setLogger($log); // PEAR<=1.9.0 does not declare "static" properly. if (!is_callable(array('PEAR', '__callStatic'))) { $this->setDefaultCallback(array($this, 'handlePES')); } else { PEAR_ErrorStack::setDefaultCallback(array($this, 'handlePES')); } } /** * @param $error * @param string $separator * * @return array|null|string */ static public function getMessages(&$error, $separator = '
') { if (is_a($error, 'CRM_Core_Error')) { $errors = $error->getErrors(); $message = array(); foreach ($errors as $e) { $message[] = $e['code'] . ': ' . $e['message']; } $message = implode($separator, $message); return $message; } elseif (is_a($error, 'Civi\Payment\Exception\PaymentProcessorException')) { return $error->getMessage(); } return NULL; } /** * Status display function specific to payment processor errors. * @param $error * @param string $separator */ public static function displaySessionError(&$error, $separator = '
') { $message = self::getMessages($error, $separator); if ($message) { $status = ts("Payment Processor Error message") . "{$separator} $message"; $session = CRM_Core_Session::singleton(); $session->setStatus($status); } } /** * Create the main callback method. this method centralizes error processing. * * the errors we expect are from the pear modules DB, DB_DataObject * which currently use PEAR::raiseError to notify of error messages. * * @param object $pearError PEAR_Error */ public static function handle($pearError) { if (defined('CIVICRM_TEST')) { return self::simpleHandler($pearError); } // setup smarty with config, session and template location. $template = CRM_Core_Smarty::singleton(); $config = CRM_Core_Config::singleton(); if ($config->backtrace) { self::backtrace(); } // create the error array $error = self::getErrorDetails($pearError); // We access connection info via _DB_DATAOBJECT instead // of, e.g., calling getDatabaseConnection(), so that we // can avoid infinite loops. global $_DB_DATAOBJECT; if (isset($_DB_DATAOBJECT['CONFIG']['database'])) { $dao = new CRM_Core_DAO(); if (isset($_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5])) { $conn = $_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5]; // FIXME: Polymorphism for the win. if ($conn instanceof DB_mysqli) { $link = $conn->connection; if (mysqli_error($link)) { $mysql_error = mysqli_error($link) . ', ' . mysqli_errno($link); mysqli_query($link, 'select 1'); // execute a dummy query to clear error stack } } elseif ($conn instanceof DB_mysql) { if (mysql_error()) { $mysql_error = mysql_error() . ', ' . mysql_errno(); mysql_query('select 1'); // execute a dummy query to clear error stack } } else { $mysql_error = 'fixme-unknown-db-cxn'; } $template->assign_by_ref('mysql_code', $mysql_error); } } $template->assign_by_ref('error', $error); $errorDetails = CRM_Core_Error::debug('', $error, FALSE); $template->assign_by_ref('errorDetails', $errorDetails); CRM_Core_Error::debug_var('Fatal Error Details', $error); CRM_Core_Error::backtrace('backTrace', TRUE); if ($config->initialized) { $content = $template->fetch('CRM/common/fatal.tpl'); echo CRM_Utils_System::theme($content); } else { echo "Sorry. A non-recoverable error has occurred. The error trace below might help to resolve the issue

