Merge branch 'wip-MDL-25928-m25' of git://github.com/samhemelryk/moodle
[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 = context_course::instance($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 = context_system::instance()->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         } else if ($data->itemtype == 'manual') {
194             // Manual items aren't assigned to a cm, so don't go duplicating them in the target if one exists.
195             $gi = array(
196                 'itemtype' => $data->itemtype,
197                 'courseid' => $data->courseid,
198                 'itemname' => $data->itemname,
199                 'categoryid' => $data->categoryid,
200             );
201             $newitemid = $DB->get_field('grade_items', 'id', $gi);
202         }
204         if (empty($newitemid)) {
205             //in case we found the course category but still need to insert the course grade item
206             if ($data->itemtype=='course' && !empty($coursecategory)) {
207                 $data->iteminstance = $coursecategory->id;
208             }
210             $newitemid = $DB->insert_record('grade_items', $data);
211         }
212         $this->set_mapping('grade_item', $oldid, $newitemid);
213     }
215     protected function process_grade_grade($data) {
216         global $DB;
218         $data = (object)$data;
219         $olduserid = $data->userid;
221         $data->itemid = $this->get_new_parentid('grade_item');
223         $data->userid = $this->get_mappingid('user', $data->userid, null);
224         if (!empty($data->userid)) {
225             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
226             $data->locktime     = $this->apply_date_offset($data->locktime);
227             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
228             $data->overridden = $this->apply_date_offset($data->overridden);
229             $data->timecreated  = $this->apply_date_offset($data->timecreated);
230             $data->timemodified = $this->apply_date_offset($data->timemodified);
232             $newitemid = $DB->insert_record('grade_grades', $data);
233         } else {
234             debugging("Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'");
235         }
236     }
238     protected function process_grade_category($data) {
239         global $DB;
241         $data = (object)$data;
242         $oldid = $data->id;
244         $data->course = $this->get_courseid();
245         $data->courseid = $data->course;
247         $data->timecreated  = $this->apply_date_offset($data->timecreated);
248         $data->timemodified = $this->apply_date_offset($data->timemodified);
250         $newitemid = null;
251         //no parent means a course level grade category. That may have been created when the course was created
252         if(empty($data->parent)) {
253             //parent was being saved as 0 when it should be null
254             $data->parent = null;
256             //get the already created course level grade category
257             $category = new stdclass();
258             $category->courseid = $this->get_courseid();
259             $category->parent = null;
261             $coursecategory = $DB->get_record('grade_categories', (array)$category);
262             if (!empty($coursecategory)) {
263                 $data->id = $newitemid = $coursecategory->id;
264                 $DB->update_record('grade_categories', $data);
265             }
266         }
268         //need to insert a course category
269         if (empty($newitemid)) {
270             $newitemid = $DB->insert_record('grade_categories', $data);
271         }
272         $this->set_mapping('grade_category', $oldid, $newitemid);
273     }
274     protected function process_grade_letter($data) {
275         global $DB;
277         $data = (object)$data;
278         $oldid = $data->id;
280         $data->contextid = context_course::instance($this->get_courseid())->id;
282         $gradeletter = (array)$data;
283         unset($gradeletter['id']);
284         if (!$DB->record_exists('grade_letters', $gradeletter)) {
285             $newitemid = $DB->insert_record('grade_letters', $data);
286         } else {
287             $newitemid = $data->id;
288         }
290         $this->set_mapping('grade_letter', $oldid, $newitemid);
291     }
292     protected function process_grade_setting($data) {
293         global $DB;
295         $data = (object)$data;
296         $oldid = $data->id;
298         $data->courseid = $this->get_courseid();
300         $newitemid = $DB->insert_record('grade_settings', $data);
301         //$this->set_mapping('grade_setting', $oldid, $newitemid);
302     }
304     /**
305      * put all activity grade items in the correct grade category and mark all for recalculation
306      */
307     protected function after_execute() {
308         global $DB;
310         $conditions = array(
311             'backupid' => $this->get_restoreid(),
312             'itemname' => 'grade_item'//,
313             //'itemid'   => $itemid
314         );
315         $rs = $DB->get_recordset('backup_ids_temp', $conditions);
317         // We need this for calculation magic later on.
318         $mappings = array();
320         if (!empty($rs)) {
321             foreach($rs as $grade_item_backup) {
323                 // Store the oldid with the new id.
324                 $mappings[$grade_item_backup->itemid] = $grade_item_backup->newitemid;
326                 $updateobj = new stdclass();
327                 $updateobj->id = $grade_item_backup->newitemid;
329                 //if this is an activity grade item that needs to be put back in its correct category
330                 if (!empty($grade_item_backup->parentitemid)) {
331                     $oldcategoryid = $this->get_mappingid('grade_category', $grade_item_backup->parentitemid, null);
332                     if (!is_null($oldcategoryid)) {
333                         $updateobj->categoryid = $oldcategoryid;
334                         $DB->update_record('grade_items', $updateobj);
335                     }
336                 } else {
337                     //mark course and category items as needing to be recalculated
338                     $updateobj->needsupdate=1;
339                     $DB->update_record('grade_items', $updateobj);
340                 }
341             }
342         }
343         $rs->close();
345         // We need to update the calculations for calculated grade items that may reference old
346         // grade item ids using ##gi\d+##.
347         // $mappings can be empty, use 0 if so (won't match ever)
348         list($sql, $params) = $DB->get_in_or_equal(array_values($mappings), SQL_PARAMS_NAMED, 'param', true, 0);
349         $sql = "SELECT gi.id, gi.calculation
350                   FROM {grade_items} gi
351                  WHERE gi.id {$sql} AND
352                        calculation IS NOT NULL";
353         $rs = $DB->get_recordset_sql($sql, $params);
354         foreach ($rs as $gradeitem) {
355             // Collect all of the used grade item id references
356             if (preg_match_all('/##gi(\d+)##/', $gradeitem->calculation, $matches) < 1) {
357                 // This calculation doesn't reference any other grade items... EASY!
358                 continue;
359             }
360             // For this next bit we are going to do the replacement of id's in two steps:
361             // 1. We will replace all old id references with a special mapping reference.
362             // 2. We will replace all mapping references with id's
363             // Why do we do this?
364             // Because there potentially there will be an overlap of ids within the query and we
365             // we substitute the wrong id.. safest way around this is the two step system
366             $calculationmap = array();
367             $mapcount = 0;
368             foreach ($matches[1] as $match) {
369                 // Check that the old id is known to us, if not it was broken to begin with and will
370                 // continue to be broken.
371                 if (!array_key_exists($match, $mappings)) {
372                     continue;
373                 }
374                 // Our special mapping key
375                 $mapping = '##MAPPING'.$mapcount.'##';
376                 // The old id that exists within the calculation now
377                 $oldid = '##gi'.$match.'##';
378                 // The new id that we want to replace the old one with.
379                 $newid = '##gi'.$mappings[$match].'##';
380                 // Replace in the special mapping key
381                 $gradeitem->calculation = str_replace($oldid, $mapping, $gradeitem->calculation);
382                 // And record the mapping
383                 $calculationmap[$mapping] = $newid;
384                 $mapcount++;
385             }
386             // Iterate all special mappings for this calculation and replace in the new id's
387             foreach ($calculationmap as $mapping => $newid) {
388                 $gradeitem->calculation = str_replace($mapping, $newid, $gradeitem->calculation);
389             }
390             // Update the calculation now that its being remapped
391             $DB->update_record('grade_items', $gradeitem);
392         }
393         $rs->close();
395         // Need to correct the grade category path and parent
396         $conditions = array(
397             'courseid' => $this->get_courseid()
398         );
400         $rs = $DB->get_recordset('grade_categories', $conditions);
401         // Get all the parents correct first as grade_category::build_path() loads category parents from the DB
402         foreach ($rs as $gc) {
403             if (!empty($gc->parent)) {
404                 $grade_category = new stdClass();
405                 $grade_category->id = $gc->id;
406                 $grade_category->parent = $this->get_mappingid('grade_category', $gc->parent);
407                 $DB->update_record('grade_categories', $grade_category);
408             }
409         }
410         $rs->close();
412         // Now we can rebuild all the paths
413         $rs = $DB->get_recordset('grade_categories', $conditions);
414         foreach ($rs as $gc) {
415             $grade_category = new stdClass();
416             $grade_category->id = $gc->id;
417             $grade_category->path = grade_category::build_path($gc);
418             $grade_category->depth = substr_count($grade_category->path, '/') - 1;
419             $DB->update_record('grade_categories', $grade_category);
420         }
421         $rs->close();
423         // Restore marks items as needing update. Update everything now.
424         grade_regrade_final_grades($this->get_courseid());
425     }
428 /**
429  * decode all the interlinks present in restored content
430  * relying 100% in the restore_decode_processor that handles
431  * both the contents to modify and the rules to be applied
432  */
433 class restore_decode_interlinks extends restore_execution_step {
435     protected function define_execution() {
436         // Get the decoder (from the plan)
437         $decoder = $this->task->get_decoder();
438         restore_decode_processor::register_link_decoders($decoder); // Add decoder contents and rules
439         // And launch it, everything will be processed
440         $decoder->execute();
441     }
444 /**
445  * first, ensure that we have no gaps in section numbers
446  * and then, rebuid the course cache
447  */
448 class restore_rebuild_course_cache extends restore_execution_step {
450     protected function define_execution() {
451         global $DB;
453         // Although there is some sort of auto-recovery of missing sections
454         // present in course/formats... here we check that all the sections
455         // from 0 to MAX(section->section) exist, creating them if necessary
456         $maxsection = $DB->get_field('course_sections', 'MAX(section)', array('course' => $this->get_courseid()));
457         // Iterate over all sections
458         for ($i = 0; $i <= $maxsection; $i++) {
459             // If the section $i doesn't exist, create it
460             if (!$DB->record_exists('course_sections', array('course' => $this->get_courseid(), 'section' => $i))) {
461                 $sectionrec = array(
462                     'course' => $this->get_courseid(),
463                     'section' => $i);
464                 $DB->insert_record('course_sections', $sectionrec); // missing section created
465             }
466         }
468         // Rebuild cache now that all sections are in place
469         rebuild_course_cache($this->get_courseid());
470     }
473 /**
474  * Review all the tasks having one after_restore method
475  * executing it to perform some final adjustments of information
476  * not available when the task was executed.
477  */
478 class restore_execute_after_restore extends restore_execution_step {
480     protected function define_execution() {
482         // Simply call to the execute_after_restore() method of the task
483         // that always is the restore_final_task
484         $this->task->launch_execute_after_restore();
485     }
489 /**
490  * Review all the (pending) block positions in backup_ids, matching by
491  * contextid, creating positions as needed. This is executed by the
492  * final task, once all the contexts have been created
493  */
494 class restore_review_pending_block_positions extends restore_execution_step {
496     protected function define_execution() {
497         global $DB;
499         // Get all the block_position objects pending to match
500         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
501         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid');
502         // Process block positions, creating them or accumulating for final step
503         foreach($rs as $posrec) {
504             // Get the complete position object (stored as info)
505             $position = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'block_position', $posrec->itemid)->info;
506             // If position is for one already mapped (known) contextid
507             // process it now, creating the position, else nothing to
508             // do, position finally discarded
509             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
510                 $position->contextid = $newctx->newitemid;
511                 // Create the block position
512                 $DB->insert_record('block_positions', $position);
513             }
514         }
515         $rs->close();
516     }
519 /**
520  * Process all the saved module availability records in backup_ids, matching
521  * course modules and grade item id once all them have been already restored.
522  * only if all matchings are satisfied the availability condition will be created.
523  * At the same time, it is required for the site to have that functionality enabled.
524  */
525 class restore_process_course_modules_availability extends restore_execution_step {
527     protected function define_execution() {
528         global $CFG, $DB;
530         // Site hasn't availability enabled
531         if (empty($CFG->enableavailability)) {
532             return;
533         }
535         // Get all the module_availability objects to process
536         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'module_availability');
537         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid');
538         // Process availabilities, creating them if everything matches ok
539         foreach($rs as $availrec) {
540             $allmatchesok = true;
541             // Get the complete availabilityobject
542             $availability = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'module_availability', $availrec->itemid)->info;
543             // Map the sourcecmid if needed and possible
544             if (!empty($availability->sourcecmid)) {
545                 $newcm = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'course_module', $availability->sourcecmid);
546                 if ($newcm) {
547                     $availability->sourcecmid = $newcm->newitemid;
548                 } else {
549                     $allmatchesok = false; // Failed matching, we won't create this availability rule
550                 }
551             }
552             // Map the gradeitemid if needed and possible
553             if (!empty($availability->gradeitemid)) {
554                 $newgi = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'grade_item', $availability->gradeitemid);
555                 if ($newgi) {
556                     $availability->gradeitemid = $newgi->newitemid;
557                 } else {
558                     $allmatchesok = false; // Failed matching, we won't create this availability rule
559                 }
560             }
561             if ($allmatchesok) { // Everything ok, create the availability rule
562                 $DB->insert_record('course_modules_availability', $availability);
563             }
564         }
565         $rs->close();
566     }
570 /*
571  * Execution step that, *conditionally* (if there isn't preloaded information)
572  * will load the inforef files for all the included course/section/activity tasks
573  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
574  */
575 class restore_load_included_inforef_records extends restore_execution_step {
577     protected function define_execution() {
579         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
580             return;
581         }
583         // Get all the included tasks
584         $tasks = restore_dbops::get_included_tasks($this->get_restoreid());
585         foreach ($tasks as $task) {
586             // Load the inforef.xml file if exists
587             $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
588             if (file_exists($inforefpath)) {
589                 restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $inforefpath); // Load each inforef file to temp_ids
590             }
591         }
592     }
595 /*
596  * Execution step that will load all the needed files into backup_files_temp
597  *   - info: contains the whole original object (times, names...)
598  * (all them being original ids as loaded from xml)
599  */
600 class restore_load_included_files extends restore_structure_step {
602     protected function define_structure() {
604         $file = new restore_path_element('file', '/files/file');
606         return array($file);
607     }
609     /**
610      * Process one <file> element from files.xml
611      *
612      * @param array $data the element data
613      */
614     public function process_file($data) {
616         $data = (object)$data; // handy
618         // load it if needed:
619         //   - it it is one of the annotated inforef files (course/section/activity/block)
620         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
621         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
622         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
623         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
624         $iscomponent = ($data->component == 'user' || $data->component == 'group' ||
625                         $data->component == 'grouping' || $data->component == 'grade' ||
626                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
627         if ($isfileref || $iscomponent) {
628             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
629         }
630     }
633 /**
634  * Execution step that, *conditionally* (if there isn't preloaded information),
635  * will load all the needed roles to backup_temp_ids. They will be stored with
636  * "role" itemname. Also it will perform one automatic mapping to roles existing
637  * in the target site, based in permissions of the user performing the restore,
638  * archetypes and other bits. At the end, each original role will have its associated
639  * target role or 0 if it's going to be skipped. Note we wrap everything over one
640  * restore_dbops method, as far as the same stuff is going to be also executed
641  * by restore prechecks
642  */
643 class restore_load_and_map_roles extends restore_execution_step {
645     protected function define_execution() {
646         if ($this->task->get_preloaded_information()) { // if info is already preloaded
647             return;
648         }
650         $file = $this->get_basepath() . '/roles.xml';
651         // Load needed toles to temp_ids
652         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
654         // Process roles, mapping/skipping. Any error throws exception
655         // Note we pass controller's info because it can contain role mapping information
656         // about manual mappings performed by UI
657         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);
658     }
661 /**
662  * Execution step that, *conditionally* (if there isn't preloaded information
663  * and users have been selected in settings, will load all the needed users
664  * to backup_temp_ids. They will be stored with "user" itemname and with
665  * their original contextid as paremitemid
666  */
667 class restore_load_included_users extends restore_execution_step {
669     protected function define_execution() {
671         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
672             return;
673         }
674         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
675             return;
676         }
677         $file = $this->get_basepath() . '/users.xml';
678         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file); // Load needed users to temp_ids
679     }
682 /**
683  * Execution step that, *conditionally* (if there isn't preloaded information
684  * and users have been selected in settings, will process all the needed users
685  * in order to decide and perform any action with them (create / map / error)
686  * Note: Any error will cause exception, as far as this is the same processing
687  * than the one into restore prechecks (that should have stopped process earlier)
688  */
689 class restore_process_included_users extends restore_execution_step {
691     protected function define_execution() {
693         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
694             return;
695         }
696         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
697             return;
698         }
699         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
700     }
703 /**
704  * Execution step that will create all the needed users as calculated
705  * by @restore_process_included_users (those having newiteind = 0)
706  */
707 class restore_create_included_users extends restore_execution_step {
709     protected function define_execution() {
711         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(), $this->task->get_userid());
712     }
715 /**
716  * Structure step that will create all the needed groups and groupings
717  * by loading them from the groups.xml file performing the required matches.
718  * Note group members only will be added if restoring user info
719  */
720 class restore_groups_structure_step extends restore_structure_step {
722     protected function define_structure() {
724         $paths = array(); // Add paths here
726         $paths[] = new restore_path_element('group', '/groups/group');
727         $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
728         $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
730         return $paths;
731     }
733     // Processing functions go here
734     public function process_group($data) {
735         global $DB;
737         $data = (object)$data; // handy
738         $data->courseid = $this->get_courseid();
740         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
741         // another a group in the same course
742         $context = context_course::instance($data->courseid);
743         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
744             if (groups_get_group_by_idnumber($data->courseid, $data->idnumber)) {
745                 unset($data->idnumber);
746             }
747         } else {
748             unset($data->idnumber);
749         }
751         $oldid = $data->id;    // need this saved for later
753         $restorefiles = false; // Only if we end creating the group
755         // Search if the group already exists (by name & description) in the target course
756         $description_clause = '';
757         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
758         if (!empty($data->description)) {
759             $description_clause = ' AND ' .
760                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
761            $params['description'] = $data->description;
762         }
763         if (!$groupdb = $DB->get_record_sql("SELECT *
764                                                FROM {groups}
765                                               WHERE courseid = :courseid
766                                                 AND name = :grname $description_clause", $params)) {
767             // group doesn't exist, create
768             $newitemid = $DB->insert_record('groups', $data);
769             $restorefiles = true; // We'll restore the files
770         } else {
771             // group exists, use it
772             $newitemid = $groupdb->id;
773         }
774         // Save the id mapping
775         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
776     }
778     public function process_grouping($data) {
779         global $DB;
781         $data = (object)$data; // handy
782         $data->courseid = $this->get_courseid();
784         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
785         // another a grouping in the same course
786         $context = context_course::instance($data->courseid);
787         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
788             if (groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) {
789                 unset($data->idnumber);
790             }
791         } else {
792             unset($data->idnumber);
793         }
795         $oldid = $data->id;    // need this saved for later
796         $restorefiles = false; // Only if we end creating the grouping
798         // Search if the grouping already exists (by name & description) in the target course
799         $description_clause = '';
800         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
801         if (!empty($data->description)) {
802             $description_clause = ' AND ' .
803                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
804            $params['description'] = $data->description;
805         }
806         if (!$groupingdb = $DB->get_record_sql("SELECT *
807                                                   FROM {groupings}
808                                                  WHERE courseid = :courseid
809                                                    AND name = :grname $description_clause", $params)) {
810             // grouping doesn't exist, create
811             $newitemid = $DB->insert_record('groupings', $data);
812             $restorefiles = true; // We'll restore the files
813         } else {
814             // grouping exists, use it
815             $newitemid = $groupingdb->id;
816         }
817         // Save the id mapping
818         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
819     }
821     public function process_grouping_group($data) {
822         global $DB;
824         $data = (object)$data;
826         $data->groupingid = $this->get_new_parentid('grouping'); // Use new parentid
827         $data->groupid    = $this->get_mappingid('group', $data->groupid); // Get from mappings
829         $params = array();
830         $params['groupingid'] = $data->groupingid;
831         $params['groupid']    = $data->groupid;
833         if (!$DB->record_exists('groupings_groups', $params)) {
834             $DB->insert_record('groupings_groups', $data);  // No need to set this mapping (no child info nor files)
835         }
836     }
838     protected function after_execute() {
839         // Add group related files, matching with "group" mappings
840         $this->add_related_files('group', 'icon', 'group');
841         $this->add_related_files('group', 'description', 'group');
842         // Add grouping related files, matching with "grouping" mappings
843         $this->add_related_files('grouping', 'description', 'grouping');
844     }
848 /**
849  * Structure step that will create all the needed group memberships
850  * by loading them from the groups.xml file performing the required matches.
851  */
852 class restore_groups_members_structure_step extends restore_structure_step {
854     protected $plugins = null;
856     protected function define_structure() {
858         $paths = array(); // Add paths here
860         if ($this->get_setting_value('users')) {
861             $paths[] = new restore_path_element('group', '/groups/group');
862             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
863         }
865         return $paths;
866     }
868     public function process_group($data) {
869         $data = (object)$data; // handy
871         // HACK ALERT!
872         // Not much to do here, this groups mapping should be already done from restore_groups_structure_step.
873         // Let's fake internal state to make $this->get_new_parentid('group') work.
875         $this->set_mapping('group', $data->id, $this->get_mappingid('group', $data->id));
876     }
878     public function process_member($data) {
879         global $DB, $CFG;
880         require_once("$CFG->dirroot/group/lib.php");
882         // NOTE: Always use groups_add_member() because it triggers events and verifies if user is enrolled.
884         $data = (object)$data; // handy
886         // get parent group->id
887         $data->groupid = $this->get_new_parentid('group');
889         // map user newitemid and insert if not member already
890         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
891             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
892                 // Check the component, if any, exists.
893                 if (empty($data->component)) {
894                     groups_add_member($data->groupid, $data->userid);
896                 } else if ((strpos($data->component, 'enrol_') === 0)) {
897                     // Deal with enrolment groups - ignore the component and just find out the instance via new id,
898                     // it is possible that enrolment was restored using different plugin type.
899                     if (!isset($this->plugins)) {
900                         $this->plugins = enrol_get_plugins(true);
901                     }
902                     if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
903                         if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
904                             if (isset($this->plugins[$instance->enrol])) {
905                                 $this->plugins[$instance->enrol]->restore_group_member($instance, $data->groupid, $data->userid);
906                             }
907                         }
908                     }
910                 } else {
911                     $dir = get_component_directory($data->component);
912                     if ($dir and is_dir($dir)) {
913                         if (component_callback($data->component, 'restore_group_member', array($this, $data), true)) {
914                             return;
915                         }
916                     }
917                     // Bad luck, plugin could not restore the data, let's add normal membership.
918                     groups_add_member($data->groupid, $data->userid);
919                     $message = "Restore of '$data->component/$data->itemid' group membership is not supported, using standard group membership instead.";
920                     debugging($message);
921                     $this->log($message, backup::LOG_WARNING);
922                 }
923             }
924         }
925     }
928 /**
929  * Structure step that will create all the needed scales
930  * by loading them from the scales.xml
931  */
932 class restore_scales_structure_step extends restore_structure_step {
934     protected function define_structure() {
936         $paths = array(); // Add paths here
937         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
938         return $paths;
939     }
941     protected function process_scale($data) {
942         global $DB;
944         $data = (object)$data;
946         $restorefiles = false; // Only if we end creating the group
948         $oldid = $data->id;    // need this saved for later
950         // Look for scale (by 'scale' both in standard (course=0) and current course
951         // with priority to standard scales (ORDER clause)
952         // scale is not course unique, use get_record_sql to suppress warning
953         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
954         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
955         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
956         if (!$scadb = $DB->get_record_sql("SELECT *
957                                             FROM {scale}
958                                            WHERE courseid IN (0, :courseid)
959                                              AND $compare_scale_clause
960                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
961             // Remap the user if possible, defaut to user performing the restore if not
962             $userid = $this->get_mappingid('user', $data->userid);
963             $data->userid = $userid ? $userid : $this->task->get_userid();
964             // Remap the course if course scale
965             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
966             // If global scale (course=0), check the user has perms to create it
967             // falling to course scale if not
968             $systemctx = context_system::instance();
969             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
970                 $data->courseid = $this->get_courseid();
971             }
972             // scale doesn't exist, create
973             $newitemid = $DB->insert_record('scale', $data);
974             $restorefiles = true; // We'll restore the files
975         } else {
976             // scale exists, use it
977             $newitemid = $scadb->id;
978         }
979         // Save the id mapping (with files support at system context)
980         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
981     }
983     protected function after_execute() {
984         // Add scales related files, matching with "scale" mappings
985         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
986     }
990 /**
991  * Structure step that will create all the needed outocomes
992  * by loading them from the outcomes.xml
993  */
994 class restore_outcomes_structure_step extends restore_structure_step {
996     protected function define_structure() {
998         $paths = array(); // Add paths here
999         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
1000         return $paths;
1001     }
1003     protected function process_outcome($data) {
1004         global $DB;
1006         $data = (object)$data;
1008         $restorefiles = false; // Only if we end creating the group
1010         $oldid = $data->id;    // need this saved for later
1012         // Look for outcome (by shortname both in standard (courseid=null) and current course
1013         // with priority to standard outcomes (ORDER clause)
1014         // outcome is not course unique, use get_record_sql to suppress warning
1015         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
1016         if (!$outdb = $DB->get_record_sql('SELECT *
1017                                              FROM {grade_outcomes}
1018                                             WHERE shortname = :shortname
1019                                               AND (courseid = :courseid OR courseid IS NULL)
1020                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
1021             // Remap the user
1022             $userid = $this->get_mappingid('user', $data->usermodified);
1023             $data->usermodified = $userid ? $userid : $this->task->get_userid();
1024             // Remap the scale
1025             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
1026             // Remap the course if course outcome
1027             $data->courseid = $data->courseid ? $this->get_courseid() : null;
1028             // If global outcome (course=null), check the user has perms to create it
1029             // falling to course outcome if not
1030             $systemctx = context_system::instance();
1031             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
1032                 $data->courseid = $this->get_courseid();
1033             }
1034             // outcome doesn't exist, create
1035             $newitemid = $DB->insert_record('grade_outcomes', $data);
1036             $restorefiles = true; // We'll restore the files
1037         } else {
1038             // scale exists, use it
1039             $newitemid = $outdb->id;
1040         }
1041         // Set the corresponding grade_outcomes_courses record
1042         $outcourserec = new stdclass();
1043         $outcourserec->courseid  = $this->get_courseid();
1044         $outcourserec->outcomeid = $newitemid;
1045         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
1046             $DB->insert_record('grade_outcomes_courses', $outcourserec);
1047         }
1048         // Save the id mapping (with files support at system context)
1049         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1050     }
1052     protected function after_execute() {
1053         // Add outcomes related files, matching with "outcome" mappings
1054         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
1055     }
1058 /**
1059  * Execution step that, *conditionally* (if there isn't preloaded information
1060  * will load all the question categories and questions (header info only)
1061  * to backup_temp_ids. They will be stored with "question_category" and
1062  * "question" itemnames and with their original contextid and question category
1063  * id as paremitemids
1064  */
1065 class restore_load_categories_and_questions extends restore_execution_step {
1067     protected function define_execution() {
1069         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1070             return;
1071         }
1072         $file = $this->get_basepath() . '/questions.xml';
1073         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
1074     }
1077 /**
1078  * Execution step that, *conditionally* (if there isn't preloaded information)
1079  * will process all the needed categories and questions
1080  * in order to decide and perform any action with them (create / map / error)
1081  * Note: Any error will cause exception, as far as this is the same processing
1082  * than the one into restore prechecks (that should have stopped process earlier)
1083  */
1084 class restore_process_categories_and_questions extends restore_execution_step {
1086     protected function define_execution() {
1088         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1089             return;
1090         }
1091         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
1092     }
1095 /**
1096  * Structure step that will read the section.xml creating/updating sections
1097  * as needed, rebuilding course cache and other friends
1098  */
1099 class restore_section_structure_step extends restore_structure_step {
1101     protected function define_structure() {
1102         global $CFG;
1104         $paths = array();
1106         $section = new restore_path_element('section', '/section');
1107         $paths[] = $section;
1108         if ($CFG->enableavailability) {
1109             $paths[] = new restore_path_element('availability', '/section/availability');
1110             $paths[] = new restore_path_element('availability_field', '/section/availability_field');
1111         }
1112         $paths[] = new restore_path_element('course_format_options', '/section/course_format_options');
1114         // Apply for 'format' plugins optional paths at section level
1115         $this->add_plugin_structure('format', $section);
1117         // Apply for 'local' plugins optional paths at section level
1118         $this->add_plugin_structure('local', $section);
1120         return $paths;
1121     }
1123     public function process_section($data) {
1124         global $CFG, $DB;
1125         $data = (object)$data;
1126         $oldid = $data->id; // We'll need this later
1128         $restorefiles = false;
1130         // Look for the section
1131         $section = new stdclass();
1132         $section->course  = $this->get_courseid();
1133         $section->section = $data->number;
1134         // Section doesn't exist, create it with all the info from backup
1135         if (!$secrec = $DB->get_record('course_sections', (array)$section)) {
1136             $section->name = $data->name;
1137             $section->summary = $data->summary;
1138             $section->summaryformat = $data->summaryformat;
1139             $section->sequence = '';
1140             $section->visible = $data->visible;
1141             if (empty($CFG->enableavailability)) { // Process availability information only if enabled.
1142                 $section->availablefrom = 0;
1143                 $section->availableuntil = 0;
1144                 $section->showavailability = 0;
1145             } else {
1146                 $section->availablefrom = isset($data->availablefrom) ? $this->apply_date_offset($data->availablefrom) : 0;
1147                 $section->availableuntil = isset($data->availableuntil) ? $this->apply_date_offset($data->availableuntil) : 0;
1148                 $section->showavailability = isset($data->showavailability) ? $data->showavailability : 0;
1149             }
1150             if (!empty($CFG->enablegroupmembersonly)) { // Only if enablegroupmembersonly is enabled
1151                 $section->groupingid = isset($data->groupingid) ? $this->get_mappingid('grouping', $data->groupingid) : 0;
1152             }
1153             $newitemid = $DB->insert_record('course_sections', $section);
1154             $restorefiles = true;
1156         // Section exists, update non-empty information
1157         } else {
1158             $section->id = $secrec->id;
1159             if ((string)$secrec->name === '') {
1160                 $section->name = $data->name;
1161             }
1162             if (empty($secrec->summary)) {
1163                 $section->summary = $data->summary;
1164                 $section->summaryformat = $data->summaryformat;
1165                 $restorefiles = true;
1166             }
1167             if (empty($secrec->groupingid)) {
1168                 if (!empty($CFG->enablegroupmembersonly)) { // Only if enablegroupmembersonly is enabled
1169                     $section->groupingid = isset($data->groupingid) ? $this->get_mappingid('grouping', $data->groupingid) : 0;
1170                 }
1171             }
1173             // Don't update available from, available until, or show availability
1174             // (I didn't see a useful way to define whether existing or new one should
1175             // take precedence).
1177             $DB->update_record('course_sections', $section);
1178             $newitemid = $secrec->id;
1179         }
1181         // Annotate the section mapping, with restorefiles option if needed
1182         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
1184         // set the new course_section id in the task
1185         $this->task->set_sectionid($newitemid);
1188         // Commented out. We never modify course->numsections as far as that is used
1189         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
1190         // Note: We keep the code here, to know about and because of the possibility of making this
1191         // optional based on some setting/attribute in the future
1192         // If needed, adjust course->numsections
1193         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
1194         //    if ($numsections < $section->section) {
1195         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
1196         //    }
1197         //}
1198     }
1200     public function process_availability($data) {
1201         global $DB;
1202         $data = (object)$data;
1204         $data->coursesectionid = $this->task->get_sectionid();
1206         // NOTE: Other values in $data need updating, but these (cm,
1207         // grade items) have not yet been restored, so are done later.
1209         $newid = $DB->insert_record('course_sections_availability', $data);
1211         // We do not need to map between old and new id but storing a mapping
1212         // means it gets added to the backup_ids table to record which ones
1213         // need updating. The mapping is stored with $newid => $newid for
1214         // convenience.
1215         $this->set_mapping('course_sections_availability', $newid, $newid);
1216     }
1218     public function process_availability_field($data) {
1219         global $DB;
1220         $data = (object)$data;
1221         // Mark it is as passed by default
1222         $passed = true;
1223         $customfieldid = null;
1225         // If a customfield has been used in order to pass we must be able to match an existing
1226         // customfield by name (data->customfield) and type (data->customfieldtype)
1227         if (is_null($data->customfield) xor is_null($data->customfieldtype)) {
1228             // xor is sort of uncommon. If either customfield is null or customfieldtype is null BUT not both.
1229             // If one is null but the other isn't something clearly went wrong and we'll skip this condition.
1230             $passed = false;
1231         } else if (!is_null($data->customfield)) {
1232             $params = array('shortname' => $data->customfield, 'datatype' => $data->customfieldtype);
1233             $customfieldid = $DB->get_field('user_info_field', 'id', $params);
1234             $passed = ($customfieldid !== false);
1235         }
1237         if ($passed) {
1238             // Create the object to insert into the database
1239             $availfield = new stdClass();
1240             $availfield->coursesectionid = $this->task->get_sectionid();
1241             $availfield->userfield = $data->userfield;
1242             $availfield->customfieldid = $customfieldid;
1243             $availfield->operator = $data->operator;
1244             $availfield->value = $data->value;
1245             $DB->insert_record('course_sections_avail_fields', $availfield);
1246         }
1247     }
1249     public function process_course_format_options($data) {
1250         global $DB;
1251         $data = (object)$data;
1252         $oldid = $data->id;
1253         unset($data->id);
1254         $data->sectionid = $this->task->get_sectionid();
1255         $data->courseid = $this->get_courseid();
1256         $newid = $DB->insert_record('course_format_options', $data);
1257         $this->set_mapping('course_format_options', $oldid, $newid);
1258     }
1260     protected function after_execute() {
1261         // Add section related files, with 'course_section' itemid to match
1262         $this->add_related_files('course', 'section', 'course_section');
1263     }
1265     public function after_restore() {
1266         global $DB;
1268         $sectionid = $this->get_task()->get_sectionid();
1270         // Get data object for current section availability (if any).
1271         $records = $DB->get_records('course_sections_availability',
1272                 array('coursesectionid' => $sectionid), 'id, sourcecmid, gradeitemid');
1274         // If it exists, update mappings.
1275         foreach ($records as $data) {
1276             // Only update mappings for entries which are created by this restore.
1277             // Otherwise, when you restore to an existing course, it will mess up
1278             // existing section availability entries.
1279             if (!$this->get_mappingid('course_sections_availability', $data->id, false)) {
1280                 return;
1281             }
1283             // Update source cmid / grade id to new value.
1284             $data->sourcecmid = $this->get_mappingid('course_module', $data->sourcecmid);
1285             if (!$data->sourcecmid) {
1286                 $data->sourcecmid = null;
1287             }
1288             $data->gradeitemid = $this->get_mappingid('grade_item', $data->gradeitemid);
1289             if (!$data->gradeitemid) {
1290                 $data->gradeitemid = null;
1291             }
1293             $DB->update_record('course_sections_availability', $data);
1294         }
1295     }
1299 /**
1300  * Structure step that will read the course.xml file, loading it and performing
1301  * various actions depending of the site/restore settings. Note that target
1302  * course always exist before arriving here so this step will be updating
1303  * the course record (never inserting)
1304  */
1305 class restore_course_structure_step extends restore_structure_step {
1306     /**
1307      * @var bool this gets set to true by {@link process_course()} if we are
1308      * restoring an old coures that used the legacy 'module security' feature.
1309      * If so, we have to do more work in {@link after_execute()}.
1310      */
1311     protected $legacyrestrictmodules = false;
1313     /**
1314      * @var array Used when {@link $legacyrestrictmodules} is true. This is an
1315      * array with array keys the module names ('forum', 'quiz', etc.). These are
1316      * the modules that are allowed according to the data in the backup file.
1317      * In {@link after_execute()} we then have to prevent adding of all the other
1318      * types of activity.
1319      */
1320     protected $legacyallowedmodules = array();
1322     protected function define_structure() {
1324         $course = new restore_path_element('course', '/course');
1325         $category = new restore_path_element('category', '/course/category');
1326         $tag = new restore_path_element('tag', '/course/tags/tag');
1327         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1329         // Apply for 'format' plugins optional paths at course level
1330         $this->add_plugin_structure('format', $course);
1332         // Apply for 'theme' plugins optional paths at course level
1333         $this->add_plugin_structure('theme', $course);
1335         // Apply for 'report' plugins optional paths at course level
1336         $this->add_plugin_structure('report', $course);
1338         // Apply for 'course report' plugins optional paths at course level
1339         $this->add_plugin_structure('coursereport', $course);
1341         // Apply for plagiarism plugins optional paths at course level
1342         $this->add_plugin_structure('plagiarism', $course);
1344         // Apply for local plugins optional paths at course level
1345         $this->add_plugin_structure('local', $course);
1347         return array($course, $category, $tag, $allowed_module);
1348     }
1350     /**
1351      * Processing functions go here
1352      *
1353      * @global moodledatabase $DB
1354      * @param stdClass $data
1355      */
1356     public function process_course($data) {
1357         global $CFG, $DB;
1359         $data = (object)$data;
1361         $fullname  = $this->get_setting_value('course_fullname');
1362         $shortname = $this->get_setting_value('course_shortname');
1363         $startdate = $this->get_setting_value('course_startdate');
1365         // Calculate final course names, to avoid dupes
1366         list($fullname, $shortname) = restore_dbops::calculate_course_names($this->get_courseid(), $fullname, $shortname);
1368         // Need to change some fields before updating the course record
1369         $data->id = $this->get_courseid();
1370         $data->fullname = $fullname;
1371         $data->shortname= $shortname;
1373         $context = context::instance_by_id($this->task->get_contextid());
1374         if (has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1375             $data->idnumber = '';
1376         } else {
1377             unset($data->idnumber);
1378         }
1380         // Any empty value for course->hiddensections will lead to 0 (default, show collapsed).
1381         // It has been reported that some old 1.9 courses may have it null leading to DB error. MDL-31532
1382         if (empty($data->hiddensections)) {
1383             $data->hiddensections = 0;
1384         }
1386         // Set legacyrestrictmodules to true if the course was resticting modules. If so
1387         // then we will need to process restricted modules after execution.
1388         $this->legacyrestrictmodules = !empty($data->restrictmodules);
1390         $data->startdate= $this->apply_date_offset($data->startdate);
1391         if ($data->defaultgroupingid) {
1392             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1393         }
1394         if (empty($CFG->enablecompletion)) {
1395             $data->enablecompletion = 0;
1396             $data->completionstartonenrol = 0;
1397             $data->completionnotify = 0;
1398         }
1399         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1400         if (!array_key_exists($data->lang, $languages)) {
1401             $data->lang = '';
1402         }
1404         $themes = get_list_of_themes(); // Get themes for quick search later
1405         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1406             $data->theme = '';
1407         }
1409         // Course record ready, update it
1410         $DB->update_record('course', $data);
1412         course_get_format($data)->update_course_format_options($data);
1414         // Role name aliases
1415         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1416     }
1418     public function process_category($data) {
1419         // Nothing to do with the category. UI sets it before restore starts
1420     }
1422     public function process_tag($data) {
1423         global $CFG, $DB;
1425         $data = (object)$data;
1427         if (!empty($CFG->usetags)) { // if enabled in server
1428             // TODO: This is highly inneficient. Each time we add one tag
1429             // we fetch all the existing because tag_set() deletes them
1430             // so everything must be reinserted on each call
1431             $tags = array();
1432             $existingtags = tag_get_tags('course', $this->get_courseid());
1433             // Re-add all the existitng tags
1434             foreach ($existingtags as $existingtag) {
1435                 $tags[] = $existingtag->rawname;
1436             }
1437             // Add the one being restored
1438             $tags[] = $data->rawname;
1439             // Send all the tags back to the course
1440             tag_set('course', $this->get_courseid(), $tags);
1441         }
1442     }
1444     public function process_allowed_module($data) {
1445         $data = (object)$data;
1447         // Backwards compatiblity support for the data that used to be in the
1448         // course_allowed_modules table.
1449         if ($this->legacyrestrictmodules) {
1450             $this->legacyallowedmodules[$data->modulename] = 1;
1451         }
1452     }
1454     protected function after_execute() {
1455         global $DB;
1457         // Add course related files, without itemid to match
1458         $this->add_related_files('course', 'summary', null);
1459         $this->add_related_files('course', 'legacy', null);
1461         // Deal with legacy allowed modules.
1462         if ($this->legacyrestrictmodules) {
1463             $context = context_course::instance($this->get_courseid());
1465             list($roleids) = get_roles_with_cap_in_context($context, 'moodle/course:manageactivities');
1466             list($managerroleids) = get_roles_with_cap_in_context($context, 'moodle/site:config');
1467             foreach ($managerroleids as $roleid) {
1468                 unset($roleids[$roleid]);
1469             }
1471             foreach (get_plugin_list('mod') as $modname => $notused) {
1472                 if (isset($this->legacyallowedmodules[$modname])) {
1473                     // Module is allowed, no worries.
1474                     continue;
1475                 }
1477                 $capability = 'mod/' . $modname . ':addinstance';
1478                 foreach ($roleids as $roleid) {
1479                     assign_capability($capability, CAP_PREVENT, $roleid, $context);
1480                 }
1481             }
1482         }
1483     }
1487 /*
1488  * Structure step that will read the roles.xml file (at course/activity/block levels)
1489  * containing all the role_assignments and overrides for that context. If corresponding to
1490  * one mapped role, they will be applied to target context. Will observe the role_assignments
1491  * setting to decide if ras are restored.
1492  *
1493  * Note: this needs to be executed after all users are enrolled.
1494  */
1495 class restore_ras_and_caps_structure_step extends restore_structure_step {
1496     protected $plugins = null;
1498     protected function define_structure() {
1500         $paths = array();
1502         // Observe the role_assignments setting
1503         if ($this->get_setting_value('role_assignments')) {
1504             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
1505         }
1506         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
1508         return $paths;
1509     }
1511     /**
1512      * Assign roles
1513      *
1514      * This has to be called after enrolments processing.
1515      *
1516      * @param mixed $data
1517      * @return void
1518      */
1519     public function process_assignment($data) {
1520         global $DB;
1522         $data = (object)$data;
1524         // Check roleid, userid are one of the mapped ones
1525         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
1526             return;
1527         }
1528         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
1529             return;
1530         }
1531         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
1532             // Only assign roles to not deleted users
1533             return;
1534         }
1535         if (!$contextid = $this->task->get_contextid()) {
1536             return;
1537         }
1539         if (empty($data->component)) {
1540             // assign standard manual roles
1541             // TODO: role_assign() needs one userid param to be able to specify our restore userid
1542             role_assign($newroleid, $newuserid, $contextid);
1544         } else if ((strpos($data->component, 'enrol_') === 0)) {
1545             // Deal with enrolment roles - ignore the component and just find out the instance via new id,
1546             // it is possible that enrolment was restored using different plugin type.
1547             if (!isset($this->plugins)) {
1548                 $this->plugins = enrol_get_plugins(true);
1549             }
1550             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1551                 if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1552                     if (isset($this->plugins[$instance->enrol])) {
1553                         $this->plugins[$instance->enrol]->restore_role_assignment($instance, $newroleid, $newuserid, $contextid);
1554                     }
1555                 }
1556             }
1558         } else {
1559             $data->roleid    = $newroleid;
1560             $data->userid    = $newuserid;
1561             $data->contextid = $contextid;
1562             $dir = get_component_directory($data->component);
1563             if ($dir and is_dir($dir)) {
1564                 if (component_callback($data->component, 'restore_role_assignment', array($this, $data), true)) {
1565                     return;
1566                 }
1567             }
1568             // Bad luck, plugin could not restore the data, let's add normal membership.
1569             role_assign($data->roleid, $data->userid, $data->contextid);
1570             $message = "Restore of '$data->component/$data->itemid' role assignments is not supported, using manual role assignments instead.";
1571             debugging($message);
1572             $this->log($message, backup::LOG_WARNING);
1573         }
1574     }
1576     public function process_override($data) {
1577         $data = (object)$data;
1579         // Check roleid is one of the mapped ones
1580         $newroleid = $this->get_mappingid('role', $data->roleid);
1581         // If newroleid and context are valid assign it via API (it handles dupes and so on)
1582         if ($newroleid && $this->task->get_contextid()) {
1583             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
1584             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
1585             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
1586         }
1587     }
1590 /**
1591  * This structure steps restores the enrol plugins and their underlying
1592  * enrolments, performing all the mappings and/or movements required
1593  */
1594 class restore_enrolments_structure_step extends restore_structure_step {
1595     protected $enrolsynced = false;
1596     protected $plugins = null;
1597     protected $originalstatus = array();
1599     /**
1600      * Conditionally decide if this step should be executed.
1601      *
1602      * This function checks the following parameter:
1603      *
1604      *   1. the course/enrolments.xml file exists
1605      *
1606      * @return bool true is safe to execute, false otherwise
1607      */
1608     protected function execute_condition() {
1610         // Check it is included in the backup
1611         $fullpath = $this->task->get_taskbasepath();
1612         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1613         if (!file_exists($fullpath)) {
1614             // Not found, can't restore enrolments info
1615             return false;
1616         }
1618         return true;
1619     }
1621     protected function define_structure() {
1623         $paths = array();
1625         $paths[] = new restore_path_element('enrol', '/enrolments/enrols/enrol');
1626         $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
1628         return $paths;
1629     }
1631     /**
1632      * Create enrolment instances.
1633      *
1634      * This has to be called after creation of roles
1635      * and before adding of role assignments.
1636      *
1637      * @param mixed $data
1638      * @return void
1639      */
1640     public function process_enrol($data) {
1641         global $DB;
1643         $data = (object)$data;
1644         $oldid = $data->id; // We'll need this later.
1645         unset($data->id);
1647         $this->originalstatus[$oldid] = $data->status;
1649         if (!$courserec = $DB->get_record('course', array('id' => $this->get_courseid()))) {
1650             $this->set_mapping('enrol', $oldid, 0);
1651             return;
1652         }
1654         if (!isset($this->plugins)) {
1655             $this->plugins = enrol_get_plugins(true);
1656         }
1658         if (!$this->enrolsynced) {
1659             // Make sure that all plugin may create instances and enrolments automatically
1660             // before the first instance restore - this is suitable especially for plugins
1661             // that synchronise data automatically using course->idnumber or by course categories.
1662             foreach ($this->plugins as $plugin) {
1663                 $plugin->restore_sync_course($courserec);
1664             }
1665             $this->enrolsynced = true;
1666         }
1668         // Map standard fields - plugin has to process custom fields manually.
1669         $data->roleid   = $this->get_mappingid('role', $data->roleid);
1670         $data->courseid = $courserec->id;
1672         if ($this->get_setting_value('enrol_migratetomanual')) {
1673             unset($data->sortorder); // Remove useless sortorder from <2.4 backups.
1674             if (!enrol_is_enabled('manual')) {
1675                 $this->set_mapping('enrol', $oldid, 0);
1676                 return;
1677             }
1678             if ($instances = $DB->get_records('enrol', array('courseid'=>$data->courseid, 'enrol'=>'manual'), 'id')) {
1679                 $instance = reset($instances);
1680                 $this->set_mapping('enrol', $oldid, $instance->id);
1681             } else {
1682                 if ($data->enrol === 'manual') {
1683                     $instanceid = $this->plugins['manual']->add_instance($courserec, (array)$data);
1684                 } else {
1685                     $instanceid = $this->plugins['manual']->add_default_instance($courserec);
1686                 }
1687                 $this->set_mapping('enrol', $oldid, $instanceid);
1688             }
1690         } else {
1691             if (!enrol_is_enabled($data->enrol) or !isset($this->plugins[$data->enrol])) {
1692                 $this->set_mapping('enrol', $oldid, 0);
1693                 $message = "Enrol plugin '$data->enrol' data can not be restored because it is not enabled, use migration to manual enrolments";
1694                 debugging($message);
1695                 $this->log($message, backup::LOG_WARNING);
1696                 return;
1697             }
1698             if ($task = $this->get_task() and $task->get_target() == backup::TARGET_NEW_COURSE) {
1699                 // Let's keep the sortorder in old backups.
1700             } else {
1701                 // Prevent problems with colliding sortorders in old backups,
1702                 // new 2.4 backups do not need sortorder because xml elements are ordered properly.
1703                 unset($data->sortorder);
1704             }
1705             // Note: plugin is responsible for setting up the mapping, it may also decide to migrate to different type.
1706             $this->plugins[$data->enrol]->restore_instance($this, $data, $courserec, $oldid);
1707         }
1708     }
1710     /**
1711      * Create user enrolments.
1712      *
1713      * This has to be called after creation of enrolment instances
1714      * and before adding of role assignments.
1715      *
1716      * Roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing afterwards.
1717      *
1718      * @param mixed $data
1719      * @return void
1720      */
1721     public function process_enrolment($data) {
1722         global $DB;
1724         if (!isset($this->plugins)) {
1725             $this->plugins = enrol_get_plugins(true);
1726         }
1728         $data = (object)$data;
1730         // Process only if parent instance have been mapped.
1731         if ($enrolid = $this->get_new_parentid('enrol')) {
1732             $oldinstancestatus = ENROL_INSTANCE_ENABLED;
1733             $oldenrolid = $this->get_old_parentid('enrol');
1734             if (isset($this->originalstatus[$oldenrolid])) {
1735                 $oldinstancestatus = $this->originalstatus[$oldenrolid];
1736             }
1737             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1738                 // And only if user is a mapped one.
1739                 if ($userid = $this->get_mappingid('user', $data->userid)) {
1740                     if (isset($this->plugins[$instance->enrol])) {
1741                         $this->plugins[$instance->enrol]->restore_user_enrolment($this, $data, $instance, $userid, $oldinstancestatus);
1742                     }
1743                 }
1744             }
1745         }
1746     }
1750 /**
1751  * Make sure the user restoring the course can actually access it.
1752  */
1753 class restore_fix_restorer_access_step extends restore_execution_step {
1754     protected function define_execution() {
1755         global $CFG, $DB;
1757         if (!$userid = $this->task->get_userid()) {
1758             return;
1759         }
1761         if (empty($CFG->restorernewroleid)) {
1762             // Bad luck, no fallback role for restorers specified
1763             return;
1764         }
1766         $courseid = $this->get_courseid();
1767         $context = context_course::instance($courseid);
1769         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1770             // Current user may access the course (admin, category manager or restored teacher enrolment usually)
1771             return;
1772         }
1774         // Try to add role only - we do not need enrolment if user has moodle/course:view or is already enrolled
1775         role_assign($CFG->restorernewroleid, $userid, $context);
1777         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1778             // Extra role is enough, yay!
1779             return;
1780         }
1782         // The last chance is to create manual enrol if it does not exist and and try to enrol the current user,
1783         // hopefully admin selected suitable $CFG->restorernewroleid ...
1784         if (!enrol_is_enabled('manual')) {
1785             return;
1786         }
1787         if (!$enrol = enrol_get_plugin('manual')) {
1788             return;
1789         }
1790         if (!$DB->record_exists('enrol', array('enrol'=>'manual', 'courseid'=>$courseid))) {
1791             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
1792             $fields = array('status'=>ENROL_INSTANCE_ENABLED, 'enrolperiod'=>$enrol->get_config('enrolperiod', 0), 'roleid'=>$enrol->get_config('roleid', 0));
1793             $enrol->add_instance($course, $fields);
1794         }
1796         enrol_try_internal_enrol($courseid, $userid);
1797     }
1801 /**
1802  * This structure steps restores the filters and their configs
1803  */
1804 class restore_filters_structure_step extends restore_structure_step {
1806     protected function define_structure() {
1808         $paths = array();
1810         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
1811         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
1813         return $paths;
1814     }
1816     public function process_active($data) {
1818         $data = (object)$data;
1820         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1821             return;
1822         }
1823         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
1824     }
1826     public function process_config($data) {
1828         $data = (object)$data;
1830         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1831             return;
1832         }
1833         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
1834     }
1838 /**
1839  * This structure steps restores the comments
1840  * Note: Cannot use the comments API because defaults to USER->id.
1841  * That should change allowing to pass $userid
1842  */
1843 class restore_comments_structure_step extends restore_structure_step {
1845     protected function define_structure() {
1847         $paths = array();
1849         $paths[] = new restore_path_element('comment', '/comments/comment');
1851         return $paths;
1852     }
1854     public function process_comment($data) {
1855         global $DB;
1857         $data = (object)$data;
1859         // First of all, if the comment has some itemid, ask to the task what to map
1860         $mapping = false;
1861         if ($data->itemid) {
1862             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
1863             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
1864         }
1865         // Only restore the comment if has no mapping OR we have found the matching mapping
1866         if (!$mapping || $data->itemid) {
1867             // Only if user mapping and context
1868             $data->userid = $this->get_mappingid('user', $data->userid);
1869             if ($data->userid && $this->task->get_contextid()) {
1870                 $data->contextid = $this->task->get_contextid();
1871                 // Only if there is another comment with same context/user/timecreated
1872                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
1873                 if (!$DB->record_exists('comments', $params)) {
1874                     $DB->insert_record('comments', $data);
1875                 }
1876             }
1877         }
1878     }
1881 /**
1882  * This structure steps restores the calendar events
1883  */
1884 class restore_calendarevents_structure_step extends restore_structure_step {
1886     protected function define_structure() {
1888         $paths = array();
1890         $paths[] = new restore_path_element('calendarevents', '/events/event');
1892         return $paths;
1893     }
1895     public function process_calendarevents($data) {
1896         global $DB, $SITE;
1898         $data = (object)$data;
1899         $oldid = $data->id;
1900         $restorefiles = true; // We'll restore the files
1901         // Find the userid and the groupid associated with the event. Return if not found.
1902         $data->userid = $this->get_mappingid('user', $data->userid);
1903         if ($data->userid === false) {
1904             return;
1905         }
1906         if (!empty($data->groupid)) {
1907             $data->groupid = $this->get_mappingid('group', $data->groupid);
1908             if ($data->groupid === false) {
1909                 return;
1910             }
1911         }
1912         // Handle events with empty eventtype //MDL-32827
1913         if(empty($data->eventtype)) {
1914             if ($data->courseid == $SITE->id) {                                // Site event
1915                 $data->eventtype = "site";
1916             } else if ($data->courseid != 0 && $data->groupid == 0 && ($data->modulename == 'assignment' || $data->modulename == 'assign')) {
1917                 // Course assingment event
1918                 $data->eventtype = "due";
1919             } else if ($data->courseid != 0 && $data->groupid == 0) {      // Course event
1920                 $data->eventtype = "course";
1921             } else if ($data->groupid) {                                      // Group event
1922                 $data->eventtype = "group";
1923             } else if ($data->userid) {                                       // User event
1924                 $data->eventtype = "user";
1925             } else {
1926                 return;
1927             }
1928         }
1930         $params = array(
1931                 'name'           => $data->name,
1932                 'description'    => $data->description,
1933                 'format'         => $data->format,
1934                 'courseid'       => $this->get_courseid(),
1935                 'groupid'        => $data->groupid,
1936                 'userid'         => $data->userid,
1937                 'repeatid'       => $data->repeatid,
1938                 'modulename'     => $data->modulename,
1939                 'eventtype'      => $data->eventtype,
1940                 'timestart'      => $this->apply_date_offset($data->timestart),
1941                 'timeduration'   => $data->timeduration,
1942                 'visible'        => $data->visible,
1943                 'uuid'           => $data->uuid,
1944                 'sequence'       => $data->sequence,
1945                 'timemodified'    => $this->apply_date_offset($data->timemodified));
1946         if ($this->name == 'activity_calendar') {
1947             $params['instance'] = $this->task->get_activityid();
1948         } else {
1949             $params['instance'] = 0;
1950         }
1951         $sql = 'SELECT id FROM {event} WHERE name = ? AND courseid = ? AND
1952                 repeatid = ? AND modulename = ? AND timestart = ? AND timeduration =?
1953                 AND ' . $DB->sql_compare_text('description', 255) . ' = ' . $DB->sql_compare_text('?', 255);
1954         $arg = array ($params['name'], $params['courseid'], $params['repeatid'], $params['modulename'], $params['timestart'], $params['timeduration'], $params['description']);
1955         $result = $DB->record_exists_sql($sql, $arg);
1956         if (empty($result)) {
1957             $newitemid = $DB->insert_record('event', $params);
1958             $this->set_mapping('event_description', $oldid, $newitemid, $restorefiles);
1959         }
1961     }
1962     protected function after_execute() {
1963         // Add related files
1964         $this->add_related_files('calendar', 'event_description', 'event_description');
1965     }
1968 class restore_course_completion_structure_step extends restore_structure_step {
1970     /**
1971      * Conditionally decide if this step should be executed.
1972      *
1973      * This function checks parameters that are not immediate settings to ensure
1974      * that the enviroment is suitable for the restore of course completion info.
1975      *
1976      * This function checks the following four parameters:
1977      *
1978      *   1. Course completion is enabled on the site
1979      *   2. The backup includes course completion information
1980      *   3. All modules are restorable
1981      *   4. All modules are marked for restore.
1982      *
1983      * @return bool True is safe to execute, false otherwise
1984      */
1985     protected function execute_condition() {
1986         global $CFG;
1988         // First check course completion is enabled on this site
1989         if (empty($CFG->enablecompletion)) {
1990             // Disabled, don't restore course completion
1991             return false;
1992         }
1994         // Check it is included in the backup
1995         $fullpath = $this->task->get_taskbasepath();
1996         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1997         if (!file_exists($fullpath)) {
1998             // Not found, can't restore course completion
1999             return false;
2000         }
2002         // Check we are able to restore all backed up modules
2003         if ($this->task->is_missing_modules()) {
2004             return false;
2005         }
2007         // Finally check all modules within the backup are being restored.
2008         if ($this->task->is_excluding_activities()) {
2009             return false;
2010         }
2012         return true;
2013     }
2015     /**
2016      * Define the course completion structure
2017      *
2018      * @return array Array of restore_path_element
2019      */
2020     protected function define_structure() {
2022         // To know if we are including user completion info
2023         $userinfo = $this->get_setting_value('userscompletion');
2025         $paths = array();
2026         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
2027         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
2029         if ($userinfo) {
2030             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
2031             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
2032         }
2034         return $paths;
2036     }
2038     /**
2039      * Process course completion criteria
2040      *
2041      * @global moodle_database $DB
2042      * @param stdClass $data
2043      */
2044     public function process_course_completion_criteria($data) {
2045         global $DB;
2047         $data = (object)$data;
2048         $data->course = $this->get_courseid();
2050         // Apply the date offset to the time end field
2051         $data->timeend = $this->apply_date_offset($data->timeend);
2053         // Map the role from the criteria
2054         if (!empty($data->role)) {
2055             $data->role = $this->get_mappingid('role', $data->role);
2056         }
2058         $skipcriteria = false;
2060         // If the completion criteria is for a module we need to map the module instance
2061         // to the new module id.
2062         if (!empty($data->moduleinstance) && !empty($data->module)) {
2063             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
2064             if (empty($data->moduleinstance)) {
2065                 $skipcriteria = true;
2066             }
2067         } else {
2068             $data->module = null;
2069             $data->moduleinstance = null;
2070         }
2072         // We backup the course shortname rather than the ID so that we can match back to the course
2073         if (!empty($data->courseinstanceshortname)) {
2074             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
2075             if (!$courseinstanceid) {
2076                 $skipcriteria = true;
2077             }
2078         } else {
2079             $courseinstanceid = null;
2080         }
2081         $data->courseinstance = $courseinstanceid;
2083         if (!$skipcriteria) {
2084             $params = array(
2085                 'course'         => $data->course,
2086                 'criteriatype'   => $data->criteriatype,
2087                 'enrolperiod'    => $data->enrolperiod,
2088                 'courseinstance' => $data->courseinstance,
2089                 'module'         => $data->module,
2090                 'moduleinstance' => $data->moduleinstance,
2091                 'timeend'        => $data->timeend,
2092                 'gradepass'      => $data->gradepass,
2093                 'role'           => $data->role
2094             );
2095             $newid = $DB->insert_record('course_completion_criteria', $params);
2096             $this->set_mapping('course_completion_criteria', $data->id, $newid);
2097         }
2098     }
2100     /**
2101      * Processes course compltion criteria complete records
2102      *
2103      * @global moodle_database $DB
2104      * @param stdClass $data
2105      */
2106     public function process_course_completion_crit_compl($data) {
2107         global $DB;
2109         $data = (object)$data;
2111         // This may be empty if criteria could not be restored
2112         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
2114         $data->course = $this->get_courseid();
2115         $data->userid = $this->get_mappingid('user', $data->userid);
2117         if (!empty($data->criteriaid) && !empty($data->userid)) {
2118             $params = array(
2119                 'userid' => $data->userid,
2120                 'course' => $data->course,
2121                 'criteriaid' => $data->criteriaid,
2122                 'timecompleted' => $this->apply_date_offset($data->timecompleted)
2123             );
2124             if (isset($data->gradefinal)) {
2125                 $params['gradefinal'] = $data->gradefinal;
2126             }
2127             if (isset($data->unenroled)) {
2128                 $params['unenroled'] = $data->unenroled;
2129             }
2130             $DB->insert_record('course_completion_crit_compl', $params);
2131         }
2132     }
2134     /**
2135      * Process course completions
2136      *
2137      * @global moodle_database $DB
2138      * @param stdClass $data
2139      */
2140     public function process_course_completions($data) {
2141         global $DB;
2143         $data = (object)$data;
2145         $data->course = $this->get_courseid();
2146         $data->userid = $this->get_mappingid('user', $data->userid);
2148         if (!empty($data->userid)) {
2149             $params = array(
2150                 'userid' => $data->userid,
2151                 'course' => $data->course,
2152                 'timeenrolled' => $this->apply_date_offset($data->timeenrolled),
2153                 'timestarted' => $this->apply_date_offset($data->timestarted),
2154                 'timecompleted' => $this->apply_date_offset($data->timecompleted),
2155                 'reaggregate' => $data->reaggregate
2156             );
2157             $DB->insert_record('course_completions', $params);
2158         }
2159     }
2161     /**
2162      * Process course completion aggregate methods
2163      *
2164      * @global moodle_database $DB
2165      * @param stdClass $data
2166      */
2167     public function process_course_completion_aggr_methd($data) {
2168         global $DB;
2170         $data = (object)$data;
2172         $data->course = $this->get_courseid();
2174         // Only create the course_completion_aggr_methd records if
2175         // the target course has not them defined. MDL-28180
2176         if (!$DB->record_exists('course_completion_aggr_methd', array(
2177                     'course' => $data->course,
2178                     'criteriatype' => $data->criteriatype))) {
2179             $params = array(
2180                 'course' => $data->course,
2181                 'criteriatype' => $data->criteriatype,
2182                 'method' => $data->method,
2183                 'value' => $data->value,
2184             );
2185             $DB->insert_record('course_completion_aggr_methd', $params);
2186         }
2187     }
2191 /**
2192  * This structure step restores course logs (cmid = 0), delegating
2193  * the hard work to the corresponding {@link restore_logs_processor} passing the
2194  * collection of {@link restore_log_rule} rules to be observed as they are defined
2195  * by the task. Note this is only executed based in the 'logs' setting.
2196  *
2197  * NOTE: This is executed by final task, to have all the activities already restored
2198  *
2199  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
2200  * records are. There are others like 'calendar' and 'upload' that will be handled
2201  * later.
2202  *
2203  * NOTE: All the missing actions (not able to be restored) are sent to logs for
2204  * debugging purposes
2205  */
2206 class restore_course_logs_structure_step extends restore_structure_step {
2208     /**
2209      * Conditionally decide if this step should be executed.
2210      *
2211      * This function checks the following parameter:
2212      *
2213      *   1. the course/logs.xml file exists
2214      *
2215      * @return bool true is safe to execute, false otherwise
2216      */
2217     protected function execute_condition() {
2219         // Check it is included in the backup
2220         $fullpath = $this->task->get_taskbasepath();
2221         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2222         if (!file_exists($fullpath)) {
2223             // Not found, can't restore course logs
2224             return false;
2225         }
2227         return true;
2228     }
2230     protected function define_structure() {
2232         $paths = array();
2234         // Simple, one plain level of information contains them
2235         $paths[] = new restore_path_element('log', '/logs/log');
2237         return $paths;
2238     }
2240     protected function process_log($data) {
2241         global $DB;
2243         $data = (object)($data);
2245         $data->time = $this->apply_date_offset($data->time);
2246         $data->userid = $this->get_mappingid('user', $data->userid);
2247         $data->course = $this->get_courseid();
2248         $data->cmid = 0;
2250         // For any reason user wasn't remapped ok, stop processing this
2251         if (empty($data->userid)) {
2252             return;
2253         }
2255         // Everything ready, let's delegate to the restore_logs_processor
2257         // Set some fixed values that will save tons of DB requests
2258         $values = array(
2259             'course' => $this->get_courseid());
2260         // Get instance and process log record
2261         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2263         // If we have data, insert it, else something went wrong in the restore_logs_processor
2264         if ($data) {
2265             $DB->insert_record('log', $data);
2266         }
2267     }
2270 /**
2271  * This structure step restores activity logs, extending {@link restore_course_logs_structure_step}
2272  * sharing its same structure but modifying the way records are handled
2273  */
2274 class restore_activity_logs_structure_step extends restore_course_logs_structure_step {
2276     protected function process_log($data) {
2277         global $DB;
2279         $data = (object)($data);
2281         $data->time = $this->apply_date_offset($data->time);
2282         $data->userid = $this->get_mappingid('user', $data->userid);
2283         $data->course = $this->get_courseid();
2284         $data->cmid = $this->task->get_moduleid();
2286         // For any reason user wasn't remapped ok, stop processing this
2287         if (empty($data->userid)) {
2288             return;
2289         }
2291         // Everything ready, let's delegate to the restore_logs_processor
2293         // Set some fixed values that will save tons of DB requests
2294         $values = array(
2295             'course' => $this->get_courseid(),
2296             'course_module' => $this->task->get_moduleid(),
2297             $this->task->get_modulename() => $this->task->get_activityid());
2298         // Get instance and process log record
2299         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2301         // If we have data, insert it, else something went wrong in the restore_logs_processor
2302         if ($data) {
2303             $DB->insert_record('log', $data);
2304         }
2305     }
2309 /**
2310  * Defines the restore step for advanced grading methods attached to the activity module
2311  */
2312 class restore_activity_grading_structure_step extends restore_structure_step {
2314     /**
2315      * This step is executed only if the grading file is present
2316      */
2317      protected function execute_condition() {
2319         $fullpath = $this->task->get_taskbasepath();
2320         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2321         if (!file_exists($fullpath)) {
2322             return false;
2323         }
2325         return true;
2326     }
2329     /**
2330      * Declares paths in the grading.xml file we are interested in
2331      */
2332     protected function define_structure() {
2334         $paths = array();
2335         $userinfo = $this->get_setting_value('userinfo');
2337         $area = new restore_path_element('grading_area', '/areas/area');
2338         $paths[] = $area;
2339         // attach local plugin stucture to $area element
2340         $this->add_plugin_structure('local', $area);
2342         $definition = new restore_path_element('grading_definition', '/areas/area/definitions/definition');
2343         $paths[] = $definition;
2344         $this->add_plugin_structure('gradingform', $definition);
2345         // attach local plugin stucture to $definition element
2346         $this->add_plugin_structure('local', $definition);
2349         if ($userinfo) {
2350             $instance = new restore_path_element('grading_instance',
2351                 '/areas/area/definitions/definition/instances/instance');
2352             $paths[] = $instance;
2353             $this->add_plugin_structure('gradingform', $instance);
2354             // attach local plugin stucture to $intance element
2355             $this->add_plugin_structure('local', $instance);
2356         }
2358         return $paths;
2359     }
2361     /**
2362      * Processes one grading area element
2363      *
2364      * @param array $data element data
2365      */
2366     protected function process_grading_area($data) {
2367         global $DB;
2369         $task = $this->get_task();
2370         $data = (object)$data;
2371         $oldid = $data->id;
2372         $data->component = 'mod_'.$task->get_modulename();
2373         $data->contextid = $task->get_contextid();
2375         $newid = $DB->insert_record('grading_areas', $data);
2376         $this->set_mapping('grading_area', $oldid, $newid);
2377     }
2379     /**
2380      * Processes one grading definition element
2381      *
2382      * @param array $data element data
2383      */
2384     protected function process_grading_definition($data) {
2385         global $DB;
2387         $task = $this->get_task();
2388         $data = (object)$data;
2389         $oldid = $data->id;
2390         $data->areaid = $this->get_new_parentid('grading_area');
2391         $data->copiedfromid = null;
2392         $data->timecreated = time();
2393         $data->usercreated = $task->get_userid();
2394         $data->timemodified = $data->timecreated;
2395         $data->usermodified = $data->usercreated;
2397         $newid = $DB->insert_record('grading_definitions', $data);
2398         $this->set_mapping('grading_definition', $oldid, $newid, true);
2399     }
2401     /**
2402      * Processes one grading form instance element
2403      *
2404      * @param array $data element data
2405      */
2406     protected function process_grading_instance($data) {
2407         global $DB;
2409         $data = (object)$data;
2411         // new form definition id
2412         $newformid = $this->get_new_parentid('grading_definition');
2414         // get the name of the area we are restoring to
2415         $sql = "SELECT ga.areaname
2416                   FROM {grading_definitions} gd
2417                   JOIN {grading_areas} ga ON gd.areaid = ga.id
2418                  WHERE gd.id = ?";
2419         $areaname = $DB->get_field_sql($sql, array($newformid), MUST_EXIST);
2421         // get the mapped itemid - the activity module is expected to define the mappings
2422         // for each gradable area
2423         $newitemid = $this->get_mappingid(restore_gradingform_plugin::itemid_mapping($areaname), $data->itemid);
2425         $oldid = $data->id;
2426         $data->definitionid = $newformid;
2427         $data->raterid = $this->get_mappingid('user', $data->raterid);
2428         $data->itemid = $newitemid;
2430         $newid = $DB->insert_record('grading_instances', $data);
2431         $this->set_mapping('grading_instance', $oldid, $newid);
2432     }
2434     /**
2435      * Final operations when the database records are inserted
2436      */
2437     protected function after_execute() {
2438         // Add files embedded into the definition description
2439         $this->add_related_files('grading', 'description', 'grading_definition');
2440     }
2444 /**
2445  * This structure step restores the grade items associated with one activity
2446  * All the grade items are made child of the "course" grade item but the original
2447  * categoryid is saved as parentitemid in the backup_ids table, so, when restoring
2448  * the complete gradebook (categories and calculations), that information is
2449  * available there
2450  */
2451 class restore_activity_grades_structure_step extends restore_structure_step {
2453     protected function define_structure() {
2455         $paths = array();
2456         $userinfo = $this->get_setting_value('userinfo');
2458         $paths[] = new restore_path_element('grade_item', '/activity_gradebook/grade_items/grade_item');
2459         $paths[] = new restore_path_element('grade_letter', '/activity_gradebook/grade_letters/grade_letter');
2460         if ($userinfo) {
2461             $paths[] = new restore_path_element('grade_grade',
2462                            '/activity_gradebook/grade_items/grade_item/grade_grades/grade_grade');
2463         }
2464         return $paths;
2465     }
2467     protected function process_grade_item($data) {
2468         global $DB;
2470         $data = (object)($data);
2471         $oldid       = $data->id;        // We'll need these later
2472         $oldparentid = $data->categoryid;
2473         $courseid = $this->get_courseid();
2475         // make sure top course category exists, all grade items will be associated
2476         // to it. Later, if restoring the whole gradebook, categories will be introduced
2477         $coursecat = grade_category::fetch_course_category($courseid);
2478         $coursecatid = $coursecat->id; // Get the categoryid to be used
2480         $idnumber = null;
2481         if (!empty($data->idnumber)) {
2482             // Don't get any idnumber from course module. Keep them as they are in grade_item->idnumber
2483             // Reason: it's not clear what happens with outcomes->idnumber or activities with multiple items (workshop)
2484             // so the best is to keep the ones already in the gradebook
2485             // Potential problem: duplicates if same items are restored more than once. :-(
2486             // This needs to be fixed in some way (outcomes & activities with multiple items)
2487             // $data->idnumber     = get_coursemodule_from_instance($data->itemmodule, $data->iteminstance)->idnumber;
2488             // In any case, verify always for uniqueness
2489             $sql = "SELECT cm.id
2490                       FROM {course_modules} cm
2491                      WHERE cm.course = :courseid AND
2492                            cm.idnumber = :idnumber AND
2493                            cm.id <> :cmid";
2494             $params = array(
2495                 'courseid' => $courseid,
2496                 'idnumber' => $data->idnumber,
2497                 'cmid' => $this->task->get_moduleid()
2498             );
2499             if (!$DB->record_exists_sql($sql, $params) && !$DB->record_exists('grade_items', array('courseid' => $courseid, 'idnumber' => $data->idnumber))) {
2500                 $idnumber = $data->idnumber;
2501             }
2502         }
2504         unset($data->id);
2505         $data->categoryid   = $coursecatid;
2506         $data->courseid     = $this->get_courseid();
2507         $data->iteminstance = $this->task->get_activityid();
2508         $data->idnumber     = $idnumber;
2509         $data->scaleid      = $this->get_mappingid('scale', $data->scaleid);
2510         $data->outcomeid    = $this->get_mappingid('outcome', $data->outcomeid);
2511         $data->timecreated  = $this->apply_date_offset($data->timecreated);
2512         $data->timemodified = $this->apply_date_offset($data->timemodified);
2514         $gradeitem = new grade_item($data, false);
2515         $gradeitem->insert('restore');
2517         //sortorder is automatically assigned when inserting. Re-instate the previous sortorder
2518         $gradeitem->sortorder = $data->sortorder;
2519         $gradeitem->update('restore');
2521         // Set mapping, saving the original category id into parentitemid
2522         // gradebook restore (final task) will need it to reorganise items
2523         $this->set_mapping('grade_item', $oldid, $gradeitem->id, false, null, $oldparentid);
2524     }
2526     protected function process_grade_grade($data) {
2527         $data = (object)($data);
2528         $olduserid = $data->userid;
2529         unset($data->id);
2531         $data->itemid = $this->get_new_parentid('grade_item');
2533         $data->userid = $this->get_mappingid('user', $data->userid, null);
2534         if (!empty($data->userid)) {
2535             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
2536             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
2537             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
2538             $data->overridden = $this->apply_date_offset($data->overridden);
2540             $grade = new grade_grade($data, false);
2541             $grade->insert('restore');
2542             // no need to save any grade_grade mapping
2543         } else {
2544             debugging("Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'");
2545         }
2546     }
2548     /**
2549      * process activity grade_letters. Note that, while these are possible,
2550      * because grade_letters are contextid based, in practice, only course
2551      * context letters can be defined. So we keep here this method knowing
2552      * it won't be executed ever. gradebook restore will restore course letters.
2553      */
2554     protected function process_grade_letter($data) {
2555         global $DB;
2557         $data['contextid'] = $this->task->get_contextid();
2558         $gradeletter = (object)$data;
2560         // Check if it exists before adding it
2561         unset($data['id']);
2562         if (!$DB->record_exists('grade_letters', $data)) {
2563             $newitemid = $DB->insert_record('grade_letters', $gradeletter);
2564         }
2565         // no need to save any grade_letter mapping
2566     }
2570 /**
2571  * This structure steps restores one instance + positions of one block
2572  * Note: Positions corresponding to one existing context are restored
2573  * here, but all the ones having unknown contexts are sent to backup_ids
2574  * for a later chance to be restored at the end (final task)
2575  */
2576 class restore_block_instance_structure_step extends restore_structure_step {
2578     protected function define_structure() {
2580         $paths = array();
2582         $paths[] = new restore_path_element('block', '/block', true); // Get the whole XML together
2583         $paths[] = new restore_path_element('block_position', '/block/block_positions/block_position');
2585         return $paths;
2586     }
2588     public function process_block($data) {
2589         global $DB, $CFG;
2591         $data = (object)$data; // Handy
2592         $oldcontextid = $data->contextid;
2593         $oldid        = $data->id;
2594         $positions = isset($data->block_positions['block_position']) ? $data->block_positions['block_position'] : array();
2596         // Look for the parent contextid
2597         if (!$data->parentcontextid = $this->get_mappingid('context', $data->parentcontextid)) {
2598             throw new restore_step_exception('restore_block_missing_parent_ctx', $data->parentcontextid);
2599         }
2601         // TODO: it would be nice to use standard plugin supports instead of this instance_allow_multiple()
2602         // If there is already one block of that type in the parent context
2603         // and the block is not multiple, stop processing
2604         // Use blockslib loader / method executor
2605         if (!$bi = block_instance($data->blockname)) {
2606             return false;
2607         }
2609         if (!$bi->instance_allow_multiple()) {
2610             if ($DB->record_exists_sql("SELECT bi.id
2611                                           FROM {block_instances} bi
2612                                           JOIN {block} b ON b.name = bi.blockname
2613                                          WHERE bi.parentcontextid = ?
2614                                            AND bi.blockname = ?", array($data->parentcontextid, $data->blockname))) {
2615                 return false;
2616             }
2617         }
2619         // If there is already one block of that type in the parent context
2620         // with the same showincontexts, pagetypepattern, subpagepattern, defaultregion and configdata
2621         // stop processing
2622         $params = array(
2623             'blockname' => $data->blockname, 'parentcontextid' => $data->parentcontextid,
2624             'showinsubcontexts' => $data->showinsubcontexts, 'pagetypepattern' => $data->pagetypepattern,
2625             'subpagepattern' => $data->subpagepattern, 'defaultregion' => $data->defaultregion);
2626         if ($birecs = $DB->get_records('block_instances', $params)) {
2627             foreach($birecs as $birec) {
2628                 if ($birec->configdata == $data->configdata) {
2629                     return false;
2630                 }
2631             }
2632         }
2634         // Set task old contextid, blockid and blockname once we know them
2635         $this->task->set_old_contextid($oldcontextid);
2636         $this->task->set_old_blockid($oldid);
2637         $this->task->set_blockname($data->blockname);
2639         // Let's look for anything within configdata neededing processing
2640         // (nulls and uses of legacy file.php)
2641         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
2642             $configdata = (array)unserialize(base64_decode($data->configdata));
2643             foreach ($configdata as $attribute => $value) {
2644                 if (in_array($attribute, $attrstotransform)) {
2645                     $configdata[$attribute] = $this->contentprocessor->process_cdata($value);
2646                 }
2647             }
2648             $data->configdata = base64_encode(serialize((object)$configdata));
2649         }
2651         // Create the block instance
2652         $newitemid = $DB->insert_record('block_instances', $data);
2653         // Save the mapping (with restorefiles support)
2654         $this->set_mapping('block_instance', $oldid, $newitemid, true);
2655         // Create the block context
2656         $newcontextid = context_block::instance($newitemid)->id;
2657         // Save the block contexts mapping and sent it to task
2658         $this->set_mapping('context', $oldcontextid, $newcontextid);
2659         $this->task->set_contextid($newcontextid);
2660         $this->task->set_blockid($newitemid);
2662         // Restore block fileareas if declared
2663         $component = 'block_' . $this->task->get_blockname();
2664         foreach ($this->task->get_fileareas() as $filearea) { // Simple match by contextid. No itemname needed
2665             $this->add_related_files($component, $filearea, null);
2666         }
2668         // Process block positions, creating them or accumulating for final step
2669         foreach($positions as $position) {
2670             $position = (object)$position;
2671             $position->blockinstanceid = $newitemid; // The instance is always the restored one
2672             // If position is for one already mapped (known) contextid
2673             // process it now, creating the position
2674             if ($newpositionctxid = $this->get_mappingid('context', $position->contextid)) {
2675                 $position->contextid = $newpositionctxid;
2676                 // Create the block position
2677                 $DB->insert_record('block_positions', $position);
2679             // The position belongs to an unknown context, send it to backup_ids
2680             // to process them as part of the final steps of restore. We send the
2681             // whole $position object there, hence use the low level method.
2682             } else {
2683                 restore_dbops::set_backup_ids_record($this->get_restoreid(), 'block_position', $position->id, 0, null, $position);
2684             }
2685         }
2686     }
2689 /**
2690  * Structure step to restore common course_module information
2691  *
2692  * This step will process the module.xml file for one activity, in order to restore
2693  * the corresponding information to the course_modules table, skipping various bits
2694  * of information based on CFG settings (groupings, completion...) in order to fullfill
2695  * all the reqs to be able to create the context to be used by all the rest of steps
2696  * in the activity restore task
2697  */
2698 class restore_module_structure_step extends restore_structure_step {
2700     protected function define_structure() {
2701         global $CFG;
2703         $paths = array();
2705         $module = new restore_path_element('module', '/module');
2706         $paths[] = $module;
2707         if ($CFG->enableavailability) {
2708             $paths[] = new restore_path_element('availability', '/module/availability_info/availability');
2709             $paths[] = new restore_path_element('availability_field', '/module/availability_info/availability_field');
2710         }
2712         // Apply for 'format' plugins optional paths at module level
2713         $this->add_plugin_structure('format', $module);
2715         // Apply for 'plagiarism' plugins optional paths at module level
2716         $this->add_plugin_structure('plagiarism', $module);
2718         // Apply for 'local' plugins optional paths at module level
2719         $this->add_plugin_structure('local', $module);
2721         return $paths;
2722     }
2724     protected function process_module($data) {
2725         global $CFG, $DB;
2727         $data = (object)$data;
2728         $oldid = $data->id;
2729         $this->task->set_old_moduleversion($data->version);
2731         $data->course = $this->task->get_courseid();
2732         $data->module = $DB->get_field('modules', 'id', array('name' => $data->modulename));
2733         // Map section (first try by course_section mapping match. Useful in course and section restores)
2734         $data->section = $this->get_mappingid('course_section', $data->sectionid);
2735         if (!$data->section) { // mapping failed, try to get section by sectionnumber matching
2736             $params = array(
2737                 'course' => $this->get_courseid(),
2738                 'section' => $data->sectionnumber);
2739             $data->section = $DB->get_field('course_sections', 'id', $params);
2740         }
2741         if (!$data->section) { // sectionnumber failed, try to get first section in course
2742             $params = array(
2743                 'course' => $this->get_courseid());
2744             $data->section = $DB->get_field('course_sections', 'MIN(id)', $params);
2745         }
2746         if (!$data->section) { // no sections in course, create section 0 and 1 and assign module to 1
2747             $sectionrec = array(
2748                 'course' => $this->get_courseid(),
2749                 'section' => 0);
2750             $DB->insert_record('course_sections', $sectionrec); // section 0
2751             $sectionrec = array(
2752                 'course' => $this->get_courseid(),
2753                 'section' => 1);
2754             $data->section = $DB->insert_record('course_sections', $sectionrec); // section 1
2755         }
2756         $data->groupingid= $this->get_mappingid('grouping', $data->groupingid);      // grouping
2757         if (!$CFG->enablegroupmembersonly) {                                         // observe groupsmemberonly
2758             $data->groupmembersonly = 0;
2759         }
2760         if (!grade_verify_idnumber($data->idnumber, $this->get_courseid())) {        // idnumber uniqueness
2761             $data->idnumber = '';
2762         }
2763         if (empty($CFG->enablecompletion)) { // completion
2764             $data->completion = 0;
2765             $data->completiongradeitemnumber = null;
2766             $data->completionview = 0;
2767             $data->completionexpected = 0;
2768         } else {
2769             $data->completionexpected = $this->apply_date_offset($data->completionexpected);
2770         }
2771         if (empty($CFG->enableavailability)) {
2772             $data->availablefrom = 0;
2773             $data->availableuntil = 0;
2774             $data->showavailability = 0;
2775         } else {
2776             $data->availablefrom = $this->apply_date_offset($data->availablefrom);
2777             $data->availableuntil= $this->apply_date_offset($data->availableuntil);
2778         }
2779         // Backups that did not include showdescription, set it to default 0
2780         // (this is not totally necessary as it has a db default, but just to
2781         // be explicit).
2782         if (!isset($data->showdescription)) {
2783             $data->showdescription = 0;
2784         }
2785         $data->instance = 0; // Set to 0 for now, going to create it soon (next step)
2787         // course_module record ready, insert it
2788         $newitemid = $DB->insert_record('course_modules', $data);
2789         // save mapping
2790         $this->set_mapping('course_module', $oldid, $newitemid);
2791         // set the new course_module id in the task
2792         $this->task->set_moduleid($newitemid);
2793         // we can now create the context safely
2794         $ctxid = context_module::instance($newitemid)->id;
2795         // set the new context id in the task
2796         $this->task->set_contextid($ctxid);
2797         // update sequence field in course_section
2798         if ($sequence = $DB->get_field('course_sections', 'sequence', array('id' => $data->section))) {
2799             $sequence .= ',' . $newitemid;
2800         } else {
2801             $sequence = $newitemid;
2802         }
2803         $DB->set_field('course_sections', 'sequence', $sequence, array('id' => $data->section));
2804     }
2806     protected function process_availability($data) {
2807         $data = (object)$data;
2808         // Simply going to store the whole availability record now, we'll process
2809         // all them later in the final task (once all activities have been restored)
2810         // Let's call the low level one to be able to store the whole object
2811         $data->coursemoduleid = $this->task->get_moduleid(); // Let add the availability cmid
2812         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'module_availability', $data->id, 0, null, $data);
2813     }
2815     protected function process_availability_field($data) {
2816         global $DB;
2817         $data = (object)$data;
2818         // Mark it is as passed by default
2819         $passed = true;
2820         $customfieldid = null;
2822         // If a customfield has been used in order to pass we must be able to match an existing
2823         // customfield by name (data->customfield) and type (data->customfieldtype)
2824         if (!empty($data->customfield) xor !empty($data->customfieldtype)) {
2825             // xor is sort of uncommon. If either customfield is null or customfieldtype is null BUT not both.
2826             // If one is null but the other isn't something clearly went wrong and we'll skip this condition.
2827             $passed = false;
2828         } else if (!empty($data->customfield)) {
2829             $params = array('shortname' => $data->customfield, 'datatype' => $data->customfieldtype);
2830             $customfieldid = $DB->get_field('user_info_field', 'id', $params);
2831             $passed = ($customfieldid !== false);
2832         }
2834         if ($passed) {
2835             // Create the object to insert into the database
2836             $availfield = new stdClass();
2837             $availfield->coursemoduleid = $this->task->get_moduleid(); // Lets add the availability cmid
2838             $availfield->userfield = $data->userfield;
2839             $availfield->customfieldid = $customfieldid;
2840             $availfield->operator = $data->operator;
2841             $availfield->value = $data->value;
2842             // Insert into the database
2843             $DB->insert_record('course_modules_avail_fields', $availfield);
2844         }
2845     }
2848 /**
2849  * Structure step that will process the user activity completion
2850  * information if all these conditions are met:
2851  *  - Target site has completion enabled ($CFG->enablecompletion)
2852  *  - Activity includes completion info (file_exists)
2853  */
2854 class restore_userscompletion_structure_step extends restore_structure_step {
2855     /**
2856      * To conditionally decide if this step must be executed
2857      * Note the "settings" conditions are evaluated in the
2858      * corresponding task. Here we check for other conditions
2859      * not being restore settings (files, site settings...)
2860      */
2861      protected function execute_condition() {
2862          global $CFG;
2864          // Completion disabled in this site, don't execute
2865          if (empty($CFG->enablecompletion)) {
2866              return false;
2867          }
2869          // No user completion info found, don't execute
2870         $fullpath = $this->task->get_taskbasepath();
2871         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2872          if (!file_exists($fullpath)) {
2873              return false;
2874          }
2876          // Arrived here, execute the step
2877          return true;
2878      }
2880      protected function define_structure() {
2882         $paths = array();
2884         $paths[] = new restore_path_element('completion', '/completions/completion');
2886         return $paths;
2887     }
2889     protected function process_completion($data) {
2890         global $DB;
2892         $data = (object)$data;
2894         $data->coursemoduleid = $this->task->get_moduleid();
2895         $data->userid = $this->get_mappingid('user', $data->userid);
2896         $data->timemodified = $this->apply_date_offset($data->timemodified);
2898         // Find the existing record
2899         $existing = $DB->get_record('course_modules_completion', array(
2900                 'coursemoduleid' => $data->coursemoduleid,
2901                 'userid' => $data->userid), 'id, timemodified');
2902         // Check we didn't already insert one for this cmid and userid
2903         // (there aren't supposed to be duplicates in that field, but
2904         // it was possible until MDL-28021 was fixed).
2905         if ($existing) {
2906             // Update it to these new values, but only if the time is newer
2907             if ($existing->timemodified < $data->timemodified) {
2908                 $data->id = $existing->id;
2909                 $DB->update_record('course_modules_completion', $data);
2910             }
2911         } else {
2912             // Normal entry where it doesn't exist already
2913             $DB->insert_record('course_modules_completion', $data);
2914         }
2915     }
2918 /**
2919  * Abstract structure step, parent of all the activity structure steps. Used to suuport
2920  * the main <activity ...> tag and process it. Also provides subplugin support for
2921  * activities.
2922  */
2923 abstract class restore_activity_structure_step extends restore_structure_step {
2925     protected function add_subplugin_structure($subplugintype, $element) {
2927         global $CFG;
2929         // Check the requested subplugintype is a valid one
2930         $subpluginsfile = $CFG->dirroot . '/mod/' . $this->task->get_modulename() . '/db/subplugins.php';
2931         if (!file_exists($subpluginsfile)) {
2932              throw new restore_step_exception('activity_missing_subplugins_php_file', $this->task->get_modulename());
2933         }
2934         include($subpluginsfile);
2935         if (!array_key_exists($subplugintype, $subplugins)) {
2936              throw new restore_step_exception('incorrect_subplugin_type', $subplugintype);
2937         }
2938         // Get all the restore path elements, looking across all the subplugin dirs
2939         $subpluginsdirs = get_plugin_list($subplugintype);
2940         foreach ($subpluginsdirs as $name => $subpluginsdir) {
2941             $classname = 'restore_' . $subplugintype . '_' . $name . '_subplugin';
2942             $restorefile = $subpluginsdir . '/backup/moodle2/' . $classname . '.class.php';
2943             if (file_exists($restorefile)) {
2944                 require_once($restorefile);
2945                 $restoresubplugin = new $classname($subplugintype, $name, $this);
2946                 // Add subplugin paths to the step
2947                 $this->prepare_pathelements($restoresubplugin->define_subplugin_structure($element));
2948             }
2949         }
2950     }
2952     /**
2953      * As far as activity restore steps are implementing restore_subplugin stuff, they need to
2954      * have the parent task available for wrapping purposes (get course/context....)
2955      * @return restore_task
2956      */
2957     public function get_task() {
2958         return $this->task;
2959     }
2961     /**
2962      * Adds support for the 'activity' path that is common to all the activities
2963      * and will be processed globally here
2964      */
2965     protected function prepare_activity_structure($paths) {
2967         $paths[] = new restore_path_element('activity', '/activity');
2969         return $paths;
2970     }
2972     /**
2973      * Process the activity path, informing the task about various ids, needed later
2974      */
2975     protected function process_activity($data) {
2976         $data = (object)$data;
2977         $this->task->set_old_contextid($data->contextid); // Save old contextid in task
2978         $this->set_mapping('context', $data->contextid, $this->task->get_contextid()); // Set the mapping
2979         $this->task->set_old_activityid($data->id); // Save old activityid in task
2980     }
2982     /**
2983      * This must be invoked immediately after creating the "module" activity record (forum, choice...)
2984      * and will adjust the new activity id (the instance) in various places
2985      */
2986     protected function apply_activity_instance($newitemid) {
2987         global $DB;
2989         $this->task->set_activityid($newitemid); // Save activity id in task
2990         // Apply the id to course_sections->instanceid
2991         $DB->set_field('course_modules', 'instance', $newitemid, array('id' => $this->task->get_moduleid()));
2992         // Do the mapping for modulename, preparing it for files by oldcontext
2993         $modulename = $this->task->get_modulename();
2994         $oldid = $this->task->get_old_activityid();
2995         $this->set_mapping($modulename, $oldid, $newitemid, true);
2996     }
2999 /**
3000  * Structure step in charge of creating/mapping all the qcats and qs
3001  * by parsing the questions.xml file and checking it against the
3002  * results calculated by {@link restore_process_categories_and_questions}
3003  * and stored in backup_ids_temp
3004  */
3005 class restore_create_categories_and_questions extends restore_structure_step {
3007     protected function define_structure() {
3009         $category = new restore_path_element('question_category', '/question_categories/question_category');
3010         $question = new restore_path_element('question', '/question_categories/question_category/questions/question');
3011         $hint = new restore_path_element('question_hint',
3012                 '/question_categories/question_category/questions/question/question_hints/question_hint');
3014         // Apply for 'qtype' plugins optional paths at question level
3015         $this->add_plugin_structure('qtype', $question);
3017         // Apply for 'local' plugins optional paths at question level
3018         $this->add_plugin_structure('local', $question);
3020         return array($category, $question, $hint);
3021     }
3023     protected function process_question_category($data) {
3024         global $DB;
3026         $data = (object)$data;
3027         $oldid = $data->id;
3029         // Check we have one mapping for this category
3030         if (!$mapping = $this->get_mapping('question_category', $oldid)) {
3031             return self::SKIP_ALL_CHILDREN; // No mapping = this category doesn't need to be created/mapped
3032         }
3034         // Check we have to create the category (newitemid = 0)
3035         if ($mapping->newitemid) {
3036             return; // newitemid != 0, this category is going to be mapped. Nothing to do
3037         }
3039         // Arrived here, newitemid = 0, we need to create the category
3040         // we'll do it at parentitemid context, but for CONTEXT_MODULE
3041         // categories, that will be created at CONTEXT_COURSE and moved
3042         // to module context later when the activity is created
3043         if ($mapping->info->contextlevel == CONTEXT_MODULE) {
3044             $mapping->parentitemid = $this->get_mappingid('context', $this->task->get_old_contextid());
3045         }
3046         $data->contextid = $mapping->parentitemid;
3048         // Let's create the question_category and save mapping
3049         $newitemid = $DB->insert_record('question_categories', $data);
3050         $this->set_mapping('question_category', $oldid, $newitemid);
3051         // Also annotate them as question_category_created, we need
3052         // that later when remapping parents
3053         $this->set_mapping('question_category_created', $oldid, $newitemid, false, null, $data->contextid);
3054     }
3056     protected function process_question($data) {
3057         global $DB;
3059         $data = (object)$data;
3060         $oldid = $data->id;
3062         // Check we have one mapping for this question
3063         if (!$questionmapping = $this->get_mapping('question', $oldid)) {
3064             return; // No mapping = this question doesn't need to be created/mapped
3065         }
3067         // Get the mapped category (cannot use get_new_parentid() because not
3068         // all the categories have been created, so it is not always available
3069         // Instead we get the mapping for the question->parentitemid because
3070         // we have loaded qcatids there for all parsed questions
3071         $data->category = $this->get_mappingid('question_category', $questionmapping->parentitemid);
3073         // In the past, there were some very sloppy values of penalty. Fix them.
3074         if ($data->penalty >= 0.33 && $data->penalty <= 0.34) {
3075             $data->penalty = 0.3333333;
3076         }
3077         if ($data->penalty >= 0.66 && $data->penalty <= 0.67) {
3078             $data->penalty = 0.6666667;
3079         }
3080         if ($data->penalty >= 1) {
3081             $data->penalty = 1;
3082         }
3084         $userid = $this->get_mappingid('user', $data->createdby);
3085         $data->createdby = $userid ? $userid : $this->task->get_userid();
3087         $userid = $this->get_mappingid('user', $data->modifiedby);
3088         $data->modifiedby = $userid ? $userid : $this->task->get_userid();
3090         // With newitemid = 0, let's create the question
3091         if (!$questionmapping->newitemid) {
3092             $newitemid = $DB->insert_record('question', $data);
3093             $this->set_mapping('question', $oldid, $newitemid);
3094             // Also annotate them as question_created, we need
3095             // that later when remapping parents (keeping the old categoryid as parentid)
3096             $this->set_mapping('question_created', $oldid, $newitemid, false, null, $questionmapping->parentitemid);
3097         } else {
3098             // By performing this set_mapping() we make get_old/new_parentid() to work for all the
3099             // children elements of the 'question' one (so qtype plugins will know the question they belong to)
3100             $this->set_mapping('question', $oldid, $questionmapping->newitemid);
3101         }
3103         // Note, we don't restore any question files yet
3104         // as far as the CONTEXT_MODULE categories still
3105         // haven't their contexts to be restored to
3106         // The {@link restore_create_question_files}, executed in the final step
3107         // step will be in charge of restoring all the question files
3108     }
3110         protected function process_question_hint($data) {
3111         global $DB;
3113         $data = (object)$data;
3114         $oldid = $data->id;
3116         // Detect if the question is created or mapped
3117         $oldquestionid   = $this->get_old_parentid('question');
3118         $newquestionid   = $this->get_new_parentid('question');
3119         $questioncreated = $this->get_mappingid('question_created', $oldquestionid) ? true : false;
3121         // If the question has been created by restore, we need to create its question_answers too
3122         if ($questioncreated) {
3123             // Adjust some columns
3124             $data->questionid = $newquestionid;
3125             // Insert record
3126             $newitemid = $DB->insert_record('question_hints', $data);
3128         // The question existed, we need to map the existing question_hints
3129         } else {
3130             // Look in question_hints by hint text matching
3131             $sql = 'SELECT id
3132                       FROM {question_hints}
3133                      WHERE questionid = ?
3134                        AND ' . $DB->sql_compare_text('hint', 255) . ' = ' . $DB->sql_compare_text('?', 255);
3135             $params = array($newquestionid, $data->hint);
3136             $newitemid = $DB->get_field_sql($sql, $params);
3138             // Not able to find the hint, let's try cleaning the hint text
3139             // of all the question's hints in DB as slower fallback. MDL-33863.
3140             if (!$newitemid) {
3141                 $potentialhints = $DB->get_records('question_hints',
3142                         array('questionid' => $newquestionid), '', 'id, hint');
3143                 foreach ($potentialhints as $potentialhint) {
3144                     // Clean in the same way than {@link xml_writer::xml_safe_utf8()}.
3145                     $cleanhint = preg_replace('/[\x-\x8\xb-\xc\xe-\x1f\x7f]/is','', $potentialhint->hint); // Clean CTRL chars.
3146                     $cleanhint = preg_replace("/\r\n|\r/", "\n", $cleanhint); // Normalize line ending.
3147                     if ($cleanhint === $data->hint) {
3148                         $newitemid = $data->id;
3149                     }
3150                 }
3151             }
3153             // If we haven't found the newitemid, something has gone really wrong, question in DB
3154             // is missing hints, exception
3155             if (!$newitemid) {
3156                 $info = new stdClass();
3157                 $info->filequestionid = $oldquestionid;
3158                 $info->dbquestionid   = $newquestionid;
3159                 $info->hint           = $data->hint;
3160                 throw new restore_step_exception('error_question_hint_missing_in_db', $info);
3161             }
3162         }
3163         // Create mapping (I'm not sure if this is really needed?)
3164         $this->set_mapping('question_hint', $oldid, $newitemid);
3165     }
3167     protected function after_execute() {
3168         global $DB;
3170         // First of all, recode all the created question_categories->parent fields
3171         $qcats = $DB->get_records('backup_ids_temp', array(
3172                      'backupid' => $this->get_restoreid(),
3173                      'itemname' => 'question_category_created'));
3174         foreach ($qcats as $qcat) {
3175             $newparent = 0;
3176             $dbcat = $DB->get_record('question_categories', array('id' => $qcat->newitemid));
3177             // Get new parent (mapped or created, so we look in quesiton_category mappings)
3178             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
3179                                  'backupid' => $this->get_restoreid(),
3180                                  'itemname' => 'question_category',
3181                                  'itemid'   => $dbcat->parent))) {
3182                 // contextids must match always, as far as we always include complete qbanks, just check it
3183                 $newparentctxid = $DB->get_field('question_categories', 'contextid', array('id' => $newparent));
3184                 if ($dbcat->contextid == $newparentctxid) {
3185                     $DB->set_field('question_categories', 'parent', $newparent, array('id' => $dbcat->id));
3186                 } else {
3187                     $newparent = 0; // No ctx match for both cats, no parent relationship
3188                 }
3189             }
3190             // Here with $newparent empty, problem with contexts or remapping, set it to top cat
3191             if (!$newparent) {
3192                 $DB->set_field('question_categories', 'parent', 0, array('id' => $dbcat->id));
3193             }
3194         }
3196         // Now, recode all the created question->parent fields
3197         $qs = $DB->get_records('backup_ids_temp', array(
3198                   'backupid' => $this->get_restoreid(),
3199                   'itemname' => 'question_created'));
3200         foreach ($qs as $q) {
3201             $newparent = 0;
3202             $dbq = $DB->get_record('question', array('id' => $q->newitemid));
3203             // Get new parent (mapped or created, so we look in question mappings)
3204             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
3205                                  'backupid' => $this->get_restoreid(),
3206                                  'itemname' => 'question',
3207                                  'itemid'   => $dbq->parent))) {
3208                 $DB->set_field('question', 'parent', $newparent, array('id' => $dbq->id));
3209             }
3210         }
3212         // Note, we don't restore any question files yet
3213         // as far as the CONTEXT_MODULE categories still
3214         // haven't their contexts to be restored to
3215         // The {@link restore_create_question_files}, executed in the final step
3216         // step will be in charge of restoring all the question files
3217     }
3220 /**
3221  * Execution step that will move all the CONTEXT_MODULE question categories
3222  * created at early stages of restore in course context (because modules weren't
3223  * created yet) to their target module (matching by old-new-contextid mapping)
3224  */
3225 class restore_move_module_questions_categories extends restore_execution_step {
3227     protected function define_execution() {
3228         global $DB;
3230         $contexts = restore_dbops::restore_get_question_banks($this->get_restoreid(), CONTEXT_MODULE);
3231         foreach ($contexts as $contextid => $contextlevel) {
3232             // Only if context mapping exists (i.e. the module has been restored)
3233             if ($newcontext = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $contextid)) {
3234                 // Update all the qcats having their parentitemid set to the original contextid
3235                 $modulecats = $DB->get_records_sql("SELECT itemid, newitemid
3236                                                       FROM {backup_ids_temp}
3237                                                      WHERE backupid = ?
3238                                                        AND itemname = 'question_category'
3239                  &