backup/moodle2/restore_activity_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_activity_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  * abstract activity task that provides all the properties and common tasks to be performed
  32  * when one activity is being restored
  33  *
  34  * TODO: Finish phpdocs
  35  */
  36 abstract class restore_activity_task extends restore_task {
  37
  38     protected $info; // info related to activity gathered from backup file
  39     protected $modulename;  // name of the module
  40     protected $moduleid;    // new (target) id of the course module
  41     protected $oldmoduleid; // old (original) id of the course module
  42     protected $oldmoduleversion; // old (original) version of the module
  43     protected $contextid;   // new (target) context of the activity
  44     protected $oldcontextid;// old (original) context of the activity
  45     protected $activityid;  // new (target) id of the activity
  46     protected $oldactivityid;// old (original) id of the activity
  47
  48     /**
  49      * Constructor - instantiates one object of this class
  50      */
  51     public function __construct($name, $info, $plan = null) {
  52         $this->info = $info;
  53         $this->modulename = $this->info->modulename;
  54         $this->moduleid = 0;
  55         $this->oldmoduleid = $this->info->moduleid;
  56         $this->oldmoduleversion = 0;
  57         $this->contextid = 0;
  58         $this->oldcontextid = 0;
  59         $this->activityid = 0;
  60         $this->oldactivityid = 0;
  61         parent::__construct($name, $plan);
  62     }
  63
  64     /**
  65      * Activity tasks have their own directory to read files
  66      */
  67     public function get_taskbasepath() {
  68         return $this->get_basepath() . '/' . $this->info->directory;
  69     }
  70
  71     public function set_moduleid($moduleid) {
  72         $this->moduleid = $moduleid;
  73     }
  74
  75     public function set_old_moduleversion($oldmoduleversion) {
  76         $this->oldmoduleversion = $oldmoduleversion;
  77     }
  78
  79     public function set_activityid($activityid) {
  80         $this->activityid = $activityid;
  81     }
  82
  83     public function set_old_activityid($activityid) {
  84         $this->oldactivityid = $activityid;
  85     }
  86
  87     public function set_contextid($contextid) {
  88         $this->contextid = $contextid;
  89     }
  90
  91     public function set_old_contextid($contextid) {
  92         $this->oldcontextid = $contextid;
  93     }
  94
  95     public function get_modulename() {
  96         return $this->modulename;
  97     }
  98
  99     public function get_moduleid() {
 100         return $this->moduleid;
 101     }
 102
 103     /**
 104      * Returns the old course module id (cmid of activity which will be restored)
 105      *
 106      * @return int
 107      */
 108     public function get_old_moduleid() {
 109         return $this->oldmoduleid;
 110     }
 111
 112     public function get_old_moduleversion() {
 113         return $this->oldmoduleversion;
 114     }
 115
 116     public function get_activityid() {
 117         return $this->activityid;
 118     }
 119
 120     public function get_old_activityid() {
 121         return $this->oldactivityid;
 122     }
 123
 124     public function get_contextid() {
 125         return $this->contextid;
 126     }
 127
 128     public function get_old_contextid() {
 129         return $this->oldcontextid;
 130     }
 131
 132     /**
 133      * Create all the steps that will be part of this task
 134      */
 135     public function build() {
 136
 137         // If we have decided not to restore activities, prevent anything to be built
 138         if (!$this->get_setting_value('activities')) {
 139             $this->built = true;
 140             return;
 141         }
 142
 143         // Load he course_module estructure, generating it (with instance = 0)
 144         // but allowing the creation of the target context needed in following steps
 145         $this->add_step(new restore_module_structure_step('module_info', 'module.xml'));
 146
 147         // Here we add all the common steps for any activity and, in the point of interest
 148         // we call to define_my_steps() is order to get the particular ones inserted in place.
 149         $this->define_my_steps();
 150
 151         // Roles (optionally role assignments and always role overrides)
 152         $this->add_step(new restore_ras_and_caps_structure_step('course_ras_and_caps', 'roles.xml'));
 153
 154         // Filters (conditionally)
 155         if ($this->get_setting_value('filters')) {
 156             $this->add_step(new restore_filters_structure_step('activity_filters', 'filters.xml'));
 157         }
 158
 159         // Comments (conditionally)
 160         if ($this->get_setting_value('comments')) {
 161             $this->add_step(new restore_comments_structure_step('activity_comments', 'comments.xml'));
 162         }
 163
 164         // Calendar events (conditionally)
 165         if ($this->get_setting_value('calendarevents')) {
 166             $this->add_step(new restore_calendarevents_structure_step('activity_calendar', 'calendar.xml'));
 167         }
 168
 169         // Grades (module-related, rest of gradebook is restored later if possible: cats, calculations...)
 170         $this->add_step(new restore_activity_grades_structure_step('activity_grades', 'grades.xml'));
 171
 172         // Advanced grading methods attached to the module
 173         $this->add_step(new restore_activity_grading_structure_step('activity_grading', 'grading.xml'));
 174
 175         // Grade history. The setting 'grade_history' is handled in the step.
 176         $this->add_step(new restore_activity_grade_history_structure_step('activity_grade_history', 'grade_history.xml'));
 177
 178         // Userscompletion (conditionally)
 179         if ($this->get_setting_value('userscompletion')) {
 180             $this->add_step(new restore_userscompletion_structure_step('activity_userscompletion', 'completion.xml'));
 181         }
 182
 183         // Logs (conditionally)
 184         if ($this->get_setting_value('logs')) {
 185             // Legacy logs.
 186             $this->add_step(new restore_activity_logs_structure_step('activity_logs', 'logs.xml'));
 187             // New log stores.
 188             $this->add_step(new restore_activity_logstores_structure_step('activity_logstores', 'logstores.xml'));
 189         }
 190
 191         // Activity competencies.
 192         $this->add_step(new restore_activity_competencies_structure_step('activity_competencies', 'competencies.xml'));
 193
 194         // Search reindexing, if enabled and if not restoring entire course.
 195         if (\core_search\manager::is_indexing_enabled()) {
 196             $wholecourse = $this->get_target() == backup::TARGET_NEW_COURSE;
 197             $wholecourse = $wholecourse || ($this->setting_exists('overwrite_conf') && $this->get_setting_value('overwrite_conf'));
 198             if (!$wholecourse) {
 199                 $this->add_step(new restore_activity_search_index('activity_search_index'));
 200             }
 201         }
 202
 203         // At the end, mark it as built
 204         $this->built = true;
 205     }
 206
 207     /**
 208      * Exceptionally override the execute method, so, based in the activity_included setting, we are able
 209      * to skip the execution of one task completely
 210      */
 211     public function execute() {
 212
 213         // Find activity_included_setting
 214         if (!$this->get_setting_value('included')) {
 215             $this->log('activity skipped by _included setting', backup::LOG_DEBUG, $this->name);
 216             $this->plan->set_excluding_activities(); // Inform plan we are excluding actvities
 217
 218         } else { // Setting tells us it's ok to execute
 219             parent::execute();
 220         }
 221     }
 222
 223
 224     /**
 225      * Specialisation that, first of all, looks for the setting within
 226      * the task with the the prefix added and later, delegates to parent
 227      * without adding anything
 228      */
 229     public function get_setting($name) {
 230         $namewithprefix = $this->info->modulename . '_' . $this->info->moduleid . '_' . $name;
 231         $result = null;
 232         foreach ($this->settings as $key => $setting) {
 233             if ($setting->get_name() == $namewithprefix) {
 234                 if ($result != null) {
 235                     throw new base_task_exception('multiple_settings_by_name_found', $namewithprefix);
 236                 } else {
 237                     $result = $setting;
 238                 }
 239             }
 240         }
 241         if ($result) {
 242             return $result;
 243         } else {
 244             // Fallback to parent
 245             return parent::get_setting($name);
 246         }
 247     }
 248
 249     /**
 250      * Given a commment area, return the itemname that contains the itemid mappings
 251      *
 252      * By default both are the same (commentarea = itemname), so return it. If some
 253      * module uses a different approach, this method can be overriden in its taks
 254      */
 255     public function get_comment_mapping_itemname($commentarea) {
 256         return $commentarea;
 257     }
 258
 259     /**
 260      * Define (add) particular steps that each activity can have
 261      */
 262     abstract protected function define_my_steps();
 263
 264     /**
 265      * Define the contents in the activity that must be
 266      * processed by the link decoder
 267      */
 268     static public function define_decode_contents() {
 269         throw new coding_exception('define_decode_contents() method needs to be overridden in each subclass of restore_activity_task');
 270     }
 271
 272     /**
 273      * Define the decoding rules for links belonging
 274      * to the activity to be executed by the link decoder
 275      */
 276     static public function define_decode_rules() {
 277         throw new coding_exception('define_decode_rules() method needs to be overridden in each subclass of restore_activity_task');
 278     }
 279
 280     /**
 281      * Define the restore log rules that will be applied
 282      * by the {@link restore_logs_processor} when restoring
 283      * activity logs. It must return one array
 284      * of {@link restore_log_rule} objects
 285      */
 286     static public function define_restore_log_rules() {
 287         throw new coding_exception('define_restore_log_rules() method needs to be overridden in each subclass of restore_activity_task');
 288     }
 289
 290 // Protected API starts here
 291
 292     /**
 293      * Define the common setting that any restore activity will have
 294      */
 295     protected function define_settings() {
 296
 297         // All the settings related to this activity will include this prefix
 298         $settingprefix = $this->info->modulename . '_' . $this->info->moduleid . '_';
 299
 300         // All these are common settings to be shared by all activities
 301
 302         // Define activity_include (to decide if the whole task must be really executed)
 303         // Dependent of:
 304         // - activities root setting
 305         // - section_included setting (if exists)
 306         $settingname = $settingprefix . 'included';
 307         $activity_included = new restore_activity_generic_setting($settingname, base_setting::IS_BOOLEAN, true);
 308         $activity_included->get_ui()->set_icon(new image_icon('monologo', get_string('pluginname', $this->modulename),
 309             $this->modulename, array('class' => 'iconlarge icon-post ml-1')));
 310         $this->add_setting($activity_included);
 311         // Look for "activities" root setting
 312         $activities = $this->plan->get_setting('activities');
 313         $activities->add_dependency($activity_included);
 314         // Look for "section_included" section setting (if exists)
 315         $settingname = 'section_' . $this->info->sectionid . '_included';
 316         if ($this->plan->setting_exists($settingname)) {
 317             $section_included = $this->plan->get_setting($settingname);
 318             $section_included->add_dependency($activity_included);
 319         }
 320
 321         // Define activity_userinfo. Dependent of:
 322         // - users root setting
 323         // - section_userinfo setting (if exists)
 324         // - activity_included setting.
 325         $settingname = $settingprefix . 'userinfo';
 326         $defaultvalue = false;
 327         if (isset($this->info->settings[$settingname]) && $this->info->settings[$settingname]) { // Only enabled when available
 328             $defaultvalue = true;
 329         }
 330
 331         $activity_userinfo = new restore_activity_userinfo_setting($settingname, base_setting::IS_BOOLEAN, $defaultvalue);
 332         if (!$defaultvalue) {
 333             // This is a bit hacky, but if there is no user data to restore, then
 334             // we replace the standard check-box with a select menu with the
 335             // single choice 'No', and the select menu is clever enough that if
 336             // there is only one choice, it just displays a static string.
 337             //
 338             // It would probably be better design to have a special UI class
 339             // setting_ui_checkbox_or_no, rather than this hack, but I am not
 340             // going to do that today.
 341             $activity_userinfo->set_ui(new backup_setting_ui_select($activity_userinfo, '-',
 342                     array(0 => get_string('no'))));
 343         } else {
 344             $activity_userinfo->get_ui()->set_label('-');
 345         }
 346
 347         $this->add_setting($activity_userinfo);
 348
 349         // Look for "users" root setting
 350         $users = $this->plan->get_setting('users');
 351         $users->add_dependency($activity_userinfo);
 352
 353         // Look for "section_userinfo" section setting (if exists)
 354         $settingname = 'section_' . $this->info->sectionid . '_userinfo';
 355         if ($this->plan->setting_exists($settingname)) {
 356             $section_userinfo = $this->plan->get_setting($settingname);
 357             $section_userinfo->add_dependency($activity_userinfo);
 358         }
 359
 360         // Look for "activity_included" setting.
 361         $activity_included->add_dependency($activity_userinfo);
 362
 363         // End of common activity settings, let's add the particular ones.
 364         $this->define_my_settings();
 365     }
 366
 367     /**
 368      * Define (add) particular settings that each activity can have
 369      */
 370     abstract protected function define_my_settings();
 371 }