Skip to content

Commit 3240639

Browse files
KocKoc
committed
feat: add relation column type
Signed-off-by: Kostiantyn Miakshyn <molodchick@gmail.com>
1 parent ea9e6e5 commit 3240639

32 files changed

+1209
-24
lines changed

‎appinfo/routes.php‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@
5151
['name' => 'api1#updateColumn', 'url' => '/api/1/columns/{columnId}', 'verb' => 'PUT'],
5252
['name' => 'api1#getColumn', 'url' => '/api/1/columns/{columnId}', 'verb' => 'GET'],
5353
['name' => 'api1#deleteColumn', 'url' => '/api/1/columns/{columnId}', 'verb' => 'DELETE'],
54+
// -> relations
55+
['name' => 'api1#indexTableRelations', 'url' => '/api/1/tables/{tableId}/relations', 'verb' => 'GET'],
56+
['name' => 'api1#indexViewRelations', 'url' => '/api/1/views/{viewId}/relations', 'verb' => 'GET'],
5457
// -> rows
5558
['name' => 'api1#indexTableRowsSimple', 'url' => '/api/1/tables/{tableId}/rows/simple', 'verb' => 'GET'],
5659
['name' => 'api1#indexTableRows', 'url' => '/api/1/tables/{tableId}/rows', 'verb' => 'GET'],

‎lib/Constants/ColumnType.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,5 @@ enum ColumnType: string {
1515
case SELECTION = 'selection';
1616
case DATETIME = 'datetime';
1717
case PEOPLE = 'usergroup';
18+
case RELATION = 'relation';
1819
}

‎lib/Controller/Api1Controller.php‎

