nextcloud / server

lib/private/Repair.php

Indentation +193 added lines, -193 removed lines

@@ -75,215 +75,215 @@
 use Throwable;
 
 class Repair implements IOutput {
-	/** @var IRepairStep[] */
-	private array $repairSteps = [];
+    /** @var IRepairStep[] */
+    private array $repairSteps = [];
 
-	private string $currentStep;
+    private string $currentStep;
 
-	public function __construct(
-		private IEventDispatcher $dispatcher,
-		private LoggerInterface $logger,
-	) {
-	}
+    public function __construct(
+        private IEventDispatcher $dispatcher,
+        private LoggerInterface $logger,
+    ) {
+    }
 
-	/** @param IRepairStep[] $repairSteps */
-	public function setRepairSteps(array $repairSteps): void {
-		$this->repairSteps = $repairSteps;
-	}
+    /** @param IRepairStep[] $repairSteps */
+    public function setRepairSteps(array $repairSteps): void {
+        $this->repairSteps = $repairSteps;
+    }
 
-	/**
-	 * Run a series of repair steps for common problems
-	 */
-	public function run() {
-		if (count($this->repairSteps) === 0) {
-			$this->dispatcher->dispatchTyped(new RepairInfoEvent('No repair steps available'));
+    /**
+     * Run a series of repair steps for common problems
+     */
+    public function run() {
+        if (count($this->repairSteps) === 0) {
+            $this->dispatcher->dispatchTyped(new RepairInfoEvent('No repair steps available'));
 
-			return;
-		}
-		// run each repair step
-		foreach ($this->repairSteps as $step) {
-			$this->currentStep = $step->getName();
-			$this->dispatcher->dispatchTyped(new RepairStepEvent($this->currentStep));
-			try {
-				$step->run($this);
-			} catch (\Exception $e) {
-				$this->logger->error('Exception while executing repair step ' . $step->getName(), ['exception' => $e]);
-				$this->dispatcher->dispatchTyped(new RepairErrorEvent($e->getMessage()));
-			}
-		}
+            return;
+        }
+        // run each repair step
+        foreach ($this->repairSteps as $step) {
+            $this->currentStep = $step->getName();
+            $this->dispatcher->dispatchTyped(new RepairStepEvent($this->currentStep));
+            try {
+                $step->run($this);
+            } catch (\Exception $e) {
+                $this->logger->error('Exception while executing repair step ' . $step->getName(), ['exception' => $e]);
+                $this->dispatcher->dispatchTyped(new RepairErrorEvent($e->getMessage()));
+            }
+        }
 
-		$this->repairSteps = [];
-	}
+        $this->repairSteps = [];
+    }
 
-	/**
-	 * Add repair step
-	 *
-	 * @param IRepairStep|string $repairStep repair step
-	 * @throws \Exception
-	 */
-	public function addStep($repairStep) {
-		if (is_string($repairStep)) {
-			try {
-				$s = \OC::$server->get($repairStep);
-			} catch (QueryException $e) {
-				if (class_exists($repairStep)) {
-					try {
-						// Last resort: hope there are no constructor arguments
-						$s = new $repairStep();
-					} catch (Throwable $inner) {
-						// Well, it was worth a try
-						throw new \Exception("Repair step '$repairStep' can't be instantiated: " . $e->getMessage(), 0, $e);
-					}
-				} else {
-					throw new \Exception("Repair step '$repairStep' is unknown", 0, $e);
-				}
-			}
+    /**
+     * Add repair step
+     *
+     * @param IRepairStep|string $repairStep repair step
+     * @throws \Exception
+     */
+    public function addStep($repairStep) {
+        if (is_string($repairStep)) {
+            try {
+                $s = \OC::$server->get($repairStep);
+            } catch (QueryException $e) {
+                if (class_exists($repairStep)) {
+                    try {
+                        // Last resort: hope there are no constructor arguments
+                        $s = new $repairStep();
+                    } catch (Throwable $inner) {
+                        // Well, it was worth a try
+                        throw new \Exception("Repair step '$repairStep' can't be instantiated: " . $e->getMessage(), 0, $e);
+                    }
+                } else {
+                    throw new \Exception("Repair step '$repairStep' is unknown", 0, $e);
+                }
+            }
 
-			if ($s instanceof IRepairStep) {
-				$this->repairSteps[] = $s;
-			} else {
-				throw new \Exception("Repair step '$repairStep' is not of type \\OCP\\Migration\\IRepairStep");
-			}
-		} else {
-			$this->repairSteps[] = $repairStep;
-		}
-	}
+            if ($s instanceof IRepairStep) {
+                $this->repairSteps[] = $s;
+            } else {
+                throw new \Exception("Repair step '$repairStep' is not of type \\OCP\\Migration\\IRepairStep");
+            }
+        } else {
+            $this->repairSteps[] = $repairStep;
+        }
+    }
 
-	/**
-	 * Returns the default repair steps to be run on the
-	 * command line or after an upgrade.
-	 *
-	 * @return IRepairStep[]
-	 */
-	public static function getRepairSteps(): array {
-		return [
-			new Collation(\OC::$server->getConfig(), \OC::$server->get(LoggerInterface::class), \OC::$server->getDatabaseConnection(), false),
-			new CleanTags(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager()),
-			new RepairInvalidShares(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()),
-			new MoveUpdaterStepFile(\OC::$server->getConfig()),
-			new MoveAvatars(
-				\OC::$server->getJobList(),
-				\OC::$server->getConfig()
-			),
-			new CleanPreviews(
-				\OC::$server->getJobList(),
-				\OC::$server->getUserManager(),
-				\OC::$server->getConfig()
-			),
-			\OCP\Server::get(MigratePropertiesTable::class),
-			\OC::$server->get(MigrateOauthTables::class),
-			new UpdateLanguageCodes(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
-			new AddLogRotateJob(\OC::$server->getJobList()),
-			new ClearFrontendCaches(\OC::$server->getMemCacheFactory(), \OCP\Server::get(JSCombiner::class)),
-			\OCP\Server::get(ClearGeneratedAvatarCache::class),
-			new AddPreviewBackgroundCleanupJob(\OC::$server->getJobList()),
-			new AddCleanupUpdaterBackupsJob(\OC::$server->getJobList()),
-			new CleanupCardDAVPhotoCache(\OC::$server->getConfig(), \OCP\Server::get(IAppDataFactory::class), \OC::$server->get(LoggerInterface::class)),
-			new AddClenupLoginFlowV2BackgroundJob(\OC::$server->getJobList()),
-			new RemoveLinkShares(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig(), \OC::$server->getGroupManager(), \OC::$server->get(INotificationManager::class), \OCP\Server::get(ITimeFactory::class)),
-			new ClearCollectionsAccessCache(\OC::$server->getConfig(), \OCP\Server::get(IManager::class)),
-			\OCP\Server::get(ResetGeneratedAvatarFlag::class),
-			\OCP\Server::get(EncryptionLegacyCipher::class),
-			\OCP\Server::get(EncryptionMigration::class),
-			\OCP\Server::get(ShippedDashboardEnable::class),
-			\OCP\Server::get(AddBruteForceCleanupJob::class),
-			\OCP\Server::get(AddCheckForUserCertificatesJob::class),
-			\OCP\Server::get(RepairDavShares::class),
-			\OCP\Server::get(LookupServerSendCheck::class),
-			\OCP\Server::get(AddTokenCleanupJob::class),
-			\OCP\Server::get(CleanUpAbandonedApps::class),
-			\OCP\Server::get(AddMissingSecretJob::class),
-			\OCP\Server::get(AddRemoveOldTasksBackgroundJob::class),
-			\OCP\Server::get(AddMetadataGenerationJob::class),
-			\OCP\Server::get(RepairLogoDimension::class),
-			\OCP\Server::get(RemoveLegacyDatadirFile::class),
-			\OCP\Server::get(AddCleanupDeletedUsersBackgroundJob::class),
-			\OCP\Server::get(SanitizeAccountProperties::class),
-			\OCP\Server::get(AddMovePreviewJob::class),
-			\OCP\Server::get(ConfigKeyMigration::class),
-		];
-	}
+    /**
+     * Returns the default repair steps to be run on the
+     * command line or after an upgrade.
+     *
+     * @return IRepairStep[]
+     */
+    public static function getRepairSteps(): array {
+        return [
+            new Collation(\OC::$server->getConfig(), \OC::$server->get(LoggerInterface::class), \OC::$server->getDatabaseConnection(), false),
+            new CleanTags(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager()),
+            new RepairInvalidShares(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()),
+            new MoveUpdaterStepFile(\OC::$server->getConfig()),
+            new MoveAvatars(
+                \OC::$server->getJobList(),
+                \OC::$server->getConfig()
+            ),
+            new CleanPreviews(
+                \OC::$server->getJobList(),
+                \OC::$server->getUserManager(),
+                \OC::$server->getConfig()
+            ),
+            \OCP\Server::get(MigratePropertiesTable::class),
+            \OC::$server->get(MigrateOauthTables::class),
+            new UpdateLanguageCodes(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
+            new AddLogRotateJob(\OC::$server->getJobList()),
+            new ClearFrontendCaches(\OC::$server->getMemCacheFactory(), \OCP\Server::get(JSCombiner::class)),
+            \OCP\Server::get(ClearGeneratedAvatarCache::class),
+            new AddPreviewBackgroundCleanupJob(\OC::$server->getJobList()),
+            new AddCleanupUpdaterBackupsJob(\OC::$server->getJobList()),
+            new CleanupCardDAVPhotoCache(\OC::$server->getConfig(), \OCP\Server::get(IAppDataFactory::class), \OC::$server->get(LoggerInterface::class)),
+            new AddClenupLoginFlowV2BackgroundJob(\OC::$server->getJobList()),
+            new RemoveLinkShares(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig(), \OC::$server->getGroupManager(), \OC::$server->get(INotificationManager::class), \OCP\Server::get(ITimeFactory::class)),
+            new ClearCollectionsAccessCache(\OC::$server->getConfig(), \OCP\Server::get(IManager::class)),
+            \OCP\Server::get(ResetGeneratedAvatarFlag::class),
+            \OCP\Server::get(EncryptionLegacyCipher::class),
+            \OCP\Server::get(EncryptionMigration::class),
+            \OCP\Server::get(ShippedDashboardEnable::class),
+            \OCP\Server::get(AddBruteForceCleanupJob::class),
+            \OCP\Server::get(AddCheckForUserCertificatesJob::class),
+            \OCP\Server::get(RepairDavShares::class),
+            \OCP\Server::get(LookupServerSendCheck::class),
+            \OCP\Server::get(AddTokenCleanupJob::class),
+            \OCP\Server::get(CleanUpAbandonedApps::class),
+            \OCP\Server::get(AddMissingSecretJob::class),
+            \OCP\Server::get(AddRemoveOldTasksBackgroundJob::class),
+            \OCP\Server::get(AddMetadataGenerationJob::class),
+            \OCP\Server::get(RepairLogoDimension::class),
+            \OCP\Server::get(RemoveLegacyDatadirFile::class),
+            \OCP\Server::get(AddCleanupDeletedUsersBackgroundJob::class),
+            \OCP\Server::get(SanitizeAccountProperties::class),
+            \OCP\Server::get(AddMovePreviewJob::class),
+            \OCP\Server::get(ConfigKeyMigration::class),
+        ];
+    }
 
-	/**
-	 * Returns expensive repair steps to be run on the
-	 * command line with a special option.
-	 *
-	 * @return IRepairStep[]
-	 */
-	public static function getExpensiveRepairSteps() {
-		return [
-			new OldGroupMembershipShares(\OC::$server->getDatabaseConnection(), \OC::$server->getGroupManager()),
-			new RemoveBrokenProperties(\OCP\Server::get(IDBConnection::class)),
-			new RepairMimeTypes(
-				\OCP\Server::get(IConfig::class),
-				\OCP\Server::get(IAppConfig::class),
-				\OCP\Server::get(IDBConnection::class)
-			),
-			\OCP\Server::get(DeleteSchedulingObjects::class),
-			\OC::$server->get(RemoveObjectProperties::class),
-		];
-	}
+    /**
+     * Returns expensive repair steps to be run on the
+     * command line with a special option.
+     *
+     * @return IRepairStep[]
+     */
+    public static function getExpensiveRepairSteps() {
+        return [
+            new OldGroupMembershipShares(\OC::$server->getDatabaseConnection(), \OC::$server->getGroupManager()),
+            new RemoveBrokenProperties(\OCP\Server::get(IDBConnection::class)),
+            new RepairMimeTypes(
+                \OCP\Server::get(IConfig::class),
+                \OCP\Server::get(IAppConfig::class),
+                \OCP\Server::get(IDBConnection::class)
+            ),
+            \OCP\Server::get(DeleteSchedulingObjects::class),
+            \OC::$server->get(RemoveObjectProperties::class),
+        ];
+    }
 
-	/**
-	 * Returns the repair steps to be run before an
-	 * upgrade.
-	 *
-	 * @return IRepairStep[]
-	 */
-	public static function getBeforeUpgradeRepairSteps() {
-		/** @var ConnectionAdapter $connectionAdapter */
-		$connectionAdapter = \OC::$server->get(ConnectionAdapter::class);
-		$config = \OC::$server->getConfig();
-		$steps = [
-			new Collation(\OC::$server->getConfig(), \OC::$server->get(LoggerInterface::class), $connectionAdapter, true),
-			new SaveAccountsTableData($connectionAdapter, $config),
-			new DropAccountTermsTable($connectionAdapter),
-		];
+    /**
+     * Returns the repair steps to be run before an
+     * upgrade.
+     *
+     * @return IRepairStep[]
+     */
+    public static function getBeforeUpgradeRepairSteps() {
+        /** @var ConnectionAdapter $connectionAdapter */
+        $connectionAdapter = \OC::$server->get(ConnectionAdapter::class);
+        $config = \OC::$server->getConfig();
+        $steps = [
+            new Collation(\OC::$server->getConfig(), \OC::$server->get(LoggerInterface::class), $connectionAdapter, true),
+            new SaveAccountsTableData($connectionAdapter, $config),
+            new DropAccountTermsTable($connectionAdapter),
+        ];
 
-		return $steps;
-	}
+        return $steps;
+    }
 
-	public function debug(string $message): void {
-	}
+    public function debug(string $message): void {
+    }
 
-	/**
-	 * @param string $message
-	 */
-	public function info($message) {
-		// for now just emit as we did in the past
-		$this->dispatcher->dispatchTyped(new RepairInfoEvent($message));
-	}
+    /**
+     * @param string $message
+     */
+    public function info($message) {
+        // for now just emit as we did in the past
+        $this->dispatcher->dispatchTyped(new RepairInfoEvent($message));
+    }
 
-	/**
-	 * @param string $message
-	 */
-	public function warning($message) {
-		// for now just emit as we did in the past
-		$this->dispatcher->dispatchTyped(new RepairWarningEvent($message));
-	}
+    /**
+     * @param string $message
+     */
+    public function warning($message) {
+        // for now just emit as we did in the past
+        $this->dispatcher->dispatchTyped(new RepairWarningEvent($message));
+    }
 
-	/**
-	 * @param int $max
-	 */
-	public function startProgress($max = 0) {
-		// for now just emit as we did in the past
-		$this->dispatcher->dispatchTyped(new RepairStartEvent($max, $this->currentStep));
-	}
+    /**
+     * @param int $max
+     */
+    public function startProgress($max = 0) {
+        // for now just emit as we did in the past
+        $this->dispatcher->dispatchTyped(new RepairStartEvent($max, $this->currentStep));
+    }
 
-	/**
-	 * @param int $step number of step to advance
-	 * @param string $description
-	 */
-	public function advance($step = 1, $description = '') {
-		// for now just emit as we did in the past
-		$this->dispatcher->dispatchTyped(new RepairAdvanceEvent($step, $description));
-	}
+    /**
+     * @param int $step number of step to advance
+     * @param string $description
+     */
+    public function advance($step = 1, $description = '') {
+        // for now just emit as we did in the past
+        $this->dispatcher->dispatchTyped(new RepairAdvanceEvent($step, $description));
+    }
 
-	/**
-	 * @param int $max
-	 */
-	public function finishProgress() {
-		// for now just emit as we did in the past
-		$this->dispatcher->dispatchTyped(new RepairFinishEvent());
-	}
+    /**
+     * @param int $max
+     */
+    public function finishProgress() {
+        // for now just emit as we did in the past
+        $this->dispatcher->dispatchTyped(new RepairFinishEvent());
+    }
 }

lib/private/Config/ConfigManager.php

Indentation +269 added lines, -269 removed lines

@@ -25,273 +25,273 @@
  * @since 32.0.0
  */
 class ConfigManager {
-	/** @var AppConfig|null $appConfig */
-	private ?IAppConfig $appConfig = null;
-	/** @var UserConfig|null $userConfig */
-	private ?IUserConfig $userConfig = null;
-
-	public function __construct(
-		private readonly LoggerInterface $logger,
-	) {
-	}
-
-	public function clearConfigCaches(): void {
-		$this->loadConfigServices();
-		$this->appConfig->clearCache();
-		$this->userConfig->clearCacheAll();
-	}
-
-
-	/**
-	 * Use the rename values from the list of ConfigLexiconEntry defined in each app ConfigLexicon
-	 * to migrate config value to a new config key.
-	 * Migration will only occur if new config key has no value in database.
-	 * The previous value from the key set in rename will be deleted from the database when migration
-	 * is over.
-	 *
-	 * This method should be mainly called during a new upgrade or when a new app is enabled.
-	 *
-	 * @param string|null $appId when set to NULL the method will be executed for all enabled apps of the instance
-	 *
-	 * @internal
-	 * @since 32.0.0
-	 * @see Entry
-	 */
-	public function migrateConfigLexiconKeys(?string $appId = null): void {
-		if ($appId === null) {
-			$this->migrateConfigLexiconKeys('core');
-			$appManager = Server::get(IAppManager::class);
-			foreach ($appManager->getEnabledApps() as $app) {
-				$this->migrateConfigLexiconKeys($app);
-			}
-
-			return;
-		}
-
-		$this->loadConfigServices();
-
-		// it is required to ignore aliases when moving config values
-		$this->appConfig->ignoreLexiconAliases(true);
-		$this->userConfig->ignoreLexiconAliases(true);
-
-		$this->migrateAppConfigKeys($appId);
-		$this->migrateUserConfigKeys($appId);
-
-		// switch back to normal behavior
-		$this->appConfig->ignoreLexiconAliases(false);
-		$this->userConfig->ignoreLexiconAliases(false);
-	}
-
-	/**
-	 * Upgrade stored data in case of changes in the lexicon.
-	 * Heavy process to be executed on core and app upgrade.
-	 */
-	public function updateLexiconEntries(string $appId): void {
-		$this->loadConfigServices();
-		$this->updateLexiconAppConfigEntries($appId);
-		$this->updateLexiconUserConfigEntries($appId);
-	}
-
-	/**
-	 * Apply modification on the lexicon to the stored app config values:
-	 *
-	 * - Upgrade AppConfig entries if set as lazy/not-lazy
-	 */
-	private function updateLexiconAppConfigEntries(string $appId): void {
-		$lexicon = $this->appConfig->getConfigDetailsFromLexicon($appId);
-		foreach ($lexicon['entries'] as $entry) {
-			// update laziness
-			$this->appConfig->updateLazy($appId, $entry->getKey(), $entry->isLazy());
-		}
-	}
-
-	/**
-	 * Apply modification on the lexicon to the stored user preferences values:
-	 *
-	 * - Upgrade UserConfig entries if set as indexed/not-indexed
-	 * - Upgrade UserConfig entries if set as lazy/not-lazy
-	 */
-	private function updateLexiconUserConfigEntries(string $appId): void {
-		$lexicon = $this->userConfig->getConfigDetailsFromLexicon($appId);
-		foreach ($lexicon['entries'] as $entry) {
-			// upgrade based on index flag
-			$this->userConfig->updateGlobalIndexed($appId, $entry->getKey(), $entry->isFlagged(IUserConfig::FLAG_INDEXED));
-			// update laziness
-			$this->userConfig->updateGlobalLazy($appId, $entry->getKey(), $entry->isLazy());
-		}
-	}
-
-	/**
-	 * config services cannot be load at __construct() or install will fail
-	 */
-	private function loadConfigServices(): void {
-		if ($this->appConfig === null) {
-			$this->appConfig = Server::get(IAppConfig::class);
-		}
-		if ($this->userConfig === null) {
-			$this->userConfig = Server::get(IUserConfig::class);
-		}
-	}
-
-	/**
-	 * Get details from lexicon related to AppConfig and search for entries with rename to initiate
-	 * a migration to new config key
-	 */
-	private function migrateAppConfigKeys(string $appId): void {
-		$lexicon = $this->appConfig->getConfigDetailsFromLexicon($appId);
-		foreach ($lexicon['entries'] as $entry) {
-			// only interested in entries with rename set
-			if ($entry->getRename() === null) {
-				continue;
-			}
-
-			// only migrate if rename config key has a value and the new config key hasn't
-			if ($this->appConfig->hasKey($appId, $entry->getRename())
-				&& !$this->appConfig->hasKey($appId, $entry->getKey())) {
-				try {
-					$this->migrateAppConfigValue($appId, $entry);
-				} catch (TypeConflictException $e) {
-					$this->logger->error('could not migrate AppConfig value', ['appId' => $appId, 'entry' => $entry, 'exception' => $e]);
-					continue;
-				}
-			}
-
-			// we only delete previous config value if migration went fine.
-			$this->appConfig->deleteKey($appId, $entry->getRename());
-		}
-	}
-
-	/**
-	 * Get details from lexicon related to UserConfig and search for entries with rename to initiate
-	 * a migration to new config key
-	 */
-	private function migrateUserConfigKeys(string $appId): void {
-		$lexicon = $this->userConfig->getConfigDetailsFromLexicon($appId);
-		foreach ($lexicon['entries'] as $entry) {
-			// only interested in keys with rename set
-			if ($entry->getRename() === null) {
-				continue;
-			}
-
-			foreach ($this->userConfig->getValuesByUsers($appId, $entry->getRename()) as $userId => $value) {
-				if ($this->userConfig->hasKey($userId, $appId, $entry->getKey())) {
-					continue;
-				}
-
-				try {
-					$this->migrateUserConfigValue($userId, $appId, $entry);
-				} catch (TypeConflictException $e) {
-					$this->logger->error('could not migrate UserConfig value', ['userId' => $userId, 'appId' => $appId, 'entry' => $entry, 'exception' => $e]);
-					continue;
-				}
-
-				$this->userConfig->deleteUserConfig($userId, $appId, $entry->getRename());
-			}
-		}
-	}
-
-
-	/**
-	 * converting value from rename to the new key
-	 *
-	 * @throws TypeConflictException if previous value does not fit the expected type
-	 */
-	private function migrateAppConfigValue(string $appId, Entry $entry): void {
-		$value = $this->appConfig->getValueMixed($appId, $entry->getRename(), lazy: null);
-		switch ($entry->getValueType()) {
-			case ValueType::STRING:
-				$this->appConfig->setValueString($appId, $entry->getKey(), $value);
-				return;
-
-			case ValueType::INT:
-				$this->appConfig->setValueInt($appId, $entry->getKey(), $this->convertToInt($value));
-				return;
-
-			case ValueType::FLOAT:
-				$this->appConfig->setValueFloat($appId, $entry->getKey(), $this->convertToFloat($value));
-				return;
-
-			case ValueType::BOOL:
-				$this->appConfig->setValueBool($appId, $entry->getKey(), $this->convertToBool($value, $entry));
-				return;
-
-			case ValueType::ARRAY:
-				$this->appConfig->setValueArray($appId, $entry->getKey(), $this->convertToArray($value));
-				return;
-		}
-	}
-
-	/**
-	 * converting value from rename to the new key
-	 *
-	 * @throws TypeConflictException if previous value does not fit the expected type
-	 */
-	private function migrateUserConfigValue(string $userId, string $appId, Entry $entry): void {
-		$value = $this->userConfig->getValueMixed($userId, $appId, $entry->getRename(), lazy: null);
-		switch ($entry->getValueType()) {
-			case ValueType::STRING:
-				$this->userConfig->setValueString($userId, $appId, $entry->getKey(), $value);
-				return;
-
-			case ValueType::INT:
-				$this->userConfig->setValueInt($userId, $appId, $entry->getKey(), $this->convertToInt($value));
-				return;
-
-			case ValueType::FLOAT:
-				$this->userConfig->setValueFloat($userId, $appId, $entry->getKey(), $this->convertToFloat($value));
-				return;
-
-			case ValueType::BOOL:
-				$this->userConfig->setValueBool($userId, $appId, $entry->getKey(), $this->convertToBool($value, $entry));
-				return;
-
-			case ValueType::ARRAY:
-				$this->userConfig->setValueArray($userId, $appId, $entry->getKey(), $this->convertToArray($value));
-				return;
-		}
-	}
-
-	public function convertToInt(string $value): int {
-		if (!is_numeric($value) || (float)$value <> (int)$value) {
-			throw new TypeConflictException('Value is not an integer');
-		}
-
-		return (int)$value;
-	}
-
-	public function convertToFloat(string $value): float {
-		if (!is_numeric($value)) {
-			throw new TypeConflictException('Value is not a float');
-		}
-
-		return (float)$value;
-	}
-
-	public function convertToBool(string $value, ?Entry $entry = null): bool {
-		if (in_array(strtolower($value), ['true', '1', 'on', 'yes'])) {
-			$valueBool = true;
-		} elseif (in_array(strtolower($value), ['false', '0', 'off', 'no'])) {
-			$valueBool = false;
-		} else {
-			throw new TypeConflictException('Value cannot be converted to boolean');
-		}
-		if ($entry?->hasOption(Entry::RENAME_INVERT_BOOLEAN) === true) {
-			$valueBool = !$valueBool;
-		}
-
-		return $valueBool;
-	}
-
-	public function convertToArray(string $value): array {
-		try {
-			$valueArray = json_decode($value, true, flags: JSON_THROW_ON_ERROR);
-		} catch (JsonException) {
-			throw new TypeConflictException('Value is not a valid json');
-		}
-		if (!is_array($valueArray)) {
-			throw new TypeConflictException('Value is not an array');
-		}
-
-		return $valueArray;
-	}
+    /** @var AppConfig|null $appConfig */
+    private ?IAppConfig $appConfig = null;
+    /** @var UserConfig|null $userConfig */
+    private ?IUserConfig $userConfig = null;
+
+    public function __construct(
+        private readonly LoggerInterface $logger,
+    ) {
+    }
+
+    public function clearConfigCaches(): void {
+        $this->loadConfigServices();
+        $this->appConfig->clearCache();
+        $this->userConfig->clearCacheAll();
+    }
+
+
+    /**
+     * Use the rename values from the list of ConfigLexiconEntry defined in each app ConfigLexicon
+     * to migrate config value to a new config key.
+     * Migration will only occur if new config key has no value in database.
+     * The previous value from the key set in rename will be deleted from the database when migration
+     * is over.
+     *
+     * This method should be mainly called during a new upgrade or when a new app is enabled.
+     *
+     * @param string|null $appId when set to NULL the method will be executed for all enabled apps of the instance
+     *
+     * @internal
+     * @since 32.0.0
+     * @see Entry
+     */
+    public function migrateConfigLexiconKeys(?string $appId = null): void {
+        if ($appId === null) {
+            $this->migrateConfigLexiconKeys('core');
+            $appManager = Server::get(IAppManager::class);
+            foreach ($appManager->getEnabledApps() as $app) {
+                $this->migrateConfigLexiconKeys($app);
+            }
+
+            return;
+        }
+
+        $this->loadConfigServices();
+
+        // it is required to ignore aliases when moving config values
+        $this->appConfig->ignoreLexiconAliases(true);
+        $this->userConfig->ignoreLexiconAliases(true);
+
+        $this->migrateAppConfigKeys($appId);
+        $this->migrateUserConfigKeys($appId);
+
+        // switch back to normal behavior
+        $this->appConfig->ignoreLexiconAliases(false);
+        $this->userConfig->ignoreLexiconAliases(false);
+    }
+
+    /**
+     * Upgrade stored data in case of changes in the lexicon.
+     * Heavy process to be executed on core and app upgrade.
+     */
+    public function updateLexiconEntries(string $appId): void {
+        $this->loadConfigServices();
+        $this->updateLexiconAppConfigEntries($appId);
+        $this->updateLexiconUserConfigEntries($appId);
+    }
+
+    /**
+     * Apply modification on the lexicon to the stored app config values:
+     *
+     * - Upgrade AppConfig entries if set as lazy/not-lazy
+     */
+    private function updateLexiconAppConfigEntries(string $appId): void {
+        $lexicon = $this->appConfig->getConfigDetailsFromLexicon($appId);
+        foreach ($lexicon['entries'] as $entry) {
+            // update laziness
+            $this->appConfig->updateLazy($appId, $entry->getKey(), $entry->isLazy());
+        }
+    }
+
+    /**
+     * Apply modification on the lexicon to the stored user preferences values:
+     *
+     * - Upgrade UserConfig entries if set as indexed/not-indexed
+     * - Upgrade UserConfig entries if set as lazy/not-lazy
+     */
+    private function updateLexiconUserConfigEntries(string $appId): void {
+        $lexicon = $this->userConfig->getConfigDetailsFromLexicon($appId);
+        foreach ($lexicon['entries'] as $entry) {
+            // upgrade based on index flag
+            $this->userConfig->updateGlobalIndexed($appId, $entry->getKey(), $entry->isFlagged(IUserConfig::FLAG_INDEXED));
+            // update laziness
+            $this->userConfig->updateGlobalLazy($appId, $entry->getKey(), $entry->isLazy());
+        }
+    }
+
+    /**
+     * config services cannot be load at __construct() or install will fail
+     */
+    private function loadConfigServices(): void {
+        if ($this->appConfig === null) {
+            $this->appConfig = Server::get(IAppConfig::class);
+        }
+        if ($this->userConfig === null) {
+            $this->userConfig = Server::get(IUserConfig::class);
+        }
+    }
+
+    /**
+     * Get details from lexicon related to AppConfig and search for entries with rename to initiate
+     * a migration to new config key
+     */
+    private function migrateAppConfigKeys(string $appId): void {
+        $lexicon = $this->appConfig->getConfigDetailsFromLexicon($appId);
+        foreach ($lexicon['entries'] as $entry) {
+            // only interested in entries with rename set
+            if ($entry->getRename() === null) {
+                continue;
+            }
+
+            // only migrate if rename config key has a value and the new config key hasn't
+            if ($this->appConfig->hasKey($appId, $entry->getRename())
+                && !$this->appConfig->hasKey($appId, $entry->getKey())) {
+                try {
+                    $this->migrateAppConfigValue($appId, $entry);
+                } catch (TypeConflictException $e) {
+                    $this->logger->error('could not migrate AppConfig value', ['appId' => $appId, 'entry' => $entry, 'exception' => $e]);
+                    continue;
+                }
+            }
+
+            // we only delete previous config value if migration went fine.
+            $this->appConfig->deleteKey($appId, $entry->getRename());
+        }
+    }
+
+    /**
+     * Get details from lexicon related to UserConfig and search for entries with rename to initiate
+     * a migration to new config key
+     */
+    private function migrateUserConfigKeys(string $appId): void {
+        $lexicon = $this->userConfig->getConfigDetailsFromLexicon($appId);
+        foreach ($lexicon['entries'] as $entry) {
+            // only interested in keys with rename set
+            if ($entry->getRename() === null) {
+                continue;
+            }
+
+            foreach ($this->userConfig->getValuesByUsers($appId, $entry->getRename()) as $userId => $value) {
+                if ($this->userConfig->hasKey($userId, $appId, $entry->getKey())) {
+                    continue;
+                }
+
+                try {
+                    $this->migrateUserConfigValue($userId, $appId, $entry);
+                } catch (TypeConflictException $e) {
+                    $this->logger->error('could not migrate UserConfig value', ['userId' => $userId, 'appId' => $appId, 'entry' => $entry, 'exception' => $e]);
+                    continue;
+                }
+
+                $this->userConfig->deleteUserConfig($userId, $appId, $entry->getRename());
+            }
+        }
+    }
+
+
+    /**
+     * converting value from rename to the new key
+     *
+     * @throws TypeConflictException if previous value does not fit the expected type
+     */
+    private function migrateAppConfigValue(string $appId, Entry $entry): void {
+        $value = $this->appConfig->getValueMixed($appId, $entry->getRename(), lazy: null);
+        switch ($entry->getValueType()) {
+            case ValueType::STRING:
+                $this->appConfig->setValueString($appId, $entry->getKey(), $value);
+                return;
+
+            case ValueType::INT:
+                $this->appConfig->setValueInt($appId, $entry->getKey(), $this->convertToInt($value));
+                return;
+
+            case ValueType::FLOAT:
+                $this->appConfig->setValueFloat($appId, $entry->getKey(), $this->convertToFloat($value));
+                return;
+
+            case ValueType::BOOL:
+                $this->appConfig->setValueBool($appId, $entry->getKey(), $this->convertToBool($value, $entry));
+                return;
+
+            case ValueType::ARRAY:
+                $this->appConfig->setValueArray($appId, $entry->getKey(), $this->convertToArray($value));
+                return;
+        }
+    }
+
+    /**
+     * converting value from rename to the new key
+     *
+     * @throws TypeConflictException if previous value does not fit the expected type
+     */
+    private function migrateUserConfigValue(string $userId, string $appId, Entry $entry): void {
+        $value = $this->userConfig->getValueMixed($userId, $appId, $entry->getRename(), lazy: null);
+        switch ($entry->getValueType()) {
+            case ValueType::STRING:
+                $this->userConfig->setValueString($userId, $appId, $entry->getKey(), $value);
+                return;
+
+            case ValueType::INT:
+                $this->userConfig->setValueInt($userId, $appId, $entry->getKey(), $this->convertToInt($value));
+                return;
+
+            case ValueType::FLOAT:
+                $this->userConfig->setValueFloat($userId, $appId, $entry->getKey(), $this->convertToFloat($value));
+                return;
+
+            case ValueType::BOOL:
+                $this->userConfig->setValueBool($userId, $appId, $entry->getKey(), $this->convertToBool($value, $entry));
+                return;
+
+            case ValueType::ARRAY:
+                $this->userConfig->setValueArray($userId, $appId, $entry->getKey(), $this->convertToArray($value));
+                return;
+        }
+    }
+
+    public function convertToInt(string $value): int {
+        if (!is_numeric($value) || (float)$value <> (int)$value) {
+            throw new TypeConflictException('Value is not an integer');
+        }
+
+        return (int)$value;
+    }
+
+    public function convertToFloat(string $value): float {
+        if (!is_numeric($value)) {
+            throw new TypeConflictException('Value is not a float');
+        }
+
+        return (float)$value;
+    }
+
+    public function convertToBool(string $value, ?Entry $entry = null): bool {
+        if (in_array(strtolower($value), ['true', '1', 'on', 'yes'])) {
+            $valueBool = true;
+        } elseif (in_array(strtolower($value), ['false', '0', 'off', 'no'])) {
+            $valueBool = false;
+        } else {
+            throw new TypeConflictException('Value cannot be converted to boolean');
+        }
+        if ($entry?->hasOption(Entry::RENAME_INVERT_BOOLEAN) === true) {
+            $valueBool = !$valueBool;
+        }
+
+        return $valueBool;
+    }
+
+    public function convertToArray(string $value): array {
+        try {
+            $valueArray = json_decode($value, true, flags: JSON_THROW_ON_ERROR);
+        } catch (JsonException) {
+            throw new TypeConflictException('Value is not a valid json');
+        }
+        if (!is_array($valueArray)) {
+            throw new TypeConflictException('Value is not an array');
+        }
+
+        return $valueArray;
+    }
 }

core/AppInfo/ConfigLexicon.php

Indentation +77 added lines, -77 removed lines

@@ -20,87 +20,87 @@
  * Please Add & Manage your Config Keys in that file and keep the Lexicon up to date!
  */
 class ConfigLexicon implements ILexicon {
-	public const SHAREAPI_ALLOW_FEDERATION_ON_PUBLIC_SHARES = 'shareapi_allow_federation_on_public_shares';
-	public const SHARE_CUSTOM_TOKEN = 'shareapi_allow_custom_tokens';
-	public const SHARE_LINK_PASSWORD_DEFAULT = 'shareapi_enable_link_password_by_default';
-	public const SHARE_LINK_PASSWORD_ENFORCED = 'shareapi_enforce_links_password';
-	public const SHARE_LINK_EXPIRE_DATE_DEFAULT = 'shareapi_default_expire_date';
-	public const SHARE_LINK_EXPIRE_DATE_ENFORCED = 'shareapi_enforce_expire_date';
-	public const USER_LANGUAGE = 'lang';
-	public const OCM_DISCOVERY_ENABLED = 'ocm_discovery_enabled';
-	public const OCM_INVITE_ACCEPT_DIALOG = 'ocm_invite_accept_dialog';
+    public const SHAREAPI_ALLOW_FEDERATION_ON_PUBLIC_SHARES = 'shareapi_allow_federation_on_public_shares';
+    public const SHARE_CUSTOM_TOKEN = 'shareapi_allow_custom_tokens';
+    public const SHARE_LINK_PASSWORD_DEFAULT = 'shareapi_enable_link_password_by_default';
+    public const SHARE_LINK_PASSWORD_ENFORCED = 'shareapi_enforce_links_password';
+    public const SHARE_LINK_EXPIRE_DATE_DEFAULT = 'shareapi_default_expire_date';
+    public const SHARE_LINK_EXPIRE_DATE_ENFORCED = 'shareapi_enforce_expire_date';
+    public const USER_LANGUAGE = 'lang';
+    public const OCM_DISCOVERY_ENABLED = 'ocm_discovery_enabled';
+    public const OCM_INVITE_ACCEPT_DIALOG = 'ocm_invite_accept_dialog';
 
-	public const USER_LOCALE = 'locale';
-	public const USER_TIMEZONE = 'timezone';
+    public const USER_LOCALE = 'locale';
+    public const USER_TIMEZONE = 'timezone';
 
-	public const UNIFIED_SEARCH_MIN_SEARCH_LENGTH = 'unified_search_min_search_length';
-	public const UNIFIED_SEARCH_MAX_RESULTS_PER_REQUEST = 'unified_search_max_results_per_request';
+    public const UNIFIED_SEARCH_MIN_SEARCH_LENGTH = 'unified_search_min_search_length';
+    public const UNIFIED_SEARCH_MAX_RESULTS_PER_REQUEST = 'unified_search_max_results_per_request';
 
-	public const LASTCRON_TIMESTAMP = 'lastcron';
+    public const LASTCRON_TIMESTAMP = 'lastcron';
 
-	public function getStrictness(): Strictness {
-		return Strictness::IGNORE;
-	}
+    public function getStrictness(): Strictness {
+        return Strictness::IGNORE;
+    }
 
-	public function getAppConfigs(): array {
-		return [
-			new Entry(
-				key: self::SHAREAPI_ALLOW_FEDERATION_ON_PUBLIC_SHARES,
-				type: ValueType::BOOL,
-				defaultRaw: true,
-				definition: 'adds share permission to public shares to allow adding them to your Nextcloud (federation)',
-			),
-			new Entry(
-				key: self::SHARE_CUSTOM_TOKEN,
-				type: ValueType::BOOL,
-				defaultRaw: fn (Preset $p): bool => match ($p) {
-					Preset::FAMILY, Preset::PRIVATE => true,
-					default => false,
-				},
-				definition: 'Allow users to customize share URL',
-				note: 'Shares with guessable tokens may be accessed easily. Shares with custom tokens will continue to be accessible after this setting has been disabled.',
-			),
-			new Entry(self::SHARE_LINK_PASSWORD_DEFAULT, ValueType::BOOL, false, 'Ask for a password when sharing document by default'),
-			new Entry(
-				key: self::SHARE_LINK_PASSWORD_ENFORCED,
-				type: ValueType::BOOL,
-				defaultRaw: fn (Preset $p): bool => match ($p) {
-					Preset::SCHOOL, Preset::UNIVERSITY, Preset::SHARED, Preset::SMALL, Preset::MEDIUM, Preset::LARGE => true,
-					default => false,
-				},
-				definition: 'Enforce password protection for shared documents'
-			),
-			new Entry(
-				key: self::SHARE_LINK_EXPIRE_DATE_DEFAULT,
-				type: ValueType::BOOL,
-				defaultRaw: fn (Preset $p): bool => match ($p) {
-					Preset::SHARED, Preset::SMALL, Preset::MEDIUM, Preset::LARGE => true,
-					default => false,
-				},
-				definition: 'Default expiration date for shares via link or mail'
-			),
-			new Entry(
-				key: self::SHARE_LINK_EXPIRE_DATE_ENFORCED,
-				type: ValueType::BOOL,
-				defaultRaw: fn (Preset $p): bool => match ($p) {
-					Preset::SHARED, Preset::SMALL, Preset::MEDIUM, Preset::LARGE => true,
-					default => false,
-				},
-				definition: 'Enforce expiration date for shares via link or mail'
-			),
-			new Entry(self::LASTCRON_TIMESTAMP, ValueType::INT, 0, 'timestamp of last cron execution'),
-			new Entry(self::OCM_DISCOVERY_ENABLED, ValueType::BOOL, true, 'enable/disable OCM'),
-			new Entry(self::OCM_INVITE_ACCEPT_DIALOG, ValueType::STRING, '', 'route to local invite accept dialog', note: 'set as empty string to disable feature'),
-			new Entry(self::UNIFIED_SEARCH_MIN_SEARCH_LENGTH, ValueType::INT, 1, 'Minimum search length to trigger the request', rename: 'unified-search.min-search-length'),
-			new Entry(self::UNIFIED_SEARCH_MAX_RESULTS_PER_REQUEST, ValueType::INT, 25, 'Maximum results returned per search request', rename: 'unified-search.max-results-per-request'),
-		];
-	}
+    public function getAppConfigs(): array {
+        return [
+            new Entry(
+                key: self::SHAREAPI_ALLOW_FEDERATION_ON_PUBLIC_SHARES,
+                type: ValueType::BOOL,
+                defaultRaw: true,
+                definition: 'adds share permission to public shares to allow adding them to your Nextcloud (federation)',
+            ),
+            new Entry(
+                key: self::SHARE_CUSTOM_TOKEN,
+                type: ValueType::BOOL,
+                defaultRaw: fn (Preset $p): bool => match ($p) {
+                    Preset::FAMILY, Preset::PRIVATE => true,
+                    default => false,
+                },
+                definition: 'Allow users to customize share URL',
+                note: 'Shares with guessable tokens may be accessed easily. Shares with custom tokens will continue to be accessible after this setting has been disabled.',
+            ),
+            new Entry(self::SHARE_LINK_PASSWORD_DEFAULT, ValueType::BOOL, false, 'Ask for a password when sharing document by default'),
+            new Entry(
+                key: self::SHARE_LINK_PASSWORD_ENFORCED,
+                type: ValueType::BOOL,
+                defaultRaw: fn (Preset $p): bool => match ($p) {
+                    Preset::SCHOOL, Preset::UNIVERSITY, Preset::SHARED, Preset::SMALL, Preset::MEDIUM, Preset::LARGE => true,
+                    default => false,
+                },
+                definition: 'Enforce password protection for shared documents'
+            ),
+            new Entry(
+                key: self::SHARE_LINK_EXPIRE_DATE_DEFAULT,
+                type: ValueType::BOOL,
+                defaultRaw: fn (Preset $p): bool => match ($p) {
+                    Preset::SHARED, Preset::SMALL, Preset::MEDIUM, Preset::LARGE => true,
+                    default => false,
+                },
+                definition: 'Default expiration date for shares via link or mail'
+            ),
+            new Entry(
+                key: self::SHARE_LINK_EXPIRE_DATE_ENFORCED,
+                type: ValueType::BOOL,
+                defaultRaw: fn (Preset $p): bool => match ($p) {
+                    Preset::SHARED, Preset::SMALL, Preset::MEDIUM, Preset::LARGE => true,
+                    default => false,
+                },
+                definition: 'Enforce expiration date for shares via link or mail'
+            ),
+            new Entry(self::LASTCRON_TIMESTAMP, ValueType::INT, 0, 'timestamp of last cron execution'),
+            new Entry(self::OCM_DISCOVERY_ENABLED, ValueType::BOOL, true, 'enable/disable OCM'),
+            new Entry(self::OCM_INVITE_ACCEPT_DIALOG, ValueType::STRING, '', 'route to local invite accept dialog', note: 'set as empty string to disable feature'),
+            new Entry(self::UNIFIED_SEARCH_MIN_SEARCH_LENGTH, ValueType::INT, 1, 'Minimum search length to trigger the request', rename: 'unified-search.min-search-length'),
+            new Entry(self::UNIFIED_SEARCH_MAX_RESULTS_PER_REQUEST, ValueType::INT, 25, 'Maximum results returned per search request', rename: 'unified-search.max-results-per-request'),
+        ];
+    }
 
-	public function getUserConfigs(): array {
-		return [
-			new Entry(self::USER_LANGUAGE, ValueType::STRING, definition: 'language'),
-			new Entry(self::USER_LOCALE, ValueType::STRING, definition: 'locale'),
-			new Entry(self::USER_TIMEZONE, ValueType::STRING, definition: 'timezone'),
-		];
-	}
+    public function getUserConfigs(): array {
+        return [
+            new Entry(self::USER_LANGUAGE, ValueType::STRING, definition: 'language'),
+            new Entry(self::USER_LOCALE, ValueType::STRING, definition: 'locale'),
+            new Entry(self::USER_TIMEZONE, ValueType::STRING, definition: 'timezone'),
+        ];
+    }
 }