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