ILB
/
moodle
9
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1 Commit
1 Branch
0 Tags
47 MiB
 
 
 
 
 
 
Tree: d89e5c3cfa
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'd89e5c3cfa'
${ noResults }
moodle/mod/quiz/backup/moodle2/restore_quiz_stepslib.php

470 lines
19 KiB
Raw Blame History

<?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/>.
/**
* @package mod_quiz
* @subpackage backup-moodle2
* @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/**
* Structure step to restore one quiz activity
*
* @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class restore_quiz_activity_structure_step extends restore_questions_activity_structure_step {
/**
* @var bool tracks whether the quiz contains at least one section. Before
* Moodle 2.9 quiz sections did not exist, so if the file being restored
* did not contain any, we need to create one in {@link after_execute()}.
*/
protected $sectioncreated = false;
/**
* @var bool when restoring old quizzes (2.8 or before) this records the
* shufflequestionsoption quiz option which has moved to the quiz_sections table.
*/
protected $legacyshufflequestionsoption = false;
protected function define_structure() {
$paths = array();
$userinfo = $this->get_setting_value('userinfo');
$quiz = new restore_path_element('quiz', '/activity/quiz');
$paths[] = $quiz;
// A chance for access subplugings to set up their quiz data.
$this->add_subplugin_structure('quizaccess', $quiz);
$paths[] = new restore_path_element('quiz_question_instance',
'/activity/quiz/question_instances/question_instance');
$paths[] = new restore_path_element('quiz_slot_tags',
'/activity/quiz/question_instances/question_instance/tags/tag');
$paths[] = new restore_path_element('quiz_section', '/activity/quiz/sections/section');
$paths[] = new restore_path_element('quiz_feedback', '/activity/quiz/feedbacks/feedback');
$paths[] = new restore_path_element('quiz_override', '/activity/quiz/overrides/override');
if ($userinfo) {
$paths[] = new restore_path_element('quiz_grade', '/activity/quiz/grades/grade');
if ($this->task->get_old_moduleversion() > 2011010100) {
// Restoring from a version 2.1 dev or later.
// Process the new-style attempt data.
$quizattempt = new restore_path_element('quiz_attempt',
'/activity/quiz/attempts/attempt');
$paths[] = $quizattempt;
// Add states and sessions.
$this->add_question_usages($quizattempt, $paths);
// A chance for access subplugings to set up their attempt data.
$this->add_subplugin_structure('quizaccess', $quizattempt);
} else {
// Restoring from a version 2.0.x+ or earlier.
// Upgrade the legacy attempt data.
$quizattempt = new restore_path_element('quiz_attempt_legacy',
'/activity/quiz/attempts/attempt',
true);
$paths[] = $quizattempt;
$this->add_legacy_question_attempt_data($quizattempt, $paths);
}
}
// Return the paths wrapped into standard activity structure.
return $this->prepare_activity_structure($paths);
}
protected function process_quiz($data) {
global $CFG, $DB;
$data = (object)$data;
$oldid = $data->id;
$data->course = $this->get_courseid();
// Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
// See MDL-9367.
$data->timeopen = $this->apply_date_offset($data->timeopen);
$data->timeclose = $this->apply_date_offset($data->timeclose);
if (property_exists($data, 'questions')) {
// Needed by {@link process_quiz_attempt_legacy}, in which case it will be present.
$this->oldquizlayout = $data->questions;
}
// The setting quiz->attempts can come both in data->attempts and
// data->attempts_number, handle both. MDL-26229.
if (isset($data->attempts_number)) {
$data->attempts = $data->attempts_number;
unset($data->attempts_number);
}
// The old optionflags and penaltyscheme from 2.0 need to be mapped to
// the new preferredbehaviour. See MDL-20636.
if (!isset($data->preferredbehaviour)) {
if (empty($data->optionflags)) {
$data->preferredbehaviour = 'deferredfeedback';
} else if (empty($data->penaltyscheme)) {
$data->preferredbehaviour = 'adaptivenopenalty';
} else {
$data->preferredbehaviour = 'adaptive';
}
unset($data->optionflags);
unset($data->penaltyscheme);
}
// The old review column from 2.0 need to be split into the seven new
// review columns. See MDL-20636.
if (isset($data->review)) {
require_once($CFG->dirroot . '/mod/quiz/locallib.php');
if (!defined('QUIZ_OLD_IMMEDIATELY')) {
define('QUIZ_OLD_IMMEDIATELY', 0x3c003f);
define('QUIZ_OLD_OPEN', 0x3c00fc0);
define('QUIZ_OLD_CLOSED', 0x3c03f000);
define('QUIZ_OLD_RESPONSES', 1*0x1041);
define('QUIZ_OLD_SCORES', 2*0x1041);
define('QUIZ_OLD_FEEDBACK', 4*0x1041);
define('QUIZ_OLD_ANSWERS', 8*0x1041);
define('QUIZ_OLD_SOLUTIONS', 16*0x1041);
define('QUIZ_OLD_GENERALFEEDBACK', 32*0x1041);
define('QUIZ_OLD_OVERALLFEEDBACK', 1*0x4440000);
}
$oldreview = $data->review;
$data->reviewattempt =
mod_quiz_display_options::DURING |
($oldreview & QUIZ_OLD_IMMEDIATELY & QUIZ_OLD_RESPONSES ?
mod_quiz_display_options::IMMEDIATELY_AFTER : 0) |
($oldreview & QUIZ_OLD_OPEN & QUIZ_OLD_RESPONSES ?
mod_quiz_display_options::LATER_WHILE_OPEN : 0) |
($oldreview & QUIZ_OLD_CLOSED & QUIZ_OLD_RESPONSES ?
mod_quiz_display_options::AFTER_CLOSE : 0);
$data->reviewcorrectness =
mod_quiz_display_options::DURING |
($oldreview & QUIZ_OLD_IMMEDIATELY & QUIZ_OLD_SCORES ?
mod_quiz_display_options::IMMEDIATELY_AFTER : 0) |
($oldreview & QUIZ_OLD_OPEN & QUIZ_OLD_SCORES ?
mod_quiz_display_options::LATER_WHILE_OPEN : 0) |
($oldreview & QUIZ_OLD_CLOSED & QUIZ_OLD_SCORES ?
mod_quiz_display_options::AFTER_CLOSE : 0);
$data->reviewmarks =
mod_quiz_display_options::DURING |
($oldreview & QUIZ_OLD_IMMEDIATELY & QUIZ_OLD_SCORES ?
mod_quiz_display_options::IMMEDIATELY_AFTER : 0) |
($oldreview & QUIZ_OLD_OPEN & QUIZ_OLD_SCORES ?
mod_quiz_display_options::LATER_WHILE_OPEN : 0) |
($oldreview & QUIZ_OLD_CLOSED & QUIZ_OLD_SCORES ?
mod_quiz_display_options::AFTER_CLOSE : 0);
$data->reviewspecificfeedback =
($oldreview & QUIZ_OLD_IMMEDIATELY & QUIZ_OLD_FEEDBACK ?
mod_quiz_display_options::DURING : 0) |
($oldreview & QUIZ_OLD_IMMEDIATELY & QUIZ_OLD_FEEDBACK ?
mod_quiz_display_options::IMMEDIATELY_AFTER : 0) |
($oldreview & QUIZ_OLD_OPEN & QUIZ_OLD_FEEDBACK ?
mod_quiz_display_options::LATER_WHILE_OPEN : 0) |
($oldreview & QUIZ_OLD_CLOSED & QUIZ_OLD_FEEDBACK ?
mod_quiz_display_options::AFTER_CLOSE : 0);
$data->reviewgeneralfeedback =
($oldreview & QUIZ_OLD_IMMEDIATELY & QUIZ_OLD_GENERALFEEDBACK ?
mod_quiz_display_options::DURING : 0) |
($oldreview & QUIZ_OLD_IMMEDIATELY & QUIZ_OLD_GENERALFEEDBACK ?
mod_quiz_display_options::IMMEDIATELY_AFTER : 0) |
($oldreview & QUIZ_OLD_OPEN & QUIZ_OLD_GENERALFEEDBACK ?
mod_quiz_display_options::LATER_WHILE_OPEN : 0) |
($oldreview & QUIZ_OLD_CLOSED & QUIZ_OLD_GENERALFEEDBACK ?
mod_quiz_display_options::AFTER_CLOSE : 0);
$data->reviewrightanswer =
($oldreview & QUIZ_OLD_IMMEDIATELY & QUIZ_OLD_ANSWERS ?
mod_quiz_display_options::DURING : 0) |
($oldreview & QUIZ_OLD_IMMEDIATELY & QUIZ_OLD_ANSWERS ?
mod_quiz_display_options::IMMEDIATELY_AFTER : 0) |
($oldreview & QUIZ_OLD_OPEN & QUIZ_OLD_ANSWERS ?
mod_quiz_display_options::LATER_WHILE_OPEN : 0) |
($oldreview & QUIZ_OLD_CLOSED & QUIZ_OLD_ANSWERS ?
mod_quiz_display_options::AFTER_CLOSE : 0);
$data->reviewoverallfeedback =
0 |
($oldreview & QUIZ_OLD_IMMEDIATELY & QUIZ_OLD_OVERALLFEEDBACK ?
mod_quiz_display_options::IMMEDIATELY_AFTER : 0) |
($oldreview & QUIZ_OLD_OPEN & QUIZ_OLD_OVERALLFEEDBACK ?
mod_quiz_display_options::LATER_WHILE_OPEN : 0) |
($oldreview & QUIZ_OLD_CLOSED & QUIZ_OLD_OVERALLFEEDBACK ?
mod_quiz_display_options::AFTER_CLOSE : 0);
}
// The old popup column from from <= 2.1 need to be mapped to
// the new browsersecurity. See MDL-29627.
if (!isset($data->browsersecurity)) {
if (empty($data->popup)) {
$data->browsersecurity = '-';
} else if ($data->popup == 1) {
$data->browsersecurity = 'securewindow';
} else if ($data->popup == 2) {
$data->browsersecurity = 'safebrowser';
} else {
$data->preferredbehaviour = '-';
}
unset($data->popup);
}
if (!isset($data->overduehandling)) {
$data->overduehandling = get_config('quiz', 'overduehandling');
}
// Old shufflequestions setting is now stored in quiz sections,
// so save it here if necessary so it is available when we need it.
$this->legacyshufflequestionsoption = !empty($data->shufflequestions);
// Insert the quiz record.
$newitemid = $DB->insert_record('quiz', $data);
// Immediately after inserting "activity" record, call this.
$this->apply_activity_instance($newitemid);
}
protected function process_quiz_question_instance($data) {
global $CFG, $DB;
$data = (object)$data;
$oldid = $data->id;
// Backwards compatibility for old field names (MDL-43670).
if (!isset($data->questionid) && isset($data->question)) {
$data->questionid = $data->question;
}
if (!isset($data->maxmark) && isset($data->grade)) {
$data->maxmark = $data->grade;
}
if (!property_exists($data, 'slot')) {
$page = 1;
$slot = 1;
foreach (explode(',', $this->oldquizlayout) as $item) {
if ($item == 0) {
$page += 1;
continue;
}
if ($item == $data->questionid) {
$data->slot = $slot;
$data->page = $page;
break;
}
$slot += 1;
}
}
if (!property_exists($data, 'slot')) {
// There was a question_instance in the backup file for a question
// that was not actually in the quiz. Drop it.
$this->log('question ' . $data->questionid . ' was associated with quiz ' .
$this->get_new_parentid('quiz') . ' but not actually used. ' .
'The instance has been ignored.', backup::LOG_INFO);
return;
}
$data->quizid = $this->get_new_parentid('quiz');
$questionmapping = $this->get_mapping('question', $data->questionid);
$data->questionid = $questionmapping ? $questionmapping->newitemid : false;
if (isset($data->questioncategoryid)) {
$data->questioncategoryid = $this->get_mappingid('question_category', $data->questioncategoryid);
} else if ($questionmapping && $questionmapping->info->qtype == 'random') {
// Backward compatibility for backups created using Moodle 3.4 or earlier.
$data->questioncategoryid = $this->get_mappingid('question_category', $questionmapping->parentitemid);
$data->includingsubcategories = $questionmapping->info->questiontext ? 1 : 0;
}
$newitemid = $DB->insert_record('quiz_slots', $data);
// Add mapping, restore of slot tags (for random questions) need it.
$this->set_mapping('quiz_question_instance', $oldid, $newitemid);
}
/**
* Process a quiz_slot_tags restore
*
* @param stdClass|array $data The quiz_slot_tags data
*/
protected function process_quiz_slot_tags($data) {
global $DB;
$data = (object)$data;
$data->slotid = $this->get_new_parentid('quiz_question_instance');
if ($this->task->is_samesite() && $tag = core_tag_tag::get($data->tagid, 'id, name')) {
$data->tagname = $tag->name;
} else if ($tag = core_tag_tag::get_by_name(0, $data->tagname, 'id, name')) {
$data->tagid = $tag->id;
} else {
$data->tagid = null;
$data->tagname = $tag->name;
}
$DB->insert_record('quiz_slot_tags', $data);
}
protected function process_quiz_section($data) {
global $DB;
$data = (object) $data;
$data->quizid = $this->get_new_parentid('quiz');
$newitemid = $DB->insert_record('quiz_sections', $data);
$this->sectioncreated = true;
}
protected function process_quiz_feedback($data) {
global $DB;
$data = (object)$data;
$oldid = $data->id;
$data->quizid = $this->get_new_parentid('quiz');
$newitemid = $DB->insert_record('quiz_feedback', $data);
$this->set_mapping('quiz_feedback', $oldid, $newitemid, true); // Has related files.
}
protected function process_quiz_override($data) {
global $DB;
$data = (object)$data;
$oldid = $data->id;
// Based on userinfo, we'll restore user overides or no.
$userinfo = $this->get_setting_value('userinfo');
// Skip user overrides if we are not restoring userinfo.
if (!$userinfo && !is_null($data->userid)) {
return;
}
$data->quiz = $this->get_new_parentid('quiz');
if ($data->userid !== null) {
$data->userid = $this->get_mappingid('user', $data->userid);
}
if ($data->groupid !== null) {
$data->groupid = $this->get_mappingid('group', $data->groupid);
}
$data->timeopen = $this->apply_date_offset($data->timeopen);
$data->timeclose = $this->apply_date_offset($data->timeclose);
$newitemid = $DB->insert_record('quiz_overrides', $data);
// Add mapping, restore of logs needs it.
$this->set_mapping('quiz_override', $oldid, $newitemid);
}
protected function process_quiz_grade($data) {
global $DB;
$data = (object)$data;
$oldid = $data->id;
$data->quiz = $this->get_new_parentid('quiz');
$data->userid = $this->get_mappingid('user', $data->userid);
$data->grade = $data->gradeval;
$DB->insert_record('quiz_grades', $data);
}
protected function process_quiz_attempt($data) {
$data = (object)$data;
$data->quiz = $this->get_new_parentid('quiz');
$data->attempt = $data->attemptnum;
$data->userid = $this->get_mappingid('user', $data->userid);
if (!empty($data->timecheckstate)) {
$data->timecheckstate = $this->apply_date_offset($data->timecheckstate);
} else {
$data->timecheckstate = 0;
}
// Deals with up-grading pre-2.3 back-ups to 2.3+.
if (!isset($data->state)) {
if ($data->timefinish > 0) {
$data->state = 'finished';
} else {
$data->state = 'inprogress';
}
}
// The data is actually inserted into the database later in inform_new_usage_id.
$this->currentquizattempt = clone($data);
}
protected function process_quiz_attempt_legacy($data) {
global $DB;
$this->process_quiz_attempt($data);
$quiz = $DB->get_record('quiz', array('id' => $this->get_new_parentid('quiz')));
$quiz->oldquestions = $this->oldquizlayout;
$this->process_legacy_quiz_attempt_data($data, $quiz);
}
protected function inform_new_usage_id($newusageid) {
global $DB;
$data = $this->currentquizattempt;
$oldid = $data->id;
$data->uniqueid = $newusageid;
$newitemid = $DB->insert_record('quiz_attempts', $data);
// Save quiz_attempt->id mapping, because logs use it.
$this->set_mapping('quiz_attempt', $oldid, $newitemid, false);
}
protected function after_execute() {
global $DB;
parent::after_execute();
// Add quiz related files, no need to match by itemname (just internally handled context).
$this->add_related_files('mod_quiz', 'intro', null);
// Add feedback related files, matching by itemname = 'quiz_feedback'.
$this->add_related_files('mod_quiz', 'feedback', 'quiz_feedback');
if (!$this->sectioncreated) {
$DB->insert_record('quiz_sections', array(
'quizid' => $this->get_new_parentid('quiz'),
'firstslot' => 1, 'heading' => '',
'shufflequestions' => $this->legacyshufflequestionsoption));
}
}
}