[Summary view] [Print] [Text view]

   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      public function get_old_moduleversion() {
 104          return $this->oldmoduleversion;
 105      }
 106  
 107      public function get_activityid() {
 108          return $this->activityid;
 109      }
 110  
 111      public function get_old_activityid() {
 112          return $this->oldactivityid;
 113      }
 114  
 115      public function get_contextid() {
 116          return $this->contextid;
 117      }
 118  
 119      public function get_old_contextid() {
 120          return $this->oldcontextid;
 121      }
 122  
 123      /**
 124       * Create all the steps that will be part of this task
 125       */
 126      public function build() {
 127  
 128          // If we have decided not to restore activities, prevent anything to be built
 129          if (!$this->get_setting_value('activities')) {
 130              $this->built = true;
 131              return;
 132          }
 133  
 134          // Load he course_module estructure, generating it (with instance = 0)
 135          // but allowing the creation of the target context needed in following steps
 136          $this->add_step(new restore_module_structure_step('module_info', 'module.xml'));
 137  
 138          // Here we add all the common steps for any activity and, in the point of interest
 139          // we call to define_my_steps() is order to get the particular ones inserted in place.
 140          $this->define_my_steps();
 141  
 142          // Roles (optionally role assignments and always role overrides)
 143          $this->add_step(new restore_ras_and_caps_structure_step('course_ras_and_caps', 'roles.xml'));
 144  
 145          // Filters (conditionally)
 146          if ($this->get_setting_value('filters')) {
 147              $this->add_step(new restore_filters_structure_step('activity_filters', 'filters.xml'));
 148          }
 149  
 150          // Comments (conditionally)
 151          if ($this->get_setting_value('comments')) {
 152              $this->add_step(new restore_comments_structure_step('activity_comments', 'comments.xml'));
 153          }
 154  
 155          // Calendar events (conditionally)
 156          if ($this->get_setting_value('calendarevents')) {
 157              $this->add_step(new restore_calendarevents_structure_step('activity_calendar', 'calendar.xml'));
 158          }
 159  
 160          // Grades (module-related, rest of gradebook is restored later if possible: cats, calculations...)
 161          $this->add_step(new restore_activity_grades_structure_step('activity_grades', 'grades.xml'));
 162  
 163          // Advanced grading methods attached to the module
 164          $this->add_step(new restore_activity_grading_structure_step('activity_grading', 'grading.xml'));
 165  
 166          // Grade history. The setting 'grade_history' is handled in the step.
 167          $this->add_step(new restore_activity_grade_history_structure_step('activity_grade_history', 'grade_history.xml'));
 168  
 169          // Userscompletion (conditionally)
 170          if ($this->get_setting_value('userscompletion')) {
 171              $this->add_step(new restore_userscompletion_structure_step('activity_userscompletion', 'completion.xml'));
 172          }
 173  
 174          // Logs (conditionally)
 175          if ($this->get_setting_value('logs')) {
 176              $this->add_step(new restore_activity_logs_structure_step('activity_logs', 'logs.xml'));
 177          }
 178  
 179          // At the end, mark it as built
 180          $this->built = true;
 181      }
 182  
 183      /**
 184       * Exceptionally override the execute method, so, based in the activity_included setting, we are able
 185       * to skip the execution of one task completely
 186       */
 187      public function execute() {
 188  
 189          // Find activity_included_setting
 190          if (!$this->get_setting_value('included')) {
 191              $this->log('activity skipped by _included setting', backup::LOG_DEBUG, $this->name);
 192              $this->plan->set_excluding_activities(); // Inform plan we are excluding actvities
 193  
 194          } else { // Setting tells us it's ok to execute
 195              parent::execute();
 196          }
 197      }
 198  
 199  
 200      /**
 201       * Specialisation that, first of all, looks for the setting within
 202       * the task with the the prefix added and later, delegates to parent
 203       * without adding anything
 204       */
 205      public function get_setting($name) {
 206          $namewithprefix = $this->info->modulename . '_' . $this->info->moduleid . '_' . $name;
 207          $result = null;
 208          foreach ($this->settings as $key => $setting) {
 209              if ($setting->get_name() == $namewithprefix) {
 210                  if ($result != null) {
 211                      throw new base_task_exception('multiple_settings_by_name_found', $namewithprefix);
 212                  } else {
 213                      $result = $setting;
 214                  }
 215              }
 216          }
 217          if ($result) {
 218              return $result;
 219          } else {
 220              // Fallback to parent
 221              return parent::get_setting($name);
 222          }
 223      }
 224  
 225      /**
 226       * Given a commment area, return the itemname that contains the itemid mappings
 227       *
 228       * By default both are the same (commentarea = itemname), so return it. If some
 229       * module uses a different approach, this method can be overriden in its taks
 230       */
 231      public function get_comment_mapping_itemname($commentarea) {
 232          return $commentarea;
 233      }
 234  
 235      /**
 236       * Define (add) particular steps that each activity can have
 237       */
 238      abstract protected function define_my_steps();
 239  
 240      /**
 241       * Define the contents in the activity that must be
 242       * processed by the link decoder
 243       */
 244      static public function define_decode_contents() {
 245          throw new coding_exception('define_decode_contents() method needs to be overridden in each subclass of restore_activity_task');
 246      }
 247  
 248      /**
 249       * Define the decoding rules for links belonging
 250       * to the activity to be executed by the link decoder
 251       */
 252      static public function define_decode_rules() {
 253          throw new coding_exception('define_decode_rules() method needs to be overridden in each subclass of restore_activity_task');
 254      }
 255  
 256      /**
 257       * Define the restore log rules that will be applied
 258       * by the {@link restore_logs_processor} when restoring
 259       * activity logs. It must return one array
 260       * of {@link restore_log_rule} objects
 261       */
 262      static public function define_restore_log_rules() {
 263          throw new coding_exception('define_restore_log_rules() method needs to be overridden in each subclass of restore_activity_task');
 264      }
 265  
 266  // Protected API starts here
 267  
 268      /**
 269       * Define the common setting that any restore activity will have
 270       */
 271      protected function define_settings() {
 272  
 273          // All the settings related to this activity will include this prefix
 274          $settingprefix = $this->info->modulename . '_' . $this->info->moduleid . '_';
 275  
 276          // All these are common settings to be shared by all activities
 277  
 278          // Define activity_include (to decide if the whole task must be really executed)
 279          // Dependent of:
 280          // - activities root setting
 281          // - section_included setting (if exists)
 282          $settingname = $settingprefix . 'included';
 283          $activity_included = new restore_activity_generic_setting($settingname, base_setting::IS_BOOLEAN, true);
 284          $activity_included->get_ui()->set_icon(new pix_icon('icon', get_string('pluginname', $this->modulename),
 285              $this->modulename, array('class' => 'iconlarge icon-post')));
 286          $this->add_setting($activity_included);
 287          // Look for "activities" root setting
 288          $activities = $this->plan->get_setting('activities');
 289          $activities->add_dependency($activity_included);
 290          // Look for "section_included" section setting (if exists)
 291          $settingname = 'section_' . $this->info->sectionid . '_included';
 292          if ($this->plan->setting_exists($settingname)) {
 293              $section_included = $this->plan->get_setting($settingname);
 294              $section_included->add_dependency($activity_included);
 295          }
 296  
 297          // Define activity_userinfo. Dependent of:
 298          // - users root setting
 299          // - section_userinfo setting (if exists)
 300          // - activity_included setting.
 301          $settingname = $settingprefix . 'userinfo';
 302          $defaultvalue = false;
 303          if (isset($this->info->settings[$settingname]) && $this->info->settings[$settingname]) { // Only enabled when available
 304              $defaultvalue = true;
 305          }
 306  
 307          $activity_userinfo = new restore_activity_userinfo_setting($settingname, base_setting::IS_BOOLEAN, $defaultvalue);
 308          if (!$defaultvalue) {
 309              // This is a bit hacky, but if there is no user data to restore, then
 310              // we replace the standard check-box with a select menu with the
 311              // single choice 'No', and the select menu is clever enough that if
 312              // there is only one choice, it just displays a static string.
 313              //
 314              // It would probably be better design to have a special UI class
 315              // setting_ui_checkbox_or_no, rather than this hack, but I am not
 316              // going to do that today.
 317              $activity_userinfo->set_ui(new backup_setting_ui_select($activity_userinfo, '-',
 318                      array(0 => get_string('no'))));
 319          } else {
 320              $activity_userinfo->get_ui()->set_label('-');
 321          }
 322  
 323          $this->add_setting($activity_userinfo);
 324  
 325          // Look for "users" root setting
 326          $users = $this->plan->get_setting('users');
 327          $users->add_dependency($activity_userinfo);
 328  
 329          // Look for "section_userinfo" section setting (if exists)
 330          $settingname = 'section_' . $this->info->sectionid . '_userinfo';
 331          if ($this->plan->setting_exists($settingname)) {
 332              $section_userinfo = $this->plan->get_setting($settingname);
 333              $section_userinfo->add_dependency($activity_userinfo);
 334          }
 335  
 336          // Look for "activity_included" setting.
 337          $activity_included->add_dependency($activity_userinfo);
 338  
 339          // End of common activity settings, let's add the particular ones.
 340          $this->define_my_settings();
 341      }
 342  
 343      /**
 344       * Define (add) particular settings that each activity can have
 345       */
 346      abstract protected function define_my_settings();
 347  }