fix: validate account properties as a repair step

Replace `ValidatePhoneNumber` from Nextcloud 21 with a new repair step, `ValidateAccountProperties` which validates and sanitizes all account properties. Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2026-04-22 14:50:17 -04:00 · 2025-02-23 19:08:10 +01:00 · 2025-02-23 19:08:10 +01:00 · 08d33a9f57
commit 08d33a9f57
parent a4ffc554d4
6 changed files with 151 additions and 74 deletions
--- a/lib/composer/composer/autoload_classmap.php
+++ b/lib/composer/composer/autoload_classmap.php
@ -1882,10 +1882,10 @@ return array(
    'OC\\Repair\\NC20\\EncryptionMigration' => $baseDir . '/lib/private/Repair/NC20/EncryptionMigration.php',
    'OC\\Repair\\NC20\\ShippedDashboardEnable' => $baseDir . '/lib/private/Repair/NC20/ShippedDashboardEnable.php',
    'OC\\Repair\\NC21\\AddCheckForUserCertificatesJob' => $baseDir . '/lib/private/Repair/NC21/AddCheckForUserCertificatesJob.php',
-    'OC\\Repair\\NC21\\ValidatePhoneNumber' => $baseDir . '/lib/private/Repair/NC21/ValidatePhoneNumber.php',
    'OC\\Repair\\NC22\\LookupServerSendCheck' => $baseDir . '/lib/private/Repair/NC22/LookupServerSendCheck.php',
    'OC\\Repair\\NC24\\AddTokenCleanupJob' => $baseDir . '/lib/private/Repair/NC24/AddTokenCleanupJob.php',
    'OC\\Repair\\NC25\\AddMissingSecretJob' => $baseDir . '/lib/private/Repair/NC25/AddMissingSecretJob.php',
+    'OC\\Repair\\NC29\\ValidateAccountProperties' => $baseDir . '/lib/private/Repair/NC29/ValidateAccountProperties.php',
    'OC\\Repair\\NC30\\RemoveLegacyDatadirFile' => $baseDir . '/lib/private/Repair/NC30/RemoveLegacyDatadirFile.php',
    'OC\\Repair\\OldGroupMembershipShares' => $baseDir . '/lib/private/Repair/OldGroupMembershipShares.php',
    'OC\\Repair\\Owncloud\\CleanPreviews' => $baseDir . '/lib/private/Repair/Owncloud/CleanPreviews.php',
--- a/lib/composer/composer/autoload_static.php
+++ b/lib/composer/composer/autoload_static.php
@ -1931,10 +1931,10 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
        'OC\\Repair\\NC20\\EncryptionMigration' => __DIR__ . '/../../..' . '/lib/private/Repair/NC20/EncryptionMigration.php',
        'OC\\Repair\\NC20\\ShippedDashboardEnable' => __DIR__ . '/../../..' . '/lib/private/Repair/NC20/ShippedDashboardEnable.php',
        'OC\\Repair\\NC21\\AddCheckForUserCertificatesJob' => __DIR__ . '/../../..' . '/lib/private/Repair/NC21/AddCheckForUserCertificatesJob.php',
-        'OC\\Repair\\NC21\\ValidatePhoneNumber' => __DIR__ . '/../../..' . '/lib/private/Repair/NC21/ValidatePhoneNumber.php',
        'OC\\Repair\\NC22\\LookupServerSendCheck' => __DIR__ . '/../../..' . '/lib/private/Repair/NC22/LookupServerSendCheck.php',
        'OC\\Repair\\NC24\\AddTokenCleanupJob' => __DIR__ . '/../../..' . '/lib/private/Repair/NC24/AddTokenCleanupJob.php',
        'OC\\Repair\\NC25\\AddMissingSecretJob' => __DIR__ . '/../../..' . '/lib/private/Repair/NC25/AddMissingSecretJob.php',
+        'OC\\Repair\\NC29\\ValidateAccountProperties' => __DIR__ . '/../../..' . '/lib/private/Repair/NC29/ValidateAccountProperties.php',
        'OC\\Repair\\NC30\\RemoveLegacyDatadirFile' => __DIR__ . '/../../..' . '/lib/private/Repair/NC30/RemoveLegacyDatadirFile.php',
        'OC\\Repair\\OldGroupMembershipShares' => __DIR__ . '/../../..' . '/lib/private/Repair/OldGroupMembershipShares.php',
        'OC\\Repair\\Owncloud\\CleanPreviews' => __DIR__ . '/../../..' . '/lib/private/Repair/Owncloud/CleanPreviews.php',
--- a/lib/private/Repair.php
+++ b/lib/private/Repair.php
@ -37,10 +37,10 @@ use OC\Repair\NC20\EncryptionLegacyCipher;
 use OC\Repair\NC20\EncryptionMigration;
 use OC\Repair\NC20\ShippedDashboardEnable;
 use OC\Repair\NC21\AddCheckForUserCertificatesJob;
-use OC\Repair\NC21\ValidatePhoneNumber;
 use OC\Repair\NC22\LookupServerSendCheck;
 use OC\Repair\NC24\AddTokenCleanupJob;
 use OC\Repair\NC25\AddMissingSecretJob;
+use OC\Repair\NC29\ValidateAccountProperties;
 use OC\Repair\NC30\RemoveLegacyDatadirFile;
 use OC\Repair\OldGroupMembershipShares;
 use OC\Repair\Owncloud\CleanPreviews;
@ -212,7 +212,7 @@ class Repair implements IOutput {
 				\OCP\Server::get(IAppConfig::class),
 				\OCP\Server::get(IDBConnection::class)
 			),
-			\OC::$server->get(ValidatePhoneNumber::class),
+			\OC::$server->get(ValidateAccountProperties::class),
 			\OC::$server->get(DeleteSchedulingObjects::class),
 		];
 	}
