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