Merge branch 'MDL-37676_23_STABLE' of git://github.com/appalachianstate/moodle into...
[moodle.git] / backup / moodle2 / restore_stepslib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Defines various restore steps that will be used by common tasks in restore
20  *
21  * @package     core_backup
22  * @subpackage  moodle2
23  * @category    backup
24  * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
25  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 defined('MOODLE_INTERNAL') || die();
30 /**
31  * delete old directories and conditionally create backup_temp_ids table
32  */
33 class restore_create_and_clean_temp_stuff extends restore_execution_step {
35     protected function define_execution() {
36         $exists = restore_controller_dbops::create_restore_temp_tables($this->get_restoreid()); // temp tables conditionally
37         // If the table already exists, it's because restore_prechecks have been executed in the same
38         // request (without problems) and it already contains a bunch of preloaded information (users...)
39         // that we aren't going to execute again
40         if ($exists) { // Inform plan about preloaded information
41             $this->task->set_preloaded_information();
42         }
43         // Create the old-course-ctxid to new-course-ctxid mapping, we need that available since the beginning
44         $itemid = $this->task->get_old_contextid();
45         $newitemid = get_context_instance(CONTEXT_COURSE, $this->get_courseid())->id;
46         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'context', $itemid, $newitemid);
47         // Create the old-system-ctxid to new-system-ctxid mapping, we need that available since the beginning
48         $itemid = $this->task->get_old_system_contextid();
49         $newitemid = get_context_instance(CONTEXT_SYSTEM)->id;
50         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'context', $itemid, $newitemid);
51         // Create the old-course-id to new-course-id mapping, we need that available since the beginning
52         $itemid = $this->task->get_old_courseid();
53         $newitemid = $this->get_courseid();
54         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'course', $itemid, $newitemid);
56     }
57 }
59 /**
60  * delete the temp dir used by backup/restore (conditionally),
61  * delete old directories and drop temp ids table
62  */
63 class restore_drop_and_clean_temp_stuff extends restore_execution_step {
65     protected function define_execution() {
66         global $CFG;
67         restore_controller_dbops::drop_restore_temp_tables($this->get_restoreid()); // Drop ids temp table
68         backup_helper::delete_old_backup_dirs(time() - (4 * 60 * 60));              // Delete > 4 hours temp dirs
69         if (empty($CFG->keeptempdirectoriesonbackup)) { // Conditionally
70             backup_helper::delete_backup_dir($this->task->get_tempdir()); // Empty restore dir
71         }
72     }
73 }
75 /**
76  * Restore calculated grade items, grade categories etc
77  */
78 class restore_gradebook_structure_step extends restore_structure_step {
80     /**
81      * To conditionally decide if this step must be executed
82      * Note the "settings" conditions are evaluated in the
83      * corresponding task. Here we check for other conditions
84      * not being restore settings (files, site settings...)
85      */
86      protected function execute_condition() {
87         global $CFG, $DB;
89         // No gradebook info found, don't execute
90         $fullpath = $this->task->get_taskbasepath();
91         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
92         if (!file_exists($fullpath)) {
93             return false;
94         }
96         // Some module present in backup file isn't available to restore
97         // in this site, don't execute
98         if ($this->task->is_missing_modules()) {
99             return false;
100         }
102         // Some activity has been excluded to be restored, don't execute
103         if ($this->task->is_excluding_activities()) {
104             return false;
105         }
107         // There should only be one grade category (the 1 associated with the course itself)
108         // If other categories already exist we're restoring into an existing course.
109         // Restoring categories into a course with an existing category structure is unlikely to go well
110         $category = new stdclass();
111         $category->courseid  = $this->get_courseid();
112         $catcount = $DB->count_records('grade_categories', (array)$category);
113         if ($catcount>1) {
114             return false;
115         }
117         // Arrived here, execute the step
118         return true;
119      }
121     protected function define_structure() {
122         $paths = array();
123         $userinfo = $this->task->get_setting_value('users');
125         $paths[] = new restore_path_element('gradebook', '/gradebook');
126         $paths[] = new restore_path_element('grade_category', '/gradebook/grade_categories/grade_category');
127         $paths[] = new restore_path_element('grade_item', '/gradebook/grade_items/grade_item');
128         if ($userinfo) {
129             $paths[] = new restore_path_element('grade_grade', '/gradebook/grade_items/grade_item/grade_grades/grade_grade');
130         }
131         $paths[] = new restore_path_element('grade_letter', '/gradebook/grade_letters/grade_letter');
132         $paths[] = new restore_path_element('grade_setting', '/gradebook/grade_settings/grade_setting');
134         return $paths;
135     }
137     protected function process_gradebook($data) {
138     }
140     protected function process_grade_item($data) {
141         global $DB;
143         $data = (object)$data;
145         $oldid = $data->id;
146         $data->course = $this->get_courseid();
148         $data->courseid = $this->get_courseid();
150         if ($data->itemtype=='manual') {
151             // manual grade items store category id in categoryid
152             $data->categoryid = $this->get_mappingid('grade_category', $data->categoryid, NULL);
153             // 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 = get_context_instance(CONTEXT_COURSE, $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         if ($this->get_setting_value('users')) {
738             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
739         }
740         $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
741         $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
743         return $paths;
744     }
746     // Processing functions go here
747     public function process_group($data) {
748         global $DB;
750         $data = (object)$data; // handy
751         $data->courseid = $this->get_courseid();
753         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
754         // another a group in the same course
755         $context = context_course::instance($data->courseid);
756         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
757             if (groups_get_group_by_idnumber($data->courseid, $data->idnumber)) {
758                 unset($data->idnumber);
759             }
760         } else {
761             unset($data->idnumber);
762         }
764         $oldid = $data->id;    // need this saved for later
766         $restorefiles = false; // Only if we end creating the group
768         // Search if the group already exists (by name & description) in the target course
769         $description_clause = '';
770         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
771         if (!empty($data->description)) {
772             $description_clause = ' AND ' .
773                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
774            $params['description'] = $data->description;
775         }
776         if (!$groupdb = $DB->get_record_sql("SELECT *
777                                                FROM {groups}
778                                               WHERE courseid = :courseid
779                                                 AND name = :grname $description_clause", $params)) {
780             // group doesn't exist, create
781             $newitemid = $DB->insert_record('groups', $data);
782             $restorefiles = true; // We'll restore the files
783         } else {
784             // group exists, use it
785             $newitemid = $groupdb->id;
786         }
787         // Save the id mapping
788         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
789     }
791     public function process_member($data) {
792         global $DB;
794         $data = (object)$data; // handy
796         // get parent group->id
797         $data->groupid = $this->get_new_parentid('group');
799         // map user newitemid and insert if not member already
800         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
801             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
802                 $DB->insert_record('groups_members', $data);
803             }
804         }
805     }
807     public function process_grouping($data) {
808         global $DB;
810         $data = (object)$data; // handy
811         $data->courseid = $this->get_courseid();
813         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
814         // another a grouping in the same course
815         $context = context_course::instance($data->courseid);
816         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
817             if (groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) {
818                 unset($data->idnumber);
819             }
820         } else {
821             unset($data->idnumber);
822         }
824         $oldid = $data->id;    // need this saved for later
825         $restorefiles = false; // Only if we end creating the grouping
827         // Search if the grouping already exists (by name & description) in the target course
828         $description_clause = '';
829         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
830         if (!empty($data->description)) {
831             $description_clause = ' AND ' .
832                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
833            $params['description'] = $data->description;
834         }
835         if (!$groupingdb = $DB->get_record_sql("SELECT *
836                                                   FROM {groupings}
837                                                  WHERE courseid = :courseid
838                                                    AND name = :grname $description_clause", $params)) {
839             // grouping doesn't exist, create
840             $newitemid = $DB->insert_record('groupings', $data);
841             $restorefiles = true; // We'll restore the files
842         } else {
843             // grouping exists, use it
844             $newitemid = $groupingdb->id;
845         }
846         // Save the id mapping
847         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
848     }
850     public function process_grouping_group($data) {
851         global $CFG;
853         require_once($CFG->dirroot.'/group/lib.php');
855         $data = (object)$data;
856         groups_assign_grouping($this->get_new_parentid('grouping'), $this->get_mappingid('group', $data->groupid), $data->timeadded);
857     }
859     protected function after_execute() {
860         // Add group related files, matching with "group" mappings
861         $this->add_related_files('group', 'icon', 'group');
862         $this->add_related_files('group', 'description', 'group');
863         // Add grouping related files, matching with "grouping" mappings
864         $this->add_related_files('grouping', 'description', 'grouping');
865     }
869 /**
870  * Structure step that will create all the needed scales
871  * by loading them from the scales.xml
872  */
873 class restore_scales_structure_step extends restore_structure_step {
875     protected function define_structure() {
877         $paths = array(); // Add paths here
878         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
879         return $paths;
880     }
882     protected function process_scale($data) {
883         global $DB;
885         $data = (object)$data;
887         $restorefiles = false; // Only if we end creating the group
889         $oldid = $data->id;    // need this saved for later
891         // Look for scale (by 'scale' both in standard (course=0) and current course
892         // with priority to standard scales (ORDER clause)
893         // scale is not course unique, use get_record_sql to suppress warning
894         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
895         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
896         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
897         if (!$scadb = $DB->get_record_sql("SELECT *
898                                             FROM {scale}
899                                            WHERE courseid IN (0, :courseid)
900                                              AND $compare_scale_clause
901                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
902             // Remap the user if possible, defaut to user performing the restore if not
903             $userid = $this->get_mappingid('user', $data->userid);
904             $data->userid = $userid ? $userid : $this->task->get_userid();
905             // Remap the course if course scale
906             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
907             // If global scale (course=0), check the user has perms to create it
908             // falling to course scale if not
909             $systemctx = get_context_instance(CONTEXT_SYSTEM);
910             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
911                 $data->courseid = $this->get_courseid();
912             }
913             // scale doesn't exist, create
914             $newitemid = $DB->insert_record('scale', $data);
915             $restorefiles = true; // We'll restore the files
916         } else {
917             // scale exists, use it
918             $newitemid = $scadb->id;
919         }
920         // Save the id mapping (with files support at system context)
921         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
922     }
924     protected function after_execute() {
925         // Add scales related files, matching with "scale" mappings
926         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
927     }
931 /**
932  * Structure step that will create all the needed outocomes
933  * by loading them from the outcomes.xml
934  */
935 class restore_outcomes_structure_step extends restore_structure_step {
937     protected function define_structure() {
939         $paths = array(); // Add paths here
940         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
941         return $paths;
942     }
944     protected function process_outcome($data) {
945         global $DB;
947         $data = (object)$data;
949         $restorefiles = false; // Only if we end creating the group
951         $oldid = $data->id;    // need this saved for later
953         // Look for outcome (by shortname both in standard (courseid=null) and current course
954         // with priority to standard outcomes (ORDER clause)
955         // outcome is not course unique, use get_record_sql to suppress warning
956         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
957         if (!$outdb = $DB->get_record_sql('SELECT *
958                                              FROM {grade_outcomes}
959                                             WHERE shortname = :shortname
960                                               AND (courseid = :courseid OR courseid IS NULL)
961                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
962             // Remap the user
963             $userid = $this->get_mappingid('user', $data->usermodified);
964             $data->usermodified = $userid ? $userid : $this->task->get_userid();
965             // Remap the scale
966             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
967             // Remap the course if course outcome
968             $data->courseid = $data->courseid ? $this->get_courseid() : null;
969             // If global outcome (course=null), check the user has perms to create it
970             // falling to course outcome if not
971             $systemctx = get_context_instance(CONTEXT_SYSTEM);
972             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
973                 $data->courseid = $this->get_courseid();
974             }
975             // outcome doesn't exist, create
976             $newitemid = $DB->insert_record('grade_outcomes', $data);
977             $restorefiles = true; // We'll restore the files
978         } else {
979             // scale exists, use it
980             $newitemid = $outdb->id;
981         }
982         // Set the corresponding grade_outcomes_courses record
983         $outcourserec = new stdclass();
984         $outcourserec->courseid  = $this->get_courseid();
985         $outcourserec->outcomeid = $newitemid;
986         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
987             $DB->insert_record('grade_outcomes_courses', $outcourserec);
988         }
989         // Save the id mapping (with files support at system context)
990         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
991     }
993     protected function after_execute() {
994         // Add outcomes related files, matching with "outcome" mappings
995         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
996     }
999 /**
1000  * Execution step that, *conditionally* (if there isn't preloaded information
1001  * will load all the question categories and questions (header info only)
1002  * to backup_temp_ids. They will be stored with "question_category" and
1003  * "question" itemnames and with their original contextid and question category
1004  * id as paremitemids
1005  */
1006 class restore_load_categories_and_questions extends restore_execution_step {
1008     protected function define_execution() {
1010         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1011             return;
1012         }
1013         $file = $this->get_basepath() . '/questions.xml';
1014         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
1015     }
1018 /**
1019  * Execution step that, *conditionally* (if there isn't preloaded information)
1020  * will process all the needed categories and questions
1021  * in order to decide and perform any action with them (create / map / error)
1022  * Note: Any error will cause exception, as far as this is the same processing
1023  * than the one into restore prechecks (that should have stopped process earlier)
1024  */
1025 class restore_process_categories_and_questions extends restore_execution_step {
1027     protected function define_execution() {
1029         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1030             return;
1031         }
1032         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
1033     }
1036 /**
1037  * Structure step that will read the section.xml creating/updating sections
1038  * as needed, rebuilding course cache and other friends
1039  */
1040 class restore_section_structure_step extends restore_structure_step {
1042     protected function define_structure() {
1043         global $CFG;
1045         $paths = array();
1047         $section = new restore_path_element('section', '/section');
1048         $paths[] = $section;
1049         if ($CFG->enableavailability) {
1050             $paths[] = new restore_path_element('availability', '/section/availability');
1051         }
1053         // Apply for 'format' plugins optional paths at section level
1054         $this->add_plugin_structure('format', $section);
1056         return $paths;
1057     }
1059     public function process_section($data) {
1060         global $CFG, $DB;
1061         $data = (object)$data;
1062         $oldid = $data->id; // We'll need this later
1064         $restorefiles = false;
1066         // Look for the section
1067         $section = new stdclass();
1068         $section->course  = $this->get_courseid();
1069         $section->section = $data->number;
1070         // Section doesn't exist, create it with all the info from backup
1071         if (!$secrec = $DB->get_record('course_sections', (array)$section)) {
1072             $section->name = $data->name;
1073             $section->summary = $data->summary;
1074             $section->summaryformat = $data->summaryformat;
1075             $section->sequence = '';
1076             $section->visible = $data->visible;
1077             if (empty($CFG->enableavailability)) { // Process availability information only if enabled.
1078                 $section->availablefrom = 0;
1079                 $section->availableuntil = 0;
1080                 $section->showavailability = 0;
1081             } else {
1082                 $section->availablefrom = isset($data->availablefrom) ? $this->apply_date_offset($data->availablefrom) : 0;
1083                 $section->availableuntil = isset($data->availableuntil) ? $this->apply_date_offset($data->availableuntil) : 0;
1084                 $section->showavailability = isset($data->showavailability) ? $data->showavailability : 0;
1085             }
1086             if (!empty($CFG->enablegroupmembersonly)) { // Only if enablegroupmembersonly is enabled
1087                 $section->groupingid = isset($data->groupingid) ? $this->get_mappingid('grouping', $data->groupingid) : 0;
1088             }
1089             $newitemid = $DB->insert_record('course_sections', $section);
1090             $restorefiles = true;
1092         // Section exists, update non-empty information
1093         } else {
1094             $section->id = $secrec->id;
1095             if ((string)$secrec->name === '') {
1096                 $section->name = $data->name;
1097             }
1098             if (empty($secrec->summary)) {
1099                 $section->summary = $data->summary;
1100                 $section->summaryformat = $data->summaryformat;
1101                 $restorefiles = true;
1102             }
1103             if (empty($secrec->groupingid)) {
1104                 if (!empty($CFG->enablegroupmembersonly)) { // Only if enablegroupmembersonly is enabled
1105                     $section->groupingid = isset($data->groupingid) ? $this->get_mappingid('grouping', $data->groupingid) : 0;
1106                 }
1107             }
1109             // Don't update available from, available until, or show availability
1110             // (I didn't see a useful way to define whether existing or new one should
1111             // take precedence).
1113             $DB->update_record('course_sections', $section);
1114             $newitemid = $secrec->id;
1115         }
1117         // Annotate the section mapping, with restorefiles option if needed
1118         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
1120         // set the new course_section id in the task
1121         $this->task->set_sectionid($newitemid);
1124         // Commented out. We never modify course->numsections as far as that is used
1125         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
1126         // Note: We keep the code here, to know about and because of the possibility of making this
1127         // optional based on some setting/attribute in the future
1128         // If needed, adjust course->numsections
1129         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
1130         //    if ($numsections < $section->section) {
1131         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
1132         //    }
1133         //}
1134     }
1136     public function process_availability($data) {
1137         global $DB;
1138         $data = (object)$data;
1140         $data->coursesectionid = $this->task->get_sectionid();
1142         // NOTE: Other values in $data need updating, but these (cm,
1143         // grade items) have not yet been restored, so are done later.
1145         $newid = $DB->insert_record('course_sections_availability', $data);
1147         // We do not need to map between old and new id but storing a mapping
1148         // means it gets added to the backup_ids table to record which ones
1149         // need updating. The mapping is stored with $newid => $newid for
1150         // convenience.
1151         $this->set_mapping('course_sections_availability', $newid, $newid);
1152     }
1154     protected function after_execute() {
1155         // Add section related files, with 'course_section' itemid to match
1156         $this->add_related_files('course', 'section', 'course_section');
1157     }
1159     public function after_restore() {
1160         global $DB;
1162         $sectionid = $this->get_task()->get_sectionid();
1164         // Get data object for current section availability (if any).
1165         $records = $DB->get_records('course_sections_availability',
1166                 array('coursesectionid' => $sectionid), 'id, sourcecmid, gradeitemid');
1168         // If it exists, update mappings.
1169         foreach ($records as $data) {
1170             // Only update mappings for entries which are created by this restore.
1171             // Otherwise, when you restore to an existing course, it will mess up
1172             // existing section availability entries.
1173             if (!$this->get_mappingid('course_sections_availability', $data->id, false)) {
1174                 return;
1175             }
1177             // Update source cmid / grade id to new value.
1178             $data->sourcecmid = $this->get_mappingid('course_module', $data->sourcecmid);
1179             if (!$data->sourcecmid) {
1180                 $data->sourcecmid = null;
1181             }
1182             $data->gradeitemid = $this->get_mappingid('grade_item', $data->gradeitemid);
1183             if (!$data->gradeitemid) {
1184                 $data->gradeitemid = null;
1185             }
1187             $DB->update_record('course_sections_availability', $data);
1188         }
1189     }
1193 /**
1194  * Structure step that will read the course.xml file, loading it and performing
1195  * various actions depending of the site/restore settings. Note that target
1196  * course always exist before arriving here so this step will be updating
1197  * the course record (never inserting)
1198  */
1199 class restore_course_structure_step extends restore_structure_step {
1200     /**
1201      * @var bool this gets set to true by {@link process_course()} if we are
1202      * restoring an old coures that used the legacy 'module security' feature.
1203      * If so, we have to do more work in {@link after_execute()}.
1204      */
1205     protected $legacyrestrictmodules = false;
1207     /**
1208      * @var array Used when {@link $legacyrestrictmodules} is true. This is an
1209      * array with array keys the module names ('forum', 'quiz', etc.). These are
1210      * the modules that are allowed according to the data in the backup file.
1211      * In {@link after_execute()} we then have to prevent adding of all the other
1212      * types of activity.
1213      */
1214     protected $legacyallowedmodules = array();
1216     protected function define_structure() {
1218         $course = new restore_path_element('course', '/course');
1219         $category = new restore_path_element('category', '/course/category');
1220         $tag = new restore_path_element('tag', '/course/tags/tag');
1221         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1223         // Apply for 'format' plugins optional paths at course level
1224         $this->add_plugin_structure('format', $course);
1226         // Apply for 'theme' plugins optional paths at course level
1227         $this->add_plugin_structure('theme', $course);
1229         // Apply for 'report' plugins optional paths at course level
1230         $this->add_plugin_structure('report', $course);
1232         // Apply for 'course report' plugins optional paths at course level
1233         $this->add_plugin_structure('coursereport', $course);
1235         // Apply for plagiarism plugins optional paths at course level
1236         $this->add_plugin_structure('plagiarism', $course);
1238         return array($course, $category, $tag, $allowed_module);
1239     }
1241     /**
1242      * Processing functions go here
1243      *
1244      * @global moodledatabase $DB
1245      * @param stdClass $data
1246      */
1247     public function process_course($data) {
1248         global $CFG, $DB;
1250         $data = (object)$data;
1252         $fullname  = $this->get_setting_value('course_fullname');
1253         $shortname = $this->get_setting_value('course_shortname');
1254         $startdate = $this->get_setting_value('course_startdate');
1256         // Calculate final course names, to avoid dupes
1257         list($fullname, $shortname) = restore_dbops::calculate_course_names($this->get_courseid(), $fullname, $shortname);
1259         // Need to change some fields before updating the course record
1260         $data->id = $this->get_courseid();
1261         $data->fullname = $fullname;
1262         $data->shortname= $shortname;
1264         $context = get_context_instance_by_id($this->task->get_contextid());
1265         if (has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1266             $data->idnumber = '';
1267         } else {
1268             unset($data->idnumber);
1269         }
1271         // Any empty value for course->hiddensections will lead to 0 (default, show collapsed).
1272         // It has been reported that some old 1.9 courses may have it null leading to DB error. MDL-31532
1273         if (empty($data->hiddensections)) {
1274             $data->hiddensections = 0;
1275         }
1277         // Set legacyrestrictmodules to true if the course was resticting modules. If so
1278         // then we will need to process restricted modules after execution.
1279         $this->legacyrestrictmodules = !empty($data->restrictmodules);
1281         $data->startdate= $this->apply_date_offset($data->startdate);
1282         if ($data->defaultgroupingid) {
1283             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1284         }
1285         if (empty($CFG->enablecompletion)) {
1286             $data->enablecompletion = 0;
1287             $data->completionstartonenrol = 0;
1288             $data->completionnotify = 0;
1289         }
1290         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1291         if (!array_key_exists($data->lang, $languages)) {
1292             $data->lang = '';
1293         }
1295         $themes = get_list_of_themes(); // Get themes for quick search later
1296         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1297             $data->theme = '';
1298         }
1300         // Course record ready, update it
1301         $DB->update_record('course', $data);
1303         // Role name aliases
1304         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1305     }
1307     public function process_category($data) {
1308         // Nothing to do with the category. UI sets it before restore starts
1309     }
1311     public function process_tag($data) {
1312         global $CFG, $DB;
1314         $data = (object)$data;
1316         if (!empty($CFG->usetags)) { // if enabled in server
1317             // TODO: This is highly inneficient. Each time we add one tag
1318             // we fetch all the existing because tag_set() deletes them
1319             // so everything must be reinserted on each call
1320             $tags = array();
1321             $existingtags = tag_get_tags('course', $this->get_courseid());
1322             // Re-add all the existitng tags
1323             foreach ($existingtags as $existingtag) {
1324                 $tags[] = $existingtag->rawname;
1325             }
1326             // Add the one being restored
1327             $tags[] = $data->rawname;
1328             // Send all the tags back to the course
1329             tag_set('course', $this->get_courseid(), $tags);
1330         }
1331     }
1333     public function process_allowed_module($data) {
1334         $data = (object)$data;
1336         // Backwards compatiblity support for the data that used to be in the
1337         // course_allowed_modules table.
1338         if ($this->legacyrestrictmodules) {
1339             $this->legacyallowedmodules[$data->modulename] = 1;
1340         }
1341     }
1343     protected function after_execute() {
1344         global $DB;
1346         // Add course related files, without itemid to match
1347         $this->add_related_files('course', 'summary', null);
1349         // Deal with legacy allowed modules.
1350         if ($this->legacyrestrictmodules) {
1351             $context = context_course::instance($this->get_courseid());
1353             list($roleids) = get_roles_with_cap_in_context($context, 'moodle/course:manageactivities');
1354             list($managerroleids) = get_roles_with_cap_in_context($context, 'moodle/site:config');
1355             foreach ($managerroleids as $roleid) {
1356                 unset($roleids[$roleid]);
1357             }
1359             foreach (get_plugin_list('mod') as $modname => $notused) {
1360                 if (isset($this->legacyallowedmodules[$modname])) {
1361                     // Module is allowed, no worries.
1362                     continue;
1363                 }
1365                 $capability = 'mod/' . $modname . ':addinstance';
1366                 foreach ($roleids as $roleid) {
1367                     assign_capability($capability, CAP_PREVENT, $roleid, $context);
1368                 }
1369             }
1370         }
1371     }
1374 /**
1375  * Execution step that will migrate legacy files if present.
1376  */
1377 class restore_course_legacy_files_step extends restore_execution_step {
1378     public function define_execution() {
1379         global $DB;
1381         // Do a check for legacy files and skip if there are none.
1382         $sql = 'SELECT count(*)
1383                   FROM {backup_files_temp}
1384                  WHERE backupid = ?
1385                    AND contextid = ?
1386                    AND component = ?
1387                    AND filearea  = ?';
1388         $params = array($this->get_restoreid(), $this->task->get_old_contextid(), 'course', 'legacy');
1390         if ($DB->count_records_sql($sql, $params)) {
1391             $DB->set_field('course', 'legacyfiles', 2, array('id' => $this->get_courseid()));
1392             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'course',
1393                 'legacy', $this->task->get_old_contextid(), $this->task->get_userid());
1394         }
1395     }
1398 /*
1399  * Structure step that will read the roles.xml file (at course/activity/block levels)
1400  * containig all the role_assignments and overrides for that context. If corresponding to
1401  * one mapped role, they will be applied to target context. Will observe the role_assignments
1402  * setting to decide if ras are restored.
1403  * Note: only ras with component == null are restored as far as the any ra with component
1404  * is handled by one enrolment plugin, hence it will createt the ras later
1405  */
1406 class restore_ras_and_caps_structure_step extends restore_structure_step {
1408     protected function define_structure() {
1410         $paths = array();
1412         // Observe the role_assignments setting
1413         if ($this->get_setting_value('role_assignments')) {
1414             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
1415         }
1416         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
1418         return $paths;
1419     }
1421     /**
1422      * Assign roles
1423      *
1424      * This has to be called after enrolments processing.
1425      *
1426      * @param mixed $data
1427      * @return void
1428      */
1429     public function process_assignment($data) {
1430         global $DB;
1432         $data = (object)$data;
1434         // Check roleid, userid are one of the mapped ones
1435         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
1436             return;
1437         }
1438         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
1439             return;
1440         }
1441         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
1442             // Only assign roles to not deleted users
1443             return;
1444         }
1445         if (!$contextid = $this->task->get_contextid()) {
1446             return;
1447         }
1449         if (empty($data->component)) {
1450             // assign standard manual roles
1451             // TODO: role_assign() needs one userid param to be able to specify our restore userid
1452             role_assign($newroleid, $newuserid, $contextid);
1454         } else if ((strpos($data->component, 'enrol_') === 0)) {
1455             // Deal with enrolment roles
1456             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1457                 if ($component = $DB->get_field('enrol', 'component', array('id'=>$enrolid))) {
1458                     //note: we have to verify component because it might have changed
1459                     if ($component === 'enrol_manual') {
1460                         // manual is a special case, we do not use components - this owudl happen when converting from other plugin
1461                         role_assign($newroleid, $newuserid, $contextid); //TODO: do we need modifierid?
1462                     } else {
1463                         role_assign($newroleid, $newuserid, $contextid, $component, $enrolid); //TODO: do we need modifierid?
1464                     }
1465                 }
1466             }
1467         }
1468     }
1470     public function process_override($data) {
1471         $data = (object)$data;
1473         // Check roleid is one of the mapped ones
1474         $newroleid = $this->get_mappingid('role', $data->roleid);
1475         // If newroleid and context are valid assign it via API (it handles dupes and so on)
1476         if ($newroleid && $this->task->get_contextid()) {
1477             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
1478             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
1479             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
1480         }
1481     }
1484 /**
1485  * This structure steps restores the enrol plugins and their underlying
1486  * enrolments, performing all the mappings and/or movements required
1487  */
1488 class restore_enrolments_structure_step extends restore_structure_step {
1490     /**
1491      * Conditionally decide if this step should be executed.
1492      *
1493      * This function checks the following parameter:
1494      *
1495      *   1. the course/enrolments.xml file exists
1496      *
1497      * @return bool true is safe to execute, false otherwise
1498      */
1499     protected function execute_condition() {
1501         // Check it is included in the backup
1502         $fullpath = $this->task->get_taskbasepath();
1503         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1504         if (!file_exists($fullpath)) {
1505             // Not found, can't restore enrolments info
1506             return false;
1507         }
1509         return true;
1510     }
1512     protected function define_structure() {
1514         $paths = array();
1516         $paths[] = new restore_path_element('enrol', '/enrolments/enrols/enrol');
1517         $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
1519         return $paths;
1520     }
1522     /**
1523      * Create enrolment instances.
1524      *
1525      * This has to be called after creation of roles
1526      * and before adding of role assignments.
1527      *
1528      * @param mixed $data
1529      * @return void
1530      */
1531     public function process_enrol($data) {
1532         global $DB;
1534         $data = (object)$data;
1535         $oldid = $data->id; // We'll need this later
1537         $restoretype = plugin_supports('enrol', $data->enrol, ENROL_RESTORE_TYPE, null);
1539         if ($restoretype !== ENROL_RESTORE_EXACT and $restoretype !== ENROL_RESTORE_NOUSERS) {
1540             // TODO: add complex restore support via custom class
1541             debugging("Skipping '{$data->enrol}' enrolment plugin. Will be implemented before 2.0 release", DEBUG_DEVELOPER);
1542             $this->set_mapping('enrol', $oldid, 0);
1543             return;
1544         }
1546         // Perform various checks to decide what to do with the enrol plugin
1547         if (!array_key_exists($data->enrol, enrol_get_plugins(false))) {
1548             // TODO: decide if we want to switch to manual enrol - we need UI for this
1549             debugging("Enrol plugin data can not be restored because it is not installed");
1550             $this->set_mapping('enrol', $oldid, 0);
1551             return;
1553         }
1554         if (!enrol_is_enabled($data->enrol)) {
1555             // TODO: decide if we want to switch to manual enrol - we need UI for this
1556             debugging("Enrol plugin data can not be restored because it is not enabled");
1557             $this->set_mapping('enrol', $oldid, 0);
1558             return;
1559         }
1561         // map standard fields - plugin has to process custom fields from own restore class
1562         $data->roleid = $this->get_mappingid('role', $data->roleid);
1563         //TODO: should we move the enrol start and end date here?
1565         // always add instance, if the course does not support multiple instances it just returns NULL
1566         $enrol = enrol_get_plugin($data->enrol);
1567         $courserec = $DB->get_record('course', array('id' => $this->get_courseid())); // Requires object, uses only id!!
1568         if ($newitemid = $enrol->add_instance($courserec, (array)$data)) {
1569             // ok
1570         } else {
1571             if ($instances = $DB->get_records('enrol', array('courseid'=>$courserec->id, 'enrol'=>$data->enrol))) {
1572                 // most probably plugin that supports only one instance
1573                 $newitemid = key($instances);
1574             } else {
1575                 debugging('Can not create new enrol instance or reuse existing');
1576                 $newitemid = 0;
1577             }
1578         }
1580         if ($restoretype === ENROL_RESTORE_NOUSERS) {
1581             // plugin requests to prevent restore of any users
1582             $newitemid = 0;
1583         }
1585         $this->set_mapping('enrol', $oldid, $newitemid);
1586     }
1588     /**
1589      * Create user enrolments
1590      *
1591      * This has to be called after creation of enrolment instances
1592      * and before adding of role assignments.
1593      *
1594      * @param mixed $data
1595      * @return void
1596      */
1597     public function process_enrolment($data) {
1598         global $DB;
1600         $data = (object)$data;
1602         // Process only if parent instance have been mapped
1603         if ($enrolid = $this->get_new_parentid('enrol')) {
1604             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1605                 // And only if user is a mapped one
1606                 if ($userid = $this->get_mappingid('user', $data->userid)) {
1607                     $enrol = enrol_get_plugin($instance->enrol);
1608                     //TODO: do we need specify modifierid?
1609                     $enrol->enrol_user($instance, $userid, null, $data->timestart, $data->timeend, $data->status);
1610                     //note: roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing above
1611                 }
1612             }
1613         }
1614     }
1618 /**
1619  * Make sure the user restoring the course can actually access it.
1620  */
1621 class restore_fix_restorer_access_step extends restore_execution_step {
1622     protected function define_execution() {
1623         global $CFG, $DB;
1625         if (!$userid = $this->task->get_userid()) {
1626             return;
1627         }
1629         if (empty($CFG->restorernewroleid)) {
1630             // Bad luck, no fallback role for restorers specified
1631             return;
1632         }
1634         $courseid = $this->get_courseid();
1635         $context = context_course::instance($courseid);
1637         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1638             // Current user may access the course (admin, category manager or restored teacher enrolment usually)
1639             return;
1640         }
1642         // Try to add role only - we do not need enrolment if user has moodle/course:view or is already enrolled
1643         role_assign($CFG->restorernewroleid, $userid, $context);
1645         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1646             // Extra role is enough, yay!
1647             return;
1648         }
1650         // The last chance is to create manual enrol if it does not exist and and try to enrol the current user,
1651         // hopefully admin selected suitable $CFG->restorernewroleid ...
1652         if (!enrol_is_enabled('manual')) {
1653             return;
1654         }
1655         if (!$enrol = enrol_get_plugin('manual')) {
1656             return;
1657         }
1658         if (!$DB->record_exists('enrol', array('enrol'=>'manual', 'courseid'=>$courseid))) {
1659             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
1660             $fields = array('status'=>ENROL_INSTANCE_ENABLED, 'enrolperiod'=>$enrol->get_config('enrolperiod', 0), 'roleid'=>$enrol->get_config('roleid', 0));
1661             $enrol->add_instance($course, $fields);
1662         }
1664         enrol_try_internal_enrol($courseid, $userid);
1665     }
1669 /**
1670  * This structure steps restores the filters and their configs
1671  */
1672 class restore_filters_structure_step extends restore_structure_step {
1674     protected function define_structure() {
1676         $paths = array();
1678         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
1679         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
1681         return $paths;
1682     }
1684     public function process_active($data) {
1686         $data = (object)$data;
1688         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1689             return;
1690         }
1691         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
1692     }
1694     public function process_config($data) {
1696         $data = (object)$data;
1698         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1699             return;
1700         }
1701         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
1702     }
1706 /**
1707  * This structure steps restores the comments
1708  * Note: Cannot use the comments API because defaults to USER->id.
1709  * That should change allowing to pass $userid
1710  */
1711 class restore_comments_structure_step extends restore_structure_step {
1713     protected function define_structure() {
1715         $paths = array();
1717         $paths[] = new restore_path_element('comment', '/comments/comment');
1719         return $paths;
1720     }
1722     public function process_comment($data) {
1723         global $DB;
1725         $data = (object)$data;
1727         // First of all, if the comment has some itemid, ask to the task what to map
1728         $mapping = false;
1729         if ($data->itemid) {
1730             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
1731             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
1732         }
1733         // Only restore the comment if has no mapping OR we have found the matching mapping
1734         if (!$mapping || $data->itemid) {
1735             // Only if user mapping and context
1736             $data->userid = $this->get_mappingid('user', $data->userid);
1737             if ($data->userid && $this->task->get_contextid()) {
1738                 $data->contextid = $this->task->get_contextid();
1739                 // Only if there is another comment with same context/user/timecreated
1740                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
1741                 if (!$DB->record_exists('comments', $params)) {
1742                     $DB->insert_record('comments', $data);
1743                 }
1744             }
1745         }
1746     }
1749 /**
1750  * This structure steps restores the calendar events
1751  */
1752 class restore_calendarevents_structure_step extends restore_structure_step {
1754     protected function define_structure() {
1756         $paths = array();
1758         $paths[] = new restore_path_element('calendarevents', '/events/event');
1760         return $paths;
1761     }
1763     public function process_calendarevents($data) {
1764         global $DB;
1766         $data = (object)$data;
1767         $oldid = $data->id;
1768         $restorefiles = true; // We'll restore the files
1769         // Find the userid and the groupid associated with the event. Return if not found.
1770         $data->userid = $this->get_mappingid('user', $data->userid);
1771         if ($data->userid === false) {
1772             return;
1773         }
1774         if (!empty($data->groupid)) {
1775             $data->groupid = $this->get_mappingid('group', $data->groupid);
1776             if ($data->groupid === false) {
1777                 return;
1778             }
1779         }
1780         // Handle events with empty eventtype //MDL-32827
1781         if(empty($data->eventtype)) {
1782             if ($data->courseid == $SITE->id) {                                // Site event
1783                 $data->eventtype = "site";
1784             } else if ($data->courseid != 0 && $data->groupid == 0 && ($data->modulename == 'assignment' || $data->modulename == 'assign')) {
1785                 // Course assingment event
1786                 $data->eventtype = "due";
1787             } else if ($data->courseid != 0 && $data->groupid == 0) {      // Course event
1788                 $data->eventtype = "course";
1789             } else if ($data->groupid) {                                      // Group event
1790                 $data->eventtype = "group";
1791             } else if ($data->userid) {                                       // User event
1792                 $data->eventtype = "user";
1793             } else {
1794                 return;
1795             }
1796         }
1798         $params = array(
1799                 'name'           => $data->name,
1800                 'description'    => $data->description,
1801                 'format'         => $data->format,
1802                 'courseid'       => $this->get_courseid(),
1803                 'groupid'        => $data->groupid,
1804                 'userid'         => $data->userid,
1805                 'repeatid'       => $data->repeatid,
1806                 'modulename'     => $data->modulename,
1807                 'eventtype'      => $data->eventtype,
1808                 'timestart'      => $this->apply_date_offset($data->timestart),
1809                 'timeduration'   => $data->timeduration,
1810                 'visible'        => $data->visible,
1811                 'uuid'           => $data->uuid,
1812                 'sequence'       => $data->sequence,
1813                 'timemodified'    => $this->apply_date_offset($data->timemodified));
1814         if ($this->name == 'activity_calendar') {
1815             $params['instance'] = $this->task->get_activityid();
1816         } else {
1817             $params['instance'] = 0;
1818         }
1819         $sql = 'SELECT id FROM {event} WHERE name = ? AND courseid = ? AND
1820                 repeatid = ? AND modulename = ? AND timestart = ? AND timeduration =?
1821                 AND ' . $DB->sql_compare_text('description', 255) . ' = ' . $DB->sql_compare_text('?', 255);
1822         $arg = array ($params['name'], $params['courseid'], $params['repeatid'], $params['modulename'], $params['timestart'], $params['timeduration'], $params['description']);
1823         $result = $DB->record_exists_sql($sql, $arg);
1824         if (empty($result)) {
1825             $newitemid = $DB->insert_record('event', $params);
1826             $this->set_mapping('event_description', $oldid, $newitemid, $restorefiles);
1827         }
1829     }
1830     protected function after_execute() {
1831         // Add related files
1832         $this->add_related_files('calendar', 'event_description', 'event_description');
1833     }
1836 class restore_course_completion_structure_step extends restore_structure_step {
1838     /**
1839      * Conditionally decide if this step should be executed.
1840      *
1841      * This function checks parameters that are not immediate settings to ensure
1842      * that the enviroment is suitable for the restore of course completion info.
1843      *
1844      * This function checks the following four parameters:
1845      *
1846      *   1. Course completion is enabled on the site
1847      *   2. The backup includes course completion information
1848      *   3. All modules are restorable
1849      *   4. All modules are marked for restore.
1850      *
1851      * @return bool True is safe to execute, false otherwise
1852      */
1853     protected function execute_condition() {
1854         global $CFG;
1856         // First check course completion is enabled on this site
1857         if (empty($CFG->enablecompletion)) {
1858             // Disabled, don't restore course completion
1859             return false;
1860         }
1862         // Check it is included in the backup
1863         $fullpath = $this->task->get_taskbasepath();
1864         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1865         if (!file_exists($fullpath)) {
1866             // Not found, can't restore course completion
1867             return false;
1868         }
1870         // Check we are able to restore all backed up modules
1871         if ($this->task->is_missing_modules()) {
1872             return false;
1873         }
1875         // Finally check all modules within the backup are being restored.
1876         if ($this->task->is_excluding_activities()) {
1877             return false;
1878         }
1880         return true;
1881     }
1883     /**
1884      * Define the course completion structure
1885      *
1886      * @return array Array of restore_path_element
1887      */
1888     protected function define_structure() {
1890         // To know if we are including user completion info
1891         $userinfo = $this->get_setting_value('userscompletion');
1893         $paths = array();
1894         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
1895         $paths[] = new restore_path_element('course_completion_notify', '/course_completion/course_completion_notify');
1896         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
1898         if ($userinfo) {
1899             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
1900             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
1901         }
1903         return $paths;
1905     }
1907     /**
1908      * Process course completion criteria
1909      *
1910      * @global moodle_database $DB
1911      * @param stdClass $data
1912      */
1913     public function process_course_completion_criteria($data) {
1914         global $DB;
1916         $data = (object)$data;
1917         $data->course = $this->get_courseid();
1919         // Apply the date offset to the time end field
1920         $data->timeend = $this->apply_date_offset($data->timeend);
1922         // Map the role from the criteria
1923         if (!empty($data->role)) {
1924             $data->role = $this->get_mappingid('role', $data->role);
1925         }
1927         $skipcriteria = false;
1929         // If the completion criteria is for a module we need to map the module instance
1930         // to the new module id.
1931         if (!empty($data->moduleinstance) && !empty($data->module)) {
1932             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
1933             if (empty($data->moduleinstance)) {
1934                 $skipcriteria = true;
1935             }
1936         } else {
1937             $data->module = null;
1938             $data->moduleinstance = null;
1939         }
1941         // We backup the course shortname rather than the ID so that we can match back to the course
1942         if (!empty($data->courseinstanceshortname)) {
1943             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
1944             if (!$courseinstanceid) {
1945                 $skipcriteria = true;
1946             }
1947         } else {
1948             $courseinstanceid = null;
1949         }
1950         $data->courseinstance = $courseinstanceid;
1952         if (!$skipcriteria) {
1953             $params = array(
1954                 'course'         => $data->course,
1955                 'criteriatype'   => $data->criteriatype,
1956                 'enrolperiod'    => $data->enrolperiod,
1957                 'courseinstance' => $data->courseinstance,
1958                 'module'         => $data->module,
1959                 'moduleinstance' => $data->moduleinstance,
1960                 'timeend'        => $data->timeend,
1961                 'gradepass'      => $data->gradepass,
1962                 'role'           => $data->role
1963             );
1964             $newid = $DB->insert_record('course_completion_criteria', $params);
1965             $this->set_mapping('course_completion_criteria', $data->id, $newid);
1966         }
1967     }
1969     /**
1970      * Processes course compltion criteria complete records
1971      *
1972      * @global moodle_database $DB
1973      * @param stdClass $data
1974      */
1975     public function process_course_completion_crit_compl($data) {
1976         global $DB;
1978         $data = (object)$data;
1980         // This may be empty if criteria could not be restored
1981         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
1983         $data->course = $this->get_courseid();
1984         $data->userid = $this->get_mappingid('user', $data->userid);
1986         if (!empty($data->criteriaid) && !empty($data->userid)) {
1987             $params = array(
1988                 'userid' => $data->userid,
1989                 'course' => $data->course,
1990                 'criteriaid' => $data->criteriaid,
1991                 'timecompleted' => $this->apply_date_offset($data->timecompleted)
1992             );
1993             if (isset($data->gradefinal)) {
1994                 $params['gradefinal'] = $data->gradefinal;
1995             }
1996             if (isset($data->unenroled)) {
1997                 $params['unenroled'] = $data->unenroled;
1998             }
1999             if (isset($data->deleted)) {
2000                 $params['deleted'] = $data->deleted;
2001             }
2002             $DB->insert_record('course_completion_crit_compl', $params);
2003         }
2004     }
2006     /**
2007      * Process course completions
2008      *
2009      * @global moodle_database $DB
2010      * @param stdClass $data
2011      */
2012     public function process_course_completions($data) {
2013         global $DB;
2015         $data = (object)$data;
2017         $data->course = $this->get_courseid();
2018         $data->userid = $this->get_mappingid('user', $data->userid);
2020         if (!empty($data->userid)) {
2021             $params = array(
2022                 'userid' => $data->userid,
2023                 'course' => $data->course,
2024                 'deleted' => $data->deleted,
2025                 'timenotified' => $this->apply_date_offset($data->timenotified),
2026                 'timeenrolled' => $this->apply_date_offset($data->timeenrolled),
2027                 'timestarted' => $this->apply_date_offset($data->timestarted),
2028                 'timecompleted' => $this->apply_date_offset($data->timecompleted),
2029                 'reaggregate' => $data->reaggregate
2030             );
2031             $DB->insert_record('course_completions', $params);
2032         }
2033     }
2035     /**
2036      * Process course completion notification records.
2037      *
2038      * Note: As of Moodle 2.0 this table is not being used however it has been
2039      * left in in the hopes that one day the functionality there will be completed
2040      *
2041      * @global moodle_database $DB
2042      * @param stdClass $data
2043      */
2044     public function process_course_completion_notify($data) {
2045         global $DB;
2047         $data = (object)$data;
2049         $data->course = $this->get_courseid();
2050         if (!empty($data->role)) {
2051             $data->role = $this->get_mappingid('role', $data->role);
2052         }
2054         $params = array(
2055             'course' => $data->course,
2056             'role' => $data->role,
2057             'message' => $data->message,
2058             'timesent' => $this->apply_date_offset($data->timesent),
2059         );
2060         $DB->insert_record('course_completion_notify', $params);
2061     }
2063     /**
2064      * Process course completion aggregate methods
2065      *
2066      * @global moodle_database $DB
2067      * @param stdClass $data
2068      */
2069     public function process_course_completion_aggr_methd($data) {
2070         global $DB;
2072         $data = (object)$data;
2074         $data->course = $this->get_courseid();
2076         // Only create the course_completion_aggr_methd records if
2077         // the target course has not them defined. MDL-28180
2078         if (!$DB->record_exists('course_completion_aggr_methd', array(
2079                     'course' => $data->course,
2080                     'criteriatype' => $data->criteriatype))) {
2081             $params = array(
2082                 'course' => $data->course,
2083                 'criteriatype' => $data->criteriatype,
2084                 'method' => $data->method,
2085                 'value' => $data->value,
2086             );
2087             $DB->insert_record('course_completion_aggr_methd', $params);
2088         }
2089     }
2093 /**
2094  * This structure step restores course logs (cmid = 0), delegating
2095  * the hard work to the corresponding {@link restore_logs_processor} passing the
2096  * collection of {@link restore_log_rule} rules to be observed as they are defined
2097  * by the task. Note this is only executed based in the 'logs' setting.
2098  *
2099  * NOTE: This is executed by final task, to have all the activities already restored
2100  *
2101  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
2102  * records are. There are others like 'calendar' and 'upload' that will be handled
2103  * later.
2104  *
2105  * NOTE: All the missing actions (not able to be restored) are sent to logs for
2106  * debugging purposes
2107  */
2108 class restore_course_logs_structure_step extends restore_structure_step {
2110     /**
2111      * Conditionally decide if this step should be executed.
2112      *
2113      * This function checks the following parameter:
2114      *
2115      *   1. the course/logs.xml file exists
2116      *
2117      * @return bool true is safe to execute, false otherwise
2118      */
2119     protected function execute_condition() {
2121         // Check it is included in the backup
2122         $fullpath = $this->task->get_taskbasepath();
2123         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2124         if (!file_exists($fullpath)) {
2125             // Not found, can't restore course logs
2126             return false;
2127         }
2129         return true;
2130     }
2132     protected function define_structure() {
2134         $paths = array();
2136         // Simple, one plain level of information contains them
2137         $paths[] = new restore_path_element('log', '/logs/log');
2139         return $paths;
2140     }
2142     protected function process_log($data) {
2143         global $DB;
2145         $data = (object)($data);
2147         $data->time = $this->apply_date_offset($data->time);
2148         $data->userid = $this->get_mappingid('user', $data->userid);
2149         $data->course = $this->get_courseid();
2150         $data->cmid = 0;
2152         // For any reason user wasn't remapped ok, stop processing this
2153         if (empty($data->userid)) {
2154             return;
2155         }
2157         // Everything ready, let's delegate to the restore_logs_processor
2159         // Set some fixed values that will save tons of DB requests
2160         $values = array(
2161             'course' => $this->get_courseid());
2162         // Get instance and process log record
2163         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2165         // If we have data, insert it, else something went wrong in the restore_logs_processor
2166         if ($data) {
2167             $DB->insert_record('log', $data);
2168         }
2169     }
2172 /**
2173  * This structure step restores activity logs, extending {@link restore_course_logs_structure_step}
2174  * sharing its same structure but modifying the way records are handled
2175  */
2176 class restore_activity_logs_structure_step extends restore_course_logs_structure_step {
2178     protected function process_log($data) {
2179         global $DB;
2181         $data = (object)($data);
2183         $data->time = $this->apply_date_offset($data->time);
2184         $data->userid = $this->get_mappingid('user', $data->userid);
2185         $data->course = $this->get_courseid();
2186         $data->cmid = $this->task->get_moduleid();
2188         // For any reason user wasn't remapped ok, stop processing this
2189         if (empty($data->userid)) {
2190             return;
2191         }
2193         // Everything ready, let's delegate to the restore_logs_processor
2195         // Set some fixed values that will save tons of DB requests
2196         $values = array(
2197             'course' => $this->get_courseid(),
2198             'course_module' => $this->task->get_moduleid(),
2199             $this->task->get_modulename() => $this->task->get_activityid());
2200         // Get instance and process log record
2201         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2203         // If we have data, insert it, else something went wrong in the restore_logs_processor
2204         if ($data) {
2205             $DB->insert_record('log', $data);
2206         }
2207     }
2211 /**
2212  * Defines the restore step for advanced grading methods attached to the activity module
2213  */
2214 class restore_activity_grading_structure_step extends restore_structure_step {
2216     /**
2217      * This step is executed only if the grading file is present
2218      */
2219      protected function execute_condition() {
2221         $fullpath = $this->task->get_taskbasepath();
2222         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2223         if (!file_exists($fullpath)) {
2224             return false;
2225         }
2227         return true;
2228     }
2231     /**
2232      * Declares paths in the grading.xml file we are interested in
2233      */
2234     protected function define_structure() {
2236         $paths = array();
2237         $userinfo = $this->get_setting_value('userinfo');
2239         $paths[] = new restore_path_element('grading_area', '/areas/area');
2241         $definition = new restore_path_element('grading_definition', '/areas/area/definitions/definition');
2242         $paths[] = $definition;
2243         $this->add_plugin_structure('gradingform', $definition);
2245         if ($userinfo) {
2246             $instance = new restore_path_element('grading_instance',
2247                 '/areas/area/definitions/definition/instances/instance');
2248             $paths[] = $instance;
2249             $this->add_plugin_structure('gradingform', $instance);
2250         }
2252         return $paths;
2253     }
2255     /**
2256      * Processes one grading area element
2257      *
2258      * @param array $data element data
2259      */
2260     protected function process_grading_area($data) {
2261         global $DB;
2263         $task = $this->get_task();
2264         $data = (object)$data;
2265         $oldid = $data->id;
2266         $data->component = 'mod_'.$task->get_modulename();
2267         $data->contextid = $task->get_contextid();
2269         $newid = $DB->insert_record('grading_areas', $data);
2270         $this->set_mapping('grading_area', $oldid, $newid);
2271     }
2273     /**
2274      * Processes one grading definition element
2275      *
2276      * @param array $data element data
2277      */
2278     protected function process_grading_definition($data) {
2279         global $DB;
2281         $task = $this->get_task();
2282         $data = (object)$data;
2283         $oldid = $data->id;
2284         $data->areaid = $this->get_new_parentid('grading_area');
2285         $data->copiedfromid = null;
2286         $data->timecreated = time();
2287         $data->usercreated = $task->get_userid();
2288         $data->timemodified = $data->timecreated;
2289         $data->usermodified = $data->usercreated;
2291         $newid = $DB->insert_record('grading_definitions', $data);
2292         $this->set_mapping('grading_definition', $oldid, $newid, true);
2293     }
2295     /**
2296      * Processes one grading form instance element
2297      *
2298      * @param array $data element data
2299      */
2300     protected function process_grading_instance($data) {
2301         global $DB;
2303         $data = (object)$data;
2305         // new form definition id
2306         $newformid = $this->get_new_parentid('grading_definition');
2308         // get the name of the area we are restoring to
2309         $sql = "SELECT ga.areaname
2310                   FROM {grading_definitions} gd
2311                   JOIN {grading_areas} ga ON gd.areaid = ga.id
2312                  WHERE gd.id = ?";
2313         $areaname = $DB->get_field_sql($sql, array($newformid), MUST_EXIST);
2315         // get the mapped itemid - the activity module is expected to define the mappings
2316         // for each gradable area
2317         $newitemid = $this->get_mappingid(restore_gradingform_plugin::itemid_mapping($areaname), $data->itemid);
2319         $oldid = $data->id;
2320         $data->definitionid = $newformid;
2321         $data->raterid = $this->get_mappingid('user', $data->raterid);
2322         $data->itemid = $newitemid;
2324         $newid = $DB->insert_record('grading_instances', $data);
2325         $this->set_mapping('grading_instance', $oldid, $newid);
2326     }
2328     /**
2329      * Final operations when the database records are inserted
2330      */
2331     protected function after_execute() {
2332         // Add files embedded into the definition description
2333         $this->add_related_files('grading', 'description', 'grading_definition');
2334     }
2338 /**
2339  * This structure step restores the grade items associated with one activity
2340  * All the grade items are made child of the "course" grade item but the original
2341  * categoryid is saved as parentitemid in the backup_ids table, so, when restoring
2342  * the complete gradebook (categories and calculations), that information is
2343  * available there
2344  */
2345 class restore_activity_grades_structure_step extends restore_structure_step {
2347     protected function define_structure() {
2349         $paths = array();
2350         $userinfo = $this->get_setting_value('userinfo');
2352         $paths[] = new restore_path_element('grade_item', '/activity_gradebook/grade_items/grade_item');
2353         $paths[] = new restore_path_element('grade_letter', '/activity_gradebook/grade_letters/grade_letter');
2354         if ($userinfo) {
2355             $paths[] = new restore_path_element('grade_grade',
2356                            '/activity_gradebook/grade_items/grade_item/grade_grades/grade_grade');
2357         }
2358         return $paths;
2359     }
2361     protected function process_grade_item($data) {
2362         global $DB;
2364         $data = (object)($data);
2365         $oldid       = $data->id;        // We'll need these later
2366         $oldparentid = $data->categoryid;
2367         $courseid = $this->get_courseid();
2369         // make sure top course category exists, all grade items will be associated
2370         // to it. Later, if restoring the whole gradebook, categories will be introduced
2371         $coursecat = grade_category::fetch_course_category($courseid);
2372         $coursecatid = $coursecat->id; // Get the categoryid to be used
2374         $idnumber = null;
2375         if (!empty($data->idnumber)) {
2376             // Don't get any idnumber from course module. Keep them as they are in grade_item->idnumber
2377             // Reason: it's not clear what happens with outcomes->idnumber or activities with multiple items (workshop)
2378             // so the best is to keep the ones already in the gradebook
2379             // Potential problem: duplicates if same items are restored more than once. :-(
2380             // This needs to be fixed in some way (outcomes & activities with multiple items)
2381             // $data->idnumber     = get_coursemodule_from_instance($data->itemmodule, $data->iteminstance)->idnumber;
2382             // In any case, verify always for uniqueness
2383             $sql = "SELECT cm.id
2384                       FROM {course_modules} cm
2385                      WHERE cm.course = :courseid AND
2386                            cm.idnumber = :idnumber AND
2387                            cm.id <> :cmid";
2388             $params = array(
2389                 'courseid' => $courseid,
2390                 'idnumber' => $data->idnumber,
2391                 'cmid' => $this->task->get_moduleid()
2392             );
2393             if (!$DB->record_exists_sql($sql, $params) && !$DB->record_exists('grade_items', array('courseid' => $courseid, 'idnumber' => $data->idnumber))) {
2394                 $idnumber = $data->idnumber;
2395             }
2396         }
2398         unset($data->id);
2399         $data->categoryid   = $coursecatid;
2400         $data->courseid     = $this->get_courseid();
2401         $data->iteminstance = $this->task->get_activityid();
2402         $data->idnumber     = $idnumber;
2403         $data->scaleid      = $this->get_mappingid('scale', $data->scaleid);
2404         $data->outcomeid    = $this->get_mappingid('outcome', $data->outcomeid);
2405         $data->timecreated  = $this->apply_date_offset($data->timecreated);
2406         $data->timemodified = $this->apply_date_offset($data->timemodified);
2408         $gradeitem = new grade_item($data, false);
2409         $gradeitem->insert('restore');
2411         //sortorder is automatically assigned when inserting. Re-instate the previous sortorder
2412         $gradeitem->sortorder = $data->sortorder;
2413         $gradeitem->update('restore');
2415         // Set mapping, saving the original category id into parentitemid
2416         // gradebook restore (final task) will need it to reorganise items
2417         $this->set_mapping('grade_item', $oldid, $gradeitem->id, false, null, $oldparentid);
2418     }
2420     protected function process_grade_grade($data) {
2421         $data = (object)($data);
2422         $olduserid = $data->userid;
2423         unset($data->id);
2425         $data->itemid = $this->get_new_parentid('grade_item');
2427         $data->userid = $this->get_mappingid('user', $data->userid, null);
2428         if (!empty($data->userid)) {
2429             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
2430             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
2431             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
2432             $data->overridden = $this->apply_date_offset($data->overridden);
2434             $grade = new grade_grade($data, false);
2435             $grade->insert('restore');
2436             // no need to save any grade_grade mapping
2437         } else {
2438             debugging("Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'");
2439         }
2440     }
2442     /**
2443      * process activity grade_letters. Note that, while these are possible,
2444      * because grade_letters are contextid based, in practice, only course
2445      * context letters can be defined. So we keep here this method knowing
2446      * it won't be executed ever. gradebook restore will restore course letters.
2447      */
2448     protected function process_grade_letter($data) {
2449         global $DB;
2451         $data['contextid'] = $this->task->get_contextid();
2452         $gradeletter = (object)$data;
2454         // Check if it exists before adding it
2455         unset($data['id']);
2456         if (!$DB->record_exists('grade_letters', $data)) {
2457             $newitemid = $DB->insert_record('grade_letters', $gradeletter);
2458         }
2459         // no need to save any grade_letter mapping
2460     }
2464 /**
2465  * This structure steps restores one instance + positions of one block
2466  * Note: Positions corresponding to one existing context are restored
2467  * here, but all the ones having unknown contexts are sent to backup_ids
2468  * for a later chance to be restored at the end (final task)
2469  */
2470 class restore_block_instance_structure_step extends restore_structure_step {
2472     protected function define_structure() {
2474         $paths = array();
2476         $paths[] = new restore_path_element('block', '/block', true); // Get the whole XML together
2477         $paths[] = new restore_path_element('block_position', '/block/block_positions/block_position');
2479         return $paths;
2480     }
2482     public function process_block($data) {
2483         global $DB, $CFG;
2485         $data = (object)$data; // Handy
2486         $oldcontextid = $data->contextid;
2487         $oldid        = $data->id;
2488         $positions = isset($data->block_positions['block_position']) ? $data->block_positions['block_position'] : array();
2490         // Look for the parent contextid
2491         if (!$data->parentcontextid = $this->get_mappingid('context', $data->parentcontextid)) {
2492             throw new restore_step_exception('restore_block_missing_parent_ctx', $data->parentcontextid);
2493         }
2495         // TODO: it would be nice to use standard plugin supports instead of this instance_allow_multiple()
2496         // If there is already one block of that type in the parent context
2497         // and the block is not multiple, stop processing
2498         // Use blockslib loader / method executor
2499         if (!$bi = block_instance($data->blockname)) {
2500             return false;
2501         }
2503         if (!$bi->instance_allow_multiple()) {
2504             if ($DB->record_exists_sql("SELECT bi.id
2505                                           FROM {block_instances} bi
2506                                           JOIN {block} b ON b.name = bi.blockname
2507                                          WHERE bi.parentcontextid = ?
2508                                            AND bi.blockname = ?", array($data->parentcontextid, $data->blockname))) {
2509                 return false;
2510             }
2511         }
2513         // If there is already one block of that type in the parent context
2514         // with the same showincontexts, pagetypepattern, subpagepattern, defaultregion and configdata
2515         // stop processing
2516         $params = array(
2517             'blockname' => $data->blockname, 'parentcontextid' => $data->parentcontextid,
2518             'showinsubcontexts' => $data->showinsubcontexts, 'pagetypepattern' => $data->pagetypepattern,
2519             'subpagepattern' => $data->subpagepattern, 'defaultregion' => $data->defaultregion);
2520         if ($birecs = $DB->get_records('block_instances', $params)) {
2521             foreach($birecs as $birec) {
2522                 if ($birec->configdata == $data->configdata) {
2523                     return false;
2524                 }
2525             }
2526         }
2528         // Set task old contextid, blockid and blockname once we know them
2529         $this->task->set_old_contextid($oldcontextid);
2530         $this->task->set_old_blockid($oldid);
2531         $this->task->set_blockname($data->blockname);
2533         // Let's look for anything within configdata neededing processing
2534         // (nulls and uses of legacy file.php)
2535         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
2536             $configdata = (array)unserialize(base64_decode($data->configdata));
2537             foreach ($configdata as $attribute => $value) {
2538                 if (in_array($attribute, $attrstotransform)) {
2539                     $configdata[$attribute] = $this->contentprocessor->process_cdata($value);
2540                 }
2541             }
2542             $data->configdata = base64_encode(serialize((object)$configdata));
2543         }
2545         // Create the block instance
2546         $newitemid = $DB->insert_record('block_instances', $data);
2547         // Save the mapping (with restorefiles support)
2548         $this->set_mapping('block_instance', $oldid, $newitemid, true);
2549         // Create the block context
2550         $newcontextid = get_context_instance(CONTEXT_BLOCK, $newitemid)->id;
2551         // Save the block contexts mapping and sent it to task
2552         $this->set_mapping('context', $oldcontextid, $newcontextid);
2553         $this->task->set_contextid($newcontextid);
2554         $this->task->set_blockid($newitemid);
2556         // Restore block fileareas if declared
2557         $component = 'block_' . $this->task->get_blockname();
2558         foreach ($this->task->get_fileareas() as $filearea) { // Simple match by contextid. No itemname needed
2559             $this->add_related_files($component, $filearea, null);
2560         }
2562         // Process block positions, creating them or accumulating for final step
2563         foreach($positions as $position) {
2564             $position = (object)$position;
2565             $position->blockinstanceid = $newitemid; // The instance is always the restored one
2566             // If position is for one already mapped (known) contextid
2567             // process it now, creating the position
2568             if ($newpositionctxid = $this->get_mappingid('context', $position->contextid)) {
2569                 $position->contextid = $newpositionctxid;
2570                 // Create the block position
2571                 $DB->insert_record('block_positions', $position);
2573             // The position belongs to an unknown context, send it to backup_ids
2574             // to process them as part of the final steps of restore. We send the
2575             // whole $position object there, hence use the low level method.
2576             } else {
2577                 restore_dbops::set_backup_ids_record($this->get_restoreid(), 'block_position', $position->id, 0, null, $position);
2578             }
2579         }
2580     }
2583 /**
2584  * Structure step to restore common course_module information
2585  *
2586  * This step will process the module.xml file for one activity, in order to restore
2587  * the corresponding information to the course_modules table, skipping various bits
2588  * of information based on CFG settings (groupings, completion...) in order to fullfill
2589  * all the reqs to be able to create the context to be used by all the rest of steps
2590  * in the activity restore task
2591  */
2592 class restore_module_structure_step extends restore_structure_step {
2594     protected function define_structure() {
2595         global $CFG;
2597         $paths = array();
2599         $module = new restore_path_element('module', '/module');
2600         $paths[] = $module;
2601         if ($CFG->enableavailability) {
2602             $paths[] = new restore_path_element('availability', '/module/availability_info/availability');
2603         }
2605         // Apply for 'format' plugins optional paths at module level
2606         $this->add_plugin_structure('format', $module);
2608         // Apply for 'plagiarism' plugins optional paths at module level
2609         $this->add_plugin_structure('plagiarism', $module);
2611         return $paths;
2612     }
2614     protected function process_module($data) {
2615         global $CFG, $DB;
2617         $data = (object)$data;
2618         $oldid = $data->id;
2619         $this->task->set_old_moduleversion($data->version);
2621         $data->course = $this->task->get_courseid();
2622         $data->module = $DB->get_field('modules', 'id', array('name' => $data->modulename));
2623         // Map section (first try by course_section mapping match. Useful in course and section restores)
2624         $data->section = $this->get_mappingid('course_section', $data->sectionid);
2625         if (!$data->section) { // mapping failed, try to get section by sectionnumber matching
2626             $params = array(
2627                 'course' => $this->get_courseid(),
2628                 'section' => $data->sectionnumber);
2629             $data->section = $DB->get_field('course_sections', 'id', $params);
2630         }
2631         if (!$data->section) { // sectionnumber failed, try to get first section in course
2632             $params = array(
2633                 'course' => $this->get_courseid());
2634             $data->section = $DB->get_field('course_sections', 'MIN(id)', $params);
2635         }
2636         if (!$data->section) { // no sections in course, create section 0 and 1 and assign module to 1
2637             $sectionrec = array(
2638                 'course' => $this->get_courseid(),
2639                 'section' => 0);
2640             $DB->insert_record('course_sections', $sectionrec); // section 0
2641             $sectionrec = array(
2642                 'course' => $this->get_courseid(),
2643                 'section' => 1);
2644             $data->section = $DB->insert_record('course_sections', $sectionrec); // section 1
2645         }
2646         $data->groupingid= $this->get_mappingid('grouping', $data->groupingid);      // grouping
2647         if (!$CFG->enablegroupmembersonly) {                                         // observe groupsmemberonly
2648             $data->groupmembersonly = 0;
2649         }
2650         if (!grade_verify_idnumber($data->idnumber, $this->get_courseid())) {        // idnumber uniqueness
2651             $data->idnumber = '';
2652         }
2653         if (empty($CFG->enablecompletion)) { // completion
2654             $data->completion = 0;
2655             $data->completiongradeitemnumber = null;
2656             $data->completionview = 0;
2657             $data->completionexpected = 0;
2658         } else {
2659             $data->completionexpected = $this->apply_date_offset($data->completionexpected);
2660         }
2661         if (empty($CFG->enableavailability)) {
2662             $data->availablefrom = 0;
2663             $data->availableuntil = 0;
2664             $data->showavailability = 0;
2665         } else {
2666             $data->availablefrom = $this->apply_date_offset($data->availablefrom);
2667             $data->availableuntil= $this->apply_date_offset($data->availableuntil);
2668         }
2669         // Backups that did not include showdescription, set it to default 0
2670         // (this is not totally necessary as it has a db default, but just to
2671         // be explicit).
2672         if (!isset($data->showdescription)) {
2673             $data->showdescription = 0;
2674         }
2675         $data->instance = 0; // Set to 0 for now, going to create it soon (next step)
2677         // course_module record ready, insert it
2678         $newitemid = $DB->insert_record('course_modules', $data);
2679         // save mapping
2680         $this->set_mapping('course_module', $oldid, $newitemid);
2681         // set the new course_module id in the task
2682         $this->task->set_moduleid($newitemid);
2683         // we can now create the context safely
2684         $ctxid = get_context_instance(CONTEXT_MODULE, $newitemid)->id;
2685         // set the new context id in the task
2686         $this->task->set_contextid($ctxid);
2687         // update sequence field in course_section
2688         if ($sequence = $DB->get_field('course_sections', 'sequence', array('id' => $data->section))) {
2689             $sequence .= ',' . $newitemid;
2690         } else {
2691             $sequence = $newitemid;
2692         }
2693         $DB->set_field('course_sections', 'sequence', $sequence, array('id' => $data->section));
2694     }
2697     protected function process_availability($data) {
2698         $data = (object)$data;
2699         // Simply going to store the whole availability record now, we'll process
2700         // all them later in the final task (once all actvivities have been restored)
2701         // Let's call the low level one to be able to store the whole object
2702         $data->coursemoduleid = $this->task->get_moduleid(); // Let add the availability cmid
2703         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'module_availability', $data->id, 0, null, $data);
2704     }
2707 /**
2708  * Structure step that will process the user activity completion
2709  * information if all these conditions are met:
2710  *  - Target site has completion enabled ($CFG->enablecompletion)
2711  *  - Activity includes completion info (file_exists)
2712  */
2713 class restore_userscompletion_structure_step extends restore_structure_step {
2714     /**
2715      * To conditionally decide if this step must be executed
2716      * Note the "settings" conditions are evaluated in the
2717      * corresponding task. Here we check for other conditions
2718      * not being restore settings (files, site settings...)
2719      */
2720      protected function execute_condition() {
2721          global $CFG;
2723          // Completion disabled in this site, don't execute
2724          if (empty($CFG->enablecompletion)) {
2725              return false;
2726          }
2728          // No user completion info found, don't execute
2729         $fullpath = $this->task->get_taskbasepath();
2730         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2731          if (!file_exists($fullpath)) {
2732              return false;
2733          }
2735          // Arrived here, execute the step
2736          return true;
2737      }
2739      protected function define_structure() {
2741         $paths = array();
2743         $paths[] = new restore_path_element('completion', '/completions/completion');
2745         return $paths;
2746     }
2748     protected function process_completion($data) {
2749         global $DB;
2751         $data = (object)$data;
2753         $data->coursemoduleid = $this->task->get_moduleid();
2754         $data->userid = $this->get_mappingid('user', $data->userid);
2755         $data->timemodified = $this->apply_date_offset($data->timemodified);
2757         // Find the existing record
2758         $existing = $DB->get_record('course_modules_completion', array(
2759                 'coursemoduleid' => $data->coursemoduleid,
2760                 'userid' => $data->userid), 'id, timemodified');
2761         // Check we didn't already insert one for this cmid and userid
2762         // (there aren't supposed to be duplicates in that field, but
2763         // it was possible until MDL-28021 was fixed).
2764         if ($existing) {
2765             // Update it to these new values, but only if the time is newer
2766             if ($existing->timemodified < $data->timemodified) {
2767                 $data->id = $existing->id;
2768                 $DB->update_record('course_modules_completion', $data);
2769             }
2770         } else {
2771             // Normal entry where it doesn't exist already
2772             $DB->insert_record('course_modules_completion', $data);
2773         }
2774     }
2777 /**
2778  * Abstract structure step, parent of all the activity structure steps. Used to suuport
2779  * the main <activity ...> tag and process it. Also provides subplugin support for
2780  * activities.
2781  */
2782 abstract class restore_activity_structure_step extends restore_structure_step {
2784     protected function add_subplugin_structure($subplugintype, $element) {
2786         global $CFG;
2788         // Check the requested subplugintype is a valid one
2789         $subpluginsfile = $CFG->dirroot . '/mod/' . $this->task->get_modulename() . '/db/subplugins.php';
2790         if (!file_exists($subpluginsfile)) {
2791              throw new restore_step_exception('activity_missing_subplugins_php_file', $this->task->get_modulename());
2792         }
2793         include($subpluginsfile);
2794         if (!array_key_exists($subplugintype, $subplugins)) {
2795              throw new restore_step_exception('incorrect_subplugin_type', $subplugintype);
2796         }
2797         // Get all the restore path elements, looking across all the subplugin dirs
2798         $subpluginsdirs = get_plugin_list($subplugintype);
2799         foreach ($subpluginsdirs as $name => $subpluginsdir) {
2800             $classname = 'restore_' . $subplugintype . '_' . $name . '_subplugin';
2801             $restorefile = $subpluginsdir . '/backup/moodle2/' . $classname . '.class.php';
2802             if (file_exists($restorefile)) {
2803                 require_once($restorefile);
2804                 $restoresubplugin = new $classname($subplugintype, $name, $this);
2805                 // Add subplugin paths to the step
2806                 $this->prepare_pathelements($restoresubplugin->define_subplugin_structure($element));
2807             }
2808         }
2809     }
2811     /**
2812      * As far as activity restore steps are implementing restore_subplugin stuff, they need to
2813      * have the parent task available for wrapping purposes (get course/context....)
2814      * @return restore_task
2815      */
2816     public function get_task() {
2817         return $this->task;
2818     }
2820     /**
2821      * Adds support for the 'activity' path that is common to all the activities
2822      * and will be processed globally here
2823      */
2824     protected function prepare_activity_structure($paths) {
2826         $paths[] = new restore_path_element('activity', '/activity');
2828         return $paths;
2829     }
2831     /**
2832      * Process the activity path, informing the task about various ids, needed later
2833      */
2834     protected function process_activity($data) {
2835         $data = (object)$data;
2836         $this->task->set_old_contextid($data->contextid); // Save old contextid in task
2837         $this->set_mapping('context', $data->contextid, $this->task->get_contextid()); // Set the mapping
2838         $this->task->set_old_activityid($data->id); // Save old activityid in task
2839     }
2841     /**
2842      * This must be invoked immediately after creating the "module" activity record (forum, choice...)
2843      * and will adjust the new activity id (the instance) in various places
2844      */
2845     protected function apply_activity_instance($newitemid) {
2846         global $DB;
2848         $this->task->set_activityid($newitemid); // Save activity id in task
2849         // Apply the id to course_sections->instanceid
2850         $DB->set_field('course_modules', 'instance', $newitemid, array('id' => $this->task->get_moduleid()));
2851         // Do the mapping for modulename, preparing it for files by oldcontext
2852         $modulename = $this->task->get_modulename();
2853         $oldid = $this->task->get_old_activityid();
2854         $this->set_mapping($modulename, $oldid, $newitemid, true);
2855     }
2858 /**
2859  * Structure step in charge of creating/mapping all the qcats and qs
2860  * by parsing the questions.xml file and checking it against the
2861  * results calculated by {@link restore_process_categories_and_questions}
2862  * and stored in backup_ids_temp
2863  */
2864 class restore_create_categories_and_questions extends restore_structure_step {
2866     protected function define_structure() {
2868         $category = new restore_path_element('question_category', '/question_categories/question_category');
2869         $question = new restore_path_element('question', '/question_categories/question_category/questions/question');
2870         $hint = new restore_path_element('question_hint',
2871                 '/question_categories/question_category/questions/question/question_hints/question_hint');
2873         // Apply for 'qtype' plugins optional paths at question level
2874         $this->add_plugin_structure('qtype', $question);
2876         return array($category, $question, $hint);
2877     }
2879     protected function process_question_category($data) {
2880         global $DB;
2882         $data = (object)$data;
2883         $oldid = $data->id;
2885         // Check we have one mapping for this category
2886         if (!$mapping = $this->get_mapping('question_category', $oldid)) {
2887             return self::SKIP_ALL_CHILDREN; // No mapping = this category doesn't need to be created/mapped
2888         }
2890         // Check we have to create the category (newitemid = 0)
2891         if ($mapping->newitemid) {
2892             return; // newitemid != 0, this category is going to be mapped. Nothing to do
2893         }
2895         // Arrived here, newitemid = 0, we need to create the category
2896         // we'll do it at parentitemid context, but for CONTEXT_MODULE
2897         // categories, that will be created at CONTEXT_COURSE and moved
2898         // to module context later when the activity is created
2899         if ($mapping->info->contextlevel == CONTEXT_MODULE) {
2900             $mapping->parentitemid = $this->get_mappingid('context', $this->task->get_old_contextid());
2901         }
2902         $data->contextid = $mapping->parentitemid;
2904         // Let's create the question_category and save mapping
2905         $newitemid = $DB->insert_record('question_categories', $data);
2906         $this->set_mapping('question_category', $oldid, $newitemid);
2907         // Also annotate them as question_category_created, we need
2908         // that later when remapping parents
2909         $this->set_mapping('question_category_created', $oldid, $newitemid, false, null, $data->contextid);
2910     }
2912     protected function process_question($data) {
2913         global $DB;
2915         $data = (object)$data;
2916         $oldid = $data->id;
2918         // Check we have one mapping for this question
2919         if (!$questionmapping = $this->get_mapping('question', $oldid)) {
2920             return; // No mapping = this question doesn't need to be created/mapped
2921         }
2923         // Get the mapped category (cannot use get_new_parentid() because not
2924         // all the categories have been created, so it is not always available
2925         // Instead we get the mapping for the question->parentitemid because
2926         // we have loaded qcatids there for all parsed questions
2927         $data->category = $this->get_mappingid('question_category', $questionmapping->parentitemid);
2929         // In the past, there were some very sloppy values of penalty. Fix them.
2930         if ($data->penalty >= 0.33 && $data->penalty <= 0.34) {
2931             $data->penalty = 0.3333333;
2932         }
2933         if ($data->penalty >= 0.66 && $data->penalty <= 0.67) {
2934             $data->penalty = 0.6666667;
2935         }
2936         if ($data->penalty >= 1) {
2937             $data->penalty = 1;
2938         }
2940         $userid = $this->get_mappingid('user', $data->createdby);
2941         $data->createdby = $userid ? $userid : $this->task->get_userid();
2943         $userid = $this->get_mappingid('user', $data->modifiedby);
2944         $data->modifiedby = $userid ? $userid : $this->task->get_userid();
2946         // With newitemid = 0, let's create the question
2947         if (!$questionmapping->newitemid) {
2948             $newitemid = $DB->insert_record('question', $data);
2949             $this->set_mapping('question', $oldid, $newitemid);
2950             // Also annotate them as question_created, we need
2951             // that later when remapping parents (keeping the old categoryid as parentid)
2952             $this->set_mapping('question_created', $oldid, $newitemid, false, null, $questionmapping->parentitemid);
2953         } else {
2954             // By performing this set_mapping() we make get_old/new_parentid() to work for all the
2955             // children elements of the 'question' one (so qtype plugins will know the question they belong to)
2956             $this->set_mapping('question', $oldid, $questionmapping->newitemid);
2957         }
2959         // Note, we don't restore any question files yet
2960         // as far as the CONTEXT_MODULE categories still
2961         // haven't their contexts to be restored to
2962         // The {@link restore_create_question_files}, executed in the final step
2963         // step will be in charge of restoring all the question files
2964     }
2966         protected function process_question_hint($data) {
2967         global $DB;
2969         $data = (object)$data;
2970         $oldid = $data->id;
2972         // Detect if the question is created or mapped
2973         $oldquestionid   = $this->get_old_parentid('question');
2974         $newquestionid   = $this->get_new_parentid('question');
2975         $questioncreated = $this->get_mappingid('question_created', $oldquestionid) ? true : false;
2977         // If the question has been created by restore, we need to create its question_answers too
2978         if ($questioncreated) {
2979             // Adjust some columns
2980             $data->questionid = $newquestionid;
2981             // Insert record
2982             $newitemid = $DB->insert_record('question_hints', $data);
2984         // The question existed, we need to map the existing question_hints
2985         } else {
2986             // Look in question_hints by hint text matching
2987             $sql = 'SELECT id
2988                       FROM {question_hints}
2989                      WHERE questionid = ?
2990                        AND ' . $DB->sql_compare_text('hint', 255) . ' = ' . $DB->sql_compare_text('?', 255);
2991             $params = array($newquestionid, $data->hint);
2992             $newitemid = $DB->get_field_sql($sql, $params);
2994             // Not able to find the hint, let's try cleaning the hint text
2995             // of all the question's hints in DB as slower fallback. MDL-33863.
2996             if (!$newitemid) {
2997                 $potentialhints = $DB->get_records('question_hints',
2998                         array('questionid' => $newquestionid), '', 'id, hint');
2999                 foreach ($potentialhints as $potentialhint) {
3000                     // Clean in the same way than {@link xml_writer::xml_safe_utf8()}.
3001                     $cleanhint = preg_replace('/[\x-\x8\xb-\xc\xe-\x1f\x7f]/is','', $potentialhint->hint); // Clean CTRL chars.
3002                     $cleanhint = preg_replace("/\r\n|\r/", "\n", $cleanhint); // Normalize line ending.
3003                     if ($cleanhint === $data->hint) {
3004                         $newitemid = $data->id;
3005                     }
3006                 }
3007             }
3009             // If we haven't found the newitemid, something has gone really wrong, question in DB
3010             // is missing hints, exception
3011             if (!$newitemid) {
3012                 $info = new stdClass();
3013                 $info->filequestionid = $oldquestionid;
3014                 $info->dbquestionid   = $newquestionid;
3015                 $info->hint           = $data->hint;
3016                 throw new restore_step_exception('error_question_hint_missing_in_db', $info);
3017             }
3018         }
3019         // Create mapping (I'm not sure if this is really needed?)
3020         $this->set_mapping('question_hint', $oldid, $newitemid);
3021     }
3023     protected function after_execute() {
3024         global $DB;
3026         // First of all, recode all the created question_categories->parent fields
3027         $qcats = $DB->get_records('backup_ids_temp', array(
3028                      'backupid' => $this->get_restoreid(),
3029                      'itemname' => 'question_category_created'));
3030         foreach ($qcats as $qcat) {
3031             $newparent = 0;
3032             $dbcat = $DB->get_record('question_categories', array('id' => $qcat->newitemid));
3033             // Get new parent (mapped or created, so we look in quesiton_category mappings)
3034             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
3035                                  'backupid' => $this->get_restoreid(),
3036                                  'itemname' => 'question_category',
3037                                  'itemid'   => $dbcat->parent))) {
3038                 // contextids must match always, as far as we always include complete qbanks, just check it
3039                 $newparentctxid = $DB->get_field('question_categories', 'contextid', array('id' => $newparent));
3040                 if ($dbcat->contextid == $newparentctxid) {
3041                     $DB->set_field('question_categories', 'parent', $newparent, array('id' => $dbcat->id));
3042                 } else {
3043                     $newparent = 0; // No ctx match for both cats, no parent relationship
3044                 }
3045             }
3046             // Here with $newparent empty, problem with contexts or remapping, set it to top cat
3047             if (!$newparent) {
3048                 $DB->set_field('question_categories', 'parent', 0, array('id' => $dbcat->id));
3049             }
3050         }
3052         // Now, recode all the created question->parent fields
3053         $qs = $DB->get_records('backup_ids_temp', array(
3054                   'backupid' => $this->get_restoreid(),
3055                   'itemname' => 'question_created'));
3056         foreach ($qs as $q) {
3057             $newparent = 0;
3058             $dbq = $DB->get_record('question', array('id' => $q->newitemid));
3059             // Get new parent (mapped or created, so we look in question mappings)
3060             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
3061                                  'backupid' => $this->get_restoreid(),
3062                                  'itemname' => 'question',
3063                                  'itemid'   => $dbq->parent))) {
3064                 $DB->set_field('question', 'parent', $newparent, array('id' => $dbq->id));
3065             }
3066         }
3068         // Note, we don't restore any question files yet
3069         // as far as the CONTEXT_MODULE categories still
3070         // haven't their contexts to be restored to
3071         // The {@link restore_create_question_files}, executed in the final step
3072         // step will be in charge of restoring all the question files
3073     }
3076 /**
3077  * Execution step that will move all the CONTEXT_MODULE question categories
3078  * created at early stages of restore in course context (because modules weren't
3079  * created yet) to their target module (matching by old-new-contextid mapping)
3080  */
3081 class restore_move_module_questions_categories extends restore_execution_step {
3083     protected function define_execution() {
3084         global $DB;
3086         $contexts = restore_dbops::restore_get_question_banks($this->get_restoreid(), CONTEXT_MODULE);
3087         foreach ($contexts as $contextid => $contextlevel) {
3088             // Only if context mapping exists (i.e. the module has been restored)
3089             if ($newcontext = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $contextid)) {
3090                 // Update all the qcats having their parentitemid set to the original contextid
3091                 $modulecats = $DB->get_records_sql("SELECT itemid, newitemid
3092                                                       FROM {backup_ids_temp}
3093                                                      WHERE backupid = ?
3094                                                        AND itemname = 'question_category'
3095                                                        AND parentitemid = ?", array($this->get_restoreid(), $contextid));
3096                 foreach ($modulecats as $modulecat) {
3097                     $DB->set_field('question_categories', 'contextid', $newcontext->newitemid, array('id' => $modulecat->newitemid));
3098                     // And set new contextid also in question_category mapping (will be
3099                     // used by {@link restore_create_question_files} later
3100                     restore_dbops::set_backup_ids_record($this->get_restoreid(), 'question_category', $modulecat->itemid, $modulecat->newitemid, $newcontext->newitemid);
3101                 }
3102             }
3103         }
3104     }
3107 /**
3108  * Execution step that will create all the question/answers/qtype-specific files for the restored
3109  * questions. It must be executed after {@link restore_move_module_questions_categories}
3110  * because only then each question is in its final category and only then the
3111  * context can be determined
3112  *
3113  * TODO: Improve this. Instead of looping over each question, it can be reduced to
3114  *       be done by contexts (this will save a huge ammount of queries)
3115  */
3116 class restore_create_question_files extends restore_execution_step {
3118     protected function define_execution() {
3119         global $DB;
3121         // Let's process only created questions
3122         $questionsrs = $DB->get_recordset_sql("SELECT bi.itemid, bi.newitemid, bi.parentitemid, q.qtype
3123                                                FROM {backup_ids_temp} bi
3124                                                JOIN {question} q ON q.id = bi.newitemid
3125                                               WHERE bi.backupid = ?
3126                                                 AND bi.itemname = 'question_created'", array($this->get_restoreid()));
3127         foreach ($questionsrs as $question) {
3128             // Get question_category mapping, it contains the target context for the question
3129             if (!$qcatmapping = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'question_category', $question->parentitemid)) {
3130                 // Something went really wrong, cannot find the question_category for the question
3131                 debugging('Error fetching target context for question', DEBUG_DEVELOPER);
3132                 continue;
3133             }
3134             // Calculate source and target contexts
3135             $oldctxid = $qcatmapping->info->contextid;
3136             $newctxid = $qcatmapping->parentitemid;
3138             // Add common question files (question and question_answer ones)
3139             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'questiontext',
3140                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3141             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'generalfeedback',
3142                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3143             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'answer',
3144                                               $oldctxid, $this->task->get_userid(), 'question_answer', null, $newctxid, true);
3145             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'answerfeedback',
3146                                               $oldctxid, $this->task->get_userid(), 'question_answer', null, $newctxid, true);
3147             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'hint',
3148                                               $oldctxid, $this->task->get_userid(), 'question_hint', null, $newctxid, true);
3149             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'correctfeedback',
3150                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3151             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'partiallycorrectfeedback',
3152                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3153             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'incorrectfeedback',
3154                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3155             // Add qtype dependent files
3156             $components = backup_qtype_plugin::get_components_and_fileareas($question->qtype);
3157             foreach ($components as $component => $fileareas) {
3158                 foreach ($fileareas as $filearea => $mapping) {
3159                     // Use itemid only if mapping is question_created
3160                     $itemid = ($mapping == 'question_created') ? $question->itemid : null;
3161                     restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), $component, $filearea,
3162                                                       $oldctxid, $this->task->get_userid(), $mapping, $itemid, $newctxid, true);
3163                 }
3164             }
3165         }
3166         $questionsrs->close();
3167     }
3171 /**
3172  * Try to restore aliases and references to external files.
3173  *
3174  * The queue of these files was prepared for us in {@link restore_dbops::send_files_to_pool()}.
3175  * We expect that all regular (non-alias) files have already been restored. Make sure
3176  * there is no restore step executed after this one that would call send_files_to_pool() again.
3177  *
3178  * You may notice we have hardcoded support for Server files, Legacy course files
3179  * and user Private files here at the moment. This could be eventually replaced with a set of
3180  * callbacks in the future if needed.
3181  *
3182  * @copyright 2012 David Mudrak <david@moodle.com>
3183  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3184  */
3185 class restore_process_file_aliases_queue extends restore_execution_step {
3187     /** @var array internal cache for {@link choose_repository() */
3188     private $cachereposbyid = array();
3190     /** @var array internal cache for {@link choose_repository() */
3191     private $cachereposbytype = array();
3193     /**
3194      * What to do when this step is executed.
3195      */
3196     protected function define_execution() {
3197         global $DB;
3199         $this->log('processing file aliases queue', backup::LOG_INFO);
3201         $fs = get_file_storage();
3203         // Load the queue.
3204         $rs = $DB->get_recordset('backup_ids_temp',
3205             array('backupid' => $this->get_restoreid(), 'itemname' => 'file_aliases_queue'),
3206             '', 'info');
3208         // Iterate over aliases in the queue.
3209         foreach ($rs as $record) {
3210             $info = unserialize(base64_decode($record->info));
3212             // Try to pick a repository instance that should serve the alias.
3213             $repository = $this->choose_repository($info);
3215             if (is_null($repository)) {
3216                 $this->notify_failure($info, 'unable to find a matching repository instance');
3217                 continue;
3218             }
3220             if ($info->oldfile->repositorytype === 'local' or $info->oldfile->repositorytype === 'coursefiles') {
3221                 // Aliases to Server files and Legacy course files may refer to a file
3222                 // contained in the backup file or to some existing file (if we are on the
3223                 // same site).
3224                 try {
3225                     $reference = file_storage::unpack_reference($info->oldfile->reference);
3226                 } catch (Exception $e) {
3227                     $this->notify_failure($info, 'invalid reference field format');
3228                     continue;
3229                 }
3231                &