Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * Start of the Error framework. We should check out and inherit from | |
30 | * PEAR_ErrorStack and use that framework | |
31 | * | |
32 | * @package CRM | |
6b83d5bd | 33 | * @copyright CiviCRM LLC (c) 2004-2019 |
6a488035 TO |
34 | */ |
35 | ||
36 | require_once 'PEAR/ErrorStack.php'; | |
37 | require_once 'PEAR/Exception.php'; | |
dcc4f6a7 | 38 | require_once 'CRM/Core/Exception.php'; |
6a488035 | 39 | |
df8de0eb SL |
40 | require_once 'Log.php'; |
41 | ||
28518c90 EM |
42 | /** |
43 | * Class CRM_Exception | |
44 | */ | |
6a488035 | 45 | class CRM_Exception extends PEAR_Exception { |
518fa0ee | 46 | |
b5c2afd0 | 47 | /** |
8eedd10a | 48 | * Redefine the exception so message isn't optional. |
49 | * | |
b5c2afd0 EM |
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); | |
da3c7979 | 59 | * |
3bdca100 | 60 | * @param string $message exception message |
da3c7979 EM |
61 | * @param int $code |
62 | * @param Exception $previous | |
b5c2afd0 | 63 | */ |
353ffa53 | 64 | public function __construct($message = NULL, $code = 0, Exception $previous = NULL) { |
6a488035 TO |
65 | parent::__construct($message, $code, $previous); |
66 | } | |
96025800 | 67 | |
6a488035 TO |
68 | } |
69 | ||
a0ee3941 EM |
70 | /** |
71 | * Class CRM_Core_Error | |
72 | */ | |
6a488035 TO |
73 | class CRM_Core_Error extends PEAR_ErrorStack { |
74 | ||
75 | /** | |
0880a9d0 | 76 | * Status code of various types of errors. |
6a488035 | 77 | */ |
7da04cde TO |
78 | const FATAL_ERROR = 2; |
79 | const DUPLICATE_CONTACT = 8001; | |
80 | const DUPLICATE_CONTRIBUTION = 8002; | |
81 | const DUPLICATE_PARTICIPANT = 8003; | |
6a488035 TO |
82 | |
83 | /** | |
84 | * We only need one instance of this object. So we use the singleton | |
85 | * pattern and cache the instance in this variable | |
86 | * @var object | |
6a488035 TO |
87 | */ |
88 | private static $_singleton = NULL; | |
89 | ||
90 | /** | |
d09edf64 | 91 | * The logger object for this application. |
6a488035 | 92 | * @var object |
6a488035 TO |
93 | */ |
94 | private static $_log = NULL; | |
95 | ||
96 | /** | |
97 | * If modeException == true, errors are raised as exception instead of returning civicrm_errors | |
518fa0ee | 98 | * @var bool |
6a488035 TO |
99 | */ |
100 | public static $modeException = NULL; | |
101 | ||
102 | /** | |
100fef9d | 103 | * Singleton function used to manage this object. |
6a488035 | 104 | * |
dd244018 EM |
105 | * @param null $package |
106 | * @param bool $msgCallback | |
107 | * @param bool $contextCallback | |
108 | * @param bool $throwPEAR_Error | |
109 | * @param string $stackClass | |
110 | * | |
30208fab | 111 | * @return CRM_Core_Error |
6a488035 | 112 | */ |
2aa397bc | 113 | public static function &singleton($package = NULL, $msgCallback = FALSE, $contextCallback = FALSE, $throwPEAR_Error = FALSE, $stackClass = 'PEAR_ErrorStack') { |
6a488035 TO |
114 | if (self::$_singleton === NULL) { |
115 | self::$_singleton = new CRM_Core_Error('CiviCRM'); | |
116 | } | |
117 | return self::$_singleton; | |
118 | } | |
119 | ||
120 | /** | |
0880a9d0 | 121 | * Constructor. |
6a488035 | 122 | */ |
00be9182 | 123 | public function __construct() { |
6a488035 TO |
124 | parent::__construct('CiviCRM'); |
125 | ||
126 | $log = CRM_Core_Config::getLog(); | |
127 | $this->setLogger($log); | |
128 | ||
a6272a48 | 129 | // PEAR<=1.9.0 does not declare "static" properly. |
be2fb01f CW |
130 | if (!is_callable(['PEAR', '__callStatic'])) { |
131 | $this->setDefaultCallback([$this, 'handlePES']); | |
a6272a48 TO |
132 | } |
133 | else { | |
be2fb01f | 134 | PEAR_ErrorStack::setDefaultCallback([$this, 'handlePES']); |
a6272a48 | 135 | } |
6a488035 TO |
136 | } |
137 | ||
a0ee3941 EM |
138 | /** |
139 | * @param $error | |
140 | * @param string $separator | |
141 | * | |
142 | * @return array|null|string | |
143 | */ | |
518fa0ee | 144 | public static function getMessages(&$error, $separator = '<br />') { |
6a488035 TO |
145 | if (is_a($error, 'CRM_Core_Error')) { |
146 | $errors = $error->getErrors(); | |
be2fb01f | 147 | $message = []; |
6a488035 TO |
148 | foreach ($errors as $e) { |
149 | $message[] = $e['code'] . ': ' . $e['message']; | |
150 | } | |
151 | $message = implode($separator, $message); | |
152 | return $message; | |
153 | } | |
31176a73 SP |
154 | elseif (is_a($error, 'Civi\Payment\Exception\PaymentProcessorException')) { |
155 | return $error->getMessage(); | |
156 | } | |
6a488035 TO |
157 | return NULL; |
158 | } | |
159 | ||
dbddfb08 | 160 | /** |
0880a9d0 | 161 | * Status display function specific to payment processor errors. |
dbddfb08 EM |
162 | * @param $error |
163 | * @param string $separator | |
164 | */ | |
00be9182 | 165 | public static function displaySessionError(&$error, $separator = '<br />') { |
6a488035 TO |
166 | $message = self::getMessages($error, $separator); |
167 | if ($message) { | |
168 | $status = ts("Payment Processor Error message") . "{$separator} $message"; | |
169 | $session = CRM_Core_Session::singleton(); | |
170 | $session->setStatus($status); | |
171 | } | |
172 | } | |
173 | ||
174 | /** | |
100fef9d | 175 | * Create the main callback method. this method centralizes error processing. |
6a488035 TO |
176 | * |
177 | * the errors we expect are from the pear modules DB, DB_DataObject | |
178 | * which currently use PEAR::raiseError to notify of error messages. | |
179 | * | |
3bdca100 | 180 | * @param object $pearError PEAR_Error |
6a488035 TO |
181 | */ |
182 | public static function handle($pearError) { | |
2b2c4099 TO |
183 | if (defined('CIVICRM_TEST')) { |
184 | return self::simpleHandler($pearError); | |
185 | } | |
6a488035 TO |
186 | |
187 | // setup smarty with config, session and template location. | |
188 | $template = CRM_Core_Smarty::singleton(); | |
189 | $config = CRM_Core_Config::singleton(); | |
190 | ||
191 | if ($config->backtrace) { | |
192 | self::backtrace(); | |
193 | } | |
194 | ||
195 | // create the error array | |
ca8416c8 | 196 | $error = self::getErrorDetails($pearError); |
2e4ade96 TO |
197 | |
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; | |
202 | ||
0828e4ad | 203 | if (isset($_DB_DATAOBJECT['CONFIG']['database'])) { |
6a488035 | 204 | $dao = new CRM_Core_DAO(); |
6a488035 TO |
205 | if (isset($_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5])) { |
206 | $conn = $_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5]; | |
6a488035 | 207 | |
0828e4ad TO |
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); | |
518fa0ee SL |
213 | // execute a dummy query to clear error stack |
214 | mysqli_query($link, 'select 1'); | |
0828e4ad TO |
215 | } |
216 | } | |
217 | elseif ($conn instanceof DB_mysql) { | |
218 | if (mysql_error()) { | |
219 | $mysql_error = mysql_error() . ', ' . mysql_errno(); | |
518fa0ee SL |
220 | // execute a dummy query to clear error stack |
221 | mysql_query('select 1'); | |
0828e4ad TO |
222 | } |
223 | } | |
224 | else { | |
225 | $mysql_error = 'fixme-unknown-db-cxn'; | |
6a488035 | 226 | } |
0828e4ad | 227 | $template->assign_by_ref('mysql_code', $mysql_error); |
6a488035 TO |
228 | } |
229 | } | |
230 | ||
231 | $template->assign_by_ref('error', $error); | |
232 | $errorDetails = CRM_Core_Error::debug('', $error, FALSE); | |
233 | $template->assign_by_ref('errorDetails', $errorDetails); | |
234 | ||
120f8e64 | 235 | CRM_Core_Error::debug_var('Fatal Error Details', $error, TRUE, TRUE, '', PEAR_LOG_ERR); |
6a488035 TO |
236 | CRM_Core_Error::backtrace('backTrace', TRUE); |
237 | ||
238 | if ($config->initialized) { | |
239 | $content = $template->fetch('CRM/common/fatal.tpl'); | |
240 | echo CRM_Utils_System::theme($content); | |
241 | } | |
242 | else { | |
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); | |
245 | } | |
3a210ec0 E |
246 | static $runOnce = FALSE; |
247 | if ($runOnce) { | |
248 | exit; | |
249 | } | |
250 | $runOnce = TRUE; | |
6a488035 TO |
251 | self::abend(1); |
252 | } | |
253 | ||
a0ee3941 | 254 | /** |
4f1f1f2a CW |
255 | * this function is used to trap and print errors |
256 | * during system initialization time. Hence the error | |
257 | * message is quite ugly | |
258 | * | |
a0ee3941 EM |
259 | * @param $pearError |
260 | */ | |
6a488035 TO |
261 | public static function simpleHandler($pearError) { |
262 | ||
ca8416c8 | 263 | $error = self::getErrorDetails($pearError); |
264 | ||
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); | |
268 | ||
269 | // always log the backtrace to a file | |
270 | self::backtrace('backTrace', TRUE); | |
271 | ||
272 | exit(0); | |
273 | } | |
274 | ||
275 | /** | |
276 | * this function is used to return error details | |
277 | * | |
278 | * @param $pearError | |
279 | * | |
280 | * @return array $error | |
281 | */ | |
282 | public static function getErrorDetails($pearError) { | |
6a488035 | 283 | // create the error array |
be2fb01f | 284 | $error = []; |
353ffa53 TO |
285 | $error['callback'] = $pearError->getCallback(); |
286 | $error['code'] = $pearError->getCode(); | |
287 | $error['message'] = $pearError->getMessage(); | |
288 | $error['mode'] = $pearError->getMode(); | |
6a488035 | 289 | $error['debug_info'] = $pearError->getDebugInfo(); |
353ffa53 TO |
290 | $error['type'] = $pearError->getType(); |
291 | $error['user_info'] = $pearError->getUserInfo(); | |
292 | $error['to_string'] = $pearError->toString(); | |
6a488035 | 293 | |
ca8416c8 | 294 | return $error; |
6a488035 TO |
295 | } |
296 | ||
297 | /** | |
298 | * Handle errors raised using the PEAR Error Stack. | |
299 | * | |
300 | * currently the handler just requests the PES framework | |
301 | * to push the error to the stack (return value PEAR_ERRORSTACK_PUSH). | |
302 | * | |
303 | * Note: we can do our own error handling here and return PEAR_ERRORSTACK_IGNORE. | |
304 | * | |
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(); | |
ea3ddccf | 308 | * |
309 | * @param mixed $pearError | |
310 | * | |
311 | * @return int | |
6a488035 TO |
312 | */ |
313 | public static function handlePES($pearError) { | |
314 | return PEAR_ERRORSTACK_PUSH; | |
315 | } | |
316 | ||
317 | /** | |
0880a9d0 | 318 | * Display an error page with an error message describing what happened. |
6a488035 | 319 | * |
c6b9b29d CB |
320 | * @deprecated |
321 | * This is a really annoying function. We ❤ exceptions. Be exceptional! | |
322 | * | |
323 | * @see CRM-20181 | |
324 | * | |
6a0b768e TO |
325 | * @param string $message |
326 | * The error message. | |
327 | * @param string $code | |
328 | * The error code if any. | |
329 | * @param string $email | |
330 | * The email address to notify of this situation. | |
77b97be7 EM |
331 | * |
332 | * @throws Exception | |
6a488035 | 333 | */ |
00be9182 | 334 | public static function fatal($message = NULL, $code = NULL, $email = NULL) { |
be2fb01f | 335 | $vars = [ |
84509850 | 336 | 'message' => $message, |
6a488035 | 337 | 'code' => $code, |
be2fb01f | 338 | ]; |
6a488035 TO |
339 | |
340 | if (self::$modeException) { | |
341 | // CRM-11043 | |
120f8e64 | 342 | CRM_Core_Error::debug_var('Fatal Error Details', $vars, TRUE, TRUE, '', PEAR_LOG_ERR); |
6a488035 TO |
343 | CRM_Core_Error::backtrace('backTrace', TRUE); |
344 | ||
345 | $details = 'A fatal error was triggered'; | |
346 | if ($message) { | |
347 | $details .= ': ' . $message; | |
2aa397bc | 348 | } |
6a488035 TO |
349 | throw new Exception($details, $code); |
350 | } | |
351 | ||
352 | if (!$message) { | |
be2fb01f | 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']); |
6a488035 TO |
354 | } |
355 | ||
356 | if (php_sapi_name() == "cli") { | |
357 | print ("Sorry. A non-recoverable error has occurred.\n$message \n$code\n$email\n\n"); | |
0c4a3d8b | 358 | // Fix for CRM-16899 |
4c68cf7b | 359 | echo static::formatBacktrace(debug_backtrace()); |
6a488035 TO |
360 | die("\n"); |
361 | // FIXME: Why doesn't this call abend()? | |
362 | // Difference: abend() will cleanup transaction and (via civiExit) store session state | |
363 | // self::abend(CRM_Core_Error::FATAL_ERROR); | |
364 | } | |
365 | ||
366 | $config = CRM_Core_Config::singleton(); | |
367 | ||
368 | if ($config->fatalErrorHandler && | |
369 | function_exists($config->fatalErrorHandler) | |
370 | ) { | |
371 | $name = $config->fatalErrorHandler; | |
372 | $ret = $name($vars); | |
373 | if ($ret) { | |
374 | // the call has been successfully handled | |
375 | // so we just exit | |
376 | self::abend(CRM_Core_Error::FATAL_ERROR); | |
377 | } | |
378 | } | |
379 | ||
25dc2153 PH |
380 | if ($config->backtrace) { |
381 | self::backtrace(); | |
382 | } | |
383 | ||
120f8e64 | 384 | CRM_Core_Error::debug_var('Fatal Error Details', $vars, TRUE, TRUE, '', PEAR_LOG_ERR); |
25dc2153 PH |
385 | CRM_Core_Error::backtrace('backTrace', TRUE); |
386 | ||
34866662 CW |
387 | // If we are in an ajax callback, format output appropriately |
388 | if (CRM_Utils_Array::value('snippet', $_REQUEST) === CRM_Core_Smarty::PRINT_JSON) { | |
be2fb01f | 389 | $out = [ |
34866662 CW |
390 | 'status' => 'fatal', |
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>', | |
be2fb01f | 392 | ]; |
34866662 CW |
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>'; | |
396 | } | |
1528ac1d | 397 | CRM_Core_Session::setStatus($message, ts('Sorry an error occurred'), 'error'); |
34866662 CW |
398 | CRM_Core_Transaction::forceRollbackIfEnabled(); |
399 | CRM_Core_Page_AJAX::returnJsonResponse($out); | |
400 | } | |
401 | ||
6a488035 TO |
402 | $template = CRM_Core_Smarty::singleton(); |
403 | $template->assign($vars); | |
f431d51f | 404 | $config->userSystem->outputError($template->fetch('CRM/common/fatal.tpl')); |
6a488035 TO |
405 | |
406 | self::abend(CRM_Core_Error::FATAL_ERROR); | |
407 | } | |
408 | ||
409 | /** | |
0880a9d0 | 410 | * Display an error page with an error message describing what happened. |
6a488035 TO |
411 | * |
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. | |
415 | * | |
416 | * @param Exception $exception | |
6a488035 | 417 | */ |
00be9182 | 418 | public static function handleUnhandledException($exception) { |
4b57bc9f EM |
419 | try { |
420 | CRM_Utils_Hook::unhandledException($exception); | |
0db6c3e1 TO |
421 | } |
422 | catch (Exception $other) { | |
4b57bc9f | 423 | // if the exception-handler generates an exception, then that sucks! oh, well. carry on. |
120f8e64 | 424 | CRM_Core_Error::debug_var('handleUnhandledException_nestedException', self::formatTextException($other), TRUE, TRUE, '', PEAR_LOG_ERR); |
4b57bc9f | 425 | } |
6a488035 | 426 | $config = CRM_Core_Config::singleton(); |
be2fb01f | 427 | $vars = [ |
6a488035 TO |
428 | 'message' => $exception->getMessage(), |
429 | 'code' => NULL, | |
430 | 'exception' => $exception, | |
be2fb01f | 431 | ]; |
6a488035 | 432 | if (!$vars['message']) { |
be2fb01f | 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']); |
6a488035 TO |
434 | } |
435 | ||
436 | // Case A: CLI | |
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); | |
440 | die("\n"); | |
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); | |
444 | } | |
445 | ||
446 | // Case B: Custom error handler | |
447 | if ($config->fatalErrorHandler && | |
448 | function_exists($config->fatalErrorHandler) | |
449 | ) { | |
450 | $name = $config->fatalErrorHandler; | |
451 | $ret = $name($vars); | |
452 | if ($ret) { | |
453 | // the call has been successfully handled | |
454 | // so we just exit | |
455 | self::abend(CRM_Core_Error::FATAL_ERROR); | |
456 | } | |
457 | } | |
458 | ||
459 | // Case C: Default error handler | |
460 | ||
461 | // log to file | |
120f8e64 | 462 | CRM_Core_Error::debug_var('Fatal Error Details', $vars, FALSE, TRUE, '', PEAR_LOG_ERR); |
6a488035 TO |
463 | CRM_Core_Error::backtrace('backTrace', TRUE); |
464 | ||
465 | // print to screen | |
466 | $template = CRM_Core_Smarty::singleton(); | |
467 | $template->assign($vars); | |
f431d51f | 468 | $content = $template->fetch('CRM/common/fatal.tpl'); |
6a488035 TO |
469 | if ($config->backtrace) { |
470 | $content = self::formatHtmlException($exception) . $content; | |
471 | } | |
472 | if ($config->userFramework == 'Joomla' && | |
473 | class_exists('JError') | |
474 | ) { | |
475 | JError::raiseError('CiviCRM-001', $content); | |
476 | } | |
477 | else { | |
478 | echo CRM_Utils_System::theme($content); | |
479 | } | |
480 | ||
481 | // fin | |
482 | self::abend(CRM_Core_Error::FATAL_ERROR); | |
483 | } | |
484 | ||
485 | /** | |
100fef9d | 486 | * Outputs pre-formatted debug information. Flushes the buffers |
6a488035 TO |
487 | * so we can interrupt a potential POST/redirect |
488 | * | |
3bdca100 | 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 | |
90154ece DL |
494 | * useful when we die during initialization and permissioning |
495 | * subsystem is not initialized - CRM-13765 | |
6a488035 | 496 | * |
a6c01b45 CW |
497 | * @return string |
498 | * the generated output | |
6a488035 | 499 | */ |
00be9182 | 500 | public static function debug($name, $variable = NULL, $log = TRUE, $html = TRUE, $checkPermission = TRUE) { |
6a488035 TO |
501 | $error = self::singleton(); |
502 | ||
503 | if ($variable === NULL) { | |
504 | $variable = $name; | |
505 | $name = NULL; | |
506 | } | |
507 | ||
508 | $out = print_r($variable, TRUE); | |
509 | $prefix = NULL; | |
510 | if ($html) { | |
511 | $out = htmlspecialchars($out); | |
512 | if ($name) { | |
513 | $prefix = "<p>$name</p>"; | |
514 | } | |
515 | $out = "{$prefix}<p><pre>$out</pre></p><p></p>"; | |
516 | } | |
517 | else { | |
518 | if ($name) { | |
519 | $prefix = "$name:\n"; | |
520 | } | |
521 | $out = "{$prefix}$out\n"; | |
522 | } | |
90154ece DL |
523 | if ( |
524 | $log && | |
525 | (!$checkPermission || CRM_Core_Permission::check('view debug output')) | |
526 | ) { | |
6a488035 TO |
527 | echo $out; |
528 | } | |
529 | ||
530 | return $out; | |
531 | } | |
532 | ||
533 | /** | |
534 | * Similar to the function debug. Only difference is | |
535 | * in the formatting of the output. | |
536 | * | |
c490a46a | 537 | * @param string $variable_name |
6b5c5203 | 538 | * Variable name. |
c490a46a | 539 | * @param mixed $variable |
6b5c5203 | 540 | * Variable value. |
6a0b768e | 541 | * @param bool $print |
6b5c5203 | 542 | * Use print_r (if true) or var_dump (if false). |
6a0b768e | 543 | * @param bool $log |
6b5c5203 CB |
544 | * Log or return the output? |
545 | * @param string $prefix | |
546 | * Prefix for output logfile. | |
120f8e64 | 547 | * @param int $priority |
548 | * The log priority level. | |
2a6da8d7 | 549 | * |
a6c01b45 | 550 | * @return string |
6b5c5203 | 551 | * The generated output |
6a488035 TO |
552 | * |
553 | * @see CRM_Core_Error::debug() | |
554 | * @see CRM_Core_Error::debug_log_message() | |
555 | */ | |
120f8e64 | 556 | public static function debug_var($variable_name, $variable, $print = TRUE, $log = TRUE, $prefix = '', $priority = NULL) { |
6a488035 TO |
557 | // check if variable is set |
558 | if (!isset($variable)) { | |
559 | $out = "\$$variable_name is not set"; | |
560 | } | |
561 | else { | |
562 | if ($print) { | |
563 | $out = print_r($variable, TRUE); | |
564 | $out = "\$$variable_name = $out"; | |
565 | } | |
566 | else { | |
567 | // use var_dump | |
568 | ob_start(); | |
569 | var_dump($variable); | |
570 | $dump = ob_get_contents(); | |
571 | ob_end_clean(); | |
572 | $out = "\n\$$variable_name = $dump"; | |
573 | } | |
574 | // reset if it is an array | |
575 | if (is_array($variable)) { | |
576 | reset($variable); | |
577 | } | |
578 | } | |
120f8e64 | 579 | return self::debug_log_message($out, FALSE, $prefix, $priority); |
6a488035 TO |
580 | } |
581 | ||
582 | /** | |
edc8adfc | 583 | * Display the error message on terminal and append it to the log file. |
584 | * | |
585 | * Provided the user has the 'view debug output' the output should be displayed. In all | |
586 | * cases it should be logged. | |
6a488035 | 587 | * |
ea3ddccf | 588 | * @param string $message |
6a0b768e TO |
589 | * @param bool $out |
590 | * Should we log or return the output. | |
6a488035 | 591 | * |
6b5c5203 CB |
592 | * @param string $prefix |
593 | * Message prefix. | |
ea3ddccf | 594 | * @param string $priority |
6a488035 | 595 | * |
ea3ddccf | 596 | * @return string |
597 | * Format of the backtrace | |
6a488035 | 598 | */ |
6b5c5203 | 599 | public static function debug_log_message($message, $out = FALSE, $prefix = '', $priority = NULL) { |
213a5f19 | 600 | $config = CRM_Core_Config::singleton(); |
6a488035 | 601 | |
6b5c5203 | 602 | $file_log = self::createDebugLogger($prefix); |
6e5ad5ee | 603 | $file_log->log("$message\n", $priority); |
0ac9fd52 | 604 | |
9726c118 | 605 | $str = '<p/><code>' . htmlspecialchars($message) . '</code>'; |
6a488035 TO |
606 | if ($out && CRM_Core_Permission::check('view debug output')) { |
607 | echo $str; | |
608 | } | |
609 | $file_log->close(); | |
610 | ||
21ce4627 | 611 | if (!isset(\Civi::$statics[__CLASS__]['userFrameworkLogging'])) { |
612 | // Set it to FALSE first & then try to set it. This is to prevent a loop as calling | |
613 | // $config->userFrameworkLogging can trigger DB queries & under log mode this | |
614 | // then gets called again. | |
615 | \Civi::$statics[__CLASS__]['userFrameworkLogging'] = FALSE; | |
616 | \Civi::$statics[__CLASS__]['userFrameworkLogging'] = $config->userFrameworkLogging; | |
617 | } | |
618 | ||
619 | if (!empty(\Civi::$statics[__CLASS__]['userFrameworkLogging'])) { | |
1fadd891 | 620 | // should call $config->userSystem->logger($message) here - but I got a situation where userSystem was not an object - not sure why |
213a5f19 | 621 | if ($config->userSystem->is_drupal and function_exists('watchdog')) { |
2d3e6c51 | 622 | watchdog('civicrm', '%message', ['%message' => $message], isset($priority) ? $priority : WATCHDOG_DEBUG); |
213a5f19 EM |
623 | } |
624 | } | |
6a488035 TO |
625 | |
626 | return $str; | |
627 | } | |
628 | ||
629 | /** | |
630 | * Append to the query log (if enabled) | |
ad37ac8e | 631 | * |
632 | * @param string $string | |
6a488035 | 633 | */ |
00be9182 | 634 | public static function debug_query($string) { |
481a74f4 | 635 | if (defined('CIVICRM_DEBUG_LOG_QUERY')) { |
7e7d0323 | 636 | if (CIVICRM_DEBUG_LOG_QUERY === 'backtrace') { |
481a74f4 | 637 | CRM_Core_Error::backtrace($string, TRUE); |
0db6c3e1 | 638 | } |
481a74f4 | 639 | elseif (CIVICRM_DEBUG_LOG_QUERY) { |
120f8e64 | 640 | CRM_Core_Error::debug_var('Query', $string, TRUE, TRUE, 'sql_log', PEAR_LOG_DEBUG); |
6a488035 TO |
641 | } |
642 | } | |
643 | } | |
644 | ||
d090b80b TO |
645 | /** |
646 | * Execute a query and log the results. | |
647 | * | |
648 | * @param string $query | |
649 | */ | |
00be9182 | 650 | public static function debug_query_result($query) { |
7d0b8a47 | 651 | $results = CRM_Core_DAO::executeQuery($query)->fetchAll(); |
120f8e64 | 652 | CRM_Core_Error::debug_var('dao result', ['query' => $query, 'results' => $results], TRUE, TRUE, '', PEAR_LOG_DEBUG); |
d090b80b TO |
653 | } |
654 | ||
6a488035 | 655 | /** |
0880a9d0 | 656 | * Obtain a reference to the error log. |
6a488035 | 657 | * |
edc8adfc | 658 | * @param string $prefix |
77b97be7 | 659 | * |
6a488035 TO |
660 | * @return Log |
661 | */ | |
edc8adfc | 662 | public static function createDebugLogger($prefix = '') { |
663 | self::generateLogFileName($prefix); | |
664 | return Log::singleton('file', \Civi::$statics[__CLASS__]['logger_file' . $prefix], ''); | |
665 | } | |
666 | ||
44c32d0a CB |
667 | /** |
668 | * Generate a hash for the logfile. | |
bf48aa29 | 669 | * |
44c32d0a | 670 | * CRM-13640. |
bf48aa29 | 671 | * |
672 | * @param CRM_Core_Config $config | |
673 | * | |
674 | * @return string | |
44c32d0a | 675 | */ |
f0f1e508 CB |
676 | public static function generateLogFileHash($config) { |
677 | // Use multiple (but stable) inputs for hash information. | |
be2fb01f | 678 | $md5inputs = [ |
262e9b08 CB |
679 | defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY : 'NO_SITE_KEY', |
680 | $config->userFrameworkBaseURL, | |
44c32d0a CB |
681 | md5($config->dsn), |
682 | $config->dsn, | |
be2fb01f | 683 | ]; |
262e9b08 CB |
684 | // Trim 8 chars off the string, make it slightly easier to find |
685 | // but reveals less information from the hash. | |
315ca480 | 686 | return substr(md5(var_export($md5inputs, 1)), 8); |
44c32d0a CB |
687 | } |
688 | ||
edc8adfc | 689 | /** |
690 | * Generate the name of the logfile to use and store it as a static. | |
691 | * | |
e047612e CB |
692 | * This function includes simplistic log rotation and a check as to whether |
693 | * the file exists. | |
edc8adfc | 694 | * |
695 | * @param string $prefix | |
696 | */ | |
697 | protected static function generateLogFileName($prefix) { | |
698 | if (!isset(\Civi::$statics[__CLASS__]['logger_file' . $prefix])) { | |
931ba0f3 | 699 | $config = CRM_Core_Config::singleton(); |
6a488035 | 700 | |
edc8adfc | 701 | $prefixString = $prefix ? ($prefix . '.') : ''; |
6a488035 | 702 | |
44c32d0a CB |
703 | $hash = self::generateLogFileHash($config); |
704 | $fileName = $config->configAndLogDir . 'CiviCRM.' . $prefixString . $hash . '.log'; | |
931ba0f3 | 705 | |
e047612e CB |
706 | // Roll log file monthly or if greater than 256M. |
707 | // Size-based rotation introduced in response to filesize limits on | |
708 | // certain OS/PHP combos. | |
931ba0f3 | 709 | if (file_exists($fileName)) { |
710 | $fileTime = date("Ym", filemtime($fileName)); | |
711 | $fileSize = filesize($fileName); | |
712 | if (($fileTime < date('Ym')) || | |
713 | ($fileSize > 256 * 1024 * 1024) || | |
714 | ($fileSize < 0) | |
715 | ) { | |
716 | rename($fileName, | |
717 | $fileName . '.' . date('YmdHi') | |
718 | ); | |
719 | } | |
720 | } | |
edc8adfc | 721 | \Civi::$statics[__CLASS__]['logger_file' . $prefix] = $fileName; |
931ba0f3 | 722 | } |
6a488035 TO |
723 | } |
724 | ||
a0ee3941 EM |
725 | /** |
726 | * @param string $msg | |
727 | * @param bool $log | |
728 | */ | |
00be9182 | 729 | public static function backtrace($msg = 'backTrace', $log = FALSE) { |
6a488035 TO |
730 | $backTrace = debug_backtrace(); |
731 | $message = self::formatBacktrace($backTrace); | |
732 | if (!$log) { | |
733 | CRM_Core_Error::debug($msg, $message); | |
734 | } | |
735 | else { | |
120f8e64 | 736 | CRM_Core_Error::debug_var($msg, $message, TRUE, TRUE, '', PEAR_LOG_DEBUG); |
6a488035 TO |
737 | } |
738 | } | |
739 | ||
740 | /** | |
0880a9d0 | 741 | * Render a backtrace array as a string. |
6a488035 | 742 | * |
6a0b768e TO |
743 | * @param array $backTrace |
744 | * Array of stack frames. | |
745 | * @param bool $showArgs | |
746 | * 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. | |
747 | * @param int $maxArgLen | |
748 | * Maximum number of characters to show from each argument string. | |
a6c01b45 CW |
749 | * @return string |
750 | * printable plain-text | |
6a488035 | 751 | */ |
00be9182 | 752 | public static function formatBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) { |
6a488035 | 753 | $message = ''; |
34866662 CW |
754 | foreach (self::parseBacktrace($backTrace, $showArgs, $maxArgLen) as $idx => $trace) { |
755 | $message .= sprintf("#%s %s\n", $idx, $trace); | |
756 | } | |
2aa397bc | 757 | $message .= sprintf("#%s {main}\n", 1 + $idx); |
34866662 CW |
758 | return $message; |
759 | } | |
760 | ||
761 | /** | |
0880a9d0 | 762 | * Render a backtrace array as an array. |
34866662 | 763 | * |
6a0b768e TO |
764 | * @param array $backTrace |
765 | * Array of stack frames. | |
766 | * @param bool $showArgs | |
767 | * 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. | |
768 | * @param int $maxArgLen | |
769 | * Maximum number of characters to show from each argument string. | |
34866662 CW |
770 | * @return array |
771 | * @see debug_backtrace | |
772 | * @see Exception::getTrace() | |
773 | */ | |
00be9182 | 774 | public static function parseBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) { |
be2fb01f | 775 | $ret = []; |
34866662 | 776 | foreach ($backTrace as $trace) { |
be2fb01f | 777 | $args = []; |
6a488035 | 778 | $fnName = CRM_Utils_Array::value('function', $trace); |
34866662 | 779 | $className = isset($trace['class']) ? ($trace['class'] . $trace['type']) : ''; |
6a488035 | 780 | |
83e7cba6 | 781 | // Do not show args for a few password related functions |
6a488035 TO |
782 | $skipArgs = ($className == 'DB::' && $fnName == 'connect') ? TRUE : FALSE; |
783 | ||
83e7cba6 CB |
784 | if (!empty($trace['args'])) { |
785 | foreach ($trace['args'] as $arg) { | |
353ffa53 | 786 | if (!$showArgs || $skipArgs) { |
83e7cba6 CB |
787 | $args[] = '(' . gettype($arg) . ')'; |
788 | continue; | |
789 | } | |
790 | switch ($type = gettype($arg)) { | |
791 | case 'boolean': | |
792 | $args[] = $arg ? 'TRUE' : 'FALSE'; | |
793 | break; | |
2aa397bc | 794 | |
83e7cba6 CB |
795 | case 'integer': |
796 | case 'double': | |
797 | $args[] = $arg; | |
798 | break; | |
2aa397bc | 799 | |
83e7cba6 | 800 | case 'string': |
86bfa4f6 | 801 | $args[] = '"' . CRM_Utils_String::ellipsify(addcslashes((string) $arg, "\r\n\t\""), $maxArgLen) . '"'; |
83e7cba6 | 802 | break; |
2aa397bc | 803 | |
83e7cba6 | 804 | case 'array': |
92fcb95f | 805 | $args[] = '(Array:' . count($arg) . ')'; |
83e7cba6 | 806 | break; |
2aa397bc | 807 | |
83e7cba6 CB |
808 | case 'object': |
809 | $args[] = 'Object(' . get_class($arg) . ')'; | |
810 | break; | |
2aa397bc | 811 | |
83e7cba6 CB |
812 | case 'resource': |
813 | $args[] = 'Resource'; | |
814 | break; | |
2aa397bc | 815 | |
83e7cba6 CB |
816 | case 'NULL': |
817 | $args[] = 'NULL'; | |
818 | break; | |
2aa397bc | 819 | |
83e7cba6 CB |
820 | default: |
821 | $args[] = "($type)"; | |
822 | break; | |
823 | } | |
6a488035 TO |
824 | } |
825 | } | |
826 | ||
34866662 CW |
827 | $ret[] = sprintf( |
828 | "%s(%s): %s%s(%s)", | |
6a488035 TO |
829 | CRM_Utils_Array::value('file', $trace, '[internal function]'), |
830 | CRM_Utils_Array::value('line', $trace, ''), | |
831 | $className, | |
832 | $fnName, | |
833 | implode(", ", $args) | |
834 | ); | |
835 | } | |
34866662 | 836 | return $ret; |
6a488035 TO |
837 | } |
838 | ||
839 | /** | |
0880a9d0 | 840 | * Render an exception as HTML string. |
6a488035 TO |
841 | * |
842 | * @param Exception $e | |
a6c01b45 CW |
843 | * @return string |
844 | * printable HTML text | |
6a488035 | 845 | */ |
00be9182 | 846 | public static function formatHtmlException(Exception $e) { |
6a488035 TO |
847 | $msg = ''; |
848 | ||
849 | // Exception metadata | |
850 | ||
851 | // Exception backtrace | |
852 | if ($e instanceof PEAR_Exception) { | |
853 | $ei = $e; | |
be2fb01f | 854 | while (is_callable([$ei, 'getCause'])) { |
6a488035 TO |
855 | if ($ei->getCause() instanceof PEAR_Error) { |
856 | $msg .= '<table class="crm-db-error">'; | |
857 | $msg .= sprintf('<thead><tr><th>%s</th><th>%s</th></tr></thead>', ts('Error Field'), ts('Error Value')); | |
858 | $msg .= '<tbody>'; | |
be2fb01f CW |
859 | foreach (['Type', 'Code', 'Message', 'Mode', 'UserInfo', 'DebugInfo'] as $f) { |
860 | $msg .= sprintf('<tr><td>%s</td><td>%s</td></tr>', $f, call_user_func([$ei->getCause(), "get$f"])); | |
2aa397bc | 861 | } |
6a488035 | 862 | $msg .= '</tbody></table>'; |
2aa397bc | 863 | } |
6a488035 | 864 | $ei = $ei->getCause(); |
2aa397bc | 865 | } |
6a488035 | 866 | $msg .= $e->toHtml(); |
0db6c3e1 TO |
867 | } |
868 | else { | |
6a488035 TO |
869 | $msg .= '<p><b>' . get_class($e) . ': "' . htmlentities($e->getMessage()) . '"</b></p>'; |
870 | $msg .= '<pre>' . htmlentities(self::formatBacktrace($e->getTrace())) . '</pre>'; | |
871 | } | |
872 | return $msg; | |
873 | } | |
874 | ||
875 | /** | |
0880a9d0 | 876 | * Write details of an exception to the log. |
6a488035 TO |
877 | * |
878 | * @param Exception $e | |
a6c01b45 CW |
879 | * @return string |
880 | * printable plain text | |
6a488035 | 881 | */ |
00be9182 | 882 | public static function formatTextException(Exception $e) { |
6a488035 TO |
883 | $msg = get_class($e) . ": \"" . $e->getMessage() . "\"\n"; |
884 | ||
885 | $ei = $e; | |
be2fb01f | 886 | while (is_callable([$ei, 'getCause'])) { |
6a488035 | 887 | if ($ei->getCause() instanceof PEAR_Error) { |
be2fb01f CW |
888 | foreach (['Type', 'Code', 'Message', 'Mode', 'UserInfo', 'DebugInfo'] as $f) { |
889 | $msg .= sprintf(" * ERROR %s: %s\n", strtoupper($f), call_user_func([$ei->getCause(), "get$f"])); | |
6a488035 TO |
890 | } |
891 | } | |
892 | $ei = $ei->getCause(); | |
893 | } | |
894 | $msg .= self::formatBacktrace($e->getTrace()); | |
895 | return $msg; | |
896 | } | |
897 | ||
a0ee3941 EM |
898 | /** |
899 | * @param $message | |
900 | * @param int $code | |
901 | * @param string $level | |
100fef9d | 902 | * @param array $params |
a0ee3941 EM |
903 | * |
904 | * @return object | |
905 | */ | |
00be9182 | 906 | public static function createError($message, $code = 8000, $level = 'Fatal', $params = NULL) { |
6a488035 | 907 | $error = CRM_Core_Error::singleton(); |
be2fb01f | 908 | $error->push($code, $level, [$params], $message); |
6a488035 TO |
909 | return $error; |
910 | } | |
911 | ||
912 | /** | |
913 | * Set a status message in the session, then bounce back to the referrer. | |
914 | * | |
6a0b768e TO |
915 | * @param string $status |
916 | * The status message to set. | |
6a488035 | 917 | * |
2a6da8d7 EM |
918 | * @param null $redirect |
919 | * @param string $title | |
6a488035 | 920 | */ |
50ecd413 | 921 | public static function statusBounce($status, $redirect = NULL, $title = NULL) { |
6a488035 TO |
922 | $session = CRM_Core_Session::singleton(); |
923 | if (!$redirect) { | |
924 | $redirect = $session->readUserContext(); | |
925 | } | |
50ecd413 CW |
926 | if ($title === NULL) { |
927 | $title = ts('Error'); | |
928 | } | |
be2fb01f | 929 | $session->setStatus($status, $title, 'alert', ['expires' => 0]); |
34866662 | 930 | if (CRM_Utils_Array::value('snippet', $_REQUEST) === CRM_Core_Smarty::PRINT_JSON) { |
be2fb01f | 931 | CRM_Core_Page_AJAX::returnJsonResponse(['status' => 'error']); |
34866662 | 932 | } |
6a488035 TO |
933 | CRM_Utils_System::redirect($redirect); |
934 | } | |
935 | ||
936 | /** | |
0880a9d0 | 937 | * Reset the error stack. |
6a488035 | 938 | * |
6a488035 TO |
939 | */ |
940 | public static function reset() { | |
941 | $error = self::singleton(); | |
be2fb01f CW |
942 | $error->_errors = []; |
943 | $error->_errorsByLevel = []; | |
6a488035 TO |
944 | } |
945 | ||
6a4257d4 | 946 | /** |
42c0daee TO |
947 | * PEAR error-handler which converts errors to exceptions |
948 | * | |
949 | * @param $pearError | |
950 | * @throws PEAR_Exception | |
6a4257d4 | 951 | */ |
6a488035 | 952 | public static function exceptionHandler($pearError) { |
120f8e64 | 953 | CRM_Core_Error::debug_var('Fatal Error Details', self::getErrorDetails($pearError), TRUE, TRUE, '', PEAR_LOG_ERR); |
6a488035 TO |
954 | CRM_Core_Error::backtrace('backTrace', TRUE); |
955 | throw new PEAR_Exception($pearError->getMessage(), $pearError); | |
956 | } | |
957 | ||
958 | /** | |
42c0daee | 959 | * PEAR error-handler to quietly catch otherwise fatal errors. Intended for use with smtp transport. |
6a488035 | 960 | * |
6a0b768e TO |
961 | * @param object $obj |
962 | * The PEAR_ERROR object. | |
a6c01b45 CW |
963 | * @return object |
964 | * $obj | |
6a488035 TO |
965 | */ |
966 | public static function nullHandler($obj) { | |
120f8e64 | 967 | CRM_Core_Error::debug_log_message("Ignoring exception thrown by nullHandler: {$obj->code}, {$obj->message}", FALSE, '', PEAR_LOG_ERR); |
6a488035 TO |
968 | CRM_Core_Error::backtrace('backTrace', TRUE); |
969 | return $obj; | |
970 | } | |
971 | ||
d424ffde | 972 | /** |
6a488035 TO |
973 | * @deprecated |
974 | * This function is no longer used by v3 api. | |
975 | * @fixme Some core files call it but it should be re-thought & renamed or removed | |
d424ffde | 976 | * |
a0ee3941 EM |
977 | * @param $msg |
978 | * @param null $data | |
979 | * | |
980 | * @return array | |
981 | * @throws Exception | |
982 | */ | |
6a488035 TO |
983 | public static function &createAPIError($msg, $data = NULL) { |
984 | if (self::$modeException) { | |
985 | throw new Exception($msg, $data); | |
986 | } | |
987 | ||
be2fb01f | 988 | $values = []; |
6a488035 TO |
989 | |
990 | $values['is_error'] = 1; | |
991 | $values['error_message'] = $msg; | |
992 | if (isset($data)) { | |
993 | $values = array_merge($values, $data); | |
994 | } | |
995 | return $values; | |
996 | } | |
997 | ||
a0ee3941 EM |
998 | /** |
999 | * @param $file | |
1000 | */ | |
6a488035 TO |
1001 | public static function movedSiteError($file) { |
1002 | $url = CRM_Utils_System::url('civicrm/admin/setting/updateConfigBackend', | |
1003 | 'reset=1', | |
1004 | TRUE | |
1005 | ); | |
1006 | echo "We could not write $file. Have you moved your site directory or server?<p>"; | |
1007 | echo "Please fix the setting by running the <a href=\"$url\">update config script</a>"; | |
1008 | exit(); | |
1009 | } | |
1010 | ||
1011 | /** | |
0880a9d0 | 1012 | * Terminate execution abnormally. |
ad37ac8e | 1013 | * |
1014 | * @param string $code | |
6a488035 TO |
1015 | */ |
1016 | protected static function abend($code) { | |
1017 | // do a hard rollback of any pending transactions | |
1018 | // if we've come here, its because of some unexpected PEAR errors | |
1019 | CRM_Core_Transaction::forceRollbackIfEnabled(); | |
1020 | CRM_Utils_System::civiExit($code); | |
1021 | } | |
1022 | ||
a0ee3941 | 1023 | /** |
3ab5efa9 EM |
1024 | * @param array $error |
1025 | * @param int $type | |
a0ee3941 EM |
1026 | * |
1027 | * @return bool | |
1028 | */ | |
6a488035 | 1029 | public static function isAPIError($error, $type = CRM_Core_Error::FATAL_ERROR) { |
8cc574cf | 1030 | if (is_array($error) && !empty($error['is_error'])) { |
6a488035 TO |
1031 | $code = $error['error_message']['code']; |
1032 | if ($code == $type) { | |
1033 | return TRUE; | |
1034 | } | |
1035 | } | |
1036 | return FALSE; | |
1037 | } | |
96025800 | 1038 | |
496320c3 MW |
1039 | /** |
1040 | * Output a deprecated function warning to log file. Deprecated class:function is automatically generated from calling function. | |
1041 | * | |
1042 | * @param $newMethod | |
1043 | * description of new method (eg. "buildOptions() method in the appropriate BAO object"). | |
1044 | */ | |
1045 | public static function deprecatedFunctionWarning($newMethod) { | |
1046 | $dbt = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2); | |
1047 | $callerFunction = isset($dbt[1]['function']) ? $dbt[1]['function'] : NULL; | |
1048 | $callerClass = isset($dbt[1]['class']) ? $dbt[1]['class'] : NULL; | |
be2fb01f | 1049 | Civi::log()->warning("Deprecated function $callerClass::$callerFunction, use $newMethod.", ['civi.tag' => 'deprecated']); |
496320c3 MW |
1050 | } |
1051 | ||
6a488035 TO |
1052 | } |
1053 | ||
1054 | $e = new PEAR_ErrorStack('CRM'); | |
1055 | $e->singleton('CRM', FALSE, NULL, 'CRM_Core_Error'); |