caf5f071b10f3b12f0479725d226f649ae400bdc
[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         // Arrived here, execute the step
125         return true;
126      }
128     protected function define_structure() {
129         $paths = array();
130         $userinfo = $this->task->get_setting_value('users');
132         $paths[] = new restore_path_element('gradebook', '/gradebook');
133         $paths[] = new restore_path_element('grade_category', '/gradebook/grade_categories/grade_category');
134         $paths[] = new restore_path_element('grade_item', '/gradebook/grade_items/grade_item');
135         if ($userinfo) {
136             $paths[] = new restore_path_element('grade_grade', '/gradebook/grade_items/grade_item/grade_grades/grade_grade');
137         }
138         $paths[] = new restore_path_element('grade_letter', '/gradebook/grade_letters/grade_letter');
139         $paths[] = new restore_path_element('grade_setting', '/gradebook/grade_settings/grade_setting');
141         return $paths;
142     }
144     protected function process_gradebook($data) {
145         // For non-merge restore types:
146         // Unset 'gradebook_calculations_freeze_' in the course and replace with the one from the backup.
147         $target = $this->get_task()->get_target();
148         if ($target == backup::TARGET_CURRENT_DELETING || $target == backup::TARGET_EXISTING_DELETING) {
149             set_config('gradebook_calculations_freeze_' . $this->get_courseid(), null);
150         }
151         if (!empty($data['calculations_freeze'])) {
152             if ($target == backup::TARGET_NEW_COURSE || $target == backup::TARGET_CURRENT_DELETING ||
153                     $target == backup::TARGET_EXISTING_DELETING) {
154                 set_config('gradebook_calculations_freeze_' . $this->get_courseid(), $data['calculations_freeze']);
155             }
156         }
157     }
159     protected function process_grade_item($data) {
160         global $DB;
162         $data = (object)$data;
164         $oldid = $data->id;
165         $data->course = $this->get_courseid();
167         $data->courseid = $this->get_courseid();
169         if ($data->itemtype=='manual') {
170             // manual grade items store category id in categoryid
171             $data->categoryid = $this->get_mappingid('grade_category', $data->categoryid, NULL);
172             // if mapping failed put in course's grade category
173             if (NULL == $data->categoryid) {
174                 $coursecat = grade_category::fetch_course_category($this->get_courseid());
175                 $data->categoryid = $coursecat->id;
176             }
177         } else if ($data->itemtype=='course') {
178             // course grade item stores their category id in iteminstance
179             $coursecat = grade_category::fetch_course_category($this->get_courseid());
180             $data->iteminstance = $coursecat->id;
181         } else if ($data->itemtype=='category') {
182             // category grade items store their category id in iteminstance
183             $data->iteminstance = $this->get_mappingid('grade_category', $data->iteminstance, NULL);
184         } else {
185             throw new restore_step_exception('unexpected_grade_item_type', $data->itemtype);
186         }
188         $data->scaleid   = $this->get_mappingid('scale', $data->scaleid, NULL);
189         $data->outcomeid = $this->get_mappingid('outcome', $data->outcomeid, NULL);
191         $data->locktime     = $this->apply_date_offset($data->locktime);
192         $data->timecreated  = $this->apply_date_offset($data->timecreated);
193         $data->timemodified = $this->apply_date_offset($data->timemodified);
195         $coursecategory = $newitemid = null;
196         //course grade item should already exist so updating instead of inserting
197         if($data->itemtype=='course') {
198             //get the ID of the already created grade item
199             $gi = new stdclass();
200             $gi->courseid  = $this->get_courseid();
201             $gi->itemtype  = $data->itemtype;
203             //need to get the id of the grade_category that was automatically created for the course
204             $category = new stdclass();
205             $category->courseid  = $this->get_courseid();
206             $category->parent  = null;
207             //course category fullname starts out as ? but may be edited
208             //$category->fullname  = '?';
209             $coursecategory = $DB->get_record('grade_categories', (array)$category);
210             $gi->iteminstance = $coursecategory->id;
212             $existinggradeitem = $DB->get_record('grade_items', (array)$gi);
213             if (!empty($existinggradeitem)) {
214                 $data->id = $newitemid = $existinggradeitem->id;
215                 $DB->update_record('grade_items', $data);
216             }
217         } else if ($data->itemtype == 'manual') {
218             // Manual items aren't assigned to a cm, so don't go duplicating them in the target if one exists.
219             $gi = array(
220                 'itemtype' => $data->itemtype,
221                 'courseid' => $data->courseid,
222                 'itemname' => $data->itemname,
223                 'categoryid' => $data->categoryid,
224             );
225             $newitemid = $DB->get_field('grade_items', 'id', $gi);
226         }
228         if (empty($newitemid)) {
229             //in case we found the course category but still need to insert the course grade item
230             if ($data->itemtype=='course' && !empty($coursecategory)) {
231                 $data->iteminstance = $coursecategory->id;
232             }
234             $newitemid = $DB->insert_record('grade_items', $data);
235         }
236         $this->set_mapping('grade_item', $oldid, $newitemid);
237     }
239     protected function process_grade_grade($data) {
240         global $DB;
242         $data = (object)$data;
243         $oldid = $data->id;
244         $olduserid = $data->userid;
246         $data->itemid = $this->get_new_parentid('grade_item');
248         $data->userid = $this->get_mappingid('user', $data->userid, null);
249         if (!empty($data->userid)) {
250             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
251             $data->locktime     = $this->apply_date_offset($data->locktime);
252             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
253             $data->overridden = $this->apply_date_offset($data->overridden);
254             $data->timecreated  = $this->apply_date_offset($data->timecreated);
255             $data->timemodified = $this->apply_date_offset($data->timemodified);
257             $gradeexists = $DB->record_exists('grade_grades', array('userid' => $data->userid, 'itemid' => $data->itemid));
258             if ($gradeexists) {
259                 $message = "User id '{$data->userid}' already has a grade entry for grade item id '{$data->itemid}'";
260                 $this->log($message, backup::LOG_DEBUG);
261             } else {
262                 $newitemid = $DB->insert_record('grade_grades', $data);
263                 $this->set_mapping('grade_grades', $oldid, $newitemid);
264             }
265         } else {
266             $message = "Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'";
267             $this->log($message, backup::LOG_DEBUG);
268         }
269     }
271     protected function process_grade_category($data) {
272         global $DB;
274         $data = (object)$data;
275         $oldid = $data->id;
277         $data->course = $this->get_courseid();
278         $data->courseid = $data->course;
280         $data->timecreated  = $this->apply_date_offset($data->timecreated);
281         $data->timemodified = $this->apply_date_offset($data->timemodified);
283         $newitemid = null;
284         //no parent means a course level grade category. That may have been created when the course was created
285         if(empty($data->parent)) {
286             //parent was being saved as 0 when it should be null
287             $data->parent = null;
289             //get the already created course level grade category
290             $category = new stdclass();
291             $category->courseid = $this->get_courseid();
292             $category->parent = null;
294             $coursecategory = $DB->get_record('grade_categories', (array)$category);
295             if (!empty($coursecategory)) {
296                 $data->id = $newitemid = $coursecategory->id;
297                 $DB->update_record('grade_categories', $data);
298             }
299         }
301         // Add a warning about a removed setting.
302         if (!empty($data->aggregatesubcats)) {
303             set_config('show_aggregatesubcats_upgrade_' . $data->courseid, 1);
304         }
306         //need to insert a course category
307         if (empty($newitemid)) {
308             $newitemid = $DB->insert_record('grade_categories', $data);
309         }
310         $this->set_mapping('grade_category', $oldid, $newitemid);
311     }
312     protected function process_grade_letter($data) {
313         global $DB;
315         $data = (object)$data;
316         $oldid = $data->id;
318         $data->contextid = context_course::instance($this->get_courseid())->id;
320         $gradeletter = (array)$data;
321         unset($gradeletter['id']);
322         if (!$DB->record_exists('grade_letters', $gradeletter)) {
323             $newitemid = $DB->insert_record('grade_letters', $data);
324         } else {
325             $newitemid = $data->id;
326         }
328         $this->set_mapping('grade_letter', $oldid, $newitemid);
329     }
330     protected function process_grade_setting($data) {
331         global $DB;
333         $data = (object)$data;
334         $oldid = $data->id;
336         $data->courseid = $this->get_courseid();
338         $target = $this->get_task()->get_target();
339         if ($data->name == 'minmaxtouse' &&
340                 ($target == backup::TARGET_CURRENT_ADDING || $target == backup::TARGET_EXISTING_ADDING)) {
341             // We never restore minmaxtouse during merge.
342             return;
343         }
345         if (!$DB->record_exists('grade_settings', array('courseid' => $data->courseid, 'name' => $data->name))) {
346             $newitemid = $DB->insert_record('grade_settings', $data);
347         } else {
348             $newitemid = $data->id;
349         }
351         if (!empty($oldid)) {
352             // In rare cases (minmaxtouse), it is possible that there wasn't any ID associated with the setting.
353             $this->set_mapping('grade_setting', $oldid, $newitemid);
354         }
355     }
357     /**
358      * put all activity grade items in the correct grade category and mark all for recalculation
359      */
360     protected function after_execute() {
361         global $DB;
363         $conditions = array(
364             'backupid' => $this->get_restoreid(),
365             'itemname' => 'grade_item'//,
366             //'itemid'   => $itemid
367         );
368         $rs = $DB->get_recordset('backup_ids_temp', $conditions);
370         // We need this for calculation magic later on.
371         $mappings = array();
373         if (!empty($rs)) {
374             foreach($rs as $grade_item_backup) {
376                 // Store the oldid with the new id.
377                 $mappings[$grade_item_backup->itemid] = $grade_item_backup->newitemid;
379                 $updateobj = new stdclass();
380                 $updateobj->id = $grade_item_backup->newitemid;
382                 //if this is an activity grade item that needs to be put back in its correct category
383                 if (!empty($grade_item_backup->parentitemid)) {
384                     $oldcategoryid = $this->get_mappingid('grade_category', $grade_item_backup->parentitemid, null);
385                     if (!is_null($oldcategoryid)) {
386                         $updateobj->categoryid = $oldcategoryid;
387                         $DB->update_record('grade_items', $updateobj);
388                     }
389                 } else {
390                     //mark course and category items as needing to be recalculated
391                     $updateobj->needsupdate=1;
392                     $DB->update_record('grade_items', $updateobj);
393                 }
394             }
395         }
396         $rs->close();
398         // We need to update the calculations for calculated grade items that may reference old
399         // grade item ids using ##gi\d+##.
400         // $mappings can be empty, use 0 if so (won't match ever)
401         list($sql, $params) = $DB->get_in_or_equal(array_values($mappings), SQL_PARAMS_NAMED, 'param', true, 0);
402         $sql = "SELECT gi.id, gi.calculation
403                   FROM {grade_items} gi
404                  WHERE gi.id {$sql} AND
405                        calculation IS NOT NULL";
406         $rs = $DB->get_recordset_sql($sql, $params);
407         foreach ($rs as $gradeitem) {
408             // Collect all of the used grade item id references
409             if (preg_match_all('/##gi(\d+)##/', $gradeitem->calculation, $matches) < 1) {
410                 // This calculation doesn't reference any other grade items... EASY!
411                 continue;
412             }
413             // For this next bit we are going to do the replacement of id's in two steps:
414             // 1. We will replace all old id references with a special mapping reference.
415             // 2. We will replace all mapping references with id's
416             // Why do we do this?
417             // Because there potentially there will be an overlap of ids within the query and we
418             // we substitute the wrong id.. safest way around this is the two step system
419             $calculationmap = array();
420             $mapcount = 0;
421             foreach ($matches[1] as $match) {
422                 // Check that the old id is known to us, if not it was broken to begin with and will
423                 // continue to be broken.
424                 if (!array_key_exists($match, $mappings)) {
425                     continue;
426                 }
427                 // Our special mapping key
428                 $mapping = '##MAPPING'.$mapcount.'##';
429                 // The old id that exists within the calculation now
430                 $oldid = '##gi'.$match.'##';
431                 // The new id that we want to replace the old one with.
432                 $newid = '##gi'.$mappings[$match].'##';
433                 // Replace in the special mapping key
434                 $gradeitem->calculation = str_replace($oldid, $mapping, $gradeitem->calculation);
435                 // And record the mapping
436                 $calculationmap[$mapping] = $newid;
437                 $mapcount++;
438             }
439             // Iterate all special mappings for this calculation and replace in the new id's
440             foreach ($calculationmap as $mapping => $newid) {
441                 $gradeitem->calculation = str_replace($mapping, $newid, $gradeitem->calculation);
442             }
443             // Update the calculation now that its being remapped
444             $DB->update_record('grade_items', $gradeitem);
445         }
446         $rs->close();
448         // Need to correct the grade category path and parent
449         $conditions = array(
450             'courseid' => $this->get_courseid()
451         );
453         $rs = $DB->get_recordset('grade_categories', $conditions);
454         // Get all the parents correct first as grade_category::build_path() loads category parents from the DB
455         foreach ($rs as $gc) {
456             if (!empty($gc->parent)) {
457                 $grade_category = new stdClass();
458                 $grade_category->id = $gc->id;
459                 $grade_category->parent = $this->get_mappingid('grade_category', $gc->parent);
460                 $DB->update_record('grade_categories', $grade_category);
461             }
462         }
463         $rs->close();
465         // Now we can rebuild all the paths
466         $rs = $DB->get_recordset('grade_categories', $conditions);
467         foreach ($rs as $gc) {
468             $grade_category = new stdClass();
469             $grade_category->id = $gc->id;
470             $grade_category->path = grade_category::build_path($gc);
471             $grade_category->depth = substr_count($grade_category->path, '/') - 1;
472             $DB->update_record('grade_categories', $grade_category);
473         }
474         $rs->close();
476         // Check what to do with the minmaxtouse setting.
477         $this->check_minmaxtouse();
479         // Freeze gradebook calculations if needed.
480         $this->gradebook_calculation_freeze();
482         // Restore marks items as needing update. Update everything now.
483         grade_regrade_final_grades($this->get_courseid());
484     }
486     /**
487      * Freeze gradebook calculation if needed.
488      *
489      * This is similar to various upgrade scripts that check if the freeze is needed.
490      */
491     protected function gradebook_calculation_freeze() {
492         global $CFG;
493         $gradebookcalculationsfreeze = get_config('core', 'gradebook_calculations_freeze_' . $this->get_courseid());
494         preg_match('/(\d{8})/', $this->get_task()->get_info()->moodle_release, $matches);
495         $backupbuild = (int)$matches[1];
497         // Extra credits need adjustments only for backups made between 2.8 release (20141110) and the fix release (20150619).
498         if (!$gradebookcalculationsfreeze && $backupbuild >= 20141110 && $backupbuild < 20150619) {
499             require_once($CFG->libdir . '/db/upgradelib.php');
500             upgrade_extra_credit_weightoverride($this->get_courseid());
501         }
502         // Calculated grade items need recalculating for backups made between 2.8 release (20141110) and the fix release (20150627).
503         if (!$gradebookcalculationsfreeze && $backupbuild >= 20141110 && $backupbuild < 20150627) {
504             require_once($CFG->libdir . '/db/upgradelib.php');
505             upgrade_calculated_grade_items($this->get_courseid());
506         }
507     }
509     /**
510      * Checks what should happen with the course grade setting minmaxtouse.
511      *
512      * This is related to the upgrade step at the time the setting was added.
513      *
514      * @see MDL-48618
515      * @return void
516      */
517     protected function check_minmaxtouse() {
518         global $CFG, $DB;
519         require_once($CFG->libdir . '/gradelib.php');
521         $userinfo = $this->task->get_setting_value('users');
522         $settingname = 'minmaxtouse';
523         $courseid = $this->get_courseid();
524         $minmaxtouse = $DB->get_field('grade_settings', 'value', array('courseid' => $courseid, 'name' => $settingname));
525         $version28start = 2014111000.00;
526         $version28last = 2014111006.05;
527         $version29start = 2015051100.00;
528         $version29last = 2015060400.02;
530         $target = $this->get_task()->get_target();
531         if ($minmaxtouse === false &&
532                 ($target != backup::TARGET_CURRENT_ADDING && $target != backup::TARGET_EXISTING_ADDING)) {
533             // The setting was not found because this setting did not exist at the time the backup was made.
534             // And we are not restoring as merge, in which case we leave the course as it was.
535             $version = $this->get_task()->get_info()->moodle_version;
537             if ($version < $version28start) {
538                 // We need to set it to use grade_item, but only if the site-wide setting is different. No need to notice them.
539                 if ($CFG->grade_minmaxtouse != GRADE_MIN_MAX_FROM_GRADE_ITEM) {
540                     grade_set_setting($courseid, $settingname, GRADE_MIN_MAX_FROM_GRADE_ITEM);
541                 }
543             } else if (($version >= $version28start && $version < $version28last) ||
544                     ($version >= $version29start && $version < $version29last)) {
545                 // They should be using grade_grade when the course has inconsistencies.
547                 $sql = "SELECT gi.id
548                           FROM {grade_items} gi
549                           JOIN {grade_grades} gg
550                             ON gg.itemid = gi.id
551                          WHERE gi.courseid = ?
552                            AND (gi.itemtype != ? AND gi.itemtype != ?)
553                            AND (gg.rawgrademax != gi.grademax OR gg.rawgrademin != gi.grademin)";
555                 // The course can only have inconsistencies when we restore the user info,
556                 // we do not need to act on existing grades that were not restored as part of this backup.
557                 if ($userinfo && $DB->record_exists_sql($sql, array($courseid, 'course', 'category'))) {
559                     // Display the notice as we do during upgrade.
560                     set_config('show_min_max_grades_changed_' . $courseid, 1);
562                     if ($CFG->grade_minmaxtouse != GRADE_MIN_MAX_FROM_GRADE_GRADE) {
563                         // We need set the setting as their site-wise setting is not GRADE_MIN_MAX_FROM_GRADE_GRADE.
564                         // If they are using the site-wide grade_grade setting, we only want to notice them.
565                         grade_set_setting($courseid, $settingname, GRADE_MIN_MAX_FROM_GRADE_GRADE);
566                     }
567                 }
569             } else {
570                 // This should never happen because from now on minmaxtouse is always saved in backups.
571             }
572         }
573     }
576 /**
577  * Step in charge of restoring the grade history of a course.
578  *
579  * The execution conditions are itendical to {@link restore_gradebook_structure_step} because
580  * we do not want to restore the history if the gradebook and its content has not been
581  * restored. At least for now.
582  */
583 class restore_grade_history_structure_step extends restore_structure_step {
585      protected function execute_condition() {
586         global $CFG, $DB;
588         if ($this->get_courseid() == SITEID) {
589             return false;
590         }
592         // No gradebook info found, don't execute.
593         $fullpath = $this->task->get_taskbasepath();
594         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
595         if (!file_exists($fullpath)) {
596             return false;
597         }
599         // Some module present in backup file isn't available to restore in this site, don't execute.
600         if ($this->task->is_missing_modules()) {
601             return false;
602         }
604         // Some activity has been excluded to be restored, don't execute.
605         if ($this->task->is_excluding_activities()) {
606             return false;
607         }
609         // There should only be one grade category (the 1 associated with the course itself).
610         $category = new stdclass();
611         $category->courseid  = $this->get_courseid();
612         $catcount = $DB->count_records('grade_categories', (array)$category);
613         if ($catcount > 1) {
614             return false;
615         }
617         // Arrived here, execute the step.
618         return true;
619      }
621     protected function define_structure() {
622         $paths = array();
624         // Settings to use.
625         $userinfo = $this->get_setting_value('users');
626         $history = $this->get_setting_value('grade_histories');
628         if ($userinfo && $history) {
629             $paths[] = new restore_path_element('grade_grade',
630                '/grade_history/grade_grades/grade_grade');
631         }
633         return $paths;
634     }
636     protected function process_grade_grade($data) {
637         global $DB;
639         $data = (object)($data);
640         $olduserid = $data->userid;
641         unset($data->id);
643         $data->userid = $this->get_mappingid('user', $data->userid, null);
644         if (!empty($data->userid)) {
645             // Do not apply the date offsets as this is history.
646             $data->itemid = $this->get_mappingid('grade_item', $data->itemid);
647             $data->oldid = $this->get_mappingid('grade_grades', $data->oldid);
648             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
649             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
650             $DB->insert_record('grade_grades_history', $data);
651         } else {
652             $message = "Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'";
653             $this->log($message, backup::LOG_DEBUG);
654         }
655     }
659 /**
660  * decode all the interlinks present in restored content
661  * relying 100% in the restore_decode_processor that handles
662  * both the contents to modify and the rules to be applied
663  */
664 class restore_decode_interlinks extends restore_execution_step {
666     protected function define_execution() {
667         // Get the decoder (from the plan)
668         $decoder = $this->task->get_decoder();
669         restore_decode_processor::register_link_decoders($decoder); // Add decoder contents and rules
670         // And launch it, everything will be processed
671         $decoder->execute();
672     }
675 /**
676  * first, ensure that we have no gaps in section numbers
677  * and then, rebuid the course cache
678  */
679 class restore_rebuild_course_cache extends restore_execution_step {
681     protected function define_execution() {
682         global $DB;
684         // Although there is some sort of auto-recovery of missing sections
685         // present in course/formats... here we check that all the sections
686         // from 0 to MAX(section->section) exist, creating them if necessary
687         $maxsection = $DB->get_field('course_sections', 'MAX(section)', array('course' => $this->get_courseid()));
688         // Iterate over all sections
689         for ($i = 0; $i <= $maxsection; $i++) {
690             // If the section $i doesn't exist, create it
691             if (!$DB->record_exists('course_sections', array('course' => $this->get_courseid(), 'section' => $i))) {
692                 $sectionrec = array(
693                     'course' => $this->get_courseid(),
694                     'section' => $i);
695                 $DB->insert_record('course_sections', $sectionrec); // missing section created
696             }
697         }
699         // Rebuild cache now that all sections are in place
700         rebuild_course_cache($this->get_courseid());
701         cache_helper::purge_by_event('changesincourse');
702         cache_helper::purge_by_event('changesincoursecat');
703     }
706 /**
707  * Review all the tasks having one after_restore method
708  * executing it to perform some final adjustments of information
709  * not available when the task was executed.
710  */
711 class restore_execute_after_restore extends restore_execution_step {
713     protected function define_execution() {
715         // Simply call to the execute_after_restore() method of the task
716         // that always is the restore_final_task
717         $this->task->launch_execute_after_restore();
718     }
722 /**
723  * Review all the (pending) block positions in backup_ids, matching by
724  * contextid, creating positions as needed. This is executed by the
725  * final task, once all the contexts have been created
726  */
727 class restore_review_pending_block_positions extends restore_execution_step {
729     protected function define_execution() {
730         global $DB;
732         // Get all the block_position objects pending to match
733         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
734         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
735         // Process block positions, creating them or accumulating for final step
736         foreach($rs as $posrec) {
737             // Get the complete position object out of the info field.
738             $position = backup_controller_dbops::decode_backup_temp_info($posrec->info);
739             // If position is for one already mapped (known) contextid
740             // process it now, creating the position, else nothing to
741             // do, position finally discarded
742             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
743                 $position->contextid = $newctx->newitemid;
744                 // Create the block position
745                 $DB->insert_record('block_positions', $position);
746             }
747         }
748         $rs->close();
749     }
753 /**
754  * Updates the availability data for course modules and sections.
755  *
756  * Runs after the restore of all course modules, sections, and grade items has
757  * completed. This is necessary in order to update IDs that have changed during
758  * restore.
759  *
760  * @package core_backup
761  * @copyright 2014 The Open University
762  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
763  */
764 class restore_update_availability extends restore_execution_step {
766     protected function define_execution() {
767         global $CFG, $DB;
769         // Note: This code runs even if availability is disabled when restoring.
770         // That will ensure that if you later turn availability on for the site,
771         // there will be no incorrect IDs. (It doesn't take long if the restored
772         // data does not contain any availability information.)
774         // Get modinfo with all data after resetting cache.
775         rebuild_course_cache($this->get_courseid(), true);
776         $modinfo = get_fast_modinfo($this->get_courseid());
778         // Get the date offset for this restore.
779         $dateoffset = $this->apply_date_offset(1) - 1;
781         // Update all sections that were restored.
782         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'course_section');
783         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'newitemid');
784         $sectionsbyid = null;
785         foreach ($rs as $rec) {
786             if (is_null($sectionsbyid)) {
787                 $sectionsbyid = array();
788                 foreach ($modinfo->get_section_info_all() as $section) {
789                     $sectionsbyid[$section->id] = $section;
790                 }
791             }
792             if (!array_key_exists($rec->newitemid, $sectionsbyid)) {
793                 // If the section was not fully restored for some reason
794                 // (e.g. due to an earlier error), skip it.
795                 $this->get_logger()->process('Section not fully restored: id ' .
796                         $rec->newitemid, backup::LOG_WARNING);
797                 continue;
798             }
799             $section = $sectionsbyid[$rec->newitemid];
800             if (!is_null($section->availability)) {
801                 $info = new \core_availability\info_section($section);
802                 $info->update_after_restore($this->get_restoreid(),
803                         $this->get_courseid(), $this->get_logger(), $dateoffset, $this->task);
804             }
805         }
806         $rs->close();
808         // Update all modules that were restored.
809         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'course_module');
810         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'newitemid');
811         foreach ($rs as $rec) {
812             if (!array_key_exists($rec->newitemid, $modinfo->cms)) {
813                 // If the module was not fully restored for some reason
814                 // (e.g. due to an earlier error), skip it.
815                 $this->get_logger()->process('Module not fully restored: id ' .
816                         $rec->newitemid, backup::LOG_WARNING);
817                 continue;
818             }
819             $cm = $modinfo->get_cm($rec->newitemid);
820             if (!is_null($cm->availability)) {
821                 $info = new \core_availability\info_module($cm);
822                 $info->update_after_restore($this->get_restoreid(),
823                         $this->get_courseid(), $this->get_logger(), $dateoffset, $this->task);
824             }
825         }
826         $rs->close();
827     }
831 /**
832  * Process legacy module availability records in backup_ids.
833  *
834  * Matches course modules and grade item id once all them have been already restored.
835  * Only if all matchings are satisfied the availability condition will be created.
836  * At the same time, it is required for the site to have that functionality enabled.
837  *
838  * This step is included only to handle legacy backups (2.6 and before). It does not
839  * do anything for newer backups.
840  *
841  * @copyright 2014 The Open University
842  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
843  */
844 class restore_process_course_modules_availability extends restore_execution_step {
846     protected function define_execution() {
847         global $CFG, $DB;
849         // Site hasn't availability enabled
850         if (empty($CFG->enableavailability)) {
851             return;
852         }
854         // Do both modules and sections.
855         foreach (array('module', 'section') as $table) {
856             // Get all the availability objects to process.
857             $params = array('backupid' => $this->get_restoreid(), 'itemname' => $table . '_availability');
858             $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
859             // Process availabilities, creating them if everything matches ok.
860             foreach ($rs as $availrec) {
861                 $allmatchesok = true;
862                 // Get the complete legacy availability object.
863                 $availability = backup_controller_dbops::decode_backup_temp_info($availrec->info);
865                 // Note: This code used to update IDs, but that is now handled by the
866                 // current code (after restore) instead of this legacy code.
868                 // Get showavailability option.
869                 $thingid = ($table === 'module') ? $availability->coursemoduleid :
870                         $availability->coursesectionid;
871                 $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
872                         $table . '_showavailability', $thingid);
873                 if (!$showrec) {
874                     // Should not happen.
875                     throw new coding_exception('No matching showavailability record');
876                 }
877                 $show = $showrec->info->showavailability;
879                 // The $availability object is now in the format used in the old
880                 // system. Interpret this and convert to new system.
881                 $currentvalue = $DB->get_field('course_' . $table . 's', 'availability',
882                         array('id' => $thingid), MUST_EXIST);
883                 $newvalue = \core_availability\info::add_legacy_availability_condition(
884                         $currentvalue, $availability, $show);
885                 $DB->set_field('course_' . $table . 's', 'availability', $newvalue,
886                         array('id' => $thingid));
887             }
888         }
889         $rs->close();
890     }
894 /*
895  * Execution step that, *conditionally* (if there isn't preloaded information)
896  * will load the inforef files for all the included course/section/activity tasks
897  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
898  */
899 class restore_load_included_inforef_records extends restore_execution_step {
901     protected function define_execution() {
903         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
904             return;
905         }
907         // Get all the included tasks
908         $tasks = restore_dbops::get_included_tasks($this->get_restoreid());
909         $progress = $this->task->get_progress();
910         $progress->start_progress($this->get_name(), count($tasks));
911         foreach ($tasks as $task) {
912             // Load the inforef.xml file if exists
913             $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
914             if (file_exists($inforefpath)) {
915                 // Load each inforef file to temp_ids.
916                 restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $inforefpath, $progress);
917             }
918         }
919         $progress->end_progress();
920     }
923 /*
924  * Execution step that will load all the needed files into backup_files_temp
925  *   - info: contains the whole original object (times, names...)
926  * (all them being original ids as loaded from xml)
927  */
928 class restore_load_included_files extends restore_structure_step {
930     protected function define_structure() {
932         $file = new restore_path_element('file', '/files/file');
934         return array($file);
935     }
937     /**
938      * Process one <file> element from files.xml
939      *
940      * @param array $data the element data
941      */
942     public function process_file($data) {
944         $data = (object)$data; // handy
946         // load it if needed:
947         //   - it it is one of the annotated inforef files (course/section/activity/block)
948         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
949         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
950         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
951         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
952         $iscomponent = ($data->component == 'user' || $data->component == 'group' || $data->component == 'badges' ||
953                         $data->component == 'grouping' || $data->component == 'grade' ||
954                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
955         if ($isfileref || $iscomponent) {
956             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
957         }
958     }
961 /**
962  * Execution step that, *conditionally* (if there isn't preloaded information),
963  * will load all the needed roles to backup_temp_ids. They will be stored with
964  * "role" itemname. Also it will perform one automatic mapping to roles existing
965  * in the target site, based in permissions of the user performing the restore,
966  * archetypes and other bits. At the end, each original role will have its associated
967  * target role or 0 if it's going to be skipped. Note we wrap everything over one
968  * restore_dbops method, as far as the same stuff is going to be also executed
969  * by restore prechecks
970  */
971 class restore_load_and_map_roles extends restore_execution_step {
973     protected function define_execution() {
974         if ($this->task->get_preloaded_information()) { // if info is already preloaded
975             return;
976         }
978         $file = $this->get_basepath() . '/roles.xml';
979         // Load needed toles to temp_ids
980         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
982         // Process roles, mapping/skipping. Any error throws exception
983         // Note we pass controller's info because it can contain role mapping information
984         // about manual mappings performed by UI
985         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);
986     }
989 /**
990  * Execution step that, *conditionally* (if there isn't preloaded information
991  * and users have been selected in settings, will load all the needed users
992  * to backup_temp_ids. They will be stored with "user" itemname and with
993  * their original contextid as paremitemid
994  */
995 class restore_load_included_users extends restore_execution_step {
997     protected function define_execution() {
999         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1000             return;
1001         }
1002         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
1003             return;
1004         }
1005         $file = $this->get_basepath() . '/users.xml';
1006         // Load needed users to temp_ids.
1007         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file, $this->task->get_progress());
1008     }
1011 /**
1012  * Execution step that, *conditionally* (if there isn't preloaded information
1013  * and users have been selected in settings, will process all the needed users
1014  * in order to decide and perform any action with them (create / map / error)
1015  * Note: Any error will cause exception, as far as this is the same processing
1016  * than the one into restore prechecks (that should have stopped process earlier)
1017  */
1018 class restore_process_included_users extends restore_execution_step {
1020     protected function define_execution() {
1022         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1023             return;
1024         }
1025         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
1026             return;
1027         }
1028         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(),
1029                 $this->task->get_userid(), $this->task->is_samesite(), $this->task->get_progress());
1030     }
1033 /**
1034  * Execution step that will create all the needed users as calculated
1035  * by @restore_process_included_users (those having newiteind = 0)
1036  */
1037 class restore_create_included_users extends restore_execution_step {
1039     protected function define_execution() {
1041         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(),
1042                 $this->task->get_userid(), $this->task->get_progress());
1043     }
1046 /**
1047  * Structure step that will create all the needed groups and groupings
1048  * by loading them from the groups.xml file performing the required matches.
1049  * Note group members only will be added if restoring user info
1050  */
1051 class restore_groups_structure_step extends restore_structure_step {
1053     protected function define_structure() {
1055         $paths = array(); // Add paths here
1057         // Do not include group/groupings information if not requested.
1058         $groupinfo = $this->get_setting_value('groups');
1059         if ($groupinfo) {
1060             $paths[] = new restore_path_element('group', '/groups/group');
1061             $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
1062             $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
1063         }
1064         return $paths;
1065     }
1067     // Processing functions go here
1068     public function process_group($data) {
1069         global $DB;
1071         $data = (object)$data; // handy
1072         $data->courseid = $this->get_courseid();
1074         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1075         // another a group in the same course
1076         $context = context_course::instance($data->courseid);
1077         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1078             if (groups_get_group_by_idnumber($data->courseid, $data->idnumber)) {
1079                 unset($data->idnumber);
1080             }
1081         } else {
1082             unset($data->idnumber);
1083         }
1085         $oldid = $data->id;    // need this saved for later
1087         $restorefiles = false; // Only if we end creating the group
1089         // Search if the group already exists (by name & description) in the target course
1090         $description_clause = '';
1091         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
1092         if (!empty($data->description)) {
1093             $description_clause = ' AND ' .
1094                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
1095            $params['description'] = $data->description;
1096         }
1097         if (!$groupdb = $DB->get_record_sql("SELECT *
1098                                                FROM {groups}
1099                                               WHERE courseid = :courseid
1100                                                 AND name = :grname $description_clause", $params)) {
1101             // group doesn't exist, create
1102             $newitemid = $DB->insert_record('groups', $data);
1103             $restorefiles = true; // We'll restore the files
1104         } else {
1105             // group exists, use it
1106             $newitemid = $groupdb->id;
1107         }
1108         // Save the id mapping
1109         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
1110         // Invalidate the course group data cache just in case.
1111         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
1112     }
1114     public function process_grouping($data) {
1115         global $DB;
1117         $data = (object)$data; // handy
1118         $data->courseid = $this->get_courseid();
1120         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1121         // another a grouping in the same course
1122         $context = context_course::instance($data->courseid);
1123         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1124             if (groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) {
1125                 unset($data->idnumber);
1126             }
1127         } else {
1128             unset($data->idnumber);
1129         }
1131         $oldid = $data->id;    // need this saved for later
1132         $restorefiles = false; // Only if we end creating the grouping
1134         // Search if the grouping already exists (by name & description) in the target course
1135         $description_clause = '';
1136         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
1137         if (!empty($data->description)) {
1138             $description_clause = ' AND ' .
1139                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
1140            $params['description'] = $data->description;
1141         }
1142         if (!$groupingdb = $DB->get_record_sql("SELECT *
1143                                                   FROM {groupings}
1144                                                  WHERE courseid = :courseid
1145                                                    AND name = :grname $description_clause", $params)) {
1146             // grouping doesn't exist, create
1147             $newitemid = $DB->insert_record('groupings', $data);
1148             $restorefiles = true; // We'll restore the files
1149         } else {
1150             // grouping exists, use it
1151             $newitemid = $groupingdb->id;
1152         }
1153         // Save the id mapping
1154         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
1155         // Invalidate the course group data cache just in case.
1156         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
1157     }
1159     public function process_grouping_group($data) {
1160         global $CFG;
1162         require_once($CFG->dirroot.'/group/lib.php');
1164         $data = (object)$data;
1165         groups_assign_grouping($this->get_new_parentid('grouping'), $this->get_mappingid('group', $data->groupid), $data->timeadded);
1166     }
1168     protected function after_execute() {
1169         // Add group related files, matching with "group" mappings
1170         $this->add_related_files('group', 'icon', 'group');
1171         $this->add_related_files('group', 'description', 'group');
1172         // Add grouping related files, matching with "grouping" mappings
1173         $this->add_related_files('grouping', 'description', 'grouping');
1174         // Invalidate the course group data.
1175         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($this->get_courseid()));
1176     }
1180 /**
1181  * Structure step that will create all the needed group memberships
1182  * by loading them from the groups.xml file performing the required matches.
1183  */
1184 class restore_groups_members_structure_step extends restore_structure_step {
1186     protected $plugins = null;
1188     protected function define_structure() {
1190         $paths = array(); // Add paths here
1192         if ($this->get_setting_value('groups') && $this->get_setting_value('users')) {
1193             $paths[] = new restore_path_element('group', '/groups/group');
1194             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
1195         }
1197         return $paths;
1198     }
1200     public function process_group($data) {
1201         $data = (object)$data; // handy
1203         // HACK ALERT!
1204         // Not much to do here, this groups mapping should be already done from restore_groups_structure_step.
1205         // Let's fake internal state to make $this->get_new_parentid('group') work.
1207         $this->set_mapping('group', $data->id, $this->get_mappingid('group', $data->id));
1208     }
1210     public function process_member($data) {
1211         global $DB, $CFG;
1212         require_once("$CFG->dirroot/group/lib.php");
1214         // NOTE: Always use groups_add_member() because it triggers events and verifies if user is enrolled.
1216         $data = (object)$data; // handy
1218         // get parent group->id
1219         $data->groupid = $this->get_new_parentid('group');
1221         // map user newitemid and insert if not member already
1222         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
1223             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
1224                 // Check the component, if any, exists.
1225                 if (empty($data->component)) {
1226                     groups_add_member($data->groupid, $data->userid);
1228                 } else if ((strpos($data->component, 'enrol_') === 0)) {
1229                     // Deal with enrolment groups - ignore the component and just find out the instance via new id,
1230                     // it is possible that enrolment was restored using different plugin type.
1231                     if (!isset($this->plugins)) {
1232                         $this->plugins = enrol_get_plugins(true);
1233                     }
1234                     if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1235                         if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1236                             if (isset($this->plugins[$instance->enrol])) {
1237                                 $this->plugins[$instance->enrol]->restore_group_member($instance, $data->groupid, $data->userid);
1238                             }
1239                         }
1240                     }
1242                 } else {
1243                     $dir = core_component::get_component_directory($data->component);
1244                     if ($dir and is_dir($dir)) {
1245                         if (component_callback($data->component, 'restore_group_member', array($this, $data), true)) {
1246                             return;
1247                         }
1248                     }
1249                     // Bad luck, plugin could not restore the data, let's add normal membership.
1250                     groups_add_member($data->groupid, $data->userid);
1251                     $message = "Restore of '$data->component/$data->itemid' group membership is not supported, using standard group membership instead.";
1252                     $this->log($message, backup::LOG_WARNING);
1253                 }
1254             }
1255         }
1256     }
1259 /**
1260  * Structure step that will create all the needed scales
1261  * by loading them from the scales.xml
1262  */
1263 class restore_scales_structure_step extends restore_structure_step {
1265     protected function define_structure() {
1267         $paths = array(); // Add paths here
1268         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
1269         return $paths;
1270     }
1272     protected function process_scale($data) {
1273         global $DB;
1275         $data = (object)$data;
1277         $restorefiles = false; // Only if we end creating the group
1279         $oldid = $data->id;    // need this saved for later
1281         // Look for scale (by 'scale' both in standard (course=0) and current course
1282         // with priority to standard scales (ORDER clause)
1283         // scale is not course unique, use get_record_sql to suppress warning
1284         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
1285         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
1286         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
1287         if (!$scadb = $DB->get_record_sql("SELECT *
1288                                             FROM {scale}
1289                                            WHERE courseid IN (0, :courseid)
1290                                              AND $compare_scale_clause
1291                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
1292             // Remap the user if possible, defaut to user performing the restore if not
1293             $userid = $this->get_mappingid('user', $data->userid);
1294             $data->userid = $userid ? $userid : $this->task->get_userid();
1295             // Remap the course if course scale
1296             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
1297             // If global scale (course=0), check the user has perms to create it
1298             // falling to course scale if not
1299             $systemctx = context_system::instance();
1300             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
1301                 $data->courseid = $this->get_courseid();
1302             }
1303             // scale doesn't exist, create
1304             $newitemid = $DB->insert_record('scale', $data);
1305             $restorefiles = true; // We'll restore the files
1306         } else {
1307             // scale exists, use it
1308             $newitemid = $scadb->id;
1309         }
1310         // Save the id mapping (with files support at system context)
1311         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1312     }
1314     protected function after_execute() {
1315         // Add scales related files, matching with "scale" mappings
1316         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
1317     }
1321 /**
1322  * Structure step that will create all the needed outocomes
1323  * by loading them from the outcomes.xml
1324  */
1325 class restore_outcomes_structure_step extends restore_structure_step {
1327     protected function define_structure() {
1329         $paths = array(); // Add paths here
1330         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
1331         return $paths;
1332     }
1334     protected function process_outcome($data) {
1335         global $DB;
1337         $data = (object)$data;
1339         $restorefiles = false; // Only if we end creating the group
1341         $oldid = $data->id;    // need this saved for later
1343         // Look for outcome (by shortname both in standard (courseid=null) and current course
1344         // with priority to standard outcomes (ORDER clause)
1345         // outcome is not course unique, use get_record_sql to suppress warning
1346         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
1347         if (!$outdb = $DB->get_record_sql('SELECT *
1348                                              FROM {grade_outcomes}
1349                                             WHERE shortname = :shortname
1350                                               AND (courseid = :courseid OR courseid IS NULL)
1351                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
1352             // Remap the user
1353             $userid = $this->get_mappingid('user', $data->usermodified);
1354             $data->usermodified = $userid ? $userid : $this->task->get_userid();
1355             // Remap the scale
1356             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
1357             // Remap the course if course outcome
1358             $data->courseid = $data->courseid ? $this->get_courseid() : null;
1359             // If global outcome (course=null), check the user has perms to create it
1360             // falling to course outcome if not
1361             $systemctx = context_system::instance();
1362             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
1363                 $data->courseid = $this->get_courseid();
1364             }
1365             // outcome doesn't exist, create
1366             $newitemid = $DB->insert_record('grade_outcomes', $data);
1367             $restorefiles = true; // We'll restore the files
1368         } else {
1369             // scale exists, use it
1370             $newitemid = $outdb->id;
1371         }
1372         // Set the corresponding grade_outcomes_courses record
1373         $outcourserec = new stdclass();
1374         $outcourserec->courseid  = $this->get_courseid();
1375         $outcourserec->outcomeid = $newitemid;
1376         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
1377             $DB->insert_record('grade_outcomes_courses', $outcourserec);
1378         }
1379         // Save the id mapping (with files support at system context)
1380         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1381     }
1383     protected function after_execute() {
1384         // Add outcomes related files, matching with "outcome" mappings
1385         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
1386     }
1389 /**
1390  * Execution step that, *conditionally* (if there isn't preloaded information
1391  * will load all the question categories and questions (header info only)
1392  * to backup_temp_ids. They will be stored with "question_category" and
1393  * "question" itemnames and with their original contextid and question category
1394  * id as paremitemids
1395  */
1396 class restore_load_categories_and_questions extends restore_execution_step {
1398     protected function define_execution() {
1400         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1401             return;
1402         }
1403         $file = $this->get_basepath() . '/questions.xml';
1404         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
1405     }
1408 /**
1409  * Execution step that, *conditionally* (if there isn't preloaded information)
1410  * will process all the needed categories and questions
1411  * in order to decide and perform any action with them (create / map / error)
1412  * Note: Any error will cause exception, as far as this is the same processing
1413  * than the one into restore prechecks (that should have stopped process earlier)
1414  */
1415 class restore_process_categories_and_questions extends restore_execution_step {
1417     protected function define_execution() {
1419         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1420             return;
1421         }
1422         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
1423     }
1426 /**
1427  * Structure step that will read the section.xml creating/updating sections
1428  * as needed, rebuilding course cache and other friends
1429  */
1430 class restore_section_structure_step extends restore_structure_step {
1431     /** @var array Cache: Array of id => course format */
1432     private static $courseformats = array();
1434     /**
1435      * Resets a static cache of course formats. Required for unit testing.
1436      */
1437     public static function reset_caches() {
1438         self::$courseformats = array();
1439     }
1441     protected function define_structure() {
1442         global $CFG;
1444         $paths = array();
1446         $section = new restore_path_element('section', '/section');
1447         $paths[] = $section;
1448         if ($CFG->enableavailability) {
1449             $paths[] = new restore_path_element('availability', '/section/availability');
1450             $paths[] = new restore_path_element('availability_field', '/section/availability_field');
1451         }
1452         $paths[] = new restore_path_element('course_format_options', '/section/course_format_options');
1454         // Apply for 'format' plugins optional paths at section level
1455         $this->add_plugin_structure('format', $section);
1457         // Apply for 'local' plugins optional paths at section level
1458         $this->add_plugin_structure('local', $section);
1460         return $paths;
1461     }
1463     public function process_section($data) {
1464         global $CFG, $DB;
1465         $data = (object)$data;
1466         $oldid = $data->id; // We'll need this later
1468         $restorefiles = false;
1470         // Look for the section
1471         $section = new stdclass();
1472         $section->course  = $this->get_courseid();
1473         $section->section = $data->number;
1474         // Section doesn't exist, create it with all the info from backup
1475         if (!$secrec = $DB->get_record('course_sections', (array)$section)) {
1476             $section->name = $data->name;
1477             $section->summary = $data->summary;
1478             $section->summaryformat = $data->summaryformat;
1479             $section->sequence = '';
1480             $section->visible = $data->visible;
1481             if (empty($CFG->enableavailability)) { // Process availability information only if enabled.
1482                 $section->availability = null;
1483             } else {
1484                 $section->availability = isset($data->availabilityjson) ? $data->availabilityjson : null;
1485                 // Include legacy [<2.7] availability data if provided.
1486                 if (is_null($section->availability)) {
1487                     $section->availability = \core_availability\info::convert_legacy_fields(
1488                             $data, true);
1489                 }
1490             }
1491             $newitemid = $DB->insert_record('course_sections', $section);
1492             $restorefiles = true;
1494         // Section exists, update non-empty information
1495         } else {
1496             $section->id = $secrec->id;
1497             if ((string)$secrec->name === '') {
1498                 $section->name = $data->name;
1499             }
1500             if (empty($secrec->summary)) {
1501                 $section->summary = $data->summary;
1502                 $section->summaryformat = $data->summaryformat;
1503                 $restorefiles = true;
1504             }
1506             // Don't update availability (I didn't see a useful way to define
1507             // whether existing or new one should take precedence).
1509             $DB->update_record('course_sections', $section);
1510             $newitemid = $secrec->id;
1511         }
1513         // Annotate the section mapping, with restorefiles option if needed
1514         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
1516         // set the new course_section id in the task
1517         $this->task->set_sectionid($newitemid);
1519         // If there is the legacy showavailability data, store this for later use.
1520         // (This data is not present when restoring 'new' backups.)
1521         if (isset($data->showavailability)) {
1522             // Cache the showavailability flag using the backup_ids data field.
1523             restore_dbops::set_backup_ids_record($this->get_restoreid(),
1524                     'section_showavailability', $newitemid, 0, null,
1525                     (object)array('showavailability' => $data->showavailability));
1526         }
1528         // Commented out. We never modify course->numsections as far as that is used
1529         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
1530         // Note: We keep the code here, to know about and because of the possibility of making this
1531         // optional based on some setting/attribute in the future
1532         // If needed, adjust course->numsections
1533         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
1534         //    if ($numsections < $section->section) {
1535         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
1536         //    }
1537         //}
1538     }
1540     /**
1541      * Process the legacy availability table record. This table does not exist
1542      * in Moodle 2.7+ but we still support restore.
1543      *
1544      * @param stdClass $data Record data
1545      */
1546     public function process_availability($data) {
1547         $data = (object)$data;
1548         // Simply going to store the whole availability record now, we'll process
1549         // all them later in the final task (once all activities have been restored)
1550         // Let's call the low level one to be able to store the whole object.
1551         $data->coursesectionid = $this->task->get_sectionid();
1552         restore_dbops::set_backup_ids_record($this->get_restoreid(),
1553                 'section_availability', $data->id, 0, null, $data);
1554     }
1556     /**
1557      * Process the legacy availability fields table record. This table does not
1558      * exist in Moodle 2.7+ but we still support restore.
1559      *
1560      * @param stdClass $data Record data
1561      */
1562     public function process_availability_field($data) {
1563         global $DB;
1564         $data = (object)$data;
1565         // Mark it is as passed by default
1566         $passed = true;
1567         $customfieldid = null;
1569         // If a customfield has been used in order to pass we must be able to match an existing
1570         // customfield by name (data->customfield) and type (data->customfieldtype)
1571         if (is_null($data->customfield) xor is_null($data->customfieldtype)) {
1572             // xor is sort of uncommon. If either customfield is null or customfieldtype is null BUT not both.
1573             // If one is null but the other isn't something clearly went wrong and we'll skip this condition.
1574             $passed = false;
1575         } else if (!is_null($data->customfield)) {
1576             $params = array('shortname' => $data->customfield, 'datatype' => $data->customfieldtype);
1577             $customfieldid = $DB->get_field('user_info_field', 'id', $params);
1578             $passed = ($customfieldid !== false);
1579         }
1581         if ($passed) {
1582             // Create the object to insert into the database
1583             $availfield = new stdClass();
1584             $availfield->coursesectionid = $this->task->get_sectionid();
1585             $availfield->userfield = $data->userfield;
1586             $availfield->customfieldid = $customfieldid;
1587             $availfield->operator = $data->operator;
1588             $availfield->value = $data->value;
1590             // Get showavailability option.
1591             $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
1592                     'section_showavailability', $availfield->coursesectionid);
1593             if (!$showrec) {
1594                 // Should not happen.
1595                 throw new coding_exception('No matching showavailability record');
1596             }
1597             $show = $showrec->info->showavailability;
1599             // The $availfield object is now in the format used in the old
1600             // system. Interpret this and convert to new system.
1601             $currentvalue = $DB->get_field('course_sections', 'availability',
1602                     array('id' => $availfield->coursesectionid), MUST_EXIST);
1603             $newvalue = \core_availability\info::add_legacy_availability_field_condition(
1604                     $currentvalue, $availfield, $show);
1605             $DB->set_field('course_sections', 'availability', $newvalue,
1606                     array('id' => $availfield->coursesectionid));
1607         }
1608     }
1610     public function process_course_format_options($data) {
1611         global $DB;
1612         $courseid = $this->get_courseid();
1613         if (!array_key_exists($courseid, self::$courseformats)) {
1614             // It is safe to have a static cache of course formats because format can not be changed after this point.
1615             self::$courseformats[$courseid] = $DB->get_field('course', 'format', array('id' => $courseid));
1616         }
1617         $data = (array)$data;
1618         if (self::$courseformats[$courseid] === $data['format']) {
1619             // Import section format options only if both courses (the one that was backed up
1620             // and the one we are restoring into) have same formats.
1621             $params = array(
1622                 'courseid' => $this->get_courseid(),
1623                 'sectionid' => $this->task->get_sectionid(),
1624                 'format' => $data['format'],
1625                 'name' => $data['name']
1626             );
1627             if ($record = $DB->get_record('course_format_options', $params, 'id, value')) {
1628                 // Do not overwrite existing information.
1629                 $newid = $record->id;
1630             } else {
1631                 $params['value'] = $data['value'];
1632                 $newid = $DB->insert_record('course_format_options', $params);
1633             }
1634             $this->set_mapping('course_format_options', $data['id'], $newid);
1635         }
1636     }
1638     protected function after_execute() {
1639         // Add section related files, with 'course_section' itemid to match
1640         $this->add_related_files('course', 'section', 'course_section');
1641     }
1644 /**
1645  * Structure step that will read the course.xml file, loading it and performing
1646  * various actions depending of the site/restore settings. Note that target
1647  * course always exist before arriving here so this step will be updating
1648  * the course record (never inserting)
1649  */
1650 class restore_course_structure_step extends restore_structure_step {
1651     /**
1652      * @var bool this gets set to true by {@link process_course()} if we are
1653      * restoring an old coures that used the legacy 'module security' feature.
1654      * If so, we have to do more work in {@link after_execute()}.
1655      */
1656     protected $legacyrestrictmodules = false;
1658     /**
1659      * @var array Used when {@link $legacyrestrictmodules} is true. This is an
1660      * array with array keys the module names ('forum', 'quiz', etc.). These are
1661      * the modules that are allowed according to the data in the backup file.
1662      * In {@link after_execute()} we then have to prevent adding of all the other
1663      * types of activity.
1664      */
1665     protected $legacyallowedmodules = array();
1667     protected function define_structure() {
1669         $course = new restore_path_element('course', '/course');
1670         $category = new restore_path_element('category', '/course/category');
1671         $tag = new restore_path_element('tag', '/course/tags/tag');
1672         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1674         // Apply for 'format' plugins optional paths at course level
1675         $this->add_plugin_structure('format', $course);
1677         // Apply for 'theme' plugins optional paths at course level
1678         $this->add_plugin_structure('theme', $course);
1680         // Apply for 'report' plugins optional paths at course level
1681         $this->add_plugin_structure('report', $course);
1683         // Apply for 'course report' plugins optional paths at course level
1684         $this->add_plugin_structure('coursereport', $course);
1686         // Apply for plagiarism plugins optional paths at course level
1687         $this->add_plugin_structure('plagiarism', $course);
1689         // Apply for local plugins optional paths at course level
1690         $this->add_plugin_structure('local', $course);
1692         return array($course, $category, $tag, $allowed_module);
1693     }
1695     /**
1696      * Processing functions go here
1697      *
1698      * @global moodledatabase $DB
1699      * @param stdClass $data
1700      */
1701     public function process_course($data) {
1702         global $CFG, $DB;
1704         $data = (object)$data;
1706         $fullname  = $this->get_setting_value('course_fullname');
1707         $shortname = $this->get_setting_value('course_shortname');
1708         $startdate = $this->get_setting_value('course_startdate');
1710         // Calculate final course names, to avoid dupes
1711         list($fullname, $shortname) = restore_dbops::calculate_course_names($this->get_courseid(), $fullname, $shortname);
1713         // Need to change some fields before updating the course record
1714         $data->id = $this->get_courseid();
1715         $data->fullname = $fullname;
1716         $data->shortname= $shortname;
1718         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1719         // another course on this site.
1720         $context = context::instance_by_id($this->task->get_contextid());
1721         if (!empty($data->idnumber) && has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid()) &&
1722                 $this->task->is_samesite() && !$DB->record_exists('course', array('idnumber' => $data->idnumber))) {
1723             // Do not reset idnumber.
1724         } else {
1725             $data->idnumber = '';
1726         }
1728         // Any empty value for course->hiddensections will lead to 0 (default, show collapsed).
1729         // It has been reported that some old 1.9 courses may have it null leading to DB error. MDL-31532
1730         if (empty($data->hiddensections)) {
1731             $data->hiddensections = 0;
1732         }
1734         // Set legacyrestrictmodules to true if the course was resticting modules. If so
1735         // then we will need to process restricted modules after execution.
1736         $this->legacyrestrictmodules = !empty($data->restrictmodules);
1738         $data->startdate= $this->apply_date_offset($data->startdate);
1739         if ($data->defaultgroupingid) {
1740             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1741         }
1742         if (empty($CFG->enablecompletion)) {
1743             $data->enablecompletion = 0;
1744             $data->completionstartonenrol = 0;
1745             $data->completionnotify = 0;
1746         }
1747         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1748         if (!array_key_exists($data->lang, $languages)) {
1749             $data->lang = '';
1750         }
1752         $themes = get_list_of_themes(); // Get themes for quick search later
1753         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1754             $data->theme = '';
1755         }
1757         // Check if this is an old SCORM course format.
1758         if ($data->format == 'scorm') {
1759             $data->format = 'singleactivity';
1760             $data->activitytype = 'scorm';
1761         }
1763         // Course record ready, update it
1764         $DB->update_record('course', $data);
1766         course_get_format($data)->update_course_format_options($data);
1768         // Role name aliases
1769         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1770     }
1772     public function process_category($data) {
1773         // Nothing to do with the category. UI sets it before restore starts
1774     }
1776     public function process_tag($data) {
1777         global $CFG, $DB;
1779         $data = (object)$data;
1781         core_tag_tag::add_item_tag('core', 'course', $this->get_courseid(),
1782                 context_course::instance($this->get_courseid()), $data->rawname);
1783     }
1785     public function process_allowed_module($data) {
1786         $data = (object)$data;
1788         // Backwards compatiblity support for the data that used to be in the
1789         // course_allowed_modules table.
1790         if ($this->legacyrestrictmodules) {
1791             $this->legacyallowedmodules[$data->modulename] = 1;
1792         }
1793     }
1795     protected function after_execute() {
1796         global $DB;
1798         // Add course related files, without itemid to match
1799         $this->add_related_files('course', 'summary', null);
1800         $this->add_related_files('course', 'overviewfiles', null);
1802         // Deal with legacy allowed modules.
1803         if ($this->legacyrestrictmodules) {
1804             $context = context_course::instance($this->get_courseid());
1806             list($roleids) = get_roles_with_cap_in_context($context, 'moodle/course:manageactivities');
1807             list($managerroleids) = get_roles_with_cap_in_context($context, 'moodle/site:config');
1808             foreach ($managerroleids as $roleid) {
1809                 unset($roleids[$roleid]);
1810             }
1812             foreach (core_component::get_plugin_list('mod') as $modname => $notused) {
1813                 if (isset($this->legacyallowedmodules[$modname])) {
1814                     // Module is allowed, no worries.
1815                     continue;
1816                 }
1818                 $capability = 'mod/' . $modname . ':addinstance';
1819                 foreach ($roleids as $roleid) {
1820                     assign_capability($capability, CAP_PREVENT, $roleid, $context);
1821                 }
1822             }
1823         }
1824     }
1827 /**
1828  * Execution step that will migrate legacy files if present.
1829  */
1830 class restore_course_legacy_files_step extends restore_execution_step {
1831     public function define_execution() {
1832         global $DB;
1834         // Do a check for legacy files and skip if there are none.
1835         $sql = 'SELECT count(*)
1836                   FROM {backup_files_temp}
1837                  WHERE backupid = ?
1838                    AND contextid = ?
1839                    AND component = ?
1840                    AND filearea  = ?';
1841         $params = array($this->get_restoreid(), $this->task->get_old_contextid(), 'course', 'legacy');
1843         if ($DB->count_records_sql($sql, $params)) {
1844             $DB->set_field('course', 'legacyfiles', 2, array('id' => $this->get_courseid()));
1845             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'course',
1846                 'legacy', $this->task->get_old_contextid(), $this->task->get_userid());
1847         }
1848     }
1851 /*
1852  * Structure step that will read the roles.xml file (at course/activity/block levels)
1853  * containing all the role_assignments and overrides for that context. If corresponding to
1854  * one mapped role, they will be applied to target context. Will observe the role_assignments
1855  * setting to decide if ras are restored.
1856  *
1857  * Note: this needs to be executed after all users are enrolled.
1858  */
1859 class restore_ras_and_caps_structure_step extends restore_structure_step {
1860     protected $plugins = null;
1862     protected function define_structure() {
1864         $paths = array();
1866         // Observe the role_assignments setting
1867         if ($this->get_setting_value('role_assignments')) {
1868             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
1869         }
1870         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
1872         return $paths;
1873     }
1875     /**
1876      * Assign roles
1877      *
1878      * This has to be called after enrolments processing.
1879      *
1880      * @param mixed $data
1881      * @return void
1882      */
1883     public function process_assignment($data) {
1884         global $DB;
1886         $data = (object)$data;
1888         // Check roleid, userid are one of the mapped ones
1889         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
1890             return;
1891         }
1892         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
1893             return;
1894         }
1895         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
1896             // Only assign roles to not deleted users
1897             return;
1898         }
1899         if (!$contextid = $this->task->get_contextid()) {
1900             return;
1901         }
1903         if (empty($data->component)) {
1904             // assign standard manual roles
1905             // TODO: role_assign() needs one userid param to be able to specify our restore userid
1906             role_assign($newroleid, $newuserid, $contextid);
1908         } else if ((strpos($data->component, 'enrol_') === 0)) {
1909             // Deal with enrolment roles - ignore the component and just find out the instance via new id,
1910             // it is possible that enrolment was restored using different plugin type.
1911             if (!isset($this->plugins)) {
1912                 $this->plugins = enrol_get_plugins(true);
1913             }
1914             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1915                 if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1916                     if (isset($this->plugins[$instance->enrol])) {
1917                         $this->plugins[$instance->enrol]->restore_role_assignment($instance, $newroleid, $newuserid, $contextid);
1918                     }
1919                 }
1920             }
1922         } else {
1923             $data->roleid    = $newroleid;
1924             $data->userid    = $newuserid;
1925             $data->contextid = $contextid;
1926             $dir = core_component::get_component_directory($data->component);
1927             if ($dir and is_dir($dir)) {
1928                 if (component_callback($data->component, 'restore_role_assignment', array($this, $data), true)) {
1929                     return;
1930                 }
1931             }
1932             // Bad luck, plugin could not restore the data, let's add normal membership.
1933             role_assign($data->roleid, $data->userid, $data->contextid);
1934             $message = "Restore of '$data->component/$data->itemid' role assignments is not supported, using manual role assignments instead.";
1935             $this->log($message, backup::LOG_WARNING);
1936         }
1937     }
1939     public function process_override($data) {
1940         $data = (object)$data;
1942         // Check roleid is one of the mapped ones
1943         $newroleid = $this->get_mappingid('role', $data->roleid);
1944         // If newroleid and context are valid assign it via API (it handles dupes and so on)
1945         if ($newroleid && $this->task->get_contextid()) {
1946             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
1947             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
1948             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
1949         }
1950     }
1953 /**
1954  * If no instances yet add default enrol methods the same way as when creating new course in UI.
1955  */
1956 class restore_default_enrolments_step extends restore_execution_step {
1958     public function define_execution() {
1959         global $DB;
1961         // No enrolments in front page.
1962         if ($this->get_courseid() == SITEID) {
1963             return;
1964         }
1966         $course = $DB->get_record('course', array('id'=>$this->get_courseid()), '*', MUST_EXIST);
1968         if ($DB->record_exists('enrol', array('courseid'=>$this->get_courseid(), 'enrol'=>'manual'))) {
1969             // Something already added instances, do not add default instances.
1970             $plugins = enrol_get_plugins(true);
1971             foreach ($plugins as $plugin) {
1972                 $plugin->restore_sync_course($course);
1973             }
1975         } else {
1976             // Looks like a newly created course.
1977             enrol_course_updated(true, $course, null);
1978         }
1979     }
1982 /**
1983  * This structure steps restores the enrol plugins and their underlying
1984  * enrolments, performing all the mappings and/or movements required
1985  */
1986 class restore_enrolments_structure_step extends restore_structure_step {
1987     protected $enrolsynced = false;
1988     protected $plugins = null;
1989     protected $originalstatus = array();
1991     /**
1992      * Conditionally decide if this step should be executed.
1993      *
1994      * This function checks the following parameter:
1995      *
1996      *   1. the course/enrolments.xml file exists
1997      *
1998      * @return bool true is safe to execute, false otherwise
1999      */
2000     protected function execute_condition() {
2002         if ($this->get_courseid() == SITEID) {
2003             return false;
2004         }
2006         // Check it is included in the backup
2007         $fullpath = $this->task->get_taskbasepath();
2008         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2009         if (!file_exists($fullpath)) {
2010             // Not found, can't restore enrolments info
2011             return false;
2012         }
2014         return true;
2015     }
2017     protected function define_structure() {
2019         $enrol = new restore_path_element('enrol', '/enrolments/enrols/enrol');
2020         $enrolment = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
2021         // Attach local plugin stucture to enrol element.
2022         $this->add_plugin_structure('enrol', $enrol);
2024         return array($enrol, $enrolment);
2025     }
2027     /**
2028      * Create enrolment instances.
2029      *
2030      * This has to be called after creation of roles
2031      * and before adding of role assignments.
2032      *
2033      * @param mixed $data
2034      * @return void
2035      */
2036     public function process_enrol($data) {
2037         global $DB;
2039         $data = (object)$data;
2040         $oldid = $data->id; // We'll need this later.
2041         unset($data->id);
2043         $this->originalstatus[$oldid] = $data->status;
2045         if (!$courserec = $DB->get_record('course', array('id' => $this->get_courseid()))) {
2046             $this->set_mapping('enrol', $oldid, 0);
2047             return;
2048         }
2050         if (!isset($this->plugins)) {
2051             $this->plugins = enrol_get_plugins(true);
2052         }
2054         if (!$this->enrolsynced) {
2055             // Make sure that all plugin may create instances and enrolments automatically
2056             // before the first instance restore - this is suitable especially for plugins
2057             // that synchronise data automatically using course->idnumber or by course categories.
2058             foreach ($this->plugins as $plugin) {
2059                 $plugin->restore_sync_course($courserec);
2060             }
2061             $this->enrolsynced = true;
2062         }
2064         // Map standard fields - plugin has to process custom fields manually.
2065         $data->roleid   = $this->get_mappingid('role', $data->roleid);
2066         $data->courseid = $courserec->id;
2068         if ($this->get_setting_value('enrol_migratetomanual')) {
2069             unset($data->sortorder); // Remove useless sortorder from <2.4 backups.
2070             if (!enrol_is_enabled('manual')) {
2071                 $this->set_mapping('enrol', $oldid, 0);
2072                 return;
2073             }
2074             if ($instances = $DB->get_records('enrol', array('courseid'=>$data->courseid, 'enrol'=>'manual'), 'id')) {
2075                 $instance = reset($instances);
2076                 $this->set_mapping('enrol', $oldid, $instance->id);
2077             } else {
2078                 if ($data->enrol === 'manual') {
2079                     $instanceid = $this->plugins['manual']->add_instance($courserec, (array)$data);
2080                 } else {
2081                     $instanceid = $this->plugins['manual']->add_default_instance($courserec);
2082                 }
2083                 $this->set_mapping('enrol', $oldid, $instanceid);
2084             }
2086         } else {
2087             if (!enrol_is_enabled($data->enrol) or !isset($this->plugins[$data->enrol])) {
2088                 $this->set_mapping('enrol', $oldid, 0);
2089                 $message = "Enrol plugin '$data->enrol' data can not be restored because it is not enabled, use migration to manual enrolments";
2090                 $this->log($message, backup::LOG_WARNING);
2091                 return;
2092             }
2093             if ($task = $this->get_task() and $task->get_target() == backup::TARGET_NEW_COURSE) {
2094                 // Let's keep the sortorder in old backups.
2095             } else {
2096                 // Prevent problems with colliding sortorders in old backups,
2097                 // new 2.4 backups do not need sortorder because xml elements are ordered properly.
2098                 unset($data->sortorder);
2099             }
2100             // Note: plugin is responsible for setting up the mapping, it may also decide to migrate to different type.
2101             $this->plugins[$data->enrol]->restore_instance($this, $data, $courserec, $oldid);
2102         }
2103     }
2105     /**
2106      * Create user enrolments.
2107      *
2108      * This has to be called after creation of enrolment instances
2109      * and before adding of role assignments.
2110      *
2111      * Roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing afterwards.
2112      *
2113      * @param mixed $data
2114      * @return void
2115      */
2116     public function process_enrolment($data) {
2117         global $DB;
2119         if (!isset($this->plugins)) {
2120             $this->plugins = enrol_get_plugins(true);
2121         }
2123         $data = (object)$data;
2125         // Process only if parent instance have been mapped.
2126         if ($enrolid = $this->get_new_parentid('enrol')) {
2127             $oldinstancestatus = ENROL_INSTANCE_ENABLED;
2128             $oldenrolid = $this->get_old_parentid('enrol');
2129             if (isset($this->originalstatus[$oldenrolid])) {
2130                 $oldinstancestatus = $this->originalstatus[$oldenrolid];
2131             }
2132             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
2133                 // And only if user is a mapped one.
2134                 if ($userid = $this->get_mappingid('user', $data->userid)) {
2135                     if (isset($this->plugins[$instance->enrol])) {
2136                         $this->plugins[$instance->enrol]->restore_user_enrolment($this, $data, $instance, $userid, $oldinstancestatus);
2137                     }
2138                 }
2139             }
2140         }
2141     }
2145 /**
2146  * Make sure the user restoring the course can actually access it.
2147  */
2148 class restore_fix_restorer_access_step extends restore_execution_step {
2149     protected function define_execution() {
2150         global $CFG, $DB;
2152         if (!$userid = $this->task->get_userid()) {
2153             return;
2154         }
2156         if (empty($CFG->restorernewroleid)) {
2157             // Bad luck, no fallback role for restorers specified
2158             return;
2159         }
2161         $courseid = $this->get_courseid();
2162         $context = context_course::instance($courseid);
2164         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
2165             // Current user may access the course (admin, category manager or restored teacher enrolment usually)
2166             return;
2167         }
2169         // Try to add role only - we do not need enrolment if user has moodle/course:view or is already enrolled
2170         role_assign($CFG->restorernewroleid, $userid, $context);
2172         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
2173             // Extra role is enough, yay!
2174             return;
2175         }
2177         // The last chance is to create manual enrol if it does not exist and and try to enrol the current user,
2178         // hopefully admin selected suitable $CFG->restorernewroleid ...
2179         if (!enrol_is_enabled('manual')) {
2180             return;
2181         }
2182         if (!$enrol = enrol_get_plugin('manual')) {
2183             return;
2184         }
2185         if (!$DB->record_exists('enrol', array('enrol'=>'manual', 'courseid'=>$courseid))) {
2186             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
2187             $fields = array('status'=>ENROL_INSTANCE_ENABLED, 'enrolperiod'=>$enrol->get_config('enrolperiod', 0), 'roleid'=>$enrol->get_config('roleid', 0));
2188             $enrol->add_instance($course, $fields);
2189         }
2191         enrol_try_internal_enrol($courseid, $userid);
2192     }
2196 /**
2197  * This structure steps restores the filters and their configs
2198  */
2199 class restore_filters_structure_step extends restore_structure_step {
2201     protected function define_structure() {
2203         $paths = array();
2205         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
2206         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
2208         return $paths;
2209     }
2211     public function process_active($data) {
2213         $data = (object)$data;
2215         if (strpos($data->filter, 'filter/') === 0) {
2216             $data->filter = substr($data->filter, 7);
2218         } else if (strpos($data->filter, '/') !== false) {
2219             // Unsupported old filter.
2220             return;
2221         }
2223         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
2224             return;
2225         }
2226         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
2227     }
2229     public function process_config($data) {
2231         $data = (object)$data;
2233         if (strpos($data->filter, 'filter/') === 0) {
2234             $data->filter = substr($data->filter, 7);
2236         } else if (strpos($data->filter, '/') !== false) {
2237             // Unsupported old filter.
2238             return;
2239         }
2241         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
2242             return;
2243         }
2244         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
2245     }
2249 /**
2250  * This structure steps restores the comments
2251  * Note: Cannot use the comments API because defaults to USER->id.
2252  * That should change allowing to pass $userid
2253  */
2254 class restore_comments_structure_step extends restore_structure_step {
2256     protected function define_structure() {
2258         $paths = array();
2260         $paths[] = new restore_path_element('comment', '/comments/comment');
2262         return $paths;
2263     }
2265     public function process_comment($data) {
2266         global $DB;
2268         $data = (object)$data;
2270         // First of all, if the comment has some itemid, ask to the task what to map
2271         $mapping = false;
2272         if ($data->itemid) {
2273             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
2274             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
2275         }
2276         // Only restore the comment if has no mapping OR we have found the matching mapping
2277         if (!$mapping || $data->itemid) {
2278             // Only if user mapping and context
2279             $data->userid = $this->get_mappingid('user', $data->userid);
2280             if ($data->userid && $this->task->get_contextid()) {
2281                 $data->contextid = $this->task->get_contextid();
2282                 // Only if there is another comment with same context/user/timecreated
2283                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
2284                 if (!$DB->record_exists('comments', $params)) {
2285                     $DB->insert_record('comments', $data);
2286                 }
2287             }
2288         }
2289     }
2292 /**
2293  * This structure steps restores the badges and their configs
2294  */
2295 class restore_badges_structure_step extends restore_structure_step {
2297     /**
2298      * Conditionally decide if this step should be executed.
2299      *
2300      * This function checks the following parameters:
2301      *
2302      *   1. Badges and course badges are enabled on the site.
2303      *   2. The course/badges.xml file exists.
2304      *   3. All modules are restorable.
2305      *   4. All modules are marked for restore.
2306      *
2307      * @return bool True is safe to execute, false otherwise
2308      */
2309     protected function execute_condition() {
2310         global $CFG;
2312         // First check is badges and course level badges are enabled on this site.
2313         if (empty($CFG->enablebadges) || empty($CFG->badges_allowcoursebadges)) {
2314             // Disabled, don't restore course badges.
2315             return false;
2316         }
2318         // Check if badges.xml is included in the backup.
2319         $fullpath = $this->task->get_taskbasepath();
2320         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2321         if (!file_exists($fullpath)) {
2322             // Not found, can't restore course badges.
2323             return false;
2324         }
2326         // Check we are able to restore all backed up modules.
2327         if ($this->task->is_missing_modules()) {
2328             return false;
2329         }
2331         // Finally check all modules within the backup are being restored.
2332         if ($this->task->is_excluding_activities()) {
2333             return false;
2334         }
2336         return true;
2337     }
2339     protected function define_structure() {
2340         $paths = array();
2341         $paths[] = new restore_path_element('badge', '/badges/badge');
2342         $paths[] = new restore_path_element('criterion', '/badges/badge/criteria/criterion');
2343         $paths[] = new restore_path_element('parameter', '/badges/badge/criteria/criterion/parameters/parameter');
2344         $paths[] = new restore_path_element('manual_award', '/badges/badge/manual_awards/manual_award');
2346         return $paths;
2347     }
2349     public function process_badge($data) {
2350         global $DB, $CFG;
2352         require_once($CFG->libdir . '/badgeslib.php');
2354         $data = (object)$data;
2355         $data->usercreated = $this->get_mappingid('user', $data->usercreated);
2356         if (empty($data->usercreated)) {
2357             $data->usercreated = $this->task->get_userid();
2358         }
2359         $data->usermodified = $this->get_mappingid('user', $data->usermodified);
2360         if (empty($data->usermodified)) {
2361             $data->usermodified = $this->task->get_userid();
2362         }
2364         // We'll restore the badge image.
2365         $restorefiles = true;
2367         $courseid = $this->get_courseid();
2369         $params = array(
2370                 'name'           => $data->name,
2371                 'description'    => $data->description,
2372                 'timecreated'    => $this->apply_date_offset($data->timecreated),
2373                 'timemodified'   => $this->apply_date_offset($data->timemodified),
2374                 'usercreated'    => $data->usercreated,
2375                 'usermodified'   => $data->usermodified,
2376                 'issuername'     => $data->issuername,
2377                 'issuerurl'      => $data->issuerurl,
2378                 'issuercontact'  => $data->issuercontact,
2379                 'expiredate'     => $this->apply_date_offset($data->expiredate),
2380                 'expireperiod'   => $data->expireperiod,
2381                 'type'           => BADGE_TYPE_COURSE,
2382                 'courseid'       => $courseid,
2383                 'message'        => $data->message,
2384                 'messagesubject' => $data->messagesubject,
2385                 'attachment'     => $data->attachment,
2386                 'notification'   => $data->notification,
2387                 'status'         => BADGE_STATUS_INACTIVE,
2388                 'nextcron'       => $this->apply_date_offset($data->nextcron)
2389         );
2391         $newid = $DB->insert_record('badge', $params);
2392         $this->set_mapping('badge', $data->id, $newid, $restorefiles);
2393     }
2395     public function process_criterion($data) {
2396         global $DB;
2398         $data = (object)$data;
2400         $params = array(
2401                 'badgeid'           => $this->get_new_parentid('badge'),
2402                 'criteriatype'      => $data->criteriatype,
2403                 'method'            => $data->method,
2404                 'description'       => isset($data->description) ? $data->description : '',
2405                 'descriptionformat' => isset($data->descriptionformat) ? $data->descriptionformat : 0,
2406         );
2407         $newid = $DB->insert_record('badge_criteria', $params);
2408         $this->set_mapping('criterion', $data->id, $newid);
2409     }
2411     public function process_parameter($data) {
2412         global $DB, $CFG;
2414         require_once($CFG->libdir . '/badgeslib.php');
2416         $data = (object)$data;
2417         $criteriaid = $this->get_new_parentid('criterion');
2419         // Parameter array that will go to database.
2420         $params = array();
2421         $params['critid'] = $criteriaid;
2423         $oldparam = explode('_', $data->name);
2425         if ($data->criteriatype == BADGE_CRITERIA_TYPE_ACTIVITY) {
2426             $module = $this->get_mappingid('course_module', $oldparam[1]);
2427             $params['name'] = $oldparam[0] . '_' . $module;
2428             $params['value'] = $oldparam[0] == 'module' ? $module : $data->value;
2429         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_COURSE) {
2430             $params['name'] = $oldparam[0] . '_' . $this->get_courseid();
2431             $params['value'] = $oldparam[0] == 'course' ? $this->get_courseid() : $data->value;
2432         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_MANUAL) {
2433             $role = $this->get_mappingid('role', $data->value);
2434             if (!empty($role)) {
2435                 $params['name'] = 'role_' . $role;
2436                 $params['value'] = $role;
2437             } else {
2438                 return;
2439             }
2440         }
2442         if (!$DB->record_exists('badge_criteria_param', $params)) {
2443             $DB->insert_record('badge_criteria_param', $params);
2444         }
2445     }
2447     public function process_manual_award($data) {
2448         global $DB;
2450         $data = (object)$data;
2451         $role = $this->get_mappingid('role', $data->issuerrole);
2453         if (!empty($role)) {
2454             $award = array(
2455                 'badgeid'     => $this->get_new_parentid('badge'),
2456                 'recipientid' => $this->get_mappingid('user', $data->recipientid),
2457                 'issuerid'    => $this->get_mappingid('user', $data->issuerid),
2458                 'issuerrole'  => $role,
2459                 'datemet'     => $this->apply_date_offset($data->datemet)
2460             );
2462             // Skip the manual award if recipient or issuer can not be mapped to.
2463             if (empty($award['recipientid']) || empty($award['issuerid'])) {
2464                 return;
2465             }
2467             $DB->insert_record('badge_manual_award', $award);
2468         }
2469     }
2471     protected function after_execute() {
2472         // Add related files.
2473         $this->add_related_files('badges', 'badgeimage', 'badge');
2474     }
2477 /**
2478  * This structure steps restores the calendar events
2479  */
2480 class restore_calendarevents_structure_step extends restore_structure_step {
2482     protected function define_structure() {
2484         $paths = array();
2486         $paths[] = new restore_path_element('calendarevents', '/events/event');
2488         return $paths;
2489     }
2491     public function process_calendarevents($data) {
2492         global $DB, $SITE, $USER;
2494         $data = (object)$data;
2495         $oldid = $data->id;
2496         $restorefiles = true; // We'll restore the files
2497         // Find the userid and the groupid associated with the event.
2498         $data->userid = $this->get_mappingid('user', $data->userid);
2499         if ($data->userid === false) {
2500             // Blank user ID means that we are dealing with module generated events such as quiz starting times.
2501             // Use the current user ID for these events.
2502             $data->userid = $USER->id;
2503         }
2504         if (!empty($data->groupid)) {
2505             $data->groupid = $this->get_mappingid('group', $data->groupid);
2506             if ($data->groupid === false) {
2507                 return;
2508             }
2509         }
2510         // Handle events with empty eventtype //MDL-32827
2511         if(empty($data->eventtype)) {
2512             if ($data->courseid == $SITE->id) {                                // Site event
2513                 $data->eventtype = "site";
2514             } else if ($data->courseid != 0 && $data->groupid == 0 && ($data->modulename == 'assignment' || $data->modulename == 'assign')) {
2515                 // Course assingment event
2516                 $data->eventtype = "due";
2517             } else if ($data->courseid != 0 && $data->groupid == 0) {      // Course event
2518                 $data->eventtype = "course";
2519             } else if ($data->groupid) {                                      // Group event
2520                 $data->eventtype = "group";
2521             } else if ($data->userid) {                                       // User event
2522                 $data->eventtype = "user";
2523             } else {
2524                 return;
2525             }
2526         }
2528         $params = array(
2529                 'name'           => $data->name,
2530                 'description'    => $data->description,
2531                 'format'         => $data->format,
2532                 'courseid'       => $this->get_courseid(),
2533                 'groupid'        => $data->groupid,
2534                 'userid'         => $data->userid,
2535                 'repeatid'       => $data->repeatid,
2536                 'modulename'     => $data->modulename,
2537                 'eventtype'      => $data->eventtype,
2538                 'timestart'      => $this->apply_date_offset($data->timestart),
2539                 'timeduration'   => $data->timeduration,
2540                 'visible'        => $data->visible,
2541                 'uuid'           => $data->uuid,
2542                 'sequence'       => $data->sequence,
2543                 'timemodified'    => $this->apply_date_offset($data->timemodified));
2544         if ($this->name == 'activity_calendar') {
2545             $params['instance'] = $this->task->get_activityid();
2546         } else {
2547             $params['instance'] = 0;
2548         }
2549         $sql = "SELECT id
2550                   FROM {event}
2551                  WHERE " . $DB->sql_compare_text('name', 255) . " = " . $DB->sql_compare_text('?', 255) . "
2552                    AND courseid = ?
2553                    AND repeatid = ?
2554                    AND modulename = ?
2555                    AND timestart = ?
2556                    AND timeduration = ?
2557                    AND " . $DB->sql_compare_text('description', 255) . " = " . $DB->sql_compare_text('?', 255);
2558         $arg = array ($params['name'], $params['courseid'], $params['repeatid'], $params['modulename'], $params['timestart'], $params['timeduration'], $params['description']);
2559         $result = $DB->record_exists_sql($sql, $arg);
2560         if (empty($result)) {
2561             $newitemid = $DB->insert_record('event', $params);
2562             $this->set_mapping('event', $oldid, $newitemid);
2563             $this->set_mapping('event_description', $oldid, $newitemid, $restorefiles);
2564         }
2566     }
2567     protected function after_execute() {
2568         // Add related files
2569         $this->add_related_files('calendar', 'event_description', 'event_description');
2570     }
2573 class restore_course_completion_structure_step extends restore_structure_step {
2575     /**
2576      * Conditionally decide if this step should be executed.
2577      *
2578      * This function checks parameters that are not immediate settings to ensure
2579      * that the enviroment is suitable for the restore of course completion info.
2580      *
2581      * This function checks the following four parameters:
2582      *
2583      *   1. Course completion is enabled on the site
2584      *   2. The backup includes course completion information
2585      *   3. All modules are restorable
2586      *   4. All modules are marked for restore.
2587      *   5. No completion criteria already exist for the course.
2588      *
2589      * @return bool True is safe to execute, false otherwise
2590      */
2591     protected function execute_condition() {
2592         global $CFG, $DB;
2594         // First check course completion is enabled on this site
2595         if (empty($CFG->enablecompletion)) {
2596             // Disabled, don't restore course completion
2597             return false;
2598         }
2600         // No course completion on the front page.
2601         if ($this->get_courseid() == SITEID) {
2602             return false;
2603         }
2605         // Check it is included in the backup
2606         $fullpath = $this->task->get_taskbasepath();
2607         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2608         if (!file_exists($fullpath)) {
2609             // Not found, can't restore course completion
2610             return false;
2611         }
2613         // Check we are able to restore all backed up modules
2614         if ($this->task->is_missing_modules()) {
2615             return false;
2616         }
2618         // Check all modules within the backup are being restored.
2619         if ($this->task->is_excluding_activities()) {
2620             return false;
2621         }
2623         // Check that no completion criteria is already set for the course.
2624         if ($DB->record_exists('course_completion_criteria', array('course' => $this->get_courseid()))) {
2625             return false;
2626         }
2628         return true;
2629     }
2631     /**
2632      * Define the course completion structure
2633      *
2634      * @return array Array of restore_path_element
2635      */
2636     protected function define_structure() {
2638         // To know if we are including user completion info
2639         $userinfo = $this->get_setting_value('userscompletion');
2641         $paths = array();
2642         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
2643         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
2645         if ($userinfo) {
2646             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
2647             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
2648         }
2650         return $paths;
2652     }
2654     /**
2655      * Process course completion criteria
2656      *
2657      * @global moodle_database $DB
2658      * @param stdClass $data
2659      */
2660     public function process_course_completion_criteria($data) {
2661         global $DB;
2663         $data = (object)$data;
2664         $data->course = $this->get_courseid();
2666         // Apply the date offset to the time end field
2667         $data->timeend = $this->apply_date_offset($data->timeend);
2669         // Map the role from the criteria
2670         if (isset($data->role) && $data->role != '') {
2671             // Newer backups should include roleshortname, which makes this much easier.
2672             if (!empty($data->roleshortname)) {
2673                 $roleinstanceid = $DB->get_field('role', 'id', array('shortname' => $data->roleshortname));
2674                 if (!$roleinstanceid) {
2675                     $this->log(
2676                         'Could not match the role shortname in course_completion_criteria, so skipping',
2677                         backup::LOG_DEBUG
2678                     );
2679                     return;
2680                 }
2681                 $data->role = $roleinstanceid;
2682             } else {
2683                 $data->role = $this->get_mappingid('role', $data->role);
2684             }
2686             // Check we have an id, otherwise it causes all sorts of bugs.
2687             if (!$data->role) {
2688                 $this->log(
2689                     'Could not match role in course_completion_criteria, so skipping',
2690                     backup::LOG_DEBUG
2691                 );
2692                 return;
2693             }
2694         }
2696         // If the completion criteria is for a module we need to map the module instance
2697         // to the new module id.
2698         if (!empty($data->moduleinstance) && !empty($data->module)) {
2699             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
2700             if (empty($data->moduleinstance)) {
2701                 $this->log(
2702                     'Could not match the module instance in course_completion_criteria, so skipping',
2703                     backup::LOG_DEBUG
2704                 );
2705                 return;
2706             }
2707         } else {
2708             $data->module = null;
2709             $data->moduleinstance = null;
2710         }
2712         // We backup the course shortname rather than the ID so that we can match back to the course
2713         if (!empty($data->courseinstanceshortname)) {
2714             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
2715             if (!$courseinstanceid) {
2716                 $this->log(
2717                     'Could not match the course instance in course_completion_criteria, so skipping',
2718                     backup::LOG_DEBUG
2719                 );
2720                 return;
2721             }
2722         } else {
2723             $courseinstanceid = null;
2724         }
2725         $data->courseinstance = $courseinstanceid;
2727         $params = array(
2728             'course'         => $data->course,
2729             'criteriatype'   => $data->criteriatype,
2730             'enrolperiod'    => $data->enrolperiod,
2731             'courseinstance' => $data->courseinstance,
2732             'module'         => $data->module,
2733             'moduleinstance' => $data->moduleinstance,
2734             'timeend'        => $data->timeend,
2735             'gradepass'      => $data->gradepass,
2736             'role'           => $data->role
2737         );
2738         $newid = $DB->insert_record('course_completion_criteria', $params);
2739         $this->set_mapping('course_completion_criteria', $data->id, $newid);
2740     }
2742     /**
2743      * Processes course compltion criteria complete records
2744      *
2745      * @global moodle_database $DB
2746      * @param stdClass $data
2747      */
2748     public function process_course_completion_crit_compl($data) {
2749         global $DB;
2751         $data = (object)$data;
2753         // This may be empty if criteria could not be restored
2754         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
2756         $data->course = $this->get_courseid();
2757         $data->userid = $this->get_mappingid('user', $data->userid);
2759         if (!empty($data->criteriaid) && !empty($data->userid)) {
2760             $params = array(
2761                 'userid' => $data->userid,
2762                 'course' => $data->course,
2763                 'criteriaid' => $data->criteriaid,
2764                 'timecompleted' => $this->apply_date_offset($data->timecompleted)
2765             );
2766             if (isset($data->gradefinal)) {
2767                 $params['gradefinal'] = $data->gradefinal;
2768             }
2769             if (isset($data->unenroled)) {
2770                 $params['unenroled'] = $data->unenroled;
2771             }
2772             $DB->insert_record('course_completion_crit_compl', $params);
2773         }
2774     }
2776     /**
2777      * Process course completions
2778      *
2779      * @global moodle_database $DB
2780      * @param stdClass $data
2781      */
2782     public function process_course_completions($data) {
2783         global $DB;
2785         $data = (object)$data;
2787         $data->course = $this->get_courseid();
2788         $data->userid = $this->get_mappingid('user', $data->userid);
2790         if (!empty($data->userid)) {
2791             $params = array(
2792                 'userid' => $data->userid,
2793                 'course' => $data->course,
2794                 'timeenrolled' => $this->apply_date_offset($data->timeenrolled),
2795                 'timestarted' => $this->apply_date_offset($data->timestarted),
2796                 'timecompleted' => $this->apply_date_offset($data->timecompleted),
2797                 'reaggregate' => $data->reaggregate
2798             );
2800             $existing = $DB->get_record('course_completions', array(
2801                 'userid' => $data->userid,
2802                 'course' => $data->course
2803             ));
2805             // MDL-46651 - If cron writes out a new record before we get to it
2806             // then we should replace it with the Truth data from the backup.
2807             // This may be obsolete after MDL-48518 is resolved
2808             if ($existing) {
2809                 $params['id'] = $existing->id;
2810                 $DB->update_record('course_completions', $params);
2811             } else {
2812                 $DB->insert_record('course_completions', $params);
2813             }
2814         }
2815     }
2817     /**
2818      * Process course completion aggregate methods
2819      *
2820      * @global moodle_database $DB
2821      * @param stdClass $data
2822      */
2823     public function process_course_completion_aggr_methd($data) {
2824         global $DB;
2826         $data = (object)$data;
2828         $data->course = $this->get_courseid();
2830         // Only create the course_completion_aggr_methd records if
2831         // the target course has not them defined. MDL-28180
2832         if (!$DB->record_exists('course_completion_aggr_methd', array(
2833                     'course' => $data->course,
2834                     'criteriatype' => $data->criteriatype))) {
2835             $params = array(
2836                 'course' => $data->course,
2837                 'criteriatype' => $data->criteriatype,
2838                 'method' => $data->method,
2839                 'value' => $data->value,
2840             );
2841             $DB->insert_record('course_completion_aggr_methd', $params);
2842         }
2843     }
2847 /**
2848  * This structure step restores course logs (cmid = 0), delegating
2849  * the hard work to the corresponding {@link restore_logs_processor} passing the
2850  * collection of {@link restore_log_rule} rules to be observed as they are defined
2851  * by the task. Note this is only executed based in the 'logs' setting.
2852  *
2853  * NOTE: This is executed by final task, to have all the activities already restored
2854  *
2855  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
2856  * records are. There are others like 'calendar' and 'upload' that will be handled
2857  * later.
2858  *
2859  * NOTE: All the missing actions (not able to be restored) are sent to logs for
2860  * debugging purposes
2861  */
2862 class restore_course_logs_structure_step extends restore_structure_step {
2864     /**
2865      * Conditionally decide if this step should be executed.
2866      *
2867      * This function checks the following parameter:
2868      *
2869      *   1. the course/logs.xml file exists
2870      *
2871      * @return bool true is safe to execute, false otherwise
2872      */
2873     protected function execute_condition() {
2875         // Check it is included in the backup
2876         $fullpath = $this->task->get_taskbasepath();
2877         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2878         if (!file_exists($fullpath)) {
2879             // Not found, can't restore course logs
2880             return false;
2881         }
2883         return true;
2884     }
2886     protected function define_structure() {
2888         $paths = array();
2890         // Simple, one plain level of information contains them
2891         $paths[] = new restore_path_element('log', '/logs/log');
2893         return $paths;
2894     }
2896     protected function process_log($data) {
2897         global $DB;
2899         $data = (object)($data);
2901         $data->time = $this->apply_date_offset($data->time);
2902         $data->userid = $this->get_mappingid('user', $data->userid);
2903         $data->course = $this->get_courseid();
2904         $data->cmid = 0;
2906         // For any reason user wasn't remapped ok, stop processing this
2907         if (empty($data->userid)) {
2908             return;
2909         }
2911         // Everything ready, let's delegate to the restore_logs_processor
2913         // Set some fixed values that will save tons of DB requests
2914         $values = array(
2915             'course' => $this->get_courseid());
2916         // Get instance and process log record
2917         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2919         // If we have data, insert it, else something went wrong in the restore_logs_processor
2920         if ($data) {
2921             if (empty($data->url)) {
2922                 $data->url = '';
2923             }
2924             if (empty($data->info)) {
2925                 $data->info = '';
2926             }
2927             // Store the data in the legacy log table if we are still using it.
2928             $manager = get_log_manager();
2929             if (method_exists($manager, 'legacy_add_to_log')) {
2930                 $manager->legacy_add_to_log($data->course, $data->module, $data->action, $data->url,
2931                     $data->info, $data->cmid, $data->userid, $data->ip, $data->time);
2932             }
2933         }
2934     }
2937 /**
2938  * This structure step restores activity logs, extending {@link restore_course_logs_structure_step}
2939  * sharing its same structure but modifying the way records are handled
2940  */
2941 class restore_activity_logs_structure_step extends restore_course_logs_structure_step {
2943     protected function process_log($data) {
2944         global $DB;
2946         $data = (object)($data);
2948         $data->time = $this->apply_date_offset($data->time);
2949         $data->userid = $this->get_mappingid('user', $data->userid);
2950         $data->course = $this->get_courseid();
2951         $data->cmid = $this->task->get_moduleid();
2953         // For any reason user wasn't remapped ok, stop processing this
2954         if (empty($data->userid)) {
2955             return;
2956         }
2958         // Everything ready, let's delegate to the restore_logs_processor
2960         // Set some fixed values that will save tons of DB requests
2961         $values = array(
2962             'course' => $this->get_courseid(),
2963             'course_module' => $this->task->get_moduleid(),
2964             $this->task->get_modulename() => $this->task->get_activityid());
2965         // Get instance and process log record
2966         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2968         // If we have data, insert it, else something went wrong in the restore_logs_processor
2969         if ($data) {
2970             if (empty($data->url)) {
2971                 $data->url = '';
2972             }
2973             if (empty($data->info)) {
2974                 $data->info = '';
2975             }
2976             // Store the data in the legacy log table if we are still using it.
2977             $manager = get_log_manager();
2978             if (method_exists($manager, 'legacy_add_to_log')) {
2979                 $manager->legacy_add_to_log($data->course, $data->module, $data->action, $data->url,
2980                     $data->info, $data->cmid, $data->userid, $data->ip, $data->time);
2981             }
2982         }
2983     }
2986 /**
2987  * Structure step in charge of restoring the logstores.xml file for the course logs.
2988  *
2989  * This restore step will rebuild the logs for all the enabled logstore subplugins supporting
2990  * it, for logs belonging to the course level.
2991  */
2992 class restore_course_logstores_structure_step extends restore_structure_step {
2994     /**
2995      * Conditionally decide if this step should be executed.
2996      *
2997      * This function checks the following parameter:
2998      *
2999      *   1. the logstores.xml file exists
3000      *
3001      * @return bool true is safe to execute, false otherwise
3002      */
3003     protected function execute_condition() {
3005         // Check it is included in the backup.
3006         $fullpath = $this->task->get_taskbasepath();
3007         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
3008         if (!file_exists($fullpath)) {
3009             // Not found, can't restore logstores.xml information.
3010             return false;
3011         }
3013         return true;
3014     }
3016     /**
3017      * Return the elements to be processed on restore of logstores.
3018      *
3019      * @return restore_path_element[] array of elements to be processed on restore.
3020      */
3021     protected function define_structure() {
3023         $paths = array();
3025         $logstore = new restore_path_element('logstore', '/logstores/logstore');
3026         $paths[] = $logstore;
3028         // Add logstore subplugin support to the 'logstore' element.
3029         $this->add_subplugin_structure('logstore', $logstore, 'tool', 'log');
3031         return array($logstore);
3032     }
3034     /**
3035      * Process the 'logstore' element,
3036      *
3037      * Note: This is empty by definition in backup, because stores do not share any
3038      * data between them, so there is nothing to process here.
3039      *
3040      * @param array $data element data
3041      */
3042     protected function process_logstore($data) {
3043         return;
3044     }
3047 /**
3048  * Structure step in charge of restoring the logstores.xml file for the activity logs.
3049  *
3050  * Note: Activity structure is completely equivalent to the course one, so just extend it.
3051  */
3052 class restore_activity_logstores_structure_step extends restore_course_logstores_structure_step {
3056 /**
3057  * Defines the restore step for advanced grading methods attached to the activity module
3058  */
3059 class restore_activity_grading_structure_step extends restore_structure_step {
3061     /**
3062      * This step is executed only if the grading file is present
3063      */
3064      protected function execute_condition() {
3066         if ($this->get_courseid() == SITEID) {
3067             return false;
3068         }
3070         $fullpath = $this->task->get_taskbasepath();
3071         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
3072         if (!file_exists($fullpath)) {
3073             return false;
3074         }
3076         return true;
3077     }
3080     /**
3081      * Declares paths in the grading.xml file we are interested in
3082      */
3083     protected function define_structure() {
3085         $paths = array();
3086         $userinfo = $this->get_setting_value('userinfo');
3088         $area = new restore_path_element('grading_area', '/areas/area');
3089         $paths[] = $area;
3090         // attach local plugin stucture to $area element
3091         $this->add_plugin_structure('local', $area);
3093         $definition = new restore_path_element('grading_definition', '/areas/area/definitions/definition');
3094         $paths[] = $definition;
3095         $this->add_plugin_structure('gradingform', $definition);
3096         // attach local plugin stucture to $definition element
3097         $this->add_plugin_structure('local', $definition);
3100         if ($userinfo) {
3101             $instance = new restore_path_element('grading_instance',
3102                 '/areas/area/definitions/definition/instances/instance');
3103             $paths[] = $instance;
3104             $this->add_plugin_structure('gradingform', $instance);
3105             // attach local plugin stucture to $intance element
3106             $this->add_plugin_structure('local', $instance);
3107         }
3109         return $paths;
3110     }
3112     /**
3113      * Processes one grading area element
3114      *
3115      * @param array $data element data
3116      */
3117     protected function process_grading_area($data) {
3118         global $DB;
3120         $task = $this->get_task();
3121         $data = (object)$data;
3122         $oldid = $data->id;
3123         $data->component = 'mod_'.$task->get_modulename();
3124         $data->contextid = $task->get_contextid();
3126         $newid = $DB->insert_record('grading_areas', $data);
3127         $this->set_mapping('grading_area', $oldid, $newid);
3128     }
3130     /**
3131      * Processes one grading definition element
3132      *
3133      * @param array $data element data
3134      */
3135     protected function process_grading_definition($data) {
3136         global $DB;
3138         $task = $this->get_task();
3139         $data = (object)$data;
3140         $oldid = $data->id;
3141         $data->areaid = $this->get_new_parentid('grading_area');
3142         $data->copiedfromid = null;
3143         $data->timecreated = time();
3144         $data->usercreated = $task->get_userid();
3145         $data->timemodified = $data->timecreated;
3146         $data->usermodified = $data->usercreated;
3148         $newid = $DB->insert_record('grading_definitions', $data);
3149         $this->set_mapping('grading_definition', $oldid, $newid, true);
3150     }
3152     /**
3153      * Processes one grading form instance element
3154      *
3155      * @param array $data element data
3156      */
3157     protected function process_grading_instance($data) {
3158         global $DB;
3160         $data = (object)$data;
3162         // new form definition id
3163         $newformid = $this->get_new_parentid('grading_definition');
3165         // get the name of the area we are restoring to
3166         $sql = "SELECT ga.areaname
3167                   FROM {grading_definitions} gd
3168                   JOIN {grading_areas} ga ON gd.areaid = ga.id
3169                  WHERE gd.id = ?";
3170         $areaname = $DB->get_field_sql($sql, array($newformid), MUST_EXIST);
3172         // get the mapped itemid - the activity module is expected to define the mappings
3173         // for each gradable area
3174         $newitemid = $this->get_mappingid(restore_gradingform_plugin::itemid_mapping($areaname), $data->itemid);
3176         $oldid = $data->id;
3177         $data->definitionid = $newformid;
3178         $data->raterid = $this->get_mappingid('user', $data->raterid);
3179         $data->itemid = $newitemid;
3181         $newid = $DB->insert_record('grading_instances', $data);
3182         $this->set_mapping('grading_instance', $oldid, $newid);
3183     }
3185     /**
3186      * Final operations when the database records are inserted
3187      */
3188     protected function after_execute() {
3189         // Add files embedded into the definition description
3190         $this->add_related_files('grading', 'description', 'grading_definition');
3191     }
3195 /**
3196  * This structure step restores the grade items associated with one activity
3197  * All the grade items are made child of the "course" grade item but the original
3198  * categoryid is saved as parentitemid in the backup_ids table, so, when restoring
3199  * the complete gradebook (categories and calculations), that information is
3200  * available there
3201  */
3202 class restore_activity_grades_structure_step extends restore_structure_step {
3204     /**
3205      * No grades in front page.
3206      * @return bool
3207      */
3208     protected function execute_condition() {
3209         return ($this->get_courseid() != SITEID);
3210     }
3212     protected function define_structure() {
3214         $paths = array();
3215         $userinfo = $this->get_setting_value('userinfo');
3217         $paths[] = new restore_path_element('grade_item', '/activity_gradebook/grade_items/grade_item');
3218         $paths[] = new restore_path_element('grade_letter', '/activity_gradebook/grade_letters/grade_letter');
3219         if ($userinfo) {
3220             $paths[] = new restore_path_element('grade_grade',
3221                            '/activity_gradebook/grade_items/grade_item/grade_grades/grade_grade');
3222         }
3223         return $paths;
3224     }
3226     protected function process_grade_item($data) {
3227         global $DB;
3229         $data = (object)($data);
3230         $oldid       = $data->id;        // We'll need these later
3231         $oldparentid = $data->categoryid;
3232         $courseid = $this->get_courseid();
3234         $idnumber = null;
3235         if (!empty($data->idnumber)) {
3236             // Don't get any idnumber from course module. Keep them as they are in grade_item->idnumber
3237             // Reason: it's not clear what happens with outcomes->idnumber or activities with multiple items (workshop)
3238             // so the best is to keep the ones already in the gradebook
3239             // Potential problem: duplicates if same items are restored more than once. :-(
3240             // This needs to be fixed in some way (outcomes & activities with multiple items)
3241             // $data->idnumber     = get_coursemodule_from_instance($data->itemmodule, $data->iteminstance)->idnumber;
3242             // In any case, verify always for uniqueness
3243             $sql = "SELECT cm.id
3244                       FROM {course_modules} cm
3245                      WHERE cm.course = :courseid AND
3246                            cm.idnumber = :idnumber AND
3247                            cm.id <> :cmid";
3248             $params = array(
3249                 'courseid' => $courseid,
3250                 'idnumber' => $data->idnumber,
3251                 'cmid' => $this->task->get_moduleid()
3252             );
3253             if (!$DB->record_exists_sql($sql, $params) && !$DB->record_exists('grade_items', array('courseid' => $courseid, 'idnumber' => $data->idnumber))) {
3254                 $idnumber = $data->idnumber;
3255             }
3256         }
3258         if (!empty($data->categoryid)) {
3259             // If the grade category id of the grade item being restored belongs to this course
3260             // then it is a fair assumption that this is the correct grade category for the activity
3261             // and we should leave it in place, if not then unset it.
3262             // TODO MDL-34790 Gradebook does not import if target course has gradebook categories.
3263             $conditions = array('id' => $data->categoryid, 'courseid' => $courseid);
3264             if (!$this->task->is_samesite() || !$DB->record_exists('grade_categories', $conditions)) {
3265                 unset($data->categoryid);
3266             }
3267         }
3269         unset($data->id);
3270         $data->courseid     = $this->get_courseid();
3271         $data->iteminstance = $this->task->get_activityid();
3272         $data->idnumber     = $idnumber;
3273         $data->scaleid      = $this->get_mappingid('scale', $data->scaleid);
3274         $data->outcomeid    = $this->get_mappingid('outcome', $data->outcomeid);
3275         $data->timecreated  = $this->apply_date_offset($data->timecreated);
3276         $data->timemodified = $this->apply_date_offset($data->timemodified);
3278         $gradeitem = new grade_item($data, false);
3279         $gradeitem->insert('restore');
3281         //sortorder is automatically assigned when inserting. Re-instate the previous sortorder
3282         $gradeitem->sortorder = $data->sortorder;
3283         $gradeitem->update('restore');
3285         // Set mapping, saving the original category id into parentitemid
3286         // gradebook restore (final task) will need it to reorganise items
3287         $this->set_mapping('grade_item', $oldid, $gradeitem->id, false, null, $oldparentid);
3288     }
3290     protected function process_grade_grade($data) {
3291         $data = (object)($data);
3292         $olduserid = $data->userid;
3293         $oldid = $data->id;
3294         unset($data->id);
3296         $data->itemid = $this->get_new_parentid('grade_item');
3298         $data->userid = $this->get_mappingid('user', $data->userid, null);
3299         if (!empty($data->userid)) {
3300             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
3301             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
3302             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
3303             $data->overridden = $this->apply_date_offset($data->overridden);
3305             $grade = new grade_grade($data, false);
3306             $grade->insert('restore');
3307             $this->set_mapping('grade_grades', $oldid, $grade->id);
3308         } else {
3309             debugging("Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'");
3310         }
3311     }
3313     /**
3314      * process activity grade_letters. Note that, while these are possible,
3315      * because grade_letters are contextid based, in practice, only course
3316      * context letters can be defined. So we keep here this method knowing
3317      * it won't be executed ever. gradebook restore will restore course letters.
3318      */
3319     protected function process_grade_letter($data) {
3320         global $DB;
3322         $data['contextid'] = $this->task->get_contextid();
3323         $gradeletter = (object)$data;
3325         // Check if it exists before adding it
3326         unset($data['id']);
3327         if (!$DB->record_exists('grade_letters', $data)) {
3328             $newitemid = $DB->insert_record('grade_letters', $gradeletter);
3329         }
3330         // no need to save any grade_letter mapping
3331     }
3333     public function after_restore() {
3334         // Fix grade item's sortorder after restore, as it might have duplicates.
3335         $courseid = $this->get_task()->get_courseid();
3336         grade_item::fix_duplicate_sortorder($courseid);
3337     }
3340 /**
3341  * Step in charge of restoring the grade history of an activity.
3342  *
3343  * This step is added to the task regardless of the setting 'grade_histories'.
3344  * The reason is to allow for a more flexible step in case the logic needs to be
3345  * split accross different settings to control the history of items and/or grades.
3346  */
3347 class restore_activity_grade_history_structure_step extends restore_structure_step {
3349     /**
3350      * This step is executed only if the grade history file is present.
3351      */
3352      protected function execute_condition() {
3354         if ($this->get_courseid() == SITEID) {
3355             return false;
3356         }
3358         $fullpath = $this->task->get_taskbasepath();
3359         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
3360         if (!file_exists($fullpath)) {
3361             return false;
3362         }
3363         return true;
3364     }
3366     protected function define_structure() {
3367         $paths = array();
3369         // Settings to use.
3370         $userinfo = $this->get_setting_value('userinfo');
3371         $history = $this->get_setting_value('grade_histories');
3373         if ($userinfo && $history) {
3374             $paths[] = new restore_path_element('grade_grade',
3375                '/grade_history/grade_grades/grade_grade');
3376         }
3378         return $paths;
3379     }
3381     protected function process_grade_grade($data) {
3382         global $DB;
3384         $data = (object) $data;
3385         $olduserid = $data->userid;
3386         unset($data->id);
3388         $data->userid = $this->get_mappingid('user', $data->userid, null);
3389         if (!empty($data->userid)) {
3390             // Do not apply the date offsets as this is history.
3391             $data->itemid = $this->get_mappingid('grade_item', $data->itemid);
3392             $data->oldid = $this->get_mappingid('grade_grades', $data->oldid);
3393             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
3394             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
3395             $DB->insert_record('grade_grades_history', $data);
3396         } else {
3397             $message = "Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'";
3398             $this->log($message, backup::LOG_DEBUG);
3399         }
3400     }
3404 /**
3405  * This structure steps restores one instance + positions of one block
3406  * Note: Positions corresponding to one existing context are restored
3407  * here, but all the ones having unknown contexts are sent to backup_ids
3408  * for a later chance to be restored at the end (final task)
3409  */
3410 class restore_block_instance_structure_step extends restore_structure_step {
3412     protected function define_structure() {
3414         $paths = array();
3416         $paths[] = new restore_path_element('block', '/block', true); // Get the whole XML together
3417         $paths[] = new restore_path_element('block_position', '/block/block_positions/block_position');
3419         return $paths;
3420     }
3422     public function process_block($data) {
3423         global $DB, $CFG;
3425         $data = (object)$data; // Handy
3426         $oldcontextid = $data->contextid;
3427         $oldid        = $data->id;
3428         $positions = isset($data->block_positions['block_position']) ? $data->block_positions['block_position'] : array();
3430         // Look for the parent contextid
3431         if (!$data->parentcontextid = $this->get_mappingid('context', $data->parentcontextid)) {
3432             throw new restore_step_exception('restore_block_missing_parent_ctx', $data->parentcontextid);
3433         }
3435         // TODO: it would be nice to use standard plugin supports instead of this instance_allow_multiple()
3436         // If there is already one block of that type in the parent context
3437         // and the block is not multiple, stop processing
3438         // Use blockslib loader / method executor
3439         if (!$bi = block_instance($data->blockname)) {
3440             return false;
3441         }
3443         if (!$bi->instance_allow_multiple()) {
3444             // The block cannot be added twice, so we will check if the same block is already being
3445             // displayed on the same page. For this, rather than mocking a page and using the block_manager
3446             // we use a similar query to the one in block_manager::load_blocks(), this will give us
3447             // a very good idea of the blocks already displayed in the context.
3448             $params =  array(
3449                 'blockname' => $data->blockname
3450             );
3452             // Context matching test.
3453             $context = context::instance_by_id($data->parentcontextid);
3454             $contextsql = 'bi.parentcontextid = :contextid';
3455             $params['contextid'] = $context->id;
3457             $parentcontextids = $context->get_parent_context_ids();
3458             if ($parentcontextids) {
3459                 list($parentcontextsql, $parentcontextparams) =
3460                         $DB->get_in_or_equal($parentcontextids, SQL_PARAMS_NAMED);
3461                 $contextsql = "($contextsql OR (bi.showinsubcontexts = 1 AND bi.parentcontextid $parentcontextsql))";
3462                 $params = array_merge($params, $parentcontextparams);
3463             }
3465             // Page type pattern test.
3466             $pagetypepatterns = matching_page_type_patterns_from_pattern($data->pagetypepattern);
3467             list($pagetypepatternsql, $pagetypepatternparams) =
3468                 $DB->get_in_or_equal($pagetypepatterns, SQL_PARAMS_NAMED);
3469             $params = array_merge($params, $pagetypepatternparams);
3471             // Sub page pattern test.
3472             $subpagepatternsql = 'bi.subpagepattern IS NULL';
3473             if ($data->subpagepattern !== null) {
3474                 $subpagepatternsql = "($subpagepatternsql OR bi.subpagepattern = :subpagepattern)";
3475                 $params['subpagepattern'] = $data->subpagepattern;
3476             }
3478             $exists = $DB->record_exists_sql("SELECT bi.id
3479                                                 FROM {block_instances} bi
3480                                                 JOIN {block} b ON b.name = bi.blockname
3481                                                WHERE bi.blockname = :blockname
3482                                                  AND $contextsql
3483                                                  AND bi.pagetypepattern $pagetypepatternsql
3484                                                  AND $subpagepatternsql", $params);
3485             if ($exists) {
3486                 // There is at least one very similar block visible on the page where we
3487                 // are trying to restore the block. In these circumstances the block API
3488                 // would not allow the user to add another instance of the block, so we
3489                 // apply the same rule here.
3490                 return false;
3491             }
3492         }
3494         // If there is already one block of that type in the parent context
3495         // with the same showincontexts, pagetypepattern, subpagepattern, defaultregion and configdata
3496         // stop processing
3497         $params = array(
3498             'blockname' => $data->blockname, 'parentcontextid' => $data->parentcontextid,
3499             'showinsubcontexts' => $data->showinsubcontexts, 'pagetypepattern' => $data->pagetypepattern,
3500             'subpagepattern' => $data->subpagepattern, 'defaultregion' => $data->defaultregion);
3501         if ($birecs = $DB->get_records('block_instances', $params)) {
3502             foreach($birecs as $birec) {
3503                 if ($birec->configdata == $data->configdata) {
3504                     return false;
3505                 }
3506             }
3507         }
3509         // Set task old contextid, blockid and blockname once we know them
3510         $this->task->set_old_contextid($oldcontextid);
3511         $this->task->set_old_blockid($oldid);
3512         $this->task->set_blockname($data->blockname);
3514         // Let's look for anything within configdata neededing processing
3515         // (nulls and uses of legacy file.php)
3516         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
3517             $configdata = (array)unserialize(base64_decode($data->configdata));
3518             foreach ($configdata as $attribute => $value) {
3519                 if (in_array($attribute, $attrstotransform)) {
3520                     $configdata[$attribute] = $this->contentprocessor->process_cdata($value);
3521                 }
3522             }
3523             $data->configdata = base64_encode(serialize((object)$configdata));
3524         }
3526         // Create the block instance
3527         $newitemid = $DB->insert_record('block_instances', $data);
3528         // Save the mapping (with restorefiles support)
3529         $this->set_mapping('block_instance', $oldid, $newitemid, true);
3530         // Create the block context
3531         $newcontextid = context_block::instance($newitemid)->id;
3532         // Save the block contexts mapping and sent it to task
3533         $this->set_mapping('context', $oldcontextid, $newcontextid);
3534         $this->task->set_contextid($newcontextid);
3535         $this->task->set_blockid($newitemid);
3537         // Restore block fileareas if declared
3538         $component = 'block_' . $this->task->get_blockname();
3539         foreach ($this->task->get_fileareas() as $filearea) { // Simple match by contextid. No itemname needed
3540             $this->add_related_files($component, $filearea, null);
3541         }
3543         // Process block positions, creating them or accumulating for final step
3544         foreach($positions as $position) {
3545             $position = (object)$position;
3546             $position->blockinstanceid = $newitemid; // The instance is always the restored one
3547             // If position is for one already mapped (known) contextid
3548             // process it now, creating the position
3549             if ($newpositionctxid = $this->get_mappingid('context', $position->contextid)) {
3550                 $position->contextid = $newpositionctxid;
3551                 // Create the block position
3552                 $DB->insert_record('block_positions', $position);
3554             // The position belongs to an unknown context, send it to backup_ids
3555             // to process them as part of the final steps of restore. We send the
3556             // whole $position object there, hence use the low level method.
3557             } else {
3558                 restore_dbops::set_backup_ids_record($this->get_restoreid(), 'block_position', $position->id, 0, null, $position);
3559             }
3560         }
3561     }
3564 /**
3565  * Structure step to restore common course_module information
3566  *
3567  * This step will process the module.xml file for one activity, in order to restore
3568  * the corresponding information to the course_modules table, skipping various bits
3569  * of information based on CFG settings (groupings, completion...) in order to fullfill
3570  * all the reqs to be able to create the context to be used by all the rest of steps
3571  * in the activity restore task
3572  */
3573 class restore_module_structure_step extends restore_structure_step {
3575     protected function define_structure() {
3576         global $CFG;
3578         $paths = array();
3580         $module = new restore_path_element('module', '/module');
3581         $paths[] = $module;
3582         if ($CFG->enableavailability) {
3583             $paths[] = new restore_path_element('availability', '/module/availability_info/availability');
3584             $paths[] = new restore_path_element('availability_field', '/module/availability_info/availability_field');
3585         }
3587         // Apply for 'format' plugins optional paths at module level
3588         $this->add_plugin_structure('format', $module);
3590         // Apply for 'plagiarism' plugins optional paths at module level
3591         $this->add_plugin_structure('plagiarism', $module);
3593         // Apply for 'local' plugins optional paths at module level
3594         $this->add_plugin_structure('local', $module);
3596         return $paths;
3597     }
3599     protected function process_module($data) {
3600         global $CFG, $DB;
3602         $data = (object)$data;
3603         $oldid = $data->id;
3604         $this->task->set_old_moduleversion($data->version);
3606         $data->course = $this->task->get_courseid();
3607         $data->module = $DB->get_field('modules', 'id', array('name' => $data->modulename));
3608         // Map section (first try by course_section mapping match. Useful in course and section restores)
3609         $data->section = $this->get_mappingid('course_section', $data->sectionid);
3610         if (!$data->section) { // mapping failed, try to get section by sectionnumber matching
3611             $params = array(
3612                 'course' => $this->get_courseid(),
3613                 'section' => $data->sectionnumber);
3614             $data->section = $DB->get_field('course_sections', 'id', $params);
3615         }
3616         if (!$data->section) { // sectionnumber failed, try to get first section in course
3617             $params = array(
3618                 'course' => $this->get_courseid());
3619             $data->section = $DB->get_field('course_sections', 'MIN(id)', $params);
3620         }
3621         if (!$data->section) { // no sections in course, create section 0 and 1 and assign module to 1
3622             $sectionrec = array(
3623                 'course' => $this->get_courseid(),
3624                 'section' => 0);
3625             $DB->insert_record('course_sections', $sectionrec); // section 0
3626             $sectionrec = array(
3627                 'course' => $this->get_courseid(),
3628                 'section' => 1);
3629             $data->section = $DB->insert_record('course_sections', $sectionrec); // section 1
3630         }
3631         $data->groupingid= $this->get_mappingid('grouping', $data->groupingid);      // grouping
3632         if (!grade_verify_idnumber($data->idnumber, $this->get_courseid())) {        // idnumber uniqueness
3633             $data->idnumber = '';
3634         }
3635         if (empty($CFG->enablecompletion)) { // completion
3636             $data->completion = 0;
3637             $data->completiongradeitemnumber = null;
3638             $data->completionview = 0;
3639             $data->completionexpected = 0;
3640         } else {
3641             $data->completionexpected = $this->apply_date_offset($data->completionexpected);
3642         }
3643         if (empty($CFG->enableavailability)) {
3644             $data->availability = null;
3645         }
3646         // Backups that did not include showdescription, set it to default 0
3647         // (this is not totally necessary as it has a db default, but just to
3648         // be explicit).
3649         if (!isset($data->showdescription)) {
3650             $data->showdescription = 0;
3651         }
3652         $data->instance = 0; // Set to 0 for now, going to create it soon (next step)
3654         if (empty($data->availability)) {
3655             // If there are legacy availablility data fields (and no new format data),
3656             // convert the old fields.
3657             $data->availability = \core_availability\info::convert_legacy_fields(
3658                     $data, false);
3659         } else if (!empty($data->groupmembersonly)) {
3660             // There is current availability data, but it still has groupmembersonly
3661             // as well (2.7 backups), convert just that part.
3662             require_once($CFG->dirroot . '/lib/db/upgradelib.php');
3663             $data->availability = upgrade_group_members_only($data->groupingid, $data->availability);
3664         }
3666         // course_module record ready, insert it
3667         $newitemid = $DB->insert_record('course_modules', $data);
3668         // save mapping
3669         $this->set_mapping('course_module', $oldid, $newitemid);
3670         // set the new course_module id in the task
3671         $this->task->set_moduleid($newitemid);
3672         // we can now create the context safely
3673         $ctxid = context_module::instance($newitemid)->id;
3674         // set the new context id in the task
3675         $this->task->set_contextid($ctxid);
3676         // update sequence field in course_section
3677         if ($sequence = $DB->get_field('course_sections', 'sequence', array('id' => $data->section))) {
3678             $sequence .= ',' . $newitemid;
3679         } else {
3680             $sequence = $newitemid;
3681         }
3682         $DB->set_field('course_sections', 'sequence', $sequence, array('id' => $data->section));
3684         // If there is the legacy showavailability data, store this for later use.
3685         // (This data is not present when restoring 'new' backups.)
3686         if (isset($data->showavailability)) {
3687             // Cache the showavailability flag using the backup_ids data field.
3688             restore_dbops::set_backup_ids_record($this->get_restoreid(),
3689                     'module_showavailability', $newitemid, 0, null,
3690                     (object)array('showavailability' => $data->showavailability));
3691         }
3692     }
3694     /**
3695      * Process the legacy availability table record. This table does not exist
3696      * in Moodle 2.7+ but we still support restore.
3697      *
3698      * @param stdClass $data Record data
3699      */
3700     protected function process_availability($data) {
3701         $data = (object)$data;
3702         // Simply going to store the whole availability record now, we'll process
3703         // all them later in the final task (once all activities have been restored)
3704         // Let's call the low level one to be able to store the whole object
3705         $data->coursemoduleid = $this->task->get_moduleid(); // Let add the availability cmid
3706         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'module_availability', $data->id, 0, null, $data);
3707     }
3709     /**
3710      * Process the legacy availability fields table record. This table does not
3711      * exist in Moodle 2.7+ but we still support restore.
3712      *
3713      * @param stdClass $data Record data
3714      */
3715     protected function process_availability_field($data) {
3716         global $DB;
3717         $data = (object)$data;
3718         // Mark it is as passed by default
3719         $passed = true;
3720         $customfieldid = null;
3722         // If a customfield has been used in order to pass we must be able to match an existing
3723         // customfield by name (data->customfield) and type (data->customfieldtype)
3724         if (!empty($data->customfield) xor !empty($data->customfieldtype)) {
3725             // xor is sort of uncommon. If either customfield is null or customfieldtype is null BUT not both.
3726             // If one is null but the other isn't something clearly went wrong and we'll skip this condition.
3727             $passed = false;
3728         } else if (!empty($data->customfield)) {
3729             $params = array('shortname' => $data->customfield, 'datatype' => $data->customfieldtype);
3730             $customfieldid = $DB->get_field('user_info_field', 'id', $params);
3731             $passed = ($customfieldid !== false);
3732         }
3734         if ($passed) {
3735             // Create the object to insert into the database
3736             $availfield = new stdClass();
3737             $availfield->coursemoduleid = $this->task->get_moduleid(); // Lets add the availability cmid
3738             $availfield->userfield = $data->userfield;
3739             $availfield->customfieldid = $customfieldid;
3740             $availfield->operator = $data->operator;
3741             $availfield->value = $data->value;
3743             // Get showavailability option.
3744             $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
3745                     'module_showavailability', $availfield->coursemoduleid);
3746             if (!$showrec) {
3747                 // Should not happen.
3748                 throw new coding_exception('No matching showavailability record');
3749             }
3750             $show = $showrec->info->showavailability;