feat(dbal): Add missing stuff in DBAL wrapper

Signed-off-by: Carl Schwan <carl@carlschwan.eu>

Author: CarlSchwan

apps/dav/lib/Migration/Version1034Date20250605132605.php

@@ -60,6 +60,7 @@ public function changeSchema(IOutput $output, Closure $schemaClosure, array $opt
 				'notnull' => true,
 				'length' => 255,
 			]);
+			/** @psalm-suppress InvalidArgument legacy column */
 			$federatedCalendarsTable->addColumn('remote_Url', Types::STRING, [
 				'notnull' => true,
 				'length' => 255,

lib/composer/composer/autoload_classmap.php

@@ -373,6 +373,7 @@
     'OCP\\DB\\QueryBuilder\\ITypedQueryBuilder' => $baseDir . '/lib/public/DB/QueryBuilder/ITypedQueryBuilder.php',
     'OCP\\DB\\QueryBuilder\\Sharded\\IShardMapper' => $baseDir . '/lib/public/DB/QueryBuilder/Sharded/IShardMapper.php',
     'OCP\\DB\\Schema\\IColumn' => $baseDir . '/lib/public/DB/Schema/IColumn.php',
+    'OCP\\DB\\Schema\\IForeignKeyConstraint' => $baseDir . '/lib/public/DB/Schema/IForeignKeyConstraint.php',
     'OCP\\DB\\Schema\\IIndex' => $baseDir . '/lib/public/DB/Schema/IIndex.php',
     'OCP\\DB\\Schema\\ITable' => $baseDir . '/lib/public/DB/Schema/ITable.php',
     'OCP\\DB\\Schema\\IType' => $baseDir . '/lib/public/DB/Schema/IType.php',
@@ -1785,6 +1786,7 @@
     'OC\\DB\\SQLiteSessionInit' => $baseDir . '/lib/private/DB/SQLiteSessionInit.php',
     'OC\\DB\\SchemaWrapper' => $baseDir . '/lib/private/DB/SchemaWrapper.php',
     'OC\\DB\\Schema\\Column' => $baseDir . '/lib/private/DB/Schema/Column.php',
+    'OC\\DB\\Schema\\ForeignKeyConstraint' => $baseDir . '/lib/private/DB/Schema/ForeignKeyConstraint.php',
     'OC\\DB\\Schema\\Index' => $baseDir . '/lib/private/DB/Schema/Index.php',
     'OC\\DB\\Schema\\Table' => $baseDir . '/lib/private/DB/Schema/Table.php',
     'OC\\DB\\Schema\\Type' => $baseDir . '/lib/private/DB/Schema/Type.php',

lib/composer/composer/autoload_static.php

@@ -414,6 +414,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OCP\\DB\\QueryBuilder\\ITypedQueryBuilder' => __DIR__ . '/../../..' . '/lib/public/DB/QueryBuilder/ITypedQueryBuilder.php',
         'OCP\\DB\\QueryBuilder\\Sharded\\IShardMapper' => __DIR__ . '/../../..' . '/lib/public/DB/QueryBuilder/Sharded/IShardMapper.php',
         'OCP\\DB\\Schema\\IColumn' => __DIR__ . '/../../..' . '/lib/public/DB/Schema/IColumn.php',
+        'OCP\\DB\\Schema\\IForeignKeyConstraint' => __DIR__ . '/../../..' . '/lib/public/DB/Schema/IForeignKeyConstraint.php',
         'OCP\\DB\\Schema\\IIndex' => __DIR__ . '/../../..' . '/lib/public/DB/Schema/IIndex.php',
         'OCP\\DB\\Schema\\ITable' => __DIR__ . '/../../..' . '/lib/public/DB/Schema/ITable.php',
         'OCP\\DB\\Schema\\IType' => __DIR__ . '/../../..' . '/lib/public/DB/Schema/IType.php',
@@ -1826,6 +1827,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OC\\DB\\SQLiteSessionInit' => __DIR__ . '/../../..' . '/lib/private/DB/SQLiteSessionInit.php',
         'OC\\DB\\SchemaWrapper' => __DIR__ . '/../../..' . '/lib/private/DB/SchemaWrapper.php',
         'OC\\DB\\Schema\\Column' => __DIR__ . '/../../..' . '/lib/private/DB/Schema/Column.php',
+        'OC\\DB\\Schema\\ForeignKeyConstraint' => __DIR__ . '/../../..' . '/lib/private/DB/Schema/ForeignKeyConstraint.php',
         'OC\\DB\\Schema\\Index' => __DIR__ . '/../../..' . '/lib/private/DB/Schema/Index.php',
         'OC\\DB\\Schema\\Table' => __DIR__ . '/../../..' . '/lib/private/DB/Schema/Table.php',
         'OC\\DB\\Schema\\Type' => __DIR__ . '/../../..' . '/lib/private/DB/Schema/Type.php',

lib/private/DB/Schema/Column.php

@@ -12,6 +12,7 @@
 use Doctrine\DBAL\Schema\Column as DBALColumn;
 use Doctrine\DBAL\Schema\SchemaException as DBALSchemaException;
 use Doctrine\DBAL\Types\Type as DBALType;
+use OCP\DB\Schema\ColumnType;
 use OCP\DB\Schema\IColumn;
 use OCP\DB\Schema\IType;
 use OCP\DB\Schema\SchemaException;
@@ -33,11 +34,15 @@ public function getWrappedColumn(): DBALColumn {
 	}
 
 	#[\Override]
-	public function setType(string|IType|DBALType $type): self {
+	public function setType(string|IType|DBALType|ColumnType $type): self {
 		if ($type instanceof IType) {
 			$type = $type->getName();
 		}
 
+		if ($type instanceof ColumnType) {
+			$type = $type->value;
+		}
+
 		$this->column->setType($type instanceof DBALType ? $type : DBALType::getType($type));
 
 		return $this;
@@ -97,6 +102,11 @@ public function getType(): IType {
 		return new Type($this->column->getType());
 	}
 
+	#[\Override]
+	public function getColumnType(): ColumnType {
+		return ColumnType::from(DBALType::lookupName($this->column->getType()));
+	}
+
 	#[\Override]
 	public function getLength(): ?int {
 		return $this->column->getLength();

lib/private/DB/Schema/ForeignKeyConstraint.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH
+ * SPDX-FileContributor: Carl Schwan
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OC\DB\Schema;
+
+use Doctrine\DBAL\Schema\ForeignKeyConstraint as DBALForeignKeyConstraint;
+use OCP\DB\Schema\IForeignKeyConstraint;
+use Override;
+
+class ForeignKeyConstraint implements IForeignKeyConstraint {
+
+	public function __construct(
+		private readonly DBALForeignKeyConstraint $keyConstraint,
+	) {
+	}
+
+	#[Override]
+	public function getName(): string {
+		/** @var non-empty-string $value */
+		$value = $this->keyConstraint->getName();
+		return $value;
+	}
+}

lib/private/DB/Schema/Index.php

@@ -53,6 +53,11 @@ public function isSimpleIndex(): bool {
 		return $this->index->isSimpleIndex();
 	}
 
+	#[\Override]
+	public function hasColumnAtPosition(string $name, int $position = 0): bool {
+		return $this->index->hasColumnAtPosition($name, $position);
+	}
+
 	/**
 	 * Forwards any method not declared on IIndex to the wrapped Doctrine
 	 * DBAL index, e.g. mutators like `addFlag()` or `removeFlag()` that are

lib/private/DB/Schema/Table.php

@@ -10,10 +10,14 @@
 namespace OC\DB\Schema;
 
 use Doctrine\DBAL\Schema\Column as DBALColumn;
+use Doctrine\DBAL\Schema\ForeignKeyConstraint as DBALForeignKeyConstraint;
 use Doctrine\DBAL\Schema\Index as DBALIndex;
 use Doctrine\DBAL\Schema\SchemaException as DBALSchemaException;
 use Doctrine\DBAL\Schema\Table as DBALTable;
+use Doctrine\DBAL\Types\Type as DBALType;
+use OCP\DB\Schema\ColumnType;
 use OCP\DB\Schema\IColumn;
+use OCP\DB\Schema\IForeignKeyConstraint;
 use OCP\DB\Schema\IIndex;
 use OCP\DB\Schema\ITable;
 use OCP\DB\Schema\SchemaException;
@@ -36,7 +40,9 @@ public function getWrappedTable(): DBALTable {
 
 	#[\Override]
 	public function getName(): string {
-		return $this->table->getName();
+		/** @var non-empty-lowercase-string $name */
+		$name = $this->table->getName();
+		return $name;
 	}
 
 	#[\Override]
@@ -134,8 +140,11 @@ public function renameIndex(string $oldName, ?string $newName = null): self {
 	}
 
 	#[\Override]
-	public function addColumn(string $name, string $typeName, array $options = []): IColumn {
+	public function addColumn(string $name, string|ColumnType $typeName, array $options = []): IColumn {
 		try {
+			if ($typeName instanceof ColumnType) {
+				$typeName = $typeName->value;
+			}
 			return new Column($this->table->addColumn($name, $typeName, $options));
 		} catch (DBALSchemaException $e) {
 			throw new SchemaException($e->getMessage(), $e->getCode(), $e);
@@ -145,6 +154,14 @@ public function addColumn(string $name, string $typeName, array $options = []):
 	#[\Override]
 	public function modifyColumn(string $name, array $options): self {
 		try {
+			if (isset($options['type'])) {
+				if ($options['type'] instanceof ColumnType) {
+					$options['type'] = $options['type']->value;
+				}
+				if (is_string($options['type'])) {
+					$options['type'] = DBALType::getType($options['type']);
+				}
+			}
 			$this->table->modifyColumn($name, $options);
 		} catch (DBALSchemaException $e) {
 			throw new SchemaException($e->getMessage(), $e->getCode(), $e);
@@ -210,8 +227,8 @@ public function __call(string $name, array $arguments): mixed {
 	}
 
 	#[\Override]
-	public function hasColumn(string $string): bool {
-		return $this->table->hasColumn($string);
+	public function hasColumn(string $name): bool {
+		return $this->table->hasColumn($name);
 	}
 
 	#[\Override]
@@ -238,4 +255,12 @@ public function getIndexes(): array {
 			$this->table->getIndexes(),
 		));
 	}
+
+	#[\Override]
+	public function getForeignKeys(): array {
+		return array_values(array_map(
+			static fn (DBALForeignKeyConstraint $keyConstraint): IForeignKeyConstraint => new ForeignKeyConstraint($keyConstraint),
+			$this->table->getForeignKeys(),
+		));
+	}
 }

lib/public/AppFramework/Db/Entity.php

@@ -8,6 +8,7 @@
 
 namespace OCP\AppFramework\Db;
 
+use OCP\DB\Schema\ColumnType;
 use OCP\DB\Types;
 use function lcfirst;
 use function substr;
@@ -23,8 +24,8 @@ abstract class Entity {
 	public $id;
 	/** @var array<string, true> $_updatedFields */
 	private array $_updatedFields = [];
-	/** @var array<string, Types::*> $_fieldTypes */
-	protected array $_fieldTypes = ['id' => 'integer'];
+	/** @var array<string, ColumnType> $_fieldTypes */
+	protected array $_fieldTypes = ['id' => ColumnType::Integer];
 
 	/**
 	 * Simple alternative constructor for building entities from a request
@@ -66,7 +67,7 @@ public static function fromRow(array $row): static {
 	 * @since 7.0.0
 	 */
 	public function getFieldTypes(): array {
-		return $this->_fieldTypes;
+		return array_map(fn (ColumnType $type) => $type->value, $this->_fieldTypes);
 	}
 
 	/**
@@ -98,7 +99,7 @@ protected function setter(string $name, array $args): void {
 		// if type definition exists, cast to correct type
 		if ($args[0] !== null && array_key_exists($name, $this->_fieldTypes)) {
 			$type = $this->_fieldTypes[$name];
-			if ($type === Types::BLOB) {
+			if ($type === ColumnType::Blob) {
 				// (B)LOB is treated as string when we read from the DB
 				if (is_resource($args[0])) {
 					$args[0] = stream_get_contents($args[0]);
@@ -107,32 +108,32 @@ protected function setter(string $name, array $args): void {
 			}
 
 			switch ($type) {
-				case Types::BIGINT:
-				case Types::SMALLINT:
+				case ColumnType::Bigint:
+				case ColumnType::Smallint:
 					settype($args[0], Types::INTEGER);
 					break;
-				case Types::BINARY:
-				case Types::DECIMAL:
-				case Types::TEXT:
+				case ColumnType::Binary:
+				case ColumnType::Decimal:
+				case ColumnType::Text:
 					settype($args[0], Types::STRING);
 					break;
-				case Types::TIME:
-				case Types::DATE:
-				case Types::DATETIME:
-				case Types::DATETIME_TZ:
+				case ColumnType::Time:
+				case ColumnType::Date:
+				case ColumnType::Datetime:
+				case ColumnType::DatetimeTz:
 					if (!$args[0] instanceof \DateTime) {
 						$args[0] = new \DateTime($args[0]);
 					}
 					break;
-				case Types::TIME_IMMUTABLE:
-				case Types::DATE_IMMUTABLE:
-				case Types::DATETIME_IMMUTABLE:
-				case Types::DATETIME_TZ_IMMUTABLE:
+				case ColumnType::TimeImmutable:
+				case ColumnType::DateImmutable:
+				case ColumnType::DatetimeImmutable:
+				case ColumnType::DatetimeTzImmutable:
 					if (!$args[0] instanceof \DateTimeImmutable) {
 						$args[0] = new \DateTimeImmutable($args[0]);
 					}
 					break;
-				case Types::JSON:
+				case ColumnType::Json:
 					if (!is_array($args[0])) {
 						$args[0] = json_decode($args[0], true);
 					}
@@ -187,7 +188,7 @@ public function __call(string $methodName, array $args) {
 	protected function isGetterForBoolProperty(string $methodName): bool {
 		if (str_starts_with($methodName, 'is')) {
 			$fieldName = lcfirst(substr($methodName, 2));
-			return isset($this->_fieldTypes[$fieldName]) && str_starts_with($this->_fieldTypes[$fieldName], 'bool');
+			return isset($this->_fieldTypes[$fieldName]) && str_starts_with($this->_fieldTypes[$fieldName]->value, 'bool');
 		}
 		return false;
 	}
@@ -258,23 +259,28 @@ public function getUpdatedFields(): array {
 	 * that value once its being returned from the database
 	 *
 	 * @param string $fieldName the name of the attribute
-	 * @param Types::* $type the type which will be used to match a cast
+	 * @param Types::*|ColumnType $type the type which will be used to match a cast
 	 * @since 31.0.0 Parameter $type is now restricted to {@see Types} constants. The formerly accidentally supported types 'int'|'bool'|'double' are mapped to Types::INTEGER|Types::BOOLEAN|Types::FLOAT accordingly.
+	 * @since 35.0.0 Parameter $type now prefers using one of the {@see ColumnType} enum values.
 	 * @since 7.0.0
 	 */
-	protected function addType(string $fieldName, string $type): void {
+	protected function addType(string $fieldName, string|ColumnType $type): void {
 		/** @psalm-suppress TypeDoesNotContainType */
 		if (in_array($type, ['bool', 'double', 'int', 'array', 'object'], true)) {
 			// Mapping legacy strings to the actual types
 			$type = match ($type) {
-				'int' => Types::INTEGER,
-				'bool' => Types::BOOLEAN,
-				'double' => Types::FLOAT,
+				'int' => ColumnType::Integer,
+				'bool' => ColumnType::Boolean,
+				'double' => ColumnType::Float,
 				'array',
-				'object' => Types::STRING,
+				'object' => ColumnType::String,
 			};
 		}
 
+		if (is_string($type)) {
+			$type = ColumnType::from($type);
+		}
+
 		$this->_fieldTypes[$fieldName] = $type;
 	}