SysLog.php

<?php
/*
    This file is part of Plop, a simple logging library for PHP.

    Copyright © 2010-2014 François Poirotte

    Plop is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Plop is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Plop.  If not, see <http://www.gnu.org/licenses/>.
*/

namespace Plop\Handler;

class SysLog extends \Plop\HandlerAbstract
{
    const LOG_FORMAT_STRING = "<%d>%s\000";

    const DEFAULT_ADDRESS   = 'udg:///dev/log';

    protected static $priorityNames = array(
        'alert'     => LOG_ALERT,
        'crit'      => LOG_CRIT,
        'critical'  => LOG_CRIT,
        'debug'     => LOG_DEBUG,
        'emerg'     => LOG_EMERG,
        'err'       => LOG_ERR,
        'error'     => LOG_ERR,         // Deprecated
        'info'      => LOG_INFO,
        'notice'    => LOG_NOTICE,
        'panic'     => LOG_EMERG,       // Deprecated
        'warn'      => LOG_WARNING,     // Deprecated
        'warning'   => LOG_WARNING,
    );

    protected static $facilityNames = array(
        'auth'      => LOG_AUTH,
        'authpriv'  => LOG_AUTHPRIV,
        'cron'      => LOG_CRON,
        'daemon'    => LOG_DAEMON,
        'kern'      => LOG_KERN,
        'lpr'       => LOG_LPR,
        'mail'      => LOG_MAIL,
        'news'      => LOG_NEWS,
        'syslog'    => LOG_SYSLOG,
        'user'      => LOG_USER,
        'uucp'      => LOG_UUCP,
    );

    protected static $priorityMap = array(
        'DEBUG'     => 'debug',
        'INFO'      => 'info',
        'NOTICE'    => 'notice',
        'WARNING'   => 'warning',
        'ERROR'     => 'error',
        'CRITICAL'  => 'critical',
        'ALERT'     => 'alert',
        'EMERGENCY' => 'emergency',
    );

    protected $address;

    protected $facility;

    protected $socket;

    public function __construct(
        $address = self::DEFAULT_ADDRESS,
        $facility = LOG_USER
    ) {
        if (defined('LOG_LOCAL0') && !isset(static::$facilityNames['local0'])) {
            static::$facilityNames += array(
                'local0'    => LOG_LOCAL0,
                'local1'    => LOG_LOCAL1,
                'local2'    => LOG_LOCAL2,
                'local3'    => LOG_LOCAL3,
                'local4'    => LOG_LOCAL4,
                'local5'    => LOG_LOCAL5,
                'local6'    => LOG_LOCAL6,
                'local7'    => LOG_LOCAL7,
            );
        }

        parent::__construct();
        $this->address  = $address;
        $this->facility = $facility;
        $this->socket   = $this->makeSocket();
        if ($this->socket === false) {
            throw new \Plop\Exception('Unable to connect to the syslog');
        }
    }

    public function __destruct()
    {
        $this->close();
    }

    protected function makeSocket()
    {
        return stream_socket_client($this->address);
    }

    protected function encodePriority($facility, $priority)
    {
        if (is_string($facility)) {
            $facility = static::$facilityNames[$facility];
        }
        if (is_string($priority)) {
            $priority = static::$priorityNames[$priority];
        }
        return ($facility << 3) | $priority;
    }

    protected function close()
    {
        if ($this->socket !== false) {
            fclose($this->socket);
            $this->socket = false;
        }
    }

    protected function mapPriority($levelName)
    {
        if (isset(static::$priorityMap[$levelName])) {
            return static::$priorityMap[$levelName];
        }
        return "warning";
    }

    protected function emit(\Plop\RecordInterface $record)
    {
        $msg = $this->format($record);
        $msg = sprintf(
            static::LOG_FORMAT_STRING,
            $this->encodePriority(
                $this->facility,
                $this->mapPriority($record['levelname'])
            ),
            $msg
        );

        for ($written = 0; $written < strlen($msg); $written += $fwrite) {
            $fwrite = @fwrite($this->socket, substr($msg, $written));
            if ($fwrite === false) {
                $this->handleError(
                    $record,
                    new \Plop\Exception('Connection lost')
                );
                break;
            }
        }
    }
}