MDL-10971 question type multianswer: Respect quiz shuffle option
[moodle.git] / backup / util / plan / restore_structure_step.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-plan
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  * Abstract class defining the needed stuff to restore one xml file
27  *
28  * TODO: Finish phpdocs
29  */
30 abstract class restore_structure_step extends restore_step {
32     protected $filename; // Name of the file to be parsed
33     protected $contentprocessor; // xml parser processor being used
34                                  // (need it here, apart from parser
35                                  // thanks to serialized data to process -
36                                  // say thanks to blocks!)
37     protected $pathelements;  // Array of pathelements to process
38     protected $elementsoldid; // Array to store last oldid used on each element
39     protected $elementsnewid; // Array to store last newid used on each element
41     protected $pathlock;      // Path currently locking processing of children
43     const SKIP_ALL_CHILDREN = -991399; // To instruct the dispatcher about to ignore
44                                        // all children below path processor returning it
46     /**
47      * Constructor - instantiates one object of this class
48      */
49     public function __construct($name, $filename, $task = null) {
50         if (!is_null($task) && !($task instanceof restore_task)) {
51             throw new restore_step_exception('wrong_restore_task_specified');
52         }
53         $this->filename = $filename;
54         $this->contentprocessor = null;
55         $this->pathelements = array();
56         $this->elementsoldid = array();
57         $this->elementsnewid = array();
58         $this->pathlock = null;
59         parent::__construct($name, $task);
60     }
62     final public function execute() {
64         if (!$this->execute_condition()) { // Check any condition to execute this
65             return;
66         }
68         $fullpath = $this->task->get_taskbasepath();
70         // We MUST have one fullpath here, else, error
71         if (empty($fullpath)) {
72             throw new restore_step_exception('restore_structure_step_undefined_fullpath');
73         }
75         // Append the filename to the fullpath
76         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
78         // And it MUST exist
79         if (!file_exists($fullpath)) { // Shouldn't happen ever, but...
80             throw new restore_step_exception('missing_moodle_backup_xml_file', $fullpath);
81         }
83         // Get restore_path elements array adapting and preparing it for processing
84         $structure = $this->define_structure();
85         if (!is_array($structure)) {
86             throw new restore_step_exception('restore_step_structure_not_array', $this->get_name());
87         }
88         $this->prepare_pathelements($structure);
90         // Create parser and processor
91         $xmlparser = new progressive_parser();
92         $xmlparser->set_file($fullpath);
93         $xmlprocessor = new restore_structure_parser_processor($this->task->get_courseid(), $this);
94         $this->contentprocessor = $xmlprocessor; // Save the reference to the contentprocessor
95                                                  // as far as we are going to need it out
96                                                  // from parser (blame serialized data!)
97         $xmlparser->set_processor($xmlprocessor);
99         // Add pathelements to processor
100         foreach ($this->pathelements as $element) {
101             $xmlprocessor->add_path($element->get_path(), $element->is_grouped());
102         }
104         // Set up progress tracking.
105         $progress = $this->get_task()->get_progress();
106         $progress->start_progress($this->get_name(), \core\progress\base::INDETERMINATE);
107         $xmlparser->set_progress($progress);
109         // And process it, dispatch to target methods in step will start automatically
110         $xmlparser->process();
112         // Have finished, launch the after_execute method of all the processing objects
113         $this->launch_after_execute_methods();
114         $progress->end_progress();
115     }
117     /**
118      * Receive one chunk of information form the xml parser processor and
119      * dispatch it, following the naming rules
120      */
121     final public function process($data) {
122         if (!array_key_exists($data['path'], $this->pathelements)) { // Incorrect path, must not happen
123             throw new restore_step_exception('restore_structure_step_missing_path', $data['path']);
124         }
125         $element = $this->pathelements[$data['path']];
126         $object = $element->get_processing_object();
127         $method = $element->get_processing_method();
128         $rdata = null;
129         if (empty($object)) { // No processing object defined
130             throw new restore_step_exception('restore_structure_step_missing_pobject', $object);
131         }
132         // Release the lock if we aren't anymore within children of it
133         if (!is_null($this->pathlock) and strpos($data['path'], $this->pathlock) === false) {
134             $this->pathlock = null;
135         }
136         if (is_null($this->pathlock)) { // Only dispatch if there isn't any lock
137             $rdata = $object->$method($data['tags']); // Dispatch to proper object/method
138         }
140         // If the dispatched method returns SKIP_ALL_CHILDREN, we grab current path in order to
141         // lock dispatching to any children
142         if ($rdata === self::SKIP_ALL_CHILDREN) {
143             // Check we haven't any previous lock
144             if (!is_null($this->pathlock)) {
145                 throw new restore_step_exception('restore_structure_step_already_skipping', $data['path']);
146             }
147             // Set the lock
148             $this->pathlock = $data['path'] . '/'; // Lock everything below current path
150         // Continue with normal processing of return values
151         } else if ($rdata !== null) { // If the method has returned any info, set element data to it
152             $element->set_data($rdata);
153         } else {               // Else, put the original parsed data
154             $element->set_data($data);
155         }
156     }
158     /**
159      * To send ids pairs to backup_ids_table and to store them into paths
160      *
161      * This method will send the given itemname and old/new ids to the
162      * backup_ids_temp table, and, at the same time, will save the new id
163      * into the corresponding restore_path_element for easier access
164      * by children. Also will inject the known old context id for the task
165      * in case it's going to be used for restoring files later
166      */
167     public function set_mapping($itemname, $oldid, $newid, $restorefiles = false, $filesctxid = null, $parentid = null) {
168         if ($restorefiles && $parentid) {
169             throw new restore_step_exception('set_mapping_cannot_specify_both_restorefiles_and_parentitemid');
170         }
171         // If we haven't specified one context for the files, use the task one
172         if (is_null($filesctxid)) {
173             $parentitemid = $restorefiles ? $this->task->get_old_contextid() : null;
174         } else { // Use the specified one
175             $parentitemid = $restorefiles ? $filesctxid : null;
176         }
177         // We have passed one explicit parentid, apply it
178         $parentitemid = !is_null($parentid) ? $parentid : $parentitemid;
180         // Let's call the low level one
181         restore_dbops::set_backup_ids_record($this->get_restoreid(), $itemname, $oldid, $newid, $parentitemid);
182         // Now, if the itemname matches any pathelement->name, store the latest $newid
183         if (array_key_exists($itemname, $this->elementsoldid)) { // If present in  $this->elementsoldid, is valid, put both ids
184             $this->elementsoldid[$itemname] = $oldid;
185             $this->elementsnewid[$itemname] = $newid;
186         }
187     }
189     /**
190      * Returns the latest (parent) old id mapped by one pathelement
191      */
192     public function get_old_parentid($itemname) {
193         return array_key_exists($itemname, $this->elementsoldid) ? $this->elementsoldid[$itemname] : null;
194     }
196     /**
197      * Returns the latest (parent) new id mapped by one pathelement
198      */
199     public function get_new_parentid($itemname) {
200         return array_key_exists($itemname, $this->elementsnewid) ? $this->elementsnewid[$itemname] : null;
201     }
203     /**
204      * Return the new id of a mapping for the given itemname
205      *
206      * @param string $itemname the type of item
207      * @param int $oldid the item ID from the backup
208      * @param mixed $ifnotfound what to return if $oldid wasnt found. Defaults to false
209      */
210     public function get_mappingid($itemname, $oldid, $ifnotfound = false) {
211         $mapping = $this->get_mapping($itemname, $oldid);
212         return $mapping ? $mapping->newitemid : $ifnotfound;
213     }
215     /**
216      * Return the complete mapping from the given itemname, itemid
217      */
218     public function get_mapping($itemname, $oldid) {
219         return restore_dbops::get_backup_ids_record($this->get_restoreid(), $itemname, $oldid);
220     }
222     /**
223      * Add all the existing file, given their component and filearea and one backup_ids itemname to match with
224      */
225     public function add_related_files($component, $filearea, $mappingitemname, $filesctxid = null, $olditemid = null) {
226         // If the current progress object is set up and ready to receive
227         // indeterminate progress, then use it, otherwise don't. (This check is
228         // just in case this function is ever called from somewhere not within
229         // the execute() method here, which does set up progress like this.)
230         $progress = $this->get_task()->get_progress();
231         if (!$progress->is_in_progress_section() ||
232                 $progress->get_current_max() !== \core\progress\base::INDETERMINATE) {
233             $progress = null;
234         }
236         $filesctxid = is_null($filesctxid) ? $this->task->get_old_contextid() : $filesctxid;
237         $results = restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), $component,
238                 $filearea, $filesctxid, $this->task->get_userid(), $mappingitemname, $olditemid, null, false,
239                 $progress);
240         $resultstoadd = array();
241         foreach ($results as $result) {
242             $this->log($result->message, $result->level);
243             $resultstoadd[$result->code] = true;
244         }
245         $this->task->add_result($resultstoadd);
246     }
248     /**
249      * Apply course startdate offset based in original course startdate and course_offset_startdate setting
250      * Note we are using one static cache here, but *by restoreid*, so it's ok for concurrence/multiple
251      * executions in the same request
252      */
253     public function apply_date_offset($value) {
255         // empties don't offset - zeros (int and string), false and nulls return original value
256         if (empty($value)) {
257             return $value;
258         }
260         static $cache = array();
261         // Lookup cache
262         if (isset($cache[$this->get_restoreid()])) {
263             return $value + $cache[$this->get_restoreid()];
264         }
265         // No cache, let's calculate the offset
266         $original = $this->task->get_info()->original_course_startdate;
267         $setting = 0;
268         if ($this->setting_exists('course_startdate')) { // Seting may not exist (MDL-25019)
269             $setting  = $this->get_setting_value('course_startdate');
270         }
272         // Original course has not startdate or setting doesn't exist, offset = 0
273         if (empty($original) || empty($setting)) {
274             $cache[$this->get_restoreid()] = 0;
276         // Less than 24h of difference, offset = 0 (this avoids some problems with timezones)
277         } else if (abs($setting - $original) < 24 * 60 * 60) {
278             $cache[$this->get_restoreid()] = 0;
280         // Re-enforce 'moodle/restore:rolldates' capability for the user in the course, just in case
281         } else if (!has_capability('moodle/restore:rolldates',
282                                    context_course::instance($this->get_courseid()),
283                                    $this->task->get_userid())) {
284             $cache[$this->get_restoreid()] = 0;
286         // Arrived here, let's calculate the real offset
287         } else {
288             $cache[$this->get_restoreid()] = $setting - $original;
289         }
291         // Return the passed value with cached offset applied
292         return $value + $cache[$this->get_restoreid()];
293     }
295     /**
296      * As far as restore structure steps are implementing restore_plugin stuff, they need to
297      * have the parent task available for wrapping purposes (get course/context....)
298      * @return restore_task|null
299      */
300     public function get_task() {
301         return $this->task;
302     }
304 // Protected API starts here
306     /**
307      * Add plugin structure to any element in the structure restore tree
308      *
309      * @param string $plugintype type of plugin as defined by core_component::get_plugin_types()
310      * @param restore_path_element $element element in the structure restore tree that
311      *                                       we are going to add plugin information to
312      */
313     protected function add_plugin_structure($plugintype, $element) {
315         global $CFG;
317         // Check the requested plugintype is a valid one
318         if (!array_key_exists($plugintype, core_component::get_plugin_types($plugintype))) {
319              throw new restore_step_exception('incorrect_plugin_type', $plugintype);
320         }
322         // Get all the restore path elements, looking across all the plugin dirs
323         $pluginsdirs = core_component::get_plugin_list($plugintype);
324         foreach ($pluginsdirs as $name => $pluginsdir) {
325             // We need to add also backup plugin classes on restore, they may contain
326             // some stuff used both in backup & restore
327             $backupclassname = 'backup_' . $plugintype . '_' . $name . '_plugin';
328             $backupfile = $pluginsdir . '/backup/moodle2/' . $backupclassname . '.class.php';
329             if (file_exists($backupfile)) {
330                 require_once($backupfile);
331             }
332             // Now add restore plugin classes and prepare stuff
333             $restoreclassname = 'restore_' . $plugintype . '_' . $name . '_plugin';
334             $restorefile = $pluginsdir . '/backup/moodle2/' . $restoreclassname . '.class.php';
335             if (file_exists($restorefile)) {
336                 require_once($restorefile);
337                 $restoreplugin = new $restoreclassname($plugintype, $name, $this);
338                 // Add plugin paths to the step
339                 $this->prepare_pathelements($restoreplugin->define_plugin_structure($element));
340             }
341         }
342     }
344     /**
345      * Launch all the after_execute methods present in all the processing objects
346      *
347      * This method will launch all the after_execute methods that can be defined
348      * both in restore_plugin and restore_structure_step classes
349      *
350      * For restore_plugin classes the name of the method to be executed will be
351      * "after_execute_" + connection point (as far as can be multiple connection
352      * points in the same class)
353      *
354      * For restore_structure_step classes is will be, simply, "after_execute". Note
355      * that this is executed *after* the plugin ones
356      */
357     protected function launch_after_execute_methods() {
358         $alreadylaunched = array(); // To avoid multiple executions
359         foreach ($this->pathelements as $key => $pathelement) {
360             // Get the processing object
361             $pobject = $pathelement->get_processing_object();
362             // Skip null processors (child of grouped ones for sure)
363             if (is_null($pobject)) {
364                 continue;
365             }
366             // Skip restore structure step processors (this)
367             if ($pobject instanceof restore_structure_step) {
368                 continue;
369             }
370             // Skip already launched processing objects
371             if (in_array($pobject, $alreadylaunched, true)) {
372                 continue;
373             }
374             // Add processing object to array of launched ones
375             $alreadylaunched[] = $pobject;
376             // If the processing object has support for
377             // launching after_execute methods, use it
378             if (method_exists($pobject, 'launch_after_execute_methods')) {
379                 $pobject->launch_after_execute_methods();
380             }
381         }
382         // Finally execute own (restore_structure_step) after_execute method
383         $this->after_execute();
385     }
387     /**
388      * Launch all the after_restore methods present in all the processing objects
389      *
390      * This method will launch all the after_restore methods that can be defined
391      * both in restore_plugin class
392      *
393      * For restore_plugin classes the name of the method to be executed will be
394      * "after_restore_" + connection point (as far as can be multiple connection
395      * points in the same class)
396      */
397     public function launch_after_restore_methods() {
398         $alreadylaunched = array(); // To avoid multiple executions
399         foreach ($this->pathelements as $pathelement) {
400             // Get the processing object
401             $pobject = $pathelement->get_processing_object();
402             // Skip null processors (child of grouped ones for sure)
403             if (is_null($pobject)) {
404                 continue;
405             }
406             // Skip restore structure step processors (this)
407             if ($pobject instanceof restore_structure_step) {
408                 continue;
409             }
410             // Skip already launched processing objects
411             if (in_array($pobject, $alreadylaunched, true)) {
412                 continue;
413             }
414             // Add processing object to array of launched ones
415             $alreadylaunched[] = $pobject;
416             // If the processing object has support for
417             // launching after_restore methods, use it
418             if (method_exists($pobject, 'launch_after_restore_methods')) {
419                 $pobject->launch_after_restore_methods();
420             }
421         }
422         // Finally execute own (restore_structure_step) after_restore method
423         $this->after_restore();
424     }
426     /**
427      * This method will be executed after the whole structure step have been processed
428      *
429      * After execution method for code needed to be executed after the whole structure
430      * has been processed. Useful for cleaning tasks, files process and others. Simply
431      * overwrite in in your steps if needed
432      */
433     protected function after_execute() {
434         // do nothing by default
435     }
437     /**
438      * This method will be executed after the rest of the restore has been processed.
439      *
440      * Use if you need to update IDs based on things which are restored after this
441      * step has completed.
442      */
443     protected function after_restore() {
444         // do nothing by default
445     }
447     /**
448      * Prepare the pathelements for processing, looking for duplicates, applying
449      * processing objects and other adjustments
450      */
451     protected function prepare_pathelements($elementsarr) {
453         // First iteration, push them to new array, indexed by name
454         // detecting duplicates in names or paths
455         $names = array();
456         $paths = array();
457         foreach($elementsarr as $element) {
458             if (!$element instanceof restore_path_element) {
459                 throw new restore_step_exception('restore_path_element_wrong_class', get_class($element));
460             }
461             if (array_key_exists($element->get_name(), $names)) {
462                 throw new restore_step_exception('restore_path_element_name_alreadyexists', $element->get_name());
463             }
464             if (array_key_exists($element->get_path(), $paths)) {
465                 throw new restore_step_exception('restore_path_element_path_alreadyexists', $element->get_path());
466             }
467             $names[$element->get_name()] = true;
468             $paths[$element->get_path()] = $element;
469         }
470         // Now, for each element not having one processing object, if
471         // not child of grouped element, assign $this (the step itself) as processing element
472         // Note method must exist or we'll get one @restore_path_element_exception
473         foreach($paths as $key => $pelement) {
474             if ($pelement->get_processing_object() === null && !$this->grouped_parent_exists($pelement, $paths)) {
475                 $paths[$key]->set_processing_object($this);
476             }
477             // Populate $elementsoldid and $elementsoldid based on available pathelements
478             $this->elementsoldid[$pelement->get_name()] = null;
479             $this->elementsnewid[$pelement->get_name()] = null;
480         }
481         // Done, add them to pathelements (dupes by key - path - are discarded)
482         $this->pathelements = array_merge($this->pathelements, $paths);
483     }
485     /**
486      * Given one pathelement, return true if grouped parent was found
487      */
488     protected function grouped_parent_exists($pelement, $elements) {
489         foreach ($elements as $element) {
490             if ($pelement->get_path() == $element->get_path()) {
491                 continue; // Don't compare against itself
492             }
493             // If element is grouped and parent of pelement, return true
494             if ($element->is_grouped() and strpos($pelement->get_path() .  '/', $element->get_path()) === 0) {
495                 return true;
496             }
497         }
498         return false; // no grouped parent found
499     }
501     /**
502      * To conditionally decide if one step will be executed or no
503      *
504      * For steps needing to be executed conditionally, based in dynamic
505      * conditions (at execution time vs at declaration time) you must
506      * override this function. It will return true if the step must be
507      * executed and false if not
508      */
509     protected function execute_condition() {
510         return true;
511     }
513     /**
514      * Function that will return the structure to be processed by this restore_step.
515      * Must return one array of @restore_path_element elements
516      */
517     abstract protected function define_structure();