Log - Code Metrics - Inspection of "log previous exception" - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#9147)

by Robin

created 2018-04-11 12:48 UTC

Log B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	386
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

Metric	Value
dl	0
loc	386
rs	8.6206
c	0
b	0
f	0
wmc	50
lcom	1
cbo	7

17 Methods

Rating	Name	Size	Complexity
B	__construct()	23	4
A	emergency()	3	1
A	alert()	3	1
A	critical()	3	1
A	error()	3	1
A	warning()	3	1
A	notice()	3	1
A	info()	3	1
A	debug()	3	1
A	log()	18	3
C	getLogLevel()	54	14
A	filterTrace()	17	3
A	removeValuesFromArgs()	10	4
A	serializeException()	20	3
B	logException()	23	4
A	writeLog()	3	1
B	getLogClass()	16	6

How to fix Complexity

<?php
declare(strict_types=1);
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 *
 * @author Arthur Schiwon <[email protected]>
 * @author Bart Visscher <[email protected]>
 * @author Bernhard Posselt <[email protected]>
 * @author Joas Schilling <[email protected]>
 * @author Johannes Schlichenmaier <[email protected]>
 * @author Juan Pablo Villafáñez <[email protected]>
 * @author Lukas Reschke <[email protected]>
 * @author Morris Jobke <[email protected]>
 * @author Olivier Paroz <[email protected]>
 * @author Robin Appelman <[email protected]>
 * @author Thomas Müller <[email protected]>
 * @author Thomas Pulzer <[email protected]>
 * @author Victor Dubiniuk <[email protected]>
 *
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * 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, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OC;

use InterfaSys\LogNormalizer\Normalizer;

use OC\Log\File;
use OCP\ILogger;
use OCP\Support\CrashReport\IRegistry;
use OCP\Util;

/**
 * logging utilities
 *
 * This is a stand in, this should be replaced by a Psr\Log\LoggerInterface
 * compatible logger. See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md
 * for the full interface specification.
 *
 * MonoLog is an example implementing this interface.
 */
class Log implements ILogger {

	/** @var string */
	private $logger;

	/** @var SystemConfig */
	private $config;

	/** @var boolean|null cache the result of the log condition check for the request */
	private $logConditionSatisfied = null;

	/** @var Normalizer */
	private $normalizer;

	/** @var IRegistry */
	private $crashReporters;

	protected $methodsWithSensitiveParameters = [
		// Session/User
		'completeLogin',
		'login',
		'checkPassword',
		'checkPasswordNoLogging',
		'loginWithPassword',
		'updatePrivateKeyPassword',
		'validateUserPass',
		'loginWithToken',
		'{closure}',

		// TokenProvider
		'getToken',
		'isTokenPassword',
		'getPassword',
		'decryptPassword',
		'logClientIn',
		'generateToken',
		'validateToken',

		// TwoFactorAuth
		'solveChallenge',
		'verifyChallenge',

		// ICrypto
		'calculateHMAC',
		'encrypt',
		'decrypt',

		// LoginController
		'tryLogin',
		'confirmPassword',

		// LDAP
		'bind',
		'areCredentialsValid',
		'invokeLDAPMethod',

		// Encryption
		'storeKeyPair',
		'setupUser',
	];

	/**
	 * @param string $logger The logger that should be used
	 * @param SystemConfig $config the system config object
	 * @param Normalizer|null $normalizer
	 * @param IRegistry|null $registry
	 */
	public function __construct($logger = null, SystemConfig $config = null, $normalizer = null, IRegistry $registry = null) {
		// FIXME: Add this for backwards compatibility, should be fixed at some point probably
		if ($config === null) {
			$config = \OC::$server->getSystemConfig();
		}

		$this->config = $config;

		// FIXME: Add this for backwards compatibility, should be fixed at some point probably
		if ($logger === null) {
			$logType = $this->config->getValue('log_type', 'file');
			$this->logger = static::getLogClass($logType);
			call_user_func([$this->logger, 'init']);
		} else {
			$this->logger = $logger;
		}
		if ($normalizer === null) {
			$this->normalizer = new Normalizer();
		} else {
			$this->normalizer = $normalizer;
		}
		$this->crashReporters = $registry;
	}

	/**
	 * System is unusable.
	 *
	 * @param string $message
	 * @param array $context
	 * @return void
	 */
	public function emergency(string $message, array $context = []) {
		$this->log(Util::FATAL, $message, $context);
	}

