MDL-22138 backup - I know smaller cathedrals than this, yay quizzes!
[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         //manual grade items store category id in categoryid
150         if ($data->itemtype=='manual') {
151             $data->categoryid = $this->get_mappingid('grade_category', $data->categoryid);
152         } //course and category grade items store their category id in iteminstance
153         else if ($data->itemtype=='course' || $data->itemtype=='category') {
154             $data->iteminstance = $this->get_mappingid('grade_category', $data->iteminstance);
155         }
157         $data->scaleid   = $this->get_mappingid('scale', $data->scaleid);
158         $data->outcomeid = $this->get_mappingid('outcome', $data->outcomeid);
160         $data->locktime     = $this->apply_date_offset($data->locktime);
161         $data->timecreated  = $this->apply_date_offset($data->timecreated);
162         $data->timemodified = $this->apply_date_offset($data->timemodified);
164         $coursecategory = $newitemid = null;
165         //course grade item should already exist so updating instead of inserting
166         if($data->itemtype=='course') {
168             //get the ID of the already created grade item
169             $gi = new stdclass();
170             $gi->courseid  = $this->get_courseid();
172             $gi->itemtype  = $data->itemtype;
173             if ($data->itemtype=='course') {
174                 //need to get the id of the grade_category that was automatically created for the course
175                 $category = new stdclass();
176                 $category->courseid  = $this->get_courseid();
177                 $category->parent  = null;
178                 //course category fullname starts out as ? but may be edited
179                 //$category->fullname  = '?';
181                 $coursecategory = $DB->get_record('grade_categories', (array)$category);
182                 $gi->iteminstance = $coursecategory->id;
183             }
185             $existinggradeitem = $DB->get_record('grade_items', (array)$gi);
186             if (!empty($existinggradeitem)) {
187                 $data->id = $newitemid = $existinggradeitem->id;
188                 $DB->update_record('grade_items', $data);
189             }
190         }
192         if (empty($newitemid)) {
193             //in case we found the course category but still need to insert the course grade item
194             if ($data->itemtype=='course' && !empty($coursecategory)) {
195                 $data->iteminstance = $coursecategory->id;
196             }
198             $newitemid = $DB->insert_record('grade_items', $data);
199         }
200         $this->set_mapping('grade_item', $oldid, $newitemid);
201     }
203     protected function process_grade_grade($data) {
204         global $DB;
206         $data = (object)$data;
207         $oldid = $data->id;
209         $data->itemid = $this->get_new_parentid('grade_item');
211         $data->userid = $this->get_mappingid('user', $data->userid);
212         $data->usermodified = $this->get_mappingid('user', $data->usermodified);
213         $data->locktime     = $this->apply_date_offset($data->locktime);
214         // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
215         $data->overridden = $this->apply_date_offset($data->overridden);
216         $data->timecreated  = $this->apply_date_offset($data->timecreated);
217         $data->timemodified = $this->apply_date_offset($data->timemodified);
219         $newitemid = $DB->insert_record('grade_grades', $data);
220         //$this->set_mapping('grade_grade', $oldid, $newitemid);
221     }
222     protected function process_grade_category($data) {
223         global $DB;
225         $data = (object)$data;
226         $oldid = $data->id;
228         $data->course = $this->get_courseid();
229         $data->courseid = $data->course;
231         $data->timecreated  = $this->apply_date_offset($data->timecreated);
232         $data->timemodified = $this->apply_date_offset($data->timemodified);
234         $newitemid = null;
235         //no parent means a course level grade category. That may have been created when the course was created
236         if(empty($data->parent)) {
237             //parent was being saved as 0 when it should be null
238             $data->parent = null;
240             //get the already created course level grade category
241             $category = new stdclass();
242             $category->courseid = $this->get_courseid();
244             $coursecategory = $DB->get_record('grade_categories', (array)$category);
245             if (!empty($coursecategory)) {
246                 $data->id = $newitemid = $coursecategory->id;
247                 $DB->update_record('grade_categories', $data);
248             }
249         }
251         //need to insert a course category
252         if (empty($newitemid)) {
253             $newitemid = $DB->insert_record('grade_categories', $data);
254         }
255         $this->set_mapping('grade_category', $oldid, $newitemid);
256     }
257     protected function process_grade_letter($data) {
258         global $DB;
260         $data = (object)$data;
261         $oldid = $data->id;
263         $data->contextid = get_context_instance(CONTEXT_COURSE, $this->get_courseid())->id;
265         $newitemid = $DB->insert_record('grade_letters', $data);
266         $this->set_mapping('grade_letter', $oldid, $newitemid);
267     }
268     protected function process_grade_setting($data) {
269         global $DB;
271         $data = (object)$data;
272         $oldid = $data->id;
274         $data->courseid = $this->get_courseid();
276         $newitemid = $DB->insert_record('grade_settings', $data);
277         //$this->set_mapping('grade_setting', $oldid, $newitemid);
278     }
280     //put all activity grade items in the correct grade category and mark all for recalculation
281     protected function after_execute() {
282         global $DB;
284         $conditions = array(
285             'backupid' => $this->get_restoreid(),
286             'itemname' => 'grade_item'//,
287             //'itemid'   => $itemid
288         );
289         $rs = $DB->get_recordset('backup_ids_temp', $conditions);
291         if (!empty($rs)) {
292             foreach($rs as $grade_item_backup) {
293                 $updateobj = new stdclass();
294                 $updateobj->id = $grade_item_backup->newitemid;
296                 //if this is an activity grade item that needs to be put back in its correct category
297                 if (!empty($grade_item_backup->parentitemid)) {
298                     $updateobj->categoryid = $this->get_mappingid('grade_category', $grade_item_backup->parentitemid);
299                 } else {
300                     //mark course and category items as needing to be recalculated
301                     $updateobj->needsupdate=1;
302                 }
303                 $DB->update_record('grade_items', $updateobj);
304             }
305         }
306         $rs->close();
308         //need to correct the grade category path and parent
309         $conditions = array(
310             'courseid' => $this->get_courseid()
311         );
312         $grade_category = new stdclass();
314         $rs = $DB->get_recordset('grade_categories', $conditions);
315         if (!empty($rs)) {
316             //get all the parents correct first as grade_category::build_path() loads category parents from the DB
317             foreach($rs as $gc) {
318                 if (!empty($gc->parent)) {
319                     $grade_category->id = $gc->id;
320                     $grade_category->parent = $this->get_mappingid('grade_category', $gc->parent);
321                     $DB->update_record('grade_categories', $grade_category);
322                 }
323             }
324         }
325         if (isset($grade_category->parent)) {
326             unset($grade_category->parent);
327         }
328         $rs->close();
330         $rs = $DB->get_recordset('grade_categories', $conditions);
331         if (!empty($rs)) {
332             //now we can rebuild all the paths
333             foreach($rs as $gc) {
334                 $grade_category->id = $gc->id;
335                 $grade_category->path = grade_category::build_path($gc);
336                 $DB->update_record('grade_categories', $grade_category);
337             }
338         }
339         $rs->close();
340     }
343 /**
344  * decode all the interlinks present in restored content
345  * relying 100% in the restore_decode_processor that handles
346  * both the contents to modify and the rules to be applied
347  */
348 class restore_decode_interlinks extends restore_execution_step {
350     protected function define_execution() {
351         // Just that
352         $this->task->get_decoder()->execute();
353     }
356 /**
357  * rebuid the course cache
358  */
359 class restore_rebuild_course_cache extends restore_execution_step {
361     protected function define_execution() {
362         // Just that
363         rebuild_course_cache($this->get_courseid());
364     }
368 /**
369  * Review all the (pending) block positions in backup_ids, matching by
370  * contextid, creating positions as needed. This is executed by the
371  * final task, once all the contexts have been created
372  */
373 class restore_review_pending_block_positions extends restore_execution_step {
375     protected function define_execution() {
376         global $DB;
378         // Get all the block_position objects pending to match
379         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
380         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid');
381         // Process block positions, creating them or accumulating for final step
382         foreach($rs as $posrec) {
383             // Get the complete position object (stored as info)
384             $position = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'block_position', $posrec->itemid)->info;
385             // If position is for one already mapped (known) contextid
386             // process it now, creating the position, else nothing to
387             // do, position finally discarded
388             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
389                 $position->contextid = $newctx->newitemid;
390                 // Create the block position
391                 $DB->insert_record('block_positions', $position);
392             }
393         }
394         $rs->close();
395     }
398 /**
399  * Process all the saved module availability records in backup_ids, matching
400  * course modules and grade item id once all them have been already restored.
401  * only if all matchings are satisfied the availability condition will be created.
402  * At the same time, it is required for the site to have that functionality enabled.
403  */
404 class restore_process_course_modules_availability extends restore_execution_step {
406     protected function define_execution() {
407         global $CFG, $DB;
409         // Site hasn't availability enabled
410         if (empty($CFG->enableavailability)) {
411             return;
412         }
414         // Get all the module_availability objects to process
415         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'module_availability');
416         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid');
417         // Process availabilities, creating them if everything matches ok
418         foreach($rs as $availrec) {
419             $allmatchesok = true;
420             // Get the complete availabilityobject
421             $availability = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'module_availability', $availrec->itemid)->info;
422             // Map the sourcecmid if needed and possible
423             if (!empty($availability->sourcecmid)) {
424                 $newcm = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'course_module', $availability->sourcecmid);
425                 if ($newcm) {
426                     $availability->sourcecmid = $newcm->newitemid;
427                 } else {
428                     $allmatchesok = false; // Failed matching, we won't create this availability rule
429                 }
430             }
431             // Map the gradeitemid if needed and possible
432             if (!empty($availability->gradeitemid)) {
433                 $newgi = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'grade_item', $availability->gradeitemid);
434                 if ($newgi) {
435                     $availability->gradeitemid = $newgi->newitemid;
436                 } else {
437                     $allmatchesok = false; // Failed matching, we won't create this availability rule
438                 }
439             }
440             if ($allmatchesok) { // Everything ok, create the availability rule
441                 $DB->insert_record('course_modules_availability', $availability);
442             }
443         }
444         $rs->close();
445     }
449 /*
450  * Execution step that, *conditionally* (if there isn't preloaded information)
451  * will load the inforef files for all the included course/section/activity tasks
452  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
453  */
454 class restore_load_included_inforef_records extends restore_execution_step {
456     protected function define_execution() {
458         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
459             return;
460         }
462         // Get all the included inforef files
463         $files = restore_dbops::get_needed_inforef_files($this->get_restoreid());
464         foreach ($files as $file) {
465             restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $file); // Load each inforef file to temp_ids
466         }
467     }
470 /*
471  * Execution step that will load all the needed files into backup_files_temp
472  *   - info: contains the whole original object (times, names...)
473  * (all them being original ids as loaded from xml)
474  */
475 class restore_load_included_files extends restore_structure_step {
477     protected function define_structure() {
479         $file = new restore_path_element('file', '/files/file');
481         return array($file);
482     }
484     // Processing functions go here
485     public function process_file($data) {
487         $data = (object)$data; // handy
489         // load it if needed:
490         //   - it it is one of the annotated inforef files (course/section/activity/block)
491         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
492         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
493         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
494         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
495         $iscomponent = ($data->component == 'user' || $data->component == 'group' ||
496                         $data->component == 'grouping' || $data->component == 'grade' ||
497                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
498         if ($isfileref || $iscomponent) {
499             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
500         }
501     }
504 /**
505  * Execution step that, *conditionally* (if there isn't preloaded information),
506  * will load all the needed roles to backup_temp_ids. They will be stored with
507  * "role" itemname. Also it will perform one automatic mapping to roles existing
508  * in the target site, based in permissions of the user performing the restore,
509  * archetypes and other bits. At the end, each original role will have its associated
510  * target role or 0 if it's going to be skipped. Note we wrap everything over one
511  * restore_dbops method, as far as the same stuff is going to be also executed
512  * by restore prechecks
513  */
514 class restore_load_and_map_roles extends restore_execution_step {
516     protected function define_execution() {
517         if ($this->task->get_preloaded_information()) { // if info is already preloaded
518             return;
519         }
521         $file = $this->get_basepath() . '/roles.xml';
522         // Load needed toles to temp_ids
523         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
525         // Process roles, mapping/skipping. Any error throws exception
526         // Note we pass controller's info because it can contain role mapping information
527         // about manual mappings performed by UI
528         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);
529     }
532 /**
533  * Execution step that, *conditionally* (if there isn't preloaded information
534  * and users have been selected in settings, will load all the needed users
535  * to backup_temp_ids. They will be stored with "user" itemname and with
536  * their original contextid as paremitemid
537  */
538 class restore_load_included_users extends restore_execution_step {
540     protected function define_execution() {
542         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
543             return;
544         }
545         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
546             return;
547         }
548         $file = $this->get_basepath() . '/users.xml';
549         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file); // Load needed users to temp_ids
550     }
553 /**
554  * Execution step that, *conditionally* (if there isn't preloaded information
555  * and users have been selected in settings, will process all the needed users
556  * in order to decide and perform any action with them (create / map / error)
557  * Note: Any error will cause exception, as far as this is the same processing
558  * than the one into restore prechecks (that should have stopped process earlier)
559  */
560 class restore_process_included_users extends restore_execution_step {
562     protected function define_execution() {
564         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
565             return;
566         }
567         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
568             return;
569         }
570         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
571     }
574 /**
575  * Execution step that will create all the needed users as calculated
576  * by @restore_process_included_users (those having newiteind = 0)
577  */
578 class restore_create_included_users extends restore_execution_step {
580     protected function define_execution() {
582         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(), $this->get_setting_value('user_files'), $this->task->get_userid());
583     }
586 /**
587  * Structure step that will create all the needed groups and groupings
588  * by loading them from the groups.xml file performing the required matches.
589  * Note group members only will be added if restoring user info
590  */
591 class restore_groups_structure_step extends restore_structure_step {
593     protected function define_structure() {
595         $paths = array(); // Add paths here
597         $paths[] = new restore_path_element('group', '/groups/group');
598         if ($this->get_setting_value('users')) {
599             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
600         }
601         $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
602         $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
604         return $paths;
605     }
607     // Processing functions go here
608     public function process_group($data) {
609         global $DB;
611         $data = (object)$data; // handy
612         $data->courseid = $this->get_courseid();
614         $oldid = $data->id;    // need this saved for later
616         $restorefiles = false; // Only if we end creating the group
618         // Search if the group already exists (by name & description) in the target course
619         $description_clause = '';
620         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
621         if (!empty($data->description)) {
622             $description_clause = ' AND ' .
623                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':desc');
624            $params['desc'] = $data->description;
625         }
626         if (!$groupdb = $DB->get_record_sql("SELECT *
627                                                FROM {groups}
628                                               WHERE courseid = :courseid
629                                                 AND name = :grname $description_clause", $params)) {
630             // group doesn't exist, create
631             $newitemid = $DB->insert_record('groups', $data);
632             $restorefiles = true; // We'll restore the files
633         } else {
634             // group exists, use it
635             $newitemid = $groupdb->id;
636         }
637         // Save the id mapping
638         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
639     }
641     public function process_member($data) {
642         global $DB;
644         $data = (object)$data; // handy
646         // get parent group->id
647         $data->groupid = $this->get_new_parentid('group');
649         // map user newitemid and insert if not member already
650         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
651             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
652                 $DB->insert_record('groups_members', $data);
653             }
654         }
655     }
657     public function process_grouping($data) {
658         global $DB;
660         $data = (object)$data; // handy
661         $data->courseid = $this->get_courseid();
663         $oldid = $data->id;    // need this saved for later
664         $restorefiles = false; // Only if we end creating the grouping
666         // Search if the grouping already exists (by name & description) in the target course
667         $description_clause = '';
668         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
669         if (!empty($data->description)) {
670             $description_clause = ' AND ' .
671                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':desc');
672            $params['desc'] = $data->description;
673         }
674         if (!$groupingdb = $DB->get_record_sql("SELECT *
675                                                   FROM {groupings}
676                                                  WHERE courseid = :courseid
677                                                    AND name = :grname $description_clause", $params)) {
678             // grouping doesn't exist, create
679             $newitemid = $DB->insert_record('groupings', $data);
680             $restorefiles = true; // We'll restore the files
681         } else {
682             // grouping exists, use it
683             $newitemid = $groupingdb->id;
684         }
685         // Save the id mapping
686         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
687     }
689     public function process_grouping_group($data) {
690         global $DB;
692         $data = (object)$data;
694         $data->groupingid = $this->get_new_parentid('grouping'); // Use new parentid
695         $data->groupid    = $this->get_mappingid('group', $data->groupid); // Get from mappings
696         $DB->insert_record('groupings_groups', $data);  // No need to set this mapping (no child info nor files)
697     }
699     protected function after_execute() {
700         // Add group related files, matching with "group" mappings
701         $this->add_related_files('group', 'icon', 'group');
702         $this->add_related_files('group', 'description', 'group');
703         // Add grouping related files, matching with "grouping" mappings
704         $this->add_related_files('grouping', 'description', 'grouping');
705     }
709 /**
710  * Structure step that will create all the needed scales
711  * by loading them from the scales.xml
712  */
713 class restore_scales_structure_step extends restore_structure_step {
715     protected function define_structure() {
717         $paths = array(); // Add paths here
718         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
719         return $paths;
720     }
722     protected function process_scale($data) {
723         global $DB;
725         $data = (object)$data;
727         $restorefiles = false; // Only if we end creating the group
729         $oldid = $data->id;    // need this saved for later
731         // Look for scale (by 'scale' both in standard (course=0) and current course
732         // with priority to standard scales (ORDER clause)
733         // scale is not course unique, use get_record_sql to suppress warning
734         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
735         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
736         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
737         if (!$scadb = $DB->get_record_sql("SELECT *
738                                             FROM {scale}
739                                            WHERE courseid IN (0, :courseid)
740                                              AND $compare_scale_clause
741                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
742             // Remap the user if possible, defaut to user performing the restore if not
743             $userid = $this->get_mappingid('user', $data->userid);
744             $data->userid = $userid ? $userid : $this->task->get_userid();
745             // Remap the course if course scale
746             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
747             // If global scale (course=0), check the user has perms to create it
748             // falling to course scale if not
749             $systemctx = get_context_instance(CONTEXT_SYSTEM);
750             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
751                 $data->courseid = $this->get_courseid();
752             }
753             // scale doesn't exist, create
754             $newitemid = $DB->insert_record('scale', $data);
755             $restorefiles = true; // We'll restore the files
756         } else {
757             // scale exists, use it
758             $newitemid = $scadb->id;
759         }
760         // Save the id mapping (with files support at system context)
761         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
762     }
764     protected function after_execute() {
765         // Add scales related files, matching with "scale" mappings
766         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
767     }
771 /**
772  * Structure step that will create all the needed outocomes
773  * by loading them from the outcomes.xml
774  */
775 class restore_outcomes_structure_step extends restore_structure_step {
777     protected function define_structure() {
779         $paths = array(); // Add paths here
780         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
781         return $paths;
782     }
784     protected function process_outcome($data) {
785         global $DB;
787         $data = (object)$data;
789         $restorefiles = false; // Only if we end creating the group
791         $oldid = $data->id;    // need this saved for later
793         // Look for outcome (by shortname both in standard (courseid=null) and current course
794         // with priority to standard outcomes (ORDER clause)
795         // outcome is not course unique, use get_record_sql to suppress warning
796         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
797         if (!$outdb = $DB->get_record_sql('SELECT *
798                                              FROM {grade_outcomes}
799                                             WHERE shortname = :shortname
800                                               AND (courseid = :courseid OR courseid IS NULL)
801                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
802             // Remap the user
803             $userid = $this->get_mappingid('user', $data->usermodified);
804             $data->usermodified = $userid ? $userid : $this->task->get_userid();
805             // Remap the scale
806             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
807             // Remap the course if course outcome
808             $data->courseid = $data->courseid ? $this->get_courseid() : null;
809             // If global outcome (course=null), check the user has perms to create it
810             // falling to course outcome if not
811             $systemctx = get_context_instance(CONTEXT_SYSTEM);
812             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
813                 $data->courseid = $this->get_courseid();
814             }
815             // outcome doesn't exist, create
816             $newitemid = $DB->insert_record('grade_outcomes', $data);
817             $restorefiles = true; // We'll restore the files
818         } else {
819             // scale exists, use it
820             $newitemid = $outdb->id;
821         }
822         // Set the corresponding grade_outcomes_courses record
823         $outcourserec = new stdclass();
824         $outcourserec->courseid  = $this->get_courseid();
825         $outcourserec->outcomeid = $newitemid;
826         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
827             $DB->insert_record('grade_outcomes_courses', $outcourserec);
828         }
829         // Save the id mapping (with files support at system context)
830         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
831     }
833     protected function after_execute() {
834         // Add outcomes related files, matching with "outcome" mappings
835         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
836     }
839 /**
840  * Execution step that, *conditionally* (if there isn't preloaded information
841  * will load all the question categories and questions (header info only)
842  * to backup_temp_ids. They will be stored with "question_category" and
843  * "question" itemnames and with their original contextid and question category
844  * id as paremitemids
845  */
846 class restore_load_categories_and_questions extends restore_execution_step {
848     protected function define_execution() {
850         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
851             return;
852         }
853         $file = $this->get_basepath() . '/questions.xml';
854         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
855     }
858 /**
859  * Execution step that, *conditionally* (if there isn't preloaded information)
860  * will process all the needed categories and questions
861  * in order to decide and perform any action with them (create / map / error)
862  * Note: Any error will cause exception, as far as this is the same processing
863  * than the one into restore prechecks (that should have stopped process earlier)
864  */
865 class restore_process_categories_and_questions extends restore_execution_step {
867     protected function define_execution() {
869         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
870             return;
871         }
872         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
873     }
876 /**
877  * Structure step that will read the section.xml creating/updating sections
878  * as needed, rebuilding course cache and other friends
879  */
880 class restore_section_structure_step extends restore_structure_step {
882     protected function define_structure() {
883         return array(new restore_path_element('section', '/section'));
884     }
886     public function process_section($data) {
887         global $DB;
888         $data = (object)$data;
889         $oldid = $data->id; // We'll need this later
891         $restorefiles = false;
893         // Look for the section
894         $section = new stdclass();
895         $section->course  = $this->get_courseid();
896         $section->section = $data->number;
897         // Section doesn't exist, create it with all the info from backup
898         if (!$secrec = $DB->get_record('course_sections', (array)$section)) {
899             $section->name = $data->name;
900             $section->summary = $data->summary;
901             $section->summaryformat = $data->summaryformat;
902             $section->sequence = '';
903             $section->visible = $data->visible;
904             $newitemid = $DB->insert_record('course_sections', $section);
905             $restorefiles = true;
907         // Section exists, update non-empty information
908         } else {
909             $section->id = $secrec->id;
910             if (empty($secrec->name)) {
911                 $section->name = $data->name;
912             }
913             if (empty($secrec->summary)) {
914                 $section->summary = $data->summary;
915                 $section->summaryformat = $data->summaryformat;
916                 $restorefiles = true;
917             }
918             $DB->update_record('course_sections', $section);
919             $newitemid = $secrec->id;
920         }
922         // Annotate the section mapping, with restorefiles option if needed
923         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
925         // If needed, adjust course->numsections
926         if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
927             if ($numsections < $section->section) {
928                 $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
929             }
930         }
931     }
933     protected function after_execute() {
934         // Add section related files, with 'course_section' itemid to match
935         $this->add_related_files('course', 'section', 'course_section');
936     }
940 /**
941  * Structure step that will read the course.xml file, loading it and performing
942  * various actions depending of the site/restore settings. Note that target
943  * course always exist before arriving here so this step will be updating
944  * the course record (never inserting)
945  */
946 class restore_course_structure_step extends restore_structure_step {
948     protected function define_structure() {
950         $course = new restore_path_element('course', '/course', true); // Grouped
951         $category = new restore_path_element('category', '/course/category');
952         $tag = new restore_path_element('tag', '/course/tags/tag');
953         $allowed = new restore_path_element('allowed', '/course/allowed_modules/module');
955         return array($course, $category, $tag, $allowed);
956     }
958     /**
959      * Processing functions go here
960      *
961      * @global moodledatabase $DB
962      * @param stdClass $data
963      */
964     public function process_course($data) {
965         global $CFG, $DB;
967         $data = (object)$data;
968         $coursetags = isset($data->tags['tag']) ? $data->tags['tag'] : array();
969         $coursemodules = isset($data->allowed_modules['module']) ? $data->allowed_modules['module'] : array();
970         $oldid = $data->id; // We'll need this later
972         $fullname  = $this->get_setting_value('course_fullname');
973         $shortname = $this->get_setting_value('course_shortname');
974         $startdate = $this->get_setting_value('course_startdate');
976         // Calculate final course names, to avoid dupes
977         list($fullname, $shortname) = restore_dbops::calculate_course_names($this->get_courseid(), $fullname, $shortname);
979         // Need to change some fields before updating the course record
980         $data->id = $this->get_courseid();
981         $data->fullname = $fullname;
982         $data->shortname= $shortname;
983         $data->idnumber = '';
985         // Category is set by UI when choosing the destination
986         unset($data->category);
988         $data->startdate= $this->apply_date_offset($data->startdate);
989         if ($data->defaultgroupingid) {
990             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
991         }
992         if (empty($CFG->enablecompletion)) {
993             $data->enablecompletion = 0;
994             $data->completionstartonenrol = 0;
995             $data->completionnotify = 0;
996         }
997         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
998         if (!array_key_exists($data->lang, $languages)) {
999             $data->lang = '';
1000         }
1001         $themes = get_list_of_themes(); // Get themes for quick search later
1002         if (!in_array($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1003             $data->theme = '';
1004         }
1006         // Course record ready, update it
1007         $DB->update_record('course', $data);
1009         // Course tags
1010         if (!empty($CFG->usetags) && isset($coursetags)) { // if enabled in server and present in backup
1011             $tags = array();
1012             foreach ($coursetags as $coursetag) {
1013                 $coursetag = (object)$coursetag;
1014                 $tags[] = $coursetag->rawname;
1015             }
1016             tag_set('course', $this->get_courseid(), $tags);
1017         }
1018         // Course allowed modules
1019         if (!empty($data->restrictmodules) && !empty($coursemodules)) {
1020             $available = get_plugin_list('mod');
1021             foreach ($coursemodules as $coursemodule) {
1022                 $mname = $coursemodule['modulename'];
1023                 if (array_key_exists($mname, $available)) {
1024                     if ($module = $DB->get_record('modules', array('name' => $mname, 'visible' => 1))) {
1025                         $rec = new stdclass();
1026                         $rec->course = $this->get_courseid();
1027                         $rec->module = $module->id;
1028                         if (!$DB->record_exists('course_allowed_modules', (array)$rec)) {
1029                             $DB->insert_record('course_allowed_modules', $rec);
1030                         }
1031                     }
1032                 }
1033             }
1034         }
1035         // Role name aliases
1036         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1037     }
1039     protected function after_execute() {
1040         // Add course related files, without itemid to match
1041         $this->add_related_files('course', 'summary', null);
1042         $this->add_related_files('course', 'legacy', null);
1043     }
1047 /*
1048  * Structure step that will read the roles.xml file (at course/activity/block levels)
1049  * containig all the role_assignments and overrides for that context. If corresponding to
1050  * one mapped role, they will be applied to target context. Will observe the role_assignments
1051  * setting to decide if ras are restored.
1052  * Note: only ras with component == null are restored as far as the any ra with component
1053  * is handled by one enrolment plugin, hence it will createt the ras later
1054  */
1055 class restore_ras_and_caps_structure_step extends restore_structure_step {
1057     protected function define_structure() {
1059         $paths = array();
1061         // Observe the role_assignments setting
1062         if ($this->get_setting_value('role_assignments')) {
1063             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
1064         }
1065         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
1067         return $paths;
1068     }
1070     /**
1071      * Assign roles
1072      *
1073      * This has to be called after enrolments processing.
1074      *
1075      * @param mixed $data
1076      * @return void
1077      */
1078     public function process_assignment($data) {
1079         global $DB;
1081         $data = (object)$data;
1083         // Check roleid, userid are one of the mapped ones
1084         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
1085             return;
1086         }
1087         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
1088             return;
1089         }
1090         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
1091             // Only assign roles to not deleted users
1092             return;
1093         }
1094         if (!$contextid = $this->task->get_contextid()) {
1095             return;
1096         }
1098         if (empty($data->component)) {
1099             // assign standard manual roles
1100             // TODO: role_assign() needs one userid param to be able to specify our restore userid
1101             role_assign($newroleid, $newuserid, $contextid);
1103         } else if ((strpos($data->component, 'enrol_') === 0)) {
1104             // Deal with enrolment roles
1105             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1106                 if ($component = $DB->get_field('enrol', 'component', array('id'=>$enrolid))) {
1107                     //note: we have to verify component because it might have changed
1108                     if ($component === 'enrol_manual') {
1109                         // manual is a special case, we do not use components - this owudl happen when converting from other plugin
1110                         role_assign($newroleid, $newuserid, $contextid); //TODO: do we need modifierid?
1111                     } else {
1112                         role_assign($newroleid, $newuserid, $contextid, $component, $enrolid); //TODO: do we need modifierid?
1113                     }
1114                 }
1115             }
1116         }
1117     }
1119     public function process_override($data) {
1120         $data = (object)$data;
1122         // Check roleid is one of the mapped ones
1123         $newroleid = $this->get_mappingid('role', $data->roleid);
1124         // If newroleid and context are valid assign it via API (it handles dupes and so on)
1125         if ($newroleid && $this->task->get_contextid()) {
1126             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
1127             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
1128             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
1129         }
1130     }
1133 /**
1134  * This structure steps restores the enrol plugins and their underlying
1135  * enrolments, performing all the mappings and/or movements required
1136  */
1137 class restore_enrolments_structure_step extends restore_structure_step {
1139     protected function define_structure() {
1141         $paths = array();
1143         $paths[] = new restore_path_element('enrol', '/enrolments/enrols/enrol');
1144         $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
1146         return $paths;
1147     }
1149     /**
1150      * Create enrolment instances.
1151      *
1152      * This has to be called after creation of roles
1153      * and before adding of role assignments.
1154      *
1155      * @param mixed $data
1156      * @return void
1157      */
1158     public function process_enrol($data) {
1159         global $DB;
1161         $data = (object)$data;
1162         $oldid = $data->id; // We'll need this later
1164         $restoretype = plugin_supports('enrol', $data->enrol, ENROL_RESTORE_TYPE, null);
1166         if ($restoretype !== ENROL_RESTORE_EXACT and $restoretype !== ENROL_RESTORE_NOUSERS) {
1167             // TODO: add complex restore support via custom class
1168             debugging("Skipping '{$data->enrol}' enrolment plugin. Will be implemented before 2.0 release", DEBUG_DEVELOPER);
1169             $this->set_mapping('enrol', $oldid, 0);
1170             return;
1171         }
1173         // Perform various checks to decide what to do with the enrol plugin
1174         if (!array_key_exists($data->enrol, enrol_get_plugins(false))) {
1175             // TODO: decide if we want to switch to manual enrol - we need UI for this
1176             debugging("Enrol plugin data can not be restored because it is not installed");
1177             $this->set_mapping('enrol', $oldid, 0);
1178             return;
1180         }
1181         if (!enrol_is_enabled($data->enrol)) {
1182             // TODO: decide if we want to switch to manual enrol - we need UI for this
1183             debugging("Enrol plugin data can not be restored because it is not enabled");
1184             $this->set_mapping('enrol', $oldid, 0);
1185             return;
1186         }
1188         // map standard fields - plugin has to process custom fields from own restore class
1189         $data->roleid = $this->get_mappingid('role', $data->roleid);
1190         //TODO: should we move the enrol start and end date here?
1192         // always add instance, if the course does not support multiple instances it just returns NULL
1193         $enrol = enrol_get_plugin($data->enrol);
1194         $courserec = $DB->get_record('course', array('id' => $this->get_courseid())); // Requires object, uses only id!!
1195         if ($newitemid = $enrol->add_instance($courserec, (array)$data)) {
1196             // ok
1197         } else {
1198             if ($instances = $DB->get_records('enrol', array('courseid'=>$courserec->id, 'enrol'=>$data->enrol))) {
1199                 // most probably plugin that supports only one instance
1200                 $newitemid = key($instances);
1201             } else {
1202                 debugging('Can not create new enrol instance or reuse existing');
1203                 $newitemid = 0;
1204             }
1205         }
1207         if ($restoretype === ENROL_RESTORE_NOUSERS) {
1208             // plugin requests to prevent restore of any users
1209             $newitemid = 0;
1210         }
1212         $this->set_mapping('enrol', $oldid, $newitemid);
1213     }
1215     /**
1216      * Create user enrolments
1217      *
1218      * This has to be called after creation of enrolment instances
1219      * and before adding of role assignments.
1220      *
1221      * @param mixed $data
1222      * @return void
1223      */
1224     public function process_enrolment($data) {
1225         global $DB;
1227         $data = (object)$data;
1229         // Process only if parent instance have been mapped
1230         if ($enrolid = $this->get_new_parentid('enrol')) {
1231             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1232                 // And only if user is a mapped one
1233                 if ($userid = $this->get_mappingid('user', $data->userid)) {
1234                     $enrol = enrol_get_plugin($instance->enrol);
1235                     //TODO: do we need specify modifierid?
1236                     $enrol->enrol_user($instance, $userid, null, $data->timestart, $data->timeend, $data->status);
1237                     //note: roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing above
1238                 }
1239             }
1240         }
1241     }
1245 /**
1246  * This structure steps restores the filters and their configs
1247  */
1248 class restore_filters_structure_step extends restore_structure_step {
1250     protected function define_structure() {
1252         $paths = array();
1254         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
1255         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
1257         return $paths;
1258     }
1260     public function process_active($data) {
1262         $data = (object)$data;
1264         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1265             return;
1266         }
1267         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
1268     }
1270     public function process_config($data) {
1272         $data = (object)$data;
1274         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1275             return;
1276         }
1277         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
1278     }
1282 /**
1283  * This structure steps restores the comments
1284  * Note: Cannot use the comments API because defaults to USER->id.
1285  * That should change allowing to pass $userid
1286  */
1287 class restore_comments_structure_step extends restore_structure_step {
1289     protected function define_structure() {
1291         $paths = array();
1293         $paths[] = new restore_path_element('comment', '/comments/comment');
1295         return $paths;
1296     }
1298     public function process_comment($data) {
1299         global $DB;
1301         $data = (object)$data;
1303         // First of all, if the comment has some itemid, ask to the task what to map
1304         $mapping = false;
1305         if ($data->itemid) {
1306             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
1307             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
1308         }
1309         // Only restore the comment if has no mapping OR we have found the matching mapping
1310         if (!$mapping || $data->itemid) {
1311             // Only if user mapping and context
1312             $data->userid = $this->get_mappingid('user', $data->userid);
1313             if ($data->userid && $this->task->get_contextid()) {
1314                 $data->contextid = $this->task->get_contextid();
1315                 // Only if there is another comment with same context/user/timecreated
1316                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
1317                 if (!$DB->record_exists('comments', $params)) {
1318                     $DB->insert_record('comments', $data);
1319                 }
1320             }
1321         }
1322     }
1325 class restore_course_completion_structure_step extends restore_structure_step {
1327     /**
1328      * Conditionally decide if this step should be executed.
1329      *
1330      * This function checks parameters that are not immediate settings to ensure
1331      * that the enviroment is suitable for the restore of course completion info.
1332      *
1333      * This function checks the following four parameters:
1334      *
1335      *   1. Course completion is enabled on the site
1336      *   2. The backup includes course completion information
1337      *   3. All modules are restorable
1338      *   4. All modules are marked for restore.
1339      *
1340      * @return bool True is safe to execute, false otherwise
1341      */
1342     protected function execute_condition() {
1343         global $CFG;
1345         // First check course completion is enabled on this site
1346         if (empty($CFG->enablecompletion)) {
1347             // Disabled, don't restore course completion
1348             return false;
1349         }
1351         // Check it is included in the backup
1352         $fullpath = $this->task->get_taskbasepath();
1353         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1354         if (!file_exists($fullpath)) {
1355             // Not found, can't restore course completion
1356             return false;
1357         }
1359         // Check we are able to restore all backed up modules
1360         if ($this->task->is_missing_modules()) {
1361             return false;
1362         }
1364         // Finally check all modules within the backup are being restored.
1365         if ($this->task->is_excluding_activities()) {
1366             return false;
1367         }
1369         return true;
1370     }
1372     /**
1373      * Define the course completion structure
1374      *
1375      * @return array Array of restore_path_element
1376      */
1377     protected function define_structure() {
1379         // To know if we are including user completion info
1380         $userinfo = $this->get_setting_value('userscompletion');
1382         $paths = array();
1383         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
1384         $paths[] = new restore_path_element('course_completion_notify', '/course_completion/course_completion_notify');
1385         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
1387         if ($userinfo) {
1388             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
1389             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
1390         }
1392         return $paths;
1394     }
1396     /**
1397      * Process course completion criteria
1398      *
1399      * @global moodle_database $DB
1400      * @param stdClass $data
1401      */
1402     public function process_course_completion_criteria($data) {
1403         global $DB;
1405         $data = (object)$data;
1406         $data->course = $this->get_courseid();
1408         // Apply the date offset to the time end field
1409         $data->timeend = $this->apply_date_offset($data->timeend);
1411         // Map the role from the criteria
1412         if (!empty($data->role)) {
1413             $data->role = $this->get_mappingid('role', $data->role);
1414         }
1416         $skipcriteria = false;
1418         // If the completion criteria is for a module we need to map the module instance
1419         // to the new module id.
1420         if (!empty($data->moduleinstance) && !empty($data->module)) {
1421             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
1422             if (empty($data->moduleinstance)) {
1423                 $skipcriteria = true;
1424             }
1425         } else {
1426             $data->module = null;
1427             $data->moduleinstance = null;
1428         }
1430         // We backup the course shortname rather than the ID so that we can match back to the course
1431         if (!empty($data->courseinstanceshortname)) {
1432             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
1433             if (!$courseinstanceid) {
1434                 $skipcriteria = true;
1435             }
1436         } else {
1437             $courseinstanceid = null;
1438         }
1439         $data->courseinstance = $courseinstanceid;
1441         if (!$skipcriteria) {
1442             $params = array(
1443                 'course'         => $data->course,
1444                 'criteriatype'   => $data->criteriatype,
1445                 'enrolperiod'    => $data->enrolperiod,
1446                 'courseinstance' => $data->courseinstance,
1447                 'module'         => $data->module,
1448                 'moduleinstance' => $data->moduleinstance,
1449                 'timeend'        => $data->timeend,
1450                 'gradepass'      => $data->gradepass,
1451                 'role'           => $data->role
1452             );
1453             $newid = $DB->insert_record('course_completion_criteria', $params);
1454             $this->set_mapping('course_completion_criteria', $data->id, $newid);
1455         }
1456     }
1458     /**
1459      * Processes course compltion criteria complete records
1460      *
1461      * @global moodle_database $DB
1462      * @param stdClass $data
1463      */
1464     public function process_course_completion_crit_compl($data) {
1465         global $DB;
1467         $data = (object)$data;
1469         // This may be empty if criteria could not be restored
1470         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
1472         $data->course = $this->get_courseid();
1473         $data->userid = $this->get_mappingid('user', $data->userid);
1475         if (!empty($data->criteriaid) && !empty($data->userid)) {
1476             $params = array(
1477                 'userid' => $data->userid,
1478                 'course' => $data->course,
1479                 'criteriaid' => $data->criteriaid,
1480                 'timecompleted' => $this->apply_date_offset($data->timecompleted)
1481             );
1482             if (isset($data->gradefinal)) {
1483                 $params['gradefinal'] = $data->gradefinal;
1484             }
1485             if (isset($data->unenroled)) {
1486                 $params['unenroled'] = $data->unenroled;
1487             }
1488             if (isset($data->deleted)) {
1489                 $params['deleted'] = $data->deleted;
1490             }
1491             $DB->insert_record('course_completion_crit_compl', $params);
1492         }
1493     }
1495     /**
1496      * Process course completions
1497      *
1498      * @global moodle_database $DB
1499      * @param stdClass $data
1500      */
1501     public function process_course_completions($data) {
1502         global $DB;
1504         $data = (object)$data;
1506         $data->course = $this->get_courseid();
1507         $data->userid = $this->get_mappingid('user', $data->userid);
1509         if (!empty($data->userid)) {
1510             $params = array(
1511                 'userid' => $data->userid,
1512                 'course' => $data->course,
1513                 'deleted' => $data->deleted,
1514                 'timenotified' => $this->apply_date_offset($data->timenotified),
1515                 'timeenrolled' => $this->apply_date_offset($data->timeenrolled),
1516                 'timestarted' => $this->apply_date_offset($data->timestarted),
1517                 'timecompleted' => $this->apply_date_offset($data->timecompleted),
1518                 'reaggregate' => $data->reaggregate
1519             );
1520             $DB->insert_record('course_completions', $params);
1521         }
1522     }
1524     /**
1525      * Process course completion notification records.
1526      *
1527      * Note: As of Moodle 2.0 this table is not being used however it has been
1528      * left in in the hopes that one day the functionality there will be completed
1529      *
1530      * @global moodle_database $DB
1531      * @param stdClass $data
1532      */
1533     public function process_course_completion_notify($data) {
1534         global $DB;
1536         $data = (object)$data;
1538         $data->course = $this->get_courseid();
1539         if (!empty($data->role)) {
1540             $data->role = $this->get_mappingid('role', $data->role);
1541         }
1543         $params = array(
1544             'course' => $data->course,
1545             'role' => $data->role,
1546             'message' => $data->message,
1547             'timesent' => $this->apply_date_offset($data->timesent),
1548         );
1549         $DB->insert_record('course_completion_notify', $params);
1550     }
1552     /**
1553      * Process course completion aggregate methods
1554      *
1555      * @global moodle_database $DB
1556      * @param stdClass $data
1557      */
1558     public function process_course_completion_aggr_methd($data) {
1559         global $DB;
1561         $data = (object)$data;
1563         $data->course = $this->get_courseid();
1565         $params = array(
1566             'course' => $data->course,
1567             'criteriatype' => $data->criteriatype,
1568             'method' => $data->method,
1569             'value' => $data->value,
1570         );
1571         $DB->insert_record('course_completion_aggr_methd', $params);
1572     }
1576 /**
1577  * This structure step restores the grade items associated with one activity
1578  * All the grade items are made child of the "course" grade item but the original
1579  * categoryid is saved as parentitemid in the backup_ids table, so, when restoring
1580  * the complete gradebook (categories and calculations), that information is
1581  * available there
1582  */
1583 class restore_activity_grades_structure_step extends restore_structure_step {
1585     protected function define_structure() {
1587         $paths = array();
1588         $userinfo = $this->get_setting_value('userinfo');
1590         $paths[] = new restore_path_element('grade_item', '/activity_gradebook/grade_items/grade_item');
1591         $paths[] = new restore_path_element('grade_letter', '/activity_gradebook/grade_letters/grade_letter');
1592         if ($userinfo) {
1593             $paths[] = new restore_path_element('grade_grade',
1594                            '/activity_gradebook/grade_items/grade_item/grade_grades/grade_grade');
1595         }
1596         return $paths;
1597     }
1599     protected function process_grade_item($data) {
1601         $data = (object)($data);
1602         $oldid       = $data->id;        // We'll need these later
1603         $oldparentid = $data->categoryid;
1605         // make sure top course category exists, all grade items will be associated
1606         // to it. Later, if restoring the whole gradebook, categories will be introduced
1607         $coursecat = grade_category::fetch_course_category($this->get_courseid());
1608         $coursecatid = $coursecat->id; // Get the categoryid to be used
1610         unset($data->id);
1611         $data->categoryid   = $coursecatid;
1612         $data->courseid     = $this->get_courseid();
1613         $data->iteminstance = $this->task->get_activityid();
1614         // Don't get any idnumber from course module. Keep them as they are in grade_item->idnumber
1615         // Reason: it's not clear what happens with outcomes->idnumber or activities with multiple items (workshop)
1616         // so the best is to keep the ones already in the gradebook
1617         // Potential problem: duplicates if same items are restored more than once. :-(
1618         // This needs to be fixed in some way (outcomes & activities with multiple items)
1619         // $data->idnumber     = get_coursemodule_from_instance($data->itemmodule, $data->iteminstance)->idnumber;
1620         // In any case, verify always for uniqueness
1621         $data->idnumber = grade_verify_idnumber($data->idnumber, $this->get_courseid()) ? $data->idnumber : null;
1622         $data->scaleid      = $this->get_mappingid('scale', $data->scaleid);
1623         $data->outcomeid    = $this->get_mappingid('outcome', $data->outcomeid);
1624         $data->timecreated  = $this->apply_date_offset($data->timecreated);
1625         $data->timemodified = $this->apply_date_offset($data->timemodified);
1627         $gradeitem = new grade_item($data);
1628         $gradeitem->insert('restore');
1630         //sortorder is automatically assigned when inserting. Re-instate the previous sortorder
1631         $gradeitem->sortorder = $data->sortorder;
1632         $gradeitem->update('restore');
1634         // Set mapping, saving the original category id into parentitemid
1635         // gradebook restore (final task) will need it to reorganise items
1636         $this->set_mapping('grade_item', $oldid, $gradeitem->id, false, null, $oldparentid);
1637     }
1639     protected function process_grade_grade($data) {
1640         $data = (object)($data);
1642         unset($data->id);
1643         $data->itemid = $this->get_new_parentid('grade_item');
1644         $data->userid = $this->get_mappingid('user', $data->userid);
1645         $data->usermodified = $this->get_mappingid('user', $data->usermodified);
1646         $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
1647         // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
1648         $data->overridden = $this->apply_date_offset($data->overridden);
1650         $grade = new grade_grade($data);
1651         $grade->insert('restore');
1652         // no need to save any grade_grade mapping
1653     }
1655     /**
1656      * process activity grade_letters. Note that, while these are possible,
1657      * because grade_letters are contextid based, in proctice, only course
1658      * context letters can be defined. So we keep here this method knowing
1659      * it won't be executed ever. gradebook restore will restore course letters.
1660      */
1661     protected function process_grade_letter($data) {
1662         global $DB;
1664         $data = (object)$data;
1666         $data->contextid = $this->task->get_contextid();
1667         $newitemid = $DB->insert_record('grade_letters', $data);
1668         // no need to save any grade_letter mapping
1669     }
1673 /**
1674  * This structure steps restores one instance + positions of one block
1675  * Note: Positions corresponding to one existing context are restored
1676  * here, but all the ones having unknown contexts are sent to backup_ids
1677  * for a later chance to be restored at the end (final task)
1678  */
1679 class restore_block_instance_structure_step extends restore_structure_step {
1681     protected function define_structure() {
1683         $paths = array();
1685         $paths[] = new restore_path_element('block', '/block', true); // Get the whole XML together
1686         $paths[] = new restore_path_element('block_position', '/block/block_positions/block_position');
1688         return $paths;
1689     }
1691     public function process_block($data) {
1692         global $DB, $CFG;
1694         $data = (object)$data; // Handy
1695         $oldcontextid = $data->contextid;
1696         $oldid        = $data->id;
1697         $positions = isset($data->block_positions['block_position']) ? $data->block_positions['block_position'] : array();
1699         // Look for the parent contextid
1700         if (!$data->parentcontextid = $this->get_mappingid('context', $data->parentcontextid)) {
1701             throw new restore_step_exception('restore_block_missing_parent_ctx', $data->parentcontextid);
1702         }
1704         // TODO: it would be nice to use standard plugin supports instead of this instance_allow_multiple()
1705         // If there is already one block of that type in the parent context
1706         // and the block is not multiple, stop processing
1707         // Use blockslib loader / method executor
1708         if (!block_method_result($data->blockname, 'instance_allow_multiple')) {
1709             if ($DB->record_exists_sql("SELECT bi.id
1710                                           FROM {block_instances} bi
1711                                           JOIN {block} b ON b.name = bi.blockname
1712                                          WHERE bi.parentcontextid = ?
1713                                            AND bi.blockname = ?", array($data->parentcontextid, $data->blockname))) {
1714                 return false;
1715             }
1716         }
1718         // If there is already one block of that type in the parent context
1719         // with the same showincontexts, pagetypepattern, subpagepattern, defaultregion and configdata
1720         // stop processing
1721         $params = array(
1722             'blockname' => $data->blockname, 'parentcontextid' => $data->parentcontextid,
1723             'showinsubcontexts' => $data->showinsubcontexts, 'pagetypepattern' => $data->pagetypepattern,
1724             'subpagepattern' => $data->subpagepattern, 'defaultregion' => $data->defaultregion);
1725         if ($birecs = $DB->get_records('block_instances', $params)) {
1726             foreach($birecs as $birec) {
1727                 if ($birec->configdata == $data->configdata) {
1728                     return false;
1729                 }
1730             }
1731         }
1733         // Set task old contextid, blockid and blockname once we know them
1734         $this->task->set_old_contextid($oldcontextid);
1735         $this->task->set_old_blockid($oldid);
1736         $this->task->set_blockname($data->blockname);
1738         // Let's look for anything within configdata neededing processing
1739         // (nulls and uses of legacy file.php)
1740         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
1741             $configdata = (array)unserialize(base64_decode($data->configdata));
1742             foreach ($configdata as $attribute => $value) {
1743                 if (in_array($attribute, $attrstotransform)) {
1744                     $configdata[$attribute] = $this->contentprocessor->process_cdata($value);
1745                 }
1746             }
1747             $data->configdata = base64_encode(serialize((object)$configdata));
1748         }
1750         // Create the block instance
1751         $newitemid = $DB->insert_record('block_instances', $data);
1752         // Save the mapping (with restorefiles support)
1753         $this->set_mapping('block_instance', $oldid, $newitemid, true);
1754         // Create the block context
1755         $newcontextid = get_context_instance(CONTEXT_BLOCK, $newitemid)->id;
1756         // Save the block contexts mapping and sent it to task
1757         $this->set_mapping('context', $oldcontextid, $newcontextid);
1758         $this->task->set_contextid($newcontextid);
1759         $this->task->set_blockid($newitemid);
1761         // Restore block fileareas if declared
1762         $component = 'block_' . $this->task->get_blockname();
1763         foreach ($this->task->get_fileareas() as $filearea) { // Simple match by contextid. No itemname needed
1764             $this->add_related_files($component, $filearea, null);
1765         }
1767         // Process block positions, creating them or accumulating for final step
1768         foreach($positions as $position) {
1769             $position = (object)$position;
1770             $position->blockinstanceid = $newitemid; // The instance is always the restored one
1771             // If position is for one already mapped (known) contextid
1772             // process it now, creating the position
1773             if ($newpositionctxid = $this->get_mappingid('context', $position->contextid)) {
1774                 $position->contextid = $newpositionctxid;
1775                 // Create the block position
1776                 $DB->insert_record('block_positions', $position);
1778             // The position belongs to an unknown context, send it to backup_ids
1779             // to process them as part of the final steps of restore. We send the
1780             // whole $position object there, hence use the low level method.
1781             } else {
1782                 restore_dbops::set_backup_ids_record($this->get_restoreid(), 'block_position', $position->id, 0, null, $position);
1783             }
1784         }
1785     }
1788 /**
1789  * Structure step to restore common course_module information
1790  *
1791  * This step will process the module.xml file for one activity, in order to restore
1792  * the corresponding information to the course_modules table, skipping various bits
1793  * of information based on CFG settings (groupings, completion...) in order to fullfill
1794  * all the reqs to be able to create the context to be used by all the rest of steps
1795  * in the activity restore task
1796  */
1797 class restore_module_structure_step extends restore_structure_step {
1799     protected function define_structure() {
1800         global $CFG;
1802         $paths = array();
1804         $paths[] = new restore_path_element('module', '/module');
1805         if ($CFG->enableavailability) {
1806             $paths[] = new restore_path_element('availability', '/module/availability_info/availability');
1807         }
1809         return $paths;
1810     }
1812     protected function process_module($data) {
1813         global $CFG, $DB;
1815         $data = (object)$data;
1816         $oldid = $data->id;
1818         $data->course = $this->task->get_courseid();
1819         $data->module = $DB->get_field('modules', 'id', array('name' => $data->modulename));
1820         // Map section (first try by course_section mapping match. Useful in course and section restores)
1821         $data->section = $this->get_mappingid('course_section', $data->sectionid);
1822         if (!$data->section) { // mapping failed, try to get section by sectionnumber matching
1823             $params = array(
1824                 'course' => $this->get_courseid(),
1825                 'section' => $data->sectionnumber);
1826             $data->section = $DB->get_field('course_sections', 'id', $params);
1827         }
1828         if (!$data->section) { // sectionnumber failed, try to get first section in course
1829             $params = array(
1830                 'course' => $this->get_courseid());
1831             $data->section = $DB->get_field('course_sections', 'MIN(id)', $params);
1832         }
1833         if (!$data->section) { // no sections in course, create section 0 and 1 and assign module to 1
1834             $sectionrec = array(
1835                 'course' => $this->get_courseid(),
1836                 'section' => 0);
1837             $DB->insert_record('course_sections', $sectionrec); // section 0
1838             $sectionrec = array(
1839                 'course' => $this->get_courseid(),
1840                 'section' => 1);
1841             $data->section = $DB->insert_record('course_sections', $sectionrec); // section 1
1842         }
1843         $data->groupingid= $this->get_mappingid('grouping', $data->groupingid);      // grouping
1844         if (!$CFG->enablegroupmembersonly) {                                         // observe groupsmemberonly
1845             $data->groupmembersonly = 0;
1846         }
1847         if (!grade_verify_idnumber($data->idnumber, $this->get_courseid())) {        // idnumber uniqueness
1848             $data->idnumber = '';
1849         }
1850         if (empty($CFG->enablecompletion)) { // completion
1851             $data->completion = 0;
1852             $data->completiongradeitemnumber = null;
1853             $data->completionview = 0;
1854             $data->completionexpected = 0;
1855         } else {
1856             $data->completionexpected = $this->apply_date_offset($data->completionexpected);
1857         }
1858         if (empty($CFG->enableavailability)) {
1859             $data->availablefrom = 0;
1860             $data->availableuntil = 0;
1861             $data->showavailability = 0;
1862         } else {
1863             $data->availablefrom = $this->apply_date_offset($data->availablefrom);
1864             $data->availableuntil= $this->apply_date_offset($data->availableuntil);
1865         }
1866         $data->instance = 0; // Set to 0 for now, going to create it soon (next step)
1868         // course_module record ready, insert it
1869         $newitemid = $DB->insert_record('course_modules', $data);
1870         // save mapping
1871         $this->set_mapping('course_module', $oldid, $newitemid);
1872         // set the new course_module id in the task
1873         $this->task->set_moduleid($newitemid);
1874         // we can now create the context safely
1875         $ctxid = get_context_instance(CONTEXT_MODULE, $newitemid)->id;
1876         // set the new context id in the task
1877         $this->task->set_contextid($ctxid);
1878         // update sequence field in course_section
1879         if ($sequence = $DB->get_field('course_sections', 'sequence', array('id' => $data->section))) {
1880             $sequence .= ',' . $newitemid;
1881         } else {
1882             $sequence = $newitemid;
1883         }
1884         $DB->set_field('course_sections', 'sequence', $sequence, array('id' => $data->section));
1885     }
1888     protected function process_availability($data) {
1889         $data = (object)$data;
1890         // Simply going to store the whole availability record now, we'll process
1891         // all them later in the final task (once all actvivities have been restored)
1892         // Let's call the low level one to be able to store the whole object
1893         $data->coursemoduleid = $this->task->get_moduleid(); // Let add the availability cmid
1894         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'module_availability', $data->id, 0, null, $data);
1895     }
1898 /**
1899  * Structure step that will process the user activity completion
1900  * information if all these conditions are met:
1901  *  - Target site has completion enabled ($CFG->enablecompletion)
1902  *  - Activity includes completion info (file_exists)
1903  */
1904 class restore_userscompletion_structure_step extends restore_structure_step {
1906     /**
1907      * To conditionally decide if this step must be executed
1908      * Note the "settings" conditions are evaluated in the
1909      * corresponding task. Here we check for other conditions
1910      * not being restore settings (files, site settings...)
1911      */
1912      protected function execute_condition() {
1913          global $CFG;
1915          // Completion disabled in this site, don't execute
1916          if (empty($CFG->enablecompletion)) {
1917              return false;
1918          }
1920          // No user completion info found, don't execute
1921         $fullpath = $this->task->get_taskbasepath();
1922         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1923          if (!file_exists($fullpath)) {
1924              return false;
1925          }
1927          // Arrived here, execute the step
1928          return true;
1929      }
1931      protected function define_structure() {
1933         $paths = array();
1935         $paths[] = new restore_path_element('completion', '/completions/completion');
1937         return $paths;
1938     }
1940     protected function process_completion($data) {
1941         global $DB;
1943         $data = (object)$data;
1945         $data->coursemoduleid = $this->task->get_moduleid();
1946         $data->userid = $this->get_mappingid('user', $data->userid);
1947         $data->timemodified = $this->apply_date_offset($data->timemodified);
1949         $DB->insert_record('course_modules_completion', $data);
1950     }
1953 /**
1954  * Abstract structure step, parent of all the activity structure steps. Used to suuport
1955  * the main <activity ...> tag and process it. Also provides subplugin support for
1956  * activities.
1957  */
1958 abstract class restore_activity_structure_step extends restore_structure_step {
1960     protected function add_subplugin_structure($subplugintype, $element) {
1962         global $CFG;
1964         // Check the requested subplugintype is a valid one
1965         $subpluginsfile = $CFG->dirroot . '/mod/' . $this->task->get_modulename() . '/db/subplugins.php';
1966         if (!file_exists($subpluginsfile)) {
1967              throw new restore_step_exception('activity_missing_subplugins_php_file', $this->task->get_modulename());
1968         }
1969         include($subpluginsfile);
1970         if (!array_key_exists($subplugintype, $subplugins)) {
1971              throw new restore_step_exception('incorrect_subplugin_type', $subplugintype);
1972         }
1973         // Get all the restore path elements, looking across all the subplugin dirs
1974         $subpluginsdirs = get_plugin_list($subplugintype);
1975         foreach ($subpluginsdirs as $name => $subpluginsdir) {
1976             $classname = 'restore_' . $subplugintype . '_' . $name . '_subplugin';
1977             $restorefile = $subpluginsdir . '/backup/moodle2/' . $classname . '.class.php';
1978             if (file_exists($restorefile)) {
1979                 require_once($restorefile);
1980                 $restoresubplugin = new $classname($subplugintype, $name, $this);
1981                 // Add subplugin paths to the step
1982                 $this->prepare_pathelements($restoresubplugin->define_subplugin_structure($element));
1983             }
1984         }
1985     }
1987     /**
1988      * As far as activity restore steps are implementing restore_subplugin stuff, they need to
1989      * have the parent task available for wrapping purposes (get course/context....)
1990      */
1991     public function get_task() {
1992         return $this->task;
1993     }
1995     /**
1996      * Adds support for the 'activity' path that is common to all the activities
1997      * and will be processed globally here
1998      */
1999     protected function prepare_activity_structure($paths) {
2001         $paths[] = new restore_path_element('activity', '/activity');
2003         return $paths;
2004     }
2006     /**
2007      * Process the activity path, informing the task about various ids, needed later
2008      */
2009     protected function process_activity($data) {
2010         $data = (object)$data;
2011         $this->task->set_old_contextid($data->contextid); // Save old contextid in task
2012         $this->set_mapping('context', $data->contextid, $this->task->get_contextid()); // Set the mapping
2013         $this->task->set_old_activityid($data->id); // Save old activityid in task
2014     }
2016     /**
2017      * This must be invoked immediately after creating the "module" activity record (forum, choice...)
2018      * and will adjust the new activity id (the instance) in various places
2019      */
2020     protected function apply_activity_instance($newitemid) {
2021         global $DB;
2023         $this->task->set_activityid($newitemid); // Save activity id in task
2024         // Apply the id to course_sections->instanceid
2025         $DB->set_field('course_modules', 'instance', $newitemid, array('id' => $this->task->get_moduleid()));
2026         // Do the mapping for modulename, preparing it for files by oldcontext
2027         $modulename = $this->task->get_modulename();
2028         $oldid = $this->task->get_old_activityid();
2029         $this->set_mapping($modulename, $oldid, $newitemid, true);
2030     }
2033 /**
2034  * Structure step in charge of creating/mapping all the qcats and qs
2035  * by parsing the questions.xml file and checking it against the
2036  * results calculated by {@link restore_process_categories_and_questions}
2037  * and stored in backup_ids_temp
2038  */
2039 class restore_create_categories_and_questions extends restore_structure_step {
2041     protected function define_structure() {
2043         $category = new restore_path_element('question_category', '/question_categories/question_category');
2044         $question = new restore_path_element('question', '/question_categories/question_category/questions/question');
2046         // Apply for 'qtype' plugins optional paths at question level
2047         $this->add_plugin_structure('qtype', $question);
2049         return array($category, $question);
2050     }
2052     protected function process_question_category($data) {
2053         global $DB;
2055         $data = (object)$data;
2056         $oldid = $data->id;
2058         // Check we have one mapping for this category
2059         if (!$mapping = $this->get_mapping('question_category', $oldid)) {
2060             return; // No mapping = this category doesn't need to be created/mapped
2061         }
2063         // Check we have to create the category (newitemid = 0)
2064         if ($mapping->newitemid) {
2065             return; // newitemid != 0, this category is going to be mapped. Nothing to do
2066         }
2068         // Arrived here, newitemid = 0, we need to create the category
2069         // we'll do it at parentitemid context, but for CONTEXT_MODULE
2070         // categories, that will be created at CONTEXT_COURSE and moved
2071         // to module context later when the activity is created
2072         if ($mapping->info->contextlevel == CONTEXT_MODULE) {
2073             $mapping->parentitemid = $this->get_mappingid('context', $this->task->get_old_contextid());
2074         }
2075         $data->contextid = $mapping->parentitemid;
2077         // Let's create the question_category and save mapping
2078         $newitemid = $DB->insert_record('question_categories', $data);
2079         $this->set_mapping('question_category', $oldid, $newitemid);
2080         // Also annotate them as question_category_created, we need
2081         // that later when remapping parents
2082         $this->set_mapping('question_category_created', $oldid, $newitemid, false, null, $data->contextid);
2083     }
2085     protected function process_question($data) {
2086         global $DB;
2088         $data = (object)$data;
2089         $oldid = $data->id;
2091         // Check we have one mapping for this question
2092         if (!$questionmapping = $this->get_mapping('question', $oldid)) {
2093             return; // No mapping = this question doesn't need to be created/mapped
2094         }
2096         // Get the mapped category (cannot use get_new_parentid() because not
2097         // all the categories have been created, so it is not always available
2098         // Instead we get the mapping for the question->parentitemid because
2099         // we have loaded qcatids there for all parsed questions
2100         $data->category = $this->get_mappingid('question_category', $questionmapping->parentitemid);
2102         $data->timecreated  = $this->apply_date_offset($data->timecreated);
2103         $data->timemodified = $this->apply_date_offset($data->timemodified);
2105         $userid = $this->get_mappingid('user', $data->createdby);
2106         $data->createdby = $userid ? $userid : $this->task->get_userid();
2108         $userid = $this->get_mappingid('user', $data->modifiedby);
2109         $data->modifiedby = $userid ? $userid : $this->task->get_userid();
2111         // With newitemid = 0, let's create the question
2112         if (!$questionmapping->newitemid) {
2113             $newitemid = $DB->insert_record('question', $data);
2114             $this->set_mapping('question', $oldid, $newitemid);
2115             // Also annotate them as question_created, we need
2116             // that later when remapping parents (keeping the old categoryid as parentid)
2117             $this->set_mapping('question_created', $oldid, $newitemid, false, null, $questionmapping->parentitemid);
2118         } else {
2119             // By performing this set_mapping() we make get_old/new_parentid() to work for all the
2120             // children elements of the 'question' one (so qtype plugins will know the question they belong to)
2121             $this->set_mapping('question', $oldid, $questionmapping->newitemid);
2122         }
2124         // Note, we don't restore any question files yet
2125         // as far as the CONTEXT_MODULE categories still
2126         // haven't their contexts to be restored to
2127         // The {@link restore_create_question_files}, executed in the final step
2128         // step will be in charge of restoring all the question files
2129     }
2131     protected function after_execute() {
2132         global $DB;
2134         // First of all, recode all the created question_categories->parent fields
2135         $qcats = $DB->get_records('backup_ids_temp', array(
2136                      'backupid' => $this->get_restoreid(),
2137                      'itemname' => 'question_category_created'));
2138         foreach ($qcats as $qcat) {
2139             $newparent = 0;
2140             $dbcat = $DB->get_record('question_categories', array('id' => $qcat->newitemid));
2141             // Get new parent (mapped or created, so we look in quesiton_category mappings)
2142             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
2143                                  'backupid' => $this->get_restoreid(),
2144                                  'itemname' => 'question_category',
2145                                  'itemid'   => $dbcat->parent))) {
2146                 // contextids must match always, as far as we always include complete qbanks, just check it
2147                 $newparentctxid = $DB->get_field('question_categories', 'contextid', array('id' => $newparent));
2148                 if ($dbcat->contextid == $newparentctxid) {
2149                     $DB->set_field('question_categories', 'parent', $newparent, array('id' => $dbcat->id));
2150                 } else {
2151                     $newparent = 0; // No ctx match for both cats, no parent relationship
2152                 }
2153             }
2154             // Here with $newparent empty, problem with contexts or remapping, set it to top cat
2155             if (!$newparent) {
2156                 $DB->set_field('question_categories', 'parent', 0, array('id' => $dbcat->id));
2157             }
2158         }
2160         // Now, recode all the created question->parent fields
2161         $qs = $DB->get_records('backup_ids_temp', array(
2162                   'backupid' => $this->get_restoreid(),
2163                   'itemname' => 'question_created'));
2164         foreach ($qs as $q) {
2165             $newparent = 0;
2166             $dbq = $DB->get_record('question', array('id' => $q->newitemid));
2167             // Get new parent (mapped or created, so we look in question mappings)
2168             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
2169                                  'backupid' => $this->get_restoreid(),
2170                                  'itemname' => 'question',
2171                                  'itemid'   => $dbq->parent))) {
2172                 $DB->set_field('question', 'parent', $newparent, array('id' => $dbq->id));
2173             }
2174         }
2176         // Note, we don't restore any question files yet
2177         // as far as the CONTEXT_MODULE categories still
2178         // haven't their contexts to be restored to
2179         // The {@link restore_create_question_files}, executed in the final step
2180         // step will be in charge of restoring all the question files
2181     }
2184 /**
2185  * Execution step that will move all the CONTEXT_MODULE question categories
2186  * created at early stages of restore in course context (because modules weren't
2187  * created yet) to their target module (matching by old-new-contextid mapping)
2188  */
2189 class restore_move_module_questions_categories extends restore_execution_step {
2191     protected function define_execution() {
2192         global $DB;
2194         $contexts = restore_dbops::restore_get_question_banks($this->get_restoreid(), CONTEXT_MODULE);
2195         foreach ($contexts as $contextid => $contextlevel) {
2196             // Only if context mapping exists (i.e. the module has been restored)
2197             if ($newcontext = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $contextid)) {
2198                 // Update all the qcats having their parentitemid set to the original contextid
2199                 $modulecats = $DB->get_records_sql("SELECT itemid, newitemid
2200                                                       FROM {backup_ids_temp}
2201                                                      WHERE backupid = ?
2202                                                        AND itemname = 'question_category'
2203                                                        AND parentitemid = ?", array($this->get_restoreid(), $contextid));
2204                 foreach ($modulecats as $modulecat) {
2205                     $DB->set_field('question_categories', 'contextid', $newcontext->newitemid, array('id' => $modulecat->newitemid));
2206                     // And set new contextid also in question_category mapping (will be
2207                     // used by {@link restore_create_question_files} later
2208                     restore_dbops::set_backup_ids_record($this->get_restoreid(), 'question_category', $modulecat->itemid, $modulecat->newitemid, $newcontext->newitemid);
2209                 }
2210             }
2211         }
2212     }
2215 /**
2216  * Execution step that will create all the question/answers/qtype-specific files for the restored
2217  * questions. It must be executed after {@link restore_move_module_questions_categories}
2218  * because only then each question is in its final category and only then the
2219  * context can be determined
2220  *
2221  * TODO: Improve this. Instead of looping over each question, it can be reduced to
2222  *       be done by contexts (this will save a huge ammount of queries)
2223  */
2224 class restore_create_question_files extends restore_execution_step {
2226     protected function define_execution() {
2227         global $DB;
2229         // Let's process only created questions
2230         $questionsrs = $DB->get_recordset_sql("SELECT bi.itemid, bi.newitemid, bi.parentitemid, q.qtype
2231                                                FROM {backup_ids_temp} bi
2232                                                JOIN {question} q ON q.id = bi.newitemid
2233                                               WHERE bi.backupid = ?
2234                                                 AND bi.itemname = 'question_created'", array($this->get_restoreid()));
2235         foreach ($questionsrs as $question) {
2236             // Get question_category mapping, it contains the target context for the question
2237             if (!$qcatmapping = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'question_category', $question->parentitemid)) {
2238                 // Something went really wrong, cannot find the question_category for the question
2239                 debugging('Error fetching target context for question', DEBUG_DEVELOPER);
2240                 continue;
2241             }
2242             // Calculate source and target contexts
2243             $oldctxid = $qcatmapping->info->contextid;
2244             $newctxid = $qcatmapping->parentitemid;
2246             // Add common question files (question and question_answer ones)
2247             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'questiontext',
2248                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
2249             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'generalfeedback',
2250                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
2251             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'answerfeedback',
2252                                               $oldctxid, $this->task->get_userid(), 'question_answer', null, $newctxid, true);
2253             // Add qtype dependent files
2254             $components = backup_qtype_plugin::get_components_and_fileareas($question->qtype);
2255             foreach ($components as $component => $fileareas) {
2256                 foreach ($fileareas as $filearea => $mapping) {
2257                     // Use itemid only if mapping is question_created
2258                     $itemid = ($mapping == 'question_created') ? $question->itemid : null;
2259                     restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), $component, $filearea,
2260                                                       $oldctxid, $this->task->get_userid(), $mapping, $itemid, $newctxid, true);
2261                 }
2262             }
2263         }
2264         $questionsrs->close();
2265     }
2268 /**
2269  * Abstract structure step, to be used by all the activities using core questions stuff
2270  * (like the quiz module), to support qtype plugins, states and sessions
2271  */
2272 abstract class restore_questions_activity_structure_step extends restore_activity_structure_step {
2274     /**
2275      * Attach below $element (usually attempts) the needed restore_path_elements
2276      * to restore question_states
2277      */
2278     protected function add_question_attempts_states($element, &$paths) {
2279         // Check $element is restore_path_element
2280         if (! $element instanceof restore_path_element) {
2281             throw new restore_step_exception('element_must_be_restore_path_element', $element);
2282         }
2283         // Check $paths is one array
2284         if (!is_array($paths)) {
2285             throw new restore_step_exception('paths_must_be_array', $paths);
2286         }
2287         $paths[] = new restore_path_element('question_state', $element->get_path() . '/states/state');
2288     }
2290     /**
2291      * Attach below $element (usually attempts) the needed restore_path_elements
2292      * to restore question_sessions
2293      */
2294     protected function add_question_attempts_sessions($element, &$paths) {
2295         // Check $element is restore_path_element
2296         if (! $element instanceof restore_path_element) {
2297             throw new restore_step_exception('element_must_be_restore_path_element', $element);
2298         }
2299         // Check $paths is one array
2300         if (!is_array($paths)) {
2301             throw new restore_step_exception('paths_must_be_array', $paths);
2302         }
2303         $paths[] = new restore_path_element('question_session', $element->get_path() . '/sessions/session');
2304     }
2306     /**
2307      * Process question_states
2308      */
2309     protected function process_question_state($data) {
2310         global $DB;
2312         $data = (object)$data;
2313         $oldid = $data->id;
2315         // Get complete question mapping, we'll need info
2316         $question = $this->get_mapping('question', $data->question);
2318         // In the quiz_attempt mapping we are storing uniqueid
2319         // and not id, so this gets the correct question_attempt to point to
2320         $data->attempt  = $this->get_new_parentid('quiz_attempt');
2321         $data->question = $question->newitemid;
2322         $data->answer   = $this->restore_recode_answer($data, $question->info->qtype); // Delegate recoding of answer
2323         $data->timestamp= $this->apply_date_offset($data->timestamp);
2325         // Everything ready, insert and create mapping (needed by question_sessions)
2326         $newitemid = $DB->insert_record('question_states', $data);
2327         $this->set_mapping('question_state', $oldid, $newitemid);
2328     }
2330     /**
2331      * Process question_sessions
2332      */
2333     protected function process_question_session($data) {
2334         global $DB;
2336         $data = (object)$data;
2337         $oldid = $data->id;
2339         // In the quiz_attempt mapping we are storing uniqueid
2340         // and not id, so this gets the correct question_attempt to point to
2341         $data->attemptid  = $this->get_new_parentid('quiz_attempt');
2342         $data->questionid = $this->get_mappingid('question', $data->questionid);
2343         $data->newest     = $this->get_mappingid('question_state', $data->newest);
2344         $data->newgraded  = $this->get_mappingid('question_state', $data->newgraded);
2346         // Everything ready, insert (no mapping needed)
2347         $newitemid = $DB->insert_record('question_sessions', $data);
2349         // Note: question_sessions haven't files associated. On purpose manualcomment is lacking
2350         // support for them, so we don't need to handle them here.
2351     }
2353     /**
2354      * Given a list of question->ids, separated by commas, returns the
2355      * recoded list, with all the restore question mappings applied.
2356      * Note: Used by quiz->questions and quiz_attempts->layout
2357      * Note: 0 = page break (unconverted)
2358      */
2359     protected function questions_recode_layout($layout) {
2360         // Extracts question id from sequence
2361         if ($questionids = explode(',', $layout)) {
2362             foreach ($questionids as $id => $questionid) {
2363                 if ($questionid) { // If it is zero then this is a pagebreak, don't translate
2364                     $newquestionid = $this->get_mappingid('question', $questionid);
2365                     $questionids[$id] = $newquestionid;
2366                 }
2367             }
2368         }
2369         return implode(',', $questionids);
2370     }
2372     /**
2373      * Given one question_states record, return the answer
2374      * recoded pointing to all the restored stuff
2375      */
2376     public function restore_recode_answer($state, $qtype) {
2377         // Build one static cache to store {@link restore_qtype_plugin}
2378         // while we are needing them, just to save zillions of instantiations
2379         // or using static stuff that will break our nice API
2380         static $qtypeplugins = array();
2382         // If we haven't the corresponding restore_qtype_plugin for current qtype
2383         // instantiate it and add to cache
2384         if (!isset($qtypeplugins[$qtype])) {
2385             $classname = 'restore_qtype_' . $qtype . '_plugin';
2386             if (class_exists($classname)) {
2387                 $qtypeplugins[$qtype] = new $classname('qtype', $qtype, $this);
2388             } else {
2389                 $qtypeplugins[$qtype] = false;
2390             }
2391         }
2392         return !empty($qtypeplugins[$qtype]) ? $qtypeplugins[$qtype]->recode_state_answer($state) : $state->answer;
2393     }