Merge branch 'MDL-37165-23' of git://github.com/damyon/moodle into MOODLE_23_STABLE
[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 = get_context_instance(CONTEXT_COURSE, $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 = get_context_instance(CONTEXT_SYSTEM)->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         } else if ($data->itemtype=='course') {
154             // course grade item stores their category id in iteminstance
155             $coursecat = grade_category::fetch_course_category($this->get_courseid());
156             $data->iteminstance = $coursecat->id;
157         } else if ($data->itemtype=='category') {
158             // category grade items store their category id in iteminstance
159             $data->iteminstance = $this->get_mappingid('grade_category', $data->iteminstance, NULL);
160         } else {
161             throw new restore_step_exception('unexpected_grade_item_type', $data->itemtype);
162         }
164         $data->scaleid   = $this->get_mappingid('scale', $data->scaleid, NULL);
165         $data->outcomeid = $this->get_mappingid('outcome', $data->outcomeid, NULL);
167         $data->locktime     = $this->apply_date_offset($data->locktime);
168         $data->timecreated  = $this->apply_date_offset($data->timecreated);
169         $data->timemodified = $this->apply_date_offset($data->timemodified);
171         $coursecategory = $newitemid = null;
172         //course grade item should already exist so updating instead of inserting
173         if($data->itemtype=='course') {
174             //get the ID of the already created grade item
175             $gi = new stdclass();
176             $gi->courseid  = $this->get_courseid();
177             $gi->itemtype  = $data->itemtype;
179             //need to get the id of the grade_category that was automatically created for the course
180             $category = new stdclass();
181             $category->courseid  = $this->get_courseid();
182             $category->parent  = null;
183             //course category fullname starts out as ? but may be edited
184             //$category->fullname  = '?';
185             $coursecategory = $DB->get_record('grade_categories', (array)$category);
186             $gi->iteminstance = $coursecategory->id;
188             $existinggradeitem = $DB->get_record('grade_items', (array)$gi);
189             if (!empty($existinggradeitem)) {
190                 $data->id = $newitemid = $existinggradeitem->id;
191                 $DB->update_record('grade_items', $data);
192             }
193         } else if ($data->itemtype == 'manual') {
194             // Manual items aren't assigned to a cm, so don't go duplicating them in the target if one exists.
195             $gi = array(
196                 'itemtype' => $data->itemtype,
197                 'courseid' => $data->courseid,
198                 'itemname' => $data->itemname,
199                 'categoryid' => $data->categoryid,
200             );
201             $newitemid = $DB->get_field('grade_items', 'id', $gi);
202         }
204         if (empty($newitemid)) {
205             //in case we found the course category but still need to insert the course grade item
206             if ($data->itemtype=='course' && !empty($coursecategory)) {
207                 $data->iteminstance = $coursecategory->id;
208             }
210             $newitemid = $DB->insert_record('grade_items', $data);
211         }
212         $this->set_mapping('grade_item', $oldid, $newitemid);
213     }
215     protected function process_grade_grade($data) {
216         global $DB;
218         $data = (object)$data;
219         $olduserid = $data->userid;
221         $data->itemid = $this->get_new_parentid('grade_item');
223         $data->userid = $this->get_mappingid('user', $data->userid, null);
224         if (!empty($data->userid)) {
225             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
226             $data->locktime     = $this->apply_date_offset($data->locktime);
227             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
228             $data->overridden = $this->apply_date_offset($data->overridden);
229             $data->timecreated  = $this->apply_date_offset($data->timecreated);
230             $data->timemodified = $this->apply_date_offset($data->timemodified);
232             $newitemid = $DB->insert_record('grade_grades', $data);
233         } else {
234             debugging("Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'");
235         }
236     }
238     protected function process_grade_category($data) {
239         global $DB;
241         $data = (object)$data;
242         $oldid = $data->id;
244         $data->course = $this->get_courseid();
245         $data->courseid = $data->course;
247         $data->timecreated  = $this->apply_date_offset($data->timecreated);
248         $data->timemodified = $this->apply_date_offset($data->timemodified);
250         $newitemid = null;
251         //no parent means a course level grade category. That may have been created when the course was created
252         if(empty($data->parent)) {
253             //parent was being saved as 0 when it should be null
254             $data->parent = null;
256             //get the already created course level grade category
257             $category = new stdclass();
258             $category->courseid = $this->get_courseid();
259             $category->parent = null;
261             $coursecategory = $DB->get_record('grade_categories', (array)$category);
262             if (!empty($coursecategory)) {
263                 $data->id = $newitemid = $coursecategory->id;
264                 $DB->update_record('grade_categories', $data);
265             }
266         }
268         //need to insert a course category
269         if (empty($newitemid)) {
270             $newitemid = $DB->insert_record('grade_categories', $data);
271         }
272         $this->set_mapping('grade_category', $oldid, $newitemid);
273     }
274     protected function process_grade_letter($data) {
275         global $DB;
277         $data = (object)$data;
278         $oldid = $data->id;
280         $data->contextid = get_context_instance(CONTEXT_COURSE, $this->get_courseid())->id;
282         $gradeletter = (array)$data;
283         unset($gradeletter['id']);
284         if (!$DB->record_exists('grade_letters', $gradeletter)) {
285             $newitemid = $DB->insert_record('grade_letters', $data);
286         } else {
287             $newitemid = $data->id;
288         }
290         $this->set_mapping('grade_letter', $oldid, $newitemid);
291     }
292     protected function process_grade_setting($data) {
293         global $DB;
295         $data = (object)$data;
296         $oldid = $data->id;
298         $data->courseid = $this->get_courseid();
300         $newitemid = $DB->insert_record('grade_settings', $data);
301         //$this->set_mapping('grade_setting', $oldid, $newitemid);
302     }
304     /**
305      * put all activity grade items in the correct grade category and mark all for recalculation
306      */
307     protected function after_execute() {
308         global $DB;
310         $conditions = array(
311             'backupid' => $this->get_restoreid(),
312             'itemname' => 'grade_item'//,
313             //'itemid'   => $itemid
314         );
315         $rs = $DB->get_recordset('backup_ids_temp', $conditions);
317         // We need this for calculation magic later on.
318         $mappings = array();
320         if (!empty($rs)) {
321             foreach($rs as $grade_item_backup) {
323                 // Store the oldid with the new id.
324                 $mappings[$grade_item_backup->itemid] = $grade_item_backup->newitemid;
326                 $updateobj = new stdclass();
327                 $updateobj->id = $grade_item_backup->newitemid;
329                 //if this is an activity grade item that needs to be put back in its correct category
330                 if (!empty($grade_item_backup->parentitemid)) {
331                     $oldcategoryid = $this->get_mappingid('grade_category', $grade_item_backup->parentitemid, null);
332                     if (!is_null($oldcategoryid)) {
333                         $updateobj->categoryid = $oldcategoryid;
334                         $DB->update_record('grade_items', $updateobj);
335                     }
336                 } else {
337                     //mark course and category items as needing to be recalculated
338                     $updateobj->needsupdate=1;
339                     $DB->update_record('grade_items', $updateobj);
340                 }
341             }
342         }
343         $rs->close();
345         // We need to update the calculations for calculated grade items that may reference old
346         // grade item ids using ##gi\d+##.
347         // $mappings can be empty, use 0 if so (won't match ever)
348         list($sql, $params) = $DB->get_in_or_equal(array_values($mappings), SQL_PARAMS_NAMED, 'param', true, 0);
349         $sql = "SELECT gi.id, gi.calculation
350                   FROM {grade_items} gi
351                  WHERE gi.id {$sql} AND
352                        calculation IS NOT NULL";
353         $rs = $DB->get_recordset_sql($sql, $params);
354         foreach ($rs as $gradeitem) {
355             // Collect all of the used grade item id references
356             if (preg_match_all('/##gi(\d+)##/', $gradeitem->calculation, $matches) < 1) {
357                 // This calculation doesn't reference any other grade items... EASY!
358                 continue;
359             }
360             // For this next bit we are going to do the replacement of id's in two steps:
361             // 1. We will replace all old id references with a special mapping reference.
362             // 2. We will replace all mapping references with id's
363             // Why do we do this?
364             // Because there potentially there will be an overlap of ids within the query and we
365             // we substitute the wrong id.. safest way around this is the two step system
366             $calculationmap = array();
367             $mapcount = 0;
368             foreach ($matches[1] as $match) {
369                 // Check that the old id is known to us, if not it was broken to begin with and will
370                 // continue to be broken.
371                 if (!array_key_exists($match, $mappings)) {
372                     continue;
373                 }
374                 // Our special mapping key
375                 $mapping = '##MAPPING'.$mapcount.'##';
376                 // The old id that exists within the calculation now
377                 $oldid = '##gi'.$match.'##';
378                 // The new id that we want to replace the old one with.
379                 $newid = '##gi'.$mappings[$match].'##';
380                 // Replace in the special mapping key
381                 $gradeitem->calculation = str_replace($oldid, $mapping, $gradeitem->calculation);
382                 // And record the mapping
383                 $calculationmap[$mapping] = $newid;
384                 $mapcount++;
385             }
386             // Iterate all special mappings for this calculation and replace in the new id's
387             foreach ($calculationmap as $mapping => $newid) {
388                 $gradeitem->calculation = str_replace($mapping, $newid, $gradeitem->calculation);
389             }
390             // Update the calculation now that its being remapped
391             $DB->update_record('grade_items', $gradeitem);
392         }
393         $rs->close();
395         // Need to correct the grade category path and parent
396         $conditions = array(
397             'courseid' => $this->get_courseid()
398         );
400         $rs = $DB->get_recordset('grade_categories', $conditions);
401         // Get all the parents correct first as grade_category::build_path() loads category parents from the DB
402         foreach ($rs as $gc) {
403             if (!empty($gc->parent)) {
404                 $grade_category = new stdClass();
405                 $grade_category->id = $gc->id;
406                 $grade_category->parent = $this->get_mappingid('grade_category', $gc->parent);
407                 $DB->update_record('grade_categories', $grade_category);
408             }
409         }
410         $rs->close();
412         // Now we can rebuild all the paths
413         $rs = $DB->get_recordset('grade_categories', $conditions);
414         foreach ($rs as $gc) {
415             $grade_category = new stdClass();
416             $grade_category->id = $gc->id;
417             $grade_category->path = grade_category::build_path($gc);
418             $grade_category->depth = substr_count($grade_category->path, '/') - 1;
419             $DB->update_record('grade_categories', $grade_category);
420         }
421         $rs->close();
423         // Restore marks items as needing update. Update everything now.
424         grade_regrade_final_grades($this->get_courseid());
425     }
428 /**
429  * decode all the interlinks present in restored content
430  * relying 100% in the restore_decode_processor that handles
431  * both the contents to modify and the rules to be applied
432  */
433 class restore_decode_interlinks extends restore_execution_step {
435     protected function define_execution() {
436         // Get the decoder (from the plan)
437         $decoder = $this->task->get_decoder();
438         restore_decode_processor::register_link_decoders($decoder); // Add decoder contents and rules
439         // And launch it, everything will be processed
440         $decoder->execute();
441     }
444 /**
445  * first, ensure that we have no gaps in section numbers
446  * and then, rebuid the course cache
447  */
448 class restore_rebuild_course_cache extends restore_execution_step {
450     protected function define_execution() {
451         global $DB;
453         // Although there is some sort of auto-recovery of missing sections
454         // present in course/formats... here we check that all the sections
455         // from 0 to MAX(section->section) exist, creating them if necessary
456         $maxsection = $DB->get_field('course_sections', 'MAX(section)', array('course' => $this->get_courseid()));
457         // Iterate over all sections
458         for ($i = 0; $i <= $maxsection; $i++) {
459             // If the section $i doesn't exist, create it
460             if (!$DB->record_exists('course_sections', array('course' => $this->get_courseid(), 'section' => $i))) {
461                 $sectionrec = array(
462                     'course' => $this->get_courseid(),
463                     'section' => $i);
464                 $DB->insert_record('course_sections', $sectionrec); // missing section created
465             }
466         }
468         // Rebuild cache now that all sections are in place
469         rebuild_course_cache($this->get_courseid());
470     }
473 /**
474  * Review all the tasks having one after_restore method
475  * executing it to perform some final adjustments of information
476  * not available when the task was executed.
477  */
478 class restore_execute_after_restore extends restore_execution_step {
480     protected function define_execution() {
482         // Simply call to the execute_after_restore() method of the task
483         // that always is the restore_final_task
484         $this->task->launch_execute_after_restore();
485     }
489 /**
490  * Review all the (pending) block positions in backup_ids, matching by
491  * contextid, creating positions as needed. This is executed by the
492  * final task, once all the contexts have been created
493  */
494 class restore_review_pending_block_positions extends restore_execution_step {
496     protected function define_execution() {
497         global $DB;
499         // Get all the block_position objects pending to match
500         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
501         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid');
502         // Process block positions, creating them or accumulating for final step
503         foreach($rs as $posrec) {
504             // Get the complete position object (stored as info)
505             $position = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'block_position', $posrec->itemid)->info;
506             // If position is for one already mapped (known) contextid
507             // process it now, creating the position, else nothing to
508             // do, position finally discarded
509             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
510                 $position->contextid = $newctx->newitemid;
511                 // Create the block position
512                 $DB->insert_record('block_positions', $position);
513             }
514         }
515         $rs->close();
516     }
519 /**
520  * Process all the saved module availability records in backup_ids, matching
521  * course modules and grade item id once all them have been already restored.
522  * only if all matchings are satisfied the availability condition will be created.
523  * At the same time, it is required for the site to have that functionality enabled.
524  */
525 class restore_process_course_modules_availability extends restore_execution_step {
527     protected function define_execution() {
528         global $CFG, $DB;
530         // Site hasn't availability enabled
531         if (empty($CFG->enableavailability)) {
532             return;
533         }
535         // Get all the module_availability objects to process
536         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'module_availability');
537         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid');
538         // Process availabilities, creating them if everything matches ok
539         foreach($rs as $availrec) {
540             $allmatchesok = true;
541             // Get the complete availabilityobject
542             $availability = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'module_availability', $availrec->itemid)->info;
543             // Map the sourcecmid if needed and possible
544             if (!empty($availability->sourcecmid)) {
545                 $newcm = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'course_module', $availability->sourcecmid);
546                 if ($newcm) {
547                     $availability->sourcecmid = $newcm->newitemid;
548                 } else {
549                     $allmatchesok = false; // Failed matching, we won't create this availability rule
550                 }
551             }
552             // Map the gradeitemid if needed and possible
553             if (!empty($availability->gradeitemid)) {
554                 $newgi = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'grade_item', $availability->gradeitemid);
555                 if ($newgi) {
556                     $availability->gradeitemid = $newgi->newitemid;
557                 } else {
558                     $allmatchesok = false; // Failed matching, we won't create this availability rule
559                 }
560             }
561             if ($allmatchesok) { // Everything ok, create the availability rule
562                 $DB->insert_record('course_modules_availability', $availability);
563             }
564         }
565         $rs->close();
566     }
570 /*
571  * Execution step that, *conditionally* (if there isn't preloaded information)
572  * will load the inforef files for all the included course/section/activity tasks
573  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
574  */
575 class restore_load_included_inforef_records extends restore_execution_step {
577     protected function define_execution() {
579         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
580             return;
581         }
583         // Get all the included tasks
584         $tasks = restore_dbops::get_included_tasks($this->get_restoreid());
585         foreach ($tasks as $task) {
586             // Load the inforef.xml file if exists
587             $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
588             if (file_exists($inforefpath)) {
589                 restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $inforefpath); // Load each inforef file to temp_ids
590             }
591         }
592     }
595 /*
596  * Execution step that will load all the needed files into backup_files_temp
597  *   - info: contains the whole original object (times, names...)
598  * (all them being original ids as loaded from xml)
599  */
600 class restore_load_included_files extends restore_structure_step {
602     protected function define_structure() {
604         $file = new restore_path_element('file', '/files/file');
606         return array($file);
607     }
609     /**
610      * Process one <file> element from files.xml
611      *
612      * @param array $data the element data
613      */
614     public function process_file($data) {
616         $data = (object)$data; // handy
618         // load it if needed:
619         //   - it it is one of the annotated inforef files (course/section/activity/block)
620         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
621         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
622         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
623         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
624         $iscomponent = ($data->component == 'user' || $data->component == 'group' ||
625                         $data->component == 'grouping' || $data->component == 'grade' ||
626                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
627         if ($isfileref || $iscomponent) {
628             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
629         }
630     }
633 /**
634  * Execution step that, *conditionally* (if there isn't preloaded information),
635  * will load all the needed roles to backup_temp_ids. They will be stored with
636  * "role" itemname. Also it will perform one automatic mapping to roles existing
637  * in the target site, based in permissions of the user performing the restore,
638  * archetypes and other bits. At the end, each original role will have its associated
639  * target role or 0 if it's going to be skipped. Note we wrap everything over one
640  * restore_dbops method, as far as the same stuff is going to be also executed
641  * by restore prechecks
642  */
643 class restore_load_and_map_roles extends restore_execution_step {
645     protected function define_execution() {
646         if ($this->task->get_preloaded_information()) { // if info is already preloaded
647             return;
648         }
650         $file = $this->get_basepath() . '/roles.xml';
651         // Load needed toles to temp_ids
652         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
654         // Process roles, mapping/skipping. Any error throws exception
655         // Note we pass controller's info because it can contain role mapping information
656         // about manual mappings performed by UI
657         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);
658     }
661 /**
662  * Execution step that, *conditionally* (if there isn't preloaded information
663  * and users have been selected in settings, will load all the needed users
664  * to backup_temp_ids. They will be stored with "user" itemname and with
665  * their original contextid as paremitemid
666  */
667 class restore_load_included_users extends restore_execution_step {
669     protected function define_execution() {
671         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
672             return;
673         }
674         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
675             return;
676         }
677         $file = $this->get_basepath() . '/users.xml';
678         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file); // Load needed users to temp_ids
679     }
682 /**
683  * Execution step that, *conditionally* (if there isn't preloaded information
684  * and users have been selected in settings, will process all the needed users
685  * in order to decide and perform any action with them (create / map / error)
686  * Note: Any error will cause exception, as far as this is the same processing
687  * than the one into restore prechecks (that should have stopped process earlier)
688  */
689 class restore_process_included_users extends restore_execution_step {
691     protected function define_execution() {
693         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
694             return;
695         }
696         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
697             return;
698         }
699         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
700     }
703 /**
704  * Execution step that will create all the needed users as calculated
705  * by @restore_process_included_users (those having newiteind = 0)
706  */
707 class restore_create_included_users extends restore_execution_step {
709     protected function define_execution() {
711         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(), $this->task->get_userid());
712     }
715 /**
716  * Structure step that will create all the needed groups and groupings
717  * by loading them from the groups.xml file performing the required matches.
718  * Note group members only will be added if restoring user info
719  */
720 class restore_groups_structure_step extends restore_structure_step {
722     protected function define_structure() {
724         $paths = array(); // Add paths here
726         $paths[] = new restore_path_element('group', '/groups/group');
727         if ($this->get_setting_value('users')) {
728             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
729         }
730         $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
731         $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
733         return $paths;
734     }
736     // Processing functions go here
737     public function process_group($data) {
738         global $DB;
740         $data = (object)$data; // handy
741         $data->courseid = $this->get_courseid();
743         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
744         // another a group in the same course
745         $context = context_course::instance($data->courseid);
746         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
747             if (groups_get_group_by_idnumber($data->courseid, $data->idnumber)) {
748                 unset($data->idnumber);
749             }
750         } else {
751             unset($data->idnumber);
752         }
754         $oldid = $data->id;    // need this saved for later
756         $restorefiles = false; // Only if we end creating the group
758         // Search if the group already exists (by name & description) in the target course
759         $description_clause = '';
760         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
761         if (!empty($data->description)) {
762             $description_clause = ' AND ' .
763                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
764            $params['description'] = $data->description;
765         }
766         if (!$groupdb = $DB->get_record_sql("SELECT *
767                                                FROM {groups}
768                                               WHERE courseid = :courseid
769                                                 AND name = :grname $description_clause", $params)) {
770             // group doesn't exist, create
771             $newitemid = $DB->insert_record('groups', $data);
772             $restorefiles = true; // We'll restore the files
773         } else {
774             // group exists, use it
775             $newitemid = $groupdb->id;
776         }
777         // Save the id mapping
778         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
779     }
781     public function process_member($data) {
782         global $DB;
784         $data = (object)$data; // handy
786         // get parent group->id
787         $data->groupid = $this->get_new_parentid('group');
789         // map user newitemid and insert if not member already
790         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
791             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
792                 $DB->insert_record('groups_members', $data);
793             }
794         }
795     }
797     public function process_grouping($data) {
798         global $DB;
800         $data = (object)$data; // handy
801         $data->courseid = $this->get_courseid();
803         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
804         // another a grouping in the same course
805         $context = context_course::instance($data->courseid);
806         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
807             if (groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) {
808                 unset($data->idnumber);
809             }
810         } else {
811             unset($data->idnumber);
812         }
814         $oldid = $data->id;    // need this saved for later
815         $restorefiles = false; // Only if we end creating the grouping
817         // Search if the grouping already exists (by name & description) in the target course
818         $description_clause = '';
819         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
820         if (!empty($data->description)) {
821             $description_clause = ' AND ' .
822                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
823            $params['description'] = $data->description;
824         }
825         if (!$groupingdb = $DB->get_record_sql("SELECT *
826                                                   FROM {groupings}
827                                                  WHERE courseid = :courseid
828                                                    AND name = :grname $description_clause", $params)) {
829             // grouping doesn't exist, create
830             $newitemid = $DB->insert_record('groupings', $data);
831             $restorefiles = true; // We'll restore the files
832         } else {
833             // grouping exists, use it
834             $newitemid = $groupingdb->id;
835         }
836         // Save the id mapping
837         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
838     }
840     public function process_grouping_group($data) {
841         global $DB;
843         $data = (object)$data;
845         $data->groupingid = $this->get_new_parentid('grouping'); // Use new parentid
846         $data->groupid    = $this->get_mappingid('group', $data->groupid); // Get from mappings
848         $params = array();
849         $params['groupingid'] = $data->groupingid;
850         $params['groupid']    = $data->groupid;
852         if (!$DB->record_exists('groupings_groups', $params)) {
853             $DB->insert_record('groupings_groups', $data);  // No need to set this mapping (no child info nor files)
854         }
855     }
857     protected function after_execute() {
858         // Add group related files, matching with "group" mappings
859         $this->add_related_files('group', 'icon', 'group');
860         $this->add_related_files('group', 'description', 'group');
861         // Add grouping related files, matching with "grouping" mappings
862         $this->add_related_files('grouping', 'description', 'grouping');
863     }
867 /**
868  * Structure step that will create all the needed scales
869  * by loading them from the scales.xml
870  */
871 class restore_scales_structure_step extends restore_structure_step {
873     protected function define_structure() {
875         $paths = array(); // Add paths here
876         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
877         return $paths;
878     }
880     protected function process_scale($data) {
881         global $DB;
883         $data = (object)$data;
885         $restorefiles = false; // Only if we end creating the group
887         $oldid = $data->id;    // need this saved for later
889         // Look for scale (by 'scale' both in standard (course=0) and current course
890         // with priority to standard scales (ORDER clause)
891         // scale is not course unique, use get_record_sql to suppress warning
892         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
893         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
894         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
895         if (!$scadb = $DB->get_record_sql("SELECT *
896                                             FROM {scale}
897                                            WHERE courseid IN (0, :courseid)
898                                              AND $compare_scale_clause
899                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
900             // Remap the user if possible, defaut to user performing the restore if not
901             $userid = $this->get_mappingid('user', $data->userid);
902             $data->userid = $userid ? $userid : $this->task->get_userid();
903             // Remap the course if course scale
904             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
905             // If global scale (course=0), check the user has perms to create it
906             // falling to course scale if not
907             $systemctx = get_context_instance(CONTEXT_SYSTEM);
908             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
909                 $data->courseid = $this->get_courseid();
910             }
911             // scale doesn't exist, create
912             $newitemid = $DB->insert_record('scale', $data);
913             $restorefiles = true; // We'll restore the files
914         } else {
915             // scale exists, use it
916             $newitemid = $scadb->id;
917         }
918         // Save the id mapping (with files support at system context)
919         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
920     }
922     protected function after_execute() {
923         // Add scales related files, matching with "scale" mappings
924         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
925     }
929 /**
930  * Structure step that will create all the needed outocomes
931  * by loading them from the outcomes.xml
932  */
933 class restore_outcomes_structure_step extends restore_structure_step {
935     protected function define_structure() {
937         $paths = array(); // Add paths here
938         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
939         return $paths;
940     }
942     protected function process_outcome($data) {
943         global $DB;
945         $data = (object)$data;
947         $restorefiles = false; // Only if we end creating the group
949         $oldid = $data->id;    // need this saved for later
951         // Look for outcome (by shortname both in standard (courseid=null) and current course
952         // with priority to standard outcomes (ORDER clause)
953         // outcome is not course unique, use get_record_sql to suppress warning
954         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
955         if (!$outdb = $DB->get_record_sql('SELECT *
956                                              FROM {grade_outcomes}
957                                             WHERE shortname = :shortname
958                                               AND (courseid = :courseid OR courseid IS NULL)
959                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
960             // Remap the user
961             $userid = $this->get_mappingid('user', $data->usermodified);
962             $data->usermodified = $userid ? $userid : $this->task->get_userid();
963             // Remap the scale
964             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
965             // Remap the course if course outcome
966             $data->courseid = $data->courseid ? $this->get_courseid() : null;
967             // If global outcome (course=null), check the user has perms to create it
968             // falling to course outcome if not
969             $systemctx = get_context_instance(CONTEXT_SYSTEM);
970             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
971                 $data->courseid = $this->get_courseid();
972             }
973             // outcome doesn't exist, create
974             $newitemid = $DB->insert_record('grade_outcomes', $data);
975             $restorefiles = true; // We'll restore the files
976         } else {
977             // scale exists, use it
978             $newitemid = $outdb->id;
979         }
980         // Set the corresponding grade_outcomes_courses record
981         $outcourserec = new stdclass();
982         $outcourserec->courseid  = $this->get_courseid();
983         $outcourserec->outcomeid = $newitemid;
984         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
985             $DB->insert_record('grade_outcomes_courses', $outcourserec);
986         }
987         // Save the id mapping (with files support at system context)
988         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
989     }
991     protected function after_execute() {
992         // Add outcomes related files, matching with "outcome" mappings
993         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
994     }
997 /**
998  * Execution step that, *conditionally* (if there isn't preloaded information
999  * will load all the question categories and questions (header info only)
1000  * to backup_temp_ids. They will be stored with "question_category" and
1001  * "question" itemnames and with their original contextid and question category
1002  * id as paremitemids
1003  */
1004 class restore_load_categories_and_questions extends restore_execution_step {
1006     protected function define_execution() {
1008         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1009             return;
1010         }
1011         $file = $this->get_basepath() . '/questions.xml';
1012         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
1013     }
1016 /**
1017  * Execution step that, *conditionally* (if there isn't preloaded information)
1018  * will process all the needed categories and questions
1019  * in order to decide and perform any action with them (create / map / error)
1020  * Note: Any error will cause exception, as far as this is the same processing
1021  * than the one into restore prechecks (that should have stopped process earlier)
1022  */
1023 class restore_process_categories_and_questions extends restore_execution_step {
1025     protected function define_execution() {
1027         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1028             return;
1029         }
1030         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
1031     }
1034 /**
1035  * Structure step that will read the section.xml creating/updating sections
1036  * as needed, rebuilding course cache and other friends
1037  */
1038 class restore_section_structure_step extends restore_structure_step {
1040     protected function define_structure() {
1041         global $CFG;
1043         $paths = array();
1045         $section = new restore_path_element('section', '/section');
1046         $paths[] = $section;
1047         if ($CFG->enableavailability) {
1048             $paths[] = new restore_path_element('availability', '/section/availability');
1049         }
1051         // Apply for 'format' plugins optional paths at section level
1052         $this->add_plugin_structure('format', $section);
1054         return $paths;
1055     }
1057     public function process_section($data) {
1058         global $CFG, $DB;
1059         $data = (object)$data;
1060         $oldid = $data->id; // We'll need this later
1062         $restorefiles = false;
1064         // Look for the section
1065         $section = new stdclass();
1066         $section->course  = $this->get_courseid();
1067         $section->section = $data->number;
1068         // Section doesn't exist, create it with all the info from backup
1069         if (!$secrec = $DB->get_record('course_sections', (array)$section)) {
1070             $section->name = $data->name;
1071             $section->summary = $data->summary;
1072             $section->summaryformat = $data->summaryformat;
1073             $section->sequence = '';
1074             $section->visible = $data->visible;
1075             if (empty($CFG->enableavailability)) { // Process availability information only if enabled.
1076                 $section->availablefrom = 0;
1077                 $section->availableuntil = 0;
1078                 $section->showavailability = 0;
1079             } else {
1080                 $section->availablefrom = isset($data->availablefrom) ? $this->apply_date_offset($data->availablefrom) : 0;
1081                 $section->availableuntil = isset($data->availableuntil) ? $this->apply_date_offset($data->availableuntil) : 0;
1082                 $section->showavailability = isset($data->showavailability) ? $data->showavailability : 0;
1083             }
1084             if (!empty($CFG->enablegroupmembersonly)) { // Only if enablegroupmembersonly is enabled
1085                 $section->groupingid = isset($data->groupingid) ? $this->get_mappingid('grouping', $data->groupingid) : 0;
1086             }
1087             $newitemid = $DB->insert_record('course_sections', $section);
1088             $restorefiles = true;
1090         // Section exists, update non-empty information
1091         } else {
1092             $section->id = $secrec->id;
1093             if ((string)$secrec->name === '') {
1094                 $section->name = $data->name;
1095             }
1096             if (empty($secrec->summary)) {
1097                 $section->summary = $data->summary;
1098                 $section->summaryformat = $data->summaryformat;
1099                 $restorefiles = true;
1100             }
1101             if (empty($secrec->groupingid)) {
1102                 if (!empty($CFG->enablegroupmembersonly)) { // Only if enablegroupmembersonly is enabled
1103                     $section->groupingid = isset($data->groupingid) ? $this->get_mappingid('grouping', $data->groupingid) : 0;
1104                 }
1105             }
1107             // Don't update available from, available until, or show availability
1108             // (I didn't see a useful way to define whether existing or new one should
1109             // take precedence).
1111             $DB->update_record('course_sections', $section);
1112             $newitemid = $secrec->id;
1113         }
1115         // Annotate the section mapping, with restorefiles option if needed
1116         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
1118         // set the new course_section id in the task
1119         $this->task->set_sectionid($newitemid);
1122         // Commented out. We never modify course->numsections as far as that is used
1123         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
1124         // Note: We keep the code here, to know about and because of the possibility of making this
1125         // optional based on some setting/attribute in the future
1126         // If needed, adjust course->numsections
1127         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
1128         //    if ($numsections < $section->section) {
1129         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
1130         //    }
1131         //}
1132     }
1134     public function process_availability($data) {
1135         global $DB;
1136         $data = (object)$data;
1138         $data->coursesectionid = $this->task->get_sectionid();
1140         // NOTE: Other values in $data need updating, but these (cm,
1141         // grade items) have not yet been restored, so are done later.
1143         $newid = $DB->insert_record('course_sections_availability', $data);
1145         // We do not need to map between old and new id but storing a mapping
1146         // means it gets added to the backup_ids table to record which ones
1147         // need updating. The mapping is stored with $newid => $newid for
1148         // convenience.
1149         $this->set_mapping('course_sections_availability', $newid, $newid);
1150     }
1152     protected function after_execute() {
1153         // Add section related files, with 'course_section' itemid to match
1154         $this->add_related_files('course', 'section', 'course_section');
1155     }
1157     public function after_restore() {
1158         global $DB;
1160         $sectionid = $this->get_task()->get_sectionid();
1162         // Get data object for current section availability (if any).
1163         $data = $DB->get_record('course_sections_availability',
1164                 array('coursesectionid' => $sectionid), 'id, sourcecmid, gradeitemid', IGNORE_MISSING);
1166         // If it exists, update mappings.
1167         if ($data) {
1168             // Only update mappings for entries which are created by this restore.
1169             // Otherwise, when you restore to an existing course, it will mess up
1170             // existing section availability entries.
1171             if (!$this->get_mappingid('course_sections_availability', $data->id, false)) {
1172                 return;
1173             }
1175             // Update source cmid / grade id to new value.
1176             $data->sourcecmid = $this->get_mappingid('course_module', $data->sourcecmid);
1177             if (!$data->sourcecmid) {
1178                 $data->sourcecmid = null;
1179             }
1180             $data->gradeitemid = $this->get_mappingid('grade_item', $data->gradeitemid);
1181             if (!$data->gradeitemid) {
1182                 $data->gradeitemid = null;
1183             }
1185             $DB->update_record('course_sections_availability', $data);
1186         }
1187     }
1191 /**
1192  * Structure step that will read the course.xml file, loading it and performing
1193  * various actions depending of the site/restore settings. Note that target
1194  * course always exist before arriving here so this step will be updating
1195  * the course record (never inserting)
1196  */
1197 class restore_course_structure_step extends restore_structure_step {
1198     /**
1199      * @var bool this gets set to true by {@link process_course()} if we are
1200      * restoring an old coures that used the legacy 'module security' feature.
1201      * If so, we have to do more work in {@link after_execute()}.
1202      */
1203     protected $legacyrestrictmodules = false;
1205     /**
1206      * @var array Used when {@link $legacyrestrictmodules} is true. This is an
1207      * array with array keys the module names ('forum', 'quiz', etc.). These are
1208      * the modules that are allowed according to the data in the backup file.
1209      * In {@link after_execute()} we then have to prevent adding of all the other
1210      * types of activity.
1211      */
1212     protected $legacyallowedmodules = array();
1214     protected function define_structure() {
1216         $course = new restore_path_element('course', '/course');
1217         $category = new restore_path_element('category', '/course/category');
1218         $tag = new restore_path_element('tag', '/course/tags/tag');
1219         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1221         // Apply for 'format' plugins optional paths at course level
1222         $this->add_plugin_structure('format', $course);
1224         // Apply for 'theme' plugins optional paths at course level
1225         $this->add_plugin_structure('theme', $course);
1227         // Apply for 'report' plugins optional paths at course level
1228         $this->add_plugin_structure('report', $course);
1230         // Apply for 'course report' plugins optional paths at course level
1231         $this->add_plugin_structure('coursereport', $course);
1233         // Apply for plagiarism plugins optional paths at course level
1234         $this->add_plugin_structure('plagiarism', $course);
1236         return array($course, $category, $tag, $allowed_module);
1237     }
1239     /**
1240      * Processing functions go here
1241      *
1242      * @global moodledatabase $DB
1243      * @param stdClass $data
1244      */
1245     public function process_course($data) {
1246         global $CFG, $DB;
1248         $data = (object)$data;
1250         $fullname  = $this->get_setting_value('course_fullname');
1251         $shortname = $this->get_setting_value('course_shortname');
1252         $startdate = $this->get_setting_value('course_startdate');
1254         // Calculate final course names, to avoid dupes
1255         list($fullname, $shortname) = restore_dbops::calculate_course_names($this->get_courseid(), $fullname, $shortname);
1257         // Need to change some fields before updating the course record
1258         $data->id = $this->get_courseid();
1259         $data->fullname = $fullname;
1260         $data->shortname= $shortname;
1262         $context = get_context_instance_by_id($this->task->get_contextid());
1263         if (has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1264             $data->idnumber = '';
1265         } else {
1266             unset($data->idnumber);
1267         }
1269         // Any empty value for course->hiddensections will lead to 0 (default, show collapsed).
1270         // It has been reported that some old 1.9 courses may have it null leading to DB error. MDL-31532
1271         if (empty($data->hiddensections)) {
1272             $data->hiddensections = 0;
1273         }
1275         // Set legacyrestrictmodules to true if the course was resticting modules. If so
1276         // then we will need to process restricted modules after execution.
1277         $this->legacyrestrictmodules = !empty($data->restrictmodules);
1279         $data->startdate= $this->apply_date_offset($data->startdate);
1280         if ($data->defaultgroupingid) {
1281             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1282         }
1283         if (empty($CFG->enablecompletion)) {
1284             $data->enablecompletion = 0;
1285             $data->completionstartonenrol = 0;
1286             $data->completionnotify = 0;
1287         }
1288         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1289         if (!array_key_exists($data->lang, $languages)) {
1290             $data->lang = '';
1291         }
1293         $themes = get_list_of_themes(); // Get themes for quick search later
1294         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1295             $data->theme = '';
1296         }
1298         // Course record ready, update it
1299         $DB->update_record('course', $data);
1301         // Role name aliases
1302         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1303     }
1305     public function process_category($data) {
1306         // Nothing to do with the category. UI sets it before restore starts
1307     }
1309     public function process_tag($data) {
1310         global $CFG, $DB;
1312         $data = (object)$data;
1314         if (!empty($CFG->usetags)) { // if enabled in server
1315             // TODO: This is highly inneficient. Each time we add one tag
1316             // we fetch all the existing because tag_set() deletes them
1317             // so everything must be reinserted on each call
1318             $tags = array();
1319             $existingtags = tag_get_tags('course', $this->get_courseid());
1320             // Re-add all the existitng tags
1321             foreach ($existingtags as $existingtag) {
1322                 $tags[] = $existingtag->rawname;
1323             }
1324             // Add the one being restored
1325             $tags[] = $data->rawname;
1326             // Send all the tags back to the course
1327             tag_set('course', $this->get_courseid(), $tags);
1328         }
1329     }
1331     public function process_allowed_module($data) {
1332         $data = (object)$data;
1334         // Backwards compatiblity support for the data that used to be in the
1335         // course_allowed_modules table.
1336         if ($this->legacyrestrictmodules) {
1337             $this->legacyallowedmodules[$data->modulename] = 1;
1338         }
1339     }
1341     protected function after_execute() {
1342         global $DB;
1344         // Add course related files, without itemid to match
1345         $this->add_related_files('course', 'summary', null);
1346         $this->add_related_files('course', 'legacy', null);
1348         // Deal with legacy allowed modules.
1349         if ($this->legacyrestrictmodules) {
1350             $context = context_course::instance($this->get_courseid());
1352             list($roleids) = get_roles_with_cap_in_context($context, 'moodle/course:manageactivities');
1353             list($managerroleids) = get_roles_with_cap_in_context($context, 'moodle/site:config');
1354             foreach ($managerroleids as $roleid) {
1355                 unset($roleids[$roleid]);
1356             }
1358             foreach (get_plugin_list('mod') as $modname => $notused) {
1359                 if (isset($this->legacyallowedmodules[$modname])) {
1360                     // Module is allowed, no worries.
1361                     continue;
1362                 }
1364                 $capability = 'mod/' . $modname . ':addinstance';
1365                 foreach ($roleids as $roleid) {
1366                     assign_capability($capability, CAP_PREVENT, $roleid, $context);
1367                 }
1368             }
1369         }
1370     }
1374 /*
1375  * Structure step that will read the roles.xml file (at course/activity/block levels)
1376  * containig all the role_assignments and overrides for that context. If corresponding to
1377  * one mapped role, they will be applied to target context. Will observe the role_assignments
1378  * setting to decide if ras are restored.
1379  * Note: only ras with component == null are restored as far as the any ra with component
1380  * is handled by one enrolment plugin, hence it will createt the ras later
1381  */
1382 class restore_ras_and_caps_structure_step extends restore_structure_step {
1384     protected function define_structure() {
1386         $paths = array();
1388         // Observe the role_assignments setting
1389         if ($this->get_setting_value('role_assignments')) {
1390             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
1391         }
1392         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
1394         return $paths;
1395     }
1397     /**
1398      * Assign roles
1399      *
1400      * This has to be called after enrolments processing.
1401      *
1402      * @param mixed $data
1403      * @return void
1404      */
1405     public function process_assignment($data) {
1406         global $DB;
1408         $data = (object)$data;
1410         // Check roleid, userid are one of the mapped ones
1411         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
1412             return;
1413         }
1414         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
1415             return;
1416         }
1417         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
1418             // Only assign roles to not deleted users
1419             return;
1420         }
1421         if (!$contextid = $this->task->get_contextid()) {
1422             return;
1423         }
1425         if (empty($data->component)) {
1426             // assign standard manual roles
1427             // TODO: role_assign() needs one userid param to be able to specify our restore userid
1428             role_assign($newroleid, $newuserid, $contextid);
1430         } else if ((strpos($data->component, 'enrol_') === 0)) {
1431             // Deal with enrolment roles
1432             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1433                 if ($component = $DB->get_field('enrol', 'component', array('id'=>$enrolid))) {
1434                     //note: we have to verify component because it might have changed
1435                     if ($component === 'enrol_manual') {
1436                         // manual is a special case, we do not use components - this owudl happen when converting from other plugin
1437                         role_assign($newroleid, $newuserid, $contextid); //TODO: do we need modifierid?
1438                     } else {
1439                         role_assign($newroleid, $newuserid, $contextid, $component, $enrolid); //TODO: do we need modifierid?
1440                     }
1441                 }
1442             }
1443         }
1444     }
1446     public function process_override($data) {
1447         $data = (object)$data;
1449         // Check roleid is one of the mapped ones
1450         $newroleid = $this->get_mappingid('role', $data->roleid);
1451         // If newroleid and context are valid assign it via API (it handles dupes and so on)
1452         if ($newroleid && $this->task->get_contextid()) {
1453             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
1454             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
1455             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
1456         }
1457     }
1460 /**
1461  * This structure steps restores the enrol plugins and their underlying
1462  * enrolments, performing all the mappings and/or movements required
1463  */
1464 class restore_enrolments_structure_step extends restore_structure_step {
1466     /**
1467      * Conditionally decide if this step should be executed.
1468      *
1469      * This function checks the following parameter:
1470      *
1471      *   1. the course/enrolments.xml file exists
1472      *
1473      * @return bool true is safe to execute, false otherwise
1474      */
1475     protected function execute_condition() {
1477         // Check it is included in the backup
1478         $fullpath = $this->task->get_taskbasepath();
1479         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1480         if (!file_exists($fullpath)) {
1481             // Not found, can't restore enrolments info
1482             return false;
1483         }
1485         return true;
1486     }
1488     protected function define_structure() {
1490         $paths = array();
1492         $paths[] = new restore_path_element('enrol', '/enrolments/enrols/enrol');
1493         $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
1495         return $paths;
1496     }
1498     /**
1499      * Create enrolment instances.
1500      *
1501      * This has to be called after creation of roles
1502      * and before adding of role assignments.
1503      *
1504      * @param mixed $data
1505      * @return void
1506      */
1507     public function process_enrol($data) {
1508         global $DB;
1510         $data = (object)$data;
1511         $oldid = $data->id; // We'll need this later
1513         $restoretype = plugin_supports('enrol', $data->enrol, ENROL_RESTORE_TYPE, null);
1515         if ($restoretype !== ENROL_RESTORE_EXACT and $restoretype !== ENROL_RESTORE_NOUSERS) {
1516             // TODO: add complex restore support via custom class
1517             debugging("Skipping '{$data->enrol}' enrolment plugin. Will be implemented before 2.0 release", DEBUG_DEVELOPER);
1518             $this->set_mapping('enrol', $oldid, 0);
1519             return;
1520         }
1522         // Perform various checks to decide what to do with the enrol plugin
1523         if (!array_key_exists($data->enrol, enrol_get_plugins(false))) {
1524             // TODO: decide if we want to switch to manual enrol - we need UI for this
1525             debugging("Enrol plugin data can not be restored because it is not installed");
1526             $this->set_mapping('enrol', $oldid, 0);
1527             return;
1529         }
1530         if (!enrol_is_enabled($data->enrol)) {
1531             // TODO: decide if we want to switch to manual enrol - we need UI for this
1532             debugging("Enrol plugin data can not be restored because it is not enabled");
1533             $this->set_mapping('enrol', $oldid, 0);
1534             return;
1535         }
1537         // map standard fields - plugin has to process custom fields from own restore class
1538         $data->roleid = $this->get_mappingid('role', $data->roleid);
1539         //TODO: should we move the enrol start and end date here?
1541         // always add instance, if the course does not support multiple instances it just returns NULL
1542         $enrol = enrol_get_plugin($data->enrol);
1543         $courserec = $DB->get_record('course', array('id' => $this->get_courseid())); // Requires object, uses only id!!
1544         if ($newitemid = $enrol->add_instance($courserec, (array)$data)) {
1545             // ok
1546         } else {
1547             if ($instances = $DB->get_records('enrol', array('courseid'=>$courserec->id, 'enrol'=>$data->enrol))) {
1548                 // most probably plugin that supports only one instance
1549                 $newitemid = key($instances);
1550             } else {
1551                 debugging('Can not create new enrol instance or reuse existing');
1552                 $newitemid = 0;
1553             }
1554         }
1556         if ($restoretype === ENROL_RESTORE_NOUSERS) {
1557             // plugin requests to prevent restore of any users
1558             $newitemid = 0;
1559         }
1561         $this->set_mapping('enrol', $oldid, $newitemid);
1562     }
1564     /**
1565      * Create user enrolments
1566      *
1567      * This has to be called after creation of enrolment instances
1568      * and before adding of role assignments.
1569      *
1570      * @param mixed $data
1571      * @return void
1572      */
1573     public function process_enrolment($data) {
1574         global $DB;
1576         $data = (object)$data;
1578         // Process only if parent instance have been mapped
1579         if ($enrolid = $this->get_new_parentid('enrol')) {
1580             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1581                 // And only if user is a mapped one
1582                 if ($userid = $this->get_mappingid('user', $data->userid)) {
1583                     $enrol = enrol_get_plugin($instance->enrol);
1584                     //TODO: do we need specify modifierid?
1585                     $enrol->enrol_user($instance, $userid, null, $data->timestart, $data->timeend, $data->status);
1586                     //note: roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing above
1587                 }
1588             }
1589         }
1590     }
1594 /**
1595  * Make sure the user restoring the course can actually access it.
1596  */
1597 class restore_fix_restorer_access_step extends restore_execution_step {
1598     protected function define_execution() {
1599         global $CFG, $DB;
1601         if (!$userid = $this->task->get_userid()) {
1602             return;
1603         }
1605         if (empty($CFG->restorernewroleid)) {
1606             // Bad luck, no fallback role for restorers specified
1607             return;
1608         }
1610         $courseid = $this->get_courseid();
1611         $context = context_course::instance($courseid);
1613         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1614             // Current user may access the course (admin, category manager or restored teacher enrolment usually)
1615             return;
1616         }
1618         // Try to add role only - we do not need enrolment if user has moodle/course:view or is already enrolled
1619         role_assign($CFG->restorernewroleid, $userid, $context);
1621         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1622             // Extra role is enough, yay!
1623             return;
1624         }
1626         // The last chance is to create manual enrol if it does not exist and and try to enrol the current user,
1627         // hopefully admin selected suitable $CFG->restorernewroleid ...
1628         if (!enrol_is_enabled('manual')) {
1629             return;
1630         }
1631         if (!$enrol = enrol_get_plugin('manual')) {
1632             return;
1633         }
1634         if (!$DB->record_exists('enrol', array('enrol'=>'manual', 'courseid'=>$courseid))) {
1635             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
1636             $fields = array('status'=>ENROL_INSTANCE_ENABLED, 'enrolperiod'=>$enrol->get_config('enrolperiod', 0), 'roleid'=>$enrol->get_config('roleid', 0));
1637             $enrol->add_instance($course, $fields);
1638         }
1640         enrol_try_internal_enrol($courseid, $userid);
1641     }
1645 /**
1646  * This structure steps restores the filters and their configs
1647  */
1648 class restore_filters_structure_step extends restore_structure_step {
1650     protected function define_structure() {
1652         $paths = array();
1654         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
1655         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
1657         return $paths;
1658     }
1660     public function process_active($data) {
1662         $data = (object)$data;
1664         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1665             return;
1666         }
1667         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
1668     }
1670     public function process_config($data) {
1672         $data = (object)$data;
1674         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1675             return;
1676         }
1677         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
1678     }
1682 /**
1683  * This structure steps restores the comments
1684  * Note: Cannot use the comments API because defaults to USER->id.
1685  * That should change allowing to pass $userid
1686  */
1687 class restore_comments_structure_step extends restore_structure_step {
1689     protected function define_structure() {
1691         $paths = array();
1693         $paths[] = new restore_path_element('comment', '/comments/comment');
1695         return $paths;
1696     }
1698     public function process_comment($data) {
1699         global $DB;
1701         $data = (object)$data;
1703         // First of all, if the comment has some itemid, ask to the task what to map
1704         $mapping = false;
1705         if ($data->itemid) {
1706             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
1707             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
1708         }
1709         // Only restore the comment if has no mapping OR we have found the matching mapping
1710         if (!$mapping || $data->itemid) {
1711             // Only if user mapping and context
1712             $data->userid = $this->get_mappingid('user', $data->userid);
1713             if ($data->userid && $this->task->get_contextid()) {
1714                 $data->contextid = $this->task->get_contextid();
1715                 // Only if there is another comment with same context/user/timecreated
1716                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
1717                 if (!$DB->record_exists('comments', $params)) {
1718                     $DB->insert_record('comments', $data);
1719                 }
1720             }
1721         }
1722     }
1725 /**
1726  * This structure steps restores the calendar events
1727  */
1728 class restore_calendarevents_structure_step extends restore_structure_step {
1730     protected function define_structure() {
1732         $paths = array();
1734         $paths[] = new restore_path_element('calendarevents', '/events/event');
1736         return $paths;
1737     }
1739     public function process_calendarevents($data) {
1740         global $DB;
1742         $data = (object)$data;
1743         $oldid = $data->id;
1744         $restorefiles = true; // We'll restore the files
1745         // Find the userid and the groupid associated with the event. Return if not found.
1746         $data->userid = $this->get_mappingid('user', $data->userid);
1747         if ($data->userid === false) {
1748             return;
1749         }
1750         if (!empty($data->groupid)) {
1751             $data->groupid = $this->get_mappingid('group', $data->groupid);
1752             if ($data->groupid === false) {
1753                 return;
1754             }
1755         }
1756         // Handle events with empty eventtype //MDL-32827
1757         if(empty($data->eventtype)) {
1758             if ($data->courseid == $SITE->id) {                                // Site event
1759                 $data->eventtype = "site";
1760             } else if ($data->courseid != 0 && $data->groupid == 0 && ($data->modulename == 'assignment' || $data->modulename == 'assign')) {
1761                 // Course assingment event
1762                 $data->eventtype = "due";
1763             } else if ($data->courseid != 0 && $data->groupid == 0) {      // Course event
1764                 $data->eventtype = "course";
1765             } else if ($data->groupid) {                                      // Group event
1766                 $data->eventtype = "group";
1767             } else if ($data->userid) {                                       // User event
1768                 $data->eventtype = "user";
1769             } else {
1770                 return;
1771             }
1772         }
1774         $params = array(
1775                 'name'           => $data->name,
1776                 'description'    => $data->description,
1777                 'format'         => $data->format,
1778                 'courseid'       => $this->get_courseid(),
1779                 'groupid'        => $data->groupid,
1780                 'userid'         => $data->userid,
1781                 'repeatid'       => $data->repeatid,
1782                 'modulename'     => $data->modulename,
1783                 'eventtype'      => $data->eventtype,
1784                 'timestart'      => $this->apply_date_offset($data->timestart),
1785                 'timeduration'   => $data->timeduration,
1786                 'visible'        => $data->visible,
1787                 'uuid'           => $data->uuid,
1788                 'sequence'       => $data->sequence,
1789                 'timemodified'    => $this->apply_date_offset($data->timemodified));
1790         if ($this->name == 'activity_calendar') {
1791             $params['instance'] = $this->task->get_activityid();
1792         } else {
1793             $params['instance'] = 0;
1794         }
1795         $sql = 'SELECT id FROM {event} WHERE name = ? AND courseid = ? AND
1796                 repeatid = ? AND modulename = ? AND timestart = ? AND timeduration =?
1797                 AND ' . $DB->sql_compare_text('description', 255) . ' = ' . $DB->sql_compare_text('?', 255);
1798         $arg = array ($params['name'], $params['courseid'], $params['repeatid'], $params['modulename'], $params['timestart'], $params['timeduration'], $params['description']);
1799         $result = $DB->record_exists_sql($sql, $arg);
1800         if (empty($result)) {
1801             $newitemid = $DB->insert_record('event', $params);
1802             $this->set_mapping('event_description', $oldid, $newitemid, $restorefiles);
1803         }
1805     }
1806     protected function after_execute() {
1807         // Add related files
1808         $this->add_related_files('calendar', 'event_description', 'event_description');
1809     }
1812 class restore_course_completion_structure_step extends restore_structure_step {
1814     /**
1815      * Conditionally decide if this step should be executed.
1816      *
1817      * This function checks parameters that are not immediate settings to ensure
1818      * that the enviroment is suitable for the restore of course completion info.
1819      *
1820      * This function checks the following four parameters:
1821      *
1822      *   1. Course completion is enabled on the site
1823      *   2. The backup includes course completion information
1824      *   3. All modules are restorable
1825      *   4. All modules are marked for restore.
1826      *
1827      * @return bool True is safe to execute, false otherwise
1828      */
1829     protected function execute_condition() {
1830         global $CFG;
1832         // First check course completion is enabled on this site
1833         if (empty($CFG->enablecompletion)) {
1834             // Disabled, don't restore course completion
1835             return false;
1836         }
1838         // Check it is included in the backup
1839         $fullpath = $this->task->get_taskbasepath();
1840         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1841         if (!file_exists($fullpath)) {
1842             // Not found, can't restore course completion
1843             return false;
1844         }
1846         // Check we are able to restore all backed up modules
1847         if ($this->task->is_missing_modules()) {
1848             return false;
1849         }
1851         // Finally check all modules within the backup are being restored.
1852         if ($this->task->is_excluding_activities()) {
1853             return false;
1854         }
1856         return true;
1857     }
1859     /**
1860      * Define the course completion structure
1861      *
1862      * @return array Array of restore_path_element
1863      */
1864     protected function define_structure() {
1866         // To know if we are including user completion info
1867         $userinfo = $this->get_setting_value('userscompletion');
1869         $paths = array();
1870         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
1871         $paths[] = new restore_path_element('course_completion_notify', '/course_completion/course_completion_notify');
1872         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
1874         if ($userinfo) {
1875             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
1876             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
1877         }
1879         return $paths;
1881     }
1883     /**
1884      * Process course completion criteria
1885      *
1886      * @global moodle_database $DB
1887      * @param stdClass $data
1888      */
1889     public function process_course_completion_criteria($data) {
1890         global $DB;
1892         $data = (object)$data;
1893         $data->course = $this->get_courseid();
1895         // Apply the date offset to the time end field
1896         $data->timeend = $this->apply_date_offset($data->timeend);
1898         // Map the role from the criteria
1899         if (!empty($data->role)) {
1900             $data->role = $this->get_mappingid('role', $data->role);
1901         }
1903         $skipcriteria = false;
1905         // If the completion criteria is for a module we need to map the module instance
1906         // to the new module id.
1907         if (!empty($data->moduleinstance) && !empty($data->module)) {
1908             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
1909             if (empty($data->moduleinstance)) {
1910                 $skipcriteria = true;
1911             }
1912         } else {
1913             $data->module = null;
1914             $data->moduleinstance = null;
1915         }
1917         // We backup the course shortname rather than the ID so that we can match back to the course
1918         if (!empty($data->courseinstanceshortname)) {
1919             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
1920             if (!$courseinstanceid) {
1921                 $skipcriteria = true;
1922             }
1923         } else {
1924             $courseinstanceid = null;
1925         }
1926         $data->courseinstance = $courseinstanceid;
1928         if (!$skipcriteria) {
1929             $params = array(
1930                 'course'         => $data->course,
1931                 'criteriatype'   => $data->criteriatype,
1932                 'enrolperiod'    => $data->enrolperiod,
1933                 'courseinstance' => $data->courseinstance,
1934                 'module'         => $data->module,
1935                 'moduleinstance' => $data->moduleinstance,
1936                 'timeend'        => $data->timeend,
1937                 'gradepass'      => $data->gradepass,
1938                 'role'           => $data->role
1939             );
1940             $newid = $DB->insert_record('course_completion_criteria', $params);
1941             $this->set_mapping('course_completion_criteria', $data->id, $newid);
1942         }
1943     }
1945     /**
1946      * Processes course compltion criteria complete records
1947      *
1948      * @global moodle_database $DB
1949      * @param stdClass $data
1950      */
1951     public function process_course_completion_crit_compl($data) {
1952         global $DB;
1954         $data = (object)$data;
1956         // This may be empty if criteria could not be restored
1957         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
1959         $data->course = $this->get_courseid();
1960         $data->userid = $this->get_mappingid('user', $data->userid);
1962         if (!empty($data->criteriaid) && !empty($data->userid)) {
1963             $params = array(
1964                 'userid' => $data->userid,
1965                 'course' => $data->course,
1966                 'criteriaid' => $data->criteriaid,
1967                 'timecompleted' => $this->apply_date_offset($data->timecompleted)
1968             );
1969             if (isset($data->gradefinal)) {
1970                 $params['gradefinal'] = $data->gradefinal;
1971             }
1972             if (isset($data->unenroled)) {
1973                 $params['unenroled'] = $data->unenroled;
1974             }
1975             if (isset($data->deleted)) {
1976                 $params['deleted'] = $data->deleted;
1977             }
1978             $DB->insert_record('course_completion_crit_compl', $params);
1979         }
1980     }
1982     /**
1983      * Process course completions
1984      *
1985      * @global moodle_database $DB
1986      * @param stdClass $data
1987      */
1988     public function process_course_completions($data) {
1989         global $DB;
1991         $data = (object)$data;
1993         $data->course = $this->get_courseid();
1994         $data->userid = $this->get_mappingid('user', $data->userid);
1996         if (!empty($data->userid)) {
1997             $params = array(
1998                 'userid' => $data->userid,
1999                 'course' => $data->course,
2000                 'deleted' => $data->deleted,
2001                 'timenotified' => $this->apply_date_offset($data->timenotified),
2002                 'timeenrolled' => $this->apply_date_offset($data->timeenrolled),
2003                 'timestarted' => $this->apply_date_offset($data->timestarted),
2004                 'timecompleted' => $this->apply_date_offset($data->timecompleted),
2005                 'reaggregate' => $data->reaggregate
2006             );
2007             $DB->insert_record('course_completions', $params);
2008         }
2009     }
2011     /**
2012      * Process course completion notification records.
2013      *
2014      * Note: As of Moodle 2.0 this table is not being used however it has been
2015      * left in in the hopes that one day the functionality there will be completed
2016      *
2017      * @global moodle_database $DB
2018      * @param stdClass $data
2019      */
2020     public function process_course_completion_notify($data) {
2021         global $DB;
2023         $data = (object)$data;
2025         $data->course = $this->get_courseid();
2026         if (!empty($data->role)) {
2027             $data->role = $this->get_mappingid('role', $data->role);
2028         }
2030         $params = array(
2031             'course' => $data->course,
2032             'role' => $data->role,
2033             'message' => $data->message,
2034             'timesent' => $this->apply_date_offset($data->timesent),
2035         );
2036         $DB->insert_record('course_completion_notify', $params);
2037     }
2039     /**
2040      * Process course completion aggregate methods
2041      *
2042      * @global moodle_database $DB
2043      * @param stdClass $data
2044      */
2045     public function process_course_completion_aggr_methd($data) {
2046         global $DB;
2048         $data = (object)$data;
2050         $data->course = $this->get_courseid();
2052         // Only create the course_completion_aggr_methd records if
2053         // the target course has not them defined. MDL-28180
2054         if (!$DB->record_exists('course_completion_aggr_methd', array(
2055                     'course' => $data->course,
2056                     'criteriatype' => $data->criteriatype))) {
2057             $params = array(
2058                 'course' => $data->course,
2059                 'criteriatype' => $data->criteriatype,
2060                 'method' => $data->method,
2061                 'value' => $data->value,
2062             );
2063             $DB->insert_record('course_completion_aggr_methd', $params);
2064         }
2065     }
2069 /**
2070  * This structure step restores course logs (cmid = 0), delegating
2071  * the hard work to the corresponding {@link restore_logs_processor} passing the
2072  * collection of {@link restore_log_rule} rules to be observed as they are defined
2073  * by the task. Note this is only executed based in the 'logs' setting.
2074  *
2075  * NOTE: This is executed by final task, to have all the activities already restored
2076  *
2077  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
2078  * records are. There are others like 'calendar' and 'upload' that will be handled
2079  * later.
2080  *
2081  * NOTE: All the missing actions (not able to be restored) are sent to logs for
2082  * debugging purposes
2083  */
2084 class restore_course_logs_structure_step extends restore_structure_step {
2086     /**
2087      * Conditionally decide if this step should be executed.
2088      *
2089      * This function checks the following parameter:
2090      *
2091      *   1. the course/logs.xml file exists
2092      *
2093      * @return bool true is safe to execute, false otherwise
2094      */
2095     protected function execute_condition() {
2097         // Check it is included in the backup
2098         $fullpath = $this->task->get_taskbasepath();
2099         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2100         if (!file_exists($fullpath)) {
2101             // Not found, can't restore course logs
2102             return false;
2103         }
2105         return true;
2106     }
2108     protected function define_structure() {
2110         $paths = array();
2112         // Simple, one plain level of information contains them
2113         $paths[] = new restore_path_element('log', '/logs/log');
2115         return $paths;
2116     }
2118     protected function process_log($data) {
2119         global $DB;
2121         $data = (object)($data);
2123         $data->time = $this->apply_date_offset($data->time);
2124         $data->userid = $this->get_mappingid('user', $data->userid);
2125         $data->course = $this->get_courseid();
2126         $data->cmid = 0;
2128         // For any reason user wasn't remapped ok, stop processing this
2129         if (empty($data->userid)) {
2130             return;
2131         }
2133         // Everything ready, let's delegate to the restore_logs_processor
2135         // Set some fixed values that will save tons of DB requests
2136         $values = array(
2137             'course' => $this->get_courseid());
2138         // Get instance and process log record
2139         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2141         // If we have data, insert it, else something went wrong in the restore_logs_processor
2142         if ($data) {
2143             $DB->insert_record('log', $data);
2144         }
2145     }
2148 /**
2149  * This structure step restores activity logs, extending {@link restore_course_logs_structure_step}
2150  * sharing its same structure but modifying the way records are handled
2151  */
2152 class restore_activity_logs_structure_step extends restore_course_logs_structure_step {
2154     protected function process_log($data) {
2155         global $DB;
2157         $data = (object)($data);
2159         $data->time = $this->apply_date_offset($data->time);
2160         $data->userid = $this->get_mappingid('user', $data->userid);
2161         $data->course = $this->get_courseid();
2162         $data->cmid = $this->task->get_moduleid();
2164         // For any reason user wasn't remapped ok, stop processing this
2165         if (empty($data->userid)) {
2166             return;
2167         }
2169         // Everything ready, let's delegate to the restore_logs_processor
2171         // Set some fixed values that will save tons of DB requests
2172         $values = array(
2173             'course' => $this->get_courseid(),
2174             'course_module' => $this->task->get_moduleid(),
2175             $this->task->get_modulename() => $this->task->get_activityid());
2176         // Get instance and process log record
2177         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2179         // If we have data, insert it, else something went wrong in the restore_logs_processor
2180         if ($data) {
2181             $DB->insert_record('log', $data);
2182         }
2183     }
2187 /**
2188  * Defines the restore step for advanced grading methods attached to the activity module
2189  */
2190 class restore_activity_grading_structure_step extends restore_structure_step {
2192     /**
2193      * This step is executed only if the grading file is present
2194      */
2195      protected function execute_condition() {
2197         $fullpath = $this->task->get_taskbasepath();
2198         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2199         if (!file_exists($fullpath)) {
2200             return false;
2201         }
2203         return true;
2204     }
2207     /**
2208      * Declares paths in the grading.xml file we are interested in
2209      */
2210     protected function define_structure() {
2212         $paths = array();
2213         $userinfo = $this->get_setting_value('userinfo');
2215         $paths[] = new restore_path_element('grading_area', '/areas/area');
2217         $definition = new restore_path_element('grading_definition', '/areas/area/definitions/definition');
2218         $paths[] = $definition;
2219         $this->add_plugin_structure('gradingform', $definition);
2221         if ($userinfo) {
2222             $instance = new restore_path_element('grading_instance',
2223                 '/areas/area/definitions/definition/instances/instance');
2224             $paths[] = $instance;
2225             $this->add_plugin_structure('gradingform', $instance);
2226         }
2228         return $paths;
2229     }
2231     /**
2232      * Processes one grading area element
2233      *
2234      * @param array $data element data
2235      */
2236     protected function process_grading_area($data) {
2237         global $DB;
2239         $task = $this->get_task();
2240         $data = (object)$data;
2241         $oldid = $data->id;
2242         $data->component = 'mod_'.$task->get_modulename();
2243         $data->contextid = $task->get_contextid();
2245         $newid = $DB->insert_record('grading_areas', $data);
2246         $this->set_mapping('grading_area', $oldid, $newid);
2247     }
2249     /**
2250      * Processes one grading definition element
2251      *
2252      * @param array $data element data
2253      */
2254     protected function process_grading_definition($data) {
2255         global $DB;
2257         $task = $this->get_task();
2258         $data = (object)$data;
2259         $oldid = $data->id;
2260         $data->areaid = $this->get_new_parentid('grading_area');
2261         $data->copiedfromid = null;
2262         $data->timecreated = time();
2263         $data->usercreated = $task->get_userid();
2264         $data->timemodified = $data->timecreated;
2265         $data->usermodified = $data->usercreated;
2267         $newid = $DB->insert_record('grading_definitions', $data);
2268         $this->set_mapping('grading_definition', $oldid, $newid, true);
2269     }
2271     /**
2272      * Processes one grading form instance element
2273      *
2274      * @param array $data element data
2275      */
2276     protected function process_grading_instance($data) {
2277         global $DB;
2279         $data = (object)$data;
2281         // new form definition id
2282         $newformid = $this->get_new_parentid('grading_definition');
2284         // get the name of the area we are restoring to
2285         $sql = "SELECT ga.areaname
2286                   FROM {grading_definitions} gd
2287                   JOIN {grading_areas} ga ON gd.areaid = ga.id
2288                  WHERE gd.id = ?";
2289         $areaname = $DB->get_field_sql($sql, array($newformid), MUST_EXIST);
2291         // get the mapped itemid - the activity module is expected to define the mappings
2292         // for each gradable area
2293         $newitemid = $this->get_mappingid(restore_gradingform_plugin::itemid_mapping($areaname), $data->itemid);
2295         $oldid = $data->id;
2296         $data->definitionid = $newformid;
2297         $data->raterid = $this->get_mappingid('user', $data->raterid);
2298         $data->itemid = $newitemid;
2300         $newid = $DB->insert_record('grading_instances', $data);
2301         $this->set_mapping('grading_instance', $oldid, $newid);
2302     }
2304     /**
2305      * Final operations when the database records are inserted
2306      */
2307     protected function after_execute() {
2308         // Add files embedded into the definition description
2309         $this->add_related_files('grading', 'description', 'grading_definition');
2310     }
2314 /**
2315  * This structure step restores the grade items associated with one activity
2316  * All the grade items are made child of the "course" grade item but the original
2317  * categoryid is saved as parentitemid in the backup_ids table, so, when restoring
2318  * the complete gradebook (categories and calculations), that information is
2319  * available there
2320  */
2321 class restore_activity_grades_structure_step extends restore_structure_step {
2323     protected function define_structure() {
2325         $paths = array();
2326         $userinfo = $this->get_setting_value('userinfo');
2328         $paths[] = new restore_path_element('grade_item', '/activity_gradebook/grade_items/grade_item');
2329         $paths[] = new restore_path_element('grade_letter', '/activity_gradebook/grade_letters/grade_letter');
2330         if ($userinfo) {
2331             $paths[] = new restore_path_element('grade_grade',
2332                            '/activity_gradebook/grade_items/grade_item/grade_grades/grade_grade');
2333         }
2334         return $paths;
2335     }
2337     protected function process_grade_item($data) {
2338         global $DB;
2340         $data = (object)($data);
2341         $oldid       = $data->id;        // We'll need these later
2342         $oldparentid = $data->categoryid;
2343         $courseid = $this->get_courseid();
2345         // make sure top course category exists, all grade items will be associated
2346         // to it. Later, if restoring the whole gradebook, categories will be introduced
2347         $coursecat = grade_category::fetch_course_category($courseid);
2348         $coursecatid = $coursecat->id; // Get the categoryid to be used
2350         $idnumber = null;
2351         if (!empty($data->idnumber)) {
2352             // Don't get any idnumber from course module. Keep them as they are in grade_item->idnumber
2353             // Reason: it's not clear what happens with outcomes->idnumber or activities with multiple items (workshop)
2354             // so the best is to keep the ones already in the gradebook
2355             // Potential problem: duplicates if same items are restored more than once. :-(
2356             // This needs to be fixed in some way (outcomes & activities with multiple items)
2357             // $data->idnumber     = get_coursemodule_from_instance($data->itemmodule, $data->iteminstance)->idnumber;
2358             // In any case, verify always for uniqueness
2359             $sql = "SELECT cm.id
2360                       FROM {course_modules} cm
2361                      WHERE cm.course = :courseid AND
2362                            cm.idnumber = :idnumber AND
2363                            cm.id <> :cmid";
2364             $params = array(
2365                 'courseid' => $courseid,
2366                 'idnumber' => $data->idnumber,
2367                 'cmid' => $this->task->get_moduleid()
2368             );
2369             if (!$DB->record_exists_sql($sql, $params) && !$DB->record_exists('grade_items', array('courseid' => $courseid, 'idnumber' => $data->idnumber))) {
2370                 $idnumber = $data->idnumber;
2371             }
2372         }
2374         unset($data->id);
2375         $data->categoryid   = $coursecatid;
2376         $data->courseid     = $this->get_courseid();
2377         $data->iteminstance = $this->task->get_activityid();
2378         $data->idnumber     = $idnumber;
2379         $data->scaleid      = $this->get_mappingid('scale', $data->scaleid);
2380         $data->outcomeid    = $this->get_mappingid('outcome', $data->outcomeid);
2381         $data->timecreated  = $this->apply_date_offset($data->timecreated);
2382         $data->timemodified = $this->apply_date_offset($data->timemodified);
2384         $gradeitem = new grade_item($data, false);
2385         $gradeitem->insert('restore');
2387         //sortorder is automatically assigned when inserting. Re-instate the previous sortorder
2388         $gradeitem->sortorder = $data->sortorder;
2389         $gradeitem->update('restore');
2391         // Set mapping, saving the original category id into parentitemid
2392         // gradebook restore (final task) will need it to reorganise items
2393         $this->set_mapping('grade_item', $oldid, $gradeitem->id, false, null, $oldparentid);
2394     }
2396     protected function process_grade_grade($data) {
2397         $data = (object)($data);
2398         $olduserid = $data->userid;
2399         unset($data->id);
2401         $data->itemid = $this->get_new_parentid('grade_item');
2403         $data->userid = $this->get_mappingid('user', $data->userid, null);
2404         if (!empty($data->userid)) {
2405             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
2406             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
2407             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
2408             $data->overridden = $this->apply_date_offset($data->overridden);
2410             $grade = new grade_grade($data, false);
2411             $grade->insert('restore');
2412             // no need to save any grade_grade mapping
2413         } else {
2414             debugging("Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'");
2415         }
2416     }
2418     /**
2419      * process activity grade_letters. Note that, while these are possible,
2420      * because grade_letters are contextid based, in practice, only course
2421      * context letters can be defined. So we keep here this method knowing
2422      * it won't be executed ever. gradebook restore will restore course letters.
2423      */
2424     protected function process_grade_letter($data) {
2425         global $DB;
2427         $data['contextid'] = $this->task->get_contextid();
2428         $gradeletter = (object)$data;
2430         // Check if it exists before adding it
2431         unset($data['id']);
2432         if (!$DB->record_exists('grade_letters', $data)) {
2433             $newitemid = $DB->insert_record('grade_letters', $gradeletter);
2434         }
2435         // no need to save any grade_letter mapping
2436     }
2440 /**
2441  * This structure steps restores one instance + positions of one block
2442  * Note: Positions corresponding to one existing context are restored
2443  * here, but all the ones having unknown contexts are sent to backup_ids
2444  * for a later chance to be restored at the end (final task)
2445  */
2446 class restore_block_instance_structure_step extends restore_structure_step {
2448     protected function define_structure() {
2450         $paths = array();
2452         $paths[] = new restore_path_element('block', '/block', true); // Get the whole XML together
2453         $paths[] = new restore_path_element('block_position', '/block/block_positions/block_position');
2455         return $paths;
2456     }
2458     public function process_block($data) {
2459         global $DB, $CFG;
2461         $data = (object)$data; // Handy
2462         $oldcontextid = $data->contextid;
2463         $oldid        = $data->id;
2464         $positions = isset($data->block_positions['block_position']) ? $data->block_positions['block_position'] : array();
2466         // Look for the parent contextid
2467         if (!$data->parentcontextid = $this->get_mappingid('context', $data->parentcontextid)) {
2468             throw new restore_step_exception('restore_block_missing_parent_ctx', $data->parentcontextid);
2469         }
2471         // TODO: it would be nice to use standard plugin supports instead of this instance_allow_multiple()
2472         // If there is already one block of that type in the parent context
2473         // and the block is not multiple, stop processing
2474         // Use blockslib loader / method executor
2475         if (!$bi = block_instance($data->blockname)) {
2476             return false;
2477         }
2479         if (!$bi->instance_allow_multiple()) {
2480             if ($DB->record_exists_sql("SELECT bi.id
2481                                           FROM {block_instances} bi
2482                                           JOIN {block} b ON b.name = bi.blockname
2483                                          WHERE bi.parentcontextid = ?
2484                                            AND bi.blockname = ?", array($data->parentcontextid, $data->blockname))) {
2485                 return false;
2486             }
2487         }
2489         // If there is already one block of that type in the parent context
2490         // with the same showincontexts, pagetypepattern, subpagepattern, defaultregion and configdata
2491         // stop processing
2492         $params = array(
2493             'blockname' => $data->blockname, 'parentcontextid' => $data->parentcontextid,
2494             'showinsubcontexts' => $data->showinsubcontexts, 'pagetypepattern' => $data->pagetypepattern,
2495             'subpagepattern' => $data->subpagepattern, 'defaultregion' => $data->defaultregion);
2496         if ($birecs = $DB->get_records('block_instances', $params)) {
2497             foreach($birecs as $birec) {
2498                 if ($birec->configdata == $data->configdata) {
2499                     return false;
2500                 }
2501             }
2502         }
2504         // Set task old contextid, blockid and blockname once we know them
2505         $this->task->set_old_contextid($oldcontextid);
2506         $this->task->set_old_blockid($oldid);
2507         $this->task->set_blockname($data->blockname);
2509         // Let's look for anything within configdata neededing processing
2510         // (nulls and uses of legacy file.php)
2511         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
2512             $configdata = (array)unserialize(base64_decode($data->configdata));
2513             foreach ($configdata as $attribute => $value) {
2514                 if (in_array($attribute, $attrstotransform)) {
2515                     $configdata[$attribute] = $this->contentprocessor->process_cdata($value);
2516                 }
2517             }
2518             $data->configdata = base64_encode(serialize((object)$configdata));
2519         }
2521         // Create the block instance
2522         $newitemid = $DB->insert_record('block_instances', $data);
2523         // Save the mapping (with restorefiles support)
2524         $this->set_mapping('block_instance', $oldid, $newitemid, true);
2525         // Create the block context
2526         $newcontextid = get_context_instance(CONTEXT_BLOCK, $newitemid)->id;
2527         // Save the block contexts mapping and sent it to task
2528         $this->set_mapping('context', $oldcontextid, $newcontextid);
2529         $this->task->set_contextid($newcontextid);
2530         $this->task->set_blockid($newitemid);
2532         // Restore block fileareas if declared
2533         $component = 'block_' . $this->task->get_blockname();
2534         foreach ($this->task->get_fileareas() as $filearea) { // Simple match by contextid. No itemname needed
2535             $this->add_related_files($component, $filearea, null);
2536         }
2538         // Process block positions, creating them or accumulating for final step
2539         foreach($positions as $position) {
2540             $position = (object)$position;
2541             $position->blockinstanceid = $newitemid; // The instance is always the restored one
2542             // If position is for one already mapped (known) contextid
2543             // process it now, creating the position
2544             if ($newpositionctxid = $this->get_mappingid('context', $position->contextid)) {
2545                 $position->contextid = $newpositionctxid;
2546                 // Create the block position
2547                 $DB->insert_record('block_positions', $position);
2549             // The position belongs to an unknown context, send it to backup_ids
2550             // to process them as part of the final steps of restore. We send the
2551             // whole $position object there, hence use the low level method.
2552             } else {
2553                 restore_dbops::set_backup_ids_record($this->get_restoreid(), 'block_position', $position->id, 0, null, $position);
2554             }
2555         }
2556     }
2559 /**
2560  * Structure step to restore common course_module information
2561  *
2562  * This step will process the module.xml file for one activity, in order to restore
2563  * the corresponding information to the course_modules table, skipping various bits
2564  * of information based on CFG settings (groupings, completion...) in order to fullfill
2565  * all the reqs to be able to create the context to be used by all the rest of steps
2566  * in the activity restore task
2567  */
2568 class restore_module_structure_step extends restore_structure_step {
2570     protected function define_structure() {
2571         global $CFG;
2573         $paths = array();
2575         $module = new restore_path_element('module', '/module');
2576         $paths[] = $module;
2577         if ($CFG->enableavailability) {
2578             $paths[] = new restore_path_element('availability', '/module/availability_info/availability');
2579         }
2581         // Apply for 'format' plugins optional paths at module level
2582         $this->add_plugin_structure('format', $module);
2584         // Apply for 'plagiarism' plugins optional paths at module level
2585         $this->add_plugin_structure('plagiarism', $module);
2587         return $paths;
2588     }
2590     protected function process_module($data) {
2591         global $CFG, $DB;
2593         $data = (object)$data;
2594         $oldid = $data->id;
2595         $this->task->set_old_moduleversion($data->version);
2597         $data->course = $this->task->get_courseid();
2598         $data->module = $DB->get_field('modules', 'id', array('name' => $data->modulename));
2599         // Map section (first try by course_section mapping match. Useful in course and section restores)
2600         $data->section = $this->get_mappingid('course_section', $data->sectionid);
2601         if (!$data->section) { // mapping failed, try to get section by sectionnumber matching
2602             $params = array(
2603                 'course' => $this->get_courseid(),
2604                 'section' => $data->sectionnumber);
2605             $data->section = $DB->get_field('course_sections', 'id', $params);
2606         }
2607         if (!$data->section) { // sectionnumber failed, try to get first section in course
2608             $params = array(
2609                 'course' => $this->get_courseid());
2610             $data->section = $DB->get_field('course_sections', 'MIN(id)', $params);
2611         }
2612         if (!$data->section) { // no sections in course, create section 0 and 1 and assign module to 1
2613             $sectionrec = array(
2614                 'course' => $this->get_courseid(),
2615                 'section' => 0);
2616             $DB->insert_record('course_sections', $sectionrec); // section 0
2617             $sectionrec = array(
2618                 'course' => $this->get_courseid(),
2619                 'section' => 1);
2620             $data->section = $DB->insert_record('course_sections', $sectionrec); // section 1
2621         }
2622         $data->groupingid= $this->get_mappingid('grouping', $data->groupingid);      // grouping
2623         if (!$CFG->enablegroupmembersonly) {                                         // observe groupsmemberonly
2624             $data->groupmembersonly = 0;
2625         }
2626         if (!grade_verify_idnumber($data->idnumber, $this->get_courseid())) {        // idnumber uniqueness
2627             $data->idnumber = '';
2628         }
2629         if (empty($CFG->enablecompletion)) { // completion
2630             $data->completion = 0;
2631             $data->completiongradeitemnumber = null;
2632             $data->completionview = 0;
2633             $data->completionexpected = 0;
2634         } else {
2635             $data->completionexpected = $this->apply_date_offset($data->completionexpected);
2636         }
2637         if (empty($CFG->enableavailability)) {
2638             $data->availablefrom = 0;
2639             $data->availableuntil = 0;
2640             $data->showavailability = 0;
2641         } else {
2642             $data->availablefrom = $this->apply_date_offset($data->availablefrom);
2643             $data->availableuntil= $this->apply_date_offset($data->availableuntil);
2644         }
2645         // Backups that did not include showdescription, set it to default 0
2646         // (this is not totally necessary as it has a db default, but just to
2647         // be explicit).
2648         if (!isset($data->showdescription)) {
2649             $data->showdescription = 0;
2650         }
2651         $data->instance = 0; // Set to 0 for now, going to create it soon (next step)
2653         // course_module record ready, insert it
2654         $newitemid = $DB->insert_record('course_modules', $data);
2655         // save mapping
2656         $this->set_mapping('course_module', $oldid, $newitemid);
2657         // set the new course_module id in the task
2658         $this->task->set_moduleid($newitemid);
2659         // we can now create the context safely
2660         $ctxid = get_context_instance(CONTEXT_MODULE, $newitemid)->id;
2661         // set the new context id in the task
2662         $this->task->set_contextid($ctxid);
2663         // update sequence field in course_section
2664         if ($sequence = $DB->get_field('course_sections', 'sequence', array('id' => $data->section))) {
2665             $sequence .= ',' . $newitemid;
2666         } else {
2667             $sequence = $newitemid;
2668         }
2669         $DB->set_field('course_sections', 'sequence', $sequence, array('id' => $data->section));
2670     }
2673     protected function process_availability($data) {
2674         $data = (object)$data;
2675         // Simply going to store the whole availability record now, we'll process
2676         // all them later in the final task (once all actvivities have been restored)
2677         // Let's call the low level one to be able to store the whole object
2678         $data->coursemoduleid = $this->task->get_moduleid(); // Let add the availability cmid
2679         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'module_availability', $data->id, 0, null, $data);
2680     }
2683 /**
2684  * Structure step that will process the user activity completion
2685  * information if all these conditions are met:
2686  *  - Target site has completion enabled ($CFG->enablecompletion)
2687  *  - Activity includes completion info (file_exists)
2688  */
2689 class restore_userscompletion_structure_step extends restore_structure_step {
2690     /**
2691      * To conditionally decide if this step must be executed
2692      * Note the "settings" conditions are evaluated in the
2693      * corresponding task. Here we check for other conditions
2694      * not being restore settings (files, site settings...)
2695      */
2696      protected function execute_condition() {
2697          global $CFG;
2699          // Completion disabled in this site, don't execute
2700          if (empty($CFG->enablecompletion)) {
2701              return false;
2702          }
2704          // No user completion info found, don't execute
2705         $fullpath = $this->task->get_taskbasepath();
2706         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2707          if (!file_exists($fullpath)) {
2708              return false;
2709          }
2711          // Arrived here, execute the step
2712          return true;
2713      }
2715      protected function define_structure() {
2717         $paths = array();
2719         $paths[] = new restore_path_element('completion', '/completions/completion');
2721         return $paths;
2722     }
2724     protected function process_completion($data) {
2725         global $DB;
2727         $data = (object)$data;
2729         $data->coursemoduleid = $this->task->get_moduleid();
2730         $data->userid = $this->get_mappingid('user', $data->userid);
2731         $data->timemodified = $this->apply_date_offset($data->timemodified);
2733         // Find the existing record
2734         $existing = $DB->get_record('course_modules_completion', array(
2735                 'coursemoduleid' => $data->coursemoduleid,
2736                 'userid' => $data->userid), 'id, timemodified');
2737         // Check we didn't already insert one for this cmid and userid
2738         // (there aren't supposed to be duplicates in that field, but
2739         // it was possible until MDL-28021 was fixed).
2740         if ($existing) {
2741             // Update it to these new values, but only if the time is newer
2742             if ($existing->timemodified < $data->timemodified) {
2743                 $data->id = $existing->id;
2744                 $DB->update_record('course_modules_completion', $data);
2745             }
2746         } else {
2747             // Normal entry where it doesn't exist already
2748             $DB->insert_record('course_modules_completion', $data);
2749         }
2750     }
2753 /**
2754  * Abstract structure step, parent of all the activity structure steps. Used to suuport
2755  * the main <activity ...> tag and process it. Also provides subplugin support for
2756  * activities.
2757  */
2758 abstract class restore_activity_structure_step extends restore_structure_step {
2760     protected function add_subplugin_structure($subplugintype, $element) {
2762         global $CFG;
2764         // Check the requested subplugintype is a valid one
2765         $subpluginsfile = $CFG->dirroot . '/mod/' . $this->task->get_modulename() . '/db/subplugins.php';
2766         if (!file_exists($subpluginsfile)) {
2767              throw new restore_step_exception('activity_missing_subplugins_php_file', $this->task->get_modulename());
2768         }
2769         include($subpluginsfile);
2770         if (!array_key_exists($subplugintype, $subplugins)) {
2771              throw new restore_step_exception('incorrect_subplugin_type', $subplugintype);
2772         }
2773         // Get all the restore path elements, looking across all the subplugin dirs
2774         $subpluginsdirs = get_plugin_list($subplugintype);
2775         foreach ($subpluginsdirs as $name => $subpluginsdir) {
2776             $classname = 'restore_' . $subplugintype . '_' . $name . '_subplugin';
2777             $restorefile = $subpluginsdir . '/backup/moodle2/' . $classname . '.class.php';
2778             if (file_exists($restorefile)) {
2779                 require_once($restorefile);
2780                 $restoresubplugin = new $classname($subplugintype, $name, $this);
2781                 // Add subplugin paths to the step
2782                 $this->prepare_pathelements($restoresubplugin->define_subplugin_structure($element));
2783             }
2784         }
2785     }
2787     /**
2788      * As far as activity restore steps are implementing restore_subplugin stuff, they need to
2789      * have the parent task available for wrapping purposes (get course/context....)
2790      * @return restore_task
2791      */
2792     public function get_task() {
2793         return $this->task;
2794     }
2796     /**
2797      * Adds support for the 'activity' path that is common to all the activities
2798      * and will be processed globally here
2799      */
2800     protected function prepare_activity_structure($paths) {
2802         $paths[] = new restore_path_element('activity', '/activity');
2804         return $paths;
2805     }
2807     /**
2808      * Process the activity path, informing the task about various ids, needed later
2809      */
2810     protected function process_activity($data) {
2811         $data = (object)$data;
2812         $this->task->set_old_contextid($data->contextid); // Save old contextid in task
2813         $this->set_mapping('context', $data->contextid, $this->task->get_contextid()); // Set the mapping
2814         $this->task->set_old_activityid($data->id); // Save old activityid in task
2815     }
2817     /**
2818      * This must be invoked immediately after creating the "module" activity record (forum, choice...)
2819      * and will adjust the new activity id (the instance) in various places
2820      */
2821     protected function apply_activity_instance($newitemid) {
2822         global $DB;
2824         $this->task->set_activityid($newitemid); // Save activity id in task
2825         // Apply the id to course_sections->instanceid
2826         $DB->set_field('course_modules', 'instance', $newitemid, array('id' => $this->task->get_moduleid()));
2827         // Do the mapping for modulename, preparing it for files by oldcontext
2828         $modulename = $this->task->get_modulename();
2829         $oldid = $this->task->get_old_activityid();
2830         $this->set_mapping($modulename, $oldid, $newitemid, true);
2831     }
2834 /**
2835  * Structure step in charge of creating/mapping all the qcats and qs
2836  * by parsing the questions.xml file and checking it against the
2837  * results calculated by {@link restore_process_categories_and_questions}
2838  * and stored in backup_ids_temp
2839  */
2840 class restore_create_categories_and_questions extends restore_structure_step {
2842     protected function define_structure() {
2844         $category = new restore_path_element('question_category', '/question_categories/question_category');
2845         $question = new restore_path_element('question', '/question_categories/question_category/questions/question');
2846         $hint = new restore_path_element('question_hint',
2847                 '/question_categories/question_category/questions/question/question_hints/question_hint');
2849         // Apply for 'qtype' plugins optional paths at question level
2850         $this->add_plugin_structure('qtype', $question);
2852         return array($category, $question, $hint);
2853     }
2855     protected function process_question_category($data) {
2856         global $DB;
2858         $data = (object)$data;
2859         $oldid = $data->id;
2861         // Check we have one mapping for this category
2862         if (!$mapping = $this->get_mapping('question_category', $oldid)) {
2863             return self::SKIP_ALL_CHILDREN; // No mapping = this category doesn't need to be created/mapped
2864         }
2866         // Check we have to create the category (newitemid = 0)
2867         if ($mapping->newitemid) {
2868             return; // newitemid != 0, this category is going to be mapped. Nothing to do
2869         }
2871         // Arrived here, newitemid = 0, we need to create the category
2872         // we'll do it at parentitemid context, but for CONTEXT_MODULE
2873         // categories, that will be created at CONTEXT_COURSE and moved
2874         // to module context later when the activity is created
2875         if ($mapping->info->contextlevel == CONTEXT_MODULE) {
2876             $mapping->parentitemid = $this->get_mappingid('context', $this->task->get_old_contextid());
2877         }
2878         $data->contextid = $mapping->parentitemid;
2880         // Let's create the question_category and save mapping
2881         $newitemid = $DB->insert_record('question_categories', $data);
2882         $this->set_mapping('question_category', $oldid, $newitemid);
2883         // Also annotate them as question_category_created, we need
2884         // that later when remapping parents
2885         $this->set_mapping('question_category_created', $oldid, $newitemid, false, null, $data->contextid);
2886     }
2888     protected function process_question($data) {
2889         global $DB;
2891         $data = (object)$data;
2892         $oldid = $data->id;
2894         // Check we have one mapping for this question
2895         if (!$questionmapping = $this->get_mapping('question', $oldid)) {
2896             return; // No mapping = this question doesn't need to be created/mapped
2897         }
2899         // Get the mapped category (cannot use get_new_parentid() because not
2900         // all the categories have been created, so it is not always available
2901         // Instead we get the mapping for the question->parentitemid because
2902         // we have loaded qcatids there for all parsed questions
2903         $data->category = $this->get_mappingid('question_category', $questionmapping->parentitemid);
2905         // In the past, there were some very sloppy values of penalty. Fix them.
2906         if ($data->penalty >= 0.33 && $data->penalty <= 0.34) {
2907             $data->penalty = 0.3333333;
2908         }
2909         if ($data->penalty >= 0.66 && $data->penalty <= 0.67) {
2910             $data->penalty = 0.6666667;
2911         }
2912         if ($data->penalty >= 1) {
2913             $data->penalty = 1;
2914         }
2916         $userid = $this->get_mappingid('user', $data->createdby);
2917         $data->createdby = $userid ? $userid : $this->task->get_userid();
2919         $userid = $this->get_mappingid('user', $data->modifiedby);
2920         $data->modifiedby = $userid ? $userid : $this->task->get_userid();
2922         // With newitemid = 0, let's create the question
2923         if (!$questionmapping->newitemid) {
2924             $newitemid = $DB->insert_record('question', $data);
2925             $this->set_mapping('question', $oldid, $newitemid);
2926             // Also annotate them as question_created, we need
2927             // that later when remapping parents (keeping the old categoryid as parentid)
2928             $this->set_mapping('question_created', $oldid, $newitemid, false, null, $questionmapping->parentitemid);
2929         } else {
2930             // By performing this set_mapping() we make get_old/new_parentid() to work for all the
2931             // children elements of the 'question' one (so qtype plugins will know the question they belong to)
2932             $this->set_mapping('question', $oldid, $questionmapping->newitemid);
2933         }
2935         // Note, we don't restore any question files yet
2936         // as far as the CONTEXT_MODULE categories still
2937         // haven't their contexts to be restored to
2938         // The {@link restore_create_question_files}, executed in the final step
2939         // step will be in charge of restoring all the question files
2940     }
2942         protected function process_question_hint($data) {
2943         global $DB;
2945         $data = (object)$data;
2946         $oldid = $data->id;
2948         // Detect if the question is created or mapped
2949         $oldquestionid   = $this->get_old_parentid('question');
2950         $newquestionid   = $this->get_new_parentid('question');
2951         $questioncreated = $this->get_mappingid('question_created', $oldquestionid) ? true : false;
2953         // If the question has been created by restore, we need to create its question_answers too
2954         if ($questioncreated) {
2955             // Adjust some columns
2956             $data->questionid = $newquestionid;
2957             // Insert record
2958             $newitemid = $DB->insert_record('question_hints', $data);
2960         // The question existed, we need to map the existing question_hints
2961         } else {
2962             // Look in question_hints by hint text matching
2963             $sql = 'SELECT id
2964                       FROM {question_hints}
2965                      WHERE questionid = ?
2966                        AND ' . $DB->sql_compare_text('hint', 255) . ' = ' . $DB->sql_compare_text('?', 255);
2967             $params = array($newquestionid, $data->hint);
2968             $newitemid = $DB->get_field_sql($sql, $params);
2970             // Not able to find the hint, let's try cleaning the hint text
2971             // of all the question's hints in DB as slower fallback. MDL-33863.
2972             if (!$newitemid) {
2973                 $potentialhints = $DB->get_records('question_hints',
2974                         array('questionid' => $newquestionid), '', 'id, hint');
2975                 foreach ($potentialhints as $potentialhint) {
2976                     // Clean in the same way than {@link xml_writer::xml_safe_utf8()}.
2977                     $cleanhint = preg_replace('/[\x-\x8\xb-\xc\xe-\x1f\x7f]/is','', $potentialhint->hint); // Clean CTRL chars.
2978                     $cleanhint = preg_replace("/\r\n|\r/", "\n", $cleanhint); // Normalize line ending.
2979                     if ($cleanhint === $data->hint) {
2980                         $newitemid = $data->id;
2981                     }
2982                 }
2983             }
2985             // If we haven't found the newitemid, something has gone really wrong, question in DB
2986             // is missing hints, exception
2987             if (!$newitemid) {
2988                 $info = new stdClass();
2989                 $info->filequestionid = $oldquestionid;
2990                 $info->dbquestionid   = $newquestionid;
2991                 $info->hint           = $data->hint;
2992                 throw new restore_step_exception('error_question_hint_missing_in_db', $info);
2993             }
2994         }
2995         // Create mapping (I'm not sure if this is really needed?)
2996         $this->set_mapping('question_hint', $oldid, $newitemid);
2997     }
2999     protected function after_execute() {
3000         global $DB;
3002         // First of all, recode all the created question_categories->parent fields
3003         $qcats = $DB->get_records('backup_ids_temp', array(
3004                      'backupid' => $this->get_restoreid(),
3005                      'itemname' => 'question_category_created'));
3006         foreach ($qcats as $qcat) {
3007             $newparent = 0;
3008             $dbcat = $DB->get_record('question_categories', array('id' => $qcat->newitemid));
3009             // Get new parent (mapped or created, so we look in quesiton_category mappings)
3010             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
3011                                  'backupid' => $this->get_restoreid(),
3012                                  'itemname' => 'question_category',
3013                                  'itemid'   => $dbcat->parent))) {
3014                 // contextids must match always, as far as we always include complete qbanks, just check it
3015                 $newparentctxid = $DB->get_field('question_categories', 'contextid', array('id' => $newparent));
3016                 if ($dbcat->contextid == $newparentctxid) {
3017                     $DB->set_field('question_categories', 'parent', $newparent, array('id' => $dbcat->id));
3018                 } else {
3019                     $newparent = 0; // No ctx match for both cats, no parent relationship
3020                 }
3021             }
3022             // Here with $newparent empty, problem with contexts or remapping, set it to top cat
3023             if (!$newparent) {
3024                 $DB->set_field('question_categories', 'parent', 0, array('id' => $dbcat->id));
3025             }
3026         }
3028         // Now, recode all the created question->parent fields
3029         $qs = $DB->get_records('backup_ids_temp', array(
3030                   'backupid' => $this->get_restoreid(),
3031                   'itemname' => 'question_created'));
3032         foreach ($qs as $q) {
3033             $newparent = 0;
3034             $dbq = $DB->get_record('question', array('id' => $q->newitemid));
3035             // Get new parent (mapped or created, so we look in question mappings)
3036             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
3037                                  'backupid' => $this->get_restoreid(),
3038                                  'itemname' => 'question',
3039                                  'itemid'   => $dbq->parent))) {
3040                 $DB->set_field('question', 'parent', $newparent, array('id' => $dbq->id));
3041             }
3042         }
3044         // Note, we don't restore any question files yet
3045         // as far as the CONTEXT_MODULE categories still
3046         // haven't their contexts to be restored to
3047         // The {@link restore_create_question_files}, executed in the final step
3048         // step will be in charge of restoring all the question files
3049     }
3052 /**
3053  * Execution step that will move all the CONTEXT_MODULE question categories
3054  * created at early stages of restore in course context (because modules weren't
3055  * created yet) to their target module (matching by old-new-contextid mapping)
3056  */
3057 class restore_move_module_questions_categories extends restore_execution_step {
3059     protected function define_execution() {
3060         global $DB;
3062         $contexts = restore_dbops::restore_get_question_banks($this->get_restoreid(), CONTEXT_MODULE);
3063         foreach ($contexts as $contextid => $contextlevel) {
3064             // Only if context mapping exists (i.e. the module has been restored)
3065             if ($newcontext = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $contextid)) {
3066                 // Update all the qcats having their parentitemid set to the original contextid
3067                 $modulecats = $DB->get_records_sql("SELECT itemid, newitemid
3068                                                       FROM {backup_ids_temp}
3069                                                      WHERE backupid = ?
3070                                                        AND itemname = 'question_category'
3071                                                        AND parentitemid = ?", array($this->get_restoreid(), $contextid));
3072                 foreach ($modulecats as $modulecat) {
3073                     $DB->set_field('question_categories', 'contextid', $newcontext->newitemid, array('id' => $modulecat->newitemid));
3074                     // And set new contextid also in question_category mapping (will be
3075                     // used by {@link restore_create_question_files} later
3076                     restore_dbops::set_backup_ids_record($this->get_restoreid(), 'question_category', $modulecat->itemid, $modulecat->newitemid, $newcontext->newitemid);
3077                 }
3078             }
3079         }
3080     }
3083 /**
3084  * Execution step that will create all the question/answers/qtype-specific files for the restored
3085  * questions. It must be executed after {@link restore_move_module_questions_categories}
3086  * because only then each question is in its final category and only then the
3087  * context can be determined
3088  *
3089  * TODO: Improve this. Instead of looping over each question, it can be reduced to
3090  *       be done by contexts (this will save a huge ammount of queries)
3091  */
3092 class restore_create_question_files extends restore_execution_step {
3094     protected function define_execution() {
3095         global $DB;
3097         // Let's process only created questions
3098         $questionsrs = $DB->get_recordset_sql("SELECT bi.itemid, bi.newitemid, bi.parentitemid, q.qtype
3099                                                FROM {backup_ids_temp} bi
3100                                                JOIN {question} q ON q.id = bi.newitemid
3101                                               WHERE bi.backupid = ?
3102                                                 AND bi.itemname = 'question_created'", array($this->get_restoreid()));
3103         foreach ($questionsrs as $question) {
3104             // Get question_category mapping, it contains the target context for the question
3105             if (!$qcatmapping = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'question_category', $question->parentitemid)) {
3106                 // Something went really wrong, cannot find the question_category for the question
3107                 debugging('Error fetching target context for question', DEBUG_DEVELOPER);
3108                 continue;
3109             }
3110             // Calculate source and target contexts
3111             $oldctxid = $qcatmapping->info->contextid;
3112             $newctxid = $qcatmapping->parentitemid;
3114             // Add common question files (question and question_answer ones)
3115             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'questiontext',
3116                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3117             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'generalfeedback',
3118                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3119             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'answer',
3120                                               $oldctxid, $this->task->get_userid(), 'question_answer', null, $newctxid, true);
3121             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'answerfeedback',
3122                                               $oldctxid, $this->task->get_userid(), 'question_answer', null, $newctxid, true);
3123             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'hint',
3124                                               $oldctxid, $this->task->get_userid(), 'question_hint', null, $newctxid, true);
3125             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'correctfeedback',
3126                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3127             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'partiallycorrectfeedback',
3128                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3129             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'incorrectfeedback',
3130                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3131             // Add qtype dependent files
3132             $components = backup_qtype_plugin::get_components_and_fileareas($question->qtype);
3133             foreach ($components as $component => $fileareas) {
3134                 foreach ($fileareas as $filearea => $mapping) {
3135                     // Use itemid only if mapping is question_created
3136                     $itemid = ($mapping == 'question_created') ? $question->itemid : null;
3137                     restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), $component, $filearea,
3138                                                       $oldctxid, $this->task->get_userid(), $mapping, $itemid, $newctxid, true);
3139                 }
3140             }
3141         }
3142         $questionsrs->close();
3143     }
3147 /**
3148  * Try to restore aliases and references to external files.
3149  *
3150  * The queue of these files was prepared for us in {@link restore_dbops::send_files_to_pool()}.
3151  * We expect that all regular (non-alias) files have already been restored. Make sure
3152  * there is no restore step executed after this one that would call send_files_to_pool() again.
3153  *
3154  * You may notice we have hardcoded support for Server files, Legacy course files
3155  * and user Private files here at the moment. This could be eventually replaced with a set of
3156  * callbacks in the future if needed.
3157  *
3158  * @copyright 2012 David Mudrak <david@moodle.com>
3159  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3160  */
3161 class restore_process_file_aliases_queue extends restore_execution_step {
3163     /** @var array internal cache for {@link choose_repository() */
3164     private $cachereposbyid = array();
3166     /** @var array internal cache for {@link choose_repository() */
3167     private $cachereposbytype = array();
3169     /**
3170      * What to do when this step is executed.
3171      */
3172     protected function define_execution() {
3173         global $DB;
3175         $this->log('processing file aliases queue', backup::LOG_INFO);
3177         $fs = get_file_storage();
3179         // Load the queue.
3180         $rs = $DB->get_recordset('backup_ids_temp',
3181             array('backupid' => $this->get_restoreid(), 'itemname' => 'file_aliases_queue'),
3182             '', 'info');
3184         // Iterate over aliases in the queue.
3185         foreach ($rs as $record) {
3186             $info = unserialize(base64_decode($record->info));
3188             // Try to pick a repository instance that should serve the alias.
3189             $repository = $this->choose_repository($info);
3191             if (is_null($repository)) {
3192                 $this->notify_failure($info, 'unable to find a matching repository instance');
3193                 continue;
3194             }
3196             if ($info->oldfile->repositorytype === 'local' or $info->oldfile->repositorytype === 'coursefiles') {
3197                 // Aliases to Server files and Legacy course files may refer to a file
3198                 // contained in the backup file or to some existing file (if we are on the
3199                 // same site).
3200                 try {
3201                     $reference = file_storage::unpack_reference($info->oldfile->reference);
3202                 } catch (Exception $e) {
3203                     $this->notify_failure($info, 'invalid reference field format');
3204                     continue;
3205                 }
3207                 // Let's see if the referred source file was also included in the backup.
3208                 $candidates = $DB->get_recordset('backup_files_temp', array(
3209                         'backupid' => $this->get_restoreid(),
3210                         'contextid' => $reference['contextid'],
3211                         'component' => $reference['component'],
3212                         'filearea' => $reference['filearea'],
3213                         'itemid' => $reference['itemid'],
3214                     ), '', 'info, newcontextid, newitemid');
3216                 $source = null;
3218                 foreach ($candidates as $candidate) {
3219                     $candidateinfo = unserialize(base64_decode($candidate->info));
3220                     if ($candidateinfo->filename === $reference['filename']
3221                             and $candidateinfo->filepath === $reference['filepath']
3222                             and !is_null($candidate->newcontextid)
3223                             and !is_null($candidate->newitemid) ) {
3224                         $source = $candidateinfo;
3225                         $source->contextid = $candidate->newcontextid;
3226                         $source->itemid = $candidate->newitemid;