MDL-45283 restore: Prevent failure when user course grade exists
[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(time() - (4 * 60 * 60), $progress);              // Delete > 4 hours 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         // No gradebook info found, don't execute
93         $fullpath = $this->task->get_taskbasepath();
94         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
95         if (!file_exists($fullpath)) {
96             return false;
97         }
99         // Some module present in backup file isn't available to restore
100         // in this site, don't execute
101         if ($this->task->is_missing_modules()) {
102             return false;
103         }
105         // Some activity has been excluded to be restored, don't execute
106         if ($this->task->is_excluding_activities()) {
107             return false;
108         }
110         // There should only be one grade category (the 1 associated with the course itself)
111         // If other categories already exist we're restoring into an existing course.
112         // Restoring categories into a course with an existing category structure is unlikely to go well
113         $category = new stdclass();
114         $category->courseid  = $this->get_courseid();
115         $catcount = $DB->count_records('grade_categories', (array)$category);
116         if ($catcount>1) {
117             return false;
118         }
120         // Arrived here, execute the step
121         return true;
122      }
124     protected function define_structure() {
125         $paths = array();
126         $userinfo = $this->task->get_setting_value('users');
128         $paths[] = new restore_path_element('gradebook', '/gradebook');
129         $paths[] = new restore_path_element('grade_category', '/gradebook/grade_categories/grade_category');
130         $paths[] = new restore_path_element('grade_item', '/gradebook/grade_items/grade_item');
131         if ($userinfo) {
132             $paths[] = new restore_path_element('grade_grade', '/gradebook/grade_items/grade_item/grade_grades/grade_grade');
133         }
134         $paths[] = new restore_path_element('grade_letter', '/gradebook/grade_letters/grade_letter');
135         $paths[] = new restore_path_element('grade_setting', '/gradebook/grade_settings/grade_setting');
137         return $paths;
138     }
140     protected function process_gradebook($data) {
141     }
143     protected function process_grade_item($data) {
144         global $DB;
146         $data = (object)$data;
148         $oldid = $data->id;
149         $data->course = $this->get_courseid();
151         $data->courseid = $this->get_courseid();
153         if ($data->itemtype=='manual') {
154             // manual grade items store category id in categoryid
155             $data->categoryid = $this->get_mappingid('grade_category', $data->categoryid, NULL);
156             // if mapping failed put in course's grade category
157             if (NULL == $data->categoryid) {
158                 $coursecat = grade_category::fetch_course_category($this->get_courseid());
159                 $data->categoryid = $coursecat->id;
160             }
161         } else if ($data->itemtype=='course') {
162             // course grade item stores their category id in iteminstance
163             $coursecat = grade_category::fetch_course_category($this->get_courseid());
164             $data->iteminstance = $coursecat->id;
165         } else if ($data->itemtype=='category') {
166             // category grade items store their category id in iteminstance
167             $data->iteminstance = $this->get_mappingid('grade_category', $data->iteminstance, NULL);
168         } else {
169             throw new restore_step_exception('unexpected_grade_item_type', $data->itemtype);
170         }
172         $data->scaleid   = $this->get_mappingid('scale', $data->scaleid, NULL);
173         $data->outcomeid = $this->get_mappingid('outcome', $data->outcomeid, NULL);
175         $data->locktime     = $this->apply_date_offset($data->locktime);
176         $data->timecreated  = $this->apply_date_offset($data->timecreated);
177         $data->timemodified = $this->apply_date_offset($data->timemodified);
179         $coursecategory = $newitemid = null;
180         //course grade item should already exist so updating instead of inserting
181         if($data->itemtype=='course') {
182             //get the ID of the already created grade item
183             $gi = new stdclass();
184             $gi->courseid  = $this->get_courseid();
185             $gi->itemtype  = $data->itemtype;
187             //need to get the id of the grade_category that was automatically created for the course
188             $category = new stdclass();
189             $category->courseid  = $this->get_courseid();
190             $category->parent  = null;
191             //course category fullname starts out as ? but may be edited
192             //$category->fullname  = '?';
193             $coursecategory = $DB->get_record('grade_categories', (array)$category);
194             $gi->iteminstance = $coursecategory->id;
196             $existinggradeitem = $DB->get_record('grade_items', (array)$gi);
197             if (!empty($existinggradeitem)) {
198                 $data->id = $newitemid = $existinggradeitem->id;
199                 $DB->update_record('grade_items', $data);
200             }
201         } else if ($data->itemtype == 'manual') {
202             // Manual items aren't assigned to a cm, so don't go duplicating them in the target if one exists.
203             $gi = array(
204                 'itemtype' => $data->itemtype,
205                 'courseid' => $data->courseid,
206                 'itemname' => $data->itemname,
207                 'categoryid' => $data->categoryid,
208             );
209             $newitemid = $DB->get_field('grade_items', 'id', $gi);
210         }
212         if (empty($newitemid)) {
213             //in case we found the course category but still need to insert the course grade item
214             if ($data->itemtype=='course' && !empty($coursecategory)) {
215                 $data->iteminstance = $coursecategory->id;
216             }
218             $newitemid = $DB->insert_record('grade_items', $data);
219         }
220         $this->set_mapping('grade_item', $oldid, $newitemid);
221     }
223     protected function process_grade_grade($data) {
224         global $DB;
226         $data = (object)$data;
227         $olduserid = $data->userid;
229         $data->itemid = $this->get_new_parentid('grade_item');
231         $data->userid = $this->get_mappingid('user', $data->userid, null);
232         if (!empty($data->userid)) {
233             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
234             $data->locktime     = $this->apply_date_offset($data->locktime);
235             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
236             $data->overridden = $this->apply_date_offset($data->overridden);
237             $data->timecreated  = $this->apply_date_offset($data->timecreated);
238             $data->timemodified = $this->apply_date_offset($data->timemodified);
240             $gradeexists = $DB->record_exists('grade_grades', array('userid' => $data->userid, 'itemid' => $data->itemid));
241             if ($gradeexists) {
242                 $message = "User id '{$data->userid}' already has a grade entry for grade item id '{$data->itemid}'";
243                 $this->log($message, backup::LOG_DEBUG);
244             } else {
245                 $newitemid = $DB->insert_record('grade_grades', $data);
246             }
247         } else {
248             $message = "Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'";
249             $this->log($message, backup::LOG_DEBUG);
250         }
251     }
253     protected function process_grade_category($data) {
254         global $DB;
256         $data = (object)$data;
257         $oldid = $data->id;
259         $data->course = $this->get_courseid();
260         $data->courseid = $data->course;
262         $data->timecreated  = $this->apply_date_offset($data->timecreated);
263         $data->timemodified = $this->apply_date_offset($data->timemodified);
265         $newitemid = null;
266         //no parent means a course level grade category. That may have been created when the course was created
267         if(empty($data->parent)) {
268             //parent was being saved as 0 when it should be null
269             $data->parent = null;
271             //get the already created course level grade category
272             $category = new stdclass();
273             $category->courseid = $this->get_courseid();
274             $category->parent = null;
276             $coursecategory = $DB->get_record('grade_categories', (array)$category);
277             if (!empty($coursecategory)) {
278                 $data->id = $newitemid = $coursecategory->id;
279                 $DB->update_record('grade_categories', $data);
280             }
281         }
283         //need to insert a course category
284         if (empty($newitemid)) {
285             $newitemid = $DB->insert_record('grade_categories', $data);
286         }
287         $this->set_mapping('grade_category', $oldid, $newitemid);
288     }
289     protected function process_grade_letter($data) {
290         global $DB;
292         $data = (object)$data;
293         $oldid = $data->id;
295         $data->contextid = context_course::instance($this->get_courseid())->id;
297         $gradeletter = (array)$data;
298         unset($gradeletter['id']);
299         if (!$DB->record_exists('grade_letters', $gradeletter)) {
300             $newitemid = $DB->insert_record('grade_letters', $data);
301         } else {
302             $newitemid = $data->id;
303         }
305         $this->set_mapping('grade_letter', $oldid, $newitemid);
306     }
307     protected function process_grade_setting($data) {
308         global $DB;
310         $data = (object)$data;
311         $oldid = $data->id;
313         $data->courseid = $this->get_courseid();
315         if (!$DB->record_exists('grade_settings', array('courseid' => $data->courseid, 'name' => $data->name))) {
316             $newitemid = $DB->insert_record('grade_settings', $data);
317         } else {
318             $newitemid = $data->id;
319         }
321         $this->set_mapping('grade_setting', $oldid, $newitemid);
322     }
324     /**
325      * put all activity grade items in the correct grade category and mark all for recalculation
326      */
327     protected function after_execute() {
328         global $DB;
330         $conditions = array(
331             'backupid' => $this->get_restoreid(),
332             'itemname' => 'grade_item'//,
333             //'itemid'   => $itemid
334         );
335         $rs = $DB->get_recordset('backup_ids_temp', $conditions);
337         // We need this for calculation magic later on.
338         $mappings = array();
340         if (!empty($rs)) {
341             foreach($rs as $grade_item_backup) {
343                 // Store the oldid with the new id.
344                 $mappings[$grade_item_backup->itemid] = $grade_item_backup->newitemid;
346                 $updateobj = new stdclass();
347                 $updateobj->id = $grade_item_backup->newitemid;
349                 //if this is an activity grade item that needs to be put back in its correct category
350                 if (!empty($grade_item_backup->parentitemid)) {
351                     $oldcategoryid = $this->get_mappingid('grade_category', $grade_item_backup->parentitemid, null);
352                     if (!is_null($oldcategoryid)) {
353                         $updateobj->categoryid = $oldcategoryid;
354                         $DB->update_record('grade_items', $updateobj);
355                     }
356                 } else {
357                     //mark course and category items as needing to be recalculated
358                     $updateobj->needsupdate=1;
359                     $DB->update_record('grade_items', $updateobj);
360                 }
361             }
362         }
363         $rs->close();
365         // We need to update the calculations for calculated grade items that may reference old
366         // grade item ids using ##gi\d+##.
367         // $mappings can be empty, use 0 if so (won't match ever)
368         list($sql, $params) = $DB->get_in_or_equal(array_values($mappings), SQL_PARAMS_NAMED, 'param', true, 0);
369         $sql = "SELECT gi.id, gi.calculation
370                   FROM {grade_items} gi
371                  WHERE gi.id {$sql} AND
372                        calculation IS NOT NULL";
373         $rs = $DB->get_recordset_sql($sql, $params);
374         foreach ($rs as $gradeitem) {
375             // Collect all of the used grade item id references
376             if (preg_match_all('/##gi(\d+)##/', $gradeitem->calculation, $matches) < 1) {
377                 // This calculation doesn't reference any other grade items... EASY!
378                 continue;
379             }
380             // For this next bit we are going to do the replacement of id's in two steps:
381             // 1. We will replace all old id references with a special mapping reference.
382             // 2. We will replace all mapping references with id's
383             // Why do we do this?
384             // Because there potentially there will be an overlap of ids within the query and we
385             // we substitute the wrong id.. safest way around this is the two step system
386             $calculationmap = array();
387             $mapcount = 0;
388             foreach ($matches[1] as $match) {
389                 // Check that the old id is known to us, if not it was broken to begin with and will
390                 // continue to be broken.
391                 if (!array_key_exists($match, $mappings)) {
392                     continue;
393                 }
394                 // Our special mapping key
395                 $mapping = '##MAPPING'.$mapcount.'##';
396                 // The old id that exists within the calculation now
397                 $oldid = '##gi'.$match.'##';
398                 // The new id that we want to replace the old one with.
399                 $newid = '##gi'.$mappings[$match].'##';
400                 // Replace in the special mapping key
401                 $gradeitem->calculation = str_replace($oldid, $mapping, $gradeitem->calculation);
402                 // And record the mapping
403                 $calculationmap[$mapping] = $newid;
404                 $mapcount++;
405             }
406             // Iterate all special mappings for this calculation and replace in the new id's
407             foreach ($calculationmap as $mapping => $newid) {
408                 $gradeitem->calculation = str_replace($mapping, $newid, $gradeitem->calculation);
409             }
410             // Update the calculation now that its being remapped
411             $DB->update_record('grade_items', $gradeitem);
412         }
413         $rs->close();
415         // Need to correct the grade category path and parent
416         $conditions = array(
417             'courseid' => $this->get_courseid()
418         );
420         $rs = $DB->get_recordset('grade_categories', $conditions);
421         // Get all the parents correct first as grade_category::build_path() loads category parents from the DB
422         foreach ($rs as $gc) {
423             if (!empty($gc->parent)) {
424                 $grade_category = new stdClass();
425                 $grade_category->id = $gc->id;
426                 $grade_category->parent = $this->get_mappingid('grade_category', $gc->parent);
427                 $DB->update_record('grade_categories', $grade_category);
428             }
429         }
430         $rs->close();
432         // Now we can rebuild all the paths
433         $rs = $DB->get_recordset('grade_categories', $conditions);
434         foreach ($rs as $gc) {
435             $grade_category = new stdClass();
436             $grade_category->id = $gc->id;
437             $grade_category->path = grade_category::build_path($gc);
438             $grade_category->depth = substr_count($grade_category->path, '/') - 1;
439             $DB->update_record('grade_categories', $grade_category);
440         }
441         $rs->close();
443         // Restore marks items as needing update. Update everything now.
444         grade_regrade_final_grades($this->get_courseid());
445     }
448 /**
449  * decode all the interlinks present in restored content
450  * relying 100% in the restore_decode_processor that handles
451  * both the contents to modify and the rules to be applied
452  */
453 class restore_decode_interlinks extends restore_execution_step {
455     protected function define_execution() {
456         // Get the decoder (from the plan)
457         $decoder = $this->task->get_decoder();
458         restore_decode_processor::register_link_decoders($decoder); // Add decoder contents and rules
459         // And launch it, everything will be processed
460         $decoder->execute();
461     }
464 /**
465  * first, ensure that we have no gaps in section numbers
466  * and then, rebuid the course cache
467  */
468 class restore_rebuild_course_cache extends restore_execution_step {
470     protected function define_execution() {
471         global $DB;
473         // Although there is some sort of auto-recovery of missing sections
474         // present in course/formats... here we check that all the sections
475         // from 0 to MAX(section->section) exist, creating them if necessary
476         $maxsection = $DB->get_field('course_sections', 'MAX(section)', array('course' => $this->get_courseid()));
477         // Iterate over all sections
478         for ($i = 0; $i <= $maxsection; $i++) {
479             // If the section $i doesn't exist, create it
480             if (!$DB->record_exists('course_sections', array('course' => $this->get_courseid(), 'section' => $i))) {
481                 $sectionrec = array(
482                     'course' => $this->get_courseid(),
483                     'section' => $i);
484                 $DB->insert_record('course_sections', $sectionrec); // missing section created
485             }
486         }
488         // Rebuild cache now that all sections are in place
489         rebuild_course_cache($this->get_courseid());
490         cache_helper::purge_by_event('changesincourse');
491         cache_helper::purge_by_event('changesincoursecat');
492     }
495 /**
496  * Review all the tasks having one after_restore method
497  * executing it to perform some final adjustments of information
498  * not available when the task was executed.
499  */
500 class restore_execute_after_restore extends restore_execution_step {
502     protected function define_execution() {
504         // Simply call to the execute_after_restore() method of the task
505         // that always is the restore_final_task
506         $this->task->launch_execute_after_restore();
507     }
511 /**
512  * Review all the (pending) block positions in backup_ids, matching by
513  * contextid, creating positions as needed. This is executed by the
514  * final task, once all the contexts have been created
515  */
516 class restore_review_pending_block_positions extends restore_execution_step {
518     protected function define_execution() {
519         global $DB;
521         // Get all the block_position objects pending to match
522         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
523         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
524         // Process block positions, creating them or accumulating for final step
525         foreach($rs as $posrec) {
526             // Get the complete position object out of the info field.
527             $position = backup_controller_dbops::decode_backup_temp_info($posrec->info);
528             // If position is for one already mapped (known) contextid
529             // process it now, creating the position, else nothing to
530             // do, position finally discarded
531             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
532                 $position->contextid = $newctx->newitemid;
533                 // Create the block position
534                 $DB->insert_record('block_positions', $position);
535             }
536         }
537         $rs->close();
538     }
542 /**
543  * Updates the availability data for course modules and sections.
544  *
545  * Runs after the restore of all course modules, sections, and grade items has
546  * completed. This is necessary in order to update IDs that have changed during
547  * restore.
548  *
549  * @package core_backup
550  * @copyright 2014 The Open University
551  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
552  */
553 class restore_update_availability extends restore_execution_step {
555     protected function define_execution() {
556         global $CFG, $DB;
558         // Note: This code runs even if availability is disabled when restoring.
559         // That will ensure that if you later turn availability on for the site,
560         // there will be no incorrect IDs. (It doesn't take long if the restored
561         // data does not contain any availability information.)
563         // Get modinfo with all data after resetting cache.
564         rebuild_course_cache($this->get_courseid(), true);
565         $modinfo = get_fast_modinfo($this->get_courseid());
567         // Update all sections that were restored.
568         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'course_section');
569         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'newitemid');
570         $sectionsbyid = null;
571         foreach ($rs as $rec) {
572             if (is_null($sectionsbyid)) {
573                 $sectionsbyid = array();
574                 foreach ($modinfo->get_section_info_all() as $section) {
575                     $sectionsbyid[$section->id] = $section;
576                 }
577             }
578             if (!array_key_exists($rec->newitemid, $sectionsbyid)) {
579                 // If the section was not fully restored for some reason
580                 // (e.g. due to an earlier error), skip it.
581                 $this->get_logger()->process('Section not fully restored: id ' .
582                         $rec->newitemid, backup::LOG_WARNING);
583                 continue;
584             }
585             $section = $sectionsbyid[$rec->newitemid];
586             if (!is_null($section->availability)) {
587                 $info = new \core_availability\info_section($section);
588                 $info->update_after_restore($this->get_restoreid(),
589                         $this->get_courseid(), $this->get_logger());
590             }
591         }
592         $rs->close();
594         // Update all modules that were restored.
595         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'course_module');
596         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'newitemid');
597         foreach ($rs as $rec) {
598             if (!array_key_exists($rec->newitemid, $modinfo->cms)) {
599                 // If the module was not fully restored for some reason
600                 // (e.g. due to an earlier error), skip it.
601                 $this->get_logger()->process('Module not fully restored: id ' .
602                         $rec->newitemid, backup::LOG_WARNING);
603                 continue;
604             }
605             $cm = $modinfo->get_cm($rec->newitemid);
606             if (!is_null($cm->availability)) {
607                 $info = new \core_availability\info_module($cm);
608                 $info->update_after_restore($this->get_restoreid(),
609                         $this->get_courseid(), $this->get_logger());
610             }
611         }
612         $rs->close();
613     }
617 /**
618  * Process legacy module availability records in backup_ids.
619  *
620  * Matches course modules and grade item id once all them have been already restored.
621  * Only if all matchings are satisfied the availability condition will be created.
622  * At the same time, it is required for the site to have that functionality enabled.
623  *
624  * This step is included only to handle legacy backups (2.6 and before). It does not
625  * do anything for newer backups.
626  *
627  * @copyright 2014 The Open University
628  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
629  */
630 class restore_process_course_modules_availability extends restore_execution_step {
632     protected function define_execution() {
633         global $CFG, $DB;
635         // Site hasn't availability enabled
636         if (empty($CFG->enableavailability)) {
637             return;
638         }
640         // Do both modules and sections.
641         foreach (array('module', 'section') as $table) {
642             // Get all the availability objects to process.
643             $params = array('backupid' => $this->get_restoreid(), 'itemname' => $table . '_availability');
644             $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
645             // Process availabilities, creating them if everything matches ok.
646             foreach ($rs as $availrec) {
647                 $allmatchesok = true;
648                 // Get the complete legacy availability object.
649                 $availability = backup_controller_dbops::decode_backup_temp_info($availrec->info);
651                 // Note: This code used to update IDs, but that is now handled by the
652                 // current code (after restore) instead of this legacy code.
654                 // Get showavailability option.
655                 $thingid = ($table === 'module') ? $availability->coursemoduleid :
656                         $availability->coursesectionid;
657                 $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
658                         $table . '_showavailability', $thingid);
659                 if (!$showrec) {
660                     // Should not happen.
661                     throw new coding_exception('No matching showavailability record');
662                 }
663                 $show = $showrec->info->showavailability;
665                 // The $availability object is now in the format used in the old
666                 // system. Interpret this and convert to new system.
667                 $currentvalue = $DB->get_field('course_' . $table . 's', 'availability',
668                         array('id' => $thingid), MUST_EXIST);
669                 $newvalue = \core_availability\info::add_legacy_availability_condition(
670                         $currentvalue, $availability, $show);
671                 $DB->set_field('course_' . $table . 's', 'availability', $newvalue,
672                         array('id' => $thingid));
673             }
674         }
675         $rs->close();
676     }
680 /*
681  * Execution step that, *conditionally* (if there isn't preloaded information)
682  * will load the inforef files for all the included course/section/activity tasks
683  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
684  */
685 class restore_load_included_inforef_records extends restore_execution_step {
687     protected function define_execution() {
689         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
690             return;
691         }
693         // Get all the included tasks
694         $tasks = restore_dbops::get_included_tasks($this->get_restoreid());
695         $progress = $this->task->get_progress();
696         $progress->start_progress($this->get_name(), count($tasks));
697         foreach ($tasks as $task) {
698             // Load the inforef.xml file if exists
699             $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
700             if (file_exists($inforefpath)) {
701                 // Load each inforef file to temp_ids.
702                 restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $inforefpath, $progress);
703             }
704         }
705         $progress->end_progress();
706     }
709 /*
710  * Execution step that will load all the needed files into backup_files_temp
711  *   - info: contains the whole original object (times, names...)
712  * (all them being original ids as loaded from xml)
713  */
714 class restore_load_included_files extends restore_structure_step {
716     protected function define_structure() {
718         $file = new restore_path_element('file', '/files/file');
720         return array($file);
721     }
723     /**
724      * Process one <file> element from files.xml
725      *
726      * @param array $data the element data
727      */
728     public function process_file($data) {
730         $data = (object)$data; // handy
732         // load it if needed:
733         //   - it it is one of the annotated inforef files (course/section/activity/block)
734         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
735         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
736         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
737         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
738         $iscomponent = ($data->component == 'user' || $data->component == 'group' || $data->component == 'badges' ||
739                         $data->component == 'grouping' || $data->component == 'grade' ||
740                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
741         if ($isfileref || $iscomponent) {
742             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
743         }
744     }
747 /**
748  * Execution step that, *conditionally* (if there isn't preloaded information),
749  * will load all the needed roles to backup_temp_ids. They will be stored with
750  * "role" itemname. Also it will perform one automatic mapping to roles existing
751  * in the target site, based in permissions of the user performing the restore,
752  * archetypes and other bits. At the end, each original role will have its associated
753  * target role or 0 if it's going to be skipped. Note we wrap everything over one
754  * restore_dbops method, as far as the same stuff is going to be also executed
755  * by restore prechecks
756  */
757 class restore_load_and_map_roles extends restore_execution_step {
759     protected function define_execution() {
760         if ($this->task->get_preloaded_information()) { // if info is already preloaded
761             return;
762         }
764         $file = $this->get_basepath() . '/roles.xml';
765         // Load needed toles to temp_ids
766         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
768         // Process roles, mapping/skipping. Any error throws exception
769         // Note we pass controller's info because it can contain role mapping information
770         // about manual mappings performed by UI
771         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);
772     }
775 /**
776  * Execution step that, *conditionally* (if there isn't preloaded information
777  * and users have been selected in settings, will load all the needed users
778  * to backup_temp_ids. They will be stored with "user" itemname and with
779  * their original contextid as paremitemid
780  */
781 class restore_load_included_users extends restore_execution_step {
783     protected function define_execution() {
785         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
786             return;
787         }
788         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
789             return;
790         }
791         $file = $this->get_basepath() . '/users.xml';
792         // Load needed users to temp_ids.
793         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file, $this->task->get_progress());
794     }
797 /**
798  * Execution step that, *conditionally* (if there isn't preloaded information
799  * and users have been selected in settings, will process all the needed users
800  * in order to decide and perform any action with them (create / map / error)
801  * Note: Any error will cause exception, as far as this is the same processing
802  * than the one into restore prechecks (that should have stopped process earlier)
803  */
804 class restore_process_included_users extends restore_execution_step {
806     protected function define_execution() {
808         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
809             return;
810         }
811         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
812             return;
813         }
814         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(),
815                 $this->task->get_userid(), $this->task->is_samesite(), $this->task->get_progress());
816     }
819 /**
820  * Execution step that will create all the needed users as calculated
821  * by @restore_process_included_users (those having newiteind = 0)
822  */
823 class restore_create_included_users extends restore_execution_step {
825     protected function define_execution() {
827         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(),
828                 $this->task->get_userid(), $this->task->get_progress());
829     }
832 /**
833  * Structure step that will create all the needed groups and groupings
834  * by loading them from the groups.xml file performing the required matches.
835  * Note group members only will be added if restoring user info
836  */
837 class restore_groups_structure_step extends restore_structure_step {
839     protected function define_structure() {
841         $paths = array(); // Add paths here
843         $paths[] = new restore_path_element('group', '/groups/group');
844         $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
845         $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
847         return $paths;
848     }
850     // Processing functions go here
851     public function process_group($data) {
852         global $DB;
854         $data = (object)$data; // handy
855         $data->courseid = $this->get_courseid();
857         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
858         // another a group in the same course
859         $context = context_course::instance($data->courseid);
860         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
861             if (groups_get_group_by_idnumber($data->courseid, $data->idnumber)) {
862                 unset($data->idnumber);
863             }
864         } else {
865             unset($data->idnumber);
866         }
868         $oldid = $data->id;    // need this saved for later
870         $restorefiles = false; // Only if we end creating the group
872         // Search if the group already exists (by name & description) in the target course
873         $description_clause = '';
874         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
875         if (!empty($data->description)) {
876             $description_clause = ' AND ' .
877                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
878            $params['description'] = $data->description;
879         }
880         if (!$groupdb = $DB->get_record_sql("SELECT *
881                                                FROM {groups}
882                                               WHERE courseid = :courseid
883                                                 AND name = :grname $description_clause", $params)) {
884             // group doesn't exist, create
885             $newitemid = $DB->insert_record('groups', $data);
886             $restorefiles = true; // We'll restore the files
887         } else {
888             // group exists, use it
889             $newitemid = $groupdb->id;
890         }
891         // Save the id mapping
892         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
893         // Invalidate the course group data cache just in case.
894         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
895     }
897     public function process_grouping($data) {
898         global $DB;
900         $data = (object)$data; // handy
901         $data->courseid = $this->get_courseid();
903         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
904         // another a grouping in the same course
905         $context = context_course::instance($data->courseid);
906         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
907             if (groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) {
908                 unset($data->idnumber);
909             }
910         } else {
911             unset($data->idnumber);
912         }
914         $oldid = $data->id;    // need this saved for later
915         $restorefiles = false; // Only if we end creating the grouping
917         // Search if the grouping already exists (by name & description) in the target course
918         $description_clause = '';
919         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
920         if (!empty($data->description)) {
921             $description_clause = ' AND ' .
922                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
923            $params['description'] = $data->description;
924         }
925         if (!$groupingdb = $DB->get_record_sql("SELECT *
926                                                   FROM {groupings}
927                                                  WHERE courseid = :courseid
928                                                    AND name = :grname $description_clause", $params)) {
929             // grouping doesn't exist, create
930             $newitemid = $DB->insert_record('groupings', $data);
931             $restorefiles = true; // We'll restore the files
932         } else {
933             // grouping exists, use it
934             $newitemid = $groupingdb->id;
935         }
936         // Save the id mapping
937         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
938         // Invalidate the course group data cache just in case.
939         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
940     }
942     public function process_grouping_group($data) {
943         global $CFG;
945         require_once($CFG->dirroot.'/group/lib.php');
947         $data = (object)$data;
948         groups_assign_grouping($this->get_new_parentid('grouping'), $this->get_mappingid('group', $data->groupid), $data->timeadded);
949     }
951     protected function after_execute() {
952         // Add group related files, matching with "group" mappings
953         $this->add_related_files('group', 'icon', 'group');
954         $this->add_related_files('group', 'description', 'group');
955         // Add grouping related files, matching with "grouping" mappings
956         $this->add_related_files('grouping', 'description', 'grouping');
957         // Invalidate the course group data.
958         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($this->get_courseid()));
959     }
963 /**
964  * Structure step that will create all the needed group memberships
965  * by loading them from the groups.xml file performing the required matches.
966  */
967 class restore_groups_members_structure_step extends restore_structure_step {
969     protected $plugins = null;
971     protected function define_structure() {
973         $paths = array(); // Add paths here
975         if ($this->get_setting_value('users')) {
976             $paths[] = new restore_path_element('group', '/groups/group');
977             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
978         }
980         return $paths;
981     }
983     public function process_group($data) {
984         $data = (object)$data; // handy
986         // HACK ALERT!
987         // Not much to do here, this groups mapping should be already done from restore_groups_structure_step.
988         // Let's fake internal state to make $this->get_new_parentid('group') work.
990         $this->set_mapping('group', $data->id, $this->get_mappingid('group', $data->id));
991     }
993     public function process_member($data) {
994         global $DB, $CFG;
995         require_once("$CFG->dirroot/group/lib.php");
997         // NOTE: Always use groups_add_member() because it triggers events and verifies if user is enrolled.
999         $data = (object)$data; // handy
1001         // get parent group->id
1002         $data->groupid = $this->get_new_parentid('group');
1004         // map user newitemid and insert if not member already
1005         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
1006             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
1007                 // Check the component, if any, exists.
1008                 if (empty($data->component)) {
1009                     groups_add_member($data->groupid, $data->userid);
1011                 } else if ((strpos($data->component, 'enrol_') === 0)) {
1012                     // Deal with enrolment groups - ignore the component and just find out the instance via new id,
1013                     // it is possible that enrolment was restored using different plugin type.
1014                     if (!isset($this->plugins)) {
1015                         $this->plugins = enrol_get_plugins(true);
1016                     }
1017                     if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1018                         if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1019                             if (isset($this->plugins[$instance->enrol])) {
1020                                 $this->plugins[$instance->enrol]->restore_group_member($instance, $data->groupid, $data->userid);
1021                             }
1022                         }
1023                     }
1025                 } else {
1026                     $dir = core_component::get_component_directory($data->component);
1027                     if ($dir and is_dir($dir)) {
1028                         if (component_callback($data->component, 'restore_group_member', array($this, $data), true)) {
1029                             return;
1030                         }
1031                     }
1032                     // Bad luck, plugin could not restore the data, let's add normal membership.
1033                     groups_add_member($data->groupid, $data->userid);
1034                     $message = "Restore of '$data->component/$data->itemid' group membership is not supported, using standard group membership instead.";
1035                     $this->log($message, backup::LOG_WARNING);
1036                 }
1037             }
1038         }
1039     }
1042 /**
1043  * Structure step that will create all the needed scales
1044  * by loading them from the scales.xml
1045  */
1046 class restore_scales_structure_step extends restore_structure_step {
1048     protected function define_structure() {
1050         $paths = array(); // Add paths here
1051         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
1052         return $paths;
1053     }
1055     protected function process_scale($data) {
1056         global $DB;
1058         $data = (object)$data;
1060         $restorefiles = false; // Only if we end creating the group
1062         $oldid = $data->id;    // need this saved for later
1064         // Look for scale (by 'scale' both in standard (course=0) and current course
1065         // with priority to standard scales (ORDER clause)
1066         // scale is not course unique, use get_record_sql to suppress warning
1067         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
1068         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
1069         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
1070         if (!$scadb = $DB->get_record_sql("SELECT *
1071                                             FROM {scale}
1072                                            WHERE courseid IN (0, :courseid)
1073                                              AND $compare_scale_clause
1074                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
1075             // Remap the user if possible, defaut to user performing the restore if not
1076             $userid = $this->get_mappingid('user', $data->userid);
1077             $data->userid = $userid ? $userid : $this->task->get_userid();
1078             // Remap the course if course scale
1079             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
1080             // If global scale (course=0), check the user has perms to create it
1081             // falling to course scale if not
1082             $systemctx = context_system::instance();
1083             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
1084                 $data->courseid = $this->get_courseid();
1085             }
1086             // scale doesn't exist, create
1087             $newitemid = $DB->insert_record('scale', $data);
1088             $restorefiles = true; // We'll restore the files
1089         } else {
1090             // scale exists, use it
1091             $newitemid = $scadb->id;
1092         }
1093         // Save the id mapping (with files support at system context)
1094         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1095     }
1097     protected function after_execute() {
1098         // Add scales related files, matching with "scale" mappings
1099         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
1100     }
1104 /**
1105  * Structure step that will create all the needed outocomes
1106  * by loading them from the outcomes.xml
1107  */
1108 class restore_outcomes_structure_step extends restore_structure_step {
1110     protected function define_structure() {
1112         $paths = array(); // Add paths here
1113         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
1114         return $paths;
1115     }
1117     protected function process_outcome($data) {
1118         global $DB;
1120         $data = (object)$data;
1122         $restorefiles = false; // Only if we end creating the group
1124         $oldid = $data->id;    // need this saved for later
1126         // Look for outcome (by shortname both in standard (courseid=null) and current course
1127         // with priority to standard outcomes (ORDER clause)
1128         // outcome is not course unique, use get_record_sql to suppress warning
1129         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
1130         if (!$outdb = $DB->get_record_sql('SELECT *
1131                                              FROM {grade_outcomes}
1132                                             WHERE shortname = :shortname
1133                                               AND (courseid = :courseid OR courseid IS NULL)
1134                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
1135             // Remap the user
1136             $userid = $this->get_mappingid('user', $data->usermodified);
1137             $data->usermodified = $userid ? $userid : $this->task->get_userid();
1138             // Remap the scale
1139             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
1140             // Remap the course if course outcome
1141             $data->courseid = $data->courseid ? $this->get_courseid() : null;
1142             // If global outcome (course=null), check the user has perms to create it
1143             // falling to course outcome if not
1144             $systemctx = context_system::instance();
1145             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
1146                 $data->courseid = $this->get_courseid();
1147             }
1148             // outcome doesn't exist, create
1149             $newitemid = $DB->insert_record('grade_outcomes', $data);
1150             $restorefiles = true; // We'll restore the files
1151         } else {
1152             // scale exists, use it
1153             $newitemid = $outdb->id;
1154         }
1155         // Set the corresponding grade_outcomes_courses record
1156         $outcourserec = new stdclass();
1157         $outcourserec->courseid  = $this->get_courseid();
1158         $outcourserec->outcomeid = $newitemid;
1159         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
1160             $DB->insert_record('grade_outcomes_courses', $outcourserec);
1161         }
1162         // Save the id mapping (with files support at system context)
1163         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1164     }
1166     protected function after_execute() {
1167         // Add outcomes related files, matching with "outcome" mappings
1168         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
1169     }
1172 /**
1173  * Execution step that, *conditionally* (if there isn't preloaded information
1174  * will load all the question categories and questions (header info only)
1175  * to backup_temp_ids. They will be stored with "question_category" and
1176  * "question" itemnames and with their original contextid and question category
1177  * id as paremitemids
1178  */
1179 class restore_load_categories_and_questions extends restore_execution_step {
1181     protected function define_execution() {
1183         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1184             return;
1185         }
1186         $file = $this->get_basepath() . '/questions.xml';
1187         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
1188     }
1191 /**
1192  * Execution step that, *conditionally* (if there isn't preloaded information)
1193  * will process all the needed categories and questions
1194  * in order to decide and perform any action with them (create / map / error)
1195  * Note: Any error will cause exception, as far as this is the same processing
1196  * than the one into restore prechecks (that should have stopped process earlier)
1197  */
1198 class restore_process_categories_and_questions extends restore_execution_step {
1200     protected function define_execution() {
1202         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1203             return;
1204         }
1205         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
1206     }
1209 /**
1210  * Structure step that will read the section.xml creating/updating sections
1211  * as needed, rebuilding course cache and other friends
1212  */
1213 class restore_section_structure_step extends restore_structure_step {
1215     protected function define_structure() {
1216         global $CFG;
1218         $paths = array();
1220         $section = new restore_path_element('section', '/section');
1221         $paths[] = $section;
1222         if ($CFG->enableavailability) {
1223             $paths[] = new restore_path_element('availability', '/section/availability');
1224             $paths[] = new restore_path_element('availability_field', '/section/availability_field');
1225         }
1226         $paths[] = new restore_path_element('course_format_options', '/section/course_format_options');
1228         // Apply for 'format' plugins optional paths at section level
1229         $this->add_plugin_structure('format', $section);
1231         // Apply for 'local' plugins optional paths at section level
1232         $this->add_plugin_structure('local', $section);
1234         return $paths;
1235     }
1237     public function process_section($data) {
1238         global $CFG, $DB;
1239         $data = (object)$data;
1240         $oldid = $data->id; // We'll need this later
1242         $restorefiles = false;
1244         // Look for the section
1245         $section = new stdclass();
1246         $section->course  = $this->get_courseid();
1247         $section->section = $data->number;
1248         // Section doesn't exist, create it with all the info from backup
1249         if (!$secrec = $DB->get_record('course_sections', (array)$section)) {
1250             $section->name = $data->name;
1251             $section->summary = $data->summary;
1252             $section->summaryformat = $data->summaryformat;
1253             $section->sequence = '';
1254             $section->visible = $data->visible;
1255             if (empty($CFG->enableavailability)) { // Process availability information only if enabled.
1256                 $section->availability = null;
1257             } else {
1258                 $section->availability = isset($data->availabilityjson) ? $data->availabilityjson : null;
1259                 // Include legacy [<2.7] availability data if provided.
1260                 if (is_null($section->availability)) {
1261                     $section->availability = \core_availability\info::convert_legacy_fields(
1262                             $data, true);
1263                 }
1264             }
1265             $newitemid = $DB->insert_record('course_sections', $section);
1266             $restorefiles = true;
1268         // Section exists, update non-empty information
1269         } else {
1270             $section->id = $secrec->id;
1271             if ((string)$secrec->name === '') {
1272                 $section->name = $data->name;
1273             }
1274             if (empty($secrec->summary)) {
1275                 $section->summary = $data->summary;
1276                 $section->summaryformat = $data->summaryformat;
1277                 $restorefiles = true;
1278             }
1280             // Don't update availability (I didn't see a useful way to define
1281             // whether existing or new one should take precedence).
1283             $DB->update_record('course_sections', $section);
1284             $newitemid = $secrec->id;
1285         }
1287         // Annotate the section mapping, with restorefiles option if needed
1288         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
1290         // set the new course_section id in the task
1291         $this->task->set_sectionid($newitemid);
1293         // If there is the legacy showavailability data, store this for later use.
1294         // (This data is not present when restoring 'new' backups.)
1295         if (isset($data->showavailability)) {
1296             // Cache the showavailability flag using the backup_ids data field.
1297             restore_dbops::set_backup_ids_record($this->get_restoreid(),
1298                     'section_showavailability', $newitemid, 0, null,
1299                     (object)array('showavailability' => $data->showavailability));
1300         }
1302         // Commented out. We never modify course->numsections as far as that is used
1303         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
1304         // Note: We keep the code here, to know about and because of the possibility of making this
1305         // optional based on some setting/attribute in the future
1306         // If needed, adjust course->numsections
1307         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
1308         //    if ($numsections < $section->section) {
1309         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
1310         //    }
1311         //}
1312     }
1314     /**
1315      * Process the legacy availability table record. This table does not exist
1316      * in Moodle 2.7+ but we still support restore.
1317      *
1318      * @param stdClass $data Record data
1319      */
1320     public function process_availability($data) {
1321         $data = (object)$data;
1322         // Simply going to store the whole availability record now, we'll process
1323         // all them later in the final task (once all activities have been restored)
1324         // Let's call the low level one to be able to store the whole object.
1325         $data->coursesectionid = $this->task->get_sectionid();
1326         restore_dbops::set_backup_ids_record($this->get_restoreid(),
1327                 'section_availability', $data->id, 0, null, $data);
1328     }
1330     /**
1331      * Process the legacy availability fields table record. This table does not
1332      * exist in Moodle 2.7+ but we still support restore.
1333      *
1334      * @param stdClass $data Record data
1335      */
1336     public function process_availability_field($data) {
1337         global $DB;
1338         $data = (object)$data;
1339         // Mark it is as passed by default
1340         $passed = true;
1341         $customfieldid = null;
1343         // If a customfield has been used in order to pass we must be able to match an existing
1344         // customfield by name (data->customfield) and type (data->customfieldtype)
1345         if (is_null($data->customfield) xor is_null($data->customfieldtype)) {
1346             // xor is sort of uncommon. If either customfield is null or customfieldtype is null BUT not both.
1347             // If one is null but the other isn't something clearly went wrong and we'll skip this condition.
1348             $passed = false;
1349         } else if (!is_null($data->customfield)) {
1350             $params = array('shortname' => $data->customfield, 'datatype' => $data->customfieldtype);
1351             $customfieldid = $DB->get_field('user_info_field', 'id', $params);
1352             $passed = ($customfieldid !== false);
1353         }
1355         if ($passed) {
1356             // Create the object to insert into the database
1357             $availfield = new stdClass();
1358             $availfield->coursesectionid = $this->task->get_sectionid();
1359             $availfield->userfield = $data->userfield;
1360             $availfield->customfieldid = $customfieldid;
1361             $availfield->operator = $data->operator;
1362             $availfield->value = $data->value;
1364             // Get showavailability option.
1365             $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
1366                     'section_showavailability', $availfield->coursesectionid);
1367             if (!$showrec) {
1368                 // Should not happen.
1369                 throw new coding_exception('No matching showavailability record');
1370             }
1371             $show = $showrec->info->showavailability;
1373             // The $availfield object is now in the format used in the old
1374             // system. Interpret this and convert to new system.
1375             $currentvalue = $DB->get_field('course_sections', 'availability',
1376                     array('id' => $availfield->coursesectionid), MUST_EXIST);
1377             $newvalue = \core_availability\info::add_legacy_availability_field_condition(
1378                     $currentvalue, $availfield, $show);
1379             $DB->set_field('course_sections', 'availability', $newvalue,
1380                     array('id' => $availfield->coursesectionid));
1381         }
1382     }
1384     public function process_course_format_options($data) {
1385         global $DB;
1386         $data = (object)$data;
1387         $oldid = $data->id;
1388         unset($data->id);
1389         $data->sectionid = $this->task->get_sectionid();
1390         $data->courseid = $this->get_courseid();
1391         $newid = $DB->insert_record('course_format_options', $data);
1392         $this->set_mapping('course_format_options', $oldid, $newid);
1393     }
1395     protected function after_execute() {
1396         // Add section related files, with 'course_section' itemid to match
1397         $this->add_related_files('course', 'section', 'course_section');
1398     }
1401 /**
1402  * Structure step that will read the course.xml file, loading it and performing
1403  * various actions depending of the site/restore settings. Note that target
1404  * course always exist before arriving here so this step will be updating
1405  * the course record (never inserting)
1406  */
1407 class restore_course_structure_step extends restore_structure_step {
1408     /**
1409      * @var bool this gets set to true by {@link process_course()} if we are
1410      * restoring an old coures that used the legacy 'module security' feature.
1411      * If so, we have to do more work in {@link after_execute()}.
1412      */
1413     protected $legacyrestrictmodules = false;
1415     /**
1416      * @var array Used when {@link $legacyrestrictmodules} is true. This is an
1417      * array with array keys the module names ('forum', 'quiz', etc.). These are
1418      * the modules that are allowed according to the data in the backup file.
1419      * In {@link after_execute()} we then have to prevent adding of all the other
1420      * types of activity.
1421      */
1422     protected $legacyallowedmodules = array();
1424     protected function define_structure() {
1426         $course = new restore_path_element('course', '/course');
1427         $category = new restore_path_element('category', '/course/category');
1428         $tag = new restore_path_element('tag', '/course/tags/tag');
1429         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1431         // Apply for 'format' plugins optional paths at course level
1432         $this->add_plugin_structure('format', $course);
1434         // Apply for 'theme' plugins optional paths at course level
1435         $this->add_plugin_structure('theme', $course);
1437         // Apply for 'report' plugins optional paths at course level
1438         $this->add_plugin_structure('report', $course);
1440         // Apply for 'course report' plugins optional paths at course level
1441         $this->add_plugin_structure('coursereport', $course);
1443         // Apply for plagiarism plugins optional paths at course level
1444         $this->add_plugin_structure('plagiarism', $course);
1446         // Apply for local plugins optional paths at course level
1447         $this->add_plugin_structure('local', $course);
1449         return array($course, $category, $tag, $allowed_module);
1450     }
1452     /**
1453      * Processing functions go here
1454      *
1455      * @global moodledatabase $DB
1456      * @param stdClass $data
1457      */
1458     public function process_course($data) {
1459         global $CFG, $DB;
1461         $data = (object)$data;
1463         $fullname  = $this->get_setting_value('course_fullname');
1464         $shortname = $this->get_setting_value('course_shortname');
1465         $startdate = $this->get_setting_value('course_startdate');
1467         // Calculate final course names, to avoid dupes
1468         list($fullname, $shortname) = restore_dbops::calculate_course_names($this->get_courseid(), $fullname, $shortname);
1470         // Need to change some fields before updating the course record
1471         $data->id = $this->get_courseid();
1472         $data->fullname = $fullname;
1473         $data->shortname= $shortname;
1475         $context = context::instance_by_id($this->task->get_contextid());
1476         if (has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1477             $data->idnumber = '';
1478         } else {
1479             unset($data->idnumber);
1480         }
1482         // Any empty value for course->hiddensections will lead to 0 (default, show collapsed).
1483         // It has been reported that some old 1.9 courses may have it null leading to DB error. MDL-31532
1484         if (empty($data->hiddensections)) {
1485             $data->hiddensections = 0;
1486         }
1488         // Set legacyrestrictmodules to true if the course was resticting modules. If so
1489         // then we will need to process restricted modules after execution.
1490         $this->legacyrestrictmodules = !empty($data->restrictmodules);
1492         $data->startdate= $this->apply_date_offset($data->startdate);
1493         if ($data->defaultgroupingid) {
1494             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1495         }
1496         if (empty($CFG->enablecompletion)) {
1497             $data->enablecompletion = 0;
1498             $data->completionstartonenrol = 0;
1499             $data->completionnotify = 0;
1500         }
1501         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1502         if (!array_key_exists($data->lang, $languages)) {
1503             $data->lang = '';
1504         }
1506         $themes = get_list_of_themes(); // Get themes for quick search later
1507         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1508             $data->theme = '';
1509         }
1511         // Check if this is an old SCORM course format.
1512         if ($data->format == 'scorm') {
1513             $data->format = 'singleactivity';
1514             $data->activitytype = 'scorm';
1515         }
1517         // Course record ready, update it
1518         $DB->update_record('course', $data);
1520         course_get_format($data)->update_course_format_options($data);
1522         // Role name aliases
1523         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1524     }
1526     public function process_category($data) {
1527         // Nothing to do with the category. UI sets it before restore starts
1528     }
1530     public function process_tag($data) {
1531         global $CFG, $DB;
1533         $data = (object)$data;
1535         if (!empty($CFG->usetags)) { // if enabled in server
1536             // TODO: This is highly inneficient. Each time we add one tag
1537             // we fetch all the existing because tag_set() deletes them
1538             // so everything must be reinserted on each call
1539             $tags = array();
1540             $existingtags = tag_get_tags('course', $this->get_courseid());
1541             // Re-add all the existitng tags
1542             foreach ($existingtags as $existingtag) {
1543                 $tags[] = $existingtag->rawname;
1544             }
1545             // Add the one being restored
1546             $tags[] = $data->rawname;
1547             // Send all the tags back to the course
1548             tag_set('course', $this->get_courseid(), $tags, 'core',
1549                 context_course::instance($this->get_courseid())->id);
1550         }
1551     }
1553     public function process_allowed_module($data) {
1554         $data = (object)$data;
1556         // Backwards compatiblity support for the data that used to be in the
1557         // course_allowed_modules table.
1558         if ($this->legacyrestrictmodules) {
1559             $this->legacyallowedmodules[$data->modulename] = 1;
1560         }
1561     }
1563     protected function after_execute() {
1564         global $DB;
1566         // Add course related files, without itemid to match
1567         $this->add_related_files('course', 'summary', null);
1568         $this->add_related_files('course', 'overviewfiles', null);
1570         // Deal with legacy allowed modules.
1571         if ($this->legacyrestrictmodules) {
1572             $context = context_course::instance($this->get_courseid());
1574             list($roleids) = get_roles_with_cap_in_context($context, 'moodle/course:manageactivities');
1575             list($managerroleids) = get_roles_with_cap_in_context($context, 'moodle/site:config');
1576             foreach ($managerroleids as $roleid) {
1577                 unset($roleids[$roleid]);
1578             }
1580             foreach (core_component::get_plugin_list('mod') as $modname => $notused) {
1581                 if (isset($this->legacyallowedmodules[$modname])) {
1582                     // Module is allowed, no worries.
1583                     continue;
1584                 }
1586                 $capability = 'mod/' . $modname . ':addinstance';
1587                 foreach ($roleids as $roleid) {
1588                     assign_capability($capability, CAP_PREVENT, $roleid, $context);
1589                 }
1590             }
1591         }
1592     }
1595 /**
1596  * Execution step that will migrate legacy files if present.
1597  */
1598 class restore_course_legacy_files_step extends restore_execution_step {
1599     public function define_execution() {
1600         global $DB;
1602         // Do a check for legacy files and skip if there are none.
1603         $sql = 'SELECT count(*)
1604                   FROM {backup_files_temp}
1605                  WHERE backupid = ?
1606                    AND contextid = ?
1607                    AND component = ?
1608                    AND filearea  = ?';
1609         $params = array($this->get_restoreid(), $this->task->get_old_contextid(), 'course', 'legacy');
1611         if ($DB->count_records_sql($sql, $params)) {
1612             $DB->set_field('course', 'legacyfiles', 2, array('id' => $this->get_courseid()));
1613             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'course',
1614                 'legacy', $this->task->get_old_contextid(), $this->task->get_userid());
1615         }
1616     }
1619 /*
1620  * Structure step that will read the roles.xml file (at course/activity/block levels)
1621  * containing all the role_assignments and overrides for that context. If corresponding to
1622  * one mapped role, they will be applied to target context. Will observe the role_assignments
1623  * setting to decide if ras are restored.
1624  *
1625  * Note: this needs to be executed after all users are enrolled.
1626  */
1627 class restore_ras_and_caps_structure_step extends restore_structure_step {
1628     protected $plugins = null;
1630     protected function define_structure() {
1632         $paths = array();
1634         // Observe the role_assignments setting
1635         if ($this->get_setting_value('role_assignments')) {
1636             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
1637         }
1638         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
1640         return $paths;
1641     }
1643     /**
1644      * Assign roles
1645      *
1646      * This has to be called after enrolments processing.
1647      *
1648      * @param mixed $data
1649      * @return void
1650      */
1651     public function process_assignment($data) {
1652         global $DB;
1654         $data = (object)$data;
1656         // Check roleid, userid are one of the mapped ones
1657         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
1658             return;
1659         }
1660         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
1661             return;
1662         }
1663         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
1664             // Only assign roles to not deleted users
1665             return;
1666         }
1667         if (!$contextid = $this->task->get_contextid()) {
1668             return;
1669         }
1671         if (empty($data->component)) {
1672             // assign standard manual roles
1673             // TODO: role_assign() needs one userid param to be able to specify our restore userid
1674             role_assign($newroleid, $newuserid, $contextid);
1676         } else if ((strpos($data->component, 'enrol_') === 0)) {
1677             // Deal with enrolment roles - ignore the component and just find out the instance via new id,
1678             // it is possible that enrolment was restored using different plugin type.
1679             if (!isset($this->plugins)) {
1680                 $this->plugins = enrol_get_plugins(true);
1681             }
1682             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1683                 if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1684                     if (isset($this->plugins[$instance->enrol])) {
1685                         $this->plugins[$instance->enrol]->restore_role_assignment($instance, $newroleid, $newuserid, $contextid);
1686                     }
1687                 }
1688             }
1690         } else {
1691             $data->roleid    = $newroleid;
1692             $data->userid    = $newuserid;
1693             $data->contextid = $contextid;
1694             $dir = core_component::get_component_directory($data->component);
1695             if ($dir and is_dir($dir)) {
1696                 if (component_callback($data->component, 'restore_role_assignment', array($this, $data), true)) {
1697                     return;
1698                 }
1699             }
1700             // Bad luck, plugin could not restore the data, let's add normal membership.
1701             role_assign($data->roleid, $data->userid, $data->contextid);
1702             $message = "Restore of '$data->component/$data->itemid' role assignments is not supported, using manual role assignments instead.";
1703             $this->log($message, backup::LOG_WARNING);
1704         }
1705     }
1707     public function process_override($data) {
1708         $data = (object)$data;
1710         // Check roleid is one of the mapped ones
1711         $newroleid = $this->get_mappingid('role', $data->roleid);
1712         // If newroleid and context are valid assign it via API (it handles dupes and so on)
1713         if ($newroleid && $this->task->get_contextid()) {
1714             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
1715             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
1716             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
1717         }
1718     }
1721 /**
1722  * If no instances yet add default enrol methods the same way as when creating new course in UI.
1723  */
1724 class restore_default_enrolments_step extends restore_execution_step {
1725     public function define_execution() {
1726         global $DB;
1728         $course = $DB->get_record('course', array('id'=>$this->get_courseid()), '*', MUST_EXIST);
1730         if ($DB->record_exists('enrol', array('courseid'=>$this->get_courseid(), 'enrol'=>'manual'))) {
1731             // Something already added instances, do not add default instances.
1732             $plugins = enrol_get_plugins(true);
1733             foreach ($plugins as $plugin) {
1734                 $plugin->restore_sync_course($course);
1735             }
1737         } else {
1738             // Looks like a newly created course.
1739             enrol_course_updated(true, $course, null);
1740         }
1741     }
1744 /**
1745  * This structure steps restores the enrol plugins and their underlying
1746  * enrolments, performing all the mappings and/or movements required
1747  */
1748 class restore_enrolments_structure_step extends restore_structure_step {
1749     protected $enrolsynced = false;
1750     protected $plugins = null;
1751     protected $originalstatus = array();
1753     /**
1754      * Conditionally decide if this step should be executed.
1755      *
1756      * This function checks the following parameter:
1757      *
1758      *   1. the course/enrolments.xml file exists
1759      *
1760      * @return bool true is safe to execute, false otherwise
1761      */
1762     protected function execute_condition() {
1764         // Check it is included in the backup
1765         $fullpath = $this->task->get_taskbasepath();
1766         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1767         if (!file_exists($fullpath)) {
1768             // Not found, can't restore enrolments info
1769             return false;
1770         }
1772         return true;
1773     }
1775     protected function define_structure() {
1777         $paths = array();
1779         $paths[] = new restore_path_element('enrol', '/enrolments/enrols/enrol');
1780         $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
1782         return $paths;
1783     }
1785     /**
1786      * Create enrolment instances.
1787      *
1788      * This has to be called after creation of roles
1789      * and before adding of role assignments.
1790      *
1791      * @param mixed $data
1792      * @return void
1793      */
1794     public function process_enrol($data) {
1795         global $DB;
1797         $data = (object)$data;
1798         $oldid = $data->id; // We'll need this later.
1799         unset($data->id);
1801         $this->originalstatus[$oldid] = $data->status;
1803         if (!$courserec = $DB->get_record('course', array('id' => $this->get_courseid()))) {
1804             $this->set_mapping('enrol', $oldid, 0);
1805             return;
1806         }
1808         if (!isset($this->plugins)) {
1809             $this->plugins = enrol_get_plugins(true);
1810         }
1812         if (!$this->enrolsynced) {
1813             // Make sure that all plugin may create instances and enrolments automatically
1814             // before the first instance restore - this is suitable especially for plugins
1815             // that synchronise data automatically using course->idnumber or by course categories.
1816             foreach ($this->plugins as $plugin) {
1817                 $plugin->restore_sync_course($courserec);
1818             }
1819             $this->enrolsynced = true;
1820         }
1822         // Map standard fields - plugin has to process custom fields manually.
1823         $data->roleid   = $this->get_mappingid('role', $data->roleid);
1824         $data->courseid = $courserec->id;
1826         if ($this->get_setting_value('enrol_migratetomanual')) {
1827             unset($data->sortorder); // Remove useless sortorder from <2.4 backups.
1828             if (!enrol_is_enabled('manual')) {
1829                 $this->set_mapping('enrol', $oldid, 0);
1830                 return;
1831             }
1832             if ($instances = $DB->get_records('enrol', array('courseid'=>$data->courseid, 'enrol'=>'manual'), 'id')) {
1833                 $instance = reset($instances);
1834                 $this->set_mapping('enrol', $oldid, $instance->id);
1835             } else {
1836                 if ($data->enrol === 'manual') {
1837                     $instanceid = $this->plugins['manual']->add_instance($courserec, (array)$data);
1838                 } else {
1839                     $instanceid = $this->plugins['manual']->add_default_instance($courserec);
1840                 }
1841                 $this->set_mapping('enrol', $oldid, $instanceid);
1842             }
1844         } else {
1845             if (!enrol_is_enabled($data->enrol) or !isset($this->plugins[$data->enrol])) {
1846                 $this->set_mapping('enrol', $oldid, 0);
1847                 $message = "Enrol plugin '$data->enrol' data can not be restored because it is not enabled, use migration to manual enrolments";
1848                 $this->log($message, backup::LOG_WARNING);
1849                 return;
1850             }
1851             if ($task = $this->get_task() and $task->get_target() == backup::TARGET_NEW_COURSE) {
1852                 // Let's keep the sortorder in old backups.
1853             } else {
1854                 // Prevent problems with colliding sortorders in old backups,
1855                 // new 2.4 backups do not need sortorder because xml elements are ordered properly.
1856                 unset($data->sortorder);
1857             }
1858             // Note: plugin is responsible for setting up the mapping, it may also decide to migrate to different type.
1859             $this->plugins[$data->enrol]->restore_instance($this, $data, $courserec, $oldid);
1860         }
1861     }
1863     /**
1864      * Create user enrolments.
1865      *
1866      * This has to be called after creation of enrolment instances
1867      * and before adding of role assignments.
1868      *
1869      * Roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing afterwards.
1870      *
1871      * @param mixed $data
1872      * @return void
1873      */
1874     public function process_enrolment($data) {
1875         global $DB;
1877         if (!isset($this->plugins)) {
1878             $this->plugins = enrol_get_plugins(true);
1879         }
1881         $data = (object)$data;
1883         // Process only if parent instance have been mapped.
1884         if ($enrolid = $this->get_new_parentid('enrol')) {
1885             $oldinstancestatus = ENROL_INSTANCE_ENABLED;
1886             $oldenrolid = $this->get_old_parentid('enrol');
1887             if (isset($this->originalstatus[$oldenrolid])) {
1888                 $oldinstancestatus = $this->originalstatus[$oldenrolid];
1889             }
1890             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1891                 // And only if user is a mapped one.
1892                 if ($userid = $this->get_mappingid('user', $data->userid)) {
1893                     if (isset($this->plugins[$instance->enrol])) {
1894                         $this->plugins[$instance->enrol]->restore_user_enrolment($this, $data, $instance, $userid, $oldinstancestatus);
1895                     }
1896                 }
1897             }
1898         }
1899     }
1903 /**
1904  * Make sure the user restoring the course can actually access it.
1905  */
1906 class restore_fix_restorer_access_step extends restore_execution_step {
1907     protected function define_execution() {
1908         global $CFG, $DB;
1910         if (!$userid = $this->task->get_userid()) {
1911             return;
1912         }
1914         if (empty($CFG->restorernewroleid)) {
1915             // Bad luck, no fallback role for restorers specified
1916             return;
1917         }
1919         $courseid = $this->get_courseid();
1920         $context = context_course::instance($courseid);
1922         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1923             // Current user may access the course (admin, category manager or restored teacher enrolment usually)
1924             return;
1925         }
1927         // Try to add role only - we do not need enrolment if user has moodle/course:view or is already enrolled
1928         role_assign($CFG->restorernewroleid, $userid, $context);
1930         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1931             // Extra role is enough, yay!
1932             return;
1933         }
1935         // The last chance is to create manual enrol if it does not exist and and try to enrol the current user,
1936         // hopefully admin selected suitable $CFG->restorernewroleid ...
1937         if (!enrol_is_enabled('manual')) {
1938             return;
1939         }
1940         if (!$enrol = enrol_get_plugin('manual')) {
1941             return;
1942         }
1943         if (!$DB->record_exists('enrol', array('enrol'=>'manual', 'courseid'=>$courseid))) {
1944             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
1945             $fields = array('status'=>ENROL_INSTANCE_ENABLED, 'enrolperiod'=>$enrol->get_config('enrolperiod', 0), 'roleid'=>$enrol->get_config('roleid', 0));
1946             $enrol->add_instance($course, $fields);
1947         }
1949         enrol_try_internal_enrol($courseid, $userid);
1950     }
1954 /**
1955  * This structure steps restores the filters and their configs
1956  */
1957 class restore_filters_structure_step extends restore_structure_step {
1959     protected function define_structure() {
1961         $paths = array();
1963         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
1964         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
1966         return $paths;
1967     }
1969     public function process_active($data) {
1971         $data = (object)$data;
1973         if (strpos($data->filter, 'filter/') === 0) {
1974             $data->filter = substr($data->filter, 7);
1976         } else if (strpos($data->filter, '/') !== false) {
1977             // Unsupported old filter.
1978             return;
1979         }
1981         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1982             return;
1983         }
1984         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
1985     }
1987     public function process_config($data) {
1989         $data = (object)$data;
1991         if (strpos($data->filter, 'filter/') === 0) {
1992             $data->filter = substr($data->filter, 7);
1994         } else if (strpos($data->filter, '/') !== false) {
1995             // Unsupported old filter.
1996             return;
1997         }
1999         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
2000             return;
2001         }
2002         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
2003     }
2007 /**
2008  * This structure steps restores the comments
2009  * Note: Cannot use the comments API because defaults to USER->id.
2010  * That should change allowing to pass $userid
2011  */
2012 class restore_comments_structure_step extends restore_structure_step {
2014     protected function define_structure() {
2016         $paths = array();
2018         $paths[] = new restore_path_element('comment', '/comments/comment');
2020         return $paths;
2021     }
2023     public function process_comment($data) {
2024         global $DB;
2026         $data = (object)$data;
2028         // First of all, if the comment has some itemid, ask to the task what to map
2029         $mapping = false;
2030         if ($data->itemid) {
2031             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
2032             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
2033         }
2034         // Only restore the comment if has no mapping OR we have found the matching mapping
2035         if (!$mapping || $data->itemid) {
2036             // Only if user mapping and context
2037             $data->userid = $this->get_mappingid('user', $data->userid);
2038             if ($data->userid && $this->task->get_contextid()) {
2039                 $data->contextid = $this->task->get_contextid();
2040                 // Only if there is another comment with same context/user/timecreated
2041                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
2042                 if (!$DB->record_exists('comments', $params)) {
2043                     $DB->insert_record('comments', $data);
2044                 }
2045             }
2046         }
2047     }
2050 /**
2051  * This structure steps restores the badges and their configs
2052  */
2053 class restore_badges_structure_step extends restore_structure_step {
2055     /**
2056      * Conditionally decide if this step should be executed.
2057      *
2058      * This function checks the following parameters:
2059      *
2060      *   1. Badges and course badges are enabled on the site.
2061      *   2. The course/badges.xml file exists.
2062      *   3. All modules are restorable.
2063      *   4. All modules are marked for restore.
2064      *
2065      * @return bool True is safe to execute, false otherwise
2066      */
2067     protected function execute_condition() {
2068         global $CFG;
2070         // First check is badges and course level badges are enabled on this site.
2071         if (empty($CFG->enablebadges) || empty($CFG->badges_allowcoursebadges)) {
2072             // Disabled, don't restore course badges.
2073             return false;
2074         }
2076         // Check if badges.xml is included in the backup.
2077         $fullpath = $this->task->get_taskbasepath();
2078         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2079         if (!file_exists($fullpath)) {
2080             // Not found, can't restore course badges.
2081             return false;
2082         }
2084         // Check we are able to restore all backed up modules.
2085         if ($this->task->is_missing_modules()) {
2086             return false;
2087         }
2089         // Finally check all modules within the backup are being restored.
2090         if ($this->task->is_excluding_activities()) {
2091             return false;
2092         }
2094         return true;
2095     }
2097     protected function define_structure() {
2098         $paths = array();
2099         $paths[] = new restore_path_element('badge', '/badges/badge');
2100         $paths[] = new restore_path_element('criterion', '/badges/badge/criteria/criterion');
2101         $paths[] = new restore_path_element('parameter', '/badges/badge/criteria/criterion/parameters/parameter');
2102         $paths[] = new restore_path_element('manual_award', '/badges/badge/manual_awards/manual_award');
2104         return $paths;
2105     }
2107     public function process_badge($data) {
2108         global $DB, $CFG;
2110         require_once($CFG->libdir . '/badgeslib.php');
2112         $data = (object)$data;
2113         $data->usercreated = $this->get_mappingid('user', $data->usercreated);
2114         $data->usermodified = $this->get_mappingid('user', $data->usermodified);
2116         // We'll restore the badge image.
2117         $restorefiles = true;
2119         $courseid = $this->get_courseid();
2121         $params = array(
2122                 'name'           => $data->name,
2123                 'description'    => $data->description,
2124                 'timecreated'    => $this->apply_date_offset($data->timecreated),
2125                 'timemodified'   => $this->apply_date_offset($data->timemodified),
2126                 'usercreated'    => $data->usercreated,
2127                 'usermodified'   => $data->usermodified,
2128                 'issuername'     => $data->issuername,
2129                 'issuerurl'      => $data->issuerurl,
2130                 'issuercontact'  => $data->issuercontact,
2131                 'expiredate'     => $this->apply_date_offset($data->expiredate),
2132                 'expireperiod'   => $data->expireperiod,
2133                 'type'           => BADGE_TYPE_COURSE,
2134                 'courseid'       => $courseid,
2135                 'message'        => $data->message,
2136                 'messagesubject' => $data->messagesubject,
2137                 'attachment'     => $data->attachment,
2138                 'notification'   => $data->notification,
2139                 'status'         => BADGE_STATUS_INACTIVE,
2140                 'nextcron'       => $this->apply_date_offset($data->nextcron)
2141         );
2143         $newid = $DB->insert_record('badge', $params);
2144         $this->set_mapping('badge', $data->id, $newid, $restorefiles);
2145     }
2147     public function process_criterion($data) {
2148         global $DB;
2150         $data = (object)$data;
2152         $params = array(
2153                 'badgeid'      => $this->get_new_parentid('badge'),
2154                 'criteriatype' => $data->criteriatype,
2155                 'method'       => $data->method
2156         );
2157         $newid = $DB->insert_record('badge_criteria', $params);
2158         $this->set_mapping('criterion', $data->id, $newid);
2159     }
2161     public function process_parameter($data) {
2162         global $DB, $CFG;
2164         require_once($CFG->libdir . '/badgeslib.php');
2166         $data = (object)$data;
2167         $criteriaid = $this->get_new_parentid('criterion');
2169         // Parameter array that will go to database.
2170         $params = array();
2171         $params['critid'] = $criteriaid;
2173         $oldparam = explode('_', $data->name);
2175         if ($data->criteriatype == BADGE_CRITERIA_TYPE_ACTIVITY) {
2176             $module = $this->get_mappingid('course_module', $oldparam[1]);
2177             $params['name'] = $oldparam[0] . '_' . $module;
2178             $params['value'] = $oldparam[0] == 'module' ? $module : $data->value;
2179         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_COURSE) {
2180             $params['name'] = $oldparam[0] . '_' . $this->get_courseid();
2181             $params['value'] = $oldparam[0] == 'course' ? $this->get_courseid() : $data->value;
2182         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_MANUAL) {
2183             $role = $this->get_mappingid('role', $data->value);
2184             if (!empty($role)) {
2185                 $params['name'] = 'role_' . $role;
2186                 $params['value'] = $role;
2187             } else {
2188                 return;
2189             }
2190         }
2192         if (!$DB->record_exists('badge_criteria_param', $params)) {
2193             $DB->insert_record('badge_criteria_param', $params);
2194         }
2195     }
2197     public function process_manual_award($data) {
2198         global $DB;
2200         $data = (object)$data;
2201         $role = $this->get_mappingid('role', $data->issuerrole);
2203         if (!empty($role)) {
2204             $award = array(
2205                 'badgeid'     => $this->get_new_parentid('badge'),
2206                 'recipientid' => $this->get_mappingid('user', $data->recipientid),
2207                 'issuerid'    => $this->get_mappingid('user', $data->issuerid),
2208                 'issuerrole'  => $role,
2209                 'datemet'     => $this->apply_date_offset($data->datemet)
2210             );
2211             $DB->insert_record('badge_manual_award', $award);
2212         }
2213     }
2215     protected function after_execute() {
2216         // Add related files.
2217         $this->add_related_files('badges', 'badgeimage', 'badge');
2218     }
2221 /**
2222  * This structure steps restores the calendar events
2223  */
2224 class restore_calendarevents_structure_step extends restore_structure_step {
2226     protected function define_structure() {
2228         $paths = array();
2230         $paths[] = new restore_path_element('calendarevents', '/events/event');
2232         return $paths;
2233     }
2235     public function process_calendarevents($data) {
2236         global $DB, $SITE;
2238         $data = (object)$data;
2239         $oldid = $data->id;
2240         $restorefiles = true; // We'll restore the files
2241         // Find the userid and the groupid associated with the event. Return if not found.
2242         $data->userid = $this->get_mappingid('user', $data->userid);
2243         if ($data->userid === false) {
2244             return;
2245         }
2246         if (!empty($data->groupid)) {
2247             $data->groupid = $this->get_mappingid('group', $data->groupid);
2248             if ($data->groupid === false) {
2249                 return;
2250             }
2251         }
2252         // Handle events with empty eventtype //MDL-32827
2253         if(empty($data->eventtype)) {
2254             if ($data->courseid == $SITE->id) {                                // Site event
2255                 $data->eventtype = "site";
2256             } else if ($data->courseid != 0 && $data->groupid == 0 && ($data->modulename == 'assignment' || $data->modulename == 'assign')) {
2257                 // Course assingment event
2258                 $data->eventtype = "due";
2259             } else if ($data->courseid != 0 && $data->groupid == 0) {      // Course event
2260                 $data->eventtype = "course";
2261             } else if ($data->groupid) {                                      // Group event
2262                 $data->eventtype = "group";
2263             } else if ($data->userid) {                                       // User event
2264                 $data->eventtype = "user";
2265             } else {
2266                 return;
2267             }
2268         }
2270         $params = array(
2271                 'name'           => $data->name,
2272                 'description'    => $data->description,
2273                 'format'         => $data->format,
2274                 'courseid'       => $this->get_courseid(),
2275                 'groupid'        => $data->groupid,
2276                 'userid'         => $data->userid,
2277                 'repeatid'       => $data->repeatid,
2278                 'modulename'     => $data->modulename,
2279                 'eventtype'      => $data->eventtype,
2280                 'timestart'      => $this->apply_date_offset($data->timestart),
2281                 'timeduration'   => $data->timeduration,
2282                 'visible'        => $data->visible,
2283                 'uuid'           => $data->uuid,
2284                 'sequence'       => $data->sequence,
2285                 'timemodified'    => $this->apply_date_offset($data->timemodified));
2286         if ($this->name == 'activity_calendar') {
2287             $params['instance'] = $this->task->get_activityid();
2288         } else {
2289             $params['instance'] = 0;
2290         }
2291         $sql = "SELECT id
2292                   FROM {event}
2293                  WHERE " . $DB->sql_compare_text('name', 255) . " = " . $DB->sql_compare_text('?', 255) . "
2294                    AND courseid = ?
2295                    AND repeatid = ?
2296                    AND modulename = ?
2297                    AND timestart = ?
2298                    AND timeduration = ?
2299                    AND " . $DB->sql_compare_text('description', 255) . " = " . $DB->sql_compare_text('?', 255);
2300         $arg = array ($params['name'], $params['courseid'], $params['repeatid'], $params['modulename'], $params['timestart'], $params['timeduration'], $params['description']);
2301         $result = $DB->record_exists_sql($sql, $arg);
2302         if (empty($result)) {
2303             $newitemid = $DB->insert_record('event', $params);
2304             $this->set_mapping('event', $oldid, $newitemid);
2305             $this->set_mapping('event_description', $oldid, $newitemid, $restorefiles);
2306         }
2308     }
2309     protected function after_execute() {
2310         // Add related files
2311         $this->add_related_files('calendar', 'event_description', 'event_description');
2312     }
2315 class restore_course_completion_structure_step extends restore_structure_step {
2317     /**
2318      * Conditionally decide if this step should be executed.
2319      *
2320      * This function checks parameters that are not immediate settings to ensure
2321      * that the enviroment is suitable for the restore of course completion info.
2322      *
2323      * This function checks the following four parameters:
2324      *
2325      *   1. Course completion is enabled on the site
2326      *   2. The backup includes course completion information
2327      *   3. All modules are restorable
2328      *   4. All modules are marked for restore.
2329      *
2330      * @return bool True is safe to execute, false otherwise
2331      */
2332     protected function execute_condition() {
2333         global $CFG;
2335         // First check course completion is enabled on this site
2336         if (empty($CFG->enablecompletion)) {
2337             // Disabled, don't restore course completion
2338             return false;
2339         }
2341         // Check it is included in the backup
2342         $fullpath = $this->task->get_taskbasepath();
2343         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2344         if (!file_exists($fullpath)) {
2345             // Not found, can't restore course completion
2346             return false;
2347         }
2349         // Check we are able to restore all backed up modules
2350         if ($this->task->is_missing_modules()) {
2351             return false;
2352         }
2354         // Finally check all modules within the backup are being restored.
2355         if ($this->task->is_excluding_activities()) {
2356             return false;
2357         }
2359         return true;
2360     }
2362     /**
2363      * Define the course completion structure
2364      *
2365      * @return array Array of restore_path_element
2366      */
2367     protected function define_structure() {
2369         // To know if we are including user completion info
2370         $userinfo = $this->get_setting_value('userscompletion');
2372         $paths = array();
2373         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
2374         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
2376         if ($userinfo) {
2377             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
2378             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
2379         }
2381         return $paths;
2383     }
2385     /**
2386      * Process course completion criteria
2387      *
2388      * @global moodle_database $DB
2389      * @param stdClass $data
2390      */
2391     public function process_course_completion_criteria($data) {
2392         global $DB;
2394         $data = (object)$data;
2395         $data->course = $this->get_courseid();
2397         // Apply the date offset to the time end field
2398         $data->timeend = $this->apply_date_offset($data->timeend);
2400         // Map the role from the criteria
2401         if (!empty($data->role)) {
2402             $data->role = $this->get_mappingid('role', $data->role);
2403         }
2405         $skipcriteria = false;
2407         // If the completion criteria is for a module we need to map the module instance
2408         // to the new module id.
2409         if (!empty($data->moduleinstance) && !empty($data->module)) {
2410             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
2411             if (empty($data->moduleinstance)) {
2412                 $skipcriteria = true;
2413             }
2414         } else {
2415             $data->module = null;
2416             $data->moduleinstance = null;
2417         }
2419         // We backup the course shortname rather than the ID so that we can match back to the course
2420         if (!empty($data->courseinstanceshortname)) {
2421             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
2422             if (!$courseinstanceid) {
2423                 $skipcriteria = true;
2424             }
2425         } else {
2426             $courseinstanceid = null;
2427         }
2428         $data->courseinstance = $courseinstanceid;
2430         if (!$skipcriteria) {
2431             $params = array(
2432                 'course'         => $data->course,
2433                 'criteriatype'   => $data->criteriatype,
2434                 'enrolperiod'    => $data->enrolperiod,
2435                 'courseinstance' => $data->courseinstance,
2436                 'module'         => $data->module,
2437                 'moduleinstance' => $data->moduleinstance,
2438                 'timeend'        => $data->timeend,
2439                 'gradepass'      => $data->gradepass,
2440                 'role'           => $data->role
2441             );
2442             $newid = $DB->insert_record('course_completion_criteria', $params);
2443             $this->set_mapping('course_completion_criteria', $data->id, $newid);
2444         }
2445     }
2447     /**
2448      * Processes course compltion criteria complete records
2449      *
2450      * @global moodle_database $DB
2451      * @param stdClass $data
2452      */
2453     public function process_course_completion_crit_compl($data) {
2454         global $DB;
2456         $data = (object)$data;
2458         // This may be empty if criteria could not be restored
2459         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
2461         $data->course = $this->get_courseid();
2462         $data->userid = $this->get_mappingid('user', $data->userid);
2464         if (!empty($data->criteriaid) && !empty($data->userid)) {
2465             $params = array(
2466                 'userid' => $data->userid,
2467                 'course' => $data->course,
2468                 'criteriaid' => $data->criteriaid,
2469                 'timecompleted' => $this->apply_date_offset($data->timecompleted)
2470             );
2471             if (isset($data->gradefinal)) {
2472                 $params['gradefinal'] = $data->gradefinal;
2473             }
2474             if (isset($data->unenroled)) {
2475                 $params['unenroled'] = $data->unenroled;
2476             }
2477             $DB->insert_record('course_completion_crit_compl', $params);
2478         }
2479     }
2481     /**
2482      * Process course completions
2483      *
2484      * @global moodle_database $DB
2485      * @param stdClass $data
2486      */
2487     public function process_course_completions($data) {
2488         global $DB;
2490         $data = (object)$data;
2492         $data->course = $this->get_courseid();
2493         $data->userid = $this->get_mappingid('user', $data->userid);
2495         if (!empty($data->userid)) {
2496             $params = array(
2497                 'userid' => $data->userid,
2498                 'course' => $data->course,
2499                 'timeenrolled' => $this->apply_date_offset($data->timeenrolled),
2500                 'timestarted' => $this->apply_date_offset($data->timestarted),
2501                 'timecompleted' => $this->apply_date_offset($data->timecompleted),
2502                 'reaggregate' => $data->reaggregate
2503             );
2504             $DB->insert_record('course_completions', $params);
2505         }
2506     }
2508     /**
2509      * Process course completion aggregate methods
2510      *
2511      * @global moodle_database $DB
2512      * @param stdClass $data
2513      */
2514     public function process_course_completion_aggr_methd($data) {
2515         global $DB;
2517         $data = (object)$data;
2519         $data->course = $this->get_courseid();
2521         // Only create the course_completion_aggr_methd records if
2522         // the target course has not them defined. MDL-28180
2523         if (!$DB->record_exists('course_completion_aggr_methd', array(
2524                     'course' => $data->course,
2525                     'criteriatype' => $data->criteriatype))) {
2526             $params = array(
2527                 'course' => $data->course,
2528                 'criteriatype' => $data->criteriatype,
2529                 'method' => $data->method,
2530                 'value' => $data->value,
2531             );
2532             $DB->insert_record('course_completion_aggr_methd', $params);
2533         }
2534     }
2538 /**
2539  * This structure step restores course logs (cmid = 0), delegating
2540  * the hard work to the corresponding {@link restore_logs_processor} passing the
2541  * collection of {@link restore_log_rule} rules to be observed as they are defined
2542  * by the task. Note this is only executed based in the 'logs' setting.
2543  *
2544  * NOTE: This is executed by final task, to have all the activities already restored
2545  *
2546  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
2547  * records are. There are others like 'calendar' and 'upload' that will be handled
2548  * later.
2549  *
2550  * NOTE: All the missing actions (not able to be restored) are sent to logs for
2551  * debugging purposes
2552  */
2553 class restore_course_logs_structure_step extends restore_structure_step {
2555     /**
2556      * Conditionally decide if this step should be executed.
2557      *
2558      * This function checks the following parameter:
2559      *
2560      *   1. the course/logs.xml file exists
2561      *
2562      * @return bool true is safe to execute, false otherwise
2563      */
2564     protected function execute_condition() {
2566         // Check it is included in the backup
2567         $fullpath = $this->task->get_taskbasepath();
2568         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2569         if (!file_exists($fullpath)) {
2570             // Not found, can't restore course logs
2571             return false;
2572         }
2574         return true;
2575     }
2577     protected function define_structure() {
2579         $paths = array();
2581         // Simple, one plain level of information contains them
2582         $paths[] = new restore_path_element('log', '/logs/log');
2584         return $paths;
2585     }
2587     protected function process_log($data) {
2588         global $DB;
2590         $data = (object)($data);
2592         $data->time = $this->apply_date_offset($data->time);
2593         $data->userid = $this->get_mappingid('user', $data->userid);
2594         $data->course = $this->get_courseid();
2595         $data->cmid = 0;
2597         // For any reason user wasn't remapped ok, stop processing this
2598         if (empty($data->userid)) {
2599             return;
2600         }
2602         // Everything ready, let's delegate to the restore_logs_processor
2604         // Set some fixed values that will save tons of DB requests
2605         $values = array(
2606             'course' => $this->get_courseid());
2607         // Get instance and process log record
2608         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2610         // If we have data, insert it, else something went wrong in the restore_logs_processor
2611         if ($data) {
2612             $DB->insert_record('log', $data);
2613         }
2614     }
2617 /**
2618  * This structure step restores activity logs, extending {@link restore_course_logs_structure_step}
2619  * sharing its same structure but modifying the way records are handled
2620  */
2621 class restore_activity_logs_structure_step extends restore_course_logs_structure_step {
2623     protected function process_log($data) {
2624         global $DB;
2626         $data = (object)($data);
2628         $data->time = $this->apply_date_offset($data->time);
2629         $data->userid = $this->get_mappingid('user', $data->userid);
2630         $data->course = $this->get_courseid();
2631         $data->cmid = $this->task->get_moduleid();
2633         // For any reason user wasn't remapped ok, stop processing this
2634         if (empty($data->userid)) {
2635             return;
2636         }
2638         // Everything ready, let's delegate to the restore_logs_processor
2640         // Set some fixed values that will save tons of DB requests
2641         $values = array(
2642             'course' => $this->get_courseid(),
2643             'course_module' => $this->task->get_moduleid(),
2644             $this->task->get_modulename() => $this->task->get_activityid());
2645         // Get instance and process log record
2646         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2648         // If we have data, insert it, else something went wrong in the restore_logs_processor
2649         if ($data) {
2650             $DB->insert_record('log', $data);
2651         }
2652     }
2656 /**
2657  * Defines the restore step for advanced grading methods attached to the activity module
2658  */
2659 class restore_activity_grading_structure_step extends restore_structure_step {
2661     /**
2662      * This step is executed only if the grading file is present
2663      */
2664      protected function execute_condition() {
2666         $fullpath = $this->task->get_taskbasepath();
2667         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2668         if (!file_exists($fullpath)) {
2669             return false;
2670         }
2672         return true;
2673     }
2676     /**
2677      * Declares paths in the grading.xml file we are interested in
2678      */
2679     protected function define_structure() {
2681         $paths = array();
2682         $userinfo = $this->get_setting_value('userinfo');
2684         $area = new restore_path_element('grading_area', '/areas/area');
2685         $paths[] = $area;
2686         // attach local plugin stucture to $area element
2687         $this->add_plugin_structure('local', $area);
2689         $definition = new restore_path_element('grading_definition', '/areas/area/definitions/definition');
2690         $paths[] = $definition;
2691         $this->add_plugin_structure('gradingform', $definition);
2692         // attach local plugin stucture to $definition element
2693         $this->add_plugin_structure('local', $definition);
2696         if ($userinfo) {
2697             $instance = new restore_path_element('grading_instance',
2698                 '/areas/area/definitions/definition/instances/instance');
2699             $paths[] = $instance;
2700             $this->add_plugin_structure('gradingform', $instance);
2701             // attach local plugin stucture to $intance element
2702             $this->add_plugin_structure('local', $instance);
2703         }
2705         return $paths;
2706     }
2708     /**
2709      * Processes one grading area element
2710      *
2711      * @param array $data element data
2712      */
2713     protected function process_grading_area($data) {
2714         global $DB;
2716         $task = $this->get_task();
2717         $data = (object)$data;
2718         $oldid = $data->id;
2719         $data->component = 'mod_'.$task->get_modulename();
2720         $data->contextid = $task->get_contextid();
2722         $newid = $DB->insert_record('grading_areas', $data);
2723         $this->set_mapping('grading_area', $oldid, $newid);
2724     }
2726     /**
2727      * Processes one grading definition element
2728      *
2729      * @param array $data element data
2730      */
2731     protected function process_grading_definition($data) {
2732         global $DB;
2734         $task = $this->get_task();
2735         $data = (object)$data;
2736         $oldid = $data->id;
2737         $data->areaid = $this->get_new_parentid('grading_area');
2738         $data->copiedfromid = null;
2739         $data->timecreated = time();
2740         $data->usercreated = $task->get_userid();
2741         $data->timemodified = $data->timecreated;
2742         $data->usermodified = $data->usercreated;
2744         $newid = $DB->insert_record('grading_definitions', $data);
2745         $this->set_mapping('grading_definition', $oldid, $newid, true);
2746     }
2748     /**
2749      * Processes one grading form instance element
2750      *
2751      * @param array $data element data
2752      */
2753     protected function process_grading_instance($data) {
2754         global $DB;
2756         $data = (object)$data;
2758         // new form definition id
2759         $newformid = $this->get_new_parentid('grading_definition');
2761         // get the name of the area we are restoring to
2762         $sql = "SELECT ga.areaname
2763                   FROM {grading_definitions} gd
2764                   JOIN {grading_areas} ga ON gd.areaid = ga.id
2765                  WHERE gd.id = ?";
2766         $areaname = $DB->get_field_sql($sql, array($newformid), MUST_EXIST);
2768         // get the mapped itemid - the activity module is expected to define the mappings
2769         // for each gradable area
2770         $newitemid = $this->get_mappingid(restore_gradingform_plugin::itemid_mapping($areaname), $data->itemid);
2772         $oldid = $data->id;
2773         $data->definitionid = $newformid;
2774         $data->raterid = $this->get_mappingid('user', $data->raterid);
2775         $data->itemid = $newitemid;
2777         $newid = $DB->insert_record('grading_instances', $data);
2778         $this->set_mapping('grading_instance', $oldid, $newid);
2779     }
2781     /**
2782      * Final operations when the database records are inserted
2783      */
2784     protected function after_execute() {
2785         // Add files embedded into the definition description
2786         $this->add_related_files('grading', 'description', 'grading_definition');
2787     }
2791 /**
2792  * This structure step restores the grade items associated with one activity
2793  * All the grade items are made child of the "course" grade item but the original
2794  * categoryid is saved as parentitemid in the backup_ids table, so, when restoring
2795  * the complete gradebook (categories and calculations), that information is
2796  * available there
2797  */
2798 class restore_activity_grades_structure_step extends restore_structure_step {
2800     protected function define_structure() {
2802         $paths = array();
2803         $userinfo = $this->get_setting_value('userinfo');
2805         $paths[] = new restore_path_element('grade_item', '/activity_gradebook/grade_items/grade_item');
2806         $paths[] = new restore_path_element('grade_letter', '/activity_gradebook/grade_letters/grade_letter');
2807         if ($userinfo) {
2808             $paths[] = new restore_path_element('grade_grade',
2809                            '/activity_gradebook/grade_items/grade_item/grade_grades/grade_grade');
2810         }
2811         return $paths;
2812     }
2814     protected function process_grade_item($data) {
2815         global $DB;
2817         $data = (object)($data);
2818         $oldid       = $data->id;        // We'll need these later
2819         $oldparentid = $data->categoryid;
2820         $courseid = $this->get_courseid();
2822         // make sure top course category exists, all grade items will be associated
2823         // to it. Later, if restoring the whole gradebook, categories will be introduced
2824         $coursecat = grade_category::fetch_course_category($courseid);
2825         $coursecatid = $coursecat->id; // Get the categoryid to be used
2827         $idnumber = null;
2828         if (!empty($data->idnumber)) {
2829             // Don't get any idnumber from course module. Keep them as they are in grade_item->idnumber
2830             // Reason: it's not clear what happens with outcomes->idnumber or activities with multiple items (workshop)
2831             // so the best is to keep the ones already in the gradebook
2832             // Potential problem: duplicates if same items are restored more than once. :-(
2833             // This needs to be fixed in some way (outcomes & activities with multiple items)
2834             // $data->idnumber     = get_coursemodule_from_instance($data->itemmodule, $data->iteminstance)->idnumber;
2835             // In any case, verify always for uniqueness
2836             $sql = "SELECT cm.id
2837                       FROM {course_modules} cm
2838                      WHERE cm.course = :courseid AND
2839                            cm.idnumber = :idnumber AND
2840                            cm.id <> :cmid";
2841             $params = array(
2842                 'courseid' => $courseid,
2843                 'idnumber' => $data->idnumber,
2844                 'cmid' => $this->task->get_moduleid()
2845             );
2846             if (!$DB->record_exists_sql($sql, $params) && !$DB->record_exists('grade_items', array('courseid' => $courseid, 'idnumber' => $data->idnumber))) {
2847                 $idnumber = $data->idnumber;
2848             }
2849         }
2851         unset($data->id);
2852         $data->categoryid   = $coursecatid;
2853         $data->courseid     = $this->get_courseid();
2854         $data->iteminstance = $this->task->get_activityid();
2855         $data->idnumber     = $idnumber;
2856         $data->scaleid      = $this->get_mappingid('scale', $data->scaleid);
2857         $data->outcomeid    = $this->get_mappingid('outcome', $data->outcomeid);
2858         $data->timecreated  = $this->apply_date_offset($data->timecreated);
2859         $data->timemodified = $this->apply_date_offset($data->timemodified);
2861         $gradeitem = new grade_item($data, false);
2862         $gradeitem->insert('restore');
2864         //sortorder is automatically assigned when inserting. Re-instate the previous sortorder
2865         $gradeitem->sortorder = $data->sortorder;
2866         $gradeitem->update('restore');
2868         // Set mapping, saving the original category id into parentitemid
2869         // gradebook restore (final task) will need it to reorganise items
2870         $this->set_mapping('grade_item', $oldid, $gradeitem->id, false, null, $oldparentid);
2871     }
2873     protected function process_grade_grade($data) {
2874         $data = (object)($data);
2875         $olduserid = $data->userid;
2876         unset($data->id);
2878         $data->itemid = $this->get_new_parentid('grade_item');
2880         $data->userid = $this->get_mappingid('user', $data->userid, null);
2881         if (!empty($data->userid)) {
2882             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
2883             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
2884             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
2885             $data->overridden = $this->apply_date_offset($data->overridden);
2887             $grade = new grade_grade($data, false);
2888             $grade->insert('restore');
2889             // no need to save any grade_grade mapping
2890         } else {
2891             debugging("Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'");
2892         }
2893     }
2895     /**
2896      * process activity grade_letters. Note that, while these are possible,
2897      * because grade_letters are contextid based, in practice, only course
2898      * context letters can be defined. So we keep here this method knowing
2899      * it won't be executed ever. gradebook restore will restore course letters.
2900      */
2901     protected function process_grade_letter($data) {
2902         global $DB;
2904         $data['contextid'] = $this->task->get_contextid();
2905         $gradeletter = (object)$data;
2907         // Check if it exists before adding it
2908         unset($data['id']);
2909         if (!$DB->record_exists('grade_letters', $data)) {
2910             $newitemid = $DB->insert_record('grade_letters', $gradeletter);
2911         }
2912         // no need to save any grade_letter mapping
2913     }
2915     public function after_restore() {
2916         // Fix grade item's sortorder after restore, as it might have duplicates.
2917         $courseid = $this->get_task()->get_courseid();
2918         grade_item::fix_duplicate_sortorder($courseid);
2919     }
2923 /**
2924  * This structure steps restores one instance + positions of one block
2925  * Note: Positions corresponding to one existing context are restored
2926  * here, but all the ones having unknown contexts are sent to backup_ids
2927  * for a later chance to be restored at the end (final task)
2928  */
2929 class restore_block_instance_structure_step extends restore_structure_step {
2931     protected function define_structure() {
2933         $paths = array();
2935         $paths[] = new restore_path_element('block', '/block', true); // Get the whole XML together
2936         $paths[] = new restore_path_element('block_position', '/block/block_positions/block_position');
2938         return $paths;
2939     }
2941     public function process_block($data) {
2942         global $DB, $CFG;
2944         $data = (object)$data; // Handy
2945         $oldcontextid = $data->contextid;
2946         $oldid        = $data->id;
2947         $positions = isset($data->block_positions['block_position']) ? $data->block_positions['block_position'] : array();
2949         // Look for the parent contextid
2950         if (!$data->parentcontextid = $this->get_mappingid('context', $data->parentcontextid)) {
2951             throw new restore_step_exception('restore_block_missing_parent_ctx', $data->parentcontextid);
2952         }
2954         // TODO: it would be nice to use standard plugin supports instead of this instance_allow_multiple()
2955         // If there is already one block of that type in the parent context
2956         // and the block is not multiple, stop processing
2957         // Use blockslib loader / method executor
2958         if (!$bi = block_instance($data->blockname)) {
2959             return false;
2960         }
2962         if (!$bi->instance_allow_multiple()) {
2963             if ($DB->record_exists_sql("SELECT bi.id
2964                                           FROM {block_instances} bi
2965                                           JOIN {block} b ON b.name = bi.blockname
2966                                          WHERE bi.parentcontextid = ?
2967                                            AND bi.blockname = ?", array($data->parentcontextid, $data->blockname))) {
2968                 return false;
2969             }
2970         }
2972         // If there is already one block of that type in the parent context
2973         // with the same showincontexts, pagetypepattern, subpagepattern, defaultregion and configdata
2974         // stop processing
2975         $params = array(
2976             'blockname' => $data->blockname, 'parentcontextid' => $data->parentcontextid,
2977             'showinsubcontexts' => $data->showinsubcontexts, 'pagetypepattern' => $data->pagetypepattern,
2978             'subpagepattern' => $data->subpagepattern, 'defaultregion' => $data->defaultregion);
2979         if ($birecs = $DB->get_records('block_instances', $params)) {
2980             foreach($birecs as $birec) {
2981                 if ($birec->configdata == $data->configdata) {
2982                     return false;
2983                 }
2984             }
2985         }
2987         // Set task old contextid, blockid and blockname once we know them
2988         $this->task->set_old_contextid($oldcontextid);
2989         $this->task->set_old_blockid($oldid);
2990         $this->task->set_blockname($data->blockname);
2992         // Let's look for anything within configdata neededing processing
2993         // (nulls and uses of legacy file.php)
2994         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
2995             $configdata = (array)unserialize(base64_decode($data->configdata));
2996             foreach ($configdata as $attribute => $value) {
2997                 if (in_array($attribute, $attrstotransform)) {
2998                     $configdata[$attribute] = $this->contentprocessor->process_cdata($value);
2999                 }
3000             }
3001             $data->configdata = base64_encode(serialize((object)$configdata));
3002         }
3004         // Create the block instance
3005         $newitemid = $DB->insert_record('block_instances', $data);
3006         // Save the mapping (with restorefiles support)
3007         $this->set_mapping('block_instance', $oldid, $newitemid, true);
3008         // Create the block context
3009         $newcontextid = context_block::instance($newitemid)->id;
3010         // Save the block contexts mapping and sent it to task
3011         $this->set_mapping('context', $oldcontextid, $newcontextid);
3012         $this->task->set_contextid($newcontextid);
3013         $this->task->set_blockid($newitemid);
3015         // Restore block fileareas if declared
3016         $component = 'block_' . $this->task->get_blockname();
3017         foreach ($this->task->get_fileareas() as $filearea) { // Simple match by contextid. No itemname needed
3018             $this->add_related_files($component, $filearea, null);
3019         }
3021         // Process block positions, creating them or accumulating for final step
3022         foreach($positions as $position) {
3023             $position = (object)$position;
3024             $position->blockinstanceid = $newitemid; // The instance is always the restored one
3025             // If position is for one already mapped (known) contextid
3026             // process it now, creating the position
3027             if ($newpositionctxid = $this->get_mappingid('context', $position->contextid)) {
3028                 $position->contextid = $newpositionctxid;
3029                 // Create the block position
3030                 $DB->insert_record('block_positions', $position);
3032             // The position belongs to an unknown context, send it to backup_ids
3033             // to process them as part of the final steps of restore. We send the
3034             // whole $position object there, hence use the low level method.
3035             } else {
3036                 restore_dbops::set_backup_ids_record($this->get_restoreid(), 'block_position', $position->id, 0, null, $position);
3037             }
3038         }
3039     }
3042 /**
3043  * Structure step to restore common course_module information
3044  *
3045  * This step will process the module.xml file for one activity, in order to restore
3046  * the corresponding information to the course_modules table, skipping various bits
3047  * of information based on CFG settings (groupings, completion...) in order to fullfill
3048  * all the reqs to be able to create the context to be used by all the rest of steps
3049  * in the activity restore task
3050  */
3051 class restore_module_structure_step extends restore_structure_step {
3053     protected function define_structure() {
3054         global $CFG;
3056         $paths = array();
3058         $module = new restore_path_element('module', '/module');
3059         $paths[] = $module;
3060         if ($CFG->enableavailability) {
3061             $paths[] = new restore_path_element('availability', '/module/availability_info/availability');
3062             $paths[] = new restore_path_element('availability_field', '/module/availability_info/availability_field');
3063         }
3065         // Apply for 'format' plugins optional paths at module level
3066         $this->add_plugin_structure('format', $module);
3068         // Apply for 'plagiarism' plugins optional paths at module level
3069         $this->add_plugin_structure('plagiarism', $module);
3071         // Apply for 'local' plugins optional paths at module level
3072         $this->add_plugin_structure('local', $module);
3074         return $paths;
3075     }
3077     protected function process_module($data) {
3078         global $CFG, $DB;
3080         $data = (object)$data;
3081         $oldid = $data->id;
3082         $this->task->set_old_moduleversion($data->version);
3084         $data->course = $this->task->get_courseid();
3085         $data->module = $DB->get_field('modules', 'id', array('name' => $data->modulename));
3086         // Map section (first try by course_section mapping match. Useful in course and section restores)
3087         $data->section = $this->get_mappingid('course_section', $data->sectionid);
3088         if (!$data->section) { // mapping failed, try to get section by sectionnumber matching
3089             $params = array(
3090                 'course' => $this->get_courseid(),
3091                 'section' => $data->sectionnumber);
3092             $data->section = $DB->get_field('course_sections', 'id', $params);
3093         }
3094         if (!$data->section) { // sectionnumber failed, try to get first section in course
3095             $params = array(
3096                 'course' => $this->get_courseid());
3097             $data->section = $DB->get_field('course_sections', 'MIN(id)', $params);
3098         }
3099         if (!$data->section) { // no sections in course, create section 0 and 1 and assign module to 1
3100             $sectionrec = array(
3101                 'course' => $this->get_courseid(),
3102                 'section' => 0);
3103             $DB->insert_record('course_sections', $sectionrec); // section 0
3104             $sectionrec = array(
3105                 'course' => $this->get_courseid(),
3106                 'section' => 1);
3107             $data->section = $DB->insert_record('course_sections', $sectionrec); // section 1
3108         }
3109         $data->groupingid= $this->get_mappingid('grouping', $data->groupingid);      // grouping
3110         if (!grade_verify_idnumber($data->idnumber, $this->get_courseid())) {        // idnumber uniqueness
3111             $data->idnumber = '';
3112         }
3113         if (empty($CFG->enablecompletion)) { // completion
3114             $data->completion = 0;
3115             $data->completiongradeitemnumber = null;
3116             $data->completionview = 0;
3117             $data->completionexpected = 0;
3118         } else {
3119             $data->completionexpected = $this->apply_date_offset($data->completionexpected);
3120         }
3121         if (empty($CFG->enableavailability)) {
3122             $data->availability = null;
3123         }
3124         // Backups that did not include showdescription, set it to default 0
3125         // (this is not totally necessary as it has a db default, but just to
3126         // be explicit).
3127         if (!isset($data->showdescription)) {
3128             $data->showdescription = 0;
3129         }
3130         $data->instance = 0; // Set to 0 for now, going to create it soon (next step)
3132         // If there are legacy availablility data fields (and no new format data),
3133         // convert the old fields.
3134         if (empty($data->availability)) {
3135             // If groupmembersonly is disabled on this system, convert the
3136             // groupmembersonly option into the new API. Otherwise don't.
3137             $data->availability = \core_availability\info::convert_legacy_fields(
3138                     $data, false, !$CFG->enablegroupmembersonly);
3139         }
3141         // course_module record ready, insert it
3142         $newitemid = $DB->insert_record('course_modules', $data);
3143         // save mapping
3144         $this->set_mapping('course_module', $oldid, $newitemid);
3145         // set the new course_module id in the task
3146         $this->task->set_moduleid($newitemid);
3147         // we can now create the context safely
3148         $ctxid = context_module::instance($newitemid)->id;
3149         // set the new context id in the task
3150         $this->task->set_contextid($ctxid);
3151         // update sequence field in course_section
3152         if ($sequence = $DB->get_field('course_sections', 'sequence', array('id' => $data->section))) {
3153             $sequence .= ',' . $newitemid;
3154         } else {
3155             $sequence = $newitemid;
3156         }
3157         $DB->set_field('course_sections', 'sequence', $sequence, array('id' => $data->section));
3159         // If there is the legacy showavailability data, store this for later use.
3160         // (This data is not present when restoring 'new' backups.)
3161         if (isset($data->showavailability)) {
3162             // Cache the showavailability flag using the backup_ids data field.
3163             restore_dbops::set_backup_ids_record($this->get_restoreid(),
3164                     'module_showavailability', $newitemid, 0, null,
3165                     (object)array('showavailability' => $data->showavailability));
3166         }
3167     }
3169     /**
3170      * Process the legacy availability table record. This table does not exist
3171      * in Moodle 2.7+ but we still support restore.
3172      *
3173      * @param stdClass $data Record data
3174      */
3175     protected function process_availability($data) {
3176         $data = (object)$data;
3177         // Simply going to store the whole availability record now, we'll process
3178         // all them later in the final task (once all activities have been restored)
3179         // Let's call the low level one to be able to store the whole object
3180         $data->coursemoduleid = $this->task->get_moduleid(); // Let add the availability cmid
3181         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'module_availability', $data->id, 0, null, $data);
3182     }
3184     /**
3185      * Process the legacy availability fields table record. This table does not
3186      * exist in Moodle 2.7+ but we still support restore.
3187      *
3188      * @param stdClass $data Record data
3189      */
3190     protected function process_availability_field($data) {
3191         global $DB;
3192         $data = (object)$data;
3193         // Mark it is as passed by default
3194         $passed = true;
3195         $customfieldid = null;
3197         // If a customfield has been used in order to pass we must be able to match an existing
3198         // customfield by name (data->customfield) and type (data->customfieldtype)
3199         if (!empty($data->customfield) xor !empty($data->customfieldtype)) {
3200             // xor is sort of uncommon. If either customfield is null or customfieldtype is null BUT not both.
3201             // If one is null but the other isn't something clearly went wrong and we'll skip this condition.
3202             $passed = false;
3203         } else if (!empty($data->customfield)) {
3204             $params = array('shortname' => $data->customfield, 'datatype' => $data->customfieldtype);
3205             $customfieldid = $DB->get_field('user_info_field', 'id', $params);
3206             $passed = ($customfieldid !== false);
3207         }
3209         if ($passed) {
3210             // Create the object to insert into the database
3211             $availfield = new stdClass();
3212             $availfield->coursemoduleid = $this->task->get_moduleid(); // Lets add the availability cmid
3213             $availfield->userfield = $data->userfield;
3214             $availfield->customfieldid = $customfieldid;
3215             $availfield->operator = $data->operator;
3216             $availfield->value = $data->value;
3218             // Get showavailability option.
3219             $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
3220                     'module_showavailability', $availfield->coursemoduleid);
3221             if (!$showrec) {
3222                 // Should not happen.
3223                 throw new coding_exception('No matching showavailability record');
3224             }
3225             $show = $showrec->info->showavailability;
3227             // The $availfieldobject is now in the format used in the old
3228             // system. Interpret this and convert to new system.
3229             $currentvalue = $DB->get_field('course_modules', 'availability',
3230                     array('id' => $availfield->coursemoduleid), MUST_EXIST);
3231             $newvalue = \core_availability\info::add_legacy_availability_field_condition(
3232                     $currentvalue, $availfield, $show);
3233             $DB->set_field('course_modules', 'availability', $newvalue,
3234                     array('id' => $availfield->coursemoduleid));
3235         }
3236     }
3239 /**
3240  * Structure step that will process the user activity completion
3241  * information if all these conditions are met:
3242  *  - Target site has completion enabled ($CFG->enablecompletion)
3243  *  - Activity includes completion info (file_exists)
3244  */
3245 class restore_userscompletion_structure_step extends restore_structure_step {