Merge remote-tracking branch 'nulpunkt/master'

README.mdown

@@ -132,6 +132,7 @@ Handlers
   [raven](https://packagist.org/packages/raven/raven).
 - _ZendMonitorHandler_: Logs records to the Zend Monitor present in Zend Server.
 - _NewRelicHandler_: Logs records to a [NewRelic](http://newrelic.com/) application.
+- _SyslogUdpHandler_: Logs records to a remote [Syslogd](http://www.rsyslog.com/) server.
 
 ### Logging in development
 

src/Monolog/Handler/SyslogUdp/UdpSocket.php

@@ -0,0 +1,62 @@
+<?php
+
+/*
+ * This file is part of the Monolog package.
+ *
+ * (c) Jordi Boggiano <j.boggiano@seld.be>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Monolog\Handler\SyslogUdp;
+
+class UdpSocket
+{
+    const DATAGRAM_MAX_LENGTH = 2048;
+
+    public function __construct($ip, $port)
+    {
+        $this->ip = $ip;
+        $this->port = $port;
+        $this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
+    }
+
+    public function write($line, $header = "")
+    {
+        $remaining = $line;
+        while (!is_null($remaining)) {
+            list($chunk, $remaining) = $this->splitLineIfNessesary($remaining, $header);
+            $this->send($chunk);
+        }
+    }
+
+    public function close()
+    {
+        socket_close($this->socket);
+    }
+
+    protected function send($chunk)
+    {
+        socket_sendto($this->socket, $chunk, strlen($chunk), $flags = 0, $this->ip, $this->port);
+    }
+
+    protected function splitLineIfNessesary($line, $header)
+    {
+        if ($this->shouldSplitLine($line, $header)) {
+            $chunkSize = self::DATAGRAM_MAX_LENGTH - strlen($header);
+            $chunk = $header . substr($line, 0, $chunkSize);
+            $remaining = substr($line, $chunkSize);
+        } else {
+            $chunk = $header . $line;
+            $remaining = null;
+        }
+
+        return array($chunk, $remaining);
+    }
+
+    protected function shouldSplitLine($remaining, $header)
+    {
+        return strlen($header.$remaining) > self::DATAGRAM_MAX_LENGTH;
+    }
+}

src/Monolog/Handler/SyslogUdpHandler.php

@@ -0,0 +1,124 @@
+<?php
+
+/*
+ * This file is part of the Monolog package.
+ *
+ * (c) Jordi Boggiano <j.boggiano@seld.be>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Monolog\Handler;
+
+use Monolog\Logger;
+use Monolog\Handler\SyslogUdp\UdpSocket;
+
+/**
+ * A Handler for logging to a remote syslogd server.
+ * Example usage (given you have a syslogd server on your local machine):
+ * <code>
+ * $logger = new \Monolog\Logger();
+ * $handler = new SyslogUdpHandler("local5", "127.0.0.1");
+ * $handler->setFormatter(new \Monolog\Formatter\LineFormatter());
+ * $logger->pushHandler($handler);
+ * $logger->warn("Hello from abroard!");
+ * </code>
+ */
+
+class SyslogUdpHandler extends AbstractProcessingHandler
+{
+    protected $facility;
+
+    protected $facilities = array(
+            "local0" => 16,
+            "local1" => 17,
+            "local2" => 18,
+            "local3" => 19,
+            "local4" => 20,
+            "local5" => 21,
+            "local6" => 22,
+            "local7" => 23
+    );
+
+    protected $severityMap = array(
+        Logger::EMERGENCY => 0,
+        Logger::ALERT => 1,
+        Logger::CRITICAL => 2,
+        Logger::ERROR => 3,
+        Logger::WARNING => 4,
+        Logger::NOTICE => 5,
+        Logger::INFO => 6,
+        Logger::DEBUG => 7
+    );
+
+    public function __construct($facility, $syslogdIp, $port = null)
+    {
+        $port = is_null($port) ? 514 : $port;
+        $this->socket = new UdpSocket($syslogdIp, $port);
+
+        $this->validateFacility($facility);
+        $this->facility = $this->facilities[$facility];
+
+    }
+
+    protected function validateFacility($facility)
+    {
+        if (!is_string($facility) || !array_key_exists($facility, $this->facilities)) {
+            throw new \InvalidArgumentException("Invalid syslog facility: $facility");
+        }
+    }
+
+    protected function write(array $record)
+    {
+        $lines = $this->splitMessageIntoLines($record['formatted']);
+
+        $header = $this->makeCommonSyslogHeader($this->getSeverity($record['level']));
+
+        foreach ($lines as $line) {
+            $this->socket->write($line, $header);
+        }
+    }
+
+    public function close()
+    {
+        $this->socket->close();
+    }
+
+    protected function splitMessageIntoLines($message)
+    {
+        if (is_array($message)) {
+            $message = implode("\n", $message);
+        }
+        return preg_split('/$\R?^/m', $message);
+    }
+
+    /**
+     * Make common syslog header (see rfc5424)
+     */
+    protected function makeCommonSyslogHeader($severity)
+    {
+        $priority = $severity + ($this->facility << 3);
+        return "<$priority>: ";
+    }
+
+    /**
+     * Map the Monolog severity levels to syslogd.
+     */
+    protected function getSeverity($priority)
+    {
+        if (array_key_exists($priority, $this->severityMap)) {
+            return $this->severityMap[$priority];
+        } else {
+            return Logger::INFO;
+        }
+    }
+
+    /**
+     * Inject your own socket, mainly used for testing
+     */
+    public function setSocket($socket)
+    {
+        $this->socket = $socket;
+    }
+}

tests/Monolog/Handler/SyslogUdpHandlerTest.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Monolog\Handler;
+
+use Monolog\TestCase;
+
+class SyslogUdpHandlerTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @expectedException InvalidArgumentException
+     */
+    public function testWeValidateFacilities()
+    {
+        $handler = new SyslogUdpHandler("loiwjefoiwjef", "ip");
+    }
+
+    public function testWeSplitIntoLines()
+    {
+        $handler = new SyslogUdpHandler("local5", "127.0.0.1");
+        $handler->setFormatter(new \Monolog\Formatter\ChromePHPFormatter());
+
+        $socket = $this->getMock('\Monolog\Handler\SyslogUdp\UdpSocket', array('write'), array('lol', 'lol'));
+        $socket->expects($this->at(0))
+            ->method('write')
+            ->with("lol", "<172>: ");
+        $socket->expects($this->at(1))
+            ->method('write')
+            ->with("hej", "<172>: ");
+
+        $handler->setSocket($socket);
+
+        $handler->handle($this->getRecordWithMessage("hej\nlol"));
+    }
+
+    protected function getRecordWithMessage($msg)
+    {
+        return array('message' => $msg, 'level' => \Monolog\Logger::WARNING, 'context' => null, 'extra' => array(), 'channel' => 'lol');
+    }
+}

tests/Monolog/Handler/UdpSocketTest.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Monolog\Handler;
+
+use Monolog\TestCase;
+
+class UdpSocketTest extends TestCase
+{
+    public function testWeDoNotSplitShortMessages()
+    {
+        $socket = $this->getMock('\Monolog\Handler\SyslogUdp\UdpSocket', array('send'), array('lol', 'lol'));
+
+        $socket->expects($this->at(0))
+            ->method('send')
+            ->with("HEADER: The quick brown fox jumps over the lazy dog");
+
+        $socket->write("The quick brown fox jumps over the lazy dog", "HEADER: ");
+    }
+
+    public function testWeSplitLongMessages()
+    {
+        $socket = $this->getMock('\Monolog\Handler\SyslogUdp\UdpSocket', array('send'), array('lol', 'lol'));
+
+        $socket->expects($this->at(1))
+            ->method('send')
+            ->with("The quick brown fox jumps over the lazy dog");
+
+        $aStringOfLength2048 = str_repeat("derp", 2048/4);
+
+        $socket->write($aStringOfLength2048."The quick brown fox jumps over the lazy dog");
+    }
+
+    public function testAllSplitMessagesHasAHeader()
+    {
+        $socket = $this->getMock('\Monolog\Handler\SyslogUdp\UdpSocket', array('send'), array('lol', 'lol'));
+
+        $socket->expects($this->exactly(5))
+            ->method('send')
+            ->with($this->stringStartsWith("HEADER"));
+
+        $aStringOfLength8192 = str_repeat("derp", 2048);
+
+        $socket->write($aStringOfLength8192, "HEADER");
+    }
+}