[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  /**
  26   * Define all the restore steps that will be used by the restore_wiki_activity_task
  27   */
  28  
  29  /**
  30   * Structure step to restore one wiki activity
  31   */
  32  class restore_wiki_activity_structure_step extends restore_activity_structure_step {
  33  
  34      protected function define_structure() {
  35  
  36          $paths = array();
  37          $userinfo = $this->get_setting_value('userinfo');
  38  
  39          $paths[] = new restore_path_element('wiki', '/activity/wiki');
  40          if ($userinfo) {
  41              $paths[] = new restore_path_element('wiki_subwiki', '/activity/wiki/subwikis/subwiki');
  42              $paths[] = new restore_path_element('wiki_page', '/activity/wiki/subwikis/subwiki/pages/page');
  43              $paths[] = new restore_path_element('wiki_version', '/activity/wiki/subwikis/subwiki/pages/page/versions/version');
  44              $paths[] = new restore_path_element('wiki_tag', '/activity/wiki/subwikis/subwiki/pages/page/tags/tag');
  45              $paths[] = new restore_path_element('wiki_synonym', '/activity/wiki/subwikis/subwiki/synonyms/synonym');
  46              $paths[] = new restore_path_element('wiki_link', '/activity/wiki/subwikis/subwiki/links/link');
  47          }
  48  
  49          // Return the paths wrapped into standard activity structure
  50          return $this->prepare_activity_structure($paths);
  51      }
  52  
  53      protected function process_wiki($data) {
  54          global $DB;
  55  
  56          $data = (object)$data;
  57          $oldid = $data->id;
  58          $data->course = $this->get_courseid();
  59  
  60          // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
  61          // See MDL-9367.
  62          $data->editbegin = $this->apply_date_offset($data->editbegin);
  63          $data->editend = $this->apply_date_offset($data->editend);
  64  
  65          // insert the wiki record
  66          $newitemid = $DB->insert_record('wiki', $data);
  67          // immediately after inserting "activity" record, call this
  68          $this->apply_activity_instance($newitemid);
  69      }
  70  
  71      protected function process_wiki_subwiki($data) {
  72          global $DB;
  73  
  74          $data = (object) $data;
  75          $oldid = $data->id;
  76          $data->wikiid = $this->get_new_parentid('wiki');
  77  
  78          // If the groupid is not equal to zero, get the mapping for the group.
  79          if ((int) $data->groupid !== 0) {
  80              $data->groupid = $this->get_mappingid('group', $data->groupid);
  81          }
  82  
  83          // If the userid is not equal to zero, get the mapping for the user.
  84          if ((int) $data->userid !== 0) {
  85              $data->userid = $this->get_mappingid('user', $data->userid);
  86          }
  87  
  88          // If these values are not equal to false then a mapping was successfully made.
  89          if ($data->groupid !== false && $data->userid !== false) {
  90              $newitemid = $DB->insert_record('wiki_subwikis', $data);
  91          } else {
  92              $newitemid = false;
  93          }
  94  
  95          $this->set_mapping('wiki_subwiki', $oldid, $newitemid, true);
  96      }
  97  
  98      protected function process_wiki_page($data) {
  99          global $DB;
 100  
 101          $data = (object) $data;
 102          $oldid = $data->id;
 103          $data->subwikiid = $this->get_new_parentid('wiki_subwiki');
 104          $data->userid = $this->get_mappingid('user', $data->userid);
 105  
 106          // Check that we were able to get a parentid for this page.
 107          if ($data->subwikiid !== false) {
 108              $newitemid = $DB->insert_record('wiki_pages', $data);
 109          } else {
 110              $newitemid = false;
 111          }
 112  
 113          $this->set_mapping('wiki_page', $oldid, $newitemid, true);
 114      }
 115  
 116      protected function process_wiki_version($data) {
 117          global $DB;
 118  
 119          $data = (object)$data;
 120          $oldid = $data->id;
 121          $data->pageid = $this->get_new_parentid('wiki_page');
 122          $data->userid = $this->get_mappingid('user', $data->userid);
 123  
 124          $newitemid = $DB->insert_record('wiki_versions', $data);
 125          $this->set_mapping('wiki_version', $oldid, $newitemid);
 126      }
 127      protected function process_wiki_synonym($data) {
 128          global $DB;
 129  
 130          $data = (object)$data;
 131          $oldid = $data->id;
 132          $data->subwikiid = $this->get_new_parentid('wiki_subwiki');
 133          $data->pageid = $this->get_mappingid('wiki_page', $data->pageid);
 134  
 135          $newitemid = $DB->insert_record('wiki_synonyms', $data);
 136          // No need to save this mapping as far as nothing depend on it
 137          // (child paths, file areas nor links decoder)
 138      }
 139      protected function process_wiki_link($data) {
 140          global $DB;
 141  
 142          $data = (object)$data;
 143          $oldid = $data->id;
 144          $data->subwikiid = $this->get_new_parentid('wiki_subwiki');
 145          $data->frompageid = $this->get_mappingid('wiki_page', $data->frompageid);
 146          $data->topageid = $this->get_mappingid('wiki_page', $data->topageid);
 147  
 148          $newitemid = $DB->insert_record('wiki_links', $data);
 149          // No need to save this mapping as far as nothing depend on it
 150          // (child paths, file areas nor links decoder)
 151      }
 152  
 153      protected function process_wiki_tag($data) {
 154          global $CFG, $DB;
 155  
 156          $data = (object)$data;
 157          $oldid = $data->id;
 158  
 159          if (!core_tag_tag::is_enabled('mod_wiki', 'wiki_pages')) { // Tags disabled in server, nothing to process.
 160              return;
 161          }
 162  
 163          $tag = $data->rawname;
 164          $itemid = $this->get_new_parentid('wiki_page');
 165          $wikiid = $this->get_new_parentid('wiki');
 166  
 167          $context = context_module::instance($this->task->get_moduleid());
 168          core_tag_tag::add_item_tag('mod_wiki', 'wiki_pages', $itemid, $context, $tag);
 169      }
 170  
 171      protected function after_execute() {
 172          // Add wiki related files, no need to match by itemname (just internally handled context)
 173          $this->add_related_files('mod_wiki', 'intro', null);
 174          $this->add_related_files('mod_wiki', 'attachments', 'wiki_subwiki');
 175      }
 176  }