Merge branch 'wip-mdl-33455' of git://github.com/rajeshtaneja/moodle
[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         }
195         if (empty($newitemid)) {
196             //in case we found the course category but still need to insert the course grade item
197             if ($data->itemtype=='course' && !empty($coursecategory)) {
198                 $data->iteminstance = $coursecategory->id;
199             }
201             $newitemid = $DB->insert_record('grade_items', $data);
202         }
203         $this->set_mapping('grade_item', $oldid, $newitemid);
204     }
206     protected function process_grade_grade($data) {
207         global $DB;
209         $data = (object)$data;
210         $oldid = $data->id;
212         $data->itemid = $this->get_new_parentid('grade_item');
214         $data->userid = $this->get_mappingid('user', $data->userid, NULL);
215         if (!is_null($data->userid)) {
216             $data->usermodified = $this->get_mappingid('user', $data->usermodified, NULL);
217             $data->locktime     = $this->apply_date_offset($data->locktime);
218             // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
219             $data->overridden = $this->apply_date_offset($data->overridden);
220             $data->timecreated  = $this->apply_date_offset($data->timecreated);
221             $data->timemodified = $this->apply_date_offset($data->timemodified);
223             $newitemid = $DB->insert_record('grade_grades', $data);
224         } else {
225             debugging("Mapped user id not found for grade item id '{$data->itemid}'");
226         }
227     }
228     protected function process_grade_category($data) {
229         global $DB;
231         $data = (object)$data;
232         $oldid = $data->id;
234         $data->course = $this->get_courseid();
235         $data->courseid = $data->course;
237         $data->timecreated  = $this->apply_date_offset($data->timecreated);
238         $data->timemodified = $this->apply_date_offset($data->timemodified);
240         $newitemid = null;
241         //no parent means a course level grade category. That may have been created when the course was created
242         if(empty($data->parent)) {
243             //parent was being saved as 0 when it should be null
244             $data->parent = null;
246             //get the already created course level grade category
247             $category = new stdclass();
248             $category->courseid = $this->get_courseid();
249             $category->parent = null;
251             $coursecategory = $DB->get_record('grade_categories', (array)$category);
252             if (!empty($coursecategory)) {
253                 $data->id = $newitemid = $coursecategory->id;
254                 $DB->update_record('grade_categories', $data);
255             }
256         }
258         //need to insert a course category
259         if (empty($newitemid)) {
260             $newitemid = $DB->insert_record('grade_categories', $data);
261         }
262         $this->set_mapping('grade_category', $oldid, $newitemid);
263     }
264     protected function process_grade_letter($data) {
265         global $DB;
267         $data = (object)$data;
268         $oldid = $data->id;
270         $data->contextid = get_context_instance(CONTEXT_COURSE, $this->get_courseid())->id;
272         $newitemid = $DB->insert_record('grade_letters', $data);
273         $this->set_mapping('grade_letter', $oldid, $newitemid);
274     }
275     protected function process_grade_setting($data) {
276         global $DB;
278         $data = (object)$data;
279         $oldid = $data->id;
281         $data->courseid = $this->get_courseid();
283         $newitemid = $DB->insert_record('grade_settings', $data);
284         //$this->set_mapping('grade_setting', $oldid, $newitemid);
285     }
287     /**
288      * put all activity grade items in the correct grade category and mark all for recalculation
289      */
290     protected function after_execute() {
291         global $DB;
293         $conditions = array(
294             'backupid' => $this->get_restoreid(),
295             'itemname' => 'grade_item'//,
296             //'itemid'   => $itemid
297         );
298         $rs = $DB->get_recordset('backup_ids_temp', $conditions);
300         // We need this for calculation magic later on.
301         $mappings = array();
303         if (!empty($rs)) {
304             foreach($rs as $grade_item_backup) {
306                 // Store the oldid with the new id.
307                 $mappings[$grade_item_backup->itemid] = $grade_item_backup->newitemid;
309                 $updateobj = new stdclass();
310                 $updateobj->id = $grade_item_backup->newitemid;
312                 //if this is an activity grade item that needs to be put back in its correct category
313                 if (!empty($grade_item_backup->parentitemid)) {
314                     $oldcategoryid = $this->get_mappingid('grade_category', $grade_item_backup->parentitemid, null);
315                     if (!is_null($oldcategoryid)) {
316                         $updateobj->categoryid = $oldcategoryid;
317                         $DB->update_record('grade_items', $updateobj);
318                     }
319                 } else {
320                     //mark course and category items as needing to be recalculated
321                     $updateobj->needsupdate=1;
322                     $DB->update_record('grade_items', $updateobj);
323                 }
324             }
325         }
326         $rs->close();
328         // We need to update the calculations for calculated grade items that may reference old
329         // grade item ids using ##gi\d+##.
330         // $mappings can be empty, use 0 if so (won't match ever)
331         list($sql, $params) = $DB->get_in_or_equal(array_values($mappings), SQL_PARAMS_NAMED, 'param', true, 0);
332         $sql = "SELECT gi.id, gi.calculation
333                   FROM {grade_items} gi
334                  WHERE gi.id {$sql} AND
335                        calculation IS NOT NULL";
336         $rs = $DB->get_recordset_sql($sql, $params);
337         foreach ($rs as $gradeitem) {
338             // Collect all of the used grade item id references
339             if (preg_match_all('/##gi(\d+)##/', $gradeitem->calculation, $matches) < 1) {
340                 // This calculation doesn't reference any other grade items... EASY!
341                 continue;
342             }
343             // For this next bit we are going to do the replacement of id's in two steps:
344             // 1. We will replace all old id references with a special mapping reference.
345             // 2. We will replace all mapping references with id's
346             // Why do we do this?
347             // Because there potentially there will be an overlap of ids within the query and we
348             // we substitute the wrong id.. safest way around this is the two step system
349             $calculationmap = array();
350             $mapcount = 0;
351             foreach ($matches[1] as $match) {
352                 // Check that the old id is known to us, if not it was broken to begin with and will
353                 // continue to be broken.
354                 if (!array_key_exists($match, $mappings)) {
355                     continue;
356                 }
357                 // Our special mapping key
358                 $mapping = '##MAPPING'.$mapcount.'##';
359                 // The old id that exists within the calculation now
360                 $oldid = '##gi'.$match.'##';
361                 // The new id that we want to replace the old one with.
362                 $newid = '##gi'.$mappings[$match].'##';
363                 // Replace in the special mapping key
364                 $gradeitem->calculation = str_replace($oldid, $mapping, $gradeitem->calculation);
365                 // And record the mapping
366                 $calculationmap[$mapping] = $newid;
367                 $mapcount++;
368             }
369             // Iterate all special mappings for this calculation and replace in the new id's
370             foreach ($calculationmap as $mapping => $newid) {
371                 $gradeitem->calculation = str_replace($mapping, $newid, $gradeitem->calculation);
372             }
373             // Update the calculation now that its being remapped
374             $DB->update_record('grade_items', $gradeitem);
375         }
376         $rs->close();
378         // Need to correct the grade category path and parent
379         $conditions = array(
380             'courseid' => $this->get_courseid()
381         );
383         $rs = $DB->get_recordset('grade_categories', $conditions);
384         // Get all the parents correct first as grade_category::build_path() loads category parents from the DB
385         foreach ($rs as $gc) {
386             if (!empty($gc->parent)) {
387                 $grade_category = new stdClass();
388                 $grade_category->id = $gc->id;
389                 $grade_category->parent = $this->get_mappingid('grade_category', $gc->parent);
390                 $DB->update_record('grade_categories', $grade_category);
391             }
392         }
393         $rs->close();
395         // Now we can rebuild all the paths
396         $rs = $DB->get_recordset('grade_categories', $conditions);
397         foreach ($rs as $gc) {
398             $grade_category = new stdClass();
399             $grade_category->id = $gc->id;
400             $grade_category->path = grade_category::build_path($gc);
401             $grade_category->depth = substr_count($grade_category->path, '/') - 1;
402             $DB->update_record('grade_categories', $grade_category);
403         }
404         $rs->close();
406         // Restore marks items as needing update. Update everything now.
407         grade_regrade_final_grades($this->get_courseid());
408     }
411 /**
412  * decode all the interlinks present in restored content
413  * relying 100% in the restore_decode_processor that handles
414  * both the contents to modify and the rules to be applied
415  */
416 class restore_decode_interlinks extends restore_execution_step {
418     protected function define_execution() {
419         // Get the decoder (from the plan)
420         $decoder = $this->task->get_decoder();
421         restore_decode_processor::register_link_decoders($decoder); // Add decoder contents and rules
422         // And launch it, everything will be processed
423         $decoder->execute();
424     }
427 /**
428  * first, ensure that we have no gaps in section numbers
429  * and then, rebuid the course cache
430  */
431 class restore_rebuild_course_cache extends restore_execution_step {
433     protected function define_execution() {
434         global $DB;
436         // Although there is some sort of auto-recovery of missing sections
437         // present in course/formats... here we check that all the sections
438         // from 0 to MAX(section->section) exist, creating them if necessary
439         $maxsection = $DB->get_field('course_sections', 'MAX(section)', array('course' => $this->get_courseid()));
440         // Iterate over all sections
441         for ($i = 0; $i <= $maxsection; $i++) {
442             // If the section $i doesn't exist, create it
443             if (!$DB->record_exists('course_sections', array('course' => $this->get_courseid(), 'section' => $i))) {
444                 $sectionrec = array(
445                     'course' => $this->get_courseid(),
446                     'section' => $i);
447                 $DB->insert_record('course_sections', $sectionrec); // missing section created
448             }
449         }
451         // Rebuild cache now that all sections are in place
452         rebuild_course_cache($this->get_courseid());
453     }
456 /**
457  * Review all the tasks having one after_restore method
458  * executing it to perform some final adjustments of information
459  * not available when the task was executed.
460  */
461 class restore_execute_after_restore extends restore_execution_step {
463     protected function define_execution() {
465         // Simply call to the execute_after_restore() method of the task
466         // that always is the restore_final_task
467         $this->task->launch_execute_after_restore();
468     }
472 /**
473  * Review all the (pending) block positions in backup_ids, matching by
474  * contextid, creating positions as needed. This is executed by the
475  * final task, once all the contexts have been created
476  */
477 class restore_review_pending_block_positions extends restore_execution_step {
479     protected function define_execution() {
480         global $DB;
482         // Get all the block_position objects pending to match
483         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
484         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid');
485         // Process block positions, creating them or accumulating for final step
486         foreach($rs as $posrec) {
487             // Get the complete position object (stored as info)
488             $position = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'block_position', $posrec->itemid)->info;
489             // If position is for one already mapped (known) contextid
490             // process it now, creating the position, else nothing to
491             // do, position finally discarded
492             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
493                 $position->contextid = $newctx->newitemid;
494                 // Create the block position
495                 $DB->insert_record('block_positions', $position);
496             }
497         }
498         $rs->close();
499     }
502 /**
503  * Process all the saved module availability records in backup_ids, matching
504  * course modules and grade item id once all them have been already restored.
505  * only if all matchings are satisfied the availability condition will be created.
506  * At the same time, it is required for the site to have that functionality enabled.
507  */
508 class restore_process_course_modules_availability extends restore_execution_step {
510     protected function define_execution() {
511         global $CFG, $DB;
513         // Site hasn't availability enabled
514         if (empty($CFG->enableavailability)) {
515             return;
516         }
518         // Get all the module_availability objects to process
519         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'module_availability');
520         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid');
521         // Process availabilities, creating them if everything matches ok
522         foreach($rs as $availrec) {
523             $allmatchesok = true;
524             // Get the complete availabilityobject
525             $availability = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'module_availability', $availrec->itemid)->info;
526             // Map the sourcecmid if needed and possible
527             if (!empty($availability->sourcecmid)) {
528                 $newcm = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'course_module', $availability->sourcecmid);
529                 if ($newcm) {
530                     $availability->sourcecmid = $newcm->newitemid;
531                 } else {
532                     $allmatchesok = false; // Failed matching, we won't create this availability rule
533                 }
534             }
535             // Map the gradeitemid if needed and possible
536             if (!empty($availability->gradeitemid)) {
537                 $newgi = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'grade_item', $availability->gradeitemid);
538                 if ($newgi) {
539                     $availability->gradeitemid = $newgi->newitemid;
540                 } else {
541                     $allmatchesok = false; // Failed matching, we won't create this availability rule
542                 }
543             }
544             if ($allmatchesok) { // Everything ok, create the availability rule
545                 $DB->insert_record('course_modules_availability', $availability);
546             }
547         }
548         $rs->close();
549     }
553 /*
554  * Execution step that, *conditionally* (if there isn't preloaded information)
555  * will load the inforef files for all the included course/section/activity tasks
556  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
557  */
558 class restore_load_included_inforef_records extends restore_execution_step {
560     protected function define_execution() {
562         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
563             return;
564         }
566         // Get all the included tasks
567         $tasks = restore_dbops::get_included_tasks($this->get_restoreid());
568         foreach ($tasks as $task) {
569             // Load the inforef.xml file if exists
570             $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
571             if (file_exists($inforefpath)) {
572                 restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $inforefpath); // Load each inforef file to temp_ids
573             }
574         }
575     }
578 /*
579  * Execution step that will load all the needed files into backup_files_temp
580  *   - info: contains the whole original object (times, names...)
581  * (all them being original ids as loaded from xml)
582  */
583 class restore_load_included_files extends restore_structure_step {
585     protected function define_structure() {
587         $file = new restore_path_element('file', '/files/file');
589         return array($file);
590     }
592     /**
593      * Processing functions go here
594      *
595      * @param array $data one file record including repositoryid and reference
596      */
597     public function process_file($data) {
599         $data = (object)$data; // handy
601         $isreference = !empty($data->repositoryid);
602         $issamesite = $this->task->is_samesite();
604         // If it's not samesite, we skip file refernces
605         if (!$issamesite && $isreference) {
606             return;
607         }
609         // load it if needed:
610         //   - it it is one of the annotated inforef files (course/section/activity/block)
611         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
612         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
613         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
614         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
615         $iscomponent = ($data->component == 'user' || $data->component == 'group' ||
616                         $data->component == 'grouping' || $data->component == 'grade' ||
617                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
618         if ($isfileref || $iscomponent) {
619             // Process files
620             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
621         }
622     }
625 /**
626  * Execution step that, *conditionally* (if there isn't preloaded information),
627  * will load all the needed roles to backup_temp_ids. They will be stored with
628  * "role" itemname. Also it will perform one automatic mapping to roles existing
629  * in the target site, based in permissions of the user performing the restore,
630  * archetypes and other bits. At the end, each original role will have its associated
631  * target role or 0 if it's going to be skipped. Note we wrap everything over one
632  * restore_dbops method, as far as the same stuff is going to be also executed
633  * by restore prechecks
634  */
635 class restore_load_and_map_roles extends restore_execution_step {
637     protected function define_execution() {
638         if ($this->task->get_preloaded_information()) { // if info is already preloaded
639             return;
640         }
642         $file = $this->get_basepath() . '/roles.xml';
643         // Load needed toles to temp_ids
644         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
646         // Process roles, mapping/skipping. Any error throws exception
647         // Note we pass controller's info because it can contain role mapping information
648         // about manual mappings performed by UI
649         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);
650     }
653 /**
654  * Execution step that, *conditionally* (if there isn't preloaded information
655  * and users have been selected in settings, will load all the needed users
656  * to backup_temp_ids. They will be stored with "user" itemname and with
657  * their original contextid as paremitemid
658  */
659 class restore_load_included_users extends restore_execution_step {
661     protected function define_execution() {
663         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
664             return;
665         }
666         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
667             return;
668         }
669         $file = $this->get_basepath() . '/users.xml';
670         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file); // Load needed users to temp_ids
671     }
674 /**
675  * Execution step that, *conditionally* (if there isn't preloaded information
676  * and users have been selected in settings, will process all the needed users
677  * in order to decide and perform any action with them (create / map / error)
678  * Note: Any error will cause exception, as far as this is the same processing
679  * than the one into restore prechecks (that should have stopped process earlier)
680  */
681 class restore_process_included_users extends restore_execution_step {
683     protected function define_execution() {
685         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
686             return;
687         }
688         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
689             return;
690         }
691         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
692     }
695 /**
696  * Execution step that will create all the needed users as calculated
697  * by @restore_process_included_users (those having newiteind = 0)
698  */
699 class restore_create_included_users extends restore_execution_step {
701     protected function define_execution() {
703         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(), $this->task->get_userid());
704     }
707 /**
708  * Structure step that will create all the needed groups and groupings
709  * by loading them from the groups.xml file performing the required matches.
710  * Note group members only will be added if restoring user info
711  */
712 class restore_groups_structure_step extends restore_structure_step {
714     protected function define_structure() {
716         $paths = array(); // Add paths here
718         $paths[] = new restore_path_element('group', '/groups/group');
719         if ($this->get_setting_value('users')) {
720             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
721         }
722         $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
723         $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
725         return $paths;
726     }
728     // Processing functions go here
729     public function process_group($data) {
730         global $DB;
732         $data = (object)$data; // handy
733         $data->courseid = $this->get_courseid();
735         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
736         // another a group in the same course
737         $context = context_course::instance($data->courseid);
738         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
739             if (groups_get_group_by_idnumber($data->courseid, $data->idnumber)) {
740                 unset($data->idnumber);
741             }
742         } else {
743             unset($data->idnumber);
744         }
746         $oldid = $data->id;    // need this saved for later
748         $restorefiles = false; // Only if we end creating the group
750         // Search if the group already exists (by name & description) in the target course
751         $description_clause = '';
752         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
753         if (!empty($data->description)) {
754             $description_clause = ' AND ' .
755                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
756            $params['description'] = $data->description;
757         }
758         if (!$groupdb = $DB->get_record_sql("SELECT *
759                                                FROM {groups}
760                                               WHERE courseid = :courseid
761                                                 AND name = :grname $description_clause", $params)) {
762             // group doesn't exist, create
763             $newitemid = $DB->insert_record('groups', $data);
764             $restorefiles = true; // We'll restore the files
765         } else {
766             // group exists, use it
767             $newitemid = $groupdb->id;
768         }
769         // Save the id mapping
770         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
771     }
773     public function process_member($data) {
774         global $DB;
776         $data = (object)$data; // handy
778         // get parent group->id
779         $data->groupid = $this->get_new_parentid('group');
781         // map user newitemid and insert if not member already
782         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
783             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
784                 $DB->insert_record('groups_members', $data);
785             }
786         }
787     }
789     public function process_grouping($data) {
790         global $DB;
792         $data = (object)$data; // handy
793         $data->courseid = $this->get_courseid();
795         // Only allow the idnumber to be set if the user has permission and the idnumber is not already in use by
796         // another a grouping in the same course
797         $context = context_course::instance($data->courseid);
798         if (isset($data->idnumber) and has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
799             if (groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) {
800                 unset($data->idnumber);
801             }
802         } else {
803             unset($data->idnumber);
804         }
806         $oldid = $data->id;    // need this saved for later
807         $restorefiles = false; // Only if we end creating the grouping
809         // Search if the grouping already exists (by name & description) in the target course
810         $description_clause = '';
811         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
812         if (!empty($data->description)) {
813             $description_clause = ' AND ' .
814                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
815            $params['description'] = $data->description;
816         }
817         if (!$groupingdb = $DB->get_record_sql("SELECT *
818                                                   FROM {groupings}
819                                                  WHERE courseid = :courseid
820                                                    AND name = :grname $description_clause", $params)) {
821             // grouping doesn't exist, create
822             $newitemid = $DB->insert_record('groupings', $data);
823             $restorefiles = true; // We'll restore the files
824         } else {
825             // grouping exists, use it
826             $newitemid = $groupingdb->id;
827         }
828         // Save the id mapping
829         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
830     }
832     public function process_grouping_group($data) {
833         global $DB;
835         $data = (object)$data;
837         $data->groupingid = $this->get_new_parentid('grouping'); // Use new parentid
838         $data->groupid    = $this->get_mappingid('group', $data->groupid); // Get from mappings
840         $params = array();
841         $params['groupingid'] = $data->groupingid;
842         $params['groupid']    = $data->groupid;
844         if (!$DB->record_exists('groupings_groups', $params)) {
845             $DB->insert_record('groupings_groups', $data);  // No need to set this mapping (no child info nor files)
846         }
847     }
849     protected function after_execute() {
850         // Add group related files, matching with "group" mappings
851         $this->add_related_files('group', 'icon', 'group');
852         $this->add_related_files('group', 'description', 'group');
853         // Add grouping related files, matching with "grouping" mappings
854         $this->add_related_files('grouping', 'description', 'grouping');
855     }
859 /**
860  * Structure step that will create all the needed scales
861  * by loading them from the scales.xml
862  */
863 class restore_scales_structure_step extends restore_structure_step {
865     protected function define_structure() {
867         $paths = array(); // Add paths here
868         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
869         return $paths;
870     }
872     protected function process_scale($data) {
873         global $DB;
875         $data = (object)$data;
877         $restorefiles = false; // Only if we end creating the group
879         $oldid = $data->id;    // need this saved for later
881         // Look for scale (by 'scale' both in standard (course=0) and current course
882         // with priority to standard scales (ORDER clause)
883         // scale is not course unique, use get_record_sql to suppress warning
884         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
885         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
886         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
887         if (!$scadb = $DB->get_record_sql("SELECT *
888                                             FROM {scale}
889                                            WHERE courseid IN (0, :courseid)
890                                              AND $compare_scale_clause
891                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
892             // Remap the user if possible, defaut to user performing the restore if not
893             $userid = $this->get_mappingid('user', $data->userid);
894             $data->userid = $userid ? $userid : $this->task->get_userid();
895             // Remap the course if course scale
896             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
897             // If global scale (course=0), check the user has perms to create it
898             // falling to course scale if not
899             $systemctx = get_context_instance(CONTEXT_SYSTEM);
900             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
901                 $data->courseid = $this->get_courseid();
902             }
903             // scale doesn't exist, create
904             $newitemid = $DB->insert_record('scale', $data);
905             $restorefiles = true; // We'll restore the files
906         } else {
907             // scale exists, use it
908             $newitemid = $scadb->id;
909         }
910         // Save the id mapping (with files support at system context)
911         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
912     }
914     protected function after_execute() {
915         // Add scales related files, matching with "scale" mappings
916         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
917     }
921 /**
922  * Structure step that will create all the needed outocomes
923  * by loading them from the outcomes.xml
924  */
925 class restore_outcomes_structure_step extends restore_structure_step {
927     protected function define_structure() {
929         $paths = array(); // Add paths here
930         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
931         return $paths;
932     }
934     protected function process_outcome($data) {
935         global $DB;
937         $data = (object)$data;
939         $restorefiles = false; // Only if we end creating the group
941         $oldid = $data->id;    // need this saved for later
943         // Look for outcome (by shortname both in standard (courseid=null) and current course
944         // with priority to standard outcomes (ORDER clause)
945         // outcome is not course unique, use get_record_sql to suppress warning
946         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
947         if (!$outdb = $DB->get_record_sql('SELECT *
948                                              FROM {grade_outcomes}
949                                             WHERE shortname = :shortname
950                                               AND (courseid = :courseid OR courseid IS NULL)
951                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
952             // Remap the user
953             $userid = $this->get_mappingid('user', $data->usermodified);
954             $data->usermodified = $userid ? $userid : $this->task->get_userid();
955             // Remap the scale
956             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
957             // Remap the course if course outcome
958             $data->courseid = $data->courseid ? $this->get_courseid() : null;
959             // If global outcome (course=null), check the user has perms to create it
960             // falling to course outcome if not
961             $systemctx = get_context_instance(CONTEXT_SYSTEM);
962             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
963                 $data->courseid = $this->get_courseid();
964             }
965             // outcome doesn't exist, create
966             $newitemid = $DB->insert_record('grade_outcomes', $data);
967             $restorefiles = true; // We'll restore the files
968         } else {
969             // scale exists, use it
970             $newitemid = $outdb->id;
971         }
972         // Set the corresponding grade_outcomes_courses record
973         $outcourserec = new stdclass();
974         $outcourserec->courseid  = $this->get_courseid();
975         $outcourserec->outcomeid = $newitemid;
976         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
977             $DB->insert_record('grade_outcomes_courses', $outcourserec);
978         }
979         // Save the id mapping (with files support at system context)
980         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
981     }
983     protected function after_execute() {
984         // Add outcomes related files, matching with "outcome" mappings
985         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
986     }
989 /**
990  * Execution step that, *conditionally* (if there isn't preloaded information
991  * will load all the question categories and questions (header info only)
992  * to backup_temp_ids. They will be stored with "question_category" and
993  * "question" itemnames and with their original contextid and question category
994  * id as paremitemids
995  */
996 class restore_load_categories_and_questions extends restore_execution_step {
998     protected function define_execution() {
1000         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1001             return;
1002         }
1003         $file = $this->get_basepath() . '/questions.xml';
1004         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
1005     }
1008 /**
1009  * Execution step that, *conditionally* (if there isn't preloaded information)
1010  * will process all the needed categories and questions
1011  * in order to decide and perform any action with them (create / map / error)
1012  * Note: Any error will cause exception, as far as this is the same processing
1013  * than the one into restore prechecks (that should have stopped process earlier)
1014  */
1015 class restore_process_categories_and_questions extends restore_execution_step {
1017     protected function define_execution() {
1019         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
1020             return;
1021         }
1022         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
1023     }
1026 /**
1027  * Structure step that will read the section.xml creating/updating sections
1028  * as needed, rebuilding course cache and other friends
1029  */
1030 class restore_section_structure_step extends restore_structure_step {
1032     protected function define_structure() {
1033         global $CFG;
1035         $paths = array();
1037         $section = new restore_path_element('section', '/section');
1038         $paths[] = $section;
1039         if ($CFG->enableavailability) {
1040             $paths[] = new restore_path_element('availability', '/section/availability');
1041         }
1043         // Apply for 'format' plugins optional paths at section level
1044         $this->add_plugin_structure('format', $section);
1046         return $paths;
1047     }
1049     public function process_section($data) {
1050         global $CFG, $DB;
1051         $data = (object)$data;
1052         $oldid = $data->id; // We'll need this later
1053         $oldsection = $data->number;
1055         $restorefiles = false;
1057         // Look for the section
1058         $section = new stdclass();
1059         $section->course  = $this->get_courseid();
1060         $section->section = $data->number;
1061         // Section doesn't exist, create it with all the info from backup
1062         if (!$secrec = $DB->get_record('course_sections', (array)$section)) {
1063             $section->name = $data->name;
1064             $section->summary = $data->summary;
1065             $section->summaryformat = $data->summaryformat;
1066             $section->sequence = '';
1067             $section->visible = $data->visible;
1068             if (empty($CFG->enableavailability)) { // Process availability information only if enabled.
1069                 $section->availablefrom = 0;
1070                 $section->availableuntil = 0;
1071                 $section->showavailability = 0;
1072             } else {
1073                 $section->availablefrom = isset($data->availablefrom) ? $this->apply_date_offset($data->availablefrom) : 0;
1074                 $section->availableuntil = isset($data->availableuntil) ? $this->apply_date_offset($data->availableuntil) : 0;
1075                 $section->showavailability = isset($data->showavailability) ? $data->showavailability : 0;
1076             }
1077             if (!empty($CFG->enablegroupmembersonly)) { // Only if enablegroupmembersonly is enabled
1078                 $section->groupingid = isset($data->groupingid) ? $this->get_mappingid('grouping', $data->groupingid) : 0;
1079             }
1080             $newitemid = $DB->insert_record('course_sections', $section);
1081             $restorefiles = true;
1083         // Section exists, update non-empty information
1084         } else {
1085             $section->id = $secrec->id;
1086             if (empty($secrec->name)) {
1087                 $section->name = $data->name;
1088             }
1089             if (empty($secrec->summary)) {
1090                 $section->summary = $data->summary;
1091                 $section->summaryformat = $data->summaryformat;
1092                 $restorefiles = true;
1093             }
1094             if (empty($secrec->groupingid)) {
1095                 if (!empty($CFG->enablegroupmembersonly)) { // Only if enablegroupmembersonly is enabled
1096                     $section->groupingid = isset($data->groupingid) ? $this->get_mappingid('grouping', $data->groupingid) : 0;
1097                 }
1098             }
1100             // Don't update available from, available until, or show availability
1101             // (I didn't see a useful way to define whether existing or new one should
1102             // take precedence).
1104             $DB->update_record('course_sections', $section);
1105             $newitemid = $secrec->id;
1106             $oldsection = $secrec->section;
1107         }
1109         // Annotate the section mapping, with restorefiles option if needed
1110         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
1111         $this->set_mapping('course_sectionnumber', $oldsection, $section->section);
1113         // set the new course_section id in the task
1114         $this->task->set_sectionid($newitemid);
1117         // Commented out. We never modify course->numsections as far as that is used
1118         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
1119         // Note: We keep the code here, to know about and because of the possibility of making this
1120         // optional based on some setting/attribute in the future
1121         // If needed, adjust course->numsections
1122         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
1123         //    if ($numsections < $section->section) {
1124         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
1125         //    }
1126         //}
1127     }
1129     public function process_availability($data) {
1130         global $DB;
1131         $data = (object)$data;
1133         $data->coursesectionid = $this->task->get_sectionid();
1135         // NOTE: Other values in $data need updating, but these (cm,
1136         // grade items) have not yet been restored, so are done later.
1138         $newid = $DB->insert_record('course_sections_availability', $data);
1140         // We do not need to map between old and new id but storing a mapping
1141         // means it gets added to the backup_ids table to record which ones
1142         // need updating. The mapping is stored with $newid => $newid for
1143         // convenience.
1144         $this->set_mapping('course_sections_availability', $newid, $newid);
1145     }
1147     protected function after_execute() {
1148         // Add section related files, with 'course_section' itemid to match
1149         $this->add_related_files('course', 'section', 'course_section');
1150     }
1152     public function after_restore() {
1153         global $DB;
1155         $sectionid = $this->get_task()->get_sectionid();
1157         // Get data object for current section availability (if any).
1158         $data = $DB->get_record('course_sections_availability',
1159                 array('coursesectionid' => $sectionid), 'id, sourcecmid, gradeitemid', IGNORE_MISSING);
1161         // If it exists, update mappings.
1162         if ($data) {
1163             // Only update mappings for entries which are created by this restore.
1164             // Otherwise, when you restore to an existing course, it will mess up
1165             // existing section availability entries.
1166             if (!$this->get_mappingid('course_sections_availability', $data->id, false)) {
1167                 return;
1168             }
1170             // Update source cmid / grade id to new value.
1171             $data->sourcecmid = $this->get_mappingid('course_module', $data->sourcecmid);
1172             if (!$data->sourcecmid) {
1173                 $data->sourcecmid = null;
1174             }
1175             $data->gradeitemid = $this->get_mappingid('grade_item', $data->gradeitemid);
1176             if (!$data->gradeitemid) {
1177                 $data->gradeitemid = null;
1178             }
1180             $DB->update_record('course_sections_availability', $data);
1181         }
1182     }
1186 /**
1187  * Structure step that will read the course.xml file, loading it and performing
1188  * various actions depending of the site/restore settings. Note that target
1189  * course always exist before arriving here so this step will be updating
1190  * the course record (never inserting)
1191  */
1192 class restore_course_structure_step extends restore_structure_step {
1193     /**
1194      * @var bool this gets set to true by {@link process_course()} if we are
1195      * restoring an old coures that used the legacy 'module security' feature.
1196      * If so, we have to do more work in {@link after_execute()}.
1197      */
1198     protected $legacyrestrictmodules = false;
1200     /**
1201      * @var array Used when {@link $legacyrestrictmodules} is true. This is an
1202      * array with array keys the module names ('forum', 'quiz', etc.). These are
1203      * the modules that are allowed according to the data in the backup file.
1204      * In {@link after_execute()} we then have to prevent adding of all the other
1205      * types of activity.
1206      */
1207     protected $legacyallowedmodules = array();
1209     protected function define_structure() {
1211         $course = new restore_path_element('course', '/course');
1212         $category = new restore_path_element('category', '/course/category');
1213         $tag = new restore_path_element('tag', '/course/tags/tag');
1214         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1216         // Apply for 'format' plugins optional paths at course level
1217         $this->add_plugin_structure('format', $course);
1219         // Apply for 'theme' plugins optional paths at course level
1220         $this->add_plugin_structure('theme', $course);
1222         // Apply for 'report' plugins optional paths at course level
1223         $this->add_plugin_structure('report', $course);
1225         // Apply for 'course report' plugins optional paths at course level
1226         $this->add_plugin_structure('coursereport', $course);
1228         // Apply for plagiarism plugins optional paths at course level
1229         $this->add_plugin_structure('plagiarism', $course);
1231         return array($course, $category, $tag, $allowed_module);
1232     }
1234     /**
1235      * Processing functions go here
1236      *
1237      * @global moodledatabase $DB
1238      * @param stdClass $data
1239      */
1240     public function process_course($data) {
1241         global $CFG, $DB;
1243         $data = (object)$data;
1245         $fullname  = $this->get_setting_value('course_fullname');
1246         $shortname = $this->get_setting_value('course_shortname');
1247         $startdate = $this->get_setting_value('course_startdate');
1249         // Calculate final course names, to avoid dupes
1250         list($fullname, $shortname) = restore_dbops::calculate_course_names($this->get_courseid(), $fullname, $shortname);
1252         // Need to change some fields before updating the course record
1253         $data->id = $this->get_courseid();
1254         $data->fullname = $fullname;
1255         $data->shortname= $shortname;
1257         $context = get_context_instance_by_id($this->task->get_contextid());
1258         if (has_capability('moodle/course:changeidnumber', $context, $this->task->get_userid())) {
1259             $data->idnumber = '';
1260         } else {
1261             unset($data->idnumber);
1262         }
1264         // Any empty value for course->hiddensections will lead to 0 (default, show collapsed).
1265         // It has been reported that some old 1.9 courses may have it null leading to DB error. MDL-31532
1266         if (empty($data->hiddensections)) {
1267             $data->hiddensections = 0;
1268         }
1270         // Set legacyrestrictmodules to true if the course was resticting modules. If so
1271         // then we will need to process restricted modules after execution.
1272         $this->legacyrestrictmodules = !empty($data->restrictmodules);
1274         $data->startdate= $this->apply_date_offset($data->startdate);
1275         if ($data->defaultgroupingid) {
1276             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1277         }
1278         if (empty($CFG->enablecompletion)) {
1279             $data->enablecompletion = 0;
1280             $data->completionstartonenrol = 0;
1281             $data->completionnotify = 0;
1282         }
1283         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1284         if (!array_key_exists($data->lang, $languages)) {
1285             $data->lang = '';
1286         }
1288         $themes = get_list_of_themes(); // Get themes for quick search later
1289         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1290             $data->theme = '';
1291         }
1293         // Course record ready, update it
1294         $DB->update_record('course', $data);
1296         // Role name aliases
1297         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1298     }
1300     public function process_category($data) {
1301         // Nothing to do with the category. UI sets it before restore starts
1302     }
1304     public function process_tag($data) {
1305         global $CFG, $DB;
1307         $data = (object)$data;
1309         if (!empty($CFG->usetags)) { // if enabled in server
1310             // TODO: This is highly inneficient. Each time we add one tag
1311             // we fetch all the existing because tag_set() deletes them
1312             // so everything must be reinserted on each call
1313             $tags = array();
1314             $existingtags = tag_get_tags('course', $this->get_courseid());
1315             // Re-add all the existitng tags
1316             foreach ($existingtags as $existingtag) {
1317                 $tags[] = $existingtag->rawname;
1318             }
1319             // Add the one being restored
1320             $tags[] = $data->rawname;
1321             // Send all the tags back to the course
1322             tag_set('course', $this->get_courseid(), $tags);
1323         }
1324     }
1326     public function process_allowed_module($data) {
1327         $data = (object)$data;
1329         // Backwards compatiblity support for the data that used to be in the
1330         // course_allowed_modules table.
1331         if ($this->legacyrestrictmodules) {
1332             $this->legacyallowedmodules[$data->modulename] = 1;
1333         }
1334     }
1336     protected function after_execute() {
1337         global $DB;
1339         // Add course related files, without itemid to match
1340         $this->add_related_files('course', 'summary', null);
1341         $this->add_related_files('course', 'legacy', null);
1343         // Deal with legacy allowed modules.
1344         if ($this->legacyrestrictmodules) {
1345             $context = context_course::instance($this->get_courseid());
1347             list($roleids) = get_roles_with_cap_in_context($context, 'moodle/course:manageactivities');
1348             list($managerroleids) = get_roles_with_cap_in_context($context, 'moodle/site:config');
1349             foreach ($managerroleids as $roleid) {
1350                 unset($roleids[$roleid]);
1351             }
1353             foreach (get_plugin_list('mod') as $modname => $notused) {
1354                 if (isset($this->legacyallowedmodules[$modname])) {
1355                     // Module is allowed, no worries.
1356                     continue;
1357                 }
1359                 $capability = 'mod/' . $modname . ':addinstance';
1360                 foreach ($roleids as $roleid) {
1361                     assign_capability($capability, CAP_PREVENT, $roleid, $context);
1362                 }
1363             }
1364         }
1365     }
1369 /*
1370  * Structure step that will read the roles.xml file (at course/activity/block levels)
1371  * containig all the role_assignments and overrides for that context. If corresponding to
1372  * one mapped role, they will be applied to target context. Will observe the role_assignments
1373  * setting to decide if ras are restored.
1374  * Note: only ras with component == null are restored as far as the any ra with component
1375  * is handled by one enrolment plugin, hence it will createt the ras later
1376  */
1377 class restore_ras_and_caps_structure_step extends restore_structure_step {
1379     protected function define_structure() {
1381         $paths = array();
1383         // Observe the role_assignments setting
1384         if ($this->get_setting_value('role_assignments')) {
1385             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
1386         }
1387         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
1389         return $paths;
1390     }
1392     /**
1393      * Assign roles
1394      *
1395      * This has to be called after enrolments processing.
1396      *
1397      * @param mixed $data
1398      * @return void
1399      */
1400     public function process_assignment($data) {
1401         global $DB;
1403         $data = (object)$data;
1405         // Check roleid, userid are one of the mapped ones
1406         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
1407             return;
1408         }
1409         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
1410             return;
1411         }
1412         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
1413             // Only assign roles to not deleted users
1414             return;
1415         }
1416         if (!$contextid = $this->task->get_contextid()) {
1417             return;
1418         }
1420         if (empty($data->component)) {
1421             // assign standard manual roles
1422             // TODO: role_assign() needs one userid param to be able to specify our restore userid
1423             role_assign($newroleid, $newuserid, $contextid);
1425         } else if ((strpos($data->component, 'enrol_') === 0)) {
1426             // Deal with enrolment roles
1427             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1428                 if ($component = $DB->get_field('enrol', 'component', array('id'=>$enrolid))) {
1429                     //note: we have to verify component because it might have changed
1430                     if ($component === 'enrol_manual') {
1431                         // manual is a special case, we do not use components - this owudl happen when converting from other plugin
1432                         role_assign($newroleid, $newuserid, $contextid); //TODO: do we need modifierid?
1433                     } else {
1434                         role_assign($newroleid, $newuserid, $contextid, $component, $enrolid); //TODO: do we need modifierid?
1435                     }
1436                 }
1437             }
1438         }
1439     }
1441     public function process_override($data) {
1442         $data = (object)$data;
1444         // Check roleid is one of the mapped ones
1445         $newroleid = $this->get_mappingid('role', $data->roleid);
1446         // If newroleid and context are valid assign it via API (it handles dupes and so on)
1447         if ($newroleid && $this->task->get_contextid()) {
1448             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
1449             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
1450             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
1451         }
1452     }
1455 /**
1456  * This structure steps restores the enrol plugins and their underlying
1457  * enrolments, performing all the mappings and/or movements required
1458  */
1459 class restore_enrolments_structure_step extends restore_structure_step {
1461     /**
1462      * Conditionally decide if this step should be executed.
1463      *
1464      * This function checks the following parameter:
1465      *
1466      *   1. the course/enrolments.xml file exists
1467      *
1468      * @return bool true is safe to execute, false otherwise
1469      */
1470     protected function execute_condition() {
1472         // Check it is included in the backup
1473         $fullpath = $this->task->get_taskbasepath();
1474         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1475         if (!file_exists($fullpath)) {
1476             // Not found, can't restore enrolments info
1477             return false;
1478         }
1480         return true;
1481     }
1483     protected function define_structure() {
1485         $paths = array();
1487         $paths[] = new restore_path_element('enrol', '/enrolments/enrols/enrol');
1488         $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
1490         return $paths;
1491     }
1493     /**
1494      * Create enrolment instances.
1495      *
1496      * This has to be called after creation of roles
1497      * and before adding of role assignments.
1498      *
1499      * @param mixed $data
1500      * @return void
1501      */
1502     public function process_enrol($data) {
1503         global $DB;
1505         $data = (object)$data;
1506         $oldid = $data->id; // We'll need this later
1508         $restoretype = plugin_supports('enrol', $data->enrol, ENROL_RESTORE_TYPE, null);
1510         if ($restoretype !== ENROL_RESTORE_EXACT and $restoretype !== ENROL_RESTORE_NOUSERS) {
1511             // TODO: add complex restore support via custom class
1512             debugging("Skipping '{$data->enrol}' enrolment plugin. Will be implemented before 2.0 release", DEBUG_DEVELOPER);
1513             $this->set_mapping('enrol', $oldid, 0);
1514             return;
1515         }
1517         // Perform various checks to decide what to do with the enrol plugin
1518         if (!array_key_exists($data->enrol, enrol_get_plugins(false))) {
1519             // TODO: decide if we want to switch to manual enrol - we need UI for this
1520             debugging("Enrol plugin data can not be restored because it is not installed");
1521             $this->set_mapping('enrol', $oldid, 0);
1522             return;
1524         }
1525         if (!enrol_is_enabled($data->enrol)) {
1526             // TODO: decide if we want to switch to manual enrol - we need UI for this
1527             debugging("Enrol plugin data can not be restored because it is not enabled");
1528             $this->set_mapping('enrol', $oldid, 0);
1529             return;
1530         }
1532         // map standard fields - plugin has to process custom fields from own restore class
1533         $data->roleid = $this->get_mappingid('role', $data->roleid);
1534         //TODO: should we move the enrol start and end date here?
1536         // always add instance, if the course does not support multiple instances it just returns NULL
1537         $enrol = enrol_get_plugin($data->enrol);
1538         $courserec = $DB->get_record('course', array('id' => $this->get_courseid())); // Requires object, uses only id!!
1539         if ($newitemid = $enrol->add_instance($courserec, (array)$data)) {
1540             // ok
1541         } else {
1542             if ($instances = $DB->get_records('enrol', array('courseid'=>$courserec->id, 'enrol'=>$data->enrol))) {
1543                 // most probably plugin that supports only one instance
1544                 $newitemid = key($instances);
1545             } else {
1546                 debugging('Can not create new enrol instance or reuse existing');
1547                 $newitemid = 0;
1548             }
1549         }
1551         if ($restoretype === ENROL_RESTORE_NOUSERS) {
1552             // plugin requests to prevent restore of any users
1553             $newitemid = 0;
1554         }
1556         $this->set_mapping('enrol', $oldid, $newitemid);
1557     }
1559     /**
1560      * Create user enrolments
1561      *
1562      * This has to be called after creation of enrolment instances
1563      * and before adding of role assignments.
1564      *
1565      * @param mixed $data
1566      * @return void
1567      */
1568     public function process_enrolment($data) {
1569         global $DB;
1571         $data = (object)$data;
1573         // Process only if parent instance have been mapped
1574         if ($enrolid = $this->get_new_parentid('enrol')) {
1575             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1576                 // And only if user is a mapped one
1577                 if ($userid = $this->get_mappingid('user', $data->userid)) {
1578                     $enrol = enrol_get_plugin($instance->enrol);
1579                     //TODO: do we need specify modifierid?
1580                     $enrol->enrol_user($instance, $userid, null, $data->timestart, $data->timeend, $data->status);
1581                     //note: roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing above
1582                 }
1583             }
1584         }
1585     }
1589 /**
1590  * Make sure the user restoring the course can actually access it.
1591  */
1592 class restore_fix_restorer_access_step extends restore_execution_step {
1593     protected function define_execution() {
1594         global $CFG, $DB;
1596         if (!$userid = $this->task->get_userid()) {
1597             return;
1598         }
1600         if (empty($CFG->restorernewroleid)) {
1601             // Bad luck, no fallback role for restorers specified
1602             return;
1603         }
1605         $courseid = $this->get_courseid();
1606         $context = context_course::instance($courseid);
1608         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1609             // Current user may access the course (admin, category manager or restored teacher enrolment usually)
1610             return;
1611         }
1613         // Try to add role only - we do not need enrolment if user has moodle/course:view or is already enrolled
1614         role_assign($CFG->restorernewroleid, $userid, $context);
1616         if (is_enrolled($context, $userid, 'moodle/course:update', true) or is_viewing($context, $userid, 'moodle/course:update')) {
1617             // Extra role is enough, yay!
1618             return;
1619         }
1621         // The last chance is to create manual enrol if it does not exist and and try to enrol the current user,
1622         // hopefully admin selected suitable $CFG->restorernewroleid ...
1623         if (!enrol_is_enabled('manual')) {
1624             return;
1625         }
1626         if (!$enrol = enrol_get_plugin('manual')) {
1627             return;
1628         }
1629         if (!$DB->record_exists('enrol', array('enrol'=>'manual', 'courseid'=>$courseid))) {
1630             $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
1631             $fields = array('status'=>ENROL_INSTANCE_ENABLED, 'enrolperiod'=>$enrol->get_config('enrolperiod', 0), 'roleid'=>$enrol->get_config('roleid', 0));
1632             $enrol->add_instance($course, $fields);
1633         }
1635         enrol_try_internal_enrol($courseid, $userid);
1636     }
1640 /**
1641  * This structure steps restores the filters and their configs
1642  */
1643 class restore_filters_structure_step extends restore_structure_step {
1645     protected function define_structure() {
1647         $paths = array();
1649         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
1650         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
1652         return $paths;
1653     }
1655     public function process_active($data) {
1657         $data = (object)$data;
1659         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1660             return;
1661         }
1662         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
1663     }
1665     public function process_config($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_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
1673     }
1677 /**
1678  * This structure steps restores the comments
1679  * Note: Cannot use the comments API because defaults to USER->id.
1680  * That should change allowing to pass $userid
1681  */
1682 class restore_comments_structure_step extends restore_structure_step {
1684     protected function define_structure() {
1686         $paths = array();
1688         $paths[] = new restore_path_element('comment', '/comments/comment');
1690         return $paths;
1691     }
1693     public function process_comment($data) {
1694         global $DB;
1696         $data = (object)$data;
1698         // First of all, if the comment has some itemid, ask to the task what to map
1699         $mapping = false;
1700         if ($data->itemid) {
1701             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
1702             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
1703         }
1704         // Only restore the comment if has no mapping OR we have found the matching mapping
1705         if (!$mapping || $data->itemid) {
1706             // Only if user mapping and context
1707             $data->userid = $this->get_mappingid('user', $data->userid);
1708             if ($data->userid && $this->task->get_contextid()) {
1709                 $data->contextid = $this->task->get_contextid();
1710                 // Only if there is another comment with same context/user/timecreated
1711                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
1712                 if (!$DB->record_exists('comments', $params)) {
1713                     $DB->insert_record('comments', $data);
1714                 }
1715             }
1716         }
1717     }
1720 /**
1721  * This structure steps restores the calendar events
1722  */
1723 class restore_calendarevents_structure_step extends restore_structure_step {
1725     protected function define_structure() {
1727         $paths = array();
1729         $paths[] = new restore_path_element('calendarevents', '/events/event');
1731         return $paths;
1732     }
1734     public function process_calendarevents($data) {
1735         global $DB;
1737         $data = (object)$data;
1738         $oldid = $data->id;
1739         $restorefiles = true; // We'll restore the files
1740         // Find the userid and the groupid associated with the event. Return if not found.
1741         $data->userid = $this->get_mappingid('user', $data->userid);
1742         if ($data->userid === false) {
1743             return;
1744         }
1745         if (!empty($data->groupid)) {
1746             $data->groupid = $this->get_mappingid('group', $data->groupid);
1747             if ($data->groupid === false) {
1748                 return;
1749             }
1750         }
1752         $params = array(
1753                 'name'           => $data->name,
1754                 'description'    => $data->description,
1755                 'format'         => $data->format,
1756                 'courseid'       => $this->get_courseid(),
1757                 'groupid'        => $data->groupid,
1758                 'userid'         => $data->userid,
1759                 'repeatid'       => $data->repeatid,
1760                 'modulename'     => $data->modulename,
1761                 'eventtype'      => $data->eventtype,
1762                 'timestart'      => $this->apply_date_offset($data->timestart),
1763                 'timeduration'   => $data->timeduration,
1764                 'visible'        => $data->visible,
1765                 'uuid'           => $data->uuid,
1766                 'sequence'       => $data->sequence,
1767                 'timemodified'    => $this->apply_date_offset($data->timemodified));
1768         if ($this->name == 'activity_calendar') {
1769             $params['instance'] = $this->task->get_activityid();
1770         } else {
1771             $params['instance'] = 0;
1772         }
1773         $sql = 'SELECT id FROM {event} WHERE name = ? AND courseid = ? AND
1774                 repeatid = ? AND modulename = ? AND timestart = ? AND timeduration =?
1775                 AND ' . $DB->sql_compare_text('description', 255) . ' = ' . $DB->sql_compare_text('?', 255);
1776         $arg = array ($params['name'], $params['courseid'], $params['repeatid'], $params['modulename'], $params['timestart'], $params['timeduration'], $params['description']);
1777         $result = $DB->record_exists_sql($sql, $arg);
1778         if (empty($result)) {
1779             $newitemid = $DB->insert_record('event', $params);
1780             $this->set_mapping('event_description', $oldid, $newitemid, $restorefiles);
1781         }
1783     }
1784     protected function after_execute() {
1785         // Add related files
1786         $this->add_related_files('calendar', 'event_description', 'event_description');
1787     }
1790 class restore_course_completion_structure_step extends restore_structure_step {
1792     /**
1793      * Conditionally decide if this step should be executed.
1794      *
1795      * This function checks parameters that are not immediate settings to ensure
1796      * that the enviroment is suitable for the restore of course completion info.
1797      *
1798      * This function checks the following four parameters:
1799      *
1800      *   1. Course completion is enabled on the site
1801      *   2. The backup includes course completion information
1802      *   3. All modules are restorable
1803      *   4. All modules are marked for restore.
1804      *
1805      * @return bool True is safe to execute, false otherwise
1806      */
1807     protected function execute_condition() {
1808         global $CFG;
1810         // First check course completion is enabled on this site
1811         if (empty($CFG->enablecompletion)) {
1812             // Disabled, don't restore course completion
1813             return false;
1814         }
1816         // Check it is included in the backup
1817         $fullpath = $this->task->get_taskbasepath();
1818         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1819         if (!file_exists($fullpath)) {
1820             // Not found, can't restore course completion
1821             return false;
1822         }
1824         // Check we are able to restore all backed up modules
1825         if ($this->task->is_missing_modules()) {
1826             return false;
1827         }
1829         // Finally check all modules within the backup are being restored.
1830         if ($this->task->is_excluding_activities()) {
1831             return false;
1832         }
1834         return true;
1835     }
1837     /**
1838      * Define the course completion structure
1839      *
1840      * @return array Array of restore_path_element
1841      */
1842     protected function define_structure() {
1844         // To know if we are including user completion info
1845         $userinfo = $this->get_setting_value('userscompletion');
1847         $paths = array();
1848         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
1849         $paths[] = new restore_path_element('course_completion_notify', '/course_completion/course_completion_notify');
1850         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
1852         if ($userinfo) {
1853             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
1854             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
1855         }
1857         return $paths;
1859     }
1861     /**
1862      * Process course completion criteria
1863      *
1864      * @global moodle_database $DB
1865      * @param stdClass $data
1866      */
1867     public function process_course_completion_criteria($data) {
1868         global $DB;
1870         $data = (object)$data;
1871         $data->course = $this->get_courseid();
1873         // Apply the date offset to the time end field
1874         $data->timeend = $this->apply_date_offset($data->timeend);
1876         // Map the role from the criteria
1877         if (!empty($data->role)) {
1878             $data->role = $this->get_mappingid('role', $data->role);
1879         }
1881         $skipcriteria = false;
1883         // If the completion criteria is for a module we need to map the module instance
1884         // to the new module id.
1885         if (!empty($data->moduleinstance) && !empty($data->module)) {
1886             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
1887             if (empty($data->moduleinstance)) {
1888                 $skipcriteria = true;
1889             }
1890         } else {
1891             $data->module = null;
1892             $data->moduleinstance = null;
1893         }
1895         // We backup the course shortname rather than the ID so that we can match back to the course
1896         if (!empty($data->courseinstanceshortname)) {
1897             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
1898             if (!$courseinstanceid) {
1899                 $skipcriteria = true;
1900             }
1901         } else {
1902             $courseinstanceid = null;
1903         }
1904         $data->courseinstance = $courseinstanceid;
1906         if (!$skipcriteria) {
1907             $params = array(
1908                 'course'         => $data->course,
1909                 'criteriatype'   => $data->criteriatype,
1910                 'enrolperiod'    => $data->enrolperiod,
1911                 'courseinstance' => $data->courseinstance,
1912                 'module'         => $data->module,
1913                 'moduleinstance' => $data->moduleinstance,
1914                 'timeend'        => $data->timeend,
1915                 'gradepass'      => $data->gradepass,
1916                 'role'           => $data->role
1917             );
1918             $newid = $DB->insert_record('course_completion_criteria', $params);
1919             $this->set_mapping('course_completion_criteria', $data->id, $newid);
1920         }
1921     }
1923     /**
1924      * Processes course compltion criteria complete records
1925      *
1926      * @global moodle_database $DB
1927      * @param stdClass $data
1928      */
1929     public function process_course_completion_crit_compl($data) {
1930         global $DB;
1932         $data = (object)$data;
1934         // This may be empty if criteria could not be restored
1935         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
1937         $data->course = $this->get_courseid();
1938         $data->userid = $this->get_mappingid('user', $data->userid);
1940         if (!empty($data->criteriaid) && !empty($data->userid)) {
1941             $params = array(
1942                 'userid' => $data->userid,
1943                 'course' => $data->course,
1944                 'criteriaid' => $data->criteriaid,
1945                 'timecompleted' => $this->apply_date_offset($data->timecompleted)
1946             );
1947             if (isset($data->gradefinal)) {
1948                 $params['gradefinal'] = $data->gradefinal;
1949             }
1950             if (isset($data->unenroled)) {
1951                 $params['unenroled'] = $data->unenroled;
1952             }
1953             if (isset($data->deleted)) {
1954                 $params['deleted'] = $data->deleted;
1955             }
1956             $DB->insert_record('course_completion_crit_compl', $params);
1957         }
1958     }
1960     /**
1961      * Process course completions
1962      *
1963      * @global moodle_database $DB
1964      * @param stdClass $data
1965      */
1966     public function process_course_completions($data) {
1967         global $DB;
1969         $data = (object)$data;
1971         $data->course = $this->get_courseid();
1972         $data->userid = $this->get_mappingid('user', $data->userid);
1974         if (!empty($data->userid)) {
1975             $params = array(
1976                 'userid' => $data->userid,
1977                 'course' => $data->course,
1978                 'deleted' => $data->deleted,
1979                 'timenotified' => $this->apply_date_offset($data->timenotified),
1980                 'timeenrolled' => $this->apply_date_offset($data->timeenrolled),
1981                 'timestarted' => $this->apply_date_offset($data->timestarted),
1982                 'timecompleted' => $this->apply_date_offset($data->timecompleted),
1983                 'reaggregate' => $data->reaggregate
1984             );
1985             $DB->insert_record('course_completions', $params);
1986         }
1987     }
1989     /**
1990      * Process course completion notification records.
1991      *
1992      * Note: As of Moodle 2.0 this table is not being used however it has been
1993      * left in in the hopes that one day the functionality there will be completed
1994      *
1995      * @global moodle_database $DB
1996      * @param stdClass $data
1997      */
1998     public function process_course_completion_notify($data) {
1999         global $DB;
2001         $data = (object)$data;
2003         $data->course = $this->get_courseid();
2004         if (!empty($data->role)) {
2005             $data->role = $this->get_mappingid('role', $data->role);
2006         }
2008         $params = array(
2009             'course' => $data->course,
2010             'role' => $data->role,
2011             'message' => $data->message,
2012             'timesent' => $this->apply_date_offset($data->timesent),
2013         );
2014         $DB->insert_record('course_completion_notify', $params);
2015     }
2017     /**
2018      * Process course completion aggregate methods
2019      *
2020      * @global moodle_database $DB
2021      * @param stdClass $data
2022      */
2023     public function process_course_completion_aggr_methd($data) {
2024         global $DB;
2026         $data = (object)$data;
2028         $data->course = $this->get_courseid();
2030         // Only create the course_completion_aggr_methd records if
2031         // the target course has not them defined. MDL-28180
2032         if (!$DB->record_exists('course_completion_aggr_methd', array(
2033                     'course' => $data->course,
2034                     'criteriatype' => $data->criteriatype))) {
2035             $params = array(
2036                 'course' => $data->course,
2037                 'criteriatype' => $data->criteriatype,
2038                 'method' => $data->method,
2039                 'value' => $data->value,
2040             );
2041             $DB->insert_record('course_completion_aggr_methd', $params);
2042         }
2043     }
2047 /**
2048  * This structure step restores course logs (cmid = 0), delegating
2049  * the hard work to the corresponding {@link restore_logs_processor} passing the
2050  * collection of {@link restore_log_rule} rules to be observed as they are defined
2051  * by the task. Note this is only executed based in the 'logs' setting.
2052  *
2053  * NOTE: This is executed by final task, to have all the activities already restored
2054  *
2055  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
2056  * records are. There are others like 'calendar' and 'upload' that will be handled
2057  * later.
2058  *
2059  * NOTE: All the missing actions (not able to be restored) are sent to logs for
2060  * debugging purposes
2061  */
2062 class restore_course_logs_structure_step extends restore_structure_step {
2064     /**
2065      * Conditionally decide if this step should be executed.
2066      *
2067      * This function checks the following parameter:
2068      *
2069      *   1. the course/logs.xml file exists
2070      *
2071      * @return bool true is safe to execute, false otherwise
2072      */
2073     protected function execute_condition() {
2075         // Check it is included in the backup
2076         $fullpath = $this->task->get_taskbasepath();
2077         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2078         if (!file_exists($fullpath)) {
2079             // Not found, can't restore course logs
2080             return false;
2081         }
2083         return true;
2084     }
2086     protected function define_structure() {
2088         $paths = array();
2090         // Simple, one plain level of information contains them
2091         $paths[] = new restore_path_element('log', '/logs/log');
2093         return $paths;
2094     }
2096     protected function process_log($data) {
2097         global $DB;
2099         $data = (object)($data);
2101         $data->time = $this->apply_date_offset($data->time);
2102         $data->userid = $this->get_mappingid('user', $data->userid);
2103         $data->course = $this->get_courseid();
2104         $data->cmid = 0;
2106         // For any reason user wasn't remapped ok, stop processing this
2107         if (empty($data->userid)) {
2108             return;
2109         }
2111         // Everything ready, let's delegate to the restore_logs_processor
2113         // Set some fixed values that will save tons of DB requests
2114         $values = array(
2115             'course' => $this->get_courseid());
2116         // Get instance and process log record
2117         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2119         // If we have data, insert it, else something went wrong in the restore_logs_processor
2120         if ($data) {
2121             $DB->insert_record('log', $data);
2122         }
2123     }
2126 /**
2127  * This structure step restores activity logs, extending {@link restore_course_logs_structure_step}
2128  * sharing its same structure but modifying the way records are handled
2129  */
2130 class restore_activity_logs_structure_step extends restore_course_logs_structure_step {
2132     protected function process_log($data) {
2133         global $DB;
2135         $data = (object)($data);
2137         $data->time = $this->apply_date_offset($data->time);
2138         $data->userid = $this->get_mappingid('user', $data->userid);
2139         $data->course = $this->get_courseid();
2140         $data->cmid = $this->task->get_moduleid();
2142         // For any reason user wasn't remapped ok, stop processing this
2143         if (empty($data->userid)) {
2144             return;
2145         }
2147         // Everything ready, let's delegate to the restore_logs_processor
2149         // Set some fixed values that will save tons of DB requests
2150         $values = array(
2151             'course' => $this->get_courseid(),
2152             'course_module' => $this->task->get_moduleid(),
2153             $this->task->get_modulename() => $this->task->get_activityid());
2154         // Get instance and process log record
2155         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
2157         // If we have data, insert it, else something went wrong in the restore_logs_processor
2158         if ($data) {
2159             $DB->insert_record('log', $data);
2160         }
2161     }
2165 /**
2166  * Defines the restore step for advanced grading methods attached to the activity module
2167  */
2168 class restore_activity_grading_structure_step extends restore_structure_step {
2170     /**
2171      * This step is executed only if the grading file is present
2172      */
2173      protected function execute_condition() {
2175         $fullpath = $this->task->get_taskbasepath();
2176         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2177         if (!file_exists($fullpath)) {
2178             return false;
2179         }
2181         return true;
2182     }
2185     /**
2186      * Declares paths in the grading.xml file we are interested in
2187      */
2188     protected function define_structure() {
2190         $paths = array();
2191         $userinfo = $this->get_setting_value('userinfo');
2193         $paths[] = new restore_path_element('grading_area', '/areas/area');
2195         $definition = new restore_path_element('grading_definition', '/areas/area/definitions/definition');
2196         $paths[] = $definition;
2197         $this->add_plugin_structure('gradingform', $definition);
2199         if ($userinfo) {
2200             $instance = new restore_path_element('grading_instance',
2201                 '/areas/area/definitions/definition/instances/instance');
2202             $paths[] = $instance;
2203             $this->add_plugin_structure('gradingform', $instance);
2204         }
2206         return $paths;
2207     }
2209     /**
2210      * Processes one grading area element
2211      *
2212      * @param array $data element data
2213      */
2214     protected function process_grading_area($data) {
2215         global $DB;
2217         $task = $this->get_task();
2218         $data = (object)$data;
2219         $oldid = $data->id;
2220         $data->component = 'mod_'.$task->get_modulename();
2221         $data->contextid = $task->get_contextid();
2223         $newid = $DB->insert_record('grading_areas', $data);
2224         $this->set_mapping('grading_area', $oldid, $newid);
2225     }
2227     /**
2228      * Processes one grading definition element
2229      *
2230      * @param array $data element data
2231      */
2232     protected function process_grading_definition($data) {
2233         global $DB;
2235         $task = $this->get_task();
2236         $data = (object)$data;
2237         $oldid = $data->id;
2238         $data->areaid = $this->get_new_parentid('grading_area');
2239         $data->copiedfromid = null;
2240         $data->timecreated = time();
2241         $data->usercreated = $task->get_userid();
2242         $data->timemodified = $data->timecreated;
2243         $data->usermodified = $data->usercreated;
2245         $newid = $DB->insert_record('grading_definitions', $data);
2246         $this->set_mapping('grading_definition', $oldid, $newid, true);
2247     }
2249     /**
2250      * Processes one grading form instance element
2251      *
2252      * @param array $data element data
2253      */
2254     protected function process_grading_instance($data) {
2255         global $DB;
2257         $data = (object)$data;
2259         // new form definition id
2260         $newformid = $this->get_new_parentid('grading_definition');
2262         // get the name of the area we are restoring to
2263         $sql = "SELECT ga.areaname
2264                   FROM {grading_definitions} gd
2265                   JOIN {grading_areas} ga ON gd.areaid = ga.id
2266                  WHERE gd.id = ?";
2267         $areaname = $DB->get_field_sql($sql, array($newformid), MUST_EXIST);
2269         // get the mapped itemid - the activity module is expected to define the mappings
2270         // for each gradable area
2271         $newitemid = $this->get_mappingid(restore_gradingform_plugin::itemid_mapping($areaname), $data->itemid);
2273         $oldid = $data->id;
2274         $data->definitionid = $newformid;
2275         $data->raterid = $this->get_mappingid('user', $data->raterid);
2276         $data->itemid = $newitemid;
2278         $newid = $DB->insert_record('grading_instances', $data);
2279         $this->set_mapping('grading_instance', $oldid, $newid);
2280     }
2282     /**
2283      * Final operations when the database records are inserted
2284      */
2285     protected function after_execute() {
2286         // Add files embedded into the definition description
2287         $this->add_related_files('grading', 'description', 'grading_definition');
2288     }
2292 /**
2293  * This structure step restores the grade items associated with one activity
2294  * All the grade items are made child of the "course" grade item but the original
2295  * categoryid is saved as parentitemid in the backup_ids table, so, when restoring
2296  * the complete gradebook (categories and calculations), that information is
2297  * available there
2298  */
2299 class restore_activity_grades_structure_step extends restore_structure_step {
2301     protected function define_structure() {
2303         $paths = array();
2304         $userinfo = $this->get_setting_value('userinfo');
2306         $paths[] = new restore_path_element('grade_item', '/activity_gradebook/grade_items/grade_item');
2307         $paths[] = new restore_path_element('grade_letter', '/activity_gradebook/grade_letters/grade_letter');
2308         if ($userinfo) {
2309             $paths[] = new restore_path_element('grade_grade',
2310                            '/activity_gradebook/grade_items/grade_item/grade_grades/grade_grade');
2311         }
2312         return $paths;
2313     }
2315     protected function process_grade_item($data) {
2316         global $DB;
2318         $data = (object)($data);
2319         $oldid       = $data->id;        // We'll need these later
2320         $oldparentid = $data->categoryid;
2321         $courseid = $this->get_courseid();
2323         // make sure top course category exists, all grade items will be associated
2324         // to it. Later, if restoring the whole gradebook, categories will be introduced
2325         $coursecat = grade_category::fetch_course_category($courseid);
2326         $coursecatid = $coursecat->id; // Get the categoryid to be used
2328         $idnumber = null;
2329         if (!empty($data->idnumber)) {
2330             // Don't get any idnumber from course module. Keep them as they are in grade_item->idnumber
2331             // Reason: it's not clear what happens with outcomes->idnumber or activities with multiple items (workshop)
2332             // so the best is to keep the ones already in the gradebook
2333             // Potential problem: duplicates if same items are restored more than once. :-(
2334             // This needs to be fixed in some way (outcomes & activities with multiple items)
2335             // $data->idnumber     = get_coursemodule_from_instance($data->itemmodule, $data->iteminstance)->idnumber;
2336             // In any case, verify always for uniqueness
2337             $sql = "SELECT cm.id
2338                       FROM {course_modules} cm
2339                      WHERE cm.course = :courseid AND
2340                            cm.idnumber = :idnumber AND
2341                            cm.id <> :cmid";
2342             $params = array(
2343                 'courseid' => $courseid,
2344                 'idnumber' => $data->idnumber,
2345                 'cmid' => $this->task->get_moduleid()
2346             );
2347             if (!$DB->record_exists_sql($sql, $params) && !$DB->record_exists('grade_items', array('courseid' => $courseid, 'idnumber' => $data->idnumber))) {
2348                 $idnumber = $data->idnumber;
2349             }
2350         }
2352         unset($data->id);
2353         $data->categoryid   = $coursecatid;
2354         $data->courseid     = $this->get_courseid();
2355         $data->iteminstance = $this->task->get_activityid();
2356         $data->idnumber     = $idnumber;
2357         $data->scaleid      = $this->get_mappingid('scale', $data->scaleid);
2358         $data->outcomeid    = $this->get_mappingid('outcome', $data->outcomeid);
2359         $data->timecreated  = $this->apply_date_offset($data->timecreated);
2360         $data->timemodified = $this->apply_date_offset($data->timemodified);
2362         $gradeitem = new grade_item($data, false);
2363         $gradeitem->insert('restore');
2365         //sortorder is automatically assigned when inserting. Re-instate the previous sortorder
2366         $gradeitem->sortorder = $data->sortorder;
2367         $gradeitem->update('restore');
2369         // Set mapping, saving the original category id into parentitemid
2370         // gradebook restore (final task) will need it to reorganise items
2371         $this->set_mapping('grade_item', $oldid, $gradeitem->id, false, null, $oldparentid);
2372     }
2374     protected function process_grade_grade($data) {
2375         $data = (object)($data);
2377         unset($data->id);
2378         $data->itemid = $this->get_new_parentid('grade_item');
2379         $data->userid = $this->get_mappingid('user', $data->userid);
2380         $data->usermodified = $this->get_mappingid('user', $data->usermodified);
2381         $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
2382         // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
2383         $data->overridden = $this->apply_date_offset($data->overridden);
2385         $grade = new grade_grade($data, false);
2386         $grade->insert('restore');
2387         // no need to save any grade_grade mapping
2388     }
2390     /**
2391      * process activity grade_letters. Note that, while these are possible,
2392      * because grade_letters are contextid based, in proctice, only course
2393      * context letters can be defined. So we keep here this method knowing
2394      * it won't be executed ever. gradebook restore will restore course letters.
2395      */
2396     protected function process_grade_letter($data) {
2397         global $DB;
2399         $data = (object)$data;
2401         $data->contextid = $this->task->get_contextid();
2402         $newitemid = $DB->insert_record('grade_letters', $data);
2403         // no need to save any grade_letter mapping
2404     }
2408 /**
2409  * This structure steps restores one instance + positions of one block
2410  * Note: Positions corresponding to one existing context are restored
2411  * here, but all the ones having unknown contexts are sent to backup_ids
2412  * for a later chance to be restored at the end (final task)
2413  */
2414 class restore_block_instance_structure_step extends restore_structure_step {
2416     protected function define_structure() {
2418         $paths = array();
2420         $paths[] = new restore_path_element('block', '/block', true); // Get the whole XML together
2421         $paths[] = new restore_path_element('block_position', '/block/block_positions/block_position');
2423         return $paths;
2424     }
2426     public function process_block($data) {
2427         global $DB, $CFG;
2429         $data = (object)$data; // Handy
2430         $oldcontextid = $data->contextid;
2431         $oldid        = $data->id;
2432         $positions = isset($data->block_positions['block_position']) ? $data->block_positions['block_position'] : array();
2434         // Look for the parent contextid
2435         if (!$data->parentcontextid = $this->get_mappingid('context', $data->parentcontextid)) {
2436             throw new restore_step_exception('restore_block_missing_parent_ctx', $data->parentcontextid);
2437         }
2439         // TODO: it would be nice to use standard plugin supports instead of this instance_allow_multiple()
2440         // If there is already one block of that type in the parent context
2441         // and the block is not multiple, stop processing
2442         // Use blockslib loader / method executor
2443         if (!$bi = block_instance($data->blockname)) {
2444             return false;
2445         }
2447         if (!$bi->instance_allow_multiple()) {
2448             if ($DB->record_exists_sql("SELECT bi.id
2449                                           FROM {block_instances} bi
2450                                           JOIN {block} b ON b.name = bi.blockname
2451                                          WHERE bi.parentcontextid = ?
2452                                            AND bi.blockname = ?", array($data->parentcontextid, $data->blockname))) {
2453                 return false;
2454             }
2455         }
2457         // If there is already one block of that type in the parent context
2458         // with the same showincontexts, pagetypepattern, subpagepattern, defaultregion and configdata
2459         // stop processing
2460         $params = array(
2461             'blockname' => $data->blockname, 'parentcontextid' => $data->parentcontextid,
2462             'showinsubcontexts' => $data->showinsubcontexts, 'pagetypepattern' => $data->pagetypepattern,
2463             'subpagepattern' => $data->subpagepattern, 'defaultregion' => $data->defaultregion);
2464         if ($birecs = $DB->get_records('block_instances', $params)) {
2465             foreach($birecs as $birec) {
2466                 if ($birec->configdata == $data->configdata) {
2467                     return false;
2468                 }
2469             }
2470         }
2472         // Set task old contextid, blockid and blockname once we know them
2473         $this->task->set_old_contextid($oldcontextid);
2474         $this->task->set_old_blockid($oldid);
2475         $this->task->set_blockname($data->blockname);
2477         // Let's look for anything within configdata neededing processing
2478         // (nulls and uses of legacy file.php)
2479         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
2480             $configdata = (array)unserialize(base64_decode($data->configdata));
2481             foreach ($configdata as $attribute => $value) {
2482                 if (in_array($attribute, $attrstotransform)) {
2483                     $configdata[$attribute] = $this->contentprocessor->process_cdata($value);
2484                 }
2485             }
2486             $data->configdata = base64_encode(serialize((object)$configdata));
2487         }
2489         // Create the block instance
2490         $newitemid = $DB->insert_record('block_instances', $data);
2491         // Save the mapping (with restorefiles support)
2492         $this->set_mapping('block_instance', $oldid, $newitemid, true);
2493         // Create the block context
2494         $newcontextid = get_context_instance(CONTEXT_BLOCK, $newitemid)->id;
2495         // Save the block contexts mapping and sent it to task
2496         $this->set_mapping('context', $oldcontextid, $newcontextid);
2497         $this->task->set_contextid($newcontextid);
2498         $this->task->set_blockid($newitemid);
2500         // Restore block fileareas if declared
2501         $component = 'block_' . $this->task->get_blockname();
2502         foreach ($this->task->get_fileareas() as $filearea) { // Simple match by contextid. No itemname needed
2503             $this->add_related_files($component, $filearea, null);
2504         }
2506         // Process block positions, creating them or accumulating for final step
2507         foreach($positions as $position) {
2508             $position = (object)$position;
2509             $position->blockinstanceid = $newitemid; // The instance is always the restored one
2510             // If position is for one already mapped (known) contextid
2511             // process it now, creating the position
2512             if ($newpositionctxid = $this->get_mappingid('context', $position->contextid)) {
2513                 $position->contextid = $newpositionctxid;
2514                 // Create the block position
2515                 $DB->insert_record('block_positions', $position);
2517             // The position belongs to an unknown context, send it to backup_ids
2518             // to process them as part of the final steps of restore. We send the
2519             // whole $position object there, hence use the low level method.
2520             } else {
2521                 restore_dbops::set_backup_ids_record($this->get_restoreid(), 'block_position', $position->id, 0, null, $position);
2522             }
2523         }
2524     }
2527 /**
2528  * Structure step to restore common course_module information
2529  *
2530  * This step will process the module.xml file for one activity, in order to restore
2531  * the corresponding information to the course_modules table, skipping various bits
2532  * of information based on CFG settings (groupings, completion...) in order to fullfill
2533  * all the reqs to be able to create the context to be used by all the rest of steps
2534  * in the activity restore task
2535  */
2536 class restore_module_structure_step extends restore_structure_step {
2538     protected function define_structure() {
2539         global $CFG;
2541         $paths = array();
2543         $module = new restore_path_element('module', '/module');
2544         $paths[] = $module;
2545         if ($CFG->enableavailability) {
2546             $paths[] = new restore_path_element('availability', '/module/availability_info/availability');
2547         }
2549         // Apply for 'format' plugins optional paths at module level
2550         $this->add_plugin_structure('format', $module);
2552         // Apply for 'plagiarism' plugins optional paths at module level
2553         $this->add_plugin_structure('plagiarism', $module);
2555         return $paths;
2556     }
2558     protected function process_module($data) {
2559         global $CFG, $DB;
2561         $data = (object)$data;
2562         $oldid = $data->id;
2563         $oldsection = $data->sectionnumber;
2564         $this->task->set_old_moduleversion($data->version);
2566         $data->course = $this->task->get_courseid();
2567         $data->module = $DB->get_field('modules', 'id', array('name' => $data->modulename));
2568         // Map section (first try by course_section mapping match. Useful in course and section restores)
2569         $data->section = $this->get_mappingid('course_section', $data->sectionid);
2570         if (!$data->section) { // mapping failed, try to get section by sectionnumber matching
2571             $params = array(
2572                 'course' => $this->get_courseid(),
2573                 'section' => $data->sectionnumber);
2574             $data->section = $DB->get_field('course_sections', 'id', $params);
2575         }
2576         if (!$data->section) { // sectionnumber failed, try to get first section in course
2577             $params = array(
2578                 'course' => $this->get_courseid());
2579             $data->section = $DB->get_field('course_sections', 'MIN(id)', $params);
2580         }
2581         if (!$data->section) { // no sections in course, create section 0 and 1 and assign module to 1
2582             $sectionrec = array(
2583                 'course' => $this->get_courseid(),
2584                 'section' => 0);
2585             $DB->insert_record('course_sections', $sectionrec); // section 0
2586             $sectionrec = array(
2587                 'course' => $this->get_courseid(),
2588                 'section' => 1);
2589             $data->section = $DB->insert_record('course_sections', $sectionrec); // section 1
2590             $this->set_mapping('course_sectionnumber', $oldsection, 1); // Assign unmatching sections to section 1.
2591         }
2592         $data->groupingid= $this->get_mappingid('grouping', $data->groupingid);      // grouping
2593         if (!$CFG->enablegroupmembersonly) {                                         // observe groupsmemberonly
2594             $data->groupmembersonly = 0;
2595         }
2596         if (!grade_verify_idnumber($data->idnumber, $this->get_courseid())) {        // idnumber uniqueness
2597             $data->idnumber = '';
2598         }
2599         if (empty($CFG->enablecompletion)) { // completion
2600             $data->completion = 0;
2601             $data->completiongradeitemnumber = null;
2602             $data->completionview = 0;
2603             $data->completionexpected = 0;
2604         } else {
2605             $data->completionexpected = $this->apply_date_offset($data->completionexpected);
2606         }
2607         if (empty($CFG->enableavailability)) {
2608             $data->availablefrom = 0;
2609             $data->availableuntil = 0;
2610             $data->showavailability = 0;
2611         } else {
2612             $data->availablefrom = $this->apply_date_offset($data->availablefrom);
2613             $data->availableuntil= $this->apply_date_offset($data->availableuntil);
2614         }
2615         // Backups that did not include showdescription, set it to default 0
2616         // (this is not totally necessary as it has a db default, but just to
2617         // be explicit).
2618         if (!isset($data->showdescription)) {
2619             $data->showdescription = 0;
2620         }
2621         $data->instance = 0; // Set to 0 for now, going to create it soon (next step)
2623         // course_module record ready, insert it
2624         $newitemid = $DB->insert_record('course_modules', $data);
2625         // save mapping
2626         $this->set_mapping('course_module', $oldid, $newitemid);
2627         // set the new course_module id in the task
2628         $this->task->set_moduleid($newitemid);
2629         // we can now create the context safely
2630         $ctxid = get_context_instance(CONTEXT_MODULE, $newitemid)->id;
2631         // set the new context id in the task
2632         $this->task->set_contextid($ctxid);
2633         // update sequence field in course_section
2634         if ($sequence = $DB->get_field('course_sections', 'sequence', array('id' => $data->section))) {
2635             $sequence .= ',' . $newitemid;
2636         } else {
2637             $sequence = $newitemid;
2638         }
2639         $DB->set_field('course_sections', 'sequence', $sequence, array('id' => $data->section));
2640     }
2643     protected function process_availability($data) {
2644         $data = (object)$data;
2645         // Simply going to store the whole availability record now, we'll process
2646         // all them later in the final task (once all actvivities have been restored)
2647         // Let's call the low level one to be able to store the whole object
2648         $data->coursemoduleid = $this->task->get_moduleid(); // Let add the availability cmid
2649         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'module_availability', $data->id, 0, null, $data);
2650     }
2653 /**
2654  * Structure step that will process the user activity completion
2655  * information if all these conditions are met:
2656  *  - Target site has completion enabled ($CFG->enablecompletion)
2657  *  - Activity includes completion info (file_exists)
2658  */
2659 class restore_userscompletion_structure_step extends restore_structure_step {
2660     /**
2661      * To conditionally decide if this step must be executed
2662      * Note the "settings" conditions are evaluated in the
2663      * corresponding task. Here we check for other conditions
2664      * not being restore settings (files, site settings...)
2665      */
2666      protected function execute_condition() {
2667          global $CFG;
2669          // Completion disabled in this site, don't execute
2670          if (empty($CFG->enablecompletion)) {
2671              return false;
2672          }
2674          // No user completion info found, don't execute
2675         $fullpath = $this->task->get_taskbasepath();
2676         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2677          if (!file_exists($fullpath)) {
2678              return false;
2679          }
2681          // Arrived here, execute the step
2682          return true;
2683      }
2685      protected function define_structure() {
2687         $paths = array();
2689         $paths[] = new restore_path_element('completion', '/completions/completion');
2691         return $paths;
2692     }
2694     protected function process_completion($data) {
2695         global $DB;
2697         $data = (object)$data;
2699         $data->coursemoduleid = $this->task->get_moduleid();
2700         $data->userid = $this->get_mappingid('user', $data->userid);
2701         $data->timemodified = $this->apply_date_offset($data->timemodified);
2703         // Find the existing record
2704         $existing = $DB->get_record('course_modules_completion', array(
2705                 'coursemoduleid' => $data->coursemoduleid,
2706                 'userid' => $data->userid), 'id, timemodified');
2707         // Check we didn't already insert one for this cmid and userid
2708         // (there aren't supposed to be duplicates in that field, but
2709         // it was possible until MDL-28021 was fixed).
2710         if ($existing) {
2711             // Update it to these new values, but only if the time is newer
2712             if ($existing->timemodified < $data->timemodified) {
2713                 $data->id = $existing->id;
2714                 $DB->update_record('course_modules_completion', $data);
2715             }
2716         } else {
2717             // Normal entry where it doesn't exist already
2718             $DB->insert_record('course_modules_completion', $data);
2719         }
2720     }
2723 /**
2724  * Abstract structure step, parent of all the activity structure steps. Used to suuport
2725  * the main <activity ...> tag and process it. Also provides subplugin support for
2726  * activities.
2727  */
2728 abstract class restore_activity_structure_step extends restore_structure_step {
2730     protected function add_subplugin_structure($subplugintype, $element) {
2732         global $CFG;
2734         // Check the requested subplugintype is a valid one
2735         $subpluginsfile = $CFG->dirroot . '/mod/' . $this->task->get_modulename() . '/db/subplugins.php';
2736         if (!file_exists($subpluginsfile)) {
2737              throw new restore_step_exception('activity_missing_subplugins_php_file', $this->task->get_modulename());
2738         }
2739         include($subpluginsfile);
2740         if (!array_key_exists($subplugintype, $subplugins)) {
2741              throw new restore_step_exception('incorrect_subplugin_type', $subplugintype);
2742         }
2743         // Get all the restore path elements, looking across all the subplugin dirs
2744         $subpluginsdirs = get_plugin_list($subplugintype);
2745         foreach ($subpluginsdirs as $name => $subpluginsdir) {
2746             $classname = 'restore_' . $subplugintype . '_' . $name . '_subplugin';
2747             $restorefile = $subpluginsdir . '/backup/moodle2/' . $classname . '.class.php';
2748             if (file_exists($restorefile)) {
2749                 require_once($restorefile);
2750                 $restoresubplugin = new $classname($subplugintype, $name, $this);
2751                 // Add subplugin paths to the step
2752                 $this->prepare_pathelements($restoresubplugin->define_subplugin_structure($element));
2753             }
2754         }
2755     }
2757     /**
2758      * As far as activity restore steps are implementing restore_subplugin stuff, they need to
2759      * have the parent task available for wrapping purposes (get course/context....)
2760      * @return restore_task
2761      */
2762     public function get_task() {
2763         return $this->task;
2764     }
2766     /**
2767      * Adds support for the 'activity' path that is common to all the activities
2768      * and will be processed globally here
2769      */
2770     protected function prepare_activity_structure($paths) {
2772         $paths[] = new restore_path_element('activity', '/activity');
2774         return $paths;
2775     }
2777     /**
2778      * Process the activity path, informing the task about various ids, needed later
2779      */
2780     protected function process_activity($data) {
2781         $data = (object)$data;
2782         $this->task->set_old_contextid($data->contextid); // Save old contextid in task
2783         $this->set_mapping('context', $data->contextid, $this->task->get_contextid()); // Set the mapping
2784         $this->task->set_old_activityid($data->id); // Save old activityid in task
2785     }
2787     /**
2788      * This must be invoked immediately after creating the "module" activity record (forum, choice...)
2789      * and will adjust the new activity id (the instance) in various places
2790      */
2791     protected function apply_activity_instance($newitemid) {
2792         global $DB;
2794         $this->task->set_activityid($newitemid); // Save activity id in task
2795         // Apply the id to course_sections->instanceid
2796         $DB->set_field('course_modules', 'instance', $newitemid, array('id' => $this->task->get_moduleid()));
2797         // Do the mapping for modulename, preparing it for files by oldcontext
2798         $modulename = $this->task->get_modulename();
2799         $oldid = $this->task->get_old_activityid();
2800         $this->set_mapping($modulename, $oldid, $newitemid, true);
2801     }
2804 /**
2805  * Structure step in charge of creating/mapping all the qcats and qs
2806  * by parsing the questions.xml file and checking it against the
2807  * results calculated by {@link restore_process_categories_and_questions}
2808  * and stored in backup_ids_temp
2809  */
2810 class restore_create_categories_and_questions extends restore_structure_step {
2812     protected function define_structure() {
2814         $category = new restore_path_element('question_category', '/question_categories/question_category');
2815         $question = new restore_path_element('question', '/question_categories/question_category/questions/question');
2816         $hint = new restore_path_element('question_hint',
2817                 '/question_categories/question_category/questions/question/question_hints/question_hint');
2819         // Apply for 'qtype' plugins optional paths at question level
2820         $this->add_plugin_structure('qtype', $question);
2822         return array($category, $question, $hint);
2823     }
2825     protected function process_question_category($data) {
2826         global $DB;
2828         $data = (object)$data;
2829         $oldid = $data->id;
2831         // Check we have one mapping for this category
2832         if (!$mapping = $this->get_mapping('question_category', $oldid)) {
2833             return self::SKIP_ALL_CHILDREN; // No mapping = this category doesn't need to be created/mapped
2834         }
2836         // Check we have to create the category (newitemid = 0)
2837         if ($mapping->newitemid) {
2838             return; // newitemid != 0, this category is going to be mapped. Nothing to do
2839         }
2841         // Arrived here, newitemid = 0, we need to create the category
2842         // we'll do it at parentitemid context, but for CONTEXT_MODULE
2843         // categories, that will be created at CONTEXT_COURSE and moved
2844         // to module context later when the activity is created
2845         if ($mapping->info->contextlevel == CONTEXT_MODULE) {
2846             $mapping->parentitemid = $this->get_mappingid('context', $this->task->get_old_contextid());
2847         }
2848         $data->contextid = $mapping->parentitemid;
2850         // Let's create the question_category and save mapping
2851         $newitemid = $DB->insert_record('question_categories', $data);
2852         $this->set_mapping('question_category', $oldid, $newitemid);
2853         // Also annotate them as question_category_created, we need
2854         // that later when remapping parents
2855         $this->set_mapping('question_category_created', $oldid, $newitemid, false, null, $data->contextid);
2856     }
2858     protected function process_question($data) {
2859         global $DB;
2861         $data = (object)$data;
2862         $oldid = $data->id;
2864         // Check we have one mapping for this question
2865         if (!$questionmapping = $this->get_mapping('question', $oldid)) {
2866             return; // No mapping = this question doesn't need to be created/mapped
2867         }
2869         // Get the mapped category (cannot use get_new_parentid() because not
2870         // all the categories have been created, so it is not always available
2871         // Instead we get the mapping for the question->parentitemid because
2872         // we have loaded qcatids there for all parsed questions
2873         $data->category = $this->get_mappingid('question_category', $questionmapping->parentitemid);
2875         // In the past, there were some very sloppy values of penalty. Fix them.
2876         if ($data->penalty >= 0.33 && $data->penalty <= 0.34) {
2877             $data->penalty = 0.3333333;
2878         }
2879         if ($data->penalty >= 0.66 && $data->penalty <= 0.67) {
2880             $data->penalty = 0.6666667;
2881         }
2882         if ($data->penalty >= 1) {
2883             $data->penalty = 1;
2884         }
2886         $data->timecreated  = $this->apply_date_offset($data->timecreated);
2887         $data->timemodified = $this->apply_date_offset($data->timemodified);
2889         $userid = $this->get_mappingid('user', $data->createdby);
2890         $data->createdby = $userid ? $userid : $this->task->get_userid();
2892         $userid = $this->get_mappingid('user', $data->modifiedby);
2893         $data->modifiedby = $userid ? $userid : $this->task->get_userid();
2895         // With newitemid = 0, let's create the question
2896         if (!$questionmapping->newitemid) {
2897             $newitemid = $DB->insert_record('question', $data);
2898             $this->set_mapping('question', $oldid, $newitemid);
2899             // Also annotate them as question_created, we need
2900             // that later when remapping parents (keeping the old categoryid as parentid)
2901             $this->set_mapping('question_created', $oldid, $newitemid, false, null, $questionmapping->parentitemid);
2902         } else {
2903             // By performing this set_mapping() we make get_old/new_parentid() to work for all the
2904             // children elements of the 'question' one (so qtype plugins will know the question they belong to)
2905             $this->set_mapping('question', $oldid, $questionmapping->newitemid);
2906         }
2908         // Note, we don't restore any question files yet
2909         // as far as the CONTEXT_MODULE categories still
2910         // haven't their contexts to be restored to
2911         // The {@link restore_create_question_files}, executed in the final step
2912         // step will be in charge of restoring all the question files
2913     }
2915         protected function process_question_hint($data) {
2916         global $DB;
2918         $data = (object)$data;
2919         $oldid = $data->id;
2921         // Detect if the question is created or mapped
2922         $oldquestionid   = $this->get_old_parentid('question');
2923         $newquestionid   = $this->get_new_parentid('question');
2924         $questioncreated = $this->get_mappingid('question_created', $oldquestionid) ? true : false;
2926         // If the question has been created by restore, we need to create its question_answers too
2927         if ($questioncreated) {
2928             // Adjust some columns
2929             $data->questionid = $newquestionid;
2930             // Insert record
2931             $newitemid = $DB->insert_record('question_hints', $data);
2933         // The question existed, we need to map the existing question_hints
2934         } else {
2935             // Look in question_hints by hint text matching
2936             $sql = 'SELECT id
2937                       FROM {question_hints}
2938                      WHERE questionid = ?
2939                        AND ' . $DB->sql_compare_text('hint', 255) . ' = ' . $DB->sql_compare_text('?', 255);
2940             $params = array($newquestionid, $data->hint);
2941             $newitemid = $DB->get_field_sql($sql, $params);
2942             // If we haven't found the newitemid, something has gone really wrong, question in DB
2943             // is missing hints, exception
2944             if (!$newitemid) {
2945                 $info = new stdClass();
2946                 $info->filequestionid = $oldquestionid;
2947                 $info->dbquestionid   = $newquestionid;
2948                 $info->hint           = $data->hint;
2949                 throw new restore_step_exception('error_question_hint_missing_in_db', $info);
2950             }
2951         }
2952         // Create mapping (I'm not sure if this is really needed?)
2953         $this->set_mapping('question_hint', $oldid, $newitemid);
2954     }
2956     protected function after_execute() {
2957         global $DB;
2959         // First of all, recode all the created question_categories->parent fields
2960         $qcats = $DB->get_records('backup_ids_temp', array(
2961                      'backupid' => $this->get_restoreid(),
2962                      'itemname' => 'question_category_created'));
2963         foreach ($qcats as $qcat) {
2964             $newparent = 0;
2965             $dbcat = $DB->get_record('question_categories', array('id' => $qcat->newitemid));
2966             // Get new parent (mapped or created, so we look in quesiton_category mappings)
2967             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
2968                                  'backupid' => $this->get_restoreid(),
2969                                  'itemname' => 'question_category',
2970                                  'itemid'   => $dbcat->parent))) {
2971                 // contextids must match always, as far as we always include complete qbanks, just check it
2972                 $newparentctxid = $DB->get_field('question_categories', 'contextid', array('id' => $newparent));
2973                 if ($dbcat->contextid == $newparentctxid) {
2974                     $DB->set_field('question_categories', 'parent', $newparent, array('id' => $dbcat->id));
2975                 } else {
2976                     $newparent = 0; // No ctx match for both cats, no parent relationship
2977                 }
2978             }
2979             // Here with $newparent empty, problem with contexts or remapping, set it to top cat
2980             if (!$newparent) {
2981                 $DB->set_field('question_categories', 'parent', 0, array('id' => $dbcat->id));
2982             }
2983         }
2985         // Now, recode all the created question->parent fields
2986         $qs = $DB->get_records('backup_ids_temp', array(
2987                   'backupid' => $this->get_restoreid(),
2988                   'itemname' => 'question_created'));
2989         foreach ($qs as $q) {
2990             $newparent = 0;
2991             $dbq = $DB->get_record('question', array('id' => $q->newitemid));
2992             // Get new parent (mapped or created, so we look in question mappings)
2993             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
2994                                  'backupid' => $this->get_restoreid(),
2995                                  'itemname' => 'question',
2996                                  'itemid'   => $dbq->parent))) {
2997                 $DB->set_field('question', 'parent', $newparent, array('id' => $dbq->id));
2998             }
2999         }
3001         // Note, we don't restore any question files yet
3002         // as far as the CONTEXT_MODULE categories still
3003         // haven't their contexts to be restored to
3004         // The {@link restore_create_question_files}, executed in the final step
3005         // step will be in charge of restoring all the question files
3006     }
3009 /**
3010  * Execution step that will move all the CONTEXT_MODULE question categories
3011  * created at early stages of restore in course context (because modules weren't
3012  * created yet) to their target module (matching by old-new-contextid mapping)
3013  */
3014 class restore_move_module_questions_categories extends restore_execution_step {
3016     protected function define_execution() {
3017         global $DB;
3019         $contexts = restore_dbops::restore_get_question_banks($this->get_restoreid(), CONTEXT_MODULE);
3020         foreach ($contexts as $contextid => $contextlevel) {
3021             // Only if context mapping exists (i.e. the module has been restored)
3022             if ($newcontext = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $contextid)) {
3023                 // Update all the qcats having their parentitemid set to the original contextid
3024                 $modulecats = $DB->get_records_sql("SELECT itemid, newitemid
3025                                                       FROM {backup_ids_temp}
3026                                                      WHERE backupid = ?
3027                                                        AND itemname = 'question_category'
3028                                                        AND parentitemid = ?", array($this->get_restoreid(), $contextid));
3029                 foreach ($modulecats as $modulecat) {
3030                     $DB->set_field('question_categories', 'contextid', $newcontext->newitemid, array('id' => $modulecat->newitemid));
3031                     // And set new contextid also in question_category mapping (will be
3032                     // used by {@link restore_create_question_files} later
3033                     restore_dbops::set_backup_ids_record($this->get_restoreid(), 'question_category', $modulecat->itemid, $modulecat->newitemid, $newcontext->newitemid);
3034                 }
3035             }
3036         }
3037     }
3040 /**
3041  * Execution step that will create all the question/answers/qtype-specific files for the restored
3042  * questions. It must be executed after {@link restore_move_module_questions_categories}
3043  * because only then each question is in its final category and only then the
3044  * context can be determined
3045  *
3046  * TODO: Improve this. Instead of looping over each question, it can be reduced to
3047  *       be done by contexts (this will save a huge ammount of queries)
3048  */
3049 class restore_create_question_files extends restore_execution_step {
3051     protected function define_execution() {
3052         global $DB;
3054         // Let's process only created questions
3055         $questionsrs = $DB->get_recordset_sql("SELECT bi.itemid, bi.newitemid, bi.parentitemid, q.qtype
3056                                                FROM {backup_ids_temp} bi
3057                                                JOIN {question} q ON q.id = bi.newitemid
3058                                               WHERE bi.backupid = ?
3059                                                 AND bi.itemname = 'question_created'", array($this->get_restoreid()));
3060         foreach ($questionsrs as $question) {
3061             // Get question_category mapping, it contains the target context for the question
3062             if (!$qcatmapping = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'question_category', $question->parentitemid)) {
3063                 // Something went really wrong, cannot find the question_category for the question
3064                 debugging('Error fetching target context for question', DEBUG_DEVELOPER);
3065                 continue;
3066             }
3067             // Calculate source and target contexts
3068             $oldctxid = $qcatmapping->info->contextid;
3069             $newctxid = $qcatmapping->parentitemid;
3071             // Add common question files (question and question_answer ones)
3072             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'questiontext',
3073                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3074             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'generalfeedback',
3075                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3076             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'answer',
3077                                               $oldctxid, $this->task->get_userid(), 'question_answer', null, $newctxid, true);
3078             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'answerfeedback',
3079                                               $oldctxid, $this->task->get_userid(), 'question_answer', null, $newctxid, true);
3080             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'hint',
3081                                               $oldctxid, $this->task->get_userid(), 'question_hint', null, $newctxid, true);
3082             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'correctfeedback',
3083                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3084             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'partiallycorrectfeedback',
3085                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3086             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'incorrectfeedback',
3087                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
3088             // Add qtype dependent files
3089             $components = backup_qtype_plugin::get_components_and_fileareas($question->qtype);
3090             foreach ($components as $component => $fileareas) {
3091                 foreach ($fileareas as $filearea => $mapping) {
3092                     // Use itemid only if mapping is question_created
3093                     $itemid = ($mapping == 'question_created') ? $question->itemid : null;
3094                     restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), $component, $filearea,
3095                                                       $oldctxid, $this->task->get_userid(), $mapping, $itemid, $newctxid, true);
3096                 }
3097             }
3098         }
3099         $questionsrs->close();
3100     }
3103 /**
3104  * Abstract structure step, to be used by all the activities using core questions stuff
3105  * (like the quiz module), to support qtype plugins, states and sessions
3106  */
3107 abstract class restore_questions_activity_structure_step extends restore_activity_structure_step {
3108     /** @var array question_attempt->id to qtype. */
3109     protected $qtypes = array();
3110     /** @var array question_attempt->id to questionid. */
3111     protected $newquestionids = array();
3113     /**
3114      * Attach below $element (usually attempts) the needed restore_path_elements
3115      * to restore question_usages and all they contain.
3116      */
3117     protected function add_question_usages($element, &$paths) {
3118         // Check $element is restore_path_element
3119         if (! $element instanceof restore_path_element) {
3120             throw new restore_step_exception('element_must_be_restore_path_element', $element);
3121         }
3122         // Check $paths is one array
3123         if (!is_array($paths)) {
3124             throw new restore_step_exception('paths_must_be_array', $paths);
3125         }
3126         $paths[] = new restore_path_element('question_usage',
3127                 $element->get_path() . '/question_usage');
3128         $paths[] = new restore_path_element('question_attempt',
3129                 $element->get_path() . '/question_usage/question_attempts/question_attempt');
3130         $paths[] = new restore_path_element('question_attempt_step',
3131                 $element->get_path() . '/question_usage/question_attempts/question_attempt/steps/step',
3132                 true);
3133         $paths[] = new restore_path_element('question_attempt_step_data',
3134                 $element->get_path() . '/question_usage/question_attempts/question_attempt/steps/step/response/variable');
3135     }
3137     /**
3138      * Process question_usages
3139      */
3140     protected function process_question_usage($data) {
3141         global $DB;
3143         // Clear our caches.
3144         $this->qtypes = array();
3145         $this->newquestionids = array();
3147         $data = (object)$data;
3148         $oldid = $data->id;
3150         $oldcontextid = $this->get_task()->get_old_contextid();
3151         $data->contextid  = $this->get_mappingid('context', $this->task->get_old_contextid());
3153         // Everything ready, insert (no mapping needed)
3154         $newitemid = $DB->insert_record('question_usages', $data);
3156         $this->inform_new_usage_id($newitemid);
3158         $this->set_mapping('question_usage', $oldid, $newitemid, false);
3159     }
3161     /**
3162      * When process_question_usage creates the new usage, it calls this method
3163      * to let the activity link to the new usage. For example, the quiz uses
3164      * this method to set quiz_attempts.uniqueid to the new usage id.
3165      * @param integer $newusageid
3166      */
3167     abstract protected function inform_new_usage_id($newusageid);
3169     /**
3170      * Process question_attempts
3171      */
3172     protected function process_question_attempt($data) {
3173         global $DB;
3175         $data = (object)$data;
3176         $oldid = $data->id;
3177         $question = $this->get_mapping('question', $data->questionid);
3179         $data->questionusageid = $this->get_new_parentid('question_usage');
3180         $data->questionid      = $question->newitemid;
3181         $data->timemodified    = $this->apply_date_offset($data->timemodified);
3183         $newitemid = $DB->insert_record('question_attempts', $data);
3185         $this->set_mapping('question_attempt', $oldid, $newitemid);
3186         $this->qtypes[$newitemid] = $question->info->qtype;
3187         $this->newquestionids[$newitemid] = $data->questionid;
3188     }
3190     /**
3191      * Process question_attempt_steps
3192      */
3193     protected function process_question_attempt_step($data) {
3194         global $DB;
3196         $data = (object)$data;
3197         $oldid = $data->id;
3199         // Pull out the response data.
3200         $response = array();
3201         if (!empty($data->response['variable'])) {
3202             foreach ($data->response['variable'] as $variable) {
3203                 $response[$variable['name']] = $variable['value'];
3204             }
3205         }
3206         unset($data->response);
3208         $data->questionattemptid = $this->get_new_parentid('question_attempt');
3209         $data->timecreated = $this->apply_date_offset($data->timecreated);
3210         $data->userid      = $this->get_mappingid('user', $data->userid);
3212         // Everything ready, insert and create mapping (needed by question_sessions)
3213         $newitemid = $DB->insert_record('question_attempt_steps', $data);
3214         $this->set_mapping('question_attempt_step', $oldid, $newitemid, true);
3216         // Now process the response data.
3217         $response = $this->questions_recode_response_data(
3218                 $this->qtypes[$data->questionattemptid],
3219                 $this->newquestionids[$data->questionattemptid],
3220                 $data->sequencenumber, $response);
3221         foreach ($response as $name => $value) {
3222             $row = new stdClass();
3223             $row->attemptstepid = $newitemid;
3224             $row->name = $name;
3225             $row->value = $value;
3226             $DB->insert_record('question_attempt_step_data', $row, false);
3227         }
3228     }
3230     /**
3231      * Recode the respones data for a particular step of an attempt at at particular question.
3232      * @param string $qtype the question type.
3233      * @param int $newquestionid the question id.
3234      * @param int $sequencenumber the sequence number.
3235      * @param array $response the response data to recode.
3236      */
3237     public function questions_recode_response_data(
3238             $qtype, $newquestionid, $sequencenumber, array $response) {
3239         $qtyperestorer = $this->get_qtype_restorer($qtype);
3240         if ($qtyperestorer) {
3241             $response = $qtyperestorer->recode_response($newquestionid, $sequencenumber, $response);
3242         }
3243         return $response;
3244     }