422533f98fabf2b1e2c7ba79a50e63be7fa6df21
[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', 'overviewfiles', 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     }
1494 /**
1495  * Execution step that will migrate legacy files if present.
1496  */
1497 class restore_course_legacy_files_step extends restore_execution_step {
1498     public function define_execution() {
1499         global $DB;
1501         // Do a check for legacy files and skip if there are none.
1502         $sql = 'SELECT count(*)
1503                   FROM {backup_files_temp}
1504                  WHERE backupid = ?
1505                    AND contextid = ?
1506                    AND component = ?
1507                    AND filearea  = ?';
1508         $params = array($this->get_restoreid(), $this->task->get_old_contextid(), 'course', 'legacy');
1510         if ($DB->count_records_sql($sql, $params)) {
1511             $DB->set_field('course', 'legacyfiles', 2, array('id' => $this->get_courseid()));
1512             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'course',
1513                 'legacy', $this->task->get_old_contextid(), $this->task->get_userid());
1514         }
1515     }
1518 /*
1519  * Structure step that will read the roles.xml file (at course/activity/block levels)
1520  * containing all the role_assignments and overrides for that context. If corresponding to
1521  * one mapped role, they will be applied to target context. Will observe the role_assignments
1522  * setting to decide if ras are restored.
1523  *
1524  * Note: this needs to be executed after all users are enrolled.
1525  */
1526 class restore_ras_and_caps_structure_step extends restore_structure_step {
1527     protected $plugins = null;
1529     protected function define_structure() {
1531         $paths = array();
1533         // Observe the role_assignments setting
1534         if ($this->get_setting_value('role_assignments')) {
1535             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
1536         }
1537         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
1539         return $paths;
1540     }
1542     /**
1543      * Assign roles
1544      *
1545      * This has to be called after enrolments processing.
1546      *
1547      * @param mixed $data
1548      * @return void
1549      */
1550     public function process_assignment($data) {
1551         global $DB;
1553         $data = (object)$data;
1555         // Check roleid, userid are one of the mapped ones
1556         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
1557             return;
1558         }
1559         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
1560             return;
1561         }
1562         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
1563             // Only assign roles to not deleted users
1564             return;
1565         }
1566         if (!$contextid = $this->task->get_contextid()) {
1567             return;
1568         }
1570         if (empty($data->component)) {
1571             // assign standard manual roles
1572             // TODO: role_assign() needs one userid param to be able to specify our restore userid
1573             role_assign($newroleid, $newuserid, $contextid);
1575         } else if ((strpos($data->component, 'enrol_') === 0)) {
1576             // Deal with enrolment roles - ignore the component and just find out the instance via new id,
1577             // it is possible that enrolment was restored using different plugin type.
1578             if (!isset($this->plugins)) {
1579                 $this->plugins = enrol_get_plugins(true);
1580             }
1581             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1582                 if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1583                     if (isset($this->plugins[$instance->enrol])) {
1584                         $this->plugins[$instance->enrol]->restore_role_assignment($instance, $newroleid, $newuserid, $contextid);
1585                     }
1586                 }
1587             }
1589         } else {
1590             $data->roleid    = $newroleid;
1591             $data->userid    = $newuserid;
1592             $data->contextid = $contextid;
1593             $dir = get_component_directory($data->component);
1594             if ($dir and is_dir($dir)) {
1595                 if (component_callback($data->component, 'restore_role_assignment', array($this, $data), true)) {
1596                     return;
1597                 }
1598             }
1599             // Bad luck, plugin could not restore the data, let's add normal membership.
1600             role_assign($data->roleid, $data->userid, $data->contextid);
1601             $message = "Restore of '$data->component/$data->itemid' role assignments is not supported, using manual role assignments instead.";
1602             debugging($message);
1603             $this->log($message, backup::LOG_WARNING);
1604         }
1605     }
1607     public function process_override($data) {
1608         $data = (object)$data;
1610         // Check roleid is one of the mapped ones
1611         $newroleid = $this->get_mappingid('role', $data->roleid);
1612         // If newroleid and context are valid assign it via API (it handles dupes and so on)
1613         if ($newroleid && $this->task->get_contextid()) {
1614             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
1615             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
1616             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
1617         }
1618     }
1621 /**
1622  * This structure steps restores the enrol plugins and their underlying
1623  * enrolments, performing all the mappings and/or movements required
1624  */
1625 class restore_enrolments_structure_step extends restore_structure_step {
1626     protected $enrolsynced = false;
1627     protected $plugins = null;
1628     protected $originalstatus = array();
1630     /**
1631      * Conditionally decide if this step should be executed.
1632      *
1633      * This function checks the following parameter:
1634      *
1635      *   1. the course/enrolments.xml file exists
1636      *
1637      * @return bool true is safe to execute, false otherwise
1638      */
1639     protected function execute_condition() {
1641         // Check it is included in the backup
1642         $fullpath = $this->task->get_taskbasepath();
1643         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1644         if (!file_exists($fullpath)) {
1645             // Not found, can't restore enrolments info
1646             return false;
1647         }
1649         return true;
1650     }
1652     protected function define_structure() {
1654         $paths = array();
1656         $paths[] = new restore_path_element('enrol', '/enrolments/enrols/enrol');
1657         $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
1659         return $paths;
1660     }
1662     /**
1663      * Create enrolment instances.
1664      *
1665      * This has to be called after creation of roles
1666      * and before adding of role assignments.
1667      *
1668      * @param mixed $data
1669      * @return void
1670      */
1671     public function process_enrol($data) {
1672         global $DB;
1674         $data = (object)$data;
1675         $oldid = $data->id; // We'll need this later.
1676         unset($data->id);
1678         $this->originalstatus[$oldid] = $data->status;
1680         if (!$courserec = $DB->get_record('course', array('id' => $this->get_courseid()))) {
1681             $this->set_mapping('enrol', $oldid, 0);
1682             return;
1683         }
1685         if (!isset($this->plugins)) {
1686             $this->plugins = enrol_get_plugins(true);
1687         }
1689         if (!$this->enrolsynced) {
1690             // Make sure that all plugin may create instances and enrolments automatically
1691             // before the first instance restore - this is suitable especially for plugins
1692             // that synchronise data automatically using course->idnumber or by course categories.
1693             foreach ($this->plugins as $plugin) {
1694                 $plugin->restore_sync_course($courserec);
1695             }
1696             $this->enrolsynced = true;
1697         }
1699         // Map standard fields - plugin has to process custom fields manually.
1700         $data->roleid   = $this->get_mappingid('role', $data->roleid);
1701         $data->courseid = $courserec->id;
1703         if ($this->get_setting_value('enrol_migratetomanual')) {
1704             unset($data->sortorder); // Remove useless sortorder from <2.4 backups.
1705             if (!enrol_is_enabled('manual')) {
1706                 $this->set_mapping('enrol', $oldid, 0);
1707                 return;
1708             }
1709             if ($instances = $DB->get_records('enrol', array('courseid'=>$data->courseid, 'enrol'=>'manual'), 'id')) {
1710                 $instance = reset($instances);
1711                 $this->set_mapping('enrol', $oldid, $instance->id);
1712             } else {
1713                 if ($data->enrol === 'manual') {
1714                     $instanceid = $this->plugins['manual']->add_instance($courserec, (array)$data);
1715                 } else {
1716                     $instanceid = $this->plugins['manual']->add_default_instance($courserec);
1717                 }
1718                 $this->set_mapping('enrol', $oldid, $instanceid);
1719             }
1721         } else {
1722             if (!enrol_is_enabled($data->enrol) or !isset($this->plugins[$data->enrol])) {
1723                 $this->set_mapping('enrol', $oldid, 0);
1724                 $message = "Enrol plugin '$data->enrol' data can not be restored because it is not enabled, use migration to manual enrolments";
1725                 debugging($message);
1726                 $this->log($message, backup::LOG_WARNING);
1727                 return;
1728             }
1729             if ($task = $this->get_task() and $task->get_target() == backup::TARGET_NEW_COURSE) {
1730                 // Let's keep the sortorder in old backups.
1731             } else {
1732                 // Prevent problems with colliding sortorders in old backups,
1733                 // new 2.4 backups do not need sortorder because xml elements are ordered properly.
1734                 unset($data->sortorder);
1735             }
1736             // Note: plugin is responsible for setting up the mapping, it may also decide to migrate to different type.
1737             $this->plugins[$data->enrol]->restore_instance($this, $data, $courserec, $oldid);
1738         }
1739     }
1741     /**
1742      * Create user enrolments.
1743      *
1744      * This has to be called after creation of enrolment instances
1745      * and before adding of role assignments.
1746      *
1747      * Roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing afterwards.
1748      *
1749      * @param mixed $data
1750      * @return void
1751      */
1752     public function process_enrolment($data) {
1753         global $DB;
1755         if (!isset($this->plugins)) {
1756             $this->plugins = enrol_get_plugins(true);
1757         }
1759         $data = (object)$data;
1761         // Process only if parent instance have been mapped.
1762         if ($enrolid = $this->get_new_parentid('enrol')) {
1763             $oldinstancestatus = ENROL_INSTANCE_ENABLED;
1764             $oldenrolid = $this->get_old_parentid('enrol');
1765             if (isset($this->originalstatus[$oldenrolid])) {
1766                 $oldinstancestatus = $this->originalstatus[$oldenrolid];
1767             }
1768             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1769                 // And only if user is a mapped one.
1770                 if ($userid = $this->get_mappingid('user', $data->userid)) {
1771                     if (isset($this->plugins[$instance->enrol])) {
1772                         $this->plugins[$instance->enrol]->restore_user_enrolment($this, $data, $instance, $userid, $oldinstancestatus);
1773                     }
1774                 }
1775             }
1776         }
1777     }
1781 /**
1782  * Make sure the user restoring the course can actually access it.
1783  */
1784 class restore_fix_restorer_access_step extends restore_execution_step {
1785     protected function define_execution() {
1786         global $CFG, $DB;
1788         if (!$userid = $this->task->get_userid()) {
1789             return;
1790         }
1792         if (empty($CFG->restorernewroleid)) {
1793             // Bad luck, no fallback role for restorers specified
1794             return;
1795         }
1797         $courseid = $this->get_courseid();
1798         $context = context_course::instance($courseid);
1800         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1801             // Current user may access the course (admin, category manager or restored teacher enrolment usually)
1802             return;
1803         }
1805         // Try to add role only - we do not need enrolment if user has moodle/course:view or is already enrolled
1806         role_assign($CFG->restorernewroleid, $userid, $context);
1808         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1809             // Extra role is enough, yay!
1810             return;
1811         }
1813         // The last chance is to create manual enrol if it does not exist and and try to enrol the current user,
1814         // hopefully admin selected suitable $CFG->restorernewroleid ...
1815         if (!enrol_is_enabled('manual')) {
1816             return;
1817         }
1818         if (!$enrol = enrol_get_plugin('manual')) {
1819             return;
1820         }
1821         if (!$DB->record_exists('enrol', array('enrol'=>'manual', 'courseid'=>$courseid))) {
1822             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
1823             $fields = array('status'=>ENROL_INSTANCE_ENABLED, 'enrolperiod'=>$enrol->get_config('enrolperiod', 0), 'roleid'=>$enrol->get_config('roleid', 0));
1824             $enrol->add_instance($course, $fields);
1825         }
1827         enrol_try_internal_enrol($courseid, $userid);
1828     }
1832 /**
1833  * This structure steps restores the filters and their configs
1834  */
1835 class restore_filters_structure_step extends restore_structure_step {
1837     protected function define_structure() {
1839         $paths = array();
1841         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
1842         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
1844         return $paths;
1845     }
1847     public function process_active($data) {
1849         $data = (object)$data;
1851         if (strpos($data->filter, 'filter/') === 0) {
1852             $data->filter = substr($data->filter, 7);
1854         } else if (strpos($data->filter, '/') !== false) {
1855             // Unsupported old filter.
1856             return;
1857         }
1859         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1860             return;
1861         }
1862         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
1863     }
1865     public function process_config($data) {
1867         $data = (object)$data;
1869         if (strpos($data->filter, 'filter/') === 0) {
1870             $data->filter = substr($data->filter, 7);
1872         } else if (strpos($data->filter, '/') !== false) {
1873             // Unsupported old filter.
1874             return;
1875         }
1877         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1878             return;
1879         }
1880         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
1881     }
1885 /**
1886  * This structure steps restores the comments
1887  * Note: Cannot use the comments API because defaults to USER->id.
1888  * That should change allowing to pass $userid
1889  */
1890 class restore_comments_structure_step extends restore_structure_step {
1892     protected function define_structure() {
1894         $paths = array();
1896         $paths[] = new restore_path_element('comment', '/comments/comment');
1898         return $paths;
1899     }
1901     public function process_comment($data) {
1902         global $DB;
1904         $data = (object)$data;
1906         // First of all, if the comment has some itemid, ask to the task what to map
1907         $mapping = false;
1908         if ($data->itemid) {
1909             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
1910             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
1911         }
1912         // Only restore the comment if has no mapping OR we have found the matching mapping
1913         if (!$mapping || $data->itemid) {
1914             // Only if user mapping and context
1915             $data->userid = $this->get_mappingid('user', $data->userid);
1916             if ($data->userid && $this->task->get_contextid()) {
1917                 $data->contextid = $this->task->get_contextid();
1918                 // Only if there is another comment with same context/user/timecreated
1919                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
1920                 if (!$DB->record_exists('comments', $params)) {
1921                     $DB->insert_record('comments', $data);
1922                 }
1923             }
1924         }
1925     }
1928 /**
1929  * This structure steps restores the calendar events
1930  */
1931 class restore_calendarevents_structure_step extends restore_structure_step {
1933     protected function define_structure() {
1935         $paths = array();
1937         $paths[] = new restore_path_element('calendarevents', '/events/event');
1939         return $paths;
1940     }
1942     public function process_calendarevents($data) {
1943         global $DB, $SITE;
1945         $data = (object)$data;
1946         $oldid = $data->id;
1947         $restorefiles = true; // We'll restore the files
1948         // Find the userid and the groupid associated with the event. Return if not found.
1949         $data->userid = $this->get_mappingid('user', $data->userid);
1950         if ($data->userid === false) {
1951             return;
1952         }
1953         if (!empty($data->groupid)) {
1954             $data->groupid = $this->get_mappingid('group', $data->groupid);
1955             if ($data->groupid === false) {
1956                 return;
1957             }
1958         }
1959         // Handle events with empty eventtype //MDL-32827
1960         if(empty($data->eventtype)) {
1961             if ($data->courseid == $SITE->id) {                                // Site event
1962                 $data->eventtype = "site";
1963             } else if ($data->courseid != 0 && $data->groupid == 0 && ($data->modulename == 'assignment' || $data->modulename == 'assign')) {
1964                 // Course assingment event
1965                 $data->eventtype = "due";
1966             } else if ($data->courseid != 0 && $data->groupid == 0) {      // Course event
1967                 $data->eventtype = "course";
1968             } else if ($data->groupid) {                                      // Group event
1969                 $data->eventtype = "group";
1970             } else if ($data->userid) {                                       // User event
1971                 $data->eventtype = "user";
1972             } else {
1973                 return;
1974             }
1975         }
1977         $params = array(
1978                 'name'           => $data->name,
1979                 'description'    => $data->description,
1980                 'format'         => $data->format,
1981                 'courseid'       => $this->get_courseid(),
1982                 'groupid'        => $data->groupid,
1983                 'userid'         => $data->userid,
1984                 'repeatid'       => $data->repeatid,
1985                 'modulename'     => $data->modulename,
1986                 'eventtype'      => $data->eventtype,
1987                 'timestart'      => $this->apply_date_offset($data->timestart),
1988                 'timeduration'   => $data->timeduration,
1989                 'visible'        => $data->visible,
1990                 'uuid'           => $data->uuid,
1991                 'sequence'       => $data->sequence,
1992                 'timemodified'    => $this->apply_date_offset($data->timemodified));
1993         if ($this->name == 'activity_calendar') {
1994             $params['instance'] = $this->task->get_activityid();
1995         } else {
1996             $params['instance'] = 0;
1997         }
1998         $sql = 'SELECT id FROM {event} WHERE name = ? AND courseid = ? AND
1999                 repeatid = ? AND modulename = ? AND timestart = ? AND timeduration =?
2000                 AND ' . $DB->sql_compare_text('description', 255) . ' = ' . $DB->sql_compare_text('?', 255);
2001         $arg = array ($params['name'], $params['courseid'], $params['repeatid'], $params['modulename'], $params['timestart'], $params['timeduration'], $params['description']);
2002         $result = $DB->record_exists_sql($sql, $arg);
2003         if (empty($result)) {
2004             $newitemid = $DB->insert_record('event', $params);
2005             $this->set_mapping('event_description', $oldid, $newitemid, $restorefiles);
2006         }
2008     }
2009     protected function after_execute() {
2010         // Add related files
2011         $this->add_related_files('calendar', 'event_description', 'event_description');
2012     }
2015 class restore_course_completion_structure_step extends restore_structure_step {
2017     /**
2018      * Conditionally decide if this step should be executed.
2019      *
2020      * This function checks parameters that are not immediate settings to ensure
2021      * that the enviroment is suitable for the restore of course completion info.
2022      *
2023      * This function checks the following four parameters:
2024      *
2025      *   1. Course completion is enabled on the site
2026      *   2. The backup includes course completion information
2027      *   3. All modules are restorable
2028      *   4. All modules are marked for restore.
2029      *
2030      * @return bool True is safe to execute, false otherwise
2031      */
2032     protected function execute_condition() {
2033         global $CFG;
2035         // First check course completion is enabled on this site
2036         if (empty($CFG->enablecompletion)) {
2037             // Disabled, don't restore course completion
2038             return false;
2039         }
2041         // Check it is included in the backup
2042         $fullpath = $this->task->get_taskbasepath();
2043         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2044         if (!file_exists($fullpath)) {
2045             // Not found, can't restore course completion
2046             return false;
2047         }
2049         // Check we are able to restore all backed up modules
2050         if ($this->task->is_missing_modules()) {
2051             return false;
2052         }
2054         // Finally check all modules within the backup are being restored.
2055         if ($this->task->is_excluding_activities()) {
2056             return false;
2057         }
2059         return true;
2060     }
2062     /**
2063      * Define the course completion structure
2064      *
2065      * @return array Array of restore_path_element
2066      */
2067     protected function define_structure() {
2069         // To know if we are including user completion info
2070         $userinfo = $this->get_setting_value('userscompletion');
2072         $paths = array();
2073         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
2074         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
2076         if ($userinfo) {
2077             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
2078             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
2079         }
2081         return $paths;
2083     }
2085     /**
2086      * Process course completion criteria
2087      *
2088      * @global moodle_database $DB
2089      * @param stdClass $data
2090      */
2091     public function process_course_completion_criteria($data) {
2092         global $DB;
2094         $data = (object)$data;
2095         $data->course = $this->get_courseid();
2097         // Apply the date offset to the time end field
2098         $data->timeend = $this->apply_date_offset($data->timeend);
2100         // Map the role from the criteria
2101         if (!empty($data->role)) {
2102             $data->role = $this->get_mappingid('role', $data->role);
2103         }
2105         $skipcriteria = false;
2107         // If the completion criteria is for a module we need to map the module instance
2108         // to the new module id.
2109         if (!empty($data->moduleinstance) && !empty($data->module)) {
2110             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
2111             if (empty($data->moduleinstance)) {
2112                 $skipcriteria = true;
2113             }
2114         } else {
2115             $data->module = null;
2116             $data->moduleinstance = null;
2117         }
2119         // We backup the course shortname rather than the ID so that we can match back to the course
2120         if (!empty($data->courseinstanceshortname)) {
2121             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
2122             if (!$courseinstanceid) {
2123                 $skipcriteria = true;
2124             }
2125         } else {
2126             $courseinstanceid = null;
2127         }
2128         $data->courseinstance = $courseinstanceid;
2130         if (!$skipcriteria) {
2131             $params = array(
2132                 'course'         => $data->course,
2133                 'criteriatype'   => $data->criteriatype,
2134                 'enrolperiod'    => $data->enrolperiod,
2135                 'courseinstance' => $data->courseinstance,
2136                 'module'         => $data->module,
2137                 'moduleinstance' => $data->moduleinstance,
2138                 'timeend'        => $data->timeend,
2139                 'gradepass'      => $data->gradepass,
2140                 'role'           => $data->role
2141             );
2142             $newid = $DB->insert_record('course_completion_criteria', $params);
2143             $this->set_mapping('course_completion_criteria', $data->id, $newid);
2144         }
2145     }
2147     /**
2148      * Processes course compltion criteria complete records
2149      *
2150      * @global moodle_database $DB
2151      * @param stdClass $data
2152      */
2153     public function process_course_completion_crit_compl($data) {
2154         global $DB;
2156         $data = (object)$data;
2158         // This may be empty if criteria could not be restored
2159         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
2161         $data->course = $this->get_courseid();
2162         $data->userid = $this->get_mappingid('user', $data->userid);
2164         if (!empty($data->criteriaid) && !empty($data->userid)) {
2165             $params = array(
2166                 'userid' => $data->userid,
2167                 'course' => $data->course,
2168                 'criteriaid' => $data->criteriaid,
2169                 'timecompleted' => $this->apply_date_offset($data->timecompleted)
2170             );
2171             if (isset($data->gradefinal)) {
2172                 $params['gradefinal'] = $data->gradefinal;
2173             }
2174             if (isset($data->unenroled)) {
2175                 $params['unenroled'] = $data->unenroled;
2176             }
2177             $DB->insert_record('course_completion_crit_compl', $params);
2178         }
2179     }
2181     /**
2182      * Process course completions
2183      *
2184      * @global moodle_database $DB
2185      * @param stdClass $data
2186      */
2187     public function process_course_completions($data) {
2188         global $DB;
2190         $data = (object)$data;
2192         $data->course = $this->get_courseid();
2193         $data->userid = $this->get_mappingid('user', $data->userid);
2195         if (!empty($data->userid)) {
2196             $params = array(
2197                 'userid' => $data->userid,
2198                 'course' => $data->course,
2199                 'timeenrolled' => $this->apply_date_offset($data->timeenrolled),
2200                 'timestarted' => $this->apply_date_offset($data->timestarted),
2201                 'timecompleted' => $this->apply_date_offset($data->timecompleted),
2202                 'reaggregate' => $data->reaggregate
2203             );
2204             $DB->insert_record('course_completions', $params);
2205         }
2206     }
2208     /**
2209      * Process course completion aggregate methods
2210      *
2211      * @global moodle_database $DB
2212      * @param stdClass $data
2213      */
2214     public function process_course_completion_aggr_methd($data) {
2215         global $DB;
2217         $data = (object)$data;
2219         $data->course = $this->get_courseid();
2221         // Only create the course_completion_aggr_methd records if
2222         // the target course has not them defined. MDL-28180
2223         if (!$DB->record_exists('course_completion_aggr_methd', array(
2224                     'course' => $data->course,
2225                     'criteriatype' => $data->criteriatype))) {
2226             $params = array(
2227                 'course' => $data->course,
2228                 'criteriatype' => $data->criteriatype,
2229                 'method' => $data->method,
2230                 'value' => $data->value,
2231             );
2232             $DB->insert_record('course_completion_aggr_methd', $params);
2233         }
2234     }
2238 /**
2239  * This structure step restores course logs (cmid = 0), delegating
2240  * the hard work to the corresponding {@link restore_logs_processor} passing the
2241  * collection of {@link restore_log_rule} rules to be observed as they are defined
2242  * by the task. Note this is only executed based in the 'logs' setting.
2243  *
2244  * NOTE: This is executed by final task, to have all the activities already restored
2245  *
2246  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
2247  * records are. There are others like 'calendar' and 'upload' that will be handled
2248  * later.
2249  *
2250  * NOTE: All the missing actions (not able to be restored) are sent to logs for
2251  * debugging purposes
2252  */
2253 class restore_course_logs_structure_step extends restore_structure_step {
2255     /**
2256      * Conditionally decide if this step should be executed.
2257      *
2258      * This function checks the following parameter:
2259      *
2260      *   1. the course/logs.xml file exists
2261      *
2262      * @return bool true is safe to execute, false otherwise
2263      */
2264     protected function execute_condition() {
2266         // Check it is included in the backup
2267         $fullpath = $this->task->get_taskbasepath();
2268         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2269         if (!file_exists($fullpath)) {
2270             // Not found, can't restore course logs
2271             return false;
2272         }
2274         return true;
2275     }
2277     protected function define_structure() {
2279         $paths = array();
2281         // Simple, one plain level of information contains them
2282         $paths[] = new restore_path_element('log', '/logs/log');
2284         return $paths;
2285     }
2287     protected function process_log($data) {
2288         global $DB;
2290         $data = (object)($data);
2292         $data->time = $this->apply_date_offset($data->time);
2293         $data->userid = $this->get_mappingid('user', $data->userid);
2294         $data->course = $this->get_courseid();
2295         $data->cmid = 0;
2297         // For any reason user wasn't remapped ok, stop processing this
2298         if (empty($data->userid)) {
2299             return;
2300         }
2302         // Everything ready, let's delegate to the restore_logs_processor
2304         // Set some fixed values that will save tons of DB requests
2305         $values = array(
2306             'course' => $this->get_courseid());
2307         // Get instance and process log record
2308         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2310         // If we have data, insert it, else something went wrong in the restore_logs_processor
2311         if ($data) {
2312             $DB->insert_record('log', $data);
2313         }
2314     }
2317 /**
2318  * This structure step restores activity logs, extending {@link restore_course_logs_structure_step}
2319  * sharing its same structure but modifying the way records are handled
2320  */
2321 class restore_activity_logs_structure_step extends restore_course_logs_structure_step {
2323     protected function process_log($data) {
2324         global $DB;
2326         $data = (object)($data);
2328         $data->time = $this->apply_date_offset($data->time);
2329         $data->userid = $this->get_mappingid('user', $data->userid);
2330         $data->course = $this->get_courseid();
2331         $data->cmid = $this->task->get_moduleid();
2333         // For any reason user wasn't remapped ok, stop processing this
2334         if (empty($data->userid)) {
2335             return;
2336         }
2338         // Everything ready, let's delegate to the restore_logs_processor
2340         // Set some fixed values that will save tons of DB requests
2341         $values = array(
2342             'course' => $this->get_courseid(),
2343             'course_module' => $this->task->get_moduleid(),
2344             $this->task->get_modulename() => $this->task->get_activityid());
2345         // Get instance and process log record
2346         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2348         // If we have data, insert it, else something went wrong in the restore_logs_processor
2349         if ($data) {
2350             $DB->insert_record('log', $data);
2351         }
2352     }
2356 /**
2357  * Defines the restore step for advanced grading methods attached to the activity module
2358  */
2359 class restore_activity_grading_structure_step extends restore_structure_step {
2361     /**
2362      * This step is executed only if the grading file is present
2363      */
2364      protected function execute_condition() {
2366         $fullpath = $this->task->get_taskbasepath();
2367         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2368         if (!file_exists($fullpath)) {
2369             return false;
2370         }
2372         return true;
2373     }
2376     /**
2377      * Declares paths in the grading.xml file we are interested in
2378      */
2379     protected function define_structure() {
2381         $paths = array();
2382         $userinfo = $this->get_setting_value('userinfo');
2384         $area = new restore_path_element('grading_area', '/areas/area');
2385         $paths[] = $area;
2386         // attach local plugin stucture to $area element
2387         $this->add_plugin_structure('local', $area);
2389         $definition = new restore_path_element('grading_definition', '/areas/area/definitions/definition');
2390         $paths[] = $definition;
2391         $this->add_plugin_structure('gradingform', $definition);
2392         // attach local plugin stucture to $definition element
2393         $this->add_plugin_structure('local', $definition);
2396         if ($userinfo) {
2397             $instance = new restore_path_element('grading_instance',
2398                 '/areas/area/definitions/definition/instances/instance');
2399             $paths[] = $instance;
2400             $this->add_plugin_structure('gradingform', $instance);
2401             // attach local plugin stucture to $intance element
2402             $this->add_plugin_structure('local', $instance);
2403         }
2405         return $paths;
2406     }
2408     /**
2409      * Processes one grading area element
2410      *
2411      * @param array $data element data
2412      */
2413     protected function process_grading_area($data) {
2414         global $DB;
2416         $task = $this->get_task();
2417         $data = (object)$data;
2418         $oldid = $data->id;
2419         $data->component = 'mod_'.$task->get_modulename();
2420         $data->contextid = $task->get_contextid();
2422         $newid = $DB->insert_record('grading_areas', $data);
2423         $this->set_mapping('grading_area', $oldid, $newid);
2424     }
2426     /**
2427      * Processes one grading definition element
2428      *
2429      * @param array $data element data
2430      */
2431     protected function process_grading_definition($data) {
2432         global $DB;
2434         $task = $this->get_task();
2435         $data = (object)$data;
2436         $oldid = $data->id;
2437         $data->areaid = $this->get_new_parentid('grading_area');
2438         $data->copiedfromid = null;
2439         $data->timecreated = time();
2440         $data->usercreated = $task->get_userid();
2441         $data->timemodified = $data->timecreated;
2442         $data->usermodified = $data->usercreated;
2444         $newid = $DB->insert_record('grading_definitions', $data);
2445         $this->set_mapping('grading_definition', $oldid, $newid, true);
2446     }
2448     /**
2449      * Processes one grading form instance element
2450      *
2451      * @param array $data element data
2452      */
2453     protected function process_grading_instance($data) {
2454         global $DB;
2456         $data = (object)$data;
2458         // new form definition id
2459         $newformid = $this->get_new_parentid('grading_definition');
2461         // get the name of the area we are restoring to
2462         $sql = "SELECT ga.areaname
2463                   FROM {grading_definitions} gd
2464                   JOIN {grading_areas} ga ON gd.areaid = ga.id
2465                  WHERE gd.id = ?";
2466         $areaname = $DB->get_field_sql($sql, array($newformid), MUST_EXIST);
2468         // get the mapped itemid - the activity module is expected to define the mappings
2469         // for each gradable area
2470         $newitemid = $this->get_mappingid(restore_gradingform_plugin::itemid_mapping($areaname), $data->itemid);
2472         $oldid = $data->id;
2473         $data->definitionid = $newformid;
2474         $data->raterid = $this->get_mappingid('user', $data->raterid);
2475         $data->itemid = $newitemid;
2477         $newid = $DB->insert_record('grading_instances', $data);
2478         $this->set_mapping('grading_instance', $oldid, $newid);
2479     }
2481     /**
2482      * Final operations when the database records are inserted
2483      */
2484     protected function after_execute() {
2485         // Add files embedded into the definition description
2486         $this->add_related_files('grading', 'description', 'grading_definition');
2487     }
2491 /**
2492  * This structure step restores the grade items associated with one activity
2493  * All the grade items are made child of the "course" grade item but the original
2494  * categoryid is saved as parentitemid in the backup_ids table, so, when restoring
2495  * the complete gradebook (categories and calculations), that information is
2496  * available there
2497  */
2498 class restore_activity_grades_structure_step extends restore_structure_step {
2500     protected function define_structure() {
2502         $paths = array();
2503         $userinfo = $this->get_setting_value('userinfo');
2505         $paths[] = new restore_path_element('grade_item', '/activity_gradebook/grade_items/grade_item');
2506         $paths[] = new restore_path_element('grade_letter', '/activity_gradebook/grade_letters/grade_letter');
2507         if ($userinfo) {
2508             $paths[] = new restore_path_element('grade_grade',
2509                            '/activity_gradebook/grade_items/grade_item/grade_grades/grade_grade');
2510         }
2511         return $paths;
2512     }
2514     protected function process_grade_item($data) {
2515         global $DB;
2517         $data = (object)($data);
2518         $oldid       = $data->id;        // We'll need these later
2519         $oldparentid = $data->categoryid;
2520         $courseid = $this->get_courseid();
2522         // make sure top course category exists, all grade items will be associated
2523         // to it. Later, if restoring the whole gradebook, categories will be introduced
2524         $coursecat = grade_category::fetch_course_category($courseid);
2525         $coursecatid = $coursecat->id; // Get the categoryid to be used
2527         $idnumber = null;
2528         if (!empty($data->idnumber)) {
2529             // Don't get any idnumber from course module. Keep them as they are in grade_item->idnumber
2530             // Reason: it's not clear what happens with outcomes->idnumber or activities with multiple items (workshop)
2531             // so the best is to keep the ones already in the gradebook
2532             // Potential problem: duplicates if same items are restored more than once. :-(
2533             // This needs to be fixed in some way (outcomes & activities with multiple items)
2534             // $data->idnumber     = get_coursemodule_from_instance($data->itemmodule, $data->iteminstance)->idnumber;
2535             // In any case, verify always for uniqueness
2536             $sql = "SELECT cm.id
2537                       FROM {course_modules} cm
2538                      WHERE cm.course = :courseid AND
2539                            cm.idnumber = :idnumber AND
2540                            cm.id <> :cmid";
2541             $params = array(
2542                 'courseid' => $courseid,
2543                 'idnumber' => $data->idnumber,
2544                 'cmid' => $this->task->get_moduleid()
2545             );
2546             if (!$DB->record_exists_sql($sql, $params) && !$DB->record_exists('grade_items', array('courseid' => $courseid, 'idnumber' => $data->idnumber))) {
2547                 $idnumber = $data->idnumber;
2548             }
2549         }
2551         unset($data->id);
2552         $data->categoryid   = $coursecatid;
2553         $data->courseid     = $this->get_courseid();
2554         $data->iteminstance = $this->task->get_activityid();
2555         $data->idnumber     = $idnumber;
2556         $data->scaleid      = $this->get_mappingid('scale', $data->scaleid);
2557         $data->outcomeid    = $this->get_mappingid('outcome', $data->outcomeid);
2558         $data->timecreated  = $this->apply_date_offset($data->timecreated);
2559         $data->timemodified = $this->apply_date_offset($data->timemodified);
2561         $gradeitem = new grade_item($data, false);
2562         $gradeitem->insert('restore');
2564         //sortorder is automatically assigned when inserting. Re-instate the previous sortorder
2565         $gradeitem->sortorder = $data->sortorder;
2566         $gradeitem->update('restore');
2568         // Set mapping, saving the original category id into parentitemid
2569         // gradebook restore (final task) will need it to reorganise items
2570         $this->set_mapping('grade_item', $oldid, $gradeitem->id, false, null, $oldparentid);
2571     }
2573     protected function process_grade_grade($data) {
2574         $data = (object)($data);
2575         $olduserid = $data->userid;
2576         unset($data->id);
2578         $data->itemid = $this->get_new_parentid('grade_item');
2580         $data->userid = $this->get_mappingid('user', $data->userid, null);
2581         if (!empty($data->userid)) {
2582             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
2583             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
2584             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
2585             $data->overridden = $this->apply_date_offset($data->overridden);
2587             $grade = new grade_grade($data, false);
2588             $grade->insert('restore');
2589             // no need to save any grade_grade mapping
2590         } else {
2591             debugging("Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'");
2592         }
2593     }
2595     /**
2596      * process activity grade_letters. Note that, while these are possible,
2597      * because grade_letters are contextid based, in practice, only course
2598      * context letters can be defined. So we keep here this method knowing
2599      * it won't be executed ever. gradebook restore will restore course letters.
2600      */
2601     protected function process_grade_letter($data) {
2602         global $DB;
2604         $data['contextid'] = $this->task->get_contextid();
2605         $gradeletter = (object)$data;
2607         // Check if it exists before adding it
2608         unset($data['id']);
2609         if (!$DB->record_exists('grade_letters', $data)) {
2610             $newitemid = $DB->insert_record('grade_letters', $gradeletter);
2611         }
2612         // no need to save any grade_letter mapping
2613     }
2617 /**
2618  * This structure steps restores one instance + positions of one block
2619  * Note: Positions corresponding to one existing context are restored
2620  * here, but all the ones having unknown contexts are sent to backup_ids
2621  * for a later chance to be restored at the end (final task)
2622  */
2623 class restore_block_instance_structure_step extends restore_structure_step {
2625     protected function define_structure() {
2627         $paths = array();
2629         $paths[] = new restore_path_element('block', '/block', true); // Get the whole XML together
2630         $paths[] = new restore_path_element('block_position', '/block/block_positions/block_position');
2632         return $paths;
2633     }
2635     public function process_block($data) {
2636         global $DB, $CFG;
2638         $data = (object)$data; // Handy
2639         $oldcontextid = $data->contextid;
2640         $oldid        = $data->id;
2641         $positions = isset($data->block_positions['block_position']) ? $data->block_positions['block_position'] : array();
2643         // Look for the parent contextid
2644         if (!$data->parentcontextid = $this->get_mappingid('context', $data->parentcontextid)) {
2645             throw new restore_step_exception('restore_block_missing_parent_ctx', $data->parentcontextid);
2646         }
2648         // TODO: it would be nice to use standard plugin supports instead of this instance_allow_multiple()
2649         // If there is already one block of that type in the parent context
2650         // and the block is not multiple, stop processing
2651         // Use blockslib loader / method executor
2652         if (!$bi = block_instance($data->blockname)) {
2653             return false;
2654         }
2656         if (!$bi->instance_allow_multiple()) {
2657             if ($DB->record_exists_sql("SELECT bi.id
2658                                           FROM {block_instances} bi
2659                                           JOIN {block} b ON b.name = bi.blockname
2660                                          WHERE bi.parentcontextid = ?
2661                                            AND bi.blockname = ?", array($data->parentcontextid, $data->blockname))) {
2662                 return false;
2663             }
2664         }
2666         // If there is already one block of that type in the parent context
2667         // with the same showincontexts, pagetypepattern, subpagepattern, defaultregion and configdata
2668         // stop processing
2669         $params = array(
2670             'blockname' => $data->blockname, 'parentcontextid' => $data->parentcontextid,
2671             'showinsubcontexts' => $data->showinsubcontexts, 'pagetypepattern' => $data->pagetypepattern,
2672             'subpagepattern' => $data->subpagepattern, 'defaultregion' => $data->defaultregion);
2673         if ($birecs = $DB->get_records('block_instances', $params)) {
2674             foreach($birecs as $birec) {
2675                 if ($birec->configdata == $data->configdata) {
2676                     return false;
2677                 }
2678             }
2679         }
2681         // Set task old contextid, blockid and blockname once we know them
2682         $this->task->set_old_contextid($oldcontextid);
2683         $this->task->set_old_blockid($oldid);
2684         $this->task->set_blockname($data->blockname);
2686         // Let's look for anything within configdata neededing processing
2687         // (nulls and uses of legacy file.php)
2688         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
2689             $configdata = (array)unserialize(base64_decode($data->configdata));
2690             foreach ($configdata as $attribute => $value) {
2691                 if (in_array($attribute, $attrstotransform)) {
2692                     $configdata[$attribute] = $this->contentprocessor->process_cdata($value);
2693                 }
2694             }
2695             $data->configdata = base64_encode(serialize((object)$configdata));
2696         }
2698         // Create the block instance
2699         $newitemid = $DB->insert_record('block_instances', $data);
2700         // Save the mapping (with restorefiles support)
2701         $this->set_mapping('block_instance', $oldid, $newitemid, true);
2702         // Create the block context
2703         $newcontextid = context_block::instance($newitemid)->id;
2704         // Save the block contexts mapping and sent it to task
2705         $this->set_mapping('context', $oldcontextid, $newcontextid);
2706         $this->task->set_contextid($newcontextid);
2707         $this->task->set_blockid($newitemid);
2709         // Restore block fileareas if declared
2710         $component = 'block_' . $this->task->get_blockname();
2711         foreach ($this->task->get_fileareas() as $filearea) { // Simple match by contextid. No itemname needed
2712             $this->add_related_files($component, $filearea, null);
2713         }
2715         // Process block positions, creating them or accumulating for final step
2716         foreach($positions as $position) {
2717             $position = (object)$position;
2718             $position->blockinstanceid = $newitemid; // The instance is always the restored one
2719             // If position is for one already mapped (known) contextid
2720             // process it now, creating the position
2721             if ($newpositionctxid = $this->get_mappingid('context', $position->contextid)) {
2722                 $position->contextid = $newpositionctxid;
2723                 // Create the block position
2724                 $DB->insert_record('block_positions', $position);
2726             // The position belongs to an unknown context, send it to backup_ids
2727             // to process them as part of the final steps of restore. We send the
2728             // whole $position object there, hence use the low level method.
2729             } else {
2730                 restore_dbops::set_backup_ids_record($this->get_restoreid(), 'block_position', $position->id, 0, null, $position);
2731             }
2732         }
2733     }
2736 /**
2737  * Structure step to restore common course_module information
2738  *
2739  * This step will process the module.xml file for one activity, in order to restore
2740  * the corresponding information to the course_modules table, skipping various bits
2741  * of information based on CFG settings (groupings, completion...) in order to fullfill
2742  * all the reqs to be able to create the context to be used by all the rest of steps
2743  * in the activity restore task
2744  */
2745 class restore_module_structure_step extends restore_structure_step {
2747     protected function define_structure() {
2748         global $CFG;
2750         $paths = array();
2752         $module = new restore_path_element('module', '/module');
2753         $paths[] = $module;
2754         if ($CFG->enableavailability) {
2755             $paths[] = new restore_path_element('availability', '/module/availability_info/availability');
2756             $paths[] = new restore_path_element('availability_field', '/module/availability_info/availability_field');
2757         }
2759         // Apply for 'format' plugins optional paths at module level
2760         $this->add_plugin_structure('format', $module);
2762         // Apply for 'plagiarism' plugins optional paths at module level
2763         $this->add_plugin_structure('plagiarism', $module);
2765         // Apply for 'local' plugins optional paths at module level
2766         $this->add_plugin_structure('local', $module);
2768         return $paths;
2769     }
2771     protected function process_module($data) {
2772         global $CFG, $DB;
2774         $data = (object)$data;
2775         $oldid = $data->id;
2776         $this->task->set_old_moduleversion($data->version);
2778         $data->course = $this->task->get_courseid();
2779         $data->module = $DB->get_field('modules', 'id', array('name' => $data->modulename));
2780         // Map section (first try by course_section mapping match. Useful in course and section restores)
2781         $data->section = $this->get_mappingid('course_section', $data->sectionid);
2782         if (!$data->section) { // mapping failed, try to get section by sectionnumber matching
2783             $params = array(
2784                 'course' => $this->get_courseid(),
2785                 'section' => $data->sectionnumber);
2786             $data->section = $DB->get_field('course_sections', 'id', $params);
2787         }
2788         if (!$data->section) { // sectionnumber failed, try to get first section in course
2789             $params = array(
2790                 'course' => $this->get_courseid());
2791             $data->section = $DB->get_field('course_sections', 'MIN(id)', $params);
2792         }
2793         if (!$data->section) { // no sections in course, create section 0 and 1 and assign module to 1
2794             $sectionrec = array(
2795                 'course' => $this->get_courseid(),
2796                 'section' => 0);
2797             $DB->insert_record('course_sections', $sectionrec); // section 0
2798             $sectionrec = array(
2799                 'course' => $this->get_courseid(),
2800                 'section' => 1);
2801             $data->section = $DB->insert_record('course_sections', $sectionrec); // section 1
2802         }
2803         $data->groupingid= $this->get_mappingid('grouping', $data->groupingid);      // grouping
2804         if (!$CFG->enablegroupmembersonly) {                                         // observe groupsmemberonly
2805             $data->groupmembersonly = 0;
2806         }
2807         if (!grade_verify_idnumber($data->idnumber, $this->get_courseid())) {        // idnumber uniqueness
2808             $data->idnumber = '';
2809         }
2810         if (empty($CFG->enablecompletion)) { // completion
2811             $data->completion = 0;
2812             $data->completiongradeitemnumber = null;
2813             $data->completionview = 0;
2814             $data->completionexpected = 0;
2815         } else {
2816             $data->completionexpected = $this->apply_date_offset($data->completionexpected);
2817         }
2818         if (empty($CFG->enableavailability)) {
2819             $data->availablefrom = 0;
2820             $data->availableuntil = 0;
2821             $data->showavailability = 0;
2822         } else {
2823             $data->availablefrom = $this->apply_date_offset($data->availablefrom);
2824             $data->availableuntil= $this->apply_date_offset($data->availableuntil);
2825         }
2826         // Backups that did not include showdescription, set it to default 0
2827         // (this is not totally necessary as it has a db default, but just to
2828         // be explicit).
2829         if (!isset($data->showdescription)) {
2830             $data->showdescription = 0;
2831         }
2832         $data->instance = 0; // Set to 0 for now, going to create it soon (next step)
2834         // course_module record ready, insert it
2835         $newitemid = $DB->insert_record('course_modules', $data);
2836         // save mapping
2837         $this->set_mapping('course_module', $oldid, $newitemid);
2838         // set the new course_module id in the task
2839         $this->task->set_moduleid($newitemid);
2840         // we can now create the context safely
2841         $ctxid = context_module::instance($newitemid)->id;
2842         // set the new context id in the task
2843         $this->task->set_contextid($ctxid);
2844         // update sequence field in course_section
2845         if ($sequence = $DB->get_field('course_sections', 'sequence', array('id' => $data->section))) {
2846             $sequence .= ',' . $newitemid;
2847         } else {
2848             $sequence = $newitemid;
2849         }
2850         $DB->set_field('course_sections', 'sequence', $sequence, array('id' => $data->section));
2851     }
2853     protected function process_availability($data) {
2854         $data = (object)$data;
2855         // Simply going to store the whole availability record now, we'll process
2856         // all them later in the final task (once all activities have been restored)
2857         // Let's call the low level one to be able to store the whole object
2858         $data->coursemoduleid = $this->task->get_moduleid(); // Let add the availability cmid
2859         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'module_availability', $data->id, 0, null, $data);
2860     }
2862     protected function process_availability_field($data) {
2863         global $DB;
2864         $data = (object)$data;
2865         // Mark it is as passed by default
2866         $passed = true;
2867         $customfieldid = null;
2869         // If a customfield has been used in order to pass we must be able to match an existing
2870         // customfield by name (data->customfield) and type (data->customfieldtype)
2871         if (!empty($data->customfield) xor !empty($data->customfieldtype)) {
2872             // xor is sort of uncommon. If either customfield is null or customfieldtype is null BUT not both.
2873             // If one is null but the other isn't something clearly went wrong and we'll skip this condition.
2874             $passed = false;
2875         } else if (!empty($data->customfield)) {
2876             $params = array('shortname' => $data->customfield, 'datatype' => $data->customfieldtype);
2877             $customfieldid = $DB->get_field('user_info_field', 'id', $params);
2878             $passed = ($customfieldid !== false);
2879         }
2881         if ($passed) {
2882             // Create the object to insert into the database
2883             $availfield = new stdClass();
2884             $availfield->coursemoduleid = $this->task->get_moduleid(); // Lets add the availability cmid
2885             $availfield->userfield = $data->userfield;
2886             $availfield->customfieldid = $customfieldid;
2887             $availfield->operator = $data->operator;
2888             $availfield->value = $data->value;
2889             // Insert into the database
2890             $DB->insert_record('course_modules_avail_fields', $availfield);
2891         }
2892     }
2895 /**
2896  * Structure step that will process the user activity completion
2897  * information if all these conditions are met:
2898  *  - Target site has completion enabled ($CFG->enablecompletion)
2899  *  - Activity includes completion info (file_exists)
2900  */
2901 class restore_userscompletion_structure_step extends restore_structure_step {
2902     /**
2903      * To conditionally decide if this step must be executed
2904      * Note the "settings" conditions are evaluated in the
2905      * corresponding task. Here we check for other conditions
2906      * not being restore settings (files, site settings...)
2907      */
2908      protected function execute_condition() {
2909          global $CFG;
2911          // Completion disabled in this site, don't execute
2912          if (empty($CFG->enablecompletion)) {
2913              return false;
2914          }
2916          // No user completion info found, don't execute
2917         $fullpath = $this->task->get_taskbasepath();
2918         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2919          if (!file_exists($fullpath)) {
2920              return false;
2921          }
2923          // Arrived here, execute the step
2924          return true;
2925      }
2927      protected function define_structure() {
2929         $paths = array();
2931         $paths[] = new restore_path_element('completion', '/completions/completion');
2933         return $paths;
2934     }
2936     protected function process_completion($data) {
2937         global $DB;
2939         $data = (object)$data;
2941         $data->coursemoduleid = $this->task->get_moduleid();
2942         $data->userid = $this->get_mappingid('user', $data->userid);
2943         $data->timemodified = $this->apply_date_offset($data->timemodified);
2945         // Find the existing record
2946         $existing = $DB->get_record('course_modules_completion', array(
2947                 'coursemoduleid' => $data->coursemoduleid,
2948                 'userid' => $data->userid), 'id, timemodified');
2949         // Check we didn't already insert one for this cmid and userid
2950         // (there aren't supposed to be duplicates in that field, but
2951         // it was possible until MDL-28021 was fixed).
2952         if ($existing) {
2953             // Update it to these new values, but only if the time is newer
2954             if ($existing->timemodified < $data->timemodified) {
2955                 $data->id = $existing->id;
2956                 $DB->update_record('course_modules_completion', $data);
2957             }
2958         } else {
2959             // Normal entry where it doesn't exist already
2960             $DB->insert_record('course_modules_completion', $data);
2961         }
2962     }
2965 /**
2966  * Abstract structure step, parent of all the activity structure steps. Used to suuport
2967  * the main <activity ...> tag and process it. Also provides subplugin support for
2968  * activities.
2969  */
2970 abstract class restore_activity_structure_step extends restore_structure_step {
2972     protected function add_subplugin_structure($subplugintype, $element) {
2974         global $CFG;
2976         // Check the requested subplugintype is a valid one
2977         $subpluginsfile = $CFG->dirroot . '/mod/' . $this->task->get_modulename() . '/db/subplugins.php';
2978         if (!file_exists($subpluginsfile)) {
2979              throw new restore_step_exception('activity_missing_subplugins_php_file', $this->task->get_modulename());
2980         }
2981         include($subpluginsfile);
2982         if (!array_key_exists($subplugintype, $subplugins)) {
2983              throw new restore_step_exception('incorrect_subplugin_type', $subplugintype);
2984         }
2985         // Get all the restore path elements, looking across all the subplugin dirs
2986         $subpluginsdirs = get_plugin_list($subplugintype);
2987         foreach ($subpluginsdirs as $name => $subpluginsdir) {
2988             $classname = 'restore_' . $subplugintype . '_' . $name . '_subplugin';
2989             $restorefile = $subpluginsdir . '/backup/moodle2/' . $classname . '.class.php';
2990             if (file_exists($restorefile)) {
2991                 require_once($restorefile);
2992                 $restoresubplugin = new $classname($subplugintype, $name, $this);
2993                 // Add subplugin paths to the step
2994                 $this->prepare_pathelements($restoresubplugin->define_subplugin_structure($element));
2995             }
2996         }
2997     }
2999     /**
3000      * As far as activity restore steps are implementing restore_subplugin stuff, they need to
3001      * have the parent task available for wrapping purposes (get course/context....)
3002      * @return restore_task
3003      */
3004     public function get_task() {
3005         return $this->task;
3006     }
3008     /**
3009      * Adds support for the 'activity' path that is common to all the activities
3010      * and will be processed globally here
3011      */
3012     protected function prepare_activity_structure($paths) {
3014         $paths[] = new restore_path_element('activity', '/activity');
3016         return $paths;
3017     }
3019     /**
3020      * Process the activity path, informing the task about various ids, needed later
3021      */
3022     protected function process_activity($data) {
3023         $data = (object)$data;
3024         $this->task->set_old_contextid($data->contextid); // Save old contextid in task
3025         $this->set_mapping('context', $data->contextid, $this->task->get_contextid()); // Set the mapping
3026         $this->task->set_old_activityid($data->id); // Save old activityid in task
3027     }
3029     /**
3030      * This must be invoked immediately after creating the "module" activity record (forum, choice...)
3031      * and will adjust the new activity id (the instance) in various places
3032      */
3033     protected function apply_activity_instance($newitemid) {
3034         global $DB;
3036         $this->task->set_activityid($newitemid); // Save activity id in task
3037         // Apply the id to course_sections->instanceid
3038         $DB->set_field('course_modules', 'instance', $newitemid, array('id' => $this->task->get_moduleid()));
3039         // Do the mapping for modulename, preparing it for files by oldcontext
3040         $modulename = $this->task->get_modulename();
3041         $oldid = $this->task->get_old_activityid();
3042         $this->set_mapping($modulename, $oldid, $newitemid, true);
3043     }
3046 /**
3047  * Structure step in charge of creating/mapping all the qcats and qs
3048  * by parsing the questions.xml file and checking it against the
3049  * results calculated by {@link restore_process_categories_and_questions}
3050  * and stored in backup_ids_temp
3051  */
3052 class restore_create_categories_and_questions extends restore_structure_step {
3054     protected function define_structure() {
3056         $category = new restore_path_element('question_category', '/question_categories/question_category');
3057         $question = new restore_path_element('question', '/question_categories/question_category/questions/question');
3058         $hint = new restore_path_element('question_hint',
3059                 '/question_categories/question_category/questions/question/question_hints/question_hint');
3061         // Apply for 'qtype' plugins optional paths at question level
3062         $this->add_plugin_structure('qtype', $question);
3064         // Apply for 'local' plugins optional paths at question level
3065         $this->add_plugin_structure('local', $question);
3067         return array($category, $question, $hint);
3068     }
3070     protected function process_question_category($data) {
3071         global $DB;
3073         $data = (object)$data;
3074         $oldid = $data->id;
3076         // Check we have one mapping for this category
3077         if (!$mapping = $this->get_mapping('question_category', $oldid)) {
3078             return self::SKIP_ALL_CHILDREN; // No mapping = this category doesn't need to be created/mapped
3079         }
3081         // Check we have to create the category (newitemid = 0)
3082         if ($mapping->newitemid) {
3083             return; // newitemid != 0, this category is going to be mapped. Nothing to do
3084         }
3086         // Arrived here, newitemid = 0, we need to create the category
3087         // we'll do it at parentitemid context, but for CONTEXT_MODULE
3088         // categories, that will be created at CONTEXT_COURSE and moved
3089         // to module context later when the activity is created
3090         if ($mapping->info->contextlevel == CONTEXT_MODULE) {
3091             $mapping->parentitemid = $this->get_mappingid('context', $this->task->get_old_contextid());
3092         }
3093         $data->contextid = $mapping->parentitemid;
3095         // Let's create the question_category and save mapping
3096         $newitemid = $DB->insert_record('question_categories', $data);
3097         $this->set_mapping('question_category', $oldid, $newitemid);
3098         // Also annotate them as question_category_created, we need
3099         // that later when remapping parents
3100         $this->set_mapping('question_category_created', $oldid, $newitemid, false, null, $data->contextid);
3101     }
3103     protected function process_question($data) {
3104         global $DB;
3106         $data = (object)$data;
3107         $oldid = $data->id;
3109         // Check we have one mapping for this question
3110         if (!$questionmapping = $this->get_mapping('question', $oldid)) {
3111             return; // No mapping = this question doesn't need to be created/mapped
3112         }
3114         // Get the mapped category (cannot use get_new_parentid() because not
3115         // all the categories have been created, so it is not always available
3116         // Instead we get the mapping for the question->parentitemid because
3117         // we have loaded qcatids there for all parsed questions
3118         $data->category = $this->get_mappingid('question_category', $questionmapping->parentitemid);
3120         // In the past, there were some very sloppy values of penalty. Fix them.
3121         if ($data->penalty >= 0.33 && $data->penalty <= 0.34) {
3122             $data->penalty = 0.3333333;
3123         }
3124         if ($data->penalty >= 0.66 && $data->penalty <= 0.67) {
3125             $data->penalty = 0.6666667;
3126         }
3127         if ($data->penalty >= 1) {
3128             $data->penalty = 1;
3129         }
3131         $userid = $this->get_mappingid('user', $data->createdby);
3132         $data->createdby = $userid ? $userid : $this->task->get_userid();
3134         $userid = $this->get_mappingid('user', $data->modifiedby);
3135         $data->modifiedby = $userid ? $userid : $this->task->get_userid();
3137         // With newitemid = 0, let's create the question
3138         if (!$questionmapping->newitemid) {
3139             $newitemid = $DB->insert_record('question', $data);
3140             $this->set_mapping('question', $oldid, $newitemid);
3141             // Also annotate them as question_created, we need
3142             // that later when remapping parents (keeping the old categoryid as parentid)
3143             $this->set_mapping('question_created', $oldid, $newitemid, false, null, $questionmapping->parentitemid);
3144         } else {
3145             // By performing this set_mapping() we make get_old/new_parentid() to work for all the
3146             // children elements of the 'question' one (so qtype plugins will know the question they belong to)
3147             $this->set_mapping('question', $oldid, $questionmapping->newitemid);
3148         }
3150         // Note, we don't restore any question files yet
3151         // as far as the CONTEXT_MODULE categories still
3152         // haven't their contexts to be restored to
3153         // The {@link restore_create_question_files}, executed in the final step
3154         // step will be in charge of restoring all the question files
3155     }
3157         protected function process_question_hint($data) {
3158         global $DB;
3160         $data = (object)$data;
3161         $oldid = $data->id;
3163         // Detect if the question is created or mapped
3164         $oldquestionid   = $this->get_old_parentid('question');
3165         $newquestionid   = $this->get_new_parentid('question');
3166         $questioncreated = $this->get_mappingid('question_created', $oldquestionid) ? true : false;
3168         // If the question has been created by restore, we need to create its question_answers too
3169         if ($questioncreated) {
3170             // Adjust some columns
3171             $data->questionid = $newquestionid;
3172             // Insert record
3173             $newitemid = $DB->insert_record('question_hints', $data);
3175         // The question existed, we need to map the existing question_hints
3176         } else {
3177             // Look in question_hints by hint text matching
3178             $sql = 'SELECT id
3179                       FROM {question_hints}
3180                      WHERE questionid = ?
3181                        AND ' . $DB->sql_compare_text('hint', 255) . ' = ' . $DB->sql_compare_text('?', 255);
3182             $params = array($newquestionid, $data->hint);
3183             $newitemid = $DB->get_field_sql($sql, $params);
3185             // Not able to find the hint, let's try cleaning the hint text
3186             // of all the question's hints in DB as slower fallback. MDL-33863.
3187             if (!$newitemid) {
3188                 $potentialhints = $DB->get_records('question_hints',
3189                         array('questionid' => $newquestionid), '', 'id, hint');
3190                 foreach ($potentialhints as $potentialhint) {
3191                     // Clean in the same way than {@link xml_writer::xml_safe_utf8()}.
3192                     $cleanhint = preg_replace('/[\x-\x8\xb-\xc\xe-\x1f\x7f]/is','', $potentialhint->hint); // Clean CTRL chars.
3193                     $cleanhint = preg_replace("/\r\n|\r/", "\n", $cleanhint); // Normalize line ending.
3194                     if ($cleanhint === $data->hint) {
3195                         $newitemid = $data->id;
3196                     }
3197                 }
3198             }
3200             // If we haven't found the newitemid, something has gone really wrong, question in DB
3201             // is missing hints, exception
3202             if (!$newitemid) {
3203                 $info = new stdClass();
3204                 $info->filequestionid = $oldquestionid;
3205                 $info->dbquestionid   = $newquestionid;
3206                 $info->hint           = $data->hint;
3207                 throw new restore_step_exception('error_question_hint_missing_in_db', $info);
3208             }
3209         }
3210         // Create mapping (I'm not sure if this is really needed?)
3211         $this->set_mapping('question_hint', $oldid, $newitemid);
3212     }
3214     protected function after_execute() {
3215         global $DB;
3217         // First of all, recode all the created question_categories->parent fields
3218         $qcats = $DB->get_records('backup_ids_temp', array(
3219                      'backupid' => $this->get_restoreid(),
3220                      'itemname' => 'question_category_created'));
3221         foreach ($qcats as $qcat) {
3222             $newparent = 0;
3223             $dbcat = $DB->get_record('question_categories', array('id' => $qcat->newitemid));
3224             // Get new parent (mapped or created, so we look in quesiton_category mappings)
3225             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
3226                                  'backupid' => $this->get_restoreid(),
3227                                  'itemname' => 'question_category',
3228                                  'itemid'   => $dbcat->parent))) {
3229                 // contextids must match always, as far as we always include complete qbanks, just check it
3230                 $newparentctxid = $DB->get_field('question_categories', 'contextid', array('id' => $newparent));
3231                 if ($dbcat->contextid == $newparentctxid) {
3232                     $DB->set_field('question_categories', 'parent', $newparent, array('id' => $dbcat->id));
3233                 } else {
3234                     $newparent = 0; // No ctx match for both cats, no parent relationship
3235                 }
3236             }
3237             // Here with $newparent empty, problem with contexts or remapping, set it to top cat
3238             if (!$newparent) {
3239                 $DB->set_field('question_categories', 'parent', 0, array('id' => $dbcat->id));
3240             }
3241         }
3243         // Now, recode all the created question->parent fields
3244         $qs = $DB->get_records('backup_ids_temp', array(
3245                   'backupid' => $this->get_restoreid(),
3246                   'itemname' => 'question_created'));
3247         foreach ($qs as $q) {