CRM/Core/Error.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.6                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  * Start of the Error framework. We should check out and inherit from
  31  * PEAR_ErrorStack and use that framework
  32  *
  33  * @package CRM
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * $Id$
  36  *
  37  */
  38
  39 require_once 'PEAR/ErrorStack.php';
  40 require_once 'PEAR/Exception.php';
  41 require_once 'CRM/Core/Exception.php';
  42
  43 require_once 'Log.php';
  44
  45 /**
  46  * Class CRM_Exception
  47  */
  48 class CRM_Exception extends PEAR_Exception {
  49   // Redefine the exception so message isn't optional
  50   /**
  51    * Supported signatures:
  52    *  - PEAR_Exception(string $message);
  53    *  - PEAR_Exception(string $message, int $code);
  54    *  - PEAR_Exception(string $message, Exception $cause);
  55    *  - PEAR_Exception(string $message, Exception $cause, int $code);
  56    *  - PEAR_Exception(string $message, PEAR_Error $cause);
  57    *  - PEAR_Exception(string $message, PEAR_Error $cause, int $code);
  58    *  - PEAR_Exception(string $message, array $causes);
  59    *  - PEAR_Exception(string $message, array $causes, int $code);
  60    *
  61    * @param string exception message
  62    * @param int $code
  63    * @param Exception $previous
  64    */
  65   public function __construct($message = NULL, $code = 0, Exception$previous = NULL) {
  66     parent::__construct($message, $code, $previous);
  67   }
  68 }
  69
  70 /**
  71  * Class CRM_Core_Error
  72  */
  73 class CRM_Core_Error extends PEAR_ErrorStack {
  74
  75   /**
  76    * Status code of various types of errors
  77    * @var const
  78    */
  79   const FATAL_ERROR = 2;
  80   const DUPLICATE_CONTACT = 8001;
  81   const DUPLICATE_CONTRIBUTION = 8002;
  82   const DUPLICATE_PARTICIPANT = 8003;
  83
  84   /**
  85    * We only need one instance of this object. So we use the singleton
  86    * pattern and cache the instance in this variable
  87    * @var object
  88    * @static
  89    */
  90   private static $_singleton = NULL;
  91
  92   /**
  93    * The logger object for this application
  94    * @var object
  95    * @static
  96    */
  97   private static $_log = NULL;
  98
  99   /**
 100    * If modeException == true, errors are raised as exception instead of returning civicrm_errors
 101    * @static
 102    */
 103   public static $modeException = NULL;
 104
 105   /**
 106    * Singleton function used to manage this object.
 107    *
 108    * @param null $package
 109    * @param bool $msgCallback
 110    * @param bool $contextCallback
 111    * @param bool $throwPEAR_Error
 112    * @param string $stackClass
 113    *
 114    * @return object
 115    * @static
 116    */
 117    public static function &singleton($package = NULL, $msgCallback = FALSE, $contextCallback = FALSE, $throwPEAR_Error = FALSE, $stackClass = 'PEAR_ErrorStack') {
 118     if (self::$_singleton === NULL) {
 119       self::$_singleton = new CRM_Core_Error('CiviCRM');
 120     }
 121     return self::$_singleton;
 122   }
 123
 124   /**
 125    * Constructor
 126    */
 127   public function __construct() {
 128     parent::__construct('CiviCRM');
 129
 130     $log = CRM_Core_Config::getLog();
 131     $this->setLogger($log);
 132
 133     // set up error handling for Pear Error Stack
 134     $this->setDefaultCallback(array($this, 'handlePES'));
 135   }
 136
 137   /**
 138    * @param $error
 139    * @param string $separator
 140    *
 141    * @return array|null|string
 142    */
 143   static public function getMessages(&$error, $separator = '<br />') {
 144     if (is_a($error, 'CRM_Core_Error')) {
 145       $errors = $error->getErrors();
 146       $message = array();
 147       foreach ($errors as $e) {
 148         $message[] = $e['code'] . ': ' . $e['message'];
 149       }
 150       $message = implode($separator, $message);
 151       return $message;
 152     }
 153     return NULL;
 154   }
 155
 156   /**
 157    * Status display function specific to payment processor errors
 158    * @param $error
 159    * @param string $separator
 160    */
 161   public static function displaySessionError(&$error, $separator = '<br />') {
 162     $message = self::getMessages($error, $separator);
 163     if ($message) {
 164       $status = ts("Payment Processor Error message") . "{$separator} $message";
 165       $session = CRM_Core_Session::singleton();
 166       $session->setStatus($status);
 167     }
 168   }
 169
 170   /**
 171    * Create the main callback method. this method centralizes error processing.
 172    *
 173    * the errors we expect are from the pear modules DB, DB_DataObject
 174    * which currently use PEAR::raiseError to notify of error messages.
 175    *
 176    * @param object PEAR_Error
 177    *
 178    * @return void
 179    */
 180   public static function handle($pearError) {
 181
 182     // setup smarty with config, session and template location.
 183     $template = CRM_Core_Smarty::singleton();
 184     $config = CRM_Core_Config::singleton();
 185
 186     if ($config->backtrace) {
 187       self::backtrace();
 188     }
 189
 190     // create the error array
 191     $error               = array();
 192     $error['callback']   = $pearError->getCallback();
 193     $error['code']       = $pearError->getCode();
 194     $error['message']    = $pearError->getMessage();
 195     $error['mode']       = $pearError->getMode();
 196     $error['debug_info'] = $pearError->getDebugInfo();
 197     $error['type']       = $pearError->getType();
 198     $error['user_info']  = $pearError->getUserInfo();
 199     $error['to_string']  = $pearError->toString();
 200     if (function_exists('mysql_error') &&
 201       mysql_error()
 202     ) {
 203       $mysql_error = mysql_error() . ', ' . mysql_errno();
 204       $template->assign_by_ref('mysql_code', $mysql_error);
 205
 206       // execute a dummy query to clear error stack
 207       mysql_query('select 1');
 208     }
 209     elseif (function_exists('mysqli_error')) {
 210       $dao = new CRM_Core_DAO();
 211
 212       // we do it this way, since calling the function
 213       // getDatabaseConnection could potentially result
 214       // in an infinite loop
 215       global $_DB_DATAOBJECT;
 216       if (isset($_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5])) {
 217         $conn = $_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5];
 218         $link = $conn->connection;
 219
 220         if (mysqli_error($link)) {
 221           $mysql_error = mysqli_error($link) . ', ' . mysqli_errno($link);
 222           $template->assign_by_ref('mysql_code', $mysql_error);
 223
 224           // execute a dummy query to clear error stack
 225           mysqli_query($link, 'select 1');
 226         }
 227       }
 228     }
 229
 230     $template->assign_by_ref('error', $error);
 231     $errorDetails = CRM_Core_Error::debug('', $error, FALSE);
 232     $template->assign_by_ref('errorDetails', $errorDetails);
 233
 234     CRM_Core_Error::debug_var('Fatal Error Details', $error);
 235     CRM_Core_Error::backtrace('backTrace', TRUE);
 236
 237     if ($config->initialized) {
 238       $content = $template->fetch('CRM/common/fatal.tpl');
 239       echo CRM_Utils_System::theme($content);
 240     }
 241     else {
 242       echo "Sorry. A non-recoverable error has occurred. The error trace below might help to resolve the issue<p>";
 243       CRM_Core_Error::debug(NULL, $error);
 244     }
 245     static $runOnce = FALSE;
 246     if ($runOnce) {
 247       exit;
 248     }
 249     $runOnce = TRUE;
 250     self::abend(1);
 251   }
 252
 253   // this function is used to trap and print errors
 254   // during system initialization time. Hence the error
 255   // message is quite ugly
 256   /**
 257    * @param $pearError
 258    */
 259   public static function simpleHandler($pearError) {
 260
 261     // create the error array
 262     $error               = array();
 263     $error['callback']   = $pearError->getCallback();
 264     $error['code']       = $pearError->getCode();
 265     $error['message']    = $pearError->getMessage();
 266     $error['mode']       = $pearError->getMode();
 267     $error['debug_info'] = $pearError->getDebugInfo();
 268     $error['type']       = $pearError->getType();
 269     $error['user_info']  = $pearError->getUserInfo();
 270     $error['to_string']  = $pearError->toString();
 271
 272     // ensure that debug does not check permissions since we are in bootstrap
 273     // mode and need to print a decent message to help the user
 274     CRM_Core_Error::debug('Initialization Error', $error, TRUE, TRUE, FALSE);
 275
 276     // always log the backtrace to a file
 277     self::backtrace('backTrace', TRUE);
 278
 279     exit(0);
 280   }
 281
 282   /**
 283    * Handle errors raised using the PEAR Error Stack.
 284    *
 285    * currently the handler just requests the PES framework
 286    * to push the error to the stack (return value PEAR_ERRORSTACK_PUSH).
 287    *
 288    * Note: we can do our own error handling here and return PEAR_ERRORSTACK_IGNORE.
 289    *
 290    * Also, if we do not return any value the PEAR_ErrorStack::push() then does the
 291    * action of PEAR_ERRORSTACK_PUSHANDLOG which displays the errors on the screen,
 292    * since the logger set for this error stack is 'display' - see CRM_Core_Config::getLog();
 293    *
 294    */
 295   public static function handlePES($pearError) {
 296     return PEAR_ERRORSTACK_PUSH;
 297   }
 298
 299   /**
 300    * Display an error page with an error message describing what happened
 301    *
 302    * @param string $message the error message
 303    * @param string $code the error code if any
 304    * @param string $email the email address to notify of this situation
 305    *
 306    * @throws Exception
 307    *
 308    * @return void
 309    * @static
 310    */
 311   public static function fatal($message = NULL, $code = NULL, $email = NULL) {
 312     $vars = array(
 313       'message' => $message,
 314       'code' => $code,
 315     );
 316
 317     if (self::$modeException) {
 318       // CRM-11043
 319       CRM_Core_Error::debug_var('Fatal Error Details', $vars);
 320       CRM_Core_Error::backtrace('backTrace', TRUE);
 321
 322       $details = 'A fatal error was triggered';
 323       if ($message) {
 324         $details .= ': ' . $message;
 325     }
 326       throw new Exception($details, $code);
 327     }
 328
 329     if (!$message) {
 330       $message = ts('We experienced an unexpected error. Please post a detailed description and the backtrace on the CiviCRM forums: %1', array(1 => 'http://forum.civicrm.org/'));
 331     }
 332
 333     if (php_sapi_name() == "cli") {
 334       print ("Sorry. A non-recoverable error has occurred.\n$message \n$code\n$email\n\n");
 335       debug_print_backtrace();
 336       die("\n");
 337       // FIXME: Why doesn't this call abend()?
 338       // Difference: abend() will cleanup transaction and (via civiExit) store session state
 339       // self::abend(CRM_Core_Error::FATAL_ERROR);
 340     }
 341
 342     $config = CRM_Core_Config::singleton();
 343
 344     if ($config->fatalErrorHandler &&
 345       function_exists($config->fatalErrorHandler)
 346     ) {
 347       $name = $config->fatalErrorHandler;
 348       $ret = $name($vars);
 349       if ($ret) {
 350         // the call has been successfully handled
 351         // so we just exit
 352         self::abend(CRM_Core_Error::FATAL_ERROR);
 353       }
 354     }
 355
 356     if ($config->backtrace) {
 357       self::backtrace();
 358     }
 359
 360     CRM_Core_Error::debug_var('Fatal Error Details', $vars);
 361     CRM_Core_Error::backtrace('backTrace', TRUE);
 362
 363     // If we are in an ajax callback, format output appropriately
 364     if (CRM_Utils_Array::value('snippet', $_REQUEST) === CRM_Core_Smarty::PRINT_JSON) {
 365       $out = array(
 366         'status' => 'fatal',
 367         'content' => '<div class="messages status no-popup"><div class="icon inform-icon"></div>' . ts('Sorry but we are not able to provide this at the moment.') . '</div>',
 368       );
 369       if ($config->backtrace && CRM_Core_Permission::check('view debug output')) {
 370         $out['backtrace'] = self::parseBacktrace(debug_backtrace());
 371         $message .= '<p><em>See console for backtrace</em></p>';
 372       }
 373       CRM_Core_Session::setStatus($message, ts('Sorry an Error Occured'), 'error');
 374       CRM_Core_Transaction::forceRollbackIfEnabled();
 375       CRM_Core_Page_AJAX::returnJsonResponse($out);
 376     }
 377
 378     $template = CRM_Core_Smarty::singleton();
 379     $template->assign($vars);
 380
 381     $config->userSystem->outputError($template->fetch($config->fatalErrorTemplate));
 382
 383     self::abend(CRM_Core_Error::FATAL_ERROR);
 384   }
 385
 386   /**
 387    * Display an error page with an error message describing what happened
 388    *
 389    * This function is evil -- it largely replicates fatal(). Hopefully the
 390    * entire CRM_Core_Error system can be hollowed out and replaced with
 391    * something that follows a cleaner separation of concerns.
 392    *
 393    * @param Exception $exception
 394    *
 395    * @return void
 396    * @static
 397    */
 398   public static function handleUnhandledException($exception) {
 399     try {
 400       CRM_Utils_Hook::unhandledException($exception);
 401     } catch (Exception $other) {
 402       // if the exception-handler generates an exception, then that sucks! oh, well. carry on.
 403       CRM_Core_Error::debug_var('handleUnhandledException_nestedException', self::formatTextException($other));
 404     }
 405     $config = CRM_Core_Config::singleton();
 406     $vars = array(
 407       'message' => $exception->getMessage(),
 408       'code' => NULL,
 409       'exception' => $exception,
 410     );
 411     if (!$vars['message']) {
 412       $vars['message'] = ts('We experienced an unexpected error. Please post a detailed description and the backtrace on the CiviCRM forums: %1', array(1 => 'http://forum.civicrm.org/'));
 413     }
 414
 415     // Case A: CLI
 416     if (php_sapi_name() == "cli") {
 417       printf("Sorry. A non-recoverable error has occurred.\n%s\n", $vars['message']);
 418       print self::formatTextException($exception);
 419       die("\n");
 420       // FIXME: Why doesn't this call abend()?
 421       // Difference: abend() will cleanup transaction and (via civiExit) store session state
 422       // self::abend(CRM_Core_Error::FATAL_ERROR);
 423     }
 424
 425     // Case B: Custom error handler
 426     if ($config->fatalErrorHandler &&
 427       function_exists($config->fatalErrorHandler)
 428     ) {
 429       $name = $config->fatalErrorHandler;
 430       $ret = $name($vars);
 431       if ($ret) {
 432         // the call has been successfully handled
 433         // so we just exit
 434         self::abend(CRM_Core_Error::FATAL_ERROR);
 435       }
 436     }
 437
 438     // Case C: Default error handler
 439
 440     // log to file
 441     CRM_Core_Error::debug_var('Fatal Error Details', $vars);
 442     CRM_Core_Error::backtrace('backTrace', TRUE);
 443
 444     // print to screen
 445     $template = CRM_Core_Smarty::singleton();
 446     $template->assign($vars);
 447     $content = $template->fetch($config->fatalErrorTemplate);
 448     if ($config->backtrace) {
 449       $content = self::formatHtmlException($exception) . $content;
 450     }
 451     if ($config->userFramework == 'Joomla' &&
 452       class_exists('JError')
 453     ) {
 454       JError::raiseError('CiviCRM-001', $content);
 455     }
 456     else {
 457       echo CRM_Utils_System::theme($content);
 458     }
 459
 460     // fin
 461     self::abend(CRM_Core_Error::FATAL_ERROR);
 462   }
 463
 464   /**
 465    * Outputs pre-formatted debug information. Flushes the buffers
 466    * so we can interrupt a potential POST/redirect
 467    *
 468    * @param  string name of debug section
 469    * @param  mixed  reference to variables that we need a trace of
 470    * @param  bool   should we log or return the output
 471    * @param  bool   whether to generate a HTML-escaped output
 472    * @param  bool   should we check permissions before displaying output
 473    *                useful when we die during initialization and permissioning
 474    *                subsystem is not initialized - CRM-13765
 475    *
 476    * @return string the generated output
 477    * @static
 478    */
 479   public static function debug($name, $variable = NULL, $log = TRUE, $html = TRUE, $checkPermission = TRUE) {
 480     $error = self::singleton();
 481
 482     if ($variable === NULL) {
 483       $variable = $name;
 484       $name = NULL;
 485     }
 486
 487     $out = print_r($variable, TRUE);
 488     $prefix = NULL;
 489     if ($html) {
 490       $out = htmlspecialchars($out);
 491       if ($name) {
 492         $prefix = "<p>$name</p>";
 493       }
 494       $out = "{$prefix}<p><pre>$out</pre></p><p></p>";
 495     }
 496     else {
 497       if ($name) {
 498         $prefix = "$name:\n";
 499       }
 500       $out = "{$prefix}$out\n";
 501     }
 502     if (
 503       $log &&
 504       (!$checkPermission || CRM_Core_Permission::check('view debug output'))
 505     ) {
 506       echo $out;
 507     }
 508
 509     return $out;
 510   }
 511
 512   /**
 513    * Similar to the function debug. Only difference is
 514    * in the formatting of the output.
 515    *
 516    * @param string $variable_name
 517    * @param mixed $variable
 518    * @param bool $print should we use print_r ? (else we use var_dump)
 519    * @param bool $log should we log or return the output
 520    * @param string $comp variable name
 521    *
 522    * @return string the generated output
 523    *
 524    *
 525    * @static
 526    *
 527    * @see CRM_Core_Error::debug()
 528    * @see CRM_Core_Error::debug_log_message()
 529    */
 530   static function debug_var($variable_name,
 531     $variable,
 532     $print = TRUE,
 533     $log   = TRUE,
 534     $comp  = ''
 535   ) {
 536     // check if variable is set
 537     if (!isset($variable)) {
 538       $out = "\$$variable_name is not set";
 539     }
 540     else {
 541       if ($print) {
 542         $out = print_r($variable, TRUE);
 543         $out = "\$$variable_name = $out";
 544       }
 545       else {
 546         // use var_dump
 547         ob_start();
 548         var_dump($variable);
 549         $dump = ob_get_contents();
 550         ob_end_clean();
 551         $out = "\n\$$variable_name = $dump";
 552       }
 553       // reset if it is an array
 554       if (is_array($variable)) {
 555         reset($variable);
 556       }
 557     }
 558     return self::debug_log_message($out, FALSE, $comp);
 559   }
 560
 561   /**
 562    * Display the error message on terminal
 563    *
 564    * @param $message
 565    * @param bool $out should we log or return the output
 566    *
 567    * @param string $comp message to be output
 568    * @return string format of the backtrace
 569    *
 570    *
 571    * @static
 572    */
 573   public static function debug_log_message($message, $out = FALSE, $comp = '') {
 574     $config = CRM_Core_Config::singleton();
 575
 576     $file_log = self::createDebugLogger($comp);
 577     $file_log->log("$message\n");
 578     $str = "<p/><code>$message</code>";
 579     if ($out && CRM_Core_Permission::check('view debug output')) {
 580       echo $str;
 581     }
 582     $file_log->close();
 583
 584     if ($config->userFrameworkLogging) {
 585       // should call $config->userSystem->logger($message) here - but I got a situation where userSystem was not an object - not sure why
 586       if ($config->userSystem->is_drupal and function_exists('watchdog')) {
 587         watchdog('civicrm', $message, NULL, WATCHDOG_DEBUG);
 588       }
 589     }
 590
 591     return $str;
 592   }
 593
 594   /**
 595    * Append to the query log (if enabled)
 596    */
 597   public static function debug_query($string) {
 598     if ( defined( 'CIVICRM_DEBUG_LOG_QUERY' ) ) {
 599       if ( CIVICRM_DEBUG_LOG_QUERY == 'backtrace' ) {
 600         CRM_Core_Error::backtrace( $string, true );
 601       } else if ( CIVICRM_DEBUG_LOG_QUERY ) {
 602         CRM_Core_Error::debug_var( 'Query', $string, false, true );
 603       }
 604     }
 605   }
 606
 607   /**
 608    * Execute a query and log the results.
 609    *
 610    * @param string $query
 611    */
 612   public static function debug_query_result($query) {
 613     $dao = CRM_Core_DAO::executeQuery($query);
 614     $results = array();
 615     while ($dao->fetch()) {
 616       $results[] = (array)$dao;
 617     }
 618     CRM_Core_Error::debug_var('dao result', array('query' => $query, 'results' => $results));
 619   }
 620
 621   /**
 622    * Obtain a reference to the error log
 623    *
 624    * @param string $comp
 625    *
 626    * @return Log
 627    */
 628   public static function createDebugLogger($comp = '') {
 629     $config = CRM_Core_Config::singleton();
 630
 631     if ($comp) {
 632       $comp = $comp . '.';
 633     }
 634
 635     $fileName = "{$config->configAndLogDir}CiviCRM." . $comp . md5($config->dsn) . '.log';
 636
 637     // Roll log file monthly or if greater than 256M
 638     // note that PHP file functions have a limit of 2G and hence
 639     // the alternative was introduce
 640     if (file_exists($fileName)) {
 641       $fileTime = date("Ym", filemtime($fileName));
 642       $fileSize = filesize($fileName);
 643       if (($fileTime < date('Ym')) ||
 644         ($fileSize > 256 * 1024 * 1024) ||
 645         ($fileSize < 0)
 646       ) {
 647         rename($fileName,
 648           $fileName . '.' . date('Ymdhs', mktime(0, 0, 0, date("m") - 1, date("d"), date("Y")))
 649         );
 650       }
 651     }
 652
 653     return Log::singleton('file', $fileName);
 654   }
 655
 656   /**
 657    * @param string $msg
 658    * @param bool $log
 659    */
 660   public static function backtrace($msg = 'backTrace', $log = FALSE) {
 661     $backTrace = debug_backtrace();
 662     $message = self::formatBacktrace($backTrace);
 663     if (!$log) {
 664       CRM_Core_Error::debug($msg, $message);
 665     }
 666     else {
 667       CRM_Core_Error::debug_var($msg, $message);
 668     }
 669   }
 670
 671   /**
 672    * Render a backtrace array as a string
 673    *
 674    * @param array $backTrace array of stack frames
 675    * @param boolean $showArgs TRUE if we should try to display content of function arguments (which could be sensitive); FALSE to display only the type of each function argument
 676    * @param int $maxArgLen maximum number of characters to show from each argument string
 677    * @return string printable plain-text
 678    */
 679   public static function formatBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) {
 680     $message = '';
 681     foreach (self::parseBacktrace($backTrace, $showArgs, $maxArgLen) as $idx => $trace) {
 682       $message .= sprintf("#%s %s\n", $idx, $trace);
 683     }
 684     $message .= sprintf("#%s {main}\n", 1+$idx);
 685     return $message;
 686   }
 687
 688   /**
 689    * Render a backtrace array as an array
 690    *
 691    * @param array $backTrace array of stack frames
 692    * @param boolean $showArgs TRUE if we should try to display content of function arguments (which could be sensitive); FALSE to display only the type of each function argument
 693    * @param int $maxArgLen maximum number of characters to show from each argument string
 694    * @return array
 695    * @see debug_backtrace
 696    * @see Exception::getTrace()
 697    */
 698   public static function parseBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) {
 699     $ret = array();
 700     foreach ($backTrace as $trace) {
 701       $args = array();
 702       $fnName = CRM_Utils_Array::value('function', $trace);
 703       $className = isset($trace['class']) ? ($trace['class'] . $trace['type']) : '';
 704
 705       // Do not show args for a few password related functions
 706       $skipArgs = ($className == 'DB::' && $fnName == 'connect') ? TRUE : FALSE;
 707
 708       if (!empty($trace['args'])) {
 709         foreach ($trace['args'] as $arg) {
 710           if (! $showArgs || $skipArgs) {
 711             $args[] = '(' . gettype($arg) . ')';
 712             continue;
 713           }
 714           switch ($type = gettype($arg)) {
 715             case 'boolean':
 716               $args[] = $arg ? 'TRUE' : 'FALSE';
 717               break;
 718             case 'integer':
 719             case 'double':
 720               $args[] = $arg;
 721               break;
 722             case 'string':
 723               $args[] = '"' . CRM_Utils_String::ellipsify(addcslashes((string) $arg, "\r\n\t\""), $maxArgLen). '"';
 724               break;
 725             case 'array':
 726               $args[] = '(Array:'.count($arg).')';
 727               break;
 728             case 'object':
 729               $args[] = 'Object(' . get_class($arg) . ')';
 730               break;
 731             case 'resource':
 732               $args[] = 'Resource';
 733               break;
 734             case 'NULL':
 735               $args[] = 'NULL';
 736               break;
 737             default:
 738               $args[] = "($type)";
 739               break;
 740           }
 741         }
 742       }
 743
 744       $ret[] = sprintf(
 745         "%s(%s): %s%s(%s)",
 746         CRM_Utils_Array::value('file', $trace, '[internal function]'),
 747         CRM_Utils_Array::value('line', $trace, ''),
 748         $className,
 749         $fnName,
 750         implode(", ", $args)
 751       );
 752     }
 753     return $ret;
 754   }
 755
 756   /**
 757    * Render an exception as HTML string
 758    *
 759    * @param Exception $e
 760    * @return string printable HTML text
 761    */
 762   public static function formatHtmlException(Exception $e) {
 763     $msg = '';
 764
 765     // Exception metadata
 766
 767     // Exception backtrace
 768     if ($e instanceof PEAR_Exception) {
 769       $ei = $e;
 770       while (is_callable(array($ei, 'getCause'))) {
 771         if ($ei->getCause() instanceof PEAR_Error) {
 772           $msg .= '<table class="crm-db-error">';
 773           $msg .= sprintf('<thead><tr><th>%s</th><th>%s</th></tr></thead>', ts('Error Field'), ts('Error Value'));
 774           $msg .= '<tbody>';
 775           foreach (array('Type', 'Code', 'Message', 'Mode', 'UserInfo', 'DebugInfo') as $f) {
 776             $msg .= sprintf('<tr><td>%s</td><td>%s</td></tr>', $f, call_user_func(array($ei->getCause(), "get$f")));
 777     }
 778           $msg .= '</tbody></table>';
 779     }
 780         $ei = $ei->getCause();
 781   }
 782       $msg .= $e->toHtml();
 783     } else {
 784       $msg .= '<p><b>' . get_class($e) . ': "' . htmlentities($e->getMessage()) . '"</b></p>';
 785       $msg .= '<pre>' . htmlentities(self::formatBacktrace($e->getTrace())) . '</pre>';
 786     }
 787     return $msg;
 788   }
 789
 790   /**
 791    * Write details of an exception to the log
 792    *
 793    * @param Exception $e
 794    * @return string printable plain text
 795    */
 796   public static function formatTextException(Exception $e) {
 797     $msg = get_class($e) . ": \"" . $e->getMessage() . "\"\n";
 798
 799     $ei = $e;
 800     while (is_callable(array($ei, 'getCause'))) {
 801       if ($ei->getCause() instanceof PEAR_Error) {
 802         foreach (array('Type', 'Code', 'Message', 'Mode', 'UserInfo', 'DebugInfo') as $f) {
 803           $msg .= sprintf(" * ERROR %s: %s\n", strtoupper($f), call_user_func(array($ei->getCause(), "get$f")));
 804         }
 805       }
 806       $ei = $ei->getCause();
 807     }
 808     $msg .= self::formatBacktrace($e->getTrace());
 809     return $msg;
 810   }
 811
 812   /**
 813    * @param $message
 814    * @param int $code
 815    * @param string $level
 816    * @param array $params
 817    *
 818    * @return object
 819    */
 820   public static function createError($message, $code = 8000, $level = 'Fatal', $params = NULL) {
 821     $error = CRM_Core_Error::singleton();
 822     $error->push($code, $level, array($params), $message);
 823     return $error;
 824   }
 825
 826   /**
 827    * Set a status message in the session, then bounce back to the referrer.
 828    *
 829    * @param string $status The status message to set
 830    *
 831    * @param null $redirect
 832    * @param string $title
 833    * @return void
 834    * @static
 835    */
 836   public static function statusBounce($status, $redirect = NULL, $title = NULL) {
 837     $session = CRM_Core_Session::singleton();
 838     if (!$redirect) {
 839       $redirect = $session->readUserContext();
 840     }
 841     if ($title === NULL) {
 842       $title = ts('Error');
 843     }
 844     $session->setStatus($status, $title, 'alert', array('expires' => 0));
 845     if (CRM_Utils_Array::value('snippet', $_REQUEST) === CRM_Core_Smarty::PRINT_JSON) {
 846       CRM_Core_Page_AJAX::returnJsonResponse(array('status' => 'error'));
 847     }
 848     CRM_Utils_System::redirect($redirect);
 849   }
 850
 851   /**
 852    * Reset the error stack
 853    *
 854    * @static
 855    */
 856   public static function reset() {
 857     $error = self::singleton();
 858     $error->_errors = array();
 859     $error->_errorsByLevel = array();
 860   }
 861
 862   /**
 863    * PEAR error-handler which converts errors to exceptions
 864    *
 865    * @param $pearError
 866    * @throws PEAR_Exception
 867    */
 868   public static function exceptionHandler($pearError) {
 869     CRM_Core_Error::backtrace('backTrace', TRUE);
 870     throw new PEAR_Exception($pearError->getMessage(), $pearError);
 871   }
 872
 873   /**
 874    * PEAR error-handler to quietly catch otherwise fatal errors. Intended for use with smtp transport.
 875    *
 876    * @param object $obj       The PEAR_ERROR object
 877    * @return object $obj
 878    * @static
 879    */
 880   public static function nullHandler($obj) {
 881     CRM_Core_Error::debug_log_message("Ignoring exception thrown by nullHandler: {$obj->code}, {$obj->message}");
 882     CRM_Core_Error::backtrace('backTrace', TRUE);
 883     return $obj;
 884   }
 885
 886   /*
 887    * @deprecated
 888    * This function is no longer used by v3 api.
 889    * @fixme Some core files call it but it should be re-thought & renamed or removed
 890    */
 891   /**
 892    * @param $msg
 893    * @param null $data
 894    *
 895    * @return array
 896    * @throws Exception
 897    */
 898   public static function &createAPIError($msg, $data = NULL) {
 899     if (self::$modeException) {
 900       throw new Exception($msg, $data);
 901     }
 902
 903     $values = array();
 904
 905     $values['is_error'] = 1;
 906     $values['error_message'] = $msg;
 907     if (isset($data)) {
 908       $values = array_merge($values, $data);
 909     }
 910     return $values;
 911   }
 912
 913   /**
 914    * @param $file
 915    */
 916   public static function movedSiteError($file) {
 917     $url = CRM_Utils_System::url('civicrm/admin/setting/updateConfigBackend',
 918       'reset=1',
 919       TRUE
 920     );
 921     echo "We could not write $file. Have you moved your site directory or server?<p>";
 922     echo "Please fix the setting by running the <a href=\"$url\">update config script</a>";
 923     exit();
 924   }
 925
 926   /**
 927    * Terminate execution abnormally
 928    */
 929   protected static function abend($code) {
 930     // do a hard rollback of any pending transactions
 931     // if we've come here, its because of some unexpected PEAR errors
 932     CRM_Core_Transaction::forceRollbackIfEnabled();
 933     CRM_Utils_System::civiExit($code);
 934   }
 935
 936   /**
 937    * @param $error
 938    * @param const $type
 939    *
 940    * @return bool
 941    */
 942   public static function isAPIError($error, $type = CRM_Core_Error::FATAL_ERROR) {
 943     if (is_array($error) && !empty($error['is_error'])) {
 944       $code = $error['error_message']['code'];
 945       if ($code == $type) {
 946         return TRUE;
 947       }
 948     }
 949     return FALSE;
 950   }
 951 }
 952
 953 $e = new PEAR_ErrorStack('CRM');
 954 $e->singleton('CRM', FALSE, NULL, 'CRM_Core_Error');