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