]> git.mxchange.org Git - friendica.git/blobdiff - src/Core/Logger.php
Update HTML::purify debug comment formatting
[friendica.git] / src / Core / Logger.php
index 67e58ef6b1206140033ba81d0b0ec59c4302a40e..6dde142cc953f3feae67ec1c39d1d882d009909d 100644 (file)
@@ -1,43 +1,80 @@
 <?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\BaseObject;
+use Friendica\DI;
+use Friendica\Util\Logger\WorkerLogger;
 use Psr\Log\LoggerInterface;
 use Psr\Log\LogLevel;
 
 /**
- * @brief Logger functions
+ * Logger functions
  */
-class Logger extends BaseObject
+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
@@ -50,37 +87,39 @@ class Logger extends BaseObject
                self::TRACE => 'Trace',
                self::DEBUG => 'Debug',
                self::DATA => 'Data',
-               self::ALL => 'All',
        ];
 
        /**
-        * @var LoggerInterface A PSR-3 compliant logger instance
+        * @return LoggerInterface
         */
-       private static $logger;
-
-       /**
-        * @var LoggerInterface A PSR-3 compliant logger instance for developing only
-        */
-       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($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($logger)
+       public static function disableWorker()
        {
-               self::$devLogger = $logger;
+               self::$type = self::TYPE_LOGGER;
        }
 
        /**
@@ -96,13 +135,7 @@ class Logger extends BaseObject
         */
        public static function emergency($message, $context = [])
        {
-               if (!isset(self::$logger)) {
-                       return;
-               }
-
-               $stamp1 = microtime(true);
-               self::$logger->emergency($message, $context);
-               self::getApp()->GetProfiler()->saveTimestamp($stamp1, 'file', System::callstack());
+               self::getWorker()->emergency($message, $context);
        }
 
        /**
@@ -120,13 +153,7 @@ class Logger extends BaseObject
         */
        public static function alert($message, $context = [])
        {
-               if (!isset(self::$logger)) {
-                       return;
-               }
-
-               $stamp1 = microtime(true);
-               self::$logger->alert($message, $context);
-               self::getApp()->getProfiler()->saveTimestamp($stamp1, 'file', System::callstack());
+               self::getWorker()->alert($message, $context);
        }
 
        /**
@@ -143,13 +170,7 @@ class Logger extends BaseObject
         */
        public static function critical($message, $context = [])
        {
-               if (!isset(self::$logger)) {
-                       return;
-               }
-
-               $stamp1 = microtime(true);
-               self::$logger->critical($message, $context);
-               self::getApp()->getProfiler()->saveTimestamp($stamp1, 'file', System::callstack());
+               self::getWorker()->critical($message, $context);
        }
 
        /**
@@ -165,14 +186,7 @@ class Logger extends BaseObject
         */
        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()->getProfiler()->saveTimestamp($stamp1, 'file', System::callstack());
+               self::getWorker()->error($message, $context);
        }
 
        /**
@@ -190,13 +204,7 @@ class Logger extends BaseObject
         */
        public static function warning($message, $context = [])
        {
-               if (!isset(self::$logger)) {
-                       return;
-               }
-
-               $stamp1 = microtime(true);
-               self::$logger->warning($message, $context);
-               self::getApp()->getProfiler()->saveTimestamp($stamp1, 'file', System::callstack());
+               self::getWorker()->warning($message, $context);
        }
 
        /**
@@ -211,13 +219,7 @@ class Logger extends BaseObject
         */
        public static function notice($message, $context = [])
        {
-               if (!isset(self::$logger)) {
-                       return;
-               }
-
-               $stamp1 = microtime(true);
-               self::$logger->notice($message, $context);
-               self::getApp()->getProfiler()->saveTimestamp($stamp1, 'file', System::callstack());
+               self::getWorker()->notice($message, $context);
        }
 
        /**
@@ -234,13 +236,7 @@ class Logger extends BaseObject
         */
        public static function info($message, $context = [])
        {
-               if (!isset(self::$logger)) {
-                       return;
-               }
-
-               $stamp1 = microtime(true);
-               self::$logger->info($message, $context);
-               self::getApp()->getProfiler()->saveTimestamp($stamp1, 'file', System::callstack());
+               self::getWorker()->info($message, $context);
        }
 
        /**
@@ -255,17 +251,11 @@ class Logger extends BaseObject
         */
        public static function debug($message, $context = [])
        {
-               if (!isset(self::$logger)) {
-                       return;
-               }
-
-               $stamp1 = microtime(true);
-               self::$logger->debug($message, $context);
-               self::getApp()->getProfiler()->saveTimestamp($stamp1, 'file', System::callstack());
+               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
@@ -275,17 +265,12 @@ class Logger extends BaseObject
         */
        public static function log($msg, $level = LogLevel::INFO)
        {
-               if (!isset(self::$logger)) {
-                       return;
-               }
-
-               $stamp1 = microtime(true);
-               self::$logger->log($level, $msg);
-               self::getApp()->getProfiler()->saveTimestamp($stamp1, "file", System::callstack());
+               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
@@ -296,12 +281,6 @@ class Logger extends BaseObject
         */
        public static function devLog($msg, $level = LogLevel::DEBUG)
        {
-               if (!isset(self::$logger)) {
-                       return;
-               }
-
-               $stamp1 = microtime(true);
-               self::$devLogger->log($level, $msg);
-               self::getApp()->getProfiler()->saveTimestamp($stamp1, "file", System::callstack());
+               DI::devLogger()->log($level, $msg);
        }
 }