MDL-65555 mod_lesson: fix group override backup and restore
authorNathan Nguyen <nathannguyen@catalyst-au.net>
Mon, 24 Jun 2019 06:19:44 +0000 (16:19 +1000)
committerNathan Nguyen <nathannguyen@catalyst-au.net>
Tue, 16 Jul 2019 01:16:03 +0000 (11:16 +1000)
mod/lesson/backup/moodle2/backup_lesson_stepslib.php
mod/lesson/backup/moodle2/restore_lesson_stepslib.php
mod/lesson/db/upgrade.php
mod/lesson/tests/restore_override_test.php [new file with mode: 0644]
mod/lesson/version.php

index 11b5f0a..1991ac3 100644 (file)
@@ -180,6 +180,12 @@ class backup_lesson_activity_structure_step extends backup_activity_structure_st
             $overrideparams['userid'] = backup_helper::is_sqlparam(null); //  Without userinfo, skip user overrides.
         }
 
+        // Skip group overrides if not including groups.
+        $groupinfo = $this->get_setting_value('groups');
+        if (!$groupinfo) {
+            $overrideparams['groupid'] = backup_helper::is_sqlparam(null);
+        }
+
         $override->set_source_table('lesson_overrides', $overrideparams);
 
         // Annotate the user id's where required.
index 5cefa64..3e06f75 100644 (file)
@@ -220,6 +220,11 @@ class restore_lesson_activity_structure_step extends restore_activity_structure_
             $data->groupid = $this->get_mappingid('group', $data->groupid);
         }
 
+        // Skip if there is no user and no group data.
+        if (empty($data->userid) && empty($data->groupid)) {
+            return;
+        }
+
         $data->available = $this->apply_date_offset($data->available);
         $data->deadline = $this->apply_date_offset($data->deadline);
 
index 3d24f04..6f06a9a 100644 (file)
@@ -101,6 +101,13 @@ function xmldb_lesson_upgrade($oldversion) {
         upgrade_mod_savepoint(true, 2017051501, 'lesson');
     }
 
+    if ($oldversion < 2019062400) {
+        // Delete orphaned group overrides.
+        $DB->delete_records_select('lesson_overrides', 'groupid = 0 AND userid IS NULL');
+
+        upgrade_mod_savepoint(true, 2019062400, 'lesson');
+    }
+
     // Automatically generated Moodle v3.4.0 release upgrade line.
     // Put any upgrade step following this.
 
diff --git a/mod/lesson/tests/restore_override_test.php b/mod/lesson/tests/restore_override_test.php
new file mode 100644 (file)
index 0000000..b3ff0c6
--- /dev/null
@@ -0,0 +1,105 @@
+<?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/>.
+
+/**
+ * Restore override tests.
+ *
+ * @package    mod_lesson
+ * @author   2019 Nathan Nguyen <nathannguyen@catalyst-au.net>
+ * @copyright Catalyst IT
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once($CFG->libdir . "/phpunit/classes/restore_date_testcase.php");
+/**
+ * Restore override tests.
+ *
+ * @package    mod_lesson
+ * @author   2019 Nathan Nguyen <nathannguyen@catalyst-au.net>
+ * @copyright Catalyst IT
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class mod_lesson_restore_override_testcase extends restore_date_testcase {
+
+    /**
+     * Test restore overrides.
+     */
+    public function test_restore_overrides() {
+        global $DB, $USER;
+        $this->resetAfterTest();
+
+        $course = $this->getDataGenerator()->create_course();
+        $lessongen = $this->getDataGenerator()->get_plugin_generator('mod_lesson');
+        $lesson = $lessongen->create_instance(['course' => $course->id]);
+
+        $group1 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
+        $group2 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
+
+        $now = 100;
+        $groupoverride1 = (object)[
+            'lessonid' => $lesson->id,
+            'groupid' => $group1->id,
+            'available' => $now,
+            'deadline' => $now + 20
+        ];
+        $DB->insert_record('lesson_overrides', $groupoverride1);
+
+        $groupoverride2 = (object)[
+            'lessonid' => $lesson->id,
+            'groupid' => $group2->id,
+            'available' => $now,
+            'deadline' => $now + 40
+        ];
+        $DB->insert_record('lesson_overrides', $groupoverride2);
+
+        // Current quiz overrides.
+        $overrides = $DB->get_records('lesson_overrides', ['lessonid' => $lesson->id]);
+        $this->assertEquals(2, count($overrides));
+
+        // User override.
+        $useroverride = (object)[
+            'lessonid' => $lesson->id,
+            'userid' => $USER->id,
+            'sortorder' => 1,
+            'available' => 100,
+            'deadline' => 200
+        ];
+        $DB->insert_record('lesson_overrides', $useroverride);
+
+        // Current quiz overrides.
+        $overrides = $DB->get_records('lesson_overrides', ['lessonid' => $lesson->id]);
+        $this->assertEquals(3, count($overrides));
+
+        // Back up and restore including group info and user info.
+        set_config('backup_general_groups', 1, 'backup');
+        $newcourseid = $this->backup_and_restore($course);
+        $newquiz = $DB->get_record('lesson', ['course' => $newcourseid]);
+        $overrides = $DB->get_records('lesson_overrides', ['lessonid' => $newquiz->id]);
+        // 2 groups overrides and 1 user override.
+        $this->assertEquals(3, count($overrides));
+
+        // Back up and restore with user info and without group info.
+        set_config('backup_general_groups', 0, 'backup');
+        $newcourseid = $this->backup_and_restore($course);
+        $newquiz = $DB->get_record('lesson', ['course' => $newcourseid]);
+        $overrides = $DB->get_records('lesson_overrides', ['lessonid' => $newquiz->id]);
+        // 1 user override.
+        $this->assertEquals(1, count($overrides));
+    }
+}
index 217f678..98445d9 100644 (file)
@@ -24,7 +24,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version   = 2019052000;     // The current module version (Date: YYYYMMDDXX)
+$plugin->version   = 2019062400;     // The current module version (Date: YYYYMMDDXX)
 $plugin->requires  = 2019051100;    // Requires this Moodle version
 $plugin->component = 'mod_lesson'; // Full name of the plugin (used for diagnostics)
 $plugin->cron      = 0;