nextcloud/lib/private/log.php

179 lines
4.6 KiB
PHP
Raw Normal View History

2011-10-16 22:49:14 +04:00
<?php
/**
2015-03-26 13:44:34 +03:00
* @author Bart Visscher <bartv@thisnet.nl>
* @author Bernhard Posselt <dev@bernhard-posselt.com>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <icewind@owncloud.com>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Victor Dubiniuk <dubiniuk@owncloud.com>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @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 \OCP\ILogger;
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
private $logger;
/**
* @param string $logger The logger that should be used
*/
public function __construct($logger=null) {
// FIXME: Add this for backwards compatibility, should be fixed at some point probably
if($logger === null) {
$this->logger = 'OC_Log_'.ucfirst(\OC_Config::getValue('log_type', 'owncloud'));
call_user_func(array($this->logger, 'init'));
} else {
$this->logger = $logger;
}
}
2013-06-28 00:01:52 +04:00
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
2011-10-16 22:49:14 +04:00
*/
2013-05-13 10:05:53 +04:00
public function emergency($message, array $context = array()) {
2013-05-13 10:13:31 +04:00
$this->log(\OC_Log::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
*/
2013-05-13 10:05:53 +04:00
public function alert($message, array $context = array()) {
2013-06-28 13:15:08 +04:00
$this->log(\OC_Log::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
*/
2013-05-13 10:05:53 +04:00
public function critical($message, array $context = array()) {
2013-06-28 13:15:08 +04:00
$this->log(\OC_Log::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
*/
2013-05-13 10:05:53 +04:00
public function error($message, array $context = array()) {
2013-05-13 10:13:31 +04:00
$this->log(\OC_Log::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
*/
2013-05-13 10:05:53 +04:00
public function warning($message, array $context = array()) {
2013-05-13 10:13:31 +04:00
$this->log(\OC_Log::WARN, $message, $context);
}
2012-09-12 23:30:04 +04:00
/**
* Normal but significant events.
*
* @param string $message
* @param array $context
*/
2013-05-13 10:05:53 +04:00
public function notice($message, array $context = array()) {
2013-06-28 13:15:08 +04:00
$this->log(\OC_Log::INFO, $message, $context);
}
/**
* Interesting events.
*
* Example: User logs in, SQL logs.
*
* @param string $message
* @param array $context
*/
2013-05-13 10:05:53 +04:00
public function info($message, array $context = array()) {
2013-05-13 10:13:31 +04:00
$this->log(\OC_Log::INFO, $message, $context);
}
/**
* Detailed debug information.
*
* @param string $message
* @param array $context
*/
2013-05-13 10:05:53 +04:00
public function debug($message, array $context = array()) {
2013-05-13 10:13:31 +04:00
$this->log(\OC_Log::DEBUG, $message, $context);
}
/**
* Logs with an arbitrary level.
*
* @param mixed $level
* @param string $message
* @param array $context
*/
2013-06-28 00:01:52 +04:00
public function log($level, $message, array $context = array()) {
if (isset($context['app'])) {
$app = $context['app'];
} else {
$app = 'no app in context';
}
// interpolate $message as defined in PSR-3
$replace = array();
foreach ($context as $key => $val) {
$replace['{' . $key . '}'] = $val;
}
// interpolate replacement values into the message and return
$message = strtr($message, $replace);
2014-05-12 15:32:03 +04:00
$logger = $this->logger;
2014-07-14 21:28:29 +04:00
call_user_func(array($logger, 'write'), $app, $message, $level);
2012-09-12 23:30:04 +04:00
}
2011-10-16 22:49:14 +04:00
}