SLog::SpecialLogUser() - Code Metrics - Inspection of "Merge branch '44-apply-php-cs-fixer-code-style' in..." - grommunio/grommunio-sync - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 34e8da...f497d2 )

unknown

created 2022-06-04 08:39 UTC

SLog::SpecialLogUser() A

↳ Parent: SLog

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	2
rs	10
c	1
b	0
f	0

<?php
/*
 * SPDX-License-Identifier: AGPL-3.0-only
 * SPDX-FileCopyrightText: Copyright 2007-2016 Zarafa Deutschland GmbH
 * SPDX-FileCopyrightText: Copyright 2020-2022 grommunio GmbH
 *
 * Debug and logging
 */

class SLog {
	private static $wbxmlDebug = '';
	private static $lastLogs = [];

	/**
	 * @var Log
	 */
	private static $logger;

	/**
	 * Initializes the logging.
	 *
	 * @return bool
	 */
	public static function Initialize() {
		// define some constants for the logging
		if (!defined('LOGUSERLEVEL')) {
			define('LOGUSERLEVEL', LOGLEVEL_OFF);
		}

		if (!defined('LOGLEVEL')) {
			define('LOGLEVEL', LOGLEVEL_OFF);
		}

		$logger = self::getLogger();


		return true;
	}

	/**
	 * Check if WBXML logging is enabled in current LOG(USER)LEVEL.
	 *
	 * @return bool
	 */
	public static function IsWbxmlDebugEnabled() {
		return LOGLEVEL >= LOGLEVEL_WBXML || (LOGUSERLEVEL >= LOGLEVEL_WBXML && self::getLogger()->HasSpecialLogUsers());
	}

	/**
	 * Writes a log line.
	 *
	 * @param int    $loglevel one of the defined LOGLEVELS
	 * @param string $message
	 * @param bool   $truncate indicate if the message should be truncated, default true
	 */
	public static function Write($loglevel, $message, $truncate = true) {
		// truncate messages longer than 10 KB
		$messagesize = strlen($message);
		if ($truncate && $messagesize > 10240) {
			$message = substr($message, 0, 10240) . sprintf(" <log message with %d bytes truncated>", $messagesize);
		}

		self::$lastLogs[$loglevel] = $message;

		try {
			self::getLogger()->Log($loglevel, $message);
		}
		catch (\Exception $e) {
			// @TODO How should we handle logging error ?
			// Ignore any error.
		}

		if ($loglevel & LOGLEVEL_WBXMLSTACK) {
			self::$wbxmlDebug .= $message . PHP_EOL;
		}
	}

	/**
	 * Returns logged information about the WBXML stack.
	 *
	 * @return string
	 */
	public static function GetWBXMLDebugInfo() {
		return trim(self::$wbxmlDebug);
	}

	/**
	 * Returns the last message logged for a log level.
	 *
	 * @param int $loglevel one of the defined LOGLEVELS
	 *
	 * @return string/false     returns false if there was no message logged in that level

	 */
	public static function GetLastMessage($loglevel) {
		return (isset(self::$lastLogs[$loglevel])) ? self::$lastLogs[$loglevel] : false;
	}

	/**
	 * If called, the authenticated current user gets an extra log-file.
	 *
	 * If called until the user is authenticated (e.g. at the end of IBackend->Logon()) all log
	 * messages that happened until this point will also be logged.
	 */
	public static function SpecialLogUser() {
		self::getLogger()->SpecialLogUser();
	}

	/**
	 * Returns the logger object. If no logger has been initialized, FileLog will be initialized and returned.
	 *
	 * @throws Exception thrown if the logger class cannot be instantiated
	 *
	 * @return Log
	 */
	private static function getLogger() {
		if (!self::$logger) {
			global $specialLogUsers; // This variable comes from the configuration file (config.php)

			$logger = LOGBACKEND_CLASS;
			if (!class_exists($logger)) {
				$errmsg = 'The configured logging class `' . $logger . '` does not exist. Check your configuration.';
				error_log($errmsg);

				throw new \Exception($errmsg);
			}

			// if there is an impersonated user it's used instead of the GET user
			if (Request::GetImpersonatedUser()) {
				$user = Request::GetImpersonatedUser();
			}
			else {
				list($user) = Utils::SplitDomainUser(strtolower(Request::GetGETUser()));
			}

			self::$logger = new $logger();
			self::$logger->SetUser($user);
			self::$logger->SetAuthUser(Request::GetAuthUser());
			self::$logger->SetSpecialLogUsers($specialLogUsers);
			self::$logger->SetDevid(Request::GetDeviceID());
			self::$logger->SetPid(@getmypid());
			self::$logger->AfterInitialize();
		}

		return self::$logger;
	}

