add ConsoleFormatter and refactor ConsoleHandler to use the output directly instead of streams (this way the formatting style are taken into account at all)

Author: Tobion

Formatter/ConsoleFormatter.php

@@ -0,0 +1,47 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\MonologBundle\Formatter;
+
+use Monolog\Formatter\LineFormatter;
+use Monolog\Logger;
+
+/**
+ * Formats incoming records for console output by coloring them depending on log level.
+ *
+ * @author Tobias Schultze <http://tobion.de>
+ */
+class ConsoleFormatter extends LineFormatter
+{
+    const SIMPLE_FORMAT = "%start_tag%[%datetime%] %channel%.%level_name%:%end_tag% %message% %context% %extra%\n";
+
+    /**
+     * {@inheritdoc}
+     */
+    public function format(array $record)
+    {
+        if ($record['level'] >= Logger::ERROR) {
+            $record['start_tag'] = '<error>';
+            $record['end_tag']   = '</error>';
+        } elseif ($record['level'] >= Logger::NOTICE) {
+            $record['start_tag'] = '<comment>';
+            $record['end_tag']   = '</comment>';
+        } elseif ($record['level'] >= Logger::INFO) {
+            $record['start_tag'] = '<info>';
+            $record['end_tag']   = '</info>';
+        } else {
+            $record['start_tag'] = '';
+            $record['end_tag']   = '';
+        }
+
+        return parent::format($record);
+    }
+}

Handler/ConsoleHandler.php

@@ -13,9 +13,9 @@
 
 use Monolog\Handler\AbstractProcessingHandler;
 use Monolog\Logger;
+use Symfony\Bundle\MonologBundle\Formatter\ConsoleFormatter;
 use Symfony\Component\Console\Output\ConsoleOutputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\Console\Output\StreamOutput;
 
 /**
  * Writes to the console output depending on its verbosity setting.
@@ -27,20 +27,9 @@
 class ConsoleHandler extends AbstractProcessingHandler
 {
     /**
-     * The stream to use when the console OutputInterface is not a StreamOutput.
+     * @var OutputInterface|null
      */
-    const FALLBACK_STREAM = 'php://output';
-
-    /**
-     * The error stream to use when the console OutputInterface is not a StreamOutput.
-     */
-    const FALLBACK_ERROR_STREAM = 'php://stderr';
-
-    private $enabled = false;
-    private $stream;
-    private $streamCreated = false;
-    private $errorStream;
-    private $errorStreamCreated = false;
+    private $output;
 
     /**
      * Constructor.
@@ -59,15 +48,15 @@ public function __construct($bubble = true)
      */
     public function isHandling(array $record)
     {
-        return $this->enabled && parent::isHandling($record);
+        return null !== $this->output && parent::isHandling($record);
     }
 
     /**
      * {@inheritdoc}
      */
     public function handle(array $record)
     {
-        if (!$this->enabled) {
+        if (null === $this->output) {
             return false;
         }
 
@@ -77,25 +66,16 @@ public function handle(array $record)
     /**
      * Sets the console output to use for printing logs.
      *
-     * It enabled the writing unless the output verbosity is set to quiet.
+     * It enables the writing unless the output verbosity is set to quiet.
      *
      * @param OutputInterface $output The console output to use
      */
     public function setOutput(OutputInterface $output)
     {
-        // close streams that might have been created before
-        $this->close();
-
         if (OutputInterface::VERBOSITY_QUIET === $output->getVerbosity()) {
-            return; // the handler remains disabled
-        }
+            $this->close();
 
-        if ($output instanceof StreamOutput) {
-            $this->stream = $output->getStream();
-        }
-
-        if ($output instanceof ConsoleOutputInterface && $output->getErrorOutput() instanceof StreamOutput) {
-            $this->errorStream = $output->getErrorOutput()->getStream();
+            return;
         }
 
         switch ($output->getVerbosity()) {
@@ -113,29 +93,15 @@ public function setOutput(OutputInterface $output)
                 break;
         }
 
-        $this->enabled = true;
+        $this->output = $output;
     }
 
     /**
-     * Disables the output and closes newly created streams.
-     *
-     * It does not close streams coming from StreamOutput because they belong to the console.
+     * Disables the output.
      */
     public function close()
     {
-        if ($this->streamCreated && is_resource($this->stream)) {
-            fclose($this->stream);
-        }
-        $this->stream = null;
-        $this->streamCreated = false;
-
-        if ($this->errorStreamCreated && is_resource($this->errorStream)) {
-            fclose($this->errorStream);
-        }
-        $this->errorStream = null;
-        $this->errorStreamCreated = false;
-
-        $this->enabled = false;
+        $this->output = null;
 
         parent::close();
     }
@@ -145,40 +111,18 @@ public function close()
      */
     protected function write(array $record)
     {
-        if (null === $this->stream) {
-            $errorMessage = null;
-            set_error_handler(function ($code, $msg) use (&$errorMessage) {
-                $errorMessage = preg_replace('{^fopen\(.*?\): }', '', $msg);
-            });
-            $this->stream = fopen(self::FALLBACK_STREAM, 'a');
-            restore_error_handler();
-            if (!is_resource($this->stream)) {
-                $this->stream = null;
-                $this->streamCreated = false;
-                throw new \UnexpectedValueException(sprintf('The stream "%s" could not be opened: '.$errorMessage, self::FALLBACK_STREAM));
-            }
-            $this->streamCreated = true;
-        }
-
-        if (null === $this->errorStream) {
-            $errorMessage = null;
-            set_error_handler(function ($code, $msg) use (&$errorMessage) {
-                $errorMessage = preg_replace('{^fopen\(.*?\): }', '', $msg);
-            });
-            $this->errorStream = fopen(self::FALLBACK_ERROR_STREAM, 'a');
-            restore_error_handler();
-            if (!is_resource($this->errorStream)) {
-                $this->errorStream = null;
-                $this->errorStreamCreated = false;
-                throw new \UnexpectedValueException(sprintf('The stream "%s" could not be opened: '.$errorMessage, self::FALLBACK_ERROR_STREAM));
-            }
-            $this->errorStreamCreated = true;
-        }
-
-        if ($record['level'] >= Logger::ERROR) {
-            fwrite($this->errorStream, (string) $record['formatted']);
+        if ($record['level'] >= Logger::ERROR && $this->output instanceof ConsoleOutputInterface) {
+            $this->output->getErrorOutput()->write((string) $record['formatted']);
         } else {
-            fwrite($this->stream, (string) $record['formatted']);
+            $this->output->write((string) $record['formatted']);
         }
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getDefaultFormatter()
+    {
+        return new ConsoleFormatter();
+    }
 }