	/**
	 * Action must be taken immediately.
	 *
	 * 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
	 */
	public function alert(string $message, array $context = []) {
		$this->log(Util::ERROR, $message, $context);
	}

	/**
	 * Critical conditions.
	 *
	 * Example: Application component unavailable, unexpected exception.
	 *
	 * @param string $message
	 * @param array $context
	 * @return void
	 */
	public function critical(string $message, array $context = []) {
		$this->log(Util::ERROR, $message, $context);
	}

	/**
	 * Runtime errors that do not require immediate action but should typically
	 * be logged and monitored.
	 *
	 * @param string $message
	 * @param array $context
	 * @return void
	 */
	public function error(string $message, array $context = []) {
		$this->log(Util::ERROR, $message, $context);
	}

	/**
	 * Exceptional occurrences that are not errors.
	 *
	 * 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
	 */
	public function warning(string $message, array $context = []) {
		$this->log(Util::WARN, $message, $context);
	}

	/**
	 * Normal but significant events.
	 *
	 * @param string $message
	 * @param array $context
	 * @return void
	 */
	public function notice(string $message, array $context = []) {
		$this->log(Util::INFO, $message, $context);
	}

	/**
	 * Interesting events.
	 *
	 * Example: User logs in, SQL logs.
	 *
	 * @param string $message
	 * @param array $context
	 * @return void
	 */
	public function info(string $message, array $context = []) {
		$this->log(Util::INFO, $message, $context);
	}

	/**
	 * Detailed debug information.
	 *
	 * @param string $message
	 * @param array $context
	 * @return void
	 */
	public function debug(string $message, array $context = []) {
		$this->log(Util::DEBUG, $message, $context);
	}


	/**
	 * Logs with an arbitrary level.
	 *
	 * @param int $level
	 * @param string $message
	 * @param array $context
	 * @return void
	 */
	public function log(int $level, string $message, array $context = []) {
		$minLevel = $this->getLogLevel($context);

		array_walk($context, [$this->normalizer, 'format']);

		$app = $context['app'] ?? 'no app in context';

		// interpolate $message as defined in PSR-3
		$replace = [];
		foreach ($context as $key => $val) {
			$replace['{' . $key . '}'] = $val;
		}
		$message = strtr($message, $replace);

		if ($level >= $minLevel) {
			$this->writeLog($app, $message, $level);
		}
	}

	private function getLogLevel($context) {
		/**
		 * check for a special log condition - this enables an increased log on
		 * a per request/user base
		 */
		if ($this->logConditionSatisfied === null) {
			// default to false to just process this once per request
			$this->logConditionSatisfied = false;
			if (!empty($logCondition)) {


				// check for secret token in the request
				if (isset($logCondition['shared_secret'])) {
					$request = \OC::$server->getRequest();

					// if token is found in the request change set the log condition to satisfied
					if ($request && hash_equals($logCondition['shared_secret'], $request->getParam('log_secret', ''))) {
						$this->logConditionSatisfied = true;
					}
				}

				// check for user
				if (isset($logCondition['users'])) {
					$user = \OC::$server->getUserSession()->getUser();

					// if the user matches set the log condition to satisfied
					if ($user !== null && in_array($user->getUID(), $logCondition['users'], true)) {
						$this->logConditionSatisfied = true;
					}
				}
			}
		}

		// if log condition is satisfied change the required log level to DEBUG
		if ($this->logConditionSatisfied) {
			return Util::DEBUG;
		}

		if (isset($context['app'])) {
			$logCondition = $this->config->getValue('log.condition', []);
			$app = $context['app'];

			/**
			 * check log condition based on the context of each log message
			 * once this is met -> change the required log level to debug
			 */
			if (!empty($logCondition)
				&& isset($logCondition['apps'])
				&& in_array($app, $logCondition['apps'], true)) {
				return Util::DEBUG;
			}
		}

		return min($this->config->getValue('loglevel', Util::WARN), Util::FATAL);
	}