"; CRM_Core_Error::debug(NULL, $error); } static $runOnce = FALSE; if ($runOnce) { exit; } $runOnce = TRUE; self::abend(1); } /** * this function is used to trap and print errors * during system initialization time. Hence the error * message is quite ugly * * @param $pearError */ public static function simpleHandler($pearError) { $error = self::getErrorDetails($pearError); // ensure that debug does not check permissions since we are in bootstrap // mode and need to print a decent message to help the user CRM_Core_Error::debug('Initialization Error', $error, TRUE, TRUE, FALSE); // always log the backtrace to a file self::backtrace('backTrace', TRUE); exit(0); } /** * this function is used to return error details * * @param $pearError * * @return array $error */ public static function getErrorDetails($pearError) { // create the error array $error = array(); $error['callback'] = $pearError->getCallback(); $error['code'] = $pearError->getCode(); $error['message'] = $pearError->getMessage(); $error['mode'] = $pearError->getMode(); $error['debug_info'] = $pearError->getDebugInfo(); $error['type'] = $pearError->getType(); $error['user_info'] = $pearError->getUserInfo(); $error['to_string'] = $pearError->toString(); return $error; } /** * Handle errors raised using the PEAR Error Stack. * * currently the handler just requests the PES framework * to push the error to the stack (return value PEAR_ERRORSTACK_PUSH). * * Note: we can do our own error handling here and return PEAR_ERRORSTACK_IGNORE. * * Also, if we do not return any value the PEAR_ErrorStack::push() then does the * action of PEAR_ERRORSTACK_PUSHANDLOG which displays the errors on the screen, * since the logger set for this error stack is 'display' - see CRM_Core_Config::getLog(); * * @param mixed $pearError * * @return int */ public static function handlePES($pearError) { return PEAR_ERRORSTACK_PUSH; } /** * Display an error page with an error message describing what happened. * * @deprecated * This is a really annoying function. We ❤ exceptions. Be exceptional! * * @see CRM-20181 * * @param string $message * The error message. * @param string $code * The error code if any. * @param string $email * The email address to notify of this situation. * * @throws Exception */ public static function fatal($message = NULL, $code = NULL, $email = NULL) { $vars = array( 'message' => $message, 'code' => $code, ); if (self::$modeException) { // CRM-11043 CRM_Core_Error::debug_var('Fatal Error Details', $vars); CRM_Core_Error::backtrace('backTrace', TRUE); $details = 'A fatal error was triggered'; if ($message) { $details .= ': ' . $message; } throw new Exception($details, $code); } if (!$message) { $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', array(1 => 'https://civicrm.org/bug-reporting')); } if (php_sapi_name() == "cli") { print ("Sorry. A non-recoverable error has occurred.\n$message \n$code\n$email\n\n"); // Fix for CRM-16899 echo static::formatBacktrace(debug_backtrace()); die("\n"); // FIXME: Why doesn't this call abend()? // Difference: abend() will cleanup transaction and (via civiExit) store session state // self::abend(CRM_Core_Error::FATAL_ERROR); } $config = CRM_Core_Config::singleton(); if ($config->fatalErrorHandler && function_exists($config->fatalErrorHandler) ) { $name = $config->fatalErrorHandler; $ret = $name($vars); if ($ret) { // the call has been successfully handled // so we just exit self::abend(CRM_Core_Error::FATAL_ERROR); } } if ($config->backtrace) { self::backtrace(); } CRM_Core_Error::debug_var('Fatal Error Details', $vars); CRM_Core_Error::backtrace('backTrace', TRUE); // If we are in an ajax callback, format output appropriately if (CRM_Utils_Array::value('snippet', $_REQUEST) === CRM_Core_Smarty::PRINT_JSON) { $out = array( 'status' => 'fatal', 'content' => '

' . ts('Sorry but we are not able to provide this at the moment.') . '
', ); if ($config->backtrace && CRM_Core_Permission::check('view debug output')) { $out['backtrace'] = self::parseBacktrace(debug_backtrace()); $message .= '

See console for backtrace

