Commit 0d14fcbc authored by Ankit Agarwal's avatar Ankit Agarwal
Browse files

MDL-9367 restore: Roll only configuration dates

It was decided to roll only configuration dates and any date related to user content
such as 'timecreated' , 'timemodified' etc should not be rolled forward.
parent d509f80c
......@@ -51,6 +51,8 @@ abstract class restore_step extends base_step {
* Note we are using one static cache here, but *by restoreid*, so it's ok for concurrence/multiple
* executions in the same request
*
* Note: The policy is to roll date only for configurations and not for user data. see MDL-9367.
*
* @param int $value Time value (seconds since epoch), or empty for nothing
* @return int Time value after applying the date offset, or empty for nothing
*/
......
<?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 dates test case.
*
* @package core
* @category test
* @copyright 2017 onwards Ankit Agarwal
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
require_once($CFG->dirroot . '/backup/util/includes/restore_includes.php');
require_once($CFG->dirroot . '/backup/util/includes/backup_includes.php');
/**
* Advanced PHPUnit test case customised for testing restore dates in Moodle.
*
* @package core
* @category test
* @copyright 2017 onwards Ankit Agarwal
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
abstract class restore_date_testcase extends advanced_testcase {
/**
* @var int Course start date.
*/
protected $startdate;
/**
* @var int Course restore date.
*/
protected $restorestartdate;
/**
* Setup.
*/
public function setUp() {
global $CFG;
parent::setUp();
$this->resetAfterTest();
$this->setAdminUser();
$this->startdate = strtotime('1 Jan 2017 00:00 GMT');
$this->restorestartdate = strtotime('1 Feb 2017 00:00 GMT');
$CFG->enableavailability = true;
}
/**
* Backs a course up and restores it.
*
* @param stdClass $course Course object to backup
* @param int $newdate If non-zero, specifies custom date for new course
* @return int ID of newly restored course
*/
protected function backup_and_restore($course, $newdate = 0) {
global $USER, $CFG;
// 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.
set_config('backup_general_users', 1, 'backup');
$bc = new backup_controller(backup::TYPE_1COURSE, $course->id,
backup::FORMAT_MOODLE, backup::INTERACTIVE_NO, backup::MODE_GENERAL,
$USER->id);
$bc->execute_plan();
$results = $bc->get_results();
$file = $results['backup_destination'];
$fp = get_file_packer('application/vnd.moodle.backup');
$filepath = $CFG->dataroot . '/temp/backup/test-restore-course';
$file->extract_to_pathname($fp, $filepath);
$bc->destroy();
// Do restore to new course with default settings.
$newcourseid = restore_dbops::create_new_course(
$course->fullname, $course->shortname . '_2', $course->category);
$rc = new restore_controller('test-restore-course', $newcourseid,
backup::INTERACTIVE_NO, backup::MODE_GENERAL, $USER->id,
backup::TARGET_NEW_COURSE);
if (empty($newdate)) {
$newdate = $this->restorestartdate;
}
$rc->get_plan()->get_setting('course_startdate')->set_value($newdate);
$this->assertTrue($rc->execute_precheck());
$rc->execute_plan();
$rc->destroy();
return $newcourseid;
}
/**
* Helper method to create a course and a module.
*
* @param string $modulename
* @param array|stdClass $record
* @return array
*/
protected function create_course_and_module($modulename, $record = []) {
// Create a course with specific start date.
$record = (array)$record;
$generator = $this->getDataGenerator();
$course = $generator->create_course(['startdate' => $this->startdate]);
$record = array_merge(['course' => $course->id], $record);
$module = $this->getDataGenerator()->create_module($modulename, $record);
return [$course, $module];
}
/**
* Verify that the given properties are not rolled.
*
* @param stdClass $oldinstance
* @param stdClass $newinstance
* @param [] $props
*/
protected function assertFieldsNotRolledForward($oldinstance, $newinstance, $props) {
foreach ($props as $prop) {
$this->assertEquals($oldinstance->$prop, $newinstance->$prop, "'$prop' should not roll forward.");
}
}
/**
* Verify that the given properties are rolled.
*
* @param stdClass $oldinstance
* @param stdClass $newinstance
* @param [] $props
*/
protected function assertFieldsRolledForward($oldinstance, $newinstance, $props) {
$diff = $this->get_diff();
foreach ($props as $prop) {
$this->assertEquals(($oldinstance->$prop + $diff), $newinstance->$prop, "'$prop' doesn't roll as expected.");
}
}
/**
* Get time diff between start date and restore date in seconds.
*
* @return mixed
*/
protected function get_diff() {
return ($this->restorestartdate - $this->startdate);
}
}
\ No newline at end of file
......@@ -87,7 +87,8 @@ class restore_assign_activity_structure_step extends restore_activity_structure_
$oldid = $data->id;
$data->course = $this->get_courseid();
$data->timemodified = $this->apply_date_offset($data->timemodified);
// 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->allowsubmissionsfromdate = $this->apply_date_offset($data->allowsubmissionsfromdate);
$data->duedate = $this->apply_date_offset($data->duedate);
......@@ -159,8 +160,6 @@ class restore_assign_activity_structure_step extends restore_activity_structure_
$data->assignment = $this->get_new_parentid('assign');
$data->timemodified = $this->apply_date_offset($data->timemodified);
$data->timecreated = $this->apply_date_offset($data->timecreated);
if ($data->userid > 0) {
$data->userid = $this->get_mappingid('user', $data->userid);
}
......@@ -220,8 +219,6 @@ class restore_assign_activity_structure_step extends restore_activity_structure_
$data->assignment = $this->get_new_parentid('assign');
$data->timemodified = $this->apply_date_offset($data->timemodified);
$data->timecreated = $this->apply_date_offset($data->timecreated);
$data->userid = $this->get_mappingid('user', $data->userid);
$data->grader = $this->get_mappingid('user', $data->grader);
......
......@@ -1035,6 +1035,8 @@ class assign {
WHERE assignid =? AND cutoffdate <> 0",
array($data->timeshift, $this->get_instance()->id));
// Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
// See MDL-9367.
shift_course_mod_dates('assign',
array('duedate', 'allowsubmissionsfromdate', 'cutoffdate'),
$data->timeshift,
......
<?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 date tests.
*
* @package mod_assign
* @copyright 2017 onwards Ankit Agarwal <ankit.agrr@gmail.com>
* @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");
require_once($CFG->dirroot . '/mod/assign/tests/base_test.php');
/**
* Restore date tests.
*
* @package mod_assign
* @copyright 2017 onwards Ankit Agarwal <ankit.agrr@gmail.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class mod_assign_restore_date_testcase extends restore_date_testcase {
/**
* Test restore dates.
*/
public function test_restore_dates() {
global $DB, $USER;
$record = ['cutoffdate' => 100, 'allowsubmissionsfromdate' => 100, 'duedate' => 100, 'timemodified' => 100];
list($course, $assign) = $this->create_course_and_module('assign', $record);
$cm = $DB->get_record('course_modules', ['course' => $course->id, 'instance' => $assign->id]);
$assignobj = new testable_assign(context_module::instance($cm->id), $cm, $course);
$submission = $assignobj->get_user_submission($USER->id, true);
$grade = $assignobj->get_user_grade($USER->id, true);
// User override.
$override = (object)[
'assignid' => $assign->id,
'groupid' => 0,
'userid' => $USER->id,
'sortorder' => 1,
'allowsubmissionsfromdate' => 100,
'duedate' => 200,
'cutoffdate' => 300
];
$DB->insert_record('assign_overrides', $override);
// Do backup and restore.
$newcourseid = $this->backup_and_restore($course);
$newassign = $DB->get_record('assign', ['course' => $newcourseid]);
$this->assertFieldsNotRolledForward($assign, $newassign, ['timemodified']);
$props = ['allowsubmissionsfromdate', 'duedate', 'cutoffdate'];
$this->assertFieldsRolledForward($assign, $newassign, $props);
$newsubmission = $DB->get_record('assign_submission', ['assignment' => $newassign->id]);
$newoverride = $DB->get_record('assign_overrides', ['assignid' => $newassign->id]);
$newgrade = $DB->get_record('assign_grades', ['assignment' => $newassign->id]);
// Assign submission time checks.
$this->assertEquals($submission->timecreated, $newsubmission->timecreated);
$this->assertEquals($submission->timemodified, $newsubmission->timemodified);
// Assign override time checks.
$diff = $this->get_diff();
$this->assertEquals($override->duedate + $diff, $newoverride->duedate);
$this->assertEquals($override->cutoffdate + $diff, $newoverride->cutoffdate);
$this->assertEquals($override->allowsubmissionsfromdate + $diff, $newoverride->allowsubmissionsfromdate);
// Assign grade time checks.
$this->assertEquals($grade->timecreated, $newgrade->timecreated);
$this->assertEquals($grade->timemodified, $newgrade->timemodified);
}
}
......@@ -51,6 +51,9 @@ class restore_book_activity_structure_step extends restore_activity_structure_st
$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.
$newitemid = $DB->insert_record('book', $data);
$this->apply_activity_instance($newitemid);
}
......
......@@ -164,6 +164,9 @@ function book_print_recent_activity($course, $viewfullnames, $timestart) {
* @return array status array
*/
function book_reset_userdata($data) {
// Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
// See MDL-9367.
return array();
}
......
......@@ -51,8 +51,9 @@ class restore_chat_activity_structure_step extends restore_activity_structure_st
$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->chattime = $this->apply_date_offset($data->chattime);
$data->timemodified = $this->apply_date_offset($data->timemodified);
// Insert the chat record.
$newitemid = $DB->insert_record('chat', $data);
......@@ -69,7 +70,6 @@ class restore_chat_activity_structure_step extends restore_activity_structure_st
$data->userid = $this->get_mappingid('user', $data->userid);
$data->groupid = $this->get_mappingid('group', $data->groupid);
$data->message = $data->message_text;
$data->timestamp = $this->apply_date_offset($data->timestamp);
$newitemid = $DB->insert_record('chat_messages', $data);
$this->set_mapping('chat_message', $oldid, $newitemid); // Because of decode.
......
......@@ -1257,6 +1257,8 @@ function chat_reset_userdata($data) {
// Updating dates - shift may be negative too.
if ($data->timeshift) {
// Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
// See MDL-9367.
shift_course_mod_dates('chat', array('chattime'), $data->timeshift, $data->courseid);
$status[] = array('component' => $componentstr, 'item' => get_string('datechanged'), 'error' => false);
}
......
<?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 date tests.
*
* @package mod_chat
* @copyright 2017 onwards Ankit Agarwal <ankit.agrr@gmail.com>
* @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 date tests.
*
* @package mod_chat
* @copyright 2017 onwards Ankit Agarwal <ankit.agrr@gmail.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class mod_chat_restore_date_testcase extends restore_date_testcase {
public function test_restore_dates() {
global $DB;
list($course, $chat) = $this->create_course_and_module('chat');
$result = mod_chat_external::login_user($chat->id);
$result = external_api::clean_returnvalue(mod_chat_external::login_user_returns(), $result);
$chatsid = $result['chatsid'];
$result = mod_chat_external::send_chat_message($chatsid, 'hello!');
$result = external_api::clean_returnvalue(mod_chat_external::send_chat_message_returns(), $result);
$message = $DB->get_record('chat_messages', ['id' => $result['messageid']]);
$timestamp = 1000;
$DB->set_field('chat_messages', 'timestamp', $timestamp);
// Do backup and restore.
$newcourseid = $this->backup_and_restore($course);
$newchat = $DB->get_record('chat', ['course' => $newcourseid]);
$this->assertFieldsNotRolledForward($chat, $newchat, ['timemodified']);
$props = ['chattime'];
$this->assertFieldsRolledForward($chat, $newchat, $props);
$newmessages = $DB->get_records('chat_messages', ['chatid' => $newchat->id]);
foreach ($newmessages as $message) {
$this->assertEquals($timestamp, $message->timestamp);
}
}
}
......@@ -53,9 +53,10 @@ class restore_choice_activity_structure_step extends restore_activity_structure_
$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);
$data->timemodified = $this->apply_date_offset($data->timemodified);
// insert the choice record
$newitemid = $DB->insert_record('choice', $data);
......@@ -70,7 +71,6 @@ class restore_choice_activity_structure_step extends restore_activity_structure_
$oldid = $data->id;
$data->choiceid = $this->get_new_parentid('choice');
$data->timemodified = $this->apply_date_offset($data->timemodified);
$newitemid = $DB->insert_record('choice_options', $data);
$this->set_mapping('choice_option', $oldid, $newitemid);
......@@ -84,7 +84,6 @@ class restore_choice_activity_structure_step extends restore_activity_structure_
$data->choiceid = $this->get_new_parentid('choice');
$data->optionid = $this->get_mappingid('choice_option', $data->optionid);
$data->userid = $this->get_mappingid('user', $data->userid);
$data->timemodified = $this->apply_date_offset($data->timemodified);
$newitemid = $DB->insert_record('choice_answers', $data);
// No need to save this mapping as far as nothing depend on it
......
......@@ -754,6 +754,8 @@ function choice_reset_userdata($data) {
/// updating dates - shift may be negative too
if ($data->timeshift) {
// Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
// See MDL-9367.
shift_course_mod_dates('choice', array('timeopen', 'timeclose'), $data->timeshift, $data->courseid);
$status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
}
......
<?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 date tests.
*
* @package mod_choice
* @copyright 2017 onwards Ankit Agarwal <ankit.agrr@gmail.com>
* @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 date tests.
*
* @package mod_choice
* @copyright 2017 onwards Ankit Agarwal <ankit.agrr@gmail.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class mod_choice_restore_date_testcase extends restore_date_testcase {
public function test_restore_dates() {
global $DB, $USER;
$time = 100000;
$record = ['timeopen' => $time, 'timeclose' => $time];
list($course, $choice) = $this->create_course_and_module('choice', $record);
$options = $DB->get_records('choice_options', ['choiceid' => $choice->id]);
$DB->set_field('choice_options', 'timemodified', $time);
$option = reset($options);
$cm = $DB->get_record('course_modules', ['id' => $choice->cmid]);
choice_user_submit_response($option->id, $choice, $USER->id, $course, $cm);
$answer = $DB->get_record('choice_answers', ['choiceid' => $choice->id]);
// Do backup and restore.
$newcourseid = $this->backup_and_restore($course);
$newchoice = $DB->get_record('choice', ['course' => $newcourseid]);
$newoptions = $DB->get_records('choice_options', ['choiceid' => $newchoice->id]);
$this->assertFieldsNotRolledForward($choice, $newchoice, ['timemodified']);
$props = ['timeopen', 'timeclose'];
$this->assertFieldsRolledForward($choice, $newchoice, $props);
// Options check.
foreach ($newoptions as $newoption) {
$this->assertEquals($time, $newoption->timemodified);
}
// Answers check.
$newanswer = $DB->get_record('choice_answers', ['choiceid' => $newchoice->id]);
$this->assertEquals($answer->timemodified, $newanswer->timemodified);
}
}
......@@ -55,14 +55,14 @@ class restore_data_activity_structure_step extends restore_activity_structure_st
$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->timeavailablefrom = $this->apply_date_offset($data->timeavailablefrom);
$data->timeavailableto = $this->apply_date_offset($data->timeavailableto);
$data->timeviewfrom = $this->apply_date_offset($data->timeviewfrom);
$data->timeviewto = $this->apply_date_offset($data->timeviewto);
$data->assesstimestart = $this->apply_date_offset($data->assesstimestart);
$data->assesstimefinish = $this->apply_date_offset($data->assesstimefinish);
// Added in 3.1, hence conditional.
$data->timemodified = isset($data->timemodified) ? $this->apply_date_offset($data->timemodified) : time();
if ($data->scale < 0) { // scale found, get mapping
$data->scale = -($this->get_mappingid('scale', abs($data->scale)));
......@@ -98,9 +98,6 @@ class restore_data_activity_structure_step extends restore_activity_structure_st
$data = (object)$data;
$oldid = $data->id;
$data->timecreated = $this->apply_date_offset($data->timecreated);
$data->timemodified = $this->apply_date_offset($data->timemodified);
$data->userid = $this->get_mappingid('user', $data->userid);
$data->groupid = $this->get_mappingid('group', $data->groupid);
$data->dataid = $this->get_new_parentid('data');
......@@ -137,8 +134,6 @@ class restore_data_activity_structure_step extends restore_activity_structure_st
}
$data->rating = $data->value;
$data->userid = $this->get_mappingid('user', $data->userid);
$data->timecreated = $this->apply_date_offset($data->timecreated);
$data->timemodified = $this->apply_date_offset($data->timemodified);
// We need to check that component and ratingarea are both set here.
if (empty($data->component)) {
......
......@@ -2872,7 +2872,10 @@ function data_reset_userdata($data) {
// updating dates - shift may be negative too
if ($data->timeshift) {
shift_course_mod_dates('data', array('timeavailablefrom', 'timeavailableto', 'timeviewfrom', 'timeviewto'), $data->timeshift, $data->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.
shift_course_mod_dates('data', array('timeavailablefrom', 'timeavailableto',
'timeviewfrom', 'timeviewto', 'assesstimestart', 'assesstimefinish'), $data->timeshift, $data->courseid);
$status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
}
......
<?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/>.
/**