Feat: Add technicalName to views

Signed-off-by: Kostiantyn Miakshyn <molodchick@gmail.com>

Author: Koc

appinfo/info.xml

@@ -26,7 +26,7 @@ Share your tables and views with users and groups within your cloud.
 Have a good time and manage whatever you want.
 
 ]]></description>
-	<version>2.2.0</version>
+	<version>2.2.1</version>
 	<licence>AGPL-3.0-or-later</licence>
 	<author>Nextcloud GmbH and Nextcloud contributors</author>
 	<namespace>Tables</namespace>

lib/Constants/ViewUpdatableParameters.php

@@ -16,4 +16,5 @@ enum ViewUpdatableParameters: string {
 	case SORT = 'sort';
 	case FILTER = 'filter';
 	case COLUMN_SETTINGS = 'columns';
+	case TECHNICAL_NAME = 'technicalName';
 }

lib/Controller/Api1Controller.php

@@ -348,10 +348,12 @@ public function indexViews(int $tableId): DataResponse {
 	 * @param int $tableId Table ID that will hold the view
 	 * @param string $title Title for the view
 	 * @param string|null $emoji Emoji for the view
+	 * @param string|null $technicalName Technical name for the view
 	 *
-	 * @return DataResponse<Http::STATUS_OK, TablesView, array{}>|DataResponse<Http::STATUS_FORBIDDEN|Http::STATUS_INTERNAL_SERVER_ERROR|Http::STATUS_NOT_FOUND, array{message: string}, array{}>
+	 * @return DataResponse<Http::STATUS_OK, TablesView, array{}>|DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_FORBIDDEN|Http::STATUS_INTERNAL_SERVER_ERROR|Http::STATUS_NOT_FOUND, array{message: string}, array{}>
 	 *
 	 * 200: View created
+	 * 400: Bad request
 	 * 403: No permissions
 	 * 404: Not found
 	 */
@@ -360,13 +362,17 @@ public function indexViews(int $tableId): DataResponse {
 	#[CORS]
 	#[RequirePermission(permission: Application::PERMISSION_MANAGE, type: Application::NODE_TYPE_TABLE, idParam: 'tableId')]
 	#[OpenAPI(scope: OpenAPI::SCOPE_DEFAULT)]
-	public function createView(int $tableId, string $title, ?string $emoji): DataResponse {
+	public function createView(int $tableId, string $title, ?string $emoji, ?string $technicalName = null): DataResponse {
 		try {
-			return new DataResponse($this->viewService->create($title, $emoji, $this->tableService->find($tableId))->jsonSerialize());
+			return new DataResponse($this->viewService->create($title, $emoji, $this->tableService->find($tableId), null, $technicalName)->jsonSerialize());
 		} catch (PermissionError $e) {
 			$this->logger->warning('A permission error occurred: ' . $e->getMessage(), ['exception' => $e]);
 			$message = ['message' => $e->getMessage()];
 			return new DataResponse($message, Http::STATUS_FORBIDDEN);
+		} catch (BadRequestError $e) {
+			$this->logger->warning('A bad request error occurred: ' . $e->getMessage(), ['exception' => $e]);
+			$message = ['message' => $e->getMessage()];
+			return new DataResponse($message, Http::STATUS_BAD_REQUEST);
 		} catch (InternalError|Exception $e) {
 			$this->logger->error('An internal error or exception occurred: ' . $e->getMessage(), ['exception' => $e]);
 			$message = ['message' => $e->getMessage()];
@@ -444,6 +450,10 @@ public function updateView(int $viewId, array $data): DataResponse {
 			$this->logger->warning('An invalid request occurred: ' . $e->getMessage(), ['exception' => $e]);
 			$message = ['message' => $e->getMessage()];
 			return new DataResponse($message, Http::STATUS_BAD_REQUEST);
+		} catch (BadRequestError $e) {
+			$this->logger->warning('A bad request error occurred: ' . $e->getMessage(), ['exception' => $e]);
+			$message = ['message' => $e->getMessage()];
+			return new DataResponse($message, Http::STATUS_BAD_REQUEST);
 		} catch (InternalError|Exception $e) {
 			$this->logger->error('An internal error or exception occurred: ' . $e->getMessage(), ['exception' => $e]);
 			$message = ['message' => $e->getMessage()];

lib/Db/View.php

@@ -25,6 +25,8 @@
  * @method setId(int $id)
  * @method getTitle(): string
  * @method setTitle(string $title)
+ * @method getTechnicalName(): string
+ * @method setTechnicalName(?string $technicalName)
  * @method getTableId(): int
  * @method setTableId(int $tableId)
  * @method getColumns(): string
@@ -64,6 +66,7 @@
  */
 class View extends EntitySuper implements JsonSerializable {
 	protected ?string $title = null;
+	protected ?string $technicalName = null;
 	protected ?int $tableId = null;
 	protected ?string $createdBy = null;
 	protected ?string $createdAt = null;
@@ -183,6 +186,7 @@ public function jsonSerialize(): array {
 			'id' => $this->id,
 			'tableId' => ($this->tableId || $this->tableId === 0) ? $this->tableId : -1,
 			'title' => $this->title ?: '',
+			'technicalName' => $this->technicalName,
 			'description' => $this->description,
 			'emoji' => $this->emoji,
 			'ownership' => $this->ownership ?: '',

lib/Migration/Version2011Date20260428000000.php

@@ -0,0 +1,84 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Tables\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\DB\QueryBuilder\IQueryBuilder;
+use OCP\DB\Types;
+use OCP\IDBConnection;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+use Override;
+
+class Version2011Date20260428000000 extends SimpleMigrationStep {
+	private IDBConnection $connection;
+
+	public function __construct(IDBConnection $connection) {
+		$this->connection = $connection;
+	}
+
+	#[Override]
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+
+		if (!$schema->hasTable('tables_views')) {
+			return null;
+		}
+
+		$table = $schema->getTable('tables_views');
+		if (!$table->hasColumn('technical_name')) {
+			$table->addColumn('technical_name', Types::STRING, [
+				'notnull' => false,
+				'length' => 200,
+			]);
+		}
+
+		if (!$table->hasIndex('tables_views_table_tech_name_uq')) {
+			$table->addUniqueIndex(['table_id', 'technical_name'], 'tables_views_table_tech_name_uq');
+		}
+
+		return $schema;
+	}
+
+	#[Override]
+	public function postSchemaChange(IOutput $output, Closure $schemaClosure, array $options): void {
+		$selectQb = $this->connection->getQueryBuilder();
+		$selectQb->select('id')
+			->from('tables_views')
+			->where(
+				$selectQb->expr()->orX(
+					$selectQb->expr()->isNull('technical_name'),
+					$selectQb->expr()->eq('technical_name', $selectQb->createNamedParameter('')),
+				)
+			);
+
+		$result = $selectQb->executeQuery();
+		$updatedCount = 0;
+
+		try {
+			while ($row = $result->fetchAssociative()) {
+				$viewId = (int)$row['id'];
+
+				$updateQb = $this->connection->getQueryBuilder();
+				$updateQb->update('tables_views')
+					->set('technical_name', $updateQb->createNamedParameter('view_' . $viewId, IQueryBuilder::PARAM_STR))
+					->where($updateQb->expr()->eq('id', $updateQb->createNamedParameter($viewId, IQueryBuilder::PARAM_INT)));
+
+				$updatedCount += $updateQb->executeStatement();
+			}
+		} finally {
+			$result->closeCursor();
+		}
+
+		$output->info('Version2011Date20260428000000: backfilled technical_name for ' . $updatedCount . ' views.');
+	}
+}

lib/Model/ViewUpdateInput.php

@@ -24,6 +24,7 @@ class ViewUpdateInput {
 
 	public function __construct(
 		protected readonly ?Title $title = null,
+		protected readonly ?string $technicalName = null,
 		protected readonly ?string $description = null,
 		protected readonly ?Emoji $emoji = null,
 		protected readonly ?ColumnSettings $columnSettings = null,
@@ -36,6 +37,9 @@ public function updateDetail(): Generator {
 		if ($this->title) {
 			yield ViewUpdatableParameters::TITLE => $this->title;
 		}
+		if ($this->technicalName !== null) {
+			yield ViewUpdatableParameters::TECHNICAL_NAME => $this->technicalName;
+		}
 		if ($this->description) {
 			yield ViewUpdatableParameters::DESCRIPTION => $this->description;
 		}
@@ -58,6 +62,7 @@ public function updateDetail(): Generator {
 	 *     title?: string,
 	 *     emoji?: string,
 	 *     description?: string,
+	 *     technicalName?: string,
 	 *     columns?: list<int>,
 	 *     columnSettings?: list<array{columnId?: int, order?: int, readonly?: bool, mandatory?: bool}>,
 	 *     sort?: list<array{columnId: int, mode: 'ASC'|'DESC'}>,
@@ -82,6 +87,7 @@ public static function fromInputArray(array $data): self {
 
 		return new self(
 			title: ($data['title'] ?? null) ? new Title($data['title']) : null,
+			technicalName: $data['technicalName'] ?? null,
 			description: $data['description'] ?? null,
 			emoji: ($data['emoji'] ?? null) ? new Emoji($data['emoji']) : null,
 			columnSettings: ($data['columnSettings'] ?? null) ? ColumnSettings::createViewSettingsFromInputArray($data['columnSettings']) : null,

lib/ResponseDefinitions.php

@@ -16,6 +16,7 @@
  * @psalm-type TablesView = array{
  * 	id: int,
  * 	title: string,
+ * 	technicalName: string|null,
  * 	emoji: string|null,
  *  tableId: int,
  * 	ownership: string,

lib/Service/ViewService.php

@@ -19,6 +19,7 @@
 use OCA\Tables\Db\Table;
 use OCA\Tables\Db\View;
 use OCA\Tables\Db\ViewMapper;
+use OCA\Tables\Errors\BadRequestError;
 use OCA\Tables\Errors\InternalError;
 use OCA\Tables\Errors\NotFoundError;
 use OCA\Tables\Errors\PermissionError;
@@ -189,11 +190,13 @@ public function findSharedViewsWithMe(?string $userId = null): array {
 	 * @param string|null $emoji
 	 * @param Table $table
 	 * @param string|null $userId
+	 * @param string|null $technicalName
 	 * @return View
 	 * @throws InternalError
 	 * @throws PermissionError
+	 * @throws BadRequestError
 	 */
-	public function create(string $title, ?string $emoji, Table $table, ?string $userId = null): View {
+	public function create(string $title, ?string $emoji, Table $table, ?string $userId = null, ?string $technicalName = null): View {
 		/** @var string $userId */
 		$userId = $this->permissionsService->preCheckUserId($userId, false); // $userId is set
 
@@ -214,6 +217,11 @@ public function create(string $title, ?string $emoji, Table $table, ?string $use
 		$item->setLastEditBy($userId);
 		$item->setCreatedAt($time->format('Y-m-d H:i:s'));
 		$item->setLastEditAt($time->format('Y-m-d H:i:s'));
+		if ($technicalName !== null) {
+			$this->assertTechnicalNameValid($technicalName);
+			$this->assertTechnicalNameUnique($table->getId(), $technicalName);
+			$item->setTechnicalName($technicalName);
+		}
 		// ownership is not stored with the record, but it might be necessary upon
 		// further interaction with the view in the running process, as the instance
 		// is cached now. The ownership is always inherited from the table.
@@ -224,6 +232,15 @@ public function create(string $title, ?string $emoji, Table $table, ?string $use
 			$this->logger->error($e->getMessage());
 			throw new InternalError($e->getMessage());
 		}
+		if ($newItem->getTechnicalName() === null || $newItem->getTechnicalName() === '') {
+			$newItem->setTechnicalName($this->buildDefaultTechnicalName($newItem->getId()));
+			try {
+				$newItem = $this->mapper->update($newItem);
+			} catch (\OCP\DB\Exception $e) {
+				$this->logger->error($e->getMessage());
+				throw new InternalError($e->getMessage(), previous: $e);
+			}
+		}
 
 		return $newItem;
 	}
@@ -251,6 +268,11 @@ public function update(int $id, ViewUpdateInput $data, ?string $userId = null, b
 					$this->assertInputColumnsAreValid($view, $userId, $value);
 				}
 
+				if ($parameter === ViewUpdatableParameters::TECHNICAL_NAME) {
+					$this->assertTechnicalNameValid($value);
+					$this->assertTechnicalNameUnique($view->getTableId(), $value, $view->getId());
+				}
+
 				if ($value instanceof JsonSerializable) {
 					$insertableValue = json_encode($value);
 				}
@@ -267,7 +289,7 @@ public function update(int $id, ViewUpdateInput $data, ?string $userId = null, b
 				$this->enhanceView($view, $userId);
 			}
 			return $view;
-		} catch (InvalidArgumentException $e) {
+		} catch (BadRequestError|InvalidArgumentException $e) {
 			throw $e;
 		} catch (Exception $e) {
 			$this->logger->error($e->getMessage(), ['exception' => $e]);
@@ -610,6 +632,7 @@ public function importView(int $tableId, array $view, string $userId): void {
 		$item->setTableId($tableId);
 		$item->setTitle($view['title']);
 		$item->setEmoji($view['emoji']);
+		$item->setTechnicalName($view['technicalName'] ?? null);
 		$item->setCreatedBy($userId);
 		$item->setCreatedAt($view['createdAt']);
 		$item->setLastEditBy($userId);
@@ -620,9 +643,51 @@ public function importView(int $tableId, array $view, string $userId): void {
 		$item->setFilter(json_encode($view['filter']));
 		try {
 			$this->mapper->insert($item);
+			if ($item->getTechnicalName() === null || $item->getTechnicalName() === '') {
+				$item->setTechnicalName($this->buildDefaultTechnicalName($item->getId()));
+				$this->mapper->update($item);
+			}
+		} catch (BadRequestError $e) {
+			throw $e;
 		} catch (\Exception $e) {
 			$this->logger->error('userMigrationImport insert error: ' . $e->getMessage());
 			throw new InternalError('userMigrationImport insert error: ' . $e->getMessage());
 		}
 	}
+
+	private function buildDefaultTechnicalName(int $viewId): string {
+		return 'view_' . $viewId;
+	}
+
+	/**
+	 * @throws BadRequestError
+	 */
+	private function assertTechnicalNameValid(string $technicalName): void {
+		if (!preg_match('/^[a-z][a-z0-9_]*$/', $technicalName)) {
+			throw new BadRequestError('Technical name must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.');
+		}
+	}
+
+	/**
+	 * @throws BadRequestError
+	 * @throws InternalError
+	 */
+	private function assertTechnicalNameUnique(int $tableId, string $technicalName, ?int $excludeCurrentViewId = null): void {
+		try {
+			$views = $this->mapper->findAll($tableId);
+		} catch (\OCP\DB\Exception $e) {
+			$this->logger->error($e->getMessage(), ['exception' => $e]);
+			throw new InternalError(get_class($this) . ' - ' . __FUNCTION__ . ': ' . $e->getMessage(), previous: $e);
+		}
+
+		foreach ($views as $view) {
+			if ($excludeCurrentViewId !== null && $view->getId() === $excludeCurrentViewId) {
+				continue;
+			}
+
+			if ($view->getTechnicalName() === $technicalName) {
+				throw new BadRequestError('Technical name must be unique in the table.');
+			}
+		}
+	}
 }