b23fda48f613529888f7503b91f4accdc67ae4bb
[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);
207         $data->timecreated  = $this->apply_date_offset($data->timecreated);
208         $data->timemodified = $this->apply_date_offset($data->timemodified);
210         $coursecategory = $newitemid = null;
211         //course grade item should already exist so updating instead of inserting
212         if($data->itemtype=='course') {
213             //get the ID of the already created grade item
214             $gi = new stdclass();
215             $gi->courseid  = $this->get_courseid();
216             $gi->itemtype  = $data->itemtype;
218             //need to get the id of the grade_category that was automatically created for the course
219             $category = new stdclass();
220             $category->courseid  = $this->get_courseid();
221             $category->parent  = null;
222             //course category fullname starts out as ? but may be edited
223             //$category->fullname  = '?';
224             $coursecategory = $DB->get_record('grade_categories', (array)$category);
225             $gi->iteminstance = $coursecategory->id;
227             $existinggradeitem = $DB->get_record('grade_items', (array)$gi);
228             if (!empty($existinggradeitem)) {
229                 $data->id = $newitemid = $existinggradeitem->id;
230                 $DB->update_record('grade_items', $data);
231             }
232         } else if ($data->itemtype == 'manual') {
233             // Manual items aren't assigned to a cm, so don't go duplicating them in the target if one exists.
234             $gi = array(
235                 'itemtype' => $data->itemtype,
236                 'courseid' => $data->courseid,
237                 'itemname' => $data->itemname,
238                 'categoryid' => $data->categoryid,
239             );
240             $newitemid = $DB->get_field('grade_items', 'id', $gi);
241         }
243         if (empty($newitemid)) {
244             //in case we found the course category but still need to insert the course grade item
245             if ($data->itemtype=='course' && !empty($coursecategory)) {
246                 $data->iteminstance = $coursecategory->id;
247             }
249             $newitemid = $DB->insert_record('grade_items', $data);
250         }
251         $this->set_mapping('grade_item', $oldid, $newitemid);
252     }
254     protected function process_grade_grade($data) {
255         global $DB;
257         $data = (object)$data;
258         $oldid = $data->id;
259         $olduserid = $data->userid;
261         $data->itemid = $this->get_new_parentid('grade_item');
263         $data->userid = $this->get_mappingid('user', $data->userid, null);
264         if (!empty($data->userid)) {
265             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
266             $data->locktime     = $this->apply_date_offset($data->locktime);
267             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
268             $data->overridden = $this->apply_date_offset($data->overridden);
269             $data->timecreated  = $this->apply_date_offset($data->timecreated);
270             $data->timemodified = $this->apply_date_offset($data->timemodified);
272             $gradeexists = $DB->record_exists('grade_grades', array('userid' => $data->userid, 'itemid' => $data->itemid));
273             if ($gradeexists) {
274                 $message = "User id '{$data->userid}' already has a grade entry for grade item id '{$data->itemid}'";
275                 $this->log($message, backup::LOG_DEBUG);
276             } else {
277                 $newitemid = $DB->insert_record('grade_grades', $data);
278                 $this->set_mapping('grade_grades', $oldid, $newitemid);
279             }
280         } else {
281             $message = "Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'";
282             $this->log($message, backup::LOG_DEBUG);
283         }
284     }
286     protected function process_grade_category($data) {
287         global $DB;
289         $data = (object)$data;
290         $oldid = $data->id;
292         $data->course = $this->get_courseid();
293         $data->courseid = $data->course;
295         $data->timecreated  = $this->apply_date_offset($data->timecreated);
296         $data->timemodified = $this->apply_date_offset($data->timemodified);
298         $newitemid = null;
299         //no parent means a course level grade category. That may have been created when the course was created
300         if(empty($data->parent)) {
301             //parent was being saved as 0 when it should be null
302             $data->parent = null;
304             //get the already created course level grade category
305             $category = new stdclass();
306             $category->courseid = $this->get_courseid();
307             $category->parent = null;
309             $coursecategory = $DB->get_record('grade_categories', (array)$category);
310             if (!empty($coursecategory)) {
311                 $data->id = $newitemid = $coursecategory->id;
312                 $DB->update_record('grade_categories', $data);
313             }
314         }
316         // Add a warning about a removed setting.
317         if (!empty($data->aggregatesubcats)) {
318             set_config('show_aggregatesubcats_upgrade_' . $data->courseid, 1);
319         }
321         //need to insert a course category
322         if (empty($newitemid)) {
323             $newitemid = $DB->insert_record('grade_categories', $data);
324         }
325         $this->set_mapping('grade_category', $oldid, $newitemid);
326     }
327     protected function process_grade_letter($data) {
328         global $DB;
330         $data = (object)$data;
331         $oldid = $data->id;
333         $data->contextid = context_course::instance($this->get_courseid())->id;
335         $gradeletter = (array)$data;
336         unset($gradeletter['id']);
337         if (!$DB->record_exists('grade_letters', $gradeletter)) {
338             $newitemid = $DB->insert_record('grade_letters', $data);
339         } else {
340             $newitemid = $data->id;
341         }
343         $this->set_mapping('grade_letter', $oldid, $newitemid);
344     }
345     protected function process_grade_setting($data) {
346         global $DB;
348         $data = (object)$data;
349         $oldid = $data->id;
351         $data->courseid = $this->get_courseid();
353         $target = $this->get_task()->get_target();
354         if ($data->name == 'minmaxtouse' &&
355                 ($target == backup::TARGET_CURRENT_ADDING || $target == backup::TARGET_EXISTING_ADDING)) {
356             // We never restore minmaxtouse during merge.
357             return;
358         }
360         if (!$DB->record_exists('grade_settings', array('courseid' => $data->courseid, 'name' => $data->name))) {
361             $newitemid = $DB->insert_record('grade_settings', $data);
362         } else {
363             $newitemid = $data->id;
364         }
366         if (!empty($oldid)) {
367             // In rare cases (minmaxtouse), it is possible that there wasn't any ID associated with the setting.
368             $this->set_mapping('grade_setting', $oldid, $newitemid);
369         }
370     }
372     /**
373      * put all activity grade items in the correct grade category and mark all for recalculation
374      */
375     protected function after_execute() {
376         global $DB;
378         $conditions = array(
379             'backupid' => $this->get_restoreid(),
380             'itemname' => 'grade_item'//,
381             //'itemid'   => $itemid
382         );
383         $rs = $DB->get_recordset('backup_ids_temp', $conditions);
385         // We need this for calculation magic later on.
386         $mappings = array();
388         if (!empty($rs)) {
389             foreach($rs as $grade_item_backup) {
391                 // Store the oldid with the new id.
392                 $mappings[$grade_item_backup->itemid] = $grade_item_backup->newitemid;
394                 $updateobj = new stdclass();
395                 $updateobj->id = $grade_item_backup->newitemid;
397                 //if this is an activity grade item that needs to be put back in its correct category
398                 if (!empty($grade_item_backup->parentitemid)) {
399                     $oldcategoryid = $this->get_mappingid('grade_category', $grade_item_backup->parentitemid, null);
400                     if (!is_null($oldcategoryid)) {
401                         $updateobj->categoryid = $oldcategoryid;
402                         $DB->update_record('grade_items', $updateobj);
403                     }
404                 } else {
405                     //mark course and category items as needing to be recalculated
406                     $updateobj->needsupdate=1;
407                     $DB->update_record('grade_items', $updateobj);
408                 }
409             }
410         }
411         $rs->close();
413         // We need to update the calculations for calculated grade items that may reference old
414         // grade item ids using ##gi\d+##.
415         // $mappings can be empty, use 0 if so (won't match ever)
416         list($sql, $params) = $DB->get_in_or_equal(array_values($mappings), SQL_PARAMS_NAMED, 'param', true, 0);
417         $sql = "SELECT gi.id, gi.calculation
418                   FROM {grade_items} gi
419                  WHERE gi.id {$sql} AND
420                        calculation IS NOT NULL";
421         $rs = $DB->get_recordset_sql($sql, $params);
422         foreach ($rs as $gradeitem) {
423             // Collect all of the used grade item id references
424             if (preg_match_all('/##gi(\d+)##/', $gradeitem->calculation, $matches) < 1) {
425                 // This calculation doesn't reference any other grade items... EASY!
426                 continue;
427             }
428             // For this next bit we are going to do the replacement of id's in two steps:
429             // 1. We will replace all old id references with a special mapping reference.
430             // 2. We will replace all mapping references with id's
431             // Why do we do this?
432             // Because there potentially there will be an overlap of ids within the query and we
433             // we substitute the wrong id.. safest way around this is the two step system
434             $calculationmap = array();
435             $mapcount = 0;
436             foreach ($matches[1] as $match) {
437                 // Check that the old id is known to us, if not it was broken to begin with and will
438                 // continue to be broken.
439                 if (!array_key_exists($match, $mappings)) {
440                     continue;
441                 }
442                 // Our special mapping key
443                 $mapping = '##MAPPING'.$mapcount.'##';
444                 // The old id that exists within the calculation now
445                 $oldid = '##gi'.$match.'##';
446                 // The new id that we want to replace the old one with.
447                 $newid = '##gi'.$mappings[$match].'##';
448                 // Replace in the special mapping key
449                 $gradeitem->calculation = str_replace($oldid, $mapping, $gradeitem->calculation);
450                 // And record the mapping
451                 $calculationmap[$mapping] = $newid;
452                 $mapcount++;
453             }
454             // Iterate all special mappings for this calculation and replace in the new id's
455             foreach ($calculationmap as $mapping => $newid) {
456                 $gradeitem->calculation = str_replace($mapping, $newid, $gradeitem->calculation);
457             }
458             // Update the calculation now that its being remapped
459             $DB->update_record('grade_items', $gradeitem);
460         }
461         $rs->close();
463         // Need to correct the grade category path and parent
464         $conditions = array(
465             'courseid' => $this->get_courseid()
466         );
468         $rs = $DB->get_recordset('grade_categories', $conditions);
469         // Get all the parents correct first as grade_category::build_path() loads category parents from the DB
470         foreach ($rs as $gc) {
471             if (!empty($gc->parent)) {
472                 $grade_category = new stdClass();
473                 $grade_category->id = $gc->id;
474                 $grade_category->parent = $this->get_mappingid('grade_category', $gc->parent);
475                 $DB->update_record('grade_categories', $grade_category);
476             }
477         }
478         $rs->close();
480         // Now we can rebuild all the paths
481         $rs = $DB->get_recordset('grade_categories', $conditions);
482         foreach ($rs as $gc) {
483             $grade_category = new stdClass();
484             $grade_category->id = $gc->id;
485             $grade_category->path = grade_category::build_path($gc);
486             $grade_category->depth = substr_count($grade_category->path, '/') - 1;
487             $DB->update_record('grade_categories', $grade_category);
488         }
489         $rs->close();
491         // Check what to do with the minmaxtouse setting.
492         $this->check_minmaxtouse();
494         // Freeze gradebook calculations if needed.
495         $this->gradebook_calculation_freeze();
497         // Restore marks items as needing update. Update everything now.
498         grade_regrade_final_grades($this->get_courseid());
499     }
501     /**
502      * Freeze gradebook calculation if needed.
503      *
504      * This is similar to various upgrade scripts that check if the freeze is needed.
505      */
506     protected function gradebook_calculation_freeze() {
507         global $CFG;
508         $gradebookcalculationsfreeze = get_config('core', 'gradebook_calculations_freeze_' . $this->get_courseid());
509         preg_match('/(\d{8})/', $this->get_task()->get_info()->moodle_release, $matches);
510         $backupbuild = (int)$matches[1];
511         // The function floatval will return a float even if there is text mixed with the release number.
512         $backuprelease = floatval($this->get_task()->get_info()->backup_release);
514         // Extra credits need adjustments only for backups made between 2.8 release (20141110) and the fix release (20150619).
515         if (!$gradebookcalculationsfreeze && $backupbuild >= 20141110 && $backupbuild < 20150619) {
516             require_once($CFG->libdir . '/db/upgradelib.php');
517             upgrade_extra_credit_weightoverride($this->get_courseid());
518         }
519         // Calculated grade items need recalculating for backups made between 2.8 release (20141110) and the fix release (20150627).
520         if (!$gradebookcalculationsfreeze && $backupbuild >= 20141110 && $backupbuild < 20150627) {
521             require_once($CFG->libdir . '/db/upgradelib.php');
522             upgrade_calculated_grade_items($this->get_courseid());
523         }
524         // Courses from before 3.1 (20160518) may have a letter boundary problem and should be checked for this issue.
525         // Backups from before and including 2.9 could have a build number that is greater than 20160518 and should
526         // be checked for this problem.
527         if (!$gradebookcalculationsfreeze && ($backupbuild < 20160518 || $backuprelease <= 2.9)) {
528             require_once($CFG->libdir . '/db/upgradelib.php');
529             upgrade_course_letter_boundary($this->get_courseid());
530         }
532     }
534     /**
535      * Checks what should happen with the course grade setting minmaxtouse.
536      *
537      * This is related to the upgrade step at the time the setting was added.
538      *
539      * @see MDL-48618
540      * @return void
541      */
542     protected function check_minmaxtouse() {
543         global $CFG, $DB;
544         require_once($CFG->libdir . '/gradelib.php');
546         $userinfo = $this->task->get_setting_value('users');
547         $settingname = 'minmaxtouse';
548         $courseid = $this->get_courseid();
549         $minmaxtouse = $DB->get_field('grade_settings', 'value', array('courseid' => $courseid, 'name' => $settingname));
550         $version28start = 2014111000.00;
551         $version28last = 2014111006.05;
552         $version29start = 2015051100.00;
553         $version29last = 2015060400.02;
555         $target = $this->get_task()->get_target();
556         if ($minmaxtouse === false &&
557                 ($target != backup::TARGET_CURRENT_ADDING && $target != backup::TARGET_EXISTING_ADDING)) {
558             // The setting was not found because this setting did not exist at the time the backup was made.
559             // And we are not restoring as merge, in which case we leave the course as it was.
560             $version = $this->get_task()->get_info()->moodle_version;
562             if ($version < $version28start) {
563                 // We need to set it to use grade_item, but only if the site-wide setting is different. No need to notice them.
564                 if ($CFG->grade_minmaxtouse != GRADE_MIN_MAX_FROM_GRADE_ITEM) {
565                     grade_set_setting($courseid, $settingname, GRADE_MIN_MAX_FROM_GRADE_ITEM);
566                 }
568             } else if (($version >= $version28start && $version < $version28last) ||
569                     ($version >= $version29start && $version < $version29last)) {
570                 // They should be using grade_grade when the course has inconsistencies.
572                 $sql = "SELECT gi.id
573                           FROM {grade_items} gi
574                           JOIN {grade_grades} gg
575                             ON gg.itemid = gi.id
576                          WHERE gi.courseid = ?
577                            AND (gi.itemtype != ? AND gi.itemtype != ?)
578                            AND (gg.rawgrademax != gi.grademax OR gg.rawgrademin != gi.grademin)";
580                 // The course can only have inconsistencies when we restore the user info,
581                 // we do not need to act on existing grades that were not restored as part of this backup.
582                 if ($userinfo && $DB->record_exists_sql($sql, array($courseid, 'course', 'category'))) {
584                     // Display the notice as we do during upgrade.
585                     set_config('show_min_max_grades_changed_' . $courseid, 1);
587                     if ($CFG->grade_minmaxtouse != GRADE_MIN_MAX_FROM_GRADE_GRADE) {
588                         // We need set the setting as their site-wise setting is not GRADE_MIN_MAX_FROM_GRADE_GRADE.
589                         // If they are using the site-wide grade_grade setting, we only want to notice them.
590                         grade_set_setting($courseid, $settingname, GRADE_MIN_MAX_FROM_GRADE_GRADE);
591                     }
592                 }
594             } else {
595                 // This should never happen because from now on minmaxtouse is always saved in backups.
596             }
597         }
598     }
600     /**
601      * Rewrite step definition to handle the legacy freeze attribute.
602      *
603      * In previous backups the calculations_freeze property was stored as an attribute of the
604      * top level node <gradebook>. The backup API, however, do not process grandparent nodes.
605      * It only processes definitive children, and their parent attributes.
606      *
607      * We had:
608      *
609      * <gradebook calculations_freeze="20160511">
610      *   <grade_categories>
611      *     <grade_category id="10">
612      *       <depth>1</depth>
613      *       ...
614      *     </grade_category>
615      *   </grade_categories>
616      *   ...
617      * </gradebook>
618      *
619      * And this method will convert it to:
620      *
621      * <gradebook >
622      *   <attributes>
623      *     <calculations_freeze>20160511</calculations_freeze>
624      *   </attributes>
625      *   <grade_categories>
626      *     <grade_category id="10">
627      *       <depth>1</depth>
628      *       ...
629      *     </grade_category>
630      *   </grade_categories>
631      *   ...
632      * </gradebook>
633      *
634      * Note that we cannot just load the XML file in memory as it could potentially be huge.
635      * We can also completely ignore if the node <attributes> is already in the backup
636      * file as it never existed before.
637      *
638      * @param string $filepath The absolute path to the XML file.
639      * @return void
640      */
641     protected function rewrite_step_backup_file_for_legacy_freeze($filepath) {
642         $foundnode = false;
643         $newfile = make_request_directory(true) . DIRECTORY_SEPARATOR . 'file.xml';
644         $fr = fopen($filepath, 'r');
645         $fw = fopen($newfile, 'w');
646         if ($fr && $fw) {
647             while (($line = fgets($fr, 4096)) !== false) {
648                 if (!$foundnode && strpos($line, '<gradebook ') === 0) {
649                     $foundnode = true;
650                     $matches = array();
651                     $pattern = '@calculations_freeze=.([0-9]+).@';
652                     if (preg_match($pattern, $line, $matches)) {
653                         $freeze = $matches[1];
654                         $line = preg_replace($pattern, '', $line);
655                         $line .= "  <attributes>\n    <calculations_freeze>$freeze</calculations_freeze>\n  </attributes>\n";
656                     }
657                 }
658                 fputs($fw, $line);
659             }
660             if (!feof($fr)) {
661                 throw new restore_step_exception('Error while attempting to rewrite the gradebook step file.');
662             }
663             fclose($fr);
664             fclose($fw);
665             if (!rename($newfile, $filepath)) {
666                 throw new restore_step_exception('Error while attempting to rename the gradebook step file.');
667             }
668         } else {
669             if ($fr) {
670                 fclose($fr);
671             }
672             if ($fw) {
673                 fclose($fw);
674             }
675         }
676     }
680 /**
681  * Step in charge of restoring the grade history of a course.
682  *
683  * The execution conditions are itendical to {@link restore_gradebook_structure_step} because
684  * we do not want to restore the history if the gradebook and its content has not been
685  * restored. At least for now.
686  */
687 class restore_grade_history_structure_step extends restore_structure_step {
689      protected function execute_condition() {
690         global $CFG, $DB;
692         if ($this->get_courseid() == SITEID) {
693             return false;
694         }
696         // No gradebook info found, don't execute.
697         $fullpath = $this->task->get_taskbasepath();
698         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
699         if (!file_exists($fullpath)) {
700             return false;
701         }
703         // Some module present in backup file isn't available to restore in this site, don't execute.
704         if ($this->task->is_missing_modules()) {
705             return false;
706         }
708         // Some activity has been excluded to be restored, don't execute.
709         if ($this->task->is_excluding_activities()) {
710             return false;
711         }
713         // There should only be one grade category (the 1 associated with the course itself).
714         $category = new stdclass();
715         $category->courseid  = $this->get_courseid();
716         $catcount = $DB->count_records('grade_categories', (array)$category);
717         if ($catcount > 1) {
718             return false;
719         }
721         // Arrived here, execute the step.
722         return true;
723      }
725     protected function define_structure() {
726         $paths = array();
728         // Settings to use.
729         $userinfo = $this->get_setting_value('users');
730         $history = $this->get_setting_value('grade_histories');
732         if ($userinfo && $history) {
733             $paths[] = new restore_path_element('grade_grade',
734                '/grade_history/grade_grades/grade_grade');
735         }
737         return $paths;
738     }
740     protected function process_grade_grade($data) {
741         global $DB;
743         $data = (object)($data);
744         $olduserid = $data->userid;
745         unset($data->id);
747         $data->userid = $this->get_mappingid('user', $data->userid, null);
748         if (!empty($data->userid)) {
749             // Do not apply the date offsets as this is history.
750             $data->itemid = $this->get_mappingid('grade_item', $data->itemid);
751             $data->oldid = $this->get_mappingid('grade_grades', $data->oldid);
752             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
753             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
754             $DB->insert_record('grade_grades_history', $data);
755         } else {
756             $message = "Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'";
757             $this->log($message, backup::LOG_DEBUG);
758         }
759     }
763 /**
764  * decode all the interlinks present in restored content
765  * relying 100% in the restore_decode_processor that handles
766  * both the contents to modify and the rules to be applied
767  */
768 class restore_decode_interlinks extends restore_execution_step {
770     protected function define_execution() {
771         // Get the decoder (from the plan)
772         $decoder = $this->task->get_decoder();
773         restore_decode_processor::register_link_decoders($decoder); // Add decoder contents and rules
774         // And launch it, everything will be processed
775         $decoder->execute();
776     }
779 /**
780  * first, ensure that we have no gaps in section numbers
781  * and then, rebuid the course cache
782  */
783 class restore_rebuild_course_cache extends restore_execution_step {
785     protected function define_execution() {
786         global $DB;
788         // Although there is some sort of auto-recovery of missing sections
789         // present in course/formats... here we check that all the sections
790         // from 0 to MAX(section->section) exist, creating them if necessary
791         $maxsection = $DB->get_field('course_sections', 'MAX(section)', array('course' => $this->get_courseid()));
792         // Iterate over all sections
793         for ($i = 0; $i <= $maxsection; $i++) {
794             // If the section $i doesn't exist, create it
795             if (!$DB->record_exists('course_sections', array('course' => $this->get_courseid(), 'section' => $i))) {
796                 $sectionrec = array(
797                     'course' => $this->get_courseid(),
798                     'section' => $i);
799                 $DB->insert_record('course_sections', $sectionrec); // missing section created
800             }
801         }
803         // Rebuild cache now that all sections are in place
804         rebuild_course_cache($this->get_courseid());
805         cache_helper::purge_by_event('changesincourse');
806         cache_helper::purge_by_event('changesincoursecat');
807     }
810 /**
811  * Review all the tasks having one after_restore method
812  * executing it to perform some final adjustments of information
813  * not available when the task was executed.
814  */
815 class restore_execute_after_restore extends restore_execution_step {
817     protected function define_execution() {
819         // Simply call to the execute_after_restore() method of the task
820         // that always is the restore_final_task
821         $this->task->launch_execute_after_restore();
822     }
826 /**
827  * Review all the (pending) block positions in backup_ids, matching by
828  * contextid, creating positions as needed. This is executed by the
829  * final task, once all the contexts have been created
830  */
831 class restore_review_pending_block_positions extends restore_execution_step {
833     protected function define_execution() {
834         global $DB;
836         // Get all the block_position objects pending to match
837         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
838         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
839         // Process block positions, creating them or accumulating for final step
840         foreach($rs as $posrec) {
841             // Get the complete position object out of the info field.
842             $position = backup_controller_dbops::decode_backup_temp_info($posrec->info);
843             // If position is for one already mapped (known) contextid
844             // process it now, creating the position, else nothing to
845             // do, position finally discarded
846             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
847                 $position->contextid = $newctx->newitemid;
848                 // Create the block position
849                 $DB->insert_record('block_positions', $position);
850             }
851         }
852         $rs->close();
853     }
857 /**
858  * Updates the availability data for course modules and sections.
859  *
860  * Runs after the restore of all course modules, sections, and grade items has
861  * completed. This is necessary in order to update IDs that have changed during
862  * restore.
863  *
864  * @package core_backup
865  * @copyright 2014 The Open University
866  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
867  */
868 class restore_update_availability extends restore_execution_step {
870     protected function define_execution() {
871         global $CFG, $DB;
873         // Note: This code runs even if availability is disabled when restoring.
874         // That will ensure that if you later turn availability on for the site,
875         // there will be no incorrect IDs. (It doesn't take long if the restored
876         // data does not contain any availability information.)
878         // Get modinfo with all data after resetting cache.
879         rebuild_course_cache($this->get_courseid(), true);
880         $modinfo = get_fast_modinfo($this->get_courseid());
882         // Get the date offset for this restore.
883         $dateoffset = $this->apply_date_offset(1) - 1;
885         // Update all sections that were restored.
886         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'course_section');
887         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'newitemid');
888         $sectionsbyid = null;
889         foreach ($rs as $rec) {
890             if (is_null($sectionsbyid)) {
891                 $sectionsbyid = array();
892                 foreach ($modinfo->get_section_info_all() as $section) {
893                     $sectionsbyid[$section->id] = $section;
894                 }
895             }
896             if (!array_key_exists($rec->newitemid, $sectionsbyid)) {
897                 // If the section was not fully restored for some reason
898                 // (e.g. due to an earlier error), skip it.
899                 $this->get_logger()->process('Section not fully restored: id ' .
900                         $rec->newitemid, backup::LOG_WARNING);
901                 continue;
902             }
903             $section = $sectionsbyid[$rec->newitemid];
904             if (!is_null($section->availability)) {
905                 $info = new \core_availability\info_section($section);
906                 $info->update_after_restore($this->get_restoreid(),
907                         $this->get_courseid(), $this->get_logger(), $dateoffset, $this->task);
908             }
909         }
910         $rs->close();
912         // Update all modules that were restored.
913         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'course_module');
914         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'newitemid');
915         foreach ($rs as $rec) {
916             if (!array_key_exists($rec->newitemid, $modinfo->cms)) {
917                 // If the module was not fully restored for some reason
918                 // (e.g. due to an earlier error), skip it.
919                 $this->get_logger()->process('Module not fully restored: id ' .
920                         $rec->newitemid, backup::LOG_WARNING);
921                 continue;
922             }
923             $cm = $modinfo->get_cm($rec->newitemid);
924             if (!is_null($cm->availability)) {
925                 $info = new \core_availability\info_module($cm);
926                 $info->update_after_restore($this->get_restoreid(),
927                         $this->get_courseid(), $this->get_logger(), $dateoffset, $this->task);
928             }
929         }
930         $rs->close();
931     }
935 /**
936  * Process legacy module availability records in backup_ids.
937  *
938  * Matches course modules and grade item id once all them have been already restored.
939  * Only if all matchings are satisfied the availability condition will be created.
940  * At the same time, it is required for the site to have that functionality enabled.
941  *
942  * This step is included only to handle legacy backups (2.6 and before). It does not
943  * do anything for newer backups.
944  *
945  * @copyright 2014 The Open University
946  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
947  */
948 class restore_process_course_modules_availability extends restore_execution_step {
950     protected function define_execution() {
951         global $CFG, $DB;
953         // Site hasn't availability enabled
954         if (empty($CFG->enableavailability)) {
955             return;
956         }
958         // Do both modules and sections.
959         foreach (array('module', 'section') as $table) {
960             // Get all the availability objects to process.
961             $params = array('backupid' => $this->get_restoreid(), 'itemname' => $table . '_availability');
962             $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
963             // Process availabilities, creating them if everything matches ok.
964             foreach ($rs as $availrec) {
965                 $allmatchesok = true;
966                 // Get the complete legacy availability object.
967                 $availability = backup_controller_dbops::decode_backup_temp_info($availrec->info);
969                 // Note: This code used to update IDs, but that is now handled by the
970                 // current code (after restore) instead of this legacy code.
972                 // Get showavailability option.
973                 $thingid = ($table === 'module') ? $availability->coursemoduleid :
974                         $availability->coursesectionid;
975                 $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
976                         $table . '_showavailability', $thingid);
977                 if (!$showrec) {
978                     // Should not happen.
979                     throw new coding_exception('No matching showavailability record');
980                 }
981                 $show = $showrec->info->showavailability;
983                 // The $availability object is now in the format used in the old
984                 // system. Interpret this and convert to new system.
985                 $currentvalue = $DB->get_field('course_' . $table . 's', 'availability',
986                         array('id' => $thingid), MUST_EXIST);
987                 $newvalue = \core_availability\info::add_legacy_availability_condition(
988                         $currentvalue, $availability, $show);
989                 $DB->set_field('course_' . $table . 's', 'availability', $newvalue,
990                         array('id' => $thingid));
991             }
992         }
993         $rs->close();
994     }
998 /*
999  * Execution step that, *conditionally* (if there isn't preloaded information)
1000  * will load the inforef files for all the included course/section/activity tasks
1001  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
1002  */
1003 class restore_load_included_inforef_records extends restore_execution_step {
1005     protected function define_execution() {
1007         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1008             return;
1009         }
1011         // Get all the included tasks
1012         $tasks = restore_dbops::get_included_tasks($this->get_restoreid());
1013         $progress = $this->task->get_progress();
1014         $progress->start_progress($this->get_name(), count($tasks));
1015         foreach ($tasks as $task) {
1016             // Load the inforef.xml file if exists
1017             $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
1018             if (file_exists($inforefpath)) {
1019                 // Load each inforef file to temp_ids.
1020                 restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $inforefpath, $progress);
1021             }
1022         }
1023         $progress->end_progress();
1024     }
1027 /*
1028  * Execution step that will load all the needed files into backup_files_temp
1029  *   - info: contains the whole original object (times, names...)
1030  * (all them being original ids as loaded from xml)
1031  */
1032 class restore_load_included_files extends restore_structure_step {
1034     protected function define_structure() {
1036         $file = new restore_path_element('file', '/files/file');
1038         return array($file);
1039     }
1041     /**
1042      * Process one <file> element from files.xml
1043      *
1044      * @param array $data the element data
1045      */
1046     public function process_file($data) {
1048         $data = (object)$data; // handy
1050         // load it if needed:
1051         //   - it it is one of the annotated inforef files (course/section/activity/block)
1052         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
1053         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
1054         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
1055         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
1056         $iscomponent = ($data->component == 'user' || $data->component == 'group' || $data->component == 'badges' ||
1057                         $data->component == 'grouping' || $data->component == 'grade' ||
1058                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
1059         if ($isfileref || $iscomponent) {
1060             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
1061         }
1062     }
1065 /**
1066  * Execution step that, *conditionally* (if there isn't preloaded information),
1067  * will load all the needed roles to backup_temp_ids. They will be stored with
1068  * "role" itemname. Also it will perform one automatic mapping to roles existing
1069  * in the target site, based in permissions of the user performing the restore,
1070  * archetypes and other bits. At the end, each original role will have its associated
1071  * target role or 0 if it's going to be skipped. Note we wrap everything over one
1072  * restore_dbops method, as far as the same stuff is going to be also executed
1073  * by restore prechecks
1074  */
1075 class restore_load_and_map_roles extends restore_execution_step {
1077     protected function define_execution() {
1078         if ($this->task->get_preloaded_information()) { // if info is already preloaded
1079             return;
1080         }
1082         $file = $this->get_basepath() . '/roles.xml';
1083         // Load needed toles to temp_ids
1084         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
1086         // Process roles, mapping/skipping. Any error throws exception
1087         // Note we pass controller's info because it can contain role mapping information
1088         // about manual mappings performed by UI
1089         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);
1090     }
1093 /**
1094  * Execution step that, *conditionally* (if there isn't preloaded information
1095  * and users have been selected in settings, will load all the needed users
1096  * to backup_temp_ids. They will be stored with "user" itemname and with
1097  * their original contextid as paremitemid
1098  */
1099 class restore_load_included_users extends restore_execution_step {
1101     protected function define_execution() {
1103         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1104             return;
1105         }
1106         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
1107             return;
1108         }
1109         $file = $this->get_basepath() . '/users.xml';
1110         // Load needed users to temp_ids.
1111         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file, $this->task->get_progress());
1112     }
1115 /**
1116  * Execution step that, *conditionally* (if there isn't preloaded information
1117  * and users have been selected in settings, will process all the needed users
1118  * in order to decide and perform any action with them (create / map / error)
1119  * Note: Any error will cause exception, as far as this is the same processing
1120  * than the one into restore prechecks (that should have stopped process earlier)
1121  */
1122 class restore_process_included_users extends restore_execution_step {
1124     protected function define_execution() {
1126         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1127             return;
1128         }
1129         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
1130             return;
1131         }
1132         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(),
1133                 $this->task->get_userid(), $this->task->is_samesite(), $this->task->get_progress());
1134     }
1137 /**
1138  * Execution step that will create all the needed users as calculated
1139  * by @restore_process_included_users (those having newiteind = 0)
1140  */
1141 class restore_create_included_users extends restore_execution_step {
1143     protected function define_execution() {
1145         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(),
1146                 $this->task->get_userid(), $this->task->get_progress());
1147     }
1150 /**
1151  * Structure step that will create all the needed groups and groupings
1152  * by loading them from the groups.xml file performing the required matches.
1153  * Note group members only will be added if restoring user info
1154  */
1155 class restore_groups_structure_step extends restore_structure_step {
1157     protected function define_structure() {
1159         $paths = array(); // Add paths here
1161         // Do not include group/groupings information if not requested.
1162         $groupinfo = $this->get_setting_value('groups');
1163         if ($groupinfo) {
1164             $paths[] = new restore_path_element('group', '/groups/group');
1165             $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
1166             $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
1167         }
1168         return $paths;
1169     }
1171     // Processing functions go here
1172     public function process_group($data) {
1173         global $DB;
1175         $data = (object)$data; // handy
1176         $data->courseid = $this->get_courseid();
1178         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1179         // another a group in the same course
1180         $context = context_course::instance($data->courseid);
1181         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1182             if (groups_get_group_by_idnumber($data->courseid, $data->idnumber)) {
1183                 unset($data->idnumber);
1184             }
1185         } else {
1186             unset($data->idnumber);
1187         }
1189         $oldid = $data->id;    // need this saved for later
1191         $restorefiles = false; // Only if we end creating the group
1193         // Search if the group already exists (by name & description) in the target course
1194         $description_clause = '';
1195         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
1196         if (!empty($data->description)) {
1197             $description_clause = ' AND ' .
1198                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
1199            $params['description'] = $data->description;
1200         }
1201         if (!$groupdb = $DB->get_record_sql("SELECT *
1202                                                FROM {groups}
1203                                               WHERE courseid = :courseid
1204                                                 AND name = :grname $description_clause", $params)) {
1205             // group doesn't exist, create
1206             $newitemid = $DB->insert_record('groups', $data);
1207             $restorefiles = true; // We'll restore the files
1208         } else {
1209             // group exists, use it
1210             $newitemid = $groupdb->id;
1211         }
1212         // Save the id mapping
1213         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
1214         // Invalidate the course group data cache just in case.
1215         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
1216     }
1218     public function process_grouping($data) {
1219         global $DB;
1221         $data = (object)$data; // handy
1222         $data->courseid = $this->get_courseid();
1224         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1225         // another a grouping in the same course
1226         $context = context_course::instance($data->courseid);
1227         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1228             if (groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) {
1229                 unset($data->idnumber);
1230             }
1231         } else {
1232             unset($data->idnumber);
1233         }
1235         $oldid = $data->id;    // need this saved for later
1236         $restorefiles = false; // Only if we end creating the grouping
1238         // Search if the grouping already exists (by name & description) in the target course
1239         $description_clause = '';
1240         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
1241         if (!empty($data->description)) {
1242             $description_clause = ' AND ' .
1243                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
1244            $params['description'] = $data->description;
1245         }
1246         if (!$groupingdb = $DB->get_record_sql("SELECT *
1247                                                   FROM {groupings}
1248                                                  WHERE courseid = :courseid
1249                                                    AND name = :grname $description_clause", $params)) {
1250             // grouping doesn't exist, create
1251             $newitemid = $DB->insert_record('groupings', $data);
1252             $restorefiles = true; // We'll restore the files
1253         } else {
1254             // grouping exists, use it
1255             $newitemid = $groupingdb->id;
1256         }
1257         // Save the id mapping
1258         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
1259         // Invalidate the course group data cache just in case.
1260         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
1261     }
1263     public function process_grouping_group($data) {
1264         global $CFG;
1266         require_once($CFG->dirroot.'/group/lib.php');
1268         $data = (object)$data;
1269         groups_assign_grouping($this->get_new_parentid('grouping'), $this->get_mappingid('group', $data->groupid), $data->timeadded);
1270     }
1272     protected function after_execute() {
1273         // Add group related files, matching with "group" mappings
1274         $this->add_related_files('group', 'icon', 'group');
1275         $this->add_related_files('group', 'description', 'group');
1276         // Add grouping related files, matching with "grouping" mappings
1277         $this->add_related_files('grouping', 'description', 'grouping');
1278         // Invalidate the course group data.
1279         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($this->get_courseid()));
1280     }
1284 /**
1285  * Structure step that will create all the needed group memberships
1286  * by loading them from the groups.xml file performing the required matches.
1287  */
1288 class restore_groups_members_structure_step extends restore_structure_step {
1290     protected $plugins = null;
1292     protected function define_structure() {
1294         $paths = array(); // Add paths here
1296         if ($this->get_setting_value('groups') && $this->get_setting_value('users')) {
1297             $paths[] = new restore_path_element('group', '/groups/group');
1298             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
1299         }
1301         return $paths;
1302     }
1304     public function process_group($data) {
1305         $data = (object)$data; // handy
1307         // HACK ALERT!
1308         // Not much to do here, this groups mapping should be already done from restore_groups_structure_step.
1309         // Let's fake internal state to make $this->get_new_parentid('group') work.
1311         $this->set_mapping('group', $data->id, $this->get_mappingid('group', $data->id));
1312     }
1314     public function process_member($data) {
1315         global $DB, $CFG;
1316         require_once("$CFG->dirroot/group/lib.php");
1318         // NOTE: Always use groups_add_member() because it triggers events and verifies if user is enrolled.
1320         $data = (object)$data; // handy
1322         // get parent group->id
1323         $data->groupid = $this->get_new_parentid('group');
1325         // map user newitemid and insert if not member already
1326         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
1327             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
1328                 // Check the component, if any, exists.
1329                 if (empty($data->component)) {
1330                     groups_add_member($data->groupid, $data->userid);
1332                 } else if ((strpos($data->component, 'enrol_') === 0)) {
1333                     // Deal with enrolment groups - ignore the component and just find out the instance via new id,
1334                     // it is possible that enrolment was restored using different plugin type.
1335                     if (!isset($this->plugins)) {
1336                         $this->plugins = enrol_get_plugins(true);
1337                     }
1338                     if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1339                         if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1340                             if (isset($this->plugins[$instance->enrol])) {
1341                                 $this->plugins[$instance->enrol]->restore_group_member($instance, $data->groupid, $data->userid);
1342                             }
1343                         }
1344                     }
1346                 } else {
1347                     $dir = core_component::get_component_directory($data->component);
1348                     if ($dir and is_dir($dir)) {
1349                         if (component_callback($data->component, 'restore_group_member', array($this, $data), true)) {
1350                             return;
1351                         }
1352                     }
1353                     // Bad luck, plugin could not restore the data, let's add normal membership.
1354                     groups_add_member($data->groupid, $data->userid);
1355                     $message = "Restore of '$data->component/$data->itemid' group membership is not supported, using standard group membership instead.";
1356                     $this->log($message, backup::LOG_WARNING);
1357                 }
1358             }
1359         }
1360     }
1363 /**
1364  * Structure step that will create all the needed scales
1365  * by loading them from the scales.xml
1366  */
1367 class restore_scales_structure_step extends restore_structure_step {
1369     protected function define_structure() {
1371         $paths = array(); // Add paths here
1372         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
1373         return $paths;
1374     }
1376     protected function process_scale($data) {
1377         global $DB;
1379         $data = (object)$data;
1381         $restorefiles = false; // Only if we end creating the group
1383         $oldid = $data->id;    // need this saved for later
1385         // Look for scale (by 'scale' both in standard (course=0) and current course
1386         // with priority to standard scales (ORDER clause)
1387         // scale is not course unique, use get_record_sql to suppress warning
1388         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
1389         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
1390         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
1391         if (!$scadb = $DB->get_record_sql("SELECT *
1392                                             FROM {scale}
1393                                            WHERE courseid IN (0, :courseid)
1394                                              AND $compare_scale_clause
1395                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
1396             // Remap the user if possible, defaut to user performing the restore if not
1397             $userid = $this->get_mappingid('user', $data->userid);
1398             $data->userid = $userid ? $userid : $this->task->get_userid();
1399             // Remap the course if course scale
1400             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
1401             // If global scale (course=0), check the user has perms to create it
1402             // falling to course scale if not
1403             $systemctx = context_system::instance();
1404             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
1405                 $data->courseid = $this->get_courseid();
1406             }
1407             // scale doesn't exist, create
1408             $newitemid = $DB->insert_record('scale', $data);
1409             $restorefiles = true; // We'll restore the files
1410         } else {
1411             // scale exists, use it
1412             $newitemid = $scadb->id;
1413         }
1414         // Save the id mapping (with files support at system context)
1415         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1416     }
1418     protected function after_execute() {
1419         // Add scales related files, matching with "scale" mappings
1420         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
1421     }
1425 /**
1426  * Structure step that will create all the needed outocomes
1427  * by loading them from the outcomes.xml
1428  */
1429 class restore_outcomes_structure_step extends restore_structure_step {
1431     protected function define_structure() {
1433         $paths = array(); // Add paths here
1434         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
1435         return $paths;
1436     }
1438     protected function process_outcome($data) {
1439         global $DB;
1441         $data = (object)$data;
1443         $restorefiles = false; // Only if we end creating the group
1445         $oldid = $data->id;    // need this saved for later
1447         // Look for outcome (by shortname both in standard (courseid=null) and current course
1448         // with priority to standard outcomes (ORDER clause)
1449         // outcome is not course unique, use get_record_sql to suppress warning
1450         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
1451         if (!$outdb = $DB->get_record_sql('SELECT *
1452                                              FROM {grade_outcomes}
1453                                             WHERE shortname = :shortname
1454                                               AND (courseid = :courseid OR courseid IS NULL)
1455                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
1456             // Remap the user
1457             $userid = $this->get_mappingid('user', $data->usermodified);
1458             $data->usermodified = $userid ? $userid : $this->task->get_userid();
1459             // Remap the scale
1460             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
1461             // Remap the course if course outcome
1462             $data->courseid = $data->courseid ? $this->get_courseid() : null;
1463             // If global outcome (course=null), check the user has perms to create it
1464             // falling to course outcome if not
1465             $systemctx = context_system::instance();
1466             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
1467                 $data->courseid = $this->get_courseid();
1468             }
1469             // outcome doesn't exist, create
1470             $newitemid = $DB->insert_record('grade_outcomes', $data);
1471             $restorefiles = true; // We'll restore the files
1472         } else {
1473             // scale exists, use it
1474             $newitemid = $outdb->id;
1475         }
1476         // Set the corresponding grade_outcomes_courses record
1477         $outcourserec = new stdclass();
1478         $outcourserec->courseid  = $this->get_courseid();
1479         $outcourserec->outcomeid = $newitemid;
1480         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
1481             $DB->insert_record('grade_outcomes_courses', $outcourserec);
1482         }
1483         // Save the id mapping (with files support at system context)
1484         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1485     }
1487     protected function after_execute() {
1488         // Add outcomes related files, matching with "outcome" mappings
1489         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
1490     }
1493 /**
1494  * Execution step that, *conditionally* (if there isn't preloaded information
1495  * will load all the question categories and questions (header info only)
1496  * to backup_temp_ids. They will be stored with "question_category" and
1497  * "question" itemnames and with their original contextid and question category
1498  * id as paremitemids
1499  */
1500 class restore_load_categories_and_questions extends restore_execution_step {
1502     protected function define_execution() {
1504         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1505             return;
1506         }
1507         $file = $this->get_basepath() . '/questions.xml';
1508         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
1509     }
1512 /**
1513  * Execution step that, *conditionally* (if there isn't preloaded information)
1514  * will process all the needed categories and questions
1515  * in order to decide and perform any action with them (create / map / error)
1516  * Note: Any error will cause exception, as far as this is the same processing
1517  * than the one into restore prechecks (that should have stopped process earlier)
1518  */
1519 class restore_process_categories_and_questions extends restore_execution_step {
1521     protected function define_execution() {
1523         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1524             return;
1525         }
1526         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
1527     }
1530 /**
1531  * Structure step that will read the section.xml creating/updating sections
1532  * as needed, rebuilding course cache and other friends
1533  */
1534 class restore_section_structure_step extends restore_structure_step {
1535     /** @var array Cache: Array of id => course format */
1536     private static $courseformats = array();
1538     /**
1539      * Resets a static cache of course formats. Required for unit testing.
1540      */
1541     public static function reset_caches() {
1542         self::$courseformats = array();
1543     }
1545     protected function define_structure() {
1546         global $CFG;
1548         $paths = array();
1550         $section = new restore_path_element('section', '/section');
1551         $paths[] = $section;
1552         if ($CFG->enableavailability) {
1553             $paths[] = new restore_path_element('availability', '/section/availability');
1554             $paths[] = new restore_path_element('availability_field', '/section/availability_field');
1555         }
1556         $paths[] = new restore_path_element('course_format_options', '/section/course_format_options');
1558         // Apply for 'format' plugins optional paths at section level
1559         $this->add_plugin_structure('format', $section);
1561         // Apply for 'local' plugins optional paths at section level
1562         $this->add_plugin_structure('local', $section);
1564         return $paths;
1565     }
1567     public function process_section($data) {
1568         global $CFG, $DB;
1569         $data = (object)$data;
1570         $oldid = $data->id; // We'll need this later
1572         $restorefiles = false;
1574         // Look for the section
1575         $section = new stdclass();
1576         $section->course  = $this->get_courseid();
1577         $section->section = $data->number;
1578         // Section doesn't exist, create it with all the info from backup
1579         if (!$secrec = $DB->get_record('course_sections', (array)$section)) {
1580             $section->name = $data->name;
1581             $section->summary = $data->summary;
1582             $section->summaryformat = $data->summaryformat;
1583             $section->sequence = '';
1584             $section->visible = $data->visible;
1585             if (empty($CFG->enableavailability)) { // Process availability information only if enabled.
1586                 $section->availability = null;
1587             } else {
1588                 $section->availability = isset($data->availabilityjson) ? $data->availabilityjson : null;
1589                 // Include legacy [<2.7] availability data if provided.
1590                 if (is_null($section->availability)) {
1591                     $section->availability = \core_availability\info::convert_legacy_fields(
1592                             $data, true);
1593                 }
1594             }
1595             $newitemid = $DB->insert_record('course_sections', $section);
1596             $section->id = $newitemid;
1598             core\event\course_section_created::create_from_section($section)->trigger();
1600             $restorefiles = true;
1602         // Section exists, update non-empty information
1603         } else {
1604             $section->id = $secrec->id;
1605             if ((string)$secrec->name === '') {
1606                 $section->name = $data->name;
1607             }
1608             if (empty($secrec->summary)) {
1609                 $section->summary = $data->summary;
1610                 $section->summaryformat = $data->summaryformat;
1611                 $restorefiles = true;
1612             }
1614             // Don't update availability (I didn't see a useful way to define
1615             // whether existing or new one should take precedence).
1617             $DB->update_record('course_sections', $section);
1618             $newitemid = $secrec->id;
1620             // Trigger an event for course section update.
1621             $event = \core\event\course_section_updated::create(
1622                 array(
1623                     'objectid' => $section->id,
1624                     'courseid' => $section->course,
1625                     'context' => context_course::instance($section->course),
1626                     'other' => array('sectionnum' => $section->section)
1627                 )
1628             );
1629             $event->trigger();
1630         }
1632         // Annotate the section mapping, with restorefiles option if needed
1633         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
1635         // set the new course_section id in the task
1636         $this->task->set_sectionid($newitemid);
1638         // If there is the legacy showavailability data, store this for later use.
1639         // (This data is not present when restoring 'new' backups.)
1640         if (isset($data->showavailability)) {
1641             // Cache the showavailability flag using the backup_ids data field.
1642             restore_dbops::set_backup_ids_record($this->get_restoreid(),
1643                     'section_showavailability', $newitemid, 0, null,
1644                     (object)array('showavailability' => $data->showavailability));
1645         }
1647         // Commented out. We never modify course->numsections as far as that is used
1648         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
1649         // Note: We keep the code here, to know about and because of the possibility of making this
1650         // optional based on some setting/attribute in the future
1651         // If needed, adjust course->numsections
1652         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
1653         //    if ($numsections < $section->section) {
1654         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
1655         //    }
1656         //}
1657     }
1659     /**
1660      * Process the legacy availability table record. This table does not exist
1661      * in Moodle 2.7+ but we still support restore.
1662      *
1663      * @param stdClass $data Record data
1664      */
1665     public function process_availability($data) {
1666         $data = (object)$data;
1667         // Simply going to store the whole availability record now, we'll process
1668         // all them later in the final task (once all activities have been restored)
1669         // Let's call the low level one to be able to store the whole object.
1670         $data->coursesectionid = $this->task->get_sectionid();
1671         restore_dbops::set_backup_ids_record($this->get_restoreid(),
1672                 'section_availability', $data->id, 0, null, $data);
1673     }
1675     /**
1676      * Process the legacy availability fields table record. This table does not
1677      * exist in Moodle 2.7+ but we still support restore.
1678      *
1679      * @param stdClass $data Record data
1680      */
1681     public function process_availability_field($data) {
1682         global $DB;
1683         $data = (object)$data;
1684         // Mark it is as passed by default
1685         $passed = true;
1686         $customfieldid = null;
1688         // If a customfield has been used in order to pass we must be able to match an existing
1689         // customfield by name (data->customfield) and type (data->customfieldtype)
1690         if (is_null($data->customfield) xor is_null($data->customfieldtype)) {
1691             // xor is sort of uncommon. If either customfield is null or customfieldtype is null BUT not both.
1692             // If one is null but the other isn't something clearly went wrong and we'll skip this condition.
1693             $passed = false;
1694         } else if (!is_null($data->customfield)) {
1695             $params = array('shortname' => $data->customfield, 'datatype' => $data->customfieldtype);
1696             $customfieldid = $DB->get_field('user_info_field', 'id', $params);
1697             $passed = ($customfieldid !== false);
1698         }
1700         if ($passed) {
1701             // Create the object to insert into the database
1702             $availfield = new stdClass();
1703             $availfield->coursesectionid = $this->task->get_sectionid();
1704             $availfield->userfield = $data->userfield;
1705             $availfield->customfieldid = $customfieldid;
1706             $availfield->operator = $data->operator;
1707             $availfield->value = $data->value;
1709             // Get showavailability option.
1710             $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
1711                     'section_showavailability', $availfield->coursesectionid);
1712             if (!$showrec) {
1713                 // Should not happen.
1714                 throw new coding_exception('No matching showavailability record');
1715             }
1716             $show = $showrec->info->showavailability;
1718             // The $availfield object is now in the format used in the old
1719             // system. Interpret this and convert to new system.
1720             $currentvalue = $DB->get_field('course_sections', 'availability',
1721                     array('id' => $availfield->coursesectionid), MUST_EXIST);
1722             $newvalue = \core_availability\info::add_legacy_availability_field_condition(
1723                     $currentvalue, $availfield, $show);
1724             $DB->set_field('course_sections', 'availability', $newvalue,
1725                     array('id' => $availfield->coursesectionid));
1726         }
1727     }
1729     public function process_course_format_options($data) {
1730         global $DB;
1731         $courseid = $this->get_courseid();
1732         if (!array_key_exists($courseid, self::$courseformats)) {
1733             // It is safe to have a static cache of course formats because format can not be changed after this point.
1734             self::$courseformats[$courseid] = $DB->get_field('course', 'format', array('id' => $courseid));
1735         }
1736         $data = (array)$data;
1737         if (self::$courseformats[$courseid] === $data['format']) {
1738             // Import section format options only if both courses (the one that was backed up
1739             // and the one we are restoring into) have same formats.
1740             $params = array(
1741                 'courseid' => $this->get_courseid(),
1742                 'sectionid' => $this->task->get_sectionid(),
1743                 'format' => $data['format'],
1744                 'name' => $data['name']
1745             );
1746             if ($record = $DB->get_record('course_format_options', $params, 'id, value')) {
1747                 // Do not overwrite existing information.
1748                 $newid = $record->id;
1749             } else {
1750                 $params['value'] = $data['value'];
1751                 $newid = $DB->insert_record('course_format_options', $params);
1752             }
1753             $this->set_mapping('course_format_options', $data['id'], $newid);
1754         }
1755     }
1757     protected function after_execute() {
1758         // Add section related files, with 'course_section' itemid to match
1759         $this->add_related_files('course', 'section', 'course_section');
1760     }
1763 /**
1764  * Structure step that will read the course.xml file, loading it and performing
1765  * various actions depending of the site/restore settings. Note that target
1766  * course always exist before arriving here so this step will be updating
1767  * the course record (never inserting)
1768  */
1769 class restore_course_structure_step extends restore_structure_step {
1770     /**
1771      * @var bool this gets set to true by {@link process_course()} if we are
1772      * restoring an old coures that used the legacy 'module security' feature.
1773      * If so, we have to do more work in {@link after_execute()}.
1774      */
1775     protected $legacyrestrictmodules = false;
1777     /**
1778      * @var array Used when {@link $legacyrestrictmodules} is true. This is an
1779      * array with array keys the module names ('forum', 'quiz', etc.). These are
1780      * the modules that are allowed according to the data in the backup file.
1781      * In {@link after_execute()} we then have to prevent adding of all the other
1782      * types of activity.
1783      */
1784     protected $legacyallowedmodules = array();
1786     protected function define_structure() {
1788         $course = new restore_path_element('course', '/course');
1789         $category = new restore_path_element('category', '/course/category');
1790         $tag = new restore_path_element('tag', '/course/tags/tag');
1791         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1793         // Apply for 'format' plugins optional paths at course level
1794         $this->add_plugin_structure('format', $course);
1796         // Apply for 'theme' plugins optional paths at course level
1797         $this->add_plugin_structure('theme', $course);
1799         // Apply for 'report' plugins optional paths at course level
1800         $this->add_plugin_structure('report', $course);
1802         // Apply for 'course report' plugins optional paths at course level
1803         $this->add_plugin_structure('coursereport', $course);
1805         // Apply for plagiarism plugins optional paths at course level
1806         $this->add_plugin_structure('plagiarism', $course);
1808         // Apply for local plugins optional paths at course level
1809         $this->add_plugin_structure('local', $course);
1811         // Apply for admin tool plugins optional paths at course level.
1812         $this->add_plugin_structure('tool', $course);
1814         return array($course, $category, $tag, $allowed_module);
1815     }
1817     /**
1818      * Processing functions go here
1819      *
1820      * @global moodledatabase $DB
1821      * @param stdClass $data
1822      */
1823     public function process_course($data) {
1824         global $CFG, $DB;
1825         $context = context::instance_by_id($this->task->get_contextid());
1826         $userid = $this->task->get_userid();
1827         $target = $this->get_task()->get_target();
1828         $isnewcourse = $target == backup::TARGET_NEW_COURSE;
1830         // When restoring to a new course we can set all the things except for the ID number.
1831         $canchangeidnumber = $isnewcourse || has_capability('moodle/course:changeidnumber', $context, $userid);
1832         $canchangesummary = $isnewcourse || has_capability('moodle/course:changesummary', $context, $userid);
1834         $data = (object)$data;
1835         $data->id = $this->get_courseid();
1837         // Calculate final course names, to avoid dupes.
1838         $fullname  = $this->get_setting_value('course_fullname');
1839         $shortname = $this->get_setting_value('course_shortname');
1840         list($data->fullname, $data->shortname) = restore_dbops::calculate_course_names($this->get_courseid(),
1841             $fullname === false ? $data->fullname : $fullname,
1842             $shortname === false ? $data->shortname : $shortname);
1843         // Do not modify the course names at all when merging and user selected to keep the names (or prohibited by cap).
1844         if (!$isnewcourse && $fullname === false) {
1845             unset($data->fullname);
1846         }
1847         if (!$isnewcourse && $shortname === false) {
1848             unset($data->shortname);
1849         }
1851         // Unset summary if user can't change it.
1852         if (!$canchangesummary) {
1853             unset($data->summary);
1854             unset($data->summaryformat);
1855         }
1857         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1858         // another course on this site.
1859         if (!empty($data->idnumber) && $canchangeidnumber && $this->task->is_samesite()
1860                 && !$DB->record_exists('course', array('idnumber' => $data->idnumber))) {
1861             // Do not reset idnumber.
1863         } else if (!$isnewcourse) {
1864             // Prevent override when restoring as merge.
1865             unset($data->idnumber);
1867         } else {
1868             $data->idnumber = '';
1869         }
1871         // Any empty value for course->hiddensections will lead to 0 (default, show collapsed).
1872         // It has been reported that some old 1.9 courses may have it null leading to DB error. MDL-31532
1873         if (empty($data->hiddensections)) {
1874             $data->hiddensections = 0;
1875         }
1877         // Set legacyrestrictmodules to true if the course was resticting modules. If so
1878         // then we will need to process restricted modules after execution.
1879         $this->legacyrestrictmodules = !empty($data->restrictmodules);
1881         $data->startdate= $this->apply_date_offset($data->startdate);
1882         if (isset($data->enddate)) {
1883             $data->enddate = $this->apply_date_offset($data->enddate);
1884         }
1886         if ($data->defaultgroupingid) {
1887             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1888         }
1889         if (empty($CFG->enablecompletion)) {
1890             $data->enablecompletion = 0;
1891             $data->completionstartonenrol = 0;
1892             $data->completionnotify = 0;
1893         }
1894         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1895         if (!array_key_exists($data->lang, $languages)) {
1896             $data->lang = '';
1897         }
1899         $themes = get_list_of_themes(); // Get themes for quick search later
1900         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1901             $data->theme = '';
1902         }
1904         // Check if this is an old SCORM course format.
1905         if ($data->format == 'scorm') {
1906             $data->format = 'singleactivity';
1907             $data->activitytype = 'scorm';
1908         }
1910         // Course record ready, update it
1911         $DB->update_record('course', $data);
1913         course_get_format($data)->update_course_format_options($data);
1915         // Role name aliases
1916         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1917     }
1919     public function process_category($data) {
1920         // Nothing to do with the category. UI sets it before restore starts
1921     }
1923     public function process_tag($data) {
1924         global $CFG, $DB;
1926         $data = (object)$data;
1928         core_tag_tag::add_item_tag('core', 'course', $this->get_courseid(),
1929                 context_course::instance($this->get_courseid()), $data->rawname);
1930     }
1932     public function process_allowed_module($data) {
1933         $data = (object)$data;
1935         // Backwards compatiblity support for the data that used to be in the
1936         // course_allowed_modules table.
1937         if ($this->legacyrestrictmodules) {
1938             $this->legacyallowedmodules[$data->modulename] = 1;
1939         }
1940     }
1942     protected function after_execute() {
1943         global $DB;
1945         // Add course related files, without itemid to match
1946         $this->add_related_files('course', 'summary', null);
1947         $this->add_related_files('course', 'overviewfiles', null);
1949         // Deal with legacy allowed modules.
1950         if ($this->legacyrestrictmodules) {
1951             $context = context_course::instance($this->get_courseid());
1953             list($roleids) = get_roles_with_cap_in_context($context, 'moodle/course:manageactivities');
1954             list($managerroleids) = get_roles_with_cap_in_context($context, 'moodle/site:config');
1955             foreach ($managerroleids as $roleid) {
1956                 unset($roleids[$roleid]);
1957             }
1959             foreach (core_component::get_plugin_list('mod') as $modname => $notused) {
1960                 if (isset($this->legacyallowedmodules[$modname])) {
1961                     // Module is allowed, no worries.
1962                     continue;
1963                 }
1965                 $capability = 'mod/' . $modname . ':addinstance';
1966                 foreach ($roleids as $roleid) {
1967                     assign_capability($capability, CAP_PREVENT, $roleid, $context);
1968                 }
1969             }
1970         }
1971     }
1974 /**
1975  * Execution step that will migrate legacy files if present.
1976  */
1977 class restore_course_legacy_files_step extends restore_execution_step {
1978     public function define_execution() {
1979         global $DB;
1981         // Do a check for legacy files and skip if there are none.
1982         $sql = 'SELECT count(*)
1983                   FROM {backup_files_temp}
1984                  WHERE backupid = ?
1985                    AND contextid = ?
1986                    AND component = ?
1987                    AND filearea  = ?';
1988         $params = array($this->get_restoreid(), $this->task->get_old_contextid(), 'course', 'legacy');
1990         if ($DB->count_records_sql($sql, $params)) {
1991             $DB->set_field('course', 'legacyfiles', 2, array('id' => $this->get_courseid()));
1992             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'course',
1993                 'legacy', $this->task->get_old_contextid(), $this->task->get_userid());
1994         }
1995     }
1998 /*
1999  * Structure step that will read the roles.xml file (at course/activity/block levels)
2000  * containing all the role_assignments and overrides for that context. If corresponding to
2001  * one mapped role, they will be applied to target context. Will observe the role_assignments
2002  * setting to decide if ras are restored.
2003  *
2004  * Note: this needs to be executed after all users are enrolled.
2005  */
2006 class restore_ras_and_caps_structure_step extends restore_structure_step {
2007     protected $plugins = null;
2009     protected function define_structure() {
2011         $paths = array();
2013         // Observe the role_assignments setting
2014         if ($this->get_setting_value('role_assignments')) {
2015             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
2016         }
2017         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
2019         return $paths;
2020     }
2022     /**
2023      * Assign roles
2024      *
2025      * This has to be called after enrolments processing.
2026      *
2027      * @param mixed $data
2028      * @return void
2029      */
2030     public function process_assignment($data) {
2031         global $DB;
2033         $data = (object)$data;
2035         // Check roleid, userid are one of the mapped ones
2036         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
2037             return;
2038         }
2039         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
2040             return;
2041         }
2042         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
2043             // Only assign roles to not deleted users
2044             return;
2045         }
2046         if (!$contextid = $this->task->get_contextid()) {
2047             return;
2048         }
2050         if (empty($data->component)) {
2051             // assign standard manual roles
2052             // TODO: role_assign() needs one userid param to be able to specify our restore userid
2053             role_assign($newroleid, $newuserid, $contextid);
2055         } else if ((strpos($data->component, 'enrol_') === 0)) {
2056             // Deal with enrolment roles - ignore the component and just find out the instance via new id,
2057             // it is possible that enrolment was restored using different plugin type.
2058             if (!isset($this->plugins)) {
2059                 $this->plugins = enrol_get_plugins(true);
2060             }
2061             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
2062                 if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
2063                     if (isset($this->plugins[$instance->enrol])) {
2064                         $this->plugins[$instance->enrol]->restore_role_assignment($instance, $newroleid, $newuserid, $contextid);
2065                     }
2066                 }
2067             }
2069         } else {
2070             $data->roleid    = $newroleid;
2071             $data->userid    = $newuserid;
2072             $data->contextid = $contextid;
2073             $dir = core_component::get_component_directory($data->component);
2074             if ($dir and is_dir($dir)) {
2075                 if (component_callback($data->component, 'restore_role_assignment', array($this, $data), true)) {
2076                     return;
2077                 }
2078             }
2079             // Bad luck, plugin could not restore the data, let's add normal membership.
2080             role_assign($data->roleid, $data->userid, $data->contextid);
2081             $message = "Restore of '$data->component/$data->itemid' role assignments is not supported, using manual role assignments instead.";
2082             $this->log($message, backup::LOG_WARNING);
2083         }
2084     }
2086     public function process_override($data) {
2087         $data = (object)$data;
2089         // Check roleid is one of the mapped ones
2090         $newroleid = $this->get_mappingid('role', $data->roleid);
2091         // If newroleid and context are valid assign it via API (it handles dupes and so on)
2092         if ($newroleid && $this->task->get_contextid()) {
2093             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
2094             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
2095             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
2096         }
2097     }
2100 /**
2101  * If no instances yet add default enrol methods the same way as when creating new course in UI.
2102  */
2103 class restore_default_enrolments_step extends restore_execution_step {
2105     public function define_execution() {
2106         global $DB;
2108         // No enrolments in front page.
2109         if ($this->get_courseid() == SITEID) {
2110             return;
2111         }
2113         $course = $DB->get_record('course', array('id'=>$this->get_courseid()), '*', MUST_EXIST);
2115         if ($DB->record_exists('enrol', array('courseid'=>$this->get_courseid(), 'enrol'=>'manual'))) {
2116             // Something already added instances, do not add default instances.
2117             $plugins = enrol_get_plugins(true);
2118             foreach ($plugins as $plugin) {
2119                 $plugin->restore_sync_course($course);
2120             }
2122         } else {
2123             // Looks like a newly created course.
2124             enrol_course_updated(true, $course, null);
2125         }
2126     }
2129 /**
2130  * This structure steps restores the enrol plugins and their underlying
2131  * enrolments, performing all the mappings and/or movements required
2132  */
2133 class restore_enrolments_structure_step extends restore_structure_step {
2134     protected $enrolsynced = false;
2135     protected $plugins = null;
2136     protected $originalstatus = array();
2138     /**
2139      * Conditionally decide if this step should be executed.
2140      *
2141      * This function checks the following parameter:
2142      *
2143      *   1. the course/enrolments.xml file exists
2144      *
2145      * @return bool true is safe to execute, false otherwise
2146      */
2147     protected function execute_condition() {
2149         if ($this->get_courseid() == SITEID) {
2150             return false;
2151         }
2153         // Check it is included in the backup
2154         $fullpath = $this->task->get_taskbasepath();
2155         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2156         if (!file_exists($fullpath)) {
2157             // Not found, can't restore enrolments info
2158             return false;
2159         }
2161         return true;
2162     }
2164     protected function define_structure() {
2166         $userinfo = $this->get_setting_value('users');
2168         $paths = [];
2169         $paths[] = $enrol = new restore_path_element('enrol', '/enrolments/enrols/enrol');
2170         if ($userinfo) {
2171             $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
2172         }
2173         // Attach local plugin stucture to enrol element.
2174         $this->add_plugin_structure('enrol', $enrol);
2176         return $paths;
2177     }
2179     /**
2180      * Create enrolment instances.
2181      *
2182      * This has to be called after creation of roles
2183      * and before adding of role assignments.
2184      *
2185      * @param mixed $data
2186      * @return void
2187      */
2188     public function process_enrol($data) {
2189         global $DB;
2191         $data = (object)$data;
2192         $oldid = $data->id; // We'll need this later.
2193         unset($data->id);
2195         $this->originalstatus[$oldid] = $data->status;
2197         if (!$courserec = $DB->get_record('course', array('id' => $this->get_courseid()))) {
2198             $this->set_mapping('enrol', $oldid, 0);
2199             return;
2200         }
2202         if (!isset($this->plugins)) {
2203             $this->plugins = enrol_get_plugins(true);
2204         }
2206         if (!$this->enrolsynced) {
2207             // Make sure that all plugin may create instances and enrolments automatically
2208             // before the first instance restore - this is suitable especially for plugins
2209             // that synchronise data automatically using course->idnumber or by course categories.
2210             foreach ($this->plugins as $plugin) {
2211                 $plugin->restore_sync_course($courserec);
2212             }
2213             $this->enrolsynced = true;
2214         }
2216         // Map standard fields - plugin has to process custom fields manually.
2217         $data->roleid   = $this->get_mappingid('role', $data->roleid);
2218         $data->courseid = $courserec->id;
2220         if (!$this->get_setting_value('users') && $this->get_setting_value('enrolments') == backup::ENROL_WITHUSERS) {
2221             $converttomanual = true;
2222         } else {
2223             $converttomanual = ($this->get_setting_value('enrolments') == backup::ENROL_NEVER);
2224         }
2226         if ($converttomanual) {
2227             // Restore enrolments as manual enrolments.
2228             unset($data->sortorder); // Remove useless sortorder from <2.4 backups.
2229             if (!enrol_is_enabled('manual')) {
2230                 $this->set_mapping('enrol', $oldid, 0);
2231                 return;
2232             }
2233             if ($instances = $DB->get_records('enrol', array('courseid'=>$data->courseid, 'enrol'=>'manual'), 'id')) {
2234                 $instance = reset($instances);
2235                 $this->set_mapping('enrol', $oldid, $instance->id);
2236             } else {
2237                 if ($data->enrol === 'manual') {
2238                     $instanceid = $this->plugins['manual']->add_instance($courserec, (array)$data);
2239                 } else {
2240                     $instanceid = $this->plugins['manual']->add_default_instance($courserec);
2241                 }
2242                 $this->set_mapping('enrol', $oldid, $instanceid);
2243             }
2245         } else {
2246             if (!enrol_is_enabled($data->enrol) or !isset($this->plugins[$data->enrol])) {
2247                 $this->set_mapping('enrol', $oldid, 0);
2248                 $message = "Enrol plugin '$data->enrol' data can not be restored because it is not enabled, consider restoring without enrolment methods";
2249                 $this->log($message, backup::LOG_WARNING);
2250                 return;
2251             }
2252             if ($task = $this->get_task() and $task->get_target() == backup::TARGET_NEW_COURSE) {
2253                 // Let's keep the sortorder in old backups.
2254             } else {
2255                 // Prevent problems with colliding sortorders in old backups,
2256                 // new 2.4 backups do not need sortorder because xml elements are ordered properly.
2257                 unset($data->sortorder);
2258             }
2259             // Note: plugin is responsible for setting up the mapping, it may also decide to migrate to different type.
2260             $this->plugins[$data->enrol]->restore_instance($this, $data, $courserec, $oldid);
2261         }
2262     }
2264     /**
2265      * Create user enrolments.
2266      *
2267      * This has to be called after creation of enrolment instances
2268      * and before adding of role assignments.
2269      *
2270      * Roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing afterwards.
2271      *
2272      * @param mixed $data
2273      * @return void
2274      */
2275     public function process_enrolment($data) {
2276         global $DB;
2278         if (!isset($this->plugins)) {
2279             $this->plugins = enrol_get_plugins(true);
2280         }
2282         $data = (object)$data;
2284         // Process only if parent instance have been mapped.
2285         if ($enrolid = $this->get_new_parentid('enrol')) {
2286             $oldinstancestatus = ENROL_INSTANCE_ENABLED;
2287             $oldenrolid = $this->get_old_parentid('enrol');
2288             if (isset($this->originalstatus[$oldenrolid])) {
2289                 $oldinstancestatus = $this->originalstatus[$oldenrolid];
2290             }
2291             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
2292                 // And only if user is a mapped one.
2293                 if ($userid = $this->get_mappingid('user', $data->userid)) {
2294                     if (isset($this->plugins[$instance->enrol])) {
2295                         $this->plugins[$instance->enrol]->restore_user_enrolment($this, $data, $instance, $userid, $oldinstancestatus);
2296                     }
2297                 }
2298             }
2299         }
2300     }
2304 /**
2305  * Make sure the user restoring the course can actually access it.
2306  */
2307 class restore_fix_restorer_access_step extends restore_execution_step {
2308     protected function define_execution() {
2309         global $CFG, $DB;
2311         if (!$userid = $this->task->get_userid()) {
2312             return;
2313         }
2315         if (empty($CFG->restorernewroleid)) {
2316             // Bad luck, no fallback role for restorers specified
2317             return;
2318         }
2320         $courseid = $this->get_courseid();
2321         $context = context_course::instance($courseid);
2323         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
2324             // Current user may access the course (admin, category manager or restored teacher enrolment usually)
2325             return;
2326         }
2328         // Try to add role only - we do not need enrolment if user has moodle/course:view or is already enrolled
2329         role_assign($CFG->restorernewroleid, $userid, $context);
2331         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
2332             // Extra role is enough, yay!
2333             return;
2334         }
2336         // The last chance is to create manual enrol if it does not exist and and try to enrol the current user,
2337         // hopefully admin selected suitable $CFG->restorernewroleid ...
2338         if (!enrol_is_enabled('manual')) {
2339             return;
2340         }
2341         if (!$enrol = enrol_get_plugin('manual')) {
2342             return;
2343         }
2344         if (!$DB->record_exists('enrol', array('enrol'=>'manual', 'courseid'=>$courseid))) {
2345             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
2346             $fields = array('status'=>ENROL_INSTANCE_ENABLED, 'enrolperiod'=>$enrol->get_config('enrolperiod', 0), 'roleid'=>$enrol->get_config('roleid', 0));
2347             $enrol->add_instance($course, $fields);
2348         }
2350         enrol_try_internal_enrol($courseid, $userid);
2351     }
2355 /**
2356  * This structure steps restores the filters and their configs
2357  */
2358 class restore_filters_structure_step extends restore_structure_step {
2360     protected function define_structure() {
2362         $paths = array();
2364         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
2365         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
2367         return $paths;
2368     }
2370     public function process_active($data) {
2372         $data = (object)$data;
2374         if (strpos($data->filter, 'filter/') === 0) {
2375             $data->filter = substr($data->filter, 7);
2377         } else if (strpos($data->filter, '/') !== false) {
2378             // Unsupported old filter.
2379             return;
2380         }
2382         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
2383             return;
2384         }
2385         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
2386     }
2388     public function process_config($data) {
2390         $data = (object)$data;
2392         if (strpos($data->filter, 'filter/') === 0) {
2393             $data->filter = substr($data->filter, 7);
2395         } else if (strpos($data->filter, '/') !== false) {
2396             // Unsupported old filter.
2397             return;
2398         }
2400         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
2401             return;
2402         }
2403         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
2404     }
2408 /**
2409  * This structure steps restores the comments
2410  * Note: Cannot use the comments API because defaults to USER->id.
2411  * That should change allowing to pass $userid
2412  */
2413 class restore_comments_structure_step extends restore_structure_step {
2415     protected function define_structure() {
2417         $paths = array();
2419         $paths[] = new restore_path_element('comment', '/comments/comment');
2421         return $paths;
2422     }
2424     public function process_comment($data) {
2425         global $DB;
2427         $data = (object)$data;
2429         // First of all, if the comment has some itemid, ask to the task what to map
2430         $mapping = false;
2431         if ($data->itemid) {
2432             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
2433             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
2434         }
2435         // Only restore the comment if has no mapping OR we have found the matching mapping
2436         if (!$mapping || $data->itemid) {
2437             // Only if user mapping and context
2438             $data->userid = $this->get_mappingid('user', $data->userid);
2439             if ($data->userid && $this->task->get_contextid()) {
2440                 $data->contextid = $this->task->get_contextid();
2441                 // Only if there is another comment with same context/user/timecreated
2442                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
2443                 if (!$DB->record_exists('comments', $params)) {
2444                     $DB->insert_record('comments', $data);
2445                 }
2446             }
2447         }
2448     }
2451 /**
2452  * This structure steps restores the badges and their configs
2453  */
2454 class restore_badges_structure_step extends restore_structure_step {
2456     /**
2457      * Conditionally decide if this step should be executed.
2458      *
2459      * This function checks the following parameters:
2460      *
2461      *   1. Badges and course badges are enabled on the site.
2462      *   2. The course/badges.xml file exists.
2463      *   3. All modules are restorable.
2464      *   4. All modules are marked for restore.
2465      *
2466      * @return bool True is safe to execute, false otherwise
2467      */
2468     protected function execute_condition() {
2469         global $CFG;
2471         // First check is badges and course level badges are enabled on this site.
2472         if (empty($CFG->enablebadges) || empty($CFG->badges_allowcoursebadges)) {
2473             // Disabled, don't restore course badges.
2474             return false;
2475         }
2477         // Check if badges.xml is included in the backup.
2478         $fullpath = $this->task->get_taskbasepath();
2479         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2480         if (!file_exists($fullpath)) {
2481             // Not found, can't restore course badges.
2482             return false;
2483         }
2485         // Check we are able to restore all backed up modules.
2486         if ($this->task->is_missing_modules()) {
2487             return false;
2488         }
2490         // Finally check all modules within the backup are being restored.
2491         if ($this->task->is_excluding_activities()) {
2492             return false;
2493         }
2495         return true;
2496     }
2498     protected function define_structure() {
2499         $paths = array();
2500         $paths[] = new restore_path_element('badge', '/badges/badge');
2501         $paths[] = new restore_path_element('criterion', '/badges/badge/criteria/criterion');
2502         $paths[] = new restore_path_element('parameter', '/badges/badge/criteria/criterion/parameters/parameter');
2503         $paths[] = new restore_path_element('manual_award', '/badges/badge/manual_awards/manual_award');
2505         return $paths;
2506     }
2508     public function process_badge($data) {
2509         global $DB, $CFG;
2511         require_once($CFG->libdir . '/badgeslib.php');
2513         $data = (object)$data;
2514         $data->usercreated = $this->get_mappingid('user', $data->usercreated);
2515         if (empty($data->usercreated)) {
2516             $data->usercreated = $this->task->get_userid();
2517         }
2518         $data->usermodified = $this->get_mappingid('user', $data->usermodified);
2519         if (empty($data->usermodified)) {
2520             $data->usermodified = $this->task->get_userid();
2521         }
2523         // We'll restore the badge image.
2524         $restorefiles = true;
2526         $courseid = $this->get_courseid();
2528         $params = array(
2529                 'name'           => $data->name,
2530                 'description'    => $data->description,
2531                 'timecreated'    => $this->apply_date_offset($data->timecreated),
2532                 'timemodified'   => $this->apply_date_offset($data->timemodified),
2533                 'usercreated'    => $data->usercreated,
2534                 'usermodified'   => $data->usermodified,
2535                 'issuername'     => $data->issuername,
2536                 'issuerurl'      => $data->issuerurl,
2537                 'issuercontact'  => $data->issuercontact,
2538                 'expiredate'     => $this->apply_date_offset($data->expiredate),
2539                 'expireperiod'   => $data->expireperiod,
2540                 'type'           => BADGE_TYPE_COURSE,
2541                 'courseid'       => $courseid,
2542                 'message'        => $data->message,
2543                 'messagesubject' => $data->messagesubject,
2544                 'attachment'     => $data->attachment,
2545                 'notification'   => $data->notification,
2546                 'status'         => BADGE_STATUS_INACTIVE,
2547                 'nextcron'       => $this->apply_date_offset($data->nextcron)
2548         );
2550         $newid = $DB->insert_record('badge', $params);
2551         $this->set_mapping('badge', $data->id, $newid, $restorefiles);
2552     }
2554     public function process_criterion($data) {
2555         global $DB;
2557         $data = (object)$data;
2559         $params = array(
2560                 'badgeid'           => $this->get_new_parentid('badge'),
2561                 'criteriatype'      => $data->criteriatype,
2562                 'method'            => $data->method,
2563                 'description'       => isset($data->description) ? $data->description : '',
2564                 'descriptionformat' => isset($data->descriptionformat) ? $data->descriptionformat : 0,
2565         );
2566         $newid = $DB->insert_record('badge_criteria', $params);
2567         $this->set_mapping('criterion', $data->id, $newid);
2568     }
2570     public function process_parameter($data) {
2571         global $DB, $CFG;
2573         require_once($CFG->libdir . '/badgeslib.php');
2575         $data = (object)$data;
2576         $criteriaid = $this->get_new_parentid('criterion');
2578         // Parameter array that will go to database.
2579         $params = array();
2580         $params['critid'] = $criteriaid;
2582         $oldparam = explode('_', $data->name);
2584         if ($data->criteriatype == BADGE_CRITERIA_TYPE_ACTIVITY) {
2585             $module = $this->get_mappingid('course_module', $oldparam[1]);
2586             $params['name'] = $oldparam[0] . '_' . $module;
2587             $params['value'] = $oldparam[0] == 'module' ? $module : $data->value;
2588         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_COURSE) {
2589             $params['name'] = $oldparam[0] . '_' . $this->get_courseid();
2590             $params['value'] = $oldparam[0] == 'course' ? $this->get_courseid() : $data->value;
2591         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_MANUAL) {
2592             $role = $this->get_mappingid('role', $data->value);
2593             if (!empty($role)) {
2594                 $params['name'] = 'role_' . $role;
2595                 $params['value'] = $role;
2596             } else {
2597                 return;
2598             }
2599         }
2601         if (!$DB->record_exists('badge_criteria_param', $params)) {
2602             $DB->insert_record('badge_criteria_param', $params);
2603         }
2604     }
2606     public function process_manual_award($data) {
2607         global $DB;
2609         $data = (object)$data;
2610         $role = $this->get_mappingid('role', $data->issuerrole);
2612         if (!empty($role)) {
2613             $award = array(
2614                 'badgeid'     => $this->get_new_parentid('badge'),
2615                 'recipientid' => $this->get_mappingid('user', $data->recipientid),
2616                 'issuerid'    => $this->get_mappingid('user', $data->issuerid),
2617                 'issuerrole'  => $role,
2618                 'datemet'     => $this->apply_date_offset($data->datemet)
2619             );
2621             // Skip the manual award if recipient or issuer can not be mapped to.
2622             if (empty($award['recipientid']) || empty($award['issuerid'])) {
2623                 return;
2624             }
2626             $DB->insert_record('badge_manual_award', $award);
2627         }
2628     }
2630     protected function after_execute() {
2631         // Add related files.
2632         $this->add_related_files('badges', 'badgeimage', 'badge');
2633     }
2636 /**
2637  * This structure steps restores the calendar events
2638  */
2639 class restore_calendarevents_structure_step extends restore_structure_step {
2641     protected function define_structure() {
2643         $paths = array();
2645         $paths[] = new restore_path_element('calendarevents', '/events/event');
2647         return $paths;
2648     }
2650     public function process_calendarevents($data) {
2651         global $DB, $SITE, $USER;
2653         $data = (object)$data;
2654         $oldid = $data->id;
2655         $restorefiles = true; // We'll restore the files
2656         // User overrides for activities are identified by having a courseid of zero with
2657         // both a modulename and instance value set.
2658         $isuseroverride = !$data->courseid && $data->modulename && $data->instance;
2660         // If we don't want to include user data and this record is a user override event
2661         // for an activity then we should not create it.
2662         if (!$this->task->get_setting_value('userinfo') && $isuseroverride) {
2663             return;
2664         }
2666         // Find the userid and the groupid associated with the event.
2667         $data->userid = $this->get_mappingid('user', $data->userid);
2668         if ($data->userid === false) {
2669             // Blank user ID means that we are dealing with module generated events such as quiz starting times.
2670             // Use the current user ID for these events.
2671             $data->userid = $USER->id;
2672         }
2673         if (!empty($data->groupid)) {
2674             $data->groupid = $this->get_mappingid('group', $data->groupid);
2675             if ($data->groupid === false) {
2676                 return;
2677             }
2678         }
2679         // Handle events with empty eventtype //MDL-32827
2680         if(empty($data->eventtype)) {
2681             if ($data->courseid == $SITE->id) {                                // Site event
2682                 $data->eventtype = "site";
2683             } else if ($data->courseid != 0 && $data->groupid == 0 && ($data->modulename == 'assignment' || $data->modulename == 'assign')) {
2684                 // Course assingment event
2685                 $data->eventtype = "due";
2686             } else if ($data->courseid != 0 && $data->groupid == 0) {      // Course event
2687                 $data->eventtype = "course";
2688             } else if ($data->groupid) {                                      // Group event
2689                 $data->eventtype = "group";
2690             } else if ($data->userid) {                                       // User event
2691                 $data->eventtype = "user";
2692             } else {
2693                 return;
2694             }
2695         }
2697         $params = array(
2698                 'name'           => $data->name,
2699                 'description'    => $data->description,
2700                 'format'         => $data->format,
2701                 // User overrides in activities use a course id of zero. All other event types
2702                 // must use the mapped course id.
2703                 'courseid'       => $data->courseid ? $this->get_courseid() : 0,
2704                 'groupid'        => $data->groupid,
2705                 'userid'         => $data->userid,
2706                 'repeatid'       => $this->get_mappingid('event', $data->repeatid),
2707                 'modulename'     => $data->modulename,
2708                 'type'           => $data->type,
2709                 'eventtype'      => $data->eventtype,
2710                 'timestart'      => $this->apply_date_offset($data->timestart),
2711                 'timeduration'   => $data->timeduration,
2712                 'timesort'       => $this->apply_date_offset($data->timesort),
2713                 'visible'        => $data->visible,
2714                 'uuid'           => $data->uuid,
2715                 'sequence'       => $data->sequence,
2716                 'timemodified'   => $this->apply_date_offset($data->timemodified),
2717                 'priority'       => $data->priority);
2718         if ($this->name == 'activity_calendar') {
2719             $params['instance'] = $this->task->get_activityid();
2720         } else {
2721             $params['instance'] = 0;
2722         }
2723         $sql = "SELECT id
2724                   FROM {event}
2725                  WHERE " . $DB->sql_compare_text('name', 255) . " = " . $DB->sql_compare_text('?', 255) . "
2726                    AND courseid = ?
2727                    AND modulename = ?
2728                    AND instance = ?
2729                    AND timestart = ?
2730                    AND timeduration = ?
2731                    AND " . $DB->sql_compare_text('description', 255) . " = " . $DB->sql_compare_text('?', 255);
2732         $arg = array ($params['name'], $params['courseid'], $params['modulename'], $params['instance'], $params['timestart'], $params['timeduration'], $params['description']);
2733         $result = $DB->record_exists_sql($sql, $arg);
2734         if (empty($result)) {
2735             $newitemid = $DB->insert_record('event', $params);
2736             $this->set_mapping('event', $oldid, $newitemid);
2737             $this->set_mapping('event_description', $oldid, $newitemid, $restorefiles);
2738         }
2739         // With repeating events, each event has the repeatid pointed at the first occurrence.
2740         // Since the repeatid will be empty when the first occurrence is restored,
2741         // Get the repeatid from the second occurrence of the repeating event and use that to update the first occurrence.
2742         // Then keep a list of repeatids so we only perform this update once.
2743         static $repeatids = array();
2744         if (!empty($params['repeatid']) && !in_array($params['repeatid'], $repeatids)) {
2745             // This entry is repeated so the repeatid field must be set.
2746             $DB->set_field('event', 'repeatid', $params['repeatid'], array('id' => $params['repeatid']));
2747             $repeatids[] = $params['repeatid'];
2748         }
2750     }
2751     protected function after_execute() {
2752         // Add related files
2753         $this->add_related_files('calendar', 'event_description', 'event_description');
2754     }
2757 class restore_course_completion_structure_step extends restore_structure_step {
2759     /**
2760      * Conditionally decide if this step should be executed.
2761      *
2762      * This function checks parameters that are not immediate settings to ensure
2763      * that the enviroment is suitable for the restore of course completion info.
2764      *
2765      * This function checks the following four parameters:
2766      *
2767      *   1. Course completion is enabled on the site
2768      *   2. The backup includes course completion information
2769      *   3. All modules are restorable
2770      *   4. All modules are marked for restore.
2771      *   5. No completion criteria already exist for the course.
2772      *
2773      * @return bool True is safe to execute, false otherwise
2774      */
2775     protected function execute_condition() {
2776         global $CFG, $DB;
2778         // First check course completion is enabled on this site
2779         if (empty($CFG->enablecompletion)) {
2780             // Disabled, don't restore course completion
2781             return false;
2782         }
2784         // No course completion on the front page.
2785         if ($this->get_courseid() == SITEID) {
2786             return false;
2787         }
2789         // Check it is included in the backup
2790         $fullpath = $this->task->get_taskbasepath();
2791         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2792         if (!file_exists($fullpath)) {
2793             // Not found, can't restore course completion
2794             return false;
2795         }
2797         // Check we are able to restore all backed up modules
2798         if ($this->task->is_missing_modules()) {
2799             return false;
2800         }
2802         // Check all modules within the backup are being restored.
2803         if ($this->task->is_excluding_activities()) {
2804             return false;
2805         }
2807         // Check that no completion criteria is already set for the course.
2808         if ($DB->record_exists('course_completion_criteria', array('course' => $this->get_courseid()))) {
2809             return false;
2810         }
2812         return true;
2813     }
2815     /**
2816      * Define the course completion structure
2817      *
2818      * @return array Array of restore_path_element
2819      */
2820     protected function define_structure() {
2822         // To know if we are including user completion info
2823         $userinfo = $this->get_setting_value('userscompletion');
2825         $paths = array();
2826         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
2827         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
2829         if ($userinfo) {
2830             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
2831             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
2832         }
2834         return $paths;
2836     }
2838     /**
2839      * Process course completion criteria
2840      *
2841      * @global moodle_database $DB
2842      * @param stdClass $data
2843      */
2844     public function process_course_completion_criteria($data) {
2845         global $DB;
2847         $data = (object)$data;
2848         $data->course = $this->get_courseid();
2850         // Apply the date offset to the time end field
2851         $data->timeend = $this->apply_date_offset($data->timeend);
2853         // Map the role from the criteria
2854         if (isset($data->role) && $data->role != '') {
2855             // Newer backups should include roleshortname, which makes this much easier.
2856             if (!empty($data->roleshortname)) {
2857                 $roleinstanceid = $DB->get_field('role', 'id', array('shortname' => $data->roleshortname));
2858                 if (!$roleinstanceid) {
2859                     $this->log(
2860                         'Could not match the role shortname in course_completion_criteria, so skipping',
2861                         backup::LOG_DEBUG
2862                     );
2863                     return;
2864                 }
2865                 $data->role = $roleinstanceid;
2866             } else {
2867                 $data->role = $this->get_mappingid('role', $data->role);
2868             }
2870             // Check we have an id, otherwise it causes all sorts of bugs.
2871             if (!$data->role) {
2872                 $this->log(
2873                     'Could not match role in course_completion_criteria, so skipping',
2874                     backup::LOG_DEBUG
2875                 );
2876                 return;
2877             }
2878         }
2880         // If the completion criteria is for a module we need to map the module instance
2881         // to the new module id.
2882         if (!empty($data->moduleinstance) && !empty($data->module)) {
2883             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
2884             if (empty($data->moduleinstance)) {
2885                 $this->log(
2886                     'Could not match the module instance in course_completion_criteria, so skipping',
2887                     backup::LOG_DEBUG
2888                 );
2889                 return;
2890             }
2891         } else {
2892             $data->module = null;
2893             $data->moduleinstance = null;
2894         }
2896         // We backup the course shortname rather than the ID so that we can match back to the course
2897         if (!empty($data->courseinstanceshortname)) {
2898             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
2899             if (!$courseinstanceid) {
2900                 $this->log(
2901                     'Could not match the course instance in course_completion_criteria, so skipping',
2902                     backup::LOG_DEBUG
2903                 );
2904                 return;
2905             }
2906         } else {
2907             $courseinstanceid = null;
2908         }
2909         $data->courseinstance = $courseinstanceid;
2911         $params = array(
2912             'course'         => $data->course,
2913             'criteriatype'   => $data->criteriatype,
2914             'enrolperiod'    => $data->enrolperiod,
2915             'courseinstance' => $data->courseinstance,
2916             'module'         => $data->module,
2917             'moduleinstance' => $data->moduleinstance,
2918             'timeend'        => $data->timeend,
2919             'gradepass'      => $data->gradepass,
2920             'role'           => $data->role
2921         );
2922         $newid = $DB->insert_record('course_completion_criteria', $params);
2923         $this->set_mapping('course_completion_criteria', $data->id, $newid);
2924     }
2926     /**
2927      * Processes course compltion criteria complete records
2928      *
2929      * @global moodle_database $DB
2930      * @param stdClass $data
2931      */
2932     public function process_course_completion_crit_compl($data) {
2933         global $DB;
2935         $data = (object)$data;
2937         // This may be empty if criteria could not be restored
2938         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
2940         $data->course = $this->get_courseid();
2941         $data->userid = $this->get_mappingid('user', $data->userid);
2943         if (!empty($data->criteriaid) && !empty($data->userid)) {
2944             $params = array(
2945                 'userid' => $data->userid,
2946                 'course' => $data->course,
2947                 'criteriaid' => $data->criteriaid,
2948                 'timecompleted' => $this->apply_date_offset($data->timecompleted)
2949             );
2950             if (isset($data->gradefinal)) {
2951                 $params['gradefinal'] = $data->gradefinal;
2952             }
2953             if (isset($data->unenroled)) {
2954                 $params['unenroled'] = $data->unenroled;
2955             }
2956             $DB->insert_record('course_completion_crit_compl', $params);
2957         }
2958     }
2960     /**
2961      * Process course completions
2962      *
2963      * @global moodle_database $DB
2964      * @param stdClass $data
2965      */
2966     public function process_course_completions($data) {
2967         global $DB;
2969         $data = (object)$data;
2971         $data->course = $this->get_courseid();
2972         $data->userid = $this->get_mappingid('user', $data->userid);
2974         if (!empty($data->userid)) {
2975             $params = array(
2976                 'userid' => $data->userid,
2977                 'course' => $data->course,
2978                 'timeenrolled' => $this->apply_date_offset($data->timeenrolled),
2979                 'timestarted' => $this->apply_date_offset($data->timestarted),
2980                 'timecompleted' => $this->apply_date_offset($data->timecompleted),
2981                 'reaggregate' => $data->reaggregate
2982             );
2984             $existing = $DB->get_record('course_completions', array(
2985                 'userid' => $data->userid,
2986                 'course' => $data->course
2987             ));
2989             // MDL-46651 - If cron writes out a new record before we get to it
2990             // then we should replace it with the Truth data from the backup.
2991             // This may be obsolete after MDL-48518 is resolved
2992             if ($existing) {
2993                 $params['id'] = $existing->id;
2994                 $DB->update_record('course_completions', $params);
2995             } else {
2996                 $DB->insert_record('course_completions', $params);
2997             }
2998         }
2999     }
3001     /**
3002      * Process course completion aggregate methods
3003      *
3004      * @global moodle_database $DB
3005      * @param stdClass $data
3006      */
3007     public function process_course_completion_aggr_methd($data) {
3008         global $DB;
3010         $data = (object)$data;
3012         $data->course = $this->get_courseid();
3014         // Only create the course_completion_aggr_methd records if
3015         // the target course has not them defined. MDL-28180
3016         if (!$DB->record_exists('course_completion_aggr_methd', array(
3017                     'course' => $data->course,
3018                     'criteriatype' => $data->criteriatype))) {
3019             $params = array(
3020                 'course' => $data->course,
3021                 'criteriatype' => $data->criteriatype,
3022                 'method' => $data->method,
3023                 'value' => $data->value,
3024             );
3025             $DB->insert_record('course_completion_aggr_methd', $params);
3026         }
3027     }
3031 /**
3032  * This structure step restores course logs (cmid = 0), delegating
3033  * the hard work to the corresponding {@link restore_logs_processor} passing the
3034  * collection of {@link restore_log_rule} rules to be observed as they are defined
3035  * by the task. Note this is only executed based in the 'logs' setting.
3036  *
3037  * NOTE: This is executed by final task, to have all the activities already restored
3038  *
3039  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
3040  * records are. There are others like 'calendar' and 'upload' that will be handled
3041  * later.
3042  *
3043  * NOTE: All the missing actions (not able to be restored) are sent to logs for
3044  * debugging purposes
3045  */
3046 class restore_course_logs_structure_step extends restore_structure_step {
3048     /**
3049      * Conditionally decide if this step should be executed.
3050      *
3051      * This function checks the following parameter:
3052      *
3053      *   1. the course/logs.xml file exists
3054      *
3055      * @return bool true is safe to execute, false otherwise
3056      */
3057     protected function execute_condition() {
3059         // Check it is included in the backup
3060         $fullpath = $this->task->get_taskbasepath();
3061         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
3062         if (!file_exists($fullpath)) {
3063             // Not found, can't restore course logs
3064             return false;
3065         }
3067         return true;
3068     }
3070     protected function define_structure() {
3072         $paths = array();
3074         // Simple, one plain level of information contains them
3075         $paths[] = new restore_path_element('log', '/logs/log');
3077         return $paths;
3078     }
3080     protected function process_log($data) {
3081         global $DB;
3083         $data = (object)($data);
3085         $data->time = $this->apply_date_offset($data->time);
3086         $data->userid = $this->get_mappingid('user', $data->userid);
3087         $data->course = $this->get_courseid();
3088         $data->cmid = 0;
3090         // For any reason user wasn't remapped ok, stop processing this
3091         if (empty($data->userid)) {
3092             return;
3093         }
3095         // Everything ready, let's delegate to the restore_logs_processor
3097         // Set some fixed values that will save tons of DB requests
3098         $values = array(
3099             'course' => $this->get_courseid());
3100         // Get instance and process log record
3101         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
3103         // If we have data, insert it, else something went wrong in the restore_logs_processor
3104         if ($data) {
3105             if (empty($data->url)) {
3106                 $data->url = '';
3107             }
3108             if (empty($data->info)) {
3109                 $data->info = '';
3110             }
3111             // Store the data in the legacy log table if we are still using it.
3112             $manager = get_log_manager();
3113             if (method_exists($manager, 'legacy_add_to_log')) {
3114                 $manager->legacy_add_to_log($data->course, $data->module, $data->action, $data->url,
3115                     $data->info, $data->cmid, $data->userid, $data->ip, $data->time);
3116             }
3117         }
3118     }
3121 /**
3122  * This structure step restores activity logs, extending {@link restore_course_logs_structure_step}
3123  * sharing its same structure but modifying the way records are handled
3124  */
3125 class restore_activity_logs_structure_step extends restore_course_logs_structure_step {
3127     protected function process_log($data) {
3128         global $DB;
3130         $data = (object)($data);
3132         $data->time = $this->apply_date_offset($data->time);
3133         $data->userid = $this->get_mappingid('user', $data->userid);
3134         $data->course = $this->get_courseid();
3135         $data->cmid = $this->task->get_moduleid();
3137         // For any reason user wasn't remapped ok, stop processing this
3138         if (empty($data->userid)) {
3139             return;
3140         }
3142         // Everything ready, let's delegate to the restore_logs_processor
3144         // Set some fixed values that will save tons of DB requests
3145         $values = array(
3146             'course' => $this->get_courseid(),
3147             'course_module' => $this->task->get_moduleid(),
3148             $this->task->get_modulename() => $this->task->get_activityid());
3149         // Get instance and process log record
3150         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
3152         // If we have data, insert it, else something went wrong in the restore_logs_processor
3153         if ($data) {
3154             if (empty($data->url)) {
3155                 $data->url = '';
3156             }
3157             if (empty($data->info)) {
3158                 $data->info = '';
3159             }
3160             // Store the data in the legacy log table if we are still using it.
3161             $manager = get_log_manager();
3162             if (method_exists($manager, 'legacy_add_to_log')) {
3163                 $manager->legacy_add_to_log($data->course, $data->module, $data->action, $data->url,
3164                     $data->info, $data->cmid, $data->userid, $data->ip, $data->time);
3165             }
3166         }
3167     }
3170 /**
3171  * Structure step in charge of restoring the logstores.xml file for the course logs.
3172  *
3173  * This restore step will rebuild the logs for all the enabled logstore subplugins supporting
3174  * it, for logs belonging to the course level.
3175  */
3176 class restore_course_logstores_structure_step extends restore_structure_step {
3178     /**
3179      * Conditionally decide if this step should be executed.
3180      *
3181      * This function checks the following parameter:
3182      *
3183      *   1. the logstores.xml file exists
3184      *
3185      * @return bool true is safe to execute, false otherwise
3186      */
3187     protected function execute_condition() {
3189         // Check it is included in the backup.
3190         $fullpath = $this->task->get_taskbasepath();
3191         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
3192         if (!file_exists($fullpath)) {
3193             // Not found, can't restore logstores.xml information.
3194             return false;
3195         }
3197         return true;
3198     }
3200     /**
3201      * Return the elements to be processed on restore of logstores.
3202      *
3203      * @return restore_path_element[] array of elements to be processed on restore.
3204      */
3205     protected function define_structure() {
3207         $paths = array();
3209         $logstore = new restore_path_element('logstore', '/logstores/logstore');
3210         $paths[] = $logstore;
3212         // Add logstore subplugin support to the 'logstore' element.
3213         $this->add_subplugin_structure('logstore', $logstore, 'tool', 'log');
3215         return array($logstore);
3216     }
3218     /**
3219      * Process the 'logstore' element,
3220      *
3221      * Note: This is empty by definition in backup, because stores do not share any
3222      * data between them, so there is nothing to process here.
3223      *
3224      * @param array $data element data
3225      */
3226     protected function process_logstore($data) {
3227         return;
3228     }
3231 /**
3232  * Structure step in charge of restoring the logstores.xml file for the activity logs.
3233  *
3234  * Note: Activity structure is completely equivalent to the course one, so just extend it.
3235  */
3236 class restore_activity_logstores_structure_step extends restore_course_logstores_structure_step {
3239 /**
3240  * Restore course competencies structure step.
3241  */
3242 class restore_course_competencies_structure_step extends restore_structure_step {
3244     /**
3245      * Returns the structure.
3246      *
3247      * @return array
3248      */
3249     protected function define_structure() {
3250         $userinfo = $this->get_setting_value('users');
3251         $paths = array(
3252             new restore_path_element('course_competency', '/course_competencies/competencies/competency'),
3253             new restore_path_element('course_competency_settings', '/course_competencies/settings'),
3254         );
3255         if ($userinfo) {
3256             $paths[] = new restore_path_element('user_competency_course',
3257                 '/course_competencies/user_competencies/user_competency');
3258         }
3259         return $paths;
3260     }
3262     /**
3263      * Process a course competency settings.
3264      *
3265      * @param array $data The data.
3266      */
3267     public function process_course_competency_settings($data) {
3268         global $DB;
3269         $data = (object) $data;
3271         // We do not restore the course settings during merge.
3272         $target = $this->get_task()->get_target();
3273         if ($target == backup::TARGET_CURRENT_ADDING || $target == backup::TARGET_EXISTING_ADDING) {
3274             return;
3275         }
3277         $courseid = $this->task->get_courseid();
3278         $exists = \core_competency\course_competency_settings::record_exists_select('courseid = :courseid',
3279             array('courseid' => $courseid));
3281         // Strangely the course settings already exist, let's just leave them as is then.
3282         if ($exists) {
3283             $this->log('Course competency settings not restored, existing settings have been found.', backup::LOG_WARNING);
3284             return;
3285         }
3287         $data = (object) array('courseid' => $courseid, 'pushratingstouserplans' => $data->pushratingstouserplans);
3288         $settings = new \core_competency\course_competency_settings(0, $data);
3289         $settings->create();
3290     }
3292     /**
3293      * Process a course competency.
3294      *
3295      * @param array $data The data.
3296      */
3297     public function process_course_competency($data) {
3298         $data = (object) $data;
3300         // Mapping the competency by ID numbers.
3301         $framework = \core_competency\competency_framework::get_record(array('idnumber' => $data->frameworkidnumber));
3302         if (!$framework) {
3303             return;
3304         }
3305         $competency = \core_competency\competency::get_record(array('idnumber' => $data->idnumber,
3306             'competencyframeworkid' => $framework->get('id')));
3307         if (!$competency) {
3308             return;
3309         }
3310         $this->set_mapping(\core_competency\competency::TABLE, $data->id, $competency->get('id'));
3312         $params = array(
3313             'competencyid' => $competency->get('id'),
3314             'courseid' => $this->task->get_courseid()
3315         );
3316         $query = 'competencyid = :competencyid AND courseid = :courseid';
3317         $existing = \core_competency\course_competency::record_exists_select($query, $params);
3319         if (!$existing) {
3320             // Sortorder is ignored by precaution, anyway we should walk through the records in the right order.
3321             $record = (object) $params;
3322             $record->ruleoutcome = $data->ruleoutcome;
3323             $coursecompetency = new \core_competency\course_competency(0, $record);
3324             $coursecompetency->create();
3325         }
3326     }
3328     /**
3329      * Process the user competency course.
3330      *
3331      * @param array $data The data.
3332      */
3333     public function process_user_competency_course($data) {
3334         global $USER, $DB;
3335         $data = (object) $data;
3337         $data->competencyid = $this->get_mappingid(\core_competency\competency::TABLE, $data->competencyid);
3338         if (!$data->competencyid) {
3339             // This is strange, the competency does not belong to the course.
3340             return;
3341         } else if ($data->grade === null) {
3342             // We do not need to do anything when there is no grade.
3343             return;
3344         }
3346         $data->userid = $this->get_mappingid('user', $data->userid);
3347         $shortname = $DB->get_field('course', 'shortname', array('id' => $this->task->get_courseid()), MUST_EXIST);
3349         // The method add_evidence also sets the course rating.
3350         \core_competency\api::add_evidence($data->userid,
3351                                            $data->competencyid,
3352                                            $this->task->get_contextid(),
3353                                            \core_competency\evidence::ACTION_OVERRIDE,
3354                                            'evidence_courserestored',
3355                                            'core_competency',
3356                                            $shortname,
3357                                            false,
3358                                            null,
3359                                            $data->grade,
3360                                            $USER->id);
3361     }
3363     /**
3364      * Execute conditions.
3365      *
3366      * @return bool
3367      */
3368     protected function execute_condition() {
3370         // Do not execute if competencies are not included.
3371         if (!$this->get_setting_value('competencies')) {
3372             return false;
3373         }
3375         // Do not execute if the competencies XML file is not found.
3376         $fullpath = $this->task->get_taskbasepath();
3377         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
3378         if (!file_exists($fullpath)) {
3379             return false;
3380         }
3382         return true;
3383     }
3386 /**
3387  * Restore activity competencies structure step.
3388  */
3389 class restore_activity_competencies_structure_step extends restore_structure_step {
3391     /**
3392      * Defines the structure.
3393      *
3394      * @return array
3395      */
3396     protected function define_structure() {
3397         $paths = array(
3398             new restore_path_element('course_module_competency', '/course_module_competencies/competencies/competency')
3399         );
3400         return $paths;
3401     }
3403     /**
3404      * Process a course module competency.
3405      *
3406      * @param array $data The data.
3407      */
3408     public function process_course_module_competency($data) {
3409         $data = (object) $data;
3411         // Mapping the competency by ID numbers.
3412         $framework = \core_competency\competency_framework::get_record(array('idnumber' => $data->frameworkidnumber));
3413         if (!$framework) {
3414             return;
3415         }
3416         $competency = \core_competency\competency::get_record(array('idnumber' => $data->idnumber,
3417             'competencyframeworkid' => $framework->get('id')));
3418         if (!$competency) {
3419             return;
3420         }
3422         $params = array(
3423             'competencyid' => $competency->get('id'),
3424             'cmid' => $this->task->get_moduleid()
3425         );
3426         $query = 'competencyid = :competencyid AND cmid = :cmid';
3427         $existing = \core_competency\course_module_competency::record_exists_select($query, $params);
3429         if (!$existing) {
3430             // Sortorder is ignored by precaution, anyway we should walk through the records in the right order.
3431             $record = (object) $params;
3432             $record->ruleoutcome = $data->ruleoutcome;
3433             $coursemodulecompetency = new \core_competency\course_module_competency(0, $record);
3434             $coursemodulecompetency->create();
3435         }
3436     }
3438     /**
3439      * Execute conditions.
3440      *
3441      * @return bool
3442      */
3443     protected function execute_condition() {
3445         // Do not execute if competencies are not included.
3446         if (!$this->get_setting_value('competencies')) {
3447             return false;
3448         }
3450         // Do not execute if the competencies XML file is not found.
3451         $fullpath = $this->task->get_taskbasepath();
3452         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
3453         if (!file_exists($fullpath)) {
3454             return false;
3455         }
3457         return true;
3458     }
3461 /**
3462  * Defines the restore step for advanced grading methods attached to the activity module
3463  */
3464 class restore_activity_grading_structure_step extends restore_structure_step {
3466     /**
3467      * This step is executed only if the grading file is present
3468      */
3469      protected function execute_condition() {
3471         if ($this->get_courseid() == SITEID) {
3472             return false;
3473         }
3475         $fullpath = $this->task->get_taskbasepath();
3476         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
3477         if (!file_exists($fullpath)) {
3478             return false;
3479         }
3481         return true;
3482     }
3485     /**
3486      * Declares paths in the grading.xml file we are interested in
3487      */
3488     protected function define_structure() {
3490         $paths = array();
3491         $userinfo = $this->get_setting_value('userinfo');
3493         $area = new restore_path_element('grading_area', '/areas/area');
3494         $paths[] = $area;
3495         // attach local plugin stucture to $area element
3496         $this->add_plugin_structure('local', $area);
3498         $definition = new restore_path_element('grading_definition', '/areas/area/definitions/definition');
3499         $paths[] = $definition;
3500         $this->add_plugin_structure('gradingform', $definition);
3501         // attach local plugin stucture to $definition element
3502         $this->add_plugin_structure('local', $definition);
3505         if ($userinfo) {
3506             $instance = new restore_path_element('grading_instance',
3507                 '/areas/area/definitions/definition/instances/instance');
3508             $paths[] = $instance;
3509             $this->add_plugin_structure('gradingform', $instance);
3510             // attach local plugin stucture to $intance element
3511             $this->add_plugin_structure('local', $instance);
3512         }
3514         return $paths;
3515     }
3517     /**
3518      * Processes one grading area element
3519      *
3520      * @param array $data element data
3521      */
3522     protected function process_grading_area($data) {
3523         global $DB;
3525         $task = $this->get_task();
3526         $data = (object)$data;
3527         $oldid = $data->id;
3528         $data->component = 'mod_'.$task->get_modulename();
3529         $data->contextid = $task->get_contextid();
3531         $newid = $DB->insert_record('grading_areas', $data);
3532         $this->set_mapping('grading_area', $oldid, $newid);
3533     }
3535     /**
3536      * Processes one grading definition element
3537      *
3538      * @param array $data element data
3539      */
3540     protected function process_grading_definition($data) {
3541         global $DB;
3543         $task = $this->get_task();
3544         $data = (object)$data;
3545         $oldid = $data->id;
3546         $data->areaid = $this->get_new_parentid('grading_area');
3547         $data->copiedfromid = null;
3548         $data->timecreated = time();
3549         $data->usercreated = $task->get_userid();
3550         $data->timemodified = $data->timecreated;
3551         $data->usermodified = $data->usercreated;
3553         $newid = $DB->insert_record('grading_definitions', $data);
3554         $this->set_mapping('grading_definition', $oldid, $newid, true);
3555     }
3557     /**
3558      * Processes one grading form instance element
3559      *
3560      * @param array $data element data
3561      */
3562     protected function process_grading_instance($data) {
3563         global $DB;
3565         $data = (object)$data;
3567         // new form definition id
3568         $newformid = $this->get_new_parentid('grading_definition');
3570         // get the name of the area we are restoring to
3571         $sql = "SELECT ga.areaname
3572                   FROM {grading_definitions} gd
3573                   JOIN {grading_areas} ga ON gd.areaid = ga.id
3574                  WHERE gd.id = ?";
3575         $areaname = $DB->get_field_sql($sql, array($newformid), MUST_EXIST);
3577         // get the mapped itemid - the activity module is expected to define the mappings
3578         // for each gradable area
3579         $newitemid = $this->get_mappingid(restore_gradingform_plugin::itemid_mapping($areaname), $data->itemid);
3581         $oldid = $data->id;
3582         $data->definitionid = $newformid;
3583         $data->raterid = $this->get_mappingid('user', $data->raterid);
3584         $data->itemid = $newitemid;
3586         $newid = $DB->insert_record('grading_instances', $data);
3587         $this->set_mapping('grading_instance', $oldid, $newid);
3588     }
3590     /**
3591      * Final operations when the database records are inserted
3592      */
3593     protected function after_execute() {
3594         // Add files embedded into the definition description
3595         $this->add_related_files('grading', 'description', 'grading_definition');
3596     }
3600 /**
3601  * This structure step restores the grade items associated with one activity
3602  * All the grade items are made child of the "course" grade item but the original
3603  * categoryid is saved as parentitemid in the backup_ids table, so, when restoring
3604  * the complete gradebook (categories and calculations), that information is
3605  * available there
3606  */
3607 class restore_activity_grades_structure_step extends restore_structure_step {
3609     /**
3610      * No grades in front page.
3611      * @return bool
3612      */
3613     protected function execute_condition() {
3614         return ($this->get_courseid() != SITEID);
3615     }
3617     protected function define_structure() {
3619         $paths = array();
3620         $userinfo = $this->get_setting_value('userinfo');
3622         $paths[] = new restore_path_element('grade_item', '/activity_gradebook/grade_items/grade_item');
3623         $paths[] = new restore_path_element('grade_letter', '/activity_gradebook/grade_letters/grade_letter');
3624         if ($userinfo) {
3625             $paths[] = new restore_path_element('grade_grade',
3626                            '/activity_gradebook/grade_items/grade_item/grade_grades/grade_grade');
3627         }
3628         return $paths;
3629     }
3631     protected function process_grade_item($data) {
3632         global $DB;
3634         $data = (object)($data);
3635         $oldid       = $data->id;        // We'll need these later
3636         $oldparentid = $data->categoryid;
3637         $courseid = $this->get_courseid();
3639         $idnumber = null;
3640         if (!empty($data->idnumber)) {
3641             // Don't get any idnumber from course module. Keep them as they are in grade_item->idnumber
3642             // Reason: it's not clear what happens with outcomes->idnumber or activities with multiple items (workshop)
3643             // so the best is to keep the ones already in the gradebook
3644             // Potential problem: duplicates if same items are restored more than once. :-(
3645             // This needs to be fixed in some way (outcomes & activities with multiple items)
3646             // $data->idnumber     = get_coursemodule_from_instance($data->itemmodule, $data->iteminstance)->idnumber;
3647             // In any case, verify always for uniqueness
3648             $sql = "SELECT cm.id
3649                       FROM {course_modules} cm
3650                      WHERE cm.course = :courseid AND
3651                            cm.idnumber = :idnumber AND
3652                            cm.id <> :cmid";
3653             $params = array(
3654                 'courseid' => $courseid,
3655                 'idnumber' => $data->idnumber,
3656                 'cmid' => $this->task->get_moduleid()
3657             );
3658             if (!$DB->record_exists_sql($sql, $params) && !$DB->record_exists('grade_items', array('courseid' => $courseid, 'idnumber' => $data->idnumber))) {
3659                 $idnumber = $data->idnumber;
3660             }
3661         }
3663         if (!empty($data->categoryid)) {
3664             // If the grade category id of the grade item being restored belongs to this course
3665             // then it is a fair assumption that this is the correct grade category for the activity
3666             // and we should leave it in place, if not then unset it.
3667             // TODO MDL-34790 Gradebook does not import if target course has gradebook categories.
3668             $conditions = array('id' => $data->categoryid, 'courseid' => $courseid);
3669             if (!$this->task->is_samesite() || !$DB->record_exists('grade_categories', $conditions)) {
3670                 unset($data->categoryid);
3671             }
3672         }
3674         unset($data->id);
3675         $data->courseid     = $this->get_courseid();
3676         $data->iteminstance = $this->task->get_activityid();
3677         $data->idnumber     = $idnumber;
3678         $data->scaleid      = $this->get_mappingid('scale', $data->scaleid);
3679         $data->outcomeid    = $this->get_mappingid('outcome', $data->outcomeid);
3680         $data->timecreated  = $this->apply_date_offset($data->timecreated);
3681         $data->timemodified = $this->apply_date_offset($data->timemodified);
3683         $gradeitem = new grade_item($data, false);
3684         $gradeitem->insert('restore');
3686         //sortorder is automatically assigned when inserting. Re-instate the previous sortorder
3687         $gradeitem->sortorder = $data->sortorder;
3688         $gradeitem->update('restore');
3690         // Set mapping, saving the original category id into parentitemid
3691         // gradebook restore (final task) will need it to reorganise items
3692         $this->set_mapping('grade_item', $oldid, $gradeitem->id, false, null, $oldparentid);
3693     }
3695     protected function process_grade_grade($data) {
3696         $data = (object)($data);
3697         $olduserid = $data->userid;
3698         $oldid = $data->id;
3699         unset($data->id);
3701         $data->itemid = $this->get_new_parentid('grade_item');
3703         $data->userid = $this->get_mappingid('user', $data->userid, null);
3704         if (!empty($data->userid)) {
3705             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
3706             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
3707             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
3708             $data->overridden = $this->apply_date_offset($data->overridden);
3710             $grade = new grade_grade($data, false);
3711             $grade->insert('restore');
3712             $this->set_mapping('grade_grades', $oldid, $grade->id);
3713         } else {
3714             debugging("Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'");
3715         }
3716     }
3718     /**
3719      * process activity grade_letters. Note that, while these are possible,
3720      * because grade_letters are contextid based, in practice, only course
3721      * context letters can be defined. So we keep here this method knowing
3722      * it won't be executed ever. gradebook restore will restore course letters.
3723      */
3724     protected function process_grade_letter($data) {
3725         global $DB;
3727         $data['contextid'] = $this->task->get_contextid();
3728         $gradeletter = (object)$data;
3730         // Check if it exists before adding it
3731         unset($data['id']);
3732         if (!$DB->record_exists('grade_letters', $data)) {
3733             $newitemid = $DB->insert_record('grade_letters', $gradeletter);
3734         }
3735         // no need to save any grade_letter mapping
3736     }
3738     public function after_restore() {
3739         // Fix grade item's sortorder after restore, as it might have duplicates.
3740         $courseid = $this->get_task()->get_courseid();
3741         grade_item::fix_duplicate_sortorder($courseid);
3742     }
3745 /**
3746  * Step in charge of restoring the grade history of an activity.
3747  *
3748  * This step is added to the task regardless of the setting 'grade_histories'.
3749  * The reason is to allow for a more flexible step in case the logic needs to be
3750  * split accross different settings to control the history of items and/or grades.
3751  */
3752 class restore_activity_grade_history_structure_step extends restore_structure_step {
3754     /**
3755      * This step is executed only if the grade history file is present.
3756      */
3757      protected function execute_condition() {
3759         if ($this->get_courseid() == SITEID) {
3760             return false;
3761         }
3763         $fullpath = $this->task->get_taskbasepath();
3764         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
3765         if (!file_exists($fullpath)) {
3766             return false;
3767         }
3768         return true;
3769     }
3771 &nb