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