1: <?php
  2: /**
  3:  * Framework debugging and PHP error-handling class
  4:  *
  5:  * Provides enhanced logging, stack traces, and rendering debug views
  6:  *
  7:  * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
  8:  * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
  9:  *
 10:  * Licensed under The MIT License
 11:  * For full copyright and license information, please see the LICENSE.txt
 12:  * Redistributions of files must retain the above copyright notice.
 13:  *
 14:  * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 15:  * @link          https://cakephp.org CakePHP(tm) Project
 16:  * @package       Cake.Utility
 17:  * @since         CakePHP(tm) v 1.2.4560
 18:  * @license       https://opensource.org/licenses/mit-license.php MIT License
 19:  */
 20: 
 21: App::uses('CakeLog', 'Log');
 22: App::uses('CakeText', 'Utility');
 23: 
 24: /**
 25:  * Provide custom logging and error handling.
 26:  *
 27:  * Debugger overrides PHP's default error handling to provide stack traces and enhanced logging
 28:  *
 29:  * @package       Cake.Utility
 30:  * @link          https://book.cakephp.org/2.0/en/development/debugging.html#debugger-class
 31:  */
 32: class Debugger {
 33: 
 34: /**
 35:  * A list of errors generated by the application.
 36:  *
 37:  * @var array
 38:  */
 39:     public $errors = array();
 40: 
 41: /**
 42:  * The current output format.
 43:  *
 44:  * @var string
 45:  */
 46:     protected $_outputFormat = 'js';
 47: 
 48: /**
 49:  * Templates used when generating trace or error strings. Can be global or indexed by the format
 50:  * value used in $_outputFormat.
 51:  *
 52:  * @var string
 53:  */
 54:     protected $_templates = array(
 55:         'log' => array(
 56:             'trace' => '{:reference} - {:path}, line {:line}',
 57:             'error' => "{:error} ({:code}): {:description} in [{:file}, line {:line}]"
 58:         ),
 59:         'js' => array(
 60:             'error' => '',
 61:             'info' => '',
 62:             'trace' => '<pre class="stack-trace">{:trace}</pre>',
 63:             'code' => '',
 64:             'context' => '',
 65:             'links' => array(),
 66:             'escapeContext' => true,
 67:         ),
 68:         'html' => array(
 69:             'trace' => '<pre class="cake-error trace"><b>Trace</b> <p>{:trace}</p></pre>',
 70:             'context' => '<pre class="cake-error context"><b>Context</b> <p>{:context}</p></pre>',
 71:             'escapeContext' => true,
 72:         ),
 73:         'txt' => array(
 74:             'error' => "{:error}: {:code} :: {:description} on line {:line} of {:path}\n{:info}",
 75:             'code' => '',
 76:             'info' => ''
 77:         ),
 78:         'base' => array(
 79:             'traceLine' => '{:reference} - {:path}, line {:line}',
 80:             'trace' => "Trace:\n{:trace}\n",
 81:             'context' => "Context:\n{:context}\n",
 82:         )
 83:     );
 84: 
 85: /**
 86:  * Holds current output data when outputFormat is false.
 87:  *
 88:  * @var string
 89:  */
 90:     protected $_data = array();
 91: 
 92: /**
 93:  * Constructor.
 94:  */
 95:     public function __construct() {
 96:         $docRef = ini_get('docref_root');
 97: 
 98:         if (empty($docRef) && function_exists('ini_set')) {
 99:             ini_set('docref_root', 'http://php.net/');
100:         }
101:         if (!defined('E_RECOVERABLE_ERROR')) {
102:             define('E_RECOVERABLE_ERROR', 4096);
103:         }
104: 
105:         $e = '<pre class="cake-error">';
106:         $e .= '<a href="javascript:void(0);" onclick="document.getElementById(\'{:id}-trace\')';
107:         $e .= '.style.display = (document.getElementById(\'{:id}-trace\').style.display == ';
108:         $e .= '\'none\' ? \'\' : \'none\');"><b>{:error}</b> ({:code})</a>: {:description} ';
109:         $e .= '[<b>{:path}</b>, line <b>{:line}</b>]';
110: 
111:         $e .= '<div id="{:id}-trace" class="cake-stack-trace" style="display: none;">';
112:         $e .= '{:links}{:info}</div>';
113:         $e .= '</pre>';
114:         $this->_templates['js']['error'] = $e;
115: 
116:         $t = '<div id="{:id}-trace" class="cake-stack-trace" style="display: none;">';
117:         $t .= '{:context}{:code}{:trace}</div>';
118:         $this->_templates['js']['info'] = $t;
119: 
120:         $links = array();
121:         $link = '<a href="javascript:void(0);" onclick="document.getElementById(\'{:id}-code\')';
122:         $link .= '.style.display = (document.getElementById(\'{:id}-code\').style.display == ';
123:         $link .= '\'none\' ? \'\' : \'none\')">Code</a>';
124:         $links['code'] = $link;
125: 
126:         $link = '<a href="javascript:void(0);" onclick="document.getElementById(\'{:id}-context\')';
127:         $link .= '.style.display = (document.getElementById(\'{:id}-context\').style.display == ';
128:         $link .= '\'none\' ? \'\' : \'none\')">Context</a>';
129:         $links['context'] = $link;
130: 
131:         $this->_templates['js']['links'] = $links;
132: 
133:         $this->_templates['js']['context'] = '<pre id="{:id}-context" class="cake-context" ';
134:         $this->_templates['js']['context'] .= 'style="display: none;">{:context}</pre>';
135: 
136:         $this->_templates['js']['code'] = '<pre id="{:id}-code" class="cake-code-dump" ';
137:         $this->_templates['js']['code'] .= 'style="display: none;">{:code}</pre>';
138: 
139:         $e = '<pre class="cake-error"><b>{:error}</b> ({:code}) : {:description} ';
140:         $e .= '[<b>{:path}</b>, line <b>{:line}]</b></pre>';
141:         $this->_templates['html']['error'] = $e;
142: 
143:         $this->_templates['html']['context'] = '<pre class="cake-context"><b>Context</b> ';
144:         $this->_templates['html']['context'] .= '<p>{:context}</p></pre>';
145:     }
146: 
147: /**
148:  * Returns a reference to the Debugger singleton object instance.
149:  *
150:  * @param string $class Debugger class name.
151:  * @return object
152:  */
153:     public static function getInstance($class = null) {
154:         static $instance = array();
155:         if (!empty($class)) {
156:             if (!$instance || strtolower($class) != strtolower(get_class($instance[0]))) {
157:                 $instance[0] = new $class();
158:             }
159:         }
160:         if (!$instance) {
161:             $instance[0] = new Debugger();
162:         }
163:         return $instance[0];
164:     }
165: 
166: /**
167:  * Recursively formats and outputs the contents of the supplied variable.
168:  *
169:  * @param mixed $var the variable to dump
170:  * @param int $depth The depth to output to. Defaults to 3.
171:  * @return void
172:  * @see Debugger::exportVar()
173:  * @link https://book.cakephp.org/2.0/en/development/debugging.html#Debugger::dump
174:  */
175:     public static function dump($var, $depth = 3) {
176:         pr(static::exportVar($var, $depth));
177:     }
178: 
179: /**
180:  * Creates an entry in the log file. The log entry will contain a stack trace from where it was called.
181:  * as well as export the variable using exportVar. By default the log is written to the debug log.
182:  *
183:  * @param mixed $var Variable or content to log
184:  * @param int|string $level Type of log to use. Defaults to LOG_DEBUG. When value is an integer
185:  *    or a string matching the recognized levels, then it will
186:  *    be treated as a log level. Otherwise it's treated as a scope.
187:  * @param int $depth The depth to output to. Defaults to 3.
188:  * @return void
189:  * @link https://book.cakephp.org/2.0/en/development/debugging.html#Debugger::log
190:  */
191:     public static function log($var, $level = LOG_DEBUG, $depth = 3) {
192:         $source = static::trace(array('start' => 1)) . "\n";
193:         CakeLog::write($level, "\n" . $source . static::exportVar($var, $depth));
194:     }
195: 
196: /**
197:  * Overrides PHP's default error handling.
198:  *
199:  * @param int $code Code of error
200:  * @param string $description Error description
201:  * @param string $file File on which error occurred
202:  * @param int $line Line that triggered the error
203:  * @param array $context Context
204:  * @return bool|null True if error was handled, otherwise null.
205:  * @deprecated 3.0.0 Will be removed in 3.0. This function is superseded by Debugger::outputError().
206:  */
207:     public static function showError($code, $description, $file = null, $line = null, $context = null) {
208:         $self = Debugger::getInstance();
209: 
210:         if (empty($file)) {
211:             $file = '[internal]';
212:         }
213:         if (empty($line)) {
214:             $line = '??';
215:         }
216: 
217:         $info = compact('code', 'description', 'file', 'line');
218:         if (!in_array($info, $self->errors)) {
219:             $self->errors[] = $info;
220:         } else {
221:             return null;
222:         }
223: 
224:         switch ($code) {
225:             case E_PARSE:
226:             case E_ERROR:
227:             case E_CORE_ERROR:
228:             case E_COMPILE_ERROR:
229:             case E_USER_ERROR:
230:                 $error = 'Fatal Error';
231:                 $level = LOG_ERR;
232:                 break;
233:             case E_WARNING:
234:             case E_USER_WARNING:
235:             case E_COMPILE_WARNING:
236:             case E_RECOVERABLE_ERROR:
237:                 $error = 'Warning';
238:                 $level = LOG_WARNING;
239:                 break;
240:             case E_NOTICE:
241:             case E_USER_NOTICE:
242:                 $error = 'Notice';
243:                 $level = LOG_NOTICE;
244:                 break;
245:             case E_DEPRECATED:
246:             case E_USER_DEPRECATED:
247:                 $error = 'Deprecated';
248:                 $level = LOG_NOTICE;
249:                 break;
250:             default:
251:                 return null;
252:         }
253: 
254:         $data = compact(
255:             'level', 'error', 'code', 'description', 'file', 'line', 'context'
256:         );
257:         echo $self->outputError($data);
258: 
259:         if ($error === 'Fatal Error') {
260:             exit();
261:         }
262:         return true;
263:     }
264: 
265: /**
266:  * Outputs a stack trace based on the supplied options.
267:  *
268:  * ### Options
269:  *
270:  * - `depth` - The number of stack frames to return. Defaults to 999
271:  * - `format` - The format you want the return. Defaults to the currently selected format. If
272:  *    format is 'array' or 'points' the return will be an array.
273:  * - `args` - Should arguments for functions be shown?  If true, the arguments for each method call
274:  *   will be displayed.
275:  * - `start` - The stack frame to start generating a trace from. Defaults to 0
276:  *
277:  * @param array $options Format for outputting stack trace
278:  * @return mixed Formatted stack trace
279:  * @link https://book.cakephp.org/2.0/en/development/debugging.html#Debugger::trace
280:  */
281:     public static function trace($options = array()) {
282:         $self = Debugger::getInstance();
283:         $defaults = array(
284:             'depth'     => 999,
285:             'format'    => $self->_outputFormat,
286:             'args'      => false,
287:             'start'     => 0,
288:             'scope'     => null,
289:             'exclude'   => array('call_user_func_array', 'trigger_error')
290:         );
291:         $options = Hash::merge($defaults, $options);
292: 
293:         $backtrace = debug_backtrace();
294:         $count = count($backtrace);
295:         $back = array();
296: 
297:         $_trace = array(
298:             'line' => '??',
299:             'file' => '[internal]',
300:             'class' => null,
301:             'function' => '[main]'
302:         );
303: 
304:         for ($i = $options['start']; $i < $count && $i < $options['depth']; $i++) {
305:             $trace = array_merge(array('file' => '[internal]', 'line' => '??'), $backtrace[$i]);
306:             $signature = $reference = '[main]';
307: 
308:             if (isset($backtrace[$i + 1])) {
309:                 $next = array_merge($_trace, $backtrace[$i + 1]);
310:                 $signature = $reference = $next['function'];
311: 
312:                 if (!empty($next['class'])) {
313:                     $signature = $next['class'] . '::' . $next['function'];
314:                     $reference = $signature . '(';
315:                     if ($options['args'] && isset($next['args'])) {
316:                         $args = array();
317:                         foreach ($next['args'] as $arg) {
318:                             $args[] = Debugger::exportVar($arg);
319:                         }
320:                         $reference .= implode(', ', $args);
321:                     }
322:                     $reference .= ')';
323:                 }
324:             }
325:             if (in_array($signature, $options['exclude'])) {
326:                 continue;
327:             }
328:             if ($options['format'] === 'points' && $trace['file'] !== '[internal]') {
329:                 $back[] = array('file' => $trace['file'], 'line' => $trace['line']);
330:             } elseif ($options['format'] === 'array') {
331:                 $back[] = $trace;
332:             } else {
333:                 if (isset($self->_templates[$options['format']]['traceLine'])) {
334:                     $tpl = $self->_templates[$options['format']]['traceLine'];
335:                 } else {
336:                     $tpl = $self->_templates['base']['traceLine'];
337:                 }
338:                 $trace['path'] = static::trimPath($trace['file']);
339:                 $trace['reference'] = $reference;
340:                 unset($trace['object'], $trace['args']);
341:                 $back[] = CakeText::insert($tpl, $trace, array('before' => '{:', 'after' => '}'));
342:             }
343:         }
344: 
345:         if ($options['format'] === 'array' || $options['format'] === 'points') {
346:             return $back;
347:         }
348:         return implode("\n", $back);
349:     }
350: 
351: /**
352:  * Shortens file paths by replacing the application base path with 'APP', and the CakePHP core
353:  * path with 'CORE'.
354:  *
355:  * @param string $path Path to shorten
356:  * @return string Normalized path
357:  */
358:     public static function trimPath($path) {
359:         if (!defined('CAKE_CORE_INCLUDE_PATH') || !defined('APP')) {
360:             return $path;
361:         }
362: 
363:         if (strpos($path, APP) === 0) {
364:             return str_replace(APP, 'APP' . DS, $path);
365:         } elseif (strpos($path, CAKE_CORE_INCLUDE_PATH) === 0) {
366:             return str_replace(CAKE_CORE_INCLUDE_PATH, 'CORE', $path);
367:         } elseif (strpos($path, ROOT) === 0) {
368:             return str_replace(ROOT, 'ROOT', $path);
369:         }
370: 
371:         return $path;
372:     }
373: 
374: /**
375:  * Grabs an excerpt from a file and highlights a given line of code.
376:  *
377:  * Usage:
378:  *
379:  * `Debugger::excerpt('/path/to/file', 100, 4);`
380:  *
381:  * The above would return an array of 8 items. The 4th item would be the provided line,
382:  * and would be wrapped in `<span class="code-highlight"></span>`. All of the lines
383:  * are processed with highlight_string() as well, so they have basic PHP syntax highlighting
384:  * applied.
385:  *
386:  * @param string $file Absolute path to a PHP file
387:  * @param int $line Line number to highlight
388:  * @param int $context Number of lines of context to extract above and below $line
389:  * @return array Set of lines highlighted
390:  * @see http://php.net/highlight_string
391:  * @link https://book.cakephp.org/2.0/en/development/debugging.html#Debugger::excerpt
392:  */
393:     public static function excerpt($file, $line, $context = 2) {
394:         $lines = array();
395:         if (!file_exists($file)) {
396:             return array();
397:         }
398:         $data = file_get_contents($file);
399:         if (empty($data)) {
400:             return $lines;
401:         }
402:         if (strpos($data, "\n") !== false) {
403:             $data = explode("\n", $data);
404:         }
405:         if (!isset($data[$line])) {
406:             return $lines;
407:         }
408:         for ($i = $line - ($context + 1); $i < $line + $context; $i++) {
409:             if (!isset($data[$i])) {
410:                 continue;
411:             }
412:             $string = str_replace(array("\r\n", "\n"), "", static::_highlight($data[$i]));
413:             if ($i == $line) {
414:                 $lines[] = '<span class="code-highlight">' . $string . '</span>';
415:             } else {
416:                 $lines[] = $string;
417:             }
418:         }
419:         return $lines;
420:     }
421: 
422: /**
423:  * Wraps the highlight_string function in case the server API does not
424:  * implement the function as it is the case of the HipHop interpreter
425:  *
426:  * @param string $str the string to convert
427:  * @return string
428:  */
429:     protected static function _highlight($str) {
430:         if (function_exists('hphp_log') || function_exists('hphp_gettid')) {
431:             return htmlentities($str);
432:         }
433:         $added = false;
434:         if (strpos($str, '<?php') === false) {
435:             $added = true;
436:             $str = "<?php \n" . $str;
437:         }
438:         $highlight = highlight_string($str, true);
439:         if ($added) {
440:             $highlight = str_replace(
441:                 '&lt;?php&nbsp;<br />',
442:                 '',
443:                 $highlight
444:             );
445:         }
446:         return $highlight;
447:     }
448: 
449: /**
450:  * Converts a variable to a string for debug output.
451:  *
452:  * *Note:* The following keys will have their contents
453:  * replaced with `*****`:
454:  *
455:  *  - password
456:  *  - login
457:  *  - host
458:  *  - database
459:  *  - port
460:  *
461:  * This is done to protect database credentials, which could be accidentally
462:  * shown in an error message if CakePHP is deployed in development mode.
463:  *
464:  * @param string $var Variable to convert
465:  * @param int $depth The depth to output to. Defaults to 3.
466:  * @return string Variable as a formatted string
467:  * @link https://book.cakephp.org/2.0/en/development/debugging.html#Debugger::exportVar
468:  */
469:     public static function exportVar($var, $depth = 3) {
470:         return static::_export($var, $depth, 0);
471:     }
472: 
473: /**
474:  * Protected export function used to keep track of indentation and recursion.
475:  *
476:  * @param mixed $var The variable to dump.
477:  * @param int $depth The remaining depth.
478:  * @param int $indent The current indentation level.
479:  * @return string The dumped variable.
480:  */
481:     protected static function _export($var, $depth, $indent) {
482:         switch (static::getType($var)) {
483:             case 'boolean':
484:                 return ($var) ? 'true' : 'false';
485:             case 'integer':
486:                 return '(int) ' . $var;
487:             case 'float':
488:                 return '(float) ' . $var;
489:             case 'string':
490:                 if (trim($var) === '') {
491:                     return "''";
492:                 }
493:                 return "'" . $var . "'";
494:             case 'array':
495:                 return static::_array($var, $depth - 1, $indent + 1);
496:             case 'resource':
497:                 return strtolower(gettype($var));
498:             case 'null':
499:                 return 'null';
500:             case 'unknown':
501:                 return 'unknown';
502:             default:
503:                 return static::_object($var, $depth - 1, $indent + 1);
504:         }
505:     }
506: 
507: /**
508:  * Export an array type object. Filters out keys used in datasource configuration.
509:  *
510:  * The following keys are replaced with ***'s
511:  *
512:  * - password
513:  * - login
514:  * - host
515:  * - database
516:  * - port
517:  *
518:  * @param array $var The array to export.
519:  * @param int $depth The current depth, used for recursion tracking.
520:  * @param int $indent The current indentation level.
521:  * @return string Exported array.
522:  */
523:     protected static function _array(array $var, $depth, $indent) {
524:         $secrets = array(
525:             'password' => '*****',
526:             'login' => '*****',
527:             'host' => '*****',
528:             'database' => '*****',
529:             'port' => '*****'
530:         );
531:         $replace = array_intersect_key($secrets, $var);
532:         $var = $replace + $var;
533: 
534:         $out = "array(";
535:         $break = $end = null;
536:         if (!empty($var)) {
537:             $break = "\n" . str_repeat("\t", $indent);
538:             $end = "\n" . str_repeat("\t", $indent - 1);
539:         }
540:         $vars = array();
541: 
542:         if ($depth >= 0) {
543:             foreach ($var as $key => $val) {
544:                 // Sniff for globals as !== explodes in < 5.4
545:                 if ($key === 'GLOBALS' && is_array($val) && isset($val['GLOBALS'])) {
546:                     $val = '[recursion]';
547:                 } elseif ($val !== $var) {
548:                     $val = static::_export($val, $depth, $indent);
549:                 }
550:                 $vars[] = $break . static::exportVar($key) .
551:                     ' => ' .
552:                     $val;
553:             }
554:         } else {
555:             $vars[] = $break . '[maximum depth reached]';
556:         }
557:         return $out . implode(',', $vars) . $end . ')';
558:     }
559: 
560: /**
561:  * Handles object to string conversion.
562:  *
563:  * @param string $var Object to convert
564:  * @param int $depth The current depth, used for tracking recursion.
565:  * @param int $indent The current indentation level.
566:  * @return string
567:  * @see Debugger::exportVar()
568:  */
569:     protected static function _object($var, $depth, $indent) {
570:         $out = '';
571:         $props = array();
572: 
573:         $className = get_class($var);
574:         $out .= 'object(' . $className . ') {';
575: 
576:         if ($depth > 0) {
577:             $end = "\n" . str_repeat("\t", $indent - 1);
578:             $break = "\n" . str_repeat("\t", $indent);
579:             $objectVars = get_object_vars($var);
580:             foreach ($objectVars as $key => $value) {
581:                 $value = static::_export($value, $depth - 1, $indent);
582:                 $props[] = "$key => " . $value;
583:             }
584: 
585:             if (version_compare(PHP_VERSION, '5.3.0') >= 0) {
586:                 $ref = new ReflectionObject($var);
587: 
588:                 $filters = array(
589:                     ReflectionProperty::IS_PROTECTED => 'protected',
590:                     ReflectionProperty::IS_PRIVATE => 'private',
591:                 );
592:                 foreach ($filters as $filter => $visibility) {
593:                     $reflectionProperties = $ref->getProperties($filter);
594:                     foreach ($reflectionProperties as $reflectionProperty) {
595:                         $reflectionProperty->setAccessible(true);
596:                         $property = $reflectionProperty->getValue($var);
597: 
598:                         $value = static::_export($property, $depth - 1, $indent);
599:                         $key = $reflectionProperty->name;
600:                         $props[] = sprintf('[%s] %s => %s', $visibility, $key, $value);
601:                     }
602:                 }
603:             }
604: 
605:             $out .= $break . implode($break, $props) . $end;
606:         }
607:         $out .= '}';
608:         return $out;
609:     }
610: 
611: /**
612:  * Get/Set the output format for Debugger error rendering.
613:  *
614:  * @param string $format The format you want errors to be output as.
615:  *   Leave null to get the current format.
616:  * @return mixed Returns null when setting. Returns the current format when getting.
617:  * @throws CakeException when choosing a format that doesn't exist.
618:  */
619:     public static function outputAs($format = null) {
620:         $self = Debugger::getInstance();
621:         if ($format === null) {
622:             return $self->_outputFormat;
623:         }
624:         if ($format !== false && !isset($self->_templates[$format])) {
625:             throw new CakeException(__d('cake_dev', 'Invalid Debugger output format.'));
626:         }
627:         $self->_outputFormat = $format;
628:     }
629: 
630: /**
631:  * Add an output format or update a format in Debugger.
632:  *
633:  * `Debugger::addFormat('custom', $data);`
634:  *
635:  * Where $data is an array of strings that use CakeText::insert() variable
636:  * replacement. The template vars should be in a `{:id}` style.
637:  * An error formatter can have the following keys:
638:  *
639:  * - 'error' - Used for the container for the error message. Gets the following template
640:  *   variables: `id`, `error`, `code`, `description`, `path`, `line`, `links`, `info`
641:  * - 'info' - A combination of `code`, `context` and `trace`. Will be set with
642:  *   the contents of the other template keys.
643:  * - 'trace' - The container for a stack trace. Gets the following template
644:  *   variables: `trace`
645:  * - 'context' - The container element for the context variables.
646:  *   Gets the following templates: `id`, `context`
647:  * - 'links' - An array of HTML links that are used for creating links to other resources.
648:  *   Typically this is used to create javascript links to open other sections.
649:  *   Link keys, are: `code`, `context`, `help`. See the js output format for an
650:  *   example.
651:  * - 'traceLine' - Used for creating lines in the stacktrace. Gets the following
652:  *   template variables: `reference`, `path`, `line`
653:  *
654:  * Alternatively if you want to use a custom callback to do all the formatting, you can use
655:  * the callback key, and provide a callable:
656:  *
657:  * `Debugger::addFormat('custom', array('callback' => array($foo, 'outputError'));`
658:  *
659:  * The callback can expect two parameters. The first is an array of all
660:  * the error data. The second contains the formatted strings generated using
661:  * the other template strings. Keys like `info`, `links`, `code`, `context` and `trace`
662:  * will be present depending on the other templates in the format type.
663:  *
664:  * @param string $format Format to use, including 'js' for JavaScript-enhanced HTML, 'html' for
665:  *    straight HTML output, or 'txt' for unformatted text.
666:  * @param array $strings Template strings, or a callback to be used for the output format.
667:  * @return The resulting format string set.
668:  */
669:     public static function addFormat($format, array $strings) {
670:         $self = Debugger::getInstance();
671:         if (isset($self->_templates[$format])) {
672:             if (isset($strings['links'])) {
673:                 $self->_templates[$format]['links'] = array_merge(
674:                     $self->_templates[$format]['links'],
675:                     $strings['links']
676:                 );
677:                 unset($strings['links']);
678:             }
679:             $self->_templates[$format] = array_merge($self->_templates[$format], $strings);
680:         } else {
681:             $self->_templates[$format] = $strings;
682:         }
683:         return $self->_templates[$format];
684:     }
685: 
686: /**
687:  * Switches output format, updates format strings.
688:  * Can be used to switch the active output format:
689:  *
690:  * @param string $format Format to use, including 'js' for JavaScript-enhanced HTML, 'html' for
691:  *    straight HTML output, or 'txt' for unformatted text.
692:  * @param array $strings Template strings to be used for the output format.
693:  * @return string
694:  * @deprecated 3.0.0 Use Debugger::outputAs() and Debugger::addFormat(). Will be removed
695:  *   in 3.0
696:  */
697:     public static function output($format = null, $strings = array()) {
698:         $self = Debugger::getInstance();
699:         $data = null;
700: 
701:         if ($format === null) {
702:             return Debugger::outputAs();
703:         }
704: 
705:         if (!empty($strings)) {
706:             return Debugger::addFormat($format, $strings);
707:         }
708: 
709:         if ($format === true && !empty($self->_data)) {
710:             $data = $self->_data;
711:             $self->_data = array();
712:             $format = false;
713:         }
714:         Debugger::outputAs($format);
715:         return $data;
716:     }
717: 
718: /**
719:  * Takes a processed array of data from an error and displays it in the chosen format.
720:  *
721:  * @param string $data Data to output.
722:  * @return void
723:  */
724:     public function outputError($data) {
725:         $defaults = array(
726:             'level' => 0,
727:             'error' => 0,
728:             'code' => 0,
729:             'description' => '',
730:             'file' => '',
731:             'line' => 0,
732:             'context' => array(),
733:             'start' => 2,
734:         );
735:         $data += $defaults;
736: 
737:         $files = $this->trace(array('start' => $data['start'], 'format' => 'points'));
738:         $code = '';
739:         $file = null;
740:         if (isset($files[0]['file'])) {
741:             $file = $files[0];
742:         } elseif (isset($files[1]['file'])) {
743:             $file = $files[1];
744:         }
745:         if ($file) {
746:             $code = $this->excerpt($file['file'], $file['line'] - 1, 1);
747:         }
748:         $trace = $this->trace(array('start' => $data['start'], 'depth' => '20'));
749:         $insertOpts = array('before' => '{:', 'after' => '}');
750:         $context = array();
751:         $links = array();
752:         $info = '';
753: 
754:         foreach ((array)$data['context'] as $var => $value) {
755:             $context[] = "\${$var} = " . $this->exportVar($value, 3);
756:         }
757: 
758:         switch ($this->_outputFormat) {
759:             case false:
760:                 $this->_data[] = compact('context', 'trace') + $data;
761:                 return;
762:             case 'log':
763:                 $this->log(compact('context', 'trace') + $data);
764:                 return;
765:         }
766: 
767:         $data['trace'] = $trace;
768:         $data['id'] = 'cakeErr' . uniqid();
769:         $tpl = array_merge($this->_templates['base'], $this->_templates[$this->_outputFormat]);
770: 
771:         if (isset($tpl['links'])) {
772:             foreach ($tpl['links'] as $key => $val) {
773:                 $links[$key] = CakeText::insert($val, $data, $insertOpts);
774:             }
775:         }
776: 
777:         if (!empty($tpl['escapeContext'])) {
778:             $context = h($context);
779:             $data['description'] = h($data['description']);
780:         }
781: 
782:         $infoData = compact('code', 'context', 'trace');
783:         foreach ($infoData as $key => $value) {
784:             if (empty($value) || !isset($tpl[$key])) {
785:                 continue;
786:             }
787:             if (is_array($value)) {
788:                 $value = implode("\n", $value);
789:             }
790:             $info .= CakeText::insert($tpl[$key], array($key => $value) + $data, $insertOpts);
791:         }
792:         $links = implode(' ', $links);
793: 
794:         if (isset($tpl['callback']) && is_callable($tpl['callback'])) {
795:             return call_user_func($tpl['callback'], $data, compact('links', 'info'));
796:         }
797:         echo CakeText::insert($tpl['error'], compact('links', 'info') + $data, $insertOpts);
798:     }
799: 
800: /**
801:  * Get the type of the given variable. Will return the class name
802:  * for objects.
803:  *
804:  * @param mixed $var The variable to get the type of
805:  * @return string The type of variable.
806:  */
807:     public static function getType($var) {
808:         if (is_object($var)) {
809:             return get_class($var);
810:         }
811:         if ($var === null) {
812:             return 'null';
813:         }
814:         if (is_string($var)) {
815:             return 'string';
816:         }
817:         if (is_array($var)) {
818:             return 'array';
819:         }
820:         if (is_int($var)) {
821:             return 'integer';
822:         }
823:         if (is_bool($var)) {
824:             return 'boolean';
825:         }
826:         if (is_float($var)) {
827:             return 'float';
828:         }
829:         if (is_resource($var)) {
830:             return 'resource';
831:         }
832:         return 'unknown';
833:     }
834: 
835: /**
836:  * Verifies that the application's salt and cipher seed value has been changed from the default value.
837:  *
838:  * @return void
839:  */
840:     public static function checkSecurityKeys() {
841:         if (Configure::read('Security.salt') === 'DYhG93b0qyJfIxfs2guVoUubWwvniR2G0FgaC9mi') {
842:             trigger_error(__d('cake_dev', 'Please change the value of %s in %s to a salt value specific to your application.', '\'Security.salt\'', CONFIG . 'core.php'), E_USER_NOTICE);
843:         }
844: 
845:         if (Configure::read('Security.cipherSeed') === '76859309657453542496749683645') {
846:             trigger_error(__d('cake_dev', 'Please change the value of %s in %s to a numeric (digits only) seed value specific to your application.', '\'Security.cipherSeed\'', CONFIG . 'core.php'), E_USER_NOTICE);
847:         }
848:     }
849: 
850: }
851: