WIP move to SSP UI

cicnavi · cicnavi · commit 5e2abff11611 · 2024-11-14T13:08:51.000+01:00
diff --git a/hooks/hook_adminmenu.php b/hooks/hook_adminmenu.php
@@ -25,8 +25,22 @@ function oidc_hook_adminmenu(Template &$template): void
         ],
     ];
 
-    // Put our entry before the "Log out" entry.
-    array_splice($template->data[$menuKey], -1, 0, $oidcMenuEntry);
+    // Put OIDC entry before the 'Log out' entry, if it exists.
+    $logoutEntryKey = 'logout';
+    $logoutEntryValue = null;
+    if (
+        array_key_exists($logoutEntryKey, $template->data[$menuKey]) &&
+        is_array($template->data[$menuKey][$logoutEntryKey])
+    ) {
+        $logoutEntryValue = $template->data[$menuKey][$logoutEntryKey];
+        unset($template->data[$menuKey][$logoutEntryKey]);
+    }
+
+    $template->data[$menuKey] += $oidcMenuEntry;
+
+    if ($logoutEntryValue !== null) {
+        $template->data[$menuKey][$logoutEntryKey] = $logoutEntryValue;
+    }
 
     $template->getLocalization()->addModuleDomain(ModuleConfig::MODULE_NAME);
 }
diff --git a/public/assets/css/src/default.css b/public/assets/css/src/default.css
@@ -1,10 +1,10 @@
 .wrap {
-    max-width: 1300px;
+    /*max-width: 1300px;*/
 }
 
