3 namespace Friendica\Factory;
5 use Friendica\Core\Config\IConfiguration;
6 use Friendica\Core\Logger;
7 use Friendica\Database\Database;
8 use Friendica\Network\HTTPException\InternalServerErrorException;
9 use Friendica\Util\FileSystem;
10 use Friendica\Util\Introspection;
11 use Friendica\Util\Logger\Monolog\DevelopHandler;
12 use Friendica\Util\Logger\Monolog\IntrospectionProcessor;
13 use Friendica\Util\Logger\ProfilerLogger;
14 use Friendica\Util\Logger\StreamLogger;
15 use Friendica\Util\Logger\SyslogLogger;
16 use Friendica\Util\Logger\VoidLogger;
17 use Friendica\Util\Profiler;
19 use Psr\Log\LoggerInterface;
25 * Currently only Monolog is supported
29 const DEV_CHANNEL = 'dev';
32 * A list of classes, which shouldn't get logged
36 private static $ignoreClassList = [
39 'Friendica\\Util\\Logger',
44 public function __construct(string $channel)
46 $this->channel = $channel;
50 * Creates a new PSR-3 compliant logger instances
52 * @param Database $database The Friendica Database instance
53 * @param IConfiguration $config The config
54 * @param Profiler $profiler The profiler of the app
55 * @param FileSystem $fileSystem FileSystem utils
57 * @return LoggerInterface The PSR-3 compliant logger instance
59 public function create(Database $database, IConfiguration $config, Profiler $profiler, FileSystem $fileSystem)
61 if (empty($config->get('system', 'debugging', false))) {
62 $logger = new VoidLogger();
63 $database->setLogger($logger);
67 $introspection = new Introspection(self::$ignoreClassList);
68 $level = $config->get('system', 'loglevel');
69 $loglevel = self::mapLegacyConfigDebugLevel((string)$level);
71 switch ($config->get('system', 'logger_config', 'stream')) {
73 $loggerTimeZone = new \DateTimeZone('UTC');
74 Monolog\Logger::setTimezone($loggerTimeZone);
76 $logger = new Monolog\Logger($this->channel);
77 $logger->pushProcessor(new Monolog\Processor\PsrLogMessageProcessor());
78 $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor());
79 $logger->pushProcessor(new Monolog\Processor\UidProcessor());
80 $logger->pushProcessor(new IntrospectionProcessor($introspection, LogLevel::DEBUG));
82 $stream = $config->get('system', 'logfile');
84 // just add a stream in case it's either writable or not file
85 if (!is_file($stream) || is_writable($stream)) {
87 static::addStreamHandler($logger, $stream, $loglevel);
88 } catch (\Throwable $e) {
90 $logger = new VoidLogger();
97 $logger = new SyslogLogger($this->channel, $introspection, $loglevel);
98 } catch (\Throwable $e) {
100 $logger = new VoidLogger();
106 $stream = $config->get('system', 'logfile');
107 // just add a stream in case it's either writable or not file
108 if (!is_file($stream) || is_writable($stream)) {
110 $logger = new StreamLogger($this->channel, $stream, $introspection, $fileSystem, $loglevel);
111 } catch (\Throwable $t) {
113 $logger = new VoidLogger();
116 $logger = new VoidLogger();
121 $profiling = $config->get('system', 'profiling', false);
123 // In case profiling is enabled, wrap the ProfilerLogger around the current logger
124 if (isset($profiling) && $profiling !== false) {
125 $logger = new ProfilerLogger($logger, $profiler);
128 $database->setLogger($logger);
133 * Creates a new PSR-3 compliant develop logger
135 * If you want to debug only interactions from your IP or the IP of a remote server for federation debug,
136 * you'll use this logger instance for the duration of your work.
138 * It should never get filled during normal usage of Friendica
140 * @param IConfiguration $config The config
141 * @param Profiler $profiler The profiler of the app
142 * @param FileSystem $fileSystem FileSystem utils
144 * @return LoggerInterface The PSR-3 compliant logger instance
146 * @throws InternalServerErrorException
149 public static function createDev(IConfiguration $config, Profiler $profiler, FileSystem $fileSystem)
151 $debugging = $config->get('system', 'debugging');
152 $stream = $config->get('system', 'dlogfile');
153 $developerIp = $config->get('system', 'dlogip');
155 if ((!isset($developerIp) || !$debugging) &&
156 (!is_file($stream) || is_writable($stream))) {
157 $logger = new VoidLogger();
161 $loggerTimeZone = new \DateTimeZone('UTC');
162 Monolog\Logger::setTimezone($loggerTimeZone);
164 $introspection = new Introspection(self::$ignoreClassList);
166 switch ($config->get('system', 'logger_config', 'stream')) {
169 $loggerTimeZone = new \DateTimeZone('UTC');
170 Monolog\Logger::setTimezone($loggerTimeZone);
172 $logger = new Monolog\Logger(self::DEV_CHANNEL);
173 $logger->pushProcessor(new Monolog\Processor\PsrLogMessageProcessor());
174 $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor());
175 $logger->pushProcessor(new Monolog\Processor\UidProcessor());
176 $logger->pushProcessor(new IntrospectionProcessor($introspection, LogLevel::DEBUG));
178 $logger->pushHandler(new DevelopHandler($developerIp));
180 static::addStreamHandler($logger, $stream, LogLevel::DEBUG);
184 $logger = new SyslogLogger(self::DEV_CHANNEL, $introspection, LogLevel::DEBUG);
189 $logger = new StreamLogger(self::DEV_CHANNEL, $stream, $introspection, $fileSystem, LogLevel::DEBUG);
193 $profiling = $config->get('system', 'profiling', false);
195 // In case profiling is enabled, wrap the ProfilerLogger around the current logger
196 if (isset($profiling) && $profiling !== false) {
197 $logger = new ProfilerLogger($logger, $profiler);
204 * Mapping a legacy level to the PSR-3 compliant levels
206 * @see https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#5-psrlogloglevel
208 * @param string $level the level to be mapped
210 * @return string the PSR-3 compliant level
212 private static function mapLegacyConfigDebugLevel($level)
217 return LogLevel::ERROR;
220 return LogLevel::WARNING;
223 return LogLevel::NOTICE;
226 return LogLevel::INFO;
231 return LogLevel::DEBUG;
232 // default if nothing set
239 * Adding a handler to a given logger instance
241 * @param LoggerInterface $logger The logger instance
242 * @param mixed $stream The stream which handles the logger output
243 * @param string $level The level, for which this handler at least should handle logging
247 * @throws \Exception in case of general failures
249 public static function addStreamHandler($logger, $stream, $level = LogLevel::NOTICE)
251 if ($logger instanceof Monolog\Logger) {
252 $loglevel = Monolog\Logger::toMonologLevel($level);
254 // fallback to notice if an invalid loglevel is set
255 if (!is_int($loglevel)) {
256 $loglevel = LogLevel::NOTICE;
259 $fileHandler = new Monolog\Handler\StreamHandler($stream, $loglevel);
261 $formatter = new Monolog\Formatter\LineFormatter("%datetime% %channel% [%level_name%]: %message% %context% %extra%\n");
262 $fileHandler->setFormatter($formatter);
264 $logger->pushHandler($fileHandler);
268 public static function addVoidHandler($logger)
270 if ($logger instanceof Monolog\Logger) {
271 $logger->pushHandler(new Monolog\Handler\NullHandler());