	private function filterTrace(array $trace) {
		$sensitiveValues = [];
		$trace = array_map(function (array $traceLine) use (&$sensitiveValues) {
			foreach ($this->methodsWithSensitiveParameters as $sensitiveMethod) {
				if (strpos($traceLine['function'], $sensitiveMethod) !== false) {
					$sensitiveValues = array_merge($sensitiveValues, $traceLine['args']);
					$traceLine['args'] = ['*** sensitive parameters replaced ***'];
					return $traceLine;
				}
			}
			return $traceLine;
		}, $trace);
		return array_map(function (array $traceLine) use ($sensitiveValues) {
			$traceLine['args'] = $this->removeValuesFromArgs($traceLine['args'], $sensitiveValues);
			return $traceLine;
		}, $trace);
	}

	private function removeValuesFromArgs($args, $values) {
		foreach($args as &$arg) {
			if (in_array($arg, $values, true)) {
				$arg = '*** sensitive parameter replaced ***';
			} else if (is_array($arg)) {
				$arg = $this->removeValuesFromArgs($arg, $values);
			}
		}
		return $args;
	}

	private function serializeException(\Throwable $exception) {
		$data = [
			'Exception' => get_class($exception),
			'Message' => $exception->getMessage(),
			'Code' => $exception->getCode(),
			'Trace' => $this->filterTrace($exception->getTrace()),
			'File' => $exception->getFile(),
			'Line' => $exception->getLine(),
		];

		if ($exception instanceof HintException) {
			$data['Hint'] = $exception->getHint();
		}

		if ($exception->getPrevious()) {
			$data['Previous'] = $this->serializeException($exception->getPrevious());
		}

		return $data;
	}

	/**
	 * Logs an exception very detailed
	 *
	 * @param \Exception|\Throwable $exception
	 * @param array $context
	 * @return void
	 * @since 8.2.0
	 */
	public function logException(\Throwable $exception, array $context = []) {
		$app = $context['app'] ?? 'no app in context';
		$level = $context['level'] ?? Util::ERROR;

		$data = $this->serializeException($exception);
		$data['CustomMessage'] = $context['message'] ?? '--';

		$minLevel = $this->getLogLevel($context);

		array_walk($context, [$this->normalizer, 'format']);

		if ($level >= $minLevel) {
			if ($this->logger !== File::class) {
				$data = json_encode($data, JSON_PARTIAL_OUTPUT_ON_ERROR);
			}
			$this->writeLog($app, $data, $level);
		}

		$context['level'] = $level;
		if (!is_null($this->crashReporters)) {
			$this->crashReporters->delegateReport($exception, $context);
		}
	}

	/**
	 * @param string $app
	 * @param string|array $entry
	 * @param int $level
	 */
	protected function writeLog(string $app, $entry, int $level) {
		call_user_func([$this->logger, 'write'], $app, $entry, $level);
	}

	/**
	 * @param string $logType
	 * @return string
	 * @internal
	 */
	public static function getLogClass(string $logType): string {
		switch (strtolower($logType)) {
			case 'errorlog':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
				return \OC\Log\Errorlog::class;
			case 'syslog':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
				return \OC\Log\Syslog::class;
			case 'file':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
				return \OC\Log\File::class;

			// Backwards compatibility for old and fallback for unknown log types
			case 'owncloud':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
			case 'nextcloud':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
			default:
switch ($expr) {
    default: { //wrong
        doSomething();
        break;
    }
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}
				return \OC\Log\File::class;
		}
	}
}


