Source for file Debug.php

Documentation is available at Debug.php

1: <?php
2:
3: /**
4: * Nette Framework
5: *
6: * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7: *
8: * This source file is subject to the "Nette license" that is bundled
9: * with this package in the file license.txt.
10: *
11: * For more information please see https://nette.org
12: *
13: * @copyright Copyright (c) 2004, 2009 David Grudl
14: * @license https://nette.org/license Nette license
15: * @link https://nette.org
16: * @category Nette
17: * @package Nette
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/compatibility.php';
24:
25: require_once dirname(__FILE__) . '/exceptions.php';
26:
27: require_once dirname(__FILE__) . '/Framework.php';
28:
29:
30:
31: /**
32: * Debug static class.
33: *
34: * @author David Grudl
35: * @copyright Copyright (c) 2004, 2009 David Grudl
36: * @package Nette
37: */
38: final class Debug
39: {
40: /**#@+ server modes {@link Debug::enable()} */
41: const DEVELOPMENT = FALSE;
42: const PRODUCTION = TRUE;
43: const DETECT = NULL;
44: /**#@-*/
45:
46: /** @var array free counters for your usage */
47: public static $counters = array();
48:
49: /** @deprecated {@link Debug::$consoleMode} */
50: public static $html;
51:
52: /** @var bool determines whether a server is running in production mode */
53: public static $productionMode;
54:
55: /** @var bool determines whether a server is running in console mode */
56: public static $consoleMode;
57:
58: /** @var int how many nested levels of array/object properties display {@link Debug::dump()} */
59: public static $maxDepth = 3;
60:
61: /** @var int how long strings display {@link Debug::dump()} */
62: public static $maxLen = 150;
63:
64: /** @var int sensitive keys not displayed by {@link Debug::dump()} when {@link Debug::$productionMode} in on */
65: public static $keysToHide = array('password', 'passwd', 'pass', 'pwd', 'creditcard', 'credit card', 'cc', 'pin');
66:
67: /** @var bool {@link Debug::enable()} */
68: private static $enabled = FALSE;
69:
70: /** @var bool {@link Debug::enableProfiler()} */
71: private static $enabledProfiler = FALSE;
72:
73: /** @var bool is Firebug & FirePHP detected? */
74: private static $firebugDetected;
75:
76: /** @var bool is AJAX request detected? */
77: private static $ajaxDetected;
78:
79: /** @var string name of the file where script errors should be logged */
80: private static $logFile;
81:
82: /** @var resource */
83: private static $logHandle;
84:
85: /** @var bool send e-mail notifications of errors? */
86: private static $sendEmails;
87:
88: /** @var string e-mail headers & body */
89: private static $emailHeaders = array(
90: 'To' => '',
91: 'From' => 'noreply@%host%',
92: 'X-Mailer' => 'Nette Framework',
93: 'Subject' => 'PHP: An error occurred on the server %host%',
94: 'Body' => '[%date%] %message%',
95: );
96:
97: /** @var callback */
98: public static $mailer = array(__CLASS__, 'defaultMailer');
99:
100: /** @deprecated */
101: public static $emailProbability;
102:
103: /** @var array */
104: private static $colophons = array(array(__CLASS__, 'getDefaultColophons'));
105:
106: /** @var array */
107: private static $keyFilter = array();
108:
109: /** @var int */
110: public static $time;
111:
112: /**#@+ FirePHP log priority */
113: const LOG = 'LOG';
114: const INFO = 'INFO';
115: const WARN = 'WARN';
116: const ERROR = 'ERROR';
117: const TRACE = 'TRACE';
118: const EXCEPTION = 'EXCEPTION';
119: const GROUP_START = 'GROUP_START';
120: const GROUP_END = 'GROUP_END';
121: /**#@-*/
122:
123:
124:
125: /**
126: * Static class - cannot be instantiated.
127: */
128: final public function __construct()
129: {
130: throw new LogicException("Cannot instantiate static class " . get_class($this));
131: }
132:
133:
134:
135: /**
136: * Static class constructor.
137: */
138: public static function init()
139: {
140: self::$time = microtime(TRUE);
141: self::$consoleMode = PHP_SAPI === 'cli';
142: self::$productionMode = self::DETECT;
143: self::$firebugDetected = isset($_SERVER['HTTP_USER_AGENT']) && strpos($_SERVER['HTTP_USER_AGENT'], 'FirePHP/');
144: self::$ajaxDetected = isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] === 'XMLHttpRequest';
145: }
146:
147:
148:
149: /********************* useful tools ****************d*g**/
150:
151:
152:
153: /**
154: * Dumps information about a variable in readable format.
155: *
156: * @param mixed variable to dump.
157: * @param bool return output instead of printing it? (bypasses $productionMode)
158: * @return mixed variable or dump
159: */
160: public static function dump($var, $return = FALSE)
161: {
162: if (!$return && self::$productionMode) {
163: return $var;
164: }
165:
166: //self::$keyFilter = self::$productionMode ? array_change_key_case(array_flip(self::$keysToHide), CASE_LOWER) : NULL;
167:
168: $output = "<pre class=\"dump\">" . self::_dump($var, 0) . "</pre>\n";
169:
170: if (self::$consoleMode) {
171: $output = htmlspecialchars_decode(strip_tags($output), ENT_NOQUOTES);
172: }
173:
174: if ($return) {
175: return $output;
176:
177: } else {
178: echo $output;
179: return $var;
180: }
181: }
182:
183:
184:
185: /**
186: * Internal dump() implementation.
187: *
188: * @param mixed variable to dump
189: * @param int current recursion level
190: * @return string
191: */
192: private static function _dump(&$var, $level)
193: {
194: if (is_bool($var)) {
195: return "bool(" . ($var ? 'TRUE' : 'FALSE') . ")\n";
196:
197: } elseif ($var === NULL) {
198: return "NULL\n";
199:
200: } elseif (is_int($var)) {
201: return "int($var)\n";
202:
203: } elseif (is_float($var)) {
204: return "float($var)\n";
205:
206: } elseif (is_string($var)) {
207: if (self::$maxLen && strlen($var) > self::$maxLen) {
208: $s = htmlSpecialChars(substr($var, 0, self::$maxLen), ENT_NOQUOTES) . ' ... ';
209: } else {
210: $s = htmlSpecialChars($var, ENT_NOQUOTES);
211: }
212: return "string(" . strlen($var) . ") \"$s\"\n";
213:
214: } elseif (is_array($var)) {
215: $s = "array(" . count($var) . ") {\n";
216: $space = str_repeat(' ', $level);
217:
218: static $marker;
219: if ($marker === NULL) $marker = uniqid("\x00", TRUE);
220: if (isset($var[$marker])) {
221: $s .= "$space *RECURSION*\n";
222:
223: } elseif ($level < self::$maxDepth || !self::$maxDepth) {
224: $var[$marker] = 0;
225: foreach ($var as $k => &$v) {
226: if ($k === $marker) continue;
227: $s .= "$space " . (is_int($k) ? $k : "\"$k\"") . " => ";
228: if (self::$keyFilter && is_string($v) && isset(self::$keyFilter[strtolower($k)])) {
229: $s .= "string(?) *** hidden ***\n";
230: } else {
231: $s .= self::_dump($v, $level + 1);
232: }
233: }
234: unset($var[$marker]);
235: } else {
236: $s .= "$space ...\n";
237: }
238: return $s . "$space}\n";
239:
240: } elseif (is_object($var)) {
241: $arr = (array) $var;
242: $s = "object(" . get_class($var) . ") (" . count($arr) . ") {\n";
243: $space = str_repeat(' ', $level);
244:
245: static $list = array();
246: if (in_array($var, $list, TRUE)) {
247: $s .= "$space *RECURSION*\n";
248:
249: } elseif ($level < self::$maxDepth || !self::$maxDepth) {
250: $list[] = $var;
251: foreach ($arr as $k => &$v) {
252: $m = '';
253: if ($k[0] === "\x00") {
254: $m = $k[1] === '*' ? ' protected' : ' private';
255: $k = substr($k, strrpos($k, "\x00") + 1);
256: }
257: $s .= "$space \"$k\"$m => ";
258: if (self::$keyFilter && is_string($v) && isset(self::$keyFilter[strtolower($k)])) {
259: $s .= "string(?) *** hidden ***\n";
260: } else {
261: $s .= self::_dump($v, $level + 1);
262: }
263: }
264: array_pop($list);
265: } else {
266: $s .= "$space ...\n";
267: }
268: return $s . "$space}\n";
269:
270: } elseif (is_resource($var)) {
271: return "resource of type(" . get_resource_type($var) . ")\n";
272:
273: } else {
274: return "unknown type\n";
275: }
276: }
277:
278:
279:
280: /**
281: * Starts/stops stopwatch.
282: * @param string name
283: * @return elapsed seconds
284: */
285: public static function timer($name = NULL)
286: {
287: static $time = array();
288: $now = microtime(TRUE);
289: $delta = isset($time[$name]) ? $now - $time[$name] : 0;
290: $time[$name] = $now;
291: return $delta;
292: }
293:
294:
295:
296: /********************* errors and exceptions reporing ****************d*g**/
297:
298:
299:
300: /**
301: * Enables displaying or logging errors and exceptions.
302: * @param bool enable production mode? (NULL means autodetection)
303: * @param string error log file (FALSE disables logging in production mode)
304: * @param array|string administrator email or email headers; enables email sending in production mode
305: * @return void
306: */
307: public static function enable($productionMode = NULL, $logFile = NULL, $email = NULL)
308: {
309: if (version_compare(PHP_VERSION, '5.2.1') === 0) {
310: throw new NotSupportedException(__METHOD__ . ' is not supported in PHP 5.2.1'); // PHP bug #40815
311: }
312:
313: error_reporting(E_ALL | E_STRICT);
314:
315: // production/development mode detection
316: if (is_bool($productionMode)) {
317: self::$productionMode = $productionMode;
318: }
319: if (self::$productionMode === self::DETECT) {
320: if (class_exists('Environment')) {
321: self::$productionMode = Environment::isProduction();
322:
323: } elseif (isset($_SERVER['SERVER_ADDR']) || isset($_SERVER['LOCAL_ADDR'])) { // IP address based detection
324: $addr = isset($_SERVER['SERVER_ADDR']) ? $_SERVER['SERVER_ADDR'] : $_SERVER['LOCAL_ADDR'];
325: $oct = explode('.', $addr);
326: self::$productionMode = $addr !== '::1' && (count($oct) !== 4 || ($oct[0] !== '10' && $oct[0] !== '127' && ($oct[0] !== '172' || $oct[1] < 16 || $oct[1] > 31)
327: && ($oct[0] !== '169' || $oct[1] !== '254') && ($oct[0] !== '192' || $oct[1] !== '168')));
328:
329: } else {
330: self::$productionMode = !self::$consoleMode;
331: }
332: }
333:
334: // logging configuration
335: if (self::$productionMode && $logFile !== FALSE) {
336: self::$logFile = 'log/php_error.log';
337:
338: if (class_exists('Environment')) {
339: if (is_string($logFile)) {
340: self::$logFile = Environment::expand($logFile);
341:
342: } else try {
343: self::$logFile = Environment::expand('%logDir%/php_error.log');
344:
345: } catch (InvalidStateException $e) {
346: }
347:
348: } elseif (is_string($logFile)) {
349: self::$logFile = $logFile;
350: }
351:
352: ini_set('error_log', self::$logFile);
353: }
354:
355: // php configuration
356: if (function_exists('ini_set')) {
357: ini_set('display_errors', !self::$productionMode); // or 'stderr'
358: ini_set('html_errors', !self::$consoleMode);
359: ini_set('log_errors', (bool) self::$logFile);
360:
361: } elseif (ini_get('log_errors') != (bool) self::$logFile || // intentionally ==
362: (ini_get('display_errors') != !self::$productionMode && ini_get('display_errors') !== (self::$productionMode ? 'stderr' : 'stdout'))) {
363: throw new NotSupportedException('Function ini_set() must be enabled.');
364: }
365:
366: self::$sendEmails = $logFile && $email;
367: if (self::$sendEmails) {
368: if (is_string($email)) {
369: self::$emailHeaders['To'] = $email;
370:
371: } elseif (is_array($email)) {
372: self::$emailHeaders = $email + self::$emailHeaders;
373: }
374: }
375:
376: if (!defined('E_DEPRECATED')) {
377: define('E_DEPRECATED', 8192);
378: }
379:
380: if (!defined('E_USER_DEPRECATED')) {
381: define('E_USER_DEPRECATED', 16384);
382: }
383:
384: set_exception_handler(array(__CLASS__, 'exceptionHandler'));
385: set_error_handler(array(__CLASS__, 'errorHandler'));
386: register_shutdown_function(array(__CLASS__, 'shutdownHandler'));
387: self::$enabled = TRUE;
388:
389: if (is_int($productionMode)) { // back compatibility
390: //trigger_error('Debug::enable($errorLevel) is deprecated; Remove $errorLevel parameter.', E_USER_WARNING);
391: }
392: }
393:
394:
395:
396: /**
397: * Unregister error handler routine.
398: * @return void
399: */
400: public static function isEnabled()
401: {
402: return self::$enabled;
403: }
404:
405:
406:
407: /**
408: * Debug exception handler.
409: *
410: * @param Exception
411: * @return void
412: * @ignore internal
413: */
414: public static function exceptionHandler(Exception $exception)
415: {
416: if (!headers_sent()) {
417: header('HTTP/1.1 500 Internal Server Error');
418: }
419:
420: self::processException($exception, TRUE);
421: exit;
422: }
423:
424:
425:
426: /**
427: * Own error handler.
428: *
429: * @param int level of the error raised
430: * @param string error message
431: * @param string file that the error was raised in
432: * @param int line number the error was raised at
433: * @param array an array of variables that existed in the scope the error was triggered in
434: * @return bool FALSE to call normal error handler, NULL otherwise
435: * @throws FatalErrorException
436: * @ignore internal
437: */
438: public static function errorHandler($severity, $message, $file, $line, $context)
439: {
440: static $fatals = array(
441: E_USER_ERROR => 1,
442: E_RECOVERABLE_ERROR => 1, // since PHP 5.2
443: );
444:
445: if (isset($fatals[$severity])) {
446: throw new FatalErrorException($message, 0, $severity, $file, $line, $context);
447:
448: } elseif (($severity & error_reporting()) !== $severity) {
449: return NULL; // nothing to do
450: }
451:
452: static $types = array(
453: E_WARNING => 'Warning',
454: E_USER_WARNING => 'Warning',
455: E_NOTICE => 'Notice',
456: E_USER_NOTICE => 'Notice',
457: E_STRICT => 'Strict standards',
458: E_DEPRECATED => 'Deprecated',
459: E_USER_DEPRECATED => 'Deprecated',
460: );
461:
462: $type = isset($types[$severity]) ? $types[$severity] : 'Unknown error';
463:
464: if (self::$logFile) {
465: if (self::$sendEmails) {
466: self::sendEmail("$type: $message in $file on line $line");
467: }
468: return FALSE; // call normal error handler
469:
470: } elseif (!self::$productionMode && self::$firebugDetected && !headers_sent()) {
471: $message = strip_tags($message);
472: self::fireLog("$type: $message in $file on line $line", self::ERROR);
473: return NULL;
474: }
475:
476: return FALSE; // call normal error handler
477: }
478:
479:
480:
481: /**
482: * Shutdown handler to process fatal errors.
483: * @return void
484: * @ignore internal
485: */
486: public static function shutdownHandler()
487: {
488: static $types = array(
489: E_ERROR => 1,
490: E_CORE_ERROR => 1,
491: E_COMPILE_ERROR => 1,
492: E_PARSE => 1,
493: );
494:
495: $error = error_get_last();
496:
497: if (isset($types[$error['type']]) && ($error['type'] & error_reporting())) {
498: if (!headers_sent()) { // for PHP < 5.2.4
499: header('HTTP/1.1 500 Internal Server Error');
500: }
501:
502: if (ini_get('html_errors')) {
503: $error['message'] = html_entity_decode(strip_tags($error['message']));
504: }
505:
506: self::processException(new FatalErrorException($error['message'], 0, $error['type'], $error['file'], $error['line'], NULL), TRUE);
507: }
508: }
509:
510:
511:
512: /**
513: * Logs or displays exception.
514: * @param Exception
515: * @param bool is writing to standard output buffer allowed?
516: * @return void
517: */
518: public static function processException(Exception $exception, $outputAllowed = FALSE)
519: {
520: if (self::$logFile) {
521: error_log("PHP Fatal error: Uncaught $exception");
522: $file = @strftime('%d-%b-%Y %H-%M-%S ', Debug::$time) . strstr(number_format(Debug::$time, 4, '~', ''), '~');
523: $file = dirname(self::$logFile) . "/exception $file.html";
524: self::$logHandle = @fopen($file, 'x');
525: if (self::$logHandle) {
526: ob_start(array(__CLASS__, 'writeFile'), 1);
527: self::paintBlueScreen($exception);
528: ob_end_flush();
529: fclose(self::$logHandle);
530: }
531: if (self::$sendEmails) {
532: self::sendEmail((string) $exception);
533: }
534:
535: } elseif (self::$productionMode) {
536: // be quiet
537:
538: } elseif (self::$consoleMode) { // dump to console
539: if ($outputAllowed) {
540: echo "$exception\n";
541: foreach (self::$colophons as $callback) {
542: foreach ((array) call_user_func($callback, 'bluescreen') as $line) echo strip_tags($line) . "\n";
543: }
544: }
545:
546: } elseif (self::$firebugDetected && self::$ajaxDetected && !headers_sent()) { // AJAX mode
547: self::fireLog($exception, self::EXCEPTION);
548:
549: } elseif ($outputAllowed) { // dump to browser
550: self::paintBlueScreen($exception);
551:
552: } elseif (self::$firebugDetected && !headers_sent()) {
553: self::fireLog($exception, self::EXCEPTION);
554: }
555: }
556:
557:
558:
559: /**
560: * Paint blue screen.
561: * @param Exception
562: * @return void
563: * @ignore internal
564: */
565: public static function paintBlueScreen(Exception $exception)
566: {
567: $internals = array();
568: foreach (array('Object', 'ObjectMixin') as $class) {
569: if (class_exists($class, FALSE)) {
570: $rc = new ReflectionClass($class);
571: $internals[$rc->getFileName()] = TRUE;
572: }
573: }
574: $colophons = self::$colophons;
575: require dirname(__FILE__) . '/Debug.templates/bluescreen.phtml';
576: }
577:
578:
579:
580: /**
581: * Redirects output to file.
582: * @param string
583: * @return string
584: * @ignore internal
585: */
586: public static function writeFile($buffer)
587: {
588: fwrite(self::$logHandle, $buffer);
589: }
590:
591:
592:
593: /**
594: * Sends e-mail notification.
595: * @param string
596: * @return void
597: */
598: private static function sendEmail($message)
599: {
600: $monitorFile = self::$logFile . '.monitor';
601: $saved = @file_get_contents($monitorFile); // intentionally @
602: if ($saved === FALSE || is_numeric($saved)) {
603: if (@file_put_contents($monitorFile, 'e-mail has been sent')) { // intentionally @
604: call_user_func(self::$mailer, $message);
605: }
606: }
607: }
608:
609:
610:
611: /**
612: * Default mailer.
613: * @param string
614: * @return void
615: */
616: private static function defaultMailer($message)
617: {
618: $host = isset($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] :
619: (isset($_SERVER['SERVER_NAME']) ? $_SERVER['SERVER_NAME'] : '');
620:
621: $headers = str_replace(
622: array('%host%', '%date%', '%message%'),
623: array($host, @date('Y-m-d H:i:s', Debug::$time), $message), // intentionally @
624: self::$emailHeaders
625: );
626:
627: $subject = $headers['Subject'];
628: $to = $headers['To'];
629: $body = $headers['Body'];
630: unset($headers['Subject'], $headers['To'], $headers['Body']);
631: $header = '';
632: foreach ($headers as $key => $value) {
633: $header .= "$key: $value\r\n";
634: }
635:
636: // we need to change \r\n to \n because Unix mailer changes it back to \r\n
637: $body = str_replace("\r\n", "\n", $body);
638: if (PHP_OS != 'Linux') $body = str_replace("\n", "\r\n", $body);
639:
640: mail($to, $subject, $body, $header);
641: }
642:
643:
644:
645: /********************* profiler ****************d*g**/
646:
647:
648:
649: /**
650: * Enables profiler.
651: * @return void
652: */
653: public static function enableProfiler()
654: {
655: self::$enabledProfiler = TRUE;
656: register_shutdown_function(array(__CLASS__, 'paintProfiler'));
657: }
658:
659:
660:
661: /**
662: * Disables profiler.
663: * @return void
664: */
665: public static function disableProfiler()
666: {
667: self::$enabledProfiler = FALSE;
668: }
669:
670:
671:
672: /**
673: * Paint profiler window.
674: * @return void
675: * @ignore internal
676: */
677: public static function paintProfiler()
678: {
679: if (!self::$enabledProfiler || self::$productionMode) {
680: return;
681: }
682: self::$enabledProfiler = FALSE;
683:
684: if (self::$firebugDetected) {
685: self::fireLog('Nette profiler', self::GROUP_START);
686: foreach (self::$colophons as $callback) {
687: foreach ((array) call_user_func($callback, 'profiler') as $line) self::fireLog(strip_tags($line));
688: }
689: self::fireLog(NULL, self::GROUP_END);
690: }
691:
692: if (!self::$ajaxDetected) {
693: $colophons = self::$colophons;
694: require dirname(__FILE__) . '/Debug.templates/profiler.phtml';
695: }
696: }
697:
698:
699:
700: /********************* colophons ****************d*g**/
701:
702:
703:
704: /**
705: * Add custom descriptions.
706: * @param callback
707: * @return void
708: */
709: public static function addColophon($callback)
710: {
711: fixCallback($callback);
712: if (!is_callable($callback)) {
713: $able = is_callable($callback, TRUE, $textual);
714: throw new InvalidArgumentException("Colophon handler '$textual' is not " . ($able ? 'callable.' : 'valid PHP callback.'));
715: }
716:
717: if (!in_array($callback, self::$colophons, TRUE)) {
718: self::$colophons[] = $callback;
719: }
720: }
721:
722:
723:
724: /**
725: * Returns default colophons.
726: * @param string profiler | bluescreen
727: * @return array
728: */
729: public static function getDefaultColophons($sender)
730: {
731: if ($sender === 'profiler') {
732: $arr[] = 'Elapsed time: ' . sprintf('%0.3f', (microtime(TRUE) - Debug::$time) * 1000) . ' ms';
733:
734: foreach ((array) self::$counters as $name => $value) {
735: if (is_array($value)) $value = implode(', ', $value);
736: $arr[] = htmlSpecialChars($name) . ' = ' . htmlSpecialChars($value) . '';
737: }
738:
739: $autoloaded = class_exists('AutoLoader', FALSE) ? AutoLoader::$count : 0;
740: $s = '' . count(get_included_files()) . '/' . $autoloaded . ' files, ';
741:
742: $exclude = array('stdClass', 'Exception', 'ErrorException', 'Traversable', 'IteratorAggregate', 'Iterator', 'ArrayAccess', 'Serializable', 'Closure');
743: foreach (get_loaded_extensions() as $ext) {
744: $ref = new ReflectionExtension($ext);
745: $exclude = array_merge($exclude, $ref->getClassNames());
746: }
747: $classes = array_diff(get_declared_classes(), $exclude);
748: $intf = array_diff(get_declared_interfaces(), $exclude);
749: $func = get_defined_functions();
750: $func = (array) @$func['user'];
751: $consts = get_defined_constants(TRUE);
752: $consts = array_keys((array) @$consts['user']);
753: foreach (array('classes', 'intf', 'func', 'consts') as $item) {
754: $s .= '' . count($$item) . ' ' . $item . ', ';
755: }
756: $arr[] = $s;
757: }
758:
759: if ($sender === 'bluescreen') {
760: $arr[] = 'Report generated at ' . @date('Y/m/d H:i:s', Debug::$time); // intentionally @
761: if (isset($_SERVER['HTTP_HOST'], $_SERVER['REQUEST_URI'])) {
762: $url = (isset($_SERVER['HTTPS']) && strcasecmp($_SERVER['HTTPS'], 'off') ? 'https://' : 'http://') . htmlSpecialChars($_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']);
763: $arr[] = '<a href="' . $url . '">' . $url . '</a>';
764: }
765: $arr[] = 'PHP ' . htmlSpecialChars(PHP_VERSION);
766: if (isset($_SERVER['SERVER_SOFTWARE'])) $arr[] = htmlSpecialChars($_SERVER['SERVER_SOFTWARE']);
767: $arr[] = htmlSpecialChars(Framework::NAME . ' ' . Framework::VERSION) . ' (revision ' . htmlSpecialChars(Framework::REVISION) . ')';
768: }
769: return $arr;
770: }
771:
772:
773:
774: /********************* Firebug extension ****************d*g**/
775:
776:
777:
778: /**
779: * Sends variable dump to Firebug tab request/server.
780: * @param mixed variable to dump
781: * @param string unique key
782: * @return bool was successful?
783: */
784: public static function fireDump($var, $key)
785: {
786: return self::fireSend(2, array((string) $key => $var));
787: }
788:
789:
790:
791: /**
792: * Sends message to Firebug console.
793: * @param mixed message to log
794: * @param string priority of message (LOG, INFO, WARN, ERROR, GROUP_START, GROUP_END)
795: * @param string optional label
796: * @return bool was successful?
797: */
798: public static function fireLog($message, $priority = self::LOG, $label = NULL)
799: {
800: if ($message instanceof Exception) {
801: if ($priority !== self::EXCEPTION && $priority !== self::TRACE) {
802: $priority = self::TRACE;
803: }
804: $message = array(
805: 'Class' => get_class($message),
806: 'Message' => $message->getMessage(),
807: 'File' => $message->getFile(),
808: 'Line' => $message->getLine(),
809: 'Trace' => $message->getTrace(),
810: 'Type' => '',
811: 'Function' => '',
812: );
813: foreach ($message['Trace'] as & $row) {
814: if (empty($row['file'])) $row['file'] = '?';
815: if (empty($row['line'])) $row['line'] = '?';
816: }
817: } elseif ($priority === self::GROUP_START) {
818: $label = $message;
819: $message = NULL;
820: }
821: return self::fireSend(1, self::replaceObjects(array(array('Type' => $priority, 'Label' => $label), $message)));
822: }
823:
824:
825:
826: /**
827: * Performs Firebug output.
828: * @see http://www.firephp.org
829: * @param int structure index
830: * @param array payload
831: * @return bool was successful?
832: */
833: private static function fireSend($index, $payload)
834: {
835: if (self::$productionMode) return NULL;
836:
837: if (headers_sent()) return FALSE; // or throw exception?
838:
839: header('X-Wf-Protocol-nette: http://meta.wildfirehq.org/Protocol/JsonStream/0.2');
840: header('X-Wf-nette-Plugin-1: http://meta.firephp.org/Wildfire/Plugin/FirePHP/Library-FirePHPCore/0.2.0');
841:
842: if ($index === 1) {
843: header('X-Wf-nette-Structure-1: http://meta.firephp.org/Wildfire/Structure/FirePHP/FirebugConsole/0.1');
844:
845: } elseif ($index === 2) {
846: header('X-Wf-nette-Structure-2: http://meta.firephp.org/Wildfire/Structure/FirePHP/Dump/0.1');
847: }
848:
849: $payload = json_encode($payload);
850: static $counter;
851: foreach (str_split($payload, 4990) as $s) {
852: $num = ++$counter;
853: header("X-Wf-nette-$index-1-n$num: |$s|\\");
854: }
855: header("X-Wf-nette-$index-1-n$num: |$s|");
856:
857: return TRUE;
858: }
859:
860:
861:
862: /**
863: * fireLog helper.
864: * @param mixed
865: * @return mixed
866: */
867: static private function replaceObjects($val)
868: {
869: if (is_object($val)) {
870: return 'object ' . get_class($val) . '';
871:
872: } elseif (is_string($val)) {
873: return $val = @iconv('UTF-16', 'UTF-8//IGNORE', iconv('UTF-8', 'UTF-16//IGNORE', $val)); // intentionally @
874:
875: } elseif (is_array($val)) {
876: foreach ($val as $k => $v) {
877: unset($val[$k]);
878: $k = @iconv('UTF-16', 'UTF-8//IGNORE', iconv('UTF-8', 'UTF-16//IGNORE', $k)); // intentionally @
879: $val[$k] = self::replaceObjects($v);
880: }
881: }
882:
883: return $val;
884: }
885:
886: }
887:
888:
889:
890: Debug::init();
891:
892: // hint:
893: // if (!function_exists('dump')) { function dump($var, $return = FALSE) { return Debug::dump($var, $return); } }

Source for file Debug.php

Namespaces