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