3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
13 * Start of the Error framework. We should check out and inherit from
14 * PEAR_ErrorStack and use that framework
17 * @copyright CiviCRM LLC https://civicrm.org/licensing
20 require_once 'PEAR/ErrorStack.php';
21 require_once 'PEAR/Exception.php';
22 require_once 'CRM/Core/Exception.php';
24 require_once 'Log.php';
27 * Class CRM_Core_Error
29 class CRM_Core_Error
extends PEAR_ErrorStack
{
32 * Status code of various types of errors.
34 const FATAL_ERROR
= 2;
35 const DUPLICATE_CONTACT
= 8001;
36 const DUPLICATE_CONTRIBUTION
= 8002;
37 const DUPLICATE_PARTICIPANT
= 8003;
40 * We only need one instance of this object. So we use the singleton
41 * pattern and cache the instance in this variable
44 private static $_singleton = NULL;
47 * The logger object for this application.
50 private static $_log = NULL;
53 * If modeException == true, errors are raised as exception instead of returning civicrm_errors
56 public static $modeException = NULL;
59 * Singleton function used to manage this object.
61 * @param null $package
62 * @param bool $msgCallback
63 * @param bool $contextCallback
64 * @param bool $throwPEAR_Error
65 * @param string $stackClass
67 * @return CRM_Core_Error
69 public static function &singleton($package = NULL, $msgCallback = FALSE, $contextCallback = FALSE, $throwPEAR_Error = FALSE, $stackClass = 'PEAR_ErrorStack') {
70 if (self
::$_singleton === NULL) {
71 self
::$_singleton = new CRM_Core_Error('CiviCRM');
73 return self
::$_singleton;
79 public function __construct() {
80 parent
::__construct('CiviCRM');
82 $log = CRM_Core_Config
::getLog();
83 $this->setLogger($log);
85 // PEAR<=1.9.0 does not declare "static" properly.
86 if (!is_callable(['PEAR', '__callStatic'])) {
87 $this->setDefaultCallback([$this, 'handlePES']);
90 PEAR_ErrorStack
::setDefaultCallback([$this, 'handlePES']);
96 * @param string $separator
98 * @return array|null|string
100 public static function getMessages(&$error, $separator = '<br />') {
101 if (is_a($error, 'CRM_Core_Error')) {
102 $errors = $error->getErrors();
104 foreach ($errors as $e) {
105 $message[] = $e['code'] . ': ' . $e['message'];
107 $message = implode($separator, $message);
110 elseif (is_a($error, 'Civi\Payment\Exception\PaymentProcessorException')) {
111 return $error->getMessage();
117 * Status display function specific to payment processor errors.
119 * @param string $separator
121 public static function displaySessionError(&$error, $separator = '<br />') {
122 $message = self
::getMessages($error, $separator);
124 $status = ts("Payment Processor Error message") . "{$separator} $message";
125 $session = CRM_Core_Session
::singleton();
126 $session->setStatus($status);
131 * Create the main callback method. this method centralizes error processing.
133 * the errors we expect are from the pear modules DB, DB_DataObject
134 * which currently use PEAR::raiseError to notify of error messages.
136 * @param object $pearError PEAR_Error
138 public static function handle($pearError) {
139 if (defined('CIVICRM_TEST')) {
140 return self
::simpleHandler($pearError);
143 // setup smarty with config, session and template location.
144 $template = CRM_Core_Smarty
::singleton();
145 $config = CRM_Core_Config
::singleton();
147 if ($config->backtrace
) {
151 // create the error array
152 $error = self
::getErrorDetails($pearError);
154 // We access connection info via _DB_DATAOBJECT instead
155 // of, e.g., calling getDatabaseConnection(), so that we
156 // can avoid infinite loops.
157 global $_DB_DATAOBJECT;
159 if (isset($_DB_DATAOBJECT['CONFIG']['database'])) {
160 $dao = new CRM_Core_DAO();
161 if (isset($_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5
])) {
162 $conn = $_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5
];
164 // FIXME: Polymorphism for the win.
165 if ($conn instanceof DB_mysqli
) {
166 $link = $conn->connection
;
167 if (mysqli_error($link)) {
168 $mysql_error = mysqli_error($link) . ', ' . mysqli_errno($link);
169 // execute a dummy query to clear error stack
170 mysqli_query($link, 'select 1');
173 elseif ($conn instanceof DB_mysql
) {
175 $mysql_error = mysql_error() . ', ' . mysql_errno();
176 // execute a dummy query to clear error stack
177 mysql_query('select 1');
181 $mysql_error = 'fixme-unknown-db-cxn';
183 $template->assign_by_ref('mysql_code', $mysql_error);
187 // Use the custom fatalErrorHandler if defined
188 if ($config->fatalErrorHandler
&& function_exists($config->fatalErrorHandler
)) {
189 $name = $config->fatalErrorHandler
;
191 'pearError' => $pearError,
195 // the call has been successfully handled so we just exit
196 self
::abend(CRM_Core_Error
::FATAL_ERROR
);
200 $template->assign_by_ref('error', $error);
201 $errorDetails = CRM_Core_Error
::debug('', $error, FALSE);
202 $template->assign_by_ref('errorDetails', $errorDetails);
204 CRM_Core_Error
::debug_var('Fatal Error Details', $error, TRUE, TRUE, '', PEAR_LOG_ERR
);
205 CRM_Core_Error
::backtrace('backTrace', TRUE);
207 if ($config->initialized
) {
208 $content = $template->fetch('CRM/common/fatal.tpl');
209 echo CRM_Utils_System
::theme($content);
212 echo "Sorry. A non-recoverable error has occurred. The error trace below might help to resolve the issue<p>";
213 CRM_Core_Error
::debug(NULL, $error);
215 static $runOnce = FALSE;
220 self
::abend(CRM_Core_Error
::FATAL_ERROR
);
224 * this function is used to trap and print errors
225 * during system initialization time. Hence the error
226 * message is quite ugly
230 public static function simpleHandler($pearError) {
232 $error = self
::getErrorDetails($pearError);
234 // ensure that debug does not check permissions since we are in bootstrap
235 // mode and need to print a decent message to help the user
236 CRM_Core_Error
::debug('Initialization Error', $error, TRUE, TRUE, FALSE);
238 // always log the backtrace to a file
239 self
::backtrace('backTrace', TRUE);
245 * this function is used to return error details
249 * @return array $error
251 public static function getErrorDetails($pearError) {
252 // create the error array
254 $error['callback'] = $pearError->getCallback();
255 $error['code'] = $pearError->getCode();
256 $error['message'] = $pearError->getMessage();
257 $error['mode'] = $pearError->getMode();
258 $error['debug_info'] = $pearError->getDebugInfo();
259 $error['type'] = $pearError->getType();
260 $error['user_info'] = $pearError->getUserInfo();
261 $error['to_string'] = $pearError->toString();
267 * Handle errors raised using the PEAR Error Stack.
269 * currently the handler just requests the PES framework
270 * to push the error to the stack (return value PEAR_ERRORSTACK_PUSH).
272 * Note: we can do our own error handling here and return PEAR_ERRORSTACK_IGNORE.
274 * Also, if we do not return any value the PEAR_ErrorStack::push() then does the
275 * action of PEAR_ERRORSTACK_PUSHANDLOG which displays the errors on the screen,
276 * since the logger set for this error stack is 'display' - see CRM_Core_Config::getLog();
278 * @param mixed $pearError
282 public static function handlePES($pearError) {
283 return PEAR_ERRORSTACK_PUSH
;
287 * Display an error page with an error message describing what happened.
290 * This is a really annoying function. We ❤ exceptions. Be exceptional!
294 * @param string $message
296 * @param string $code
297 * The error code if any.
298 * @param string $email
299 * The email address to notify of this situation.
303 public static function fatal($message = NULL, $code = NULL, $email = NULL) {
304 CRM_Core_Error
::deprecatedFunctionWarning('throw new CRM_Core_Exception or use CRM_Core_Error::statusBounce', 'CRM_Core_Error::fatal');
306 'message' => $message,
310 if (self
::$modeException) {
312 CRM_Core_Error
::debug_var('Fatal Error Details', $vars, TRUE, TRUE, '', PEAR_LOG_ERR
);
313 CRM_Core_Error
::backtrace('backTrace', TRUE);
315 $details = 'A fatal error was triggered';
317 $details .= ': ' . $message;
319 throw new Exception($details, $code);
323 $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']);
326 if (php_sapi_name() == "cli") {
327 print ("Sorry. A non-recoverable error has occurred.\n$message \n$code\n$email\n\n");
329 echo static::formatBacktrace(debug_backtrace());
331 // FIXME: Why doesn't this call abend()?
332 // Difference: abend() will cleanup transaction and (via civiExit) store session state
333 // self::abend(CRM_Core_Error::FATAL_ERROR);
336 $config = CRM_Core_Config
::singleton();
338 if ($config->fatalErrorHandler
&&
339 function_exists($config->fatalErrorHandler
)
341 $name = $config->fatalErrorHandler
;
344 // the call has been successfully handled
346 self
::abend(CRM_Core_Error
::FATAL_ERROR
);
350 if ($config->backtrace
) {
354 CRM_Core_Error
::debug_var('Fatal Error Details', $vars, TRUE, TRUE, '', PEAR_LOG_ERR
);
355 CRM_Core_Error
::backtrace('backTrace', TRUE);
357 // If we are in an ajax callback, format output appropriately
358 if (CRM_Utils_Array
::value('snippet', $_REQUEST) === CRM_Core_Smarty
::PRINT_JSON
) {
361 'content' => '<div class="messages status no-popup">' . CRM_Core_Page
::crmIcon('fa-info-circle') . ' ' . ts('Sorry but we are not able to provide this at the moment.') . '</div>',
363 if ($config->backtrace
&& CRM_Core_Permission
::check('view debug output')) {
364 $out['backtrace'] = self
::parseBacktrace(debug_backtrace());
365 $message .= '<p><em>See console for backtrace</em></p>';
367 CRM_Core_Session
::setStatus($message, ts('Sorry an error occurred'), 'error');
368 CRM_Core_Transaction
::forceRollbackIfEnabled();
369 CRM_Core_Page_AJAX
::returnJsonResponse($out);
372 $template = CRM_Core_Smarty
::singleton();
373 $template->assign($vars);
374 $config->userSystem
->outputError($template->fetch('CRM/common/fatal.tpl'));
376 self
::abend(CRM_Core_Error
::FATAL_ERROR
);
380 * Display an error page with an error message describing what happened.
382 * This function is evil -- it largely replicates fatal(). Hopefully the
383 * entire CRM_Core_Error system can be hollowed out and replaced with
384 * something that follows a cleaner separation of concerns.
386 * @param Exception $exception
388 public static function handleUnhandledException($exception) {
390 CRM_Utils_Hook
::unhandledException($exception);
392 catch (Exception
$other) {
393 // if the exception-handler generates an exception, then that sucks! oh, well. carry on.
394 CRM_Core_Error
::debug_var('handleUnhandledException_nestedException', self
::formatTextException($other), TRUE, TRUE, '', PEAR_LOG_ERR
);
396 $config = CRM_Core_Config
::singleton();
398 'message' => $exception->getMessage(),
400 'exception' => $exception,
402 if (!$vars['message']) {
403 $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']);
407 if (php_sapi_name() == "cli") {
408 printf("Sorry. A non-recoverable error has occurred.\n%s\n", $vars['message']);
409 print self
::formatTextException($exception);
411 // FIXME: Why doesn't this call abend()?
412 // Difference: abend() will cleanup transaction and (via civiExit) store session state
413 // self::abend(CRM_Core_Error::FATAL_ERROR);
416 // Case B: Custom error handler
417 if ($config->fatalErrorHandler
&&
418 function_exists($config->fatalErrorHandler
)
420 $name = $config->fatalErrorHandler
;
423 // the call has been successfully handled
425 self
::abend(CRM_Core_Error
::FATAL_ERROR
);
429 // Case C: Default error handler
432 CRM_Core_Error
::debug_var('Fatal Error Details', $vars, FALSE, TRUE, '', PEAR_LOG_ERR
);
433 CRM_Core_Error
::backtrace('backTrace', TRUE);
436 $template = CRM_Core_Smarty
::singleton();
437 $template->assign($vars);
438 $content = $template->fetch('CRM/common/fatal.tpl');
440 if ($config->backtrace
) {
441 $content = self
::formatHtmlException($exception) . $content;
444 echo CRM_Utils_System
::theme($content);
447 self
::abend(CRM_Core_Error
::FATAL_ERROR
);
451 * Outputs pre-formatted debug information. Flushes the buffers
452 * so we can interrupt a potential POST/redirect
454 * @param string $name name of debug section
455 * @param $variable mixed reference to variables that we need a trace of
456 * @param bool $log should we log or return the output
457 * @param bool $html whether to generate a HTML-escaped output
458 * @param bool $checkPermission should we check permissions before displaying output
459 * useful when we die during initialization and permissioning
460 * subsystem is not initialized - CRM-13765
463 * the generated output
465 public static function debug($name, $variable = NULL, $log = TRUE, $html = TRUE, $checkPermission = TRUE) {
466 $error = self
::singleton();
468 if ($variable === NULL) {
473 $out = print_r($variable, TRUE);
476 $out = htmlspecialchars($out);
478 $prefix = "<p>$name</p>";
480 $out = "{$prefix}<p><pre>$out</pre></p><p></p>";
484 $prefix = "$name:\n";
486 $out = "{$prefix}$out\n";
490 (!$checkPermission || CRM_Core_Permission
::check('view debug output'))
499 * Similar to the function debug. Only difference is
500 * in the formatting of the output.
502 * @param string $variable_name
504 * @param mixed $variable
507 * Use print_r (if true) or var_dump (if false).
509 * Log or return the output?
510 * @param string $prefix
511 * Prefix for output logfile.
512 * @param int $priority
513 * The log priority level.
516 * The generated output
518 * @see CRM_Core_Error::debug()
519 * @see CRM_Core_Error::debug_log_message()
521 public static function debug_var($variable_name, $variable, $print = TRUE, $log = TRUE, $prefix = '', $priority = NULL) {
522 // check if variable is set
523 if (!isset($variable)) {
524 $out = "\$$variable_name is not set";
528 $out = print_r($variable, TRUE);
529 $out = "\$$variable_name = $out";
535 $dump = ob_get_contents();
537 $out = "\n\$$variable_name = $dump";
539 // reset if it is an array
540 if (is_array($variable)) {
544 return self
::debug_log_message($out, FALSE, $prefix, $priority);
548 * Display the error message on terminal and append it to the log file.
550 * Provided the user has the 'view debug output' the output should be displayed. In all
551 * cases it should be logged.
553 * @param string $message
555 * Should we log or return the output.
557 * @param string $prefix
559 * @param string $priority
562 * Format of the backtrace
564 public static function debug_log_message($message, $out = FALSE, $prefix = '', $priority = NULL) {
565 $config = CRM_Core_Config
::singleton();
567 $file_log = self
::createDebugLogger($prefix);
568 $file_log->log("$message\n", $priority);
570 $str = '<p/><code>' . htmlspecialchars($message) . '</code>';
571 if ($out && CRM_Core_Permission
::check('view debug output')) {
576 if (!isset(\Civi
::$statics[__CLASS__
]['userFrameworkLogging'])) {
577 // Set it to FALSE first & then try to set it. This is to prevent a loop as calling
578 // $config->userFrameworkLogging can trigger DB queries & under log mode this
579 // then gets called again.
580 \Civi
::$statics[__CLASS__
]['userFrameworkLogging'] = FALSE;
581 \Civi
::$statics[__CLASS__
]['userFrameworkLogging'] = $config->userFrameworkLogging
;
584 if (!empty(\Civi
::$statics[__CLASS__
]['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', ['%message' => $message], $priority ?? WATCHDOG_DEBUG
);
589 elseif ($config->userSystem
->is_drupal
and CIVICRM_UF
== 'Drupal8') {
590 \Drupal
::logger('civicrm')->log($priority ?? \Drupal\Core\Logger\RfcLogLevel
::DEBUG
, '%message', ['%message' => $message]);
598 * Append to the query log (if enabled)
600 * @param string $string
602 public static function debug_query($string) {
603 if (defined('CIVICRM_DEBUG_LOG_QUERY')) {
604 if (CIVICRM_DEBUG_LOG_QUERY
=== 'backtrace') {
605 CRM_Core_Error
::backtrace($string, TRUE);
607 elseif (CIVICRM_DEBUG_LOG_QUERY
) {
608 CRM_Core_Error
::debug_var('Query', $string, TRUE, TRUE, 'sql_log', PEAR_LOG_DEBUG
);
614 * Execute a query and log the results.
616 * @param string $query
618 public static function debug_query_result($query) {
619 $results = CRM_Core_DAO
::executeQuery($query)->fetchAll();
620 CRM_Core_Error
::debug_var('dao result', ['query' => $query, 'results' => $results], TRUE, TRUE, '', PEAR_LOG_DEBUG
);
624 * Obtain a reference to the error log.
626 * @param string $prefix
630 public static function createDebugLogger($prefix = '') {
631 self
::generateLogFileName($prefix);
632 return Log
::singleton('file', \Civi
::$statics[__CLASS__
]['logger_file' . $prefix], '');
636 * Generate a hash for the logfile.
640 * @param CRM_Core_Config $config
644 public static function generateLogFileHash($config) {
645 // Use multiple (but stable) inputs for hash information.
647 defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY
: 'NO_SITE_KEY',
648 $config->userFrameworkBaseURL
,
652 // Trim 8 chars off the string, make it slightly easier to find
653 // but reveals less information from the hash.
654 return substr(md5(var_export($md5inputs, 1)), 8);
658 * Generate the name of the logfile to use and store it as a static.
660 * This function includes simplistic log rotation and a check as to whether
663 * @param string $prefix
665 protected static function generateLogFileName($prefix) {
666 if (!isset(\Civi
::$statics[__CLASS__
]['logger_file' . $prefix])) {
667 $config = CRM_Core_Config
::singleton();
669 $prefixString = $prefix ?
($prefix . '.') : '';
671 if (CRM_Utils_Constant
::value('CIVICRM_LOG_HASH', TRUE)) {
672 $hash = self
::generateLogFileHash($config) . '.';
677 $fileName = $config->configAndLogDir
. 'CiviCRM.' . $prefixString . $hash . 'log';
679 // Roll log file monthly or if greater than our threshold.
680 // Size-based rotation introduced in response to filesize limits on
681 // certain OS/PHP combos.
682 $maxBytes = CRM_Utils_Constant
::value('CIVICRM_LOG_ROTATESIZE', 256 * 1024 * 1024);
684 if (file_exists($fileName)) {
685 $fileTime = date("Ym", filemtime($fileName));
686 $fileSize = filesize($fileName);
687 if (($fileTime < date('Ym')) ||
688 ($fileSize > $maxBytes) ||
692 $fileName . '.' . date('YmdHi')
697 \Civi
::$statics[__CLASS__
]['logger_file' . $prefix] = $fileName;
705 public static function backtrace($msg = 'backTrace', $log = FALSE) {
706 $backTrace = debug_backtrace();
707 $message = self
::formatBacktrace($backTrace);
709 CRM_Core_Error
::debug($msg, $message);
712 CRM_Core_Error
::debug_var($msg, $message, TRUE, TRUE, '', PEAR_LOG_DEBUG
);
717 * Render a backtrace array as a string.
719 * @param array $backTrace
720 * Array of stack frames.
721 * @param bool $showArgs
722 * 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.
723 * @param int $maxArgLen
724 * Maximum number of characters to show from each argument string.
726 * printable plain-text
728 public static function formatBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) {
730 foreach (self
::parseBacktrace($backTrace, $showArgs, $maxArgLen) as $idx => $trace) {
731 $message .= sprintf("#%s %s\n", $idx, $trace);
733 $message .= sprintf("#%s {main}\n", 1 +
$idx);
738 * Render a backtrace array as an array.
740 * @param array $backTrace
741 * Array of stack frames.
742 * @param bool $showArgs
743 * 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.
744 * @param int $maxArgLen
745 * Maximum number of characters to show from each argument string.
747 * @see debug_backtrace
748 * @see Exception::getTrace()
750 public static function parseBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) {
752 foreach ($backTrace as $trace) {
754 $fnName = $trace['function'] ??
NULL;
755 $className = isset($trace['class']) ?
($trace['class'] . $trace['type']) : '';
757 // Do not show args for a few password related functions
758 $skipArgs = $className == 'DB::' && $fnName == 'connect';
760 if (!empty($trace['args'])) {
761 foreach ($trace['args'] as $arg) {
762 if (!$showArgs ||
$skipArgs) {
763 $args[] = '(' . gettype($arg) . ')';
766 switch ($type = gettype($arg)) {
768 $args[] = $arg ?
'TRUE' : 'FALSE';
777 $args[] = '"' . CRM_Utils_String
::ellipsify(addcslashes((string) $arg, "\r\n\t\""), $maxArgLen) . '"';
781 $args[] = '(Array:' . count($arg) . ')';
785 $args[] = 'Object(' . get_class($arg) . ')';
789 $args[] = 'Resource';
805 CRM_Utils_Array
::value('file', $trace, '[internal function]'),
806 CRM_Utils_Array
::value('line', $trace, ''),
816 * Render an exception as HTML string.
818 * @param Exception $e
820 * printable HTML text
822 public static function formatHtmlException(Exception
$e) {
825 // Exception metadata
827 // Exception backtrace
828 if ($e instanceof PEAR_Exception
) {
830 while (is_callable([$ei, 'getCause'])) {
831 // DB_ERROR doesn't have a getCause but does have a __call function which tricks is_callable.
832 if (!$ei instanceof DB_Error
) {
833 if ($ei->getCause() instanceof PEAR_Error
) {
834 $msg .= '<table class="crm-db-error">';
835 $msg .= sprintf('<thead><tr><th>%s</th><th>%s</th></tr></thead>', ts('Error Field'), ts('Error Value'));
837 foreach (['Type', 'Code', 'Message', 'Mode', 'UserInfo', 'DebugInfo'] as $f) {
838 $msg .= sprintf('<tr><td>%s</td><td>%s</td></tr>', $f, call_user_func([$ei->getCause(), "get$f"]));
840 $msg .= '</tbody></table>';
842 $ei = $ei->getCause();
845 $msg .= $e->toHtml();
848 $msg .= '<p><b>' . get_class($e) . ': "' . htmlentities($e->getMessage()) . '"</b></p>';
849 $msg .= '<pre>' . htmlentities(self
::formatBacktrace($e->getTrace())) . '</pre>';
855 * Write details of an exception to the log.
857 * @param Exception $e
859 * printable plain text
861 public static function formatTextException(Exception
$e) {
862 $msg = get_class($e) . ": \"" . $e->getMessage() . "\"\n";
865 while (is_callable([$ei, 'getCause'])) {
866 // DB_ERROR doesn't have a getCause but does have a __call function which tricks is_callable.
867 if (!$ei instanceof DB_Error
) {
868 if ($ei->getCause() instanceof PEAR_Error
) {
869 foreach (['Type', 'Code', 'Message', 'Mode', 'UserInfo', 'DebugInfo'] as $f) {
870 $msg .= sprintf(" * ERROR %s: %s\n", strtoupper($f), call_user_func([$ei->getCause(), "get$f"]));
873 $ei = $ei->getCause();
875 // if we have reached a DB_Error assume that is the end of the road.
880 $msg .= self
::formatBacktrace($e->getTrace());
887 * @param string $level
888 * @param array $params
892 public static function createError($message, $code = 8000, $level = 'Fatal', $params = NULL) {
893 $error = CRM_Core_Error
::singleton();
894 $error->push($code, $level, [$params], $message);
899 * Set a status message in the session, then bounce back to the referrer.
901 * @param string $status
902 * The status message to set.
904 * @param null $redirect
905 * @param string $title
907 public static function statusBounce($status, $redirect = NULL, $title = NULL) {
908 $session = CRM_Core_Session
::singleton();
910 $redirect = $session->readUserContext();
912 if ($title === NULL) {
913 $title = ts('Error');
915 $session->setStatus($status, $title, 'alert', ['expires' => 0]);
916 if (CRM_Utils_Array
::value('snippet', $_REQUEST) === CRM_Core_Smarty
::PRINT_JSON
) {
917 CRM_Core_Page_AJAX
::returnJsonResponse(['status' => 'error']);
919 CRM_Utils_System
::redirect($redirect);
923 * Reset the error stack.
926 public static function reset() {
927 $error = self
::singleton();
928 $error->_errors
= [];
929 $error->_errorsByLevel
= [];
933 * PEAR error-handler which converts errors to exceptions
936 * @throws PEAR_Exception
938 public static function exceptionHandler($pearError) {
939 CRM_Core_Error
::debug_var('Fatal Error Details', self
::getErrorDetails($pearError), TRUE, TRUE, '', PEAR_LOG_ERR
);
940 CRM_Core_Error
::backtrace('backTrace', TRUE);
941 throw new PEAR_Exception($pearError->getMessage(), $pearError);
945 * PEAR error-handler to quietly catch otherwise fatal errors. Intended for use with smtp transport.
948 * The PEAR_ERROR object.
952 public static function nullHandler($obj) {
953 CRM_Core_Error
::debug_log_message("Ignoring exception thrown by nullHandler: {$obj->code}, {$obj->message}", FALSE, '', PEAR_LOG_ERR
);
954 CRM_Core_Error
::backtrace('backTrace', TRUE);
960 * This function is no longer used by v3 api.
961 * @fixme Some core files call it but it should be re-thought & renamed or removed
969 public static function &createAPIError($msg, $data = NULL) {
970 if (self
::$modeException) {
971 throw new Exception($msg, $data);
976 $values['is_error'] = 1;
977 $values['error_message'] = $msg;
979 $values = array_merge($values, $data);
987 public static function movedSiteError($file) {
988 $url = CRM_Utils_System
::url('civicrm/admin/setting/updateConfigBackend',
992 echo "We could not write $file. Have you moved your site directory or server?<p>";
993 echo "Please fix the setting by running the <a href=\"$url\">update config script</a>";
998 * Terminate execution abnormally.
1000 * @param string $code
1002 protected static function abend($code) {
1003 // do a hard rollback of any pending transactions
1004 // if we've come here, its because of some unexpected PEAR errors
1005 CRM_Core_Transaction
::forceRollbackIfEnabled();
1006 CRM_Utils_System
::civiExit($code);
1010 * @param array $error
1015 public static function isAPIError($error, $type = CRM_Core_Error
::FATAL_ERROR
) {
1016 if (is_array($error) && !empty($error['is_error'])) {
1017 $code = $error['error_message']['code'];
1018 if ($code == $type) {
1026 * Output a deprecated function warning to log file. Deprecated class:function is automatically generated from calling function.
1028 * @param string $newMethod
1029 * description of new method (eg. "buildOptions() method in the appropriate BAO object").
1030 * @param string $oldMethod
1031 * optional description of old method (if not the calling method). eg. CRM_MyClass::myOldMethodToGetTheOptions()
1033 public static function deprecatedFunctionWarning($newMethod, $oldMethod = NULL) {
1035 $dbt = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS
, 2);
1036 $callerFunction = $dbt[1]['function'] ??
NULL;
1037 $callerClass = $dbt[1]['class'] ??
NULL;
1038 $oldMethod = "{$callerClass}::{$callerFunction}";
1040 Civi
::log()->warning("Deprecated function $oldMethod, use $newMethod.", ['civi.tag' => 'deprecated']);
1045 $e = new PEAR_ErrorStack('CRM');
1046 $e->singleton('CRM', FALSE, NULL, 'CRM_Core_Error');