Merge remote-tracking branch 'Sgoettschkes/PushoverHandler'

src/Monolog/Handler/PushoverHandler.php

@@ -0,0 +1,80 @@
+<?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;
+
+/**
+ * Sends notifications through the pushover api to mobile phones
+ *
+ * @author Sebastian Göttschkes <sebastian.goettschkes@googlemail.com>
+ * @see    https://www.pushover.net/api
+ */
+class PushoverHandler extends SocketHandler
+{
+    private $token;
+    private $user;
+    private $title;
+
+    /**
+     * @param string  $token  Pushover api token
+     * @param string  $user   Pushover user id the message will be sent to
+     * @param string  $title  Title sent to Pushover API
+     * @param integer $level  The minimum logging level at which this handler will be triggered
+     * @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
+     */
+    public function __construct($token, $user, $title = 'Monolog', $level = Logger::CRITICAL, $bubble = true)
+    {
+        parent::__construct('api.pushover.net', $level, $bubble);
+        $this->connectionPort = 80;
+
+        $this->token = $token;
+        $this->user = $user;
+        $this->title = $title;
+    }
+
+    protected function generateDataStream($record)
+    {
+        $content = $this->buildContentString($record);
+        return $this->buildHeaderAndAddContent($content);
+    }
+
+    private function buildContentString($record)
+    {
+        // Pushover has a limit of 512 characters on title and message combined.
+        $maxMessageLength = 512 - strlen($this->title);
+        $message = substr($record['message'], 0, $maxMessageLength);
+        $timestamp = $record['datetime']->getTimestamp();
+
+        $dataArray = array(
+            'token' => $this->token,
+            'user' => $this->user,
+            'message' => $message,
+            'title' => $this->title,
+            'timestamp' => $timestamp
+        );
+
+        return http_build_query($dataArray);
+    }
+
+    private function buildHeaderAndAddContent($content)
+    {
+        $header = "POST /1/messages.json HTTP/1.1\r\n";
+        $header .= "Host: api.pushover.net\r\n";
+        $header .= "Content-Type: application/x-www-form-urlencoded\r\n";
+        $header .= "Content-Length: " . strlen($content) . "\r\n";
+        $header .= "\r\n";
+        $header .= $content;
+
+        return $header;
+    }
+}

src/Monolog/Handler/SocketHandler.php

