|
| 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 | + |
| 10 | +namespace OCA\Deck\ShareReview; |
| 11 | + |
| 12 | +use OCA\Deck\Db\Acl; |
| 13 | +use OCA\Deck\Db\AclMapper; |
| 14 | +use OCA\Deck\Service\BoardService; |
| 15 | +use OCP\AppFramework\Db\DoesNotExistException; |
| 16 | +use OCP\DB\Exception; |
| 17 | +use OCP\EventDispatcher\IEventDispatcher; |
| 18 | +use OCP\IL10N; |
| 19 | +use OCP\Share\IShare; |
| 20 | +use OCP\Share\ShareReview\Events\ShareReviewAccessCheckEvent; |
| 21 | +use OCP\Share\ShareReview\IShareReviewSource; |
| 22 | +use OCP\Share\ShareReview\ShareReviewEntry; |
| 23 | +use OCP\Share\ShareReview\ShareReviewPermission; |
| 24 | +use Psr\Log\LoggerInterface; |
| 25 | + |
| 26 | +class ShareReviewSource implements IShareReviewSource { |
| 27 | + |
| 28 | + public const PERMISSION_READ = 'deck:read'; |
| 29 | + public const PERMISSION_EDIT = 'deck:edit'; |
| 30 | + public const PERMISSION_SHARE = 'deck:share'; |
| 31 | + public const PERMISSION_MANAGE = 'deck:manage'; |
| 32 | + |
| 33 | + /** @var array<string, ShareReviewPermission>|null */ |
| 34 | + private ?array $permissionCatalog = null; |
| 35 | + |
| 36 | + public function __construct( |
| 37 | + private readonly AclMapper $aclMapper, |
| 38 | + private readonly LoggerInterface $logger, |
| 39 | + private readonly BoardService $boardService, |
| 40 | + private readonly IEventDispatcher $eventDispatcher, |
| 41 | + private readonly IL10N $l, |
| 42 | + ) { |
| 43 | + } |
| 44 | + |
| 45 | + public function getName(): string { |
| 46 | + return 'Deck'; |
| 47 | + } |
| 48 | + |
| 49 | + /** |
| 50 | + * @return list<ShareReviewEntry> |
| 51 | + */ |
| 52 | + public function getShares(): array { |
| 53 | + try { |
| 54 | + $rawShares = $this->aclMapper->findAllForShareReview(); |
| 55 | + } catch (Exception $e) { |
| 56 | + $this->logger->error('Deck ShareReview: failed to fetch shares: {message}', ['message' => $e->getMessage()]); |
| 57 | + return []; |
| 58 | + } |
| 59 | + return array_map( |
| 60 | + fn (array $share) => $this->buildEntry($share), |
| 61 | + $rawShares, |
| 62 | + ); |
| 63 | + } |
| 64 | + |
| 65 | + public function deleteShare(string $shareId): bool { |
| 66 | + if (!is_numeric($shareId)) { |
| 67 | + return false; |
| 68 | + } |
| 69 | + |
| 70 | + $event = new ShareReviewAccessCheckEvent('Deck', $shareId); |
| 71 | + $this->eventDispatcher->dispatchTyped($event); |
| 72 | + |
| 73 | + if (!$event->isHandled() || !$event->isGranted()) { |
| 74 | + return false; |
| 75 | + } |
| 76 | + |
| 77 | + try { |
| 78 | + $this->boardService->deleteAclForShareReview((int)$shareId); |
| 79 | + return true; |
| 80 | + } catch (DoesNotExistException) { |
| 81 | + return false; |
| 82 | + } |
| 83 | + } |
| 84 | + |
| 85 | + /** @param array<string, mixed> $share */ |
| 86 | + private function buildEntry(array $share): ShareReviewEntry { |
| 87 | + return new ShareReviewEntry( |
| 88 | + id: (string)$share['id'], |
| 89 | + object: $this->resolveObjectName($share), |
| 90 | + initiator: (string)$share['board_owner'], |
| 91 | + type: $this->mapParticipantType((int)$share['type']), |
| 92 | + recipient: (string)$share['participant'], |
| 93 | + lastModifiedTimestamp: max((int)$share['created_at'], (int)$share['last_modified_at']), |
| 94 | + permissions: $this->buildPermissions($share), |
| 95 | + ); |
| 96 | + } |
| 97 | + |
| 98 | + /** @param array<string, mixed> $share */ |
| 99 | + private function resolveObjectName(array $share): string { |
| 100 | + $title = (string)($share['board_title'] ?? ''); |
| 101 | + $boardId = (int)($share['board_id'] ?? $share['id']); |
| 102 | + $label = $title !== '' ? $title : $this->l->t('Board %d', [$boardId]); |
| 103 | + return $this->l->t('%s (Board)', [$label]); |
| 104 | + } |
| 105 | + |
| 106 | + private function mapParticipantType(int $type): int { |
| 107 | + return match($type) { |
| 108 | + Acl::PERMISSION_TYPE_USER => IShare::TYPE_USER, |
| 109 | + Acl::PERMISSION_TYPE_GROUP => IShare::TYPE_GROUP, |
| 110 | + Acl::PERMISSION_TYPE_REMOTE => IShare::TYPE_REMOTE, |
| 111 | + Acl::PERMISSION_TYPE_CIRCLE => IShare::TYPE_CIRCLE, |
| 112 | + default => $this->fallbackParticipantType($type), |
| 113 | + }; |
| 114 | + } |
| 115 | + |
| 116 | + private function fallbackParticipantType(int $type): int { |
| 117 | + $this->logger->warning('Deck ShareReview: unknown ACL participant type {type}, defaulting to user share', ['type' => $type]); |
| 118 | + return IShare::TYPE_USER; |
| 119 | + } |
| 120 | + |
| 121 | + /** |
| 122 | + * @param array<string, mixed> $share |
| 123 | + * @return list<ShareReviewPermission> |
| 124 | + */ |
| 125 | + private function buildPermissions(array $share): array { |
| 126 | + $catalog = $this->permissionCatalog(); |
| 127 | + $permissions = [$catalog[self::PERMISSION_READ]]; |
| 128 | + if ($share['permission_edit']) { |
| 129 | + $permissions[] = $catalog[self::PERMISSION_EDIT]; |
| 130 | + } |
| 131 | + if ($share['permission_share']) { |
| 132 | + $permissions[] = $catalog[self::PERMISSION_SHARE]; |
| 133 | + } |
| 134 | + if ($share['permission_manage']) { |
| 135 | + $permissions[] = $catalog[self::PERMISSION_MANAGE]; |
| 136 | + } |
| 137 | + return $permissions; |
| 138 | + } |
| 139 | + |
| 140 | + /** |
| 141 | + * The permission objects are immutable and identical for every share row, |
| 142 | + * so they are built once per request instead of once per row. |
| 143 | + * |
| 144 | + * All permission IDs are namespaced to this app, and labels and hints are |
| 145 | + * translated from this app's own catalog — the app owning a permission |
| 146 | + * also owns its wording in every language. |
| 147 | + * |
| 148 | + * @return array<string, ShareReviewPermission> |
| 149 | + */ |
| 150 | + private function permissionCatalog(): array { |
| 151 | + return $this->permissionCatalog ??= [ |
| 152 | + self::PERMISSION_READ => new ShareReviewPermission(self::PERMISSION_READ, $this->l->t('Read'), priority: 80), |
| 153 | + self::PERMISSION_EDIT => new ShareReviewPermission(self::PERMISSION_EDIT, $this->l->t('Edit'), $this->l->t('Create, update and delete cards'), 70), |
| 154 | + self::PERMISSION_SHARE => new ShareReviewPermission(self::PERMISSION_SHARE, $this->l->t('Re-share'), priority: 40), |
| 155 | + self::PERMISSION_MANAGE => new ShareReviewPermission(self::PERMISSION_MANAGE, $this->l->t('Manage board'), $this->l->t('Administer participants and board settings'), 30), |
| 156 | + ]; |
| 157 | + } |
| 158 | +} |
0 commit comments