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