Changeset 19610

Timestamp:

12/08/08 12:30:11 (7 months ago)

Author:

bergie

Message:

Implement error actions for logging or sending email on error pages, fixes #305

Files:

• branches/ragnaroek/midcom/midcom.core/errors.php (modified) (4 diffs)
• branches/ragnaroek/midcom/midcom.core/midcom/config/midcom_config.php (modified) (2 diffs)
• branches/ragnaroek/midcom/midcom.core/midcom/debug.php (modified) (1 diff)
• branches/ragnaroek/midcom/org.openpsa.mail/backend/mail/smtp.php (modified) (1 diff)

branches/ragnaroek/midcom/midcom.core/errors.php

@@ -21 +21 @@
-    /**
-     * Catch an Exception and show it as a HTTP error
+     *
+     * @see midcom_application::generate_error()
+     * @see midcom_exception_handler::show()
-     */
-    public static function handle_exception(Exception $e)
-    {
-this->show
+_MIDCOM->generate_error
-        // This will exit
-    }
@@ -69 +72 @@
-        debug_print_r('Debugging Stacktrace:', $GLOBALS['midcom_debugger']->_prefixes);
-        debug_print_function_stack('XDebug Stacktrace:');
+
+        // Send error to special log or recipient as per in configuration.
+        $this->send($httpcode, $message);
-
-        if (headers_sent())
@@ -159 +165 @@
-</address>
-<?php
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
-?>
-</body>
@@ -191 +177 @@
-        debug_add("Error Page output finished, exiting now", MIDCOM_LOG_DEBUG);
-        debug_pop();
-this
-this
+_MIDCOM
+_MIDCOM
-        exit();
-    }
+
+    /**
+     * Send error for processing.
+     *
+     * If the given error code has an action configured for it, that action will be
+     * performed. This means that system administrators can request email notifications
+     * of 500 "Internal Errors" and a special log of 404 "Not Founds".
+     *
+     * @param int $httpcode        The error code to send.
+     * @param string $message    The message to print.
+     */
+    private function send($httpcode, $message)
+    {
+        if (   !isset($GLOBALS['midcom_config']['error_actions'][$httpcode])
+            || !is_array($GLOBALS['midcom_config']['error_actions'][$httpcode])
+            || !isset($GLOBALS['midcom_config']['error_actions'][$httpcode]['action']))
+        {
+            // No action specified for this error code, skip
+            return;
+        }
+
+        // Prepare the message
+        $msg = "{$_SERVER['REQUEST_METHOD']} request to {$_SERVER['REQUEST_URI']}: ";
+        $msg .= "{$httpcode} {$message}\n";
+        if (isset($_SERVER['HTTP_REFERER']))
+        {
+            $msg .= "(Referrer: {$_SERVER['HTTP_REFERER']})";
+        }
+        
+        // Send as email handler
+        if ($GLOBALS['midcom_config']['error_actions'][$httpcode]['action'] == 'email')
+        {
+            if (   !isset($GLOBALS['midcom_config']['error_actions'][$httpcode]['email'])
+                || empty($GLOBALS['midcom_config']['error_actions'][$httpcode]['email']))
+            {
+                // No recipient specified, skip
+                return;
+            }
+            
+            if (!$_MIDCOM->componentloader->is_installed('org.openpsa.mail'))
+            {
+                debug_push_class(__CLASS__, __FUNCTION__);
+                debug_add("Email sending library org.openpsa.mail, used for error notifications is not installed", MIDCOM_LOG_WARN);
+                debug_pop();
+                return;
+            }
+
+            $_MIDCOM->load_library('org.openpsa.mail');
+
+            $mail = new org_openpsa_mail();
+            $mail->to = $GLOBALS['midcom_config']['error_actions'][$httpcode]['email'];
+            $mail->from = "\"MidCOM error notifier\" <webmaster@{$_SERVER['SERVER_NAME']}>";
+            $mail->subject = "[{$_SERVER['SERVER_NAME']}] {$msg}";
+            $mail->body = "{$_SERVER['SERVER_NAME']}:\n{$msg}";
+            
+            $stacktrace = $this->get_function_stack();
+
+            if (empty($stacktrace))
+            {
+                // No Xdebug, rely on MidCOM debugger stack
+                foreach ($GLOBALS['midcom_debugger']->_prefixes as $prefix)
+                {
+                    $stacktrace .= "{$prefix}\n";
+                }
+            }
+
+            $mail->body .= "\n{$stacktrace}";
+
+            if (!$mail->send())
+            {
+                debug_push_class(__CLASS__, __FUNCTION__);
+                debug_add("failed to send error notification email to {$mail->to}, reason: " . $mail->get_error_message(), MIDCOM_LOG_WARN);
+                debug_pop();
+            }
+            
+            return;
+        }
+
+        // Append to log file handler
+        if ($GLOBALS['midcom_config']['error_actions'][$httpcode]['action'] == 'log')
+        {
+            if (   !isset($GLOBALS['midcom_config']['error_actions'][$httpcode]['filename'])
+                || empty($GLOBALS['midcom_config']['error_actions'][$httpcode]['filename']))
+            {
+                // No log file specified, skip
+                return;
+            }
+            
+            if (   !is_writable($GLOBALS['midcom_config']['error_actions'][$httpcode]['filename'])
+                && !is_writable(dirname($GLOBALS['midcom_config']['error_actions'][$httpcode]['filename'])))
+            {
+                debug_push_class(__CLASS__, __FUNCTION__);
+                debug_add("Error logging file {$GLOBALS['midcom_config']['error_actions'][$httpcode]['filename']} is not writable", MIDCOM_LOG_WARN);
+                debug_pop();
+                return;
+            }
+            
+            // Add the line to the error-specific log
+            $logger = new midcom_debug($GLOBALS['midcom_config']['error_actions'][$httpcode]['filename']);
+            $logger->setLoglevel(MIDCOM_LOG_INFO);
+            $logger->log($msg, MIDCOM_LOG_INFO);
+
+            return;
+        }
+    }
+    
+    private function get_function_stack()
+    {
+        $stacktrace = '';
+        if (!MIDCOM_XDEBUG)
+        {
+            return $stacktrace;
+        }
+        
+        $stack = xdebug_get_function_stack();
+        $stacktrace .= "Stacktrace:\n";
+        foreach ($stack as $number => $frame)
+        {
+            $stacktrace .= $number + 1;
+            $stacktrace .= ": {$frame['file']}:{$frame['line']} ";
+            if (array_key_exists('class', $frame))
+            {
+                $stacktrace .= "{$frame['class']}::{$frame['function']}";
+            }
+            else if (array_key_exists('function', $frame))
+            {
+                $stacktrace .= $frame['function'];
+            }
+            else
+            {
+                $stacktrace .= 'require, include or eval';
+            }
+            $stacktrace .= "\n";
+        }
+        return $stacktrace;
+    }
-}
-
+// Register the error and Exception handlers
-set_error_handler(array('midcom_exception_handler', 'handle_error'), E_ALL & ~E_NOTICE | E_WARNING);
-set_exception_handler(array('midcom_exception_handler', 'handle_exception'));

