3 namespace Friendica\Factory;
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\Logger\WorkerLogger;
16 use Friendica\Util\Profiler;
18 use Psr\Log\LoggerInterface;
24 * Currently only Monolog is supported
29 * A list of classes, which shouldn't get logged
32 private static $ignoreClassList = [
39 * Creates a new PSR-3 compliant logger instances
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
45 * @return LoggerInterface The PSR-3 compliant logger instance
48 * @throws InternalServerErrorException
50 public static function create($channel, Configuration $config, Profiler $profiler)
52 if (empty($config->get('system', 'debugging', false))) {
53 $logger = new VoidLogger();
54 Logger::init($logger);
58 $introspection = new Introspection(self::$ignoreClassList);
59 $level = $config->get('system', 'loglevel');
60 $loglevel = self::mapLegacyConfigDebugLevel((string)$level);
62 switch ($config->get('system', 'logger_config', 'stream')) {
64 $loggerTimeZone = new \DateTimeZone('UTC');
65 Monolog\Logger::setTimezone($loggerTimeZone);
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));
73 $stream = $config->get('system', 'logfile');
75 static::addStreamHandler($logger, $stream, $loglevel);
79 $logger = new SyslogLogger($channel, $introspection, $loglevel);
84 $stream = $config->get('system', 'logfile');
85 $logger = new StreamLogger($channel, $stream, $introspection, $loglevel);
89 $profiling = $config->get('system', 'profiling', false);
91 // In case profiling is enabled, wrap the ProfilerLogger around the current logger
92 if (isset($profiling) && $profiling !== false) {
93 $logger = new ProfilerLogger($logger, $profiler);
96 Logger::init($logger);
102 * Creates a new PSR-3 compliant develop logger
104 * If you want to debug only interactions from your IP or the IP of a remote server for federation debug,
105 * you'll use this logger instance for the duration of your work.
107 * It should never get filled during normal usage of Friendica
109 * @param string $channel The channel of the logger instance
110 * @param Configuration $config The config
111 * @param Profiler $profiler The profiler of the app
113 * @return LoggerInterface The PSR-3 compliant logger instance
115 * @throws InternalServerErrorException
118 public static function createDev($channel, Configuration $config, Profiler $profiler)
120 $debugging = $config->get('system', 'debugging');
121 $stream = $config->get('system', 'dlogfile');
122 $developerIp = $config->get('system', 'dlogip');
124 if (!isset($developerIp) || !$debugging) {
125 $logger = new VoidLogger();
126 Logger::setDevLogger($logger);
130 $loggerTimeZone = new \DateTimeZone('UTC');
131 Monolog\Logger::setTimezone($loggerTimeZone);
133 $introspection = new Introspection(self::$ignoreClassList);
135 switch ($config->get('system', 'logger_config', 'stream')) {
138 $loggerTimeZone = new \DateTimeZone('UTC');
139 Monolog\Logger::setTimezone($loggerTimeZone);
141 $logger = new Monolog\Logger($channel);
142 $logger->pushProcessor(new Monolog\Processor\PsrLogMessageProcessor());
143 $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor());
144 $logger->pushProcessor(new Monolog\Processor\UidProcessor());
145 $logger->pushProcessor(new IntrospectionProcessor($introspection, LogLevel::DEBUG));
147 $logger->pushHandler(new DevelopHandler($developerIp));
149 static::addStreamHandler($logger, $stream, LogLevel::DEBUG);
153 $logger = new SyslogLogger($channel, $introspection, LogLevel::DEBUG);
158 $logger = new StreamLogger($channel, $stream, $introspection, LogLevel::DEBUG);
162 $profiling = $config->get('system', 'profiling', false);
164 // In case profiling is enabled, wrap the ProfilerLogger around the current logger
165 if (isset($profiling) && $profiling !== false) {
166 $logger = new ProfilerLogger($logger, $profiler);
169 Logger::setDevLogger($logger);
175 * Mapping a legacy level to the PSR-3 compliant levels
176 * @see https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#5-psrlogloglevel
178 * @param string $level the level to be mapped
180 * @return string the PSR-3 compliant level
182 private static function mapLegacyConfigDebugLevel($level)
187 return LogLevel::ERROR;
190 return LogLevel::WARNING;
193 return LogLevel::NOTICE;
196 return LogLevel::INFO;
199 return LogLevel::DEBUG;
202 return LogLevel::DEBUG;
203 // default if nothing set
210 * Adding a handler to a given logger instance
212 * @param LoggerInterface $logger The logger instance
213 * @param mixed $stream The stream which handles the logger output
214 * @param string $level The level, for which this handler at least should handle logging
218 * @throws InternalServerErrorException if the logger is incompatible to the logger factory
219 * @throws \Exception in case of general failures
221 public static function addStreamHandler($logger, $stream, $level = LogLevel::NOTICE)
223 if ($logger instanceof Monolog\Logger) {
224 $loglevel = Monolog\Logger::toMonologLevel($level);
226 // fallback to notice if an invalid loglevel is set
227 if (!is_int($loglevel)) {
228 $loglevel = LogLevel::NOTICE;
231 $fileHandler = new Monolog\Handler\StreamHandler($stream, $loglevel);
233 $formatter = new Monolog\Formatter\LineFormatter("%datetime% %channel% [%level_name%]: %message% %context% %extra%\n");
234 $fileHandler->setFormatter($formatter);
236 $logger->pushHandler($fileHandler);
238 throw new InternalServerErrorException('Logger instance incompatible for MonologFactory');
242 public static function addVoidHandler($logger)
244 if ($logger instanceof Monolog\Logger) {
245 $logger->pushHandler(new Monolog\Handler\NullHandler());