src/Factory/LoggerFactory.php

   1 <?php
   2
   3 namespace Friendica\Factory;
   4
   5 use Friendica\Core\Config\Configuration;
   6 use Friendica\Core\Logger;
   7 use Friendica\Network\HTTPException\InternalServerErrorException;
   8 use Friendica\Util\Introspection;
   9 use Friendica\Util\Logger\Monolog\DevelopHandler;
  10 use Friendica\Util\Logger\Monolog\IntrospectionProcessor;
  11 use Friendica\Util\Logger\ProfilerLogger;
  12 use Friendica\Util\Logger\StreamLogger;
  13 use Friendica\Util\Logger\SyslogLogger;
  14 use Friendica\Util\Logger\VoidLogger;
  15 use Friendica\Util\Logger\WorkerLogger;
  16 use Friendica\Util\Profiler;
  17 use Monolog;
  18 use Psr\Log\LoggerInterface;
  19 use Psr\Log\LogLevel;
  20
  21 /**
  22  * A logger factory
  23  *
  24  * Currently only Monolog is supported
  25  */
  26 class LoggerFactory
  27 {
  28         /**
  29          * A list of classes, which shouldn't get logged
  30          * @var array
  31          */
  32         private static $ignoreClassList = [
  33                 Logger::class,
  34                 Profiler::class,
  35                 WorkerLogger::class
  36         ];
  37
  38         /**
  39          * Creates a new PSR-3 compliant logger instances
  40          *
  41          * @param string        $channel The channel of the logger instance
  42          * @param Configuration $config  The config
  43          * @param Profiler      $profiler The profiler of the app
  44          *
  45          * @return LoggerInterface The PSR-3 compliant logger instance
  46          *
  47          * @throws \Exception
  48          * @throws InternalServerErrorException
  49          */
  50         public static function create($channel, Configuration $config, Profiler $profiler)
  51         {
  52                 if (empty($config->get('system', 'debugging', false))) {
  53                         $logger = new VoidLogger();
  54                         Logger::init($logger);
  55                         return $logger;
  56                 }
  57
  58                 $introspection = new Introspection(self::$ignoreClassList);
  59                 $level = $config->get('system', 'loglevel');
  60
  61                 switch ($config->get('system', 'logger_config', 'stream')) {
  62                         case 'monolog':
  63                                 $loggerTimeZone = new \DateTimeZone('UTC');
  64                                 Monolog\Logger::setTimezone($loggerTimeZone);
  65
  66                                 $logger = new Monolog\Logger($channel);
  67                                 $logger->pushProcessor(new Monolog\Processor\PsrLogMessageProcessor());
  68                                 $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor());
  69                                 $logger->pushProcessor(new Monolog\Processor\UidProcessor());
  70                                 $logger->pushProcessor(new IntrospectionProcessor($introspection, LogLevel::DEBUG));
  71
  72                                 $stream = $config->get('system', 'logfile');
  73
  74                                 $loglevel = self::mapLegacyConfigDebugLevel((string)$level);
  75                                 static::addStreamHandler($logger, $stream, $loglevel);
  76                                 break;
  77
  78                         case 'syslog':
  79                                 $logger = new SyslogLogger($channel, $introspection, $level);
  80                                 break;
  81
  82                         case 'stream':
  83                         default:
  84                                 $stream = $config->get('system', 'logfile');
  85                                 $logger = new StreamLogger($channel, $stream, $introspection, $level);
  86                                 break;
  87                 }
  88
  89                 $profiling = $config->get('system', 'profiling', false);
  90
  91                 // In case profiling is enabled, wrap the ProfilerLogger around the current logger
  92                 if (isset($profiling) && $profiling !== false) {
  93                         $logger = new ProfilerLogger($logger, $profiler);
  94                 }
  95
  96                 Logger::init($logger);
  97
  98                 return $logger;
  99         }
 100
 101         /**
 102          * Creates a new PSR-3 compliant develop logger
 103          *
 104          * If you want to debug only interactions from your IP or the IP of a remote server for federation debug,
 105          * you'll use this logger instance for the duration of your work.
 106          *
 107          * It should never get filled during normal usage of Friendica
 108          *
 109          * @param string        $channel The channel of the logger instance
 110          * @param Configuration $config  The config
 111          * @param Profiler      $profiler The profiler of the app
 112          *
 113          * @return LoggerInterface The PSR-3 compliant logger instance
 114          *
 115          * @throws InternalServerErrorException
 116          * @throws \Exception
 117          */
 118         public static function createDev($channel, Configuration $config, Profiler $profiler)
 119         {
 120                 $debugging   = $config->get('system', 'debugging');
 121                 $stream      = $config->get('system', 'dlogfile');
 122                 $developerIp = $config->get('system', 'dlogip');
 123
 124                 if (!isset($developerIp) || !$debugging) {
 125                         $logger = new VoidLogger();
 126                         Logger::setDevLogger($logger);
 127                         return $logger;
 128                 }
 129
 130                 $loggerTimeZone = new \DateTimeZone('UTC');
 131                 Monolog\Logger::setTimezone($loggerTimeZone);
 132
 133                 $introspection = new Introspection(self::$ignoreClassList);
 134
 135                 switch ($config->get('system', 'logger_config', 'stream')) {
 136
 137                         case 'monolog':
 138                                 $loggerTimeZone = new \DateTimeZone('UTC');
 139                                 Monolog\Logger::setTimezone($loggerTimeZone);
 140
 141                                 $logger = new Monolog\Logger($channel);
 142                                 $logger->pushProcessor(new Monolog\Processor\PsrLogMessageProcessor());
 143                                 $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor());
 144                                 $logger->pushProcessor(new Monolog\Processor\UidProcessor());
 145                                 $logger->pushProcessor(new IntrospectionProcessor($introspection, LogLevel::DEBUG));
 146
 147                                 $logger->pushHandler(new DevelopHandler($developerIp));
 148
 149                                 static::addStreamHandler($logger, $stream, LogLevel::DEBUG);
 150                                 break;
 151
 152                         case 'syslog':
 153                                 $logger = new SyslogLogger($channel, $introspection,  LogLevel::DEBUG);
 154                                 break;
 155
 156                         case 'stream':
 157                         default:
 158                                 $logger = new StreamLogger($channel, $stream, $introspection, LogLevel::DEBUG);
 159                                 break;
 160                 }
 161
 162                 $profiling = $config->get('system', 'profiling', false);
 163
 164                 // In case profiling is enabled, wrap the ProfilerLogger around the current logger
 165                 if (isset($profiling) && $profiling !== false) {
 166                         $logger = new ProfilerLogger($logger, $profiler);
 167                 }
 168
 169                 Logger::setDevLogger($logger);
 170
 171                 return $logger;
 172         }
 173
 174         /**
 175          * Mapping a legacy level to the PSR-3 compliant levels
 176          * @see https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#5-psrlogloglevel
 177          *
 178          * @param string $level the level to be mapped
 179          *
 180          * @return string the PSR-3 compliant level
 181          */
 182         private static function mapLegacyConfigDebugLevel($level)
 183         {
 184                 switch ($level) {
 185                         // legacy WARNING
 186                         case "0":
 187                                 return LogLevel::ERROR;
 188                         // legacy INFO
 189                         case "1":
 190                                 return LogLevel::WARNING;
 191                         // legacy TRACE
 192                         case "2":
 193                                 return LogLevel::NOTICE;
 194                         // legacy DEBUG
 195                         case "3":
 196                                 return LogLevel::INFO;
 197                         // legacy DATA
 198                         case "4":
 199                                 return LogLevel::DEBUG;
 200                         // legacy ALL
 201                         case "5":
 202                                 return LogLevel::DEBUG;
 203                         // default if nothing set
 204                         default:
 205                                 return $level;
 206                 }
 207         }
 208
 209         /**
 210          * Adding a handler to a given logger instance
 211          *
 212          * @param LoggerInterface $logger  The logger instance
 213          * @param mixed           $stream  The stream which handles the logger output
 214          * @param string          $level   The level, for which this handler at least should handle logging
 215          *
 216          * @return void
 217          *
 218          * @throws InternalServerErrorException if the logger is incompatible to the logger factory
 219          * @throws \Exception in case of general failures
 220          */
 221         public static function addStreamHandler($logger, $stream, $level = LogLevel::NOTICE)
 222         {
 223                 if ($logger instanceof Monolog\Logger) {
 224                         $loglevel = Monolog\Logger::toMonologLevel($level);
 225
 226                         // fallback to notice if an invalid loglevel is set
 227                         if (!is_int($loglevel)) {
 228                                 $loglevel = LogLevel::NOTICE;
 229                         }
 230
 231                         $fileHandler = new Monolog\Handler\StreamHandler($stream, $loglevel);
 232
 233                         $formatter = new Monolog\Formatter\LineFormatter("%datetime% %channel% [%level_name%]: %message% %context% %extra%\n");
 234                         $fileHandler->setFormatter($formatter);
 235
 236                         $logger->pushHandler($fileHandler);
 237                 } else {
 238                         throw new InternalServerErrorException('Logger instance incompatible for MonologFactory');
 239                 }
 240         }
 241
 242         public static function addVoidHandler($logger)
 243         {
 244                 if ($logger instanceof Monolog\Logger) {
 245                         $logger->pushHandler(new Monolog\Handler\NullHandler());
 246                 }
 247         }
 248 }