nextcloud / server

lib/public/Migration/BigIntMigration.php

Indentation +34 added lines, -34 removed lines

@@ -14,38 +14,38 @@
  * @since 13.0.0
  */
 abstract class BigIntMigration extends SimpleMigrationStep {
-	/**
-	 * @return array Returns an array with the following structure
-	 *               ['table1' => ['column1', 'column2'], ...]
-	 * @since 13.0.0
-	 */
-	abstract protected function getColumnsByTable();
-
-	/**
-	 * @param IOutput $output
-	 * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
-	 * @param array $options
-	 * @return null|ISchemaWrapper
-	 * @since 13.0.0
-	 */
-	public function changeSchema(IOutput $output, \Closure $schemaClosure, array $options) {
-		/** @var ISchemaWrapper $schema */
-		$schema = $schemaClosure();
-
-		$tables = $this->getColumnsByTable();
-
-		foreach ($tables as $tableName => $columns) {
-			$table = $schema->getTable($tableName);
-
-			foreach ($columns as $columnName) {
-				$column = $table->getColumn($columnName);
-				if (Type::lookupName($column->getType()) !== Types::BIGINT) {
-					$column->setType(Type::getType(Types::BIGINT));
-					$column->setOptions(['length' => 20]);
-				}
-			}
-		}
-
-		return $schema;
-	}
+    /**
+     * @return array Returns an array with the following structure
+     *               ['table1' => ['column1', 'column2'], ...]
+     * @since 13.0.0
+     */
+    abstract protected function getColumnsByTable();
+
+    /**
+     * @param IOutput $output
+     * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
+     * @param array $options
+     * @return null|ISchemaWrapper
+     * @since 13.0.0
+     */
+    public function changeSchema(IOutput $output, \Closure $schemaClosure, array $options) {
+        /** @var ISchemaWrapper $schema */
+        $schema = $schemaClosure();
+
+        $tables = $this->getColumnsByTable();
+
+        foreach ($tables as $tableName => $columns) {
+            $table = $schema->getTable($tableName);
+
+            foreach ($columns as $columnName) {
+                $column = $table->getColumn($columnName);
+                if (Type::lookupName($column->getType()) !== Types::BIGINT) {
+                    $column->setType(Type::getType(Types::BIGINT));
+                    $column->setOptions(['length' => 20]);
+                }
+            }
+        }
+
+        return $schema;
+    }
 }

lib/private/DB/MigrationService.php

Indentation +713 added lines, -713 removed lines

