3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * Start of the Error framework. We should check out and inherit from
30 * PEAR_ErrorStack and use that framework
33 * @copyright CiviCRM LLC (c) 2004-2019
36 require_once 'PEAR/ErrorStack.php';
37 require_once 'PEAR/Exception.php';
38 require_once 'CRM/Core/Exception.php';
40 require_once 'Log.php';
45 class CRM_Exception
extends PEAR_Exception
{
48 * Redefine the exception so message isn't optional.
50 * Supported signatures:
51 * - PEAR_Exception(string $message);
52 * - PEAR_Exception(string $message, int $code);
53 * - PEAR_Exception(string $message, Exception $cause);
54 * - PEAR_Exception(string $message, Exception $cause, int $code);
55 * - PEAR_Exception(string $message, PEAR_Error $cause);
56 * - PEAR_Exception(string $message, PEAR_Error $cause, int $code);
57 * - PEAR_Exception(string $message, array $causes);
58 * - PEAR_Exception(string $message, array $causes, int $code);
60 * @param string $message exception message
62 * @param Exception $previous
64 public function __construct($message = NULL, $code = 0, Exception
$previous = NULL) {
65 parent
::__construct($message, $code, $previous);
71 * Class CRM_Core_Error
73 class CRM_Core_Error
extends PEAR_ErrorStack
{
76 * Status code of various types of errors.
78 const FATAL_ERROR
= 2;
79 const DUPLICATE_CONTACT
= 8001;
80 const DUPLICATE_CONTRIBUTION
= 8002;
81 const DUPLICATE_PARTICIPANT
= 8003;
84 * We only need one instance of this object. So we use the singleton
85 * pattern and cache the instance in this variable
88 private static $_singleton = NULL;
91 * The logger object for this application.
94 private static $_log = NULL;
97 * If modeException == true, errors are raised as exception instead of returning civicrm_errors
100 public static $modeException = NULL;
103 * Singleton function used to manage this object.
105 * @param null $package
106 * @param bool $msgCallback
107 * @param bool $contextCallback
108 * @param bool $throwPEAR_Error
109 * @param string $stackClass
111 * @return CRM_Core_Error
113 public static function &singleton($package = NULL, $msgCallback = FALSE, $contextCallback = FALSE, $throwPEAR_Error = FALSE, $stackClass = 'PEAR_ErrorStack') {
114 if (self
::$_singleton === NULL) {
115 self
::$_singleton = new CRM_Core_Error('CiviCRM');
117 return self
::$_singleton;
123 public function __construct() {
124 parent
::__construct('CiviCRM');
126 $log = CRM_Core_Config
::getLog();
127 $this->setLogger($log);
129 // PEAR<=1.9.0 does not declare "static" properly.
130 if (!is_callable(['PEAR', '__callStatic'])) {
131 $this->setDefaultCallback([$this, 'handlePES']);
134 PEAR_ErrorStack
::setDefaultCallback([$this, 'handlePES']);
140 * @param string $separator
142 * @return array|null|string
144 public static function getMessages(&$error, $separator = '<br />') {
145 if (is_a($error, 'CRM_Core_Error')) {
146 $errors = $error->getErrors();
148 foreach ($errors as $e) {
149 $message[] = $e['code'] . ': ' . $e['message'];
151 $message = implode($separator, $message);
154 elseif (is_a($error, 'Civi\Payment\Exception\PaymentProcessorException')) {
155 return $error->getMessage();
161 * Status display function specific to payment processor errors.
163 * @param string $separator
165 public static function displaySessionError(&$error, $separator = '<br />') {
166 $message = self
::getMessages($error, $separator);
168 $status = ts("Payment Processor Error message") . "{$separator} $message";
169 $session = CRM_Core_Session
::singleton();
170 $session->setStatus($status);
175 * Create the main callback method. this method centralizes error processing.
177 * the errors we expect are from the pear modules DB, DB_DataObject
178 * which currently use PEAR::raiseError to notify of error messages.
180 * @param object $pearError PEAR_Error
182 public static function handle($pearError) {
183 if (defined('CIVICRM_TEST')) {
184 return self
::simpleHandler($pearError);
187 // setup smarty with config, session and template location.
188 $template = CRM_Core_Smarty
::singleton();
189 $config = CRM_Core_Config
::singleton();
191 if ($config->backtrace
) {
195 // create the error array
196 $error = self
::getErrorDetails($pearError);
198 // We access connection info via _DB_DATAOBJECT instead
199 // of, e.g., calling getDatabaseConnection(), so that we
200 // can avoid infinite loops.
201 global $_DB_DATAOBJECT;
203 if (isset($_DB_DATAOBJECT['CONFIG']['database'])) {
204 $dao = new CRM_Core_DAO();
205 if (isset($_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5
])) {
206 $conn = $_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5
];
208 // FIXME: Polymorphism for the win.
209 if ($conn instanceof DB_mysqli
) {
210 $link = $conn->connection
;
211 if (mysqli_error($link)) {
212 $mysql_error = mysqli_error($link) . ', ' . mysqli_errno($link);
213 // execute a dummy query to clear error stack
214 mysqli_query($link, 'select 1');
217 elseif ($conn instanceof DB_mysql
) {
219 $mysql_error = mysql_error() . ', ' . mysql_errno();
220 // execute a dummy query to clear error stack
221 mysql_query('select 1');
225 $mysql_error = 'fixme-unknown-db-cxn';
227 $template->assign_by_ref('mysql_code', $mysql_error);
231 $template->assign_by_ref('error', $error);
232 $errorDetails = CRM_Core_Error
::debug('', $error, FALSE);
233 $template->assign_by_ref('errorDetails', $errorDetails);
235 CRM_Core_Error
::debug_var('Fatal Error Details', $error);
236 CRM_Core_Error
::backtrace('backTrace', TRUE);
238 if ($config->initialized
) {
239 $content = $template->fetch('CRM/common/fatal.tpl');
240 echo CRM_Utils_System
::theme($content);
243 echo "Sorry. A non-recoverable error has occurred. The error trace below might help to resolve the issue<p>";
244 CRM_Core_Error
::debug(NULL, $error);
246 static $runOnce = FALSE;
255 * this function is used to trap and print errors
256 * during system initialization time. Hence the error
257 * message is quite ugly
261 public static function simpleHandler($pearError) {
263 $error = self
::getErrorDetails($pearError);
265 // ensure that debug does not check permissions since we are in bootstrap
266 // mode and need to print a decent message to help the user
267 CRM_Core_Error
::debug('Initialization Error', $error, TRUE, TRUE, FALSE);
269 // always log the backtrace to a file
270 self
::backtrace('backTrace', TRUE);
276 * this function is used to return error details
280 * @return array $error
282 public static function getErrorDetails($pearError) {
283 // create the error array
285 $error['callback'] = $pearError->getCallback();
286 $error['code'] = $pearError->getCode();
287 $error['message'] = $pearError->getMessage();
288 $error['mode'] = $pearError->getMode();
289 $error['debug_info'] = $pearError->getDebugInfo();
290 $error['type'] = $pearError->getType();
291 $error['user_info'] = $pearError->getUserInfo();
292 $error['to_string'] = $pearError->toString();
298 * Handle errors raised using the PEAR Error Stack.
300 * currently the handler just requests the PES framework
301 * to push the error to the stack (return value PEAR_ERRORSTACK_PUSH).
303 * Note: we can do our own error handling here and return PEAR_ERRORSTACK_IGNORE.
305 * Also, if we do not return any value the PEAR_ErrorStack::push() then does the
306 * action of PEAR_ERRORSTACK_PUSHANDLOG which displays the errors on the screen,
307 * since the logger set for this error stack is 'display' - see CRM_Core_Config::getLog();
309 * @param mixed $pearError
313 public static function handlePES($pearError) {
314 return PEAR_ERRORSTACK_PUSH
;
318 * Display an error page with an error message describing what happened.
321 * This is a really annoying function. We ❤ exceptions. Be exceptional!
325 * @param string $message
327 * @param string $code
328 * The error code if any.
329 * @param string $email
330 * The email address to notify of this situation.
334 public static function fatal($message = NULL, $code = NULL, $email = NULL) {
336 'message' => $message,
340 if (self
::$modeException) {
342 CRM_Core_Error
::debug_var('Fatal Error Details', $vars);
343 CRM_Core_Error
::backtrace('backTrace', TRUE);
345 $details = 'A fatal error was triggered';
347 $details .= ': ' . $message;
349 throw new Exception($details, $code);
353 $message = ts('We experienced an unexpected error. You may have found a bug. For more information on how to provide a bug report, please read: %1', [1 => 'https://civicrm.org/bug-reporting']);
356 if (php_sapi_name() == "cli") {
357 print ("Sorry. A non-recoverable error has occurred.\n$message \n$code\n$email\n\n");
359 echo static::formatBacktrace(debug_backtrace());
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);
366 $config = CRM_Core_Config
::singleton();
368 if ($config->fatalErrorHandler
&&
369 function_exists($config->fatalErrorHandler
)
371 $name = $config->fatalErrorHandler
;
374 // the call has been successfully handled
376 self
::abend(CRM_Core_Error
::FATAL_ERROR
);
380 if ($config->backtrace
) {
384 CRM_Core_Error
::debug_var('Fatal Error Details', $vars);
385 CRM_Core_Error
::backtrace('backTrace', TRUE);
387 // If we are in an ajax callback, format output appropriately
388 if (CRM_Utils_Array
::value('snippet', $_REQUEST) === CRM_Core_Smarty
::PRINT_JSON
) {
391 '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>',
393 if ($config->backtrace
&& CRM_Core_Permission
::check('view debug output')) {
394 $out['backtrace'] = self
::parseBacktrace(debug_backtrace());
395 $message .= '<p><em>See console for backtrace</em></p>';
397 CRM_Core_Session
::setStatus($message, ts('Sorry an error occurred'), 'error');
398 CRM_Core_Transaction
::forceRollbackIfEnabled();
399 CRM_Core_Page_AJAX
::returnJsonResponse($out);
402 $template = CRM_Core_Smarty
::singleton();
403 $template->assign($vars);
404 $config->userSystem
->outputError($template->fetch('CRM/common/fatal.tpl'));
406 self
::abend(CRM_Core_Error
::FATAL_ERROR
);
410 * Display an error page with an error message describing what happened.
412 * This function is evil -- it largely replicates fatal(). Hopefully the
413 * entire CRM_Core_Error system can be hollowed out and replaced with
414 * something that follows a cleaner separation of concerns.
416 * @param Exception $exception
418 public static function handleUnhandledException($exception) {
420 CRM_Utils_Hook
::unhandledException($exception);
422 catch (Exception
$other) {
423 // if the exception-handler generates an exception, then that sucks! oh, well. carry on.
424 CRM_Core_Error
::debug_var('handleUnhandledException_nestedException', self
::formatTextException($other));
426 $config = CRM_Core_Config
::singleton();
428 'message' => $exception->getMessage(),
430 'exception' => $exception,
432 if (!$vars['message']) {
433 $vars['message'] = ts('We experienced an unexpected error. You may have found a bug. For more information on how to provide a bug report, please read: %1', [1 => 'https://civicrm.org/bug-reporting']);
437 if (php_sapi_name() == "cli") {
438 printf("Sorry. A non-recoverable error has occurred.\n%s\n", $vars['message']);
439 print self
::formatTextException($exception);
441 // FIXME: Why doesn't this call abend()?
442 // Difference: abend() will cleanup transaction and (via civiExit) store session state
443 // self::abend(CRM_Core_Error::FATAL_ERROR);
446 // Case B: Custom error handler
447 if ($config->fatalErrorHandler
&&
448 function_exists($config->fatalErrorHandler
)
450 $name = $config->fatalErrorHandler
;
453 // the call has been successfully handled
455 self
::abend(CRM_Core_Error
::FATAL_ERROR
);
459 // Case C: Default error handler
462 CRM_Core_Error
::debug_var('Fatal Error Details', $vars, FALSE);
463 CRM_Core_Error
::backtrace('backTrace', TRUE);
466 $template = CRM_Core_Smarty
::singleton();
467 $template->assign($vars);
468 $content = $template->fetch('CRM/common/fatal.tpl');
469 if ($config->backtrace
) {
470 $content = self
::formatHtmlException($exception) . $content;
472 if ($config->userFramework
== 'Joomla' &&
473 class_exists('JError')
475 JError
::raiseError('CiviCRM-001', $content);
478 echo CRM_Utils_System
::theme($content);
482 self
::abend(CRM_Core_Error
::FATAL_ERROR
);
486 * Outputs pre-formatted debug information. Flushes the buffers
487 * so we can interrupt a potential POST/redirect
489 * @param string $name name of debug section
490 * @param $variable mixed reference to variables that we need a trace of
491 * @param bool $log should we log or return the output
492 * @param bool $html whether to generate a HTML-escaped output
493 * @param bool $checkPermission should we check permissions before displaying output
494 * useful when we die during initialization and permissioning
495 * subsystem is not initialized - CRM-13765
498 * the generated output
500 public static function debug($name, $variable = NULL, $log = TRUE, $html = TRUE, $checkPermission = TRUE) {
501 $error = self
::singleton();
503 if ($variable === NULL) {
508 $out = print_r($variable, TRUE);
511 $out = htmlspecialchars($out);
513 $prefix = "<p>$name</p>";
515 $out = "{$prefix}<p><pre>$out</pre></p><p></p>";
519 $prefix = "$name:\n";
521 $out = "{$prefix}$out\n";
525 (!$checkPermission || CRM_Core_Permission
::check('view debug output'))
534 * Similar to the function debug. Only difference is
535 * in the formatting of the output.
537 * @param string $variable_name
539 * @param mixed $variable
542 * Use print_r (if true) or var_dump (if false).
544 * Log or return the output?
545 * @param string $prefix
546 * Prefix for output logfile.
549 * The generated output
551 * @see CRM_Core_Error::debug()
552 * @see CRM_Core_Error::debug_log_message()
554 public static function debug_var($variable_name, $variable, $print = TRUE, $log = TRUE, $prefix = '') {
555 // check if variable is set
556 if (!isset($variable)) {
557 $out = "\$$variable_name is not set";
561 $out = print_r($variable, TRUE);
562 $out = "\$$variable_name = $out";
568 $dump = ob_get_contents();
570 $out = "\n\$$variable_name = $dump";
572 // reset if it is an array
573 if (is_array($variable)) {
577 return self
::debug_log_message($out, FALSE, $prefix);
581 * Display the error message on terminal and append it to the log file.
583 * Provided the user has the 'view debug output' the output should be displayed. In all
584 * cases it should be logged.
586 * @param string $message
588 * Should we log or return the output.
590 * @param string $prefix
592 * @param string $priority
595 * Format of the backtrace
597 public static function debug_log_message($message, $out = FALSE, $prefix = '', $priority = NULL) {
598 $config = CRM_Core_Config
::singleton();
600 $file_log = self
::createDebugLogger($prefix);
601 $file_log->log("$message\n", $priority);
603 $str = '<p/><code>' . htmlspecialchars($message) . '</code>';
604 if ($out && CRM_Core_Permission
::check('view debug output')) {
609 if (!isset(\Civi
::$statics[__CLASS__
]['userFrameworkLogging'])) {
610 // Set it to FALSE first & then try to set it. This is to prevent a loop as calling
611 // $config->userFrameworkLogging can trigger DB queries & under log mode this
612 // then gets called again.
613 \Civi
::$statics[__CLASS__
]['userFrameworkLogging'] = FALSE;
614 \Civi
::$statics[__CLASS__
]['userFrameworkLogging'] = $config->userFrameworkLogging
;
617 if (!empty(\Civi
::$statics[__CLASS__
]['userFrameworkLogging'])) {
618 // should call $config->userSystem->logger($message) here - but I got a situation where userSystem was not an object - not sure why
619 if ($config->userSystem
->is_drupal
and function_exists('watchdog')) {
620 watchdog('civicrm', '%message', ['%message' => $message], isset($priority) ?
$priority : WATCHDOG_DEBUG
);
628 * Append to the query log (if enabled)
630 * @param string $string
632 public static function debug_query($string) {
633 if (defined('CIVICRM_DEBUG_LOG_QUERY')) {
634 if (CIVICRM_DEBUG_LOG_QUERY
=== 'backtrace') {
635 CRM_Core_Error
::backtrace($string, TRUE);
637 elseif (CIVICRM_DEBUG_LOG_QUERY
) {
638 CRM_Core_Error
::debug_var('Query', $string, TRUE, TRUE, 'sql_log');
644 * Execute a query and log the results.
646 * @param string $query
648 public static function debug_query_result($query) {
649 $results = CRM_Core_DAO
::executeQuery($query)->fetchAll();
650 CRM_Core_Error
::debug_var('dao result', ['query' => $query, 'results' => $results]);
654 * Obtain a reference to the error log.
656 * @param string $prefix
660 public static function createDebugLogger($prefix = '') {
661 self
::generateLogFileName($prefix);
662 return Log
::singleton('file', \Civi
::$statics[__CLASS__
]['logger_file' . $prefix], '');
666 * Generate a hash for the logfile.
670 * @param CRM_Core_Config $config
674 public static function generateLogFileHash($config) {
675 // Use multiple (but stable) inputs for hash information.
677 defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY
: 'NO_SITE_KEY',
678 $config->userFrameworkBaseURL
,
682 // Trim 8 chars off the string, make it slightly easier to find
683 // but reveals less information from the hash.
684 return substr(md5(var_export($md5inputs, 1)), 8);
688 * Generate the name of the logfile to use and store it as a static.
690 * This function includes simplistic log rotation and a check as to whether
693 * @param string $prefix
695 protected static function generateLogFileName($prefix) {
696 if (!isset(\Civi
::$statics[__CLASS__
]['logger_file' . $prefix])) {
697 $config = CRM_Core_Config
::singleton();
699 $prefixString = $prefix ?
($prefix . '.') : '';
701 $hash = self
::generateLogFileHash($config);
702 $fileName = $config->configAndLogDir
. 'CiviCRM.' . $prefixString . $hash . '.log';
704 // Roll log file monthly or if greater than 256M.
705 // Size-based rotation introduced in response to filesize limits on
706 // certain OS/PHP combos.
707 if (file_exists($fileName)) {
708 $fileTime = date("Ym", filemtime($fileName));
709 $fileSize = filesize($fileName);
710 if (($fileTime < date('Ym')) ||
711 ($fileSize > 256 * 1024 * 1024) ||
715 $fileName . '.' . date('YmdHi')
719 \Civi
::$statics[__CLASS__
]['logger_file' . $prefix] = $fileName;
727 public static function backtrace($msg = 'backTrace', $log = FALSE) {
728 $backTrace = debug_backtrace();
729 $message = self
::formatBacktrace($backTrace);
731 CRM_Core_Error
::debug($msg, $message);
734 CRM_Core_Error
::debug_var($msg, $message);
739 * Render a backtrace array as a string.
741 * @param array $backTrace
742 * Array of stack frames.
743 * @param bool $showArgs
744 * 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.
745 * @param int $maxArgLen
746 * Maximum number of characters to show from each argument string.
748 * printable plain-text
750 public static function formatBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) {
752 foreach (self
::parseBacktrace($backTrace, $showArgs, $maxArgLen) as $idx => $trace) {
753 $message .= sprintf("#%s %s\n", $idx, $trace);
755 $message .= sprintf("#%s {main}\n", 1 +
$idx);
760 * Render a backtrace array as an array.
762 * @param array $backTrace
763 * Array of stack frames.
764 * @param bool $showArgs
765 * 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.
766 * @param int $maxArgLen
767 * Maximum number of characters to show from each argument string.
769 * @see debug_backtrace
770 * @see Exception::getTrace()
772 public static function parseBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) {
774 foreach ($backTrace as $trace) {
776 $fnName = CRM_Utils_Array
::value('function', $trace);
777 $className = isset($trace['class']) ?
($trace['class'] . $trace['type']) : '';
779 // Do not show args for a few password related functions
780 $skipArgs = ($className == 'DB::' && $fnName == 'connect') ?
TRUE : FALSE;
782 if (!empty($trace['args'])) {
783 foreach ($trace['args'] as $arg) {
784 if (!$showArgs ||
$skipArgs) {
785 $args[] = '(' . gettype($arg) . ')';
788 switch ($type = gettype($arg)) {
790 $args[] = $arg ?
'TRUE' : 'FALSE';
799 $args[] = '"' . CRM_Utils_String
::ellipsify(addcslashes((string) $arg, "\r\n\t\""), $maxArgLen) . '"';
803 $args[] = '(Array:' . count($arg) . ')';
807 $args[] = 'Object(' . get_class($arg) . ')';
811 $args[] = 'Resource';
827 CRM_Utils_Array
::value('file', $trace, '[internal function]'),
828 CRM_Utils_Array
::value('line', $trace, ''),
838 * Render an exception as HTML string.
840 * @param Exception $e
842 * printable HTML text
844 public static function formatHtmlException(Exception
$e) {
847 // Exception metadata
849 // Exception backtrace
850 if ($e instanceof PEAR_Exception
) {
852 while (is_callable([$ei, 'getCause'])) {
853 if ($ei->getCause() instanceof PEAR_Error
) {
854 $msg .= '<table class="crm-db-error">';
855 $msg .= sprintf('<thead><tr><th>%s</th><th>%s</th></tr></thead>', ts('Error Field'), ts('Error Value'));
857 foreach (['Type', 'Code', 'Message', 'Mode', 'UserInfo', 'DebugInfo'] as $f) {
858 $msg .= sprintf('<tr><td>%s</td><td>%s</td></tr>', $f, call_user_func([$ei->getCause(), "get$f"]));
860 $msg .= '</tbody></table>';
862 $ei = $ei->getCause();
864 $msg .= $e->toHtml();
867 $msg .= '<p><b>' . get_class($e) . ': "' . htmlentities($e->getMessage()) . '"</b></p>';
868 $msg .= '<pre>' . htmlentities(self
::formatBacktrace($e->getTrace())) . '</pre>';
874 * Write details of an exception to the log.
876 * @param Exception $e
878 * printable plain text
880 public static function formatTextException(Exception
$e) {
881 $msg = get_class($e) . ": \"" . $e->getMessage() . "\"\n";
884 while (is_callable([$ei, 'getCause'])) {
885 if ($ei->getCause() instanceof PEAR_Error
) {
886 foreach (['Type', 'Code', 'Message', 'Mode', 'UserInfo', 'DebugInfo'] as $f) {
887 $msg .= sprintf(" * ERROR %s: %s\n", strtoupper($f), call_user_func([$ei->getCause(), "get$f"]));
890 $ei = $ei->getCause();
892 $msg .= self
::formatBacktrace($e->getTrace());
899 * @param string $level
900 * @param array $params
904 public static function createError($message, $code = 8000, $level = 'Fatal', $params = NULL) {
905 $error = CRM_Core_Error
::singleton();
906 $error->push($code, $level, [$params], $message);
911 * Set a status message in the session, then bounce back to the referrer.
913 * @param string $status
914 * The status message to set.
916 * @param null $redirect
917 * @param string $title
919 public static function statusBounce($status, $redirect = NULL, $title = NULL) {
920 $session = CRM_Core_Session
::singleton();
922 $redirect = $session->readUserContext();
924 if ($title === NULL) {
925 $title = ts('Error');
927 $session->setStatus($status, $title, 'alert', ['expires' => 0]);
928 if (CRM_Utils_Array
::value('snippet', $_REQUEST) === CRM_Core_Smarty
::PRINT_JSON
) {
929 CRM_Core_Page_AJAX
::returnJsonResponse(['status' => 'error']);
931 CRM_Utils_System
::redirect($redirect);
935 * Reset the error stack.
938 public static function reset() {
939 $error = self
::singleton();
940 $error->_errors
= [];
941 $error->_errorsByLevel
= [];
945 * PEAR error-handler which converts errors to exceptions
948 * @throws PEAR_Exception
950 public static function exceptionHandler($pearError) {
951 CRM_Core_Error
::debug_var('Fatal Error Details', self
::getErrorDetails($pearError));
952 CRM_Core_Error
::backtrace('backTrace', TRUE);
953 throw new PEAR_Exception($pearError->getMessage(), $pearError);
957 * PEAR error-handler to quietly catch otherwise fatal errors. Intended for use with smtp transport.
960 * The PEAR_ERROR object.
964 public static function nullHandler($obj) {
965 CRM_Core_Error
::debug_log_message("Ignoring exception thrown by nullHandler: {$obj->code}, {$obj->message}");
966 CRM_Core_Error
::backtrace('backTrace', TRUE);
972 * This function is no longer used by v3 api.
973 * @fixme Some core files call it but it should be re-thought & renamed or removed
981 public static function &createAPIError($msg, $data = NULL) {
982 if (self
::$modeException) {
983 throw new Exception($msg, $data);
988 $values['is_error'] = 1;
989 $values['error_message'] = $msg;
991 $values = array_merge($values, $data);
999 public static function movedSiteError($file) {
1000 $url = CRM_Utils_System
::url('civicrm/admin/setting/updateConfigBackend',
1004 echo "We could not write $file. Have you moved your site directory or server?<p>";
1005 echo "Please fix the setting by running the <a href=\"$url\">update config script</a>";
1010 * Terminate execution abnormally.
1012 * @param string $code
1014 protected static function abend($code) {
1015 // do a hard rollback of any pending transactions
1016 // if we've come here, its because of some unexpected PEAR errors
1017 CRM_Core_Transaction
::forceRollbackIfEnabled();
1018 CRM_Utils_System
::civiExit($code);
1022 * @param array $error
1027 public static function isAPIError($error, $type = CRM_Core_Error
::FATAL_ERROR
) {
1028 if (is_array($error) && !empty($error['is_error'])) {
1029 $code = $error['error_message']['code'];
1030 if ($code == $type) {
1038 * Output a deprecated function warning to log file. Deprecated class:function is automatically generated from calling function.
1041 * description of new method (eg. "buildOptions() method in the appropriate BAO object").
1043 public static function deprecatedFunctionWarning($newMethod) {
1044 $dbt = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS
, 2);
1045 $callerFunction = isset($dbt[1]['function']) ?
$dbt[1]['function'] : NULL;
1046 $callerClass = isset($dbt[1]['class']) ?
$dbt[1]['class'] : NULL;
1047 Civi
::log()->warning("Deprecated function $callerClass::$callerFunction, use $newMethod.", ['civi.tag' => 'deprecated']);
1052 $e = new PEAR_ErrorStack('CRM');
1053 $e->singleton('CRM', FALSE, NULL, 'CRM_Core_Error');