backup/moodle2/restore_course_task.class.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * Defines restore_course_task class
  20  *
  21  * @package     core_backup
  22  * @subpackage  moodle2
  23  * @category    backup
  24  * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
  25  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  26  */
  27
  28 defined('MOODLE_INTERNAL') || die();
  29
  30 /**
  31  * course task that provides all the properties and common steps to be performed
  32  * when one course is being restored
  33  *
  34  * TODO: Finish phpdocs
  35  */
  36 class restore_course_task extends restore_task {
  37
  38     protected $info; // info related to course gathered from backup file
  39     protected $contextid; // course context id
  40
  41     /**
  42      * Constructor - instantiates one object of this class
  43      */
  44     public function __construct($name, $info, $plan = null) {
  45         $this->info = $info;
  46         parent::__construct($name, $plan);
  47     }
  48
  49     /**
  50      * Course tasks have their own directory to read files
  51      */
  52     public function get_taskbasepath() {
  53
  54         return $this->get_basepath() . '/course';
  55     }
  56
  57     public function get_contextid() {
  58         return $this->contextid;
  59     }
  60
  61     /**
  62      * Create all the steps that will be part of this task
  63      */
  64     public function build() {
  65
  66         // Define the task contextid (the course one)
  67         $this->contextid = context_course::instance($this->get_courseid())->id;
  68
  69         // Executed conditionally if restoring to new course or if overwrite_conf setting is enabled
  70         if ($this->get_target() == backup::TARGET_NEW_COURSE || $this->get_setting_value('overwrite_conf') == true) {
  71             $this->add_step(new restore_course_structure_step('course_info', 'course.xml'));
  72         }
  73
  74         $this->add_step(new restore_course_legacy_files_step('legacy_files'));
  75
  76         // Deal with enrolment methods and user enrolments.
  77         if ($this->plan->get_mode() == backup::MODE_IMPORT) {
  78             // No need to do anything with enrolments.
  79
  80         } else if (!$this->get_setting_value('users') or $this->plan->get_mode() == backup::MODE_HUB) {
  81             if ($this->get_setting_value('enrolments') == backup::ENROL_ALWAYS && $this->plan->get_mode() != backup::MODE_HUB) {
  82                 // Restore enrolment methods.
  83                 $this->add_step(new restore_enrolments_structure_step('course_enrolments', 'enrolments.xml'));
  84             } else if ($this->get_target() == backup::TARGET_CURRENT_ADDING or $this->get_target() == backup::TARGET_EXISTING_ADDING) {
  85                 // Keep current enrolments unchanged.
  86             } else {
  87                 // If no instances yet add default enrol methods the same way as when creating new course in UI.
  88                 $this->add_step(new restore_default_enrolments_step('default_enrolments'));
  89             }
  90
  91         } else {
  92             // Restore course enrolment data.
  93             $this->add_step(new restore_enrolments_structure_step('course_enrolments', 'enrolments.xml'));
  94         }
  95
  96         // Populate groups, this must be done after enrolments because only enrolled users may be in groups.
  97         $this->add_step(new restore_groups_members_structure_step('create_groups_members', '../groups.xml'));
  98
  99         // Restore course role assignments and overrides (internally will observe the role_assignments setting),
 100         // this must be done after all users are enrolled.
 101         $this->add_step(new restore_ras_and_caps_structure_step('course_ras_and_caps', 'roles.xml'));
 102
 103         // Restore course filters (conditionally)
 104         if ($this->get_setting_value('filters')) {
 105             $this->add_step(new restore_filters_structure_step('course_filters', 'filters.xml'));
 106         }
 107
 108         // Restore course comments (conditionally)
 109         if ($this->get_setting_value('comments')) {
 110             $this->add_step(new restore_comments_structure_step('course_comments', 'comments.xml'));
 111         }
 112
 113         // Calendar events (conditionally)
 114         if ($this->get_setting_value('calendarevents')) {
 115             $this->add_step(new restore_calendarevents_structure_step('course_calendar', 'calendar.xml'));
 116         }
 117
 118         // Course competencies.
 119         $this->add_step(new restore_course_competencies_structure_step('course_competencies', 'competencies.xml'));
 120
 121         // Activity completion defaults.
 122         $this->add_step(new restore_completion_defaults_structure_step('course_completion_defaults', 'completiondefaults.xml'));
 123
 124         // At the end, mark it as built
 125         $this->built = true;
 126     }
 127
 128     /**
 129      * Define the contents in the course that must be
 130      * processed by the link decoder
 131      */
 132     static public function define_decode_contents() {
 133         $contents = array();
 134
 135         $contents[] = new restore_decode_content('course', 'summary');
 136         $contents[] = new restore_decode_content('event', 'description');
 137
 138         return $contents;
 139     }
 140
 141     /**
 142      * Define the decoding rules for links belonging
 143      * to the course to be executed by the link decoder
 144      */
 145     static public function define_decode_rules() {
 146         $rules = array();
 147
 148         // Link to the course main page (it also covers "&topic=xx" and "&week=xx"
 149         // because they don't become transformed (section number) in backup/restore.
 150         $rules[] = new restore_decode_rule('COURSEVIEWBYID',       '/course/view.php?id=$1',        'course');
 151
 152         // A few other key course links.
 153         $rules[] = new restore_decode_rule('GRADEINDEXBYID',       '/grade/index.php?id=$1',        'course');
 154         $rules[] = new restore_decode_rule('GRADEREPORTINDEXBYID', '/grade/report/index.php?id=$1', 'course');
 155         $rules[] = new restore_decode_rule('BADGESVIEWBYID',       '/badges/view.php?type=2&id=$1', 'course');
 156         $rules[] = new restore_decode_rule('USERINDEXVIEWBYID',    '/user/index.php?id=$1',         'course');
 157
 158         return $rules;
 159     }
 160
 161 // Protected API starts here
 162
 163     /**
 164      * Define the common setting that any restore course will have
 165      */
 166     protected function define_settings() {
 167
 168         // Define overwrite_conf to decide if course configuration will be restored over existing one.
 169         $overwrite = new restore_course_overwrite_conf_setting('overwrite_conf', base_setting::IS_BOOLEAN, false);
 170         $overwrite->set_ui(new backup_setting_ui_select($overwrite, $overwrite->get_name(),
 171             array(1 => get_string('yes'), 0 => get_string('no'))));
 172         $overwrite->get_ui()->set_label(get_string('setting_overwrite_conf', 'backup'));
 173         if ($this->get_target() == backup::TARGET_NEW_COURSE) {
 174             $overwrite->set_value(true);
 175             $overwrite->set_status(backup_setting::LOCKED_BY_CONFIG);
 176             $overwrite->set_visibility(backup_setting::HIDDEN);
 177             $course = (object)['fullname' => null, 'shortname' => null, 'startdate' => null];
 178         } else {
 179             $course = get_course($this->get_courseid());
 180         }
 181         $this->add_setting($overwrite);
 182
 183         $fullnamedefaultvalue = $this->get_info()->original_course_fullname;
 184         $fullname = new restore_course_defaultcustom_setting('course_fullname', base_setting::IS_TEXT, $fullnamedefaultvalue);
 185         $fullname->set_ui(new backup_setting_ui_defaultcustom($fullname, get_string('setting_course_fullname', 'backup'),
 186             ['customvalue' => $fullnamedefaultvalue, 'defaultvalue' => $course->fullname]));
 187         $this->add_setting($fullname);
 188
 189         $shortnamedefaultvalue = $this->get_info()->original_course_shortname;
 190         $shortname = new restore_course_defaultcustom_setting('course_shortname', base_setting::IS_TEXT, $shortnamedefaultvalue);
 191         $shortname->set_ui(new backup_setting_ui_defaultcustom($shortname, get_string('setting_course_shortname', 'backup'),
 192             ['customvalue' => $shortnamedefaultvalue, 'defaultvalue' => $course->shortname]));
 193         $this->add_setting($shortname);
 194
 195         $startdatedefaultvalue = $this->get_info()->original_course_startdate;
 196         $startdate = new restore_course_defaultcustom_setting('course_startdate', base_setting::IS_INTEGER, $startdatedefaultvalue);
 197         $startdate->set_ui(new backup_setting_ui_defaultcustom($startdate, get_string('setting_course_startdate', 'backup'),
 198             ['customvalue' => $startdatedefaultvalue, 'defaultvalue' => $course->startdate, 'type' => 'date_selector']));
 199         $this->add_setting($startdate);
 200
 201         $keep_enrols = new restore_course_generic_setting('keep_roles_and_enrolments', base_setting::IS_BOOLEAN, false);
 202         $keep_enrols->set_ui(new backup_setting_ui_select($keep_enrols, $keep_enrols->get_name(), array(1=>get_string('yes'), 0=>get_string('no'))));
 203         $keep_enrols->get_ui()->set_label(get_string('setting_keep_roles_and_enrolments', 'backup'));
 204         if ($this->get_target() != backup::TARGET_CURRENT_DELETING and $this->get_target() != backup::TARGET_EXISTING_DELETING) {
 205             $keep_enrols->set_value(false);
 206             $keep_enrols->set_status(backup_setting::LOCKED_BY_CONFIG);
 207             $keep_enrols->set_visibility(backup_setting::HIDDEN);
 208         }
 209         $this->add_setting($keep_enrols);
 210
 211         $keep_groups = new restore_course_generic_setting('keep_groups_and_groupings', base_setting::IS_BOOLEAN, false);
 212         $keep_groups->set_ui(new backup_setting_ui_select($keep_groups, $keep_groups->get_name(), array(1=>get_string('yes'), 0=>get_string('no'))));
 213         $keep_groups->get_ui()->set_label(get_string('setting_keep_groups_and_groupings', 'backup'));
 214         if ($this->get_target() != backup::TARGET_CURRENT_DELETING and $this->get_target() != backup::TARGET_EXISTING_DELETING) {
 215             $keep_groups->set_value(false);
 216             $keep_groups->set_status(backup_setting::LOCKED_BY_CONFIG);
 217             $keep_groups->set_visibility(backup_setting::HIDDEN);
 218         }
 219         $this->add_setting($keep_groups);
 220
 221     }
 222 }