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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik;
use Piwik\Db;
/**
* Logging utility class.
*
* Log entries are made with a message and log level. The logging utility will tag each
* log entry with the name of the plugin that's doing the logging. If no plugin is found,
* the name of the current class is used.
*
* You can log messages using one of the public static functions (eg, 'error', 'warning',
* 'info', etc.). Messages logged with the **error** level will **always** be logged to
* the screen, regardless of whether the [log] log_writer config option includes the
* screen writer.
*
* Currently, Piwik supports the following logging backends:
*
* - **screen**: logging to the screen
* - **file**: logging to a file
* - **database**: logging to Piwik's MySQL database
*
* ### Logging configuration
*
* The logging utility can be configured by manipulating the INI config options in the
* `[log]` section.
*
* The following configuration options can be set:
*
* - `log_writers[]`: This is an array of log writer IDs. The three log writers provided
* by Piwik core are **file**, **screen** and **database**. You can
* get more by installing plugins. The default value is **screen**.
* - `log_level`: The current log level. Can be **ERROR**, **WARN**, **INFO**, **DEBUG**,
* or **VERBOSE**. Log entries made with a log level that is as or more
* severe than the current log level will be outputted. Others will be
* ignored. The default level is **WARN**.
* - `log_only_when_cli`: 0 or 1. If 1, logging is only enabled when Piwik is executed
* in the command line (for example, by the core:archive command
* script). Default: 0.
* - `log_only_when_debug_parameter`: 0 or 1. If 1, logging is only enabled when the
* `debug` query parameter is 1. Default: 0.
* - `logger_file_path`: For the file log writer, specifies the path to the log file
* to log to or a path to a directory to store logs in. If a
* directory, the file name is piwik.log. Can be relative to
* Piwik's root dir or an absolute path. Defaults to **tmp/logs**.
*
* ### Custom message formatting
*
* If you'd like to format log messages differently for different backends, you can use
* one of the `'Log.format...Message'` events.
*
* These events are fired when an object is logged. You can create your own custom class
* containing the information to log and listen to these events to format it correctly for
* different backends.
*
* If you don't care about the backend when formatting an object, implement a `__toString()`
* in the custom class.
*
* ### Custom log writers
*
* New logging backends can be added via the {@hook Log.getAvailableWriters}` event. A log
* writer is just a callback that accepts log entry information (such as the message,
* level, etc.), so any backend could conceivably be used (including existing PSR3
* backends).
*
* ### Examples
*
* **Basic logging**
*
* Log::error("This log message will end up on the screen and in a file.")
* Log::verbose("This log message uses %s params, but %s will only be called if the"
* . " configured log level includes %s.", "sprintf", "sprintf", "verbose");
*
* **Logging objects**
*
* class MyDebugInfo
* {
* // ...
*
* public function __toString()
* {
* return // ...
* }
* }
*
* try {
* $myThirdPartyServiceClient->doSomething();
* } catch (Exception $unexpectedError) {
* $debugInfo = new MyDebugInfo($unexpectedError, $myThirdPartyServiceClient);
* Log::debug($debugInfo);
* }
*
* @method static \Piwik\Log getInstance()
*/
class Log extends Singleton
{
// log levels
const NONE = 0;
const ERROR = 1;
const WARN = 2;
const INFO = 3;
const DEBUG = 4;
const VERBOSE = 5;
// config option names
const LOG_LEVEL_CONFIG_OPTION = 'log_level';
const LOG_WRITERS_CONFIG_OPTION = 'log_writers';
const LOGGER_FILE_PATH_CONFIG_OPTION = 'logger_file_path';
const STRING_MESSAGE_FORMAT_OPTION = 'string_message_format';
const FORMAT_FILE_MESSAGE_EVENT = 'Log.formatFileMessage';
const FORMAT_SCREEN_MESSAGE_EVENT = 'Log.formatScreenMessage';
const FORMAT_DATABASE_MESSAGE_EVENT = 'Log.formatDatabaseMessage';
const GET_AVAILABLE_WRITERS_EVENT = 'Log.getAvailableWriters';
/**
* The current logging level. Everything of equal or greater priority will be logged.
* Everything else will be ignored.
*
* @var int
*/
private $currentLogLevel = self::WARN;
/**
* The array of callbacks executed when logging to a file. Each callback writes a log
* message to a logging backend.
*
* @var array
*/
private $writers = array();
/**
* The log message format string that turns a tag name, date-time and message into
* one string to log.
*
* @var string
*/
private $logMessageFormat = "%level% %tag%[%datetime%] %message%";
/**
* If we're logging to a file, this is the path to the file to log to.
*
* @var string
*/
private $logToFilePath;
/**
* True if we're currently setup to log to a screen, false if otherwise.
*
* @var bool
*/
private $loggingToScreen;
/**
* Constructor.
*/
protected function __construct()
{
/**
* access a property that is not overriden by TestingEnvironment before accessing log as the
* log section is used in TestingEnvironment. Otherwise access to magic __get('log') fails in
* TestingEnvironment as it tries to acccess it already here with __get('log').
* $config->log ==> __get('log') ==> Config.createConfigInstance ==> nested __get('log') ==> returns null
*/
$initConfigToPreventErrorWhenAccessingLog = Config::getInstance()->mail;
$logConfig = Config::getInstance()->log;
$this->setCurrentLogLevelFromConfig($logConfig);
$this->setLogWritersFromConfig($logConfig);
$this->setLogFilePathFromConfig($logConfig);
$this->setStringLogMessageFormat($logConfig);
$this->disableLoggingBasedOnConfig($logConfig);
}
/**
* Logs a message using the ERROR log level.
*
* _Note: Messages logged with the ERROR level are always logged to the screen in addition
* to configured writers._
*
* @param string $message The log message. This can be a sprintf format string.
* @param ... mixed Optional sprintf params.
* @api
*/
public static function error($message /* ... */)
{
self::logMessage(self::ERROR, $message, array_slice(func_get_args(), 1));
}
/**
* Logs a message using the WARNING log level.
*
* @param string $message The log message. This can be a sprintf format string.
* @param ... mixed Optional sprintf params.
* @api
*/
public static function warning($message /* ... */)
{
self::logMessage(self::WARN, $message, array_slice(func_get_args(), 1));
}
/**
* Logs a message using the INFO log level.
*
* @param string $message The log message. This can be a sprintf format string.
* @param ... mixed Optional sprintf params.
* @api
*/
public static function info($message /* ... */)
{
self::logMessage(self::INFO, $message, array_slice(func_get_args(), 1));
}
/**
* Logs a message using the DEBUG log level.
*
* @param string $message The log message. This can be a sprintf format string.
* @param ... mixed Optional sprintf params.
* @api
*/
public static function debug($message /* ... */)
{
self::logMessage(self::DEBUG, $message, array_slice(func_get_args(), 1));
}
/**
* Logs a message using the VERBOSE log level.
*
* @param string $message The log message. This can be a sprintf format string.
* @param ... mixed Optional sprintf params.
* @api
*/
public static function verbose($message /* ... */)
{
self::logMessage(self::VERBOSE, $message, array_slice(func_get_args(), 1));
}
/**
* Creates log message combining logging info including a log level, tag name,
* date time, and caller-provided log message. The log message can be set through
* the `[log] string_message_format` INI config option. By default it will
* create log messages like:
*
* **LEVEL [tag:datetime] log message**
*
* @param int $level
* @param string $tag
* @param string $datetime
* @param string $message
* @return string
*/
public function formatMessage($level, $tag, $datetime, $message)
{
return str_replace(
array("%tag%", "%message%", "%datetime%", "%level%"),
array($tag, $message, $datetime, $this->getStringLevel($level)),
$this->logMessageFormat
);
}
private function setLogWritersFromConfig($logConfig)
{
// set the log writers
$logWriters = $logConfig[self::LOG_WRITERS_CONFIG_OPTION];
$logWriters = array_map('trim', $logWriters);
foreach ($logWriters as $writerName) {
$this->addLogWriter($writerName);
}
}
public function addLogWriter($writerName)
{
if (array_key_exists($writerName, $this->writers)) {
return;
}
$availableWritersByName = $this->getAvailableWriters();
if (empty($availableWritersByName[$writerName])) {
return;
}
$this->writers[$writerName] = $availableWritersByName[$writerName];
}
private function setCurrentLogLevelFromConfig($logConfig)
{
if (!empty($logConfig[self::LOG_LEVEL_CONFIG_OPTION])) {
$logLevel = $this->getLogLevelFromStringName($logConfig[self::LOG_LEVEL_CONFIG_OPTION]);
if ($logLevel >= self::NONE // sanity check
&& $logLevel <= self::VERBOSE
) {
$this->setLogLevel($logLevel);
}
}
}
private function setStringLogMessageFormat($logConfig)
{
if (isset($logConfig['string_message_format'])) {
$this->logMessageFormat = $logConfig['string_message_format'];
}
}
private function setLogFilePathFromConfig($logConfig)
{
$logPath = $logConfig[self::LOGGER_FILE_PATH_CONFIG_OPTION];
if (!SettingsServer::isWindows()
&& $logPath[0] != '/'
) {
$logPath = PIWIK_USER_PATH . DIRECTORY_SEPARATOR . $logPath;
}
$logPath = SettingsPiwik::rewriteTmpPathWithInstanceId($logPath);
if (is_dir($logPath)) {
$logPath .= '/piwik.log';
}
$this->logToFilePath = $logPath;
}
private function getAvailableWriters()
{
$writers = array();
/**
* This event is called when the Log instance is created. Plugins can use this event to
* make new logging writers available.
*
* A logging writer is a callback with the following signature:
*
* function (int $level, string $tag, string $datetime, string $message)
*
* `$level` is the log level to use, `$tag` is the log tag used, `$datetime` is the date time
* of the logging call and `$message` is the formatted log message.
*
* Logging writers must be associated by name in the array passed to event handlers. The
* name specified can be used in Piwik's INI configuration.
*
* **Example**
*
* public function getAvailableWriters(&$writers) {
* $writers['myloggername'] = function ($level, $tag, $datetime, $message) {
* // ...
* };
* }
*
* // 'myloggername' can now be used in the log_writers config option.
*
* @param array $writers Array mapping writer names with logging writers.
*/
Piwik::postEvent(self::GET_AVAILABLE_WRITERS_EVENT, array(&$writers));
$writers['file'] = array($this, 'logToFile');
$writers['screen'] = array($this, 'logToScreen');
$writers['database'] = array($this, 'logToDatabase');
return $writers;
}
public function setLogLevel($logLevel)
{
$this->currentLogLevel = $logLevel;
}
public function getLogLevel()
{
return $this->currentLogLevel;
}
private function logToFile($level, $tag, $datetime, $message)
{
$message = $this->getMessageFormattedFile($level, $tag, $datetime, $message);
if (empty($message)) {
return;
}
if(!file_put_contents($this->logToFilePath, $message, FILE_APPEND)) {
$message = Filechecks::getErrorMessageMissingPermissions($this->logToFilePath);
throw new \Exception( $message );
}
}
private function logToScreen($level, $tag, $datetime, $message)
{
$message = $this->getMessageFormattedScreen($level, $tag, $datetime, $message);
if (empty($message)) {
return;
}
echo $message;
}
private function logToDatabase($level, $tag, $datetime, $message)
{
$message = $this->getMessageFormattedDatabase($level, $tag, $datetime, $message);
if (empty($message)) {
return;
}
$sql = "INSERT INTO " . Common::prefixTable('logger_message')
. " (tag, timestamp, level, message)"
. " VALUES (?, ?, ?, ?)";
Db::query($sql, array($tag, $datetime, self::getStringLevel($level), (string)$message));
}
private function doLog($level, $message, $sprintfParams = array())
{
if (!$this->shouldLoggerLog($level)) {
return;
}
$datetime = date("Y-m-d H:i:s");
if (is_string($message)
&& !empty($sprintfParams)
) {
$message = vsprintf($message, $sprintfParams);
}
if (version_compare(phpversion(), '5.3.6', '>=')) {
$backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS | DEBUG_BACKTRACE_PROVIDE_OBJECT);
} else {
$backtrace = debug_backtrace();
}
$tag = Plugin::getPluginNameFromBacktrace($backtrace);
// if we can't determine the plugin, use the name of the calling class
if ($tag == false) {
$tag = $this->getClassNameThatIsLogging($backtrace);
}
$this->writeMessage($level, $tag, $datetime, $message);
}
private function writeMessage($level, $tag, $datetime, $message)
{
foreach ($this->writers as $writer) {
call_user_func($writer, $level, $tag, $datetime, $message);
}
if ($level == self::ERROR) {
$message = $this->getMessageFormattedScreen($level, $tag, $datetime, $message);
$this->writeErrorToStandardErrorOutput($message);
if(!isset($this->writers['screen'])) {
echo $message;
}
}
}
private static function logMessage($level, $message, $sprintfParams)
{
self::getInstance()->doLog($level, $message, $sprintfParams);
}
private function shouldLoggerLog($level)
{
return $level <= $this->currentLogLevel;
}
private function disableLoggingBasedOnConfig($logConfig)
{
$disableLogging = false;
if (!empty($logConfig['log_only_when_cli'])
&& !Common::isPhpCliMode()
) {
$disableLogging = true;
}
if (!empty($logConfig['log_only_when_debug_parameter'])
&& !isset($_REQUEST['debug'])
) {
$disableLogging = true;
}
if ($disableLogging) {
$this->currentLogLevel = self::NONE;
}
}
private function getLogLevelFromStringName($name)
{
$name = strtoupper($name);
switch ($name) {
case 'NONE':
return self::NONE;
case 'ERROR':
return self::ERROR;
case 'WARN':
return self::WARN;
case 'INFO':
return self::INFO;
case 'DEBUG':
return self::DEBUG;
case 'VERBOSE':
return self::VERBOSE;
default:
return -1;
}
}
private function getStringLevel($level)
{
static $levelToName = array(
self::NONE => 'NONE',
self::ERROR => 'ERROR',
self::WARN => 'WARN',
self::INFO => 'INFO',
self::DEBUG => 'DEBUG',
self::VERBOSE => 'VERBOSE'
);
return $levelToName[$level];
}
private function getClassNameThatIsLogging($backtrace)
{
foreach ($backtrace as $tracepoint) {
if (isset($tracepoint['class'])
&& $tracepoint['class'] != "Piwik\\Log"
&& $tracepoint['class'] != "Piwik\\Piwik"
&& $tracepoint['class'] != "Piwik\\CronArchive"
) {
return $tracepoint['class'];
}
}
return false;
}
/**
* @param $level
* @param $tag
* @param $datetime
* @param $message
* @return string
*/
private function getMessageFormattedScreen($level, $tag, $datetime, $message)
{
static $currentRequestKey;
if (empty($currentRequestKey)) {
$currentRequestKey = substr(Common::generateUniqId(), 0, 5);
}
if (is_string($message)) {
if (!defined('PIWIK_TEST_MODE')) {
$message = '[' . $currentRequestKey . '] ' . $message;
}
$message = $this->formatMessage($level, $tag, $datetime, $message);
if (!Common::isPhpCliMode()) {
$message = Common::sanitizeInputValue($message);
$message = '<pre>' . $message . '</pre>';
}
} else {
$logger = $this;
/**
* Triggered when trying to log an object to the screen. Plugins can use
* this event to convert objects to strings before they are logged.
*
* The result of this callback can be HTML so no sanitization is done on the result.
* This means **YOU MUST SANITIZE THE MESSAGE YOURSELF** if you use this event.
*
* **Example**
*
* public function formatScreenMessage(&$message, $level, $tag, $datetime, $logger) {
* if ($message instanceof MyCustomDebugInfo) {
* $message = Common::sanitizeInputValue($message->formatForScreen());
* }
* }
*
* @param mixed &$message The object that is being logged. Event handlers should
* check if the object is of a certain type and if it is,
* set `$message` to the string that should be logged.
* @param int $level The log level used with this log entry.
* @param string $tag The current plugin that started logging (or if no plugin,
* the current class).
* @param string $datetime Datetime of the logging call.
* @param Log $logger The Log singleton.
*/
Piwik::postEvent(self::FORMAT_SCREEN_MESSAGE_EVENT, array(&$message, $level, $tag, $datetime, $logger));
}
return $message . "\n";
}
/**
* @param $message
*/
private function writeErrorToStandardErrorOutput($message)
{
if(defined('PIWIK_TEST_MODE')) {
// do not log on stderr during tests (prevent display of errors in CI output)
return;
}
$fe = fopen('php://stderr', 'w');
fwrite($fe, $message);
}
/**
* @param $level
* @param $tag
* @param $datetime
* @param $message
* @return string
*/
private function getMessageFormattedDatabase($level, $tag, $datetime, $message)
{
if (is_string($message)) {
$message = $this->formatMessage($level, $tag, $datetime, $message);
} else {
$logger = $this;
/**
* Triggered when trying to log an object to a database table. Plugins can use
* this event to convert objects to strings before they are logged.
*
* **Example**
*
* public function formatDatabaseMessage(&$message, $level, $tag, $datetime, $logger) {
* if ($message instanceof MyCustomDebugInfo) {
* $message = $message->formatForDatabase();
* }
* }
*
* @param mixed &$message The object that is being logged. Event handlers should
* check if the object is of a certain type and if it is,
* set `$message` to the string that should be logged.
* @param int $level The log level used with this log entry.
* @param string $tag The current plugin that started logging (or if no plugin,
* the current class).
* @param string $datetime Datetime of the logging call.
* @param Log $logger The Log singleton.
*/
Piwik::postEvent(self::FORMAT_DATABASE_MESSAGE_EVENT, array(&$message, $level, $tag, $datetime, $logger));
}
return $message;
}
/**
* @param $level
* @param $tag
* @param $datetime
* @param $message
* @return string
*/
private function getMessageFormattedFile($level, $tag, $datetime, $message)
{
if (is_string($message)) {
$message = $this->formatMessage($level, $tag, $datetime, $message);
} else {
$logger = $this;
/**
* Triggered when trying to log an object to a file. Plugins can use
* this event to convert objects to strings before they are logged.
*
* **Example**
*
* public function formatFileMessage(&$message, $level, $tag, $datetime, $logger) {
* if ($message instanceof MyCustomDebugInfo) {
* $message = $message->formatForFile();
* }
* }
*
* @param mixed &$message The object that is being logged. Event handlers should
* check if the object is of a certain type and if it is,
* set `$message` to the string that should be logged.
* @param int $level The log level used with this log entry.
* @param string $tag The current plugin that started logging (or if no plugin,
* the current class).
* @param string $datetime Datetime of the logging call.
* @param Log $logger The Log singleton.
*/
Piwik::postEvent(self::FORMAT_FILE_MESSAGE_EVENT, array(&$message, $level, $tag, $datetime, $logger));
}
return $message . "\n";
}
}
|