6a64cf22f1b903515785e9a575b0113e970cd8cb
[moodle.git] / backup / moodle2 / restore_qtype_plugin.class.php
1 <?php
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/>.
18 /**
19  * @package    moodlecore
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  */
25 /**
26  * Class extending standard restore_plugin in order to implement some
27  * helper methods related with the questions (qtype plugin)
28  *
29  * TODO: Finish phpdocs
30  */
31 abstract class restore_qtype_plugin extends restore_plugin {
33     /**
34      * Add to $paths the restore_path_elements needed
35      * to handle question_answers for a given question
36      * Used by various qtypes (calculated, essay, multianswer,
37      * multichoice, numerical, shortanswer, truefalse)
38      */
39     protected function add_question_question_answers(&$paths) {
40         // Check $paths is one array
41         if (!is_array($paths)) {
42             throw new restore_step_exception('paths_must_be_array', $paths);
43         }
45         $elename = 'question_answer';
46         $elepath = $this->get_pathfor('/answers/answer'); // we used get_recommended_name() so this works
47         $paths[] = new restore_path_element($elename, $elepath);
48     }
50     /**
51      * Add to $paths the restore_path_elements needed
52      * to handle question_numerical_units for a given question
53      * Used by various qtypes (calculated, numerical)
54      */
55     protected function add_question_numerical_units(&$paths) {
56         // Check $paths is one array
57         if (!is_array($paths)) {
58             throw new restore_step_exception('paths_must_be_array', $paths);
59         }
61         $elename = 'question_numerical_unit';
62         $elepath = $this->get_pathfor('/numerical_units/numerical_unit'); // we used get_recommended_name() so this works
63         $paths[] = new restore_path_element($elename, $elepath);
64     }
66     /**
67      * Add to $paths the restore_path_elements needed
68      * to handle question_numerical_options for a given question
69      * Used by various qtypes (calculated, numerical)
70      */
71     protected function add_question_numerical_options(&$paths) {
72         // Check $paths is one array
73         if (!is_array($paths)) {
74             throw new restore_step_exception('paths_must_be_array', $paths);
75         }
77         $elename = 'question_numerical_option';
78         $elepath = $this->get_pathfor('/numerical_options/numerical_option'); // we used get_recommended_name() so this works
79         $paths[] = new restore_path_element($elename, $elepath);
80     }
82     /**
83      * Add to $paths the restore_path_elements needed
84      * to handle question_datasets (defs and items) for a given question
85      * Used by various qtypes (calculated, numerical)
86      */
87     protected function add_question_datasets(&$paths) {
88         // Check $paths is one array
89         if (!is_array($paths)) {
90             throw new restore_step_exception('paths_must_be_array', $paths);
91         }
93         $elename = 'question_dataset_definition';
94         $elepath = $this->get_pathfor('/dataset_definitions/dataset_definition'); // we used get_recommended_name() so this works
95         $paths[] = new restore_path_element($elename, $elepath);
97         $elename = 'question_dataset_item';
98         $elepath = $this->get_pathfor('/dataset_definitions/dataset_definition/dataset_items/dataset_item');
99         $paths[] = new restore_path_element($elename, $elepath);
100     }
102     /**
103      * Processes the answer element (question answers). Common for various qtypes.
104      * It handles both creation (if the question is being created) and mapping
105      * (if the question already existed and is being reused)
106      */
107     public function process_question_answer($data) {
108         global $DB;
110         $data = (object)$data;
111         $oldid = $data->id;
113         // Detect if the question is created or mapped
114         $oldquestionid   = $this->get_old_parentid('question');
115         $newquestionid   = $this->get_new_parentid('question');
116         $questioncreated = $this->get_mappingid('question_created', $oldquestionid) ? true : false;
118         // If the question has been created by restore, we need to create its question_answers too
119         if ($questioncreated) {
120             // Adjust some columns
121             $data->question = $newquestionid;
122             $data->answer = $data->answertext;
123             // Insert record
124             $newitemid = $DB->insert_record('question_answers', $data);
126         // The question existed, we need to map the existing question_answers
127         } else {
128             // Look in question_answers by answertext matching
129             $newitemid = $DB->get_field('question_answers', 'id', array('question' => $newquestionid, 'answer' => $data->answertext));
130             // If we haven't found the newitemid, something has gone really wrong, question in DB
131             // is missing answers, exception
132             if (!$newitemid) {
133                 $info = new stdClass();
134                 $info->filequestionid = $oldquestionid;
135                 $info->dbquestionid   = $newquestionid;
136                 $info->answer         = $data->answertext;
137                 throw restore_step_exception('error_question_answers_missing_in_db', $info);
138             }
139         }
140         // Create mapping (we'll use this intensively when restoring question_states. And also answerfeedback files)
141         $this->set_mapping('question_answer', $oldid, $newitemid);
142     }
144     /**
145      * Processes the numerical_unit element (question numerical units). Common for various qtypes.
146      * It handles both creation (if the question is being created) and mapping
147      * (if the question already existed and is being reused)
148      */
149     public function process_question_numerical_unit($data) {
150         global $DB;
152         $data = (object)$data;
153         $oldid = $data->id;
155         // Detect if the question is created or mapped
156         $oldquestionid   = $this->get_old_parentid('question');
157         $newquestionid   = $this->get_new_parentid('question');
158         $questioncreated = $this->get_mappingid('question_created', $oldquestionid) ? true : false;
160         // If the question has been created by restore, we need to create its question_numerical_units too
161         if ($questioncreated) {
162             // Adjust some columns
163             $data->question = $newquestionid;
164             // Insert record
165             $newitemid = $DB->insert_record('question_numerical_units', $data);
166         }
167     }
169     /**
170      * Processes the numerical_option element (question numerical options). Common for various qtypes.
171      * It handles both creation (if the question is being created) and mapping
172      * (if the question already existed and is being reused)
173      */
174     public function process_question_numerical_option($data) {
175         global $DB;
177         $data = (object)$data;
178         $oldid = $data->id;
180         // Detect if the question is created or mapped
181         $oldquestionid   = $this->get_old_parentid('question');
182         $newquestionid   = $this->get_new_parentid('question');
183         $questioncreated = $this->get_mappingid('question_created', $oldquestionid) ? true : false;
185         // If the question has been created by restore, we need to create its question_numerical_options too
186         if ($questioncreated) {
187             // Adjust some columns
188             $data->question = $newquestionid;
189             // Insert record
190             $newitemid = $DB->insert_record('question_numerical_options', $data);
191             // Create mapping (not needed, no files nor childs nor states here)
192             //$this->set_mapping('question_numerical_option', $oldid, $newitemid);
193         }
194     }
196     /**
197      * Processes the dataset_definition element (question dataset definitions). Common for various qtypes.
198      * It handles both creation (if the question is being created) and mapping
199      * (if the question already existed and is being reused)
200      */
201     public function process_question_dataset_definition($data) {
202         global $DB;
204         $data = (object)$data;
205         $oldid = $data->id;
207         // Detect if the question is created or mapped
208         $oldquestionid   = $this->get_old_parentid('question');
209         $newquestionid   = $this->get_new_parentid('question');
210         $questioncreated = $this->get_mappingid('question_created', $oldquestionid) ? true : false;
212         // If the question is mapped, nothing to do
213         if (!$questioncreated) {
214             return;
215         }
217         // Arrived here, let's see if the question_dataset_definition already exists in category or no
218         // (by category, name, type and enough items). Only for "shared" definitions (category != 0).
219         // If exists, reuse it, else, create it as "not shared" (category = 0)
220         $data->category = $this->get_mappingid('question_category', $data->category);
221         // If category is shared, look for definitions
222         $founddefid = null;
223         if ($data->category) {
224             $candidatedefs = $DB->get_records_sql("SELECT id, itemcount
225                                                      FROM {question_dataset_definitions}
226                                                     WHERE category = ?
227                                                       AND name = ?
228                                                       AND type = ?", array($data->category, $data->name, $data->type));
229             foreach ($candidatedefs as $candidatedef) {
230                 if ($candidatedef->itemcount >= $data->itemcount) { // Check it has enough items
231                     $founddefid = $candidatedef->id;
232                     break; // end loop, shared definition match found
233                 }
234             }
235             // If there were candidates but none fulfilled the itemcount condition, create definition as not shared
236             if ($candidatedefs && !$founddefid) {
237                 $data->category = 0;
238             }
239         }
240         // If haven't found any shared definition match, let's create it
241         if (!$founddefid) {
242             $newitemid = $DB->insert_record('question_dataset_definitions', $data);
243             // Set mapping, so dataset items will know if they must be created
244             $this->set_mapping('question_dataset_definition', $oldid, $newitemid);
246         // If we have found one shared definition match, use it
247         } else {
248             $newitemid = $founddefid;
249             // Set mapping to 0, so dataset items will know they don't need to be created
250             $this->set_mapping('question_dataset_definition', $oldid, 0);
251         }
253         // Arrived here, we have one $newitemid (create or reused). Create the question_datasets record
254         $questiondataset = new stdClass();
255         $questiondataset->question = $newquestionid;
256         $questiondataset->datasetdefinition = $newitemid;
257         $DB->insert_record('question_datasets', $questiondataset);
258     }
260     /**
261      * Processes the dataset_item element (question dataset items). Common for various qtypes.
262      * It handles both creation (if the question is being created) and mapping
263      * (if the question already existed and is being reused)
264      */
265     public function process_question_dataset_item($data) {
266         global $DB;
268         $data = (object)$data;
269         $oldid = $data->id;
271         // Detect if the question is created or mapped
272         $oldquestionid   = $this->get_old_parentid('question');
273         $newquestionid   = $this->get_new_parentid('question');
274         $questioncreated = $this->get_mappingid('question_created', $oldquestionid) ? true : false;
276         // If the question is mapped, nothing to do
277         if (!$questioncreated) {
278             return;
279         }
281         // Detect if the question_dataset_definition is being created
282         $newdefinitionid = $this->get_new_parentid('question_dataset_definition');
284         // If the definition is reused, nothing to do
285         if (!$newdefinitionid) {
286             return;
287         }
289         // let's create the question_dataset_items
290         $data->definition = $newdefinitionid;
291         $data->itemnumber = $data->number;
292         $DB->insert_record('question_dataset_items', $data);
293     }
295     /**
296      * Decode one question_states for this qtype (default impl)
297      */
298     public function recode_state_answer($state) {
299         // By default, return answer unmodified, qtypes needing recode will override this
300         return $state->answer;
301     }
303     /**
304      * Return the contents of the questions stuff that must be processed by the links decoder
305      *
306      * Only common stuff to all plugins, in this case:
307      * - question: text and feedback
308      * - question_answers: text and feedbak
309      *
310      * Note each qtype will have, if needed, its own define_decode_contents method
311      */
312     static public function define_plugin_decode_contents() {
314         $contents = array();
316         $contents[] = new restore_decode_content('question', array('questiontext', 'generalfeedback'), 'question_created');
317         $contents[] = new restore_decode_content('question_answers', array('answer', 'feedback'), 'question_answer');
319         return $contents;
320     }