Cleanup: Cleanup iterations in t3lib_timeTrack->printTSlog()
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_timetrack.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2009 Kasper Skaarhoj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Contains class with time tracking functions
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
32 * XHTML compliant
33 *
34 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
35 */
36 /**
37 * [CLASS/FUNCTION INDEX of SCRIPT]
38 *
39 *
40 *
41 * 88: class t3lib_timeTrack
42 *
43 * SECTION: Logging parsing times in the scripts
44 * 144: function start()
45 * 164: function push($tslabel, $value='')
46 * 189: function pull($content='')
47 * 207: function setTSlogMessage($content,$num=0)
48 * 221: function setTSselectQuery($query,$msg)
49 * 234: function incStackPointer()
50 * 245: function decStackPointer()
51 * 255: function mtime()
52 * 265: function convertMicrotime($microtime)
53 *
54 * SECTION: Printing the parsing time information (for Admin Panel)
55 * 298: function printTSlog()
56 * 447: function fixContent(&$arr, $content, $depthData='', $first=0, $vKey='')
57 * 511: function fixCLen($c,$v)
58 * 527: function fw($str)
59 * 541: function createHierarchyArray(&$arr,$pointer,$uniqueId)
60 * 561: function debug_typo3PrintError($header,$text,$js,$baseUrl='')
61 *
62 * TOTAL FUNCTIONS: 15
63 * (This index is automatically created/updated by the extension "extdeveval")
64 *
65 */
66
67
68
69
70
71
72
73
74
75
76
77 /**
78 * Frontend Timetracking functions
79 *
80 * Is used to register how much time is used with operations in TypoScript
81 * Used by index_ts
82 *
83 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
84 * @package TYPO3
85 * @subpackage t3lib
86 * @see t3lib_tsfeBeUserAuth, tslib_fe, tslib_cObj, TSpagegen
87 */
88 class t3lib_timeTrack {
89 var $starttime = 0; // Is loaded with the millisecond time when this object is created
90
91 var $LR = 1; // Log Rendering flag. If set, ->push() and ->pull() is called from the cObj->cObjGetSingle(). This determines whether or not the TypoScript parsing activity is logged. But it also slows down the rendering
92 var $printConf=array(
93 'showParentKeys' => 1,
94 'contentLength' => 10000, // Determines max lenght of displayed content before it gets cropped.
95 'contentLength_FILE' => 400, // Determines max lenght of displayed content FROM FILE cObjects before it gets cropped. Reason is that most FILE cObjects are huge and often used as template-code.
96 'flag_tree' => 1,
97 'flag_messages' => 1,
98 'flag_queries' => 0,
99 'flag_content' => 0,
100 'allTime' => 0,
101 'keyLgd' => 40,
102 'factor' => 10,
103 'col' => '#D9D5C9',
104 'highlight_col' => '#FF9933'
105 );
106
107 var $wrapError = array();
108 var $wrapIcon = array();
109 var $uniqueCounter = 0;
110 var $tsStack = array(array());
111 var $tsStackLevel = 0;
112 var $tsStackLevelMax = array();
113 var $tsStackLog = array();
114 var $tsStackPointer = 0;
115 var $currentHashPointer = array();
116
117 var $highlightLongerThan = 0; // Log entries that take than this number of milliseconds (own time) will be highlighted during log display. Set 0 to disable highlighting.
118
119
120
121
122
123
124
125 /*******************************************
126 *
127 * Logging parsing times in the scripts
128 *
129 *******************************************/
130
131 /**
132 * Constructor
133 * Sets the starting time
134 *
135 * @return void
136 */
137 function start() {
138 $this->wrapError = array(
139 0 => array('',''),
140 1 => array('<strong>','</strong>'),
141 2 => array('<strong style="color:#ff6600;">','</strong>'),
142 3 => array('<strong style="color:#ff0000;">','</strong>')
143 );
144
145 $this->wrapIcon = array(
146 0 => '',
147 1 => '<img src="'.TYPO3_mainDir.'gfx/icon_note.gif" width="18" height="16" align="absmiddle" alt="" />',
148 2 => '<img src="'.TYPO3_mainDir.'gfx/icon_warning.gif" width="18" height="16" align="absmiddle" alt="" />',
149 3 => '<img src="'.TYPO3_mainDir.'gfx/icon_fatalerror.gif" width="18" height="16" align="absmiddle" alt="" />'
150 );
151
152 $this->starttime = 0;
153 $this->starttime = $this->mtime();
154 }
155
156 /**
157 * Pushes an element to the TypoScript tracking array
158 *
159 * @param string Label string for the entry, eg. TypoScript property name
160 * @param string Additional value(?)
161 * @return void
162 * @see tslib_cObj::cObjGetSingle(), pull()
163 */
164 function push($tslabel, $value='') {
165 array_push($this->tsStack[$this->tsStackPointer], $tslabel);
166 array_push($this->currentHashPointer, 'timetracker_'.$this->uniqueCounter++);
167
168 $this->tsStackLevel++;
169 $this->tsStackLevelMax[] = $this->tsStackLevel;
170
171 // setTSlog
172 $k = end($this->currentHashPointer);
173 $this->tsStackLog[$k] = array(
174 'level' => $this->tsStackLevel,
175 'tsStack' => $this->tsStack,
176 'value' => $value,
177 'starttime' => microtime(),
178 'stackPointer' => $this->tsStackPointer
179 );
180 }
181
182 /**
183 * Pulls an element from the TypoScript tracking array
184 *
185 * @param string The content string generated within the push/pull part.
186 * @return void
187 * @see tslib_cObj::cObjGetSingle(), push()
188 */
189 function pull($content='') {
190 $k = end($this->currentHashPointer);
191 $this->tsStackLog[$k]['endtime'] = microtime();
192 $this->tsStackLog[$k]['content'] = $content;
193
194 $this->tsStackLevel--;
195 array_pop($this->tsStack[$this->tsStackPointer]);
196 array_pop($this->currentHashPointer);
197 }
198
199 /**
200 * Logs the TypoScript entry
201 *
202 * @param string The message string
203 * @param integer Message type: 0: information, 1: message, 2: warning, 3: error
204 * @return void
205 * @see tslib_cObj::CONTENT()
206 */
207 function setTSlogMessage($content,$num=0) {
208 end($this->currentHashPointer);
209 $k = current($this->currentHashPointer);
210
211 if (strlen($content)>30) { // Enlarge the "details" column by adding a wide clear.gif
212 $placeholder = '<br /><img src="'.TYPO3_mainDir.'clear.gif" width="300" height="1" alt="" />';
213 }
214 $this->tsStackLog[$k]['message'][] = $this->wrapIcon[$num].$this->wrapError[$num][0].htmlspecialchars($content).$this->wrapError[$num][1].$placeholder;
215 }
216
217 /**
218 * Set TSselectQuery - for messages in TypoScript debugger.
219 *
220 * @param array Query array
221 * @param string Message/Label to attach
222 * @return void
223 */
224 function setTSselectQuery(array $data,$msg='') {
225 end($this->currentHashPointer);
226 $k = current($this->currentHashPointer);
227
228 if (strlen($msg)) {
229 $data['msg'] = $msg;
230 }
231
232 $this->tsStackLog[$k]['selectQuery'][] = $data;
233 }
234
235 /**
236 * Increases the stack pointer
237 *
238 * @return void
239 * @see decStackPointer(), TSpagegen::renderContent(), tslib_cObj::cObjGetSingle()
240 */
241 function incStackPointer() {
242 $this->tsStackPointer++;
243 $this->tsStack[$this->tsStackPointer]=array();
244 }
245
246 /**
247 * Decreases the stack pointer
248 *
249 * @return void
250 * @see incStackPointer(), TSpagegen::renderContent(), tslib_cObj::cObjGetSingle()
251 */
252 function decStackPointer() {
253 unset($this->tsStack[$this->tsStackPointer]);
254 $this->tsStackPointer--;
255 }
256
257 /**
258 * Returns the current time in milliseconds
259 *
260 * @return integer
261 */
262 function mtime() {
263 return $this->convertMicrotime(microtime())-$this->starttime;
264 }
265
266 /**
267 * Returns microtime input to milliseconds
268 *
269 * @param string PHP microtime string
270 * @return integer
271 */
272 function convertMicrotime($microtime) {
273 $parts = explode(' ',$microtime);
274 return round(($parts[0]+$parts[1])*1000);
275 }
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293 /*******************************************
294 *
295 * Printing the parsing time information (for Admin Panel)
296 *
297 *******************************************/
298
299 /**
300 * Print TypoScript parsing log
301 *
302 * @return string HTML table with the information about parsing times.
303 * @see t3lib_tsfeBeUserAuth::extGetCategory_tsdebug()
304 */
305 function printTSlog() {
306 // Calculate times and keys for the tsStackLog
307 foreach ($this->tsStackLog as $uniqueId => &$data) {
308 $data['endtime'] = $this->convertMicrotime($data['endtime']) - $this->starttime;
309 $data['starttime'] = $this->convertMicrotime($data['starttime']) - $this->starttime;
310 $data['deltatime'] = $data['endtime'] - $data['starttime'];
311 $data['key'] = implode($data['stackPointer'] ? '.' : '/', end($data['tsStack']));
312 }
313
314 // Create hierarchical array of keys pointing to the stack
315 $arr = array();
316 foreach ($this->tsStackLog as $uniqueId => $data) {
317 $this->createHierarchyArray($arr, $data['level'], $uniqueId);
318 }
319 // Parsing the registeret content and create icon-html for the tree
320 $this->tsStackLog[$arr['0.'][0]]['content'] = $this->fixContent($arr['0.']['0.'], $this->tsStackLog[$arr['0.'][0]]['content'], '', 0, $arr['0.'][0]);
321
322 // Displaying the tree:
323 $outputArr = array();
324 $outputArr[] = $this->fw('TypoScript Key');
325 $outputArr[] = $this->fw('Value');
326
327 if ($this->printConf['allTime']) {
328 $outputArr[] = $this->fw('Time');
329 $outputArr[] = $this->fw('Own');
330 $outputArr[] = $this->fw('Sub');
331 $outputArr[] = $this->fw('Total');
332 } else {
333 $outputArr[] = $this->fw('Own');
334 }
335
336 $outputArr[] = $this->fw('Details');
337
338 $out = '';
339 foreach ($outputArr as $row) {
340 $out.= '
341 <th style="text-align:center; background:#ABBBB4;"><strong>'.$row.'</strong></th>';
342 }
343 $out = '<tr>'.$out.'</tr>';
344
345 $flag_tree = $this->printConf['flag_tree'];
346 $flag_messages = $this->printConf['flag_messages'];
347 $flag_content = $this->printConf['flag_content'];
348 $flag_queries = $this->printConf['flag_queries'];
349 $keyLgd = $this->printConf['keyLgd'];
350 $factor = $this->printConf['factor'];
351 $col = $this->printConf['col'];
352 $highlight_col = $this->printConf['highlight_col'];
353
354 $c=0;
355 foreach ($this->tsStackLog as $uniqueId => $data) {
356 $bgColor = ' background-color:'.($c%2 ? t3lib_div::modifyHTMLColor($col,$factor,$factor,$factor) : $col).';';
357 if ($this->highlightLongerThan && intval($data['owntime']) > intval($this->highlightLongerThan)) {
358 $bgColor = ' background-color:'.$highlight_col.';';
359 }
360
361 $item = '';
362 if (!$c) { // If first...
363 $data['icons'] = '';
364 $data['key'] = 'Script Start';
365 $data['value'] = '';
366 }
367
368
369 // key label:
370 $keyLabel = '';
371 if (!$flag_tree && $data['stackPointer']) {
372 $temp = array();
373 reset($data['tsStack']);
374 while(list($k,$v)=each($data['tsStack'])) {
375 $temp[] = t3lib_div::fixed_lgd_cs(implode($v,$k?'.':'/'),-$keyLgd);
376 }
377 array_pop($temp);
378 $temp = array_reverse($temp);
379 array_pop($temp);
380 if (count($temp)) {
381 $keyLabel = '<br /><span style="color:#999999;">'.implode($temp,'<br />').'</span>';
382 }
383 }
384 if ($flag_tree) {
385 $tmp = t3lib_div::trimExplode('.',$data['key'],1);
386 $theLabel = end($tmp);
387 } else {
388 $theLabel = $data['key'];
389 }
390 $theLabel = t3lib_div::fixed_lgd_cs($theLabel, -$keyLgd);
391 $theLabel = $data['stackPointer'] ? '<span style="color:maroon;">'.$theLabel.'</span>' : $theLabel;
392 $keyLabel = $theLabel.$keyLabel;
393 $item.= '<td valign="top" style="text-align:left; white-space:nowrap; padding-left:2px;'.$bgColor.'">'.($flag_tree?$data['icons']:'').$this->fw($keyLabel).'</td>';
394
395 // key value:
396 $keyValue = $data['value'];
397 $item.= '<td valign="top" style="text-align:left; white-space:nowrap;'.$bgColor.'">'.$this->fw(htmlspecialchars($keyValue)).'</td>';
398
399 if ($this->printConf['allTime']) {
400 $item.= '<td valign="top" style="text-align:right; white-space:nowrap;'.$bgColor.'"> '.$this->fw($data['starttime']).'</td>';
401 $item.= '<td valign="top" style="text-align:right; white-space:nowrap;'.$bgColor.'"> '.$this->fw($data['owntime']).'</td>';
402 $item.= '<td valign="top" style="text-align:left; white-space:nowrap;'.$bgColor.'"> '.$this->fw($data['subtime'] ? '+'.$data['subtime'] : '').'</td>';
403 $item.= '<td valign="top" style="text-align:left; white-space:nowrap;'.$bgColor.'"> '.$this->fw($data['subtime'] ? '='.$data['deltatime'] : '').'</td>';
404 } else {
405 $item.= '<td valign="top" style="text-align:right; white-space:nowrap;'.$bgColor.'"> '.$this->fw($data['owntime']).'</td>';
406 }
407
408
409 // messages:
410 $msgArr = array();
411 $msg = '';
412 if ($flag_messages && is_array($data['message'])) {
413 reset($data['message']);
414 while(list(,$v)=each($data['message'])) {
415 $msgArr[] = nl2br($v);
416 }
417 }
418 if ($flag_queries && is_array($data['selectQuery'])) {
419 $msgArr[] = t3lib_div::view_array($data['selectQuery']);
420 }
421 if ($flag_content && strcmp($data['content'],'')) {
422 $maxlen = 120;
423 if (preg_match_all('/(\S{'.$maxlen.',})/', $data['content'], $reg)) { // Break lines which are too longer than $maxlen chars (can happen if content contains long paths...)
424 foreach ($reg[1] as $key=>$match) {
425 $match = preg_replace('/(.{'.$maxlen.'})/', '$1 ', $match);
426 $data['content'] = str_replace($reg[0][$key], $match, $data['content']);
427 }
428 }
429 $msgArr[] = '<span style="color:#000066;">'.nl2br($data['content']).'</span>';
430 }
431 if (count($msgArr)) {
432 $msg = implode($msgArr,'<hr />');
433 }
434 $item.= '<td valign="top" style="text-align:left;'.$bgColor.'">'.$this->fw($msg).'</td>';
435 $out.= '<tr>'.$item.'</tr>';
436 $c++;
437 }
438 $out = '<table border="0" cellpadding="0" cellspacing="0" summary="">'.$out.'</table>';
439 return $out;
440 }
441
442 /**
443 * Recursively generates the content to display
444 *
445 * @param array Array which is modified with content. Reference
446 * @param string Current content string for the level
447 * @param string Prefixed icons for new PM icons
448 * @param boolean Set this for the first call from outside.
449 * @param string Seems to be the previous tsStackLog key
450 * @return string Returns the $content string generated/modified. Also the $arr array is modified!
451 */
452 function fixContent(&$arr, $content, $depthData='', $first=0, $vKey='') {
453 $ac=0;
454 $c=0;
455 // First, find number of entries
456 reset($arr);
457 while(list($k,$v)=each($arr)) {
458 if (t3lib_div::testInt($k)) {
459 $ac++;
460 }
461 }
462 // Traverse through entries
463 $subtime=0;
464 reset($arr);
465 while(list($k,$v)=each($arr)) {
466 if (t3lib_div::testInt($k)) {
467 $c++;
468
469 $deeper = is_array($arr[$k.'.']) ? 1 : 0;
470 $PM = 'join';
471 $LN = ($ac==$c)?'blank':'line';
472 $BTM = ($ac==$c)?'bottom':'';
473 $PM = is_array($arr[$k.'.']) ? ($deeper ? 'minus':'plus') : 'join';
474 $this->tsStackLog[$v]['icons'] = $depthData.($first?'':'<img src="'.TYPO3_mainDir.'gfx/ol/'.$PM.$BTM.'.gif" width="18" height="16" align="top" border="0" alt="" />');
475
476 if (strlen($this->tsStackLog[$v]['content'])) {
477 $content = str_replace($this->tsStackLog[$v]['content'],$v, $content);
478 }
479 if (is_array($arr[$k.'.'])) {
480 $this->tsStackLog[$v]['content'] = $this->fixContent($arr[$k.'.'], $this->tsStackLog[$v]['content'], $depthData.($first?'':'<img src="'.TYPO3_mainDir.'gfx/ol/'.$LN.'.gif" width="18" height="16" align="top" border="0" alt="" />'), 0, $v);
481 } else {
482 $this->tsStackLog[$v]['content'] = $this->fixCLen($this->tsStackLog[$v]['content'], $this->tsStackLog[$v]['value']);
483 $this->tsStackLog[$v]['subtime'] = '';
484 $this->tsStackLog[$v]['owntime'] = $this->tsStackLog[$v]['deltatime'];
485 }
486 $subtime+= $this->tsStackLog[$v]['deltatime'];
487 }
488 }
489 // Set content with special chars
490 if (isset($this->tsStackLog[$vKey])) {
491 $this->tsStackLog[$vKey]['subtime'] = $subtime;
492 $this->tsStackLog[$vKey]['owntime'] = $this->tsStackLog[$vKey]['deltatime']-$subtime;
493 }
494 $content=$this->fixCLen($content, $this->tsStackLog[$vKey]['value']);
495
496 // Traverse array again, this time substitute the unique hash with the red key
497 reset($arr);
498 while(list($k,$v)=each($arr)) {
499 if (t3lib_div::testInt($k)) {
500 if (strlen($this->tsStackLog[$v]['content'])) {
501 $content = str_replace($v, '<strong style="color:red;">['.$this->tsStackLog[$v]['key'].']</strong>', $content);
502 }
503 }
504 }
505 // return the content
506 return $content;
507 }
508
509 /**
510 * 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"
511 *
512 * @param string The content string
513 * @param string Command: If "FILE" then $this->printConf['contentLength_FILE'] is used for content length comparison, otherwise $this->printConf['contentLength']
514 * @return string
515 */
516 function fixCLen($c,$v) {
517 $len = $v=='FILE'?$this->printConf['contentLength_FILE']:$this->printConf['contentLength'];
518 if (strlen($c)>$len) {
519 $c = '<span style="color:green;">'.htmlspecialchars(t3lib_div::fixed_lgd_cs($c,$len)).'</span>';
520 } else {
521 $c = htmlspecialchars($c);
522 }
523 return $c;
524 }
525
526 /**
527 * Wraps input string in a <span> tag with black verdana font
528 *
529 * @param string The string to be wrapped
530 * @return string
531 */
532 function fw($str) {
533 return '<span style="font-family:Verdana,Arial,Helvetica,sans-serif; font-size:10px; color:black; vertical-align:top;">'.$str.'&nbsp;</span>';
534 }
535
536 /**
537 * Helper function for internal data manipulation
538 *
539 * @param array Array (passed by reference) and modified
540 * @param integer Pointer value
541 * @param string Unique ID string
542 * @return void
543 * @access private
544 * @see printTSlog()
545 */
546 function createHierarchyArray(&$arr,$pointer,$uniqueId) {
547 if (!is_array($arr)) {
548 $arr = array();
549 }
550 if ($pointer>0) {
551 end($arr);
552 $k = key($arr);
553 $this->createHierarchyArray($arr[intval($k).'.'],$pointer-1,$uniqueId);
554 } else {
555 $arr[] = $uniqueId;
556 }
557 }
558
559 /**
560 * This prints out a TYPO3 error message.
561 *
562 * @param string Header string
563 * @param string Message string
564 * @param boolean If set, then this will produce a alert() line for inclusion in JavaScript.
565 * @param string URL for the <base> tag (if you want it)
566 * @return string
567 */
568 function debug_typo3PrintError($header,$text,$js,$baseUrl='') {
569 if ($js) {
570 echo "alert('".t3lib_div::slashJS($header."\n".$text)."');";
571 } else {
572 echo '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
573 "http://www.w3.org/TR/xhtml1/DTD/xhtml11.dtd">
574 <?xml version="1.0" encoding="utf-8"?>
575 <html>
576 <head>
577 '.($baseUrl ? '<base href="'.htmlspecialchars($baseUrl).'" />' : '').'
578 <title>Error!</title>
579 <style type="text/css"><!--/*--><![CDATA[/*><!--*/
580 body { font-family:Verdana,Arial,Helvetica,sans-serif; font-size: 90%; text-align: center; background-color: #ffffff; }
581 h1 { font-size: 1.2em; margin: 0 0 1em 0; }
582 p { margin: 0; text-align: left; }
583 img { border: 0; margin: 10px 0; }
584 div.center div { margin: 0 auto; }
585 .errorBox { width: 400px; padding: 0.5em; border: 1px solid black; background-color: #F4F0E8; }
586 /*]]>*/--></style>
587 </head>
588 <body>
589 <div class="center">
590 <img src="'.TYPO3_mainDir.'gfx/typo3logo.gif" width="123" height="34" alt="" />
591 <div class="errorBox">
592 <h1>'.$header.'</h1>
593 <p>'.$text.'</p>
594 </div>
595 </div>
596 </body>
597 </html>';
598 }
599 }
600 }
601
602 // XCLASSing is not possible for this class
603
604 ?>