SyslogWriter.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Log\Writer;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
use TYPO3\CMS\Core\Log\LogRecord;

class SyslogWriter extends AbstractWriter
{
    private $facilities = [
        '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 $facility = LOG_USER;

    public function __construct(array $options = [])
    {
        // additional facilities for *nix environments
        if (!defined('PHP_WINDOWS_VERSION_BUILD')) {
            $this->facilities['local0'] = LOG_LOCAL0;
            $this->facilities['local1'] = LOG_LOCAL1;
            $this->facilities['local2'] = LOG_LOCAL2;
            $this->facilities['local3'] = LOG_LOCAL3;
            $this->facilities['local4'] = LOG_LOCAL4;
            $this->facilities['local5'] = LOG_LOCAL5;
            $this->facilities['local6'] = LOG_LOCAL6;
            $this->facilities['local7'] = LOG_LOCAL7;
        }
        parent::__construct($options);
        if (!openlog('TYPO3', (LOG_ODELAY | LOG_PID), $this->facility)) {
            $facilityName = array_search($this->facility, $this->facilities);
            throw new \RuntimeException('Could not open syslog for facility ' . $facilityName, 1321722682);
        }
    }

    public function __destruct()
    {
        closelog();
    }

    public function setFacility($facility)
    {
        if (array_key_exists(strtolower($facility), $this->facilities)) {
            $this->facility = $this->facilities[strtolower($facility)];
        }
    }

    public function getMessageForSyslog(LogRecord $record)
    {
        $data = '';
        $recordData = $record->getData();
        if (!empty($recordData)) {
            // According to PSR3 the exception-key may hold an \Exception
            // Since json_encode() does not encode an exception, we run the _toString() here
            if (isset($recordData['exception']) && $recordData['exception'] instanceof \Exception) {
                $recordData['exception'] = (string)$recordData['exception'];
            }
            $data = '- ' . json_encode($recordData);
        }
        $message = sprintf(
            '[request="%s" component="%s"] %s %s',
            $record->getRequestId(),
            $record->getComponent(),
            $record->getMessage(),
            $data
        );
        return $message;
    }

    public function writeLog(LogRecord $record)
    {
        if (false === syslog($record->getLevel(), $this->getMessageForSyslog($record))) {
            throw new \RuntimeException('Could not write log record to syslog', 1345036337);
        }
        return $this;
    }
}