MDL-23479 backup - choice restore implementation

mod/choice/backup/moodle2/restore_choice_activity_task.class.php

@@ -22,6 +22,10 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->dirroot . '/mod/choice/backup/moodle2/restore_choice_stepslib.php'); // Because it exists (must)
+
 /**
  * choice restore task that provides all the settings and steps to perform one
  * complete restore of the activity
@@ -39,17 +43,33 @@ class restore_choice_activity_task extends restore_activity_task {
      * Define (add) particular steps this activity can have
      */
     protected function define_my_steps() {
-        // TODO: Add choice structure step here
+        // Choice only has one structure step
+        $this->add_step(new restore_choice_activity_structure_step('choice_structure', 'choice.xml'));
     }
 
     /**
-     * Code the transformations to perform in the actvity in
-     * order to get encoded transformed back to working links
+     * Define the contents in the activity that must be
+     * processed by the link decoder
      */
-    static public function decode_content_links($content) {
+    static public function define_decode_contents() {
+        $contents = array();
 
-        // TODO: Decode CHOICEINDEX & CHOICEVIEWBYID
+        $contents[] = new restore_decode_content('choice', array('intro'), 'choice');
+
+        return $contents;
+    }
+
+    /**
+     * Define the decoding rules for links belonging
+     * to the activity to be executed by the link decoder
+     */
+    static public function define_decode_rules() {
+        $rules = array();
+
+        $rules[] = new restore_decode_rule('CHOICEVIEWBYID', '/mod/choice/view.php?id=$1', 'course_module');
+        $rules[] = new restore_decode_rule('CHOICEINDEX', '/mod/choice/index.php?id=$1', 'course');
+
+        return $rules;
 
-        return $content;
     }
 }

mod/choice/backup/moodle2/restore_choice_stepslib.php

@@ -0,0 +1,94 @@
+<?php
+
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * @package moodlecore
+ * @subpackage backup-moodle2
+ * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * Define all the restore steps that will be used by the restore_choice_activity_task
+ */
+
+/**
+ * Structure step to restore one choice activity
+ */
+class restore_choice_activity_structure_step extends restore_activity_structure_step {
+
+    protected function define_structure() {
+
+        $paths = array();
+        $userinfo = $this->get_setting_value('userinfo');
+
+        $paths[] = new restore_path_element('choice', '/activity/choice');
+        $paths[] = new restore_path_element('choice_option', '/activity/choice/options/option');
+        if ($userinfo) {
+            $paths[] = new restore_path_element('choice_answer', '/activity/choice/answers/answer');
+        }
+
+        // Return the paths wrapped into standard activity structure
+        return $this->prepare_activity_structure($paths);
+    }
+
+    protected function process_choice($data) {
+        global $DB;
+
+        $data = (object)$data;
+        $oldid = $data->id;
+        $data->course = $this->get_courseid();
+
+        $data->timeopen = $this->apply_date_offset($data->timeopen);
+        $data->timeclose = $this->apply_date_offset($data->timeclose);
+
+        // insert the choice record
+        $newitemid = $DB->insert_record('choice', $data);
+        // inmediately after inserting "activity" record, call this
+        $this->apply_activity_instance($newitemid);
+    }
+
+    protected function process_choice_option($data) {
+        global $DB;
+
+        $data = (object)$data;
+        $oldid = $data->id;
+        $data->choiceid = $this->get_new_parentid('choice');
+
+        $newitemid = $DB->insert_record('choice_options', $data);
+        $this->set_mapping('choice_option', $oldid, $newitemid);
+    }
+
+    protected function process_choice_answer($data) {
+        global $DB;
+
+        $data = (object)$data;
+        $oldid = $data->id;
+        $data->choiceid = $this->get_new_parentid('choice');
+        $data->optionid = $this->get_new_parentid('choice_option');
+        $data->userid = $this->get_mappingid('user', $data->userid);
+
+        $newitemid = $DB->insert_record('choice_answers', $data);
+        // No need to save this mapping as far as nothing depend on it
+        // (child paths, file areas nor links decoder)
+    }
+
+    protected function after_execute() {
+        // Add choice related files, no need to match by itemname (just internally handled context)
+        $this->add_related_files('mod_choice', 'intro', null);
+    }
+}