1: <?php
2:
3: 4: 5: 6: 7: 8: 9: 10:
11:
12: namespace Nette\Diagnostics;
13:
14: use Nette;
15:
16:
17:
18: 19: 20: 21: 22: 23: 24: 25: 26:
27: final class Debugger
28: {
29:
30: public static $productionMode;
31:
32:
33: public static $consoleMode;
34:
35:
36: public static $time;
37:
38:
39: private static $ajaxDetected;
40:
41:
42: public static $source;
43:
44:
45: public static $editor = 'editor://open/?file=%file&line=%line';
46:
47:
48: public static $browser;
49:
50:
51:
52:
53: public static $maxDepth = 3;
54:
55:
56: public static $maxLen = 150;
57:
58:
59: public static $showLocation = FALSE;
60:
61:
62: public static $consoleColors = array(
63: 'bool' => '1;33',
64: 'null' => '1;33',
65: 'int' => '1;36',
66: 'float' => '1;36',
67: 'string' => '1;32',
68: 'array' => '1;31',
69: 'key' => '1;37',
70: 'object' => '1;31',
71: 'visibility' => '1;30',
72: 'resource' => '1;37',
73: );
74:
75:
76:
77:
78: const DEVELOPMENT = FALSE,
79: PRODUCTION = TRUE,
80: DETECT = NULL;
81:
82:
83: public static $blueScreen;
84:
85:
86: public static $strictMode = FALSE;
87:
88:
89: public static $scream = FALSE;
90:
91:
92: public static $onFatalError = array();
93:
94:
95: private static $enabled = FALSE;
96:
97:
98: private static $lastError = FALSE;
99:
100:
101:
102:
103: public static $logger;
104:
105:
106: public static $fireLogger;
107:
108:
109: public static $logDirectory;
110:
111:
112: public static $email;
113:
114:
115: public static $mailer;
116:
117:
118: public static $emailSnooze;
119:
120:
121:
122:
123: public static $bar;
124:
125:
126: private static $errorPanel;
127:
128:
129: private static $dumpPanel;
130:
131:
132:
133:
134: const DEBUG = 'debug',
135: INFO = 'info',
136: WARNING = 'warning',
137: ERROR = 'error',
138: CRITICAL = 'critical';
139:
140:
141:
142: 143: 144:
145: final public function __construct()
146: {
147: throw new Nette\StaticClassException;
148: }
149:
150:
151:
152: 153: 154: 155:
156: public static function _init()
157: {
158: self::$time = microtime(TRUE);
159: self::$consoleMode = PHP_SAPI === 'cli';
160: self::$productionMode = self::DETECT;
161: if (self::$consoleMode) {
162: self::$source = empty($_SERVER['argv']) ? 'cli' : 'cli: ' . implode(' ', $_SERVER['argv']);
163: } else {
164: self::$ajaxDetected = isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] === 'XMLHttpRequest';
165: if (isset($_SERVER['REQUEST_URI'])) {
166: self::$source = (isset($_SERVER['HTTPS']) && strcasecmp($_SERVER['HTTPS'], 'off') ? 'https://' : 'http://')
167: . (isset($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : (isset($_SERVER['SERVER_NAME']) ? $_SERVER['SERVER_NAME'] : ''))
168: . $_SERVER['REQUEST_URI'];
169: }
170: }
171:
172: self::$logger = new Logger;
173: self::$logDirectory = & self::$logger->directory;
174: self::$email = & self::$logger->email;
175: self::$mailer = & self::$logger->mailer;
176: self::$emailSnooze = & Logger::$emailSnooze;
177:
178: self::$fireLogger = new FireLogger;
179:
180: self::$blueScreen = new BlueScreen;
181: self::$blueScreen->addPanel(function($e) {
182: if ($e instanceof Nette\Templating\FilterException) {
183: return array(
184: 'tab' => 'Template',
185: 'panel' => '<p><b>File:</b> ' . Helpers::editorLink($e->sourceFile, $e->sourceLine)
186: . ' <b>Line:</b> ' . ($e->sourceLine ? $e->sourceLine : 'n/a') . '</p>'
187: . ($e->sourceLine ? BlueScreen::highlightFile($e->sourceFile, $e->sourceLine) : '')
188: );
189: } elseif ($e instanceof Nette\Utils\NeonException && preg_match('#line (\d+)#', $e->getMessage(), $m)) {
190: if ($item = Helpers::findTrace($e->getTrace(), 'Nette\Config\Adapters\NeonAdapter::load')) {
191: return array(
192: 'tab' => 'NEON',
193: 'panel' => '<p><b>File:</b> ' . Helpers::editorLink($item['args'][0], $m[1]) . ' <b>Line:</b> ' . $m[1] . '</p>'
194: . BlueScreen::highlightFile($item['args'][0], $m[1])
195: );
196: } elseif ($item = Helpers::findTrace($e->getTrace(), 'Nette\Utils\Neon::decode')) {
197: return array(
198: 'tab' => 'NEON',
199: 'panel' => BlueScreen::highlightPhp($item['args'][0], $m[1])
200: );
201: }
202: }
203: });
204:
205: self::$bar = new Bar;
206: self::$bar->addPanel(new DefaultBarPanel('time'));
207: self::$bar->addPanel(new DefaultBarPanel('memory'));
208: self::$bar->addPanel(self::$errorPanel = new DefaultBarPanel('errors'));
209: self::$bar->addPanel(self::$dumpPanel = new DefaultBarPanel('dumps'));
210: }
211:
212:
213:
214:
215:
216:
217:
218: 219: 220: 221: 222: 223: 224:
225: public static function enable($mode = NULL, $logDirectory = NULL, $email = NULL)
226: {
227: error_reporting(E_ALL | E_STRICT);
228:
229:
230: if (is_bool($mode)) {
231: self::$productionMode = $mode;
232:
233: } elseif ($mode !== self::DETECT || self::$productionMode === NULL) {
234: $mode = is_string($mode) ? preg_split('#[,\s]+#', $mode) : (array) $mode;
235: $mode[] = '127.0.0.1';
236: $mode[] = '::1';
237: self::$productionMode = !in_array(isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : php_uname('n'), $mode, TRUE);
238: }
239:
240:
241: if (is_string($logDirectory)) {
242: self::$logDirectory = realpath($logDirectory);
243: if (self::$logDirectory === FALSE) {
244: throw new Nette\DirectoryNotFoundException("Directory '$logDirectory' is not found.");
245: }
246: } elseif ($logDirectory === FALSE) {
247: self::$logDirectory = FALSE;
248:
249: } elseif (self::$logDirectory === NULL) {
250: self::$logDirectory = defined('APP_DIR') ? APP_DIR . '/../log' : getcwd() . '/log';
251: }
252: if (self::$logDirectory) {
253: ini_set('error_log', self::$logDirectory . '/php_error.log');
254: }
255:
256:
257: if (function_exists('ini_set')) {
258: ini_set('display_errors', !self::$productionMode);
259: ini_set('html_errors', FALSE);
260: ini_set('log_errors', FALSE);
261:
262: } elseif (ini_get('display_errors') != !self::$productionMode && ini_get('display_errors') !== (self::$productionMode ? 'stderr' : 'stdout')) {
263: throw new Nette\NotSupportedException('Function ini_set() must be enabled.');
264: }
265:
266: if ($email) {
267: if (!is_string($email)) {
268: throw new Nette\InvalidArgumentException('Email address must be a string.');
269: }
270: self::$email = $email;
271: }
272:
273: if (!defined('E_DEPRECATED')) {
274: define('E_DEPRECATED', 8192);
275: }
276:
277: if (!defined('E_USER_DEPRECATED')) {
278: define('E_USER_DEPRECATED', 16384);
279: }
280:
281: if (!self::$enabled) {
282: register_shutdown_function(array(__CLASS__, '_shutdownHandler'));
283: set_exception_handler(array(__CLASS__, '_exceptionHandler'));
284: set_error_handler(array(__CLASS__, '_errorHandler'));
285: self::$enabled = TRUE;
286: }
287: }
288:
289:
290:
291: 292: 293: 294:
295: public static function isEnabled()
296: {
297: return self::$enabled;
298: }
299:
300:
301:
302: 303: 304: 305: 306: 307:
308: public static function log($message, $priority = self::INFO)
309: {
310: if (self::$logDirectory === FALSE) {
311: return;
312:
313: } elseif (!self::$logDirectory) {
314: throw new Nette\InvalidStateException('Logging directory is not specified in Nette\Diagnostics\Debugger::$logDirectory.');
315: }
316:
317: if ($message instanceof \Exception) {
318: $exception = $message;
319: $message = ($message instanceof Nette\FatalErrorException
320: ? 'Fatal error: ' . $exception->getMessage()
321: : get_class($exception) . ": " . $exception->getMessage())
322: . " in " . $exception->getFile() . ":" . $exception->getLine();
323:
324: $hash = md5($exception );
325: $exceptionFilename = "exception-" . @date('Y-m-d-H-i-s') . "-$hash.html";
326: foreach (new \DirectoryIterator(self::$logDirectory) as $entry) {
327: if (strpos($entry, $hash)) {
328: $exceptionFilename = $entry;
329: $saved = TRUE;
330: break;
331: }
332: }
333: }
334:
335: self::$logger->log(array(
336: @date('[Y-m-d H-i-s]'),
337: trim($message),
338: self::$source ? ' @ ' . self::$source : NULL,
339: !empty($exceptionFilename) ? ' @@ ' . $exceptionFilename : NULL
340: ), $priority);
341:
342: if (!empty($exceptionFilename)) {
343: $exceptionFilename = self::$logDirectory . '/' . $exceptionFilename;
344: if (empty($saved) && $logHandle = @fopen($exceptionFilename, 'w')) {
345: ob_start();
346: ob_start(function($buffer) use ($logHandle) { fwrite($logHandle, $buffer); }, 4096);
347: self::$blueScreen->render($exception);
348: ob_end_flush();
349: ob_end_clean();
350: fclose($logHandle);
351: }
352: return strtr($exceptionFilename, '\\/', DIRECTORY_SEPARATOR . DIRECTORY_SEPARATOR);
353: }
354: }
355:
356:
357:
358: 359: 360: 361: 362:
363: public static function _shutdownHandler()
364: {
365: if (!self::$enabled) {
366: return;
367: }
368:
369:
370: static $types = array(
371: E_ERROR => 1,
372: E_CORE_ERROR => 1,
373: E_COMPILE_ERROR => 1,
374: E_PARSE => 1,
375: );
376: $error = error_get_last();
377: if (isset($types[$error['type']])) {
378: self::_exceptionHandler(new Nette\FatalErrorException($error['message'], 0, $error['type'], $error['file'], $error['line'], NULL));
379: }
380:
381:
382: if (self::$bar && !self::$productionMode && self::isHtmlMode()) {
383: self::$bar->render();
384: }
385: }
386:
387:
388:
389: 390: 391: 392: 393: 394:
395: public static function _exceptionHandler(\Exception $exception)
396: {
397: if (!headers_sent()) {
398: $protocol = isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.1';
399: header($protocol . ' 500', TRUE, 500);
400: }
401:
402: try {
403: if (self::$productionMode) {
404: try {
405: self::log($exception, self::ERROR);
406: } catch (\Exception $e) {
407: echo 'FATAL ERROR: unable to log error';
408: }
409:
410: if (self::$consoleMode) {
411: echo "ERROR: the server encountered an internal error and was unable to complete your request.\n";
412:
413: } elseif (self::isHtmlMode()) {
414: require __DIR__ . '/templates/error.phtml';
415: }
416:
417: } else {
418: if (self::$consoleMode) {
419: echo "$exception\n";
420: if ($file = self::log($exception)) {
421: echo "(stored in $file)\n";
422: if (self::$browser) {
423: exec(self::$browser . ' ' . escapeshellarg($file));
424: }
425: }
426:
427: } elseif (self::isHtmlMode()) {
428: self::$blueScreen->render($exception);
429: if (self::$bar) {
430: self::$bar->render();
431: }
432:
433: } elseif (!self::fireLog($exception, self::ERROR)) {
434: $file = self::log($exception);
435: if (!headers_sent()) {
436: header("X-Nette-Error-Log: $file");
437: }
438: }
439: }
440:
441: foreach (self::$onFatalError as $handler) {
442: call_user_func($handler, $exception);
443: }
444:
445: } catch (\Exception $e) {
446: if (self::$productionMode) {
447: echo self::isHtmlMode() ? '<meta name=robots content=noindex>FATAL ERROR' : 'FATAL ERROR';
448: } else {
449: echo "FATAL ERROR: thrown ", get_class($e), ': ', $e->getMessage(),
450: "\nwhile processing ", get_class($exception), ': ', $exception->getMessage(), "\n";
451: }
452: }
453:
454: self::$enabled = FALSE;
455: exit(255);
456: }
457:
458:
459:
460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470:
471: public static function _errorHandler($severity, $message, $file, $line, $context)
472: {
473: if (self::$scream) {
474: error_reporting(E_ALL | E_STRICT);
475: }
476:
477: if (self::$lastError !== FALSE && ($severity & error_reporting()) === $severity) {
478: self::$lastError = new \ErrorException($message, 0, $severity, $file, $line);
479: return NULL;
480: }
481:
482: if ($severity === E_RECOVERABLE_ERROR || $severity === E_USER_ERROR) {
483: throw new Nette\FatalErrorException($message, 0, $severity, $file, $line, $context);
484:
485: } elseif (($severity & error_reporting()) !== $severity) {
486: return FALSE;
487:
488: } elseif (!self::$productionMode && (is_bool(self::$strictMode) ? self::$strictMode : ((self::$strictMode & $severity) === $severity))) {
489: self::_exceptionHandler(new Nette\FatalErrorException($message, 0, $severity, $file, $line, $context));
490: }
491:
492: static $types = array(
493: E_WARNING => 'Warning',
494: E_COMPILE_WARNING => 'Warning',
495: E_USER_WARNING => 'Warning',
496: E_NOTICE => 'Notice',
497: E_USER_NOTICE => 'Notice',
498: E_STRICT => 'Strict standards',
499: E_DEPRECATED => 'Deprecated',
500: E_USER_DEPRECATED => 'Deprecated',
501: );
502:
503: $message = 'PHP ' . (isset($types[$severity]) ? $types[$severity] : 'Unknown error') . ": $message";
504: $count = & self::$errorPanel->data["$message|$file|$line"];
505:
506: if ($count++) {
507: return NULL;
508:
509: } elseif (self::$productionMode) {
510: self::log("$message in $file:$line", self::ERROR);
511: return NULL;
512:
513: } else {
514: $ok = self::fireLog(new \ErrorException($message, 0, $severity, $file, $line), self::WARNING);
515: return !self::isHtmlMode() || (!self::$bar && !$ok) ? FALSE : NULL;
516: }
517:
518: return FALSE;
519: }
520:
521:
522:
523: 524: 525: 526: 527:
528: public static function toStringException(\Exception $exception)
529: {
530: if (self::$enabled) {
531: self::_exceptionHandler($exception);
532: } else {
533: trigger_error($exception->getMessage(), E_USER_ERROR);
534: }
535: }
536:
537:
538:
539: 540: 541: 542:
543: public static function tryError()
544: {
545: if (!self::$enabled && self::$lastError === FALSE) {
546: set_error_handler(array(__CLASS__, '_errorHandler'));
547: }
548: self::$lastError = NULL;
549: }
550:
551:
552:
553: 554: 555: 556: 557:
558: public static function catchError(& $error)
559: {
560: if (!self::$enabled && self::$lastError !== FALSE) {
561: restore_error_handler();
562: }
563: $error = self::$lastError;
564: self::$lastError = FALSE;
565: return (bool) $error;
566: }
567:
568:
569:
570:
571:
572:
573:
574: 575: 576: 577: 578: 579:
580: public static function dump($var, $return = FALSE)
581: {
582: if (!$return && self::$productionMode) {
583: return $var;
584: }
585:
586: $output = "<pre class=\"nette-dump\">" . Helpers::htmlDump($var) . "</pre>\n";
587:
588: if (!$return) {
589: $trace = debug_backtrace(FALSE);
590: $i = Helpers::findTrace($trace, 'dump') ? 1 : 0;
591: if (isset($trace[$i]['file'], $trace[$i]['line']) && is_file($trace[$i]['file'])) {
592: $lines = file($trace[$i]['file']);
593: preg_match('#dump\((.*)\)#', $lines[$trace[$i]['line'] - 1], $m);
594: $output = substr_replace(
595: $output,
596: ' title="' . htmlspecialchars((isset($m[0]) ? "$m[0] \n" : '') . "in file {$trace[$i]['file']} on line {$trace[$i]['line']}") . '"',
597: 4, 0);
598:
599: if (self::$showLocation) {
600: $output = substr_replace(
601: $output,
602: ' <small>in ' . Helpers::editorLink($trace[$i]['file'], $trace[$i]['line']) . ":{$trace[$i]['line']}</small>",
603: -8, 0);
604: }
605: }
606: }
607:
608: if (self::$consoleMode) {
609: if (self::$consoleColors && substr(PHP_OS, 0, 3) !== 'WIN') {
610: $output = preg_replace_callback('#<span class="php-(\w+)">|</span>#', function($m) {
611: return "\033[" . (isset($m[1], Debugger::$consoleColors[$m[1]]) ? Debugger::$consoleColors[$m[1]] : '0') . "m";
612: }, $output);
613: }
614: $output = htmlspecialchars_decode(strip_tags($output), ENT_QUOTES);
615: }
616:
617: if ($return) {
618: return $output;
619:
620: } else {
621: echo $output;
622: return $var;
623: }
624: }
625:
626:
627:
628: 629: 630: 631: 632:
633: public static function timer($name = NULL)
634: {
635: static $time = array();
636: $now = microtime(TRUE);
637: $delta = isset($time[$name]) ? $now - $time[$name] : 0;
638: $time[$name] = $now;
639: return $delta;
640: }
641:
642:
643:
644: 645: 646: 647: 648: 649:
650: public static function barDump($var, $title = NULL)
651: {
652: if (!self::$productionMode) {
653: $dump = array();
654: foreach ((is_array($var) ? $var : array('' => $var)) as $key => $val) {
655: $dump[$key] = Helpers::clickableDump($val);
656: }
657: self::$dumpPanel->data[] = array('title' => $title, 'dump' => $dump);
658: }
659: return $var;
660: }
661:
662:
663:
664: 665: 666: 667: 668:
669: public static function fireLog($message)
670: {
671: if (!self::$productionMode) {
672: return self::$fireLogger->log($message);
673: }
674: }
675:
676:
677:
678: private static function isHtmlMode()
679: {
680: return !self::$ajaxDetected && !self::$consoleMode
681: && !preg_match('#^Content-Type: (?!text/html)#im', implode("\n", headers_list()));
682: }
683:
684:
685:
686:
687: public static function addPanel(IBarPanel $panel, $id = NULL)
688: {
689: return self::$bar->addPanel($panel, $id);
690: }
691:
692: }
693: