<?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\DI;
+use Friendica\Util\Logger\WorkerLogger;
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;
/**
- * @brief Logger functions
+ * Logger functions
*/
class Logger
{
/**
* @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
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
+ * @return LoggerInterface
*/
- private static $devLogger;
+ private static function getWorker()
+ {
+ if (self::$type === self::TYPE_LOGGER) {
+ return DI::logger();
+ } else {
+ return DI::workerLogger();
+ }
+ }
/**
- * Sets the default logging handler for Friendica.
+ * Enable additional logging for worker usage
+ *
+ * @param string $functionName The worker function, which got called
*
- * @param LoggerInterface $logger The Logger instance of this Application
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function init(LoggerInterface $logger)
+ public static function enableWorker(string $functionName)
{
- self::$logger = $logger;
+ self::$type = self::TYPE_WORKER;
+ self::getWorker()->setFunctionName($functionName);
}
/**
- * Sets the default dev-logging handler for Friendica.
- *
- * @param LoggerInterface $logger The Logger instance of this Application
+ * Disable additional logging for worker usage
*/
- public static function setDevLogger(LoggerInterface $logger)
+ public static function disableWorker()
{
- self::$devLogger = $logger;
+ self::$type = self::TYPE_LOGGER;
}
/**
*/
public static function emergency($message, $context = [])
{
- self::$logger->emergency($message, $context);
+ self::getWorker()->emergency($message, $context);
}
/**
*/
public static function alert($message, $context = [])
{
- self::$logger->alert($message, $context);
+ self::getWorker()->alert($message, $context);
}
/**
*/
public static function critical($message, $context = [])
{
- self::$logger->critical($message, $context);
+ self::getWorker()->critical($message, $context);
}
/**
*/
public static function error($message, $context = [])
{
- self::$logger->error($message, $context);
+ self::getWorker()->error($message, $context);
}
/**
*/
public static function warning($message, $context = [])
{
- self::$logger->warning($message, $context);
+ self::getWorker()->warning($message, $context);
}
/**
*/
public static function notice($message, $context = [])
{
- self::$logger->notice($message, $context);
+ self::getWorker()->notice($message, $context);
}
/**
*/
public static function info($message, $context = [])
{
- self::$logger->info($message, $context);
+ self::getWorker()->info($message, $context);
}
/**
*/
public static function debug($message, $context = [])
{
- self::$logger->debug($message, $context);
+ self::getWorker()->debug($message, $context);
}
- /**
- * @brief Logs the given message at the given log level
+ /**
+ * Logs the given message at the given log level
*
* @param string $msg
* @param string $level
*/
public static function log($msg, $level = LogLevel::INFO)
{
- self::$logger->log($level, $msg);
+ self::getWorker()->log($level, $msg);
}
/**
- * @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
* personally without background noise
*/
public static function devLog($msg, $level = LogLevel::DEBUG)
{
- if (!isset(self::$devLogger)) {
- return;
- }
-
- self::$devLogger->log($level, $msg);
+ DI::devLogger()->log($level, $msg);
}
}
projects / friendica.git / blobdiff