3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * To ensure that PHP errors or unhandled exceptions are reported in JSON format,
30 * wrap this around your code. For example:
33 * $errorContainer = new CRM_Queue_ErrorPolicy();
34 * $errorContainer->call(function(){
35 * ...include some files, do some work, etc...
39 * Note: Most of the code in this class is pretty generic vis-a-vis error
40 * handling -- except for 'reportError', whose message format is only
41 * appropriate for use with the CRM_Queue_Page_AJAX. Some kind of cleanup
42 * will be necessary to get reuse from the other parts of this class.
44 class CRM_Queue_ErrorPolicy
{
46 function __construct($level = NULL) {
47 register_shutdown_function(array($this, 'onShutdown'));
48 if ($level === NULL) {
49 $level = E_ERROR | E_PARSE | E_CORE_ERROR | E_COMPILE_ERROR | E_USER_ERROR | E_RECOVERABLE_ERROR
;
51 $this->level
= $level;
56 $this->backup
= array();
58 'display_errors', 'html_errors', 'xmlrpc_errors') as $key) {
59 $this->backup
[$key] = ini_get($key);
62 set_error_handler(array($this, 'onError'), $this->level
);
63 // FIXME make this temporary/reversible
64 $this->errorScope
= CRM_Core_TemporaryErrorScope
::useException();
67 function deactivate() {
68 $this->errorScope
= NULL;
69 restore_error_handler();
71 'display_errors', 'html_errors', 'xmlrpc_errors') as $key) {
72 ini_set($key, $this->backup
[$key]);
74 $this->active
= FALSE;
77 function call($callable) {
80 $result = $callable();
83 $this->reportException($e);
90 * Receive (semi) recoverable error notices
92 * @see set_error_handler
94 function onError($errno, $errstr, $errfile, $errline) {
95 if (!(error_reporting() & $errno)) {
98 throw new Exception(sprintf('PHP Error %s at %s:%s: %s', $errno, $errfile, $errline, $errstr));
102 * Receive non-recoverable error notices
104 * @see register_shutdown_function
105 * @see error_get_last
107 function onShutdown() {
108 if (!$this->active
) {
111 $error = error_get_last();
112 if (is_array($error) && ($error['type'] & $this->level
)) {
113 $this->reportError($error);
118 * Print a fatal error
122 function reportError($error) {
126 'exception' => htmlentities(sprintf('Error %s: %s in %s, line %s', $error['type'], $error['message'], $error['file'], $error['line'])),
128 global $activeQueueRunner;
129 if (is_object($activeQueueRunner)) {
130 $response['last_task_title'] = $activeQueueRunner->lastTaskTitle
;
132 CRM_Core_Error
::debug_var('CRM_Queue_ErrorPolicy_reportError', $response);
133 echo json_encode($response);
134 // civiExit() is unnecessary -- we're only called as part of abend
138 * Print an unhandled exception
142 function reportException(Exception
$e) {
143 CRM_Core_Error
::debug_var('CRM_Queue_ErrorPolicy_reportException', CRM_Core_Error
::formatTextException($e));
150 $config = CRM_Core_Config
::singleton();
151 if ($config->backtrace || CRM_Core_Config
::isUpgradeMode()) {
152 $response['exception'] = CRM_Core_Error
::formatHtmlException($e);
155 $response['exception'] = htmlentities($e->getMessage());
158 global $activeQueueRunner;
159 if (is_object($activeQueueRunner)) {
160 $response['last_task_title'] = $activeQueueRunner->lastTaskTitle
;
162 echo json_encode($response);
163 CRM_Utils_System
::civiExit();