CRM/Core/Error.php

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