134 lines
3.9 KiB
PHP
134 lines
3.9 KiB
PHP
<?php
|
|
|
|
/*
|
|
* 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!
|
|
*/
|
|
|
|
namespace TYPO3\CMS\Core\Log\Writer;
|
|
|
|
use TYPO3\CMS\Core\Log\LogLevel;
|
|
use TYPO3\CMS\Core\Log\LogRecord;
|
|
|
|
/**
|
|
* Log writer that writes to syslog
|
|
*/
|
|
class SyslogWriter extends AbstractWriter
|
|
{
|
|
/**
|
|
* List of valid syslog facility names.
|
|
* private as it's not supposed to be changed.
|
|
*
|
|
* @var array<string, int> Facilities
|
|
*/
|
|
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,
|
|
];
|
|
|
|
/**
|
|
* Type of program that is logging to syslog.
|
|
*
|
|
* @var int
|
|
*/
|
|
protected $facility = LOG_USER;
|
|
|
|
/**
|
|
* Constructor, adds facilities on *nix environments.
|
|
*
|
|
* @param array $options Configuration options
|
|
* @throws \RuntimeException if connection to syslog cannot be opened
|
|
* @see \TYPO3\CMS\Core\Log\Writer\AbstractWriter
|
|
*/
|
|
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);
|
|
openlog('TYPO3', LOG_ODELAY | LOG_PID, $this->facility);
|
|
}
|
|
|
|
/**
|
|
* Destructor, closes connection to syslog.
|
|
*/
|
|
public function __destruct()
|
|
{
|
|
closelog();
|
|
}
|
|
|
|
/**
|
|
* Sets the facility to use when logging to syslog.
|
|
*
|
|
* @param string $facility Facility to use when logging.
|
|
*/
|
|
public function setFacility($facility): void
|
|
{
|
|
if (array_key_exists(strtolower($facility), $this->facilities)) {
|
|
$this->facility = $this->facilities[strtolower($facility)];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the data of the record in syslog format
|
|
*/
|
|
public function getMessageForSyslog(LogRecord $record): string
|
|
{
|
|
$data = '';
|
|
$context = $record->getData();
|
|
$message = $record->getMessage();
|
|
if (!empty($context)) {
|
|
// Fold an exception into the message, and string-ify it into context so it can be jsonified.
|
|
if (isset($context['exception']) && $context['exception'] instanceof \Throwable) {
|
|
$message .= $this->formatException($context['exception']);
|
|
$context['exception'] = (string)$context['exception'];
|
|
}
|
|
$data = '- ' . json_encode($context);
|
|
}
|
|
|
|
return sprintf(
|
|
'[request="%s" component="%s"] %s %s',
|
|
$record->getRequestId(),
|
|
$record->getComponent(),
|
|
$this->interpolate($message, $context),
|
|
$data
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Writes the log record to syslog
|
|
*
|
|
* @return \TYPO3\CMS\Core\Log\Writer\WriterInterface
|
|
*/
|
|
public function writeLog(LogRecord $record)
|
|
{
|
|
syslog(LogLevel::normalizeLevel($record->getLevel()), $this->getMessageForSyslog($record));
|
|
return $this;
|
|
}
|
|
}
|