3 namespace Friendica\Factory;
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;
18 use Psr\Log\LoggerInterface;
24 * Currently only Monolog is supported
29 * A list of classes, which shouldn't get logged
33 private static $ignoreClassList = [
36 'Friendica\\Util\\Logger',
40 * Creates a new PSR-3 compliant logger instances
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
46 * @return LoggerInterface The PSR-3 compliant logger instance
49 * @throws InternalServerErrorException
51 public static function create($channel, Database $database, Configuration $config, Profiler $profiler)
53 if (empty($config->get('system', 'debugging', false))) {
54 $logger = new VoidLogger();
55 $database->setLogger($logger);
56 Logger::init($logger);
60 $introspection = new Introspection(self::$ignoreClassList);
61 $level = $config->get('system', 'loglevel');
62 $loglevel = self::mapLegacyConfigDebugLevel((string)$level);
64 switch ($config->get('system', 'logger_config', 'stream')) {
66 $loggerTimeZone = new \DateTimeZone('UTC');
67 Monolog\Logger::setTimezone($loggerTimeZone);
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));
75 $stream = $config->get('system', 'logfile');
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);
84 $logger = new SyslogLogger($channel, $introspection, $loglevel);
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);
94 $logger = new VoidLogger();
99 $profiling = $config->get('system', 'profiling', false);
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);
106 $database->setLogger($logger);
107 Logger::init($logger);
113 * Creates a new PSR-3 compliant develop logger
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.
118 * It should never get filled during normal usage of Friendica
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
124 * @return LoggerInterface The PSR-3 compliant logger instance
126 * @throws InternalServerErrorException
129 public static function createDev($channel, Configuration $config, Profiler $profiler)
131 $debugging = $config->get('system', 'debugging');
132 $stream = $config->get('system', 'dlogfile');
133 $developerIp = $config->get('system', 'dlogip');
135 if ((!isset($developerIp) || !$debugging) &&
136 (!is_file($stream) || is_writable($stream))) {
137 $logger = new VoidLogger();
138 Logger::setDevLogger($logger);
142 $loggerTimeZone = new \DateTimeZone('UTC');
143 Monolog\Logger::setTimezone($loggerTimeZone);
145 $introspection = new Introspection(self::$ignoreClassList);
147 switch ($config->get('system', 'logger_config', 'stream')) {
150 $loggerTimeZone = new \DateTimeZone('UTC');
151 Monolog\Logger::setTimezone($loggerTimeZone);
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));
159 $logger->pushHandler(new DevelopHandler($developerIp));
161 static::addStreamHandler($logger, $stream, LogLevel::DEBUG);
165 $logger = new SyslogLogger($channel, $introspection, LogLevel::DEBUG);
170 $logger = new StreamLogger($channel, $stream, $introspection, LogLevel::DEBUG);
174 $profiling = $config->get('system', 'profiling', false);
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);
181 Logger::setDevLogger($logger);
187 * Mapping a legacy level to the PSR-3 compliant levels
189 * @see https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#5-psrlogloglevel
191 * @param string $level the level to be mapped
193 * @return string the PSR-3 compliant level
195 private static function mapLegacyConfigDebugLevel($level)
200 return LogLevel::ERROR;
203 return LogLevel::WARNING;
206 return LogLevel::NOTICE;
209 return LogLevel::INFO;
212 return LogLevel::DEBUG;
215 return LogLevel::DEBUG;
216 // default if nothing set
223 * Adding a handler to a given logger instance
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
231 * @throws InternalServerErrorException if the logger is incompatible to the logger factory
232 * @throws \Exception in case of general failures
234 public static function addStreamHandler($logger, $stream, $level = LogLevel::NOTICE)
236 if ($logger instanceof Monolog\Logger) {
237 $loglevel = Monolog\Logger::toMonologLevel($level);
239 // fallback to notice if an invalid loglevel is set
240 if (!is_int($loglevel)) {
241 $loglevel = LogLevel::NOTICE;
244 $fileHandler = new Monolog\Handler\StreamHandler($stream, $loglevel);
246 $formatter = new Monolog\Formatter\LineFormatter("%datetime% %channel% [%level_name%]: %message% %context% %extra%\n");
247 $fileHandler->setFormatter($formatter);
249 $logger->pushHandler($fileHandler);
251 throw new InternalServerErrorException('Logger instance incompatible for MonologFactory');
255 public static function addVoidHandler($logger)
257 if ($logger instanceof Monolog\Logger) {
258 $logger->pushHandler(new Monolog\Handler\NullHandler());