CRM/Queue/ErrorPolicy.php

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