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
|
<?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\Formatter;
use Monolog\Formatter\FormatterInterface;
use Monolog\Level;
use Monolog\LogRecord;
use Symfony\Component\Console\Formatter\OutputFormatter;
use Symfony\Component\VarDumper\Cloner\Data;
use Symfony\Component\VarDumper\Cloner\Stub;
use Symfony\Component\VarDumper\Cloner\VarCloner;
use Symfony\Component\VarDumper\Dumper\CliDumper;
/**
* Formats incoming records for console output by coloring them depending on log level.
*
* (c) Fabien Potencier <fabien@symfony.com>
* @author Tobias Schultze <http://tobion.de>
* @author Grégoire Pineau <lyrixx@lyrixx.info>
*/
class ConsoleFormatter implements FormatterInterface
{
public const SIMPLE_FORMAT = "%datetime% %start_tag%%level_name%%end_tag% <comment>[%channel%]</> %message%%context%%extra%\n";
public const SIMPLE_DATE = 'H:i:s';
private const LEVEL_COLOR_MAP = [
Level::Debug->value => 'fg=white',
Level::Info->value => 'fg=green',
Level::Notice->value => 'fg=blue',
Level::Warning->value => 'fg=cyan',
Level::Error->value => 'fg=yellow',
Level::Critical->value => 'fg=red',
Level::Alert->value => 'fg=red',
Level::Emergency->value => 'fg=white;bg=red',
];
private array $options;
private VarCloner $cloner;
/**
* @var resource|null
*/
private $outputBuffer;
private CliDumper $dumper;
/**
* Available options:
* * format: The format of the outputted log string. The following placeholders are supported: %datetime%, %start_tag%, %level_name%, %end_tag%, %channel%, %message%, %context%, %extra%;
* * date_format: The format of the outputted date string;
* * colors: If true, the log string contains ANSI code to add color;
* * multiline: If false, "context" and "extra" are dumped on one line.
*/
public function __construct(array $options = [])
{
$this->options = array_replace([
'format' => self::SIMPLE_FORMAT,
'date_format' => self::SIMPLE_DATE,
'colors' => true,
'multiline' => false,
'level_name_format' => '%-9s',
'ignore_empty_context_and_extra' => true,
], $options);
if (class_exists(VarCloner::class)) {
$this->cloner = new VarCloner();
$this->cloner->addCasters([
'*' => $this->castObject(...),
]);
$this->outputBuffer = fopen('php://memory', 'r+');
if ($this->options['multiline']) {
$output = $this->outputBuffer;
} else {
$output = $this->echoLine(...);
}
$this->dumper = new CliDumper($output, null, CliDumper::DUMP_LIGHT_ARRAY | CliDumper::DUMP_COMMA_SEPARATOR);
}
}
public function formatBatch(array $records): mixed
{
foreach ($records as $key => $record) {
$records[$key] = $this->format($record);
}
return $records;
}
public function format(LogRecord $record): mixed
{
$record = $this->replacePlaceHolder($record);
if (!$this->options['ignore_empty_context_and_extra'] || $record->context) {
$context = $record->context;
$context = ($this->options['multiline'] ? "\n" : ' ').$this->dumpData($context);
} else {
$context = '';
}
if (!$this->options['ignore_empty_context_and_extra'] || $record->extra) {
$extra = $record->extra;
$extra = ($this->options['multiline'] ? "\n" : ' ').$this->dumpData($extra);
} else {
$extra = '';
}
$formatted = strtr($this->options['format'], [
'%datetime%' => $record->datetime->format($this->options['date_format']),
'%start_tag%' => \sprintf('<%s>', self::LEVEL_COLOR_MAP[$record->level->value]),
'%level_name%' => \sprintf($this->options['level_name_format'], $record->level->getName()),
'%end_tag%' => '</>',
'%channel%' => $record->channel,
'%message%' => $this->replacePlaceHolder($record)->message,
'%context%' => $context,
'%extra%' => $extra,
]);
foreach ($record->extra as $var => $val) {
if (false !== strpos($formatted, '%extra.' . $var . '%')) {
$formatted = str_replace('%extra.' . $var . '%', $val, $formatted);
unset($record->extra[$var]);
}
}
return $formatted;
}
/**
* @internal
*/
public function echoLine(string $line, int $depth, string $indentPad): void
{
if (-1 !== $depth) {
fwrite($this->outputBuffer, $line);
}
}
/**
* @internal
*/
public function castObject(mixed $v, array $a, Stub $s, bool $isNested): array
{
if ($this->options['multiline']) {
return $a;
}
if ($isNested && !$v instanceof \DateTimeInterface) {
$s->cut = -1;
$a = [];
}
return $a;
}
private function replacePlaceHolder(LogRecord $record): LogRecord
{
$message = $record->message;
if (!str_contains($message, '{')) {
return $record;
}
$context = $record->context;
$replacements = [];
foreach ($context as $k => $v) {
// Remove quotes added by the dumper around string.
$v = trim($this->dumpData($v, false), '"');
$v = OutputFormatter::escape($v);
$replacements['{'.$k.'}'] = \sprintf('<comment>%s</>', $v);
}
return $record->with(message: strtr($message, $replacements));
}
private function dumpData(mixed $data, ?bool $colors = null): string
{
if (!isset($this->dumper)) {
return '';
}
if (null === $colors) {
$this->dumper->setColors($this->options['colors']);
} else {
$this->dumper->setColors($colors);
}
if (\is_array($data) && ($data['data'] ?? null) instanceof Data) {
$data = $data['data'];
} elseif (!$data instanceof Data) {
$data = $this->cloner->cloneVar($data);
}
$data = $data->withRefHandles(false);
$this->dumper->dump($data);
$dump = stream_get_contents($this->outputBuffer, -1, 0);
rewind($this->outputBuffer);
ftruncate($this->outputBuffer, 0);
return rtrim($dump);
}
}
|