--- a/lib/private/Repair/NC21/ValidatePhoneNumber.php
+++ b/lib/private/Repair/NC21/ValidatePhoneNumber.php
@ -1,70 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-/**
- * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
- * SPDX-License-Identifier: AGPL-3.0-or-later
- */
-namespace OC\Repair\NC21;
-
-use OCP\Accounts\IAccountManager;
-use OCP\IConfig;
-use OCP\IUser;
-use OCP\IUserManager;
-use OCP\Migration\IOutput;
-use OCP\Migration\IRepairStep;
-
-class ValidatePhoneNumber implements IRepairStep {
-	/** @var IConfig */
-	protected $config;
-	/** @var IUserManager */
-	protected $userManager;
-	/** @var IAccountManager */
-	private $accountManager;
-
-	public function __construct(IUserManager $userManager,
-		IAccountManager $accountManager,
-		IConfig $config) {
-		$this->config = $config;
-		$this->userManager = $userManager;
-		$this->accountManager = $accountManager;
-	}
-
-	public function getName(): string {
-		return 'Validate the phone number and store it in a known format for search';
-	}
-
-	public function run(IOutput $output): void {
-		if ($this->config->getSystemValueString('default_phone_region', '') === '') {
-			$output->warning('Can not validate phone numbers without `default_phone_region` being set in the config file');
-			return;
-		}
-
-		$numUpdated = 0;
-		$numRemoved = 0;
-
-		$this->userManager->callForSeenUsers(function (IUser $user) use (&$numUpdated, &$numRemoved) {
-			$account = $this->accountManager->getAccount($user);
-			$property = $account->getProperty(IAccountManager::PROPERTY_PHONE);
-
-			if ($property->getValue() !== '') {
-				$this->accountManager->updateAccount($account);
-				$updatedAccount = $this->accountManager->getAccount($user);
-				$updatedProperty = $updatedAccount->getProperty(IAccountManager::PROPERTY_PHONE);
-
-				if ($property->getValue() !== $updatedProperty->getValue()) {
-					if ($updatedProperty->getValue() === '') {
-						$numRemoved++;
-					} else {
-						$numUpdated++;
-					}
-				}
-			}
-		});
-
-		if ($numRemoved > 0 || $numUpdated > 0) {
-			$output->info('Updated ' . $numUpdated . ' entries and cleaned ' . $numRemoved . ' invalid phone numbers');
-		}
-	}
-}
--- a/lib/private/Repair/NC29/ValidateAccountProperties.php
+++ b/lib/private/Repair/NC29/ValidateAccountProperties.php
@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OC\Repair\NC29;
+
+use InvalidArgumentException;
+use OCP\Accounts\IAccountManager;
+use OCP\IUser;
+use OCP\IUserManager;
+use OCP\Migration\IOutput;
+use OCP\Migration\IRepairStep;
+use Psr\Log\LoggerInterface;
+
+class ValidateAccountProperties implements IRepairStep {
+
+	public function __construct(
+		private IUserManager $userManager,
+		private IAccountManager $accountManager,
+		private LoggerInterface $logger,
+	) {
+	}
+
+	public function getName(): string {
+		return 'Validate account properties and store phone numbers in a known format for search';
+	}
+
+	public function run(IOutput $output): void {
+		$numRemoved = 0;
+
+		$this->userManager->callForSeenUsers(function (IUser $user) use (&$numRemoved) {
+			$account = $this->accountManager->getAccount($user);
+			while (true) {
+				try {
+					$this->accountManager->updateAccount($account);
+					break;
+				} catch (InvalidArgumentException $e) {
+					if (in_array($e->getMessage(), IAccountManager::ALLOWED_PROPERTIES)) {
+						$numRemoved++;
+						$property = $account->getProperty($e->getMessage());
+						$account->setProperty($property->getName(), '', $property->getScope(), IAccountManager::NOT_VERIFIED);
+					} else {
+						$this->logger->error('Error while sanitizing account property', ['exception' => $e, 'user' => $user->getUID()]);
+						break;
+					}
+				}
+			}
+		});
+
+		if ($numRemoved > 0) {
+			$output->info('Cleaned ' . $numRemoved . ' invalid account property entries');
+		}
+	}
+}
--- a/tests/lib/Repair/NC29/ValidateAccountPropertiesTest.php
+++ b/tests/lib/Repair/NC29/ValidateAccountPropertiesTest.php
@ -0,0 +1,89 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OC\Repair\NC29;
+
+use InvalidArgumentException;
+use OCP\Accounts\IAccount;
+use OCP\Accounts\IAccountManager;
+use OCP\Accounts\IAccountProperty;
+use OCP\IUser;
+use OCP\IUserManager;
+use OCP\Migration\IOutput;
+use PHPUnit\Framework\MockObject\MockObject;
+use Psr\Log\LoggerInterface;
+use Test\TestCase;
+
+class ValidateAccountPropertiesTest extends TestCase {
+
+	private IUserManager&MockObject $userManager;
+	private IAccountManager&MockObject $accountManager;
+	private LoggerInterface&MockObject $logger;
+	
+	private ValidateAccountProperties $repairStep;
+
+	protected function setUp(): void {
+		$this->userManager = $this->createMock(IUserManager::class);
+		$this->accountManager = $this->createMock(IAccountManager::class);
+		$this->logger = $this->createMock(LoggerInterface::class);
+
+		$this->repairStep = new ValidateAccountProperties($this->userManager, $this->accountManager, $this->logger);
+	}
+
+	public function testGetName(): void {
+		self::assertStringContainsString('Validate account properties', $this->repairStep->getName());
+	}
+
+	public function testRun(): void {
+		$users = [
+			$this->createMock(IUser::class),
+			$this->createMock(IUser::class),
+		];
+		$this->userManager
+			->expects(self::once())
+			->method('callForSeenUsers')
+			->willReturnCallback(fn ($fn) => array_map($fn, $users));
+
+		$property = $this->createMock(IAccountProperty::class);
+		$property->expects(self::once())->method('getName')->willReturn(IAccountManager::PROPERTY_PHONE);
+		$property->expects(self::once())->method('getScope')->willReturn(IAccountManager::SCOPE_LOCAL);
+
+		$account1 = $this->createMock(IAccount::class);
+		$account1->expects(self::once())
+			->method('getProperty')
+			->with(IAccountManager::PROPERTY_PHONE)
+			->willReturn($property);
+		$account1->expects(self::once())
+			->method('setProperty')
+			->with(IAccountManager::PROPERTY_PHONE, '', IAccountManager::SCOPE_LOCAL, IAccountManager::NOT_VERIFIED);
+		$account2 = $this->createMock(IAccount::class);
+		$account2->expects(self::never())
+			->method('getProperty');
+		$this->accountManager
+			->expects(self::exactly(2))
+			->method('getAccount')
+			->willReturnMap([
+				[$users[0], $account1],
+				[$users[1], $account2],
+			]);
+		$valid = false;
+		$this->accountManager->expects(self::exactly(3))
+			->method('updateAccount')
+			->willReturnCallback(function (IAccount $account) use (&$account1, &$valid) {
+				if (!$valid && $account === $account1) {
+					$valid = true;
+					throw new InvalidArgumentException(IAccountManager::PROPERTY_PHONE);
+				}
+			});
+
+		$output = $this->createMock(IOutput::class);
+		$output->expects(self::once())->method('info')->with('Cleaned 1 invalid account property entries');
+
+		$this->repairStep->run($output);
+	}
+}