Merge branch 'MDL-69401-39' of git://github.com/mihailges/moodle into MOODLE_39_STABLE
[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(strtotime('-1 week'), $progress);      // Delete > 1 week old 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         if ($this->get_courseid() == SITEID) {
93             return false;
94         }
96         // No gradebook info found, don't execute
97         $fullpath = $this->task->get_taskbasepath();
98         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
99         if (!file_exists($fullpath)) {
100             return false;
101         }
103         // Some module present in backup file isn't available to restore
104         // in this site, don't execute
105         if ($this->task->is_missing_modules()) {
106             return false;
107         }
109         // Some activity has been excluded to be restored, don't execute
110         if ($this->task->is_excluding_activities()) {
111             return false;
112         }
114         // There should only be one grade category (the 1 associated with the course itself)
115         // If other categories already exist we're restoring into an existing course.
116         // Restoring categories into a course with an existing category structure is unlikely to go well
117         $category = new stdclass();
118         $category->courseid  = $this->get_courseid();
119         $catcount = $DB->count_records('grade_categories', (array)$category);
120         if ($catcount>1) {
121             return false;
122         }
124         // Identify the backup we're dealing with.
125         $backuprelease = $this->get_task()->get_info()->backup_release; // The major version: 2.9, 3.0, 3.10...
126         $backupbuild = 0;
127         preg_match('/(\d{8})/', $this->get_task()->get_info()->moodle_release, $matches);
128         if (!empty($matches[1])) {
129             $backupbuild = (int) $matches[1]; // The date of Moodle build at the time of the backup.
130         }
132         // On older versions the freeze value has to be converted.
133         // We do this from here as it is happening right before the file is read.
134         // This only targets the backup files that can contain the legacy freeze.
135         if ($backupbuild > 20150618 && (version_compare($backuprelease, '3.0', '<') || $backupbuild < 20160527)) {
136             $this->rewrite_step_backup_file_for_legacy_freeze($fullpath);
137         }
139         // Arrived here, execute the step
140         return true;
141      }
143     protected function define_structure() {
144         $paths = array();
145         $userinfo = $this->task->get_setting_value('users');
147         $paths[] = new restore_path_element('attributes', '/gradebook/attributes');
148         $paths[] = new restore_path_element('grade_category', '/gradebook/grade_categories/grade_category');
149         $paths[] = new restore_path_element('grade_item', '/gradebook/grade_items/grade_item');
150         if ($userinfo) {
151             $paths[] = new restore_path_element('grade_grade', '/gradebook/grade_items/grade_item/grade_grades/grade_grade');
152         }
153         $paths[] = new restore_path_element('grade_letter', '/gradebook/grade_letters/grade_letter');
154         $paths[] = new restore_path_element('grade_setting', '/gradebook/grade_settings/grade_setting');
156         return $paths;
157     }
159     protected function process_attributes($data) {
160         // For non-merge restore types:
161         // Unset 'gradebook_calculations_freeze_' in the course and replace with the one from the backup.
162         $target = $this->get_task()->get_target();
163         if ($target == backup::TARGET_CURRENT_DELETING || $target == backup::TARGET_EXISTING_DELETING) {
164             set_config('gradebook_calculations_freeze_' . $this->get_courseid(), null);
165         }
166         if (!empty($data['calculations_freeze'])) {
167             if ($target == backup::TARGET_NEW_COURSE || $target == backup::TARGET_CURRENT_DELETING ||
168                     $target == backup::TARGET_EXISTING_DELETING) {
169                 set_config('gradebook_calculations_freeze_' . $this->get_courseid(), $data['calculations_freeze']);
170             }
171         }
172     }
174     protected function process_grade_item($data) {
175         global $DB;
177         $data = (object)$data;
179         $oldid = $data->id;
180         $data->course = $this->get_courseid();
182         $data->courseid = $this->get_courseid();
184         if ($data->itemtype=='manual') {
185             // manual grade items store category id in categoryid
186             $data->categoryid = $this->get_mappingid('grade_category', $data->categoryid, NULL);
187             // if mapping failed put in course's grade category
188             if (NULL == $data->categoryid) {
189                 $coursecat = grade_category::fetch_course_category($this->get_courseid());
190                 $data->categoryid = $coursecat->id;
191             }
192         } else if ($data->itemtype=='course') {
193             // course grade item stores their category id in iteminstance
194             $coursecat = grade_category::fetch_course_category($this->get_courseid());
195             $data->iteminstance = $coursecat->id;
196         } else if ($data->itemtype=='category') {
197             // category grade items store their category id in iteminstance
198             $data->iteminstance = $this->get_mappingid('grade_category', $data->iteminstance, NULL);
199         } else {
200             throw new restore_step_exception('unexpected_grade_item_type', $data->itemtype);
201         }
203         $data->scaleid   = $this->get_mappingid('scale', $data->scaleid, NULL);
204         $data->outcomeid = $this->get_mappingid('outcome', $data->outcomeid, NULL);
206         $data->locktime = $this->apply_date_offset($data->locktime);
208         $coursecategory = $newitemid = null;
209         //course grade item should already exist so updating instead of inserting
210         if($data->itemtype=='course') {
211             //get the ID of the already created grade item
212             $gi = new stdclass();
213             $gi->courseid  = $this->get_courseid();
214             $gi->itemtype  = $data->itemtype;
216             //need to get the id of the grade_category that was automatically created for the course
217             $category = new stdclass();
218             $category->courseid  = $this->get_courseid();
219             $category->parent  = null;
220             //course category fullname starts out as ? but may be edited
221             //$category->fullname  = '?';
222             $coursecategory = $DB->get_record('grade_categories', (array)$category);
223             $gi->iteminstance = $coursecategory->id;
225             $existinggradeitem = $DB->get_record('grade_items', (array)$gi);
226             if (!empty($existinggradeitem)) {
227                 $data->id = $newitemid = $existinggradeitem->id;
228                 $DB->update_record('grade_items', $data);
229             }
230         } else if ($data->itemtype == 'manual') {
231             // Manual items aren't assigned to a cm, so don't go duplicating them in the target if one exists.
232             $gi = array(
233                 'itemtype' => $data->itemtype,
234                 'courseid' => $data->courseid,
235                 'itemname' => $data->itemname,
236                 'categoryid' => $data->categoryid,
237             );
238             $newitemid = $DB->get_field('grade_items', 'id', $gi);
239         }
241         if (empty($newitemid)) {
242             //in case we found the course category but still need to insert the course grade item
243             if ($data->itemtype=='course' && !empty($coursecategory)) {
244                 $data->iteminstance = $coursecategory->id;
245             }
247             $newitemid = $DB->insert_record('grade_items', $data);
248             $data->id = $newitemid;
249             $gradeitem = new grade_item($data);
250             core\event\grade_item_created::create_from_grade_item($gradeitem)->trigger();
251         }
252         $this->set_mapping('grade_item', $oldid, $newitemid);
253     }
255     protected function process_grade_grade($data) {
256         global $DB;
258         $data = (object)$data;
259         $oldid = $data->id;
260         $olduserid = $data->userid;
262         $data->itemid = $this->get_new_parentid('grade_item');
264         $data->userid = $this->get_mappingid('user', $data->userid, null);
265         if (!empty($data->userid)) {
266             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
267             $data->locktime     = $this->apply_date_offset($data->locktime);
269             $gradeexists = $DB->record_exists('grade_grades', array('userid' => $data->userid, 'itemid' => $data->itemid));
270             if ($gradeexists) {
271                 $message = "User id '{$data->userid}' already has a grade entry for grade item id '{$data->itemid}'";
272                 $this->log($message, backup::LOG_DEBUG);
273             } else {
274                 $newitemid = $DB->insert_record('grade_grades', $data);
275                 $this->set_mapping('grade_grades', $oldid, $newitemid);
276             }
277         } else {
278             $message = "Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'";
279             $this->log($message, backup::LOG_DEBUG);
280         }
281     }
283     protected function process_grade_category($data) {
284         global $DB;
286         $data = (object)$data;
287         $oldid = $data->id;
289         $data->course = $this->get_courseid();
290         $data->courseid = $data->course;
292         $newitemid = null;
293         //no parent means a course level grade category. That may have been created when the course was created
294         if(empty($data->parent)) {
295             //parent was being saved as 0 when it should be null
296             $data->parent = null;
298             //get the already created course level grade category
299             $category = new stdclass();
300             $category->courseid = $this->get_courseid();
301             $category->parent = null;
303             $coursecategory = $DB->get_record('grade_categories', (array)$category);
304             if (!empty($coursecategory)) {
305                 $data->id = $newitemid = $coursecategory->id;
306                 $DB->update_record('grade_categories', $data);
307             }
308         }
310         // Add a warning about a removed setting.
311         if (!empty($data->aggregatesubcats)) {
312             set_config('show_aggregatesubcats_upgrade_' . $data->courseid, 1);
313         }
315         //need to insert a course category
316         if (empty($newitemid)) {
317             $newitemid = $DB->insert_record('grade_categories', $data);
318         }
319         $this->set_mapping('grade_category', $oldid, $newitemid);
320     }
321     protected function process_grade_letter($data) {
322         global $DB;
324         $data = (object)$data;
325         $oldid = $data->id;
327         $data->contextid = context_course::instance($this->get_courseid())->id;
329         $gradeletter = (array)$data;
330         unset($gradeletter['id']);
331         if (!$DB->record_exists('grade_letters', $gradeletter)) {
332             $newitemid = $DB->insert_record('grade_letters', $data);
333         } else {
334             $newitemid = $data->id;
335         }
337         $this->set_mapping('grade_letter', $oldid, $newitemid);
338     }
339     protected function process_grade_setting($data) {
340         global $DB;
342         $data = (object)$data;
343         $oldid = $data->id;
345         $data->courseid = $this->get_courseid();
347         $target = $this->get_task()->get_target();
348         if ($data->name == 'minmaxtouse' &&
349                 ($target == backup::TARGET_CURRENT_ADDING || $target == backup::TARGET_EXISTING_ADDING)) {
350             // We never restore minmaxtouse during merge.
351             return;
352         }
354         if (!$DB->record_exists('grade_settings', array('courseid' => $data->courseid, 'name' => $data->name))) {
355             $newitemid = $DB->insert_record('grade_settings', $data);
356         } else {
357             $newitemid = $data->id;
358         }
360         if (!empty($oldid)) {
361             // In rare cases (minmaxtouse), it is possible that there wasn't any ID associated with the setting.
362             $this->set_mapping('grade_setting', $oldid, $newitemid);
363         }
364     }
366     /**
367      * put all activity grade items in the correct grade category and mark all for recalculation
368      */
369     protected function after_execute() {
370         global $DB;
372         $conditions = array(
373             'backupid' => $this->get_restoreid(),
374             'itemname' => 'grade_item'//,
375             //'itemid'   => $itemid
376         );
377         $rs = $DB->get_recordset('backup_ids_temp', $conditions);
379         // We need this for calculation magic later on.
380         $mappings = array();
382         if (!empty($rs)) {
383             foreach($rs as $grade_item_backup) {
385                 // Store the oldid with the new id.
386                 $mappings[$grade_item_backup->itemid] = $grade_item_backup->newitemid;
388                 $updateobj = new stdclass();
389                 $updateobj->id = $grade_item_backup->newitemid;
391                 //if this is an activity grade item that needs to be put back in its correct category
392                 if (!empty($grade_item_backup->parentitemid)) {
393                     $oldcategoryid = $this->get_mappingid('grade_category', $grade_item_backup->parentitemid, null);
394                     if (!is_null($oldcategoryid)) {
395                         $updateobj->categoryid = $oldcategoryid;
396                         $DB->update_record('grade_items', $updateobj);
397                     }
398                 } else {
399                     //mark course and category items as needing to be recalculated
400                     $updateobj->needsupdate=1;
401                     $DB->update_record('grade_items', $updateobj);
402                 }
403             }
404         }
405         $rs->close();
407         // We need to update the calculations for calculated grade items that may reference old
408         // grade item ids using ##gi\d+##.
409         // $mappings can be empty, use 0 if so (won't match ever)
410         list($sql, $params) = $DB->get_in_or_equal(array_values($mappings), SQL_PARAMS_NAMED, 'param', true, 0);
411         $sql = "SELECT gi.id, gi.calculation
412                   FROM {grade_items} gi
413                  WHERE gi.id {$sql} AND
414                        calculation IS NOT NULL";
415         $rs = $DB->get_recordset_sql($sql, $params);
416         foreach ($rs as $gradeitem) {
417             // Collect all of the used grade item id references
418             if (preg_match_all('/##gi(\d+)##/', $gradeitem->calculation, $matches) < 1) {
419                 // This calculation doesn't reference any other grade items... EASY!
420                 continue;
421             }
422             // For this next bit we are going to do the replacement of id's in two steps:
423             // 1. We will replace all old id references with a special mapping reference.
424             // 2. We will replace all mapping references with id's
425             // Why do we do this?
426             // Because there potentially there will be an overlap of ids within the query and we
427             // we substitute the wrong id.. safest way around this is the two step system
428             $calculationmap = array();
429             $mapcount = 0;
430             foreach ($matches[1] as $match) {
431                 // Check that the old id is known to us, if not it was broken to begin with and will
432                 // continue to be broken.
433                 if (!array_key_exists($match, $mappings)) {
434                     continue;
435                 }
436                 // Our special mapping key
437                 $mapping = '##MAPPING'.$mapcount.'##';
438                 // The old id that exists within the calculation now
439                 $oldid = '##gi'.$match.'##';
440                 // The new id that we want to replace the old one with.
441                 $newid = '##gi'.$mappings[$match].'##';
442                 // Replace in the special mapping key
443                 $gradeitem->calculation = str_replace($oldid, $mapping, $gradeitem->calculation);
444                 // And record the mapping
445                 $calculationmap[$mapping] = $newid;
446                 $mapcount++;
447             }
448             // Iterate all special mappings for this calculation and replace in the new id's
449             foreach ($calculationmap as $mapping => $newid) {
450                 $gradeitem->calculation = str_replace($mapping, $newid, $gradeitem->calculation);
451             }
452             // Update the calculation now that its being remapped
453             $DB->update_record('grade_items', $gradeitem);
454         }
455         $rs->close();
457         // Need to correct the grade category path and parent
458         $conditions = array(
459             'courseid' => $this->get_courseid()
460         );
462         $rs = $DB->get_recordset('grade_categories', $conditions);
463         // Get all the parents correct first as grade_category::build_path() loads category parents from the DB
464         foreach ($rs as $gc) {
465             if (!empty($gc->parent)) {
466                 $grade_category = new stdClass();
467                 $grade_category->id = $gc->id;
468                 $grade_category->parent = $this->get_mappingid('grade_category', $gc->parent);
469                 $DB->update_record('grade_categories', $grade_category);
470             }
471         }
472         $rs->close();
474         // Now we can rebuild all the paths
475         $rs = $DB->get_recordset('grade_categories', $conditions);
476         foreach ($rs as $gc) {
477             $grade_category = new stdClass();
478             $grade_category->id = $gc->id;
479             $grade_category->path = grade_category::build_path($gc);
480             $grade_category->depth = substr_count($grade_category->path, '/') - 1;
481             $DB->update_record('grade_categories', $grade_category);
482         }
483         $rs->close();
485         // Check what to do with the minmaxtouse setting.
486         $this->check_minmaxtouse();
488         // Freeze gradebook calculations if needed.
489         $this->gradebook_calculation_freeze();
491         // Ensure the module cache is current when recalculating grades.
492         rebuild_course_cache($this->get_courseid(), true);
494         // Restore marks items as needing update. Update everything now.
495         grade_regrade_final_grades($this->get_courseid());
496     }
498     /**
499      * Freeze gradebook calculation if needed.
500      *
501      * This is similar to various upgrade scripts that check if the freeze is needed.
502      */
503     protected function gradebook_calculation_freeze() {
504         global $CFG;
505         $gradebookcalculationsfreeze = get_config('core', 'gradebook_calculations_freeze_' . $this->get_courseid());
506         preg_match('/(\d{8})/', $this->get_task()->get_info()->moodle_release, $matches);
507         $backupbuild = (int)$matches[1];
508         $backuprelease = $this->get_task()->get_info()->backup_release; // The major version: 2.9, 3.0, 3.10...
510         // Extra credits need adjustments only for backups made between 2.8 release (20141110) and the fix release (20150619).
511         if (!$gradebookcalculationsfreeze && $backupbuild >= 20141110 && $backupbuild < 20150619) {
512             require_once($CFG->libdir . '/db/upgradelib.php');
513             upgrade_extra_credit_weightoverride($this->get_courseid());
514         }
515         // Calculated grade items need recalculating for backups made between 2.8 release (20141110) and the fix release (20150627).
516         if (!$gradebookcalculationsfreeze && $backupbuild >= 20141110 && $backupbuild < 20150627) {
517             require_once($CFG->libdir . '/db/upgradelib.php');
518             upgrade_calculated_grade_items($this->get_courseid());
519         }
520         // Courses from before 3.1 (20160518) may have a letter boundary problem and should be checked for this issue.
521         // Backups from before and including 2.9 could have a build number that is greater than 20160518 and should
522         // be checked for this problem.
523         if (!$gradebookcalculationsfreeze && ($backupbuild < 20160518 || version_compare($backuprelease, '2.9', '<='))) {
524             require_once($CFG->libdir . '/db/upgradelib.php');
525             upgrade_course_letter_boundary($this->get_courseid());
526         }
528     }
530     /**
531      * Checks what should happen with the course grade setting minmaxtouse.
532      *
533      * This is related to the upgrade step at the time the setting was added.
534      *
535      * @see MDL-48618
536      * @return void
537      */
538     protected function check_minmaxtouse() {
539         global $CFG, $DB;
540         require_once($CFG->libdir . '/gradelib.php');
542         $userinfo = $this->task->get_setting_value('users');
543         $settingname = 'minmaxtouse';
544         $courseid = $this->get_courseid();
545         $minmaxtouse = $DB->get_field('grade_settings', 'value', array('courseid' => $courseid, 'name' => $settingname));
546         $version28start = 2014111000.00;
547         $version28last = 2014111006.05;
548         $version29start = 2015051100.00;
549         $version29last = 2015060400.02;
551         $target = $this->get_task()->get_target();
552         if ($minmaxtouse === false &&
553                 ($target != backup::TARGET_CURRENT_ADDING && $target != backup::TARGET_EXISTING_ADDING)) {
554             // The setting was not found because this setting did not exist at the time the backup was made.
555             // And we are not restoring as merge, in which case we leave the course as it was.
556             $version = $this->get_task()->get_info()->moodle_version;
558             if ($version < $version28start) {
559                 // We need to set it to use grade_item, but only if the site-wide setting is different. No need to notice them.
560                 if ($CFG->grade_minmaxtouse != GRADE_MIN_MAX_FROM_GRADE_ITEM) {
561                     grade_set_setting($courseid, $settingname, GRADE_MIN_MAX_FROM_GRADE_ITEM);
562                 }
564             } else if (($version >= $version28start && $version < $version28last) ||
565                     ($version >= $version29start && $version < $version29last)) {
566                 // They should be using grade_grade when the course has inconsistencies.
568                 $sql = "SELECT gi.id
569                           FROM {grade_items} gi
570                           JOIN {grade_grades} gg
571                             ON gg.itemid = gi.id
572                          WHERE gi.courseid = ?
573                            AND (gi.itemtype != ? AND gi.itemtype != ?)
574                            AND (gg.rawgrademax != gi.grademax OR gg.rawgrademin != gi.grademin)";
576                 // The course can only have inconsistencies when we restore the user info,
577                 // we do not need to act on existing grades that were not restored as part of this backup.
578                 if ($userinfo && $DB->record_exists_sql($sql, array($courseid, 'course', 'category'))) {
580                     // Display the notice as we do during upgrade.
581                     set_config('show_min_max_grades_changed_' . $courseid, 1);
583                     if ($CFG->grade_minmaxtouse != GRADE_MIN_MAX_FROM_GRADE_GRADE) {
584                         // We need set the setting as their site-wise setting is not GRADE_MIN_MAX_FROM_GRADE_GRADE.
585                         // If they are using the site-wide grade_grade setting, we only want to notice them.
586                         grade_set_setting($courseid, $settingname, GRADE_MIN_MAX_FROM_GRADE_GRADE);
587                     }
588                 }
590             } else {
591                 // This should never happen because from now on minmaxtouse is always saved in backups.
592             }
593         }
594     }
596     /**
597      * Rewrite step definition to handle the legacy freeze attribute.
598      *
599      * In previous backups the calculations_freeze property was stored as an attribute of the
600      * top level node <gradebook>. The backup API, however, do not process grandparent nodes.
601      * It only processes definitive children, and their parent attributes.
602      *
603      * We had:
604      *
605      * <gradebook calculations_freeze="20160511">
606      *   <grade_categories>
607      *     <grade_category id="10">
608      *       <depth>1</depth>
609      *       ...
610      *     </grade_category>
611      *   </grade_categories>
612      *   ...
613      * </gradebook>
614      *
615      * And this method will convert it to:
616      *
617      * <gradebook >
618      *   <attributes>
619      *     <calculations_freeze>20160511</calculations_freeze>
620      *   </attributes>
621      *   <grade_categories>
622      *     <grade_category id="10">
623      *       <depth>1</depth>
624      *       ...
625      *     </grade_category>
626      *   </grade_categories>
627      *   ...
628      * </gradebook>
629      *
630      * Note that we cannot just load the XML file in memory as it could potentially be huge.
631      * We can also completely ignore if the node <attributes> is already in the backup
632      * file as it never existed before.
633      *
634      * @param string $filepath The absolute path to the XML file.
635      * @return void
636      */
637     protected function rewrite_step_backup_file_for_legacy_freeze($filepath) {
638         $foundnode = false;
639         $newfile = make_request_directory(true) . DIRECTORY_SEPARATOR . 'file.xml';
640         $fr = fopen($filepath, 'r');
641         $fw = fopen($newfile, 'w');
642         if ($fr && $fw) {
643             while (($line = fgets($fr, 4096)) !== false) {
644                 if (!$foundnode && strpos($line, '<gradebook ') === 0) {
645                     $foundnode = true;
646                     $matches = array();
647                     $pattern = '@calculations_freeze=.([0-9]+).@';
648                     if (preg_match($pattern, $line, $matches)) {
649                         $freeze = $matches[1];
650                         $line = preg_replace($pattern, '', $line);
651                         $line .= "  <attributes>\n    <calculations_freeze>$freeze</calculations_freeze>\n  </attributes>\n";
652                     }
653                 }
654                 fputs($fw, $line);
655             }
656             if (!feof($fr)) {
657                 throw new restore_step_exception('Error while attempting to rewrite the gradebook step file.');
658             }
659             fclose($fr);
660             fclose($fw);
661             if (!rename($newfile, $filepath)) {
662                 throw new restore_step_exception('Error while attempting to rename the gradebook step file.');
663             }
664         } else {
665             if ($fr) {
666                 fclose($fr);
667             }
668             if ($fw) {
669                 fclose($fw);
670             }
671         }
672     }
676 /**
677  * Step in charge of restoring the grade history of a course.
678  *
679  * The execution conditions are itendical to {@link restore_gradebook_structure_step} because
680  * we do not want to restore the history if the gradebook and its content has not been
681  * restored. At least for now.
682  */
683 class restore_grade_history_structure_step extends restore_structure_step {
685      protected function execute_condition() {
686         global $CFG, $DB;
688         if ($this->get_courseid() == SITEID) {
689             return false;
690         }
692         // No gradebook info found, don't execute.
693         $fullpath = $this->task->get_taskbasepath();
694         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
695         if (!file_exists($fullpath)) {
696             return false;
697         }
699         // Some module present in backup file isn't available to restore in this site, don't execute.
700         if ($this->task->is_missing_modules()) {
701             return false;
702         }
704         // Some activity has been excluded to be restored, don't execute.
705         if ($this->task->is_excluding_activities()) {
706             return false;
707         }
709         // There should only be one grade category (the 1 associated with the course itself).
710         $category = new stdclass();
711         $category->courseid  = $this->get_courseid();
712         $catcount = $DB->count_records('grade_categories', (array)$category);
713         if ($catcount > 1) {
714             return false;
715         }
717         // Arrived here, execute the step.
718         return true;
719      }
721     protected function define_structure() {
722         $paths = array();
724         // Settings to use.
725         $userinfo = $this->get_setting_value('users');
726         $history = $this->get_setting_value('grade_histories');
728         if ($userinfo && $history) {
729             $paths[] = new restore_path_element('grade_grade',
730                '/grade_history/grade_grades/grade_grade');
731         }
733         return $paths;
734     }
736     protected function process_grade_grade($data) {
737         global $DB;
739         $data = (object)($data);
740         $olduserid = $data->userid;
741         unset($data->id);
743         $data->userid = $this->get_mappingid('user', $data->userid, null);
744         if (!empty($data->userid)) {
745             // Do not apply the date offsets as this is history.
746             $data->itemid = $this->get_mappingid('grade_item', $data->itemid);
747             $data->oldid = $this->get_mappingid('grade_grades', $data->oldid);
748             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
749             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
750             $DB->insert_record('grade_grades_history', $data);
751         } else {
752             $message = "Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'";
753             $this->log($message, backup::LOG_DEBUG);
754         }
755     }
759 /**
760  * decode all the interlinks present in restored content
761  * relying 100% in the restore_decode_processor that handles
762  * both the contents to modify and the rules to be applied
763  */
764 class restore_decode_interlinks extends restore_execution_step {
766     protected function define_execution() {
767         // Get the decoder (from the plan)
768         $decoder = $this->task->get_decoder();
769         restore_decode_processor::register_link_decoders($decoder); // Add decoder contents and rules
770         // And launch it, everything will be processed
771         $decoder->execute();
772     }
775 /**
776  * first, ensure that we have no gaps in section numbers
777  * and then, rebuid the course cache
778  */
779 class restore_rebuild_course_cache extends restore_execution_step {
781     protected function define_execution() {
782         global $DB;
784         // Although there is some sort of auto-recovery of missing sections
785         // present in course/formats... here we check that all the sections
786         // from 0 to MAX(section->section) exist, creating them if necessary
787         $maxsection = $DB->get_field('course_sections', 'MAX(section)', array('course' => $this->get_courseid()));
788         // Iterate over all sections
789         for ($i = 0; $i <= $maxsection; $i++) {
790             // If the section $i doesn't exist, create it
791             if (!$DB->record_exists('course_sections', array('course' => $this->get_courseid(), 'section' => $i))) {
792                 $sectionrec = array(
793                     'course' => $this->get_courseid(),
794                     'section' => $i,
795                     'timemodified' => time());
796                 $DB->insert_record('course_sections', $sectionrec); // missing section created
797             }
798         }
800         // Rebuild cache now that all sections are in place
801         rebuild_course_cache($this->get_courseid());
802         cache_helper::purge_by_event('changesincourse');
803         cache_helper::purge_by_event('changesincoursecat');
804     }
807 /**
808  * Review all the tasks having one after_restore method
809  * executing it to perform some final adjustments of information
810  * not available when the task was executed.
811  */
812 class restore_execute_after_restore extends restore_execution_step {
814     protected function define_execution() {
816         // Simply call to the execute_after_restore() method of the task
817         // that always is the restore_final_task
818         $this->task->launch_execute_after_restore();
819     }
823 /**
824  * Review all the (pending) block positions in backup_ids, matching by
825  * contextid, creating positions as needed. This is executed by the
826  * final task, once all the contexts have been created
827  */
828 class restore_review_pending_block_positions extends restore_execution_step {
830     protected function define_execution() {
831         global $DB;
833         // Get all the block_position objects pending to match
834         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
835         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
836         // Process block positions, creating them or accumulating for final step
837         foreach($rs as $posrec) {
838             // Get the complete position object out of the info field.
839             $position = backup_controller_dbops::decode_backup_temp_info($posrec->info);
840             // If position is for one already mapped (known) contextid
841             // process it now, creating the position, else nothing to
842             // do, position finally discarded
843             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
844                 $position->contextid = $newctx->newitemid;
845                 // Create the block position
846                 $DB->insert_record('block_positions', $position);
847             }
848         }
849         $rs->close();
850     }
854 /**
855  * Updates the availability data for course modules and sections.
856  *
857  * Runs after the restore of all course modules, sections, and grade items has
858  * completed. This is necessary in order to update IDs that have changed during
859  * restore.
860  *
861  * @package core_backup
862  * @copyright 2014 The Open University
863  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
864  */
865 class restore_update_availability extends restore_execution_step {
867     protected function define_execution() {
868         global $CFG, $DB;
870         // Note: This code runs even if availability is disabled when restoring.
871         // That will ensure that if you later turn availability on for the site,
872         // there will be no incorrect IDs. (It doesn't take long if the restored
873         // data does not contain any availability information.)
875         // Get modinfo with all data after resetting cache.
876         rebuild_course_cache($this->get_courseid(), true);
877         $modinfo = get_fast_modinfo($this->get_courseid());
879         // Get the date offset for this restore.
880         $dateoffset = $this->apply_date_offset(1) - 1;
882         // Update all sections that were restored.
883         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'course_section');
884         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'newitemid');
885         $sectionsbyid = null;
886         foreach ($rs as $rec) {
887             if (is_null($sectionsbyid)) {
888                 $sectionsbyid = array();
889                 foreach ($modinfo->get_section_info_all() as $section) {
890                     $sectionsbyid[$section->id] = $section;
891                 }
892             }
893             if (!array_key_exists($rec->newitemid, $sectionsbyid)) {
894                 // If the section was not fully restored for some reason
895                 // (e.g. due to an earlier error), skip it.
896                 $this->get_logger()->process('Section not fully restored: id ' .
897                         $rec->newitemid, backup::LOG_WARNING);
898                 continue;
899             }
900             $section = $sectionsbyid[$rec->newitemid];
901             if (!is_null($section->availability)) {
902                 $info = new \core_availability\info_section($section);
903                 $info->update_after_restore($this->get_restoreid(),
904                         $this->get_courseid(), $this->get_logger(), $dateoffset, $this->task);
905             }
906         }
907         $rs->close();
909         // Update all modules that were restored.
910         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'course_module');
911         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'newitemid');
912         foreach ($rs as $rec) {
913             if (!array_key_exists($rec->newitemid, $modinfo->cms)) {
914                 // If the module was not fully restored for some reason
915                 // (e.g. due to an earlier error), skip it.
916                 $this->get_logger()->process('Module not fully restored: id ' .
917                         $rec->newitemid, backup::LOG_WARNING);
918                 continue;
919             }
920             $cm = $modinfo->get_cm($rec->newitemid);
921             if (!is_null($cm->availability)) {
922                 $info = new \core_availability\info_module($cm);
923                 $info->update_after_restore($this->get_restoreid(),
924                         $this->get_courseid(), $this->get_logger(), $dateoffset, $this->task);
925             }
926         }
927         $rs->close();
928     }
932 /**
933  * Process legacy module availability records in backup_ids.
934  *
935  * Matches course modules and grade item id once all them have been already restored.
936  * Only if all matchings are satisfied the availability condition will be created.
937  * At the same time, it is required for the site to have that functionality enabled.
938  *
939  * This step is included only to handle legacy backups (2.6 and before). It does not
940  * do anything for newer backups.
941  *
942  * @copyright 2014 The Open University
943  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
944  */
945 class restore_process_course_modules_availability extends restore_execution_step {
947     protected function define_execution() {
948         global $CFG, $DB;
950         // Site hasn't availability enabled
951         if (empty($CFG->enableavailability)) {
952             return;
953         }
955         // Do both modules and sections.
956         foreach (array('module', 'section') as $table) {
957             // Get all the availability objects to process.
958             $params = array('backupid' => $this->get_restoreid(), 'itemname' => $table . '_availability');
959             $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
960             // Process availabilities, creating them if everything matches ok.
961             foreach ($rs as $availrec) {
962                 $allmatchesok = true;
963                 // Get the complete legacy availability object.
964                 $availability = backup_controller_dbops::decode_backup_temp_info($availrec->info);
966                 // Note: This code used to update IDs, but that is now handled by the
967                 // current code (after restore) instead of this legacy code.
969                 // Get showavailability option.
970                 $thingid = ($table === 'module') ? $availability->coursemoduleid :
971                         $availability->coursesectionid;
972                 $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
973                         $table . '_showavailability', $thingid);
974                 if (!$showrec) {
975                     // Should not happen.
976                     throw new coding_exception('No matching showavailability record');
977                 }
978                 $show = $showrec->info->showavailability;
980                 // The $availability object is now in the format used in the old
981                 // system. Interpret this and convert to new system.
982                 $currentvalue = $DB->get_field('course_' . $table . 's', 'availability',
983                         array('id' => $thingid), MUST_EXIST);
984                 $newvalue = \core_availability\info::add_legacy_availability_condition(
985                         $currentvalue, $availability, $show);
986                 $DB->set_field('course_' . $table . 's', 'availability', $newvalue,
987                         array('id' => $thingid));
988             }
989             $rs->close();
990         }
991     }
995 /*
996  * Execution step that, *conditionally* (if there isn't preloaded information)
997  * will load the inforef files for all the included course/section/activity tasks
998  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
999  */
1000 class restore_load_included_inforef_records extends restore_execution_step {
1002     protected function define_execution() {
1004         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1005             return;
1006         }
1008         // Get all the included tasks
1009         $tasks = restore_dbops::get_included_tasks($this->get_restoreid());
1010         $progress = $this->task->get_progress();
1011         $progress->start_progress($this->get_name(), count($tasks));
1012         foreach ($tasks as $task) {
1013             // Load the inforef.xml file if exists
1014             $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
1015             if (file_exists($inforefpath)) {
1016                 // Load each inforef file to temp_ids.
1017                 restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $inforefpath, $progress);
1018             }
1019         }
1020         $progress->end_progress();
1021     }
1024 /*
1025  * Execution step that will load all the needed files into backup_files_temp
1026  *   - info: contains the whole original object (times, names...)
1027  * (all them being original ids as loaded from xml)
1028  */
1029 class restore_load_included_files extends restore_structure_step {
1031     protected function define_structure() {
1033         $file = new restore_path_element('file', '/files/file');
1035         return array($file);
1036     }
1038     /**
1039      * Process one <file> element from files.xml
1040      *
1041      * @param array $data the element data
1042      */
1043     public function process_file($data) {
1045         $data = (object)$data; // handy
1047         // load it if needed:
1048         //   - it it is one of the annotated inforef files (course/section/activity/block)
1049         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
1050         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
1051         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
1052         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
1053         $iscomponent = ($data->component == 'user' || $data->component == 'group' || $data->component == 'badges' ||
1054                         $data->component == 'grouping' || $data->component == 'grade' ||
1055                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
1056         if ($isfileref || $iscomponent) {
1057             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
1058         }
1059     }
1062 /**
1063  * Execution step that, *conditionally* (if there isn't preloaded information),
1064  * will load all the needed roles to backup_temp_ids. They will be stored with
1065  * "role" itemname. Also it will perform one automatic mapping to roles existing
1066  * in the target site, based in permissions of the user performing the restore,
1067  * archetypes and other bits. At the end, each original role will have its associated
1068  * target role or 0 if it's going to be skipped. Note we wrap everything over one
1069  * restore_dbops method, as far as the same stuff is going to be also executed
1070  * by restore prechecks
1071  */
1072 class restore_load_and_map_roles extends restore_execution_step {
1074     protected function define_execution() {
1075         if ($this->task->get_preloaded_information()) { // if info is already preloaded
1076             return;
1077         }
1079         $file = $this->get_basepath() . '/roles.xml';
1080         // Load needed toles to temp_ids
1081         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
1083         // Process roles, mapping/skipping. Any error throws exception
1084         // Note we pass controller's info because it can contain role mapping information
1085         // about manual mappings performed by UI
1086         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);
1087     }
1090 /**
1091  * Execution step that, *conditionally* (if there isn't preloaded information
1092  * and users have been selected in settings, will load all the needed users
1093  * to backup_temp_ids. They will be stored with "user" itemname and with
1094  * their original contextid as paremitemid
1095  */
1096 class restore_load_included_users extends restore_execution_step {
1098     protected function define_execution() {
1100         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1101             return;
1102         }
1103         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
1104             return;
1105         }
1106         $file = $this->get_basepath() . '/users.xml';
1107         // Load needed users to temp_ids.
1108         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file, $this->task->get_progress());
1109     }
1112 /**
1113  * Execution step that, *conditionally* (if there isn't preloaded information
1114  * and users have been selected in settings, will process all the needed users
1115  * in order to decide and perform any action with them (create / map / error)
1116  * Note: Any error will cause exception, as far as this is the same processing
1117  * than the one into restore prechecks (that should have stopped process earlier)
1118  */
1119 class restore_process_included_users extends restore_execution_step {
1121     protected function define_execution() {
1123         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1124             return;
1125         }
1126         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
1127             return;
1128         }
1129         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(),
1130                 $this->task->get_userid(), $this->task->is_samesite(), $this->task->get_progress());
1131     }
1134 /**
1135  * Execution step that will create all the needed users as calculated
1136  * by @restore_process_included_users (those having newiteind = 0)
1137  */
1138 class restore_create_included_users extends restore_execution_step {
1140     protected function define_execution() {
1142         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(),
1143                 $this->task->get_userid(), $this->task->get_progress());
1144     }
1147 /**
1148  * Structure step that will create all the needed groups and groupings
1149  * by loading them from the groups.xml file performing the required matches.
1150  * Note group members only will be added if restoring user info
1151  */
1152 class restore_groups_structure_step extends restore_structure_step {
1154     protected function define_structure() {
1156         $paths = array(); // Add paths here
1158         // Do not include group/groupings information if not requested.
1159         $groupinfo = $this->get_setting_value('groups');
1160         if ($groupinfo) {
1161             $paths[] = new restore_path_element('group', '/groups/group');
1162             $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
1163             $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
1164         }
1165         return $paths;
1166     }
1168     // Processing functions go here
1169     public function process_group($data) {
1170         global $DB;
1172         $data = (object)$data; // handy
1173         $data->courseid = $this->get_courseid();
1175         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1176         // another a group in the same course
1177         $context = context_course::instance($data->courseid);
1178         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1179             if (groups_get_group_by_idnumber($data->courseid, $data->idnumber)) {
1180                 unset($data->idnumber);
1181             }
1182         } else {
1183             unset($data->idnumber);
1184         }
1186         $oldid = $data->id;    // need this saved for later
1188         $restorefiles = false; // Only if we end creating the group
1190         // Search if the group already exists (by name & description) in the target course
1191         $description_clause = '';
1192         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
1193         if (!empty($data->description)) {
1194             $description_clause = ' AND ' .
1195                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
1196            $params['description'] = $data->description;
1197         }
1198         if (!$groupdb = $DB->get_record_sql("SELECT *
1199                                                FROM {groups}
1200                                               WHERE courseid = :courseid
1201                                                 AND name = :grname $description_clause", $params)) {
1202             // group doesn't exist, create
1203             $newitemid = $DB->insert_record('groups', $data);
1204             $restorefiles = true; // We'll restore the files
1205         } else {
1206             // group exists, use it
1207             $newitemid = $groupdb->id;
1208         }
1209         // Save the id mapping
1210         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
1211         // Invalidate the course group data cache just in case.
1212         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
1213     }
1215     public function process_grouping($data) {
1216         global $DB;
1218         $data = (object)$data; // handy
1219         $data->courseid = $this->get_courseid();
1221         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1222         // another a grouping in the same course
1223         $context = context_course::instance($data->courseid);
1224         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1225             if (groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) {
1226                 unset($data->idnumber);
1227             }
1228         } else {
1229             unset($data->idnumber);
1230         }
1232         $oldid = $data->id;    // need this saved for later
1233         $restorefiles = false; // Only if we end creating the grouping
1235         // Search if the grouping already exists (by name & description) in the target course
1236         $description_clause = '';
1237         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
1238         if (!empty($data->description)) {
1239             $description_clause = ' AND ' .
1240                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
1241            $params['description'] = $data->description;
1242         }
1243         if (!$groupingdb = $DB->get_record_sql("SELECT *
1244                                                   FROM {groupings}
1245                                                  WHERE courseid = :courseid
1246                                                    AND name = :grname $description_clause", $params)) {
1247             // grouping doesn't exist, create
1248             $newitemid = $DB->insert_record('groupings', $data);
1249             $restorefiles = true; // We'll restore the files
1250         } else {
1251             // grouping exists, use it
1252             $newitemid = $groupingdb->id;
1253         }
1254         // Save the id mapping
1255         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
1256         // Invalidate the course group data cache just in case.
1257         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
1258     }
1260     public function process_grouping_group($data) {
1261         global $CFG;
1263         require_once($CFG->dirroot.'/group/lib.php');
1265         $data = (object)$data;
1266         groups_assign_grouping($this->get_new_parentid('grouping'), $this->get_mappingid('group', $data->groupid), $data->timeadded);
1267     }
1269     protected function after_execute() {
1270         // Add group related files, matching with "group" mappings
1271         $this->add_related_files('group', 'icon', 'group');
1272         $this->add_related_files('group', 'description', 'group');
1273         // Add grouping related files, matching with "grouping" mappings
1274         $this->add_related_files('grouping', 'description', 'grouping');
1275         // Invalidate the course group data.
1276         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($this->get_courseid()));
1277     }
1281 /**
1282  * Structure step that will create all the needed group memberships
1283  * by loading them from the groups.xml file performing the required matches.
1284  */
1285 class restore_groups_members_structure_step extends restore_structure_step {
1287     protected $plugins = null;
1289     protected function define_structure() {
1291         $paths = array(); // Add paths here
1293         if ($this->get_setting_value('groups') && $this->get_setting_value('users')) {
1294             $paths[] = new restore_path_element('group', '/groups/group');
1295             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
1296         }
1298         return $paths;
1299     }
1301     public function process_group($data) {
1302         $data = (object)$data; // handy
1304         // HACK ALERT!
1305         // Not much to do here, this groups mapping should be already done from restore_groups_structure_step.
1306         // Let's fake internal state to make $this->get_new_parentid('group') work.
1308         $this->set_mapping('group', $data->id, $this->get_mappingid('group', $data->id));
1309     }
1311     public function process_member($data) {
1312         global $DB, $CFG;
1313         require_once("$CFG->dirroot/group/lib.php");
1315         // NOTE: Always use groups_add_member() because it triggers events and verifies if user is enrolled.
1317         $data = (object)$data; // handy
1319         // get parent group->id
1320         $data->groupid = $this->get_new_parentid('group');
1322         // map user newitemid and insert if not member already
1323         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
1324             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
1325                 // Check the component, if any, exists.
1326                 if (empty($data->component)) {
1327                     groups_add_member($data->groupid, $data->userid);
1329                 } else if ((strpos($data->component, 'enrol_') === 0)) {
1330                     // Deal with enrolment groups - ignore the component and just find out the instance via new id,
1331                     // it is possible that enrolment was restored using different plugin type.
1332                     if (!isset($this->plugins)) {
1333                         $this->plugins = enrol_get_plugins(true);
1334                     }
1335                     if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1336                         if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1337                             if (isset($this->plugins[$instance->enrol])) {
1338                                 $this->plugins[$instance->enrol]->restore_group_member($instance, $data->groupid, $data->userid);
1339                             }
1340                         }
1341                     }
1343                 } else {
1344                     $dir = core_component::get_component_directory($data->component);
1345                     if ($dir and is_dir($dir)) {
1346                         if (component_callback($data->component, 'restore_group_member', array($this, $data), true)) {
1347                             return;
1348                         }
1349                     }
1350                     // Bad luck, plugin could not restore the data, let's add normal membership.
1351                     groups_add_member($data->groupid, $data->userid);
1352                     $message = "Restore of '$data->component/$data->itemid' group membership is not supported, using standard group membership instead.";
1353                     $this->log($message, backup::LOG_WARNING);
1354                 }
1355             }
1356         }
1357     }
1360 /**
1361  * Structure step that will create all the needed scales
1362  * by loading them from the scales.xml
1363  */
1364 class restore_scales_structure_step extends restore_structure_step {
1366     protected function define_structure() {
1368         $paths = array(); // Add paths here
1369         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
1370         return $paths;
1371     }
1373     protected function process_scale($data) {
1374         global $DB;
1376         $data = (object)$data;
1378         $restorefiles = false; // Only if we end creating the group
1380         $oldid = $data->id;    // need this saved for later
1382         // Look for scale (by 'scale' both in standard (course=0) and current course
1383         // with priority to standard scales (ORDER clause)
1384         // scale is not course unique, use get_record_sql to suppress warning
1385         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
1386         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
1387         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
1388         if (!$scadb = $DB->get_record_sql("SELECT *
1389                                             FROM {scale}
1390                                            WHERE courseid IN (0, :courseid)
1391                                              AND $compare_scale_clause
1392                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
1393             // Remap the user if possible, defaut to user performing the restore if not
1394             $userid = $this->get_mappingid('user', $data->userid);
1395             $data->userid = $userid ? $userid : $this->task->get_userid();
1396             // Remap the course if course scale
1397             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
1398             // If global scale (course=0), check the user has perms to create it
1399             // falling to course scale if not
1400             $systemctx = context_system::instance();
1401             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
1402                 $data->courseid = $this->get_courseid();
1403             }
1404             // scale doesn't exist, create
1405             $newitemid = $DB->insert_record('scale', $data);
1406             $restorefiles = true; // We'll restore the files
1407         } else {
1408             // scale exists, use it
1409             $newitemid = $scadb->id;
1410         }
1411         // Save the id mapping (with files support at system context)
1412         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1413     }
1415     protected function after_execute() {
1416         // Add scales related files, matching with "scale" mappings
1417         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
1418     }
1422 /**
1423  * Structure step that will create all the needed outocomes
1424  * by loading them from the outcomes.xml
1425  */
1426 class restore_outcomes_structure_step extends restore_structure_step {
1428     protected function define_structure() {
1430         $paths = array(); // Add paths here
1431         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
1432         return $paths;
1433     }
1435     protected function process_outcome($data) {
1436         global $DB;
1438         $data = (object)$data;
1440         $restorefiles = false; // Only if we end creating the group
1442         $oldid = $data->id;    // need this saved for later
1444         // Look for outcome (by shortname both in standard (courseid=null) and current course
1445         // with priority to standard outcomes (ORDER clause)
1446         // outcome is not course unique, use get_record_sql to suppress warning
1447         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
1448         if (!$outdb = $DB->get_record_sql('SELECT *
1449                                              FROM {grade_outcomes}
1450                                             WHERE shortname = :shortname
1451                                               AND (courseid = :courseid OR courseid IS NULL)
1452                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
1453             // Remap the user
1454             $userid = $this->get_mappingid('user', $data->usermodified);
1455             $data->usermodified = $userid ? $userid : $this->task->get_userid();
1456             // Remap the scale
1457             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
1458             // Remap the course if course outcome
1459             $data->courseid = $data->courseid ? $this->get_courseid() : null;
1460             // If global outcome (course=null), check the user has perms to create it
1461             // falling to course outcome if not
1462             $systemctx = context_system::instance();
1463             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
1464                 $data->courseid = $this->get_courseid();
1465             }
1466             // outcome doesn't exist, create
1467             $newitemid = $DB->insert_record('grade_outcomes', $data);
1468             $restorefiles = true; // We'll restore the files
1469         } else {
1470             // scale exists, use it
1471             $newitemid = $outdb->id;
1472         }
1473         // Set the corresponding grade_outcomes_courses record
1474         $outcourserec = new stdclass();
1475         $outcourserec->courseid  = $this->get_courseid();
1476         $outcourserec->outcomeid = $newitemid;
1477         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
1478             $DB->insert_record('grade_outcomes_courses', $outcourserec);
1479         }
1480         // Save the id mapping (with files support at system context)
1481         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1482     }
1484     protected function after_execute() {
1485         // Add outcomes related files, matching with "outcome" mappings
1486         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
1487     }
1490 /**
1491  * Execution step that, *conditionally* (if there isn't preloaded information
1492  * will load all the question categories and questions (header info only)
1493  * to backup_temp_ids. They will be stored with "question_category" and
1494  * "question" itemnames and with their original contextid and question category
1495  * id as paremitemids
1496  */
1497 class restore_load_categories_and_questions extends restore_execution_step {
1499     protected function define_execution() {
1501         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1502             return;
1503         }
1504         $file = $this->get_basepath() . '/questions.xml';
1505         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
1506     }
1509 /**
1510  * Execution step that, *conditionally* (if there isn't preloaded information)
1511  * will process all the needed categories and questions
1512  * in order to decide and perform any action with them (create / map / error)
1513  * Note: Any error will cause exception, as far as this is the same processing
1514  * than the one into restore prechecks (that should have stopped process earlier)
1515  */
1516 class restore_process_categories_and_questions extends restore_execution_step {
1518     protected function define_execution() {
1520         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1521             return;
1522         }
1523         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
1524     }
1527 /**
1528  * Structure step that will read the section.xml creating/updating sections
1529  * as needed, rebuilding course cache and other friends
1530  */
1531 class restore_section_structure_step extends restore_structure_step {
1532     /** @var array Cache: Array of id => course format */
1533     private static $courseformats = array();
1535     /**
1536      * Resets a static cache of course formats. Required for unit testing.
1537      */
1538     public static function reset_caches() {
1539         self::$courseformats = array();
1540     }
1542     protected function define_structure() {
1543         global $CFG;
1545         $paths = array();
1547         $section = new restore_path_element('section', '/section');
1548         $paths[] = $section;
1549         if ($CFG->enableavailability) {
1550             $paths[] = new restore_path_element('availability', '/section/availability');
1551             $paths[] = new restore_path_element('availability_field', '/section/availability_field');
1552         }
1553         $paths[] = new restore_path_element('course_format_options', '/section/course_format_options');
1555         // Apply for 'format' plugins optional paths at section level
1556         $this->add_plugin_structure('format', $section);
1558         // Apply for 'local' plugins optional paths at section level
1559         $this->add_plugin_structure('local', $section);
1561         return $paths;
1562     }
1564     public function process_section($data) {
1565         global $CFG, $DB;
1566         $data = (object)$data;
1567         $oldid = $data->id; // We'll need this later
1569         $restorefiles = false;
1571         // Look for the section
1572         $section = new stdclass();
1573         $section->course  = $this->get_courseid();
1574         $section->section = $data->number;
1575         $section->timemodified = $data->timemodified ?? 0;
1576         // Section doesn't exist, create it with all the info from backup
1577         if (!$secrec = $DB->get_record('course_sections', ['course' => $this->get_courseid(), 'section' => $data->number])) {
1578             $section->name = $data->name;
1579             $section->summary = $data->summary;
1580             $section->summaryformat = $data->summaryformat;
1581             $section->sequence = '';
1582             $section->visible = $data->visible;
1583             if (empty($CFG->enableavailability)) { // Process availability information only if enabled.
1584                 $section->availability = null;
1585             } else {
1586                 $section->availability = isset($data->availabilityjson) ? $data->availabilityjson : null;
1587                 // Include legacy [<2.7] availability data if provided.
1588                 if (is_null($section->availability)) {
1589                     $section->availability = \core_availability\info::convert_legacy_fields(
1590                             $data, true);
1591                 }
1592             }
1593             $newitemid = $DB->insert_record('course_sections', $section);
1594             $section->id = $newitemid;
1596             core\event\course_section_created::create_from_section($section)->trigger();
1598             $restorefiles = true;
1600         // Section exists, update non-empty information
1601         } else {
1602             $section->id = $secrec->id;
1603             if ((string)$secrec->name === '') {
1604                 $section->name = $data->name;
1605             }
1606             if (empty($secrec->summary)) {
1607                 $section->summary = $data->summary;
1608                 $section->summaryformat = $data->summaryformat;
1609                 $restorefiles = true;
1610             }
1612             // Don't update availability (I didn't see a useful way to define
1613             // whether existing or new one should take precedence).
1615             $DB->update_record('course_sections', $section);
1616             $newitemid = $secrec->id;
1618             // Trigger an event for course section update.
1619             $event = \core\event\course_section_updated::create(
1620                 array(
1621                     'objectid' => $section->id,
1622                     'courseid' => $section->course,
1623                     'context' => context_course::instance($section->course),
1624                     'other' => array('sectionnum' => $section->section)
1625                 )
1626             );
1627             $event->trigger();
1628         }
1630         // Annotate the section mapping, with restorefiles option if needed
1631         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
1633         // set the new course_section id in the task
1634         $this->task->set_sectionid($newitemid);
1636         // If there is the legacy showavailability data, store this for later use.
1637         // (This data is not present when restoring 'new' backups.)
1638         if (isset($data->showavailability)) {
1639             // Cache the showavailability flag using the backup_ids data field.
1640             restore_dbops::set_backup_ids_record($this->get_restoreid(),
1641                     'section_showavailability', $newitemid, 0, null,
1642                     (object)array('showavailability' => $data->showavailability));
1643         }
1645         // Commented out. We never modify course->numsections as far as that is used
1646         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
1647         // Note: We keep the code here, to know about and because of the possibility of making this
1648         // optional based on some setting/attribute in the future
1649         // If needed, adjust course->numsections
1650         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
1651         //    if ($numsections < $section->section) {
1652         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
1653         //    }
1654         //}
1655     }
1657     /**
1658      * Process the legacy availability table record. This table does not exist
1659      * in Moodle 2.7+ but we still support restore.
1660      *
1661      * @param stdClass $data Record data
1662      */
1663     public function process_availability($data) {
1664         $data = (object)$data;
1665         // Simply going to store the whole availability record now, we'll process
1666         // all them later in the final task (once all activities have been restored)
1667         // Let's call the low level one to be able to store the whole object.
1668         $data->coursesectionid = $this->task->get_sectionid();
1669         restore_dbops::set_backup_ids_record($this->get_restoreid(),
1670                 'section_availability', $data->id, 0, null, $data);
1671     }
1673     /**
1674      * Process the legacy availability fields table record. This table does not
1675      * exist in Moodle 2.7+ but we still support restore.
1676      *
1677      * @param stdClass $data Record data
1678      */
1679     public function process_availability_field($data) {
1680         global $DB;
1681         $data = (object)$data;
1682         // Mark it is as passed by default
1683         $passed = true;
1684         $customfieldid = null;
1686         // If a customfield has been used in order to pass we must be able to match an existing
1687         // customfield by name (data->customfield) and type (data->customfieldtype)
1688         if (is_null($data->customfield) xor is_null($data->customfieldtype)) {
1689             // xor is sort of uncommon. If either customfield is null or customfieldtype is null BUT not both.
1690             // If one is null but the other isn't something clearly went wrong and we'll skip this condition.
1691             $passed = false;
1692         } else if (!is_null($data->customfield)) {
1693             $params = array('shortname' => $data->customfield, 'datatype' => $data->customfieldtype);
1694             $customfieldid = $DB->get_field('user_info_field', 'id', $params);
1695             $passed = ($customfieldid !== false);
1696         }
1698         if ($passed) {
1699             // Create the object to insert into the database
1700             $availfield = new stdClass();
1701             $availfield->coursesectionid = $this->task->get_sectionid();
1702             $availfield->userfield = $data->userfield;
1703             $availfield->customfieldid = $customfieldid;
1704             $availfield->operator = $data->operator;
1705             $availfield->value = $data->value;
1707             // Get showavailability option.
1708             $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
1709                     'section_showavailability', $availfield->coursesectionid);
1710             if (!$showrec) {
1711                 // Should not happen.
1712                 throw new coding_exception('No matching showavailability record');
1713             }
1714             $show = $showrec->info->showavailability;
1716             // The $availfield object is now in the format used in the old
1717             // system. Interpret this and convert to new system.
1718             $currentvalue = $DB->get_field('course_sections', 'availability',
1719                     array('id' => $availfield->coursesectionid), MUST_EXIST);
1720             $newvalue = \core_availability\info::add_legacy_availability_field_condition(
1721                     $currentvalue, $availfield, $show);
1723             $section = new stdClass();
1724             $section->id = $availfield->coursesectionid;
1725             $section->availability = $newvalue;
1726             $section->timemodified = time();
1727             $DB->update_record('course_sections', $section);
1728         }
1729     }
1731     public function process_course_format_options($data) {
1732         global $DB;
1733         $courseid = $this->get_courseid();
1734         if (!array_key_exists($courseid, self::$courseformats)) {
1735             // It is safe to have a static cache of course formats because format can not be changed after this point.
1736             self::$courseformats[$courseid] = $DB->get_field('course', 'format', array('id' => $courseid));
1737         }
1738         $data = (array)$data;
1739         if (self::$courseformats[$courseid] === $data['format']) {
1740             // Import section format options only if both courses (the one that was backed up
1741             // and the one we are restoring into) have same formats.
1742             $params = array(
1743                 'courseid' => $this->get_courseid(),
1744                 'sectionid' => $this->task->get_sectionid(),
1745                 'format' => $data['format'],
1746                 'name' => $data['name']
1747             );
1748             if ($record = $DB->get_record('course_format_options', $params, 'id, value')) {
1749                 // Do not overwrite existing information.
1750                 $newid = $record->id;
1751             } else {
1752                 $params['value'] = $data['value'];
1753                 $newid = $DB->insert_record('course_format_options', $params);
1754             }
1755             $this->set_mapping('course_format_options', $data['id'], $newid);
1756         }
1757     }
1759     protected function after_execute() {
1760         // Add section related files, with 'course_section' itemid to match
1761         $this->add_related_files('course', 'section', 'course_section');
1762     }
1765 /**
1766  * Structure step that will read the course.xml file, loading it and performing
1767  * various actions depending of the site/restore settings. Note that target
1768  * course always exist before arriving here so this step will be updating
1769  * the course record (never inserting)
1770  */
1771 class restore_course_structure_step extends restore_structure_step {
1772     /**
1773      * @var bool this gets set to true by {@link process_course()} if we are
1774      * restoring an old coures that used the legacy 'module security' feature.
1775      * If so, we have to do more work in {@link after_execute()}.
1776      */
1777     protected $legacyrestrictmodules = false;
1779     /**
1780      * @var array Used when {@link $legacyrestrictmodules} is true. This is an
1781      * array with array keys the module names ('forum', 'quiz', etc.). These are
1782      * the modules that are allowed according to the data in the backup file.
1783      * In {@link after_execute()} we then have to prevent adding of all the other
1784      * types of activity.
1785      */
1786     protected $legacyallowedmodules = array();
1788     protected function define_structure() {
1790         $course = new restore_path_element('course', '/course');
1791         $category = new restore_path_element('category', '/course/category');
1792         $tag = new restore_path_element('tag', '/course/tags/tag');
1793         $customfield = new restore_path_element('customfield', '/course/customfields/customfield');
1794         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1796         // Apply for 'format' plugins optional paths at course level
1797         $this->add_plugin_structure('format', $course);
1799         // Apply for 'theme' plugins optional paths at course level
1800         $this->add_plugin_structure('theme', $course);
1802         // Apply for 'report' plugins optional paths at course level
1803         $this->add_plugin_structure('report', $course);
1805         // Apply for 'course report' plugins optional paths at course level
1806         $this->add_plugin_structure('coursereport', $course);
1808         // Apply for plagiarism plugins optional paths at course level
1809         $this->add_plugin_structure('plagiarism', $course);
1811         // Apply for local plugins optional paths at course level
1812         $this->add_plugin_structure('local', $course);
1814         // Apply for admin tool plugins optional paths at course level.
1815         $this->add_plugin_structure('tool', $course);
1817         return array($course, $category, $tag, $customfield, $allowed_module);
1818     }
1820     /**
1821      * Processing functions go here
1822      *
1823      * @global moodledatabase $DB
1824      * @param stdClass $data
1825      */
1826     public function process_course($data) {
1827         global $CFG, $DB;
1828         $context = context::instance_by_id($this->task->get_contextid());
1829         $userid = $this->task->get_userid();
1830         $target = $this->get_task()->get_target();
1831         $isnewcourse = $target == backup::TARGET_NEW_COURSE;
1833         // When restoring to a new course we can set all the things except for the ID number.
1834         $canchangeidnumber = $isnewcourse || has_capability('moodle/course:changeidnumber', $context, $userid);
1835         $canchangesummary = $isnewcourse || has_capability('moodle/course:changesummary', $context, $userid);
1836         $canforcelanguage = has_capability('moodle/course:setforcedlanguage', $context, $userid);
1838         $data = (object)$data;
1839         $data->id = $this->get_courseid();
1841         // Calculate final course names, to avoid dupes.
1842         $fullname  = $this->get_setting_value('course_fullname');
1843         $shortname = $this->get_setting_value('course_shortname');
1844         list($data->fullname, $data->shortname) = restore_dbops::calculate_course_names($this->get_courseid(),
1845             $fullname === false ? $data->fullname : $fullname,
1846             $shortname === false ? $data->shortname : $shortname);
1847         // Do not modify the course names at all when merging and user selected to keep the names (or prohibited by cap).
1848         if (!$isnewcourse && $fullname === false) {
1849             unset($data->fullname);
1850         }
1851         if (!$isnewcourse && $shortname === false) {
1852             unset($data->shortname);
1853         }
1855         // Unset summary if user can't change it.
1856         if (!$canchangesummary) {
1857             unset($data->summary);
1858             unset($data->summaryformat);
1859         }
1861         // Unset lang if user can't change it.
1862         if (!$canforcelanguage) {
1863             unset($data->lang);
1864         }
1866         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1867         // another course on this site.
1868         if (!empty($data->idnumber) && $canchangeidnumber && $this->task->is_samesite()
1869                 && !$DB->record_exists('course', array('idnumber' => $data->idnumber))) {
1870             // Do not reset idnumber.
1872         } else if (!$isnewcourse) {
1873             // Prevent override when restoring as merge.
1874             unset($data->idnumber);
1876         } else {
1877             $data->idnumber = '';
1878         }
1880         // Any empty value for course->hiddensections will lead to 0 (default, show collapsed).
1881         // It has been reported that some old 1.9 courses may have it null leading to DB error. MDL-31532
1882         if (empty($data->hiddensections)) {
1883             $data->hiddensections = 0;
1884         }
1886         // Set legacyrestrictmodules to true if the course was resticting modules. If so
1887         // then we will need to process restricted modules after execution.
1888         $this->legacyrestrictmodules = !empty($data->restrictmodules);
1890         $data->startdate= $this->apply_date_offset($data->startdate);
1891         if (isset($data->enddate)) {
1892             $data->enddate = $this->apply_date_offset($data->enddate);
1893         }
1895         if ($data->defaultgroupingid) {
1896             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1897         }
1898         if (empty($CFG->enablecompletion)) {
1899             $data->enablecompletion = 0;
1900             $data->completionstartonenrol = 0;
1901             $data->completionnotify = 0;
1902         }
1903         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1904         if (isset($data->lang) && !array_key_exists($data->lang, $languages)) {
1905             $data->lang = '';
1906         }
1908         $themes = get_list_of_themes(); // Get themes for quick search later
1909         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1910             $data->theme = '';
1911         }
1913         // Check if this is an old SCORM course format.
1914         if ($data->format == 'scorm') {
1915             $data->format = 'singleactivity';
1916             $data->activitytype = 'scorm';
1917         }
1919         // Course record ready, update it
1920         $DB->update_record('course', $data);
1922         course_get_format($data)->update_course_format_options($data);
1924         // Role name aliases
1925         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1926     }
1928     public function process_category($data) {
1929         // Nothing to do with the category. UI sets it before restore starts
1930     }
1932     public function process_tag($data) {
1933         global $CFG, $DB;
1935         $data = (object)$data;
1937         core_tag_tag::add_item_tag('core', 'course', $this->get_courseid(),
1938                 context_course::instance($this->get_courseid()), $data->rawname);
1939     }
1941     /**
1942      * Process custom fields
1943      *
1944      * @param array $data
1945      */
1946     public function process_customfield($data) {
1947         $handler = core_course\customfield\course_handler::create();
1948         $handler->restore_instance_data_from_backup($this->task, $data);
1949     }
1951     public function process_allowed_module($data) {
1952         $data = (object)$data;
1954         // Backwards compatiblity support for the data that used to be in the
1955         // course_allowed_modules table.
1956         if ($this->legacyrestrictmodules) {
1957             $this->legacyallowedmodules[$data->modulename] = 1;
1958         }
1959     }
1961     protected function after_execute() {
1962         global $DB;
1964         // Add course related files, without itemid to match
1965         $this->add_related_files('course', 'summary', null);
1966         $this->add_related_files('course', 'overviewfiles', null);
1968         // Deal with legacy allowed modules.
1969         if ($this->legacyrestrictmodules) {
1970             $context = context_course::instance($this->get_courseid());
1972             list($roleids) = get_roles_with_cap_in_context($context, 'moodle/course:manageactivities');
1973             list($managerroleids) = get_roles_with_cap_in_context($context, 'moodle/site:config');
1974             foreach ($managerroleids as $roleid) {
1975                 unset($roleids[$roleid]);
1976             }
1978             foreach (core_component::get_plugin_list('mod') as $modname => $notused) {
1979                 if (isset($this->legacyallowedmodules[$modname])) {
1980                     // Module is allowed, no worries.
1981                     continue;
1982                 }
1984                 $capability = 'mod/' . $modname . ':addinstance';
1986                 if (!get_capability_info($capability)) {
1987                     $this->log("Capability '{$capability}' was not found!", backup::LOG_WARNING);
1988                     continue;
1989                 }
1991                 foreach ($roleids as $roleid) {
1992                     assign_capability($capability, CAP_PREVENT, $roleid, $context);
1993                 }
1994             }
1995         }
1996     }
1999 /**
2000  * Execution step that will migrate legacy files if present.
2001  */
2002 class restore_course_legacy_files_step extends restore_execution_step {
2003     public function define_execution() {
2004         global $DB;
2006         // Do a check for legacy files and skip if there are none.
2007         $sql = 'SELECT count(*)
2008                   FROM {backup_files_temp}
2009                  WHERE backupid = ?
2010                    AND contextid = ?
2011                    AND component = ?
2012                    AND filearea  = ?';
2013         $params = array($this->get_restoreid(), $this->task->get_old_contextid(), 'course', 'legacy');
2015         if ($DB->count_records_sql($sql, $params)) {
2016             $DB->set_field('course', 'legacyfiles', 2, array('id' => $this->get_courseid()));
2017             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'course',
2018                 'legacy', $this->task->get_old_contextid(), $this->task->get_userid());
2019         }
2020     }
2023 /*
2024  * Structure step that will read the roles.xml file (at course/activity/block levels)
2025  * containing all the role_assignments and overrides for that context. If corresponding to
2026  * one mapped role, they will be applied to target context. Will observe the role_assignments
2027  * setting to decide if ras are restored.
2028  *
2029  * Note: this needs to be executed after all users are enrolled.
2030  */
2031 class restore_ras_and_caps_structure_step extends restore_structure_step {
2032     protected $plugins = null;
2034     protected function define_structure() {
2036         $paths = array();
2038         // Observe the role_assignments setting
2039         if ($this->get_setting_value('role_assignments')) {
2040             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
2041         }
2042         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
2044         return $paths;
2045     }
2047     /**
2048      * Assign roles
2049      *
2050      * This has to be called after enrolments processing.
2051      *
2052      * @param mixed $data
2053      * @return void
2054      */
2055     public function process_assignment($data) {
2056         global $DB;
2058         $data = (object)$data;
2060         // Check roleid, userid are one of the mapped ones
2061         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
2062             return;
2063         }
2064         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
2065             return;
2066         }
2067         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
2068             // Only assign roles to not deleted users
2069             return;
2070         }
2071         if (!$contextid = $this->task->get_contextid()) {
2072             return;
2073         }
2075         if (empty($data->component)) {
2076             // assign standard manual roles
2077             // TODO: role_assign() needs one userid param to be able to specify our restore userid
2078             role_assign($newroleid, $newuserid, $contextid);
2080         } else if ((strpos($data->component, 'enrol_') === 0)) {
2081             // Deal with enrolment roles - ignore the component and just find out the instance via new id,
2082             // it is possible that enrolment was restored using different plugin type.
2083             if (!isset($this->plugins)) {
2084                 $this->plugins = enrol_get_plugins(true);
2085             }
2086             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
2087                 if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
2088                     if (isset($this->plugins[$instance->enrol])) {
2089                         $this->plugins[$instance->enrol]->restore_role_assignment($instance, $newroleid, $newuserid, $contextid);
2090                     }
2091                 }
2092             }
2094         } else {
2095             $data->roleid    = $newroleid;
2096             $data->userid    = $newuserid;
2097             $data->contextid = $contextid;
2098             $dir = core_component::get_component_directory($data->component);
2099             if ($dir and is_dir($dir)) {
2100                 if (component_callback($data->component, 'restore_role_assignment', array($this, $data), true)) {
2101                     return;
2102                 }
2103             }
2104             // Bad luck, plugin could not restore the data, let's add normal membership.
2105             role_assign($data->roleid, $data->userid, $data->contextid);
2106             $message = "Restore of '$data->component/$data->itemid' role assignments is not supported, using manual role assignments instead.";
2107             $this->log($message, backup::LOG_WARNING);
2108         }
2109     }
2111     public function process_override($data) {
2112         $data = (object)$data;
2114         // Check roleid is one of the mapped ones
2115         $newroleid = $this->get_mappingid('role', $data->roleid);
2116         // If newroleid and context are valid assign it via API (it handles dupes and so on)
2117         if ($newroleid && $this->task->get_contextid()) {
2118             if (!get_capability_info($data->capability)) {
2119                 $this->log("Capability '{$data->capability}' was not found!", backup::LOG_WARNING);
2120             } else {
2121                 // TODO: assign_capability() needs one userid param to be able to specify our restore userid.
2122                 assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
2123             }
2124         }
2125     }
2128 /**
2129  * If no instances yet add default enrol methods the same way as when creating new course in UI.
2130  */
2131 class restore_default_enrolments_step extends restore_execution_step {
2133     public function define_execution() {
2134         global $DB;
2136         // No enrolments in front page.
2137         if ($this->get_courseid() == SITEID) {
2138             return;
2139         }
2141         $course = $DB->get_record('course', array('id'=>$this->get_courseid()), '*', MUST_EXIST);
2143         if ($DB->record_exists('enrol', array('courseid'=>$this->get_courseid(), 'enrol'=>'manual'))) {
2144             // Something already added instances, do not add default instances.
2145             $plugins = enrol_get_plugins(true);
2146             foreach ($plugins as $plugin) {
2147                 $plugin->restore_sync_course($course);
2148             }
2150         } else {
2151             // Looks like a newly created course.
2152             enrol_course_updated(true, $course, null);
2153         }
2154     }
2157 /**
2158  * This structure steps restores the enrol plugins and their underlying
2159  * enrolments, performing all the mappings and/or movements required
2160  */
2161 class restore_enrolments_structure_step extends restore_structure_step {
2162     protected $enrolsynced = false;
2163     protected $plugins = null;
2164     protected $originalstatus = array();
2166     /**
2167      * Conditionally decide if this step should be executed.
2168      *
2169      * This function checks the following parameter:
2170      *
2171      *   1. the course/enrolments.xml file exists
2172      *
2173      * @return bool true is safe to execute, false otherwise
2174      */
2175     protected function execute_condition() {
2177         if ($this->get_courseid() == SITEID) {
2178             return false;
2179         }
2181         // Check it is included in the backup
2182         $fullpath = $this->task->get_taskbasepath();
2183         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2184         if (!file_exists($fullpath)) {
2185             // Not found, can't restore enrolments info
2186             return false;
2187         }
2189         return true;
2190     }
2192     protected function define_structure() {
2194         $userinfo = $this->get_setting_value('users');
2196         $paths = [];
2197         $paths[] = $enrol = new restore_path_element('enrol', '/enrolments/enrols/enrol');
2198         if ($userinfo) {
2199             $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
2200         }
2201         // Attach local plugin stucture to enrol element.
2202         $this->add_plugin_structure('enrol', $enrol);
2204         return $paths;
2205     }
2207     /**
2208      * Create enrolment instances.
2209      *
2210      * This has to be called after creation of roles
2211      * and before adding of role assignments.
2212      *
2213      * @param mixed $data
2214      * @return void
2215      */
2216     public function process_enrol($data) {
2217         global $DB;
2219         $data = (object)$data;
2220         $oldid = $data->id; // We'll need this later.
2221         unset($data->id);
2223         $this->originalstatus[$oldid] = $data->status;
2225         if (!$courserec = $DB->get_record('course', array('id' => $this->get_courseid()))) {
2226             $this->set_mapping('enrol', $oldid, 0);
2227             return;
2228         }
2230         if (!isset($this->plugins)) {
2231             $this->plugins = enrol_get_plugins(true);
2232         }
2234         if (!$this->enrolsynced) {
2235             // Make sure that all plugin may create instances and enrolments automatically
2236             // before the first instance restore - this is suitable especially for plugins
2237             // that synchronise data automatically using course->idnumber or by course categories.
2238             foreach ($this->plugins as $plugin) {
2239                 $plugin->restore_sync_course($courserec);
2240             }
2241             $this->enrolsynced = true;
2242         }
2244         // Map standard fields - plugin has to process custom fields manually.
2245         $data->roleid   = $this->get_mappingid('role', $data->roleid);
2246         $data->courseid = $courserec->id;
2248         if (!$this->get_setting_value('users') && $this->get_setting_value('enrolments') == backup::ENROL_WITHUSERS) {
2249             $converttomanual = true;
2250         } else {
2251             $converttomanual = ($this->get_setting_value('enrolments') == backup::ENROL_NEVER);
2252         }
2254         if ($converttomanual) {
2255             // Restore enrolments as manual enrolments.
2256             unset($data->sortorder); // Remove useless sortorder from <2.4 backups.
2257             if (!enrol_is_enabled('manual')) {
2258                 $this->set_mapping('enrol', $oldid, 0);
2259                 return;
2260             }
2261             if ($instances = $DB->get_records('enrol', array('courseid'=>$data->courseid, 'enrol'=>'manual'), 'id')) {
2262                 $instance = reset($instances);
2263                 $this->set_mapping('enrol', $oldid, $instance->id);
2264             } else {
2265                 if ($data->enrol === 'manual') {
2266                     $instanceid = $this->plugins['manual']->add_instance($courserec, (array)$data);
2267                 } else {
2268                     $instanceid = $this->plugins['manual']->add_default_instance($courserec);
2269                 }
2270                 $this->set_mapping('enrol', $oldid, $instanceid);
2271             }
2273         } else {
2274             if (!enrol_is_enabled($data->enrol) or !isset($this->plugins[$data->enrol])) {
2275                 $this->set_mapping('enrol', $oldid, 0);
2276                 $message = "Enrol plugin '$data->enrol' data can not be restored because it is not enabled, consider restoring without enrolment methods";
2277                 $this->log($message, backup::LOG_WARNING);
2278                 return;
2279             }
2280             if ($task = $this->get_task() and $task->get_target() == backup::TARGET_NEW_COURSE) {
2281                 // Let's keep the sortorder in old backups.
2282             } else {
2283                 // Prevent problems with colliding sortorders in old backups,
2284                 // new 2.4 backups do not need sortorder because xml elements are ordered properly.
2285                 unset($data->sortorder);
2286             }
2287             // Note: plugin is responsible for setting up the mapping, it may also decide to migrate to different type.
2288             $this->plugins[$data->enrol]->restore_instance($this, $data, $courserec, $oldid);
2289         }
2290     }
2292     /**
2293      * Create user enrolments.
2294      *
2295      * This has to be called after creation of enrolment instances
2296      * and before adding of role assignments.
2297      *
2298      * Roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing afterwards.
2299      *
2300      * @param mixed $data
2301      * @return void
2302      */
2303     public function process_enrolment($data) {
2304         global $DB;
2306         if (!isset($this->plugins)) {
2307             $this->plugins = enrol_get_plugins(true);
2308         }
2310         $data = (object)$data;
2312         // Process only if parent instance have been mapped.
2313         if ($enrolid = $this->get_new_parentid('enrol')) {
2314             $oldinstancestatus = ENROL_INSTANCE_ENABLED;
2315             $oldenrolid = $this->get_old_parentid('enrol');
2316             if (isset($this->originalstatus[$oldenrolid])) {
2317                 $oldinstancestatus = $this->originalstatus[$oldenrolid];
2318             }
2319             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
2320                 // And only if user is a mapped one.
2321                 if ($userid = $this->get_mappingid('user', $data->userid)) {
2322                     if (isset($this->plugins[$instance->enrol])) {
2323                         $this->plugins[$instance->enrol]->restore_user_enrolment($this, $data, $instance, $userid, $oldinstancestatus);
2324                     }
2325                 }
2326             }
2327         }
2328     }
2332 /**
2333  * Make sure the user restoring the course can actually access it.
2334  */
2335 class restore_fix_restorer_access_step extends restore_execution_step {
2336     protected function define_execution() {
2337         global $CFG, $DB;
2339         if (!$userid = $this->task->get_userid()) {
2340             return;
2341         }
2343         if (empty($CFG->restorernewroleid)) {
2344             // Bad luck, no fallback role for restorers specified
2345             return;
2346         }
2348         $courseid = $this->get_courseid();
2349         $context = context_course::instance($courseid);
2351         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
2352             // Current user may access the course (admin, category manager or restored teacher enrolment usually)
2353             return;
2354         }
2356         // Try to add role only - we do not need enrolment if user has moodle/course:view or is already enrolled
2357         role_assign($CFG->restorernewroleid, $userid, $context);
2359         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
2360             // Extra role is enough, yay!
2361             return;
2362         }
2364         // The last chance is to create manual enrol if it does not exist and and try to enrol the current user,
2365         // hopefully admin selected suitable $CFG->restorernewroleid ...
2366         if (!enrol_is_enabled('manual')) {
2367             return;
2368         }
2369         if (!$enrol = enrol_get_plugin('manual')) {
2370             return;
2371         }
2372         if (!$DB->record_exists('enrol', array('enrol'=>'manual', 'courseid'=>$courseid))) {
2373             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
2374             $fields = array('status'=>ENROL_INSTANCE_ENABLED, 'enrolperiod'=>$enrol->get_config('enrolperiod', 0), 'roleid'=>$enrol->get_config('roleid', 0));
2375             $enrol->add_instance($course, $fields);
2376         }
2378         enrol_try_internal_enrol($courseid, $userid);
2379     }
2383 /**
2384  * This structure steps restores the filters and their configs
2385  */
2386 class restore_filters_structure_step extends restore_structure_step {
2388     protected function define_structure() {
2390         $paths = array();
2392         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
2393         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
2395         return $paths;
2396     }
2398     public function process_active($data) {
2400         $data = (object)$data;
2402         if (strpos($data->filter, 'filter/') === 0) {
2403             $data->filter = substr($data->filter, 7);
2405         } else if (strpos($data->filter, '/') !== false) {
2406             // Unsupported old filter.
2407             return;
2408         }
2410         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
2411             return;
2412         }
2413         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
2414     }
2416     public function process_config($data) {
2418         $data = (object)$data;
2420         if (strpos($data->filter, 'filter/') === 0) {
2421             $data->filter = substr($data->filter, 7);
2423         } else if (strpos($data->filter, '/') !== false) {
2424             // Unsupported old filter.
2425             return;
2426         }
2428         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
2429             return;
2430         }
2431         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
2432     }
2436 /**
2437  * This structure steps restores the comments
2438  * Note: Cannot use the comments API because defaults to USER->id.
2439  * That should change allowing to pass $userid
2440  */
2441 class restore_comments_structure_step extends restore_structure_step {
2443     protected function define_structure() {
2445         $paths = array();
2447         $paths[] = new restore_path_element('comment', '/comments/comment');
2449         return $paths;
2450     }
2452     public function process_comment($data) {
2453         global $DB;
2455         $data = (object)$data;
2457         // First of all, if the comment has some itemid, ask to the task what to map
2458         $mapping = false;
2459         if ($data->itemid) {
2460             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
2461             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
2462         }
2463         // Only restore the comment if has no mapping OR we have found the matching mapping
2464         if (!$mapping || $data->itemid) {
2465             // Only if user mapping and context
2466             $data->userid = $this->get_mappingid('user', $data->userid);
2467             if ($data->userid && $this->task->get_contextid()) {
2468                 $data->contextid = $this->task->get_contextid();
2469                 // Only if there is another comment with same context/user/timecreated
2470                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
2471                 if (!$DB->record_exists('comments', $params)) {
2472                     $DB->insert_record('comments', $data);
2473                 }
2474             }
2475         }
2476     }
2479 /**
2480  * This structure steps restores the badges and their configs
2481  */
2482 class restore_badges_structure_step extends restore_structure_step {
2484     /**
2485      * Conditionally decide if this step should be executed.
2486      *
2487      * This function checks the following parameters:
2488      *
2489      *   1. Badges and course badges are enabled on the site.
2490      *   2. The course/badges.xml file exists.
2491      *   3. All modules are restorable.
2492      *   4. All modules are marked for restore.
2493      *
2494      * @return bool True is safe to execute, false otherwise
2495      */
2496     protected function execute_condition() {
2497         global $CFG;
2499         // First check is badges and course level badges are enabled on this site.
2500         if (empty($CFG->enablebadges) || empty($CFG->badges_allowcoursebadges)) {
2501             // Disabled, don't restore course badges.
2502             return false;
2503         }
2505         // Check if badges.xml is included in the backup.
2506         $fullpath = $this->task->get_taskbasepath();
2507         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2508         if (!file_exists($fullpath)) {
2509             // Not found, can't restore course badges.
2510             return false;
2511         }
2513         // Check we are able to restore all backed up modules.
2514         if ($this->task->is_missing_modules()) {
2515             return false;
2516         }
2518         // Finally check all modules within the backup are being restored.
2519         if ($this->task->is_excluding_activities()) {
2520             return false;
2521         }
2523         return true;
2524     }
2526     protected function define_structure() {
2527         $paths = array();
2528         $paths[] = new restore_path_element('badge', '/badges/badge');
2529         $paths[] = new restore_path_element('criterion', '/badges/badge/criteria/criterion');
2530         $paths[] = new restore_path_element('parameter', '/badges/badge/criteria/criterion/parameters/parameter');
2531         $paths[] = new restore_path_element('endorsement', '/badges/badge/endorsement');
2532         $paths[] = new restore_path_element('alignment', '/badges/badge/alignments/alignment');
2533         $paths[] = new restore_path_element('relatedbadge', '/badges/badge/relatedbadges/relatedbadge');
2534         $paths[] = new restore_path_element('manual_award', '/badges/badge/manual_awards/manual_award');
2536         return $paths;
2537     }
2539     public function process_badge($data) {
2540         global $DB, $CFG;
2542         require_once($CFG->libdir . '/badgeslib.php');
2544         $data = (object)$data;
2545         $data->usercreated = $this->get_mappingid('user', $data->usercreated);
2546         if (empty($data->usercreated)) {
2547             $data->usercreated = $this->task->get_userid();
2548         }
2549         $data->usermodified = $this->get_mappingid('user', $data->usermodified);
2550         if (empty($data->usermodified)) {
2551             $data->usermodified = $this->task->get_userid();
2552         }
2554         // We'll restore the badge image.
2555         $restorefiles = true;
2557         $courseid = $this->get_courseid();
2559         $params = array(
2560                 'name'           => $data->name,
2561                 'description'    => $data->description,
2562                 'timecreated'    => $data->timecreated,
2563                 'timemodified'   => $data->timemodified,
2564                 'usercreated'    => $data->usercreated,
2565                 'usermodified'   => $data->usermodified,
2566                 'issuername'     => $data->issuername,
2567                 'issuerurl'      => $data->issuerurl,
2568                 'issuercontact'  => $data->issuercontact,
2569                 'expiredate'     => $this->apply_date_offset($data->expiredate),
2570                 'expireperiod'   => $data->expireperiod,
2571                 'type'           => BADGE_TYPE_COURSE,
2572                 'courseid'       => $courseid,
2573                 'message'        => $data->message,
2574                 'messagesubject' => $data->messagesubject,
2575                 'attachment'     => $data->attachment,
2576                 'notification'   => $data->notification,
2577                 'status'         => BADGE_STATUS_INACTIVE,
2578                 'nextcron'       => $data->nextcron,
2579                 'version'        => $data->version,
2580                 'language'       => $data->language,
2581                 'imageauthorname' => $data->imageauthorname,
2582                 'imageauthoremail' => $data->imageauthoremail,
2583                 'imageauthorurl' => $data->imageauthorurl,
2584                 'imagecaption'   => $data->imagecaption
2585         );
2587         $newid = $DB->insert_record('badge', $params);
2588         $this->set_mapping('badge', $data->id, $newid, $restorefiles);
2589     }
2591     /**
2592      * Create an endorsement for a badge.
2593      *
2594      * @param mixed $data
2595      * @return void
2596      */
2597     public function process_endorsement($data) {
2598         global $DB;
2600         $data = (object)$data;
2602         $params = [
2603             'badgeid' => $this->get_new_parentid('badge'),
2604             'issuername' => $data->issuername,
2605             'issuerurl' => $data->issuerurl,
2606             'issueremail' => $data->issueremail,
2607             'claimid' => $data->claimid,
2608             'claimcomment' => $data->claimcomment,
2609             'dateissued' => $this->apply_date_offset($data->dateissued)
2610         ];
2611         $newid = $DB->insert_record('badge_endorsement', $params);
2612         $this->set_mapping('endorsement', $data->id, $newid);
2613     }
2615     /**
2616      * Link to related badges for a badge. This relies on post processing in after_execute().
2617      *
2618      * @param mixed $data
2619      * @return void
2620      */
2621     public function process_relatedbadge($data) {
2622         global $DB;
2624         $data = (object)$data;
2625         $relatedbadgeid = $data->relatedbadgeid;
2627         if ($relatedbadgeid) {
2628             // Only backup and restore related badges if they are contained in the backup file.
2629             $params = array(
2630                     'badgeid'           => $this->get_new_parentid('badge'),
2631                     'relatedbadgeid'    => $relatedbadgeid
2632             );
2633             $newid = $DB->insert_record('badge_related', $params);
2634         }
2635     }
2637     /**
2638      * Link to an alignment for a badge.
2639      *
2640      * @param mixed $data
2641      * @return void
2642      */
2643     public function process_alignment($data) {
2644         global $DB;
2646         $data = (object)$data;
2647         $params = array(
2648                 'badgeid'           => $this->get_new_parentid('badge'),
2649                 'targetname'        => $data->targetname,
2650                 'targeturl'         => $data->targeturl,
2651                 'targetdescription' => $data->targetdescription,
2652                 'targetframework'   => $data->targetframework,
2653                 'targetcode'        => $data->targetcode
2654         );
2655         $newid = $DB->insert_record('badge_alignment', $params);
2656         $this->set_mapping('alignment', $data->id, $newid);
2657     }
2659     public function process_criterion($data) {
2660         global $DB;
2662         $data = (object)$data;
2664         $params = array(
2665                 'badgeid'           => $this->get_new_parentid('badge'),
2666                 'criteriatype'      => $data->criteriatype,
2667                 'method'            => $data->method,
2668                 'description'       => isset($data->description) ? $data->description : '',
2669                 'descriptionformat' => isset($data->descriptionformat) ? $data->descriptionformat : 0,
2670         );
2672         $newid = $DB->insert_record('badge_criteria', $params);
2673         $this->set_mapping('criterion', $data->id, $newid);
2674     }
2676     public function process_parameter($data) {
2677         global $DB, $CFG;
2679         require_once($CFG->libdir . '/badgeslib.php');
2681         $data = (object)$data;
2682         $criteriaid = $this->get_new_parentid('criterion');
2684         // Parameter array that will go to database.
2685         $params = array();
2686         $params['critid'] = $criteriaid;
2688         $oldparam = explode('_', $data->name);
2690         if ($data->criteriatype == BADGE_CRITERIA_TYPE_ACTIVITY) {
2691             $module = $this->get_mappingid('course_module', $oldparam[1]);
2692             $params['name'] = $oldparam[0] . '_' . $module;
2693             $params['value'] = $oldparam[0] == 'module' ? $module : $data->value;
2694         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_COURSE) {
2695             $params['name'] = $oldparam[0] . '_' . $this->get_courseid();
2696             $params['value'] = $oldparam[0] == 'course' ? $this->get_courseid() : $data->value;
2697         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_MANUAL) {
2698             $role = $this->get_mappingid('role', $data->value);
2699             if (!empty($role)) {
2700                 $params['name'] = 'role_' . $role;
2701                 $params['value'] = $role;
2702             } else {
2703                 return;
2704             }
2705         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_COMPETENCY) {
2706             $competencyid = $this->get_mappingid('competency', $data->value);
2707             if (!empty($competencyid)) {
2708                 $params['name'] = 'competency_' . $competencyid;
2709                 $params['value'] = $competencyid;
2710             } else {
2711                 return;
2712             }
2713         }
2715         if (!$DB->record_exists('badge_criteria_param', $params)) {
2716             $DB->insert_record('badge_criteria_param', $params);
2717         }
2718     }
2720     public function process_manual_award($data) {
2721         global $DB;
2723         $data = (object)$data;
2724         $role = $this->get_mappingid('role', $data->issuerrole);
2726         if (!empty($role)) {
2727             $award = array(
2728                 'badgeid'     => $this->get_new_parentid('badge'),
2729                 'recipientid' => $this->get_mappingid('user', $data->recipientid),
2730                 'issuerid'    => $this->get_mappingid('user', $data->issuerid),
2731                 'issuerrole'  => $role,
2732                 'datemet'     => $this->apply_date_offset($data->datemet)
2733             );
2735             // Skip the manual award if recipient or issuer can not be mapped to.
2736             if (empty($award['recipientid']) || empty($award['issuerid'])) {
2737                 return;
2738             }
2740             $DB->insert_record('badge_manual_award', $award);
2741         }
2742     }
2744     protected function after_execute() {
2745         global $DB;
2746         // Add related files.
2747         $this->add_related_files('badges', 'badgeimage', 'badge');
2749         $badgeid = $this->get_new_parentid('badge');
2750         // Remap any related badges.
2751         // We do this in the DB directly because this is backup/restore it is not valid to call into
2752         // the component API.
2753         $params = array('badgeid' => $badgeid);
2754         $query = "SELECT DISTINCT br.id, br.badgeid, br.relatedbadgeid
2755                     FROM {badge_related} br
2756                    WHERE (br.badgeid = :badgeid)";
2757         $relatedbadges = $DB->get_records_sql($query, $params);
2758         $newrelatedids = [];
2759         foreach ($relatedbadges as $relatedbadge) {
2760             $relatedid = $this->get_mappingid('badge', $relatedbadge->relatedbadgeid);
2761             $params['relatedbadgeid'] = $relatedbadge->relatedbadgeid;
2762             $DB->delete_records_select('badge_related', '(badgeid = :badgeid AND relatedbadgeid = :relatedbadgeid)', $params);
2763             if ($relatedid) {
2764                 $newrelatedids[] = $relatedid;
2765             }
2766         }
2767         if (!empty($newrelatedids)) {
2768             $relatedbadges = [];
2769             foreach ($newrelatedids as $relatedid) {
2770                 $relatedbadge = new stdClass();
2771                 $relatedbadge->badgeid = $badgeid;
2772                 $relatedbadge->relatedbadgeid = $relatedid;
2773                 $relatedbadges[] = $relatedbadge;
2774             }
2775             $DB->insert_records('badge_related', $relatedbadges);
2776         }
2777     }
2780 /**
2781  * This structure steps restores the calendar events
2782  */
2783 class restore_calendarevents_structure_step extends restore_structure_step {
2785     protected function define_structure() {
2787         $paths = array();
2789         $paths[] = new restore_path_element('calendarevents', '/events/event');
2791         return $paths;
2792     }
2794     public function process_calendarevents($data) {
2795         global $DB, $SITE, $USER;
2797         $data = (object)$data;
2798         $oldid = $data->id;
2799         $restorefiles = true; // We'll restore the files
2801         // If this is a new action event, it will automatically be populated by the adhoc task.
2802         // Nothing to do here.
2803         if (isset($data->type) && $data->type == CALENDAR_EVENT_TYPE_ACTION) {
2804             return;
2805         }
2807         // User overrides for activities are identified by having a courseid of zero with
2808         // both a modulename and instance value set.
2809         $isuseroverride = !$data->courseid && $data->modulename && $data->instance;
2811         // If we don't want to include user data and this record is a user override event
2812         // for an activity then we should not create it. (Only activity events can be user override events - which must have this
2813         // setting).
2814         if ($isuseroverride && $this->task->setting_exists('userinfo') && !$this->task->get_setting_value('userinfo')) {
2815             return;
2816         }
2818         // Find the userid and the groupid associated with the event.
2819         $data->userid = $this->get_mappingid('user', $data->userid);
2820         if ($data->userid === false) {
2821             // Blank user ID means that we are dealing with module generated events such as quiz starting times.
2822             // Use the current user ID for these events.
2823             $data->userid = $USER->id;
2824         }
2825         if (!empty($data->groupid)) {
2826             $data->groupid = $this->get_mappingid('group', $data->groupid);
2827             if ($data->groupid === false) {
2828                 return;
2829             }
2830         }
2831         // Handle events with empty eventtype //MDL-32827
2832         if(empty($data->eventtype)) {
2833             if ($data->courseid == $SITE->id) {                                // Site event
2834                 $data->eventtype = "site";
2835             } else if ($data->courseid != 0 && $data->groupid == 0 && ($data->modulename == 'assignment' || $data->modulename == 'assign')) {
2836                 // Course assingment event
2837                 $data->eventtype = "due";
2838             } else if ($data->courseid != 0 && $data->groupid == 0) {      // Course event
2839                 $data->eventtype = "course";
2840             } else if ($data->groupid) {                                      // Group event
2841                 $data->eventtype = "group";
2842             } else if ($data->userid) {                                       // User event
2843                 $data->eventtype = "user";
2844             } else {
2845                 return;
2846             }
2847         }
2849         $params = array(
2850                 'name'           => $data->name,
2851                 'description'    => $data->description,
2852                 'format'         => $data->format,
2853                 // User overrides in activities use a course id of zero. All other event types
2854                 // must use the mapped course id.
2855                 'courseid'       => $data->courseid ? $this->get_courseid() : 0,
2856                 'groupid'        => $data->groupid,
2857                 'userid'         => $data->userid,
2858                 'repeatid'       => $this->get_mappingid('event', $data->repeatid),
2859                 'modulename'     => $data->modulename,
2860                 'type'           => isset($data->type) ? $data->type : 0,
2861                 'eventtype'      => $data->eventtype,
2862                 'timestart'      => $this->apply_date_offset($data->timestart),
2863                 'timeduration'   => $data->timeduration,
2864                 'timesort'       => isset($data->timesort) ? $this->apply_date_offset($data->timesort) : null,
2865                 'visible'        => $data->visible,
2866                 'uuid'           => $data->uuid,
2867                 'sequence'       => $data->sequence,
2868                 'timemodified'   => $data->timemodified,
2869                 'priority'       => isset($data->priority) ? $data->priority : null,
2870                 'location'       => isset($data->location) ? $data->location : null);
2871         if ($this->name == 'activity_calendar') {
2872             $params['instance'] = $this->task->get_activityid();
2873         } else {
2874             $params['instance'] = 0;
2875         }
2876         $sql = "SELECT id
2877                   FROM {event}
2878                  WHERE " . $DB->sql_compare_text('name', 255) . " = " . $DB->sql_compare_text('?', 255) . "
2879                    AND courseid = ?
2880                    AND modulename = ?
2881                    AND instance = ?
2882                    AND timestart = ?
2883                    AND timeduration = ?
2884                    AND " . $DB->sql_compare_text('description', 255) . " = " . $DB->sql_compare_text('?', 255);
2885         $arg = array ($params['name'], $params['courseid'], $params['modulename'], $params['instance'], $params['timestart'], $params['timeduration'], $params['description']);
2886         $result = $DB->record_exists_sql($sql, $arg);
2887         if (empty($result)) {
2888             $newitemid = $DB->insert_record('event', $params);
2889             $this->set_mapping('event', $oldid, $newitemid);
2890             $this->set_mapping('event_description', $oldid, $newitemid, $restorefiles);
2891         }
2892         // With repeating events, each event has the repeatid pointed at the first occurrence.
2893         // Since the repeatid will be empty when the first occurrence is restored,
2894         // Get the repeatid from the second occurrence of the repeating event and use that to update the first occurrence.
2895         // Then keep a list of repeatids so we only perform this update once.
2896         static $repeatids = array();
2897         if (!empty($params['repeatid']) && !in_array($params['repeatid'], $repeatids)) {
2898             // This entry is repeated so the repeatid field must be set.
2899             $DB->set_field('event', 'repeatid', $params['repeatid'], array('id' => $params['repeatid']));
2900             $repeatids[] = $params['repeatid'];
2901         }
2903     }
2904     protected function after_execute() {
2905         // Add related files
2906         $this->add_related_files('calendar', 'event_description', 'event_description');
2907     }
2910 class restore_course_completion_structure_step extends restore_structure_step {
2912     /**
2913      * Conditionally decide if this step should be executed.
2914      *
2915      * This function checks parameters that are not immediate settings to ensure
2916      * that the enviroment is suitable for the restore of course completion info.
2917      *
2918      * This function checks the following four parameters:
2919      *
2920      *   1. Course completion is enabled on the site
2921      *   2. The backup includes course completion information
2922      *   3. All modules are restorable
2923      *   4. All modules are marked for restore.
2924      *   5. No completion criteria already exist for the course.
2925      *
2926      * @return bool True is safe to execute, false otherwise
2927      */
2928     protected function execute_condition() {
2929         global $CFG, $DB;
2931         // First check course completion is enabled on this site
2932         if (empty($CFG->enablecompletion)) {
2933             // Disabled, don't restore course completion
2934             return false;
2935         }
2937         // No course completion on the front page.
2938         if ($this->get_courseid() == SITEID) {
2939             return false;
2940         }
2942         // Check it is included in the backup
2943         $fullpath = $this->task->get_taskbasepath();
2944         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2945         if (!file_exists($fullpath)) {
2946             // Not found, can't restore course completion
2947             return false;
2948         }
2950         // Check we are able to restore all backed up modules
2951         if ($this->task->is_missing_modules()) {
2952             return false;
2953         }
2955         // Check all modules within the backup are being restored.
2956         if ($this->task->is_excluding_activities()) {
2957             return false;
2958         }
2960         // Check that no completion criteria is already set for the course.
2961         if ($DB->record_exists('course_completion_criteria', array('course' => $this->get_courseid()))) {
2962             return false;
2963         }
2965         return true;
2966     }
2968     /**
2969      * Define the course completion structure
2970      *
2971      * @return array Array of restore_path_element
2972      */
2973     protected function define_structure() {
2975         // To know if we are including user completion info
2976         $userinfo = $this->get_setting_value('userscompletion');
2978         $paths = array();
2979         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
2980         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
2982         if ($userinfo) {
2983             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
2984             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
2985         }
2987         return $paths;
2989     }
2991     /**
2992      * Process course completion criteria
2993      *
2994      * @global moodle_database $DB
2995      * @param stdClass $data
2996      */
2997     public function process_course_completion_criteria($data) {
2998         global $DB;
3000         $data = (object)$data;
3001         $data->course = $this->get_courseid();
3003         // Apply the date offset to the time end field
3004         $data->timeend = $this->apply_date_offset($data->timeend);
3006         // Map the role from the criteria
3007         if (isset($data->role) && $data->role != '') {
3008             // Newer backups should include roleshortname, which makes this much easier.
3009             if (!empty($data->roleshortname)) {
3010                 $roleinstanceid = $DB->get_field('role', 'id', array('shortname' => $data->roleshortname));
3011                 if (!$roleinstanceid) {
3012                     $this->log(
3013                         'Could not match the role shortname in course_completion_criteria, so skipping',
3014                         backup::LOG_DEBUG
3015                     );
3016                     return;
3017                 }
3018                 $data->role = $roleinstanceid;
3019             } else {
3020                 $data->role = $this->get_mappingid('role', $data->role);
3021             }
3023             // Check we have an id, otherwise it causes all sorts of bugs.
3024             if (!$data->role) {
3025                 $this->log(
3026                     'Could not match role in course_completion_criteria, so skipping',
3027                     backup::LOG_DEBUG
3028                 );
3029                 return;
3030             }
3031         }
3033         // If the completion criteria is for a module we need to map the module instance
3034         // to the new module id.
3035         if (!empty($data->moduleinstance) && !empty($data->module)) {
3036             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
3037             if (empty($data->moduleinstance)) {
3038                 $this->log(
3039                     'Could not match the module instance in course_completion_criteria, so skipping',
3040                     backup::LOG_DEBUG
3041                 );
3042                 return;
3043             }
3044         } else {
3045             $data->module = null;
3046             $data->moduleinstance = null;
3047         }
3049         // We backup the course shortname rather than the ID so that we can match back to the course
3050         if (!empty($data->courseinstanceshortname)) {
3051             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
3052             if (!$courseinstanceid) {
3053                 $this->log(
3054                     'Could not match the course instance in course_completion_criteria, so skipping',
3055                     backup::LOG_DEBUG
3056                 );
3057                 return;
3058             }
3059         } else {
3060             $courseinstanceid = null;
3061         }
3062         $data->courseinstance = $courseinstanceid;
3064         $params = array(
3065             'course'         => $data->course,
3066             'criteriatype'   => $data->criteriatype,
3067             'enrolperiod'    => $data->enrolperiod,
3068             'courseinstance' => $data->courseinstance,
3069             'module'         => $data->module,
3070             'moduleinstance' => $data->moduleinstance,
3071             'timeend'        => $data->timeend,
3072             'gradepass'      => $data->gradepass,
3073             'role'           => $data->role
3074         );
3075         $newid = $DB->insert_record('course_completion_criteria', $params);
3076         $this->set_mapping('course_completion_criteria', $data->id, $newid);
3077     }
3079     /**
3080      * Processes course compltion criteria complete records
3081      *
3082      * @global moodle_database $DB
3083      * @param stdClass $data
3084      */
3085     public function process_course_completion_crit_compl($data) {
3086         global $DB;
3088         $data = (object)$data;
3090         // This may be empty if criteria could not be restored
3091         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
3093         $data->course = $this->get_courseid();
3094         $data->userid = $this->get_mappingid('user', $data->userid);
3096         if (!empty($data->criteriaid) && !empty($data->userid)) {
3097             $params = array(
3098                 'userid' => $data->userid,
3099                 'course' => $data->course,
3100                 'criteriaid' => $data->criteriaid,
3101                 'timecompleted' => $data->timecompleted
3102             );
3103             if (isset($data->gradefinal)) {
3104                 $params['gradefinal'] = $data->gradefinal;
3105             }
3106             if (isset($data->unenroled)) {
3107                 $params['unenroled'] = $data->unenroled;
3108             }
3109             $DB->insert_record('course_completion_crit_compl', $params);
3110         }
3111     }
3113     /**
3114      * Process course completions
3115      *
3116      * @global moodle_database $DB
3117      * @param stdClass $data
3118      */
3119     public function process_course_completions($data) {
3120         global $DB;
3122         $data = (object)$data;
3124         $data->course = $this->get_courseid();
3125         $data->userid = $this->get_mappingid('user', $data->userid);
3127         if (!empty($data->userid)) {
3128             $params = array(
3129                 'userid' => $data->userid,
3130                 'course' => $data->course,
3131                 'timeenrolled' => $data->timeenrolled,
3132                 'timestarted' => $data->timestarted,
3133                 'timecompleted' => $data->timecompleted,
3134                 'reaggregate' => $data->reaggregate
3135             );
3137             $existing = $DB->get_record('course_completions', array(
3138                 'userid' => $data->userid,
3139                 'course' => $data->course
3140             ));
3142             // MDL-46651 - If cron writes out a new record before we get to it
3143             // then we should replace it with the Truth data from the backup.
3144             // This may be obsolete after MDL-48518 is resolved
3145             if ($existing) {
3146                 $params['id'] = $existing->id;
3147                 $DB->update_record('course_completions', $params);
3148             } else {
3149                 $DB->insert_record('course_completions', $params);
3150             }
3151         }
3152     }
3154     /**
3155      * Process course completion aggregate methods
3156      *
3157      * @global moodle_database $DB
3158      * @param stdClass $data
3159      */
3160     public function process_course_completion_aggr_methd($data) {
3161         global $DB;
3163         $data = (object)$data;
3165         $data->course = $this->get_courseid();
3167         // Only create the course_completion_aggr_methd records if
3168         // the target course has not them defined. MDL-28180
3169         if (!$DB->record_exists('course_completion_aggr_methd', array(
3170                     'course' => $data->course,
3171                     'criteriatype' => $data->criteriatype))) {
3172             $params = array(
3173                 'course' => $data->course,
3174                 'criteriatype' => $data->criteriatype,
3175                 'method' => $data->method,
3176                 'value' => $data->value,
3177             );
3178             $DB->insert_record('course_completion_aggr_methd', $params);
3179         }
3180     }
3184 /**
3185  * This structure step restores course logs (cmid = 0), delegating
3186  * the hard work to the corresponding {@link restore_logs_processor} passing the
3187  * collection of {@link restore_log_rule} rules to be observed as they are defined
3188  * by the task. Note this is only executed based in the 'logs' setting.
3189  *
3190  * NOTE: This is executed by final task, to have all the activities already restored
3191  *
3192  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
3193  * records are. There are others like 'calendar' and 'upload' that will be handled
3194  * later.
3195  *
3196  * NOTE: All the missing actions (not able to be restored) are sent to logs for
3197  * debugging purposes
3198  */
3199 class restore_course_logs_structure_step extends restore_structure_step {
3201     /**
3202      * Conditionally decide if this step should be executed.
3203      *
3204      * This function checks the following parameter:
3205      *
3206      *   1. the course/logs.xml file exists
3207      *
3208      * @return bool true is safe to execute, false otherwise
3209      */
3210     protected function execute_condition() {
3212         // Check it is included in the backup
3213         $fullpath = $this->task->get_taskbasepath();
3214         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
3215         if (!file_exists($fullpath)) {
3216             // Not found, can't restore course logs
3217             return false;
3218         }
3220         return true;
3221     }