Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
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 | /** | |
4523a2f5 TO |
29 | * To ensure that PHP errors or unhandled exceptions are reported in JSON |
30 | * format, wrap this around your code. For example: | |
6a488035 TO |
31 | * |
32 | * @code | |
33 | * $errorContainer = new CRM_Queue_ErrorPolicy(); | |
9b873358 | 34 | * $errorContainer->call(function() { |
6a488035 TO |
35 | * ...include some files, do some work, etc... |
36 | * }); | |
37 | * @endcode | |
38 | * | |
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. | |
43 | */ | |
44 | class CRM_Queue_ErrorPolicy { | |
4523a2f5 | 45 | public $active; |
e0ef6999 EM |
46 | |
47 | /** | |
4523a2f5 TO |
48 | * @param null|int $level |
49 | * PHP error level to capture (e.g. E_PARSE|E_USER_ERROR). | |
e0ef6999 | 50 | */ |
4523a2f5 | 51 | public function __construct($level = NULL) { |
6a488035 TO |
52 | register_shutdown_function(array($this, 'onShutdown')); |
53 | if ($level === NULL) { | |
54 | $level = E_ERROR | E_PARSE | E_CORE_ERROR | E_COMPILE_ERROR | E_USER_ERROR | E_RECOVERABLE_ERROR; | |
55 | } | |
56 | $this->level = $level; | |
57 | } | |
58 | ||
4523a2f5 TO |
59 | /** |
60 | * Enable the error policy. | |
61 | */ | |
62 | public function activate() { | |
6a488035 TO |
63 | $this->active = TRUE; |
64 | $this->backup = array(); | |
65 | foreach (array( | |
353ffa53 TO |
66 | 'display_errors', |
67 | 'html_errors', | |
28a04ea9 | 68 | 'xmlrpc_errors', |
353ffa53 | 69 | ) as $key) { |
6a488035 TO |
70 | $this->backup[$key] = ini_get($key); |
71 | ini_set($key, 0); | |
72 | } | |
73 | set_error_handler(array($this, 'onError'), $this->level); | |
74 | // FIXME make this temporary/reversible | |
75 | $this->errorScope = CRM_Core_TemporaryErrorScope::useException(); | |
76 | } | |
77 | ||
4523a2f5 TO |
78 | /** |
79 | * Disable the error policy. | |
80 | */ | |
81 | public function deactivate() { | |
6a488035 TO |
82 | $this->errorScope = NULL; |
83 | restore_error_handler(); | |
84 | foreach (array( | |
353ffa53 TO |
85 | 'display_errors', |
86 | 'html_errors', | |
28a04ea9 | 87 | 'xmlrpc_errors', |
353ffa53 | 88 | ) as $key) { |
6a488035 TO |
89 | ini_set($key, $this->backup[$key]); |
90 | } | |
91 | $this->active = FALSE; | |
92 | } | |
93 | ||
e0ef6999 | 94 | /** |
4523a2f5 TO |
95 | * Execute the callable. Activate and deactivate the error policy |
96 | * automatically. | |
97 | * | |
98 | * @param callable|array|string $callable | |
99 | * A callback function. | |
e0ef6999 EM |
100 | * |
101 | * @return mixed | |
102 | */ | |
4523a2f5 | 103 | public function call($callable) { |
6a488035 TO |
104 | $this->activate(); |
105 | try { | |
106 | $result = $callable(); | |
107 | } | |
353ffa53 | 108 | catch (Exception$e) { |
6a488035 TO |
109 | $this->reportException($e); |
110 | } | |
111 | $this->deactivate(); | |
112 | return $result; | |
113 | } | |
114 | ||
115 | /** | |
116 | * Receive (semi) recoverable error notices | |
117 | * | |
118 | * @see set_error_handler | |
119 | */ | |
4523a2f5 | 120 | public function onError($errno, $errstr, $errfile, $errline) { |
6a488035 TO |
121 | if (!(error_reporting() & $errno)) { |
122 | return TRUE; | |
123 | } | |
124 | throw new Exception(sprintf('PHP Error %s at %s:%s: %s', $errno, $errfile, $errline, $errstr)); | |
125 | } | |
126 | ||
127 | /** | |
128 | * Receive non-recoverable error notices | |
129 | * | |
130 | * @see register_shutdown_function | |
131 | * @see error_get_last | |
132 | */ | |
4523a2f5 | 133 | public function onShutdown() { |
6a488035 TO |
134 | if (!$this->active) { |
135 | return; | |
136 | } | |
137 | $error = error_get_last(); | |
138 | if (is_array($error) && ($error['type'] & $this->level)) { | |
139 | $this->reportError($error); | |
140 | } | |
141 | } | |
142 | ||
143 | /** | |
fe482240 | 144 | * Print a fatal error. |
6a488035 | 145 | * |
4523a2f5 TO |
146 | * @param array $error |
147 | * The PHP error (with "type", "message", etc). | |
6a488035 | 148 | */ |
4523a2f5 | 149 | public function reportError($error) { |
6a488035 TO |
150 | $response = array( |
151 | 'is_error' => 1, | |
152 | 'is_continue' => 0, | |
153 | 'exception' => htmlentities(sprintf('Error %s: %s in %s, line %s', $error['type'], $error['message'], $error['file'], $error['line'])), | |
154 | ); | |
155 | global $activeQueueRunner; | |
156 | if (is_object($activeQueueRunner)) { | |
157 | $response['last_task_title'] = $activeQueueRunner->lastTaskTitle; | |
158 | } | |
159 | CRM_Core_Error::debug_var('CRM_Queue_ErrorPolicy_reportError', $response); | |
160 | echo json_encode($response); | |
161 | // civiExit() is unnecessary -- we're only called as part of abend | |
162 | } | |
163 | ||
164 | /** | |
fe482240 | 165 | * Print an unhandled exception. |
6a488035 | 166 | * |
4523a2f5 TO |
167 | * @param Exception $e |
168 | * The unhandled exception. | |
6a488035 | 169 | */ |
4523a2f5 | 170 | public function reportException(Exception $e) { |
6a488035 TO |
171 | CRM_Core_Error::debug_var('CRM_Queue_ErrorPolicy_reportException', CRM_Core_Error::formatTextException($e)); |
172 | ||
173 | $response = array( | |
174 | 'is_error' => 1, | |
175 | 'is_continue' => 0, | |
176 | ); | |
177 | ||
178 | $config = CRM_Core_Config::singleton(); | |
179 | if ($config->backtrace || CRM_Core_Config::isUpgradeMode()) { | |
180 | $response['exception'] = CRM_Core_Error::formatHtmlException($e); | |
181 | } | |
182 | else { | |
183 | $response['exception'] = htmlentities($e->getMessage()); | |
184 | } | |
185 | ||
186 | global $activeQueueRunner; | |
187 | if (is_object($activeQueueRunner)) { | |
188 | $response['last_task_title'] = $activeQueueRunner->lastTaskTitle; | |
189 | } | |
ecdef330 | 190 | CRM_Utils_JSON::output($response); |
6a488035 | 191 | } |
96025800 | 192 | |
6a488035 | 193 | } |