Use PSR-14 events to replace hook infrastructure (simplesamlphp#2560)

* Replace hook infrastructure with PSR-14 events

* fix lookup for module event listeners

* remove redunant registration of module event listeners

* use correct config key to resolve enabled modules

* fix template reference

* add missing event variable type hints

* refactor: remove event dispatcher property and instantiate it locally

* refactor: move enabled modules discovery to ModuleListenerProvider

Author: m0ark

composer.json

@@ -66,6 +66,7 @@
         "gettext/gettext": "~5.7.3",
         "gettext/translator": "~1.2.1",
         "phpmailer/phpmailer": "~6.12.0",
+        "psr/event-dispatcher": "~1.0.0",
         "psr/log": "~3.0.2",
         "robrichards/xmlseclibs": "~3.1.3",
         "simplesamlphp/assert": "^1.9",
@@ -79,6 +80,7 @@
         "symfony/config": "~7.3.0",
         "symfony/console": "~7.3.0",
         "symfony/dependency-injection": "~7.3.0",
+        "symfony/event-dispatcher": "~7.3.0",
         "symfony/expression-language": "~7.3.0",
         "symfony/filesystem": "~7.3.0",
         "symfony/finder": "~7.3.0",

composer.lock

@@ -5,8 +5,11 @@
 namespace SimpleSAML\Module\admin\Controller;
 
 use SimpleSAML\Configuration;
+use SimpleSAML\Event\Dispatcher\ModuleEventDispatcherFactory;
 use SimpleSAML\Locale\Translate;
 use SimpleSAML\Module;
+use SimpleSAML\Module\admin\Event\ConfigPageEvent;
+use SimpleSAML\Module\admin\Event\SanityCheckEvent;
 use SimpleSAML\Session;
 use SimpleSAML\Utils;
 use SimpleSAML\XHTML\Template;
@@ -162,6 +165,10 @@ public function main(/** @scrutinizer ignore-unused */ Request $request): Respon
             'modulelist' => $this->getModuleList(),
         ];
 
+        $eventDispatcher = ModuleEventDispatcherFactory::getInstance();
+        /** @var CronEvent $event */
+        $event = $eventDispatcher->dispatch(new ConfigPageEvent($t));
+        $t = $event->getTemplate();
         Module::callHooks('configpage', $t);
         $this->menu->addOption('logout', $this->authUtils->getAdminLogoutURL(), Translate::noop('Log out'));
         return $this->menu->insert($t);
@@ -398,8 +405,25 @@ protected function getPrerequisiteChecks(): array
 
 
         // Add module specific checks via the sanitycheck hook that a module can provide.
+        $eventDispatcher = ModuleEventDispatcherFactory::getInstance();
+        /** @var SanityCheckEvent $event */
+        $event = $eventDispatcher->dispatch(new SanityCheckEvent());
+        
         $hookinfo = [ 'info' => [], 'errors' => [] ];
         Module::callHooks('sanitycheck', $hookinfo);