	/*----------------------------------------------------------------------------------------------------------
	 * private log stuff
	 */
}

/*----------------------------------------------------------------------------------------------------------
 * Legacy debug stuff
 */

// TODO review error handler
function gsync_error_handler($errno, $errstr, $errfile, $errline) {
	if (defined('LOG_ERROR_MASK')) {
		$errno &= LOG_ERROR_MASK;

	}

	switch ($errno) {
		case 0:
			// logging disabled by LOG_ERROR_MASK
			break;

		case E_DEPRECATED:
			// do not handle this message
			break;

		case E_NOTICE:
		case E_WARNING:
			// TODO check if there is a better way to avoid these messages
			if (stripos($errfile, 'interprocessdata') !== false && stripos($errstr, 'shm_get_var()') !== false) {
				break;
			}
			SLog::Write(LOGLEVEL_WARN, "{$errfile}:{$errline} {$errstr} ({$errno})");
			break;

		default:
			$bt = debug_backtrace();
			SLog::Write(LOGLEVEL_ERROR, "trace error: {$errfile}:{$errline} {$errstr} ({$errno}) - backtrace: " . (count($bt) - 1) . " steps");
			for ($i = 1, $bt_length = count($bt); $i < $bt_length; ++$i) {
				$file = $line = "unknown";
				if (isset($bt[$i]['file'])) {
					$file = $bt[$i]['file'];
				}
				if (isset($bt[$i]['line'])) {
					$line = $bt[$i]['line'];
				}
				SLog::Write(LOGLEVEL_ERROR, "trace: {$i}:" . $file . ":" . $line . " - " . ((isset($bt[$i]['class'])) ? $bt[$i]['class'] . $bt[$i]['type'] : "") . $bt[$i]['function'] . "()");
			}
			// throw new Exception("An error occurred.");
			break;
	}
}

error_reporting(E_ALL);
set_error_handler("gsync_error_handler");

function gsync_fatal_handler() {
	$errfile = "unknown file";

	$errstr = "shutdown";

	$errno = E_CORE_ERROR;

	$errline = 0;


	$error = error_get_last();

	if ($error !== null) {
		$errno = $error["type"];
		$errfile = $error["file"];
		$errline = $error["line"];
		$errstr = $error["message"];

		// do NOT log PHP Notice, Warning, Deprecated or Strict as FATAL
		if ($errno & ~(E_NOTICE | E_WARNING | E_DEPRECATED | E_STRICT)) {
			SLog::Write(LOGLEVEL_FATAL, sprintf("Fatal error: %s:%d - %s (%s)", $errfile, $errline, $errstr, $errno));
		}
	}
}
register_shutdown_function("gsync_fatal_handler");


