WIP: Feat/federation

appinfo/routes.php

@@ -132,6 +132,11 @@
 		['name' => 'board_api#preflighted_cors', 'url' => '/api/v{apiVersion}/{path}','verb' => 'OPTIONS', 'requirements' => ['path' => '.+']],
 	],
 	'ocs' => [
+
+		['name' => 'new_board#index', 'url' => '/api/v{apiVersion}/boards', 'verb' => 'GET'],
+		['name' => 'new_board#read', 'url' => '/api/v{apiVersion}/board/{boardId}', 'verb' => 'GET'],
+		['name' => 'new_board#stacks', 'url' => '/api/v{apiVersion}/stacks/{boardId}', 'verb' => 'GET'],
+
 		['name' => 'Config#get', 'url' => '/api/v{apiVersion}/config', 'verb' => 'GET'],
 		['name' => 'Config#setValue', 'url' => '/api/v{apiVersion}/config/{key}', 'verb' => 'POST'],
 

lib/AppInfo/Application.php

@@ -27,6 +27,7 @@
 use OCA\Deck\Event\CardUpdatedEvent;
 use OCA\Deck\Event\SessionClosedEvent;
 use OCA\Deck\Event\SessionCreatedEvent;
+use OCA\Deck\Federation\DeckFederationProvider;
 use OCA\Deck\Listeners\BeforeTemplateRenderedListener;
 use OCA\Deck\Listeners\CommentEventListener;
 use OCA\Deck\Listeners\FullTextSearchEventListener;
@@ -59,9 +60,11 @@
 use OCP\Comments\CommentsEntityEvent;
 use OCP\Comments\CommentsEvent;
 use OCP\EventDispatcher\IEventDispatcher;
+use OCP\Federation\ICloudFederationProviderManager;
 use OCP\Group\Events\GroupDeletedEvent;
 use OCP\IConfig;
 use OCP\IDBConnection;
+use OCP\Server;
 use OCP\Share\IManager;
 use OCP\User\Events\UserDeletedEvent;
 use OCP\Util;
@@ -101,6 +104,7 @@ public function boot(IBootContext $context): void {
 		$context->injectFn(function (Listener $listener, IEventDispatcher $eventDispatcher) {
 			$listener->register($eventDispatcher);
 		});
+		$context->injectFn($this->registerCloudFederationProvider(...));
 	}
 
 	public function register(IRegistrationContext $context): void {
@@ -189,4 +193,14 @@ protected function registerCollaborationResources(IProviderManager $resourceMana
 		$resourceManager->registerResourceProvider(ResourceProvider::class);
 		$resourceManager->registerResourceProvider(ResourceProviderCard::class);
 	}
+
+	public function registerCloudFederationProvider(
+		ICloudFederationProviderManager $manager,
+	): void {
+		$manager->addCloudFederationProvider(
+			DeckFederationProvider::PROVIDER_ID,
+			"Deck Federation",
+			static fn () => Server::get(DeckFederationProvider::class),
+		);
+	}
 }

lib/Controller/BoardController.php

@@ -10,6 +10,7 @@
 use OCA\Deck\Db\Acl;
 use OCA\Deck\Db\Board;
 use OCA\Deck\Service\BoardService;
+use OCA\Deck\Service\ExternalBoardService;
 use OCA\Deck\Service\Importer\BoardImportService;
 use OCA\Deck\Service\PermissionService;
 use OCP\AppFramework\ApiController;
@@ -24,6 +25,7 @@
 		$appName,
 		IRequest $request,
 		private BoardService $boardService,
+		private ExternalBoardService $externalBoardService,
 		private PermissionService $permissionService,
 		private BoardImportService $boardImportService,
 		private IL10N $l10n,
@@ -77,8 +79,8 @@
 	 * @param $participant
 	 */
 	#[NoAdminRequired]
-	public function addAcl(int $boardId, int $type, $participant, bool $permissionEdit, bool $permissionShare, bool $permissionManage): Acl {
-		return $this->boardService->addAcl($boardId, $type, $participant, $permissionEdit, $permissionShare, $permissionManage);
+	public function addAcl(int $boardId, int $type, $participant, bool $permissionEdit, bool $permissionShare, bool $permissionManage, ?string $remote = null): Acl {
+		return $this->boardService->addAcl($boardId, $type, $participant, $permissionEdit, $permissionShare, $permissionManage, $remote);
 	}
 
 	/**

lib/Controller/NewBoardController.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace OCA\Deck\Controller;
+
+use OCA\Deck\Service\BoardService;
+use OCA\Deck\Service\StackService;
+use OCA\Deck\Service\ExternalBoardService;
+use OCP\AppFramework\Http\DataResponse;
+use OCP\AppFramework\OCSController;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
+use OCP\AppFramework\Http\Attribute\PublicPage;
+use OCP\AppFramework\Http\Attribute\RequestHeader;
+use OCP\IRequest;
+use Psr\Log\LoggerInterface;
+
+class NewBoardController extends OCSController{
+	public function __construct(
+		string $appName,
+		IRequest $request,
+		private BoardService $boardService,
+		private ExternalBoardService $externalBoardService,
+		private LoggerInterface $logger,
+		private StackService $stackService,
+	) {
+		parent::__construct($appName, $request);
+	}
+
+	#[NoAdminRequired]
+	public function index(): DataResponse {
+		$internalBoards = $this->boardService->findAll();
+		return new DataResponse($internalBoards);
+	}
+
+	#[NoAdminRequired]
+	#[PublicPage]
+	#[NoCSRFRequired]
+	#[RequestHeader(name: 'x-nextcloud-federation', description: 'Set to 1 when the request is performed by another Nextcloud Server to indicate a federation request', indirect: true)]
+	public function read(int $boardId): DataResponse {
+		// Board on this instance -> get it from database
+		$localBoard = $this->boardService->find($boardId, true, true, $this->request->getParam('accessToken'));
+		if($localBoard->getExternalId() !== null) {
+			return $this->externalBoardService->getExternalBoardFromRemote($localBoard);
+		}
+		// Board on other instance -> get it from other instance
+		return new DataResponse($localBoard);
+	}
+
+	#[NoAdminRequired]
+	#[PublicPage]
+	#[NoCSRFRequired]
+	#[RequestHeader(name: 'x-nextcloud-federation', description: 'Set to 1 when the request is performed by another Nextcloud Server to indicate a federation request', indirect: true)]
+	public function stacks(int $boardId): DataResponse{
+		$localBoard = $this->boardService->find($boardId, true, true, $this->request->getParam('accessToken'));
+		// Board on other instance -> get it from other instance
+		if($localBoard->getExternalId() !== null) {
+			return $this->externalBoardService->getExternalStacksFromRemote($localBoard);
+		} else {
+			return new DataResponse($this->stackService->findAll($boardId));
+		}
+	}
+}

lib/Controller/PageController.php

@@ -10,6 +10,7 @@
 use OCA\Deck\Db\Acl;
 use OCA\Deck\Db\CardMapper;
 use OCA\Deck\Service\BoardService;
+use OCA\Deck\Service\ExternalBoardService;
 use OCA\Deck\Service\CardService;
 use OCA\Deck\Service\ConfigService;
 use OCA\Deck\Service\PermissionService;
@@ -36,6 +37,7 @@ public function __construct(
 		private PermissionService $permissionService,
 		private IInitialState $initialState,
 		private BoardService $boardService,
+		private ExternalBoardService $externalBoardService,
 		private ConfigService $configService,
 		private IEventDispatcher $eventDispatcher,
 		private CardMapper $cardMapper,
@@ -53,7 +55,9 @@ public function index(): TemplateResponse {
 		$this->initialState->provideInitialState('canCreate', $this->permissionService->canCreate());
 		$this->initialState->provideInitialState('config', $this->configService->getAll());
 
-		$this->initialState->provideInitialState('initialBoards', $this->boardService->findAll());
+		$this->initialState->provideInitialState('initialBoards', [
+			$this->boardService->findAll(),
+		]);
 
 		$this->eventDispatcher->dispatchTyped(new LoadSidebar());
 		$this->eventDispatcher->dispatchTyped(new CollaborationResourcesEvent());

lib/Db/Acl.php

@@ -19,6 +19,8 @@
  * @method void setType(int $type)
  * @method bool isOwner()
  * @method void setOwner(int $owner)
+ * @method void setToken(string $token)
+ * @method string getToken()
  *
  */
 class Acl extends RelationalEntity {
@@ -29,6 +31,7 @@ class Acl extends RelationalEntity {
 
 	public const PERMISSION_TYPE_USER = 0;
 	public const PERMISSION_TYPE_GROUP = 1;
+	public const PERMISSION_TYPE_REMOTE = 6;
 	public const PERMISSION_TYPE_CIRCLE = 7;
 
 	protected $participant;
@@ -38,6 +41,7 @@ class Acl extends RelationalEntity {
 	protected $permissionShare = false;
 	protected $permissionManage = false;
 	protected $owner = false;
+	protected $token = null;
 
 	public function __construct() {
 		$this->addType('id', 'integer');
@@ -47,6 +51,7 @@ public function __construct() {
 		$this->addType('permissionManage', 'boolean');
 		$this->addType('type', 'integer');
 		$this->addType('owner', 'boolean');
+		$this->addType('token', 'string');
 		$this->addRelation('owner');
 		$this->addResolvable('participant');
 	}

lib/Db/AclMapper.php

@@ -24,7 +24,7 @@ public function __construct(IDBConnection $db) {
 	 */
 	public function findAll(int $boardId, ?int $limit = null, ?int $offset = null) {
 		$qb = $this->db->getQueryBuilder();
-		$qb->select('id', 'board_id', 'type', 'participant', 'permission_edit', 'permission_share', 'permission_manage')
+		$qb->select('id', 'board_id', 'type', 'participant', 'permission_edit', 'permission_share', 'permission_manage', 'token')
 			->from('deck_board_acl')
 			->where($qb->expr()->eq('board_id', $qb->createNamedParameter($boardId, IQueryBuilder::PARAM_INT)))
 			->setMaxResults($limit)

lib/Db/Board.php

@@ -24,6 +24,10 @@
  * @method void setOwner(string $owner)
  * @method string getColor()
  * @method void setColor(string $color)
+ * @method void setShareToken(string $shareToken)
+ * @method string getShareToken()
+ * @method void setExternalId(int $externalId)
+ * @method int getExternalId()
  */
 class Board extends RelationalEntity {
 	protected $title;
@@ -41,6 +45,8 @@ class Board extends RelationalEntity {
 	protected $activeSessions = [];
 	protected $deletedAt = 0;
 	protected $lastModified = 0;
+	protected $shareToken = null;
+	protected $externalId = null;
 
 	protected $settings = [];
 
@@ -50,6 +56,8 @@ public function __construct() {
 		$this->addType('archived', 'boolean');
 		$this->addType('deletedAt', 'integer');
 		$this->addType('lastModified', 'integer');
+		$this->addType('shareToken', 'string');
+		$this->addType('externalId', 'integer');
 		$this->addRelation('labels');
 		$this->addRelation('acl');
 		$this->addRelation('shared');

lib/Db/BoardMapper.php

@@ -509,6 +509,9 @@ public function mapAcl(Acl &$acl): void {
 				}
 				return null;
 			}
+			if ($acl->getType() === Acl::PERMISSION_TYPE_REMOTE) {
+				return null;
+			}
 			$this->logger->warning('Unknown permission type for mapping acl ' . $acl->getId());
 			return null;
 		});

lib/Federation/DeckFederationProvider.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace OCA\Deck\Federation;
+use OCA\Deck\Db\Board;
+use OCA\Deck\Db\Acl;
+use OCA\Deck\Db\BoardMapper;
+use OCA\Deck\Db\AclMapper;
+use OCA\Deck\Db\ChangeHelper;
+use OCP\Federation\ICloudFederationProvider;
+use OCP\Federation\ICloudFederationShare;
+use OCP\Federation\ICloudIdManager;
+use OCP\Notification\IManager as INotificationManager;
+use Exception;
+
+class DeckFederationProvider implements ICloudFederationProvider{
+	public const PROVIDER_ID = 'deck';
+
+	public function __construct(
+		private readonly ICloudIdmanager $cloudIdManager,
+		private INotificationManager $notificationManager,
+		private BoardMapper $boardMapper,
+		private AclMapper $aclMapper,
+		private ChangeHelper $changeHelper,
+	){
+	}
+
+	public function getShareType(): string {
+		return self::PROVIDER_ID;
+	}
+
+	public function shareReceived(ICloudFederationShare $share): string {
+		$notification = $this->notificationManager->createNotification();
+		$notification->setApp('deck');
+		$notification->setUser($share->getShareWith());
+		$notification->setDateTime(new \DateTime());
+		$notification->setObject('remote-board-shared', (string) rand(0,9999999));
+		$notification->setSubject('remote-board-shared',[$share->getResourceName(), $share->getSharedBy()]);
+
+		$this->notificationManager->notify($notification);
+
+		$externalBoard = new Board();
+		$externalBoard->setTitle($share->getResourceName());
+		$externalBoard->setExternalId($share->getProviderId());
+		$externalBoard->setOwner($share->getSharedBy());
+		$externalBoard->setShareToken($share->getShareSecret());
+		$insertedBoard = $this->boardMapper->insert($externalBoard);
+
+		$acl = new Acl();
+		$acl->setBoardId($insertedBoard->getId());
+		$acl->setType(Acl::PERMISSION_TYPE_USER);
+		$acl->setParticipant($share->getShareWith());
+		$acl->setPermissionEdit(false);
+		$acl->setPermissionShare(false);
+		$acl->setPermissionManage(false);
+		$this->aclMapper->insert($acl);
+
+		$this->changeHelper->boardChanged($insertedBoard->getId());
+		return 'PLACE_HOLDER_ID';
+	}
+
+	public function notificationReceived($notificationType, $providerId, $notification): array {
+		return [];
+	}
+
+	public function getSupportedShareTypes(): array {
+		return ['user'];
+	}
+}