d87cdb94db9dafae42cd54a489f76b1bae760435
[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  * Defines various restore steps that will be used by common tasks in restore
20  *
21  * @package     core_backup
22  * @subpackage  moodle2
23  * @category    backup
24  * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
25  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 defined('MOODLE_INTERNAL') || die();
30 /**
31  * delete old directories and conditionally create backup_temp_ids table
32  */
33 class restore_create_and_clean_temp_stuff extends restore_execution_step {
35     protected function define_execution() {
36         $exists = restore_controller_dbops::create_restore_temp_tables($this->get_restoreid()); // temp tables conditionally
37         // If the table already exists, it's because restore_prechecks have been executed in the same
38         // request (without problems) and it already contains a bunch of preloaded information (users...)
39         // that we aren't going to execute again
40         if ($exists) { // Inform plan about preloaded information
41             $this->task->set_preloaded_information();
42         }
43         // Create the old-course-ctxid to new-course-ctxid mapping, we need that available since the beginning
44         $itemid = $this->task->get_old_contextid();
45         $newitemid = get_context_instance(CONTEXT_COURSE, $this->get_courseid())->id;
46         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'context', $itemid, $newitemid);
47         // Create the old-system-ctxid to new-system-ctxid mapping, we need that available since the beginning
48         $itemid = $this->task->get_old_system_contextid();
49         $newitemid = get_context_instance(CONTEXT_SYSTEM)->id;
50         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'context', $itemid, $newitemid);
51         // Create the old-course-id to new-course-id mapping, we need that available since the beginning
52         $itemid = $this->task->get_old_courseid();
53         $newitemid = $this->get_courseid();
54         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'course', $itemid, $newitemid);
56     }
57 }
59 /**
60  * delete the temp dir used by backup/restore (conditionally),
61  * delete old directories and drop temp ids table
62  */
63 class restore_drop_and_clean_temp_stuff extends restore_execution_step {
65     protected function define_execution() {
66         global $CFG;
67         restore_controller_dbops::drop_restore_temp_tables($this->get_restoreid()); // Drop ids temp table
68         backup_helper::delete_old_backup_dirs(time() - (4 * 60 * 60));              // Delete > 4 hours temp dirs
69         if (empty($CFG->keeptempdirectoriesonbackup)) { // Conditionally
70             backup_helper::delete_backup_dir($this->task->get_tempdir()); // Empty restore dir
71         }
72     }
73 }
75 /**
76  * Restore calculated grade items, grade categories etc
77  */
78 class restore_gradebook_structure_step extends restore_structure_step {
80     /**
81      * To conditionally decide if this step must be executed
82      * Note the "settings" conditions are evaluated in the
83      * corresponding task. Here we check for other conditions
84      * not being restore settings (files, site settings...)
85      */
86      protected function execute_condition() {
87         global $CFG, $DB;
89         // No gradebook info found, don't execute
90         $fullpath = $this->task->get_taskbasepath();
91         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
92         if (!file_exists($fullpath)) {
93             return false;
94         }
96         // Some module present in backup file isn't available to restore
97         // in this site, don't execute
98         if ($this->task->is_missing_modules()) {
99             return false;
100         }
102         // Some activity has been excluded to be restored, don't execute
103         if ($this->task->is_excluding_activities()) {
104             return false;
105         }
107         // There should only be one grade category (the 1 associated with the course itself)
108         // If other categories already exist we're restoring into an existing course.
109         // Restoring categories into a course with an existing category structure is unlikely to go well
110         $category = new stdclass();
111         $category->courseid  = $this->get_courseid();
112         $catcount = $DB->count_records('grade_categories', (array)$category);
113         if ($catcount>1) {
114             return false;
115         }
117         // Arrived here, execute the step
118         return true;
119      }
121     protected function define_structure() {
122         $paths = array();
123         $userinfo = $this->task->get_setting_value('users');
125         $paths[] = new restore_path_element('gradebook', '/gradebook');
126         $paths[] = new restore_path_element('grade_category', '/gradebook/grade_categories/grade_category');
127         $paths[] = new restore_path_element('grade_item', '/gradebook/grade_items/grade_item');
128         if ($userinfo) {
129             $paths[] = new restore_path_element('grade_grade', '/gradebook/grade_items/grade_item/grade_grades/grade_grade');
130         }
131         $paths[] = new restore_path_element('grade_letter', '/gradebook/grade_letters/grade_letter');
132         $paths[] = new restore_path_element('grade_setting', '/gradebook/grade_settings/grade_setting');
134         return $paths;
135     }
137     protected function process_gradebook($data) {
138     }
140     protected function process_grade_item($data) {
141         global $DB;
143         $data = (object)$data;
145         $oldid = $data->id;
146         $data->course = $this->get_courseid();
148         $data->courseid = $this->get_courseid();
150         if ($data->itemtype=='manual') {
151             // manual grade items store category id in categoryid
152             $data->categoryid = $this->get_mappingid('grade_category', $data->categoryid, NULL);
153         } else if ($data->itemtype=='course') {
154             // course grade item stores their category id in iteminstance
155             $coursecat = grade_category::fetch_course_category($this->get_courseid());
156             $data->iteminstance = $coursecat->id;
157         } else if ($data->itemtype=='category') {
158             // category grade items store their category id in iteminstance
159             $data->iteminstance = $this->get_mappingid('grade_category', $data->iteminstance, NULL);
160         } else {
161             throw new restore_step_exception('unexpected_grade_item_type', $data->itemtype);
162         }
164         $data->scaleid   = $this->get_mappingid('scale', $data->scaleid, NULL);
165         $data->outcomeid = $this->get_mappingid('outcome', $data->outcomeid, NULL);
167         $data->locktime     = $this->apply_date_offset($data->locktime);
168         $data->timecreated  = $this->apply_date_offset($data->timecreated);
169         $data->timemodified = $this->apply_date_offset($data->timemodified);
171         $coursecategory = $newitemid = null;
172         //course grade item should already exist so updating instead of inserting
173         if($data->itemtype=='course') {
174             //get the ID of the already created grade item
175             $gi = new stdclass();
176             $gi->courseid  = $this->get_courseid();
177             $gi->itemtype  = $data->itemtype;
179             //need to get the id of the grade_category that was automatically created for the course
180             $category = new stdclass();
181             $category->courseid  = $this->get_courseid();
182             $category->parent  = null;
183             //course category fullname starts out as ? but may be edited
184             //$category->fullname  = '?';
185             $coursecategory = $DB->get_record('grade_categories', (array)$category);
186             $gi->iteminstance = $coursecategory->id;
188             $existinggradeitem = $DB->get_record('grade_items', (array)$gi);
189             if (!empty($existinggradeitem)) {
190                 $data->id = $newitemid = $existinggradeitem->id;
191                 $DB->update_record('grade_items', $data);
192             }
193         }
195         if (empty($newitemid)) {
196             //in case we found the course category but still need to insert the course grade item
197             if ($data->itemtype=='course' && !empty($coursecategory)) {
198                 $data->iteminstance = $coursecategory->id;
199             }
201             $newitemid = $DB->insert_record('grade_items', $data);
202         }
203         $this->set_mapping('grade_item', $oldid, $newitemid);
204     }
206     protected function process_grade_grade($data) {
207         global $DB;
209         $data = (object)$data;
210         $oldid = $data->id;
212         $data->itemid = $this->get_new_parentid('grade_item');
214         $data->userid = $this->get_mappingid('user', $data->userid, NULL);
215         $data->usermodified = $this->get_mappingid('user', $data->usermodified, NULL);
216         $data->locktime     = $this->apply_date_offset($data->locktime);
217         // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
218         $data->overridden = $this->apply_date_offset($data->overridden);
219         $data->timecreated  = $this->apply_date_offset($data->timecreated);
220         $data->timemodified = $this->apply_date_offset($data->timemodified);
222         $newitemid = $DB->insert_record('grade_grades', $data);
223         //$this->set_mapping('grade_grade', $oldid, $newitemid);
224     }
225     protected function process_grade_category($data) {
226         global $DB;
228         $data = (object)$data;
229         $oldid = $data->id;
231         $data->course = $this->get_courseid();
232         $data->courseid = $data->course;
234         $data->timecreated  = $this->apply_date_offset($data->timecreated);
235         $data->timemodified = $this->apply_date_offset($data->timemodified);
237         $newitemid = null;
238         //no parent means a course level grade category. That may have been created when the course was created
239         if(empty($data->parent)) {
240             //parent was being saved as 0 when it should be null
241             $data->parent = null;
243             //get the already created course level grade category
244             $category = new stdclass();
245             $category->courseid = $this->get_courseid();
246             $category->parent = null;
248             $coursecategory = $DB->get_record('grade_categories', (array)$category);
249             if (!empty($coursecategory)) {
250                 $data->id = $newitemid = $coursecategory->id;
251                 $DB->update_record('grade_categories', $data);
252             }
253         }
255         //need to insert a course category
256         if (empty($newitemid)) {
257             $newitemid = $DB->insert_record('grade_categories', $data);
258         }
259         $this->set_mapping('grade_category', $oldid, $newitemid);
260     }
261     protected function process_grade_letter($data) {
262         global $DB;
264         $data = (object)$data;
265         $oldid = $data->id;
267         $data->contextid = get_context_instance(CONTEXT_COURSE, $this->get_courseid())->id;
269         $newitemid = $DB->insert_record('grade_letters', $data);
270         $this->set_mapping('grade_letter', $oldid, $newitemid);
271     }
272     protected function process_grade_setting($data) {
273         global $DB;
275         $data = (object)$data;
276         $oldid = $data->id;
278         $data->courseid = $this->get_courseid();
280         $newitemid = $DB->insert_record('grade_settings', $data);
281         //$this->set_mapping('grade_setting', $oldid, $newitemid);
282     }
284     /**
285      * put all activity grade items in the correct grade category and mark all for recalculation
286      */
287     protected function after_execute() {
288         global $DB;
290         $conditions = array(
291             'backupid' => $this->get_restoreid(),
292             'itemname' => 'grade_item'//,
293             //'itemid'   => $itemid
294         );
295         $rs = $DB->get_recordset('backup_ids_temp', $conditions);
297         // We need this for calculation magic later on.
298         $mappings = array();
300         if (!empty($rs)) {
301             foreach($rs as $grade_item_backup) {
303                 // Store the oldid with the new id.
304                 $mappings[$grade_item_backup->itemid] = $grade_item_backup->newitemid;
306                 $updateobj = new stdclass();
307                 $updateobj->id = $grade_item_backup->newitemid;
309                 //if this is an activity grade item that needs to be put back in its correct category
310                 if (!empty($grade_item_backup->parentitemid)) {
311                     $oldcategoryid = $this->get_mappingid('grade_category', $grade_item_backup->parentitemid, null);
312                     if (!is_null($oldcategoryid)) {
313                         $updateobj->categoryid = $oldcategoryid;
314                         $DB->update_record('grade_items', $updateobj);
315                     }
316                 } else {
317                     //mark course and category items as needing to be recalculated
318                     $updateobj->needsupdate=1;
319                     $DB->update_record('grade_items', $updateobj);
320                 }
321             }
322         }
323         $rs->close();
325         // We need to update the calculations for calculated grade items that may reference old
326         // grade item ids using ##gi\d+##.
327         // $mappings can be empty, use 0 if so (won't match ever)
328         list($sql, $params) = $DB->get_in_or_equal(array_values($mappings), SQL_PARAMS_NAMED, 'param', true, 0);
329         $sql = "SELECT gi.id, gi.calculation
330                   FROM {grade_items} gi
331                  WHERE gi.id {$sql} AND
332                        calculation IS NOT NULL";
333         $rs = $DB->get_recordset_sql($sql, $params);
334         foreach ($rs as $gradeitem) {
335             // Collect all of the used grade item id references
336             if (preg_match_all('/##gi(\d+)##/', $gradeitem->calculation, $matches) < 1) {
337                 // This calculation doesn't reference any other grade items... EASY!
338                 continue;
339             }
340             // For this next bit we are going to do the replacement of id's in two steps:
341             // 1. We will replace all old id references with a special mapping reference.
342             // 2. We will replace all mapping references with id's
343             // Why do we do this?
344             // Because there potentially there will be an overlap of ids within the query and we
345             // we substitute the wrong id.. safest way around this is the two step system
346             $calculationmap = array();
347             $mapcount = 0;
348             foreach ($matches[1] as $match) {
349                 // Check that the old id is known to us, if not it was broken to begin with and will
350                 // continue to be broken.
351                 if (!array_key_exists($match, $mappings)) {
352                     continue;
353                 }
354                 // Our special mapping key
355                 $mapping = '##MAPPING'.$mapcount.'##';
356                 // The old id that exists within the calculation now
357                 $oldid = '##gi'.$match.'##';
358                 // The new id that we want to replace the old one with.
359                 $newid = '##gi'.$mappings[$match].'##';
360                 // Replace in the special mapping key
361                 $gradeitem->calculation = str_replace($oldid, $mapping, $gradeitem->calculation);
362                 // And record the mapping
363                 $calculationmap[$mapping] = $newid;
364                 $mapcount++;
365             }
366             // Iterate all special mappings for this calculation and replace in the new id's
367             foreach ($calculationmap as $mapping => $newid) {
368                 $gradeitem->calculation = str_replace($mapping, $newid, $gradeitem->calculation);
369             }
370             // Update the calculation now that its being remapped
371             $DB->update_record('grade_items', $gradeitem);
372         }
373         $rs->close();
375         // Need to correct the grade category path and parent
376         $conditions = array(
377             'courseid' => $this->get_courseid()
378         );
380         $rs = $DB->get_recordset('grade_categories', $conditions);
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 = new stdClass();
385                 $grade_category->id = $gc->id;
386                 $grade_category->parent = $this->get_mappingid('grade_category', $gc->parent);
387                 $DB->update_record('grade_categories', $grade_category);
388             }
389         }
390         $rs->close();
392         // Now we can rebuild all the paths
393         $rs = $DB->get_recordset('grade_categories', $conditions);
394         foreach ($rs as $gc) {
395             $grade_category = new stdClass();
396             $grade_category->id = $gc->id;
397             $grade_category->path = grade_category::build_path($gc);
398             $grade_category->depth = substr_count($grade_category->path, '/') - 1;
399             $DB->update_record('grade_categories', $grade_category);
400         }
401         $rs->close();
403         // Restore marks items as needing update. Update everything now.
404         grade_regrade_final_grades($this->get_courseid());
405     }
408 /**
409  * decode all the interlinks present in restored content
410  * relying 100% in the restore_decode_processor that handles
411  * both the contents to modify and the rules to be applied
412  */
413 class restore_decode_interlinks extends restore_execution_step {
415     protected function define_execution() {
416         // Get the decoder (from the plan)
417         $decoder = $this->task->get_decoder();
418         restore_decode_processor::register_link_decoders($decoder); // Add decoder contents and rules
419         // And launch it, everything will be processed
420         $decoder->execute();
421     }
424 /**
425  * first, ensure that we have no gaps in section numbers
426  * and then, rebuid the course cache
427  */
428 class restore_rebuild_course_cache extends restore_execution_step {
430     protected function define_execution() {
431         global $DB;
433         // Although there is some sort of auto-recovery of missing sections
434         // present in course/formats... here we check that all the sections
435         // from 0 to MAX(section->section) exist, creating them if necessary
436         $maxsection = $DB->get_field('course_sections', 'MAX(section)', array('course' => $this->get_courseid()));
437         // Iterate over all sections
438         for ($i = 0; $i <= $maxsection; $i++) {
439             // If the section $i doesn't exist, create it
440             if (!$DB->record_exists('course_sections', array('course' => $this->get_courseid(), 'section' => $i))) {
441                 $sectionrec = array(
442                     'course' => $this->get_courseid(),
443                     'section' => $i);
444                 $DB->insert_record('course_sections', $sectionrec); // missing section created
445             }
446         }
448         // Rebuild cache now that all sections are in place
449         rebuild_course_cache($this->get_courseid());
450     }
453 /**
454  * Review all the tasks having one after_restore method
455  * executing it to perform some final adjustments of information
456  * not available when the task was executed.
457  */
458 class restore_execute_after_restore extends restore_execution_step {
460     protected function define_execution() {
462         // Simply call to the execute_after_restore() method of the task
463         // that always is the restore_final_task
464         $this->task->launch_execute_after_restore();
465     }
469 /**
470  * Review all the (pending) block positions in backup_ids, matching by
471  * contextid, creating positions as needed. This is executed by the
472  * final task, once all the contexts have been created
473  */
474 class restore_review_pending_block_positions extends restore_execution_step {
476     protected function define_execution() {
477         global $DB;
479         // Get all the block_position objects pending to match
480         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
481         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid');
482         // Process block positions, creating them or accumulating for final step
483         foreach($rs as $posrec) {
484             // Get the complete position object (stored as info)
485             $position = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'block_position', $posrec->itemid)->info;
486             // If position is for one already mapped (known) contextid
487             // process it now, creating the position, else nothing to
488             // do, position finally discarded
489             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
490                 $position->contextid = $newctx->newitemid;
491                 // Create the block position
492                 $DB->insert_record('block_positions', $position);
493             }
494         }
495         $rs->close();
496     }
499 /**
500  * Process all the saved module availability records in backup_ids, matching
501  * course modules and grade item id once all them have been already restored.
502  * only if all matchings are satisfied the availability condition will be created.
503  * At the same time, it is required for the site to have that functionality enabled.
504  */
505 class restore_process_course_modules_availability extends restore_execution_step {
507     protected function define_execution() {
508         global $CFG, $DB;
510         // Site hasn't availability enabled
511         if (empty($CFG->enableavailability)) {
512             return;
513         }
515         // Get all the module_availability objects to process
516         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'module_availability');
517         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid');
518         // Process availabilities, creating them if everything matches ok
519         foreach($rs as $availrec) {
520             $allmatchesok = true;
521             // Get the complete availabilityobject
522             $availability = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'module_availability', $availrec->itemid)->info;
523             // Map the sourcecmid if needed and possible
524             if (!empty($availability->sourcecmid)) {
525                 $newcm = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'course_module', $availability->sourcecmid);
526                 if ($newcm) {
527                     $availability->sourcecmid = $newcm->newitemid;
528                 } else {
529                     $allmatchesok = false; // Failed matching, we won't create this availability rule
530                 }
531             }
532             // Map the gradeitemid if needed and possible
533             if (!empty($availability->gradeitemid)) {
534                 $newgi = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'grade_item', $availability->gradeitemid);
535                 if ($newgi) {
536                     $availability->gradeitemid = $newgi->newitemid;
537                 } else {
538                     $allmatchesok = false; // Failed matching, we won't create this availability rule
539                 }
540             }
541             if ($allmatchesok) { // Everything ok, create the availability rule
542                 $DB->insert_record('course_modules_availability', $availability);
543             }
544         }
545         $rs->close();
546     }
550 /*
551  * Execution step that, *conditionally* (if there isn't preloaded information)
552  * will load the inforef files for all the included course/section/activity tasks
553  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
554  */
555 class restore_load_included_inforef_records extends restore_execution_step {
557     protected function define_execution() {
559         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
560             return;
561         }
563         // Get all the included tasks
564         $tasks = restore_dbops::get_included_tasks($this->get_restoreid());
565         foreach ($tasks as $task) {
566             // Load the inforef.xml file if exists
567             $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
568             if (file_exists($inforefpath)) {
569                 restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $inforefpath); // Load each inforef file to temp_ids
570             }
571         }
572     }
575 /*
576  * Execution step that will load all the needed files into backup_files_temp
577  *   - info: contains the whole original object (times, names...)
578  * (all them being original ids as loaded from xml)
579  */
580 class restore_load_included_files extends restore_structure_step {
582     protected function define_structure() {
584         $file = new restore_path_element('file', '/files/file');
586         return array($file);
587     }
589     /**
590      * Processing functions go here
591      *
592      * @param array $data one file record including repositoryid and reference
593      */
594     public function process_file($data) {
596         $data = (object)$data; // handy
598         $isreference = !empty($data->repositoryid);
599         $issamesite = $this->task->is_samesite();
601         // If it's not samesite, we skip file refernces
602         if (!$issamesite && $isreference) {
603             return;
604         }
606         // load it if needed:
607         //   - it it is one of the annotated inforef files (course/section/activity/block)
608         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
609         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
610         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
611         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
612         $iscomponent = ($data->component == 'user' || $data->component == 'group' ||
613                         $data->component == 'grouping' || $data->component == 'grade' ||
614                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
615         if ($isfileref || $iscomponent) {
616             // Process files
617             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
618         }
619     }
622 /**
623  * Execution step that, *conditionally* (if there isn't preloaded information),
624  * will load all the needed roles to backup_temp_ids. They will be stored with
625  * "role" itemname. Also it will perform one automatic mapping to roles existing
626  * in the target site, based in permissions of the user performing the restore,
627  * archetypes and other bits. At the end, each original role will have its associated
628  * target role or 0 if it's going to be skipped. Note we wrap everything over one
629  * restore_dbops method, as far as the same stuff is going to be also executed
630  * by restore prechecks
631  */
632 class restore_load_and_map_roles extends restore_execution_step {
634     protected function define_execution() {
635         if ($this->task->get_preloaded_information()) { // if info is already preloaded
636             return;
637         }
639         $file = $this->get_basepath() . '/roles.xml';
640         // Load needed toles to temp_ids
641         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
643         // Process roles, mapping/skipping. Any error throws exception
644         // Note we pass controller's info because it can contain role mapping information
645         // about manual mappings performed by UI
646         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);
647     }
650 /**
651  * Execution step that, *conditionally* (if there isn't preloaded information
652  * and users have been selected in settings, will load all the needed users
653  * to backup_temp_ids. They will be stored with "user" itemname and with
654  * their original contextid as paremitemid
655  */
656 class restore_load_included_users extends restore_execution_step {
658     protected function define_execution() {
660         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
661             return;
662         }
663         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
664             return;
665         }
666         $file = $this->get_basepath() . '/users.xml';
667         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file); // Load needed users to temp_ids
668     }
671 /**
672  * Execution step that, *conditionally* (if there isn't preloaded information
673  * and users have been selected in settings, will process all the needed users
674  * in order to decide and perform any action with them (create / map / error)
675  * Note: Any error will cause exception, as far as this is the same processing
676  * than the one into restore prechecks (that should have stopped process earlier)
677  */
678 class restore_process_included_users extends restore_execution_step {
680     protected function define_execution() {
682         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
683             return;
684         }
685         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
686             return;
687         }
688         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
689     }
692 /**
693  * Execution step that will create all the needed users as calculated
694  * by @restore_process_included_users (those having newiteind = 0)
695  */
696 class restore_create_included_users extends restore_execution_step {
698     protected function define_execution() {
700         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(), $this->task->get_userid());
701     }
704 /**
705  * Structure step that will create all the needed groups and groupings
706  * by loading them from the groups.xml file performing the required matches.
707  * Note group members only will be added if restoring user info
708  */
709 class restore_groups_structure_step extends restore_structure_step {
711     protected function define_structure() {
713         $paths = array(); // Add paths here
715         $paths[] = new restore_path_element('group', '/groups/group');
716         if ($this->get_setting_value('users')) {
717             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
718         }
719         $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
720         $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
722         return $paths;
723     }
725     // Processing functions go here
726     public function process_group($data) {
727         global $DB;
729         $data = (object)$data; // handy
730         $data->courseid = $this->get_courseid();
732         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
733         // another a group in the same course
734         $context = context_course::instance($data->courseid);
735         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
736             if (groups_get_group_by_idnumber($data->courseid, $data->idnumber)) {
737                 unset($data->idnumber);
738             }
739         } else {
740             unset($data->idnumber);
741         }
743         $oldid = $data->id;    // need this saved for later
745         $restorefiles = false; // Only if we end creating the group
747         // Search if the group already exists (by name & description) in the target course
748         $description_clause = '';
749         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
750         if (!empty($data->description)) {
751             $description_clause = ' AND ' .
752                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
753            $params['description'] = $data->description;
754         }
755         if (!$groupdb = $DB->get_record_sql("SELECT *
756                                                FROM {groups}
757                                               WHERE courseid = :courseid
758                                                 AND name = :grname $description_clause", $params)) {
759             // group doesn't exist, create
760             $newitemid = $DB->insert_record('groups', $data);
761             $restorefiles = true; // We'll restore the files
762         } else {
763             // group exists, use it
764             $newitemid = $groupdb->id;
765         }
766         // Save the id mapping
767         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
768     }
770     public function process_member($data) {
771         global $DB;
773         $data = (object)$data; // handy
775         // get parent group->id
776         $data->groupid = $this->get_new_parentid('group');
778         // map user newitemid and insert if not member already
779         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
780             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
781                 $DB->insert_record('groups_members', $data);
782             }
783         }
784     }
786     public function process_grouping($data) {
787         global $DB;
789         $data = (object)$data; // handy
790         $data->courseid = $this->get_courseid();
792         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
793         // another a grouping in the same course
794         $context = context_course::instance($data->courseid);
795         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
796             if (groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) {
797                 unset($data->idnumber);
798             }
799         } else {
800             unset($data->idnumber);
801         }
803         $oldid = $data->id;    // need this saved for later
804         $restorefiles = false; // Only if we end creating the grouping
806         // Search if the grouping already exists (by name & description) in the target course
807         $description_clause = '';
808         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
809         if (!empty($data->description)) {
810             $description_clause = ' AND ' .
811                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
812            $params['description'] = $data->description;
813         }
814         if (!$groupingdb = $DB->get_record_sql("SELECT *
815                                                   FROM {groupings}
816                                                  WHERE courseid = :courseid
817                                                    AND name = :grname $description_clause", $params)) {
818             // grouping doesn't exist, create
819             $newitemid = $DB->insert_record('groupings', $data);
820             $restorefiles = true; // We'll restore the files
821         } else {
822             // grouping exists, use it
823             $newitemid = $groupingdb->id;
824         }
825         // Save the id mapping
826         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
827     }
829     public function process_grouping_group($data) {
830         global $DB;
832         $data = (object)$data;
834         $data->groupingid = $this->get_new_parentid('grouping'); // Use new parentid
835         $data->groupid    = $this->get_mappingid('group', $data->groupid); // Get from mappings
837         $params = array();
838         $params['groupingid'] = $data->groupingid;
839         $params['groupid']    = $data->groupid;
841         if (!$DB->record_exists('groupings_groups', $params)) {
842             $DB->insert_record('groupings_groups', $data);  // No need to set this mapping (no child info nor files)
843         }
844     }
846     protected function after_execute() {
847         // Add group related files, matching with "group" mappings
848         $this->add_related_files('group', 'icon', 'group');
849         $this->add_related_files('group', 'description', 'group');
850         // Add grouping related files, matching with "grouping" mappings
851         $this->add_related_files('grouping', 'description', 'grouping');
852     }
856 /**
857  * Structure step that will create all the needed scales
858  * by loading them from the scales.xml
859  */
860 class restore_scales_structure_step extends restore_structure_step {
862     protected function define_structure() {
864         $paths = array(); // Add paths here
865         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
866         return $paths;
867     }
869     protected function process_scale($data) {
870         global $DB;
872         $data = (object)$data;
874         $restorefiles = false; // Only if we end creating the group
876         $oldid = $data->id;    // need this saved for later
878         // Look for scale (by 'scale' both in standard (course=0) and current course
879         // with priority to standard scales (ORDER clause)
880         // scale is not course unique, use get_record_sql to suppress warning
881         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
882         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
883         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
884         if (!$scadb = $DB->get_record_sql("SELECT *
885                                             FROM {scale}
886                                            WHERE courseid IN (0, :courseid)
887                                              AND $compare_scale_clause
888                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
889             // Remap the user if possible, defaut to user performing the restore if not
890             $userid = $this->get_mappingid('user', $data->userid);
891             $data->userid = $userid ? $userid : $this->task->get_userid();
892             // Remap the course if course scale
893             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
894             // If global scale (course=0), check the user has perms to create it
895             // falling to course scale if not
896             $systemctx = get_context_instance(CONTEXT_SYSTEM);
897             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
898                 $data->courseid = $this->get_courseid();
899             }
900             // scale doesn't exist, create
901             $newitemid = $DB->insert_record('scale', $data);
902             $restorefiles = true; // We'll restore the files
903         } else {
904             // scale exists, use it
905             $newitemid = $scadb->id;
906         }
907         // Save the id mapping (with files support at system context)
908         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
909     }
911     protected function after_execute() {
912         // Add scales related files, matching with "scale" mappings
913         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
914     }
918 /**
919  * Structure step that will create all the needed outocomes
920  * by loading them from the outcomes.xml
921  */
922 class restore_outcomes_structure_step extends restore_structure_step {
924     protected function define_structure() {
926         $paths = array(); // Add paths here
927         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
928         return $paths;
929     }
931     protected function process_outcome($data) {
932         global $DB;
934         $data = (object)$data;
936         $restorefiles = false; // Only if we end creating the group
938         $oldid = $data->id;    // need this saved for later
940         // Look for outcome (by shortname both in standard (courseid=null) and current course
941         // with priority to standard outcomes (ORDER clause)
942         // outcome is not course unique, use get_record_sql to suppress warning
943         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
944         if (!$outdb = $DB->get_record_sql('SELECT *
945                                              FROM {grade_outcomes}
946                                             WHERE shortname = :shortname
947                                               AND (courseid = :courseid OR courseid IS NULL)
948                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
949             // Remap the user
950             $userid = $this->get_mappingid('user', $data->usermodified);
951             $data->usermodified = $userid ? $userid : $this->task->get_userid();
952             // Remap the scale
953             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
954             // Remap the course if course outcome
955             $data->courseid = $data->courseid ? $this->get_courseid() : null;
956             // If global outcome (course=null), check the user has perms to create it
957             // falling to course outcome if not
958             $systemctx = get_context_instance(CONTEXT_SYSTEM);
959             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
960                 $data->courseid = $this->get_courseid();
961             }
962             // outcome doesn't exist, create
963             $newitemid = $DB->insert_record('grade_outcomes', $data);
964             $restorefiles = true; // We'll restore the files
965         } else {
966             // scale exists, use it
967             $newitemid = $outdb->id;
968         }
969         // Set the corresponding grade_outcomes_courses record
970         $outcourserec = new stdclass();
971         $outcourserec->courseid  = $this->get_courseid();
972         $outcourserec->outcomeid = $newitemid;
973         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
974             $DB->insert_record('grade_outcomes_courses', $outcourserec);
975         }
976         // Save the id mapping (with files support at system context)
977         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
978     }
980     protected function after_execute() {
981         // Add outcomes related files, matching with "outcome" mappings
982         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
983     }
986 /**
987  * Execution step that, *conditionally* (if there isn't preloaded information
988  * will load all the question categories and questions (header info only)
989  * to backup_temp_ids. They will be stored with "question_category" and
990  * "question" itemnames and with their original contextid and question category
991  * id as paremitemids
992  */
993 class restore_load_categories_and_questions extends restore_execution_step {
995     protected function define_execution() {
997         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
998             return;
999         }
1000         $file = $this->get_basepath() . '/questions.xml';
1001         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
1002     }
1005 /**
1006  * Execution step that, *conditionally* (if there isn't preloaded information)
1007  * will process all the needed categories and questions
1008  * in order to decide and perform any action with them (create / map / error)
1009  * Note: Any error will cause exception, as far as this is the same processing
1010  * than the one into restore prechecks (that should have stopped process earlier)
1011  */
1012 class restore_process_categories_and_questions extends restore_execution_step {
1014     protected function define_execution() {
1016         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1017             return;
1018         }
1019         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
1020     }
1023 /**
1024  * Structure step that will read the section.xml creating/updating sections
1025  * as needed, rebuilding course cache and other friends
1026  */
1027 class restore_section_structure_step extends restore_structure_step {
1029     protected function define_structure() {
1030         global $CFG;
1032         $paths = array();
1034         $section = new restore_path_element('section', '/section');
1035         $paths[] = $section;
1036         if ($CFG->enableavailability) {
1037             $paths[] = new restore_path_element('availability', '/section/availability');
1038         }
1040         // Apply for 'format' plugins optional paths at section level
1041         $this->add_plugin_structure('format', $section);
1043         return $paths;
1044     }
1046     public function process_section($data) {
1047         global $CFG, $DB;
1048         $data = (object)$data;
1049         $oldid = $data->id; // We'll need this later
1050         $oldsection = $data->number;
1052         $restorefiles = false;
1054         // Look for the section
1055         $section = new stdclass();
1056         $section->course  = $this->get_courseid();
1057         $section->section = $data->number;
1058         // Section doesn't exist, create it with all the info from backup
1059         if (!$secrec = $DB->get_record('course_sections', (array)$section)) {
1060             $section->name = $data->name;
1061             $section->summary = $data->summary;
1062             $section->summaryformat = $data->summaryformat;
1063             $section->sequence = '';
1064             $section->visible = $data->visible;
1065             if (empty($CFG->enableavailability)) { // Process availability information only if enabled.
1066                 $section->availablefrom = 0;
1067                 $section->availableuntil = 0;
1068                 $section->showavailability = 0;
1069             } else {
1070                 $section->availablefrom = isset($data->availablefrom) ? $this->apply_date_offset($data->availablefrom) : 0;
1071                 $section->availableuntil = isset($data->availableuntil) ? $this->apply_date_offset($data->availableuntil) : 0;
1072                 $section->showavailability = isset($data->showavailability) ? $data->showavailability : 0;
1073             }
1074             if (!empty($CFG->enablegroupmembersonly)) { // Only if enablegroupmembersonly is enabled
1075                 $section->groupingid = isset($data->groupingid) ? $this->get_mappingid('grouping', $data->groupingid) : 0;
1076             }
1077             $newitemid = $DB->insert_record('course_sections', $section);
1078             $restorefiles = true;
1080         // Section exists, update non-empty information
1081         } else {
1082             $section->id = $secrec->id;
1083             if (empty($secrec->name)) {
1084                 $section->name = $data->name;
1085             }
1086             if (empty($secrec->summary)) {
1087                 $section->summary = $data->summary;
1088                 $section->summaryformat = $data->summaryformat;
1089                 $restorefiles = true;
1090             }
1091             if (empty($secrec->groupingid)) {
1092                 if (!empty($CFG->enablegroupmembersonly)) { // Only if enablegroupmembersonly is enabled
1093                     $section->groupingid = isset($data->groupingid) ? $this->get_mappingid('grouping', $data->groupingid) : 0;
1094                 }
1095             }
1097             // Don't update available from, available until, or show availability
1098             // (I didn't see a useful way to define whether existing or new one should
1099             // take precedence).
1101             $DB->update_record('course_sections', $section);
1102             $newitemid = $secrec->id;
1103             $oldsection = $secrec->section;
1104         }
1106         // Annotate the section mapping, with restorefiles option if needed
1107         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
1108         $this->set_mapping('course_sectionnumber', $oldsection, $section->section, $restorefiles);
1110         // set the new course_section id in the task
1111         $this->task->set_sectionid($newitemid);
1114         // Commented out. We never modify course->numsections as far as that is used
1115         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
1116         // Note: We keep the code here, to know about and because of the possibility of making this
1117         // optional based on some setting/attribute in the future
1118         // If needed, adjust course->numsections
1119         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
1120         //    if ($numsections < $section->section) {
1121         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
1122         //    }
1123         //}
1124     }
1126     public function process_availability($data) {
1127         global $DB;
1128         $data = (object)$data;
1129         $data->coursesectionid = $this->task->get_sectionid();
1130         // NOTE: Other values in $data need updating, but these (cm,
1131         // grade items) have not yet been restored.
1132         $DB->insert_record('course_sections_availability', $data);
1133     }
1135     protected function after_execute() {
1136         // Add section related files, with 'course_section' itemid to match
1137         $this->add_related_files('course', 'section', 'course_section');
1138     }
1140     public function after_restore() {
1141         global $DB;
1143         $sectionid = $this->get_task()->get_sectionid();
1145         // Get data object for current section availability (if any)
1146         // TODO: This can be processing already existing records, we need to be able to know which ones
1147         //       are the just restored ones, perhaps creating 'course_sections_availability' mappings for them.
1148         // TODO: Also, this must avoid duplicates, so if one course module or one grade item already is being
1149         //       used for some availability rule... we need to handle that carefully.
1150         $data = $DB->get_record('course_sections_availability',
1151                 array('coursesectionid' => $sectionid), 'id, sourcecmid, gradeitemid', IGNORE_MISSING);
1153         // Update mappings
1154         if ($data) {
1155             $data->sourcecmid = $this->get_mappingid('course_module', $data->sourcecmid);
1156             if (!$data->sourcecmid) {
1157                 $data->sourcecmid = null;
1158             }
1159             $data->gradeitemid = $this->get_mappingid('grade_item', $data->gradeitemid);
1160             if (!$data->gradeitemid) {
1161                 $data->gradeitemid = null;
1162             }
1164             $DB->update_record('course_sections_availability', $data);
1165         }
1166     }
1170 /**
1171  * Structure step that will read the course.xml file, loading it and performing
1172  * various actions depending of the site/restore settings. Note that target
1173  * course always exist before arriving here so this step will be updating
1174  * the course record (never inserting)
1175  */
1176 class restore_course_structure_step extends restore_structure_step {
1177     /**
1178      * @var bool this gets set to true by {@link process_course()} if we are
1179      * restoring an old coures that used the legacy 'module security' feature.
1180      * If so, we have to do more work in {@link after_execute()}.
1181      */
1182     protected $legacyrestrictmodules = false;
1184     /**
1185      * @var array Used when {@link $legacyrestrictmodules} is true. This is an
1186      * array with array keys the module names ('forum', 'quiz', etc.). These are
1187      * the modules that are allowed according to the data in the backup file.
1188      * In {@link after_execute()} we then have to prevent adding of all the other
1189      * types of activity.
1190      */
1191     protected $legacyallowedmodules = array();
1193     protected function define_structure() {
1195         $course = new restore_path_element('course', '/course');
1196         $category = new restore_path_element('category', '/course/category');
1197         $tag = new restore_path_element('tag', '/course/tags/tag');
1198         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1200         // Apply for 'format' plugins optional paths at course level
1201         $this->add_plugin_structure('format', $course);
1203         // Apply for 'theme' plugins optional paths at course level
1204         $this->add_plugin_structure('theme', $course);
1206         // Apply for 'report' plugins optional paths at course level
1207         $this->add_plugin_structure('report', $course);
1209         // Apply for 'course report' plugins optional paths at course level
1210         $this->add_plugin_structure('coursereport', $course);
1212         // Apply for plagiarism plugins optional paths at course level
1213         $this->add_plugin_structure('plagiarism', $course);
1215         return array($course, $category, $tag, $allowed_module);
1216     }
1218     /**
1219      * Processing functions go here
1220      *
1221      * @global moodledatabase $DB
1222      * @param stdClass $data
1223      */
1224     public function process_course($data) {
1225         global $CFG, $DB;
1227         $data = (object)$data;
1229         $fullname  = $this->get_setting_value('course_fullname');
1230         $shortname = $this->get_setting_value('course_shortname');
1231         $startdate = $this->get_setting_value('course_startdate');
1233         // Calculate final course names, to avoid dupes
1234         list($fullname, $shortname) = restore_dbops::calculate_course_names($this->get_courseid(), $fullname, $shortname);
1236         // Need to change some fields before updating the course record
1237         $data->id = $this->get_courseid();
1238         $data->fullname = $fullname;
1239         $data->shortname= $shortname;
1241         $context = get_context_instance_by_id($this->task->get_contextid());
1242         if (has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1243             $data->idnumber = '';
1244         } else {
1245             unset($data->idnumber);
1246         }
1248         // Any empty value for course->hiddensections will lead to 0 (default, show collapsed).
1249         // It has been reported that some old 1.9 courses may have it null leading to DB error. MDL-31532
1250         if (empty($data->hiddensections)) {
1251             $data->hiddensections = 0;
1252         }
1254         // Set legacyrestrictmodules to true if the course was resticting modules. If so
1255         // then we will need to process restricted modules after execution.
1256         $this->legacyrestrictmodules = !empty($data->restrictmodules);
1258         $data->startdate= $this->apply_date_offset($data->startdate);
1259         if ($data->defaultgroupingid) {
1260             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1261         }
1262         if (empty($CFG->enablecompletion)) {
1263             $data->enablecompletion = 0;
1264             $data->completionstartonenrol = 0;
1265             $data->completionnotify = 0;
1266         }
1267         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1268         if (!array_key_exists($data->lang, $languages)) {
1269             $data->lang = '';
1270         }
1272         $themes = get_list_of_themes(); // Get themes for quick search later
1273         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1274             $data->theme = '';
1275         }
1277         // Course record ready, update it
1278         $DB->update_record('course', $data);
1280         // Role name aliases
1281         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1282     }
1284     public function process_category($data) {
1285         // Nothing to do with the category. UI sets it before restore starts
1286     }
1288     public function process_tag($data) {
1289         global $CFG, $DB;
1291         $data = (object)$data;
1293         if (!empty($CFG->usetags)) { // if enabled in server
1294             // TODO: This is highly inneficient. Each time we add one tag
1295             // we fetch all the existing because tag_set() deletes them
1296             // so everything must be reinserted on each call
1297             $tags = array();
1298             $existingtags = tag_get_tags('course', $this->get_courseid());
1299             // Re-add all the existitng tags
1300             foreach ($existingtags as $existingtag) {
1301                 $tags[] = $existingtag->rawname;
1302             }
1303             // Add the one being restored
1304             $tags[] = $data->rawname;
1305             // Send all the tags back to the course
1306             tag_set('course', $this->get_courseid(), $tags);
1307         }
1308     }
1310     public function process_allowed_module($data) {
1311         $data = (object)$data;
1313         // Backwards compatiblity support for the data that used to be in the
1314         // course_allowed_modules table.
1315         if ($this->legacyrestrictmodules) {
1316             $this->legacyallowedmodules[$data->modulename] = 1;
1317         }
1318     }
1320     protected function after_execute() {
1321         global $DB;
1323         // Add course related files, without itemid to match
1324         $this->add_related_files('course', 'summary', null);
1325         $this->add_related_files('course', 'legacy', null);
1327         // Deal with legacy allowed modules.
1328         if ($this->legacyrestrictmodules) {
1329             $context = context_course::instance($this->get_courseid());
1331             list($roleids) = get_roles_with_cap_in_context($context, 'moodle/course:manageactivities');
1332             list($managerroleids) = get_roles_with_cap_in_context($context, 'moodle/site:config');
1333             foreach ($managerroleids as $roleid) {
1334                 unset($roleids[$roleid]);
1335             }
1337             foreach (get_plugin_list('mod') as $modname => $notused) {
1338                 if (isset($this->legacyallowedmodules[$modname])) {
1339                     // Module is allowed, no worries.
1340                     continue;
1341                 }
1343                 $capability = 'mod/' . $modname . ':addinstance';
1344                 foreach ($roleids as $roleid) {
1345                     assign_capability($capability, CAP_PREVENT, $roleid, $context);
1346                 }
1347             }
1348         }
1349     }
1353 /*
1354  * Structure step that will read the roles.xml file (at course/activity/block levels)
1355  * containig all the role_assignments and overrides for that context. If corresponding to
1356  * one mapped role, they will be applied to target context. Will observe the role_assignments
1357  * setting to decide if ras are restored.
1358  * Note: only ras with component == null are restored as far as the any ra with component
1359  * is handled by one enrolment plugin, hence it will createt the ras later
1360  */
1361 class restore_ras_and_caps_structure_step extends restore_structure_step {
1363     protected function define_structure() {
1365         $paths = array();
1367         // Observe the role_assignments setting
1368         if ($this->get_setting_value('role_assignments')) {
1369             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
1370         }
1371         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
1373         return $paths;
1374     }
1376     /**
1377      * Assign roles
1378      *
1379      * This has to be called after enrolments processing.
1380      *
1381      * @param mixed $data
1382      * @return void
1383      */
1384     public function process_assignment($data) {
1385         global $DB;
1387         $data = (object)$data;
1389         // Check roleid, userid are one of the mapped ones
1390         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
1391             return;
1392         }
1393         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
1394             return;
1395         }
1396         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
1397             // Only assign roles to not deleted users
1398             return;
1399         }
1400         if (!$contextid = $this->task->get_contextid()) {
1401             return;
1402         }
1404         if (empty($data->component)) {
1405             // assign standard manual roles
1406             // TODO: role_assign() needs one userid param to be able to specify our restore userid
1407             role_assign($newroleid, $newuserid, $contextid);
1409         } else if ((strpos($data->component, 'enrol_') === 0)) {
1410             // Deal with enrolment roles
1411             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1412                 if ($component = $DB->get_field('enrol', 'component', array('id'=>$enrolid))) {
1413                     //note: we have to verify component because it might have changed
1414                     if ($component === 'enrol_manual') {
1415                         // manual is a special case, we do not use components - this owudl happen when converting from other plugin
1416                         role_assign($newroleid, $newuserid, $contextid); //TODO: do we need modifierid?
1417                     } else {
1418                         role_assign($newroleid, $newuserid, $contextid, $component, $enrolid); //TODO: do we need modifierid?
1419                     }
1420                 }
1421             }
1422         }
1423     }
1425     public function process_override($data) {
1426         $data = (object)$data;
1428         // Check roleid is one of the mapped ones
1429         $newroleid = $this->get_mappingid('role', $data->roleid);
1430         // If newroleid and context are valid assign it via API (it handles dupes and so on)
1431         if ($newroleid && $this->task->get_contextid()) {
1432             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
1433             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
1434             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
1435         }
1436     }
1439 /**
1440  * This structure steps restores the enrol plugins and their underlying
1441  * enrolments, performing all the mappings and/or movements required
1442  */
1443 class restore_enrolments_structure_step extends restore_structure_step {
1445     /**
1446      * Conditionally decide if this step should be executed.
1447      *
1448      * This function checks the following parameter:
1449      *
1450      *   1. the course/enrolments.xml file exists
1451      *
1452      * @return bool true is safe to execute, false otherwise
1453      */
1454     protected function execute_condition() {
1456         // Check it is included in the backup
1457         $fullpath = $this->task->get_taskbasepath();
1458         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1459         if (!file_exists($fullpath)) {
1460             // Not found, can't restore enrolments info
1461             return false;
1462         }
1464         return true;
1465     }
1467     protected function define_structure() {
1469         $paths = array();
1471         $paths[] = new restore_path_element('enrol', '/enrolments/enrols/enrol');
1472         $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
1474         return $paths;
1475     }
1477     /**
1478      * Create enrolment instances.
1479      *
1480      * This has to be called after creation of roles
1481      * and before adding of role assignments.
1482      *
1483      * @param mixed $data
1484      * @return void
1485      */
1486     public function process_enrol($data) {
1487         global $DB;
1489         $data = (object)$data;
1490         $oldid = $data->id; // We'll need this later
1492         $restoretype = plugin_supports('enrol', $data->enrol, ENROL_RESTORE_TYPE, null);
1494         if ($restoretype !== ENROL_RESTORE_EXACT and $restoretype !== ENROL_RESTORE_NOUSERS) {
1495             // TODO: add complex restore support via custom class
1496             debugging("Skipping '{$data->enrol}' enrolment plugin. Will be implemented before 2.0 release", DEBUG_DEVELOPER);
1497             $this->set_mapping('enrol', $oldid, 0);
1498             return;
1499         }
1501         // Perform various checks to decide what to do with the enrol plugin
1502         if (!array_key_exists($data->enrol, enrol_get_plugins(false))) {
1503             // TODO: decide if we want to switch to manual enrol - we need UI for this
1504             debugging("Enrol plugin data can not be restored because it is not installed");
1505             $this->set_mapping('enrol', $oldid, 0);
1506             return;
1508         }
1509         if (!enrol_is_enabled($data->enrol)) {
1510             // TODO: decide if we want to switch to manual enrol - we need UI for this
1511             debugging("Enrol plugin data can not be restored because it is not enabled");
1512             $this->set_mapping('enrol', $oldid, 0);
1513             return;
1514         }
1516         // map standard fields - plugin has to process custom fields from own restore class
1517         $data->roleid = $this->get_mappingid('role', $data->roleid);
1518         //TODO: should we move the enrol start and end date here?
1520         // always add instance, if the course does not support multiple instances it just returns NULL
1521         $enrol = enrol_get_plugin($data->enrol);
1522         $courserec = $DB->get_record('course', array('id' => $this->get_courseid())); // Requires object, uses only id!!
1523         if ($newitemid = $enrol->add_instance($courserec, (array)$data)) {
1524             // ok
1525         } else {
1526             if ($instances = $DB->get_records('enrol', array('courseid'=>$courserec->id, 'enrol'=>$data->enrol))) {
1527                 // most probably plugin that supports only one instance
1528                 $newitemid = key($instances);
1529             } else {
1530                 debugging('Can not create new enrol instance or reuse existing');
1531                 $newitemid = 0;
1532             }
1533         }
1535         if ($restoretype === ENROL_RESTORE_NOUSERS) {
1536             // plugin requests to prevent restore of any users
1537             $newitemid = 0;
1538         }
1540         $this->set_mapping('enrol', $oldid, $newitemid);
1541     }
1543     /**
1544      * Create user enrolments
1545      *
1546      * This has to be called after creation of enrolment instances
1547      * and before adding of role assignments.
1548      *
1549      * @param mixed $data
1550      * @return void
1551      */
1552     public function process_enrolment($data) {
1553         global $DB;
1555         $data = (object)$data;
1557         // Process only if parent instance have been mapped
1558         if ($enrolid = $this->get_new_parentid('enrol')) {
1559             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1560                 // And only if user is a mapped one
1561                 if ($userid = $this->get_mappingid('user', $data->userid)) {
1562                     $enrol = enrol_get_plugin($instance->enrol);
1563                     //TODO: do we need specify modifierid?
1564                     $enrol->enrol_user($instance, $userid, null, $data->timestart, $data->timeend, $data->status);
1565                     //note: roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing above
1566                 }
1567             }
1568         }
1569     }
1573 /**
1574  * Make sure the user restoring the course can actually access it.
1575  */
1576 class restore_fix_restorer_access_step extends restore_execution_step {
1577     protected function define_execution() {
1578         global $CFG, $DB;
1580         if (!$userid = $this->task->get_userid()) {
1581             return;
1582         }
1584         if (empty($CFG->restorernewroleid)) {
1585             // Bad luck, no fallback role for restorers specified
1586             return;
1587         }
1589         $courseid = $this->get_courseid();
1590         $context = context_course::instance($courseid);
1592         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1593             // Current user may access the course (admin, category manager or restored teacher enrolment usually)
1594             return;
1595         }
1597         // Try to add role only - we do not need enrolment if user has moodle/course:view or is already enrolled
1598         role_assign($CFG->restorernewroleid, $userid, $context);
1600         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1601             // Extra role is enough, yay!
1602             return;
1603         }
1605         // The last chance is to create manual enrol if it does not exist and and try to enrol the current user,
1606         // hopefully admin selected suitable $CFG->restorernewroleid ...
1607         if (!enrol_is_enabled('manual')) {
1608             return;
1609         }
1610         if (!$enrol = enrol_get_plugin('manual')) {
1611             return;
1612         }
1613         if (!$DB->record_exists('enrol', array('enrol'=>'manual', 'courseid'=>$courseid))) {
1614             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
1615             $fields = array('status'=>ENROL_INSTANCE_ENABLED, 'enrolperiod'=>$enrol->get_config('enrolperiod', 0), 'roleid'=>$enrol->get_config('roleid', 0));
1616             $enrol->add_instance($course, $fields);
1617         }
1619         enrol_try_internal_enrol($courseid, $userid);
1620     }
1624 /**
1625  * This structure steps restores the filters and their configs
1626  */
1627 class restore_filters_structure_step extends restore_structure_step {
1629     protected function define_structure() {
1631         $paths = array();
1633         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
1634         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
1636         return $paths;
1637     }
1639     public function process_active($data) {
1641         $data = (object)$data;
1643         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1644             return;
1645         }
1646         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
1647     }
1649     public function process_config($data) {
1651         $data = (object)$data;
1653         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1654             return;
1655         }
1656         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
1657     }
1661 /**
1662  * This structure steps restores the comments
1663  * Note: Cannot use the comments API because defaults to USER->id.
1664  * That should change allowing to pass $userid
1665  */
1666 class restore_comments_structure_step extends restore_structure_step {
1668     protected function define_structure() {
1670         $paths = array();
1672         $paths[] = new restore_path_element('comment', '/comments/comment');
1674         return $paths;
1675     }
1677     public function process_comment($data) {
1678         global $DB;
1680         $data = (object)$data;
1682         // First of all, if the comment has some itemid, ask to the task what to map
1683         $mapping = false;
1684         if ($data->itemid) {
1685             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
1686             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
1687         }
1688         // Only restore the comment if has no mapping OR we have found the matching mapping
1689         if (!$mapping || $data->itemid) {
1690             // Only if user mapping and context
1691             $data->userid = $this->get_mappingid('user', $data->userid);
1692             if ($data->userid && $this->task->get_contextid()) {
1693                 $data->contextid = $this->task->get_contextid();
1694                 // Only if there is another comment with same context/user/timecreated
1695                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
1696                 if (!$DB->record_exists('comments', $params)) {
1697                     $DB->insert_record('comments', $data);
1698                 }
1699             }
1700         }
1701     }
1704 /**
1705  * This structure steps restores the calendar events
1706  */
1707 class restore_calendarevents_structure_step extends restore_structure_step {
1709     protected function define_structure() {
1711         $paths = array();
1713         $paths[] = new restore_path_element('calendarevents', '/events/event');
1715         return $paths;
1716     }
1718     public function process_calendarevents($data) {
1719         global $DB;
1721         $data = (object)$data;
1722         $oldid = $data->id;
1723         $restorefiles = true; // We'll restore the files
1724         // Find the userid and the groupid associated with the event. Return if not found.
1725         $data->userid = $this->get_mappingid('user', $data->userid);
1726         if ($data->userid === false) {
1727             return;
1728         }
1729         if (!empty($data->groupid)) {
1730             $data->groupid = $this->get_mappingid('group', $data->groupid);
1731             if ($data->groupid === false) {
1732                 return;
1733             }
1734         }
1736         $params = array(
1737                 'name'           => $data->name,
1738                 'description'    => $data->description,
1739                 'format'         => $data->format,
1740                 'courseid'       => $this->get_courseid(),
1741                 'groupid'        => $data->groupid,
1742                 'userid'         => $data->userid,
1743                 'repeatid'       => $data->repeatid,
1744                 'modulename'     => $data->modulename,
1745                 'eventtype'      => $data->eventtype,
1746                 'timestart'      => $this->apply_date_offset($data->timestart),
1747                 'timeduration'   => $data->timeduration,
1748                 'visible'        => $data->visible,
1749                 'uuid'           => $data->uuid,
1750                 'sequence'       => $data->sequence,
1751                 'timemodified'    => $this->apply_date_offset($data->timemodified));
1752         if ($this->name == 'activity_calendar') {
1753             $params['instance'] = $this->task->get_activityid();
1754         } else {
1755             $params['instance'] = 0;
1756         }
1757         $sql = 'SELECT id FROM {event} WHERE name = ? AND courseid = ? AND
1758                 repeatid = ? AND modulename = ? AND timestart = ? AND timeduration =?
1759                 AND ' . $DB->sql_compare_text('description', 255) . ' = ' . $DB->sql_compare_text('?', 255);
1760         $arg = array ($params['name'], $params['courseid'], $params['repeatid'], $params['modulename'], $params['timestart'], $params['timeduration'], $params['description']);
1761         $result = $DB->record_exists_sql($sql, $arg);
1762         if (empty($result)) {
1763             $newitemid = $DB->insert_record('event', $params);
1764             $this->set_mapping('event_description', $oldid, $newitemid, $restorefiles);
1765         }
1767     }
1768     protected function after_execute() {
1769         // Add related files
1770         $this->add_related_files('calendar', 'event_description', 'event_description');
1771     }
1774 class restore_course_completion_structure_step extends restore_structure_step {
1776     /**
1777      * Conditionally decide if this step should be executed.
1778      *
1779      * This function checks parameters that are not immediate settings to ensure
1780      * that the enviroment is suitable for the restore of course completion info.
1781      *
1782      * This function checks the following four parameters:
1783      *
1784      *   1. Course completion is enabled on the site
1785      *   2. The backup includes course completion information
1786      *   3. All modules are restorable
1787      *   4. All modules are marked for restore.
1788      *
1789      * @return bool True is safe to execute, false otherwise
1790      */
1791     protected function execute_condition() {
1792         global $CFG;
1794         // First check course completion is enabled on this site
1795         if (empty($CFG->enablecompletion)) {
1796             // Disabled, don't restore course completion
1797             return false;
1798         }
1800         // Check it is included in the backup
1801         $fullpath = $this->task->get_taskbasepath();
1802         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1803         if (!file_exists($fullpath)) {
1804             // Not found, can't restore course completion
1805             return false;
1806         }
1808         // Check we are able to restore all backed up modules
1809         if ($this->task->is_missing_modules()) {
1810             return false;
1811         }
1813         // Finally check all modules within the backup are being restored.
1814         if ($this->task->is_excluding_activities()) {
1815             return false;
1816         }
1818         return true;
1819     }
1821     /**
1822      * Define the course completion structure
1823      *
1824      * @return array Array of restore_path_element
1825      */
1826     protected function define_structure() {
1828         // To know if we are including user completion info
1829         $userinfo = $this->get_setting_value('userscompletion');
1831         $paths = array();
1832         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
1833         $paths[] = new restore_path_element('course_completion_notify', '/course_completion/course_completion_notify');
1834         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
1836         if ($userinfo) {
1837             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
1838             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
1839         }
1841         return $paths;
1843     }
1845     /**
1846      * Process course completion criteria
1847      *
1848      * @global moodle_database $DB
1849      * @param stdClass $data
1850      */
1851     public function process_course_completion_criteria($data) {
1852         global $DB;
1854         $data = (object)$data;
1855         $data->course = $this->get_courseid();
1857         // Apply the date offset to the time end field
1858         $data->timeend = $this->apply_date_offset($data->timeend);
1860         // Map the role from the criteria
1861         if (!empty($data->role)) {
1862             $data->role = $this->get_mappingid('role', $data->role);
1863         }
1865         $skipcriteria = false;
1867         // If the completion criteria is for a module we need to map the module instance
1868         // to the new module id.
1869         if (!empty($data->moduleinstance) && !empty($data->module)) {
1870             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
1871             if (empty($data->moduleinstance)) {
1872                 $skipcriteria = true;
1873             }
1874         } else {
1875             $data->module = null;
1876             $data->moduleinstance = null;
1877         }
1879         // We backup the course shortname rather than the ID so that we can match back to the course
1880         if (!empty($data->courseinstanceshortname)) {
1881             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
1882             if (!$courseinstanceid) {
1883                 $skipcriteria = true;
1884             }
1885         } else {
1886             $courseinstanceid = null;
1887         }
1888         $data->courseinstance = $courseinstanceid;
1890         if (!$skipcriteria) {
1891             $params = array(
1892                 'course'         => $data->course,
1893                 'criteriatype'   => $data->criteriatype,
1894                 'enrolperiod'    => $data->enrolperiod,
1895                 'courseinstance' => $data->courseinstance,
1896                 'module'         => $data->module,
1897                 'moduleinstance' => $data->moduleinstance,
1898                 'timeend'        => $data->timeend,
1899                 'gradepass'      => $data->gradepass,
1900                 'role'           => $data->role
1901             );
1902             $newid = $DB->insert_record('course_completion_criteria', $params);
1903             $this->set_mapping('course_completion_criteria', $data->id, $newid);
1904         }
1905     }
1907     /**
1908      * Processes course compltion criteria complete records
1909      *
1910      * @global moodle_database $DB
1911      * @param stdClass $data
1912      */
1913     public function process_course_completion_crit_compl($data) {
1914         global $DB;
1916         $data = (object)$data;
1918         // This may be empty if criteria could not be restored
1919         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
1921         $data->course = $this->get_courseid();
1922         $data->userid = $this->get_mappingid('user', $data->userid);
1924         if (!empty($data->criteriaid) && !empty($data->userid)) {
1925             $params = array(
1926                 'userid' => $data->userid,
1927                 'course' => $data->course,
1928                 'criteriaid' => $data->criteriaid,
1929                 'timecompleted' => $this->apply_date_offset($data->timecompleted)
1930             );
1931             if (isset($data->gradefinal)) {
1932                 $params['gradefinal'] = $data->gradefinal;
1933             }
1934             if (isset($data->unenroled)) {
1935                 $params['unenroled'] = $data->unenroled;
1936             }
1937             if (isset($data->deleted)) {
1938                 $params['deleted'] = $data->deleted;
1939             }
1940             $DB->insert_record('course_completion_crit_compl', $params);
1941         }
1942     }
1944     /**
1945      * Process course completions
1946      *
1947      * @global moodle_database $DB
1948      * @param stdClass $data
1949      */
1950     public function process_course_completions($data) {
1951         global $DB;
1953         $data = (object)$data;
1955         $data->course = $this->get_courseid();
1956         $data->userid = $this->get_mappingid('user', $data->userid);
1958         if (!empty($data->userid)) {
1959             $params = array(
1960                 'userid' => $data->userid,
1961                 'course' => $data->course,
1962                 'deleted' => $data->deleted,
1963                 'timenotified' => $this->apply_date_offset($data->timenotified),
1964                 'timeenrolled' => $this->apply_date_offset($data->timeenrolled),
1965                 'timestarted' => $this->apply_date_offset($data->timestarted),
1966                 'timecompleted' => $this->apply_date_offset($data->timecompleted),
1967                 'reaggregate' => $data->reaggregate
1968             );
1969             $DB->insert_record('course_completions', $params);
1970         }
1971     }
1973     /**
1974      * Process course completion notification records.
1975      *
1976      * Note: As of Moodle 2.0 this table is not being used however it has been
1977      * left in in the hopes that one day the functionality there will be completed
1978      *
1979      * @global moodle_database $DB
1980      * @param stdClass $data
1981      */
1982     public function process_course_completion_notify($data) {
1983         global $DB;
1985         $data = (object)$data;
1987         $data->course = $this->get_courseid();
1988         if (!empty($data->role)) {
1989             $data->role = $this->get_mappingid('role', $data->role);
1990         }
1992         $params = array(
1993             'course' => $data->course,
1994             'role' => $data->role,
1995             'message' => $data->message,
1996             'timesent' => $this->apply_date_offset($data->timesent),
1997         );
1998         $DB->insert_record('course_completion_notify', $params);
1999     }
2001     /**
2002      * Process course completion aggregate methods
2003      *
2004      * @global moodle_database $DB
2005      * @param stdClass $data
2006      */
2007     public function process_course_completion_aggr_methd($data) {
2008         global $DB;
2010         $data = (object)$data;
2012         $data->course = $this->get_courseid();
2014         // Only create the course_completion_aggr_methd records if
2015         // the target course has not them defined. MDL-28180
2016         if (!$DB->record_exists('course_completion_aggr_methd', array(
2017                     'course' => $data->course,
2018                     'criteriatype' => $data->criteriatype))) {
2019             $params = array(
2020                 'course' => $data->course,
2021                 'criteriatype' => $data->criteriatype,
2022                 'method' => $data->method,
2023                 'value' => $data->value,
2024             );
2025             $DB->insert_record('course_completion_aggr_methd', $params);
2026         }
2027     }
2031 /**
2032  * This structure step restores course logs (cmid = 0), delegating
2033  * the hard work to the corresponding {@link restore_logs_processor} passing the
2034  * collection of {@link restore_log_rule} rules to be observed as they are defined
2035  * by the task. Note this is only executed based in the 'logs' setting.
2036  *
2037  * NOTE: This is executed by final task, to have all the activities already restored
2038  *
2039  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
2040  * records are. There are others like 'calendar' and 'upload' that will be handled
2041  * later.
2042  *
2043  * NOTE: All the missing actions (not able to be restored) are sent to logs for
2044  * debugging purposes
2045  */
2046 class restore_course_logs_structure_step extends restore_structure_step {
2048     /**
2049      * Conditionally decide if this step should be executed.
2050      *
2051      * This function checks the following parameter:
2052      *
2053      *   1. the course/logs.xml file exists
2054      *
2055      * @return bool true is safe to execute, false otherwise
2056      */
2057     protected function execute_condition() {
2059         // Check it is included in the backup
2060         $fullpath = $this->task->get_taskbasepath();
2061         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2062         if (!file_exists($fullpath)) {
2063             // Not found, can't restore course logs
2064             return false;
2065         }
2067         return true;
2068     }
2070     protected function define_structure() {
2072         $paths = array();
2074         // Simple, one plain level of information contains them
2075         $paths[] = new restore_path_element('log', '/logs/log');
2077         return $paths;
2078     }
2080     protected function process_log($data) {
2081         global $DB;
2083         $data = (object)($data);
2085         $data->time = $this->apply_date_offset($data->time);
2086         $data->userid = $this->get_mappingid('user', $data->userid);
2087         $data->course = $this->get_courseid();
2088         $data->cmid = 0;
2090         // For any reason user wasn't remapped ok, stop processing this
2091         if (empty($data->userid)) {
2092             return;
2093         }
2095         // Everything ready, let's delegate to the restore_logs_processor
2097         // Set some fixed values that will save tons of DB requests
2098         $values = array(
2099             'course' => $this->get_courseid());
2100         // Get instance and process log record
2101         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2103         // If we have data, insert it, else something went wrong in the restore_logs_processor
2104         if ($data) {
2105             $DB->insert_record('log', $data);
2106         }
2107     }
2110 /**
2111  * This structure step restores activity logs, extending {@link restore_course_logs_structure_step}
2112  * sharing its same structure but modifying the way records are handled
2113  */
2114 class restore_activity_logs_structure_step extends restore_course_logs_structure_step {
2116     protected function process_log($data) {
2117         global $DB;
2119         $data = (object)($data);
2121         $data->time = $this->apply_date_offset($data->time);
2122         $data->userid = $this->get_mappingid('user', $data->userid);
2123         $data->course = $this->get_courseid();
2124         $data->cmid = $this->task->get_moduleid();
2126         // For any reason user wasn't remapped ok, stop processing this
2127         if (empty($data->userid)) {
2128             return;
2129         }
2131         // Everything ready, let's delegate to the restore_logs_processor
2133         // Set some fixed values that will save tons of DB requests
2134         $values = array(
2135             'course' => $this->get_courseid(),
2136             'course_module' => $this->task->get_moduleid(),
2137             $this->task->get_modulename() => $this->task->get_activityid());
2138         // Get instance and process log record
2139         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2141         // If we have data, insert it, else something went wrong in the restore_logs_processor
2142         if ($data) {
2143             $DB->insert_record('log', $data);
2144         }
2145     }
2149 /**
2150  * Defines the restore step for advanced grading methods attached to the activity module
2151  */
2152 class restore_activity_grading_structure_step extends restore_structure_step {
2154     /**
2155      * This step is executed only if the grading file is present
2156      */
2157      protected function execute_condition() {
2159         $fullpath = $this->task->get_taskbasepath();
2160         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2161         if (!file_exists($fullpath)) {
2162             return false;
2163         }
2165         return true;
2166     }
2169     /**
2170      * Declares paths in the grading.xml file we are interested in
2171      */
2172     protected function define_structure() {
2174         $paths = array();
2175         $userinfo = $this->get_setting_value('userinfo');
2177         $paths[] = new restore_path_element('grading_area', '/areas/area');
2179         $definition = new restore_path_element('grading_definition', '/areas/area/definitions/definition');
2180         $paths[] = $definition;
2181         $this->add_plugin_structure('gradingform', $definition);
2183         if ($userinfo) {
2184             $instance = new restore_path_element('grading_instance',
2185                 '/areas/area/definitions/definition/instances/instance');
2186             $paths[] = $instance;
2187             $this->add_plugin_structure('gradingform', $instance);
2188         }
2190         return $paths;
2191     }
2193     /**
2194      * Processes one grading area element
2195      *
2196      * @param array $data element data
2197      */
2198     protected function process_grading_area($data) {
2199         global $DB;
2201         $task = $this->get_task();
2202         $data = (object)$data;
2203         $oldid = $data->id;
2204         $data->component = 'mod_'.$task->get_modulename();
2205         $data->contextid = $task->get_contextid();
2207         $newid = $DB->insert_record('grading_areas', $data);
2208         $this->set_mapping('grading_area', $oldid, $newid);
2209     }
2211     /**
2212      * Processes one grading definition element
2213      *
2214      * @param array $data element data
2215      */
2216     protected function process_grading_definition($data) {
2217         global $DB;
2219         $task = $this->get_task();
2220         $data = (object)$data;
2221         $oldid = $data->id;
2222         $data->areaid = $this->get_new_parentid('grading_area');
2223         $data->copiedfromid = null;
2224         $data->timecreated = time();
2225         $data->usercreated = $task->get_userid();
2226         $data->timemodified = $data->timecreated;
2227         $data->usermodified = $data->usercreated;
2229         $newid = $DB->insert_record('grading_definitions', $data);
2230         $this->set_mapping('grading_definition', $oldid, $newid, true);
2231     }
2233     /**
2234      * Processes one grading form instance element
2235      *
2236      * @param array $data element data
2237      */
2238     protected function process_grading_instance($data) {
2239         global $DB;
2241         $data = (object)$data;
2243         // new form definition id
2244         $newformid = $this->get_new_parentid('grading_definition');
2246         // get the name of the area we are restoring to
2247         $sql = "SELECT ga.areaname
2248                   FROM {grading_definitions} gd
2249                   JOIN {grading_areas} ga ON gd.areaid = ga.id
2250                  WHERE gd.id = ?";
2251         $areaname = $DB->get_field_sql($sql, array($newformid), MUST_EXIST);
2253         // get the mapped itemid - the activity module is expected to define the mappings
2254         // for each gradable area
2255         $newitemid = $this->get_mappingid(restore_gradingform_plugin::itemid_mapping($areaname), $data->itemid);
2257         $oldid = $data->id;
2258         $data->definitionid = $newformid;
2259         $data->raterid = $this->get_mappingid('user', $data->raterid);
2260         $data->itemid = $newitemid;
2262         $newid = $DB->insert_record('grading_instances', $data);
2263         $this->set_mapping('grading_instance', $oldid, $newid);
2264     }
2266     /**
2267      * Final operations when the database records are inserted
2268      */
2269     protected function after_execute() {
2270         // Add files embedded into the definition description
2271         $this->add_related_files('grading', 'description', 'grading_definition');
2272     }
2276 /**
2277  * This structure step restores the grade items associated with one activity
2278  * All the grade items are made child of the "course" grade item but the original
2279  * categoryid is saved as parentitemid in the backup_ids table, so, when restoring
2280  * the complete gradebook (categories and calculations), that information is
2281  * available there
2282  */
2283 class restore_activity_grades_structure_step extends restore_structure_step {
2285     protected function define_structure() {
2287         $paths = array();
2288         $userinfo = $this->get_setting_value('userinfo');
2290         $paths[] = new restore_path_element('grade_item', '/activity_gradebook/grade_items/grade_item');
2291         $paths[] = new restore_path_element('grade_letter', '/activity_gradebook/grade_letters/grade_letter');
2292         if ($userinfo) {
2293             $paths[] = new restore_path_element('grade_grade',
2294                            '/activity_gradebook/grade_items/grade_item/grade_grades/grade_grade');
2295         }
2296         return $paths;
2297     }
2299     protected function process_grade_item($data) {
2300         global $DB;
2302         $data = (object)($data);
2303         $oldid       = $data->id;        // We'll need these later
2304         $oldparentid = $data->categoryid;
2305         $courseid = $this->get_courseid();
2307         // make sure top course category exists, all grade items will be associated
2308         // to it. Later, if restoring the whole gradebook, categories will be introduced
2309         $coursecat = grade_category::fetch_course_category($courseid);
2310         $coursecatid = $coursecat->id; // Get the categoryid to be used
2312         $idnumber = null;
2313         if (!empty($data->idnumber)) {
2314             // Don't get any idnumber from course module. Keep them as they are in grade_item->idnumber
2315             // Reason: it's not clear what happens with outcomes->idnumber or activities with multiple items (workshop)
2316             // so the best is to keep the ones already in the gradebook
2317             // Potential problem: duplicates if same items are restored more than once. :-(
2318             // This needs to be fixed in some way (outcomes & activities with multiple items)
2319             // $data->idnumber     = get_coursemodule_from_instance($data->itemmodule, $data->iteminstance)->idnumber;
2320             // In any case, verify always for uniqueness
2321             $sql = "SELECT cm.id
2322                       FROM {course_modules} cm
2323                      WHERE cm.course = :courseid AND
2324                            cm.idnumber = :idnumber AND
2325                            cm.id <> :cmid";
2326             $params = array(
2327                 'courseid' => $courseid,
2328                 'idnumber' => $data->idnumber,
2329                 'cmid' => $this->task->get_moduleid()
2330             );
2331             if (!$DB->record_exists_sql($sql, $params) && !$DB->record_exists('grade_items', array('courseid' => $courseid, 'idnumber' => $data->idnumber))) {
2332                 $idnumber = $data->idnumber;
2333             }
2334         }
2336         unset($data->id);
2337         $data->categoryid   = $coursecatid;
2338         $data->courseid     = $this->get_courseid();
2339         $data->iteminstance = $this->task->get_activityid();
2340         $data->idnumber     = $idnumber;
2341         $data->scaleid      = $this->get_mappingid('scale', $data->scaleid);
2342         $data->outcomeid    = $this->get_mappingid('outcome', $data->outcomeid);
2343         $data->timecreated  = $this->apply_date_offset($data->timecreated);
2344         $data->timemodified = $this->apply_date_offset($data->timemodified);
2346         $gradeitem = new grade_item($data, false);
2347         $gradeitem->insert('restore');
2349         //sortorder is automatically assigned when inserting. Re-instate the previous sortorder
2350         $gradeitem->sortorder = $data->sortorder;
2351         $gradeitem->update('restore');
2353         // Set mapping, saving the original category id into parentitemid
2354         // gradebook restore (final task) will need it to reorganise items
2355         $this->set_mapping('grade_item', $oldid, $gradeitem->id, false, null, $oldparentid);
2356     }
2358     protected function process_grade_grade($data) {
2359         $data = (object)($data);
2361         unset($data->id);
2362         $data->itemid = $this->get_new_parentid('grade_item');
2363         $data->userid = $this->get_mappingid('user', $data->userid);
2364         $data->usermodified = $this->get_mappingid('user', $data->usermodified);
2365         $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
2366         // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
2367         $data->overridden = $this->apply_date_offset($data->overridden);
2369         $grade = new grade_grade($data, false);
2370         $grade->insert('restore');
2371         // no need to save any grade_grade mapping
2372     }
2374     /**
2375      * process activity grade_letters. Note that, while these are possible,
2376      * because grade_letters are contextid based, in proctice, only course
2377      * context letters can be defined. So we keep here this method knowing
2378      * it won't be executed ever. gradebook restore will restore course letters.
2379      */
2380     protected function process_grade_letter($data) {
2381         global $DB;
2383         $data = (object)$data;
2385         $data->contextid = $this->task->get_contextid();
2386         $newitemid = $DB->insert_record('grade_letters', $data);
2387         // no need to save any grade_letter mapping
2388     }
2392 /**
2393  * This structure steps restores one instance + positions of one block
2394  * Note: Positions corresponding to one existing context are restored
2395  * here, but all the ones having unknown contexts are sent to backup_ids
2396  * for a later chance to be restored at the end (final task)
2397  */
2398 class restore_block_instance_structure_step extends restore_structure_step {
2400     protected function define_structure() {
2402         $paths = array();
2404         $paths[] = new restore_path_element('block', '/block', true); // Get the whole XML together
2405         $paths[] = new restore_path_element('block_position', '/block/block_positions/block_position');
2407         return $paths;
2408     }
2410     public function process_block($data) {
2411         global $DB, $CFG;
2413         $data = (object)$data; // Handy
2414         $oldcontextid = $data->contextid;
2415         $oldid        = $data->id;
2416         $positions = isset($data->block_positions['block_position']) ? $data->block_positions['block_position'] : array();
2418         // Look for the parent contextid
2419         if (!$data->parentcontextid = $this->get_mappingid('context', $data->parentcontextid)) {
2420             throw new restore_step_exception('restore_block_missing_parent_ctx', $data->parentcontextid);
2421         }
2423         // TODO: it would be nice to use standard plugin supports instead of this instance_allow_multiple()
2424         // If there is already one block of that type in the parent context
2425         // and the block is not multiple, stop processing
2426         // Use blockslib loader / method executor
2427         if (!$bi = block_instance($data->blockname)) {
2428             return false;
2429         }
2431         if (!$bi->instance_allow_multiple()) {
2432             if ($DB->record_exists_sql("SELECT bi.id
2433                                           FROM {block_instances} bi
2434                                           JOIN {block} b ON b.name = bi.blockname
2435                                          WHERE bi.parentcontextid = ?
2436                                            AND bi.blockname = ?", array($data->parentcontextid, $data->blockname))) {
2437                 return false;
2438             }
2439         }
2441         // If there is already one block of that type in the parent context
2442         // with the same showincontexts, pagetypepattern, subpagepattern, defaultregion and configdata
2443         // stop processing
2444         $params = array(
2445             'blockname' => $data->blockname, 'parentcontextid' => $data->parentcontextid,
2446             'showinsubcontexts' => $data->showinsubcontexts, 'pagetypepattern' => $data->pagetypepattern,
2447             'subpagepattern' => $data->subpagepattern, 'defaultregion' => $data->defaultregion);
2448         if ($birecs = $DB->get_records('block_instances', $params)) {
2449             foreach($birecs as $birec) {
2450                 if ($birec->configdata == $data->configdata) {
2451                     return false;
2452                 }
2453             }
2454         }
2456         // Set task old contextid, blockid and blockname once we know them
2457         $this->task->set_old_contextid($oldcontextid);
2458         $this->task->set_old_blockid($oldid);
2459         $this->task->set_blockname($data->blockname);
2461         // Let's look for anything within configdata neededing processing
2462         // (nulls and uses of legacy file.php)
2463         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
2464             $configdata = (array)unserialize(base64_decode($data->configdata));
2465             foreach ($configdata as $attribute => $value) {
2466                 if (in_array($attribute, $attrstotransform)) {
2467                     $configdata[$attribute] = $this->contentprocessor->process_cdata($value);
2468                 }
2469             }
2470             $data->configdata = base64_encode(serialize((object)$configdata));
2471         }
2473         // Create the block instance
2474         $newitemid = $DB->insert_record('block_instances', $data);
2475         // Save the mapping (with restorefiles support)
2476         $this->set_mapping('block_instance', $oldid, $newitemid, true);
2477         // Create the block context
2478         $newcontextid = get_context_instance(CONTEXT_BLOCK, $newitemid)->id;
2479         // Save the block contexts mapping and sent it to task
2480         $this->set_mapping('context', $oldcontextid, $newcontextid);
2481         $this->task->set_contextid($newcontextid);
2482         $this->task->set_blockid($newitemid);
2484         // Restore block fileareas if declared
2485         $component = 'block_' . $this->task->get_blockname();
2486         foreach ($this->task->get_fileareas() as $filearea) { // Simple match by contextid. No itemname needed
2487             $this->add_related_files($component, $filearea, null);
2488         }
2490         // Process block positions, creating them or accumulating for final step
2491         foreach($positions as $position) {
2492             $position = (object)$position;
2493             $position->blockinstanceid = $newitemid; // The instance is always the restored one
2494             // If position is for one already mapped (known) contextid
2495             // process it now, creating the position
2496             if ($newpositionctxid = $this->get_mappingid('context', $position->contextid)) {
2497                 $position->contextid = $newpositionctxid;
2498                 // Create the block position
2499                 $DB->insert_record('block_positions', $position);
2501             // The position belongs to an unknown context, send it to backup_ids
2502             // to process them as part of the final steps of restore. We send the
2503             // whole $position object there, hence use the low level method.
2504             } else {
2505                 restore_dbops::set_backup_ids_record($this->get_restoreid(), 'block_position', $position->id, 0, null, $position);
2506             }
2507         }
2508     }
2511 /**
2512  * Structure step to restore common course_module information
2513  *
2514  * This step will process the module.xml file for one activity, in order to restore
2515  * the corresponding information to the course_modules table, skipping various bits
2516  * of information based on CFG settings (groupings, completion...) in order to fullfill
2517  * all the reqs to be able to create the context to be used by all the rest of steps
2518  * in the activity restore task
2519  */
2520 class restore_module_structure_step extends restore_structure_step {
2522     protected function define_structure() {
2523         global $CFG;
2525         $paths = array();
2527         $module = new restore_path_element('module', '/module');
2528         $paths[] = $module;
2529         if ($CFG->enableavailability) {
2530             $paths[] = new restore_path_element('availability', '/module/availability_info/availability');
2531         }
2533         // Apply for 'format' plugins optional paths at module level
2534         $this->add_plugin_structure('format', $module);
2536         // Apply for 'plagiarism' plugins optional paths at module level
2537         $this->add_plugin_structure('plagiarism', $module);
2539         return $paths;
2540     }
2542     protected function process_module($data) {
2543         global $CFG, $DB;
2545         $data = (object)$data;
2546         $oldid = $data->id;
2547         $oldsection = $data->sectionnumber;
2548         $this->task->set_old_moduleversion($data->version);
2550         $data->course = $this->task->get_courseid();
2551         $data->module = $DB->get_field('modules', 'id', array('name' => $data->modulename));
2552         // Map section (first try by course_section mapping match. Useful in course and section restores)
2553         $data->section = $this->get_mappingid('course_section', $data->sectionid);
2554         if (!$data->section) { // mapping failed, try to get section by sectionnumber matching
2555             $params = array(
2556                 'course' => $this->get_courseid(),
2557                 'section' => $data->sectionnumber);
2558             $data->section = $DB->get_field('course_sections', 'id', $params);
2559         }
2560         if (!$data->section) { // sectionnumber failed, try to get first section in course
2561             $params = array(
2562                 'course' => $this->get_courseid());
2563             $data->section = $DB->get_field('course_sections', 'MIN(id)', $params);
2564         }
2565         if (!$data->section) { // no sections in course, create section 0 and 1 and assign module to 1
2566             $sectionrec = array(
2567                 'course' => $this->get_courseid(),
2568                 'section' => 0);
2569             $DB->insert_record('course_sections', $sectionrec); // section 0
2570             $sectionrec = array(
2571                 'course' => $this->get_courseid(),
2572                 'section' => 1);
2573             $data->section = $DB->insert_record('course_sections', $sectionrec); // section 1
2574             $this->set_mapping('course_sectionnumber', $oldsection, $sectionrec->section, $restorefiles);
2575         }
2576         $data->groupingid= $this->get_mappingid('grouping', $data->groupingid);      // grouping
2577         if (!$CFG->enablegroupmembersonly) {                                         // observe groupsmemberonly
2578             $data->groupmembersonly = 0;
2579         }
2580         if (!grade_verify_idnumber($data->idnumber, $this->get_courseid())) {        // idnumber uniqueness
2581             $data->idnumber = '';
2582         }
2583         if (empty($CFG->enablecompletion)) { // completion
2584             $data->completion = 0;
2585             $data->completiongradeitemnumber = null;
2586             $data->completionview = 0;
2587             $data->completionexpected = 0;
2588         } else {
2589             $data->completionexpected = $this->apply_date_offset($data->completionexpected);
2590         }
2591         if (empty($CFG->enableavailability)) {
2592             $data->availablefrom = 0;
2593             $data->availableuntil = 0;
2594             $data->showavailability = 0;
2595         } else {
2596             $data->availablefrom = $this->apply_date_offset($data->availablefrom);
2597             $data->availableuntil= $this->apply_date_offset($data->availableuntil);
2598         }
2599         // Backups that did not include showdescription, set it to default 0
2600         // (this is not totally necessary as it has a db default, but just to
2601         // be explicit).
2602         if (!isset($data->showdescription)) {
2603             $data->showdescription = 0;
2604         }
2605         $data->instance = 0; // Set to 0 for now, going to create it soon (next step)
2607         // course_module record ready, insert it
2608         $newitemid = $DB->insert_record('course_modules', $data);
2609         // save mapping
2610         $this->set_mapping('course_module', $oldid, $newitemid);
2611         // set the new course_module id in the task
2612         $this->task->set_moduleid($newitemid);
2613         // we can now create the context safely
2614         $ctxid = get_context_instance(CONTEXT_MODULE, $newitemid)->id;
2615         // set the new context id in the task
2616         $this->task->set_contextid($ctxid);
2617         // update sequence field in course_section
2618         if ($sequence = $DB->get_field('course_sections', 'sequence', array('id' => $data->section))) {
2619             $sequence .= ',' . $newitemid;
2620         } else {
2621             $sequence = $newitemid;
2622         }
2623         $DB->set_field('course_sections', 'sequence', $sequence, array('id' => $data->section));
2624     }
2627     protected function process_availability($data) {
2628         $data = (object)$data;
2629         // Simply going to store the whole availability record now, we'll process
2630         // all them later in the final task (once all actvivities have been restored)
2631         // Let's call the low level one to be able to store the whole object
2632         $data->coursemoduleid = $this->task->get_moduleid(); // Let add the availability cmid
2633         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'module_availability', $data->id, 0, null, $data);
2634     }
2637 /**
2638  * Structure step that will process the user activity completion
2639  * information if all these conditions are met:
2640  *  - Target site has completion enabled ($CFG->enablecompletion)
2641  *  - Activity includes completion info (file_exists)
2642  */
2643 class restore_userscompletion_structure_step extends restore_structure_step {
2644     /**
2645      * To conditionally decide if this step must be executed
2646      * Note the "settings" conditions are evaluated in the
2647      * corresponding task. Here we check for other conditions
2648      * not being restore settings (files, site settings...)
2649      */
2650      protected function execute_condition() {
2651          global $CFG;
2653          // Completion disabled in this site, don't execute
2654          if (empty($CFG->enablecompletion)) {
2655              return false;
2656          }
2658          // No user completion info found, don't execute
2659         $fullpath = $this->task->get_taskbasepath();
2660         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2661          if (!file_exists($fullpath)) {
2662              return false;
2663          }
2665          // Arrived here, execute the step
2666          return true;
2667      }
2669      protected function define_structure() {
2671         $paths = array();
2673         $paths[] = new restore_path_element('completion', '/completions/completion');
2675         return $paths;
2676     }
2678     protected function process_completion($data) {
2679         global $DB;
2681         $data = (object)$data;
2683         $data->coursemoduleid = $this->task->get_moduleid();
2684         $data->userid = $this->get_mappingid('user', $data->userid);
2685         $data->timemodified = $this->apply_date_offset($data->timemodified);
2687         // Find the existing record
2688         $existing = $DB->get_record('course_modules_completion', array(
2689                 'coursemoduleid' => $data->coursemoduleid,
2690                 'userid' => $data->userid), 'id, timemodified');
2691         // Check we didn't already insert one for this cmid and userid
2692         // (there aren't supposed to be duplicates in that field, but
2693         // it was possible until MDL-28021 was fixed).
2694         if ($existing) {
2695             // Update it to these new values, but only if the time is newer
2696             if ($existing->timemodified < $data->timemodified) {
2697                 $data->id = $existing->id;
2698                 $DB->update_record('course_modules_completion', $data);
2699             }
2700         } else {
2701             // Normal entry where it doesn't exist already
2702             $DB->insert_record('course_modules_completion', $data);
2703         }
2704     }
2707 /**
2708  * Abstract structure step, parent of all the activity structure steps. Used to suuport
2709  * the main <activity ...> tag and process it. Also provides subplugin support for
2710  * activities.
2711  */
2712 abstract class restore_activity_structure_step extends restore_structure_step {
2714     protected function add_subplugin_structure($subplugintype, $element) {
2716         global $CFG;
2718         // Check the requested subplugintype is a valid one
2719         $subpluginsfile = $CFG->dirroot . '/mod/' . $this->task->get_modulename() . '/db/subplugins.php';
2720         if (!file_exists($subpluginsfile)) {
2721              throw new restore_step_exception('activity_missing_subplugins_php_file', $this->task->get_modulename());
2722         }
2723         include($subpluginsfile);
2724         if (!array_key_exists($subplugintype, $subplugins)) {
2725              throw new restore_step_exception('incorrect_subplugin_type', $subplugintype);
2726         }
2727         // Get all the restore path elements, looking across all the subplugin dirs
2728         $subpluginsdirs = get_plugin_list($subplugintype);
2729         foreach ($subpluginsdirs as $name => $subpluginsdir) {
2730             $classname = 'restore_' . $subplugintype . '_' . $name . '_subplugin';
2731             $restorefile = $subpluginsdir . '/backup/moodle2/' . $classname . '.class.php';
2732             if (file_exists($restorefile)) {
2733                 require_once($restorefile);
2734                 $restoresubplugin = new $classname($subplugintype, $name, $this);
2735                 // Add subplugin paths to the step
2736                 $this->prepare_pathelements($restoresubplugin->define_subplugin_structure($element));
2737             }
2738         }
2739     }
2741     /**
2742      * As far as activity restore steps are implementing restore_subplugin stuff, they need to
2743      * have the parent task available for wrapping purposes (get course/context....)
2744      * @return restore_task
2745      */
2746     public function get_task() {
2747         return $this->task;
2748     }
2750     /**
2751      * Adds support for the 'activity' path that is common to all the activities
2752      * and will be processed globally here
2753      */
2754     protected function prepare_activity_structure($paths) {
2756         $paths[] = new restore_path_element('activity', '/activity');
2758         return $paths;
2759     }
2761     /**
2762      * Process the activity path, informing the task about various ids, needed later
2763      */
2764     protected function process_activity($data) {
2765         $data = (object)$data;
2766         $this->task->set_old_contextid($data->contextid); // Save old contextid in task
2767         $this->set_mapping('context', $data->contextid, $this->task->get_contextid()); // Set the mapping
2768         $this->task->set_old_activityid($data->id); // Save old activityid in task
2769     }
2771     /**
2772      * This must be invoked immediately after creating the "module" activity record (forum, choice...)
2773      * and will adjust the new activity id (the instance) in various places
2774      */
2775     protected function apply_activity_instance($newitemid) {
2776         global $DB;
2778         $this->task->set_activityid($newitemid); // Save activity id in task
2779         // Apply the id to course_sections->instanceid
2780         $DB->set_field('course_modules', 'instance', $newitemid, array('id' => $this->task->get_moduleid()));
2781         // Do the mapping for modulename, preparing it for files by oldcontext
2782         $modulename = $this->task->get_modulename();
2783         $oldid = $this->task->get_old_activityid();
2784         $this->set_mapping($modulename, $oldid, $newitemid, true);
2785     }
2788 /**
2789  * Structure step in charge of creating/mapping all the qcats and qs
2790  * by parsing the questions.xml file and checking it against the
2791  * results calculated by {@link restore_process_categories_and_questions}
2792  * and stored in backup_ids_temp
2793  */
2794 class restore_create_categories_and_questions extends restore_structure_step {
2796     protected function define_structure() {
2798         $category = new restore_path_element('question_category', '/question_categories/question_category');
2799         $question = new restore_path_element('question', '/question_categories/question_category/questions/question');
2800         $hint = new restore_path_element('question_hint',
2801                 '/question_categories/question_category/questions/question/question_hints/question_hint');
2803         // Apply for 'qtype' plugins optional paths at question level
2804         $this->add_plugin_structure('qtype', $question);
2806         return array($category, $question, $hint);
2807     }
2809     protected function process_question_category($data) {
2810         global $DB;
2812         $data = (object)$data;
2813         $oldid = $data->id;
2815         // Check we have one mapping for this category
2816         if (!$mapping = $this->get_mapping('question_category', $oldid)) {
2817             return self::SKIP_ALL_CHILDREN; // No mapping = this category doesn't need to be created/mapped
2818         }
2820         // Check we have to create the category (newitemid = 0)
2821         if ($mapping->newitemid) {
2822             return; // newitemid != 0, this category is going to be mapped. Nothing to do
2823         }
2825         // Arrived here, newitemid = 0, we need to create the category
2826         // we'll do it at parentitemid context, but for CONTEXT_MODULE
2827         // categories, that will be created at CONTEXT_COURSE and moved
2828         // to module context later when the activity is created
2829         if ($mapping->info->contextlevel == CONTEXT_MODULE) {
2830             $mapping->parentitemid = $this->get_mappingid('context', $this->task->get_old_contextid());
2831         }
2832         $data->contextid = $mapping->parentitemid;
2834         // Let's create the question_category and save mapping
2835         $newitemid = $DB->insert_record('question_categories', $data);
2836         $this->set_mapping('question_category', $oldid, $newitemid);
2837         // Also annotate them as question_category_created, we need
2838         // that later when remapping parents
2839         $this->set_mapping('question_category_created', $oldid, $newitemid, false, null, $data->contextid);
2840     }
2842     protected function process_question($data) {
2843         global $DB;
2845         $data = (object)$data;
2846         $oldid = $data->id;
2848         // Check we have one mapping for this question
2849         if (!$questionmapping = $this->get_mapping('question', $oldid)) {
2850             return; // No mapping = this question doesn't need to be created/mapped
2851         }
2853         // Get the mapped category (cannot use get_new_parentid() because not
2854         // all the categories have been created, so it is not always available
2855         // Instead we get the mapping for the question->parentitemid because
2856         // we have loaded qcatids there for all parsed questions
2857         $data->category = $this->get_mappingid('question_category', $questionmapping->parentitemid);
2859         // In the past, there were some very sloppy values of penalty. Fix them.
2860         if ($data->penalty >= 0.33 && $data->penalty <= 0.34) {
2861             $data->penalty = 0.3333333;
2862         }
2863         if ($data->penalty >= 0.66 && $data->penalty <= 0.67) {
2864             $data->penalty = 0.6666667;
2865         }
2866         if ($data->penalty >= 1) {
2867             $data->penalty = 1;
2868         }
2870         $data->timecreated  = $this->apply_date_offset($data->timecreated);
2871         $data->timemodified = $this->apply_date_offset($data->timemodified);
2873         $userid = $this->get_mappingid('user', $data->createdby);
2874         $data->createdby = $userid ? $userid : $this->task->get_userid();
2876         $userid = $this->get_mappingid('user', $data->modifiedby);
2877         $data->modifiedby = $userid ? $userid : $this->task->get_userid();
2879         // With newitemid = 0, let's create the question
2880         if (!$questionmapping->newitemid) {
2881             $newitemid = $DB->insert_record('question', $data);
2882             $this->set_mapping('question', $oldid, $newitemid);
2883             // Also annotate them as question_created, we need
2884             // that later when remapping parents (keeping the old categoryid as parentid)
2885             $this->set_mapping('question_created', $oldid, $newitemid, false, null, $questionmapping->parentitemid);
2886         } else {
2887             // By performing this set_mapping() we make get_old/new_parentid() to work for all the
2888             // children elements of the 'question' one (so qtype plugins will know the question they belong to)
2889             $this->set_mapping('question', $oldid, $questionmapping->newitemid);
2890         }
2892         // Note, we don't restore any question files yet
2893         // as far as the CONTEXT_MODULE categories still
2894         // haven't their contexts to be restored to
2895         // The {@link restore_create_question_files}, executed in the final step
2896         // step will be in charge of restoring all the question files
2897     }
2899         protected function process_question_hint($data) {
2900         global $DB;
2902         $data = (object)$data;
2903         $oldid = $data->id;
2905         // Detect if the question is created or mapped
2906         $oldquestionid   = $this->get_old_parentid('question');
2907         $newquestionid   = $this->get_new_parentid('question');
2908         $questioncreated = $this->get_mappingid('question_created', $oldquestionid) ? true : false;
2910         // If the question has been created by restore, we need to create its question_answers too
2911         if ($questioncreated) {
2912             // Adjust some columns
2913             $data->questionid = $newquestionid;
2914             // Insert record
2915             $newitemid = $DB->insert_record('question_hints', $data);
2917         // The question existed, we need to map the existing question_hints
2918         } else {
2919             // Look in question_hints by hint text matching
2920             $sql = 'SELECT id
2921                       FROM {question_hints}
2922                      WHERE questionid = ?
2923                        AND ' . $DB->sql_compare_text('hint', 255) . ' = ' . $DB->sql_compare_text('?', 255);
2924             $params = array($newquestionid, $data->hint);
2925             $newitemid = $DB->get_field_sql($sql, $params);
2926             // If we haven't found the newitemid, something has gone really wrong, question in DB
2927             // is missing hints, exception
2928             if (!$newitemid) {
2929                 $info = new stdClass();
2930                 $info->filequestionid = $oldquestionid;
2931                 $info->dbquestionid   = $newquestionid;
2932                 $info->hint           = $data->hint;
2933                 throw new restore_step_exception('error_question_hint_missing_in_db', $info);
2934             }
2935         }
2936         // Create mapping (I'm not sure if this is really needed?)
2937         $this->set_mapping('question_hint', $oldid, $newitemid);
2938     }
2940     protected function after_execute() {
2941         global $DB;
2943         // First of all, recode all the created question_categories->parent fields
2944         $qcats = $DB->get_records('backup_ids_temp', array(
2945                      'backupid' => $this->get_restoreid(),
2946                      'itemname' => 'question_category_created'));
2947         foreach ($qcats as $qcat) {
2948             $newparent = 0;
2949             $dbcat = $DB->get_record('question_categories', array('id' => $qcat->newitemid));
2950             // Get new parent (mapped or created, so we look in quesiton_category mappings)
2951             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
2952                                  'backupid' => $this->get_restoreid(),
2953                                  'itemname' => 'question_category',
2954                                  'itemid'   => $dbcat->parent))) {
2955                 // contextids must match always, as far as we always include complete qbanks, just check it
2956                 $newparentctxid = $DB->get_field('question_categories', 'contextid', array('id' => $newparent));
2957                 if ($dbcat->contextid == $newparentctxid) {
2958                     $DB->set_field('question_categories', 'parent', $newparent, array('id' => $dbcat->id));
2959                 } else {
2960                     $newparent = 0; // No ctx match for both cats, no parent relationship
2961                 }
2962             }
2963             // Here with $newparent empty, problem with contexts or remapping, set it to top cat
2964             if (!$newparent) {
2965                 $DB->set_field('question_categories', 'parent', 0, array('id' => $dbcat->id));
2966             }
2967         }
2969         // Now, recode all the created question->parent fields
2970         $qs = $DB->get_records('backup_ids_temp', array(
2971                   'backupid' => $this->get_restoreid(),
2972                   'itemname' => 'question_created'));
2973         foreach ($qs as $q) {
2974             $newparent = 0;
2975             $dbq = $DB->get_record('question', array('id' => $q->newitemid));
2976             // Get new parent (mapped or created, so we look in question mappings)
2977             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
2978                                  'backupid' => $this->get_restoreid(),
2979                                  'itemname' => 'question',
2980                                  'itemid'   => $dbq->parent))) {
2981                 $DB->set_field('question', 'parent', $newparent, array('id' => $dbq->id));
2982             }
2983         }
2985         // Note, we don't restore any question files yet
2986         // as far as the CONTEXT_MODULE categories still
2987         // haven't their contexts to be restored to
2988         // The {@link restore_create_question_files}, executed in the final step
2989         // step will be in charge of restoring all the question files
2990     }
2993 /**
2994  * Execution step that will move all the CONTEXT_MODULE question categories
2995  * created at early stages of restore in course context (because modules weren't
2996  * created yet) to their target module (matching by old-new-contextid mapping)
2997  */
2998 class restore_move_module_questions_categories extends restore_execution_step {
3000     protected function define_execution() {
3001         global $DB;
3003         $contexts = restore_dbops::restore_get_question_banks($this->get_restoreid(), CONTEXT_MODULE);
3004         foreach ($contexts as $contextid => $contextlevel) {
3005             // Only if context mapping exists (i.e. the module has been restored)
3006             if ($newcontext = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $contextid)) {
3007                 // Update all the qcats having their parentitemid set to the original contextid
3008                 $modulecats = $DB->get_records_sql("SELECT itemid, newitemid
3009                                                       FROM {backup_ids_temp}
3010                                                      WHERE backupid = ?
3011                                                        AND itemname = 'question_category'
3012                                                        AND parentitemid = ?", array($this->get_restoreid(), $contextid));
3013                 foreach ($modulecats as $modulecat) {
3014                     $DB->set_field('question_categories', 'contextid', $newcontext->newitemid, array('id' => $modulecat->newitemid));
3015                     // And set new contextid also in question_category mapping (will be
3016                     // used by {@link restore_create_question_files} later
3017                     restore_dbops::set_backup_ids_record($this->get_restoreid(), 'question_category', $modulecat->itemid, $modulecat->newitemid, $newcontext->newitemid);
3018                 }
3019             }
3020         }
3021     }
3024 /**
3025  * Execution step that will create all the question/answers/qtype-specific files for the restored
3026  * questions. It must be executed after {@link restore_move_module_questions_categories}
3027  * because only then each question is in its final category and only then the
3028  * context can be determined
3029  *
3030  * TODO: Improve this. Instead of looping over each question, it can be reduced to
3031  *       be done by contexts (this will save a huge ammount of queries)
3032  */
3033 class restore_create_question_files extends restore_execution_step {
3035     protected function define_execution() {
3036         global $DB;
3038         // Let's process only created questions
3039         $questionsrs = $DB->get_recordset_sql("SELECT bi.itemid, bi.newitemid, bi.parentitemid, q.qtype
3040                                                FROM {backup_ids_temp} bi
3041                                                JOIN {question} q ON q.id = bi.newitemid
3042                                               WHERE bi.backupid = ?
3043                                                 AND bi.itemname = 'question_created'", array($this->get_restoreid()));
3044         foreach ($questionsrs as $question) {
3045             // Get question_category mapping, it contains the target context for the question
3046             if (!$qcatmapping = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'question_category', $question->parentitemid)) {
3047                 // Something went really wrong, cannot find the question_category for the question
3048                 debugging('Error fetching target context for question', DEBUG_DEVELOPER);
3049                 continue;
3050             }
3051             // Calculate source and target contexts
3052             $oldctxid = $qcatmapping->info->contextid;
3053             $newctxid = $qcatmapping->parentitemid;
3055             // Add common question files (question and question_answer ones)
3056             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'questiontext',
3057                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3058             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'generalfeedback',
3059                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3060             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'answer',
3061                                               $oldctxid, $this->task->get_userid(), 'question_answer', null, $newctxid, true);
3062             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'answerfeedback',
3063                                               $oldctxid, $this->task->get_userid(), 'question_answer', null, $newctxid, true);
3064             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'hint',
3065                                               $oldctxid, $this->task->get_userid(), 'question_hint', null, $newctxid, true);
3066             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'correctfeedback',
3067                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3068             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'partiallycorrectfeedback',
3069                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3070             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'incorrectfeedback',
3071                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3072             // Add qtype dependent files
3073             $components = backup_qtype_plugin::get_components_and_fileareas($question->qtype);
3074             foreach ($components as $component => $fileareas) {
3075                 foreach ($fileareas as $filearea => $mapping) {
3076                     // Use itemid only if mapping is question_created
3077                     $itemid = ($mapping == 'question_created') ? $question->itemid : null;
3078                     restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), $component, $filearea,
3079                                                       $oldctxid, $this->task->get_userid(), $mapping, $itemid, $newctxid, true);
3080                 }
3081             }
3082         }
3083         $questionsrs->close();
3084     }
3087 /**
3088  * Abstract structure step, to be used by all the activities using core questions stuff
3089  * (like the quiz module), to support qtype plugins, states and sessions
3090  */
3091 abstract class restore_questions_activity_structure_step extends restore_activity_structure_step {
3092     /** @var array question_attempt->id to qtype. */
3093     protected $qtypes = array();
3094     /** @var array question_attempt->id to questionid. */
3095     protected $newquestionids = array();
3097     /**
3098      * Attach below $element (usually attempts) the needed restore_path_elements
3099      * to restore question_usages and all they contain.
3100      */
3101     protected function add_question_usages($element, &$paths) {
3102         // Check $element is restore_path_element
3103         if (! $element instanceof restore_path_element) {
3104             throw new restore_step_exception('element_must_be_restore_path_element', $element);
3105         }
3106         // Check $paths is one array
3107         if (!is_array($paths)) {
3108             throw new restore_step_exception('paths_must_be_array', $paths);
3109         }
3110         $paths[] = new restore_path_element('question_usage',
3111                 $element->get_path() . '/question_usage');
3112         $paths[] = new restore_path_element('question_attempt',
3113                 $element->get_path() . '/question_usage/question_attempts/question_attempt');
3114         $paths[] = new restore_path_element('question_attempt_step',
3115                 $element->get_path() . '/question_usage/question_attempts/question_attempt/steps/step',
3116                 true);
3117         $paths[] = new restore_path_element('question_attempt_step_data',
3118                 $element->get_path() . '/question_usage/question_attempts/question_attempt/steps/step/response/variable');
3119     }
3121     /**
3122      * Process question_usages
3123      */
3124     protected function process_question_usage($data) {
3125         global $DB;
3127         // Clear our caches.
3128         $this->qtypes = array();
3129         $this->newquestionids = array();
3131         $data = (object)$data;
3132         $oldid = $data->id;
3134         $oldcontextid = $this->get_task()->get_old_contextid();
3135         $data->contextid  = $this->get_mappingid('context', $this->task->get_old_contextid());
3137         // Everything ready, insert (no mapping needed)
3138         $newitemid = $DB->insert_record('question_usages', $data);
3140         $this->inform_new_usage_id($newitemid);
3142         $this->set_mapping('question_usage', $oldid, $newitemid, false);
3143     }
3145     /**
3146      * When process_question_usage creates the new usage, it calls this method
3147      * to let the activity link to the new usage. For example, the quiz uses
3148      * this method to set quiz_attempts.uniqueid to the new usage id.
3149      * @param integer $newusageid
3150      */
3151     abstract protected function inform_new_usage_id($newusageid);
3153     /**
3154      * Process question_attempts
3155      */
3156     protected function process_question_attempt($data) {
3157         global $DB;
3159         $data = (object)$data;
3160         $oldid = $data->id;
3161         $question = $this->get_mapping('question', $data->questionid);
3163         $data->questionusageid = $this->get_new_parentid('question_usage');
3164         $data->questionid      = $question->newitemid;
3165         $data->timemodified    = $this->apply_date_offset($data->timemodified);
3167         $newitemid = $DB->insert_record('question_attempts', $data);
3169         $this->set_mapping('question_attempt', $oldid, $newitemid);
3170         $this->qtypes[$newitemid] = $question->info->qtype;
3171         $this->newquestionids[$newitemid] = $data->questionid;
3172     }
3174     /**
3175      * Process question_attempt_steps
3176      */
3177     protected function process_question_attempt_step($data) {
3178         global $DB;
3180         $data = (object)$data;
3181         $oldid = $data->id;
3183         // Pull out the response data.
3184         $response = array();
3185         if (!empty($data->response['variable'])) {
3186             foreach ($data->response['variable'] as $variable) {
3187                 $response[$variable['name']] = $variable['value'];
3188             }
3189         }
3190         unset($data->response);
3192         $data->questionattemptid = $this->get_new_parentid('question_attempt');
3193         $data->timecreated = $this->apply_date_offset($data->timecreated);
3194         $data->userid      = $this->get_mappingid('user', $data->userid);
3196         // Everything ready, insert and create mapping (needed by question_sessions)
3197         $newitemid = $DB->insert_record('question_attempt_steps', $data);
3198         $this->set_mapping('question_attempt_step', $oldid, $newitemid, true);
3200         // Now process the response data.
3201         $response = $this->questions_recode_response_data(
3202                 $this->qtypes[$data->questionattemptid],
3203                 $this->newquestionids[$data->questionattemptid],
3204                 $data->sequencenumber, $response);
3205         foreach ($response as $name => $value) {
3206             $row = new stdClass();
3207             $row->attemptstepid = $newitemid;
3208             $row->name = $name;
3209             $row->value = $value;
3210             $DB->insert_record('question_attempt_step_data', $row, false);
3211         }
3212     }
3214     /**
3215      * Recode the respones data for a particular step of an attempt at at particular question.
3216      * @param string $qtype the question type.
3217      * @param int $newquestionid the question id.
3218      * @param int $sequencenumber the sequence number.
3219      * @param array $response the response data to recode.
3220      */
3221     public function questions_recode_response_data(
3222             $qtype, $newquestionid, $sequencenumber, array $response) {
3223         $qtyperestorer = $this->get_qtype_restorer($qtype);
3224         if ($qtyperestorer) {
3225             $response = $qtyperestorer->recode_response($newquestionid, $sequencenumber, $response);
3226         }
3227         return $response;
3228     }
3230     /**
3231      * Given a list of question->ids, separated by commas, returns the
3232      * recoded list, with all the restore question mappings applied.
3233      * Note: Used by quiz->questions and quiz_attempts->layout
3234      * Note: 0 = page break (unconverted)
3235      */
3236     protected function questions_recode_layout($layout) {
3237         // Extracts question id from sequence
3238         if ($questionids = explode(',', $layout)) {
3239             foreach ($questionids as $id => $questionid) {
3240                 if ($questionid) { // If it is zero then this is a pagebreak, don't translate
3241                     $newquestionid = $this->get_mappingid('question', $questionid);
3242                     $questionids[$id] = $newquestionid;
3243                 }
3244             }
3245         }
3246         return implode(',', $questionids);
3247     }
3249     /**
3250      * Get the restore_qtype_plugin subclass for a specific question type.
3251      * @param string $qtype e.g. multichoice.
3252      * @return restore_qtype_plugin instance.
3253      */
3254     protected function get_qtype_restorer($qtype) {
3255         // Build one static cache to store {@link restore_qtype_plugin}
3256         // while we are needing them, just to save zillions of instantiations
3257         // or using static stuff that will break our nice API
3258         static $qtypeplugins = array();
3260         if (!isset($qtypeplugins[$qtype])) {
3261             $classname = 'restore_qtype_' . $qtype . '_plugin';
3262             if (class_exists($classname)) {
3263                 $qtypeplugins[$qtype] = new $classname('qtype', $qtype, $this);
3264             } else {
3265                 $qtypeplugins[$qtype] = null;
3266             }
3267         }
3268         return $qtypeplugins[$qtype];
3269     }
3271     protected function after_execute() {
3272         parent::after_execute();
3274         // Restore any files belonging to responses.
3275         foreach (question_engine::get_all_response_file_areas() as $filearea) {
3276             $this->add_related_files('question', $filearea, 'question_attempt_step');
3277         }
3278     }
3280     /**
3281      * Attach below $element (usually attempts) the needed restore_path_elements
3282      * to restore question attempt data from Moodle 2.0.
3283      *
3284      * When using this method, the parent element ($element) must be defined with
3285      * $grouped = true. Then, in that elements process method, you must call
3286      * {@link process_legacy_attempt_data()} with the groupded data. See, for
3287      * example, the usage of this method in {@link restore_quiz_activity_structure_step}.
3288      * @param restore_path_element $element the parent element. (E.g. a quiz attempt.)
3289      * @param array $paths the paths array that is being built to describe the
3290      *      structure.
3291      */
3292     protected function add_legacy_question_attempt_data($element, &$paths) {
3293         global $CFG;
3294         require_once($CFG->dirroot . '/question/engine/upgrade/upgradelib.php');
3296         // Check $element is restore_path_element
3297         if (!($element instanceof restore_path_element)) {
3298             throw new restore_step_exception('element_must_be_restore_path_element', $element);
3299         }
3300         // Check $paths is one array
3301         if (!is_array($paths)) {
3302             throw new restore_step_exception('paths_must_be_array', $paths);
3303         }
3305         $paths[] = new restore_path_element('question_state',
3306                 $element->get_path() . '/states/state');
3307         $paths[] = new restore_path_element('question_session',
3308                 $element->get_path() . '/sessions/session');
3309     }
3311     protected function get_attempt_upgrader() {
3312         if (empty($this->attemptupgrader)) {
3313             $this->attemptupgrader = new question_engine_attempt_upgrader();
3314             $this->attemptupgrader->prepare_to_restore();
3315         }
3316         return $this->attemptupgrader;
3317     }
3319     /**
3320      * Process the attempt data defined by {@link add_legacy_question_attempt_data()}.
3321      * @param object $data contains all the grouped attempt data ot process.
3322      * @param pbject $quiz data about the activity the attempts belong to. Required
3323      * fields are (basically this only works for the quiz module):
3324      *      oldquestions => list of question ids in this activity - using old ids.
3325      *      preferredbehaviour => the behaviour to use for questionattempts.
3326      */
3327     protected function process_legacy_quiz_attempt_data($data, $quiz) {
3328         global $DB;
3329         $upgrader = $this->get_attempt_upgrader();
3331         $data = (object)$data;
3333         $layout = explode(',', $data->layout);
3334         $newlayout = $layout;
3336         // Convert each old question_session into a question_attempt.
3337         $qas = array();
3338         foreach (explode(',', $quiz->oldquestions) as $questionid) {
3339             if ($questionid == 0) {
3340                 continue;
3341             }
3343             $newquestionid = $this->get_mappingid('question', $questionid);
3344             if (!$newquestionid) {
3345                 throw new restore_step_exception('questionattemptreferstomissingquestion',
3346                         $questionid, $questionid);
3347             }
3349             $question = $upgrader->load_question($newquestionid, $quiz->id);
3351             foreach ($layout as $key => $qid) {
3352                 if ($qid == $questionid) {
3353                     $newlayout[$key] = $newquestionid;
3354                 }
3355             }
3357             list($qsession, $qstates) = $this->find_question_session_and_states(
3358                     $data, $questionid);
3360             if (empty($qsession) || empty($qstates)) {
3361                 throw new restore_step_exception('questionattemptdatamissing',
3362                         $questionid, $questionid);
3363             }
3365             list($qsession, $qstates) = $this->recode_legacy_response_data(
3366                     $question, $qsession, $qstates);
3368             $data->layout = implode(',', $newlayout);
3369             $qas[$newquestionid] = $upgrader->convert_question_attempt(
3370                     $quiz, $data, $question, $qsession, $qstates);
3371         }
3373         // Now create a new question_usage.
3374         $usage = new stdClass();
3375         $usage->component = 'mod_quiz';
3376         $usage->contextid = $this->get_mappingid('context', $this->task->get_old_contextid());
3377         $usage->preferredbehaviour = $quiz->preferredbehaviour;
3378         $usage->id = $DB->insert_record('question_usages', $usage);
3380         $this->inform_new_usage_id($usage->id);
3382         $data->uniqueid = $usage->id;
3383         $upgrader->save_usage($quiz->preferredbehaviour, $data, $qas, $quiz->questions);
3384     }
3386     protected function find_question_session_and_states($data, $questionid) {
3387         $qsession = null;
3388         foreach ($data->sessions['session'] as $session) {
3389             if ($session['questionid'] == $questionid) {
3390                 $qsession = (object) $session;
3391                 break;
3392             }
3393         }
3395         $qstates = array();
3396         foreach ($data->states['state'] as $state) {
3397             if ($state['question'] == $questionid) {
3398                 // It would be natural to use $state['seq_number'] as the array-key
3399                 // here, but it seems that buggy behaviour in 2.0 and early can
3400                 // mean that that is not unique, so we use id, which is guaranteed
3401                 // to be unique.
3402                 $qstates[$state['id']] = (object) $state;
3403             }
3404         }
3405         ksort($qstates);
3406         $qstates = array_values($qstates);
3408         return array($qsession, $qstates);
3409     }
3411     /**
3412      * Recode any ids in the response data
3413      * @param object $question the question data
3414      * @param object $qsession the question sessions.
3415      * @param array $qstates the question states.
3416      */
3417     protected function recode_legacy_response_data($question, $qsession, $qstates) {
3418         $qsession->questionid = $question->id;
3420         foreach ($qstates as &$state) {
3421             $state->question = $question->id;
3422             $state->answer = $this->restore_recode_legacy_answer($state, $question->qtype);
3423         }
3425         return array($qsession, $qstates);
3426     }
3428     /**
3429      * Recode the legacy answer field.
3430      * @param object $state the state to recode the answer of.
3431      * @param string $qtype the question type.
3432      */
3433     public function restore_recode_legacy_answer($state, $qtype) {
3434         $restorer = $this->get_qtype_restorer($qtype);
3435         if ($restorer) {
3436             return $restorer->recode_legacy_state_answer($state);
3437         } else {
3438             return $state->answer;
3439         }
3440     }