nextcloud/lib/private/Log.php

383 lines
9.9 KiB
PHP
Raw Normal View History

2011-10-16 22:49:14 +04:00
<?php
declare(strict_types=1);
2011-10-16 22:49:14 +04:00
/**
2016-07-21 18:07:57 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
2015-03-26 13:44:34 +03:00
* @author Bart Visscher <bartv@thisnet.nl>
* @author Bernhard Posselt <dev@bernhard-posselt.com>
2016-07-21 18:07:57 +03:00
* @author Joas Schilling <coding@schilljs.com>
* @author Johannes Schlichenmaier <johannes@schlichenmaier.info>
* @author Juan Pablo Villafáñez <jvillafanez@solidgear.es>
2016-05-26 20:56:05 +03:00
* @author Lukas Reschke <lukas@statuscode.ch>
2015-03-26 13:44:34 +03:00
* @author Morris Jobke <hey@morrisjobke.de>
2015-10-05 21:54:56 +03:00
* @author Olivier Paroz <github@oparoz.com>
2016-07-21 19:13:36 +03:00
* @author Robin Appelman <robin@icewind.nl>
2015-03-26 13:44:34 +03:00
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Thomas Pulzer <t.pulzer@kniel.de>
2015-03-26 13:44:34 +03:00
* @author Victor Dubiniuk <dubiniuk@owncloud.com>
*
* @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/>
*
2011-10-16 22:49:14 +04:00
*/
namespace OC;
use InterfaSys\LogNormalizer\Normalizer;
use OCP\ILogger;
use OCP\Support\CrashReport\IRegistry;
2016-01-11 14:25:28 +03:00
use OCP\Util;
2011-10-16 22:49:14 +04:00
/**
2012-03-31 01:15:48 +04:00
* logging utilities
2011-10-16 22:49:14 +04:00
*
* 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.
2011-10-16 22:49:14 +04:00
*/
class Log implements ILogger {
2014-05-12 15:32:03 +04:00
/** @var string */
private $logger;
2016-01-11 14:25:28 +03:00
/** @var SystemConfig */
private $config;
/** @var boolean|null cache the result of the log condition check for the request */
private $logConditionSatisfied = null;
2016-01-11 14:25:28 +03:00
/** @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;
}
2011-10-16 22:49:14 +04:00
/**
* System is unusable.
*
2011-10-16 22:49:14 +04:00
* @param string $message
* @param array $context
2016-01-11 14:25:28 +03:00
* @return void
2011-10-16 22:49:14 +04:00
*/
public function emergency(string $message, array $context = []) {
2016-01-11 14:25:28 +03:00
$this->log(Util::FATAL, $message, $context);
2011-10-16 22:49:14 +04:00
}
2013-01-14 23:30:39 +04:00
/**
* 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
2016-01-11 14:25:28 +03:00
* @return void
*/
public function alert(string $message, array $context = []) {
2016-01-11 14:25:28 +03:00
$this->log(Util::ERROR, $message, $context);
2012-09-12 23:30:04 +04:00
}
2013-01-14 23:30:39 +04:00
/**
* Critical conditions.
*
* Example: Application component unavailable, unexpected exception.
*
* @param string $message
* @param array $context
2016-01-11 14:25:28 +03:00
* @return void
*/
public function critical(string $message, array $context = []) {
2016-01-11 14:25:28 +03:00
$this->log(Util::ERROR, $message, $context);
2012-09-26 15:38:06 +04:00
}
2012-09-12 23:30:04 +04:00
/**
* Runtime errors that do not require immediate action but should typically
* be logged and monitored.
*
* @param string $message
* @param array $context
2016-01-11 14:25:28 +03:00
* @return void
*/
public function error(string $message, array $context = []) {
2016-01-11 14:25:28 +03:00
$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
2016-01-11 14:25:28 +03:00
* @return void
*/
public function warning(string $message, array $context = []) {
2016-01-11 14:25:28 +03:00
$this->log(Util::WARN, $message, $context);
}
2012-09-12 23:30:04 +04:00
/**
* Normal but significant events.
*
* @param string $message
* @param array $context
2016-01-11 14:25:28 +03:00
* @return void
*/
public function notice(string $message, array $context = []) {
2016-01-11 14:25:28 +03:00
$this->log(Util::INFO, $message, $context);
}
/**
* Interesting events.
*
* Example: User logs in, SQL logs.
*
* @param string $message
* @param array $context
2016-01-11 14:25:28 +03:00
* @return void
*/
public function info(string $message, array $context = []) {
2016-01-11 14:25:28 +03:00
$this->log(Util::INFO, $message, $context);
}
/**
* Detailed debug information.
*
* @param string $message
* @param array $context
2016-01-11 14:25:28 +03:00
* @return void
*/
public function debug(string $message, array $context = []) {
2016-01-11 14:25:28 +03:00
$this->log(Util::DEBUG, $message, $context);
}
/**
* Logs with an arbitrary level.
*
* @param int $level
* @param string $message
* @param array $context
2016-01-11 14:25:28 +03:00
* @return void
*/
public function log(int $level, string $message, array $context = []) {
$minLevel = min($this->config->getValue('loglevel', Util::WARN), Util::FATAL);
$logCondition = $this->config->getValue('log.condition', []);
array_walk($context, [$this->normalizer, 'format']);
if (isset($context['app'])) {
$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)) {
2016-01-11 14:25:28 +03:00
$minLevel = Util::DEBUG;
}
} else {
$app = 'no app in context';
}
// interpolate $message as defined in PSR-3
$replace = [];
foreach ($context as $key => $val) {
$replace['{' . $key . '}'] = $val;
}
// interpolate replacement values into the message and return
$message = strtr($message, $replace);
/**
* 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) {
2016-01-11 14:25:28 +03:00
$minLevel = Util::DEBUG;
}
if ($level >= $minLevel) {
$logger = $this->logger;
call_user_func([$logger, 'write'], $app, $message, $level);
}
2012-09-12 23:30:04 +04:00
}
/**
* 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 = []) {
$level = Util::ERROR;
if (isset($context['level'])) {
$level = $context['level'];
unset($context['level']);
}
$data = [
'Exception' => get_class($exception),
'Message' => $exception->getMessage(),
'Code' => $exception->getCode(),
'Trace' => $exception->getTraceAsString(),
'File' => $exception->getFile(),
'Line' => $exception->getLine(),
];
$data['Trace'] = preg_replace('!(' . implode('|', $this->methodsWithSensitiveParameters) . ')\(.*\)!', '$1(*** sensitive parameters replaced ***)', $data['Trace']);
if ($exception instanceof HintException) {
$data['Hint'] = $exception->getHint();
}
$msg = isset($context['message']) ? $context['message'] : 'Exception';
$msg .= ': ' . json_encode($data);
$this->log($level, $msg, $context);
$context['level'] = $level;
if (!is_null($this->crashReporters)) {
$this->crashReporters->delegateReport($exception, $context);
}
}
/**
* @param string $logType
* @return string
* @internal
*/
public static function getLogClass(string $logType): string {
switch (strtolower($logType)) {
case 'errorlog':
return \OC\Log\Errorlog::class;
case 'syslog':
return \OC\Log\Syslog::class;
case 'file':
return \OC\Log\File::class;
// Backwards compatibility for old and fallback for unknown log types
case 'owncloud':
case 'nextcloud':
default:
return \OC\Log\File::class;
}
}
2011-10-16 22:49:14 +04:00
}