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