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
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\Monolog\Processor;
use Monolog\LogRecord;
use Piwik\Common;
use Piwik\ErrorHandler;
use Piwik\Exception\InvalidRequestParameterException;
use Piwik\ExceptionHandler;
use Piwik\Log;
use Piwik\Url;
/**
* Process a log record containing an exception to generate a textual message.
*/
class ExceptionToTextProcessor
{
private $forcePrintBacktrace;
public function __construct(bool $forcePrintBacktrace = false)
{
$this->forcePrintBacktrace = $forcePrintBacktrace;
}
public function __invoke(LogRecord $record)
{
if (!$this->contextContainsException($record)) {
return $record;
}
/** @var \Exception $exception */
$exception = $record->context['exception'];
if ($exception instanceof InvalidRequestParameterException) {
return $record;
}
$exceptionStr = sprintf(
"%s(%d): %s",
ExceptionHandler::replaceSensitiveValues($exception instanceof \Exception ? $exception->getFile() : $exception['file']),
$exception instanceof \Exception ? $exception->getLine() : $exception['line'],
$this->getStackTrace($exception)
);
$finalMessage = '';
if (
!isset($record->message)
|| strpos($record->message, '{exception}') === false
) {
$finalMessage = $exceptionStr;
} else {
$finalMessage = str_replace('{exception}', $exceptionStr, ExceptionHandler::replaceSensitiveValues($record->message));
}
$finalMessage .= ' [' . $this->getErrorContext() . ']';
return new LogRecord(
datetime: $record->datetime,
channel: $record->channel,
level: $record->level,
message: $finalMessage,
context: $record->context,
extra: $record->extra,
formatted: $record->formatted,
);
}
private function contextContainsException(LogRecord $record): bool
{
return isset($record->context['exception'])
&& ($record->context['exception'] instanceof \Exception
|| $this->isLooksLikeFatalErrorArray($record->context['exception']));
}
private function isLooksLikeFatalErrorArray($exception)
{
return is_array($exception) && isset($exception['message']) && isset($exception['file']) && isset($exception['line']);
}
private function getMessage($exception)
{
if ($exception instanceof \ErrorException) {
return ErrorHandler::getErrNoString($exception->getSeverity()) . ' - ' . ExceptionHandler::replaceSensitiveValues($exception->getMessage());
}
if (is_array($exception) && isset($exception['message'])) {
return ExceptionHandler::replaceSensitiveValues($exception['message']);
}
return ExceptionHandler::replaceSensitiveValues($exception->getMessage());
}
private function getStackTrace($exception)
{
return Log::$debugBacktraceForTests ?: self::getMessageAndWholeBacktrace($exception, $this->forcePrintBacktrace ? true : null);
}
/**
* @param \Throwable|array{message: ?string, backtrace: ?string} $exception
*/
public static function getMessageAndWholeBacktrace($exception, ?bool $shouldPrintBacktrace = null): string
{
if ($shouldPrintBacktrace === null) {
$shouldPrintBacktrace = ExceptionHandler::shouldPrintBackTraceWithMessage();
}
if (is_array($exception)) {
$message = ExceptionHandler::replaceSensitiveValues($exception['message'] ?? '');
if ($shouldPrintBacktrace && isset($exception['backtrace'])) {
$trace = $exception['backtrace'];
$trace = ExceptionHandler::replaceSensitiveValues($trace);
return $message . "\n" . $trace;
} else {
return $message;
}
}
if (!$shouldPrintBacktrace) {
return ExceptionHandler::replaceSensitiveValues($exception->getMessage());
}
$message = '';
$e = $exception;
do {
if ($e !== $exception) {
$message .= ",\ncaused by: ";
}
$message .= ExceptionHandler::replaceSensitiveValues($e->getMessage());
$message .= "\n" . ExceptionHandler::replaceSensitiveValues($e->getTraceAsString());
} while ($e = $e->getPrevious());
return $message;
}
private function getErrorContext()
{
try {
$context = 'Query: ' . Url::getCurrentQueryString();
$context .= ', CLI mode: ' . (int)Common::isPhpCliMode();
return $context;
} catch (\Exception $ex) {
return 'cannot get url or cli mode: ' . ExceptionHandler::replaceSensitiveValues($ex->getMessage());
}
}
}
|
