summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--.drone.yml8
-rw-r--r--config/config.sample.php22
-rw-r--r--core/Command/Log/Manage.php5
-rw-r--r--index.php8
-rw-r--r--lib/composer/composer/autoload_classmap.php1
-rw-r--r--lib/composer/composer/autoload_static.php1
-rw-r--r--lib/private/Log/LogFactory.php3
-rw-r--r--lib/private/Log/Syslog.php2
-rw-r--r--lib/private/Log/Systemdlog.php78
-rw-r--r--lib/private/legacy/template.php18
-rw-r--r--lib/public/Log/ILogFactory.php3
-rw-r--r--tests/lib/Log/LogFactoryTest.php15
-rw-r--r--tests/lib/TestCase.php1
13 files changed, 145 insertions, 20 deletions
diff --git a/.drone.yml b/.drone.yml
index 8724553982c..6173c155c2b 100644
--- a/.drone.yml
+++ b/.drone.yml
@@ -67,7 +67,7 @@ pipeline:
matrix:
TESTS: syntax-php7.1
phan:
- image: nextcloudci/php7.2:php7.2-11
+ image: nextcloudci/php7.2:php7.2-12
commands:
- composer install
- composer require --dev "phan/phan:0.11.1"
@@ -208,7 +208,7 @@ pipeline:
DB: sqlite
PHP: 7.1
sqlite-php7.2:
- image: nextcloudci/php7.2:php7.2-11
+ image: nextcloudci/php7.2:php7.2-12
commands:
- NOCOVERAGE=true TEST_SELECTION=DB ./autotest.sh sqlite
when:
@@ -232,7 +232,7 @@ pipeline:
DB: mysql
PHP: 7.1
mysql-php7.2:
- image: nextcloudci/php7.2:php7.2-11
+ image: nextcloudci/php7.2:php7.2-12
commands:
- NOCOVERAGE=true TEST_SELECTION=DB ./autotest.sh mysql
when:
@@ -306,7 +306,7 @@ pipeline:
DB: mysqlmb4
PHP: 7.1
mysqlmb4-php7.2:
- image: nextcloudci/php7.2:php7.2-11
+ image: nextcloudci/php7.2:php7.2-12
commands:
- NOCOVERAGE=true TEST_SELECTION=DB ./autotest.sh mysqlmb4
when:
diff --git a/config/config.sample.php b/config/config.sample.php
index 2218021bab9..68f27ed0323 100644
--- a/config/config.sample.php
+++ b/config/config.sample.php
@@ -710,18 +710,24 @@ $CONFIG = array(
*/
/**
- * By default the Nextcloud logs are sent to the ``nextcloud.log`` file in the
- * default Nextcloud data directory.
- * If syslogging is desired, set this parameter to ``syslog``.
- * Setting this parameter to ``errorlog`` will use the PHP error_log function
- * for logging.
+ * This parameter determines where the Nextcloud logs are sent.
+ * ``file``: the logs are written to file ``nextcloud.log`` in the default
+ * Nextcloud data directory. The log file can be changed with parameter
+ * ``logfile``.
+ * ``syslog``: the logs are sent to the system log. This requires a syslog daemon
+ * to be active.
+ * ``errorlog``: the logs are sent to the PHP ``error_log`` function.
+ * ``systemd``: the logs are sent to the Systemd journal. This requires a system
+ * that runs Systemd and the Systemd journal. The PHP extension ``systemd``
+ * must be installed and active.
*
* Defaults to ``file``
*/
'log_type' => 'file',
/**
- * Log file path for the Nextcloud logging type.
+ * Name of the file to which the Nextcloud logs are written if parameter
+ * ``log_type`` is set to ``file``.
*
* Defaults to ``[datadirectory]/nextcloud.log``
*/
@@ -738,7 +744,9 @@ $CONFIG = array(
/**
* If you maintain different instances and aggregate the logs, you may want
* to distinguish between them. ``syslog_tag`` can be set per instance
- * with a unique id. Only available if ``log_type`` is set to ``syslog``.
+ * with a unique id. Only available if ``log_type`` is set to ``syslog`` or
+ * ``systemd``.
+ *
* The default value is ``Nextcloud``.
*/
'syslog_tag' => 'Nextcloud',
diff --git a/core/Command/Log/Manage.php b/core/Command/Log/Manage.php
index 267e84c140f..5a1dd3d048b 100644
--- a/core/Command/Log/Manage.php
+++ b/core/Command/Log/Manage.php
@@ -6,6 +6,7 @@
* @author Robin McCorkell <robin@mccorkell.me.uk>
* @author Roeland Jago Douma <roeland@famdouma.nl>
* @author Thomas Pulzer <t.pulzer@kniel.de>
+ * @author Johannes Ernst <jernst@indiecomputing.com>
*
* @license AGPL-3.0
*
@@ -55,7 +56,7 @@ class Manage extends Command implements CompletionAwareInterface {
'backend',
null,
InputOption::VALUE_REQUIRED,
- 'set the logging backend [file, syslog, errorlog]'
+ 'set the logging backend [file, syslog, errorlog, systemd]'
)
->addOption(
'level',
@@ -181,7 +182,7 @@ class Manage extends Command implements CompletionAwareInterface {
*/
public function completeOptionValues($optionName, CompletionContext $context) {
if ($optionName === 'backend') {
- return ['file', 'syslog', 'errorlog'];
+ return ['file', 'syslog', 'errorlog', 'systemd'];
} else if ($optionName === 'level') {
return ['debug', 'info', 'warning', 'error'];
} else if ($optionName === 'timezone') {
diff --git a/index.php b/index.php
index 4b5991a3ade..ba83054ccca 100644
--- a/index.php
+++ b/index.php
@@ -50,8 +50,12 @@ try {
try {
OC_Template::printErrorPage($ex->getMessage(), $ex->getHint(), 503);
} catch (Exception $ex2) {
- \OC::$server->getLogger()->logException($ex, array('app' => 'index'));
- \OC::$server->getLogger()->logException($ex2, array('app' => 'index'));
+ try {
+ \OC::$server->getLogger()->logException($ex, array('app' => 'index'));
+ \OC::$server->getLogger()->logException($ex2, array('app' => 'index'));
+ } catch (Throwable $e) {
+ // no way to log it properly - but to avoid a white page of death we try harder and ignore this one here
+ }
//show the user a detailed error page
OC_Template::printExceptionErrorPage($ex, 500);
diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php
index 74e42fbe34c..f818bc2840f 100644
--- a/lib/composer/composer/autoload_classmap.php
+++ b/lib/composer/composer/autoload_classmap.php
@@ -794,6 +794,7 @@ return array(
'OC\\Log\\LogFactory' => $baseDir . '/lib/private/Log/LogFactory.php',
'OC\\Log\\Rotate' => $baseDir . '/lib/private/Log/Rotate.php',
'OC\\Log\\Syslog' => $baseDir . '/lib/private/Log/Syslog.php',
+ 'OC\\Log\\Systemdlog' => $baseDir . '/lib/private/Log/Systemdlog.php',
'OC\\Mail\\Attachment' => $baseDir . '/lib/private/Mail/Attachment.php',
'OC\\Mail\\EMailTemplate' => $baseDir . '/lib/private/Mail/EMailTemplate.php',
'OC\\Mail\\Mailer' => $baseDir . '/lib/private/Mail/Mailer.php',
diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php
index df547d55265..05128f65c4f 100644
--- a/lib/composer/composer/autoload_static.php
+++ b/lib/composer/composer/autoload_static.php
@@ -824,6 +824,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
'OC\\Log\\LogFactory' => __DIR__ . '/../../..' . '/lib/private/Log/LogFactory.php',
'OC\\Log\\Rotate' => __DIR__ . '/../../..' . '/lib/private/Log/Rotate.php',
'OC\\Log\\Syslog' => __DIR__ . '/../../..' . '/lib/private/Log/Syslog.php',
+ 'OC\\Log\\Systemdlog' => __DIR__ . '/../../..' . '/lib/private/Log/Systemdlog.php',
'OC\\Mail\\Attachment' => __DIR__ . '/../../..' . '/lib/private/Mail/Attachment.php',
'OC\\Mail\\EMailTemplate' => __DIR__ . '/../../..' . '/lib/private/Mail/EMailTemplate.php',
'OC\\Mail\\Mailer' => __DIR__ . '/../../..' . '/lib/private/Mail/Mailer.php',
diff --git a/lib/private/Log/LogFactory.php b/lib/private/Log/LogFactory.php
index 9b9d12abfa8..5bb803cbaf2 100644
--- a/lib/private/Log/LogFactory.php
+++ b/lib/private/Log/LogFactory.php
@@ -3,6 +3,7 @@
* @copyright Copyright (c) 2018 Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ * @author Johannes Ernst <jernst@indiecomputing.com>
*
* @license GNU AGPL version 3 or any later version
*
@@ -50,6 +51,8 @@ class LogFactory implements ILogFactory {
return new Errorlog();
case 'syslog':
return $this->c->resolve(Syslog::class);
+ case 'systemd':
+ return $this->c->resolve(Systemdlog::class);
case 'file':
return $this->buildLogFile();
diff --git a/lib/private/Log/Syslog.php b/lib/private/Log/Syslog.php
index 90a20026f0e..b652eb4343d 100644
--- a/lib/private/Log/Syslog.php
+++ b/lib/private/Log/Syslog.php
@@ -39,7 +39,7 @@ class Syslog implements IWriter {
];
public function __construct(IConfig $config) {
- openlog($config->getSystemValue('syslog_tag', 'ownCloud'), LOG_PID | LOG_CONS, LOG_USER);
+ openlog($config->getSystemValue('syslog_tag', 'Nextcloud'), LOG_PID | LOG_CONS, LOG_USER);
}
public function __destruct() {
diff --git a/lib/private/Log/Systemdlog.php b/lib/private/Log/Systemdlog.php
new file mode 100644
index 00000000000..40e9c12386e
--- /dev/null
+++ b/lib/private/Log/Systemdlog.php
@@ -0,0 +1,78 @@
+<?php
+/**
+ * @copyright Copyright (c) 2018, Johannes Ernst
+ *
+ * @author Johannes Ernst <jernst@indiecomputing.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * 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/>
+ *
+ */
+
+namespace OC\Log;
+
+use OC\HintException;
+use OCP\ILogger;
+use OCP\IConfig;
+use OCP\Log\IWriter;
+
+// The following fields are understood by systemd/journald, see
+// man systemd.journal-fields. All are optional:
+// MESSAGE=
+// The human-readable message string for this entry.
+// MESSAGE_ID=
+// A 128-bit message identifier ID
+// PRIORITY=
+// A priority value between 0 ("emerg") and 7 ("debug")
+// CODE_FILE=, CODE_LINE=, CODE_FUNC=
+// The code location generating this message, if known
+// ERRNO=
+// The low-level Unix error number causing this entry, if any.
+// SYSLOG_FACILITY=, SYSLOG_IDENTIFIER=, SYSLOG_PID=
+// Syslog compatibility fields
+
+class Systemdlog implements IWriter {
+ protected $levels = [
+ ILogger::DEBUG => 7,
+ ILogger::INFO => 6,
+ ILogger::WARN => 4,
+ ILogger::ERROR => 3,
+ ILogger::FATAL => 2,
+ ];
+
+ protected $syslogId;
+
+ public function __construct(IConfig $config) {
+ if(!function_exists('sd_journal_send')) {
+ throw new HintException(
+ 'PHP extension php-systemd is not available.',
+ 'Please install and enable PHP extension systemd if you wish to log to the Systemd journal.');
+
+ }
+ $this->syslogId = $config->getSystemValue('syslog_tag', 'Nextcloud');
+ }
+
+ /**
+ * Write a message to the log.
+ * @param string $app
+ * @param string $message
+ * @param int $level
+ */
+ public function write(string $app, $message, int $level) {
+ $journal_level = $this->levels[$level];
+ sd_journal_send('PRIORITY='.$journal_level,
+ 'SYSLOG_IDENTIFIER='.$this->syslogId,
+ 'MESSAGE={'.$app.'} '.$message);
+ }
+}
diff --git a/lib/private/legacy/template.php b/lib/private/legacy/template.php
index f84d6386deb..1505089d561 100644
--- a/lib/private/legacy/template.php
+++ b/lib/private/legacy/template.php
@@ -358,9 +358,21 @@ class OC_Template extends \OC\Template\Base {
$content->assign('requestID', $request->getId());
$content->printPage();
} catch (\Exception $e) {
- $logger = \OC::$server->getLogger();
- $logger->logException($exception, ['app' => 'core']);
- $logger->logException($e, ['app' => 'core']);
+ try {
+ $logger = \OC::$server->getLogger();
+ $logger->logException($exception, ['app' => 'core']);
+ $logger->logException($e, ['app' => 'core']);
+ } catch (Throwable $e) {
+ // no way to log it properly - but to avoid a white page of death we send some output
+ header('Content-Type: text/plain; charset=utf-8');
+ print("Internal Server Error\n\n");
+ print("The server encountered an internal error and was unable to complete your request.\n");
+ print("Please contact the server administrator if this error reappears multiple times, please include the technical details below in your report.\n");
+ print("More details can be found in the server log.\n");
+
+ // and then throw it again to log it at least to the web server error log
+ throw $e;
+ }
header('Content-Type: text/plain; charset=utf-8');
print("Internal Server Error\n\n");
diff --git a/lib/public/Log/ILogFactory.php b/lib/public/Log/ILogFactory.php
index d8e1ab4ee76..6f843d12687 100644
--- a/lib/public/Log/ILogFactory.php
+++ b/lib/public/Log/ILogFactory.php
@@ -3,6 +3,7 @@
* @copyright Copyright (c) 2018 Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ * @author Johannes Ernst <jernst@indiecomputing.com>
*
* @license GNU AGPL version 3 or any later version
*
@@ -33,7 +34,7 @@ use OCP\ILogger;
*/
interface ILogFactory {
/**
- * @param string $type - one of: file, errorlog, syslog
+ * @param string $type - one of: file, errorlog, syslog, systemd
* @return IWriter
* @since 14.0.0
*/
diff --git a/tests/lib/Log/LogFactoryTest.php b/tests/lib/Log/LogFactoryTest.php
index 08139f54df4..b9b4c2c218a 100644
--- a/tests/lib/Log/LogFactoryTest.php
+++ b/tests/lib/Log/LogFactoryTest.php
@@ -3,6 +3,7 @@
* @copyright Copyright (c) 2018 Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ * @author Johannes Ernst <jernst@indiecomputing.com>
*
* @license GNU AGPL version 3 or any later version
*
@@ -26,6 +27,7 @@ use OC\Log\Errorlog;
use OC\Log\File;
use OC\Log\LogFactory;
use OC\Log\Syslog;
+use OC\Log\Systemdlog;
use OC\SystemConfig;
use OCP\IConfig;
use OCP\IServerContainer;
@@ -141,4 +143,17 @@ class LogFactoryTest extends TestCase {
$log = $this->factory->get('syslog');
$this->assertInstanceOf(Syslog::class, $log);
}
+
+ /**
+ * @throws \OCP\AppFramework\QueryException
+ */
+ public function testSystemdLog() {
+ $this->c->expects($this->once())
+ ->method('resolve')
+ ->with(Systemdlog::class)
+ ->willReturn($this->createMock(Systemdlog::class));
+
+ $log = $this->factory->get('systemd');
+ $this->assertInstanceOf(Systemdlog::class, $log);
+ }
}
diff --git a/tests/lib/TestCase.php b/tests/lib/TestCase.php
index 92076580510..96ee0f06f8c 100644
--- a/tests/lib/TestCase.php
+++ b/tests/lib/TestCase.php
@@ -299,6 +299,7 @@ abstract class TestCase extends \PHPUnit\Framework\TestCase {
static protected function tearDownAfterClassCleanStrayDataFiles($dataDir) {
$knownEntries = array(
'nextcloud.log' => true,
+ 'audit.log' => true,
'owncloud.db' => true,
'.ocdata' => true,
'..' => true,
generated by cgit v1.2.3 (git 2.39.1) at 2025-02-13 08:02:18 +0000