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