740c2028a427e0d05860b5172ec249976e25fd06
[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         if (!$DB->record_exists('grade_settings', array('courseid' => $data->courseid, 'name' => $data->name))) {
301             $newitemid = $DB->insert_record('grade_settings', $data);
302         } else {
303             $newitemid = $data->id;
304         }
306         $this->set_mapping('grade_setting', $oldid, $newitemid);
307     }
309     /**
310      * put all activity grade items in the correct grade category and mark all for recalculation
311      */
312     protected function after_execute() {
313         global $DB;
315         $conditions = array(
316             'backupid' => $this->get_restoreid(),
317             'itemname' => 'grade_item'//,
318             //'itemid'   => $itemid
319         );
320         $rs = $DB->get_recordset('backup_ids_temp', $conditions);
322         // We need this for calculation magic later on.
323         $mappings = array();
325         if (!empty($rs)) {
326             foreach($rs as $grade_item_backup) {
328                 // Store the oldid with the new id.
329                 $mappings[$grade_item_backup->itemid] = $grade_item_backup->newitemid;
331                 $updateobj = new stdclass();
332                 $updateobj->id = $grade_item_backup->newitemid;
334                 //if this is an activity grade item that needs to be put back in its correct category
335                 if (!empty($grade_item_backup->parentitemid)) {
336                     $oldcategoryid = $this->get_mappingid('grade_category', $grade_item_backup->parentitemid, null);
337                     if (!is_null($oldcategoryid)) {
338                         $updateobj->categoryid = $oldcategoryid;
339                         $DB->update_record('grade_items', $updateobj);
340                     }
341                 } else {
342                     //mark course and category items as needing to be recalculated
343                     $updateobj->needsupdate=1;
344                     $DB->update_record('grade_items', $updateobj);
345                 }
346             }
347         }
348         $rs->close();
350         // We need to update the calculations for calculated grade items that may reference old
351         // grade item ids using ##gi\d+##.
352         // $mappings can be empty, use 0 if so (won't match ever)
353         list($sql, $params) = $DB->get_in_or_equal(array_values($mappings), SQL_PARAMS_NAMED, 'param', true, 0);
354         $sql = "SELECT gi.id, gi.calculation
355                   FROM {grade_items} gi
356                  WHERE gi.id {$sql} AND
357                        calculation IS NOT NULL";
358         $rs = $DB->get_recordset_sql($sql, $params);
359         foreach ($rs as $gradeitem) {
360             // Collect all of the used grade item id references
361             if (preg_match_all('/##gi(\d+)##/', $gradeitem->calculation, $matches) < 1) {
362                 // This calculation doesn't reference any other grade items... EASY!
363                 continue;
364             }
365             // For this next bit we are going to do the replacement of id's in two steps:
366             // 1. We will replace all old id references with a special mapping reference.
367             // 2. We will replace all mapping references with id's
368             // Why do we do this?
369             // Because there potentially there will be an overlap of ids within the query and we
370             // we substitute the wrong id.. safest way around this is the two step system
371             $calculationmap = array();
372             $mapcount = 0;
373             foreach ($matches[1] as $match) {
374                 // Check that the old id is known to us, if not it was broken to begin with and will
375                 // continue to be broken.
376                 if (!array_key_exists($match, $mappings)) {
377                     continue;
378                 }
379                 // Our special mapping key
380                 $mapping = '##MAPPING'.$mapcount.'##';
381                 // The old id that exists within the calculation now
382                 $oldid = '##gi'.$match.'##';
383                 // The new id that we want to replace the old one with.
384                 $newid = '##gi'.$mappings[$match].'##';
385                 // Replace in the special mapping key
386                 $gradeitem->calculation = str_replace($oldid, $mapping, $gradeitem->calculation);
387                 // And record the mapping
388                 $calculationmap[$mapping] = $newid;
389                 $mapcount++;
390             }
391             // Iterate all special mappings for this calculation and replace in the new id's
392             foreach ($calculationmap as $mapping => $newid) {
393                 $gradeitem->calculation = str_replace($mapping, $newid, $gradeitem->calculation);
394             }
395             // Update the calculation now that its being remapped
396             $DB->update_record('grade_items', $gradeitem);
397         }
398         $rs->close();
400         // Need to correct the grade category path and parent
401         $conditions = array(
402             'courseid' => $this->get_courseid()
403         );
405         $rs = $DB->get_recordset('grade_categories', $conditions);
406         // Get all the parents correct first as grade_category::build_path() loads category parents from the DB
407         foreach ($rs as $gc) {
408             if (!empty($gc->parent)) {
409                 $grade_category = new stdClass();
410                 $grade_category->id = $gc->id;
411                 $grade_category->parent = $this->get_mappingid('grade_category', $gc->parent);
412                 $DB->update_record('grade_categories', $grade_category);
413             }
414         }
415         $rs->close();
417         // Now we can rebuild all the paths
418         $rs = $DB->get_recordset('grade_categories', $conditions);
419         foreach ($rs as $gc) {
420             $grade_category = new stdClass();
421             $grade_category->id = $gc->id;
422             $grade_category->path = grade_category::build_path($gc);
423             $grade_category->depth = substr_count($grade_category->path, '/') - 1;
424             $DB->update_record('grade_categories', $grade_category);
425         }
426         $rs->close();
428         // Restore marks items as needing update. Update everything now.
429         grade_regrade_final_grades($this->get_courseid());
430     }
433 /**
434  * decode all the interlinks present in restored content
435  * relying 100% in the restore_decode_processor that handles
436  * both the contents to modify and the rules to be applied
437  */
438 class restore_decode_interlinks extends restore_execution_step {
440     protected function define_execution() {
441         // Get the decoder (from the plan)
442         $decoder = $this->task->get_decoder();
443         restore_decode_processor::register_link_decoders($decoder); // Add decoder contents and rules
444         // And launch it, everything will be processed
445         $decoder->execute();
446     }
449 /**
450  * first, ensure that we have no gaps in section numbers
451  * and then, rebuid the course cache
452  */
453 class restore_rebuild_course_cache extends restore_execution_step {
455     protected function define_execution() {
456         global $DB;
458         // Although there is some sort of auto-recovery of missing sections
459         // present in course/formats... here we check that all the sections
460         // from 0 to MAX(section->section) exist, creating them if necessary
461         $maxsection = $DB->get_field('course_sections', 'MAX(section)', array('course' => $this->get_courseid()));
462         // Iterate over all sections
463         for ($i = 0; $i <= $maxsection; $i++) {
464             // If the section $i doesn't exist, create it
465             if (!$DB->record_exists('course_sections', array('course' => $this->get_courseid(), 'section' => $i))) {
466                 $sectionrec = array(
467                     'course' => $this->get_courseid(),
468                     'section' => $i);
469                 $DB->insert_record('course_sections', $sectionrec); // missing section created
470             }
471         }
473         // Rebuild cache now that all sections are in place
474         rebuild_course_cache($this->get_courseid());
475     }
478 /**
479  * Review all the tasks having one after_restore method
480  * executing it to perform some final adjustments of information
481  * not available when the task was executed.
482  */
483 class restore_execute_after_restore extends restore_execution_step {
485     protected function define_execution() {
487         // Simply call to the execute_after_restore() method of the task
488         // that always is the restore_final_task
489         $this->task->launch_execute_after_restore();
490     }
494 /**
495  * Review all the (pending) block positions in backup_ids, matching by
496  * contextid, creating positions as needed. This is executed by the
497  * final task, once all the contexts have been created
498  */
499 class restore_review_pending_block_positions extends restore_execution_step {
501     protected function define_execution() {
502         global $DB;
504         // Get all the block_position objects pending to match
505         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
506         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid');
507         // Process block positions, creating them or accumulating for final step
508         foreach($rs as $posrec) {
509             // Get the complete position object (stored as info)
510             $position = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'block_position', $posrec->itemid)->info;
511             // If position is for one already mapped (known) contextid
512             // process it now, creating the position, else nothing to
513             // do, position finally discarded
514             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
515                 $position->contextid = $newctx->newitemid;
516                 // Create the block position
517                 $DB->insert_record('block_positions', $position);
518             }
519         }
520         $rs->close();
521     }
524 /**
525  * Process all the saved module availability records in backup_ids, matching
526  * course modules and grade item id once all them have been already restored.
527  * only if all matchings are satisfied the availability condition will be created.
528  * At the same time, it is required for the site to have that functionality enabled.
529  */
530 class restore_process_course_modules_availability extends restore_execution_step {
532     protected function define_execution() {
533         global $CFG, $DB;
535         // Site hasn't availability enabled
536         if (empty($CFG->enableavailability)) {
537             return;
538         }
540         // Get all the module_availability objects to process
541         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'module_availability');
542         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid');
543         // Process availabilities, creating them if everything matches ok
544         foreach($rs as $availrec) {
545             $allmatchesok = true;
546             // Get the complete availabilityobject
547             $availability = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'module_availability', $availrec->itemid)->info;
548             // Map the sourcecmid if needed and possible
549             if (!empty($availability->sourcecmid)) {
550                 $newcm = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'course_module', $availability->sourcecmid);
551                 if ($newcm) {
552                     $availability->sourcecmid = $newcm->newitemid;
553                 } else {
554                     $allmatchesok = false; // Failed matching, we won't create this availability rule
555                 }
556             }
557             // Map the gradeitemid if needed and possible
558             if (!empty($availability->gradeitemid)) {
559                 $newgi = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'grade_item', $availability->gradeitemid);
560                 if ($newgi) {
561                     $availability->gradeitemid = $newgi->newitemid;
562                 } else {
563                     $allmatchesok = false; // Failed matching, we won't create this availability rule
564                 }
565             }
566             if ($allmatchesok) { // Everything ok, create the availability rule
567                 $DB->insert_record('course_modules_availability', $availability);
568             }
569         }
570         $rs->close();
571     }
575 /*
576  * Execution step that, *conditionally* (if there isn't preloaded information)
577  * will load the inforef files for all the included course/section/activity tasks
578  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
579  */
580 class restore_load_included_inforef_records extends restore_execution_step {
582     protected function define_execution() {
584         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
585             return;
586         }
588         // Get all the included tasks
589         $tasks = restore_dbops::get_included_tasks($this->get_restoreid());
590         foreach ($tasks as $task) {
591             // Load the inforef.xml file if exists
592             $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
593             if (file_exists($inforefpath)) {
594                 restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $inforefpath); // Load each inforef file to temp_ids
595             }
596         }
597     }
600 /*
601  * Execution step that will load all the needed files into backup_files_temp
602  *   - info: contains the whole original object (times, names...)
603  * (all them being original ids as loaded from xml)
604  */
605 class restore_load_included_files extends restore_structure_step {
607     protected function define_structure() {
609         $file = new restore_path_element('file', '/files/file');
611         return array($file);
612     }
614     /**
615      * Process one <file> element from files.xml
616      *
617      * @param array $data the element data
618      */
619     public function process_file($data) {
621         $data = (object)$data; // handy
623         // load it if needed:
624         //   - it it is one of the annotated inforef files (course/section/activity/block)
625         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
626         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
627         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
628         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
629         $iscomponent = ($data->component == 'user' || $data->component == 'group' ||
630                         $data->component == 'grouping' || $data->component == 'grade' ||
631                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
632         if ($isfileref || $iscomponent) {
633             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
634         }
635     }
638 /**
639  * Execution step that, *conditionally* (if there isn't preloaded information),
640  * will load all the needed roles to backup_temp_ids. They will be stored with
641  * "role" itemname. Also it will perform one automatic mapping to roles existing
642  * in the target site, based in permissions of the user performing the restore,
643  * archetypes and other bits. At the end, each original role will have its associated
644  * target role or 0 if it's going to be skipped. Note we wrap everything over one
645  * restore_dbops method, as far as the same stuff is going to be also executed
646  * by restore prechecks
647  */
648 class restore_load_and_map_roles extends restore_execution_step {
650     protected function define_execution() {
651         if ($this->task->get_preloaded_information()) { // if info is already preloaded
652             return;
653         }
655         $file = $this->get_basepath() . '/roles.xml';
656         // Load needed toles to temp_ids
657         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
659         // Process roles, mapping/skipping. Any error throws exception
660         // Note we pass controller's info because it can contain role mapping information
661         // about manual mappings performed by UI
662         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);
663     }
666 /**
667  * Execution step that, *conditionally* (if there isn't preloaded information
668  * and users have been selected in settings, will load all the needed users
669  * to backup_temp_ids. They will be stored with "user" itemname and with
670  * their original contextid as paremitemid
671  */
672 class restore_load_included_users extends restore_execution_step {
674     protected function define_execution() {
676         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
677             return;
678         }
679         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
680             return;
681         }
682         $file = $this->get_basepath() . '/users.xml';
683         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file); // Load needed users to temp_ids
684     }
687 /**
688  * Execution step that, *conditionally* (if there isn't preloaded information
689  * and users have been selected in settings, will process all the needed users
690  * in order to decide and perform any action with them (create / map / error)
691  * Note: Any error will cause exception, as far as this is the same processing
692  * than the one into restore prechecks (that should have stopped process earlier)
693  */
694 class restore_process_included_users extends restore_execution_step {
696     protected function define_execution() {
698         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
699             return;
700         }
701         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
702             return;
703         }
704         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
705     }
708 /**
709  * Execution step that will create all the needed users as calculated
710  * by @restore_process_included_users (those having newiteind = 0)
711  */
712 class restore_create_included_users extends restore_execution_step {
714     protected function define_execution() {
716         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(), $this->task->get_userid());
717     }
720 /**
721  * Structure step that will create all the needed groups and groupings
722  * by loading them from the groups.xml file performing the required matches.
723  * Note group members only will be added if restoring user info
724  */
725 class restore_groups_structure_step extends restore_structure_step {
727     protected function define_structure() {
729         $paths = array(); // Add paths here
731         $paths[] = new restore_path_element('group', '/groups/group');
732         if ($this->get_setting_value('users')) {
733             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
734         }
735         $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
736         $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
738         return $paths;
739     }
741     // Processing functions go here
742     public function process_group($data) {
743         global $DB;
745         $data = (object)$data; // handy
746         $data->courseid = $this->get_courseid();
748         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
749         // another a group in the same course
750         $context = context_course::instance($data->courseid);
751         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
752             if (groups_get_group_by_idnumber($data->courseid, $data->idnumber)) {
753                 unset($data->idnumber);
754             }
755         } else {
756             unset($data->idnumber);
757         }
759         $oldid = $data->id;    // need this saved for later
761         $restorefiles = false; // Only if we end creating the group
763         // Search if the group already exists (by name & description) in the target course
764         $description_clause = '';
765         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
766         if (!empty($data->description)) {
767             $description_clause = ' AND ' .
768                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
769            $params['description'] = $data->description;
770         }
771         if (!$groupdb = $DB->get_record_sql("SELECT *
772                                                FROM {groups}
773                                               WHERE courseid = :courseid
774                                                 AND name = :grname $description_clause", $params)) {
775             // group doesn't exist, create
776             $newitemid = $DB->insert_record('groups', $data);
777             $restorefiles = true; // We'll restore the files
778         } else {
779             // group exists, use it
780             $newitemid = $groupdb->id;
781         }
782         // Save the id mapping
783         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
784     }
786     public function process_member($data) {
787         global $DB;
789         $data = (object)$data; // handy
791         // get parent group->id
792         $data->groupid = $this->get_new_parentid('group');
794         // map user newitemid and insert if not member already
795         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
796             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
797                 $DB->insert_record('groups_members', $data);
798             }
799         }
800     }
802     public function process_grouping($data) {
803         global $DB;
805         $data = (object)$data; // handy
806         $data->courseid = $this->get_courseid();
808         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
809         // another a grouping in the same course
810         $context = context_course::instance($data->courseid);
811         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
812             if (groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) {
813                 unset($data->idnumber);
814             }
815         } else {
816             unset($data->idnumber);
817         }
819         $oldid = $data->id;    // need this saved for later
820         $restorefiles = false; // Only if we end creating the grouping
822         // Search if the grouping already exists (by name & description) in the target course
823         $description_clause = '';
824         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
825         if (!empty($data->description)) {
826             $description_clause = ' AND ' .
827                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
828            $params['description'] = $data->description;
829         }
830         if (!$groupingdb = $DB->get_record_sql("SELECT *
831                                                   FROM {groupings}
832                                                  WHERE courseid = :courseid
833                                                    AND name = :grname $description_clause", $params)) {
834             // grouping doesn't exist, create
835             $newitemid = $DB->insert_record('groupings', $data);
836             $restorefiles = true; // We'll restore the files
837         } else {
838             // grouping exists, use it
839             $newitemid = $groupingdb->id;
840         }
841         // Save the id mapping
842         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
843     }
845     public function process_grouping_group($data) {
846         global $DB;
848         $data = (object)$data;
850         $data->groupingid = $this->get_new_parentid('grouping'); // Use new parentid
851         $data->groupid    = $this->get_mappingid('group', $data->groupid); // Get from mappings
853         $params = array();
854         $params['groupingid'] = $data->groupingid;
855         $params['groupid']    = $data->groupid;
857         if (!$DB->record_exists('groupings_groups', $params)) {
858             $DB->insert_record('groupings_groups', $data);  // No need to set this mapping (no child info nor files)
859         }
860     }
862     protected function after_execute() {
863         // Add group related files, matching with "group" mappings
864         $this->add_related_files('group', 'icon', 'group');
865         $this->add_related_files('group', 'description', 'group');
866         // Add grouping related files, matching with "grouping" mappings
867         $this->add_related_files('grouping', 'description', 'grouping');
868     }
872 /**
873  * Structure step that will create all the needed scales
874  * by loading them from the scales.xml
875  */
876 class restore_scales_structure_step extends restore_structure_step {
878     protected function define_structure() {
880         $paths = array(); // Add paths here
881         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
882         return $paths;
883     }
885     protected function process_scale($data) {
886         global $DB;
888         $data = (object)$data;
890         $restorefiles = false; // Only if we end creating the group
892         $oldid = $data->id;    // need this saved for later
894         // Look for scale (by 'scale' both in standard (course=0) and current course
895         // with priority to standard scales (ORDER clause)
896         // scale is not course unique, use get_record_sql to suppress warning
897         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
898         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
899         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
900         if (!$scadb = $DB->get_record_sql("SELECT *
901                                             FROM {scale}
902                                            WHERE courseid IN (0, :courseid)
903                                              AND $compare_scale_clause
904                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
905             // Remap the user if possible, defaut to user performing the restore if not
906             $userid = $this->get_mappingid('user', $data->userid);
907             $data->userid = $userid ? $userid : $this->task->get_userid();
908             // Remap the course if course scale
909             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
910             // If global scale (course=0), check the user has perms to create it
911             // falling to course scale if not
912             $systemctx = get_context_instance(CONTEXT_SYSTEM);
913             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
914                 $data->courseid = $this->get_courseid();
915             }
916             // scale doesn't exist, create
917             $newitemid = $DB->insert_record('scale', $data);
918             $restorefiles = true; // We'll restore the files
919         } else {
920             // scale exists, use it
921             $newitemid = $scadb->id;
922         }
923         // Save the id mapping (with files support at system context)
924         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
925     }
927     protected function after_execute() {
928         // Add scales related files, matching with "scale" mappings
929         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
930     }
934 /**
935  * Structure step that will create all the needed outocomes
936  * by loading them from the outcomes.xml
937  */
938 class restore_outcomes_structure_step extends restore_structure_step {
940     protected function define_structure() {
942         $paths = array(); // Add paths here
943         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
944         return $paths;
945     }
947     protected function process_outcome($data) {
948         global $DB;
950         $data = (object)$data;
952         $restorefiles = false; // Only if we end creating the group
954         $oldid = $data->id;    // need this saved for later
956         // Look for outcome (by shortname both in standard (courseid=null) and current course
957         // with priority to standard outcomes (ORDER clause)
958         // outcome is not course unique, use get_record_sql to suppress warning
959         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
960         if (!$outdb = $DB->get_record_sql('SELECT *
961                                              FROM {grade_outcomes}
962                                             WHERE shortname = :shortname
963                                               AND (courseid = :courseid OR courseid IS NULL)
964                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
965             // Remap the user
966             $userid = $this->get_mappingid('user', $data->usermodified);
967             $data->usermodified = $userid ? $userid : $this->task->get_userid();
968             // Remap the scale
969             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
970             // Remap the course if course outcome
971             $data->courseid = $data->courseid ? $this->get_courseid() : null;
972             // If global outcome (course=null), check the user has perms to create it
973             // falling to course outcome if not
974             $systemctx = get_context_instance(CONTEXT_SYSTEM);
975             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
976                 $data->courseid = $this->get_courseid();
977             }
978             // outcome doesn't exist, create
979             $newitemid = $DB->insert_record('grade_outcomes', $data);
980             $restorefiles = true; // We'll restore the files
981         } else {
982             // scale exists, use it
983             $newitemid = $outdb->id;
984         }
985         // Set the corresponding grade_outcomes_courses record
986         $outcourserec = new stdclass();
987         $outcourserec->courseid  = $this->get_courseid();
988         $outcourserec->outcomeid = $newitemid;
989         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
990             $DB->insert_record('grade_outcomes_courses', $outcourserec);
991         }
992         // Save the id mapping (with files support at system context)
993         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
994     }
996     protected function after_execute() {
997         // Add outcomes related files, matching with "outcome" mappings
998         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
999     }
1002 /**
1003  * Execution step that, *conditionally* (if there isn't preloaded information
1004  * will load all the question categories and questions (header info only)
1005  * to backup_temp_ids. They will be stored with "question_category" and
1006  * "question" itemnames and with their original contextid and question category
1007  * id as paremitemids
1008  */
1009 class restore_load_categories_and_questions extends restore_execution_step {
1011     protected function define_execution() {
1013         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1014             return;
1015         }
1016         $file = $this->get_basepath() . '/questions.xml';
1017         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
1018     }
1021 /**
1022  * Execution step that, *conditionally* (if there isn't preloaded information)
1023  * will process all the needed categories and questions
1024  * in order to decide and perform any action with them (create / map / error)
1025  * Note: Any error will cause exception, as far as this is the same processing
1026  * than the one into restore prechecks (that should have stopped process earlier)
1027  */
1028 class restore_process_categories_and_questions extends restore_execution_step {
1030     protected function define_execution() {
1032         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1033             return;
1034         }
1035         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
1036     }
1039 /**
1040  * Structure step that will read the section.xml creating/updating sections
1041  * as needed, rebuilding course cache and other friends
1042  */
1043 class restore_section_structure_step extends restore_structure_step {
1045     protected function define_structure() {
1046         global $CFG;
1048         $paths = array();
1050         $section = new restore_path_element('section', '/section');
1051         $paths[] = $section;
1052         if ($CFG->enableavailability) {
1053             $paths[] = new restore_path_element('availability', '/section/availability');
1054         }
1056         // Apply for 'format' plugins optional paths at section level
1057         $this->add_plugin_structure('format', $section);
1059         return $paths;
1060     }
1062     public function process_section($data) {
1063         global $CFG, $DB;
1064         $data = (object)$data;
1065         $oldid = $data->id; // We'll need this later
1067         $restorefiles = false;
1069         // Look for the section
1070         $section = new stdclass();
1071         $section->course  = $this->get_courseid();
1072         $section->section = $data->number;
1073         // Section doesn't exist, create it with all the info from backup
1074         if (!$secrec = $DB->get_record('course_sections', (array)$section)) {
1075             $section->name = $data->name;
1076             $section->summary = $data->summary;
1077             $section->summaryformat = $data->summaryformat;
1078             $section->sequence = '';
1079             $section->visible = $data->visible;
1080             if (empty($CFG->enableavailability)) { // Process availability information only if enabled.
1081                 $section->availablefrom = 0;
1082                 $section->availableuntil = 0;
1083                 $section->showavailability = 0;
1084             } else {
1085                 $section->availablefrom = isset($data->availablefrom) ? $this->apply_date_offset($data->availablefrom) : 0;
1086                 $section->availableuntil = isset($data->availableuntil) ? $this->apply_date_offset($data->availableuntil) : 0;
1087                 $section->showavailability = isset($data->showavailability) ? $data->showavailability : 0;
1088             }
1089             if (!empty($CFG->enablegroupmembersonly)) { // Only if enablegroupmembersonly is enabled
1090                 $section->groupingid = isset($data->groupingid) ? $this->get_mappingid('grouping', $data->groupingid) : 0;
1091             }
1092             $newitemid = $DB->insert_record('course_sections', $section);
1093             $restorefiles = true;
1095         // Section exists, update non-empty information
1096         } else {
1097             $section->id = $secrec->id;
1098             if ((string)$secrec->name === '') {
1099                 $section->name = $data->name;
1100             }
1101             if (empty($secrec->summary)) {
1102                 $section->summary = $data->summary;
1103                 $section->summaryformat = $data->summaryformat;
1104                 $restorefiles = true;
1105             }
1106             if (empty($secrec->groupingid)) {
1107                 if (!empty($CFG->enablegroupmembersonly)) { // Only if enablegroupmembersonly is enabled
1108                     $section->groupingid = isset($data->groupingid) ? $this->get_mappingid('grouping', $data->groupingid) : 0;
1109                 }
1110             }
1112             // Don't update available from, available until, or show availability
1113             // (I didn't see a useful way to define whether existing or new one should
1114             // take precedence).
1116             $DB->update_record('course_sections', $section);
1117             $newitemid = $secrec->id;
1118         }
1120         // Annotate the section mapping, with restorefiles option if needed
1121         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
1123         // set the new course_section id in the task
1124         $this->task->set_sectionid($newitemid);
1127         // Commented out. We never modify course->numsections as far as that is used
1128         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
1129         // Note: We keep the code here, to know about and because of the possibility of making this
1130         // optional based on some setting/attribute in the future
1131         // If needed, adjust course->numsections
1132         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
1133         //    if ($numsections < $section->section) {
1134         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
1135         //    }
1136         //}
1137     }
1139     public function process_availability($data) {
1140         global $DB;
1141         $data = (object)$data;
1143         $data->coursesectionid = $this->task->get_sectionid();
1145         // NOTE: Other values in $data need updating, but these (cm,
1146         // grade items) have not yet been restored, so are done later.
1148         $newid = $DB->insert_record('course_sections_availability', $data);
1150         // We do not need to map between old and new id but storing a mapping
1151         // means it gets added to the backup_ids table to record which ones
1152         // need updating. The mapping is stored with $newid => $newid for
1153         // convenience.
1154         $this->set_mapping('course_sections_availability', $newid, $newid);
1155     }
1157     protected function after_execute() {
1158         // Add section related files, with 'course_section' itemid to match
1159         $this->add_related_files('course', 'section', 'course_section');
1160     }
1162     public function after_restore() {
1163         global $DB;
1165         $sectionid = $this->get_task()->get_sectionid();
1167         // Get data object for current section availability (if any).
1168         $records = $DB->get_records('course_sections_availability',
1169                 array('coursesectionid' => $sectionid), 'id, sourcecmid, gradeitemid');
1171         // If it exists, update mappings.
1172         foreach ($records as $data) {
1173             // Only update mappings for entries which are created by this restore.
1174             // Otherwise, when you restore to an existing course, it will mess up
1175             // existing section availability entries.
1176             if (!$this->get_mappingid('course_sections_availability', $data->id, false)) {
1177                 return;
1178             }
1180             // Update source cmid / grade id to new value.
1181             $data->sourcecmid = $this->get_mappingid('course_module', $data->sourcecmid);
1182             if (!$data->sourcecmid) {
1183                 $data->sourcecmid = null;
1184             }
1185             $data->gradeitemid = $this->get_mappingid('grade_item', $data->gradeitemid);
1186             if (!$data->gradeitemid) {
1187                 $data->gradeitemid = null;
1188             }
1190             $DB->update_record('course_sections_availability', $data);
1191         }
1192     }
1196 /**
1197  * Structure step that will read the course.xml file, loading it and performing
1198  * various actions depending of the site/restore settings. Note that target
1199  * course always exist before arriving here so this step will be updating
1200  * the course record (never inserting)
1201  */
1202 class restore_course_structure_step extends restore_structure_step {
1203     /**
1204      * @var bool this gets set to true by {@link process_course()} if we are
1205      * restoring an old coures that used the legacy 'module security' feature.
1206      * If so, we have to do more work in {@link after_execute()}.
1207      */
1208     protected $legacyrestrictmodules = false;
1210     /**
1211      * @var array Used when {@link $legacyrestrictmodules} is true. This is an
1212      * array with array keys the module names ('forum', 'quiz', etc.). These are
1213      * the modules that are allowed according to the data in the backup file.
1214      * In {@link after_execute()} we then have to prevent adding of all the other
1215      * types of activity.
1216      */
1217     protected $legacyallowedmodules = array();
1219     protected function define_structure() {
1221         $course = new restore_path_element('course', '/course');
1222         $category = new restore_path_element('category', '/course/category');
1223         $tag = new restore_path_element('tag', '/course/tags/tag');
1224         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1226         // Apply for 'format' plugins optional paths at course level
1227         $this->add_plugin_structure('format', $course);
1229         // Apply for 'theme' plugins optional paths at course level
1230         $this->add_plugin_structure('theme', $course);
1232         // Apply for 'report' plugins optional paths at course level
1233         $this->add_plugin_structure('report', $course);
1235         // Apply for 'course report' plugins optional paths at course level
1236         $this->add_plugin_structure('coursereport', $course);
1238         // Apply for plagiarism plugins optional paths at course level
1239         $this->add_plugin_structure('plagiarism', $course);
1241         return array($course, $category, $tag, $allowed_module);
1242     }
1244     /**
1245      * Processing functions go here
1246      *
1247      * @global moodledatabase $DB
1248      * @param stdClass $data
1249      */
1250     public function process_course($data) {
1251         global $CFG, $DB;
1253         $data = (object)$data;
1255         $fullname  = $this->get_setting_value('course_fullname');
1256         $shortname = $this->get_setting_value('course_shortname');
1257         $startdate = $this->get_setting_value('course_startdate');
1259         // Calculate final course names, to avoid dupes
1260         list($fullname, $shortname) = restore_dbops::calculate_course_names($this->get_courseid(), $fullname, $shortname);
1262         // Need to change some fields before updating the course record
1263         $data->id = $this->get_courseid();
1264         $data->fullname = $fullname;
1265         $data->shortname= $shortname;
1267         $context = get_context_instance_by_id($this->task->get_contextid());
1268         if (has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1269             $data->idnumber = '';
1270         } else {
1271             unset($data->idnumber);
1272         }
1274         // Any empty value for course->hiddensections will lead to 0 (default, show collapsed).
1275         // It has been reported that some old 1.9 courses may have it null leading to DB error. MDL-31532
1276         if (empty($data->hiddensections)) {
1277             $data->hiddensections = 0;
1278         }
1280         // Set legacyrestrictmodules to true if the course was resticting modules. If so
1281         // then we will need to process restricted modules after execution.
1282         $this->legacyrestrictmodules = !empty($data->restrictmodules);
1284         $data->startdate= $this->apply_date_offset($data->startdate);
1285         if ($data->defaultgroupingid) {
1286             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1287         }
1288         if (empty($CFG->enablecompletion)) {
1289             $data->enablecompletion = 0;
1290             $data->completionstartonenrol = 0;
1291             $data->completionnotify = 0;
1292         }
1293         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1294         if (!array_key_exists($data->lang, $languages)) {
1295             $data->lang = '';
1296         }
1298         $themes = get_list_of_themes(); // Get themes for quick search later
1299         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1300             $data->theme = '';
1301         }
1303         // Course record ready, update it
1304         $DB->update_record('course', $data);
1306         // Role name aliases
1307         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1308     }
1310     public function process_category($data) {
1311         // Nothing to do with the category. UI sets it before restore starts
1312     }
1314     public function process_tag($data) {
1315         global $CFG, $DB;
1317         $data = (object)$data;
1319         if (!empty($CFG->usetags)) { // if enabled in server
1320             // TODO: This is highly inneficient. Each time we add one tag
1321             // we fetch all the existing because tag_set() deletes them
1322             // so everything must be reinserted on each call
1323             $tags = array();
1324             $existingtags = tag_get_tags('course', $this->get_courseid());
1325             // Re-add all the existitng tags
1326             foreach ($existingtags as $existingtag) {
1327                 $tags[] = $existingtag->rawname;
1328             }
1329             // Add the one being restored
1330             $tags[] = $data->rawname;
1331             // Send all the tags back to the course
1332             tag_set('course', $this->get_courseid(), $tags);
1333         }
1334     }
1336     public function process_allowed_module($data) {
1337         $data = (object)$data;
1339         // Backwards compatiblity support for the data that used to be in the
1340         // course_allowed_modules table.
1341         if ($this->legacyrestrictmodules) {
1342             $this->legacyallowedmodules[$data->modulename] = 1;
1343         }
1344     }
1346     protected function after_execute() {
1347         global $DB;
1349         // Add course related files, without itemid to match
1350         $this->add_related_files('course', 'summary', null);
1351         $this->add_related_files('course', 'legacy', null);
1353         // Deal with legacy allowed modules.
1354         if ($this->legacyrestrictmodules) {
1355             $context = context_course::instance($this->get_courseid());
1357             list($roleids) = get_roles_with_cap_in_context($context, 'moodle/course:manageactivities');
1358             list($managerroleids) = get_roles_with_cap_in_context($context, 'moodle/site:config');
1359             foreach ($managerroleids as $roleid) {
1360                 unset($roleids[$roleid]);
1361             }
1363             foreach (get_plugin_list('mod') as $modname => $notused) {
1364                 if (isset($this->legacyallowedmodules[$modname])) {
1365                     // Module is allowed, no worries.
1366                     continue;
1367                 }
1369                 $capability = 'mod/' . $modname . ':addinstance';
1370                 foreach ($roleids as $roleid) {
1371                     assign_capability($capability, CAP_PREVENT, $roleid, $context);
1372                 }
1373             }
1374         }
1375     }
1379 /*
1380  * Structure step that will read the roles.xml file (at course/activity/block levels)
1381  * containig all the role_assignments and overrides for that context. If corresponding to
1382  * one mapped role, they will be applied to target context. Will observe the role_assignments
1383  * setting to decide if ras are restored.
1384  * Note: only ras with component == null are restored as far as the any ra with component
1385  * is handled by one enrolment plugin, hence it will createt the ras later
1386  */
1387 class restore_ras_and_caps_structure_step extends restore_structure_step {
1389     protected function define_structure() {
1391         $paths = array();
1393         // Observe the role_assignments setting
1394         if ($this->get_setting_value('role_assignments')) {
1395             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
1396         }
1397         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
1399         return $paths;
1400     }
1402     /**
1403      * Assign roles
1404      *
1405      * This has to be called after enrolments processing.
1406      *
1407      * @param mixed $data
1408      * @return void
1409      */
1410     public function process_assignment($data) {
1411         global $DB;
1413         $data = (object)$data;
1415         // Check roleid, userid are one of the mapped ones
1416         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
1417             return;
1418         }
1419         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
1420             return;
1421         }
1422         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
1423             // Only assign roles to not deleted users
1424             return;
1425         }
1426         if (!$contextid = $this->task->get_contextid()) {
1427             return;
1428         }
1430         if (empty($data->component)) {
1431             // assign standard manual roles
1432             // TODO: role_assign() needs one userid param to be able to specify our restore userid
1433             role_assign($newroleid, $newuserid, $contextid);
1435         } else if ((strpos($data->component, 'enrol_') === 0)) {
1436             // Deal with enrolment roles
1437             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1438                 if ($component = $DB->get_field('enrol', 'component', array('id'=>$enrolid))) {
1439                     //note: we have to verify component because it might have changed
1440                     if ($component === 'enrol_manual') {
1441                         // manual is a special case, we do not use components - this owudl happen when converting from other plugin
1442                         role_assign($newroleid, $newuserid, $contextid); //TODO: do we need modifierid?
1443                     } else {
1444                         role_assign($newroleid, $newuserid, $contextid, $component, $enrolid); //TODO: do we need modifierid?
1445                     }
1446                 }
1447             }
1448         }
1449     }
1451     public function process_override($data) {
1452         $data = (object)$data;
1454         // Check roleid is one of the mapped ones
1455         $newroleid = $this->get_mappingid('role', $data->roleid);
1456         // If newroleid and context are valid assign it via API (it handles dupes and so on)
1457         if ($newroleid && $this->task->get_contextid()) {
1458             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
1459             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
1460             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
1461         }
1462     }
1465 /**
1466  * This structure steps restores the enrol plugins and their underlying
1467  * enrolments, performing all the mappings and/or movements required
1468  */
1469 class restore_enrolments_structure_step extends restore_structure_step {
1471     /**
1472      * Conditionally decide if this step should be executed.
1473      *
1474      * This function checks the following parameter:
1475      *
1476      *   1. the course/enrolments.xml file exists
1477      *
1478      * @return bool true is safe to execute, false otherwise
1479      */
1480     protected function execute_condition() {
1482         // Check it is included in the backup
1483         $fullpath = $this->task->get_taskbasepath();
1484         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1485         if (!file_exists($fullpath)) {
1486             // Not found, can't restore enrolments info
1487             return false;
1488         }
1490         return true;
1491     }
1493     protected function define_structure() {
1495         $paths = array();
1497         $paths[] = new restore_path_element('enrol', '/enrolments/enrols/enrol');
1498         $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
1500         return $paths;
1501     }
1503     /**
1504      * Create enrolment instances.
1505      *
1506      * This has to be called after creation of roles
1507      * and before adding of role assignments.
1508      *
1509      * @param mixed $data
1510      * @return void
1511      */
1512     public function process_enrol($data) {
1513         global $DB;
1515         $data = (object)$data;
1516         $oldid = $data->id; // We'll need this later
1518         $restoretype = plugin_supports('enrol', $data->enrol, ENROL_RESTORE_TYPE, null);
1520         if ($restoretype !== ENROL_RESTORE_EXACT and $restoretype !== ENROL_RESTORE_NOUSERS) {
1521             // TODO: add complex restore support via custom class
1522             debugging("Skipping '{$data->enrol}' enrolment plugin. Will be implemented before 2.0 release", DEBUG_DEVELOPER);
1523             $this->set_mapping('enrol', $oldid, 0);
1524             return;
1525         }
1527         // Perform various checks to decide what to do with the enrol plugin
1528         if (!array_key_exists($data->enrol, enrol_get_plugins(false))) {
1529             // TODO: decide if we want to switch to manual enrol - we need UI for this
1530             debugging("Enrol plugin data can not be restored because it is not installed");
1531             $this->set_mapping('enrol', $oldid, 0);
1532             return;
1534         }
1535         if (!enrol_is_enabled($data->enrol)) {
1536             // TODO: decide if we want to switch to manual enrol - we need UI for this
1537             debugging("Enrol plugin data can not be restored because it is not enabled");
1538             $this->set_mapping('enrol', $oldid, 0);
1539             return;
1540         }
1542         // map standard fields - plugin has to process custom fields from own restore class
1543         $data->roleid = $this->get_mappingid('role', $data->roleid);
1544         //TODO: should we move the enrol start and end date here?
1546         // always add instance, if the course does not support multiple instances it just returns NULL
1547         $enrol = enrol_get_plugin($data->enrol);
1548         $courserec = $DB->get_record('course', array('id' => $this->get_courseid())); // Requires object, uses only id!!
1549         if ($newitemid = $enrol->add_instance($courserec, (array)$data)) {
1550             // ok
1551         } else {
1552             if ($instances = $DB->get_records('enrol', array('courseid'=>$courserec->id, 'enrol'=>$data->enrol))) {
1553                 // most probably plugin that supports only one instance
1554                 $newitemid = key($instances);
1555             } else {
1556                 debugging('Can not create new enrol instance or reuse existing');
1557                 $newitemid = 0;
1558             }
1559         }
1561         if ($restoretype === ENROL_RESTORE_NOUSERS) {
1562             // plugin requests to prevent restore of any users
1563             $newitemid = 0;
1564         }
1566         $this->set_mapping('enrol', $oldid, $newitemid);
1567     }
1569     /**
1570      * Create user enrolments
1571      *
1572      * This has to be called after creation of enrolment instances
1573      * and before adding of role assignments.
1574      *
1575      * @param mixed $data
1576      * @return void
1577      */
1578     public function process_enrolment($data) {
1579         global $DB;
1581         $data = (object)$data;
1583         // Process only if parent instance have been mapped
1584         if ($enrolid = $this->get_new_parentid('enrol')) {
1585             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1586                 // And only if user is a mapped one
1587                 if ($userid = $this->get_mappingid('user', $data->userid)) {
1588                     $enrol = enrol_get_plugin($instance->enrol);
1589                     //TODO: do we need specify modifierid?
1590                     $enrol->enrol_user($instance, $userid, null, $data->timestart, $data->timeend, $data->status);
1591                     //note: roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing above
1592                 }
1593             }
1594         }
1595     }
1599 /**
1600  * Make sure the user restoring the course can actually access it.
1601  */
1602 class restore_fix_restorer_access_step extends restore_execution_step {
1603     protected function define_execution() {
1604         global $CFG, $DB;
1606         if (!$userid = $this->task->get_userid()) {
1607             return;
1608         }
1610         if (empty($CFG->restorernewroleid)) {
1611             // Bad luck, no fallback role for restorers specified
1612             return;
1613         }
1615         $courseid = $this->get_courseid();
1616         $context = context_course::instance($courseid);
1618         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1619             // Current user may access the course (admin, category manager or restored teacher enrolment usually)
1620             return;
1621         }
1623         // Try to add role only - we do not need enrolment if user has moodle/course:view or is already enrolled
1624         role_assign($CFG->restorernewroleid, $userid, $context);
1626         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1627             // Extra role is enough, yay!
1628             return;
1629         }
1631         // The last chance is to create manual enrol if it does not exist and and try to enrol the current user,
1632         // hopefully admin selected suitable $CFG->restorernewroleid ...
1633         if (!enrol_is_enabled('manual')) {
1634             return;
1635         }
1636         if (!$enrol = enrol_get_plugin('manual')) {
1637             return;
1638         }
1639         if (!$DB->record_exists('enrol', array('enrol'=>'manual', 'courseid'=>$courseid))) {
1640             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
1641             $fields = array('status'=>ENROL_INSTANCE_ENABLED, 'enrolperiod'=>$enrol->get_config('enrolperiod', 0), 'roleid'=>$enrol->get_config('roleid', 0));
1642             $enrol->add_instance($course, $fields);
1643         }
1645         enrol_try_internal_enrol($courseid, $userid);
1646     }
1650 /**
1651  * This structure steps restores the filters and their configs
1652  */
1653 class restore_filters_structure_step extends restore_structure_step {
1655     protected function define_structure() {
1657         $paths = array();
1659         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
1660         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
1662         return $paths;
1663     }
1665     public function process_active($data) {
1667         $data = (object)$data;
1669         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1670             return;
1671         }
1672         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
1673     }
1675     public function process_config($data) {
1677         $data = (object)$data;
1679         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1680             return;
1681         }
1682         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
1683     }
1687 /**
1688  * This structure steps restores the comments
1689  * Note: Cannot use the comments API because defaults to USER->id.
1690  * That should change allowing to pass $userid
1691  */
1692 class restore_comments_structure_step extends restore_structure_step {
1694     protected function define_structure() {
1696         $paths = array();
1698         $paths[] = new restore_path_element('comment', '/comments/comment');
1700         return $paths;
1701     }
1703     public function process_comment($data) {
1704         global $DB;
1706         $data = (object)$data;
1708         // First of all, if the comment has some itemid, ask to the task what to map
1709         $mapping = false;
1710         if ($data->itemid) {
1711             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
1712             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
1713         }
1714         // Only restore the comment if has no mapping OR we have found the matching mapping
1715         if (!$mapping || $data->itemid) {
1716             // Only if user mapping and context
1717             $data->userid = $this->get_mappingid('user', $data->userid);
1718             if ($data->userid && $this->task->get_contextid()) {
1719                 $data->contextid = $this->task->get_contextid();
1720                 // Only if there is another comment with same context/user/timecreated
1721                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
1722                 if (!$DB->record_exists('comments', $params)) {
1723                     $DB->insert_record('comments', $data);
1724                 }
1725             }
1726         }
1727     }
1730 /**
1731  * This structure steps restores the calendar events
1732  */
1733 class restore_calendarevents_structure_step extends restore_structure_step {
1735     protected function define_structure() {
1737         $paths = array();
1739         $paths[] = new restore_path_element('calendarevents', '/events/event');
1741         return $paths;
1742     }
1744     public function process_calendarevents($data) {
1745         global $DB;
1747         $data = (object)$data;
1748         $oldid = $data->id;
1749         $restorefiles = true; // We'll restore the files
1750         // Find the userid and the groupid associated with the event. Return if not found.
1751         $data->userid = $this->get_mappingid('user', $data->userid);
1752         if ($data->userid === false) {
1753             return;
1754         }
1755         if (!empty($data->groupid)) {
1756             $data->groupid = $this->get_mappingid('group', $data->groupid);
1757             if ($data->groupid === false) {
1758                 return;
1759             }
1760         }
1761         // Handle events with empty eventtype //MDL-32827
1762         if(empty($data->eventtype)) {
1763             if ($data->courseid == $SITE->id) {                                // Site event
1764                 $data->eventtype = "site";
1765             } else if ($data->courseid != 0 && $data->groupid == 0 && ($data->modulename == 'assignment' || $data->modulename == 'assign')) {
1766                 // Course assingment event
1767                 $data->eventtype = "due";
1768             } else if ($data->courseid != 0 && $data->groupid == 0) {      // Course event
1769                 $data->eventtype = "course";
1770             } else if ($data->groupid) {                                      // Group event
1771                 $data->eventtype = "group";
1772             } else if ($data->userid) {                                       // User event
1773                 $data->eventtype = "user";
1774             } else {
1775                 return;
1776             }
1777         }
1779         $params = array(
1780                 'name'           => $data->name,
1781                 'description'    => $data->description,
1782                 'format'         => $data->format,
1783                 'courseid'       => $this->get_courseid(),
1784                 'groupid'        => $data->groupid,
1785                 'userid'         => $data->userid,
1786                 'repeatid'       => $data->repeatid,
1787                 'modulename'     => $data->modulename,
1788                 'eventtype'      => $data->eventtype,
1789                 'timestart'      => $this->apply_date_offset($data->timestart),
1790                 'timeduration'   => $data->timeduration,
1791                 'visible'        => $data->visible,
1792                 'uuid'           => $data->uuid,
1793                 'sequence'       => $data->sequence,
1794                 'timemodified'    => $this->apply_date_offset($data->timemodified));
1795         if ($this->name == 'activity_calendar') {
1796             $params['instance'] = $this->task->get_activityid();
1797         } else {
1798             $params['instance'] = 0;
1799         }
1800         $sql = 'SELECT id FROM {event} WHERE name = ? AND courseid = ? AND
1801                 repeatid = ? AND modulename = ? AND timestart = ? AND timeduration =?
1802                 AND ' . $DB->sql_compare_text('description', 255) . ' = ' . $DB->sql_compare_text('?', 255);
1803         $arg = array ($params['name'], $params['courseid'], $params['repeatid'], $params['modulename'], $params['timestart'], $params['timeduration'], $params['description']);
1804         $result = $DB->record_exists_sql($sql, $arg);
1805         if (empty($result)) {
1806             $newitemid = $DB->insert_record('event', $params);
1807             $this->set_mapping('event_description', $oldid, $newitemid, $restorefiles);
1808         }
1810     }
1811     protected function after_execute() {
1812         // Add related files
1813         $this->add_related_files('calendar', 'event_description', 'event_description');
1814     }
1817 class restore_course_completion_structure_step extends restore_structure_step {
1819     /**
1820      * Conditionally decide if this step should be executed.
1821      *
1822      * This function checks parameters that are not immediate settings to ensure
1823      * that the enviroment is suitable for the restore of course completion info.
1824      *
1825      * This function checks the following four parameters:
1826      *
1827      *   1. Course completion is enabled on the site
1828      *   2. The backup includes course completion information
1829      *   3. All modules are restorable
1830      *   4. All modules are marked for restore.
1831      *
1832      * @return bool True is safe to execute, false otherwise
1833      */
1834     protected function execute_condition() {
1835         global $CFG;
1837         // First check course completion is enabled on this site
1838         if (empty($CFG->enablecompletion)) {
1839             // Disabled, don't restore course completion
1840             return false;
1841         }
1843         // Check it is included in the backup
1844         $fullpath = $this->task->get_taskbasepath();
1845         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1846         if (!file_exists($fullpath)) {
1847             // Not found, can't restore course completion
1848             return false;
1849         }
1851         // Check we are able to restore all backed up modules
1852         if ($this->task->is_missing_modules()) {
1853             return false;
1854         }
1856         // Finally check all modules within the backup are being restored.
1857         if ($this->task->is_excluding_activities()) {
1858             return false;
1859         }
1861         return true;
1862     }
1864     /**
1865      * Define the course completion structure
1866      *
1867      * @return array Array of restore_path_element
1868      */
1869     protected function define_structure() {
1871         // To know if we are including user completion info
1872         $userinfo = $this->get_setting_value('userscompletion');
1874         $paths = array();
1875         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
1876         $paths[] = new restore_path_element('course_completion_notify', '/course_completion/course_completion_notify');
1877         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
1879         if ($userinfo) {
1880             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
1881             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
1882         }
1884         return $paths;
1886     }
1888     /**
1889      * Process course completion criteria
1890      *
1891      * @global moodle_database $DB
1892      * @param stdClass $data
1893      */
1894     public function process_course_completion_criteria($data) {
1895         global $DB;
1897         $data = (object)$data;
1898         $data->course = $this->get_courseid();
1900         // Apply the date offset to the time end field
1901         $data->timeend = $this->apply_date_offset($data->timeend);
1903         // Map the role from the criteria
1904         if (!empty($data->role)) {
1905             $data->role = $this->get_mappingid('role', $data->role);
1906         }
1908         $skipcriteria = false;
1910         // If the completion criteria is for a module we need to map the module instance
1911         // to the new module id.
1912         if (!empty($data->moduleinstance) && !empty($data->module)) {
1913             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
1914             if (empty($data->moduleinstance)) {
1915                 $skipcriteria = true;
1916             }
1917         } else {
1918             $data->module = null;
1919             $data->moduleinstance = null;
1920         }
1922         // We backup the course shortname rather than the ID so that we can match back to the course
1923         if (!empty($data->courseinstanceshortname)) {
1924             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
1925             if (!$courseinstanceid) {
1926                 $skipcriteria = true;
1927             }
1928         } else {
1929             $courseinstanceid = null;
1930         }
1931         $data->courseinstance = $courseinstanceid;
1933         if (!$skipcriteria) {
1934             $params = array(
1935                 'course'         => $data->course,
1936                 'criteriatype'   => $data->criteriatype,
1937                 'enrolperiod'    => $data->enrolperiod,
1938                 'courseinstance' => $data->courseinstance,
1939                 'module'         => $data->module,
1940                 'moduleinstance' => $data->moduleinstance,
1941                 'timeend'        => $data->timeend,
1942                 'gradepass'      => $data->gradepass,
1943                 'role'           => $data->role
1944             );
1945             $newid = $DB->insert_record('course_completion_criteria', $params);
1946             $this->set_mapping('course_completion_criteria', $data->id, $newid);
1947         }
1948     }
1950     /**
1951      * Processes course compltion criteria complete records
1952      *
1953      * @global moodle_database $DB
1954      * @param stdClass $data
1955      */
1956     public function process_course_completion_crit_compl($data) {
1957         global $DB;
1959         $data = (object)$data;
1961         // This may be empty if criteria could not be restored
1962         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
1964         $data->course = $this->get_courseid();
1965         $data->userid = $this->get_mappingid('user', $data->userid);
1967         if (!empty($data->criteriaid) && !empty($data->userid)) {
1968             $params = array(
1969                 'userid' => $data->userid,
1970                 'course' => $data->course,
1971                 'criteriaid' => $data->criteriaid,
1972                 'timecompleted' => $this->apply_date_offset($data->timecompleted)
1973             );
1974             if (isset($data->gradefinal)) {
1975                 $params['gradefinal'] = $data->gradefinal;
1976             }
1977             if (isset($data->unenroled)) {
1978                 $params['unenroled'] = $data->unenroled;
1979             }
1980             if (isset($data->deleted)) {
1981                 $params['deleted'] = $data->deleted;
1982             }
1983             $DB->insert_record('course_completion_crit_compl', $params);
1984         }
1985     }
1987     /**
1988      * Process course completions
1989      *
1990      * @global moodle_database $DB
1991      * @param stdClass $data
1992      */
1993     public function process_course_completions($data) {
1994         global $DB;
1996         $data = (object)$data;
1998         $data->course = $this->get_courseid();
1999         $data->userid = $this->get_mappingid('user', $data->userid);
2001         if (!empty($data->userid)) {
2002             $params = array(
2003                 'userid' => $data->userid,
2004                 'course' => $data->course,
2005                 'deleted' => $data->deleted,
2006                 'timenotified' => $this->apply_date_offset($data->timenotified),
2007                 'timeenrolled' => $this->apply_date_offset($data->timeenrolled),
2008                 'timestarted' => $this->apply_date_offset($data->timestarted),
2009                 'timecompleted' => $this->apply_date_offset($data->timecompleted),
2010                 'reaggregate' => $data->reaggregate
2011             );
2012             $DB->insert_record('course_completions', $params);
2013         }
2014     }
2016     /**
2017      * Process course completion notification records.
2018      *
2019      * Note: As of Moodle 2.0 this table is not being used however it has been
2020      * left in in the hopes that one day the functionality there will be completed
2021      *
2022      * @global moodle_database $DB
2023      * @param stdClass $data
2024      */
2025     public function process_course_completion_notify($data) {
2026         global $DB;
2028         $data = (object)$data;
2030         $data->course = $this->get_courseid();
2031         if (!empty($data->role)) {
2032             $data->role = $this->get_mappingid('role', $data->role);
2033         }
2035         $params = array(
2036             'course' => $data->course,
2037             'role' => $data->role,
2038             'message' => $data->message,
2039             'timesent' => $this->apply_date_offset($data->timesent),
2040         );
2041         $DB->insert_record('course_completion_notify', $params);
2042     }
2044     /**
2045      * Process course completion aggregate methods
2046      *
2047      * @global moodle_database $DB
2048      * @param stdClass $data
2049      */
2050     public function process_course_completion_aggr_methd($data) {
2051         global $DB;
2053         $data = (object)$data;
2055         $data->course = $this->get_courseid();
2057         // Only create the course_completion_aggr_methd records if
2058         // the target course has not them defined. MDL-28180
2059         if (!$DB->record_exists('course_completion_aggr_methd', array(
2060                     'course' => $data->course,
2061                     'criteriatype' => $data->criteriatype))) {
2062             $params = array(
2063                 'course' => $data->course,
2064                 'criteriatype' => $data->criteriatype,
2065                 'method' => $data->method,
2066                 'value' => $data->value,
2067             );
2068             $DB->insert_record('course_completion_aggr_methd', $params);
2069         }
2070     }
2074 /**
2075  * This structure step restores course logs (cmid = 0), delegating
2076  * the hard work to the corresponding {@link restore_logs_processor} passing the
2077  * collection of {@link restore_log_rule} rules to be observed as they are defined
2078  * by the task. Note this is only executed based in the 'logs' setting.
2079  *
2080  * NOTE: This is executed by final task, to have all the activities already restored
2081  *
2082  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
2083  * records are. There are others like 'calendar' and 'upload' that will be handled
2084  * later.
2085  *
2086  * NOTE: All the missing actions (not able to be restored) are sent to logs for
2087  * debugging purposes
2088  */
2089 class restore_course_logs_structure_step extends restore_structure_step {
2091     /**
2092      * Conditionally decide if this step should be executed.
2093      *
2094      * This function checks the following parameter:
2095      *
2096      *   1. the course/logs.xml file exists
2097      *
2098      * @return bool true is safe to execute, false otherwise
2099      */
2100     protected function execute_condition() {
2102         // Check it is included in the backup
2103         $fullpath = $this->task->get_taskbasepath();
2104         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2105         if (!file_exists($fullpath)) {
2106             // Not found, can't restore course logs
2107             return false;
2108         }
2110         return true;
2111     }
2113     protected function define_structure() {
2115         $paths = array();
2117         // Simple, one plain level of information contains them
2118         $paths[] = new restore_path_element('log', '/logs/log');
2120         return $paths;
2121     }
2123     protected function process_log($data) {
2124         global $DB;
2126         $data = (object)($data);
2128         $data->time = $this->apply_date_offset($data->time);
2129         $data->userid = $this->get_mappingid('user', $data->userid);
2130         $data->course = $this->get_courseid();
2131         $data->cmid = 0;
2133         // For any reason user wasn't remapped ok, stop processing this
2134         if (empty($data->userid)) {
2135             return;
2136         }
2138         // Everything ready, let's delegate to the restore_logs_processor
2140         // Set some fixed values that will save tons of DB requests
2141         $values = array(
2142             'course' => $this->get_courseid());
2143         // Get instance and process log record
2144         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2146         // If we have data, insert it, else something went wrong in the restore_logs_processor
2147         if ($data) {
2148             $DB->insert_record('log', $data);
2149         }
2150     }
2153 /**
2154  * This structure step restores activity logs, extending {@link restore_course_logs_structure_step}
2155  * sharing its same structure but modifying the way records are handled
2156  */
2157 class restore_activity_logs_structure_step extends restore_course_logs_structure_step {
2159     protected function process_log($data) {
2160         global $DB;
2162         $data = (object)($data);
2164         $data->time = $this->apply_date_offset($data->time);
2165         $data->userid = $this->get_mappingid('user', $data->userid);
2166         $data->course = $this->get_courseid();
2167         $data->cmid = $this->task->get_moduleid();
2169         // For any reason user wasn't remapped ok, stop processing this
2170         if (empty($data->userid)) {
2171             return;
2172         }
2174         // Everything ready, let's delegate to the restore_logs_processor
2176         // Set some fixed values that will save tons of DB requests
2177         $values = array(
2178             'course' => $this->get_courseid(),
2179             'course_module' => $this->task->get_moduleid(),
2180             $this->task->get_modulename() => $this->task->get_activityid());
2181         // Get instance and process log record
2182         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2184         // If we have data, insert it, else something went wrong in the restore_logs_processor
2185         if ($data) {
2186             $DB->insert_record('log', $data);
2187         }
2188     }
2192 /**
2193  * Defines the restore step for advanced grading methods attached to the activity module
2194  */
2195 class restore_activity_grading_structure_step extends restore_structure_step {
2197     /**
2198      * This step is executed only if the grading file is present
2199      */
2200      protected function execute_condition() {
2202         $fullpath = $this->task->get_taskbasepath();
2203         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2204         if (!file_exists($fullpath)) {
2205             return false;
2206         }
2208         return true;
2209     }
2212     /**
2213      * Declares paths in the grading.xml file we are interested in
2214      */
2215     protected function define_structure() {
2217         $paths = array();
2218         $userinfo = $this->get_setting_value('userinfo');
2220         $paths[] = new restore_path_element('grading_area', '/areas/area');
2222         $definition = new restore_path_element('grading_definition', '/areas/area/definitions/definition');
2223         $paths[] = $definition;
2224         $this->add_plugin_structure('gradingform', $definition);
2226         if ($userinfo) {
2227             $instance = new restore_path_element('grading_instance',
2228                 '/areas/area/definitions/definition/instances/instance');
2229             $paths[] = $instance;
2230             $this->add_plugin_structure('gradingform', $instance);
2231         }
2233         return $paths;
2234     }
2236     /**
2237      * Processes one grading area element
2238      *
2239      * @param array $data element data
2240      */
2241     protected function process_grading_area($data) {
2242         global $DB;
2244         $task = $this->get_task();
2245         $data = (object)$data;
2246         $oldid = $data->id;
2247         $data->component = 'mod_'.$task->get_modulename();
2248         $data->contextid = $task->get_contextid();
2250         $newid = $DB->insert_record('grading_areas', $data);
2251         $this->set_mapping('grading_area', $oldid, $newid);
2252     }
2254     /**
2255      * Processes one grading definition element
2256      *
2257      * @param array $data element data
2258      */
2259     protected function process_grading_definition($data) {
2260         global $DB;
2262         $task = $this->get_task();
2263         $data = (object)$data;
2264         $oldid = $data->id;
2265         $data->areaid = $this->get_new_parentid('grading_area');
2266         $data->copiedfromid = null;
2267         $data->timecreated = time();
2268         $data->usercreated = $task->get_userid();
2269         $data->timemodified = $data->timecreated;
2270         $data->usermodified = $data->usercreated;
2272         $newid = $DB->insert_record('grading_definitions', $data);
2273         $this->set_mapping('grading_definition', $oldid, $newid, true);
2274     }
2276     /**
2277      * Processes one grading form instance element
2278      *
2279      * @param array $data element data
2280      */
2281     protected function process_grading_instance($data) {
2282         global $DB;
2284         $data = (object)$data;
2286         // new form definition id
2287         $newformid = $this->get_new_parentid('grading_definition');
2289         // get the name of the area we are restoring to
2290         $sql = "SELECT ga.areaname
2291                   FROM {grading_definitions} gd
2292                   JOIN {grading_areas} ga ON gd.areaid = ga.id
2293                  WHERE gd.id = ?";
2294         $areaname = $DB->get_field_sql($sql, array($newformid), MUST_EXIST);
2296         // get the mapped itemid - the activity module is expected to define the mappings
2297         // for each gradable area
2298         $newitemid = $this->get_mappingid(restore_gradingform_plugin::itemid_mapping($areaname), $data->itemid);
2300         $oldid = $data->id;
2301         $data->definitionid = $newformid;
2302         $data->raterid = $this->get_mappingid('user', $data->raterid);
2303         $data->itemid = $newitemid;
2305         $newid = $DB->insert_record('grading_instances', $data);
2306         $this->set_mapping('grading_instance', $oldid, $newid);
2307     }
2309     /**
2310      * Final operations when the database records are inserted
2311      */
2312     protected function after_execute() {
2313         // Add files embedded into the definition description
2314         $this->add_related_files('grading', 'description', 'grading_definition');
2315     }
2319 /**
2320  * This structure step restores the grade items associated with one activity
2321  * All the grade items are made child of the "course" grade item but the original
2322  * categoryid is saved as parentitemid in the backup_ids table, so, when restoring
2323  * the complete gradebook (categories and calculations), that information is
2324  * available there
2325  */
2326 class restore_activity_grades_structure_step extends restore_structure_step {
2328     protected function define_structure() {
2330         $paths = array();
2331         $userinfo = $this->get_setting_value('userinfo');
2333         $paths[] = new restore_path_element('grade_item', '/activity_gradebook/grade_items/grade_item');
2334         $paths[] = new restore_path_element('grade_letter', '/activity_gradebook/grade_letters/grade_letter');
2335         if ($userinfo) {
2336             $paths[] = new restore_path_element('grade_grade',
2337                            '/activity_gradebook/grade_items/grade_item/grade_grades/grade_grade');
2338         }
2339         return $paths;
2340     }
2342     protected function process_grade_item($data) {
2343         global $DB;
2345         $data = (object)($data);
2346         $oldid       = $data->id;        // We'll need these later
2347         $oldparentid = $data->categoryid;
2348         $courseid = $this->get_courseid();
2350         // make sure top course category exists, all grade items will be associated
2351         // to it. Later, if restoring the whole gradebook, categories will be introduced
2352         $coursecat = grade_category::fetch_course_category($courseid);
2353         $coursecatid = $coursecat->id; // Get the categoryid to be used
2355         $idnumber = null;
2356         if (!empty($data->idnumber)) {
2357             // Don't get any idnumber from course module. Keep them as they are in grade_item->idnumber
2358             // Reason: it's not clear what happens with outcomes->idnumber or activities with multiple items (workshop)
2359             // so the best is to keep the ones already in the gradebook
2360             // Potential problem: duplicates if same items are restored more than once. :-(
2361             // This needs to be fixed in some way (outcomes & activities with multiple items)
2362             // $data->idnumber     = get_coursemodule_from_instance($data->itemmodule, $data->iteminstance)->idnumber;
2363             // In any case, verify always for uniqueness
2364             $sql = "SELECT cm.id
2365                       FROM {course_modules} cm
2366                      WHERE cm.course = :courseid AND
2367                            cm.idnumber = :idnumber AND
2368                            cm.id <> :cmid";
2369             $params = array(
2370                 'courseid' => $courseid,
2371                 'idnumber' => $data->idnumber,
2372                 'cmid' => $this->task->get_moduleid()
2373             );
2374             if (!$DB->record_exists_sql($sql, $params) && !$DB->record_exists('grade_items', array('courseid' => $courseid, 'idnumber' => $data->idnumber))) {
2375                 $idnumber = $data->idnumber;
2376             }
2377         }
2379         unset($data->id);
2380         $data->categoryid   = $coursecatid;
2381         $data->courseid     = $this->get_courseid();
2382         $data->iteminstance = $this->task->get_activityid();
2383         $data->idnumber     = $idnumber;
2384         $data->scaleid      = $this->get_mappingid('scale', $data->scaleid);
2385         $data->outcomeid    = $this->get_mappingid('outcome', $data->outcomeid);
2386         $data->timecreated  = $this->apply_date_offset($data->timecreated);
2387         $data->timemodified = $this->apply_date_offset($data->timemodified);
2389         $gradeitem = new grade_item($data, false);
2390         $gradeitem->insert('restore');
2392         //sortorder is automatically assigned when inserting. Re-instate the previous sortorder
2393         $gradeitem->sortorder = $data->sortorder;
2394         $gradeitem->update('restore');
2396         // Set mapping, saving the original category id into parentitemid
2397         // gradebook restore (final task) will need it to reorganise items
2398         $this->set_mapping('grade_item', $oldid, $gradeitem->id, false, null, $oldparentid);
2399     }
2401     protected function process_grade_grade($data) {
2402         $data = (object)($data);
2403         $olduserid = $data->userid;
2404         unset($data->id);
2406         $data->itemid = $this->get_new_parentid('grade_item');
2408         $data->userid = $this->get_mappingid('user', $data->userid, null);
2409         if (!empty($data->userid)) {
2410             $data->usermodified = $this->get_mappingid('user', $data->usermodified, null);
2411             $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
2412             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
2413             $data->overridden = $this->apply_date_offset($data->overridden);
2415             $grade = new grade_grade($data, false);
2416             $grade->insert('restore');
2417             // no need to save any grade_grade mapping
2418         } else {
2419             debugging("Mapped user id not found for user id '{$olduserid}', grade item id '{$data->itemid}'");
2420         }
2421     }
2423     /**
2424      * process activity grade_letters. Note that, while these are possible,
2425      * because grade_letters are contextid based, in practice, only course
2426      * context letters can be defined. So we keep here this method knowing
2427      * it won't be executed ever. gradebook restore will restore course letters.
2428      */
2429     protected function process_grade_letter($data) {
2430         global $DB;
2432         $data['contextid'] = $this->task->get_contextid();
2433         $gradeletter = (object)$data;
2435         // Check if it exists before adding it
2436         unset($data['id']);
2437         if (!$DB->record_exists('grade_letters', $data)) {
2438             $newitemid = $DB->insert_record('grade_letters', $gradeletter);
2439         }
2440         // no need to save any grade_letter mapping
2441     }
2445 /**
2446  * This structure steps restores one instance + positions of one block
2447  * Note: Positions corresponding to one existing context are restored
2448  * here, but all the ones having unknown contexts are sent to backup_ids
2449  * for a later chance to be restored at the end (final task)
2450  */
2451 class restore_block_instance_structure_step extends restore_structure_step {
2453     protected function define_structure() {
2455         $paths = array();
2457         $paths[] = new restore_path_element('block', '/block', true); // Get the whole XML together
2458         $paths[] = new restore_path_element('block_position', '/block/block_positions/block_position');
2460         return $paths;
2461     }
2463     public function process_block($data) {
2464         global $DB, $CFG;
2466         $data = (object)$data; // Handy
2467         $oldcontextid = $data->contextid;
2468         $oldid        = $data->id;
2469         $positions = isset($data->block_positions['block_position']) ? $data->block_positions['block_position'] : array();
2471         // Look for the parent contextid
2472         if (!$data->parentcontextid = $this->get_mappingid('context', $data->parentcontextid)) {
2473             throw new restore_step_exception('restore_block_missing_parent_ctx', $data->parentcontextid);
2474         }
2476         // TODO: it would be nice to use standard plugin supports instead of this instance_allow_multiple()
2477         // If there is already one block of that type in the parent context
2478         // and the block is not multiple, stop processing
2479         // Use blockslib loader / method executor
2480         if (!$bi = block_instance($data->blockname)) {
2481             return false;
2482         }
2484         if (!$bi->instance_allow_multiple()) {
2485             if ($DB->record_exists_sql("SELECT bi.id
2486                                           FROM {block_instances} bi
2487                                           JOIN {block} b ON b.name = bi.blockname
2488                                          WHERE bi.parentcontextid = ?
2489                                            AND bi.blockname = ?", array($data->parentcontextid, $data->blockname))) {
2490                 return false;
2491             }
2492         }
2494         // If there is already one block of that type in the parent context
2495         // with the same showincontexts, pagetypepattern, subpagepattern, defaultregion and configdata
2496         // stop processing
2497         $params = array(
2498             'blockname' => $data->blockname, 'parentcontextid' => $data->parentcontextid,
2499             'showinsubcontexts' => $data->showinsubcontexts, 'pagetypepattern' => $data->pagetypepattern,
2500             'subpagepattern' => $data->subpagepattern, 'defaultregion' => $data->defaultregion);
2501         if ($birecs = $DB->get_records('block_instances', $params)) {
2502             foreach($birecs as $birec) {
2503                 if ($birec->configdata == $data->configdata) {
2504                     return false;
2505                 }
2506             }
2507         }
2509         // Set task old contextid, blockid and blockname once we know them
2510         $this->task->set_old_contextid($oldcontextid);
2511         $this->task->set_old_blockid($oldid);
2512         $this->task->set_blockname($data->blockname);
2514         // Let's look for anything within configdata neededing processing
2515         // (nulls and uses of legacy file.php)
2516         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
2517             $configdata = (array)unserialize(base64_decode($data->configdata));
2518             foreach ($configdata as $attribute => $value) {
2519                 if (in_array($attribute, $attrstotransform)) {
2520                     $configdata[$attribute] = $this->contentprocessor->process_cdata($value);
2521                 }
2522             }
2523             $data->configdata = base64_encode(serialize((object)$configdata));
2524         }
2526         // Create the block instance
2527         $newitemid = $DB->insert_record('block_instances', $data);
2528         // Save the mapping (with restorefiles support)
2529         $this->set_mapping('block_instance', $oldid, $newitemid, true);
2530         // Create the block context
2531         $newcontextid = get_context_instance(CONTEXT_BLOCK, $newitemid)->id;
2532         // Save the block contexts mapping and sent it to task
2533         $this->set_mapping('context', $oldcontextid, $newcontextid);
2534         $this->task->set_contextid($newcontextid);
2535         $this->task->set_blockid($newitemid);
2537         // Restore block fileareas if declared
2538         $component = 'block_' . $this->task->get_blockname();
2539         foreach ($this->task->get_fileareas() as $filearea) { // Simple match by contextid. No itemname needed
2540             $this->add_related_files($component, $filearea, null);
2541         }
2543         // Process block positions, creating them or accumulating for final step
2544         foreach($positions as $position) {
2545             $position = (object)$position;
2546             $position->blockinstanceid = $newitemid; // The instance is always the restored one
2547             // If position is for one already mapped (known) contextid
2548             // process it now, creating the position
2549             if ($newpositionctxid = $this->get_mappingid('context', $position->contextid)) {
2550                 $position->contextid = $newpositionctxid;
2551                 // Create the block position
2552                 $DB->insert_record('block_positions', $position);
2554             // The position belongs to an unknown context, send it to backup_ids
2555             // to process them as part of the final steps of restore. We send the
2556             // whole $position object there, hence use the low level method.
2557             } else {
2558                 restore_dbops::set_backup_ids_record($this->get_restoreid(), 'block_position', $position->id, 0, null, $position);
2559             }
2560         }
2561     }
2564 /**
2565  * Structure step to restore common course_module information
2566  *
2567  * This step will process the module.xml file for one activity, in order to restore
2568  * the corresponding information to the course_modules table, skipping various bits
2569  * of information based on CFG settings (groupings, completion...) in order to fullfill
2570  * all the reqs to be able to create the context to be used by all the rest of steps
2571  * in the activity restore task
2572  */
2573 class restore_module_structure_step extends restore_structure_step {
2575     protected function define_structure() {
2576         global $CFG;
2578         $paths = array();
2580         $module = new restore_path_element('module', '/module');
2581         $paths[] = $module;
2582         if ($CFG->enableavailability) {
2583             $paths[] = new restore_path_element('availability', '/module/availability_info/availability');
2584         }
2586         // Apply for 'format' plugins optional paths at module level
2587         $this->add_plugin_structure('format', $module);
2589         // Apply for 'plagiarism' plugins optional paths at module level
2590         $this->add_plugin_structure('plagiarism', $module);
2592         return $paths;
2593     }
2595     protected function process_module($data) {
2596         global $CFG, $DB;
2598         $data = (object)$data;
2599         $oldid = $data->id;
2600         $this->task->set_old_moduleversion($data->version);
2602         $data->course = $this->task->get_courseid();
2603         $data->module = $DB->get_field('modules', 'id', array('name' => $data->modulename));
2604         // Map section (first try by course_section mapping match. Useful in course and section restores)
2605         $data->section = $this->get_mappingid('course_section', $data->sectionid);
2606         if (!$data->section) { // mapping failed, try to get section by sectionnumber matching
2607             $params = array(
2608                 'course' => $this->get_courseid(),
2609                 'section' => $data->sectionnumber);
2610             $data->section = $DB->get_field('course_sections', 'id', $params);
2611         }
2612         if (!$data->section) { // sectionnumber failed, try to get first section in course
2613             $params = array(
2614                 'course' => $this->get_courseid());
2615             $data->section = $DB->get_field('course_sections', 'MIN(id)', $params);
2616         }
2617         if (!$data->section) { // no sections in course, create section 0 and 1 and assign module to 1
2618             $sectionrec = array(
2619                 'course' => $this->get_courseid(),
2620                 'section' => 0);
2621             $DB->insert_record('course_sections', $sectionrec); // section 0
2622             $sectionrec = array(
2623                 'course' => $this->get_courseid(),
2624                 'section' => 1);
2625             $data->section = $DB->insert_record('course_sections', $sectionrec); // section 1
2626         }
2627         $data->groupingid= $this->get_mappingid('grouping', $data->groupingid);      // grouping
2628         if (!$CFG->enablegroupmembersonly) {                                         // observe groupsmemberonly
2629             $data->groupmembersonly = 0;
2630         }
2631         if (!grade_verify_idnumber($data->idnumber, $this->get_courseid())) {        // idnumber uniqueness
2632             $data->idnumber = '';
2633         }
2634         if (empty($CFG->enablecompletion)) { // completion
2635             $data->completion = 0;
2636             $data->completiongradeitemnumber = null;
2637             $data->completionview = 0;
2638             $data->completionexpected = 0;
2639         } else {
2640             $data->completionexpected = $this->apply_date_offset($data->completionexpected);
2641         }
2642         if (empty($CFG->enableavailability)) {
2643             $data->availablefrom = 0;
2644             $data->availableuntil = 0;
2645             $data->showavailability = 0;
2646         } else {
2647             $data->availablefrom = $this->apply_date_offset($data->availablefrom);
2648             $data->availableuntil= $this->apply_date_offset($data->availableuntil);
2649         }
2650         // Backups that did not include showdescription, set it to default 0
2651         // (this is not totally necessary as it has a db default, but just to
2652         // be explicit).
2653         if (!isset($data->showdescription)) {
2654             $data->showdescription = 0;
2655         }
2656         $data->instance = 0; // Set to 0 for now, going to create it soon (next step)
2658         // course_module record ready, insert it
2659         $newitemid = $DB->insert_record('course_modules', $data);
2660         // save mapping
2661         $this->set_mapping('course_module', $oldid, $newitemid);
2662         // set the new course_module id in the task
2663         $this->task->set_moduleid($newitemid);
2664         // we can now create the context safely
2665         $ctxid = get_context_instance(CONTEXT_MODULE, $newitemid)->id;
2666         // set the new context id in the task
2667         $this->task->set_contextid($ctxid);
2668         // update sequence field in course_section
2669         if ($sequence = $DB->get_field('course_sections', 'sequence', array('id' => $data->section))) {
2670             $sequence .= ',' . $newitemid;
2671         } else {
2672             $sequence = $newitemid;
2673         }
2674         $DB->set_field('course_sections', 'sequence', $sequence, array('id' => $data->section));
2675     }
2678     protected function process_availability($data) {
2679         $data = (object)$data;
2680         // Simply going to store the whole availability record now, we'll process
2681         // all them later in the final task (once all actvivities have been restored)
2682         // Let's call the low level one to be able to store the whole object
2683         $data->coursemoduleid = $this->task->get_moduleid(); // Let add the availability cmid
2684         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'module_availability', $data->id, 0, null, $data);
2685     }
2688 /**
2689  * Structure step that will process the user activity completion
2690  * information if all these conditions are met:
2691  *  - Target site has completion enabled ($CFG->enablecompletion)
2692  *  - Activity includes completion info (file_exists)
2693  */
2694 class restore_userscompletion_structure_step extends restore_structure_step {
2695     /**
2696      * To conditionally decide if this step must be executed
2697      * Note the "settings" conditions are evaluated in the
2698      * corresponding task. Here we check for other conditions
2699      * not being restore settings (files, site settings...)
2700      */
2701      protected function execute_condition() {
2702          global $CFG;
2704          // Completion disabled in this site, don't execute
2705          if (empty($CFG->enablecompletion)) {
2706              return false;
2707          }
2709          // No user completion info found, don't execute
2710         $fullpath = $this->task->get_taskbasepath();
2711         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2712          if (!file_exists($fullpath)) {
2713              return false;
2714          }
2716          // Arrived here, execute the step
2717          return true;
2718      }
2720      protected function define_structure() {
2722         $paths = array();
2724         $paths[] = new restore_path_element('completion', '/completions/completion');
2726         return $paths;
2727     }
2729     protected function process_completion($data) {
2730         global $DB;
2732         $data = (object)$data;
2734         $data->coursemoduleid = $this->task->get_moduleid();
2735         $data->userid = $this->get_mappingid('user', $data->userid);
2736         $data->timemodified = $this->apply_date_offset($data->timemodified);
2738         // Find the existing record
2739         $existing = $DB->get_record('course_modules_completion', array(
2740                 'coursemoduleid' => $data->coursemoduleid,
2741                 'userid' => $data->userid), 'id, timemodified');
2742         // Check we didn't already insert one for this cmid and userid
2743         // (there aren't supposed to be duplicates in that field, but
2744         // it was possible until MDL-28021 was fixed).
2745         if ($existing) {
2746             // Update it to these new values, but only if the time is newer
2747             if ($existing->timemodified < $data->timemodified) {
2748                 $data->id = $existing->id;
2749                 $DB->update_record('course_modules_completion', $data);
2750             }
2751         } else {
2752             // Normal entry where it doesn't exist already
2753             $DB->insert_record('course_modules_completion', $data);
2754         }
2755     }
2758 /**
2759  * Abstract structure step, parent of all the activity structure steps. Used to suuport
2760  * the main <activity ...> tag and process it. Also provides subplugin support for
2761  * activities.
2762  */
2763 abstract class restore_activity_structure_step extends restore_structure_step {
2765     protected function add_subplugin_structure($subplugintype, $element) {
2767         global $CFG;
2769         // Check the requested subplugintype is a valid one
2770         $subpluginsfile = $CFG->dirroot . '/mod/' . $this->task->get_modulename() . '/db/subplugins.php';
2771         if (!file_exists($subpluginsfile)) {
2772              throw new restore_step_exception('activity_missing_subplugins_php_file', $this->task->get_modulename());
2773         }
2774         include($subpluginsfile);
2775         if (!array_key_exists($subplugintype, $subplugins)) {
2776              throw new restore_step_exception('incorrect_subplugin_type', $subplugintype);
2777         }
2778         // Get all the restore path elements, looking across all the subplugin dirs
2779         $subpluginsdirs = get_plugin_list($subplugintype);
2780         foreach ($subpluginsdirs as $name => $subpluginsdir) {
2781             $classname = 'restore_' . $subplugintype . '_' . $name . '_subplugin';
2782             $restorefile = $subpluginsdir . '/backup/moodle2/' . $classname . '.class.php';
2783             if (file_exists($restorefile)) {
2784                 require_once($restorefile);
2785                 $restoresubplugin = new $classname($subplugintype, $name, $this);
2786                 // Add subplugin paths to the step
2787                 $this->prepare_pathelements($restoresubplugin->define_subplugin_structure($element));
2788             }
2789         }
2790     }
2792     /**
2793      * As far as activity restore steps are implementing restore_subplugin stuff, they need to
2794      * have the parent task available for wrapping purposes (get course/context....)
2795      * @return restore_task
2796      */
2797     public function get_task() {
2798         return $this->task;
2799     }
2801     /**
2802      * Adds support for the 'activity' path that is common to all the activities
2803      * and will be processed globally here
2804      */
2805     protected function prepare_activity_structure($paths) {
2807         $paths[] = new restore_path_element('activity', '/activity');
2809         return $paths;
2810     }
2812     /**
2813      * Process the activity path, informing the task about various ids, needed later
2814      */
2815     protected function process_activity($data) {
2816         $data = (object)$data;
2817         $this->task->set_old_contextid($data->contextid); // Save old contextid in task
2818         $this->set_mapping('context', $data->contextid, $this->task->get_contextid()); // Set the mapping
2819         $this->task->set_old_activityid($data->id); // Save old activityid in task
2820     }
2822     /**
2823      * This must be invoked immediately after creating the "module" activity record (forum, choice...)
2824      * and will adjust the new activity id (the instance) in various places
2825      */
2826     protected function apply_activity_instance($newitemid) {
2827         global $DB;
2829         $this->task->set_activityid($newitemid); // Save activity id in task
2830         // Apply the id to course_sections->instanceid
2831         $DB->set_field('course_modules', 'instance', $newitemid, array('id' => $this->task->get_moduleid()));
2832         // Do the mapping for modulename, preparing it for files by oldcontext
2833         $modulename = $this->task->get_modulename();
2834         $oldid = $this->task->get_old_activityid();
2835         $this->set_mapping($modulename, $oldid, $newitemid, true);
2836     }
2839 /**
2840  * Structure step in charge of creating/mapping all the qcats and qs
2841  * by parsing the questions.xml file and checking it against the
2842  * results calculated by {@link restore_process_categories_and_questions}
2843  * and stored in backup_ids_temp
2844  */
2845 class restore_create_categories_and_questions extends restore_structure_step {
2847     protected function define_structure() {
2849         $category = new restore_path_element('question_category', '/question_categories/question_category');
2850         $question = new restore_path_element('question', '/question_categories/question_category/questions/question');
2851         $hint = new restore_path_element('question_hint',
2852                 '/question_categories/question_category/questions/question/question_hints/question_hint');
2854         // Apply for 'qtype' plugins optional paths at question level
2855         $this->add_plugin_structure('qtype', $question);
2857         return array($category, $question, $hint);
2858     }
2860     protected function process_question_category($data) {
2861         global $DB;
2863         $data = (object)$data;
2864         $oldid = $data->id;
2866         // Check we have one mapping for this category
2867         if (!$mapping = $this->get_mapping('question_category', $oldid)) {
2868             return self::SKIP_ALL_CHILDREN; // No mapping = this category doesn't need to be created/mapped
2869         }
2871         // Check we have to create the category (newitemid = 0)
2872         if ($mapping->newitemid) {
2873             return; // newitemid != 0, this category is going to be mapped. Nothing to do
2874         }
2876         // Arrived here, newitemid = 0, we need to create the category
2877         // we'll do it at parentitemid context, but for CONTEXT_MODULE
2878         // categories, that will be created at CONTEXT_COURSE and moved
2879         // to module context later when the activity is created
2880         if ($mapping->info->contextlevel == CONTEXT_MODULE) {
2881             $mapping->parentitemid = $this->get_mappingid('context', $this->task->get_old_contextid());
2882         }
2883         $data->contextid = $mapping->parentitemid;
2885         // Let's create the question_category and save mapping
2886         $newitemid = $DB->insert_record('question_categories', $data);
2887         $this->set_mapping('question_category', $oldid, $newitemid);
2888         // Also annotate them as question_category_created, we need
2889         // that later when remapping parents
2890         $this->set_mapping('question_category_created', $oldid, $newitemid, false, null, $data->contextid);
2891     }
2893     protected function process_question($data) {
2894         global $DB;
2896         $data = (object)$data;
2897         $oldid = $data->id;
2899         // Check we have one mapping for this question
2900         if (!$questionmapping = $this->get_mapping('question', $oldid)) {
2901             return; // No mapping = this question doesn't need to be created/mapped
2902         }
2904         // Get the mapped category (cannot use get_new_parentid() because not
2905         // all the categories have been created, so it is not always available
2906         // Instead we get the mapping for the question->parentitemid because
2907         // we have loaded qcatids there for all parsed questions
2908         $data->category = $this->get_mappingid('question_category', $questionmapping->parentitemid);
2910         // In the past, there were some very sloppy values of penalty. Fix them.
2911         if ($data->penalty >= 0.33 && $data->penalty <= 0.34) {
2912             $data->penalty = 0.3333333;
2913         }
2914         if ($data->penalty >= 0.66 && $data->penalty <= 0.67) {
2915             $data->penalty = 0.6666667;
2916         }
2917         if ($data->penalty >= 1) {
2918             $data->penalty = 1;
2919         }
2921         $userid = $this->get_mappingid('user', $data->createdby);
2922         $data->createdby = $userid ? $userid : $this->task->get_userid();
2924         $userid = $this->get_mappingid('user', $data->modifiedby);
2925         $data->modifiedby = $userid ? $userid : $this->task->get_userid();
2927         // With newitemid = 0, let's create the question
2928         if (!$questionmapping->newitemid) {
2929             $newitemid = $DB->insert_record('question', $data);
2930             $this->set_mapping('question', $oldid, $newitemid);
2931             // Also annotate them as question_created, we need
2932             // that later when remapping parents (keeping the old categoryid as parentid)
2933             $this->set_mapping('question_created', $oldid, $newitemid, false, null, $questionmapping->parentitemid);
2934         } else {
2935             // By performing this set_mapping() we make get_old/new_parentid() to work for all the
2936             // children elements of the 'question' one (so qtype plugins will know the question they belong to)
2937             $this->set_mapping('question', $oldid, $questionmapping->newitemid);
2938         }
2940         // Note, we don't restore any question files yet
2941         // as far as the CONTEXT_MODULE categories still
2942         // haven't their contexts to be restored to
2943         // The {@link restore_create_question_files}, executed in the final step
2944         // step will be in charge of restoring all the question files
2945     }
2947         protected function process_question_hint($data) {
2948         global $DB;
2950         $data = (object)$data;
2951         $oldid = $data->id;
2953         // Detect if the question is created or mapped
2954         $oldquestionid   = $this->get_old_parentid('question');
2955         $newquestionid   = $this->get_new_parentid('question');
2956         $questioncreated = $this->get_mappingid('question_created', $oldquestionid) ? true : false;
2958         // If the question has been created by restore, we need to create its question_answers too
2959         if ($questioncreated) {
2960             // Adjust some columns
2961             $data->questionid = $newquestionid;
2962             // Insert record
2963             $newitemid = $DB->insert_record('question_hints', $data);
2965         // The question existed, we need to map the existing question_hints
2966         } else {
2967             // Look in question_hints by hint text matching
2968             $sql = 'SELECT id
2969                       FROM {question_hints}
2970                      WHERE questionid = ?
2971                        AND ' . $DB->sql_compare_text('hint', 255) . ' = ' . $DB->sql_compare_text('?', 255);
2972             $params = array($newquestionid, $data->hint);
2973             $newitemid = $DB->get_field_sql($sql, $params);
2975             // Not able to find the hint, let's try cleaning the hint text
2976             // of all the question's hints in DB as slower fallback. MDL-33863.
2977             if (!$newitemid) {
2978                 $potentialhints = $DB->get_records('question_hints',
2979                         array('questionid' => $newquestionid), '', 'id, hint');
2980                 foreach ($potentialhints as $potentialhint) {
2981                     // Clean in the same way than {@link xml_writer::xml_safe_utf8()}.
2982                     $cleanhint = preg_replace('/[\x-\x8\xb-\xc\xe-\x1f\x7f]/is','', $potentialhint->hint); // Clean CTRL chars.
2983                     $cleanhint = preg_replace("/\r\n|\r/", "\n", $cleanhint); // Normalize line ending.
2984                     if ($cleanhint === $data->hint) {
2985                         $newitemid = $data->id;
2986                     }
2987                 }
2988             }
2990             // If we haven't found the newitemid, something has gone really wrong, question in DB
2991             // is missing hints, exception
2992             if (!$newitemid) {
2993                 $info = new stdClass();
2994                 $info->filequestionid = $oldquestionid;
2995                 $info->dbquestionid   = $newquestionid;
2996                 $info->hint           = $data->hint;
2997                 throw new restore_step_exception('error_question_hint_missing_in_db', $info);
2998             }
2999         }
3000         // Create mapping (I'm not sure if this is really needed?)
3001         $this->set_mapping('question_hint', $oldid, $newitemid);
3002     }
3004     protected function after_execute() {
3005         global $DB;
3007         // First of all, recode all the created question_categories->parent fields
3008         $qcats = $DB->get_records('backup_ids_temp', array(
3009                      'backupid' => $this->get_restoreid(),
3010                      'itemname' => 'question_category_created'));
3011         foreach ($qcats as $qcat) {
3012             $newparent = 0;
3013             $dbcat = $DB->get_record('question_categories', array('id' => $qcat->newitemid));
3014             // Get new parent (mapped or created, so we look in quesiton_category mappings)
3015             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
3016                                  'backupid' => $this->get_restoreid(),
3017                                  'itemname' => 'question_category',
3018                                  'itemid'   => $dbcat->parent))) {
3019                 // contextids must match always, as far as we always include complete qbanks, just check it
3020                 $newparentctxid = $DB->get_field('question_categories', 'contextid', array('id' => $newparent));
3021                 if ($dbcat->contextid == $newparentctxid) {
3022                     $DB->set_field('question_categories', 'parent', $newparent, array('id' => $dbcat->id));
3023                 } else {
3024                     $newparent = 0; // No ctx match for both cats, no parent relationship
3025                 }
3026             }
3027             // Here with $newparent empty, problem with contexts or remapping, set it to top cat
3028             if (!$newparent) {
3029                 $DB->set_field('question_categories', 'parent', 0, array('id' => $dbcat->id));
3030             }
3031         }
3033         // Now, recode all the created question->parent fields
3034         $qs = $DB->get_records('backup_ids_temp', array(
3035                   'backupid' => $this->get_restoreid(),
3036                   'itemname' => 'question_created'));
3037         foreach ($qs as $q) {
3038             $newparent = 0;
3039             $dbq = $DB->get_record('question', array('id' => $q->newitemid));
3040             // Get new parent (mapped or created, so we look in question mappings)
3041             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
3042                                  'backupid' => $this->get_restoreid(),
3043                                  'itemname' => 'question',
3044                                  'itemid'   => $dbq->parent))) {
3045                 $DB->set_field('question', 'parent', $newparent, array('id' => $dbq->id));
3046             }
3047         }
3049         // Note, we don't restore any question files yet
3050         // as far as the CONTEXT_MODULE categories still
3051         // haven't their contexts to be restored to
3052         // The {@link restore_create_question_files}, executed in the final step
3053         // step will be in charge of restoring all the question files
3054     }
3057 /**
3058  * Execution step that will move all the CONTEXT_MODULE question categories
3059  * created at early stages of restore in course context (because modules weren't
3060  * created yet) to their target module (matching by old-new-contextid mapping)
3061  */
3062 class restore_move_module_questions_categories extends restore_execution_step {
3064     protected function define_execution() {
3065         global $DB;
3067         $contexts = restore_dbops::restore_get_question_banks($this->get_restoreid(), CONTEXT_MODULE);
3068         foreach ($contexts as $contextid => $contextlevel) {
3069             // Only if context mapping exists (i.e. the module has been restored)
3070             if ($newcontext = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $contextid)) {
3071                 // Update all the qcats having their parentitemid set to the original contextid
3072                 $modulecats = $DB->get_records_sql("SELECT itemid, newitemid
3073                                                       FROM {backup_ids_temp}
3074                                                      WHERE backupid = ?
3075                                                        AND itemname = 'question_category'
3076                                                        AND parentitemid = ?", array($this->get_restoreid(), $contextid));
3077                 foreach ($modulecats as $modulecat) {
3078                     $DB->set_field('question_categories', 'contextid', $newcontext->newitemid, array('id' => $modulecat->newitemid));
3079                     // And set new contextid also in question_category mapping (will be
3080                     // used by {@link restore_create_question_files} later
3081                     restore_dbops::set_backup_ids_record($this->get_restoreid(), 'question_category', $modulecat->itemid, $modulecat->newitemid, $newcontext->newitemid);
3082                 }
3083             }
3084         }
3085     }
3088 /**
3089  * Execution step that will create all the question/answers/qtype-specific files for the restored
3090  * questions. It must be executed after {@link restore_move_module_questions_categories}
3091  * because only then each question is in its final category and only then the
3092  * context can be determined
3093  *
3094  * TODO: Improve this. Instead of looping over each question, it can be reduced to
3095  *       be done by contexts (this will save a huge ammount of queries)
3096  */
3097 class restore_create_question_files extends restore_execution_step {
3099     protected function define_execution() {
3100         global $DB;
3102         // Let's process only created questions
3103         $questionsrs = $DB->get_recordset_sql("SELECT bi.itemid, bi.newitemid, bi.parentitemid, q.qtype
3104                                                FROM {backup_ids_temp} bi
3105                                                JOIN {question} q ON q.id = bi.newitemid
3106                                               WHERE bi.backupid = ?
3107                                                 AND bi.itemname = 'question_created'", array($this->get_restoreid()));
3108         foreach ($questionsrs as $question) {
3109             // Get question_category mapping, it contains the target context for the question
3110             if (!$qcatmapping = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'question_category', $question->parentitemid)) {
3111                 // Something went really wrong, cannot find the question_category for the question
3112                 debugging('Error fetching target context for question', DEBUG_DEVELOPER);
3113                 continue;
3114             }
3115             // Calculate source and target contexts
3116             $oldctxid = $qcatmapping->info->contextid;
3117             $newctxid = $qcatmapping->parentitemid;
3119             // Add common question files (question and question_answer ones)
3120             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'questiontext',
3121                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3122             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'generalfeedback',
3123                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3124             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'answer',
3125                                               $oldctxid, $this->task->get_userid(), 'question_answer', null, $newctxid, true);
3126             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'answerfeedback',
3127                                               $oldctxid, $this->task->get_userid(), 'question_answer', null, $newctxid, true);
3128             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'hint',
3129                                               $oldctxid, $this->task->get_userid(), 'question_hint', null, $newctxid, true);
3130             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'correctfeedback',
3131                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3132             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'partiallycorrectfeedback',
3133                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3134             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'incorrectfeedback',
3135                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3136             // Add qtype dependent files
3137             $components = backup_qtype_plugin::get_components_and_fileareas($question->qtype);
3138             foreach ($components as $component => $fileareas) {
3139                 foreach ($fileareas as $filearea => $mapping) {
3140                     // Use itemid only if mapping is question_created
3141                     $itemid = ($mapping == 'question_created') ? $question->itemid : null;
3142                     restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), $component, $filearea,
3143                                                       $oldctxid, $this->task->get_userid(), $mapping, $itemid, $newctxid, true);
3144                 }
3145             }
3146         }
3147         $questionsrs->close();
3148     }
3152 /**
3153  * Try to restore aliases and references to external files.
3154  *
3155  * The queue of these files was prepared for us in {@link restore_dbops::send_files_to_pool()}.
3156  * We expect that all regular (non-alias) files have already been restored. Make sure
3157  * there is no restore step executed after this one that would call send_files_to_pool() again.
3158  *
3159  * You may notice we have hardcoded support for Server files, Legacy course files
3160  * and user Private files here at the moment. This could be eventually replaced with a set of
3161  * callbacks in the future if needed.
3162  *
3163  * @copyright 2012 David Mudrak <david@moodle.com>
3164  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3165  */
3166 class restore_process_file_aliases_queue extends restore_execution_step {
3168     /** @var array internal cache for {@link choose_repository() */
3169     private $cachereposbyid = array();
3171     /** @var array internal cache for {@link choose_repository() */
3172     private $cachereposbytype = array();
3174     /**
3175      * What to do when this step is executed.
3176      */
3177     protected function define_execution() {
3178         global $DB;
3180         $this->log('processing file aliases queue', backup::LOG_INFO);
3182         $fs = get_file_storage();
3184         // Load the queue.
3185         $rs = $DB->get_recordset('backup_ids_temp',
3186             array('backupid' => $this->get_restoreid(), 'itemname' => 'file_aliases_queue'),
3187             '', 'info');
3189         // Iterate over aliases in the queue.
3190         foreach ($rs as $record) {
3191             $info = unserialize(base64_decode($record->info));
3193             // Try to pick a repository instance that should serve the alias.
3194             $repository = $this->choose_repository($info);
3196             if (is_null($repository)) {
3197                 $this->notify_failure($info, 'unable to find a matching repository instance');
3198                 continue;
3199             }
3201             if ($info->oldfile->repositorytype === 'local' or $info->oldfile->repositorytype === 'coursefiles') {
3202                 // Aliases to Server files and Legacy course files may refer to a file
3203                 // contained in the backup file or to some existing file (if we are on the
3204                 // same site).
3205                 try {
3206                     $reference = file_storage::unpack_reference($info->oldfile->reference);
3207                 } catch (Exception $e) {
3208                     $this->notify_failure($info, 'invalid reference field format');
3209                     continue;
3210                 }
3212                 // Let's see if the referred source file was also included in the backup.
3213                 $candidates = $DB->get_recordset('backup_files_temp', array(
3214                         'backupid' => $this->get_restoreid(),
3215                         'contextid' => $reference['contextid'],
3216                         'component' => $reference['component'],
3217                         'filearea' => $reference['filearea'],
3218                         'itemid' => $reference['itemid'],
3219                     ), '', 'info, newcontextid, newitemid');
3221                 $source = null;
3223                 foreach ($candidates as $candidate) {
3224                     $candidateinfo = unserialize(base64_decode($candidate->info));
3225                     if ($candidateinfo->filename === $reference['filename']
3226                             and $candidateinfo->filepath === $reference['filepath']
3227                             and !is_null($candidate->newcontextid)
3228                             and !is_null($candidate->newitemid) ) {
3229                         $source = $candidateinfo;
3230                         $source->contextid = $candidate->newcontextid;