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