MDL-57898 core_course: backup/restore support for course custom fields
[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         }
249         $this->set_mapping('grade_item', $oldid, $newitemid);
250     }
252     protected function process_grade_grade($data) {
253         global $DB;
255         $data = (object)$data;
256         $oldid = $data->id;
257         $olduserid = $data->userid;
259         $data->itemid = $this->get_new_parentid('grade_item');
261         $data->userid = $this->get_mappingid('user', $data->userid, null);
262         if (!empty($data->userid)) {
263             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
264             $data->locktime     = $this->apply_date_offset($data->locktime);
266             $gradeexists = $DB->record_exists('grade_grades', array('userid' => $data->userid, 'itemid' => $data->itemid));
267             if ($gradeexists) {
268                 $message = "User id '{$data->userid}' already has a grade entry for grade item id '{$data->itemid}'";
269                 $this->log($message, backup::LOG_DEBUG);
270             } else {
271                 $newitemid = $DB->insert_record('grade_grades', $data);
272                 $this->set_mapping('grade_grades', $oldid, $newitemid);
273             }
274         } else {
275             $message = "Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'";
276             $this->log($message, backup::LOG_DEBUG);
277         }
278     }
280     protected function process_grade_category($data) {
281         global $DB;
283         $data = (object)$data;
284         $oldid = $data->id;
286         $data->course = $this->get_courseid();
287         $data->courseid = $data->course;
289         $newitemid = null;
290         //no parent means a course level grade category. That may have been created when the course was created
291         if(empty($data->parent)) {
292             //parent was being saved as 0 when it should be null
293             $data->parent = null;
295             //get the already created course level grade category
296             $category = new stdclass();
297             $category->courseid = $this->get_courseid();
298             $category->parent = null;
300             $coursecategory = $DB->get_record('grade_categories', (array)$category);
301             if (!empty($coursecategory)) {
302                 $data->id = $newitemid = $coursecategory->id;
303                 $DB->update_record('grade_categories', $data);
304             }
305         }
307         // Add a warning about a removed setting.
308         if (!empty($data->aggregatesubcats)) {
309             set_config('show_aggregatesubcats_upgrade_' . $data->courseid, 1);
310         }
312         //need to insert a course category
313         if (empty($newitemid)) {
314             $newitemid = $DB->insert_record('grade_categories', $data);
315         }
316         $this->set_mapping('grade_category', $oldid, $newitemid);
317     }
318     protected function process_grade_letter($data) {
319         global $DB;
321         $data = (object)$data;
322         $oldid = $data->id;
324         $data->contextid = context_course::instance($this->get_courseid())->id;
326         $gradeletter = (array)$data;
327         unset($gradeletter['id']);
328         if (!$DB->record_exists('grade_letters', $gradeletter)) {
329             $newitemid = $DB->insert_record('grade_letters', $data);
330         } else {
331             $newitemid = $data->id;
332         }
334         $this->set_mapping('grade_letter', $oldid, $newitemid);
335     }
336     protected function process_grade_setting($data) {
337         global $DB;
339         $data = (object)$data;
340         $oldid = $data->id;
342         $data->courseid = $this->get_courseid();
344         $target = $this->get_task()->get_target();
345         if ($data->name == 'minmaxtouse' &&
346                 ($target == backup::TARGET_CURRENT_ADDING || $target == backup::TARGET_EXISTING_ADDING)) {
347             // We never restore minmaxtouse during merge.
348             return;
349         }
351         if (!$DB->record_exists('grade_settings', array('courseid' => $data->courseid, 'name' => $data->name))) {
352             $newitemid = $DB->insert_record('grade_settings', $data);
353         } else {
354             $newitemid = $data->id;
355         }
357         if (!empty($oldid)) {
358             // In rare cases (minmaxtouse), it is possible that there wasn't any ID associated with the setting.
359             $this->set_mapping('grade_setting', $oldid, $newitemid);
360         }
361     }
363     /**
364      * put all activity grade items in the correct grade category and mark all for recalculation
365      */
366     protected function after_execute() {
367         global $DB;
369         $conditions = array(
370             'backupid' => $this->get_restoreid(),
371             'itemname' => 'grade_item'//,
372             //'itemid'   => $itemid
373         );
374         $rs = $DB->get_recordset('backup_ids_temp', $conditions);
376         // We need this for calculation magic later on.
377         $mappings = array();
379         if (!empty($rs)) {
380             foreach($rs as $grade_item_backup) {
382                 // Store the oldid with the new id.
383                 $mappings[$grade_item_backup->itemid] = $grade_item_backup->newitemid;
385                 $updateobj = new stdclass();
386                 $updateobj->id = $grade_item_backup->newitemid;
388                 //if this is an activity grade item that needs to be put back in its correct category
389                 if (!empty($grade_item_backup->parentitemid)) {
390                     $oldcategoryid = $this->get_mappingid('grade_category', $grade_item_backup->parentitemid, null);
391                     if (!is_null($oldcategoryid)) {
392                         $updateobj->categoryid = $oldcategoryid;
393                         $DB->update_record('grade_items', $updateobj);
394                     }
395                 } else {
396                     //mark course and category items as needing to be recalculated
397                     $updateobj->needsupdate=1;
398                     $DB->update_record('grade_items', $updateobj);
399                 }
400             }
401         }
402         $rs->close();
404         // We need to update the calculations for calculated grade items that may reference old
405         // grade item ids using ##gi\d+##.
406         // $mappings can be empty, use 0 if so (won't match ever)
407         list($sql, $params) = $DB->get_in_or_equal(array_values($mappings), SQL_PARAMS_NAMED, 'param', true, 0);
408         $sql = "SELECT gi.id, gi.calculation
409                   FROM {grade_items} gi
410                  WHERE gi.id {$sql} AND
411                        calculation IS NOT NULL";
412         $rs = $DB->get_recordset_sql($sql, $params);
413         foreach ($rs as $gradeitem) {
414             // Collect all of the used grade item id references
415             if (preg_match_all('/##gi(\d+)##/', $gradeitem->calculation, $matches) < 1) {
416                 // This calculation doesn't reference any other grade items... EASY!
417                 continue;
418             }
419             // For this next bit we are going to do the replacement of id's in two steps:
420             // 1. We will replace all old id references with a special mapping reference.
421             // 2. We will replace all mapping references with id's
422             // Why do we do this?
423             // Because there potentially there will be an overlap of ids within the query and we
424             // we substitute the wrong id.. safest way around this is the two step system
425             $calculationmap = array();
426             $mapcount = 0;
427             foreach ($matches[1] as $match) {
428                 // Check that the old id is known to us, if not it was broken to begin with and will
429                 // continue to be broken.
430                 if (!array_key_exists($match, $mappings)) {
431                     continue;
432                 }
433                 // Our special mapping key
434                 $mapping = '##MAPPING'.$mapcount.'##';
435                 // The old id that exists within the calculation now
436                 $oldid = '##gi'.$match.'##';
437                 // The new id that we want to replace the old one with.
438                 $newid = '##gi'.$mappings[$match].'##';
439                 // Replace in the special mapping key
440                 $gradeitem->calculation = str_replace($oldid, $mapping, $gradeitem->calculation);
441                 // And record the mapping
442                 $calculationmap[$mapping] = $newid;
443                 $mapcount++;
444             }
445             // Iterate all special mappings for this calculation and replace in the new id's
446             foreach ($calculationmap as $mapping => $newid) {
447                 $gradeitem->calculation = str_replace($mapping, $newid, $gradeitem->calculation);
448             }
449             // Update the calculation now that its being remapped
450             $DB->update_record('grade_items', $gradeitem);
451         }
452         $rs->close();
454         // Need to correct the grade category path and parent
455         $conditions = array(
456             'courseid' => $this->get_courseid()
457         );
459         $rs = $DB->get_recordset('grade_categories', $conditions);
460         // Get all the parents correct first as grade_category::build_path() loads category parents from the DB
461         foreach ($rs as $gc) {
462             if (!empty($gc->parent)) {
463                 $grade_category = new stdClass();
464                 $grade_category->id = $gc->id;
465                 $grade_category->parent = $this->get_mappingid('grade_category', $gc->parent);
466                 $DB->update_record('grade_categories', $grade_category);
467             }
468         }
469         $rs->close();
471         // Now we can rebuild all the paths
472         $rs = $DB->get_recordset('grade_categories', $conditions);
473         foreach ($rs as $gc) {
474             $grade_category = new stdClass();
475             $grade_category->id = $gc->id;
476             $grade_category->path = grade_category::build_path($gc);
477             $grade_category->depth = substr_count($grade_category->path, '/') - 1;
478             $DB->update_record('grade_categories', $grade_category);
479         }
480         $rs->close();
482         // Check what to do with the minmaxtouse setting.
483         $this->check_minmaxtouse();
485         // Freeze gradebook calculations if needed.
486         $this->gradebook_calculation_freeze();
488         // Restore marks items as needing update. Update everything now.
489         grade_regrade_final_grades($this->get_courseid());
490     }
492     /**
493      * Freeze gradebook calculation if needed.
494      *
495      * This is similar to various upgrade scripts that check if the freeze is needed.
496      */
497     protected function gradebook_calculation_freeze() {
498         global $CFG;
499         $gradebookcalculationsfreeze = get_config('core', 'gradebook_calculations_freeze_' . $this->get_courseid());
500         preg_match('/(\d{8})/', $this->get_task()->get_info()->moodle_release, $matches);
501         $backupbuild = (int)$matches[1];
502         // The function floatval will return a float even if there is text mixed with the release number.
503         $backuprelease = floatval($this->get_task()->get_info()->backup_release);
505         // Extra credits need adjustments only for backups made between 2.8 release (20141110) and the fix release (20150619).
506         if (!$gradebookcalculationsfreeze && $backupbuild >= 20141110 && $backupbuild < 20150619) {
507             require_once($CFG->libdir . '/db/upgradelib.php');
508             upgrade_extra_credit_weightoverride($this->get_courseid());
509         }
510         // Calculated grade items need recalculating for backups made between 2.8 release (20141110) and the fix release (20150627).
511         if (!$gradebookcalculationsfreeze && $backupbuild >= 20141110 && $backupbuild < 20150627) {
512             require_once($CFG->libdir . '/db/upgradelib.php');
513             upgrade_calculated_grade_items($this->get_courseid());
514         }
515         // Courses from before 3.1 (20160518) may have a letter boundary problem and should be checked for this issue.
516         // Backups from before and including 2.9 could have a build number that is greater than 20160518 and should
517         // be checked for this problem.
518         if (!$gradebookcalculationsfreeze && ($backupbuild < 20160518 || $backuprelease <= 2.9)) {
519             require_once($CFG->libdir . '/db/upgradelib.php');
520             upgrade_course_letter_boundary($this->get_courseid());
521         }
523     }
525     /**
526      * Checks what should happen with the course grade setting minmaxtouse.
527      *
528      * This is related to the upgrade step at the time the setting was added.
529      *
530      * @see MDL-48618
531      * @return void
532      */
533     protected function check_minmaxtouse() {
534         global $CFG, $DB;
535         require_once($CFG->libdir . '/gradelib.php');
537         $userinfo = $this->task->get_setting_value('users');
538         $settingname = 'minmaxtouse';
539         $courseid = $this->get_courseid();
540         $minmaxtouse = $DB->get_field('grade_settings', 'value', array('courseid' => $courseid, 'name' => $settingname));
541         $version28start = 2014111000.00;
542         $version28last = 2014111006.05;
543         $version29start = 2015051100.00;
544         $version29last = 2015060400.02;
546         $target = $this->get_task()->get_target();
547         if ($minmaxtouse === false &&
548                 ($target != backup::TARGET_CURRENT_ADDING && $target != backup::TARGET_EXISTING_ADDING)) {
549             // The setting was not found because this setting did not exist at the time the backup was made.
550             // And we are not restoring as merge, in which case we leave the course as it was.
551             $version = $this->get_task()->get_info()->moodle_version;
553             if ($version < $version28start) {
554                 // We need to set it to use grade_item, but only if the site-wide setting is different. No need to notice them.
555                 if ($CFG->grade_minmaxtouse != GRADE_MIN_MAX_FROM_GRADE_ITEM) {
556                     grade_set_setting($courseid, $settingname, GRADE_MIN_MAX_FROM_GRADE_ITEM);
557                 }
559             } else if (($version >= $version28start && $version < $version28last) ||
560                     ($version >= $version29start && $version < $version29last)) {
561                 // They should be using grade_grade when the course has inconsistencies.
563                 $sql = "SELECT gi.id
564                           FROM {grade_items} gi
565                           JOIN {grade_grades} gg
566                             ON gg.itemid = gi.id
567                          WHERE gi.courseid = ?
568                            AND (gi.itemtype != ? AND gi.itemtype != ?)
569                            AND (gg.rawgrademax != gi.grademax OR gg.rawgrademin != gi.grademin)";
571                 // The course can only have inconsistencies when we restore the user info,
572                 // we do not need to act on existing grades that were not restored as part of this backup.
573                 if ($userinfo && $DB->record_exists_sql($sql, array($courseid, 'course', 'category'))) {
575                     // Display the notice as we do during upgrade.
576                     set_config('show_min_max_grades_changed_' . $courseid, 1);
578                     if ($CFG->grade_minmaxtouse != GRADE_MIN_MAX_FROM_GRADE_GRADE) {
579                         // We need set the setting as their site-wise setting is not GRADE_MIN_MAX_FROM_GRADE_GRADE.
580                         // If they are using the site-wide grade_grade setting, we only want to notice them.
581                         grade_set_setting($courseid, $settingname, GRADE_MIN_MAX_FROM_GRADE_GRADE);
582                     }
583                 }
585             } else {
586                 // This should never happen because from now on minmaxtouse is always saved in backups.
587             }
588         }
589     }
591     /**
592      * Rewrite step definition to handle the legacy freeze attribute.
593      *
594      * In previous backups the calculations_freeze property was stored as an attribute of the
595      * top level node <gradebook>. The backup API, however, do not process grandparent nodes.
596      * It only processes definitive children, and their parent attributes.
597      *
598      * We had:
599      *
600      * <gradebook calculations_freeze="20160511">
601      *   <grade_categories>
602      *     <grade_category id="10">
603      *       <depth>1</depth>
604      *       ...
605      *     </grade_category>
606      *   </grade_categories>
607      *   ...
608      * </gradebook>
609      *
610      * And this method will convert it to:
611      *
612      * <gradebook >
613      *   <attributes>
614      *     <calculations_freeze>20160511</calculations_freeze>
615      *   </attributes>
616      *   <grade_categories>
617      *     <grade_category id="10">
618      *       <depth>1</depth>
619      *       ...
620      *     </grade_category>
621      *   </grade_categories>
622      *   ...
623      * </gradebook>
624      *
625      * Note that we cannot just load the XML file in memory as it could potentially be huge.
626      * We can also completely ignore if the node <attributes> is already in the backup
627      * file as it never existed before.
628      *
629      * @param string $filepath The absolute path to the XML file.
630      * @return void
631      */
632     protected function rewrite_step_backup_file_for_legacy_freeze($filepath) {
633         $foundnode = false;
634         $newfile = make_request_directory(true) . DIRECTORY_SEPARATOR . 'file.xml';
635         $fr = fopen($filepath, 'r');
636         $fw = fopen($newfile, 'w');
637         if ($fr && $fw) {
638             while (($line = fgets($fr, 4096)) !== false) {
639                 if (!$foundnode && strpos($line, '<gradebook ') === 0) {
640                     $foundnode = true;
641                     $matches = array();
642                     $pattern = '@calculations_freeze=.([0-9]+).@';
643                     if (preg_match($pattern, $line, $matches)) {
644                         $freeze = $matches[1];
645                         $line = preg_replace($pattern, '', $line);
646                         $line .= "  <attributes>\n    <calculations_freeze>$freeze</calculations_freeze>\n  </attributes>\n";
647                     }
648                 }
649                 fputs($fw, $line);
650             }
651             if (!feof($fr)) {
652                 throw new restore_step_exception('Error while attempting to rewrite the gradebook step file.');
653             }
654             fclose($fr);
655             fclose($fw);
656             if (!rename($newfile, $filepath)) {
657                 throw new restore_step_exception('Error while attempting to rename the gradebook step file.');
658             }
659         } else {
660             if ($fr) {
661                 fclose($fr);
662             }
663             if ($fw) {
664                 fclose($fw);
665             }
666         }
667     }
671 /**
672  * Step in charge of restoring the grade history of a course.
673  *
674  * The execution conditions are itendical to {@link restore_gradebook_structure_step} because
675  * we do not want to restore the history if the gradebook and its content has not been
676  * restored. At least for now.
677  */
678 class restore_grade_history_structure_step extends restore_structure_step {
680      protected function execute_condition() {
681         global $CFG, $DB;
683         if ($this->get_courseid() == SITEID) {
684             return false;
685         }
687         // No gradebook info found, don't execute.
688         $fullpath = $this->task->get_taskbasepath();
689         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
690         if (!file_exists($fullpath)) {
691             return false;
692         }
694         // Some module present in backup file isn't available to restore in this site, don't execute.
695         if ($this->task->is_missing_modules()) {
696             return false;
697         }
699         // Some activity has been excluded to be restored, don't execute.
700         if ($this->task->is_excluding_activities()) {
701             return false;
702         }
704         // There should only be one grade category (the 1 associated with the course itself).
705         $category = new stdclass();
706         $category->courseid  = $this->get_courseid();
707         $catcount = $DB->count_records('grade_categories', (array)$category);
708         if ($catcount > 1) {
709             return false;
710         }
712         // Arrived here, execute the step.
713         return true;
714      }
716     protected function define_structure() {
717         $paths = array();
719         // Settings to use.
720         $userinfo = $this->get_setting_value('users');
721         $history = $this->get_setting_value('grade_histories');
723         if ($userinfo && $history) {
724             $paths[] = new restore_path_element('grade_grade',
725                '/grade_history/grade_grades/grade_grade');
726         }
728         return $paths;
729     }
731     protected function process_grade_grade($data) {
732         global $DB;
734         $data = (object)($data);
735         $olduserid = $data->userid;
736         unset($data->id);
738         $data->userid = $this->get_mappingid('user', $data->userid, null);
739         if (!empty($data->userid)) {
740             // Do not apply the date offsets as this is history.
741             $data->itemid = $this->get_mappingid('grade_item', $data->itemid);
742             $data->oldid = $this->get_mappingid('grade_grades', $data->oldid);
743             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
744             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
745             $DB->insert_record('grade_grades_history', $data);
746         } else {
747             $message = "Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'";
748             $this->log($message, backup::LOG_DEBUG);
749         }
750     }
754 /**
755  * decode all the interlinks present in restored content
756  * relying 100% in the restore_decode_processor that handles
757  * both the contents to modify and the rules to be applied
758  */
759 class restore_decode_interlinks extends restore_execution_step {
761     protected function define_execution() {
762         // Get the decoder (from the plan)
763         $decoder = $this->task->get_decoder();
764         restore_decode_processor::register_link_decoders($decoder); // Add decoder contents and rules
765         // And launch it, everything will be processed
766         $decoder->execute();
767     }
770 /**
771  * first, ensure that we have no gaps in section numbers
772  * and then, rebuid the course cache
773  */
774 class restore_rebuild_course_cache extends restore_execution_step {
776     protected function define_execution() {
777         global $DB;
779         // Although there is some sort of auto-recovery of missing sections
780         // present in course/formats... here we check that all the sections
781         // from 0 to MAX(section->section) exist, creating them if necessary
782         $maxsection = $DB->get_field('course_sections', 'MAX(section)', array('course' => $this->get_courseid()));
783         // Iterate over all sections
784         for ($i = 0; $i <= $maxsection; $i++) {
785             // If the section $i doesn't exist, create it
786             if (!$DB->record_exists('course_sections', array('course' => $this->get_courseid(), 'section' => $i))) {
787                 $sectionrec = array(
788                     'course' => $this->get_courseid(),
789                     'section' => $i,
790                     'timemodified' => time());
791                 $DB->insert_record('course_sections', $sectionrec); // missing section created
792             }
793         }
795         // Rebuild cache now that all sections are in place
796         rebuild_course_cache($this->get_courseid());
797         cache_helper::purge_by_event('changesincourse');
798         cache_helper::purge_by_event('changesincoursecat');
799     }
802 /**
803  * Review all the tasks having one after_restore method
804  * executing it to perform some final adjustments of information
805  * not available when the task was executed.
806  */
807 class restore_execute_after_restore extends restore_execution_step {
809     protected function define_execution() {
811         // Simply call to the execute_after_restore() method of the task
812         // that always is the restore_final_task
813         $this->task->launch_execute_after_restore();
814     }
818 /**
819  * Review all the (pending) block positions in backup_ids, matching by
820  * contextid, creating positions as needed. This is executed by the
821  * final task, once all the contexts have been created
822  */
823 class restore_review_pending_block_positions extends restore_execution_step {
825     protected function define_execution() {
826         global $DB;
828         // Get all the block_position objects pending to match
829         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
830         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
831         // Process block positions, creating them or accumulating for final step
832         foreach($rs as $posrec) {
833             // Get the complete position object out of the info field.
834             $position = backup_controller_dbops::decode_backup_temp_info($posrec->info);
835             // If position is for one already mapped (known) contextid
836             // process it now, creating the position, else nothing to
837             // do, position finally discarded
838             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
839                 $position->contextid = $newctx->newitemid;
840                 // Create the block position
841                 $DB->insert_record('block_positions', $position);
842             }
843         }
844         $rs->close();
845     }
849 /**
850  * Updates the availability data for course modules and sections.
851  *
852  * Runs after the restore of all course modules, sections, and grade items has
853  * completed. This is necessary in order to update IDs that have changed during
854  * restore.
855  *
856  * @package core_backup
857  * @copyright 2014 The Open University
858  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
859  */
860 class restore_update_availability extends restore_execution_step {
862     protected function define_execution() {
863         global $CFG, $DB;
865         // Note: This code runs even if availability is disabled when restoring.
866         // That will ensure that if you later turn availability on for the site,
867         // there will be no incorrect IDs. (It doesn't take long if the restored
868         // data does not contain any availability information.)
870         // Get modinfo with all data after resetting cache.
871         rebuild_course_cache($this->get_courseid(), true);
872         $modinfo = get_fast_modinfo($this->get_courseid());
874         // Get the date offset for this restore.
875         $dateoffset = $this->apply_date_offset(1) - 1;
877         // Update all sections that were restored.
878         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'course_section');
879         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'newitemid');
880         $sectionsbyid = null;
881         foreach ($rs as $rec) {
882             if (is_null($sectionsbyid)) {
883                 $sectionsbyid = array();
884                 foreach ($modinfo->get_section_info_all() as $section) {
885                     $sectionsbyid[$section->id] = $section;
886                 }
887             }
888             if (!array_key_exists($rec->newitemid, $sectionsbyid)) {
889                 // If the section was not fully restored for some reason
890                 // (e.g. due to an earlier error), skip it.
891                 $this->get_logger()->process('Section not fully restored: id ' .
892                         $rec->newitemid, backup::LOG_WARNING);
893                 continue;
894             }
895             $section = $sectionsbyid[$rec->newitemid];
896             if (!is_null($section->availability)) {
897                 $info = new \core_availability\info_section($section);
898                 $info->update_after_restore($this->get_restoreid(),
899                         $this->get_courseid(), $this->get_logger(), $dateoffset, $this->task);
900             }
901         }
902         $rs->close();
904         // Update all modules that were restored.
905         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'course_module');
906         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'newitemid');
907         foreach ($rs as $rec) {
908             if (!array_key_exists($rec->newitemid, $modinfo->cms)) {
909                 // If the module was not fully restored for some reason
910                 // (e.g. due to an earlier error), skip it.
911                 $this->get_logger()->process('Module not fully restored: id ' .
912                         $rec->newitemid, backup::LOG_WARNING);
913                 continue;
914             }
915             $cm = $modinfo->get_cm($rec->newitemid);
916             if (!is_null($cm->availability)) {
917                 $info = new \core_availability\info_module($cm);
918                 $info->update_after_restore($this->get_restoreid(),
919                         $this->get_courseid(), $this->get_logger(), $dateoffset, $this->task);
920             }
921         }
922         $rs->close();
923     }
927 /**
928  * Process legacy module availability records in backup_ids.
929  *
930  * Matches course modules and grade item id once all them have been already restored.
931  * Only if all matchings are satisfied the availability condition will be created.
932  * At the same time, it is required for the site to have that functionality enabled.
933  *
934  * This step is included only to handle legacy backups (2.6 and before). It does not
935  * do anything for newer backups.
936  *
937  * @copyright 2014 The Open University
938  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
939  */
940 class restore_process_course_modules_availability extends restore_execution_step {
942     protected function define_execution() {
943         global $CFG, $DB;
945         // Site hasn't availability enabled
946         if (empty($CFG->enableavailability)) {
947             return;
948         }
950         // Do both modules and sections.
951         foreach (array('module', 'section') as $table) {
952             // Get all the availability objects to process.
953             $params = array('backupid' => $this->get_restoreid(), 'itemname' => $table . '_availability');
954             $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
955             // Process availabilities, creating them if everything matches ok.
956             foreach ($rs as $availrec) {
957                 $allmatchesok = true;
958                 // Get the complete legacy availability object.
959                 $availability = backup_controller_dbops::decode_backup_temp_info($availrec->info);
961                 // Note: This code used to update IDs, but that is now handled by the
962                 // current code (after restore) instead of this legacy code.
964                 // Get showavailability option.
965                 $thingid = ($table === 'module') ? $availability->coursemoduleid :
966                         $availability->coursesectionid;
967                 $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
968                         $table . '_showavailability', $thingid);
969                 if (!$showrec) {
970                     // Should not happen.
971                     throw new coding_exception('No matching showavailability record');
972                 }
973                 $show = $showrec->info->showavailability;
975                 // The $availability object is now in the format used in the old
976                 // system. Interpret this and convert to new system.
977                 $currentvalue = $DB->get_field('course_' . $table . 's', 'availability',
978                         array('id' => $thingid), MUST_EXIST);
979                 $newvalue = \core_availability\info::add_legacy_availability_condition(
980                         $currentvalue, $availability, $show);
981                 $DB->set_field('course_' . $table . 's', 'availability', $newvalue,
982                         array('id' => $thingid));
983             }
984             $rs->close();
985         }
986     }
990 /*
991  * Execution step that, *conditionally* (if there isn't preloaded information)
992  * will load the inforef files for all the included course/section/activity tasks
993  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
994  */
995 class restore_load_included_inforef_records extends restore_execution_step {
997     protected function define_execution() {
999         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1000             return;
1001         }
1003         // Get all the included tasks
1004         $tasks = restore_dbops::get_included_tasks($this->get_restoreid());
1005         $progress = $this->task->get_progress();
1006         $progress->start_progress($this->get_name(), count($tasks));
1007         foreach ($tasks as $task) {
1008             // Load the inforef.xml file if exists
1009             $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
1010             if (file_exists($inforefpath)) {
1011                 // Load each inforef file to temp_ids.
1012                 restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $inforefpath, $progress);
1013             }
1014         }
1015         $progress->end_progress();
1016     }
1019 /*
1020  * Execution step that will load all the needed files into backup_files_temp
1021  *   - info: contains the whole original object (times, names...)
1022  * (all them being original ids as loaded from xml)
1023  */
1024 class restore_load_included_files extends restore_structure_step {
1026     protected function define_structure() {
1028         $file = new restore_path_element('file', '/files/file');
1030         return array($file);
1031     }
1033     /**
1034      * Process one <file> element from files.xml
1035      *
1036      * @param array $data the element data
1037      */
1038     public function process_file($data) {
1040         $data = (object)$data; // handy
1042         // load it if needed:
1043         //   - it it is one of the annotated inforef files (course/section/activity/block)
1044         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
1045         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
1046         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
1047         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
1048         $iscomponent = ($data->component == 'user' || $data->component == 'group' || $data->component == 'badges' ||
1049                         $data->component == 'grouping' || $data->component == 'grade' ||
1050                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
1051         if ($isfileref || $iscomponent) {
1052             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
1053         }
1054     }
1057 /**
1058  * Execution step that, *conditionally* (if there isn't preloaded information),
1059  * will load all the needed roles to backup_temp_ids. They will be stored with
1060  * "role" itemname. Also it will perform one automatic mapping to roles existing
1061  * in the target site, based in permissions of the user performing the restore,
1062  * archetypes and other bits. At the end, each original role will have its associated
1063  * target role or 0 if it's going to be skipped. Note we wrap everything over one
1064  * restore_dbops method, as far as the same stuff is going to be also executed
1065  * by restore prechecks
1066  */
1067 class restore_load_and_map_roles extends restore_execution_step {
1069     protected function define_execution() {
1070         if ($this->task->get_preloaded_information()) { // if info is already preloaded
1071             return;
1072         }
1074         $file = $this->get_basepath() . '/roles.xml';
1075         // Load needed toles to temp_ids
1076         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
1078         // Process roles, mapping/skipping. Any error throws exception
1079         // Note we pass controller's info because it can contain role mapping information
1080         // about manual mappings performed by UI
1081         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);
1082     }
1085 /**
1086  * Execution step that, *conditionally* (if there isn't preloaded information
1087  * and users have been selected in settings, will load all the needed users
1088  * to backup_temp_ids. They will be stored with "user" itemname and with
1089  * their original contextid as paremitemid
1090  */
1091 class restore_load_included_users extends restore_execution_step {
1093     protected function define_execution() {
1095         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1096             return;
1097         }
1098         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
1099             return;
1100         }
1101         $file = $this->get_basepath() . '/users.xml';
1102         // Load needed users to temp_ids.
1103         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file, $this->task->get_progress());
1104     }
1107 /**
1108  * Execution step that, *conditionally* (if there isn't preloaded information
1109  * and users have been selected in settings, will process all the needed users
1110  * in order to decide and perform any action with them (create / map / error)
1111  * Note: Any error will cause exception, as far as this is the same processing
1112  * than the one into restore prechecks (that should have stopped process earlier)
1113  */
1114 class restore_process_included_users extends restore_execution_step {
1116     protected function define_execution() {
1118         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1119             return;
1120         }
1121         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
1122             return;
1123         }
1124         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(),
1125                 $this->task->get_userid(), $this->task->is_samesite(), $this->task->get_progress());
1126     }
1129 /**
1130  * Execution step that will create all the needed users as calculated
1131  * by @restore_process_included_users (those having newiteind = 0)
1132  */
1133 class restore_create_included_users extends restore_execution_step {
1135     protected function define_execution() {
1137         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(),
1138                 $this->task->get_userid(), $this->task->get_progress());
1139     }
1142 /**
1143  * Structure step that will create all the needed groups and groupings
1144  * by loading them from the groups.xml file performing the required matches.
1145  * Note group members only will be added if restoring user info
1146  */
1147 class restore_groups_structure_step extends restore_structure_step {
1149     protected function define_structure() {
1151         $paths = array(); // Add paths here
1153         // Do not include group/groupings information if not requested.
1154         $groupinfo = $this->get_setting_value('groups');
1155         if ($groupinfo) {
1156             $paths[] = new restore_path_element('group', '/groups/group');
1157             $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
1158             $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
1159         }
1160         return $paths;
1161     }
1163     // Processing functions go here
1164     public function process_group($data) {
1165         global $DB;
1167         $data = (object)$data; // handy
1168         $data->courseid = $this->get_courseid();
1170         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1171         // another a group in the same course
1172         $context = context_course::instance($data->courseid);
1173         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1174             if (groups_get_group_by_idnumber($data->courseid, $data->idnumber)) {
1175                 unset($data->idnumber);
1176             }
1177         } else {
1178             unset($data->idnumber);
1179         }
1181         $oldid = $data->id;    // need this saved for later
1183         $restorefiles = false; // Only if we end creating the group
1185         // Search if the group already exists (by name & description) in the target course
1186         $description_clause = '';
1187         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
1188         if (!empty($data->description)) {
1189             $description_clause = ' AND ' .
1190                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
1191            $params['description'] = $data->description;
1192         }
1193         if (!$groupdb = $DB->get_record_sql("SELECT *
1194                                                FROM {groups}
1195                                               WHERE courseid = :courseid
1196                                                 AND name = :grname $description_clause", $params)) {
1197             // group doesn't exist, create
1198             $newitemid = $DB->insert_record('groups', $data);
1199             $restorefiles = true; // We'll restore the files
1200         } else {
1201             // group exists, use it
1202             $newitemid = $groupdb->id;
1203         }
1204         // Save the id mapping
1205         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
1206         // Invalidate the course group data cache just in case.
1207         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
1208     }
1210     public function process_grouping($data) {
1211         global $DB;
1213         $data = (object)$data; // handy
1214         $data->courseid = $this->get_courseid();
1216         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1217         // another a grouping in the same course
1218         $context = context_course::instance($data->courseid);
1219         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1220             if (groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) {
1221                 unset($data->idnumber);
1222             }
1223         } else {
1224             unset($data->idnumber);
1225         }
1227         $oldid = $data->id;    // need this saved for later
1228         $restorefiles = false; // Only if we end creating the grouping
1230         // Search if the grouping already exists (by name & description) in the target course
1231         $description_clause = '';
1232         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
1233         if (!empty($data->description)) {
1234             $description_clause = ' AND ' .
1235                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
1236            $params['description'] = $data->description;
1237         }
1238         if (!$groupingdb = $DB->get_record_sql("SELECT *
1239                                                   FROM {groupings}
1240                                                  WHERE courseid = :courseid
1241                                                    AND name = :grname $description_clause", $params)) {
1242             // grouping doesn't exist, create
1243             $newitemid = $DB->insert_record('groupings', $data);
1244             $restorefiles = true; // We'll restore the files
1245         } else {
1246             // grouping exists, use it
1247             $newitemid = $groupingdb->id;
1248         }
1249         // Save the id mapping
1250         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
1251         // Invalidate the course group data cache just in case.
1252         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
1253     }
1255     public function process_grouping_group($data) {
1256         global $CFG;
1258         require_once($CFG->dirroot.'/group/lib.php');
1260         $data = (object)$data;
1261         groups_assign_grouping($this->get_new_parentid('grouping'), $this->get_mappingid('group', $data->groupid), $data->timeadded);
1262     }
1264     protected function after_execute() {
1265         // Add group related files, matching with "group" mappings
1266         $this->add_related_files('group', 'icon', 'group');
1267         $this->add_related_files('group', 'description', 'group');
1268         // Add grouping related files, matching with "grouping" mappings
1269         $this->add_related_files('grouping', 'description', 'grouping');
1270         // Invalidate the course group data.
1271         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($this->get_courseid()));
1272     }
1276 /**
1277  * Structure step that will create all the needed group memberships
1278  * by loading them from the groups.xml file performing the required matches.
1279  */
1280 class restore_groups_members_structure_step extends restore_structure_step {
1282     protected $plugins = null;
1284     protected function define_structure() {
1286         $paths = array(); // Add paths here
1288         if ($this->get_setting_value('groups') && $this->get_setting_value('users')) {
1289             $paths[] = new restore_path_element('group', '/groups/group');
1290             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
1291         }
1293         return $paths;
1294     }
1296     public function process_group($data) {
1297         $data = (object)$data; // handy
1299         // HACK ALERT!
1300         // Not much to do here, this groups mapping should be already done from restore_groups_structure_step.
1301         // Let's fake internal state to make $this->get_new_parentid('group') work.
1303         $this->set_mapping('group', $data->id, $this->get_mappingid('group', $data->id));
1304     }
1306     public function process_member($data) {
1307         global $DB, $CFG;
1308         require_once("$CFG->dirroot/group/lib.php");
1310         // NOTE: Always use groups_add_member() because it triggers events and verifies if user is enrolled.
1312         $data = (object)$data; // handy
1314         // get parent group->id
1315         $data->groupid = $this->get_new_parentid('group');
1317         // map user newitemid and insert if not member already
1318         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
1319             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
1320                 // Check the component, if any, exists.
1321                 if (empty($data->component)) {
1322                     groups_add_member($data->groupid, $data->userid);
1324                 } else if ((strpos($data->component, 'enrol_') === 0)) {
1325                     // Deal with enrolment groups - ignore the component and just find out the instance via new id,
1326                     // it is possible that enrolment was restored using different plugin type.
1327                     if (!isset($this->plugins)) {
1328                         $this->plugins = enrol_get_plugins(true);
1329                     }
1330                     if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1331                         if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1332                             if (isset($this->plugins[$instance->enrol])) {
1333                                 $this->plugins[$instance->enrol]->restore_group_member($instance, $data->groupid, $data->userid);
1334                             }
1335                         }
1336                     }
1338                 } else {
1339                     $dir = core_component::get_component_directory($data->component);
1340                     if ($dir and is_dir($dir)) {
1341                         if (component_callback($data->component, 'restore_group_member', array($this, $data), true)) {
1342                             return;
1343                         }
1344                     }
1345                     // Bad luck, plugin could not restore the data, let's add normal membership.
1346                     groups_add_member($data->groupid, $data->userid);
1347                     $message = "Restore of '$data->component/$data->itemid' group membership is not supported, using standard group membership instead.";
1348                     $this->log($message, backup::LOG_WARNING);
1349                 }
1350             }
1351         }
1352     }
1355 /**
1356  * Structure step that will create all the needed scales
1357  * by loading them from the scales.xml
1358  */
1359 class restore_scales_structure_step extends restore_structure_step {
1361     protected function define_structure() {
1363         $paths = array(); // Add paths here
1364         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
1365         return $paths;
1366     }
1368     protected function process_scale($data) {
1369         global $DB;
1371         $data = (object)$data;
1373         $restorefiles = false; // Only if we end creating the group
1375         $oldid = $data->id;    // need this saved for later
1377         // Look for scale (by 'scale' both in standard (course=0) and current course
1378         // with priority to standard scales (ORDER clause)
1379         // scale is not course unique, use get_record_sql to suppress warning
1380         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
1381         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
1382         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
1383         if (!$scadb = $DB->get_record_sql("SELECT *
1384                                             FROM {scale}
1385                                            WHERE courseid IN (0, :courseid)
1386                                              AND $compare_scale_clause
1387                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
1388             // Remap the user if possible, defaut to user performing the restore if not
1389             $userid = $this->get_mappingid('user', $data->userid);
1390             $data->userid = $userid ? $userid : $this->task->get_userid();
1391             // Remap the course if course scale
1392             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
1393             // If global scale (course=0), check the user has perms to create it
1394             // falling to course scale if not
1395             $systemctx = context_system::instance();
1396             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
1397                 $data->courseid = $this->get_courseid();
1398             }
1399             // scale doesn't exist, create
1400             $newitemid = $DB->insert_record('scale', $data);
1401             $restorefiles = true; // We'll restore the files
1402         } else {
1403             // scale exists, use it
1404             $newitemid = $scadb->id;
1405         }
1406         // Save the id mapping (with files support at system context)
1407         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1408     }
1410     protected function after_execute() {
1411         // Add scales related files, matching with "scale" mappings
1412         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
1413     }
1417 /**
1418  * Structure step that will create all the needed outocomes
1419  * by loading them from the outcomes.xml
1420  */
1421 class restore_outcomes_structure_step extends restore_structure_step {
1423     protected function define_structure() {
1425         $paths = array(); // Add paths here
1426         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
1427         return $paths;
1428     }
1430     protected function process_outcome($data) {
1431         global $DB;
1433         $data = (object)$data;
1435         $restorefiles = false; // Only if we end creating the group
1437         $oldid = $data->id;    // need this saved for later
1439         // Look for outcome (by shortname both in standard (courseid=null) and current course
1440         // with priority to standard outcomes (ORDER clause)
1441         // outcome is not course unique, use get_record_sql to suppress warning
1442         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
1443         if (!$outdb = $DB->get_record_sql('SELECT *
1444                                              FROM {grade_outcomes}
1445                                             WHERE shortname = :shortname
1446                                               AND (courseid = :courseid OR courseid IS NULL)
1447                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
1448             // Remap the user
1449             $userid = $this->get_mappingid('user', $data->usermodified);
1450             $data->usermodified = $userid ? $userid : $this->task->get_userid();
1451             // Remap the scale
1452             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
1453             // Remap the course if course outcome
1454             $data->courseid = $data->courseid ? $this->get_courseid() : null;
1455             // If global outcome (course=null), check the user has perms to create it
1456             // falling to course outcome if not
1457             $systemctx = context_system::instance();
1458             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
1459                 $data->courseid = $this->get_courseid();
1460             }
1461             // outcome doesn't exist, create
1462             $newitemid = $DB->insert_record('grade_outcomes', $data);
1463             $restorefiles = true; // We'll restore the files
1464         } else {
1465             // scale exists, use it
1466             $newitemid = $outdb->id;
1467         }
1468         // Set the corresponding grade_outcomes_courses record
1469         $outcourserec = new stdclass();
1470         $outcourserec->courseid  = $this->get_courseid();
1471         $outcourserec->outcomeid = $newitemid;
1472         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
1473             $DB->insert_record('grade_outcomes_courses', $outcourserec);
1474         }
1475         // Save the id mapping (with files support at system context)
1476         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1477     }
1479     protected function after_execute() {
1480         // Add outcomes related files, matching with "outcome" mappings
1481         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
1482     }
1485 /**
1486  * Execution step that, *conditionally* (if there isn't preloaded information
1487  * will load all the question categories and questions (header info only)
1488  * to backup_temp_ids. They will be stored with "question_category" and
1489  * "question" itemnames and with their original contextid and question category
1490  * id as paremitemids
1491  */
1492 class restore_load_categories_and_questions extends restore_execution_step {
1494     protected function define_execution() {
1496         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1497             return;
1498         }
1499         $file = $this->get_basepath() . '/questions.xml';
1500         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
1501     }
1504 /**
1505  * Execution step that, *conditionally* (if there isn't preloaded information)
1506  * will process all the needed categories and questions
1507  * in order to decide and perform any action with them (create / map / error)
1508  * Note: Any error will cause exception, as far as this is the same processing
1509  * than the one into restore prechecks (that should have stopped process earlier)
1510  */
1511 class restore_process_categories_and_questions extends restore_execution_step {
1513     protected function define_execution() {
1515         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1516             return;
1517         }
1518         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
1519     }
1522 /**
1523  * Structure step that will read the section.xml creating/updating sections
1524  * as needed, rebuilding course cache and other friends
1525  */
1526 class restore_section_structure_step extends restore_structure_step {
1527     /** @var array Cache: Array of id => course format */
1528     private static $courseformats = array();
1530     /**
1531      * Resets a static cache of course formats. Required for unit testing.
1532      */
1533     public static function reset_caches() {
1534         self::$courseformats = array();
1535     }
1537     protected function define_structure() {
1538         global $CFG;
1540         $paths = array();
1542         $section = new restore_path_element('section', '/section');
1543         $paths[] = $section;
1544         if ($CFG->enableavailability) {
1545             $paths[] = new restore_path_element('availability', '/section/availability');
1546             $paths[] = new restore_path_element('availability_field', '/section/availability_field');
1547         }
1548         $paths[] = new restore_path_element('course_format_options', '/section/course_format_options');
1550         // Apply for 'format' plugins optional paths at section level
1551         $this->add_plugin_structure('format', $section);
1553         // Apply for 'local' plugins optional paths at section level
1554         $this->add_plugin_structure('local', $section);
1556         return $paths;
1557     }
1559     public function process_section($data) {
1560         global $CFG, $DB;
1561         $data = (object)$data;
1562         $oldid = $data->id; // We'll need this later
1564         $restorefiles = false;
1566         // Look for the section
1567         $section = new stdclass();
1568         $section->course  = $this->get_courseid();
1569         $section->section = $data->number;
1570         $section->timemodified = $data->timemodified ?? 0;
1571         // Section doesn't exist, create it with all the info from backup
1572         if (!$secrec = $DB->get_record('course_sections', ['course' => $this->get_courseid(), 'section' => $data->number])) {
1573             $section->name = $data->name;
1574             $section->summary = $data->summary;
1575             $section->summaryformat = $data->summaryformat;
1576             $section->sequence = '';
1577             $section->visible = $data->visible;
1578             if (empty($CFG->enableavailability)) { // Process availability information only if enabled.
1579                 $section->availability = null;
1580             } else {
1581                 $section->availability = isset($data->availabilityjson) ? $data->availabilityjson : null;
1582                 // Include legacy [<2.7] availability data if provided.
1583                 if (is_null($section->availability)) {
1584                     $section->availability = \core_availability\info::convert_legacy_fields(
1585                             $data, true);
1586                 }
1587             }
1588             $newitemid = $DB->insert_record('course_sections', $section);
1589             $section->id = $newitemid;
1591             core\event\course_section_created::create_from_section($section)->trigger();
1593             $restorefiles = true;
1595         // Section exists, update non-empty information
1596         } else {
1597             $section->id = $secrec->id;
1598             if ((string)$secrec->name === '') {
1599                 $section->name = $data->name;
1600             }
1601             if (empty($secrec->summary)) {
1602                 $section->summary = $data->summary;
1603                 $section->summaryformat = $data->summaryformat;
1604                 $restorefiles = true;
1605             }
1607             // Don't update availability (I didn't see a useful way to define
1608             // whether existing or new one should take precedence).
1610             $DB->update_record('course_sections', $section);
1611             $newitemid = $secrec->id;
1613             // Trigger an event for course section update.
1614             $event = \core\event\course_section_updated::create(
1615                 array(
1616                     'objectid' => $section->id,
1617                     'courseid' => $section->course,
1618                     'context' => context_course::instance($section->course),
1619                     'other' => array('sectionnum' => $section->section)
1620                 )
1621             );
1622             $event->trigger();
1623         }
1625         // Annotate the section mapping, with restorefiles option if needed
1626         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
1628         // set the new course_section id in the task
1629         $this->task->set_sectionid($newitemid);
1631         // If there is the legacy showavailability data, store this for later use.
1632         // (This data is not present when restoring 'new' backups.)
1633         if (isset($data->showavailability)) {
1634             // Cache the showavailability flag using the backup_ids data field.
1635             restore_dbops::set_backup_ids_record($this->get_restoreid(),
1636                     'section_showavailability', $newitemid, 0, null,
1637                     (object)array('showavailability' => $data->showavailability));
1638         }
1640         // Commented out. We never modify course->numsections as far as that is used
1641         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
1642         // Note: We keep the code here, to know about and because of the possibility of making this
1643         // optional based on some setting/attribute in the future
1644         // If needed, adjust course->numsections
1645         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
1646         //    if ($numsections < $section->section) {
1647         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
1648         //    }
1649         //}
1650     }
1652     /**
1653      * Process the legacy availability table record. This table does not exist
1654      * in Moodle 2.7+ but we still support restore.
1655      *
1656      * @param stdClass $data Record data
1657      */
1658     public function process_availability($data) {
1659         $data = (object)$data;
1660         // Simply going to store the whole availability record now, we'll process
1661         // all them later in the final task (once all activities have been restored)
1662         // Let's call the low level one to be able to store the whole object.
1663         $data->coursesectionid = $this->task->get_sectionid();
1664         restore_dbops::set_backup_ids_record($this->get_restoreid(),
1665                 'section_availability', $data->id, 0, null, $data);
1666     }
1668     /**
1669      * Process the legacy availability fields table record. This table does not
1670      * exist in Moodle 2.7+ but we still support restore.
1671      *
1672      * @param stdClass $data Record data
1673      */
1674     public function process_availability_field($data) {
1675         global $DB;
1676         $data = (object)$data;
1677         // Mark it is as passed by default
1678         $passed = true;
1679         $customfieldid = null;
1681         // If a customfield has been used in order to pass we must be able to match an existing
1682         // customfield by name (data->customfield) and type (data->customfieldtype)
1683         if (is_null($data->customfield) xor is_null($data->customfieldtype)) {
1684             // xor is sort of uncommon. If either customfield is null or customfieldtype is null BUT not both.
1685             // If one is null but the other isn't something clearly went wrong and we'll skip this condition.
1686             $passed = false;
1687         } else if (!is_null($data->customfield)) {
1688             $params = array('shortname' => $data->customfield, 'datatype' => $data->customfieldtype);
1689             $customfieldid = $DB->get_field('user_info_field', 'id', $params);
1690             $passed = ($customfieldid !== false);
1691         }
1693         if ($passed) {
1694             // Create the object to insert into the database
1695             $availfield = new stdClass();
1696             $availfield->coursesectionid = $this->task->get_sectionid();
1697             $availfield->userfield = $data->userfield;
1698             $availfield->customfieldid = $customfieldid;
1699             $availfield->operator = $data->operator;
1700             $availfield->value = $data->value;
1702             // Get showavailability option.
1703             $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
1704                     'section_showavailability', $availfield->coursesectionid);
1705             if (!$showrec) {
1706                 // Should not happen.
1707                 throw new coding_exception('No matching showavailability record');
1708             }
1709             $show = $showrec->info->showavailability;
1711             // The $availfield object is now in the format used in the old
1712             // system. Interpret this and convert to new system.
1713             $currentvalue = $DB->get_field('course_sections', 'availability',
1714                     array('id' => $availfield->coursesectionid), MUST_EXIST);
1715             $newvalue = \core_availability\info::add_legacy_availability_field_condition(
1716                     $currentvalue, $availfield, $show);
1718             $section = new stdClass();
1719             $section->id = $availfield->coursesectionid;
1720             $section->availability = $newvalue;
1721             $section->timemodified = time();
1722             $DB->update_record('course_sections', $section);
1723         }
1724     }
1726     public function process_course_format_options($data) {
1727         global $DB;
1728         $courseid = $this->get_courseid();
1729         if (!array_key_exists($courseid, self::$courseformats)) {
1730             // It is safe to have a static cache of course formats because format can not be changed after this point.
1731             self::$courseformats[$courseid] = $DB->get_field('course', 'format', array('id' => $courseid));
1732         }
1733         $data = (array)$data;
1734         if (self::$courseformats[$courseid] === $data['format']) {
1735             // Import section format options only if both courses (the one that was backed up
1736             // and the one we are restoring into) have same formats.
1737             $params = array(
1738                 'courseid' => $this->get_courseid(),
1739                 'sectionid' => $this->task->get_sectionid(),
1740                 'format' => $data['format'],
1741                 'name' => $data['name']
1742             );
1743             if ($record = $DB->get_record('course_format_options', $params, 'id, value')) {
1744                 // Do not overwrite existing information.
1745                 $newid = $record->id;
1746             } else {
1747                 $params['value'] = $data['value'];
1748                 $newid = $DB->insert_record('course_format_options', $params);
1749             }
1750             $this->set_mapping('course_format_options', $data['id'], $newid);
1751         }
1752     }
1754     protected function after_execute() {
1755         // Add section related files, with 'course_section' itemid to match
1756         $this->add_related_files('course', 'section', 'course_section');
1757     }
1760 /**
1761  * Structure step that will read the course.xml file, loading it and performing
1762  * various actions depending of the site/restore settings. Note that target
1763  * course always exist before arriving here so this step will be updating
1764  * the course record (never inserting)
1765  */
1766 class restore_course_structure_step extends restore_structure_step {
1767     /**
1768      * @var bool this gets set to true by {@link process_course()} if we are
1769      * restoring an old coures that used the legacy 'module security' feature.
1770      * If so, we have to do more work in {@link after_execute()}.
1771      */
1772     protected $legacyrestrictmodules = false;
1774     /**
1775      * @var array Used when {@link $legacyrestrictmodules} is true. This is an
1776      * array with array keys the module names ('forum', 'quiz', etc.). These are
1777      * the modules that are allowed according to the data in the backup file.
1778      * In {@link after_execute()} we then have to prevent adding of all the other
1779      * types of activity.
1780      */
1781     protected $legacyallowedmodules = array();
1783     protected function define_structure() {
1785         $course = new restore_path_element('course', '/course');
1786         $category = new restore_path_element('category', '/course/category');
1787         $tag = new restore_path_element('tag', '/course/tags/tag');
1788         $customfield = new restore_path_element('customfield', '/course/customfields/customfield');
1789         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1791         // Apply for 'format' plugins optional paths at course level
1792         $this->add_plugin_structure('format', $course);
1794         // Apply for 'theme' plugins optional paths at course level
1795         $this->add_plugin_structure('theme', $course);
1797         // Apply for 'report' plugins optional paths at course level
1798         $this->add_plugin_structure('report', $course);
1800         // Apply for 'course report' plugins optional paths at course level
1801         $this->add_plugin_structure('coursereport', $course);
1803         // Apply for plagiarism plugins optional paths at course level
1804         $this->add_plugin_structure('plagiarism', $course);
1806         // Apply for local plugins optional paths at course level
1807         $this->add_plugin_structure('local', $course);
1809         // Apply for admin tool plugins optional paths at course level.
1810         $this->add_plugin_structure('tool', $course);
1812         return array($course, $category, $tag, $customfield, $allowed_module);
1813     }
1815     /**
1816      * Processing functions go here
1817      *
1818      * @global moodledatabase $DB
1819      * @param stdClass $data
1820      */
1821     public function process_course($data) {
1822         global $CFG, $DB;
1823         $context = context::instance_by_id($this->task->get_contextid());
1824         $userid = $this->task->get_userid();
1825         $target = $this->get_task()->get_target();
1826         $isnewcourse = $target == backup::TARGET_NEW_COURSE;
1828         // When restoring to a new course we can set all the things except for the ID number.
1829         $canchangeidnumber = $isnewcourse || has_capability('moodle/course:changeidnumber', $context, $userid);
1830         $canchangesummary = $isnewcourse || has_capability('moodle/course:changesummary', $context, $userid);
1831         $canforcelanguage = has_capability('moodle/course:setforcedlanguage', $context, $userid);
1833         $data = (object)$data;
1834         $data->id = $this->get_courseid();
1836         // Calculate final course names, to avoid dupes.
1837         $fullname  = $this->get_setting_value('course_fullname');
1838         $shortname = $this->get_setting_value('course_shortname');
1839         list($data->fullname, $data->shortname) = restore_dbops::calculate_course_names($this->get_courseid(),
1840             $fullname === false ? $data->fullname : $fullname,
1841             $shortname === false ? $data->shortname : $shortname);
1842         // Do not modify the course names at all when merging and user selected to keep the names (or prohibited by cap).
1843         if (!$isnewcourse && $fullname === false) {
1844             unset($data->fullname);
1845         }
1846         if (!$isnewcourse && $shortname === false) {
1847             unset($data->shortname);
1848         }
1850         // Unset summary if user can't change it.
1851         if (!$canchangesummary) {
1852             unset($data->summary);
1853             unset($data->summaryformat);
1854         }
1856         // Unset lang if user can't change it.
1857         if (!$canforcelanguage) {
1858             unset($data->lang);
1859         }
1861         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1862         // another course on this site.
1863         if (!empty($data->idnumber) && $canchangeidnumber && $this->task->is_samesite()
1864                 && !$DB->record_exists('course', array('idnumber' => $data->idnumber))) {
1865             // Do not reset idnumber.
1867         } else if (!$isnewcourse) {
1868             // Prevent override when restoring as merge.
1869             unset($data->idnumber);
1871         } else {
1872             $data->idnumber = '';
1873         }
1875         // Any empty value for course->hiddensections will lead to 0 (default, show collapsed).
1876         // It has been reported that some old 1.9 courses may have it null leading to DB error. MDL-31532
1877         if (empty($data->hiddensections)) {
1878             $data->hiddensections = 0;
1879         }
1881         // Set legacyrestrictmodules to true if the course was resticting modules. If so
1882         // then we will need to process restricted modules after execution.
1883         $this->legacyrestrictmodules = !empty($data->restrictmodules);
1885         $data->startdate= $this->apply_date_offset($data->startdate);
1886         if (isset($data->enddate)) {
1887             $data->enddate = $this->apply_date_offset($data->enddate);
1888         }
1890         if ($data->defaultgroupingid) {
1891             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1892         }
1893         if (empty($CFG->enablecompletion)) {
1894             $data->enablecompletion = 0;
1895             $data->completionstartonenrol = 0;
1896             $data->completionnotify = 0;
1897         }
1898         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1899         if (isset($data->lang) && !array_key_exists($data->lang, $languages)) {
1900             $data->lang = '';
1901         }
1903         $themes = get_list_of_themes(); // Get themes for quick search later
1904         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1905             $data->theme = '';
1906         }
1908         // Check if this is an old SCORM course format.
1909         if ($data->format == 'scorm') {
1910             $data->format = 'singleactivity';
1911             $data->activitytype = 'scorm';
1912         }
1914         // Course record ready, update it
1915         $DB->update_record('course', $data);
1917         course_get_format($data)->update_course_format_options($data);
1919         // Role name aliases
1920         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1921     }
1923     public function process_category($data) {
1924         // Nothing to do with the category. UI sets it before restore starts
1925     }
1927     public function process_tag($data) {
1928         global $CFG, $DB;
1930         $data = (object)$data;
1932         core_tag_tag::add_item_tag('core', 'course', $this->get_courseid(),
1933                 context_course::instance($this->get_courseid()), $data->rawname);
1934     }
1936     /**
1937      * Process custom fields
1938      *
1939      * @param array $data
1940      */
1941     public function process_customfield($data) {
1942         $handler = core_course\customfield\course_handler::create();
1943         $handler->restore_instance_data_from_backup($this->task, $data);
1944     }
1946     public function process_allowed_module($data) {
1947         $data = (object)$data;
1949         // Backwards compatiblity support for the data that used to be in the
1950         // course_allowed_modules table.
1951         if ($this->legacyrestrictmodules) {
1952             $this->legacyallowedmodules[$data->modulename] = 1;
1953         }
1954     }
1956     protected function after_execute() {
1957         global $DB;
1959         // Add course related files, without itemid to match
1960         $this->add_related_files('course', 'summary', null);
1961         $this->add_related_files('course', 'overviewfiles', null);
1963         // Deal with legacy allowed modules.
1964         if ($this->legacyrestrictmodules) {
1965             $context = context_course::instance($this->get_courseid());
1967             list($roleids) = get_roles_with_cap_in_context($context, 'moodle/course:manageactivities');
1968             list($managerroleids) = get_roles_with_cap_in_context($context, 'moodle/site:config');
1969             foreach ($managerroleids as $roleid) {
1970                 unset($roleids[$roleid]);
1971             }
1973             foreach (core_component::get_plugin_list('mod') as $modname => $notused) {
1974                 if (isset($this->legacyallowedmodules[$modname])) {
1975                     // Module is allowed, no worries.
1976                     continue;
1977                 }
1979                 $capability = 'mod/' . $modname . ':addinstance';
1980                 foreach ($roleids as $roleid) {
1981                     assign_capability($capability, CAP_PREVENT, $roleid, $context);
1982                 }
1983             }
1984         }
1985     }
1988 /**
1989  * Execution step that will migrate legacy files if present.
1990  */
1991 class restore_course_legacy_files_step extends restore_execution_step {
1992     public function define_execution() {
1993         global $DB;
1995         // Do a check for legacy files and skip if there are none.
1996         $sql = 'SELECT count(*)
1997                   FROM {backup_files_temp}
1998                  WHERE backupid = ?
1999                    AND contextid = ?
2000                    AND component = ?
2001                    AND filearea  = ?';
2002         $params = array($this->get_restoreid(), $this->task->get_old_contextid(), 'course', 'legacy');
2004         if ($DB->count_records_sql($sql, $params)) {
2005             $DB->set_field('course', 'legacyfiles', 2, array('id' => $this->get_courseid()));
2006             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'course',
2007                 'legacy', $this->task->get_old_contextid(), $this->task->get_userid());
2008         }
2009     }
2012 /*
2013  * Structure step that will read the roles.xml file (at course/activity/block levels)
2014  * containing all the role_assignments and overrides for that context. If corresponding to
2015  * one mapped role, they will be applied to target context. Will observe the role_assignments
2016  * setting to decide if ras are restored.
2017  *
2018  * Note: this needs to be executed after all users are enrolled.
2019  */
2020 class restore_ras_and_caps_structure_step extends restore_structure_step {
2021     protected $plugins = null;
2023     protected function define_structure() {
2025         $paths = array();
2027         // Observe the role_assignments setting
2028         if ($this->get_setting_value('role_assignments')) {
2029             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
2030         }
2031         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
2033         return $paths;
2034     }
2036     /**
2037      * Assign roles
2038      *
2039      * This has to be called after enrolments processing.
2040      *
2041      * @param mixed $data
2042      * @return void
2043      */
2044     public function process_assignment($data) {
2045         global $DB;
2047         $data = (object)$data;
2049         // Check roleid, userid are one of the mapped ones
2050         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
2051             return;
2052         }
2053         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
2054             return;
2055         }
2056         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
2057             // Only assign roles to not deleted users
2058             return;
2059         }
2060         if (!$contextid = $this->task->get_contextid()) {
2061             return;
2062         }
2064         if (empty($data->component)) {
2065             // assign standard manual roles
2066             // TODO: role_assign() needs one userid param to be able to specify our restore userid
2067             role_assign($newroleid, $newuserid, $contextid);
2069         } else if ((strpos($data->component, 'enrol_') === 0)) {
2070             // Deal with enrolment roles - ignore the component and just find out the instance via new id,
2071             // it is possible that enrolment was restored using different plugin type.
2072             if (!isset($this->plugins)) {
2073                 $this->plugins = enrol_get_plugins(true);
2074             }
2075             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
2076                 if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
2077                     if (isset($this->plugins[$instance->enrol])) {
2078                         $this->plugins[$instance->enrol]->restore_role_assignment($instance, $newroleid, $newuserid, $contextid);
2079                     }
2080                 }
2081             }
2083         } else {
2084             $data->roleid    = $newroleid;
2085             $data->userid    = $newuserid;
2086             $data->contextid = $contextid;
2087             $dir = core_component::get_component_directory($data->component);
2088             if ($dir and is_dir($dir)) {
2089                 if (component_callback($data->component, 'restore_role_assignment', array($this, $data), true)) {
2090                     return;
2091                 }
2092             }
2093             // Bad luck, plugin could not restore the data, let's add normal membership.
2094             role_assign($data->roleid, $data->userid, $data->contextid);
2095             $message = "Restore of '$data->component/$data->itemid' role assignments is not supported, using manual role assignments instead.";
2096             $this->log($message, backup::LOG_WARNING);
2097         }
2098     }
2100     public function process_override($data) {
2101         $data = (object)$data;
2103         // Check roleid is one of the mapped ones
2104         $newroleid = $this->get_mappingid('role', $data->roleid);
2105         // If newroleid and context are valid assign it via API (it handles dupes and so on)
2106         if ($newroleid && $this->task->get_contextid()) {
2107             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
2108             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
2109             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
2110         }
2111     }
2114 /**
2115  * If no instances yet add default enrol methods the same way as when creating new course in UI.
2116  */
2117 class restore_default_enrolments_step extends restore_execution_step {
2119     public function define_execution() {
2120         global $DB;
2122         // No enrolments in front page.
2123         if ($this->get_courseid() == SITEID) {
2124             return;
2125         }
2127         $course = $DB->get_record('course', array('id'=>$this->get_courseid()), '*', MUST_EXIST);
2129         if ($DB->record_exists('enrol', array('courseid'=>$this->get_courseid(), 'enrol'=>'manual'))) {
2130             // Something already added instances, do not add default instances.
2131             $plugins = enrol_get_plugins(true);
2132             foreach ($plugins as $plugin) {
2133                 $plugin->restore_sync_course($course);
2134             }
2136         } else {
2137             // Looks like a newly created course.
2138             enrol_course_updated(true, $course, null);
2139         }
2140     }
2143 /**
2144  * This structure steps restores the enrol plugins and their underlying
2145  * enrolments, performing all the mappings and/or movements required
2146  */
2147 class restore_enrolments_structure_step extends restore_structure_step {
2148     protected $enrolsynced = false;
2149     protected $plugins = null;
2150     protected $originalstatus = array();
2152     /**
2153      * Conditionally decide if this step should be executed.
2154      *
2155      * This function checks the following parameter:
2156      *
2157      *   1. the course/enrolments.xml file exists
2158      *
2159      * @return bool true is safe to execute, false otherwise
2160      */
2161     protected function execute_condition() {
2163         if ($this->get_courseid() == SITEID) {
2164             return false;
2165         }
2167         // Check it is included in the backup
2168         $fullpath = $this->task->get_taskbasepath();
2169         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2170         if (!file_exists($fullpath)) {
2171             // Not found, can't restore enrolments info
2172             return false;
2173         }
2175         return true;
2176     }
2178     protected function define_structure() {
2180         $userinfo = $this->get_setting_value('users');
2182         $paths = [];
2183         $paths[] = $enrol = new restore_path_element('enrol', '/enrolments/enrols/enrol');
2184         if ($userinfo) {
2185             $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
2186         }
2187         // Attach local plugin stucture to enrol element.
2188         $this->add_plugin_structure('enrol', $enrol);
2190         return $paths;
2191     }
2193     /**
2194      * Create enrolment instances.
2195      *
2196      * This has to be called after creation of roles
2197      * and before adding of role assignments.
2198      *
2199      * @param mixed $data
2200      * @return void
2201      */
2202     public function process_enrol($data) {
2203         global $DB;
2205         $data = (object)$data;
2206         $oldid = $data->id; // We'll need this later.
2207         unset($data->id);
2209         $this->originalstatus[$oldid] = $data->status;
2211         if (!$courserec = $DB->get_record('course', array('id' => $this->get_courseid()))) {
2212             $this->set_mapping('enrol', $oldid, 0);
2213             return;
2214         }
2216         if (!isset($this->plugins)) {
2217             $this->plugins = enrol_get_plugins(true);
2218         }
2220         if (!$this->enrolsynced) {
2221             // Make sure that all plugin may create instances and enrolments automatically
2222             // before the first instance restore - this is suitable especially for plugins
2223             // that synchronise data automatically using course->idnumber or by course categories.
2224             foreach ($this->plugins as $plugin) {
2225                 $plugin->restore_sync_course($courserec);
2226             }
2227             $this->enrolsynced = true;
2228         }
2230         // Map standard fields - plugin has to process custom fields manually.
2231         $data->roleid   = $this->get_mappingid('role', $data->roleid);
2232         $data->courseid = $courserec->id;
2234         if (!$this->get_setting_value('users') && $this->get_setting_value('enrolments') == backup::ENROL_WITHUSERS) {
2235             $converttomanual = true;
2236         } else {
2237             $converttomanual = ($this->get_setting_value('enrolments') == backup::ENROL_NEVER);
2238         }
2240         if ($converttomanual) {
2241             // Restore enrolments as manual enrolments.
2242             unset($data->sortorder); // Remove useless sortorder from <2.4 backups.
2243             if (!enrol_is_enabled('manual')) {
2244                 $this->set_mapping('enrol', $oldid, 0);
2245                 return;
2246             }
2247             if ($instances = $DB->get_records('enrol', array('courseid'=>$data->courseid, 'enrol'=>'manual'), 'id')) {
2248                 $instance = reset($instances);
2249                 $this->set_mapping('enrol', $oldid, $instance->id);
2250             } else {
2251                 if ($data->enrol === 'manual') {
2252                     $instanceid = $this->plugins['manual']->add_instance($courserec, (array)$data);
2253                 } else {
2254                     $instanceid = $this->plugins['manual']->add_default_instance($courserec);
2255                 }
2256                 $this->set_mapping('enrol', $oldid, $instanceid);
2257             }
2259         } else {
2260             if (!enrol_is_enabled($data->enrol) or !isset($this->plugins[$data->enrol])) {
2261                 $this->set_mapping('enrol', $oldid, 0);
2262                 $message = "Enrol plugin '$data->enrol' data can not be restored because it is not enabled, consider restoring without enrolment methods";
2263                 $this->log($message, backup::LOG_WARNING);
2264                 return;
2265             }
2266             if ($task = $this->get_task() and $task->get_target() == backup::TARGET_NEW_COURSE) {
2267                 // Let's keep the sortorder in old backups.
2268             } else {
2269                 // Prevent problems with colliding sortorders in old backups,
2270                 // new 2.4 backups do not need sortorder because xml elements are ordered properly.
2271                 unset($data->sortorder);
2272             }
2273             // Note: plugin is responsible for setting up the mapping, it may also decide to migrate to different type.
2274             $this->plugins[$data->enrol]->restore_instance($this, $data, $courserec, $oldid);
2275         }
2276     }
2278     /**
2279      * Create user enrolments.
2280      *
2281      * This has to be called after creation of enrolment instances
2282      * and before adding of role assignments.
2283      *
2284      * Roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing afterwards.
2285      *
2286      * @param mixed $data
2287      * @return void
2288      */
2289     public function process_enrolment($data) {
2290         global $DB;
2292         if (!isset($this->plugins)) {
2293             $this->plugins = enrol_get_plugins(true);
2294         }
2296         $data = (object)$data;
2298         // Process only if parent instance have been mapped.
2299         if ($enrolid = $this->get_new_parentid('enrol')) {
2300             $oldinstancestatus = ENROL_INSTANCE_ENABLED;
2301             $oldenrolid = $this->get_old_parentid('enrol');
2302             if (isset($this->originalstatus[$oldenrolid])) {
2303                 $oldinstancestatus = $this->originalstatus[$oldenrolid];
2304             }
2305             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
2306                 // And only if user is a mapped one.
2307                 if ($userid = $this->get_mappingid('user', $data->userid)) {
2308                     if (isset($this->plugins[$instance->enrol])) {
2309                         $this->plugins[$instance->enrol]->restore_user_enrolment($this, $data, $instance, $userid, $oldinstancestatus);
2310                     }
2311                 }
2312             }
2313         }
2314     }
2318 /**
2319  * Make sure the user restoring the course can actually access it.
2320  */
2321 class restore_fix_restorer_access_step extends restore_execution_step {
2322     protected function define_execution() {
2323         global $CFG, $DB;
2325         if (!$userid = $this->task->get_userid()) {
2326             return;
2327         }
2329         if (empty($CFG->restorernewroleid)) {
2330             // Bad luck, no fallback role for restorers specified
2331             return;
2332         }
2334         $courseid = $this->get_courseid();
2335         $context = context_course::instance($courseid);
2337         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
2338             // Current user may access the course (admin, category manager or restored teacher enrolment usually)
2339             return;
2340         }
2342         // Try to add role only - we do not need enrolment if user has moodle/course:view or is already enrolled
2343         role_assign($CFG->restorernewroleid, $userid, $context);
2345         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
2346             // Extra role is enough, yay!
2347             return;
2348         }
2350         // The last chance is to create manual enrol if it does not exist and and try to enrol the current user,
2351         // hopefully admin selected suitable $CFG->restorernewroleid ...
2352         if (!enrol_is_enabled('manual')) {
2353             return;
2354         }
2355         if (!$enrol = enrol_get_plugin('manual')) {
2356             return;
2357         }
2358         if (!$DB->record_exists('enrol', array('enrol'=>'manual', 'courseid'=>$courseid))) {
2359             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
2360             $fields = array('status'=>ENROL_INSTANCE_ENABLED, 'enrolperiod'=>$enrol->get_config('enrolperiod', 0), 'roleid'=>$enrol->get_config('roleid', 0));
2361             $enrol->add_instance($course, $fields);
2362         }
2364         enrol_try_internal_enrol($courseid, $userid);
2365     }
2369 /**
2370  * This structure steps restores the filters and their configs
2371  */
2372 class restore_filters_structure_step extends restore_structure_step {
2374     protected function define_structure() {
2376         $paths = array();
2378         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
2379         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
2381         return $paths;
2382     }
2384     public function process_active($data) {
2386         $data = (object)$data;
2388         if (strpos($data->filter, 'filter/') === 0) {
2389             $data->filter = substr($data->filter, 7);
2391         } else if (strpos($data->filter, '/') !== false) {
2392             // Unsupported old filter.
2393             return;
2394         }
2396         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
2397             return;
2398         }
2399         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
2400     }
2402     public function process_config($data) {
2404         $data = (object)$data;
2406         if (strpos($data->filter, 'filter/') === 0) {
2407             $data->filter = substr($data->filter, 7);
2409         } else if (strpos($data->filter, '/') !== false) {
2410             // Unsupported old filter.
2411             return;
2412         }
2414         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
2415             return;
2416         }
2417         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
2418     }
2422 /**
2423  * This structure steps restores the comments
2424  * Note: Cannot use the comments API because defaults to USER->id.
2425  * That should change allowing to pass $userid
2426  */
2427 class restore_comments_structure_step extends restore_structure_step {
2429     protected function define_structure() {
2431         $paths = array();
2433         $paths[] = new restore_path_element('comment', '/comments/comment');
2435         return $paths;
2436     }
2438     public function process_comment($data) {
2439         global $DB;
2441         $data = (object)$data;
2443         // First of all, if the comment has some itemid, ask to the task what to map
2444         $mapping = false;
2445         if ($data->itemid) {
2446             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
2447             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
2448         }
2449         // Only restore the comment if has no mapping OR we have found the matching mapping
2450         if (!$mapping || $data->itemid) {
2451             // Only if user mapping and context
2452             $data->userid = $this->get_mappingid('user', $data->userid);
2453             if ($data->userid && $this->task->get_contextid()) {
2454                 $data->contextid = $this->task->get_contextid();
2455                 // Only if there is another comment with same context/user/timecreated
2456                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
2457                 if (!$DB->record_exists('comments', $params)) {
2458                     $DB->insert_record('comments', $data);
2459                 }
2460             }
2461         }
2462     }
2465 /**
2466  * This structure steps restores the badges and their configs
2467  */
2468 class restore_badges_structure_step extends restore_structure_step {
2470     /**
2471      * Conditionally decide if this step should be executed.
2472      *
2473      * This function checks the following parameters:
2474      *
2475      *   1. Badges and course badges are enabled on the site.
2476      *   2. The course/badges.xml file exists.
2477      *   3. All modules are restorable.
2478      *   4. All modules are marked for restore.
2479      *
2480      * @return bool True is safe to execute, false otherwise
2481      */
2482     protected function execute_condition() {
2483         global $CFG;
2485         // First check is badges and course level badges are enabled on this site.
2486         if (empty($CFG->enablebadges) || empty($CFG->badges_allowcoursebadges)) {
2487             // Disabled, don't restore course badges.
2488             return false;
2489         }
2491         // Check if badges.xml is included in the backup.
2492         $fullpath = $this->task->get_taskbasepath();
2493         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2494         if (!file_exists($fullpath)) {
2495             // Not found, can't restore course badges.
2496             return false;
2497         }
2499         // Check we are able to restore all backed up modules.
2500         if ($this->task->is_missing_modules()) {
2501             return false;
2502         }
2504         // Finally check all modules within the backup are being restored.
2505         if ($this->task->is_excluding_activities()) {
2506             return false;
2507         }
2509         return true;
2510     }
2512     protected function define_structure() {
2513         $paths = array();
2514         $paths[] = new restore_path_element('badge', '/badges/badge');
2515         $paths[] = new restore_path_element('criterion', '/badges/badge/criteria/criterion');
2516         $paths[] = new restore_path_element('parameter', '/badges/badge/criteria/criterion/parameters/parameter');
2517         $paths[] = new restore_path_element('manual_award', '/badges/badge/manual_awards/manual_award');
2519         return $paths;
2520     }
2522     public function process_badge($data) {
2523         global $DB, $CFG;
2525         require_once($CFG->libdir . '/badgeslib.php');
2527         $data = (object)$data;
2528         $data->usercreated = $this->get_mappingid('user', $data->usercreated);
2529         if (empty($data->usercreated)) {
2530             $data->usercreated = $this->task->get_userid();
2531         }
2532         $data->usermodified = $this->get_mappingid('user', $data->usermodified);
2533         if (empty($data->usermodified)) {
2534             $data->usermodified = $this->task->get_userid();
2535         }
2537         // We'll restore the badge image.
2538         $restorefiles = true;
2540         $courseid = $this->get_courseid();
2542         $params = array(
2543                 'name'           => $data->name,
2544                 'description'    => $data->description,
2545                 'timecreated'    => $data->timecreated,
2546                 'timemodified'   => $data->timemodified,
2547                 'usercreated'    => $data->usercreated,
2548                 'usermodified'   => $data->usermodified,
2549                 'issuername'     => $data->issuername,
2550                 'issuerurl'      => $data->issuerurl,
2551                 'issuercontact'  => $data->issuercontact,
2552                 'expiredate'     => $this->apply_date_offset($data->expiredate),
2553                 'expireperiod'   => $data->expireperiod,
2554                 'type'           => BADGE_TYPE_COURSE,
2555                 'courseid'       => $courseid,
2556                 'message'        => $data->message,
2557                 'messagesubject' => $data->messagesubject,
2558                 'attachment'     => $data->attachment,
2559                 'notification'   => $data->notification,
2560                 'status'         => BADGE_STATUS_INACTIVE,
2561                 'nextcron'       => $data->nextcron
2562         );
2564         $newid = $DB->insert_record('badge', $params);
2565         $this->set_mapping('badge', $data->id, $newid, $restorefiles);
2566     }
2568     public function process_criterion($data) {
2569         global $DB;
2571         $data = (object)$data;
2573         $params = array(
2574                 'badgeid'           => $this->get_new_parentid('badge'),
2575                 'criteriatype'      => $data->criteriatype,
2576                 'method'            => $data->method,
2577                 'description'       => isset($data->description) ? $data->description : '',
2578                 'descriptionformat' => isset($data->descriptionformat) ? $data->descriptionformat : 0,
2579         );
2580         $newid = $DB->insert_record('badge_criteria', $params);
2581         $this->set_mapping('criterion', $data->id, $newid);
2582     }
2584     public function process_parameter($data) {
2585         global $DB, $CFG;
2587         require_once($CFG->libdir . '/badgeslib.php');
2589         $data = (object)$data;
2590         $criteriaid = $this->get_new_parentid('criterion');
2592         // Parameter array that will go to database.
2593         $params = array();
2594         $params['critid'] = $criteriaid;
2596         $oldparam = explode('_', $data->name);
2598         if ($data->criteriatype == BADGE_CRITERIA_TYPE_ACTIVITY) {
2599             $module = $this->get_mappingid('course_module', $oldparam[1]);
2600             $params['name'] = $oldparam[0] . '_' . $module;
2601             $params['value'] = $oldparam[0] == 'module' ? $module : $data->value;
2602         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_COURSE) {
2603             $params['name'] = $oldparam[0] . '_' . $this->get_courseid();
2604             $params['value'] = $oldparam[0] == 'course' ? $this->get_courseid() : $data->value;
2605         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_MANUAL) {
2606             $role = $this->get_mappingid('role', $data->value);
2607             if (!empty($role)) {
2608                 $params['name'] = 'role_' . $role;
2609                 $params['value'] = $role;
2610             } else {
2611                 return;
2612             }
2613         }
2615         if (!$DB->record_exists('badge_criteria_param', $params)) {
2616             $DB->insert_record('badge_criteria_param', $params);
2617         }
2618     }
2620     public function process_manual_award($data) {
2621         global $DB;
2623         $data = (object)$data;
2624         $role = $this->get_mappingid('role', $data->issuerrole);
2626         if (!empty($role)) {
2627             $award = array(
2628                 'badgeid'     => $this->get_new_parentid('badge'),
2629                 'recipientid' => $this->get_mappingid('user', $data->recipientid),
2630                 'issuerid'    => $this->get_mappingid('user', $data->issuerid),
2631                 'issuerrole'  => $role,
2632                 'datemet'     => $this->apply_date_offset($data->datemet)
2633             );
2635             // Skip the manual award if recipient or issuer can not be mapped to.
2636             if (empty($award['recipientid']) || empty($award['issuerid'])) {
2637                 return;
2638             }
2640             $DB->insert_record('badge_manual_award', $award);
2641         }
2642     }
2644     protected function after_execute() {
2645         // Add related files.
2646         $this->add_related_files('badges', 'badgeimage', 'badge');
2647     }
2650 /**
2651  * This structure steps restores the calendar events
2652  */
2653 class restore_calendarevents_structure_step extends restore_structure_step {
2655     protected function define_structure() {
2657         $paths = array();
2659         $paths[] = new restore_path_element('calendarevents', '/events/event');
2661         return $paths;
2662     }
2664     public function process_calendarevents($data) {
2665         global $DB, $SITE, $USER;
2667         $data = (object)$data;
2668         $oldid = $data->id;
2669         $restorefiles = true; // We'll restore the files
2671         // If this is a new action event, it will automatically be populated by the adhoc task.
2672         // Nothing to do here.
2673         if (isset($data->type) && $data->type == CALENDAR_EVENT_TYPE_ACTION) {
2674             return;
2675         }
2677         // User overrides for activities are identified by having a courseid of zero with
2678         // both a modulename and instance value set.
2679         $isuseroverride = !$data->courseid && $data->modulename && $data->instance;
2681         // If we don't want to include user data and this record is a user override event
2682         // for an activity then we should not create it. (Only activity events can be user override events - which must have this
2683         // setting).
2684         if ($isuseroverride && $this->task->setting_exists('userinfo') && !$this->task->get_setting_value('userinfo')) {
2685             return;
2686         }
2688         // Find the userid and the groupid associated with the event.
2689         $data->userid = $this->get_mappingid('user', $data->userid);
2690         if ($data->userid === false) {
2691             // Blank user ID means that we are dealing with module generated events such as quiz starting times.
2692             // Use the current user ID for these events.
2693             $data->userid = $USER->id;
2694         }
2695         if (!empty($data->groupid)) {
2696             $data->groupid = $this->get_mappingid('group', $data->groupid);
2697             if ($data->groupid === false) {
2698                 return;
2699             }
2700         }
2701         // Handle events with empty eventtype //MDL-32827
2702         if(empty($data->eventtype)) {
2703             if ($data->courseid == $SITE->id) {                                // Site event
2704                 $data->eventtype = "site";
2705             } else if ($data->courseid != 0 && $data->groupid == 0 && ($data->modulename == 'assignment' || $data->modulename == 'assign')) {
2706                 // Course assingment event
2707                 $data->eventtype = "due";
2708             } else if ($data->courseid != 0 && $data->groupid == 0) {      // Course event
2709                 $data->eventtype = "course";
2710             } else if ($data->groupid) {                                      // Group event
2711                 $data->eventtype = "group";
2712             } else if ($data->userid) {                                       // User event
2713                 $data->eventtype = "user";
2714             } else {
2715                 return;
2716             }
2717         }
2719         $params = array(
2720                 'name'           => $data->name,
2721                 'description'    => $data->description,
2722                 'format'         => $data->format,
2723                 // User overrides in activities use a course id of zero. All other event types
2724                 // must use the mapped course id.
2725                 'courseid'       => $data->courseid ? $this->get_courseid() : 0,
2726                 'groupid'        => $data->groupid,
2727                 'userid'         => $data->userid,
2728                 'repeatid'       => $this->get_mappingid('event', $data->repeatid),
2729                 'modulename'     => $data->modulename,
2730                 'type'           => isset($data->type) ? $data->type : 0,
2731                 'eventtype'      => $data->eventtype,
2732                 'timestart'      => $this->apply_date_offset($data->timestart),
2733                 'timeduration'   => $data->timeduration,
2734                 'timesort'       => isset($data->timesort) ? $this->apply_date_offset($data->timesort) : null,
2735                 'visible'        => $data->visible,
2736                 'uuid'           => $data->uuid,
2737                 'sequence'       => $data->sequence,
2738                 'timemodified'   => $data->timemodified,
2739                 'priority'       => isset($data->priority) ? $data->priority : null,
2740                 'location'       => isset($data->location) ? $data->location : null);
2741         if ($this->name == 'activity_calendar') {
2742             $params['instance'] = $this->task->get_activityid();
2743         } else {
2744             $params['instance'] = 0;
2745         }
2746         $sql = "SELECT id
2747                   FROM {event}
2748                  WHERE " . $DB->sql_compare_text('name', 255) . " = " . $DB->sql_compare_text('?', 255) . "
2749                    AND courseid = ?
2750                    AND modulename = ?
2751                    AND instance = ?
2752                    AND timestart = ?
2753                    AND timeduration = ?
2754                    AND " . $DB->sql_compare_text('description', 255) . " = " . $DB->sql_compare_text('?', 255);
2755         $arg = array ($params['name'], $params['courseid'], $params['modulename'], $params['instance'], $params['timestart'], $params['timeduration'], $params['description']);
2756         $result = $DB->record_exists_sql($sql, $arg);
2757         if (empty($result)) {
2758             $newitemid = $DB->insert_record('event', $params);
2759             $this->set_mapping('event', $oldid, $newitemid);
2760             $this->set_mapping('event_description', $oldid, $newitemid, $restorefiles);
2761         }
2762         // With repeating events, each event has the repeatid pointed at the first occurrence.
2763         // Since the repeatid will be empty when the first occurrence is restored,
2764         // Get the repeatid from the second occurrence of the repeating event and use that to update the first occurrence.
2765         // Then keep a list of repeatids so we only perform this update once.
2766         static $repeatids = array();
2767         if (!empty($params['repeatid']) && !in_array($params['repeatid'], $repeatids)) {
2768             // This entry is repeated so the repeatid field must be set.
2769             $DB->set_field('event', 'repeatid', $params['repeatid'], array('id' => $params['repeatid']));
2770             $repeatids[] = $params['repeatid'];
2771         }
2773     }
2774     protected function after_execute() {
2775         // Add related files
2776         $this->add_related_files('calendar', 'event_description', 'event_description');
2777     }
2780 class restore_course_completion_structure_step extends restore_structure_step {
2782     /**
2783      * Conditionally decide if this step should be executed.
2784      *
2785      * This function checks parameters that are not immediate settings to ensure
2786      * that the enviroment is suitable for the restore of course completion info.
2787      *
2788      * This function checks the following four parameters:
2789      *
2790      *   1. Course completion is enabled on the site
2791      *   2. The backup includes course completion information
2792      *   3. All modules are restorable
2793      *   4. All modules are marked for restore.
2794      *   5. No completion criteria already exist for the course.
2795      *
2796      * @return bool True is safe to execute, false otherwise
2797      */
2798     protected function execute_condition() {
2799         global $CFG, $DB;
2801         // First check course completion is enabled on this site
2802         if (empty($CFG->enablecompletion)) {
2803             // Disabled, don't restore course completion
2804             return false;
2805         }
2807         // No course completion on the front page.
2808         if ($this->get_courseid() == SITEID) {
2809             return false;
2810         }
2812         // Check it is included in the backup
2813         $fullpath = $this->task->get_taskbasepath();
2814         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2815         if (!file_exists($fullpath)) {
2816             // Not found, can't restore course completion
2817             return false;
2818         }
2820         // Check we are able to restore all backed up modules
2821         if ($this->task->is_missing_modules()) {
2822             return false;
2823         }
2825         // Check all modules within the backup are being restored.
2826         if ($this->task->is_excluding_activities()) {
2827             return false;
2828         }
2830         // Check that no completion criteria is already set for the course.
2831         if ($DB->record_exists('course_completion_criteria', array('course' => $this->get_courseid()))) {
2832             return false;
2833         }
2835         return true;
2836     }
2838     /**
2839      * Define the course completion structure
2840      *
2841      * @return array Array of restore_path_element
2842      */
2843     protected function define_structure() {
2845         // To know if we are including user completion info
2846         $userinfo = $this->get_setting_value('userscompletion');
2848         $paths = array();
2849         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
2850         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
2852         if ($userinfo) {
2853             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
2854             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
2855         }
2857         return $paths;
2859     }
2861     /**
2862      * Process course completion criteria
2863      *
2864      * @global moodle_database $DB
2865      * @param stdClass $data
2866      */
2867     public function process_course_completion_criteria($data) {
2868         global $DB;
2870         $data = (object)$data;
2871         $data->course = $this->get_courseid();
2873         // Apply the date offset to the time end field
2874         $data->timeend = $this->apply_date_offset($data->timeend);
2876         // Map the role from the criteria
2877         if (isset($data->role) && $data->role != '') {
2878             // Newer backups should include roleshortname, which makes this much easier.
2879             if (!empty($data->roleshortname)) {
2880                 $roleinstanceid = $DB->get_field('role', 'id', array('shortname' => $data->roleshortname));
2881                 if (!$roleinstanceid) {
2882                     $this->log(
2883                         'Could not match the role shortname in course_completion_criteria, so skipping',
2884                         backup::LOG_DEBUG
2885                     );
2886                     return;
2887                 }
2888                 $data->role = $roleinstanceid;
2889             } else {
2890                 $data->role = $this->get_mappingid('role', $data->role);
2891             }
2893             // Check we have an id, otherwise it causes all sorts of bugs.
2894             if (!$data->role) {
2895                 $this->log(
2896                     'Could not match role in course_completion_criteria, so skipping',
2897                     backup::LOG_DEBUG
2898                 );
2899                 return;
2900             }
2901         }
2903         // If the completion criteria is for a module we need to map the module instance
2904         // to the new module id.
2905         if (!empty($data->moduleinstance) && !empty($data->module)) {
2906             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
2907             if (empty($data->moduleinstance)) {
2908                 $this->log(
2909                     'Could not match the module instance in course_completion_criteria, so skipping',
2910                     backup::LOG_DEBUG
2911                 );
2912                 return;
2913             }
2914         } else {
2915             $data->module = null;
2916             $data->moduleinstance = null;
2917         }
2919         // We backup the course shortname rather than the ID so that we can match back to the course
2920         if (!empty($data->courseinstanceshortname)) {
2921             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
2922             if (!$courseinstanceid) {
2923                 $this->log(
2924                     'Could not match the course instance in course_completion_criteria, so skipping',
2925                     backup::LOG_DEBUG
2926                 );
2927                 return;
2928             }
2929         } else {
2930             $courseinstanceid = null;
2931         }
2932         $data->courseinstance = $courseinstanceid;
2934         $params = array(
2935             'course'         => $data->course,
2936             'criteriatype'   => $data->criteriatype,
2937             'enrolperiod'    => $data->enrolperiod,
2938             'courseinstance' => $data->courseinstance,
2939             'module'         => $data->module,
2940             'moduleinstance' => $data->moduleinstance,
2941             'timeend'        => $data->timeend,
2942             'gradepass'      => $data->gradepass,
2943             'role'           => $data->role
2944         );
2945         $newid = $DB->insert_record('course_completion_criteria', $params);
2946         $this->set_mapping('course_completion_criteria', $data->id, $newid);
2947     }
2949     /**
2950      * Processes course compltion criteria complete records
2951      *
2952      * @global moodle_database $DB
2953      * @param stdClass $data
2954      */
2955     public function process_course_completion_crit_compl($data) {
2956         global $DB;
2958         $data = (object)$data;
2960         // This may be empty if criteria could not be restored
2961         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
2963         $data->course = $this->get_courseid();
2964         $data->userid = $this->get_mappingid('user', $data->userid);
2966         if (!empty($data->criteriaid) && !empty($data->userid)) {
2967             $params = array(
2968                 'userid' => $data->userid,
2969                 'course' => $data->course,
2970                 'criteriaid' => $data->criteriaid,
2971                 'timecompleted' => $data->timecompleted
2972             );
2973             if (isset($data->gradefinal)) {
2974                 $params['gradefinal'] = $data->gradefinal;
2975             }
2976             if (isset($data->unenroled)) {
2977                 $params['unenroled'] = $data->unenroled;
2978             }
2979             $DB->insert_record('course_completion_crit_compl', $params);
2980         }
2981     }
2983     /**
2984      * Process course completions
2985      *
2986      * @global moodle_database $DB
2987      * @param stdClass $data
2988      */
2989     public function process_course_completions($data) {
2990         global $DB;
2992         $data = (object)$data;
2994         $data->course = $this->get_courseid();
2995         $data->userid = $this->get_mappingid('user', $data->userid);
2997         if (!empty($data->userid)) {
2998             $params = array(
2999                 'userid' => $data->userid,
3000                 'course' => $data->course,
3001                 'timeenrolled' => $data->timeenrolled,
3002                 'timestarted' => $data->timestarted,
3003                 'timecompleted' => $data->timecompleted,
3004                 'reaggregate' => $data->reaggregate
3005             );
3007             $existing = $DB->get_record('course_completions', array(
3008                 'userid' => $data->userid,
3009                 'course' => $data->course
3010             ));
3012             // MDL-46651 - If cron writes out a new record before we get to it
3013             // then we should replace it with the Truth data from the backup.
3014             // This may be obsolete after MDL-48518 is resolved
3015             if ($existing) {
3016                 $params['id'] = $existing->id;
3017                 $DB->update_record('course_completions', $params);
3018             } else {
3019                 $DB->insert_record('course_completions', $params);
3020             }
3021         }
3022     }
3024     /**
3025      * Process course completion aggregate methods
3026      *
3027      * @global moodle_database $DB
3028      * @param stdClass $data
3029      */
3030     public function process_course_completion_aggr_methd($data) {
3031         global $DB;
3033         $data = (object)$data;
3035         $data->course = $this->get_courseid();
3037         // Only create the course_completion_aggr_methd records if
3038         // the target course has not them defined. MDL-28180
3039         if (!$DB->record_exists('course_completion_aggr_methd', array(
3040                     'course' => $data->course,
3041                     'criteriatype' => $data->criteriatype))) {
3042             $params = array(
3043                 'course' => $data->course,
3044                 'criteriatype' => $data->criteriatype,
3045                 'method' => $data->method,
3046                 'value' => $data->value,
3047             );
3048             $DB->insert_record('course_completion_aggr_methd', $params);
3049         }
3050     }
3054 /**
3055  * This structure step restores course logs (cmid = 0), delegating
3056  * the hard work to the corresponding {@link restore_logs_processor} passing the
3057  * collection of {@link restore_log_rule} rules to be observed as they are defined
3058  * by the task. Note this is only executed based in the 'logs' setting.
3059  *
3060  * NOTE: This is executed by final task, to have all the activities already restored
3061  *
3062  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
3063  * records are. There are others like 'calendar' and 'upload' that will be handled
3064  * later.
3065  *
3066  * NOTE: All the missing actions (not able to be restored) are sent to logs for
3067  * debugging purposes
3068  */
3069 class restore_course_logs_structure_step extends restore_structure_step {
3071     /**
3072      * Conditionally decide if this step should be executed.
3073      *
3074      * This function checks the following parameter:
3075      *
3076      *   1. the course/logs.xml file exists
3077      *
3078      * @return bool true is safe to execute, false otherwise
3079      */
3080     protected function execute_condition() {
3082         // Check it is included in the backup
3083         $fullpath = $this->task->get_taskbasepath();
3084         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
3085         if (!file_exists($fullpath)) {
3086             // Not found, can't restore course logs
3087             return false;
3088         }
3090         return true;
3091     }
3093     protected function define_structure() {
3095         $paths = array();
3097         // Simple, one plain level of information contains them
3098         $paths[] = new restore_path_element('log', '/logs/log');
3100         return $paths;
3101     }
3103     protected function process_log($data) {
3104         global $DB;
3106         $data = (object)($data);
3108         // There is no need to roll dates. Logs are supposed to be immutable. See MDL-44961.
3110         $data->userid = $this->get_mappingid('user', $data->userid);
3111         $data->course = $this->get_courseid();
3112         $data->cmid = 0;
3114         // For any reason user wasn't remapped ok, stop processing this
3115         if (empty($data->userid)) {
3116             return;
3117         }
3119         // Everything ready, let's delegate to the restore_logs_processor
3121         // Set some fixed values that will save tons of DB requests
3122         $values = array(
3123             'course' => $this->get_courseid());
3124         // Get instance and process log record
3125         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
3127         // If we have data, insert it, else something went wrong in the restore_logs_processor
3128         if ($data) {
3129             if (empty($data->url)) {
3130                 $data->url = '';
3131             }
3132             if (empty($data->info)) {
3133                 $data->info = '';
3134             }
3135             // Store the data in the legacy log table if we are still using it.
3136             $manager = get_log_manager();
3137             if (method_exists($manager, 'legacy_add_to_log')) {
3138                 $manager->legacy_add_to_log($data->course, $data->module, $data->action, $data->url,
3139                     $data->info, $data->cmid, $data->userid, $data->ip, $data->time);
3140             }
3141         }
3142     }
3145 /**
3146  * This structure step restores activity logs, extending {@link restore_course_logs_structure_step}
3147  * sharing its same structure but modifying the way records are handled
3148  */
3149 class restore_activity_logs_structure_step extends restore_course_logs_structure_step {
3151     protected function process_log($data) {
3152         global $DB;
3154         $data = (object)($data);
3156         // There is no need to roll dates. Logs are supposed to be immutable. See MDL-44961.
3158         $data->userid = $this->get_mappingid('user', $data->userid);
3159         $data->course = $this->get_courseid();
3160         $data->cmid = $this->task->get_moduleid();
3162         // For any reason user wasn't remapped ok, stop processing this
3163         if (empty($data->userid)) {
3164             return;
3165         }
3167         // Everything ready, let's delegate to the restore_logs_processor
3169         // Set some fixed values that will save tons of DB requests
3170         $values = array(
3171             'course' => $this->get_courseid(),
3172             'course_module' => $this->task->get_moduleid(),
3173             $this->task->get_modulename() => $this->task->get_activityid());
3174         // Get instance and process log record
3175         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
3177         // If we have data, insert it, else something went wrong in the restore_logs_processor
3178         if ($data) {
3179             if (empty($data->url)) {
3180                 $data->url = '';
3181             }
3182             if (empty($data->info)) {
3183                 $data->info = '';
3184             }
3185             // Store the data in the legacy log table if we are still using it.
3186             $manager = get_log_manager();
3187             if (method_exists($manager, 'legacy_add_to_log')) {
3188                 $manager->legacy_add_to_log($data->course, $data->module, $data->action, $data->url,
3189                     $data->info, $data->cmid, $data->userid, $data->ip, $data->time);
3190             }
3191         }
3192     }
3195 /**
3196  * Structure step in charge of restoring the logstores.xml file for the course logs.
3197  *
3198  * This restore step will rebuild the logs for all the enabled logstore subplugins supporting
3199  * it, for logs belonging to the course level.
3200  */
3201 class restore_course_logstores_structure_step extends restore_structure_step {
3203     /**
3204      * Conditionally decide if this step should be executed.
3205      *
3206      * This function checks the following parameter:
3207      *
3208      *   1. the logstores.xml file exists
3209      *
3210      * @return bool true is safe to execute, false otherwise
3211      */
3212     protected function execute_condition() {
3214         // Check it is included in the backup.
3215         $fullpath = $this->task->get_taskbasepath();
3216         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
3217         if (!file_exists($fullpath)) {
3218             // Not found, can't restore logstores.xml information.
3219             return false;
3220         }
3222         return true;
3223     }
3225     /**
3226      * Return the elements to be processed on restore of logstores.
3227      *
3228      * @return restore_path_element[] array of elements to be processed on restore.
3229      */
3230     protected function define_structure() {