Backups including STACK questions can now be restored.

backup/moodle2/backup_qtype_stack_plugin.class.php

@@ -135,10 +135,12 @@ class backup_qtype_stack_plugin extends backup_qtype_plugin {
      */
     public static function get_qtype_fileareas() {
         return array(
-            'specificfeedback'    => 'qtype_stack',
-            'prtcorrect'          => 'qtype_stack',
-            'prtpartiallycorrect' => 'qtype_stack',
-            'prtincorrect'        => 'qtype_stack',
+            'specificfeedback'     => 'question_created',
+            'prtcorrect'           => 'question_created',
+            'prtpartiallycorrect'  => 'question_created',
+            'prtincorrect'         => 'question_created',
+            'prtnodetruefeedback'  => 'qtype_stack_prt_nodes',
+            'prtnodefalsefeedback' => 'qtype_stack_prt_nodes',
         );
     }
 }

backup/moodle2/restore_qtype_stack_plugin.class.php

+<?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/>.
+
+/**
+ * STACK question type restore code.
+ * @package   qtype_stack
+ * @copyright 2012 The Open University
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+defined('MOODLE_INTERNAL') || die();
+
+
+/**
+ * Provides the information to restore STACK questions
+ *
+ * @copyright 2012 The Open University
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class restore_qtype_stack_plugin extends restore_qtype_plugin {
+
+    /** @var string the name of the PRT we are currently restoring. */
+    protected $currentprtname = null;
+
+    /** @var int the name of the PRT we are currently restoring. */
+    protected $currenttestcase = null;
+
+    /**
+     * Returns the paths to be handled by the plugin at question level
+     */
+    protected function define_question_plugin_structure() {
+
+        $paths = array();
+
+        // List the relevant paths in the XML.
+        $elements = array(
+            'qtype_stack_options'        => '/stackoptions',
+            'qtype_stack_input'          => '/stackinputs/stackinput',
+            'qtype_stack_prt'            => '/stackprts/stackprt',
+            'qtype_stack_prt_node'       => '/stackprts/stackprt/stackprtnodes/stackprtnode',
+            'qtype_stack_qtest'          => '/stackqtests/stackqtest',
+            'qtype_stack_qtest_input'    => '/stackqtests/stackqtest/stackqtestinputs/stackqtestinput',
+            'qtype_stack_qtest_expected' => '/stackqtests/stackqtest/stackqtestexpecteds/stackqtestexpected',
+            'qtype_stack_deployed_seed'  => '/stackdeployedseeds/stackdeployedseed',
+        );
+        foreach ($elements as $elename => $path) {
+            $paths[] = new restore_path_element($elename, $this->get_pathfor($path));
+        }
+
+        return $paths;
+    }
+
+    /**
+     * Process the STACK options.
+     * @param array/object $data the data from the backup file.
+     */
+    public function process_qtype_stack_options($data) {
+        global $DB;
+
+        $data = (object)$data;
+
+        // Detect if the question is created or mapped
+        $questioncreated = (bool) $this->get_mappingid('question_created', $this->get_old_parentid('question'));
+
+        // If the question is being created by restore, save the stack options.
+        if ($questioncreated) {
+            $oldid = $data->id;
+            $data->questionid = $this->get_new_parentid('question');
+            $newitemid = $DB->insert_record('qtype_stack', $data);
+            $this->set_mapping('qtype_stack', $oldid, $newitemid);
+        }
+    }
+
+    /**
+     * Process the STACK inputs.
+     * @param array/object $data the data from the backup file.
+     */
+    public function process_qtype_stack_input($data) {
+        global $DB;
+
+        $data = (object)$data;
+
+        // Detect if the question is created or mapped
+        $questioncreated = (bool) $this->get_mappingid('question_created', $this->get_old_parentid('question'));
+
+        // If the question is being created, save this input.
+        if ($questioncreated) {
+            $data->questionid = $this->get_new_parentid('question');
+            $DB->insert_record('qtype_stack_inputs', $data, false);
+        }
+    }
+
+    /**
+     * Process the STACK PRTs.
+     * @param array/object $data the data from the backup file.
+     */
+    public function process_qtype_stack_prt($data) {
+        global $DB;
+
+        $data = (object)$data;
+
+        $this->currentprtname = $data->name;
+
+        // Detect if the question is created or mapped
+        $questioncreated = (bool) $this->get_mappingid('question_created', $this->get_old_parentid('question'));
+
+        // If the question is being created, save this input.
+        if ($questioncreated) {
+            $data->questionid = $this->get_new_parentid('question');
+            $DB->insert_record('qtype_stack_prts', $data, false);
+        }
+    }
+
+    /**
+     * Process the STACK PRT nodes.
+     * @param array/object $data the data from the backup file.
+     */
+    public function process_qtype_stack_prt_node($data) {
+        global $DB;
+
+        $data = (object)$data;
+
+        // Detect if the question is created or mapped
+        $questioncreated = (bool) $this->get_mappingid('question_created', $this->get_old_parentid('question'));
+
+        // If the question is being created, save this input.
+        if ($questioncreated) {
+            $oldid = $data->id;
+            $data->questionid = $this->get_new_parentid('question');
+            $data->prtname = $this->currentprtname;
+            $newitemid = $DB->insert_record('qtype_stack_prt_nodes', $data);
+            $this->set_mapping('qtype_stack_prt_nodes', $oldid, $newitemid);
+        }
+    }
+
+    /**
+     * Process the STACK question tests.
+     * @param array/object $data the data from the backup file.
+     */
+    public function process_qtype_stack_qtest($data) {
+        global $DB;
+
+        $data = (object)$data;
+
+        $this->currenttestcase = $data->testcase;
+
+        // Detect if the question is created or mapped
+        $questioncreated = (bool) $this->get_mappingid('question_created', $this->get_old_parentid('question'));
+
+        // If the question is being created, save this input.
+        if ($questioncreated) {
+            $data->questionid = $this->get_new_parentid('question');
+            $DB->insert_record('qtype_stack_qtests', $data, false);
+        }
+    }
+
+    /**
+     * Process the STACK question test input data.
+     * @param array/object $data the data from the backup file.
+     */
+    public function process_qtype_stack_qtest_input($data) {
+        global $DB;
+
+        $data = (object)$data;
+
+        // Detect if the question is created or mapped
+        $questioncreated = (bool) $this->get_mappingid('question_created', $this->get_old_parentid('question'));
+
+        // If the question is being created, save this input.
+        if ($questioncreated) {
+            $data->questionid = $this->get_new_parentid('question');
+            $data->testcase = $this->currenttestcase;
+            $DB->insert_record('qtype_stack_qtest_inputs', $data, false);
+        }
+    }
+
+    /**
+     * Process the STACK question test expected results.
+     * @param array/object $data the data from the backup file.
+     */
+    public function process_qtype_stack_qtest_expected($data) {
+        global $DB;
+
+        $data = (object)$data;
+
+        // Detect if the question is created or mapped
+        $questioncreated = (bool) $this->get_mappingid('question_created', $this->get_old_parentid('question'));
+
+        // If the question is being created, save this input.
+        if ($questioncreated) {
+        $data->questionid = $this->get_new_parentid('question');
+            $data->testcase = $this->currenttestcase;
+            $DB->insert_record('qtype_stack_qtest_expected', $data, false);
+        }
+    }
+
+    /**
+     * Process the STACK question tests.
+     * @param array/object $data the data from the backup file.
+     */
+    public function process_qtype_stack_deployed_seed($data) {
+        global $DB;
+
+        $data = (object)$data;
+
+        // Detect if the question is created or mapped
+        $questioncreated = (bool) $this->get_mappingid('question_created', $this->get_old_parentid('question'));
+
+        // If the question is being created, save this input.
+        if ($questioncreated) {
+            $data->questionid = $this->get_new_parentid('question');
+            $DB->insert_record('qtype_stack_deployed_seeds', $data, false);
+        }
+    }
+
+    /**
+     * Return the contents of this qtype to be processed by the links decoder
+     */
+    public static function define_decode_contents() {
+        return array(
+            new restore_decode_content('qtype_stack',
+                    array('specificfeedback', 'prtcorrect', 'prtpartiallycorrect', 'prtincorrect'),
+                    'qtype_stack'),
+            new restore_decode_content('qtype_stack_prt_nodes', array('truefeedback', 'falsefeedback'),
+                    'qtype_stack_prt_nodes'),
+        );
+    }
+}