ca6610287bc4391dd150a6dd8e818ab14c6ed1fc
[moodle.git] / backup / moodle2 / restore_stepslib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Defines various restore steps that will be used by common tasks in restore
20  *
21  * @package     core_backup
22  * @subpackage  moodle2
23  * @category    backup
24  * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
25  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 defined('MOODLE_INTERNAL') || die();
30 /**
31  * delete old directories and conditionally create backup_temp_ids table
32  */
33 class restore_create_and_clean_temp_stuff extends restore_execution_step {
35     protected function define_execution() {
36         $exists = restore_controller_dbops::create_restore_temp_tables($this->get_restoreid()); // temp tables conditionally
37         // If the table already exists, it's because restore_prechecks have been executed in the same
38         // request (without problems) and it already contains a bunch of preloaded information (users...)
39         // that we aren't going to execute again
40         if ($exists) { // Inform plan about preloaded information
41             $this->task->set_preloaded_information();
42         }
43         // Create the old-course-ctxid to new-course-ctxid mapping, we need that available since the beginning
44         $itemid = $this->task->get_old_contextid();
45         $newitemid = context_course::instance($this->get_courseid())->id;
46         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'context', $itemid, $newitemid);
47         // Create the old-system-ctxid to new-system-ctxid mapping, we need that available since the beginning
48         $itemid = $this->task->get_old_system_contextid();
49         $newitemid = context_system::instance()->id;
50         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'context', $itemid, $newitemid);
51         // Create the old-course-id to new-course-id mapping, we need that available since the beginning
52         $itemid = $this->task->get_old_courseid();
53         $newitemid = $this->get_courseid();
54         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'course', $itemid, $newitemid);
56     }
57 }
59 /**
60  * delete the temp dir used by backup/restore (conditionally),
61  * delete old directories and drop temp ids table
62  */
63 class restore_drop_and_clean_temp_stuff extends restore_execution_step {
65     protected function define_execution() {
66         global $CFG;
67         restore_controller_dbops::drop_restore_temp_tables($this->get_restoreid()); // Drop ids temp table
68         $progress = $this->task->get_progress();
69         $progress->start_progress('Deleting backup dir');
70         backup_helper::delete_old_backup_dirs(strtotime('-1 week'), $progress);      // Delete > 1 week old temp dirs.
71         if (empty($CFG->keeptempdirectoriesonbackup)) { // Conditionally
72             backup_helper::delete_backup_dir($this->task->get_tempdir(), $progress); // Empty restore dir
73         }
74         $progress->end_progress();
75     }
76 }
78 /**
79  * Restore calculated grade items, grade categories etc
80  */
81 class restore_gradebook_structure_step extends restore_structure_step {
83     /**
84      * To conditionally decide if this step must be executed
85      * Note the "settings" conditions are evaluated in the
86      * corresponding task. Here we check for other conditions
87      * not being restore settings (files, site settings...)
88      */
89      protected function execute_condition() {
90         global $CFG, $DB;
92         if ($this->get_courseid() == SITEID) {
93             return false;
94         }
96         // No gradebook info found, don't execute
97         $fullpath = $this->task->get_taskbasepath();
98         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
99         if (!file_exists($fullpath)) {
100             return false;
101         }
103         // Some module present in backup file isn't available to restore
104         // in this site, don't execute
105         if ($this->task->is_missing_modules()) {
106             return false;
107         }
109         // Some activity has been excluded to be restored, don't execute
110         if ($this->task->is_excluding_activities()) {
111             return false;
112         }
114         // There should only be one grade category (the 1 associated with the course itself)
115         // If other categories already exist we're restoring into an existing course.
116         // Restoring categories into a course with an existing category structure is unlikely to go well
117         $category = new stdclass();
118         $category->courseid  = $this->get_courseid();
119         $catcount = $DB->count_records('grade_categories', (array)$category);
120         if ($catcount>1) {
121             return false;
122         }
124         // Arrived here, execute the step
125         return true;
126      }
128     protected function define_structure() {
129         $paths = array();
130         $userinfo = $this->task->get_setting_value('users');
132         $paths[] = new restore_path_element('gradebook', '/gradebook');
133         $paths[] = new restore_path_element('grade_category', '/gradebook/grade_categories/grade_category');
134         $paths[] = new restore_path_element('grade_item', '/gradebook/grade_items/grade_item');
135         if ($userinfo) {
136             $paths[] = new restore_path_element('grade_grade', '/gradebook/grade_items/grade_item/grade_grades/grade_grade');
137         }
138         $paths[] = new restore_path_element('grade_letter', '/gradebook/grade_letters/grade_letter');
139         $paths[] = new restore_path_element('grade_setting', '/gradebook/grade_settings/grade_setting');
141         return $paths;
142     }
144     protected function process_gradebook($data) {
145     }
147     protected function process_grade_item($data) {
148         global $DB;
150         $data = (object)$data;
152         $oldid = $data->id;
153         $data->course = $this->get_courseid();
155         $data->courseid = $this->get_courseid();
157         if ($data->itemtype=='manual') {
158             // manual grade items store category id in categoryid
159             $data->categoryid = $this->get_mappingid('grade_category', $data->categoryid, NULL);
160             // if mapping failed put in course's grade category
161             if (NULL == $data->categoryid) {
162                 $coursecat = grade_category::fetch_course_category($this->get_courseid());
163                 $data->categoryid = $coursecat->id;
164             }
165         } else if ($data->itemtype=='course') {
166             // course grade item stores their category id in iteminstance
167             $coursecat = grade_category::fetch_course_category($this->get_courseid());
168             $data->iteminstance = $coursecat->id;
169         } else if ($data->itemtype=='category') {
170             // category grade items store their category id in iteminstance
171             $data->iteminstance = $this->get_mappingid('grade_category', $data->iteminstance, NULL);
172         } else {
173             throw new restore_step_exception('unexpected_grade_item_type', $data->itemtype);
174         }
176         $data->scaleid   = $this->get_mappingid('scale', $data->scaleid, NULL);
177         $data->outcomeid = $this->get_mappingid('outcome', $data->outcomeid, NULL);
179         $data->locktime     = $this->apply_date_offset($data->locktime);
180         $data->timecreated  = $this->apply_date_offset($data->timecreated);
181         $data->timemodified = $this->apply_date_offset($data->timemodified);
183         $coursecategory = $newitemid = null;
184         //course grade item should already exist so updating instead of inserting
185         if($data->itemtype=='course') {
186             //get the ID of the already created grade item
187             $gi = new stdclass();
188             $gi->courseid  = $this->get_courseid();
189             $gi->itemtype  = $data->itemtype;
191             //need to get the id of the grade_category that was automatically created for the course
192             $category = new stdclass();
193             $category->courseid  = $this->get_courseid();
194             $category->parent  = null;
195             //course category fullname starts out as ? but may be edited
196             //$category->fullname  = '?';
197             $coursecategory = $DB->get_record('grade_categories', (array)$category);
198             $gi->iteminstance = $coursecategory->id;
200             $existinggradeitem = $DB->get_record('grade_items', (array)$gi);
201             if (!empty($existinggradeitem)) {
202                 $data->id = $newitemid = $existinggradeitem->id;
203                 $DB->update_record('grade_items', $data);
204             }
205         } else if ($data->itemtype == 'manual') {
206             // Manual items aren't assigned to a cm, so don't go duplicating them in the target if one exists.
207             $gi = array(
208                 'itemtype' => $data->itemtype,
209                 'courseid' => $data->courseid,
210                 'itemname' => $data->itemname,
211                 'categoryid' => $data->categoryid,
212             );
213             $newitemid = $DB->get_field('grade_items', 'id', $gi);
214         }
216         if (empty($newitemid)) {
217             //in case we found the course category but still need to insert the course grade item
218             if ($data->itemtype=='course' && !empty($coursecategory)) {
219                 $data->iteminstance = $coursecategory->id;
220             }
222             $newitemid = $DB->insert_record('grade_items', $data);
223         }
224         $this->set_mapping('grade_item', $oldid, $newitemid);
225     }
227     protected function process_grade_grade($data) {
228         global $DB;
230         $data = (object)$data;
231         $oldid = $data->id;
232         $olduserid = $data->userid;
234         $data->itemid = $this->get_new_parentid('grade_item');
236         $data->userid = $this->get_mappingid('user', $data->userid, null);
237         if (!empty($data->userid)) {
238             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
239             $data->locktime     = $this->apply_date_offset($data->locktime);
240             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
241             $data->overridden = $this->apply_date_offset($data->overridden);
242             $data->timecreated  = $this->apply_date_offset($data->timecreated);
243             $data->timemodified = $this->apply_date_offset($data->timemodified);
245             $gradeexists = $DB->record_exists('grade_grades', array('userid' => $data->userid, 'itemid' => $data->itemid));
246             if ($gradeexists) {
247                 $message = "User id '{$data->userid}' already has a grade entry for grade item id '{$data->itemid}'";
248                 $this->log($message, backup::LOG_DEBUG);
249             } else {
250                 $newitemid = $DB->insert_record('grade_grades', $data);
251                 $this->set_mapping('grade_grades', $oldid, $newitemid);
252             }
253         } else {
254             $message = "Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'";
255             $this->log($message, backup::LOG_DEBUG);
256         }
257     }
259     protected function process_grade_category($data) {
260         global $DB;
262         $data = (object)$data;
263         $oldid = $data->id;
265         $data->course = $this->get_courseid();
266         $data->courseid = $data->course;
268         $data->timecreated  = $this->apply_date_offset($data->timecreated);
269         $data->timemodified = $this->apply_date_offset($data->timemodified);
271         $newitemid = null;
272         //no parent means a course level grade category. That may have been created when the course was created
273         if(empty($data->parent)) {
274             //parent was being saved as 0 when it should be null
275             $data->parent = null;
277             //get the already created course level grade category
278             $category = new stdclass();
279             $category->courseid = $this->get_courseid();
280             $category->parent = null;
282             $coursecategory = $DB->get_record('grade_categories', (array)$category);
283             if (!empty($coursecategory)) {
284                 $data->id = $newitemid = $coursecategory->id;
285                 $DB->update_record('grade_categories', $data);
286             }
287         }
289         // Add a warning about a removed setting.
290         if (!empty($data->aggregatesubcats)) {
291             set_config('show_aggregatesubcats_upgrade_' . $data->courseid, 1);
292         }
294         //need to insert a course category
295         if (empty($newitemid)) {
296             $newitemid = $DB->insert_record('grade_categories', $data);
297         }
298         $this->set_mapping('grade_category', $oldid, $newitemid);
299     }
300     protected function process_grade_letter($data) {
301         global $DB;
303         $data = (object)$data;
304         $oldid = $data->id;
306         $data->contextid = context_course::instance($this->get_courseid())->id;
308         $gradeletter = (array)$data;
309         unset($gradeletter['id']);
310         if (!$DB->record_exists('grade_letters', $gradeletter)) {
311             $newitemid = $DB->insert_record('grade_letters', $data);
312         } else {
313             $newitemid = $data->id;
314         }
316         $this->set_mapping('grade_letter', $oldid, $newitemid);
317     }
318     protected function process_grade_setting($data) {
319         global $DB;
321         $data = (object)$data;
322         $oldid = $data->id;
324         $data->courseid = $this->get_courseid();
326         if (!$DB->record_exists('grade_settings', array('courseid' => $data->courseid, 'name' => $data->name))) {
327             $newitemid = $DB->insert_record('grade_settings', $data);
328         } else {
329             $newitemid = $data->id;
330         }
332         $this->set_mapping('grade_setting', $oldid, $newitemid);
333     }
335     /**
336      * put all activity grade items in the correct grade category and mark all for recalculation
337      */
338     protected function after_execute() {
339         global $DB;
341         $conditions = array(
342             'backupid' => $this->get_restoreid(),
343             'itemname' => 'grade_item'//,
344             //'itemid'   => $itemid
345         );
346         $rs = $DB->get_recordset('backup_ids_temp', $conditions);
348         // We need this for calculation magic later on.
349         $mappings = array();
351         if (!empty($rs)) {
352             foreach($rs as $grade_item_backup) {
354                 // Store the oldid with the new id.
355                 $mappings[$grade_item_backup->itemid] = $grade_item_backup->newitemid;
357                 $updateobj = new stdclass();
358                 $updateobj->id = $grade_item_backup->newitemid;
360                 //if this is an activity grade item that needs to be put back in its correct category
361                 if (!empty($grade_item_backup->parentitemid)) {
362                     $oldcategoryid = $this->get_mappingid('grade_category', $grade_item_backup->parentitemid, null);
363                     if (!is_null($oldcategoryid)) {
364                         $updateobj->categoryid = $oldcategoryid;
365                         $DB->update_record('grade_items', $updateobj);
366                     }
367                 } else {
368                     //mark course and category items as needing to be recalculated
369                     $updateobj->needsupdate=1;
370                     $DB->update_record('grade_items', $updateobj);
371                 }
372             }
373         }
374         $rs->close();
376         // We need to update the calculations for calculated grade items that may reference old
377         // grade item ids using ##gi\d+##.
378         // $mappings can be empty, use 0 if so (won't match ever)
379         list($sql, $params) = $DB->get_in_or_equal(array_values($mappings), SQL_PARAMS_NAMED, 'param', true, 0);
380         $sql = "SELECT gi.id, gi.calculation
381                   FROM {grade_items} gi
382                  WHERE gi.id {$sql} AND
383                        calculation IS NOT NULL";
384         $rs = $DB->get_recordset_sql($sql, $params);
385         foreach ($rs as $gradeitem) {
386             // Collect all of the used grade item id references
387             if (preg_match_all('/##gi(\d+)##/', $gradeitem->calculation, $matches) < 1) {
388                 // This calculation doesn't reference any other grade items... EASY!
389                 continue;
390             }
391             // For this next bit we are going to do the replacement of id's in two steps:
392             // 1. We will replace all old id references with a special mapping reference.
393             // 2. We will replace all mapping references with id's
394             // Why do we do this?
395             // Because there potentially there will be an overlap of ids within the query and we
396             // we substitute the wrong id.. safest way around this is the two step system
397             $calculationmap = array();
398             $mapcount = 0;
399             foreach ($matches[1] as $match) {
400                 // Check that the old id is known to us, if not it was broken to begin with and will
401                 // continue to be broken.
402                 if (!array_key_exists($match, $mappings)) {
403                     continue;
404                 }
405                 // Our special mapping key
406                 $mapping = '##MAPPING'.$mapcount.'##';
407                 // The old id that exists within the calculation now
408                 $oldid = '##gi'.$match.'##';
409                 // The new id that we want to replace the old one with.
410                 $newid = '##gi'.$mappings[$match].'##';
411                 // Replace in the special mapping key
412                 $gradeitem->calculation = str_replace($oldid, $mapping, $gradeitem->calculation);
413                 // And record the mapping
414                 $calculationmap[$mapping] = $newid;
415                 $mapcount++;
416             }
417             // Iterate all special mappings for this calculation and replace in the new id's
418             foreach ($calculationmap as $mapping => $newid) {
419                 $gradeitem->calculation = str_replace($mapping, $newid, $gradeitem->calculation);
420             }
421             // Update the calculation now that its being remapped
422             $DB->update_record('grade_items', $gradeitem);
423         }
424         $rs->close();
426         // Need to correct the grade category path and parent
427         $conditions = array(
428             'courseid' => $this->get_courseid()
429         );
431         $rs = $DB->get_recordset('grade_categories', $conditions);
432         // Get all the parents correct first as grade_category::build_path() loads category parents from the DB
433         foreach ($rs as $gc) {
434             if (!empty($gc->parent)) {
435                 $grade_category = new stdClass();
436                 $grade_category->id = $gc->id;
437                 $grade_category->parent = $this->get_mappingid('grade_category', $gc->parent);
438                 $DB->update_record('grade_categories', $grade_category);
439             }
440         }
441         $rs->close();
443         // Now we can rebuild all the paths
444         $rs = $DB->get_recordset('grade_categories', $conditions);
445         foreach ($rs as $gc) {
446             $grade_category = new stdClass();
447             $grade_category->id = $gc->id;
448             $grade_category->path = grade_category::build_path($gc);
449             $grade_category->depth = substr_count($grade_category->path, '/') - 1;
450             $DB->update_record('grade_categories', $grade_category);
451         }
452         $rs->close();
454         // Restore marks items as needing update. Update everything now.
455         grade_regrade_final_grades($this->get_courseid());
456     }
459 /**
460  * Step in charge of restoring the grade history of a course.
461  *
462  * The execution conditions are itendical to {@link restore_gradebook_structure_step} because
463  * we do not want to restore the history if the gradebook and its content has not been
464  * restored. At least for now.
465  */
466 class restore_grade_history_structure_step extends restore_structure_step {
468      protected function execute_condition() {
469         global $CFG, $DB;
471         if ($this->get_courseid() == SITEID) {
472             return false;
473         }
475         // No gradebook info found, don't execute.
476         $fullpath = $this->task->get_taskbasepath();
477         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
478         if (!file_exists($fullpath)) {
479             return false;
480         }
482         // Some module present in backup file isn't available to restore in this site, don't execute.
483         if ($this->task->is_missing_modules()) {
484             return false;
485         }
487         // Some activity has been excluded to be restored, don't execute.
488         if ($this->task->is_excluding_activities()) {
489             return false;
490         }
492         // There should only be one grade category (the 1 associated with the course itself).
493         $category = new stdclass();
494         $category->courseid  = $this->get_courseid();
495         $catcount = $DB->count_records('grade_categories', (array)$category);
496         if ($catcount > 1) {
497             return false;
498         }
500         // Arrived here, execute the step.
501         return true;
502      }
504     protected function define_structure() {
505         $paths = array();
507         // Settings to use.
508         $userinfo = $this->get_setting_value('users');
509         $history = $this->get_setting_value('grade_histories');
511         if ($userinfo && $history) {
512             $paths[] = new restore_path_element('grade_grade',
513                '/grade_history/grade_grades/grade_grade');
514         }
516         return $paths;
517     }
519     protected function process_grade_grade($data) {
520         global $DB;
522         $data = (object)($data);
523         $olduserid = $data->userid;
524         unset($data->id);
526         $data->userid = $this->get_mappingid('user', $data->userid, null);
527         if (!empty($data->userid)) {
528             // Do not apply the date offsets as this is history.
529             $data->itemid = $this->get_mappingid('grade_item', $data->itemid);
530             $data->oldid = $this->get_mappingid('grade_grades', $data->oldid);
531             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
532             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
533             $DB->insert_record('grade_grades_history', $data);
534         } else {
535             $message = "Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'";
536             $this->log($message, backup::LOG_DEBUG);
537         }
538     }
542 /**
543  * decode all the interlinks present in restored content
544  * relying 100% in the restore_decode_processor that handles
545  * both the contents to modify and the rules to be applied
546  */
547 class restore_decode_interlinks extends restore_execution_step {
549     protected function define_execution() {
550         // Get the decoder (from the plan)
551         $decoder = $this->task->get_decoder();
552         restore_decode_processor::register_link_decoders($decoder); // Add decoder contents and rules
553         // And launch it, everything will be processed
554         $decoder->execute();
555     }
558 /**
559  * first, ensure that we have no gaps in section numbers
560  * and then, rebuid the course cache
561  */
562 class restore_rebuild_course_cache extends restore_execution_step {
564     protected function define_execution() {
565         global $DB;
567         // Although there is some sort of auto-recovery of missing sections
568         // present in course/formats... here we check that all the sections
569         // from 0 to MAX(section->section) exist, creating them if necessary
570         $maxsection = $DB->get_field('course_sections', 'MAX(section)', array('course' => $this->get_courseid()));
571         // Iterate over all sections
572         for ($i = 0; $i <= $maxsection; $i++) {
573             // If the section $i doesn't exist, create it
574             if (!$DB->record_exists('course_sections', array('course' => $this->get_courseid(), 'section' => $i))) {
575                 $sectionrec = array(
576                     'course' => $this->get_courseid(),
577                     'section' => $i);
578                 $DB->insert_record('course_sections', $sectionrec); // missing section created
579             }
580         }
582         // Rebuild cache now that all sections are in place
583         rebuild_course_cache($this->get_courseid());
584         cache_helper::purge_by_event('changesincourse');
585         cache_helper::purge_by_event('changesincoursecat');
586     }
589 /**
590  * Review all the tasks having one after_restore method
591  * executing it to perform some final adjustments of information
592  * not available when the task was executed.
593  */
594 class restore_execute_after_restore extends restore_execution_step {
596     protected function define_execution() {
598         // Simply call to the execute_after_restore() method of the task
599         // that always is the restore_final_task
600         $this->task->launch_execute_after_restore();
601     }
605 /**
606  * Review all the (pending) block positions in backup_ids, matching by
607  * contextid, creating positions as needed. This is executed by the
608  * final task, once all the contexts have been created
609  */
610 class restore_review_pending_block_positions extends restore_execution_step {
612     protected function define_execution() {
613         global $DB;
615         // Get all the block_position objects pending to match
616         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
617         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
618         // Process block positions, creating them or accumulating for final step
619         foreach($rs as $posrec) {
620             // Get the complete position object out of the info field.
621             $position = backup_controller_dbops::decode_backup_temp_info($posrec->info);
622             // If position is for one already mapped (known) contextid
623             // process it now, creating the position, else nothing to
624             // do, position finally discarded
625             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
626                 $position->contextid = $newctx->newitemid;
627                 // Create the block position
628                 $DB->insert_record('block_positions', $position);
629             }
630         }
631         $rs->close();
632     }
636 /**
637  * Updates the availability data for course modules and sections.
638  *
639  * Runs after the restore of all course modules, sections, and grade items has
640  * completed. This is necessary in order to update IDs that have changed during
641  * restore.
642  *
643  * @package core_backup
644  * @copyright 2014 The Open University
645  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
646  */
647 class restore_update_availability extends restore_execution_step {
649     protected function define_execution() {
650         global $CFG, $DB;
652         // Note: This code runs even if availability is disabled when restoring.
653         // That will ensure that if you later turn availability on for the site,
654         // there will be no incorrect IDs. (It doesn't take long if the restored
655         // data does not contain any availability information.)
657         // Get modinfo with all data after resetting cache.
658         rebuild_course_cache($this->get_courseid(), true);
659         $modinfo = get_fast_modinfo($this->get_courseid());
661         // Get the date offset for this restore.
662         $dateoffset = $this->apply_date_offset(1) - 1;
664         // Update all sections that were restored.
665         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'course_section');
666         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'newitemid');
667         $sectionsbyid = null;
668         foreach ($rs as $rec) {
669             if (is_null($sectionsbyid)) {
670                 $sectionsbyid = array();
671                 foreach ($modinfo->get_section_info_all() as $section) {
672                     $sectionsbyid[$section->id] = $section;
673                 }
674             }
675             if (!array_key_exists($rec->newitemid, $sectionsbyid)) {
676                 // If the section was not fully restored for some reason
677                 // (e.g. due to an earlier error), skip it.
678                 $this->get_logger()->process('Section not fully restored: id ' .
679                         $rec->newitemid, backup::LOG_WARNING);
680                 continue;
681             }
682             $section = $sectionsbyid[$rec->newitemid];
683             if (!is_null($section->availability)) {
684                 $info = new \core_availability\info_section($section);
685                 $info->update_after_restore($this->get_restoreid(),
686                         $this->get_courseid(), $this->get_logger(), $dateoffset, $this->task);
687             }
688         }
689         $rs->close();
691         // Update all modules that were restored.
692         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'course_module');
693         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'newitemid');
694         foreach ($rs as $rec) {
695             if (!array_key_exists($rec->newitemid, $modinfo->cms)) {
696                 // If the module was not fully restored for some reason
697                 // (e.g. due to an earlier error), skip it.
698                 $this->get_logger()->process('Module not fully restored: id ' .
699                         $rec->newitemid, backup::LOG_WARNING);
700                 continue;
701             }
702             $cm = $modinfo->get_cm($rec->newitemid);
703             if (!is_null($cm->availability)) {
704                 $info = new \core_availability\info_module($cm);
705                 $info->update_after_restore($this->get_restoreid(),
706                         $this->get_courseid(), $this->get_logger(), $dateoffset, $this->task);
707             }
708         }
709         $rs->close();
710     }
714 /**
715  * Process legacy module availability records in backup_ids.
716  *
717  * Matches course modules and grade item id once all them have been already restored.
718  * Only if all matchings are satisfied the availability condition will be created.
719  * At the same time, it is required for the site to have that functionality enabled.
720  *
721  * This step is included only to handle legacy backups (2.6 and before). It does not
722  * do anything for newer backups.
723  *
724  * @copyright 2014 The Open University
725  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
726  */
727 class restore_process_course_modules_availability extends restore_execution_step {
729     protected function define_execution() {
730         global $CFG, $DB;
732         // Site hasn't availability enabled
733         if (empty($CFG->enableavailability)) {
734             return;
735         }
737         // Do both modules and sections.
738         foreach (array('module', 'section') as $table) {
739             // Get all the availability objects to process.
740             $params = array('backupid' => $this->get_restoreid(), 'itemname' => $table . '_availability');
741             $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
742             // Process availabilities, creating them if everything matches ok.
743             foreach ($rs as $availrec) {
744                 $allmatchesok = true;
745                 // Get the complete legacy availability object.
746                 $availability = backup_controller_dbops::decode_backup_temp_info($availrec->info);
748                 // Note: This code used to update IDs, but that is now handled by the
749                 // current code (after restore) instead of this legacy code.
751                 // Get showavailability option.
752                 $thingid = ($table === 'module') ? $availability->coursemoduleid :
753                         $availability->coursesectionid;
754                 $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
755                         $table . '_showavailability', $thingid);
756                 if (!$showrec) {
757                     // Should not happen.
758                     throw new coding_exception('No matching showavailability record');
759                 }
760                 $show = $showrec->info->showavailability;
762                 // The $availability object is now in the format used in the old
763                 // system. Interpret this and convert to new system.
764                 $currentvalue = $DB->get_field('course_' . $table . 's', 'availability',
765                         array('id' => $thingid), MUST_EXIST);
766                 $newvalue = \core_availability\info::add_legacy_availability_condition(
767                         $currentvalue, $availability, $show);
768                 $DB->set_field('course_' . $table . 's', 'availability', $newvalue,
769                         array('id' => $thingid));
770             }
771         }
772         $rs->close();
773     }
777 /*
778  * Execution step that, *conditionally* (if there isn't preloaded information)
779  * will load the inforef files for all the included course/section/activity tasks
780  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
781  */
782 class restore_load_included_inforef_records extends restore_execution_step {
784     protected function define_execution() {
786         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
787             return;
788         }
790         // Get all the included tasks
791         $tasks = restore_dbops::get_included_tasks($this->get_restoreid());
792         $progress = $this->task->get_progress();
793         $progress->start_progress($this->get_name(), count($tasks));
794         foreach ($tasks as $task) {
795             // Load the inforef.xml file if exists
796             $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
797             if (file_exists($inforefpath)) {
798                 // Load each inforef file to temp_ids.
799                 restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $inforefpath, $progress);
800             }
801         }
802         $progress->end_progress();
803     }
806 /*
807  * Execution step that will load all the needed files into backup_files_temp
808  *   - info: contains the whole original object (times, names...)
809  * (all them being original ids as loaded from xml)
810  */
811 class restore_load_included_files extends restore_structure_step {
813     protected function define_structure() {
815         $file = new restore_path_element('file', '/files/file');
817         return array($file);
818     }
820     /**
821      * Process one <file> element from files.xml
822      *
823      * @param array $data the element data
824      */
825     public function process_file($data) {
827         $data = (object)$data; // handy
829         // load it if needed:
830         //   - it it is one of the annotated inforef files (course/section/activity/block)
831         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
832         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
833         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
834         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
835         $iscomponent = ($data->component == 'user' || $data->component == 'group' || $data->component == 'badges' ||
836                         $data->component == 'grouping' || $data->component == 'grade' ||
837                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
838         if ($isfileref || $iscomponent) {
839             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
840         }
841     }
844 /**
845  * Execution step that, *conditionally* (if there isn't preloaded information),
846  * will load all the needed roles to backup_temp_ids. They will be stored with
847  * "role" itemname. Also it will perform one automatic mapping to roles existing
848  * in the target site, based in permissions of the user performing the restore,
849  * archetypes and other bits. At the end, each original role will have its associated
850  * target role or 0 if it's going to be skipped. Note we wrap everything over one
851  * restore_dbops method, as far as the same stuff is going to be also executed
852  * by restore prechecks
853  */
854 class restore_load_and_map_roles extends restore_execution_step {
856     protected function define_execution() {
857         if ($this->task->get_preloaded_information()) { // if info is already preloaded
858             return;
859         }
861         $file = $this->get_basepath() . '/roles.xml';
862         // Load needed toles to temp_ids
863         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
865         // Process roles, mapping/skipping. Any error throws exception
866         // Note we pass controller's info because it can contain role mapping information
867         // about manual mappings performed by UI
868         restore_dbops::process_included_roles($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite(), $this->task->get_info()->role_mappings);
869     }
872 /**
873  * Execution step that, *conditionally* (if there isn't preloaded information
874  * and users have been selected in settings, will load all the needed users
875  * to backup_temp_ids. They will be stored with "user" itemname and with
876  * their original contextid as paremitemid
877  */
878 class restore_load_included_users extends restore_execution_step {
880     protected function define_execution() {
882         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
883             return;
884         }
885         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
886             return;
887         }
888         $file = $this->get_basepath() . '/users.xml';
889         // Load needed users to temp_ids.
890         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file, $this->task->get_progress());
891     }
894 /**
895  * Execution step that, *conditionally* (if there isn't preloaded information
896  * and users have been selected in settings, will process all the needed users
897  * in order to decide and perform any action with them (create / map / error)
898  * Note: Any error will cause exception, as far as this is the same processing
899  * than the one into restore prechecks (that should have stopped process earlier)
900  */
901 class restore_process_included_users extends restore_execution_step {
903     protected function define_execution() {
905         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
906             return;
907         }
908         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
909             return;
910         }
911         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(),
912                 $this->task->get_userid(), $this->task->is_samesite(), $this->task->get_progress());
913     }
916 /**
917  * Execution step that will create all the needed users as calculated
918  * by @restore_process_included_users (those having newiteind = 0)
919  */
920 class restore_create_included_users extends restore_execution_step {
922     protected function define_execution() {
924         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(),
925                 $this->task->get_userid(), $this->task->get_progress());
926     }
929 /**
930  * Structure step that will create all the needed groups and groupings
931  * by loading them from the groups.xml file performing the required matches.
932  * Note group members only will be added if restoring user info
933  */
934 class restore_groups_structure_step extends restore_structure_step {
936     protected function define_structure() {
938         $paths = array(); // Add paths here
940         // Do not include group/groupings information if not requested.
941         $groupinfo = $this->get_setting_value('groups');
942         if ($groupinfo) {
943             $paths[] = new restore_path_element('group', '/groups/group');
944             $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
945             $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
946         }
947         return $paths;
948     }
950     // Processing functions go here
951     public function process_group($data) {
952         global $DB;
954         $data = (object)$data; // handy
955         $data->courseid = $this->get_courseid();
957         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
958         // another a group in the same course
959         $context = context_course::instance($data->courseid);
960         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
961             if (groups_get_group_by_idnumber($data->courseid, $data->idnumber)) {
962                 unset($data->idnumber);
963             }
964         } else {
965             unset($data->idnumber);
966         }
968         $oldid = $data->id;    // need this saved for later
970         $restorefiles = false; // Only if we end creating the group
972         // Search if the group already exists (by name & description) in the target course
973         $description_clause = '';
974         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
975         if (!empty($data->description)) {
976             $description_clause = ' AND ' .
977                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
978            $params['description'] = $data->description;
979         }
980         if (!$groupdb = $DB->get_record_sql("SELECT *
981                                                FROM {groups}
982                                               WHERE courseid = :courseid
983                                                 AND name = :grname $description_clause", $params)) {
984             // group doesn't exist, create
985             $newitemid = $DB->insert_record('groups', $data);
986             $restorefiles = true; // We'll restore the files
987         } else {
988             // group exists, use it
989             $newitemid = $groupdb->id;
990         }
991         // Save the id mapping
992         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
993         // Invalidate the course group data cache just in case.
994         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
995     }
997     public function process_grouping($data) {
998         global $DB;
1000         $data = (object)$data; // handy
1001         $data->courseid = $this->get_courseid();
1003         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1004         // another a grouping in the same course
1005         $context = context_course::instance($data->courseid);
1006         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1007             if (groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) {
1008                 unset($data->idnumber);
1009             }
1010         } else {
1011             unset($data->idnumber);
1012         }
1014         $oldid = $data->id;    // need this saved for later
1015         $restorefiles = false; // Only if we end creating the grouping
1017         // Search if the grouping already exists (by name & description) in the target course
1018         $description_clause = '';
1019         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
1020         if (!empty($data->description)) {
1021             $description_clause = ' AND ' .
1022                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
1023            $params['description'] = $data->description;
1024         }
1025         if (!$groupingdb = $DB->get_record_sql("SELECT *
1026                                                   FROM {groupings}
1027                                                  WHERE courseid = :courseid
1028                                                    AND name = :grname $description_clause", $params)) {
1029             // grouping doesn't exist, create
1030             $newitemid = $DB->insert_record('groupings', $data);
1031             $restorefiles = true; // We'll restore the files
1032         } else {
1033             // grouping exists, use it
1034             $newitemid = $groupingdb->id;
1035         }
1036         // Save the id mapping
1037         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
1038         // Invalidate the course group data cache just in case.
1039         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
1040     }
1042     public function process_grouping_group($data) {
1043         global $CFG;
1045         require_once($CFG->dirroot.'/group/lib.php');
1047         $data = (object)$data;
1048         groups_assign_grouping($this->get_new_parentid('grouping'), $this->get_mappingid('group', $data->groupid), $data->timeadded);
1049     }
1051     protected function after_execute() {
1052         // Add group related files, matching with "group" mappings
1053         $this->add_related_files('group', 'icon', 'group');
1054         $this->add_related_files('group', 'description', 'group');
1055         // Add grouping related files, matching with "grouping" mappings
1056         $this->add_related_files('grouping', 'description', 'grouping');
1057         // Invalidate the course group data.
1058         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($this->get_courseid()));
1059     }
1063 /**
1064  * Structure step that will create all the needed group memberships
1065  * by loading them from the groups.xml file performing the required matches.
1066  */
1067 class restore_groups_members_structure_step extends restore_structure_step {
1069     protected $plugins = null;
1071     protected function define_structure() {
1073         $paths = array(); // Add paths here
1075         if ($this->get_setting_value('groups') && $this->get_setting_value('users')) {
1076             $paths[] = new restore_path_element('group', '/groups/group');
1077             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
1078         }
1080         return $paths;
1081     }
1083     public function process_group($data) {
1084         $data = (object)$data; // handy
1086         // HACK ALERT!
1087         // Not much to do here, this groups mapping should be already done from restore_groups_structure_step.
1088         // Let's fake internal state to make $this->get_new_parentid('group') work.
1090         $this->set_mapping('group', $data->id, $this->get_mappingid('group', $data->id));
1091     }
1093     public function process_member($data) {
1094         global $DB, $CFG;
1095         require_once("$CFG->dirroot/group/lib.php");
1097         // NOTE: Always use groups_add_member() because it triggers events and verifies if user is enrolled.
1099         $data = (object)$data; // handy
1101         // get parent group->id
1102         $data->groupid = $this->get_new_parentid('group');
1104         // map user newitemid and insert if not member already
1105         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
1106             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
1107                 // Check the component, if any, exists.
1108                 if (empty($data->component)) {
1109                     groups_add_member($data->groupid, $data->userid);
1111                 } else if ((strpos($data->component, 'enrol_') === 0)) {
1112                     // Deal with enrolment groups - ignore the component and just find out the instance via new id,
1113                     // it is possible that enrolment was restored using different plugin type.
1114                     if (!isset($this->plugins)) {
1115                         $this->plugins = enrol_get_plugins(true);
1116                     }
1117                     if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1118                         if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1119                             if (isset($this->plugins[$instance->enrol])) {
1120                                 $this->plugins[$instance->enrol]->restore_group_member($instance, $data->groupid, $data->userid);
1121                             }
1122                         }
1123                     }
1125                 } else {
1126                     $dir = core_component::get_component_directory($data->component);
1127                     if ($dir and is_dir($dir)) {
1128                         if (component_callback($data->component, 'restore_group_member', array($this, $data), true)) {
1129                             return;
1130                         }
1131                     }
1132                     // Bad luck, plugin could not restore the data, let's add normal membership.
1133                     groups_add_member($data->groupid, $data->userid);
1134                     $message = "Restore of '$data->component/$data->itemid' group membership is not supported, using standard group membership instead.";
1135                     $this->log($message, backup::LOG_WARNING);
1136                 }
1137             }
1138         }
1139     }
1142 /**
1143  * Structure step that will create all the needed scales
1144  * by loading them from the scales.xml
1145  */
1146 class restore_scales_structure_step extends restore_structure_step {
1148     protected function define_structure() {
1150         $paths = array(); // Add paths here
1151         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
1152         return $paths;
1153     }
1155     protected function process_scale($data) {
1156         global $DB;
1158         $data = (object)$data;
1160         $restorefiles = false; // Only if we end creating the group
1162         $oldid = $data->id;    // need this saved for later
1164         // Look for scale (by 'scale' both in standard (course=0) and current course
1165         // with priority to standard scales (ORDER clause)
1166         // scale is not course unique, use get_record_sql to suppress warning
1167         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
1168         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
1169         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
1170         if (!$scadb = $DB->get_record_sql("SELECT *
1171                                             FROM {scale}
1172                                            WHERE courseid IN (0, :courseid)
1173                                              AND $compare_scale_clause
1174                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
1175             // Remap the user if possible, defaut to user performing the restore if not
1176             $userid = $this->get_mappingid('user', $data->userid);
1177             $data->userid = $userid ? $userid : $this->task->get_userid();
1178             // Remap the course if course scale
1179             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
1180             // If global scale (course=0), check the user has perms to create it
1181             // falling to course scale if not
1182             $systemctx = context_system::instance();
1183             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
1184                 $data->courseid = $this->get_courseid();
1185             }
1186             // scale doesn't exist, create
1187             $newitemid = $DB->insert_record('scale', $data);
1188             $restorefiles = true; // We'll restore the files
1189         } else {
1190             // scale exists, use it
1191             $newitemid = $scadb->id;
1192         }
1193         // Save the id mapping (with files support at system context)
1194         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1195     }
1197     protected function after_execute() {
1198         // Add scales related files, matching with "scale" mappings
1199         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
1200     }
1204 /**
1205  * Structure step that will create all the needed outocomes
1206  * by loading them from the outcomes.xml
1207  */
1208 class restore_outcomes_structure_step extends restore_structure_step {
1210     protected function define_structure() {
1212         $paths = array(); // Add paths here
1213         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
1214         return $paths;
1215     }
1217     protected function process_outcome($data) {
1218         global $DB;
1220         $data = (object)$data;
1222         $restorefiles = false; // Only if we end creating the group
1224         $oldid = $data->id;    // need this saved for later
1226         // Look for outcome (by shortname both in standard (courseid=null) and current course
1227         // with priority to standard outcomes (ORDER clause)
1228         // outcome is not course unique, use get_record_sql to suppress warning
1229         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
1230         if (!$outdb = $DB->get_record_sql('SELECT *
1231                                              FROM {grade_outcomes}
1232                                             WHERE shortname = :shortname
1233                                               AND (courseid = :courseid OR courseid IS NULL)
1234                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
1235             // Remap the user
1236             $userid = $this->get_mappingid('user', $data->usermodified);
1237             $data->usermodified = $userid ? $userid : $this->task->get_userid();
1238             // Remap the scale
1239             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
1240             // Remap the course if course outcome
1241             $data->courseid = $data->courseid ? $this->get_courseid() : null;
1242             // If global outcome (course=null), check the user has perms to create it
1243             // falling to course outcome if not
1244             $systemctx = context_system::instance();
1245             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
1246                 $data->courseid = $this->get_courseid();
1247             }
1248             // outcome doesn't exist, create
1249             $newitemid = $DB->insert_record('grade_outcomes', $data);
1250             $restorefiles = true; // We'll restore the files
1251         } else {
1252             // scale exists, use it
1253             $newitemid = $outdb->id;
1254         }
1255         // Set the corresponding grade_outcomes_courses record
1256         $outcourserec = new stdclass();
1257         $outcourserec->courseid  = $this->get_courseid();
1258         $outcourserec->outcomeid = $newitemid;
1259         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
1260             $DB->insert_record('grade_outcomes_courses', $outcourserec);
1261         }
1262         // Save the id mapping (with files support at system context)
1263         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1264     }
1266     protected function after_execute() {
1267         // Add outcomes related files, matching with "outcome" mappings
1268         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
1269     }
1272 /**
1273  * Execution step that, *conditionally* (if there isn't preloaded information
1274  * will load all the question categories and questions (header info only)
1275  * to backup_temp_ids. They will be stored with "question_category" and
1276  * "question" itemnames and with their original contextid and question category
1277  * id as paremitemids
1278  */
1279 class restore_load_categories_and_questions extends restore_execution_step {
1281     protected function define_execution() {
1283         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1284             return;
1285         }
1286         $file = $this->get_basepath() . '/questions.xml';
1287         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
1288     }
1291 /**
1292  * Execution step that, *conditionally* (if there isn't preloaded information)
1293  * will process all the needed categories and questions
1294  * in order to decide and perform any action with them (create / map / error)
1295  * Note: Any error will cause exception, as far as this is the same processing
1296  * than the one into restore prechecks (that should have stopped process earlier)
1297  */
1298 class restore_process_categories_and_questions extends restore_execution_step {
1300     protected function define_execution() {
1302         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1303             return;
1304         }
1305         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
1306     }
1309 /**
1310  * Structure step that will read the section.xml creating/updating sections
1311  * as needed, rebuilding course cache and other friends
1312  */
1313 class restore_section_structure_step extends restore_structure_step {
1315     protected function define_structure() {
1316         global $CFG;
1318         $paths = array();
1320         $section = new restore_path_element('section', '/section');
1321         $paths[] = $section;
1322         if ($CFG->enableavailability) {
1323             $paths[] = new restore_path_element('availability', '/section/availability');
1324             $paths[] = new restore_path_element('availability_field', '/section/availability_field');
1325         }
1326         $paths[] = new restore_path_element('course_format_options', '/section/course_format_options');
1328         // Apply for 'format' plugins optional paths at section level
1329         $this->add_plugin_structure('format', $section);
1331         // Apply for 'local' plugins optional paths at section level
1332         $this->add_plugin_structure('local', $section);
1334         return $paths;
1335     }
1337     public function process_section($data) {
1338         global $CFG, $DB;
1339         $data = (object)$data;
1340         $oldid = $data->id; // We'll need this later
1342         $restorefiles = false;
1344         // Look for the section
1345         $section = new stdclass();
1346         $section->course  = $this->get_courseid();
1347         $section->section = $data->number;
1348         // Section doesn't exist, create it with all the info from backup
1349         if (!$secrec = $DB->get_record('course_sections', (array)$section)) {
1350             $section->name = $data->name;
1351             $section->summary = $data->summary;
1352             $section->summaryformat = $data->summaryformat;
1353             $section->sequence = '';
1354             $section->visible = $data->visible;
1355             if (empty($CFG->enableavailability)) { // Process availability information only if enabled.
1356                 $section->availability = null;
1357             } else {
1358                 $section->availability = isset($data->availabilityjson) ? $data->availabilityjson : null;
1359                 // Include legacy [<2.7] availability data if provided.
1360                 if (is_null($section->availability)) {
1361                     $section->availability = \core_availability\info::convert_legacy_fields(
1362                             $data, true);
1363                 }
1364             }
1365             $newitemid = $DB->insert_record('course_sections', $section);
1366             $restorefiles = true;
1368         // Section exists, update non-empty information
1369         } else {
1370             $section->id = $secrec->id;
1371             if ((string)$secrec->name === '') {
1372                 $section->name = $data->name;
1373             }
1374             if (empty($secrec->summary)) {
1375                 $section->summary = $data->summary;
1376                 $section->summaryformat = $data->summaryformat;
1377                 $restorefiles = true;
1378             }
1380             // Don't update availability (I didn't see a useful way to define
1381             // whether existing or new one should take precedence).
1383             $DB->update_record('course_sections', $section);
1384             $newitemid = $secrec->id;
1385         }
1387         // Annotate the section mapping, with restorefiles option if needed
1388         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
1390         // set the new course_section id in the task
1391         $this->task->set_sectionid($newitemid);
1393         // If there is the legacy showavailability data, store this for later use.
1394         // (This data is not present when restoring 'new' backups.)
1395         if (isset($data->showavailability)) {
1396             // Cache the showavailability flag using the backup_ids data field.
1397             restore_dbops::set_backup_ids_record($this->get_restoreid(),
1398                     'section_showavailability', $newitemid, 0, null,
1399                     (object)array('showavailability' => $data->showavailability));
1400         }
1402         // Commented out. We never modify course->numsections as far as that is used
1403         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
1404         // Note: We keep the code here, to know about and because of the possibility of making this
1405         // optional based on some setting/attribute in the future
1406         // If needed, adjust course->numsections
1407         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
1408         //    if ($numsections < $section->section) {
1409         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
1410         //    }
1411         //}
1412     }
1414     /**
1415      * Process the legacy availability table record. This table does not exist
1416      * in Moodle 2.7+ but we still support restore.
1417      *
1418      * @param stdClass $data Record data
1419      */
1420     public function process_availability($data) {
1421         $data = (object)$data;
1422         // Simply going to store the whole availability record now, we'll process
1423         // all them later in the final task (once all activities have been restored)
1424         // Let's call the low level one to be able to store the whole object.
1425         $data->coursesectionid = $this->task->get_sectionid();
1426         restore_dbops::set_backup_ids_record($this->get_restoreid(),
1427                 'section_availability', $data->id, 0, null, $data);
1428     }
1430     /**
1431      * Process the legacy availability fields table record. This table does not
1432      * exist in Moodle 2.7+ but we still support restore.
1433      *
1434      * @param stdClass $data Record data
1435      */
1436     public function process_availability_field($data) {
1437         global $DB;
1438         $data = (object)$data;
1439         // Mark it is as passed by default
1440         $passed = true;
1441         $customfieldid = null;
1443         // If a customfield has been used in order to pass we must be able to match an existing
1444         // customfield by name (data->customfield) and type (data->customfieldtype)
1445         if (is_null($data->customfield) xor is_null($data->customfieldtype)) {
1446             // xor is sort of uncommon. If either customfield is null or customfieldtype is null BUT not both.
1447             // If one is null but the other isn't something clearly went wrong and we'll skip this condition.
1448             $passed = false;
1449         } else if (!is_null($data->customfield)) {
1450             $params = array('shortname' => $data->customfield, 'datatype' => $data->customfieldtype);
1451             $customfieldid = $DB->get_field('user_info_field', 'id', $params);
1452             $passed = ($customfieldid !== false);
1453         }
1455         if ($passed) {
1456             // Create the object to insert into the database
1457             $availfield = new stdClass();
1458             $availfield->coursesectionid = $this->task->get_sectionid();
1459             $availfield->userfield = $data->userfield;
1460             $availfield->customfieldid = $customfieldid;
1461             $availfield->operator = $data->operator;
1462             $availfield->value = $data->value;
1464             // Get showavailability option.
1465             $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
1466                     'section_showavailability', $availfield->coursesectionid);
1467             if (!$showrec) {
1468                 // Should not happen.
1469                 throw new coding_exception('No matching showavailability record');
1470             }
1471             $show = $showrec->info->showavailability;
1473             // The $availfield object is now in the format used in the old
1474             // system. Interpret this and convert to new system.
1475             $currentvalue = $DB->get_field('course_sections', 'availability',
1476                     array('id' => $availfield->coursesectionid), MUST_EXIST);
1477             $newvalue = \core_availability\info::add_legacy_availability_field_condition(
1478                     $currentvalue, $availfield, $show);
1479             $DB->set_field('course_sections', 'availability', $newvalue,
1480                     array('id' => $availfield->coursesectionid));
1481         }
1482     }
1484     public function process_course_format_options($data) {
1485         global $DB;
1486         $data = (object)$data;
1487         $oldid = $data->id;
1488         unset($data->id);
1489         $data->sectionid = $this->task->get_sectionid();
1490         $data->courseid = $this->get_courseid();
1491         $newid = $DB->insert_record('course_format_options', $data);
1492         $this->set_mapping('course_format_options', $oldid, $newid);
1493     }
1495     protected function after_execute() {
1496         // Add section related files, with 'course_section' itemid to match
1497         $this->add_related_files('course', 'section', 'course_section');
1498     }
1501 /**
1502  * Structure step that will read the course.xml file, loading it and performing
1503  * various actions depending of the site/restore settings. Note that target
1504  * course always exist before arriving here so this step will be updating
1505  * the course record (never inserting)
1506  */
1507 class restore_course_structure_step extends restore_structure_step {
1508     /**
1509      * @var bool this gets set to true by {@link process_course()} if we are
1510      * restoring an old coures that used the legacy 'module security' feature.
1511      * If so, we have to do more work in {@link after_execute()}.
1512      */
1513     protected $legacyrestrictmodules = false;
1515     /**
1516      * @var array Used when {@link $legacyrestrictmodules} is true. This is an
1517      * array with array keys the module names ('forum', 'quiz', etc.). These are
1518      * the modules that are allowed according to the data in the backup file.
1519      * In {@link after_execute()} we then have to prevent adding of all the other
1520      * types of activity.
1521      */
1522     protected $legacyallowedmodules = array();
1524     protected function define_structure() {
1526         $course = new restore_path_element('course', '/course');
1527         $category = new restore_path_element('category', '/course/category');
1528         $tag = new restore_path_element('tag', '/course/tags/tag');
1529         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1531         // Apply for 'format' plugins optional paths at course level
1532         $this->add_plugin_structure('format', $course);
1534         // Apply for 'theme' plugins optional paths at course level
1535         $this->add_plugin_structure('theme', $course);
1537         // Apply for 'report' plugins optional paths at course level
1538         $this->add_plugin_structure('report', $course);
1540         // Apply for 'course report' plugins optional paths at course level
1541         $this->add_plugin_structure('coursereport', $course);
1543         // Apply for plagiarism plugins optional paths at course level
1544         $this->add_plugin_structure('plagiarism', $course);
1546         // Apply for local plugins optional paths at course level
1547         $this->add_plugin_structure('local', $course);
1549         return array($course, $category, $tag, $allowed_module);
1550     }
1552     /**
1553      * Processing functions go here
1554      *
1555      * @global moodledatabase $DB
1556      * @param stdClass $data
1557      */
1558     public function process_course($data) {
1559         global $CFG, $DB;
1561         $data = (object)$data;
1563         $fullname  = $this->get_setting_value('course_fullname');
1564         $shortname = $this->get_setting_value('course_shortname');
1565         $startdate = $this->get_setting_value('course_startdate');
1567         // Calculate final course names, to avoid dupes
1568         list($fullname, $shortname) = restore_dbops::calculate_course_names($this->get_courseid(), $fullname, $shortname);
1570         // Need to change some fields before updating the course record
1571         $data->id = $this->get_courseid();
1572         $data->fullname = $fullname;
1573         $data->shortname= $shortname;
1575         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
1576         // another course on this site.
1577         $context = context::instance_by_id($this->task->get_contextid());
1578         if (!empty($data->idnumber) && has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid()) &&
1579                 $this->task->is_samesite() && !$DB->record_exists('course', array('idnumber' => $data->idnumber))) {
1580             // Do not reset idnumber.
1581         } else {
1582             $data->idnumber = '';
1583         }
1585         // Any empty value for course->hiddensections will lead to 0 (default, show collapsed).
1586         // It has been reported that some old 1.9 courses may have it null leading to DB error. MDL-31532
1587         if (empty($data->hiddensections)) {
1588             $data->hiddensections = 0;
1589         }
1591         // Set legacyrestrictmodules to true if the course was resticting modules. If so
1592         // then we will need to process restricted modules after execution.
1593         $this->legacyrestrictmodules = !empty($data->restrictmodules);
1595         $data->startdate= $this->apply_date_offset($data->startdate);
1596         if ($data->defaultgroupingid) {
1597             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1598         }
1599         if (empty($CFG->enablecompletion)) {
1600             $data->enablecompletion = 0;
1601             $data->completionstartonenrol = 0;
1602             $data->completionnotify = 0;
1603         }
1604         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1605         if (!array_key_exists($data->lang, $languages)) {
1606             $data->lang = '';
1607         }
1609         $themes = get_list_of_themes(); // Get themes for quick search later
1610         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1611             $data->theme = '';
1612         }
1614         // Check if this is an old SCORM course format.
1615         if ($data->format == 'scorm') {
1616             $data->format = 'singleactivity';
1617             $data->activitytype = 'scorm';
1618         }
1620         // Course record ready, update it
1621         $DB->update_record('course', $data);
1623         course_get_format($data)->update_course_format_options($data);
1625         // Role name aliases
1626         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1627     }
1629     public function process_category($data) {
1630         // Nothing to do with the category. UI sets it before restore starts
1631     }
1633     public function process_tag($data) {
1634         global $CFG, $DB;
1636         $data = (object)$data;
1638         if (!empty($CFG->usetags)) { // if enabled in server
1639             // TODO: This is highly inneficient. Each time we add one tag
1640             // we fetch all the existing because tag_set() deletes them
1641             // so everything must be reinserted on each call
1642             $tags = array();
1643             $existingtags = tag_get_tags('course', $this->get_courseid());
1644             // Re-add all the existitng tags
1645             foreach ($existingtags as $existingtag) {
1646                 $tags[] = $existingtag->rawname;
1647             }
1648             // Add the one being restored
1649             $tags[] = $data->rawname;
1650             // Send all the tags back to the course
1651             tag_set('course', $this->get_courseid(), $tags, 'core',
1652                 context_course::instance($this->get_courseid())->id);
1653         }
1654     }
1656     public function process_allowed_module($data) {
1657         $data = (object)$data;
1659         // Backwards compatiblity support for the data that used to be in the
1660         // course_allowed_modules table.
1661         if ($this->legacyrestrictmodules) {
1662             $this->legacyallowedmodules[$data->modulename] = 1;
1663         }
1664     }
1666     protected function after_execute() {
1667         global $DB;
1669         // Add course related files, without itemid to match
1670         $this->add_related_files('course', 'summary', null);
1671         $this->add_related_files('course', 'overviewfiles', null);
1673         // Deal with legacy allowed modules.
1674         if ($this->legacyrestrictmodules) {
1675             $context = context_course::instance($this->get_courseid());
1677             list($roleids) = get_roles_with_cap_in_context($context, 'moodle/course:manageactivities');
1678             list($managerroleids) = get_roles_with_cap_in_context($context, 'moodle/site:config');
1679             foreach ($managerroleids as $roleid) {
1680                 unset($roleids[$roleid]);
1681             }
1683             foreach (core_component::get_plugin_list('mod') as $modname => $notused) {
1684                 if (isset($this->legacyallowedmodules[$modname])) {
1685                     // Module is allowed, no worries.
1686                     continue;
1687                 }
1689                 $capability = 'mod/' . $modname . ':addinstance';
1690                 foreach ($roleids as $roleid) {
1691                     assign_capability($capability, CAP_PREVENT, $roleid, $context);
1692                 }
1693             }
1694         }
1695     }
1698 /**
1699  * Execution step that will migrate legacy files if present.
1700  */
1701 class restore_course_legacy_files_step extends restore_execution_step {
1702     public function define_execution() {
1703         global $DB;
1705         // Do a check for legacy files and skip if there are none.
1706         $sql = 'SELECT count(*)
1707                   FROM {backup_files_temp}
1708                  WHERE backupid = ?
1709                    AND contextid = ?
1710                    AND component = ?
1711                    AND filearea  = ?';
1712         $params = array($this->get_restoreid(), $this->task->get_old_contextid(), 'course', 'legacy');
1714         if ($DB->count_records_sql($sql, $params)) {
1715             $DB->set_field('course', 'legacyfiles', 2, array('id' => $this->get_courseid()));
1716             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'course',
1717                 'legacy', $this->task->get_old_contextid(), $this->task->get_userid());
1718         }
1719     }
1722 /*
1723  * Structure step that will read the roles.xml file (at course/activity/block levels)
1724  * containing all the role_assignments and overrides for that context. If corresponding to
1725  * one mapped role, they will be applied to target context. Will observe the role_assignments
1726  * setting to decide if ras are restored.
1727  *
1728  * Note: this needs to be executed after all users are enrolled.
1729  */
1730 class restore_ras_and_caps_structure_step extends restore_structure_step {
1731     protected $plugins = null;
1733     protected function define_structure() {
1735         $paths = array();
1737         // Observe the role_assignments setting
1738         if ($this->get_setting_value('role_assignments')) {
1739             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
1740         }
1741         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
1743         return $paths;
1744     }
1746     /**
1747      * Assign roles
1748      *
1749      * This has to be called after enrolments processing.
1750      *
1751      * @param mixed $data
1752      * @return void
1753      */
1754     public function process_assignment($data) {
1755         global $DB;
1757         $data = (object)$data;
1759         // Check roleid, userid are one of the mapped ones
1760         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
1761             return;
1762         }
1763         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
1764             return;
1765         }
1766         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
1767             // Only assign roles to not deleted users
1768             return;
1769         }
1770         if (!$contextid = $this->task->get_contextid()) {
1771             return;
1772         }
1774         if (empty($data->component)) {
1775             // assign standard manual roles
1776             // TODO: role_assign() needs one userid param to be able to specify our restore userid
1777             role_assign($newroleid, $newuserid, $contextid);
1779         } else if ((strpos($data->component, 'enrol_') === 0)) {
1780             // Deal with enrolment roles - ignore the component and just find out the instance via new id,
1781             // it is possible that enrolment was restored using different plugin type.
1782             if (!isset($this->plugins)) {
1783                 $this->plugins = enrol_get_plugins(true);
1784             }
1785             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1786                 if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1787                     if (isset($this->plugins[$instance->enrol])) {
1788                         $this->plugins[$instance->enrol]->restore_role_assignment($instance, $newroleid, $newuserid, $contextid);
1789                     }
1790                 }
1791             }
1793         } else {
1794             $data->roleid    = $newroleid;
1795             $data->userid    = $newuserid;
1796             $data->contextid = $contextid;
1797             $dir = core_component::get_component_directory($data->component);
1798             if ($dir and is_dir($dir)) {
1799                 if (component_callback($data->component, 'restore_role_assignment', array($this, $data), true)) {
1800                     return;
1801                 }
1802             }
1803             // Bad luck, plugin could not restore the data, let's add normal membership.
1804             role_assign($data->roleid, $data->userid, $data->contextid);
1805             $message = "Restore of '$data->component/$data->itemid' role assignments is not supported, using manual role assignments instead.";
1806             $this->log($message, backup::LOG_WARNING);
1807         }
1808     }
1810     public function process_override($data) {
1811         $data = (object)$data;
1813         // Check roleid is one of the mapped ones
1814         $newroleid = $this->get_mappingid('role', $data->roleid);
1815         // If newroleid and context are valid assign it via API (it handles dupes and so on)
1816         if ($newroleid && $this->task->get_contextid()) {
1817             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
1818             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
1819             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
1820         }
1821     }
1824 /**
1825  * If no instances yet add default enrol methods the same way as when creating new course in UI.
1826  */
1827 class restore_default_enrolments_step extends restore_execution_step {
1829     public function define_execution() {
1830         global $DB;
1832         // No enrolments in front page.
1833         if ($this->get_courseid() == SITEID) {
1834             return;
1835         }
1837         $course = $DB->get_record('course', array('id'=>$this->get_courseid()), '*', MUST_EXIST);
1839         if ($DB->record_exists('enrol', array('courseid'=>$this->get_courseid(), 'enrol'=>'manual'))) {
1840             // Something already added instances, do not add default instances.
1841             $plugins = enrol_get_plugins(true);
1842             foreach ($plugins as $plugin) {
1843                 $plugin->restore_sync_course($course);
1844             }
1846         } else {
1847             // Looks like a newly created course.
1848             enrol_course_updated(true, $course, null);
1849         }
1850     }
1853 /**
1854  * This structure steps restores the enrol plugins and their underlying
1855  * enrolments, performing all the mappings and/or movements required
1856  */
1857 class restore_enrolments_structure_step extends restore_structure_step {
1858     protected $enrolsynced = false;
1859     protected $plugins = null;
1860     protected $originalstatus = array();
1862     /**
1863      * Conditionally decide if this step should be executed.
1864      *
1865      * This function checks the following parameter:
1866      *
1867      *   1. the course/enrolments.xml file exists
1868      *
1869      * @return bool true is safe to execute, false otherwise
1870      */
1871     protected function execute_condition() {
1873         if ($this->get_courseid() == SITEID) {
1874             return false;
1875         }
1877         // Check it is included in the backup
1878         $fullpath = $this->task->get_taskbasepath();
1879         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1880         if (!file_exists($fullpath)) {
1881             // Not found, can't restore enrolments info
1882             return false;
1883         }
1885         return true;
1886     }
1888     protected function define_structure() {
1890         $enrol = new restore_path_element('enrol', '/enrolments/enrols/enrol');
1891         $enrolment = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
1892         // Attach local plugin stucture to enrol element.
1893         $this->add_plugin_structure('enrol', $enrol);
1895         return array($enrol, $enrolment);
1896     }
1898     /**
1899      * Create enrolment instances.
1900      *
1901      * This has to be called after creation of roles
1902      * and before adding of role assignments.
1903      *
1904      * @param mixed $data
1905      * @return void
1906      */
1907     public function process_enrol($data) {
1908         global $DB;
1910         $data = (object)$data;
1911         $oldid = $data->id; // We'll need this later.
1912         unset($data->id);
1914         $this->originalstatus[$oldid] = $data->status;
1916         if (!$courserec = $DB->get_record('course', array('id' => $this->get_courseid()))) {
1917             $this->set_mapping('enrol', $oldid, 0);
1918             return;
1919         }
1921         if (!isset($this->plugins)) {
1922             $this->plugins = enrol_get_plugins(true);
1923         }
1925         if (!$this->enrolsynced) {
1926             // Make sure that all plugin may create instances and enrolments automatically
1927             // before the first instance restore - this is suitable especially for plugins
1928             // that synchronise data automatically using course->idnumber or by course categories.
1929             foreach ($this->plugins as $plugin) {
1930                 $plugin->restore_sync_course($courserec);
1931             }
1932             $this->enrolsynced = true;
1933         }
1935         // Map standard fields - plugin has to process custom fields manually.
1936         $data->roleid   = $this->get_mappingid('role', $data->roleid);
1937         $data->courseid = $courserec->id;
1939         if ($this->get_setting_value('enrol_migratetomanual')) {
1940             unset($data->sortorder); // Remove useless sortorder from <2.4 backups.
1941             if (!enrol_is_enabled('manual')) {
1942                 $this->set_mapping('enrol', $oldid, 0);
1943                 return;
1944             }
1945             if ($instances = $DB->get_records('enrol', array('courseid'=>$data->courseid, 'enrol'=>'manual'), 'id')) {
1946                 $instance = reset($instances);
1947                 $this->set_mapping('enrol', $oldid, $instance->id);
1948             } else {
1949                 if ($data->enrol === 'manual') {
1950                     $instanceid = $this->plugins['manual']->add_instance($courserec, (array)$data);
1951                 } else {
1952                     $instanceid = $this->plugins['manual']->add_default_instance($courserec);
1953                 }
1954                 $this->set_mapping('enrol', $oldid, $instanceid);
1955             }
1957         } else {
1958             if (!enrol_is_enabled($data->enrol) or !isset($this->plugins[$data->enrol])) {
1959                 $this->set_mapping('enrol', $oldid, 0);
1960                 $message = "Enrol plugin '$data->enrol' data can not be restored because it is not enabled, use migration to manual enrolments";
1961                 $this->log($message, backup::LOG_WARNING);
1962                 return;
1963             }
1964             if ($task = $this->get_task() and $task->get_target() == backup::TARGET_NEW_COURSE) {
1965                 // Let's keep the sortorder in old backups.
1966             } else {
1967                 // Prevent problems with colliding sortorders in old backups,
1968                 // new 2.4 backups do not need sortorder because xml elements are ordered properly.
1969                 unset($data->sortorder);
1970             }
1971             // Note: plugin is responsible for setting up the mapping, it may also decide to migrate to different type.
1972             $this->plugins[$data->enrol]->restore_instance($this, $data, $courserec, $oldid);
1973         }
1974     }
1976     /**
1977      * Create user enrolments.
1978      *
1979      * This has to be called after creation of enrolment instances
1980      * and before adding of role assignments.
1981      *
1982      * Roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing afterwards.
1983      *
1984      * @param mixed $data
1985      * @return void
1986      */
1987     public function process_enrolment($data) {
1988         global $DB;
1990         if (!isset($this->plugins)) {
1991             $this->plugins = enrol_get_plugins(true);
1992         }
1994         $data = (object)$data;
1996         // Process only if parent instance have been mapped.
1997         if ($enrolid = $this->get_new_parentid('enrol')) {
1998             $oldinstancestatus = ENROL_INSTANCE_ENABLED;
1999             $oldenrolid = $this->get_old_parentid('enrol');
2000             if (isset($this->originalstatus[$oldenrolid])) {
2001                 $oldinstancestatus = $this->originalstatus[$oldenrolid];
2002             }
2003             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
2004                 // And only if user is a mapped one.
2005                 if ($userid = $this->get_mappingid('user', $data->userid)) {
2006                     if (isset($this->plugins[$instance->enrol])) {
2007                         $this->plugins[$instance->enrol]->restore_user_enrolment($this, $data, $instance, $userid, $oldinstancestatus);
2008                     }
2009                 }
2010             }
2011         }
2012     }
2016 /**
2017  * Make sure the user restoring the course can actually access it.
2018  */
2019 class restore_fix_restorer_access_step extends restore_execution_step {
2020     protected function define_execution() {
2021         global $CFG, $DB;
2023         if (!$userid = $this->task->get_userid()) {
2024             return;
2025         }
2027         if (empty($CFG->restorernewroleid)) {
2028             // Bad luck, no fallback role for restorers specified
2029             return;
2030         }
2032         $courseid = $this->get_courseid();
2033         $context = context_course::instance($courseid);
2035         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
2036             // Current user may access the course (admin, category manager or restored teacher enrolment usually)
2037             return;
2038         }
2040         // Try to add role only - we do not need enrolment if user has moodle/course:view or is already enrolled
2041         role_assign($CFG->restorernewroleid, $userid, $context);
2043         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
2044             // Extra role is enough, yay!
2045             return;
2046         }
2048         // The last chance is to create manual enrol if it does not exist and and try to enrol the current user,
2049         // hopefully admin selected suitable $CFG->restorernewroleid ...
2050         if (!enrol_is_enabled('manual')) {
2051             return;
2052         }
2053         if (!$enrol = enrol_get_plugin('manual')) {
2054             return;
2055         }
2056         if (!$DB->record_exists('enrol', array('enrol'=>'manual', 'courseid'=>$courseid))) {
2057             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
2058             $fields = array('status'=>ENROL_INSTANCE_ENABLED, 'enrolperiod'=>$enrol->get_config('enrolperiod', 0), 'roleid'=>$enrol->get_config('roleid', 0));
2059             $enrol->add_instance($course, $fields);
2060         }
2062         enrol_try_internal_enrol($courseid, $userid);
2063     }
2067 /**
2068  * This structure steps restores the filters and their configs
2069  */
2070 class restore_filters_structure_step extends restore_structure_step {
2072     protected function define_structure() {
2074         $paths = array();
2076         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
2077         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
2079         return $paths;
2080     }
2082     public function process_active($data) {
2084         $data = (object)$data;
2086         if (strpos($data->filter, 'filter/') === 0) {
2087             $data->filter = substr($data->filter, 7);
2089         } else if (strpos($data->filter, '/') !== false) {
2090             // Unsupported old filter.
2091             return;
2092         }
2094         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
2095             return;
2096         }
2097         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
2098     }
2100     public function process_config($data) {
2102         $data = (object)$data;
2104         if (strpos($data->filter, 'filter/') === 0) {
2105             $data->filter = substr($data->filter, 7);
2107         } else if (strpos($data->filter, '/') !== false) {
2108             // Unsupported old filter.
2109             return;
2110         }
2112         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
2113             return;
2114         }
2115         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
2116     }
2120 /**
2121  * This structure steps restores the comments
2122  * Note: Cannot use the comments API because defaults to USER->id.
2123  * That should change allowing to pass $userid
2124  */
2125 class restore_comments_structure_step extends restore_structure_step {
2127     protected function define_structure() {
2129         $paths = array();
2131         $paths[] = new restore_path_element('comment', '/comments/comment');
2133         return $paths;
2134     }
2136     public function process_comment($data) {
2137         global $DB;
2139         $data = (object)$data;
2141         // First of all, if the comment has some itemid, ask to the task what to map
2142         $mapping = false;
2143         if ($data->itemid) {
2144             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
2145             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
2146         }
2147         // Only restore the comment if has no mapping OR we have found the matching mapping
2148         if (!$mapping || $data->itemid) {
2149             // Only if user mapping and context
2150             $data->userid = $this->get_mappingid('user', $data->userid);
2151             if ($data->userid && $this->task->get_contextid()) {
2152                 $data->contextid = $this->task->get_contextid();
2153                 // Only if there is another comment with same context/user/timecreated
2154                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
2155                 if (!$DB->record_exists('comments', $params)) {
2156                     $DB->insert_record('comments', $data);
2157                 }
2158             }
2159         }
2160     }
2163 /**
2164  * This structure steps restores the badges and their configs
2165  */
2166 class restore_badges_structure_step extends restore_structure_step {
2168     /**
2169      * Conditionally decide if this step should be executed.
2170      *
2171      * This function checks the following parameters:
2172      *
2173      *   1. Badges and course badges are enabled on the site.
2174      *   2. The course/badges.xml file exists.
2175      *   3. All modules are restorable.
2176      *   4. All modules are marked for restore.
2177      *
2178      * @return bool True is safe to execute, false otherwise
2179      */
2180     protected function execute_condition() {
2181         global $CFG;
2183         // First check is badges and course level badges are enabled on this site.
2184         if (empty($CFG->enablebadges) || empty($CFG->badges_allowcoursebadges)) {
2185             // Disabled, don't restore course badges.
2186             return false;
2187         }
2189         // Check if badges.xml is included in the backup.
2190         $fullpath = $this->task->get_taskbasepath();
2191         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2192         if (!file_exists($fullpath)) {
2193             // Not found, can't restore course badges.
2194             return false;
2195         }
2197         // Check we are able to restore all backed up modules.
2198         if ($this->task->is_missing_modules()) {
2199             return false;
2200         }
2202         // Finally check all modules within the backup are being restored.
2203         if ($this->task->is_excluding_activities()) {
2204             return false;
2205         }
2207         return true;
2208     }
2210     protected function define_structure() {
2211         $paths = array();
2212         $paths[] = new restore_path_element('badge', '/badges/badge');
2213         $paths[] = new restore_path_element('criterion', '/badges/badge/criteria/criterion');
2214         $paths[] = new restore_path_element('parameter', '/badges/badge/criteria/criterion/parameters/parameter');
2215         $paths[] = new restore_path_element('manual_award', '/badges/badge/manual_awards/manual_award');
2217         return $paths;
2218     }
2220     public function process_badge($data) {
2221         global $DB, $CFG;
2223         require_once($CFG->libdir . '/badgeslib.php');
2225         $data = (object)$data;
2226         $data->usercreated = $this->get_mappingid('user', $data->usercreated);
2227         if (empty($data->usercreated)) {
2228             $data->usercreated = $this->task->get_userid();
2229         }
2230         $data->usermodified = $this->get_mappingid('user', $data->usermodified);
2231         if (empty($data->usermodified)) {
2232             $data->usermodified = $this->task->get_userid();
2233         }
2235         // We'll restore the badge image.
2236         $restorefiles = true;
2238         $courseid = $this->get_courseid();
2240         $params = array(
2241                 'name'           => $data->name,
2242                 'description'    => $data->description,
2243                 'timecreated'    => $this->apply_date_offset($data->timecreated),
2244                 'timemodified'   => $this->apply_date_offset($data->timemodified),
2245                 'usercreated'    => $data->usercreated,
2246                 'usermodified'   => $data->usermodified,
2247                 'issuername'     => $data->issuername,
2248                 'issuerurl'      => $data->issuerurl,
2249                 'issuercontact'  => $data->issuercontact,
2250                 'expiredate'     => $this->apply_date_offset($data->expiredate),
2251                 'expireperiod'   => $data->expireperiod,
2252                 'type'           => BADGE_TYPE_COURSE,
2253                 'courseid'       => $courseid,
2254                 'message'        => $data->message,
2255                 'messagesubject' => $data->messagesubject,
2256                 'attachment'     => $data->attachment,
2257                 'notification'   => $data->notification,
2258                 'status'         => BADGE_STATUS_INACTIVE,
2259                 'nextcron'       => $this->apply_date_offset($data->nextcron)
2260         );
2262         $newid = $DB->insert_record('badge', $params);
2263         $this->set_mapping('badge', $data->id, $newid, $restorefiles);
2264     }
2266     public function process_criterion($data) {
2267         global $DB;
2269         $data = (object)$data;
2271         $params = array(
2272                 'badgeid'      => $this->get_new_parentid('badge'),
2273                 'criteriatype' => $data->criteriatype,
2274                 'method'       => $data->method
2275         );
2276         $newid = $DB->insert_record('badge_criteria', $params);
2277         $this->set_mapping('criterion', $data->id, $newid);
2278     }
2280     public function process_parameter($data) {
2281         global $DB, $CFG;
2283         require_once($CFG->libdir . '/badgeslib.php');
2285         $data = (object)$data;
2286         $criteriaid = $this->get_new_parentid('criterion');
2288         // Parameter array that will go to database.
2289         $params = array();
2290         $params['critid'] = $criteriaid;
2292         $oldparam = explode('_', $data->name);
2294         if ($data->criteriatype == BADGE_CRITERIA_TYPE_ACTIVITY) {
2295             $module = $this->get_mappingid('course_module', $oldparam[1]);
2296             $params['name'] = $oldparam[0] . '_' . $module;
2297             $params['value'] = $oldparam[0] == 'module' ? $module : $data->value;
2298         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_COURSE) {
2299             $params['name'] = $oldparam[0] . '_' . $this->get_courseid();
2300             $params['value'] = $oldparam[0] == 'course' ? $this->get_courseid() : $data->value;
2301         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_MANUAL) {
2302             $role = $this->get_mappingid('role', $data->value);
2303             if (!empty($role)) {
2304                 $params['name'] = 'role_' . $role;
2305                 $params['value'] = $role;
2306             } else {
2307                 return;
2308             }
2309         }
2311         if (!$DB->record_exists('badge_criteria_param', $params)) {
2312             $DB->insert_record('badge_criteria_param', $params);
2313         }
2314     }
2316     public function process_manual_award($data) {
2317         global $DB;
2319         $data = (object)$data;
2320         $role = $this->get_mappingid('role', $data->issuerrole);
2322         if (!empty($role)) {
2323             $award = array(
2324                 'badgeid'     => $this->get_new_parentid('badge'),
2325                 'recipientid' => $this->get_mappingid('user', $data->recipientid),
2326                 'issuerid'    => $this->get_mappingid('user', $data->issuerid),
2327                 'issuerrole'  => $role,
2328                 'datemet'     => $this->apply_date_offset($data->datemet)
2329             );
2331             // Skip the manual award if recipient or issuer can not be mapped to.
2332             if (empty($award['recipientid']) || empty($award['issuerid'])) {
2333                 return;
2334             }
2336             $DB->insert_record('badge_manual_award', $award);
2337         }
2338     }
2340     protected function after_execute() {
2341         // Add related files.
2342         $this->add_related_files('badges', 'badgeimage', 'badge');
2343     }
2346 /**
2347  * This structure steps restores the calendar events
2348  */
2349 class restore_calendarevents_structure_step extends restore_structure_step {
2351     protected function define_structure() {
2353         $paths = array();
2355         $paths[] = new restore_path_element('calendarevents', '/events/event');
2357         return $paths;
2358     }
2360     public function process_calendarevents($data) {
2361         global $DB, $SITE, $USER;
2363         $data = (object)$data;
2364         $oldid = $data->id;
2365         $restorefiles = true; // We'll restore the files
2366         // Find the userid and the groupid associated with the event.
2367         $data->userid = $this->get_mappingid('user', $data->userid);
2368         if ($data->userid === false) {
2369             // Blank user ID means that we are dealing with module generated events such as quiz starting times.
2370             // Use the current user ID for these events.
2371             $data->userid = $USER->id;
2372         }
2373         if (!empty($data->groupid)) {
2374             $data->groupid = $this->get_mappingid('group', $data->groupid);
2375             if ($data->groupid === false) {
2376                 return;
2377             }
2378         }
2379         // Handle events with empty eventtype //MDL-32827
2380         if(empty($data->eventtype)) {
2381             if ($data->courseid == $SITE->id) {                                // Site event
2382                 $data->eventtype = "site";
2383             } else if ($data->courseid != 0 && $data->groupid == 0 && ($data->modulename == 'assignment' || $data->modulename == 'assign')) {
2384                 // Course assingment event
2385                 $data->eventtype = "due";
2386             } else if ($data->courseid != 0 && $data->groupid == 0) {      // Course event
2387                 $data->eventtype = "course";
2388             } else if ($data->groupid) {                                      // Group event
2389                 $data->eventtype = "group";
2390             } else if ($data->userid) {                                       // User event
2391                 $data->eventtype = "user";
2392             } else {
2393                 return;
2394             }
2395         }
2397         $params = array(
2398                 'name'           => $data->name,
2399                 'description'    => $data->description,
2400                 'format'         => $data->format,
2401                 'courseid'       => $this->get_courseid(),
2402                 'groupid'        => $data->groupid,
2403                 'userid'         => $data->userid,
2404                 'repeatid'       => $data->repeatid,
2405                 'modulename'     => $data->modulename,
2406                 'eventtype'      => $data->eventtype,
2407                 'timestart'      => $this->apply_date_offset($data->timestart),
2408                 'timeduration'   => $data->timeduration,
2409                 'visible'        => $data->visible,
2410                 'uuid'           => $data->uuid,
2411                 'sequence'       => $data->sequence,
2412                 'timemodified'    => $this->apply_date_offset($data->timemodified));
2413         if ($this->name == 'activity_calendar') {
2414             $params['instance'] = $this->task->get_activityid();
2415         } else {
2416             $params['instance'] = 0;
2417         }
2418         $sql = "SELECT id
2419                   FROM {event}
2420                  WHERE " . $DB->sql_compare_text('name', 255) . " = " . $DB->sql_compare_text('?', 255) . "
2421                    AND courseid = ?
2422                    AND repeatid = ?
2423                    AND modulename = ?
2424                    AND timestart = ?
2425                    AND timeduration = ?
2426                    AND " . $DB->sql_compare_text('description', 255) . " = " . $DB->sql_compare_text('?', 255);
2427         $arg = array ($params['name'], $params['courseid'], $params['repeatid'], $params['modulename'], $params['timestart'], $params['timeduration'], $params['description']);
2428         $result = $DB->record_exists_sql($sql, $arg);
2429         if (empty($result)) {
2430             $newitemid = $DB->insert_record('event', $params);
2431             $this->set_mapping('event', $oldid, $newitemid);
2432             $this->set_mapping('event_description', $oldid, $newitemid, $restorefiles);
2433         }
2435     }
2436     protected function after_execute() {
2437         // Add related files
2438         $this->add_related_files('calendar', 'event_description', 'event_description');
2439     }
2442 class restore_course_completion_structure_step extends restore_structure_step {
2444     /**
2445      * Conditionally decide if this step should be executed.
2446      *
2447      * This function checks parameters that are not immediate settings to ensure
2448      * that the enviroment is suitable for the restore of course completion info.
2449      *
2450      * This function checks the following four parameters:
2451      *
2452      *   1. Course completion is enabled on the site
2453      *   2. The backup includes course completion information
2454      *   3. All modules are restorable
2455      *   4. All modules are marked for restore.
2456      *   5. No completion criteria already exist for the course.
2457      *
2458      * @return bool True is safe to execute, false otherwise
2459      */
2460     protected function execute_condition() {
2461         global $CFG, $DB;
2463         // First check course completion is enabled on this site
2464         if (empty($CFG->enablecompletion)) {
2465             // Disabled, don't restore course completion
2466             return false;
2467         }
2469         // No course completion on the front page.
2470         if ($this->get_courseid() == SITEID) {
2471             return false;
2472         }
2474         // Check it is included in the backup
2475         $fullpath = $this->task->get_taskbasepath();
2476         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2477         if (!file_exists($fullpath)) {
2478             // Not found, can't restore course completion
2479             return false;
2480         }
2482         // Check we are able to restore all backed up modules
2483         if ($this->task->is_missing_modules()) {
2484             return false;
2485         }
2487         // Check all modules within the backup are being restored.
2488         if ($this->task->is_excluding_activities()) {
2489             return false;
2490         }
2492         // Check that no completion criteria is already set for the course.
2493         if ($DB->record_exists('course_completion_criteria', array('course' => $this->get_courseid()))) {
2494             return false;
2495         }
2497         return true;
2498     }
2500     /**
2501      * Define the course completion structure
2502      *
2503      * @return array Array of restore_path_element
2504      */
2505     protected function define_structure() {
2507         // To know if we are including user completion info
2508         $userinfo = $this->get_setting_value('userscompletion');
2510         $paths = array();
2511         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
2512         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
2514         if ($userinfo) {
2515             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
2516             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
2517         }
2519         return $paths;
2521     }
2523     /**
2524      * Process course completion criteria
2525      *
2526      * @global moodle_database $DB
2527      * @param stdClass $data
2528      */
2529     public function process_course_completion_criteria($data) {
2530         global $DB;
2532         $data = (object)$data;
2533         $data->course = $this->get_courseid();
2535         // Apply the date offset to the time end field
2536         $data->timeend = $this->apply_date_offset($data->timeend);
2538         // Map the role from the criteria
2539         if (isset($data->role) && $data->role != '') {
2540             // Newer backups should include roleshortname, which makes this much easier.
2541             if (!empty($data->roleshortname)) {
2542                 $roleinstanceid = $DB->get_field('role', 'id', array('shortname' => $data->roleshortname));
2543                 if (!$roleinstanceid) {
2544                     $this->log(
2545                         'Could not match the role shortname in course_completion_criteria, so skipping',
2546                         backup::LOG_DEBUG
2547                     );
2548                     return;
2549                 }
2550                 $data->role = $roleinstanceid;
2551             } else {
2552                 $data->role = $this->get_mappingid('role', $data->role);
2553             }
2555             // Check we have an id, otherwise it causes all sorts of bugs.
2556             if (!$data->role) {
2557                 $this->log(
2558                     'Could not match role in course_completion_criteria, so skipping',
2559                     backup::LOG_DEBUG
2560                 );
2561                 return;
2562             }
2563         }
2565         // If the completion criteria is for a module we need to map the module instance
2566         // to the new module id.
2567         if (!empty($data->moduleinstance) && !empty($data->module)) {
2568             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
2569             if (empty($data->moduleinstance)) {
2570                 $this->log(
2571                     'Could not match the module instance in course_completion_criteria, so skipping',
2572                     backup::LOG_DEBUG
2573                 );
2574                 return;
2575             }
2576         } else {
2577             $data->module = null;
2578             $data->moduleinstance = null;
2579         }
2581         // We backup the course shortname rather than the ID so that we can match back to the course
2582         if (!empty($data->courseinstanceshortname)) {
2583             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
2584             if (!$courseinstanceid) {
2585                 $this->log(
2586                     'Could not match the course instance in course_completion_criteria, so skipping',
2587                     backup::LOG_DEBUG
2588                 );
2589                 return;
2590             }
2591         } else {
2592             $courseinstanceid = null;
2593         }
2594         $data->courseinstance = $courseinstanceid;
2596         $params = array(
2597             'course'         => $data->course,
2598             'criteriatype'   => $data->criteriatype,
2599             'enrolperiod'    => $data->enrolperiod,
2600             'courseinstance' => $data->courseinstance,
2601             'module'         => $data->module,
2602             'moduleinstance' => $data->moduleinstance,
2603             'timeend'        => $data->timeend,
2604             'gradepass'      => $data->gradepass,
2605             'role'           => $data->role
2606         );
2607         $newid = $DB->insert_record('course_completion_criteria', $params);
2608         $this->set_mapping('course_completion_criteria', $data->id, $newid);
2609     }
2611     /**
2612      * Processes course compltion criteria complete records
2613      *
2614      * @global moodle_database $DB
2615      * @param stdClass $data
2616      */
2617     public function process_course_completion_crit_compl($data) {
2618         global $DB;
2620         $data = (object)$data;
2622         // This may be empty if criteria could not be restored
2623         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
2625         $data->course = $this->get_courseid();
2626         $data->userid = $this->get_mappingid('user', $data->userid);
2628         if (!empty($data->criteriaid) && !empty($data->userid)) {
2629             $params = array(
2630                 'userid' => $data->userid,
2631                 'course' => $data->course,
2632                 'criteriaid' => $data->criteriaid,
2633                 'timecompleted' => $this->apply_date_offset($data->timecompleted)
2634             );
2635             if (isset($data->gradefinal)) {
2636                 $params['gradefinal'] = $data->gradefinal;
2637             }
2638             if (isset($data->unenroled)) {
2639                 $params['unenroled'] = $data->unenroled;
2640             }
2641             $DB->insert_record('course_completion_crit_compl', $params);
2642         }
2643     }
2645     /**
2646      * Process course completions
2647      *
2648      * @global moodle_database $DB
2649      * @param stdClass $data
2650      */
2651     public function process_course_completions($data) {
2652         global $DB;
2654         $data = (object)$data;
2656         $data->course = $this->get_courseid();
2657         $data->userid = $this->get_mappingid('user', $data->userid);
2659         if (!empty($data->userid)) {
2660             $params = array(
2661                 'userid' => $data->userid,
2662                 'course' => $data->course,
2663                 'timeenrolled' => $this->apply_date_offset($data->timeenrolled),
2664                 'timestarted' => $this->apply_date_offset($data->timestarted),
2665                 'timecompleted' => $this->apply_date_offset($data->timecompleted),
2666                 'reaggregate' => $data->reaggregate
2667             );
2669             $existing = $DB->get_record('course_completions', array(
2670                 'userid' => $data->userid,
2671                 'course' => $data->course
2672             ));
2674             // MDL-46651 - If cron writes out a new record before we get to it
2675             // then we should replace it with the Truth data from the backup.
2676             // This may be obsolete after MDL-48518 is resolved
2677             if ($existing) {
2678                 $params['id'] = $existing->id;
2679                 $DB->update_record('course_completions', $params);
2680             } else {
2681                 $DB->insert_record('course_completions', $params);
2682             }
2683         }
2684     }
2686     /**
2687      * Process course completion aggregate methods
2688      *
2689      * @global moodle_database $DB
2690      * @param stdClass $data
2691      */
2692     public function process_course_completion_aggr_methd($data) {
2693         global $DB;
2695         $data = (object)$data;
2697         $data->course = $this->get_courseid();
2699         // Only create the course_completion_aggr_methd records if
2700         // the target course has not them defined. MDL-28180
2701         if (!$DB->record_exists('course_completion_aggr_methd', array(
2702                     'course' => $data->course,
2703                     'criteriatype' => $data->criteriatype))) {
2704             $params = array(
2705                 'course' => $data->course,
2706                 'criteriatype' => $data->criteriatype,
2707                 'method' => $data->method,
2708                 'value' => $data->value,
2709             );
2710             $DB->insert_record('course_completion_aggr_methd', $params);
2711         }
2712     }
2716 /**
2717  * This structure step restores course logs (cmid = 0), delegating
2718  * the hard work to the corresponding {@link restore_logs_processor} passing the
2719  * collection of {@link restore_log_rule} rules to be observed as they are defined
2720  * by the task. Note this is only executed based in the 'logs' setting.
2721  *
2722  * NOTE: This is executed by final task, to have all the activities already restored
2723  *
2724  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
2725  * records are. There are others like 'calendar' and 'upload' that will be handled
2726  * later.
2727  *
2728  * NOTE: All the missing actions (not able to be restored) are sent to logs for
2729  * debugging purposes
2730  */
2731 class restore_course_logs_structure_step extends restore_structure_step {
2733     /**
2734      * Conditionally decide if this step should be executed.
2735      *
2736      * This function checks the following parameter:
2737      *
2738      *   1. the course/logs.xml file exists
2739      *
2740      * @return bool true is safe to execute, false otherwise
2741      */
2742     protected function execute_condition() {
2744         // Check it is included in the backup
2745         $fullpath = $this->task->get_taskbasepath();
2746         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2747         if (!file_exists($fullpath)) {
2748             // Not found, can't restore course logs
2749             return false;
2750         }
2752         return true;
2753     }
2755     protected function define_structure() {
2757         $paths = array();
2759         // Simple, one plain level of information contains them
2760         $paths[] = new restore_path_element('log', '/logs/log');
2762         return $paths;
2763     }
2765     protected function process_log($data) {
2766         global $DB;
2768         $data = (object)($data);
2770         $data->time = $this->apply_date_offset($data->time);
2771         $data->userid = $this->get_mappingid('user', $data->userid);
2772         $data->course = $this->get_courseid();
2773         $data->cmid = 0;
2775         // For any reason user wasn't remapped ok, stop processing this
2776         if (empty($data->userid)) {
2777             return;
2778         }
2780         // Everything ready, let's delegate to the restore_logs_processor
2782         // Set some fixed values that will save tons of DB requests
2783         $values = array(
2784             'course' => $this->get_courseid());
2785         // Get instance and process log record
2786         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2788         // If we have data, insert it, else something went wrong in the restore_logs_processor
2789         if ($data) {
2790             if (empty($data->url)) {
2791                 $data->url = '';
2792             }
2793             if (empty($data->info)) {
2794                 $data->info = '';
2795             }
2796             // Store the data in the legacy log table if we are still using it.
2797             $manager = get_log_manager();
2798             if (method_exists($manager, 'legacy_add_to_log')) {
2799                 $manager->legacy_add_to_log($data->course, $data->module, $data->action, $data->url,
2800                     $data->info, $data->cmid, $data->userid, $data->ip, $data->time);
2801             }
2802         }
2803     }
2806 /**
2807  * This structure step restores activity logs, extending {@link restore_course_logs_structure_step}
2808  * sharing its same structure but modifying the way records are handled
2809  */
2810 class restore_activity_logs_structure_step extends restore_course_logs_structure_step {
2812     protected function process_log($data) {
2813         global $DB;
2815         $data = (object)($data);
2817         $data->time = $this->apply_date_offset($data->time);
2818         $data->userid = $this->get_mappingid('user', $data->userid);
2819         $data->course = $this->get_courseid();
2820         $data->cmid = $this->task->get_moduleid();
2822         // For any reason user wasn't remapped ok, stop processing this
2823         if (empty($data->userid)) {
2824             return;
2825         }
2827         // Everything ready, let's delegate to the restore_logs_processor
2829         // Set some fixed values that will save tons of DB requests
2830         $values = array(
2831             'course' => $this->get_courseid(),
2832             'course_module' => $this->task->get_moduleid(),
2833             $this->task->get_modulename() => $this->task->get_activityid());
2834         // Get instance and process log record
2835         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2837         // If we have data, insert it, else something went wrong in the restore_logs_processor
2838         if ($data) {
2839             if (empty($data->url)) {
2840                 $data->url = '';
2841             }
2842             if (empty($data->info)) {
2843                 $data->info = '';
2844             }
2845             // Store the data in the legacy log table if we are still using it.
2846             $manager = get_log_manager();
2847             if (method_exists($manager, 'legacy_add_to_log')) {
2848                 $manager->legacy_add_to_log($data->course, $data->module, $data->action, $data->url,
2849                     $data->info, $data->cmid, $data->userid, $data->ip, $data->time);
2850             }
2851         }
2852     }
2856 /**
2857  * Defines the restore step for advanced grading methods attached to the activity module
2858  */
2859 class restore_activity_grading_structure_step extends restore_structure_step {
2861     /**
2862      * This step is executed only if the grading file is present
2863      */
2864      protected function execute_condition() {
2866         if ($this->get_courseid() == SITEID) {
2867             return false;
2868         }
2870         $fullpath = $this->task->get_taskbasepath();
2871         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2872         if (!file_exists($fullpath)) {
2873             return false;
2874         }
2876         return true;
2877     }
2880     /**
2881      * Declares paths in the grading.xml file we are interested in
2882      */
2883     protected function define_structure() {
2885         $paths = array();
2886         $userinfo = $this->get_setting_value('userinfo');
2888         $area = new restore_path_element('grading_area', '/areas/area');
2889         $paths[] = $area;
2890         // attach local plugin stucture to $area element
2891         $this->add_plugin_structure('local', $area);
2893         $definition = new restore_path_element('grading_definition', '/areas/area/definitions/definition');
2894         $paths[] = $definition;
2895         $this->add_plugin_structure('gradingform', $definition);
2896         // attach local plugin stucture to $definition element
2897         $this->add_plugin_structure('local', $definition);
2900         if ($userinfo) {
2901             $instance = new restore_path_element('grading_instance',
2902                 '/areas/area/definitions/definition/instances/instance');
2903             $paths[] = $instance;
2904             $this->add_plugin_structure('gradingform', $instance);
2905             // attach local plugin stucture to $intance element
2906             $this->add_plugin_structure('local', $instance);
2907         }
2909         return $paths;
2910     }
2912     /**
2913      * Processes one grading area element
2914      *
2915      * @param array $data element data
2916      */
2917     protected function process_grading_area($data) {
2918         global $DB;
2920         $task = $this->get_task();
2921         $data = (object)$data;
2922         $oldid = $data->id;
2923         $data->component = 'mod_'.$task->get_modulename();
2924         $data->contextid = $task->get_contextid();
2926         $newid = $DB->insert_record('grading_areas', $data);
2927         $this->set_mapping('grading_area', $oldid, $newid);
2928     }
2930     /**
2931      * Processes one grading definition element
2932      *
2933      * @param array $data element data
2934      */
2935     protected function process_grading_definition($data) {
2936         global $DB;
2938         $task = $this->get_task();
2939         $data = (object)$data;
2940         $oldid = $data->id;
2941         $data->areaid = $this->get_new_parentid('grading_area');
2942         $data->copiedfromid = null;
2943         $data->timecreated = time();
2944         $data->usercreated = $task->get_userid();
2945         $data->timemodified = $data->timecreated;
2946         $data->usermodified = $data->usercreated;
2948         $newid = $DB->insert_record('grading_definitions', $data);
2949         $this->set_mapping('grading_definition', $oldid, $newid, true);
2950     }
2952     /**
2953      * Processes one grading form instance element
2954      *
2955      * @param array $data element data
2956      */
2957     protected function process_grading_instance($data) {
2958         global $DB;
2960         $data = (object)$data;
2962         // new form definition id
2963         $newformid = $this->get_new_parentid('grading_definition');
2965         // get the name of the area we are restoring to
2966         $sql = "SELECT ga.areaname
2967                   FROM {grading_definitions} gd
2968                   JOIN {grading_areas} ga ON gd.areaid = ga.id
2969                  WHERE gd.id = ?";
2970         $areaname = $DB->get_field_sql($sql, array($newformid), MUST_EXIST);
2972         // get the mapped itemid - the activity module is expected to define the mappings
2973         // for each gradable area
2974         $newitemid = $this->get_mappingid(restore_gradingform_plugin::itemid_mapping($areaname), $data->itemid);
2976         $oldid = $data->id;
2977         $data->definitionid = $newformid;
2978         $data->raterid = $this->get_mappingid('user', $data->raterid);
2979         $data->itemid = $newitemid;
2981         $newid = $DB->insert_record('grading_instances', $data);
2982         $this->set_mapping('grading_instance', $oldid, $newid);
2983     }
2985     /**
2986      * Final operations when the database records are inserted
2987      */
2988     protected function after_execute() {
2989         // Add files embedded into the definition description
2990         $this->add_related_files('grading', 'description', 'grading_definition');
2991     }
2995 /**
2996  * This structure step restores the grade items associated with one activity
2997  * All the grade items are made child of the "course" grade item but the original
2998  * categoryid is saved as parentitemid in the backup_ids table, so, when restoring
2999  * the complete gradebook (categories and calculations), that information is
3000  * available there
3001  */
3002 class restore_activity_grades_structure_step extends restore_structure_step {
3004     /**
3005      * No grades in front page.
3006      * @return bool
3007      */
3008     protected function execute_condition() {
3009         return ($this->get_courseid() != SITEID);
3010     }
3012     protected function define_structure() {
3014         $paths = array();
3015         $userinfo = $this->get_setting_value('userinfo');
3017         $paths[] = new restore_path_element('grade_item', '/activity_gradebook/grade_items/grade_item');
3018         $paths[] = new restore_path_element('grade_letter', '/activity_gradebook/grade_letters/grade_letter');
3019         if ($userinfo) {
3020             $paths[] = new restore_path_element('grade_grade',
3021                            '/activity_gradebook/grade_items/grade_item/grade_grades/grade_grade');
3022         }
3023         return $paths;
3024     }
3026     protected function process_grade_item($data) {
3027         global $DB;
3029         $data = (object)($data);
3030         $oldid       = $data->id;        // We'll need these later
3031         $oldparentid = $data->categoryid;
3032         $courseid = $this->get_courseid();
3034         // make sure top course category exists, all grade items will be associated
3035         // to it. Later, if restoring the whole gradebook, categories will be introduced
3036         $coursecat = grade_category::fetch_course_category($courseid);
3037         $coursecatid = $coursecat->id; // Get the categoryid to be used
3039         $idnumber = null;
3040         if (!empty($data->idnumber)) {
3041             // Don't get any idnumber from course module. Keep them as they are in grade_item->idnumber
3042             // Reason: it's not clear what happens with outcomes->idnumber or activities with multiple items (workshop)
3043             // so the best is to keep the ones already in the gradebook
3044             // Potential problem: duplicates if same items are restored more than once. :-(
3045             // This needs to be fixed in some way (outcomes & activities with multiple items)
3046             // $data->idnumber     = get_coursemodule_from_instance($data->itemmodule, $data->iteminstance)->idnumber;
3047             // In any case, verify always for uniqueness
3048             $sql = "SELECT cm.id
3049                       FROM {course_modules} cm
3050                      WHERE cm.course = :courseid AND
3051                            cm.idnumber = :idnumber AND
3052                            cm.id <> :cmid";
3053             $params = array(
3054                 'courseid' => $courseid,
3055                 'idnumber' => $data->idnumber,
3056                 'cmid' => $this->task->get_moduleid()
3057             );
3058             if (!$DB->record_exists_sql($sql, $params) && !$DB->record_exists('grade_items', array('courseid' => $courseid, 'idnumber' => $data->idnumber))) {
3059                 $idnumber = $data->idnumber;
3060             }
3061         }
3063         unset($data->id);
3064         $data->categoryid   = $coursecatid;
3065         $data->courseid     = $this->get_courseid();
3066         $data->iteminstance = $this->task->get_activityid();
3067         $data->idnumber     = $idnumber;
3068         $data->scaleid      = $this->get_mappingid('scale', $data->scaleid);
3069         $data->outcomeid    = $this->get_mappingid('outcome', $data->outcomeid);
3070         $data->timecreated  = $this->apply_date_offset($data->timecreated);
3071         $data->timemodified = $this->apply_date_offset($data->timemodified);
3073         $gradeitem = new grade_item($data, false);
3074         $gradeitem->insert('restore');
3076         //sortorder is automatically assigned when inserting. Re-instate the previous sortorder
3077         $gradeitem->sortorder = $data->sortorder;
3078         $gradeitem->update('restore');
3080         // Set mapping, saving the original category id into parentitemid
3081         // gradebook restore (final task) will need it to reorganise items
3082         $this->set_mapping('grade_item', $oldid, $gradeitem->id, false, null, $oldparentid);
3083     }
3085     protected function process_grade_grade($data) {
3086         $data = (object)($data);
3087         $olduserid = $data->userid;
3088         $oldid = $data->id;
3089         unset($data->id);
3091         $data->itemid = $this->get_new_parentid('grade_item');
3093         $data->userid = $this->get_mappingid('user', $data->userid, null);
3094         if (!empty($data->userid)) {
3095             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
3096             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
3097             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
3098             $data->overridden = $this->apply_date_offset($data->overridden);
3100             $grade = new grade_grade($data, false);
3101             $grade->insert('restore');
3102             $this->set_mapping('grade_grades', $oldid, $grade->id);
3103         } else {
3104             debugging("Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'");
3105         }
3106     }
3108     /**
3109      * process activity grade_letters. Note that, while these are possible,
3110      * because grade_letters are contextid based, in practice, only course
3111      * context letters can be defined. So we keep here this method knowing
3112      * it won't be executed ever. gradebook restore will restore course letters.
3113      */
3114     protected function process_grade_letter($data) {
3115         global $DB;
3117         $data['contextid'] = $this->task->get_contextid();
3118         $gradeletter = (object)$data;
3120         // Check if it exists before adding it
3121         unset($data['id']);
3122         if (!$DB->record_exists('grade_letters', $data)) {
3123             $newitemid = $DB->insert_record('grade_letters', $gradeletter);
3124         }
3125         // no need to save any grade_letter mapping
3126     }
3128     public function after_restore() {
3129         // Fix grade item's sortorder after restore, as it might have duplicates.
3130         $courseid = $this->get_task()->get_courseid();
3131         grade_item::fix_duplicate_sortorder($courseid);
3132     }
3135 /**
3136  * Step in charge of restoring the grade history of an activity.
3137  *
3138  * This step is added to the task regardless of the setting 'grade_histories'.
3139  * The reason is to allow for a more flexible step in case the logic needs to be
3140  * split accross different settings to control the history of items and/or grades.
3141  */
3142 class restore_activity_grade_history_structure_step extends restore_structure_step {
3144     /**
3145      * This step is executed only if the grade history file is present.
3146      */
3147      protected function execute_condition() {
3149         if ($this->get_courseid() == SITEID) {
3150             return false;
3151         }
3153         $fullpath = $this->task->get_taskbasepath();
3154         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
3155         if (!file_exists($fullpath)) {
3156             return false;
3157         }
3158         return true;
3159     }
3161     protected function define_structure() {
3162         $paths = array();
3164         // Settings to use.
3165         $userinfo = $this->get_setting_value('userinfo');
3166         $history = $this->get_setting_value('grade_histories');
3168         if ($userinfo && $history) {
3169             $paths[] = new restore_path_element('grade_grade',
3170                '/grade_history/grade_grades/grade_grade');
3171         }
3173         return $paths;
3174     }
3176     protected function process_grade_grade($data) {
3177         global $DB;
3179         $data = (object) $data;
3180         $olduserid = $data->userid;
3181         unset($data->id);
3183         $data->userid = $this->get_mappingid('user', $data->userid, null);
3184         if (!empty($data->userid)) {
3185             // Do not apply the date offsets as this is history.
3186             $data->itemid = $this->get_mappingid('grade_item', $data->itemid);
3187             $data->oldid = $this->get_mappingid('grade_grades', $data->oldid);
3188             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
3189             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
3190             $DB->insert_record('grade_grades_history', $data);
3191         } else {
3192             $message = "Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'";
3193             $this->log($message, backup::LOG_DEBUG);
3194         }
3195     }
3199 /**
3200  * This structure steps restores one instance + positions of one block
3201  * Note: Positions corresponding to one existing context are restored
3202  * here, but all the ones having unknown contexts are sent to backup_ids
3203  * for a later chance to be restored at the end (final task)
3204  */
3205 class restore_block_instance_structure_step extends restore_structure_step {
3207     protected function define_structure() {
3209         $paths = array();
3211         $paths[] = new restore_path_element('block', '/block', true); // Get the whole XML together
3212         $paths[] = new restore_path_element('block_position', '/block/block_positions/block_position');
3214         return $paths;
3215     }
3217     public function process_block($data) {
3218         global $DB, $CFG;
3220         $data = (object)$data; // Handy
3221         $oldcontextid = $data->contextid;
3222         $oldid        = $data->id;
3223         $positions = isset($data->block_positions['block_position']) ? $data->block_positions['block_position'] : array();
3225         // Look for the parent contextid
3226         if (!$data->parentcontextid = $this->get_mappingid('context', $data->parentcontextid)) {
3227             throw new restore_step_exception('restore_block_missing_parent_ctx', $data->parentcontextid);
3228         }
3230         // TODO: it would be nice to use standard plugin supports instead of this instance_allow_multiple()
3231         // If there is already one block of that type in the parent context
3232         // and the block is not multiple, stop processing
3233         // Use blockslib loader / method executor
3234         if (!$bi = block_instance($data->blockname)) {
3235             return false;
3236         }
3238         if (!$bi->instance_allow_multiple()) {
3239             // The block cannot be added twice, so we will check if the same block is already being
3240             // displayed on the same page. For this, rather than mocking a page and using the block_manager
3241             // we use a similar query to the one in block_manager::load_blocks(), this will give us
3242             // a very good idea of the blocks already displayed in the context.
3243             $params =  array(
3244                 'blockname' => $data->blockname
3245             );
3247             // Context matching test.
3248             $context = context::instance_by_id($data->parentcontextid);
3249             $contextsql = 'bi.parentcontextid = :contextid';
3250             $params['contextid'] = $context->id;
3252             $parentcontextids = $context->get_parent_context_ids();
3253             if ($parentcontextids) {
3254                 list($parentcontextsql, $parentcontextparams) =
3255                         $DB->get_in_or_equal($parentcontextids, SQL_PARAMS_NAMED);
3256                 $contextsql = "($contextsql OR (bi.showinsubcontexts = 1 AND bi.parentcontextid $parentcontextsql))";
3257                 $params = array_merge($params, $parentcontextparams);
3258             }
3260             // Page type pattern test.
3261             $pagetypepatterns = matching_page_type_patterns_from_pattern($data->pagetypepattern);
3262             list($pagetypepatternsql, $pagetypepatternparams) =
3263                 $DB->get_in_or_equal($pagetypepatterns, SQL_PARAMS_NAMED);
3264             $params = array_merge($params, $pagetypepatternparams);
3266             // Sub page pattern test.
3267             $subpagepatternsql = 'bi.subpagepattern IS NULL';
3268             if ($data->subpagepattern !== null) {
3269                 $subpagepatternsql = "($subpagepatternsql OR bi.subpagepattern = :subpagepattern)";
3270                 $params['subpagepattern'] = $data->subpagepattern;
3271             }
3273             $exists = $DB->record_exists_sql("SELECT bi.id
3274                                                 FROM {block_instances} bi
3275                                                 JOIN {block} b ON b.name = bi.blockname
3276                                                WHERE bi.blockname = :blockname
3277                                                  AND $contextsql
3278                                                  AND bi.pagetypepattern $pagetypepatternsql
3279                                                  AND $subpagepatternsql", $params);
3280             if ($exists) {
3281                 // There is at least one very similar block visible on the page where we
3282                 // are trying to restore the block. In these circumstances the block API
3283                 // would not allow the user to add another instance of the block, so we
3284                 // apply the same rule here.
3285                 return false;
3286             }
3287         }
3289         // If there is already one block of that type in the parent context
3290         // with the same showincontexts, pagetypepattern, subpagepattern, defaultregion and configdata
3291         // stop processing
3292         $params = array(
3293             'blockname' => $data->blockname, 'parentcontextid' => $data->parentcontextid,
3294             'showinsubcontexts' => $data->showinsubcontexts, 'pagetypepattern' => $data->pagetypepattern,
3295             'subpagepattern' => $data->subpagepattern, 'defaultregion' => $data->defaultregion);
3296         if ($birecs = $DB->get_records('block_instances', $params)) {
3297             foreach($birecs as $birec) {
3298                 if ($birec->configdata == $data->configdata) {
3299                     return false;
3300                 }
3301             }
3302         }
3304         // Set task old contextid, blockid and blockname once we know them
3305         $this->task->set_old_contextid($oldcontextid);
3306         $this->task->set_old_blockid($oldid);
3307         $this->task->set_blockname($data->blockname);
3309         // Let's look for anything within configdata neededing processing
3310         // (nulls and uses of legacy file.php)
3311         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
3312             $configdata = (array)unserialize(base64_decode($data->configdata));
3313             foreach ($configdata as $attribute => $value) {
3314                 if (in_array($attribute, $attrstotransform)) {
3315                     $configdata[$attribute] = $this->contentprocessor->process_cdata($value);
3316                 }
3317             }
3318             $data->configdata = base64_encode(serialize((object)$configdata));
3319         }
3321         // Create the block instance
3322         $newitemid = $DB->insert_record('block_instances', $data);
3323         // Save the mapping (with restorefiles support)
3324         $this->set_mapping('block_instance', $oldid, $newitemid, true);
3325         // Create the block context
3326         $newcontextid = context_block::instance($newitemid)->id;
3327         // Save the block contexts mapping and sent it to task
3328         $this->set_mapping('context', $oldcontextid, $newcontextid);
3329         $this->task->set_contextid($newcontextid);
3330         $this->task->set_blockid($newitemid);
3332         // Restore block fileareas if declared
3333         $component = 'block_' . $this->task->get_blockname();
3334         foreach ($this->task->get_fileareas() as $filearea) { // Simple match by contextid. No itemname needed
3335             $this->add_related_files($component, $filearea, null);
3336         }
3338         // Process block positions, creating them or accumulating for final step
3339         foreach($positions as $position) {
3340             $position = (object)$position;
3341             $position->blockinstanceid = $newitemid; // The instance is always the restored one
3342             // If position is for one already mapped (known) contextid
3343             // process it now, creating the position
3344             if ($newpositionctxid = $this->get_mappingid('context', $position->contextid)) {
3345                 $position->contextid = $newpositionctxid;
3346                 // Create the block position
3347                 $DB->insert_record('block_positions', $position);
3349             // The position belongs to an unknown context, send it to backup_ids
3350             // to process them as part of the final steps of restore. We send the
3351             // whole $position object there, hence use the low level method.
3352             } else {
3353                 restore_dbops::set_backup_ids_record($this->get_restoreid(), 'block_position', $position->id, 0, null, $position);
3354             }
3355         }
3356     }
3359 /**
3360  * Structure step to restore common course_module information
3361  *
3362  * This step will process the module.xml file for one activity, in order to restore
3363  * the corresponding information to the course_modules table, skipping various bits
3364  * of information based on CFG settings (groupings, completion...) in order to fullfill
3365  * all the reqs to be able to create the context to be used by all the rest of steps
3366  * in the activity restore task
3367  */
3368 class restore_module_structure_step extends restore_structure_step {
3370     protected function define_structure() {
3371         global $CFG;
3373         $paths = array();
3375         $module = new restore_path_element('module', '/module');
3376         $paths[] = $module;
3377         if ($CFG->enableavailability) {
3378             $paths[] = new restore_path_element('availability', '/module/availability_info/availability');
3379             $paths[] = new restore_path_element('availability_field', '/module/availability_info/availability_field');
3380         }
3382         // Apply for 'format' plugins optional paths at module level
3383         $this->add_plugin_structure('format', $module);
3385         // Apply for 'plagiarism' plugins optional paths at module level
3386         $this->add_plugin_structure('plagiarism', $module);
3388         // Apply for 'local' plugins optional paths at module level
3389         $this->add_plugin_structure('local', $module);
3391         return $paths;
3392     }
3394     protected function process_module($data) {
3395         global $CFG, $DB;
3397         $data = (object)$data;
3398         $oldid = $data->id;
3399         $this->task->set_old_moduleversion($data->version);
3401         $data->course = $this->task->get_courseid();
3402         $data->module = $DB->get_field('modules', 'id', array('name' => $data->modulename));
3403         // Map section (first try by course_section mapping match. Useful in course and section restores)
3404         $data->section = $this->get_mappingid('course_section', $data->sectionid);
3405         if (!$data->section) { // mapping failed, try to get section by sectionnumber matching
3406             $params = array(
3407                 'course' => $this->get_courseid(),
3408                 'section' => $data->sectionnumber);
3409             $data->section = $DB->get_field('course_sections', 'id', $params);
3410         }
3411         if (!$data->section) { // sectionnumber failed, try to get first section in course
3412             $params = array(
3413                 'course' => $this->get_courseid());
3414             $data->section = $DB->get_field('course_sections', 'MIN(id)', $params);
3415         }
3416         if (!$data->section) { // no sections in course, create section 0 and 1 and assign module to 1
3417             $sectionrec = array(
3418                 'course' => $this->get_courseid(),
3419                 'section' => 0);
3420             $DB->insert_record('course_sections', $sectionrec); // section 0
3421             $sectionrec = array(
3422                 'course' => $this->get_courseid(),
3423                 'section' => 1);
3424             $data->section = $DB->insert_record('course_sections', $sectionrec); // section 1
3425         }
3426         $data->groupingid= $this->get_mappingid('grouping', $data->groupingid);      // grouping
3427         if (!grade_verify_idnumber($data->idnumber, $this->get_courseid())) {        // idnumber uniqueness
3428             $data->idnumber = '';
3429         }
3430         if (empty($CFG->enablecompletion)) { // completion
3431             $data->completion = 0;
3432             $data->completiongradeitemnumber = null;
3433             $data->completionview = 0;
3434             $data->completionexpected = 0;
3435         } else {
3436             $data->completionexpected = $this->apply_date_offset($data->completionexpected);
3437         }
3438         if (empty($CFG->enableavailability)) {
3439             $data->availability = null;
3440         }
3441         // Backups that did not include showdescription, set it to default 0
3442         // (this is not totally necessary as it has a db default, but just to
3443         // be explicit).
3444         if (!isset($data->showdescription)) {
3445             $data->showdescription = 0;
3446         }
3447         $data->instance = 0; // Set to 0 for now, going to create it soon (next step)
3449         if (empty($data->availability)) {
3450             // If there are legacy availablility data fields (and no new format data),
3451             // convert the old fields.
3452             $data->availability = \core_availability\info::convert_legacy_fields(
3453                     $data, false);
3454         } else if (!empty($data->groupmembersonly)) {
3455             // There is current availability data, but it still has groupmembersonly
3456             // as well (2.7 backups), convert just that part.
3457             require_once($CFG->dirroot . '/lib/db/upgradelib.php');
3458             $data->availability = upgrade_group_members_only($data->groupingid, $data->availability);
3459         }
3461         // course_module record ready, insert it
3462         $newitemid = $DB->insert_record('course_modules', $data);
3463         // save mapping
3464         $this->set_mapping('course_module', $oldid, $newitemid);
3465         // set the new course_module id in the task
3466         $this->task->set_moduleid($newitemid);
3467         // we can now create the context safely
3468         $ctxid = context_module::instance($newitemid)->id;
3469         // set the new context id in the task
3470         $this->task->set_contextid($ctxid);
3471         // update sequence field in course_section
3472         if ($sequence = $DB->get_field('course_sections', 'sequence', array('id' => $data->section))) {
3473             $sequence .= ',' . $newitemid;
3474         } else {
3475             $sequence = $newitemid;
3476         }
3477         $DB->set_field('course_sections', 'sequence', $sequence, array('id' => $data->section));
3479         // If there is the legacy showavailability data, store this for later use.
3480         // (This data is not present when restoring 'new' backups.)
3481         if (isset($data->showavailability)) {
3482             // Cache the showavailability flag using the backup_ids data field.
3483             restore_dbops::set_backup_ids_record($this->get_restoreid(),
3484                     'module_showavailability', $newitemid, 0, null,
3485                     (object)array('showavailability' => $data->showavailability));
3486         }
3487     }
3489     /**
3490      * Process the legacy availability table record. This table does not exist
3491      * in Moodle 2.7+ but we still support restore.
3492      *
3493      * @param stdClass $data Record data
3494      */
3495     protected function process_availability($data) {
3496         $data = (object)$data;
3497         // Simply going to store the whole availability record now, we'll process
3498         // all them later in the final task (once all activities have been restored)
3499         // Let's call the low level one to be able to store the whole object
3500         $data->coursemoduleid = $this->task->get_moduleid(); // Let add the availability cmid
3501         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'module_availability', $data->id, 0, null, $data);
3502     }
3504     /**
3505      * Process the legacy availability fields table record. This table does not
3506      * exist in Moodle 2.7+ but we still support restore.
3507      *
3508      * @param stdClass $data Record data
3509      */
3510     protected function process_availability_field($data) {
3511         global $DB;
3512         $data = (object)$data;
3513         // Mark it is as passed by default
3514         $passed = true;
3515         $customfieldid = null;
3517         // If a customfield has been used in order to pass we must be able to match an existing
3518         // customfield by name (data->customfield) and type (data->customfieldtype)
3519         if (!empty($data->customfield) xor !empty($data->customfieldtype)) {
3520             // xor is sort of uncommon. If either customfield is null or customfieldtype is null BUT not both.
3521             // If one is null but the other isn't something clearly went wrong and we'll skip this condition.
3522             $passed = false;
3523         } else if (!empty($data->customfield)) {
3524             $params = array('shortname' => $data->customfield, 'datatype' => $data->customfieldtype);
3525             $customfieldid = $DB->get_field('user_info_field', 'id', $params);
3526             $passed = ($customfieldid !== false);
3527         }
3529         if ($passed) {
3530             // Create the object to insert into the database
3531             $availfield = new stdClass();
3532             $availfield->coursemoduleid = $this->task->get_moduleid(); // Lets add the availability cmid
3533             $availfield->userfield = $data->userfield;
3534             $availfield->customfieldid = $customfieldid;
3535             $availfield->operator = $data->operator;
3536             $availfield->value = $data->value;
3538             // Get showavailability option.
3539             $showrec = restore_dbops::get_backup_ids_record($this->get_restoreid(),
3540                     'module_showavailability', $availfield->coursemoduleid);
3541             if (!$showrec) {
3542                 // Should not happen.
3543                 throw new coding_exception('No matching showavailability record');
3544             }
3545             $show = $showrec->info->showavailability;
3547             // The $availfieldobject is now in the format used in the old
3548             // system. Interpret this and convert to new system.
3549             $currentvalue = $DB->get_field('course_modules', 'availability',
3550                     array('id' => $availfield->coursemoduleid), MUST_EXIST);
3551             $newvalue = \core_availability\info::add_legacy_availability_field_condition(
3552                     $currentvalue, $availfield, $show);
3553             $DB->set_field('course_modules', 'availability', $newvalue,
3554                     array('id' => $availfield->coursemoduleid));
3555         }
3556     }
3559 /**
3560  * Structure step that will process the user activity completion
3561  * information if all these conditions are met:
3562  *  - Target site has completion enabled ($CFG->enablecompletion)
3563  *  - Activity includes completion info (file_exists)
3564  */
3565 class restore_userscompletion_structure_step extends restore_structure_step {
3566     /**
3567      * To conditionally decide if this step must be executed
3568      * Note the "settings" conditions are evaluated in the
3569      * corresponding task. Here we check for other conditions
3570      * not being restore settings (files, site settings...)
3571      */
3572      protected function execute_condition() {
3573          global $CFG;
3575          // Completion disabled in this site, don't execute
3576          if (empty($CFG->enablecompletion)) {
3577              return false;
3578          }
3580         // No completion on the front page.
3581         if ($this->get_courseid() == SITEID) {
3582             return false;
3583         }
3585          // No user completion info found, don't execute
3586         $fullpath = $this->task->get_taskbasepath();
3587         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
3588          if (!file_exists($fullpath)) {
3589              return false;
3590          }
3592          // Arrived here, execute the step
3593          return true;
3594      }
3596      protected function define_structure() {
3598         $paths = array();
3600         $paths[] = new restore_path_element('completion', '/completions/completion');
3602         return $paths;
3603     }
3605     protected function process_completion($data) {
3606         global $DB;
3608         $data = (object)$data;
3610         $data->coursemoduleid = $this->task->get_moduleid();
3611         $data->userid = $this->get_mappingid('user', $data->userid);
3612         $data->timemodified = $this->apply_date_offset($data->timemodified);
3614         // Find the existing record
3615         $existing = $DB->get_record('course_modules_completion', array(
3616                 'coursemoduleid' => $data->coursemoduleid,
3617                 'userid' => $data->userid), 'id, timemodified');
3618         // Check we didn't already insert one for this cmid and userid
3619         // (there aren't supposed to be duplicates in that field, but
3620         // it was possible until MDL-28021 was fixed).
3621         if ($existing) {
3622             // Update it to these new values, but only if the time is newer
3623             if ($existing->timemodified < $data->timemodified) {
3624                 $data->id = $existing->id;
3625                 $DB->update_record('course_modules_completion', $data);
3626             }
3627         } else {
3628             // Normal entry where it doesn't exist already
3629             $DB->insert_record('course_modules_completion', $data);
3630         }
3631     }
3634 /**
3635  * Abstract structure step, parent of all the activity structure steps. Used to suuport
3636  * the main <activity ...> tag and process it. Also provides subplugin support for
3637  * activities.
3638  */
3639 abstract class restore_activity_structure_step extends restore_structure_step {
3641     protected function add_subplugin_structure($subplugintype, $element) {
3643         global $CFG;
3645         // Check the requested subplugintype is a valid one
3646         $subpluginsfile = $CFG->dirroot . '/mod/' . $this->task->get_modulename() . '/db/subplugins.php';
3647         if (!file_exists($subpluginsfile)) {
3648              throw new restore_step_exception('activity_missing_subplugins_php_file', $this->task->get_modulename());
3649         }
3650         include($subpluginsfile);
3651         if (!array_key_exists($subplugintype, $subplugins)) {
3652              throw new restore_step_exception('incorrect_subplugin_type', $subplugintype);
3653         }
3654         // Get all the restore path elements, looking across all the subplugin dirs
3655         $subpluginsdirs = core_component::get_plugin_list($subplugintype);
3656         foreach ($subpluginsdirs as $name => $subpluginsdir) {
3657             $classname = 'restore_' . $subplugintype . '_' . $name . '_subplugin';
3658             $restorefile = $subpluginsdir . '/backup/moodle2/' . $classname . '.class.php';
3659             if (file_exists($restorefile)) {
3660                 require_once($restorefile);
3661                 $restoresubplugin = new $classname($subplugintype, $name, $this);
3662                 // Add subplugin paths to the step
3663                 $this->prepare_pathelements($restoresubplugin->define_subplugin_structure($element));
3664             }
3665         }
3666     }
3668     /**
3669      * As far as activity restore steps are implementing restore_subplugin stuff, they need to
3670      * have the parent task available for wrapping purposes (get course/context....)
3671      * @return restore_task
3672      */
3673     public function get_task() {
3674         return $this->task;
3675     }
3677     /**
3678      * Adds support for the 'activity' path that is common to all the activities
3679      * and will be processed globally here
3680      */
3681     protected function prepare_activity_structure($paths) {
3683         $paths[] = new restore_path_element('activity', '/activity');
3685         return $paths;
3686     }
3688     /**
3689      * Process the activity path, informing the task about various ids, needed later
3690      */
3691     protected function process_activity($data) {
3692         $data = (object)$data;
3693         $this->task->set_old_contextid($data->contextid); // Save old contextid in task
3694         $this->set_mapping('context', $data->contextid, $this->task->get_contextid()); // Set the mapping
3695         $this->task->set_old_activityid($data->id); // Save old activityid in task
3696     }
3698     /**
3699      * This must be invoked immediately after creating the "module" activity record (forum, choice...)
3700      * and will adjust the new activity id (the instance) in various places
3701      */
3702     protected function apply_activity_instance($newitemid) {
3703         global $DB;
3705         $this->task->set_activityid($newitemid); // Save activity id in task
3706         // Apply the id to course_sections->instanceid
3707         $DB->set_field('course_modules', 'instance', $newitemid, array('id' => $this->task->get_moduleid()));
3708         // Do the mapping for modulename, preparing it for files by oldcontext
3709         $modulename = $this->task->get_modulename();
3710         $oldid = $this->task->get_old_activityid();
3711         $this->set_mapping($modulename, $oldid, $newitemid, true);
3712     }
3715 /**
3716  * Structure step in charge of creating/mapping all the qcats and qs
3717  * by parsing the questions.xml file and checking it against the
3718  * results calculated by {@link restore_process_categories_and_questions}
3719  * and stored in backup_ids_temp
3720  */
3721 class restore_create_categories_and_questions extends restore_structure_step {
3723     /** @var array $cachecategory store a question category */
3724     protected $cachedcategory = null;
3726     protected function define_structure() {
3728         $category = new restore_path_element('question_category', '/question_categories/question_category');
3729         $question = new restore_path_element('question', '/question_categories/question_category/questions/question');
3730         $hint = new restore_path_element('question_hint',
3731                 '/question_categories/question_category/questions/question/question_hints/question_hint');
3733         $tag = new restore_path_element('tag','/question_categories/question_category/questions/question/tags/tag');
3735         // Apply for 'qtype' plugins optional paths at question level
3736         $this->add_plugin_structure('qtype', $question);
3738         // Apply for 'local' plugins optional paths at question level
3739         $this->add_plugin_structure('local', $question);
3741         return array($category, $question, $hint, $tag);
3742     }
3744     protected function process_question_category($data) {
3745         global $DB;
3747         $data = (object)$data;
3748         $oldid = $data->id;
3750         // Check we have one mapping for this category
3751         if (!$mapping = $this->get_mapping('question_category', $oldid)) {
3752             return self::SKIP_ALL_CHILDREN; // No mapping = this category doesn't need to be created/mapped
3753         }
3755         // Check we have to create the category (newitemid = 0)
3756         if ($mapping->newitemid) {
3757             return; // newitemid != 0, this category is going to be mapped. Nothing to do
3758         }
3760         // Arrived here, newitemid = 0, we need to create the category
3761         // we'll do it at parentitemid context, but for CONTEXT_MODULE
3762         // categories, that will be created at CONTEXT_COURSE and moved
3763         // to module context later when the activity is created
3764         if ($mapping->info->contextlevel == CONTEXT_MODULE) {
3765           &n