Merge pull request #25016 from nextcloud/enh/noid/add-check-for-unsupported-db

Add setup check to verify that the used DB version is still supported…

6 files changed, 180 insertions, 3 deletions

diff --git a/apps/settings/composer/composer/autoload_classmap.php b/apps/settings/composer/composer/autoload_classmap.php
index 916b6f8c55a..bf15d877fe0 100644
--- a/apps/settings/composer/composer/autoload_classmap.php
+++ b/apps/settings/composer/composer/autoload_classmap.php
@@ -61,4 +61,5 @@ return array(
     'OCA\\Settings\\SetupChecks\\LegacySSEKeyFormat' => $baseDir . '/../lib/SetupChecks/LegacySSEKeyFormat.php',
     'OCA\\Settings\\SetupChecks\\PhpDefaultCharset' => $baseDir . '/../lib/SetupChecks/PhpDefaultCharset.php',
     'OCA\\Settings\\SetupChecks\\PhpOutputBuffering' => $baseDir . '/../lib/SetupChecks/PhpOutputBuffering.php',
+    'OCA\\Settings\\SetupChecks\\SupportedDatabase' => $baseDir . '/../lib/SetupChecks/SupportedDatabase.php',
 );
diff --git a/apps/settings/composer/composer/autoload_static.php b/apps/settings/composer/composer/autoload_static.php
index 661fc4bd84d..87635f63586 100644
--- a/apps/settings/composer/composer/autoload_static.php
+++ b/apps/settings/composer/composer/autoload_static.php
@@ -76,6 +76,7 @@ class ComposerStaticInitSettings
         'OCA\\Settings\\SetupChecks\\LegacySSEKeyFormat' => __DIR__ . '/..' . '/../lib/SetupChecks/LegacySSEKeyFormat.php',
         'OCA\\Settings\\SetupChecks\\PhpDefaultCharset' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpDefaultCharset.php',
         'OCA\\Settings\\SetupChecks\\PhpOutputBuffering' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpOutputBuffering.php',
+        'OCA\\Settings\\SetupChecks\\SupportedDatabase' => __DIR__ . '/..' . '/../lib/SetupChecks/SupportedDatabase.php',
     );
 
     public static function getInitializer(ClassLoader $loader)
diff --git a/apps/settings/lib/Controller/CheckSetupController.php b/apps/settings/lib/Controller/CheckSetupController.php
index b21301cd96a..a53bdd408c0 100644
--- a/apps/settings/lib/Controller/CheckSetupController.php
+++ b/apps/settings/lib/Controller/CheckSetupController.php
@@ -63,6 +63,7 @@ use OCA\Settings\SetupChecks\CheckUserCertificates;
 use OCA\Settings\SetupChecks\LegacySSEKeyFormat;
 use OCA\Settings\SetupChecks\PhpDefaultCharset;
 use OCA\Settings\SetupChecks\PhpOutputBuffering;
+use OCA\Settings\SetupChecks\SupportedDatabase;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http\DataDisplayResponse;
 use OCP\AppFramework\Http\DataResponse;
