2018-10-29 21:10:35 +01:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* @file src/Core/Logger.php
|
|
|
|
*/
|
|
|
|
namespace Friendica\Core;
|
|
|
|
|
2018-10-30 15:02:52 +01:00
|
|
|
use Friendica\BaseObject;
|
2019-02-03 22:22:04 +01:00
|
|
|
use Friendica\Factory\LoggerFactory;
|
2018-12-30 21:42:56 +01:00
|
|
|
use Friendica\Network\HTTPException\InternalServerErrorException;
|
|
|
|
use Psr\Log\LoggerInterface;
|
|
|
|
use Psr\Log\LogLevel;
|
2018-10-29 21:10:35 +01:00
|
|
|
|
2018-10-30 12:59:45 +01:00
|
|
|
/**
|
|
|
|
* @brief Logger functions
|
|
|
|
*/
|
|
|
|
class Logger extends BaseObject
|
2018-10-29 21:10:35 +01:00
|
|
|
{
|
2018-12-30 21:42:56 +01:00
|
|
|
/**
|
|
|
|
* @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 LoggerInterface $logger The Logger instance of this Application
|
|
|
|
*
|
|
|
|
* @throws InternalServerErrorException if the logger factory is incompatible to this logger
|
|
|
|
*/
|
|
|
|
public static function setLogger($logger)
|
|
|
|
{
|
|
|
|
$debugging = Config::get('system', 'debugging');
|
|
|
|
$logfile = Config::get('system', 'logfile');
|
|
|
|
$loglevel = Config::get('system', 'loglevel');
|
|
|
|
|
|
|
|
if (!$debugging || !$logfile) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2019-01-07 21:54:40 +01:00
|
|
|
$loglevel = self::mapLegacyConfigDebugLevel((string)$loglevel);
|
2018-12-30 21:42:56 +01:00
|
|
|
|
|
|
|
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);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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
|
|
|
|
*
|
2019-01-07 22:01:38 +01:00
|
|
|
* @param string $level the level to be mapped
|
2018-12-30 21:42:56 +01:00
|
|
|
*
|
|
|
|
* @return string the PSR-3 compliant level
|
|
|
|
*/
|
2019-01-07 21:18:34 +01:00
|
|
|
private static function mapLegacyConfigDebugLevel($level)
|
2018-12-30 21:42:56 +01:00
|
|
|
{
|
|
|
|
switch ($level) {
|
|
|
|
// legacy WARNING
|
2019-01-07 21:54:40 +01:00
|
|
|
case "0":
|
2018-12-30 21:42:56 +01:00
|
|
|
return LogLevel::ERROR;
|
|
|
|
// legacy INFO
|
2019-01-07 21:54:40 +01:00
|
|
|
case "1":
|
2018-12-30 21:42:56 +01:00
|
|
|
return LogLevel::WARNING;
|
|
|
|
// legacy TRACE
|
2019-01-07 21:54:40 +01:00
|
|
|
case "2":
|
2018-12-30 21:42:56 +01:00
|
|
|
return LogLevel::NOTICE;
|
|
|
|
// legacy DEBUG
|
2019-01-07 21:54:40 +01:00
|
|
|
case "3":
|
2018-12-30 21:42:56 +01:00
|
|
|
return LogLevel::INFO;
|
|
|
|
// legacy DATA
|
2019-01-07 21:54:40 +01:00
|
|
|
case "4":
|
2018-12-30 21:42:56 +01:00
|
|
|
return LogLevel::DEBUG;
|
|
|
|
// legacy ALL
|
2019-01-07 21:54:40 +01:00
|
|
|
case "5":
|
2018-12-30 21:42:56 +01:00
|
|
|
return LogLevel::DEBUG;
|
|
|
|
// default if nothing set
|
|
|
|
default:
|
2019-01-07 21:54:40 +01:00
|
|
|
return $level;
|
2018-12-30 21:42:56 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* System is unusable.
|
2019-01-06 22:06:53 +01:00
|
|
|
*
|
2018-12-30 21:42:56 +01:00
|
|
|
* @see LoggerInterface::emergency()
|
|
|
|
*
|
|
|
|
* @param string $message
|
|
|
|
* @param array $context
|
|
|
|
*
|
|
|
|
* @return void
|
2019-01-06 22:06:53 +01:00
|
|
|
* @throws \Exception
|
2018-12-30 21:42:56 +01:00
|
|
|
*/
|
|
|
|
public static function emergency($message, $context = [])
|
|
|
|
{
|
|
|
|
if (!isset(self::$logger)) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
$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
|
2019-01-06 22:06:53 +01:00
|
|
|
* @throws \Exception
|
2018-12-30 21:42:56 +01:00
|
|
|
*/
|
|
|
|
public static function alert($message, $context = [])
|
|
|
|
{
|
|
|
|
if (!isset(self::$logger)) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
$stamp1 = microtime(true);
|
|
|
|
self::$logger->alert($message, $context);
|
|
|
|
self::getApp()->saveTimestamp($stamp1, 'file');
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Critical conditions.
|
|
|
|
* @see LoggerInterface::critical()
|
|
|
|
*
|
|
|
|
* Example: Application component unavailable, unexpected exception.
|
|
|
|
*
|
|
|
|
* @param string $message
|
|
|
|
* @param array $context
|
|
|
|
*
|
|
|
|
* @return void
|
2019-01-06 22:06:53 +01:00
|
|
|
* @throws \Exception
|
2018-12-30 21:42:56 +01:00
|
|
|
*/
|
|
|
|
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
|
2019-01-06 22:06:53 +01:00
|
|
|
* @throws \Exception
|
2018-12-30 21:42:56 +01:00
|
|
|
*/
|
|
|
|
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
|
2019-01-06 22:06:53 +01:00
|
|
|
* @throws \Exception
|
2018-12-30 21:42:56 +01:00
|
|
|
*/
|
|
|
|
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
|
2019-01-06 22:06:53 +01:00
|
|
|
* @throws \Exception
|
2018-12-30 21:42:56 +01:00
|
|
|
*/
|
|
|
|
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
|
2019-01-06 22:06:53 +01:00
|
|
|
* @throws \Exception
|
2018-12-30 21:42:56 +01:00
|
|
|
*/
|
|
|
|
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
|
2019-01-06 22:06:53 +01:00
|
|
|
* @throws \Exception
|
2018-12-30 21:42:56 +01:00
|
|
|
*/
|
|
|
|
public static function debug($message, $context = [])
|
|
|
|
{
|
|
|
|
if (!isset(self::$logger)) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
$stamp1 = microtime(true);
|
|
|
|
self::$logger->debug($message, $context);
|
|
|
|
self::getApp()->saveTimestamp($stamp1, 'file');
|
|
|
|
}
|
2019-01-01 17:42:08 +01:00
|
|
|
|
2019-01-07 20:21:58 +01:00
|
|
|
/**
|
|
|
|
* @brief Logs the given message at the given log level
|
|
|
|
*
|
|
|
|
* @param string $msg
|
2019-01-07 21:08:09 +01:00
|
|
|
* @param string $level
|
2018-12-30 21:42:56 +01:00
|
|
|
*
|
2019-01-06 22:06:53 +01:00
|
|
|
* @throws \Exception
|
2018-12-30 21:42:56 +01:00
|
|
|
* @deprecated since 2019.03 Use Logger::debug() Logger::info() , ... instead
|
2019-01-07 20:21:58 +01:00
|
|
|
*/
|
2019-01-07 21:08:09 +01:00
|
|
|
public static function log($msg, $level = LogLevel::INFO)
|
2018-10-29 21:10:35 +01:00
|
|
|
{
|
2018-12-30 21:42:56 +01:00
|
|
|
if (!isset(self::$logger)) {
|
|
|
|
return;
|
|
|
|
}
|
2019-01-01 17:42:08 +01:00
|
|
|
|
2018-10-29 21:10:35 +01:00
|
|
|
$stamp1 = microtime(true);
|
2019-01-07 21:08:09 +01:00
|
|
|
self::$logger->log($level, $msg);
|
2018-12-30 21:42:56 +01:00
|
|
|
self::getApp()->saveTimestamp($stamp1, "file");
|
2018-10-29 21:10:35 +01:00
|
|
|
}
|
|
|
|
|
2019-01-06 22:06:53 +01:00
|
|
|
/**
|
|
|
|
* @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
|
2018-12-30 21:42:56 +01:00
|
|
|
* @param string $level
|
2019-01-06 22:06:53 +01:00
|
|
|
* @throws \Exception
|
|
|
|
*/
|
2018-12-30 21:42:56 +01:00
|
|
|
public static function devLog($msg, $level = LogLevel::DEBUG)
|
2018-10-29 21:10:35 +01:00
|
|
|
{
|
2018-12-30 21:42:56 +01:00
|
|
|
if (!isset(self::$logger)) {
|
|
|
|
return;
|
|
|
|
}
|
2018-10-29 21:10:35 +01:00
|
|
|
|
|
|
|
$stamp1 = microtime(true);
|
2018-12-30 21:42:56 +01:00
|
|
|
self::$devLogger->log($level, $msg);
|
|
|
|
self::getApp()->saveTimestamp($stamp1, "file");
|
2018-10-29 21:10:35 +01:00
|
|
|
}
|
2018-10-30 12:59:45 +01:00
|
|
|
}
|