Don't spam the log with fatals when maintenance mode is enabled or an upgrade has to be done

Signed-off-by: Joas Schilling <coding@schilljs.com>

apps/dav/composer/composer/autoload_classmap.php

@@ -224,6 +224,7 @@ return array(
     'OCA\\DAV\\Events\\SubscriptionCreatedEvent' => $baseDir . '/../lib/Events/SubscriptionCreatedEvent.php',
     'OCA\\DAV\\Events\\SubscriptionDeletedEvent' => $baseDir . '/../lib/Events/SubscriptionDeletedEvent.php',
     'OCA\\DAV\\Events\\SubscriptionUpdatedEvent' => $baseDir . '/../lib/Events/SubscriptionUpdatedEvent.php',
+    'OCA\\DAV\\Exception\\ServerMaintenanceMode' => $baseDir . '/../lib/Exception/ServerMaintenanceMode.php',
     'OCA\\DAV\\Exception\\UnsupportedLimitOnInitialSyncException' => $baseDir . '/../lib/Exception/UnsupportedLimitOnInitialSyncException.php',
     'OCA\\DAV\\Files\\BrowserErrorPagePlugin' => $baseDir . '/../lib/Files/BrowserErrorPagePlugin.php',
     'OCA\\DAV\\Files\\FileSearchBackend' => $baseDir . '/../lib/Files/FileSearchBackend.php',

apps/dav/composer/composer/autoload_static.php

@@ -239,6 +239,7 @@ class ComposerStaticInitDAV
         'OCA\\DAV\\Events\\SubscriptionCreatedEvent' => __DIR__ . '/..' . '/../lib/Events/SubscriptionCreatedEvent.php',
         'OCA\\DAV\\Events\\SubscriptionDeletedEvent' => __DIR__ . '/..' . '/../lib/Events/SubscriptionDeletedEvent.php',
         'OCA\\DAV\\Events\\SubscriptionUpdatedEvent' => __DIR__ . '/..' . '/../lib/Events/SubscriptionUpdatedEvent.php',
+        'OCA\\DAV\\Exception\\ServerMaintenanceMode' => __DIR__ . '/..' . '/../lib/Exception/ServerMaintenanceMode.php',
         'OCA\\DAV\\Exception\\UnsupportedLimitOnInitialSyncException' => __DIR__ . '/..' . '/../lib/Exception/UnsupportedLimitOnInitialSyncException.php',
         'OCA\\DAV\\Files\\BrowserErrorPagePlugin' => __DIR__ . '/..' . '/../lib/Files/BrowserErrorPagePlugin.php',
         'OCA\\DAV\\Files\\FileSearchBackend' => __DIR__ . '/..' . '/../lib/Files/FileSearchBackend.php',

apps/dav/lib/Connector/Sabre/ExceptionLoggerPlugin.php

@@ -29,6 +29,7 @@ namespace OCA\DAV\Connector\Sabre;
 
 use OCA\DAV\Connector\Sabre\Exception\FileLocked;
 use OCA\DAV\Connector\Sabre\Exception\PasswordLoginForbidden;
+use OCA\DAV\Exception\ServerMaintenanceMode;
 use OCP\Files\StorageNotAvailableException;
 use Psr\Log\LoggerInterface;
 use Sabre\DAV\Exception\BadRequest;
@@ -81,6 +82,7 @@ class ExceptionLoggerPlugin extends \Sabre\DAV\ServerPlugin {
 		FileLocked::class => true,
 		// An invalid range is requested
 		RequestedRangeNotSatisfiable::class => true,
+		ServerMaintenanceMode::class => true,
 	];
 
 	private string $appName;
@@ -114,17 +116,12 @@ class ExceptionLoggerPlugin extends \Sabre\DAV\ServerPlugin {
 	 */
 	public function logException(\Throwable $ex) {
 		$exceptionClass = get_class($ex);
-		if (isset($this->nonFatalExceptions[$exceptionClass]) ||
-			(
-				$exceptionClass === ServiceUnavailable::class &&
-				$ex->getMessage() === 'System in maintenance mode.'
-			)
-		) {
+		if (isset($this->nonFatalExceptions[$exceptionClass])) {
 			$this->logger->debug($ex->getMessage(), [
 				'app' => $this->appName,
 				'exception' => $ex,
 			]);
-			return; 
+			return;
 		}
 
 		$this->logger->critical($ex->getMessage(), [

apps/dav/lib/Connector/Sabre/MaintenancePlugin.php

@@ -27,6 +27,7 @@
  */
 namespace OCA\DAV\Connector\Sabre;
 
+use OCA\DAV\Exception\ServerMaintenanceMode;
 use OCP\IConfig;
 use OCP\IL10N;
 use OCP\Util;
@@ -82,10 +83,10 @@ class MaintenancePlugin extends ServerPlugin {
 	 */
 	public function checkMaintenanceMode() {
 		if ($this->config->getSystemValueBool('maintenance')) {
-			throw new ServiceUnavailable($this->l10n->t('System is in maintenance mode.'));
+			throw new ServerMaintenanceMode($this->l10n->t('System is in maintenance mode.'));
 		}
 		if (Util::needUpgrade()) {
-			throw new ServiceUnavailable($this->l10n->t('Upgrade needed'));
+			throw new ServerMaintenanceMode($this->l10n->t('Upgrade needed'));
 		}
 
 		return true;

apps/dav/lib/Exception/ServerMaintenanceMode.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2022 Joas Schilling <coding@schilljs.com>
+ *
+ * @author Joas Schilling <coding@schilljs.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+namespace OCA\DAV\Exception;
+
+use Sabre\DAV\Exception\ServiceUnavailable;
+
+class ServerMaintenanceMode extends ServiceUnavailable {
+
+}

apps/dav/tests/unit/Connector/Sabre/ExceptionLoggerPluginTest.php

@@ -32,6 +32,7 @@ use OC\Log;
 use OC\SystemConfig;
 use OCA\DAV\Connector\Sabre\Exception\InvalidPath;
 use OCA\DAV\Connector\Sabre\ExceptionLoggerPlugin;
+use OCA\DAV\Exception\ServerMaintenanceMode;
 use Psr\Log\LoggerInterface;
 use Sabre\DAV\Exception\NotFound;
 use Sabre\DAV\Exception\ServiceUnavailable;
@@ -84,8 +85,10 @@ class ExceptionLoggerPluginTest extends TestCase {
 	public function providesExceptions() {
 		return [
 			['debug', new NotFound()],
-			['debug', new ServiceUnavailable('System in maintenance mode.')],
-			['critical', new ServiceUnavailable('Upgrade needed')],
+			['debug', new ServerMaintenanceMode('System is in maintenance mode.')],
+			// Faking a translation
+			['debug', new ServerMaintenanceMode('Syst3m 1s 1n m41nt3n4nc3 m0d3.')],
+			['debug', new ServerMaintenanceMode('Upgrade needed')],
 			['critical', new InvalidPath('This path leads to nowhere')]
 		];
 	}