'; } CRM_Core_Session::setStatus($message, ts('Sorry an error occurred'), 'error'); CRM_Core_Transaction::forceRollbackIfEnabled(); CRM_Core_Page_AJAX::returnJsonResponse($out); } $template = CRM_Core_Smarty::singleton(); $template->assign($vars); $config->userSystem->outputError($template->fetch('CRM/common/fatal.tpl')); self::abend(CRM_Core_Error::FATAL_ERROR); } /** * Display an error page with an error message describing what happened. * * This function is evil -- it largely replicates fatal(). Hopefully the * entire CRM_Core_Error system can be hollowed out and replaced with * something that follows a cleaner separation of concerns. * * @param Exception $exception */ public static function handleUnhandledException($exception) { try { CRM_Utils_Hook::unhandledException($exception); } catch (Exception $other) { // if the exception-handler generates an exception, then that sucks! oh, well. carry on. CRM_Core_Error::debug_var('handleUnhandledException_nestedException', self::formatTextException($other)); } $config = CRM_Core_Config::singleton(); $vars = array( 'message' => $exception->getMessage(), 'code' => NULL, 'exception' => $exception, ); if (!$vars['message']) { $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', array(1 => 'https://civicrm.org/bug-reporting')); } // Case A: CLI if (php_sapi_name() == "cli") { printf("Sorry. A non-recoverable error has occurred.\n%s\n", $vars['message']); print self::formatTextException($exception); die("\n"); // FIXME: Why doesn't this call abend()? // Difference: abend() will cleanup transaction and (via civiExit) store session state // self::abend(CRM_Core_Error::FATAL_ERROR); } // Case B: Custom error handler if ($config->fatalErrorHandler && function_exists($config->fatalErrorHandler) ) { $name = $config->fatalErrorHandler; $ret = $name($vars); if ($ret) { // the call has been successfully handled // so we just exit self::abend(CRM_Core_Error::FATAL_ERROR); } } // Case C: Default error handler // log to file CRM_Core_Error::debug_var('Fatal Error Details', $vars, FALSE); CRM_Core_Error::backtrace('backTrace', TRUE); // print to screen $template = CRM_Core_Smarty::singleton(); $template->assign($vars); $content = $template->fetch('CRM/common/fatal.tpl'); if ($config->backtrace) { $content = self::formatHtmlException($exception) . $content; } if ($config->userFramework == 'Joomla' && class_exists('JError') ) { JError::raiseError('CiviCRM-001', $content); } else { echo CRM_Utils_System::theme($content); } // fin self::abend(CRM_Core_Error::FATAL_ERROR); } /** * Outputs pre-formatted debug information. Flushes the buffers * so we can interrupt a potential POST/redirect * * @param string $name name of debug section * @param $variable mixed reference to variables that we need a trace of * @param bool $log should we log or return the output * @param bool $html whether to generate a HTML-escaped output * @param bool $checkPermission should we check permissions before displaying output * useful when we die during initialization and permissioning * subsystem is not initialized - CRM-13765 * * @return string * the generated output */ public static function debug($name, $variable = NULL, $log = TRUE, $html = TRUE, $checkPermission = TRUE) { $error = self::singleton(); if ($variable === NULL) { $variable = $name; $name = NULL; } $out = print_r($variable, TRUE); $prefix = NULL; if ($html) { $out = htmlspecialchars($out); if ($name) { $prefix = "

$name

"; } $out = "{$prefix}

$out

"; } else { if ($name) { $prefix = "$name:\n"; } $out = "{$prefix}$out\n"; } if ( $log && (!$checkPermission || CRM_Core_Permission::check('view debug output')) ) { echo $out; } return $out; } /** * Similar to the function debug. Only difference is * in the formatting of the output. * * @param string $variable_name * Variable name. * @param mixed $variable * Variable value. * @param bool $print * Use print_r (if true) or var_dump (if false). * @param bool $log * Log or return the output? * @param string $prefix * Prefix for output logfile. * * @return string * The generated output * * @see CRM_Core_Error::debug() * @see CRM_Core_Error::debug_log_message() */ public static function debug_var($variable_name, $variable, $print = TRUE, $log = TRUE, $prefix = '') { // check if variable is set if (!isset($variable)) { $out = "\$$variable_name is not set"; } else { if ($print) { $out = print_r($variable, TRUE); $out = "\$$variable_name = $out"; } else { // use var_dump ob_start(); var_dump($variable); $dump = ob_get_contents(); ob_end_clean(); $out = "\n\$$variable_name = $dump"; } // reset if it is an array if (is_array($variable)) { reset($variable); } } return self::debug_log_message($out, FALSE, $prefix); } /** * Display the error message on terminal and append it to the log file. * * Provided the user has the 'view debug output' the output should be displayed. In all * cases it should be logged. * * @param string $message * @param bool $out * Should we log or return the output. * * @param string $prefix * Message prefix. * @param string $priority * * @return string * Format of the backtrace */ public static function debug_log_message($message, $out = FALSE, $prefix = '', $priority = NULL) { $config = CRM_Core_Config::singleton(); $file_log = self::createDebugLogger($prefix); $file_log->log("$message\n", $priority); $str = '

