From cfc804ad21cb1457c4d77494d01dd4b533c7cd5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julius=20H=C3=A4rtl?= Date: Mon, 15 Jul 2024 20:19:46 +0200 Subject: [PATCH 1/7] fix: Add method to map board to file permissions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Julius Härtl --- lib/Service/PermissionService.php | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/lib/Service/PermissionService.php b/lib/Service/PermissionService.php index e8bf4116f4..53ea1725d4 100644 --- a/lib/Service/PermissionService.php +++ b/lib/Service/PermissionService.php @@ -19,6 +19,7 @@ use OCP\AppFramework\Db\DoesNotExistException; use OCP\AppFramework\Db\MultipleObjectsReturnedException; use OCP\Cache\CappedMemoryCache; +use OCP\Constants; use OCP\IConfig; use OCP\IGroupManager; use OCP\IUserManager; @@ -132,6 +133,20 @@ public function checkPermission(?IPermissionMapper $mapper, $id, int $permission throw new NoPermissionException('Permission denied'); } + public function boardToFilePermission(array $permissions): int { + $result = 0; + foreach ($permissions as $key => $value) { + $result |= $value ? match ($key) { + Acl::PERMISSION_READ => Constants::PERMISSION_READ, + Acl::PERMISSION_EDIT => Constants::PERMISSION_UPDATE | Constants::PERMISSION_DELETE | Constants::PERMISSION_CREATE | Constants::PERMISSION_DELETE, + Acl::PERMISSION_SHARE => Constants::PERMISSION_SHARE, + default => 0, + } : 0; + } + + return $result; + } + /** * @param $boardId * @return bool From c1dde0cb74a963bd279f5ec8e2b33347b5c606fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julius=20H=C3=A4rtl?= Date: Mon, 15 Jul 2024 20:21:16 +0200 Subject: [PATCH 2/7] perf(sharing): Optimize getSharedWith to fetch permissions right away MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Julius Härtl --- lib/Sharing/DeckShareProvider.php | 41 +++++++++++++++++++++++++------ 1 file changed, 33 insertions(+), 8 deletions(-) diff --git a/lib/Sharing/DeckShareProvider.php b/lib/Sharing/DeckShareProvider.php index 74bcecfdbc..8d4e4ee8dd 100644 --- a/lib/Sharing/DeckShareProvider.php +++ b/lib/Sharing/DeckShareProvider.php @@ -268,7 +268,13 @@ private function createShareObject(array $data): IShare { return $share; } - private function applyBoardPermission($share, $permissions, $userId) { + private function applyBoardPermission($share, $permissions, $userId, ?array $shareToPermissionMap = null): void { + $cardId = (int)$share->getSharedWith(); + if ($shareToPermissionMap !== null && isset($shareToPermissionMap[$cardId])) { + $share->setPermissions($permissions & $this->permissionService->boardToFilePermission($shareToPermissionMap[$cardId])); + return; + } + try { $this->permissionService->checkPermission($this->cardMapper, $share->getSharedWith(), Acl::PERMISSION_EDIT, $userId); } catch (NoPermissionException $e) { @@ -613,7 +619,7 @@ public function getShareById($id, $recipientId = null) { * @param string $userId * @return IShare[] */ - private function resolveSharesForRecipient(array $shares, string $userId): array { + private function resolveSharesForRecipient(array $shares, string $userId, ?array $cardPermissionMap = null): array { $result = []; $start = 0; @@ -650,7 +656,7 @@ private function resolveSharesForRecipient(array $shares, string $userId): array $stmt = $query->execute(); while ($data = $stmt->fetch()) { - $this->applyBoardPermission($shareMap[$data['parent']], (int)$data['permissions'], $userId); + $this->applyBoardPermission($shareMap[$data['parent']], (int)$data['permissions'], $userId, $cardPermissionMap); $shareMap[$data['parent']]->setTarget($data['file_target']); } @@ -699,14 +705,18 @@ public function getSharesByPath(Node $path): array { * @return IShare[] */ public function getSharedWith($userId, $shareType, $node, $limit, $offset): array { - $allBoards = $this->boardMapper->findBoardIds($userId); - + // We query all boards fully as we can reuse that to match permissions later on + $allBoards = $this->boardMapper->findAllForUser($userId); + $cardToBoardMapping = []; /** @var IShare[] $shares */ $shares = []; $start = 0; while (true) { $boards = array_slice($allBoards, $start, 1000); + $boardIds = array_map(function ($board) { + return $board->getId(); + }, $boards); $start += 1000; if ($boards === []) { @@ -720,13 +730,16 @@ public function getSharedWith($userId, $shareType, $node, $limit, $offset): arra 'f.encrypted', 'f.unencrypted_size', 'f.etag', 'f.checksum' ) ->selectAlias('st.id', 'storage_string_id') + ->selectAlias('db.id', 'board_id') ->from('share', 's') ->orderBy('s.id') ->leftJoin('s', 'filecache', 'f', $qb->expr()->eq('s.file_source', 'f.fileid')) ->leftJoin('f', 'storages', 'st', $qb->expr()->eq('f.storage', 'st.numeric_id')) ->leftJoin('s', 'deck_cards', 'dc', $qb->expr()->eq($qb->expr()->castColumn('dc.id', IQueryBuilder::PARAM_STR), 's.share_with')) ->leftJoin('dc', 'deck_stacks', 'ds', $qb->expr()->eq('dc.stack_id', 'ds.id')) - ->leftJoin('ds', 'deck_boards', 'db', $qb->expr()->eq('ds.board_id', 'db.id')); + ->leftJoin('ds', 'deck_boards', 'db', $qb->expr()->eq('ds.board_id', 'db.id')) + ->where($qb->expr()->eq('dc.deleted_at', $qb->createNamedParameter(0))) + ->andWhere($qb->expr()->eq('db.deleted_at', $qb->createNamedParameter(0))); if ($limit !== -1) { $qb->setMaxResults($limit); @@ -739,7 +752,7 @@ public function getSharedWith($userId, $shareType, $node, $limit, $offset): arra $qb->andWhere($qb->expr()->eq('s.share_type', $qb->createNamedParameter(IShare::TYPE_DECK))) ->andWhere($qb->expr()->in('db.id', $qb->createNamedParameter( - $boards, + $boardIds, IQueryBuilder::PARAM_STR_ARRAY ))) ->andWhere($qb->expr()->orX( @@ -758,11 +771,23 @@ public function getSharedWith($userId, $shareType, $node, $limit, $offset): arra continue; } $shares[] = $this->createShareObject($data); + $cardToBoardMapping[(int)$data['share_with']] = $data['board_id']; } $cursor->closeCursor(); } - $shares = $this->resolveSharesForRecipient($shares, $userId); + $boardPermissions = []; + foreach ($allBoards as $board) { + $permissions = $this->permissionService->matchPermissions($board); + $boardPermissions[$board->getId()] = $permissions; + } + + $cardPermissionMap = []; + foreach ($cardToBoardMapping as $cardId => $boardId) { + $cardPermissionMap[$cardId] = $boardPermissions[$boardId] ?? false; + } + + $shares = $this->resolveSharesForRecipient($shares, $userId, $cardPermissionMap); return $shares; } From cb469fb78cc5ded413c12d29c24554462c83f175 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julius=20H=C3=A4rtl?= Date: Mon, 15 Jul 2024 20:21:53 +0200 Subject: [PATCH 3/7] fix: Chunk query for getting labels for cards MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Julius Härtl --- lib/Db/LabelMapper.php | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/lib/Db/LabelMapper.php b/lib/Db/LabelMapper.php index f0b32413ce..fabd9bab6a 100644 --- a/lib/Db/LabelMapper.php +++ b/lib/Db/LabelMapper.php @@ -44,36 +44,40 @@ public function delete(Entity $entity): Entity { } /** - * @param numeric $cardId - * @param int|null $limit - * @param int|null $offset * @return Label[] * @throws \OCP\DB\Exception */ - public function findAssignedLabelsForCard($cardId, $limit = null, $offset = null): array { + public function findAssignedLabelsForCard(int $cardId): array { $qb = $this->db->getQueryBuilder(); $qb->select('l.*', 'card_id') ->from($this->getTableName(), 'l') ->innerJoin('l', 'deck_assigned_labels', 'al', 'l.id = al.label_id') ->where($qb->expr()->eq('card_id', $qb->createNamedParameter($cardId, IQueryBuilder::PARAM_INT))) - ->orderBy('l.id') - ->setMaxResults($limit) - ->setFirstResult($offset); + ->orderBy('l.id'); return $this->findEntities($qb); } - public function findAssignedLabelsForCards($cardIds, $limit = null, $offset = null): array { + public function findAssignedLabelsForCards(array $cardIds, ?int $limit = null, ?int $offset = null): array { $qb = $this->db->getQueryBuilder(); $qb->select('l.*', 'card_id') ->from($this->getTableName(), 'l') ->innerJoin('l', 'deck_assigned_labels', 'al', 'l.id = al.label_id') - ->where($qb->expr()->in('card_id', $qb->createNamedParameter($cardIds, IQueryBuilder::PARAM_INT_ARRAY))) + ->where($qb->expr()->in('card_id', $qb->createParameter('ids'))) ->orderBy('l.id') ->setMaxResults($limit) ->setFirstResult($offset); - return $this->findEntities($qb); + $results = []; + foreach (array_chunk($cardIds, 1000) as $chunk) { + $qb->setParameter('ids', $chunk, IQueryBuilder::PARAM_STR_ARRAY); + + foreach ($this->findEntities($qb) as $result) { + $results[] = $result; + } + } + + return $results; } /** From a1bd24dbf7c48541e4ef4817b9c38b5408bf79d8 Mon Sep 17 00:00:00 2001 From: Julius Knorr Date: Thu, 19 Dec 2024 18:04:23 +0100 Subject: [PATCH 4/7] ci: Print query log Signed-off-by: Julius Knorr --- .github/workflows/integration.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml index ae87ccd907..41200ba2cd 100644 --- a/.github/workflows/integration.yml +++ b/.github/workflows/integration.yml @@ -112,6 +112,11 @@ jobs: working-directory: apps/${{ env.APP_NAME }}/tests/integration run: ./run.sh + - name: Print query log + run: | + cat query.log | wc -l + cat query.log + - name: Query count if: ${{ matrix.databases == 'mysql' }} uses: actions/github-script@v7 From 93cdedb6b0043ac815364d6fd9fae9a76e8cdcb6 Mon Sep 17 00:00:00 2001 From: Julius Knorr Date: Thu, 19 Dec 2024 18:04:42 +0100 Subject: [PATCH 5/7] Revert "fix: Chunk query for getting labels for cards" This reverts commit cb469fb78cc5ded413c12d29c24554462c83f175. --- lib/Db/LabelMapper.php | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/lib/Db/LabelMapper.php b/lib/Db/LabelMapper.php index fabd9bab6a..f0b32413ce 100644 --- a/lib/Db/LabelMapper.php +++ b/lib/Db/LabelMapper.php @@ -44,40 +44,36 @@ public function delete(Entity $entity): Entity { } /** + * @param numeric $cardId + * @param int|null $limit + * @param int|null $offset * @return Label[] * @throws \OCP\DB\Exception */ - public function findAssignedLabelsForCard(int $cardId): array { + public function findAssignedLabelsForCard($cardId, $limit = null, $offset = null): array { $qb = $this->db->getQueryBuilder(); $qb->select('l.*', 'card_id') ->from($this->getTableName(), 'l') ->innerJoin('l', 'deck_assigned_labels', 'al', 'l.id = al.label_id') ->where($qb->expr()->eq('card_id', $qb->createNamedParameter($cardId, IQueryBuilder::PARAM_INT))) - ->orderBy('l.id'); + ->orderBy('l.id') + ->setMaxResults($limit) + ->setFirstResult($offset); return $this->findEntities($qb); } - public function findAssignedLabelsForCards(array $cardIds, ?int $limit = null, ?int $offset = null): array { + public function findAssignedLabelsForCards($cardIds, $limit = null, $offset = null): array { $qb = $this->db->getQueryBuilder(); $qb->select('l.*', 'card_id') ->from($this->getTableName(), 'l') ->innerJoin('l', 'deck_assigned_labels', 'al', 'l.id = al.label_id') - ->where($qb->expr()->in('card_id', $qb->createParameter('ids'))) + ->where($qb->expr()->in('card_id', $qb->createNamedParameter($cardIds, IQueryBuilder::PARAM_INT_ARRAY))) ->orderBy('l.id') ->setMaxResults($limit) ->setFirstResult($offset); - $results = []; - foreach (array_chunk($cardIds, 1000) as $chunk) { - $qb->setParameter('ids', $chunk, IQueryBuilder::PARAM_STR_ARRAY); - - foreach ($this->findEntities($qb) as $result) { - $results[] = $result; - } - } - - return $results; + return $this->findEntities($qb); } /** From dec47f6f0a873382abbf007ab709a01928bbb50f Mon Sep 17 00:00:00 2001 From: Julius Knorr Date: Thu, 19 Dec 2024 18:04:45 +0100 Subject: [PATCH 6/7] Revert "perf(sharing): Optimize getSharedWith to fetch permissions right away" This reverts commit c1dde0cb74a963bd279f5ec8e2b33347b5c606fd. --- lib/Sharing/DeckShareProvider.php | 41 ++++++------------------------- 1 file changed, 8 insertions(+), 33 deletions(-) diff --git a/lib/Sharing/DeckShareProvider.php b/lib/Sharing/DeckShareProvider.php index 8d4e4ee8dd..74bcecfdbc 100644 --- a/lib/Sharing/DeckShareProvider.php +++ b/lib/Sharing/DeckShareProvider.php @@ -268,13 +268,7 @@ private function createShareObject(array $data): IShare { return $share; } - private function applyBoardPermission($share, $permissions, $userId, ?array $shareToPermissionMap = null): void { - $cardId = (int)$share->getSharedWith(); - if ($shareToPermissionMap !== null && isset($shareToPermissionMap[$cardId])) { - $share->setPermissions($permissions & $this->permissionService->boardToFilePermission($shareToPermissionMap[$cardId])); - return; - } - + private function applyBoardPermission($share, $permissions, $userId) { try { $this->permissionService->checkPermission($this->cardMapper, $share->getSharedWith(), Acl::PERMISSION_EDIT, $userId); } catch (NoPermissionException $e) { @@ -619,7 +613,7 @@ public function getShareById($id, $recipientId = null) { * @param string $userId * @return IShare[] */ - private function resolveSharesForRecipient(array $shares, string $userId, ?array $cardPermissionMap = null): array { + private function resolveSharesForRecipient(array $shares, string $userId): array { $result = []; $start = 0; @@ -656,7 +650,7 @@ private function resolveSharesForRecipient(array $shares, string $userId, ?array $stmt = $query->execute(); while ($data = $stmt->fetch()) { - $this->applyBoardPermission($shareMap[$data['parent']], (int)$data['permissions'], $userId, $cardPermissionMap); + $this->applyBoardPermission($shareMap[$data['parent']], (int)$data['permissions'], $userId); $shareMap[$data['parent']]->setTarget($data['file_target']); } @@ -705,18 +699,14 @@ public function getSharesByPath(Node $path): array { * @return IShare[] */ public function getSharedWith($userId, $shareType, $node, $limit, $offset): array { - // We query all boards fully as we can reuse that to match permissions later on - $allBoards = $this->boardMapper->findAllForUser($userId); - $cardToBoardMapping = []; + $allBoards = $this->boardMapper->findBoardIds($userId); + /** @var IShare[] $shares */ $shares = []; $start = 0; while (true) { $boards = array_slice($allBoards, $start, 1000); - $boardIds = array_map(function ($board) { - return $board->getId(); - }, $boards); $start += 1000; if ($boards === []) { @@ -730,16 +720,13 @@ public function getSharedWith($userId, $shareType, $node, $limit, $offset): arra 'f.encrypted', 'f.unencrypted_size', 'f.etag', 'f.checksum' ) ->selectAlias('st.id', 'storage_string_id') - ->selectAlias('db.id', 'board_id') ->from('share', 's') ->orderBy('s.id') ->leftJoin('s', 'filecache', 'f', $qb->expr()->eq('s.file_source', 'f.fileid')) ->leftJoin('f', 'storages', 'st', $qb->expr()->eq('f.storage', 'st.numeric_id')) ->leftJoin('s', 'deck_cards', 'dc', $qb->expr()->eq($qb->expr()->castColumn('dc.id', IQueryBuilder::PARAM_STR), 's.share_with')) ->leftJoin('dc', 'deck_stacks', 'ds', $qb->expr()->eq('dc.stack_id', 'ds.id')) - ->leftJoin('ds', 'deck_boards', 'db', $qb->expr()->eq('ds.board_id', 'db.id')) - ->where($qb->expr()->eq('dc.deleted_at', $qb->createNamedParameter(0))) - ->andWhere($qb->expr()->eq('db.deleted_at', $qb->createNamedParameter(0))); + ->leftJoin('ds', 'deck_boards', 'db', $qb->expr()->eq('ds.board_id', 'db.id')); if ($limit !== -1) { $qb->setMaxResults($limit); @@ -752,7 +739,7 @@ public function getSharedWith($userId, $shareType, $node, $limit, $offset): arra $qb->andWhere($qb->expr()->eq('s.share_type', $qb->createNamedParameter(IShare::TYPE_DECK))) ->andWhere($qb->expr()->in('db.id', $qb->createNamedParameter( - $boardIds, + $boards, IQueryBuilder::PARAM_STR_ARRAY ))) ->andWhere($qb->expr()->orX( @@ -771,23 +758,11 @@ public function getSharedWith($userId, $shareType, $node, $limit, $offset): arra continue; } $shares[] = $this->createShareObject($data); - $cardToBoardMapping[(int)$data['share_with']] = $data['board_id']; } $cursor->closeCursor(); } - $boardPermissions = []; - foreach ($allBoards as $board) { - $permissions = $this->permissionService->matchPermissions($board); - $boardPermissions[$board->getId()] = $permissions; - } - - $cardPermissionMap = []; - foreach ($cardToBoardMapping as $cardId => $boardId) { - $cardPermissionMap[$cardId] = $boardPermissions[$boardId] ?? false; - } - - $shares = $this->resolveSharesForRecipient($shares, $userId, $cardPermissionMap); + $shares = $this->resolveSharesForRecipient($shares, $userId); return $shares; } From b3e358868f8f7cbcd89b9f4180f69c7151e0e5d8 Mon Sep 17 00:00:00 2001 From: Julius Knorr Date: Thu, 19 Dec 2024 18:04:46 +0100 Subject: [PATCH 7/7] Revert "fix: Add method to map board to file permissions" This reverts commit cfc804ad21cb1457c4d77494d01dd4b533c7cd5c. --- lib/Service/PermissionService.php | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/lib/Service/PermissionService.php b/lib/Service/PermissionService.php index 53ea1725d4..e8bf4116f4 100644 --- a/lib/Service/PermissionService.php +++ b/lib/Service/PermissionService.php @@ -19,7 +19,6 @@ use OCP\AppFramework\Db\DoesNotExistException; use OCP\AppFramework\Db\MultipleObjectsReturnedException; use OCP\Cache\CappedMemoryCache; -use OCP\Constants; use OCP\IConfig; use OCP\IGroupManager; use OCP\IUserManager; @@ -133,20 +132,6 @@ public function checkPermission(?IPermissionMapper $mapper, $id, int $permission throw new NoPermissionException('Permission denied'); } - public function boardToFilePermission(array $permissions): int { - $result = 0; - foreach ($permissions as $key => $value) { - $result |= $value ? match ($key) { - Acl::PERMISSION_READ => Constants::PERMISSION_READ, - Acl::PERMISSION_EDIT => Constants::PERMISSION_UPDATE | Constants::PERMISSION_DELETE | Constants::PERMISSION_CREATE | Constants::PERMISSION_DELETE, - Acl::PERMISSION_SHARE => Constants::PERMISSION_SHARE, - default => 0, - } : 0; - } - - return $result; - } - /** * @param $boardId * @return bool