@@ -27,717 +27,717 @@
 use Psr\Log\LoggerInterface;
 
 class MigrationService {
-	private bool $migrationTableCreated;
-	private array $migrations;
-	private string $migrationsPath;
-	private string $migrationsNamespace;
-	private IOutput $output;
-	private LoggerInterface $logger;
-	private Connection $connection;
-	private string $appName;
-	private bool $checkOracle;
-
-	/**
-	 * @throws \Exception
-	 */
-	public function __construct(
-		string $appName,
-		Connection $connection,
-		?IOutput $output = null,
-		?LoggerInterface $logger = null,
-	) {
-		$this->appName = $appName;
-		$this->connection = $connection;
-		if ($logger === null) {
-			$this->logger = Server::get(LoggerInterface::class);
-		} else {
-			$this->logger = $logger;
-		}
-		if ($output === null) {
-			$this->output = new SimpleOutput($this->logger, $appName);
-		} else {
-			$this->output = $output;
-		}
-
-		if ($appName === 'core') {
-			$this->migrationsPath = \OC::$SERVERROOT . '/core/Migrations';
-			$this->migrationsNamespace = 'OC\\Core\\Migrations';
-			$this->checkOracle = true;
-		} else {
-			$appManager = Server::get(IAppManager::class);
-			$appPath = $appManager->getAppPath($appName);
-			$namespace = App::buildAppNamespace($appName);
-			$this->migrationsPath = "$appPath/lib/Migration";
-			$this->migrationsNamespace = $namespace . '\\Migration';
-
-			$infoParser = new InfoParser();
-			$info = $infoParser->parse($appPath . '/appinfo/info.xml');
-			if (!isset($info['dependencies']['database'])) {
-				$this->checkOracle = true;
-			} else {
-				$this->checkOracle = false;
-				foreach ($info['dependencies']['database'] as $database) {
-					if (\is_string($database) && $database === 'oci') {
-						$this->checkOracle = true;
-					} elseif (\is_array($database) && isset($database['@value']) && $database['@value'] === 'oci') {
-						$this->checkOracle = true;
-					}
-				}
-			}
-		}
-		$this->migrationTableCreated = false;
-	}
-
-	/**
-	 * Returns the name of the app for which this migration is executed
-	 */
-	public function getApp(): string {
-		return $this->appName;
-	}
-
-	/**
-	 * @codeCoverageIgnore - this will implicitly tested on installation
-	 */
-	private function createMigrationTable(): bool {
-		if ($this->migrationTableCreated) {
-			return false;
-		}
-
-		if ($this->connection->tableExists('migrations') && \OC::$server->getConfig()->getAppValue('core', 'vendor', '') !== 'owncloud') {
-			$this->migrationTableCreated = true;
-			return false;
-		}
-
-		$schema = new SchemaWrapper($this->connection);
-
-		/**
-		 * We drop the table when it has different columns or the definition does not
-		 * match. E.g. ownCloud uses a length of 177 for app and 14 for version.
-		 */
-		try {
-			$table = $schema->getTable('migrations');
-			$columns = $table->getColumns();
-
-			if (count($columns) === 2) {
-				try {
-					$column = $table->getColumn('app');
-					$schemaMismatch = $column->getLength() !== 255;
-
-					if (!$schemaMismatch) {
-						$column = $table->getColumn('version');
-						$schemaMismatch = $column->getLength() !== 255;
-					}
-				} catch (SchemaException $e) {
-					// One of the columns is missing
-					$schemaMismatch = true;
-				}
-
-				if (!$schemaMismatch) {
-					// Table exists and schema matches: return back!
-					$this->migrationTableCreated = true;
-					return false;
-				}
-			}
-
-			// Drop the table, when it didn't match our expectations.
-			$this->connection->dropTable('migrations');
-
-			// Recreate the schema after the table was dropped.
-			$schema = new SchemaWrapper($this->connection);
-		} catch (SchemaException $e) {
-			// Table not found, no need to panic, we will create it.
-		}
-
-		$table = $schema->createTable('migrations');
-		$table->addColumn('app', Types::STRING, ['length' => 255]);
-		$table->addColumn('version', Types::STRING, ['length' => 255]);
-		$table->setPrimaryKey(['app', 'version']);
-
-		$this->connection->migrateToSchema($schema->getWrappedSchema());
-
-		$this->migrationTableCreated = true;
-
-		return true;
-	}
-
-	/**
-	 * Returns all versions which have already been applied
-	 *
-	 * @return list<string>
-	 * @codeCoverageIgnore - no need to test this
-	 */
-	public function getMigratedVersions() {
-		$this->createMigrationTable();
-		$qb = $this->connection->getQueryBuilder();
-
-		$qb->select('version')
-			->from('migrations')
-			->where($qb->expr()->eq('app', $qb->createNamedParameter($this->getApp())))
-			->orderBy('version');
-
-		$result = $qb->executeQuery();
-		$rows = $result->fetchAll(\PDO::FETCH_COLUMN);
-		$result->closeCursor();
-
-		usort($rows, $this->sortMigrations(...));
-
-		return $rows;
-	}
-
-	/**
-	 * Returns all versions which are available in the migration folder
-	 * @return list<string>
-	 */
-	public function getAvailableVersions(): array {
-		$this->ensureMigrationsAreLoaded();
-		$versions = array_map('strval', array_keys($this->migrations));
-		usort($versions, $this->sortMigrations(...));
-		return $versions;
-	}
-
-	protected function sortMigrations(string $a, string $b): int {
-		preg_match('/(\d+)Date(\d+)/', basename($a), $matchA);
-		preg_match('/(\d+)Date(\d+)/', basename($b), $matchB);
-		if (!empty($matchA) && !empty($matchB)) {
-			$versionA = (int)$matchA[1];
-			$versionB = (int)$matchB[1];
-			if ($versionA !== $versionB) {
-				return ($versionA < $versionB) ? -1 : 1;
-			}
-			return strnatcmp($matchA[2], $matchB[2]);
-		}
-		return strnatcmp(basename($a), basename($b));
-	}
-
-	/**
-	 * @return array<string, string>
-	 */
-	protected function findMigrations(): array {
-		$directory = realpath($this->migrationsPath);
-		if ($directory === false || !file_exists($directory) || !is_dir($directory)) {
-			return [];
-		}
-
-		$iterator = new \RegexIterator(
-			new \RecursiveIteratorIterator(
-				new \RecursiveDirectoryIterator($directory, \FilesystemIterator::SKIP_DOTS),
-				\RecursiveIteratorIterator::LEAVES_ONLY
-			),
-			'#^.+\\/Version[^\\/]{1,255}\\.php$#i',
-			\RegexIterator::GET_MATCH);
-
-		$files = array_keys(iterator_to_array($iterator));
-		usort($files, $this->sortMigrations(...));
-
-		$migrations = [];
-
-		foreach ($files as $file) {
-			$className = basename($file, '.php');
-			$version = (string)substr($className, 7);
-			if ($version === '0') {
-				throw new \InvalidArgumentException(
-					"Cannot load a migrations with the name '$version' because it is a reserved number"
-				);
-			}
-			$migrations[$version] = sprintf('%s\\%s', $this->migrationsNamespace, $className);
-		}
-
-		return $migrations;
-	}
-
-	/**
-	 * @param string $to
-	 * @return string[]
-	 */
-	private function getMigrationsToExecute($to) {
-		$knownMigrations = $this->getMigratedVersions();
-		$availableMigrations = $this->getAvailableVersions();
-
-		$toBeExecuted = [];
-		foreach ($availableMigrations as $v) {
-			if ($to !== 'latest' && ($this->sortMigrations($v, $to) > 0)) {
-				continue;
-			}
-			if ($this->shallBeExecuted($v, $knownMigrations)) {
-				$toBeExecuted[] = $v;
-			}
-		}
-
-		return $toBeExecuted;
-	}
-
-	/**
-	 * @param string $m
-	 * @param string[] $knownMigrations
-	 * @return bool
-	 */
-	private function shallBeExecuted($m, $knownMigrations) {
-		if (in_array($m, $knownMigrations)) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * @param string $version
-	 */
-	private function markAsExecuted($version) {
-		$this->connection->insertIfNotExist('*PREFIX*migrations', [
-			'app' => $this->appName,
-			'version' => $version
-		]);
-	}
-
-	/**
-	 * Returns the name of the table which holds the already applied versions
-	 *
-	 * @return string
-	 */
-	public function getMigrationsTableName() {
-		return $this->connection->getPrefix() . 'migrations';
-	}
-
-	/**
-	 * Returns the namespace of the version classes
-	 *
-	 * @return string
-	 */
-	public function getMigrationsNamespace() {
-		return $this->migrationsNamespace;
-	}
-
-	/**
-	 * Returns the directory which holds the versions
-	 *
-	 * @return string
-	 */
-	public function getMigrationsDirectory() {
-		return $this->migrationsPath;
-	}
-
-	/**
-	 * Return the explicit version for the aliases; current, next, prev, latest
-	 *
-	 * @return mixed|null|string
-	 */
-	public function getMigration(string $alias) {
-		switch ($alias) {
-			case 'current':
-				return $this->getCurrentVersion();
-			case 'next':
-				return $this->getRelativeVersion($this->getCurrentVersion(), 1);
-			case 'prev':
-				return $this->getRelativeVersion($this->getCurrentVersion(), -1);
-			case 'latest':
-				$this->ensureMigrationsAreLoaded();
-
-				$migrations = $this->getAvailableVersions();
-				return @end($migrations);
-		}
-		return '0';
-	}
-
-	private function getRelativeVersion(string $version, int $delta): ?string {
-		$this->ensureMigrationsAreLoaded();
-
-		$versions = $this->getAvailableVersions();
-		array_unshift($versions, '0');
-		/** @var int $offset */
-		$offset = array_search($version, $versions, true);
-		if ($offset === false || !isset($versions[$offset + $delta])) {
-			// Unknown version or delta out of bounds.
-			return null;
-		}
-
-		return (string)$versions[$offset + $delta];
-	}
-
-	private function getCurrentVersion(): string {
-		$m = $this->getMigratedVersions();
-		if (count($m) === 0) {
-			return '0';
-		}
-		$migrations = array_values($m);
-		return @end($migrations);
-	}
-
-	/**
-	 * @throws \InvalidArgumentException
-	 */
-	private function getClass(string $version): string {
-		$this->ensureMigrationsAreLoaded();
-
-		if (isset($this->migrations[$version])) {
-			return $this->migrations[$version];
-		}
-
-		throw new \InvalidArgumentException("Version $version is unknown.");
-	}
-
-	/**
-	 * Allows to set an IOutput implementation which is used for logging progress and messages
-	 */
-	public function setOutput(IOutput $output): void {
-		$this->output = $output;
-	}
-
-	/**
-	 * Applies all not yet applied versions up to $to
-	 * @throws \InvalidArgumentException
-	 */
-	public function migrate(string $to = 'latest', bool $schemaOnly = false): void {
-		if ($schemaOnly) {
-			$this->output->debug('Migrating schema only');
-			$this->migrateSchemaOnly($to);
-			return;
-		}
-
-		// read known migrations
-		$toBeExecuted = $this->getMigrationsToExecute($to);
-		foreach ($toBeExecuted as $version) {
-			try {
-				$this->executeStep($version, $schemaOnly);
-			} catch (\Exception $e) {
-				// The exception itself does not contain the name of the migration,
-				// so we wrap it here, to make debugging easier.
-				throw new \Exception('Database error when running migration ' . $version . ' for app ' . $this->getApp() . PHP_EOL . $e->getMessage(), 0, $e);
-			}
-		}
-	}
-
-	/**
-	 * Applies all not yet applied versions up to $to
-	 * @throws \InvalidArgumentException
-	 */
-	public function migrateSchemaOnly(string $to = 'latest'): void {
-		// read known migrations
-		$toBeExecuted = $this->getMigrationsToExecute($to);
-
-		if (empty($toBeExecuted)) {
-			return;
-		}
-
-		$toSchema = null;
-		foreach ($toBeExecuted as $version) {
-			$this->output->debug('- Reading ' . $version);
-			$instance = $this->createInstance($version);
-
-			$toSchema = $instance->changeSchema($this->output, function () use ($toSchema): ISchemaWrapper {
-				return $toSchema ?: new SchemaWrapper($this->connection);
-			}, ['tablePrefix' => $this->connection->getPrefix()]) ?: $toSchema;
-		}
-
-		if ($toSchema instanceof SchemaWrapper) {
-			$this->output->debug('- Checking target database schema');
-			$targetSchema = $toSchema->getWrappedSchema();
-			$this->ensureUniqueNamesConstraints($targetSchema, true);
-			if ($this->checkOracle) {
-				$beforeSchema = $this->connection->createSchema();
-				$this->ensureOracleConstraints($beforeSchema, $targetSchema, strlen($this->connection->getPrefix()));
-			}
-
-			$this->output->debug('- Migrate database schema');
-			$this->connection->migrateToSchema($targetSchema);
-			$toSchema->performDropTableCalls();
-		}
-
-		$this->output->debug('- Mark migrations as executed');
-		foreach ($toBeExecuted as $version) {
-			$this->markAsExecuted($version);
-		}
-	}
-
-	/**
-	 * Get the human readable descriptions for the migration steps to run
-	 *
-	 * @param string $to
-	 * @return string[] [$name => $description]
-	 */
-	public function describeMigrationStep($to = 'latest') {
-		$toBeExecuted = $this->getMigrationsToExecute($to);
-		$description = [];
-		foreach ($toBeExecuted as $version) {
-			$migration = $this->createInstance($version);
-			if ($migration->name()) {
-				$description[$migration->name()] = $migration->description();
-			}
-		}
-		return $description;
-	}
-
-	/**
-	 * @param string $version
-	 * @return IMigrationStep
-	 * @throws \InvalidArgumentException
-	 */
-	public function createInstance($version) {
-		$class = $this->getClass($version);
-		try {
-			$s = \OCP\Server::get($class);
-
-			if (!$s instanceof IMigrationStep) {
-				throw new \InvalidArgumentException('Not a valid migration');
-			}
-		} catch (QueryException $e) {
-			if (class_exists($class)) {
-				$s = new $class();
-			} else {
-				throw new \InvalidArgumentException("Migration step '$class' is unknown");
-			}
-		}
-
-		return $s;
-	}
-
-	/**
-	 * Executes one explicit version
-	 *
-	 * @param string $version
-	 * @param bool $schemaOnly
-	 * @throws \InvalidArgumentException
-	 */
-	public function executeStep($version, $schemaOnly = false) {
-		$instance = $this->createInstance($version);
-
-		if (!$schemaOnly) {
-			$instance->preSchemaChange($this->output, function (): ISchemaWrapper {
-				return new SchemaWrapper($this->connection);
-			}, ['tablePrefix' => $this->connection->getPrefix()]);
-		}
-
-		$toSchema = $instance->changeSchema($this->output, function (): ISchemaWrapper {
-			return new SchemaWrapper($this->connection);
-		}, ['tablePrefix' => $this->connection->getPrefix()]);
-
-		if ($toSchema instanceof SchemaWrapper) {
-			$targetSchema = $toSchema->getWrappedSchema();
-			$this->ensureUniqueNamesConstraints($targetSchema, $schemaOnly);
-			if ($this->checkOracle) {
-				$sourceSchema = $this->connection->createSchema();
-				$this->ensureOracleConstraints($sourceSchema, $targetSchema, strlen($this->connection->getPrefix()));
-			}
-			$this->connection->migrateToSchema($targetSchema);
-			$toSchema->performDropTableCalls();
-		}
-
-		if (!$schemaOnly) {
-			$instance->postSchemaChange($this->output, function (): ISchemaWrapper {
-				return new SchemaWrapper($this->connection);
-			}, ['tablePrefix' => $this->connection->getPrefix()]);
-		}
-
-		$this->markAsExecuted($version);
-	}
-
-	/**
-	 * Naming constraints:
-	 * - Tables names must be 30 chars or shorter (27 + oc_ prefix)
-	 * - Column names must be 30 chars or shorter
-	 * - Index names must be 30 chars or shorter
-	 * - Sequence names must be 30 chars or shorter
-	 * - Primary key names must be set or the table name 23 chars or shorter
-	 *
-	 * Data constraints:
-	 * - Tables need a primary key (Not specific to Oracle, but required for performant clustering support)
-	 * - Columns with "NotNull" can not have empty string as default value
-	 * - Columns with "NotNull" can not have number 0 as default value
-	 * - Columns with type "bool" (which is in fact integer of length 1) can not be "NotNull" as it can not store 0/false
-	 * - Columns with type "string" can not be longer than 4.000 characters, use "text" instead
-	 *
-	 * @see https://github.com/nextcloud/documentation/blob/master/developer_manual/basics/storage/database.rst
-	 *
-	 * @param Schema $sourceSchema
-	 * @param Schema $targetSchema
-	 * @param int $prefixLength
-	 * @throws \Doctrine\DBAL\Exception
-	 */
-	public function ensureOracleConstraints(Schema $sourceSchema, Schema $targetSchema, int $prefixLength) {
-		$sequences = $targetSchema->getSequences();
-
-		foreach ($targetSchema->getTables() as $table) {
-			try {
-				$sourceTable = $sourceSchema->getTable($table->getName());
-			} catch (SchemaException $e) {
-				if (\strlen($table->getName()) - $prefixLength > 27) {
-					throw new \InvalidArgumentException('Table name "' . $table->getName() . '" is too long.');
-				}
-				$sourceTable = null;
-			}
-
-			foreach ($table->getColumns() as $thing) {
-				// If the table doesn't exist OR if the column doesn't exist in the table
-				if (!$sourceTable instanceof Table || !$sourceTable->hasColumn($thing->getName())) {
-					if (\strlen($thing->getName()) > 30) {
-						throw new \InvalidArgumentException('Column name "' . $table->getName() . '"."' . $thing->getName() . '" is too long.');
-					}
-
-					if ($thing->getNotnull() && $thing->getDefault() === ''
-						&& $sourceTable instanceof Table && !$sourceTable->hasColumn($thing->getName())) {
-						throw new \InvalidArgumentException('Column "' . $table->getName() . '"."' . $thing->getName() . '" is NotNull, but has empty string or null as default.');
-					}
-
-					if ($this->connection->getDatabaseProvider() === IDBConnection::PLATFORM_ORACLE) {
-						// Oracle doesn't support boolean column with non-null value
-						if ($thing->getNotnull() && Type::lookupName($thing->getType()) === Types::BOOLEAN) {
-							$thing->setNotnull(false);
-						}
-					}
-
-					$sourceColumn = null;
-				} else {
-					$sourceColumn = $sourceTable->getColumn($thing->getName());
-				}
-
-				// If the column was just created OR the length changed OR the type changed
-				// we will NOT detect invalid length if the column is not modified
-				if (($sourceColumn === null || $sourceColumn->getLength() !== $thing->getLength() || Type::lookupName($sourceColumn->getType()) !== Types::STRING)
-					&& $thing->getLength() > 4000 && Type::lookupName($thing->getType()) === Types::STRING) {
-					throw new \InvalidArgumentException('Column "' . $table->getName() . '"."' . $thing->getName() . '" is type String, but exceeding the 4.000 length limit.');
-				}
-			}
-
-			foreach ($table->getIndexes() as $thing) {
-				if ((!$sourceTable instanceof Table || !$sourceTable->hasIndex($thing->getName())) && \strlen($thing->getName()) > 30) {
-					throw new \InvalidArgumentException('Index name "' . $table->getName() . '"."' . $thing->getName() . '" is too long.');
-				}
-			}
-
-			foreach ($table->getForeignKeys() as $thing) {
-				if ((!$sourceTable instanceof Table || !$sourceTable->hasForeignKey($thing->getName())) && \strlen($thing->getName()) > 30) {
-					throw new \InvalidArgumentException('Foreign key name "' . $table->getName() . '"."' . $thing->getName() . '" is too long.');
-				}
-			}
-
-			$primaryKey = $table->getPrimaryKey();
-			if ($primaryKey instanceof Index && (!$sourceTable instanceof Table || $sourceTable->getPrimaryKey() === null)) {
-				$indexName = strtolower($primaryKey->getName());
-				$isUsingDefaultName = $indexName === 'primary';
-
-				if ($this->connection->getDatabaseProvider() === IDBConnection::PLATFORM_POSTGRES) {
-					$defaultName = $table->getName() . '_pkey';
-					$isUsingDefaultName = strtolower($defaultName) === $indexName;
-
-					if ($isUsingDefaultName) {
-						$sequenceName = $table->getName() . '_' . implode('_', $primaryKey->getColumns()) . '_seq';
-						$sequences = array_filter($sequences, function (Sequence $sequence) use ($sequenceName) {
-							return $sequence->getName() !== $sequenceName;
-						});
-					}
-				} elseif ($this->connection->getDatabaseProvider() === IDBConnection::PLATFORM_ORACLE) {
-					$defaultName = $table->getName() . '_seq';
-					$isUsingDefaultName = strtolower($defaultName) === $indexName;
-				}
-
-				if (!$isUsingDefaultName && \strlen($indexName) > 30) {
-					throw new \InvalidArgumentException('Primary index name on "' . $table->getName() . '" is too long.');
-				}
-				if ($isUsingDefaultName && \strlen($table->getName()) - $prefixLength >= 23) {
-					throw new \InvalidArgumentException('Primary index name on "' . $table->getName() . '" is too long.');
-				}
-			} elseif (!$primaryKey instanceof Index && !$sourceTable instanceof Table) {
-				/** @var LoggerInterface $logger */
-				$logger = \OC::$server->get(LoggerInterface::class);
-				$logger->error('Table "' . $table->getName() . '" has no primary key and therefor will not behave sane in clustered setups. This will throw an exception and not be installable in a future version of Nextcloud.');
-				// throw new \InvalidArgumentException('Table "' . $table->getName() . '" has no primary key and therefor will not behave sane in clustered setups.');
-			}
-		}
-
-		foreach ($sequences as $sequence) {
-			if (!$sourceSchema->hasSequence($sequence->getName()) && \strlen($sequence->getName()) > 30) {
-				throw new \InvalidArgumentException('Sequence name "' . $sequence->getName() . '" is too long.');
-			}
-		}
-	}
-
-	/**
-	 * Ensure naming constraints
-	 *
-	 * Naming constraints:
-	 * - Index, sequence and primary key names must be unique within a Postgres Schema
-	 *
-	 * Only on installation we want to break hard, so that all developers notice
-	 * the bugs when installing the app on any database or CI, and can work on
-	 * fixing their migrations before releasing a version incompatible with Postgres.
-	 *
-	 * In case of updates we might be running on production instances and the
-	 * administrators being faced with the error would not know how to resolve it
-	 * anyway. This can also happen with instances, that had the issue before the
-	 * current update, so we don't want to make their life more complicated
-	 * than needed.
-	 *
-	 * @param Schema $targetSchema
-	 * @param bool $isInstalling
-	 */
-	public function ensureUniqueNamesConstraints(Schema $targetSchema, bool $isInstalling): void {
-		$constraintNames = [];
-		$sequences = $targetSchema->getSequences();
-
-		foreach ($targetSchema->getTables() as $table) {
-			foreach ($table->getIndexes() as $thing) {
-				$indexName = strtolower($thing->getName());
-				if ($indexName === 'primary' || $thing->isPrimary()) {
-					continue;
-				}
-
-				if (isset($constraintNames[$thing->getName()])) {
-					if ($isInstalling) {
-						throw new \InvalidArgumentException('Index name "' . $thing->getName() . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
-					}
-					$this->logErrorOrWarning('Index name "' . $thing->getName() . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
-				}
-				$constraintNames[$thing->getName()] = $table->getName();
-			}
-
-			foreach ($table->getForeignKeys() as $thing) {
-				if (isset($constraintNames[$thing->getName()])) {
-					if ($isInstalling) {
-						throw new \InvalidArgumentException('Foreign key name "' . $thing->getName() . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
-					}
-					$this->logErrorOrWarning('Foreign key name "' . $thing->getName() . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
-				}
-				$constraintNames[$thing->getName()] = $table->getName();
-			}
-
-			$primaryKey = $table->getPrimaryKey();
-			if ($primaryKey instanceof Index) {
-				$indexName = strtolower($primaryKey->getName());
-				if ($indexName === 'primary') {
-					continue;
-				}
-
-				if (isset($constraintNames[$indexName])) {
-					if ($isInstalling) {
-						throw new \InvalidArgumentException('Primary index name "' . $indexName . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
-					}
-					$this->logErrorOrWarning('Primary index name "' . $indexName . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
-				}
-				$constraintNames[$indexName] = $table->getName();
-			}
-		}
-
-		foreach ($sequences as $sequence) {
-			if (isset($constraintNames[$sequence->getName()])) {
-				if ($isInstalling) {
-					throw new \InvalidArgumentException('Sequence name "' . $sequence->getName() . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
-				}
-				$this->logErrorOrWarning('Sequence name "' . $sequence->getName() . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
-			}
-			$constraintNames[$sequence->getName()] = 'sequence';
-		}
-	}
-
-	protected function logErrorOrWarning(string $log): void {
-		if ($this->output instanceof SimpleOutput) {
-			$this->output->warning($log);
-		} else {
-			$this->logger->error($log);
-		}
-	}
-
-	private function ensureMigrationsAreLoaded(): void {
-		if (empty($this->migrations)) {
-			$this->migrations = $this->findMigrations();
-		}
-	}
+    private bool $migrationTableCreated;
+    private array $migrations;
+    private string $migrationsPath;
+    private string $migrationsNamespace;
+    private IOutput $output;
+    private LoggerInterface $logger;
+    private Connection $connection;
+    private string $appName;
+    private bool $checkOracle;
+
+    /**
+     * @throws \Exception
+     */
+    public function __construct(
+        string $appName,
+        Connection $connection,
+        ?IOutput $output = null,
+        ?LoggerInterface $logger = null,
+    ) {
+        $this->appName = $appName;
+        $this->connection = $connection;
+        if ($logger === null) {
+            $this->logger = Server::get(LoggerInterface::class);
+        } else {
+            $this->logger = $logger;
+        }
+        if ($output === null) {
+            $this->output = new SimpleOutput($this->logger, $appName);
+        } else {
+            $this->output = $output;
+        }
+
+        if ($appName === 'core') {
+            $this->migrationsPath = \OC::$SERVERROOT . '/core/Migrations';
+            $this->migrationsNamespace = 'OC\\Core\\Migrations';
+            $this->checkOracle = true;
+        } else {
+            $appManager = Server::get(IAppManager::class);
+            $appPath = $appManager->getAppPath($appName);
+            $namespace = App::buildAppNamespace($appName);
+            $this->migrationsPath = "$appPath/lib/Migration";
+            $this->migrationsNamespace = $namespace . '\\Migration';
+
+            $infoParser = new InfoParser();
+            $info = $infoParser->parse($appPath . '/appinfo/info.xml');
+            if (!isset($info['dependencies']['database'])) {
+                $this->checkOracle = true;
+            } else {
+                $this->checkOracle = false;
+                foreach ($info['dependencies']['database'] as $database) {
+                    if (\is_string($database) && $database === 'oci') {
+                        $this->checkOracle = true;
+                    } elseif (\is_array($database) && isset($database['@value']) && $database['@value'] === 'oci') {
+                        $this->checkOracle = true;
+                    }
+                }
+            }
+        }
+        $this->migrationTableCreated = false;
+    }
+
+    /**
+     * Returns the name of the app for which this migration is executed
+     */
+    public function getApp(): string {
+        return $this->appName;
+    }
+
+    /**
+     * @codeCoverageIgnore - this will implicitly tested on installation
+     */
+    private function createMigrationTable(): bool {
+        if ($this->migrationTableCreated) {
+            return false;
+        }
+
+        if ($this->connection->tableExists('migrations') && \OC::$server->getConfig()->getAppValue('core', 'vendor', '') !== 'owncloud') {
+            $this->migrationTableCreated = true;
+            return false;
+        }
+
+        $schema = new SchemaWrapper($this->connection);
+
+        /**
+         * We drop the table when it has different columns or the definition does not
+         * match. E.g. ownCloud uses a length of 177 for app and 14 for version.
+         */
+        try {
+            $table = $schema->getTable('migrations');
+            $columns = $table->getColumns();
+
+            if (count($columns) === 2) {
+                try {
+                    $column = $table->getColumn('app');
+                    $schemaMismatch = $column->getLength() !== 255;
+
+                    if (!$schemaMismatch) {
+                        $column = $table->getColumn('version');
+                        $schemaMismatch = $column->getLength() !== 255;
+                    }
+                } catch (SchemaException $e) {
+                    // One of the columns is missing
+                    $schemaMismatch = true;
+                }
+
+                if (!$schemaMismatch) {
+                    // Table exists and schema matches: return back!
+                    $this->migrationTableCreated = true;
+                    return false;
+                }
+            }
+
+            // Drop the table, when it didn't match our expectations.
+            $this->connection->dropTable('migrations');
+
+            // Recreate the schema after the table was dropped.
+            $schema = new SchemaWrapper($this->connection);
+        } catch (SchemaException $e) {
+            // Table not found, no need to panic, we will create it.
+        }
+
+        $table = $schema->createTable('migrations');
+        $table->addColumn('app', Types::STRING, ['length' => 255]);
+        $table->addColumn('version', Types::STRING, ['length' => 255]);
+        $table->setPrimaryKey(['app', 'version']);
+
+        $this->connection->migrateToSchema($schema->getWrappedSchema());
+
+        $this->migrationTableCreated = true;
+
+        return true;
+    }
+
+    /**
+     * Returns all versions which have already been applied
+     *
+     * @return list<string>
+     * @codeCoverageIgnore - no need to test this
+     */
+    public function getMigratedVersions() {
+        $this->createMigrationTable();
+        $qb = $this->connection->getQueryBuilder();
+
+        $qb->select('version')
+            ->from('migrations')
+            ->where($qb->expr()->eq('app', $qb->createNamedParameter($this->getApp())))
+            ->orderBy('version');
+
+        $result = $qb->executeQuery();
+        $rows = $result->fetchAll(\PDO::FETCH_COLUMN);
+        $result->closeCursor();
+
+        usort($rows, $this->sortMigrations(...));
+
+        return $rows;
+    }
+
+    /**
+     * Returns all versions which are available in the migration folder
+     * @return list<string>
+     */
+    public function getAvailableVersions(): array {
+        $this->ensureMigrationsAreLoaded();
+        $versions = array_map('strval', array_keys($this->migrations));
+        usort($versions, $this->sortMigrations(...));
+        return $versions;
+    }
+
+    protected function sortMigrations(string $a, string $b): int {
+        preg_match('/(\d+)Date(\d+)/', basename($a), $matchA);
+        preg_match('/(\d+)Date(\d+)/', basename($b), $matchB);
+        if (!empty($matchA) && !empty($matchB)) {
+            $versionA = (int)$matchA[1];
+            $versionB = (int)$matchB[1];
+            if ($versionA !== $versionB) {
+                return ($versionA < $versionB) ? -1 : 1;
+            }
+            return strnatcmp($matchA[2], $matchB[2]);
+        }
+        return strnatcmp(basename($a), basename($b));
+    }
+
+    /**
+     * @return array<string, string>
+     */
+    protected function findMigrations(): array {
+        $directory = realpath($this->migrationsPath);
+        if ($directory === false || !file_exists($directory) || !is_dir($directory)) {
+            return [];
+        }
+
+        $iterator = new \RegexIterator(
+            new \RecursiveIteratorIterator(
+                new \RecursiveDirectoryIterator($directory, \FilesystemIterator::SKIP_DOTS),
+                \RecursiveIteratorIterator::LEAVES_ONLY
+            ),
+            '#^.+\\/Version[^\\/]{1,255}\\.php$#i',
+            \RegexIterator::GET_MATCH);
+
+        $files = array_keys(iterator_to_array($iterator));
+        usort($files, $this->sortMigrations(...));
+
+        $migrations = [];
+
+        foreach ($files as $file) {
+            $className = basename($file, '.php');
+            $version = (string)substr($className, 7);
+            if ($version === '0') {
+                throw new \InvalidArgumentException(
+                    "Cannot load a migrations with the name '$version' because it is a reserved number"
+                );
+            }
+            $migrations[$version] = sprintf('%s\\%s', $this->migrationsNamespace, $className);
+        }
+
+        return $migrations;
+    }
+
+    /**
+     * @param string $to
+     * @return string[]
+     */
+    private function getMigrationsToExecute($to) {
+        $knownMigrations = $this->getMigratedVersions();
+        $availableMigrations = $this->getAvailableVersions();
+
+        $toBeExecuted = [];
+        foreach ($availableMigrations as $v) {
+            if ($to !== 'latest' && ($this->sortMigrations($v, $to) > 0)) {
+                continue;
+            }
+            if ($this->shallBeExecuted($v, $knownMigrations)) {
+                $toBeExecuted[] = $v;
+            }
+        }
+
+        return $toBeExecuted;
+    }
+
+    /**
+     * @param string $m
+     * @param string[] $knownMigrations
+     * @return bool
+     */
+    private function shallBeExecuted($m, $knownMigrations) {
+        if (in_array($m, $knownMigrations)) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * @param string $version
+     */
+    private function markAsExecuted($version) {
+        $this->connection->insertIfNotExist('*PREFIX*migrations', [
+            'app' => $this->appName,
+            'version' => $version
+        ]);
+    }
+
+    /**
+     * Returns the name of the table which holds the already applied versions
+     *
+     * @return string
+     */
+    public function getMigrationsTableName() {
+        return $this->connection->getPrefix() . 'migrations';
+    }
+
+    /**
+     * Returns the namespace of the version classes
+     *
+     * @return string
+     */
+    public function getMigrationsNamespace() {
+        return $this->migrationsNamespace;
+    }
+
+    /**
+     * Returns the directory which holds the versions
+     *
+     * @return string
+     */
+    public function getMigrationsDirectory() {
+        return $this->migrationsPath;
+    }
+
+    /**
+     * Return the explicit version for the aliases; current, next, prev, latest
+     *
+     * @return mixed|null|string
+     */
+    public function getMigration(string $alias) {
+        switch ($alias) {
+            case 'current':
+                return $this->getCurrentVersion();
+            case 'next':
+                return $this->getRelativeVersion($this->getCurrentVersion(), 1);
+            case 'prev':
+                return $this->getRelativeVersion($this->getCurrentVersion(), -1);
+            case 'latest':
+                $this->ensureMigrationsAreLoaded();
+
+                $migrations = $this->getAvailableVersions();
+                return @end($migrations);
+        }
+        return '0';
+    }
+
+    private function getRelativeVersion(string $version, int $delta): ?string {
+        $this->ensureMigrationsAreLoaded();
+
+        $versions = $this->getAvailableVersions();
+        array_unshift($versions, '0');
+        /** @var int $offset */
+        $offset = array_search($version, $versions, true);
+        if ($offset === false || !isset($versions[$offset + $delta])) {
+            // Unknown version or delta out of bounds.
+            return null;
+        }
+
+        return (string)$versions[$offset + $delta];
+    }
+
+    private function getCurrentVersion(): string {
+        $m = $this->getMigratedVersions();
+        if (count($m) === 0) {
+            return '0';
+        }
+        $migrations = array_values($m);
+        return @end($migrations);
+    }
+
+    /**
+     * @throws \InvalidArgumentException
+     */
+    private function getClass(string $version): string {
+        $this->ensureMigrationsAreLoaded();
+
+        if (isset($this->migrations[$version])) {
+            return $this->migrations[$version];
+        }
+
+        throw new \InvalidArgumentException("Version $version is unknown.");
+    }
+
+    /**
+     * Allows to set an IOutput implementation which is used for logging progress and messages
+     */
+    public function setOutput(IOutput $output): void {
+        $this->output = $output;
+    }
+
+    /**
+     * Applies all not yet applied versions up to $to
+     * @throws \InvalidArgumentException
+     */
+    public function migrate(string $to = 'latest', bool $schemaOnly = false): void {
+        if ($schemaOnly) {
+            $this->output->debug('Migrating schema only');
+            $this->migrateSchemaOnly($to);
+            return;
+        }
+
+        // read known migrations
+        $toBeExecuted = $this->getMigrationsToExecute($to);
+        foreach ($toBeExecuted as $version) {
+            try {
+                $this->executeStep($version, $schemaOnly);
+            } catch (\Exception $e) {
+                // The exception itself does not contain the name of the migration,
+                // so we wrap it here, to make debugging easier.
+                throw new \Exception('Database error when running migration ' . $version . ' for app ' . $this->getApp() . PHP_EOL . $e->getMessage(), 0, $e);
+            }
+        }
+    }
+
+    /**
+     * Applies all not yet applied versions up to $to
+     * @throws \InvalidArgumentException
+     */
+    public function migrateSchemaOnly(string $to = 'latest'): void {
+        // read known migrations
+        $toBeExecuted = $this->getMigrationsToExecute($to);
+
+        if (empty($toBeExecuted)) {
+            return;
+        }
+
+        $toSchema = null;
+        foreach ($toBeExecuted as $version) {
+            $this->output->debug('- Reading ' . $version);
+            $instance = $this->createInstance($version);
+
+            $toSchema = $instance->changeSchema($this->output, function () use ($toSchema): ISchemaWrapper {
+                return $toSchema ?: new SchemaWrapper($this->connection);
+            }, ['tablePrefix' => $this->connection->getPrefix()]) ?: $toSchema;
+        }
+
+        if ($toSchema instanceof SchemaWrapper) {
+            $this->output->debug('- Checking target database schema');
+            $targetSchema = $toSchema->getWrappedSchema();
+            $this->ensureUniqueNamesConstraints($targetSchema, true);
+            if ($this->checkOracle) {
+                $beforeSchema = $this->connection->createSchema();
+                $this->ensureOracleConstraints($beforeSchema, $targetSchema, strlen($this->connection->getPrefix()));
+            }
+
+            $this->output->debug('- Migrate database schema');
+            $this->connection->migrateToSchema($targetSchema);
+            $toSchema->performDropTableCalls();
+        }
+
+        $this->output->debug('- Mark migrations as executed');
+        foreach ($toBeExecuted as $version) {
+            $this->markAsExecuted($version);
+        }
+    }
+
+    /**
+     * Get the human readable descriptions for the migration steps to run
+     *
+     * @param string $to
+     * @return string[] [$name => $description]
+     */
+    public function describeMigrationStep($to = 'latest') {
+        $toBeExecuted = $this->getMigrationsToExecute($to);
+        $description = [];
+        foreach ($toBeExecuted as $version) {
+            $migration = $this->createInstance($version);
+            if ($migration->name()) {
+                $description[$migration->name()] = $migration->description();
+            }
+        }
+        return $description;
+    }
+
+    /**
+     * @param string $version
+     * @return IMigrationStep
+     * @throws \InvalidArgumentException
+     */
+    public function createInstance($version) {
+        $class = $this->getClass($version);
+        try {
+            $s = \OCP\Server::get($class);
+
+            if (!$s instanceof IMigrationStep) {
+                throw new \InvalidArgumentException('Not a valid migration');
+            }
+        } catch (QueryException $e) {
+            if (class_exists($class)) {
+                $s = new $class();
+            } else {
+                throw new \InvalidArgumentException("Migration step '$class' is unknown");
+            }
+        }
+
+        return $s;
+    }
+
+    /**
+     * Executes one explicit version
+     *
+     * @param string $version
+     * @param bool $schemaOnly
+     * @throws \InvalidArgumentException
+     */
+    public function executeStep($version, $schemaOnly = false) {
+        $instance = $this->createInstance($version);
+
+        if (!$schemaOnly) {
+            $instance->preSchemaChange($this->output, function (): ISchemaWrapper {
+                return new SchemaWrapper($this->connection);
+            }, ['tablePrefix' => $this->connection->getPrefix()]);
+        }
+
+        $toSchema = $instance->changeSchema($this->output, function (): ISchemaWrapper {
+            return new SchemaWrapper($this->connection);
+        }, ['tablePrefix' => $this->connection->getPrefix()]);
+
+        if ($toSchema instanceof SchemaWrapper) {
+            $targetSchema = $toSchema->getWrappedSchema();
+            $this->ensureUniqueNamesConstraints($targetSchema, $schemaOnly);
+            if ($this->checkOracle) {
+                $sourceSchema = $this->connection->createSchema();
+                $this->ensureOracleConstraints($sourceSchema, $targetSchema, strlen($this->connection->getPrefix()));
+            }
+            $this->connection->migrateToSchema($targetSchema);
+            $toSchema->performDropTableCalls();
+        }
+
+        if (!$schemaOnly) {
+            $instance->postSchemaChange($this->output, function (): ISchemaWrapper {
+                return new SchemaWrapper($this->connection);
+            }, ['tablePrefix' => $this->connection->getPrefix()]);
+        }
+
+        $this->markAsExecuted($version);
+    }
+
+    /**
+     * Naming constraints:
+     * - Tables names must be 30 chars or shorter (27 + oc_ prefix)
+     * - Column names must be 30 chars or shorter
+     * - Index names must be 30 chars or shorter
+     * - Sequence names must be 30 chars or shorter
+     * - Primary key names must be set or the table name 23 chars or shorter
+     *
+     * Data constraints:
+     * - Tables need a primary key (Not specific to Oracle, but required for performant clustering support)
+     * - Columns with "NotNull" can not have empty string as default value
+     * - Columns with "NotNull" can not have number 0 as default value
+     * - Columns with type "bool" (which is in fact integer of length 1) can not be "NotNull" as it can not store 0/false
+     * - Columns with type "string" can not be longer than 4.000 characters, use "text" instead
+     *
+     * @see https://github.com/nextcloud/documentation/blob/master/developer_manual/basics/storage/database.rst
+     *
+     * @param Schema $sourceSchema
+     * @param Schema $targetSchema
+     * @param int $prefixLength
+     * @throws \Doctrine\DBAL\Exception
+     */
+    public function ensureOracleConstraints(Schema $sourceSchema, Schema $targetSchema, int $prefixLength) {
+        $sequences = $targetSchema->getSequences();
+
+        foreach ($targetSchema->getTables() as $table) {
+            try {
+                $sourceTable = $sourceSchema->getTable($table->getName());
+            } catch (SchemaException $e) {
+                if (\strlen($table->getName()) - $prefixLength > 27) {
+                    throw new \InvalidArgumentException('Table name "' . $table->getName() . '" is too long.');
+                }
+                $sourceTable = null;
+            }
+
+            foreach ($table->getColumns() as $thing) {
+                // If the table doesn't exist OR if the column doesn't exist in the table
+                if (!$sourceTable instanceof Table || !$sourceTable->hasColumn($thing->getName())) {
+                    if (\strlen($thing->getName()) > 30) {
+                        throw new \InvalidArgumentException('Column name "' . $table->getName() . '"."' . $thing->getName() . '" is too long.');
+                    }
+
+                    if ($thing->getNotnull() && $thing->getDefault() === ''
+                        && $sourceTable instanceof Table && !$sourceTable->hasColumn($thing->getName())) {
+                        throw new \InvalidArgumentException('Column "' . $table->getName() . '"."' . $thing->getName() . '" is NotNull, but has empty string or null as default.');
+                    }
+
+                    if ($this->connection->getDatabaseProvider() === IDBConnection::PLATFORM_ORACLE) {
+                        // Oracle doesn't support boolean column with non-null value
+                        if ($thing->getNotnull() && Type::lookupName($thing->getType()) === Types::BOOLEAN) {
+                            $thing->setNotnull(false);
+                        }
+                    }
+
+                    $sourceColumn = null;
+                } else {
+                    $sourceColumn = $sourceTable->getColumn($thing->getName());
+                }
+
+                // If the column was just created OR the length changed OR the type changed
+                // we will NOT detect invalid length if the column is not modified
+                if (($sourceColumn === null || $sourceColumn->getLength() !== $thing->getLength() || Type::lookupName($sourceColumn->getType()) !== Types::STRING)
+                    && $thing->getLength() > 4000 && Type::lookupName($thing->getType()) === Types::STRING) {
+                    throw new \InvalidArgumentException('Column "' . $table->getName() . '"."' . $thing->getName() . '" is type String, but exceeding the 4.000 length limit.');
+                }
+            }
+
+            foreach ($table->getIndexes() as $thing) {
+                if ((!$sourceTable instanceof Table || !$sourceTable->hasIndex($thing->getName())) && \strlen($thing->getName()) > 30) {
+                    throw new \InvalidArgumentException('Index name "' . $table->getName() . '"."' . $thing->getName() . '" is too long.');
+                }
+            }
+
+            foreach ($table->getForeignKeys() as $thing) {
+                if ((!$sourceTable instanceof Table || !$sourceTable->hasForeignKey($thing->getName())) && \strlen($thing->getName()) > 30) {
+                    throw new \InvalidArgumentException('Foreign key name "' . $table->getName() . '"."' . $thing->getName() . '" is too long.');
+                }
+            }
+
+            $primaryKey = $table->getPrimaryKey();
+            if ($primaryKey instanceof Index && (!$sourceTable instanceof Table || $sourceTable->getPrimaryKey() === null)) {
+                $indexName = strtolower($primaryKey->getName());
+                $isUsingDefaultName = $indexName === 'primary';
+
+                if ($this->connection->getDatabaseProvider() === IDBConnection::PLATFORM_POSTGRES) {
+                    $defaultName = $table->getName() . '_pkey';
+                    $isUsingDefaultName = strtolower($defaultName) === $indexName;
+
+                    if ($isUsingDefaultName) {
+                        $sequenceName = $table->getName() . '_' . implode('_', $primaryKey->getColumns()) . '_seq';
+                        $sequences = array_filter($sequences, function (Sequence $sequence) use ($sequenceName) {
+                            return $sequence->getName() !== $sequenceName;
+                        });
+                    }
+                } elseif ($this->connection->getDatabaseProvider() === IDBConnection::PLATFORM_ORACLE) {
+                    $defaultName = $table->getName() . '_seq';
+                    $isUsingDefaultName = strtolower($defaultName) === $indexName;
+                }
+
+                if (!$isUsingDefaultName && \strlen($indexName) > 30) {
+                    throw new \InvalidArgumentException('Primary index name on "' . $table->getName() . '" is too long.');
+                }
+                if ($isUsingDefaultName && \strlen($table->getName()) - $prefixLength >= 23) {
+                    throw new \InvalidArgumentException('Primary index name on "' . $table->getName() . '" is too long.');
+                }
+            } elseif (!$primaryKey instanceof Index && !$sourceTable instanceof Table) {
+                /** @var LoggerInterface $logger */
+                $logger = \OC::$server->get(LoggerInterface::class);
+                $logger->error('Table "' . $table->getName() . '" has no primary key and therefor will not behave sane in clustered setups. This will throw an exception and not be installable in a future version of Nextcloud.');
+                // throw new \InvalidArgumentException('Table "' . $table->getName() . '" has no primary key and therefor will not behave sane in clustered setups.');
+            }
+        }
+
+        foreach ($sequences as $sequence) {
+            if (!$sourceSchema->hasSequence($sequence->getName()) && \strlen($sequence->getName()) > 30) {
+                throw new \InvalidArgumentException('Sequence name "' . $sequence->getName() . '" is too long.');
+            }
+        }
+    }
+
+    /**
+     * Ensure naming constraints
+     *
+     * Naming constraints:
+     * - Index, sequence and primary key names must be unique within a Postgres Schema
+     *
+     * Only on installation we want to break hard, so that all developers notice
+     * the bugs when installing the app on any database or CI, and can work on
+     * fixing their migrations before releasing a version incompatible with Postgres.
+     *
+     * In case of updates we might be running on production instances and the
+     * administrators being faced with the error would not know how to resolve it
+     * anyway. This can also happen with instances, that had the issue before the
+     * current update, so we don't want to make their life more complicated
+     * than needed.
+     *
+     * @param Schema $targetSchema
+     * @param bool $isInstalling
+     */
+    public function ensureUniqueNamesConstraints(Schema $targetSchema, bool $isInstalling): void {
+        $constraintNames = [];
+        $sequences = $targetSchema->getSequences();
+
+        foreach ($targetSchema->getTables() as $table) {
+            foreach ($table->getIndexes() as $thing) {
+                $indexName = strtolower($thing->getName());
+                if ($indexName === 'primary' || $thing->isPrimary()) {
+                    continue;
+                }
+
+                if (isset($constraintNames[$thing->getName()])) {
+                    if ($isInstalling) {
+                        throw new \InvalidArgumentException('Index name "' . $thing->getName() . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
+                    }
+                    $this->logErrorOrWarning('Index name "' . $thing->getName() . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
+                }
+                $constraintNames[$thing->getName()] = $table->getName();
+            }
+
+            foreach ($table->getForeignKeys() as $thing) {
+                if (isset($constraintNames[$thing->getName()])) {
+                    if ($isInstalling) {
+                        throw new \InvalidArgumentException('Foreign key name "' . $thing->getName() . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
+                    }
+                    $this->logErrorOrWarning('Foreign key name "' . $thing->getName() . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
+                }
+                $constraintNames[$thing->getName()] = $table->getName();
+            }
+
+            $primaryKey = $table->getPrimaryKey();
+            if ($primaryKey instanceof Index) {
+                $indexName = strtolower($primaryKey->getName());
+                if ($indexName === 'primary') {
+                    continue;
+                }
+
+                if (isset($constraintNames[$indexName])) {
+                    if ($isInstalling) {
+                        throw new \InvalidArgumentException('Primary index name "' . $indexName . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
+                    }
+                    $this->logErrorOrWarning('Primary index name "' . $indexName . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
+                }
+                $constraintNames[$indexName] = $table->getName();
+            }
+        }
+
+        foreach ($sequences as $sequence) {
+            if (isset($constraintNames[$sequence->getName()])) {
+                if ($isInstalling) {
+                    throw new \InvalidArgumentException('Sequence name "' . $sequence->getName() . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
+                }
+                $this->logErrorOrWarning('Sequence name "' . $sequence->getName() . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
+            }
+            $constraintNames[$sequence->getName()] = 'sequence';
+        }
+    }
+
+    protected function logErrorOrWarning(string $log): void {
+        if ($this->output instanceof SimpleOutput) {
+            $this->output->warning($log);
+        } else {
+            $this->logger->error($log);
+        }
+    }
+
+    private function ensureMigrationsAreLoaded(): void {
+        if (empty($this->migrations)) {
+            $this->migrations = $this->findMigrations();
+        }
+    }
 }

Spacing +36 added lines, -36 removed lines

@@ -60,7 +60,7 @@ 
 		}
 
 		if ($appName === 'core') {
-			$this->migrationsPath = \OC::$SERVERROOT . '/core/Migrations';
+			$this->migrationsPath = \OC::$SERVERROOT.'/core/Migrations';
 			$this->migrationsNamespace = 'OC\\Core\\Migrations';
 			$this->checkOracle = true;
 		} else {
@@ -68,10 +68,10 @@ 
 			$appPath = $appManager->getAppPath($appName);
 			$namespace = App::buildAppNamespace($appName);
 			$this->migrationsPath = "$appPath/lib/Migration";
-			$this->migrationsNamespace = $namespace . '\\Migration';
+			$this->migrationsNamespace = $namespace.'\\Migration';
 
 			$infoParser = new InfoParser();
-			$info = $infoParser->parse($appPath . '/appinfo/info.xml');
+			$info = $infoParser->parse($appPath.'/appinfo/info.xml');
 			if (!isset($info['dependencies']['database'])) {
 				$this->checkOracle = true;
 			} else {
@@ -199,8 +199,8 @@ 
 		preg_match('/(\d+)Date(\d+)/', basename($a), $matchA);
 		preg_match('/(\d+)Date(\d+)/', basename($b), $matchB);
 		if (!empty($matchA) && !empty($matchB)) {
-			$versionA = (int)$matchA[1];
-			$versionB = (int)$matchB[1];
+			$versionA = (int) $matchA[1];
+			$versionB = (int) $matchB[1];
 			if ($versionA !== $versionB) {
 				return ($versionA < $versionB) ? -1 : 1;
 			}
@@ -233,7 +233,7 @@ 
 
 		foreach ($files as $file) {
 			$className = basename($file, '.php');
-			$version = (string)substr($className, 7);
+			$version = (string) substr($className, 7);
 			if ($version === '0') {
 				throw new \InvalidArgumentException(
 					"Cannot load a migrations with the name '$version' because it is a reserved number"
@@ -295,7 +295,7 @@ 
 	 * @return string
 	 */
 	public function getMigrationsTableName() {
-		return $this->connection->getPrefix() . 'migrations';
+		return $this->connection->getPrefix().'migrations';
 	}
 
 	/**
@@ -350,7 +350,7 @@ 
 			return null;
 		}
 
-		return (string)$versions[$offset + $delta];
+		return (string) $versions[$offset + $delta];
 	}
 
 	private function getCurrentVersion(): string {
@@ -401,7 +401,7 @@ 
 			} catch (\Exception $e) {
 				// The exception itself does not contain the name of the migration,
 				// so we wrap it here, to make debugging easier.
-				throw new \Exception('Database error when running migration ' . $version . ' for app ' . $this->getApp() . PHP_EOL . $e->getMessage(), 0, $e);
+				throw new \Exception('Database error when running migration '.$version.' for app '.$this->getApp().PHP_EOL.$e->getMessage(), 0, $e);
 			}
 		}
 	}
@@ -420,10 +420,10 @@ 
 
 		$toSchema = null;
 		foreach ($toBeExecuted as $version) {
-			$this->output->debug('- Reading ' . $version);
+			$this->output->debug('- Reading '.$version);
 			$instance = $this->createInstance($version);
 
-			$toSchema = $instance->changeSchema($this->output, function () use ($toSchema): ISchemaWrapper {
+			$toSchema = $instance->changeSchema($this->output, function() use ($toSchema): ISchemaWrapper {
 				return $toSchema ?: new SchemaWrapper($this->connection);
 			}, ['tablePrefix' => $this->connection->getPrefix()]) ?: $toSchema;
 		}
@@ -501,12 +501,12 @@ 
 		$instance = $this->createInstance($version);
 
 		if (!$schemaOnly) {
-			$instance->preSchemaChange($this->output, function (): ISchemaWrapper {
+			$instance->preSchemaChange($this->output, function(): ISchemaWrapper {
 				return new SchemaWrapper($this->connection);
 			}, ['tablePrefix' => $this->connection->getPrefix()]);
 		}
 
-		$toSchema = $instance->changeSchema($this->output, function (): ISchemaWrapper {
+		$toSchema = $instance->changeSchema($this->output, function(): ISchemaWrapper {
 			return new SchemaWrapper($this->connection);
 		}, ['tablePrefix' => $this->connection->getPrefix()]);
 
@@ -522,7 +522,7 @@ 
 		}
 
 		if (!$schemaOnly) {
-			$instance->postSchemaChange($this->output, function (): ISchemaWrapper {
+			$instance->postSchemaChange($this->output, function(): ISchemaWrapper {
 				return new SchemaWrapper($this->connection);
 			}, ['tablePrefix' => $this->connection->getPrefix()]);
 		}
@@ -560,7 +560,7 @@ 
 				$sourceTable = $sourceSchema->getTable($table->getName());
 			} catch (SchemaException $e) {
 				if (\strlen($table->getName()) - $prefixLength > 27) {
-					throw new \InvalidArgumentException('Table name "' . $table->getName() . '" is too long.');
+					throw new \InvalidArgumentException('Table name "'.$table->getName().'" is too long.');
 				}
 				$sourceTable = null;
 			}
@@ -569,12 +569,12 @@ 
 				// If the table doesn't exist OR if the column doesn't exist in the table
 				if (!$sourceTable instanceof Table || !$sourceTable->hasColumn($thing->getName())) {
 					if (\strlen($thing->getName()) > 30) {
-						throw new \InvalidArgumentException('Column name "' . $table->getName() . '"."' . $thing->getName() . '" is too long.');
+						throw new \InvalidArgumentException('Column name "'.$table->getName().'"."'.$thing->getName().'" is too long.');
 					}
 
 					if ($thing->getNotnull() && $thing->getDefault() === ''
 						&& $sourceTable instanceof Table && !$sourceTable->hasColumn($thing->getName())) {
-						throw new \InvalidArgumentException('Column "' . $table->getName() . '"."' . $thing->getName() . '" is NotNull, but has empty string or null as default.');
+						throw new \InvalidArgumentException('Column "'.$table->getName().'"."'.$thing->getName().'" is NotNull, but has empty string or null as default.');
 					}
 
 					if ($this->connection->getDatabaseProvider() === IDBConnection::PLATFORM_ORACLE) {
@@ -593,19 +593,19 @@ 
 				// we will NOT detect invalid length if the column is not modified
 				if (($sourceColumn === null || $sourceColumn->getLength() !== $thing->getLength() || Type::lookupName($sourceColumn->getType()) !== Types::STRING)
 					&& $thing->getLength() > 4000 && Type::lookupName($thing->getType()) === Types::STRING) {
-					throw new \InvalidArgumentException('Column "' . $table->getName() . '"."' . $thing->getName() . '" is type String, but exceeding the 4.000 length limit.');
+					throw new \InvalidArgumentException('Column "'.$table->getName().'"."'.$thing->getName().'" is type String, but exceeding the 4.000 length limit.');
 				}
 			}
 
 			foreach ($table->getIndexes() as $thing) {
 				if ((!$sourceTable instanceof Table || !$sourceTable->hasIndex($thing->getName())) && \strlen($thing->getName()) > 30) {
-					throw new \InvalidArgumentException('Index name "' . $table->getName() . '"."' . $thing->getName() . '" is too long.');
+					throw new \InvalidArgumentException('Index name "'.$table->getName().'"."'.$thing->getName().'" is too long.');
 				}
 			}
 
 			foreach ($table->getForeignKeys() as $thing) {
 				if ((!$sourceTable instanceof Table || !$sourceTable->hasForeignKey($thing->getName())) && \strlen($thing->getName()) > 30) {
-					throw new \InvalidArgumentException('Foreign key name "' . $table->getName() . '"."' . $thing->getName() . '" is too long.');
+					throw new \InvalidArgumentException('Foreign key name "'.$table->getName().'"."'.$thing->getName().'" is too long.');
 				}
 			}
 
@@ -615,37 +615,37 @@ 
 				$isUsingDefaultName = $indexName === 'primary';
 
 				if ($this->connection->getDatabaseProvider() === IDBConnection::PLATFORM_POSTGRES) {
-					$defaultName = $table->getName() . '_pkey';
+					$defaultName = $table->getName().'_pkey';
 					$isUsingDefaultName = strtolower($defaultName) === $indexName;
 
 					if ($isUsingDefaultName) {
-						$sequenceName = $table->getName() . '_' . implode('_', $primaryKey->getColumns()) . '_seq';
-						$sequences = array_filter($sequences, function (Sequence $sequence) use ($sequenceName) {
+						$sequenceName = $table->getName().'_'.implode('_', $primaryKey->getColumns()).'_seq';
+						$sequences = array_filter($sequences, function(Sequence $sequence) use ($sequenceName) {
 							return $sequence->getName() !== $sequenceName;
 						});
 					}
 				} elseif ($this->connection->getDatabaseProvider() === IDBConnection::PLATFORM_ORACLE) {
-					$defaultName = $table->getName() . '_seq';
+					$defaultName = $table->getName().'_seq';
 					$isUsingDefaultName = strtolower($defaultName) === $indexName;
 				}
 
 				if (!$isUsingDefaultName && \strlen($indexName) > 30) {
-					throw new \InvalidArgumentException('Primary index name on "' . $table->getName() . '" is too long.');
+					throw new \InvalidArgumentException('Primary index name on "'.$table->getName().'" is too long.');
 				}
 				if ($isUsingDefaultName && \strlen($table->getName()) - $prefixLength >= 23) {
-					throw new \InvalidArgumentException('Primary index name on "' . $table->getName() . '" is too long.');
+					throw new \InvalidArgumentException('Primary index name on "'.$table->getName().'" is too long.');
 				}
 			} elseif (!$primaryKey instanceof Index && !$sourceTable instanceof Table) {
 				/** @var LoggerInterface $logger */
 				$logger = \OC::$server->get(LoggerInterface::class);
-				$logger->error('Table "' . $table->getName() . '" has no primary key and therefor will not behave sane in clustered setups. This will throw an exception and not be installable in a future version of Nextcloud.');
+				$logger->error('Table "'.$table->getName().'" has no primary key and therefor will not behave sane in clustered setups. This will throw an exception and not be installable in a future version of Nextcloud.');
 				// throw new \InvalidArgumentException('Table "' . $table->getName() . '" has no primary key and therefor will not behave sane in clustered setups.');
 			}
 		}
 
 		foreach ($sequences as $sequence) {
 			if (!$sourceSchema->hasSequence($sequence->getName()) && \strlen($sequence->getName()) > 30) {
-				throw new \InvalidArgumentException('Sequence name "' . $sequence->getName() . '" is too long.');
+				throw new \InvalidArgumentException('Sequence name "'.$sequence->getName().'" is too long.');
 			}
 		}
 	}
@@ -682,9 +682,9 @@ 
 
 				if (isset($constraintNames[$thing->getName()])) {
 					if ($isInstalling) {
-						throw new \InvalidArgumentException('Index name "' . $thing->getName() . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
+						throw new \InvalidArgumentException('Index name "'.$thing->getName().'" for table "'.$table->getName().'" collides with the constraint on table "'.$constraintNames[$thing->getName()].'".');
 					}
-					$this->logErrorOrWarning('Index name "' . $thing->getName() . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
+					$this->logErrorOrWarning('Index name "'.$thing->getName().'" for table "'.$table->getName().'" collides with the constraint on table "'.$constraintNames[$thing->getName()].'".');
 				}
 				$constraintNames[$thing->getName()] = $table->getName();
 			}
@@ -692,9 +692,9 @@ 
 			foreach ($table->getForeignKeys() as $thing) {
 				if (isset($constraintNames[$thing->getName()])) {
 					if ($isInstalling) {
-						throw new \InvalidArgumentException('Foreign key name "' . $thing->getName() . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
+						throw new \InvalidArgumentException('Foreign key name "'.$thing->getName().'" for table "'.$table->getName().'" collides with the constraint on table "'.$constraintNames[$thing->getName()].'".');
 					}
-					$this->logErrorOrWarning('Foreign key name "' . $thing->getName() . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
+					$this->logErrorOrWarning('Foreign key name "'.$thing->getName().'" for table "'.$table->getName().'" collides with the constraint on table "'.$constraintNames[$thing->getName()].'".');
 				}
 				$constraintNames[$thing->getName()] = $table->getName();
 			}
@@ -708,9 +708,9 @@ 
 
 				if (isset($constraintNames[$indexName])) {
 					if ($isInstalling) {
-						throw new \InvalidArgumentException('Primary index name "' . $indexName . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
+						throw new \InvalidArgumentException('Primary index name "'.$indexName.'" for table "'.$table->getName().'" collides with the constraint on table "'.$constraintNames[$thing->getName()].'".');
 					}
-					$this->logErrorOrWarning('Primary index name "' . $indexName . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
+					$this->logErrorOrWarning('Primary index name "'.$indexName.'" for table "'.$table->getName().'" collides with the constraint on table "'.$constraintNames[$thing->getName()].'".');
 				}
 				$constraintNames[$indexName] = $table->getName();
 			}
@@ -719,9 +719,9 @@ 
 		foreach ($sequences as $sequence) {
 			if (isset($constraintNames[$sequence->getName()])) {
 				if ($isInstalling) {
-					throw new \InvalidArgumentException('Sequence name "' . $sequence->getName() . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
+					throw new \InvalidArgumentException('Sequence name "'.$sequence->getName().'" for table "'.$table->getName().'" collides with the constraint on table "'.$constraintNames[$thing->getName()].'".');
 				}
-				$this->logErrorOrWarning('Sequence name "' . $sequence->getName() . '" for table "' . $table->getName() . '" collides with the constraint on table "' . $constraintNames[$thing->getName()] . '".');
+				$this->logErrorOrWarning('Sequence name "'.$sequence->getName().'" for table "'.$table->getName().'" collides with the constraint on table "'.$constraintNames[$thing->getName()].'".');
 			}
 			$constraintNames[$sequence->getName()] = 'sequence';
 		}

lib/private/User/Manager.php

Indentation +768 added lines, -768 removed lines

@@ -53,772 +53,772 @@
  * @package OC\User
  */
 class Manager extends PublicEmitter implements IUserManager {
-	/**
-	 * @var UserInterface[] $backends
-	 */
-	private array $backends = [];
-
-	/**
-	 * @var array<string,\OC\User\User> $cachedUsers
-	 */
-	private array $cachedUsers = [];
-
-	private ICache $cache;
-
-	private DisplayNameCache $displayNameCache;
-
-	public function __construct(
-		private IConfig $config,
-		ICacheFactory $cacheFactory,
-		private IEventDispatcher $eventDispatcher,
-		private LoggerInterface $logger,
-	) {
-		$this->cache = new WithLocalCache($cacheFactory->createDistributed('user_backend_map'));
-		$this->listen('\OC\User', 'postDelete', function (IUser $user): void {
-			unset($this->cachedUsers[$user->getUID()]);
-		});
-		$this->displayNameCache = new DisplayNameCache($cacheFactory, $this);
-	}
-
-	/**
-	 * Get the active backends
-	 * @return UserInterface[]
-	 */
-	public function getBackends(): array {
-		return $this->backends;
-	}
-
-	public function registerBackend(UserInterface $backend): void {
-		$this->backends[] = $backend;
-	}
-
-	public function removeBackend(UserInterface $backend): void {
-		$this->cachedUsers = [];
-		if (($i = array_search($backend, $this->backends)) !== false) {
-			unset($this->backends[$i]);
-		}
-	}
-
-	public function clearBackends(): void {
-		$this->cachedUsers = [];
-		$this->backends = [];
-	}
-
-	/**
-	 * get a user by user id
-	 *
-	 * @param string $uid
-	 * @return \OC\User\User|null Either the user or null if the specified user does not exist
-	 */
-	public function get($uid) {
-		if (is_null($uid) || $uid === '' || $uid === false) {
-			return null;
-		}
-		if (isset($this->cachedUsers[$uid])) { //check the cache first to prevent having to loop over the backends
-			return $this->cachedUsers[$uid];
-		}
-
-		if (strlen($uid) > IUser::MAX_USERID_LENGTH) {
-			return null;
-		}
-
-		$cachedBackend = $this->cache->get(sha1($uid));
-		if ($cachedBackend !== null && isset($this->backends[$cachedBackend])) {
-			// Cache has the info of the user backend already, so ask that one directly
-			$backend = $this->backends[$cachedBackend];
-			if ($backend->userExists($uid)) {
-				return $this->getUserObject($uid, $backend);
-			}
-		}
-
-		foreach ($this->backends as $i => $backend) {
-			if ($i === $cachedBackend) {
-				// Tried that one already
-				continue;
-			}
-
-			if ($backend->userExists($uid)) {
-				// Hash $uid to ensure that only valid characters are used for the cache key
-				$this->cache->set(sha1($uid), $i, 300);
-				return $this->getUserObject($uid, $backend);
-			}
-		}
-		return null;
-	}
-
-	public function getDisplayName(string $uid): ?string {
-		return $this->displayNameCache->getDisplayName($uid);
-	}
-
-	/**
-	 * get or construct the user object
-	 *
-	 * @param string $uid
-	 * @param \OCP\UserInterface $backend
-	 * @param bool $cacheUser If false the newly created user object will not be cached
-	 * @return \OC\User\User
-	 */
-	public function getUserObject($uid, $backend, $cacheUser = true) {
-		if ($backend instanceof IGetRealUIDBackend) {
-			$uid = $backend->getRealUID($uid);
-		}
-
-		if (isset($this->cachedUsers[$uid])) {
-			return $this->cachedUsers[$uid];
-		}
-
-		$user = new User($uid, $backend, $this->eventDispatcher, $this, $this->config);
-		if ($cacheUser) {
-			$this->cachedUsers[$uid] = $user;
-		}
-		return $user;
-	}
-
-	/**
-	 * check if a user exists
-	 *
-	 * @param string $uid
-	 * @return bool
-	 */
-	public function userExists($uid) {
-		if (strlen($uid) > IUser::MAX_USERID_LENGTH) {
-			return false;
-		}
-
-		$user = $this->get($uid);
-		return ($user !== null);
-	}
-
-	/**
-	 * Check if the password is valid for the user
-	 *
-	 * @param string $loginName
-	 * @param string $password
-	 * @return IUser|false the User object on success, false otherwise
-	 */
-	public function checkPassword($loginName, $password) {
-		$result = $this->checkPasswordNoLogging($loginName, $password);
-
-		if ($result === false) {
-			$this->logger->warning('Login failed: \'' . $loginName . '\' (Remote IP: \'' . \OC::$server->getRequest()->getRemoteAddress() . '\')', ['app' => 'core']);
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Check if the password is valid for the user
-	 *
-	 * @internal
-	 * @param string $loginName
-	 * @param string $password
-	 * @return IUser|false the User object on success, false otherwise
-	 */
-	public function checkPasswordNoLogging($loginName, $password) {
-		$loginName = str_replace("\0", '', $loginName);
-		$password = str_replace("\0", '', $password);
-
-		$cachedBackend = $this->cache->get($loginName);
-		if ($cachedBackend !== null && isset($this->backends[$cachedBackend])) {
-			$backends = [$this->backends[$cachedBackend]];
-		} else {
-			$backends = $this->backends;
-		}
-		foreach ($backends as $backend) {
-			if ($backend instanceof ICheckPasswordBackend || $backend->implementsActions(Backend::CHECK_PASSWORD)) {
-				/** @var ICheckPasswordBackend $backend */
-				$uid = $backend->checkPassword($loginName, $password);
-				if ($uid !== false) {
-					return $this->getUserObject($uid, $backend);
-				}
-			}
-		}
-
-		// since http basic auth doesn't provide a standard way of handling non ascii password we allow password to be urlencoded
-		// we only do this decoding after using the plain password fails to maintain compatibility with any password that happens
-		// to contain urlencoded patterns by "accident".
-		$password = urldecode($password);
-
-		foreach ($backends as $backend) {
-			if ($backend instanceof ICheckPasswordBackend || $backend->implementsActions(Backend::CHECK_PASSWORD)) {
-				/** @var ICheckPasswordBackend|UserInterface $backend */
-				$uid = $backend->checkPassword($loginName, $password);
-				if ($uid !== false) {
-					return $this->getUserObject($uid, $backend);
-				}
-			}
-		}
-
-		return false;
-	}
-
-	public function search($pattern, $limit = null, $offset = null) {
-		$users = [];
-		foreach ($this->backends as $backend) {
-			$backendUsers = $backend->getUsers($pattern, $limit, $offset);
-			if (is_array($backendUsers)) {
-				foreach ($backendUsers as $uid) {
-					$users[$uid] = new LazyUser($uid, $this, null, $backend);
-				}
-			}
-		}
-
-		uasort($users, function (IUser $a, IUser $b) {
-			return strcasecmp($a->getUID(), $b->getUID());
-		});
-		return $users;
-	}
-
-	public function searchDisplayName($pattern, $limit = null, $offset = null) {
-		$users = [];
-		foreach ($this->backends as $backend) {
-			$backendUsers = $backend->getDisplayNames($pattern, $limit, $offset);
-			if (is_array($backendUsers)) {
-				foreach ($backendUsers as $uid => $displayName) {
-					$users[] = new LazyUser($uid, $this, $displayName, $backend);
-				}
-			}
-		}
-
-		usort($users, function (IUser $a, IUser $b) {
-			return strcasecmp($a->getDisplayName(), $b->getDisplayName());
-		});
-		return $users;
-	}
-
-	/**
-	 * @return IUser[]
-	 */
-	public function getDisabledUsers(?int $limit = null, int $offset = 0, string $search = ''): array {
-		$users = $this->config->getUsersForUserValue('core', 'enabled', 'false');
-		$users = array_combine(
-			$users,
-			array_map(
-				fn (string $uid): IUser => new LazyUser($uid, $this),
-				$users
-			)
-		);
-		if ($search !== '') {
-			$users = array_filter(
-				$users,
-				function (IUser $user) use ($search): bool {
-					try {
-						return mb_stripos($user->getUID(), $search) !== false
-						|| mb_stripos($user->getDisplayName(), $search) !== false
-						|| mb_stripos($user->getEMailAddress() ?? '', $search) !== false;
-					} catch (NoUserException $ex) {
-						$this->logger->error('Error while filtering disabled users', ['exception' => $ex, 'userUID' => $user->getUID()]);
-						return false;
-					}
-				});
-		}
-
-		$tempLimit = ($limit === null ? null : $limit + $offset);
-		foreach ($this->backends as $backend) {
-			if (($tempLimit !== null) && (count($users) >= $tempLimit)) {
-				break;
-			}
-			if ($backend instanceof IProvideEnabledStateBackend) {
-				$backendUsers = $backend->getDisabledUserList(($tempLimit === null ? null : $tempLimit - count($users)), 0, $search);
-				foreach ($backendUsers as $uid) {
-					$users[$uid] = new LazyUser($uid, $this, null, $backend);
-				}
-			}
-		}
-
-		return array_slice($users, $offset, $limit);
-	}
-
-	/**
-	 * Search known users (from phonebook sync) by displayName
-	 *
-	 * @param string $searcher
-	 * @param string $pattern
-	 * @param int|null $limit
-	 * @param int|null $offset
-	 * @return IUser[]
-	 */
-	public function searchKnownUsersByDisplayName(string $searcher, string $pattern, ?int $limit = null, ?int $offset = null): array {
-		$users = [];
-		foreach ($this->backends as $backend) {
-			if ($backend instanceof ISearchKnownUsersBackend) {
-				$backendUsers = $backend->searchKnownUsersByDisplayName($searcher, $pattern, $limit, $offset);
-			} else {
-				// Better than nothing, but filtering after pagination can remove lots of results.
-				$backendUsers = $backend->getDisplayNames($pattern, $limit, $offset);
-			}
-			if (is_array($backendUsers)) {
-				foreach ($backendUsers as $uid => $displayName) {
-					$users[] = $this->getUserObject($uid, $backend);
-				}
-			}
-		}
-
-		usort($users, function ($a, $b) {
-			/**
-			 * @var IUser $a
-			 * @var IUser $b
-			 */
-			return strcasecmp($a->getDisplayName(), $b->getDisplayName());
-		});
-		return $users;
-	}
-
-	/**
-	 * @param string $uid
-	 * @param string $password
-	 * @return false|IUser the created user or false
-	 * @throws \InvalidArgumentException
-	 * @throws HintException
-	 */
-	public function createUser($uid, $password) {
-		// DI injection is not used here as IRegistry needs the user manager itself for user count and thus it would create a cyclic dependency
-		/** @var IAssertion $assertion */
-		$assertion = \OC::$server->get(IAssertion::class);
-		$assertion->createUserIsLegit();
-
-		$localBackends = [];
-		foreach ($this->backends as $backend) {
-			if ($backend instanceof Database) {
-				// First check if there is another user backend
-				$localBackends[] = $backend;
-				continue;
-			}
-
-			if ($backend->implementsActions(Backend::CREATE_USER)) {
-				return $this->createUserFromBackend($uid, $password, $backend);
-			}
-		}
-
-		foreach ($localBackends as $backend) {
-			if ($backend->implementsActions(Backend::CREATE_USER)) {
-				return $this->createUserFromBackend($uid, $password, $backend);
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * @param string $uid
-	 * @param string $password
-	 * @param UserInterface $backend
-	 * @return IUser|false
-	 * @throws \InvalidArgumentException
-	 */
-	public function createUserFromBackend($uid, $password, UserInterface $backend) {
-		$l = \OCP\Util::getL10N('lib');
-
-		$this->validateUserId($uid, true);
-
-		// No empty password
-		if (trim($password) === '') {
-			throw new \InvalidArgumentException($l->t('A valid password must be provided'));
-		}
-
-		// Check if user already exists
-		if ($this->userExists($uid)) {
-			throw new \InvalidArgumentException($l->t('The Login is already being used'));
-		}
-
-		/** @deprecated 21.0.0 use BeforeUserCreatedEvent event with the IEventDispatcher instead */
-		$this->emit('\OC\User', 'preCreateUser', [$uid, $password]);
-		$this->eventDispatcher->dispatchTyped(new BeforeUserCreatedEvent($uid, $password));
-		$state = $backend->createUser($uid, $password);
-		if ($state === false) {
-			throw new \InvalidArgumentException($l->t('Could not create account'));
-		}
-		$user = $this->getUserObject($uid, $backend);
-		if ($user instanceof IUser) {
-			/** @deprecated 21.0.0 use UserCreatedEvent event with the IEventDispatcher instead */
-			$this->emit('\OC\User', 'postCreateUser', [$user, $password]);
-			$this->eventDispatcher->dispatchTyped(new UserCreatedEvent($user, $password));
-			return $user;
-		}
-		return false;
-	}
-
-	/**
-	 * returns how many users per backend exist (if supported by backend)
-	 *
-	 * @param boolean $hasLoggedIn when true only users that have a lastLogin
-	 *                             entry in the preferences table will be affected
-	 * @return array<string, int> an array of backend class as key and count number as value
-	 */
-	public function countUsers() {
-		$userCountStatistics = [];
-		foreach ($this->backends as $backend) {
-			if ($backend instanceof ICountUsersBackend || $backend->implementsActions(Backend::COUNT_USERS)) {
-				/** @var ICountUsersBackend|IUserBackend $backend */
-				$backendUsers = $backend->countUsers();
-				if ($backendUsers !== false) {
-					if ($backend instanceof IUserBackend) {
-						$name = $backend->getBackendName();
-					} else {
-						$name = get_class($backend);
-					}
-					if (isset($userCountStatistics[$name])) {
-						$userCountStatistics[$name] += $backendUsers;
-					} else {
-						$userCountStatistics[$name] = $backendUsers;
-					}
-				}
-			}
-		}
-		return $userCountStatistics;
-	}
-
-	public function countUsersTotal(int $limit = 0, bool $onlyMappedUsers = false): int|false {
-		$userCount = false;
-
-		foreach ($this->backends as $backend) {
-			if ($onlyMappedUsers && $backend instanceof ICountMappedUsersBackend) {
-				$backendUsers = $backend->countMappedUsers();
-			} elseif ($backend instanceof ILimitAwareCountUsersBackend) {
-				$backendUsers = $backend->countUsers($limit);
-			} elseif ($backend instanceof ICountUsersBackend || $backend->implementsActions(Backend::COUNT_USERS)) {
-				/** @var ICountUsersBackend $backend */
-				$backendUsers = $backend->countUsers();
-			} else {
-				$this->logger->debug('Skip backend for user count: ' . get_class($backend));
-				continue;
-			}
-			if ($backendUsers !== false) {
-				$userCount = (int)$userCount + $backendUsers;
-				if ($limit > 0) {
-					if ($userCount >= $limit) {
-						break;
-					}
-					$limit -= $userCount;
-				}
-			} else {
-				$this->logger->warning('Can not determine user count for ' . get_class($backend));
-			}
-		}
-		return $userCount;
-	}
-
-	/**
-	 * returns how many users per backend exist in the requested groups (if supported by backend)
-	 *
-	 * @param IGroup[] $groups an array of groups to search in
-	 * @param int $limit limit to stop counting
-	 * @return array{int,int} total number of users, and number of disabled users in the given groups, below $limit. If limit is reached, -1 is returned for number of disabled users
-	 */
-	public function countUsersAndDisabledUsersOfGroups(array $groups, int $limit): array {
-		$users = [];
-		$disabled = [];
-		foreach ($groups as $group) {
-			foreach ($group->getUsers() as $user) {
-				$users[$user->getUID()] = 1;
-				if (!$user->isEnabled()) {
-					$disabled[$user->getUID()] = 1;
-				}
-				if (count($users) >= $limit) {
-					return [count($users),-1];
-				}
-			}
-		}
-		return [count($users),count($disabled)];
-	}
-
-	/**
-	 * The callback is executed for each user on each backend.
-	 * If the callback returns false no further users will be retrieved.
-	 *
-	 * @psalm-param \Closure(\OCP\IUser):?bool $callback
-	 * @param string $search
-	 * @param boolean $onlySeen when true only users that have a lastLogin entry
-	 *                          in the preferences table will be affected
-	 * @since 9.0.0
-	 */
-	public function callForAllUsers(\Closure $callback, $search = '', $onlySeen = false) {
-		if ($onlySeen) {
-			$this->callForSeenUsers($callback);
-		} else {
-			foreach ($this->getBackends() as $backend) {
-				$limit = 500;
-				$offset = 0;
-				do {
-					$users = $backend->getUsers($search, $limit, $offset);
-					foreach ($users as $uid) {
-						if (!$backend->userExists($uid)) {
-							continue;
-						}
-						$user = $this->getUserObject($uid, $backend, false);
-						$return = $callback($user);
-						if ($return === false) {
-							break;
-						}
-					}
-					$offset += $limit;
-				} while (count($users) >= $limit);
-			}
-		}
-	}
-
-	/**
-	 * returns how many users are disabled
-	 *
-	 * @return int
-	 * @since 12.0.0
-	 */
-	public function countDisabledUsers(): int {
-		$queryBuilder = Server::get(IDBConnection::class)->getQueryBuilder();
-		$queryBuilder->select($queryBuilder->func()->count('*'))
-			->from('preferences')
-			->where($queryBuilder->expr()->eq('appid', $queryBuilder->createNamedParameter('core')))
-			->andWhere($queryBuilder->expr()->eq('configkey', $queryBuilder->createNamedParameter('enabled')))
-			->andWhere($queryBuilder->expr()->eq('configvalue', $queryBuilder->createNamedParameter('false'), IQueryBuilder::PARAM_STR));
-
-
-		$result = $queryBuilder->executeQuery();
-		$count = $result->fetchOne();
-		$result->closeCursor();
-
-		if ($count !== false) {
-			$count = (int)$count;
-		} else {
-			$count = 0;
-		}
-
-		return $count;
-	}
-
-	/**
-	 * returns how many users have logged in once
-	 *
-	 * @return int
-	 * @since 11.0.0
-	 */
-	public function countSeenUsers() {
-		$queryBuilder = Server::get(IDBConnection::class)->getQueryBuilder();
-		$queryBuilder->select($queryBuilder->func()->count('*'))
-			->from('preferences')
-			->where($queryBuilder->expr()->eq('appid', $queryBuilder->createNamedParameter('login')))
-			->andWhere($queryBuilder->expr()->eq('configkey', $queryBuilder->createNamedParameter('lastLogin')));
-
-		$query = $queryBuilder->executeQuery();
-
-		$result = (int)$query->fetchOne();
-		$query->closeCursor();
-
-		return $result;
-	}
-
-	public function callForSeenUsers(\Closure $callback) {
-		$users = $this->getSeenUsers();
-		foreach ($users as $user) {
-			$return = $callback($user);
-			if ($return === false) {
-				return;
-			}
-		}
-	}
-
-	/**
-	 * Getting all userIds that have a lastLogin value requires checking the
-	 * value in php because on oracle you cannot use a clob in a where clause,
-	 * preventing us from doing a not null or length(value) > 0 check.
-	 *
-	 * @param int $limit
-	 * @param int $offset
-	 * @return string[] with user ids
-	 */
-	private function getSeenUserIds($limit = null, $offset = null) {
-		$queryBuilder = Server::get(IDBConnection::class)->getQueryBuilder();
-		$queryBuilder->select(['userid'])
-			->from('preferences')
-			->where($queryBuilder->expr()->eq(
-				'appid', $queryBuilder->createNamedParameter('login'))
-			)
-			->andWhere($queryBuilder->expr()->eq(
-				'configkey', $queryBuilder->createNamedParameter('lastLogin'))
-			)
-			->andWhere($queryBuilder->expr()->isNotNull('configvalue')
-			);
-
-		if ($limit !== null) {
-			$queryBuilder->setMaxResults($limit);
-		}
-		if ($offset !== null) {
-			$queryBuilder->setFirstResult($offset);
-		}
-		$query = $queryBuilder->executeQuery();
-		$result = [];
-
-		while ($row = $query->fetch()) {
-			$result[] = $row['userid'];
-		}
-
-		$query->closeCursor();
-
-		return $result;
-	}
-
-	/**
-	 * @param string $email
-	 * @return IUser[]
-	 * @since 9.1.0
-	 */
-	public function getByEmail($email) {
-		// looking for 'email' only (and not primary_mail) is intentional
-		$userIds = $this->config->getUsersForUserValueCaseInsensitive('settings', 'email', $email);
-
-		$users = array_map(function ($uid) {
-			return $this->get($uid);
-		}, $userIds);
-
-		return array_values(array_filter($users, function ($u) {
-			return ($u instanceof IUser);
-		}));
-	}
-
-	/**
-	 * @param string $uid
-	 * @param bool $checkDataDirectory
-	 * @throws \InvalidArgumentException Message is an already translated string with a reason why the id is not valid
-	 * @since 26.0.0
-	 */
-	public function validateUserId(string $uid, bool $checkDataDirectory = false): void {
-		$l = Server::get(IFactory::class)->get('lib');
-
-		// Check the ID for bad characters
-		// Allowed are: "a-z", "A-Z", "0-9", spaces and "_.@-'"
-		if (preg_match('/[^a-zA-Z0-9 _.@\-\']/', $uid)) {
-			throw new \InvalidArgumentException($l->t('Only the following characters are allowed in an Login:'
-				. ' "a-z", "A-Z", "0-9", spaces and "_.@-\'"'));
-		}
-
-		// No empty user ID
-		if (trim($uid) === '') {
-			throw new \InvalidArgumentException($l->t('A valid Login must be provided'));
-		}
-
-		// No whitespace at the beginning or at the end
-		if (trim($uid) !== $uid) {
-			throw new \InvalidArgumentException($l->t('Login contains whitespace at the beginning or at the end'));
-		}
-
-		// User ID only consists of 1 or 2 dots (directory traversal)
-		if ($uid === '.' || $uid === '..') {
-			throw new \InvalidArgumentException($l->t('Login must not consist of dots only'));
-		}
-
-		// User ID is too long
-		if (strlen($uid) > IUser::MAX_USERID_LENGTH) {
-			// TRANSLATORS User ID is too long
-			throw new \InvalidArgumentException($l->t('Username is too long'));
-		}
-
-		if (!$this->verifyUid($uid, $checkDataDirectory)) {
-			throw new \InvalidArgumentException($l->t('Login is invalid because files already exist for this user'));
-		}
-	}
-
-	/**
-	 * Gets the list of user ids sorted by lastLogin, from most recent to least recent
-	 *
-	 * @param int|null $limit how many users to fetch (default: 25, max: 100)
-	 * @param int $offset from which offset to fetch
-	 * @param string $search search users based on search params
-	 * @return list<string> list of user IDs
-	 */
-	public function getLastLoggedInUsers(?int $limit = null, int $offset = 0, string $search = ''): array {
-		// We can't load all users who already logged in
-		$limit = min(100, $limit ?: 25);
-
-		$connection = Server::get(IDBConnection::class);
-		$queryBuilder = $connection->getQueryBuilder();
-		$queryBuilder->select('pref_login.userid')
-			->from('preferences', 'pref_login')
-			->where($queryBuilder->expr()->eq('pref_login.appid', $queryBuilder->expr()->literal('login')))
-			->andWhere($queryBuilder->expr()->eq('pref_login.configkey', $queryBuilder->expr()->literal('lastLogin')))
-			->setFirstResult($offset)
-			->setMaxResults($limit)
-		;
-
-		// Oracle don't want to run ORDER BY on CLOB column
-		$loginOrder = $connection->getDatabaseProvider() === IDBConnection::PLATFORM_ORACLE
-			? $queryBuilder->expr()->castColumn('pref_login.configvalue', IQueryBuilder::PARAM_INT)
-			: 'pref_login.configvalue';
-		$queryBuilder
-			->orderBy($loginOrder, 'DESC')
-			->addOrderBy($queryBuilder->func()->lower('pref_login.userid'), 'ASC');
-
-		if ($search !== '') {
-			$displayNameMatches = $this->searchDisplayName($search);
-			$matchedUids = array_map(static fn (IUser $u): string => $u->getUID(), $displayNameMatches);
-
-			$queryBuilder
-				->leftJoin('pref_login', 'preferences', 'pref_email', $queryBuilder->expr()->andX(
-					$queryBuilder->expr()->eq('pref_login.userid', 'pref_email.userid'),
-					$queryBuilder->expr()->eq('pref_email.appid', $queryBuilder->expr()->literal('settings')),
-					$queryBuilder->expr()->eq('pref_email.configkey', $queryBuilder->expr()->literal('email')),
-				))
-				->andWhere($queryBuilder->expr()->orX(
-					$queryBuilder->expr()->in('pref_login.userid', $queryBuilder->createNamedParameter($matchedUids, IQueryBuilder::PARAM_STR_ARRAY)),
-				));
-		}
-
-		/** @var list<string> */
-		$list = $queryBuilder->executeQuery()->fetchAll(\PDO::FETCH_COLUMN);
-
-		return $list;
-	}
-
-	private function verifyUid(string $uid, bool $checkDataDirectory = false): bool {
-		$appdata = 'appdata_' . $this->config->getSystemValueString('instanceid');
-
-		if (\in_array($uid, [
-			'.htaccess',
-			'files_external',
-			'__groupfolders',
-			'.ncdata',
-			'owncloud.log',
-			'nextcloud.log',
-			'updater.log',
-			'audit.log',
-			$appdata], true)) {
-			return false;
-		}
-
-		if (!$checkDataDirectory) {
-			return true;
-		}
-
-		$dataDirectory = $this->config->getSystemValueString('datadirectory', \OC::$SERVERROOT . '/data');
-
-		return !file_exists(rtrim($dataDirectory, '/') . '/' . $uid);
-	}
-
-	public function getDisplayNameCache(): DisplayNameCache {
-		return $this->displayNameCache;
-	}
-
-	public function getSeenUsers(int $offset = 0, ?int $limit = null): \Iterator {
-		$maxBatchSize = 1000;
-
-		do {
-			if ($limit !== null) {
-				$batchSize = min($limit, $maxBatchSize);
-				$limit -= $batchSize;
-			} else {
-				$batchSize = $maxBatchSize;
-			}
-
-			$userIds = $this->getSeenUserIds($batchSize, $offset);
-			$offset += $batchSize;
-
-			foreach ($userIds as $userId) {
-				foreach ($this->backends as $backend) {
-					if ($backend->userExists($userId)) {
-						$user = new LazyUser($userId, $this, null, $backend);
-						yield $user;
-						break;
-					}
-				}
-			}
-		} while (count($userIds) === $batchSize && $limit !== 0);
-	}
+    /**
+     * @var UserInterface[] $backends
+     */
+    private array $backends = [];
+
+    /**
+     * @var array<string,\OC\User\User> $cachedUsers
+     */
+    private array $cachedUsers = [];
+
+    private ICache $cache;
+
+    private DisplayNameCache $displayNameCache;
+
+    public function __construct(
+        private IConfig $config,
+        ICacheFactory $cacheFactory,
+        private IEventDispatcher $eventDispatcher,
+        private LoggerInterface $logger,
+    ) {
+        $this->cache = new WithLocalCache($cacheFactory->createDistributed('user_backend_map'));
+        $this->listen('\OC\User', 'postDelete', function (IUser $user): void {
+            unset($this->cachedUsers[$user->getUID()]);
+        });
+        $this->displayNameCache = new DisplayNameCache($cacheFactory, $this);
+    }
+
+    /**
+     * Get the active backends
+     * @return UserInterface[]
+     */
+    public function getBackends(): array {
+        return $this->backends;
+    }
+
+    public function registerBackend(UserInterface $backend): void {
+        $this->backends[] = $backend;
+    }
+
+    public function removeBackend(UserInterface $backend): void {
+        $this->cachedUsers = [];
+        if (($i = array_search($backend, $this->backends)) !== false) {
+            unset($this->backends[$i]);
+        }
+    }
+
+    public function clearBackends(): void {
+        $this->cachedUsers = [];
+        $this->backends = [];
+    }
+
+    /**
+     * get a user by user id
+     *
+     * @param string $uid
+     * @return \OC\User\User|null Either the user or null if the specified user does not exist
+     */
+    public function get($uid) {
+        if (is_null($uid) || $uid === '' || $uid === false) {
+            return null;
+        }
+        if (isset($this->cachedUsers[$uid])) { //check the cache first to prevent having to loop over the backends
+            return $this->cachedUsers[$uid];
+        }
+
+        if (strlen($uid) > IUser::MAX_USERID_LENGTH) {
+            return null;
+        }
+
+        $cachedBackend = $this->cache->get(sha1($uid));
+        if ($cachedBackend !== null && isset($this->backends[$cachedBackend])) {
+            // Cache has the info of the user backend already, so ask that one directly
+            $backend = $this->backends[$cachedBackend];
+            if ($backend->userExists($uid)) {
+                return $this->getUserObject($uid, $backend);
+            }
+        }
+
+        foreach ($this->backends as $i => $backend) {
+            if ($i === $cachedBackend) {
+                // Tried that one already
+                continue;
+            }
+
+            if ($backend->userExists($uid)) {
+                // Hash $uid to ensure that only valid characters are used for the cache key
+                $this->cache->set(sha1($uid), $i, 300);
+                return $this->getUserObject($uid, $backend);
+            }
+        }
+        return null;
+    }
+
+    public function getDisplayName(string $uid): ?string {
+        return $this->displayNameCache->getDisplayName($uid);
+    }
+
+    /**
+     * get or construct the user object
+     *
+     * @param string $uid
+     * @param \OCP\UserInterface $backend
+     * @param bool $cacheUser If false the newly created user object will not be cached
+     * @return \OC\User\User
+     */
+    public function getUserObject($uid, $backend, $cacheUser = true) {
+        if ($backend instanceof IGetRealUIDBackend) {
+            $uid = $backend->getRealUID($uid);
+        }
+
+        if (isset($this->cachedUsers[$uid])) {
+            return $this->cachedUsers[$uid];
+        }
+
+        $user = new User($uid, $backend, $this->eventDispatcher, $this, $this->config);
+        if ($cacheUser) {
+            $this->cachedUsers[$uid] = $user;
+        }
+        return $user;
+    }
+
+    /**
+     * check if a user exists
+     *
+     * @param string $uid
+     * @return bool
+     */
+    public function userExists($uid) {
+        if (strlen($uid) > IUser::MAX_USERID_LENGTH) {
+            return false;
+        }
+
+        $user = $this->get($uid);
+        return ($user !== null);
+    }
+
+    /**
+     * Check if the password is valid for the user
+     *
+     * @param string $loginName
+     * @param string $password
+     * @return IUser|false the User object on success, false otherwise
+     */
+    public function checkPassword($loginName, $password) {
+        $result = $this->checkPasswordNoLogging($loginName, $password);
+
+        if ($result === false) {
+            $this->logger->warning('Login failed: \'' . $loginName . '\' (Remote IP: \'' . \OC::$server->getRequest()->getRemoteAddress() . '\')', ['app' => 'core']);
+        }
+
+        return $result;
+    }
+
+    /**
+     * Check if the password is valid for the user
+     *
+     * @internal
+     * @param string $loginName
+     * @param string $password
+     * @return IUser|false the User object on success, false otherwise
+     */
+    public function checkPasswordNoLogging($loginName, $password) {
+        $loginName = str_replace("\0", '', $loginName);
+        $password = str_replace("\0", '', $password);
+
+        $cachedBackend = $this->cache->get($loginName);
+        if ($cachedBackend !== null && isset($this->backends[$cachedBackend])) {
+            $backends = [$this->backends[$cachedBackend]];
+        } else {
+            $backends = $this->backends;
+        }
+        foreach ($backends as $backend) {
+            if ($backend instanceof ICheckPasswordBackend || $backend->implementsActions(Backend::CHECK_PASSWORD)) {
+                /** @var ICheckPasswordBackend $backend */
+                $uid = $backend->checkPassword($loginName, $password);
+                if ($uid !== false) {
+                    return $this->getUserObject($uid, $backend);
+                }
+            }
+        }
+
+        // since http basic auth doesn't provide a standard way of handling non ascii password we allow password to be urlencoded
+        // we only do this decoding after using the plain password fails to maintain compatibility with any password that happens
+        // to contain urlencoded patterns by "accident".
+        $password = urldecode($password);
+
+        foreach ($backends as $backend) {
+            if ($backend instanceof ICheckPasswordBackend || $backend->implementsActions(Backend::CHECK_PASSWORD)) {
+                /** @var ICheckPasswordBackend|UserInterface $backend */
+                $uid = $backend->checkPassword($loginName, $password);
+                if ($uid !== false) {
+                    return $this->getUserObject($uid, $backend);
+                }
+            }
+        }
+
+        return false;
+    }
+
+    public function search($pattern, $limit = null, $offset = null) {
+        $users = [];
+        foreach ($this->backends as $backend) {
+            $backendUsers = $backend->getUsers($pattern, $limit, $offset);
+            if (is_array($backendUsers)) {
+                foreach ($backendUsers as $uid) {
+                    $users[$uid] = new LazyUser($uid, $this, null, $backend);
+                }
+            }
+        }
+
+        uasort($users, function (IUser $a, IUser $b) {
+            return strcasecmp($a->getUID(), $b->getUID());
+        });
+        return $users;
+    }
+
+    public function searchDisplayName($pattern, $limit = null, $offset = null) {
+        $users = [];
+        foreach ($this->backends as $backend) {
+            $backendUsers = $backend->getDisplayNames($pattern, $limit, $offset);
+            if (is_array($backendUsers)) {
+                foreach ($backendUsers as $uid => $displayName) {
+                    $users[] = new LazyUser($uid, $this, $displayName, $backend);
+                }
+            }
+        }
+
+        usort($users, function (IUser $a, IUser $b) {
+            return strcasecmp($a->getDisplayName(), $b->getDisplayName());
+        });
+        return $users;
+    }
+
+    /**
+     * @return IUser[]
+     */
+    public function getDisabledUsers(?int $limit = null, int $offset = 0, string $search = ''): array {
+        $users = $this->config->getUsersForUserValue('core', 'enabled', 'false');
+        $users = array_combine(
+            $users,
+            array_map(
+                fn (string $uid): IUser => new LazyUser($uid, $this),
+                $users
+            )
+        );
+        if ($search !== '') {
+            $users = array_filter(
+                $users,
+                function (IUser $user) use ($search): bool {
+                    try {
+                        return mb_stripos($user->getUID(), $search) !== false
+                        || mb_stripos($user->getDisplayName(), $search) !== false
+                        || mb_stripos($user->getEMailAddress() ?? '', $search) !== false;
+                    } catch (NoUserException $ex) {
+                        $this->logger->error('Error while filtering disabled users', ['exception' => $ex, 'userUID' => $user->getUID()]);
+                        return false;
+                    }
+                });
+        }
+
+        $tempLimit = ($limit === null ? null : $limit + $offset);
+        foreach ($this->backends as $backend) {
+            if (($tempLimit !== null) && (count($users) >= $tempLimit)) {
+                break;
+            }
+            if ($backend instanceof IProvideEnabledStateBackend) {
+                $backendUsers = $backend->getDisabledUserList(($tempLimit === null ? null : $tempLimit - count($users)), 0, $search);
+                foreach ($backendUsers as $uid) {
+                    $users[$uid] = new LazyUser($uid, $this, null, $backend);
+                }
+            }
+        }
+
+        return array_slice($users, $offset, $limit);
+    }
+
+    /**
+     * Search known users (from phonebook sync) by displayName
+     *
+     * @param string $searcher
+     * @param string $pattern
+     * @param int|null $limit
+     * @param int|null $offset
+     * @return IUser[]
+     */
+    public function searchKnownUsersByDisplayName(string $searcher, string $pattern, ?int $limit = null, ?int $offset = null): array {
+        $users = [];
+        foreach ($this->backends as $backend) {
+            if ($backend instanceof ISearchKnownUsersBackend) {
+                $backendUsers = $backend->searchKnownUsersByDisplayName($searcher, $pattern, $limit, $offset);
+            } else {
+                // Better than nothing, but filtering after pagination can remove lots of results.
+                $backendUsers = $backend->getDisplayNames($pattern, $limit, $offset);
+            }
+            if (is_array($backendUsers)) {
+                foreach ($backendUsers as $uid => $displayName) {
+                    $users[] = $this->getUserObject($uid, $backend);
+                }
+            }
+        }
+
+        usort($users, function ($a, $b) {
+            /**
+             * @var IUser $a
+             * @var IUser $b
+             */
+            return strcasecmp($a->getDisplayName(), $b->getDisplayName());
+        });
+        return $users;
+    }
+
+    /**
+     * @param string $uid
+     * @param string $password
+     * @return false|IUser the created user or false
+     * @throws \InvalidArgumentException
+     * @throws HintException
+     */
+    public function createUser($uid, $password) {
+        // DI injection is not used here as IRegistry needs the user manager itself for user count and thus it would create a cyclic dependency
+        /** @var IAssertion $assertion */
+        $assertion = \OC::$server->get(IAssertion::class);
+        $assertion->createUserIsLegit();
+
+        $localBackends = [];
+        foreach ($this->backends as $backend) {
+            if ($backend instanceof Database) {
+                // First check if there is another user backend
+                $localBackends[] = $backend;
+                continue;
+            }
+
+            if ($backend->implementsActions(Backend::CREATE_USER)) {
+                return $this->createUserFromBackend($uid, $password, $backend);
+            }
+        }
+
+        foreach ($localBackends as $backend) {
+            if ($backend->implementsActions(Backend::CREATE_USER)) {
+                return $this->createUserFromBackend($uid, $password, $backend);
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * @param string $uid
+     * @param string $password
+     * @param UserInterface $backend
+     * @return IUser|false
+     * @throws \InvalidArgumentException
+     */
+    public function createUserFromBackend($uid, $password, UserInterface $backend) {
+        $l = \OCP\Util::getL10N('lib');
+
+        $this->validateUserId($uid, true);
+
+        // No empty password
+        if (trim($password) === '') {
+            throw new \InvalidArgumentException($l->t('A valid password must be provided'));
+        }
+
+        // Check if user already exists
+        if ($this->userExists($uid)) {
+            throw new \InvalidArgumentException($l->t('The Login is already being used'));
+        }
+
+        /** @deprecated 21.0.0 use BeforeUserCreatedEvent event with the IEventDispatcher instead */
+        $this->emit('\OC\User', 'preCreateUser', [$uid, $password]);
+        $this->eventDispatcher->dispatchTyped(new BeforeUserCreatedEvent($uid, $password));
+        $state = $backend->createUser($uid, $password);
+        if ($state === false) {
+            throw new \InvalidArgumentException($l->t('Could not create account'));
+        }
+        $user = $this->getUserObject($uid, $backend);
+        if ($user instanceof IUser) {
+            /** @deprecated 21.0.0 use UserCreatedEvent event with the IEventDispatcher instead */
+            $this->emit('\OC\User', 'postCreateUser', [$user, $password]);
+            $this->eventDispatcher->dispatchTyped(new UserCreatedEvent($user, $password));
+            return $user;
+        }
+        return false;
+    }
+
+    /**
+     * returns how many users per backend exist (if supported by backend)
+     *
+     * @param boolean $hasLoggedIn when true only users that have a lastLogin
+     *                             entry in the preferences table will be affected
+     * @return array<string, int> an array of backend class as key and count number as value
+     */
+    public function countUsers() {
+        $userCountStatistics = [];
+        foreach ($this->backends as $backend) {
+            if ($backend instanceof ICountUsersBackend || $backend->implementsActions(Backend::COUNT_USERS)) {
+                /** @var ICountUsersBackend|IUserBackend $backend */
+                $backendUsers = $backend->countUsers();
+                if ($backendUsers !== false) {
+                    if ($backend instanceof IUserBackend) {
+                        $name = $backend->getBackendName();
+                    } else {
+                        $name = get_class($backend);
+                    }
+                    if (isset($userCountStatistics[$name])) {
+                        $userCountStatistics[$name] += $backendUsers;
+                    } else {
+                        $userCountStatistics[$name] = $backendUsers;
+                    }
+                }
+            }
+        }
+        return $userCountStatistics;
+    }
+
+    public function countUsersTotal(int $limit = 0, bool $onlyMappedUsers = false): int|false {
+        $userCount = false;
+
+        foreach ($this->backends as $backend) {
+            if ($onlyMappedUsers && $backend instanceof ICountMappedUsersBackend) {
+                $backendUsers = $backend->countMappedUsers();
+            } elseif ($backend instanceof ILimitAwareCountUsersBackend) {
+                $backendUsers = $backend->countUsers($limit);
+            } elseif ($backend instanceof ICountUsersBackend || $backend->implementsActions(Backend::COUNT_USERS)) {
+                /** @var ICountUsersBackend $backend */
+                $backendUsers = $backend->countUsers();
+            } else {
+                $this->logger->debug('Skip backend for user count: ' . get_class($backend));
+                continue;
+            }
+            if ($backendUsers !== false) {
+                $userCount = (int)$userCount + $backendUsers;
+                if ($limit > 0) {
+                    if ($userCount >= $limit) {
+                        break;
+                    }
+                    $limit -= $userCount;
+                }
+            } else {
+                $this->logger->warning('Can not determine user count for ' . get_class($backend));
+            }
+        }
+        return $userCount;
+    }
+
+    /**
+     * returns how many users per backend exist in the requested groups (if supported by backend)
+     *
+     * @param IGroup[] $groups an array of groups to search in
+     * @param int $limit limit to stop counting
+     * @return array{int,int} total number of users, and number of disabled users in the given groups, below $limit. If limit is reached, -1 is returned for number of disabled users
+     */
+    public function countUsersAndDisabledUsersOfGroups(array $groups, int $limit): array {
+        $users = [];
+        $disabled = [];
+        foreach ($groups as $group) {
+            foreach ($group->getUsers() as $user) {
+                $users[$user->getUID()] = 1;
+                if (!$user->isEnabled()) {
+                    $disabled[$user->getUID()] = 1;
+                }
+                if (count($users) >= $limit) {
+                    return [count($users),-1];
+                }
+            }
+        }
+        return [count($users),count($disabled)];
+    }
+
+    /**
+     * The callback is executed for each user on each backend.
+     * If the callback returns false no further users will be retrieved.
+     *
+     * @psalm-param \Closure(\OCP\IUser):?bool $callback
+     * @param string $search
+     * @param boolean $onlySeen when true only users that have a lastLogin entry
+     *                          in the preferences table will be affected
+     * @since 9.0.0
+     */
+    public function callForAllUsers(\Closure $callback, $search = '', $onlySeen = false) {
+        if ($onlySeen) {
+            $this->callForSeenUsers($callback);
+        } else {
+            foreach ($this->getBackends() as $backend) {
+                $limit = 500;
+                $offset = 0;
+                do {
+                    $users = $backend->getUsers($search, $limit, $offset);
+                    foreach ($users as $uid) {
+                        if (!$backend->userExists($uid)) {
+                            continue;
+                        }
+                        $user = $this->getUserObject($uid, $backend, false);
+                        $return = $callback($user);
+                        if ($return === false) {
+                            break;
+                        }
+                    }
+                    $offset += $limit;
+                } while (count($users) >= $limit);
+            }
+        }
+    }
+
+    /**
+     * returns how many users are disabled
+     *
+     * @return int
+     * @since 12.0.0
+     */
+    public function countDisabledUsers(): int {
+        $queryBuilder = Server::get(IDBConnection::class)->getQueryBuilder();
+        $queryBuilder->select($queryBuilder->func()->count('*'))
+            ->from('preferences')
+            ->where($queryBuilder->expr()->eq('appid', $queryBuilder->createNamedParameter('core')))
+            ->andWhere($queryBuilder->expr()->eq('configkey', $queryBuilder->createNamedParameter('enabled')))
+            ->andWhere($queryBuilder->expr()->eq('configvalue', $queryBuilder->createNamedParameter('false'), IQueryBuilder::PARAM_STR));
+
+
+        $result = $queryBuilder->executeQuery();
+        $count = $result->fetchOne();
+        $result->closeCursor();
+
+        if ($count !== false) {
+            $count = (int)$count;
+        } else {
+            $count = 0;
+        }
+
+        return $count;
+    }
+
+    /**
+     * returns how many users have logged in once
+     *
+     * @return int
+     * @since 11.0.0
+     */
+    public function countSeenUsers() {
+        $queryBuilder = Server::get(IDBConnection::class)->getQueryBuilder();
+        $queryBuilder->select($queryBuilder->func()->count('*'))
+            ->from('preferences')
+            ->where($queryBuilder->expr()->eq('appid', $queryBuilder->createNamedParameter('login')))
+            ->andWhere($queryBuilder->expr()->eq('configkey', $queryBuilder->createNamedParameter('lastLogin')));
+
+        $query = $queryBuilder->executeQuery();
+
+        $result = (int)$query->fetchOne();
+        $query->closeCursor();
+
+        return $result;
+    }
+
+    public function callForSeenUsers(\Closure $callback) {
+        $users = $this->getSeenUsers();
+        foreach ($users as $user) {
+            $return = $callback($user);
+            if ($return === false) {
+                return;
+            }
+        }
+    }
+
+    /**
+     * Getting all userIds that have a lastLogin value requires checking the
+     * value in php because on oracle you cannot use a clob in a where clause,
+     * preventing us from doing a not null or length(value) > 0 check.
+     *
+     * @param int $limit
+     * @param int $offset
+     * @return string[] with user ids
+     */
+    private function getSeenUserIds($limit = null, $offset = null) {
+        $queryBuilder = Server::get(IDBConnection::class)->getQueryBuilder();
+        $queryBuilder->select(['userid'])
+            ->from('preferences')
+            ->where($queryBuilder->expr()->eq(
+                'appid', $queryBuilder->createNamedParameter('login'))
+            )
+            ->andWhere($queryBuilder->expr()->eq(
+                'configkey', $queryBuilder->createNamedParameter('lastLogin'))
+            )
+            ->andWhere($queryBuilder->expr()->isNotNull('configvalue')
+            );
+
+        if ($limit !== null) {
+            $queryBuilder->setMaxResults($limit);
+        }
+        if ($offset !== null) {
+            $queryBuilder->setFirstResult($offset);
+        }
+        $query = $queryBuilder->executeQuery();
+        $result = [];
+
+        while ($row = $query->fetch()) {
+            $result[] = $row['userid'];
+        }
+
+        $query->closeCursor();
+
+        return $result;
+    }
+
+    /**
+     * @param string $email
+     * @return IUser[]
+     * @since 9.1.0
+     */
+    public function getByEmail($email) {
+        // looking for 'email' only (and not primary_mail) is intentional
+        $userIds = $this->config->getUsersForUserValueCaseInsensitive('settings', 'email', $email);
+
+        $users = array_map(function ($uid) {
+            return $this->get($uid);
+        }, $userIds);
+
+        return array_values(array_filter($users, function ($u) {
+            return ($u instanceof IUser);
+        }));
+    }
+
+    /**
+     * @param string $uid
+     * @param bool $checkDataDirectory
+     * @throws \InvalidArgumentException Message is an already translated string with a reason why the id is not valid
+     * @since 26.0.0
+     */
+    public function validateUserId(string $uid, bool $checkDataDirectory = false): void {
+        $l = Server::get(IFactory::class)->get('lib');
+
+        // Check the ID for bad characters
+        // Allowed are: "a-z", "A-Z", "0-9", spaces and "_.@-'"
+        if (preg_match('/[^a-zA-Z0-9 _.@\-\']/', $uid)) {
+            throw new \InvalidArgumentException($l->t('Only the following characters are allowed in an Login:'
+                . ' "a-z", "A-Z", "0-9", spaces and "_.@-\'"'));
+        }
+
+        // No empty user ID
+        if (trim($uid) === '') {
+            throw new \InvalidArgumentException($l->t('A valid Login must be provided'));
+        }
+
+        // No whitespace at the beginning or at the end
+        if (trim($uid) !== $uid) {
+            throw new \InvalidArgumentException($l->t('Login contains whitespace at the beginning or at the end'));
+        }
+
+        // User ID only consists of 1 or 2 dots (directory traversal)
+        if ($uid === '.' || $uid === '..') {
+            throw new \InvalidArgumentException($l->t('Login must not consist of dots only'));
+        }
+
+        // User ID is too long
+        if (strlen($uid) > IUser::MAX_USERID_LENGTH) {
+            // TRANSLATORS User ID is too long
+            throw new \InvalidArgumentException($l->t('Username is too long'));
+        }
+
+        if (!$this->verifyUid($uid, $checkDataDirectory)) {
+            throw new \InvalidArgumentException($l->t('Login is invalid because files already exist for this user'));
+        }
+    }
+
+    /**
+     * Gets the list of user ids sorted by lastLogin, from most recent to least recent
+     *
+     * @param int|null $limit how many users to fetch (default: 25, max: 100)
+     * @param int $offset from which offset to fetch
+     * @param string $search search users based on search params
+     * @return list<string> list of user IDs
+     */
+    public function getLastLoggedInUsers(?int $limit = null, int $offset = 0, string $search = ''): array {
+        // We can't load all users who already logged in
+        $limit = min(100, $limit ?: 25);
+
+        $connection = Server::get(IDBConnection::class);
+        $queryBuilder = $connection->getQueryBuilder();
+        $queryBuilder->select('pref_login.userid')
+            ->from('preferences', 'pref_login')
+            ->where($queryBuilder->expr()->eq('pref_login.appid', $queryBuilder->expr()->literal('login')))
+            ->andWhere($queryBuilder->expr()->eq('pref_login.configkey', $queryBuilder->expr()->literal('lastLogin')))
+            ->setFirstResult($offset)
+            ->setMaxResults($limit)
+        ;
+
+        // Oracle don't want to run ORDER BY on CLOB column
+        $loginOrder = $connection->getDatabaseProvider() === IDBConnection::PLATFORM_ORACLE
+            ? $queryBuilder->expr()->castColumn('pref_login.configvalue', IQueryBuilder::PARAM_INT)
+            : 'pref_login.configvalue';
+        $queryBuilder
+            ->orderBy($loginOrder, 'DESC')
+            ->addOrderBy($queryBuilder->func()->lower('pref_login.userid'), 'ASC');
+
+        if ($search !== '') {
+            $displayNameMatches = $this->searchDisplayName($search);
+            $matchedUids = array_map(static fn (IUser $u): string => $u->getUID(), $displayNameMatches);
+
+            $queryBuilder
+                ->leftJoin('pref_login', 'preferences', 'pref_email', $queryBuilder->expr()->andX(
+                    $queryBuilder->expr()->eq('pref_login.userid', 'pref_email.userid'),
+                    $queryBuilder->expr()->eq('pref_email.appid', $queryBuilder->expr()->literal('settings')),
+                    $queryBuilder->expr()->eq('pref_email.configkey', $queryBuilder->expr()->literal('email')),
+                ))
+                ->andWhere($queryBuilder->expr()->orX(
+                    $queryBuilder->expr()->in('pref_login.userid', $queryBuilder->createNamedParameter($matchedUids, IQueryBuilder::PARAM_STR_ARRAY)),
+                ));
+        }
+
+        /** @var list<string> */
+        $list = $queryBuilder->executeQuery()->fetchAll(\PDO::FETCH_COLUMN);
+
+        return $list;
+    }
+
+    private function verifyUid(string $uid, bool $checkDataDirectory = false): bool {
+        $appdata = 'appdata_' . $this->config->getSystemValueString('instanceid');
+
+        if (\in_array($uid, [
+            '.htaccess',
+            'files_external',
+            '__groupfolders',
+            '.ncdata',
+            'owncloud.log',
+            'nextcloud.log',
+            'updater.log',
+            'audit.log',
+            $appdata], true)) {
+            return false;
+        }
+
+        if (!$checkDataDirectory) {
+            return true;
+        }
+
+        $dataDirectory = $this->config->getSystemValueString('datadirectory', \OC::$SERVERROOT . '/data');
+
+        return !file_exists(rtrim($dataDirectory, '/') . '/' . $uid);
+    }
+
+    public function getDisplayNameCache(): DisplayNameCache {
+        return $this->displayNameCache;
+    }
+
+    public function getSeenUsers(int $offset = 0, ?int $limit = null): \Iterator {
+        $maxBatchSize = 1000;
+
+        do {
+            if ($limit !== null) {
+                $batchSize = min($limit, $maxBatchSize);
+                $limit -= $batchSize;
+            } else {
+                $batchSize = $maxBatchSize;
+            }
+
+            $userIds = $this->getSeenUserIds($batchSize, $offset);
+            $offset += $batchSize;
+
+            foreach ($userIds as $userId) {
+                foreach ($this->backends as $backend) {
+                    if ($backend->userExists($userId)) {
+                        $user = new LazyUser($userId, $this, null, $backend);
+                        yield $user;
+                        break;
+                    }
+                }
+            }
+        } while (count($userIds) === $batchSize && $limit !== 0);
+    }
 }

apps/settings/lib/SetupChecks/MysqlRowFormat.php

Indentation +40 added lines, -40 removed lines

@@ -17,55 +17,55 @@
 use OCP\SetupCheck\SetupResult;
 
 class MysqlRowFormat implements ISetupCheck {
-	public function __construct(
-		private IL10N $l10n,
-		private IConfig $config,
-		private Connection $connection,
-		private IURLGenerator $urlGenerator,
-	) {
-	}
+    public function __construct(
+        private IL10N $l10n,
+        private IConfig $config,
+        private Connection $connection,
+        private IURLGenerator $urlGenerator,
+    ) {
+    }
 
-	public function getName(): string {
-		return $this->l10n->t('MySQL row format');
-	}
+    public function getName(): string {
+        return $this->l10n->t('MySQL row format');
+    }
 
-	public function getCategory(): string {
-		return 'database';
-	}
+    public function getCategory(): string {
+        return 'database';
+    }
 
-	public function run(): SetupResult {
-		if (!$this->connection->getDatabaseProvider() === IDBConnection::PLATFORM_MYSQL
-			&& !$this->connection->getDatabaseProvider() === IDBConnection::PLATFORM_MARIADB) {
-			return SetupResult::success($this->l10n->t('You are not using MySQL'));
-		}
+    public function run(): SetupResult {
+        if (!$this->connection->getDatabaseProvider() === IDBConnection::PLATFORM_MYSQL
+            && !$this->connection->getDatabaseProvider() === IDBConnection::PLATFORM_MARIADB) {
+            return SetupResult::success($this->l10n->t('You are not using MySQL'));
+        }
 
-		$wrongRowFormatTables = $this->getRowNotDynamicTables();
-		if (empty($wrongRowFormatTables)) {
-			return SetupResult::success($this->l10n->t('None of your tables use ROW_FORMAT=Compressed'));
-		}
+        $wrongRowFormatTables = $this->getRowNotDynamicTables();
+        if (empty($wrongRowFormatTables)) {
+            return SetupResult::success($this->l10n->t('None of your tables use ROW_FORMAT=Compressed'));
+        }
 
-		return SetupResult::warning(
-			$this->l10n->t(
-				'Incorrect row format found in your database. ROW_FORMAT=Dynamic offers the best database performances for Nextcloud. Please update row format on the following list: %s.',
-				[implode(', ', $wrongRowFormatTables)],
-			),
-			'https://dev.mysql.com/doc/refman/en/innodb-row-format.html',
-		);
-	}
+        return SetupResult::warning(
+            $this->l10n->t(
+                'Incorrect row format found in your database. ROW_FORMAT=Dynamic offers the best database performances for Nextcloud. Please update row format on the following list: %s.',
+                [implode(', ', $wrongRowFormatTables)],
+            ),
+            'https://dev.mysql.com/doc/refman/en/innodb-row-format.html',
+        );
+    }
 
-	/**
-	 * @return string[]
-	 */
-	private function getRowNotDynamicTables(): array {
-		$sql = "SELECT table_name
+    /**
+     * @return string[]
+     */
+    private function getRowNotDynamicTables(): array {
+        $sql = "SELECT table_name
 			FROM information_schema.tables
 			WHERE table_schema = ?
 			  AND table_name LIKE '*PREFIX*%'
 			  AND row_format != 'Dynamic';";
 
-		return $this->connection->executeQuery(
-			$sql,
-			[$this->config->getSystemValueString('dbname')],
-		)->fetchFirstColumn();
-	}
+        return $this->connection->executeQuery(
+            $sql,
+            [$this->config->getSystemValueString('dbname')],
+        )->fetchFirstColumn();
+    }
 }

apps/settings/lib/SetupChecks/SupportedDatabase.php

Indentation +98 added lines, -98 removed lines

@@ -16,106 +16,106 @@
 
 class SupportedDatabase implements ISetupCheck {
 
-	private const MIN_MARIADB = '10.6';
-	private const MAX_MARIADB = '11.8';
-	private const MIN_MYSQL = '8.0';
-	private const MAX_MYSQL = '8.4';
-	private const MIN_POSTGRES = '13';
-	private const MAX_POSTGRES = '17';
+    private const MIN_MARIADB = '10.6';
+    private const MAX_MARIADB = '11.8';
+    private const MIN_MYSQL = '8.0';
+    private const MAX_MYSQL = '8.4';
+    private const MIN_POSTGRES = '13';
+    private const MAX_POSTGRES = '17';
 
-	public function __construct(
-		private IL10N $l10n,
-		private IURLGenerator $urlGenerator,
-		private IDBConnection $connection,
-	) {
-	}
+    public function __construct(
+        private IL10N $l10n,
+        private IURLGenerator $urlGenerator,
+        private IDBConnection $connection,
+    ) {
+    }
 
-	public function getCategory(): string {
-		return 'database';
-	}
+    public function getCategory(): string {
+        return 'database';
+    }
 
-	public function getName(): string {
-		return $this->l10n->t('Database version');
-	}
+    public function getName(): string {
+        return $this->l10n->t('Database version');
+    }
 
-	public function run(): SetupResult {
-		$databasePlatform = $this->connection->getDatabaseProvider();
-		if ($databasePlatform === IDBConnection::PLATFORM_MYSQL || $databasePlatform === IDBConnection::PLATFORM_MARIADB) {
-			$statement = $this->connection->prepare("SHOW VARIABLES LIKE 'version';");
-			$result = $statement->execute();
-			$row = $result->fetch();
-			$version = $row['Value'];
-			$versionlc = strtolower($version);
-			// we only care about X.Y not X.Y.Z differences
-			[$major, $minor, ] = explode('.', $versionlc);
-			$versionConcern = $major . '.' . $minor;
-			if (str_contains($versionlc, 'mariadb')) {
-				if (version_compare($versionConcern, '10.3', '=')) {
-					return SetupResult::info(
-						$this->l10n->t(
-							'MariaDB version 10.3 detected, this version is end-of-life and only supported as part of Ubuntu 20.04. MariaDB >=%1$s and <=%2$s is suggested for best performance, stability and functionality with this version of Nextcloud.',
-							[
-								self::MIN_MARIADB,
-								self::MAX_MARIADB,
-							]
-						),
-					);
-				} elseif (version_compare($versionConcern, self::MIN_MARIADB, '<') || version_compare($versionConcern, self::MAX_MARIADB, '>')) {
-					return SetupResult::warning(
-						$this->l10n->t(
-							'MariaDB version "%1$s" detected. MariaDB >=%2$s and <=%3$s is suggested for best performance, stability and functionality with this version of Nextcloud.',
-							[
-								$version,
-								self::MIN_MARIADB,
-								self::MAX_MARIADB,
-							],
-						),
-					);
-				}
-			} else {
-				if (version_compare($versionConcern, self::MIN_MYSQL, '<') || version_compare($versionConcern, self::MAX_MYSQL, '>')) {
-					return SetupResult::warning(
-						$this->l10n->t(
-							'MySQL version "%1$s" detected. MySQL >=%2$s and <=%3$s is suggested for best performance, stability and functionality with this version of Nextcloud.',
-							[
-								$version,
-								self::MIN_MYSQL,
-								self::MAX_MYSQL,
-							],
-						),
-					);
-				}
-			}
-		} elseif ($databasePlatform === IDBConnection::PLATFORM_POSTGRES) {
-			$statement = $this->connection->prepare('SHOW server_version;');
-			$result = $statement->execute();
-			$row = $result->fetch();
-			$version = $row['server_version'];
-			$versionlc = strtolower($version);
-			// we only care about X not X.Y or X.Y.Z differences
-			[$major, ] = explode('.', $versionlc);
-			$versionConcern = $major;
-			if (version_compare($versionConcern, self::MIN_POSTGRES, '<') || version_compare($versionConcern, self::MAX_POSTGRES, '>')) {
-				return SetupResult::warning(
-					$this->l10n->t(
-						'PostgreSQL version "%1$s" detected. PostgreSQL >=%2$s and <=%3$s is suggested for best performance, stability and functionality with this version of Nextcloud.',
-						[
-							$version,
-							self::MIN_POSTGRES,
-							self::MAX_POSTGRES,
-						])
-				);
-			}
-		} elseif ($databasePlatform === IDBConnection::PLATFORM_ORACLE) {
-			$version = 'Oracle';
-		} elseif ($databasePlatform === IDBConnection::PLATFORM_SQLITE) {
-			return SetupResult::warning(
-				$this->l10n->t('SQLite is currently being used as the backend database. For larger installations we recommend that you switch to a different database backend. This is particularly recommended when using the desktop client for file synchronisation. To migrate to another database use the command line tool: "occ db:convert-type".'),
-				$this->urlGenerator->linkToDocs('admin-db-conversion')
-			);
-		} else {
-			return SetupResult::error($this->l10n->t('Unknown database platform'));
-		}
-		return SetupResult::success($version);
-	}
+    public function run(): SetupResult {
+        $databasePlatform = $this->connection->getDatabaseProvider();
+        if ($databasePlatform === IDBConnection::PLATFORM_MYSQL || $databasePlatform === IDBConnection::PLATFORM_MARIADB) {
+            $statement = $this->connection->prepare("SHOW VARIABLES LIKE 'version';");
+            $result = $statement->execute();
+            $row = $result->fetch();
+            $version = $row['Value'];
+            $versionlc = strtolower($version);
+            // we only care about X.Y not X.Y.Z differences
+            [$major, $minor, ] = explode('.', $versionlc);
+            $versionConcern = $major . '.' . $minor;
+            if (str_contains($versionlc, 'mariadb')) {
+                if (version_compare($versionConcern, '10.3', '=')) {
+                    return SetupResult::info(
+                        $this->l10n->t(
+                            'MariaDB version 10.3 detected, this version is end-of-life and only supported as part of Ubuntu 20.04. MariaDB >=%1$s and <=%2$s is suggested for best performance, stability and functionality with this version of Nextcloud.',
+                            [
+                                self::MIN_MARIADB,
+                                self::MAX_MARIADB,
+                            ]
+                        ),
+                    );
+                } elseif (version_compare($versionConcern, self::MIN_MARIADB, '<') || version_compare($versionConcern, self::MAX_MARIADB, '>')) {
+                    return SetupResult::warning(
+                        $this->l10n->t(
+                            'MariaDB version "%1$s" detected. MariaDB >=%2$s and <=%3$s is suggested for best performance, stability and functionality with this version of Nextcloud.',
+                            [
+                                $version,
+                                self::MIN_MARIADB,
+                                self::MAX_MARIADB,
+                            ],
+                        ),
+                    );
+                }
+            } else {
+                if (version_compare($versionConcern, self::MIN_MYSQL, '<') || version_compare($versionConcern, self::MAX_MYSQL, '>')) {
+                    return SetupResult::warning(
+                        $this->l10n->t(
+                            'MySQL version "%1$s" detected. MySQL >=%2$s and <=%3$s is suggested for best performance, stability and functionality with this version of Nextcloud.',
+                            [
+                                $version,
+                                self::MIN_MYSQL,
+                                self::MAX_MYSQL,
+                            ],
+                        ),
+                    );
+                }
+            }
+        } elseif ($databasePlatform === IDBConnection::PLATFORM_POSTGRES) {
+            $statement = $this->connection->prepare('SHOW server_version;');
+            $result = $statement->execute();
+            $row = $result->fetch();
+            $version = $row['server_version'];
+            $versionlc = strtolower($version);
+            // we only care about X not X.Y or X.Y.Z differences
+            [$major, ] = explode('.', $versionlc);
+            $versionConcern = $major;
+            if (version_compare($versionConcern, self::MIN_POSTGRES, '<') || version_compare($versionConcern, self::MAX_POSTGRES, '>')) {
+                return SetupResult::warning(
+                    $this->l10n->t(
+                        'PostgreSQL version "%1$s" detected. PostgreSQL >=%2$s and <=%3$s is suggested for best performance, stability and functionality with this version of Nextcloud.',
+                        [
+                            $version,
+                            self::MIN_POSTGRES,
+                            self::MAX_POSTGRES,
+                        ])
+                );
+            }
+        } elseif ($databasePlatform === IDBConnection::PLATFORM_ORACLE) {
+            $version = 'Oracle';
+        } elseif ($databasePlatform === IDBConnection::PLATFORM_SQLITE) {
+            return SetupResult::warning(
+                $this->l10n->t('SQLite is currently being used as the backend database. For larger installations we recommend that you switch to a different database backend. This is particularly recommended when using the desktop client for file synchronisation. To migrate to another database use the command line tool: "occ db:convert-type".'),
+                $this->urlGenerator->linkToDocs('admin-db-conversion')
+            );
+        } else {
+            return SetupResult::error($this->l10n->t('Unknown database platform'));
+        }
+        return SetupResult::success($version);
+    }
 }

apps/oauth2/tests/Db/ClientMapperTest.php

Indentation +51 added lines, -51 removed lines

@@ -17,66 +17,66 @@
  * @group DB
  */
 class ClientMapperTest extends TestCase {
-	/** @var ClientMapper */
-	private $clientMapper;
+    /** @var ClientMapper */
+    private $clientMapper;
 
-	protected function setUp(): void {
-		parent::setUp();
-		$this->clientMapper = new ClientMapper(Server::get(IDBConnection::class));
-	}
+    protected function setUp(): void {
+        parent::setUp();
+        $this->clientMapper = new ClientMapper(Server::get(IDBConnection::class));
+    }
 
-	protected function tearDown(): void {
-		$query = Server::get(IDBConnection::class)->getQueryBuilder();
-		$query->delete('oauth2_clients')->executeStatement();
+    protected function tearDown(): void {
+        $query = Server::get(IDBConnection::class)->getQueryBuilder();
+        $query->delete('oauth2_clients')->executeStatement();
 
-		parent::tearDown();
-	}
+        parent::tearDown();
+    }
 
-	public function testGetByIdentifier(): void {
-		$client = new Client();
-		$client->setClientIdentifier('MyAwesomeClientIdentifier');
-		$client->setName('Client Name');
-		$client->setRedirectUri('https://example.com/');
-		$client->setSecret('TotallyNotSecret');
-		$this->clientMapper->insert($client);
-		$client->resetUpdatedFields();
-		$this->assertEquals($client, $this->clientMapper->getByIdentifier('MyAwesomeClientIdentifier'));
-	}
+    public function testGetByIdentifier(): void {
+        $client = new Client();
+        $client->setClientIdentifier('MyAwesomeClientIdentifier');
+        $client->setName('Client Name');
+        $client->setRedirectUri('https://example.com/');
+        $client->setSecret('TotallyNotSecret');
+        $this->clientMapper->insert($client);
+        $client->resetUpdatedFields();
+        $this->assertEquals($client, $this->clientMapper->getByIdentifier('MyAwesomeClientIdentifier'));
+    }
 
-	public function testGetByIdentifierNotExisting(): void {
-		$this->expectException(ClientNotFoundException::class);
+    public function testGetByIdentifierNotExisting(): void {
+        $this->expectException(ClientNotFoundException::class);
 
-		$this->clientMapper->getByIdentifier('MyTotallyNotExistingClient');
-	}
+        $this->clientMapper->getByIdentifier('MyTotallyNotExistingClient');
+    }
 
-	public function testGetByUid(): void {
-		$client = new Client();
-		$client->setClientIdentifier('MyNewClient');
-		$client->setName('Client Name');
-		$client->setRedirectUri('https://example.com/');
-		$client->setSecret('TotallyNotSecret');
-		$this->clientMapper->insert($client);
-		$client->resetUpdatedFields();
-		$this->assertEquals($client, $this->clientMapper->getByUid($client->getId()));
-	}
+    public function testGetByUid(): void {
+        $client = new Client();
+        $client->setClientIdentifier('MyNewClient');
+        $client->setName('Client Name');
+        $client->setRedirectUri('https://example.com/');
+        $client->setSecret('TotallyNotSecret');
+        $this->clientMapper->insert($client);
+        $client->resetUpdatedFields();
+        $this->assertEquals($client, $this->clientMapper->getByUid($client->getId()));
+    }
 
-	public function testGetByUidNotExisting(): void {
-		$this->expectException(ClientNotFoundException::class);
+    public function testGetByUidNotExisting(): void {
+        $this->expectException(ClientNotFoundException::class);
 
-		$this->clientMapper->getByUid(1234);
-	}
+        $this->clientMapper->getByUid(1234);
+    }
 
-	public function testGetClients(): void {
-		$this->assertSame('array', gettype($this->clientMapper->getClients()));
-	}
+    public function testGetClients(): void {
+        $this->assertSame('array', gettype($this->clientMapper->getClients()));
+    }
 
-	public function testInsertLongEncryptedSecret(): void {
-		$client = new Client();
-		$client->setClientIdentifier('MyNewClient');
-		$client->setName('Client Name');
-		$client->setRedirectUri('https://example.com/');
-		$client->setSecret('b81dc8e2dc178817bf28ca7b37265aa96559ca02e6dcdeb74b42221d096ed5ef63681e836ae0ba1077b5fb5e6c2fa7748c78463f66fe0110c8dcb8dd7eb0305b16d0cd993e2ae275879994a2abf88c68|e466d9befa6b0102341458e45ecd551a|013af9e277374483123437f180a3b0371a411ad4f34c451547909769181a7d7cc191f0f5c2de78376d124dd7751b8c9660aabdd913f5e071fc6b819ba2e3d919|3');
-		$this->clientMapper->insert($client);
-		$this->assertTrue(true);
-	}
+    public function testInsertLongEncryptedSecret(): void {
+        $client = new Client();
+        $client->setClientIdentifier('MyNewClient');
+        $client->setName('Client Name');
+        $client->setRedirectUri('https://example.com/');
+        $client->setSecret('b81dc8e2dc178817bf28ca7b37265aa96559ca02e6dcdeb74b42221d096ed5ef63681e836ae0ba1077b5fb5e6c2fa7748c78463f66fe0110c8dcb8dd7eb0305b16d0cd993e2ae275879994a2abf88c68|e466d9befa6b0102341458e45ecd551a|013af9e277374483123437f180a3b0371a411ad4f34c451547909769181a7d7cc191f0f5c2de78376d124dd7751b8c9660aabdd913f5e071fc6b819ba2e3d919|3');
+        $this->clientMapper->insert($client);
+        $this->assertTrue(true);
+    }
 }

apps/workflowengine/tests/ManagerTest.php

Indentation +733 added lines, -733 removed lines

@@ -43,737 +43,737 @@
  * @group DB
  */
 class ManagerTest extends TestCase {
-	protected Manager $manager;
-	protected IDBConnection $db;
-	protected LoggerInterface&MockObject $logger;
-	protected ContainerInterface&MockObject $container;
-	protected IUserSession&MockObject $session;
-	protected IL10N&MockObject $l;
-	protected IEventDispatcher&MockObject $dispatcher;
-	protected IAppConfig&MockObject $config;
-	protected ICacheFactory&MockObject $cacheFactory;
-
-	protected function setUp(): void {
-		parent::setUp();
-
-		$this->db = Server::get(IDBConnection::class);
-		$this->container = $this->createMock(ContainerInterface::class);
-		$this->l = $this->createMock(IL10N::class);
-		$this->l->method('t')
-			->willReturnCallback(function ($text, $parameters = []) {
-				return vsprintf($text, $parameters);
-			});
-
-		$this->logger = $this->createMock(LoggerInterface::class);
-		$this->session = $this->createMock(IUserSession::class);
-		$this->dispatcher = $this->createMock(IEventDispatcher::class);
-		$this->config = $this->createMock(IAppConfig::class);
-		$this->cacheFactory = $this->createMock(ICacheFactory::class);
-
-		$this->manager = new Manager(
-			$this->db,
-			$this->container,
-			$this->l,
-			$this->logger,
-			$this->session,
-			$this->dispatcher,
-			$this->config,
-			$this->cacheFactory
-		);
-		$this->clearTables();
-	}
-
-	protected function tearDown(): void {
-		$this->clearTables();
-		parent::tearDown();
-	}
-
-	protected function buildScope(?string $scopeId = null): MockObject&ScopeContext {
-		$scopeContext = $this->createMock(ScopeContext::class);
-		$scopeContext->expects($this->any())
-			->method('getScope')
-			->willReturn($scopeId ? IManager::SCOPE_USER : IManager::SCOPE_ADMIN);
-		$scopeContext->expects($this->any())
-			->method('getScopeId')
-			->willReturn($scopeId ?? '');
-		$scopeContext->expects($this->any())
-			->method('getHash')
-			->willReturn(md5($scopeId ?? ''));
-
-		return $scopeContext;
-	}
-
-	public function clearTables() {
-		$query = $this->db->getQueryBuilder();
-		foreach (['flow_checks', 'flow_operations', 'flow_operations_scope'] as $table) {
-			$query->delete($table)
-				->executeStatement();
-		}
-	}
-
-	public function testChecks(): void {
-		$check1 = $this->invokePrivate($this->manager, 'addCheck', ['Test', 'equal', 1]);
-		$check2 = $this->invokePrivate($this->manager, 'addCheck', ['Test', '!equal', 2]);
-
-		$data = $this->manager->getChecks([$check1]);
-		$this->assertArrayHasKey($check1, $data);
-		$this->assertArrayNotHasKey($check2, $data);
-
-		$data = $this->manager->getChecks([$check1, $check2]);
-		$this->assertArrayHasKey($check1, $data);
-		$this->assertArrayHasKey($check2, $data);
-
-		$data = $this->manager->getChecks([$check2, $check1]);
-		$this->assertArrayHasKey($check1, $data);
-		$this->assertArrayHasKey($check2, $data);
-
-		$data = $this->manager->getChecks([$check2]);
-		$this->assertArrayNotHasKey($check1, $data);
-		$this->assertArrayHasKey($check2, $data);
-	}
-
-	public function testScope(): void {
-		$adminScope = $this->buildScope();
-		$userScope = $this->buildScope('jackie');
-		$entity = File::class;
-
-		$opId1 = $this->invokePrivate(
-			$this->manager,
-			'insertOperation',
-			['OCA\WFE\TestOp', 'Test01', [11, 22], 'foo', $entity, []]
-		);
-		$this->invokePrivate($this->manager, 'addScope', [$opId1, $adminScope]);
-
-		$opId2 = $this->invokePrivate(
-			$this->manager,
-			'insertOperation',
-			['OCA\WFE\TestOp', 'Test02', [33, 22], 'bar', $entity, []]
-		);
-		$this->invokePrivate($this->manager, 'addScope', [$opId2, $userScope]);
-		$opId3 = $this->invokePrivate(
-			$this->manager,
-			'insertOperation',
-			['OCA\WFE\TestOp', 'Test03', [11, 44], 'foobar', $entity, []]
-		);
-		$this->invokePrivate($this->manager, 'addScope', [$opId3, $userScope]);
-
-		$this->assertTrue($this->invokePrivate($this->manager, 'canModify', [$opId1, $adminScope]));
-		$this->assertFalse($this->invokePrivate($this->manager, 'canModify', [$opId2, $adminScope]));
-		$this->assertFalse($this->invokePrivate($this->manager, 'canModify', [$opId3, $adminScope]));
-
-		$this->assertFalse($this->invokePrivate($this->manager, 'canModify', [$opId1, $userScope]));
-		$this->assertTrue($this->invokePrivate($this->manager, 'canModify', [$opId2, $userScope]));
-		$this->assertTrue($this->invokePrivate($this->manager, 'canModify', [$opId3, $userScope]));
-	}
-
-	public function testGetAllOperations(): void {
-		$adminScope = $this->buildScope();
-		$userScope = $this->buildScope('jackie');
-		$entity = File::class;
-
-		$adminOperation = $this->createMock(IOperation::class);
-		$adminOperation->expects($this->any())
-			->method('isAvailableForScope')
-			->willReturnMap([
-				[IManager::SCOPE_ADMIN, true],
-				[IManager::SCOPE_USER, false],
-			]);
-		$userOperation = $this->createMock(IOperation::class);
-		$userOperation->expects($this->any())
-			->method('isAvailableForScope')
-			->willReturnMap([
-				[IManager::SCOPE_ADMIN, false],
-				[IManager::SCOPE_USER, true],
-			]);
-
-		$this->container->expects($this->any())
-			->method('get')
-			->willReturnCallback(function ($className) use ($adminOperation, $userOperation) {
-				switch ($className) {
-					case 'OCA\WFE\TestAdminOp':
-						return $adminOperation;
-					case 'OCA\WFE\TestUserOp':
-						return $userOperation;
-				}
-			});
-
-		$opId1 = $this->invokePrivate(
-			$this->manager,
-			'insertOperation',
-			['OCA\WFE\TestAdminOp', 'Test01', [11, 22], 'foo', $entity, []]
-		);
-		$this->invokePrivate($this->manager, 'addScope', [$opId1, $adminScope]);
-
-		$opId2 = $this->invokePrivate(
-			$this->manager,
-			'insertOperation',
-			['OCA\WFE\TestUserOp', 'Test02', [33, 22], 'bar', $entity, []]
-		);
-		$this->invokePrivate($this->manager, 'addScope', [$opId2, $userScope]);
-		$opId3 = $this->invokePrivate(
-			$this->manager,
-			'insertOperation',
-			['OCA\WFE\TestUserOp', 'Test03', [11, 44], 'foobar', $entity, []]
-		);
-		$this->invokePrivate($this->manager, 'addScope', [$opId3, $userScope]);
-
-		$opId4 = $this->invokePrivate(
-			$this->manager,
-			'insertOperation',
-			['OCA\WFE\TestAdminOp', 'Test04', [41, 10, 4], 'NoBar', $entity, []]
-		);
-		$this->invokePrivate($this->manager, 'addScope', [$opId4, $userScope]);
-
-		$adminOps = $this->manager->getAllOperations($adminScope);
-		$userOps = $this->manager->getAllOperations($userScope);
-
-		$this->assertSame(1, count($adminOps));
-		$this->assertTrue(array_key_exists('OCA\WFE\TestAdminOp', $adminOps));
-		$this->assertFalse(array_key_exists('OCA\WFE\TestUserOp', $adminOps));
-
-		$this->assertSame(1, count($userOps));
-		$this->assertFalse(array_key_exists('OCA\WFE\TestAdminOp', $userOps));
-		$this->assertTrue(array_key_exists('OCA\WFE\TestUserOp', $userOps));
-		$this->assertSame(2, count($userOps['OCA\WFE\TestUserOp']));
-	}
-
-	public function testGetOperations(): void {
-		$adminScope = $this->buildScope();
-		$userScope = $this->buildScope('jackie');
-		$entity = File::class;
-
-		$opId1 = $this->invokePrivate(
-			$this->manager,
-			'insertOperation',
-			['OCA\WFE\TestOp', 'Test01', [11, 22], 'foo', $entity, []]
-		);
-		$this->invokePrivate($this->manager, 'addScope', [$opId1, $adminScope]);
-		$opId4 = $this->invokePrivate(
-			$this->manager,
-			'insertOperation',
-			['OCA\WFE\OtherTestOp', 'Test04', [5], 'foo', $entity, []]
-		);
-		$this->invokePrivate($this->manager, 'addScope', [$opId4, $adminScope]);
-
-		$opId2 = $this->invokePrivate(
-			$this->manager,
-			'insertOperation',
-			['OCA\WFE\TestOp', 'Test02', [33, 22], 'bar', $entity, []]
-		);
-		$this->invokePrivate($this->manager, 'addScope', [$opId2, $userScope]);
-		$opId3 = $this->invokePrivate(
-			$this->manager,
-			'insertOperation',
-			['OCA\WFE\TestOp', 'Test03', [11, 44], 'foobar', $entity, []]
-		);
-		$this->invokePrivate($this->manager, 'addScope', [$opId3, $userScope]);
-		$opId5 = $this->invokePrivate(
-			$this->manager,
-			'insertOperation',
-			['OCA\WFE\OtherTestOp', 'Test05', [5], 'foobar', $entity, []]
-		);
-		$this->invokePrivate($this->manager, 'addScope', [$opId5, $userScope]);
-
-		$operation = $this->createMock(IOperation::class);
-		$operation->expects($this->any())
-			->method('isAvailableForScope')
-			->willReturnMap([
-				[IManager::SCOPE_ADMIN, true],
-				[IManager::SCOPE_USER, true],
-			]);
-
-		$this->container->expects($this->any())
-			->method('get')
-			->willReturnCallback(function ($className) use ($operation) {
-				switch ($className) {
-					case 'OCA\WFE\TestOp':
-						return $operation;
-					case 'OCA\WFE\OtherTestOp':
-						throw new QueryException();
-				}
-			});
-
-		$adminOps = $this->manager->getOperations('OCA\WFE\TestOp', $adminScope);
-		$userOps = $this->manager->getOperations('OCA\WFE\TestOp', $userScope);
-
-		$this->assertSame(1, count($adminOps));
-		array_walk($adminOps, function ($op): void {
-			$this->assertTrue($op['class'] === 'OCA\WFE\TestOp');
-		});
-
-		$this->assertSame(2, count($userOps));
-		array_walk($userOps, function ($op): void {
-			$this->assertTrue($op['class'] === 'OCA\WFE\TestOp');
-		});
-	}
-
-	public function testGetAllConfiguredEvents(): void {
-		$adminScope = $this->buildScope();
-		$userScope = $this->buildScope('jackie');
-		$entity = File::class;
-
-		$opId5 = $this->invokePrivate(
-			$this->manager,
-			'insertOperation',
-			['OCA\WFE\OtherTestOp', 'Test04', [], 'foo', $entity, [NodeCreatedEvent::class]]
-		);
-		$this->invokePrivate($this->manager, 'addScope', [$opId5, $userScope]);
-
-		$allOperations = null;
-
-		$cache = $this->createMock(ICache::class);
-		$cache
-			->method('get')
-			->willReturnCallback(function () use (&$allOperations) {
-				if ($allOperations) {
-					return $allOperations;
-				}
-
-				return null;
-			});
-
-		$this->cacheFactory->method('createDistributed')->willReturn($cache);
-		$allOperations = $this->manager->getAllConfiguredEvents();
-		$this->assertCount(1, $allOperations);
-
-		$allOperationsCached = $this->manager->getAllConfiguredEvents();
-		$this->assertCount(1, $allOperationsCached);
-		$this->assertEquals($allOperationsCached, $allOperations);
-	}
-
-	public function testUpdateOperation(): void {
-		$adminScope = $this->buildScope();
-		$userScope = $this->buildScope('jackie');
-		$entity = File::class;
-
-		$cache = $this->createMock(ICache::class);
-		$cache->expects($this->exactly(4))
-			->method('remove')
-			->with('events');
-		$this->cacheFactory->method('createDistributed')
-			->willReturn($cache);
-
-		$expectedCalls = [
-			[IManager::SCOPE_ADMIN],
-			[IManager::SCOPE_USER],
-		];
-		$i = 0;
-		$operationMock = $this->createMock(IOperation::class);
-		$operationMock->expects($this->any())
-			->method('isAvailableForScope')
-			->willReturnCallback(function () use (&$expectedCalls, &$i): bool {
-				$this->assertEquals($expectedCalls[$i], func_get_args());
-				$i++;
-				return true;
-			});
-
-		$this->container->expects($this->any())
-			->method('get')
-			->willReturnCallback(function ($class) use ($operationMock) {
-				if (substr($class, -2) === 'Op') {
-					return $operationMock;
-				} elseif ($class === File::class) {
-					return $this->getMockBuilder(File::class)
-						->setConstructorArgs([
-							$this->l,
-							$this->createMock(IURLGenerator::class),
-							$this->createMock(IRootFolder::class),
-							$this->createMock(IUserSession::class),
-							$this->createMock(ISystemTagManager::class),
-							$this->createMock(IUserManager::class),
-							$this->createMock(UserMountCache::class),
-							$this->createMock(IMountManager::class),
-						])
-						->onlyMethods($this->filterClassMethods(File::class, ['getEvents']))
-						->getMock();
-				}
-				return $this->createMock(ICheck::class);
-			});
-
-		$opId1 = $this->invokePrivate(
-			$this->manager,
-			'insertOperation',
-			['OCA\WFE\TestAdminOp', 'Test01', [11, 22], 'foo', $entity, []]
-		);
-		$this->invokePrivate($this->manager, 'addScope', [$opId1, $adminScope]);
-
-		$opId2 = $this->invokePrivate(
-			$this->manager,
-			'insertOperation',
-			['OCA\WFE\TestUserOp', 'Test02', [33, 22], 'bar', $entity, []]
-		);
-		$this->invokePrivate($this->manager, 'addScope', [$opId2, $userScope]);
-
-		$check1 = ['class' => 'OCA\WFE\C22', 'operator' => 'eq', 'value' => 'asdf'];
-		$check2 = ['class' => 'OCA\WFE\C33', 'operator' => 'eq', 'value' => 23456];
-
-		/** @noinspection PhpUnhandledExceptionInspection */
-		$op = $this->manager->updateOperation($opId1, 'Test01a', [$check1, $check2], 'foohur', $adminScope, $entity, ['\OCP\Files::postDelete']);
-		$this->assertSame('Test01a', $op['name']);
-		$this->assertSame('foohur', $op['operation']);
-
-		/** @noinspection PhpUnhandledExceptionInspection */
-		$op = $this->manager->updateOperation($opId2, 'Test02a', [$check1], 'barfoo', $userScope, $entity, ['\OCP\Files::postDelete']);
-		$this->assertSame('Test02a', $op['name']);
-		$this->assertSame('barfoo', $op['operation']);
-
-		foreach ([[$adminScope, $opId2], [$userScope, $opId1]] as $run) {
-			try {
-				/** @noinspection PhpUnhandledExceptionInspection */
-				$this->manager->updateOperation($run[1], 'Evil', [$check2], 'hackx0r', $run[0], $entity, []);
-				$this->assertTrue(false, 'DomainException not thrown');
-			} catch (\DomainException $e) {
-				$this->assertTrue(true);
-			}
-		}
-	}
-
-	public function testDeleteOperation(): void {
-		$adminScope = $this->buildScope();
-		$userScope = $this->buildScope('jackie');
-		$entity = File::class;
-
-		$cache = $this->createMock(ICache::class);
-		$cache->expects($this->exactly(4))
-			->method('remove')
-			->with('events');
-		$this->cacheFactory->method('createDistributed')->willReturn($cache);
-
-		$opId1 = $this->invokePrivate(
-			$this->manager,
-			'insertOperation',
-			['OCA\WFE\TestAdminOp', 'Test01', [11, 22], 'foo', $entity, []]
-		);
-		$this->invokePrivate($this->manager, 'addScope', [$opId1, $adminScope]);
-
-		$opId2 = $this->invokePrivate(
-			$this->manager,
-			'insertOperation',
-			['OCA\WFE\TestUserOp', 'Test02', [33, 22], 'bar', $entity, []]
-		);
-		$this->invokePrivate($this->manager, 'addScope', [$opId2, $userScope]);
-
-		foreach ([[$adminScope, $opId2], [$userScope, $opId1]] as $run) {
-			try {
-				/** @noinspection PhpUnhandledExceptionInspection */
-				$this->manager->deleteOperation($run[1], $run[0]);
-				$this->assertTrue(false, 'DomainException not thrown');
-			} catch (\Exception $e) {
-				$this->assertInstanceOf(\DomainException::class, $e);
-			}
-		}
-
-		/** @noinspection PhpUnhandledExceptionInspection */
-		$this->manager->deleteOperation($opId1, $adminScope);
-		/** @noinspection PhpUnhandledExceptionInspection */
-		$this->manager->deleteOperation($opId2, $userScope);
-
-		foreach ([$opId1, $opId2] as $opId) {
-			try {
-				$this->invokePrivate($this->manager, 'getOperation', [$opId]);
-				$this->assertTrue(false, 'UnexpectedValueException not thrown');
-			} catch (\Exception $e) {
-				$this->assertInstanceOf(\UnexpectedValueException::class, $e);
-			}
-		}
-	}
-
-	public function testGetEntitiesListBuildInOnly(): void {
-		$fileEntityMock = $this->createMock(File::class);
-
-		$this->container->expects($this->once())
-			->method('get')
-			->with(File::class)
-			->willReturn($fileEntityMock);
-
-		$entities = $this->manager->getEntitiesList();
-
-		$this->assertCount(1, $entities);
-		$this->assertInstanceOf(IEntity::class, $entities[0]);
-	}
-
-	public function testGetEntitiesList(): void {
-		$fileEntityMock = $this->createMock(File::class);
-
-		$this->container->expects($this->once())
-			->method('get')
-			->with(File::class)
-			->willReturn($fileEntityMock);
-
-		$extraEntity = $this->createMock(IEntity::class);
-
-		$this->dispatcher->expects($this->once())
-			->method('dispatchTyped')
-			->willReturnCallback(function (RegisterEntitiesEvent $e) use ($extraEntity): void {
-				$this->manager->registerEntity($extraEntity);
-			});
-
-		$entities = $this->manager->getEntitiesList();
-
-		$this->assertCount(2, $entities);
-
-		$entityTypeCounts = array_reduce($entities, function (array $carry, IEntity $entity) {
-			if ($entity instanceof File) {
-				$carry[0]++;
-			} elseif ($entity instanceof IEntity) {
-				$carry[1]++;
-			}
-			return $carry;
-		}, [0, 0]);
-
-		$this->assertSame(1, $entityTypeCounts[0]);
-		$this->assertSame(1, $entityTypeCounts[1]);
-	}
-
-	public function testValidateOperationOK(): void {
-		$check = [
-			'class' => ICheck::class,
-			'operator' => 'is',
-			'value' => 'barfoo',
-		];
-
-		$operationMock = $this->createMock(IOperation::class);
-		$entityMock = $this->createMock(IEntity::class);
-		$eventEntityMock = $this->createMock(IEntityEvent::class);
-		$checkMock = $this->createMock(ICheck::class);
-		$scopeMock = $this->createMock(ScopeContext::class);
-
-		$scopeMock->expects($this->any())
-			->method('getScope')
-			->willReturn(IManager::SCOPE_ADMIN);
-
-		$operationMock->expects($this->once())
-			->method('isAvailableForScope')
-			->with(IManager::SCOPE_ADMIN)
-			->willReturn(true);
-
-		$operationMock->expects($this->once())
-			->method('validateOperation')
-			->with('test', [$check], 'operationData');
-
-		$entityMock->expects($this->any())
-			->method('getEvents')
-			->willReturn([$eventEntityMock]);
-
-		$eventEntityMock->expects($this->any())
-			->method('getEventName')
-			->willReturn('MyEvent');
-
-		$checkMock->expects($this->any())
-			->method('supportedEntities')
-			->willReturn([IEntity::class]);
-		$checkMock->expects($this->atLeastOnce())
-			->method('validateCheck');
-
-		$this->container->expects($this->any())
-			->method('get')
-			->willReturnCallback(function ($className) use ($operationMock, $entityMock, $eventEntityMock, $checkMock) {
-				switch ($className) {
-					case IOperation::class:
-						return $operationMock;
-					case IEntity::class:
-						return $entityMock;
-					case IEntityEvent::class:
-						return $eventEntityMock;
-					case ICheck::class:
-						return $checkMock;
-					default:
-						return $this->createMock($className);
-				}
-			});
-
-		$this->manager->validateOperation(IOperation::class, 'test', [$check], 'operationData', $scopeMock, IEntity::class, ['MyEvent']);
-	}
-
-	public function testValidateOperationCheckInputLengthError(): void {
-		$check = [
-			'class' => ICheck::class,
-			'operator' => 'is',
-			'value' => str_pad('', IManager::MAX_CHECK_VALUE_BYTES + 1, 'FooBar'),
-		];
-
-		$operationMock = $this->createMock(IOperation::class);
-		$entityMock = $this->createMock(IEntity::class);
-		$eventEntityMock = $this->createMock(IEntityEvent::class);
-		$checkMock = $this->createMock(ICheck::class);
-		$scopeMock = $this->createMock(ScopeContext::class);
-
-		$scopeMock->expects($this->any())
-			->method('getScope')
-			->willReturn(IManager::SCOPE_ADMIN);
-
-		$operationMock->expects($this->once())
-			->method('isAvailableForScope')
-			->with(IManager::SCOPE_ADMIN)
-			->willReturn(true);
-
-		$operationMock->expects($this->once())
-			->method('validateOperation')
-			->with('test', [$check], 'operationData');
-
-		$entityMock->expects($this->any())
-			->method('getEvents')
-			->willReturn([$eventEntityMock]);
-
-		$eventEntityMock->expects($this->any())
-			->method('getEventName')
-			->willReturn('MyEvent');
-
-		$checkMock->expects($this->any())
-			->method('supportedEntities')
-			->willReturn([IEntity::class]);
-		$checkMock->expects($this->never())
-			->method('validateCheck');
-
-		$this->container->expects($this->any())
-			->method('get')
-			->willReturnCallback(function ($className) use ($operationMock, $entityMock, $eventEntityMock, $checkMock) {
-				switch ($className) {
-					case IOperation::class:
-						return $operationMock;
-					case IEntity::class:
-						return $entityMock;
-					case IEntityEvent::class:
-						return $eventEntityMock;
-					case ICheck::class:
-						return $checkMock;
-					default:
-						return $this->createMock($className);
-				}
-			});
-
-		try {
-			$this->manager->validateOperation(IOperation::class, 'test', [$check], 'operationData', $scopeMock, IEntity::class, ['MyEvent']);
-		} catch (\UnexpectedValueException $e) {
-			$this->assertSame('The provided check value is too long', $e->getMessage());
-		}
-	}
-
-	public function testValidateOperationDataLengthError(): void {
-		$check = [
-			'class' => ICheck::class,
-			'operator' => 'is',
-			'value' => 'barfoo',
-		];
-		$operationData = str_pad('', IManager::MAX_OPERATION_VALUE_BYTES + 1, 'FooBar');
-
-		$operationMock = $this->createMock(IOperation::class);
-		$entityMock = $this->createMock(IEntity::class);
-		$eventEntityMock = $this->createMock(IEntityEvent::class);
-		$checkMock = $this->createMock(ICheck::class);
-		$scopeMock = $this->createMock(ScopeContext::class);
-
-		$scopeMock->expects($this->any())
-			->method('getScope')
-			->willReturn(IManager::SCOPE_ADMIN);
-
-		$operationMock->expects($this->once())
-			->method('isAvailableForScope')
-			->with(IManager::SCOPE_ADMIN)
-			->willReturn(true);
-
-		$operationMock->expects($this->never())
-			->method('validateOperation');
-
-		$entityMock->expects($this->any())
-			->method('getEvents')
-			->willReturn([$eventEntityMock]);
-
-		$eventEntityMock->expects($this->any())
-			->method('getEventName')
-			->willReturn('MyEvent');
-
-		$checkMock->expects($this->any())
-			->method('supportedEntities')
-			->willReturn([IEntity::class]);
-		$checkMock->expects($this->never())
-			->method('validateCheck');
-
-		$this->container->expects($this->any())
-			->method('get')
-			->willReturnCallback(function ($className) use ($operationMock, $entityMock, $eventEntityMock, $checkMock) {
-				switch ($className) {
-					case IOperation::class:
-						return $operationMock;
-					case IEntity::class:
-						return $entityMock;
-					case IEntityEvent::class:
-						return $eventEntityMock;
-					case ICheck::class:
-						return $checkMock;
-					default:
-						return $this->createMock($className);
-				}
-			});
-
-		try {
-			$this->manager->validateOperation(IOperation::class, 'test', [$check], $operationData, $scopeMock, IEntity::class, ['MyEvent']);
-		} catch (\UnexpectedValueException $e) {
-			$this->assertSame('The provided operation data is too long', $e->getMessage());
-		}
-	}
-
-	public function testValidateOperationScopeNotAvailable(): void {
-		$check = [
-			'class' => ICheck::class,
-			'operator' => 'is',
-			'value' => 'barfoo',
-		];
-		$operationData = str_pad('', IManager::MAX_OPERATION_VALUE_BYTES + 1, 'FooBar');
-
-		$operationMock = $this->createMock(IOperation::class);
-		$entityMock = $this->createMock(IEntity::class);
-		$eventEntityMock = $this->createMock(IEntityEvent::class);
-		$checkMock = $this->createMock(ICheck::class);
-		$scopeMock = $this->createMock(ScopeContext::class);
-
-		$scopeMock->expects($this->any())
-			->method('getScope')
-			->willReturn(IManager::SCOPE_ADMIN);
-
-		$operationMock->expects($this->once())
-			->method('isAvailableForScope')
-			->with(IManager::SCOPE_ADMIN)
-			->willReturn(false);
-
-		$operationMock->expects($this->never())
-			->method('validateOperation');
-
-		$entityMock->expects($this->any())
-			->method('getEvents')
-			->willReturn([$eventEntityMock]);
-
-		$eventEntityMock->expects($this->any())
-			->method('getEventName')
-			->willReturn('MyEvent');
-
-		$checkMock->expects($this->any())
-			->method('supportedEntities')
-			->willReturn([IEntity::class]);
-		$checkMock->expects($this->never())
-			->method('validateCheck');
-
-		$this->container->expects($this->any())
-			->method('get')
-			->willReturnCallback(function ($className) use ($operationMock, $entityMock, $eventEntityMock, $checkMock) {
-				switch ($className) {
-					case IOperation::class:
-						return $operationMock;
-					case IEntity::class:
-						return $entityMock;
-					case IEntityEvent::class:
-						return $eventEntityMock;
-					case ICheck::class:
-						return $checkMock;
-					default:
-						return $this->createMock($className);
-				}
-			});
-
-		try {
-			$this->manager->validateOperation(IOperation::class, 'test', [$check], $operationData, $scopeMock, IEntity::class, ['MyEvent']);
-		} catch (\UnexpectedValueException $e) {
-			$this->assertSame('Operation OCP\WorkflowEngine\IOperation is invalid', $e->getMessage());
-		}
-	}
+    protected Manager $manager;
+    protected IDBConnection $db;
+    protected LoggerInterface&MockObject $logger;
+    protected ContainerInterface&MockObject $container;
+    protected IUserSession&MockObject $session;
+    protected IL10N&MockObject $l;
+    protected IEventDispatcher&MockObject $dispatcher;
+    protected IAppConfig&MockObject $config;
+    protected ICacheFactory&MockObject $cacheFactory;
+
+    protected function setUp(): void {
+        parent::setUp();
+
+        $this->db = Server::get(IDBConnection::class);
+        $this->container = $this->createMock(ContainerInterface::class);
+        $this->l = $this->createMock(IL10N::class);
+        $this->l->method('t')
+            ->willReturnCallback(function ($text, $parameters = []) {
+                return vsprintf($text, $parameters);
+            });
+
+        $this->logger = $this->createMock(LoggerInterface::class);
+        $this->session = $this->createMock(IUserSession::class);
+        $this->dispatcher = $this->createMock(IEventDispatcher::class);
+        $this->config = $this->createMock(IAppConfig::class);
+        $this->cacheFactory = $this->createMock(ICacheFactory::class);
+
+        $this->manager = new Manager(
+            $this->db,
+            $this->container,
+            $this->l,
+            $this->logger,
+            $this->session,
+            $this->dispatcher,
+            $this->config,
+            $this->cacheFactory
+        );
+        $this->clearTables();
+    }
+
+    protected function tearDown(): void {
+        $this->clearTables();
+        parent::tearDown();
+    }
+
+    protected function buildScope(?string $scopeId = null): MockObject&ScopeContext {
+        $scopeContext = $this->createMock(ScopeContext::class);
+        $scopeContext->expects($this->any())
+            ->method('getScope')
+            ->willReturn($scopeId ? IManager::SCOPE_USER : IManager::SCOPE_ADMIN);
+        $scopeContext->expects($this->any())
+            ->method('getScopeId')
+            ->willReturn($scopeId ?? '');
+        $scopeContext->expects($this->any())
+            ->method('getHash')
+            ->willReturn(md5($scopeId ?? ''));
+
+        return $scopeContext;
+    }
+
+    public function clearTables() {
+        $query = $this->db->getQueryBuilder();
+        foreach (['flow_checks', 'flow_operations', 'flow_operations_scope'] as $table) {
+            $query->delete($table)
+                ->executeStatement();
+        }
+    }
+
+    public function testChecks(): void {
+        $check1 = $this->invokePrivate($this->manager, 'addCheck', ['Test', 'equal', 1]);
+        $check2 = $this->invokePrivate($this->manager, 'addCheck', ['Test', '!equal', 2]);
+
+        $data = $this->manager->getChecks([$check1]);
+        $this->assertArrayHasKey($check1, $data);
+        $this->assertArrayNotHasKey($check2, $data);
+
+        $data = $this->manager->getChecks([$check1, $check2]);
+        $this->assertArrayHasKey($check1, $data);
+        $this->assertArrayHasKey($check2, $data);
+
+        $data = $this->manager->getChecks([$check2, $check1]);
+        $this->assertArrayHasKey($check1, $data);
+        $this->assertArrayHasKey($check2, $data);
+
+        $data = $this->manager->getChecks([$check2]);
+        $this->assertArrayNotHasKey($check1, $data);
+        $this->assertArrayHasKey($check2, $data);
+    }
+
+    public function testScope(): void {
+        $adminScope = $this->buildScope();
+        $userScope = $this->buildScope('jackie');
+        $entity = File::class;
+
+        $opId1 = $this->invokePrivate(
+            $this->manager,
+            'insertOperation',
+            ['OCA\WFE\TestOp', 'Test01', [11, 22], 'foo', $entity, []]
+        );
+        $this->invokePrivate($this->manager, 'addScope', [$opId1, $adminScope]);
+
+        $opId2 = $this->invokePrivate(
+            $this->manager,
+            'insertOperation',
+            ['OCA\WFE\TestOp', 'Test02', [33, 22], 'bar', $entity, []]
+        );
+        $this->invokePrivate($this->manager, 'addScope', [$opId2, $userScope]);
+        $opId3 = $this->invokePrivate(
+            $this->manager,
+            'insertOperation',
+            ['OCA\WFE\TestOp', 'Test03', [11, 44], 'foobar', $entity, []]
+        );
+        $this->invokePrivate($this->manager, 'addScope', [$opId3, $userScope]);
+
+        $this->assertTrue($this->invokePrivate($this->manager, 'canModify', [$opId1, $adminScope]));
+        $this->assertFalse($this->invokePrivate($this->manager, 'canModify', [$opId2, $adminScope]));
+        $this->assertFalse($this->invokePrivate($this->manager, 'canModify', [$opId3, $adminScope]));
+
+        $this->assertFalse($this->invokePrivate($this->manager, 'canModify', [$opId1, $userScope]));
+        $this->assertTrue($this->invokePrivate($this->manager, 'canModify', [$opId2, $userScope]));
+        $this->assertTrue($this->invokePrivate($this->manager, 'canModify', [$opId3, $userScope]));
+    }
+
+    public function testGetAllOperations(): void {
+        $adminScope = $this->buildScope();
+        $userScope = $this->buildScope('jackie');
+        $entity = File::class;
+
+        $adminOperation = $this->createMock(IOperation::class);
+        $adminOperation->expects($this->any())
+            ->method('isAvailableForScope')
+            ->willReturnMap([
+                [IManager::SCOPE_ADMIN, true],
+                [IManager::SCOPE_USER, false],
+            ]);
+        $userOperation = $this->createMock(IOperation::class);
+        $userOperation->expects($this->any())
+            ->method('isAvailableForScope')
+            ->willReturnMap([
+                [IManager::SCOPE_ADMIN, false],
+                [IManager::SCOPE_USER, true],
+            ]);
+
+        $this->container->expects($this->any())
+            ->method('get')
+            ->willReturnCallback(function ($className) use ($adminOperation, $userOperation) {
+                switch ($className) {
+                    case 'OCA\WFE\TestAdminOp':
+                        return $adminOperation;
+                    case 'OCA\WFE\TestUserOp':
+                        return $userOperation;
+                }
+            });
+
+        $opId1 = $this->invokePrivate(
+            $this->manager,
+            'insertOperation',
+            ['OCA\WFE\TestAdminOp', 'Test01', [11, 22], 'foo', $entity, []]
+        );
+        $this->invokePrivate($this->manager, 'addScope', [$opId1, $adminScope]);
+
+        $opId2 = $this->invokePrivate(
+            $this->manager,
+            'insertOperation',
+            ['OCA\WFE\TestUserOp', 'Test02', [33, 22], 'bar', $entity, []]
+        );
+        $this->invokePrivate($this->manager, 'addScope', [$opId2, $userScope]);
+        $opId3 = $this->invokePrivate(
+            $this->manager,
+            'insertOperation',
+            ['OCA\WFE\TestUserOp', 'Test03', [11, 44], 'foobar', $entity, []]
+        );
+        $this->invokePrivate($this->manager, 'addScope', [$opId3, $userScope]);
+
+        $opId4 = $this->invokePrivate(
+            $this->manager,
+            'insertOperation',
+            ['OCA\WFE\TestAdminOp', 'Test04', [41, 10, 4], 'NoBar', $entity, []]
+        );
+        $this->invokePrivate($this->manager, 'addScope', [$opId4, $userScope]);
+
+        $adminOps = $this->manager->getAllOperations($adminScope);
+        $userOps = $this->manager->getAllOperations($userScope);
+
+        $this->assertSame(1, count($adminOps));
+        $this->assertTrue(array_key_exists('OCA\WFE\TestAdminOp', $adminOps));
+        $this->assertFalse(array_key_exists('OCA\WFE\TestUserOp', $adminOps));
+
+        $this->assertSame(1, count($userOps));
+        $this->assertFalse(array_key_exists('OCA\WFE\TestAdminOp', $userOps));
+        $this->assertTrue(array_key_exists('OCA\WFE\TestUserOp', $userOps));
+        $this->assertSame(2, count($userOps['OCA\WFE\TestUserOp']));
+    }
+
+    public function testGetOperations(): void {
+        $adminScope = $this->buildScope();
+        $userScope = $this->buildScope('jackie');
+        $entity = File::class;
+
+        $opId1 = $this->invokePrivate(
+            $this->manager,
+            'insertOperation',
+            ['OCA\WFE\TestOp', 'Test01', [11, 22], 'foo', $entity, []]
+        );
+        $this->invokePrivate($this->manager, 'addScope', [$opId1, $adminScope]);
+        $opId4 = $this->invokePrivate(
+            $this->manager,
+            'insertOperation',
+            ['OCA\WFE\OtherTestOp', 'Test04', [5], 'foo', $entity, []]
+        );
+        $this->invokePrivate($this->manager, 'addScope', [$opId4, $adminScope]);
+
+        $opId2 = $this->invokePrivate(
+            $this->manager,
+            'insertOperation',
+            ['OCA\WFE\TestOp', 'Test02', [33, 22], 'bar', $entity, []]
+        );
+        $this->invokePrivate($this->manager, 'addScope', [$opId2, $userScope]);
+        $opId3 = $this->invokePrivate(
+            $this->manager,
+            'insertOperation',
+            ['OCA\WFE\TestOp', 'Test03', [11, 44], 'foobar', $entity, []]
+        );
+        $this->invokePrivate($this->manager, 'addScope', [$opId3, $userScope]);
+        $opId5 = $this->invokePrivate(
+            $this->manager,
+            'insertOperation',
+            ['OCA\WFE\OtherTestOp', 'Test05', [5], 'foobar', $entity, []]
+        );
+        $this->invokePrivate($this->manager, 'addScope', [$opId5, $userScope]);
+
+        $operation = $this->createMock(IOperation::class);
+        $operation->expects($this->any())
+            ->method('isAvailableForScope')
+            ->willReturnMap([
+                [IManager::SCOPE_ADMIN, true],
+                [IManager::SCOPE_USER, true],
+            ]);
+
+        $this->container->expects($this->any())
+            ->method('get')
+            ->willReturnCallback(function ($className) use ($operation) {
+                switch ($className) {
+                    case 'OCA\WFE\TestOp':
+                        return $operation;
+                    case 'OCA\WFE\OtherTestOp':
+                        throw new QueryException();
+                }
+            });
+
+        $adminOps = $this->manager->getOperations('OCA\WFE\TestOp', $adminScope);
+        $userOps = $this->manager->getOperations('OCA\WFE\TestOp', $userScope);
+
+        $this->assertSame(1, count($adminOps));
+        array_walk($adminOps, function ($op): void {
+            $this->assertTrue($op['class'] === 'OCA\WFE\TestOp');
+        });
+
+        $this->assertSame(2, count($userOps));
+        array_walk($userOps, function ($op): void {
+            $this->assertTrue($op['class'] === 'OCA\WFE\TestOp');
+        });
+    }
+
+    public function testGetAllConfiguredEvents(): void {
+        $adminScope = $this->buildScope();
+        $userScope = $this->buildScope('jackie');
+        $entity = File::class;
+
+        $opId5 = $this->invokePrivate(
+            $this->manager,
+            'insertOperation',
+            ['OCA\WFE\OtherTestOp', 'Test04', [], 'foo', $entity, [NodeCreatedEvent::class]]
+        );
+        $this->invokePrivate($this->manager, 'addScope', [$opId5, $userScope]);
+
+        $allOperations = null;
+
+        $cache = $this->createMock(ICache::class);
+        $cache
+            ->method('get')
+            ->willReturnCallback(function () use (&$allOperations) {
+                if ($allOperations) {
+                    return $allOperations;
+                }
+
+                return null;
+            });
+
+        $this->cacheFactory->method('createDistributed')->willReturn($cache);
+        $allOperations = $this->manager->getAllConfiguredEvents();
+        $this->assertCount(1, $allOperations);
+
+        $allOperationsCached = $this->manager->getAllConfiguredEvents();
+        $this->assertCount(1, $allOperationsCached);
+        $this->assertEquals($allOperationsCached, $allOperations);
+    }
+
+    public function testUpdateOperation(): void {
+        $adminScope = $this->buildScope();
+        $userScope = $this->buildScope('jackie');
+        $entity = File::class;
+
+        $cache = $this->createMock(ICache::class);
+        $cache->expects($this->exactly(4))
+            ->method('remove')
+            ->with('events');
+        $this->cacheFactory->method('createDistributed')
+            ->willReturn($cache);
+
+        $expectedCalls = [
+            [IManager::SCOPE_ADMIN],
+            [IManager::SCOPE_USER],
+        ];
+        $i = 0;
+        $operationMock = $this->createMock(IOperation::class);
+        $operationMock->expects($this->any())
+            ->method('isAvailableForScope')
+            ->willReturnCallback(function () use (&$expectedCalls, &$i): bool {
+                $this->assertEquals($expectedCalls[$i], func_get_args());
+                $i++;
+                return true;
+            });
+
+        $this->container->expects($this->any())
+            ->method('get')
+            ->willReturnCallback(function ($class) use ($operationMock) {
+                if (substr($class, -2) === 'Op') {
+                    return $operationMock;
+                } elseif ($class === File::class) {
+                    return $this->getMockBuilder(File::class)
+                        ->setConstructorArgs([
+                            $this->l,
+                            $this->createMock(IURLGenerator::class),
+                            $this->createMock(IRootFolder::class),
+                            $this->createMock(IUserSession::class),
+                            $this->createMock(ISystemTagManager::class),
+                            $this->createMock(IUserManager::class),
+                            $this->createMock(UserMountCache::class),
+                            $this->createMock(IMountManager::class),
+                        ])
+                        ->onlyMethods($this->filterClassMethods(File::class, ['getEvents']))
+                        ->getMock();
+                }
+                return $this->createMock(ICheck::class);
+            });
+
+        $opId1 = $this->invokePrivate(
+            $this->manager,
+            'insertOperation',
+            ['OCA\WFE\TestAdminOp', 'Test01', [11, 22], 'foo', $entity, []]
+        );
+        $this->invokePrivate($this->manager, 'addScope', [$opId1, $adminScope]);
+
+        $opId2 = $this->invokePrivate(
+            $this->manager,
+            'insertOperation',
+            ['OCA\WFE\TestUserOp', 'Test02', [33, 22], 'bar', $entity, []]
+        );
+        $this->invokePrivate($this->manager, 'addScope', [$opId2, $userScope]);
+
+        $check1 = ['class' => 'OCA\WFE\C22', 'operator' => 'eq', 'value' => 'asdf'];
+        $check2 = ['class' => 'OCA\WFE\C33', 'operator' => 'eq', 'value' => 23456];
+
+        /** @noinspection PhpUnhandledExceptionInspection */
+        $op = $this->manager->updateOperation($opId1, 'Test01a', [$check1, $check2], 'foohur', $adminScope, $entity, ['\OCP\Files::postDelete']);
+        $this->assertSame('Test01a', $op['name']);
+        $this->assertSame('foohur', $op['operation']);
+
+        /** @noinspection PhpUnhandledExceptionInspection */
+        $op = $this->manager->updateOperation($opId2, 'Test02a', [$check1], 'barfoo', $userScope, $entity, ['\OCP\Files::postDelete']);
+        $this->assertSame('Test02a', $op['name']);
+        $this->assertSame('barfoo', $op['operation']);
+
+        foreach ([[$adminScope, $opId2], [$userScope, $opId1]] as $run) {
+            try {
+                /** @noinspection PhpUnhandledExceptionInspection */
+                $this->manager->updateOperation($run[1], 'Evil', [$check2], 'hackx0r', $run[0], $entity, []);
+                $this->assertTrue(false, 'DomainException not thrown');
+            } catch (\DomainException $e) {
+                $this->assertTrue(true);
+            }
+        }
+    }
+
+    public function testDeleteOperation(): void {
+        $adminScope = $this->buildScope();
+        $userScope = $this->buildScope('jackie');
+        $entity = File::class;
+
+        $cache = $this->createMock(ICache::class);
+        $cache->expects($this->exactly(4))
+            ->method('remove')
+            ->with('events');
+        $this->cacheFactory->method('createDistributed')->willReturn($cache);
+
+        $opId1 = $this->invokePrivate(
+            $this->manager,
+            'insertOperation',
+            ['OCA\WFE\TestAdminOp', 'Test01', [11, 22], 'foo', $entity, []]
+        );
+        $this->invokePrivate($this->manager, 'addScope', [$opId1, $adminScope]);
+
+        $opId2 = $this->invokePrivate(
+            $this->manager,
+            'insertOperation',
+            ['OCA\WFE\TestUserOp', 'Test02', [33, 22], 'bar', $entity, []]
+        );
+        $this->invokePrivate($this->manager, 'addScope', [$opId2, $userScope]);
+
+        foreach ([[$adminScope, $opId2], [$userScope, $opId1]] as $run) {
+            try {
+                /** @noinspection PhpUnhandledExceptionInspection */
+                $this->manager->deleteOperation($run[1], $run[0]);
+                $this->assertTrue(false, 'DomainException not thrown');
+            } catch (\Exception $e) {
+                $this->assertInstanceOf(\DomainException::class, $e);
+            }
+        }
+
+        /** @noinspection PhpUnhandledExceptionInspection */
+        $this->manager->deleteOperation($opId1, $adminScope);
+        /** @noinspection PhpUnhandledExceptionInspection */
+        $this->manager->deleteOperation($opId2, $userScope);
+
+        foreach ([$opId1, $opId2] as $opId) {
+            try {
+                $this->invokePrivate($this->manager, 'getOperation', [$opId]);
+                $this->assertTrue(false, 'UnexpectedValueException not thrown');
+            } catch (\Exception $e) {
+                $this->assertInstanceOf(\UnexpectedValueException::class, $e);
+            }
+        }
+    }
+
+    public function testGetEntitiesListBuildInOnly(): void {
+        $fileEntityMock = $this->createMock(File::class);
+
+        $this->container->expects($this->once())
+            ->method('get')
+            ->with(File::class)
+            ->willReturn($fileEntityMock);
+
+        $entities = $this->manager->getEntitiesList();
+
+        $this->assertCount(1, $entities);
+        $this->assertInstanceOf(IEntity::class, $entities[0]);
+    }
+
+    public function testGetEntitiesList(): void {
+        $fileEntityMock = $this->createMock(File::class);
+
+        $this->container->expects($this->once())
+            ->method('get')
+            ->with(File::class)
+            ->willReturn($fileEntityMock);
+
+        $extraEntity = $this->createMock(IEntity::class);
+
+        $this->dispatcher->expects($this->once())
+            ->method('dispatchTyped')
+            ->willReturnCallback(function (RegisterEntitiesEvent $e) use ($extraEntity): void {
+                $this->manager->registerEntity($extraEntity);
+            });
+
+        $entities = $this->manager->getEntitiesList();
+
+        $this->assertCount(2, $entities);
+
+        $entityTypeCounts = array_reduce($entities, function (array $carry, IEntity $entity) {
+            if ($entity instanceof File) {
+                $carry[0]++;
+            } elseif ($entity instanceof IEntity) {
+                $carry[1]++;
+            }
+            return $carry;
+        }, [0, 0]);
+
+        $this->assertSame(1, $entityTypeCounts[0]);
+        $this->assertSame(1, $entityTypeCounts[1]);
+    }
+
+    public function testValidateOperationOK(): void {
+        $check = [
+            'class' => ICheck::class,
+            'operator' => 'is',
+            'value' => 'barfoo',
+        ];
+
+        $operationMock = $this->createMock(IOperation::class);
+        $entityMock = $this->createMock(IEntity::class);
+        $eventEntityMock = $this->createMock(IEntityEvent::class);
+        $checkMock = $this->createMock(ICheck::class);
+        $scopeMock = $this->createMock(ScopeContext::class);
+
+        $scopeMock->expects($this->any())
+            ->method('getScope')
+            ->willReturn(IManager::SCOPE_ADMIN);
+
+        $operationMock->expects($this->once())
+            ->method('isAvailableForScope')
+            ->with(IManager::SCOPE_ADMIN)
+            ->willReturn(true);
+
+        $operationMock->expects($this->once())
+            ->method('validateOperation')
+            ->with('test', [$check], 'operationData');
+
+        $entityMock->expects($this->any())
+            ->method('getEvents')
+            ->willReturn([$eventEntityMock]);
+
+        $eventEntityMock->expects($this->any())
+            ->method('getEventName')
+            ->willReturn('MyEvent');
+
+        $checkMock->expects($this->any())
+            ->method('supportedEntities')
+            ->willReturn([IEntity::class]);
+        $checkMock->expects($this->atLeastOnce())
+            ->method('validateCheck');
+
+        $this->container->expects($this->any())
+            ->method('get')
+            ->willReturnCallback(function ($className) use ($operationMock, $entityMock, $eventEntityMock, $checkMock) {
+                switch ($className) {
+                    case IOperation::class:
+                        return $operationMock;
+                    case IEntity::class:
+                        return $entityMock;
+                    case IEntityEvent::class:
+                        return $eventEntityMock;
+                    case ICheck::class:
+                        return $checkMock;
+                    default:
+                        return $this->createMock($className);
+                }
+            });
+
+        $this->manager->validateOperation(IOperation::class, 'test', [$check], 'operationData', $scopeMock, IEntity::class, ['MyEvent']);
+    }
+
+    public function testValidateOperationCheckInputLengthError(): void {
+        $check = [
+            'class' => ICheck::class,
+            'operator' => 'is',
+            'value' => str_pad('', IManager::MAX_CHECK_VALUE_BYTES + 1, 'FooBar'),
+        ];
+
+        $operationMock = $this->createMock(IOperation::class);
+        $entityMock = $this->createMock(IEntity::class);
+        $eventEntityMock = $this->createMock(IEntityEvent::class);
+        $checkMock = $this->createMock(ICheck::class);
+        $scopeMock = $this->createMock(ScopeContext::class);
+
+        $scopeMock->expects($this->any())
+            ->method('getScope')
+            ->willReturn(IManager::SCOPE_ADMIN);
+
+        $operationMock->expects($this->once())
+            ->method('isAvailableForScope')
+            ->with(IManager::SCOPE_ADMIN)
+            ->willReturn(true);
+
+        $operationMock->expects($this->once())
+            ->method('validateOperation')
+            ->with('test', [$check], 'operationData');
+
+        $entityMock->expects($this->any())
+            ->method('getEvents')
+            ->willReturn([$eventEntityMock]);
+
+        $eventEntityMock->expects($this->any())
+            ->method('getEventName')
+            ->willReturn('MyEvent');
+
+        $checkMock->expects($this->any())
+            ->method('supportedEntities')
+            ->willReturn([IEntity::class]);
+        $checkMock->expects($this->never())
+            ->method('validateCheck');
+
+        $this->container->expects($this->any())
+            ->method('get')
+            ->willReturnCallback(function ($className) use ($operationMock, $entityMock, $eventEntityMock, $checkMock) {
+                switch ($className) {
+                    case IOperation::class:
+                        return $operationMock;
+                    case IEntity::class:
+                        return $entityMock;
+                    case IEntityEvent::class:
+                        return $eventEntityMock;
+                    case ICheck::class:
+                        return $checkMock;
+                    default:
+                        return $this->createMock($className);
+                }
+            });
+
+        try {
+            $this->manager->validateOperation(IOperation::class, 'test', [$check], 'operationData', $scopeMock, IEntity::class, ['MyEvent']);
+        } catch (\UnexpectedValueException $e) {
+            $this->assertSame('The provided check value is too long', $e->getMessage());
+        }
+    }
+
+    public function testValidateOperationDataLengthError(): void {
+        $check = [
+            'class' => ICheck::class,
+            'operator' => 'is',
+            'value' => 'barfoo',
+        ];
+        $operationData = str_pad('', IManager::MAX_OPERATION_VALUE_BYTES + 1, 'FooBar');
+
+        $operationMock = $this->createMock(IOperation::class);
+        $entityMock = $this->createMock(IEntity::class);
+        $eventEntityMock = $this->createMock(IEntityEvent::class);
+        $checkMock = $this->createMock(ICheck::class);
+        $scopeMock = $this->createMock(ScopeContext::class);
+
+        $scopeMock->expects($this->any())
+            ->method('getScope')
+            ->willReturn(IManager::SCOPE_ADMIN);
+
+        $operationMock->expects($this->once())
+            ->method('isAvailableForScope')
+            ->with(IManager::SCOPE_ADMIN)
+            ->willReturn(true);
+
+        $operationMock->expects($this->never())
+            ->method('validateOperation');
+
+        $entityMock->expects($this->any())
+            ->method('getEvents')
+            ->willReturn([$eventEntityMock]);
+
+        $eventEntityMock->expects($this->any())
+            ->method('getEventName')
+            ->willReturn('MyEvent');
+
+        $checkMock->expects($this->any())
+            ->method('supportedEntities')
+            ->willReturn([IEntity::class]);
+        $checkMock->expects($this->never())
+            ->method('validateCheck');
+
+        $this->container->expects($this->any())
+            ->method('get')
+            ->willReturnCallback(function ($className) use ($operationMock, $entityMock, $eventEntityMock, $checkMock) {
+                switch ($className) {
+                    case IOperation::class:
+                        return $operationMock;
+                    case IEntity::class:
+                        return $entityMock;
+                    case IEntityEvent::class:
+                        return $eventEntityMock;
+                    case ICheck::class:
+                        return $checkMock;
+                    default:
+                        return $this->createMock($className);
+                }
+            });
+
+        try {
+            $this->manager->validateOperation(IOperation::class, 'test', [$check], $operationData, $scopeMock, IEntity::class, ['MyEvent']);
+        } catch (\UnexpectedValueException $e) {
+            $this->assertSame('The provided operation data is too long', $e->getMessage());
+        }
+    }
+
+    public function testValidateOperationScopeNotAvailable(): void {
+        $check = [
+            'class' => ICheck::class,
+            'operator' => 'is',
+            'value' => 'barfoo',
+        ];
+        $operationData = str_pad('', IManager::MAX_OPERATION_VALUE_BYTES + 1, 'FooBar');
+
+        $operationMock = $this->createMock(IOperation::class);
+        $entityMock = $this->createMock(IEntity::class);
+        $eventEntityMock = $this->createMock(IEntityEvent::class);
+        $checkMock = $this->createMock(ICheck::class);
+        $scopeMock = $this->createMock(ScopeContext::class);
+
+        $scopeMock->expects($this->any())
+            ->method('getScope')
+            ->willReturn(IManager::SCOPE_ADMIN);
+
+        $operationMock->expects($this->once())
+            ->method('isAvailableForScope')
+            ->with(IManager::SCOPE_ADMIN)
+            ->willReturn(false);
+
+        $operationMock->expects($this->never())
+            ->method('validateOperation');
+
+        $entityMock->expects($this->any())
+            ->method('getEvents')
+            ->willReturn([$eventEntityMock]);
+
+        $eventEntityMock->expects($this->any())
+            ->method('getEventName')
+            ->willReturn('MyEvent');
+
+        $checkMock->expects($this->any())
+            ->method('supportedEntities')
+            ->willReturn([IEntity::class]);
+        $checkMock->expects($this->never())
+            ->method('validateCheck');
+
+        $this->container->expects($this->any())
+            ->method('get')
+            ->willReturnCallback(function ($className) use ($operationMock, $entityMock, $eventEntityMock, $checkMock) {
+                switch ($className) {
+                    case IOperation::class:
+                        return $operationMock;
+                    case IEntity::class:
+                        return $entityMock;
+                    case IEntityEvent::class:
+                        return $eventEntityMock;
+                    case ICheck::class:
+                        return $checkMock;
+                    default:
+                        return $this->createMock($className);
+                }
+            });
+
+        try {
+            $this->manager->validateOperation(IOperation::class, 'test', [$check], $operationData, $scopeMock, IEntity::class, ['MyEvent']);
+        } catch (\UnexpectedValueException $e) {
+            $this->assertSame('Operation OCP\WorkflowEngine\IOperation is invalid', $e->getMessage());
+        }
+    }
 }

apps/federatedfilesharing/lib/Migration/Version1011Date20201120125158.php

Indentation +31 added lines, -31 removed lines

@@ -18,35 +18,35 @@
 
 class Version1011Date20201120125158 extends SimpleMigrationStep {
 
-	public function __construct(
-		private IDBConnection $connection,
-	) {
-	}
-
-	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options) {
-		/** @var ISchemaWrapper $schema */
-		$schema = $schemaClosure();
-
-		if ($schema->hasTable('federated_reshares')) {
-			$table = $schema->getTable('federated_reshares');
-			$remoteIdColumn = $table->getColumn('remote_id');
-			if ($remoteIdColumn && Type::lookupName($remoteIdColumn->getType()) !== Types::STRING) {
-				$remoteIdColumn->setNotnull(false);
-				$remoteIdColumn->setType(Type::getType(Types::STRING));
-				$remoteIdColumn->setOptions(['length' => 255]);
-				$remoteIdColumn->setDefault('');
-				return $schema;
-			}
-		}
-
-		return null;
-	}
-
-	public function postSchemaChange(IOutput $output, \Closure $schemaClosure, array $options) {
-		$qb = $this->connection->getQueryBuilder();
-		$qb->update('federated_reshares')
-			->set('remote_id', $qb->createNamedParameter(''))
-			->where($qb->expr()->eq('remote_id', $qb->createNamedParameter('-1')));
-		$qb->executeStatement();
-	}
+    public function __construct(
+        private IDBConnection $connection,
+    ) {
+    }
+
+    public function changeSchema(IOutput $output, Closure $schemaClosure, array $options) {
+        /** @var ISchemaWrapper $schema */
+        $schema = $schemaClosure();
+
+        if ($schema->hasTable('federated_reshares')) {
+            $table = $schema->getTable('federated_reshares');
+            $remoteIdColumn = $table->getColumn('remote_id');
+            if ($remoteIdColumn && Type::lookupName($remoteIdColumn->getType()) !== Types::STRING) {
+                $remoteIdColumn->setNotnull(false);
+                $remoteIdColumn->setType(Type::getType(Types::STRING));
+                $remoteIdColumn->setOptions(['length' => 255]);
+                $remoteIdColumn->setDefault('');
+                return $schema;
+            }
+        }
+
+        return null;
+    }
+
+    public function postSchemaChange(IOutput $output, \Closure $schemaClosure, array $options) {
+        $qb = $this->connection->getQueryBuilder();
+        $qb->update('federated_reshares')
+            ->set('remote_id', $qb->createNamedParameter(''))
+            ->where($qb->expr()->eq('remote_id', $qb->createNamedParameter('-1')));
+        $qb->executeStatement();
+    }
 }

apps/files_external/tests/Service/StoragesServiceTestCase.php

Indentation +455 added lines, -455 removed lines

@@ -38,465 +38,465 @@
 use PHPUnit\Framework\MockObject\MockObject;
 
 class CleaningDBConfig extends DBConfigService {
-	private array $mountIds = [];
-
-	public function addMount($mountPoint, $storageBackend, $authBackend, $priority, $type) {
-		$id = parent::addMount($mountPoint, $storageBackend, $authBackend, $priority, $type); // TODO: Change the autogenerated stub
-		$this->mountIds[] = $id;
-		return $id;
-	}
-
-	public function clean() {
-		foreach ($this->mountIds as $id) {
-			$this->removeMount($id);
-		}
-	}
+    private array $mountIds = [];
+
+    public function addMount($mountPoint, $storageBackend, $authBackend, $priority, $type) {
+        $id = parent::addMount($mountPoint, $storageBackend, $authBackend, $priority, $type); // TODO: Change the autogenerated stub
+        $this->mountIds[] = $id;
+        return $id;
+    }
+
+    public function clean() {
+        foreach ($this->mountIds as $id) {
+            $this->removeMount($id);
+        }
+    }
 }
 
 /**
  * @group DB
  */
 abstract class StoragesServiceTestCase extends \Test\TestCase {
-	protected StoragesService $service;
-	protected BackendService&MockObject $backendService;
-	protected string $dataDir;
-	protected CleaningDBConfig $dbConfig;
-	protected static array $hookCalls;
-	protected IUserMountCache&MockObject $mountCache;
-	protected IEventDispatcher&MockObject $eventDispatcher;
-	protected IAppConfig&MockObject $appConfig;
-
-	protected function setUp(): void {
-		parent::setUp();
-		$this->dbConfig = new CleaningDBConfig(Server::get(IDBConnection::class), Server::get(ICrypto::class));
-		self::$hookCalls = [];
-		$config = Server::get(IConfig::class);
-		$this->dataDir = $config->getSystemValue(
-			'datadirectory',
-			\OC::$SERVERROOT . '/data/'
-		);
-		MountConfig::$skipTest = true;
-
-		$this->mountCache = $this->createMock(IUserMountCache::class);
-		$this->eventDispatcher = $this->createMock(IEventDispatcher::class);
-		$this->appConfig = $this->createMock(IAppConfig::class);
-
-		// prepare BackendService mock
-		$this->backendService = $this->createMock(BackendService::class);
-
-		$authMechanisms = [
-			'identifier:\Auth\Mechanism' => $this->getAuthMechMock('null', '\Auth\Mechanism'),
-			'identifier:\Other\Auth\Mechanism' => $this->getAuthMechMock('null', '\Other\Auth\Mechanism'),
-			'identifier:\OCA\Files_External\Lib\Auth\NullMechanism' => $this->getAuthMechMock(),
-		];
-		$this->backendService->method('getAuthMechanism')
-			->willReturnCallback(function ($class) use ($authMechanisms) {
-				if (isset($authMechanisms[$class])) {
-					return $authMechanisms[$class];
-				}
-				return null;
-			});
-		$this->backendService->method('getAuthMechanismsByScheme')
-			->willReturnCallback(function ($schemes) use ($authMechanisms) {
-				return array_filter($authMechanisms, function ($authMech) use ($schemes) {
-					return in_array($authMech->getScheme(), $schemes, true);
-				});
-			});
-		$this->backendService->method('getAuthMechanisms')
-			->willReturn($authMechanisms);
-
-		$sftpBackend = $this->getBackendMock('\OCA\Files_External\Lib\Backend\SFTP', '\OCA\Files_External\Lib\Storage\SFTP');
-		$backends = [
-			'identifier:\OCA\Files_External\Lib\Backend\DAV' => $this->getBackendMock('\OCA\Files_External\Lib\Backend\DAV', '\OC\Files\Storage\DAV'),
-			'identifier:\OCA\Files_External\Lib\Backend\SMB' => $this->getBackendMock('\OCA\Files_External\Lib\Backend\SMB', '\OCA\Files_External\Lib\Storage\SMB'),
-			'identifier:\OCA\Files_External\Lib\Backend\SFTP' => $sftpBackend,
-			'identifier:sftp_alias' => $sftpBackend,
-		];
-		$backends['identifier:\OCA\Files_External\Lib\Backend\SFTP']->method('getLegacyAuthMechanism')
-			->willReturn($authMechanisms['identifier:\Other\Auth\Mechanism']);
-		$this->backendService->method('getBackend')
-			->willReturnCallback(function ($backendClass) use ($backends) {
-				if (isset($backends[$backendClass])) {
-					return $backends[$backendClass];
-				}
-				return null;
-			});
-		$this->backendService->method('getBackends')
-			->willReturn($backends);
-		$this->overwriteService(BackendService::class, $this->backendService);
-
-		Util::connectHook(
-			Filesystem::CLASSNAME,
-			Filesystem::signal_create_mount,
-			get_class($this), 'createHookCallback');
-		Util::connectHook(
-			Filesystem::CLASSNAME,
-			Filesystem::signal_delete_mount,
-			get_class($this), 'deleteHookCallback');
-
-		$containerMock = $this->createMock(IAppContainer::class);
-		$containerMock->method('query')
-			->willReturnCallback(function ($name) {
-				if ($name === 'OCA\Files_External\Service\BackendService') {
-					return $this->backendService;
-				}
-			});
-	}
-
-	protected function tearDown(): void {
-		MountConfig::$skipTest = false;
-		self::$hookCalls = [];
-		if ($this->dbConfig) {
-			$this->dbConfig->clean();
-		}
-		parent::tearDown();
-	}
-
-	protected function getBackendMock($class = SMB::class, $storageClass = \OCA\Files_External\Lib\Storage\SMB::class) {
-		$backend = $this->createMock(Backend::class);
-		$backend->method('getStorageClass')
-			->willReturn($storageClass);
-		$backend->method('getIdentifier')
-			->willReturn('identifier:' . $class);
-		return $backend;
-	}
-
-	protected function getAuthMechMock($scheme = 'null', $class = NullMechanism::class) {
-		$authMech = $this->createMock(AuthMechanism::class);
-		$authMech->method('getScheme')
-			->willReturn($scheme);
-		$authMech->method('getIdentifier')
-			->willReturn('identifier:' . $class);
-
-		return $authMech;
-	}
-
-	/**
-	 * Creates a StorageConfig instance based on array data
-	 */
-	protected function makeStorageConfig(array $data): StorageConfig {
-		$storage = new StorageConfig();
-		if (isset($data['id'])) {
-			$storage->setId($data['id']);
-		}
-		$storage->setMountPoint($data['mountPoint']);
-		if (!isset($data['backend'])) {
-			// data providers are run before $this->backendService is initialised
-			// so $data['backend'] can be specified directly
-			$data['backend'] = $this->backendService->getBackend($data['backendIdentifier']);
-		}
-		if (!isset($data['backend'])) {
-			throw new \Exception('oops, no backend');
-		}
-		if (!isset($data['authMechanism'])) {
-			$data['authMechanism'] = $this->backendService->getAuthMechanism($data['authMechanismIdentifier']);
-		}
-		if (!isset($data['authMechanism'])) {
-			throw new \Exception('oops, no auth mechanism');
-		}
-		$storage->setBackend($data['backend']);
-		$storage->setAuthMechanism($data['authMechanism']);
-		$storage->setBackendOptions($data['backendOptions']);
-		if (isset($data['applicableUsers'])) {
-			$storage->setApplicableUsers($data['applicableUsers']);
-		}
-		if (isset($data['applicableGroups'])) {
-			$storage->setApplicableGroups($data['applicableGroups']);
-		}
-		if (isset($data['priority'])) {
-			$storage->setPriority($data['priority']);
-		}
-		if (isset($data['mountOptions'])) {
-			$storage->setMountOptions($data['mountOptions']);
-		}
-		return $storage;
-	}
-
-
-	protected function ActualNonExistingStorageTest() {
-		$backend = $this->backendService->getBackend('identifier:\OCA\Files_External\Lib\Backend\SMB');
-		$authMechanism = $this->backendService->getAuthMechanism('identifier:\Auth\Mechanism');
-		$storage = new StorageConfig(255);
-		$storage->setMountPoint('mountpoint');
-		$storage->setBackend($backend);
-		$storage->setAuthMechanism($authMechanism);
-		$this->service->updateStorage($storage);
-	}
-
-	public function testNonExistingStorage(): void {
-		$this->expectException(NotFoundException::class);
-
-		$this->ActualNonExistingStorageTest();
-	}
-
-	public static function deleteStorageDataProvider(): array {
-		return [
-			// regular case, can properly delete the oc_storages entry
-			[
-				[
-					'host' => 'example.com',
-					'user' => 'test',
-					'password' => 'testPassword',
-					'root' => 'someroot',
-				],
-				'webdav::test@example.com//someroot/'
-			],
-			[
-				[
-					'host' => 'example.com',
-					'user' => '$user',
-					'password' => 'testPassword',
-					'root' => 'someroot',
-				],
-				'webdav::someone@example.com//someroot/'
-			],
-		];
-	}
-
-	#[\PHPUnit\Framework\Attributes\DataProvider('deleteStorageDataProvider')]
-	public function testDeleteStorage(array $backendOptions, string $rustyStorageId): void {
-		$backend = $this->backendService->getBackend('identifier:\OCA\Files_External\Lib\Backend\DAV');
-		$authMechanism = $this->backendService->getAuthMechanism('identifier:\Auth\Mechanism');
-		$storage = new StorageConfig(255);
-		$storage->setMountPoint('mountpoint');
-		$storage->setBackend($backend);
-		$storage->setAuthMechanism($authMechanism);
-		$storage->setBackendOptions($backendOptions);
-
-		$newStorage = $this->service->addStorage($storage);
-		$id = $newStorage->getId();
-
-		// manually trigger storage entry because normally it happens on first
-		// access, which isn't possible within this test
-		$storageCache = new Storage($rustyStorageId, true, Server::get(IDBConnection::class));
-
-		/** @var IUserMountCache $mountCache */
-		$mountCache = Server::get(IUserMountCache::class);
-		$mountCache->clear();
-		$user = $this->createMock(IUser::class);
-		$user->method('getUID')->willReturn('test');
-		$cache = $this->createMock(ICache::class);
-		$storage = $this->createMock(IStorage::class);
-		$storage->method('getCache')->willReturn($cache);
-		$mount = $this->createMock(IMountPoint::class);
-		$mount->method('getStorage')
-			->willReturn($storage);
-		$mount->method('getStorageId')
-			->willReturn($rustyStorageId);
-		$mount->method('getNumericStorageId')
-			->willReturn($storageCache->getNumericId());
-		$mount->method('getStorageRootId')
-			->willReturn(1);
-		$mount->method('getMountPoint')
-			->willReturn('dummy');
-		$mount->method('getMountId')
-			->willReturn($id);
-		$mountCache->registerMounts($user, [
-			$mount
-		]);
-
-		// get numeric id for later check
-		$numericId = $storageCache->getNumericId();
-
-		$this->service->removeStorage($id);
-
-		$caught = false;
-		try {
-			$this->service->getStorage(1);
-		} catch (NotFoundException $e) {
-			$caught = true;
-		}
-
-		$this->assertTrue($caught);
-
-		// storage id was removed from oc_storages
-		$qb = Server::get(IDBConnection::class)->getQueryBuilder();
-		$storageCheckQuery = $qb->select('*')
-			->from('storages')
-			->where($qb->expr()->eq('numeric_id', $qb->expr()->literal($numericId)));
-
-		$result = $storageCheckQuery->executeQuery();
-		$storages = $result->fetchAll();
-		$result->closeCursor();
-		$this->assertCount(0, $storages, 'expected 0 storages, got ' . json_encode($storages));
-	}
-
-	protected function actualDeletedUnexistingStorageTest() {
-		$this->service->removeStorage(255);
-	}
-
-	public function testDeleteUnexistingStorage(): void {
-		$this->expectException(NotFoundException::class);
-
-		$this->actualDeletedUnexistingStorageTest();
-	}
-
-	public function testCreateStorage(): void {
-		$mountPoint = 'mount';
-		$backendIdentifier = 'identifier:\OCA\Files_External\Lib\Backend\SMB';
-		$authMechanismIdentifier = 'identifier:\Auth\Mechanism';
-		$backendOptions = ['param' => 'foo', 'param2' => 'bar'];
-		$mountOptions = ['option' => 'foobar'];
-		$applicableUsers = ['user1', 'user2'];
-		$applicableGroups = ['group'];
-		$priority = 123;
-
-		$backend = $this->backendService->getBackend($backendIdentifier);
-		$authMechanism = $this->backendService->getAuthMechanism($authMechanismIdentifier);
-
-		$storage = $this->service->createStorage(
-			$mountPoint,
-			$backendIdentifier,
-			$authMechanismIdentifier,
-			$backendOptions,
-			$mountOptions,
-			$applicableUsers,
-			$applicableGroups,
-			$priority
-		);
-
-		$this->assertEquals('/' . $mountPoint, $storage->getMountPoint());
-		$this->assertEquals($backend, $storage->getBackend());
-		$this->assertEquals($authMechanism, $storage->getAuthMechanism());
-		$this->assertEquals($backendOptions, $storage->getBackendOptions());
-		$this->assertEquals($mountOptions, $storage->getMountOptions());
-		$this->assertEquals($applicableUsers, $storage->getApplicableUsers());
-		$this->assertEquals($applicableGroups, $storage->getApplicableGroups());
-		$this->assertEquals($priority, $storage->getPriority());
-	}
-
-	public function testCreateStorageInvalidClass(): void {
-		$storage = $this->service->createStorage(
-			'mount',
-			'identifier:\OC\Not\A\Backend',
-			'identifier:\Auth\Mechanism',
-			[]
-		);
-		$this->assertInstanceOf(InvalidBackend::class, $storage->getBackend());
-	}
-
-	public function testCreateStorageInvalidAuthMechanismClass(): void {
-		$storage = $this->service->createStorage(
-			'mount',
-			'identifier:\OCA\Files_External\Lib\Backend\SMB',
-			'identifier:\Not\An\Auth\Mechanism',
-			[]
-		);
-		$this->assertInstanceOf(InvalidAuth::class, $storage->getAuthMechanism());
-	}
-
-	public function testGetStoragesBackendNotVisible(): void {
-		$backend = $this->backendService->getBackend('identifier:\OCA\Files_External\Lib\Backend\SMB');
-		$backend->expects($this->once())
-			->method('isVisibleFor')
-			->with($this->service->getVisibilityType())
-			->willReturn(false);
-		$authMechanism = $this->backendService->getAuthMechanism('identifier:\Auth\Mechanism');
-		$authMechanism->method('isVisibleFor')
-			->with($this->service->getVisibilityType())
-			->willReturn(true);
-
-		$storage = new StorageConfig(255);
-		$storage->setMountPoint('mountpoint');
-		$storage->setBackend($backend);
-		$storage->setAuthMechanism($authMechanism);
-		$storage->setBackendOptions(['password' => 'testPassword']);
-
-		$newStorage = $this->service->addStorage($storage);
-
-		$this->assertCount(1, $this->service->getAllStorages());
-		$this->assertEmpty($this->service->getStorages());
-	}
-
-	public function testGetStoragesAuthMechanismNotVisible(): void {
-		$backend = $this->backendService->getBackend('identifier:\OCA\Files_External\Lib\Backend\SMB');
-		$backend->method('isVisibleFor')
-			->with($this->service->getVisibilityType())
-			->willReturn(true);
-		$authMechanism = $this->backendService->getAuthMechanism('identifier:\Auth\Mechanism');
-		$authMechanism->expects($this->once())
-			->method('isVisibleFor')
-			->with($this->service->getVisibilityType())
-			->willReturn(false);
-
-		$storage = new StorageConfig(255);
-		$storage->setMountPoint('mountpoint');
-		$storage->setBackend($backend);
-		$storage->setAuthMechanism($authMechanism);
-		$storage->setBackendOptions(['password' => 'testPassword']);
-
-		$newStorage = $this->service->addStorage($storage);
-
-		$this->assertCount(1, $this->service->getAllStorages());
-		$this->assertEmpty($this->service->getStorages());
-	}
-
-	public static function createHookCallback($params): void {
-		self::$hookCalls[] = [
-			'signal' => Filesystem::signal_create_mount,
-			'params' => $params
-		];
-	}
-
-	public static function deleteHookCallback($params): void {
-		self::$hookCalls[] = [
-			'signal' => Filesystem::signal_delete_mount,
-			'params' => $params
-		];
-	}
-
-	/**
-	 * Asserts hook call
-	 *
-	 * @param array $callData hook call data to check
-	 * @param string $signal signal name
-	 * @param string $mountPath mount path
-	 * @param string $mountType mount type
-	 * @param string $applicable applicable users
-	 */
-	protected function assertHookCall($callData, $signal, $mountPath, $mountType, $applicable) {
-		$this->assertEquals($signal, $callData['signal']);
-		$params = $callData['params'];
-		$this->assertEquals(
-			$mountPath,
-			$params[Filesystem::signal_param_path]
-		);
-		$this->assertEquals(
-			$mountType,
-			$params[Filesystem::signal_param_mount_type]
-		);
-		$this->assertEquals(
-			$applicable,
-			$params[Filesystem::signal_param_users]
-		);
-	}
-
-	public function testUpdateStorageMountPoint(): void {
-		$backend = $this->backendService->getBackend('identifier:\OCA\Files_External\Lib\Backend\SMB');
-		$authMechanism = $this->backendService->getAuthMechanism('identifier:\Auth\Mechanism');
-
-		$storage = new StorageConfig();
-		$storage->setMountPoint('mountpoint');
-		$storage->setBackend($backend);
-		$storage->setAuthMechanism($authMechanism);
-		$storage->setBackendOptions(['password' => 'testPassword']);
-
-		$savedStorage = $this->service->addStorage($storage);
-
-		$newAuthMechanism = $this->backendService->getAuthMechanism('identifier:\Other\Auth\Mechanism');
-
-		$updatedStorage = new StorageConfig($savedStorage->getId());
-		$updatedStorage->setMountPoint('mountpoint2');
-		$updatedStorage->setBackend($backend);
-		$updatedStorage->setAuthMechanism($newAuthMechanism);
-		$updatedStorage->setBackendOptions(['password' => 'password2']);
-
-		$this->service->updateStorage($updatedStorage);
-
-		$savedStorage = $this->service->getStorage($updatedStorage->getId());
-
-		$this->assertEquals('/mountpoint2', $savedStorage->getMountPoint());
-		$this->assertEquals($newAuthMechanism, $savedStorage->getAuthMechanism());
-		$this->assertEquals('password2', $savedStorage->getBackendOption('password'));
-	}
+    protected StoragesService $service;
+    protected BackendService&MockObject $backendService;
+    protected string $dataDir;
+    protected CleaningDBConfig $dbConfig;
+    protected static array $hookCalls;
+    protected IUserMountCache&MockObject $mountCache;
+    protected IEventDispatcher&MockObject $eventDispatcher;
+    protected IAppConfig&MockObject $appConfig;
+
+    protected function setUp(): void {
+        parent::setUp();
+        $this->dbConfig = new CleaningDBConfig(Server::get(IDBConnection::class), Server::get(ICrypto::class));
+        self::$hookCalls = [];
+        $config = Server::get(IConfig::class);
+        $this->dataDir = $config->getSystemValue(
+            'datadirectory',
+            \OC::$SERVERROOT . '/data/'
+        );
+        MountConfig::$skipTest = true;
+
+        $this->mountCache = $this->createMock(IUserMountCache::class);
+        $this->eventDispatcher = $this->createMock(IEventDispatcher::class);
+        $this->appConfig = $this->createMock(IAppConfig::class);
+
+        // prepare BackendService mock
+        $this->backendService = $this->createMock(BackendService::class);
+
+        $authMechanisms = [
+            'identifier:\Auth\Mechanism' => $this->getAuthMechMock('null', '\Auth\Mechanism'),
+            'identifier:\Other\Auth\Mechanism' => $this->getAuthMechMock('null', '\Other\Auth\Mechanism'),
+            'identifier:\OCA\Files_External\Lib\Auth\NullMechanism' => $this->getAuthMechMock(),
+        ];
+        $this->backendService->method('getAuthMechanism')
+            ->willReturnCallback(function ($class) use ($authMechanisms) {
+                if (isset($authMechanisms[$class])) {
+                    return $authMechanisms[$class];
+                }
+                return null;
+            });
+        $this->backendService->method('getAuthMechanismsByScheme')
+            ->willReturnCallback(function ($schemes) use ($authMechanisms) {
+                return array_filter($authMechanisms, function ($authMech) use ($schemes) {
+                    return in_array($authMech->getScheme(), $schemes, true);
+                });
+            });
+        $this->backendService->method('getAuthMechanisms')
+            ->willReturn($authMechanisms);
+
+        $sftpBackend = $this->getBackendMock('\OCA\Files_External\Lib\Backend\SFTP', '\OCA\Files_External\Lib\Storage\SFTP');
+        $backends = [
+            'identifier:\OCA\Files_External\Lib\Backend\DAV' => $this->getBackendMock('\OCA\Files_External\Lib\Backend\DAV', '\OC\Files\Storage\DAV'),
+            'identifier:\OCA\Files_External\Lib\Backend\SMB' => $this->getBackendMock('\OCA\Files_External\Lib\Backend\SMB', '\OCA\Files_External\Lib\Storage\SMB'),
+            'identifier:\OCA\Files_External\Lib\Backend\SFTP' => $sftpBackend,
+            'identifier:sftp_alias' => $sftpBackend,
+        ];
+        $backends['identifier:\OCA\Files_External\Lib\Backend\SFTP']->method('getLegacyAuthMechanism')
+            ->willReturn($authMechanisms['identifier:\Other\Auth\Mechanism']);
+        $this->backendService->method('getBackend')
+            ->willReturnCallback(function ($backendClass) use ($backends) {
+                if (isset($backends[$backendClass])) {
+                    return $backends[$backendClass];
+                }
+                return null;
+            });
+        $this->backendService->method('getBackends')
+            ->willReturn($backends);
+        $this->overwriteService(BackendService::class, $this->backendService);
+
+        Util::connectHook(
+            Filesystem::CLASSNAME,
+            Filesystem::signal_create_mount,
+            get_class($this), 'createHookCallback');
+        Util::connectHook(
+            Filesystem::CLASSNAME,
+            Filesystem::signal_delete_mount,
+            get_class($this), 'deleteHookCallback');
+
+        $containerMock = $this->createMock(IAppContainer::class);
+        $containerMock->method('query')
+            ->willReturnCallback(function ($name) {
+                if ($name === 'OCA\Files_External\Service\BackendService') {
+                    return $this->backendService;
+                }
+            });
+    }
+
+    protected function tearDown(): void {
+        MountConfig::$skipTest = false;
+        self::$hookCalls = [];
+        if ($this->dbConfig) {
+            $this->dbConfig->clean();
+        }
+        parent::tearDown();
+    }
+
+    protected function getBackendMock($class = SMB::class, $storageClass = \OCA\Files_External\Lib\Storage\SMB::class) {
+        $backend = $this->createMock(Backend::class);
+        $backend->method('getStorageClass')
+            ->willReturn($storageClass);
+        $backend->method('getIdentifier')
+            ->willReturn('identifier:' . $class);
+        return $backend;
+    }
+
+    protected function getAuthMechMock($scheme = 'null', $class = NullMechanism::class) {
+        $authMech = $this->createMock(AuthMechanism::class);
+        $authMech->method('getScheme')
+            ->willReturn($scheme);
+        $authMech->method('getIdentifier')
+            ->willReturn('identifier:' . $class);
+
+        return $authMech;
+    }
+
+    /**
+     * Creates a StorageConfig instance based on array data
+     */
+    protected function makeStorageConfig(array $data): StorageConfig {
+        $storage = new StorageConfig();
+        if (isset($data['id'])) {
+            $storage->setId($data['id']);
+        }
+        $storage->setMountPoint($data['mountPoint']);
+        if (!isset($data['backend'])) {
+            // data providers are run before $this->backendService is initialised
+            // so $data['backend'] can be specified directly
+            $data['backend'] = $this->backendService->getBackend($data['backendIdentifier']);
+        }
+        if (!isset($data['backend'])) {
+            throw new \Exception('oops, no backend');
+        }
+        if (!isset($data['authMechanism'])) {
+            $data['authMechanism'] = $this->backendService->getAuthMechanism($data['authMechanismIdentifier']);
+        }
+        if (!isset($data['authMechanism'])) {
+            throw new \Exception('oops, no auth mechanism');
+        }
+        $storage->setBackend($data['backend']);
+        $storage->setAuthMechanism($data['authMechanism']);
+        $storage->setBackendOptions($data['backendOptions']);
+        if (isset($data['applicableUsers'])) {
+            $storage->setApplicableUsers($data['applicableUsers']);
+        }
+        if (isset($data['applicableGroups'])) {
+            $storage->setApplicableGroups($data['applicableGroups']);
+        }
+        if (isset($data['priority'])) {
+            $storage->setPriority($data['priority']);
+        }
+        if (isset($data['mountOptions'])) {
+            $storage->setMountOptions($data['mountOptions']);
+        }
+        return $storage;
+    }
+
+
+    protected function ActualNonExistingStorageTest() {
+        $backend = $this->backendService->getBackend('identifier:\OCA\Files_External\Lib\Backend\SMB');
+        $authMechanism = $this->backendService->getAuthMechanism('identifier:\Auth\Mechanism');
+        $storage = new StorageConfig(255);
+        $storage->setMountPoint('mountpoint');
+        $storage->setBackend($backend);
+        $storage->setAuthMechanism($authMechanism);
+        $this->service->updateStorage($storage);
+    }
+
+    public function testNonExistingStorage(): void {
+        $this->expectException(NotFoundException::class);
+
+        $this->ActualNonExistingStorageTest();
+    }
+
+    public static function deleteStorageDataProvider(): array {
+        return [
+            // regular case, can properly delete the oc_storages entry
+            [
+                [
+                    'host' => 'example.com',
+                    'user' => 'test',
+                    'password' => 'testPassword',
+                    'root' => 'someroot',
+                ],
+                'webdav::test@example.com//someroot/'
+            ],
+            [
+                [
+                    'host' => 'example.com',
+                    'user' => '$user',
+                    'password' => 'testPassword',
+                    'root' => 'someroot',
+                ],
+                'webdav::someone@example.com//someroot/'
+            ],
+        ];
+    }
+
+    #[\PHPUnit\Framework\Attributes\DataProvider('deleteStorageDataProvider')]
+    public function testDeleteStorage(array $backendOptions, string $rustyStorageId): void {
+        $backend = $this->backendService->getBackend('identifier:\OCA\Files_External\Lib\Backend\DAV');
+        $authMechanism = $this->backendService->getAuthMechanism('identifier:\Auth\Mechanism');
+        $storage = new StorageConfig(255);
+        $storage->setMountPoint('mountpoint');
+        $storage->setBackend($backend);
+        $storage->setAuthMechanism($authMechanism);
+        $storage->setBackendOptions($backendOptions);
+
+        $newStorage = $this->service->addStorage($storage);
+        $id = $newStorage->getId();
+
+        // manually trigger storage entry because normally it happens on first
+        // access, which isn't possible within this test
+        $storageCache = new Storage($rustyStorageId, true, Server::get(IDBConnection::class));
+
+        /** @var IUserMountCache $mountCache */
+        $mountCache = Server::get(IUserMountCache::class);
+        $mountCache->clear();
+        $user = $this->createMock(IUser::class);
+        $user->method('getUID')->willReturn('test');
+        $cache = $this->createMock(ICache::class);
+        $storage = $this->createMock(IStorage::class);
+        $storage->method('getCache')->willReturn($cache);
+        $mount = $this->createMock(IMountPoint::class);
+        $mount->method('getStorage')
+            ->willReturn($storage);
+        $mount->method('getStorageId')
+            ->willReturn($rustyStorageId);
+        $mount->method('getNumericStorageId')
+            ->willReturn($storageCache->getNumericId());
+        $mount->method('getStorageRootId')
+            ->willReturn(1);
+        $mount->method('getMountPoint')
+            ->willReturn('dummy');
+        $mount->method('getMountId')
+            ->willReturn($id);
+        $mountCache->registerMounts($user, [
+            $mount
+        ]);
+
+        // get numeric id for later check
+        $numericId = $storageCache->getNumericId();
+
+        $this->service->removeStorage($id);
+
+        $caught = false;
+        try {
+            $this->service->getStorage(1);
+        } catch (NotFoundException $e) {
+            $caught = true;
+        }
+
+        $this->assertTrue($caught);
+
+        // storage id was removed from oc_storages
+        $qb = Server::get(IDBConnection::class)->getQueryBuilder();
+        $storageCheckQuery = $qb->select('*')
+            ->from('storages')
+            ->where($qb->expr()->eq('numeric_id', $qb->expr()->literal($numericId)));
+
+        $result = $storageCheckQuery->executeQuery();
+        $storages = $result->fetchAll();
+        $result->closeCursor();
+        $this->assertCount(0, $storages, 'expected 0 storages, got ' . json_encode($storages));
+    }
+
+    protected function actualDeletedUnexistingStorageTest() {
+        $this->service->removeStorage(255);
+    }
+
+    public function testDeleteUnexistingStorage(): void {
+        $this->expectException(NotFoundException::class);
+
+        $this->actualDeletedUnexistingStorageTest();
+    }
+
+    public function testCreateStorage(): void {
+        $mountPoint = 'mount';
+        $backendIdentifier = 'identifier:\OCA\Files_External\Lib\Backend\SMB';
+        $authMechanismIdentifier = 'identifier:\Auth\Mechanism';
+        $backendOptions = ['param' => 'foo', 'param2' => 'bar'];
+        $mountOptions = ['option' => 'foobar'];
+        $applicableUsers = ['user1', 'user2'];
+        $applicableGroups = ['group'];
+        $priority = 123;
+
+        $backend = $this->backendService->getBackend($backendIdentifier);
+        $authMechanism = $this->backendService->getAuthMechanism($authMechanismIdentifier);
+
+        $storage = $this->service->createStorage(
+            $mountPoint,
+            $backendIdentifier,
+            $authMechanismIdentifier,
+            $backendOptions,
+            $mountOptions,
+            $applicableUsers,
+            $applicableGroups,
+            $priority
+        );
+
+        $this->assertEquals('/' . $mountPoint, $storage->getMountPoint());
+        $this->assertEquals($backend, $storage->getBackend());
+        $this->assertEquals($authMechanism, $storage->getAuthMechanism());
+        $this->assertEquals($backendOptions, $storage->getBackendOptions());
+        $this->assertEquals($mountOptions, $storage->getMountOptions());
+        $this->assertEquals($applicableUsers, $storage->getApplicableUsers());
+        $this->assertEquals($applicableGroups, $storage->getApplicableGroups());
+        $this->assertEquals($priority, $storage->getPriority());
+    }
+
+    public function testCreateStorageInvalidClass(): void {
+        $storage = $this->service->createStorage(
+            'mount',
+            'identifier:\OC\Not\A\Backend',
+            'identifier:\Auth\Mechanism',
+            []
+        );
+        $this->assertInstanceOf(InvalidBackend::class, $storage->getBackend());
+    }
+
+    public function testCreateStorageInvalidAuthMechanismClass(): void {
+        $storage = $this->service->createStorage(
+            'mount',
+            'identifier:\OCA\Files_External\Lib\Backend\SMB',
+            'identifier:\Not\An\Auth\Mechanism',
+            []
+        );
+        $this->assertInstanceOf(InvalidAuth::class, $storage->getAuthMechanism());
+    }
+
+    public function testGetStoragesBackendNotVisible(): void {
+        $backend = $this->backendService->getBackend('identifier:\OCA\Files_External\Lib\Backend\SMB');
+        $backend->expects($this->once())
+            ->method('isVisibleFor')
+            ->with($this->service->getVisibilityType())
+            ->willReturn(false);
+        $authMechanism = $this->backendService->getAuthMechanism('identifier:\Auth\Mechanism');
+        $authMechanism->method('isVisibleFor')
+            ->with($this->service->getVisibilityType())
+            ->willReturn(true);
+
+        $storage = new StorageConfig(255);
+        $storage->setMountPoint('mountpoint');
+        $storage->setBackend($backend);
+        $storage->setAuthMechanism($authMechanism);
+        $storage->setBackendOptions(['password' => 'testPassword']);
+
+        $newStorage = $this->service->addStorage($storage);
+
+        $this->assertCount(1, $this->service->getAllStorages());
+        $this->assertEmpty($this->service->getStorages());
+    }
+
+    public function testGetStoragesAuthMechanismNotVisible(): void {
+        $backend = $this->backendService->getBackend('identifier:\OCA\Files_External\Lib\Backend\SMB');
+        $backend->method('isVisibleFor')
+            ->with($this->service->getVisibilityType())
+            ->willReturn(true);
+        $authMechanism = $this->backendService->getAuthMechanism('identifier:\Auth\Mechanism');
+        $authMechanism->expects($this->once())
+            ->method('isVisibleFor')
+            ->with($this->service->getVisibilityType())
+            ->willReturn(false);
+
+        $storage = new StorageConfig(255);
+        $storage->setMountPoint('mountpoint');
+        $storage->setBackend($backend);
+        $storage->setAuthMechanism($authMechanism);
+        $storage->setBackendOptions(['password' => 'testPassword']);
+
+        $newStorage = $this->service->addStorage($storage);
+
+        $this->assertCount(1, $this->service->getAllStorages());
+        $this->assertEmpty($this->service->getStorages());
+    }
+
+    public static function createHookCallback($params): void {
+        self::$hookCalls[] = [
+            'signal' => Filesystem::signal_create_mount,
+            'params' => $params
+        ];
+    }
+
+    public static function deleteHookCallback($params): void {
+        self::$hookCalls[] = [
+            'signal' => Filesystem::signal_delete_mount,
+            'params' => $params
+        ];
+    }
+
+    /**
+     * Asserts hook call
+     *
+     * @param array $callData hook call data to check
+     * @param string $signal signal name
+     * @param string $mountPath mount path
+     * @param string $mountType mount type
+     * @param string $applicable applicable users
+     */
+    protected function assertHookCall($callData, $signal, $mountPath, $mountType, $applicable) {
+        $this->assertEquals($signal, $callData['signal']);
+        $params = $callData['params'];
+        $this->assertEquals(
+            $mountPath,
+            $params[Filesystem::signal_param_path]
+        );
+        $this->assertEquals(
+            $mountType,
+            $params[Filesystem::signal_param_mount_type]
+        );
+        $this->assertEquals(
+            $applicable,
+            $params[Filesystem::signal_param_users]
+        );
+    }
+
+    public function testUpdateStorageMountPoint(): void {
+        $backend = $this->backendService->getBackend('identifier:\OCA\Files_External\Lib\Backend\SMB');
+        $authMechanism = $this->backendService->getAuthMechanism('identifier:\Auth\Mechanism');
+
+        $storage = new StorageConfig();
+        $storage->setMountPoint('mountpoint');
+        $storage->setBackend($backend);
+        $storage->setAuthMechanism($authMechanism);
+        $storage->setBackendOptions(['password' => 'testPassword']);
+
+        $savedStorage = $this->service->addStorage($storage);
+
+        $newAuthMechanism = $this->backendService->getAuthMechanism('identifier:\Other\Auth\Mechanism');
+
+        $updatedStorage = new StorageConfig($savedStorage->getId());
+        $updatedStorage->setMountPoint('mountpoint2');
+        $updatedStorage->setBackend($backend);
+        $updatedStorage->setAuthMechanism($newAuthMechanism);
+        $updatedStorage->setBackendOptions(['password' => 'password2']);
+
+        $this->service->updateStorage($updatedStorage);
+
+        $savedStorage = $this->service->getStorage($updatedStorage->getId());
+
+        $this->assertEquals('/mountpoint2', $savedStorage->getMountPoint());
+        $this->assertEquals($newAuthMechanism, $savedStorage->getAuthMechanism());
+        $this->assertEquals('password2', $savedStorage->getBackendOption('password'));
+    }
 }

Spacing +10 added lines, -10 removed lines

@@ -73,7 +73,7 @@ 
 		$config = Server::get(IConfig::class);
 		$this->dataDir = $config->getSystemValue(
 			'datadirectory',
-			\OC::$SERVERROOT . '/data/'
+			\OC::$SERVERROOT.'/data/'
 		);
 		MountConfig::$skipTest = true;
 
@@ -90,15 +90,15 @@ 
 			'identifier:\OCA\Files_External\Lib\Auth\NullMechanism' => $this->getAuthMechMock(),
 		];
 		$this->backendService->method('getAuthMechanism')
-			->willReturnCallback(function ($class) use ($authMechanisms) {
+			->willReturnCallback(function($class) use ($authMechanisms) {
 				if (isset($authMechanisms[$class])) {
 					return $authMechanisms[$class];
 				}
 				return null;
 			});
 		$this->backendService->method('getAuthMechanismsByScheme')
-			->willReturnCallback(function ($schemes) use ($authMechanisms) {
-				return array_filter($authMechanisms, function ($authMech) use ($schemes) {
+			->willReturnCallback(function($schemes) use ($authMechanisms) {
+				return array_filter($authMechanisms, function($authMech) use ($schemes) {
 					return in_array($authMech->getScheme(), $schemes, true);
 				});
 			});
@@ -115,7 +115,7 @@ 
 		$backends['identifier:\OCA\Files_External\Lib\Backend\SFTP']->method('getLegacyAuthMechanism')
 			->willReturn($authMechanisms['identifier:\Other\Auth\Mechanism']);
 		$this->backendService->method('getBackend')
-			->willReturnCallback(function ($backendClass) use ($backends) {
+			->willReturnCallback(function($backendClass) use ($backends) {
 				if (isset($backends[$backendClass])) {
 					return $backends[$backendClass];
 				}
@@ -136,7 +136,7 @@ 
 
 		$containerMock = $this->createMock(IAppContainer::class);
 		$containerMock->method('query')
-			->willReturnCallback(function ($name) {
+			->willReturnCallback(function($name) {
 				if ($name === 'OCA\Files_External\Service\BackendService') {
 					return $this->backendService;
 				}
@@ -157,7 +157,7 @@ 
 		$backend->method('getStorageClass')
 			->willReturn($storageClass);
 		$backend->method('getIdentifier')
-			->willReturn('identifier:' . $class);
+			->willReturn('identifier:'.$class);
 		return $backend;
 	}
 
@@ -166,7 +166,7 @@ 
 		$authMech->method('getScheme')
 			->willReturn($scheme);
 		$authMech->method('getIdentifier')
-			->willReturn('identifier:' . $class);
+			->willReturn('identifier:'.$class);
 
 		return $authMech;
 	}
@@ -318,7 +318,7 @@ 
 		$result = $storageCheckQuery->executeQuery();
 		$storages = $result->fetchAll();
 		$result->closeCursor();
-		$this->assertCount(0, $storages, 'expected 0 storages, got ' . json_encode($storages));
+		$this->assertCount(0, $storages, 'expected 0 storages, got '.json_encode($storages));
 	}
 
 	protected function actualDeletedUnexistingStorageTest() {
@@ -355,7 +355,7 @@ 
 			$priority
 		);
 
-		$this->assertEquals('/' . $mountPoint, $storage->getMountPoint());
+		$this->assertEquals('/'.$mountPoint, $storage->getMountPoint());
 		$this->assertEquals($backend, $storage->getBackend());
 		$this->assertEquals($authMechanism, $storage->getAuthMechanism());
 		$this->assertEquals($backendOptions, $storage->getBackendOptions());