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') {
 323       // JErrorPage exists only in 3.1.x
 324       // a bit ugly hack, but want this in for 4.4.1
 325       // CRM-13714
 326       if (class_exists('JError') && !class_exists('JErrorPage')) {
 327         JError::raiseError('CiviCRM-001', $content);
 328       }
 329       else {
 330         echo CRM_Utils_System::theme($content);
 331       }
 332     }
 333
 334     self::abend(CRM_Core_Error::FATAL_ERROR);
 335   }
 336
 337   /**
 338    * display an error page with an error message describing what happened
 339    *
 340    * This function is evil -- it largely replicates fatal(). Hopefully the
 341    * entire CRM_Core_Error system can be hollowed out and replaced with
 342    * something that follows a cleaner separation of concerns.
 343    *
 344    * @param Exception $exception
 345    *
 346    * @return void
 347    * @static
 348    * @acess public
 349    */
 350   static function handleUnhandledException($exception) {
 351     $config = CRM_Core_Config::singleton();
 352     $vars = array(
 353       'message' => $exception->getMessage(),
 354       'code' => NULL,
 355       'exception' => $exception,
 356     );
 357     if (!$vars['message']) {
 358       $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/'));
 359     }
 360
 361     // Case A: CLI
 362     if (php_sapi_name() == "cli") {
 363       printf("Sorry. A non-recoverable error has occurred.\n%s\n", $vars['message']);
 364       print self::formatTextException($exception);
 365       die("\n");
 366       // FIXME: Why doesn't this call abend()?
 367       // Difference: abend() will cleanup transaction and (via civiExit) store session state
 368       // self::abend(CRM_Core_Error::FATAL_ERROR);
 369     }
 370
 371     // Case B: Custom error handler
 372     if ($config->fatalErrorHandler &&
 373       function_exists($config->fatalErrorHandler)
 374     ) {
 375       $name = $config->fatalErrorHandler;
 376       $ret = $name($vars);
 377       if ($ret) {
 378         // the call has been successfully handled
 379         // so we just exit
 380         self::abend(CRM_Core_Error::FATAL_ERROR);
 381       }
 382     }
 383
 384     // Case C: Default error handler
 385
 386     // log to file
 387     CRM_Core_Error::debug_var('Fatal Error Details', $vars);
 388     CRM_Core_Error::backtrace('backTrace', TRUE);
 389
 390     // print to screen
 391     $template = CRM_Core_Smarty::singleton();
 392     $template->assign($vars);
 393     $content = $template->fetch($config->fatalErrorTemplate);
 394     if ($config->backtrace) {
 395       $content = self::formatHtmlException($exception) . $content;
 396     }
 397     if ($config->userFramework == 'Joomla' &&
 398       class_exists('JError')
 399     ) {
 400       JError::raiseError('CiviCRM-001', $content);
 401     }
 402     else {
 403       echo CRM_Utils_System::theme($content);
 404     }
 405
 406     // fin
 407     self::abend(CRM_Core_Error::FATAL_ERROR);
 408   }
 409
 410   /**
 411    * outputs pre-formatted debug information. Flushes the buffers
 412    * so we can interrupt a potential POST/redirect
 413    *
 414    * @param  string name of debug section
 415    * @param  mixed  reference to variables that we need a trace of
 416    * @param  bool   should we log or return the output
 417    * @param  bool   whether to generate a HTML-escaped output
 418    *
 419    * @return string the generated output
 420    * @access public
 421    * @static
 422    */
 423   static function debug($name, $variable = NULL, $log = TRUE, $html = TRUE) {
 424     $error = self::singleton();
 425
 426     if ($variable === NULL) {
 427       $variable = $name;
 428       $name = NULL;
 429     }
 430
 431     $out = print_r($variable, TRUE);
 432     $prefix = NULL;
 433     if ($html) {
 434       $out = htmlspecialchars($out);
 435       if ($name) {
 436         $prefix = "<p>$name</p>";
 437       }
 438       $out = "{$prefix}<p><pre>$out</pre></p><p></p>";
 439     }
 440     else {
 441       if ($name) {
 442         $prefix = "$name:\n";
 443       }
 444       $out = "{$prefix}$out\n";
 445     }
 446     if ($log && CRM_Core_Permission::check('view debug output')) {
 447       echo $out;
 448     }
 449
 450     return $out;
 451   }
 452
 453   /**
 454    * Similar to the function debug. Only difference is
 455    * in the formatting of the output.
 456    *
 457    * @param  string variable name
 458    * @param  mixed  reference to variables that we need a trace of
 459    * @param  bool   should we use print_r ? (else we use var_dump)
 460    * @param  bool   should we log or return the output
 461    *
 462    * @return string the generated output
 463    *
 464    * @access public
 465    *
 466    * @static
 467    *
 468    * @see CRM_Core_Error::debug()
 469    * @see CRM_Core_Error::debug_log_message()
 470    */
 471   static function debug_var($variable_name,
 472     $variable,
 473     $print = TRUE,
 474     $log   = TRUE,
 475     $comp  = ''
 476   ) {
 477     // check if variable is set
 478     if (!isset($variable)) {
 479       $out = "\$$variable_name is not set";
 480     }
 481     else {
 482       if ($print) {
 483         $out = print_r($variable, TRUE);
 484         $out = "\$$variable_name = $out";
 485       }
 486       else {
 487         // use var_dump
 488         ob_start();
 489         var_dump($variable);
 490         $dump = ob_get_contents();
 491         ob_end_clean();
 492         $out = "\n\$$variable_name = $dump";
 493       }
 494       // reset if it is an array
 495       if (is_array($variable)) {
 496         reset($variable);
 497       }
 498     }
 499     return self::debug_log_message($out, FALSE, $comp);
 500   }
 501
 502   /**
 503    * display the error message on terminal
 504    *
 505    * @param  string message to be output
 506    * @param  bool   should we log or return the output
 507    *
 508    * @return string format of the backtrace
 509    *
 510    * @access public
 511    *
 512    * @static
 513    */
 514   static function debug_log_message($message, $out = FALSE, $comp = '') {
 515     $config = CRM_Core_Config::singleton();
 516
 517     $file_log = self::createDebugLogger($comp);
 518     $file_log->log("$message\n");
 519     $str = "<p/><code>$message</code>";
 520     if ($out && CRM_Core_Permission::check('view debug output')) {
 521       echo $str;
 522     }
 523     $file_log->close();
 524
 525     if ($config->userFrameworkLogging) {
 526       if ($config->userSystem->is_drupal and function_exists('watchdog')) {
 527         watchdog('civicrm', $message, NULL, WATCHDOG_DEBUG);
 528       }
 529     }
 530
 531     return $str;
 532   }
 533
 534   /**
 535    * Append to the query log (if enabled)
 536    */
 537   static function debug_query($string) {
 538     if ( defined( 'CIVICRM_DEBUG_LOG_QUERY' ) ) {
 539       if ( CIVICRM_DEBUG_LOG_QUERY == 'backtrace' ) {
 540         CRM_Core_Error::backtrace( $string, true );
 541       } else if ( CIVICRM_DEBUG_LOG_QUERY ) {
 542         CRM_Core_Error::debug_var( 'Query', $string, false, true );
 543       }
 544     }
 545   }
 546
 547   /**
 548    * Obtain a reference to the error log
 549    *
 550    * @return Log
 551    */
 552   static function createDebugLogger($comp = '') {
 553     $config = CRM_Core_Config::singleton();
 554
 555     if ($comp) {
 556       $comp = $comp . '.';
 557     }
 558
 559     $fileName = "{$config->configAndLogDir}CiviCRM." . $comp . md5($config->dsn) . '.log';
 560
 561     // Roll log file monthly or if greater than 256M
 562     // note that PHP file functions have a limit of 2G and hence
 563     // the alternative was introduce
 564     if (file_exists($fileName)) {
 565       $fileTime = date("Ym", filemtime($fileName));
 566       $fileSize = filesize($fileName);
 567       if (($fileTime < date('Ym')) ||
 568         ($fileSize > 256 * 1024 * 1024) ||
 569         ($fileSize < 0)
 570       ) {
 571         rename($fileName,
 572           $fileName . '.' . date('Ymdhs', mktime(0, 0, 0, date("m") - 1, date("d"), date("Y")))
 573         );
 574       }
 575     }
 576
 577     return Log::singleton('file', $fileName);
 578   }
 579
 580   static function backtrace($msg = 'backTrace', $log = FALSE) {
 581     $backTrace = debug_backtrace();
 582     $message = self::formatBacktrace($backTrace);
 583     if (!$log) {
 584       CRM_Core_Error::debug($msg, $message);
 585     }
 586     else {
 587       CRM_Core_Error::debug_var($msg, $message);
 588     }
 589   }
 590
 591   /**
 592    * Render a backtrace array as a string
 593    *
 594    * @param array $backTrace array of stack frames
 595    * @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
 596    * @param int $maxArgLen maximum number of characters to show from each argument string
 597    * @return string printable plain-text
 598    * @see debug_backtrace
 599    * @see Exception::getTrace()
 600    */
 601   static function formatBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) {
 602     $message = '';
 603     foreach ($backTrace as $idx => $trace) {
 604       $args = array();
 605       $fnName = CRM_Utils_Array::value('function', $trace);
 606       $className = array_key_exists('class', $trace) ? ($trace['class'] . $trace['type']) : '';
 607
 608       // do now show args for a few password related functions
 609       $skipArgs = ($className == 'DB::' && $fnName == 'connect') ? TRUE : FALSE;
 610
 611       foreach ($trace['args'] as $arg) {
 612         if (! $showArgs || $skipArgs) {
 613           $args[] = '(' . gettype($arg) . ')';
 614           continue;
 615         }
 616         switch ($type = gettype($arg)) {
 617           case 'boolean':
 618             $args[] = $arg ? 'TRUE' : 'FALSE';
 619             break;
 620           case 'integer':
 621           case 'double':
 622             $args[] = $arg;
 623             break;
 624           case 'string':
 625             $args[] = '"' . CRM_Utils_String::ellipsify(addcslashes((string) $arg, "\r\n\t\""), $maxArgLen). '"';
 626             break;
 627           case 'array':
 628             $args[] = '(Array:'.count($arg).')';
 629             break;
 630           case 'object':
 631             $args[] = 'Object(' . get_class($arg) . ')';
 632             break;
 633           case 'resource':
 634             $args[] = 'Resource';
 635             break;
 636           case 'NULL':
 637             $args[] = 'NULL';
 638             break;
 639           default:
 640             $args[] = "($type)";
 641             break;
 642         }
 643       }
 644
 645       $message .= sprintf(
 646         "#%s %s(%s): %s%s(%s)\n",
 647         $idx,
 648         CRM_Utils_Array::value('file', $trace, '[internal function]'),
 649         CRM_Utils_Array::value('line', $trace, ''),
 650         $className,
 651         $fnName,
 652         implode(", ", $args)
 653       );
 654     }
 655     $message .= sprintf("#%s {main}\n", 1+$idx);
 656     return $message;
 657   }
 658
 659   /**
 660    * Render an exception as HTML string
 661    *
 662    * @param Exception $e
 663    * @return string printable HTML text
 664    */
 665   static function formatHtmlException(Exception $e) {
 666     $msg = '';
 667
 668     // Exception metadata
 669
 670     // Exception backtrace
 671     if ($e instanceof PEAR_Exception) {
 672       $ei = $e;
 673       while (is_callable(array($ei, 'getCause'))) {
 674         if ($ei->getCause() instanceof PEAR_Error) {
 675           $msg .= '<table class="crm-db-error">';
 676           $msg .= sprintf('<thead><tr><th>%s</th><th>%s</th></tr></thead>', ts('Error Field'), ts('Error Value'));
 677           $msg .= '<tbody>';
 678           foreach (array('Type', 'Code', 'Message', 'Mode', 'UserInfo', 'DebugInfo') as $f) {
 679             $msg .= sprintf('<tr><td>%s</td><td>%s</td></tr>', $f, call_user_func(array($ei->getCause(), "get$f")));
 680     }
 681           $msg .= '</tbody></table>';
 682     }
 683         $ei = $ei->getCause();
 684   }
 685       $msg .= $e->toHtml();
 686     } else {
 687       $msg .= '<p><b>' . get_class($e) . ': "' . htmlentities($e->getMessage()) . '"</b></p>';
 688       $msg .= '<pre>' . htmlentities(self::formatBacktrace($e->getTrace())) . '</pre>';
 689     }
 690     return $msg;
 691   }
 692
 693   /**
 694    * Write details of an exception to the log
 695    *
 696    * @param Exception $e
 697    * @return string printable plain text
 698    */
 699   static function formatTextException(Exception $e) {
 700     $msg = get_class($e) . ": \"" . $e->getMessage() . "\"\n";
 701
 702     $ei = $e;
 703     while (is_callable(array($ei, 'getCause'))) {
 704       if ($ei->getCause() instanceof PEAR_Error) {
 705         foreach (array('Type', 'Code', 'Message', 'Mode', 'UserInfo', 'DebugInfo') as $f) {
 706           $msg .= sprintf(" * ERROR %s: %s\n", strtoupper($f), call_user_func(array($ei->getCause(), "get$f")));
 707         }
 708       }
 709       $ei = $ei->getCause();
 710     }
 711     $msg .= self::formatBacktrace($e->getTrace());
 712     return $msg;
 713   }
 714
 715   static function createError($message, $code = 8000, $level = 'Fatal', $params = NULL) {
 716     $error = CRM_Core_Error::singleton();
 717     $error->push($code, $level, array($params), $message);
 718     return $error;
 719   }
 720
 721   /**
 722    * Set a status message in the session, then bounce back to the referrer.
 723    *
 724    * @param string $status        The status message to set
 725    *
 726    * @return void
 727    * @access public
 728    * @static
 729    */
 730   public static function statusBounce($status, $redirect = NULL, $title = '') {
 731     $session = CRM_Core_Session::singleton();
 732     if (!$redirect) {
 733       $redirect = $session->readUserContext();
 734     }
 735     $session->setStatus($status, $title);
 736     CRM_Utils_System::redirect($redirect);
 737   }
 738
 739   /**
 740    * Function to reset the error stack
 741    *
 742    * @access public
 743    * @static
 744    */
 745   public static function reset() {
 746     $error = self::singleton();
 747     $error->_errors = array();
 748     $error->_errorsByLevel = array();
 749   }
 750
 751   public static function ignoreException($callback = NULL) {
 752     if (!$callback) {
 753       $callback = array('CRM_Core_Error', 'nullHandler');
 754     }
 755
 756     $GLOBALS['_PEAR_default_error_mode'] = PEAR_ERROR_CALLBACK;
 757     $GLOBALS['_PEAR_default_error_options'] = $callback;
 758   }
 759
 760   public static function exceptionHandler($pearError) {
 761     CRM_Core_Error::backtrace('backTrace', TRUE);
 762     throw new PEAR_Exception($pearError->getMessage(), $pearError);
 763   }
 764
 765   /**
 766    * Error handler to quietly catch otherwise fatal smtp transport errors.
 767    *
 768    * @param object $obj       The PEAR_ERROR object
 769    *
 770    * @return object $obj
 771    * @access public
 772    * @static
 773    */
 774   public static function nullHandler($obj) {
 775     CRM_Core_Error::debug_log_message("Ignoring exception thrown by nullHandler: {$obj->code}, {$obj->message}");
 776     CRM_Core_Error::backtrace('backTrace', TRUE);
 777     return $obj;
 778   }
 779
 780   /**
 781    * (Re)set the default callback method
 782    *
 783    * @return void
 784    * @access public
 785    * @static
 786    */
 787   public static function setCallback($callback = NULL) {
 788     if (!$callback) {
 789       $callback = array('CRM_Core_Error', 'handle');
 790     }
 791     $GLOBALS['_PEAR_default_error_mode'] = PEAR_ERROR_CALLBACK;
 792     $GLOBALS['_PEAR_default_error_options'] = $callback;
 793   }
 794
 795   /*
 796    * @deprecated
 797    * This function is no longer used by v3 api.
 798    * @fixme Some core files call it but it should be re-thought & renamed or removed
 799    */
 800   public static function &createAPIError($msg, $data = NULL) {
 801     if (self::$modeException) {
 802       throw new Exception($msg, $data);
 803     }
 804
 805     $values = array();
 806
 807     $values['is_error'] = 1;
 808     $values['error_message'] = $msg;
 809     if (isset($data)) {
 810       $values = array_merge($values, $data);
 811     }
 812     return $values;
 813   }
 814
 815   public static function movedSiteError($file) {
 816     $url = CRM_Utils_System::url('civicrm/admin/setting/updateConfigBackend',
 817       'reset=1',
 818       TRUE
 819     );
 820     echo "We could not write $file. Have you moved your site directory or server?<p>";
 821     echo "Please fix the setting by running the <a href=\"$url\">update config script</a>";
 822     exit();
 823   }
 824
 825   /**
 826    * Terminate execution abnormally
 827    */
 828   protected static function abend($code) {
 829     // do a hard rollback of any pending transactions
 830     // if we've come here, its because of some unexpected PEAR errors
 831     CRM_Core_Transaction::forceRollbackIfEnabled();
 832     CRM_Utils_System::civiExit($code);
 833   }
 834
 835   public static function isAPIError($error, $type = CRM_Core_Error::FATAL_ERROR) {
 836     if (is_array($error) && CRM_Utils_Array::value('is_error', $error)) {
 837       $code = $error['error_message']['code'];
 838       if ($code == $type) {
 839         return TRUE;
 840       }
 841     }
 842     return FALSE;
 843   }
 844 }
 845
 846 $e = new PEAR_ErrorStack('CRM');
 847 $e->singleton('CRM', FALSE, NULL, 'CRM_Core_Error');