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