L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-86817 qbank: Prevent unique key violations during migration

Browse Source 
When fixing categories with broken parents, if the resulting changes
would have led to categories with the same stamp or idnumber being in
the same context, the task failed due to violations of the unique keys
on contextid-stamp and contextid-idnumber.

This checks for violations before moving categories, and either
generates a new stamp or nulls the idnumber on the category being moved,
following the method used in MDL-85869.
This commit is contained in:
Mark Johnson
2025-11-13 10:35:16 +00:00
parent 7838e3f247
commit 458be6f714
2 changed files with 74 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
mod/qbank/classes/task/transfer_question_categories.php
+12 -1
View File
@@ -317,13 +317,24 @@ class transfer_question_categories extends adhoc_task {
/**
* Set the contextid of category $categoryid and all its children to $newcontextid.
*
* We may need to modify the category before moving it to avoid unique key violations {@see move_subcategories_to_context()}.
*
* @param int $categoryid a question_category id.
* @param int $newcontextid the place to move to.
*/
public function move_category_and_its_children(int $categoryid, int $newcontextid): void {
global $DB;
$DB->set_field('question_categories', 'contextid', $newcontextid, ['id' => $categoryid]);
$category = $DB->get_record('question_categories', ['id' => $categoryid]);
// Check for fields that are part of a unique key for conflicts with existing records.
if ($DB->record_exists('question_categories', ['contextid' => $newcontextid, 'stamp' => $category->stamp])) {
$category->stamp = make_unique_id_code();
}
if ($DB->record_exists('question_categories', ['contextid' => $newcontextid, 'idnumber' => $category->idnumber])) {
$category->idnumber = null;
}
$category->contextid = $newcontextid;
$DB->update_record('question_categories', $category);
$children = $DB->get_records('question_categories', ['parent' => $categoryid], '', 'id, contextid');
foreach ($children as $child) {
if ($child->contextid != $newcontextid) {
mod/qbank/tests/task/transfer_question_categories_test.php
+62
View File
@@ -792,6 +792,68 @@ final class transfer_question_categories_test extends \advanced_testcase {
$this->assert_category_is_in_context_with_parent($course2context, $wrongchild2, $doublywronggrandchild2->id);
}
/**
* Categories with missing contexts that would violate unique keys if moved to the same context as-is are correctly modified.
*/
public function test_fix_wrong_parents_conflicting_indexes(): void {
global $DB;
$this->resetAfterTest();
$this->setup_pre_install_data();
// Create a second course.
$course2 = self::getDataGenerator()->create_course();
$course2context = context_course::instance($course2->id);
// Create a parent category, and 2 child categories in a non-existant context.
$course2parentcat = $this->create_question_category('Course2 parent cat', $course2context->id);
$wrongchild1 = $this->create_question_category('Wrong context 1', $this->coursecontext->id + 1000, $course2parentcat->id);
$wrongchild2 = $this->create_question_category('Wrong context 2', $this->coursecontext->id + 1000, $course2parentcat->id);
// Set the stamp of one child and the idnumber of another child to match that of the parent context.
// Moving either of these children to the correct context would cause a conflict.
$tamperedstamp = make_unique_id_code();
$wrongchild1->stamp = $tamperedstamp;
$course2parentcat->stamp = $tamperedstamp;
$tamperedidnumber = random_string();
$wrongchild2->idnumber = $tamperedidnumber;
$course2parentcat->idnumber = $tamperedidnumber;
$DB->update_record('question_categories', $course2parentcat);
$DB->update_record('question_categories', $wrongchild1);
$DB->update_record('question_categories', $wrongchild2);
// Before we clean up, check that the expected categories are picked up.
$task = new transfer_question_categories();
$this->assertEquals(
[
$wrongchild1->id => $wrongchild1->contextid,
$wrongchild2->id => $wrongchild2->contextid,
],
$task->get_categories_in_a_different_context_to_their_parent(),
);
// Call the cleanup method.
$task->fix_wrong_parents();
// Now we expect no mismatches.
$this->assertEmpty($task->get_categories_in_a_different_context_to_their_parent());
// Assert that the child categories have been moved to the parent context.
$this->assert_category_is_in_context_with_parent($course2context, $course2parentcat, $wrongchild1->id);
$this->assert_category_is_in_context_with_parent($course2context, $course2parentcat, $wrongchild2->id);
// Categories with the same stamp should now be different.
$this->assertNotEquals(
$DB->get_field('question_categories', 'stamp', ['id' => $course2parentcat->id]),
$DB->get_field('question_categories', 'stamp', ['id' => $wrongchild1->id]),
);
// Categories with same idnumber should now be different.
$this->assertNotEquals(
$DB->get_field('question_categories', 'idnumber', ['id' => $course2parentcat->id]),
$DB->get_field('question_categories', 'idnumber', ['id' => $wrongchild2->id]),
);
}
/**
* Assert that the category with id $categoryid is in context $expectedcontext, with the given parent.
*