MBS-10194: Make task more resilient to wrong course values in DB

Author: sh-csg

classes/cachemanager.php

@@ -73,13 +73,14 @@ public static function build_backlink_cache(int $courseid = 0) {
 
         $records = $DB->get_recordset('learningmap', $conditions, '', 'id, placestore, backlink, course');
         foreach ($records as $record) {
+            // If course does not exist for some reason, avoid running into errors and try to fix record.
+            if (!$DB->record_exists('course', ['id' => $record->course])) {
+                helper::repair_learningmap_record($record->id);
+                continue;
+            }
             $modinfo = get_fast_modinfo($record->course);
             $module = $modinfo->instances['learningmap'][$record->id];
             $placestore = json_decode($record->placestore);
-            // If course does not exist for some reason, avoid running into errors.
-            if (!$DB->record_exists('course', ['id' => $module->course])) {
-                continue;
-            }
             $coursepageurl = course_get_format($module->course)->get_view_url($module->sectionnum);
             $coursepageurl->set_anchor('module-' . $module->id);
             foreach ($placestore->places as $place) {

classes/helper.php

@@ -39,4 +39,54 @@ public static function show_map_on_course_page($cm): bool {
         $courseformat = $course->format;
         return !empty($showmaponcoursepage) && $courseformat !== 'learningmap';
     }
+
+    /**
+     * Repairs a learning map record by checking if the course exists and updating the record accordingly.
+     *
+     * @param int $learningmapid The ID of the learning map record to repair.
+     * @return void
+     */
+    public static function repair_learningmap_record(int $learningmapid): void {
+        global $DB;
+
+        // Check if the learningmap record exists.
+        if (!$DB->record_exists('learningmap', ['id' => $learningmapid])) {
+            return;
+        }
+
+        // Attempt to repair the learning map record.
+        $record = $DB->get_record('learningmap', ['id' => $learningmapid], '*', MUST_EXIST);
+
+        if (!$DB->record_exists('course', ['id' => $record->course])) {
+            // If the course does not exist, try to find the course from the course module.
+            if (!PHPUNIT_TEST) {
+                mtrace("Course with id {$record->course} does not exist, trying to find it from course module.");
+            }
+            $moduleid = $DB->get_field('modules', 'id', ['name' => 'learningmap']);
+            if ($moduleid) {
+                $courseid = $DB->get_field('course_modules', 'course', ['module' => $moduleid, 'instance' => $record->id]);
+                if ($courseid) {
+                    if ($DB->record_exists('course', ['id' => $courseid])) {
+                        if (!PHPUNIT_TEST) {
+                            mtrace("Updating learning map record to course id {$courseid}.");
+                        }
+                        $record->course = $courseid;
+                        $record->timemodified = time();
+                        $DB->update_record('learningmap', $record);
+                    } else {
+                        if (!PHPUNIT_TEST) {
+                            mtrace(
+                                "Course with id {$courseid} does not exist, learning " .
+                                "map {$record->id} is an orphaned course module."
+                            );
+                        }
+                    }
+                } else {
+                    if (!PHPUNIT_TEST) {
+                        mtrace("No course module found, learning map with id {$record->id} is an orphaned instance.");
+                    }
+                }
+            }
+        }
+    }
 }

tests/mod_learningmap_helper_test.php

@@ -0,0 +1,65 @@
+<?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 mod_learningmap;
+
+/**
+ * Tests for Learning map helper class
+ *
+ * @package    mod_learningmap
+ * @category   test
+ * @copyright  2025 ISB Bayern
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+#[\PHPUnit\Framework\Attributes\CoversClass(helper::class)]
+#[\PHPUnit\Framework\Attributes\CoversMethod(helper::class, 'repair_learningmap_record')]
+final class mod_learningmap_helper_test extends \advanced_testcase {
+    /**
+     * Tests the repair_learningmap_record method.
+     *
+     * @return void
+     */
+    public function test_repair_learningmap_record(): void {
+        global $DB;
+        $this->resetAfterTest();
+        $this->setAdminUser();
+        $course = $this->getDataGenerator()->create_course();
+        $learningmapid = $this->getDataGenerator()->create_module('learningmap', ['course' => $course->id])->id;
+
+        $recordbefore = $DB->get_record('learningmap', ['id' => $learningmapid], '*', MUST_EXIST);
+        helper::repair_learningmap_record($learningmapid);
+        $recordafter = $DB->get_record('learningmap', ['id' => $learningmapid], '*', MUST_EXIST);
+        $this->assertEquals($recordbefore->course, $recordafter->course, 'The learning map record should not have changed.');
+
+        $DB->update_record('learningmap', ['id' => $learningmapid, 'course' => -1]);
+        helper::repair_learningmap_record($learningmapid);
+        $recordafter = $DB->get_record('learningmap', ['id' => $learningmapid], '*', MUST_EXIST);
+        $this->assertEquals(
+            $course->id,
+            $recordafter->course,
+            'The course id should have been updated in the learning map record.'
+        );
+
+        $DB->delete_records('course', ['id' => $course->id]);
+        helper::repair_learningmap_record($learningmapid);
+        $recordafter = $DB->get_record('learningmap', ['id' => $learningmapid], '*', MUST_EXIST);
+        $this->assertEquals(
+            $recordbefore->course,
+            $recordafter->course,
+            'The learning map record should not have changed after trying to repair it with a non-existing course.'
+        );
+    }
+}