X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCore%2FLogger.php;h=fc2dde1dfe703f3de75e6044cc7fccc8b699e7bd;hb=6bb418c5a7cdd71d28a8a572059efb14401b70bd;hp=06134386700fe8893806fefaac1f9647d964d513;hpb=d6d593d724cd8d510bd1f6b2fd3302873cde3bca;p=friendica.git diff --git a/src/Core/Logger.php b/src/Core/Logger.php index 0613438670..fc2dde1dfe 100644 --- a/src/Core/Logger.php +++ b/src/Core/Logger.php @@ -4,139 +4,246 @@ */ namespace Friendica\Core; -use Friendica\Core\Config; -use Friendica\Util\DataTimeFormat; +use Psr\Log\LoggerInterface; +use Psr\Log\LogLevel; +/** + * @brief Logger functions + */ class Logger { - /** - * @brief Logs the given message at the given log level - * - * log levels: - * LOGGER_WARNING - * LOGGER_INFO (default) - * LOGGER_TRACE - * LOGGER_DEBUG - * LOGGER_DATA - * LOGGER_ALL - * - * @global array $LOGGER_LEVELS - * @param string $msg - * @param int $level - */ - public static function logger($msg, $level = LOGGER_INFO) - { - $a = get_app(); - global $LOGGER_LEVELS; - $LOGGER_LEVELS = []; - - $debugging = Config::get('system', 'debugging'); - $logfile = Config::get('system', 'logfile'); - $loglevel = intval(Config::get('system', 'loglevel')); - - if ( - !$debugging - || !$logfile - || $level > $loglevel - ) { - return; - } - - if (count($LOGGER_LEVELS) == 0) { - foreach (get_defined_constants() as $k => $v) { - if (substr($k, 0, 7) == "LOGGER_") { - $LOGGER_LEVELS[$v] = substr($k, 7, 7); - } - } - } - - $process_id = session_id(); - - if ($process_id == '') { - $process_id = get_app()->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), - $process_id, - $LOGGER_LEVELS[$level], - basename($callers[0]['file']), - $callers[0]['line'], - $function, - $msg - ); - - $stamp1 = microtime(true); - @file_put_contents($logfile, $logline, FILE_APPEND); - $a->saveTimestamp($stamp1, "file"); - } - - /** - * @brief An alternative logger for development. - * Works largely as logger() but allows developers - * to isolate particular elements they are targetting - * personally without background noise - * - * log levels: - * LOGGER_WARNING - * LOGGER_INFO (default) - * LOGGER_TRACE - * LOGGER_DEBUG - * LOGGER_DATA - * LOGGER_ALL - * - * @global array $LOGGER_LEVELS - * @param string $msg - * @param int $level - */ - public static function dlogger($msg, $level = LOGGER_INFO) - { - $a = get_app(); - - $logfile = Config::get('system', 'dlogfile'); - if (!$logfile) { - return; - } - - $dlogip = Config::get('system', 'dlogip'); - if (!is_null($dlogip) && $_SERVER['REMOTE_ADDR'] != $dlogip) { - return; - } - - if (count($LOGGER_LEVELS) == 0) { - foreach (get_defined_constants() as $k => $v) { - if (substr($k, 0, 7) == "LOGGER_") { - $LOGGER_LEVELS[$v] = substr($k, 7, 7); - } - } - } - - $process_id = session_id(); - - if ($process_id == '') { - $process_id = $a->process_id; - } - - $callers = debug_backtrace(); - $logline = sprintf("%s@\t%s:\t%s:\t%s\t%s\t%s\n", - DateTimeFormat::utcNow(), - $process_id, - basename($callers[0]['file']), - $callers[0]['line'], - $callers[1]['function'], - $msg - ); - - $stamp1 = microtime(true); - @file_put_contents($logfile, $logline, FILE_APPEND); - $a->saveTimestamp($stamp1, "file"); - } -} \ No newline at end of file + /** + * @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. + * + * @param LoggerInterface $logger The Logger instance of this Application + */ + public static function init(LoggerInterface $logger) + { + self::$logger = $logger; + } + + /** + * Sets the default dev-logging handler for Friendica. + * + * @param LoggerInterface $logger The Logger instance of this Application + */ + public static function setDevLogger(LoggerInterface $logger) + { + self::$devLogger = $logger; + } + + /** + * System is unusable. + * + * @see LoggerInterface::emergency() + * + * @param string $message + * @param array $context + * + * @return void + * @throws \Exception + */ + public static function emergency($message, $context = []) + { + self::$logger->emergency($message, $context); + } + + /** + * 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 = []) + { + self::$logger->alert($message, $context); + } + + /** + * 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 = []) + { + self::$logger->critical($message, $context); + } + + /** + * 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 = []) + { + self::$logger->error($message, $context); + } + + /** + * 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 = []) + { + self::$logger->warning($message, $context); + } + + /** + * Normal but significant events. + * @see LoggerInterface::notice() + * + * @param string $message + * @param array $context + * + * @return void + * @throws \Exception + */ + public static function notice($message, $context = []) + { + self::$logger->notice($message, $context); + } + + /** + * 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 = []) + { + self::$logger->info($message, $context); + } + + /** + * Detailed debug information. + * @see LoggerInterface::debug() + * + * @param string $message + * @param array $context + * + * @return void + * @throws \Exception + */ + public static function debug($message, $context = []) + { + self::$logger->debug($message, $context); + } + + /** + * @brief Logs the given message at the given log level + * + * @param string $msg + * @param string $level + * + * @throws \Exception + * @deprecated since 2019.03 Use Logger::debug() Logger::info() , ... instead + */ + public static function log($msg, $level = LogLevel::INFO) + { + self::$logger->log($level, $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 + * + * @param string $msg + * @param string $level + * @throws \Exception + */ + public static function devLog($msg, $level = LogLevel::DEBUG) + { + if (!isset(self::$devLogger)) { + return; + } + + self::$devLogger->log($level, $msg); + } +}