Merge branch 'MDL-30182' of git://github.com/timhunt/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  * @package moodlecore
20  * @subpackage backup-moodle2
21  * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 /**
26  * Define all the restore steps that will be used by common tasks in restore
27  */
29 /**
30  * delete old directories and conditionally create backup_temp_ids table
31  */
32 class restore_create_and_clean_temp_stuff extends restore_execution_step {
34     protected function define_execution() {
35         $exists = restore_controller_dbops::create_restore_temp_tables($this->get_restoreid()); // temp tables conditionally
36         // If the table already exists, it's because restore_prechecks have been executed in the same
37         // request (without problems) and it already contains a bunch of preloaded information (users...)
38         // that we aren't going to execute again
39         if ($exists) { // Inform plan about preloaded information
40             $this->task->set_preloaded_information();
41         }
42         // Create the old-course-ctxid to new-course-ctxid mapping, we need that available since the beginning
43         $itemid = $this->task->get_old_contextid();
44         $newitemid = get_context_instance(CONTEXT_COURSE, $this->get_courseid())->id;
45         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'context', $itemid, $newitemid);
46         // Create the old-system-ctxid to new-system-ctxid mapping, we need that available since the beginning
47         $itemid = $this->task->get_old_system_contextid();
48         $newitemid = get_context_instance(CONTEXT_SYSTEM)->id;
49         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'context', $itemid, $newitemid);
50         // Create the old-course-id to new-course-id mapping, we need that available since the beginning
51         $itemid = $this->task->get_old_courseid();
52         $newitemid = $this->get_courseid();
53         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'course', $itemid, $newitemid);
55     }
56 }
58 /**
59  * delete the temp dir used by backup/restore (conditionally),
60  * delete old directories and drop temp ids table
61  */
62 class restore_drop_and_clean_temp_stuff extends restore_execution_step {
64     protected function define_execution() {
65         global $CFG;
66         restore_controller_dbops::drop_restore_temp_tables($this->get_restoreid()); // Drop ids temp table
67         backup_helper::delete_old_backup_dirs(time() - (4 * 60 * 60));              // Delete > 4 hours temp dirs
68         if (empty($CFG->keeptempdirectoriesonbackup)) { // Conditionally
69             backup_helper::delete_backup_dir($this->task->get_tempdir()); // Empty restore dir
70         }
71     }
72 }
74 /**
75  * Restore calculated grade items, grade categories etc
76  */
77 class restore_gradebook_structure_step extends restore_structure_step {
79     /**
80      * To conditionally decide if this step must be executed
81      * Note the "settings" conditions are evaluated in the
82      * corresponding task. Here we check for other conditions
83      * not being restore settings (files, site settings...)
84      */
85      protected function execute_condition() {
86         global $CFG, $DB;
88         // No gradebook info found, don't execute
89         $fullpath = $this->task->get_taskbasepath();
90         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
91         if (!file_exists($fullpath)) {
92             return false;
93         }
95         // Some module present in backup file isn't available to restore
96         // in this site, don't execute
97         if ($this->task->is_missing_modules()) {
98             return false;
99         }
101         // Some activity has been excluded to be restored, don't execute
102         if ($this->task->is_excluding_activities()) {
103             return false;
104         }
106         // There should only be one grade category (the 1 associated with the course itself)
107         // If other categories already exist we're restoring into an existing course.
108         // Restoring categories into a course with an existing category structure is unlikely to go well
109         $category = new stdclass();
110         $category->courseid  = $this->get_courseid();
111         $catcount = $DB->count_records('grade_categories', (array)$category);
112         if ($catcount>1) {
113             return false;
114         }
116         // Arrived here, execute the step
117         return true;
118      }
120     protected function define_structure() {
121         $paths = array();
122         $userinfo = $this->task->get_setting_value('users');
124         $paths[] = new restore_path_element('gradebook', '/gradebook');
125         $paths[] = new restore_path_element('grade_category', '/gradebook/grade_categories/grade_category');
126         $paths[] = new restore_path_element('grade_item', '/gradebook/grade_items/grade_item');
127         if ($userinfo) {
128             $paths[] = new restore_path_element('grade_grade', '/gradebook/grade_items/grade_item/grade_grades/grade_grade');
129         }
130         $paths[] = new restore_path_element('grade_letter', '/gradebook/grade_letters/grade_letter');
131         $paths[] = new restore_path_element('grade_setting', '/gradebook/grade_settings/grade_setting');
133         return $paths;
134     }
136     protected function process_gradebook($data) {
137     }
139     protected function process_grade_item($data) {
140         global $DB;
142         $data = (object)$data;
144         $oldid = $data->id;
145         $data->course = $this->get_courseid();
147         $data->courseid = $this->get_courseid();
149         if ($data->itemtype=='manual') {
150             // manual grade items store category id in categoryid
151             $data->categoryid = $this->get_mappingid('grade_category', $data->categoryid, NULL);
152         } else if ($data->itemtype=='course') {
153             // course grade item stores their category id in iteminstance
154             $coursecat = grade_category::fetch_course_category($this->get_courseid());
155             $data->iteminstance = $coursecat->id;
156         } else if ($data->itemtype=='category') {
157             // category grade items store their category id in iteminstance
158             $data->iteminstance = $this->get_mappingid('grade_category', $data->iteminstance, NULL);
159         } else {
160             throw new restore_step_exception('unexpected_grade_item_type', $data->itemtype);
161         }
163         $data->scaleid   = $this->get_mappingid('scale', $data->scaleid, NULL);
164         $data->outcomeid = $this->get_mappingid('outcome', $data->outcomeid, NULL);
166         $data->locktime     = $this->apply_date_offset($data->locktime);
167         $data->timecreated  = $this->apply_date_offset($data->timecreated);
168         $data->timemodified = $this->apply_date_offset($data->timemodified);
170         $coursecategory = $newitemid = null;
171         //course grade item should already exist so updating instead of inserting
172         if($data->itemtype=='course') {
173             //get the ID of the already created grade item
174             $gi = new stdclass();
175             $gi->courseid  = $this->get_courseid();
176             $gi->itemtype  = $data->itemtype;
178             //need to get the id of the grade_category that was automatically created for the course
179             $category = new stdclass();
180             $category->courseid  = $this->get_courseid();
181             $category->parent  = null;
182             //course category fullname starts out as ? but may be edited
183             //$category->fullname  = '?';
184             $coursecategory = $DB->get_record('grade_categories', (array)$category);
185             $gi->iteminstance = $coursecategory->id;
187             $existinggradeitem = $DB->get_record('grade_items', (array)$gi);
188             if (!empty($existinggradeitem)) {
189                 $data->id = $newitemid = $existinggradeitem->id;
190                 $DB->update_record('grade_items', $data);
191             }
192         }
194         if (empty($newitemid)) {
195             //in case we found the course category but still need to insert the course grade item
196             if ($data->itemtype=='course' && !empty($coursecategory)) {
197                 $data->iteminstance = $coursecategory->id;
198             }
200             $newitemid = $DB->insert_record('grade_items', $data);
201         }
202         $this->set_mapping('grade_item', $oldid, $newitemid);
203     }
205     protected function process_grade_grade($data) {
206         global $DB;
208         $data = (object)$data;
209         $oldid = $data->id;
211         $data->itemid = $this->get_new_parentid('grade_item');
213         $data->userid = $this->get_mappingid('user', $data->userid, NULL);
214         $data->usermodified = $this->get_mappingid('user', $data->usermodified, NULL);
215         $data->locktime     = $this->apply_date_offset($data->locktime);
216         // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
217         $data->overridden = $this->apply_date_offset($data->overridden);
218         $data->timecreated  = $this->apply_date_offset($data->timecreated);
219         $data->timemodified = $this->apply_date_offset($data->timemodified);
221         $newitemid = $DB->insert_record('grade_grades', $data);
222         //$this->set_mapping('grade_grade', $oldid, $newitemid);
223     }
224     protected function process_grade_category($data) {
225         global $DB;
227         $data = (object)$data;
228         $oldid = $data->id;
230         $data->course = $this->get_courseid();
231         $data->courseid = $data->course;
233         $data->timecreated  = $this->apply_date_offset($data->timecreated);
234         $data->timemodified = $this->apply_date_offset($data->timemodified);
236         $newitemid = null;
237         //no parent means a course level grade category. That may have been created when the course was created
238         if(empty($data->parent)) {
239             //parent was being saved as 0 when it should be null
240             $data->parent = null;
242             //get the already created course level grade category
243             $category = new stdclass();
244             $category->courseid = $this->get_courseid();
245             $category->parent = null;
247             $coursecategory = $DB->get_record('grade_categories', (array)$category);
248             if (!empty($coursecategory)) {
249                 $data->id = $newitemid = $coursecategory->id;
250                 $DB->update_record('grade_categories', $data);
251             }
252         }
254         //need to insert a course category
255         if (empty($newitemid)) {
256             $newitemid = $DB->insert_record('grade_categories', $data);
257         }
258         $this->set_mapping('grade_category', $oldid, $newitemid);
259     }
260     protected function process_grade_letter($data) {
261         global $DB;
263         $data = (object)$data;
264         $oldid = $data->id;
266         $data->contextid = get_context_instance(CONTEXT_COURSE, $this->get_courseid())->id;
268         $newitemid = $DB->insert_record('grade_letters', $data);
269         $this->set_mapping('grade_letter', $oldid, $newitemid);
270     }
271     protected function process_grade_setting($data) {
272         global $DB;
274         $data = (object)$data;
275         $oldid = $data->id;
277         $data->courseid = $this->get_courseid();
279         $newitemid = $DB->insert_record('grade_settings', $data);
280         //$this->set_mapping('grade_setting', $oldid, $newitemid);
281     }
283     /**
284      * put all activity grade items in the correct grade category and mark all for recalculation
285      */
286     protected function after_execute() {
287         global $DB;
289         $conditions = array(
290             'backupid' => $this->get_restoreid(),
291             'itemname' => 'grade_item'//,
292             //'itemid'   => $itemid
293         );
294         $rs = $DB->get_recordset('backup_ids_temp', $conditions);
296         // We need this for calculation magic later on.
297         $mappings = array();
299         if (!empty($rs)) {
300             foreach($rs as $grade_item_backup) {
302                 // Store the oldid with the new id.
303                 $mappings[$grade_item_backup->itemid] = $grade_item_backup->newitemid;
305                 $updateobj = new stdclass();
306                 $updateobj->id = $grade_item_backup->newitemid;
308                 //if this is an activity grade item that needs to be put back in its correct category
309                 if (!empty($grade_item_backup->parentitemid)) {
310                     $oldcategoryid = $this->get_mappingid('grade_category', $grade_item_backup->parentitemid, null);
311                     if (!is_null($oldcategoryid)) {
312                         $updateobj->categoryid = $oldcategoryid;
313                         $DB->update_record('grade_items', $updateobj);
314                     }
315                 } else {
316                     //mark course and category items as needing to be recalculated
317                     $updateobj->needsupdate=1;
318                     $DB->update_record('grade_items', $updateobj);
319                 }
320             }
321         }
322         $rs->close();
324         // We need to update the calculations for calculated grade items that may reference old
325         // grade item ids using ##gi\d+##.
326         // $mappings can be empty, use 0 if so (won't match ever)
327         list($sql, $params) = $DB->get_in_or_equal(array_values($mappings), SQL_PARAMS_NAMED, 'param', true, 0);
328         $sql = "SELECT gi.id, gi.calculation
329                   FROM {grade_items} gi
330                  WHERE gi.id {$sql} AND
331                        calculation IS NOT NULL";
332         $rs = $DB->get_recordset_sql($sql, $params);
333         foreach ($rs as $gradeitem) {
334             // Collect all of the used grade item id references
335             if (preg_match_all('/##gi(\d+)##/', $gradeitem->calculation, $matches) < 1) {
336                 // This calculation doesn't reference any other grade items... EASY!
337                 continue;
338             }
339             // For this next bit we are going to do the replacement of id's in two steps:
340             // 1. We will replace all old id references with a special mapping reference.
341             // 2. We will replace all mapping references with id's
342             // Why do we do this?
343             // Because there potentially there will be an overlap of ids within the query and we
344             // we substitute the wrong id.. safest way around this is the two step system
345             $calculationmap = array();
346             $mapcount = 0;
347             foreach ($matches[1] as $match) {
348                 // Check that the old id is known to us, if not it was broken to begin with and will
349                 // continue to be broken.
350                 if (!array_key_exists($match, $mappings)) {
351                     continue;
352                 }
353                 // Our special mapping key
354                 $mapping = '##MAPPING'.$mapcount.'##';
355                 // The old id that exists within the calculation now
356                 $oldid = '##gi'.$match.'##';
357                 // The new id that we want to replace the old one with.
358                 $newid = '##gi'.$mappings[$match].'##';
359                 // Replace in the special mapping key
360                 $gradeitem->calculation = str_replace($oldid, $mapping, $gradeitem->calculation);
361                 // And record the mapping
362                 $calculationmap[$mapping] = $newid;
363                 $mapcount++;
364             }
365             // Iterate all special mappings for this calculation and replace in the new id's
366             foreach ($calculationmap as $mapping => $newid) {
367                 $gradeitem->calculation = str_replace($mapping, $newid, $gradeitem->calculation);
368             }
369             // Update the calculation now that its being remapped
370             $DB->update_record('grade_items', $gradeitem);
371         }
372         $rs->close();
374         //need to correct the grade category path and parent
375         $conditions = array(
376             'courseid' => $this->get_courseid()
377         );
378         $grade_category = new stdclass();
380         $rs = $DB->get_recordset('grade_categories', $conditions);
381         if (!empty($rs)) {
382             //get all the parents correct first as grade_category::build_path() loads category parents from the DB
383             foreach($rs as $gc) {
384                 if (!empty($gc->parent)) {
385                     $grade_category->id = $gc->id;
386                     $grade_category->parent = $this->get_mappingid('grade_category', $gc->parent);
387                     $DB->update_record('grade_categories', $grade_category);
388                 }
389             }
390         }
391         if (isset($grade_category->parent)) {
392             unset($grade_category->parent);
393         }
394         $rs->close();
396         $rs = $DB->get_recordset('grade_categories', $conditions);
397         if (!empty($rs)) {
398             //now we can rebuild all the paths
399             foreach($rs as $gc) {
400                 $grade_category->id = $gc->id;
401                 $grade_category->path = grade_category::build_path($gc);
402                 $DB->update_record('grade_categories', $grade_category);
403             }
404         }
405         $rs->close();
407         //Restore marks items as needing update. Update everything now.
408         grade_regrade_final_grades($this->get_courseid());
409     }
412 /**
413  * decode all the interlinks present in restored content
414  * relying 100% in the restore_decode_processor that handles
415  * both the contents to modify and the rules to be applied
416  */
417 class restore_decode_interlinks extends restore_execution_step {
419     protected function define_execution() {
420         // Get the decoder (from the plan)
421         $decoder = $this->task->get_decoder();
422         restore_decode_processor::register_link_decoders($decoder); // Add decoder contents and rules
423         // And launch it, everything will be processed
424         $decoder->execute();
425     }
428 /**
429  * first, ensure that we have no gaps in section numbers
430  * and then, rebuid the course cache
431  */
432 class restore_rebuild_course_cache extends restore_execution_step {
434     protected function define_execution() {
435         global $DB;
437         // Although there is some sort of auto-recovery of missing sections
438         // present in course/formats... here we check that all the sections
439         // from 0 to MAX(section->section) exist, creating them if necessary
440         $maxsection = $DB->get_field('course_sections', 'MAX(section)', array('course' => $this->get_courseid()));
441         // Iterate over all sections
442         for ($i = 0; $i <= $maxsection; $i++) {
443             // If the section $i doesn't exist, create it
444             if (!$DB->record_exists('course_sections', array('course' => $this->get_courseid(), 'section' => $i))) {
445                 $sectionrec = array(
446                     'course' => $this->get_courseid(),
447                     'section' => $i);
448                 $DB->insert_record('course_sections', $sectionrec); // missing section created
449             }
450         }
452         // Rebuild cache now that all sections are in place
453         rebuild_course_cache($this->get_courseid());
454     }
457 /**
458  * Review all the tasks having one after_restore method
459  * executing it to perform some final adjustments of information
460  * not available when the task was executed.
461  */
462 class restore_execute_after_restore extends restore_execution_step {
464     protected function define_execution() {
466         // Simply call to the execute_after_restore() method of the task
467         // that always is the restore_final_task
468         $this->task->launch_execute_after_restore();
469     }
473 /**
474  * Review all the (pending) block positions in backup_ids, matching by
475  * contextid, creating positions as needed. This is executed by the
476  * final task, once all the contexts have been created
477  */
478 class restore_review_pending_block_positions extends restore_execution_step {
480     protected function define_execution() {
481         global $DB;
483         // Get all the block_position objects pending to match
484         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
485         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid');
486         // Process block positions, creating them or accumulating for final step
487         foreach($rs as $posrec) {
488             // Get the complete position object (stored as info)
489             $position = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'block_position', $posrec->itemid)->info;
490             // If position is for one already mapped (known) contextid
491             // process it now, creating the position, else nothing to
492             // do, position finally discarded
493             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
494                 $position->contextid = $newctx->newitemid;
495                 // Create the block position
496                 $DB->insert_record('block_positions', $position);
497             }
498         }
499         $rs->close();
500     }
503 /**
504  * Process all the saved module availability records in backup_ids, matching
505  * course modules and grade item id once all them have been already restored.
506  * only if all matchings are satisfied the availability condition will be created.
507  * At the same time, it is required for the site to have that functionality enabled.
508  */
509 class restore_process_course_modules_availability extends restore_execution_step {
511     protected function define_execution() {
512         global $CFG, $DB;
514         // Site hasn't availability enabled
515         if (empty($CFG->enableavailability)) {
516             return;
517         }
519         // Get all the module_availability objects to process
520         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'module_availability');
521         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid');
522         // Process availabilities, creating them if everything matches ok
523         foreach($rs as $availrec) {
524             $allmatchesok = true;
525             // Get the complete availabilityobject
526             $availability = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'module_availability', $availrec->itemid)->info;
527             // Map the sourcecmid if needed and possible
528             if (!empty($availability->sourcecmid)) {
529                 $newcm = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'course_module', $availability->sourcecmid);
530                 if ($newcm) {
531                     $availability->sourcecmid = $newcm->newitemid;
532                 } else {
533                     $allmatchesok = false; // Failed matching, we won't create this availability rule
534                 }
535             }
536             // Map the gradeitemid if needed and possible
537             if (!empty($availability->gradeitemid)) {
538                 $newgi = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'grade_item', $availability->gradeitemid);
539                 if ($newgi) {
540                     $availability->gradeitemid = $newgi->newitemid;
541                 } else {
542                     $allmatchesok = false; // Failed matching, we won't create this availability rule
543                 }
544             }
545             if ($allmatchesok) { // Everything ok, create the availability rule
546                 $DB->insert_record('course_modules_availability', $availability);
547             }
548         }
549         $rs->close();
550     }
554 /*
555  * Execution step that, *conditionally* (if there isn't preloaded information)
556  * will load the inforef files for all the included course/section/activity tasks
557  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
558  */
559 class restore_load_included_inforef_records extends restore_execution_step {
561     protected function define_execution() {
563         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
564             return;
565         }
567         // Get all the included tasks
568         $tasks = restore_dbops::get_included_tasks($this->get_restoreid());
569         foreach ($tasks as $task) {
570             // Load the inforef.xml file if exists
571             $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
572             if (file_exists($inforefpath)) {
573                 restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $inforefpath); // Load each inforef file to temp_ids
574             }
575         }
576     }
579 /*
580  * Execution step that will load all the needed files into backup_files_temp
581  *   - info: contains the whole original object (times, names...)
582  * (all them being original ids as loaded from xml)
583  */
584 class restore_load_included_files extends restore_structure_step {
586     protected function define_structure() {
588         $file = new restore_path_element('file', '/files/file');
590         return array($file);
591     }
593     // Processing functions go here
594     public function process_file($data) {
596         $data = (object)$data; // handy
598         // load it if needed:
599         //   - it it is one of the annotated inforef files (course/section/activity/block)
600         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
601         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
602         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
603         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
604         $iscomponent = ($data->component == 'user' || $data->component == 'group' ||
605                         $data->component == 'grouping' || $data->component == 'grade' ||
606                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
607         if ($isfileref || $iscomponent) {
608             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
609         }
610     }
613 /**
614  * Execution step that, *conditionally* (if there isn't preloaded information),
615  * will load all the needed roles to backup_temp_ids. They will be stored with
616  * "role" itemname. Also it will perform one automatic mapping to roles existing
617  * in the target site, based in permissions of the user performing the restore,
618  * archetypes and other bits. At the end, each original role will have its associated
619  * target role or 0 if it's going to be skipped. Note we wrap everything over one
620  * restore_dbops method, as far as the same stuff is going to be also executed
621  * by restore prechecks
622  */
623 class restore_load_and_map_roles extends restore_execution_step {
625     protected function define_execution() {
626         if ($this->task->get_preloaded_information()) { // if info is already preloaded
627             return;
628         }
630         $file = $this->get_basepath() . '/roles.xml';
631         // Load needed toles to temp_ids
632         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
634         // Process roles, mapping/skipping. Any error throws exception
635         // Note we pass controller's info because it can contain role mapping information
636         // about manual mappings performed by UI
637         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);
638     }
641 /**
642  * Execution step that, *conditionally* (if there isn't preloaded information
643  * and users have been selected in settings, will load all the needed users
644  * to backup_temp_ids. They will be stored with "user" itemname and with
645  * their original contextid as paremitemid
646  */
647 class restore_load_included_users extends restore_execution_step {
649     protected function define_execution() {
651         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
652             return;
653         }
654         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
655             return;
656         }
657         $file = $this->get_basepath() . '/users.xml';
658         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file); // Load needed users to temp_ids
659     }
662 /**
663  * Execution step that, *conditionally* (if there isn't preloaded information
664  * and users have been selected in settings, will process all the needed users
665  * in order to decide and perform any action with them (create / map / error)
666  * Note: Any error will cause exception, as far as this is the same processing
667  * than the one into restore prechecks (that should have stopped process earlier)
668  */
669 class restore_process_included_users extends restore_execution_step {
671     protected function define_execution() {
673         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
674             return;
675         }
676         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
677             return;
678         }
679         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
680     }
683 /**
684  * Execution step that will create all the needed users as calculated
685  * by @restore_process_included_users (those having newiteind = 0)
686  */
687 class restore_create_included_users extends restore_execution_step {
689     protected function define_execution() {
691         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(), $this->get_setting_value('user_files'), $this->task->get_userid());
692     }
695 /**
696  * Structure step that will create all the needed groups and groupings
697  * by loading them from the groups.xml file performing the required matches.
698  * Note group members only will be added if restoring user info
699  */
700 class restore_groups_structure_step extends restore_structure_step {
702     protected function define_structure() {
704         $paths = array(); // Add paths here
706         $paths[] = new restore_path_element('group', '/groups/group');
707         if ($this->get_setting_value('users')) {
708             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
709         }
710         $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
711         $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
713         return $paths;
714     }
716     // Processing functions go here
717     public function process_group($data) {
718         global $DB;
720         $data = (object)$data; // handy
721         $data->courseid = $this->get_courseid();
723         $oldid = $data->id;    // need this saved for later
725         $restorefiles = false; // Only if we end creating the group
727         // Search if the group already exists (by name & description) in the target course
728         $description_clause = '';
729         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
730         if (!empty($data->description)) {
731             $description_clause = ' AND ' .
732                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
733            $params['description'] = $data->description;
734         }
735         if (!$groupdb = $DB->get_record_sql("SELECT *
736                                                FROM {groups}
737                                               WHERE courseid = :courseid
738                                                 AND name = :grname $description_clause", $params)) {
739             // group doesn't exist, create
740             $newitemid = $DB->insert_record('groups', $data);
741             $restorefiles = true; // We'll restore the files
742         } else {
743             // group exists, use it
744             $newitemid = $groupdb->id;
745         }
746         // Save the id mapping
747         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
748     }
750     public function process_member($data) {
751         global $DB;
753         $data = (object)$data; // handy
755         // get parent group->id
756         $data->groupid = $this->get_new_parentid('group');
758         // map user newitemid and insert if not member already
759         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
760             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
761                 $DB->insert_record('groups_members', $data);
762             }
763         }
764     }
766     public function process_grouping($data) {
767         global $DB;
769         $data = (object)$data; // handy
770         $data->courseid = $this->get_courseid();
772         $oldid = $data->id;    // need this saved for later
773         $restorefiles = false; // Only if we end creating the grouping
775         // Search if the grouping already exists (by name & description) in the target course
776         $description_clause = '';
777         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
778         if (!empty($data->description)) {
779             $description_clause = ' AND ' .
780                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
781            $params['description'] = $data->description;
782         }
783         if (!$groupingdb = $DB->get_record_sql("SELECT *
784                                                   FROM {groupings}
785                                                  WHERE courseid = :courseid
786                                                    AND name = :grname $description_clause", $params)) {
787             // grouping doesn't exist, create
788             $newitemid = $DB->insert_record('groupings', $data);
789             $restorefiles = true; // We'll restore the files
790         } else {
791             // grouping exists, use it
792             $newitemid = $groupingdb->id;
793         }
794         // Save the id mapping
795         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
796     }
798     public function process_grouping_group($data) {
799         global $DB;
801         $data = (object)$data;
803         $data->groupingid = $this->get_new_parentid('grouping'); // Use new parentid
804         $data->groupid    = $this->get_mappingid('group', $data->groupid); // Get from mappings
805         $DB->insert_record('groupings_groups', $data);  // No need to set this mapping (no child info nor files)
806     }
808     protected function after_execute() {
809         // Add group related files, matching with "group" mappings
810         $this->add_related_files('group', 'icon', 'group');
811         $this->add_related_files('group', 'description', 'group');
812         // Add grouping related files, matching with "grouping" mappings
813         $this->add_related_files('grouping', 'description', 'grouping');
814     }
818 /**
819  * Structure step that will create all the needed scales
820  * by loading them from the scales.xml
821  */
822 class restore_scales_structure_step extends restore_structure_step {
824     protected function define_structure() {
826         $paths = array(); // Add paths here
827         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
828         return $paths;
829     }
831     protected function process_scale($data) {
832         global $DB;
834         $data = (object)$data;
836         $restorefiles = false; // Only if we end creating the group
838         $oldid = $data->id;    // need this saved for later
840         // Look for scale (by 'scale' both in standard (course=0) and current course
841         // with priority to standard scales (ORDER clause)
842         // scale is not course unique, use get_record_sql to suppress warning
843         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
844         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
845         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
846         if (!$scadb = $DB->get_record_sql("SELECT *
847                                             FROM {scale}
848                                            WHERE courseid IN (0, :courseid)
849                                              AND $compare_scale_clause
850                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
851             // Remap the user if possible, defaut to user performing the restore if not
852             $userid = $this->get_mappingid('user', $data->userid);
853             $data->userid = $userid ? $userid : $this->task->get_userid();
854             // Remap the course if course scale
855             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
856             // If global scale (course=0), check the user has perms to create it
857             // falling to course scale if not
858             $systemctx = get_context_instance(CONTEXT_SYSTEM);
859             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
860                 $data->courseid = $this->get_courseid();
861             }
862             // scale doesn't exist, create
863             $newitemid = $DB->insert_record('scale', $data);
864             $restorefiles = true; // We'll restore the files
865         } else {
866             // scale exists, use it
867             $newitemid = $scadb->id;
868         }
869         // Save the id mapping (with files support at system context)
870         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
871     }
873     protected function after_execute() {
874         // Add scales related files, matching with "scale" mappings
875         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
876     }
880 /**
881  * Structure step that will create all the needed outocomes
882  * by loading them from the outcomes.xml
883  */
884 class restore_outcomes_structure_step extends restore_structure_step {
886     protected function define_structure() {
888         $paths = array(); // Add paths here
889         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
890         return $paths;
891     }
893     protected function process_outcome($data) {
894         global $DB;
896         $data = (object)$data;
898         $restorefiles = false; // Only if we end creating the group
900         $oldid = $data->id;    // need this saved for later
902         // Look for outcome (by shortname both in standard (courseid=null) and current course
903         // with priority to standard outcomes (ORDER clause)
904         // outcome is not course unique, use get_record_sql to suppress warning
905         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
906         if (!$outdb = $DB->get_record_sql('SELECT *
907                                              FROM {grade_outcomes}
908                                             WHERE shortname = :shortname
909                                               AND (courseid = :courseid OR courseid IS NULL)
910                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
911             // Remap the user
912             $userid = $this->get_mappingid('user', $data->usermodified);
913             $data->usermodified = $userid ? $userid : $this->task->get_userid();
914             // Remap the scale
915             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
916             // Remap the course if course outcome
917             $data->courseid = $data->courseid ? $this->get_courseid() : null;
918             // If global outcome (course=null), check the user has perms to create it
919             // falling to course outcome if not
920             $systemctx = get_context_instance(CONTEXT_SYSTEM);
921             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
922                 $data->courseid = $this->get_courseid();
923             }
924             // outcome doesn't exist, create
925             $newitemid = $DB->insert_record('grade_outcomes', $data);
926             $restorefiles = true; // We'll restore the files
927         } else {
928             // scale exists, use it
929             $newitemid = $outdb->id;
930         }
931         // Set the corresponding grade_outcomes_courses record
932         $outcourserec = new stdclass();
933         $outcourserec->courseid  = $this->get_courseid();
934         $outcourserec->outcomeid = $newitemid;
935         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
936             $DB->insert_record('grade_outcomes_courses', $outcourserec);
937         }
938         // Save the id mapping (with files support at system context)
939         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
940     }
942     protected function after_execute() {
943         // Add outcomes related files, matching with "outcome" mappings
944         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
945     }
948 /**
949  * Execution step that, *conditionally* (if there isn't preloaded information
950  * will load all the question categories and questions (header info only)
951  * to backup_temp_ids. They will be stored with "question_category" and
952  * "question" itemnames and with their original contextid and question category
953  * id as paremitemids
954  */
955 class restore_load_categories_and_questions extends restore_execution_step {
957     protected function define_execution() {
959         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
960             return;
961         }
962         $file = $this->get_basepath() . '/questions.xml';
963         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
964     }
967 /**
968  * Execution step that, *conditionally* (if there isn't preloaded information)
969  * will process all the needed categories and questions
970  * in order to decide and perform any action with them (create / map / error)
971  * Note: Any error will cause exception, as far as this is the same processing
972  * than the one into restore prechecks (that should have stopped process earlier)
973  */
974 class restore_process_categories_and_questions extends restore_execution_step {
976     protected function define_execution() {
978         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
979             return;
980         }
981         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
982     }
985 /**
986  * Structure step that will read the section.xml creating/updating sections
987  * as needed, rebuilding course cache and other friends
988  */
989 class restore_section_structure_step extends restore_structure_step {
991     protected function define_structure() {
992         $section = new restore_path_element('section', '/section');
994         // Apply for 'format' plugins optional paths at section level
995         $this->add_plugin_structure('format', $section);
997         return array($section);
998     }
1000     public function process_section($data) {
1001         global $DB;
1002         $data = (object)$data;
1003         $oldid = $data->id; // We'll need this later
1005         $restorefiles = false;
1007         // Look for the section
1008         $section = new stdclass();
1009         $section->course  = $this->get_courseid();
1010         $section->section = $data->number;
1011         // Section doesn't exist, create it with all the info from backup
1012         if (!$secrec = $DB->get_record('course_sections', (array)$section)) {
1013             $section->name = $data->name;
1014             $section->summary = $data->summary;
1015             $section->summaryformat = $data->summaryformat;
1016             $section->sequence = '';
1017             $section->visible = $data->visible;
1018             $newitemid = $DB->insert_record('course_sections', $section);
1019             $restorefiles = true;
1021         // Section exists, update non-empty information
1022         } else {
1023             $section->id = $secrec->id;
1024             if (empty($secrec->name)) {
1025                 $section->name = $data->name;
1026             }
1027             if (empty($secrec->summary)) {
1028                 $section->summary = $data->summary;
1029                 $section->summaryformat = $data->summaryformat;
1030                 $restorefiles = true;
1031             }
1032             $DB->update_record('course_sections', $section);
1033             $newitemid = $secrec->id;
1034         }
1036         // Annotate the section mapping, with restorefiles option if needed
1037         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
1039         // set the new course_section id in the task
1040         $this->task->set_sectionid($newitemid);
1043         // Commented out. We never modify course->numsections as far as that is used
1044         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
1045         // Note: We keep the code here, to know about and because of the possibility of making this
1046         // optional based on some setting/attribute in the future
1047         // If needed, adjust course->numsections
1048         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
1049         //    if ($numsections < $section->section) {
1050         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
1051         //    }
1052         //}
1053     }
1055     protected function after_execute() {
1056         // Add section related files, with 'course_section' itemid to match
1057         $this->add_related_files('course', 'section', 'course_section');
1058     }
1062 /**
1063  * Structure step that will read the course.xml file, loading it and performing
1064  * various actions depending of the site/restore settings. Note that target
1065  * course always exist before arriving here so this step will be updating
1066  * the course record (never inserting)
1067  */
1068 class restore_course_structure_step extends restore_structure_step {
1070     protected function define_structure() {
1072         $course = new restore_path_element('course', '/course');
1073         $category = new restore_path_element('category', '/course/category');
1074         $tag = new restore_path_element('tag', '/course/tags/tag');
1075         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1077         // Apply for 'format' plugins optional paths at course level
1078         $this->add_plugin_structure('format', $course);
1080         // Apply for 'theme' plugins optional paths at course level
1081         $this->add_plugin_structure('theme', $course);
1083         // Apply for 'report' plugins optional paths at course level
1084         $this->add_plugin_structure('report', $course);
1086         // Apply for 'course report' plugins optional paths at course level
1087         $this->add_plugin_structure('coursereport', $course);
1089         // Apply for plagiarism plugins optional paths at course level
1090         $this->add_plugin_structure('plagiarism', $course);
1092         return array($course, $category, $tag, $allowed_module);
1093     }
1095     /**
1096      * Processing functions go here
1097      *
1098      * @global moodledatabase $DB
1099      * @param stdClass $data
1100      */
1101     public function process_course($data) {
1102         global $CFG, $DB;
1104         $data = (object)$data;
1105         $oldid = $data->id; // We'll need this later
1107         $fullname  = $this->get_setting_value('course_fullname');
1108         $shortname = $this->get_setting_value('course_shortname');
1109         $startdate = $this->get_setting_value('course_startdate');
1111         // Calculate final course names, to avoid dupes
1112         list($fullname, $shortname) = restore_dbops::calculate_course_names($this->get_courseid(), $fullname, $shortname);
1114         // Need to change some fields before updating the course record
1115         $data->id = $this->get_courseid();
1116         $data->fullname = $fullname;
1117         $data->shortname= $shortname;
1118         $data->idnumber = '';
1120         // Only restrict modules if original course was and target site too for new courses
1121         $data->restrictmodules = $data->restrictmodules && !empty($CFG->restrictmodulesfor) && $CFG->restrictmodulesfor == 'all';
1123         $data->startdate= $this->apply_date_offset($data->startdate);
1124         if ($data->defaultgroupingid) {
1125             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1126         }
1127         if (empty($CFG->enablecompletion)) {
1128             $data->enablecompletion = 0;
1129             $data->completionstartonenrol = 0;
1130             $data->completionnotify = 0;
1131         }
1132         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1133         if (!array_key_exists($data->lang, $languages)) {
1134             $data->lang = '';
1135         }
1137         $themes = get_list_of_themes(); // Get themes for quick search later
1138         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1139             $data->theme = '';
1140         }
1142         // Course record ready, update it
1143         $DB->update_record('course', $data);
1145         // Role name aliases
1146         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1147     }
1149     public function process_category($data) {
1150         // Nothing to do with the category. UI sets it before restore starts
1151     }
1153     public function process_tag($data) {
1154         global $CFG, $DB;
1156         $data = (object)$data;
1158         if (!empty($CFG->usetags)) { // if enabled in server
1159             // TODO: This is highly inneficient. Each time we add one tag
1160             // we fetch all the existing because tag_set() deletes them
1161             // so everything must be reinserted on each call
1162             $tags = array();
1163             $existingtags = tag_get_tags('course', $this->get_courseid());
1164             // Re-add all the existitng tags
1165             foreach ($existingtags as $existingtag) {
1166                 $tags[] = $existingtag->rawname;
1167             }
1168             // Add the one being restored
1169             $tags[] = $data->rawname;
1170             // Send all the tags back to the course
1171             tag_set('course', $this->get_courseid(), $tags);
1172         }
1173     }
1175     public function process_allowed_module($data) {
1176         global $CFG, $DB;
1178         $data = (object)$data;
1180         // only if enabled by admin setting
1181         if (!empty($CFG->restrictmodulesfor) && $CFG->restrictmodulesfor == 'all') {
1182             $available = get_plugin_list('mod');
1183             $mname = $data->modulename;
1184             if (array_key_exists($mname, $available)) {
1185                 if ($module = $DB->get_record('modules', array('name' => $mname, 'visible' => 1))) {
1186                     $rec = new stdclass();
1187                     $rec->course = $this->get_courseid();
1188                     $rec->module = $module->id;
1189                     if (!$DB->record_exists('course_allowed_modules', (array)$rec)) {
1190                         $DB->insert_record('course_allowed_modules', $rec);
1191                     }
1192                 }
1193             }
1194         }
1195     }
1197     protected function after_execute() {
1198         // Add course related files, without itemid to match
1199         $this->add_related_files('course', 'summary', null);
1200         $this->add_related_files('course', 'legacy', null);
1201     }
1205 /*
1206  * Structure step that will read the roles.xml file (at course/activity/block levels)
1207  * containig all the role_assignments and overrides for that context. If corresponding to
1208  * one mapped role, they will be applied to target context. Will observe the role_assignments
1209  * setting to decide if ras are restored.
1210  * Note: only ras with component == null are restored as far as the any ra with component
1211  * is handled by one enrolment plugin, hence it will createt the ras later
1212  */
1213 class restore_ras_and_caps_structure_step extends restore_structure_step {
1215     protected function define_structure() {
1217         $paths = array();
1219         // Observe the role_assignments setting
1220         if ($this->get_setting_value('role_assignments')) {
1221             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
1222         }
1223         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
1225         return $paths;
1226     }
1228     /**
1229      * Assign roles
1230      *
1231      * This has to be called after enrolments processing.
1232      *
1233      * @param mixed $data
1234      * @return void
1235      */
1236     public function process_assignment($data) {
1237         global $DB;
1239         $data = (object)$data;
1241         // Check roleid, userid are one of the mapped ones
1242         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
1243             return;
1244         }
1245         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
1246             return;
1247         }
1248         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
1249             // Only assign roles to not deleted users
1250             return;
1251         }
1252         if (!$contextid = $this->task->get_contextid()) {
1253             return;
1254         }
1256         if (empty($data->component)) {
1257             // assign standard manual roles
1258             // TODO: role_assign() needs one userid param to be able to specify our restore userid
1259             role_assign($newroleid, $newuserid, $contextid);
1261         } else if ((strpos($data->component, 'enrol_') === 0)) {
1262             // Deal with enrolment roles
1263             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1264                 if ($component = $DB->get_field('enrol', 'component', array('id'=>$enrolid))) {
1265                     //note: we have to verify component because it might have changed
1266                     if ($component === 'enrol_manual') {
1267                         // manual is a special case, we do not use components - this owudl happen when converting from other plugin
1268                         role_assign($newroleid, $newuserid, $contextid); //TODO: do we need modifierid?
1269                     } else {
1270                         role_assign($newroleid, $newuserid, $contextid, $component, $enrolid); //TODO: do we need modifierid?
1271                     }
1272                 }
1273             }
1274         }
1275     }
1277     public function process_override($data) {
1278         $data = (object)$data;
1280         // Check roleid is one of the mapped ones
1281         $newroleid = $this->get_mappingid('role', $data->roleid);
1282         // If newroleid and context are valid assign it via API (it handles dupes and so on)
1283         if ($newroleid && $this->task->get_contextid()) {
1284             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
1285             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
1286             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
1287         }
1288     }
1291 /**
1292  * This structure steps restores the enrol plugins and their underlying
1293  * enrolments, performing all the mappings and/or movements required
1294  */
1295 class restore_enrolments_structure_step extends restore_structure_step {
1297     /**
1298      * Conditionally decide if this step should be executed.
1299      *
1300      * This function checks the following parameter:
1301      *
1302      *   1. the course/enrolments.xml file exists
1303      *
1304      * @return bool true is safe to execute, false otherwise
1305      */
1306     protected function execute_condition() {
1308         // Check it is included in the backup
1309         $fullpath = $this->task->get_taskbasepath();
1310         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1311         if (!file_exists($fullpath)) {
1312             // Not found, can't restore enrolments info
1313             return false;
1314         }
1316         return true;
1317     }
1319     protected function define_structure() {
1321         $paths = array();
1323         $paths[] = new restore_path_element('enrol', '/enrolments/enrols/enrol');
1324         $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
1326         return $paths;
1327     }
1329     /**
1330      * Create enrolment instances.
1331      *
1332      * This has to be called after creation of roles
1333      * and before adding of role assignments.
1334      *
1335      * @param mixed $data
1336      * @return void
1337      */
1338     public function process_enrol($data) {
1339         global $DB;
1341         $data = (object)$data;
1342         $oldid = $data->id; // We'll need this later
1344         $restoretype = plugin_supports('enrol', $data->enrol, ENROL_RESTORE_TYPE, null);
1346         if ($restoretype !== ENROL_RESTORE_EXACT and $restoretype !== ENROL_RESTORE_NOUSERS) {
1347             // TODO: add complex restore support via custom class
1348             debugging("Skipping '{$data->enrol}' enrolment plugin. Will be implemented before 2.0 release", DEBUG_DEVELOPER);
1349             $this->set_mapping('enrol', $oldid, 0);
1350             return;
1351         }
1353         // Perform various checks to decide what to do with the enrol plugin
1354         if (!array_key_exists($data->enrol, enrol_get_plugins(false))) {
1355             // TODO: decide if we want to switch to manual enrol - we need UI for this
1356             debugging("Enrol plugin data can not be restored because it is not installed");
1357             $this->set_mapping('enrol', $oldid, 0);
1358             return;
1360         }
1361         if (!enrol_is_enabled($data->enrol)) {
1362             // TODO: decide if we want to switch to manual enrol - we need UI for this
1363             debugging("Enrol plugin data can not be restored because it is not enabled");
1364             $this->set_mapping('enrol', $oldid, 0);
1365             return;
1366         }
1368         // map standard fields - plugin has to process custom fields from own restore class
1369         $data->roleid = $this->get_mappingid('role', $data->roleid);
1370         //TODO: should we move the enrol start and end date here?
1372         // always add instance, if the course does not support multiple instances it just returns NULL
1373         $enrol = enrol_get_plugin($data->enrol);
1374         $courserec = $DB->get_record('course', array('id' => $this->get_courseid())); // Requires object, uses only id!!
1375         if ($newitemid = $enrol->add_instance($courserec, (array)$data)) {
1376             // ok
1377         } else {
1378             if ($instances = $DB->get_records('enrol', array('courseid'=>$courserec->id, 'enrol'=>$data->enrol))) {
1379                 // most probably plugin that supports only one instance
1380                 $newitemid = key($instances);
1381             } else {
1382                 debugging('Can not create new enrol instance or reuse existing');
1383                 $newitemid = 0;
1384             }
1385         }
1387         if ($restoretype === ENROL_RESTORE_NOUSERS) {
1388             // plugin requests to prevent restore of any users
1389             $newitemid = 0;
1390         }
1392         $this->set_mapping('enrol', $oldid, $newitemid);
1393     }
1395     /**
1396      * Create user enrolments
1397      *
1398      * This has to be called after creation of enrolment instances
1399      * and before adding of role assignments.
1400      *
1401      * @param mixed $data
1402      * @return void
1403      */
1404     public function process_enrolment($data) {
1405         global $DB;
1407         $data = (object)$data;
1409         // Process only if parent instance have been mapped
1410         if ($enrolid = $this->get_new_parentid('enrol')) {
1411             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1412                 // And only if user is a mapped one
1413                 if ($userid = $this->get_mappingid('user', $data->userid)) {
1414                     $enrol = enrol_get_plugin($instance->enrol);
1415                     //TODO: do we need specify modifierid?
1416                     $enrol->enrol_user($instance, $userid, null, $data->timestart, $data->timeend, $data->status);
1417                     //note: roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing above
1418                 }
1419             }
1420         }
1421     }
1425 /**
1426  * This structure steps restores the filters and their configs
1427  */
1428 class restore_filters_structure_step extends restore_structure_step {
1430     protected function define_structure() {
1432         $paths = array();
1434         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
1435         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
1437         return $paths;
1438     }
1440     public function process_active($data) {
1442         $data = (object)$data;
1444         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1445             return;
1446         }
1447         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
1448     }
1450     public function process_config($data) {
1452         $data = (object)$data;
1454         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1455             return;
1456         }
1457         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
1458     }
1462 /**
1463  * This structure steps restores the comments
1464  * Note: Cannot use the comments API because defaults to USER->id.
1465  * That should change allowing to pass $userid
1466  */
1467 class restore_comments_structure_step extends restore_structure_step {
1469     protected function define_structure() {
1471         $paths = array();
1473         $paths[] = new restore_path_element('comment', '/comments/comment');
1475         return $paths;
1476     }
1478     public function process_comment($data) {
1479         global $DB;
1481         $data = (object)$data;
1483         // First of all, if the comment has some itemid, ask to the task what to map
1484         $mapping = false;
1485         if ($data->itemid) {
1486             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
1487             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
1488         }
1489         // Only restore the comment if has no mapping OR we have found the matching mapping
1490         if (!$mapping || $data->itemid) {
1491             // Only if user mapping and context
1492             $data->userid = $this->get_mappingid('user', $data->userid);
1493             if ($data->userid && $this->task->get_contextid()) {
1494                 $data->contextid = $this->task->get_contextid();
1495                 // Only if there is another comment with same context/user/timecreated
1496                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
1497                 if (!$DB->record_exists('comments', $params)) {
1498                     $DB->insert_record('comments', $data);
1499                 }
1500             }
1501         }
1502     }
1505 class restore_course_completion_structure_step extends restore_structure_step {
1507     /**
1508      * Conditionally decide if this step should be executed.
1509      *
1510      * This function checks parameters that are not immediate settings to ensure
1511      * that the enviroment is suitable for the restore of course completion info.
1512      *
1513      * This function checks the following four parameters:
1514      *
1515      *   1. Course completion is enabled on the site
1516      *   2. The backup includes course completion information
1517      *   3. All modules are restorable
1518      *   4. All modules are marked for restore.
1519      *
1520      * @return bool True is safe to execute, false otherwise
1521      */
1522     protected function execute_condition() {
1523         global $CFG;
1525         // First check course completion is enabled on this site
1526         if (empty($CFG->enablecompletion)) {
1527             // Disabled, don't restore course completion
1528             return false;
1529         }
1531         // Check it is included in the backup
1532         $fullpath = $this->task->get_taskbasepath();
1533         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1534         if (!file_exists($fullpath)) {
1535             // Not found, can't restore course completion
1536             return false;
1537         }
1539         // Check we are able to restore all backed up modules
1540         if ($this->task->is_missing_modules()) {
1541             return false;
1542         }
1544         // Finally check all modules within the backup are being restored.
1545         if ($this->task->is_excluding_activities()) {
1546             return false;
1547         }
1549         return true;
1550     }
1552     /**
1553      * Define the course completion structure
1554      *
1555      * @return array Array of restore_path_element
1556      */
1557     protected function define_structure() {
1559         // To know if we are including user completion info
1560         $userinfo = $this->get_setting_value('userscompletion');
1562         $paths = array();
1563         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
1564         $paths[] = new restore_path_element('course_completion_notify', '/course_completion/course_completion_notify');
1565         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
1567         if ($userinfo) {
1568             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
1569             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
1570         }
1572         return $paths;
1574     }
1576     /**
1577      * Process course completion criteria
1578      *
1579      * @global moodle_database $DB
1580      * @param stdClass $data
1581      */
1582     public function process_course_completion_criteria($data) {
1583         global $DB;
1585         $data = (object)$data;
1586         $data->course = $this->get_courseid();
1588         // Apply the date offset to the time end field
1589         $data->timeend = $this->apply_date_offset($data->timeend);
1591         // Map the role from the criteria
1592         if (!empty($data->role)) {
1593             $data->role = $this->get_mappingid('role', $data->role);
1594         }
1596         $skipcriteria = false;
1598         // If the completion criteria is for a module we need to map the module instance
1599         // to the new module id.
1600         if (!empty($data->moduleinstance) && !empty($data->module)) {
1601             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
1602             if (empty($data->moduleinstance)) {
1603                 $skipcriteria = true;
1604             }
1605         } else {
1606             $data->module = null;
1607             $data->moduleinstance = null;
1608         }
1610         // We backup the course shortname rather than the ID so that we can match back to the course
1611         if (!empty($data->courseinstanceshortname)) {
1612             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
1613             if (!$courseinstanceid) {
1614                 $skipcriteria = true;
1615             }
1616         } else {
1617             $courseinstanceid = null;
1618         }
1619         $data->courseinstance = $courseinstanceid;
1621         if (!$skipcriteria) {
1622             $params = array(
1623                 'course'         => $data->course,
1624                 'criteriatype'   => $data->criteriatype,
1625                 'enrolperiod'    => $data->enrolperiod,
1626                 'courseinstance' => $data->courseinstance,
1627                 'module'         => $data->module,
1628                 'moduleinstance' => $data->moduleinstance,
1629                 'timeend'        => $data->timeend,
1630                 'gradepass'      => $data->gradepass,
1631                 'role'           => $data->role
1632             );
1633             $newid = $DB->insert_record('course_completion_criteria', $params);
1634             $this->set_mapping('course_completion_criteria', $data->id, $newid);
1635         }
1636     }
1638     /**
1639      * Processes course compltion criteria complete records
1640      *
1641      * @global moodle_database $DB
1642      * @param stdClass $data
1643      */
1644     public function process_course_completion_crit_compl($data) {
1645         global $DB;
1647         $data = (object)$data;
1649         // This may be empty if criteria could not be restored
1650         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
1652         $data->course = $this->get_courseid();
1653         $data->userid = $this->get_mappingid('user', $data->userid);
1655         if (!empty($data->criteriaid) && !empty($data->userid)) {
1656             $params = array(
1657                 'userid' => $data->userid,
1658                 'course' => $data->course,
1659                 'criteriaid' => $data->criteriaid,
1660                 'timecompleted' => $this->apply_date_offset($data->timecompleted)
1661             );
1662             if (isset($data->gradefinal)) {
1663                 $params['gradefinal'] = $data->gradefinal;
1664             }
1665             if (isset($data->unenroled)) {
1666                 $params['unenroled'] = $data->unenroled;
1667             }
1668             if (isset($data->deleted)) {
1669                 $params['deleted'] = $data->deleted;
1670             }
1671             $DB->insert_record('course_completion_crit_compl', $params);
1672         }
1673     }
1675     /**
1676      * Process course completions
1677      *
1678      * @global moodle_database $DB
1679      * @param stdClass $data
1680      */
1681     public function process_course_completions($data) {
1682         global $DB;
1684         $data = (object)$data;
1686         $data->course = $this->get_courseid();
1687         $data->userid = $this->get_mappingid('user', $data->userid);
1689         if (!empty($data->userid)) {
1690             $params = array(
1691                 'userid' => $data->userid,
1692                 'course' => $data->course,
1693                 'deleted' => $data->deleted,
1694                 'timenotified' => $this->apply_date_offset($data->timenotified),
1695                 'timeenrolled' => $this->apply_date_offset($data->timeenrolled),
1696                 'timestarted' => $this->apply_date_offset($data->timestarted),
1697                 'timecompleted' => $this->apply_date_offset($data->timecompleted),
1698                 'reaggregate' => $data->reaggregate
1699             );
1700             $DB->insert_record('course_completions', $params);
1701         }
1702     }
1704     /**
1705      * Process course completion notification records.
1706      *
1707      * Note: As of Moodle 2.0 this table is not being used however it has been
1708      * left in in the hopes that one day the functionality there will be completed
1709      *
1710      * @global moodle_database $DB
1711      * @param stdClass $data
1712      */
1713     public function process_course_completion_notify($data) {
1714         global $DB;
1716         $data = (object)$data;
1718         $data->course = $this->get_courseid();
1719         if (!empty($data->role)) {
1720             $data->role = $this->get_mappingid('role', $data->role);
1721         }
1723         $params = array(
1724             'course' => $data->course,
1725             'role' => $data->role,
1726             'message' => $data->message,
1727             'timesent' => $this->apply_date_offset($data->timesent),
1728         );
1729         $DB->insert_record('course_completion_notify', $params);
1730     }
1732     /**
1733      * Process course completion aggregate methods
1734      *
1735      * @global moodle_database $DB
1736      * @param stdClass $data
1737      */
1738     public function process_course_completion_aggr_methd($data) {
1739         global $DB;
1741         $data = (object)$data;
1743         $data->course = $this->get_courseid();
1745         $params = array(
1746             'course' => $data->course,
1747             'criteriatype' => $data->criteriatype,
1748             'method' => $data->method,
1749             'value' => $data->value,
1750         );
1751         $DB->insert_record('course_completion_aggr_methd', $params);
1752     }
1757 /**
1758  * This structure step restores course logs (cmid = 0), delegating
1759  * the hard work to the corresponding {@link restore_logs_processor} passing the
1760  * collection of {@link restore_log_rule} rules to be observed as they are defined
1761  * by the task. Note this is only executed based in the 'logs' setting.
1762  *
1763  * NOTE: This is executed by final task, to have all the activities already restored
1764  *
1765  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
1766  * records are. There are others like 'calendar' and 'upload' that will be handled
1767  * later.
1768  *
1769  * NOTE: All the missing actions (not able to be restored) are sent to logs for
1770  * debugging purposes
1771  */
1772 class restore_course_logs_structure_step extends restore_structure_step {
1774     /**
1775      * Conditionally decide if this step should be executed.
1776      *
1777      * This function checks the following parameter:
1778      *
1779      *   1. the course/logs.xml file exists
1780      *
1781      * @return bool true is safe to execute, false otherwise
1782      */
1783     protected function execute_condition() {
1785         // Check it is included in the backup
1786         $fullpath = $this->task->get_taskbasepath();
1787         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1788         if (!file_exists($fullpath)) {
1789             // Not found, can't restore course logs
1790             return false;
1791         }
1793         return true;
1794     }
1796     protected function define_structure() {
1798         $paths = array();
1800         // Simple, one plain level of information contains them
1801         $paths[] = new restore_path_element('log', '/logs/log');
1803         return $paths;
1804     }
1806     protected function process_log($data) {
1807         global $DB;
1809         $data = (object)($data);
1811         $data->time = $this->apply_date_offset($data->time);
1812         $data->userid = $this->get_mappingid('user', $data->userid);
1813         $data->course = $this->get_courseid();
1814         $data->cmid = 0;
1816         // For any reason user wasn't remapped ok, stop processing this
1817         if (empty($data->userid)) {
1818             return;
1819         }
1821         // Everything ready, let's delegate to the restore_logs_processor
1823         // Set some fixed values that will save tons of DB requests
1824         $values = array(
1825             'course' => $this->get_courseid());
1826         // Get instance and process log record
1827         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
1829         // If we have data, insert it, else something went wrong in the restore_logs_processor
1830         if ($data) {
1831             $DB->insert_record('log', $data);
1832         }
1833     }
1836 /**
1837  * This structure step restores activity logs, extending {@link restore_course_logs_structure_step}
1838  * sharing its same structure but modifying the way records are handled
1839  */
1840 class restore_activity_logs_structure_step extends restore_course_logs_structure_step {
1842     protected function process_log($data) {
1843         global $DB;
1845         $data = (object)($data);
1847         $data->time = $this->apply_date_offset($data->time);
1848         $data->userid = $this->get_mappingid('user', $data->userid);
1849         $data->course = $this->get_courseid();
1850         $data->cmid = $this->task->get_moduleid();
1852         // For any reason user wasn't remapped ok, stop processing this
1853         if (empty($data->userid)) {
1854             return;
1855         }
1857         // Everything ready, let's delegate to the restore_logs_processor
1859         // Set some fixed values that will save tons of DB requests
1860         $values = array(
1861             'course' => $this->get_courseid(),
1862             'course_module' => $this->task->get_moduleid(),
1863             $this->task->get_modulename() => $this->task->get_activityid());
1864         // Get instance and process log record
1865         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
1867         // If we have data, insert it, else something went wrong in the restore_logs_processor
1868         if ($data) {
1869             $DB->insert_record('log', $data);
1870         }
1871     }
1875 /**
1876  * Defines the restore step for advanced grading methods attached to the activity module
1877  */
1878 class restore_activity_grading_structure_step extends restore_structure_step {
1880     /**
1881      * This step is executed only if the grading file is present
1882      */
1883      protected function execute_condition() {
1885         $fullpath = $this->task->get_taskbasepath();
1886         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1887         if (!file_exists($fullpath)) {
1888             return false;
1889         }
1891         return true;
1892     }
1895     /**
1896      * Declares paths in the grading.xml file we are interested in
1897      */
1898     protected function define_structure() {
1900         $paths = array();
1901         $userinfo = $this->get_setting_value('userinfo');
1903         $paths[] = new restore_path_element('grading_area', '/areas/area');
1905         $definition = new restore_path_element('grading_definition', '/areas/area/definitions/definition');
1906         $paths[] = $definition;
1907         $this->add_plugin_structure('gradingform', $definition);
1909         if ($userinfo) {
1910             $instance = new restore_path_element('grading_instance',
1911                 '/areas/area/definitions/definition/instances/instance');
1912             $paths[] = $instance;
1913             $this->add_plugin_structure('gradingform', $instance);
1914         }
1916         return $paths;
1917     }
1919     /**
1920      * Processes one grading area element
1921      *
1922      * @param array $data element data
1923      */
1924     protected function process_grading_area($data) {
1925         global $DB;
1927         $task = $this->get_task();
1928         $data = (object)$data;
1929         $oldid = $data->id;
1930         $data->component = 'mod_'.$task->get_modulename();
1931         $data->contextid = $task->get_contextid();
1933         $newid = $DB->insert_record('grading_areas', $data);
1934         $this->set_mapping('grading_area', $oldid, $newid);
1935     }
1937     /**
1938      * Processes one grading definition element
1939      *
1940      * @param array $data element data
1941      */
1942     protected function process_grading_definition($data) {
1943         global $DB;
1945         $task = $this->get_task();
1946         $data = (object)$data;
1947         $oldid = $data->id;
1948         $data->areaid = $this->get_new_parentid('grading_area');
1949         $data->copiedfromid = null;
1950         $data->timecreated = time();
1951         $data->usercreated = $task->get_userid();
1952         $data->timemodified = $data->timecreated;
1953         $data->usermodified = $data->usercreated;
1955         $newid = $DB->insert_record('grading_definitions', $data);
1956         $this->set_mapping('grading_definition', $oldid, $newid, true);
1957     }
1959     /**
1960      * Processes one grading form instance element
1961      *
1962      * @param array $data element data
1963      */
1964     protected function process_grading_instance($data) {
1965         global $DB;
1967         $data = (object)$data;
1969         // new form definition id
1970         $newformid = $this->get_new_parentid('grading_definition');
1972         // get the name of the area we are restoring to
1973         $sql = "SELECT ga.areaname
1974                   FROM {grading_definitions} gd
1975                   JOIN {grading_areas} ga ON gd.areaid = ga.id
1976                  WHERE gd.id = ?";
1977         $areaname = $DB->get_field_sql($sql, array($newformid), MUST_EXIST);
1979         // get the mapped itemid - the activity module is expected to define the mappings
1980         // for each gradable area
1981         $newitemid = $this->get_mappingid(restore_gradingform_plugin::itemid_mapping($areaname), $data->itemid);
1983         $oldid = $data->id;
1984         $data->formid = $newformid;
1985         $data->raterid = $this->get_mappingid('user', $data->raterid);
1986         $data->itemid = $newitemid;
1988         $newid = $DB->insert_record('grading_instances', $data);
1989         $this->set_mapping('grading_instance', $oldid, $newid);
1990     }
1992     /**
1993      * Final operations when the database records are inserted
1994      */
1995     protected function after_execute() {
1996         // Add files embedded into the definition description
1997         $this->add_related_files('grading', 'description', 'grading_definition');
1998     }
2002 /**
2003  * This structure step restores the grade items associated with one activity
2004  * All the grade items are made child of the "course" grade item but the original
2005  * categoryid is saved as parentitemid in the backup_ids table, so, when restoring
2006  * the complete gradebook (categories and calculations), that information is
2007  * available there
2008  */
2009 class restore_activity_grades_structure_step extends restore_structure_step {
2011     protected function define_structure() {
2013         $paths = array();
2014         $userinfo = $this->get_setting_value('userinfo');
2016         $paths[] = new restore_path_element('grade_item', '/activity_gradebook/grade_items/grade_item');
2017         $paths[] = new restore_path_element('grade_letter', '/activity_gradebook/grade_letters/grade_letter');
2018         if ($userinfo) {
2019             $paths[] = new restore_path_element('grade_grade',
2020                            '/activity_gradebook/grade_items/grade_item/grade_grades/grade_grade');
2021         }
2022         return $paths;
2023     }
2025     protected function process_grade_item($data) {
2026         global $DB;
2028         $data = (object)($data);
2029         $oldid       = $data->id;        // We'll need these later
2030         $oldparentid = $data->categoryid;
2031         $courseid = $this->get_courseid();
2033         // make sure top course category exists, all grade items will be associated
2034         // to it. Later, if restoring the whole gradebook, categories will be introduced
2035         $coursecat = grade_category::fetch_course_category($courseid);
2036         $coursecatid = $coursecat->id; // Get the categoryid to be used
2038         $idnumber = null;
2039         if (!empty($data->idnumber)) {
2040             // Don't get any idnumber from course module. Keep them as they are in grade_item->idnumber
2041             // Reason: it's not clear what happens with outcomes->idnumber or activities with multiple items (workshop)
2042             // so the best is to keep the ones already in the gradebook
2043             // Potential problem: duplicates if same items are restored more than once. :-(
2044             // This needs to be fixed in some way (outcomes & activities with multiple items)
2045             // $data->idnumber     = get_coursemodule_from_instance($data->itemmodule, $data->iteminstance)->idnumber;
2046             // In any case, verify always for uniqueness
2047             $sql = "SELECT cm.id
2048                       FROM {course_modules} cm
2049                      WHERE cm.course = :courseid AND
2050                            cm.idnumber = :idnumber AND
2051                            cm.id <> :cmid";
2052             $params = array(
2053                 'courseid' => $courseid,
2054                 'idnumber' => $data->idnumber,
2055                 'cmid' => $this->task->get_moduleid()
2056             );
2057             if (!$DB->record_exists_sql($sql, $params) && !$DB->record_exists('grade_items', array('courseid' => $courseid, 'idnumber' => $data->idnumber))) {
2058                 $idnumber = $data->idnumber;
2059             }
2060         }
2062         unset($data->id);
2063         $data->categoryid   = $coursecatid;
2064         $data->courseid     = $this->get_courseid();
2065         $data->iteminstance = $this->task->get_activityid();
2066         $data->idnumber     = $idnumber;
2067         $data->scaleid      = $this->get_mappingid('scale', $data->scaleid);
2068         $data->outcomeid    = $this->get_mappingid('outcome', $data->outcomeid);
2069         $data->timecreated  = $this->apply_date_offset($data->timecreated);
2070         $data->timemodified = $this->apply_date_offset($data->timemodified);
2072         $gradeitem = new grade_item($data, false);
2073         $gradeitem->insert('restore');
2075         //sortorder is automatically assigned when inserting. Re-instate the previous sortorder
2076         $gradeitem->sortorder = $data->sortorder;
2077         $gradeitem->update('restore');
2079         // Set mapping, saving the original category id into parentitemid
2080         // gradebook restore (final task) will need it to reorganise items
2081         $this->set_mapping('grade_item', $oldid, $gradeitem->id, false, null, $oldparentid);
2082     }
2084     protected function process_grade_grade($data) {
2085         $data = (object)($data);
2087         unset($data->id);
2088         $data->itemid = $this->get_new_parentid('grade_item');
2089         $data->userid = $this->get_mappingid('user', $data->userid);
2090         $data->usermodified = $this->get_mappingid('user', $data->usermodified);
2091         $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
2092         // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
2093         $data->overridden = $this->apply_date_offset($data->overridden);
2095         $grade = new grade_grade($data, false);
2096         $grade->insert('restore');
2097         // no need to save any grade_grade mapping
2098     }
2100     /**
2101      * process activity grade_letters. Note that, while these are possible,
2102      * because grade_letters are contextid based, in proctice, only course
2103      * context letters can be defined. So we keep here this method knowing
2104      * it won't be executed ever. gradebook restore will restore course letters.
2105      */
2106     protected function process_grade_letter($data) {
2107         global $DB;
2109         $data = (object)$data;
2111         $data->contextid = $this->task->get_contextid();
2112         $newitemid = $DB->insert_record('grade_letters', $data);
2113         // no need to save any grade_letter mapping
2114     }
2118 /**
2119  * This structure steps restores one instance + positions of one block
2120  * Note: Positions corresponding to one existing context are restored
2121  * here, but all the ones having unknown contexts are sent to backup_ids
2122  * for a later chance to be restored at the end (final task)
2123  */
2124 class restore_block_instance_structure_step extends restore_structure_step {
2126     protected function define_structure() {
2128         $paths = array();
2130         $paths[] = new restore_path_element('block', '/block', true); // Get the whole XML together
2131         $paths[] = new restore_path_element('block_position', '/block/block_positions/block_position');
2133         return $paths;
2134     }
2136     public function process_block($data) {
2137         global $DB, $CFG;
2139         $data = (object)$data; // Handy
2140         $oldcontextid = $data->contextid;
2141         $oldid        = $data->id;
2142         $positions = isset($data->block_positions['block_position']) ? $data->block_positions['block_position'] : array();
2144         // Look for the parent contextid
2145         if (!$data->parentcontextid = $this->get_mappingid('context', $data->parentcontextid)) {
2146             throw new restore_step_exception('restore_block_missing_parent_ctx', $data->parentcontextid);
2147         }
2149         // TODO: it would be nice to use standard plugin supports instead of this instance_allow_multiple()
2150         // If there is already one block of that type in the parent context
2151         // and the block is not multiple, stop processing
2152         // Use blockslib loader / method executor
2153         if (!block_method_result($data->blockname, 'instance_allow_multiple')) {
2154             if ($DB->record_exists_sql("SELECT bi.id
2155                                           FROM {block_instances} bi
2156                                           JOIN {block} b ON b.name = bi.blockname
2157                                          WHERE bi.parentcontextid = ?
2158                                            AND bi.blockname = ?", array($data->parentcontextid, $data->blockname))) {
2159                 return false;
2160             }
2161         }
2163         // If there is already one block of that type in the parent context
2164         // with the same showincontexts, pagetypepattern, subpagepattern, defaultregion and configdata
2165         // stop processing
2166         $params = array(
2167             'blockname' => $data->blockname, 'parentcontextid' => $data->parentcontextid,
2168             'showinsubcontexts' => $data->showinsubcontexts, 'pagetypepattern' => $data->pagetypepattern,
2169             'subpagepattern' => $data->subpagepattern, 'defaultregion' => $data->defaultregion);
2170         if ($birecs = $DB->get_records('block_instances', $params)) {
2171             foreach($birecs as $birec) {
2172                 if ($birec->configdata == $data->configdata) {
2173                     return false;
2174                 }
2175             }
2176         }
2178         // Set task old contextid, blockid and blockname once we know them
2179         $this->task->set_old_contextid($oldcontextid);
2180         $this->task->set_old_blockid($oldid);
2181         $this->task->set_blockname($data->blockname);
2183         // Let's look for anything within configdata neededing processing
2184         // (nulls and uses of legacy file.php)
2185         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
2186             $configdata = (array)unserialize(base64_decode($data->configdata));
2187             foreach ($configdata as $attribute => $value) {
2188                 if (in_array($attribute, $attrstotransform)) {
2189                     $configdata[$attribute] = $this->contentprocessor->process_cdata($value);
2190                 }
2191             }
2192             $data->configdata = base64_encode(serialize((object)$configdata));
2193         }
2195         // Create the block instance
2196         $newitemid = $DB->insert_record('block_instances', $data);
2197         // Save the mapping (with restorefiles support)
2198         $this->set_mapping('block_instance', $oldid, $newitemid, true);
2199         // Create the block context
2200         $newcontextid = get_context_instance(CONTEXT_BLOCK, $newitemid)->id;
2201         // Save the block contexts mapping and sent it to task
2202         $this->set_mapping('context', $oldcontextid, $newcontextid);
2203         $this->task->set_contextid($newcontextid);
2204         $this->task->set_blockid($newitemid);
2206         // Restore block fileareas if declared
2207         $component = 'block_' . $this->task->get_blockname();
2208         foreach ($this->task->get_fileareas() as $filearea) { // Simple match by contextid. No itemname needed
2209             $this->add_related_files($component, $filearea, null);
2210         }
2212         // Process block positions, creating them or accumulating for final step
2213         foreach($positions as $position) {
2214             $position = (object)$position;
2215             $position->blockinstanceid = $newitemid; // The instance is always the restored one
2216             // If position is for one already mapped (known) contextid
2217             // process it now, creating the position
2218             if ($newpositionctxid = $this->get_mappingid('context', $position->contextid)) {
2219                 $position->contextid = $newpositionctxid;
2220                 // Create the block position
2221                 $DB->insert_record('block_positions', $position);
2223             // The position belongs to an unknown context, send it to backup_ids
2224             // to process them as part of the final steps of restore. We send the
2225             // whole $position object there, hence use the low level method.
2226             } else {
2227                 restore_dbops::set_backup_ids_record($this->get_restoreid(), 'block_position', $position->id, 0, null, $position);
2228             }
2229         }
2230     }
2233 /**
2234  * Structure step to restore common course_module information
2235  *
2236  * This step will process the module.xml file for one activity, in order to restore
2237  * the corresponding information to the course_modules table, skipping various bits
2238  * of information based on CFG settings (groupings, completion...) in order to fullfill
2239  * all the reqs to be able to create the context to be used by all the rest of steps
2240  * in the activity restore task
2241  */
2242 class restore_module_structure_step extends restore_structure_step {
2244     protected function define_structure() {
2245         global $CFG;
2247         $paths = array();
2249         $module = new restore_path_element('module', '/module');
2250         $paths[] = $module;
2251         if ($CFG->enableavailability) {
2252             $paths[] = new restore_path_element('availability', '/module/availability_info/availability');
2253         }
2255         // Apply for 'format' plugins optional paths at module level
2256         $this->add_plugin_structure('format', $module);
2258         // Apply for 'plagiarism' plugins optional paths at module level
2259         $this->add_plugin_structure('plagiarism', $module);
2261         return $paths;
2262     }
2264     protected function process_module($data) {
2265         global $CFG, $DB;
2267         $data = (object)$data;
2268         $oldid = $data->id;
2270         $this->task->set_old_moduleversion($data->version);
2272         $data->course = $this->task->get_courseid();
2273         $data->module = $DB->get_field('modules', 'id', array('name' => $data->modulename));
2274         // Map section (first try by course_section mapping match. Useful in course and section restores)
2275         $data->section = $this->get_mappingid('course_section', $data->sectionid);
2276         if (!$data->section) { // mapping failed, try to get section by sectionnumber matching
2277             $params = array(
2278                 'course' => $this->get_courseid(),
2279                 'section' => $data->sectionnumber);
2280             $data->section = $DB->get_field('course_sections', 'id', $params);
2281         }
2282         if (!$data->section) { // sectionnumber failed, try to get first section in course
2283             $params = array(
2284                 'course' => $this->get_courseid());
2285             $data->section = $DB->get_field('course_sections', 'MIN(id)', $params);
2286         }
2287         if (!$data->section) { // no sections in course, create section 0 and 1 and assign module to 1
2288             $sectionrec = array(
2289                 'course' => $this->get_courseid(),
2290                 'section' => 0);
2291             $DB->insert_record('course_sections', $sectionrec); // section 0
2292             $sectionrec = array(
2293                 'course' => $this->get_courseid(),
2294                 'section' => 1);
2295             $data->section = $DB->insert_record('course_sections', $sectionrec); // section 1
2296         }
2297         $data->groupingid= $this->get_mappingid('grouping', $data->groupingid);      // grouping
2298         if (!$CFG->enablegroupmembersonly) {                                         // observe groupsmemberonly
2299             $data->groupmembersonly = 0;
2300         }
2301         if (!grade_verify_idnumber($data->idnumber, $this->get_courseid())) {        // idnumber uniqueness
2302             $data->idnumber = '';
2303         }
2304         if (empty($CFG->enablecompletion)) { // completion
2305             $data->completion = 0;
2306             $data->completiongradeitemnumber = null;
2307             $data->completionview = 0;
2308             $data->completionexpected = 0;
2309         } else {
2310             $data->completionexpected = $this->apply_date_offset($data->completionexpected);
2311         }
2312         if (empty($CFG->enableavailability)) {
2313             $data->availablefrom = 0;
2314             $data->availableuntil = 0;
2315             $data->showavailability = 0;
2316         } else {
2317             $data->availablefrom = $this->apply_date_offset($data->availablefrom);
2318             $data->availableuntil= $this->apply_date_offset($data->availableuntil);
2319         }
2320         // Backups that did not include showdescription, set it to default 0
2321         // (this is not totally necessary as it has a db default, but just to
2322         // be explicit).
2323         if (!isset($data->showdescription)) {
2324             $data->showdescription = 0;
2325         }
2326         $data->instance = 0; // Set to 0 for now, going to create it soon (next step)
2328         // course_module record ready, insert it
2329         $newitemid = $DB->insert_record('course_modules', $data);
2330         // save mapping
2331         $this->set_mapping('course_module', $oldid, $newitemid);
2332         // set the new course_module id in the task
2333         $this->task->set_moduleid($newitemid);
2334         // we can now create the context safely
2335         $ctxid = get_context_instance(CONTEXT_MODULE, $newitemid)->id;
2336         // set the new context id in the task
2337         $this->task->set_contextid($ctxid);
2338         // update sequence field in course_section
2339         if ($sequence = $DB->get_field('course_sections', 'sequence', array('id' => $data->section))) {
2340             $sequence .= ',' . $newitemid;
2341         } else {
2342             $sequence = $newitemid;
2343         }
2344         $DB->set_field('course_sections', 'sequence', $sequence, array('id' => $data->section));
2345     }
2348     protected function process_availability($data) {
2349         $data = (object)$data;
2350         // Simply going to store the whole availability record now, we'll process
2351         // all them later in the final task (once all actvivities have been restored)
2352         // Let's call the low level one to be able to store the whole object
2353         $data->coursemoduleid = $this->task->get_moduleid(); // Let add the availability cmid
2354         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'module_availability', $data->id, 0, null, $data);
2355     }
2358 /**
2359  * Structure step that will process the user activity completion
2360  * information if all these conditions are met:
2361  *  - Target site has completion enabled ($CFG->enablecompletion)
2362  *  - Activity includes completion info (file_exists)
2363  */
2364 class restore_userscompletion_structure_step extends restore_structure_step {
2365     private $done = array();
2367     /**
2368      * To conditionally decide if this step must be executed
2369      * Note the "settings" conditions are evaluated in the
2370      * corresponding task. Here we check for other conditions
2371      * not being restore settings (files, site settings...)
2372      */
2373      protected function execute_condition() {
2374          global $CFG;
2376          // Completion disabled in this site, don't execute
2377          if (empty($CFG->enablecompletion)) {
2378              return false;
2379          }
2381          // No user completion info found, don't execute
2382         $fullpath = $this->task->get_taskbasepath();
2383         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2384          if (!file_exists($fullpath)) {
2385              return false;
2386          }
2388          // Arrived here, execute the step
2389          return true;
2390      }
2392      protected function define_structure() {
2394         $paths = array();
2396         $paths[] = new restore_path_element('completion', '/completions/completion');
2398         return $paths;
2399     }
2401     protected function process_completion($data) {
2402         global $DB;
2404         $data = (object)$data;
2406         $data->coursemoduleid = $this->task->get_moduleid();
2407         $data->userid = $this->get_mappingid('user', $data->userid);
2408         $data->timemodified = $this->apply_date_offset($data->timemodified);
2410         // Check we didn't already insert one for this cmid and userid
2411         // (there aren't supposed to be duplicates in that field, but
2412         // it was possible until MDL-28021 was fixed).
2413         $key = $data->coursemoduleid . ',' . $data->userid;
2414         if (array_key_exists($key, $this->done)) {
2415             // Find the existing record
2416             $existing = $DB->get_record('course_modules_completion', array(
2417                     'coursemoduleid' => $data->coursemoduleid,
2418                     'userid' => $data->userid), 'id, timemodified');
2419             // Update it to these new values, but only if the time is newer
2420             if ($existing->timemodified < $data->timemodified) {
2421                 $data->id = $existing->id;
2422                 $DB->update_record('course_modules_completion', $data);
2423             }
2424         } else {
2425             // Normal entry where it doesn't exist already
2426             $DB->insert_record('course_modules_completion', $data);
2427             // Remember this entry
2428             $this->done[$key] = true;
2429         }
2430     }
2432     protected function after_execute() {
2433         // This gets called once per activity (according to my testing).
2434         // Clearing the array isn't strictly required, but avoids using
2435         // unnecessary memory.
2436         $this->done = array();
2437     }
2440 /**
2441  * Abstract structure step, parent of all the activity structure steps. Used to suuport
2442  * the main <activity ...> tag and process it. Also provides subplugin support for
2443  * activities.
2444  */
2445 abstract class restore_activity_structure_step extends restore_structure_step {
2447     protected function add_subplugin_structure($subplugintype, $element) {
2449         global $CFG;
2451         // Check the requested subplugintype is a valid one
2452         $subpluginsfile = $CFG->dirroot . '/mod/' . $this->task->get_modulename() . '/db/subplugins.php';
2453         if (!file_exists($subpluginsfile)) {
2454              throw new restore_step_exception('activity_missing_subplugins_php_file', $this->task->get_modulename());
2455         }
2456         include($subpluginsfile);
2457         if (!array_key_exists($subplugintype, $subplugins)) {
2458              throw new restore_step_exception('incorrect_subplugin_type', $subplugintype);
2459         }
2460         // Get all the restore path elements, looking across all the subplugin dirs
2461         $subpluginsdirs = get_plugin_list($subplugintype);
2462         foreach ($subpluginsdirs as $name => $subpluginsdir) {
2463             $classname = 'restore_' . $subplugintype . '_' . $name . '_subplugin';
2464             $restorefile = $subpluginsdir . '/backup/moodle2/' . $classname . '.class.php';
2465             if (file_exists($restorefile)) {
2466                 require_once($restorefile);
2467                 $restoresubplugin = new $classname($subplugintype, $name, $this);
2468                 // Add subplugin paths to the step
2469                 $this->prepare_pathelements($restoresubplugin->define_subplugin_structure($element));
2470             }
2471         }
2472     }
2474     /**
2475      * As far as activity restore steps are implementing restore_subplugin stuff, they need to
2476      * have the parent task available for wrapping purposes (get course/context....)
2477      * @return restore_task
2478      */
2479     public function get_task() {
2480         return $this->task;
2481     }
2483     /**
2484      * Adds support for the 'activity' path that is common to all the activities
2485      * and will be processed globally here
2486      */
2487     protected function prepare_activity_structure($paths) {
2489         $paths[] = new restore_path_element('activity', '/activity');
2491         return $paths;
2492     }
2494     /**
2495      * Process the activity path, informing the task about various ids, needed later
2496      */
2497     protected function process_activity($data) {
2498         $data = (object)$data;
2499         $this->task->set_old_contextid($data->contextid); // Save old contextid in task
2500         $this->set_mapping('context', $data->contextid, $this->task->get_contextid()); // Set the mapping
2501         $this->task->set_old_activityid($data->id); // Save old activityid in task
2502     }
2504     /**
2505      * This must be invoked immediately after creating the "module" activity record (forum, choice...)
2506      * and will adjust the new activity id (the instance) in various places
2507      */
2508     protected function apply_activity_instance($newitemid) {
2509         global $DB;
2511         $this->task->set_activityid($newitemid); // Save activity id in task
2512         // Apply the id to course_sections->instanceid
2513         $DB->set_field('course_modules', 'instance', $newitemid, array('id' => $this->task->get_moduleid()));
2514         // Do the mapping for modulename, preparing it for files by oldcontext
2515         $modulename = $this->task->get_modulename();
2516         $oldid = $this->task->get_old_activityid();
2517         $this->set_mapping($modulename, $oldid, $newitemid, true);
2518     }
2521 /**
2522  * Structure step in charge of creating/mapping all the qcats and qs
2523  * by parsing the questions.xml file and checking it against the
2524  * results calculated by {@link restore_process_categories_and_questions}
2525  * and stored in backup_ids_temp
2526  */
2527 class restore_create_categories_and_questions extends restore_structure_step {
2529     protected function define_structure() {
2531         $category = new restore_path_element('question_category', '/question_categories/question_category');
2532         $question = new restore_path_element('question', '/question_categories/question_category/questions/question');
2533         $hint = new restore_path_element('question_hint',
2534                 '/question_categories/question_category/questions/question/question_hints/question_hint');
2536         // Apply for 'qtype' plugins optional paths at question level
2537         $this->add_plugin_structure('qtype', $question);
2539         return array($category, $question, $hint);
2540     }
2542     protected function process_question_category($data) {
2543         global $DB;
2545         $data = (object)$data;
2546         $oldid = $data->id;
2548         // Check we have one mapping for this category
2549         if (!$mapping = $this->get_mapping('question_category', $oldid)) {
2550             return self::SKIP_ALL_CHILDREN; // No mapping = this category doesn't need to be created/mapped
2551         }
2553         // Check we have to create the category (newitemid = 0)
2554         if ($mapping->newitemid) {
2555             return; // newitemid != 0, this category is going to be mapped. Nothing to do
2556         }
2558         // Arrived here, newitemid = 0, we need to create the category
2559         // we'll do it at parentitemid context, but for CONTEXT_MODULE
2560         // categories, that will be created at CONTEXT_COURSE and moved
2561         // to module context later when the activity is created
2562         if ($mapping->info->contextlevel == CONTEXT_MODULE) {
2563             $mapping->parentitemid = $this->get_mappingid('context', $this->task->get_old_contextid());
2564         }
2565         $data->contextid = $mapping->parentitemid;
2567         // Let's create the question_category and save mapping
2568         $newitemid = $DB->insert_record('question_categories', $data);
2569         $this->set_mapping('question_category', $oldid, $newitemid);
2570         // Also annotate them as question_category_created, we need
2571         // that later when remapping parents
2572         $this->set_mapping('question_category_created', $oldid, $newitemid, false, null, $data->contextid);
2573     }
2575     protected function process_question($data) {
2576         global $DB;
2578         $data = (object)$data;
2579         $oldid = $data->id;
2581         // Check we have one mapping for this question
2582         if (!$questionmapping = $this->get_mapping('question', $oldid)) {
2583             return; // No mapping = this question doesn't need to be created/mapped
2584         }
2586         // Get the mapped category (cannot use get_new_parentid() because not
2587         // all the categories have been created, so it is not always available
2588         // Instead we get the mapping for the question->parentitemid because
2589         // we have loaded qcatids there for all parsed questions
2590         $data->category = $this->get_mappingid('question_category', $questionmapping->parentitemid);
2592         // In the past, there were some very sloppy values of penalty. Fix them.
2593         if ($data->penalty >= 0.33 && $data->penalty <= 0.34) {
2594             $data->penalty = 0.3333333;
2595         }
2596         if ($data->penalty >= 0.66 && $data->penalty <= 0.67) {
2597             $data->penalty = 0.6666667;
2598         }
2599         if ($data->penalty >= 1) {
2600             $data->penalty = 1;
2601         }
2603         $data->timecreated  = $this->apply_date_offset($data->timecreated);
2604         $data->timemodified = $this->apply_date_offset($data->timemodified);
2606         $userid = $this->get_mappingid('user', $data->createdby);
2607         $data->createdby = $userid ? $userid : $this->task->get_userid();
2609         $userid = $this->get_mappingid('user', $data->modifiedby);
2610         $data->modifiedby = $userid ? $userid : $this->task->get_userid();
2612         // With newitemid = 0, let's create the question
2613         if (!$questionmapping->newitemid) {
2614             $newitemid = $DB->insert_record('question', $data);
2615             $this->set_mapping('question', $oldid, $newitemid);
2616             // Also annotate them as question_created, we need
2617             // that later when remapping parents (keeping the old categoryid as parentid)
2618             $this->set_mapping('question_created', $oldid, $newitemid, false, null, $questionmapping->parentitemid);
2619         } else {
2620             // By performing this set_mapping() we make get_old/new_parentid() to work for all the
2621             // children elements of the 'question' one (so qtype plugins will know the question they belong to)
2622             $this->set_mapping('question', $oldid, $questionmapping->newitemid);
2623         }
2625         // Note, we don't restore any question files yet
2626         // as far as the CONTEXT_MODULE categories still
2627         // haven't their contexts to be restored to
2628         // The {@link restore_create_question_files}, executed in the final step
2629         // step will be in charge of restoring all the question files
2630     }
2632         protected function process_question_hint($data) {
2633         global $DB;
2635         $data = (object)$data;
2636         $oldid = $data->id;
2638         // Detect if the question is created or mapped
2639         $oldquestionid   = $this->get_old_parentid('question');
2640         $newquestionid   = $this->get_new_parentid('question');
2641         $questioncreated = $this->get_mappingid('question_created', $oldquestionid) ? true : false;
2643         // If the question has been created by restore, we need to create its question_answers too
2644         if ($questioncreated) {
2645             // Adjust some columns
2646             $data->questionid = $newquestionid;
2647             // Insert record
2648             $newitemid = $DB->insert_record('question_hints', $data);
2650         // The question existed, we need to map the existing question_hints
2651         } else {
2652             // Look in question_hints by hint text matching
2653             $sql = 'SELECT id
2654                       FROM {question_hints}
2655                      WHERE questionid = ?
2656                        AND ' . $DB->sql_compare_text('hint', 255) . ' = ' . $DB->sql_compare_text('?', 255);
2657             $params = array($newquestionid, $data->hint);
2658             $newitemid = $DB->get_field_sql($sql, $params);
2659             // If we haven't found the newitemid, something has gone really wrong, question in DB
2660             // is missing hints, exception
2661             if (!$newitemid) {
2662                 $info = new stdClass();
2663                 $info->filequestionid = $oldquestionid;
2664                 $info->dbquestionid   = $newquestionid;
2665                 $info->hint           = $data->hint;
2666                 throw new restore_step_exception('error_question_hint_missing_in_db', $info);
2667             }
2668         }
2669         // Create mapping (I'm not sure if this is really needed?)
2670         $this->set_mapping('question_hint', $oldid, $newitemid);
2671     }
2673     protected function after_execute() {
2674         global $DB;
2676         // First of all, recode all the created question_categories->parent fields
2677         $qcats = $DB->get_records('backup_ids_temp', array(
2678                      'backupid' => $this->get_restoreid(),
2679                      'itemname' => 'question_category_created'));
2680         foreach ($qcats as $qcat) {
2681             $newparent = 0;
2682             $dbcat = $DB->get_record('question_categories', array('id' => $qcat->newitemid));
2683             // Get new parent (mapped or created, so we look in quesiton_category mappings)
2684             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
2685                                  'backupid' => $this->get_restoreid(),
2686                                  'itemname' => 'question_category',
2687                                  'itemid'   => $dbcat->parent))) {
2688                 // contextids must match always, as far as we always include complete qbanks, just check it
2689                 $newparentctxid = $DB->get_field('question_categories', 'contextid', array('id' => $newparent));
2690                 if ($dbcat->contextid == $newparentctxid) {
2691                     $DB->set_field('question_categories', 'parent', $newparent, array('id' => $dbcat->id));
2692                 } else {
2693                     $newparent = 0; // No ctx match for both cats, no parent relationship
2694                 }
2695             }
2696             // Here with $newparent empty, problem with contexts or remapping, set it to top cat
2697             if (!$newparent) {
2698                 $DB->set_field('question_categories', 'parent', 0, array('id' => $dbcat->id));
2699             }
2700         }
2702         // Now, recode all the created question->parent fields
2703         $qs = $DB->get_records('backup_ids_temp', array(
2704                   'backupid' => $this->get_restoreid(),
2705                   'itemname' => 'question_created'));
2706         foreach ($qs as $q) {
2707             $newparent = 0;
2708             $dbq = $DB->get_record('question', array('id' => $q->newitemid));
2709             // Get new parent (mapped or created, so we look in question mappings)
2710             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
2711                                  'backupid' => $this->get_restoreid(),
2712                                  'itemname' => 'question',
2713                                  'itemid'   => $dbq->parent))) {
2714                 $DB->set_field('question', 'parent', $newparent, array('id' => $dbq->id));
2715             }
2716         }
2718         // Note, we don't restore any question files yet
2719         // as far as the CONTEXT_MODULE categories still
2720         // haven't their contexts to be restored to
2721         // The {@link restore_create_question_files}, executed in the final step
2722         // step will be in charge of restoring all the question files
2723     }
2726 /**
2727  * Execution step that will move all the CONTEXT_MODULE question categories
2728  * created at early stages of restore in course context (because modules weren't
2729  * created yet) to their target module (matching by old-new-contextid mapping)
2730  */
2731 class restore_move_module_questions_categories extends restore_execution_step {
2733     protected function define_execution() {
2734         global $DB;
2736         $contexts = restore_dbops::restore_get_question_banks($this->get_restoreid(), CONTEXT_MODULE);
2737         foreach ($contexts as $contextid => $contextlevel) {
2738             // Only if context mapping exists (i.e. the module has been restored)
2739             if ($newcontext = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $contextid)) {
2740                 // Update all the qcats having their parentitemid set to the original contextid
2741                 $modulecats = $DB->get_records_sql("SELECT itemid, newitemid
2742                                                       FROM {backup_ids_temp}
2743                                                      WHERE backupid = ?
2744                                                        AND itemname = 'question_category'
2745                                                        AND parentitemid = ?", array($this->get_restoreid(), $contextid));
2746                 foreach ($modulecats as $modulecat) {
2747                     $DB->set_field('question_categories', 'contextid', $newcontext->newitemid, array('id' => $modulecat->newitemid));
2748                     // And set new contextid also in question_category mapping (will be
2749                     // used by {@link restore_create_question_files} later
2750                     restore_dbops::set_backup_ids_record($this->get_restoreid(), 'question_category', $modulecat->itemid, $modulecat->newitemid, $newcontext->newitemid);
2751                 }
2752             }
2753         }
2754     }
2757 /**
2758  * Execution step that will create all the question/answers/qtype-specific files for the restored
2759  * questions. It must be executed after {@link restore_move_module_questions_categories}
2760  * because only then each question is in its final category and only then the
2761  * context can be determined
2762  *
2763  * TODO: Improve this. Instead of looping over each question, it can be reduced to
2764  *       be done by contexts (this will save a huge ammount of queries)
2765  */
2766 class restore_create_question_files extends restore_execution_step {
2768     protected function define_execution() {
2769         global $DB;
2771         // Let's process only created questions
2772         $questionsrs = $DB->get_recordset_sql("SELECT bi.itemid, bi.newitemid, bi.parentitemid, q.qtype
2773                                                FROM {backup_ids_temp} bi
2774                                                JOIN {question} q ON q.id = bi.newitemid
2775                                               WHERE bi.backupid = ?
2776                                                 AND bi.itemname = 'question_created'", array($this->get_restoreid()));
2777         foreach ($questionsrs as $question) {
2778             // Get question_category mapping, it contains the target context for the question
2779             if (!$qcatmapping = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'question_category', $question->parentitemid)) {
2780                 // Something went really wrong, cannot find the question_category for the question
2781                 debugging('Error fetching target context for question', DEBUG_DEVELOPER);
2782                 continue;
2783             }
2784             // Calculate source and target contexts
2785             $oldctxid = $qcatmapping->info->contextid;
2786             $newctxid = $qcatmapping->parentitemid;
2788             // Add common question files (question and question_answer ones)
2789             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'questiontext',
2790                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
2791             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'generalfeedback',
2792                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
2793             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'answer',
2794                                               $oldctxid, $this->task->get_userid(), 'question_answer', null, $newctxid, true);
2795             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'answerfeedback',
2796                                               $oldctxid, $this->task->get_userid(), 'question_answer', null, $newctxid, true);
2797             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'hint',
2798                                               $oldctxid, $this->task->get_userid(), 'question_hint', null, $newctxid, true);
2799             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'correctfeedback',
2800                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
2801             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'partiallycorrectfeedback',
2802                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
2803             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'incorrectfeedback',
2804                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
2805             // Add qtype dependent files
2806             $components = backup_qtype_plugin::get_components_and_fileareas($question->qtype);
2807             foreach ($components as $component => $fileareas) {
2808                 foreach ($fileareas as $filearea => $mapping) {
2809                     // Use itemid only if mapping is question_created
2810                     $itemid = ($mapping == 'question_created') ? $question->itemid : null;
2811                     restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), $component, $filearea,
2812                                                       $oldctxid, $this->task->get_userid(), $mapping, $itemid, $newctxid, true);
2813                 }
2814             }
2815         }
2816         $questionsrs->close();
2817     }
2820 /**
2821  * Abstract structure step, to be used by all the activities using core questions stuff
2822  * (like the quiz module), to support qtype plugins, states and sessions
2823  */
2824 abstract class restore_questions_activity_structure_step extends restore_activity_structure_step {
2825     /** @var array question_attempt->id to qtype. */
2826     protected $qtypes = array();
2827     /** @var array question_attempt->id to questionid. */
2828     protected $newquestionids = array();
2830     /**
2831      * Attach below $element (usually attempts) the needed restore_path_elements
2832      * to restore question_usages and all they contain.
2833      */
2834     protected function add_question_usages($element, &$paths) {
2835         // Check $element is restore_path_element
2836         if (! $element instanceof restore_path_element) {
2837             throw new restore_step_exception('element_must_be_restore_path_element', $element);
2838         }
2839         // Check $paths is one array
2840         if (!is_array($paths)) {
2841             throw new restore_step_exception('paths_must_be_array', $paths);
2842         }
2843         $paths[] = new restore_path_element('question_usage',
2844                 $element->get_path() . '/question_usage');
2845         $paths[] = new restore_path_element('question_attempt',
2846                 $element->get_path() . '/question_usage/question_attempts/question_attempt');
2847         $paths[] = new restore_path_element('question_attempt_step',
2848                 $element->get_path() . '/question_usage/question_attempts/question_attempt/steps/step',
2849                 true);
2850         $paths[] = new restore_path_element('question_attempt_step_data',
2851                 $element->get_path() . '/question_usage/question_attempts/question_attempt/steps/step/response/variable');
2852     }
2854     /**
2855      * Process question_usages
2856      */
2857     protected function process_question_usage($data) {
2858         global $DB;
2860         // Clear our caches.
2861         $this->qtypes = array();
2862         $this->newquestionids = array();
2864         $data = (object)$data;
2865         $oldid = $data->id;
2867         $oldcontextid = $this->get_task()->get_old_contextid();
2868         $data->contextid  = $this->get_mappingid('context', $this->task->get_old_contextid());
2870         // Everything ready, insert (no mapping needed)
2871         $newitemid = $DB->insert_record('question_usages', $data);
2873         $this->inform_new_usage_id($newitemid);
2875         $this->set_mapping('question_usage', $oldid, $newitemid, false);
2876     }
2878     /**
2879      * When process_question_usage creates the new usage, it calls this method
2880      * to let the activity link to the new usage. For example, the quiz uses
2881      * this method to set quiz_attempts.uniqueid to the new usage id.
2882      * @param integer $newusageid
2883      */
2884     abstract protected function inform_new_usage_id($newusageid);
2886     /**
2887      * Process question_attempts
2888      */
2889     protected function process_question_attempt($data) {
2890         global $DB;
2892         $data = (object)$data;
2893         $oldid = $data->id;
2894         $question = $this->get_mapping('question', $data->questionid);
2896         $data->questionusageid = $this->get_new_parentid('question_usage');
2897         $data->questionid      = $question->newitemid;
2898         $data->timemodified    = $this->apply_date_offset($data->timemodified);
2900         $newitemid = $DB->insert_record('question_attempts', $data);
2902         $this->set_mapping('question_attempt', $oldid, $newitemid);
2903         $this->qtypes[$newitemid] = $question->info->qtype;
2904         $this->newquestionids[$newitemid] = $data->questionid;
2905     }
2907     /**
2908      * Process question_attempt_steps
2909      */
2910     protected function process_question_attempt_step($data) {
2911         global $DB;
2913         $data = (object)$data;
2914         $oldid = $data->id;
2916         // Pull out the response data.
2917         $response = array();
2918         if (!empty($data->response['variable'])) {
2919             foreach ($data->response['variable'] as $variable) {
2920                 $response[$variable['name']] = $variable['value'];
2921             }
2922         }
2923         unset($data->response);
2925         $data->questionattemptid = $this->get_new_parentid('question_attempt');
2926         $data->timecreated = $this->apply_date_offset($data->timecreated);
2927         $data->userid      = $this->get_mappingid('user', $data->userid);
2929         // Everything ready, insert and create mapping (needed by question_sessions)
2930         $newitemid = $DB->insert_record('question_attempt_steps', $data);
2931         $this->set_mapping('question_attempt_step', $oldid, $newitemid, true);
2933         // Now process the response data.
2934         $response = $this->questions_recode_response_data(
2935                 $this->qtypes[$data->questionattemptid],
2936                 $this->newquestionids[$data->questionattemptid],
2937                 $data->sequencenumber, $response);
2938         foreach ($response as $name => $value) {
2939             $row = new stdClass();
2940             $row->attemptstepid = $newitemid;
2941             $row->name = $name;
2942             $row->value = $value;
2943             $DB->insert_record('question_attempt_step_data', $row, false);
2944         }
2945     }
2947     /**
2948      * Recode the respones data for a particular step of an attempt at at particular question.
2949      * @param string $qtype the question type.
2950      * @param int $newquestionid the question id.
2951      * @param int $sequencenumber the sequence number.
2952      * @param array $response the response data to recode.
2953      */
2954     public function questions_recode_response_data(
2955             $qtype, $newquestionid, $sequencenumber, array $response) {
2956         $qtyperestorer = $this->get_qtype_restorer($qtype);
2957         if ($qtyperestorer) {
2958             $response = $qtyperestorer->recode_response($newquestionid, $sequencenumber, $response);
2959         }
2960         return $response;
2961     }
2963     /**
2964      * Given a list of question->ids, separated by commas, returns the
2965      * recoded list, with all the restore question mappings applied.
2966      * Note: Used by quiz->questions and quiz_attempts->layout
2967      * Note: 0 = page break (unconverted)
2968      */
2969     protected function questions_recode_layout($layout) {
2970         // Extracts question id from sequence
2971         if ($questionids = explode(',', $layout)) {
2972             foreach ($questionids as $id => $questionid) {
2973                 if ($questionid) { // If it is zero then this is a pagebreak, don't translate
2974                     $newquestionid = $this->get_mappingid('question', $questionid);
2975                     $questionids[$id] = $newquestionid;
2976                 }
2977             }
2978         }
2979         return implode(',', $questionids);
2980     }
2982     /**
2983      * Get the restore_qtype_plugin subclass for a specific question type.
2984      * @param string $qtype e.g. multichoice.
2985      * @return restore_qtype_plugin instance.
2986      */
2987     protected function get_qtype_restorer($qtype) {
2988         // Build one static cache to store {@link restore_qtype_plugin}
2989         // while we are needing them, just to save zillions of instantiations
2990         // or using static stuff that will break our nice API
2991         static $qtypeplugins = array();
2993         if (!isset($qtypeplugins[$qtype])) {
2994             $classname = 'restore_qtype_' . $qtype . '_plugin';
2995             if (class_exists($classname)) {
2996                 $qtypeplugins[$qtype] = new $classname('qtype', $qtype, $this);
2997             } else {
2998                 $qtypeplugins[$qtype] = null;
2999             }
3000         }
3001         return $qtypeplugins[$qtype];
3002     }
3004     protected function after_execute() {
3005         parent::after_execute();
3007         // Restore any files belonging to responses.
3008         foreach (question_engine::get_all_response_file_areas() as $filearea) {
3009             $this->add_related_files('question', $filearea, 'question_attempt_step');
3010         }
3011     }
3013     /**
3014      * Attach below $element (usually attempts) the needed restore_path_elements
3015      * to restore question attempt data from Moodle 2.0.
3016      *
3017      * When using this method, the parent element ($element) must be defined with
3018      * $grouped = true. Then, in that elements process method, you must call
3019      * {@link process_legacy_attempt_data()} with the groupded data. See, for
3020      * example, the usage of this method in {@link restore_quiz_activity_structure_step}.
3021      * @param restore_path_element $element the parent element. (E.g. a quiz attempt.)
3022      * @param array $paths the paths array that is being built to describe the
3023      *      structure.
3024      */
3025     protected function add_legacy_question_attempt_data($element, &$paths) {
3026         global $CFG;
3027         require_once($CFG->dirroot . '/question/engine/upgrade/upgradelib.php');
3029         // Check $element is restore_path_element
3030         if (!($element instanceof restore_path_element)) {
3031             throw new restore_step_exception('element_must_be_restore_path_element', $element);
3032         }
3033         // Check $paths is one array
3034         if (!is_array($paths)) {
3035             throw new restore_step_exception('paths_must_be_array', $paths);
3036         }
3038         $paths[] = new restore_path_element('question_state',
3039                 $element->get_path() . '/states/state');
3040         $paths[] = new restore_path_element('question_session',
3041                 $element->get_path() . '/sessions/session');
3042     }
3044     protected function get_attempt_upgrader() {
3045         if (empty($this->attemptupgrader)) {
3046             $this->attemptupgrader = new question_engine_attempt_upgrader();
3047             $this->attemptupgrader->prepare_to_restore();
3048         }
3049         return $this->attemptupgrader;
3050     }
3052     /**
3053      * Process the attempt data defined by {@link add_legacy_question_attempt_data()}.
3054      * @param object $data contains all the grouped attempt data ot process.
3055      * @param pbject $quiz data about the activity the attempts belong to. Required
3056      * fields are (basically this only works for the quiz module):
3057      *      oldquestions => list of question ids in this activity - using old ids.
3058      *      preferredbehaviour => the behaviour to use for questionattempts.
3059      */
3060     protected function process_legacy_quiz_attempt_data($data, $quiz) {
3061         global $DB;
3062         $upgrader = $this->get_attempt_upgrader();
3064         $data = (object)$data;
3066         $layout = explode(',', $data->layout);
3067         $newlayout = $layout;
3069         // Convert each old question_session into a question_attempt.
3070         $qas = array();
3071         foreach (explode(',', $quiz->oldquestions) as $questionid) {
3072             if ($questionid == 0) {
3073                 continue;
3074             }
3076             $newquestionid = $this->get_mappingid('question', $questionid);
3077             if (!$newquestionid) {
3078                 throw new restore_step_exception('questionattemptreferstomissingquestion',
3079                         $questionid, $questionid);
3080             }
3082             $question = $upgrader->load_question($newquestionid, $quiz->id);
3084             foreach ($layout as $key => $qid) {
3085                 if ($qid == $questionid) {
3086                     $newlayout[$key] = $newquestionid;
3087                 }
3088             }
3090             list($qsession, $qstates) = $this->find_question_session_and_states(
3091                     $data, $questionid);
3093             if (empty($qsession) || empty($qstates)) {
3094                 throw new restore_step_exception('questionattemptdatamissing',
3095                         $questionid, $questionid);
3096             }
3098             list($qsession, $qstates) = $this->recode_legacy_response_data(
3099                     $question, $qsession, $qstates);
3101             $data->layout = implode(',', $newlayout);
3102             $qas[$newquestionid] = $upgrader->convert_question_attempt(
3103                     $quiz, $data, $question, $qsession, $qstates);
3104         }
3106         // Now create a new question_usage.
3107         $usage = new stdClass();
3108         $usage->component = 'mod_quiz';
3109         $usage->contextid = $this->get_mappingid('context', $this->task->get_old_contextid());
3110         $usage->preferredbehaviour = $quiz->preferredbehaviour;
3111         $usage->id = $DB->insert_record('question_usages', $usage);
3113         $this->inform_new_usage_id($usage->id);
3115         $data->uniqueid = $usage->id;
3116         $upgrader->save_usage($quiz->preferredbehaviour, $data, $qas, $quiz->questions);
3117     }
3119     protected function find_question_session_and_states($data, $questionid) {
3120         $qsession = null;
3121         foreach ($data->sessions['session'] as $session) {
3122             if ($session['questionid'] == $questionid) {
3123                 $qsession = (object) $session;
3124                 break;
3125             }
3126         }
3128         $qstates = array();
3129         foreach ($data->states['state'] as $state) {
3130             if ($state['question'] == $questionid) {
3131                 // It would be natural to use $state['seq_number'] as the array-key
3132                 // here, but it seems that buggy behaviour in 2.0 and early can
3133                 // mean that that is not unique, so we use id, which is guaranteed
3134                 // to be unique.
3135                 $qstates[$state['id']] = (object) $state;
3136             }
3137         }
3138         ksort($qstates);
3139         $qstates = array_values($qstates);
3141         return array($qsession, $qstates);
3142     }
3144     /**
3145      * Recode any ids in the response data
3146      * @param object $question the question data
3147      * @param object $qsession the question sessions.
3148      * @param array $qstates the question states.
3149      */
3150     protected function recode_legacy_response_data($question, $qsession, $qstates) {
3151         $qsession->questionid = $question->id;
3153         foreach ($qstates as &$state) {
3154             $state->question = $question->id;
3155             $state->answer = $this->restore_recode_legacy_answer($state, $question->qtype);
3156         }
3158         return array($qsession, $qstates);
3159     }
3161     /**
3162      * Recode the legacy answer field.
3163      * @param object $state the state to recode the answer of.
3164      * @param string $qtype the question type.
3165      */
3166     public function restore_recode_legacy_answer($state, $qtype) {
3167         $restorer = $this->get_qtype_restorer($qtype);
3168         if ($restorer) {
3169             return $restorer->recode_legacy_state_answer($state);
3170         } else {
3171             return $state->answer;
3172         }
3173     }