-h2 {
-    margin: 0.3em;
-}
+/*h2 {*/
+/*    margin: 0.3em;*/
+/*}*/
 
 h3 {
     margin-bottom: 0.5em;
diff --git a/src/Bridges/SspBridge/Module.php b/src/Bridges/SspBridge/Module.php
@@ -5,11 +5,27 @@
 namespace SimpleSAML\Module\oidc\Bridges\SspBridge;
 
 use SimpleSAML\Module as SspModule;
+use SimpleSAML\Module\oidc\Bridges\SspBridge\Module\Admin;
 
 class Module
 {
+    protected static ?SspModule\oidc\Bridges\SspBridge\Module\Admin $admin = null;
+
+    public function admin(): Admin
+    {
+        return self::$admin ??= new Admin();
+    }
+
     public function getModuleUrl(string $resource, array $parameters = []): string
     {
         return SspModule::getModuleURL($resource, $parameters);
     }
+
+    /**
+     * @throws \Exception
+     */
+    public function isModuleEnabled(string $moduleName): bool
+    {
+        return SspModule::isModuleEnabled($moduleName);
+    }
 }
diff --git a/src/Bridges/SspBridge/Module/Admin.php b/src/Bridges/SspBridge/Module/Admin.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Module\oidc\Bridges\SspBridge\Module;
+
+use SimpleSAML\Module\admin\Controller\Menu;
+
+class Admin
+{
+    public function buildSspAdminMenu(): Menu
+    {
+        return new Menu();
+    }
+}
diff --git a/src/Controller/AdminController.php b/src/Controller/AdminController.php
@@ -5,6 +5,7 @@
 namespace SimpleSAML\Module\oidc\Controller;
 
 use SimpleSAML\Module\oidc\Admin\Authorization;
+use SimpleSAML\Module\oidc\Codebooks\RoutesEnum;
 use SimpleSAML\Module\oidc\Factories\TemplateFactory;
 use SimpleSAML\Module\oidc\ModuleConfig;
 use Symfony\Component\HttpFoundation\Response;
@@ -21,11 +22,10 @@ public function __construct(
 
     public function configOverview(): Response
     {
-        return $this->templateFactory->render(
+        return $this->templateFactory->build(
             'oidc:config/overview.twig',
-            [
-                'moduleConfig' => $this->moduleConfig,
-            ],
+            ['moduleConfig' => $this->moduleConfig],
+            RoutesEnum::AdminConfigOverview->value,
         );
     }
 }
diff --git a/src/Controller/Client/CreateController.php b/src/Controller/Client/CreateController.php
@@ -135,7 +135,7 @@ public function __invoke(): Template|RedirectResponse
             return new RedirectResponse((new HTTP())->addURLParameters('show.php', ['client_id' => $client['id']]));
         }
 
-        return $this->templateFactory->render('oidc:clients/new.twig', [
+        return $this->templateFactory->build('oidc:clients/new.twig', [
             'form' => $form,
             'regexUri' => ClientForm::REGEX_URI,
             'regexAllowedOriginUrl' => ClientForm::REGEX_ALLOWED_ORIGIN_URL,
diff --git a/src/Controller/Client/DeleteController.php b/src/Controller/Client/DeleteController.php
@@ -71,7 +71,7 @@ public function __invoke(ServerRequest $request): Template|RedirectResponse
             return new RedirectResponse((new HTTP())->addURLParameters('index.php', []));
         }
 
-        return $this->templateFactory->render('oidc:clients/delete.twig', [
+        return $this->templateFactory->build('oidc:clients/delete.twig', [
             'client' => $client,
         ]);
     }
diff --git a/src/Controller/Client/EditController.php b/src/Controller/Client/EditController.php
@@ -143,7 +143,7 @@ public function __invoke(ServerRequest $request): Template|RedirectResponse
             );
         }
 
-        return $this->templateFactory->render('oidc:clients/edit.twig', [
+        return $this->templateFactory->build('oidc:clients/edit.twig', [
             'form' => $form,
             'regexUri' => ClientForm::REGEX_URI,
             'regexAllowedOriginUrl' => ClientForm::REGEX_ALLOWED_ORIGIN_URL,
diff --git a/src/Controller/Client/IndexController.php b/src/Controller/Client/IndexController.php
@@ -44,7 +44,7 @@ public function __invoke(ServerRequest $request): Template
         $authedUser = $this->authContextService->isSspAdmin() ? null : $this->authContextService->getAuthUserId();
         $pagination = $this->clientRepository->findPaginated($page, $query, $authedUser);
 
-        return $this->templateFactory->render('oidc:clients/index.twig', [
+        return $this->templateFactory->build('oidc:clients/index.twig', [
             'clients' => $pagination['items'],
             'numPages' => $pagination['numPages'],
             'currentPage' => $pagination['currentPage'],
diff --git a/src/Controller/Client/ShowController.php b/src/Controller/Client/ShowController.php
@@ -49,7 +49,7 @@ public function __invoke(ServerRequest $request): Template
         $client = $this->getClientFromRequest($request);
         $allowedOrigins = $this->allowedOriginRepository->get($client->getIdentifier());
 
-        return $this->templateFactory->render('oidc:clients/show.twig', [
+        return $this->templateFactory->build('oidc:clients/show.twig', [
             'client' => $client,
             'allowedOrigins' => $allowedOrigins,
         ]);
diff --git a/src/Controller/EndSessionController.php b/src/Controller/EndSessionController.php
@@ -197,7 +197,7 @@ protected function resolveResponse(LogoutRequest $logoutRequest, bool $wasLogout
             return new RedirectResponse($postLogoutRedirectUri);
         }
 
-        return $this->templateFactory->render('oidc:/logout.twig', [
+        return $this->templateFactory->build('oidc:/logout.twig', [
             'wasLogoutActionCalled' => $wasLogoutActionCalled,
         ]);
     }
diff --git a/src/Controller/InstallerController.php b/src/Controller/InstallerController.php
@@ -61,7 +61,7 @@ public function __invoke(ServerRequest $request): Template|RedirectResponse
             return new RedirectResponse((new HTTP())->addURLParameters('admin-clients/index.php', []));
         }
 
-        return $this->templateFactory->render('oidc:install.twig', [
+        return $this->templateFactory->build('oidc:install.twig', [
             'oauth2_enabled' => $oauth2Enabled,
         ]);
     }
diff --git a/src/Factories/TemplateFactory.php b/src/Factories/TemplateFactory.php
@@ -17,25 +17,100 @@
 namespace SimpleSAML\Module\oidc\Factories;
 
 use SimpleSAML\Configuration;
+use SimpleSAML\Locale\Translate;
+use SimpleSAML\Module\oidc\Admin\Menu;
+use SimpleSAML\Module\oidc\Bridges\SspBridge;
+use SimpleSAML\Module\oidc\Codebooks\RoutesEnum;
+use SimpleSAML\Module\oidc\ModuleConfig;
 use SimpleSAML\XHTML\Template;
 
 class TemplateFactory
 {
-    private readonly Configuration $configuration;
+    protected bool $showMenu = true;
+    protected bool $includeDefaultMenuItems = true;
 
-    public function __construct(Configuration $configuration)
-    {
-        $this->configuration = new Configuration($configuration->toArray(), 'oidc');
+    public function __construct(
+        protected readonly Configuration $sspConfiguration,
+        protected readonly ModuleConfig $moduleConfig,
+        protected readonly Menu $oidcMenu,
+        protected readonly SspBridge $sspBridge,
+    ) {
     }
 
     /**
      * @throws \SimpleSAML\Error\ConfigurationError
      */
-    public function render(string $templateName, array $data = []): Template
-    {
-        $template = new Template($this->configuration, $templateName);
+    public function build(
+        string $templateName,
+        array $data = [],
+        string $activeHrefPath = null,
+    ): Template {
+        $template = new Template($this->sspConfiguration, $templateName);
+
+        if ($this->includeDefaultMenuItems) {
+            $this->includeDefaultMenuItems();
+        }
+
+        if ($activeHrefPath) {
+            $this->setActiveHrefPath($activeHrefPath);
+        }
+
+        $template->data = [
+            'sspConfiguration' => $this->sspConfiguration,
+            'moduleConfiguration' => $this->moduleConfig,
+            'oidcMenu' => $this->oidcMenu,
+            'showMenu' => $this->showMenu,
+        ];
+
+        if ($this->sspBridge->module()->isModuleEnabled('admin')) {
+            $template->addTemplatesFromModule('admin');
+            $sspMenu = $this->sspBridge->module()->admin()->buildSspAdminMenu();
+            $sspMenu->addOption(
+                'logout',
+                $this->sspBridge->utils()->auth()->getAdminLogoutURL(),
+                Translate::noop('Log out'),
+            );
+            $template = $sspMenu->insert($template);
+            $template->data['frontpage_section'] = ModuleConfig::MODULE_NAME;
+        }
+
         $template->data += $data;
 
         return $template;
     }
+
+    protected function includeDefaultMenuItems(): void
+    {
+        $this->oidcMenu->addItem(
+            $this->oidcMenu->buildItem(
+                $this->moduleConfig->getModuleUrl(RoutesEnum::AdminConfigOverview->value),
+                \SimpleSAML\Locale\Translate::noop('Config Overview '),
+            ),
+        );
+    }
+
+    public function setShowMenu(bool $showMenu): TemplateFactory
+    {
+        $this->showMenu = $showMenu;
+        return $this;
+    }
+
+    public function setIncludeDefaultMenuItems(bool $includeDefaultMenuItems): TemplateFactory
+    {
+        $this->includeDefaultMenuItems = $includeDefaultMenuItems;
+        return $this;
+    }
+
+    public function setActiveHrefPath(?string $activeHrefPath): TemplateFactory
+    {
+        $this->oidcMenu->setActiveHrefPath(
+            $activeHrefPath ? $this->moduleConfig->getModuleUrl($activeHrefPath) : null,
+        );
+        return $this;
+    }
+
+    public function getActiveHrefPath(): ?string
+    {
+        return $this->oidcMenu->getActiveHrefPath();
+    }
 }
diff --git a/src/Services/Container.php b/src/Services/Container.php
@@ -31,6 +31,7 @@
 use SimpleSAML\Database;
 use SimpleSAML\Error\Exception;
 use SimpleSAML\Metadata\MetaDataStorageHandler;
+use SimpleSAML\Module\oidc\Admin\Menu;
 use SimpleSAML\Module\oidc\Bridges\PsrHttpBridge;
 use SimpleSAML\Module\oidc\Bridges\SspBridge;
 use SimpleSAML\Module\oidc\Factories\AuthorizationServerFactory;
@@ -149,7 +150,18 @@ public function __construct()
         $sessionMessagesService = new SessionMessagesService($session);
         $this->services[SessionMessagesService::class] = $sessionMessagesService;
 
-        $templateFactory = new TemplateFactory($simpleSAMLConfiguration);
+        $sspBridge = new SspBridge();
+        $this->services[SspBridge::class] = $sspBridge;
+
+        $oidcMenu = new Menu();
+        $this->services[Menu::class] = $oidcMenu;
+
+        $templateFactory = new TemplateFactory(
+            $simpleSAMLConfiguration,
+            $moduleConfig,
+            $oidcMenu,
+            $sspBridge,
+        );
         $this->services[TemplateFactory::class] = $templateFactory;
 
         $opMetadataService = new OpMetadataService($moduleConfig);
@@ -193,9 +205,6 @@ public function __construct()
         $requestParamsResolver = new RequestParamsResolver($helpers, $core, $federation);
         $this->services[RequestParamsResolver::class] = $requestParamsResolver;
 
-        $sspBridge = new SspBridge();
-        $this->services[SspBridge::class] = $sspBridge;
-
         $clientEntityFactory = new ClientEntityFactory(
             $sspBridge,
             $helpers,
diff --git a/templates/base.twig b/templates/base.twig
@@ -11,6 +11,8 @@
 
 {% block content %}
 
+    {%- include "@admin/includes/menu.twig" %}
+
     <h2>{{ moduleName }}</h2>
 
     <div class="oidc-container">
diff --git a/templates/config/overview.twig b/templates/config/overview.twig
@@ -4,8 +4,6 @@
 
 {% block oidcContent %}
 
-    <p>{{ 'OIDC module config overview'|trans }}</p>
-
-    <h4>{{ 'Migrations'|trans }}</h4>
+    <p>{{ 'TODO config overview'|trans }}</p>
 
 {% endblock oidcContent -%}
diff --git a/templates/includes/menu.twig b/templates/includes/menu.twig
@@ -1,13 +1,15 @@
-{% if menu|default %}
+{% if oidcMenu|default %}
     <div class="menu">
         <ul>
-            {% for item in menu.items %}
+            {% for item in oidcMenu.items %}
             <li>
                 <a href="{{ item.hrefPath }}"
-                   class="{{ item.hrefPath == menu.activeHrefPath ? 'active' : '' }}"
+                   class="{{ item.hrefPath == oidcMenu.activeHrefPath ? 'active' : '' }}"
                 > {{ item.label }} </a>
             </li>
             {% endfor %}
         </ul>
     </div>
+
+
 {% endif %}
diff --git a/tests/unit/src/Controller/Client/CreateControllerTest.php b/tests/unit/src/Controller/Client/CreateControllerTest.php
@@ -99,7 +99,7 @@ public function testCanShowNewClientForm(): void
 
         $this->templateFactoryMock
             ->expects($this->once())
-            ->method('render')
+            ->method('build')
             ->with('oidc:clients/new.twig', [
                 'form' => $this->clientFormMock,
                 'regexUri' => ClientForm::REGEX_URI,
diff --git a/tests/unit/src/Controller/Client/DeleteControllerTest.php b/tests/unit/src/Controller/Client/DeleteControllerTest.php
@@ -81,7 +81,7 @@ public function testItAsksConfirmationBeforeDeletingClient(): void
         $this->serverRequestMock->expects($this->once())->method('getMethod')->willReturn('get');
         $this->clientRepositoryMock->expects($this->once())->method('findById')->with('clientid')
             ->willReturn($this->clientEntityMock);
-        $this->templateFactoryMock->expects($this->once())->method('render')
+        $this->templateFactoryMock->expects($this->once())->method('build')
             ->with('oidc:clients/delete.twig', ['client' => $this->clientEntityMock])
             ->willReturn($this->templateStub);
 
diff --git a/tests/unit/src/Controller/Client/EditControllerTest.php b/tests/unit/src/Controller/Client/EditControllerTest.php
@@ -160,7 +160,7 @@ public function testItShowsEditClientForm(): void
         $this->clientFormMock->expects($this->once())->method('setDefaults')->with($data);
         $this->clientFormMock->expects($this->once())->method('isSuccess')->willReturn(false);
         $this->formFactoryMock->expects($this->once())->method('build')->willReturn($this->clientFormMock);
-        $this->templateFactoryMock->expects($this->once())->method('render')->with(
+        $this->templateFactoryMock->expects($this->once())->method('build')->with(
             'oidc:clients/edit.twig',
             [
                 'form' => $this->clientFormMock,
diff --git a/tests/unit/src/Controller/Client/IndexControllerTest.php b/tests/unit/src/Controller/Client/IndexControllerTest.php
@@ -75,7 +75,7 @@ public function testItShowsClientIndex(): void
                 ],
             );
 
-        $this->templateFactoryMock->expects($this->once())->method('render')->with(
+        $this->templateFactoryMock->expects($this->once())->method('build')->with(
             'oidc:clients/index.twig',
             [
                 'clients' => [],
diff --git a/tests/unit/src/Controller/Client/ShowControllerTest.php b/tests/unit/src/Controller/Client/ShowControllerTest.php
@@ -90,7 +90,7 @@ public function testItShowsClientDescription(): void
             ->willReturn([]);
         $this->templateFactoryMock
             ->expects($this->once())
-            ->method('render')
+            ->method('build')
             ->with(
                 'oidc:clients/show.twig',
                 [
diff --git a/tests/unit/src/Controller/InstallerControllerTest.php b/tests/unit/src/Controller/InstallerControllerTest.php

Original file line number	Diff line number	Diff line change
`@@ -135,7 +135,7 @@ public function __invoke(): Template\|RedirectResponse`
`135`	`135`	`return new RedirectResponse((new HTTP())->addURLParameters('show.php', ['client_id' => $client['id']]));`
`136`	`136`	`}`
`137`	`137`
`138`		`- return $this->templateFactory->render('oidc:clients/new.twig', [`
	`138`	`+ return $this->templateFactory->build('oidc:clients/new.twig', [`
`139`	`139`	`'form' => $form,`
`140`	`140`	`'regexUri' => ClientForm::REGEX_URI,`
`141`	`141`	`'regexAllowedOriginUrl' => ClientForm::REGEX_ALLOWED_ORIGIN_URL,`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ public function __invoke(ServerRequest $request): Template\|RedirectResponse`
`71`	`71`	`return new RedirectResponse((new HTTP())->addURLParameters('index.php', []));`
`72`	`72`	`}`
`73`	`73`
`74`		`- return $this->templateFactory->render('oidc:clients/delete.twig', [`
	`74`	`+ return $this->templateFactory->build('oidc:clients/delete.twig', [`
`75`	`75`	`'client' => $client,`
`76`	`76`	`]);`
`77`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -143,7 +143,7 @@ public function __invoke(ServerRequest $request): Template\|RedirectResponse`
`143`	`143`	`);`
`144`	`144`	`}`
`145`	`145`
`146`		`- return $this->templateFactory->render('oidc:clients/edit.twig', [`
	`146`	`+ return $this->templateFactory->build('oidc:clients/edit.twig', [`
`147`	`147`	`'form' => $form,`
`148`	`148`	`'regexUri' => ClientForm::REGEX_URI,`
`149`	`149`	`'regexAllowedOriginUrl' => ClientForm::REGEX_ALLOWED_ORIGIN_URL,`