Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
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 | |
e7112fa7 | 33 | * @copyright CiviCRM LLC (c) 2004-2015 |
6a488035 TO |
34 | * $Id$ |
35 | * | |
36 | */ | |
37 | ||
38 | require_once 'PEAR/ErrorStack.php'; | |
39 | require_once 'PEAR/Exception.php'; | |
dcc4f6a7 | 40 | require_once 'CRM/Core/Exception.php'; |
6a488035 TO |
41 | |
42 | require_once 'Log.php'; | |
28518c90 EM |
43 | |
44 | /** | |
45 | * Class CRM_Exception | |
46 | */ | |
6a488035 | 47 | class CRM_Exception extends PEAR_Exception { |
b5c2afd0 | 48 | /** |
4f1f1f2a | 49 | * Redefine the exception so message isn't optional |
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 | |
6a488035 TO |
98 | */ |
99 | public static $modeException = NULL; | |
100 | ||
101 | /** | |
100fef9d | 102 | * Singleton function used to manage this object. |
6a488035 | 103 | * |
dd244018 EM |
104 | * @param null $package |
105 | * @param bool $msgCallback | |
106 | * @param bool $contextCallback | |
107 | * @param bool $throwPEAR_Error | |
108 | * @param string $stackClass | |
109 | * | |
6a488035 | 110 | * @return object |
6a488035 | 111 | */ |
2aa397bc | 112 | public static function &singleton($package = NULL, $msgCallback = FALSE, $contextCallback = FALSE, $throwPEAR_Error = FALSE, $stackClass = 'PEAR_ErrorStack') { |
6a488035 TO |
113 | if (self::$_singleton === NULL) { |
114 | self::$_singleton = new CRM_Core_Error('CiviCRM'); | |
115 | } | |
116 | return self::$_singleton; | |
117 | } | |
118 | ||
119 | /** | |
0880a9d0 | 120 | * Constructor. |
6a488035 | 121 | */ |
00be9182 | 122 | public function __construct() { |
6a488035 TO |
123 | parent::__construct('CiviCRM'); |
124 | ||
125 | $log = CRM_Core_Config::getLog(); | |
126 | $this->setLogger($log); | |
127 | ||
128 | // set up error handling for Pear Error Stack | |
129 | $this->setDefaultCallback(array($this, 'handlePES')); | |
130 | } | |
131 | ||
a0ee3941 EM |
132 | /** |
133 | * @param $error | |
134 | * @param string $separator | |
135 | * | |
136 | * @return array|null|string | |
137 | */ | |
93a11cd6 | 138 | static public function getMessages(&$error, $separator = '<br />') { |
6a488035 TO |
139 | if (is_a($error, 'CRM_Core_Error')) { |
140 | $errors = $error->getErrors(); | |
141 | $message = array(); | |
142 | foreach ($errors as $e) { | |
143 | $message[] = $e['code'] . ': ' . $e['message']; | |
144 | } | |
145 | $message = implode($separator, $message); | |
146 | return $message; | |
147 | } | |
148 | return NULL; | |
149 | } | |
150 | ||
dbddfb08 | 151 | /** |
0880a9d0 | 152 | * Status display function specific to payment processor errors. |
dbddfb08 EM |
153 | * @param $error |
154 | * @param string $separator | |
155 | */ | |
00be9182 | 156 | public static function displaySessionError(&$error, $separator = '<br />') { |
6a488035 TO |
157 | $message = self::getMessages($error, $separator); |
158 | if ($message) { | |
159 | $status = ts("Payment Processor Error message") . "{$separator} $message"; | |
160 | $session = CRM_Core_Session::singleton(); | |
161 | $session->setStatus($status); | |
162 | } | |
163 | } | |
164 | ||
165 | /** | |
100fef9d | 166 | * Create the main callback method. this method centralizes error processing. |
6a488035 TO |
167 | * |
168 | * the errors we expect are from the pear modules DB, DB_DataObject | |
169 | * which currently use PEAR::raiseError to notify of error messages. | |
170 | * | |
3bdca100 | 171 | * @param object $pearError PEAR_Error |
6a488035 TO |
172 | * |
173 | * @return void | |
6a488035 TO |
174 | */ |
175 | public static function handle($pearError) { | |
176 | ||
177 | // setup smarty with config, session and template location. | |
178 | $template = CRM_Core_Smarty::singleton(); | |
179 | $config = CRM_Core_Config::singleton(); | |
180 | ||
181 | if ($config->backtrace) { | |
182 | self::backtrace(); | |
183 | } | |
184 | ||
185 | // create the error array | |
353ffa53 TO |
186 | $error = array(); |
187 | $error['callback'] = $pearError->getCallback(); | |
188 | $error['code'] = $pearError->getCode(); | |
189 | $error['message'] = $pearError->getMessage(); | |
190 | $error['mode'] = $pearError->getMode(); | |
6a488035 | 191 | $error['debug_info'] = $pearError->getDebugInfo(); |
353ffa53 TO |
192 | $error['type'] = $pearError->getType(); |
193 | $error['user_info'] = $pearError->getUserInfo(); | |
194 | $error['to_string'] = $pearError->toString(); | |
2e4ade96 TO |
195 | |
196 | // We access connection info via _DB_DATAOBJECT instead | |
197 | // of, e.g., calling getDatabaseConnection(), so that we | |
198 | // can avoid infinite loops. | |
199 | global $_DB_DATAOBJECT; | |
200 | ||
201 | if (!isset($_DB_DATAOBJECT['CONFIG']['database'])) { | |
202 | // we haven't setup sql, so it's not our sql error... | |
203 | } | |
204 | elseif (preg_match('/^mysql:/', $_DB_DATAOBJECT['CONFIG']['database']) && | |
6a488035 TO |
205 | mysql_error() |
206 | ) { | |
207 | $mysql_error = mysql_error() . ', ' . mysql_errno(); | |
208 | $template->assign_by_ref('mysql_code', $mysql_error); | |
209 | ||
210 | // execute a dummy query to clear error stack | |
211 | mysql_query('select 1'); | |
212 | } | |
2e4ade96 | 213 | elseif (preg_match('/^mysqli:/', $_DB_DATAOBJECT['CONFIG']['database'])) { |
6a488035 TO |
214 | $dao = new CRM_Core_DAO(); |
215 | ||
6a488035 TO |
216 | if (isset($_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5])) { |
217 | $conn = $_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5]; | |
218 | $link = $conn->connection; | |
219 | ||
220 | if (mysqli_error($link)) { | |
221 | $mysql_error = mysqli_error($link) . ', ' . mysqli_errno($link); | |
222 | $template->assign_by_ref('mysql_code', $mysql_error); | |
223 | ||
224 | // execute a dummy query to clear error stack | |
225 | mysqli_query($link, 'select 1'); | |
226 | } | |
227 | } | |
228 | } | |
229 | ||
230 | $template->assign_by_ref('error', $error); | |
231 | $errorDetails = CRM_Core_Error::debug('', $error, FALSE); | |
232 | $template->assign_by_ref('errorDetails', $errorDetails); | |
233 | ||
234 | CRM_Core_Error::debug_var('Fatal Error Details', $error); | |
235 | CRM_Core_Error::backtrace('backTrace', TRUE); | |
236 | ||
237 | if ($config->initialized) { | |
238 | $content = $template->fetch('CRM/common/fatal.tpl'); | |
239 | echo CRM_Utils_System::theme($content); | |
240 | } | |
241 | else { | |
242 | echo "Sorry. A non-recoverable error has occurred. The error trace below might help to resolve the issue<p>"; | |
243 | CRM_Core_Error::debug(NULL, $error); | |
244 | } | |
3a210ec0 E |
245 | static $runOnce = FALSE; |
246 | if ($runOnce) { | |
247 | exit; | |
248 | } | |
249 | $runOnce = TRUE; | |
6a488035 TO |
250 | self::abend(1); |
251 | } | |
252 | ||
a0ee3941 | 253 | /** |
4f1f1f2a CW |
254 | * this function is used to trap and print errors |
255 | * during system initialization time. Hence the error | |
256 | * message is quite ugly | |
257 | * | |
a0ee3941 EM |
258 | * @param $pearError |
259 | */ | |
6a488035 TO |
260 | public static function simpleHandler($pearError) { |
261 | ||
262 | // create the error array | |
353ffa53 TO |
263 | $error = array(); |
264 | $error['callback'] = $pearError->getCallback(); | |
265 | $error['code'] = $pearError->getCode(); | |
266 | $error['message'] = $pearError->getMessage(); | |
267 | $error['mode'] = $pearError->getMode(); | |
6a488035 | 268 | $error['debug_info'] = $pearError->getDebugInfo(); |
353ffa53 TO |
269 | $error['type'] = $pearError->getType(); |
270 | $error['user_info'] = $pearError->getUserInfo(); | |
271 | $error['to_string'] = $pearError->toString(); | |
6a488035 | 272 | |
005db542 DL |
273 | // ensure that debug does not check permissions since we are in bootstrap |
274 | // mode and need to print a decent message to help the user | |
90154ece | 275 | CRM_Core_Error::debug('Initialization Error', $error, TRUE, TRUE, FALSE); |
6a488035 TO |
276 | |
277 | // always log the backtrace to a file | |
278 | self::backtrace('backTrace', TRUE); | |
279 | ||
280 | exit(0); | |
281 | } | |
282 | ||
283 | /** | |
284 | * Handle errors raised using the PEAR Error Stack. | |
285 | * | |
286 | * currently the handler just requests the PES framework | |
287 | * to push the error to the stack (return value PEAR_ERRORSTACK_PUSH). | |
288 | * | |
289 | * Note: we can do our own error handling here and return PEAR_ERRORSTACK_IGNORE. | |
290 | * | |
291 | * Also, if we do not return any value the PEAR_ErrorStack::push() then does the | |
292 | * action of PEAR_ERRORSTACK_PUSHANDLOG which displays the errors on the screen, | |
293 | * since the logger set for this error stack is 'display' - see CRM_Core_Config::getLog(); | |
6a488035 TO |
294 | */ |
295 | public static function handlePES($pearError) { | |
296 | return PEAR_ERRORSTACK_PUSH; | |
297 | } | |
298 | ||
299 | /** | |
0880a9d0 | 300 | * Display an error page with an error message describing what happened. |
6a488035 | 301 | * |
6a0b768e TO |
302 | * @param string $message |
303 | * The error message. | |
304 | * @param string $code | |
305 | * The error code if any. | |
306 | * @param string $email | |
307 | * The email address to notify of this situation. | |
77b97be7 EM |
308 | * |
309 | * @throws Exception | |
6a488035 TO |
310 | * |
311 | * @return void | |
6a488035 | 312 | */ |
00be9182 | 313 | public static function fatal($message = NULL, $code = NULL, $email = NULL) { |
6a488035 TO |
314 | $vars = array( |
315 | 'message' => $message, | |
316 | 'code' => $code, | |
317 | ); | |
318 | ||
319 | if (self::$modeException) { | |
320 | // CRM-11043 | |
321 | CRM_Core_Error::debug_var('Fatal Error Details', $vars); | |
322 | CRM_Core_Error::backtrace('backTrace', TRUE); | |
323 | ||
324 | $details = 'A fatal error was triggered'; | |
325 | if ($message) { | |
326 | $details .= ': ' . $message; | |
2aa397bc | 327 | } |
6a488035 TO |
328 | throw new Exception($details, $code); |
329 | } | |
330 | ||
331 | if (!$message) { | |
332 | $message = ts('We experienced an unexpected error. Please post a detailed description and the backtrace on the CiviCRM forums: %1', array(1 => 'http://forum.civicrm.org/')); | |
333 | } | |
334 | ||
335 | if (php_sapi_name() == "cli") { | |
336 | print ("Sorry. A non-recoverable error has occurred.\n$message \n$code\n$email\n\n"); | |
337 | debug_print_backtrace(); | |
338 | die("\n"); | |
339 | // FIXME: Why doesn't this call abend()? | |
340 | // Difference: abend() will cleanup transaction and (via civiExit) store session state | |
341 | // self::abend(CRM_Core_Error::FATAL_ERROR); | |
342 | } | |
343 | ||
344 | $config = CRM_Core_Config::singleton(); | |
345 | ||
346 | if ($config->fatalErrorHandler && | |
347 | function_exists($config->fatalErrorHandler) | |
348 | ) { | |
349 | $name = $config->fatalErrorHandler; | |
350 | $ret = $name($vars); | |
351 | if ($ret) { | |
352 | // the call has been successfully handled | |
353 | // so we just exit | |
354 | self::abend(CRM_Core_Error::FATAL_ERROR); | |
355 | } | |
356 | } | |
357 | ||
25dc2153 PH |
358 | if ($config->backtrace) { |
359 | self::backtrace(); | |
360 | } | |
361 | ||
362 | CRM_Core_Error::debug_var('Fatal Error Details', $vars); | |
363 | CRM_Core_Error::backtrace('backTrace', TRUE); | |
364 | ||
34866662 CW |
365 | // If we are in an ajax callback, format output appropriately |
366 | if (CRM_Utils_Array::value('snippet', $_REQUEST) === CRM_Core_Smarty::PRINT_JSON) { | |
367 | $out = array( | |
368 | 'status' => 'fatal', | |
369 | '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>', | |
370 | ); | |
371 | if ($config->backtrace && CRM_Core_Permission::check('view debug output')) { | |
372 | $out['backtrace'] = self::parseBacktrace(debug_backtrace()); | |
373 | $message .= '<p><em>See console for backtrace</em></p>'; | |
374 | } | |
375 | CRM_Core_Session::setStatus($message, ts('Sorry an Error Occured'), 'error'); | |
376 | CRM_Core_Transaction::forceRollbackIfEnabled(); | |
377 | CRM_Core_Page_AJAX::returnJsonResponse($out); | |
378 | } | |
379 | ||
6a488035 TO |
380 | $template = CRM_Core_Smarty::singleton(); |
381 | $template->assign($vars); | |
382 | ||
f85b1d20 | 383 | $config->userSystem->outputError($template->fetch($config->fatalErrorTemplate)); |
6a488035 TO |
384 | |
385 | self::abend(CRM_Core_Error::FATAL_ERROR); | |
386 | } | |
387 | ||
388 | /** | |
0880a9d0 | 389 | * Display an error page with an error message describing what happened. |
6a488035 TO |
390 | * |
391 | * This function is evil -- it largely replicates fatal(). Hopefully the | |
392 | * entire CRM_Core_Error system can be hollowed out and replaced with | |
393 | * something that follows a cleaner separation of concerns. | |
394 | * | |
395 | * @param Exception $exception | |
396 | * | |
397 | * @return void | |
6a488035 | 398 | */ |
00be9182 | 399 | public static function handleUnhandledException($exception) { |
4b57bc9f EM |
400 | try { |
401 | CRM_Utils_Hook::unhandledException($exception); | |
0db6c3e1 TO |
402 | } |
403 | catch (Exception $other) { | |
4b57bc9f | 404 | // if the exception-handler generates an exception, then that sucks! oh, well. carry on. |
4fd5f07e | 405 | CRM_Core_Error::debug_var('handleUnhandledException_nestedException', self::formatTextException($other)); |
4b57bc9f | 406 | } |
6a488035 TO |
407 | $config = CRM_Core_Config::singleton(); |
408 | $vars = array( | |
409 | 'message' => $exception->getMessage(), | |
410 | 'code' => NULL, | |
411 | 'exception' => $exception, | |
412 | ); | |
413 | if (!$vars['message']) { | |
414 | $vars['message'] = ts('We experienced an unexpected error. Please post a detailed description and the backtrace on the CiviCRM forums: %1', array(1 => 'http://forum.civicrm.org/')); | |
415 | } | |
416 | ||
417 | // Case A: CLI | |
418 | if (php_sapi_name() == "cli") { | |
419 | printf("Sorry. A non-recoverable error has occurred.\n%s\n", $vars['message']); | |
420 | print self::formatTextException($exception); | |
421 | die("\n"); | |
422 | // FIXME: Why doesn't this call abend()? | |
423 | // Difference: abend() will cleanup transaction and (via civiExit) store session state | |
424 | // self::abend(CRM_Core_Error::FATAL_ERROR); | |
425 | } | |
426 | ||
427 | // Case B: Custom error handler | |
428 | if ($config->fatalErrorHandler && | |
429 | function_exists($config->fatalErrorHandler) | |
430 | ) { | |
431 | $name = $config->fatalErrorHandler; | |
432 | $ret = $name($vars); | |
433 | if ($ret) { | |
434 | // the call has been successfully handled | |
435 | // so we just exit | |
436 | self::abend(CRM_Core_Error::FATAL_ERROR); | |
437 | } | |
438 | } | |
439 | ||
440 | // Case C: Default error handler | |
441 | ||
442 | // log to file | |
443 | CRM_Core_Error::debug_var('Fatal Error Details', $vars); | |
444 | CRM_Core_Error::backtrace('backTrace', TRUE); | |
445 | ||
446 | // print to screen | |
447 | $template = CRM_Core_Smarty::singleton(); | |
448 | $template->assign($vars); | |
449 | $content = $template->fetch($config->fatalErrorTemplate); | |
450 | if ($config->backtrace) { | |
451 | $content = self::formatHtmlException($exception) . $content; | |
452 | } | |
453 | if ($config->userFramework == 'Joomla' && | |
454 | class_exists('JError') | |
455 | ) { | |
456 | JError::raiseError('CiviCRM-001', $content); | |
457 | } | |
458 | else { | |
459 | echo CRM_Utils_System::theme($content); | |
460 | } | |
461 | ||
462 | // fin | |
463 | self::abend(CRM_Core_Error::FATAL_ERROR); | |
464 | } | |
465 | ||
466 | /** | |
100fef9d | 467 | * Outputs pre-formatted debug information. Flushes the buffers |
6a488035 TO |
468 | * so we can interrupt a potential POST/redirect |
469 | * | |
3bdca100 | 470 | * @param string $name name of debug section |
471 | * @param $variable mixed reference to variables that we need a trace of | |
472 | * @param bool $log should we log or return the output | |
473 | * @param bool $html whether to generate a HTML-escaped output | |
474 | * @param bool $checkPermission should we check permissions before displaying output | |
90154ece DL |
475 | * useful when we die during initialization and permissioning |
476 | * subsystem is not initialized - CRM-13765 | |
6a488035 | 477 | * |
a6c01b45 CW |
478 | * @return string |
479 | * the generated output | |
6a488035 | 480 | */ |
00be9182 | 481 | public static function debug($name, $variable = NULL, $log = TRUE, $html = TRUE, $checkPermission = TRUE) { |
6a488035 TO |
482 | $error = self::singleton(); |
483 | ||
484 | if ($variable === NULL) { | |
485 | $variable = $name; | |
486 | $name = NULL; | |
487 | } | |
488 | ||
489 | $out = print_r($variable, TRUE); | |
490 | $prefix = NULL; | |
491 | if ($html) { | |
492 | $out = htmlspecialchars($out); | |
493 | if ($name) { | |
494 | $prefix = "<p>$name</p>"; | |
495 | } | |
496 | $out = "{$prefix}<p><pre>$out</pre></p><p></p>"; | |
497 | } | |
498 | else { | |
499 | if ($name) { | |
500 | $prefix = "$name:\n"; | |
501 | } | |
502 | $out = "{$prefix}$out\n"; | |
503 | } | |
90154ece DL |
504 | if ( |
505 | $log && | |
506 | (!$checkPermission || CRM_Core_Permission::check('view debug output')) | |
507 | ) { | |
6a488035 TO |
508 | echo $out; |
509 | } | |
510 | ||
511 | return $out; | |
512 | } | |
513 | ||
514 | /** | |
515 | * Similar to the function debug. Only difference is | |
516 | * in the formatting of the output. | |
517 | * | |
c490a46a CW |
518 | * @param string $variable_name |
519 | * @param mixed $variable | |
6a0b768e TO |
520 | * @param bool $print |
521 | * Should we use print_r ? (else we use var_dump). | |
522 | * @param bool $log | |
523 | * Should we log or return the output. | |
524 | * @param string $comp | |
525 | * Variable name. | |
2a6da8d7 | 526 | * |
a6c01b45 CW |
527 | * @return string |
528 | * the generated output | |
6a488035 | 529 | * |
6a488035 | 530 | * |
6a488035 TO |
531 | * |
532 | * @see CRM_Core_Error::debug() | |
533 | * @see CRM_Core_Error::debug_log_message() | |
534 | */ | |
3bdca100 | 535 | public static function debug_var( |
f9f40af3 | 536 | $variable_name, |
6a488035 TO |
537 | $variable, |
538 | $print = TRUE, | |
2aa397bc TO |
539 | $log = TRUE, |
540 | $comp = '' | |
6a488035 TO |
541 | ) { |
542 | // check if variable is set | |
543 | if (!isset($variable)) { | |
544 | $out = "\$$variable_name is not set"; | |
545 | } | |
546 | else { | |
547 | if ($print) { | |
548 | $out = print_r($variable, TRUE); | |
549 | $out = "\$$variable_name = $out"; | |
550 | } | |
551 | else { | |
552 | // use var_dump | |
553 | ob_start(); | |
554 | var_dump($variable); | |
555 | $dump = ob_get_contents(); | |
556 | ob_end_clean(); | |
557 | $out = "\n\$$variable_name = $dump"; | |
558 | } | |
559 | // reset if it is an array | |
560 | if (is_array($variable)) { | |
561 | reset($variable); | |
562 | } | |
563 | } | |
564 | return self::debug_log_message($out, FALSE, $comp); | |
565 | } | |
566 | ||
567 | /** | |
0880a9d0 | 568 | * Display the error message on terminal. |
6a488035 | 569 | * |
2a6da8d7 | 570 | * @param $message |
6a0b768e TO |
571 | * @param bool $out |
572 | * Should we log or return the output. | |
6a488035 | 573 | * |
6a0b768e TO |
574 | * @param string $comp |
575 | * Message to be output. | |
a6c01b45 CW |
576 | * @return string |
577 | * format of the backtrace | |
6a488035 | 578 | * |
6a488035 | 579 | * |
6a488035 | 580 | */ |
00be9182 | 581 | public static function debug_log_message($message, $out = FALSE, $comp = '') { |
213a5f19 | 582 | $config = CRM_Core_Config::singleton(); |
6a488035 TO |
583 | |
584 | $file_log = self::createDebugLogger($comp); | |
585 | $file_log->log("$message\n"); | |
586 | $str = "<p/><code>$message</code>"; | |
587 | if ($out && CRM_Core_Permission::check('view debug output')) { | |
588 | echo $str; | |
589 | } | |
590 | $file_log->close(); | |
591 | ||
213a5f19 | 592 | if ($config->userFrameworkLogging) { |
1fadd891 | 593 | // should call $config->userSystem->logger($message) here - but I got a situation where userSystem was not an object - not sure why |
213a5f19 | 594 | if ($config->userSystem->is_drupal and function_exists('watchdog')) { |
eb9dd128 | 595 | watchdog('civicrm', '%message', array('%message' => $message), WATCHDOG_DEBUG); |
213a5f19 EM |
596 | } |
597 | } | |
6a488035 TO |
598 | |
599 | return $str; | |
600 | } | |
601 | ||
602 | /** | |
603 | * Append to the query log (if enabled) | |
604 | */ | |
00be9182 | 605 | public static function debug_query($string) { |
481a74f4 TO |
606 | if (defined('CIVICRM_DEBUG_LOG_QUERY')) { |
607 | if (CIVICRM_DEBUG_LOG_QUERY == 'backtrace') { | |
608 | CRM_Core_Error::backtrace($string, TRUE); | |
0db6c3e1 | 609 | } |
481a74f4 TO |
610 | elseif (CIVICRM_DEBUG_LOG_QUERY) { |
611 | CRM_Core_Error::debug_var('Query', $string, FALSE, TRUE); | |
6a488035 TO |
612 | } |
613 | } | |
614 | } | |
615 | ||
d090b80b TO |
616 | /** |
617 | * Execute a query and log the results. | |
618 | * | |
619 | * @param string $query | |
620 | */ | |
00be9182 | 621 | public static function debug_query_result($query) { |
d090b80b TO |
622 | $dao = CRM_Core_DAO::executeQuery($query); |
623 | $results = array(); | |
624 | while ($dao->fetch()) { | |
2aa397bc | 625 | $results[] = (array) $dao; |
d090b80b TO |
626 | } |
627 | CRM_Core_Error::debug_var('dao result', array('query' => $query, 'results' => $results)); | |
628 | } | |
629 | ||
6a488035 | 630 | /** |
0880a9d0 | 631 | * Obtain a reference to the error log. |
6a488035 | 632 | * |
77b97be7 EM |
633 | * @param string $comp |
634 | * | |
6a488035 TO |
635 | * @return Log |
636 | */ | |
00be9182 | 637 | public static function createDebugLogger($comp = '') { |
6a488035 TO |
638 | $config = CRM_Core_Config::singleton(); |
639 | ||
640 | if ($comp) { | |
641 | $comp = $comp . '.'; | |
642 | } | |
643 | ||
644 | $fileName = "{$config->configAndLogDir}CiviCRM." . $comp . md5($config->dsn) . '.log'; | |
645 | ||
646 | // Roll log file monthly or if greater than 256M | |
647 | // note that PHP file functions have a limit of 2G and hence | |
648 | // the alternative was introduce | |
649 | if (file_exists($fileName)) { | |
650 | $fileTime = date("Ym", filemtime($fileName)); | |
651 | $fileSize = filesize($fileName); | |
652 | if (($fileTime < date('Ym')) || | |
653 | ($fileSize > 256 * 1024 * 1024) || | |
654 | ($fileSize < 0) | |
655 | ) { | |
656 | rename($fileName, | |
dafad154 | 657 | $fileName . '.' . date('YmdHi') |
6a488035 TO |
658 | ); |
659 | } | |
660 | } | |
661 | ||
662 | return Log::singleton('file', $fileName); | |
663 | } | |
664 | ||
a0ee3941 EM |
665 | /** |
666 | * @param string $msg | |
667 | * @param bool $log | |
668 | */ | |
00be9182 | 669 | public static function backtrace($msg = 'backTrace', $log = FALSE) { |
6a488035 TO |
670 | $backTrace = debug_backtrace(); |
671 | $message = self::formatBacktrace($backTrace); | |
672 | if (!$log) { | |
673 | CRM_Core_Error::debug($msg, $message); | |
674 | } | |
675 | else { | |
676 | CRM_Core_Error::debug_var($msg, $message); | |
677 | } | |
678 | } | |
679 | ||
680 | /** | |
0880a9d0 | 681 | * Render a backtrace array as a string. |
6a488035 | 682 | * |
6a0b768e TO |
683 | * @param array $backTrace |
684 | * Array of stack frames. | |
685 | * @param bool $showArgs | |
686 | * 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. | |
687 | * @param int $maxArgLen | |
688 | * Maximum number of characters to show from each argument string. | |
a6c01b45 CW |
689 | * @return string |
690 | * printable plain-text | |
6a488035 | 691 | */ |
00be9182 | 692 | public static function formatBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) { |
6a488035 | 693 | $message = ''; |
34866662 CW |
694 | foreach (self::parseBacktrace($backTrace, $showArgs, $maxArgLen) as $idx => $trace) { |
695 | $message .= sprintf("#%s %s\n", $idx, $trace); | |
696 | } | |
2aa397bc | 697 | $message .= sprintf("#%s {main}\n", 1 + $idx); |
34866662 CW |
698 | return $message; |
699 | } | |
700 | ||
701 | /** | |
0880a9d0 | 702 | * Render a backtrace array as an array. |
34866662 | 703 | * |
6a0b768e TO |
704 | * @param array $backTrace |
705 | * Array of stack frames. | |
706 | * @param bool $showArgs | |
707 | * 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. | |
708 | * @param int $maxArgLen | |
709 | * Maximum number of characters to show from each argument string. | |
34866662 CW |
710 | * @return array |
711 | * @see debug_backtrace | |
712 | * @see Exception::getTrace() | |
713 | */ | |
00be9182 | 714 | public static function parseBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) { |
34866662 CW |
715 | $ret = array(); |
716 | foreach ($backTrace as $trace) { | |
6a488035 TO |
717 | $args = array(); |
718 | $fnName = CRM_Utils_Array::value('function', $trace); | |
34866662 | 719 | $className = isset($trace['class']) ? ($trace['class'] . $trace['type']) : ''; |
6a488035 | 720 | |
83e7cba6 | 721 | // Do not show args for a few password related functions |
6a488035 TO |
722 | $skipArgs = ($className == 'DB::' && $fnName == 'connect') ? TRUE : FALSE; |
723 | ||
83e7cba6 CB |
724 | if (!empty($trace['args'])) { |
725 | foreach ($trace['args'] as $arg) { | |
353ffa53 | 726 | if (!$showArgs || $skipArgs) { |
83e7cba6 CB |
727 | $args[] = '(' . gettype($arg) . ')'; |
728 | continue; | |
729 | } | |
730 | switch ($type = gettype($arg)) { | |
731 | case 'boolean': | |
732 | $args[] = $arg ? 'TRUE' : 'FALSE'; | |
733 | break; | |
2aa397bc | 734 | |
83e7cba6 CB |
735 | case 'integer': |
736 | case 'double': | |
737 | $args[] = $arg; | |
738 | break; | |
2aa397bc | 739 | |
83e7cba6 | 740 | case 'string': |
86bfa4f6 | 741 | $args[] = '"' . CRM_Utils_String::ellipsify(addcslashes((string) $arg, "\r\n\t\""), $maxArgLen) . '"'; |
83e7cba6 | 742 | break; |
2aa397bc | 743 | |
83e7cba6 | 744 | case 'array': |
92fcb95f | 745 | $args[] = '(Array:' . count($arg) . ')'; |
83e7cba6 | 746 | break; |
2aa397bc | 747 | |
83e7cba6 CB |
748 | case 'object': |
749 | $args[] = 'Object(' . get_class($arg) . ')'; | |
750 | break; | |
2aa397bc | 751 | |
83e7cba6 CB |
752 | case 'resource': |
753 | $args[] = 'Resource'; | |
754 | break; | |
2aa397bc | 755 | |
83e7cba6 CB |
756 | case 'NULL': |
757 | $args[] = 'NULL'; | |
758 | break; | |
2aa397bc | 759 | |
83e7cba6 CB |
760 | default: |
761 | $args[] = "($type)"; | |
762 | break; | |
763 | } | |
6a488035 TO |
764 | } |
765 | } | |
766 | ||
34866662 CW |
767 | $ret[] = sprintf( |
768 | "%s(%s): %s%s(%s)", | |
6a488035 TO |
769 | CRM_Utils_Array::value('file', $trace, '[internal function]'), |
770 | CRM_Utils_Array::value('line', $trace, ''), | |
771 | $className, | |
772 | $fnName, | |
773 | implode(", ", $args) | |
774 | ); | |
775 | } | |
34866662 | 776 | return $ret; |
6a488035 TO |
777 | } |
778 | ||
779 | /** | |
0880a9d0 | 780 | * Render an exception as HTML string. |
6a488035 TO |
781 | * |
782 | * @param Exception $e | |
a6c01b45 CW |
783 | * @return string |
784 | * printable HTML text | |
6a488035 | 785 | */ |
00be9182 | 786 | public static function formatHtmlException(Exception $e) { |
6a488035 TO |
787 | $msg = ''; |
788 | ||
789 | // Exception metadata | |
790 | ||
791 | // Exception backtrace | |
792 | if ($e instanceof PEAR_Exception) { | |
793 | $ei = $e; | |
794 | while (is_callable(array($ei, 'getCause'))) { | |
795 | if ($ei->getCause() instanceof PEAR_Error) { | |
796 | $msg .= '<table class="crm-db-error">'; | |
797 | $msg .= sprintf('<thead><tr><th>%s</th><th>%s</th></tr></thead>', ts('Error Field'), ts('Error Value')); | |
798 | $msg .= '<tbody>'; | |
799 | foreach (array('Type', 'Code', 'Message', 'Mode', 'UserInfo', 'DebugInfo') as $f) { | |
800 | $msg .= sprintf('<tr><td>%s</td><td>%s</td></tr>', $f, call_user_func(array($ei->getCause(), "get$f"))); | |
2aa397bc | 801 | } |
6a488035 | 802 | $msg .= '</tbody></table>'; |
2aa397bc | 803 | } |
6a488035 | 804 | $ei = $ei->getCause(); |
2aa397bc | 805 | } |
6a488035 | 806 | $msg .= $e->toHtml(); |
0db6c3e1 TO |
807 | } |
808 | else { | |
6a488035 TO |
809 | $msg .= '<p><b>' . get_class($e) . ': "' . htmlentities($e->getMessage()) . '"</b></p>'; |
810 | $msg .= '<pre>' . htmlentities(self::formatBacktrace($e->getTrace())) . '</pre>'; | |
811 | } | |
812 | return $msg; | |
813 | } | |
814 | ||
815 | /** | |
0880a9d0 | 816 | * Write details of an exception to the log. |
6a488035 TO |
817 | * |
818 | * @param Exception $e | |
a6c01b45 CW |
819 | * @return string |
820 | * printable plain text | |
6a488035 | 821 | */ |
00be9182 | 822 | public static function formatTextException(Exception $e) { |
6a488035 TO |
823 | $msg = get_class($e) . ": \"" . $e->getMessage() . "\"\n"; |
824 | ||
825 | $ei = $e; | |
826 | while (is_callable(array($ei, 'getCause'))) { | |
827 | if ($ei->getCause() instanceof PEAR_Error) { | |
828 | foreach (array('Type', 'Code', 'Message', 'Mode', 'UserInfo', 'DebugInfo') as $f) { | |
829 | $msg .= sprintf(" * ERROR %s: %s\n", strtoupper($f), call_user_func(array($ei->getCause(), "get$f"))); | |
830 | } | |
831 | } | |
832 | $ei = $ei->getCause(); | |
833 | } | |
834 | $msg .= self::formatBacktrace($e->getTrace()); | |
835 | return $msg; | |
836 | } | |
837 | ||
a0ee3941 EM |
838 | /** |
839 | * @param $message | |
840 | * @param int $code | |
841 | * @param string $level | |
100fef9d | 842 | * @param array $params |
a0ee3941 EM |
843 | * |
844 | * @return object | |
845 | */ | |
00be9182 | 846 | public static function createError($message, $code = 8000, $level = 'Fatal', $params = NULL) { |
6a488035 TO |
847 | $error = CRM_Core_Error::singleton(); |
848 | $error->push($code, $level, array($params), $message); | |
849 | return $error; | |
850 | } | |
851 | ||
852 | /** | |
853 | * Set a status message in the session, then bounce back to the referrer. | |
854 | * | |
6a0b768e TO |
855 | * @param string $status |
856 | * The status message to set. | |
6a488035 | 857 | * |
2a6da8d7 EM |
858 | * @param null $redirect |
859 | * @param string $title | |
6a488035 | 860 | * @return void |
6a488035 | 861 | */ |
50ecd413 | 862 | public static function statusBounce($status, $redirect = NULL, $title = NULL) { |
6a488035 TO |
863 | $session = CRM_Core_Session::singleton(); |
864 | if (!$redirect) { | |
865 | $redirect = $session->readUserContext(); | |
866 | } | |
50ecd413 CW |
867 | if ($title === NULL) { |
868 | $title = ts('Error'); | |
869 | } | |
870 | $session->setStatus($status, $title, 'alert', array('expires' => 0)); | |
34866662 CW |
871 | if (CRM_Utils_Array::value('snippet', $_REQUEST) === CRM_Core_Smarty::PRINT_JSON) { |
872 | CRM_Core_Page_AJAX::returnJsonResponse(array('status' => 'error')); | |
873 | } | |
6a488035 TO |
874 | CRM_Utils_System::redirect($redirect); |
875 | } | |
876 | ||
877 | /** | |
0880a9d0 | 878 | * Reset the error stack. |
6a488035 | 879 | * |
6a488035 TO |
880 | */ |
881 | public static function reset() { | |
882 | $error = self::singleton(); | |
883 | $error->_errors = array(); | |
884 | $error->_errorsByLevel = array(); | |
885 | } | |
886 | ||
6a4257d4 | 887 | /** |
42c0daee TO |
888 | * PEAR error-handler which converts errors to exceptions |
889 | * | |
890 | * @param $pearError | |
891 | * @throws PEAR_Exception | |
6a4257d4 | 892 | */ |
6a488035 TO |
893 | public static function exceptionHandler($pearError) { |
894 | CRM_Core_Error::backtrace('backTrace', TRUE); | |
895 | throw new PEAR_Exception($pearError->getMessage(), $pearError); | |
896 | } | |
897 | ||
898 | /** | |
42c0daee | 899 | * PEAR error-handler to quietly catch otherwise fatal errors. Intended for use with smtp transport. |
6a488035 | 900 | * |
6a0b768e TO |
901 | * @param object $obj |
902 | * The PEAR_ERROR object. | |
a6c01b45 CW |
903 | * @return object |
904 | * $obj | |
6a488035 TO |
905 | */ |
906 | public static function nullHandler($obj) { | |
907 | CRM_Core_Error::debug_log_message("Ignoring exception thrown by nullHandler: {$obj->code}, {$obj->message}"); | |
908 | CRM_Core_Error::backtrace('backTrace', TRUE); | |
909 | return $obj; | |
910 | } | |
911 | ||
d424ffde | 912 | /** |
6a488035 TO |
913 | * @deprecated |
914 | * This function is no longer used by v3 api. | |
915 | * @fixme Some core files call it but it should be re-thought & renamed or removed | |
d424ffde | 916 | * |
a0ee3941 EM |
917 | * @param $msg |
918 | * @param null $data | |
919 | * | |
920 | * @return array | |
921 | * @throws Exception | |
922 | */ | |
6a488035 TO |
923 | public static function &createAPIError($msg, $data = NULL) { |
924 | if (self::$modeException) { | |
925 | throw new Exception($msg, $data); | |
926 | } | |
927 | ||
928 | $values = array(); | |
929 | ||
930 | $values['is_error'] = 1; | |
931 | $values['error_message'] = $msg; | |
932 | if (isset($data)) { | |
933 | $values = array_merge($values, $data); | |
934 | } | |
935 | return $values; | |
936 | } | |
937 | ||
a0ee3941 EM |
938 | /** |
939 | * @param $file | |
940 | */ | |
6a488035 TO |
941 | public static function movedSiteError($file) { |
942 | $url = CRM_Utils_System::url('civicrm/admin/setting/updateConfigBackend', | |
943 | 'reset=1', | |
944 | TRUE | |
945 | ); | |
946 | echo "We could not write $file. Have you moved your site directory or server?<p>"; | |
947 | echo "Please fix the setting by running the <a href=\"$url\">update config script</a>"; | |
948 | exit(); | |
949 | } | |
950 | ||
951 | /** | |
0880a9d0 | 952 | * Terminate execution abnormally. |
6a488035 TO |
953 | */ |
954 | protected static function abend($code) { | |
955 | // do a hard rollback of any pending transactions | |
956 | // if we've come here, its because of some unexpected PEAR errors | |
957 | CRM_Core_Transaction::forceRollbackIfEnabled(); | |
958 | CRM_Utils_System::civiExit($code); | |
959 | } | |
960 | ||
a0ee3941 | 961 | /** |
3ab5efa9 EM |
962 | * @param array $error |
963 | * @param int $type | |
a0ee3941 EM |
964 | * |
965 | * @return bool | |
966 | */ | |
6a488035 | 967 | public static function isAPIError($error, $type = CRM_Core_Error::FATAL_ERROR) { |
8cc574cf | 968 | if (is_array($error) && !empty($error['is_error'])) { |
6a488035 TO |
969 | $code = $error['error_message']['code']; |
970 | if ($code == $type) { | |
971 | return TRUE; | |
972 | } | |
973 | } | |
974 | return FALSE; | |
975 | } | |
96025800 | 976 | |
6a488035 TO |
977 | } |
978 | ||
979 | $e = new PEAR_ErrorStack('CRM'); | |
980 | $e->singleton('CRM', FALSE, NULL, 'CRM_Core_Error'); |