branches/ragnaroek/midcom/midcom.core/midcom/config/midcom_config.php

@@ -189 +189 @@
- *   the logging system. See the URL method log of midcom_application for details. Turned off
- *   by default for security reasons.
+ * - <b>array error_actions:</b> Actions to run when a specific error code is produced. This can
+ *   be used for saving logs about 404 errors from broken links, or sending an error 500 to
+ *   webmaster for analysis.
+ *
+ *   Configuration example:
+ *
+ * <code>
+ * $GLOBALS['midcom_config_default']['error_actions'] = array
+ * (
+ *     500 => array
+ *     (
+ *         'action' => 'email',
+ *         'email' => 'webmaster@example.net',
+ *     ),
+ *     404 => array
+ *     (
+ *         'action' => 'log',
+ *         'filename' => '/var/log/broken_links.log',
+ *     ),
+ * );
+ * </code>
- *
- * <b>MidCOM Core configuration</b>
@@ -424 +445 @@
-$GLOBALS['midcom_config_default']['display_php_errors'] = true;
-$GLOBALS['midcom_config_default']['enable_error_handler'] = true;
+$GLOBALS['midcom_config_default']['error_actions'] = array();
-
-// Core configuration

branches/ragnaroek/midcom/midcom.core/midcom/debug.php

@@ -86 +86 @@
-        $this->_enabled = true;
-        $this->_loglevel = $GLOBALS['midcom_config']['log_level'];
-
+
+
-            MIDCOM_LOG_DEBUG => "debug",
-            MIDCOM_LOG_INFO  => "info",

branches/ragnaroek/midcom/org.openpsa.mail/backend/mail/smtp.php

@@ -62 +62 @@
-        $merged = $mailclass->merge_address_headers();
-        //debug_add("address_headers_merged:\n===\n{$merged}\n===\nheaders:\n===\n" . org_openpsa_helpers::sprint_r($mailclass->headers) . "===\n");
+
-        $mailRet = $mail->send($merged, $mailclass->headers, $mailclass->body);
-        //This gives *huge* log in case of error since the full org_openpsa_mail object is included in the PEAR error as well
-        //debug_add("mail->send returned\n===\n" . org_openpsa_helpers::sprint_r($mailRet) . "===\n");
+
-        if ($mailRet === true)
-        {