Merge pull request #5 from nerds-and-company/feature/better_log_proce…

…ssing

Better log processing

LogHelperPlugin.php

@@ -76,12 +76,14 @@ public function init()
 
         // Use STDERR logging?
         if (craft()->config->get('useStdErrLog', 'logHelper')) {
+            require_once __DIR__.'/logging/LogHelper_BaseLogRoute.php';
             require_once __DIR__.'/logging/LogHelper_StdErrLogRoute.php';
             craft()->log->addRoute('Craft\LogHelper_StdErrLogRoute');
         }
 
         // Use SysLog logging?
         if (craft()->config->get('useSysLog', 'logHelper')) {
+            require_once __DIR__.'/logging/LogHelper_BaseLogRoute.php';
             require_once __DIR__.'/logging/LogHelper_SysLogRoute.php';
             craft()->log->addRoute('Craft\LogHelper_SysLogRoute');
         }

README.md

@@ -132,6 +132,10 @@ This plugin has been licensed under the MIT License (MIT). Please see [License F
 
 ##  Changelog
 
+### 2.0.3
+
+- Better log processing
+
 ### 2.0.2
 
 - Fixed bug with reading default config values

logging/LogHelper_BaseLogRoute.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Craft;
+
+/**
+ * Log Helper Plugin.
+ *
+ * Advanced logging options
+ *
+ * @author    Nerds & Company
+ * @copyright Copyright (c) 2016, Nerds & Company
+ *
+ * @link      https://www.nerds.company
+ */
+abstract class LogHelper_BaseLogRoute extends \CLogRoute
+{
+    // Public Methods
+    // =========================================================================
+
+    /**
+     * Initializes the log route. This method is invoked after the log route is created by the route manager.
+     *
+     * @return null
+     */
+    public function init()
+    {
+        $this->levels = craft()->config->get('devMode') ? '' : 'error,warning';
+        $this->filter = craft()->config->get('devMode') ? 'Craft\\LogFilter' : null;
+
+        parent::init();
+    }
+
+    // Protected Methods
+    // =========================================================================
+
+    /**
+     * Saves log messages in files.
+     *
+     * @param array $logs The list of log messages
+     *
+     * @return null
+     */
+    protected function processLogs($logs)
+    {
+        $processed = array();
+
+        foreach ($logs as $log) {
+            $message = LoggingHelper::redact($log[0]);
+            $level = $log[1];
+            $category = $log[2];
+            $time = $log[3];
+            $force = (isset($log[4]) && $log[4] == true) ? true : false;
+            $plugin = isset($log[5]) ? StringHelper::toLowerCase($log[5]) : 'craft';
+
+            $processed[] = $this->formatLogMessageWithForce($message, $level, $category, $time, $force, $plugin);
+        }
+
+        return $processed;
+    }
+
+    /**
+     * Formats a log message given different fields.
+     *
+     * @param string $message  The message content.
+     * @param int    $level    The message level.
+     * @param string $category The message category.
+     * @param int    $time     The message timestamp.
+     * @param bool   $force    Whether the message was forced or not.
+     *
+     * @return string The formatted message.
+     */
+    protected function formatLogMessageWithForce($message, $level, $category, $time, $force)
+    {
+        return "[$level] [$category]".($force ? " [Forced]" : "")." $message";
+    }
+}

logging/LogHelper_StdErrLogRoute.php

@@ -12,19 +12,21 @@
  *
  * @link      https://www.nerds.company
  */
-class LogHelper_StdErrLogRoute extends \CLogRoute
+class LogHelper_StdErrLogRoute extends LogHelper_BaseLogRoute
 {
     /**
      * Process logs.
      *
      * @param array $logs
      */
-    public function processLogs($logs)
+    protected function processLogs($logs)
     {
+        $logs = parent::processLogs($logs);
+
         $strErr = fopen('php://stderr', 'w');
 
         foreach ($logs as $log) {
-            fwrite($strErr, $log[0]."\n");
+            fwrite($strErr, $log."\n");
         }
 
         fclose($strErr);

logging/LogHelper_SysLogRoute.php

@@ -12,17 +12,19 @@
  *
  * @link      https://www.nerds.company
  */
-class LogHelper_SysLogRoute extends \CLogRoute
+class LogHelper_SysLogRoute extends LogHelper_BaseLogRoute
 {
     /**
      * Process logs.
      *
      * @param array $logs
      */
-    public function processLogs($logs)
+    protected function processLogs($logs)
     {
+        $logs = parent::processLogs($logs);
+
         foreach ($logs as $log) {
-            syslog(LOG_DEBUG, $log[0]."\n");
+            syslog(LOG_DEBUG, $log."\n");
         }
     }
 }