2012-03-30 21:15:48 +00:00
|
|
|
<?php
|
2024-05-23 07:26:56 +00:00
|
|
|
|
2012-03-30 21:15:48 +00:00
|
|
|
/**
|
2024-05-23 07:26:56 +00:00
|
|
|
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
|
|
|
|
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
|
|
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
2012-03-30 21:15:48 +00:00
|
|
|
*/
|
2016-05-02 12:04:58 +00:00
|
|
|
namespace OC\Log;
|
2020-04-09 09:48:10 +00:00
|
|
|
|
2018-04-26 21:54:11 +00:00
|
|
|
use OC\SystemConfig;
|
2019-11-22 19:52:10 +00:00
|
|
|
use OCP\ILogger;
|
2018-04-25 10:26:03 +00:00
|
|
|
use OCP\Log\IFileBased;
|
2018-04-25 00:27:43 +00:00
|
|
|
use OCP\Log\IWriter;
|
2018-04-25 13:22:28 +00:00
|
|
|
|
2015-02-26 10:37:37 +00:00
|
|
|
/**
|
|
|
|
* logging utilities
|
|
|
|
*
|
2016-07-04 09:50:32 +00:00
|
|
|
* Log is saved at data/nextcloud.log (on default)
|
2015-02-26 10:37:37 +00:00
|
|
|
*/
|
|
|
|
|
2019-07-16 08:15:00 +00:00
|
|
|
class File extends LogDetails implements IWriter, IFileBased {
|
2023-06-28 05:53:43 +00:00
|
|
|
protected string $logFile;
|
2012-03-30 21:40:16 +00:00
|
|
|
|
2023-06-28 05:53:43 +00:00
|
|
|
protected int $logFileMode;
|
|
|
|
|
|
|
|
public function __construct(
|
|
|
|
string $path,
|
|
|
|
string $fallbackPath,
|
|
|
|
private SystemConfig $config,
|
|
|
|
) {
|
2019-07-16 08:15:00 +00:00
|
|
|
parent::__construct($config);
|
2018-04-24 20:14:00 +00: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 15:48:57 +00:00
|
|
|
}
|
2012-12-17 00:43:32 +00:00
|
|
|
}
|
2018-02-09 15:09:56 +00:00
|
|
|
$this->logFileMode = $config->getValue('logfilemode', 0640);
|
2012-03-30 21:15:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* write a message in the log
|
2018-03-22 14:52:46 +00:00
|
|
|
* @param string|array $message
|
2012-03-30 21:15:48 +00:00
|
|
|
*/
|
2023-06-28 05:53:43 +00:00
|
|
|
public function write(string $app, $message, int $level): void {
|
2019-07-16 08:15:00 +00:00
|
|
|
$entry = $this->logDetailsAsJSON($app, $message, $level);
|
2018-04-24 20:14:00 +00:00
|
|
|
$handle = @fopen($this->logFile, 'a');
|
2020-07-03 18:53:54 +00:00
|
|
|
if ($this->logFileMode > 0 && is_file($this->logFile) && (fileperms($this->logFile) & 0777) != $this->logFileMode) {
|
2018-02-09 15:09:56 +00:00
|
|
|
@chmod($this->logFile, $this->logFileMode);
|
2017-01-28 23:55:39 +00:00
|
|
|
}
|
2015-04-30 10:06:52 +00:00
|
|
|
if ($handle) {
|
|
|
|
fwrite($handle, $entry . "\n");
|
|
|
|
fclose($handle);
|
|
|
|
} else {
|
|
|
|
// Fall back to error_log
|
|
|
|
error_log($entry);
|
2012-03-30 21:15:48 +00:00
|
|
|
}
|
2015-12-14 11:16:41 +00:00
|
|
|
if (php_sapi_name() === 'cli-server') {
|
2018-07-23 14:30:38 +00:00
|
|
|
if (!\is_string($message)) {
|
|
|
|
$message = json_encode($message);
|
|
|
|
}
|
2015-12-14 11:16:41 +00:00
|
|
|
error_log($message, 4);
|
|
|
|
}
|
2012-03-30 21:15:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* get entries from the log in reverse chronological order
|
|
|
|
*/
|
2023-06-28 05:53:43 +00:00
|
|
|
public function getEntries(int $limit = 50, int $offset = 0): array {
|
2018-04-26 21:54:11 +00:00
|
|
|
$minLevel = $this->config->getValue('loglevel', ILogger::WARN);
|
2020-03-26 08:30:18 +00:00
|
|
|
$entries = [];
|
2018-04-24 20:14:00 +00:00
|
|
|
$handle = @fopen($this->logFile, 'rb');
|
2012-06-01 18:38:25 +00:00
|
|
|
if ($handle) {
|
2012-07-06 19:51:01 +00: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
|
2020-10-05 13:12:57 +00:00
|
|
|
while ($pos >= 0 && ($limit === null || $entriesCount < $limit)) {
|
2012-07-06 19:51:01 +00:00
|
|
|
fseek($handle, $pos);
|
|
|
|
$ch = fgetc($handle);
|
|
|
|
if ($ch == "\n" || $pos == 0) {
|
|
|
|
if ($line != '') {
|
2013-02-11 16:44:02 +00: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 19:51:01 +00: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-06 21:29:45 +00:00
|
|
|
if ($entry->level >= $minLevel) {
|
|
|
|
$lines++;
|
|
|
|
if ($lines > $offset) {
|
|
|
|
$entries[] = $entry;
|
|
|
|
$entriesCount++;
|
|
|
|
}
|
2012-07-06 19:51:01 +00:00
|
|
|
}
|
|
|
|
$line = '';
|
2012-06-01 18:38:25 +00:00
|
|
|
}
|
2012-07-06 19:51:01 +00:00
|
|
|
} else {
|
|
|
|
$line = $ch . $line;
|
2012-06-01 18:38:25 +00:00
|
|
|
}
|
2012-07-06 19:51:01 +00:00
|
|
|
$pos--;
|
2012-04-16 10:21:12 +00:00
|
|
|
}
|
2012-06-01 18:38:25 +00:00
|
|
|
fclose($handle);
|
2012-03-30 21:15:48 +00:00
|
|
|
}
|
|
|
|
return $entries;
|
|
|
|
}
|
2014-12-20 21:44:41 +00:00
|
|
|
|
2018-04-25 14:01:17 +00:00
|
|
|
public function getLogFilePath():string {
|
2018-04-24 20:14:00 +00:00
|
|
|
return $this->logFile;
|
2014-12-20 21:44:41 +00:00
|
|
|
}
|
2012-03-30 21:15:48 +00:00
|
|
|
}
|