<?php
/**
- * @file src/Core/Logger.php
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
*/
+
namespace Friendica\Core;
-use Friendica\Core\Config;
-use Friendica\Util\DataTimeFormat;
+use Friendica\DI;
+use Friendica\Util\Logger\WorkerLogger;
+use Psr\Log\LoggerInterface;
+use Psr\Log\LogLevel;
+/**
+ * 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()
+ * @deprecated since 2019.01
+ */
+ const WARNING = LogLevel::ERROR;
+ /**
+ * @see Logger::warning()
+ * @deprecated since 2019.01
+ */
+ const INFO = LogLevel::WARNING;
+ /**
+ * @see Logger::notice()
+ * @deprecated since 2019.01
+ */
+ const TRACE = LogLevel::NOTICE;
+ /**
+ * @see Logger::info()
+ * @deprecated since 2019.01
+ */
+ const DEBUG = LogLevel::INFO;
+ /**
+ * @see Logger::debug()
+ * @deprecated since 2019.01
+ */
+ const DATA = LogLevel::DEBUG;
+ /**
+ * @see Logger::debug()
+ * @deprecated since 2019.01
+ */
+ const ALL = LogLevel::DEBUG;
+
+ /**
+ * @var LoggerInterface The default Logger type
+ */
+ const TYPE_LOGGER = LoggerInterface::class;
+ /**
+ * @var WorkerLogger A specific worker logger type, which can be anabled
+ */
+ const TYPE_WORKER = WorkerLogger::class;
+ /**
+ * @var LoggerInterface The current logger type
+ */
+ private static $type = self::TYPE_LOGGER;
+
+ /**
+ * @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',
+ ];
+
+ /**
+ * @return LoggerInterface
+ */
+ private static function getWorker()
+ {
+ if (self::$type === self::TYPE_LOGGER) {
+ return DI::logger();
+ } else {
+ return DI::workerLogger();
+ }
+ }
+
+ /**
+ * Enable additional logging for worker usage
+ *
+ * @param string $functionName The worker function, which got called
+ *
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ */
+ public static function enableWorker(string $functionName)
+ {
+ self::$type = self::TYPE_WORKER;
+ self::getWorker()->setFunctionName($functionName);
+ }
+
+ /**
+ * Disable additional logging for worker usage
+ */
+ public static function disableWorker()
+ {
+ self::$type = self::TYPE_LOGGER;
+ }
+
+ /**
+ * System is unusable.
+ *
+ * @see LoggerInterface::emergency()
+ *
+ * @param string $message
+ * @param array $context
+ *
+ * @return void
+ * @throws \Exception
+ */
+ public static function emergency($message, $context = [])
+ {
+ self::getWorker()->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::getWorker()->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::getWorker()->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::getWorker()->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::getWorker()->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::getWorker()->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::getWorker()->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::getWorker()->debug($message, $context);
+ }
+
+ /**
+ * 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::getWorker()->log($level, $msg);
+ }
+
+ /**
+ * 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)
+ {
+ DI::devLogger()->log($level, $msg);
+ }
+}
projects / friendica.git / blobdiff