' . htmlspecialchars($message) . ''; if ($out && CRM_Core_Permission::check('view debug output')) { echo $str; } $file_log->close(); if (!isset(\Civi::$statics[__CLASS__]['userFrameworkLogging'])) { // Set it to FALSE first & then try to set it. This is to prevent a loop as calling // $config->userFrameworkLogging can trigger DB queries & under log mode this // then gets called again. \Civi::$statics[__CLASS__]['userFrameworkLogging'] = FALSE; \Civi::$statics[__CLASS__]['userFrameworkLogging'] = $config->userFrameworkLogging; } if (!empty(\Civi::$statics[__CLASS__]['userFrameworkLogging'])) { // should call $config->userSystem->logger($message) here - but I got a situation where userSystem was not an object - not sure why if ($config->userSystem->is_drupal and function_exists('watchdog')) { watchdog('civicrm', '%message', array('%message' => $message), WATCHDOG_DEBUG); } } return $str; } /** * Append to the query log (if enabled) * * @param string $string */ public static function debug_query($string) { if (defined('CIVICRM_DEBUG_LOG_QUERY')) { if (CIVICRM_DEBUG_LOG_QUERY === 'backtrace') { CRM_Core_Error::backtrace($string, TRUE); } elseif (CIVICRM_DEBUG_LOG_QUERY) { CRM_Core_Error::debug_var('Query', $string, TRUE, TRUE, 'sql_log'); } } } /** * Execute a query and log the results. * * @param string $query */ public static function debug_query_result($query) { $results = CRM_Core_DAO::executeQuery($query)->fetchAll(); CRM_Core_Error::debug_var('dao result', array('query' => $query, 'results' => $results)); } /** * Obtain a reference to the error log. * * @param string $prefix * * @return Log */ public static function createDebugLogger($prefix = '') { self::generateLogFileName($prefix); return Log::singleton('file', \Civi::$statics[__CLASS__]['logger_file' . $prefix], ''); } /** * Generate a hash for the logfile. * * CRM-13640. * * @param CRM_Core_Config $config * * @return string */ public static function generateLogFileHash($config) { // Use multiple (but stable) inputs for hash information. $md5inputs = array( defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY : 'NO_SITE_KEY', $config->userFrameworkBaseURL, md5($config->dsn), $config->dsn, ); // Trim 8 chars off the string, make it slightly easier to find // but reveals less information from the hash. return substr(md5(var_export($md5inputs, 1)), 8); } /** * Generate the name of the logfile to use and store it as a static. * * This function includes simplistic log rotation and a check as to whether * the file exists. * * @param string $prefix */ protected static function generateLogFileName($prefix) { if (!isset(\Civi::$statics[__CLASS__]['logger_file' . $prefix])) { $config = CRM_Core_Config::singleton(); $prefixString = $prefix ? ($prefix . '.') : ''; $hash = self::generateLogFileHash($config); $fileName = $config->configAndLogDir . 'CiviCRM.' . $prefixString . $hash . '.log'; // Roll log file monthly or if greater than 256M. // Size-based rotation introduced in response to filesize limits on // certain OS/PHP combos. if (file_exists($fileName)) { $fileTime = date("Ym", filemtime($fileName)); $fileSize = filesize($fileName); if (($fileTime < date('Ym')) || ($fileSize > 256 * 1024 * 1024) || ($fileSize < 0) ) { rename($fileName, $fileName . '.' . date('YmdHi') ); } } \Civi::$statics[__CLASS__]['logger_file' . $prefix] = $fileName; } } /** * @param string $msg * @param bool $log */ public static function backtrace($msg = 'backTrace', $log = FALSE) { $backTrace = debug_backtrace(); $message = self::formatBacktrace($backTrace); if (!$log) { CRM_Core_Error::debug($msg, $message); } else { CRM_Core_Error::debug_var($msg, $message); } } /** * Render a backtrace array as a string. * * @param array $backTrace * Array of stack frames. * @param bool $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. * @param int $maxArgLen * Maximum number of characters to show from each argument string. * @return string * printable plain-text */ public static function formatBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) { $message = ''; foreach (self::parseBacktrace($backTrace, $showArgs, $maxArgLen) as $idx => $trace) { $message .= sprintf("#%s %s\n", $idx, $trace); } $message .= sprintf("#%s {main}\n", 1 + $idx); return $message; } /** * Render a backtrace array as an array. * * @param array $backTrace * Array of stack frames. * @param bool $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. * @param int $maxArgLen * Maximum number of characters to show from each argument string. * @return array * @see debug_backtrace * @see Exception::getTrace() */ public static function parseBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) { $ret = array(); foreach ($backTrace as $trace) { $args = array(); $fnName = CRM_Utils_Array::value('function', $trace); $className = isset($trace['class']) ? ($trace['class'] . $trace['type']) : ''; // Do not show args for a few password related functions $skipArgs = ($className == 'DB::' && $fnName == 'connect') ? TRUE : FALSE; if (!empty($trace['args'])) { foreach ($trace['args'] as $arg) { if (!$showArgs || $skipArgs) { $args[] = '(' . gettype($arg) . ')'; continue; } switch ($type = gettype($arg)) { case 'boolean': $args[] = $arg ? 'TRUE' : 'FALSE'; break; case 'integer': case 'double': $args[] = $arg; break; case 'string': $args[] = '"' . CRM_Utils_String::ellipsify(addcslashes((string) $arg, "\r\n\t\""), $maxArgLen) . '"'; break; case 'array': $args[] = '(Array:' . count($arg) . ')'; break; case 'object': $args[] = 'Object(' . get_class($arg) . ')'; break; case 'resource': $args[] = 'Resource'; break; case 'NULL': $args[] = 'NULL'; break; default: $args[] = "($type)"; break; } } } $ret[] = sprintf( "%s(%s): %s%s(%s)", CRM_Utils_Array::value('file', $trace, '[internal function]'), CRM_Utils_Array::value('line', $trace, ''), $className, $fnName, implode(", ", $args) ); } return $ret; } /** * Render an exception as HTML string. * * @param Exception $e * @return string * printable HTML text */ public static function formatHtmlException(Exception $e) { $msg = ''; // Exception metadata // Exception backtrace if ($e instanceof PEAR_Exception) { $ei = $e; while (is_callable(array($ei, 'getCause'))) { if ($ei->getCause() instanceof PEAR_Error) { $msg .= ''; $msg .= sprintf('', ts('Error Field'), ts('Error Value')); $msg .= ''; foreach (array('Type', 'Code', 'Message', 'Mode', 'UserInfo', 'DebugInfo') as $f) { $msg .= sprintf('', $f, call_user_func(array($ei->getCause(), "get$f"))); } $msg .= '
%s%s
%s%s
'; } $ei = $ei->getCause(); } $msg .= $e->toHtml(); } else { $msg .= '

' . get_class($e) . ': "' . htmlentities($e->getMessage()) . '"

'; $msg .= '
' . htmlentities(self::formatBacktrace($e->getTrace())) . '
'; } return $msg; } /** * Write details of an exception to the log. * * @param Exception $e * @return string * printable plain text */ public static function formatTextException(Exception $e) { $msg = get_class($e) . ": \"" . $e->getMessage() . "\"\n"; $ei = $e; while (is_callable(array($ei, 'getCause'))) { if ($ei->getCause() instanceof PEAR_Error) { foreach (array('Type', 'Code', 'Message', 'Mode', 'UserInfo', 'DebugInfo') as $f) { $msg .= sprintf(" * ERROR %s: %s\n", strtoupper($f), call_user_func(array($ei->getCause(), "get$f"))); } } $ei = $ei->getCause(); } $msg .= self::formatBacktrace($e->getTrace()); return $msg; } /** * @param $message * @param int $code * @param string $level * @param array $params * * @return object */ public static function createError($message, $code = 8000, $level = 'Fatal', $params = NULL) { $error = CRM_Core_Error::singleton(); $error->push($code, $level, array($params), $message); return $error; } /** * Set a status message in the session, then bounce back to the referrer. * * @param string $status * The status message to set. * * @param null $redirect * @param string $title */ public static function statusBounce($status, $redirect = NULL, $title = NULL) { $session = CRM_Core_Session::singleton(); if (!$redirect) { $redirect = $session->readUserContext(); } if ($title === NULL) { $title = ts('Error'); } $session->setStatus($status, $title, 'alert', array('expires' => 0)); if (CRM_Utils_Array::value('snippet', $_REQUEST) === CRM_Core_Smarty::PRINT_JSON) { CRM_Core_Page_AJAX::returnJsonResponse(array('status' => 'error')); } CRM_Utils_System::redirect($redirect); } /** * Reset the error stack. * */ public static function reset() { $error = self::singleton(); $error->_errors = array(); $error->_errorsByLevel = array(); } /** * PEAR error-handler which converts errors to exceptions * * @param $pearError * @throws PEAR_Exception */ public static function exceptionHandler($pearError) { CRM_Core_Error::debug_var('Fatal Error Details', self::getErrorDetails($pearError)); CRM_Core_Error::backtrace('backTrace', TRUE); throw new PEAR_Exception($pearError->getMessage(), $pearError); } /** * PEAR error-handler to quietly catch otherwise fatal errors. Intended for use with smtp transport. * * @param object $obj * The PEAR_ERROR object. * @return object * $obj */ public static function nullHandler($obj) { CRM_Core_Error::debug_log_message("Ignoring exception thrown by nullHandler: {$obj->code}, {$obj->message}"); CRM_Core_Error::backtrace('backTrace', TRUE); return $obj; } /** * @deprecated * This function is no longer used by v3 api. * @fixme Some core files call it but it should be re-thought & renamed or removed * * @param $msg * @param null $data * * @return array * @throws Exception */ public static function &createAPIError($msg, $data = NULL) { if (self::$modeException) { throw new Exception($msg, $data); } $values = array(); $values['is_error'] = 1; $values['error_message'] = $msg; if (isset($data)) { $values = array_merge($values, $data); } return $values; } /** * @param $file */ public static function movedSiteError($file) { $url = CRM_Utils_System::url('civicrm/admin/setting/updateConfigBackend', 'reset=1', TRUE ); echo "We could not write $file. Have you moved your site directory or server?

"; echo "Please fix the setting by running the update config script"; exit(); } /** * Terminate execution abnormally. * * @param string $code */ protected static function abend($code) { // do a hard rollback of any pending transactions // if we've come here, its because of some unexpected PEAR errors CRM_Core_Transaction::forceRollbackIfEnabled(); CRM_Utils_System::civiExit($code); } /** * @param array $error * @param int $type * * @return bool */ public static function isAPIError($error, $type = CRM_Core_Error::FATAL_ERROR) { if (is_array($error) && !empty($error['is_error'])) { $code = $error['error_message']['code']; if ($code == $type) { return TRUE; } } return FALSE; } /** * Output a deprecated function warning to log file. Deprecated class:function is automatically generated from calling function. * * @param $newMethod * description of new method (eg. "buildOptions() method in the appropriate BAO object"). */ public static function deprecatedFunctionWarning($newMethod) { $dbt = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2); $callerFunction = isset($dbt[1]['function']) ? $dbt[1]['function'] : NULL; $callerClass = isset($dbt[1]['class']) ? $dbt[1]['class'] : NULL; Civi::log()->warning("Deprecated function $callerClass::$callerFunction, use $newMethod.", array('civi.tag' => 'deprecated')); } } $e = new PEAR_ErrorStack('CRM'); $e->singleton('CRM', FALSE, NULL, 'CRM_Core_Error');