302 lines
8.6 KiB
PHP
302 lines
8.6 KiB
PHP
<?php
|
|
/**
|
|
* This file is part of the ForkBB <https://github.com/forkbb>.
|
|
*
|
|
* @copyright (c) Visman <mio.visman@yandex.ru, https://github.com/MioVisman>
|
|
* @license The MIT License (MIT)
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace ForkBB\Core;
|
|
|
|
use ForkBB\Core\Container;
|
|
use Psr\Log\LoggerInterface;
|
|
use Psr\Log\LogLevel;
|
|
use Psr\Log\InvalidArgumentException;
|
|
use DateTimeZone;
|
|
use DateTime;
|
|
use RuntimeException;
|
|
use Stringable;
|
|
use Throwable;
|
|
|
|
class Log implements LoggerInterface
|
|
{
|
|
protected string $path;
|
|
protected string $lineFormat;
|
|
protected string $timeFormat;
|
|
protected $resource;
|
|
protected string $hidePath;
|
|
|
|
public function __construct(array $config, protected Container $c)
|
|
{
|
|
$this->path = $config['path'] ?? __DIR__ . '/../log/{Y-m-d}.log';
|
|
$this->lineFormat = $config['lineFormat'] ?? "%datetime% [%level_name%] %message%\t%context%\n";
|
|
$this->timeFormat = $config['timeFormat'] ?? 'Y-m-d H:i:s';
|
|
$this->hidePath = \realpath(__DIR__ . '/../../');
|
|
}
|
|
|
|
public function __destruct()
|
|
{
|
|
if (\is_resource($this->resource)) {
|
|
\fclose($this->resource);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Logs with an arbitrary level.
|
|
*/
|
|
public function log($level, string|Stringable $message, array $context = []): void
|
|
{
|
|
if (
|
|
\is_object($message)
|
|
&& \method_exists($message, '__toString')
|
|
) {
|
|
$message = (string) $message;
|
|
|
|
} elseif (! \is_string($message)) {
|
|
throw new InvalidArgumentException('Expected string in message');
|
|
}
|
|
|
|
if (! \is_string($level)) {
|
|
throw new InvalidArgumentException('Expected string in level');
|
|
}
|
|
|
|
switch ($level) {
|
|
case LogLevel::EMERGENCY:
|
|
case LogLevel::ALERT:
|
|
case LogLevel::CRITICAL:
|
|
case LogLevel::ERROR:
|
|
case LogLevel::WARNING:
|
|
case LogLevel::NOTICE:
|
|
case LogLevel::INFO:
|
|
case LogLevel::DEBUG:
|
|
break;
|
|
default:
|
|
throw new InvalidArgumentException('Invalid level value');
|
|
}
|
|
|
|
$context = $this->contextExp($level, $context);
|
|
$line = $this->generateLine(
|
|
$level,
|
|
$this->c->Secury->replInvalidChars($message),
|
|
$context
|
|
);
|
|
|
|
if (! \is_resource($this->resource)) {
|
|
$this->initResource();
|
|
}
|
|
|
|
\flock($this->resource, \LOCK_EX);
|
|
\fwrite($this->resource, $line);
|
|
\flock($this->resource, \LOCK_UN);
|
|
}
|
|
|
|
protected function contextExp(string $level, array $context): array
|
|
{
|
|
$ext = $context['headers'] ?? null;
|
|
$headers = [
|
|
'REMOTE_ADDR' => $_SERVER['REMOTE_ADDR'] ?? null,
|
|
'HTTP_USER_AGENT' => $_SERVER['HTTP_USER_AGENT'] ?? null,
|
|
];
|
|
|
|
if (null === $ext) {
|
|
switch ($level) {
|
|
case LogLevel::EMERGENCY:
|
|
case LogLevel::ALERT:
|
|
case LogLevel::CRITICAL:
|
|
case LogLevel::ERROR:
|
|
case LogLevel::WARNING:
|
|
$ext = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (true === $ext) {
|
|
foreach ($_SERVER as $key => $value) {
|
|
if (
|
|
'REQUEST_METHOD' === $key
|
|
|| (
|
|
\str_starts_with($key, 'HTTP_')
|
|
&& 'HTTP_USER_AGENT' !== $key
|
|
&& 'HTTP_COOKIE' !== $key
|
|
)
|
|
) {
|
|
$headers[$key] = $value;
|
|
}
|
|
}
|
|
}
|
|
|
|
$context['headers'] = $headers;
|
|
|
|
return $context;
|
|
}
|
|
|
|
protected function initResource(): void
|
|
{
|
|
$dt = new DateTime('now', new DateTimeZone('UTC'));
|
|
$path = \preg_replace_callback(
|
|
'%{([^{}]+)}%',
|
|
function ($matches) use ($dt) {
|
|
$result = $dt->format($matches[1]);
|
|
|
|
return $result ?: 'bad_format';
|
|
},
|
|
$this->path
|
|
);
|
|
|
|
if (! \is_writable($path)) {
|
|
$dir = \pathinfo($path, \PATHINFO_DIRNAME);
|
|
|
|
if (
|
|
! \is_dir($dir)
|
|
&& ! \mkdir($dir, 0755, true)
|
|
) {
|
|
throw new RuntimeException("Unable to create '{$dir}' directory");
|
|
}
|
|
|
|
if (! \chmod($dir, 0755)) {
|
|
throw new RuntimeException("Error changing the access mode to '{$dir}' directory");
|
|
}
|
|
|
|
if (
|
|
\is_file($path)
|
|
&& ! \chmod($dir, 0755)
|
|
) {
|
|
throw new RuntimeException("Error changing the access mode to '{$path}' file");
|
|
}
|
|
}
|
|
|
|
$this->resource = \fopen($path, 'a');
|
|
|
|
if (! \is_resource($this->resource)) {
|
|
throw new RuntimeException("Could not get access to '{$path}' resource");
|
|
}
|
|
}
|
|
|
|
protected function generateLine(string $level, string $message, array $context): string
|
|
{
|
|
if (
|
|
false !== \strpos($message, '{')
|
|
&& false !== \strpos($message, '}')
|
|
) {
|
|
$message = $this->interpolate($message, $context);
|
|
}
|
|
|
|
if (
|
|
isset($context['exception'])
|
|
&& $context['exception'] instanceof Throwable
|
|
) {
|
|
$context['exception'] = \str_replace($this->hidePath, '...', (string) $context['exception']);
|
|
}
|
|
|
|
$dt = new DateTime('now', new DateTimeZone('UTC'));
|
|
$result = [
|
|
'%datetime%' => $dt->format($this->timeFormat),
|
|
'%level_name%' => $level,
|
|
'%message%' => \addcslashes($message, "\0..\37\\"),
|
|
'%context%' => \json_encode($context, FORK_JSON_ENCODE | \JSON_INVALID_UTF8_SUBSTITUTE),
|
|
];
|
|
|
|
return \strtr($this->lineFormat, $result);
|
|
}
|
|
|
|
/**
|
|
* Interpolates context values into the message placeholders.
|
|
*/
|
|
protected function interpolate(string $message, array $context): string
|
|
{
|
|
$replace = [];
|
|
foreach ($context as $key => $val) {
|
|
// check that the value can be cast to string
|
|
if (
|
|
! \is_array($val)
|
|
&& (
|
|
! \is_object($val)
|
|
|| \method_exists($val, '__toString')
|
|
)
|
|
) {
|
|
$replace['{' . $key . '}'] = \str_replace($this->hidePath, '...', (string) $val);
|
|
}
|
|
}
|
|
|
|
// interpolate replacement values into the message and return
|
|
return \strtr($message, $replace);
|
|
}
|
|
|
|
/**
|
|
* System is unusable.
|
|
*/
|
|
public function emergency(string|Stringable $message, array $context = []): void
|
|
{
|
|
$this->log(LogLevel::EMERGENCY, $message, $context);
|
|
}
|
|
|
|
/**
|
|
* Action must be taken immediately.
|
|
*
|
|
* Example: Entire website down, database unavailable, etc. This should
|
|
* trigger the SMS alerts and wake you up.
|
|
*/
|
|
public function alert(string|Stringable $message, array $context = []): void
|
|
{
|
|
$this->log(LogLevel::ALERT, $message, $context);
|
|
}
|
|
|
|
/**
|
|
* Critical conditions.
|
|
*
|
|
* Example: Application component unavailable, unexpected exception.
|
|
*/
|
|
public function critical(string|Stringable $message, array $context = []): void
|
|
{
|
|
$this->log(LogLevel::CRITICAL, $message, $context);
|
|
}
|
|
|
|
/**
|
|
* Runtime errors that do not require immediate action but should typically
|
|
* be logged and monitored.
|
|
*/
|
|
public function error(string|Stringable $message, array $context = []): void
|
|
{
|
|
$this->log(LogLevel::ERROR, $message, $context);
|
|
}
|
|
|
|
/**
|
|
* Exceptional occurrences that are not errors.
|
|
*
|
|
* Example: Use of deprecated APIs, poor use of an API, undesirable things
|
|
* that are not necessarily wrong.
|
|
*/
|
|
public function warning(string|Stringable $message, array $context = []): void
|
|
{
|
|
$this->log(LogLevel::WARNING, $message, $context);
|
|
}
|
|
|
|
/**
|
|
* Normal but significant events.
|
|
*/
|
|
public function notice(string|Stringable $message, array $context = []): void
|
|
{
|
|
$this->log(LogLevel::NOTICE, $message, $context);
|
|
}
|
|
|
|
/**
|
|
* Interesting events.
|
|
*
|
|
* Example: User logs in, SQL logs.
|
|
*/
|
|
public function info(string|Stringable $message, array $context = []): void
|
|
{
|
|
$this->log(LogLevel::INFO, $message, $context);
|
|
}
|
|
|
|
/**
|
|
* Detailed debug information.
|
|
*/
|
|
public function debug(string|Stringable $message, array $context = []): void
|
|
{
|
|
$this->log(LogLevel::DEBUG, $message, $context);
|
|
}
|
|
}
|