2012-03-31 01:15:48 +04:00
|
|
|
<?php
|
|
|
|
/**
|
2016-07-21 18:07:57 +03:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Andreas Fischer <bantu@owncloud.com>
|
|
|
|
* @author Bart Visscher <bartv@thisnet.nl>
|
2017-11-06 17:56:42 +03:00
|
|
|
* @author duritong <peter.meier+github@immerda.ch>
|
2017-11-06 22:15:27 +03:00
|
|
|
* @author Georg Ehrke <oc.list@georgehrke.com>
|
2017-11-06 17:56:42 +03:00
|
|
|
* @author Joas Schilling <coding@schilljs.com>
|
|
|
|
* @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 Michael Gapczynski <GapczynskiM@gmail.com>
|
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
2016-05-26 20:56:05 +03:00
|
|
|
* @author Phiber2000 <phiber2000@gmx.de>
|
2016-07-21 19:13:36 +03:00
|
|
|
* @author Robin Appelman <robin@icewind.nl>
|
2016-07-21 18:07:57 +03:00
|
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
2017-11-06 17:56:42 +03:00
|
|
|
* @author Roger Szabo <roger.szabo@web.de>
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
2016-07-21 18:07:57 +03:00
|
|
|
* @author Thomas Pulzer <t.pulzer@kniel.de>
|
|
|
|
* @author Vincent Petry <pvince81@owncloud.com>
|
2012-03-31 01:15:48 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* @license AGPL-3.0
|
2012-03-31 01:15:48 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* 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.
|
2012-03-31 01:15:48 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* This program is distributed in the hope that it will be useful,
|
2012-03-31 01:15:48 +04:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-03-26 13:44:34 +03:00
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU Affero General Public License for more details.
|
2012-03-31 01:15:48 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* 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/>
|
2012-03-31 01:15:48 +04:00
|
|
|
*
|
|
|
|
*/
|
2015-02-26 13:37:37 +03:00
|
|
|
|
2016-05-02 15:04:58 +03:00
|
|
|
namespace OC\Log;
|
2018-04-25 03:27:43 +03:00
|
|
|
use OCP\IConfig;
|
2018-04-25 13:26:03 +03:00
|
|
|
use OCP\Log\IFileBased;
|
2018-04-25 03:27:43 +03:00
|
|
|
use OCP\Log\IWriter;
|
2016-05-02 15:04:58 +03:00
|
|
|
|
2018-04-25 16:22:28 +03:00
|
|
|
use OCP\ILogger;
|
|
|
|
|
2015-02-26 13:37:37 +03:00
|
|
|
/**
|
|
|
|
* logging utilities
|
|
|
|
*
|
2016-07-04 12:50:32 +03:00
|
|
|
* Log is saved at data/nextcloud.log (on default)
|
2015-02-26 13:37:37 +03:00
|
|
|
*/
|
|
|
|
|
2018-04-25 03:27:43 +03:00
|
|
|
class File implements IWriter, IFileBased {
|
2018-04-24 23:14:00 +03:00
|
|
|
/** @var string */
|
|
|
|
protected $logFile;
|
2018-04-25 03:27:43 +03:00
|
|
|
/** @var IConfig */
|
|
|
|
private $config;
|
2012-03-31 01:40:16 +04:00
|
|
|
|
2018-04-25 03:27:43 +03:00
|
|
|
public function __construct(string $path, string $fallbackPath = '', IConfig $config) {
|
2018-04-24 23:14:00 +03:00
|
|
|
$this->logFile = $path;
|
|
|
|
if (!file_exists($this->logFile)) {
|
|
|
|
if(
|
|
|
|
(
|
|
|
|
!is_writable(dirname($this->logFile))
|
|
|
|
|| !touch($this->logFile)
|
|
|
|
)
|
|
|
|
&& $fallbackPath !== ''
|
|
|
|
) {
|
|
|
|
$this->logFile = $fallbackPath;
|
2016-01-26 18:48:57 +03:00
|
|
|
}
|
2012-12-17 04:43:32 +04:00
|
|
|
}
|
2018-04-25 03:27:43 +03:00
|
|
|
$this->config = $config;
|
2012-03-31 01:15:48 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* write a message in the log
|
|
|
|
* @param string $app
|
2018-03-22 17:52:46 +03:00
|
|
|
* @param string|array $message
|
2013-08-05 01:13:34 +04:00
|
|
|
* @param int $level
|
2012-03-31 01:15:48 +04:00
|
|
|
*/
|
2018-04-25 03:27:43 +03:00
|
|
|
public function write(string $app, $message, int $level) {
|
2015-04-30 13:06:52 +03:00
|
|
|
// default to ISO8601
|
2018-04-25 03:27:43 +03:00
|
|
|
$format = $this->config->getSystemValue('logdateformat', \DateTime::ATOM);
|
|
|
|
$logTimeZone = $this->config->getSystemValue('logtimezone', 'UTC');
|
2015-04-30 13:06:52 +03:00
|
|
|
try {
|
2016-05-02 15:04:58 +03:00
|
|
|
$timezone = new \DateTimeZone($logTimeZone);
|
|
|
|
} catch (\Exception $e) {
|
|
|
|
$timezone = new \DateTimeZone('UTC');
|
2015-04-30 13:06:52 +03:00
|
|
|
}
|
2016-05-02 15:04:58 +03:00
|
|
|
$time = \DateTime::createFromFormat("U.u", number_format(microtime(true), 4, ".", ""));
|
2015-11-16 18:20:42 +03:00
|
|
|
if ($time === false) {
|
2016-05-02 15:04:58 +03:00
|
|
|
$time = new \DateTime(null, $timezone);
|
2016-03-14 15:39:45 +03:00
|
|
|
} else {
|
|
|
|
// apply timezone if $time is created from UNIX timestamp
|
|
|
|
$time->setTimezone($timezone);
|
2015-11-16 18:20:42 +03:00
|
|
|
}
|
2015-04-30 13:06:52 +03:00
|
|
|
$request = \OC::$server->getRequest();
|
|
|
|
$reqId = $request->getId();
|
|
|
|
$remoteAddr = $request->getRemoteAddress();
|
|
|
|
// remove username/passwords from URLs before writing the to the log file
|
|
|
|
$time = $time->format($format);
|
2016-03-21 17:21:22 +03:00
|
|
|
$url = ($request->getRequestUri() !== '') ? $request->getRequestUri() : '--';
|
|
|
|
$method = is_string($request->getMethod()) ? $request->getMethod() : '--';
|
2018-04-25 03:27:43 +03:00
|
|
|
if($this->config->getSystemValue('installed', false)) {
|
2018-01-27 01:46:40 +03:00
|
|
|
$user = \OC_User::getUser() ? \OC_User::getUser() : '--';
|
2016-03-22 19:34:20 +03:00
|
|
|
} else {
|
2016-05-25 18:35:52 +03:00
|
|
|
$user = '--';
|
2016-03-22 19:34:20 +03:00
|
|
|
}
|
2018-01-12 16:15:12 +03:00
|
|
|
$userAgent = $request->getHeader('User-Agent');
|
|
|
|
if ($userAgent === '') {
|
|
|
|
$userAgent = '--';
|
|
|
|
}
|
2018-04-25 03:27:43 +03:00
|
|
|
$version = $this->config->getSystemValue('version', '');
|
2016-03-21 17:21:22 +03:00
|
|
|
$entry = compact(
|
|
|
|
'reqId',
|
|
|
|
'level',
|
|
|
|
'time',
|
2017-04-04 11:12:41 +03:00
|
|
|
'remoteAddr',
|
|
|
|
'user',
|
|
|
|
'app',
|
2016-03-21 17:21:22 +03:00
|
|
|
'method',
|
|
|
|
'url',
|
2017-04-04 11:12:41 +03:00
|
|
|
'message',
|
2017-03-10 11:50:15 +03:00
|
|
|
'userAgent',
|
2017-04-12 14:04:28 +03:00
|
|
|
'version'
|
2016-03-21 17:21:22 +03:00
|
|
|
);
|
2017-08-17 16:01:50 +03:00
|
|
|
// PHP's json_encode only accept proper UTF-8 strings, loop over all
|
|
|
|
// elements to ensure that they are properly UTF-8 compliant or convert
|
|
|
|
// them manually.
|
|
|
|
foreach($entry as $key => $value) {
|
|
|
|
if(is_string($value)) {
|
|
|
|
$testEncode = json_encode($value);
|
|
|
|
if($testEncode === false) {
|
|
|
|
$entry[$key] = utf8_encode($value);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
$entry = json_encode($entry, JSON_PARTIAL_OUTPUT_ON_ERROR);
|
2018-04-24 23:14:00 +03:00
|
|
|
$handle = @fopen($this->logFile, 'a');
|
|
|
|
if ((fileperms($this->logFile) & 0777) != 0640) {
|
|
|
|
@chmod($this->logFile, 0640);
|
2017-01-29 02:55:39 +03:00
|
|
|
}
|
2015-04-30 13:06:52 +03:00
|
|
|
if ($handle) {
|
|
|
|
fwrite($handle, $entry."\n");
|
|
|
|
fclose($handle);
|
|
|
|
} else {
|
|
|
|
// Fall back to error_log
|
|
|
|
error_log($entry);
|
2012-03-31 01:15:48 +04:00
|
|
|
}
|
2015-12-14 14:16:41 +03:00
|
|
|
if (php_sapi_name() === 'cli-server') {
|
|
|
|
error_log($message, 4);
|
|
|
|
}
|
2012-03-31 01:15:48 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* get entries from the log in reverse chronological order
|
2013-08-05 01:13:34 +04:00
|
|
|
* @param int $limit
|
|
|
|
* @param int $offset
|
2012-03-31 01:15:48 +04:00
|
|
|
* @return array
|
|
|
|
*/
|
2018-04-24 23:14:00 +03:00
|
|
|
public function getEntries($limit=50, $offset=0) {
|
2018-04-25 03:27:43 +03:00
|
|
|
$minLevel = $this->config->getSystemValue("loglevel", ILogger::WARN);
|
2012-06-01 22:38:25 +04:00
|
|
|
$entries = array();
|
2018-04-24 23:14:00 +03:00
|
|
|
$handle = @fopen($this->logFile, 'rb');
|
2012-06-01 22:38:25 +04:00
|
|
|
if ($handle) {
|
2012-07-06 23:51:01 +04:00
|
|
|
fseek($handle, 0, SEEK_END);
|
|
|
|
$pos = ftell($handle);
|
|
|
|
$line = '';
|
|
|
|
$entriesCount = 0;
|
|
|
|
$lines = 0;
|
|
|
|
// Loop through each character of the file looking for new lines
|
2014-12-21 00:44:41 +03:00
|
|
|
while ($pos >= 0 && ($limit === null ||$entriesCount < $limit)) {
|
2012-07-06 23:51:01 +04:00
|
|
|
fseek($handle, $pos);
|
|
|
|
$ch = fgetc($handle);
|
|
|
|
if ($ch == "\n" || $pos == 0) {
|
|
|
|
if ($line != '') {
|
2013-02-11 20:44:02 +04:00
|
|
|
// Add the first character if at the start of the file,
|
|
|
|
// because it doesn't hit the else in the loop
|
2012-07-06 23:51:01 +04:00
|
|
|
if ($pos == 0) {
|
|
|
|
$line = $ch.$line;
|
|
|
|
}
|
|
|
|
$entry = json_decode($line);
|
|
|
|
// Add the line as an entry if it is passed the offset and is equal or above the log level
|
2012-07-07 01:29:45 +04:00
|
|
|
if ($entry->level >= $minLevel) {
|
|
|
|
$lines++;
|
|
|
|
if ($lines > $offset) {
|
|
|
|
$entries[] = $entry;
|
|
|
|
$entriesCount++;
|
|
|
|
}
|
2012-07-06 23:51:01 +04:00
|
|
|
}
|
|
|
|
$line = '';
|
2012-06-01 22:38:25 +04:00
|
|
|
}
|
2012-07-06 23:51:01 +04:00
|
|
|
} else {
|
|
|
|
$line = $ch.$line;
|
2012-06-01 22:38:25 +04:00
|
|
|
}
|
2012-07-06 23:51:01 +04:00
|
|
|
$pos--;
|
2012-04-16 14:21:12 +04:00
|
|
|
}
|
2012-06-01 22:38:25 +04:00
|
|
|
fclose($handle);
|
2012-03-31 01:15:48 +04:00
|
|
|
}
|
|
|
|
return $entries;
|
|
|
|
}
|
2014-12-21 00:44:41 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @return string
|
|
|
|
*/
|
2018-04-24 23:14:00 +03:00
|
|
|
public function getLogFilePath() {
|
|
|
|
return $this->logFile;
|
2014-12-21 00:44:41 +03:00
|
|
|
}
|
2012-03-31 01:15:48 +04:00
|
|
|
}
|