[Summary 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   * @package    mod_wiki
  20   * @subpackage backup-moodle2
  21   * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  require_once($CFG->dirroot . '/mod/wiki/backup/moodle2/restore_wiki_stepslib.php'); // Because it exists (must)
  28  
  29  /**
  30   * wiki restore task that provides all the settings and steps to perform one
  31   * complete restore of the activity
  32   */
  33  class restore_wiki_activity_task extends restore_activity_task {
  34  
  35      /**
  36       * Define (add) particular settings this activity can have
  37       */
  38      protected function define_my_settings() {
  39          // No particular settings for this activity
  40      }
  41  
  42      /**
  43       * Define (add) particular steps this activity can have
  44       */
  45      protected function define_my_steps() {
  46          // wiki only has one structure step
  47          $this->add_step(new restore_wiki_activity_structure_step('wiki_structure', 'wiki.xml'));
  48      }
  49  
  50      /**
  51       * Define the contents in the activity that must be
  52       * processed by the link decoder
  53       */
  54      static public function define_decode_contents() {
  55          $contents = array();
  56  
  57          $contents[] = new restore_decode_content('wiki', array('intro'), 'wiki');
  58          $contents[] = new restore_decode_content('wiki_versions', array('content'), 'wiki_version');
  59          $contents[] = new restore_decode_content('wiki_pages', array('cachedcontent'), 'wiki_page');
  60          return $contents;
  61      }
  62  
  63      /**
  64       * Define the decoding rules for links belonging
  65       * to the activity to be executed by the link decoder
  66       */
  67      static public function define_decode_rules() {
  68          $rules = array();
  69  
  70          $rules[] = new restore_decode_rule('WIKIINDEX', '/mod/wiki/index.php?id=$1', 'course');
  71          $rules[] = new restore_decode_rule('WIKIVIEWBYID', '/mod/wiki/view.php?id=$1', 'course_module');
  72          $rules[] = new restore_decode_rule('WIKIPAGEBYID', '/mod/wiki/view.php?pageid=$1', 'wiki_page');
  73  
  74          return $rules;
  75  
  76      }
  77  
  78      /**
  79       * Define the restore log rules that will be applied
  80       * by the {@link restore_logs_processor} when restoring
  81       * wiki logs. It must return one array
  82       * of {@link restore_log_rule} objects
  83       */
  84      static public function define_restore_log_rules() {
  85          $rules = array();
  86  
  87          $rules[] = new restore_log_rule('wiki', 'add', 'view.php?id={course_module}', '{wiki}');
  88          $rules[] = new restore_log_rule('wiki', 'update', 'view.php?id={course_module}', '{wiki}');
  89          $rules[] = new restore_log_rule('wiki', 'view', 'view.php?id={course_module}', '{wiki}');
  90          $rules[] = new restore_log_rule('wiki', 'comments', 'comments.php?id={course_module}', '{wiki}');
  91          $rules[] = new restore_log_rule('wiki', 'diff', 'diff.php?id={course_module}', '{wiki}');
  92          $rules[] = new restore_log_rule('wiki', 'edit', 'edit.php?id={course_module}', '{wiki}');
  93          $rules[] = new restore_log_rule('wiki', 'history', 'history.php?id={course_module}', '{wiki}');
  94          $rules[] = new restore_log_rule('wiki', 'map', 'map.php?id={course_module}', '{wiki}');
  95          $rules[] = new restore_log_rule('wiki', 'overridelocks', 'overridelocks.php?id={course_module}', '{wiki}');
  96          /// TODO: Examine these 2 rules, because module is not "wiki", and it shouldn't happen
  97          $rules[] = new restore_log_rule('restore', 'restore', 'view.php?id={course_module}', '{wiki}');
  98          $rules[] = new restore_log_rule('createpage', 'createpage', 'view.php?id={course_module}', '{wiki}');
  99  
 100          return $rules;
 101      }
 102  
 103      /**
 104       * Define the restore log rules that will be applied
 105       * by the {@link restore_logs_processor} when restoring
 106       * course logs. It must return one array
 107       * of {@link restore_log_rule} objects
 108       *
 109       * Note this rules are applied when restoring course logs
 110       * by the restore final task, but are defined here at
 111       * activity level. All them are rules not linked to any module instance (cmid = 0)
 112       */
 113      static public function define_restore_log_rules_for_course() {
 114          $rules = array();
 115  
 116          $rules[] = new restore_log_rule('wiki', 'view all', 'index.php?id={course}', null);
 117  
 118          return $rules;
 119      }
 120  }