Implement card reference widget

.eslintrc.js

@@ -8,6 +8,7 @@ module.exports = {
 		'jsdoc/require-param-type': ['off'],
 		'jsdoc/check-param-names': ['off'],
 		'jsdoc/no-undefined-types': ['off'],
-		'jsdoc/require-property-description' : ['off']
+		'jsdoc/require-property-description': ['off'],
+		'import/no-named-as-default-member': ['off']
 	},
 }

lib/AppInfo/Application.php

@@ -36,7 +36,6 @@
 use OCA\Deck\Db\AssignmentMapper;
 use OCA\Deck\Db\BoardMapper;
 use OCA\Deck\Db\CardMapper;
-use OCA\Deck\Db\User;
 use OCA\Deck\Event\AclCreatedEvent;
 use OCA\Deck\Event\AclDeletedEvent;
 use OCA\Deck\Event\AclUpdatedEvent;
@@ -48,6 +47,7 @@
 use OCA\Deck\Middleware\DefaultBoardMiddleware;
 use OCA\Deck\Middleware\ExceptionMiddleware;
 use OCA\Deck\Notification\Notifier;
+use OCA\Deck\Reference\CardReferenceProvider;
 use OCA\Deck\Search\CardCommentProvider;
 use OCA\Deck\Search\DeckProvider;
 use OCA\Deck\Service\PermissionService;
@@ -58,6 +58,7 @@
 use OCP\AppFramework\Bootstrap\IBootstrap;
 use OCP\AppFramework\Bootstrap\IRegistrationContext;
 use OCP\AppFramework\Http\Events\BeforeTemplateRenderedEvent;
+use OCP\Collaboration\Reference\RenderReferenceEvent;
 use OCP\Collaboration\Resources\IProviderManager;
 use OCP\Comments\CommentsEntityEvent;
 use OCP\Comments\ICommentsManager;
@@ -83,6 +84,14 @@ class Application extends App implements IBootstrap {
 
 	public function __construct(array $urlParams = []) {
 		parent::__construct(self::APP_ID, $urlParams);
+
+		// TODO move this back to ::register after fixing the autoload issue
+		// (and use a listener class)
+		$container = $this->getContainer();
+		$eventDispatcher = $container->get(IEventDispatcher::class);
+		$eventDispatcher->addListener(RenderReferenceEvent::class, function () {
+			Util::addScript(self::APP_ID, self::APP_ID . '-card-reference');
+		});
 	}
 
 	public function boot(IBootContext $context): void {
@@ -121,8 +130,12 @@ public function register(IRegistrationContext $context): void {
 		$context->registerSearchProvider(CardCommentProvider::class);
 		$context->registerDashboardWidget(DeckWidget::class);
 
+		// reference widget
+		$context->registerReferenceProvider(CardReferenceProvider::class);
+		// $context->registerEventListener(RenderReferenceEvent::class, CardReferenceListener::class);
+
 		$context->registerEventListener(BeforeTemplateRenderedEvent::class, BeforeTemplateRenderedListener::class);
-		
+
 		// Event listening for full text search indexing
 		$context->registerEventListener(CardCreatedEvent::class, FullTextSearchEventListener::class);
 		$context->registerEventListener(CardUpdatedEvent::class, FullTextSearchEventListener::class);

lib/Reference/CardReferenceProvider.php

@@ -0,0 +1,113 @@
+<?php
+/**
+ * @copyright Copyright (c) 2022 Julien Veyssier <eneiluj@posteo.net>
+ *
+ * @author Julien Veyssier <eneiluj@posteo.net>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace OCA\Deck\Reference;
+
+use OC\Collaboration\Reference\Reference;
+use OCA\Deck\AppInfo\Application;
+use OCA\Deck\Service\BoardService;
+use OCA\Deck\Service\CardService;
+use OCA\Deck\Service\StackService;
+use OCP\Collaboration\Reference\IReference;
+use OCP\Collaboration\Reference\IReferenceProvider;
+use OCP\IURLGenerator;
+
+class CardReferenceProvider implements IReferenceProvider {
+	private CardService $cardService;
+	private IURLGenerator $urlGenerator;
+	private BoardService $boardService;
+	private StackService $stackService;
+
+	public function __construct(CardService $cardService,
+								BoardService $boardService,
+								StackService $stackService,
+								IURLGenerator $urlGenerator,
+								?string $userId) {
+		$this->cardService = $cardService;
+		$this->urlGenerator = $urlGenerator;
+		$this->boardService = $boardService;
+		$this->stackService = $stackService;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function matchReference(string $referenceText): bool {
+		$start = $this->urlGenerator->getAbsoluteURL('/apps/' . Application::APP_ID);
+		$startIndex = $this->urlGenerator->getAbsoluteURL('/index.php/apps/' . Application::APP_ID);
+
+		// link example: https://nextcloud.local/index.php/apps/deck/#/board/2/card/11
+		$noIndexMatch = preg_match('/^' . preg_quote($start, '/') . '\/#\/board\/[0-9]+\/card\/[0-9]+$/', $referenceText) === 1;
+		$indexMatch = preg_match('/^' . preg_quote($startIndex, '/') . '\/#\/board\/[0-9]+\/card\/[0-9]+$/', $referenceText) === 1;
+
+		return $noIndexMatch || $indexMatch;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function resolveReference(string $referenceText): ?IReference {
+		if ($this->matchReference($referenceText)) {
+			$cardIds = $this->getBoardCardId($referenceText);
+			if ($cardIds !== null) {
+				[$boardId, $cardId] = $cardIds;
+				$card = $this->cardService->find((int) $cardId);
+				$board = $this->boardService->find((int) $boardId);
+				$stack = $this->stackService->find((int) $card->jsonSerialize()['stackId']);
+				$reference = new Reference($referenceText);
+				$reference->setRichObject(Application::APP_ID . '-card', [
+					'card' => $card,
+					'board' => $board,
+					'stack' => $stack,
+				]);
+				return $reference;
+			}
+		}
+
+		return null;
+	}
+
+	private function getBoardCardId(string $url): ?array {
+		$start = $this->urlGenerator->getAbsoluteURL('/apps/' . Application::APP_ID);
+		$startIndex = $this->urlGenerator->getAbsoluteURL('/index.php/apps/' . Application::APP_ID);
+
+		preg_match('/^' . preg_quote($start, '/') . '\/#\/board\/([0-9]+)\/card\/([0-9]+)$/', $url, $matches);
+		if ($matches && count($matches) > 2) {
+			return [$matches[1], $matches[2]];
+		}
+
+		preg_match('/^' . preg_quote($startIndex, '/') . '\/#\/board\/([0-9]+)\/card\/([0-9]+)$/', $url, $matches2);
+		if ($matches2 && count($matches2) > 2) {
+			return [$matches2[1], $matches2[2]];
+		}
+
+		return null;
+	}
+
+	public function getCachePrefix(string $referenceId): string {
+		return $referenceId;
+	}
+
+	public function getCacheKey(string $referenceId): ?string {
+		return null;
+	}
+}