MDL-69401 book: Limit character length in chapter title
[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 = floatval($this->get_task()->get_info()->backup_release); // The major version: 2.9, 3.0, ...
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 && ($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         // The function floatval will return a float even if there is text mixed with the release number.
509         $backuprelease = floatval($this->get_task()->get_info()->backup_release);
511         // Extra credits need adjustments only for backups made between 2.8 release (20141110) and the fix release (20150619).
512         if (!$gradebookcalculationsfreeze && $backupbuild >= 20141110 && $backupbuild < 20150619) {
513             require_once($CFG->libdir . '/db/upgradelib.php');
514             upgrade_extra_credit_weightoverride($this->get_courseid());
515         }
516         // Calculated grade items need recalculating for backups made between 2.8 release (20141110) and the fix release (20150627).
517         if (!$gradebookcalculationsfreeze && $backupbuild >= 20141110 && $backupbuild < 20150627) {
518             require_once($CFG->libdir . '/db/upgradelib.php');
519             upgrade_calculated_grade_items($this->get_courseid());
520         }
521         // Courses from before 3.1 (20160518) may have a letter boundary problem and should be checked for this issue.
522         // Backups from before and including 2.9 could have a build number that is greater than 20160518 and should
523         // be checked for this problem.
524         if (!$gradebookcalculationsfreeze && ($backupbuild < 20160518 || $backuprelease <= 2.9)) {
525             require_once($CFG->libdir . '/db/upgradelib.php');
526             upgrade_course_letter_boundary($this->get_courseid());
527         }
529     }
531     /**
532      * Checks what should happen with the course grade setting minmaxtouse.
533      *
534      * This is related to the upgrade step at the time the setting was added.
535      *
536      * @see MDL-48618
537      * @return void
538      */
539     protected function check_minmaxtouse() {
540         global $CFG, $DB;
541         require_once($CFG->libdir . '/gradelib.php');
543         $userinfo = $this->task->get_setting_value('users');
544         $settingname = 'minmaxtouse';
545         $courseid = $this->get_courseid();
546         $minmaxtouse = $DB->get_field('grade_settings', 'value', array('courseid' => $courseid, 'name' => $settingname));
547         $version28start = 2014111000.00;
548         $version28last = 2014111006.05;
549         $version29start = 2015051100.00;
550         $version29last = 2015060400.02;
552         $target = $this->get_task()->get_target();
553         if ($minmaxtouse === false &&
554                 ($target != backup::TARGET_CURRENT_ADDING && $target != backup::TARGET_EXISTING_ADDING)) {
555             // The setting was not found because this setting did not exist at the time the backup was made.
556             // And we are not restoring as merge, in which case we leave the course as it was.
557             $version = $this->get_task()->get_info()->moodle_version;
559             if ($version < $version28start) {
560                 // We need to set it to use grade_item, but only if the site-wide setting is different. No need to notice them.
561                 if ($CFG->grade_minmaxtouse != GRADE_MIN_MAX_FROM_GRADE_ITEM) {
562                     grade_set_setting($courseid, $settingname, GRADE_MIN_MAX_FROM_GRADE_ITEM);
563                 }
565             } else if (($version >= $version28start && $version < $version28last) ||
566                     ($version >= $version29start && $version < $version29last)) {
567                 // They should be using grade_grade when the course has inconsistencies.
569                 $sql = "SELECT gi.id
570                           FROM {grade_items} gi
571                           JOIN {grade_grades} gg
572                             ON gg.itemid = gi.id
573                          WHERE gi.courseid = ?
574                            AND (gi.itemtype != ? AND gi.itemtype != ?)
575                            AND (gg.rawgrademax != gi.grademax OR gg.rawgrademin != gi.grademin)";
577                 // The course can only have inconsistencies when we restore the user info,
578                 // we do not need to act on existing grades that were not restored as part of this backup.
579                 if ($userinfo && $DB->record_exists_sql($sql, array($courseid, 'course', 'category'))) {
581                     // Display the notice as we do during upgrade.
582                     set_config('show_min_max_grades_changed_' . $courseid, 1);
584                     if ($CFG->grade_minmaxtouse != GRADE_MIN_MAX_FROM_GRADE_GRADE) {
585                         // We need set the setting as their site-wise setting is not GRADE_MIN_MAX_FROM_GRADE_GRADE.
586                         // If they are using the site-wide grade_grade setting, we only want to notice them.
587                         grade_set_setting($courseid, $settingname, GRADE_MIN_MAX_FROM_GRADE_GRADE);
588                     }
589                 }
591             } else {
592                 // This should never happen because from now on minmaxtouse is always saved in backups.
593             }
594         }
595     }
597     /**
598      * Rewrite step definition to handle the legacy freeze attribute.
599      *
600      * In previous backups the calculations_freeze property was stored as an attribute of the
601      * top level node <gradebook>. The backup API, however, do not process grandparent nodes.
602      * It only processes definitive children, and their parent attributes.
603      *
604      * We had:
605      *
606      * <gradebook calculations_freeze="20160511">
607      *   <grade_categories>
608      *     <grade_category id="10">
609      *       <depth>1</depth>
610      *       ...
611      *     </grade_category>
612      *   </grade_categories>
613      *   ...
614      * </gradebook>
615      *
616      * And this method will convert it to:
617      *
618      * <gradebook >
619      *   <attributes>
620      *     <calculations_freeze>20160511</calculations_freeze>
621      *   </attributes>
622      *   <grade_categories>
623      *     <grade_category id="10">
624      *       <depth>1</depth>
625      *       ...
626      *     </grade_category>
627      *   </grade_categories>
628      *   ...
629      * </gradebook>
630      *
631      * Note that we cannot just load the XML file in memory as it could potentially be huge.
632      * We can also completely ignore if the node <attributes> is already in the backup
633      * file as it never existed before.
634      *
635      * @param string $filepath The absolute path to the XML file.
636      * @return void
637      */
638     protected function rewrite_step_backup_file_for_legacy_freeze($filepath) {
639         $foundnode = false;
640         $newfile = make_request_directory(true) . DIRECTORY_SEPARATOR . 'file.xml';
641         $fr = fopen($filepath, 'r');
642         $fw = fopen($newfile, 'w');
643         if ($fr && $fw) {
644             while (($line = fgets($fr, 4096)) !== false) {
645                 if (!$foundnode && strpos($line, '<gradebook ') === 0) {
646                     $foundnode = true;
647                     $matches = array();
648                     $pattern = '@calculations_freeze=.([0-9]+).@';
649                     if (preg_match($pattern, $line, $matches)) {
650                         $freeze = $matches[1];
651                         $line = preg_replace($pattern, '', $line);
652                         $line .= "  <attributes>\n    <calculations_freeze>$freeze</calculations_freeze>\n  </attributes>\n";
653                     }
654                 }
655                 fputs($fw, $line);
656             }
657             if (!feof($fr)) {
658                 throw new restore_step_exception('Error while attempting to rewrite the gradebook step file.');
659             }
660             fclose($fr);
661             fclose($fw);
662             if (!rename($newfile, $filepath)) {
663                 throw new restore_step_exception('Error while attempting to rename the gradebook step file.');
664             }
665         } else {
666             if ($fr) {
667                 fclose($fr);
668             }
669             if ($fw) {
670                 fclose($fw);
671             }
672         }
673     }
677 /**
678  * Step in charge of restoring the grade history of a course.
679  *
680  * The execution conditions are itendical to {@link restore_gradebook_structure_step} because
681  * we do not want to restore the history if the gradebook and its content has not been
682  * restored. At least for now.
683  */
684 class restore_grade_history_structure_step extends restore_structure_step {
686      protected function execute_condition() {
687         global $CFG, $DB;
689         if ($this->get_courseid() == SITEID) {
690             return false;
691         }
693         // No gradebook info found, don't execute.
694         $fullpath = $this->task->get_taskbasepath();
695         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
696         if (!file_exists($fullpath)) {
697             return false;
698         }
700         // Some module present in backup file isn't available to restore in this site, don't execute.
701         if ($this->task->is_missing_modules()) {
702             return false;
703         }
705         // Some activity has been excluded to be restored, don't execute.
706         if ($this->task->is_excluding_activities()) {
707             return false;
708         }
710         // There should only be one grade category (the 1 associated with the course itself).
711         $category = new stdclass();
712         $category->courseid  = $this->get_courseid();
713         $catcount = $DB->count_records('grade_categories', (array)$category);
714         if ($catcount > 1) {
715             return false;
716         }
718         // Arrived here, execute the step.
719         return true;
720      }
722     protected function define_structure() {
723         $paths = array();
725         // Settings to use.
726         $userinfo = $this->get_setting_value('users');
727         $history = $this->get_setting_value('grade_histories');
729         if ($userinfo && $history) {
730             $paths[] = new restore_path_element('grade_grade',
731                '/grade_history/grade_grades/grade_grade');
732         }
734         return $paths;
735     }
737     protected function process_grade_grade($data) {
738         global $DB;
740         $data = (object)($data);
741         $olduserid = $data->userid;
742         unset($data->id);
744         $data->userid = $this->get_mappingid('user', $data->userid, null);
745         if (!empty($data->userid)) {
746             // Do not apply the date offsets as this is history.
747             $data->itemid = $this->get_mappingid('grade_item', $data->itemid);
748             $data->oldid = $this->get_mappingid('grade_grades', $data->oldid);
749             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
750             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
751             $DB->insert_record('grade_grades_history', $data);
752         } else {
753             $message = "Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'";
754             $this->log($message, backup::LOG_DEBUG);
755         }
756     }
760 /**
761  * decode all the interlinks present in restored content
762  * relying 100% in the restore_decode_processor that handles
763  * both the contents to modify and the rules to be applied
764  */
765 class restore_decode_interlinks extends restore_execution_step {
767     protected function define_execution() {
768         // Get the decoder (from the plan)
769         $decoder = $this->task->get_decoder();
770         restore_decode_processor::register_link_decoders($decoder); // Add decoder contents and rules
771         // And launch it, everything will be processed
772         $decoder->execute();
773     }
776 /**
777  * first, ensure that we have no gaps in section numbers
778  * and then, rebuid the course cache
779  */
780 class restore_rebuild_course_cache extends restore_execution_step {
782     protected function define_execution() {
783         global $DB;
785         // Although there is some sort of auto-recovery of missing sections
786         // present in course/formats... here we check that all the sections
787         // from 0 to MAX(section->section) exist, creating them if necessary
788         $maxsection = $DB->get_field('course_sections', 'MAX(section)', array('course' => $this->get_courseid()));
789         // Iterate over all sections
790         for ($i = 0; $i <= $maxsection; $i++) {
791             // If the section $i doesn't exist, create it
792             if (!$DB->record_exists('course_sections', array('course' => $this->get_courseid(), 'section' => $i))) {
793                 $sectionrec = array(
794                     'course' => $this->get_courseid(),
795                     'section' => $i,
796                     'timemodified' => time());
797                 $DB->insert_record('course_sections', $sectionrec); // missing section created
798             }
799         }
801         // Rebuild cache now that all sections are in place
802         rebuild_course_cache($this->get_courseid());
803         cache_helper::purge_by_event('changesincourse');
804         cache_helper::purge_by_event('changesincoursecat');
805     }
808 /**
809  * Review all the tasks having one after_restore method
810  * executing it to perform some final adjustments of information
811  * not available when the task was executed.
812  */
813 class restore_execute_after_restore extends restore_execution_step {
815     protected function define_execution() {
817         // Simply call to the execute_after_restore() method of the task
818         // that always is the restore_final_task
819         $this->task->launch_execute_after_restore();
820     }
824 /**
825  * Review all the (pending) block positions in backup_ids, matching by
826  * contextid, creating positions as needed. This is executed by the
827  * final task, once all the contexts have been created
828  */
829 class restore_review_pending_block_positions extends restore_execution_step {
831     protected function define_execution() {
832         global $DB;
834         // Get all the block_position objects pending to match
835         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
836         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
837         // Process block positions, creating them or accumulating for final step
838         foreach($rs as $posrec) {
839             // Get the complete position object out of the info field.
840             $position = backup_controller_dbops::decode_backup_temp_info($posrec->info);
841             // If position is for one already mapped (known) contextid
842             // process it now, creating the position, else nothing to
843             // do, position finally discarded
844             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
845                 $position->contextid = $newctx->newitemid;
846                 // Create the block position
847                 $DB->insert_record('block_positions', $position);
848             }
849         }
850         $rs->close();
851     }
855 /**
856  * Updates the availability data for course modules and sections.
857  *
858  * Runs after the restore of all course modules, sections, and grade items has
859  * completed. This is necessary in order to update IDs that have changed during
860  * restore.
861  *
862  * @package core_backup
863  * @copyright 2014 The Open University
864  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
865  */
866 class restore_update_availability extends restore_execution_step {
868     protected function define_execution() {
869         global $CFG, $DB;
871         // Note: This code runs even if availability is disabled when restoring.
872         // That will ensure that if you later turn availability on for the site,
873         // there will be no incorrect IDs. (It doesn't take long if the restored
874         // data does not contain any availability information.)
876         // Get modinfo with all data after resetting cache.
877         rebuild_course_cache($this->get_courseid(), true);
878         $modinfo = get_fast_modinfo($this->get_courseid());
880         // Get the date offset for this restore.
881         $dateoffset = $this->apply_date_offset(1) - 1;
883         // Update all sections that were restored.
884         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'course_section');
885         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'newitemid');
886         $sectionsbyid = null;
887         foreach ($rs as $rec) {
888             if (is_null($sectionsbyid)) {
889                 $sectionsbyid = array();
890                 foreach ($modinfo->get_section_info_all() as $section) {
891                     $sectionsbyid[$section->id] = $section;
892                 }
893             }
894             if (!array_key_exists($rec->newitemid, $sectionsbyid)) {
895                 // If the section was not fully restored for some reason
896                 // (e.g. due to an earlier error), skip it.
897                 $this->get_logger()->process('Section not fully restored: id ' .
898                         $rec->newitemid, backup::LOG_WARNING);
899                 continue;
900             }
901             $section = $sectionsbyid[$rec->newitemid];
902             if (!is_null($section->availability)) {
903                 $info = new \core_availability\info_section($section);
904                 $info->update_after_restore($this->get_restoreid(),
905                         $this->get_courseid(), $this->get_logger(), $dateoffset, $this->task);
906             }
907         }
908         $rs->close();
910         // Update all modules that were restored.
911         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'course_module');
912         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'newitemid');
913         foreach ($rs as $rec) {
914             if (!array_key_exists($rec->newitemid, $modinfo->cms)) {
915                 // If the module was not fully restored for some reason
916                 // (e.g. due to an earlier error), skip it.
917                 $this->get_logger()->process('Module not fully restored: id ' .
918                         $rec->newitemid, backup::LOG_WARNING);
919                 continue;
920             }
921             $cm = $modinfo->get_cm($rec->newitemid);
922             if (!is_null($cm->availability)) {
923                 $info = new \core_availability\info_module($cm);
924                 $info->update_after_restore($this->get_restoreid(),
925                         $this->get_courseid(), $this->get_logger(), $dateoffset, $this->task);
926             }
927         }
928         $rs->close();
929     }
933 /**
934  * Process legacy module availability records in backup_ids.
935  *
936  * Matches course modules and grade item id once all them have been already restored.
937  * Only if all matchings are satisfied the availability condition will be created.
938  * At the same time, it is required for the site to have that functionality enabled.
939  *
940  * This step is included only to handle legacy backups (2.6 and before). It does not
941  * do anything for newer backups.
942  *
943  * @copyright 2014 The Open University
944  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
945  */
946 class restore_process_course_modules_availability extends restore_execution_step {
948     protected function define_execution() {
949         global $CFG, $DB;
951         // Site hasn't availability enabled
952         if (empty($CFG->enableavailability)) {
953             return;
954         }
956         // Do both modules and sections.
957         foreach (array('module', 'section') as $table) {
958             // Get all the availability objects to process.
959             $params = array('backupid' => $this->get_restoreid(), 'itemname' => $table . '_availability');
960             $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
961             // Process availabilities, creating them if everything matches ok.
962             foreach ($rs as $availrec) {
963                 $allmatchesok = true;
964                 // Get the complete legacy availability object.
965                 $availability = backup_controller_dbops::decode_backup_temp_info($availrec->info);
967                 // Note: This code used to update IDs, but that is now handled by the
968                 // current code (after restore) instead of this legacy code.
970                 // Get showavailability option.
971                 $thingid = ($table === 'module') ? $availability->coursemoduleid :
972                         $availability->coursesectionid;
973                 $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
974                         $table . '_showavailability', $thingid);
975                 if (!$showrec) {
976                     // Should not happen.
977                     throw new coding_exception('No matching showavailability record');
978                 }
979                 $show = $showrec->info->showavailability;
981                 // The $availability object is now in the format used in the old
982                 // system. Interpret this and convert to new system.
983                 $currentvalue = $DB->get_field('course_' . $table . 's', 'availability',
984                         array('id' => $thingid), MUST_EXIST);
985                 $newvalue = \core_availability\info::add_legacy_availability_condition(
986                         $currentvalue, $availability, $show);
987                 $DB->set_field('course_' . $table . 's', 'availability', $newvalue,
988                         array('id' => $thingid));
989             }
990             $rs->close();
991         }
992     }
996 /*
997  * Execution step that, *conditionally* (if there isn't preloaded information)
998  * will load the inforef files for all the included course/section/activity tasks
999  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
1000  */
1001 class restore_load_included_inforef_records extends restore_execution_step {
1003     protected function define_execution() {
1005         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1006             return;
1007         }
1009         // Get all the included tasks
1010         $tasks = restore_dbops::get_included_tasks($this->get_restoreid());
1011         $progress = $this->task->get_progress();
1012         $progress->start_progress($this->get_name(), count($tasks));
1013         foreach ($tasks as $task) {
1014             // Load the inforef.xml file if exists
1015             $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
1016             if (file_exists($inforefpath)) {
1017                 // Load each inforef file to temp_ids.
1018                 restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $inforefpath, $progress);
1019             }
1020         }
1021         $progress->end_progress();
1022     }
1025 /*
1026  * Execution step that will load all the needed files into backup_files_temp
1027  *   - info: contains the whole original object (times, names...)
1028  * (all them being original ids as loaded from xml)
1029  */
1030 class restore_load_included_files extends restore_structure_step {
1032     protected function define_structure() {
1034         $file = new restore_path_element('file', '/files/file');
1036         return array($file);
1037     }
1039     /**
1040      * Process one <file> element from files.xml
1041      *
1042      * @param array $data the element data
1043      */
1044     public function process_file($data) {
1046         $data = (object)$data; // handy
1048         // load it if needed:
1049         //   - it it is one of the annotated inforef files (course/section/activity/block)
1050         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
1051         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
1052         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
1053         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
1054         $iscomponent = ($data->component == 'user' || $data->component == 'group' || $data->component == 'badges' ||
1055                         $data->component == 'grouping' || $data->component == 'grade' ||
1056                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
1057         if ($isfileref || $iscomponent) {
1058             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
1059         }
1060     }
1063 /**
1064  * Execution step that, *conditionally* (if there isn't preloaded information),
1065  * will load all the needed roles to backup_temp_ids. They will be stored with
1066  * "role" itemname. Also it will perform one automatic mapping to roles existing
1067  * in the target site, based in permissions of the user performing the restore,
1068  * archetypes and other bits. At the end, each original role will have its associated
1069  * target role or 0 if it's going to be skipped. Note we wrap everything over one
1070  * restore_dbops method, as far as the same stuff is going to be also executed
1071  * by restore prechecks
1072  */
1073 class restore_load_and_map_roles extends restore_execution_step {
1075     protected function define_execution() {
1076         if ($this->task->get_preloaded_information()) { // if info is already preloaded
1077             return;
1078         }
1080         $file = $this->get_basepath() . '/roles.xml';
1081         // Load needed toles to temp_ids
1082         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
1084         // Process roles, mapping/skipping. Any error throws exception
1085         // Note we pass controller's info because it can contain role mapping information
1086         // about manual mappings performed by UI
1087         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);
1088     }
1091 /**
1092  * Execution step that, *conditionally* (if there isn't preloaded information
1093  * and users have been selected in settings, will load all the needed users
1094  * to backup_temp_ids. They will be stored with "user" itemname and with
1095  * their original contextid as paremitemid
1096  */
1097 class restore_load_included_users extends restore_execution_step {
1099     protected function define_execution() {
1101         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1102             return;
1103         }
1104         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
1105             return;
1106         }
1107         $file = $this->get_basepath() . '/users.xml';
1108         // Load needed users to temp_ids.
1109         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file, $this->task->get_progress());
1110     }
1113 /**
1114  * Execution step that, *conditionally* (if there isn't preloaded information
1115  * and users have been selected in settings, will process all the needed users
1116  * in order to decide and perform any action with them (create / map / error)
1117  * Note: Any error will cause exception, as far as this is the same processing
1118  * than the one into restore prechecks (that should have stopped process earlier)
1119  */
1120 class restore_process_included_users extends restore_execution_step {
1122     protected function define_execution() {
1124         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1125             return;
1126         }
1127         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
1128             return;
1129         }
1130         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(),
1131                 $this->task->get_userid(), $this->task->is_samesite(), $this->task->get_progress());
1132     }
1135 /**
1136  * Execution step that will create all the needed users as calculated
1137  * by @restore_process_included_users (those having newiteind = 0)
1138  */
1139 class restore_create_included_users extends restore_execution_step {
1141     protected function define_execution() {
1143         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(),
1144                 $this->task->get_userid(), $this->task->get_progress());
1145     }
1148 /**
1149  * Structure step that will create all the needed groups and groupings
1150  * by loading them from the groups.xml file performing the required matches.
1151  * Note group members only will be added if restoring user info
1152  */
1153 class restore_groups_structure_step extends restore_structure_step {
1155     protected function define_structure() {
1157         $paths = array(); // Add paths here
1159         // Do not include group/groupings information if not requested.
1160         $groupinfo = $this->get_setting_value('groups');
1161         if ($groupinfo) {
1162             $paths[] = new restore_path_element('group', '/groups/group');
1163             $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
1164             $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
1165         }
1166         return $paths;
1167     }
1169     // Processing functions go here
1170     public function process_group($data) {
1171         global $DB;
1173         $data = (object)$data; // handy
1174         $data->courseid = $this->get_courseid();
1176         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1177         // another a group in the same course
1178         $context = context_course::instance($data->courseid);
1179         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1180             if (groups_get_group_by_idnumber($data->courseid, $data->idnumber)) {
1181                 unset($data->idnumber);
1182             }
1183         } else {
1184             unset($data->idnumber);
1185         }
1187         $oldid = $data->id;    // need this saved for later
1189         $restorefiles = false; // Only if we end creating the group
1191         // Search if the group already exists (by name & description) in the target course
1192         $description_clause = '';
1193         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
1194         if (!empty($data->description)) {
1195             $description_clause = ' AND ' .
1196                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
1197            $params['description'] = $data->description;
1198         }
1199         if (!$groupdb = $DB->get_record_sql("SELECT *
1200                                                FROM {groups}
1201                                               WHERE courseid = :courseid
1202                                                 AND name = :grname $description_clause", $params)) {
1203             // group doesn't exist, create
1204             $newitemid = $DB->insert_record('groups', $data);
1205             $restorefiles = true; // We'll restore the files
1206         } else {
1207             // group exists, use it
1208             $newitemid = $groupdb->id;
1209         }
1210         // Save the id mapping
1211         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
1212         // Invalidate the course group data cache just in case.
1213         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
1214     }
1216     public function process_grouping($data) {
1217         global $DB;
1219         $data = (object)$data; // handy
1220         $data->courseid = $this->get_courseid();
1222         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1223         // another a grouping in the same course
1224         $context = context_course::instance($data->courseid);
1225         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1226             if (groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) {
1227                 unset($data->idnumber);
1228             }
1229         } else {
1230             unset($data->idnumber);
1231         }
1233         $oldid = $data->id;    // need this saved for later
1234         $restorefiles = false; // Only if we end creating the grouping
1236         // Search if the grouping already exists (by name & description) in the target course
1237         $description_clause = '';
1238         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
1239         if (!empty($data->description)) {
1240             $description_clause = ' AND ' .
1241                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
1242            $params['description'] = $data->description;
1243         }
1244         if (!$groupingdb = $DB->get_record_sql("SELECT *
1245                                                   FROM {groupings}
1246                                                  WHERE courseid = :courseid
1247                                                    AND name = :grname $description_clause", $params)) {
1248             // grouping doesn't exist, create
1249             $newitemid = $DB->insert_record('groupings', $data);
1250             $restorefiles = true; // We'll restore the files
1251         } else {
1252             // grouping exists, use it
1253             $newitemid = $groupingdb->id;
1254         }
1255         // Save the id mapping
1256         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
1257         // Invalidate the course group data cache just in case.
1258         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
1259     }
1261     public function process_grouping_group($data) {
1262         global $CFG;
1264         require_once($CFG->dirroot.'/group/lib.php');
1266         $data = (object)$data;
1267         groups_assign_grouping($this->get_new_parentid('grouping'), $this->get_mappingid('group', $data->groupid), $data->timeadded);
1268     }
1270     protected function after_execute() {
1271         // Add group related files, matching with "group" mappings
1272         $this->add_related_files('group', 'icon', 'group');
1273         $this->add_related_files('group', 'description', 'group');
1274         // Add grouping related files, matching with "grouping" mappings
1275         $this->add_related_files('grouping', 'description', 'grouping');
1276         // Invalidate the course group data.
1277         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($this->get_courseid()));
1278     }
1282 /**
1283  * Structure step that will create all the needed group memberships
1284  * by loading them from the groups.xml file performing the required matches.
1285  */
1286 class restore_groups_members_structure_step extends restore_structure_step {
1288     protected $plugins = null;
1290     protected function define_structure() {
1292         $paths = array(); // Add paths here
1294         if ($this->get_setting_value('groups') && $this->get_setting_value('users')) {
1295             $paths[] = new restore_path_element('group', '/groups/group');
1296             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
1297         }
1299         return $paths;
1300     }
1302     public function process_group($data) {
1303         $data = (object)$data; // handy
1305         // HACK ALERT!
1306         // Not much to do here, this groups mapping should be already done from restore_groups_structure_step.
1307         // Let's fake internal state to make $this->get_new_parentid('group') work.
1309         $this->set_mapping('group', $data->id, $this->get_mappingid('group', $data->id));
1310     }
1312     public function process_member($data) {
1313         global $DB, $CFG;
1314         require_once("$CFG->dirroot/group/lib.php");
1316         // NOTE: Always use groups_add_member() because it triggers events and verifies if user is enrolled.
1318         $data = (object)$data; // handy
1320         // get parent group->id
1321         $data->groupid = $this->get_new_parentid('group');
1323         // map user newitemid and insert if not member already
1324         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
1325             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
1326                 // Check the component, if any, exists.
1327                 if (empty($data->component)) {
1328                     groups_add_member($data->groupid, $data->userid);
1330                 } else if ((strpos($data->component, 'enrol_') === 0)) {
1331                     // Deal with enrolment groups - ignore the component and just find out the instance via new id,
1332                     // it is possible that enrolment was restored using different plugin type.
1333                     if (!isset($this->plugins)) {
1334                         $this->plugins = enrol_get_plugins(true);
1335                     }
1336                     if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1337                         if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1338                             if (isset($this->plugins[$instance->enrol])) {
1339                                 $this->plugins[$instance->enrol]->restore_group_member($instance, $data->groupid, $data->userid);
1340                             }
1341                         }
1342                     }
1344                 } else {
1345                     $dir = core_component::get_component_directory($data->component);
1346                     if ($dir and is_dir($dir)) {
1347                         if (component_callback($data->component, 'restore_group_member', array($this, $data), true)) {
1348                             return;
1349                         }
1350                     }
1351                     // Bad luck, plugin could not restore the data, let's add normal membership.
1352                     groups_add_member($data->groupid, $data->userid);
1353                     $message = "Restore of '$data->component/$data->itemid' group membership is not supported, using standard group membership instead.";
1354                     $this->log($message, backup::LOG_WARNING);
1355                 }
1356             }
1357         }
1358     }
1361 /**
1362  * Structure step that will create all the needed scales
1363  * by loading them from the scales.xml
1364  */
1365 class restore_scales_structure_step extends restore_structure_step {
1367     protected function define_structure() {
1369         $paths = array(); // Add paths here
1370         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
1371         return $paths;
1372     }
1374     protected function process_scale($data) {
1375         global $DB;
1377         $data = (object)$data;
1379         $restorefiles = false; // Only if we end creating the group
1381         $oldid = $data->id;    // need this saved for later
1383         // Look for scale (by 'scale' both in standard (course=0) and current course
1384         // with priority to standard scales (ORDER clause)
1385         // scale is not course unique, use get_record_sql to suppress warning
1386         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
1387         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
1388         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
1389         if (!$scadb = $DB->get_record_sql("SELECT *
1390                                             FROM {scale}
1391                                            WHERE courseid IN (0, :courseid)
1392                                              AND $compare_scale_clause
1393                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
1394             // Remap the user if possible, defaut to user performing the restore if not
1395             $userid = $this->get_mappingid('user', $data->userid);
1396             $data->userid = $userid ? $userid : $this->task->get_userid();
1397             // Remap the course if course scale
1398             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
1399             // If global scale (course=0), check the user has perms to create it
1400             // falling to course scale if not
1401             $systemctx = context_system::instance();
1402             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
1403                 $data->courseid = $this->get_courseid();
1404             }
1405             // scale doesn't exist, create
1406             $newitemid = $DB->insert_record('scale', $data);
1407             $restorefiles = true; // We'll restore the files
1408         } else {
1409             // scale exists, use it
1410             $newitemid = $scadb->id;
1411         }
1412         // Save the id mapping (with files support at system context)
1413         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1414     }
1416     protected function after_execute() {
1417         // Add scales related files, matching with "scale" mappings
1418         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
1419     }
1423 /**
1424  * Structure step that will create all the needed outocomes
1425  * by loading them from the outcomes.xml
1426  */
1427 class restore_outcomes_structure_step extends restore_structure_step {
1429     protected function define_structure() {
1431         $paths = array(); // Add paths here
1432         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
1433         return $paths;
1434     }
1436     protected function process_outcome($data) {
1437         global $DB;
1439         $data = (object)$data;
1441         $restorefiles = false; // Only if we end creating the group
1443         $oldid = $data->id;    // need this saved for later
1445         // Look for outcome (by shortname both in standard (courseid=null) and current course
1446         // with priority to standard outcomes (ORDER clause)
1447         // outcome is not course unique, use get_record_sql to suppress warning
1448         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
1449         if (!$outdb = $DB->get_record_sql('SELECT *
1450                                              FROM {grade_outcomes}
1451                                             WHERE shortname = :shortname
1452                                               AND (courseid = :courseid OR courseid IS NULL)
1453                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
1454             // Remap the user
1455             $userid = $this->get_mappingid('user', $data->usermodified);
1456             $data->usermodified = $userid ? $userid : $this->task->get_userid();
1457             // Remap the scale
1458             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
1459             // Remap the course if course outcome
1460             $data->courseid = $data->courseid ? $this->get_courseid() : null;
1461             // If global outcome (course=null), check the user has perms to create it
1462             // falling to course outcome if not
1463             $systemctx = context_system::instance();
1464             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
1465                 $data->courseid = $this->get_courseid();
1466             }
1467             // outcome doesn't exist, create
1468             $newitemid = $DB->insert_record('grade_outcomes', $data);
1469             $restorefiles = true; // We'll restore the files
1470         } else {
1471             // scale exists, use it
1472             $newitemid = $outdb->id;
1473         }
1474         // Set the corresponding grade_outcomes_courses record
1475         $outcourserec = new stdclass();
1476         $outcourserec->courseid  = $this->get_courseid();
1477         $outcourserec->outcomeid = $newitemid;
1478         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
1479             $DB->insert_record('grade_outcomes_courses', $outcourserec);
1480         }
1481         // Save the id mapping (with files support at system context)
1482         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1483     }
1485     protected function after_execute() {
1486         // Add outcomes related files, matching with "outcome" mappings
1487         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
1488     }
1491 /**
1492  * Execution step that, *conditionally* (if there isn't preloaded information
1493  * will load all the question categories and questions (header info only)
1494  * to backup_temp_ids. They will be stored with "question_category" and
1495  * "question" itemnames and with their original contextid and question category
1496  * id as paremitemids
1497  */
1498 class restore_load_categories_and_questions extends restore_execution_step {
1500     protected function define_execution() {
1502         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1503             return;
1504         }
1505         $file = $this->get_basepath() . '/questions.xml';
1506         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
1507     }
1510 /**
1511  * Execution step that, *conditionally* (if there isn't preloaded information)
1512  * will process all the needed categories and questions
1513  * in order to decide and perform any action with them (create / map / error)
1514  * Note: Any error will cause exception, as far as this is the same processing
1515  * than the one into restore prechecks (that should have stopped process earlier)
1516  */
1517 class restore_process_categories_and_questions extends restore_execution_step {
1519     protected function define_execution() {
1521         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1522             return;
1523         }
1524         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
1525     }
1528 /**
1529  * Structure step that will read the section.xml creating/updating sections
1530  * as needed, rebuilding course cache and other friends
1531  */
1532 class restore_section_structure_step extends restore_structure_step {
1533     /** @var array Cache: Array of id => course format */
1534     private static $courseformats = array();
1536     /**
1537      * Resets a static cache of course formats. Required for unit testing.
1538      */
1539     public static function reset_caches() {
1540         self::$courseformats = array();
1541     }
1543     protected function define_structure() {
1544         global $CFG;
1546         $paths = array();
1548         $section = new restore_path_element('section', '/section');
1549         $paths[] = $section;
1550         if ($CFG->enableavailability) {
1551             $paths[] = new restore_path_element('availability', '/section/availability');
1552             $paths[] = new restore_path_element('availability_field', '/section/availability_field');
1553         }
1554         $paths[] = new restore_path_element('course_format_options', '/section/course_format_options');
1556         // Apply for 'format' plugins optional paths at section level
1557         $this->add_plugin_structure('format', $section);
1559         // Apply for 'local' plugins optional paths at section level
1560         $this->add_plugin_structure('local', $section);
1562         return $paths;
1563     }
1565     public function process_section($data) {
1566         global $CFG, $DB;
1567         $data = (object)$data;
1568         $oldid = $data->id; // We'll need this later
1570         $restorefiles = false;
1572         // Look for the section
1573         $section = new stdclass();
1574         $section->course  = $this->get_courseid();
1575         $section->section = $data->number;
1576         $section->timemodified = $data->timemodified ?? 0;
1577         // Section doesn't exist, create it with all the info from backup
1578         if (!$secrec = $DB->get_record('course_sections', ['course' => $this->get_courseid(), 'section' => $data->number])) {
1579             $section->name = $data->name;
1580             $section->summary = $data->summary;
1581             $section->summaryformat = $data->summaryformat;
1582             $section->sequence = '';
1583             $section->visible = $data->visible;
1584             if (empty($CFG->enableavailability)) { // Process availability information only if enabled.
1585                 $section->availability = null;
1586             } else {
1587                 $section->availability = isset($data->availabilityjson) ? $data->availabilityjson : null;
1588                 // Include legacy [<2.7] availability data if provided.
1589                 if (is_null($section->availability)) {
1590                     $section->availability = \core_availability\info::convert_legacy_fields(
1591                             $data, true);
1592                 }
1593             }
1594             $newitemid = $DB->insert_record('course_sections', $section);
1595             $section->id = $newitemid;
1597             core\event\course_section_created::create_from_section($section)->trigger();
1599             $restorefiles = true;
1601         // Section exists, update non-empty information
1602         } else {
1603             $section->id = $secrec->id;
1604             if ((string)$secrec->name === '') {
1605                 $section->name = $data->name;
1606             }
1607             if (empty($secrec->summary)) {
1608                 $section->summary = $data->summary;
1609                 $section->summaryformat = $data->summaryformat;
1610                 $restorefiles = true;
1611             }
1613             // Don't update availability (I didn't see a useful way to define
1614             // whether existing or new one should take precedence).
1616             $DB->update_record('course_sections', $section);
1617             $newitemid = $secrec->id;
1619             // Trigger an event for course section update.
1620             $event = \core\event\course_section_updated::create(
1621                 array(
1622                     'objectid' => $section->id,
1623                     'courseid' => $section->course,
1624                     'context' => context_course::instance($section->course),
1625                     'other' => array('sectionnum' => $section->section)
1626                 )
1627             );
1628             $event->trigger();
1629         }
1631         // Annotate the section mapping, with restorefiles option if needed
1632         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
1634         // set the new course_section id in the task
1635         $this->task->set_sectionid($newitemid);
1637         // If there is the legacy showavailability data, store this for later use.
1638         // (This data is not present when restoring 'new' backups.)
1639         if (isset($data->showavailability)) {
1640             // Cache the showavailability flag using the backup_ids data field.
1641             restore_dbops::set_backup_ids_record($this->get_restoreid(),
1642                     'section_showavailability', $newitemid, 0, null,
1643                     (object)array('showavailability' => $data->showavailability));
1644         }
1646         // Commented out. We never modify course->numsections as far as that is used
1647         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
1648         // Note: We keep the code here, to know about and because of the possibility of making this
1649         // optional based on some setting/attribute in the future
1650         // If needed, adjust course->numsections
1651         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
1652         //    if ($numsections < $section->section) {
1653         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
1654         //    }
1655         //}
1656     }
1658     /**
1659      * Process the legacy availability table record. This table does not exist
1660      * in Moodle 2.7+ but we still support restore.
1661      *
1662      * @param stdClass $data Record data
1663      */
1664     public function process_availability($data) {
1665         $data = (object)$data;
1666         // Simply going to store the whole availability record now, we'll process
1667         // all them later in the final task (once all activities have been restored)
1668         // Let's call the low level one to be able to store the whole object.
1669         $data->coursesectionid = $this->task->get_sectionid();
1670         restore_dbops::set_backup_ids_record($this->get_restoreid(),
1671                 'section_availability', $data->id, 0, null, $data);
1672     }
1674     /**
1675      * Process the legacy availability fields table record. This table does not
1676      * exist in Moodle 2.7+ but we still support restore.
1677      *
1678      * @param stdClass $data Record data
1679      */
1680     public function process_availability_field($data) {
1681         global $DB;
1682         $data = (object)$data;
1683         // Mark it is as passed by default
1684         $passed = true;
1685         $customfieldid = null;
1687         // If a customfield has been used in order to pass we must be able to match an existing
1688         // customfield by name (data->customfield) and type (data->customfieldtype)
1689         if (is_null($data->customfield) xor is_null($data->customfieldtype)) {
1690             // xor is sort of uncommon. If either customfield is null or customfieldtype is null BUT not both.
1691             // If one is null but the other isn't something clearly went wrong and we'll skip this condition.
1692             $passed = false;
1693         } else if (!is_null($data->customfield)) {
1694             $params = array('shortname' => $data->customfield, 'datatype' => $data->customfieldtype);
1695             $customfieldid = $DB->get_field('user_info_field', 'id', $params);
1696             $passed = ($customfieldid !== false);
1697         }
1699         if ($passed) {
1700             // Create the object to insert into the database
1701             $availfield = new stdClass();
1702             $availfield->coursesectionid = $this->task->get_sectionid();
1703             $availfield->userfield = $data->userfield;
1704             $availfield->customfieldid = $customfieldid;
1705             $availfield->operator = $data->operator;
1706             $availfield->value = $data->value;
1708             // Get showavailability option.
1709             $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
1710                     'section_showavailability', $availfield->coursesectionid);
1711             if (!$showrec) {
1712                 // Should not happen.
1713                 throw new coding_exception('No matching showavailability record');
1714             }
1715             $show = $showrec->info->showavailability;
1717             // The $availfield object is now in the format used in the old
1718             // system. Interpret this and convert to new system.
1719             $currentvalue = $DB->get_field('course_sections', 'availability',
1720                     array('id' => $availfield->coursesectionid), MUST_EXIST);
1721             $newvalue = \core_availability\info::add_legacy_availability_field_condition(
1722                     $currentvalue, $availfield, $show);
1724             $section = new stdClass();
1725             $section->id = $availfield->coursesectionid;
1726             $section->availability = $newvalue;
1727             $section->timemodified = time();
1728             $DB->update_record('course_sections', $section);
1729         }
1730     }
1732     public function process_course_format_options($data) {
1733         global $DB;
1734         $courseid = $this->get_courseid();
1735         if (!array_key_exists($courseid, self::$courseformats)) {
1736             // It is safe to have a static cache of course formats because format can not be changed after this point.
1737             self::$courseformats[$courseid] = $DB->get_field('course', 'format', array('id' => $courseid));
1738         }
1739         $data = (array)$data;
1740         if (self::$courseformats[$courseid] === $data['format']) {
1741             // Import section format options only if both courses (the one that was backed up
1742             // and the one we are restoring into) have same formats.
1743             $params = array(
1744                 'courseid' => $this->get_courseid(),
1745                 'sectionid' => $this->task->get_sectionid(),
1746                 'format' => $data['format'],
1747                 'name' => $data['name']
1748             );
1749             if ($record = $DB->get_record('course_format_options', $params, 'id, value')) {
1750                 // Do not overwrite existing information.
1751                 $newid = $record->id;
1752             } else {
1753                 $params['value'] = $data['value'];
1754                 $newid = $DB->insert_record('course_format_options', $params);
1755             }
1756             $this->set_mapping('course_format_options', $data['id'], $newid);
1757         }
1758     }
1760     protected function after_execute() {
1761         // Add section related files, with 'course_section' itemid to match
1762         $this->add_related_files('course', 'section', 'course_section');
1763     }
1766 /**
1767  * Structure step that will read the course.xml file, loading it and performing
1768  * various actions depending of the site/restore settings. Note that target
1769  * course always exist before arriving here so this step will be updating
1770  * the course record (never inserting)
1771  */
1772 class restore_course_structure_step extends restore_structure_step {
1773     /**
1774      * @var bool this gets set to true by {@link process_course()} if we are
1775      * restoring an old coures that used the legacy 'module security' feature.
1776      * If so, we have to do more work in {@link after_execute()}.
1777      */
1778     protected $legacyrestrictmodules = false;
1780     /**
1781      * @var array Used when {@link $legacyrestrictmodules} is true. This is an
1782      * array with array keys the module names ('forum', 'quiz', etc.). These are
1783      * the modules that are allowed according to the data in the backup file.
1784      * In {@link after_execute()} we then have to prevent adding of all the other
1785      * types of activity.
1786      */
1787     protected $legacyallowedmodules = array();
1789     protected function define_structure() {
1791         $course = new restore_path_element('course', '/course');
1792         $category = new restore_path_element('category', '/course/category');
1793         $tag = new restore_path_element('tag', '/course/tags/tag');
1794         $customfield = new restore_path_element('customfield', '/course/customfields/customfield');
1795         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1797         // Apply for 'format' plugins optional paths at course level
1798         $this->add_plugin_structure('format', $course);
1800         // Apply for 'theme' plugins optional paths at course level
1801         $this->add_plugin_structure('theme', $course);
1803         // Apply for 'report' plugins optional paths at course level
1804         $this->add_plugin_structure('report', $course);
1806         // Apply for 'course report' plugins optional paths at course level
1807         $this->add_plugin_structure('coursereport', $course);
1809         // Apply for plagiarism plugins optional paths at course level
1810         $this->add_plugin_structure('plagiarism', $course);
1812         // Apply for local plugins optional paths at course level
1813         $this->add_plugin_structure('local', $course);
1815         // Apply for admin tool plugins optional paths at course level.
1816         $this->add_plugin_structure('tool', $course);
1818         return array($course, $category, $tag, $customfield, $allowed_module);
1819     }
1821     /**
1822      * Processing functions go here
1823      *
1824      * @global moodledatabase $DB
1825      * @param stdClass $data
1826      */
1827     public function process_course($data) {
1828         global $CFG, $DB;
1829         $context = context::instance_by_id($this->task->get_contextid());
1830         $userid = $this->task->get_userid();
1831         $target = $this->get_task()->get_target();
1832         $isnewcourse = $target == backup::TARGET_NEW_COURSE;
1834         // When restoring to a new course we can set all the things except for the ID number.
1835         $canchangeidnumber = $isnewcourse || has_capability('moodle/course:changeidnumber', $context, $userid);
1836         $canchangesummary = $isnewcourse || has_capability('moodle/course:changesummary', $context, $userid);
1837         $canforcelanguage = has_capability('moodle/course:setforcedlanguage', $context, $userid);
1839         $data = (object)$data;
1840         $data->id = $this->get_courseid();
1842         // Calculate final course names, to avoid dupes.
1843         $fullname  = $this->get_setting_value('course_fullname');
1844         $shortname = $this->get_setting_value('course_shortname');
1845         list($data->fullname, $data->shortname) = restore_dbops::calculate_course_names($this->get_courseid(),
1846             $fullname === false ? $data->fullname : $fullname,
1847             $shortname === false ? $data->shortname : $shortname);
1848         // Do not modify the course names at all when merging and user selected to keep the names (or prohibited by cap).
1849         if (!$isnewcourse && $fullname === false) {
1850             unset($data->fullname);
1851         }
1852         if (!$isnewcourse && $shortname === false) {
1853             unset($data->shortname);
1854         }
1856         // Unset summary if user can't change it.
1857         if (!$canchangesummary) {
1858             unset($data->summary);
1859             unset($data->summaryformat);
1860         }
1862         // Unset lang if user can't change it.
1863         if (!$canforcelanguage) {
1864             unset($data->lang);
1865         }
1867         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1868         // another course on this site.
1869         if (!empty($data->idnumber) && $canchangeidnumber && $this->task->is_samesite()
1870                 && !$DB->record_exists('course', array('idnumber' => $data->idnumber))) {
1871             // Do not reset idnumber.
1873         } else if (!$isnewcourse) {
1874             // Prevent override when restoring as merge.
1875             unset($data->idnumber);
1877         } else {
1878             $data->idnumber = '';
1879         }
1881         // Any empty value for course->hiddensections will lead to 0 (default, show collapsed).
1882         // It has been reported that some old 1.9 courses may have it null leading to DB error. MDL-31532
1883         if (empty($data->hiddensections)) {
1884             $data->hiddensections = 0;
1885         }
1887         // Set legacyrestrictmodules to true if the course was resticting modules. If so
1888         // then we will need to process restricted modules after execution.
1889         $this->legacyrestrictmodules = !empty($data->restrictmodules);
1891         $data->startdate= $this->apply_date_offset($data->startdate);
1892         if (isset($data->enddate)) {
1893             $data->enddate = $this->apply_date_offset($data->enddate);
1894         }
1896         if ($data->defaultgroupingid) {
1897             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1898         }
1899         if (empty($CFG->enablecompletion)) {
1900             $data->enablecompletion = 0;
1901             $data->completionstartonenrol = 0;
1902             $data->completionnotify = 0;
1903         }
1904         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1905         if (isset($data->lang) && !array_key_exists($data->lang, $languages)) {
1906             $data->lang = '';
1907         }
1909         $themes = get_list_of_themes(); // Get themes for quick search later
1910         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1911             $data->theme = '';
1912         }
1914         // Check if this is an old SCORM course format.
1915         if ($data->format == 'scorm') {
1916             $data->format = 'singleactivity';
1917             $data->activitytype = 'scorm';
1918         }
1920         // Course record ready, update it
1921         $DB->update_record('course', $data);
1923         course_get_format($data)->update_course_format_options($data);
1925         // Role name aliases
1926         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1927     }
1929     public function process_category($data) {
1930         // Nothing to do with the category. UI sets it before restore starts
1931     }
1933     public function process_tag($data) {
1934         global $CFG, $DB;
1936         $data = (object)$data;
1938         core_tag_tag::add_item_tag('core', 'course', $this->get_courseid(),
1939                 context_course::instance($this->get_courseid()), $data->rawname);
1940     }
1942     /**
1943      * Process custom fields
1944      *
1945      * @param array $data
1946      */
1947     public function process_customfield($data) {
1948         $handler = core_course\customfield\course_handler::create();
1949         $handler->restore_instance_data_from_backup($this->task, $data);
1950     }
1952     public function process_allowed_module($data) {
1953         $data = (object)$data;
1955         // Backwards compatiblity support for the data that used to be in the
1956         // course_allowed_modules table.
1957         if ($this->legacyrestrictmodules) {
1958             $this->legacyallowedmodules[$data->modulename] = 1;
1959         }
1960     }
1962     protected function after_execute() {
1963         global $DB;
1965         // Add course related files, without itemid to match
1966         $this->add_related_files('course', 'summary', null);
1967         $this->add_related_files('course', 'overviewfiles', null);
1969         // Deal with legacy allowed modules.
1970         if ($this->legacyrestrictmodules) {
1971             $context = context_course::instance($this->get_courseid());
1973             list($roleids) = get_roles_with_cap_in_context($context, 'moodle/course:manageactivities');
1974             list($managerroleids) = get_roles_with_cap_in_context($context, 'moodle/site:config');
1975             foreach ($managerroleids as $roleid) {
1976                 unset($roleids[$roleid]);
1977             }
1979             foreach (core_component::get_plugin_list('mod') as $modname => $notused) {
1980                 if (isset($this->legacyallowedmodules[$modname])) {
1981                     // Module is allowed, no worries.
1982                     continue;
1983                 }
1985                 $capability = 'mod/' . $modname . ':addinstance';
1987                 if (!get_capability_info($capability)) {
1988                     $this->log("Capability '{$capability}' was not found!", backup::LOG_WARNING);
1989                     continue;
1990                 }
1992                 foreach ($roleids as $roleid) {
1993                     assign_capability($capability, CAP_PREVENT, $roleid, $context);
1994                 }
1995             }
1996         }
1997     }
2000 /**
2001  * Execution step that will migrate legacy files if present.
2002  */
2003 class restore_course_legacy_files_step extends restore_execution_step {
2004     public function define_execution() {
2005         global $DB;
2007         // Do a check for legacy files and skip if there are none.
2008         $sql = 'SELECT count(*)
2009                   FROM {backup_files_temp}
2010                  WHERE backupid = ?
2011                    AND contextid = ?
2012                    AND component = ?
2013                    AND filearea  = ?';
2014         $params = array($this->get_restoreid(), $this->task->get_old_contextid(), 'course', 'legacy');
2016         if ($DB->count_records_sql($sql, $params)) {
2017             $DB->set_field('course', 'legacyfiles', 2, array('id' => $this->get_courseid()));
2018             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'course',
2019                 'legacy', $this->task->get_old_contextid(), $this->task->get_userid());
2020         }
2021     }
2024 /*
2025  * Structure step that will read the roles.xml file (at course/activity/block levels)
2026  * containing all the role_assignments and overrides for that context. If corresponding to
2027  * one mapped role, they will be applied to target context. Will observe the role_assignments
2028  * setting to decide if ras are restored.
2029  *
2030  * Note: this needs to be executed after all users are enrolled.
2031  */
2032 class restore_ras_and_caps_structure_step extends restore_structure_step {
2033     protected $plugins = null;
2035     protected function define_structure() {
2037         $paths = array();
2039         // Observe the role_assignments setting
2040         if ($this->get_setting_value('role_assignments')) {
2041             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
2042         }
2043         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
2045         return $paths;
2046     }
2048     /**
2049      * Assign roles
2050      *
2051      * This has to be called after enrolments processing.
2052      *
2053      * @param mixed $data
2054      * @return void
2055      */
2056     public function process_assignment($data) {
2057         global $DB;
2059         $data = (object)$data;
2061         // Check roleid, userid are one of the mapped ones
2062         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
2063             return;
2064         }
2065         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
2066             return;
2067         }
2068         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
2069             // Only assign roles to not deleted users
2070             return;
2071         }
2072         if (!$contextid = $this->task->get_contextid()) {
2073             return;
2074         }
2076         if (empty($data->component)) {
2077             // assign standard manual roles
2078             // TODO: role_assign() needs one userid param to be able to specify our restore userid
2079             role_assign($newroleid, $newuserid, $contextid);
2081         } else if ((strpos($data->component, 'enrol_') === 0)) {
2082             // Deal with enrolment roles - ignore the component and just find out the instance via new id,
2083             // it is possible that enrolment was restored using different plugin type.
2084             if (!isset($this->plugins)) {
2085                 $this->plugins = enrol_get_plugins(true);
2086             }
2087             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
2088                 if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
2089                     if (isset($this->plugins[$instance->enrol])) {
2090                         $this->plugins[$instance->enrol]->restore_role_assignment($instance, $newroleid, $newuserid, $contextid);
2091                     }
2092                 }
2093             }
2095         } else {
2096             $data->roleid    = $newroleid;
2097             $data->userid    = $newuserid;
2098             $data->contextid = $contextid;
2099             $dir = core_component::get_component_directory($data->component);
2100             if ($dir and is_dir($dir)) {
2101                 if (component_callback($data->component, 'restore_role_assignment', array($this, $data), true)) {
2102                     return;
2103                 }
2104             }
2105             // Bad luck, plugin could not restore the data, let's add normal membership.
2106             role_assign($data->roleid, $data->userid, $data->contextid);
2107             $message = "Restore of '$data->component/$data->itemid' role assignments is not supported, using manual role assignments instead.";
2108             $this->log($message, backup::LOG_WARNING);
2109         }
2110     }
2112     public function process_override($data) {
2113         $data = (object)$data;
2115         // Check roleid is one of the mapped ones
2116         $newroleid = $this->get_mappingid('role', $data->roleid);
2117         // If newroleid and context are valid assign it via API (it handles dupes and so on)
2118         if ($newroleid && $this->task->get_contextid()) {
2119             if (!get_capability_info($data->capability)) {
2120                 $this->log("Capability '{$data->capability}' was not found!", backup::LOG_WARNING);
2121             } else {
2122                 // TODO: assign_capability() needs one userid param to be able to specify our restore userid.
2123                 assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
2124             }
2125         }
2126     }
2129 /**
2130  * If no instances yet add default enrol methods the same way as when creating new course in UI.
2131  */
2132 class restore_default_enrolments_step extends restore_execution_step {
2134     public function define_execution() {
2135         global $DB;
2137         // No enrolments in front page.
2138         if ($this->get_courseid() == SITEID) {
2139             return;
2140         }
2142         $course = $DB->get_record('course', array('id'=>$this->get_courseid()), '*', MUST_EXIST);
2144         if ($DB->record_exists('enrol', array('courseid'=>$this->get_courseid(), 'enrol'=>'manual'))) {
2145             // Something already added instances, do not add default instances.
2146             $plugins = enrol_get_plugins(true);
2147             foreach ($plugins as $plugin) {
2148                 $plugin->restore_sync_course($course);
2149             }
2151         } else {
2152             // Looks like a newly created course.
2153             enrol_course_updated(true, $course, null);
2154         }
2155     }
2158 /**
2159  * This structure steps restores the enrol plugins and their underlying
2160  * enrolments, performing all the mappings and/or movements required
2161  */
2162 class restore_enrolments_structure_step extends restore_structure_step {
2163     protected $enrolsynced = false;
2164     protected $plugins = null;
2165     protected $originalstatus = array();
2167     /**
2168      * Conditionally decide if this step should be executed.
2169      *
2170      * This function checks the following parameter:
2171      *
2172      *   1. the course/enrolments.xml file exists
2173      *
2174      * @return bool true is safe to execute, false otherwise
2175      */
2176     protected function execute_condition() {
2178         if ($this->get_courseid() == SITEID) {
2179             return false;
2180         }
2182         // Check it is included in the backup
2183         $fullpath = $this->task->get_taskbasepath();
2184         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2185         if (!file_exists($fullpath)) {
2186             // Not found, can't restore enrolments info
2187             return false;
2188         }
2190         return true;
2191     }
2193     protected function define_structure() {
2195         $userinfo = $this->get_setting_value('users');
2197         $paths = [];
2198         $paths[] = $enrol = new restore_path_element('enrol', '/enrolments/enrols/enrol');
2199         if ($userinfo) {
2200             $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
2201         }
2202         // Attach local plugin stucture to enrol element.
2203         $this->add_plugin_structure('enrol', $enrol);
2205         return $paths;
2206     }
2208     /**
2209      * Create enrolment instances.
2210      *
2211      * This has to be called after creation of roles
2212      * and before adding of role assignments.
2213      *
2214      * @param mixed $data
2215      * @return void
2216      */
2217     public function process_enrol($data) {
2218         global $DB;
2220         $data = (object)$data;
2221         $oldid = $data->id; // We'll need this later.
2222         unset($data->id);
2224         $this->originalstatus[$oldid] = $data->status;
2226         if (!$courserec = $DB->get_record('course', array('id' => $this->get_courseid()))) {
2227             $this->set_mapping('enrol', $oldid, 0);
2228             return;
2229         }
2231         if (!isset($this->plugins)) {
2232             $this->plugins = enrol_get_plugins(true);
2233         }
2235         if (!$this->enrolsynced) {
2236             // Make sure that all plugin may create instances and enrolments automatically
2237             // before the first instance restore - this is suitable especially for plugins
2238             // that synchronise data automatically using course->idnumber or by course categories.
2239             foreach ($this->plugins as $plugin) {
2240                 $plugin->restore_sync_course($courserec);
2241             }
2242             $this->enrolsynced = true;
2243         }
2245         // Map standard fields - plugin has to process custom fields manually.
2246         $data->roleid   = $this->get_mappingid('role', $data->roleid);
2247         $data->courseid = $courserec->id;
2249         if (!$this->get_setting_value('users') && $this->get_setting_value('enrolments') == backup::ENROL_WITHUSERS) {
2250             $converttomanual = true;
2251         } else {
2252             $converttomanual = ($this->get_setting_value('enrolments') == backup::ENROL_NEVER);
2253         }
2255         if ($converttomanual) {
2256             // Restore enrolments as manual enrolments.
2257             unset($data->sortorder); // Remove useless sortorder from <2.4 backups.
2258             if (!enrol_is_enabled('manual')) {
2259                 $this->set_mapping('enrol', $oldid, 0);
2260                 return;
2261             }
2262             if ($instances = $DB->get_records('enrol', array('courseid'=>$data->courseid, 'enrol'=>'manual'), 'id')) {
2263                 $instance = reset($instances);
2264                 $this->set_mapping('enrol', $oldid, $instance->id);
2265             } else {
2266                 if ($data->enrol === 'manual') {
2267                     $instanceid = $this->plugins['manual']->add_instance($courserec, (array)$data);
2268                 } else {
2269                     $instanceid = $this->plugins['manual']->add_default_instance($courserec);
2270                 }
2271                 $this->set_mapping('enrol', $oldid, $instanceid);
2272             }
2274         } else {
2275             if (!enrol_is_enabled($data->enrol) or !isset($this->plugins[$data->enrol])) {
2276                 $this->set_mapping('enrol', $oldid, 0);
2277                 $message = "Enrol plugin '$data->enrol' data can not be restored because it is not enabled, consider restoring without enrolment methods";
2278                 $this->log($message, backup::LOG_WARNING);
2279                 return;
2280             }
2281             if ($task = $this->get_task() and $task->get_target() == backup::TARGET_NEW_COURSE) {
2282                 // Let's keep the sortorder in old backups.
2283             } else {
2284                 // Prevent problems with colliding sortorders in old backups,
2285                 // new 2.4 backups do not need sortorder because xml elements are ordered properly.
2286                 unset($data->sortorder);
2287             }
2288             // Note: plugin is responsible for setting up the mapping, it may also decide to migrate to different type.
2289             $this->plugins[$data->enrol]->restore_instance($this, $data, $courserec, $oldid);
2290         }
2291     }
2293     /**
2294      * Create user enrolments.
2295      *
2296      * This has to be called after creation of enrolment instances
2297      * and before adding of role assignments.
2298      *
2299      * Roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing afterwards.
2300      *
2301      * @param mixed $data
2302      * @return void
2303      */
2304     public function process_enrolment($data) {
2305         global $DB;
2307         if (!isset($this->plugins)) {
2308             $this->plugins = enrol_get_plugins(true);
2309         }
2311         $data = (object)$data;
2313         // Process only if parent instance have been mapped.
2314         if ($enrolid = $this->get_new_parentid('enrol')) {
2315             $oldinstancestatus = ENROL_INSTANCE_ENABLED;
2316             $oldenrolid = $this->get_old_parentid('enrol');
2317             if (isset($this->originalstatus[$oldenrolid])) {
2318                 $oldinstancestatus = $this->originalstatus[$oldenrolid];
2319             }
2320             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
2321                 // And only if user is a mapped one.
2322                 if ($userid = $this->get_mappingid('user', $data->userid)) {
2323                     if (isset($this->plugins[$instance->enrol])) {
2324                         $this->plugins[$instance->enrol]->restore_user_enrolment($this, $data, $instance, $userid, $oldinstancestatus);
2325                     }
2326                 }
2327             }
2328         }
2329     }
2333 /**
2334  * Make sure the user restoring the course can actually access it.
2335  */
2336 class restore_fix_restorer_access_step extends restore_execution_step {
2337     protected function define_execution() {
2338         global $CFG, $DB;
2340         if (!$userid = $this->task->get_userid()) {
2341             return;
2342         }
2344         if (empty($CFG->restorernewroleid)) {
2345             // Bad luck, no fallback role for restorers specified
2346             return;
2347         }
2349         $courseid = $this->get_courseid();
2350         $context = context_course::instance($courseid);
2352         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
2353             // Current user may access the course (admin, category manager or restored teacher enrolment usually)
2354             return;
2355         }
2357         // Try to add role only - we do not need enrolment if user has moodle/course:view or is already enrolled
2358         role_assign($CFG->restorernewroleid, $userid, $context);
2360         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
2361             // Extra role is enough, yay!
2362             return;
2363         }
2365         // The last chance is to create manual enrol if it does not exist and and try to enrol the current user,
2366         // hopefully admin selected suitable $CFG->restorernewroleid ...
2367         if (!enrol_is_enabled('manual')) {
2368             return;
2369         }
2370         if (!$enrol = enrol_get_plugin('manual')) {
2371             return;
2372         }
2373         if (!$DB->record_exists('enrol', array('enrol'=>'manual', 'courseid'=>$courseid))) {
2374             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
2375             $fields = array('status'=>ENROL_INSTANCE_ENABLED, 'enrolperiod'=>$enrol->get_config('enrolperiod', 0), 'roleid'=>$enrol->get_config('roleid', 0));
2376             $enrol->add_instance($course, $fields);
2377         }
2379         enrol_try_internal_enrol($courseid, $userid);
2380     }
2384 /**
2385  * This structure steps restores the filters and their configs
2386  */
2387 class restore_filters_structure_step extends restore_structure_step {
2389     protected function define_structure() {
2391         $paths = array();
2393         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
2394         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
2396         return $paths;
2397     }
2399     public function process_active($data) {
2401         $data = (object)$data;
2403         if (strpos($data->filter, 'filter/') === 0) {
2404             $data->filter = substr($data->filter, 7);
2406         } else if (strpos($data->filter, '/') !== false) {
2407             // Unsupported old filter.
2408             return;
2409         }
2411         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
2412             return;
2413         }
2414         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
2415     }
2417     public function process_config($data) {
2419         $data = (object)$data;
2421         if (strpos($data->filter, 'filter/') === 0) {
2422             $data->filter = substr($data->filter, 7);
2424         } else if (strpos($data->filter, '/') !== false) {
2425             // Unsupported old filter.
2426             return;
2427         }
2429         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
2430             return;
2431         }
2432         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
2433     }
2437 /**
2438  * This structure steps restores the comments
2439  * Note: Cannot use the comments API because defaults to USER->id.
2440  * That should change allowing to pass $userid
2441  */
2442 class restore_comments_structure_step extends restore_structure_step {
2444     protected function define_structure() {
2446         $paths = array();
2448         $paths[] = new restore_path_element('comment', '/comments/comment');
2450         return $paths;
2451     }
2453     public function process_comment($data) {
2454         global $DB;
2456         $data = (object)$data;
2458         // First of all, if the comment has some itemid, ask to the task what to map
2459         $mapping = false;
2460         if ($data->itemid) {
2461             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
2462             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
2463         }
2464         // Only restore the comment if has no mapping OR we have found the matching mapping
2465         if (!$mapping || $data->itemid) {
2466             // Only if user mapping and context
2467             $data->userid = $this->get_mappingid('user', $data->userid);
2468             if ($data->userid && $this->task->get_contextid()) {
2469                 $data->contextid = $this->task->get_contextid();
2470                 // Only if there is another comment with same context/user/timecreated
2471                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
2472                 if (!$DB->record_exists('comments', $params)) {
2473                     $DB->insert_record('comments', $data);
2474                 }
2475             }
2476         }
2477     }
2480 /**
2481  * This structure steps restores the badges and their configs
2482  */
2483 class restore_badges_structure_step extends restore_structure_step {
2485     /**
2486      * Conditionally decide if this step should be executed.
2487      *
2488      * This function checks the following parameters:
2489      *
2490      *   1. Badges and course badges are enabled on the site.
2491      *   2. The course/badges.xml file exists.
2492      *   3. All modules are restorable.
2493      *   4. All modules are marked for restore.
2494      *
2495      * @return bool True is safe to execute, false otherwise
2496      */
2497     protected function execute_condition() {
2498         global $CFG;
2500         // First check is badges and course level badges are enabled on this site.
2501         if (empty($CFG->enablebadges) || empty($CFG->badges_allowcoursebadges)) {
2502             // Disabled, don't restore course badges.
2503             return false;
2504         }
2506         // Check if badges.xml is included in the backup.
2507         $fullpath = $this->task->get_taskbasepath();
2508         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2509         if (!file_exists($fullpath)) {
2510             // Not found, can't restore course badges.
2511             return false;
2512         }
2514         // Check we are able to restore all backed up modules.
2515         if ($this->task->is_missing_modules()) {
2516             return false;
2517         }
2519         // Finally check all modules within the backup are being restored.
2520         if ($this->task->is_excluding_activities()) {
2521             return false;
2522         }
2524         return true;
2525     }
2527     protected function define_structure() {
2528         $paths = array();
2529         $paths[] = new restore_path_element('badge', '/badges/badge');
2530         $paths[] = new restore_path_element('criterion', '/badges/badge/criteria/criterion');
2531         $paths[] = new restore_path_element('parameter', '/badges/badge/criteria/criterion/parameters/parameter');
2532         $paths[] = new restore_path_element('endorsement', '/badges/badge/endorsement');
2533         $paths[] = new restore_path_element('alignment', '/badges/badge/alignments/alignment');
2534         $paths[] = new restore_path_element('relatedbadge', '/badges/badge/relatedbadges/relatedbadge');
2535         $paths[] = new restore_path_element('manual_award', '/badges/badge/manual_awards/manual_award');
2537         return $paths;
2538     }
2540     public function process_badge($data) {
2541         global $DB, $CFG;
2543         require_once($CFG->libdir . '/badgeslib.php');
2545         $data = (object)$data;
2546         $data->usercreated = $this->get_mappingid('user', $data->usercreated);
2547         if (empty($data->usercreated)) {
2548             $data->usercreated = $this->task->get_userid();
2549         }
2550         $data->usermodified = $this->get_mappingid('user', $data->usermodified);
2551         if (empty($data->usermodified)) {
2552             $data->usermodified = $this->task->get_userid();
2553         }
2555         // We'll restore the badge image.
2556         $restorefiles = true;
2558         $courseid = $this->get_courseid();
2560         $params = array(
2561                 'name'           => $data->name,
2562                 'description'    => $data->description,
2563                 'timecreated'    => $data->timecreated,
2564                 'timemodified'   => $data->timemodified,
2565                 'usercreated'    => $data->usercreated,
2566                 'usermodified'   => $data->usermodified,
2567                 'issuername'     => $data->issuername,
2568                 'issuerurl'      => $data->issuerurl,
2569                 'issuercontact'  => $data->issuercontact,
2570                 'expiredate'     => $this->apply_date_offset($data->expiredate),
2571                 'expireperiod'   => $data->expireperiod,
2572                 'type'           => BADGE_TYPE_COURSE,
2573                 'courseid'       => $courseid,
2574                 'message'        => $data->message,
2575                 'messagesubject' => $data->messagesubject,
2576                 'attachment'     => $data->attachment,
2577                 'notification'   => $data->notification,
2578                 'status'         => BADGE_STATUS_INACTIVE,
2579                 'nextcron'       => $data->nextcron,
2580                 'version'        => $data->version,
2581                 'language'       => $data->language,
2582                 'imageauthorname' => $data->imageauthorname,
2583                 'imageauthoremail' => $data->imageauthoremail,
2584                 'imageauthorurl' => $data->imageauthorurl,
2585                 'imagecaption'   => $data->imagecaption
2586         );
2588         $newid = $DB->insert_record('badge', $params);
2589         $this->set_mapping('badge', $data->id, $newid, $restorefiles);
2590     }
2592     /**
2593      * Create an endorsement for a badge.
2594      *
2595      * @param mixed $data
2596      * @return void
2597      */
2598     public function process_endorsement($data) {
2599         global $DB;
2601         $data = (object)$data;
2603         $params = [
2604             'badgeid' => $this->get_new_parentid('badge'),
2605             'issuername' => $data->issuername,
2606             'issuerurl' => $data->issuerurl,
2607             'issueremail' => $data->issueremail,
2608             'claimid' => $data->claimid,
2609             'claimcomment' => $data->claimcomment,
2610             'dateissued' => $this->apply_date_offset($data->dateissued)
2611         ];
2612         $newid = $DB->insert_record('badge_endorsement', $params);
2613         $this->set_mapping('endorsement', $data->id, $newid);
2614     }
2616     /**
2617      * Link to related badges for a badge. This relies on post processing in after_execute().
2618      *
2619      * @param mixed $data
2620      * @return void
2621      */
2622     public function process_relatedbadge($data) {
2623         global $DB;
2625         $data = (object)$data;
2626         $relatedbadgeid = $data->relatedbadgeid;
2628         if ($relatedbadgeid) {
2629             // Only backup and restore related badges if they are contained in the backup file.
2630             $params = array(
2631                     'badgeid'           => $this->get_new_parentid('badge'),
2632                     'relatedbadgeid'    => $relatedbadgeid
2633             );
2634             $newid = $DB->insert_record('badge_related', $params);
2635         }
2636     }
2638     /**
2639      * Link to an alignment for a badge.
2640      *
2641      * @param mixed $data
2642      * @return void
2643      */
2644     public function process_alignment($data) {
2645         global $DB;
2647         $data = (object)$data;
2648         $params = array(
2649                 'badgeid'           => $this->get_new_parentid('badge'),
2650                 'targetname'        => $data->targetname,
2651                 'targeturl'         => $data->targeturl,
2652                 'targetdescription' => $data->targetdescription,
2653                 'targetframework'   => $data->targetframework,
2654                 'targetcode'        => $data->targetcode
2655         );
2656         $newid = $DB->insert_record('badge_alignment', $params);
2657         $this->set_mapping('alignment', $data->id, $newid);
2658     }
2660     public function process_criterion($data) {
2661         global $DB;
2663         $data = (object)$data;
2665         $params = array(
2666                 'badgeid'           => $this->get_new_parentid('badge'),
2667                 'criteriatype'      => $data->criteriatype,
2668                 'method'            => $data->method,
2669                 'description'       => isset($data->description) ? $data->description : '',
2670                 'descriptionformat' => isset($data->descriptionformat) ? $data->descriptionformat : 0,
2671         );
2673         $newid = $DB->insert_record('badge_criteria', $params);
2674         $this->set_mapping('criterion', $data->id, $newid);
2675     }
2677     public function process_parameter($data) {
2678         global $DB, $CFG;
2680         require_once($CFG->libdir . '/badgeslib.php');
2682         $data = (object)$data;
2683         $criteriaid = $this->get_new_parentid('criterion');
2685         // Parameter array that will go to database.
2686         $params = array();
2687         $params['critid'] = $criteriaid;
2689         $oldparam = explode('_', $data->name);
2691         if ($data->criteriatype == BADGE_CRITERIA_TYPE_ACTIVITY) {
2692             $module = $this->get_mappingid('course_module', $oldparam[1]);
2693             $params['name'] = $oldparam[0] . '_' . $module;
2694             $params['value'] = $oldparam[0] == 'module' ? $module : $data->value;
2695         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_COURSE) {
2696             $params['name'] = $oldparam[0] . '_' . $this->get_courseid();
2697             $params['value'] = $oldparam[0] == 'course' ? $this->get_courseid() : $data->value;
2698         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_MANUAL) {
2699             $role = $this->get_mappingid('role', $data->value);
2700             if (!empty($role)) {
2701                 $params['name'] = 'role_' . $role;
2702                 $params['value'] = $role;
2703             } else {
2704                 return;
2705             }
2706         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_COMPETENCY) {
2707             $competencyid = $this->get_mappingid('competency', $data->value);
2708             if (!empty($competencyid)) {
2709                 $params['name'] = 'competency_' . $competencyid;
2710                 $params['value'] = $competencyid;
2711             } else {
2712                 return;
2713             }
2714         }
2716         if (!$DB->record_exists('badge_criteria_param', $params)) {
2717             $DB->insert_record('badge_criteria_param', $params);
2718         }
2719     }
2721     public function process_manual_award($data) {
2722         global $DB;
2724         $data = (object)$data;
2725         $role = $this->get_mappingid('role', $data->issuerrole);
2727         if (!empty($role)) {
2728             $award = array(
2729                 'badgeid'     => $this->get_new_parentid('badge'),
2730                 'recipientid' => $this->get_mappingid('user', $data->recipientid),
2731                 'issuerid'    => $this->get_mappingid('user', $data->issuerid),
2732                 'issuerrole'  => $role,
2733                 'datemet'     => $this->apply_date_offset($data->datemet)
2734             );
2736             // Skip the manual award if recipient or issuer can not be mapped to.
2737             if (empty($award['recipientid']) || empty($award['issuerid'])) {
2738                 return;
2739             }
2741             $DB->insert_record('badge_manual_award', $award);
2742         }
2743     }
2745     protected function after_execute() {
2746         global $DB;
2747         // Add related files.
2748         $this->add_related_files('badges', 'badgeimage', 'badge');
2750         $badgeid = $this->get_new_parentid('badge');
2751         // Remap any related badges.
2752         // We do this in the DB directly because this is backup/restore it is not valid to call into
2753         // the component API.
2754         $params = array('badgeid' => $badgeid);
2755         $query = "SELECT DISTINCT br.id, br.badgeid, br.relatedbadgeid
2756                     FROM {badge_related} br
2757                    WHERE (br.badgeid = :badgeid)";
2758         $relatedbadges = $DB->get_records_sql($query, $params);
2759         $newrelatedids = [];
2760         foreach ($relatedbadges as $relatedbadge) {
2761             $relatedid = $this->get_mappingid('badge', $relatedbadge->relatedbadgeid);
2762             $params['relatedbadgeid'] = $relatedbadge->relatedbadgeid;
2763             $DB->delete_records_select('badge_related', '(badgeid = :badgeid AND relatedbadgeid = :relatedbadgeid)', $params);
2764             if ($relatedid) {
2765                 $newrelatedids[] = $relatedid;
2766             }
2767         }
2768         if (!empty($newrelatedids)) {
2769             $relatedbadges = [];
2770             foreach ($newrelatedids as $relatedid) {
2771                 $relatedbadge = new stdClass();
2772                 $relatedbadge->badgeid = $badgeid;
2773                 $relatedbadge->relatedbadgeid = $relatedid;
2774                 $relatedbadges[] = $relatedbadge;
2775             }
2776             $DB->insert_records('badge_related', $relatedbadges);
2777         }
2778     }
2781 /**
2782  * This structure steps restores the calendar events
2783  */
2784 class restore_calendarevents_structure_step extends restore_structure_step {
2786     protected function define_structure() {
2788         $paths = array();
2790         $paths[] = new restore_path_element('calendarevents', '/events/event');
2792         return $paths;
2793     }
2795     public function process_calendarevents($data) {
2796         global $DB, $SITE, $USER;
2798         $data = (object)$data;
2799         $oldid = $data->id;
2800         $restorefiles = true; // We'll restore the files
2802         // If this is a new action event, it will automatically be populated by the adhoc task.
2803         // Nothing to do here.
2804         if (isset($data->type) && $data->type == CALENDAR_EVENT_TYPE_ACTION) {
2805             return;
2806         }
2808         // User overrides for activities are identified by having a courseid of zero with
2809         // both a modulename and instance value set.
2810         $isuseroverride = !$data->courseid && $data->modulename && $data->instance;
2812         // If we don't want to include user data and this record is a user override event
2813         // for an activity then we should not create it. (Only activity events can be user override events - which must have this
2814         // setting).
2815         if ($isuseroverride && $this->task->setting_exists('userinfo') && !$this->task->get_setting_value('userinfo')) {
2816             return;
2817         }
2819         // Find the userid and the groupid associated with the event.
2820         $data->userid = $this->get_mappingid('user', $data->userid);
2821         if ($data->userid === false) {
2822             // Blank user ID means that we are dealing with module generated events such as quiz starting times.
2823             // Use the current user ID for these events.
2824             $data->userid = $USER->id;
2825         }
2826         if (!empty($data->groupid)) {
2827             $data->groupid = $this->get_mappingid('group', $data->groupid);
2828             if ($data->groupid === false) {
2829                 return;
2830             }
2831         }
2832         // Handle events with empty eventtype //MDL-32827
2833         if(empty($data->eventtype)) {
2834             if ($data->courseid == $SITE->id) {                                // Site event
2835                 $data->eventtype = "site";
2836             } else if ($data->courseid != 0 && $data->groupid == 0 && ($data->modulename == 'assignment' || $data->modulename == 'assign')) {
2837                 // Course assingment event
2838                 $data->eventtype = "due";
2839             } else if ($data->courseid != 0 && $data->groupid == 0) {      // Course event
2840                 $data->eventtype = "course";
2841             } else if ($data->groupid) {                                      // Group event
2842                 $data->eventtype = "group";
2843             } else if ($data->userid) {                                       // User event
2844                 $data->eventtype = "user";
2845             } else {
2846                 return;
2847             }
2848         }
2850         $params = array(
2851                 'name'           => $data->name,
2852                 'description'    => $data->description,
2853                 'format'         => $data->format,
2854                 // User overrides in activities use a course id of zero. All other event types
2855                 // must use the mapped course id.
2856                 'courseid'       => $data->courseid ? $this->get_courseid() : 0,
2857                 'groupid'        => $data->groupid,
2858                 'userid'         => $data->userid,
2859                 'repeatid'       => $this->get_mappingid('event', $data->repeatid),
2860                 'modulename'     => $data->modulename,
2861                 'type'           => isset($data->type) ? $data->type : 0,
2862                 'eventtype'      => $data->eventtype,
2863                 'timestart'      => $this->apply_date_offset($data->timestart),
2864                 'timeduration'   => $data->timeduration,
2865                 'timesort'       => isset($data->timesort) ? $this->apply_date_offset($data->timesort) : null,
2866                 'visible'        => $data->visible,
2867                 'uuid'           => $data->uuid,
2868                 'sequence'       => $data->sequence,
2869                 'timemodified'   => $data->timemodified,
2870                 'priority'       => isset($data->priority) ? $data->priority : null,
2871                 'location'       => isset($data->location) ? $data->location : null);
2872         if ($this->name == 'activity_calendar') {
2873             $params['instance'] = $this->task->get_activityid();
2874         } else {
2875             $params['instance'] = 0;
2876         }
2877         $sql = "SELECT id
2878                   FROM {event}
2879                  WHERE " . $DB->sql_compare_text('name', 255) . " = " . $DB->sql_compare_text('?', 255) . "
2880                    AND courseid = ?
2881                    AND modulename = ?
2882                    AND instance = ?
2883                    AND timestart = ?
2884                    AND timeduration = ?
2885                    AND " . $DB->sql_compare_text('description', 255) . " = " . $DB->sql_compare_text('?', 255);
2886         $arg = array ($params['name'], $params['courseid'], $params['modulename'], $params['instance'], $params['timestart'], $params['timeduration'], $params['description']);
2887         $result = $DB->record_exists_sql($sql, $arg);
2888         if (empty($result)) {
2889             $newitemid = $DB->insert_record('event', $params);
2890             $this->set_mapping('event', $oldid, $newitemid);
2891             $this->set_mapping('event_description', $oldid, $newitemid, $restorefiles);
2892         }
2893         // With repeating events, each event has the repeatid pointed at the first occurrence.
2894         // Since the repeatid will be empty when the first occurrence is restored,
2895         // Get the repeatid from the second occurrence of the repeating event and use that to update the first occurrence.
2896         // Then keep a list of repeatids so we only perform this update once.
2897         static $repeatids = array();
2898         if (!empty($params['repeatid']) && !in_array($params['repeatid'], $repeatids)) {
2899             // This entry is repeated so the repeatid field must be set.
2900             $DB->set_field('event', 'repeatid', $params['repeatid'], array('id' => $params['repeatid']));
2901             $repeatids[] = $params['repeatid'];
2902         }
2904     }
2905     protected function after_execute() {
2906         // Add related files
2907         $this->add_related_files('calendar', 'event_description', 'event_description');
2908     }
2911 class restore_course_completion_structure_step extends restore_structure_step {
2913     /**
2914      * Conditionally decide if this step should be executed.
2915      *
2916      * This function checks parameters that are not immediate settings to ensure
2917      * that the enviroment is suitable for the restore of course completion info.
2918      *
2919      * This function checks the following four parameters:
2920      *
2921      *   1. Course completion is enabled on the site
2922      *   2. The backup includes course completion information
2923      *   3. All modules are restorable
2924      *   4. All modules are marked for restore.
2925      *   5. No completion criteria already exist for the course.
2926      *
2927      * @return bool True is safe to execute, false otherwise
2928      */
2929     protected function execute_condition() {
2930         global $CFG, $DB;
2932         // First check course completion is enabled on this site
2933         if (empty($CFG->enablecompletion)) {
2934             // Disabled, don't restore course completion
2935             return false;
2936         }
2938         // No course completion on the front page.
2939         if ($this->get_courseid() == SITEID) {
2940             return false;
2941         }
2943         // Check it is included in the backup
2944         $fullpath = $this->task->get_taskbasepath();
2945         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2946         if (!file_exists($fullpath)) {
2947             // Not found, can't restore course completion
2948             return false;
2949         }
2951         // Check we are able to restore all backed up modules
2952         if ($this->task->is_missing_modules()) {
2953             return false;
2954         }
2956         // Check all modules within the backup are being restored.
2957         if ($this->task->is_excluding_activities()) {
2958             return false;
2959         }
2961         // Check that no completion criteria is already set for the course.
2962         if ($DB->record_exists('course_completion_criteria', array('course' => $this->get_courseid()))) {
2963             return false;
2964         }
2966         return true;
2967     }
2969     /**
2970      * Define the course completion structure
2971      *
2972      * @return array Array of restore_path_element
2973      */
2974     protected function define_structure() {
2976         // To know if we are including user completion info
2977         $userinfo = $this->get_setting_value('userscompletion');
2979         $paths = array();
2980         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
2981         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
2983         if ($userinfo) {
2984             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
2985             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
2986         }
2988         return $paths;
2990     }
2992     /**
2993      * Process course completion criteria
2994      *
2995      * @global moodle_database $DB
2996      * @param stdClass $data
2997      */
2998     public function process_course_completion_criteria($data) {
2999         global $DB;
3001         $data = (object)$data;
3002         $data->course = $this->get_courseid();
3004         // Apply the date offset to the time end field
3005         $data->timeend = $this->apply_date_offset($data->timeend);
3007         // Map the role from the criteria
3008         if (isset($data->role) && $data->role != '') {
3009             // Newer backups should include roleshortname, which makes this much easier.
3010             if (!empty($data->roleshortname)) {
3011                 $roleinstanceid = $DB->get_field('role', 'id', array('shortname' => $data->roleshortname));
3012                 if (!$roleinstanceid) {
3013                     $this->log(
3014                         'Could not match the role shortname in course_completion_criteria, so skipping',
3015                         backup::LOG_DEBUG
3016                     );
3017                     return;
3018                 }
3019                 $data->role = $roleinstanceid;
3020             } else {
3021                 $data->role = $this->get_mappingid('role', $data->role);
3022             }
3024             // Check we have an id, otherwise it causes all sorts of bugs.
3025             if (!$data->role) {
3026                 $this->log(
3027                     'Could not match role in course_completion_criteria, so skipping',
3028                     backup::LOG_DEBUG
3029                 );
3030                 return;
3031             }
3032         }
3034         // If the completion criteria is for a module we need to map the module instance
3035         // to the new module id.
3036         if (!empty($data->moduleinstance) && !empty($data->module)) {
3037             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
3038             if (empty($data->moduleinstance)) {
3039                 $this->log(
3040                     'Could not match the module instance in course_completion_criteria, so skipping',
3041                     backup::LOG_DEBUG
3042                 );
3043                 return;
3044             }
3045         } else {
3046             $data->module = null;
3047             $data->moduleinstance = null;
3048         }
3050         // We backup the course shortname rather than the ID so that we can match back to the course
3051         if (!empty($data->courseinstanceshortname)) {
3052             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
3053             if (!$courseinstanceid) {
3054                 $this->log(
3055                     'Could not match the course instance in course_completion_criteria, so skipping',
3056                     backup::LOG_DEBUG
3057                 );
3058                 return;
3059             }
3060         } else {
3061             $courseinstanceid = null;
3062         }
3063         $data->courseinstance = $courseinstanceid;
3065         $params = array(
3066             'course'         => $data->course,
3067             'criteriatype'   => $data->criteriatype,
3068             'enrolperiod'    => $data->enrolperiod,
3069             'courseinstance' => $data->courseinstance,
3070             'module'         => $data->module,
3071             'moduleinstance' => $data->moduleinstance,
3072             'timeend'        => $data->timeend,
3073             'gradepass'      => $data->gradepass,
3074             'role'           => $data->role
3075         );
3076         $newid = $DB->insert_record('course_completion_criteria', $params);
3077         $this->set_mapping('course_completion_criteria', $data->id, $newid);
3078     }
3080     /**
3081      * Processes course compltion criteria complete records
3082      *
3083      * @global moodle_database $DB
3084      * @param stdClass $data
3085      */
3086     public function process_course_completion_crit_compl($data) {
3087         global $DB;
3089         $data = (object)$data;
3091         // This may be empty if criteria could not be restored
3092         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
3094         $data->course = $this->get_courseid();
3095         $data->userid = $this->get_mappingid('user', $data->userid);
3097         if (!empty($data->criteriaid) && !empty($data->userid)) {
3098             $params = array(
3099                 'userid' => $data->userid,
3100                 'course' => $data->course,
3101                 'criteriaid' => $data->criteriaid,
3102                 'timecompleted' => $data->timecompleted
3103             );
3104             if (isset($data->gradefinal)) {
3105                 $params['gradefinal'] = $data->gradefinal;
3106             }
3107             if (isset($data->unenroled)) {
3108                 $params['unenroled'] = $data->unenroled;
3109             }
3110             $DB->insert_record('course_completion_crit_compl', $params);
3111         }
3112     }
3114     /**
3115      * Process course completions
3116      *
3117      * @global moodle_database $DB
3118      * @param stdClass $data
3119      */
3120     public function process_course_completions($data) {
3121         global $DB;
3123         $data = (object)$data;
3125         $data->course = $this->get_courseid();
3126         $data->userid = $this->get_mappingid('user', $data->userid);
3128         if (!empty($data->userid)) {
3129             $params = array(
3130                 'userid' => $data->userid,
3131                 'course' => $data->course,
3132                 'timeenrolled' => $data->timeenrolled,
3133                 'timestarted' => $data->timestarted,
3134                 'timecompleted' => $data->timecompleted,
3135                 'reaggregate' => $data->reaggregate
3136             );
3138             $existing = $DB->get_record('course_completions', array(
3139                 'userid' => $data->userid,
3140                 'course' => $data->course
3141             ));
3143             // MDL-46651 - If cron writes out a new record before we get to it
3144             // then we should replace it with the Truth data from the backup.
3145             // This may be obsolete after MDL-48518 is resolved
3146             if ($existing) {
3147                 $params['id'] = $existing->id;
3148                 $DB->update_record('course_completions', $params);
3149             } else {
3150                 $DB->insert_record('course_completions', $params);
3151             }
3152         }
3153     }
3155     /**
3156      * Process course completion aggregate methods
3157      *
3158      * @global moodle_database $DB
3159      * @param stdClass $data
3160      */
3161     public function process_course_completion_aggr_methd($data) {
3162         global $DB;
3164         $data = (object)$data;
3166         $data->course = $this->get_courseid();
3168         // Only create the course_completion_aggr_methd records if
3169         // the target course has not them defined. MDL-28180
3170         if (!$DB->record_exists('course_completion_aggr_methd', array(
3171                     'course' => $data->course,
3172                     'criteriatype' => $data->criteriatype))) {
3173             $params = array(
3174                 'course' => $data->course,
3175                 'criteriatype' => $data->criteriatype,
3176                 'method' => $data->method,
3177                 'value' => $data->value,
3178             );
3179             $DB->insert_record('course_completion_aggr_methd', $params);
3180         }
3181     }
3185 /**
3186  * This structure step restores course logs (cmid = 0), delegating
3187  * the hard work to the corresponding {@link restore_logs_processor} passing the
3188  * collection of {@link restore_log_rule} rules to be observed as they are defined
3189  * by the task. Note this is only executed based in the 'logs' setting.
3190  *
3191  * NOTE: This is executed by final task, to have all the activities already restored
3192  *
3193  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
3194  * records are. There are others like 'calendar' and 'upload' that will be handled
3195  * later.
3196  *
3197  * NOTE: All the missing actions (not able to be restored) are sent to logs for
3198  * debugging purposes
3199  */
3200 class restore_course_logs_structure_step extends restore_structure_step {
3202     /**
3203      * Conditionally decide if this step should be executed.
3204      *
3205      * This function checks the following parameter:
3206      *
3207      *   1. the course/logs.xml file exists
3208      *
3209      * @return bool true is safe to execute, false otherwise
3210      */
3211     protected function execute_condition() {
3213         // Check it is included in the backup
3214         $fullpath = $this->task->get_taskbasepath();
3215         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
3216         if (!file_exists($fullpath)) {
3217             // Not found, can't restore course logs
3218             return false;
3219         }
3221         return true;