Merge pull request #904 from nextcloud/enh/863/navigation

feat(Contexts): add Contexts to navigation when applicable

lib/AppInfo/Application.php

@@ -6,6 +6,7 @@
 use OCA\Analytics\Datasource\DatasourceEvent;
 use OCA\Tables\Capabilities;
 use OCA\Tables\Listener\AnalyticsDatasourceListener;
+use OCA\Tables\Listener\BeforeTemplateRenderedListener;
 use OCA\Tables\Listener\LoadAdditionalListener;
 use OCA\Tables\Listener\TablesReferenceListener;
 use OCA\Tables\Listener\UserDeletedListener;
@@ -16,6 +17,7 @@
 use OCP\AppFramework\Bootstrap\IBootContext;
 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\LoadAdditionalScriptsEvent;
 use OCP\User\Events\BeforeUserDeletedEvent;
@@ -28,6 +30,10 @@ class Application extends App implements IBootstrap {
 
 	public const OWNER_TYPE_USER = 0;
 
+	public const NAV_ENTRY_MODE_HIDDEN = 0;
+	public const NAV_ENTRY_MODE_RECIPIENTS = 1;
+	public const NAV_ENTRY_MODE_ALL = 2;
+
 	public function __construct() {
 		parent::__construct(self::APP_ID);
 	}
@@ -43,7 +49,7 @@ public function register(IRegistrationContext $context): void {
 		$context->registerEventListener(BeforeUserDeletedEvent::class, UserDeletedListener::class);
 		$context->registerEventListener(DatasourceEvent::class, AnalyticsDatasourceListener::class);
 		$context->registerEventListener(RenderReferenceEvent::class, TablesReferenceListener::class);
-
+		$context->registerEventListener(BeforeTemplateRenderedEvent::class, BeforeTemplateRenderedListener::class);
 		$context->registerEventListener(LoadAdditionalScriptsEvent::class, LoadAdditionalListener::class);
 
 		$context->registerSearchProvider(SearchTablesProvider::class);

lib/Db/ContextMapper.php

@@ -4,6 +4,7 @@
 
 namespace OCA\Tables\Db;
 
+use OCA\Tables\AppInfo\Application;
 use OCA\Tables\Errors\NotFoundError;
 use OCA\Tables\Helper\UserHelper;
 use OCP\AppFramework\Db\QBMapper;
@@ -161,6 +162,42 @@ public function findAll(?string $userId = null): array {
 		return $resultEntities;
 	}
 
+	public function findForNavBar(string $userId): array {
+		$qb = $this->getFindContextBaseQuery($userId);
+		$qb->andWhere($qb->expr()->andX(
+			// default
+			$qb->expr()->gt('n.display_mode', $qb->createNamedParameter(Application::NAV_ENTRY_MODE_HIDDEN, IQueryBuilder::PARAM_INT)),
+			// user override
+			$qb->expr()->orX(
+				$qb->expr()->gt('n2.display_mode', $qb->createNamedParameter(Application::NAV_ENTRY_MODE_HIDDEN, IQueryBuilder::PARAM_INT)),
+				$qb->expr()->isNull('n2.display_mode'),
+			)
+		));
+
+		$result = $qb->executeQuery();
+		$r = $result->fetchAll();
+
+		$contextIds = [];
+		foreach ($r as $row) {
+			$contextIds[$row['id']] = 1;
+		}
+		$contextIds = array_keys($contextIds);
+		unset($row);
+
+		$resultEntities = [];
+		foreach ($contextIds as $contextId) {
+			$workArray = [];
+			foreach ($r as $row) {
+				if ($row['id'] === $contextId) {
+					$workArray[] = $row;
+				}
+			}
+			$resultEntities[] = $this->formatResultRows($workArray, $userId);
+		}
+
+		return $resultEntities;
+	}
+
 	/**
 	 * @throws Exception
 	 * @throws NotFoundError

lib/Listener/BeforeTemplateRenderedListener.php

@@ -0,0 +1,91 @@
+<?php
+
+namespace OCA\Tables\Listener;
+
+use OCA\Tables\AppInfo\Application;
+use OCA\Tables\Service\ContextService;
+use OCP\AppFramework\Http\Events\BeforeTemplateRenderedEvent;
+use OCP\EventDispatcher\Event;
+use OCP\EventDispatcher\IEventListener;
+use OCP\INavigationManager;
+use OCP\IURLGenerator;
+use OCP\IUserSession;
+
+/**
+ * @template-implements IEventListener<Event|BeforeTemplateRenderedEvent>
+ */
+class BeforeTemplateRenderedListener implements IEventListener {
+	public function __construct(
+		protected INavigationManager $navigationManager,
+		protected IURLGenerator $urlGenerator,
+		protected IUserSession $userSession,
+		protected ContextService $contextService,
+	) {
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function handle(Event $event): void {
+		if (!$event instanceof BeforeTemplateRenderedEvent) {
+			return;
+		}
+
+		$user = $this->userSession->getUser();
+		if ($user === null) {
+			return;
+		}
+
+		// temporarily show all
+		//$contexts = $this->contextService->findForNavigation($user->getUID());
+		$contexts = $this->contextService->findAll($user->getUID());
+		foreach ($contexts as $context) {
+			/* temporarily, show all
+			if ($context->getOwnerType() === Application::OWNER_TYPE_USER
+				&& $context->getOwnerId() === $user->getUID()) {
+
+
+				// filter out entries for owners unless it is set to be visible
+				$skipEntry = true;
+				foreach ($context->getSharing() as $shareInfo) {
+					// TODO: integrate into DB query in Mapper
+
+					if (isset($shareInfo['display_mode']) && $shareInfo['display_mode'] === Application::NAV_ENTRY_MODE_ALL) {
+						// a custom override makes it visible
+						$skipEntry = false;
+						break;
+					} elseif (!isset($shareInfo['display_mode']) && $shareInfo['display_mode_default'] === Application::NAV_ENTRY_MODE_ALL) {
+						// no custom override, and visible also for owner by default
+						$skipEntry = false;
+						break;
+					}
+				}
+				if ($skipEntry) {
+					continue;
+				}
+			}
+			*/
+
+			$this->navigationManager->add(function () use ($context) {
+				$iconRelPath = 'material/' . $context->getIcon() . '.svg';
+				if (file_exists(__DIR__ . '/../../img/' . $iconRelPath)) {
+					$iconUrl = $this->urlGenerator->imagePath(Application::APP_ID, $iconRelPath);
+				} else {
+					$iconUrl = $this->urlGenerator->imagePath('core', 'places/default-app-icon.svg');
+				}
+
+				$contextUrl = $this->urlGenerator->linkToRoute('tables.page.index');
+				$contextUrl .= sprintf('#/application/%d', $context->getId());
+
+				return [
+					'id' => Application::APP_ID . '_application_' . $context->getId(),
+					'name' => $context->getName(),
+					'href' => $contextUrl,
+					'icon' => $iconUrl,
+					'order' => 500,
+					'type' => 'link',
+				];
+			});
+		}
+	}
+}

lib/Service/ContextService.php

@@ -77,6 +77,10 @@ public function findAll(?string $userId): array {
 		return $this->contextMapper->findAll($userId);
 	}
 
+	public function findForNavigation(string $userId): array {
+		return $this->contextMapper->findForNavBar($userId);
+	}
+
 	/**
 	 * @throws Exception
 	 * @throws InternalError