1			<?php
2			/*
3			* SPDX-License-Identifier: AGPL-3.0-only
4			* SPDX-FileCopyrightText: Copyright 2007-2016 Zarafa Deutschland GmbH
5			* SPDX-FileCopyrightText: Copyright 2020-2022 grommunio GmbH
6			*
7			* Debug and logging
8			*/
9
10			class SLog {
11			private static $wbxmlDebug = '';
12			private static $lastLogs = [];
13
14			/**
15			* @var Log
16			*/
17			private static $logger;
18
19			/**
20			* Initializes the logging.
21			*
22			* @return bool
23			*/
24			public static function Initialize() {
25			// define some constants for the logging
26			if (!defined('LOGUSERLEVEL')) {
27			define('LOGUSERLEVEL', LOGLEVEL_OFF);
28			}
29
30			if (!defined('LOGLEVEL')) {
31			define('LOGLEVEL', LOGLEVEL_OFF);
32			}
33
34			$logger = self::getLogger();
			0 ignored issues – show Unused Code introduced 2022-05-27 08:52 UTC by Report Bug Copy Issue Report The assignment to `$logger` is dead and can be removed. Loading history...
35
36			return true;
37			}
38
39			/**
40			* Check if WBXML logging is enabled in current LOG(USER)LEVEL.
41			*
42			* @return bool
43			*/
44			public static function IsWbxmlDebugEnabled() {
45			return LOGLEVEL >= LOGLEVEL_WBXML \|\| (LOGUSERLEVEL >= LOGLEVEL_WBXML && self::getLogger()->HasSpecialLogUsers());
46			}
47
48			/**
49			* Writes a log line.
50			*
51			* @param int $loglevel one of the defined LOGLEVELS
52			* @param string $message
53			* @param bool $truncate indicate if the message should be truncated, default true
54			*/
55			public static function Write($loglevel, $message, $truncate = true) {
56			// truncate messages longer than 10 KB
57			$messagesize = strlen($message);
58			if ($truncate && $messagesize > 10240) {
59			$message = substr($message, 0, 10240) . sprintf(" <log message with %d bytes truncated>", $messagesize);
60			}
61
62			self::$lastLogs[$loglevel] = $message;
63
64			try {
65			self::getLogger()->Log($loglevel, $message);
66			}
67			catch (\Exception $e) {
68			// @TODO How should we handle logging error ?
69			// Ignore any error.
70			}
71
72			if ($loglevel & LOGLEVEL_WBXMLSTACK) {
73			self::$wbxmlDebug .= $message . PHP_EOL;
74			}
75			}
76
77			/**
78			* Returns logged information about the WBXML stack.
79			*
80			* @return string
81			*/
82			public static function GetWBXMLDebugInfo() {
83			return trim(self::$wbxmlDebug);
84			}
85
86			/**
87			* Returns the last message logged for a log level.
88			*
89			* @param int $loglevel one of the defined LOGLEVELS
90			*
91			* @return string/false returns false if there was no message logged in that level
			0 ignored issues – show Documentation Bug introduced 2022-05-27 08:52 UTC by Report Bug Copy Issue Report The doc comment `string/false` at position `0` could not be parsed: Unknown type name 'string/false' at position 0 in string/false. Loading history...
92			*/
93			public static function GetLastMessage($loglevel) {
94			return (isset(self::$lastLogs[$loglevel])) ? self::$lastLogs[$loglevel] : false;
95			}
96
97			/**
98			* If called, the authenticated current user gets an extra log-file.
99			*
100			* If called until the user is authenticated (e.g. at the end of IBackend->Logon()) all log
101			* messages that happened until this point will also be logged.
102			*/
103			public static function SpecialLogUser() {
104			self::getLogger()->SpecialLogUser();
105			}
106
107			/**
108			* Returns the logger object. If no logger has been initialized, FileLog will be initialized and returned.
109			*
110			* @throws Exception thrown if the logger class cannot be instantiated
111			*
112			* @return Log
113			*/
114			private static function getLogger() {
115			if (!self::$logger) {
116			global $specialLogUsers; // This variable comes from the configuration file (config.php)
117
118			$logger = LOGBACKEND_CLASS;
119			if (!class_exists($logger)) {
120			$errmsg = 'The configured logging class `' . $logger . '` does not exist. Check your configuration.';
121			error_log($errmsg);
122
123			throw new \Exception($errmsg);
124			}
125
126			// if there is an impersonated user it's used instead of the GET user
127			if (Request::GetImpersonatedUser()) {
128			$user = Request::GetImpersonatedUser();
129			}
130			else {
131			list($user) = Utils::SplitDomainUser(strtolower(Request::GetGETUser()));
132			}
133
134			self::$logger = new $logger();
135			self::$logger->SetUser($user);
136			self::$logger->SetAuthUser(Request::GetAuthUser());
137			self::$logger->SetSpecialLogUsers($specialLogUsers);
138			self::$logger->SetDevid(Request::GetDeviceID());
139			self::$logger->SetPid(@getmypid());
140			self::$logger->AfterInitialize();
141			}
142
143			return self::$logger;
144			}
145
146			/*----------------------------------------------------------------------------------------------------------
147			* private log stuff
148			*/
149			}
150
151			/*----------------------------------------------------------------------------------------------------------
152			* Legacy debug stuff
153			*/
154
155			// TODO review error handler
156			function gsync_error_handler($errno, $errstr, $errfile, $errline) {
157			if (defined('LOG_ERROR_MASK')) {
158			$errno &= LOG_ERROR_MASK;
			0 ignored issues – show Bug introduced 2022-05-27 23:22 UTC by Report Bug Copy Issue Report The constant `LOG_ERROR_MASK` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
159			}
160
161			switch ($errno) {
162			case 0:
163			// logging disabled by LOG_ERROR_MASK
164			break;
165
166			case E_DEPRECATED:
167			// do not handle this message
168			break;
169
170			case E_NOTICE:
171			case E_WARNING:
172			// TODO check if there is a better way to avoid these messages
173			if (stripos($errfile, 'interprocessdata') !== false && stripos($errstr, 'shm_get_var()') !== false) {
174			break;
175			}
176			SLog::Write(LOGLEVEL_WARN, "{$errfile}:{$errline} {$errstr} ({$errno})");
177			break;
178
179			default:
180			$bt = debug_backtrace();
181			SLog::Write(LOGLEVEL_ERROR, "trace error: {$errfile}:{$errline} {$errstr} ({$errno}) - backtrace: " . (count($bt) - 1) . " steps");
182			for ($i = 1, $bt_length = count($bt); $i < $bt_length; ++$i) {
183			$file = $line = "unknown";
184			if (isset($bt[$i]['file'])) {
185			$file = $bt[$i]['file'];
186			}
187			if (isset($bt[$i]['line'])) {
188			$line = $bt[$i]['line'];
189			}
190			SLog::Write(LOGLEVEL_ERROR, "trace: {$i}:" . $file . ":" . $line . " - " . ((isset($bt[$i]['class'])) ? $bt[$i]['class'] . $bt[$i]['type'] : "") . $bt[$i]['function'] . "()");
191			}
192			// throw new Exception("An error occurred.");
193			break;
194			}
195			}
196
197			error_reporting(E_ALL);
198			set_error_handler("gsync_error_handler");
199
200			function gsync_fatal_handler() {
201			$errfile = "unknown file";
			0 ignored issues – show Unused Code introduced 2022-05-27 08:52 UTC by Report Bug Copy Issue Report The assignment to `$errfile` is dead and can be removed. Loading history...
202			$errstr = "shutdown";
			0 ignored issues – show Unused Code introduced 2022-05-27 08:52 UTC by Report Bug Copy Issue Report The assignment to `$errstr` is dead and can be removed. Loading history...
203			$errno = E_CORE_ERROR;
			0 ignored issues – show Unused Code introduced 2022-05-27 08:52 UTC by Report Bug Copy Issue Report The assignment to `$errno` is dead and can be removed. Loading history...
204			$errline = 0;
			0 ignored issues – show Unused Code introduced 2022-05-27 08:52 UTC by Report Bug Copy Issue Report The assignment to `$errline` is dead and can be removed. Loading history...
205
206			$error = error_get_last();
207
208			if ($error !== null) {
209			$errno = $error["type"];
210			$errfile = $error["file"];
211			$errline = $error["line"];
212			$errstr = $error["message"];
213
214			// do NOT log PHP Notice, Warning, Deprecated or Strict as FATAL
215			if ($errno & ~(E_NOTICE \| E_WARNING \| E_DEPRECATED \| E_STRICT)) {
216			SLog::Write(LOGLEVEL_FATAL, sprintf("Fatal error: %s:%d - %s (%s)", $errfile, $errline, $errstr, $errno));
217			}
218			}
219			}
220			register_shutdown_function("gsync_fatal_handler");
221

grommunio / grommunio-sync

Push — master ( 34e8da...f497d2 )

SLog::SpecialLogUser() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like