[Summary view]

Differences Between: [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403]

   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_plan_builder 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  require_once($CFG->dirroot . '/backup/moodle2/backup_root_task.class.php');
  31  require_once($CFG->dirroot . '/backup/moodle2/backup_activity_task.class.php');
  32  require_once($CFG->dirroot . '/backup/moodle2/backup_section_task.class.php');
  33  require_once($CFG->dirroot . '/backup/moodle2/backup_course_task.class.php');
  34  require_once($CFG->dirroot . '/backup/moodle2/backup_final_task.class.php');
  35  require_once($CFG->dirroot . '/backup/moodle2/backup_block_task.class.php');
  36  require_once($CFG->dirroot . '/backup/moodle2/backup_default_block_task.class.php');
  37  require_once($CFG->dirroot . '/backup/moodle2/backup_xml_transformer.class.php');
  38  require_once($CFG->dirroot . '/backup/moodle2/backup_plugin.class.php');
  39  require_once($CFG->dirroot . '/backup/moodle2/backup_qtype_plugin.class.php');
  40  require_once($CFG->dirroot . '/backup/moodle2/backup_qtype_extrafields_plugin.class.php');
  41  require_once($CFG->dirroot . '/backup/moodle2/backup_gradingform_plugin.class.php');
  42  require_once($CFG->dirroot . '/backup/moodle2/backup_format_plugin.class.php');
  43  require_once($CFG->dirroot . '/backup/moodle2/backup_local_plugin.class.php');
  44  require_once($CFG->dirroot . '/backup/moodle2/backup_theme_plugin.class.php');
  45  require_once($CFG->dirroot . '/backup/moodle2/backup_report_plugin.class.php');
  46  require_once($CFG->dirroot . '/backup/moodle2/backup_coursereport_plugin.class.php');
  47  require_once($CFG->dirroot . '/backup/moodle2/backup_plagiarism_plugin.class.php');
  48  require_once($CFG->dirroot . '/backup/moodle2/backup_enrol_plugin.class.php');
  49  require_once($CFG->dirroot . '/backup/moodle2/backup_subplugin.class.php');
  50  require_once($CFG->dirroot . '/backup/moodle2/backup_settingslib.php');
  51  require_once($CFG->dirroot . '/backup/moodle2/backup_stepslib.php');
  52  require_once($CFG->dirroot . '/backup/moodle2/backup_custom_fields.php');
  53  
  54  // Load all the activity tasks for moodle2 format
  55  $mods = core_component::get_plugin_list('mod');
  56  foreach ($mods as $mod => $moddir) {
  57      $taskpath = $moddir . '/backup/moodle2/backup_' . $mod . '_activity_task.class.php';
  58      if (plugin_supports('mod', $mod, FEATURE_BACKUP_MOODLE2)) {
  59          if (file_exists($taskpath)) {
  60              require_once($taskpath);
  61          }
  62      }
  63  }
  64  
  65  // Load all the block tasks for moodle2 format
  66  $blocks = core_component::get_plugin_list('block');
  67  foreach ($blocks as $block => $blockdir) {
  68      $taskpath = $blockdir . '/backup/moodle2/backup_' . $block . '_block_task.class.php';
  69      if (file_exists($taskpath)) {
  70          require_once($taskpath);
  71      }
  72  }
  73  
  74  /**
  75   * Abstract class defining the static method in charge of building the whole
  76   * backup plan, based in @backup_controller preferences.
  77   *
  78   * TODO: Finish phpdocs
  79   */
  80  abstract class backup_plan_builder {
  81  
  82      /**
  83       * Dispatches, based on type to specialised builders
  84       */
  85      static public function build_plan($controller) {
  86  
  87          $plan = $controller->get_plan();
  88  
  89          // Add the root task, responsible for storing global settings
  90          // and some init tasks
  91          $plan->add_task(new backup_root_task('root_task'));
  92  
  93          switch ($controller->get_type()) {
  94              case backup::TYPE_1ACTIVITY:
  95                  self::build_activity_plan($controller, $controller->get_id());
  96                  break;
  97              case backup::TYPE_1SECTION:
  98                  self::build_section_plan($controller, $controller->get_id());
  99                  break;
 100              case backup::TYPE_1COURSE:
 101                  self::build_course_plan($controller, $controller->get_id());
 102                  break;
 103          }
 104  
 105          // Add the final task, responsible for outputting
 106          // all the global xml files (groups, users,
 107          // gradebook, questions, roles, files...) and
 108          // the main moodle_backup.xml file
 109          // and perform other various final actions.
 110          $plan->add_task(new backup_final_task('final_task'));
 111      }
 112  
 113  
 114      /**
 115       * Return one array of supported backup types
 116       */
 117      static public function supported_backup_types() {
 118          return array(backup::TYPE_1COURSE, backup::TYPE_1SECTION, backup::TYPE_1ACTIVITY);
 119      }
 120  
 121  // Protected API starts here
 122  
 123      /**
 124       * Build one 1-activity backup
 125       */
 126      static protected function build_activity_plan($controller, $id) {
 127  
 128          $plan = $controller->get_plan();
 129  
 130          // Add the activity task, responsible for outputting
 131          // all the module related information
 132          try {
 133              $plan->add_task(backup_factory::get_backup_activity_task($controller->get_format(), $id));
 134  
 135              // For the given activity, add as many block tasks as necessary
 136              $blockids = backup_plan_dbops::get_blockids_from_moduleid($id);
 137              foreach ($blockids as $blockid) {
 138                  try {
 139                      $plan->add_task(backup_factory::get_backup_block_task($controller->get_format(), $blockid, $id));
 140                  } catch (backup_task_exception $e) {
 141                      $a = stdClass();
 142                      $a->mid = $id;
 143                      $a->bid = $blockid;
 144                      $controller->log(get_string('error_block_for_module_not_found', 'backup', $a), backup::LOG_WARNING);
 145                  }
 146              }
 147          } catch (backup_task_exception $e) {
 148              $controller->log(get_string('error_course_module_not_found', 'backup', $id), backup::LOG_WARNING);
 149          }
 150      }
 151  
 152      /**
 153       * Build one 1-section backup
 154       */
 155      static protected function build_section_plan($controller, $id) {
 156  
 157          $plan = $controller->get_plan();
 158  
 159          // Add the section task, responsible for outputting
 160          // all the section related information
 161          $plan->add_task(backup_factory::get_backup_section_task($controller->get_format(), $id));
 162  
 163          // For the given section, add as many activity tasks as necessary
 164          $coursemodules = backup_plan_dbops::get_modules_from_sectionid($id);
 165          foreach ($coursemodules as $coursemodule) {
 166              if (plugin_supports('mod', $coursemodule->modname, FEATURE_BACKUP_MOODLE2)) { // Check we support the format
 167                  self::build_activity_plan($controller, $coursemodule->id);
 168              } else {
 169                  // TODO: Debug information about module not supported
 170              }
 171          }
 172      }
 173  
 174      /**
 175       * Build one 1-course backup
 176       */
 177      static protected function build_course_plan($controller, $id) {
 178  
 179          $plan = $controller->get_plan();
 180  
 181          // Add the course task, responsible for outputting
 182          // all the course related information
 183          $plan->add_task(backup_factory::get_backup_course_task($controller->get_format(), $id));
 184  
 185          // For the given course, add as many section tasks as necessary
 186          $sections = backup_plan_dbops::get_sections_from_courseid($id);
 187          foreach ($sections as $section) {
 188              self::build_section_plan($controller, $section);
 189          }
 190  
 191          // For the given course, add as many block tasks as necessary
 192          $blockids = backup_plan_dbops::get_blockids_from_courseid($id);
 193          foreach ($blockids as $blockid) {
 194              $plan->add_task(backup_factory::get_backup_block_task($controller->get_format(), $blockid));
 195          }
 196      }
 197  }