[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 backup_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   * Provides all the settings and steps to perform one complete backup of the activity
  32   *
  33   * Activities are supposed to provide the subclass of this class in their file
  34   * mod/MODULENAME/backup/moodle2/backup_MODULENAME_activity_task.class.php
  35   * The expected name of the subclass is backup_MODULENAME_activity_task
  36   */
  37  abstract class backup_activity_task extends backup_task {
  38  
  39      protected $moduleid;
  40      protected $sectionid;
  41      protected $modulename;
  42      protected $activityid;
  43      protected $contextid;
  44  
  45      /**
  46       * Constructor - instantiates one object of this class
  47       *
  48       * @param string $name the task identifier
  49       * @param int $moduleid course module id (id in course_modules table)
  50       * @param backup_plan|null $plan the backup plan instance this task is part of
  51       */
  52      public function __construct($name, $moduleid, $plan = null) {
  53  
  54          // Check moduleid exists
  55          if (!$coursemodule = get_coursemodule_from_id(false, $moduleid)) {
  56              throw new backup_task_exception('activity_task_coursemodule_not_found', $moduleid);
  57          }
  58          // Check activity supports this moodle2 backup format
  59          if (!plugin_supports('mod', $coursemodule->modname, FEATURE_BACKUP_MOODLE2)) {
  60              throw new backup_task_exception('activity_task_activity_lacks_moodle2_backup_support', $coursemodule->modname);
  61          }
  62  
  63          $this->moduleid   = $moduleid;
  64          $this->sectionid  = $coursemodule->section;
  65          $this->modulename = $coursemodule->modname;
  66          $this->activityid = $coursemodule->instance;
  67          $this->contextid  = context_module::instance($this->moduleid)->id;
  68  
  69          parent::__construct($name, $plan);
  70      }
  71  
  72      /**
  73       * @return int the course module id (id in the course_modules table)
  74       */
  75      public function get_moduleid() {
  76          return $this->moduleid;
  77      }
  78  
  79      /**
  80       * @return int the course section id (id in the course_sections table)
  81       */
  82      public function get_sectionid() {
  83          return $this->sectionid;
  84      }
  85  
  86      /**
  87       * @return string the name of the module, eg 'workshop' (from the modules table)
  88       */
  89      public function get_modulename() {
  90          return $this->modulename;
  91      }
  92  
  93      /**
  94       * @return int the id of the activity instance (id in the activity's instances table)
  95       */
  96      public function get_activityid() {
  97          return $this->activityid;
  98      }
  99  
 100      /**
 101       * @return int the id of the associated CONTEXT_MODULE instance
 102       */
 103      public function get_contextid() {
 104          return $this->contextid;
 105      }
 106  
 107      /**
 108       * @return string full path to the directory where this task writes its files
 109       */
 110      public function get_taskbasepath() {
 111          return $this->get_basepath() . '/activities/' . $this->modulename . '_' . $this->moduleid;
 112      }
 113  
 114      /**
 115       * Create all the steps that will be part of this task
 116       */
 117      public function build() {
 118  
 119          // If we have decided not to backup activities, prevent anything to be built
 120          if (!$this->get_setting_value('activities')) {
 121              $this->built = true;
 122              return;
 123          }
 124  
 125          // Add some extra settings that related processors are going to need
 126          $this->add_setting(new backup_activity_generic_setting(backup::VAR_MODID, base_setting::IS_INTEGER, $this->moduleid));
 127          $this->add_setting(new backup_activity_generic_setting(backup::VAR_COURSEID, base_setting::IS_INTEGER, $this->get_courseid()));
 128          $this->add_setting(new backup_activity_generic_setting(backup::VAR_SECTIONID, base_setting::IS_INTEGER, $this->sectionid));
 129          $this->add_setting(new backup_activity_generic_setting(backup::VAR_MODNAME, base_setting::IS_FILENAME, $this->modulename));
 130          $this->add_setting(new backup_activity_generic_setting(backup::VAR_ACTIVITYID, base_setting::IS_INTEGER, $this->activityid));
 131          $this->add_setting(new backup_activity_generic_setting(backup::VAR_CONTEXTID, base_setting::IS_INTEGER, $this->contextid));
 132  
 133          // Create the activity directory
 134          $this->add_step(new create_taskbasepath_directory('create_activity_directory'));
 135  
 136          // Generate the module.xml file, containing general information for the
 137          // activity and from its related course_modules record and availability
 138          $this->add_step(new backup_module_structure_step('module_info', 'module.xml'));
 139  
 140          // Annotate the groups used in already annotated groupings
 141          $this->add_step(new backup_annotate_groups_from_groupings('annotate_groups'));
 142  
 143          // Here we add all the common steps for any activity and, in the point of interest
 144          // we call to define_my_steps() is order to get the particular ones inserted in place.
 145          $this->define_my_steps();
 146  
 147          // Generate the roles file (optionally role assignments and always role overrides)
 148          $this->add_step(new backup_roles_structure_step('activity_roles', 'roles.xml'));
 149  
 150          // Generate the filter file (conditionally)
 151          if ($this->get_setting_value('filters')) {
 152              $this->add_step(new backup_filters_structure_step('activity_filters', 'filters.xml'));
 153          }
 154  
 155          // Generate the comments file (conditionally)
 156          if ($this->get_setting_value('comments')) {
 157              $this->add_step(new backup_comments_structure_step('activity_comments', 'comments.xml'));
 158          }
 159  
 160          // Generate the userscompletion file (conditionally)
 161          if ($this->get_setting_value('userscompletion')) {
 162              $this->add_step(new backup_userscompletion_structure_step('activity_userscompletion', 'completion.xml'));
 163          }
 164  
 165          // Generate the logs file (conditionally)
 166          if ($this->get_setting_value('logs')) {
 167              $this->add_step(new backup_activity_logs_structure_step('activity_logs', 'logs.xml'));
 168          }
 169  
 170          // Generate the calendar events file (conditionally)
 171          if ($this->get_setting_value('calendarevents')) {
 172              $this->add_step(new backup_calendarevents_structure_step('activity_calendar', 'calendar.xml'));
 173          }
 174  
 175          // Fetch all the activity grade items and put them to backup_ids
 176          $this->add_step(new backup_activity_grade_items_to_ids('fetch_activity_grade_items'));
 177  
 178          // Generate the grades file
 179          $this->add_step(new backup_activity_grades_structure_step('activity_grades', 'grades.xml'));
 180  
 181          // Generate the grading file (conditionally)
 182          $this->add_step(new backup_activity_grading_structure_step('activity_grading', 'grading.xml'));
 183  
 184          // Generate the grade history file. The setting 'grade_histories' is handled in the step.
 185          $this->add_step(new backup_activity_grade_history_structure_step('activity_grade_history', 'grade_history.xml'));
 186  
 187          // Annotate the scales used in already annotated outcomes
 188          $this->add_step(new backup_annotate_scales_from_outcomes('annotate_scales'));
 189  
 190          // NOTE: Historical grade information is saved completely at course level only (see 1.9)
 191          // not per activity nor per selected activities (all or nothing).
 192  
 193          // Generate the inforef file (must be after ALL steps gathering annotations of ANY type)
 194          $this->add_step(new backup_inforef_structure_step('activity_inforef', 'inforef.xml'));
 195  
 196          // Migrate the already exported inforef entries to final ones
 197          $this->add_step(new move_inforef_annotations_to_final('migrate_inforef'));
 198  
 199          // At the end, mark it as built
 200          $this->built = true;
 201      }
 202  
 203      /**
 204       * Exceptionally override the execute method, so, based in the activity_included setting, we are able
 205       * to skip the execution of one task completely
 206       */
 207      public function execute() {
 208  
 209          // Find activity_included_setting
 210          if (!$this->get_setting_value('included')) {
 211              $this->log('activity skipped by _included setting', backup::LOG_DEBUG, $this->name);
 212              $this->plan->set_excluding_activities();
 213          } else { // Setting tells us it's ok to execute
 214              parent::execute();
 215          }
 216      }
 217  
 218  
 219      /**
 220       * Tries to look for the instance specific setting value, task specific setting value or the
 221       * common plan setting value - in that order
 222       *
 223       * @param string $name the name of the setting
 224       * @return mixed|null the value of the setting or null if not found
 225       */
 226      public function get_setting($name) {
 227          $namewithprefix = $this->modulename . '_' . $this->moduleid . '_' . $name;
 228          $result = null;
 229          foreach ($this->settings as $key => $setting) {
 230              if ($setting->get_name() == $namewithprefix) {
 231                  if ($result != null) {
 232                      throw new base_task_exception('multiple_settings_by_name_found', $namewithprefix);
 233                  } else {
 234                      $result = $setting;
 235                  }
 236              }
 237          }
 238          if ($result) {
 239              return $result;
 240          } else {
 241              // Fallback to parent
 242              return parent::get_setting($name);
 243          }
 244      }
 245  
 246  // Protected API starts here
 247  
 248      /**
 249       * Defines the common setting that any backup activity will have
 250       */
 251      protected function define_settings() {
 252          global $CFG;
 253          require_once($CFG->libdir.'/questionlib.php');
 254  
 255          // All the settings related to this activity will include this prefix
 256          $settingprefix = $this->modulename . '_' . $this->moduleid . '_';
 257  
 258          // All these are common settings to be shared by all activities
 259  
 260          // Define activity_include (to decide if the whole task must be really executed)
 261          // Dependent of:
 262          // - activities root setting
 263          // - section_included setting (if exists)
 264          $settingname = $settingprefix . 'included';
 265          $activity_included = new backup_activity_generic_setting($settingname, base_setting::IS_BOOLEAN, true);
 266          $activity_included->get_ui()->set_icon(new pix_icon('icon', get_string('pluginname', $this->modulename),
 267              $this->modulename, array('class' => 'iconlarge icon-post')));
 268          $this->add_setting($activity_included);
 269          // Look for "activities" root setting
 270          $activities = $this->plan->get_setting('activities');
 271          $activities->add_dependency($activity_included);
 272  
 273          if (question_module_uses_questions($this->modulename)) {
 274              $questionbank = $this->plan->get_setting('questionbank');
 275              $questionbank->add_dependency($activity_included);
 276          }
 277  
 278          // Look for "section_included" section setting (if exists)
 279          $settingname = 'section_' . $this->sectionid . '_included';
 280          if ($this->plan->setting_exists($settingname)) {
 281              $section_included = $this->plan->get_setting($settingname);
 282              $section_included->add_dependency($activity_included);
 283          }
 284  
 285          // Define activity_userinfo. Dependent of:
 286          // - users root setting
 287          // - section_userinfo setting (if exists)
 288          // - activity_included setting
 289          $settingname = $settingprefix . 'userinfo';
 290          $activity_userinfo = new backup_activity_userinfo_setting($settingname, base_setting::IS_BOOLEAN, true);
 291          //$activity_userinfo->get_ui()->set_label(get_string('includeuserinfo','backup'));
 292          $activity_userinfo->get_ui()->set_label('-');
 293          $this->add_setting($activity_userinfo);
 294          // Look for "users" root setting
 295          $users = $this->plan->get_setting('users');
 296          $users->add_dependency($activity_userinfo);
 297          // Look for "section_userinfo" section setting (if exists)
 298          $settingname = 'section_' . $this->sectionid . '_userinfo';
 299          if ($this->plan->setting_exists($settingname)) {
 300              $section_userinfo = $this->plan->get_setting($settingname);
 301              $section_userinfo->add_dependency($activity_userinfo);
 302          }
 303          // Look for "activity_included" setting
 304          $activity_included->add_dependency($activity_userinfo);
 305  
 306          // End of common activity settings, let's add the particular ones
 307          $this->define_my_settings();
 308      }
 309  
 310      /**
 311       * Defines activity specific settings to be added to the common ones
 312       *
 313       * This method is called from {@link self::define_settings()}. The activity module
 314       * author may use it to define additional settings that influence the execution of
 315       * the backup.
 316       *
 317       * Most activities just leave the method empty.
 318       *
 319       * @see self::define_settings() for the example how to define own settings
 320       */
 321      abstract protected function define_my_settings();
 322  
 323      /**
 324       * Defines activity specific steps for this task
 325       *
 326       * This method is called from {@link self::build()}. Activities are supposed
 327       * to call {self::add_step()} in it to include their specific steps in the
 328       * backup plan.
 329       */
 330      abstract protected function define_my_steps();
 331  
 332      /**
 333       * Encodes URLs to the activity instance's scripts into a site-independent form
 334       *
 335       * The current instance of the activity may be referenced from other places in
 336       * the course by URLs like http://my.moodle.site/mod/workshop/view.php?id=42
 337       * Obvisouly, such URLs are not valid any more once the course is restored elsewhere.
 338       * For this reason the backup file does not store the original URLs but encodes them
 339       * into a transportable form. During the restore, the reverse process is applied and
 340       * the encoded URLs are replaced with the new ones valid for the target site.
 341       *
 342       * Every plugin must override this method in its subclass.
 343       *
 344       * @see backup_xml_transformer class that actually runs the transformation
 345       * @param string $content some HTML text that eventually contains URLs to the activity instance scripts
 346       * @return string the content with the URLs encoded
 347       */
 348      static public function encode_content_links($content) {
 349          throw new coding_exception('encode_content_links() method needs to be overridden in each subclass of backup_activity_task');
 350      }
 351  }