f9f78020ff8f5db848e973091da1c91e4ea873a6
[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         backup_helper::delete_old_backup_dirs(time() - (4 * 60 * 60));              // Delete > 4 hours temp dirs
69         if (empty($CFG->keeptempdirectoriesonbackup)) { // Conditionally
70             backup_helper::delete_backup_dir($this->task->get_tempdir()); // Empty restore dir
71         }
72     }
73 }
75 /**
76  * Restore calculated grade items, grade categories etc
77  */
78 class restore_gradebook_structure_step extends restore_structure_step {
80     /**
81      * To conditionally decide if this step must be executed
82      * Note the "settings" conditions are evaluated in the
83      * corresponding task. Here we check for other conditions
84      * not being restore settings (files, site settings...)
85      */
86      protected function execute_condition() {
87         global $CFG, $DB;
89         // No gradebook info found, don't execute
90         $fullpath = $this->task->get_taskbasepath();
91         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
92         if (!file_exists($fullpath)) {
93             return false;
94         }
96         // Some module present in backup file isn't available to restore
97         // in this site, don't execute
98         if ($this->task->is_missing_modules()) {
99             return false;
100         }
102         // Some activity has been excluded to be restored, don't execute
103         if ($this->task->is_excluding_activities()) {
104             return false;
105         }
107         // There should only be one grade category (the 1 associated with the course itself)
108         // If other categories already exist we're restoring into an existing course.
109         // Restoring categories into a course with an existing category structure is unlikely to go well
110         $category = new stdclass();
111         $category->courseid  = $this->get_courseid();
112         $catcount = $DB->count_records('grade_categories', (array)$category);
113         if ($catcount>1) {
114             return false;
115         }
117         // Arrived here, execute the step
118         return true;
119      }
121     protected function define_structure() {
122         $paths = array();
123         $userinfo = $this->task->get_setting_value('users');
125         $paths[] = new restore_path_element('gradebook', '/gradebook');
126         $paths[] = new restore_path_element('grade_category', '/gradebook/grade_categories/grade_category');
127         $paths[] = new restore_path_element('grade_item', '/gradebook/grade_items/grade_item');
128         if ($userinfo) {
129             $paths[] = new restore_path_element('grade_grade', '/gradebook/grade_items/grade_item/grade_grades/grade_grade');
130         }
131         $paths[] = new restore_path_element('grade_letter', '/gradebook/grade_letters/grade_letter');
132         $paths[] = new restore_path_element('grade_setting', '/gradebook/grade_settings/grade_setting');
134         return $paths;
135     }
137     protected function process_gradebook($data) {
138     }
140     protected function process_grade_item($data) {
141         global $DB;
143         $data = (object)$data;
145         $oldid = $data->id;
146         $data->course = $this->get_courseid();
148         $data->courseid = $this->get_courseid();
150         if ($data->itemtype=='manual') {
151             // manual grade items store category id in categoryid
152             $data->categoryid = $this->get_mappingid('grade_category', $data->categoryid, NULL);
153             // if mapping failed put in course's grade category
154             if (NULL == $data->categoryid) {
155                 $coursecat = grade_category::fetch_course_category($this->get_courseid());
156                 $data->categoryid = $coursecat->id;
157             }
158         } else if ($data->itemtype=='course') {
159             // course grade item stores their category id in iteminstance
160             $coursecat = grade_category::fetch_course_category($this->get_courseid());
161             $data->iteminstance = $coursecat->id;
162         } else if ($data->itemtype=='category') {
163             // category grade items store their category id in iteminstance
164             $data->iteminstance = $this->get_mappingid('grade_category', $data->iteminstance, NULL);
165         } else {
166             throw new restore_step_exception('unexpected_grade_item_type', $data->itemtype);
167         }
169         $data->scaleid   = $this->get_mappingid('scale', $data->scaleid, NULL);
170         $data->outcomeid = $this->get_mappingid('outcome', $data->outcomeid, NULL);
172         $data->locktime     = $this->apply_date_offset($data->locktime);
173         $data->timecreated  = $this->apply_date_offset($data->timecreated);
174         $data->timemodified = $this->apply_date_offset($data->timemodified);
176         $coursecategory = $newitemid = null;
177         //course grade item should already exist so updating instead of inserting
178         if($data->itemtype=='course') {
179             //get the ID of the already created grade item
180             $gi = new stdclass();
181             $gi->courseid  = $this->get_courseid();
182             $gi->itemtype  = $data->itemtype;
184             //need to get the id of the grade_category that was automatically created for the course
185             $category = new stdclass();
186             $category->courseid  = $this->get_courseid();
187             $category->parent  = null;
188             //course category fullname starts out as ? but may be edited
189             //$category->fullname  = '?';
190             $coursecategory = $DB->get_record('grade_categories', (array)$category);
191             $gi->iteminstance = $coursecategory->id;
193             $existinggradeitem = $DB->get_record('grade_items', (array)$gi);
194             if (!empty($existinggradeitem)) {
195                 $data->id = $newitemid = $existinggradeitem->id;
196                 $DB->update_record('grade_items', $data);
197             }
198         } else if ($data->itemtype == 'manual') {
199             // Manual items aren't assigned to a cm, so don't go duplicating them in the target if one exists.
200             $gi = array(
201                 'itemtype' => $data->itemtype,
202                 'courseid' => $data->courseid,
203                 'itemname' => $data->itemname,
204                 'categoryid' => $data->categoryid,
205             );
206             $newitemid = $DB->get_field('grade_items', 'id', $gi);
207         }
209         if (empty($newitemid)) {
210             //in case we found the course category but still need to insert the course grade item
211             if ($data->itemtype=='course' && !empty($coursecategory)) {
212                 $data->iteminstance = $coursecategory->id;
213             }
215             $newitemid = $DB->insert_record('grade_items', $data);
216         }
217         $this->set_mapping('grade_item', $oldid, $newitemid);
218     }
220     protected function process_grade_grade($data) {
221         global $DB;
223         $data = (object)$data;
224         $olduserid = $data->userid;
226         $data->itemid = $this->get_new_parentid('grade_item');
228         $data->userid = $this->get_mappingid('user', $data->userid, null);
229         if (!empty($data->userid)) {
230             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
231             $data->locktime     = $this->apply_date_offset($data->locktime);
232             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
233             $data->overridden = $this->apply_date_offset($data->overridden);
234             $data->timecreated  = $this->apply_date_offset($data->timecreated);
235             $data->timemodified = $this->apply_date_offset($data->timemodified);
237             $newitemid = $DB->insert_record('grade_grades', $data);
238         } else {
239             debugging("Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'");
240         }
241     }
243     protected function process_grade_category($data) {
244         global $DB;
246         $data = (object)$data;
247         $oldid = $data->id;
249         $data->course = $this->get_courseid();
250         $data->courseid = $data->course;
252         $data->timecreated  = $this->apply_date_offset($data->timecreated);
253         $data->timemodified = $this->apply_date_offset($data->timemodified);
255         $newitemid = null;
256         //no parent means a course level grade category. That may have been created when the course was created
257         if(empty($data->parent)) {
258             //parent was being saved as 0 when it should be null
259             $data->parent = null;
261             //get the already created course level grade category
262             $category = new stdclass();
263             $category->courseid = $this->get_courseid();
264             $category->parent = null;
266             $coursecategory = $DB->get_record('grade_categories', (array)$category);
267             if (!empty($coursecategory)) {
268                 $data->id = $newitemid = $coursecategory->id;
269                 $DB->update_record('grade_categories', $data);
270             }
271         }
273         //need to insert a course category
274         if (empty($newitemid)) {
275             $newitemid = $DB->insert_record('grade_categories', $data);
276         }
277         $this->set_mapping('grade_category', $oldid, $newitemid);
278     }
279     protected function process_grade_letter($data) {
280         global $DB;
282         $data = (object)$data;
283         $oldid = $data->id;
285         $data->contextid = context_course::instance($this->get_courseid())->id;
287         $gradeletter = (array)$data;
288         unset($gradeletter['id']);
289         if (!$DB->record_exists('grade_letters', $gradeletter)) {
290             $newitemid = $DB->insert_record('grade_letters', $data);
291         } else {
292             $newitemid = $data->id;
293         }
295         $this->set_mapping('grade_letter', $oldid, $newitemid);
296     }
297     protected function process_grade_setting($data) {
298         global $DB;
300         $data = (object)$data;
301         $oldid = $data->id;
303         $data->courseid = $this->get_courseid();
305         if (!$DB->record_exists('grade_settings', array('courseid' => $data->courseid, 'name' => $data->name))) {
306             $newitemid = $DB->insert_record('grade_settings', $data);
307         } else {
308             $newitemid = $data->id;
309         }
311         $this->set_mapping('grade_setting', $oldid, $newitemid);
312     }
314     /**
315      * put all activity grade items in the correct grade category and mark all for recalculation
316      */
317     protected function after_execute() {
318         global $DB;
320         $conditions = array(
321             'backupid' => $this->get_restoreid(),
322             'itemname' => 'grade_item'//,
323             //'itemid'   => $itemid
324         );
325         $rs = $DB->get_recordset('backup_ids_temp', $conditions);
327         // We need this for calculation magic later on.
328         $mappings = array();
330         if (!empty($rs)) {
331             foreach($rs as $grade_item_backup) {
333                 // Store the oldid with the new id.
334                 $mappings[$grade_item_backup->itemid] = $grade_item_backup->newitemid;
336                 $updateobj = new stdclass();
337                 $updateobj->id = $grade_item_backup->newitemid;
339                 //if this is an activity grade item that needs to be put back in its correct category
340                 if (!empty($grade_item_backup->parentitemid)) {
341                     $oldcategoryid = $this->get_mappingid('grade_category', $grade_item_backup->parentitemid, null);
342                     if (!is_null($oldcategoryid)) {
343                         $updateobj->categoryid = $oldcategoryid;
344                         $DB->update_record('grade_items', $updateobj);
345                     }
346                 } else {
347                     //mark course and category items as needing to be recalculated
348                     $updateobj->needsupdate=1;
349                     $DB->update_record('grade_items', $updateobj);
350                 }
351             }
352         }
353         $rs->close();
355         // We need to update the calculations for calculated grade items that may reference old
356         // grade item ids using ##gi\d+##.
357         // $mappings can be empty, use 0 if so (won't match ever)
358         list($sql, $params) = $DB->get_in_or_equal(array_values($mappings), SQL_PARAMS_NAMED, 'param', true, 0);
359         $sql = "SELECT gi.id, gi.calculation
360                   FROM {grade_items} gi
361                  WHERE gi.id {$sql} AND
362                        calculation IS NOT NULL";
363         $rs = $DB->get_recordset_sql($sql, $params);
364         foreach ($rs as $gradeitem) {
365             // Collect all of the used grade item id references
366             if (preg_match_all('/##gi(\d+)##/', $gradeitem->calculation, $matches) < 1) {
367                 // This calculation doesn't reference any other grade items... EASY!
368                 continue;
369             }
370             // For this next bit we are going to do the replacement of id's in two steps:
371             // 1. We will replace all old id references with a special mapping reference.
372             // 2. We will replace all mapping references with id's
373             // Why do we do this?
374             // Because there potentially there will be an overlap of ids within the query and we
375             // we substitute the wrong id.. safest way around this is the two step system
376             $calculationmap = array();
377             $mapcount = 0;
378             foreach ($matches[1] as $match) {
379                 // Check that the old id is known to us, if not it was broken to begin with and will
380                 // continue to be broken.
381                 if (!array_key_exists($match, $mappings)) {
382                     continue;
383                 }
384                 // Our special mapping key
385                 $mapping = '##MAPPING'.$mapcount.'##';
386                 // The old id that exists within the calculation now
387                 $oldid = '##gi'.$match.'##';
388                 // The new id that we want to replace the old one with.
389                 $newid = '##gi'.$mappings[$match].'##';
390                 // Replace in the special mapping key
391                 $gradeitem->calculation = str_replace($oldid, $mapping, $gradeitem->calculation);
392                 // And record the mapping
393                 $calculationmap[$mapping] = $newid;
394                 $mapcount++;
395             }
396             // Iterate all special mappings for this calculation and replace in the new id's
397             foreach ($calculationmap as $mapping => $newid) {
398                 $gradeitem->calculation = str_replace($mapping, $newid, $gradeitem->calculation);
399             }
400             // Update the calculation now that its being remapped
401             $DB->update_record('grade_items', $gradeitem);
402         }
403         $rs->close();
405         // Need to correct the grade category path and parent
406         $conditions = array(
407             'courseid' => $this->get_courseid()
408         );
410         $rs = $DB->get_recordset('grade_categories', $conditions);
411         // Get all the parents correct first as grade_category::build_path() loads category parents from the DB
412         foreach ($rs as $gc) {
413             if (!empty($gc->parent)) {
414                 $grade_category = new stdClass();
415                 $grade_category->id = $gc->id;
416                 $grade_category->parent = $this->get_mappingid('grade_category', $gc->parent);
417                 $DB->update_record('grade_categories', $grade_category);
418             }
419         }
420         $rs->close();
422         // Now we can rebuild all the paths
423         $rs = $DB->get_recordset('grade_categories', $conditions);
424         foreach ($rs as $gc) {
425             $grade_category = new stdClass();
426             $grade_category->id = $gc->id;
427             $grade_category->path = grade_category::build_path($gc);
428             $grade_category->depth = substr_count($grade_category->path, '/') - 1;
429             $DB->update_record('grade_categories', $grade_category);
430         }
431         $rs->close();
433         // Restore marks items as needing update. Update everything now.
434         grade_regrade_final_grades($this->get_courseid());
435     }
438 /**
439  * decode all the interlinks present in restored content
440  * relying 100% in the restore_decode_processor that handles
441  * both the contents to modify and the rules to be applied
442  */
443 class restore_decode_interlinks extends restore_execution_step {
445     protected function define_execution() {
446         // Get the decoder (from the plan)
447         $decoder = $this->task->get_decoder();
448         restore_decode_processor::register_link_decoders($decoder); // Add decoder contents and rules
449         // And launch it, everything will be processed
450         $decoder->execute();
451     }
454 /**
455  * first, ensure that we have no gaps in section numbers
456  * and then, rebuid the course cache
457  */
458 class restore_rebuild_course_cache extends restore_execution_step {
460     protected function define_execution() {
461         global $DB;
463         // Although there is some sort of auto-recovery of missing sections
464         // present in course/formats... here we check that all the sections
465         // from 0 to MAX(section->section) exist, creating them if necessary
466         $maxsection = $DB->get_field('course_sections', 'MAX(section)', array('course' => $this->get_courseid()));
467         // Iterate over all sections
468         for ($i = 0; $i <= $maxsection; $i++) {
469             // If the section $i doesn't exist, create it
470             if (!$DB->record_exists('course_sections', array('course' => $this->get_courseid(), 'section' => $i))) {
471                 $sectionrec = array(
472                     'course' => $this->get_courseid(),
473                     'section' => $i);
474                 $DB->insert_record('course_sections', $sectionrec); // missing section created
475             }
476         }
478         // Rebuild cache now that all sections are in place
479         rebuild_course_cache($this->get_courseid());
480         cache_helper::purge_by_event('changesincourse');
481         cache_helper::purge_by_event('changesincoursecat');
482     }
485 /**
486  * Review all the tasks having one after_restore method
487  * executing it to perform some final adjustments of information
488  * not available when the task was executed.
489  */
490 class restore_execute_after_restore extends restore_execution_step {
492     protected function define_execution() {
494         // Simply call to the execute_after_restore() method of the task
495         // that always is the restore_final_task
496         $this->task->launch_execute_after_restore();
497     }
501 /**
502  * Review all the (pending) block positions in backup_ids, matching by
503  * contextid, creating positions as needed. This is executed by the
504  * final task, once all the contexts have been created
505  */
506 class restore_review_pending_block_positions extends restore_execution_step {
508     protected function define_execution() {
509         global $DB;
511         // Get all the block_position objects pending to match
512         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
513         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
514         // Process block positions, creating them or accumulating for final step
515         foreach($rs as $posrec) {
516             // Get the complete position object out of the info field.
517             $position = backup_controller_dbops::decode_backup_temp_info($posrec->info);
518             // If position is for one already mapped (known) contextid
519             // process it now, creating the position, else nothing to
520             // do, position finally discarded
521             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
522                 $position->contextid = $newctx->newitemid;
523                 // Create the block position
524                 $DB->insert_record('block_positions', $position);
525             }
526         }
527         $rs->close();
528     }
531 /**
532  * Process all the saved module availability records in backup_ids, matching
533  * course modules and grade item id once all them have been already restored.
534  * only if all matchings are satisfied the availability condition will be created.
535  * At the same time, it is required for the site to have that functionality enabled.
536  */
537 class restore_process_course_modules_availability extends restore_execution_step {
539     protected function define_execution() {
540         global $CFG, $DB;
542         // Site hasn't availability enabled
543         if (empty($CFG->enableavailability)) {
544             return;
545         }
547         // Get all the module_availability objects to process
548         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'module_availability');
549         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid, info');
550         // Process availabilities, creating them if everything matches ok
551         foreach($rs as $availrec) {
552             $allmatchesok = true;
553             // Get the complete availabilityobject
554             $availability = backup_controller_dbops::decode_backup_temp_info($availrec->info);
555             // Map the sourcecmid if needed and possible
556             if (!empty($availability->sourcecmid)) {
557                 $newcm = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'course_module', $availability->sourcecmid);
558                 if ($newcm) {
559                     $availability->sourcecmid = $newcm->newitemid;
560                 } else {
561                     $allmatchesok = false; // Failed matching, we won't create this availability rule
562                 }
563             }
564             // Map the gradeitemid if needed and possible
565             if (!empty($availability->gradeitemid)) {
566                 $newgi = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'grade_item', $availability->gradeitemid);
567                 if ($newgi) {
568                     $availability->gradeitemid = $newgi->newitemid;
569                 } else {
570                     $allmatchesok = false; // Failed matching, we won't create this availability rule
571                 }
572             }
573             if ($allmatchesok) { // Everything ok, create the availability rule
574                 $DB->insert_record('course_modules_availability', $availability);
575             }
576         }
577         $rs->close();
578     }
582 /*
583  * Execution step that, *conditionally* (if there isn't preloaded information)
584  * will load the inforef files for all the included course/section/activity tasks
585  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
586  */
587 class restore_load_included_inforef_records extends restore_execution_step {
589     protected function define_execution() {
591         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
592             return;
593         }
595         // Get all the included tasks
596         $tasks = restore_dbops::get_included_tasks($this->get_restoreid());
597         $progress = $this->task->get_progress();
598         $progress->start_progress($this->get_name(), count($tasks));
599         foreach ($tasks as $task) {
600             // Load the inforef.xml file if exists
601             $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
602             if (file_exists($inforefpath)) {
603                 // Load each inforef file to temp_ids.
604                 restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $inforefpath, $progress);
605             }
606         }
607         $progress->end_progress();
608     }
611 /*
612  * Execution step that will load all the needed files into backup_files_temp
613  *   - info: contains the whole original object (times, names...)
614  * (all them being original ids as loaded from xml)
615  */
616 class restore_load_included_files extends restore_structure_step {
618     protected function define_structure() {
620         $file = new restore_path_element('file', '/files/file');
622         return array($file);
623     }
625     /**
626      * Process one <file> element from files.xml
627      *
628      * @param array $data the element data
629      */
630     public function process_file($data) {
632         $data = (object)$data; // handy
634         // load it if needed:
635         //   - it it is one of the annotated inforef files (course/section/activity/block)
636         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
637         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
638         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
639         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
640         $iscomponent = ($data->component == 'user' || $data->component == 'group' || $data->component == 'badges' ||
641                         $data->component == 'grouping' || $data->component == 'grade' ||
642                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
643         if ($isfileref || $iscomponent) {
644             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
645         }
646     }
649 /**
650  * Execution step that, *conditionally* (if there isn't preloaded information),
651  * will load all the needed roles to backup_temp_ids. They will be stored with
652  * "role" itemname. Also it will perform one automatic mapping to roles existing
653  * in the target site, based in permissions of the user performing the restore,
654  * archetypes and other bits. At the end, each original role will have its associated
655  * target role or 0 if it's going to be skipped. Note we wrap everything over one
656  * restore_dbops method, as far as the same stuff is going to be also executed
657  * by restore prechecks
658  */
659 class restore_load_and_map_roles extends restore_execution_step {
661     protected function define_execution() {
662         if ($this->task->get_preloaded_information()) { // if info is already preloaded
663             return;
664         }
666         $file = $this->get_basepath() . '/roles.xml';
667         // Load needed toles to temp_ids
668         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
670         // Process roles, mapping/skipping. Any error throws exception
671         // Note we pass controller's info because it can contain role mapping information
672         // about manual mappings performed by UI
673         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);
674     }
677 /**
678  * Execution step that, *conditionally* (if there isn't preloaded information
679  * and users have been selected in settings, will load all the needed users
680  * to backup_temp_ids. They will be stored with "user" itemname and with
681  * their original contextid as paremitemid
682  */
683 class restore_load_included_users extends restore_execution_step {
685     protected function define_execution() {
687         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
688             return;
689         }
690         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
691             return;
692         }
693         $file = $this->get_basepath() . '/users.xml';
694         // Load needed users to temp_ids.
695         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file, $this->task->get_progress());
696     }
699 /**
700  * Execution step that, *conditionally* (if there isn't preloaded information
701  * and users have been selected in settings, will process all the needed users
702  * in order to decide and perform any action with them (create / map / error)
703  * Note: Any error will cause exception, as far as this is the same processing
704  * than the one into restore prechecks (that should have stopped process earlier)
705  */
706 class restore_process_included_users extends restore_execution_step {
708     protected function define_execution() {
710         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
711             return;
712         }
713         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
714             return;
715         }
716         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(),
717                 $this->task->get_userid(), $this->task->is_samesite(), $this->task->get_progress());
718     }
721 /**
722  * Execution step that will create all the needed users as calculated
723  * by @restore_process_included_users (those having newiteind = 0)
724  */
725 class restore_create_included_users extends restore_execution_step {
727     protected function define_execution() {
729         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(), $this->task->get_userid());
730     }
733 /**
734  * Structure step that will create all the needed groups and groupings
735  * by loading them from the groups.xml file performing the required matches.
736  * Note group members only will be added if restoring user info
737  */
738 class restore_groups_structure_step extends restore_structure_step {
740     protected function define_structure() {
742         $paths = array(); // Add paths here
744         $paths[] = new restore_path_element('group', '/groups/group');
745         $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
746         $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
748         return $paths;
749     }
751     // Processing functions go here
752     public function process_group($data) {
753         global $DB;
755         $data = (object)$data; // handy
756         $data->courseid = $this->get_courseid();
758         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
759         // another a group in the same course
760         $context = context_course::instance($data->courseid);
761         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
762             if (groups_get_group_by_idnumber($data->courseid, $data->idnumber)) {
763                 unset($data->idnumber);
764             }
765         } else {
766             unset($data->idnumber);
767         }
769         $oldid = $data->id;    // need this saved for later
771         $restorefiles = false; // Only if we end creating the group
773         // Search if the group already exists (by name & description) in the target course
774         $description_clause = '';
775         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
776         if (!empty($data->description)) {
777             $description_clause = ' AND ' .
778                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
779            $params['description'] = $data->description;
780         }
781         if (!$groupdb = $DB->get_record_sql("SELECT *
782                                                FROM {groups}
783                                               WHERE courseid = :courseid
784                                                 AND name = :grname $description_clause", $params)) {
785             // group doesn't exist, create
786             $newitemid = $DB->insert_record('groups', $data);
787             $restorefiles = true; // We'll restore the files
788         } else {
789             // group exists, use it
790             $newitemid = $groupdb->id;
791         }
792         // Save the id mapping
793         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
794         // Invalidate the course group data cache just in case.
795         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
796     }
798     public function process_grouping($data) {
799         global $DB;
801         $data = (object)$data; // handy
802         $data->courseid = $this->get_courseid();
804         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
805         // another a grouping in the same course
806         $context = context_course::instance($data->courseid);
807         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
808             if (groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) {
809                 unset($data->idnumber);
810             }
811         } else {
812             unset($data->idnumber);
813         }
815         $oldid = $data->id;    // need this saved for later
816         $restorefiles = false; // Only if we end creating the grouping
818         // Search if the grouping already exists (by name & description) in the target course
819         $description_clause = '';
820         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
821         if (!empty($data->description)) {
822             $description_clause = ' AND ' .
823                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
824            $params['description'] = $data->description;
825         }
826         if (!$groupingdb = $DB->get_record_sql("SELECT *
827                                                   FROM {groupings}
828                                                  WHERE courseid = :courseid
829                                                    AND name = :grname $description_clause", $params)) {
830             // grouping doesn't exist, create
831             $newitemid = $DB->insert_record('groupings', $data);
832             $restorefiles = true; // We'll restore the files
833         } else {
834             // grouping exists, use it
835             $newitemid = $groupingdb->id;
836         }
837         // Save the id mapping
838         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
839         // Invalidate the course group data cache just in case.
840         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
841     }
843     public function process_grouping_group($data) {
844         global $CFG;
846         require_once($CFG->dirroot.'/group/lib.php');
848         $data = (object)$data;
849         groups_assign_grouping($this->get_new_parentid('grouping'), $this->get_mappingid('group', $data->groupid), $data->timeadded);
850     }
852     protected function after_execute() {
853         // Add group related files, matching with "group" mappings
854         $this->add_related_files('group', 'icon', 'group');
855         $this->add_related_files('group', 'description', 'group');
856         // Add grouping related files, matching with "grouping" mappings
857         $this->add_related_files('grouping', 'description', 'grouping');
858         // Invalidate the course group data.
859         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($this->get_courseid()));
860     }
864 /**
865  * Structure step that will create all the needed group memberships
866  * by loading them from the groups.xml file performing the required matches.
867  */
868 class restore_groups_members_structure_step extends restore_structure_step {
870     protected $plugins = null;
872     protected function define_structure() {
874         $paths = array(); // Add paths here
876         if ($this->get_setting_value('users')) {
877             $paths[] = new restore_path_element('group', '/groups/group');
878             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
879         }
881         return $paths;
882     }
884     public function process_group($data) {
885         $data = (object)$data; // handy
887         // HACK ALERT!
888         // Not much to do here, this groups mapping should be already done from restore_groups_structure_step.
889         // Let's fake internal state to make $this->get_new_parentid('group') work.
891         $this->set_mapping('group', $data->id, $this->get_mappingid('group', $data->id));
892     }
894     public function process_member($data) {
895         global $DB, $CFG;
896         require_once("$CFG->dirroot/group/lib.php");
898         // NOTE: Always use groups_add_member() because it triggers events and verifies if user is enrolled.
900         $data = (object)$data; // handy
902         // get parent group->id
903         $data->groupid = $this->get_new_parentid('group');
905         // map user newitemid and insert if not member already
906         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
907             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
908                 // Check the component, if any, exists.
909                 if (empty($data->component)) {
910                     groups_add_member($data->groupid, $data->userid);
912                 } else if ((strpos($data->component, 'enrol_') === 0)) {
913                     // Deal with enrolment groups - ignore the component and just find out the instance via new id,
914                     // it is possible that enrolment was restored using different plugin type.
915                     if (!isset($this->plugins)) {
916                         $this->plugins = enrol_get_plugins(true);
917                     }
918                     if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
919                         if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
920                             if (isset($this->plugins[$instance->enrol])) {
921                                 $this->plugins[$instance->enrol]->restore_group_member($instance, $data->groupid, $data->userid);
922                             }
923                         }
924                     }
926                 } else {
927                     $dir = core_component::get_component_directory($data->component);
928                     if ($dir and is_dir($dir)) {
929                         if (component_callback($data->component, 'restore_group_member', array($this, $data), true)) {
930                             return;
931                         }
932                     }
933                     // Bad luck, plugin could not restore the data, let's add normal membership.
934                     groups_add_member($data->groupid, $data->userid);
935                     $message = "Restore of '$data->component/$data->itemid' group membership is not supported, using standard group membership instead.";
936                     debugging($message);
937                     $this->log($message, backup::LOG_WARNING);
938                 }
939             }
940         }
941     }
944 /**
945  * Structure step that will create all the needed scales
946  * by loading them from the scales.xml
947  */
948 class restore_scales_structure_step extends restore_structure_step {
950     protected function define_structure() {
952         $paths = array(); // Add paths here
953         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
954         return $paths;
955     }
957     protected function process_scale($data) {
958         global $DB;
960         $data = (object)$data;
962         $restorefiles = false; // Only if we end creating the group
964         $oldid = $data->id;    // need this saved for later
966         // Look for scale (by 'scale' both in standard (course=0) and current course
967         // with priority to standard scales (ORDER clause)
968         // scale is not course unique, use get_record_sql to suppress warning
969         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
970         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
971         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
972         if (!$scadb = $DB->get_record_sql("SELECT *
973                                             FROM {scale}
974                                            WHERE courseid IN (0, :courseid)
975                                              AND $compare_scale_clause
976                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
977             // Remap the user if possible, defaut to user performing the restore if not
978             $userid = $this->get_mappingid('user', $data->userid);
979             $data->userid = $userid ? $userid : $this->task->get_userid();
980             // Remap the course if course scale
981             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
982             // If global scale (course=0), check the user has perms to create it
983             // falling to course scale if not
984             $systemctx = context_system::instance();
985             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
986                 $data->courseid = $this->get_courseid();
987             }
988             // scale doesn't exist, create
989             $newitemid = $DB->insert_record('scale', $data);
990             $restorefiles = true; // We'll restore the files
991         } else {
992             // scale exists, use it
993             $newitemid = $scadb->id;
994         }
995         // Save the id mapping (with files support at system context)
996         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
997     }
999     protected function after_execute() {
1000         // Add scales related files, matching with "scale" mappings
1001         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
1002     }
1006 /**
1007  * Structure step that will create all the needed outocomes
1008  * by loading them from the outcomes.xml
1009  */
1010 class restore_outcomes_structure_step extends restore_structure_step {
1012     protected function define_structure() {
1014         $paths = array(); // Add paths here
1015         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
1016         return $paths;
1017     }
1019     protected function process_outcome($data) {
1020         global $DB;
1022         $data = (object)$data;
1024         $restorefiles = false; // Only if we end creating the group
1026         $oldid = $data->id;    // need this saved for later
1028         // Look for outcome (by shortname both in standard (courseid=null) and current course
1029         // with priority to standard outcomes (ORDER clause)
1030         // outcome is not course unique, use get_record_sql to suppress warning
1031         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
1032         if (!$outdb = $DB->get_record_sql('SELECT *
1033                                              FROM {grade_outcomes}
1034                                             WHERE shortname = :shortname
1035                                               AND (courseid = :courseid OR courseid IS NULL)
1036                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
1037             // Remap the user
1038             $userid = $this->get_mappingid('user', $data->usermodified);
1039             $data->usermodified = $userid ? $userid : $this->task->get_userid();
1040             // Remap the scale
1041             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
1042             // Remap the course if course outcome
1043             $data->courseid = $data->courseid ? $this->get_courseid() : null;
1044             // If global outcome (course=null), check the user has perms to create it
1045             // falling to course outcome if not
1046             $systemctx = context_system::instance();
1047             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
1048                 $data->courseid = $this->get_courseid();
1049             }
1050             // outcome doesn't exist, create
1051             $newitemid = $DB->insert_record('grade_outcomes', $data);
1052             $restorefiles = true; // We'll restore the files
1053         } else {
1054             // scale exists, use it
1055             $newitemid = $outdb->id;
1056         }
1057         // Set the corresponding grade_outcomes_courses record
1058         $outcourserec = new stdclass();
1059         $outcourserec->courseid  = $this->get_courseid();
1060         $outcourserec->outcomeid = $newitemid;
1061         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
1062             $DB->insert_record('grade_outcomes_courses', $outcourserec);
1063         }
1064         // Save the id mapping (with files support at system context)
1065         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
1066     }
1068     protected function after_execute() {
1069         // Add outcomes related files, matching with "outcome" mappings
1070         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
1071     }
1074 /**
1075  * Execution step that, *conditionally* (if there isn't preloaded information
1076  * will load all the question categories and questions (header info only)
1077  * to backup_temp_ids. They will be stored with "question_category" and
1078  * "question" itemnames and with their original contextid and question category
1079  * id as paremitemids
1080  */
1081 class restore_load_categories_and_questions extends restore_execution_step {
1083     protected function define_execution() {
1085         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1086             return;
1087         }
1088         $file = $this->get_basepath() . '/questions.xml';
1089         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
1090     }
1093 /**
1094  * Execution step that, *conditionally* (if there isn't preloaded information)
1095  * will process all the needed categories and questions
1096  * in order to decide and perform any action with them (create / map / error)
1097  * Note: Any error will cause exception, as far as this is the same processing
1098  * than the one into restore prechecks (that should have stopped process earlier)
1099  */
1100 class restore_process_categories_and_questions extends restore_execution_step {
1102     protected function define_execution() {
1104         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1105             return;
1106         }
1107         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
1108     }
1111 /**
1112  * Structure step that will read the section.xml creating/updating sections
1113  * as needed, rebuilding course cache and other friends
1114  */
1115 class restore_section_structure_step extends restore_structure_step {
1117     protected function define_structure() {
1118         global $CFG;
1120         $paths = array();
1122         $section = new restore_path_element('section', '/section');
1123         $paths[] = $section;
1124         if ($CFG->enableavailability) {
1125             $paths[] = new restore_path_element('availability', '/section/availability');
1126             $paths[] = new restore_path_element('availability_field', '/section/availability_field');
1127         }
1128         $paths[] = new restore_path_element('course_format_options', '/section/course_format_options');
1130         // Apply for 'format' plugins optional paths at section level
1131         $this->add_plugin_structure('format', $section);
1133         // Apply for 'local' plugins optional paths at section level
1134         $this->add_plugin_structure('local', $section);
1136         return $paths;
1137     }
1139     public function process_section($data) {
1140         global $CFG, $DB;
1141         $data = (object)$data;
1142         $oldid = $data->id; // We'll need this later
1144         $restorefiles = false;
1146         // Look for the section
1147         $section = new stdclass();
1148         $section->course  = $this->get_courseid();
1149         $section->section = $data->number;
1150         // Section doesn't exist, create it with all the info from backup
1151         if (!$secrec = $DB->get_record('course_sections', (array)$section)) {
1152             $section->name = $data->name;
1153             $section->summary = $data->summary;
1154             $section->summaryformat = $data->summaryformat;
1155             $section->sequence = '';
1156             $section->visible = $data->visible;
1157             if (empty($CFG->enableavailability)) { // Process availability information only if enabled.
1158                 $section->availablefrom = 0;
1159                 $section->availableuntil = 0;
1160                 $section->showavailability = 0;
1161             } else {
1162                 $section->availablefrom = isset($data->availablefrom) ? $this->apply_date_offset($data->availablefrom) : 0;
1163                 $section->availableuntil = isset($data->availableuntil) ? $this->apply_date_offset($data->availableuntil) : 0;
1164                 $section->showavailability = isset($data->showavailability) ? $data->showavailability : 0;
1165             }
1166             if (!empty($CFG->enablegroupmembersonly)) { // Only if enablegroupmembersonly is enabled
1167                 $section->groupingid = isset($data->groupingid) ? $this->get_mappingid('grouping', $data->groupingid) : 0;
1168             }
1169             $newitemid = $DB->insert_record('course_sections', $section);
1170             $restorefiles = true;
1172         // Section exists, update non-empty information
1173         } else {
1174             $section->id = $secrec->id;
1175             if ((string)$secrec->name === '') {
1176                 $section->name = $data->name;
1177             }
1178             if (empty($secrec->summary)) {
1179                 $section->summary = $data->summary;
1180                 $section->summaryformat = $data->summaryformat;
1181                 $restorefiles = true;
1182             }
1183             if (empty($secrec->groupingid)) {
1184                 if (!empty($CFG->enablegroupmembersonly)) { // Only if enablegroupmembersonly is enabled
1185                     $section->groupingid = isset($data->groupingid) ? $this->get_mappingid('grouping', $data->groupingid) : 0;
1186                 }
1187             }
1189             // Don't update available from, available until, or show availability
1190             // (I didn't see a useful way to define whether existing or new one should
1191             // take precedence).
1193             $DB->update_record('course_sections', $section);
1194             $newitemid = $secrec->id;
1195         }
1197         // Annotate the section mapping, with restorefiles option if needed
1198         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
1200         // set the new course_section id in the task
1201         $this->task->set_sectionid($newitemid);
1204         // Commented out. We never modify course->numsections as far as that is used
1205         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
1206         // Note: We keep the code here, to know about and because of the possibility of making this
1207         // optional based on some setting/attribute in the future
1208         // If needed, adjust course->numsections
1209         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
1210         //    if ($numsections < $section->section) {
1211         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
1212         //    }
1213         //}
1214     }
1216     public function process_availability($data) {
1217         global $DB;
1218         $data = (object)$data;
1220         $data->coursesectionid = $this->task->get_sectionid();
1222         // NOTE: Other values in $data need updating, but these (cm,
1223         // grade items) have not yet been restored, so are done later.
1225         $newid = $DB->insert_record('course_sections_availability', $data);
1227         // We do not need to map between old and new id but storing a mapping
1228         // means it gets added to the backup_ids table to record which ones
1229         // need updating. The mapping is stored with $newid => $newid for
1230         // convenience.
1231         $this->set_mapping('course_sections_availability', $newid, $newid);
1232     }
1234     public function process_availability_field($data) {
1235         global $DB;
1236         $data = (object)$data;
1237         // Mark it is as passed by default
1238         $passed = true;
1239         $customfieldid = null;
1241         // If a customfield has been used in order to pass we must be able to match an existing
1242         // customfield by name (data->customfield) and type (data->customfieldtype)
1243         if (is_null($data->customfield) xor is_null($data->customfieldtype)) {
1244             // xor is sort of uncommon. If either customfield is null or customfieldtype is null BUT not both.
1245             // If one is null but the other isn't something clearly went wrong and we'll skip this condition.
1246             $passed = false;
1247         } else if (!is_null($data->customfield)) {
1248             $params = array('shortname' => $data->customfield, 'datatype' => $data->customfieldtype);
1249             $customfieldid = $DB->get_field('user_info_field', 'id', $params);
1250             $passed = ($customfieldid !== false);
1251         }
1253         if ($passed) {
1254             // Create the object to insert into the database
1255             $availfield = new stdClass();
1256             $availfield->coursesectionid = $this->task->get_sectionid();
1257             $availfield->userfield = $data->userfield;
1258             $availfield->customfieldid = $customfieldid;
1259             $availfield->operator = $data->operator;
1260             $availfield->value = $data->value;
1261             $DB->insert_record('course_sections_avail_fields', $availfield);
1262         }
1263     }
1265     public function process_course_format_options($data) {
1266         global $DB;
1267         $data = (object)$data;
1268         $oldid = $data->id;
1269         unset($data->id);
1270         $data->sectionid = $this->task->get_sectionid();
1271         $data->courseid = $this->get_courseid();
1272         $newid = $DB->insert_record('course_format_options', $data);
1273         $this->set_mapping('course_format_options', $oldid, $newid);
1274     }
1276     protected function after_execute() {
1277         // Add section related files, with 'course_section' itemid to match
1278         $this->add_related_files('course', 'section', 'course_section');
1279     }
1281     public function after_restore() {
1282         global $DB;
1284         $sectionid = $this->get_task()->get_sectionid();
1286         // Get data object for current section availability (if any).
1287         $records = $DB->get_records('course_sections_availability',
1288                 array('coursesectionid' => $sectionid), 'id, sourcecmid, gradeitemid');
1290         // If it exists, update mappings.
1291         foreach ($records as $data) {
1292             // Only update mappings for entries which are created by this restore.
1293             // Otherwise, when you restore to an existing course, it will mess up
1294             // existing section availability entries.
1295             if (!$this->get_mappingid('course_sections_availability', $data->id, false)) {
1296                 continue;
1297             }
1299             // Update source cmid / grade id to new value.
1300             $data->sourcecmid = $this->get_mappingid('course_module', $data->sourcecmid);
1301             if (!$data->sourcecmid) {
1302                 $data->sourcecmid = null;
1303             }
1304             $data->gradeitemid = $this->get_mappingid('grade_item', $data->gradeitemid);
1305             if (!$data->gradeitemid) {
1306                 $data->gradeitemid = null;
1307             }
1309             // Delete the record if the condition wasn't found, otherwise update it.
1310             if ($data->sourcecmid === null && $data->gradeitemid === null) {
1311                 $DB->delete_records('course_sections_availability', array('id' => $data->id));
1312             } else {
1313                 $DB->update_record('course_sections_availability', $data);
1314             }
1315         }
1316     }
1320 /**
1321  * Structure step that will read the course.xml file, loading it and performing
1322  * various actions depending of the site/restore settings. Note that target
1323  * course always exist before arriving here so this step will be updating
1324  * the course record (never inserting)
1325  */
1326 class restore_course_structure_step extends restore_structure_step {
1327     /**
1328      * @var bool this gets set to true by {@link process_course()} if we are
1329      * restoring an old coures that used the legacy 'module security' feature.
1330      * If so, we have to do more work in {@link after_execute()}.
1331      */
1332     protected $legacyrestrictmodules = false;
1334     /**
1335      * @var array Used when {@link $legacyrestrictmodules} is true. This is an
1336      * array with array keys the module names ('forum', 'quiz', etc.). These are
1337      * the modules that are allowed according to the data in the backup file.
1338      * In {@link after_execute()} we then have to prevent adding of all the other
1339      * types of activity.
1340      */
1341     protected $legacyallowedmodules = array();
1343     protected function define_structure() {
1345         $course = new restore_path_element('course', '/course');
1346         $category = new restore_path_element('category', '/course/category');
1347         $tag = new restore_path_element('tag', '/course/tags/tag');
1348         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1350         // Apply for 'format' plugins optional paths at course level
1351         $this->add_plugin_structure('format', $course);
1353         // Apply for 'theme' plugins optional paths at course level
1354         $this->add_plugin_structure('theme', $course);
1356         // Apply for 'report' plugins optional paths at course level
1357         $this->add_plugin_structure('report', $course);
1359         // Apply for 'course report' plugins optional paths at course level
1360         $this->add_plugin_structure('coursereport', $course);
1362         // Apply for plagiarism plugins optional paths at course level
1363         $this->add_plugin_structure('plagiarism', $course);
1365         // Apply for local plugins optional paths at course level
1366         $this->add_plugin_structure('local', $course);
1368         return array($course, $category, $tag, $allowed_module);
1369     }
1371     /**
1372      * Processing functions go here
1373      *
1374      * @global moodledatabase $DB
1375      * @param stdClass $data
1376      */
1377     public function process_course($data) {
1378         global $CFG, $DB;
1380         $data = (object)$data;
1382         $fullname  = $this->get_setting_value('course_fullname');
1383         $shortname = $this->get_setting_value('course_shortname');
1384         $startdate = $this->get_setting_value('course_startdate');
1386         // Calculate final course names, to avoid dupes
1387         list($fullname, $shortname) = restore_dbops::calculate_course_names($this->get_courseid(), $fullname, $shortname);
1389         // Need to change some fields before updating the course record
1390         $data->id = $this->get_courseid();
1391         $data->fullname = $fullname;
1392         $data->shortname= $shortname;
1394         $context = context::instance_by_id($this->task->get_contextid());
1395         if (has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1396             $data->idnumber = '';
1397         } else {
1398             unset($data->idnumber);
1399         }
1401         // Any empty value for course->hiddensections will lead to 0 (default, show collapsed).
1402         // It has been reported that some old 1.9 courses may have it null leading to DB error. MDL-31532
1403         if (empty($data->hiddensections)) {
1404             $data->hiddensections = 0;
1405         }
1407         // Set legacyrestrictmodules to true if the course was resticting modules. If so
1408         // then we will need to process restricted modules after execution.
1409         $this->legacyrestrictmodules = !empty($data->restrictmodules);
1411         $data->startdate= $this->apply_date_offset($data->startdate);
1412         if ($data->defaultgroupingid) {
1413             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1414         }
1415         if (empty($CFG->enablecompletion)) {
1416             $data->enablecompletion = 0;
1417             $data->completionstartonenrol = 0;
1418             $data->completionnotify = 0;
1419         }
1420         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1421         if (!array_key_exists($data->lang, $languages)) {
1422             $data->lang = '';
1423         }
1425         $themes = get_list_of_themes(); // Get themes for quick search later
1426         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1427             $data->theme = '';
1428         }
1430         // Check if this is an old SCORM course format.
1431         if ($data->format == 'scorm') {
1432             $data->format = 'singleactivity';
1433             $data->activitytype = 'scorm';
1434         }
1436         // Course record ready, update it
1437         $DB->update_record('course', $data);
1439         course_get_format($data)->update_course_format_options($data);
1441         // Role name aliases
1442         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1443     }
1445     public function process_category($data) {
1446         // Nothing to do with the category. UI sets it before restore starts
1447     }
1449     public function process_tag($data) {
1450         global $CFG, $DB;
1452         $data = (object)$data;
1454         if (!empty($CFG->usetags)) { // if enabled in server
1455             // TODO: This is highly inneficient. Each time we add one tag
1456             // we fetch all the existing because tag_set() deletes them
1457             // so everything must be reinserted on each call
1458             $tags = array();
1459             $existingtags = tag_get_tags('course', $this->get_courseid());
1460             // Re-add all the existitng tags
1461             foreach ($existingtags as $existingtag) {
1462                 $tags[] = $existingtag->rawname;
1463             }
1464             // Add the one being restored
1465             $tags[] = $data->rawname;
1466             // Send all the tags back to the course
1467             tag_set('course', $this->get_courseid(), $tags);
1468         }
1469     }
1471     public function process_allowed_module($data) {
1472         $data = (object)$data;
1474         // Backwards compatiblity support for the data that used to be in the
1475         // course_allowed_modules table.
1476         if ($this->legacyrestrictmodules) {
1477             $this->legacyallowedmodules[$data->modulename] = 1;
1478         }
1479     }
1481     protected function after_execute() {
1482         global $DB;
1484         // Add course related files, without itemid to match
1485         $this->add_related_files('course', 'summary', null);
1486         $this->add_related_files('course', 'overviewfiles', null);
1488         // Deal with legacy allowed modules.
1489         if ($this->legacyrestrictmodules) {
1490             $context = context_course::instance($this->get_courseid());
1492             list($roleids) = get_roles_with_cap_in_context($context, 'moodle/course:manageactivities');
1493             list($managerroleids) = get_roles_with_cap_in_context($context, 'moodle/site:config');
1494             foreach ($managerroleids as $roleid) {
1495                 unset($roleids[$roleid]);
1496             }
1498             foreach (core_component::get_plugin_list('mod') as $modname => $notused) {
1499                 if (isset($this->legacyallowedmodules[$modname])) {
1500                     // Module is allowed, no worries.
1501                     continue;
1502                 }
1504                 $capability = 'mod/' . $modname . ':addinstance';
1505                 foreach ($roleids as $roleid) {
1506                     assign_capability($capability, CAP_PREVENT, $roleid, $context);
1507                 }
1508             }
1509         }
1510     }
1513 /**
1514  * Execution step that will migrate legacy files if present.
1515  */
1516 class restore_course_legacy_files_step extends restore_execution_step {
1517     public function define_execution() {
1518         global $DB;
1520         // Do a check for legacy files and skip if there are none.
1521         $sql = 'SELECT count(*)
1522                   FROM {backup_files_temp}
1523                  WHERE backupid = ?
1524                    AND contextid = ?
1525                    AND component = ?
1526                    AND filearea  = ?';
1527         $params = array($this->get_restoreid(), $this->task->get_old_contextid(), 'course', 'legacy');
1529         if ($DB->count_records_sql($sql, $params)) {
1530             $DB->set_field('course', 'legacyfiles', 2, array('id' => $this->get_courseid()));
1531             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'course',
1532                 'legacy', $this->task->get_old_contextid(), $this->task->get_userid());
1533         }
1534     }
1537 /*
1538  * Structure step that will read the roles.xml file (at course/activity/block levels)
1539  * containing all the role_assignments and overrides for that context. If corresponding to
1540  * one mapped role, they will be applied to target context. Will observe the role_assignments
1541  * setting to decide if ras are restored.
1542  *
1543  * Note: this needs to be executed after all users are enrolled.
1544  */
1545 class restore_ras_and_caps_structure_step extends restore_structure_step {
1546     protected $plugins = null;
1548     protected function define_structure() {
1550         $paths = array();
1552         // Observe the role_assignments setting
1553         if ($this->get_setting_value('role_assignments')) {
1554             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
1555         }
1556         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
1558         return $paths;
1559     }
1561     /**
1562      * Assign roles
1563      *
1564      * This has to be called after enrolments processing.
1565      *
1566      * @param mixed $data
1567      * @return void
1568      */
1569     public function process_assignment($data) {
1570         global $DB;
1572         $data = (object)$data;
1574         // Check roleid, userid are one of the mapped ones
1575         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
1576             return;
1577         }
1578         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
1579             return;
1580         }
1581         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
1582             // Only assign roles to not deleted users
1583             return;
1584         }
1585         if (!$contextid = $this->task->get_contextid()) {
1586             return;
1587         }
1589         if (empty($data->component)) {
1590             // assign standard manual roles
1591             // TODO: role_assign() needs one userid param to be able to specify our restore userid
1592             role_assign($newroleid, $newuserid, $contextid);
1594         } else if ((strpos($data->component, 'enrol_') === 0)) {
1595             // Deal with enrolment roles - ignore the component and just find out the instance via new id,
1596             // it is possible that enrolment was restored using different plugin type.
1597             if (!isset($this->plugins)) {
1598                 $this->plugins = enrol_get_plugins(true);
1599             }
1600             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1601                 if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1602                     if (isset($this->plugins[$instance->enrol])) {
1603                         $this->plugins[$instance->enrol]->restore_role_assignment($instance, $newroleid, $newuserid, $contextid);
1604                     }
1605                 }
1606             }
1608         } else {
1609             $data->roleid    = $newroleid;
1610             $data->userid    = $newuserid;
1611             $data->contextid = $contextid;
1612             $dir = core_component::get_component_directory($data->component);
1613             if ($dir and is_dir($dir)) {
1614                 if (component_callback($data->component, 'restore_role_assignment', array($this, $data), true)) {
1615                     return;
1616                 }
1617             }
1618             // Bad luck, plugin could not restore the data, let's add normal membership.
1619             role_assign($data->roleid, $data->userid, $data->contextid);
1620             $message = "Restore of '$data->component/$data->itemid' role assignments is not supported, using manual role assignments instead.";
1621             debugging($message);
1622             $this->log($message, backup::LOG_WARNING);
1623         }
1624     }
1626     public function process_override($data) {
1627         $data = (object)$data;
1629         // Check roleid is one of the mapped ones
1630         $newroleid = $this->get_mappingid('role', $data->roleid);
1631         // If newroleid and context are valid assign it via API (it handles dupes and so on)
1632         if ($newroleid && $this->task->get_contextid()) {
1633             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
1634             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
1635             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
1636         }
1637     }
1640 /**
1641  * If no instances yet add default enrol methods the same way as when creating new course in UI.
1642  */
1643 class restore_default_enrolments_step extends restore_execution_step {
1644     public function define_execution() {
1645         global $DB;
1647         $course = $DB->get_record('course', array('id'=>$this->get_courseid()), '*', MUST_EXIST);
1649         if ($DB->record_exists('enrol', array('courseid'=>$this->get_courseid(), 'enrol'=>'manual'))) {
1650             // Something already added instances, do not add default instances.
1651             $plugins = enrol_get_plugins(true);
1652             foreach ($plugins as $plugin) {
1653                 $plugin->restore_sync_course($course);
1654             }
1656         } else {
1657             // Looks like a newly created course.
1658             enrol_course_updated(true, $course, null);
1659         }
1660     }
1663 /**
1664  * This structure steps restores the enrol plugins and their underlying
1665  * enrolments, performing all the mappings and/or movements required
1666  */
1667 class restore_enrolments_structure_step extends restore_structure_step {
1668     protected $enrolsynced = false;
1669     protected $plugins = null;
1670     protected $originalstatus = array();
1672     /**
1673      * Conditionally decide if this step should be executed.
1674      *
1675      * This function checks the following parameter:
1676      *
1677      *   1. the course/enrolments.xml file exists
1678      *
1679      * @return bool true is safe to execute, false otherwise
1680      */
1681     protected function execute_condition() {
1683         // Check it is included in the backup
1684         $fullpath = $this->task->get_taskbasepath();
1685         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1686         if (!file_exists($fullpath)) {
1687             // Not found, can't restore enrolments info
1688             return false;
1689         }
1691         return true;
1692     }
1694     protected function define_structure() {
1696         $paths = array();
1698         $paths[] = new restore_path_element('enrol', '/enrolments/enrols/enrol');
1699         $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
1701         return $paths;
1702     }
1704     /**
1705      * Create enrolment instances.
1706      *
1707      * This has to be called after creation of roles
1708      * and before adding of role assignments.
1709      *
1710      * @param mixed $data
1711      * @return void
1712      */
1713     public function process_enrol($data) {
1714         global $DB;
1716         $data = (object)$data;
1717         $oldid = $data->id; // We'll need this later.
1718         unset($data->id);
1720         $this->originalstatus[$oldid] = $data->status;
1722         if (!$courserec = $DB->get_record('course', array('id' => $this->get_courseid()))) {
1723             $this->set_mapping('enrol', $oldid, 0);
1724             return;
1725         }
1727         if (!isset($this->plugins)) {
1728             $this->plugins = enrol_get_plugins(true);
1729         }
1731         if (!$this->enrolsynced) {
1732             // Make sure that all plugin may create instances and enrolments automatically
1733             // before the first instance restore - this is suitable especially for plugins
1734             // that synchronise data automatically using course->idnumber or by course categories.
1735             foreach ($this->plugins as $plugin) {
1736                 $plugin->restore_sync_course($courserec);
1737             }
1738             $this->enrolsynced = true;
1739         }
1741         // Map standard fields - plugin has to process custom fields manually.
1742         $data->roleid   = $this->get_mappingid('role', $data->roleid);
1743         $data->courseid = $courserec->id;
1745         if ($this->get_setting_value('enrol_migratetomanual')) {
1746             unset($data->sortorder); // Remove useless sortorder from <2.4 backups.
1747             if (!enrol_is_enabled('manual')) {
1748                 $this->set_mapping('enrol', $oldid, 0);
1749                 return;
1750             }
1751             if ($instances = $DB->get_records('enrol', array('courseid'=>$data->courseid, 'enrol'=>'manual'), 'id')) {
1752                 $instance = reset($instances);
1753                 $this->set_mapping('enrol', $oldid, $instance->id);
1754             } else {
1755                 if ($data->enrol === 'manual') {
1756                     $instanceid = $this->plugins['manual']->add_instance($courserec, (array)$data);
1757                 } else {
1758                     $instanceid = $this->plugins['manual']->add_default_instance($courserec);
1759                 }
1760                 $this->set_mapping('enrol', $oldid, $instanceid);
1761             }
1763         } else {
1764             if (!enrol_is_enabled($data->enrol) or !isset($this->plugins[$data->enrol])) {
1765                 $this->set_mapping('enrol', $oldid, 0);
1766                 $message = "Enrol plugin '$data->enrol' data can not be restored because it is not enabled, use migration to manual enrolments";
1767                 debugging($message);
1768                 $this->log($message, backup::LOG_WARNING);
1769                 return;
1770             }
1771             if ($task = $this->get_task() and $task->get_target() == backup::TARGET_NEW_COURSE) {
1772                 // Let's keep the sortorder in old backups.
1773             } else {
1774                 // Prevent problems with colliding sortorders in old backups,
1775                 // new 2.4 backups do not need sortorder because xml elements are ordered properly.
1776                 unset($data->sortorder);
1777             }
1778             // Note: plugin is responsible for setting up the mapping, it may also decide to migrate to different type.
1779             $this->plugins[$data->enrol]->restore_instance($this, $data, $courserec, $oldid);
1780         }
1781     }
1783     /**
1784      * Create user enrolments.
1785      *
1786      * This has to be called after creation of enrolment instances
1787      * and before adding of role assignments.
1788      *
1789      * Roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing afterwards.
1790      *
1791      * @param mixed $data
1792      * @return void
1793      */
1794     public function process_enrolment($data) {
1795         global $DB;
1797         if (!isset($this->plugins)) {
1798             $this->plugins = enrol_get_plugins(true);
1799         }
1801         $data = (object)$data;
1803         // Process only if parent instance have been mapped.
1804         if ($enrolid = $this->get_new_parentid('enrol')) {
1805             $oldinstancestatus = ENROL_INSTANCE_ENABLED;
1806             $oldenrolid = $this->get_old_parentid('enrol');
1807             if (isset($this->originalstatus[$oldenrolid])) {
1808                 $oldinstancestatus = $this->originalstatus[$oldenrolid];
1809             }
1810             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1811                 // And only if user is a mapped one.
1812                 if ($userid = $this->get_mappingid('user', $data->userid)) {
1813                     if (isset($this->plugins[$instance->enrol])) {
1814                         $this->plugins[$instance->enrol]->restore_user_enrolment($this, $data, $instance, $userid, $oldinstancestatus);
1815                     }
1816                 }
1817             }
1818         }
1819     }
1823 /**
1824  * Make sure the user restoring the course can actually access it.
1825  */
1826 class restore_fix_restorer_access_step extends restore_execution_step {
1827     protected function define_execution() {
1828         global $CFG, $DB;
1830         if (!$userid = $this->task->get_userid()) {
1831             return;
1832         }
1834         if (empty($CFG->restorernewroleid)) {
1835             // Bad luck, no fallback role for restorers specified
1836             return;
1837         }
1839         $courseid = $this->get_courseid();
1840         $context = context_course::instance($courseid);
1842         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1843             // Current user may access the course (admin, category manager or restored teacher enrolment usually)
1844             return;
1845         }
1847         // Try to add role only - we do not need enrolment if user has moodle/course:view or is already enrolled
1848         role_assign($CFG->restorernewroleid, $userid, $context);
1850         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1851             // Extra role is enough, yay!
1852             return;
1853         }
1855         // The last chance is to create manual enrol if it does not exist and and try to enrol the current user,
1856         // hopefully admin selected suitable $CFG->restorernewroleid ...
1857         if (!enrol_is_enabled('manual')) {
1858             return;
1859         }
1860         if (!$enrol = enrol_get_plugin('manual')) {
1861             return;
1862         }
1863         if (!$DB->record_exists('enrol', array('enrol'=>'manual', 'courseid'=>$courseid))) {
1864             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
1865             $fields = array('status'=>ENROL_INSTANCE_ENABLED, 'enrolperiod'=>$enrol->get_config('enrolperiod', 0), 'roleid'=>$enrol->get_config('roleid', 0));
1866             $enrol->add_instance($course, $fields);
1867         }
1869         enrol_try_internal_enrol($courseid, $userid);
1870     }
1874 /**
1875  * This structure steps restores the filters and their configs
1876  */
1877 class restore_filters_structure_step extends restore_structure_step {
1879     protected function define_structure() {
1881         $paths = array();
1883         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
1884         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
1886         return $paths;
1887     }
1889     public function process_active($data) {
1891         $data = (object)$data;
1893         if (strpos($data->filter, 'filter/') === 0) {
1894             $data->filter = substr($data->filter, 7);
1896         } else if (strpos($data->filter, '/') !== false) {
1897             // Unsupported old filter.
1898             return;
1899         }
1901         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1902             return;
1903         }
1904         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
1905     }
1907     public function process_config($data) {
1909         $data = (object)$data;
1911         if (strpos($data->filter, 'filter/') === 0) {
1912             $data->filter = substr($data->filter, 7);
1914         } else if (strpos($data->filter, '/') !== false) {
1915             // Unsupported old filter.
1916             return;
1917         }
1919         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1920             return;
1921         }
1922         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
1923     }
1927 /**
1928  * This structure steps restores the comments
1929  * Note: Cannot use the comments API because defaults to USER->id.
1930  * That should change allowing to pass $userid
1931  */
1932 class restore_comments_structure_step extends restore_structure_step {
1934     protected function define_structure() {
1936         $paths = array();
1938         $paths[] = new restore_path_element('comment', '/comments/comment');
1940         return $paths;
1941     }
1943     public function process_comment($data) {
1944         global $DB;
1946         $data = (object)$data;
1948         // First of all, if the comment has some itemid, ask to the task what to map
1949         $mapping = false;
1950         if ($data->itemid) {
1951             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
1952             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
1953         }
1954         // Only restore the comment if has no mapping OR we have found the matching mapping
1955         if (!$mapping || $data->itemid) {
1956             // Only if user mapping and context
1957             $data->userid = $this->get_mappingid('user', $data->userid);
1958             if ($data->userid && $this->task->get_contextid()) {
1959                 $data->contextid = $this->task->get_contextid();
1960                 // Only if there is another comment with same context/user/timecreated
1961                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
1962                 if (!$DB->record_exists('comments', $params)) {
1963                     $DB->insert_record('comments', $data);
1964                 }
1965             }
1966         }
1967     }
1970 /**
1971  * This structure steps restores the badges and their configs
1972  */
1973 class restore_badges_structure_step extends restore_structure_step {
1975     /**
1976      * Conditionally decide if this step should be executed.
1977      *
1978      * This function checks the following parameters:
1979      *
1980      *   1. Badges and course badges are enabled on the site.
1981      *   2. The course/badges.xml file exists.
1982      *   3. All modules are restorable.
1983      *   4. All modules are marked for restore.
1984      *
1985      * @return bool True is safe to execute, false otherwise
1986      */
1987     protected function execute_condition() {
1988         global $CFG;
1990         // First check is badges and course level badges are enabled on this site.
1991         if (empty($CFG->enablebadges) || empty($CFG->badges_allowcoursebadges)) {
1992             // Disabled, don't restore course badges.
1993             return false;
1994         }
1996         // Check if badges.xml is included in the backup.
1997         $fullpath = $this->task->get_taskbasepath();
1998         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1999         if (!file_exists($fullpath)) {
2000             // Not found, can't restore course badges.
2001             return false;
2002         }
2004         // Check we are able to restore all backed up modules.
2005         if ($this->task->is_missing_modules()) {
2006             return false;
2007         }
2009         // Finally check all modules within the backup are being restored.
2010         if ($this->task->is_excluding_activities()) {
2011             return false;
2012         }
2014         return true;
2015     }
2017     protected function define_structure() {
2018         $paths = array();
2019         $paths[] = new restore_path_element('badge', '/badges/badge');
2020         $paths[] = new restore_path_element('criterion', '/badges/badge/criteria/criterion');
2021         $paths[] = new restore_path_element('parameter', '/badges/badge/criteria/criterion/parameters/parameter');
2022         $paths[] = new restore_path_element('manual_award', '/badges/badge/manual_awards/manual_award');
2024         return $paths;
2025     }
2027     public function process_badge($data) {
2028         global $DB, $CFG;
2030         require_once($CFG->libdir . '/badgeslib.php');
2032         $data = (object)$data;
2033         $data->usercreated = $this->get_mappingid('user', $data->usercreated);
2034         $data->usermodified = $this->get_mappingid('user', $data->usermodified);
2036         // We'll restore the badge image.
2037         $restorefiles = true;
2039         $courseid = $this->get_courseid();
2041         $params = array(
2042                 'name'           => $data->name,
2043                 'description'    => $data->description,
2044                 'timecreated'    => $this->apply_date_offset($data->timecreated),
2045                 'timemodified'   => $this->apply_date_offset($data->timemodified),
2046                 'usercreated'    => $data->usercreated,
2047                 'usermodified'   => $data->usermodified,
2048                 'issuername'     => $data->issuername,
2049                 'issuerurl'      => $data->issuerurl,
2050                 'issuercontact'  => $data->issuercontact,
2051                 'expiredate'     => $this->apply_date_offset($data->expiredate),
2052                 'expireperiod'   => $data->expireperiod,
2053                 'type'           => BADGE_TYPE_COURSE,
2054                 'courseid'       => $courseid,
2055                 'message'        => $data->message,
2056                 'messagesubject' => $data->messagesubject,
2057                 'attachment'     => $data->attachment,
2058                 'notification'   => $data->notification,
2059                 'status'         => BADGE_STATUS_INACTIVE,
2060                 'nextcron'       => $this->apply_date_offset($data->nextcron)
2061         );
2063         $newid = $DB->insert_record('badge', $params);
2064         $this->set_mapping('badge', $data->id, $newid, $restorefiles);
2065     }
2067     public function process_criterion($data) {
2068         global $DB;
2070         $data = (object)$data;
2072         $params = array(
2073                 'badgeid'      => $this->get_new_parentid('badge'),
2074                 'criteriatype' => $data->criteriatype,
2075                 'method'       => $data->method
2076         );
2077         $newid = $DB->insert_record('badge_criteria', $params);
2078         $this->set_mapping('criterion', $data->id, $newid);
2079     }
2081     public function process_parameter($data) {
2082         global $DB, $CFG;
2084         require_once($CFG->libdir . '/badgeslib.php');
2086         $data = (object)$data;
2087         $criteriaid = $this->get_new_parentid('criterion');
2089         // Parameter array that will go to database.
2090         $params = array();
2091         $params['critid'] = $criteriaid;
2093         $oldparam = explode('_', $data->name);
2095         if ($data->criteriatype == BADGE_CRITERIA_TYPE_ACTIVITY) {
2096             $module = $this->get_mappingid('course_module', $oldparam[1]);
2097             $params['name'] = $oldparam[0] . '_' . $module;
2098             $params['value'] = $oldparam[0] == 'module' ? $module : $data->value;
2099         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_COURSE) {
2100             $params['name'] = $oldparam[0] . '_' . $this->get_courseid();
2101             $params['value'] = $oldparam[0] == 'course' ? $this->get_courseid() : $data->value;
2102         } else if ($data->criteriatype == BADGE_CRITERIA_TYPE_MANUAL) {
2103             $role = $this->get_mappingid('role', $data->value);
2104             if (!empty($role)) {
2105                 $params['name'] = 'role_' . $role;
2106                 $params['value'] = $role;
2107             } else {
2108                 return;
2109             }
2110         }
2112         if (!$DB->record_exists('badge_criteria_param', $params)) {
2113             $DB->insert_record('badge_criteria_param', $params);
2114         }
2115     }
2117     public function process_manual_award($data) {
2118         global $DB;
2120         $data = (object)$data;
2121         $role = $this->get_mappingid('role', $data->issuerrole);
2123         if (!empty($role)) {
2124             $award = array(
2125                 'badgeid'     => $this->get_new_parentid('badge'),
2126                 'recipientid' => $this->get_mappingid('user', $data->recipientid),
2127                 'issuerid'    => $this->get_mappingid('user', $data->issuerid),
2128                 'issuerrole'  => $role,
2129                 'datemet'     => $this->apply_date_offset($data->datemet)
2130             );
2131             $DB->insert_record('badge_manual_award', $award);
2132         }
2133     }
2135     protected function after_execute() {
2136         // Add related files.
2137         $this->add_related_files('badges', 'badgeimage', 'badge');
2138     }
2141 /**
2142  * This structure steps restores the calendar events
2143  */
2144 class restore_calendarevents_structure_step extends restore_structure_step {
2146     protected function define_structure() {
2148         $paths = array();
2150         $paths[] = new restore_path_element('calendarevents', '/events/event');
2152         return $paths;
2153     }
2155     public function process_calendarevents($data) {
2156         global $DB, $SITE;
2158         $data = (object)$data;
2159         $oldid = $data->id;
2160         $restorefiles = true; // We'll restore the files
2161         // Find the userid and the groupid associated with the event. Return if not found.
2162         $data->userid = $this->get_mappingid('user', $data->userid);
2163         if ($data->userid === false) {
2164             return;
2165         }
2166         if (!empty($data->groupid)) {
2167             $data->groupid = $this->get_mappingid('group', $data->groupid);
2168             if ($data->groupid === false) {
2169                 return;
2170             }
2171         }
2172         // Handle events with empty eventtype //MDL-32827
2173         if(empty($data->eventtype)) {
2174             if ($data->courseid == $SITE->id) {                                // Site event
2175                 $data->eventtype = "site";
2176             } else if ($data->courseid != 0 && $data->groupid == 0 && ($data->modulename == 'assignment' || $data->modulename == 'assign')) {
2177                 // Course assingment event
2178                 $data->eventtype = "due";
2179             } else if ($data->courseid != 0 && $data->groupid == 0) {      // Course event
2180                 $data->eventtype = "course";
2181             } else if ($data->groupid) {                                      // Group event
2182                 $data->eventtype = "group";
2183             } else if ($data->userid) {                                       // User event
2184                 $data->eventtype = "user";
2185             } else {
2186                 return;
2187             }
2188         }
2190         $params = array(
2191                 'name'           => $data->name,
2192                 'description'    => $data->description,
2193                 'format'         => $data->format,
2194                 'courseid'       => $this->get_courseid(),
2195                 'groupid'        => $data->groupid,
2196                 'userid'         => $data->userid,
2197                 'repeatid'       => $data->repeatid,
2198                 'modulename'     => $data->modulename,
2199                 'eventtype'      => $data->eventtype,
2200                 'timestart'      => $this->apply_date_offset($data->timestart),
2201                 'timeduration'   => $data->timeduration,
2202                 'visible'        => $data->visible,
2203                 'uuid'           => $data->uuid,
2204                 'sequence'       => $data->sequence,
2205                 'timemodified'    => $this->apply_date_offset($data->timemodified));
2206         if ($this->name == 'activity_calendar') {
2207             $params['instance'] = $this->task->get_activityid();
2208         } else {
2209             $params['instance'] = 0;
2210         }
2211         $sql = 'SELECT id FROM {event} WHERE name = ? AND courseid = ? AND
2212                 repeatid = ? AND modulename = ? AND timestart = ? AND timeduration =?
2213                 AND ' . $DB->sql_compare_text('description', 255) . ' = ' . $DB->sql_compare_text('?', 255);
2214         $arg = array ($params['name'], $params['courseid'], $params['repeatid'], $params['modulename'], $params['timestart'], $params['timeduration'], $params['description']);
2215         $result = $DB->record_exists_sql($sql, $arg);
2216         if (empty($result)) {
2217             $newitemid = $DB->insert_record('event', $params);
2218             $this->set_mapping('event_description', $oldid, $newitemid, $restorefiles);
2219         }
2221     }
2222     protected function after_execute() {
2223         // Add related files
2224         $this->add_related_files('calendar', 'event_description', 'event_description');
2225     }
2228 class restore_course_completion_structure_step extends restore_structure_step {
2230     /**
2231      * Conditionally decide if this step should be executed.
2232      *
2233      * This function checks parameters that are not immediate settings to ensure
2234      * that the enviroment is suitable for the restore of course completion info.
2235      *
2236      * This function checks the following four parameters:
2237      *
2238      *   1. Course completion is enabled on the site
2239      *   2. The backup includes course completion information
2240      *   3. All modules are restorable
2241      *   4. All modules are marked for restore.
2242      *
2243      * @return bool True is safe to execute, false otherwise
2244      */
2245     protected function execute_condition() {
2246         global $CFG;
2248         // First check course completion is enabled on this site
2249         if (empty($CFG->enablecompletion)) {
2250             // Disabled, don't restore course completion
2251             return false;
2252         }
2254         // Check it is included in the backup
2255         $fullpath = $this->task->get_taskbasepath();
2256         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2257         if (!file_exists($fullpath)) {
2258             // Not found, can't restore course completion
2259             return false;
2260         }
2262         // Check we are able to restore all backed up modules
2263         if ($this->task->is_missing_modules()) {
2264             return false;
2265         }
2267         // Finally check all modules within the backup are being restored.
2268         if ($this->task->is_excluding_activities()) {
2269             return false;
2270         }
2272         return true;
2273     }
2275     /**
2276      * Define the course completion structure
2277      *
2278      * @return array Array of restore_path_element
2279      */
2280     protected function define_structure() {
2282         // To know if we are including user completion info
2283         $userinfo = $this->get_setting_value('userscompletion');
2285         $paths = array();
2286         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
2287         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
2289         if ($userinfo) {
2290             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
2291             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
2292         }
2294         return $paths;
2296     }
2298     /**
2299      * Process course completion criteria
2300      *
2301      * @global moodle_database $DB
2302      * @param stdClass $data
2303      */
2304     public function process_course_completion_criteria($data) {
2305         global $DB;
2307         $data = (object)$data;
2308         $data->course = $this->get_courseid();
2310         // Apply the date offset to the time end field
2311         $data->timeend = $this->apply_date_offset($data->timeend);
2313         // Map the role from the criteria
2314         if (!empty($data->role)) {
2315             $data->role = $this->get_mappingid('role', $data->role);
2316         }
2318         $skipcriteria = false;
2320         // If the completion criteria is for a module we need to map the module instance
2321         // to the new module id.
2322         if (!empty($data->moduleinstance) && !empty($data->module)) {
2323             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
2324             if (empty($data->moduleinstance)) {
2325                 $skipcriteria = true;
2326             }
2327         } else {
2328             $data->module = null;
2329             $data->moduleinstance = null;
2330         }
2332         // We backup the course shortname rather than the ID so that we can match back to the course
2333         if (!empty($data->courseinstanceshortname)) {
2334             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
2335             if (!$courseinstanceid) {
2336                 $skipcriteria = true;
2337             }
2338         } else {
2339             $courseinstanceid = null;
2340         }
2341         $data->courseinstance = $courseinstanceid;
2343         if (!$skipcriteria) {
2344             $params = array(
2345                 'course'         => $data->course,
2346                 'criteriatype'   => $data->criteriatype,
2347                 'enrolperiod'    => $data->enrolperiod,
2348                 'courseinstance' => $data->courseinstance,
2349                 'module'         => $data->module,
2350                 'moduleinstance' => $data->moduleinstance,
2351                 'timeend'        => $data->timeend,
2352                 'gradepass'      => $data->gradepass,
2353                 'role'           => $data->role
2354             );
2355             $newid = $DB->insert_record('course_completion_criteria', $params);
2356             $this->set_mapping('course_completion_criteria', $data->id, $newid);
2357         }
2358     }
2360     /**
2361      * Processes course compltion criteria complete records
2362      *
2363      * @global moodle_database $DB
2364      * @param stdClass $data
2365      */
2366     public function process_course_completion_crit_compl($data) {
2367         global $DB;
2369         $data = (object)$data;
2371         // This may be empty if criteria could not be restored
2372         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
2374         $data->course = $this->get_courseid();
2375         $data->userid = $this->get_mappingid('user', $data->userid);
2377         if (!empty($data->criteriaid) && !empty($data->userid)) {
2378             $params = array(
2379                 'userid' => $data->userid,
2380                 'course' => $data->course,
2381                 'criteriaid' => $data->criteriaid,
2382                 'timecompleted' => $this->apply_date_offset($data->timecompleted)
2383             );
2384             if (isset($data->gradefinal)) {
2385                 $params['gradefinal'] = $data->gradefinal;
2386             }
2387             if (isset($data->unenroled)) {
2388                 $params['unenroled'] = $data->unenroled;
2389             }
2390             $DB->insert_record('course_completion_crit_compl', $params);
2391         }
2392     }
2394     /**
2395      * Process course completions
2396      *
2397      * @global moodle_database $DB
2398      * @param stdClass $data
2399      */
2400     public function process_course_completions($data) {
2401         global $DB;
2403         $data = (object)$data;
2405         $data->course = $this->get_courseid();
2406         $data->userid = $this->get_mappingid('user', $data->userid);
2408         if (!empty($data->userid)) {
2409             $params = array(
2410                 'userid' => $data->userid,
2411                 'course' => $data->course,
2412                 'timeenrolled' => $this->apply_date_offset($data->timeenrolled),
2413                 'timestarted' => $this->apply_date_offset($data->timestarted),
2414                 'timecompleted' => $this->apply_date_offset($data->timecompleted),
2415                 'reaggregate' => $data->reaggregate
2416             );
2417             $DB->insert_record('course_completions', $params);
2418         }
2419     }
2421     /**
2422      * Process course completion aggregate methods
2423      *
2424      * @global moodle_database $DB
2425      * @param stdClass $data
2426      */
2427     public function process_course_completion_aggr_methd($data) {
2428         global $DB;
2430         $data = (object)$data;
2432         $data->course = $this->get_courseid();
2434         // Only create the course_completion_aggr_methd records if
2435         // the target course has not them defined. MDL-28180
2436         if (!$DB->record_exists('course_completion_aggr_methd', array(
2437                     'course' => $data->course,
2438                     'criteriatype' => $data->criteriatype))) {
2439             $params = array(
2440                 'course' => $data->course,
2441                 'criteriatype' => $data->criteriatype,
2442                 'method' => $data->method,
2443                 'value' => $data->value,
2444             );
2445             $DB->insert_record('course_completion_aggr_methd', $params);
2446         }
2447     }
2451 /**
2452  * This structure step restores course logs (cmid = 0), delegating
2453  * the hard work to the corresponding {@link restore_logs_processor} passing the
2454  * collection of {@link restore_log_rule} rules to be observed as they are defined
2455  * by the task. Note this is only executed based in the 'logs' setting.
2456  *
2457  * NOTE: This is executed by final task, to have all the activities already restored
2458  *
2459  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
2460  * records are. There are others like 'calendar' and 'upload' that will be handled
2461  * later.
2462  *
2463  * NOTE: All the missing actions (not able to be restored) are sent to logs for
2464  * debugging purposes
2465  */
2466 class restore_course_logs_structure_step extends restore_structure_step {
2468     /**
2469      * Conditionally decide if this step should be executed.
2470      *
2471      * This function checks the following parameter:
2472      *
2473      *   1. the course/logs.xml file exists
2474      *
2475      * @return bool true is safe to execute, false otherwise
2476      */
2477     protected function execute_condition() {
2479         // Check it is included in the backup
2480         $fullpath = $this->task->get_taskbasepath();
2481         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2482         if (!file_exists($fullpath)) {
2483             // Not found, can't restore course logs
2484             return false;
2485         }
2487         return true;
2488     }
2490     protected function define_structure() {
2492         $paths = array();
2494         // Simple, one plain level of information contains them
2495         $paths[] = new restore_path_element('log', '/logs/log');
2497         return $paths;
2498     }
2500     protected function process_log($data) {
2501         global $DB;
2503         $data = (object)($data);
2505         $data->time = $this->apply_date_offset($data->time);
2506         $data->userid = $this->get_mappingid('user', $data->userid);
2507         $data->course = $this->get_courseid();
2508         $data->cmid = 0;
2510         // For any reason user wasn't remapped ok, stop processing this
2511         if (empty($data->userid)) {
2512             return;
2513         }
2515         // Everything ready, let's delegate to the restore_logs_processor
2517         // Set some fixed values that will save tons of DB requests
2518         $values = array(
2519             'course' => $this->get_courseid());
2520         // Get instance and process log record
2521         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2523         // If we have data, insert it, else something went wrong in the restore_logs_processor
2524         if ($data) {
2525             $DB->insert_record('log', $data);
2526         }
2527     }
2530 /**
2531  * This structure step restores activity logs, extending {@link restore_course_logs_structure_step}
2532  * sharing its same structure but modifying the way records are handled
2533  */
2534 class restore_activity_logs_structure_step extends restore_course_logs_structure_step {
2536     protected function process_log($data) {
2537         global $DB;
2539         $data = (object)($data);
2541         $data->time = $this->apply_date_offset($data->time);
2542         $data->userid = $this->get_mappingid('user', $data->userid);
2543         $data->course = $this->get_courseid();
2544         $data->cmid = $this->task->get_moduleid();
2546         // For any reason user wasn't remapped ok, stop processing this
2547         if (empty($data->userid)) {
2548             return;
2549         }
2551         // Everything ready, let's delegate to the restore_logs_processor
2553         // Set some fixed values that will save tons of DB requests
2554         $values = array(
2555             'course' => $this->get_courseid(),
2556             'course_module' => $this->task->get_moduleid(),
2557             $this->task->get_modulename() => $this->task->get_activityid());
2558         // Get instance and process log record
2559         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2561         // If we have data, insert it, else something went wrong in the restore_logs_processor
2562         if ($data) {
2563             $DB->insert_record('log', $data);
2564         }
2565     }
2569 /**
2570  * Defines the restore step for advanced grading methods attached to the activity module
2571  */
2572 class restore_activity_grading_structure_step extends restore_structure_step {
2574     /**
2575      * This step is executed only if the grading file is present
2576      */
2577      protected function execute_condition() {
2579         $fullpath = $this->task->get_taskbasepath();
2580         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2581         if (!file_exists($fullpath)) {
2582             return false;
2583         }
2585         return true;
2586     }
2589     /**
2590      * Declares paths in the grading.xml file we are interested in
2591      */
2592     protected function define_structure() {
2594         $paths = array();
2595         $userinfo = $this->get_setting_value('userinfo');
2597         $area = new restore_path_element('grading_area', '/areas/area');
2598         $paths[] = $area;
2599         // attach local plugin stucture to $area element
2600         $this->add_plugin_structure('local', $area);
2602         $definition = new restore_path_element('grading_definition', '/areas/area/definitions/definition');
2603         $paths[] = $definition;
2604         $this->add_plugin_structure('gradingform', $definition);
2605         // attach local plugin stucture to $definition element
2606         $this->add_plugin_structure('local', $definition);
2609         if ($userinfo) {
2610             $instance = new restore_path_element('grading_instance',
2611                 '/areas/area/definitions/definition/instances/instance');
2612             $paths[] = $instance;
2613             $this->add_plugin_structure('gradingform', $instance);
2614             // attach local plugin stucture to $intance element
2615             $this->add_plugin_structure('local', $instance);
2616         }
2618         return $paths;
2619     }
2621     /**
2622      * Processes one grading area element
2623      *
2624      * @param array $data element data
2625      */
2626     protected function process_grading_area($data) {
2627         global $DB;
2629         $task = $this->get_task();
2630         $data = (object)$data;
2631         $oldid = $data->id;
2632         $data->component = 'mod_'.$task->get_modulename();
2633         $data->contextid = $task->get_contextid();
2635         $newid = $DB->insert_record('grading_areas', $data);
2636         $this->set_mapping('grading_area', $oldid, $newid);
2637     }
2639     /**
2640      * Processes one grading definition element
2641      *
2642      * @param array $data element data
2643      */
2644     protected function process_grading_definition($data) {
2645         global $DB;
2647         $task = $this->get_task();
2648         $data = (object)$data;
2649         $oldid = $data->id;
2650         $data->areaid = $this->get_new_parentid('grading_area');
2651         $data->copiedfromid = null;
2652         $data->timecreated = time();
2653         $data->usercreated = $task->get_userid();
2654         $data->timemodified = $data->timecreated;
2655         $data->usermodified = $data->usercreated;
2657         $newid = $DB->insert_record('grading_definitions', $data);
2658         $this->set_mapping('grading_definition', $oldid, $newid, true);
2659     }
2661     /**
2662      * Processes one grading form instance element
2663      *
2664      * @param array $data element data
2665      */
2666     protected function process_grading_instance($data) {
2667         global $DB;
2669         $data = (object)$data;
2671         // new form definition id
2672         $newformid = $this->get_new_parentid('grading_definition');
2674         // get the name of the area we are restoring to
2675         $sql = "SELECT ga.areaname
2676                   FROM {grading_definitions} gd
2677                   JOIN {grading_areas} ga ON gd.areaid = ga.id
2678                  WHERE gd.id = ?";
2679         $areaname = $DB->get_field_sql($sql, array($newformid), MUST_EXIST);
2681         // get the mapped itemid - the activity module is expected to define the mappings
2682         // for each gradable area
2683         $newitemid = $this->get_mappingid(restore_gradingform_plugin::itemid_mapping($areaname), $data->itemid);
2685         $oldid = $data->id;
2686         $data->definitionid = $newformid;
2687         $data->raterid = $this->get_mappingid('user', $data->raterid);
2688         $data->itemid = $newitemid;
2690         $newid = $DB->insert_record('grading_instances', $data);
2691         $this->set_mapping('grading_instance', $oldid, $newid);
2692     }
2694     /**
2695      * Final operations when the database records are inserted
2696      */
2697     protected function after_execute() {
2698         // Add files embedded into the definition description
2699         $this->add_related_files('grading', 'description', 'grading_definition');
2700     }
2704 /**
2705  * This structure step restores the grade items associated with one activity
2706  * All the grade items are made child of the "course" grade item but the original
2707  * categoryid is saved as parentitemid in the backup_ids table, so, when restoring
2708  * the complete gradebook (categories and calculations), that information is
2709  * available there
2710  */
2711 class restore_activity_grades_structure_step extends restore_structure_step {
2713     protected function define_structure() {
2715         $paths = array();
2716         $userinfo = $this->get_setting_value('userinfo');
2718         $paths[] = new restore_path_element('grade_item', '/activity_gradebook/grade_items/grade_item');
2719         $paths[] = new restore_path_element('grade_letter', '/activity_gradebook/grade_letters/grade_letter');
2720         if ($userinfo) {
2721             $paths[] = new restore_path_element('grade_grade',
2722                            '/activity_gradebook/grade_items/grade_item/grade_grades/grade_grade');
2723         }
2724         return $paths;
2725     }
2727     protected function process_grade_item($data) {
2728         global $DB;
2730         $data = (object)($data);
2731         $oldid       = $data->id;        // We'll need these later
2732         $oldparentid = $data->categoryid;
2733         $courseid = $this->get_courseid();
2735         // make sure top course category exists, all grade items will be associated
2736         // to it. Later, if restoring the whole gradebook, categories will be introduced
2737         $coursecat = grade_category::fetch_course_category($courseid);
2738         $coursecatid = $coursecat->id; // Get the categoryid to be used
2740         $idnumber = null;
2741         if (!empty($data->idnumber)) {
2742             // Don't get any idnumber from course module. Keep them as they are in grade_item->idnumber
2743             // Reason: it's not clear what happens with outcomes->idnumber or activities with multiple items (workshop)
2744             // so the best is to keep the ones already in the gradebook
2745             // Potential problem: duplicates if same items are restored more than once. :-(
2746             // This needs to be fixed in some way (outcomes & activities with multiple items)
2747             // $data->idnumber     = get_coursemodule_from_instance($data->itemmodule, $data->iteminstance)->idnumber;
2748             // In any case, verify always for uniqueness
2749             $sql = "SELECT cm.id
2750                       FROM {course_modules} cm
2751                      WHERE cm.course = :courseid AND
2752                            cm.idnumber = :idnumber AND
2753                            cm.id <> :cmid";
2754             $params = array(
2755                 'courseid' => $courseid,
2756                 'idnumber' => $data->idnumber,
2757                 'cmid' => $this->task->get_moduleid()
2758             );
2759             if (!$DB->record_exists_sql($sql, $params) && !$DB->record_exists('grade_items', array('courseid' => $courseid, 'idnumber' => $data->idnumber))) {
2760                 $idnumber = $data->idnumber;
2761             }
2762         }
2764         unset($data->id);
2765         $data->categoryid   = $coursecatid;
2766         $data->courseid     = $this->get_courseid();
2767         $data->iteminstance = $this->task->get_activityid();
2768         $data->idnumber     = $idnumber;
2769         $data->scaleid      = $this->get_mappingid('scale', $data->scaleid);
2770         $data->outcomeid    = $this->get_mappingid('outcome', $data->outcomeid);
2771         $data->timecreated  = $this->apply_date_offset($data->timecreated);
2772         $data->timemodified = $this->apply_date_offset($data->timemodified);
2774         $gradeitem = new grade_item($data, false);
2775         $gradeitem->insert('restore');
2777         //sortorder is automatically assigned when inserting. Re-instate the previous sortorder
2778         $gradeitem->sortorder = $data->sortorder;
2779         $gradeitem->update('restore');
2781         // Set mapping, saving the original category id into parentitemid
2782         // gradebook restore (final task) will need it to reorganise items
2783         $this->set_mapping('grade_item', $oldid, $gradeitem->id, false, null, $oldparentid);
2784     }
2786     protected function process_grade_grade($data) {
2787         $data = (object)($data);
2788         $olduserid = $data->userid;
2789         unset($data->id);
2791         $data->itemid = $this->get_new_parentid('grade_item');
2793         $data->userid = $this->get_mappingid('user', $data->userid, null);
2794         if (!empty($data->userid)) {
2795             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
2796             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
2797             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
2798             $data->overridden = $this->apply_date_offset($data->overridden);
2800             $grade = new grade_grade($data, false);
2801             $grade->insert('restore');
2802             // no need to save any grade_grade mapping
2803         } else {
2804             debugging("Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'");
2805         }
2806     }
2808     /**
2809      * process activity grade_letters. Note that, while these are possible,
2810      * because grade_letters are contextid based, in practice, only course
2811      * context letters can be defined. So we keep here this method knowing
2812      * it won't be executed ever. gradebook restore will restore course letters.
2813      */
2814     protected function process_grade_letter($data) {
2815         global $DB;
2817         $data['contextid'] = $this->task->get_contextid();
2818         $gradeletter = (object)$data;
2820         // Check if it exists before adding it
2821         unset($data['id']);
2822         if (!$DB->record_exists('grade_letters', $data)) {
2823             $newitemid = $DB->insert_record('grade_letters', $gradeletter);
2824         }
2825         // no need to save any grade_letter mapping
2826     }
2830 /**
2831  * This structure steps restores one instance + positions of one block
2832  * Note: Positions corresponding to one existing context are restored
2833  * here, but all the ones having unknown contexts are sent to backup_ids
2834  * for a later chance to be restored at the end (final task)
2835  */
2836 class restore_block_instance_structure_step extends restore_structure_step {
2838     protected function define_structure() {
2840         $paths = array();
2842         $paths[] = new restore_path_element('block', '/block', true); // Get the whole XML together
2843         $paths[] = new restore_path_element('block_position', '/block/block_positions/block_position');
2845         return $paths;
2846     }
2848     public function process_block($data) {
2849         global $DB, $CFG;
2851         $data = (object)$data; // Handy
2852         $oldcontextid = $data->contextid;
2853         $oldid        = $data->id;
2854         $positions = isset($data->block_positions['block_position']) ? $data->block_positions['block_position'] : array();
2856         // Look for the parent contextid
2857         if (!$data->parentcontextid = $this->get_mappingid('context', $data->parentcontextid)) {
2858             throw new restore_step_exception('restore_block_missing_parent_ctx', $data->parentcontextid);
2859         }
2861         // TODO: it would be nice to use standard plugin supports instead of this instance_allow_multiple()
2862         // If there is already one block of that type in the parent context
2863         // and the block is not multiple, stop processing
2864         // Use blockslib loader / method executor
2865         if (!$bi = block_instance($data->blockname)) {
2866             return false;
2867         }
2869         if (!$bi->instance_allow_multiple()) {
2870             if ($DB->record_exists_sql("SELECT bi.id
2871                                           FROM {block_instances} bi
2872                                           JOIN {block} b ON b.name = bi.blockname
2873                                          WHERE bi.parentcontextid = ?
2874                                            AND bi.blockname = ?", array($data->parentcontextid, $data->blockname))) {
2875                 return false;
2876             }
2877         }
2879         // If there is already one block of that type in the parent context
2880         // with the same showincontexts, pagetypepattern, subpagepattern, defaultregion and configdata
2881         // stop processing
2882         $params = array(
2883             'blockname' => $data->blockname, 'parentcontextid' => $data->parentcontextid,
2884             'showinsubcontexts' => $data->showinsubcontexts, 'pagetypepattern' => $data->pagetypepattern,
2885             'subpagepattern' => $data->subpagepattern, 'defaultregion' => $data->defaultregion);
2886         if ($birecs = $DB->get_records('block_instances', $params)) {
2887             foreach($birecs as $birec) {
2888                 if ($birec->configdata == $data->configdata) {
2889                     return false;
2890                 }
2891             }
2892         }
2894         // Set task old contextid, blockid and blockname once we know them
2895         $this->task->set_old_contextid($oldcontextid);
2896         $this->task->set_old_blockid($oldid);
2897         $this->task->set_blockname($data->blockname);
2899         // Let's look for anything within configdata neededing processing
2900         // (nulls and uses of legacy file.php)
2901         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
2902             $configdata = (array)unserialize(base64_decode($data->configdata));
2903             foreach ($configdata as $attribute => $value) {
2904                 if (in_array($attribute, $attrstotransform)) {
2905                     $configdata[$attribute] = $this->contentprocessor->process_cdata($value);
2906                 }
2907             }
2908             $data->configdata = base64_encode(serialize((object)$configdata));
2909         }
2911         // Create the block instance
2912         $newitemid = $DB->insert_record('block_instances', $data);
2913         // Save the mapping (with restorefiles support)
2914         $this->set_mapping('block_instance', $oldid, $newitemid, true);
2915         // Create the block context
2916         $newcontextid = context_block::instance($newitemid)->id;
2917         // Save the block contexts mapping and sent it to task
2918         $this->set_mapping('context', $oldcontextid, $newcontextid);
2919         $this->task->set_contextid($newcontextid);
2920         $this->task->set_blockid($newitemid);
2922         // Restore block fileareas if declared
2923         $component = 'block_' . $this->task->get_blockname();
2924         foreach ($this->task->get_fileareas() as $filearea) { // Simple match by contextid. No itemname needed
2925             $this->add_related_files($component, $filearea, null);
2926         }
2928         // Process block positions, creating them or accumulating for final step
2929         foreach($positions as $position) {
2930             $position = (object)$position;
2931             $position->blockinstanceid = $newitemid; // The instance is always the restored one
2932             // If position is for one already mapped (known) contextid
2933             // process it now, creating the position
2934             if ($newpositionctxid = $this->get_mappingid('context', $position->contextid)) {
2935                 $position->contextid = $newpositionctxid;
2936                 // Create the block position
2937                 $DB->insert_record('block_positions', $position);
2939             // The position belongs to an unknown context, send it to backup_ids
2940             // to process them as part of the final steps of restore. We send the
2941             // whole $position object there, hence use the low level method.
2942             } else {
2943                 restore_dbops::set_backup_ids_record($this->get_restoreid(), 'block_position', $position->id, 0, null, $position);
2944             }
2945         }
2946     }
2949 /**
2950  * Structure step to restore common course_module information
2951  *
2952  * This step will process the module.xml file for one activity, in order to restore
2953  * the corresponding information to the course_modules table, skipping various bits
2954  * of information based on CFG settings (groupings, completion...) in order to fullfill
2955  * all the reqs to be able to create the context to be used by all the rest of steps
2956  * in the activity restore task
2957  */
2958 class restore_module_structure_step extends restore_structure_step {
2960     protected function define_structure() {
2961         global $CFG;
2963         $paths = array();
2965         $module = new restore_path_element('module', '/module');
2966         $paths[] = $module;
2967         if ($CFG->enableavailability) {
2968             $paths[] = new restore_path_element('availability', '/module/availability_info/availability');
2969             $paths[] = new restore_path_element('availability_field', '/module/availability_info/availability_field');
2970         }
2972         // Apply for 'format' plugins optional paths at module level
2973         $this->add_plugin_structure('format', $module);
2975         // Apply for 'plagiarism' plugins optional paths at module level
2976         $this->add_plugin_structure('plagiarism', $module);
2978         // Apply for 'local' plugins optional paths at module level
2979         $this->add_plugin_structure('local', $module);
2981         return $paths;
2982     }
2984     protected function process_module($data) {
2985         global $CFG, $DB;
2987         $data = (object)$data;
2988         $oldid = $data->id;
2989         $this->task->set_old_moduleversion($data->version);
2991         $data->course = $this->task->get_courseid();
2992         $data->module = $DB->get_field('modules', 'id', array('name' => $data->modulename));
2993         // Map section (first try by course_section mapping match. Useful in course and section restores)
2994         $data->section = $this->get_mappingid('course_section', $data->sectionid);
2995         if (!$data->section) { // mapping failed, try to get section by sectionnumber matching
2996             $params = array(
2997                 'course' => $this->get_courseid(),
2998                 'section' => $data->sectionnumber);
2999             $data->section = $DB->get_field('course_sections', 'id', $params);
3000         }
3001         if (!$data->section) { // sectionnumber failed, try to get first section in course
3002             $params = array(
3003                 'course' => $this->get_courseid());
3004             $data->section = $DB->get_field('course_sections', 'MIN(id)', $params);
3005         }
3006         if (!$data->section) { // no sections in course, create section 0 and 1 and assign module to 1
3007             $sectionrec = array(
3008                 'course' => $this->get_courseid(),
3009                 'section' => 0);
3010             $DB->insert_record('course_sections', $sectionrec); // section 0
3011             $sectionrec = array(
3012                 'course' => $this->get_courseid(),
3013                 'section' => 1);
3014             $data->section = $DB->insert_record('course_sections', $sectionrec); // section 1
3015         }
3016         $data->groupingid= $this->get_mappingid('grouping', $data->groupingid);      // grouping
3017         if (!$CFG->enablegroupmembersonly) {                                         // observe groupsmemberonly
3018             $data->groupmembersonly = 0;
3019         }
3020         if (!grade_verify_idnumber($data->idnumber, $this->get_courseid())) {        // idnumber uniqueness
3021             $data->idnumber = '';
3022         }
3023         if (empty($CFG->enablecompletion)) { // completion
3024             $data->completion = 0;
3025             $data->completiongradeitemnumber = null;
3026             $data->completionview = 0;
3027             $data->completionexpected = 0;
3028         } else {
3029             $data->completionexpected = $this->apply_date_offset($data->completionexpected);
3030         }
3031         if (empty($CFG->enableavailability)) {
3032             $data->availablefrom = 0;
3033             $data->availableuntil = 0;
3034             $data->showavailability = 0;
3035         } else {
3036             $data->availablefrom = $this->apply_date_offset($data->availablefrom);
3037             $data->availableuntil= $this->apply_date_offset($data->availableuntil);
3038         }
3039         // Backups that did not include showdescription, set it to default 0
3040         // (this is not totally necessary as it has a db default, but just to
3041         // be explicit).
3042         if (!isset($data->showdescription)) {
3043             $data->showdescription = 0;
3044         }
3045         $data->instance = 0; // Set to 0 for now, going to create it soon (next step)
3047         // course_module record ready, insert it
3048         $newitemid = $DB->insert_record('course_modules', $data);
3049         // save mapping
3050         $this->set_mapping('course_module', $oldid, $newitemid);
3051         // set the new course_module id in the task
3052         $this->task->set_moduleid($newitemid);
3053         // we can now create the context safely
3054         $ctxid = context_module::instance($newitemid)->id;
3055         // set the new context id in the task
3056         $this->task->set_contextid($ctxid);
3057         // update sequence field in course_section
3058         if ($sequence = $DB->get_field('course_sections', 'sequence', array('id' => $data->section))) {
3059             $sequence .= ',' . $newitemid;
3060         } else {
3061             $sequence = $newitemid;
3062         }
3063         $DB->set_field('course_sections', 'sequence', $sequence, array('id' => $data->section));
3064     }
3066     protected function process_availability($data) {
3067         $data = (object)$data;
3068         // Simply going to store the whole availability record now, we'll process
3069         // all them later in the final task (once all activities have been restored)
3070         // Let's call the low level one to be able to store the whole object
3071         $data->coursemoduleid = $this->task->get_moduleid(); // Let add the availability cmid
3072         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'module_availability', $data->id, 0, null, $data);
3073     }
3075     protected function process_availability_field($data) {
3076         global $DB;
3077         $data = (object)$data;
3078         // Mark it is as passed by default
3079         $passed = true;
3080         $customfieldid = null;
3082         // If a customfield has been used in order to pass we must be able to match an existing
3083         // customfield by name (data->customfield) and type (data->customfieldtype)
3084         if (!empty($data->customfield) xor !empty($data->customfieldtype)) {
3085             // xor is sort of uncommon. If either customfield is null or customfieldtype is null BUT not both.
3086             // If one is null but the other isn't something clearly went wrong and we'll skip this condition.
3087             $passed = false;
3088         } else if (!empty($data->customfield)) {
3089             $params = array('shortname' => $data->customfield, 'datatype' => $data->customfieldtype);
3090             $customfieldid = $DB->get_field('user_info_field', 'id', $params);
3091             $passed = ($customfieldid !== false);
3092         }
3094         if ($passed) {
3095             // Create the object to insert into the database
3096             $availfield = new stdClass();
3097             $availfield->coursemoduleid = $this->task->get_moduleid(); // Lets add the availability cmid
3098             $availfield->userfield = $data->userfield;
3099             $availfield->customfieldid = $customfieldid;
3100             $availfield->operator = $data->operator;
3101             $availfield->value = $data->value;
3102             // Insert into the database
3103             $DB->insert_record('course_modules_avail_fields', $availfield);
3104         }
3105     }
3108 /**
3109  * Structure step that will process the user activity completion
3110  * information if all these conditions are met:
3111  *  - Target site has completion enabled ($CFG->enablecompletion)
3112  *  - Activity includes completion info (file_exists)
3113  */
3114 class restore_userscompletion_structure_step extends restore_structure_step {
3115     /**
3116      * To conditionally decide if this step must be executed
3117      * Note the "settings" conditions are evaluated in the
3118      * corresponding task. Here we check for other conditions
3119      * not being restore settings (files, site settings...)
3120      */
3121      protected function execute_condition() {
3122          global $CFG;
3124          // Completion disabled in this site, don't execute
3125          if (empty($CFG->enablecompletion)) {
3126              return false;
3127          }
3129          // No user completion info found, don't execute
3130         $fullpath = $this->task->get_taskbasepath();
3131         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
3132          if (!file_exists($fullpath)) {
3133              return false;
3134          }
3136          // Arrived here, execute the step
3137          return true;
3138      }
3140      protected function define_structure() {
3142         $paths = array();
3144         $paths[] = new restore_path_element('completion', '/completions/completion');
3146         return $paths;
3147     }
3149     protected function process_completion($data) {
3150         global $DB;
3152         $data = (object)$data;
3154         $data->coursemoduleid = $this->task->get_moduleid();
3155         $data->userid = $this->get_mappingid('user', $data->userid);
3156         $data->timemodified = $this->apply_date_offset($data->timemodified);
3158         // Find the existing record
3159         $existing = $DB->get_record('course_modules_completion', array(
3160                 'coursemoduleid' => $data->coursemoduleid,
3161                 'userid' => $data->userid), 'id, timemodified');
3162         // Check we didn't already insert one for this cmid and userid
3163         // (there aren't supposed to be duplicates in that field, but
3164         // it was possible until MDL-28021 was fixed).
3165         if ($existing) {
3166             // Update it to these new values, but only if the time is newer
3167             if ($existing->timemodified < $data->timemodified) {
3168                 $data->id = $existing->id;
3169                 $DB->update_record('course_modules_completion', $data);
3170             }
3171         } else {
3172             // Normal entry where it doesn't exist already
3173             $DB->insert_record('course_modules_completion', $data);
3174         }
3175     }
3178 /**
3179  * Abstract structure step, parent of all the activity structure steps. Used to suuport
3180  * the main <activity ...> tag and process it. Also provides subplugin support for
3181  * activities.
3182  */
3183 abstract class restore_activity_structure_step extends restore_structure_step {
3185     protected function add_subplugin_structure($subplugintype, $element) {
3187         global $CFG;
3189         // Check the requested subplugintype is a valid one
3190         $subpluginsfile = $CFG->dirroot . '/mod/' . $this->task->get_modulename() . '/db/subplugins.php';
3191         if (!file_exists($subpluginsfile)) {
3192              throw new restore_step_exception('activity_missing_subplugins_php_file', $this->task->get_modulename());
3193         }
3194         include($subpluginsfile);
3195         if (!array_key_exists($subplugintype, $subplugins)) {
3196              throw new restore_step_exception('incorrect_subplugin_type', $subplugintype);
3197         }
3198         // Get all the restore path elements, looking across all the subplugin dirs
3199         $subpluginsdirs = core_component::get_plugin_list($subplugintype);
3200         foreach ($subpluginsdirs as $name => $subpluginsdir) {
3201             $classname = 'restore_' . $subplugintype . '_' . $name . '_subplugin';
3202             $restorefile = $subpluginsdir . '/backup/moodle2/' . $classname . '.class.php';
3203             if (file_exists($restorefile)) {
3204                 require_once($restorefile);
3205                 $restoresubplugin = new $classname($subplugintype, $name, $this);
3206                 // Add subplugin paths to the step
3207                 $this->prepare_pathelements($restoresubplugin->define_subplugin_structure($element));
3208             }
3209         }
3210     }
3212     /**
3213      * As far as activity restore steps are implementing restore_subplugin stuff, they need to
3214      * have the parent task available for wrapping purposes (get course/context....)
3215      * @return restore_task
3216      */
3217     public function get_task() {
3218         return $this->task;
3219     }
3221     /**
3222      * Adds support for the 'activity' path that is common to all the activities
3223      * and will be processed globally here
3224      */
3225     protected function prepare_activity_structure($paths) {
3227         $paths[] = new restore_path_element('activity', '/activity');
3229         return $paths;
3230     }
3232     /**
3233      * Process the activity path, informing the task about various ids, needed later
3234      */
3235     protected function process_activity($data) {
3236         $data = (object)$data;
3237         $this->task->set_old_contextid($data->contextid); // Save old contextid in task
3238         $this->set_mapping('context', $data->contextid, $this->task->get_contextid()); // Set the mapping
3239         $this->task->set_old_activityid($data->id); // Save old activityid in task
3240     }
3242     /**
3243      * This must be invoked immediately after creating the "module" activity record (forum, choice...)
3244      * and will adjust the new activity id (the instance) in various places
3245      */
3246     protected function apply_activity_instance($newitemid) {
3247         global $DB;
3249         $this->task->set_activityid($newitemid); // Save activity id in task
3250         // Apply the id to course_sections->instanceid
3251         $DB->set_field('course_modules', 'instance', $newitemid, array('id' => $this->task->get_moduleid()));
3252         // Do the mapping for modulename, preparing it for files by oldcontext
3253         $modulename = $this->task->get_modulename();
3254         $oldid = $this->task->get_old_activityid();
3255         $this->set_mapping($modulename, $oldid, $newitemid, true);
3256     }
3259 /**
3260  * Structure step in charge of creating/mapping all the qcats and qs
3261  * by parsing the questions.xml file and checking it against the
3262  * results cal