-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
ErrorLogger.php
165 lines (144 loc) · 4.7 KB
/
ErrorLogger.php
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
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Error;
use Cake\Core\Configure;
use Cake\Core\Exception\CakeException;
use Cake\Core\InstanceConfigTrait;
use Cake\Log\Log;
use Psr\Http\Message\ServerRequestInterface;
use Throwable;
/**
* Log errors and unhandled exceptions to `Cake\Log\Log`
*/
class ErrorLogger implements ErrorLoggerInterface
{
use InstanceConfigTrait;
/**
* Default configuration values.
*
* - `skipLog` List of exceptions to skip logging. Exceptions that
* extend one of the listed exceptions will also not be logged.
* - `trace` Should error logs include stack traces?
*
* @var array
*/
protected $_defaultConfig = [
'skipLog' => [],
'trace' => false,
];
/**
* Constructor
*
* @param array $config Config array.
*/
public function __construct(array $config = [])
{
$this->setConfig($config);
}
/**
* @inheritDoc
*/
public function logMessage($level, string $message, array $context = []): bool
{
if (!empty($context['request'])) {
$message .= $this->getRequestContext($context['request']);
}
if (!empty($context['trace'])) {
$message .= "\nTrace:\n" . $context['trace'] . "\n";
}
return Log::write($level, $message);
}
/**
* @inheritDoc
*/
public function log(Throwable $exception, ?ServerRequestInterface $request = null): bool
{
foreach ($this->getConfig('skipLog') as $class) {
if ($exception instanceof $class) {
return false;
}
}
$message = $this->getMessage($exception);
if ($request !== null) {
$message .= $this->getRequestContext($request);
}
$message .= "\n\n";
return Log::error($message);
}
/**
* Generate the message for the exception
*
* @param \Throwable $exception The exception to log a message for.
* @param bool $isPrevious False for original exception, true for previous
* @return string Error message
*/
protected function getMessage(Throwable $exception, bool $isPrevious = false): string
{
$message = sprintf(
'%s[%s] %s in %s on line %s',
$isPrevious ? "\nCaused by: " : '',
get_class($exception),
$exception->getMessage(),
$exception->getFile(),
$exception->getLine()
);
$debug = Configure::read('debug');
if ($debug && $exception instanceof CakeException) {
$attributes = $exception->getAttributes();
if ($attributes) {
$message .= "\nException Attributes: " . var_export($exception->getAttributes(), true);
}
}
if ($this->getConfig('trace')) {
/** @var array $trace */
$trace = Debugger::formatTrace($exception, ['format' => 'points']);
$message .= "\nStack Trace:\n";
foreach ($trace as $line) {
if (is_string($line)) {
$message .= '- ' . $line;
} else {
$message .= "- {$line['file']}:{$line['line']}\n";
}
}
}
$previous = $exception->getPrevious();
if ($previous) {
$message .= $this->getMessage($previous, true);
}
return $message;
}
/**
* Get the request context for an error/exception trace.
*
* @param \Psr\Http\Message\ServerRequestInterface $request The request to read from.
* @return string
*/
public function getRequestContext(ServerRequestInterface $request): string
{
$message = "\nRequest URL: " . $request->getRequestTarget();
$referer = $request->getHeaderLine('Referer');
if ($referer) {
$message .= "\nReferer URL: " . $referer;
}
if (method_exists($request, 'clientIp')) {
$clientIp = $request->clientIp();
if ($clientIp && $clientIp !== '::1') {
$message .= "\nClient IP: " . $clientIp;
}
}
return $message;
}
}