9fa8a9b5a13993bb426b1020809cc8ea326a5b6e
[moodle.git] / backup / moodle2 / restore_stepslib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Defines various restore steps that will be used by common tasks in restore
20  *
21  * @package     core_backup
22  * @subpackage  moodle2
23  * @category    backup
24  * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
25  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 defined('MOODLE_INTERNAL') || die();
30 /**
31  * delete old directories and conditionally create backup_temp_ids table
32  */
33 class restore_create_and_clean_temp_stuff extends restore_execution_step {
35     protected function define_execution() {
36         $exists = restore_controller_dbops::create_restore_temp_tables($this->get_restoreid()); // temp tables conditionally
37         // If the table already exists, it's because restore_prechecks have been executed in the same
38         // request (without problems) and it already contains a bunch of preloaded information (users...)
39         // that we aren't going to execute again
40         if ($exists) { // Inform plan about preloaded information
41             $this->task->set_preloaded_information();
42         }
43         // Create the old-course-ctxid to new-course-ctxid mapping, we need that available since the beginning
44         $itemid = $this->task->get_old_contextid();
45         $newitemid = context_course::instance($this->get_courseid())->id;
46         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'context', $itemid, $newitemid);
47         // Create the old-system-ctxid to new-system-ctxid mapping, we need that available since the beginning
48         $itemid = $this->task->get_old_system_contextid();
49         $newitemid = context_system::instance()->id;
50         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'context', $itemid, $newitemid);
51         // Create the old-course-id to new-course-id mapping, we need that available since the beginning
52         $itemid = $this->task->get_old_courseid();
53         $newitemid = $this->get_courseid();
54         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'course', $itemid, $newitemid);
56     }
57 }
59 /**
60  * delete the temp dir used by backup/restore (conditionally),
61  * delete old directories and drop temp ids table
62  */
63 class restore_drop_and_clean_temp_stuff extends restore_execution_step {
65     protected function define_execution() {
66         global $CFG;
67         restore_controller_dbops::drop_restore_temp_tables($this->get_restoreid()); // Drop ids temp table
68         $progress = $this->task->get_progress();
69         $progress->start_progress('Deleting backup dir');
70         backup_helper::delete_old_backup_dirs(time() - (4 * 60 * 60), $progress);              // Delete > 4 hours temp dirs
71         if (empty($CFG->keeptempdirectoriesonbackup)) { // Conditionally
72             backup_helper::delete_backup_dir($this->task->get_tempdir(), $progress); // Empty restore dir
73         }
74         $progress->end_progress();
75     }
76 }
78 /**
79  * Restore calculated grade items, grade categories etc
80  */
81 class restore_gradebook_structure_step extends restore_structure_step {
83     /**
84      * To conditionally decide if this step must be executed
85      * Note the "settings" conditions are evaluated in the
86      * corresponding task. Here we check for other conditions
87      * not being restore settings (files, site settings...)
88      */
89      protected function execute_condition() {
90         global $CFG, $DB;
92         // No gradebook info found, don't execute
93         $fullpath = $this->task->get_taskbasepath();
94         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
95         if (!file_exists($fullpath)) {
96             return false;
97         }
99         // Some module present in backup file isn't available to restore
100         // in this site, don't execute
101         if ($this->task->is_missing_modules()) {
102             return false;
103         }
105         // Some activity has been excluded to be restored, don't execute
106         if ($this->task->is_excluding_activities()) {
107             return false;
108         }
110         // There should only be one grade category (the 1 associated with the course itself)
111         // If other categories already exist we're restoring into an existing course.
112         // Restoring categories into a course with an existing category structure is unlikely to go well
113         $category = new stdclass();
114         $category->courseid  = $this->get_courseid();
115         $catcount = $DB->count_records('grade_categories', (array)$category);
116         if ($catcount>1) {
117             return false;
118         }
120         // Arrived here, execute the step
121         return true;
122      }
124     protected function define_structure() {
125         $paths = array();
126         $userinfo = $this->task->get_setting_value('users');
128         $paths[] = new restore_path_element('gradebook', '/gradebook');
129         $paths[] = new restore_path_element('grade_category', '/gradebook/grade_categories/grade_category');
130         $paths[] = new restore_path_element('grade_item', '/gradebook/grade_items/grade_item');
131         if ($userinfo) {
132             $paths[] = new restore_path_element('grade_grade', '/gradebook/grade_items/grade_item/grade_grades/grade_grade');
133         }
134         $paths[] = new restore_path_element('grade_letter', '/gradebook/grade_letters/grade_letter');
135         $paths[] = new restore_path_element('grade_setting', '/gradebook/grade_settings/grade_setting');
137         return $paths;
138     }
140     protected function process_gradebook($data) {
141     }
143     protected function process_grade_item($data) {
144         global $DB;
146         $data = (object)$data;
148         $oldid = $data->id;
149         $data->course = $this->get_courseid();
151         $data->courseid = $this->get_courseid();
153         if ($data->itemtype=='manual') {
154             // manual grade items store category id in categoryid
155             $data->categoryid = $this->get_mappingid('grade_category', $data->categoryid, NULL);
156             // if mapping failed put in course's grade category
157             if (NULL == $data->categoryid) {
158                 $coursecat = grade_category::fetch_course_category($this->get_courseid());
159                 $data->categoryid = $coursecat->id;
160             }
161         } else if ($data->itemtype=='course') {
162             // course grade item stores their category id in iteminstance
163             $coursecat = grade_category::fetch_course_category($this->get_courseid());
164             $data->iteminstance = $coursecat->id;
165         } else if ($data->itemtype=='category') {
166             // category grade items store their category id in iteminstance
167             $data->iteminstance = $this->get_mappingid('grade_category', $data->iteminstance, NULL);
168         } else {
169             throw new restore_step_exception('unexpected_grade_item_type', $data->itemtype);
170         }
172         $data->scaleid   = $this->get_mappingid('scale', $data->scaleid, NULL);
173         $data->outcomeid = $this->get_mappingid('outcome', $data->outcomeid, NULL);
175         $data->locktime     = $this->apply_date_offset($data->locktime);
176         $data->timecreated  = $this->apply_date_offset($data->timecreated);
177         $data->timemodified = $this->apply_date_offset($data->timemodified);
179         $coursecategory = $newitemid = null;
180         //course grade item should already exist so updating instead of inserting
181         if($data->itemtype=='course') {
182             //get the ID of the already created grade item
183             $gi = new stdclass();
184             $gi->courseid  = $this->get_courseid();
185             $gi->itemtype  = $data->itemtype;
187             //need to get the id of the grade_category that was automatically created for the course
188             $category = new stdclass();
189             $category->courseid  = $this->get_courseid();
190             $category->parent  = null;
191             //course category fullname starts out as ? but may be edited
192             //$category->fullname  = '?';
193             $coursecategory = $DB->get_record('grade_categories', (array)$category);
194             $gi->iteminstance = $coursecategory->id;
196             $existinggradeitem = $DB->get_record('grade_items', (array)$gi);
197             if (!empty($existinggradeitem)) {
198                 $data->id = $newitemid = $existinggradeitem->id;
199                 $DB->update_record('grade_items', $data);
200             }
201         } else if ($data->itemtype == 'manual') {
202             // Manual items aren't assigned to a cm, so don't go duplicating them in the target if one exists.
203             $gi = array(
204                 'itemtype' => $data->itemtype,
205                 'courseid' => $data->courseid,
206                 'itemname' => $data->itemname,
207                 'categoryid' => $data->categoryid,
208             );
209             $newitemid = $DB->get_field('grade_items', 'id', $gi);
210         }
212         if (empty($newitemid)) {
213             //in case we found the course category but still need to insert the course grade item
214             if ($data->itemtype=='course' && !empty($coursecategory)) {
215                 $data->iteminstance = $coursecategory->id;
216             }
218             $newitemid = $DB->insert_record('grade_items', $data);
219         }
220         $this->set_mapping('grade_item', $oldid, $newitemid);
221     }
223     protected function process_grade_grade($data) {
224         global $DB;
226         $data = (object)$data;
227         $olduserid = $data->userid;
229         $data->itemid = $this->get_new_parentid('grade_item');
231         $data->userid = $this->get_mappingid('user', $data->userid, null);
232         if (!empty($data->userid)) {
233             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
234             $data->locktime     = $this->apply_date_offset($data->locktime);
235             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
236             $data->overridden = $this->apply_date_offset($data->overridden);
237             $data->timecreated  = $this->apply_date_offset($data->timecreated);
238             $data->timemodified = $this->apply_date_offset($data->timemodified);
240             $newitemid = $DB->insert_record('grade_grades', $data);
241         } else {
242             debugging("Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'");
243         }
244     }
246     protected function process_grade_category($data) {
247         global $DB;
249         $data = (object)$data;
250         $oldid = $data->id;
252         $data->course = $this->get_courseid();
253         $data->courseid = $data->course;
255         $data->timecreated  = $this->apply_date_offset($data->timecreated);
256         $data->timemodified = $this->apply_date_offset($data->timemodified);
258         $newitemid = null;
259         //no parent means a course level grade category. That may have been created when the course was created
260         if(empty($data->parent)) {
261             //parent was being saved as 0 when it should be null
262             $data->parent = null;
264             //get the already created course level grade category
265             $category = new stdclass();
266             $category->courseid = $this->get_courseid();
267             $category->parent = null;
269             $coursecategory = $DB->get_record('grade_categories', (array)$category);
270             if (!empty($coursecategory)) {
271                 $data->id = $newitemid = $coursecategory->id;
272                 $DB->update_record('grade_categories', $data);
273             }
274         }
276         //need to insert a course category
277         if (empty($newitemid)) {
278             $newitemid = $DB->insert_record('grade_categories', $data);
279         }
280         $this->set_mapping('grade_category', $oldid, $newitemid);
281     }
282     protected function process_grade_letter($data) {
283         global $DB;
285         $data = (object)$data;
286         $oldid = $data->id;
288         $data->contextid = context_course::instance($this->get_courseid())->id;
290         $gradeletter = (array)$data;
291         unset($gradeletter['id']);
292         if (!$DB->record_exists('grade_letters', $gradeletter)) {
293             $newitemid = $DB->insert_record('grade_letters', $data);
294         } else {
295             $newitemid = $data->id;
296         }
298         $this->set_mapping('grade_letter', $oldid, $newitemid);
299     }
300     protected function process_grade_setting($data) {
301         global $DB;
303         $data = (object)$data;
304         $oldid = $data->id;
306         $data->courseid = $this->get_courseid();
308         if (!$DB->record_exists('grade_settings', array('courseid' => $data->courseid, 'name' => $data->name))) {
309             $newitemid = $DB->insert_record('grade_settings', $data);
310         } else {
311             $newitemid = $data->id;
312         }
314         $this->set_mapping('grade_setting', $oldid, $newitemid);
315     }
317     /**
318      * put all activity grade items in the correct grade category and mark all for recalculation
319      */
320     protected function after_execute() {
321         global $DB;
323         $conditions = array(
324             'backupid' => $this->get_restoreid(),
325             'itemname' => 'grade_item'//,
326             //'itemid'   => $itemid
327         );
328         $rs = $DB->get_recordset('backup_ids_temp', $conditions);
330         // We need this for calculation magic later on.
331         $mappings = array();
333         if (!empty($rs)) {
334             foreach($rs as $grade_item_backup) {
336                 // Store the oldid with the new id.
337                 $mappings[$grade_item_backup->itemid] = $grade_item_backup->newitemid;
339                 $updateobj = new stdclass();
340                 $updateobj->id = $grade_item_backup->newitemid;
342                 //if this is an activity grade item that needs to be put back in its correct category
343                 if (!empty($grade_item_backup->parentitemid)) {
344                     $oldcategoryid = $this->get_mappingid('grade_category', $grade_item_backup->parentitemid, null);
345                     if (!is_null($oldcategoryid)) {
346                         $updateobj->categoryid = $oldcategoryid;
347                         $DB->update_record('grade_items', $updateobj);
348                     }
349                 } else {
350                     //mark course and category items as needing to be recalculated
351                     $updateobj->needsupdate=1;
352                     $DB->update_record('grade_items', $updateobj);
353                 }
354             }
355         }
356         $rs->close();
358         // We need to update the calculations for calculated grade items that may reference old
359         // grade item ids using ##gi\d+##.
360         // $mappings can be empty, use 0 if so (won't match ever)
361         list($sql, $params) = $DB->get_in_or_equal(array_values($mappings), SQL_PARAMS_NAMED, 'param', true, 0);
362         $sql = "SELECT gi.id, gi.calculation
363                   FROM {grade_items} gi
364                  WHERE gi.id {$sql} AND
365                        calculation IS NOT NULL";
366         $rs = $DB->get_recordset_sql($sql, $params);
367         foreach ($rs as $gradeitem) {
368             // Collect all of the used grade item id references
369             if (preg_match_all('/##gi(\d+)##/', $gradeitem->calculation, $matches) < 1) {
370                 // This calculation doesn't reference any other grade items... EASY!
371                 continue;
372             }
373             // For this next bit we are going to do the replacement of id's in two steps:
374             // 1. We will replace all old id references with a special mapping reference.
375             // 2. We will replace all mapping references with id's
376             // Why do we do this?
377             // Because there potentially there will be an overlap of ids within the query and we
378             // we substitute the wrong id.. safest way around this is the two step system
379             $calculationmap = array();
380             $mapcount = 0;
381             foreach ($matches[1] as $match) {
382                 // Check that the old id is known to us, if not it was broken to begin with and will
383                 // continue to be broken.
384                 if (!array_key_exists($match, $mappings)) {
385                     continue;
386                 }
387                 // Our special mapping key
388                 $mapping = '##MAPPING'.$mapcount.'##';
389                 // The old id that exists within the calculation now
390                 $oldid = '##gi'.$match.'##';
391                 // The new id that we want to replace the old one with.
392                 $newid = '##gi'.$mappings[$match].'##';
393                 // Replace in the special mapping key
394                 $gradeitem->calculation = str_replace($oldid, $mapping, $gradeitem->calculation);
395                 // And record the mapping
396                 $calculationmap[$mapping] = $newid;
397                 $mapcount++;
398             }
399             // Iterate all special mappings for this calculation and replace in the new id's
400             foreach ($calculationmap as $mapping => $newid) {
401                 $gradeitem->calculation = str_replace($mapping, $newid, $gradeitem->calculation);
402             }
403             // Update the calculation now that its being remapped
404             $DB->update_record('grade_items', $gradeitem);
405         }
406         $rs->close();
408         // Need to correct the grade category path and parent
409         $conditions = array(
410             'courseid' => $this->get_courseid()
411         );
413         $rs = $DB->get_recordset('grade_categories', $conditions);
414         // Get all the parents correct first as grade_category::build_path() loads category parents from the DB
415         foreach ($rs as $gc) {
416             if (!empty($gc->parent)) {
417                 $grade_category = new stdClass();
418                 $grade_category->id = $gc->id;
419                 $grade_category->parent = $this->get_mappingid('grade_category', $gc->parent);
420                 $DB->update_record('grade_categories', $grade_category);
421             }
422         }
423         $rs->close();
425         // Now we can rebuild all the paths
426         $rs = $DB->get_recordset('grade_categories', $conditions);
427         foreach ($rs as $gc) {
428             $grade_category = new stdClass();
429             $grade_category->id = $gc->id;
430             $grade_category->path = grade_category::build_path($gc);
431             $grade_category->depth = substr_count($grade_category->path, '/') - 1;
432             $DB->update_record('grade_categories', $grade_category);
433         }
434         $rs->close();
436         // Restore marks items as needing update. Update everything now.
437         grade_regrade_final_grades($this->get_courseid());
438     }
441 /**
442  * decode all the interlinks present in restored content
443  * relying 100% in the restore_decode_processor that handles
444  * both the contents to modify and the rules to be applied
445  */
446 class restore_decode_interlinks extends restore_execution_step {
448     protected function define_execution() {
449         // Get the decoder (from the plan)
450         $decoder = $this->task->get_decoder();
451         restore_decode_processor::register_link_decoders($decoder); // Add decoder contents and rules
452         // And launch it, everything will be processed
453         $decoder->execute();
454     }
457 /**
458  * first, ensure that we have no gaps in section numbers
459  * and then, rebuid the course cache
460  */
461 class restore_rebuild_course_cache extends restore_execution_step {
463     protected function define_execution() {
464         global $DB;
466         // Although there is some sort of auto-recovery of missing sections
467         // present in course/formats... here we check that all the sections
468         // from 0 to MAX(section->section) exist, creating them if necessary
469         $maxsection = $DB->get_field('course_sections', 'MAX(section)', array('course' => $this->get_courseid()));
470         // Iterate over all sections
471         for ($i = 0; $i <= $maxsection; $i++) {
472             // If the section $i doesn't exist, create it
473             if (!$DB->record_exists('course_sections', array('course' => $this->get_courseid(), 'section' => $i))) {
474                 $sectionrec = array(
475                     'course' => $this->get_courseid(),
476                     'section' => $i);
477                 $DB->insert_record('course_sections', $sectionrec); // missing section created
478             }
479         }
481         // Rebuild cache now that all sections are in place
482         rebuild_course_cache($this->get_courseid());
483         cache_helper::purge_by_event('changesincourse');
484         cache_helper::purge_by_event('changesincoursecat');
485     }
488 /**
489  * Review all the tasks having one after_restore method
490  * executing it to perform some final adjustments of information
491  * not available when the task was executed.
492  */
493 class restore_execute_after_restore extends restore_execution_step {
495     protected function define_execution() {
497         // Simply call to the execute_after_restore() method of the task
498         // that always is the restore_final_task
499         $this->task->launch_execute_after_restore();
500     }
504 /**
505  * Review all the (pending) block positions in backup_ids, matching by
506  * contextid, creating positions as needed. This is executed by the
507  * final task, once all the contexts have been created
508  */
509 class restore_review_pending_block_positions extends restore_execution_step {
511     protected function define_execution() {
512         global $DB;
514         // Get all the block_position objects pending to match
515         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
516         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
517         // Process block positions, creating them or accumulating for final step
518         foreach($rs as $posrec) {
519             // Get the complete position object out of the info field.
520             $position = backup_controller_dbops::decode_backup_temp_info($posrec->info);
521             // If position is for one already mapped (known) contextid
522             // process it now, creating the position, else nothing to
523             // do, position finally discarded
524             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
525                 $position->contextid = $newctx->newitemid;
526                 // Create the block position
527                 $DB->insert_record('block_positions', $position);
528             }
529         }
530         $rs->close();
531     }
534 /**
535  * Process all the saved module availability records in backup_ids, matching
536  * course modules and grade item id once all them have been already restored.
537  * only if all matchings are satisfied the availability condition will be created.
538  * At the same time, it is required for the site to have that functionality enabled.
539  */
540 class restore_process_course_modules_availability extends restore_execution_step {
542     protected function define_execution() {
543         global $CFG, $DB;
545         // Site hasn't availability enabled
546         if (empty($CFG->enableavailability)) {
547             return;
548         }
550         // Get all the module_availability objects to process
551         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'module_availability');
552         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
553         // Process availabilities, creating them if everything matches ok
554         foreach($rs as $availrec) {
555             $allmatchesok = true;
556             // Get the complete availabilityobject
557             $availability = backup_controller_dbops::decode_backup_temp_info($availrec->info);
558             // Map the sourcecmid if needed and possible
559             if (!empty($availability->sourcecmid)) {
560                 $newcm = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'course_module', $availability->sourcecmid);
561                 if ($newcm) {
562                     $availability->sourcecmid = $newcm->newitemid;
563                 } else {
564                     $allmatchesok = false; // Failed matching, we won't create this availability rule
565                 }
566             }
567             // Map the gradeitemid if needed and possible
568             if (!empty($availability->gradeitemid)) {
569                 $newgi = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'grade_item', $availability->gradeitemid);
570                 if ($newgi) {
571                     $availability->gradeitemid = $newgi->newitemid;
572                 } else {
573                     $allmatchesok = false; // Failed matching, we won't create this availability rule
574                 }
575             }
576             if ($allmatchesok) { // Everything ok, create the availability rule
577                 $DB->insert_record('course_modules_availability', $availability);
578             }
579         }
580         $rs->close();
581     }
585 /*
586  * Execution step that, *conditionally* (if there isn't preloaded information)
587  * will load the inforef files for all the included course/section/activity tasks
588  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
589  */
590 class restore_load_included_inforef_records extends restore_execution_step {
592     protected function define_execution() {
594         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
595             return;
596         }
598         // Get all the included tasks
599         $tasks = restore_dbops::get_included_tasks($this->get_restoreid());
600         $progress = $this->task->get_progress();
601         $progress->start_progress($this->get_name(), count($tasks));
602         foreach ($tasks as $task) {
603             // Load the inforef.xml file if exists
604             $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
605             if (file_exists($inforefpath)) {
606                 // Load each inforef file to temp_ids.
607                 restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $inforefpath, $progress);
608             }
609         }
610         $progress->end_progress();
611     }
614 /*
615  * Execution step that will load all the needed files into backup_files_temp
616  *   - info: contains the whole original object (times, names...)
617  * (all them being original ids as loaded from xml)
618  */
619 class restore_load_included_files extends restore_structure_step {
621     protected function define_structure() {
623         $file = new restore_path_element('file', '/files/file');
625         return array($file);
626     }
628     /**
629      * Process one <file> element from files.xml
630      *
631      * @param array $data the element data
632      */
633     public function process_file($data) {
635         $data = (object)$data; // handy
637         // load it if needed:
638         //   - it it is one of the annotated inforef files (course/section/activity/block)
639         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
640         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
641         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
642         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
643         $iscomponent = ($data->component == 'user' || $data->component == 'group' || $data->component == 'badges' ||
644                         $data->component == 'grouping' || $data->component == 'grade' ||
645                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
646         if ($isfileref || $iscomponent) {
647             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
648         }
649     }
652 /**
653  * Execution step that, *conditionally* (if there isn't preloaded information),
654  * will load all the needed roles to backup_temp_ids. They will be stored with
655  * "role" itemname. Also it will perform one automatic mapping to roles existing
656  * in the target site, based in permissions of the user performing the restore,
657  * archetypes and other bits. At the end, each original role will have its associated
658  * target role or 0 if it's going to be skipped. Note we wrap everything over one
659  * restore_dbops method, as far as the same stuff is going to be also executed
660  * by restore prechecks
661  */
662 class restore_load_and_map_roles extends restore_execution_step {
664     protected function define_execution() {
665         if ($this->task->get_preloaded_information()) { // if info is already preloaded
666             return;
667         }
669         $file = $this->get_basepath() . '/roles.xml';
670         // Load needed toles to temp_ids
671         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
673         // Process roles, mapping/skipping. Any error throws exception
674         // Note we pass controller's info because it can contain role mapping information
675         // about manual mappings performed by UI
676         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);
677     }
680 /**
681  * Execution step that, *conditionally* (if there isn't preloaded information
682  * and users have been selected in settings, will load all the needed users
683  * to backup_temp_ids. They will be stored with "user" itemname and with
684  * their original contextid as paremitemid
685  */
686 class restore_load_included_users extends restore_execution_step {
688     protected function define_execution() {
690         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
691             return;
692         }
693         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
694             return;
695         }
696         $file = $this->get_basepath() . '/users.xml';
697         // Load needed users to temp_ids.
698         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file, $this->task->get_progress());
699     }
702 /**
703  * Execution step that, *conditionally* (if there isn't preloaded information
704  * and users have been selected in settings, will process all the needed users
705  * in order to decide and perform any action with them (create / map / error)
706  * Note: Any error will cause exception, as far as this is the same processing
707  * than the one into restore prechecks (that should have stopped process earlier)
708  */
709 class restore_process_included_users extends restore_execution_step {
711     protected function define_execution() {
713         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
714             return;
715         }
716         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
717             return;
718         }
719         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(),
720                 $this->task->get_userid(), $this->task->is_samesite(), $this->task->get_progress());
721     }
724 /**
725  * Execution step that will create all the needed users as calculated
726  * by @restore_process_included_users (those having newiteind = 0)
727  */
728 class restore_create_included_users extends restore_execution_step {
730     protected function define_execution() {
732         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(),
733                 $this->task->get_userid(), $this->task->get_progress());
734     }
737 /**
738  * Structure step that will create all the needed groups and groupings
739  * by loading them from the groups.xml file performing the required matches.
740  * Note group members only will be added if restoring user info
741  */
742 class restore_groups_structure_step extends restore_structure_step {
744     protected function define_structure() {
746         $paths = array(); // Add paths here
748         $paths[] = new restore_path_element('group', '/groups/group');
749         $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
750         $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
752         return $paths;
753     }
755     // Processing functions go here
756     public function process_group($data) {
757         global $DB;
759         $data = (object)$data; // handy
760         $data->courseid = $this->get_courseid();
762         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
763         // another a group in the same course
764         $context = context_course::instance($data->courseid);
765         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
766             if (groups_get_group_by_idnumber($data->courseid, $data->idnumber)) {
767                 unset($data->idnumber);
768             }
769         } else {
770             unset($data->idnumber);
771         }
773         $oldid = $data->id;    // need this saved for later
775         $restorefiles = false; // Only if we end creating the group
777         // Search if the group already exists (by name & description) in the target course
778         $description_clause = '';
779         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
780         if (!empty($data->description)) {
781             $description_clause = ' AND ' .
782                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
783            $params['description'] = $data->description;
784         }
785         if (!$groupdb = $DB->get_record_sql("SELECT *
786                                                FROM {groups}
787                                               WHERE courseid = :courseid
788                                                 AND name = :grname $description_clause", $params)) {
789             // group doesn't exist, create
790             $newitemid = $DB->insert_record('groups', $data);
791             $restorefiles = true; // We'll restore the files
792         } else {
793             // group exists, use it
794             $newitemid = $groupdb->id;
795         }
796         // Save the id mapping
797         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
798         // Invalidate the course group data cache just in case.
799         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
800     }
802     public function process_grouping($data) {
803         global $DB;
805         $data = (object)$data; // handy
806         $data->courseid = $this->get_courseid();
808         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
809         // another a grouping in the same course
810         $context = context_course::instance($data->courseid);
811         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
812             if (groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) {
813                 unset($data->idnumber);
814             }
815         } else {
816             unset($data->idnumber);
817         }
819         $oldid = $data->id;    // need this saved for later
820         $restorefiles = false; // Only if we end creating the grouping
822         // Search if the grouping already exists (by name & description) in the target course
823         $description_clause = '';
824         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
825         if (!empty($data->description)) {
826             $description_clause = ' AND ' .
827                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
828            $params['description'] = $data->description;
829         }
830         if (!$groupingdb = $DB->get_record_sql("SELECT *
831                                                   FROM {groupings}
832                                                  WHERE courseid = :courseid
833                                                    AND name = :grname $description_clause", $params)) {
834             // grouping doesn't exist, create
835             $newitemid = $DB->insert_record('groupings', $data);
836             $restorefiles = true; // We'll restore the files
837         } else {
838             // grouping exists, use it
839             $newitemid = $groupingdb->id;
840         }
841         // Save the id mapping
842         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
843         // Invalidate the course group data cache just in case.
844         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
845     }
847     public function process_grouping_group($data) {
848         global $CFG;
850         require_once($CFG->dirroot.'/group/lib.php');
852         $data = (object)$data;
853         groups_assign_grouping($this->get_new_parentid('grouping'), $this->get_mappingid('group', $data->groupid), $data->timeadded);
854     }
856     protected function after_execute() {
857         // Add group related files, matching with "group" mappings
858         $this->add_related_files('group', 'icon', 'group');
859         $this->add_related_files('group', 'description', 'group');
860         // Add grouping related files, matching with "grouping" mappings
861         $this->add_related_files('grouping', 'description', 'grouping');
862         // Invalidate the course group data.
863         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($this->get_courseid()));
864     }
868 /**
869  * Structure step that will create all the needed group memberships
870  * by loading them from the groups.xml file performing the required matches.
871  */
872 class restore_groups_members_structure_step extends restore_structure_step {
874     protected $plugins = null;
876     protected function define_structure() {
878         $paths = array(); // Add paths here
880         if ($this->get_setting_value('users')) {
881             $paths[] = new restore_path_element('group', '/groups/group');
882             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
883         }
885         return $paths;
886     }
888     public function process_group($data) {
889         $data = (object)$data; // handy
891         // HACK ALERT!
892         // Not much to do here, this groups mapping should be already done from restore_groups_structure_step.
893         // Let's fake internal state to make $this->get_new_parentid('group') work.
895         $this->set_mapping('group', $data->id, $this->get_mappingid('group', $data->id));
896     }
898     public function process_member($data) {
899         global $DB, $CFG;
900         require_once("$CFG->dirroot/group/lib.php");
902         // NOTE: Always use groups_add_member() because it triggers events and verifies if user is enrolled.
904         $data = (object)$data; // handy
906         // get parent group->id
907         $data->groupid = $this->get_new_parentid('group');
909         // map user newitemid and insert if not member already
910         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
911             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
912                 // Check the component, if any, exists.
913                 if (empty($data->component)) {
914                     groups_add_member($data->groupid, $data->userid);
916                 } else if ((strpos($data->component, 'enrol_') === 0)) {
917                     // Deal with enrolment groups - ignore the component and just find out the instance via new id,
918                     // it is possible that enrolment was restored using different plugin type.
919                     if (!isset($this->plugins)) {
920                         $this->plugins = enrol_get_plugins(true);
921                     }
922                     if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
923                         if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
924                             if (isset($this->plugins[$instance->enrol])) {
925                                 $this->plugins[$instance->enrol]->restore_group_member($instance, $data->groupid, $data->userid);
926                             }
927                         }
928                     }
930                 } else {
931                     $dir = core_component::get_component_directory($data->component);
932                     if ($dir and is_dir($dir)) {
933                         if (component_callback($data->component, 'restore_group_member', array($this, $data), true)) {
934                             return;
935                         }
936                     }
937                     // Bad luck, plugin could not restore the data, let's add normal membership.
938                     groups_add_member($data->groupid, $data->userid);
939                     $message = "Restore of '$data->component/$data->itemid' group membership is not supported, using standard group membership instead.";
940                     debugging($message);
941                     $this->log($message, backup::LOG_WARNING);
942                 }
943             }
944         }
945     }
948 /**
949  * Structure step that will create all the needed scales
950  * by loading them from the scales.xml
951  */
952 class restore_scales_structure_step extends restore_structure_step {
954     protected function define_structure() {
956         $paths = array(); // Add paths here
957         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
958         return $paths;
959     }
961     protected function process_scale($data) {
962         global $DB;
964         $data = (object)$data;
966         $restorefiles = false; // Only if we end creating the group
968         $oldid = $data->id;    // need this saved for later
970         // Look for scale (by 'scale' both in standard (course=0) and current course
971         // with priority to standard scales (ORDER clause)
972         // scale is not course unique, use get_record_sql to suppress warning
973         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
974         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
975         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
976         if (!$scadb = $DB->get_record_sql("SELECT *
977                                             FROM {scale}
978                                            WHERE courseid IN (0, :courseid)
979                                              AND $compare_scale_clause
980                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
981             // Remap the user if possible, defaut to user performing the restore if not
982             $userid = $this->get_mappingid('user', $data->userid);
983             $data->userid = $userid ? $userid : $this->task->get_userid();
984             // Remap the course if course scale
985             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
986             // If global scale (course=0), check the user has perms to create it
987             // falling to course scale if not
988             $systemctx = context_system::instance();
989             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
990                 $data->courseid = $this->get_courseid();
991             }
992             // scale doesn't exist, create
993             $newitemid = $DB->insert_record('scale', $data);
994             $restorefiles = true; // We'll restore the files
995         } else {
996             // scale exists, use it
997             $newitemid = $scadb->id;
998         }
999         // Save the id mapping (with files support at system context)
1000         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1001     }
1003     protected function after_execute() {
1004         // Add scales related files, matching with "scale" mappings
1005         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
1006     }
1010 /**
1011  * Structure step that will create all the needed outocomes
1012  * by loading them from the outcomes.xml
1013  */
1014 class restore_outcomes_structure_step extends restore_structure_step {
1016     protected function define_structure() {
1018         $paths = array(); // Add paths here
1019         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
1020         return $paths;
1021     }
1023     protected function process_outcome($data) {
1024         global $DB;
1026         $data = (object)$data;
1028         $restorefiles = false; // Only if we end creating the group
1030         $oldid = $data->id;    // need this saved for later
1032         // Look for outcome (by shortname both in standard (courseid=null) and current course
1033         // with priority to standard outcomes (ORDER clause)
1034         // outcome is not course unique, use get_record_sql to suppress warning
1035         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
1036         if (!$outdb = $DB->get_record_sql('SELECT *
1037                                              FROM {grade_outcomes}
1038                                             WHERE shortname = :shortname
1039                                               AND (courseid = :courseid OR courseid IS NULL)
1040                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
1041             // Remap the user
1042             $userid = $this->get_mappingid('user', $data->usermodified);
1043             $data->usermodified = $userid ? $userid : $this->task->get_userid();
1044             // Remap the scale
1045             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
1046             // Remap the course if course outcome
1047             $data->courseid = $data->courseid ? $this->get_courseid() : null;
1048             // If global outcome (course=null), check the user has perms to create it
1049             // falling to course outcome if not
1050             $systemctx = context_system::instance();
1051             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
1052                 $data->courseid = $this->get_courseid();
1053             }
1054             // outcome doesn't exist, create
1055             $newitemid = $DB->insert_record('grade_outcomes', $data);
1056             $restorefiles = true; // We'll restore the files
1057         } else {
1058             // scale exists, use it
1059             $newitemid = $outdb->id;
1060         }
1061         // Set the corresponding grade_outcomes_courses record
1062         $outcourserec = new stdclass();
1063         $outcourserec->courseid  = $this->get_courseid();
1064         $outcourserec->outcomeid = $newitemid;
1065         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
1066             $DB->insert_record('grade_outcomes_courses', $outcourserec);
1067         }
1068         // Save the id mapping (with files support at system context)
1069         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1070     }
1072     protected function after_execute() {
1073         // Add outcomes related files, matching with "outcome" mappings
1074         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
1075     }
1078 /**
1079  * Execution step that, *conditionally* (if there isn't preloaded information
1080  * will load all the question categories and questions (header info only)
1081  * to backup_temp_ids. They will be stored with "question_category" and
1082  * "question" itemnames and with their original contextid and question category
1083  * id as paremitemids
1084  */
1085 class restore_load_categories_and_questions extends restore_execution_step {
1087     protected function define_execution() {
1089         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1090             return;
1091         }
1092         $file = $this->get_basepath() . '/questions.xml';
1093         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
1094     }
1097 /**
1098  * Execution step that, *conditionally* (if there isn't preloaded information)
1099  * will process all the needed categories and questions
1100  * in order to decide and perform any action with them (create / map / error)
1101  * Note: Any error will cause exception, as far as this is the same processing
1102  * than the one into restore prechecks (that should have stopped process earlier)
1103  */
1104 class restore_process_categories_and_questions extends restore_execution_step {
1106     protected function define_execution() {
1108         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1109             return;
1110         }
1111         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
1112     }
1115 /**
1116  * Structure step that will read the section.xml creating/updating sections
1117  * as needed, rebuilding course cache and other friends
1118  */
1119 class restore_section_structure_step extends restore_structure_step {
1121     protected function define_structure() {
1122         global $CFG;
1124         $paths = array();
1126         $section = new restore_path_element('section', '/section');
1127         $paths[] = $section;
1128         if ($CFG->enableavailability) {
1129             $paths[] = new restore_path_element('availability', '/section/availability');
1130             $paths[] = new restore_path_element('availability_field', '/section/availability_field');
1131         }
1132         $paths[] = new restore_path_element('course_format_options', '/section/course_format_options');
1134         // Apply for 'format' plugins optional paths at section level
1135         $this->add_plugin_structure('format', $section);
1137         // Apply for 'local' plugins optional paths at section level
1138         $this->add_plugin_structure('local', $section);
1140         return $paths;
1141     }
1143     public function process_section($data) {
1144         global $CFG, $DB;
1145         $data = (object)$data;
1146         $oldid = $data->id; // We'll need this later
1148         $restorefiles = false;
1150         // Look for the section
1151         $section = new stdclass();
1152         $section->course  = $this->get_courseid();
1153         $section->section = $data->number;
1154         // Section doesn't exist, create it with all the info from backup
1155         if (!$secrec = $DB->get_record('course_sections', (array)$section)) {
1156             $section->name = $data->name;
1157             $section->summary = $data->summary;
1158             $section->summaryformat = $data->summaryformat;
1159             $section->sequence = '';
1160             $section->visible = $data->visible;
1161             if (empty($CFG->enableavailability)) { // Process availability information only if enabled.
1162                 $section->availablefrom = 0;
1163                 $section->availableuntil = 0;
1164                 $section->showavailability = 0;
1165             } else {
1166                 $section->availablefrom = isset($data->availablefrom) ? $this->apply_date_offset($data->availablefrom) : 0;
1167                 $section->availableuntil = isset($data->availableuntil) ? $this->apply_date_offset($data->availableuntil) : 0;
1168                 $section->showavailability = isset($data->showavailability) ? $data->showavailability : 0;
1169             }
1170             if (!empty($CFG->enablegroupmembersonly)) { // Only if enablegroupmembersonly is enabled
1171                 $section->groupingid = isset($data->groupingid) ? $this->get_mappingid('grouping', $data->groupingid) : 0;
1172             }
1173             $newitemid = $DB->insert_record('course_sections', $section);
1174             $restorefiles = true;
1176         // Section exists, update non-empty information
1177         } else {
1178             $section->id = $secrec->id;
1179             if ((string)$secrec->name === '') {
1180                 $section->name = $data->name;
1181             }
1182             if (empty($secrec->summary)) {
1183                 $section->summary = $data->summary;
1184                 $section->summaryformat = $data->summaryformat;
1185                 $restorefiles = true;
1186             }
1187             if (empty($secrec->groupingid)) {
1188                 if (!empty($CFG->enablegroupmembersonly)) { // Only if enablegroupmembersonly is enabled
1189                     $section->groupingid = isset($data->groupingid) ? $this->get_mappingid('grouping', $data->groupingid) : 0;
1190                 }
1191             }
1193             // Don't update available from, available until, or show availability
1194             // (I didn't see a useful way to define whether existing or new one should
1195             // take precedence).
1197             $DB->update_record('course_sections', $section);
1198             $newitemid = $secrec->id;
1199         }
1201         // Annotate the section mapping, with restorefiles option if needed
1202         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
1204         // set the new course_section id in the task
1205         $this->task->set_sectionid($newitemid);
1208         // Commented out. We never modify course->numsections as far as that is used
1209         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
1210         // Note: We keep the code here, to know about and because of the possibility of making this
1211         // optional based on some setting/attribute in the future
1212         // If needed, adjust course->numsections
1213         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
1214         //    if ($numsections < $section->section) {
1215         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
1216         //    }
1217         //}
1218     }
1220     public function process_availability($data) {
1221         global $DB;
1222         $data = (object)$data;
1224         $data->coursesectionid = $this->task->get_sectionid();
1226         // NOTE: Other values in $data need updating, but these (cm,
1227         // grade items) have not yet been restored, so are done later.
1229         $newid = $DB->insert_record('course_sections_availability', $data);
1231         // We do not need to map between old and new id but storing a mapping
1232         // means it gets added to the backup_ids table to record which ones
1233         // need updating. The mapping is stored with $newid => $newid for
1234         // convenience.
1235         $this->set_mapping('course_sections_availability', $newid, $newid);
1236     }
1238     public function process_availability_field($data) {
1239         global $DB;
1240         $data = (object)$data;
1241         // Mark it is as passed by default
1242         $passed = true;
1243         $customfieldid = null;
1245         // If a customfield has been used in order to pass we must be able to match an existing
1246         // customfield by name (data->customfield) and type (data->customfieldtype)
1247         if (is_null($data->customfield) xor is_null($data->customfieldtype)) {
1248             // xor is sort of uncommon. If either customfield is null or customfieldtype is null BUT not both.
1249             // If one is null but the other isn't something clearly went wrong and we'll skip this condition.
1250             $passed = false;
1251         } else if (!is_null($data->customfield)) {
1252             $params = array('shortname' => $data->customfield, 'datatype' => $data->customfieldtype);
1253             $customfieldid = $DB->get_field('user_info_field', 'id', $params);
1254             $passed = ($customfieldid !== false);
1255         }
1257         if ($passed) {
1258             // Create the object to insert into the database
1259             $availfield = new stdClass();
1260             $availfield->coursesectionid = $this->task->get_sectionid();
1261             $availfield->userfield = $data->userfield;
1262             $availfield->customfieldid = $customfieldid;
1263             $availfield->operator = $data->operator;
1264             $availfield->value = $data->value;
1265             $DB->insert_record('course_sections_avail_fields', $availfield);
1266         }
1267     }
1269     public function process_course_format_options($data) {
1270         global $DB;
1271         $data = (object)$data;
1272         $oldid = $data->id;
1273         unset($data->id);
1274         $data->sectionid = $this->task->get_sectionid();
1275         $data->courseid = $this->get_courseid();
1276         $newid = $DB->insert_record('course_format_options', $data);
1277         $this->set_mapping('course_format_options', $oldid, $newid);
1278     }
1280     protected function after_execute() {
1281         // Add section related files, with 'course_section' itemid to match
1282         $this->add_related_files('course', 'section', 'course_section');
1283     }
1285     public function after_restore() {
1286         global $DB;
1288         $sectionid = $this->get_task()->get_sectionid();
1290         // Get data object for current section availability (if any).
1291         $records = $DB->get_records('course_sections_availability',
1292                 array('coursesectionid' => $sectionid), 'id, sourcecmid, gradeitemid');
1294         // If it exists, update mappings.
1295         foreach ($records as $data) {
1296             // Only update mappings for entries which are created by this restore.
1297             // Otherwise, when you restore to an existing course, it will mess up
1298             // existing section availability entries.
1299             if (!$this->get_mappingid('course_sections_availability', $data->id, false)) {
1300                 continue;
1301             }
1303             // Update source cmid / grade id to new value.
1304             $data->sourcecmid = $this->get_mappingid('course_module', $data->sourcecmid);
1305             if (!$data->sourcecmid) {
1306                 $data->sourcecmid = null;
1307             }
1308             $data->gradeitemid = $this->get_mappingid('grade_item', $data->gradeitemid);
1309             if (!$data->gradeitemid) {
1310                 $data->gradeitemid = null;
1311             }
1313             // Delete the record if the condition wasn't found, otherwise update it.
1314             if ($data->sourcecmid === null && $data->gradeitemid === null) {
1315                 $DB->delete_records('course_sections_availability', array('id' => $data->id));
1316             } else {
1317                 $DB->update_record('course_sections_availability', $data);
1318             }
1319         }
1320     }
1324 /**
1325  * Structure step that will read the course.xml file, loading it and performing
1326  * various actions depending of the site/restore settings. Note that target
1327  * course always exist before arriving here so this step will be updating
1328  * the course record (never inserting)
1329  */
1330 class restore_course_structure_step extends restore_structure_step {
1331     /**
1332      * @var bool this gets set to true by {@link process_course()} if we are
1333      * restoring an old coures that used the legacy 'module security' feature.
1334      * If so, we have to do more work in {@link after_execute()}.
1335      */
1336     protected $legacyrestrictmodules = false;
1338     /**
1339      * @var array Used when {@link $legacyrestrictmodules} is true. This is an
1340      * array with array keys the module names ('forum', 'quiz', etc.). These are
1341      * the modules that are allowed according to the data in the backup file.
1342      * In {@link after_execute()} we then have to prevent adding of all the other
1343      * types of activity.
1344      */
1345     protected $legacyallowedmodules = array();
1347     protected function define_structure() {
1349         $course = new restore_path_element('course', '/course');
1350         $category = new restore_path_element('category', '/course/category');
1351         $tag = new restore_path_element('tag', '/course/tags/tag');
1352         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1354         // Apply for 'format' plugins optional paths at course level
1355         $this->add_plugin_structure('format', $course);
1357         // Apply for 'theme' plugins optional paths at course level
1358         $this->add_plugin_structure('theme', $course);
1360         // Apply for 'report' plugins optional paths at course level
1361         $this->add_plugin_structure('report', $course);
1363         // Apply for 'course report' plugins optional paths at course level
1364         $this->add_plugin_structure('coursereport', $course);
1366         // Apply for plagiarism plugins optional paths at course level
1367         $this->add_plugin_structure('plagiarism', $course);
1369         // Apply for local plugins optional paths at course level
1370         $this->add_plugin_structure('local', $course);
1372         return array($course, $category, $tag, $allowed_module);
1373     }
1375     /**
1376      * Processing functions go here
1377      *
1378      * @global moodledatabase $DB
1379      * @param stdClass $data
1380      */
1381     public function process_course($data) {
1382         global $CFG, $DB;
1384         $data = (object)$data;
1386         $fullname  = $this->get_setting_value('course_fullname');
1387         $shortname = $this->get_setting_value('course_shortname');
1388         $startdate = $this->get_setting_value('course_startdate');
1390         // Calculate final course names, to avoid dupes
1391         list($fullname, $shortname) = restore_dbops::calculate_course_names($this->get_courseid(), $fullname, $shortname);
1393         // Need to change some fields before updating the course record
1394         $data->id = $this->get_courseid();
1395         $data->fullname = $fullname;
1396         $data->shortname= $shortname;
1398         $context = context::instance_by_id($this->task->get_contextid());
1399         if (has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1400             $data->idnumber = '';
1401         } else {
1402             unset($data->idnumber);
1403         }
1405         // Any empty value for course->hiddensections will lead to 0 (default, show collapsed).
1406         // It has been reported that some old 1.9 courses may have it null leading to DB error. MDL-31532
1407         if (empty($data->hiddensections)) {
1408             $data->hiddensections = 0;
1409         }
1411         // Set legacyrestrictmodules to true if the course was resticting modules. If so
1412         // then we will need to process restricted modules after execution.
1413         $this->legacyrestrictmodules = !empty($data->restrictmodules);
1415         $data->startdate= $this->apply_date_offset($data->startdate);
1416         if ($data->defaultgroupingid) {
1417             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1418         }
1419         if (empty($CFG->enablecompletion)) {
1420             $data->enablecompletion = 0;
1421             $data->completionstartonenrol = 0;
1422             $data->completionnotify = 0;
1423         }
1424         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1425         if (!array_key_exists($data->lang, $languages)) {
1426             $data->lang = '';
1427         }
1429         $themes = get_list_of_themes(); // Get themes for quick search later
1430         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1431             $data->theme = '';
1432         }
1434         // Check if this is an old SCORM course format.
1435         if ($data->format == 'scorm') {
1436             $data->format = 'singleactivity';
1437             $data->activitytype = 'scorm';
1438         }
1440         // Course record ready, update it
1441         $DB->update_record('course', $data);
1443         course_get_format($data)->update_course_format_options($data);
1445         // Role name aliases
1446         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1447     }
1449     public function process_category($data) {
1450         // Nothing to do with the category. UI sets it before restore starts
1451     }
1453     public function process_tag($data) {
1454         global $CFG, $DB;
1456         $data = (object)$data;
1458         if (!empty($CFG->usetags)) { // if enabled in server
1459             // TODO: This is highly inneficient. Each time we add one tag
1460             // we fetch all the existing because tag_set() deletes them
1461             // so everything must be reinserted on each call
1462             $tags = array();
1463             $existingtags = tag_get_tags('course', $this->get_courseid());
1464             // Re-add all the existitng tags
1465             foreach ($existingtags as $existingtag) {
1466                 $tags[] = $existingtag->rawname;
1467             }
1468             // Add the one being restored
1469             $tags[] = $data->rawname;
1470             // Send all the tags back to the course
1471             tag_set('course', $this->get_courseid(), $tags);
1472         }
1473     }
1475     public function process_allowed_module($data) {
1476         $data = (object)$data;
1478         // Backwards compatiblity support for the data that used to be in the
1479         // course_allowed_modules table.
1480         if ($this->legacyrestrictmodules) {
1481             $this->legacyallowedmodules[$data->modulename] = 1;
1482         }
1483     }
1485     protected function after_execute() {
1486         global $DB;
1488         // Add course related files, without itemid to match
1489         $this->add_related_files('course', 'summary', null);
1490         $this->add_related_files('course', 'overviewfiles', null);
1492         // Deal with legacy allowed modules.
1493         if ($this->legacyrestrictmodules) {
1494             $context = context_course::instance($this->get_courseid());
1496             list($roleids) = get_roles_with_cap_in_context($context, 'moodle/course:manageactivities');
1497             list($managerroleids) = get_roles_with_cap_in_context($context, 'moodle/site:config');
1498             foreach ($managerroleids as $roleid) {
1499                 unset($roleids[$roleid]);
1500             }
1502             foreach (core_component::get_plugin_list('mod') as $modname => $notused) {
1503                 if (isset($this->legacyallowedmodules[$modname])) {
1504                     // Module is allowed, no worries.
1505                     continue;
1506                 }
1508                 $capability = 'mod/' . $modname . ':addinstance';
1509                 foreach ($roleids as $roleid) {
1510                     assign_capability($capability, CAP_PREVENT, $roleid, $context);
1511                 }
1512             }
1513         }
1514     }
1517 /**
1518  * Execution step that will migrate legacy files if present.
1519  */
1520 class restore_course_legacy_files_step extends restore_execution_step {
1521     public function define_execution() {
1522         global $DB;
1524         // Do a check for legacy files and skip if there are none.
1525         $sql = 'SELECT count(*)
1526                   FROM {backup_files_temp}
1527                  WHERE backupid = ?
1528                    AND contextid = ?
1529                    AND component = ?
1530                    AND filearea  = ?';
1531         $params = array($this->get_restoreid(), $this->task->get_old_contextid(), 'course', 'legacy');
1533         if ($DB->count_records_sql($sql, $params)) {
1534             $DB->set_field('course', 'legacyfiles', 2, array('id' => $this->get_courseid()));
1535             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'course',
1536                 'legacy', $this->task->get_old_contextid(), $this->task->get_userid());
1537         }
1538     }
1541 /*
1542  * Structure step that will read the roles.xml file (at course/activity/block levels)
1543  * containing all the role_assignments and overrides for that context. If corresponding to
1544  * one mapped role, they will be applied to target context. Will observe the role_assignments
1545  * setting to decide if ras are restored.
1546  *
1547  * Note: this needs to be executed after all users are enrolled.
1548  */
1549 class restore_ras_and_caps_structure_step extends restore_structure_step {
1550     protected $plugins = null;
1552     protected function define_structure() {
1554         $paths = array();
1556         // Observe the role_assignments setting
1557         if ($this->get_setting_value('role_assignments')) {
1558             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
1559         }
1560         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
1562         return $paths;
1563     }
1565     /**
1566      * Assign roles
1567      *
1568      * This has to be called after enrolments processing.
1569      *
1570      * @param mixed $data
1571      * @return void
1572      */
1573     public function process_assignment($data) {
1574         global $DB;
1576         $data = (object)$data;
1578         // Check roleid, userid are one of the mapped ones
1579         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
1580             return;
1581         }
1582         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
1583             return;
1584         }
1585         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
1586             // Only assign roles to not deleted users
1587             return;
1588         }
1589         if (!$contextid = $this->task->get_contextid()) {
1590             return;
1591         }
1593         if (empty($data->component)) {
1594             // assign standard manual roles
1595             // TODO: role_assign() needs one userid param to be able to specify our restore userid
1596             role_assign($newroleid, $newuserid, $contextid);
1598         } else if ((strpos($data->component, 'enrol_') === 0)) {
1599             // Deal with enrolment roles - ignore the component and just find out the instance via new id,
1600             // it is possible that enrolment was restored using different plugin type.
1601             if (!isset($this->plugins)) {
1602                 $this->plugins = enrol_get_plugins(true);
1603             }
1604             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1605                 if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1606                     if (isset($this->plugins[$instance->enrol])) {
1607                         $this->plugins[$instance->enrol]->restore_role_assignment($instance, $newroleid, $newuserid, $contextid);
1608                     }
1609                 }
1610             }
1612         } else {
1613             $data->roleid    = $newroleid;
1614             $data->userid    = $newuserid;
1615             $data->contextid = $contextid;
1616             $dir = core_component::get_component_directory($data->component);
1617             if ($dir and is_dir($dir)) {
1618                 if (component_callback($data->component, 'restore_role_assignment', array($this, $data), true)) {
1619                     return;
1620                 }
1621             }
1622             // Bad luck, plugin could not restore the data, let's add normal membership.
1623             role_assign($data->roleid, $data->userid, $data->contextid);
1624             $message = "Restore of '$data->component/$data->itemid' role assignments is not supported, using manual role assignments instead.";
1625             debugging($message);
1626             $this->log($message, backup::LOG_WARNING);
1627         }
1628     }
1630     public function process_override($data) {
1631         $data = (object)$data;
1633         // Check roleid is one of the mapped ones
1634         $newroleid = $this->get_mappingid('role', $data->roleid);
1635         // If newroleid and context are valid assign it via API (it handles dupes and so on)
1636         if ($newroleid && $this->task->get_contextid()) {
1637             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
1638             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
1639             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
1640         }
1641     }
1644 /**
1645  * If no instances yet add default enrol methods the same way as when creating new course in UI.
1646  */
1647 class restore_default_enrolments_step extends restore_execution_step {
1648     public function define_execution() {
1649         global $DB;
1651         $course = $DB->get_record('course', array('id'=>$this->get_courseid()), '*', MUST_EXIST);
1653         if ($DB->record_exists('enrol', array('courseid'=>$this->get_courseid(), 'enrol'=>'manual'))) {
1654             // Something already added instances, do not add default instances.
1655             $plugins = enrol_get_plugins(true);
1656             foreach ($plugins as $plugin) {
1657                 $plugin->restore_sync_course($course);
1658             }
1660         } else {
1661             // Looks like a newly created course.
1662             enrol_course_updated(true, $course, null);
1663         }
1664     }
1667 /**
1668  * This structure steps restores the enrol plugins and their underlying
1669  * enrolments, performing all the mappings and/or movements required
1670  */
1671 class restore_enrolments_structure_step extends restore_structure_step {
1672     protected $enrolsynced = false;
1673     protected $plugins = null;
1674     protected $originalstatus = array();
1676     /**
1677      * Conditionally decide if this step should be executed.
1678      *
1679      * This function checks the following parameter:
1680      *
1681      *   1. the course/enrolments.xml file exists
1682      *
1683      * @return bool true is safe to execute, false otherwise
1684      */
1685     protected function execute_condition() {
1687         // Check it is included in the backup
1688         $fullpath = $this->task->get_taskbasepath();
1689         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1690         if (!file_exists($fullpath)) {
1691             // Not found, can't restore enrolments info
1692             return false;
1693         }
1695         return true;
1696     }
1698     protected function define_structure() {
1700         $paths = array();
1702         $paths[] = new restore_path_element('enrol', '/enrolments/enrols/enrol');
1703         $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
1705         return $paths;
1706     }
1708     /**
1709      * Create enrolment instances.
1710      *
1711      * This has to be called after creation of roles
1712      * and before adding of role assignments.
1713      *
1714      * @param mixed $data
1715      * @return void
1716      */
1717     public function process_enrol($data) {
1718         global $DB;
1720         $data = (object)$data;
1721         $oldid = $data->id; // We'll need this later.
1722         unset($data->id);
1724         $this->originalstatus[$oldid] = $data->status;
1726         if (!$courserec = $DB->get_record('course', array('id' => $this->get_courseid()))) {
1727             $this->set_mapping('enrol', $oldid, 0);
1728             return;
1729         }
1731         if (!isset($this->plugins)) {
1732             $this->plugins = enrol_get_plugins(true);
1733         }
1735         if (!$this->enrolsynced) {
1736             // Make sure that all plugin may create instances and enrolments automatically
1737             // before the first instance restore - this is suitable especially for plugins
1738             // that synchronise data automatically using course->idnumber or by course categories.
1739             foreach ($this->plugins as $plugin) {
1740                 $plugin->restore_sync_course($courserec);
1741             }
1742             $this->enrolsynced = true;
1743         }
1745         // Map standard fields - plugin has to process custom fields manually.
1746         $data->roleid   = $this->get_mappingid('role', $data->roleid);
1747         $data->courseid = $courserec->id;
1749         if ($this->get_setting_value('enrol_migratetomanual')) {
1750             unset($data->sortorder); // Remove useless sortorder from <2.4 backups.
1751             if (!enrol_is_enabled('manual')) {
1752                 $this->set_mapping('enrol', $oldid, 0);
1753                 return;
1754             }
1755             if ($instances = $DB->get_records('enrol', array('courseid'=>$data->courseid, 'enrol'=>'manual'), 'id')) {
1756                 $instance = reset($instances);
1757                 $this->set_mapping('enrol', $oldid, $instance->id);
1758             } else {
1759                 if ($data->enrol === 'manual') {
1760                     $instanceid = $this->plugins['manual']->add_instance($courserec, (array)$data);
1761                 } else {
1762                     $instanceid = $this->plugins['manual']->add_default_instance($courserec);
1763                 }
1764                 $this->set_mapping('enrol', $oldid, $instanceid);
1765             }
1767         } else {
1768             if (!enrol_is_enabled($data->enrol) or !isset($this->plugins[$data->enrol])) {
1769                 $this->set_mapping('enrol', $oldid, 0);
1770                 $message = "Enrol plugin '$data->enrol' data can not be restored because it is not enabled, use migration to manual enrolments";
1771                 debugging($message);
1772                 $this->log($message, backup::LOG_WARNING);
1773                 return;
1774             }
1775             if ($task = $this->get_task() and $task->get_target() == backup::TARGET_NEW_COURSE) {
1776                 // Let's keep the sortorder in old backups.
1777             } else {
1778                 // Prevent problems with colliding sortorders in old backups,
1779                 // new 2.4 backups do not need sortorder because xml elements are ordered properly.
1780                 unset($data->sortorder);
1781             }
1782             // Note: plugin is responsible for setting up the mapping, it may also decide to migrate to different type.
1783             $this->plugins[$data->enrol]->restore_instance($this, $data, $courserec, $oldid);
1784         }
1785     }
1787     /**
1788      * Create user enrolments.
1789      *
1790      * This has to be called after creation of enrolment instances
1791      * and before adding of role assignments.
1792      *
1793      * Roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing afterwards.
1794      *
1795      * @param mixed $data
1796      * @return void
1797      */
1798     public function process_enrolment($data) {
1799         global $DB;
1801         if (!isset($this->plugins)) {
1802             $this->plugins = enrol_get_plugins(true);
1803         }
1805         $data = (object)$data;
1807         // Process only if parent instance have been mapped.
1808         if ($enrolid = $this->get_new_parentid('enrol')) {
1809             $oldinstancestatus = ENROL_INSTANCE_ENABLED;
1810             $oldenrolid = $this->get_old_parentid('enrol');
1811             if (isset($this->originalstatus[$oldenrolid])) {
1812                 $oldinstancestatus = $this->originalstatus[$oldenrolid];
1813             }
1814             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1815                 // And only if user is a mapped one.
1816                 if ($userid = $this->get_mappingid('user', $data->userid)) {
1817                     if (isset($this->plugins[$instance->enrol])) {
1818                         $this->plugins[$instance->enrol]->restore_user_enrolment($this, $data, $instance, $userid, $oldinstancestatus);
1819                     }
1820                 }
1821             }
1822         }
1823     }
1827 /**
1828  * Make sure the user restoring the course can actually access it.
1829  */
1830 class restore_fix_restorer_access_step extends restore_execution_step {
1831     protected function define_execution() {
1832         global $CFG, $DB;
1834         if (!$userid = $this->task->get_userid()) {
1835             return;
1836         }
1838         if (empty($CFG->restorernewroleid)) {
1839             // Bad luck, no fallback role for restorers specified
1840             return;
1841         }
1843         $courseid = $this->get_courseid();
1844         $context = context_course::instance($courseid);
1846         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1847             // Current user may access the course (admin, category manager or restored teacher enrolment usually)
1848             return;
1849         }
1851         // Try to add role only - we do not need enrolment if user has moodle/course:view or is already enrolled
1852         role_assign($CFG->restorernewroleid, $userid, $context);
1854         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1855             // Extra role is enough, yay!
1856             return;
1857         }
1859         // The last chance is to create manual enrol if it does not exist and and try to enrol the current user,
1860         // hopefully admin selected suitable $CFG->restorernewroleid ...
1861         if (!enrol_is_enabled('manual')) {
1862             return;
1863         }
1864         if (!$enrol = enrol_get_plugin('manual')) {
1865             return;
1866         }
1867         if (!$DB->record_exists('enrol', array('enrol'=>'manual', 'courseid'=>$courseid))) {
1868             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
1869             $fields = array('status'=>ENROL_INSTANCE_ENABLED, 'enrolperiod'=>$enrol->get_config('enrolperiod', 0), 'roleid'=>$enrol->get_config('roleid', 0));
1870             $enrol->add_instance($course, $fields);
1871         }
1873         enrol_try_internal_enrol($courseid, $userid);
1874     }
1878 /**
1879  * This structure steps restores the filters and their configs
1880  */
1881 class restore_filters_structure_step extends restore_structure_step {
1883     protected function define_structure() {
1885         $paths = array();
1887         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
1888         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
1890         return $paths;
1891     }
1893     public function process_active($data) {
1895         $data = (object)$data;
1897         if (strpos($data->filter, 'filter/') === 0) {
1898             $data->filter = substr($data->filter, 7);
1900         } else if (strpos($data->filter, '/') !== false) {
1901             // Unsupported old filter.
1902             return;
1903         }
1905         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1906             return;
1907         }
1908         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
1909     }
1911     public function process_config($data) {
1913         $data = (object)$data;
1915         if (strpos($data->filter, 'filter/') === 0) {
1916             $data->filter = substr($data->filter, 7);
1918         } else if (strpos($data->filter, '/') !== false) {
1919             // Unsupported old filter.
1920             return;
1921         }
1923         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1924             return;
1925         }
1926         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
1927     }
1931 /**
1932  * This structure steps restores the comments
1933  * Note: Cannot use the comments API because defaults to USER->id.
1934  * That should change allowing to pass $userid
1935  */
1936 class restore_comments_structure_step extends restore_structure_step {
1938     protected function define_structure() {
1940         $paths = array();
1942         $paths[] = new restore_path_element('comment', '/comments/comment');
1944         return $paths;
1945     }
1947     public function process_comment($data) {
1948         global $DB;
1950         $data = (object)$data;
1952         // First of all, if the comment has some itemid, ask to the task what to map
1953         $mapping = false;
1954         if ($data->itemid) {
1955             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
1956             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
1957         }
1958         // Only restore the comment if has no mapping OR we have found the matching mapping
1959         if (!$mapping || $data->itemid) {
1960             // Only if user mapping and context
1961             $data->userid = $this->get_mappingid('user', $data->userid);
1962             if ($data->userid && $this->task->get_contextid()) {
1963                 $data->contextid = $this->task->get_contextid();
1964                 // Only if there is another comment with same context/user/timecreated
1965                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
1966                 if (!$DB->record_exists('comments', $params)) {
1967                     $DB->insert_record('comments', $data);
1968                 }
1969             }
1970         }
1971     }
1974 /**
1975  * This structure steps restores the badges and their configs
1976  */
1977 class restore_badges_structure_step extends restore_structure_step {
1979     /**
1980      * Conditionally decide if this step should be executed.
1981      *
1982      * This function checks the following parameters:
1983      *
1984      *   1. Badges and course badges are enabled on the site.
1985      *   2. The course/badges.xml file exists.
1986      *   3. All modules are restorable.
1987      *   4. All modules are marked for restore.
1988      *
1989      * @return bool True is safe to execute, false otherwise
1990      */
1991     protected function execute_condition() {
1992         global $CFG;
1994         // First check is badges and course level badges are enabled on this site.
1995         if (empty($CFG->enablebadges) || empty($CFG->badges_allowcoursebadges)) {
1996             // Disabled, don't restore course badges.
1997             return false;
1998         }
2000         // Check if badges.xml is included in the backup.
2001         $fullpath = $this->task->get_taskbasepath();
2002         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2003         if (!file_exists($fullpath)) {
2004             // Not found, can't restore course badges.
2005             return false;
2006         }
2008         // Check we are able to restore all backed up modules.
2009         if ($this->task->is_missing_modules()) {
2010             return false;
2011         }
2013         // Finally check all modules within the backup are being restored.
2014         if ($this->task->is_excluding_activities()) {
2015             return false;
2016         }
2018         return true;
2019     }
2021     protected function define_structure() {
2022         $paths = array();
2023         $paths[] = new restore_path_element('badge', '/badges/badge');
2024         $paths[] = new restore_path_element('criterion', '/badges/badge/criteria/criterion');
2025         $paths[] = new restore_path_element('parameter', '/badges/badge/criteria/criterion/parameters/parameter');
2026         $paths[] = new restore_path_element('manual_award', '/badges/badge/manual_awards/manual_award');
2028         return $paths;
2029     }
2031     public function process_badge($data) {
2032         global $DB, $CFG;
2034         require_once($CFG->libdir . '/badgeslib.php');
2036         $data = (object)$data;
2037         $data->usercreated = $this->get_mappingid('user', $data->usercreated);
2038         $data->usermodified = $this->get_mappingid('user', $data->usermodified);
2040         // We'll restore the badge image.
2041         $restorefiles = true;
2043         $courseid = $this->get_courseid();
2045         $params = array(
2046                 'name'           => $data->name,
2047                 'description'    => $data->description,
2048                 'timecreated'    => $this->apply_date_offset($data->timecreated),
2049                 'timemodified'   => $this->apply_date_offset($data->timemodified),
2050                 'usercreated'    => $data->usercreated,
2051                 'usermodified'   => $data->usermodified,
2052                 'issuername'     => $data->issuername,
2053                 'issuerurl'      => $data->issuerurl,
2054                 'issuercontact'  => $data->issuercontact,
2055                 'expiredate'     => $this->apply_date_offset($data->expiredate),
2056                 'expireperiod'   => $data->expireperiod,
2057                 'type'           => BADGE_TYPE_COURSE,
2058                 'courseid'       => $courseid,
2059                 'message'        => $data->message,
2060                 'messagesubject' => $data->messagesubject,
2061                 'attachment'     => $data->attachment,
2062                 'notification'   => $data->notification,
2063                 'status'         => BADGE_STATUS_INACTIVE,
2064                 'nextcron'       => $this->apply_date_offset($data->nextcron)
2065         );
2067         $newid = $DB->insert_record('badge', $params);
2068         $this->set_mapping('badge', $data->id, $newid, $restorefiles);
2069     }
2071     public function process_criterion($data) {
2072         global $DB;
2074         $data = (object)$data;
2076         $params = array(
2077                 'badgeid'      => $this->get_new_parentid('badge'),
2078                 'criteriatype' => $data->criteriatype,
2079                 'method'       => $data->method
2080         );
2081         $newid = $DB->insert_record('badge_criteria', $params);
2082         $this->set_mapping('criterion', $data->id, $newid);
2083     }
2085     public function process_parameter($data) {
2086         global $DB, $CFG;
2088         require_once($CFG->libdir . '/badgeslib.php');
2090         $data = (object)$data;
2091         $criteriaid = $this->get_new_parentid('criterion');
2093         // Parameter array that will go to database.
2094         $params = array();
2095         $params['critid'] = $criteriaid;
2097         $oldparam = explode('_', $data->name);
2099         if ($data->criteriatype == BADGE_CRITERIA_TYPE_ACTIVITY) {
2100             $module = $this->get_mappingid('course_module', $oldparam[1]);
2101             $params['name'] = $oldparam[0] . '_' . $module;
2102             $params['value'] = $oldparam[0] == 'module' ? $module : $data->value;
2103         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_COURSE) {
2104             $params['name'] = $oldparam[0] . '_' . $this->get_courseid();
2105             $params['value'] = $oldparam[0] == 'course' ? $this->get_courseid() : $data->value;
2106         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_MANUAL) {
2107             $role = $this->get_mappingid('role', $data->value);
2108             if (!empty($role)) {
2109                 $params['name'] = 'role_' . $role;
2110                 $params['value'] = $role;
2111             } else {
2112                 return;
2113             }
2114         }
2116         if (!$DB->record_exists('badge_criteria_param', $params)) {
2117             $DB->insert_record('badge_criteria_param', $params);
2118         }
2119     }
2121     public function process_manual_award($data) {
2122         global $DB;
2124         $data = (object)$data;
2125         $role = $this->get_mappingid('role', $data->issuerrole);
2127         if (!empty($role)) {
2128             $award = array(
2129                 'badgeid'     => $this->get_new_parentid('badge'),
2130                 'recipientid' => $this->get_mappingid('user', $data->recipientid),
2131                 'issuerid'    => $this->get_mappingid('user', $data->issuerid),
2132                 'issuerrole'  => $role,
2133                 'datemet'     => $this->apply_date_offset($data->datemet)
2134             );
2135             $DB->insert_record('badge_manual_award', $award);
2136         }
2137     }
2139     protected function after_execute() {
2140         // Add related files.
2141         $this->add_related_files('badges', 'badgeimage', 'badge');
2142     }
2145 /**
2146  * This structure steps restores the calendar events
2147  */
2148 class restore_calendarevents_structure_step extends restore_structure_step {
2150     protected function define_structure() {
2152         $paths = array();
2154         $paths[] = new restore_path_element('calendarevents', '/events/event');
2156         return $paths;
2157     }
2159     public function process_calendarevents($data) {
2160         global $DB, $SITE;
2162         $data = (object)$data;
2163         $oldid = $data->id;
2164         $restorefiles = true; // We'll restore the files
2165         // Find the userid and the groupid associated with the event. Return if not found.
2166         $data->userid = $this->get_mappingid('user', $data->userid);
2167         if ($data->userid === false) {
2168             return;
2169         }
2170         if (!empty($data->groupid)) {
2171             $data->groupid = $this->get_mappingid('group', $data->groupid);
2172             if ($data->groupid === false) {
2173                 return;
2174             }
2175         }
2176         // Handle events with empty eventtype //MDL-32827
2177         if(empty($data->eventtype)) {
2178             if ($data->courseid == $SITE->id) {                                // Site event
2179                 $data->eventtype = "site";
2180             } else if ($data->courseid != 0 && $data->groupid == 0 && ($data->modulename == 'assignment' || $data->modulename == 'assign')) {
2181                 // Course assingment event
2182                 $data->eventtype = "due";
2183             } else if ($data->courseid != 0 && $data->groupid == 0) {      // Course event
2184                 $data->eventtype = "course";
2185             } else if ($data->groupid) {                                      // Group event
2186                 $data->eventtype = "group";
2187             } else if ($data->userid) {                                       // User event
2188                 $data->eventtype = "user";
2189             } else {
2190                 return;
2191             }
2192         }
2194         $params = array(
2195                 'name'           => $data->name,
2196                 'description'    => $data->description,
2197                 'format'         => $data->format,
2198                 'courseid'       => $this->get_courseid(),
2199                 'groupid'        => $data->groupid,
2200                 'userid'         => $data->userid,
2201                 'repeatid'       => $data->repeatid,
2202                 'modulename'     => $data->modulename,
2203                 'eventtype'      => $data->eventtype,
2204                 'timestart'      => $this->apply_date_offset($data->timestart),
2205                 'timeduration'   => $data->timeduration,
2206                 'visible'        => $data->visible,
2207                 'uuid'           => $data->uuid,
2208                 'sequence'       => $data->sequence,
2209                 'timemodified'    => $this->apply_date_offset($data->timemodified));
2210         if ($this->name == 'activity_calendar') {
2211             $params['instance'] = $this->task->get_activityid();
2212         } else {
2213             $params['instance'] = 0;
2214         }
2215         $sql = 'SELECT id FROM {event} WHERE name = ? AND courseid = ? AND
2216                 repeatid = ? AND modulename = ? AND timestart = ? AND timeduration =?
2217                 AND ' . $DB->sql_compare_text('description', 255) . ' = ' . $DB->sql_compare_text('?', 255);
2218         $arg = array ($params['name'], $params['courseid'], $params['repeatid'], $params['modulename'], $params['timestart'], $params['timeduration'], $params['description']);
2219         $result = $DB->record_exists_sql($sql, $arg);
2220         if (empty($result)) {
2221             $newitemid = $DB->insert_record('event', $params);
2222             $this->set_mapping('event_description', $oldid, $newitemid, $restorefiles);
2223         }
2225     }
2226     protected function after_execute() {
2227         // Add related files
2228         $this->add_related_files('calendar', 'event_description', 'event_description');
2229     }
2232 class restore_course_completion_structure_step extends restore_structure_step {
2234     /**
2235      * Conditionally decide if this step should be executed.
2236      *
2237      * This function checks parameters that are not immediate settings to ensure
2238      * that the enviroment is suitable for the restore of course completion info.
2239      *
2240      * This function checks the following four parameters:
2241      *
2242      *   1. Course completion is enabled on the site
2243      *   2. The backup includes course completion information
2244      *   3. All modules are restorable
2245      *   4. All modules are marked for restore.
2246      *
2247      * @return bool True is safe to execute, false otherwise
2248      */
2249     protected function execute_condition() {
2250         global $CFG;
2252         // First check course completion is enabled on this site
2253         if (empty($CFG->enablecompletion)) {
2254             // Disabled, don't restore course completion
2255             return false;
2256         }
2258         // Check it is included in the backup
2259         $fullpath = $this->task->get_taskbasepath();
2260         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2261         if (!file_exists($fullpath)) {
2262             // Not found, can't restore course completion
2263             return false;
2264         }
2266         // Check we are able to restore all backed up modules
2267         if ($this->task->is_missing_modules()) {
2268             return false;
2269         }
2271         // Finally check all modules within the backup are being restored.
2272         if ($this->task->is_excluding_activities()) {
2273             return false;
2274         }
2276         return true;
2277     }
2279     /**
2280      * Define the course completion structure
2281      *
2282      * @return array Array of restore_path_element
2283      */
2284     protected function define_structure() {
2286         // To know if we are including user completion info
2287         $userinfo = $this->get_setting_value('userscompletion');
2289         $paths = array();
2290         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
2291         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
2293         if ($userinfo) {
2294             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
2295             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
2296         }
2298         return $paths;
2300     }
2302     /**
2303      * Process course completion criteria
2304      *
2305      * @global moodle_database $DB
2306      * @param stdClass $data
2307      */
2308     public function process_course_completion_criteria($data) {
2309         global $DB;
2311         $data = (object)$data;
2312         $data->course = $this->get_courseid();
2314         // Apply the date offset to the time end field
2315         $data->timeend = $this->apply_date_offset($data->timeend);
2317         // Map the role from the criteria
2318         if (!empty($data->role)) {
2319             $data->role = $this->get_mappingid('role', $data->role);
2320         }
2322         $skipcriteria = false;
2324         // If the completion criteria is for a module we need to map the module instance
2325         // to the new module id.
2326         if (!empty($data->moduleinstance) && !empty($data->module)) {
2327             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
2328             if (empty($data->moduleinstance)) {
2329                 $skipcriteria = true;
2330             }
2331         } else {
2332             $data->module = null;
2333             $data->moduleinstance = null;
2334         }
2336         // We backup the course shortname rather than the ID so that we can match back to the course
2337         if (!empty($data->courseinstanceshortname)) {
2338             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
2339             if (!$courseinstanceid) {
2340                 $skipcriteria = true;
2341             }
2342         } else {
2343             $courseinstanceid = null;
2344         }
2345         $data->courseinstance = $courseinstanceid;
2347         if (!$skipcriteria) {
2348             $params = array(
2349                 'course'         => $data->course,
2350                 'criteriatype'   => $data->criteriatype,
2351                 'enrolperiod'    => $data->enrolperiod,
2352                 'courseinstance' => $data->courseinstance,
2353                 'module'         => $data->module,
2354                 'moduleinstance' => $data->moduleinstance,
2355                 'timeend'        => $data->timeend,
2356                 'gradepass'      => $data->gradepass,
2357                 'role'           => $data->role
2358             );
2359             $newid = $DB->insert_record('course_completion_criteria', $params);
2360             $this->set_mapping('course_completion_criteria', $data->id, $newid);
2361         }
2362     }
2364     /**
2365      * Processes course compltion criteria complete records
2366      *
2367      * @global moodle_database $DB
2368      * @param stdClass $data
2369      */
2370     public function process_course_completion_crit_compl($data) {
2371         global $DB;
2373         $data = (object)$data;
2375         // This may be empty if criteria could not be restored
2376         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
2378         $data->course = $this->get_courseid();
2379         $data->userid = $this->get_mappingid('user', $data->userid);
2381         if (!empty($data->criteriaid) && !empty($data->userid)) {
2382             $params = array(
2383                 'userid' => $data->userid,
2384                 'course' => $data->course,
2385                 'criteriaid' => $data->criteriaid,
2386                 'timecompleted' => $this->apply_date_offset($data->timecompleted)
2387             );
2388             if (isset($data->gradefinal)) {
2389                 $params['gradefinal'] = $data->gradefinal;
2390             }
2391             if (isset($data->unenroled)) {
2392                 $params['unenroled'] = $data->unenroled;
2393             }
2394             $DB->insert_record('course_completion_crit_compl', $params);
2395         }
2396     }
2398     /**
2399      * Process course completions
2400      *
2401      * @global moodle_database $DB
2402      * @param stdClass $data
2403      */
2404     public function process_course_completions($data) {
2405         global $DB;
2407         $data = (object)$data;
2409         $data->course = $this->get_courseid();
2410         $data->userid = $this->get_mappingid('user', $data->userid);
2412         if (!empty($data->userid)) {
2413             $params = array(
2414                 'userid' => $data->userid,
2415                 'course' => $data->course,
2416                 'timeenrolled' => $this->apply_date_offset($data->timeenrolled),
2417                 'timestarted' => $this->apply_date_offset($data->timestarted),
2418                 'timecompleted' => $this->apply_date_offset($data->timecompleted),
2419                 'reaggregate' => $data->reaggregate
2420             );
2421             $DB->insert_record('course_completions', $params);
2422         }
2423     }
2425     /**
2426      * Process course completion aggregate methods
2427      *
2428      * @global moodle_database $DB
2429      * @param stdClass $data
2430      */
2431     public function process_course_completion_aggr_methd($data) {
2432         global $DB;
2434         $data = (object)$data;
2436         $data->course = $this->get_courseid();
2438         // Only create the course_completion_aggr_methd records if
2439         // the target course has not them defined. MDL-28180
2440         if (!$DB->record_exists('course_completion_aggr_methd', array(
2441                     'course' => $data->course,
2442                     'criteriatype' => $data->criteriatype))) {
2443             $params = array(
2444                 'course' => $data->course,
2445                 'criteriatype' => $data->criteriatype,
2446                 'method' => $data->method,
2447                 'value' => $data->value,
2448             );
2449             $DB->insert_record('course_completion_aggr_methd', $params);
2450         }
2451     }
2455 /**
2456  * This structure step restores course logs (cmid = 0), delegating
2457  * the hard work to the corresponding {@link restore_logs_processor} passing the
2458  * collection of {@link restore_log_rule} rules to be observed as they are defined
2459  * by the task. Note this is only executed based in the 'logs' setting.
2460  *
2461  * NOTE: This is executed by final task, to have all the activities already restored
2462  *
2463  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
2464  * records are. There are others like 'calendar' and 'upload' that will be handled
2465  * later.
2466  *
2467  * NOTE: All the missing actions (not able to be restored) are sent to logs for
2468  * debugging purposes
2469  */
2470 class restore_course_logs_structure_step extends restore_structure_step {
2472     /**
2473      * Conditionally decide if this step should be executed.
2474      *
2475      * This function checks the following parameter:
2476      *
2477      *   1. the course/logs.xml file exists
2478      *
2479      * @return bool true is safe to execute, false otherwise
2480      */
2481     protected function execute_condition() {
2483         // Check it is included in the backup
2484         $fullpath = $this->task->get_taskbasepath();
2485         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2486         if (!file_exists($fullpath)) {
2487             // Not found, can't restore course logs
2488             return false;
2489         }
2491         return true;
2492     }
2494     protected function define_structure() {
2496         $paths = array();
2498         // Simple, one plain level of information contains them
2499         $paths[] = new restore_path_element('log', '/logs/log');
2501         return $paths;
2502     }
2504     protected function process_log($data) {
2505         global $DB;
2507         $data = (object)($data);
2509         $data->time = $this->apply_date_offset($data->time);
2510         $data->userid = $this->get_mappingid('user', $data->userid);
2511         $data->course = $this->get_courseid();
2512         $data->cmid = 0;
2514         // For any reason user wasn't remapped ok, stop processing this
2515         if (empty($data->userid)) {
2516             return;
2517         }
2519         // Everything ready, let's delegate to the restore_logs_processor
2521         // Set some fixed values that will save tons of DB requests
2522         $values = array(
2523             'course' => $this->get_courseid());
2524         // Get instance and process log record
2525         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2527         // If we have data, insert it, else something went wrong in the restore_logs_processor
2528         if ($data) {
2529             $DB->insert_record('log', $data);
2530         }
2531     }
2534 /**
2535  * This structure step restores activity logs, extending {@link restore_course_logs_structure_step}
2536  * sharing its same structure but modifying the way records are handled
2537  */
2538 class restore_activity_logs_structure_step extends restore_course_logs_structure_step {
2540     protected function process_log($data) {
2541         global $DB;
2543         $data = (object)($data);
2545         $data->time = $this->apply_date_offset($data->time);
2546         $data->userid = $this->get_mappingid('user', $data->userid);
2547         $data->course = $this->get_courseid();
2548         $data->cmid = $this->task->get_moduleid();
2550         // For any reason user wasn't remapped ok, stop processing this
2551         if (empty($data->userid)) {
2552             return;
2553         }
2555         // Everything ready, let's delegate to the restore_logs_processor
2557         // Set some fixed values that will save tons of DB requests
2558         $values = array(
2559             'course' => $this->get_courseid(),
2560             'course_module' => $this->task->get_moduleid(),
2561             $this->task->get_modulename() => $this->task->get_activityid());
2562         // Get instance and process log record
2563         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2565         // If we have data, insert it, else something went wrong in the restore_logs_processor
2566         if ($data) {
2567             $DB->insert_record('log', $data);
2568         }
2569     }
2573 /**
2574  * Defines the restore step for advanced grading methods attached to the activity module
2575  */
2576 class restore_activity_grading_structure_step extends restore_structure_step {
2578     /**
2579      * This step is executed only if the grading file is present
2580      */
2581      protected function execute_condition() {
2583         $fullpath = $this->task->get_taskbasepath();
2584         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2585         if (!file_exists($fullpath)) {
2586             return false;
2587         }
2589         return true;
2590     }
2593     /**
2594      * Declares paths in the grading.xml file we are interested in
2595      */
2596     protected function define_structure() {
2598         $paths = array();
2599         $userinfo = $this->get_setting_value('userinfo');
2601         $area = new restore_path_element('grading_area', '/areas/area');
2602         $paths[] = $area;
2603         // attach local plugin stucture to $area element
2604         $this->add_plugin_structure('local', $area);
2606         $definition = new restore_path_element('grading_definition', '/areas/area/definitions/definition');
2607         $paths[] = $definition;
2608         $this->add_plugin_structure('gradingform', $definition);
2609         // attach local plugin stucture to $definition element
2610         $this->add_plugin_structure('local', $definition);
2613         if ($userinfo) {
2614             $instance = new restore_path_element('grading_instance',
2615                 '/areas/area/definitions/definition/instances/instance');
2616             $paths[] = $instance;
2617             $this->add_plugin_structure('gradingform', $instance);
2618             // attach local plugin stucture to $intance element
2619             $this->add_plugin_structure('local', $instance);
2620         }
2622         return $paths;
2623     }
2625     /**
2626      * Processes one grading area element
2627      *
2628      * @param array $data element data
2629      */
2630     protected function process_grading_area($data) {
2631         global $DB;
2633         $task = $this->get_task();
2634         $data = (object)$data;
2635         $oldid = $data->id;
2636         $data->component = 'mod_'.$task->get_modulename();
2637         $data->contextid = $task->get_contextid();
2639         $newid = $DB->insert_record('grading_areas', $data);
2640         $this->set_mapping('grading_area', $oldid, $newid);
2641     }
2643     /**
2644      * Processes one grading definition element
2645      *
2646      * @param array $data element data
2647      */
2648     protected function process_grading_definition($data) {
2649         global $DB;
2651         $task = $this->get_task();
2652         $data = (object)$data;
2653         $oldid = $data->id;
2654         $data->areaid = $this->get_new_parentid('grading_area');
2655         $data->copiedfromid = null;
2656         $data->timecreated = time();
2657         $data->usercreated = $task->get_userid();
2658         $data->timemodified = $data->timecreated;
2659         $data->usermodified = $data->usercreated;
2661         $newid = $DB->insert_record('grading_definitions', $data);
2662         $this->set_mapping('grading_definition', $oldid, $newid, true);
2663     }
2665     /**
2666      * Processes one grading form instance element
2667      *
2668      * @param array $data element data
2669      */
2670     protected function process_grading_instance($data) {
2671         global $DB;
2673         $data = (object)$data;
2675         // new form definition id
2676         $newformid = $this->get_new_parentid('grading_definition');
2678         // get the name of the area we are restoring to
2679         $sql = "SELECT ga.areaname
2680                   FROM {grading_definitions} gd
2681                   JOIN {grading_areas} ga ON gd.areaid = ga.id
2682                  WHERE gd.id = ?";
2683         $areaname = $DB->get_field_sql($sql, array($newformid), MUST_EXIST);
2685         // get the mapped itemid - the activity module is expected to define the mappings
2686         // for each gradable area
2687         $newitemid = $this->get_mappingid(restore_gradingform_plugin::itemid_mapping($areaname), $data->itemid);
2689         $oldid = $data->id;
2690         $data->definitionid = $newformid;
2691         $data->raterid = $this->get_mappingid('user', $data->raterid);
2692         $data->itemid = $newitemid;
2694         $newid = $DB->insert_record('grading_instances', $data);
2695         $this->set_mapping('grading_instance', $oldid, $newid);
2696     }
2698     /**
2699      * Final operations when the database records are inserted
2700      */
2701     protected function after_execute() {
2702         // Add files embedded into the definition description
2703         $this->add_related_files('grading', 'description', 'grading_definition');
2704     }
2708 /**
2709  * This structure step restores the grade items associated with one activity
2710  * All the grade items are made child of the "course" grade item but the original
2711  * categoryid is saved as parentitemid in the backup_ids table, so, when restoring
2712  * the complete gradebook (categories and calculations), that information is
2713  * available there
2714  */
2715 class restore_activity_grades_structure_step extends restore_structure_step {
2717     protected function define_structure() {
2719         $paths = array();
2720         $userinfo = $this->get_setting_value('userinfo');
2722         $paths[] = new restore_path_element('grade_item', '/activity_gradebook/grade_items/grade_item');
2723         $paths[] = new restore_path_element('grade_letter', '/activity_gradebook/grade_letters/grade_letter');
2724         if ($userinfo) {
2725             $paths[] = new restore_path_element('grade_grade',
2726                            '/activity_gradebook/grade_items/grade_item/grade_grades/grade_grade');
2727         }
2728         return $paths;
2729     }
2731     protected function process_grade_item($data) {
2732         global $DB;
2734         $data = (object)($data);
2735         $oldid       = $data->id;        // We'll need these later
2736         $oldparentid = $data->categoryid;
2737         $courseid = $this->get_courseid();
2739         // make sure top course category exists, all grade items will be associated
2740         // to it. Later, if restoring the whole gradebook, categories will be introduced
2741         $coursecat = grade_category::fetch_course_category($courseid);
2742         $coursecatid = $coursecat->id; // Get the categoryid to be used
2744         $idnumber = null;
2745         if (!empty($data->idnumber)) {
2746             // Don't get any idnumber from course module. Keep them as they are in grade_item->idnumber
2747             // Reason: it's not clear what happens with outcomes->idnumber or activities with multiple items (workshop)
2748             // so the best is to keep the ones already in the gradebook
2749             // Potential problem: duplicates if same items are restored more than once. :-(
2750             // This needs to be fixed in some way (outcomes & activities with multiple items)
2751             // $data->idnumber     = get_coursemodule_from_instance($data->itemmodule, $data->iteminstance)->idnumber;
2752             // In any case, verify always for uniqueness
2753             $sql = "SELECT cm.id
2754                       FROM {course_modules} cm
2755                      WHERE cm.course = :courseid AND
2756                            cm.idnumber = :idnumber AND
2757                            cm.id <> :cmid";
2758             $params = array(
2759                 'courseid' => $courseid,
2760                 'idnumber' => $data->idnumber,
2761                 'cmid' => $this->task->get_moduleid()
2762             );
2763             if (!$DB->record_exists_sql($sql, $params) && !$DB->record_exists('grade_items', array('courseid' => $courseid, 'idnumber' => $data->idnumber))) {
2764                 $idnumber = $data->idnumber;
2765             }
2766         }
2768         unset($data->id);
2769         $data->categoryid   = $coursecatid;
2770         $data->courseid     = $this->get_courseid();
2771         $data->iteminstance = $this->task->get_activityid();
2772         $data->idnumber     = $idnumber;
2773         $data->scaleid      = $this->get_mappingid('scale', $data->scaleid);
2774         $data->outcomeid    = $this->get_mappingid('outcome', $data->outcomeid);
2775         $data->timecreated  = $this->apply_date_offset($data->timecreated);
2776         $data->timemodified = $this->apply_date_offset($data->timemodified);
2778         $gradeitem = new grade_item($data, false);
2779         $gradeitem->insert('restore');
2781         //sortorder is automatically assigned when inserting. Re-instate the previous sortorder
2782         $gradeitem->sortorder = $data->sortorder;
2783         $gradeitem->update('restore');
2785         // Set mapping, saving the original category id into parentitemid
2786         // gradebook restore (final task) will need it to reorganise items
2787         $this->set_mapping('grade_item', $oldid, $gradeitem->id, false, null, $oldparentid);
2788     }
2790     protected function process_grade_grade($data) {
2791         $data = (object)($data);
2792         $olduserid = $data->userid;
2793         unset($data->id);
2795         $data->itemid = $this->get_new_parentid('grade_item');
2797         $data->userid = $this->get_mappingid('user', $data->userid, null);
2798         if (!empty($data->userid)) {
2799             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
2800             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
2801             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
2802             $data->overridden = $this->apply_date_offset($data->overridden);
2804             $grade = new grade_grade($data, false);
2805             $grade->insert('restore');
2806             // no need to save any grade_grade mapping
2807         } else {
2808             debugging("Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'");
2809         }
2810     }
2812     /**
2813      * process activity grade_letters. Note that, while these are possible,
2814      * because grade_letters are contextid based, in practice, only course
2815      * context letters can be defined. So we keep here this method knowing
2816      * it won't be executed ever. gradebook restore will restore course letters.
2817      */
2818     protected function process_grade_letter($data) {
2819         global $DB;
2821         $data['contextid'] = $this->task->get_contextid();
2822         $gradeletter = (object)$data;
2824         // Check if it exists before adding it
2825         unset($data['id']);
2826         if (!$DB->record_exists('grade_letters', $data)) {
2827             $newitemid = $DB->insert_record('grade_letters', $gradeletter);
2828         }
2829         // no need to save any grade_letter mapping
2830     }
2834 /**
2835  * This structure steps restores one instance + positions of one block
2836  * Note: Positions corresponding to one existing context are restored
2837  * here, but all the ones having unknown contexts are sent to backup_ids
2838  * for a later chance to be restored at the end (final task)
2839  */
2840 class restore_block_instance_structure_step extends restore_structure_step {
2842     protected function define_structure() {
2844         $paths = array();
2846         $paths[] = new restore_path_element('block', '/block', true); // Get the whole XML together
2847         $paths[] = new restore_path_element('block_position', '/block/block_positions/block_position');
2849         return $paths;
2850     }
2852     public function process_block($data) {
2853         global $DB, $CFG;
2855         $data = (object)$data; // Handy
2856         $oldcontextid = $data->contextid;
2857         $oldid        = $data->id;
2858         $positions = isset($data->block_positions['block_position']) ? $data->block_positions['block_position'] : array();
2860         // Look for the parent contextid
2861         if (!$data->parentcontextid = $this->get_mappingid('context', $data->parentcontextid)) {
2862             throw new restore_step_exception('restore_block_missing_parent_ctx', $data->parentcontextid);
2863         }
2865         // TODO: it would be nice to use standard plugin supports instead of this instance_allow_multiple()
2866         // If there is already one block of that type in the parent context
2867         // and the block is not multiple, stop processing
2868         // Use blockslib loader / method executor
2869         if (!$bi = block_instance($data->blockname)) {
2870             return false;
2871         }
2873         if (!$bi->instance_allow_multiple()) {
2874             if ($DB->record_exists_sql("SELECT bi.id
2875                                           FROM {block_instances} bi
2876                                           JOIN {block} b ON b.name = bi.blockname
2877                                          WHERE bi.parentcontextid = ?
2878                                            AND bi.blockname = ?", array($data->parentcontextid, $data->blockname))) {
2879                 return false;
2880             }
2881         }
2883         // If there is already one block of that type in the parent context
2884         // with the same showincontexts, pagetypepattern, subpagepattern, defaultregion and configdata
2885         // stop processing
2886         $params = array(
2887             'blockname' => $data->blockname, 'parentcontextid' => $data->parentcontextid,
2888             'showinsubcontexts' => $data->showinsubcontexts, 'pagetypepattern' => $data->pagetypepattern,
2889             'subpagepattern' => $data->subpagepattern, 'defaultregion' => $data->defaultregion);
2890         if ($birecs = $DB->get_records('block_instances', $params)) {
2891             foreach($birecs as $birec) {
2892                 if ($birec->configdata == $data->configdata) {
2893                     return false;
2894                 }
2895             }
2896         }
2898         // Set task old contextid, blockid and blockname once we know them
2899         $this->task->set_old_contextid($oldcontextid);
2900         $this->task->set_old_blockid($oldid);
2901         $this->task->set_blockname($data->blockname);
2903         // Let's look for anything within configdata neededing processing
2904         // (nulls and uses of legacy file.php)
2905         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
2906             $configdata = (array)unserialize(base64_decode($data->configdata));
2907             foreach ($configdata as $attribute => $value) {
2908                 if (in_array($attribute, $attrstotransform)) {
2909                     $configdata[$attribute] = $this->contentprocessor->process_cdata($value);
2910                 }
2911             }
2912             $data->configdata = base64_encode(serialize((object)$configdata));
2913         }
2915         // Create the block instance
2916         $newitemid = $DB->insert_record('block_instances', $data);
2917         // Save the mapping (with restorefiles support)
2918         $this->set_mapping('block_instance', $oldid, $newitemid, true);
2919         // Create the block context
2920         $newcontextid = context_block::instance($newitemid)->id;
2921         // Save the block contexts mapping and sent it to task
2922         $this->set_mapping('context', $oldcontextid, $newcontextid);
2923         $this->task->set_contextid($newcontextid);
2924         $this->task->set_blockid($newitemid);
2926         // Restore block fileareas if declared
2927         $component = 'block_' . $this->task->get_blockname();
2928         foreach ($this->task->get_fileareas() as $filearea) { // Simple match by contextid. No itemname needed
2929             $this->add_related_files($component, $filearea, null);
2930         }
2932         // Process block positions, creating them or accumulating for final step
2933         foreach($positions as $position) {
2934             $position = (object)$position;
2935             $position->blockinstanceid = $newitemid; // The instance is always the restored one
2936             // If position is for one already mapped (known) contextid
2937             // process it now, creating the position
2938             if ($newpositionctxid = $this->get_mappingid('context', $position->contextid)) {
2939                 $position->contextid = $newpositionctxid;
2940                 // Create the block position
2941                 $DB->insert_record('block_positions', $position);
2943             // The position belongs to an unknown context, send it to backup_ids
2944             // to process them as part of the final steps of restore. We send the
2945             // whole $position object there, hence use the low level method.
2946             } else {
2947                 restore_dbops::set_backup_ids_record($this->get_restoreid(), 'block_position', $position->id, 0, null, $position);
2948             }
2949         }
2950     }
2953 /**
2954  * Structure step to restore common course_module information
2955  *
2956  * This step will process the module.xml file for one activity, in order to restore
2957  * the corresponding information to the course_modules table, skipping various bits
2958  * of information based on CFG settings (groupings, completion...) in order to fullfill
2959  * all the reqs to be able to create the context to be used by all the rest of steps
2960  * in the activity restore task
2961  */
2962 class restore_module_structure_step extends restore_structure_step {
2964     protected function define_structure() {
2965         global $CFG;
2967         $paths = array();
2969         $module = new restore_path_element('module', '/module');
2970         $paths[] = $module;
2971         if ($CFG->enableavailability) {
2972             $paths[] = new restore_path_element('availability', '/module/availability_info/availability');
2973             $paths[] = new restore_path_element('availability_field', '/module/availability_info/availability_field');
2974         }
2976         // Apply for 'format' plugins optional paths at module level
2977         $this->add_plugin_structure('format', $module);
2979         // Apply for 'plagiarism' plugins optional paths at module level
2980         $this->add_plugin_structure('plagiarism', $module);
2982         // Apply for 'local' plugins optional paths at module level
2983         $this->add_plugin_structure('local', $module);
2985         return $paths;
2986     }
2988     protected function process_module($data) {
2989         global $CFG, $DB;
2991         $data = (object)$data;
2992         $oldid = $data->id;
2993         $this->task->set_old_moduleversion($data->version);
2995         $data->course = $this->task->get_courseid();
2996         $data->module = $DB->get_field('modules', 'id', array('name' => $data->modulename));
2997         // Map section (first try by course_section mapping match. Useful in course and section restores)
2998         $data->section = $this->get_mappingid('course_section', $data->sectionid);
2999         if (!$data->section) { // mapping failed, try to get section by sectionnumber matching
3000             $params = array(
3001                 'course' => $this->get_courseid(),
3002                 'section' => $data->sectionnumber);
3003             $data->section = $DB->get_field('course_sections', 'id', $params);
3004         }
3005         if (!$data->section) { // sectionnumber failed, try to get first section in course
3006             $params = array(
3007                 'course' => $this->get_courseid());
3008             $data->section = $DB->get_field('course_sections', 'MIN(id)', $params);
3009         }
3010         if (!$data->section) { // no sections in course, create section 0 and 1 and assign module to 1
3011             $sectionrec = array(
3012                 'course' => $this->get_courseid(),
3013                 'section' => 0);
3014             $DB->insert_record('course_sections', $sectionrec); // section 0
3015             $sectionrec = array(
3016                 'course' => $this->get_courseid(),
3017                 'section' => 1);
3018             $data->section = $DB->insert_record('course_sections', $sectionrec); // section 1
3019         }
3020         $data->groupingid= $this->get_mappingid('grouping', $data->groupingid);      // grouping
3021         if (!$CFG->enablegroupmembersonly) {                                         // observe groupsmemberonly
3022             $data->groupmembersonly = 0;
3023         }
3024         if (!grade_verify_idnumber($data->idnumber, $this->get_courseid())) {        // idnumber uniqueness
3025             $data->idnumber = '';
3026         }
3027         if (empty($CFG->enablecompletion)) { // completion
3028             $data->completion = 0;
3029             $data->completiongradeitemnumber = null;
3030             $data->completionview = 0;
3031             $data->completionexpected = 0;
3032         } else {
3033             $data->completionexpected = $this->apply_date_offset($data->completionexpected);
3034         }
3035         if (empty($CFG->enableavailability)) {
3036             $data->availablefrom = 0;
3037             $data->availableuntil = 0;
3038             $data->showavailability = 0;
3039         } else {
3040             $data->availablefrom = $this->apply_date_offset($data->availablefrom);
3041             $data->availableuntil= $this->apply_date_offset($data->availableuntil);
3042         }
3043         // Backups that did not include showdescription, set it to default 0
3044         // (this is not totally necessary as it has a db default, but just to
3045         // be explicit).
3046         if (!isset($data->showdescription)) {
3047             $data->showdescription = 0;
3048         }
3049         $data->instance = 0; // Set to 0 for now, going to create it soon (next step)
3051         // course_module record ready, insert it
3052         $newitemid = $DB->insert_record('course_modules', $data);
3053         // save mapping
3054         $this->set_mapping('course_module', $oldid, $newitemid);
3055         // set the new course_module id in the task
3056         $this->task->set_moduleid($newitemid);
3057         // we can now create the context safely
3058         $ctxid = context_module::instance($newitemid)->id;
3059         // set the new context id in the task
3060         $this->task->set_contextid($ctxid);
3061         // update sequence field in course_section
3062         if ($sequence = $DB->get_field('course_sections', 'sequence', array('id' => $data->section))) {
3063             $sequence .= ',' . $newitemid;
3064         } else {
3065             $sequence = $newitemid;
3066         }
3067         $DB->set_field('course_sections', 'sequence', $sequence, array('id' => $data->section));
3068     }
3070     protected function process_availability($data) {
3071         $data = (object)$data;
3072         // Simply going to store the whole availability record now, we'll process
3073         // all them later in the final task (once all activities have been restored)
3074         // Let's call the low level one to be able to store the whole object
3075         $data->coursemoduleid = $this->task->get_moduleid(); // Let add the availability cmid
3076         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'module_availability', $data->id, 0, null, $data);
3077     }
3079     protected function process_availability_field($data) {
3080         global $DB;
3081         $data = (object)$data;
3082         // Mark it is as passed by default
3083         $passed = true;
3084         $customfieldid = null;
3086         // If a customfield has been used in order to pass we must be able to match an existing
3087         // customfield by name (data->customfield) and type (data->customfieldtype)
3088         if (!empty($data->customfield) xor !empty($data->customfieldtype)) {
3089             // xor is sort of uncommon. If either customfield is null or customfieldtype is null BUT not both.
3090             // If one is null but the other isn't something clearly went wrong and we'll skip this condition.
3091             $passed = false;
3092         } else if (!empty($data->customfield)) {
3093             $params = array('shortname' => $data->customfield, 'datatype' => $data->customfieldtype);
3094             $customfieldid = $DB->get_field('user_info_field', 'id', $params);
3095             $passed = ($customfieldid !== false);
3096         }
3098         if ($passed) {
3099             // Create the object to insert into the database
3100             $availfield = new stdClass();
3101             $availfield->coursemoduleid = $this->task->get_moduleid(); // Lets add the availability cmid
3102             $availfield->userfield = $data->userfield;
3103             $availfield->customfieldid = $customfieldid;
3104             $availfield->operator = $data->operator;
3105             $availfield->value = $data->value;
3106             // Insert into the database
3107             $DB->insert_record('course_modules_avail_fields', $availfield);
3108         }
3109     }
3112 /**
3113  * Structure step that will process the user activity completion
3114  * information if all these conditions are met:
3115  *  - Target site has completion enabled ($CFG->enablecompletion)
3116  *  - Activity includes completion info (file_exists)
3117  */
3118 class restore_userscompletion_structure_step extends restore_structure_step {
3119     /**
3120      * To conditionally decide if this step must be executed
3121      * Note the "settings" conditions are evaluated in the
3122      * corresponding task. Here we check for other conditions
3123      * not being restore settings (files, site settings...)
3124      */
3125      protected function execute_condition() {
3126          global $CFG;
3128          // Completion disabled in this site, don't execute
3129          if (empty($CFG->enablecompletion)) {
3130              return false;
3131          }
3133          // No user completion info found, don't execute
3134         $fullpath = $this->task->get_taskbasepath();
3135         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
3136          if (!file_exists($fullpath)) {
3137              return false;
3138          }
3140          // Arrived here, execute the step
3141          return true;
3142      }
3144      protected function define_structure() {
3146         $paths = array();
3148         $paths[] = new restore_path_element('completion', '/completions/completion');
3150         return $paths;
3151     }
3153     protected function process_completion($data) {
3154         global $DB;
3156         $data = (object)$data;
3158         $data->coursemoduleid = $this->task->get_moduleid();
3159         $data->userid = $this->get_mappingid('user', $data->userid);
3160         $data->timemodified = $this->apply_date_offset($data->timemodified);
3162         // Find the existing record
3163         $existing = $DB->get_record('course_modules_completion', array(
3164                 'coursemoduleid' => $data->coursemoduleid,
3165                 'userid' => $data->userid), 'id, timemodified');
3166         // Check we didn't already insert one for this cmid and userid
3167         // (there aren't supposed to be duplicates in that field, but
3168         // it was possible until MDL-28021 was fixed).
3169         if ($existing) {
3170             // Update it to these new values, but only if the time is newer
3171             if ($existing->timemodified < $data->timemodified) {
3172                 $data->id = $existing->id;
3173                 $DB->update_record('course_modules_completion', $data);
3174             }
3175         } else {
3176             // Normal entry where it doesn't exist already
3177             $DB->insert_record('course_modules_completion', $data);
3178         }
3179     }
3182 /**
3183  * Abstract structure step, parent of all the activity structure steps. Used to suuport
3184  * the main <activity ...> tag and process it. Also provides subplugin support for
3185  * activities.
3186  */
3187 abstract class restore_activity_structure_step extends restore_structure_step {
3189     protected function add_subplugin_structure($subplugintype, $element) {
3191         global $CFG;
3193         // Check the requested subplugintype is a valid one
3194         $subpluginsfile = $CFG->dirroot . '/mod/' . $this->task->get_modulename() . '/db/subplugins.php';
3195         if (!file_exists($subpluginsfile)) {
3196              throw new restore_step_exception('activity_missing_subplugins_php_file', $this->task->get_modulename());
3197         }
3198         include($subpluginsfile);
3199         if (!array_key_exists($subplugintype, $subplugins)) {
3200              throw new restore_step_exception('incorrect_subplugin_type', $subplugintype);
3201         }
3202         // Get all the restore path elements, looking across all the subplugin dirs
3203         $subpluginsdirs = core_component::get_plugin_list($subplugintype);
3204         foreach ($subpluginsdirs as $name => $subpluginsdir) {
3205             $classname = 'restore_' . $subplugintype . '_' . $name . '_subplugin';
3206             $restorefile = $subpluginsdir . '/backup/moodle2/' . $classname . '.class.php';
3207             if (file_exists($restorefile)) {
3208                 require_once($restorefile);
3209                 $restoresubplugin = new $classname($subplugintype, $name, $this);
3210                 // Add subplugin paths to the step
3211                 $this->prepare_pathelements($restoresubplugin->define_subplugin_structure($element));
3212             }
3213         }
3214     }
3216     /**
3217      * As far as activity restore steps are implementing restore_subplugin stuff, they need to
3218      * have the parent task available for wrapping purposes (get course/context....)
3219      * @return restore_task
3220      */
3221     public function get_task() {
3222         return $this->task;
3223     }
3225     /**
3226      * Adds support for the 'activity' path that is common to all the activities
3227      * and will be processed globally here
3228      */
3229     protected function prepare_activity_structure($paths) {
3231         $paths[] = new restore_path_element('activity', '/activity');
3233         return $paths;
3234     }
3236     /**
3237      * Process the activity path, informing the task about various ids, needed later
3238      */
3239     protected function process_activity($data) {
3240         $data = (object)$data;
3241         $this->task->set_old_contextid($data->contextid); // Save old contextid in task
3242         $this->set_mapping('context', $data->contextid, $this->task->get_contextid()); // Set the mapping
3243         $this->task->set_old_activityid($data->id); // Save old activityid in task
3244     }
3246     /**
3247      * This must be invoked immediately after creating the "module" activity record (forum, choice...)
3248      * and will adjust the new activity id (the instance) in various places
3249      */
3250     protected function apply_activity_instance($newitemid) {
3251         global $DB;
3253         $this->task->set_activityid($newitemid); // Save activity id in task
3254         // Apply the id to course_sections->instanceid
3255         $DB->set_field('course_modules', 'instance', $newitemid, array('id' => $this->task->get_moduleid()));
3256         // Do the mapping for modulename, preparing it for files by oldcontext
3257         $modulename = $this->task->get_modulename();
3258         $oldid = $this->task->get_old_activityid();
3259         $this->set_mapping($modulename, $oldid, $newitemid, true);
3260     }
3263 /**
3264  * Structure step in charge of creating/mapping all the qcats and qs
3265  * by parsing the questions.xml file and checking it against the
3266  * results calculated by {@link restore_process_categories_and_questions}
3267  * and stored in backup_ids_temp
3268  */
3269 class restore_create_categories_and_questions extends restore_structure_step {
3271     protected function define_structure() {
3273         $category = new restore_path_element('question_category', '/question_categories/question_category');
3274         $question = new restore_path_element('question', '/question_categories/question_category/questions/question');
3275         $hint = new restore_path_element('question_hint',
3276                 '/question_categories/question_category/questions/question/question_hints/question_hint');
3278         $tag = new restore_path_element('tag','/question_categories/question_category/questions/question/tags/tag');
3280         // Apply for 'qtype' plugins optional paths at question level
3281         $this->add_plugin_structure('qtype', $question);
3283         // Apply for 'local' plugins optional paths at question level
3284         $this->add_plugin_structure('local', $question);
3286         return array($category, $question, $hint, $tag);
3287     }
3289     protected function process_question_category($data) {
3290         global $DB;
3292         $data = (object)$data;
3293         $oldid = $data->id;
3295         // Check we have one mapping for this category
3296         if (!$mapping = $this->get_mapping('question_category', $oldid)) {
3297             return self::SKIP_ALL_CHILDREN; // No mapping = this category doesn't need to be created/mapped
3298         }
3300         // Check we have to create the category (newitemid = 0)
3301         if ($mapping->newitemid) {
3302             return; // newitemid != 0, this category is going to be mapped. Nothing to do
3303         }
3305         // Arrived here, newitemid = 0, we need to create the category
3306         // we'll do it at parentitemid context, but for CONTEXT_MODULE
3307         // categories, that will be created at CONTEXT_COURSE and moved
3308         // to module context later when the activity is created
3309         if ($mapping->info->contextlevel == CONTEXT_MODULE) {
3310             $mapping->parentitemid = $this->get_mappingid('context', $this->task->get_old_contextid());
3311         }
3312         $data->contextid = $mapping->parentitemid;
3314         // Let's create the question_category and save mapping
3315         $newitemid = $DB->insert_record('question_categories', $data);
3316         $this->set_mapping('question_category', $oldid, $newitemid);
3317         // Also annotate them as question_category_created, we need
3318         // that later when remapping parents
3319         $this->set_mapping('question_category_created', $oldid, $newitemid, false, null, $data->contextid);
3320     }
3322     protected function process_question($data) {
3323         global $DB;
3325         $data = (object)$data;
3326         $oldid = $data->id;
3328         // Check we have one mapping for this question
3329         if (!$questionmapping = $this->get_mapping('question', $oldid)) {
3330             return; // No mapping = this question doesn't need to be created/mapped
3331         }
3333         // Get the mapped category (cannot use get_new_parentid() because not
3334         // all the categories have been created, so it is not always available
3335         // Instead we get the mapping for the question->parentitemid because
3336         // we have loaded qcatids there for all parsed questions
3337         $data->category = $this->get_mappingid('question_category', $questionmapping->parentitemid);
3339         // In the past, there were some very sloppy values of penalty. Fix them.
3340         if ($data->penalty >= 0.33 && $data->penalty <= 0.34) {
3341             $data->penalty = 0.3333333;
3342         }
3343         if ($data->penalty >= 0.66 && $data->penalty <= 0.67) {
3344             $data->penalty = 0.6666667;
3345         }
3346         if ($data->penalty >= 1) {
3347             $data->penalty = 1;
3348         }
3350         $userid = $this->get_mappingid('user', $data->createdby);
3351         $data->createdby = $userid ? $userid : $this->task->get_userid();
3353         $userid = $this->get_mappingid('user', $data->modifiedby);
3354         $data->modifiedby = $userid ? $userid : $this->task->get_userid();
3356         // With newitemid = 0, let's create the question
3357         if (!$questionmapping->newitemid) {
3358             $newitemid = $DB->insert_record('question', $data);
3359             $this->set_mapping('question', $oldid, $newitemid);
3360             // Also annotate them as question_created, we need
3361             // that later when remapping parents (keeping the old categoryid as parentid)
3362             $this->set_mapping('question_created', $oldid, $newitemid, false, null, $questionmapping->parentitemid);
3363         } else {
3364             // By performing this set_mapping() we make get_old/new_parentid() to work for all the
3365             // children elements of the 'question' one (so qtype plugins will know the question they belong to)
3366             $this->set_mapping('question', $oldid, $questionmapping->newitemid);
3367         }
3369         // Note, we don't restore any question files yet
3370         // as far as the CONTEXT_MODULE categories still
3371         // haven't their contexts to be restored to
3372         // The {@link restore_create_question_files}, executed in the final step
3373         // step will be in charge of restoring all the question files
3374     }
3376         protected function process_question_hint($data) {
3377         global $DB;
3379         $data = (object)$data;
3380         $oldid = $data->id;
3382         // Detect if the question is created or mapped
3383         $oldquestionid   = $this->get_old_parentid('question');
3384         $newquestionid   = $this->get_new_parentid('question');
3385         $questioncreated = $this->get_mappingid('question_created', $oldquestionid) ? true : false;
3387         // If the question has been created by restore, we need to create its question_answers too
3388         if ($questioncreated) {
3389             // Adjust some columns
3390             $data->questionid = $newquestionid;
3391             // Insert record
3392             $newitemid = $DB->insert_record('question_hints', $data);
3394         // The question existed, we need to map the existing question_hints
3395         } else {
3396             // Look in question_hints by hint text matching
3397             $sql = 'SELECT id
3398                       FROM {question_hints}
3399                      WHERE questionid = ?
3400                        AND ' . $DB->sql_compare_text('hint', 255) . ' = ' . $DB->sql_compare_text('?', 255);
3401             $params = array($newquestionid, $data->hint);
3402             $newitemid = $DB->get_field_sql($sql, $params);
3404             // Not able to find the hint, let's try cleaning the hint text
3405             // of all the question's hints in DB as slower fallback. MDL-33863.
3406             if (!$newitemid) {
3407                 $potentialhints = $DB->get_records('question_hints',
3408                         array('questionid' => $newquestionid), '', 'id, hint');
3409                 foreach ($potentialhints as $potentialhint) {
3410                     // Clean in the same way than {@link xml_writer::xml_safe_utf8()}.
3411                     $cleanhint = preg_replace('/[\x-\x8\xb-\xc\xe-\x1f\x7f]/is','', $potentialhint->hint); // Clean CTRL chars.
3412                     $cleanhint = preg_replace("/\r\n|\r/", "\n", $cleanhint); // Normalize line ending.
3413                     if ($cleanhint === $data->hint) {
3414                         $newitemid = $data->id;
3415                     }
3416                 }
3417             }
3419             // If we haven't found the newitemid, something has gone really wrong, question in DB
3420             // is missing hints, exception
3421             if (!$newitemid) {
3422                 $info = new stdClass();
3423                 $info->filequestionid = $oldquestionid;
3424                 $info->dbquestionid   = $newquestionid;
3425                 $info->hint           = $data->hint;
3426                 throw new restore_step_exception('error_question_hint_missing_in_db', $info);
3427             }
3428         }
3429         // Create mapping (I'm not sure if this is really needed?)
3430         $this->set_mapping('question_hint', $oldid, $newitemid);
3431     }
3433     protected function process_tag($data) {
3434         global $CFG, $DB;
3436         $data = (object)$data;
3437         $newquestion = $this->get_new_parentid('question');
3439         if (!empty($CFG->usetags)) { // if enabled in server
3440             // TODO: This is highly inneficient. Each time we add one tag
3441             // we fetch all the existing because tag_set() deletes them
3442             // so everything must be reinserted on each call
3443             $tags = array();
3444             $existingtags = tag_get_tags('question', $newquestion);
3445             // Re-add all the existitng tags
3446             foreach ($existingtags as $existingtag) {
3447                 $tags[] = $existingtag->rawname;
3448             }
3449             // Add the one being restored
3450             $tags[] = $data->rawname;
3451             // Send all the tags back to the question
3452             tag_set('question', $newquestion, $tags);
3453         }
3454     }
3456     protected function after_execute() {
3457         global $DB;
3459         // First of all, recode all the created question_categories->parent fields
3460         $qcats = $DB->get_records('backup_ids_temp', array(
3461                      'backupid' => $this->get_restoreid(),
3462                      'itemname' => 'question_category_created'));
3463         foreach ($qcats as $qcat) {
3464             $newparent = 0;
3465             $dbcat = $DB->get_record('question_categories', array('id' => $qcat->newitemid));
3466             // Get new parent (mapped or created, so we look in quesiton_category mappings)
3467             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
3468                                  'backupid' => $this->get_restoreid(),
3469                                  'itemname' => 'question_category',
3470                                  'itemid'   => $dbcat->parent))) {
3471                 // contextids must match always, as far as we always include complete qbanks, just check it
3472                 $newparentctxid = $DB->get_field('question_categories', 'contextid', array('id' => $newparent));
3473                 if ($dbcat->contextid == $newparentctxid) {
3474                     $DB->set_field('question_categories', 'parent', $newparent, array('id' => $dbcat->id));
3475                 } else {
3476                     $newparent = 0; // No ctx match for both cats, no parent relationship
3477                 }
3478             }
3479             // Here with $newparent empty, problem with contexts or remapping, set it to top cat
3480             if (!$newparent) {
3481                 $DB->set_field('question_categories', 'parent', 0, array('id' => $dbcat->id));
3482             }
3483         }
3485         // Now, recode all the created question->parent fields
3486         $qs = $DB->get_records('backup_ids_temp', array(
3487                   'backupid' => $this->get_restoreid(),
3488                   'itemname' => 'question_created'));
3489         foreach ($qs as $q) {
3490             $newparent = 0;
3491             $dbq = $DB->get_record('question', array('id' => $q->newitemid));
3492             // Get new parent (mapped or created, so we look in question mappings)
3493             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
3494                                  'backupid' => $this->get_restoreid(),
3495                                  'itemname' => 'question',
3496                                  'itemid'   => $dbq->parent))) {
3497                 $DB->set_field('question', 'parent', $newparent, array('id' => $dbq->id));
3498             }
3499         }
3501         // Note, we don't restore any question files yet
3502         // as far as the CONTEXT_MODULE categories still
3503         // haven't their contexts to be restored to
3504         // The {@link restore_create_question_files}, executed in the final step
3505         // step will be in charge of restoring all the question files
3506     }
3509 /**
3510  * Execution step that will move all the CONTEXT_MODULE question categories
3511  * created at early stages of restore in course context (because modules weren't
3512  * created yet) to their target module (matching by old-new-contextid mapping)
3513  */
3514 class restore_move_module_questions_categories extends restore_execution_step {
3516     protected function define_execution() {
3517         global $DB;
3519         $contexts = restore_dbops::restore_get_question_banks($this->get_restoreid(), CONTEXT_MODULE);
3520         foreach ($contexts as $contextid => $contextlevel) {
3521             // Only if context mapping exists (i.e. the module has been restored)
3522             if ($newcontext = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $contextid)) {
3523                 // Update all the qcats having their parentitemid set to the original contextid
3524                 $modulecats = $DB->get_records_sql("SELECT itemid, newitemid
3525                                                       FROM {backup_ids_temp}
3526                                                      WHERE backupid = ?
3527                                                        AND itemname = 'question_category'
3528                                                        AND parentitemid = ?", array($this->get_restoreid(), $contextid));
3529                 foreach ($modulecats as $modulecat) {
3530                     $DB->set_field('question_categories', 'contextid', $newcontext->newitemid, array('id' => $modulecat->newitemid));
3531                     // And set new contextid also in question_category mapping (will be
3532                     // used by {@link restore_create_question_files} later
3533                     restore_dbops::set_backup_ids_record($this->get_restoreid(), 'question_category', $modulecat->itemid, $modulecat->newitemid, $newcontext->newitemid);
3534                 }
3535             }
3536         }
3537     }
3540 /**
3541  * Execution step that will create all the question/answers/qtype-specific files for the restored
3542  * questions. It must be executed after {@link restore_move_module_questions_categories}
3543  * because only then each question is in its final category and only then the
3544  * context can be determined
3545  *
3546  * TODO: Improve this. Instead of looping over each question, it can be reduced to
3547  *       be done by contexts (this will save a huge ammount of queries)
3548  */
3549 class restore_create_question_files extends restore_execution_step {
3551     protected function define_execution() {
3552         global $DB;
3554         // Track progress, as this task can take a long time.
3555         $progress = $this->task->get_progress();
3556         $progress->start_progress($this->get_name(), core_backup_progress::INDETERMINATE);
3558         // Let's process only created questions
3559         $questionsrs = $DB->get_recordset_sql("SELECT bi.itemid, bi.newitemid, bi.parentitemid, q.qtype
3560                                                FROM {backup_ids_temp} bi
3561                                                JOIN {question} q ON q.id = bi.newitemid
3562                                               WHERE bi.backupid = ?
3563                                                 AND bi.itemname = 'question_created'", array($this->get_restoreid()));
3564         foreach ($questionsrs as $question) {
3565             // Report progress for each question.
3566             $progress->progress();
3568             // Get question_category mapping, it contains the target context for the question
3569             if (!$qcatmapping = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'question_category', $question->parentitemid)) {
3570                 // Something went really wrong, cannot find the question_category for the question
3571                 debugging('Error fetching target context for question', DEBUG_DEVELOPER);
3572                 continue;
3573             }
3574             // Calculate source and target contexts
3575             $oldctxid = $qcatmapping->info->contextid;
3576             $newctxid = $qcatmapping->parentitemid;
3578             // Add common question files (question and question_answer ones)
3579             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'questiontext',
3580                     $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true, $progress);
3581             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'generalfeedback',
3582                     $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true, $progress);
3583             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'answer',
3584                     $oldctxid, $this->task->get_userid(), 'question_answer', null, $newctxid, true, $progress);
3585             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'answerfeedback',
3586                     $oldctxid, $this->task->get_userid(), 'question_answer', null, $newctxid, true, $progress);
3587             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'hint',
3588                     $oldctxid, $this->task->get_userid(), 'question_hint', null, $newctxid, true, $progress);
3589             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'correctfeedback',
3590                     $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true, $progress);
3591             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'partiallycorrectfeedback',
3592                     $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true, $progress);
3593             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'incorrectfeedback',
3594                     $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true, $progress);
3596             // Add qtype dependent files
3597             $components = backup_qtype_plugin::get_components_and_fileareas($question->qtype);
3598             foreach ($components as $component => $fileareas) {
3599                 foreach ($fileareas as $filearea => $mapping) {
3600                     // Use itemid only if mapping is question_created
3601                     $itemid = ($mapping == 'question_created') ? $question->itemid : null;
3602                     restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), $component, $filearea,
3603                             $oldctxid, $this->task->get_userid(), $mapping, $itemid, $newctxid, true, $progress);
3604                 }
3605             }
3606         }
3607         $questionsrs->close();
3608         $progress->end_progress();
3609     }
3613 /**
3614  * Try to restore aliases and references to external files.
3615  *
3616  * The queue of these files was prepared for us in {@link restore_dbops::send_files_to_pool()}.
3617  * We expect that all regular (non-alias) files have already been restored. Make sure
3618  * there is no restore step executed after this one that would call send_files_to_pool() again.
3619  *
3620  * You may notice we have hardcoded support for Server files, Legacy course files
3621  * and user Private files here at the moment. This could be eventually replaced with a set of
3622  * callbacks in the future if needed.
3623  *
3624  * @copyright 2012 David Mudrak <david@moodle.com>
3625  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3626  */
3627 class restore_process_file_aliases_queue extends restore_execution_step {
3629     /** @var array internal cache for {@link choose_repository()} */
3630     private $cachereposbyid = array();
3632     /** @var array internal cache for {@link choose_repository()} */
3633     private $cachereposbytype = array();
3635     /**
3636      * What to do when this step is executed.
3637      */
3638     protected function define_execution() {
3639         global $DB;
3641         $this->log('processing file aliases queue', backup::LOG_DEBUG);
3643         $fs = get_file_storage();
3645         // Load the queue.
3646         $rs = $DB->get_recordset('backup_ids_temp',
3647             array('backupid' => $this->get_restoreid(), 'itemname' => 'file_aliases_queue'),
3648             '', 'info');
3650         // Iterate over aliases in the queue.
3651         foreach ($rs as $record) {
3652             $info = backup_controller_dbops::decode_backup_temp_info($record->info);
3654             // Try to pick a repository instance that should serve the alias.
3655             $repository = $this->choose_repository($info);
3657             if (is_null($repository)) {
3658                 $this->notify_failure($info, 'unable to find a matching repository instance');
3659                 continue;
3660             }
3662             if ($info->oldfile->repositorytype === 'local' or $info->oldfile->repositorytype === 'coursefiles') {
3663                 // Aliases to Server files and Legacy course files may refer to a file
3664                 // contained in the backup file or to some existing file (if we are on the
3665                 // same site).
3666                 try {
3667                     $reference = file_storage::unpack_reference($info->oldfile->reference);
3668                 } catch (Exception $e) {
3669                     $this->notify_failure($info, 'invalid reference field format');
3670                     continue;
3671                 }
3673                 // Let's see if the referred source file was also included in the backup.
3674                 $candidates = $DB->get_recordset('backup_files_temp', array(
3675                         'backupid' => $this->get_restoreid(),
3676                         'contextid' => $reference['contextid'],
3677                         'component' => $reference['component'],
3678                         'filearea' => $reference['filearea'],
3679                         'itemid' => $reference['itemid'],
3680                     ), '', 'info, newcontextid, newitemid');
3682                 $source = null;
3684                 foreach ($candidates as $candidate) {
3685                     $candidateinfo = backup_controller_dbops::decode_backup_temp_info($candidate->info);
3686                     if ($candidateinfo->filename === $reference['filename']
3687                             and $candidateinfo->filepath === $reference['filepath']
3688                             and !is_null($candidate->newcontextid)
3689                             and !is_null($candidate->newitemid) ) {
3690                         $source = $candidateinfo;
3691                         $source->contextid = $candidate->newcontextid;
3692                         $source->itemid = $candidate->newitemid;
3693                         break;
3694                     }
3695                 }
3696                 $candidates->close();
3698                 if ($source) {
3699                     // We have an alias that refers to another file also included in
3700                     // the backup. Let us change the reference field so that it refers
3701                     // to the restored copy of the original file.
3702                     $reference = file_storage::pack_reference($source);
3704                     // Send the new alias to the filepool.
3705                     $fs->create_file_from_reference($info->newfile, $repository->id, $reference);
3706                     $this->notify_success($info);
3707                     continue;
3709                 } else {
3710                     // This is a reference to some moodle file that was not contained in the backup
3711                     // file. If we are restoring to the same site, keep the reference untouched
3712                     // and restore the alias as is if the referenced file exists.
3713                     if ($this->task->is_samesite()) {
3714                         if ($fs->file_exists($reference['contextid'], $reference['component'], $reference['filearea'],
3715                                 $reference['itemid'], $reference['filepath'], $reference['filename'])) {
3716                             $reference = file_storage::pack_reference($reference);
3717                             $fs->create_file_from_reference($info->newfile, $repository->id, $reference);
3718                             $this->notify_success($info);
3719                             continue;
3720                         } else {
3721                             $this->notify_failure($info, 'referenced file not found');
3722                             continue;
3723                         }
3725                     // If we are at other site, we can't restore this alias.
3726                     } else {
3727