Skip to content

Commit

Permalink
Merge branch 'MDL-61464-master' of git://github.com/rezaies/moodle
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewnicols committed Apr 5, 2018
2 parents 8f20573 + 7c33ba4 commit 682282d
Show file tree
Hide file tree
Showing 3 changed files with 271 additions and 35 deletions.
4 changes: 2 additions & 2 deletions backup/moodle2/backup_stepslib.php
Original file line number Diff line number Diff line change
Expand Up @@ -2234,7 +2234,7 @@ protected function define_structure() {

$tags = new backup_nested_element('tags');

$tag = new backup_nested_element('tag', array('id'), array('name', 'rawname'));
$tag = new backup_nested_element('tag', array('id', 'contextid'), array('name', 'rawname'));

// Build the tree

Expand Down Expand Up @@ -2266,7 +2266,7 @@ protected function define_structure() {
ORDER BY id',
array('questionid' => backup::VAR_PARENTID));

$tag->set_source_sql("SELECT t.id, t.name, t.rawname
$tag->set_source_sql("SELECT t.id, ti.contextid, t.name, t.rawname
FROM {tag} t
JOIN {tag_instance} ti ON ti.tagid = t.id
WHERE ti.itemid = ?
Expand Down
96 changes: 63 additions & 33 deletions backup/moodle2/restore_stepslib.php
Original file line number Diff line number Diff line change
Expand Up @@ -4388,6 +4388,9 @@ protected function process_question_category($data) {

// Check we have to create the category (newitemid = 0)
if ($mapping->newitemid) {
// By performing this set_mapping() we make get_old/new_parentid() to work for all the
// children elements of the 'question_category' one.
$this->set_mapping('question_category', $oldid, $mapping->newitemid);
return; // newitemid != 0, this category is going to be mapped. Nothing to do
}

Expand All @@ -4414,20 +4417,29 @@ protected function process_question_category($data) {
$data->parent = $top->id;
}

// Before 3.1, the 'stamp' field could be erroneously duplicated.
// From 3.1 onwards, there's a unique index of (contextid, stamp).
// If we encounter a duplicate in an old restore file, just generate a new stamp.
// This is the same as what happens during an upgrade to 3.1+ anyway.
if ($DB->record_exists('question_categories', ['stamp' => $data->stamp, 'contextid' => $data->contextid])) {
$data->stamp = make_unique_id_code();
}
if (empty($data->parent)) {
if (!$top = question_get_top_category($data->contextid)) {
$top = question_get_top_category($data->contextid, true);
$this->set_mapping('question_category_created', $oldid, $top->id, false, null, $data->contextid);
}
$this->set_mapping('question_category', $oldid, $top->id);
} else {

// Before 3.1, the 'stamp' field could be erroneously duplicated.
// From 3.1 onwards, there's a unique index of (contextid, stamp).
// If we encounter a duplicate in an old restore file, just generate a new stamp.
// This is the same as what happens during an upgrade to 3.1+ anyway.
if ($DB->record_exists('question_categories', ['stamp' => $data->stamp, 'contextid' => $data->contextid])) {
$data->stamp = make_unique_id_code();
}

// Let's create the question_category and save mapping
$newitemid = $DB->insert_record('question_categories', $data);
$this->set_mapping('question_category', $oldid, $newitemid);
// Also annotate them as question_category_created, we need
// that later when remapping parents
$this->set_mapping('question_category_created', $oldid, $newitemid, false, null, $data->contextid);
// Let's create the question_category and save mapping.
$newitemid = $DB->insert_record('question_categories', $data);
$this->set_mapping('question_category', $oldid, $newitemid);
// Also annotate them as question_category_created, we need
// that later when remapping parents.
$this->set_mapping('question_category_created', $oldid, $newitemid, false, null, $data->contextid);
}
}

protected function process_question($data) {
Expand Down Expand Up @@ -4542,7 +4554,7 @@ protected function process_question_hint($data) {
}

protected function process_tag($data) {
global $CFG, $DB;
global $DB;

$data = (object)$data;
$newquestion = $this->get_new_parentid('question');
Expand All @@ -4554,14 +4566,19 @@ protected function process_tag($data) {

if (core_tag_tag::is_enabled('core_question', 'question')) {
$tagname = $data->rawname;
// Get the category, so we can then later get the context.
$categoryid = $this->get_new_parentid('question_category');
if (empty($this->cachedcategory) || $this->cachedcategory->id != $categoryid) {
$this->cachedcategory = $DB->get_record('question_categories', array('id' => $categoryid));
if (!empty($data->contextid) && $newcontextid = $this->get_mappingid('context', $data->contextid)) {
$tagcontextid = $newcontextid;
} else {
// Get the category, so we can then later get the context.
$categoryid = $this->get_new_parentid('question_category');
if (empty($this->cachedcategory) || $this->cachedcategory->id != $categoryid) {
$this->cachedcategory = $DB->get_record('question_categories', array('id' => $categoryid));
}
$tagcontextid = $this->cachedcategory->contextid;
}
// Add the tag to the question.
core_tag_tag::add_item_tag('core_question', 'question', $newquestion,
context::instance_by_id($this->cachedcategory->contextid),
context::instance_by_id($tagcontextid),
$tagname);
}
}
Expand Down Expand Up @@ -4633,9 +4650,9 @@ protected function define_execution() {
$backuprelease = floatval($this->task->get_info()->backup_release);
preg_match('/(\d{8})/', $this->task->get_info()->moodle_release, $matches);
$backupbuild = (int)$matches[1];
$before35 = false;
if ($backuprelease < 3.5 || $backupbuild < 20180205) {
$before35 = true;
$after35 = false;
if ($backuprelease >= 3.5 && $backupbuild > 20180205) {
$after35 = true;
}

$contexts = restore_dbops::restore_get_question_banks($this->get_restoreid(), CONTEXT_MODULE);
Expand All @@ -4648,23 +4665,36 @@ protected function define_execution() {
WHERE backupid = ?
AND itemname = 'question_category'
AND parentitemid = ?", array($this->get_restoreid(), $contextid));
$top = question_get_top_category($newcontext->newitemid, true);
$oldtopid = 0;
foreach ($modulecats as $modulecat) {
$cat = new stdClass();
$cat->id = $modulecat->newitemid;
$cat->contextid = $newcontext->newitemid;

// Before 3.5, question categories could be created at top level.
// From 3.5 onwards, all question categories should be a child of a special category called the "top" category.
$info = backup_controller_dbops::decode_backup_temp_info($modulecat->info);
if ($before35 && empty($info->parent)) {
$top = question_get_top_category($newcontext->newitemid, true);
$cat->parent = $top->id;
if ($after35 && empty($info->parent)) {
$oldtopid = $modulecat->newitemid;
$modulecat->newitemid = $top->id;
} else {
$cat = new stdClass();
$cat->id = $modulecat->newitemid;
$cat->contextid = $newcontext->newitemid;
if (empty($info->parent)) {
$cat->parent = $top->id;
}
$DB->update_record('question_categories', $cat);
}
$DB->update_record('question_categories', $cat);

// And set new contextid also in question_category mapping (will be
// used by {@link restore_create_question_files} later
restore_dbops::set_backup_ids_record($this->get_restoreid(), 'question_category', $modulecat->itemid, $modulecat->newitemid, $newcontext->newitemid);
// And set new contextid (and maybe update newitemid) also in question_category mapping (will be
// used by {@link restore_create_question_files} later.
restore_dbops::set_backup_ids_record($this->get_restoreid(), 'question_category', $modulecat->itemid,
$modulecat->newitemid, $newcontext->newitemid);
}

// Now set the parent id for the question categories that were in the top category in the course context
// and have been moved now.
if ($oldtopid) {
$DB->set_field('question_categories', 'parent', $top->id,
array('contextid' => $newcontext->newitemid, 'parent' => $oldtopid));
}
}
}
Expand Down
206 changes: 206 additions & 0 deletions question/tests/backup_test.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,206 @@
<?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/>.

/**
* Unit tests for question backup and restore.
*
* @package core_question
* @category test
* @copyright 2018 Shamim Rezaie <shamim@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

defined('MOODLE_INTERNAL') || die();

global $CFG;
require_once($CFG->dirroot . '/backup/util/includes/backup_includes.php');
require_once($CFG->dirroot . '/backup/util/includes/restore_includes.php');

/**
* Class core_question_backup_testcase
*
* @copyright 2018 Shamim Rezaie <shamim@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class core_question_backup_testcase extends advanced_testcase {

/**
* Makes a backup of the course.
*
* @param stdClass $course The course object.
* @return string Unique identifier for this backup.
*/
protected function backup_course($course) {
global $CFG, $USER;

// Turn off file logging, otherwise it can't delete the file (Windows).
$CFG->backup_file_logger_level = backup::LOG_NONE;

// Do backup with default settings. MODE_IMPORT means it will just
// create the directory and not zip it.
$bc = new backup_controller(backup::TYPE_1COURSE, $course->id,
backup::FORMAT_MOODLE, backup::INTERACTIVE_NO, backup::MODE_IMPORT,
$USER->id);
$backupid = $bc->get_backupid();
$bc->execute_plan();
$bc->destroy();

return $backupid;
}

/**
* Restores a backup that has been made earlier.
*
* @param string $backupid The unique identifier of the backup.
* @param string $fullname Full name of the new course that is going to be created.
* @param string $shortname Short name of the new course that is going to be created.
* @param int $categoryid The course category the backup is going to be restored in.
* @param string[] $expectedprecheckwarning
* @return int The new course id.
*/
protected function restore_course($backupid, $fullname, $shortname, $categoryid, $expectedprecheckwarning = []) {
global $CFG, $USER;

// Turn off file logging, otherwise it can't delete the file (Windows).
$CFG->backup_file_logger_level = backup::LOG_NONE;

// Do restore to new course with default settings.
$newcourseid = restore_dbops::create_new_course($fullname, $shortname, $categoryid);
$rc = new restore_controller($backupid, $newcourseid,
backup::INTERACTIVE_NO, backup::MODE_GENERAL, $USER->id,
backup::TARGET_NEW_COURSE);

$precheck = $rc->execute_precheck();
if (!$expectedprecheckwarning) {
$this->assertTrue($precheck);
} else {
$precheckresults = $rc->get_precheck_results();
$this->assertEquals(['warnings' => $expectedprecheckwarning], $precheckresults);
}
$rc->execute_plan();
$rc->destroy();

return $newcourseid;
}

/**
* This function tests backup and restore of question tags and course level question tags.
*/
public function test_backup_question_tags() {
global $DB;

$this->resetAfterTest();
$this->setAdminUser();

// Create a new course category and and a new course in that.
$category1 = $this->getDataGenerator()->create_category();
$course = $this->getDataGenerator()->create_course(array('category' => $category1->id));
$courseshortname = $course->shortname;
$coursefullname = $course->fullname;

// Create 2 questions.
$qgen = $this->getDataGenerator()->get_plugin_generator('core_question');
$context = context_coursecat::instance($category1->id);
$qcat = $qgen->create_question_category(array('contextid' => $context->id));
$question1 = $qgen->create_question('shortanswer', null, array('category' => $qcat->id));
$question2 = $qgen->create_question('shortanswer', null, array('category' => $qcat->id));

// Tag the questions with 2 question tags and 2 course level question tags.
$qcontext = context::instance_by_id($qcat->contextid);
$coursecontext = context_course::instance($course->id);
core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $qcontext, ['qtag1', 'qtag2']);
core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $qcontext, ['qtag3', 'qtag4']);
core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $coursecontext, ['ctag1', 'ctag2']);
core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $coursecontext, ['ctag3', 'ctag4']);

// Create a quiz and add one of the questions to that.
$quiz = $this->getDataGenerator()->create_module('quiz', array('course' => $course->id));
quiz_add_quiz_question($question1->id, $quiz);

// Backup the course twice for future use.
$backupid1 = $this->backup_course($course);
$backupid2 = $this->backup_course($course);

// Now delete almost everything.
delete_course($course, false);
question_delete_question($question1->id);
question_delete_question($question2->id);

// Restore the backup we had made earlier into a new course.
$courseid2 = $this->restore_course($backupid1, $coursefullname, $courseshortname . '_2', $category1->id);

// The questions should remain in the question category they were which is
// a question category belonging to a course category context.
$questions = $DB->get_records('question', array('category' => $qcat->id));
$this->assertCount(2, $questions);

// Retrieve tags for each question and check if they are assigned at the right context.
foreach ($questions as $question) {
$tags = core_tag_tag::get_item_tags('core_question', 'question', $question->id);

// Each question is tagged with 4 tags (2 question tags + 2 course tags).
$this->assertCount(4, $tags);

foreach ($tags as $tag) {
if (in_array($tag->name, ['ctag1', 'ctag2', 'ctag3', 'ctag4'])) {
$expected = context_course::instance($courseid2)->id;
} else if (in_array($tag->name, ['qtag1', 'qtag2', 'qtag3', 'qtag4'])) {
$expected = $qcontext->id;
}
$this->assertEquals($expected, $tag->taginstancecontextid);
}
}

// Now, again, delete everything including the course category.
delete_course($courseid2, false);
foreach ($questions as $question) {
question_delete_question($question->id);
}
$category1->delete_full(false);

// Create a new course category to restore the backup file into it.
$category2 = $this->getDataGenerator()->create_category();

$expectedwarnings = array(
get_string('qcategory2coursefallback', 'backup', (object) ['name' => 'top']),
get_string('qcategory2coursefallback', 'backup', (object) ['name' => $qcat->name])
);

// Restore to a new course in the new course category.
$courseid3 = $this->restore_course($backupid2, $coursefullname, $courseshortname . '_3', $category2->id, $expectedwarnings);
$coursecontext3 = context_course::instance($courseid3);

// The questions should have been moved to a question category that belongs to a course context.
$questions = $DB->get_records_sql("SELECT q.*
FROM {question} q
JOIN {question_categories} qc ON q.category = qc.id
WHERE qc.contextid = ?", array($coursecontext3->id));
$this->assertCount(2, $questions);

// Now, retrieve tags for each question and check if they are assigned at the right context.
foreach ($questions as $question) {
$tags = core_tag_tag::get_item_tags('core_question', 'question', $question->id);

// Each question is tagged with 4 tags (all are course tags now).
$this->assertCount(4, $tags);

foreach ($tags as $tag) {
$this->assertEquals($coursecontext3->id, $tag->taginstancecontextid);
}
}

}
}

0 comments on commit 682282d

Please sign in to comment.