4a4b1badabffbb7be60a0767e49dc43ffb68d021
[moodle.git] / backup / moodle2 / restore_stepslib.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  * Define all the restore steps that will be used by common tasks in restore
27  */
29 /**
30  * delete old directories and conditionally create backup_temp_ids table
31  */
32 class restore_create_and_clean_temp_stuff extends restore_execution_step {
34     protected function define_execution() {
35         $exists = restore_controller_dbops::create_restore_temp_tables($this->get_restoreid()); // temp tables conditionally
36         // If the table already exists, it's because restore_prechecks have been executed in the same
37         // request (without problems) and it already contains a bunch of preloaded information (users...)
38         // that we aren't going to execute again
39         if ($exists) { // Inform plan about preloaded information
40             $this->task->set_preloaded_information();
41         }
42         // Create the old-course-ctxid to new-course-ctxid mapping, we need that available since the beginning
43         $itemid = $this->task->get_old_contextid();
44         $newitemid = get_context_instance(CONTEXT_COURSE, $this->get_courseid())->id;
45         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'context', $itemid, $newitemid);
46         // Create the old-system-ctxid to new-system-ctxid mapping, we need that available since the beginning
47         $itemid = $this->task->get_old_system_contextid();
48         $newitemid = get_context_instance(CONTEXT_SYSTEM)->id;
49         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'context', $itemid, $newitemid);
50         // Create the old-course-id to new-course-id mapping, we need that available since the beginning
51         $itemid = $this->task->get_old_courseid();
52         $newitemid = $this->get_courseid();
53         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'course', $itemid, $newitemid);
55     }
56 }
58 /**
59  * delete the temp dir used by backup/restore (conditionally),
60  * delete old directories and drop temp ids table
61  */
62 class restore_drop_and_clean_temp_stuff extends restore_execution_step {
64     protected function define_execution() {
65         global $CFG;
66         restore_controller_dbops::drop_restore_temp_tables($this->get_restoreid()); // Drop ids temp table
67         backup_helper::delete_old_backup_dirs(time() - (4 * 60 * 60));              // Delete > 4 hours temp dirs
68         if (empty($CFG->keeptempdirectoriesonbackup)) { // Conditionally
69             backup_helper::delete_backup_dir($this->task->get_tempdir()); // Empty restore dir
70         }
71     }
72 }
74 /**
75  * Restore calculated grade items, grade categories etc
76  */
77 class restore_gradebook_structure_step extends restore_structure_step {
79     /**
80      * To conditionally decide if this step must be executed
81      * Note the "settings" conditions are evaluated in the
82      * corresponding task. Here we check for other conditions
83      * not being restore settings (files, site settings...)
84      */
85      protected function execute_condition() {
86         global $CFG, $DB;
88         // No gradebook info found, don't execute
89         $fullpath = $this->task->get_taskbasepath();
90         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
91         if (!file_exists($fullpath)) {
92             return false;
93         }
95         // Some module present in backup file isn't available to restore
96         // in this site, don't execute
97         if ($this->task->is_missing_modules()) {
98             return false;
99         }
101         // Some activity has been excluded to be restored, don't execute
102         if ($this->task->is_excluding_activities()) {
103             return false;
104         }
106         // There should only be one grade category (the 1 associated with the course itself)
107         // If other categories already exist we're restoring into an existing course.
108         // Restoring categories into a course with an existing category structure is unlikely to go well
109         $category = new stdclass();
110         $category->courseid  = $this->get_courseid();
111         $catcount = $DB->count_records('grade_categories', (array)$category);
112         if ($catcount>1) {
113             return false;
114         }
116         // Arrived here, execute the step
117         return true;
118      }
120     protected function define_structure() {
121         $paths = array();
122         $userinfo = $this->task->get_setting_value('users');
124         $paths[] = new restore_path_element('gradebook', '/gradebook');
125         $paths[] = new restore_path_element('grade_category', '/gradebook/grade_categories/grade_category');
126         $paths[] = new restore_path_element('grade_item', '/gradebook/grade_items/grade_item');
127         if ($userinfo) {
128             $paths[] = new restore_path_element('grade_grade', '/gradebook/grade_items/grade_item/grade_grades/grade_grade');
129         }
130         $paths[] = new restore_path_element('grade_letter', '/gradebook/grade_letters/grade_letter');
131         $paths[] = new restore_path_element('grade_setting', '/gradebook/grade_settings/grade_setting');
133         return $paths;
134     }
136     protected function process_gradebook($data) {
137     }
139     protected function process_grade_item($data) {
140         global $DB;
142         $data = (object)$data;
144         $oldid = $data->id;
145         $data->course = $this->get_courseid();
147         $data->courseid = $this->get_courseid();
149         if ($data->itemtype=='manual') {
150             // manual grade items store category id in categoryid
151             $data->categoryid = $this->get_mappingid('grade_category', $data->categoryid, NULL);
152         } else if ($data->itemtype=='course') {
153             // course grade item stores their category id in iteminstance
154             $coursecat = grade_category::fetch_course_category($this->get_courseid());
155             $data->iteminstance = $coursecat->id;
156         } else if ($data->itemtype=='category') {
157             // category grade items store their category id in iteminstance
158             $data->iteminstance = $this->get_mappingid('grade_category', $data->iteminstance, NULL);
159         } else {
160             throw new restore_step_exception('unexpected_grade_item_type', $data->itemtype);
161         }
163         $data->scaleid   = $this->get_mappingid('scale', $data->scaleid, NULL);
164         $data->outcomeid = $this->get_mappingid('outcome', $data->outcomeid, NULL);
166         $data->locktime     = $this->apply_date_offset($data->locktime);
167         $data->timecreated  = $this->apply_date_offset($data->timecreated);
168         $data->timemodified = $this->apply_date_offset($data->timemodified);
170         $coursecategory = $newitemid = null;
171         //course grade item should already exist so updating instead of inserting
172         if($data->itemtype=='course') {
173             //get the ID of the already created grade item
174             $gi = new stdclass();
175             $gi->courseid  = $this->get_courseid();
176             $gi->itemtype  = $data->itemtype;
178             //need to get the id of the grade_category that was automatically created for the course
179             $category = new stdclass();
180             $category->courseid  = $this->get_courseid();
181             $category->parent  = null;
182             //course category fullname starts out as ? but may be edited
183             //$category->fullname  = '?';
184             $coursecategory = $DB->get_record('grade_categories', (array)$category);
185             $gi->iteminstance = $coursecategory->id;
187             $existinggradeitem = $DB->get_record('grade_items', (array)$gi);
188             if (!empty($existinggradeitem)) {
189                 $data->id = $newitemid = $existinggradeitem->id;
190                 $DB->update_record('grade_items', $data);
191             }
192         }
194         if (empty($newitemid)) {
195             //in case we found the course category but still need to insert the course grade item
196             if ($data->itemtype=='course' && !empty($coursecategory)) {
197                 $data->iteminstance = $coursecategory->id;
198             }
200             $newitemid = $DB->insert_record('grade_items', $data);
201         }
202         $this->set_mapping('grade_item', $oldid, $newitemid);
203     }
205     protected function process_grade_grade($data) {
206         global $DB;
208         $data = (object)$data;
209         $oldid = $data->id;
211         $data->itemid = $this->get_new_parentid('grade_item');
213         $data->userid = $this->get_mappingid('user', $data->userid, NULL);
214         $data->usermodified = $this->get_mappingid('user', $data->usermodified, NULL);
215         $data->locktime     = $this->apply_date_offset($data->locktime);
216         // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
217         $data->overridden = $this->apply_date_offset($data->overridden);
218         $data->timecreated  = $this->apply_date_offset($data->timecreated);
219         $data->timemodified = $this->apply_date_offset($data->timemodified);
221         $newitemid = $DB->insert_record('grade_grades', $data);
222         //$this->set_mapping('grade_grade', $oldid, $newitemid);
223     }
224     protected function process_grade_category($data) {
225         global $DB;
227         $data = (object)$data;
228         $oldid = $data->id;
230         $data->course = $this->get_courseid();
231         $data->courseid = $data->course;
233         $data->timecreated  = $this->apply_date_offset($data->timecreated);
234         $data->timemodified = $this->apply_date_offset($data->timemodified);
236         $newitemid = null;
237         //no parent means a course level grade category. That may have been created when the course was created
238         if(empty($data->parent)) {
239             //parent was being saved as 0 when it should be null
240             $data->parent = null;
242             //get the already created course level grade category
243             $category = new stdclass();
244             $category->courseid = $this->get_courseid();
245             $category->parent = null;
247             $coursecategory = $DB->get_record('grade_categories', (array)$category);
248             if (!empty($coursecategory)) {
249                 $data->id = $newitemid = $coursecategory->id;
250                 $DB->update_record('grade_categories', $data);
251             }
252         }
254         //need to insert a course category
255         if (empty($newitemid)) {
256             $newitemid = $DB->insert_record('grade_categories', $data);
257         }
258         $this->set_mapping('grade_category', $oldid, $newitemid);
259     }
260     protected function process_grade_letter($data) {
261         global $DB;
263         $data = (object)$data;
264         $oldid = $data->id;
266         $data->contextid = get_context_instance(CONTEXT_COURSE, $this->get_courseid())->id;
268         $newitemid = $DB->insert_record('grade_letters', $data);
269         $this->set_mapping('grade_letter', $oldid, $newitemid);
270     }
271     protected function process_grade_setting($data) {
272         global $DB;
274         $data = (object)$data;
275         $oldid = $data->id;
277         $data->courseid = $this->get_courseid();
279         $newitemid = $DB->insert_record('grade_settings', $data);
280         //$this->set_mapping('grade_setting', $oldid, $newitemid);
281     }
283     /**
284      * put all activity grade items in the correct grade category and mark all for recalculation
285      */
286     protected function after_execute() {
287         global $DB;
289         $conditions = array(
290             'backupid' => $this->get_restoreid(),
291             'itemname' => 'grade_item'//,
292             //'itemid'   => $itemid
293         );
294         $rs = $DB->get_recordset('backup_ids_temp', $conditions);
296         // We need this for calculation magic later on.
297         $mappings = array();
299         if (!empty($rs)) {
300             foreach($rs as $grade_item_backup) {
302                 // Store the oldid with the new id.
303                 $mappings[$grade_item_backup->itemid] = $grade_item_backup->newitemid;
305                 $updateobj = new stdclass();
306                 $updateobj->id = $grade_item_backup->newitemid;
308                 //if this is an activity grade item that needs to be put back in its correct category
309                 if (!empty($grade_item_backup->parentitemid)) {
310                     $oldcategoryid = $this->get_mappingid('grade_category', $grade_item_backup->parentitemid, null);
311                     if (!is_null($oldcategoryid)) {
312                         $updateobj->categoryid = $oldcategoryid;
313                         $DB->update_record('grade_items', $updateobj);
314                     }
315                 } else {
316                     //mark course and category items as needing to be recalculated
317                     $updateobj->needsupdate=1;
318                     $DB->update_record('grade_items', $updateobj);
319                 }
320             }
321         }
322         $rs->close();
324         // We need to update the calculations for calculated grade items that may reference old
325         // grade item ids using ##gi\d+##.
326         list($sql, $params) = $DB->get_in_or_equal(array_values($mappings), SQL_PARAMS_NAMED);
327         $sql = "SELECT gi.id, gi.calculation
328                   FROM {grade_items} gi
329                  WHERE gi.id {$sql} AND
330                        calculation IS NOT NULL";
331         $rs = $DB->get_recordset_sql($sql, $params);
332         foreach ($rs as $gradeitem) {
333             // Collect all of the used grade item id references
334             if (preg_match_all('/##gi(\d+)##/', $gradeitem->calculation, $matches) < 1) {
335                 // This calculation doesn't reference any other grade items... EASY!
336                 continue;
337             }
338             // For this next bit we are going to do the replacement of id's in two steps:
339             // 1. We will replace all old id references with a special mapping reference.
340             // 2. We will replace all mapping references with id's
341             // Why do we do this?
342             // Because there potentially there will be an overlap of ids within the query and we
343             // we substitute the wrong id.. safest way around this is the two step system
344             $calculationmap = array();
345             $mapcount = 0;
346             foreach ($matches[1] as $match) {
347                 // Check that the old id is known to us, if not it was broken to begin with and will
348                 // continue to be broken.
349                 if (!array_key_exists($match, $mappings)) {
350                     continue;
351                 }
352                 // Our special mapping key
353                 $mapping = '##MAPPING'.$mapcount.'##';
354                 // The old id that exists within the calculation now
355                 $oldid = '##gi'.$match.'##';
356                 // The new id that we want to replace the old one with.
357                 $newid = '##gi'.$mappings[$match].'##';
358                 // Replace in the special mapping key
359                 $gradeitem->calculation = str_replace($oldid, $mapping, $gradeitem->calculation);
360                 // And record the mapping
361                 $calculationmap[$mapping] = $newid;
362                 $mapcount++;
363             }
364             // Iterate all special mappings for this calculation and replace in the new id's
365             foreach ($calculationmap as $mapping => $newid) {
366                 $gradeitem->calculation = str_replace($mapping, $newid, $gradeitem->calculation);
367             }
368             // Update the calculation now that its being remapped
369             $DB->update_record('grade_items', $gradeitem);
370         }
371         $rs->close();
373         //need to correct the grade category path and parent
374         $conditions = array(
375             'courseid' => $this->get_courseid()
376         );
377         $grade_category = new stdclass();
379         $rs = $DB->get_recordset('grade_categories', $conditions);
380         if (!empty($rs)) {
381             //get all the parents correct first as grade_category::build_path() loads category parents from the DB
382             foreach($rs as $gc) {
383                 if (!empty($gc->parent)) {
384                     $grade_category->id = $gc->id;
385                     $grade_category->parent = $this->get_mappingid('grade_category', $gc->parent);
386                     $DB->update_record('grade_categories', $grade_category);
387                 }
388             }
389         }
390         if (isset($grade_category->parent)) {
391             unset($grade_category->parent);
392         }
393         $rs->close();
395         $rs = $DB->get_recordset('grade_categories', $conditions);
396         if (!empty($rs)) {
397             //now we can rebuild all the paths
398             foreach($rs as $gc) {
399                 $grade_category->id = $gc->id;
400                 $grade_category->path = grade_category::build_path($gc);
401                 $DB->update_record('grade_categories', $grade_category);
402             }
403         }
404         $rs->close();
406         //Restore marks items as needing update. Update everything now.
407         grade_regrade_final_grades($this->get_courseid());
408     }
411 /**
412  * decode all the interlinks present in restored content
413  * relying 100% in the restore_decode_processor that handles
414  * both the contents to modify and the rules to be applied
415  */
416 class restore_decode_interlinks extends restore_execution_step {
418     protected function define_execution() {
419         // Get the decoder (from the plan)
420         $decoder = $this->task->get_decoder();
421         restore_decode_processor::register_link_decoders($decoder); // Add decoder contents and rules
422         // And launch it, everything will be processed
423         $decoder->execute();
424     }
427 /**
428  * first, ensure that we have no gaps in section numbers
429  * and then, rebuid the course cache
430  */
431 class restore_rebuild_course_cache extends restore_execution_step {
433     protected function define_execution() {
434         global $DB;
436         // Although there is some sort of auto-recovery of missing sections
437         // present in course/formats... here we check that all the sections
438         // from 0 to MAX(section->section) exist, creating them if necessary
439         $maxsection = $DB->get_field('course_sections', 'MAX(section)', array('course' => $this->get_courseid()));
440         // Iterate over all sections
441         for ($i = 0; $i <= $maxsection; $i++) {
442             // If the section $i doesn't exist, create it
443             if (!$DB->record_exists('course_sections', array('course' => $this->get_courseid(), 'section' => $i))) {
444                 $sectionrec = array(
445                     'course' => $this->get_courseid(),
446                     'section' => $i);
447                 $DB->insert_record('course_sections', $sectionrec); // missing section created
448             }
449         }
451         // Rebuild cache now that all sections are in place
452         rebuild_course_cache($this->get_courseid());
453     }
456 /**
457  * Review all the tasks having one after_restore method
458  * executing it to perform some final adjustments of information
459  * not available when the task was executed.
460  */
461 class restore_execute_after_restore extends restore_execution_step {
463     protected function define_execution() {
465         // Simply call to the execute_after_restore() method of the task
466         // that always is the restore_final_task
467         $this->task->launch_execute_after_restore();
468     }
472 /**
473  * Review all the (pending) block positions in backup_ids, matching by
474  * contextid, creating positions as needed. This is executed by the
475  * final task, once all the contexts have been created
476  */
477 class restore_review_pending_block_positions extends restore_execution_step {
479     protected function define_execution() {
480         global $DB;
482         // Get all the block_position objects pending to match
483         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
484         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid');
485         // Process block positions, creating them or accumulating for final step
486         foreach($rs as $posrec) {
487             // Get the complete position object (stored as info)
488             $position = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'block_position', $posrec->itemid)->info;
489             // If position is for one already mapped (known) contextid
490             // process it now, creating the position, else nothing to
491             // do, position finally discarded
492             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
493                 $position->contextid = $newctx->newitemid;
494                 // Create the block position
495                 $DB->insert_record('block_positions', $position);
496             }
497         }
498         $rs->close();
499     }
502 /**
503  * Process all the saved module availability records in backup_ids, matching
504  * course modules and grade item id once all them have been already restored.
505  * only if all matchings are satisfied the availability condition will be created.
506  * At the same time, it is required for the site to have that functionality enabled.
507  */
508 class restore_process_course_modules_availability extends restore_execution_step {
510     protected function define_execution() {
511         global $CFG, $DB;
513         // Site hasn't availability enabled
514         if (empty($CFG->enableavailability)) {
515             return;
516         }
518         // Get all the module_availability objects to process
519         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'module_availability');
520         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid');
521         // Process availabilities, creating them if everything matches ok
522         foreach($rs as $availrec) {
523             $allmatchesok = true;
524             // Get the complete availabilityobject
525             $availability = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'module_availability', $availrec->itemid)->info;
526             // Map the sourcecmid if needed and possible
527             if (!empty($availability->sourcecmid)) {
528                 $newcm = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'course_module', $availability->sourcecmid);
529                 if ($newcm) {
530                     $availability->sourcecmid = $newcm->newitemid;
531                 } else {
532                     $allmatchesok = false; // Failed matching, we won't create this availability rule
533                 }
534             }
535             // Map the gradeitemid if needed and possible
536             if (!empty($availability->gradeitemid)) {
537                 $newgi = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'grade_item', $availability->gradeitemid);
538                 if ($newgi) {
539                     $availability->gradeitemid = $newgi->newitemid;
540                 } else {
541                     $allmatchesok = false; // Failed matching, we won't create this availability rule
542                 }
543             }
544             if ($allmatchesok) { // Everything ok, create the availability rule
545                 $DB->insert_record('course_modules_availability', $availability);
546             }
547         }
548         $rs->close();
549     }
553 /*
554  * Execution step that, *conditionally* (if there isn't preloaded information)
555  * will load the inforef files for all the included course/section/activity tasks
556  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
557  */
558 class restore_load_included_inforef_records extends restore_execution_step {
560     protected function define_execution() {
562         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
563             return;
564         }
566         // Get all the included tasks
567         $tasks = restore_dbops::get_included_tasks($this->get_restoreid());
568         foreach ($tasks as $task) {
569             // Load the inforef.xml file if exists
570             $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
571             if (file_exists($inforefpath)) {
572                 restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $inforefpath); // Load each inforef file to temp_ids
573             }
574         }
575     }
578 /*
579  * Execution step that will load all the needed files into backup_files_temp
580  *   - info: contains the whole original object (times, names...)
581  * (all them being original ids as loaded from xml)
582  */
583 class restore_load_included_files extends restore_structure_step {
585     protected function define_structure() {
587         $file = new restore_path_element('file', '/files/file');
589         return array($file);
590     }
592     // Processing functions go here
593     public function process_file($data) {
595         $data = (object)$data; // handy
597         // load it if needed:
598         //   - it it is one of the annotated inforef files (course/section/activity/block)
599         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
600         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
601         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
602         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
603         $iscomponent = ($data->component == 'user' || $data->component == 'group' ||
604                         $data->component == 'grouping' || $data->component == 'grade' ||
605                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
606         if ($isfileref || $iscomponent) {
607             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
608         }
609     }
612 /**
613  * Execution step that, *conditionally* (if there isn't preloaded information),
614  * will load all the needed roles to backup_temp_ids. They will be stored with
615  * "role" itemname. Also it will perform one automatic mapping to roles existing
616  * in the target site, based in permissions of the user performing the restore,
617  * archetypes and other bits. At the end, each original role will have its associated
618  * target role or 0 if it's going to be skipped. Note we wrap everything over one
619  * restore_dbops method, as far as the same stuff is going to be also executed
620  * by restore prechecks
621  */
622 class restore_load_and_map_roles extends restore_execution_step {
624     protected function define_execution() {
625         if ($this->task->get_preloaded_information()) { // if info is already preloaded
626             return;
627         }
629         $file = $this->get_basepath() . '/roles.xml';
630         // Load needed toles to temp_ids
631         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
633         // Process roles, mapping/skipping. Any error throws exception
634         // Note we pass controller's info because it can contain role mapping information
635         // about manual mappings performed by UI
636         restore_dbops::process_included_roles($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite(), $this->task->get_info()->role_mappings);
637     }
640 /**
641  * Execution step that, *conditionally* (if there isn't preloaded information
642  * and users have been selected in settings, will load all the needed users
643  * to backup_temp_ids. They will be stored with "user" itemname and with
644  * their original contextid as paremitemid
645  */
646 class restore_load_included_users extends restore_execution_step {
648     protected function define_execution() {
650         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
651             return;
652         }
653         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
654             return;
655         }
656         $file = $this->get_basepath() . '/users.xml';
657         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file); // Load needed users to temp_ids
658     }
661 /**
662  * Execution step that, *conditionally* (if there isn't preloaded information
663  * and users have been selected in settings, will process all the needed users
664  * in order to decide and perform any action with them (create / map / error)
665  * Note: Any error will cause exception, as far as this is the same processing
666  * than the one into restore prechecks (that should have stopped process earlier)
667  */
668 class restore_process_included_users extends restore_execution_step {
670     protected function define_execution() {
672         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
673             return;
674         }
675         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
676             return;
677         }
678         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
679     }
682 /**
683  * Execution step that will create all the needed users as calculated
684  * by @restore_process_included_users (those having newiteind = 0)
685  */
686 class restore_create_included_users extends restore_execution_step {
688     protected function define_execution() {
690         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(), $this->get_setting_value('user_files'), $this->task->get_userid());
691     }
694 /**
695  * Structure step that will create all the needed groups and groupings
696  * by loading them from the groups.xml file performing the required matches.
697  * Note group members only will be added if restoring user info
698  */
699 class restore_groups_structure_step extends restore_structure_step {
701     protected function define_structure() {
703         $paths = array(); // Add paths here
705         $paths[] = new restore_path_element('group', '/groups/group');
706         if ($this->get_setting_value('users')) {
707             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
708         }
709         $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
710         $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
712         return $paths;
713     }
715     // Processing functions go here
716     public function process_group($data) {
717         global $DB;
719         $data = (object)$data; // handy
720         $data->courseid = $this->get_courseid();
722         $oldid = $data->id;    // need this saved for later
724         $restorefiles = false; // Only if we end creating the group
726         // Search if the group already exists (by name & description) in the target course
727         $description_clause = '';
728         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
729         if (!empty($data->description)) {
730             $description_clause = ' AND ' .
731                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
732            $params['description'] = $data->description;
733         }
734         if (!$groupdb = $DB->get_record_sql("SELECT *
735                                                FROM {groups}
736                                               WHERE courseid = :courseid
737                                                 AND name = :grname $description_clause", $params)) {
738             // group doesn't exist, create
739             $newitemid = $DB->insert_record('groups', $data);
740             $restorefiles = true; // We'll restore the files
741         } else {
742             // group exists, use it
743             $newitemid = $groupdb->id;
744         }
745         // Save the id mapping
746         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
747     }
749     public function process_member($data) {
750         global $DB;
752         $data = (object)$data; // handy
754         // get parent group->id
755         $data->groupid = $this->get_new_parentid('group');
757         // map user newitemid and insert if not member already
758         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
759             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
760                 $DB->insert_record('groups_members', $data);
761             }
762         }
763     }
765     public function process_grouping($data) {
766         global $DB;
768         $data = (object)$data; // handy
769         $data->courseid = $this->get_courseid();
771         $oldid = $data->id;    // need this saved for later
772         $restorefiles = false; // Only if we end creating the grouping
774         // Search if the grouping already exists (by name & description) in the target course
775         $description_clause = '';
776         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
777         if (!empty($data->description)) {
778             $description_clause = ' AND ' .
779                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
780            $params['description'] = $data->description;
781         }
782         if (!$groupingdb = $DB->get_record_sql("SELECT *
783                                                   FROM {groupings}
784                                                  WHERE courseid = :courseid
785                                                    AND name = :grname $description_clause", $params)) {
786             // grouping doesn't exist, create
787             $newitemid = $DB->insert_record('groupings', $data);
788             $restorefiles = true; // We'll restore the files
789         } else {
790             // grouping exists, use it
791             $newitemid = $groupingdb->id;
792         }
793         // Save the id mapping
794         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
795     }
797     public function process_grouping_group($data) {
798         global $DB;
800         $data = (object)$data;
802         $data->groupingid = $this->get_new_parentid('grouping'); // Use new parentid
803         $data->groupid    = $this->get_mappingid('group', $data->groupid); // Get from mappings
804         $DB->insert_record('groupings_groups', $data);  // No need to set this mapping (no child info nor files)
805     }
807     protected function after_execute() {
808         // Add group related files, matching with "group" mappings
809         $this->add_related_files('group', 'icon', 'group');
810         $this->add_related_files('group', 'description', 'group');
811         // Add grouping related files, matching with "grouping" mappings
812         $this->add_related_files('grouping', 'description', 'grouping');
813     }
817 /**
818  * Structure step that will create all the needed scales
819  * by loading them from the scales.xml
820  */
821 class restore_scales_structure_step extends restore_structure_step {
823     protected function define_structure() {
825         $paths = array(); // Add paths here
826         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
827         return $paths;
828     }
830     protected function process_scale($data) {
831         global $DB;
833         $data = (object)$data;
835         $restorefiles = false; // Only if we end creating the group
837         $oldid = $data->id;    // need this saved for later
839         // Look for scale (by 'scale' both in standard (course=0) and current course
840         // with priority to standard scales (ORDER clause)
841         // scale is not course unique, use get_record_sql to suppress warning
842         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
843         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
844         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
845         if (!$scadb = $DB->get_record_sql("SELECT *
846                                             FROM {scale}
847                                            WHERE courseid IN (0, :courseid)
848                                              AND $compare_scale_clause
849                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
850             // Remap the user if possible, defaut to user performing the restore if not
851             $userid = $this->get_mappingid('user', $data->userid);
852             $data->userid = $userid ? $userid : $this->task->get_userid();
853             // Remap the course if course scale
854             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
855             // If global scale (course=0), check the user has perms to create it
856             // falling to course scale if not
857             $systemctx = get_context_instance(CONTEXT_SYSTEM);
858             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
859                 $data->courseid = $this->get_courseid();
860             }
861             // scale doesn't exist, create
862             $newitemid = $DB->insert_record('scale', $data);
863             $restorefiles = true; // We'll restore the files
864         } else {
865             // scale exists, use it
866             $newitemid = $scadb->id;
867         }
868         // Save the id mapping (with files support at system context)
869         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
870     }
872     protected function after_execute() {
873         // Add scales related files, matching with "scale" mappings
874         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
875     }
879 /**
880  * Structure step that will create all the needed outocomes
881  * by loading them from the outcomes.xml
882  */
883 class restore_outcomes_structure_step extends restore_structure_step {
885     protected function define_structure() {
887         $paths = array(); // Add paths here
888         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
889         return $paths;
890     }
892     protected function process_outcome($data) {
893         global $DB;
895         $data = (object)$data;
897         $restorefiles = false; // Only if we end creating the group
899         $oldid = $data->id;    // need this saved for later
901         // Look for outcome (by shortname both in standard (courseid=null) and current course
902         // with priority to standard outcomes (ORDER clause)
903         // outcome is not course unique, use get_record_sql to suppress warning
904         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
905         if (!$outdb = $DB->get_record_sql('SELECT *
906                                              FROM {grade_outcomes}
907                                             WHERE shortname = :shortname
908                                               AND (courseid = :courseid OR courseid IS NULL)
909                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
910             // Remap the user
911             $userid = $this->get_mappingid('user', $data->usermodified);
912             $data->usermodified = $userid ? $userid : $this->task->get_userid();
913             // Remap the scale
914             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
915             // Remap the course if course outcome
916             $data->courseid = $data->courseid ? $this->get_courseid() : null;
917             // If global outcome (course=null), check the user has perms to create it
918             // falling to course outcome if not
919             $systemctx = get_context_instance(CONTEXT_SYSTEM);
920             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
921                 $data->courseid = $this->get_courseid();
922             }
923             // outcome doesn't exist, create
924             $newitemid = $DB->insert_record('grade_outcomes', $data);
925             $restorefiles = true; // We'll restore the files
926         } else {
927             // scale exists, use it
928             $newitemid = $outdb->id;
929         }
930         // Set the corresponding grade_outcomes_courses record
931         $outcourserec = new stdclass();
932         $outcourserec->courseid  = $this->get_courseid();
933         $outcourserec->outcomeid = $newitemid;
934         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
935             $DB->insert_record('grade_outcomes_courses', $outcourserec);
936         }
937         // Save the id mapping (with files support at system context)
938         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
939     }
941     protected function after_execute() {
942         // Add outcomes related files, matching with "outcome" mappings
943         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
944     }
947 /**
948  * Execution step that, *conditionally* (if there isn't preloaded information
949  * will load all the question categories and questions (header info only)
950  * to backup_temp_ids. They will be stored with "question_category" and
951  * "question" itemnames and with their original contextid and question category
952  * id as paremitemids
953  */
954 class restore_load_categories_and_questions extends restore_execution_step {
956     protected function define_execution() {
958         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
959             return;
960         }
961         $file = $this->get_basepath() . '/questions.xml';
962         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
963     }
966 /**
967  * Execution step that, *conditionally* (if there isn't preloaded information)
968  * will process all the needed categories and questions
969  * in order to decide and perform any action with them (create / map / error)
970  * Note: Any error will cause exception, as far as this is the same processing
971  * than the one into restore prechecks (that should have stopped process earlier)
972  */
973 class restore_process_categories_and_questions extends restore_execution_step {
975     protected function define_execution() {
977         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
978             return;
979         }
980         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
981     }
984 /**
985  * Structure step that will read the section.xml creating/updating sections
986  * as needed, rebuilding course cache and other friends
987  */
988 class restore_section_structure_step extends restore_structure_step {
990     protected function define_structure() {
991         $section = new restore_path_element('section', '/section');
993         // Apply for 'format' plugins optional paths at section level
994         $this->add_plugin_structure('format', $section);
996         return array($section);
997     }
999     public function process_section($data) {
1000         global $DB;
1001         $data = (object)$data;
1002         $oldid = $data->id; // We'll need this later
1004         $restorefiles = false;
1006         // Look for the section
1007         $section = new stdclass();
1008         $section->course  = $this->get_courseid();
1009         $section->section = $data->number;
1010         // Section doesn't exist, create it with all the info from backup
1011         if (!$secrec = $DB->get_record('course_sections', (array)$section)) {
1012             $section->name = $data->name;
1013             $section->summary = $data->summary;
1014             $section->summaryformat = $data->summaryformat;
1015             $section->sequence = '';
1016             $section->visible = $data->visible;
1017             $newitemid = $DB->insert_record('course_sections', $section);
1018             $restorefiles = true;
1020         // Section exists, update non-empty information
1021         } else {
1022             $section->id = $secrec->id;
1023             if (empty($secrec->name)) {
1024                 $section->name = $data->name;
1025             }
1026             if (empty($secrec->summary)) {
1027                 $section->summary = $data->summary;
1028                 $section->summaryformat = $data->summaryformat;
1029                 $restorefiles = true;
1030             }
1031             $DB->update_record('course_sections', $section);
1032             $newitemid = $secrec->id;
1033         }
1035         // Annotate the section mapping, with restorefiles option if needed
1036         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
1038         // set the new course_section id in the task
1039         $this->task->set_sectionid($newitemid);
1042         // Commented out. We never modify course->numsections as far as that is used
1043         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
1044         // Note: We keep the code here, to know about and because of the possibility of making this
1045         // optional based on some setting/attribute in the future
1046         // If needed, adjust course->numsections
1047         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
1048         //    if ($numsections < $section->section) {
1049         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
1050         //    }
1051         //}
1052     }
1054     protected function after_execute() {
1055         // Add section related files, with 'course_section' itemid to match
1056         $this->add_related_files('course', 'section', 'course_section');
1057     }
1061 /**
1062  * Structure step that will read the course.xml file, loading it and performing
1063  * various actions depending of the site/restore settings. Note that target
1064  * course always exist before arriving here so this step will be updating
1065  * the course record (never inserting)
1066  */
1067 class restore_course_structure_step extends restore_structure_step {
1069     protected function define_structure() {
1071         $course = new restore_path_element('course', '/course');
1072         $category = new restore_path_element('category', '/course/category');
1073         $tag = new restore_path_element('tag', '/course/tags/tag');
1074         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1076         // Apply for 'format' plugins optional paths at course level
1077         $this->add_plugin_structure('format', $course);
1079         // Apply for 'theme' plugins optional paths at course level
1080         $this->add_plugin_structure('theme', $course);
1082         // Apply for 'course report' plugins optional paths at course level
1083         $this->add_plugin_structure('coursereport', $course);
1085         // Apply for plagiarism plugins optional paths at course level
1086         $this->add_plugin_structure('plagiarism', $course);
1088         return array($course, $category, $tag, $allowed_module);
1089     }
1091     /**
1092      * Processing functions go here
1093      *
1094      * @global moodledatabase $DB
1095      * @param stdClass $data
1096      */
1097     public function process_course($data) {
1098         global $CFG, $DB;
1100         $data = (object)$data;
1101         $oldid = $data->id; // We'll need this later
1103         $fullname  = $this->get_setting_value('course_fullname');
1104         $shortname = $this->get_setting_value('course_shortname');
1105         $startdate = $this->get_setting_value('course_startdate');
1107         // Calculate final course names, to avoid dupes
1108         list($fullname, $shortname) = restore_dbops::calculate_course_names($this->get_courseid(), $fullname, $shortname);
1110         // Need to change some fields before updating the course record
1111         $data->id = $this->get_courseid();
1112         $data->fullname = $fullname;
1113         $data->shortname= $shortname;
1114         $data->idnumber = '';
1116         // Only restrict modules if original course was and target site too for new courses
1117         $data->restrictmodules = $data->restrictmodules && !empty($CFG->restrictmodulesfor) && $CFG->restrictmodulesfor == 'all';
1119         $data->startdate= $this->apply_date_offset($data->startdate);
1120         if ($data->defaultgroupingid) {
1121             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1122         }
1123         if (empty($CFG->enablecompletion)) {
1124             $data->enablecompletion = 0;
1125             $data->completionstartonenrol = 0;
1126             $data->completionnotify = 0;
1127         }
1128         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1129         if (!array_key_exists($data->lang, $languages)) {
1130             $data->lang = '';
1131         }
1133         $themes = get_list_of_themes(); // Get themes for quick search later
1134         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1135             $data->theme = '';
1136         }
1138         // Course record ready, update it
1139         $DB->update_record('course', $data);
1141         // Role name aliases
1142         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1143     }
1145     public function process_category($data) {
1146         // Nothing to do with the category. UI sets it before restore starts
1147     }
1149     public function process_tag($data) {
1150         global $CFG, $DB;
1152         $data = (object)$data;
1154         if (!empty($CFG->usetags)) { // if enabled in server
1155             // TODO: This is highly inneficient. Each time we add one tag
1156             // we fetch all the existing because tag_set() deletes them
1157             // so everything must be reinserted on each call
1158             $tags = array();
1159             $existingtags = tag_get_tags('course', $this->get_courseid());
1160             // Re-add all the existitng tags
1161             foreach ($existingtags as $existingtag) {
1162                 $tags[] = $existingtag->rawname;
1163             }
1164             // Add the one being restored
1165             $tags[] = $data->rawname;
1166             // Send all the tags back to the course
1167             tag_set('course', $this->get_courseid(), $tags);
1168         }
1169     }
1171     public function process_allowed_module($data) {
1172         global $CFG, $DB;
1174         $data = (object)$data;
1176         // only if enabled by admin setting
1177         if (!empty($CFG->restrictmodulesfor) && $CFG->restrictmodulesfor == 'all') {
1178             $available = get_plugin_list('mod');
1179             $mname = $data->modulename;
1180             if (array_key_exists($mname, $available)) {
1181                 if ($module = $DB->get_record('modules', array('name' => $mname, 'visible' => 1))) {
1182                     $rec = new stdclass();
1183                     $rec->course = $this->get_courseid();
1184                     $rec->module = $module->id;
1185                     if (!$DB->record_exists('course_allowed_modules', (array)$rec)) {
1186                         $DB->insert_record('course_allowed_modules', $rec);
1187                     }
1188                 }
1189             }
1190         }
1191     }
1193     protected function after_execute() {
1194         // Add course related files, without itemid to match
1195         $this->add_related_files('course', 'summary', null);
1196         $this->add_related_files('course', 'legacy', null);
1197     }
1201 /*
1202  * Structure step that will read the roles.xml file (at course/activity/block levels)
1203  * containig all the role_assignments and overrides for that context. If corresponding to
1204  * one mapped role, they will be applied to target context. Will observe the role_assignments
1205  * setting to decide if ras are restored.
1206  * Note: only ras with component == null are restored as far as the any ra with component
1207  * is handled by one enrolment plugin, hence it will createt the ras later
1208  */
1209 class restore_ras_and_caps_structure_step extends restore_structure_step {
1211     protected function define_structure() {
1213         $paths = array();
1215         // Observe the role_assignments setting
1216         if ($this->get_setting_value('role_assignments')) {
1217             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
1218         }
1219         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
1221         return $paths;
1222     }
1224     /**
1225      * Assign roles
1226      *
1227      * This has to be called after enrolments processing.
1228      *
1229      * @param mixed $data
1230      * @return void
1231      */
1232     public function process_assignment($data) {
1233         global $DB;
1235         $data = (object)$data;
1237         // Check roleid, userid are one of the mapped ones
1238         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
1239             return;
1240         }
1241         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
1242             return;
1243         }
1244         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
1245             // Only assign roles to not deleted users
1246             return;
1247         }
1248         if (!$contextid = $this->task->get_contextid()) {
1249             return;
1250         }
1252         if (empty($data->component)) {
1253             // assign standard manual roles
1254             // TODO: role_assign() needs one userid param to be able to specify our restore userid
1255             role_assign($newroleid, $newuserid, $contextid);
1257         } else if ((strpos($data->component, 'enrol_') === 0)) {
1258             // Deal with enrolment roles
1259             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1260                 if ($component = $DB->get_field('enrol', 'component', array('id'=>$enrolid))) {
1261                     //note: we have to verify component because it might have changed
1262                     if ($component === 'enrol_manual') {
1263                         // manual is a special case, we do not use components - this owudl happen when converting from other plugin
1264                         role_assign($newroleid, $newuserid, $contextid); //TODO: do we need modifierid?
1265                     } else {
1266                         role_assign($newroleid, $newuserid, $contextid, $component, $enrolid); //TODO: do we need modifierid?
1267                     }
1268                 }
1269             }
1270         }
1271     }
1273     public function process_override($data) {
1274         $data = (object)$data;
1276         // Check roleid is one of the mapped ones
1277         $newroleid = $this->get_mappingid('role', $data->roleid);
1278         // If newroleid and context are valid assign it via API (it handles dupes and so on)
1279         if ($newroleid && $this->task->get_contextid()) {
1280             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
1281             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
1282             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
1283         }
1284     }
1287 /**
1288  * This structure steps restores the enrol plugins and their underlying
1289  * enrolments, performing all the mappings and/or movements required
1290  */
1291 class restore_enrolments_structure_step extends restore_structure_step {
1293     protected function define_structure() {
1295         $paths = array();
1297         $paths[] = new restore_path_element('enrol', '/enrolments/enrols/enrol');
1298         $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
1300         return $paths;
1301     }
1303     /**
1304      * Create enrolment instances.
1305      *
1306      * This has to be called after creation of roles
1307      * and before adding of role assignments.
1308      *
1309      * @param mixed $data
1310      * @return void
1311      */
1312     public function process_enrol($data) {
1313         global $DB;
1315         $data = (object)$data;
1316         $oldid = $data->id; // We'll need this later
1318         $restoretype = plugin_supports('enrol', $data->enrol, ENROL_RESTORE_TYPE, null);
1320         if ($restoretype !== ENROL_RESTORE_EXACT and $restoretype !== ENROL_RESTORE_NOUSERS) {
1321             // TODO: add complex restore support via custom class
1322             debugging("Skipping '{$data->enrol}' enrolment plugin. Will be implemented before 2.0 release", DEBUG_DEVELOPER);
1323             $this->set_mapping('enrol', $oldid, 0);
1324             return;
1325         }
1327         // Perform various checks to decide what to do with the enrol plugin
1328         if (!array_key_exists($data->enrol, enrol_get_plugins(false))) {
1329             // TODO: decide if we want to switch to manual enrol - we need UI for this
1330             debugging("Enrol plugin data can not be restored because it is not installed");
1331             $this->set_mapping('enrol', $oldid, 0);
1332             return;
1334         }
1335         if (!enrol_is_enabled($data->enrol)) {
1336             // TODO: decide if we want to switch to manual enrol - we need UI for this
1337             debugging("Enrol plugin data can not be restored because it is not enabled");
1338             $this->set_mapping('enrol', $oldid, 0);
1339             return;
1340         }
1342         // map standard fields - plugin has to process custom fields from own restore class
1343         $data->roleid = $this->get_mappingid('role', $data->roleid);
1344         //TODO: should we move the enrol start and end date here?
1346         // always add instance, if the course does not support multiple instances it just returns NULL
1347         $enrol = enrol_get_plugin($data->enrol);
1348         $courserec = $DB->get_record('course', array('id' => $this->get_courseid())); // Requires object, uses only id!!
1349         if ($newitemid = $enrol->add_instance($courserec, (array)$data)) {
1350             // ok
1351         } else {
1352             if ($instances = $DB->get_records('enrol', array('courseid'=>$courserec->id, 'enrol'=>$data->enrol))) {
1353                 // most probably plugin that supports only one instance
1354                 $newitemid = key($instances);
1355             } else {
1356                 debugging('Can not create new enrol instance or reuse existing');
1357                 $newitemid = 0;
1358             }
1359         }
1361         if ($restoretype === ENROL_RESTORE_NOUSERS) {
1362             // plugin requests to prevent restore of any users
1363             $newitemid = 0;
1364         }
1366         $this->set_mapping('enrol', $oldid, $newitemid);
1367     }
1369     /**
1370      * Create user enrolments
1371      *
1372      * This has to be called after creation of enrolment instances
1373      * and before adding of role assignments.
1374      *
1375      * @param mixed $data
1376      * @return void
1377      */
1378     public function process_enrolment($data) {
1379         global $DB;
1381         $data = (object)$data;
1383         // Process only if parent instance have been mapped
1384         if ($enrolid = $this->get_new_parentid('enrol')) {
1385             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1386                 // And only if user is a mapped one
1387                 if ($userid = $this->get_mappingid('user', $data->userid)) {
1388                     $enrol = enrol_get_plugin($instance->enrol);
1389                     //TODO: do we need specify modifierid?
1390                     $enrol->enrol_user($instance, $userid, null, $data->timestart, $data->timeend, $data->status);
1391                     //note: roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing above
1392                 }
1393             }
1394         }
1395     }
1399 /**
1400  * This structure steps restores the filters and their configs
1401  */
1402 class restore_filters_structure_step extends restore_structure_step {
1404     protected function define_structure() {
1406         $paths = array();
1408         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
1409         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
1411         return $paths;
1412     }
1414     public function process_active($data) {
1416         $data = (object)$data;
1418         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1419             return;
1420         }
1421         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
1422     }
1424     public function process_config($data) {
1426         $data = (object)$data;
1428         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1429             return;
1430         }
1431         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
1432     }
1436 /**
1437  * This structure steps restores the comments
1438  * Note: Cannot use the comments API because defaults to USER->id.
1439  * That should change allowing to pass $userid
1440  */
1441 class restore_comments_structure_step extends restore_structure_step {
1443     protected function define_structure() {
1445         $paths = array();
1447         $paths[] = new restore_path_element('comment', '/comments/comment');
1449         return $paths;
1450     }
1452     public function process_comment($data) {
1453         global $DB;
1455         $data = (object)$data;
1457         // First of all, if the comment has some itemid, ask to the task what to map
1458         $mapping = false;
1459         if ($data->itemid) {
1460             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
1461             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
1462         }
1463         // Only restore the comment if has no mapping OR we have found the matching mapping
1464         if (!$mapping || $data->itemid) {
1465             // Only if user mapping and context
1466             $data->userid = $this->get_mappingid('user', $data->userid);
1467             if ($data->userid && $this->task->get_contextid()) {
1468                 $data->contextid = $this->task->get_contextid();
1469                 // Only if there is another comment with same context/user/timecreated
1470                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
1471                 if (!$DB->record_exists('comments', $params)) {
1472                     $DB->insert_record('comments', $data);
1473                 }
1474             }
1475         }
1476     }
1479 class restore_course_completion_structure_step extends restore_structure_step {
1481     /**
1482      * Conditionally decide if this step should be executed.
1483      *
1484      * This function checks parameters that are not immediate settings to ensure
1485      * that the enviroment is suitable for the restore of course completion info.
1486      *
1487      * This function checks the following four parameters:
1488      *
1489      *   1. Course completion is enabled on the site
1490      *   2. The backup includes course completion information
1491      *   3. All modules are restorable
1492      *   4. All modules are marked for restore.
1493      *
1494      * @return bool True is safe to execute, false otherwise
1495      */
1496     protected function execute_condition() {
1497         global $CFG;
1499         // First check course completion is enabled on this site
1500         if (empty($CFG->enablecompletion)) {
1501             // Disabled, don't restore course completion
1502             return false;
1503         }
1505         // Check it is included in the backup
1506         $fullpath = $this->task->get_taskbasepath();
1507         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1508         if (!file_exists($fullpath)) {
1509             // Not found, can't restore course completion
1510             return false;
1511         }
1513         // Check we are able to restore all backed up modules
1514         if ($this->task->is_missing_modules()) {
1515             return false;
1516         }
1518         // Finally check all modules within the backup are being restored.
1519         if ($this->task->is_excluding_activities()) {
1520             return false;
1521         }
1523         return true;
1524     }
1526     /**
1527      * Define the course completion structure
1528      *
1529      * @return array Array of restore_path_element
1530      */
1531     protected function define_structure() {
1533         // To know if we are including user completion info
1534         $userinfo = $this->get_setting_value('userscompletion');
1536         $paths = array();
1537         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
1538         $paths[] = new restore_path_element('course_completion_notify', '/course_completion/course_completion_notify');
1539         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
1541         if ($userinfo) {
1542             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
1543             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
1544         }
1546         return $paths;
1548     }
1550     /**
1551      * Process course completion criteria
1552      *
1553      * @global moodle_database $DB
1554      * @param stdClass $data
1555      */
1556     public function process_course_completion_criteria($data) {
1557         global $DB;
1559         $data = (object)$data;
1560         $data->course = $this->get_courseid();
1562         // Apply the date offset to the time end field
1563         $data->timeend = $this->apply_date_offset($data->timeend);
1565         // Map the role from the criteria
1566         if (!empty($data->role)) {
1567             $data->role = $this->get_mappingid('role', $data->role);
1568         }
1570         $skipcriteria = false;
1572         // If the completion criteria is for a module we need to map the module instance
1573         // to the new module id.
1574         if (!empty($data->moduleinstance) && !empty($data->module)) {
1575             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
1576             if (empty($data->moduleinstance)) {
1577                 $skipcriteria = true;
1578             }
1579         } else {
1580             $data->module = null;
1581             $data->moduleinstance = null;
1582         }
1584         // We backup the course shortname rather than the ID so that we can match back to the course
1585         if (!empty($data->courseinstanceshortname)) {
1586             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
1587             if (!$courseinstanceid) {
1588                 $skipcriteria = true;
1589             }
1590         } else {
1591             $courseinstanceid = null;
1592         }
1593         $data->courseinstance = $courseinstanceid;
1595         if (!$skipcriteria) {
1596             $params = array(
1597                 'course'         => $data->course,
1598                 'criteriatype'   => $data->criteriatype,
1599                 'enrolperiod'    => $data->enrolperiod,
1600                 'courseinstance' => $data->courseinstance,
1601                 'module'         => $data->module,
1602                 'moduleinstance' => $data->moduleinstance,
1603                 'timeend'        => $data->timeend,
1604                 'gradepass'      => $data->gradepass,
1605                 'role'           => $data->role
1606             );
1607             $newid = $DB->insert_record('course_completion_criteria', $params);
1608             $this->set_mapping('course_completion_criteria', $data->id, $newid);
1609         }
1610     }
1612     /**
1613      * Processes course compltion criteria complete records
1614      *
1615      * @global moodle_database $DB
1616      * @param stdClass $data
1617      */
1618     public function process_course_completion_crit_compl($data) {
1619         global $DB;
1621         $data = (object)$data;
1623         // This may be empty if criteria could not be restored
1624         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
1626         $data->course = $this->get_courseid();
1627         $data->userid = $this->get_mappingid('user', $data->userid);
1629         if (!empty($data->criteriaid) && !empty($data->userid)) {
1630             $params = array(
1631                 'userid' => $data->userid,
1632                 'course' => $data->course,
1633                 'criteriaid' => $data->criteriaid,
1634                 'timecompleted' => $this->apply_date_offset($data->timecompleted)
1635             );
1636             if (isset($data->gradefinal)) {
1637                 $params['gradefinal'] = $data->gradefinal;
1638             }
1639             if (isset($data->unenroled)) {
1640                 $params['unenroled'] = $data->unenroled;
1641             }
1642             if (isset($data->deleted)) {
1643                 $params['deleted'] = $data->deleted;
1644             }
1645             $DB->insert_record('course_completion_crit_compl', $params);
1646         }
1647     }
1649     /**
1650      * Process course completions
1651      *
1652      * @global moodle_database $DB
1653      * @param stdClass $data
1654      */
1655     public function process_course_completions($data) {
1656         global $DB;
1658         $data = (object)$data;
1660         $data->course = $this->get_courseid();
1661         $data->userid = $this->get_mappingid('user', $data->userid);
1663         if (!empty($data->userid)) {
1664             $params = array(
1665                 'userid' => $data->userid,
1666                 'course' => $data->course,
1667                 'deleted' => $data->deleted,
1668                 'timenotified' => $this->apply_date_offset($data->timenotified),
1669                 'timeenrolled' => $this->apply_date_offset($data->timeenrolled),
1670                 'timestarted' => $this->apply_date_offset($data->timestarted),
1671                 'timecompleted' => $this->apply_date_offset($data->timecompleted),
1672                 'reaggregate' => $data->reaggregate
1673             );
1674             $DB->insert_record('course_completions', $params);
1675         }
1676     }
1678     /**
1679      * Process course completion notification records.
1680      *
1681      * Note: As of Moodle 2.0 this table is not being used however it has been
1682      * left in in the hopes that one day the functionality there will be completed
1683      *
1684      * @global moodle_database $DB
1685      * @param stdClass $data
1686      */
1687     public function process_course_completion_notify($data) {
1688         global $DB;
1690         $data = (object)$data;
1692         $data->course = $this->get_courseid();
1693         if (!empty($data->role)) {
1694             $data->role = $this->get_mappingid('role', $data->role);
1695         }
1697         $params = array(
1698             'course' => $data->course,
1699             'role' => $data->role,
1700             'message' => $data->message,
1701             'timesent' => $this->apply_date_offset($data->timesent),
1702         );
1703         $DB->insert_record('course_completion_notify', $params);
1704     }
1706     /**
1707      * Process course completion aggregate methods
1708      *
1709      * @global moodle_database $DB
1710      * @param stdClass $data
1711      */
1712     public function process_course_completion_aggr_methd($data) {
1713         global $DB;
1715         $data = (object)$data;
1717         $data->course = $this->get_courseid();
1719         $params = array(
1720             'course' => $data->course,
1721             'criteriatype' => $data->criteriatype,
1722             'method' => $data->method,
1723             'value' => $data->value,
1724         );
1725         $DB->insert_record('course_completion_aggr_methd', $params);
1726     }
1731 /**
1732  * This structure step restores course logs (cmid = 0), delegating
1733  * the hard work to the corresponding {@link restore_logs_processor} passing the
1734  * collection of {@link restore_log_rule} rules to be observed as they are defined
1735  * by the task. Note this is only executed based in the 'logs' setting.
1736  *
1737  * NOTE: This is executed by final task, to have all the activities already restored
1738  *
1739  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
1740  * records are. There are others like 'calendar' and 'upload' that will be handled
1741  * later.
1742  *
1743  * NOTE: All the missing actions (not able to be restored) are sent to logs for
1744  * debugging purposes
1745  */
1746 class restore_course_logs_structure_step extends restore_structure_step {
1748     /**
1749      * Conditionally decide if this step should be executed.
1750      *
1751      * This function checks the following four parameters:
1752      *
1753      *   1. the course/logs.xml file exists
1754      *
1755      * @return bool true is safe to execute, false otherwise
1756      */
1757     protected function execute_condition() {
1759         // Check it is included in the backup
1760         $fullpath = $this->task->get_taskbasepath();
1761         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1762         if (!file_exists($fullpath)) {
1763             // Not found, can't restore course logs
1764             return false;
1765         }
1767         return true;
1768     }
1770     protected function define_structure() {
1772         $paths = array();
1774         // Simple, one plain level of information contains them
1775         $paths[] = new restore_path_element('log', '/logs/log');
1777         return $paths;
1778     }
1780     protected function process_log($data) {
1781         global $DB;
1783         $data = (object)($data);
1785         $data->time = $this->apply_date_offset($data->time);
1786         $data->userid = $this->get_mappingid('user', $data->userid);
1787         $data->course = $this->get_courseid();
1788         $data->cmid = 0;
1790         // For any reason user wasn't remapped ok, stop processing this
1791         if (empty($data->userid)) {
1792             return;
1793         }
1795         // Everything ready, let's delegate to the restore_logs_processor
1797         // Set some fixed values that will save tons of DB requests
1798         $values = array(
1799             'course' => $this->get_courseid());
1800         // Get instance and process log record
1801         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
1803         // If we have data, insert it, else something went wrong in the restore_logs_processor
1804         if ($data) {
1805             $DB->insert_record('log', $data);
1806         }
1807     }
1810 /**
1811  * This structure step restores activity logs, extending {@link restore_course_logs_structure_step}
1812  * sharing its same structure but modifying the way records are handled
1813  */
1814 class restore_activity_logs_structure_step extends restore_course_logs_structure_step {
1816     protected function process_log($data) {
1817         global $DB;
1819         $data = (object)($data);
1821         $data->time = $this->apply_date_offset($data->time);
1822         $data->userid = $this->get_mappingid('user', $data->userid);
1823         $data->course = $this->get_courseid();
1824         $data->cmid = $this->task->get_moduleid();
1826         // For any reason user wasn't remapped ok, stop processing this
1827         if (empty($data->userid)) {
1828             return;
1829         }
1831         // Everything ready, let's delegate to the restore_logs_processor
1833         // Set some fixed values that will save tons of DB requests
1834         $values = array(
1835             'course' => $this->get_courseid(),
1836             'course_module' => $this->task->get_moduleid(),
1837             $this->task->get_modulename() => $this->task->get_activityid());
1838         // Get instance and process log record
1839         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
1841         // If we have data, insert it, else something went wrong in the restore_logs_processor
1842         if ($data) {
1843             $DB->insert_record('log', $data);
1844         }
1845     }
1848 /**
1849  * This structure step restores the grade items associated with one activity
1850  * All the grade items are made child of the "course" grade item but the original
1851  * categoryid is saved as parentitemid in the backup_ids table, so, when restoring
1852  * the complete gradebook (categories and calculations), that information is
1853  * available there
1854  */
1855 class restore_activity_grades_structure_step extends restore_structure_step {
1857     protected function define_structure() {
1859         $paths = array();
1860         $userinfo = $this->get_setting_value('userinfo');
1862         $paths[] = new restore_path_element('grade_item', '/activity_gradebook/grade_items/grade_item');
1863         $paths[] = new restore_path_element('grade_letter', '/activity_gradebook/grade_letters/grade_letter');
1864         if ($userinfo) {
1865             $paths[] = new restore_path_element('grade_grade',
1866                            '/activity_gradebook/grade_items/grade_item/grade_grades/grade_grade');
1867         }
1868         return $paths;
1869     }
1871     protected function process_grade_item($data) {
1872         global $DB;
1874         $data = (object)($data);
1875         $oldid       = $data->id;        // We'll need these later
1876         $oldparentid = $data->categoryid;
1877         $courseid = $this->get_courseid();
1879         // make sure top course category exists, all grade items will be associated
1880         // to it. Later, if restoring the whole gradebook, categories will be introduced
1881         $coursecat = grade_category::fetch_course_category($courseid);
1882         $coursecatid = $coursecat->id; // Get the categoryid to be used
1884         $idnumber = null;
1885         if (!empty($data->idnumber)) {
1886             // Don't get any idnumber from course module. Keep them as they are in grade_item->idnumber
1887             // Reason: it's not clear what happens with outcomes->idnumber or activities with multiple items (workshop)
1888             // so the best is to keep the ones already in the gradebook
1889             // Potential problem: duplicates if same items are restored more than once. :-(
1890             // This needs to be fixed in some way (outcomes & activities with multiple items)
1891             // $data->idnumber     = get_coursemodule_from_instance($data->itemmodule, $data->iteminstance)->idnumber;
1892             // In any case, verify always for uniqueness
1893             $sql = "SELECT cm.id
1894                       FROM {course_modules} cm
1895                      WHERE cm.course = :courseid AND
1896                            cm.idnumber = :idnumber AND
1897                            cm.id <> :cmid";
1898             $params = array(
1899                 'courseid' => $courseid,
1900                 'idnumber' => $data->idnumber,
1901                 'cmid' => $this->task->get_moduleid()
1902             );
1903             if (!$DB->record_exists_sql($sql, $params) && !$DB->record_exists('grade_items', array('courseid' => $courseid, 'idnumber' => $data->idnumber))) {
1904                 $idnumber = $data->idnumber;
1905             }
1906         }
1908         unset($data->id);
1909         $data->categoryid   = $coursecatid;
1910         $data->courseid     = $this->get_courseid();
1911         $data->iteminstance = $this->task->get_activityid();
1912         $data->idnumber     = $idnumber;
1913         $data->scaleid      = $this->get_mappingid('scale', $data->scaleid);
1914         $data->outcomeid    = $this->get_mappingid('outcome', $data->outcomeid);
1915         $data->timecreated  = $this->apply_date_offset($data->timecreated);
1916         $data->timemodified = $this->apply_date_offset($data->timemodified);
1918         $gradeitem = new grade_item($data, false);
1919         $gradeitem->insert('restore');
1921         //sortorder is automatically assigned when inserting. Re-instate the previous sortorder
1922         $gradeitem->sortorder = $data->sortorder;
1923         $gradeitem->update('restore');
1925         // Set mapping, saving the original category id into parentitemid
1926         // gradebook restore (final task) will need it to reorganise items
1927         $this->set_mapping('grade_item', $oldid, $gradeitem->id, false, null, $oldparentid);
1928     }
1930     protected function process_grade_grade($data) {
1931         $data = (object)($data);
1933         unset($data->id);
1934         $data->itemid = $this->get_new_parentid('grade_item');
1935         $data->userid = $this->get_mappingid('user', $data->userid);
1936         $data->usermodified = $this->get_mappingid('user', $data->usermodified);
1937         $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
1938         // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
1939         $data->overridden = $this->apply_date_offset($data->overridden);
1941         $grade = new grade_grade($data, false);
1942         $grade->insert('restore');
1943         // no need to save any grade_grade mapping
1944     }
1946     /**
1947      * process activity grade_letters. Note that, while these are possible,
1948      * because grade_letters are contextid based, in proctice, only course
1949      * context letters can be defined. So we keep here this method knowing
1950      * it won't be executed ever. gradebook restore will restore course letters.
1951      */
1952     protected function process_grade_letter($data) {
1953         global $DB;
1955         $data = (object)$data;
1957         $data->contextid = $this->task->get_contextid();
1958         $newitemid = $DB->insert_record('grade_letters', $data);
1959         // no need to save any grade_letter mapping
1960     }
1964 /**
1965  * This structure steps restores one instance + positions of one block
1966  * Note: Positions corresponding to one existing context are restored
1967  * here, but all the ones having unknown contexts are sent to backup_ids
1968  * for a later chance to be restored at the end (final task)
1969  */
1970 class restore_block_instance_structure_step extends restore_structure_step {
1972     protected function define_structure() {
1974         $paths = array();
1976         $paths[] = new restore_path_element('block', '/block', true); // Get the whole XML together
1977         $paths[] = new restore_path_element('block_position', '/block/block_positions/block_position');
1979         return $paths;
1980     }
1982     public function process_block($data) {
1983         global $DB, $CFG;
1985         $data = (object)$data; // Handy
1986         $oldcontextid = $data->contextid;
1987         $oldid        = $data->id;
1988         $positions = isset($data->block_positions['block_position']) ? $data->block_positions['block_position'] : array();
1990         // Look for the parent contextid
1991         if (!$data->parentcontextid = $this->get_mappingid('context', $data->parentcontextid)) {
1992             throw new restore_step_exception('restore_block_missing_parent_ctx', $data->parentcontextid);
1993         }
1995         // TODO: it would be nice to use standard plugin supports instead of this instance_allow_multiple()
1996         // If there is already one block of that type in the parent context
1997         // and the block is not multiple, stop processing
1998         // Use blockslib loader / method executor
1999         if (!block_method_result($data->blockname, 'instance_allow_multiple')) {
2000             if ($DB->record_exists_sql("SELECT bi.id
2001                                           FROM {block_instances} bi
2002                                           JOIN {block} b ON b.name = bi.blockname
2003                                          WHERE bi.parentcontextid = ?
2004                                            AND bi.blockname = ?", array($data->parentcontextid, $data->blockname))) {
2005                 return false;
2006             }
2007         }
2009         // If there is already one block of that type in the parent context
2010         // with the same showincontexts, pagetypepattern, subpagepattern, defaultregion and configdata
2011         // stop processing
2012         $params = array(
2013             'blockname' => $data->blockname, 'parentcontextid' => $data->parentcontextid,
2014             'showinsubcontexts' => $data->showinsubcontexts, 'pagetypepattern' => $data->pagetypepattern,
2015             'subpagepattern' => $data->subpagepattern, 'defaultregion' => $data->defaultregion);
2016         if ($birecs = $DB->get_records('block_instances', $params)) {
2017             foreach($birecs as $birec) {
2018                 if ($birec->configdata == $data->configdata) {
2019                     return false;
2020                 }
2021             }
2022         }
2024         // Set task old contextid, blockid and blockname once we know them
2025         $this->task->set_old_contextid($oldcontextid);
2026         $this->task->set_old_blockid($oldid);
2027         $this->task->set_blockname($data->blockname);
2029         // Let's look for anything within configdata neededing processing
2030         // (nulls and uses of legacy file.php)
2031         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
2032             $configdata = (array)unserialize(base64_decode($data->configdata));
2033             foreach ($configdata as $attribute => $value) {
2034                 if (in_array($attribute, $attrstotransform)) {
2035                     $configdata[$attribute] = $this->contentprocessor->process_cdata($value);
2036                 }
2037             }
2038             $data->configdata = base64_encode(serialize((object)$configdata));
2039         }
2041         // Create the block instance
2042         $newitemid = $DB->insert_record('block_instances', $data);
2043         // Save the mapping (with restorefiles support)
2044         $this->set_mapping('block_instance', $oldid, $newitemid, true);
2045         // Create the block context
2046         $newcontextid = get_context_instance(CONTEXT_BLOCK, $newitemid)->id;
2047         // Save the block contexts mapping and sent it to task
2048         $this->set_mapping('context', $oldcontextid, $newcontextid);
2049         $this->task->set_contextid($newcontextid);
2050         $this->task->set_blockid($newitemid);
2052         // Restore block fileareas if declared
2053         $component = 'block_' . $this->task->get_blockname();
2054         foreach ($this->task->get_fileareas() as $filearea) { // Simple match by contextid. No itemname needed
2055             $this->add_related_files($component, $filearea, null);
2056         }
2058         // Process block positions, creating them or accumulating for final step
2059         foreach($positions as $position) {
2060             $position = (object)$position;
2061             $position->blockinstanceid = $newitemid; // The instance is always the restored one
2062             // If position is for one already mapped (known) contextid
2063             // process it now, creating the position
2064             if ($newpositionctxid = $this->get_mappingid('context', $position->contextid)) {
2065                 $position->contextid = $newpositionctxid;
2066                 // Create the block position
2067                 $DB->insert_record('block_positions', $position);
2069             // The position belongs to an unknown context, send it to backup_ids
2070             // to process them as part of the final steps of restore. We send the
2071             // whole $position object there, hence use the low level method.
2072             } else {
2073                 restore_dbops::set_backup_ids_record($this->get_restoreid(), 'block_position', $position->id, 0, null, $position);
2074             }
2075         }
2076     }
2079 /**
2080  * Structure step to restore common course_module information
2081  *
2082  * This step will process the module.xml file for one activity, in order to restore
2083  * the corresponding information to the course_modules table, skipping various bits
2084  * of information based on CFG settings (groupings, completion...) in order to fullfill
2085  * all the reqs to be able to create the context to be used by all the rest of steps
2086  * in the activity restore task
2087  */
2088 class restore_module_structure_step extends restore_structure_step {
2090     protected function define_structure() {
2091         global $CFG;
2093         $paths = array();
2095         $module = new restore_path_element('module', '/module');
2096         $paths[] = $module;
2097         if ($CFG->enableavailability) {
2098             $paths[] = new restore_path_element('availability', '/module/availability_info/availability');
2099         }
2101         // Apply for 'format' plugins optional paths at module level
2102         $this->add_plugin_structure('format', $module);
2104         // Apply for 'plagiarism' plugins optional paths at module level
2105         $this->add_plugin_structure('plagiarism', $module);
2107         return $paths;
2108     }
2110     protected function process_module($data) {
2111         global $CFG, $DB;
2113         $data = (object)$data;
2114         $oldid = $data->id;
2116         $this->task->set_old_moduleversion($data->version);
2118         $data->course = $this->task->get_courseid();
2119         $data->module = $DB->get_field('modules', 'id', array('name' => $data->modulename));
2120         // Map section (first try by course_section mapping match. Useful in course and section restores)
2121         $data->section = $this->get_mappingid('course_section', $data->sectionid);
2122         if (!$data->section) { // mapping failed, try to get section by sectionnumber matching
2123             $params = array(
2124                 'course' => $this->get_courseid(),
2125                 'section' => $data->sectionnumber);
2126             $data->section = $DB->get_field('course_sections', 'id', $params);
2127         }
2128         if (!$data->section) { // sectionnumber failed, try to get first section in course
2129             $params = array(
2130                 'course' => $this->get_courseid());
2131             $data->section = $DB->get_field('course_sections', 'MIN(id)', $params);
2132         }
2133         if (!$data->section) { // no sections in course, create section 0 and 1 and assign module to 1
2134             $sectionrec = array(
2135                 'course' => $this->get_courseid(),
2136                 'section' => 0);
2137             $DB->insert_record('course_sections', $sectionrec); // section 0
2138             $sectionrec = array(
2139                 'course' => $this->get_courseid(),
2140                 'section' => 1);
2141             $data->section = $DB->insert_record('course_sections', $sectionrec); // section 1
2142         }
2143         $data->groupingid= $this->get_mappingid('grouping', $data->groupingid);      // grouping
2144         if (!$CFG->enablegroupmembersonly) {                                         // observe groupsmemberonly
2145             $data->groupmembersonly = 0;
2146         }
2147         if (!grade_verify_idnumber($data->idnumber, $this->get_courseid())) {        // idnumber uniqueness
2148             $data->idnumber = '';
2149         }
2150         if (empty($CFG->enablecompletion)) { // completion
2151             $data->completion = 0;
2152             $data->completiongradeitemnumber = null;
2153             $data->completionview = 0;
2154             $data->completionexpected = 0;
2155         } else {
2156             $data->completionexpected = $this->apply_date_offset($data->completionexpected);
2157         }
2158         if (empty($CFG->enableavailability)) {
2159             $data->availablefrom = 0;
2160             $data->availableuntil = 0;
2161             $data->showavailability = 0;
2162         } else {
2163             $data->availablefrom = $this->apply_date_offset($data->availablefrom);
2164             $data->availableuntil= $this->apply_date_offset($data->availableuntil);
2165         }
2166         $data->instance = 0; // Set to 0 for now, going to create it soon (next step)
2168         // course_module record ready, insert it
2169         $newitemid = $DB->insert_record('course_modules', $data);
2170         // save mapping
2171         $this->set_mapping('course_module', $oldid, $newitemid);
2172         // set the new course_module id in the task
2173         $this->task->set_moduleid($newitemid);
2174         // we can now create the context safely
2175         $ctxid = get_context_instance(CONTEXT_MODULE, $newitemid)->id;
2176         // set the new context id in the task
2177         $this->task->set_contextid($ctxid);
2178         // update sequence field in course_section
2179         if ($sequence = $DB->get_field('course_sections', 'sequence', array('id' => $data->section))) {
2180             $sequence .= ',' . $newitemid;
2181         } else {
2182             $sequence = $newitemid;
2183         }
2184         $DB->set_field('course_sections', 'sequence', $sequence, array('id' => $data->section));
2185     }
2188     protected function process_availability($data) {
2189         $data = (object)$data;
2190         // Simply going to store the whole availability record now, we'll process
2191         // all them later in the final task (once all actvivities have been restored)
2192         // Let's call the low level one to be able to store the whole object
2193         $data->coursemoduleid = $this->task->get_moduleid(); // Let add the availability cmid
2194         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'module_availability', $data->id, 0, null, $data);
2195     }
2198 /**
2199  * Structure step that will process the user activity completion
2200  * information if all these conditions are met:
2201  *  - Target site has completion enabled ($CFG->enablecompletion)
2202  *  - Activity includes completion info (file_exists)
2203  */
2204 class restore_userscompletion_structure_step extends restore_structure_step {
2205     private $done = array();
2207     /**
2208      * To conditionally decide if this step must be executed
2209      * Note the "settings" conditions are evaluated in the
2210      * corresponding task. Here we check for other conditions
2211      * not being restore settings (files, site settings...)
2212      */
2213      protected function execute_condition() {
2214          global $CFG;
2216          // Completion disabled in this site, don't execute
2217          if (empty($CFG->enablecompletion)) {
2218              return false;
2219          }
2221          // No user completion info found, don't execute
2222         $fullpath = $this->task->get_taskbasepath();
2223         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2224          if (!file_exists($fullpath)) {
2225              return false;
2226          }
2228          // Arrived here, execute the step
2229          return true;
2230      }
2232      protected function define_structure() {
2234         $paths = array();
2236         $paths[] = new restore_path_element('completion', '/completions/completion');
2238         return $paths;
2239     }
2241     protected function process_completion($data) {
2242         global $DB;
2244         $data = (object)$data;
2246         $data->coursemoduleid = $this->task->get_moduleid();
2247         $data->userid = $this->get_mappingid('user', $data->userid);
2248         $data->timemodified = $this->apply_date_offset($data->timemodified);
2250         // Check we didn't already insert one for this cmid and userid
2251         // (there aren't supposed to be duplicates in that field, but
2252         // it was possible until MDL-28021 was fixed).
2253         $key = $data->coursemoduleid . ',' . $data->userid;
2254         if (array_key_exists($key, $this->done)) {
2255             // Find the existing record
2256             $existing = $DB->get_record('course_modules_completion', array(
2257                     'coursemoduleid' => $data->coursemoduleid,
2258                     'userid' => $data->userid), 'id, timemodified');
2259             // Update it to these new values, but only if the time is newer
2260             if ($existing->timemodified < $data->timemodified) {
2261                 $data->id = $existing->id;
2262                 $DB->update_record('course_modules_completion', $data);
2263             }
2264         } else {
2265             // Normal entry where it doesn't exist already
2266             $DB->insert_record('course_modules_completion', $data);
2267             // Remember this entry
2268             $this->done[$key] = true;
2269         }
2270     }
2272     protected function after_execute() {
2273         // This gets called once per activity (according to my testing).
2274         // Clearing the array isn't strictly required, but avoids using
2275         // unnecessary memory.
2276         $this->done = array();
2277     }
2280 /**
2281  * Abstract structure step, parent of all the activity structure steps. Used to suuport
2282  * the main <activity ...> tag and process it. Also provides subplugin support for
2283  * activities.
2284  */
2285 abstract class restore_activity_structure_step extends restore_structure_step {
2287     protected function add_subplugin_structure($subplugintype, $element) {
2289         global $CFG;
2291         // Check the requested subplugintype is a valid one
2292         $subpluginsfile = $CFG->dirroot . '/mod/' . $this->task->get_modulename() . '/db/subplugins.php';
2293         if (!file_exists($subpluginsfile)) {
2294              throw new restore_step_exception('activity_missing_subplugins_php_file', $this->task->get_modulename());
2295         }
2296         include($subpluginsfile);
2297         if (!array_key_exists($subplugintype, $subplugins)) {
2298              throw new restore_step_exception('incorrect_subplugin_type', $subplugintype);
2299         }
2300         // Get all the restore path elements, looking across all the subplugin dirs
2301         $subpluginsdirs = get_plugin_list($subplugintype);
2302         foreach ($subpluginsdirs as $name => $subpluginsdir) {
2303             $classname = 'restore_' . $subplugintype . '_' . $name . '_subplugin';
2304             $restorefile = $subpluginsdir . '/backup/moodle2/' . $classname . '.class.php';
2305             if (file_exists($restorefile)) {
2306                 require_once($restorefile);
2307                 $restoresubplugin = new $classname($subplugintype, $name, $this);
2308                 // Add subplugin paths to the step
2309                 $this->prepare_pathelements($restoresubplugin->define_subplugin_structure($element));
2310             }
2311         }
2312     }
2314     /**
2315      * As far as activity restore steps are implementing restore_subplugin stuff, they need to
2316      * have the parent task available for wrapping purposes (get course/context....)
2317      * @return restore_task
2318      */
2319     public function get_task() {
2320         return $this->task;
2321     }
2323     /**
2324      * Adds support for the 'activity' path that is common to all the activities
2325      * and will be processed globally here
2326      */
2327     protected function prepare_activity_structure($paths) {
2329         $paths[] = new restore_path_element('activity', '/activity');
2331         return $paths;
2332     }
2334     /**
2335      * Process the activity path, informing the task about various ids, needed later
2336      */
2337     protected function process_activity($data) {
2338         $data = (object)$data;
2339         $this->task->set_old_contextid($data->contextid); // Save old contextid in task
2340         $this->set_mapping('context', $data->contextid, $this->task->get_contextid()); // Set the mapping
2341         $this->task->set_old_activityid($data->id); // Save old activityid in task
2342     }
2344     /**
2345      * This must be invoked immediately after creating the "module" activity record (forum, choice...)
2346      * and will adjust the new activity id (the instance) in various places
2347      */
2348     protected function apply_activity_instance($newitemid) {
2349         global $DB;
2351         $this->task->set_activityid($newitemid); // Save activity id in task
2352         // Apply the id to course_sections->instanceid
2353         $DB->set_field('course_modules', 'instance', $newitemid, array('id' => $this->task->get_moduleid()));
2354         // Do the mapping for modulename, preparing it for files by oldcontext
2355         $modulename = $this->task->get_modulename();
2356         $oldid = $this->task->get_old_activityid();
2357         $this->set_mapping($modulename, $oldid, $newitemid, true);
2358     }
2361 /**
2362  * Structure step in charge of creating/mapping all the qcats and qs
2363  * by parsing the questions.xml file and checking it against the
2364  * results calculated by {@link restore_process_categories_and_questions}
2365  * and stored in backup_ids_temp
2366  */
2367 class restore_create_categories_and_questions extends restore_structure_step {
2369     protected function define_structure() {
2371         $category = new restore_path_element('question_category', '/question_categories/question_category');
2372         $question = new restore_path_element('question', '/question_categories/question_category/questions/question');
2374         // Apply for 'qtype' plugins optional paths at question level
2375         $this->add_plugin_structure('qtype', $question);
2377         return array($category, $question);
2378     }
2380     protected function process_question_category($data) {
2381         global $DB;
2383         $data = (object)$data;
2384         $oldid = $data->id;
2386         // Check we have one mapping for this category
2387         if (!$mapping = $this->get_mapping('question_category', $oldid)) {
2388             return self::SKIP_ALL_CHILDREN; // No mapping = this category doesn't need to be created/mapped
2389         }
2391         // Check we have to create the category (newitemid = 0)
2392         if ($mapping->newitemid) {
2393             return; // newitemid != 0, this category is going to be mapped. Nothing to do
2394         }
2396         // Arrived here, newitemid = 0, we need to create the category
2397         // we'll do it at parentitemid context, but for CONTEXT_MODULE
2398         // categories, that will be created at CONTEXT_COURSE and moved
2399         // to module context later when the activity is created
2400         if ($mapping->info->contextlevel == CONTEXT_MODULE) {
2401             $mapping->parentitemid = $this->get_mappingid('context', $this->task->get_old_contextid());
2402         }
2403         $data->contextid = $mapping->parentitemid;
2405         // Let's create the question_category and save mapping
2406         $newitemid = $DB->insert_record('question_categories', $data);
2407         $this->set_mapping('question_category', $oldid, $newitemid);
2408         // Also annotate them as question_category_created, we need
2409         // that later when remapping parents
2410         $this->set_mapping('question_category_created', $oldid, $newitemid, false, null, $data->contextid);
2411     }
2413     protected function process_question($data) {
2414         global $DB;
2416         $data = (object)$data;
2417         $oldid = $data->id;
2419         // Check we have one mapping for this question
2420         if (!$questionmapping = $this->get_mapping('question', $oldid)) {
2421             return; // No mapping = this question doesn't need to be created/mapped
2422         }
2424         // Get the mapped category (cannot use get_new_parentid() because not
2425         // all the categories have been created, so it is not always available
2426         // Instead we get the mapping for the question->parentitemid because
2427         // we have loaded qcatids there for all parsed questions
2428         $data->category = $this->get_mappingid('question_category', $questionmapping->parentitemid);
2430         // In the past, there were some very sloppy values of penalty. Fix them.
2431         if ($data->penalty >= 0.33 && $data->penalty <= 0.34) {
2432             $data->penalty = 0.3333333;
2433         }
2434         if ($data->penalty >= 0.66 && $data->penalty <= 0.67) {
2435             $data->penalty = 0.6666667;
2436         }
2437         if ($data->penalty >= 1) {
2438             $data->penalty = 1;
2439         }
2441         $data->timecreated  = $this->apply_date_offset($data->timecreated);
2442         $data->timemodified = $this->apply_date_offset($data->timemodified);
2444         $userid = $this->get_mappingid('user', $data->createdby);
2445         $data->createdby = $userid ? $userid : $this->task->get_userid();
2447         $userid = $this->get_mappingid('user', $data->modifiedby);
2448         $data->modifiedby = $userid ? $userid : $this->task->get_userid();
2450         // With newitemid = 0, let's create the question
2451         if (!$questionmapping->newitemid) {
2452             $newitemid = $DB->insert_record('question', $data);
2453             $this->set_mapping('question', $oldid, $newitemid);
2454             // Also annotate them as question_created, we need
2455             // that later when remapping parents (keeping the old categoryid as parentid)
2456             $this->set_mapping('question_created', $oldid, $newitemid, false, null, $questionmapping->parentitemid);
2457         } else {
2458             // By performing this set_mapping() we make get_old/new_parentid() to work for all the
2459             // children elements of the 'question' one (so qtype plugins will know the question they belong to)
2460             $this->set_mapping('question', $oldid, $questionmapping->newitemid);
2461         }
2463         // Note, we don't restore any question files yet
2464         // as far as the CONTEXT_MODULE categories still
2465         // haven't their contexts to be restored to
2466         // The {@link restore_create_question_files}, executed in the final step
2467         // step will be in charge of restoring all the question files
2468     }
2470         protected function process_question_hint($data) {
2471         global $DB;
2473         $data = (object)$data;
2474         $oldid = $data->id;
2476         // Detect if the question is created or mapped
2477         $oldquestionid   = $this->get_old_parentid('question');
2478         $newquestionid   = $this->get_new_parentid('question');
2479         $questioncreated = $this->get_mappingid('question_created', $oldquestionid) ? true : false;
2481         // If the question has been created by restore, we need to create its question_answers too
2482         if ($questioncreated) {
2483             // Adjust some columns
2484             $data->questionid = $newquestionid;
2485             // Insert record
2486             $newitemid = $DB->insert_record('question_answers', $data);
2488         // The question existed, we need to map the existing question_answers
2489         } else {
2490             // Look in question_answers by answertext matching
2491             $sql = 'SELECT id
2492                       FROM {question_hints}
2493                      WHERE questionid = ?
2494                        AND ' . $DB->sql_compare_text('hint', 255) . ' = ' . $DB->sql_compare_text('?', 255);
2495             $params = array($newquestionid, $data->hint);
2496             $newitemid = $DB->get_field_sql($sql, $params);
2497             // If we haven't found the newitemid, something has gone really wrong, question in DB
2498             // is missing answers, exception
2499             if (!$newitemid) {
2500                 $info = new stdClass();
2501                 $info->filequestionid = $oldquestionid;
2502                 $info->dbquestionid   = $newquestionid;
2503                 $info->hint           = $data->hint;
2504                 throw new restore_step_exception('error_question_hint_missing_in_db', $info);
2505             }
2506         }
2507         // Create mapping (we'll use this intensively when restoring question_states. And also answerfeedback files)
2508         $this->set_mapping('question_hint', $oldid, $newitemid);
2509     }
2511     protected function after_execute() {
2512         global $DB;
2514         // First of all, recode all the created question_categories->parent fields
2515         $qcats = $DB->get_records('backup_ids_temp', array(
2516                      'backupid' => $this->get_restoreid(),
2517                      'itemname' => 'question_category_created'));
2518         foreach ($qcats as $qcat) {
2519             $newparent = 0;
2520             $dbcat = $DB->get_record('question_categories', array('id' => $qcat->newitemid));
2521             // Get new parent (mapped or created, so we look in quesiton_category mappings)
2522             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
2523                                  'backupid' => $this->get_restoreid(),
2524                                  'itemname' => 'question_category',
2525                                  'itemid'   => $dbcat->parent))) {
2526                 // contextids must match always, as far as we always include complete qbanks, just check it
2527                 $newparentctxid = $DB->get_field('question_categories', 'contextid', array('id' => $newparent));
2528                 if ($dbcat->contextid == $newparentctxid) {
2529                     $DB->set_field('question_categories', 'parent', $newparent, array('id' => $dbcat->id));
2530                 } else {
2531                     $newparent = 0; // No ctx match for both cats, no parent relationship
2532                 }
2533             }
2534             // Here with $newparent empty, problem with contexts or remapping, set it to top cat
2535             if (!$newparent) {
2536                 $DB->set_field('question_categories', 'parent', 0, array('id' => $dbcat->id));
2537             }
2538         }
2540         // Now, recode all the created question->parent fields
2541         $qs = $DB->get_records('backup_ids_temp', array(
2542                   'backupid' => $this->get_restoreid(),
2543                   'itemname' => 'question_created'));
2544         foreach ($qs as $q) {
2545             $newparent = 0;
2546             $dbq = $DB->get_record('question', array('id' => $q->newitemid));
2547             // Get new parent (mapped or created, so we look in question mappings)
2548             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
2549                                  'backupid' => $this->get_restoreid(),
2550                                  'itemname' => 'question',
2551                                  'itemid'   => $dbq->parent))) {
2552                 $DB->set_field('question', 'parent', $newparent, array('id' => $dbq->id));
2553             }
2554         }
2556         // Note, we don't restore any question files yet
2557         // as far as the CONTEXT_MODULE categories still
2558         // haven't their contexts to be restored to
2559         // The {@link restore_create_question_files}, executed in the final step
2560         // step will be in charge of restoring all the question files
2561     }
2564 /**
2565  * Execution step that will move all the CONTEXT_MODULE question categories
2566  * created at early stages of restore in course context (because modules weren't
2567  * created yet) to their target module (matching by old-new-contextid mapping)
2568  */
2569 class restore_move_module_questions_categories extends restore_execution_step {
2571     protected function define_execution() {
2572         global $DB;
2574         $contexts = restore_dbops::restore_get_question_banks($this->get_restoreid(), CONTEXT_MODULE);
2575         foreach ($contexts as $contextid => $contextlevel) {
2576             // Only if context mapping exists (i.e. the module has been restored)
2577             if ($newcontext = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $contextid)) {
2578                 // Update all the qcats having their parentitemid set to the original contextid
2579                 $modulecats = $DB->get_records_sql("SELECT itemid, newitemid
2580                                                       FROM {backup_ids_temp}
2581                                                      WHERE backupid = ?
2582                                                        AND itemname = 'question_category'
2583                                                        AND parentitemid = ?", array($this->get_restoreid(), $contextid));
2584                 foreach ($modulecats as $modulecat) {
2585                     $DB->set_field('question_categories', 'contextid', $newcontext->newitemid, array('id' => $modulecat->newitemid));
2586                     // And set new contextid also in question_category mapping (will be
2587                     // used by {@link restore_create_question_files} later
2588                     restore_dbops::set_backup_ids_record($this->get_restoreid(), 'question_category', $modulecat->itemid, $modulecat->newitemid, $newcontext->newitemid);
2589                 }
2590             }
2591         }
2592     }
2595 /**
2596  * Execution step that will create all the question/answers/qtype-specific files for the restored
2597  * questions. It must be executed after {@link restore_move_module_questions_categories}
2598  * because only then each question is in its final category and only then the
2599  * context can be determined
2600  *
2601  * TODO: Improve this. Instead of looping over each question, it can be reduced to
2602  *       be done by contexts (this will save a huge ammount of queries)
2603  */
2604 class restore_create_question_files extends restore_execution_step {
2606     protected function define_execution() {
2607         global $DB;
2609         // Let's process only created questions
2610         $questionsrs = $DB->get_recordset_sql("SELECT bi.itemid, bi.newitemid, bi.parentitemid, q.qtype
2611                                                FROM {backup_ids_temp} bi
2612                                                JOIN {question} q ON q.id = bi.newitemid
2613                                               WHERE bi.backupid = ?
2614                                                 AND bi.itemname = 'question_created'", array($this->get_restoreid()));
2615         foreach ($questionsrs as $question) {
2616             // Get question_category mapping, it contains the target context for the question
2617             if (!$qcatmapping = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'question_category', $question->parentitemid)) {
2618                 // Something went really wrong, cannot find the question_category for the question
2619                 debugging('Error fetching target context for question', DEBUG_DEVELOPER);
2620                 continue;
2621             }
2622             // Calculate source and target contexts
2623             $oldctxid = $qcatmapping->info->contextid;
2624             $newctxid = $qcatmapping->parentitemid;
2626             // Add common question files (question and question_answer ones)
2627             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'questiontext',
2628                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
2629             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'generalfeedback',
2630                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
2631             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'answer',
2632                                               $oldctxid, $this->task->get_userid(), 'question_answer', null, $newctxid, true);
2633             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'answerfeedback',
2634                                               $oldctxid, $this->task->get_userid(), 'question_answer', null, $newctxid, true);
2635             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'hint',
2636                                               $oldctxid, $this->task->get_userid(), 'question_hint', null, $newctxid, true);
2637             // Add qtype dependent files
2638             $components = backup_qtype_plugin::get_components_and_fileareas($question->qtype);
2639             foreach ($components as $component => $fileareas) {
2640                 foreach ($fileareas as $filearea => $mapping) {
2641                     // Use itemid only if mapping is question_created
2642                     $itemid = ($mapping == 'question_created') ? $question->itemid : null;
2643                     restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), $component, $filearea,
2644                                                       $oldctxid, $this->task->get_userid(), $mapping, $itemid, $newctxid, true);
2645                 }
2646             }
2647         }
2648         $questionsrs->close();
2649     }
2652 /**
2653  * Abstract structure step, to be used by all the activities using core questions stuff
2654  * (like the quiz module), to support qtype plugins, states and sessions
2655  */
2656 abstract class restore_questions_activity_structure_step extends restore_activity_structure_step {
2657     /** @var array question_attempt->id to qtype. */
2658     protected $qtypes = array();
2659     /** @var array question_attempt->id to questionid. */
2660     protected $newquestionids = array();
2662     /**
2663      * Attach below $element (usually attempts) the needed restore_path_elements
2664      * to restore question_usages and all they contain.
2665      */
2666     protected function add_question_usages($element, &$paths) {
2667         // Check $element is restore_path_element
2668         if (! $element instanceof restore_path_element) {
2669             throw new restore_step_exception('element_must_be_restore_path_element', $element);
2670         }
2671         // Check $paths is one array
2672         if (!is_array($paths)) {
2673             throw new restore_step_exception('paths_must_be_array', $paths);
2674         }
2675         $paths[] = new restore_path_element('question_usage',
2676                 $element->get_path() . '/question_usage');
2677         $paths[] = new restore_path_element('question_attempt',
2678                 $element->get_path() . '/question_usage/question_attempts/question_attempt');
2679         $paths[] = new restore_path_element('question_attempt_step',
2680                 $element->get_path() . '/question_usage/question_attempts/question_attempt/steps/step',
2681                 true);
2682         $paths[] = new restore_path_element('question_attempt_step_data',
2683                 $element->get_path() . '/question_usage/question_attempts/question_attempt/steps/step/response/variable');
2684     }
2686     /**
2687      * Process question_usages
2688      */
2689     protected function process_question_usage($data) {
2690         global $DB;
2692         // Clear our caches.
2693         $this->qtypes = array();
2694         $this->newquestionids = array();
2696         $data = (object)$data;
2697         $oldid = $data->id;
2699         $oldcontextid = $this->get_task()->get_old_contextid();
2700         $data->contextid  = $this->get_mappingid('context', $this->task->get_old_contextid());
2702         // Everything ready, insert (no mapping needed)
2703         $newitemid = $DB->insert_record('question_usages', $data);
2705         $this->inform_new_usage_id($newitemid);
2707         $this->set_mapping('question_usage', $oldid, $newitemid, false);
2708     }
2710     /**
2711      * When process_question_usage creates the new usage, it calls this method
2712      * to let the activity link to the new usage. For example, the quiz uses
2713      * this method to set quiz_attempts.uniqueid to the new usage id.
2714      * @param integer $newusageid
2715      */
2716     abstract protected function inform_new_usage_id($newusageid);
2718     /**
2719      * Process question_attempts
2720      */
2721     protected function process_question_attempt($data) {
2722         global $DB;
2724         $data = (object)$data;
2725         $oldid = $data->id;
2726         $question = $this->get_mapping('question', $data->questionid);
2728         $data->questionusageid = $this->get_new_parentid('question_usage');
2729         $data->questionid      = $question->newitemid;
2730         $data->timemodified    = $this->apply_date_offset($data->timemodified);
2732         $newitemid = $DB->insert_record('question_attempts', $data);
2734         $this->set_mapping('question_attempt', $oldid, $newitemid);
2735         $this->qtypes[$newitemid] = $question->info->qtype;
2736         $this->newquestionids[$newitemid] = $data->questionid;
2737     }
2739     /**
2740      * Process question_attempt_steps
2741      */
2742     protected function process_question_attempt_step($data) {
2743         global $DB;
2745         $data = (object)$data;
2746         $oldid = $data->id;
2748         // Pull out the response data.
2749         $response = array();
2750         if (!empty($data->response['variable'])) {
2751             foreach ($data->response['variable'] as $variable) {
2752                 $response[$variable['name']] = $variable['value'];
2753             }
2754         }
2755         unset($data->response);
2757         $data->questionattemptid = $this->get_new_parentid('question_attempt');
2758         $data->timecreated = $this->apply_date_offset($data->timecreated);
2759         $data->userid      = $this->get_mappingid('user', $data->userid);
2761         // Everything ready, insert and create mapping (needed by question_sessions)
2762         $newitemid = $DB->insert_record('question_attempt_steps', $data);
2763         $this->set_mapping('question_attempt_step', $oldid, $newitemid, true);
2765         // Now process the response data.
2766         $response = $this->questions_recode_response_data(
2767                 $this->qtypes[$data->questionattemptid],
2768                 $this->newquestionids[$data->questionattemptid],
2769                 $data->sequencenumber, $response);
2770         foreach ($response as $name => $value) {
2771             $row = new stdClass();
2772             $row->attemptstepid = $newitemid;
2773             $row->name = $name;
2774             $row->value = $value;
2775             $DB->insert_record('question_attempt_step_data', $row, false);
2776         }
2777     }
2779     /**
2780      * Recode the respones data for a particular step of an attempt at at particular question.
2781      * @param string $qtype the question type.
2782      * @param int $newquestionid the question id.
2783      * @param int $sequencenumber the sequence number.
2784      * @param array $response the response data to recode.
2785      */
2786     public function questions_recode_response_data(
2787             $qtype, $newquestionid, $sequencenumber, array $response) {
2788         $qtyperestorer = $this->get_qtype_restorer($qtype);
2789         if ($qtyperestorer) {
2790             $response = $qtyperestorer->recode_response($newquestionid, $sequencenumber, $response);
2791         }
2792         return $response;
2793     }
2795     /**
2796      * Given a list of question->ids, separated by commas, returns the
2797      * recoded list, with all the restore question mappings applied.
2798      * Note: Used by quiz->questions and quiz_attempts->layout
2799      * Note: 0 = page break (unconverted)
2800      */
2801     protected function questions_recode_layout($layout) {
2802         // Extracts question id from sequence
2803         if ($questionids = explode(',', $layout)) {
2804             foreach ($questionids as $id => $questionid) {
2805                 if ($questionid) { // If it is zero then this is a pagebreak, don't translate
2806                     $newquestionid = $this->get_mappingid('question', $questionid);
2807                     $questionids[$id] = $newquestionid;
2808                 }
2809             }
2810         }
2811         return implode(',', $questionids);
2812     }
2814     /**
2815      * Get the restore_qtype_plugin subclass for a specific question type.
2816      * @param string $qtype e.g. multichoice.
2817      * @return restore_qtype_plugin instance.
2818      */
2819     protected function get_qtype_restorer($qtype) {
2820         // Build one static cache to store {@link restore_qtype_plugin}
2821         // while we are needing them, just to save zillions of instantiations
2822         // or using static stuff that will break our nice API
2823         static $qtypeplugins = array();
2825         if (!isset($qtypeplugins[$qtype])) {
2826             $classname = 'restore_qtype_' . $qtype . '_plugin';
2827             if (class_exists($classname)) {
2828                 $qtypeplugins[$qtype] = new $classname('qtype', $qtype, $this);
2829             } else {
2830                 $qtypeplugins[$qtype] = null;
2831             }
2832         }
2833         return $qtypeplugins[$qtype];
2834     }
2836     protected function after_execute() {
2837         parent::after_execute();
2839         // Restore any files belonging to responses.
2840         foreach (question_engine::get_all_response_file_areas() as $filearea) {
2841             $this->add_related_files('question', $filearea, 'question_attempt_step');
2842         }
2843     }
2845     /**
2846      * Attach below $element (usually attempts) the needed restore_path_elements
2847      * to restore question attempt data from Moodle 2.0.
2848      *
2849      * When using this method, the parent element ($element) must be defined with
2850      * $grouped = true. Then, in that elements process method, you must call
2851      * {@link process_legacy_attempt_data()} with the groupded data. See, for
2852      * example, the usage of this method in {@link restore_quiz_activity_structure_step}.
2853      * @param restore_path_element $element the parent element. (E.g. a quiz attempt.)
2854      * @param array $paths the paths array that is being built to describe the
2855      *      structure.
2856      */
2857     protected function add_legacy_question_attempt_data($element, &$paths) {
2858         global $CFG;
2859         require_once($CFG->dirroot . '/question/engine/upgrade/upgradelib.php');
2861         // Check $element is restore_path_element
2862         if (!($element instanceof restore_path_element)) {
2863             throw new restore_step_exception('element_must_be_restore_path_element', $element);
2864         }
2865         // Check $paths is one array
2866         if (!is_array($paths)) {
2867             throw new restore_step_exception('paths_must_be_array', $paths);
2868         }
2870         $paths[] = new restore_path_element('question_state',
2871                 $element->get_path() . '/states/state');
2872         $paths[] = new restore_path_element('question_session',
2873                 $element->get_path() . '/sessions/session');
2874     }
2876     protected function get_attempt_upgrader() {
2877         if (empty($this->attemptupgrader)) {
2878             $this->attemptupgrader = new question_engine_attempt_upgrader();
2879             $this->attemptupgrader->prepare_to_restore();
2880         }
2881         return $this->attemptupgrader;
2882     }
2884     /**
2885      * Process the attempt data defined by {@link add_legacy_question_attempt_data()}.
2886      * @param object $data contains all the grouped attempt data ot process.
2887      * @param pbject $quiz data about the activity the attempts belong to. Required
2888      * fields are (basically this only works for the quiz module):
2889      *      oldquestions => list of question ids in this activity - using old ids.
2890      *      preferredbehaviour => the behaviour to use for questionattempts.
2891      */
2892     protected function process_legacy_quiz_attempt_data($data, $quiz) {
2893         global $DB;
2894         $upgrader = $this->get_attempt_upgrader();
2896         $data = (object)$data;
2898         $layout = explode(',', $data->layout);
2899         $newlayout = $layout;
2901         // Convert each old question_session into a question_attempt.
2902         $qas = array();
2903         foreach (explode(',', $quiz->oldquestions) as $questionid) {
2904             if ($questionid == 0) {
2905                 continue;
2906             }
2908             $newquestionid = $this->get_mappingid('question', $questionid);
2909             if (!$newquestionid) {
2910                 throw new restore_step_exception('questionattemptreferstomissingquestion',
2911                         $questionid, $questionid);
2912             }
2914             $question = $upgrader->load_question($newquestionid, $quiz->id);
2916             foreach ($layout as $key => $qid) {
2917                 if ($qid == $questionid) {
2918                     $newlayout[$key] = $newquestionid;
2919                 }
2920             }
2922             list($qsession, $qstates) = $this->find_question_session_and_states(
2923                     $data, $questionid);
2925             if (empty($qsession) || empty($qstates)) {
2926                 throw new restore_step_exception('questionattemptdatamissing',
2927                         $questionid, $questionid);
2928             }
2930             list($qsession, $qstates) = $this->recode_legacy_response_data(
2931                     $question, $qsession, $qstates);
2933             $data->layout = implode(',', $newlayout);
2934             $qas[$newquestionid] = $upgrader->convert_question_attempt(
2935                     $quiz, $data, $question, $qsession, $qstates);
2936         }
2938         // Now create a new question_usage.
2939         $usage = new stdClass();
2940         $usage->component = 'mod_quiz';
2941         $usage->contextid = $this->get_mappingid('context', $this->task->get_old_contextid());
2942         $usage->preferredbehaviour = $quiz->preferredbehaviour;
2943         $usage->id = $DB->insert_record('question_usages', $usage);
2945         $this->inform_new_usage_id($usage->id);
2947         $data->uniqueid = $usage->id;
2948         $upgrader->save_usage($quiz->preferredbehaviour, $data, $qas, $quiz->questions);
2949     }
2951     protected function find_question_session_and_states($data, $questionid) {
2952         $qsession = null;
2953         foreach ($data->sessions['session'] as $session) {
2954             if ($session['questionid'] == $questionid) {
2955                 $qsession = (object) $session;
2956                 break;
2957             }
2958         }
2960         $qstates = array();
2961         foreach ($data->states['state'] as $state) {
2962             if ($state['question'] == $questionid) {
2963                 // It would be natural to use $state['seq_number'] as the array-key
2964                 // here, but it seems that buggy behaviour in 2.0 and early can
2965                 // mean that that is not unique, so we use id, which is guaranteed
2966                 // to be unique.
2967                 $qstates[$state['id']] = (object) $state;
2968             }
2969         }
2970         ksort($qstates);
2971         $qstates = array_values($qstates);
2973         return array($qsession, $qstates);
2974     }
2976     /**
2977      * Recode any ids in the response data
2978      * @param object $question the question data
2979      * @param object $qsession the question sessions.
2980      * @param array $qstates the question states.
2981      */
2982     protected function recode_legacy_response_data($question, $qsession, $qstates) {
2983         $qsession->questionid = $question->id;
2985         foreach ($qstates as &$state) {
2986             $state->question = $question->id;
2987             $state->answer = $this->restore_recode_legacy_answer($state, $question->qtype);
2988         }
2990         return array($qsession, $qstates);
2991     }
2993     /**
2994      * Recode the legacy answer field.
2995      * @param object $state the state to recode the answer of.
2996      * @param string $qtype the question type.
2997      */
2998     public function restore_recode_legacy_answer($state, $qtype) {
2999         $restorer = $this->get_qtype_restorer($qtype);
3000         if ($restorer) {
3001             return $restorer->recode_legacy_state_answer($state);
3002         } else {
3003             return $state->answer;
3004         }
3005     }