Merge branch 'MDL-45430-master' of git://github.com/ankitagarwal/moodle
[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     }
147     protected function process_grade_item($data) {
148         global $DB;
150         $data = (object)$data;
152         $oldid = $data->id;
153         $data->course = $this->get_courseid();
155         $data->courseid = $this->get_courseid();
157         if ($data->itemtype=='manual') {
158             // manual grade items store category id in categoryid
159             $data->categoryid = $this->get_mappingid('grade_category', $data->categoryid, NULL);
160             // if mapping failed put in course's grade category
161             if (NULL == $data->categoryid) {
162                 $coursecat = grade_category::fetch_course_category($this->get_courseid());
163                 $data->categoryid = $coursecat->id;
164             }
165         } else if ($data->itemtype=='course') {
166             // course grade item stores their category id in iteminstance
167             $coursecat = grade_category::fetch_course_category($this->get_courseid());
168             $data->iteminstance = $coursecat->id;
169         } else if ($data->itemtype=='category') {
170             // category grade items store their category id in iteminstance
171             $data->iteminstance = $this->get_mappingid('grade_category', $data->iteminstance, NULL);
172         } else {
173             throw new restore_step_exception('unexpected_grade_item_type', $data->itemtype);
174         }
176         $data->scaleid   = $this->get_mappingid('scale', $data->scaleid, NULL);
177         $data->outcomeid = $this->get_mappingid('outcome', $data->outcomeid, NULL);
179         $data->locktime     = $this->apply_date_offset($data->locktime);
180         $data->timecreated  = $this->apply_date_offset($data->timecreated);
181         $data->timemodified = $this->apply_date_offset($data->timemodified);
183         $coursecategory = $newitemid = null;
184         //course grade item should already exist so updating instead of inserting
185         if($data->itemtype=='course') {
186             //get the ID of the already created grade item
187             $gi = new stdclass();
188             $gi->courseid  = $this->get_courseid();
189             $gi->itemtype  = $data->itemtype;
191             //need to get the id of the grade_category that was automatically created for the course
192             $category = new stdclass();
193             $category->courseid  = $this->get_courseid();
194             $category->parent  = null;
195             //course category fullname starts out as ? but may be edited
196             //$category->fullname  = '?';
197             $coursecategory = $DB->get_record('grade_categories', (array)$category);
198             $gi->iteminstance = $coursecategory->id;
200             $existinggradeitem = $DB->get_record('grade_items', (array)$gi);
201             if (!empty($existinggradeitem)) {
202                 $data->id = $newitemid = $existinggradeitem->id;
203                 $DB->update_record('grade_items', $data);
204             }
205         } else if ($data->itemtype == 'manual') {
206             // Manual items aren't assigned to a cm, so don't go duplicating them in the target if one exists.
207             $gi = array(
208                 'itemtype' => $data->itemtype,
209                 'courseid' => $data->courseid,
210                 'itemname' => $data->itemname,
211                 'categoryid' => $data->categoryid,
212             );
213             $newitemid = $DB->get_field('grade_items', 'id', $gi);
214         }
216         if (empty($newitemid)) {
217             //in case we found the course category but still need to insert the course grade item
218             if ($data->itemtype=='course' && !empty($coursecategory)) {
219                 $data->iteminstance = $coursecategory->id;
220             }
222             $newitemid = $DB->insert_record('grade_items', $data);
223         }
224         $this->set_mapping('grade_item', $oldid, $newitemid);
225     }
227     protected function process_grade_grade($data) {
228         global $DB;
230         $data = (object)$data;
231         $oldid = $data->id;
232         $olduserid = $data->userid;
234         $data->itemid = $this->get_new_parentid('grade_item');
236         $data->userid = $this->get_mappingid('user', $data->userid, null);
237         if (!empty($data->userid)) {
238             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
239             $data->locktime     = $this->apply_date_offset($data->locktime);
240             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
241             $data->overridden = $this->apply_date_offset($data->overridden);
242             $data->timecreated  = $this->apply_date_offset($data->timecreated);
243             $data->timemodified = $this->apply_date_offset($data->timemodified);
245             $gradeexists = $DB->record_exists('grade_grades', array('userid' => $data->userid, 'itemid' => $data->itemid));
246             if ($gradeexists) {
247                 $message = "User id '{$data->userid}' already has a grade entry for grade item id '{$data->itemid}'";
248                 $this->log($message, backup::LOG_DEBUG);
249             } else {
250                 $newitemid = $DB->insert_record('grade_grades', $data);
251                 $this->set_mapping('grade_grades', $oldid, $newitemid);
252             }
253         } else {
254             $message = "Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'";
255             $this->log($message, backup::LOG_DEBUG);
256         }
257     }
259     protected function process_grade_category($data) {
260         global $DB;
262         $data = (object)$data;
263         $oldid = $data->id;
265         $data->course = $this->get_courseid();
266         $data->courseid = $data->course;
268         $data->timecreated  = $this->apply_date_offset($data->timecreated);
269         $data->timemodified = $this->apply_date_offset($data->timemodified);
271         $newitemid = null;
272         //no parent means a course level grade category. That may have been created when the course was created
273         if(empty($data->parent)) {
274             //parent was being saved as 0 when it should be null
275             $data->parent = null;
277             //get the already created course level grade category
278             $category = new stdclass();
279             $category->courseid = $this->get_courseid();
280             $category->parent = null;
282             $coursecategory = $DB->get_record('grade_categories', (array)$category);
283             if (!empty($coursecategory)) {
284                 $data->id = $newitemid = $coursecategory->id;
285                 $DB->update_record('grade_categories', $data);
286             }
287         }
289         // Add a warning about a removed setting.
290         if (!empty($data->aggregatesubcats)) {
291             set_config('show_aggregatesubcats_upgrade_' . $data->courseid, 1);
292         }
294         //need to insert a course category
295         if (empty($newitemid)) {
296             $newitemid = $DB->insert_record('grade_categories', $data);
297         }
298         $this->set_mapping('grade_category', $oldid, $newitemid);
299     }
300     protected function process_grade_letter($data) {
301         global $DB;
303         $data = (object)$data;
304         $oldid = $data->id;
306         $data->contextid = context_course::instance($this->get_courseid())->id;
308         $gradeletter = (array)$data;
309         unset($gradeletter['id']);
310         if (!$DB->record_exists('grade_letters', $gradeletter)) {
311             $newitemid = $DB->insert_record('grade_letters', $data);
312         } else {
313             $newitemid = $data->id;
314         }
316         $this->set_mapping('grade_letter', $oldid, $newitemid);
317     }
318     protected function process_grade_setting($data) {
319         global $DB;
321         $data = (object)$data;
322         $oldid = $data->id;
324         $data->courseid = $this->get_courseid();
326         if (!$DB->record_exists('grade_settings', array('courseid' => $data->courseid, 'name' => $data->name))) {
327             $newitemid = $DB->insert_record('grade_settings', $data);
328         } else {
329             $newitemid = $data->id;
330         }
332         $this->set_mapping('grade_setting', $oldid, $newitemid);
333     }
335     /**
336      * put all activity grade items in the correct grade category and mark all for recalculation
337      */
338     protected function after_execute() {
339         global $DB;
341         $conditions = array(
342             'backupid' => $this->get_restoreid(),
343             'itemname' => 'grade_item'//,
344             //'itemid'   => $itemid
345         );
346         $rs = $DB->get_recordset('backup_ids_temp', $conditions);
348         // We need this for calculation magic later on.
349         $mappings = array();
351         if (!empty($rs)) {
352             foreach($rs as $grade_item_backup) {
354                 // Store the oldid with the new id.
355                 $mappings[$grade_item_backup->itemid] = $grade_item_backup->newitemid;
357                 $updateobj = new stdclass();
358                 $updateobj->id = $grade_item_backup->newitemid;
360                 //if this is an activity grade item that needs to be put back in its correct category
361                 if (!empty($grade_item_backup->parentitemid)) {
362                     $oldcategoryid = $this->get_mappingid('grade_category', $grade_item_backup->parentitemid, null);
363                     if (!is_null($oldcategoryid)) {
364                         $updateobj->categoryid = $oldcategoryid;
365                         $DB->update_record('grade_items', $updateobj);
366                     }
367                 } else {
368                     //mark course and category items as needing to be recalculated
369                     $updateobj->needsupdate=1;
370                     $DB->update_record('grade_items', $updateobj);
371                 }
372             }
373         }
374         $rs->close();
376         // We need to update the calculations for calculated grade items that may reference old
377         // grade item ids using ##gi\d+##.
378         // $mappings can be empty, use 0 if so (won't match ever)
379         list($sql, $params) = $DB->get_in_or_equal(array_values($mappings), SQL_PARAMS_NAMED, 'param', true, 0);
380         $sql = "SELECT gi.id, gi.calculation
381                   FROM {grade_items} gi
382                  WHERE gi.id {$sql} AND
383                        calculation IS NOT NULL";
384         $rs = $DB->get_recordset_sql($sql, $params);
385         foreach ($rs as $gradeitem) {
386             // Collect all of the used grade item id references
387             if (preg_match_all('/##gi(\d+)##/', $gradeitem->calculation, $matches) < 1) {
388                 // This calculation doesn't reference any other grade items... EASY!
389                 continue;
390             }
391             // For this next bit we are going to do the replacement of id's in two steps:
392             // 1. We will replace all old id references with a special mapping reference.
393             // 2. We will replace all mapping references with id's
394             // Why do we do this?
395             // Because there potentially there will be an overlap of ids within the query and we
396             // we substitute the wrong id.. safest way around this is the two step system
397             $calculationmap = array();
398             $mapcount = 0;
399             foreach ($matches[1] as $match) {
400                 // Check that the old id is known to us, if not it was broken to begin with and will
401                 // continue to be broken.
402                 if (!array_key_exists($match, $mappings)) {
403                     continue;
404                 }
405                 // Our special mapping key
406                 $mapping = '##MAPPING'.$mapcount.'##';
407                 // The old id that exists within the calculation now
408                 $oldid = '##gi'.$match.'##';
409                 // The new id that we want to replace the old one with.
410                 $newid = '##gi'.$mappings[$match].'##';
411                 // Replace in the special mapping key
412                 $gradeitem->calculation = str_replace($oldid, $mapping, $gradeitem->calculation);
413                 // And record the mapping
414                 $calculationmap[$mapping] = $newid;
415                 $mapcount++;
416             }
417             // Iterate all special mappings for this calculation and replace in the new id's
418             foreach ($calculationmap as $mapping => $newid) {
419                 $gradeitem->calculation = str_replace($mapping, $newid, $gradeitem->calculation);
420             }
421             // Update the calculation now that its being remapped
422             $DB->update_record('grade_items', $gradeitem);
423         }
424         $rs->close();
426         // Need to correct the grade category path and parent
427         $conditions = array(
428             'courseid' => $this->get_courseid()
429         );
431         $rs = $DB->get_recordset('grade_categories', $conditions);
432         // Get all the parents correct first as grade_category::build_path() loads category parents from the DB
433         foreach ($rs as $gc) {
434             if (!empty($gc->parent)) {
435                 $grade_category = new stdClass();
436                 $grade_category->id = $gc->id;
437                 $grade_category->parent = $this->get_mappingid('grade_category', $gc->parent);
438                 $DB->update_record('grade_categories', $grade_category);
439             }
440         }
441         $rs->close();
443         // Now we can rebuild all the paths
444         $rs = $DB->get_recordset('grade_categories', $conditions);
445         foreach ($rs as $gc) {
446             $grade_category = new stdClass();
447             $grade_category->id = $gc->id;
448             $grade_category->path = grade_category::build_path($gc);
449             $grade_category->depth = substr_count($grade_category->path, '/') - 1;
450             $DB->update_record('grade_categories', $grade_category);
451         }
452         $rs->close();
454         // Restore marks items as needing update. Update everything now.
455         grade_regrade_final_grades($this->get_courseid());
456     }
459 /**
460  * Step in charge of restoring the grade history of a course.
461  *
462  * The execution conditions are itendical to {@link restore_gradebook_structure_step} because
463  * we do not want to restore the history if the gradebook and its content has not been
464  * restored. At least for now.
465  */
466 class restore_grade_history_structure_step extends restore_structure_step {
468      protected function execute_condition() {
469         global $CFG, $DB;
471         if ($this->get_courseid() == SITEID) {
472             return false;
473         }
475         // No gradebook info found, don't execute.
476         $fullpath = $this->task->get_taskbasepath();
477         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
478         if (!file_exists($fullpath)) {
479             return false;
480         }
482         // Some module present in backup file isn't available to restore in this site, don't execute.
483         if ($this->task->is_missing_modules()) {
484             return false;
485         }
487         // Some activity has been excluded to be restored, don't execute.
488         if ($this->task->is_excluding_activities()) {
489             return false;
490         }
492         // There should only be one grade category (the 1 associated with the course itself).
493         $category = new stdclass();
494         $category->courseid  = $this->get_courseid();
495         $catcount = $DB->count_records('grade_categories', (array)$category);
496         if ($catcount > 1) {
497             return false;
498         }
500         // Arrived here, execute the step.
501         return true;
502      }
504     protected function define_structure() {
505         $paths = array();
507         // Settings to use.
508         $userinfo = $this->get_setting_value('users');
509         $history = $this->get_setting_value('grade_histories');
511         if ($userinfo && $history) {
512             $paths[] = new restore_path_element('grade_grade',
513                '/grade_history/grade_grades/grade_grade');
514         }
516         return $paths;
517     }
519     protected function process_grade_grade($data) {
520         global $DB;
522         $data = (object)($data);
523         $olduserid = $data->userid;
524         unset($data->id);
526         $data->userid = $this->get_mappingid('user', $data->userid, null);
527         if (!empty($data->userid)) {
528             // Do not apply the date offsets as this is history.
529             $data->itemid = $this->get_mappingid('grade_item', $data->itemid);
530             $data->oldid = $this->get_mappingid('grade_grades', $data->oldid);
531             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
532             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
533             $DB->insert_record('grade_grades_history', $data);
534         } else {
535             $message = "Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'";
536             $this->log($message, backup::LOG_DEBUG);
537         }
538     }
542 /**
543  * decode all the interlinks present in restored content
544  * relying 100% in the restore_decode_processor that handles
545  * both the contents to modify and the rules to be applied
546  */
547 class restore_decode_interlinks extends restore_execution_step {
549     protected function define_execution() {
550         // Get the decoder (from the plan)
551         $decoder = $this->task->get_decoder();
552         restore_decode_processor::register_link_decoders($decoder); // Add decoder contents and rules
553         // And launch it, everything will be processed
554         $decoder->execute();
555     }
558 /**
559  * first, ensure that we have no gaps in section numbers
560  * and then, rebuid the course cache
561  */
562 class restore_rebuild_course_cache extends restore_execution_step {
564     protected function define_execution() {
565         global $DB;
567         // Although there is some sort of auto-recovery of missing sections
568         // present in course/formats... here we check that all the sections
569         // from 0 to MAX(section->section) exist, creating them if necessary
570         $maxsection = $DB->get_field('course_sections', 'MAX(section)', array('course' => $this->get_courseid()));
571         // Iterate over all sections
572         for ($i = 0; $i <= $maxsection; $i++) {
573             // If the section $i doesn't exist, create it
574             if (!$DB->record_exists('course_sections', array('course' => $this->get_courseid(), 'section' => $i))) {
575                 $sectionrec = array(
576                     'course' => $this->get_courseid(),
577                     'section' => $i);
578                 $DB->insert_record('course_sections', $sectionrec); // missing section created
579             }
580         }
582         // Rebuild cache now that all sections are in place
583         rebuild_course_cache($this->get_courseid());
584         cache_helper::purge_by_event('changesincourse');
585         cache_helper::purge_by_event('changesincoursecat');
586     }
589 /**
590  * Review all the tasks having one after_restore method
591  * executing it to perform some final adjustments of information
592  * not available when the task was executed.
593  */
594 class restore_execute_after_restore extends restore_execution_step {
596     protected function define_execution() {
598         // Simply call to the execute_after_restore() method of the task
599         // that always is the restore_final_task
600         $this->task->launch_execute_after_restore();
601     }
605 /**
606  * Review all the (pending) block positions in backup_ids, matching by
607  * contextid, creating positions as needed. This is executed by the
608  * final task, once all the contexts have been created
609  */
610 class restore_review_pending_block_positions extends restore_execution_step {
612     protected function define_execution() {
613         global $DB;
615         // Get all the block_position objects pending to match
616         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
617         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
618         // Process block positions, creating them or accumulating for final step
619         foreach($rs as $posrec) {
620             // Get the complete position object out of the info field.
621             $position = backup_controller_dbops::decode_backup_temp_info($posrec->info);
622             // If position is for one already mapped (known) contextid
623             // process it now, creating the position, else nothing to
624             // do, position finally discarded
625             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
626                 $position->contextid = $newctx->newitemid;
627                 // Create the block position
628                 $DB->insert_record('block_positions', $position);
629             }
630         }
631         $rs->close();
632     }
636 /**
637  * Updates the availability data for course modules and sections.
638  *
639  * Runs after the restore of all course modules, sections, and grade items has
640  * completed. This is necessary in order to update IDs that have changed during
641  * restore.
642  *
643  * @package core_backup
644  * @copyright 2014 The Open University
645  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
646  */
647 class restore_update_availability extends restore_execution_step {
649     protected function define_execution() {
650         global $CFG, $DB;
652         // Note: This code runs even if availability is disabled when restoring.
653         // That will ensure that if you later turn availability on for the site,
654         // there will be no incorrect IDs. (It doesn't take long if the restored
655         // data does not contain any availability information.)
657         // Get modinfo with all data after resetting cache.
658         rebuild_course_cache($this->get_courseid(), true);
659         $modinfo = get_fast_modinfo($this->get_courseid());
661         // Get the date offset for this restore.
662         $dateoffset = $this->apply_date_offset(1) - 1;
664         // Update all sections that were restored.
665         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'course_section');
666         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'newitemid');
667         $sectionsbyid = null;
668         foreach ($rs as $rec) {
669             if (is_null($sectionsbyid)) {
670                 $sectionsbyid = array();
671                 foreach ($modinfo->get_section_info_all() as $section) {
672                     $sectionsbyid[$section->id] = $section;
673                 }
674             }
675             if (!array_key_exists($rec->newitemid, $sectionsbyid)) {
676                 // If the section was not fully restored for some reason
677                 // (e.g. due to an earlier error), skip it.
678                 $this->get_logger()->process('Section not fully restored: id ' .
679                         $rec->newitemid, backup::LOG_WARNING);
680                 continue;
681             }
682             $section = $sectionsbyid[$rec->newitemid];
683             if (!is_null($section->availability)) {
684                 $info = new \core_availability\info_section($section);
685                 $info->update_after_restore($this->get_restoreid(),
686                         $this->get_courseid(), $this->get_logger(), $dateoffset);
687             }
688         }
689         $rs->close();
691         // Update all modules that were restored.
692         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'course_module');
693         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'newitemid');
694         foreach ($rs as $rec) {
695             if (!array_key_exists($rec->newitemid, $modinfo->cms)) {
696                 // If the module was not fully restored for some reason
697                 // (e.g. due to an earlier error), skip it.
698                 $this->get_logger()->process('Module not fully restored: id ' .
699                         $rec->newitemid, backup::LOG_WARNING);
700                 continue;
701             }
702             $cm = $modinfo->get_cm($rec->newitemid);
703             if (!is_null($cm->availability)) {
704                 $info = new \core_availability\info_module($cm);
705                 $info->update_after_restore($this->get_restoreid(),
706                         $this->get_courseid(), $this->get_logger(), $dateoffset);
707             }
708         }
709         $rs->close();
710     }
714 /**
715  * Process legacy module availability records in backup_ids.
716  *
717  * Matches course modules and grade item id once all them have been already restored.
718  * Only if all matchings are satisfied the availability condition will be created.
719  * At the same time, it is required for the site to have that functionality enabled.
720  *
721  * This step is included only to handle legacy backups (2.6 and before). It does not
722  * do anything for newer backups.
723  *
724  * @copyright 2014 The Open University
725  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
726  */
727 class restore_process_course_modules_availability extends restore_execution_step {
729     protected function define_execution() {
730         global $CFG, $DB;
732         // Site hasn't availability enabled
733         if (empty($CFG->enableavailability)) {
734             return;
735         }
737         // Do both modules and sections.
738         foreach (array('module', 'section') as $table) {
739             // Get all the availability objects to process.
740             $params = array('backupid' => $this->get_restoreid(), 'itemname' => $table . '_availability');
741             $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
742             // Process availabilities, creating them if everything matches ok.
743             foreach ($rs as $availrec) {
744                 $allmatchesok = true;
745                 // Get the complete legacy availability object.
746                 $availability = backup_controller_dbops::decode_backup_temp_info($availrec->info);
748                 // Note: This code used to update IDs, but that is now handled by the
749                 // current code (after restore) instead of this legacy code.
751                 // Get showavailability option.
752                 $thingid = ($table === 'module') ? $availability->coursemoduleid :
753                         $availability->coursesectionid;
754                 $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
755                         $table . '_showavailability', $thingid);
756                 if (!$showrec) {
757                     // Should not happen.
758                     throw new coding_exception('No matching showavailability record');
759                 }
760                 $show = $showrec->info->showavailability;
762                 // The $availability object is now in the format used in the old
763                 // system. Interpret this and convert to new system.
764                 $currentvalue = $DB->get_field('course_' . $table . 's', 'availability',
765                         array('id' => $thingid), MUST_EXIST);
766                 $newvalue = \core_availability\info::add_legacy_availability_condition(
767                         $currentvalue, $availability, $show);
768                 $DB->set_field('course_' . $table . 's', 'availability', $newvalue,
769                         array('id' => $thingid));
770             }
771         }
772         $rs->close();
773     }
777 /*
778  * Execution step that, *conditionally* (if there isn't preloaded information)
779  * will load the inforef files for all the included course/section/activity tasks
780  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
781  */
782 class restore_load_included_inforef_records extends restore_execution_step {
784     protected function define_execution() {
786         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
787             return;
788         }
790         // Get all the included tasks
791         $tasks = restore_dbops::get_included_tasks($this->get_restoreid());
792         $progress = $this->task->get_progress();
793         $progress->start_progress($this->get_name(), count($tasks));
794         foreach ($tasks as $task) {
795             // Load the inforef.xml file if exists
796             $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
797             if (file_exists($inforefpath)) {
798                 // Load each inforef file to temp_ids.
799                 restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $inforefpath, $progress);
800             }
801         }
802         $progress->end_progress();
803     }
806 /*
807  * Execution step that will load all the needed files into backup_files_temp
808  *   - info: contains the whole original object (times, names...)
809  * (all them being original ids as loaded from xml)
810  */
811 class restore_load_included_files extends restore_structure_step {
813     protected function define_structure() {
815         $file = new restore_path_element('file', '/files/file');
817         return array($file);
818     }
820     /**
821      * Process one <file> element from files.xml
822      *
823      * @param array $data the element data
824      */
825     public function process_file($data) {
827         $data = (object)$data; // handy
829         // load it if needed:
830         //   - it it is one of the annotated inforef files (course/section/activity/block)
831         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
832         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
833         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
834         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
835         $iscomponent = ($data->component == 'user' || $data->component == 'group' || $data->component == 'badges' ||
836                         $data->component == 'grouping' || $data->component == 'grade' ||
837                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
838         if ($isfileref || $iscomponent) {
839             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
840         }
841     }
844 /**
845  * Execution step that, *conditionally* (if there isn't preloaded information),
846  * will load all the needed roles to backup_temp_ids. They will be stored with
847  * "role" itemname. Also it will perform one automatic mapping to roles existing
848  * in the target site, based in permissions of the user performing the restore,
849  * archetypes and other bits. At the end, each original role will have its associated
850  * target role or 0 if it's going to be skipped. Note we wrap everything over one
851  * restore_dbops method, as far as the same stuff is going to be also executed
852  * by restore prechecks
853  */
854 class restore_load_and_map_roles extends restore_execution_step {
856     protected function define_execution() {
857         if ($this->task->get_preloaded_information()) { // if info is already preloaded
858             return;
859         }
861         $file = $this->get_basepath() . '/roles.xml';
862         // Load needed toles to temp_ids
863         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
865         // Process roles, mapping/skipping. Any error throws exception
866         // Note we pass controller's info because it can contain role mapping information
867         // about manual mappings performed by UI
868         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);
869     }
872 /**
873  * Execution step that, *conditionally* (if there isn't preloaded information
874  * and users have been selected in settings, will load all the needed users
875  * to backup_temp_ids. They will be stored with "user" itemname and with
876  * their original contextid as paremitemid
877  */
878 class restore_load_included_users extends restore_execution_step {
880     protected function define_execution() {
882         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
883             return;
884         }
885         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
886             return;
887         }
888         $file = $this->get_basepath() . '/users.xml';
889         // Load needed users to temp_ids.
890         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file, $this->task->get_progress());
891     }
894 /**
895  * Execution step that, *conditionally* (if there isn't preloaded information
896  * and users have been selected in settings, will process all the needed users
897  * in order to decide and perform any action with them (create / map / error)
898  * Note: Any error will cause exception, as far as this is the same processing
899  * than the one into restore prechecks (that should have stopped process earlier)
900  */
901 class restore_process_included_users extends restore_execution_step {
903     protected function define_execution() {
905         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
906             return;
907         }
908         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
909             return;
910         }
911         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(),
912                 $this->task->get_userid(), $this->task->is_samesite(), $this->task->get_progress());
913     }
916 /**
917  * Execution step that will create all the needed users as calculated
918  * by @restore_process_included_users (those having newiteind = 0)
919  */
920 class restore_create_included_users extends restore_execution_step {
922     protected function define_execution() {
924         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(),
925                 $this->task->get_userid(), $this->task->get_progress());
926     }
929 /**
930  * Structure step that will create all the needed groups and groupings
931  * by loading them from the groups.xml file performing the required matches.
932  * Note group members only will be added if restoring user info
933  */
934 class restore_groups_structure_step extends restore_structure_step {
936     protected function define_structure() {
938         $paths = array(); // Add paths here
940         $paths[] = new restore_path_element('group', '/groups/group');
941         $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
942         $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
944         return $paths;
945     }
947     // Processing functions go here
948     public function process_group($data) {
949         global $DB;
951         $data = (object)$data; // handy
952         $data->courseid = $this->get_courseid();
954         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
955         // another a group in the same course
956         $context = context_course::instance($data->courseid);
957         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
958             if (groups_get_group_by_idnumber($data->courseid, $data->idnumber)) {
959                 unset($data->idnumber);
960             }
961         } else {
962             unset($data->idnumber);
963         }
965         $oldid = $data->id;    // need this saved for later
967         $restorefiles = false; // Only if we end creating the group
969         // Search if the group already exists (by name & description) in the target course
970         $description_clause = '';
971         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
972         if (!empty($data->description)) {
973             $description_clause = ' AND ' .
974                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
975            $params['description'] = $data->description;
976         }
977         if (!$groupdb = $DB->get_record_sql("SELECT *
978                                                FROM {groups}
979                                               WHERE courseid = :courseid
980                                                 AND name = :grname $description_clause", $params)) {
981             // group doesn't exist, create
982             $newitemid = $DB->insert_record('groups', $data);
983             $restorefiles = true; // We'll restore the files
984         } else {
985             // group exists, use it
986             $newitemid = $groupdb->id;
987         }
988         // Save the id mapping
989         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
990         // Invalidate the course group data cache just in case.
991         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
992     }
994     public function process_grouping($data) {
995         global $DB;
997         $data = (object)$data; // handy
998         $data->courseid = $this->get_courseid();
1000         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1001         // another a grouping in the same course
1002         $context = context_course::instance($data->courseid);
1003         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1004             if (groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) {
1005                 unset($data->idnumber);
1006             }
1007         } else {
1008             unset($data->idnumber);
1009         }
1011         $oldid = $data->id;    // need this saved for later
1012         $restorefiles = false; // Only if we end creating the grouping
1014         // Search if the grouping already exists (by name & description) in the target course
1015         $description_clause = '';
1016         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
1017         if (!empty($data->description)) {
1018             $description_clause = ' AND ' .
1019                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
1020            $params['description'] = $data->description;
1021         }
1022         if (!$groupingdb = $DB->get_record_sql("SELECT *
1023                                                   FROM {groupings}
1024                                                  WHERE courseid = :courseid
1025                                                    AND name = :grname $description_clause", $params)) {
1026             // grouping doesn't exist, create
1027             $newitemid = $DB->insert_record('groupings', $data);
1028             $restorefiles = true; // We'll restore the files
1029         } else {
1030             // grouping exists, use it
1031             $newitemid = $groupingdb->id;
1032         }
1033         // Save the id mapping
1034         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
1035         // Invalidate the course group data cache just in case.
1036         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
1037     }
1039     public function process_grouping_group($data) {
1040         global $CFG;
1042         require_once($CFG->dirroot.'/group/lib.php');
1044         $data = (object)$data;
1045         groups_assign_grouping($this->get_new_parentid('grouping'), $this->get_mappingid('group', $data->groupid), $data->timeadded);
1046     }
1048     protected function after_execute() {
1049         // Add group related files, matching with "group" mappings
1050         $this->add_related_files('group', 'icon', 'group');
1051         $this->add_related_files('group', 'description', 'group');
1052         // Add grouping related files, matching with "grouping" mappings
1053         $this->add_related_files('grouping', 'description', 'grouping');
1054         // Invalidate the course group data.
1055         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($this->get_courseid()));
1056     }
1060 /**
1061  * Structure step that will create all the needed group memberships
1062  * by loading them from the groups.xml file performing the required matches.
1063  */
1064 class restore_groups_members_structure_step extends restore_structure_step {
1066     protected $plugins = null;
1068     protected function define_structure() {
1070         $paths = array(); // Add paths here
1072         if ($this->get_setting_value('users')) {
1073             $paths[] = new restore_path_element('group', '/groups/group');
1074             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
1075         }
1077         return $paths;
1078     }
1080     public function process_group($data) {
1081         $data = (object)$data; // handy
1083         // HACK ALERT!
1084         // Not much to do here, this groups mapping should be already done from restore_groups_structure_step.
1085         // Let's fake internal state to make $this->get_new_parentid('group') work.
1087         $this->set_mapping('group', $data->id, $this->get_mappingid('group', $data->id));
1088     }
1090     public function process_member($data) {
1091         global $DB, $CFG;
1092         require_once("$CFG->dirroot/group/lib.php");
1094         // NOTE: Always use groups_add_member() because it triggers events and verifies if user is enrolled.
1096         $data = (object)$data; // handy
1098         // get parent group->id
1099         $data->groupid = $this->get_new_parentid('group');
1101         // map user newitemid and insert if not member already
1102         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
1103             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
1104                 // Check the component, if any, exists.
1105                 if (empty($data->component)) {
1106                     groups_add_member($data->groupid, $data->userid);
1108                 } else if ((strpos($data->component, 'enrol_') === 0)) {
1109                     // Deal with enrolment groups - ignore the component and just find out the instance via new id,
1110                     // it is possible that enrolment was restored using different plugin type.
1111                     if (!isset($this->plugins)) {
1112                         $this->plugins = enrol_get_plugins(true);
1113                     }
1114                     if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1115                         if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1116                             if (isset($this->plugins[$instance->enrol])) {
1117                                 $this->plugins[$instance->enrol]->restore_group_member($instance, $data->groupid, $data->userid);
1118                             }
1119                         }
1120                     }
1122                 } else {
1123                     $dir = core_component::get_component_directory($data->component);
1124                     if ($dir and is_dir($dir)) {
1125                         if (component_callback($data->component, 'restore_group_member', array($this, $data), true)) {
1126                             return;
1127                         }
1128                     }
1129                     // Bad luck, plugin could not restore the data, let's add normal membership.
1130                     groups_add_member($data->groupid, $data->userid);
1131                     $message = "Restore of '$data->component/$data->itemid' group membership is not supported, using standard group membership instead.";
1132                     $this->log($message, backup::LOG_WARNING);
1133                 }
1134             }
1135         }
1136     }
1139 /**
1140  * Structure step that will create all the needed scales
1141  * by loading them from the scales.xml
1142  */
1143 class restore_scales_structure_step extends restore_structure_step {
1145     protected function define_structure() {
1147         $paths = array(); // Add paths here
1148         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
1149         return $paths;
1150     }
1152     protected function process_scale($data) {
1153         global $DB;
1155         $data = (object)$data;
1157         $restorefiles = false; // Only if we end creating the group
1159         $oldid = $data->id;    // need this saved for later
1161         // Look for scale (by 'scale' both in standard (course=0) and current course
1162         // with priority to standard scales (ORDER clause)
1163         // scale is not course unique, use get_record_sql to suppress warning
1164         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
1165         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
1166         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
1167         if (!$scadb = $DB->get_record_sql("SELECT *
1168                                             FROM {scale}
1169                                            WHERE courseid IN (0, :courseid)
1170                                              AND $compare_scale_clause
1171                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
1172             // Remap the user if possible, defaut to user performing the restore if not
1173             $userid = $this->get_mappingid('user', $data->userid);
1174             $data->userid = $userid ? $userid : $this->task->get_userid();
1175             // Remap the course if course scale
1176             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
1177             // If global scale (course=0), check the user has perms to create it
1178             // falling to course scale if not
1179             $systemctx = context_system::instance();
1180             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
1181                 $data->courseid = $this->get_courseid();
1182             }
1183             // scale doesn't exist, create
1184             $newitemid = $DB->insert_record('scale', $data);
1185             $restorefiles = true; // We'll restore the files
1186         } else {
1187             // scale exists, use it
1188             $newitemid = $scadb->id;
1189         }
1190         // Save the id mapping (with files support at system context)
1191         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1192     }
1194     protected function after_execute() {
1195         // Add scales related files, matching with "scale" mappings
1196         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
1197     }
1201 /**
1202  * Structure step that will create all the needed outocomes
1203  * by loading them from the outcomes.xml
1204  */
1205 class restore_outcomes_structure_step extends restore_structure_step {
1207     protected function define_structure() {
1209         $paths = array(); // Add paths here
1210         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
1211         return $paths;
1212     }
1214     protected function process_outcome($data) {
1215         global $DB;
1217         $data = (object)$data;
1219         $restorefiles = false; // Only if we end creating the group
1221         $oldid = $data->id;    // need this saved for later
1223         // Look for outcome (by shortname both in standard (courseid=null) and current course
1224         // with priority to standard outcomes (ORDER clause)
1225         // outcome is not course unique, use get_record_sql to suppress warning
1226         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
1227         if (!$outdb = $DB->get_record_sql('SELECT *
1228                                              FROM {grade_outcomes}
1229                                             WHERE shortname = :shortname
1230                                               AND (courseid = :courseid OR courseid IS NULL)
1231                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
1232             // Remap the user
1233             $userid = $this->get_mappingid('user', $data->usermodified);
1234             $data->usermodified = $userid ? $userid : $this->task->get_userid();
1235             // Remap the scale
1236             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
1237             // Remap the course if course outcome
1238             $data->courseid = $data->courseid ? $this->get_courseid() : null;
1239             // If global outcome (course=null), check the user has perms to create it
1240             // falling to course outcome if not
1241             $systemctx = context_system::instance();
1242             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
1243                 $data->courseid = $this->get_courseid();
1244             }
1245             // outcome doesn't exist, create
1246             $newitemid = $DB->insert_record('grade_outcomes', $data);
1247             $restorefiles = true; // We'll restore the files
1248         } else {
1249             // scale exists, use it
1250             $newitemid = $outdb->id;
1251         }
1252         // Set the corresponding grade_outcomes_courses record
1253         $outcourserec = new stdclass();
1254         $outcourserec->courseid  = $this->get_courseid();
1255         $outcourserec->outcomeid = $newitemid;
1256         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
1257             $DB->insert_record('grade_outcomes_courses', $outcourserec);
1258         }
1259         // Save the id mapping (with files support at system context)
1260         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1261     }
1263     protected function after_execute() {
1264         // Add outcomes related files, matching with "outcome" mappings
1265         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
1266     }
1269 /**
1270  * Execution step that, *conditionally* (if there isn't preloaded information
1271  * will load all the question categories and questions (header info only)
1272  * to backup_temp_ids. They will be stored with "question_category" and
1273  * "question" itemnames and with their original contextid and question category
1274  * id as paremitemids
1275  */
1276 class restore_load_categories_and_questions extends restore_execution_step {
1278     protected function define_execution() {
1280         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1281             return;
1282         }
1283         $file = $this->get_basepath() . '/questions.xml';
1284         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
1285     }
1288 /**
1289  * Execution step that, *conditionally* (if there isn't preloaded information)
1290  * will process all the needed categories and questions
1291  * in order to decide and perform any action with them (create / map / error)
1292  * Note: Any error will cause exception, as far as this is the same processing
1293  * than the one into restore prechecks (that should have stopped process earlier)
1294  */
1295 class restore_process_categories_and_questions extends restore_execution_step {
1297     protected function define_execution() {
1299         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1300             return;
1301         }
1302         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
1303     }
1306 /**
1307  * Structure step that will read the section.xml creating/updating sections
1308  * as needed, rebuilding course cache and other friends
1309  */
1310 class restore_section_structure_step extends restore_structure_step {
1312     protected function define_structure() {
1313         global $CFG;
1315         $paths = array();
1317         $section = new restore_path_element('section', '/section');
1318         $paths[] = $section;
1319         if ($CFG->enableavailability) {
1320             $paths[] = new restore_path_element('availability', '/section/availability');
1321             $paths[] = new restore_path_element('availability_field', '/section/availability_field');
1322         }
1323         $paths[] = new restore_path_element('course_format_options', '/section/course_format_options');
1325         // Apply for 'format' plugins optional paths at section level
1326         $this->add_plugin_structure('format', $section);
1328         // Apply for 'local' plugins optional paths at section level
1329         $this->add_plugin_structure('local', $section);
1331         return $paths;
1332     }
1334     public function process_section($data) {
1335         global $CFG, $DB;
1336         $data = (object)$data;
1337         $oldid = $data->id; // We'll need this later
1339         $restorefiles = false;
1341         // Look for the section
1342         $section = new stdclass();
1343         $section->course  = $this->get_courseid();
1344         $section->section = $data->number;
1345         // Section doesn't exist, create it with all the info from backup
1346         if (!$secrec = $DB->get_record('course_sections', (array)$section)) {
1347             $section->name = $data->name;
1348             $section->summary = $data->summary;
1349             $section->summaryformat = $data->summaryformat;
1350             $section->sequence = '';
1351             $section->visible = $data->visible;
1352             if (empty($CFG->enableavailability)) { // Process availability information only if enabled.
1353                 $section->availability = null;
1354             } else {
1355                 $section->availability = isset($data->availabilityjson) ? $data->availabilityjson : null;
1356                 // Include legacy [<2.7] availability data if provided.
1357                 if (is_null($section->availability)) {
1358                     $section->availability = \core_availability\info::convert_legacy_fields(
1359                             $data, true);
1360                 }
1361             }
1362             $newitemid = $DB->insert_record('course_sections', $section);
1363             $restorefiles = true;
1365         // Section exists, update non-empty information
1366         } else {
1367             $section->id = $secrec->id;
1368             if ((string)$secrec->name === '') {
1369                 $section->name = $data->name;
1370             }
1371             if (empty($secrec->summary)) {
1372                 $section->summary = $data->summary;
1373                 $section->summaryformat = $data->summaryformat;
1374                 $restorefiles = true;
1375             }
1377             // Don't update availability (I didn't see a useful way to define
1378             // whether existing or new one should take precedence).
1380             $DB->update_record('course_sections', $section);
1381             $newitemid = $secrec->id;
1382         }
1384         // Annotate the section mapping, with restorefiles option if needed
1385         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
1387         // set the new course_section id in the task
1388         $this->task->set_sectionid($newitemid);
1390         // If there is the legacy showavailability data, store this for later use.
1391         // (This data is not present when restoring 'new' backups.)
1392         if (isset($data->showavailability)) {
1393             // Cache the showavailability flag using the backup_ids data field.
1394             restore_dbops::set_backup_ids_record($this->get_restoreid(),
1395                     'section_showavailability', $newitemid, 0, null,
1396                     (object)array('showavailability' => $data->showavailability));
1397         }
1399         // Commented out. We never modify course->numsections as far as that is used
1400         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
1401         // Note: We keep the code here, to know about and because of the possibility of making this
1402         // optional based on some setting/attribute in the future
1403         // If needed, adjust course->numsections
1404         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
1405         //    if ($numsections < $section->section) {
1406         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
1407         //    }
1408         //}
1409     }
1411     /**
1412      * Process the legacy availability table record. This table does not exist
1413      * in Moodle 2.7+ but we still support restore.
1414      *
1415      * @param stdClass $data Record data
1416      */
1417     public function process_availability($data) {
1418         $data = (object)$data;
1419         // Simply going to store the whole availability record now, we'll process
1420         // all them later in the final task (once all activities have been restored)
1421         // Let's call the low level one to be able to store the whole object.
1422         $data->coursesectionid = $this->task->get_sectionid();
1423         restore_dbops::set_backup_ids_record($this->get_restoreid(),
1424                 'section_availability', $data->id, 0, null, $data);
1425     }
1427     /**
1428      * Process the legacy availability fields table record. This table does not
1429      * exist in Moodle 2.7+ but we still support restore.
1430      *
1431      * @param stdClass $data Record data
1432      */
1433     public function process_availability_field($data) {
1434         global $DB;
1435         $data = (object)$data;
1436         // Mark it is as passed by default
1437         $passed = true;
1438         $customfieldid = null;
1440         // If a customfield has been used in order to pass we must be able to match an existing
1441         // customfield by name (data->customfield) and type (data->customfieldtype)
1442         if (is_null($data->customfield) xor is_null($data->customfieldtype)) {
1443             // xor is sort of uncommon. If either customfield is null or customfieldtype is null BUT not both.
1444             // If one is null but the other isn't something clearly went wrong and we'll skip this condition.
1445             $passed = false;
1446         } else if (!is_null($data->customfield)) {
1447             $params = array('shortname' => $data->customfield, 'datatype' => $data->customfieldtype);
1448             $customfieldid = $DB->get_field('user_info_field', 'id', $params);
1449             $passed = ($customfieldid !== false);
1450         }
1452         if ($passed) {
1453             // Create the object to insert into the database
1454             $availfield = new stdClass();
1455             $availfield->coursesectionid = $this->task->get_sectionid();
1456             $availfield->userfield = $data->userfield;
1457             $availfield->customfieldid = $customfieldid;
1458             $availfield->operator = $data->operator;
1459             $availfield->value = $data->value;
1461             // Get showavailability option.
1462             $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
1463                     'section_showavailability', $availfield->coursesectionid);
1464             if (!$showrec) {
1465                 // Should not happen.
1466                 throw new coding_exception('No matching showavailability record');
1467             }
1468             $show = $showrec->info->showavailability;
1470             // The $availfield object is now in the format used in the old
1471             // system. Interpret this and convert to new system.
1472             $currentvalue = $DB->get_field('course_sections', 'availability',
1473                     array('id' => $availfield->coursesectionid), MUST_EXIST);
1474             $newvalue = \core_availability\info::add_legacy_availability_field_condition(
1475                     $currentvalue, $availfield, $show);
1476             $DB->set_field('course_sections', 'availability', $newvalue,
1477                     array('id' => $availfield->coursesectionid));
1478         }
1479     }
1481     public function process_course_format_options($data) {
1482         global $DB;
1483         $data = (object)$data;
1484         $oldid = $data->id;
1485         unset($data->id);
1486         $data->sectionid = $this->task->get_sectionid();
1487         $data->courseid = $this->get_courseid();
1488         $newid = $DB->insert_record('course_format_options', $data);
1489         $this->set_mapping('course_format_options', $oldid, $newid);
1490     }
1492     protected function after_execute() {
1493         // Add section related files, with 'course_section' itemid to match
1494         $this->add_related_files('course', 'section', 'course_section');
1495     }
1498 /**
1499  * Structure step that will read the course.xml file, loading it and performing
1500  * various actions depending of the site/restore settings. Note that target
1501  * course always exist before arriving here so this step will be updating
1502  * the course record (never inserting)
1503  */
1504 class restore_course_structure_step extends restore_structure_step {
1505     /**
1506      * @var bool this gets set to true by {@link process_course()} if we are
1507      * restoring an old coures that used the legacy 'module security' feature.
1508      * If so, we have to do more work in {@link after_execute()}.
1509      */
1510     protected $legacyrestrictmodules = false;
1512     /**
1513      * @var array Used when {@link $legacyrestrictmodules} is true. This is an
1514      * array with array keys the module names ('forum', 'quiz', etc.). These are
1515      * the modules that are allowed according to the data in the backup file.
1516      * In {@link after_execute()} we then have to prevent adding of all the other
1517      * types of activity.
1518      */
1519     protected $legacyallowedmodules = array();
1521     protected function define_structure() {
1523         $course = new restore_path_element('course', '/course');
1524         $category = new restore_path_element('category', '/course/category');
1525         $tag = new restore_path_element('tag', '/course/tags/tag');
1526         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1528         // Apply for 'format' plugins optional paths at course level
1529         $this->add_plugin_structure('format', $course);
1531         // Apply for 'theme' plugins optional paths at course level
1532         $this->add_plugin_structure('theme', $course);
1534         // Apply for 'report' plugins optional paths at course level
1535         $this->add_plugin_structure('report', $course);
1537         // Apply for 'course report' plugins optional paths at course level
1538         $this->add_plugin_structure('coursereport', $course);
1540         // Apply for plagiarism plugins optional paths at course level
1541         $this->add_plugin_structure('plagiarism', $course);
1543         // Apply for local plugins optional paths at course level
1544         $this->add_plugin_structure('local', $course);
1546         return array($course, $category, $tag, $allowed_module);
1547     }
1549     /**
1550      * Processing functions go here
1551      *
1552      * @global moodledatabase $DB
1553      * @param stdClass $data
1554      */
1555     public function process_course($data) {
1556         global $CFG, $DB;
1558         $data = (object)$data;
1560         $fullname  = $this->get_setting_value('course_fullname');
1561         $shortname = $this->get_setting_value('course_shortname');
1562         $startdate = $this->get_setting_value('course_startdate');
1564         // Calculate final course names, to avoid dupes
1565         list($fullname, $shortname) = restore_dbops::calculate_course_names($this->get_courseid(), $fullname, $shortname);
1567         // Need to change some fields before updating the course record
1568         $data->id = $this->get_courseid();
1569         $data->fullname = $fullname;
1570         $data->shortname= $shortname;
1572         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1573         // another course on this site.
1574         $context = context::instance_by_id($this->task->get_contextid());
1575         if (!empty($data->idnumber) && has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid()) &&
1576                 $this->task->is_samesite() && !$DB->record_exists('course', array('idnumber' => $data->idnumber))) {
1577             // Do not reset idnumber.
1578         } else {
1579             $data->idnumber = '';
1580         }
1582         // Any empty value for course->hiddensections will lead to 0 (default, show collapsed).
1583         // It has been reported that some old 1.9 courses may have it null leading to DB error. MDL-31532
1584         if (empty($data->hiddensections)) {
1585             $data->hiddensections = 0;
1586         }
1588         // Set legacyrestrictmodules to true if the course was resticting modules. If so
1589         // then we will need to process restricted modules after execution.
1590         $this->legacyrestrictmodules = !empty($data->restrictmodules);
1592         $data->startdate= $this->apply_date_offset($data->startdate);
1593         if ($data->defaultgroupingid) {
1594             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1595         }
1596         if (empty($CFG->enablecompletion)) {
1597             $data->enablecompletion = 0;
1598             $data->completionstartonenrol = 0;
1599             $data->completionnotify = 0;
1600         }
1601         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1602         if (!array_key_exists($data->lang, $languages)) {
1603             $data->lang = '';
1604         }
1606         $themes = get_list_of_themes(); // Get themes for quick search later
1607         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1608             $data->theme = '';
1609         }
1611         // Check if this is an old SCORM course format.
1612         if ($data->format == 'scorm') {
1613             $data->format = 'singleactivity';
1614             $data->activitytype = 'scorm';
1615         }
1617         // Course record ready, update it
1618         $DB->update_record('course', $data);
1620         course_get_format($data)->update_course_format_options($data);
1622         // Role name aliases
1623         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1624     }
1626     public function process_category($data) {
1627         // Nothing to do with the category. UI sets it before restore starts
1628     }
1630     public function process_tag($data) {
1631         global $CFG, $DB;
1633         $data = (object)$data;
1635         if (!empty($CFG->usetags)) { // if enabled in server
1636             // TODO: This is highly inneficient. Each time we add one tag
1637             // we fetch all the existing because tag_set() deletes them
1638             // so everything must be reinserted on each call
1639             $tags = array();
1640             $existingtags = tag_get_tags('course', $this->get_courseid());
1641             // Re-add all the existitng tags
1642             foreach ($existingtags as $existingtag) {
1643                 $tags[] = $existingtag->rawname;
1644             }
1645             // Add the one being restored
1646             $tags[] = $data->rawname;
1647             // Send all the tags back to the course
1648             tag_set('course', $this->get_courseid(), $tags, 'core',
1649                 context_course::instance($this->get_courseid())->id);
1650         }
1651     }
1653     public function process_allowed_module($data) {
1654         $data = (object)$data;
1656         // Backwards compatiblity support for the data that used to be in the
1657         // course_allowed_modules table.
1658         if ($this->legacyrestrictmodules) {
1659             $this->legacyallowedmodules[$data->modulename] = 1;
1660         }
1661     }
1663     protected function after_execute() {
1664         global $DB;
1666         // Add course related files, without itemid to match
1667         $this->add_related_files('course', 'summary', null);
1668         $this->add_related_files('course', 'overviewfiles', null);
1670         // Deal with legacy allowed modules.
1671         if ($this->legacyrestrictmodules) {
1672             $context = context_course::instance($this->get_courseid());
1674             list($roleids) = get_roles_with_cap_in_context($context, 'moodle/course:manageactivities');
1675             list($managerroleids) = get_roles_with_cap_in_context($context, 'moodle/site:config');
1676             foreach ($managerroleids as $roleid) {
1677                 unset($roleids[$roleid]);
1678             }
1680             foreach (core_component::get_plugin_list('mod') as $modname => $notused) {
1681                 if (isset($this->legacyallowedmodules[$modname])) {
1682                     // Module is allowed, no worries.
1683                     continue;
1684                 }
1686                 $capability = 'mod/' . $modname . ':addinstance';
1687                 foreach ($roleids as $roleid) {
1688                     assign_capability($capability, CAP_PREVENT, $roleid, $context);
1689                 }
1690             }
1691         }
1692     }
1695 /**
1696  * Execution step that will migrate legacy files if present.
1697  */
1698 class restore_course_legacy_files_step extends restore_execution_step {
1699     public function define_execution() {
1700         global $DB;
1702         // Do a check for legacy files and skip if there are none.
1703         $sql = 'SELECT count(*)
1704                   FROM {backup_files_temp}
1705                  WHERE backupid = ?
1706                    AND contextid = ?
1707                    AND component = ?
1708                    AND filearea  = ?';
1709         $params = array($this->get_restoreid(), $this->task->get_old_contextid(), 'course', 'legacy');
1711         if ($DB->count_records_sql($sql, $params)) {
1712             $DB->set_field('course', 'legacyfiles', 2, array('id' => $this->get_courseid()));
1713             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'course',
1714                 'legacy', $this->task->get_old_contextid(), $this->task->get_userid());
1715         }
1716     }
1719 /*
1720  * Structure step that will read the roles.xml file (at course/activity/block levels)
1721  * containing all the role_assignments and overrides for that context. If corresponding to
1722  * one mapped role, they will be applied to target context. Will observe the role_assignments
1723  * setting to decide if ras are restored.
1724  *
1725  * Note: this needs to be executed after all users are enrolled.
1726  */
1727 class restore_ras_and_caps_structure_step extends restore_structure_step {
1728     protected $plugins = null;
1730     protected function define_structure() {
1732         $paths = array();
1734         // Observe the role_assignments setting
1735         if ($this->get_setting_value('role_assignments')) {
1736             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
1737         }
1738         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
1740         return $paths;
1741     }
1743     /**
1744      * Assign roles
1745      *
1746      * This has to be called after enrolments processing.
1747      *
1748      * @param mixed $data
1749      * @return void
1750      */
1751     public function process_assignment($data) {
1752         global $DB;
1754         $data = (object)$data;
1756         // Check roleid, userid are one of the mapped ones
1757         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
1758             return;
1759         }
1760         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
1761             return;
1762         }
1763         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
1764             // Only assign roles to not deleted users
1765             return;
1766         }
1767         if (!$contextid = $this->task->get_contextid()) {
1768             return;
1769         }
1771         if (empty($data->component)) {
1772             // assign standard manual roles
1773             // TODO: role_assign() needs one userid param to be able to specify our restore userid
1774             role_assign($newroleid, $newuserid, $contextid);
1776         } else if ((strpos($data->component, 'enrol_') === 0)) {
1777             // Deal with enrolment roles - ignore the component and just find out the instance via new id,
1778             // it is possible that enrolment was restored using different plugin type.
1779             if (!isset($this->plugins)) {
1780                 $this->plugins = enrol_get_plugins(true);
1781             }
1782             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1783                 if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1784                     if (isset($this->plugins[$instance->enrol])) {
1785                         $this->plugins[$instance->enrol]->restore_role_assignment($instance, $newroleid, $newuserid, $contextid);
1786                     }
1787                 }
1788             }
1790         } else {
1791             $data->roleid    = $newroleid;
1792             $data->userid    = $newuserid;
1793             $data->contextid = $contextid;
1794             $dir = core_component::get_component_directory($data->component);
1795             if ($dir and is_dir($dir)) {
1796                 if (component_callback($data->component, 'restore_role_assignment', array($this, $data), true)) {
1797                     return;
1798                 }
1799             }
1800             // Bad luck, plugin could not restore the data, let's add normal membership.
1801             role_assign($data->roleid, $data->userid, $data->contextid);
1802             $message = "Restore of '$data->component/$data->itemid' role assignments is not supported, using manual role assignments instead.";
1803             $this->log($message, backup::LOG_WARNING);
1804         }
1805     }
1807     public function process_override($data) {
1808         $data = (object)$data;
1810         // Check roleid is one of the mapped ones
1811         $newroleid = $this->get_mappingid('role', $data->roleid);
1812         // If newroleid and context are valid assign it via API (it handles dupes and so on)
1813         if ($newroleid && $this->task->get_contextid()) {
1814             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
1815             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
1816             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
1817         }
1818     }
1821 /**
1822  * If no instances yet add default enrol methods the same way as when creating new course in UI.
1823  */
1824 class restore_default_enrolments_step extends restore_execution_step {
1826     public function define_execution() {
1827         global $DB;
1829         // No enrolments in front page.
1830         if ($this->get_courseid() == SITEID) {
1831             return;
1832         }
1834         $course = $DB->get_record('course', array('id'=>$this->get_courseid()), '*', MUST_EXIST);
1836         if ($DB->record_exists('enrol', array('courseid'=>$this->get_courseid(), 'enrol'=>'manual'))) {
1837             // Something already added instances, do not add default instances.
1838             $plugins = enrol_get_plugins(true);
1839             foreach ($plugins as $plugin) {
1840                 $plugin->restore_sync_course($course);
1841             }
1843         } else {
1844             // Looks like a newly created course.
1845             enrol_course_updated(true, $course, null);
1846         }
1847     }
1850 /**
1851  * This structure steps restores the enrol plugins and their underlying
1852  * enrolments, performing all the mappings and/or movements required
1853  */
1854 class restore_enrolments_structure_step extends restore_structure_step {
1855     protected $enrolsynced = false;
1856     protected $plugins = null;
1857     protected $originalstatus = array();
1859     /**
1860      * Conditionally decide if this step should be executed.
1861      *
1862      * This function checks the following parameter:
1863      *
1864      *   1. the course/enrolments.xml file exists
1865      *
1866      * @return bool true is safe to execute, false otherwise
1867      */
1868     protected function execute_condition() {
1870         if ($this->get_courseid() == SITEID) {
1871             return false;
1872         }
1874         // Check it is included in the backup
1875         $fullpath = $this->task->get_taskbasepath();
1876         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1877         if (!file_exists($fullpath)) {
1878             // Not found, can't restore enrolments info
1879             return false;
1880         }
1882         return true;
1883     }
1885     protected function define_structure() {
1887         $paths = array();
1889         $paths[] = new restore_path_element('enrol', '/enrolments/enrols/enrol');
1890         $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
1892         return $paths;
1893     }
1895     /**
1896      * Create enrolment instances.
1897      *
1898      * This has to be called after creation of roles
1899      * and before adding of role assignments.
1900      *
1901      * @param mixed $data
1902      * @return void
1903      */
1904     public function process_enrol($data) {
1905         global $DB;
1907         $data = (object)$data;
1908         $oldid = $data->id; // We'll need this later.
1909         unset($data->id);
1911         $this->originalstatus[$oldid] = $data->status;
1913         if (!$courserec = $DB->get_record('course', array('id' => $this->get_courseid()))) {
1914             $this->set_mapping('enrol', $oldid, 0);
1915             return;
1916         }
1918         if (!isset($this->plugins)) {
1919             $this->plugins = enrol_get_plugins(true);
1920         }
1922         if (!$this->enrolsynced) {
1923             // Make sure that all plugin may create instances and enrolments automatically
1924             // before the first instance restore - this is suitable especially for plugins
1925             // that synchronise data automatically using course->idnumber or by course categories.
1926             foreach ($this->plugins as $plugin) {
1927                 $plugin->restore_sync_course($courserec);
1928             }
1929             $this->enrolsynced = true;
1930         }
1932         // Map standard fields - plugin has to process custom fields manually.
1933         $data->roleid   = $this->get_mappingid('role', $data->roleid);
1934         $data->courseid = $courserec->id;
1936         if ($this->get_setting_value('enrol_migratetomanual')) {
1937             unset($data->sortorder); // Remove useless sortorder from <2.4 backups.
1938             if (!enrol_is_enabled('manual')) {
1939                 $this->set_mapping('enrol', $oldid, 0);
1940                 return;
1941             }
1942             if ($instances = $DB->get_records('enrol', array('courseid'=>$data->courseid, 'enrol'=>'manual'), 'id')) {
1943                 $instance = reset($instances);
1944                 $this->set_mapping('enrol', $oldid, $instance->id);
1945             } else {
1946                 if ($data->enrol === 'manual') {
1947                     $instanceid = $this->plugins['manual']->add_instance($courserec, (array)$data);
1948                 } else {
1949                     $instanceid = $this->plugins['manual']->add_default_instance($courserec);
1950                 }
1951                 $this->set_mapping('enrol', $oldid, $instanceid);
1952             }
1954         } else {
1955             if (!enrol_is_enabled($data->enrol) or !isset($this->plugins[$data->enrol])) {
1956                 $this->set_mapping('enrol', $oldid, 0);
1957                 $message = "Enrol plugin '$data->enrol' data can not be restored because it is not enabled, use migration to manual enrolments";
1958                 $this->log($message, backup::LOG_WARNING);
1959                 return;
1960             }
1961             if ($task = $this->get_task() and $task->get_target() == backup::TARGET_NEW_COURSE) {
1962                 // Let's keep the sortorder in old backups.
1963             } else {
1964                 // Prevent problems with colliding sortorders in old backups,
1965                 // new 2.4 backups do not need sortorder because xml elements are ordered properly.
1966                 unset($data->sortorder);
1967             }
1968             // Note: plugin is responsible for setting up the mapping, it may also decide to migrate to different type.
1969             $this->plugins[$data->enrol]->restore_instance($this, $data, $courserec, $oldid);
1970         }
1971     }
1973     /**
1974      * Create user enrolments.
1975      *
1976      * This has to be called after creation of enrolment instances
1977      * and before adding of role assignments.
1978      *
1979      * Roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing afterwards.
1980      *
1981      * @param mixed $data
1982      * @return void
1983      */
1984     public function process_enrolment($data) {
1985         global $DB;
1987         if (!isset($this->plugins)) {
1988             $this->plugins = enrol_get_plugins(true);
1989         }
1991         $data = (object)$data;
1993         // Process only if parent instance have been mapped.
1994         if ($enrolid = $this->get_new_parentid('enrol')) {
1995             $oldinstancestatus = ENROL_INSTANCE_ENABLED;
1996             $oldenrolid = $this->get_old_parentid('enrol');
1997             if (isset($this->originalstatus[$oldenrolid])) {
1998                 $oldinstancestatus = $this->originalstatus[$oldenrolid];
1999             }
2000             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
2001                 // And only if user is a mapped one.
2002                 if ($userid = $this->get_mappingid('user', $data->userid)) {
2003                     if (isset($this->plugins[$instance->enrol])) {
2004                         $this->plugins[$instance->enrol]->restore_user_enrolment($this, $data, $instance, $userid, $oldinstancestatus);
2005                     }
2006                 }
2007             }
2008         }
2009     }
2013 /**
2014  * Make sure the user restoring the course can actually access it.
2015  */
2016 class restore_fix_restorer_access_step extends restore_execution_step {
2017     protected function define_execution() {
2018         global $CFG, $DB;
2020         if (!$userid = $this->task->get_userid()) {
2021             return;
2022         }
2024         if (empty($CFG->restorernewroleid)) {
2025             // Bad luck, no fallback role for restorers specified
2026             return;
2027         }
2029         $courseid = $this->get_courseid();
2030         $context = context_course::instance($courseid);
2032         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
2033             // Current user may access the course (admin, category manager or restored teacher enrolment usually)
2034             return;
2035         }
2037         // Try to add role only - we do not need enrolment if user has moodle/course:view or is already enrolled
2038         role_assign($CFG->restorernewroleid, $userid, $context);
2040         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
2041             // Extra role is enough, yay!
2042             return;
2043         }
2045         // The last chance is to create manual enrol if it does not exist and and try to enrol the current user,
2046         // hopefully admin selected suitable $CFG->restorernewroleid ...
2047         if (!enrol_is_enabled('manual')) {
2048             return;
2049         }
2050         if (!$enrol = enrol_get_plugin('manual')) {
2051             return;
2052         }
2053         if (!$DB->record_exists('enrol', array('enrol'=>'manual', 'courseid'=>$courseid))) {
2054             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
2055             $fields = array('status'=>ENROL_INSTANCE_ENABLED, 'enrolperiod'=>$enrol->get_config('enrolperiod', 0), 'roleid'=>$enrol->get_config('roleid', 0));
2056             $enrol->add_instance($course, $fields);
2057         }
2059         enrol_try_internal_enrol($courseid, $userid);
2060     }
2064 /**
2065  * This structure steps restores the filters and their configs
2066  */
2067 class restore_filters_structure_step extends restore_structure_step {
2069     protected function define_structure() {
2071         $paths = array();
2073         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
2074         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
2076         return $paths;
2077     }
2079     public function process_active($data) {
2081         $data = (object)$data;
2083         if (strpos($data->filter, 'filter/') === 0) {
2084             $data->filter = substr($data->filter, 7);
2086         } else if (strpos($data->filter, '/') !== false) {
2087             // Unsupported old filter.
2088             return;
2089         }
2091         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
2092             return;
2093         }
2094         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
2095     }
2097     public function process_config($data) {
2099         $data = (object)$data;
2101         if (strpos($data->filter, 'filter/') === 0) {
2102             $data->filter = substr($data->filter, 7);
2104         } else if (strpos($data->filter, '/') !== false) {
2105             // Unsupported old filter.
2106             return;
2107         }
2109         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
2110             return;
2111         }
2112         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
2113     }
2117 /**
2118  * This structure steps restores the comments
2119  * Note: Cannot use the comments API because defaults to USER->id.
2120  * That should change allowing to pass $userid
2121  */
2122 class restore_comments_structure_step extends restore_structure_step {
2124     protected function define_structure() {
2126         $paths = array();
2128         $paths[] = new restore_path_element('comment', '/comments/comment');
2130         return $paths;
2131     }
2133     public function process_comment($data) {
2134         global $DB;
2136         $data = (object)$data;
2138         // First of all, if the comment has some itemid, ask to the task what to map
2139         $mapping = false;
2140         if ($data->itemid) {
2141             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
2142             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
2143         }
2144         // Only restore the comment if has no mapping OR we have found the matching mapping
2145         if (!$mapping || $data->itemid) {
2146             // Only if user mapping and context
2147             $data->userid = $this->get_mappingid('user', $data->userid);
2148             if ($data->userid && $this->task->get_contextid()) {
2149                 $data->contextid = $this->task->get_contextid();
2150                 // Only if there is another comment with same context/user/timecreated
2151                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
2152                 if (!$DB->record_exists('comments', $params)) {
2153                     $DB->insert_record('comments', $data);
2154                 }
2155             }
2156         }
2157     }
2160 /**
2161  * This structure steps restores the badges and their configs
2162  */
2163 class restore_badges_structure_step extends restore_structure_step {
2165     /**
2166      * Conditionally decide if this step should be executed.
2167      *
2168      * This function checks the following parameters:
2169      *
2170      *   1. Badges and course badges are enabled on the site.
2171      *   2. The course/badges.xml file exists.
2172      *   3. All modules are restorable.
2173      *   4. All modules are marked for restore.
2174      *
2175      * @return bool True is safe to execute, false otherwise
2176      */
2177     protected function execute_condition() {
2178         global $CFG;
2180         // First check is badges and course level badges are enabled on this site.
2181         if (empty($CFG->enablebadges) || empty($CFG->badges_allowcoursebadges)) {
2182             // Disabled, don't restore course badges.
2183             return false;
2184         }
2186         // Check if badges.xml is included in the backup.
2187         $fullpath = $this->task->get_taskbasepath();
2188         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2189         if (!file_exists($fullpath)) {
2190             // Not found, can't restore course badges.
2191             return false;
2192         }
2194         // Check we are able to restore all backed up modules.
2195         if ($this->task->is_missing_modules()) {
2196             return false;
2197         }
2199         // Finally check all modules within the backup are being restored.
2200         if ($this->task->is_excluding_activities()) {
2201             return false;
2202         }
2204         return true;
2205     }
2207     protected function define_structure() {
2208         $paths = array();
2209         $paths[] = new restore_path_element('badge', '/badges/badge');
2210         $paths[] = new restore_path_element('criterion', '/badges/badge/criteria/criterion');
2211         $paths[] = new restore_path_element('parameter', '/badges/badge/criteria/criterion/parameters/parameter');
2212         $paths[] = new restore_path_element('manual_award', '/badges/badge/manual_awards/manual_award');
2214         return $paths;
2215     }
2217     public function process_badge($data) {
2218         global $DB, $CFG;
2220         require_once($CFG->libdir . '/badgeslib.php');
2222         $data = (object)$data;
2223         $data->usercreated = $this->get_mappingid('user', $data->usercreated);
2224         if (empty($data->usercreated)) {
2225             $data->usercreated = $this->task->get_userid();
2226         }
2227         $data->usermodified = $this->get_mappingid('user', $data->usermodified);
2228         if (empty($data->usermodified)) {
2229             $data->usermodified = $this->task->get_userid();
2230         }
2232         // We'll restore the badge image.
2233         $restorefiles = true;
2235         $courseid = $this->get_courseid();
2237         $params = array(
2238                 'name'           => $data->name,
2239                 'description'    => $data->description,
2240                 'timecreated'    => $this->apply_date_offset($data->timecreated),
2241                 'timemodified'   => $this->apply_date_offset($data->timemodified),
2242                 'usercreated'    => $data->usercreated,
2243                 'usermodified'   => $data->usermodified,
2244                 'issuername'     => $data->issuername,
2245                 'issuerurl'      => $data->issuerurl,
2246                 'issuercontact'  => $data->issuercontact,
2247                 'expiredate'     => $this->apply_date_offset($data->expiredate),
2248                 'expireperiod'   => $data->expireperiod,
2249                 'type'           => BADGE_TYPE_COURSE,
2250                 'courseid'       => $courseid,
2251                 'message'        => $data->message,
2252                 'messagesubject' => $data->messagesubject,
2253                 'attachment'     => $data->attachment,
2254                 'notification'   => $data->notification,
2255                 'status'         => BADGE_STATUS_INACTIVE,
2256                 'nextcron'       => $this->apply_date_offset($data->nextcron)
2257         );
2259         $newid = $DB->insert_record('badge', $params);
2260         $this->set_mapping('badge', $data->id, $newid, $restorefiles);
2261     }
2263     public function process_criterion($data) {
2264         global $DB;
2266         $data = (object)$data;
2268         $params = array(
2269                 'badgeid'      => $this->get_new_parentid('badge'),
2270                 'criteriatype' => $data->criteriatype,
2271                 'method'       => $data->method
2272         );
2273         $newid = $DB->insert_record('badge_criteria', $params);
2274         $this->set_mapping('criterion', $data->id, $newid);
2275     }
2277     public function process_parameter($data) {
2278         global $DB, $CFG;
2280         require_once($CFG->libdir . '/badgeslib.php');
2282         $data = (object)$data;
2283         $criteriaid = $this->get_new_parentid('criterion');
2285         // Parameter array that will go to database.
2286         $params = array();
2287         $params['critid'] = $criteriaid;
2289         $oldparam = explode('_', $data->name);
2291         if ($data->criteriatype == BADGE_CRITERIA_TYPE_ACTIVITY) {
2292             $module = $this->get_mappingid('course_module', $oldparam[1]);
2293             $params['name'] = $oldparam[0] . '_' . $module;
2294             $params['value'] = $oldparam[0] == 'module' ? $module : $data->value;
2295         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_COURSE) {
2296             $params['name'] = $oldparam[0] . '_' . $this->get_courseid();
2297             $params['value'] = $oldparam[0] == 'course' ? $this->get_courseid() : $data->value;
2298         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_MANUAL) {
2299             $role = $this->get_mappingid('role', $data->value);
2300             if (!empty($role)) {
2301                 $params['name'] = 'role_' . $role;
2302                 $params['value'] = $role;
2303             } else {
2304                 return;
2305             }
2306         }
2308         if (!$DB->record_exists('badge_criteria_param', $params)) {
2309             $DB->insert_record('badge_criteria_param', $params);
2310         }
2311     }
2313     public function process_manual_award($data) {
2314         global $DB;
2316         $data = (object)$data;
2317         $role = $this->get_mappingid('role', $data->issuerrole);
2319         if (!empty($role)) {
2320             $award = array(
2321                 'badgeid'     => $this->get_new_parentid('badge'),
2322                 'recipientid' => $this->get_mappingid('user', $data->recipientid),
2323                 'issuerid'    => $this->get_mappingid('user', $data->issuerid),
2324                 'issuerrole'  => $role,
2325                 'datemet'     => $this->apply_date_offset($data->datemet)
2326             );
2328             // Skip the manual award if recipient or issuer can not be mapped to.
2329             if (empty($award['recipientid']) || empty($award['issuerid'])) {
2330                 return;
2331             }
2333             $DB->insert_record('badge_manual_award', $award);
2334         }
2335     }
2337     protected function after_execute() {
2338         // Add related files.
2339         $this->add_related_files('badges', 'badgeimage', 'badge');
2340     }
2343 /**
2344  * This structure steps restores the calendar events
2345  */
2346 class restore_calendarevents_structure_step extends restore_structure_step {
2348     protected function define_structure() {
2350         $paths = array();
2352         $paths[] = new restore_path_element('calendarevents', '/events/event');
2354         return $paths;
2355     }
2357     public function process_calendarevents($data) {
2358         global $DB, $SITE, $USER;
2360         $data = (object)$data;
2361         $oldid = $data->id;
2362         $restorefiles = true; // We'll restore the files
2363         // Find the userid and the groupid associated with the event.
2364         $data->userid = $this->get_mappingid('user', $data->userid);
2365         if ($data->userid === false) {
2366             // Blank user ID means that we are dealing with module generated events such as quiz starting times.
2367             // Use the current user ID for these events.
2368             $data->userid = $USER->id;
2369         }
2370         if (!empty($data->groupid)) {
2371             $data->groupid = $this->get_mappingid('group', $data->groupid);
2372             if ($data->groupid === false) {
2373                 return;
2374             }
2375         }
2376         // Handle events with empty eventtype //MDL-32827
2377         if(empty($data->eventtype)) {
2378             if ($data->courseid == $SITE->id) {                                // Site event
2379                 $data->eventtype = "site";
2380             } else if ($data->courseid != 0 && $data->groupid == 0 && ($data->modulename == 'assignment' || $data->modulename == 'assign')) {
2381                 // Course assingment event
2382                 $data->eventtype = "due";
2383             } else if ($data->courseid != 0 && $data->groupid == 0) {      // Course event
2384                 $data->eventtype = "course";
2385             } else if ($data->groupid) {                                      // Group event
2386                 $data->eventtype = "group";
2387             } else if ($data->userid) {                                       // User event
2388                 $data->eventtype = "user";
2389             } else {
2390                 return;
2391             }
2392         }
2394         $params = array(
2395                 'name'           => $data->name,
2396                 'description'    => $data->description,
2397                 'format'         => $data->format,
2398                 'courseid'       => $this->get_courseid(),
2399                 'groupid'        => $data->groupid,
2400                 'userid'         => $data->userid,
2401                 'repeatid'       => $data->repeatid,
2402                 'modulename'     => $data->modulename,
2403                 'eventtype'      => $data->eventtype,
2404                 'timestart'      => $this->apply_date_offset($data->timestart),
2405                 'timeduration'   => $data->timeduration,
2406                 'visible'        => $data->visible,
2407                 'uuid'           => $data->uuid,
2408                 'sequence'       => $data->sequence,
2409                 'timemodified'    => $this->apply_date_offset($data->timemodified));
2410         if ($this->name == 'activity_calendar') {
2411             $params['instance'] = $this->task->get_activityid();
2412         } else {
2413             $params['instance'] = 0;
2414         }
2415         $sql = "SELECT id
2416                   FROM {event}
2417                  WHERE " . $DB->sql_compare_text('name', 255) . " = " . $DB->sql_compare_text('?', 255) . "
2418                    AND courseid = ?
2419                    AND repeatid = ?
2420                    AND modulename = ?
2421                    AND timestart = ?
2422                    AND timeduration = ?
2423                    AND " . $DB->sql_compare_text('description', 255) . " = " . $DB->sql_compare_text('?', 255);
2424         $arg = array ($params['name'], $params['courseid'], $params['repeatid'], $params['modulename'], $params['timestart'], $params['timeduration'], $params['description']);
2425         $result = $DB->record_exists_sql($sql, $arg);
2426         if (empty($result)) {
2427             $newitemid = $DB->insert_record('event', $params);
2428             $this->set_mapping('event', $oldid, $newitemid);
2429             $this->set_mapping('event_description', $oldid, $newitemid, $restorefiles);
2430         }
2432     }
2433     protected function after_execute() {
2434         // Add related files
2435         $this->add_related_files('calendar', 'event_description', 'event_description');
2436     }
2439 class restore_course_completion_structure_step extends restore_structure_step {
2441     /**
2442      * Conditionally decide if this step should be executed.
2443      *
2444      * This function checks parameters that are not immediate settings to ensure
2445      * that the enviroment is suitable for the restore of course completion info.
2446      *
2447      * This function checks the following four parameters:
2448      *
2449      *   1. Course completion is enabled on the site
2450      *   2. The backup includes course completion information
2451      *   3. All modules are restorable
2452      *   4. All modules are marked for restore.
2453      *
2454      * @return bool True is safe to execute, false otherwise
2455      */
2456     protected function execute_condition() {
2457         global $CFG;
2459         // First check course completion is enabled on this site
2460         if (empty($CFG->enablecompletion)) {
2461             // Disabled, don't restore course completion
2462             return false;
2463         }
2465         // No course completion on the front page.
2466         if ($this->get_courseid() == SITEID) {
2467             return false;
2468         }
2470         // Check it is included in the backup
2471         $fullpath = $this->task->get_taskbasepath();
2472         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2473         if (!file_exists($fullpath)) {
2474             // Not found, can't restore course completion
2475             return false;
2476         }
2478         // Check we are able to restore all backed up modules
2479         if ($this->task->is_missing_modules()) {
2480             return false;
2481         }
2483         // Finally check all modules within the backup are being restored.
2484         if ($this->task->is_excluding_activities()) {
2485             return false;
2486         }
2488         return true;
2489     }
2491     /**
2492      * Define the course completion structure
2493      *
2494      * @return array Array of restore_path_element
2495      */
2496     protected function define_structure() {
2498         // To know if we are including user completion info
2499         $userinfo = $this->get_setting_value('userscompletion');
2501         $paths = array();
2502         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
2503         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
2505         if ($userinfo) {
2506             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
2507             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
2508         }
2510         return $paths;
2512     }
2514     /**
2515      * Process course completion criteria
2516      *
2517      * @global moodle_database $DB
2518      * @param stdClass $data
2519      */
2520     public function process_course_completion_criteria($data) {
2521         global $DB;
2523         $data = (object)$data;
2524         $data->course = $this->get_courseid();
2526         // Apply the date offset to the time end field
2527         $data->timeend = $this->apply_date_offset($data->timeend);
2529         // Map the role from the criteria
2530         if (!empty($data->role)) {
2531             $data->role = $this->get_mappingid('role', $data->role);
2532         }
2534         $skipcriteria = false;
2536         // If the completion criteria is for a module we need to map the module instance
2537         // to the new module id.
2538         if (!empty($data->moduleinstance) && !empty($data->module)) {
2539             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
2540             if (empty($data->moduleinstance)) {
2541                 $skipcriteria = true;
2542             }
2543         } else {
2544             $data->module = null;
2545             $data->moduleinstance = null;
2546         }
2548         // We backup the course shortname rather than the ID so that we can match back to the course
2549         if (!empty($data->courseinstanceshortname)) {
2550             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
2551             if (!$courseinstanceid) {
2552                 $skipcriteria = true;
2553             }
2554         } else {
2555             $courseinstanceid = null;
2556         }
2557         $data->courseinstance = $courseinstanceid;
2559         if (!$skipcriteria) {
2560             $params = array(
2561                 'course'         => $data->course,
2562                 'criteriatype'   => $data->criteriatype,
2563                 'enrolperiod'    => $data->enrolperiod,
2564                 'courseinstance' => $data->courseinstance,
2565                 'module'         => $data->module,
2566                 'moduleinstance' => $data->moduleinstance,
2567                 'timeend'        => $data->timeend,
2568                 'gradepass'      => $data->gradepass,
2569                 'role'           => $data->role
2570             );
2571             $newid = $DB->insert_record('course_completion_criteria', $params);
2572             $this->set_mapping('course_completion_criteria', $data->id, $newid);
2573         }
2574     }
2576     /**
2577      * Processes course compltion criteria complete records
2578      *
2579      * @global moodle_database $DB
2580      * @param stdClass $data
2581      */
2582     public function process_course_completion_crit_compl($data) {
2583         global $DB;
2585         $data = (object)$data;
2587         // This may be empty if criteria could not be restored
2588         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
2590         $data->course = $this->get_courseid();
2591         $data->userid = $this->get_mappingid('user', $data->userid);
2593         if (!empty($data->criteriaid) && !empty($data->userid)) {
2594             $params = array(
2595                 'userid' => $data->userid,
2596                 'course' => $data->course,
2597                 'criteriaid' => $data->criteriaid,
2598                 'timecompleted' => $this->apply_date_offset($data->timecompleted)
2599             );
2600             if (isset($data->gradefinal)) {
2601                 $params['gradefinal'] = $data->gradefinal;
2602             }
2603             if (isset($data->unenroled)) {
2604                 $params['unenroled'] = $data->unenroled;
2605             }
2606             $DB->insert_record('course_completion_crit_compl', $params);
2607         }
2608     }
2610     /**
2611      * Process course completions
2612      *
2613      * @global moodle_database $DB
2614      * @param stdClass $data
2615      */
2616     public function process_course_completions($data) {
2617         global $DB;
2619         $data = (object)$data;
2621         $data->course = $this->get_courseid();
2622         $data->userid = $this->get_mappingid('user', $data->userid);
2624         if (!empty($data->userid)) {
2625             $params = array(
2626                 'userid' => $data->userid,
2627                 'course' => $data->course,
2628                 'timeenrolled' => $this->apply_date_offset($data->timeenrolled),
2629                 'timestarted' => $this->apply_date_offset($data->timestarted),
2630                 'timecompleted' => $this->apply_date_offset($data->timecompleted),
2631                 'reaggregate' => $data->reaggregate
2632             );
2633             $DB->insert_record('course_completions', $params);
2634         }
2635     }
2637     /**
2638      * Process course completion aggregate methods
2639      *
2640      * @global moodle_database $DB
2641      * @param stdClass $data
2642      */
2643     public function process_course_completion_aggr_methd($data) {
2644         global $DB;
2646         $data = (object)$data;
2648         $data->course = $this->get_courseid();
2650         // Only create the course_completion_aggr_methd records if
2651         // the target course has not them defined. MDL-28180
2652         if (!$DB->record_exists('course_completion_aggr_methd', array(
2653                     'course' => $data->course,
2654                     'criteriatype' => $data->criteriatype))) {
2655             $params = array(
2656                 'course' => $data->course,
2657                 'criteriatype' => $data->criteriatype,
2658                 'method' => $data->method,
2659                 'value' => $data->value,
2660             );
2661             $DB->insert_record('course_completion_aggr_methd', $params);
2662         }
2663     }
2667 /**
2668  * This structure step restores course logs (cmid = 0), delegating
2669  * the hard work to the corresponding {@link restore_logs_processor} passing the
2670  * collection of {@link restore_log_rule} rules to be observed as they are defined
2671  * by the task. Note this is only executed based in the 'logs' setting.
2672  *
2673  * NOTE: This is executed by final task, to have all the activities already restored
2674  *
2675  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
2676  * records are. There are others like 'calendar' and 'upload' that will be handled
2677  * later.
2678  *
2679  * NOTE: All the missing actions (not able to be restored) are sent to logs for
2680  * debugging purposes
2681  */
2682 class restore_course_logs_structure_step extends restore_structure_step {
2684     /**
2685      * Conditionally decide if this step should be executed.
2686      *
2687      * This function checks the following parameter:
2688      *
2689      *   1. the course/logs.xml file exists
2690      *
2691      * @return bool true is safe to execute, false otherwise
2692      */
2693     protected function execute_condition() {
2695         // Check it is included in the backup
2696         $fullpath = $this->task->get_taskbasepath();
2697         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2698         if (!file_exists($fullpath)) {
2699             // Not found, can't restore course logs
2700             return false;
2701         }
2703         return true;
2704     }
2706     protected function define_structure() {
2708         $paths = array();
2710         // Simple, one plain level of information contains them
2711         $paths[] = new restore_path_element('log', '/logs/log');
2713         return $paths;
2714     }
2716     protected function process_log($data) {
2717         global $DB;
2719         $data = (object)($data);
2721         $data->time = $this->apply_date_offset($data->time);
2722         $data->userid = $this->get_mappingid('user', $data->userid);
2723         $data->course = $this->get_courseid();
2724         $data->cmid = 0;
2726         // For any reason user wasn't remapped ok, stop processing this
2727         if (empty($data->userid)) {
2728             return;
2729         }
2731         // Everything ready, let's delegate to the restore_logs_processor
2733         // Set some fixed values that will save tons of DB requests
2734         $values = array(
2735             'course' => $this->get_courseid());
2736         // Get instance and process log record
2737         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2739         // If we have data, insert it, else something went wrong in the restore_logs_processor
2740         if ($data) {
2741             if (empty($data->url)) {
2742                 $data->url = '';
2743             }
2744             if (empty($data->info)) {
2745                 $data->info = '';
2746             }
2747             // Store the data in the legacy log table if we are still using it.
2748             $manager = get_log_manager();
2749             if (method_exists($manager, 'legacy_add_to_log')) {
2750                 $manager->legacy_add_to_log($data->course, $data->module, $data->action, $data->url,
2751                     $data->info, $data->cmid, $data->userid);
2752             }
2753         }
2754     }
2757 /**
2758  * This structure step restores activity logs, extending {@link restore_course_logs_structure_step}
2759  * sharing its same structure but modifying the way records are handled
2760  */
2761 class restore_activity_logs_structure_step extends restore_course_logs_structure_step {
2763     protected function process_log($data) {
2764         global $DB;
2766         $data = (object)($data);
2768         $data->time = $this->apply_date_offset($data->time);
2769         $data->userid = $this->get_mappingid('user', $data->userid);
2770         $data->course = $this->get_courseid();
2771         $data->cmid = $this->task->get_moduleid();
2773         // For any reason user wasn't remapped ok, stop processing this
2774         if (empty($data->userid)) {
2775             return;
2776         }
2778         // Everything ready, let's delegate to the restore_logs_processor
2780         // Set some fixed values that will save tons of DB requests
2781         $values = array(
2782             'course' => $this->get_courseid(),
2783             'course_module' => $this->task->get_moduleid(),
2784             $this->task->get_modulename() => $this->task->get_activityid());
2785         // Get instance and process log record
2786         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2788         // If we have data, insert it, else something went wrong in the restore_logs_processor
2789         if ($data) {
2790             if (empty($data->url)) {
2791                 $data->url = '';
2792             }
2793             if (empty($data->info)) {
2794                 $data->info = '';
2795             }
2796             // Store the data in the legacy log table if we are still using it.
2797             $manager = get_log_manager();
2798             if (method_exists($manager, 'legacy_add_to_log')) {
2799                 $manager->legacy_add_to_log($data->course, $data->module, $data->action, $data->url,
2800                     $data->info, $data->cmid, $data->userid);
2801             }
2802         }
2803     }
2807 /**
2808  * Defines the restore step for advanced grading methods attached to the activity module
2809  */
2810 class restore_activity_grading_structure_step extends restore_structure_step {
2812     /**
2813      * This step is executed only if the grading file is present
2814      */
2815      protected function execute_condition() {
2817         if ($this->get_courseid() == SITEID) {
2818             return false;
2819         }
2821         $fullpath = $this->task->get_taskbasepath();
2822         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2823         if (!file_exists($fullpath)) {
2824             return false;
2825         }
2827         return true;
2828     }
2831     /**
2832      * Declares paths in the grading.xml file we are interested in
2833      */
2834     protected function define_structure() {
2836         $paths = array();
2837         $userinfo = $this->get_setting_value('userinfo');
2839         $area = new restore_path_element('grading_area', '/areas/area');
2840         $paths[] = $area;
2841         // attach local plugin stucture to $area element
2842         $this->add_plugin_structure('local', $area);
2844         $definition = new restore_path_element('grading_definition', '/areas/area/definitions/definition');
2845         $paths[] = $definition;
2846         $this->add_plugin_structure('gradingform', $definition);
2847         // attach local plugin stucture to $definition element
2848         $this->add_plugin_structure('local', $definition);
2851         if ($userinfo) {
2852             $instance = new restore_path_element('grading_instance',
2853                 '/areas/area/definitions/definition/instances/instance');
2854             $paths[] = $instance;
2855             $this->add_plugin_structure('gradingform', $instance);
2856             // attach local plugin stucture to $intance element
2857             $this->add_plugin_structure('local', $instance);
2858         }
2860         return $paths;
2861     }
2863     /**
2864      * Processes one grading area element
2865      *
2866      * @param array $data element data
2867      */
2868     protected function process_grading_area($data) {
2869         global $DB;
2871         $task = $this->get_task();
2872         $data = (object)$data;
2873         $oldid = $data->id;
2874         $data->component = 'mod_'.$task->get_modulename();
2875         $data->contextid = $task->get_contextid();
2877         $newid = $DB->insert_record('grading_areas', $data);
2878         $this->set_mapping('grading_area', $oldid, $newid);
2879     }
2881     /**
2882      * Processes one grading definition element
2883      *
2884      * @param array $data element data
2885      */
2886     protected function process_grading_definition($data) {
2887         global $DB;
2889         $task = $this->get_task();
2890         $data = (object)$data;
2891         $oldid = $data->id;
2892         $data->areaid = $this->get_new_parentid('grading_area');
2893         $data->copiedfromid = null;
2894         $data->timecreated = time();
2895         $data->usercreated = $task->get_userid();
2896         $data->timemodified = $data->timecreated;
2897         $data->usermodified = $data->usercreated;
2899         $newid = $DB->insert_record('grading_definitions', $data);
2900         $this->set_mapping('grading_definition', $oldid, $newid, true);
2901     }
2903     /**
2904      * Processes one grading form instance element
2905      *
2906      * @param array $data element data
2907      */
2908     protected function process_grading_instance($data) {
2909         global $DB;
2911         $data = (object)$data;
2913         // new form definition id
2914         $newformid = $this->get_new_parentid('grading_definition');
2916         // get the name of the area we are restoring to
2917         $sql = "SELECT ga.areaname
2918                   FROM {grading_definitions} gd
2919                   JOIN {grading_areas} ga ON gd.areaid = ga.id
2920                  WHERE gd.id = ?";
2921         $areaname = $DB->get_field_sql($sql, array($newformid), MUST_EXIST);
2923         // get the mapped itemid - the activity module is expected to define the mappings
2924         // for each gradable area
2925         $newitemid = $this->get_mappingid(restore_gradingform_plugin::itemid_mapping($areaname), $data->itemid);
2927         $oldid = $data->id;
2928         $data->definitionid = $newformid;
2929         $data->raterid = $this->get_mappingid('user', $data->raterid);
2930         $data->itemid = $newitemid;
2932         $newid = $DB->insert_record('grading_instances', $data);
2933         $this->set_mapping('grading_instance', $oldid, $newid);
2934     }
2936     /**
2937      * Final operations when the database records are inserted
2938      */
2939     protected function after_execute() {
2940         // Add files embedded into the definition description
2941         $this->add_related_files('grading', 'description', 'grading_definition');
2942     }
2946 /**
2947  * This structure step restores the grade items associated with one activity
2948  * All the grade items are made child of the "course" grade item but the original
2949  * categoryid is saved as parentitemid in the backup_ids table, so, when restoring
2950  * the complete gradebook (categories and calculations), that information is
2951  * available there
2952  */
2953 class restore_activity_grades_structure_step extends restore_structure_step {
2955     /**
2956      * No grades in front page.
2957      * @return bool
2958      */
2959     protected function execute_condition() {
2960         return ($this->get_courseid() != SITEID);
2961     }
2963     protected function define_structure() {
2965         $paths = array();
2966         $userinfo = $this->get_setting_value('userinfo');
2968         $paths[] = new restore_path_element('grade_item', '/activity_gradebook/grade_items/grade_item');
2969         $paths[] = new restore_path_element('grade_letter', '/activity_gradebook/grade_letters/grade_letter');
2970         if ($userinfo) {
2971             $paths[] = new restore_path_element('grade_grade',
2972                            '/activity_gradebook/grade_items/grade_item/grade_grades/grade_grade');
2973         }
2974         return $paths;
2975     }
2977     protected function process_grade_item($data) {
2978         global $DB;
2980         $data = (object)($data);
2981         $oldid       = $data->id;        // We'll need these later
2982         $oldparentid = $data->categoryid;
2983         $courseid = $this->get_courseid();
2985         // make sure top course category exists, all grade items will be associated
2986         // to it. Later, if restoring the whole gradebook, categories will be introduced
2987         $coursecat = grade_category::fetch_course_category($courseid);
2988         $coursecatid = $coursecat->id; // Get the categoryid to be used
2990         $idnumber = null;
2991         if (!empty($data->idnumber)) {
2992             // Don't get any idnumber from course module. Keep them as they are in grade_item->idnumber
2993             // Reason: it's not clear what happens with outcomes->idnumber or activities with multiple items (workshop)
2994             // so the best is to keep the ones already in the gradebook
2995             // Potential problem: duplicates if same items are restored more than once. :-(
2996             // This needs to be fixed in some way (outcomes & activities with multiple items)
2997             // $data->idnumber     = get_coursemodule_from_instance($data->itemmodule, $data->iteminstance)->idnumber;
2998             // In any case, verify always for uniqueness
2999             $sql = "SELECT cm.id
3000                       FROM {course_modules} cm
3001                      WHERE cm.course = :courseid AND
3002                            cm.idnumber = :idnumber AND
3003                            cm.id <> :cmid";
3004             $params = array(
3005                 'courseid' => $courseid,
3006                 'idnumber' => $data->idnumber,
3007                 'cmid' => $this->task->get_moduleid()
3008             );
3009             if (!$DB->record_exists_sql($sql, $params) && !$DB->record_exists('grade_items', array('courseid' => $courseid, 'idnumber' => $data->idnumber))) {
3010                 $idnumber = $data->idnumber;
3011             }
3012         }
3014         unset($data->id);
3015         $data->categoryid   = $coursecatid;
3016         $data->courseid     = $this->get_courseid();
3017         $data->iteminstance = $this->task->get_activityid();
3018         $data->idnumber     = $idnumber;
3019         $data->scaleid      = $this->get_mappingid('scale', $data->scaleid);
3020         $data->outcomeid    = $this->get_mappingid('outcome', $data->outcomeid);
3021         $data->timecreated  = $this->apply_date_offset($data->timecreated);
3022         $data->timemodified = $this->apply_date_offset($data->timemodified);
3024         $gradeitem = new grade_item($data, false);
3025         $gradeitem->insert('restore');
3027         //sortorder is automatically assigned when inserting. Re-instate the previous sortorder
3028         $gradeitem->sortorder = $data->sortorder;
3029         $gradeitem->update('restore');
3031         // Set mapping, saving the original category id into parentitemid
3032         // gradebook restore (final task) will need it to reorganise items
3033         $this->set_mapping('grade_item', $oldid, $gradeitem->id, false, null, $oldparentid);
3034     }
3036     protected function process_grade_grade($data) {
3037         $data = (object)($data);
3038         $olduserid = $data->userid;
3039         $oldid = $data->id;
3040         unset($data->id);
3042         $data->itemid = $this->get_new_parentid('grade_item');
3044         $data->userid = $this->get_mappingid('user', $data->userid, null);
3045         if (!empty($data->userid)) {
3046             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
3047             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
3048             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
3049             $data->overridden = $this->apply_date_offset($data->overridden);
3051             $grade = new grade_grade($data, false);
3052             $grade->insert('restore');
3053             $this->set_mapping('grade_grades', $oldid, $grade->id);
3054         } else {
3055             debugging("Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'");
3056         }
3057     }
3059     /**
3060      * process activity grade_letters. Note that, while these are possible,
3061      * because grade_letters are contextid based, in practice, only course
3062      * context letters can be defined. So we keep here this method knowing
3063      * it won't be executed ever. gradebook restore will restore course letters.
3064      */
3065     protected function process_grade_letter($data) {
3066         global $DB;
3068         $data['contextid'] = $this->task->get_contextid();
3069         $gradeletter = (object)$data;
3071         // Check if it exists before adding it
3072         unset($data['id']);
3073         if (!$DB->record_exists('grade_letters', $data)) {
3074             $newitemid = $DB->insert_record('grade_letters', $gradeletter);
3075         }
3076         // no need to save any grade_letter mapping
3077     }
3079     public function after_restore() {
3080         // Fix grade item's sortorder after restore, as it might have duplicates.
3081         $courseid = $this->get_task()->get_courseid();
3082         grade_item::fix_duplicate_sortorder($courseid);
3083     }
3086 /**
3087  * Step in charge of restoring the grade history of an activity.
3088  *
3089  * This step is added to the task regardless of the setting 'grade_histories'.
3090  * The reason is to allow for a more flexible step in case the logic needs to be
3091  * split accross different settings to control the history of items and/or grades.
3092  */
3093 class restore_activity_grade_history_structure_step extends restore_structure_step {
3095     /**
3096      * This step is executed only if the grade history file is present.
3097      */
3098      protected function execute_condition() {
3100         if ($this->get_courseid() == SITEID) {
3101             return false;
3102         }
3104         $fullpath = $this->task->get_taskbasepath();
3105         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
3106         if (!file_exists($fullpath)) {
3107             return false;
3108         }
3109         return true;
3110     }
3112     protected function define_structure() {
3113         $paths = array();
3115         // Settings to use.
3116         $userinfo = $this->get_setting_value('userinfo');
3117         $history = $this->get_setting_value('grade_histories');
3119         if ($userinfo && $history) {
3120             $paths[] = new restore_path_element('grade_grade',
3121                '/grade_history/grade_grades/grade_grade');
3122         }
3124         return $paths;
3125     }
3127     protected function process_grade_grade($data) {
3128         global $DB;
3130         $data = (object) $data;
3131         $olduserid = $data->userid;
3132         unset($data->id);
3134         $data->userid = $this->get_mappingid('user', $data->userid, null);
3135         if (!empty($data->userid)) {
3136             // Do not apply the date offsets as this is history.
3137             $data->itemid = $this->get_mappingid('grade_item', $data->itemid);
3138             $data->oldid = $this->get_mappingid('grade_grades', $data->oldid);
3139             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
3140             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
3141             $DB->insert_record('grade_grades_history', $data);
3142         } else {
3143             $message = "Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'";
3144             $this->log($message, backup::LOG_DEBUG);
3145         }
3146     }
3150 /**
3151  * This structure steps restores one instance + positions of one block
3152  * Note: Positions corresponding to one existing context are restored
3153  * here, but all the ones having unknown contexts are sent to backup_ids
3154  * for a later chance to be restored at the end (final task)
3155  */
3156 class restore_block_instance_structure_step extends restore_structure_step {
3158     protected function define_structure() {
3160         $paths = array();
3162         $paths[] = new restore_path_element('block', '/block', true); // Get the whole XML together
3163         $paths[] = new restore_path_element('block_position', '/block/block_positions/block_position');
3165         return $paths;
3166     }
3168     public function process_block($data) {
3169         global $DB, $CFG;
3171         $data = (object)$data; // Handy
3172         $oldcontextid = $data->contextid;
3173         $oldid        = $data->id;
3174         $positions = isset($data->block_positions['block_position']) ? $data->block_positions['block_position'] : array();
3176         // Look for the parent contextid
3177         if (!$data->parentcontextid = $this->get_mappingid('context', $data->parentcontextid)) {
3178             throw new restore_step_exception('restore_block_missing_parent_ctx', $data->parentcontextid);
3179         }
3181         // TODO: it would be nice to use standard plugin supports instead of this instance_allow_multiple()
3182         // If there is already one block of that type in the parent context
3183         // and the block is not multiple, stop processing
3184         // Use blockslib loader / method executor
3185         if (!$bi = block_instance($data->blockname)) {
3186             return false;
3187         }
3189         if (!$bi->instance_allow_multiple()) {
3190             // The block cannot be added twice, so we will check if the same block is already being
3191             // displayed on the same page. For this, rather than mocking a page and using the block_manager
3192             // we use a similar query to the one in block_manager::load_blocks(), this will give us
3193             // a very good idea of the blocks already displayed in the context.
3194             $params =  array(
3195                 'blockname' => $data->blockname
3196             );
3198             // Context matching test.
3199             $context = context::instance_by_id($data->parentcontextid);
3200             $contextsql = 'bi.parentcontextid = :contextid';
3201             $params['contextid'] = $context->id;
3203             $parentcontextids = $context->get_parent_context_ids();
3204             if ($parentcontextids) {
3205                 list($parentcontextsql, $parentcontextparams) =
3206                         $DB->get_in_or_equal($parentcontextids, SQL_PARAMS_NAMED);
3207                 $contextsql = "($contextsql OR (bi.showinsubcontexts = 1 AND bi.parentcontextid $parentcontextsql))";
3208                 $params = array_merge($params, $parentcontextparams);
3209             }
3211             // Page type pattern test.
3212             $pagetypepatterns = matching_page_type_patterns_from_pattern($data->pagetypepattern);
3213             list($pagetypepatternsql, $pagetypepatternparams) =
3214                 $DB->get_in_or_equal($pagetypepatterns, SQL_PARAMS_NAMED);
3215             $params = array_merge($params, $pagetypepatternparams);
3217             // Sub page pattern test.
3218             $subpagepatternsql = 'bi.subpagepattern IS NULL';
3219             if ($data->subpagepattern !== null) {
3220                 $subpagepatternsql = "($subpagepatternsql OR bi.subpagepattern = :subpagepattern)";
3221                 $params['subpagepattern'] = $data->subpagepattern;
3222             }
3224             $exists = $DB->record_exists_sql("SELECT bi.id
3225                                                 FROM {block_instances} bi
3226                                                 JOIN {block} b ON b.name = bi.blockname
3227                                                WHERE bi.blockname = :blockname
3228                                                  AND $contextsql
3229                                                  AND bi.pagetypepattern $pagetypepatternsql
3230                                                  AND $subpagepatternsql", $params);
3231             if ($exists) {
3232                 // There is at least one very similar block visible on the page where we
3233                 // are trying to restore the block. In these circumstances the block API
3234                 // would not allow the user to add another instance of the block, so we
3235                 // apply the same rule here.
3236                 return false;
3237             }
3238         }
3240         // If there is already one block of that type in the parent context
3241         // with the same showincontexts, pagetypepattern, subpagepattern, defaultregion and configdata
3242         // stop processing
3243         $params = array(
3244             'blockname' => $data->blockname, 'parentcontextid' => $data->parentcontextid,
3245             'showinsubcontexts' => $data->showinsubcontexts, 'pagetypepattern' => $data->pagetypepattern,
3246             'subpagepattern' => $data->subpagepattern, 'defaultregion' => $data->defaultregion);
3247         if ($birecs = $DB->get_records('block_instances', $params)) {
3248             foreach($birecs as $birec) {
3249                 if ($birec->configdata == $data->configdata) {
3250                     return false;
3251                 }
3252             }
3253         }
3255         // Set task old contextid, blockid and blockname once we know them
3256         $this->task->set_old_contextid($oldcontextid);
3257         $this-&