Merge pull request #25 from catalyst/fix-ci-issues-#20

bwalkerl · web-flow · commit cac4ce2eb47e · 2025-08-15T15:16:45.000+10:00
Fix CI and autoload issues
diff --git a/classes/local/hook/output/before_standard_head_html_generation.php b/classes/local/hook/output/before_standard_head_html_generation.php
@@ -16,6 +16,8 @@
 
 namespace tool_seo\local\hook\output;
 
+use tool_seo\local\seo;
+
 /**
  * Allows plugins to add any elements to the page <head> html tag
  *
@@ -29,15 +31,13 @@ class before_standard_head_html_generation {
     /**
      * Callback that adds a custom html header tag to each page.
      *
-     * @param \core\hook\output\standard_head_html_prepend $hook
+     * @param \core\hook\output\before_standard_head_html_generation $hook
      */
     public static function callback(\core\hook\output\before_standard_head_html_generation $hook): void {
-        global $PAGE, $CFG;
-
-        require_once($CFG->dirroot . '/admin/tool/seo/lib.php');
+        global $PAGE;
 
         // If URL should not be indexed, add the noindex meta tag to page.
-        if (tool_seo_is_url_indexable($PAGE->url->get_path()) == false) {
+        if (!seo::is_url_indexable($PAGE->url->get_path())) {
             $hook->add_html('<meta name="robots" content="noindex, nofollow" />');
         }
     }
diff --git a/classes/local/seo.php b/classes/local/seo.php
@@ -0,0 +1,68 @@
+<?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 tool_seo\local;
+
+use dml_exception;
+
+/**
+ * SEO utils class.
+ *
+ * @package    tool_seo
+ * @author     Andrew Madden <andrewmadden@catalyst-au.net>
+ * @copyright  2019 Catalyst IT
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class seo {
+    /**
+     * Checks whether the current URL is listed in the URLs to not be indexed in admin tools.
+     *
+     * @param string $currentpath The path component of the current URL to compare against.
+     * @return bool Returns true if the URL should be indexable by search engines.
+     */
+    public static function is_url_indexable($currentpath): bool {
+
+        // Get the list of URLs to be excluded from the admin settings.
+        try {
+            $nonindexableurlstring = get_config('tool_seo', 'nonindexable');
+        } catch (dml_exception $e) {
+            return true;
+        }
+
+        $nonindexableurls = array_map('trim', explode(PHP_EOL, $nonindexableurlstring));
+
+        $currentpathliteral = preg_quote($currentpath, '/');
+
+        foreach ($nonindexableurls as $nonindexableurl) {
+            // If the url is empty, ignore.
+            if ($nonindexableurl == '') {
+                continue;
+            }
+
+            // Checks if a non-indexable url is part of the current path.
+            if (strpos($currentpath, $nonindexableurl) !== false) {
+                return false;
+            }
+
+            // Checks if the current path is a slug of the non-indexable url.
+            if (preg_match("/^.*$currentpathliteral$/", $nonindexableurl)) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+}
diff --git a/classes/privacy/provider.php b/classes/privacy/provider.php
@@ -40,7 +40,7 @@ class provider implements \core_privacy\local\metadata\null_provider {
      *
      * @return  string
      */
-    public static function get_reason() : string {
+    public static function get_reason(): string {
         return 'privacy:metadata';
     }
 }
diff --git a/lang/en/tool_seo.php b/lang/en/tool_seo.php
@@ -23,14 +23,9 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-$string['pluginname'] = 'SEO';
-
-// Settings.
 $string['nonindexable'] = 'Include URLs not to be indexed by search engines.';
 $string['nonindexable_help'] = 'List of URLs that will not be indexed and profiled by search engines. Enter each URL on a new line.';
+$string['pluginname'] = 'SEO';
+$string['privacy:metadata'] = 'The SEO plugin does not store any personal data.';
 $string['robotstxt'] = 'robots.txt';
 $string['robotstxt_help'] = 'The raw robots.txt file can be entered here. For this to work you must have Moodle setup to handle error pages.';
-
-// Privacy.
-$string['privacy:metadata'] = 'The SEO plugin does not store any personal data.';
-
diff --git a/lib.php b/lib.php
@@ -21,11 +21,10 @@
  * @copyright  2019 Andrew Madden <andrewmadden@catalyst-au.net>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
+use tool_seo\local\seo;
 
 defined('MOODLE_INTERNAL') || die();
 
-require_once(__DIR__ . '/locallib.php');
-
 /**
  * Callback that adds a custom html header tag to each page.
  *
@@ -36,7 +35,7 @@ function tool_seo_before_standard_html_head() {
     global $PAGE;
 
     // If URL should not be indexed, add the noindex meta tag to page.
-    if (tool_seo_is_url_indexable($PAGE->url->get_path()) == false) {
+    if (!seo::is_url_indexable($PAGE->url->get_path())) {
         return '<meta name="robots" content="noindex, nofollow" />';
     }
 
diff --git a/locallib.php b/locallib.php
diff --git a/tests/noindex_test.php b/tests/noindex_test.php
@@ -25,6 +25,8 @@
 
 namespace tool_seo;
 
+use tool_seo\local\seo;
+
 /**
  * Test case class for the noindex tool.
  *
@@ -33,8 +35,11 @@
  * @copyright  2019 Catalyst IT
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class noindex_test extends \advanced_testcase {
+final class noindex_test extends \advanced_testcase {
 
+    /**
+     * Sets up test.
+     */
     protected function setUp(): void {
         parent::setUp();
         // Set up non-indexable array in config.
@@ -53,13 +58,11 @@ protected function setUp(): void {
      * @dataProvider get_noindex_url_testcases
      * @param string $url A URL path representing a moodle page url.
      * @param bool $expected True if the URL should be indexable.
+     * @covers \tool_seo\local\seo::is_url_indexable
      */
-    public function test_nonindexable_url_configuration($url, $expected) {
+    public function test_nonindexable_url_configuration($url, $expected): void {
         $this->resetAfterTest(true);
-
-        require_once(__DIR__ . '/../locallib.php');
-        $result = tool_seo_is_url_indexable($url);
-
+        $result = seo::is_url_indexable($url);
         $this->assertEquals($expected, $result);
     }
 
@@ -69,14 +72,12 @@ public function test_nonindexable_url_configuration($url, $expected) {
      * @dataProvider get_noindex_url_testcases
      * @param string $url A URL path representing a moodle page url.
      * @param bool $expected True if the URL should be indexable.
+     * @covers \tool_seo\local\seo::is_url_indexable
      */
-    public function test_empty_configuration($url, $expected) {
+    public function test_empty_configuration($url, $expected): void {
         $this->resetAfterTest(true);
         set_config('nonindexable', "", 'tool_seo');
-
-        require_once(__DIR__ . '/../locallib.php');
-        $result = tool_seo_is_url_indexable($url);
-
+        $result = seo::is_url_indexable($url);
         $this->assertTrue($result);
     }
 
@@ -85,7 +86,7 @@ public function test_empty_configuration($url, $expected) {
      *
      * @return array
      */
-    public function get_noindex_url_testcases() {
+    public static function get_noindex_url_testcases(): array {
         return [
             // Exact matches.
             'Login URL' => ['/login/index.php', false],
diff --git a/version.php b/version.php
@@ -24,9 +24,9 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version = 2024021902;
-$plugin->release = 2024021902; // Match release exactly to version.
+$plugin->version = 2024021903;
+$plugin->release = 2024021903; // Match release exactly to version.
 $plugin->requires = 2022112800; // Moodle 4.1.
 $plugin->component = 'tool_seo';
 $plugin->maturity  = MATURITY_STABLE;
-$plugin->supported = [401, 403];     // Supports Moodle 4.1 or later.
+$plugin->supported = [401, 404];     // Supports Moodle 4.1 or later.

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,8 @@`
`16`	`16`
`17`	`17`	`namespace tool_seo\local\hook\output;`
`18`	`18`
	`19`	`+use tool_seo\local\seo;`
	`20`	`+`
`19`	`21`	`/**`
`20`	`22`	`* Allows plugins to add any elements to the page <head> html tag`
`21`	`23`	`*`
`@@ -29,15 +31,13 @@ class before_standard_head_html_generation {`
`29`	`31`	`/**`
`30`	`32`	`* Callback that adds a custom html header tag to each page.`
`31`	`33`	`*`
`32`		`- * @param \core\hook\output\standard_head_html_prepend $hook`
	`34`	`+ * @param \core\hook\output\before_standard_head_html_generation $hook`
`33`	`35`	`*/`
`34`	`36`	`public static function callback(\core\hook\output\before_standard_head_html_generation $hook): void {`
`35`		`- global $PAGE, $CFG;`
`36`		`-`
`37`		`- require_once($CFG->dirroot . '/admin/tool/seo/lib.php');`
	`37`	`+ global $PAGE;`
`38`	`38`
`39`	`39`	`// If URL should not be indexed, add the noindex meta tag to page.`
`40`		`- if (tool_seo_is_url_indexable($PAGE->url->get_path()) == false) {`
	`40`	`+ if (!seo::is_url_indexable($PAGE->url->get_path())) {`
`41`	`41`	`$hook->add_html('<meta name="robots" content="noindex, nofollow" />');`
`42`	`42`	`}`
`43`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ class provider implements \core_privacy\local\metadata\null_provider {`
`40`	`40`	`*`
`41`	`41`	`* @return string`
`42`	`42`	`*/`
`43`		`- public static function get_reason() : string {`
	`43`	`+ public static function get_reason(): string {`
`44`	`44`	`return 'privacy:metadata';`
`45`	`45`	`}`
`46`	`46`	`}`