@@ -107,6 +108,8 @@ class CheckSetupController extends Controller {
 	private $secureRandom;
 	/** @var IniGetWrapper */
 	private $iniGetWrapper;
+	/** @var IDBConnection */
+	private $connection;
 
 	public function __construct($AppName,
 								IRequest $request,
@@ -122,7 +125,8 @@ class CheckSetupController extends Controller {
 								IDateTimeFormatter $dateTimeFormatter,
 								MemoryInfo $memoryInfo,
 								ISecureRandom $secureRandom,
-								IniGetWrapper $iniGetWrapper) {
+								IniGetWrapper $iniGetWrapper,
+								IDBConnection $connection) {
 		parent::__construct($AppName, $request);
 		$this->config = $config;
 		$this->clientService = $clientService;
@@ -137,6 +141,7 @@ class CheckSetupController extends Controller {
 		$this->memoryInfo = $memoryInfo;
 		$this->secureRandom = $secureRandom;
 		$this->iniGetWrapper = $iniGetWrapper;
+		$this->connection = $connection;
 	}
 
 	/**
@@ -714,6 +719,7 @@ Raw output
 		$phpOutputBuffering = new PhpOutputBuffering();
 		$legacySSEKeyFormat = new LegacySSEKeyFormat($this->l10n, $this->config, $this->urlGenerator);
 		$checkUserCertificates = new CheckUserCertificates($this->l10n, $this->config, $this->urlGenerator);
+		$supportedDatabases = new SupportedDatabase($this->l10n, $this->connection);
 
 		return new DataResponse(
 			[
@@ -760,6 +766,7 @@ Raw output
 				LegacySSEKeyFormat::class => ['pass' => $legacySSEKeyFormat->run(), 'description' => $legacySSEKeyFormat->description(), 'severity' => $legacySSEKeyFormat->severity(), 'linkToDocumentation' => $legacySSEKeyFormat->linkToDocumentation()],
 				CheckUserCertificates::class => ['pass' => $checkUserCertificates->run(), 'description' => $checkUserCertificates->description(), 'severity' => $checkUserCertificates->severity(), 'elements' => $checkUserCertificates->elements()],
 				'isDefaultPhoneRegionSet' => $this->config->getSystemValueString('default_phone_region', '') !== '',
+				SupportedDatabase::class => ['pass' => $supportedDatabases->run(), 'description' => $supportedDatabases->description(), 'severity' => $supportedDatabases->severity()],
 			]
 		);
 	}
diff --git a/apps/settings/lib/SetupChecks/SupportedDatabase.php b/apps/settings/lib/SetupChecks/SupportedDatabase.php
new file mode 100644
index 00000000000..ac9138abfc6
--- /dev/null
+++ b/apps/settings/lib/SetupChecks/SupportedDatabase.php
@@ -0,0 +1,112 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2021 Morris Jobke <hey@morrisjobke.de>
+ *
+ * @author Morris Jobke <hey@morrisjobke.de>
+ *
+ * @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\Settings\SetupChecks;
+
+use Doctrine\DBAL\Platforms\MariaDb1027Platform;
+use Doctrine\DBAL\Platforms\MySQL57Platform;
+use Doctrine\DBAL\Platforms\MySQL80Platform;
+use Doctrine\DBAL\Platforms\MySqlPlatform;
+use Doctrine\DBAL\Platforms\OraclePlatform;
+use Doctrine\DBAL\Platforms\PostgreSQL100Platform;
+use Doctrine\DBAL\Platforms\PostgreSQL94Platform;
+use Doctrine\DBAL\Platforms\SqlitePlatform;
+use OCP\IDBConnection;
+use OCP\IL10N;
+
+class SupportedDatabase {
+	/** @var IL10N */
+	private $l10n;
+	/** @var IDBConnection */
+	private $connection;
+
+	private $checked = false;
+	private $description = '';
+
+	public function __construct(IL10N $l10n, IDBConnection $connection) {
+		$this->l10n = $l10n;
+		$this->connection = $connection;
+	}
+
+	public function check() {
+		if ($this->checked === true) {
+			return;
+		}
+		$this->checked = true;
+
+		switch (get_class($this->connection->getDatabasePlatform())) {
+			case MySQL80Platform::class: # extends MySQL57Platform
+			case MySQL57Platform::class: # extends MySQLPlatform
+			case MariaDb1027Platform::class: # extends MySQLPlatform
+			case MySqlPlatform::class:
+				$result = $this->connection->prepare('SHOW VARIABLES LIKE "version";');
+				$result->execute();
+				$row = $result->fetch();
+				$version = strtolower($row['Value']);
+
+				if (strpos($version, 'mariadb') !== false) {
+					if (version_compare($version, '10.2', '<')) {
+						$this->description = $this->l10n->t('MariaDB version "%s" is used. Nextcloud 21 will no longer support this version and requires MariaDB 10.2 or higher.', $row['Value']);
+						return;
+					}
+				} else {
+					if (version_compare($version, '8', '<')) {
+						$this->description = $this->l10n->t('MySQL version "%s" is used. Nextcloud 21 will no longer support this version and requires MySQL 8 or higher.', $row['Value']);
+						return;
+					}
+				}
+				break;
+			case SqlitePlatform::class:
+				break;
+			case PostgreSQL100Platform::class: # extends PostgreSQL94Platform
+			case PostgreSQL94Platform::class:
+				$result = $this->connection->prepare('SHOW server_version;');
+				$result->execute();
+				$row = $result->fetch();
+				if (version_compare($row['server_version'], '9.6', '<')) {
+					$this->description = $this->l10n->t('PostgreSQL version "%s" is used. Nextcloud 21 will no longer support this version and requires PostgreSQL 9.6 or higher.', $row['server_version']);
+					return;
+				}
+				break;
+			case OraclePlatform::class:
+				break;
+		}
+	}
+
+	public function description(): string {
+		$this->check();
+		return $this->description;
+	}
+
+	public function severity(): string {
+		return 'info';
+	}
+
+	public function run(): bool {
+		$this->check();
+		return $this->description === '';
+	}
+}
diff --git a/apps/settings/tests/Controller/CheckSetupControllerTest.php b/apps/settings/tests/Controller/CheckSetupControllerTest.php
index 040a0ca3500..426793df606 100644
--- a/apps/settings/tests/Controller/CheckSetupControllerTest.php
+++ b/apps/settings/tests/Controller/CheckSetupControllerTest.php
@@ -35,6 +35,7 @@
 namespace OCA\Settings\Tests\Controller;
 
 use bantu\IniGetWrapper\IniGetWrapper;
+use Doctrine\DBAL\Platforms\SqlitePlatform;
 use OC;
 use OC\DB\Connection;
 use OC\IntegrityCheck\Checker;
@@ -48,6 +49,7 @@ use OCP\AppFramework\Http\RedirectResponse;
 use OCP\Http\Client\IClientService;
 use OCP\IConfig;
 use OCP\IDateTimeFormatter;
+use OCP\IDBConnection;
 use OCP\IL10N;
 use OCP\ILogger;
 use OCP\IRequest;
@@ -95,6 +97,8 @@ class CheckSetupControllerTest extends TestCase {
 	private $secureRandom;
 	/** @var IniGetWrapper|\PHPUnit\Framework\MockObject\MockObject */
 	private $iniGetWrapper;
+	/** @var IDBConnection|\PHPUnit\Framework\MockObject\MockObject */
+	private $connection;
 
 	/**
 	 * Holds a list of directories created during tests.
@@ -135,6 +139,8 @@ class CheckSetupControllerTest extends TestCase {
 			->getMock();
 		$this->secureRandom = $this->getMockBuilder(SecureRandom::class)->getMock();
 		$this->iniGetWrapper = $this->getMockBuilder(IniGetWrapper::class)->getMock();
+		$this->connection = $this->getMockBuilder(IDBConnection::class)
+			->disableOriginalConstructor()->getMock();
 		$this->checkSetupController = $this->getMockBuilder(CheckSetupController::class)
 			->setConstructorArgs([
 				'settings',
@@ -152,6 +158,7 @@ class CheckSetupControllerTest extends TestCase {
 				$this->memoryInfo,
 				$this->secureRandom,
 				$this->iniGetWrapper,
+				$this->connection,
 			])
 			->setMethods([
 				'isReadOnlyConfig',
@@ -553,6 +560,9 @@ class CheckSetupControllerTest extends TestCase {
 				}
 				return '';
 			});
+		$sqlitePlatform = $this->getMockBuilder(SqlitePlatform::class)->getMock();
+		$this->connection->method('getDatabasePlatform')
+			->willReturn($sqlitePlatform);
 
 		$expected = new DataResponse(
 			[
@@ -606,6 +616,7 @@ class CheckSetupControllerTest extends TestCase {
 				'OCA\Settings\SetupChecks\CheckUserCertificates' => ['pass' => false, 'description' => 'There are some user imported SSL certificates present, that are not used anymore with Nextcloud 21. They can be imported on the command line via "occ security:certificates:import" command. Their paths inside the data directory are shown below.', 'severity' => 'warning', 'elements' => ['a', 'b']],
 				'imageMagickLacksSVGSupport' => false,
 				'isDefaultPhoneRegionSet' => false,
+				'OCA\Settings\SetupChecks\SupportedDatabase' => ['pass' => true, 'description' => '', 'severity' => 'info'],
 			]
 		);
 		$this->assertEquals($expected, $this->checkSetupController->check());
@@ -629,6 +640,7 @@ class CheckSetupControllerTest extends TestCase {
 				$this->memoryInfo,
 				$this->secureRandom,
 				$this->iniGetWrapper,
+				$this->connection,
 			])
 			->setMethods(null)->getMock();
 
@@ -1397,7 +1409,8 @@ Array
 				$this->dateTimeFormatter,
 				$this->memoryInfo,
 				$this->secureRandom,
-				$this->iniGetWrapper
+				$this->iniGetWrapper,
+				$this->connection
 			);
 
 		$this->assertSame($expected, $this->invokePrivate($checkSetupController, 'isMysqlUsedWithoutUTF8MB4'));
@@ -1446,7 +1459,8 @@ Array
 			$this->dateTimeFormatter,
 			$this->memoryInfo,
 			$this->secureRandom,
-			$this->iniGetWrapper
+			$this->iniGetWrapper,
+			$this->connection
 		);
 
 		$this->assertSame($expected, $this->invokePrivate($checkSetupController, 'isEnoughTempSpaceAvailableIfS3PrimaryStorageIsUsed'));
diff --git a/apps/settings/tests/SetupChecks/SupportedDatabaseTest.php b/apps/settings/tests/SetupChecks/SupportedDatabaseTest.php
new file mode 100644
index 00000000000..de709572261
--- /dev/null
+++ b/apps/settings/tests/SetupChecks/SupportedDatabaseTest.php
@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2021 Morris Jobke <hey@morrisjobke.de>
+ *
+ * @author Morris Jobke <hey@morrisjobke.de>
+ *
+ * @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\Settings\Tests;
+
+use OCA\Settings\SetupChecks\SupportedDatabase;
+use OCP\IL10N;
+use Test\TestCase;
+
+/**
+ * @group DB
+ */
+class SupportedDatabaseTest extends TestCase {
+	public function testPass(): void {
+		$l10n = $this->getMockBuilder(IL10N::class)->getMock();
+		$check = new SupportedDatabase($l10n, \OC::$server->getDatabaseConnection());
+		$this->assertTrue($check->run());
+	}
+}