Merge branch 'MDL-26572_backup_sum' of git://github.com/andyjdavis/moodle
[moodle.git] / backup / moodle2 / restore_stepslib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * @package moodlecore
20  * @subpackage backup-moodle2
21  * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 /**
26  * Define all the restore steps that will be used by common tasks in restore
27  */
29 /**
30  * delete old directories and conditionally create backup_temp_ids table
31  */
32 class restore_create_and_clean_temp_stuff extends restore_execution_step {
34     protected function define_execution() {
35         $exists = restore_controller_dbops::create_restore_temp_tables($this->get_restoreid()); // temp tables conditionally
36         // If the table already exists, it's because restore_prechecks have been executed in the same
37         // request (without problems) and it already contains a bunch of preloaded information (users...)
38         // that we aren't going to execute again
39         if ($exists) { // Inform plan about preloaded information
40             $this->task->set_preloaded_information();
41         }
42         // Create the old-course-ctxid to new-course-ctxid mapping, we need that available since the beginning
43         $itemid = $this->task->get_old_contextid();
44         $newitemid = get_context_instance(CONTEXT_COURSE, $this->get_courseid())->id;
45         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'context', $itemid, $newitemid);
46         // Create the old-system-ctxid to new-system-ctxid mapping, we need that available since the beginning
47         $itemid = $this->task->get_old_system_contextid();
48         $newitemid = get_context_instance(CONTEXT_SYSTEM)->id;
49         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'context', $itemid, $newitemid);
50         // Create the old-course-id to new-course-id mapping, we need that available since the beginning
51         $itemid = $this->task->get_old_courseid();
52         $newitemid = $this->get_courseid();
53         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'course', $itemid, $newitemid);
55     }
56 }
58 /**
59  * delete the temp dir used by backup/restore (conditionally),
60  * delete old directories and drop temp ids table
61  */
62 class restore_drop_and_clean_temp_stuff extends restore_execution_step {
64     protected function define_execution() {
65         global $CFG;
66         restore_controller_dbops::drop_restore_temp_tables($this->get_restoreid()); // Drop ids temp table
67         backup_helper::delete_old_backup_dirs(time() - (4 * 60 * 60));              // Delete > 4 hours temp dirs
68         if (empty($CFG->keeptempdirectoriesonbackup)) { // Conditionally
69             backup_helper::delete_backup_dir($this->task->get_tempdir()); // Empty restore dir
70         }
71     }
72 }
74 /**
75  * Restore calculated grade items, grade categories etc
76  */
77 class restore_gradebook_structure_step extends restore_structure_step {
79     /**
80      * To conditionally decide if this step must be executed
81      * Note the "settings" conditions are evaluated in the
82      * corresponding task. Here we check for other conditions
83      * not being restore settings (files, site settings...)
84      */
85      protected function execute_condition() {
86         global $CFG, $DB;
88         // No gradebook info found, don't execute
89         $fullpath = $this->task->get_taskbasepath();
90         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
91         if (!file_exists($fullpath)) {
92             return false;
93         }
95         // Some module present in backup file isn't available to restore
96         // in this site, don't execute
97         if ($this->task->is_missing_modules()) {
98             return false;
99         }
101         // Some activity has been excluded to be restored, don't execute
102         if ($this->task->is_excluding_activities()) {
103             return false;
104         }
106         // There should only be one grade category (the 1 associated with the course itself)
107         // If other categories already exist we're restoring into an existing course.
108         // Restoring categories into a course with an existing category structure is unlikely to go well
109         $category = new stdclass();
110         $category->courseid  = $this->get_courseid();
111         $catcount = $DB->count_records('grade_categories', (array)$category);
112         if ($catcount>1) {
113             return false;
114         }
116         // Arrived here, execute the step
117         return true;
118      }
120     protected function define_structure() {
121         $paths = array();
122         $userinfo = $this->task->get_setting_value('users');
124         $paths[] = new restore_path_element('gradebook', '/gradebook');
125         $paths[] = new restore_path_element('grade_category', '/gradebook/grade_categories/grade_category');
126         $paths[] = new restore_path_element('grade_item', '/gradebook/grade_items/grade_item');
127         if ($userinfo) {
128             $paths[] = new restore_path_element('grade_grade', '/gradebook/grade_items/grade_item/grade_grades/grade_grade');
129         }
130         $paths[] = new restore_path_element('grade_letter', '/gradebook/grade_letters/grade_letter');
131         $paths[] = new restore_path_element('grade_setting', '/gradebook/grade_settings/grade_setting');
133         return $paths;
134     }
136     protected function process_gradebook($data) {
137     }
139     protected function process_grade_item($data) {
140         global $DB;
142         $data = (object)$data;
144         $oldid = $data->id;
145         $data->course = $this->get_courseid();
147         $data->courseid = $this->get_courseid();
149         //manual grade items store category id in categoryid
150         if ($data->itemtype=='manual') {
151             $data->categoryid = $this->get_mappingid('grade_category', $data->categoryid, NULL);
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, NULL);
155         }
157         $data->scaleid   = $this->get_mappingid('scale', $data->scaleid, NULL);
158         $data->outcomeid = $this->get_mappingid('outcome', $data->outcomeid, NULL);
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') {
167             //get the ID of the already created grade item
168             $gi = new stdclass();
169             $gi->courseid  = $this->get_courseid();
170             $gi->itemtype  = $data->itemtype;
172             //need to get the id of the grade_category that was automatically created for the course
173             $category = new stdclass();
174             $category->courseid  = $this->get_courseid();
175             $category->parent  = null;
176             //course category fullname starts out as ? but may be edited
177             //$category->fullname  = '?';
178             $coursecategory = $DB->get_record('grade_categories', (array)$category);
179             $gi->iteminstance = $coursecategory->id;
181             $existinggradeitem = $DB->get_record('grade_items', (array)$gi);
182             if (!empty($existinggradeitem)) {
183                 $data->id = $newitemid = $existinggradeitem->id;
184                 $DB->update_record('grade_items', $data);
185             }
186         }
188         if (empty($newitemid)) {
189             //in case we found the course category but still need to insert the course grade item
190             if ($data->itemtype=='course' && !empty($coursecategory)) {
191                 $data->iteminstance = $coursecategory->id;
192             }
194             $newitemid = $DB->insert_record('grade_items', $data);
195         }
196         $this->set_mapping('grade_item', $oldid, $newitemid);
197     }
199     protected function process_grade_grade($data) {
200         global $DB;
202         $data = (object)$data;
203         $oldid = $data->id;
205         $data->itemid = $this->get_new_parentid('grade_item');
207         $data->userid = $this->get_mappingid('user', $data->userid, NULL);
208         $data->usermodified = $this->get_mappingid('user', $data->usermodified, NULL);
209         $data->locktime     = $this->apply_date_offset($data->locktime);
210         // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
211         $data->overridden = $this->apply_date_offset($data->overridden);
212         $data->timecreated  = $this->apply_date_offset($data->timecreated);
213         $data->timemodified = $this->apply_date_offset($data->timemodified);
215         $newitemid = $DB->insert_record('grade_grades', $data);
216         //$this->set_mapping('grade_grade', $oldid, $newitemid);
217     }
218     protected function process_grade_category($data) {
219         global $DB;
221         $data = (object)$data;
222         $oldid = $data->id;
224         $data->course = $this->get_courseid();
225         $data->courseid = $data->course;
227         $data->timecreated  = $this->apply_date_offset($data->timecreated);
228         $data->timemodified = $this->apply_date_offset($data->timemodified);
230         $newitemid = null;
231         //no parent means a course level grade category. That may have been created when the course was created
232         if(empty($data->parent)) {
233             //parent was being saved as 0 when it should be null
234             $data->parent = null;
236             //get the already created course level grade category
237             $category = new stdclass();
238             $category->courseid = $this->get_courseid();
240             $coursecategory = $DB->get_record('grade_categories', (array)$category);
241             if (!empty($coursecategory)) {
242                 $data->id = $newitemid = $coursecategory->id;
243                 $DB->update_record('grade_categories', $data);
244             }
245         }
247         //need to insert a course category
248         if (empty($newitemid)) {
249             $newitemid = $DB->insert_record('grade_categories', $data);
250         }
251         $this->set_mapping('grade_category', $oldid, $newitemid);
252     }
253     protected function process_grade_letter($data) {
254         global $DB;
256         $data = (object)$data;
257         $oldid = $data->id;
259         $data->contextid = get_context_instance(CONTEXT_COURSE, $this->get_courseid())->id;
261         $newitemid = $DB->insert_record('grade_letters', $data);
262         $this->set_mapping('grade_letter', $oldid, $newitemid);
263     }
264     protected function process_grade_setting($data) {
265         global $DB;
267         $data = (object)$data;
268         $oldid = $data->id;
270         $data->courseid = $this->get_courseid();
272         $newitemid = $DB->insert_record('grade_settings', $data);
273         //$this->set_mapping('grade_setting', $oldid, $newitemid);
274     }
276     //put all activity grade items in the correct grade category and mark all for recalculation
277     protected function after_execute() {
278         global $DB;
280         $conditions = array(
281             'backupid' => $this->get_restoreid(),
282             'itemname' => 'grade_item'//,
283             //'itemid'   => $itemid
284         );
285         $rs = $DB->get_recordset('backup_ids_temp', $conditions);
287         if (!empty($rs)) {
288             foreach($rs as $grade_item_backup) {
289                 $updateobj = new stdclass();
290                 $updateobj->id = $grade_item_backup->newitemid;
292                 //if this is an activity grade item that needs to be put back in its correct category
293                 if (!empty($grade_item_backup->parentitemid)) {
294                     $updateobj->categoryid = $this->get_mappingid('grade_category', $grade_item_backup->parentitemid);
295                 } else {
296                     //mark course and category items as needing to be recalculated
297                     $updateobj->needsupdate=1;
298                 }
299                 $DB->update_record('grade_items', $updateobj);
300             }
301         }
302         $rs->close();
304         //need to correct the grade category path and parent
305         $conditions = array(
306             'courseid' => $this->get_courseid()
307         );
308         $grade_category = new stdclass();
310         $rs = $DB->get_recordset('grade_categories', $conditions);
311         if (!empty($rs)) {
312             //get all the parents correct first as grade_category::build_path() loads category parents from the DB
313             foreach($rs as $gc) {
314                 if (!empty($gc->parent)) {
315                     $grade_category->id = $gc->id;
316                     $grade_category->parent = $this->get_mappingid('grade_category', $gc->parent);
317                     $DB->update_record('grade_categories', $grade_category);
318                 }
319             }
320         }
321         if (isset($grade_category->parent)) {
322             unset($grade_category->parent);
323         }
324         $rs->close();
326         $rs = $DB->get_recordset('grade_categories', $conditions);
327         if (!empty($rs)) {
328             //now we can rebuild all the paths
329             foreach($rs as $gc) {
330                 $grade_category->id = $gc->id;
331                 $grade_category->path = grade_category::build_path($gc);
332                 $DB->update_record('grade_categories', $grade_category);
333             }
334         }
335         $rs->close();
337         //Restore marks items as needing update. Update everything now.
338         grade_regrade_final_grades($this->get_courseid());
339     }
342 /**
343  * decode all the interlinks present in restored content
344  * relying 100% in the restore_decode_processor that handles
345  * both the contents to modify and the rules to be applied
346  */
347 class restore_decode_interlinks extends restore_execution_step {
349     protected function define_execution() {
350         // Get the decoder (from the plan)
351         $decoder = $this->task->get_decoder();
352         restore_decode_processor::register_link_decoders($decoder); // Add decoder contents and rules
353         // And launch it, everything will be processed
354         $decoder->execute();
355     }
358 /**
359  * first, ensure that we have no gaps in section numbers
360  * and then, rebuid the course cache
361  */
362 class restore_rebuild_course_cache extends restore_execution_step {
364     protected function define_execution() {
365         global $DB;
367         // Although there is some sort of auto-recovery of missing sections
368         // present in course/formats... here we check that all the sections
369         // from 0 to MAX(section->section) exist, creating them if necessary
370         $maxsection = $DB->get_field('course_sections', 'MAX(section)', array('course' => $this->get_courseid()));
371         // Iterate over all sections
372         for ($i = 0; $i <= $maxsection; $i++) {
373             // If the section $i doesn't exist, create it
374             if (!$DB->record_exists('course_sections', array('course' => $this->get_courseid(), 'section' => $i))) {
375                 $sectionrec = array(
376                     'course' => $this->get_courseid(),
377                     'section' => $i);
378                 $DB->insert_record('course_sections', $sectionrec); // missing section created
379             }
380         }
382         // Rebuild cache now that all sections are in place
383         rebuild_course_cache($this->get_courseid());
384     }
387 /**
388  * Review all the tasks having one after_restore method
389  * executing it to perform some final adjustments of information
390  * not available when the task was executed.
391  */
392 class restore_execute_after_restore extends restore_execution_step {
394     protected function define_execution() {
396         // Simply call to the execute_after_restore() method of the task
397         // that always is the restore_final_task
398         $this->task->launch_execute_after_restore();
399     }
403 /**
404  * Review all the (pending) block positions in backup_ids, matching by
405  * contextid, creating positions as needed. This is executed by the
406  * final task, once all the contexts have been created
407  */
408 class restore_review_pending_block_positions extends restore_execution_step {
410     protected function define_execution() {
411         global $DB;
413         // Get all the block_position objects pending to match
414         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'block_position');
415         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid');
416         // Process block positions, creating them or accumulating for final step
417         foreach($rs as $posrec) {
418             // Get the complete position object (stored as info)
419             $position = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'block_position', $posrec->itemid)->info;
420             // If position is for one already mapped (known) contextid
421             // process it now, creating the position, else nothing to
422             // do, position finally discarded
423             if ($newctx = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $position->contextid)) {
424                 $position->contextid = $newctx->newitemid;
425                 // Create the block position
426                 $DB->insert_record('block_positions', $position);
427             }
428         }
429         $rs->close();
430     }
433 /**
434  * Process all the saved module availability records in backup_ids, matching
435  * course modules and grade item id once all them have been already restored.
436  * only if all matchings are satisfied the availability condition will be created.
437  * At the same time, it is required for the site to have that functionality enabled.
438  */
439 class restore_process_course_modules_availability extends restore_execution_step {
441     protected function define_execution() {
442         global $CFG, $DB;
444         // Site hasn't availability enabled
445         if (empty($CFG->enableavailability)) {
446             return;
447         }
449         // Get all the module_availability objects to process
450         $params = array('backupid' => $this->get_restoreid(), 'itemname' => 'module_availability');
451         $rs = $DB->get_recordset('backup_ids_temp', $params, '', 'itemid');
452         // Process availabilities, creating them if everything matches ok
453         foreach($rs as $availrec) {
454             $allmatchesok = true;
455             // Get the complete availabilityobject
456             $availability = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'module_availability', $availrec->itemid)->info;
457             // Map the sourcecmid if needed and possible
458             if (!empty($availability->sourcecmid)) {
459                 $newcm = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'course_module', $availability->sourcecmid);
460                 if ($newcm) {
461                     $availability->sourcecmid = $newcm->newitemid;
462                 } else {
463                     $allmatchesok = false; // Failed matching, we won't create this availability rule
464                 }
465             }
466             // Map the gradeitemid if needed and possible
467             if (!empty($availability->gradeitemid)) {
468                 $newgi = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'grade_item', $availability->gradeitemid);
469                 if ($newgi) {
470                     $availability->gradeitemid = $newgi->newitemid;
471                 } else {
472                     $allmatchesok = false; // Failed matching, we won't create this availability rule
473                 }
474             }
475             if ($allmatchesok) { // Everything ok, create the availability rule
476                 $DB->insert_record('course_modules_availability', $availability);
477             }
478         }
479         $rs->close();
480     }
484 /*
485  * Execution step that, *conditionally* (if there isn't preloaded information)
486  * will load the inforef files for all the included course/section/activity tasks
487  * to backup_temp_ids. They will be stored with "xxxxref" as itemname
488  */
489 class restore_load_included_inforef_records extends restore_execution_step {
491     protected function define_execution() {
493         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
494             return;
495         }
497         // Get all the included tasks
498         $tasks = restore_dbops::get_included_tasks($this->get_restoreid());
499         foreach ($tasks as $task) {
500             // Load the inforef.xml file if exists
501             $inforefpath = $task->get_taskbasepath() . '/inforef.xml';
502             if (file_exists($inforefpath)) {
503                 restore_dbops::load_inforef_to_tempids($this->get_restoreid(), $inforefpath); // Load each inforef file to temp_ids
504             }
505         }
506     }
509 /*
510  * Execution step that will load all the needed files into backup_files_temp
511  *   - info: contains the whole original object (times, names...)
512  * (all them being original ids as loaded from xml)
513  */
514 class restore_load_included_files extends restore_structure_step {
516     protected function define_structure() {
518         $file = new restore_path_element('file', '/files/file');
520         return array($file);
521     }
523     // Processing functions go here
524     public function process_file($data) {
526         $data = (object)$data; // handy
528         // load it if needed:
529         //   - it it is one of the annotated inforef files (course/section/activity/block)
530         //   - it is one "user", "group", "grouping", "grade", "question" or "qtype_xxxx" component file (that aren't sent to inforef ever)
531         // TODO: qtype_xxx should be replaced by proper backup_qtype_plugin::get_components_and_fileareas() use,
532         //       but then we'll need to change it to load plugins itself (because this is executed too early in restore)
533         $isfileref   = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'fileref', $data->id);
534         $iscomponent = ($data->component == 'user' || $data->component == 'group' ||
535                         $data->component == 'grouping' || $data->component == 'grade' ||
536                         $data->component == 'question' || substr($data->component, 0, 5) == 'qtype');
537         if ($isfileref || $iscomponent) {
538             restore_dbops::set_backup_files_record($this->get_restoreid(), $data);
539         }
540     }
543 /**
544  * Execution step that, *conditionally* (if there isn't preloaded information),
545  * will load all the needed roles to backup_temp_ids. They will be stored with
546  * "role" itemname. Also it will perform one automatic mapping to roles existing
547  * in the target site, based in permissions of the user performing the restore,
548  * archetypes and other bits. At the end, each original role will have its associated
549  * target role or 0 if it's going to be skipped. Note we wrap everything over one
550  * restore_dbops method, as far as the same stuff is going to be also executed
551  * by restore prechecks
552  */
553 class restore_load_and_map_roles extends restore_execution_step {
555     protected function define_execution() {
556         if ($this->task->get_preloaded_information()) { // if info is already preloaded
557             return;
558         }
560         $file = $this->get_basepath() . '/roles.xml';
561         // Load needed toles to temp_ids
562         restore_dbops::load_roles_to_tempids($this->get_restoreid(), $file);
564         // Process roles, mapping/skipping. Any error throws exception
565         // Note we pass controller's info because it can contain role mapping information
566         // about manual mappings performed by UI
567         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);
568     }
571 /**
572  * Execution step that, *conditionally* (if there isn't preloaded information
573  * and users have been selected in settings, will load all the needed users
574  * to backup_temp_ids. They will be stored with "user" itemname and with
575  * their original contextid as paremitemid
576  */
577 class restore_load_included_users extends restore_execution_step {
579     protected function define_execution() {
581         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
582             return;
583         }
584         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
585             return;
586         }
587         $file = $this->get_basepath() . '/users.xml';
588         restore_dbops::load_users_to_tempids($this->get_restoreid(), $file); // Load needed users to temp_ids
589     }
592 /**
593  * Execution step that, *conditionally* (if there isn't preloaded information
594  * and users have been selected in settings, will process all the needed users
595  * in order to decide and perform any action with them (create / map / error)
596  * Note: Any error will cause exception, as far as this is the same processing
597  * than the one into restore prechecks (that should have stopped process earlier)
598  */
599 class restore_process_included_users extends restore_execution_step {
601     protected function define_execution() {
603         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
604             return;
605         }
606         if (!$this->task->get_setting_value('users')) { // No userinfo being restored, nothing to do
607             return;
608         }
609         restore_dbops::process_included_users($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
610     }
613 /**
614  * Execution step that will create all the needed users as calculated
615  * by @restore_process_included_users (those having newiteind = 0)
616  */
617 class restore_create_included_users extends restore_execution_step {
619     protected function define_execution() {
621         restore_dbops::create_included_users($this->get_basepath(), $this->get_restoreid(), $this->get_setting_value('user_files'), $this->task->get_userid());
622     }
625 /**
626  * Structure step that will create all the needed groups and groupings
627  * by loading them from the groups.xml file performing the required matches.
628  * Note group members only will be added if restoring user info
629  */
630 class restore_groups_structure_step extends restore_structure_step {
632     protected function define_structure() {
634         $paths = array(); // Add paths here
636         $paths[] = new restore_path_element('group', '/groups/group');
637         if ($this->get_setting_value('users')) {
638             $paths[] = new restore_path_element('member', '/groups/group/group_members/group_member');
639         }
640         $paths[] = new restore_path_element('grouping', '/groups/groupings/grouping');
641         $paths[] = new restore_path_element('grouping_group', '/groups/groupings/grouping/grouping_groups/grouping_group');
643         return $paths;
644     }
646     // Processing functions go here
647     public function process_group($data) {
648         global $DB;
650         $data = (object)$data; // handy
651         $data->courseid = $this->get_courseid();
653         $oldid = $data->id;    // need this saved for later
655         $restorefiles = false; // Only if we end creating the group
657         // Search if the group already exists (by name & description) in the target course
658         $description_clause = '';
659         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
660         if (!empty($data->description)) {
661             $description_clause = ' AND ' .
662                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
663            $params['description'] = $data->description;
664         }
665         if (!$groupdb = $DB->get_record_sql("SELECT *
666                                                FROM {groups}
667                                               WHERE courseid = :courseid
668                                                 AND name = :grname $description_clause", $params)) {
669             // group doesn't exist, create
670             $newitemid = $DB->insert_record('groups', $data);
671             $restorefiles = true; // We'll restore the files
672         } else {
673             // group exists, use it
674             $newitemid = $groupdb->id;
675         }
676         // Save the id mapping
677         $this->set_mapping('group', $oldid, $newitemid, $restorefiles);
678     }
680     public function process_member($data) {
681         global $DB;
683         $data = (object)$data; // handy
685         // get parent group->id
686         $data->groupid = $this->get_new_parentid('group');
688         // map user newitemid and insert if not member already
689         if ($data->userid = $this->get_mappingid('user', $data->userid)) {
690             if (!$DB->record_exists('groups_members', array('groupid' => $data->groupid, 'userid' => $data->userid))) {
691                 $DB->insert_record('groups_members', $data);
692             }
693         }
694     }
696     public function process_grouping($data) {
697         global $DB;
699         $data = (object)$data; // handy
700         $data->courseid = $this->get_courseid();
702         $oldid = $data->id;    // need this saved for later
703         $restorefiles = false; // Only if we end creating the grouping
705         // Search if the grouping already exists (by name & description) in the target course
706         $description_clause = '';
707         $params = array('courseid' => $this->get_courseid(), 'grname' => $data->name);
708         if (!empty($data->description)) {
709             $description_clause = ' AND ' .
710                                   $DB->sql_compare_text('description') . ' = ' . $DB->sql_compare_text(':description');
711            $params['description'] = $data->description;
712         }
713         if (!$groupingdb = $DB->get_record_sql("SELECT *
714                                                   FROM {groupings}
715                                                  WHERE courseid = :courseid
716                                                    AND name = :grname $description_clause", $params)) {
717             // grouping doesn't exist, create
718             $newitemid = $DB->insert_record('groupings', $data);
719             $restorefiles = true; // We'll restore the files
720         } else {
721             // grouping exists, use it
722             $newitemid = $groupingdb->id;
723         }
724         // Save the id mapping
725         $this->set_mapping('grouping', $oldid, $newitemid, $restorefiles);
726     }
728     public function process_grouping_group($data) {
729         global $DB;
731         $data = (object)$data;
733         $data->groupingid = $this->get_new_parentid('grouping'); // Use new parentid
734         $data->groupid    = $this->get_mappingid('group', $data->groupid); // Get from mappings
735         $DB->insert_record('groupings_groups', $data);  // No need to set this mapping (no child info nor files)
736     }
738     protected function after_execute() {
739         // Add group related files, matching with "group" mappings
740         $this->add_related_files('group', 'icon', 'group');
741         $this->add_related_files('group', 'description', 'group');
742         // Add grouping related files, matching with "grouping" mappings
743         $this->add_related_files('grouping', 'description', 'grouping');
744     }
748 /**
749  * Structure step that will create all the needed scales
750  * by loading them from the scales.xml
751  */
752 class restore_scales_structure_step extends restore_structure_step {
754     protected function define_structure() {
756         $paths = array(); // Add paths here
757         $paths[] = new restore_path_element('scale', '/scales_definition/scale');
758         return $paths;
759     }
761     protected function process_scale($data) {
762         global $DB;
764         $data = (object)$data;
766         $restorefiles = false; // Only if we end creating the group
768         $oldid = $data->id;    // need this saved for later
770         // Look for scale (by 'scale' both in standard (course=0) and current course
771         // with priority to standard scales (ORDER clause)
772         // scale is not course unique, use get_record_sql to suppress warning
773         // Going to compare LOB columns so, use the cross-db sql_compare_text() in both sides
774         $compare_scale_clause = $DB->sql_compare_text('scale')  . ' = ' . $DB->sql_compare_text(':scaledesc');
775         $params = array('courseid' => $this->get_courseid(), 'scaledesc' => $data->scale);
776         if (!$scadb = $DB->get_record_sql("SELECT *
777                                             FROM {scale}
778                                            WHERE courseid IN (0, :courseid)
779                                              AND $compare_scale_clause
780                                         ORDER BY courseid", $params, IGNORE_MULTIPLE)) {
781             // Remap the user if possible, defaut to user performing the restore if not
782             $userid = $this->get_mappingid('user', $data->userid);
783             $data->userid = $userid ? $userid : $this->task->get_userid();
784             // Remap the course if course scale
785             $data->courseid = $data->courseid ? $this->get_courseid() : 0;
786             // If global scale (course=0), check the user has perms to create it
787             // falling to course scale if not
788             $systemctx = get_context_instance(CONTEXT_SYSTEM);
789             if ($data->courseid == 0 && !has_capability('moodle/course:managescales', $systemctx , $this->task->get_userid())) {
790                 $data->courseid = $this->get_courseid();
791             }
792             // scale doesn't exist, create
793             $newitemid = $DB->insert_record('scale', $data);
794             $restorefiles = true; // We'll restore the files
795         } else {
796             // scale exists, use it
797             $newitemid = $scadb->id;
798         }
799         // Save the id mapping (with files support at system context)
800         $this->set_mapping('scale', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
801     }
803     protected function after_execute() {
804         // Add scales related files, matching with "scale" mappings
805         $this->add_related_files('grade', 'scale', 'scale', $this->task->get_old_system_contextid());
806     }
810 /**
811  * Structure step that will create all the needed outocomes
812  * by loading them from the outcomes.xml
813  */
814 class restore_outcomes_structure_step extends restore_structure_step {
816     protected function define_structure() {
818         $paths = array(); // Add paths here
819         $paths[] = new restore_path_element('outcome', '/outcomes_definition/outcome');
820         return $paths;
821     }
823     protected function process_outcome($data) {
824         global $DB;
826         $data = (object)$data;
828         $restorefiles = false; // Only if we end creating the group
830         $oldid = $data->id;    // need this saved for later
832         // Look for outcome (by shortname both in standard (courseid=null) and current course
833         // with priority to standard outcomes (ORDER clause)
834         // outcome is not course unique, use get_record_sql to suppress warning
835         $params = array('courseid' => $this->get_courseid(), 'shortname' => $data->shortname);
836         if (!$outdb = $DB->get_record_sql('SELECT *
837                                              FROM {grade_outcomes}
838                                             WHERE shortname = :shortname
839                                               AND (courseid = :courseid OR courseid IS NULL)
840                                          ORDER BY COALESCE(courseid, 0)', $params, IGNORE_MULTIPLE)) {
841             // Remap the user
842             $userid = $this->get_mappingid('user', $data->usermodified);
843             $data->usermodified = $userid ? $userid : $this->task->get_userid();
844             // Remap the scale
845             $data->scaleid = $this->get_mappingid('scale', $data->scaleid);
846             // Remap the course if course outcome
847             $data->courseid = $data->courseid ? $this->get_courseid() : null;
848             // If global outcome (course=null), check the user has perms to create it
849             // falling to course outcome if not
850             $systemctx = get_context_instance(CONTEXT_SYSTEM);
851             if (is_null($data->courseid) && !has_capability('moodle/grade:manageoutcomes', $systemctx , $this->task->get_userid())) {
852                 $data->courseid = $this->get_courseid();
853             }
854             // outcome doesn't exist, create
855             $newitemid = $DB->insert_record('grade_outcomes', $data);
856             $restorefiles = true; // We'll restore the files
857         } else {
858             // scale exists, use it
859             $newitemid = $outdb->id;
860         }
861         // Set the corresponding grade_outcomes_courses record
862         $outcourserec = new stdclass();
863         $outcourserec->courseid  = $this->get_courseid();
864         $outcourserec->outcomeid = $newitemid;
865         if (!$DB->record_exists('grade_outcomes_courses', (array)$outcourserec)) {
866             $DB->insert_record('grade_outcomes_courses', $outcourserec);
867         }
868         // Save the id mapping (with files support at system context)
869         $this->set_mapping('outcome', $oldid, $newitemid, $restorefiles, $this->task->get_old_system_contextid());
870     }
872     protected function after_execute() {
873         // Add outcomes related files, matching with "outcome" mappings
874         $this->add_related_files('grade', 'outcome', 'outcome', $this->task->get_old_system_contextid());
875     }
878 /**
879  * Execution step that, *conditionally* (if there isn't preloaded information
880  * will load all the question categories and questions (header info only)
881  * to backup_temp_ids. They will be stored with "question_category" and
882  * "question" itemnames and with their original contextid and question category
883  * id as paremitemids
884  */
885 class restore_load_categories_and_questions extends restore_execution_step {
887     protected function define_execution() {
889         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
890             return;
891         }
892         $file = $this->get_basepath() . '/questions.xml';
893         restore_dbops::load_categories_and_questions_to_tempids($this->get_restoreid(), $file);
894     }
897 /**
898  * Execution step that, *conditionally* (if there isn't preloaded information)
899  * will process all the needed categories and questions
900  * in order to decide and perform any action with them (create / map / error)
901  * Note: Any error will cause exception, as far as this is the same processing
902  * than the one into restore prechecks (that should have stopped process earlier)
903  */
904 class restore_process_categories_and_questions extends restore_execution_step {
906     protected function define_execution() {
908         if ($this->task->get_preloaded_information()) { // if info is already preloaded, nothing to do
909             return;
910         }
911         restore_dbops::process_categories_and_questions($this->get_restoreid(), $this->task->get_courseid(), $this->task->get_userid(), $this->task->is_samesite());
912     }
915 /**
916  * Structure step that will read the section.xml creating/updating sections
917  * as needed, rebuilding course cache and other friends
918  */
919 class restore_section_structure_step extends restore_structure_step {
921     protected function define_structure() {
922         $section = new restore_path_element('section', '/section');
924         // Apply for 'format' plugins optional paths at section level
925         $this->add_plugin_structure('format', $section);
927         return array($section);
928     }
930     public function process_section($data) {
931         global $DB;
932         $data = (object)$data;
933         $oldid = $data->id; // We'll need this later
935         $restorefiles = false;
937         // Look for the section
938         $section = new stdclass();
939         $section->course  = $this->get_courseid();
940         $section->section = $data->number;
941         // Section doesn't exist, create it with all the info from backup
942         if (!$secrec = $DB->get_record('course_sections', (array)$section)) {
943             $section->name = $data->name;
944             $section->summary = $data->summary;
945             $section->summaryformat = $data->summaryformat;
946             $section->sequence = '';
947             $section->visible = $data->visible;
948             $newitemid = $DB->insert_record('course_sections', $section);
949             $restorefiles = true;
951         // Section exists, update non-empty information
952         } else {
953             $section->id = $secrec->id;
954             if (empty($secrec->name)) {
955                 $section->name = $data->name;
956             }
957             if (empty($secrec->summary)) {
958                 $section->summary = $data->summary;
959                 $section->summaryformat = $data->summaryformat;
960                 $restorefiles = true;
961             }
962             $DB->update_record('course_sections', $section);
963             $newitemid = $secrec->id;
964         }
966         // Annotate the section mapping, with restorefiles option if needed
967         $this->set_mapping('course_section', $oldid, $newitemid, $restorefiles);
969         // set the new course_section id in the task
970         $this->task->set_sectionid($newitemid);
973         // Commented out. We never modify course->numsections as far as that is used
974         // by a lot of people to "hide" sections on purpose (so this remains as used to be in Moodle 1.x)
975         // Note: We keep the code here, to know about and because of the possibility of making this
976         // optional based on some setting/attribute in the future
977         // If needed, adjust course->numsections
978         //if ($numsections = $DB->get_field('course', 'numsections', array('id' => $this->get_courseid()))) {
979         //    if ($numsections < $section->section) {
980         //        $DB->set_field('course', 'numsections', $section->section, array('id' => $this->get_courseid()));
981         //    }
982         //}
983     }
985     protected function after_execute() {
986         // Add section related files, with 'course_section' itemid to match
987         $this->add_related_files('course', 'section', 'course_section');
988     }
992 /**
993  * Structure step that will read the course.xml file, loading it and performing
994  * various actions depending of the site/restore settings. Note that target
995  * course always exist before arriving here so this step will be updating
996  * the course record (never inserting)
997  */
998 class restore_course_structure_step extends restore_structure_step {
1000     protected function define_structure() {
1002         $course = new restore_path_element('course', '/course');
1003         $category = new restore_path_element('category', '/course/category');
1004         $tag = new restore_path_element('tag', '/course/tags/tag');
1005         $allowed_module = new restore_path_element('allowed_module', '/course/allowed_modules/module');
1007         // Apply for 'format' plugins optional paths at course level
1008         $this->add_plugin_structure('format', $course);
1010         // Apply for 'theme' plugins optional paths at course level
1011         $this->add_plugin_structure('theme', $course);
1013         return array($course, $category, $tag, $allowed_module);
1014     }
1016     /**
1017      * Processing functions go here
1018      *
1019      * @global moodledatabase $DB
1020      * @param stdClass $data
1021      */
1022     public function process_course($data) {
1023         global $CFG, $DB;
1025         $data = (object)$data;
1026         $oldid = $data->id; // We'll need this later
1028         $fullname  = $this->get_setting_value('course_fullname');
1029         $shortname = $this->get_setting_value('course_shortname');
1030         $startdate = $this->get_setting_value('course_startdate');
1032         // Calculate final course names, to avoid dupes
1033         list($fullname, $shortname) = restore_dbops::calculate_course_names($this->get_courseid(), $fullname, $shortname);
1035         // Need to change some fields before updating the course record
1036         $data->id = $this->get_courseid();
1037         $data->fullname = $fullname;
1038         $data->shortname= $shortname;
1039         $data->idnumber = '';
1041         // Only restrict modules if original course was and target site too for new courses
1042         $data->restrictmodules = $data->restrictmodules && !empty($CFG->restrictmodulesfor) && $CFG->restrictmodulesfor == 'all';
1044         $data->startdate= $this->apply_date_offset($data->startdate);
1045         if ($data->defaultgroupingid) {
1046             $data->defaultgroupingid = $this->get_mappingid('grouping', $data->defaultgroupingid);
1047         }
1048         if (empty($CFG->enablecompletion)) {
1049             $data->enablecompletion = 0;
1050             $data->completionstartonenrol = 0;
1051             $data->completionnotify = 0;
1052         }
1053         $languages = get_string_manager()->get_list_of_translations(); // Get languages for quick search
1054         if (!array_key_exists($data->lang, $languages)) {
1055             $data->lang = '';
1056         }
1058         $themes = get_list_of_themes(); // Get themes for quick search later
1059         if (!array_key_exists($data->theme, $themes) || empty($CFG->allowcoursethemes)) {
1060             $data->theme = '';
1061         }
1063         // Course record ready, update it
1064         $DB->update_record('course', $data);
1066         // Role name aliases
1067         restore_dbops::set_course_role_names($this->get_restoreid(), $this->get_courseid());
1068     }
1070     public function process_category($data) {
1071         // Nothing to do with the category. UI sets it before restore starts
1072     }
1074     public function process_tag($data) {
1075         global $CFG, $DB;
1077         $data = (object)$data;
1079         if (!empty($CFG->usetags)) { // if enabled in server
1080             // TODO: This is highly inneficient. Each time we add one tag
1081             // we fetch all the existing because tag_set() deletes them
1082             // so everything must be reinserted on each call
1083             $tags = array();
1084             $existingtags = tag_get_tags('course', $this->get_courseid());
1085             // Re-add all the existitng tags
1086             foreach ($existingtags as $existingtag) {
1087                 $tags[] = $existingtag->rawname;
1088             }
1089             // Add the one being restored
1090             $tags[] = $data->rawname;
1091             // Send all the tags back to the course
1092             tag_set('course', $this->get_courseid(), $tags);
1093         }
1094     }
1096     public function process_allowed_module($data) {
1097         global $CFG, $DB;
1099         $data = (object)$data;
1101         // only if enabled by admin setting
1102         if (!empty($CFG->restrictmodulesfor) && $CFG->restrictmodulesfor == 'all') {
1103             $available = get_plugin_list('mod');
1104             $mname = $data->modulename;
1105             if (array_key_exists($mname, $available)) {
1106                 if ($module = $DB->get_record('modules', array('name' => $mname, 'visible' => 1))) {
1107                     $rec = new stdclass();
1108                     $rec->course = $this->get_courseid();
1109                     $rec->module = $module->id;
1110                     if (!$DB->record_exists('course_allowed_modules', (array)$rec)) {
1111                         $DB->insert_record('course_allowed_modules', $rec);
1112                     }
1113                 }
1114             }
1115         }
1116     }
1118     protected function after_execute() {
1119         // Add course related files, without itemid to match
1120         $this->add_related_files('course', 'summary', null);
1121         $this->add_related_files('course', 'legacy', null);
1122     }
1126 /*
1127  * Structure step that will read the roles.xml file (at course/activity/block levels)
1128  * containig all the role_assignments and overrides for that context. If corresponding to
1129  * one mapped role, they will be applied to target context. Will observe the role_assignments
1130  * setting to decide if ras are restored.
1131  * Note: only ras with component == null are restored as far as the any ra with component
1132  * is handled by one enrolment plugin, hence it will createt the ras later
1133  */
1134 class restore_ras_and_caps_structure_step extends restore_structure_step {
1136     protected function define_structure() {
1138         $paths = array();
1140         // Observe the role_assignments setting
1141         if ($this->get_setting_value('role_assignments')) {
1142             $paths[] = new restore_path_element('assignment', '/roles/role_assignments/assignment');
1143         }
1144         $paths[] = new restore_path_element('override', '/roles/role_overrides/override');
1146         return $paths;
1147     }
1149     /**
1150      * Assign roles
1151      *
1152      * This has to be called after enrolments processing.
1153      *
1154      * @param mixed $data
1155      * @return void
1156      */
1157     public function process_assignment($data) {
1158         global $DB;
1160         $data = (object)$data;
1162         // Check roleid, userid are one of the mapped ones
1163         if (!$newroleid = $this->get_mappingid('role', $data->roleid)) {
1164             return;
1165         }
1166         if (!$newuserid = $this->get_mappingid('user', $data->userid)) {
1167             return;
1168         }
1169         if (!$DB->record_exists('user', array('id' => $newuserid, 'deleted' => 0))) {
1170             // Only assign roles to not deleted users
1171             return;
1172         }
1173         if (!$contextid = $this->task->get_contextid()) {
1174             return;
1175         }
1177         if (empty($data->component)) {
1178             // assign standard manual roles
1179             // TODO: role_assign() needs one userid param to be able to specify our restore userid
1180             role_assign($newroleid, $newuserid, $contextid);
1182         } else if ((strpos($data->component, 'enrol_') === 0)) {
1183             // Deal with enrolment roles
1184             if ($enrolid = $this->get_mappingid('enrol', $data->itemid)) {
1185                 if ($component = $DB->get_field('enrol', 'component', array('id'=>$enrolid))) {
1186                     //note: we have to verify component because it might have changed
1187                     if ($component === 'enrol_manual') {
1188                         // manual is a special case, we do not use components - this owudl happen when converting from other plugin
1189                         role_assign($newroleid, $newuserid, $contextid); //TODO: do we need modifierid?
1190                     } else {
1191                         role_assign($newroleid, $newuserid, $contextid, $component, $enrolid); //TODO: do we need modifierid?
1192                     }
1193                 }
1194             }
1195         }
1196     }
1198     public function process_override($data) {
1199         $data = (object)$data;
1201         // Check roleid is one of the mapped ones
1202         $newroleid = $this->get_mappingid('role', $data->roleid);
1203         // If newroleid and context are valid assign it via API (it handles dupes and so on)
1204         if ($newroleid && $this->task->get_contextid()) {
1205             // TODO: assign_capability() needs one userid param to be able to specify our restore userid
1206             // TODO: it seems that assign_capability() doesn't check for valid capabilities at all ???
1207             assign_capability($data->capability, $data->permission, $newroleid, $this->task->get_contextid());
1208         }
1209     }
1212 /**
1213  * This structure steps restores the enrol plugins and their underlying
1214  * enrolments, performing all the mappings and/or movements required
1215  */
1216 class restore_enrolments_structure_step extends restore_structure_step {
1218     protected function define_structure() {
1220         $paths = array();
1222         $paths[] = new restore_path_element('enrol', '/enrolments/enrols/enrol');
1223         $paths[] = new restore_path_element('enrolment', '/enrolments/enrols/enrol/user_enrolments/enrolment');
1225         return $paths;
1226     }
1228     /**
1229      * Create enrolment instances.
1230      *
1231      * This has to be called after creation of roles
1232      * and before adding of role assignments.
1233      *
1234      * @param mixed $data
1235      * @return void
1236      */
1237     public function process_enrol($data) {
1238         global $DB;
1240         $data = (object)$data;
1241         $oldid = $data->id; // We'll need this later
1243         $restoretype = plugin_supports('enrol', $data->enrol, ENROL_RESTORE_TYPE, null);
1245         if ($restoretype !== ENROL_RESTORE_EXACT and $restoretype !== ENROL_RESTORE_NOUSERS) {
1246             // TODO: add complex restore support via custom class
1247             debugging("Skipping '{$data->enrol}' enrolment plugin. Will be implemented before 2.0 release", DEBUG_DEVELOPER);
1248             $this->set_mapping('enrol', $oldid, 0);
1249             return;
1250         }
1252         // Perform various checks to decide what to do with the enrol plugin
1253         if (!array_key_exists($data->enrol, enrol_get_plugins(false))) {
1254             // TODO: decide if we want to switch to manual enrol - we need UI for this
1255             debugging("Enrol plugin data can not be restored because it is not installed");
1256             $this->set_mapping('enrol', $oldid, 0);
1257             return;
1259         }
1260         if (!enrol_is_enabled($data->enrol)) {
1261             // TODO: decide if we want to switch to manual enrol - we need UI for this
1262             debugging("Enrol plugin data can not be restored because it is not enabled");
1263             $this->set_mapping('enrol', $oldid, 0);
1264             return;
1265         }
1267         // map standard fields - plugin has to process custom fields from own restore class
1268         $data->roleid = $this->get_mappingid('role', $data->roleid);
1269         //TODO: should we move the enrol start and end date here?
1271         // always add instance, if the course does not support multiple instances it just returns NULL
1272         $enrol = enrol_get_plugin($data->enrol);
1273         $courserec = $DB->get_record('course', array('id' => $this->get_courseid())); // Requires object, uses only id!!
1274         if ($newitemid = $enrol->add_instance($courserec, (array)$data)) {
1275             // ok
1276         } else {
1277             if ($instances = $DB->get_records('enrol', array('courseid'=>$courserec->id, 'enrol'=>$data->enrol))) {
1278                 // most probably plugin that supports only one instance
1279                 $newitemid = key($instances);
1280             } else {
1281                 debugging('Can not create new enrol instance or reuse existing');
1282                 $newitemid = 0;
1283             }
1284         }
1286         if ($restoretype === ENROL_RESTORE_NOUSERS) {
1287             // plugin requests to prevent restore of any users
1288             $newitemid = 0;
1289         }
1291         $this->set_mapping('enrol', $oldid, $newitemid);
1292     }
1294     /**
1295      * Create user enrolments
1296      *
1297      * This has to be called after creation of enrolment instances
1298      * and before adding of role assignments.
1299      *
1300      * @param mixed $data
1301      * @return void
1302      */
1303     public function process_enrolment($data) {
1304         global $DB;
1306         $data = (object)$data;
1308         // Process only if parent instance have been mapped
1309         if ($enrolid = $this->get_new_parentid('enrol')) {
1310             if ($instance = $DB->get_record('enrol', array('id'=>$enrolid))) {
1311                 // And only if user is a mapped one
1312                 if ($userid = $this->get_mappingid('user', $data->userid)) {
1313                     $enrol = enrol_get_plugin($instance->enrol);
1314                     //TODO: do we need specify modifierid?
1315                     $enrol->enrol_user($instance, $userid, null, $data->timestart, $data->timeend, $data->status);
1316                     //note: roles are assigned in restore_ras_and_caps_structure_step::process_assignment() processing above
1317                 }
1318             }
1319         }
1320     }
1324 /**
1325  * This structure steps restores the filters and their configs
1326  */
1327 class restore_filters_structure_step extends restore_structure_step {
1329     protected function define_structure() {
1331         $paths = array();
1333         $paths[] = new restore_path_element('active', '/filters/filter_actives/filter_active');
1334         $paths[] = new restore_path_element('config', '/filters/filter_configs/filter_config');
1336         return $paths;
1337     }
1339     public function process_active($data) {
1341         $data = (object)$data;
1343         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1344             return;
1345         }
1346         filter_set_local_state($data->filter, $this->task->get_contextid(), $data->active);
1347     }
1349     public function process_config($data) {
1351         $data = (object)$data;
1353         if (!filter_is_enabled($data->filter)) { // Not installed or not enabled, nothing to do
1354             return;
1355         }
1356         filter_set_local_config($data->filter, $this->task->get_contextid(), $data->name, $data->value);
1357     }
1361 /**
1362  * This structure steps restores the comments
1363  * Note: Cannot use the comments API because defaults to USER->id.
1364  * That should change allowing to pass $userid
1365  */
1366 class restore_comments_structure_step extends restore_structure_step {
1368     protected function define_structure() {
1370         $paths = array();
1372         $paths[] = new restore_path_element('comment', '/comments/comment');
1374         return $paths;
1375     }
1377     public function process_comment($data) {
1378         global $DB;
1380         $data = (object)$data;
1382         // First of all, if the comment has some itemid, ask to the task what to map
1383         $mapping = false;
1384         if ($data->itemid) {
1385             $mapping = $this->task->get_comment_mapping_itemname($data->commentarea);
1386             $data->itemid = $this->get_mappingid($mapping, $data->itemid);
1387         }
1388         // Only restore the comment if has no mapping OR we have found the matching mapping
1389         if (!$mapping || $data->itemid) {
1390             // Only if user mapping and context
1391             $data->userid = $this->get_mappingid('user', $data->userid);
1392             if ($data->userid && $this->task->get_contextid()) {
1393                 $data->contextid = $this->task->get_contextid();
1394                 // Only if there is another comment with same context/user/timecreated
1395                 $params = array('contextid' => $data->contextid, 'userid' => $data->userid, 'timecreated' => $data->timecreated);
1396                 if (!$DB->record_exists('comments', $params)) {
1397                     $DB->insert_record('comments', $data);
1398                 }
1399             }
1400         }
1401     }
1404 class restore_course_completion_structure_step extends restore_structure_step {
1406     /**
1407      * Conditionally decide if this step should be executed.
1408      *
1409      * This function checks parameters that are not immediate settings to ensure
1410      * that the enviroment is suitable for the restore of course completion info.
1411      *
1412      * This function checks the following four parameters:
1413      *
1414      *   1. Course completion is enabled on the site
1415      *   2. The backup includes course completion information
1416      *   3. All modules are restorable
1417      *   4. All modules are marked for restore.
1418      *
1419      * @return bool True is safe to execute, false otherwise
1420      */
1421     protected function execute_condition() {
1422         global $CFG;
1424         // First check course completion is enabled on this site
1425         if (empty($CFG->enablecompletion)) {
1426             // Disabled, don't restore course completion
1427             return false;
1428         }
1430         // Check it is included in the backup
1431         $fullpath = $this->task->get_taskbasepath();
1432         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1433         if (!file_exists($fullpath)) {
1434             // Not found, can't restore course completion
1435             return false;
1436         }
1438         // Check we are able to restore all backed up modules
1439         if ($this->task->is_missing_modules()) {
1440             return false;
1441         }
1443         // Finally check all modules within the backup are being restored.
1444         if ($this->task->is_excluding_activities()) {
1445             return false;
1446         }
1448         return true;
1449     }
1451     /**
1452      * Define the course completion structure
1453      *
1454      * @return array Array of restore_path_element
1455      */
1456     protected function define_structure() {
1458         // To know if we are including user completion info
1459         $userinfo = $this->get_setting_value('userscompletion');
1461         $paths = array();
1462         $paths[] = new restore_path_element('course_completion_criteria', '/course_completion/course_completion_criteria');
1463         $paths[] = new restore_path_element('course_completion_notify', '/course_completion/course_completion_notify');
1464         $paths[] = new restore_path_element('course_completion_aggr_methd', '/course_completion/course_completion_aggr_methd');
1466         if ($userinfo) {
1467             $paths[] = new restore_path_element('course_completion_crit_compl', '/course_completion/course_completion_criteria/course_completion_crit_completions/course_completion_crit_compl');
1468             $paths[] = new restore_path_element('course_completions', '/course_completion/course_completions');
1469         }
1471         return $paths;
1473     }
1475     /**
1476      * Process course completion criteria
1477      *
1478      * @global moodle_database $DB
1479      * @param stdClass $data
1480      */
1481     public function process_course_completion_criteria($data) {
1482         global $DB;
1484         $data = (object)$data;
1485         $data->course = $this->get_courseid();
1487         // Apply the date offset to the time end field
1488         $data->timeend = $this->apply_date_offset($data->timeend);
1490         // Map the role from the criteria
1491         if (!empty($data->role)) {
1492             $data->role = $this->get_mappingid('role', $data->role);
1493         }
1495         $skipcriteria = false;
1497         // If the completion criteria is for a module we need to map the module instance
1498         // to the new module id.
1499         if (!empty($data->moduleinstance) && !empty($data->module)) {
1500             $data->moduleinstance = $this->get_mappingid('course_module', $data->moduleinstance);
1501             if (empty($data->moduleinstance)) {
1502                 $skipcriteria = true;
1503             }
1504         } else {
1505             $data->module = null;
1506             $data->moduleinstance = null;
1507         }
1509         // We backup the course shortname rather than the ID so that we can match back to the course
1510         if (!empty($data->courseinstanceshortname)) {
1511             $courseinstanceid = $DB->get_field('course', 'id', array('shortname'=>$data->courseinstanceshortname));
1512             if (!$courseinstanceid) {
1513                 $skipcriteria = true;
1514             }
1515         } else {
1516             $courseinstanceid = null;
1517         }
1518         $data->courseinstance = $courseinstanceid;
1520         if (!$skipcriteria) {
1521             $params = array(
1522                 'course'         => $data->course,
1523                 'criteriatype'   => $data->criteriatype,
1524                 'enrolperiod'    => $data->enrolperiod,
1525                 'courseinstance' => $data->courseinstance,
1526                 'module'         => $data->module,
1527                 'moduleinstance' => $data->moduleinstance,
1528                 'timeend'        => $data->timeend,
1529                 'gradepass'      => $data->gradepass,
1530                 'role'           => $data->role
1531             );
1532             $newid = $DB->insert_record('course_completion_criteria', $params);
1533             $this->set_mapping('course_completion_criteria', $data->id, $newid);
1534         }
1535     }
1537     /**
1538      * Processes course compltion criteria complete records
1539      *
1540      * @global moodle_database $DB
1541      * @param stdClass $data
1542      */
1543     public function process_course_completion_crit_compl($data) {
1544         global $DB;
1546         $data = (object)$data;
1548         // This may be empty if criteria could not be restored
1549         $data->criteriaid = $this->get_mappingid('course_completion_criteria', $data->criteriaid);
1551         $data->course = $this->get_courseid();
1552         $data->userid = $this->get_mappingid('user', $data->userid);
1554         if (!empty($data->criteriaid) && !empty($data->userid)) {
1555             $params = array(
1556                 'userid' => $data->userid,
1557                 'course' => $data->course,
1558                 'criteriaid' => $data->criteriaid,
1559                 'timecompleted' => $this->apply_date_offset($data->timecompleted)
1560             );
1561             if (isset($data->gradefinal)) {
1562                 $params['gradefinal'] = $data->gradefinal;
1563             }
1564             if (isset($data->unenroled)) {
1565                 $params['unenroled'] = $data->unenroled;
1566             }
1567             if (isset($data->deleted)) {
1568                 $params['deleted'] = $data->deleted;
1569             }
1570             $DB->insert_record('course_completion_crit_compl', $params);
1571         }
1572     }
1574     /**
1575      * Process course completions
1576      *
1577      * @global moodle_database $DB
1578      * @param stdClass $data
1579      */
1580     public function process_course_completions($data) {
1581         global $DB;
1583         $data = (object)$data;
1585         $data->course = $this->get_courseid();
1586         $data->userid = $this->get_mappingid('user', $data->userid);
1588         if (!empty($data->userid)) {
1589             $params = array(
1590                 'userid' => $data->userid,
1591                 'course' => $data->course,
1592                 'deleted' => $data->deleted,
1593                 'timenotified' => $this->apply_date_offset($data->timenotified),
1594                 'timeenrolled' => $this->apply_date_offset($data->timeenrolled),
1595                 'timestarted' => $this->apply_date_offset($data->timestarted),
1596                 'timecompleted' => $this->apply_date_offset($data->timecompleted),
1597                 'reaggregate' => $data->reaggregate
1598             );
1599             $DB->insert_record('course_completions', $params);
1600         }
1601     }
1603     /**
1604      * Process course completion notification records.
1605      *
1606      * Note: As of Moodle 2.0 this table is not being used however it has been
1607      * left in in the hopes that one day the functionality there will be completed
1608      *
1609      * @global moodle_database $DB
1610      * @param stdClass $data
1611      */
1612     public function process_course_completion_notify($data) {
1613         global $DB;
1615         $data = (object)$data;
1617         $data->course = $this->get_courseid();
1618         if (!empty($data->role)) {
1619             $data->role = $this->get_mappingid('role', $data->role);
1620         }
1622         $params = array(
1623             'course' => $data->course,
1624             'role' => $data->role,
1625             'message' => $data->message,
1626             'timesent' => $this->apply_date_offset($data->timesent),
1627         );
1628         $DB->insert_record('course_completion_notify', $params);
1629     }
1631     /**
1632      * Process course completion aggregate methods
1633      *
1634      * @global moodle_database $DB
1635      * @param stdClass $data
1636      */
1637     public function process_course_completion_aggr_methd($data) {
1638         global $DB;
1640         $data = (object)$data;
1642         $data->course = $this->get_courseid();
1644         $params = array(
1645             'course' => $data->course,
1646             'criteriatype' => $data->criteriatype,
1647             'method' => $data->method,
1648             'value' => $data->value,
1649         );
1650         $DB->insert_record('course_completion_aggr_methd', $params);
1651     }
1656 /**
1657  * This structure step restores course logs (cmid = 0), delegating
1658  * the hard work to the corresponding {@link restore_logs_processor} passing the
1659  * collection of {@link restore_log_rule} rules to be observed as they are defined
1660  * by the task. Note this is only executed based in the 'logs' setting.
1661  *
1662  * NOTE: This is executed by final task, to have all the activities already restored
1663  *
1664  * NOTE: Not all course logs are being restored. For now only 'course' and 'user'
1665  * records are. There are others like 'calendar' and 'upload' that will be handled
1666  * later.
1667  *
1668  * NOTE: All the missing actions (not able to be restored) are sent to logs for
1669  * debugging purposes
1670  */
1671 class restore_course_logs_structure_step extends restore_structure_step {
1673     /**
1674      * Conditionally decide if this step should be executed.
1675      *
1676      * This function checks the following four parameters:
1677      *
1678      *   1. the course/logs.xml file exists
1679      *
1680      * @return bool true is safe to execute, false otherwise
1681      */
1682     protected function execute_condition() {
1684         // Check it is included in the backup
1685         $fullpath = $this->task->get_taskbasepath();
1686         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
1687         if (!file_exists($fullpath)) {
1688             // Not found, can't restore course logs
1689             return false;
1690         }
1692         return true;
1693     }
1695     protected function define_structure() {
1697         $paths = array();
1699         // Simple, one plain level of information contains them
1700         $paths[] = new restore_path_element('log', '/logs/log');
1702         return $paths;
1703     }
1705     protected function process_log($data) {
1706         global $DB;
1708         $data = (object)($data);
1710         $data->time = $this->apply_date_offset($data->time);
1711         $data->userid = $this->get_mappingid('user', $data->userid);
1712         $data->course = $this->get_courseid();
1713         $data->cmid = 0;
1715         // For any reason user wasn't remapped ok, stop processing this
1716         if (empty($data->userid)) {
1717             return;
1718         }
1720         // Everything ready, let's delegate to the restore_logs_processor
1722         // Set some fixed values that will save tons of DB requests
1723         $values = array(
1724             'course' => $this->get_courseid());
1725         // Get instance and process log record
1726         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
1728         // If we have data, insert it, else something went wrong in the restore_logs_processor
1729         if ($data) {
1730             $DB->insert_record('log', $data);
1731         }
1732     }
1735 /**
1736  * This structure step restores activity logs, extending {@link restore_course_logs_structure_step}
1737  * sharing its same structure but modifying the way records are handled
1738  */
1739 class restore_activity_logs_structure_step extends restore_course_logs_structure_step {
1741     protected function process_log($data) {
1742         global $DB;
1744         $data = (object)($data);
1746         $data->time = $this->apply_date_offset($data->time);
1747         $data->userid = $this->get_mappingid('user', $data->userid);
1748         $data->course = $this->get_courseid();
1749         $data->cmid = $this->task->get_moduleid();
1751         // For any reason user wasn't remapped ok, stop processing this
1752         if (empty($data->userid)) {
1753             return;
1754         }
1756         // Everything ready, let's delegate to the restore_logs_processor
1758         // Set some fixed values that will save tons of DB requests
1759         $values = array(
1760             'course' => $this->get_courseid(),
1761             'course_module' => $this->task->get_moduleid(),
1762             $this->task->get_modulename() => $this->task->get_activityid());
1763         // Get instance and process log record
1764         $data = restore_logs_processor::get_instance($this->task, $values)->process_log_record($data);
1766         // If we have data, insert it, else something went wrong in the restore_logs_processor
1767         if ($data) {
1768             $DB->insert_record('log', $data);
1769         }
1770     }
1773 /**
1774  * This structure step restores the grade items associated with one activity
1775  * All the grade items are made child of the "course" grade item but the original
1776  * categoryid is saved as parentitemid in the backup_ids table, so, when restoring
1777  * the complete gradebook (categories and calculations), that information is
1778  * available there
1779  */
1780 class restore_activity_grades_structure_step extends restore_structure_step {
1782     protected function define_structure() {
1784         $paths = array();
1785         $userinfo = $this->get_setting_value('userinfo');
1787         $paths[] = new restore_path_element('grade_item', '/activity_gradebook/grade_items/grade_item');
1788         $paths[] = new restore_path_element('grade_letter', '/activity_gradebook/grade_letters/grade_letter');
1789         if ($userinfo) {
1790             $paths[] = new restore_path_element('grade_grade',
1791                            '/activity_gradebook/grade_items/grade_item/grade_grades/grade_grade');
1792         }
1793         return $paths;
1794     }
1796     protected function process_grade_item($data) {
1798         $data = (object)($data);
1799         $oldid       = $data->id;        // We'll need these later
1800         $oldparentid = $data->categoryid;
1802         // make sure top course category exists, all grade items will be associated
1803         // to it. Later, if restoring the whole gradebook, categories will be introduced
1804         $coursecat = grade_category::fetch_course_category($this->get_courseid());
1805         $coursecatid = $coursecat->id; // Get the categoryid to be used
1807         unset($data->id);
1808         $data->categoryid   = $coursecatid;
1809         $data->courseid     = $this->get_courseid();
1810         $data->iteminstance = $this->task->get_activityid();
1811         // Don't get any idnumber from course module. Keep them as they are in grade_item->idnumber
1812         // Reason: it's not clear what happens with outcomes->idnumber or activities with multiple items (workshop)
1813         // so the best is to keep the ones already in the gradebook
1814         // Potential problem: duplicates if same items are restored more than once. :-(
1815         // This needs to be fixed in some way (outcomes & activities with multiple items)
1816         // $data->idnumber     = get_coursemodule_from_instance($data->itemmodule, $data->iteminstance)->idnumber;
1817         // In any case, verify always for uniqueness
1818         $data->idnumber = grade_verify_idnumber($data->idnumber, $this->get_courseid()) ? $data->idnumber : null;
1819         $data->scaleid      = $this->get_mappingid('scale', $data->scaleid);
1820         $data->outcomeid    = $this->get_mappingid('outcome', $data->outcomeid);
1821         $data->timecreated  = $this->apply_date_offset($data->timecreated);
1822         $data->timemodified = $this->apply_date_offset($data->timemodified);
1824         $gradeitem = new grade_item($data, false);
1825         $gradeitem->insert('restore');
1827         //sortorder is automatically assigned when inserting. Re-instate the previous sortorder
1828         $gradeitem->sortorder = $data->sortorder;
1829         $gradeitem->update('restore');
1831         // Set mapping, saving the original category id into parentitemid
1832         // gradebook restore (final task) will need it to reorganise items
1833         $this->set_mapping('grade_item', $oldid, $gradeitem->id, false, null, $oldparentid);
1834     }
1836     protected function process_grade_grade($data) {
1837         $data = (object)($data);
1839         unset($data->id);
1840         $data->itemid = $this->get_new_parentid('grade_item');
1841         $data->userid = $this->get_mappingid('user', $data->userid);
1842         $data->usermodified = $this->get_mappingid('user', $data->usermodified);
1843         $data->rawscaleid = $this->get_mappingid('scale', $data->rawscaleid);
1844         // TODO: Ask, all the rest of locktime/exported... work with time... to be rolled?
1845         $data->overridden = $this->apply_date_offset($data->overridden);
1847         $grade = new grade_grade($data, false);
1848         $grade->insert('restore');
1849         // no need to save any grade_grade mapping
1850     }
1852     /**
1853      * process activity grade_letters. Note that, while these are possible,
1854      * because grade_letters are contextid based, in proctice, only course
1855      * context letters can be defined. So we keep here this method knowing
1856      * it won't be executed ever. gradebook restore will restore course letters.
1857      */
1858     protected function process_grade_letter($data) {
1859         global $DB;
1861         $data = (object)$data;
1863         $data->contextid = $this->task->get_contextid();
1864         $newitemid = $DB->insert_record('grade_letters', $data);
1865         // no need to save any grade_letter mapping
1866     }
1870 /**
1871  * This structure steps restores one instance + positions of one block
1872  * Note: Positions corresponding to one existing context are restored
1873  * here, but all the ones having unknown contexts are sent to backup_ids
1874  * for a later chance to be restored at the end (final task)
1875  */
1876 class restore_block_instance_structure_step extends restore_structure_step {
1878     protected function define_structure() {
1880         $paths = array();
1882         $paths[] = new restore_path_element('block', '/block', true); // Get the whole XML together
1883         $paths[] = new restore_path_element('block_position', '/block/block_positions/block_position');
1885         return $paths;
1886     }
1888     public function process_block($data) {
1889         global $DB, $CFG;
1891         $data = (object)$data; // Handy
1892         $oldcontextid = $data->contextid;
1893         $oldid        = $data->id;
1894         $positions = isset($data->block_positions['block_position']) ? $data->block_positions['block_position'] : array();
1896         // Look for the parent contextid
1897         if (!$data->parentcontextid = $this->get_mappingid('context', $data->parentcontextid)) {
1898             throw new restore_step_exception('restore_block_missing_parent_ctx', $data->parentcontextid);
1899         }
1901         // TODO: it would be nice to use standard plugin supports instead of this instance_allow_multiple()
1902         // If there is already one block of that type in the parent context
1903         // and the block is not multiple, stop processing
1904         // Use blockslib loader / method executor
1905         if (!block_method_result($data->blockname, 'instance_allow_multiple')) {
1906             if ($DB->record_exists_sql("SELECT bi.id
1907                                           FROM {block_instances} bi
1908                                           JOIN {block} b ON b.name = bi.blockname
1909                                          WHERE bi.parentcontextid = ?
1910                                            AND bi.blockname = ?", array($data->parentcontextid, $data->blockname))) {
1911                 return false;
1912             }
1913         }
1915         // If there is already one block of that type in the parent context
1916         // with the same showincontexts, pagetypepattern, subpagepattern, defaultregion and configdata
1917         // stop processing
1918         $params = array(
1919             'blockname' => $data->blockname, 'parentcontextid' => $data->parentcontextid,
1920             'showinsubcontexts' => $data->showinsubcontexts, 'pagetypepattern' => $data->pagetypepattern,
1921             'subpagepattern' => $data->subpagepattern, 'defaultregion' => $data->defaultregion);
1922         if ($birecs = $DB->get_records('block_instances', $params)) {
1923             foreach($birecs as $birec) {
1924                 if ($birec->configdata == $data->configdata) {
1925                     return false;
1926                 }
1927             }
1928         }
1930         // Set task old contextid, blockid and blockname once we know them
1931         $this->task->set_old_contextid($oldcontextid);
1932         $this->task->set_old_blockid($oldid);
1933         $this->task->set_blockname($data->blockname);
1935         // Let's look for anything within configdata neededing processing
1936         // (nulls and uses of legacy file.php)
1937         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
1938             $configdata = (array)unserialize(base64_decode($data->configdata));
1939             foreach ($configdata as $attribute => $value) {
1940                 if (in_array($attribute, $attrstotransform)) {
1941                     $configdata[$attribute] = $this->contentprocessor->process_cdata($value);
1942                 }
1943             }
1944             $data->configdata = base64_encode(serialize((object)$configdata));
1945         }
1947         // Create the block instance
1948         $newitemid = $DB->insert_record('block_instances', $data);
1949         // Save the mapping (with restorefiles support)
1950         $this->set_mapping('block_instance', $oldid, $newitemid, true);
1951         // Create the block context
1952         $newcontextid = get_context_instance(CONTEXT_BLOCK, $newitemid)->id;
1953         // Save the block contexts mapping and sent it to task
1954         $this->set_mapping('context', $oldcontextid, $newcontextid);
1955         $this->task->set_contextid($newcontextid);
1956         $this->task->set_blockid($newitemid);
1958         // Restore block fileareas if declared
1959         $component = 'block_' . $this->task->get_blockname();
1960         foreach ($this->task->get_fileareas() as $filearea) { // Simple match by contextid. No itemname needed
1961             $this->add_related_files($component, $filearea, null);
1962         }
1964         // Process block positions, creating them or accumulating for final step
1965         foreach($positions as $position) {
1966             $position = (object)$position;
1967             $position->blockinstanceid = $newitemid; // The instance is always the restored one
1968             // If position is for one already mapped (known) contextid
1969             // process it now, creating the position
1970             if ($newpositionctxid = $this->get_mappingid('context', $position->contextid)) {
1971                 $position->contextid = $newpositionctxid;
1972                 // Create the block position
1973                 $DB->insert_record('block_positions', $position);
1975             // The position belongs to an unknown context, send it to backup_ids
1976             // to process them as part of the final steps of restore. We send the
1977             // whole $position object there, hence use the low level method.
1978             } else {
1979                 restore_dbops::set_backup_ids_record($this->get_restoreid(), 'block_position', $position->id, 0, null, $position);
1980             }
1981         }
1982     }
1985 /**
1986  * Structure step to restore common course_module information
1987  *
1988  * This step will process the module.xml file for one activity, in order to restore
1989  * the corresponding information to the course_modules table, skipping various bits
1990  * of information based on CFG settings (groupings, completion...) in order to fullfill
1991  * all the reqs to be able to create the context to be used by all the rest of steps
1992  * in the activity restore task
1993  */
1994 class restore_module_structure_step extends restore_structure_step {
1996     protected function define_structure() {
1997         global $CFG;
1999         $paths = array();
2001         $module = new restore_path_element('module', '/module');
2002         $paths[] = $module;
2003         if ($CFG->enableavailability) {
2004             $paths[] = new restore_path_element('availability', '/module/availability_info/availability');
2005         }
2007         // Apply for 'format' plugins optional paths at module level
2008         $this->add_plugin_structure('format', $module);
2010         return $paths;
2011     }
2013     protected function process_module($data) {
2014         global $CFG, $DB;
2016         $data = (object)$data;
2017         $oldid = $data->id;
2019         $data->course = $this->task->get_courseid();
2020         $data->module = $DB->get_field('modules', 'id', array('name' => $data->modulename));
2021         // Map section (first try by course_section mapping match. Useful in course and section restores)
2022         $data->section = $this->get_mappingid('course_section', $data->sectionid);
2023         if (!$data->section) { // mapping failed, try to get section by sectionnumber matching
2024             $params = array(
2025                 'course' => $this->get_courseid(),
2026                 'section' => $data->sectionnumber);
2027             $data->section = $DB->get_field('course_sections', 'id', $params);
2028         }
2029         if (!$data->section) { // sectionnumber failed, try to get first section in course
2030             $params = array(
2031                 'course' => $this->get_courseid());
2032             $data->section = $DB->get_field('course_sections', 'MIN(id)', $params);
2033         }
2034         if (!$data->section) { // no sections in course, create section 0 and 1 and assign module to 1
2035             $sectionrec = array(
2036                 'course' => $this->get_courseid(),
2037                 'section' => 0);
2038             $DB->insert_record('course_sections', $sectionrec); // section 0
2039             $sectionrec = array(
2040                 'course' => $this->get_courseid(),
2041                 'section' => 1);
2042             $data->section = $DB->insert_record('course_sections', $sectionrec); // section 1
2043         }
2044         $data->groupingid= $this->get_mappingid('grouping', $data->groupingid);      // grouping
2045         if (!$CFG->enablegroupmembersonly) {                                         // observe groupsmemberonly
2046             $data->groupmembersonly = 0;
2047         }
2048         if (!grade_verify_idnumber($data->idnumber, $this->get_courseid())) {        // idnumber uniqueness
2049             $data->idnumber = '';
2050         }
2051         if (empty($CFG->enablecompletion)) { // completion
2052             $data->completion = 0;
2053             $data->completiongradeitemnumber = null;
2054             $data->completionview = 0;
2055             $data->completionexpected = 0;
2056         } else {
2057             $data->completionexpected = $this->apply_date_offset($data->completionexpected);
2058         }
2059         if (empty($CFG->enableavailability)) {
2060             $data->availablefrom = 0;
2061             $data->availableuntil = 0;
2062             $data->showavailability = 0;
2063         } else {
2064             $data->availablefrom = $this->apply_date_offset($data->availablefrom);
2065             $data->availableuntil= $this->apply_date_offset($data->availableuntil);
2066         }
2067         $data->instance = 0; // Set to 0 for now, going to create it soon (next step)
2069         // course_module record ready, insert it
2070         $newitemid = $DB->insert_record('course_modules', $data);
2071         // save mapping
2072         $this->set_mapping('course_module', $oldid, $newitemid);
2073         // set the new course_module id in the task
2074         $this->task->set_moduleid($newitemid);
2075         // we can now create the context safely
2076         $ctxid = get_context_instance(CONTEXT_MODULE, $newitemid)->id;
2077         // set the new context id in the task
2078         $this->task->set_contextid($ctxid);
2079         // update sequence field in course_section
2080         if ($sequence = $DB->get_field('course_sections', 'sequence', array('id' => $data->section))) {
2081             $sequence .= ',' . $newitemid;
2082         } else {
2083             $sequence = $newitemid;
2084         }
2085         $DB->set_field('course_sections', 'sequence', $sequence, array('id' => $data->section));
2086     }
2089     protected function process_availability($data) {
2090         $data = (object)$data;
2091         // Simply going to store the whole availability record now, we'll process
2092         // all them later in the final task (once all actvivities have been restored)
2093         // Let's call the low level one to be able to store the whole object
2094         $data->coursemoduleid = $this->task->get_moduleid(); // Let add the availability cmid
2095         restore_dbops::set_backup_ids_record($this->get_restoreid(), 'module_availability', $data->id, 0, null, $data);
2096     }
2099 /**
2100  * Structure step that will process the user activity completion
2101  * information if all these conditions are met:
2102  *  - Target site has completion enabled ($CFG->enablecompletion)
2103  *  - Activity includes completion info (file_exists)
2104  */
2105 class restore_userscompletion_structure_step extends restore_structure_step {
2107     /**
2108      * To conditionally decide if this step must be executed
2109      * Note the "settings" conditions are evaluated in the
2110      * corresponding task. Here we check for other conditions
2111      * not being restore settings (files, site settings...)
2112      */
2113      protected function execute_condition() {
2114          global $CFG;
2116          // Completion disabled in this site, don't execute
2117          if (empty($CFG->enablecompletion)) {
2118              return false;
2119          }
2121          // No user completion info found, don't execute
2122         $fullpath = $this->task->get_taskbasepath();
2123         $fullpath = rtrim($fullpath, '/') . '/' . $this->filename;
2124          if (!file_exists($fullpath)) {
2125              return false;
2126          }
2128          // Arrived here, execute the step
2129          return true;
2130      }
2132      protected function define_structure() {
2134         $paths = array();
2136         $paths[] = new restore_path_element('completion', '/completions/completion');
2138         return $paths;
2139     }
2141     protected function process_completion($data) {
2142         global $DB;
2144         $data = (object)$data;
2146         $data->coursemoduleid = $this->task->get_moduleid();
2147         $data->userid = $this->get_mappingid('user', $data->userid);
2148         $data->timemodified = $this->apply_date_offset($data->timemodified);
2150         $DB->insert_record('course_modules_completion', $data);
2151     }
2154 /**
2155  * Abstract structure step, parent of all the activity structure steps. Used to suuport
2156  * the main <activity ...> tag and process it. Also provides subplugin support for
2157  * activities.
2158  */
2159 abstract class restore_activity_structure_step extends restore_structure_step {
2161     protected function add_subplugin_structure($subplugintype, $element) {
2163         global $CFG;
2165         // Check the requested subplugintype is a valid one
2166         $subpluginsfile = $CFG->dirroot . '/mod/' . $this->task->get_modulename() . '/db/subplugins.php';
2167         if (!file_exists($subpluginsfile)) {
2168              throw new restore_step_exception('activity_missing_subplugins_php_file', $this->task->get_modulename());
2169         }
2170         include($subpluginsfile);
2171         if (!array_key_exists($subplugintype, $subplugins)) {
2172              throw new restore_step_exception('incorrect_subplugin_type', $subplugintype);
2173         }
2174         // Get all the restore path elements, looking across all the subplugin dirs
2175         $subpluginsdirs = get_plugin_list($subplugintype);
2176         foreach ($subpluginsdirs as $name => $subpluginsdir) {
2177             $classname = 'restore_' . $subplugintype . '_' . $name . '_subplugin';
2178             $restorefile = $subpluginsdir . '/backup/moodle2/' . $classname . '.class.php';
2179             if (file_exists($restorefile)) {
2180                 require_once($restorefile);
2181                 $restoresubplugin = new $classname($subplugintype, $name, $this);
2182                 // Add subplugin paths to the step
2183                 $this->prepare_pathelements($restoresubplugin->define_subplugin_structure($element));
2184             }
2185         }
2186     }
2188     /**
2189      * As far as activity restore steps are implementing restore_subplugin stuff, they need to
2190      * have the parent task available for wrapping purposes (get course/context....)
2191      */
2192     public function get_task() {
2193         return $this->task;
2194     }
2196     /**
2197      * Adds support for the 'activity' path that is common to all the activities
2198      * and will be processed globally here
2199      */
2200     protected function prepare_activity_structure($paths) {
2202         $paths[] = new restore_path_element('activity', '/activity');
2204         return $paths;
2205     }
2207     /**
2208      * Process the activity path, informing the task about various ids, needed later
2209      */
2210     protected function process_activity($data) {
2211         $data = (object)$data;
2212         $this->task->set_old_contextid($data->contextid); // Save old contextid in task
2213         $this->set_mapping('context', $data->contextid, $this->task->get_contextid()); // Set the mapping
2214         $this->task->set_old_activityid($data->id); // Save old activityid in task
2215     }
2217     /**
2218      * This must be invoked immediately after creating the "module" activity record (forum, choice...)
2219      * and will adjust the new activity id (the instance) in various places
2220      */
2221     protected function apply_activity_instance($newitemid) {
2222         global $DB;
2224         $this->task->set_activityid($newitemid); // Save activity id in task
2225         // Apply the id to course_sections->instanceid
2226         $DB->set_field('course_modules', 'instance', $newitemid, array('id' => $this->task->get_moduleid()));
2227         // Do the mapping for modulename, preparing it for files by oldcontext
2228         $modulename = $this->task->get_modulename();
2229         $oldid = $this->task->get_old_activityid();
2230         $this->set_mapping($modulename, $oldid, $newitemid, true);
2231     }
2234 /**
2235  * Structure step in charge of creating/mapping all the qcats and qs
2236  * by parsing the questions.xml file and checking it against the
2237  * results calculated by {@link restore_process_categories_and_questions}
2238  * and stored in backup_ids_temp
2239  */
2240 class restore_create_categories_and_questions extends restore_structure_step {
2242     protected function define_structure() {
2244         $category = new restore_path_element('question_category', '/question_categories/question_category');
2245         $question = new restore_path_element('question', '/question_categories/question_category/questions/question');
2247         // Apply for 'qtype' plugins optional paths at question level
2248         $this->add_plugin_structure('qtype', $question);
2250         return array($category, $question);
2251     }
2253     protected function process_question_category($data) {
2254         global $DB;
2256         $data = (object)$data;
2257         $oldid = $data->id;
2259         // Check we have one mapping for this category
2260         if (!$mapping = $this->get_mapping('question_category', $oldid)) {
2261             return self::SKIP_ALL_CHILDREN; // No mapping = this category doesn't need to be created/mapped
2262         }
2264         // Check we have to create the category (newitemid = 0)
2265         if ($mapping->newitemid) {
2266             return; // newitemid != 0, this category is going to be mapped. Nothing to do
2267         }
2269         // Arrived here, newitemid = 0, we need to create the category
2270         // we'll do it at parentitemid context, but for CONTEXT_MODULE
2271         // categories, that will be created at CONTEXT_COURSE and moved
2272         // to module context later when the activity is created
2273         if ($mapping->info->contextlevel == CONTEXT_MODULE) {
2274             $mapping->parentitemid = $this->get_mappingid('context', $this->task->get_old_contextid());
2275         }
2276         $data->contextid = $mapping->parentitemid;
2278         // Let's create the question_category and save mapping
2279         $newitemid = $DB->insert_record('question_categories', $data);
2280         $this->set_mapping('question_category', $oldid, $newitemid);
2281         // Also annotate them as question_category_created, we need
2282         // that later when remapping parents
2283         $this->set_mapping('question_category_created', $oldid, $newitemid, false, null, $data->contextid);
2284     }
2286     protected function process_question($data) {
2287         global $DB;
2289         $data = (object)$data;
2290         $oldid = $data->id;
2292         // Check we have one mapping for this question
2293         if (!$questionmapping = $this->get_mapping('question', $oldid)) {
2294             return; // No mapping = this question doesn't need to be created/mapped
2295         }
2297         // Get the mapped category (cannot use get_new_parentid() because not
2298         // all the categories have been created, so it is not always available
2299         // Instead we get the mapping for the question->parentitemid because
2300         // we have loaded qcatids there for all parsed questions
2301         $data->category = $this->get_mappingid('question_category', $questionmapping->parentitemid);
2303         $data->timecreated  = $this->apply_date_offset($data->timecreated);
2304         $data->timemodified = $this->apply_date_offset($data->timemodified);
2306         $userid = $this->get_mappingid('user', $data->createdby);
2307         $data->createdby = $userid ? $userid : $this->task->get_userid();
2309         $userid = $this->get_mappingid('user', $data->modifiedby);
2310         $data->modifiedby = $userid ? $userid : $this->task->get_userid();
2312         // With newitemid = 0, let's create the question
2313         if (!$questionmapping->newitemid) {
2314             $newitemid = $DB->insert_record('question', $data);
2315             $this->set_mapping('question', $oldid, $newitemid);
2316             // Also annotate them as question_created, we need
2317             // that later when remapping parents (keeping the old categoryid as parentid)
2318             $this->set_mapping('question_created', $oldid, $newitemid, false, null, $questionmapping->parentitemid);
2319         } else {
2320             // By performing this set_mapping() we make get_old/new_parentid() to work for all the
2321             // children elements of the 'question' one (so qtype plugins will know the question they belong to)
2322             $this->set_mapping('question', $oldid, $questionmapping->newitemid);
2323         }
2325         // Note, we don't restore any question files yet
2326         // as far as the CONTEXT_MODULE categories still
2327         // haven't their contexts to be restored to
2328         // The {@link restore_create_question_files}, executed in the final step
2329         // step will be in charge of restoring all the question files
2330     }
2332     protected function after_execute() {
2333         global $DB;
2335         // First of all, recode all the created question_categories->parent fields
2336         $qcats = $DB->get_records('backup_ids_temp', array(
2337                      'backupid' => $this->get_restoreid(),
2338                      'itemname' => 'question_category_created'));
2339         foreach ($qcats as $qcat) {
2340             $newparent = 0;
2341             $dbcat = $DB->get_record('question_categories', array('id' => $qcat->newitemid));
2342             // Get new parent (mapped or created, so we look in quesiton_category mappings)
2343             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
2344                                  'backupid' => $this->get_restoreid(),
2345                                  'itemname' => 'question_category',
2346                                  'itemid'   => $dbcat->parent))) {
2347                 // contextids must match always, as far as we always include complete qbanks, just check it
2348                 $newparentctxid = $DB->get_field('question_categories', 'contextid', array('id' => $newparent));
2349                 if ($dbcat->contextid == $newparentctxid) {
2350                     $DB->set_field('question_categories', 'parent', $newparent, array('id' => $dbcat->id));
2351                 } else {
2352                     $newparent = 0; // No ctx match for both cats, no parent relationship
2353                 }
2354             }
2355             // Here with $newparent empty, problem with contexts or remapping, set it to top cat
2356             if (!$newparent) {
2357                 $DB->set_field('question_categories', 'parent', 0, array('id' => $dbcat->id));
2358             }
2359         }
2361         // Now, recode all the created question->parent fields
2362         $qs = $DB->get_records('backup_ids_temp', array(
2363                   'backupid' => $this->get_restoreid(),
2364                   'itemname' => 'question_created'));
2365         foreach ($qs as $q) {
2366             $newparent = 0;
2367             $dbq = $DB->get_record('question', array('id' => $q->newitemid));
2368             // Get new parent (mapped or created, so we look in question mappings)
2369             if ($newparent = $DB->get_field('backup_ids_temp', 'newitemid', array(
2370                                  'backupid' => $this->get_restoreid(),
2371                                  'itemname' => 'question',
2372                                  'itemid'   => $dbq->parent))) {
2373                 $DB->set_field('question', 'parent', $newparent, array('id' => $dbq->id));
2374             }
2375         }
2377         // Note, we don't restore any question files yet
2378         // as far as the CONTEXT_MODULE categories still
2379         // haven't their contexts to be restored to
2380         // The {@link restore_create_question_files}, executed in the final step
2381         // step will be in charge of restoring all the question files
2382     }
2385 /**
2386  * Execution step that will move all the CONTEXT_MODULE question categories
2387  * created at early stages of restore in course context (because modules weren't
2388  * created yet) to their target module (matching by old-new-contextid mapping)
2389  */
2390 class restore_move_module_questions_categories extends restore_execution_step {
2392     protected function define_execution() {
2393         global $DB;
2395         $contexts = restore_dbops::restore_get_question_banks($this->get_restoreid(), CONTEXT_MODULE);
2396         foreach ($contexts as $contextid => $contextlevel) {
2397             // Only if context mapping exists (i.e. the module has been restored)
2398             if ($newcontext = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'context', $contextid)) {
2399                 // Update all the qcats having their parentitemid set to the original contextid
2400                 $modulecats = $DB->get_records_sql("SELECT itemid, newitemid
2401                                                       FROM {backup_ids_temp}
2402                                                      WHERE backupid = ?
2403                                                        AND itemname = 'question_category'
2404                                                        AND parentitemid = ?", array($this->get_restoreid(), $contextid));
2405                 foreach ($modulecats as $modulecat) {
2406                     $DB->set_field('question_categories', 'contextid', $newcontext->newitemid, array('id' => $modulecat->newitemid));
2407                     // And set new contextid also in question_category mapping (will be
2408                     // used by {@link restore_create_question_files} later
2409                     restore_dbops::set_backup_ids_record($this->get_restoreid(), 'question_category', $modulecat->itemid, $modulecat->newitemid, $newcontext->newitemid);
2410                 }
2411             }
2412         }
2413     }
2416 /**
2417  * Execution step that will create all the question/answers/qtype-specific files for the restored
2418  * questions. It must be executed after {@link restore_move_module_questions_categories}
2419  * because only then each question is in its final category and only then the
2420  * context can be determined
2421  *
2422  * TODO: Improve this. Instead of looping over each question, it can be reduced to
2423  *       be done by contexts (this will save a huge ammount of queries)
2424  */
2425 class restore_create_question_files extends restore_execution_step {
2427     protected function define_execution() {
2428         global $DB;
2430         // Let's process only created questions
2431         $questionsrs = $DB->get_recordset_sql("SELECT bi.itemid, bi.newitemid, bi.parentitemid, q.qtype
2432                                                FROM {backup_ids_temp} bi
2433                                                JOIN {question} q ON q.id = bi.newitemid
2434                                               WHERE bi.backupid = ?
2435                                                 AND bi.itemname = 'question_created'", array($this->get_restoreid()));
2436         foreach ($questionsrs as $question) {
2437             // Get question_category mapping, it contains the target context for the question
2438             if (!$qcatmapping = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'question_category', $question->parentitemid)) {
2439                 // Something went really wrong, cannot find the question_category for the question
2440                 debugging('Error fetching target context for question', DEBUG_DEVELOPER);
2441                 continue;
2442             }
2443             // Calculate source and target contexts
2444             $oldctxid = $qcatmapping->info->contextid;
2445             $newctxid = $qcatmapping->parentitemid;
2447             // Add common question files (question and question_answer ones)
2448             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'questiontext',
2449                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
2450             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'generalfeedback',
2451                                               $oldctxid, $this->task->get_userid(), 'question_created', $question->itemid, $newctxid, true);
2452             restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), 'question', 'answerfeedback',
2453                                               $oldctxid, $this->task->get_userid(), 'question_answer', null, $newctxid, true);
2454             // Add qtype dependent files
2455             $components = backup_qtype_plugin::get_components_and_fileareas($question->qtype);
2456             foreach ($components as $component => $fileareas) {
2457                 foreach ($fileareas as $filearea => $mapping) {
2458                     // Use itemid only if mapping is question_created
2459                     $itemid = ($mapping == 'question_created') ? $question->itemid : null;
2460                     restore_dbops::send_files_to_pool($this->get_basepath(), $this->get_restoreid(), $component, $filearea,
2461                                                       $oldctxid, $this->task->get_userid(), $mapping, $itemid, $newctxid, true);
2462                 }
2463             }
2464         }
2465         $questionsrs->close();
2466     }
2469 /**
2470  * Abstract structure step, to be used by all the activities using core questions stuff
2471  * (like the quiz module), to support qtype plugins, states and sessions
2472  */
2473 abstract class restore_questions_activity_structure_step extends restore_activity_structure_step {
2475     /**
2476      * Attach below $element (usually attempts) the needed restore_path_elements
2477      * to restore question_states
2478      */
2479     protected function add_question_attempts_states($element, &$paths) {
2480         // Check $element is restore_path_element
2481         if (! $element instanceof restore_path_element) {
2482             throw new restore_step_exception('element_must_be_restore_path_element', $element);
2483         }
2484         // Check $paths is one array
2485         if (!is_array($paths)) {
2486             throw new restore_step_exception('paths_must_be_array', $paths);
2487         }
2488         $paths[] = new restore_path_element('question_state', $element->get_path() . '/states/state');
2489     }
2491     /**
2492      * Attach below $element (usually attempts) the needed restore_path_elements
2493      * to restore question_sessions
2494      */
2495     protected function add_question_attempts_sessions($element, &$paths) {
2496         // Check $element is restore_path_element
2497         if (! $element instanceof restore_path_element) {
2498             throw new restore_step_exception('element_must_be_restore_path_element', $element);
2499         }
2500         // Check $paths is one array
2501         if (!is_array($paths)) {
2502             throw new restore_step_exception('paths_must_be_array', $paths);
2503         }
2504         $paths[] = new restore_path_element('question_session', $element->get_path() . '/sessions/session');
2505     }
2507     /**
2508      * Process question_states
2509      */
2510     protected function process_question_state($data) {
2511         global $DB;
2513         $data = (object)$data;
2514         $oldid = $data->id;
2516         // Get complete question mapping, we'll need info
2517         $question = $this->get_mapping('question', $data->question);
2519         // In the quiz_attempt mapping we are storing uniqueid
2520         // and not id, so this gets the correct question_attempt to point to
2521         $data->attempt  = $this->get_new_parentid('quiz_attempt');
2522         $data->question = $question->newitemid;
2523         $data->answer   = $this->restore_recode_answer($data, $question->info->qtype); // Delegate recoding of answer
2524         $data->timestamp= $this->apply_date_offset($data->timestamp);
2526         // Everything ready, insert and create mapping (needed by question_sessions)
2527         $newitemid = $DB->insert_record('question_states', $data);
2528         $this->set_mapping('question_state', $oldid, $newitemid);
2529     }
2531     /**
2532      * Process question_sessions
2533      */
2534     protected function process_question_session($data) {
2535         global $DB;
2537         $data = (object)$data;
2538         $oldid = $data->id;
2540         // In the quiz_attempt mapping we are storing uniqueid
2541         // and not id, so this gets the correct question_attempt to point to
2542         $data->attemptid  = $this->get_new_parentid('quiz_attempt');
2543         $data->questionid = $this->get_mappingid('question', $data->questionid);
2544         $data->newest     = $this->get_mappingid('question_state', $data->newest);
2545         $data->newgraded  = $this->get_mappingid('question_state', $data->newgraded);
2547         // Everything ready, insert (no mapping needed)
2548         $newitemid = $DB->insert_record('question_sessions', $data);
2550         // Note: question_sessions haven't files associated. On purpose manualcomment is lacking
2551         // support for them, so we don't need to handle them here.
2552     }
2554     /**
2555      * Given a list of question->ids, separated by commas, returns the
2556      * recoded list, with all the restore question mappings applied.
2557      * Note: Used by quiz->questions and quiz_attempts->layout
2558      * Note: 0 = page break (unconverted)
2559      */
2560     protected function questions_recode_layout($layout) {
2561         // Extracts question id from sequence
2562         if ($questionids = explode(',', $layout)) {
2563             foreach ($questionids as $id => $questionid) {
2564                 if ($questionid) { // If it is zero then this is a pagebreak, don't translate
2565                     $newquestionid = $this->get_mappingid('question', $questionid);
2566                     $questionids[$id] = $newquestionid;
2567                 }
2568             }
2569         }
2570         return implode(',', $questionids);
2571     }
2573     /**
2574      * Given one question_states record, return the answer
2575      * recoded pointing to all the restored stuff
2576      */
2577     public function restore_recode_answer($state, $qtype) {
2578         // Build one static cache to store {@link restore_qtype_plugin}
2579         // while we are needing them, just to save zillions of instantiations
2580         // or using static stuff that will break our nice API
2581         static $qtypeplugins = array();
2583         // If we haven't the corresponding restore_qtype_plugin for current qtype
2584         // instantiate it and add to cache
2585         if (!isset($qtypeplugins[$qtype])) {
2586             $classname = 'restore_qtype_' . $qtype . '_plugin';
2587             if (class_exists($classname)) {
2588                 $qtypeplugins[$qtype] = new $classname('qtype', $qtype, $this);
2589             } else {
2590                 $qtypeplugins[$qtype] = false;
2591             }
2592         }
2593         return !empty($qtypeplugins[$qtype]) ? $qtypeplugins[$qtype]->recode_state_answer($state) : $state->answer;
2594     }