1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
* @category Piwik
* @package Piwik
*/
namespace Piwik;
use Piwik\Log\APICall;
use Piwik\Log\Error;
use Piwik\Log\Exception;
use Piwik\Log\Message;
/**
*
* @package Piwik
* @subpackage Log
* @see Zend_Log, libs/Zend/Log.php
* @link http://framework.zend.com/manual/en/zend.log.html
*/
abstract class Log extends \Zend_Log
{
protected $logToDatabaseTableName = null;
protected $logToDatabaseColumnMapping = null;
protected $logToFileFilename = null;
protected $fileFormatter = null;
protected $screenFormatter = null;
protected $currentRequestKey;
/**
* @param string $logToFileFilename filename of logfile
* @param \Zend_Log_Formatter_Interface $fileFormatter
* @param \Zend_Log_Formatter_Interface $screenFormatter
* @param string $logToDatabaseTableName
* @param array $logToDatabaseColumnMapping
*/
function __construct($logToFileFilename,
$fileFormatter,
$screenFormatter,
$logToDatabaseTableName,
$logToDatabaseColumnMapping)
{
parent::__construct();
$this->currentRequestKey = substr(Common::generateUniqId(), 0, 8);
$log_dir = Config::getInstance()->log['logger_file_path'];
if ($log_dir[0] != '/' && $log_dir[0] != DIRECTORY_SEPARATOR) {
$log_dir = PIWIK_USER_PATH . '/' . $log_dir;
}
$this->logToFileFilename = $log_dir . '/' . $logToFileFilename;
$this->fileFormatter = $fileFormatter;
$this->screenFormatter = $screenFormatter;
$this->logToDatabaseTableName = Common::prefixTable($logToDatabaseTableName);
$this->logToDatabaseColumnMapping = $logToDatabaseColumnMapping;
}
function addWriteToFile()
{
Filesystem::mkdir(dirname($this->logToFileFilename));
$writerFile = new \Zend_Log_Writer_Stream($this->logToFileFilename);
$writerFile->setFormatter($this->fileFormatter);
$this->addWriter($writerFile);
}
function addWriteToNull()
{
$this->addWriter(new \Zend_Log_Writer_Null);
}
function addWriteToDatabase()
{
$writerDb = new \Zend_Log_Writer_Db(
\Zend_Registry::get('db'),
$this->logToDatabaseTableName,
$this->logToDatabaseColumnMapping);
$this->addWriter($writerDb);
}
function addWriteToScreen()
{
$writerScreen = new \Zend_Log_Writer_Stream('php://output');
$writerScreen->setFormatter($this->screenFormatter);
$this->addWriter($writerScreen);
}
public function getWritersCount()
{
return count($this->_writers);
}
/**
* Log an event
* @param string $event
* @param int $priority
* @param null $extras
* @throws \Zend_Log_Exception
* @return void
*/
public function log($event, $priority, $extras = null)
{
// sanity checks
if (empty($this->_writers)) {
throw new \Zend_Log_Exception('No writers were added');
}
$event['timestamp'] = date('Y-m-d H:i:s');
$event['requestKey'] = $this->currentRequestKey;
// pack into event required by filters and writers
$event = array_merge($event, $this->_extras);
// one message must stay on one line
if (isset($event['message'])) {
$event['message'] = str_replace(array(PHP_EOL, "\n"), " ", $event['message']);
}
// Truncate the backtrace which can be too long to display in the browser
if (!empty($event['backtrace'])) {
$maxSizeOutputBytes = 1024 * 1024; // no more than 1M output please
$truncateBacktraceLineAfter = 1000;
$maxLines = ceil($maxSizeOutputBytes / $truncateBacktraceLineAfter);
$bt = explode("\n", $event['backtrace']);
foreach ($bt as $count => &$line) {
if (strlen($line) > $truncateBacktraceLineAfter) {
$line = substr($line, 0, $truncateBacktraceLineAfter) . '...';
}
if ($count > $maxLines) {
$line .= "\nTruncated error message.";
break;
}
}
$event['backtrace'] = implode("\n", $bt);
}
// abort if rejected by the global filters
foreach ($this->_filters as $filter) {
if (!$filter->accept($event)) {
return;
}
}
// send to each writer
foreach ($this->_writers as $writer) {
$writer->write($event);
}
}
/**
* Create log object
* @throws Exception
*/
static public function make()
{
$configAPI = Config::getInstance()->log;
/** @var Log[] $aLoggers */
$aLoggers = array(
'logger_api_call' => new APICall,
'logger_exception' => new Exception,
'logger_error' => new Error,
'logger_message' => new Message,
);
foreach ($configAPI as $loggerType => $aRecordTo) {
if (isset($aLoggers[$loggerType])) {
$logger = $aLoggers[$loggerType];
foreach ($aRecordTo as $recordTo) {
switch ($recordTo) {
case 'screen':
$logger->addWriteToScreen();
break;
case 'database':
$logger->addWriteToDatabase();
break;
case 'file':
$logger->addWriteToFile();
break;
default:
throw new \Exception("'$recordTo' is not a valid Log type. Valid logger types are: screen, database, file.");
break;
}
}
}
}
foreach ($aLoggers as $loggerType => $logger) {
if ($logger->getWritersCount() == 0) {
$logger->addWriteToNull();
}
\Zend_Registry::set($loggerType, $logger);
}
}
}
|
