*/
namespace Friendica\Core;
-use Friendica\App;
use Friendica\BaseObject;
-use Monolog;
-use Friendica\Util\DateTimeFormat;
+use Friendica\Factory\LoggerFactory;
+use Friendica\Network\HTTPException\InternalServerErrorException;
+use Psr\Log\LoggerInterface;
+use Psr\Log\LogLevel;
/**
* @brief Logger functions
class Logger extends BaseObject
{
/**
- * Creates a basic Monolog instance for logging.
+ * @see Logger::error()
+ */
+ const WARNING = LogLevel::ERROR;
+ /**
+ * @see Logger::warning()
+ */
+ const INFO = LogLevel::WARNING;
+ /**
+ * @see Logger::notice()
+ */
+ const TRACE = LogLevel::NOTICE;
+ /**
+ * @see Logger::info()
+ */
+ const DEBUG = LogLevel::INFO;
+ /**
+ * @see Logger::debug()
+ */
+ const DATA = LogLevel::DEBUG;
+ /**
+ * @see Logger::debug()
+ */
+ const ALL = LogLevel::DEBUG;
+
+ /**
+ * @var array the legacy loglevels
+ * @deprecated 2019.03 use PSR-3 loglevels
+ * @see https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#5-psrlogloglevel
+ *
+ */
+ public static $levels = [
+ self::WARNING => 'Warning',
+ self::INFO => 'Info',
+ self::TRACE => 'Trace',
+ self::DEBUG => 'Debug',
+ self::DATA => 'Data',
+ self::ALL => 'All',
+ ];
+
+ /**
+ * @var LoggerInterface A PSR-3 compliant logger instance
+ */
+ private static $logger;
+
+ /**
+ * @var LoggerInterface A PSR-3 compliant logger instance for developing only
+ */
+ private static $devLogger;
+
+ /**
+ * Sets the default logging handler for Friendica.
+ * @todo Can be combined with other handlers too if necessary, could be configurable.
*
- * @param string $application the current application name (index, daemon, ...)
+ * @param LoggerInterface $logger The Logger instance of this Application
*
- * @return Monolog\Logger The Logger instance
+ * @throws InternalServerErrorException if the logger factory is incompatible to this logger
*/
- public static function create($application)
+ public static function setLogger($logger)
{
- $logger = new Monolog\Logger($application);
+ $debugging = Config::get('system', 'debugging');
+ $logfile = Config::get('system', 'logfile');
+ $loglevel = Config::get('system', 'loglevel');
+
+ if (!$debugging || !$logfile) {
+ return;
+ }
+
+ $loglevel = self::mapLegacyConfigDebugLevel((string)$loglevel);
+
+ LoggerFactory::addStreamHandler($logger, $logfile, $loglevel);
+
+ self::$logger = $logger;
+
+ $logfile = Config::get('system', 'dlogfile');
+
+ if (!$logfile) {
+ return;
+ }
- $logger->pushProcessor(new Monolog\Processor\IntrospectionProcessor());
- $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor());
- $logger->pushProcessor(new Monolog\Processor\WebProcessor());
- $logger->pushProcessor(new App\FriendicaLoggerProcessor());
+ $developIp = Config::get('system', 'dlogip');
- return $logger;
+ self::$devLogger = LoggerFactory::createDev('develop', $developIp);
+ LoggerFactory::addStreamHandler(self::$devLogger, $logfile, LogLevel::DEBUG);
}
/**
- * Sets the default Logging handler for this instance.
- * Can be combined with other handlers too if necessary.
+ * Mapping a legacy level to the PSR-3 compliant levels
+ * @see https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#5-psrlogloglevel
+ *
+ * @param string $level the level to be mapped
*
- * @param Monolog\Logger $logger The Logger instance of this Application
- * @param App $app The Friendica Application
+ * @return string the PSR-3 compliant level
*/
- public static function loadDefaultHandler($logger, $app)
+ private static function mapLegacyConfigDebugLevel($level)
{
- foreach ($logger->getProcessors() as $processor) {
- if ($processor instanceof App\FriendicaLoggerProcessor) {
- $processor->setProcessId($app->process_id);
- }
+ switch ($level) {
+ // legacy WARNING
+ case "0":
+ return LogLevel::ERROR;
+ // legacy INFO
+ case "1":
+ return LogLevel::WARNING;
+ // legacy TRACE
+ case "2":
+ return LogLevel::NOTICE;
+ // legacy DEBUG
+ case "3":
+ return LogLevel::INFO;
+ // legacy DATA
+ case "4":
+ return LogLevel::DEBUG;
+ // legacy ALL
+ case "5":
+ return LogLevel::DEBUG;
+ // default if nothing set
+ default:
+ return $level;
}
+ }
- $debugging = Config::get('system', 'debugging');
- $logfile = Config::get('system', 'logfile');
- $loglevel = intval(Config::get('system', 'loglevel'));
+ /**
+ * System is unusable.
+ *
+ * @see LoggerInterface::emergency()
+ *
+ * @param string $message
+ * @param array $context
+ *
+ * @return void
+ * @throws \Exception
+ */
+ public static function emergency($message, $context = [])
+ {
+ if (!isset(self::$logger)) {
+ return;
+ }
- if (!$debugging || !$logfile) {
+ $stamp1 = microtime(true);
+ self::$logger->emergency($message, $context);
+ self::getApp()->saveTimestamp($stamp1, 'file');
+ }
+
+ /**
+ * Action must be taken immediately.
+ * @see LoggerInterface::alert()
+ *
+ * Example: Entire website down, database unavailable, etc. This should
+ * trigger the SMS alerts and wake you up.
+ *
+ * @param string $message
+ * @param array $context
+ *
+ * @return void
+ * @throws \Exception
+ */
+ public static function alert($message, $context = [])
+ {
+ if (!isset(self::$logger)) {
return;
}
- $fileHandler = new Monolog\Handler\StreamHandler($logfile . ".1", $loglevel);
- $logger->pushHandler($fileHandler);
+ $stamp1 = microtime(true);
+ self::$logger->alert($message, $context);
+ self::getApp()->saveTimestamp($stamp1, 'file');
}
- // Log levels:
- //EMERGENCY
- //ALERT
- //CRITICAL
- const WARNING = 0; //ERROR
- const INFO = 1; //WARNING
- const TRACE = 2; //NOTICE(default)
- const DEBUG = 3; //INFO
- const DATA = 4; //INFO
- const ALL = 5; //DEBUG
-
- public static $levels = [
- self::WARNING => 'Warning',
- self::INFO => 'Info',
- self::TRACE => 'Trace',
- self::DEBUG => 'Debug',
- self::DATA => 'Data',
- self::ALL => 'All',
- ];
+ /**
+ * Critical conditions.
+ * @see LoggerInterface::critical()
+ *
+ * Example: Application component unavailable, unexpected exception.
+ *
+ * @param string $message
+ * @param array $context
+ *
+ * @return void
+ * @throws \Exception
+ */
+ public static function critical($message, $context = [])
+ {
+ if (!isset(self::$logger)) {
+ return;
+ }
+
+ $stamp1 = microtime(true);
+ self::$logger->critical($message, $context);
+ self::getApp()->saveTimestamp($stamp1, 'file');
+ }
+
+ /**
+ * Runtime errors that do not require immediate action but should typically
+ * be logged and monitored.
+ * @see LoggerInterface::error()
+ *
+ * @param string $message
+ * @param array $context
+ *
+ * @return void
+ * @throws \Exception
+ */
+ public static function error($message, $context = [])
+ {
+ if (!isset(self::$logger)) {
+ echo "not set!?\n";
+ return;
+ }
+
+ $stamp1 = microtime(true);
+ self::$logger->error($message, $context);
+ self::getApp()->saveTimestamp($stamp1, 'file');
+ }
+
+ /**
+ * Exceptional occurrences that are not errors.
+ * @see LoggerInterface::warning()
+ *
+ * Example: Use of deprecated APIs, poor use of an API, undesirable things
+ * that are not necessarily wrong.
+ *
+ * @param string $message
+ * @param array $context
+ *
+ * @return void
+ * @throws \Exception
+ */
+ public static function warning($message, $context = [])
+ {
+ if (!isset(self::$logger)) {
+ return;
+ }
+
+ $stamp1 = microtime(true);
+ self::$logger->warning($message, $context);
+ self::getApp()->saveTimestamp($stamp1, 'file');
+ }
+
+ /**
+ * Normal but significant events.
+ * @see LoggerInterface::notice()
+ *
+ * @param string $message
+ * @param array $context
+ *
+ * @return void
+ * @throws \Exception
+ */
+ public static function notice($message, $context = [])
+ {
+ if (!isset(self::$logger)) {
+ return;
+ }
+
+ $stamp1 = microtime(true);
+ self::$logger->notice($message, $context);
+ self::getApp()->saveTimestamp($stamp1, 'file');
+ }
+
+ /**
+ * Interesting events.
+ * @see LoggerInterface::info()
+ *
+ * Example: User logs in, SQL logs.
+ *
+ * @param string $message
+ * @param array $context
+ *
+ * @return void
+ * @throws \Exception
+ */
+ public static function info($message, $context = [])
+ {
+ if (!isset(self::$logger)) {
+ return;
+ }
+
+ $stamp1 = microtime(true);
+ self::$logger->info($message, $context);
+ self::getApp()->saveTimestamp($stamp1, 'file');
+ }
+
+ /**
+ * Detailed debug information.
+ * @see LoggerInterface::debug()
+ *
+ * @param string $message
+ * @param array $context
+ *
+ * @return void
+ * @throws \Exception
+ */
+ public static function debug($message, $context = [])
+ {
+ if (!isset(self::$logger)) {
+ return;
+ }
+
+ $stamp1 = microtime(true);
+ self::$logger->debug($message, $context);
+ self::getApp()->saveTimestamp($stamp1, 'file');
+ }
/**
* @brief Logs the given message at the given log level
*
* @param string $msg
- * @param int $level
+ * @param string $level
*
- * @deprecated since 2019.03 - use App->getLogger() instead
+ * @throws \Exception
+ * @deprecated since 2019.03 Use Logger::debug() Logger::info() , ... instead
*/
- public static function log($msg, $level = self::INFO)
+ public static function log($msg, $level = LogLevel::INFO)
{
- $a = self::getApp();
-
- $debugging = Config::get('system', 'debugging');
- $logfile = Config::get('system', 'logfile');
- $loglevel = intval(Config::get('system', 'loglevel'));
-
- if (
- !$debugging
- || !$logfile
- || $level > $loglevel
- ) {
- return;
- }
-
- $processId = session_id();
-
- if ($processId == '')
- {
- $processId = $a->process_id;
- }
-
- $callers = debug_backtrace();
-
- if (count($callers) > 1) {
- $function = $callers[1]['function'];
- } else {
- $function = '';
- }
-
- $logline = sprintf("%s@%s\t[%s]:%s:%s:%s\t%s\n",
- DateTimeFormat::utcNow(DateTimeFormat::ATOM),
- $processId,
- self::$levels[$level],
- basename($callers[0]['file']),
- $callers[0]['line'],
- $function,
- $msg
- );
+ if (!isset(self::$logger)) {
+ return;
+ }
$stamp1 = microtime(true);
- @file_put_contents($logfile, $logline, FILE_APPEND);
- $a->saveTimestamp($stamp1, "file");
+ self::$logger->log($level, $msg);
+ self::getApp()->saveTimestamp($stamp1, "file");
}
- /**
- * @brief An alternative logger for development.
- * Works largely as log() but allows developers
- * to isolate particular elements they are targetting
- * personally without background noise
- *
- * @param string $msg
+ /**
+ * @brief An alternative logger for development.
+ * Works largely as log() but allows developers
+ * to isolate particular elements they are targetting
+ * personally without background noise
*
- * * @deprecated since 2019.03 - never used
- */
- public static function devLog($msg)
+ * @param string $msg
+ * @param string $level
+ * @throws \Exception
+ */
+ public static function devLog($msg, $level = LogLevel::DEBUG)
{
- $a = self::getApp();
-
- $logfile = Config::get('system', 'dlogfile');
-
- if (!$logfile) {
- return;
- }
-
- $dlogip = Config::get('system', 'dlogip');
-
- if (!is_null($dlogip) && $_SERVER['REMOTE_ADDR'] != $dlogip)
- {
- return;
- }
-
- $processId = session_id();
-
- if ($processId == '')
- {
- $processId = $a->process_id;
- }
-
- if (!is_string($msg)) {
- $msg = var_export($msg, true);
- }
-
- $callers = debug_backtrace();
- $logline = sprintf("%s@\t%s:\t%s:\t%s\t%s\t%s\n",
- DateTimeFormat::utcNow(),
- $processId,
- basename($callers[0]['file']),
- $callers[0]['line'],
- $callers[1]['function'],
- $msg
- );
+ if (!isset(self::$logger)) {
+ return;
+ }
$stamp1 = microtime(true);
- @file_put_contents($logfile, $logline, FILE_APPEND);
- $a->saveTimestamp($stamp1, "file");
+ self::$devLogger->log($level, $msg);
+ self::getApp()->saveTimestamp($stamp1, "file");
}
}
projects / friendica.git / blobdiff