1			<?php
2			declare(strict_types=1);
3			/**
4			* @copyright Copyright (c) 2016, ownCloud, Inc.
5			*
6			* @author Arthur Schiwon <[email protected]>
7			* @author Bart Visscher <[email protected]>
8			* @author Bernhard Posselt <[email protected]>
9			* @author Joas Schilling <[email protected]>
10			* @author Johannes Schlichenmaier <[email protected]>
11			* @author Juan Pablo Villafáñez <[email protected]>
12			* @author Lukas Reschke <[email protected]>
13			* @author Morris Jobke <[email protected]>
14			* @author Olivier Paroz <[email protected]>
15			* @author Robin Appelman <[email protected]>
16			* @author Thomas Müller <[email protected]>
17			* @author Thomas Pulzer <[email protected]>
18			* @author Victor Dubiniuk <[email protected]>
19			*
20			* @license AGPL-3.0
21			*
22			* This code is free software: you can redistribute it and/or modify
23			* it under the terms of the GNU Affero General Public License, version 3,
24			* as published by the Free Software Foundation.
25			*
26			* This program is distributed in the hope that it will be useful,
27			* but WITHOUT ANY WARRANTY; without even the implied warranty of
28			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29			* GNU Affero General Public License for more details.
30			*
31			* You should have received a copy of the GNU Affero General Public License, version 3,
32			* along with this program. If not, see <http://www.gnu.org/licenses/>
33			*
34			*/
35
36			namespace OC;
37
38			use InterfaSys\LogNormalizer\Normalizer;
39
40			use OC\Log\File;
41			use OCP\ILogger;
42			use OCP\Support\CrashReport\IRegistry;
43			use OCP\Util;
44
45			/**
46			* logging utilities
47			*
48			* This is a stand in, this should be replaced by a Psr\Log\LoggerInterface
49			* compatible logger. See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md
50			* for the full interface specification.
51			*
52			* MonoLog is an example implementing this interface.
53			*/
54			class Log implements ILogger {
55
56			/** @var string */
57			private $logger;
58
59			/** @var SystemConfig */
60			private $config;
61
62			/** @var boolean\|null cache the result of the log condition check for the request */
63			private $logConditionSatisfied = null;
64
65			/** @var Normalizer */
66			private $normalizer;
67
68			/** @var IRegistry */
69			private $crashReporters;
70
71			protected $methodsWithSensitiveParameters = [
72			// Session/User
73			'completeLogin',
74			'login',
75			'checkPassword',
76			'checkPasswordNoLogging',
77			'loginWithPassword',
78			'updatePrivateKeyPassword',
79			'validateUserPass',
80			'loginWithToken',
81			'{closure}',
82
83			// TokenProvider
84			'getToken',
85			'isTokenPassword',
86			'getPassword',
87			'decryptPassword',
88			'logClientIn',
89			'generateToken',
90			'validateToken',
91
92			// TwoFactorAuth
93			'solveChallenge',
94			'verifyChallenge',
95
96			// ICrypto
97			'calculateHMAC',
98			'encrypt',
99			'decrypt',
100
101			// LoginController
102			'tryLogin',
103			'confirmPassword',
104
105			// LDAP
106			'bind',
107			'areCredentialsValid',
108			'invokeLDAPMethod',
109
110			// Encryption
111			'storeKeyPair',
112			'setupUser',
113			];
114
115			/**
116			* @param string $logger The logger that should be used
117			* @param SystemConfig $config the system config object
118			* @param Normalizer\|null $normalizer
119			* @param IRegistry\|null $registry
120			*/
121			public function __construct($logger = null, SystemConfig $config = null, $normalizer = null, IRegistry $registry = null) {
122			// FIXME: Add this for backwards compatibility, should be fixed at some point probably
123			if ($config === null) {
124			$config = \OC::$server->getSystemConfig();
125			}
126
127			$this->config = $config;
128
129			// FIXME: Add this for backwards compatibility, should be fixed at some point probably
130			if ($logger === null) {
131			$logType = $this->config->getValue('log_type', 'file');
132			$this->logger = static::getLogClass($logType);
133			call_user_func([$this->logger, 'init']);
134			} else {
135			$this->logger = $logger;
136			}
137			if ($normalizer === null) {
138			$this->normalizer = new Normalizer();
139			} else {
140			$this->normalizer = $normalizer;
141			}
142			$this->crashReporters = $registry;
143			}
144
145			/**
146			* System is unusable.
147			*
148			* @param string $message
149			* @param array $context
150			* @return void
151			*/
152			public function emergency(string $message, array $context = []) {
153			$this->log(Util::FATAL, $message, $context);
154			}
155
156			/**
157			* Action must be taken immediately.
158			*
159			* Example: Entire website down, database unavailable, etc. This should
160			* trigger the SMS alerts and wake you up.
161			*
162			* @param string $message
163			* @param array $context
164			* @return void
165			*/
166			public function alert(string $message, array $context = []) {
167			$this->log(Util::ERROR, $message, $context);
168			}
169
170			/**
171			* Critical conditions.
172			*
173			* Example: Application component unavailable, unexpected exception.
174			*
175			* @param string $message
176			* @param array $context
177			* @return void
178			*/
179			public function critical(string $message, array $context = []) {
180			$this->log(Util::ERROR, $message, $context);
181			}
182
183			/**
184			* Runtime errors that do not require immediate action but should typically
185			* be logged and monitored.
186			*
187			* @param string $message
188			* @param array $context
189			* @return void
190			*/
191			public function error(string $message, array $context = []) {
192			$this->log(Util::ERROR, $message, $context);
193			}
194
195			/**
196			* Exceptional occurrences that are not errors.
197			*
198			* Example: Use of deprecated APIs, poor use of an API, undesirable things
199			* that are not necessarily wrong.
200			*
201			* @param string $message
202			* @param array $context
203			* @return void
204			*/
205			public function warning(string $message, array $context = []) {
206			$this->log(Util::WARN, $message, $context);
207			}
208
209			/**
210			* Normal but significant events.
211			*
212			* @param string $message
213			* @param array $context
214			* @return void
215			*/
216			public function notice(string $message, array $context = []) {
217			$this->log(Util::INFO, $message, $context);
218			}
219
220			/**
221			* Interesting events.
222			*
223			* Example: User logs in, SQL logs.
224			*
225			* @param string $message
226			* @param array $context
227			* @return void
228			*/
229			public function info(string $message, array $context = []) {
230			$this->log(Util::INFO, $message, $context);
231			}
232
233			/**
234			* Detailed debug information.
235			*
236			* @param string $message
237			* @param array $context
238			* @return void
239			*/
240			public function debug(string $message, array $context = []) {
241			$this->log(Util::DEBUG, $message, $context);
242			}
243
244
245			/**
246			* Logs with an arbitrary level.
247			*
248			* @param int $level
249			* @param string $message
250			* @param array $context
251			* @return void
252			*/
253			public function log(int $level, string $message, array $context = []) {
254			$minLevel = $this->getLogLevel($context);
255
256			array_walk($context, [$this->normalizer, 'format']);
257
258			$app = $context['app'] ?? 'no app in context';
259
260			// interpolate $message as defined in PSR-3
261			$replace = [];
262			foreach ($context as $key => $val) {
263			$replace['{' . $key . '}'] = $val;
264			}
265			$message = strtr($message, $replace);
266
267			if ($level >= $minLevel) {
268			$this->writeLog($app, $message, $level);
269			}
270			}
271
272			private function getLogLevel($context) {
273			/**
274			* check for a special log condition - this enables an increased log on
275			* a per request/user base
276			*/
277			if ($this->logConditionSatisfied === null) {
278			// default to false to just process this once per request
279			$this->logConditionSatisfied = false;
280			if (!empty($logCondition)) {
			0 ignored issues – show Bug introduced 2018-03-22 16:12 UTC by Report Bug Copy Issue Report The variable `$logCondition` seems only to be defined at a later point. As such the call to `empty()` seems to always evaluate to `true`. This check marks calls to `isset(...)` or `empty(...)` that are found before the variable itself is defined. These will always have the same result. This is likely the result of code being shifted around. Consider removing these calls. Loading history...
281
282			// check for secret token in the request
283			if (isset($logCondition['shared_secret'])) {
284			$request = \OC::$server->getRequest();
285
286			// if token is found in the request change set the log condition to satisfied
287			if ($request && hash_equals($logCondition['shared_secret'], $request->getParam('log_secret', ''))) {
288			$this->logConditionSatisfied = true;
289			}
290			}
291
292			// check for user
293			if (isset($logCondition['users'])) {
294			$user = \OC::$server->getUserSession()->getUser();
295
296			// if the user matches set the log condition to satisfied
297			if ($user !== null && in_array($user->getUID(), $logCondition['users'], true)) {
298			$this->logConditionSatisfied = true;
299			}
300			}
301			}
302			}
303
304			// if log condition is satisfied change the required log level to DEBUG
305			if ($this->logConditionSatisfied) {
306			return Util::DEBUG;
307			}
308
309			if (isset($context['app'])) {
310			$logCondition = $this->config->getValue('log.condition', []);
311			$app = $context['app'];
312
313			/**
314			* check log condition based on the context of each log message
315			* once this is met -> change the required log level to debug
316			*/
317			if (!empty($logCondition)
318			&& isset($logCondition['apps'])
319			&& in_array($app, $logCondition['apps'], true)) {
320			return Util::DEBUG;
321			}
322			}
323
324			return min($this->config->getValue('loglevel', Util::WARN), Util::FATAL);
325			}
326
327			private function filterTrace(array $trace) {
328			$sensitiveValues = [];
329			$trace = array_map(function (array $traceLine) use (&$sensitiveValues) {
330			foreach ($this->methodsWithSensitiveParameters as $sensitiveMethod) {
331			if (strpos($traceLine['function'], $sensitiveMethod) !== false) {
332			$sensitiveValues = array_merge($sensitiveValues, $traceLine['args']);
333			$traceLine['args'] = ['* sensitive parameters replaced *'];
334			return $traceLine;
335			}
336			}
337			return $traceLine;
338			}, $trace);
339			return array_map(function (array $traceLine) use ($sensitiveValues) {
340			$traceLine['args'] = $this->removeValuesFromArgs($traceLine['args'], $sensitiveValues);
341			return $traceLine;
342			}, $trace);
343			}
344
345			private function removeValuesFromArgs($args, $values) {
346			foreach($args as &$arg) {
347			if (in_array($arg, $values, true)) {
348			$arg = '* sensitive parameter replaced *';
349			} else if (is_array($arg)) {
350			$arg = $this->removeValuesFromArgs($arg, $values);
351			}
352			}
353			return $args;
354			}
355
356			private function serializeException(\Throwable $exception) {
357			$data = [
358			'Exception' => get_class($exception),
359			'Message' => $exception->getMessage(),
360			'Code' => $exception->getCode(),
361			'Trace' => $this->filterTrace($exception->getTrace()),
362			'File' => $exception->getFile(),
363			'Line' => $exception->getLine(),
364			];
365
366			if ($exception instanceof HintException) {
367			$data['Hint'] = $exception->getHint();
368			}
369
370			if ($exception->getPrevious()) {
371			$data['Previous'] = $this->serializeException($exception->getPrevious());
372			}
373
374			return $data;
375			}
376
377			/**
378			* Logs an exception very detailed
379			*
380			* @param \Exception\|\Throwable $exception
381			* @param array $context
382			* @return void
383			* @since 8.2.0
384			*/
385			public function logException(\Throwable $exception, array $context = []) {
386			$app = $context['app'] ?? 'no app in context';
387			$level = $context['level'] ?? Util::ERROR;
388
389			$data = $this->serializeException($exception);
390			$data['CustomMessage'] = $context['message'] ?? '--';
391
392			$minLevel = $this->getLogLevel($context);
393
394			array_walk($context, [$this->normalizer, 'format']);
395
396			if ($level >= $minLevel) {
397			if ($this->logger !== File::class) {
398			$data = json_encode($data, JSON_PARTIAL_OUTPUT_ON_ERROR);
399			}
400			$this->writeLog($app, $data, $level);
401			}
402
403			$context['level'] = $level;
404			if (!is_null($this->crashReporters)) {
405			$this->crashReporters->delegateReport($exception, $context);
406			}
407			}
408
409			/**
410			* @param string $app
411			* @param string\|array $entry
412			* @param int $level
413			*/
414			protected function writeLog(string $app, $entry, int $level) {
415			call_user_func([$this->logger, 'write'], $app, $entry, $level);
416			}
417
418			/**
419			* @param string $logType
420			* @return string
421			* @internal
422			*/
423			public static function getLogClass(string $logType): string {
424			switch (strtolower($logType)) {
425			case 'errorlog':
			0 ignored issues – show Coding Style introduced 2018-04-10 10:09 UTC by Report Bug Copy Issue Report `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
426			return \OC\Log\Errorlog::class;
427			case 'syslog':
			0 ignored issues – show Coding Style introduced 2018-04-10 10:09 UTC by Report Bug Copy Issue Report `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
428			return \OC\Log\Syslog::class;
429			case 'file':
			0 ignored issues – show Coding Style introduced 2018-04-10 10:09 UTC by Report Bug Copy Issue Report `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
430			return \OC\Log\File::class;
431
432			// Backwards compatibility for old and fallback for unknown log types
433			case 'owncloud':
			0 ignored issues – show Coding Style introduced 2018-04-10 10:09 UTC by Report Bug Copy Issue Report `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
434			case 'nextcloud':
			0 ignored issues – show Coding Style introduced 2018-04-10 10:09 UTC by Report Bug Copy Issue Report `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
435			default:
			0 ignored issues – show Coding Style introduced 2018-04-10 10:09 UTC by Report Bug Copy Issue Report DEFAULT statements must be defined using a colon As per the PSR-2 coding standard, default statements should not be wrapped in curly braces. switch ($expr) { default: { //wrong doSomething(); break; } } switch ($expr) { default: //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
436			return \OC\Log\File::class;
437			}
438			}
439			}
440

nextcloud / server

Pull Request — master (#9147)

Log B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

17 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like