Lines changed: 70 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
use OCA\Tables\ResponseDefinitions;
2626
use OCA\Tables\Service\ColumnService;
2727
use OCA\Tables\Service\ImportService;
28+
use OCA\Tables\Service\RelationService;
2829
use OCA\Tables\Service\RowService;
2930
use OCA\Tables\Service\ShareService;
3031
use OCA\Tables\Service\TableService;
@@ -60,6 +61,7 @@ class Api1Controller extends ApiController {
6061
private RowService $rowService;
6162
private ImportService $importService;
6263
private ViewService $viewService;
64+
private RelationService $relationService;
6365
private ViewMapper $viewMapper;
6466
private IL10N $l10N;
6567

@@ -80,6 +82,7 @@ public function __construct(
8082
RowService $rowService,
8183
ImportService $importService,
8284
ViewService $viewService,
85+
RelationService $relationService,
8386
ViewMapper $viewMapper,
8487
V1Api $v1Api,
8588
LoggerInterface $logger,
@@ -93,6 +96,7 @@ public function __construct(
9396
$this->rowService = $rowService;
9497
$this->importService = $importService;
9598
$this->viewService = $viewService;
99+
$this->relationService = $relationService;
96100
$this->viewMapper = $viewMapper;
97101
$this->userId = $userId;
98102
$this->v1Api = $v1Api;
@@ -816,13 +820,77 @@ public function indexViewColumns(int $viewId): DataResponse {
816820
}
817821
}
818822

823+
/**
824+
* Get all relation data for a table
825+
*
826+
* @param int $tableId Table ID
827+
* @return DataResponse<Http::STATUS_OK, array<string, array<string, array{id: int, label: string}>>, array{}>|DataResponse<Http::STATUS_FORBIDDEN|Http::STATUS_INTERNAL_SERVER_ERROR|Http::STATUS_NOT_FOUND, array{message: string}, array{}>
828+
*
829+
* 200: Relation data returned
830+
* 403: No permissions
831+
* 404: Not found
832+
*/
833+
#[NoAdminRequired]
834+
#[NoCSRFRequired]
835+
#[CORS]
836+
#[RequirePermission(permission: Application::PERMISSION_READ, type: Application::NODE_TYPE_TABLE, idParam: 'tableId')]
837+
public function indexTableRelations(int $tableId): DataResponse {
838+
try {
839+
return new DataResponse($this->relationService->getRelationsForTable($tableId));
840+
} catch (PermissionError $e) {
841+
$this->logger->warning('A permission error occurred: ' . $e->getMessage(), ['exception' => $e]);
842+
$message = ['message' => $e->getMessage()];
843+
return new DataResponse($message, Http::STATUS_FORBIDDEN);
844+
} catch (InternalError $e) {
845+
$this->logger->error('An internal error or exception occurred: ' . $e->getMessage(), ['exception' => $e]);
846+
$message = ['message' => $e->getMessage()];
847+
return new DataResponse($message, Http::STATUS_INTERNAL_SERVER_ERROR);
848+
} catch (NotFoundError $e) {
849+
$this->logger->info('A not found error occurred: ' . $e->getMessage(), ['exception' => $e]);
850+
$message = ['message' => $e->getMessage()];
851+
return new DataResponse($message, Http::STATUS_NOT_FOUND);
852+
}
853+
}
854+
855+
/**
856+
* Get all relation data for a view
857+
*
858+
* @param int $viewId View ID
859+
* @return DataResponse<Http::STATUS_OK, array<string, array<string, array{id: int, label: string}>>, array{}>|DataResponse<Http::STATUS_FORBIDDEN|Http::STATUS_INTERNAL_SERVER_ERROR|Http::STATUS_NOT_FOUND, array{message: string}, array{}>
860+
*
861+
* 200: Relation data returned
862+
* 403: No permissions
863+
* 404: Not found
864+
*/
865+
#[NoAdminRequired]
866+
#[NoCSRFRequired]
867+
#[CORS]
868+
#[RequirePermission(permission: Application::PERMISSION_READ, type: Application::NODE_TYPE_VIEW, idParam: 'viewId')]
869+
public function indexViewRelations(int $viewId): DataResponse {
870+
try {
871+
return new DataResponse($this->relationService->getRelationsForView($viewId));
872+
} catch (PermissionError $e) {
873+
$this->logger->warning('A permission error occurred: ' . $e->getMessage(), ['exception' => $e]);
874+
$message = ['message' => $e->getMessage()];
875+
return new DataResponse($message, Http::STATUS_FORBIDDEN);
876+
} catch (InternalError $e) {
877+
$this->logger->error('An internal error or exception occurred: ' . $e->getMessage(), ['exception' => $e]);
878+
$message = ['message' => $e->getMessage()];
879+
return new DataResponse($message, Http::STATUS_INTERNAL_SERVER_ERROR);
880+
} catch (NotFoundError $e) {
881+
$this->logger->info('A not found error occurred: ' . $e->getMessage(), ['exception' => $e]);
882+
$message = ['message' => $e->getMessage()];
883+
return new DataResponse($message, Http::STATUS_NOT_FOUND);
884+
}
885+
}
886+
819887
/**
820888
* Create a column
821889
*
822890
* @param int|null $tableId Table ID
823891
* @param int|null $viewId View ID
824892
* @param string $title Title
825-
* @param 'text'|'number'|'datetime'|'select'|'usergroup' $type Column main type
893+
* @param 'text'|'number'|'datetime'|'select'|'usergroup'|'relation' $type Column main type
826894
* @param string|null $subtype Column sub type
827895
* @param bool $mandatory Is the column mandatory
828896
* @param string|null $description Description
@@ -1600,7 +1668,7 @@ public function createTableShare(int $tableId, string $receiver, string $receive
16001668
*
16011669
* @param int $tableId Table ID
16021670
* @param string $title Title
1603-
* @param 'text'|'number'|'datetime'|'select'|'usergroup' $type Column main type
1671+
* @param 'text'|'number'|'datetime'|'select'|'usergroup'|'relation' $type Column main type
16041672
* @param string|null $subtype Column sub type
16051673
* @param bool $mandatory Is the column mandatory
16061674
* @param string|null $description Description

‎lib/Db/Column.php‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ class Column extends EntitySuper implements JsonSerializable {
103103
public const TYPE_NUMBER = 'number';
104104
public const TYPE_DATETIME = 'datetime';
105105
public const TYPE_USERGROUP = 'usergroup';
106+
public const TYPE_RELATION = 'relation';
106107

107108
public const SUBTYPE_DATETIME_DATE = 'date';
108109
public const SUBTYPE_DATETIME_TIME = 'time';
@@ -114,6 +115,10 @@ class Column extends EntitySuper implements JsonSerializable {
114115

115116
public const META_ID_TITLE = 'id';
116117

118+
public const RELATION_TYPE = 'relationType';
119+
public const RELATION_TARGET_ID = 'targetId';
120+
public const RELATION_LABEL_COLUMN = 'labelColumn';
121+
117122
protected ?string $title = null;
118123
protected ?int $tableId = null;
119124
protected ?string $createdBy = null;

‎lib/Db/RowCellRelation.php‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
/**
6+
* SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
7+
* SPDX-License-Identifier: AGPL-3.0-or-later
8+
*/
9+
namespace OCA\Tables\Db;
10+
11+
/** @template-extends RowCellSuper<RowCellRelation> */
12+
class RowCellRelation extends RowCellSuper {
13+
protected ?int $value = null;
14+
15+
public function __construct() {
16+
parent::__construct();
17+
$this->addType('value', 'integer');
18+
}
19+
20+
public function jsonSerialize(): array {
21+
return parent::jsonSerializePreparation($this->value);
22+
}
23+
}

‎lib/Db/RowCellRelationMapper.php‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
/**
6+
* SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
7+
* SPDX-License-Identifier: AGPL-3.0-or-later
8+
*/
9+
namespace OCA\Tables\Db;
10+
11+
use OCP\DB\QueryBuilder\IQueryBuilder;
12+
use OCP\IDBConnection;
13+
14+
/** @template-extends RowCellMapperSuper<RowCellRelation, int|null, int|null> */
15+
class RowCellRelationMapper extends RowCellMapperSuper {
16+
protected string $table = 'tables_row_cells_relation';
17+
18+
public function __construct(IDBConnection $db) {
19+
parent::__construct($db, $this->table, RowCellRelation::class);
20+
}
21+
22+
/**
23+
* @inheritDoc
24+
*/
25+
public function hasMultipleValues(): bool {
26+
return false;
27+
}
28+
29+
/**
30+
* @inheritDoc
31+
*/
32+
public function getDbParamType() {
33+
return IQueryBuilder::PARAM_INT;
34+
}
35+
}

‎lib/Helper/ColumnsHelper.php‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ class ColumnsHelper {
2020
Column::TYPE_DATETIME,
2121
Column::TYPE_SELECTION,
2222
Column::TYPE_USERGROUP,
23+
Column::TYPE_RELATION,
2324
];
2425

2526
/**
@@ -37,6 +38,9 @@ public function resolveSearchValue(string $placeholder, string $userId, ?Column
3738
if (str_starts_with($placeholder, '@selection-id-')) {
3839
return substr($placeholder, 14);
3940
}
41+
if (str_starts_with($placeholder, '@relation-id-')) {
42+
return substr($placeholder, 13);
43+
}
4044

4145
$placeholderParts = explode(':', $placeholder, 2);
4246
$placeholderName = ltrim($placeholderParts[0], '@');

‎lib/Migration/Version002001Date20260109000000.php‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
/**
6+
* SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
7+
* SPDX-License-Identifier: AGPL-3.0-or-later
8+
*/
9+
namespace OCA\Tables\Migration;
10+
11+
use Closure;
12+
use OCP\DB\ISchemaWrapper;
13+
use OCP\DB\Types;
14+
use OCP\Migration\IOutput;
15+
use OCP\Migration\SimpleMigrationStep;
16+
17+
class Version002001Date20260109000000 extends SimpleMigrationStep {
18+
public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
19+
/** @var ISchemaWrapper $schema */
20+
$schema = $schemaClosure();
21+
22+
$changes = $this->createRowValueTable($schema, 'relation', Types::INTEGER);
23+
return $changes;
24+
}
25+
26+
private function createRowValueTable(ISchemaWrapper $schema, string $name, string $type): ?ISchemaWrapper {
27+
if (!$schema->hasTable('tables_row_cells_' . $name)) {
28+
$table = $schema->createTable('tables_row_cells_' . $name);
29+
$table->addColumn('id', Types::INTEGER, [
30+
'autoincrement' => true,
31+
'notnull' => true,
32+
]);
33+
$table->addColumn('column_id', Types::INTEGER, ['notnull' => true]);
34+
$table->addColumn('row_id', Types::INTEGER, ['notnull' => true]);
35+
$table->addColumn('value', $type, ['notnull' => false]);
36+
$table->addColumn('last_edit_at', Types::DATETIME, ['notnull' => true]);
37+
$table->addColumn('last_edit_by', Types::STRING, ['notnull' => true, 'length' => 64]);
38+
$table->addIndex(['column_id', 'row_id']);
39+
$table->addIndex(['column_id', 'value']);
40+
$table->setPrimaryKey(['id']);
41+
return $schema;
42+
}
43+
44+
return null;
45+
}
46+
}

‎lib/Service/ColumnTypes/RelationBusiness.php‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
<?php
2+
3+
/**
4+
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
5+
* SPDX-License-Identifier: AGPL-3.0-or-later
6+
*/
7+
8+
namespace OCA\Tables\Service\ColumnTypes;
9+
10+
use OCA\Tables\Db\Column;
11+
use OCA\Tables\Errors\BadRequestError;
12+
use OCA\Tables\Service\RelationService;
13+
use Psr\Log\LoggerInterface;
14+
15+
class RelationBusiness extends SuperBusiness implements IColumnTypeBusiness {
16+
17+
public function __construct(
18+
LoggerInterface $logger,
19+
private RelationService $relationService,
20+
) {
21+
parent::__construct($logger);
22+
}
23+
24+
/**
25+
* @param mixed $value (array|string|null)
26+
* @param Column|null $column
27+
* @return string
28+
*/
29+
public function parseValue($value, ?Column $column = null): string {
30+
if (!$column) {
31+
$this->logger->warning('No column given, but expected on ' . __FUNCTION__ . ' within ' . __CLASS__, ['exception' => new \Exception()]);
32+
return '';
33+
}
34+
35+
$relationData = $this->relationService->getRelationData($column);
36+
// try to find value by label
37+
$matchingRelation = array_filter($relationData, fn (array $relation) => $relation['label'] === $value);
38+
if (!empty($matchingRelation)) {
39+
return json_encode(reset($matchingRelation)['id']);
40+
}
41+
42+
// if not found, try to find by id
43+
if (is_numeric($value) && isset($relationData[(int)$value])) {
44+
return json_encode($value);
45+
}
46+
47+
return '';
48+
}
49+
50+
/**
51+
* @param mixed $value (array|string|null)
52+
* @param Column|null $column
53+
* @return bool
54+
*/
55+
public function canBeParsed($value, ?Column $column = null): bool {
56+
if (!$column) {
57+
$this->logger->warning('No column given, but expected on ' . __FUNCTION__ . ' within ' . __CLASS__, ['exception' => new \Exception()]);
58+
return false;
59+
}
60+
if ($value === null) {
61+
return true;
62+
}
63+
64+
$relationData = $this->relationService->getRelationData($column);
65+
// try to find value by label
66+
$matchingRelation = array_filter($relationData, fn (array $relation) => $relation['label'] === $value);
67+
if (!empty($matchingRelation)) {
68+
return true;
69+
}
70+
// if not found, try to find by id
71+
if (is_numeric($value) && isset($relationData[(int)$value])) {
72+
return true;
73+
}
74+
75+
return false;
76+
}
77+
78+
public function validateValue(mixed $value, Column $column, string $userId, int $tableId, ?int $rowId): void {
79+
if ($value === null || $value === '') {
80+
return;
81+
}
82+
// Validate that the value exists in the target table/view
83+
$relationData = $this->relationService->getRelationData($column);
84+
85+
// Try to find value by label first
86+
$matchingRelation = array_filter($relationData, fn (array $relation) => $relation['label'] === $value);
87+
if (!empty($matchingRelation)) {
88+
return;
89+
}
90+
91+
// If not found by label, try to find by id
92+
if (is_numeric($value) && isset($relationData[(int)$value])) {
93+
return;
94+
}
95+
96+
throw new BadRequestError('Relation value does not exist in the target table/view');
97+
}
98+
}

‎lib/Service/ImportService.php‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,10 @@ private function getPreviewData(Worksheet $worksheet): array {
187187
$value = $cell->getValue();
188188
// $cellIterator`s index is based on 1, not 0.
189189
$colIndex = $cellIterator->getCurrentColumnIndex() - 1;
190+
if (!array_key_exists($colIndex, $this->columns)) {
191+
continue;
192+
}
193+
190194
$column = $this->columns[$colIndex];
191195

192196
if (!array_key_exists($colIndex, $columns)) {
@@ -444,7 +448,7 @@ private function upsertRow(Row $row, array $columnBusinesses): void {
444448
if (!$cell || $cell->getValue() === null) {
445449
$this->logger->info('Cell is empty while fetching rows data for importing.');
446450
if ($column->getMandatory()) {
447-
$this->logger->warning('Mandatory column was not set');
451+
$this->logger->warning('Mandatory column "' . $column->getTitle() . '" was not set');
448452
$this->countErrors++;
449453
return;
450454
}

0 commit comments

Comments
 (0)