-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
BaseLog.php
177 lines (152 loc) · 5.15 KB
/
BaseLog.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
166
167
168
169
170
171
172
173
174
175
176
177
<?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://cakefoundation.org CakePHP(tm) Project
* @since 2.2.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Log\Engine;
use ArrayObject;
use Cake\Core\InstanceConfigTrait;
use DateTimeImmutable;
use JsonSerializable;
use Psr\Log\AbstractLogger;
use Serializable;
/**
* Base log engine class.
*/
abstract class BaseLog extends AbstractLogger
{
use InstanceConfigTrait;
/**
* Default config for this class
*
* @var array
*/
protected $_defaultConfig = [
'levels' => [],
'scopes' => [],
'dateFormat' => 'Y-m-d H:i:s',
];
/**
* __construct method
*
* @param array $config Configuration array
*/
public function __construct(array $config = [])
{
$this->setConfig($config);
if (!is_array($this->_config['scopes']) && $this->_config['scopes'] !== false) {
$this->_config['scopes'] = (array)$this->_config['scopes'];
}
if (!is_array($this->_config['levels'])) {
$this->_config['levels'] = (array)$this->_config['levels'];
}
if (!empty($this->_config['types']) && empty($this->_config['levels'])) {
$this->_config['levels'] = (array)$this->_config['types'];
}
}
/**
* Get the levels this logger is interested in.
*
* @return array
*/
public function levels(): array
{
return $this->_config['levels'];
}
/**
* Get the scopes this logger is interested in.
*
* @return array|false
*/
public function scopes()
{
return $this->_config['scopes'];
}
/**
* Formats the message to be logged.
*
* The context can optionally be used by log engines to interpolate variables
* or add additional info to the logged message.
*
* @param string $message The message to be formatted.
* @param array $context Additional logging information for the message.
* @return string
*/
protected function _format(string $message, array $context = []): string
{
if (strpos($message, '{') === false && strpos($message, '}') === false) {
return $message;
}
preg_match_all(
'/(?<!' . preg_quote('\\', '/') . ')\{([a-z0-9-_]+)\}/i',
$message,
$matches
);
if (empty($matches)) {
return $message;
}
$placeholders = array_intersect($matches[1], array_keys($context));
$replacements = [];
foreach ($placeholders as $key) {
$value = $context[$key];
if (is_scalar($value)) {
$replacements['{' . $key . '}'] = (string)$value;
continue;
}
if (is_array($value)) {
$replacements['{' . $key . '}'] = json_encode($value, JSON_UNESCAPED_UNICODE);
continue;
}
if ($value instanceof JsonSerializable) {
$replacements['{' . $key . '}'] = json_encode($value, JSON_UNESCAPED_UNICODE);
continue;
}
if ($value instanceof ArrayObject) {
$replacements['{' . $key . '}'] = json_encode($value->getArrayCopy(), JSON_UNESCAPED_UNICODE);
continue;
}
if ($value instanceof Serializable) {
$replacements['{' . $key . '}'] = $value->serialize();
continue;
}
if (is_object($value)) {
if (method_exists($value, '__toString')) {
$replacements['{' . $key . '}'] = (string)$value;
continue;
}
if (method_exists($value, 'toArray')) {
$replacements['{' . $key . '}'] = json_encode($value->toArray(), JSON_UNESCAPED_UNICODE);
continue;
}
if (method_exists($value, '__debugInfo')) {
$replacements['{' . $key . '}'] = json_encode($value->__debugInfo(), JSON_UNESCAPED_UNICODE);
continue;
}
}
$replacements['{' . $key . '}'] = sprintf('[unhandled value of type %s]', getTypeName($value));
}
/** @psalm-suppress InvalidArgument */
return str_replace(array_keys($replacements), $replacements, $message);
}
/**
* Returns date formatted according to given `dateFormat` option format.
*
* This function affects `FileLog` or` ConsoleLog` datetime information format.
*
* @return string
*/
protected function _getFormattedDate(): string
{
return (new DateTimeImmutable())->format($this->_config['dateFormat']);
}
}