Skip to content
This repository
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 569 lines (541 sloc) 16.168 kb
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
<?php
/* SVN FILE: $Id$ */
/**
* Framework debugging and PHP error-handling class
*
* Provides enhanced logging, stack traces, and rendering debug views
*
* PHP versions 4 and 5
*
* CakePHP(tm) : Rapid Development Framework (http://www.cakephp.org)
* Copyright 2005-2008, Cake Software Foundation, Inc. (http://www.cakefoundation.org)
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright 2005-2008, Cake Software Foundation, Inc. (http://www.cakefoundation.org)
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP(tm) Project
* @package cake
* @subpackage cake.cake.libs
* @since CakePHP(tm) v 1.2.4560
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
/**
* Included libraries.
*
*/
if (!class_exists('Object')) {
uses('object');
}
if (!class_exists('CakeLog')) {
uses('cake_log');
}
/**
* Provide custom logging and error handling.
*
* Debugger overrides PHP's default error handling to provide stack traces and enhanced logging
*
* @package cake
* @subpackage cake.cake.libs
* @link http://book.cakephp.org/view/460/Using-the-Debugger-Class
*/
class Debugger extends Object {
/**
* A list of errors generated by the application.
*
* @var array
* @access public
*/
var $errors = array();
/**
* Contains the base URL for error code documentation.
*
* @var string
* @access public
*/
var $helpPath = null;
/**
* The current output format.
*
* @var string
* @access protected
*/
var $_outputFormat = 'js';
/**
* Holds current output data when outputFormat is false.
*
* @var string
* @access private
*/
var $__data = array();
/**
* Constructor.
*
*/
function __construct() {
$docRef = ini_get('docref_root');
if (empty($docRef)) {
ini_set('docref_root', 'http://php.net/');
}
if (!defined('E_RECOVERABLE_ERROR')) {
define('E_RECOVERABLE_ERROR', 4096);
}
}
/**
* Returns a reference to the Debugger singleton object instance.
*
* @return object
* @access public
* @static
*/
function &getInstance($class = null) {
static $instance = array();
if (!empty($class)) {
if (!$instance || strtolower($class) != strtolower(get_class($instance[0]))) {
$instance[0] = & new $class();
if (Configure::read() > 0) {
Configure::version(); // Make sure the core config is loaded
$instance[0]->helpPath = Configure::read('Cake.Debugger.HelpPath');
}
}
}

if (!$instance) {
$instance[0] =& new Debugger();
if (Configure::read() > 0) {
Configure::version(); // Make sure the core config is loaded
$instance[0]->helpPath = Configure::read('Cake.Debugger.HelpPath');
}
}
return $instance[0];
}
/**
* Formats and outputs the contents of the supplied variable.
*
* @param $var mixed the variable to dump
* @return void
* @see exportVar
* @access public
* @static
* @link http://book.cakephp.org/view/460/Using-the-Debugger-Class
*/
function dump($var) {
$_this = Debugger::getInstance();
pr($_this->exportVar($var));
}
/**
* Creates a detailed stack trace log at the time of invocation, much like dump()
* but to debug.log.
*
* @param $var mixed Variable or content to log
* @param $level int type of log to use. Defaults to LOG_DEBUG
* @return void
* @static
* @link http://book.cakephp.org/view/460/Using-the-Debugger-Class
*/
function log($var, $level = LOG_DEBUG) {
$_this = Debugger::getInstance();
$source = $_this->trace(array('start' => 1)) . "\n";
CakeLog::write($level, "\n" . $source . $_this->exportVar($var));
}

/**
* Overrides PHP's default error handling.
*
* @param integer $code Code of error
* @param string $description Error description
* @param string $file File on which error occurred
* @param integer $line Line that triggered the error
* @param array $context Context
* @return boolean true if error was handled
* @access public
*/
function handleError($code, $description, $file = null, $line = null, $context = null) {
if (error_reporting() == 0 || $code === 2048 || $code === 8192) {
return;
}

$_this = Debugger::getInstance();

if (empty($file)) {
$file = '[internal]';
}
if (empty($line)) {
$line = '??';
}
$file = $_this->trimPath($file);

$info = compact('code', 'description', 'file', 'line');
if (!in_array($info, $_this->errors)) {
$_this->errors[] = $info;
} else {
return;
}

$level = LOG_DEBUG;
switch ($code) {
case E_PARSE:
case E_ERROR:
case E_CORE_ERROR:
case E_COMPILE_ERROR:
case E_USER_ERROR:
$error = 'Fatal Error';
$level = LOG_ERROR;
break;
case E_WARNING:
case E_USER_WARNING:
case E_COMPILE_WARNING:
case E_RECOVERABLE_ERROR:
$error = 'Warning';
$level = LOG_WARNING;
break;
case E_NOTICE:
case E_USER_NOTICE:
$error = 'Notice';
$level = LOG_NOTICE;
break;
default:
return false;
break;
}

$helpCode = null;
if (!empty($_this->helpPath) && preg_match('/.*\[([0-9]+)\]$/', $description, $codes)) {
if (isset($codes[1])) {
$helpCode = $codes[1];
$description = trim(preg_replace('/\[[0-9]+\]$/', '', $description));
}
}

echo $_this->_output($level, $error, $code, $helpCode, $description, $file, $line, $context);

if (Configure::read('log')) {
CakeLog::write($level, "{$error} ({$code}): {$description} in [{$file}, line {$line}]");
}

if ($error == 'Fatal Error') {
die();
}
return true;
}
/**
* Outputs a stack trace based on the supplied options.
*
* @param array $options Format for outputting stack trace
* @return string Formatted stack trace
* @access public
* @static
* @link http://book.cakephp.org/view/460/Using-the-Debugger-Class
*/
function trace($options = array()) {
$options = array_merge(array(
'depth' => 999,
'format' => '',
'args' => false,
'start' => 0,
'scope' => null,
'exclude' => null
),
$options
);

$backtrace = debug_backtrace();
$back = array();
$count = count($backtrace);

for ($i = $options['start']; $i < $count && $i < $options['depth']; $i++) {
$trace = array_merge(
array(
'file' => '[internal]',
'line' => '??'
),
$backtrace[$i]
);

if (isset($backtrace[$i + 1])) {
$next = array_merge(
array(
'line' => '??',
'file' => '[internal]',
'class' => null,
'function' => '[main]'
),
$backtrace[$i + 1]
);
$function = $next['function'];

if (!empty($next['class'])) {
$function = $next['class'] . '::' . $function . '(';
if ($options['args'] && isset($next['args'])) {
$args = array();
foreach ($next['args'] as $arg) {
$args[] = Debugger::exportVar($arg);
}
$function .= join(', ', $args);
}
$function .= ')';
}
} else {
$function = '[main]';
}
if (in_array($function, array('call_user_func_array', 'trigger_error'))) {
continue;
}
if ($options['format'] == 'points' && $trace['file'] != '[internal]') {
$back[] = array('file' => $trace['file'], 'line' => $trace['line']);
} elseif (empty($options['format'])) {
$back[] = $function . ' - ' . Debugger::trimPath($trace['file']) . ', line ' . $trace['line'];
} else {
$back[] = $trace;
}
}

if ($options['format'] == 'array' || $options['format'] == 'points') {
return $back;
}
return join("\n", $back);
}
/**
* Shortens file paths by replacing the application base path with 'APP', and the CakePHP core
* path with 'CORE'.
*
* @param string $path Path to shorten
* @return string Normalized path
* @access public
* @static
*/
function trimPath($path) {
if (!defined('CAKE_CORE_INCLUDE_PATH') || !defined('APP')) {
return $path;
}

if (strpos($path, APP) === 0) {
return str_replace(APP, 'APP' . DS, $path);
} elseif (strpos($path, CAKE_CORE_INCLUDE_PATH) === 0) {
return str_replace(CAKE_CORE_INCLUDE_PATH, 'CORE', $path);
} elseif (strpos($path, ROOT) === 0) {
return str_replace(ROOT, 'ROOT', $path);
}
$corePaths = Configure::corePaths('cake');
foreach ($corePaths as $corePath) {
if (strpos($path, $corePath) === 0) {
return str_replace($corePath, 'CORE' .DS . 'cake' .DS, $path);
}
}
return $path;
}
/**
* Grabs an excerpt from a file and highlights a given line of code
*
* @param string $file Absolute path to a PHP file
* @param integer $line Line number to highlight
* @param integer $context Number of lines of context to extract above and below $line
* @return array Set of lines highlighted
* @access public
* @static
* @link http://book.cakephp.org/view/460/Using-the-Debugger-Class
*/
function excerpt($file, $line, $context = 2) {
$data = $lines = array();
if (!file_exists($file)) {
return array();
}
$data = @explode("\n", file_get_contents($file));

if (empty($data) || !isset($data[$line])) {
return;
}
for ($i = $line - ($context + 1); $i < $line + $context; $i++) {
if (!isset($data[$i])) {
continue;
}
$string = str_replace(array("\r\n", "\n"), "", highlight_string($data[$i], true));
if ($i == $line) {
$lines[] = '<span class="code-highlight">' . $string . '</span>';
} else {
$lines[] = $string;
}
}
return $lines;
}
/**
* Converts a variable to a string for debug output.
*
* @param string $var Variable to convert
* @return string Variable as a formatted string
* @access public
* @static
* @link http://book.cakephp.org/view/460/Using-the-Debugger-Class
*/
function exportVar($var, $recursion = 0) {
$_this = Debugger::getInstance();
switch (strtolower(gettype($var))) {
case 'boolean':
return ($var) ? 'true' : 'false';
break;
case 'integer':
case 'double':
return $var;
break;
case 'string':
if (trim($var) == "") {
return '""';
}
return '"' . h($var) . '"';
break;
case 'object':
return get_class($var) . "\n" . $_this->__object($var);
case 'array':
$out = "array(";
$vars = array();
foreach ($var as $key => $val) {
if ($recursion >= 0) {
if (is_numeric($key)) {
$vars[] = "\n\t" . $_this->exportVar($val, $recursion - 1);
} else {
$vars[] = "\n\t" .$_this->exportVar($key, $recursion - 1)
. ' => ' . $_this->exportVar($val, $recursion - 1);
}
}
}
$n = null;
if (count($vars) > 0) {
$n = "\n";
}
return $out . join(",", $vars) . "{$n})";
break;
case 'resource':
return strtolower(gettype($var));
break;
case 'null':
return 'null';
break;
}
}
/**
* Handles object to string conversion.
*
* @param string $var Object to convert
* @return string
* @access private
* @see Debugger:exportVar()
*/
function __object($var) {
$out = array();

if (is_object($var)) {
$className = get_class($var);
$objectVars = get_object_vars($var);

foreach ($objectVars as $key => $value) {
if (is_object($value)) {
$value = get_class($value) . ' object';
} elseif (is_array($value)) {
$value = 'array';
} elseif ($value === null) {
$value = 'NULL';
} elseif (in_array(gettype($value), array('boolean', 'integer', 'double', 'string', 'array', 'resource'))) {
$value = Debugger::exportVar($value);
}
$out[] = "$className::$$key = " . $value;
}
}
return join("\n", $out);
}
/**
* Handles object conversion to debug string.
*
* @param string $var Object to convert
* @access protected
*/
function output($format = 'js') {
$_this = Debugger::getInstance();
$data = null;

if ($format === true && !empty($_this->__data)) {
$data = $_this->__data;
$_this->__data = array();
$format = false;
}
$_this->_outputFormat = $format;

return $data;
}
/**
* Handles object conversion to debug string.
*
* @param string $var Object to convert
* @access private
*/
function _output($level, $error, $code, $helpCode, $description, $file, $line, $kontext) {
$files = $this->trace(array('start' => 2, 'format' => 'points'));
$listing = $this->excerpt($files[0]['file'], $files[0]['line'] - 1, 1);
$trace = $this->trace(array('start' => 2, 'depth' => '20'));
$context = array();

foreach ((array)$kontext as $var => $value) {
$context[] = "\${$var}\t=\t" . $this->exportVar($value, 1);
}

switch ($this->_outputFormat) {
default:
case 'js':
$link = "document.getElementById(\"CakeStackTrace" . count($this->errors) . "\").style.display = (document.getElementById(\"CakeStackTrace" . count($this->errors) . "\").style.display == \"none\" ? \"\" : \"none\")";
$out = "<a href='javascript:void(0);' onclick='{$link}'><b>{$error}</b> ({$code})</a>: {$description} [<b>{$file}</b>, line <b>{$line}</b>]";
if (Configure::read() > 0) {
debug($out, false, false);
echo '<div id="CakeStackTrace' . count($this->errors) . '" class="cake-stack-trace" style="display: none;">';
$link = "document.getElementById(\"CakeErrorCode" . count($this->errors) . "\").style.display = (document.getElementById(\"CakeErrorCode" . count($this->errors) . "\").style.display == \"none\" ? \"\" : \"none\")";
echo "<a href='javascript:void(0);' onclick='{$link}'>Code</a>";

if (!empty($context)) {
$link = "document.getElementById(\"CakeErrorContext" . count($this->errors) . "\").style.display = (document.getElementById(\"CakeErrorContext" . count($this->errors) . "\").style.display == \"none\" ? \"\" : \"none\")";
echo " | <a href='javascript:void(0);' onclick='{$link}'>Context</a>";

if (!empty($helpCode)) {
echo " | <a href='{$this->helpPath}{$helpCode}' target='_blank'>Help</a>";
}

echo "<pre id=\"CakeErrorContext" . count($this->errors) . "\" class=\"cake-context\" style=\"display: none;\">";
echo implode("\n", $context);
echo "</pre>";
}

if (!empty($listing)) {
echo "<div id=\"CakeErrorCode" . count($this->errors) . "\" class=\"cake-code-dump\" style=\"display: none;\">";
pr(implode("\n", $listing) . "\n", false);
echo '</div>';
}
pr($trace, false);
echo '</div>';
}
break;
case 'html':
echo "<pre class=\"cake-debug\"><b>{$error}</b> ({$code}) : {$description} [<b>{$file}</b>, line <b>{$line}]</b></pre>";
if (!empty($context)) {
echo "Context:\n" .implode("\n", $context) . "\n";
}
echo "<pre class=\"cake-debug context\"><b>Context</b> <p>" . implode("\n", $context) . "</p></pre>";
echo "<pre class=\"cake-debug trace\"><b>Trace</b> <p>" . $trace. "</p></pre>";
break;
case 'text':
case 'txt':
echo "{$error}: {$code} :: {$description} on line {$line} of {$file}\n";
if (!empty($context)) {
echo "Context:\n" .implode("\n", $context) . "\n";
}
echo "Trace:\n" . $trace;
break;
case 'log':
$this->log(compact('error', 'code', 'description', 'line', 'file', 'context', 'trace'));
break;
case false:
$this->__data[] = compact('error', 'code', 'description', 'line', 'file', 'context', 'trace');
break;
}
}
/**
* Verifies that the application's salt value has been changed from the default value.
*
* @access public
* @static
*/
function checkSessionKey() {
if (Configure::read('Security.salt') == 'DYhG93b0qyJfIxfs2guVoUubWwvniR2G0FgaC9mi') {
trigger_error(__('Please change the value of \'Security.salt\' in app/config/core.php to a salt value specific to your application', true), E_USER_NOTICE);
}
}
/**
* Invokes the given debugger object as the current error handler, taking over control from the previous handler
* in a stack-like hierarchy.
*
* @param object $debugger A reference to the Debugger object
* @access public
* @static
* @link http://book.cakephp.org/view/460/Using-the-Debugger-Class
*/
function invoke(&$debugger) {
set_error_handler(array(&$debugger, 'handleError'));
}
}

if (!defined('DISABLE_DEFAULT_ERROR_HANDLING')) {
Debugger::invoke(Debugger::getInstance());
}
?>
Something went wrong with that request. Please try again.