]> git.mxchange.org Git - friendica.git/blobdiff - src/Factory/LoggerFactory.php
Group selection: Respect "pubmail" and ignore atchived or blocked contacts
[friendica.git] / src / Factory / LoggerFactory.php
index 8eb5506093da9145cda2231508381afb553883aa..f21fe9b7f50fa04f6de3f7b24fecc42a34bc5b20 100644 (file)
@@ -4,10 +4,16 @@ namespace Friendica\Factory;
 
 use Friendica\Core\Config\Configuration;
 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\Logger\WorkerLogger;
+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;
@@ -20,45 +26,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,
-               WorkerLogger::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 Configuration $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, Configuration $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, self::$ignoreClassList));
-
-               $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;
+               }
+
+               $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;
                }
 
-               Logger::init($logger);
+               $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;
        }
 
@@ -70,38 +137,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 Configuration $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(Configuration $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, self::$ignoreClassList));
+               $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 = 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));
+
+                               $logger->pushHandler(new DevelopHandler($developerIp));
+
+                               static::addStreamHandler($logger, $stream, LogLevel::DEBUG);
+                               break;
 
-               $logger->pushHandler(new FriendicaDevelopHandler($developerIp));
+                       case 'syslog':
+                               $logger = new SyslogLogger(self::DEV_CHANNEL, $introspection, LogLevel::DEBUG);
+                               break;
 
-               static::addStreamHandler($logger, $stream, LogLevel::DEBUG);
+                       case 'stream':
+                       default:
+                               $logger = new StreamLogger(self::DEV_CHANNEL, $stream, $introspection, $fileSystem, LogLevel::DEBUG);
+                               break;
+               }
 
-               Logger::setDevLogger($logger);
+               $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
@@ -125,7 +226,6 @@ class LoggerFactory
                                return LogLevel::INFO;
                        // legacy DATA
                        case "4":
-                               return LogLevel::DEBUG;
                        // legacy ALL
                        case "5":
                                return LogLevel::DEBUG;
@@ -138,13 +238,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)
@@ -157,20 +256,12 @@ class LoggerFactory
                                $loglevel = LogLevel::NOTICE;
                        }
 
-                       // if the stream is a file and it isn't writeable, add a null handler and return
-                       if (is_file($stream) && !is_writable($stream)) {
-                               $logger->pushHandler(new Monolog\Handler\NullHandler());
-                               return;
-                       }
-
                        $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');
                }
        }