<?php
/**
- * @file src/Core/Logger.php
+ * @copyright Copyright (C) 2010-2023, 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\BaseObject;
-use Friendica\Factory\LoggerFactory;
-use Friendica\Network\HTTPException\InternalServerErrorException;
+use Friendica\DI;
+use Friendica\Core\Logger\Type\WorkerLogger;
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;
/**
- * @brief Logger functions
+ * Logger functions
*/
-class Logger extends BaseObject
+class Logger
{
/**
- * @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()
+ * @var LoggerInterface The default Logger type
*/
- const ALL = LogLevel::DEBUG;
-
+ const TYPE_LOGGER = LoggerInterface::class;
/**
- * @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
- *
+ * @var WorkerLogger A specific worker logger type, which can be enabled
*/
- public static $levels = [
- self::WARNING => 'Warning',
- self::INFO => 'Info',
- self::TRACE => 'Trace',
- self::DEBUG => 'Debug',
- self::DATA => 'Data',
- self::ALL => 'All',
- ];
-
+ const TYPE_WORKER = WorkerLogger::class;
/**
- * @var LoggerInterface A PSR-3 compliant logger instance
+ * @var LoggerInterface The current logger type
*/
- private static $logger;
+ private static $type = self::TYPE_LOGGER;
/**
- * @var LoggerInterface A PSR-3 compliant logger instance for developing only
+ * @return LoggerInterface
*/
- private static $devLogger;
+ private static function getInstance()
+ {
+ if (self::$type === self::TYPE_LOGGER) {
+ return DI::logger();
+ } else {
+ return DI::workerLogger();
+ }
+ }
/**
- * Sets the default logging handler for Friendica.
- * @todo Can be combined with other handlers too if necessary, could be configurable.
+ * Enable additional logging for worker usage
*
- * @param LoggerInterface $logger The Logger instance of this Application
+ * @param string $functionName The worker function, which got called
*
- * @throws InternalServerErrorException if the logger factory is incompatible to this logger
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function setLogger($logger)
+ public static function enableWorker(string $functionName)
{
- $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;
- }
-
- $developIp = Config::get('system', 'dlogip');
-
- self::$devLogger = LoggerFactory::createDev('develop', $developIp);
- LoggerFactory::addStreamHandler(self::$devLogger, $logfile, LogLevel::DEBUG);
+ self::$type = self::TYPE_WORKER;
+ self::getInstance()->setFunctionName($functionName);
}
/**
- * 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
- *
- * @return string the PSR-3 compliant level
+ * Disable additional logging for worker usage
*/
- private static function mapLegacyConfigDebugLevel($level)
+ public static function disableWorker()
{
- 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;
- }
+ self::$type = self::TYPE_LOGGER;
}
/**
*
* @see LoggerInterface::emergency()
*
- * @param string $message
- * @param array $context
- *
+ * @param string $message Message to log
+ * @param array $context Optional variables
* @return void
* @throws \Exception
*/
- public static function emergency($message, $context = [])
+ public static function emergency(string $message, array $context = [])
{
- if (!isset(self::$logger)) {
- return;
- }
-
- $stamp1 = microtime(true);
- self::$logger->emergency($message, $context);
- self::getApp()->saveTimestamp($stamp1, 'file');
+ self::getInstance()->emergency($message, $context);
}
/**
* Example: Entire website down, database unavailable, etc. This should
* trigger the SMS alerts and wake you up.
*
- * @param string $message
- * @param array $context
- *
+ * @param string $message Message to log
+ * @param array $context Optional variables
* @return void
* @throws \Exception
*/
- public static function alert($message, $context = [])
+ public static function alert(string $message, array $context = [])
{
- if (!isset(self::$logger)) {
- return;
- }
-
- $stamp1 = microtime(true);
- self::$logger->alert($message, $context);
- self::getApp()->saveTimestamp($stamp1, 'file');
+ self::getInstance()->alert($message, $context);
}
/**
*
* Example: Application component unavailable, unexpected exception.
*
- * @param string $message
- * @param array $context
- *
+ * @param string $message Message to log
+ * @param array $context Optional variables
* @return void
* @throws \Exception
*/
- public static function critical($message, $context = [])
+ public static function critical(string $message, array $context = [])
{
- if (!isset(self::$logger)) {
- return;
- }
-
- $stamp1 = microtime(true);
- self::$logger->critical($message, $context);
- self::getApp()->saveTimestamp($stamp1, 'file');
+ self::getInstance()->critical($message, $context);
}
/**
* be logged and monitored.
* @see LoggerInterface::error()
*
- * @param string $message
- * @param array $context
- *
+ * @param string $message Message to log
+ * @param array $context Optional variables
* @return void
* @throws \Exception
*/
- public static function error($message, $context = [])
+ public static function error(string $message, array $context = [])
{
- if (!isset(self::$logger)) {
- echo "not set!?\n";
- return;
- }
-
- $stamp1 = microtime(true);
- self::$logger->error($message, $context);
- self::getApp()->saveTimestamp($stamp1, 'file');
+ self::getInstance()->error($message, $context);
}
/**
* Example: Use of deprecated APIs, poor use of an API, undesirable things
* that are not necessarily wrong.
*
- * @param string $message
- * @param array $context
- *
+ * @param string $message Message to log
+ * @param array $context Optional variables
* @return void
* @throws \Exception
*/
- public static function warning($message, $context = [])
+ public static function warning(string $message, array $context = [])
{
- if (!isset(self::$logger)) {
- return;
- }
-
- $stamp1 = microtime(true);
- self::$logger->warning($message, $context);
- self::getApp()->saveTimestamp($stamp1, 'file');
+ self::getInstance()->warning($message, $context);
}
/**
* Normal but significant events.
* @see LoggerInterface::notice()
*
- * @param string $message
- * @param array $context
- *
+ * @param string $message Message to log
+ * @param array $context Optional variables
* @return void
* @throws \Exception
*/
- public static function notice($message, $context = [])
+ public static function notice(string $message, array $context = [])
{
- if (!isset(self::$logger)) {
- return;
- }
-
- $stamp1 = microtime(true);
- self::$logger->notice($message, $context);
- self::getApp()->saveTimestamp($stamp1, 'file');
+ self::getInstance()->notice($message, $context);
}
/**
* @return void
* @throws \Exception
*/
- public static function info($message, $context = [])
+ public static function info(string $message, array $context = [])
{
- if (!isset(self::$logger)) {
- return;
- }
-
- $stamp1 = microtime(true);
- self::$logger->info($message, $context);
- self::getApp()->saveTimestamp($stamp1, 'file');
+ self::getInstance()->info($message, $context);
}
/**
* Detailed debug information.
* @see LoggerInterface::debug()
*
- * @param string $message
- * @param array $context
- *
+ * @param string $message Message to log
+ * @param array $context Optional variables
* @return void
* @throws \Exception
*/
- public static function debug($message, $context = [])
+ public static function debug(string $message, array $context = [])
{
- if (!isset(self::$logger)) {
- return;
- }
-
- $stamp1 = microtime(true);
- self::$logger->debug($message, $context);
- self::getApp()->saveTimestamp($stamp1, 'file');
+ self::getInstance()->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)
- {
- if (!isset(self::$logger)) {
- return;
- }
-
- $stamp1 = microtime(true);
- self::$logger->log($level, $msg);
- self::getApp()->saveTimestamp($stamp1, "file");
- }
-
/**
- * @brief An alternative logger for development.
+ * An alternative logger for development.
+ *
* Works largely as log() but allows developers
- * to isolate particular elements they are targetting
+ * to isolate particular elements they are targeting
* personally without background noise
*
- * @param string $msg
- * @param string $level
+ * @param string $message Message to log
+ * @param string $level Logging level
+ * @return void
* @throws \Exception
*/
- public static function devLog($msg, $level = LogLevel::DEBUG)
- {
- if (!isset(self::$logger)) {
- return;
- }
-
- $stamp1 = microtime(true);
- self::$devLogger->log($level, $msg);
- self::getApp()->saveTimestamp($stamp1, "file");
- }
+ public static function devLog(string $message, string $level = LogLevel::DEBUG)
+ {
+ DI::devLogger()->log($level, $message);
+ }
}
projects / friendica.git / blobdiff