!message
' . format_backtrace($backtrace) . ''; - } - drupal_set_message($message, $class, TRUE); + + drupal_set_message($message_output, $class); } if ($fatal) { @@ -279,9 +303,7 @@ function _drupal_log_error($error, $fatal = FALSE) { $output = theme('maintenance_page', array('content' => 'The website has encountered an error. Please try again later.')); $response = new Response($output, 500); - if ($fatal) { - $response->setStatusCode(500, '500 Service unavailable (with message)'); - } + $response->setStatusCode(500, '500 Service unavailable (with message)'); return $response; } @@ -349,38 +371,153 @@ function _drupal_get_last_caller(&$backtrace) { } /** - * Formats a backtrace into a plain-text string. + * We don't want to call watchdog if anywhere in the array there is a PDOException + * since PHP won't let us log a PDOException back to the DB. The function will + * check for the exception and return TRUE if it finds it in an array. It checks + * recursively through the array. * - * The calls show values for scalar arguments and type names for complex ones. + * @param type $array + * The array to check, will likely be $error from calling function + * + * @return boolean + * TRUE if found. + */ +function array_has_PDOException($array) { + if (array_key_exists('%type', $array) && stripos($array['%type'], 'PDOException') !== FALSE) { + return TRUE; + } + foreach ($array as $value) { + if (is_array($value) && array_has_PDOException($value)) { + return TRUE; + } + } + return FALSE; +} + +/** + * Formats a stacktrace into an HTML table. * * @param array $backtrace * A standard PHP backtrace. * * @return string - * A plain-text line-wrapped string ready to be put inside
.
+ * An HTML string.
*/
-function format_backtrace(array $backtrace) {
- $return = '';
- foreach ($backtrace as $trace) {
- $call = array('function' => '', 'args' => array());
- if (isset($trace['class'])) {
- $call['function'] = $trace['class'] . $trace['type'] . $trace['function'];
- }
- elseif (isset($trace['function'])) {
- $call['function'] = $trace['function'];
- }
- else {
- $call['function'] = 'main';
+function format_stacktrace($backtrace) {
+
+ $report_type = 'STACKTRACE:';
+
+ $callstack = array_reverse($backtrace, TRUE);
+
+ $stacktrace_options = Drupal::config('system.logging')->get('stacktrace_display');
+ $show_params = $stacktrace_options[ERROR_REPORTING_DISPLAY_PASSED_PARAMS];
+ $show_scalar = $stacktrace_options[ERROR_REPORTING_DISPLAY_PASSED_SCALARS];
+ $cleaner_string_args = $stacktrace_options[ERROR_REPORTING_DISPLAY_STRIP_DRUPAL_ROOT_STRING_ARGS];
+ $args_sep = $stacktrace_options[ERROR_REPORTING_DISPLAY_STRIP_DRUPAL_ROOT_STRING_ARGS] ? '
' : ', ';
+
+ if ($show_params) {
+ $params_table_header1 = 'Caller file ';
+ $params_table_header2 = 'Passed types ';
+ }
+ else {
+ $params_table_header1 = 'Caller file ';
+ $params_table_header2 = '';
+ }
+
+ // TODO: Styling should be in CSS or should make use of drupal's existing CSS.
+ $cs =<<
+ .stacktrace td, .stacktrace th {padding: 0 0.5em;}
+ .stacktrace th {border-width: 2px 0;}
+ .stacktrace .row-bunch {border-top: 2px solid #BFBFBA; border-bottom: 0;}
+ .stacktrace .first_column {border-left: 2px solid #BFBFBA;}
+ .stacktrace .last_column {border-right: 2px solid #BFBFBA;}
+ .stacktrace .row-bunch-last {border-bottom: 2px solid #BFBFBA;}
+ pre.stacktrace {font-family: "Andale Mono","Courier New",Courier,Lucidatypewriter,Fixed,monospace;}
+
+
+
+
+
+ Index
+ Function called
+ Caller line
+ $params_table_header1
+ $params_table_header2
+
+
+
+EOT
+ ;
+
+ $column_names = array('function', 'line', 'file');
+ if ($show_params) {
+ $column_names[] = 'args';
+ }
+ $last_col_name = end($column_names);
+
+ $first_col_class = 'class="first_column"';
+ $last_col_classes[] = 'last_column';
+
+ $row_bunching = $row_bunching_max = 3;
+ foreach ($callstack AS $raw_data_no => &$raw_data) {
+ $classes = array();
+ $row_bunching++;
+ if ($row_bunching >= $row_bunching_max) {
+ $classes[] = 'row-bunch';
+ $row_bunching = 0;
+ } elseif ($raw_data_no == 0) {
+ $classes[] = 'row-bunch-last';
}
- foreach ($trace['args'] as $arg) {
- if (is_scalar($arg)) {
- $call['args'][] = is_string($arg) ? '\'' . filter_xss($arg) . '\'' : $arg;
- }
- else {
- $call['args'][] = ucfirst(gettype($arg));
+ $row_class = 'class="'.implode(' ', $classes).'"';
+ $cs .= "$raw_data_no ";
+ foreach ($column_names as $column_name) {
+ if (isset($raw_data[$column_name])) {
+ switch ($column_name) {
+ case 'args':
+ $last_col_classes[] = 'row-bunch';
+ $cs .= '';
+ $data = $raw_data[$column_name];
+ $args = array();
+ foreach ($raw_data as $arg) {
+ if ($show_scalar && is_scalar($arg)) {
+ if (is_string($arg)) {
+ if ($cleaner_string_args) {
+ $arg = str_replace(DRUPAL_ROOT, '...', $arg);
+ $arg = htmlentities($arg);
+ }
+ $args[] = '\'' . filter_xss($arg) . '\'';
+ }
+ else {
+ $args[] = $arg;
+ }
+ $args[] = is_string($arg) ? '\'' . filter_xss($arg) . '\'' : $arg;
+ }
+ else {
+ $args[] = gettype($arg);
+ }
+ }
+ $data = implode($args_sep, $args);
+ break;
+
+ default:
+ $cs .= $column_name == $last_col_name ? ' ' : ' ';
+ $data = str_replace(DRUPAL_ROOT . '/', '', $raw_data[$column_name]);
+ $data = htmlentities($data);
+ }
+ $cs .= $data;
+ } else {
+ $cs .= $column_name == $last_col_name ? ' ' : ' ';
}
+ $cs .= ' ';
}
- $return .= $call['function'] . '(' . implode(', ', $call['args']) . ")\n";
+ $cs .= '
+
+
+EOT
+ ;
+ return '' . format_backtrace($verbose_backtrace) . ''; + $message .= format_stacktrace($verbose_backtrace); } $this->error($message, $error_map[$severity], _drupal_get_last_caller($backtrace)); @@ -1152,10 +1152,12 @@ protected function exceptionHandler($exception) { // The exception message is run through check_plain() // by _drupal_decode_exception(). $decoded_exception = _drupal_decode_exception($exception); - unset($decoded_exception['backtrace']); - $message = format_string('%type: !message in %function (line %line of %file).
!backtrace', $decoded_exception + array( - '!backtrace' => format_backtrace($verbose_backtrace), - )); + unset($decoded_exception['!backtrace']); + $message = format_string('%type: !message in %function (line %line of %file). !backtrace', + $decoded_exception + array( + '!backtrace' => format_stacktrace($verbose_backtrace), + ) + ); $this->error($message, 'Uncaught exception', _drupal_get_last_caller($backtrace)); } diff --git a/core/modules/system/config/system.logging.yml b/core/modules/system/config/system.logging.yml index 3ecc76c..6bee54b 100644 --- a/core/modules/system/config/system.logging.yml +++ b/core/modules/system/config/system.logging.yml @@ -1 +1,9 @@ error_level: all + +stacktrace_display: + 1: 0 + 2: 0 + 3: 0 + 4: 0 + 5: 0 + 6: 6 diff --git a/core/modules/system/lib/Drupal/system/Form/LoggingForm.php b/core/modules/system/lib/Drupal/system/Form/LoggingForm.php index bc74529..917c6bd 100644 --- a/core/modules/system/lib/Drupal/system/Form/LoggingForm.php +++ b/core/modules/system/lib/Drupal/system/Form/LoggingForm.php @@ -26,6 +26,7 @@ public function getFormID() { */ public function buildForm(array $form, array &$form_state) { $config = $this->configFactory->get('system.logging'); + $form['error_level'] = array( '#type' => 'radios', '#title' => t('Error messages to display'), @@ -34,11 +35,25 @@ public function buildForm(array $form, array &$form_state) { ERROR_REPORTING_HIDE => t('None'), ERROR_REPORTING_DISPLAY_SOME => t('Errors and warnings'), ERROR_REPORTING_DISPLAY_ALL => t('All messages'), - ERROR_REPORTING_DISPLAY_VERBOSE => t('All messages, with backtrace information'), ), '#description' => t('It is recommended that sites running on production environments do not display any errors.'), ); + $form['stacktrace_display'] = array( + '#type' => 'checkboxes', + '#title' => t('Choose how to monitor stacktrace information.'), + '#default_value' => $config->get('stacktrace_display'), + '#options' => array( + ERROR_REPORTING_DISPLAY_LOG_EXTRA => t('Add to log'), + ERROR_REPORTING_DISPLAY_OUTPUT_EXTRA => t('Show on page'), + ERROR_REPORTING_DISPLAY_PASSED_PARAMS => t('Show types of passed parameters'), + ERROR_REPORTING_DISPLAY_PASSED_SCALARS => t('Show scalar content if showing types of passed parameters'), + ERROR_REPORTING_DISPLAY_LINE_PER_ARG => t('List passed parameters on per line'), + ERROR_REPORTING_DISPLAY_STRIP_DRUPAL_ROOT_STRING_ARGS => t('Strip DRUPAL_ROOT from paths and replace with "..." on string parameters (looks cleaner).'), + ), + '#description' => t('On production environments only use "Add to log" and then only when needed, not "Show on page".'), + ); + return parent::buildForm($form, $form_state); } @@ -48,6 +63,7 @@ public function buildForm(array $form, array &$form_state) { public function submitForm(array &$form, array &$form_state) { $this->configFactory->get('system.logging') ->set('error_level', $form_state['values']['error_level']) + ->set('stacktrace_display', $form_state['values']['stacktrace_display']) ->save(); parent::submitForm($form, $form_state); diff --git a/core/modules/system/lib/Drupal/system/Tests/System/ErrorHandlerTest.php b/core/modules/system/lib/Drupal/system/Tests/System/ErrorHandlerTest.php index 11d1356..9856e7d 100644 --- a/core/modules/system/lib/Drupal/system/Tests/System/ErrorHandlerTest.php +++ b/core/modules/system/lib/Drupal/system/Tests/System/ErrorHandlerTest.php @@ -30,64 +30,100 @@ public static function getInfo() { } /** + * Must be public being an error trap. + * Calls the error handler and is surrounded by re-entrant code blocking so + * we don't end up in an infinite loop with triggered errors. + */ + public function testErrorHandler_error_trap($errno = NULL, $errstr = NULL, $errfile = NULL, $errline = NULL, $errcontext = NULL) { + static $entered = FALSE; + if (is_null($errno)) { + return; // Was called by TestBase iterating through functions so ignore it. + } + if ($entered) { + // At this point let's not pick up variables or anything. Let's just print + // a string which is about as safe we can get other than doing nothing. + print "
Call to: TestBase->errorHandler() about an error during ErrorHandlerTest->testErrorHandler() caused another error.\n
"; + return; + } + $entered = TRUE; + $this->errorHandler($errno, $errstr, $errfile, $errline); + $entered = FALSE; + } + + /** * Test the error handler. */ function testErrorHandler() { $config = config('system.logging'); - $error_notice = array( - '%type' => 'Notice', - '!message' => 'Undefined variable: bananas', - '%function' => 'error_test_generate_warnings()', - '%file' => drupal_get_path('module', 'error_test') . '/error_test.module', - ); - $error_warning = array( - '%type' => 'Warning', - '!message' => 'Division by zero', + + // Would prefer to just nest an error handler at this point but for some + // reason doing a set_error_handler() before a restore is causing a PHP error. + restore_error_handler(); + set_error_handler(array($this, 'testErrorHandler_error_trap')); + + $caller = array( '%function' => 'error_test_generate_warnings()', '%file' => drupal_get_path('module', 'error_test') . '/error_test.module', + '%line' => __LINE__, ); - $error_user_notice = array( - '%type' => 'User warning', - '!message' => 'Drupal is awesome', - '%function' => 'error_test_generate_warnings()', - '%file' => drupal_get_path('module', 'error_test') . '/error_test.module', + + $error_display_levels = array( + ERROR_REPORTING_HIDE, + ERROR_REPORTING_DISPLAY_SOME, + ERROR_REPORTING_DISPLAY_ALL + ); + + $options = array( + ERROR_REPORTING_DISPLAY_LOG_EXTRA => 0, + ERROR_REPORTING_DISPLAY_OUTPUT_EXTRA => 0, + ERROR_REPORTING_DISPLAY_PASSED_PARAMS => 0, + ERROR_REPORTING_DISPLAY_PASSED_SCALARS => 0, + ERROR_REPORTING_DISPLAY_LINE_PER_ARG => 0, + ERROR_REPORTING_DISPLAY_STRIP_DRUPAL_ROOT_STRING_ARGS => 0, ); - // Set error reporting to display verbose notices. - config('system.logging')->set('error_level', ERROR_REPORTING_DISPLAY_VERBOSE)->save(); - $this->drupalGet('error-test/generate-warnings'); - $this->assertResponse(200, 'Received expected HTTP status code.'); - $this->assertErrorMessage($error_notice); - $this->assertErrorMessage($error_warning); - $this->assertErrorMessage($error_user_notice); - $this->assertRaw('', 'Found pre element with backtrace class.');
-
- // Set error reporting to collect notices.
- $config->set('error_level', ERROR_REPORTING_DISPLAY_ALL)->save();
- $this->drupalGet('error-test/generate-warnings');
- $this->assertResponse(200, 'Received expected HTTP status code.');
- $this->assertErrorMessage($error_notice);
- $this->assertErrorMessage($error_warning);
- $this->assertErrorMessage($error_user_notice);
- $this->assertNoRaw('', 'Did not find pre element with backtrace class.');
-
- // Set error reporting to not collect notices.
- $config->set('error_level', ERROR_REPORTING_DISPLAY_SOME)->save();
- $this->drupalGet('error-test/generate-warnings');
- $this->assertResponse(200, 'Received expected HTTP status code.');
- $this->assertNoErrorMessage($error_notice);
- $this->assertErrorMessage($error_warning);
- $this->assertErrorMessage($error_user_notice);
- $this->assertNoRaw('', 'Did not find pre element with backtrace class.');
-
- // Set error reporting to not show any errors.
- $config->set('error_level', ERROR_REPORTING_HIDE)->save();
- $this->drupalGet('error-test/generate-warnings');
- $this->assertResponse(200, 'Received expected HTTP status code.');
- $this->assertNoErrorMessage($error_notice);
- $this->assertNoErrorMessage($error_warning);
- $this->assertNoErrorMessage($error_user_notice);
- $this->assertNoRaw('', 'Did not find pre element with backtrace class.');
+ // Every one we uncomment multiplies out the loops so only use the ones that
+ // make sense in terms of may be handled differently.
+ $error_types = array(
+ E_ERROR,
+// E_WARNING,
+// E_NOTICE,
+// E_USER_ERROR,
+// E_USER_WARNING,
+// E_USER_NOTICE,
+// E_STRICT,
+// E_DEPRECATED,
+// E_USER_DEPRECATED,
+// E_RECOVERABLE_ERROR,
+ );
+
+ $max = pow(2, count($options));
+ /*
+ * These loops will test all permuations of the error reporting admin
+ * options and error types passed.
+ */
+ foreach ($error_display_levels as $error_display_level) {
+ $config->set('error_level', $error_display_level)->save();
+ for ($i = 0; $i <= $max; $i++) {
+ for ($j = 1; $j <= $max; $j = $j * 2) {
+ $options[$j] = $i & $j;
+ $config->set('stacktrace_display', $options)->save();
+ foreach ($error_types as $error_type) {
+ _drupal_error_handler_real(
+ $error_type,
+ 'Options set when _drupal_error_handler_real() called: ' . var_export($options, TRUE),
+ $caller['%file'],
+ $caller['%line'],
+ array()
+ );
+ }
+ }
+ }
+ }
+
+ // Restore the error handler back to this class.
+ restore_error_handler();
+ set_error_handler(array($this, 'errorHandler'));
}
/**