Merge pull request #112 from catalyst/18235-resotre-duplicate-fail

Issue #110: Fix restore not correctly finding CMS type.

Author: marcusboon

backup/moodle2/restore_cms_stepslib.php

@@ -89,12 +89,13 @@ protected function process_cms_types(array $data) {
 
         $typeid = $this->find_existing_cms_type($data);
 
+        // TODO: Ignoring a missing CMS type currently causes a crash during the restore process.
         if ($typeid === false) {
-            $typeid = $DB->insert_record('cms_types', $data);
+            throw new moodle_exception('CMS type not found for idnumber ' . $data->idnumber);
         }
 
+        // If we can find a type ID, we can restore the mapping.
         $this->set_mapping('cms_types', $oldid, $typeid, true);
-
         $DB->update_record('cms', (object) ['id' => $this->get_new_parentid('cms'), 'typeid' => $typeid]);
     }
 
@@ -111,33 +112,8 @@ protected function find_existing_cms_type(\stdClass $data) {
             return $typeid;
         }
 
-        if ($this->task->is_samesite()) {
-            if ($DB->record_exists('cms_types', ['id' => $data->id])) {
-                return $data->id;
-            }
-        }
-
-        // Try to find a CMS type is that is a match for content. Returns false if none found.
-        $sqltitlemustache = $DB->sql_compare_text('title_mustache');
-        $sqltitlemustacheparam = $DB->sql_compare_text(':title_mustache');
-        $sqlmustache = $DB->sql_compare_text('mustache');
-        $sqlmustacheparam = $DB->sql_compare_text(':mustache');
-
-        $sql = "SELECT id
-                  FROM {cms_types}
-                 WHERE name = :name
-                   AND idnumber = :idnumber
-                   AND datasources = :datasources
-                   AND $sqltitlemustache = $sqltitlemustacheparam
-                   AND $sqlmustache = $sqlmustacheparam";
-        $params = [
-            'name' => $data->name,
-            'idnumber' => $data->idnumber,
-            'datasources' => $data->datasources,
-            'title_mustache' => $data->title_mustache,
-            'mustache' => $data->mustache,
-        ];
-        $record = $DB->get_record_sql($sql, $params);
+        // Try to find a CMS type that matches idnumber. Returns false if none found.
+        $record = $DB->get_record('cms_types', ['idnumber' => $data->idnumber]);
 
         return $record->id ?? false;
     }

classes/customfield/cms_restore.php

@@ -56,7 +56,5 @@ public function cms_restore_instance_data_from_backup(\restore_task $task, array
                 return $d->get('id');
             }
         }
-        // Should not get here.
-        throw new \moodle_exception("Bad shorname {$data['shortname']}, and type {$data['type']}");
     }
 }

tests/datasource_fields_test.php

@@ -329,5 +329,8 @@ public function test_duplicate() {
         $newds = new dsfields($newcms);
 
         $this->assertEquals($ds->get_data(), $newds->get_data());
+
+        // Assert that the CMS type is not duplicated.
+        $this->assertEquals($cms->get('typeid'), $newcms->get('typeid'));
     }
 }

tests/datasource_images_test.php

@@ -183,5 +183,8 @@ public function test_duplicate() {
         $newds = new dsimages($newcms);
 
         $this->assertEquals($ds->get_data(), $newds->get_data());
+
+        // Assert that the CMS type is not duplicated.
+        $this->assertEquals($cms->get('typeid'), $newcms->get('typeid'));
     }
 }

tests/datasource_roles_test.php

@@ -311,5 +311,8 @@ public function test_duplicate() {
         $newds = new dsroles($newcms);
 
         $this->assertEquals($ds->get_data(), $newds->get_data());
+
+        // Assert that the CMS type is not duplicated.
+        $this->assertEquals($cms->get('typeid'), $newcms->get('typeid'));
     }
 }

tests/datasource_userlist_test.php

@@ -375,5 +375,8 @@ public function test_duplicate() {
         $newds = new dsuserlist($newcms);
 
         $this->assertEquals($ds->get_data(), $newds->get_data());
+
+        // Assert that the CMS type is not duplicated.
+        $this->assertEquals($cms->get('typeid'), $newcms->get('typeid'));
     }
 }