X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FFactory%2FLoggerFactory.php;h=ad6658b563b6e8040f80d0ad36bc0922cd8e48f3;hb=5d61599964e74bb733816a5592eee2aed3bbba4e;hp=77a09637c46d9dc3dffc23330f543de9ffe31e23;hpb=5e5c39b0e12154551ece88692c1567fc04db86ec;p=friendica.git diff --git a/src/Factory/LoggerFactory.php b/src/Factory/LoggerFactory.php index 77a09637c4..ad6658b563 100644 --- a/src/Factory/LoggerFactory.php +++ b/src/Factory/LoggerFactory.php @@ -1,12 +1,38 @@ . + * + */ namespace Friendica\Factory; -use Friendica\Core\Config\Configuration; +use Friendica\Core\Config\IConfig; use Friendica\Core\Logger; +use Friendica\Database\Database; use Friendica\Network\HTTPException\InternalServerErrorException; -use Friendica\Util\Logger\FriendicaDevelopHandler; -use Friendica\Util\Logger\FriendicaIntrospectionProcessor; +use Friendica\Util\FileSystem; +use Friendica\Util\Introspection; +use Friendica\Util\Logger\Monolog\DevelopHandler; +use Friendica\Util\Logger\Monolog\IntrospectionProcessor; +use Friendica\Util\Logger\ProfilerLogger; +use Friendica\Util\Logger\StreamLogger; +use Friendica\Util\Logger\SyslogLogger; +use Friendica\Util\Logger\VoidLogger; use Friendica\Util\Profiler; use Monolog; use Psr\Log\LoggerInterface; @@ -19,35 +45,106 @@ use Psr\Log\LogLevel; */ class LoggerFactory { + const DEV_CHANNEL = 'dev'; + + /** + * A list of classes, which shouldn't get logged + * + * @var array + */ + private static $ignoreClassList = [ + Logger::class, + Profiler::class, + 'Friendica\\Util\\Logger', + ]; + + private $channel; + + public function __construct(string $channel) + { + $this->channel = $channel; + } + /** * Creates a new PSR-3 compliant logger instances * - * @param string $channel The channel of the logger instance - * @param Configuration $config The config + * @param Database $database The Friendica Database instance + * @param IConfig $config The config + * @param Profiler $profiler The profiler of the app + * @param FileSystem $fileSystem FileSystem utils * * @return LoggerInterface The PSR-3 compliant logger instance */ - public static function create($channel, Configuration $config) + public function create(Database $database, IConfig $config, Profiler $profiler, FileSystem $fileSystem) { - $logger = new Monolog\Logger($channel); - $logger->pushProcessor(new Monolog\Processor\PsrLogMessageProcessor()); - $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor()); - $logger->pushProcessor(new Monolog\Processor\UidProcessor()); - $logger->pushProcessor(new FriendicaIntrospectionProcessor(LogLevel::DEBUG, [Logger::class, Profiler::class])); - - $debugging = $config->get('system', 'debugging'); - $stream = $config->get('system', 'logfile'); - $level = $config->get('system', 'loglevel'); - - if ($debugging) { - $loglevel = self::mapLegacyConfigDebugLevel((string)$level); - static::addStreamHandler($logger, $stream, $loglevel); - } else { - static::addVoidHandler($logger); + if (empty($config->get('system', 'debugging', false))) { + $logger = new VoidLogger(); + $database->setLogger($logger); + return $logger; } - Logger::init($logger); + $introspection = new Introspection(self::$ignoreClassList); + $level = $config->get('system', 'loglevel'); + $loglevel = self::mapLegacyConfigDebugLevel((string)$level); + + switch ($config->get('system', 'logger_config', 'stream')) { + case 'monolog': + $loggerTimeZone = new \DateTimeZone('UTC'); + Monolog\Logger::setTimezone($loggerTimeZone); + + $logger = new Monolog\Logger($this->channel); + $logger->pushProcessor(new Monolog\Processor\PsrLogMessageProcessor()); + $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor()); + $logger->pushProcessor(new Monolog\Processor\UidProcessor()); + $logger->pushProcessor(new IntrospectionProcessor($introspection, LogLevel::DEBUG)); + + $stream = $config->get('system', 'logfile'); + + // just add a stream in case it's either writable or not file + if (!is_file($stream) || is_writable($stream)) { + try { + static::addStreamHandler($logger, $stream, $loglevel); + } catch (\Throwable $e) { + // No Logger .. + $logger = new VoidLogger(); + } + } + break; + + case 'syslog': + try { + $logger = new SyslogLogger($this->channel, $introspection, $loglevel); + } catch (\Throwable $e) { + // No logger ... + $logger = new VoidLogger(); + } + break; + case 'stream': + default: + $stream = $config->get('system', 'logfile'); + // just add a stream in case it's either writable or not file + if (!is_file($stream) || is_writable($stream)) { + try { + $logger = new StreamLogger($this->channel, $stream, $introspection, $fileSystem, $loglevel); + } catch (\Throwable $t) { + // No logger ... + $logger = new VoidLogger(); + } + } else { + $logger = new VoidLogger(); + } + break; + } + + $profiling = $config->get('system', 'profiling', false); + + // In case profiling is enabled, wrap the ProfilerLogger around the current logger + if (isset($profiling) && $profiling !== false) { + $logger = new ProfilerLogger($logger, $profiler); + } + + $database->setLogger($logger); return $logger; } @@ -59,38 +156,72 @@ class LoggerFactory * * It should never get filled during normal usage of Friendica * - * @param string $channel The channel of the logger instance - * @param Configuration $config The config + * @param IConfig $config The config + * @param Profiler $profiler The profiler of the app + * @param FileSystem $fileSystem FileSystem utils * * @return LoggerInterface The PSR-3 compliant logger instance + * + * @throws InternalServerErrorException + * @throws \Exception */ - public static function createDev($channel, Configuration $config) + public static function createDev(IConfig $config, Profiler $profiler, FileSystem $fileSystem) { $debugging = $config->get('system', 'debugging'); $stream = $config->get('system', 'dlogfile'); $developerIp = $config->get('system', 'dlogip'); - if (!isset($developerIp) || !$debugging) { - return null; + if ((!isset($developerIp) || !$debugging) && + (!is_file($stream) || is_writable($stream))) { + $logger = new VoidLogger(); + return $logger; } - $logger = new Monolog\Logger($channel); - $logger->pushProcessor(new Monolog\Processor\PsrLogMessageProcessor()); - $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor()); - $logger->pushProcessor(new Monolog\Processor\UidProcessor()); - $logger->pushProcessor(new FriendicaIntrospectionProcessor(LogLevel::DEBUG, ['Friendica\\Core\\Logger'])); + $loggerTimeZone = new \DateTimeZone('UTC'); + Monolog\Logger::setTimezone($loggerTimeZone); + + $introspection = new Introspection(self::$ignoreClassList); + + switch ($config->get('system', 'logger_config', 'stream')) { + + case 'monolog': + $loggerTimeZone = new \DateTimeZone('UTC'); + Monolog\Logger::setTimezone($loggerTimeZone); - $logger->pushHandler(new FriendicaDevelopHandler($developerIp)); + $logger = new Monolog\Logger(self::DEV_CHANNEL); + $logger->pushProcessor(new Monolog\Processor\PsrLogMessageProcessor()); + $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor()); + $logger->pushProcessor(new Monolog\Processor\UidProcessor()); + $logger->pushProcessor(new IntrospectionProcessor($introspection, LogLevel::DEBUG)); - static::addStreamHandler($logger, $stream, LogLevel::DEBUG); + $logger->pushHandler(new DevelopHandler($developerIp)); - Logger::setDevLogger($logger); + static::addStreamHandler($logger, $stream, LogLevel::DEBUG); + break; + + case 'syslog': + $logger = new SyslogLogger(self::DEV_CHANNEL, $introspection, LogLevel::DEBUG); + break; + + case 'stream': + default: + $logger = new StreamLogger(self::DEV_CHANNEL, $stream, $introspection, $fileSystem, LogLevel::DEBUG); + break; + } + + $profiling = $config->get('system', 'profiling', false); + + // In case profiling is enabled, wrap the ProfilerLogger around the current logger + if (isset($profiling) && $profiling !== false) { + $logger = new ProfilerLogger($logger, $profiler); + } return $logger; } /** * Mapping a legacy level to the PSR-3 compliant levels + * * @see https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#5-psrlogloglevel * * @param string $level the level to be mapped @@ -114,7 +245,6 @@ class LoggerFactory return LogLevel::INFO; // legacy DATA case "4": - return LogLevel::DEBUG; // legacy ALL case "5": return LogLevel::DEBUG; @@ -127,13 +257,12 @@ class LoggerFactory /** * Adding a handler to a given logger instance * - * @param LoggerInterface $logger The logger instance - * @param mixed $stream The stream which handles the logger output - * @param string $level The level, for which this handler at least should handle logging + * @param LoggerInterface $logger The logger instance + * @param mixed $stream The stream which handles the logger output + * @param string $level The level, for which this handler at least should handle logging * * @return void * - * @throws InternalServerErrorException if the logger is incompatible to the logger factory * @throws \Exception in case of general failures */ public static function addStreamHandler($logger, $stream, $level = LogLevel::NOTICE) @@ -145,14 +274,13 @@ class LoggerFactory if (!is_int($loglevel)) { $loglevel = LogLevel::NOTICE; } + $fileHandler = new Monolog\Handler\StreamHandler($stream, $loglevel); $formatter = new Monolog\Formatter\LineFormatter("%datetime% %channel% [%level_name%]: %message% %context% %extra%\n"); $fileHandler->setFormatter($formatter); $logger->pushHandler($fileHandler); - } else { - throw new InternalServerErrorException('Logger instance incompatible for MonologFactory'); } }