Merge pull request #839 from dravek/issue838

Migrate after_config hook callback

Author: danmarsden

classes/local/hooks/after_config.php

@@ -0,0 +1,55 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle 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 General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace auth_saml2\local\hooks;
+
+/**
+ * after_config hook callback for auth_saml2
+ *
+ * @package    auth_saml2
+ * @copyright  2024 David Carrillo <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class after_config {
+    /**
+     * Callback executed from setup.php, available from Moodle 3.8 in core
+     *
+     * @param \core\hook\after_config $hook
+     */
+    public static function callback(\core\hook\after_config $hook): void {
+        global $CFG;
+
+        if (during_initial_install() || isset($CFG->upgraderunning)) {
+            // Do nothing during installation or upgrade.
+            return;
+        }
+
+        try {
+            $saml = optional_param('saml', null, PARAM_BOOL);
+            if ($saml == 1) {
+                if (isguestuser()) {
+                    // We want to force users to log in with a real account, so log guest users out.
+                    require_logout();
+                }
+                // We have the saml=on param set. Disable guest access (in memory -
+                // not saved in database) to force the login with saml for this request.
+                unset($CFG->autologinguests);
+            }
+        } catch (\Exception $exception) {
+            debugging('auth_saml2_after_config error', DEBUG_DEVELOPER, $exception->getTrace());
+        }
+    }
+}

db/hooks.php

@@ -30,4 +30,9 @@
         'callback' => 'auth_saml2\local\hooks\output\before_http_headers::callback',
         'priority' => 0,
     ],
+    [
+        'hook' => \core\hook\after_config::class,
+        'callback' => 'auth_saml2\local\hooks\after_config::callback',
+        'priority' => 0,
+    ],
 ];

lib.php

@@ -25,6 +25,10 @@
 /**
  * Check if we have the saml=on param set. If so, disable guest access and force the user to log in with saml.
  *
+ * This is an implementation of a legacy callback that will only be called in older Moodle versions.
+ * It will not be called in Moodle 4.5+ that contain the hook core\hook\after_config,
+ * instead, the callback auth_saml2\local\hooks\after_config::callback will be executed.
+ *
  * @since  Moodle 3.8
  * @return void
  */