nextcloud/lib/private/Log/File.php

210 lines
5.8 KiB
PHP
Raw Normal View History

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>
* @author duritong <peter.meier+github@immerda.ch>
* @author Georg Ehrke <oc.list@georgehrke.com>
* @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>
* @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
*
*/
2016-05-02 15:04:58 +03:00
namespace OC\Log;
use OC\SystemConfig;
use OCP\Log\IFileBased;
use OCP\Log\IWriter;
use OCP\ILogger;
/**
* logging utilities
*
* Log is saved at data/nextcloud.log (on default)
*/
class File implements IWriter, IFileBased {
/** @var string */
protected $logFile;
/** @var SystemConfig */
private $config;
public function __construct(string $path, string $fallbackPath = '', SystemConfig $config) {
$this->logFile = $path;
if (!file_exists($this->logFile)) {
if(
(
!is_writable(dirname($this->logFile))
|| !touch($this->logFile)
)
&& $fallbackPath !== ''
) {
$this->logFile = $fallbackPath;
}
}
$this->config = $config;
2012-03-31 01:15:48 +04:00
}
/**
* write a message in the log
* @param string $app
* @param string|array $message
2013-08-05 01:13:34 +04:00
* @param int $level
2012-03-31 01:15:48 +04:00
*/
public function write(string $app, $message, int $level) {
// default to ISO8601
$format = $this->config->getValue('logdateformat', \DateTime::ATOM);
$logTimeZone = $this->config->getValue('logtimezone', 'UTC');
try {
2016-05-02 15:04:58 +03:00
$timezone = new \DateTimeZone($logTimeZone);
} catch (\Exception $e) {
$timezone = new \DateTimeZone('UTC');
}
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
}
$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);
$url = ($request->getRequestUri() !== '') ? $request->getRequestUri() : '--';
$method = is_string($request->getMethod()) ? $request->getMethod() : '--';
if($this->config->getValue('installed', false)) {
$user = \OC_User::getUser() ? \OC_User::getUser() : '--';
} else {
$user = '--';
}
$userAgent = $request->getHeader('User-Agent');
if ($userAgent === '') {
$userAgent = '--';
}
$version = $this->config->getValue('version', '');
$entry = compact(
'reqId',
'level',
'time',
'remoteAddr',
'user',
'app',
'method',
'url',
'message',
'userAgent',
'version'
);
// 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);
$handle = @fopen($this->logFile, 'a');
if ((fileperms($this->logFile) & 0777) != 0640) {
@chmod($this->logFile, 0640);
}
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
}
if (php_sapi_name() === 'cli-server') {
if (!\is_string($message)) {
$message = json_encode($message);
}
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
*/
public function getEntries(int $limit=50, int $offset=0):array {
$minLevel = $this->config->getValue("loglevel", ILogger::WARN);
$entries = array();
$handle = @fopen($this->logFile, 'rb');
if ($handle) {
fseek($handle, 0, SEEK_END);
$pos = ftell($handle);
$line = '';
$entriesCount = 0;
$lines = 0;
// Loop through each character of the file looking for new lines
while ($pos >= 0 && ($limit === null ||$entriesCount < $limit)) {
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
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
if ($entry->level >= $minLevel) {
$lines++;
if ($lines > $offset) {
$entries[] = $entry;
$entriesCount++;
}
}
$line = '';
}
} else {
$line = $ch.$line;
}
$pos--;
2012-04-16 14:21:12 +04:00
}
fclose($handle);
2012-03-31 01:15:48 +04:00
}
return $entries;
}
/**
* @return string
*/
public function getLogFilePath():string {
return $this->logFile;
}
2012-03-31 01:15:48 +04:00
}