Merge branch 'MDL-85816-main' of https://github.com/andrewnicols/moodle

config-dist.php

@@ -164,6 +164,12 @@ $CFG->dboptions = array(
 
 $CFG->wwwroot   = 'http://example.com/moodle';
 
+// Generally it is not advisable to use a wwwroot that ends in 'public'.
+// This is because the 'public' directory is used to serve web-accessible content.
+// Moodle looks for any URL which ends in 'public' and assumes that it is a misconfiguration.
+// In the event that there is a need to have a wwwroot that ends in 'public', the
+// following setting can be used to override this check.
+$CFG->wwwrootendsinpublic = false;
 
 //=========================================================================
 // 3. DATA FILES LOCATION

public/lang/en/error.php

@@ -648,6 +648,7 @@ $string['wrongusernamepassword'] = 'Wrong user/password';
 $string['wrongzipfilename'] = 'Wrong ZIP file name';
 $string['wscouldnotcreateecoursenopermission'] = 'WS - Could not create course - No permission';
 $string['wwwrootmismatch'] = 'Incorrect access detected, this server may be accessed only through "{$a}" address, sorry.<br />Please notify server administrator.';
+$string['wwwrootpublic'] = 'Detected incorrect $CFG->wwwroot in config.php, it should not end in /public. See MDL-85816 for further information.';
 $string['wwwrootslash'] = 'Detected incorrect $CFG->wwwroot in config.php, it must not contain trailing slash.<br />Please notify server administrator.';
 $string['xmldberror'] = 'XMLDB error!';
 $string['alreadyloggedin'] = 'You are already logged in as {$a}, you need to log out before logging in as different user.';

public/lib/classes/setup.php

@@ -0,0 +1,83 @@
+<?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 core;
+
+use core\exception\moodle_exception;
+
+/**
+ * Core setup functionality for Moodle.
+ *
+ * @package    core
+ * @copyright  Andrew Lyons <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class setup {
+    /**
+     * Check the validity of the wwwroot, throwing a Moodle exception if invalid.
+     *
+     * @throws moodle_exception
+     * @return true
+     */
+    public function validate_wwwroot(): bool {
+        if ($this->does_wwwroot_end_in_slash()) {
+            // The wwwroot should not end in a slash as this may suggest a misconfiguration.
+            throw new moodle_exception('wwwrootslash', 'error');
+        }
+
+        if (!$this->can_wwwroot_end_in_public() && $this->does_wwwroot_end_in_public()) {
+            // The wwwroot should not end in /public as this may suggest a misconfiguration.
+            // There may be legitimate sites out there that currently do this but it is not recommended.
+            // Where a site _does_ need to do this, then they can set the $CFG->wwwrootendsinpublic var to true.
+            throw new moodle_exception('wwwrootpublic', 'error');
+        }
+
+        return true;
+    }
+
+    /**
+     * Whether the wwwroot is allowed to end in public.
+     *
+     * @return bool
+     */
+    protected function can_wwwroot_end_in_public(): bool {
+        global $CFG;
+
+        return property_exists($CFG, 'wwwrootendsinpublic') && $CFG->wwwrootendsinpublic;
+    }
+
+    /**
+     * Detect whether the wwwroot ends in /public.
+     *
+     * @return bool
+     */
+    protected function does_wwwroot_end_in_public(): bool {
+        global $CFG;
+
+        return substr($CFG->wwwroot, -7) == '/public';
+    }
+
+    /**
+     * Detect whether the wwwroot ends in /.
+     *
+     * @return bool
+     */
+    protected function does_wwwroot_end_in_slash(): bool {
+        global $CFG;
+
+        return str_ends_with($CFG->wwwroot, '/');
+    }
+}

public/lib/setuplib.php

@@ -634,10 +634,10 @@ function hash_local_config_cache() {
 function initialise_fullme() {
     global $CFG, $FULLME, $ME, $SCRIPT, $FULLSCRIPT;
 
-    // Detect common config error.
-    if (substr($CFG->wwwroot, -1) == '/') {
-        throw new \moodle_exception('wwwrootslash', 'error');
-    }
+    $setuphelper = \core\di::get(\core\setup::class);
+
+    // Detect common config errors in the wwwroot.
+    $setuphelper->validate_wwwroot();
 
     if (CLI_SCRIPT) {
         initialise_fullme_cli();

public/lib/tests/setup_test.php

@@ -0,0 +1,110 @@
+<?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 core;
+
+/**
+ * Tests for the \core\setup class.
+ *
+ * @package    core
+ * @category   test
+ * @copyright  Andrew Lyons <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+#[\PHPUnit\Framework\Attributes\CoversClass(\core\setup::class)]
+final class setup_test extends \advanced_testcase {
+    #[\PHPUnit\Framework\Attributes\DataProvider('wwwroot_validity_provider')]
+    public function test_wwwroot_ends_in_slash(
+        string $wwwroot,
+        bool $mayendinpublic,
+        bool $valid,
+        ?string $exceptionstring = null,
+    ): void {
+        global $CFG;
+
+        $this->resetAfterTest(true);
+        $CFG->wwwroot = $wwwroot;
+        $CFG->wwwrootendsinpublic = $mayendinpublic;
+
+        if (!$valid) {
+            $this->expectException(\core\exception\moodle_exception::class);
+            $this->expectExceptionMessage($exceptionstring);
+        }
+
+        $this->assertTrue(di::get(setup::class)->validate_wwwroot());
+    }
+
+    /**
+     * Data provider for test_wwwroot_ends_in_slash.
+     *
+     * @return \Generator
+     */
+    public static function wwwroot_validity_provider(): \Generator {
+        foreach (['https', 'http'] as $protocol) {
+            yield "Valid {$protocol} wwwroot on root domain" => [
+                "{$protocol}://example.com",
+                false,
+                true,
+            ];
+
+            yield "Valid {$protocol} wwwroot on sub domain" => [
+                "{$protocol}://moodle.example.com",
+                false,
+                true,
+            ];
+
+            yield "Valid {$protocol} wwwroot on directory" => [
+                "{$protocol}://example.com/moodle",
+                false,
+                true,
+            ];
+        }
+
+        yield "Root domain ends in slash" => [
+            "https://example.com/",
+            false,
+            false,
+            get_string('wwwrootslash', 'error'),
+        ];
+
+        yield "Sub domain ends in slash" => [
+            "https://moodle.example.com/",
+            false,
+            false,
+            get_string('wwwrootslash', 'error'),
+        ];
+
+        yield "Directory ends in slash" => [
+            "https://example.com/moodle/",
+            false,
+            false,
+            get_string('wwwrootslash', 'error'),
+        ];
+
+        yield "Directory ends in public and should not" => [
+            "https://example.com/public",
+            false,
+            false,
+            get_string('wwwrootpublic', 'error'),
+        ];
+
+        yield "Directory ends in public and is allowed to" => [
+            "https://example.com/public",
+            true,
+            true,
+        ];
+    }
+}