@@ -22,6 +22,7 @@ use Monolog\Logger;
 class SocketHandler extends AbstractProcessingHandler
 {
     private $connectionString;
+    protected $connectionPort = -1;
     private $connectionTimeout;
     private $resource;
     private $timeout = 0;
@@ -52,7 +53,8 @@ class SocketHandler extends AbstractProcessingHandler
     public function write(array $record)
     {
         $this->connectIfNotConnected();
-        $this->writeToSocket((string) $record['formatted']);
+        $data = $this->generateDataStream($record);
+        $this->writeToSocket($data);
     }
 
     /**
@@ -170,7 +172,7 @@ class SocketHandler extends AbstractProcessingHandler
      */
     protected function pfsockopen()
     {
-        return @pfsockopen($this->connectionString, -1, $this->errno, $this->errstr, $this->connectionTimeout);
+        return @pfsockopen($this->connectionString, $this->connectionPort, $this->errno, $this->errstr, $this->connectionTimeout);
     }
 
     /**
@@ -178,7 +180,7 @@ class SocketHandler extends AbstractProcessingHandler
      */
     protected function fsockopen()
     {
-        return @fsockopen($this->connectionString, -1, $this->errno, $this->errstr, $this->connectionTimeout);
+        return @fsockopen($this->connectionString, $this->connectionPort, $this->errno, $this->errstr, $this->connectionTimeout);
     }
 
     /**
@@ -226,6 +228,11 @@ class SocketHandler extends AbstractProcessingHandler
         $this->connect();
     }
 
+    protected function generateDataStream($record)
+    {
+        return (string) $record['formatted'];
+    }
+
     private function connect()
     {
         $this->createSocketResource();
@@ -252,7 +259,7 @@ class SocketHandler extends AbstractProcessingHandler
         }
     }
 
-    private function writeToSocket($data)
+    protected function writeToSocket($data)
     {
         $length = strlen($data);
         $sent = 0;

tests/Monolog/Handler/PushoverHandlerTest.php

@@ -0,0 +1,107 @@
+<?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\TestCase;
+use Monolog\Logger;
+
+/**
+ * Almost all examples (expected header, titles, messages) taken from
+ * https://www.pushover.net/api
+ * @author Sebastian Göttschkes <sebastian.goettschkes@googlemail.com>
+ * @see https://www.pushover.net/api
+ */
+class PushoverHandlerTest extends TestCase
+{
+
+    private $res;
+    private $handler;
+
+    public function testWriteHeader()
+    {
+        $this->createHandler();
+        $this->handler->handle($this->getRecord(Logger::CRITICAL, 'test1'));
+        fseek($this->res, 0);
+        $content = fread($this->res, 1024);
+
+        $this->assertRegexp('/POST \/1\/messages.json HTTP\/1.1\\r\\nHost: api.pushover.net\\r\\nContent-Type: application\/x-www-form-urlencoded\\r\\nContent-Length: \d{2,4}\\r\\n\\r\\n/', $content);
+
+        return $content;
+    }
+
+    /**
+     * @depends testWriteHeader
+     */
+    public function testWriteContent($content)
+    {
+        $this->assertRegexp('/token=myToken&user=myUser&message=test1&title=Monolog&timestamp=\d{10}$/', $content);
+    }
+
+    public function testWriteWithComplexTitle()
+    {
+        $this->createHandler('myToken', 'myUser', 'Backup finished - SQL1');
+        $this->handler->handle($this->getRecord(Logger::CRITICAL, 'test1'));
+        fseek($this->res, 0);
+        $content = fread($this->res, 1024);
+
+        $this->assertRegexp('/title=Backup\+finished\+-\+SQL1/', $content);
+    }
+
+    public function testWriteWithComplexMessage()
+    {
+        $this->createHandler();
+        $this->handler->handle($this->getRecord(Logger::CRITICAL, 'Backup of database "example" finished in 16 minutes.'));
+        fseek($this->res, 0);
+        $content = fread($this->res, 1024);
+
+        $this->assertRegexp('/message=Backup\+of\+database\+%22example%22\+finished\+in\+16\+minutes\./', $content);
+    }
+
+    public function testWriteWithTooLongMessage()
+    {
+        $message = str_pad('test', 520, 'a');
+        $this->createHandler();
+        $this->handler->handle($this->getRecord(Logger::CRITICAL, $message));
+        fseek($this->res, 0);
+        $content = fread($this->res, 1024);
+
+        $expectedMessage = substr($message, 0, 505);
+
+        $this->assertRegexp('/message=' . $expectedMessage . '&title/', $content);
+    }
+
+    private function createHandler($token = 'myToken', $user = 'myUser', $title = null)
+    {
+        $constructArray = array($token, $user);
+        if($title != null) {
+            $constructArray[2] = $title;
+        }
+        $this->res = fopen('php://memory', 'a');
+        $this->handler = $this->getMock(
+            '\Monolog\Handler\PushoverHandler', array('fsockopen', 'streamSetTimeout'), $constructArray
+        );
+
+        $reflectionProperty = new \ReflectionProperty('\Monolog\Handler\SocketHandler', 'connectionString');
+        $reflectionProperty->setAccessible(true);
+        $reflectionProperty->setValue($this->handler, 'localhost:1234');
+
+        $this->handler->expects($this->any())
+            ->method('fsockopen')
+            ->will($this->returnValue($this->res));
+        $this->handler->expects($this->any())
+            ->method('streamSetTimeout')
+            ->will($this->returnValue(true));
+
+        $this->handler->setFormatter($this->getIdentityFormatter());
+    }
+
+}