+
+        // Merge results from the event into $hookinfo. Can be removed when hook infrastructure is removed.
+        $hookinfo = [
+            'info' => array_merge(
+                $event->getInfo(),
+                $hookinfo['info'],
+            ),
+            'errors' => array_merge(
+                $event->getErrors(),
+                $hookinfo['errors'],
+            ),
+        ];
+
         foreach (['info', 'errors'] as $resulttype) {
             foreach ($hookinfo[$resulttype] as $result) {
                 $matrix[] = [

modules/admin/src/Controller/Config.php

@@ -8,6 +8,7 @@
 use SimpleSAML\Assert\Assert;
 use SimpleSAML\Auth;
 use SimpleSAML\Configuration;
+use SimpleSAML\Event\Dispatcher\ModuleEventDispatcherFactory;
 use SimpleSAML\Locale\Translate;
 use SimpleSAML\Logger;
 use SimpleSAML\Metadata\MetaDataStorageHandler;
@@ -16,6 +17,7 @@
 use SimpleSAML\Metadata\Signer;
 use SimpleSAML\Module;
 use SimpleSAML\Module\adfs\IdP\ADFS as ADFS_IdP;
+use SimpleSAML\Module\admin\Event\FederationPageEvent;
 use SimpleSAML\Module\saml\IdP\SAML2 as SAML2_IdP;
 use SimpleSAML\SAML2\Constants as C;
 use SimpleSAML\SAML2\Exception\ArrayValidationException;
@@ -27,6 +29,7 @@
 use Symfony\Component\HttpFoundation\ResponseHeaderBag;
 use Symfony\Component\VarExporter\VarExporter;
 
+
 use function array_merge;
 use function array_pop;
 use function array_values;
@@ -190,6 +193,11 @@ public function main(/** @scrutinizer ignore-unused */ Request $request): Respon
             'logouturl' => $this->authUtils->getAdminLogoutURL(),
         ];
 
+        $eventDispatcher = ModuleEventDispatcherFactory::getInstance();
+        /** @var FederationPageEvent $event */
+        $event = $eventDispatcher->dispatch(new FederationPageEvent($t));
+        $t = $event->getTemplate();
+
         Module::callHooks('federationpage', $t);
         Assert::isInstanceOf($t, Template::class);
 

modules/admin/src/Controller/Federation.php

@@ -5,8 +5,10 @@
 namespace SimpleSAML\Module\admin\Controller;
 
 use SimpleSAML\Assert\Assert;
+use SimpleSAML\Event\Dispatcher\ModuleEventDispatcherFactory;
 use SimpleSAML\Locale\Translate;
 use SimpleSAML\Module;
+use SimpleSAML\Module\admin\Event\AdminMenuEvent;
 use SimpleSAML\XHTML\Template;
 
 /**
@@ -92,6 +94,10 @@ public function addOption(string $id, string $url, string $name): void
     public function insert(Template $template): Template
     {
         $template->data['menu'] = $this->options;
+        $eventDispatcher = ModuleEventDispatcherFactory::getInstance();
+        /** @var AdminMenuEvent $event */
+        $event = $eventDispatcher->dispatch(new AdminMenuEvent($template));
+        $template = $event->getTemplate();
         Module::callHooks('adminmenu', $template);
 
         Assert::isInstanceOf($template, Template::class);

modules/admin/src/Controller/Menu.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Module\admin\Event;
+
+use SimpleSAML\XHTML;
+
+class AdminMenuEvent
+{
+    private XHTML\Template $template;
+
+    public function __construct(XHTML\Template $template)
+    {
+        $this->template = $template;
+    }
+
+    public function getTemplate(): XHTML\Template
+    {
+        return $this->template;
+    }
+}

modules/admin/src/Event/AdminMenuEvent.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Module\admin\Event;
+
+use SimpleSAML\XHTML;
+
+class ConfigPageEvent
+{
+    public function __construct(
+        private readonly XHTML\Template $template,
+    )
+    {}
+
+    public function getTemplate(): XHTML\Template
+    {
+        return $this->template;
+    }
+}

modules/admin/src/Event/ConfigPageEvent.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Module\admin\Event;
+
+use SimpleSAML\XHTML;
+
+class FederationPageEvent
+{
+    public function __construct(
+        private readonly XHTML\Template $template,
+    ) {}
+
+    public function getTemplate(): XHTML\Template
+    {
+        return $this->template;
+    }
+}

modules/admin/src/Event/FederationPageEvent.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Module\admin\Event;
+
+class SanityCheckEvent
+{
+    private array $info = [];
+    private array $errors = [];
+
+    public function __construct() {
+    }
+
+    public function addInfo(string $message): void
+    {
+        $this->info[] = $message;
+    }
+
+    public function addError(string $message): void
+    {
+        $this->errors[] = $message;
+    }
+
+    public function getInfo(): array
+    {
+        return $this->info;
+    }
+
+    public function getErrors(): array
+    {
+        return $this->errors;
+    }
+}