Chris@0
|
1 <?php
|
Chris@0
|
2
|
Chris@0
|
3 /*
|
Chris@0
|
4 * This file is part of the Symfony package.
|
Chris@0
|
5 *
|
Chris@0
|
6 * (c) Fabien Potencier <fabien@symfony.com>
|
Chris@0
|
7 *
|
Chris@0
|
8 * For the full copyright and license information, please view the LICENSE
|
Chris@0
|
9 * file that was distributed with this source code.
|
Chris@0
|
10 */
|
Chris@0
|
11
|
Chris@0
|
12 namespace Symfony\Component\HttpKernel\DataCollector;
|
Chris@0
|
13
|
Chris@0
|
14 use Symfony\Component\HttpFoundation\Request;
|
Chris@0
|
15 use Symfony\Component\HttpFoundation\RequestStack;
|
Chris@0
|
16 use Symfony\Component\HttpFoundation\Response;
|
Chris@0
|
17 use Symfony\Component\Stopwatch\Stopwatch;
|
Chris@0
|
18 use Symfony\Component\VarDumper\Cloner\Data;
|
Chris@0
|
19 use Symfony\Component\VarDumper\Cloner\VarCloner;
|
Chris@0
|
20 use Symfony\Component\VarDumper\Dumper\CliDumper;
|
Chris@17
|
21 use Symfony\Component\VarDumper\Dumper\DataDumperInterface;
|
Chris@0
|
22 use Symfony\Component\VarDumper\Dumper\HtmlDumper;
|
Chris@12
|
23 use Twig\Template;
|
Chris@0
|
24
|
Chris@0
|
25 /**
|
Chris@0
|
26 * @author Nicolas Grekas <p@tchwork.com>
|
Chris@0
|
27 */
|
Chris@0
|
28 class DumpDataCollector extends DataCollector implements DataDumperInterface
|
Chris@0
|
29 {
|
Chris@0
|
30 private $stopwatch;
|
Chris@0
|
31 private $fileLinkFormat;
|
Chris@0
|
32 private $dataCount = 0;
|
Chris@0
|
33 private $isCollected = true;
|
Chris@0
|
34 private $clonesCount = 0;
|
Chris@0
|
35 private $clonesIndex = 0;
|
Chris@0
|
36 private $rootRefs;
|
Chris@0
|
37 private $charset;
|
Chris@0
|
38 private $requestStack;
|
Chris@0
|
39 private $dumper;
|
Chris@0
|
40 private $dumperIsInjected;
|
Chris@0
|
41
|
Chris@0
|
42 public function __construct(Stopwatch $stopwatch = null, $fileLinkFormat = null, $charset = null, RequestStack $requestStack = null, DataDumperInterface $dumper = null)
|
Chris@0
|
43 {
|
Chris@0
|
44 $this->stopwatch = $stopwatch;
|
Chris@0
|
45 $this->fileLinkFormat = $fileLinkFormat ?: ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format');
|
Chris@0
|
46 $this->charset = $charset ?: ini_get('php.output_encoding') ?: ini_get('default_charset') ?: 'UTF-8';
|
Chris@0
|
47 $this->requestStack = $requestStack;
|
Chris@0
|
48 $this->dumper = $dumper;
|
Chris@0
|
49 $this->dumperIsInjected = null !== $dumper;
|
Chris@0
|
50
|
Chris@0
|
51 // All clones share these properties by reference:
|
Chris@17
|
52 $this->rootRefs = [
|
Chris@0
|
53 &$this->data,
|
Chris@0
|
54 &$this->dataCount,
|
Chris@0
|
55 &$this->isCollected,
|
Chris@0
|
56 &$this->clonesCount,
|
Chris@17
|
57 ];
|
Chris@0
|
58 }
|
Chris@0
|
59
|
Chris@0
|
60 public function __clone()
|
Chris@0
|
61 {
|
Chris@0
|
62 $this->clonesIndex = ++$this->clonesCount;
|
Chris@0
|
63 }
|
Chris@0
|
64
|
Chris@0
|
65 public function dump(Data $data)
|
Chris@0
|
66 {
|
Chris@0
|
67 if ($this->stopwatch) {
|
Chris@0
|
68 $this->stopwatch->start('dump');
|
Chris@0
|
69 }
|
Chris@14
|
70 if ($this->isCollected && !$this->dumper) {
|
Chris@0
|
71 $this->isCollected = false;
|
Chris@0
|
72 }
|
Chris@0
|
73
|
Chris@0
|
74 $trace = debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT | DEBUG_BACKTRACE_IGNORE_ARGS, 7);
|
Chris@0
|
75
|
Chris@0
|
76 $file = $trace[0]['file'];
|
Chris@0
|
77 $line = $trace[0]['line'];
|
Chris@0
|
78 $name = false;
|
Chris@0
|
79 $fileExcerpt = false;
|
Chris@0
|
80
|
Chris@0
|
81 for ($i = 1; $i < 7; ++$i) {
|
Chris@0
|
82 if (isset($trace[$i]['class'], $trace[$i]['function'])
|
Chris@0
|
83 && 'dump' === $trace[$i]['function']
|
Chris@0
|
84 && 'Symfony\Component\VarDumper\VarDumper' === $trace[$i]['class']
|
Chris@0
|
85 ) {
|
Chris@0
|
86 $file = $trace[$i]['file'];
|
Chris@0
|
87 $line = $trace[$i]['line'];
|
Chris@0
|
88
|
Chris@0
|
89 while (++$i < 7) {
|
Chris@0
|
90 if (isset($trace[$i]['function'], $trace[$i]['file']) && empty($trace[$i]['class']) && 0 !== strpos($trace[$i]['function'], 'call_user_func')) {
|
Chris@0
|
91 $file = $trace[$i]['file'];
|
Chris@0
|
92 $line = $trace[$i]['line'];
|
Chris@0
|
93
|
Chris@0
|
94 break;
|
Chris@12
|
95 } elseif (isset($trace[$i]['object']) && $trace[$i]['object'] instanceof Template) {
|
Chris@0
|
96 $template = $trace[$i]['object'];
|
Chris@0
|
97 $name = $template->getTemplateName();
|
Chris@0
|
98 $src = method_exists($template, 'getSourceContext') ? $template->getSourceContext()->getCode() : (method_exists($template, 'getSource') ? $template->getSource() : false);
|
Chris@0
|
99 $info = $template->getDebugInfo();
|
Chris@0
|
100 if (isset($info[$trace[$i - 1]['line']])) {
|
Chris@0
|
101 $line = $info[$trace[$i - 1]['line']];
|
Chris@0
|
102 $file = method_exists($template, 'getSourceContext') ? $template->getSourceContext()->getPath() : null;
|
Chris@0
|
103
|
Chris@0
|
104 if ($src) {
|
Chris@0
|
105 $src = explode("\n", $src);
|
Chris@17
|
106 $fileExcerpt = [];
|
Chris@0
|
107
|
Chris@17
|
108 for ($i = max($line - 3, 1), $max = min($line + 3, \count($src)); $i <= $max; ++$i) {
|
Chris@0
|
109 $fileExcerpt[] = '<li'.($i === $line ? ' class="selected"' : '').'><code>'.$this->htmlEncode($src[$i - 1]).'</code></li>';
|
Chris@0
|
110 }
|
Chris@0
|
111
|
Chris@0
|
112 $fileExcerpt = '<ol start="'.max($line - 3, 1).'">'.implode("\n", $fileExcerpt).'</ol>';
|
Chris@0
|
113 }
|
Chris@0
|
114 }
|
Chris@0
|
115 break;
|
Chris@0
|
116 }
|
Chris@0
|
117 }
|
Chris@0
|
118 break;
|
Chris@0
|
119 }
|
Chris@0
|
120 }
|
Chris@0
|
121
|
Chris@0
|
122 if (false === $name) {
|
Chris@0
|
123 $name = str_replace('\\', '/', $file);
|
Chris@0
|
124 $name = substr($name, strrpos($name, '/') + 1);
|
Chris@0
|
125 }
|
Chris@0
|
126
|
Chris@0
|
127 if ($this->dumper) {
|
Chris@0
|
128 $this->doDump($data, $name, $file, $line);
|
Chris@0
|
129 }
|
Chris@0
|
130
|
Chris@0
|
131 $this->data[] = compact('data', 'name', 'file', 'line', 'fileExcerpt');
|
Chris@0
|
132 ++$this->dataCount;
|
Chris@0
|
133
|
Chris@0
|
134 if ($this->stopwatch) {
|
Chris@0
|
135 $this->stopwatch->stop('dump');
|
Chris@0
|
136 }
|
Chris@0
|
137 }
|
Chris@0
|
138
|
Chris@0
|
139 public function collect(Request $request, Response $response, \Exception $exception = null)
|
Chris@0
|
140 {
|
Chris@0
|
141 // Sub-requests and programmatic calls stay in the collected profile.
|
Chris@0
|
142 if ($this->dumper || ($this->requestStack && $this->requestStack->getMasterRequest() !== $request) || $request->isXmlHttpRequest() || $request->headers->has('Origin')) {
|
Chris@0
|
143 return;
|
Chris@0
|
144 }
|
Chris@0
|
145
|
Chris@0
|
146 // In all other conditions that remove the web debug toolbar, dumps are written on the output.
|
Chris@0
|
147 if (!$this->requestStack
|
Chris@0
|
148 || !$response->headers->has('X-Debug-Token')
|
Chris@0
|
149 || $response->isRedirection()
|
Chris@0
|
150 || ($response->headers->has('Content-Type') && false === strpos($response->headers->get('Content-Type'), 'html'))
|
Chris@0
|
151 || 'html' !== $request->getRequestFormat()
|
Chris@0
|
152 || false === strripos($response->getContent(), '</body>')
|
Chris@0
|
153 ) {
|
Chris@0
|
154 if ($response->headers->has('Content-Type') && false !== strpos($response->headers->get('Content-Type'), 'html')) {
|
Chris@0
|
155 $this->dumper = new HtmlDumper('php://output', $this->charset);
|
Chris@17
|
156 $this->dumper->setDisplayOptions(['fileLinkFormat' => $this->fileLinkFormat]);
|
Chris@0
|
157 } else {
|
Chris@0
|
158 $this->dumper = new CliDumper('php://output', $this->charset);
|
Chris@0
|
159 }
|
Chris@0
|
160
|
Chris@0
|
161 foreach ($this->data as $dump) {
|
Chris@0
|
162 $this->doDump($dump['data'], $dump['name'], $dump['file'], $dump['line']);
|
Chris@0
|
163 }
|
Chris@0
|
164 }
|
Chris@0
|
165 }
|
Chris@0
|
166
|
Chris@14
|
167 public function reset()
|
Chris@14
|
168 {
|
Chris@14
|
169 if ($this->stopwatch) {
|
Chris@14
|
170 $this->stopwatch->reset();
|
Chris@14
|
171 }
|
Chris@17
|
172 $this->data = [];
|
Chris@14
|
173 $this->dataCount = 0;
|
Chris@16
|
174 $this->isCollected = true;
|
Chris@14
|
175 $this->clonesCount = 0;
|
Chris@14
|
176 $this->clonesIndex = 0;
|
Chris@14
|
177 }
|
Chris@14
|
178
|
Chris@0
|
179 public function serialize()
|
Chris@0
|
180 {
|
Chris@0
|
181 if ($this->clonesCount !== $this->clonesIndex) {
|
Chris@0
|
182 return 'a:0:{}';
|
Chris@0
|
183 }
|
Chris@0
|
184
|
Chris@0
|
185 $this->data[] = $this->fileLinkFormat;
|
Chris@0
|
186 $this->data[] = $this->charset;
|
Chris@0
|
187 $ser = serialize($this->data);
|
Chris@17
|
188 $this->data = [];
|
Chris@0
|
189 $this->dataCount = 0;
|
Chris@0
|
190 $this->isCollected = true;
|
Chris@0
|
191 if (!$this->dumperIsInjected) {
|
Chris@0
|
192 $this->dumper = null;
|
Chris@0
|
193 }
|
Chris@0
|
194
|
Chris@0
|
195 return $ser;
|
Chris@0
|
196 }
|
Chris@0
|
197
|
Chris@0
|
198 public function unserialize($data)
|
Chris@0
|
199 {
|
Chris@17
|
200 $this->data = unserialize($data);
|
Chris@0
|
201 $charset = array_pop($this->data);
|
Chris@0
|
202 $fileLinkFormat = array_pop($this->data);
|
Chris@17
|
203 $this->dataCount = \count($this->data);
|
Chris@0
|
204 self::__construct($this->stopwatch, $fileLinkFormat, $charset);
|
Chris@0
|
205 }
|
Chris@0
|
206
|
Chris@0
|
207 public function getDumpsCount()
|
Chris@0
|
208 {
|
Chris@0
|
209 return $this->dataCount;
|
Chris@0
|
210 }
|
Chris@0
|
211
|
Chris@0
|
212 public function getDumps($format, $maxDepthLimit = -1, $maxItemsPerDepth = -1)
|
Chris@0
|
213 {
|
Chris@0
|
214 $data = fopen('php://memory', 'r+b');
|
Chris@0
|
215
|
Chris@0
|
216 if ('html' === $format) {
|
Chris@0
|
217 $dumper = new HtmlDumper($data, $this->charset);
|
Chris@17
|
218 $dumper->setDisplayOptions(['fileLinkFormat' => $this->fileLinkFormat]);
|
Chris@0
|
219 } else {
|
Chris@0
|
220 throw new \InvalidArgumentException(sprintf('Invalid dump format: %s', $format));
|
Chris@0
|
221 }
|
Chris@17
|
222 $dumps = [];
|
Chris@0
|
223
|
Chris@0
|
224 foreach ($this->data as $dump) {
|
Chris@0
|
225 $dumper->dump($dump['data']->withMaxDepth($maxDepthLimit)->withMaxItemsPerDepth($maxItemsPerDepth));
|
Chris@0
|
226 $dump['data'] = stream_get_contents($data, -1, 0);
|
Chris@0
|
227 ftruncate($data, 0);
|
Chris@0
|
228 rewind($data);
|
Chris@0
|
229 $dumps[] = $dump;
|
Chris@0
|
230 }
|
Chris@0
|
231
|
Chris@0
|
232 return $dumps;
|
Chris@0
|
233 }
|
Chris@0
|
234
|
Chris@0
|
235 public function getName()
|
Chris@0
|
236 {
|
Chris@0
|
237 return 'dump';
|
Chris@0
|
238 }
|
Chris@0
|
239
|
Chris@0
|
240 public function __destruct()
|
Chris@0
|
241 {
|
Chris@0
|
242 if (0 === $this->clonesCount-- && !$this->isCollected && $this->data) {
|
Chris@0
|
243 $this->clonesCount = 0;
|
Chris@0
|
244 $this->isCollected = true;
|
Chris@0
|
245
|
Chris@0
|
246 $h = headers_list();
|
Chris@17
|
247 $i = \count($h);
|
Chris@0
|
248 array_unshift($h, 'Content-Type: '.ini_get('default_mimetype'));
|
Chris@0
|
249 while (0 !== stripos($h[$i], 'Content-Type:')) {
|
Chris@0
|
250 --$i;
|
Chris@0
|
251 }
|
Chris@0
|
252
|
Chris@17
|
253 if (!\in_array(\PHP_SAPI, ['cli', 'phpdbg'], true) && stripos($h[$i], 'html')) {
|
Chris@0
|
254 $this->dumper = new HtmlDumper('php://output', $this->charset);
|
Chris@17
|
255 $this->dumper->setDisplayOptions(['fileLinkFormat' => $this->fileLinkFormat]);
|
Chris@0
|
256 } else {
|
Chris@0
|
257 $this->dumper = new CliDumper('php://output', $this->charset);
|
Chris@0
|
258 }
|
Chris@0
|
259
|
Chris@0
|
260 foreach ($this->data as $i => $dump) {
|
Chris@0
|
261 $this->data[$i] = null;
|
Chris@0
|
262 $this->doDump($dump['data'], $dump['name'], $dump['file'], $dump['line']);
|
Chris@0
|
263 }
|
Chris@0
|
264
|
Chris@17
|
265 $this->data = [];
|
Chris@0
|
266 $this->dataCount = 0;
|
Chris@0
|
267 }
|
Chris@0
|
268 }
|
Chris@0
|
269
|
Chris@0
|
270 private function doDump($data, $name, $file, $line)
|
Chris@0
|
271 {
|
Chris@0
|
272 if ($this->dumper instanceof CliDumper) {
|
Chris@0
|
273 $contextDumper = function ($name, $file, $line, $fmt) {
|
Chris@0
|
274 if ($this instanceof HtmlDumper) {
|
Chris@0
|
275 if ($file) {
|
Chris@0
|
276 $s = $this->style('meta', '%s');
|
Chris@0
|
277 $f = strip_tags($this->style('', $file));
|
Chris@0
|
278 $name = strip_tags($this->style('', $name));
|
Chris@17
|
279 if ($fmt && $link = \is_string($fmt) ? strtr($fmt, ['%f' => $file, '%l' => $line]) : $fmt->format($file, $line)) {
|
Chris@0
|
280 $name = sprintf('<a href="%s" title="%s">'.$s.'</a>', strip_tags($this->style('', $link)), $f, $name);
|
Chris@0
|
281 } else {
|
Chris@0
|
282 $name = sprintf('<abbr title="%s">'.$s.'</abbr>', $f, $name);
|
Chris@0
|
283 }
|
Chris@0
|
284 } else {
|
Chris@0
|
285 $name = $this->style('meta', $name);
|
Chris@0
|
286 }
|
Chris@0
|
287 $this->line = $name.' on line '.$this->style('meta', $line).':';
|
Chris@0
|
288 } else {
|
Chris@0
|
289 $this->line = $this->style('meta', $name).' on line '.$this->style('meta', $line).':';
|
Chris@0
|
290 }
|
Chris@0
|
291 $this->dumpLine(0);
|
Chris@0
|
292 };
|
Chris@0
|
293 $contextDumper = $contextDumper->bindTo($this->dumper, $this->dumper);
|
Chris@0
|
294 $contextDumper($name, $file, $line, $this->fileLinkFormat);
|
Chris@0
|
295 } else {
|
Chris@0
|
296 $cloner = new VarCloner();
|
Chris@0
|
297 $this->dumper->dump($cloner->cloneVar($name.' on line '.$line.':'));
|
Chris@0
|
298 }
|
Chris@0
|
299 $this->dumper->dump($data);
|
Chris@0
|
300 }
|
Chris@0
|
301
|
Chris@0
|
302 private function htmlEncode($s)
|
Chris@0
|
303 {
|
Chris@0
|
304 $html = '';
|
Chris@0
|
305
|
Chris@0
|
306 $dumper = new HtmlDumper(function ($line) use (&$html) { $html .= $line; }, $this->charset);
|
Chris@0
|
307 $dumper->setDumpHeader('');
|
Chris@0
|
308 $dumper->setDumpBoundaries('', '');
|
Chris@0
|
309
|
Chris@0
|
310 $cloner = new VarCloner();
|
Chris@0
|
311 $dumper->dump($cloner->cloneVar($s));
|
Chris@0
|
312
|
Chris@0
|
313 return substr(strip_tags($html), 1, -1);
|
Chris@0
|
314 }
|
Chris@0
|
315 }
|