14bf30ce3e3c3e686e54bb895636898be82bcd3b
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / TimeTracker / TimeTracker.php
1 <?php
2 namespace TYPO3\CMS\Core\TimeTracker;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16 use TYPO3\CMS\Core\Imaging\Icon;
17 use TYPO3\CMS\Core\Imaging\IconFactory;
18 use TYPO3\CMS\Core\SingletonInterface;
19 use TYPO3\CMS\Core\Utility\GeneralUtility;
20
21 /**
22 * Frontend Timetracking functions
23 *
24 * Is used to register how much time is used with operations in TypoScript
25 */
26 class TimeTracker implements SingletonInterface
27 {
28 /**
29 * If set to true (see constructor) then then the timetracking is enabled
30 * @var bool
31 */
32 protected $isEnabled = false;
33
34 /**
35 * Is loaded with the millisecond time when this object is created
36 *
37 * @var int
38 */
39 public $starttime = 0;
40
41 /**
42 * Log Rendering flag. If set, ->push() and ->pull() is called from the cObj->cObjGetSingle().
43 * This determines whether or not the TypoScript parsing activity is logged. But it also slows down the rendering
44 *
45 * @var bool
46 */
47 public $LR = 1;
48
49 /**
50 * @var array
51 */
52 public $printConf = [
53 'showParentKeys' => 1,
54 'contentLength' => 10000,
55 // Determines max length of displayed content before it gets cropped.
56 'contentLength_FILE' => 400,
57 // Determines max length of displayed content FROM FILE cObjects before it gets cropped. Reason is that most FILE cObjects are huge and often used as template-code.
58 'flag_tree' => 1,
59 'flag_messages' => 1,
60 'flag_content' => 0,
61 'allTime' => 0,
62 'keyLgd' => 40
63 ];
64
65 /**
66 * @var array
67 */
68 public $wrapError = [
69 0 => ['', ''],
70 1 => ['<strong>', '</strong>'],
71 2 => ['<strong style="color:#ff6600;">', '</strong>'],
72 3 => ['<strong style="color:#ff0000;">', '</strong>']
73 ];
74
75 /**
76 * @var array
77 */
78 public $wrapIcon = [
79 0 => '',
80 1 => 'actions-document-info',
81 2 => 'status-dialog-warning',
82 3 => 'status-dialog-error'
83 ];
84
85 /**
86 * @var int
87 */
88 public $uniqueCounter = 0;
89
90 /**
91 * @var array
92 */
93 public $tsStack = [[]];
94
95 /**
96 * @var int
97 */
98 public $tsStackLevel = 0;
99
100 /**
101 * @var array
102 */
103 public $tsStackLevelMax = [];
104
105 /**
106 * @var array
107 */
108 public $tsStackLog = [];
109
110 /**
111 * @var int
112 */
113 public $tsStackPointer = 0;
114
115 /**
116 * @var array
117 */
118 public $currentHashPointer = [];
119
120 /**
121 * Log entries that take than this number of milliseconds (own time) will be highlighted during log display. Set 0 to disable highlighting.
122 *
123 * @var int
124 */
125 public $highlightLongerThan = 0;
126
127 /*******************************************
128 *
129 * Logging parsing times in the scripts
130 *
131 *******************************************/
132
133 /**
134 * TimeTracker constructor.
135 *
136 * @param bool $isEnabled
137 */
138 public function __construct($isEnabled = true)
139 {
140 $this->isEnabled = $isEnabled;
141 }
142
143 /**
144 * Sets the starting time
145 */
146 public function start()
147 {
148 if (!$this->isEnabled) {
149 return;
150 }
151 $this->starttime = $this->getMilliseconds();
152 }
153
154 /**
155 * Pushes an element to the TypoScript tracking array
156 *
157 * @param string $tslabel Label string for the entry, eg. TypoScript property name
158 * @param string $value Additional value(?)
159 * @see \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::cObjGetSingle(), pull()
160 */
161 public function push($tslabel, $value = '')
162 {
163 if (!$this->isEnabled) {
164 return;
165 }
166 $this->tsStack[$this->tsStackPointer][] = $tslabel;
167 $this->currentHashPointer[] = 'timetracker_' . $this->uniqueCounter++;
168 $this->tsStackLevel++;
169 $this->tsStackLevelMax[] = $this->tsStackLevel;
170 // setTSlog
171 $k = end($this->currentHashPointer);
172 $this->tsStackLog[$k] = [
173 'level' => $this->tsStackLevel,
174 'tsStack' => $this->tsStack,
175 'value' => $value,
176 'starttime' => microtime(true),
177 'stackPointer' => $this->tsStackPointer
178 ];
179 }
180
181 /**
182 * Pulls an element from the TypoScript tracking array
183 *
184 * @param string $content The content string generated within the push/pull part.
185 * @see \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::cObjGetSingle(), push()
186 */
187 public function pull($content = '')
188 {
189 if (!$this->isEnabled) {
190 return;
191 }
192 $k = end($this->currentHashPointer);
193 $this->tsStackLog[$k]['endtime'] = microtime(true);
194 $this->tsStackLog[$k]['content'] = $content;
195 $this->tsStackLevel--;
196 array_pop($this->tsStack[$this->tsStackPointer]);
197 array_pop($this->currentHashPointer);
198 }
199
200 /**
201 * Logs the TypoScript entry
202 *
203 * @param string $content The message string
204 * @param int $num Message type: 0: information, 1: message, 2: warning, 3: error
205 * @see \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::CONTENT()
206 */
207 public function setTSlogMessage($content, $num = 0)
208 {
209 if (!$this->isEnabled) {
210 return;
211 }
212 end($this->currentHashPointer);
213 $k = current($this->currentHashPointer);
214 $placeholder = '';
215 // Enlarge the "details" column by adding a span
216 if (strlen($content) > 30) {
217 $placeholder = '<br /><span style="width: 300px; height: 1px; display: inline-block;"></span>';
218 }
219 $iconFactory = GeneralUtility::makeInstance(IconFactory::class);
220 $this->tsStackLog[$k]['message'][] = $iconFactory->getIcon($this->wrapIcon[$num], Icon::SIZE_SMALL)->render() . $this->wrapError[$num][0] . htmlspecialchars($content) . $this->wrapError[$num][1] . $placeholder;
221 }
222
223 /**
224 * Set TSselectQuery - for messages in TypoScript debugger.
225 *
226 * @param array $data Query array
227 * @param string $msg Message/Label to attach
228 */
229 public function setTSselectQuery(array $data, $msg = '')
230 {
231 if (!$this->isEnabled) {
232 return;
233 }
234 end($this->currentHashPointer);
235 $k = current($this->currentHashPointer);
236 if ($msg !== '') {
237 $data['msg'] = $msg;
238 }
239 $this->tsStackLog[$k]['selectQuery'][] = $data;
240 }
241
242 /**
243 * Increases the stack pointer
244 *
245 * @see decStackPointer(), \TYPO3\CMS\Frontend\Page\PageGenerator::renderContent(), \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::cObjGetSingle()
246 */
247 public function incStackPointer()
248 {
249 if (!$this->isEnabled) {
250 return;
251 }
252 $this->tsStackPointer++;
253 $this->tsStack[$this->tsStackPointer] = [];
254 }
255
256 /**
257 * Decreases the stack pointer
258 *
259 * @see incStackPointer(), \TYPO3\CMS\Frontend\Page\PageGenerator::renderContent(), \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::cObjGetSingle()
260 */
261 public function decStackPointer()
262 {
263 if (!$this->isEnabled) {
264 return;
265 }
266 unset($this->tsStack[$this->tsStackPointer]);
267 $this->tsStackPointer--;
268 }
269
270 /**
271 * Gets a microtime value as milliseconds value.
272 *
273 * @param float $microtime The microtime value - if not set the current time is used
274 * @return int The microtime value as milliseconds value
275 */
276 public function getMilliseconds($microtime = null)
277 {
278 if (!$this->isEnabled) {
279 return 0;
280 }
281 if (!isset($microtime)) {
282 $microtime = microtime(true);
283 }
284 return round($microtime * 1000);
285 }
286
287 /**
288 * Gets the difference between a given microtime value and the starting time as milliseconds.
289 *
290 * @param float $microtime The microtime value - if not set the current time is used
291 * @return int The difference between a given microtime value and starting time as milliseconds
292 */
293 public function getDifferenceToStarttime($microtime = null)
294 {
295 return $this->getMilliseconds($microtime) - $this->starttime;
296 }
297
298 /*******************************************
299 *
300 * Printing the parsing time information (for Admin Panel)
301 *
302 *******************************************/
303 /**
304 * Print TypoScript parsing log
305 *
306 * @return string HTML table with the information about parsing times.
307 */
308 public function printTSlog()
309 {
310 if (!$this->isEnabled) {
311 return '';
312 }
313 // Calculate times and keys for the tsStackLog
314 foreach ($this->tsStackLog as $uniqueId => &$data) {
315 $data['endtime'] = $this->getDifferenceToStarttime($data['endtime']);
316 $data['starttime'] = $this->getDifferenceToStarttime($data['starttime']);
317 $data['deltatime'] = $data['endtime'] - $data['starttime'];
318 if (is_array($data['tsStack'])) {
319 $data['key'] = implode($data['stackPointer'] ? '.' : '/', end($data['tsStack']));
320 }
321 }
322 unset($data);
323 // Create hierarchical array of keys pointing to the stack
324 $arr = [];
325 foreach ($this->tsStackLog as $uniqueId => $data) {
326 $this->createHierarchyArray($arr, $data['level'], $uniqueId);
327 }
328 // Parsing the registeret content and create icon-html for the tree
329 $this->tsStackLog[$arr['0.'][0]]['content'] = $this->fixContent($arr['0.'], $this->tsStackLog[$arr['0.'][0]]['content'], '', 0, $arr['0.'][0]);
330 // Displaying the tree:
331 $outputArr = [];
332 $outputArr[] = $this->fw('TypoScript Key');
333 $outputArr[] = $this->fw('Value');
334 if ($this->printConf['allTime']) {
335 $outputArr[] = $this->fw('Time');
336 $outputArr[] = $this->fw('Own');
337 $outputArr[] = $this->fw('Sub');
338 $outputArr[] = $this->fw('Total');
339 } else {
340 $outputArr[] = $this->fw('Own');
341 }
342 $outputArr[] = $this->fw('Details');
343 $out = '';
344 foreach ($outputArr as $row) {
345 $out .= '
346 <th><strong>' . $row . '</strong></th>';
347 }
348 $out = '<tr class="typo3-adminPanel-itemRow">' . $out . '</tr>';
349 $flag_tree = $this->printConf['flag_tree'];
350 $flag_messages = $this->printConf['flag_messages'];
351 $flag_content = $this->printConf['flag_content'];
352 $keyLgd = $this->printConf['keyLgd'];
353 $c = 0;
354 foreach ($this->tsStackLog as $uniqueId => $data) {
355 if ($this->highlightLongerThan && (int)$data['owntime'] > (int)$this->highlightLongerThan) {
356 $logRowClass = 'typo3-adminPanel-logRow-highlight';
357 } else {
358 $logRowClass = $c % 2 ? 'line-odd' : 'line-even';
359 }
360 $logRowClass .= ' typo3-adminPanel-section-content-title';
361 $item = '';
362 // If first...
363 if (!$c) {
364 $data['icons'] = '';
365 $data['key'] = 'Script Start';
366 $data['value'] = '';
367 }
368 // Key label:
369 $keyLabel = '';
370 if (!$flag_tree && $data['stackPointer']) {
371 $temp = [];
372 foreach ($data['tsStack'] as $k => $v) {
373 $temp[] = GeneralUtility::fixed_lgd_cs(implode($v, $k ? '.' : '/'), -$keyLgd);
374 }
375 array_pop($temp);
376 $temp = array_reverse($temp);
377 array_pop($temp);
378 if (!empty($temp)) {
379 $keyLabel = '<br /><span style="color:#999999;">' . implode($temp, '<br />') . '</span>';
380 }
381 }
382 if ($flag_tree) {
383 $tmp = GeneralUtility::trimExplode('.', $data['key'], true);
384 $theLabel = end($tmp);
385 } else {
386 $theLabel = $data['key'];
387 }
388 $theLabel = GeneralUtility::fixed_lgd_cs($theLabel, -$keyLgd);
389 $theLabel = $data['stackPointer'] ? '<span class="stackPointer">' . $theLabel . '</span>' : $theLabel;
390 $keyLabel = $theLabel . $keyLabel;
391 $item .= '<td class="' . $logRowClass . '">' . ($flag_tree ? $data['icons'] : '') . $this->fw($keyLabel) . '</td>';
392 // Key value:
393 $keyValue = $data['value'];
394 $item .= '<td class="' . $logRowClass . ' typo3-adminPanel-tsLogTime">' . $this->fw(htmlspecialchars($keyValue)) . '</td>';
395 if ($this->printConf['allTime']) {
396 $item .= '<td class="' . $logRowClass . ' typo3-adminPanel-tsLogTime"> ' . $this->fw($data['starttime']) . '</td>';
397 $item .= '<td class="' . $logRowClass . ' typo3-adminPanel-tsLogTime"> ' . $this->fw($data['owntime']) . '</td>';
398 $item .= '<td class="' . $logRowClass . ' typo3-adminPanel-tsLogTime"> ' . $this->fw(($data['subtime'] ? '+' . $data['subtime'] : '')) . '</td>';
399 $item .= '<td class="' . $logRowClass . ' typo3-adminPanel-tsLogTime"> ' . $this->fw(($data['subtime'] ? '=' . $data['deltatime'] : '')) . '</td>';
400 } else {
401 $item .= '<td class="' . $logRowClass . ' typo3-adminPanel-tsLogTime"> ' . $this->fw($data['owntime']) . '</td>';
402 }
403 // Messages:
404 $msgArr = [];
405 $msg = '';
406 if ($flag_messages && is_array($data['message'])) {
407 foreach ($data['message'] as $v) {
408 $msgArr[] = nl2br($v);
409 }
410 }
411 if ($flag_content && (string)$data['content'] !== '') {
412 $maxlen = 120;
413 // Break lines which are too longer than $maxlen chars (can happen if content contains long paths...)
414 if (preg_match_all('/(\\S{' . $maxlen . ',})/', $data['content'], $reg)) {
415 foreach ($reg[1] as $key => $match) {
416 $match = preg_replace('/(.{' . $maxlen . '})/', '$1 ', $match);
417 $data['content'] = str_replace($reg[0][$key], $match, $data['content']);
418 }
419 }
420 $msgArr[] = '<span style="color:#000066;">' . nl2br($data['content']) . '</span>';
421 }
422 if (!empty($msgArr)) {
423 $msg = implode($msgArr, '<hr />');
424 }
425 $item .= '<td valign="top" class="' . $logRowClass . '" style="text-align:left;">' . $this->fw($msg) . '</td>';
426 $out .= '<tr class="typo3-adminPanel-itemRow">' . $item . '</tr>';
427 $c++;
428 }
429 $out = '<table class="typo3-adminPanel-table typo3-adminPanel-tsLog">' . $out . '</table>';
430 return $out;
431 }
432
433 /**
434 * Recursively generates the content to display
435 *
436 * @param array $arr Array which is modified with content. Reference
437 * @param string $content Current content string for the level
438 * @param string $depthData Prefixed icons for new PM icons
439 * @param bool $first Set this for the first call from outside.
440 * @param string $vKey Seems to be the previous tsStackLog key
441 * @return string Returns the $content string generated/modified. Also the $arr array is modified!
442 */
443 protected function fixContent(&$arr, $content, $depthData = '', $first = 0, $vKey = '')
444 {
445 $ac = 0;
446 $c = 0;
447 // First, find number of entries
448 foreach ($arr as $k => $v) {
449 if (\TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($k)) {
450 $ac++;
451 }
452 }
453 // Traverse through entries
454 $subtime = 0;
455 foreach ($arr as $k => $v) {
456 if (\TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($k)) {
457 $c++;
458 $deeper = is_array($arr[$k . '.']) ? 1 : 0;
459 $LN = $ac == $c ? 'blank' : 'line';
460
461 $BTM = $ac == $c ? 'bottom' : '';
462 $PM = is_array($arr[$k . '.']) ? '<i class="fa fa-' . ($deeper ? 'minus' : 'plus') . '-square-o"></i>' : '<span class="treeline-icon treeline-icon-join' . ($BTM ? 'bottom' : '') . '"></span>';
463
464 $this->tsStackLog[$v]['icons'] = $depthData . ($first ? '' : $PM);
465 if ($this->tsStackLog[$v]['content'] !== '') {
466 $content = str_replace($this->tsStackLog[$v]['content'], $v, $content);
467 }
468 if (is_array($arr[$k . '.'])) {
469 $this->tsStackLog[$v]['content'] = $this->fixContent($arr[$k . '.'], $this->tsStackLog[$v]['content'], $depthData . ($first ? '' : '<span class="treeline-icon treeline-icon-' . $LN . '"></span>'), 0, $v);
470 } else {
471 $this->tsStackLog[$v]['content'] = $this->fixCLen($this->tsStackLog[$v]['content'], $this->tsStackLog[$v]['value']);
472 $this->tsStackLog[$v]['subtime'] = '';
473 $this->tsStackLog[$v]['owntime'] = $this->tsStackLog[$v]['deltatime'];
474 }
475 $subtime += $this->tsStackLog[$v]['deltatime'];
476 }
477 }
478 // Set content with special chars
479 if (isset($this->tsStackLog[$vKey])) {
480 $this->tsStackLog[$vKey]['subtime'] = $subtime;
481 $this->tsStackLog[$vKey]['owntime'] = $this->tsStackLog[$vKey]['deltatime'] - $subtime;
482 }
483 $content = $this->fixCLen($content, $this->tsStackLog[$vKey]['value']);
484 // Traverse array again, this time substitute the unique hash with the red key
485 foreach ($arr as $k => $v) {
486 if (\TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($k)) {
487 if ($this->tsStackLog[$v]['content'] !== '') {
488 $content = str_replace($v, '<strong style="color:red;">[' . $this->tsStackLog[$v]['key'] . ']</strong>', $content);
489 }
490 }
491 }
492 // Return the content
493 return $content;
494 }
495
496 /**
497 * Wraps the input content string in green colored span-tags IF the length o fthe input string exceeds $this->printConf['contentLength'] (or $this->printConf['contentLength_FILE'] if $v == "FILE"
498 *
499 * @param string $c The content string
500 * @param string $v Command: If "FILE" then $this->printConf['contentLength_FILE'] is used for content length comparison, otherwise $this->printConf['contentLength']
501 * @return string
502 */
503 protected function fixCLen($c, $v)
504 {
505 $len = $v === 'FILE' ? $this->printConf['contentLength_FILE'] : $this->printConf['contentLength'];
506 if (strlen($c) > $len) {
507 $c = '<span style="color:green;">' . htmlspecialchars(GeneralUtility::fixed_lgd_cs($c, $len)) . '</span>';
508 } else {
509 $c = htmlspecialchars($c);
510 }
511 return $c;
512 }
513
514 /**
515 * Wraps input string in a <span> tag
516 *
517 * @param string $str The string to be wrapped
518 * @return string
519 */
520 protected function fw($str)
521 {
522 return '<span>' . $str . '</span>';
523 }
524
525 /**
526 * Helper function for internal data manipulation
527 *
528 * @param array $arr Array (passed by reference) and modified
529 * @param int $pointer Pointer value
530 * @param string $uniqueId Unique ID string
531 * @access private
532 * @see printTSlog()
533 */
534 protected function createHierarchyArray(&$arr, $pointer, $uniqueId)
535 {
536 if (!is_array($arr)) {
537 $arr = [];
538 }
539 if ($pointer > 0) {
540 end($arr);
541 $k = key($arr);
542 $this->createHierarchyArray($arr[(int)$k . '.'], $pointer - 1, $uniqueId);
543 } else {
544 $arr[] = $uniqueId;
545 }
546 }
547 }