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