9179390612ce3f7df03e3ab9fd4a0868b9ae1377
[moodle.git] / backup / moodle2 / backup_stepslib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * @package moodlecore
20  * @subpackage backup-moodle2
21  * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 /**
26  * Define all the backup steps that will be used by common tasks in backup
27  */
29 /**
30  * create the temp dir where backup/restore will happen,
31  * delete old directories and create temp ids table
32  */
33 class create_and_clean_temp_stuff extends backup_execution_step {
35     protected function define_execution() {
36         backup_helper::check_and_create_backup_dir($this->get_backupid());// Create backup temp dir
37         backup_helper::clear_backup_dir($this->get_backupid());           // Empty temp dir, just in case
38         backup_helper::delete_old_backup_dirs(time() - (4 * 60 * 60));    // Delete > 4 hours temp dirs
39         backup_controller_dbops::create_backup_ids_temp_table($this->get_backupid()); // Create ids temp table
40     }
41 }
43 /**
44  * delete the temp dir used by backup/restore (conditionally),
45  * delete old directories and drop tem ids table. Note we delete
46  * the directory but not the corresponding log file that will be
47  * there for, at least, 4 hours - only delete_old_backup_dirs()
48  * deletes log files (for easier access to them)
49  */
50 class drop_and_clean_temp_stuff extends backup_execution_step {
52     protected function define_execution() {
53         global $CFG;
54         backup_controller_dbops::drop_backup_ids_temp_table($this->get_backupid()); // Drop ids temp table
55         backup_helper::delete_old_backup_dirs(time() - (4 * 60 * 60));              // Delete > 4 hours temp dirs
56         if (empty($CFG->keeptempdirectoriesonbackup)) { // Conditionally
57             backup_helper::delete_backup_dir($this->get_backupid()); // Empty backup dir
58         }
59     }
60 }
62 /**
63  * Create the directory where all the task (activity/block...) information will be stored
64  */
65 class create_taskbasepath_directory extends backup_execution_step {
67     protected function define_execution() {
68         global $CFG;
69         $basepath = $this->task->get_taskbasepath();
70         if (!check_dir_exists($basepath, true, true)) {
71             throw new backup_step_exception('cannot_create_taskbasepath_directory', $basepath);
72         }
73     }
74 }
76 /**
77  * Abstract structure step, parent of all the activity structure steps. Used to wrap the
78  * activity structure definition within the main <activity ...> tag. Also provides
79  * subplugin support for activities (that must be properly declared)
80  */
81 abstract class backup_activity_structure_step extends backup_structure_step {
83     /**
84      * Add subplugin structure to any element in the activity backup tree
85      *
86      * @param string $subplugintype type of subplugin as defined in activity db/subplugins.php
87      * @param backup_nested_element $element element in the activity backup tree that
88      *                                       we are going to add subplugin information to
89      * @param bool $multiple to define if multiple subplugins can produce information
90      *                       for each instance of $element (true) or no (false)
91      */
92     protected function add_subplugin_structure($subplugintype, $element, $multiple) {
94         global $CFG;
96         // Check the requested subplugintype is a valid one
97         $subpluginsfile = $CFG->dirroot . '/mod/' . $this->task->get_modulename() . '/db/subplugins.php';
98         if (!file_exists($subpluginsfile)) {
99              throw new backup_step_exception('activity_missing_subplugins_php_file', $this->task->get_modulename());
100         }
101         include($subpluginsfile);
102         if (!array_key_exists($subplugintype, $subplugins)) {
103              throw new backup_step_exception('incorrect_subplugin_type', $subplugintype);
104         }
106         // Arrived here, subplugin is correct, let's create the optigroup
107         $optigroupname = $subplugintype . '_' . $element->get_name() . '_subplugin';
108         $optigroup = new backup_optigroup($optigroupname, null, $multiple);
109         $element->add_child($optigroup); // Add optigroup to stay connected since beginning
111         // Get all the optigroup_elements, looking across all the subplugin dirs
112         $elements = array();
113         $subpluginsdirs = get_plugin_list($subplugintype);
114         foreach ($subpluginsdirs as $name => $subpluginsdir) {
115             $classname = 'backup_' . $subplugintype . '_' . $name . '_subplugin';
116             $backupfile = $subpluginsdir . '/backup/moodle2/' . $classname . '.class.php';
117             if (file_exists($backupfile)) {
118                 require_once($backupfile);
119                 $backupsubplugin = new $classname($subplugintype, $name, $optigroup);
120                 // Add subplugin returned structure to optigroup
121                 $backupsubplugin->define_subplugin_structure($element->get_name());
122             }
123         }
124     }
126     /**
127      * Wraps any activity backup structure within the common 'activity' element
128      * that will include common to all activities information like id, context...
129      */
130     protected function prepare_activity_structure($activitystructure) {
132         // Create the wrap element
133         $activity = new backup_nested_element('activity', array('id', 'moduleid', 'modulename', 'contextid'), null);
135         // Build the tree
136         $activity->add_child($activitystructure);
138         // Set the source
139         $activityarr = array((object)array(
140             'id'         => $this->task->get_activityid(),
141             'moduleid'   => $this->task->get_moduleid(),
142             'modulename' => $this->task->get_modulename(),
143             'contextid'  => $this->task->get_contextid()));
145         $activity->set_source_array($activityarr);
147         // Return the root element (activity)
148         return $activity;
149     }
152 /**
153  * Abstract structure step, parent of all the block structure steps. Used to wrap the
154  * block structure definition within the main <block ...> tag
155  */
156 abstract class backup_block_structure_step extends backup_structure_step {
158     protected function prepare_block_structure($blockstructure) {
160         // Create the wrap element
161         $block = new backup_nested_element('block', array('id', 'blockname', 'contextid'), null);
163         // Build the tree
164         $block->add_child($blockstructure);
166         // Set the source
167         $blockarr = array((object)array(
168             'id'         => $this->task->get_blockid(),
169             'blockname'  => $this->task->get_blockname(),
170             'contextid'  => $this->task->get_contextid()));
172         $block->set_source_array($blockarr);
174         // Return the root element (block)
175         return $block;
176     }
179 /**
180  * structure step that will generate the module.xml file for the activity,
181  * accumulating various information about the activity, annotating groupings
182  * and completion/avail conf
183  */
184 class backup_module_structure_step extends backup_structure_step {
186     protected function define_structure() {
188         // Define each element separated
190         $module = new backup_nested_element('module', array('id', 'version'), array(
191             'modulename', 'sectionid', 'sectionnumber', 'idnumber',
192             'added', 'score', 'indent', 'visible',
193             'visibleold', 'groupmode', 'groupingid', 'groupmembersonly',
194             'completion', 'completiongradeitemnumber', 'completionview', 'completionexpected',
195             'availablefrom', 'availableuntil', 'showavailability'));
197         $availinfo = new backup_nested_element('availability_info');
198         $availability = new backup_nested_element('availability', array('id'), array(
199             'sourcecmid', 'requiredcompletion', 'gradeitemid', 'grademin', 'grademax'));
201         // Define the tree
202         $module->add_child($availinfo);
203         $availinfo->add_child($availability);
205         // Set the sources
207         $module->set_source_sql('
208             SELECT cm.*, m.version, m.name AS modulename, s.id AS sectionid, s.section AS sectionnumber
209               FROM {course_modules} cm
210               JOIN {modules} m ON m.id = cm.module
211               JOIN {course_sections} s ON s.id = cm.section
212              WHERE cm.id = ?', array(backup::VAR_MODID));
214         $availability->set_source_table('course_modules_availability', array('coursemoduleid' => backup::VAR_MODID));
216         // Define annotations
217         $module->annotate_ids('grouping', 'groupingid');
219         // Return the root element ($module)
220         return $module;
221     }
224 /**
225  * structure step that will generate the section.xml file for the section
226  * annotating files
227  */
228 class backup_section_structure_step extends backup_structure_step {
230     protected function define_structure() {
232         // Define each element separated
234         $section = new backup_nested_element('section', array('id'), array(
235             'number', 'name', 'summary', 'summaryformat', 'sequence', 'visible'));
237         // Define sources
239         $section->set_source_table('course_sections', array('id' => backup::VAR_SECTIONID));
241         // Aliases
242         $section->set_source_alias('section', 'number');
244         // Set annotations
245         $section->annotate_files('course', 'section', 'id');
247         return $section;
248     }
251 /**
252  * structure step that will generate the course.xml file for the course, including
253  * course category reference, tags, modules restriction information
254  * and some annotations (files & groupings)
255  */
256 class backup_course_structure_step extends backup_structure_step {
258     protected function define_structure() {
259         global $DB;
261         // Define each element separated
263         $course = new backup_nested_element('course', array('id', 'contextid'), array(
264             'shortname', 'fullname', 'idnumber',
265             'summary', 'summaryformat', 'format', 'showgrades',
266             'newsitems', 'startdate',
267             'numsections', 'marker', 'maxbytes', 'showreports',
268             'visible', 'hiddensections', 'groupmode', 'groupmodeforce',
269             'defaultgroupingid', 'lang', 'theme',
270             'timecreated', 'timemodified',
271             'requested', 'restrictmodules',
272             'enablecompletion'));
274         $category = new backup_nested_element('category', array('id'), array(
275             'name', 'description'));
277         $tags = new backup_nested_element('tags');
279         $tag = new backup_nested_element('tag', array('id'), array(
280             'name', 'rawname'));
282         $allowedmodules = new backup_nested_element('allowed_modules');
284         $module = new backup_nested_element('module', array('modulename'));
286         // Build the tree
288         $course->add_child($category);
290         $course->add_child($tags);
291         $tags->add_child($tag);
293         $course->add_child($allowedmodules);
294         $allowedmodules->add_child($module);
296         // Set the sources
298         $courserec = $DB->get_record('course', array('id' => $this->task->get_courseid()));
299         $courserec->contextid = $this->task->get_contextid();
301         $course->set_source_array(array($courserec));
303         $categoryrec = $DB->get_record('course_categories', array('id' => $courserec->category));
305         $category->set_source_array(array($categoryrec));
307         $tag->set_source_sql('SELECT t.id, t.name, t.rawname
308                                 FROM {tag} t
309                                 JOIN {tag_instance} ti ON ti.tagid = t.id
310                                WHERE ti.itemtype = ?
311                                  AND ti.itemid = ?', array(
312                                      backup_helper::is_sqlparam('course'),
313                                      backup::VAR_PARENTID));
315         $module->set_source_sql('SELECT m.name AS modulename
316                                    FROM {modules} m
317                                    JOIN {course_allowed_modules} cam ON m.id = cam.module
318                                   WHERE course = ?', array(backup::VAR_COURSEID));
320         // Some annotations
322         $course->annotate_ids('grouping', 'defaultgroupingid');
324         $course->annotate_files('course', 'summary', null);
325         $course->annotate_files('course', 'legacy', null);
327         // Return root element ($course)
329         return $course;
330     }
333 /**
334  * structure step that will generate the enrolments.xml file for the given course
335  */
336 class backup_enrolments_structure_step extends backup_structure_step {
338     protected function define_structure() {
340         // To know if we are including users
341         $users = $this->get_setting_value('users');
343         // Define each element separated
345         $enrolments = new backup_nested_element('enrolments');
347         $enrols = new backup_nested_element('enrols');
349         $enrol = new backup_nested_element('enrol', array('id'), array(
350             'enrol', 'status', 'sortorder', 'name', 'enrolperiod', 'enrolstartdate',
351             'enrolenddate', 'expirynotify', 'expirytreshold', 'notifyall',
352             'password', 'cost', 'currency', 'roleid', 'customint1', 'customint2', 'customint3',
353             'customint4', 'customchar1', 'customchar2', 'customdec1', 'customdec2',
354             'customtext1', 'customtext2', 'timecreated', 'timemodified'));
356         $userenrolments = new backup_nested_element('user_enrolments');
358         $enrolment = new backup_nested_element('enrolment', array('id'), array(
359             'status', 'userid', 'timestart', 'timeend', 'modifierid',
360             'timemodified'));
362         // Build the tree
363         $enrolments->add_child($enrols);
364         $enrols->add_child($enrol);
365         $enrol->add_child($userenrolments);
366         $userenrolments->add_child($enrolment);
368         // Define sources
370         $enrol->set_source_table('enrol', array('courseid' => backup::VAR_COURSEID));
372         // User enrolments only added only if users included
373         if ($users) {
374             $enrolment->set_source_table('user_enrolments', array('enrolid' => backup::VAR_PARENTID));
375             $enrolment->annotate_ids('user', 'userid');
376         }
378         $enrol->annotate_ids('role', 'roleid');
380         //TODO: let plugins annotate custom fields too and add more children
382         return $enrolments;
383     }
386 /**
387  * structure step that will generate the roles.xml file for the given context, observing
388  * the role_assignments setting to know if that part needs to be included
389  */
390 class backup_roles_structure_step extends backup_structure_step {
392     protected function define_structure() {
394         // To know if we are including role assignments
395         $roleassignments = $this->get_setting_value('role_assignments');
397         // Define each element separated
399         $roles = new backup_nested_element('roles');
401         $overrides = new backup_nested_element('role_overrides');
403         $override = new backup_nested_element('override', array('id'), array(
404             'roleid', 'capability', 'permission', 'timemodified',
405             'modifierid'));
407         $assignments = new backup_nested_element('role_assignments');
409         $assignment = new backup_nested_element('assignment', array('id'), array(
410             'roleid', 'userid', 'timemodified', 'modifierid', 'component', 'itemid',
411             'sortorder'));
413         // Build the tree
414         $roles->add_child($overrides);
415         $roles->add_child($assignments);
417         $overrides->add_child($override);
418         $assignments->add_child($assignment);
420         // Define sources
422         $override->set_source_table('role_capabilities', array('contextid' => backup::VAR_CONTEXTID));
424         // Assignments only added if specified
425         if ($roleassignments) {
426             $assignment->set_source_table('role_assignments', array('contextid' => backup::VAR_CONTEXTID));
427         }
429         // Define id annotations
430         $override->annotate_ids('role', 'roleid');
432         $assignment->annotate_ids('role', 'roleid');
434         $assignment->annotate_ids('user', 'userid');
436         //TODO: how do we annotate the itemid? the meaning depends on the content of component table (skodak)
438         return $roles;
439     }
442 /**
443  * structure step that will generate the roles.xml containing the
444  * list of roles used along the whole backup process. Just raw
445  * list of used roles from role table
446  */
447 class backup_final_roles_structure_step extends backup_structure_step {
449     protected function define_structure() {
451         // Define elements
453         $rolesdef = new backup_nested_element('roles_definition');
455         $role = new backup_nested_element('role', array('id'), array(
456             'name', 'shortname', 'nameincourse', 'description',
457             'sortorder', 'archetype'));
459         // Build the tree
461         $rolesdef->add_child($role);
463         // Define sources
465         $role->set_source_sql("SELECT r.*, rn.name AS nameincourse
466                                  FROM {role} r
467                                  JOIN {backup_ids_temp} bi ON r.id = bi.itemid
468                             LEFT JOIN {role_names} rn ON r.id = rn.roleid AND rn.contextid = ?
469                                 WHERE bi.backupid = ?
470                                   AND bi.itemname = 'rolefinal'", array(backup::VAR_CONTEXTID, backup::VAR_BACKUPID));
472         // Return main element (rolesdef)
473         return $rolesdef;
474     }
477 /**
478  * structure step that will generate the scales.xml containing the
479  * list of scales used along the whole backup process.
480  */
481 class backup_final_scales_structure_step extends backup_structure_step {
483     protected function define_structure() {
485         // Define elements
487         $scalesdef = new backup_nested_element('scales_definition');
489         $scale = new backup_nested_element('scale', array('id'), array(
490             'courseid', 'userid', 'name', 'scale',
491             'description', 'descriptionformat', 'timemodified'));
493         // Build the tree
495         $scalesdef->add_child($scale);
497         // Define sources
499         $scale->set_source_sql("SELECT s.*
500                                   FROM {scale} s
501                                   JOIN {backup_ids_temp} bi ON s.id = bi.itemid
502                                  WHERE bi.backupid = ?
503                                    AND bi.itemname = 'scalefinal'", array(backup::VAR_BACKUPID));
505         // Return main element (scalesdef)
506         return $scalesdef;
507     }
510 /**
511  * structure step that will generate the outcomes.xml containing the
512  * list of outcomes used along the whole backup process.
513  */
514 class backup_final_outcomes_structure_step extends backup_structure_step {
516     protected function define_structure() {
518         // Define elements
520         $outcomesdef = new backup_nested_element('outcomes_definition');
522         $outcome = new backup_nested_element('outcome', array('id'), array(
523             'courseid', 'userid', 'shortname', 'fullname',
524             'scaleid', 'description', 'descriptionformat', 'timecreated',
525             'timemodified','usermodified'));
527         // Build the tree
529         $outcomesdef->add_child($outcome);
531         // Define sources
533         $outcome->set_source_sql("SELECT o.*
534                                     FROM {grade_outcomes} o
535                                     JOIN {backup_ids_temp} bi ON o.id = bi.itemid
536                                    WHERE bi.backupid = ?
537                                      AND bi.itemname = 'outcomefinal'", array(backup::VAR_BACKUPID));
539         // Return main element (outcomesdef)
540         return $outcomesdef;
541     }
544 /**
545  * structure step in charge of constructing the filters.xml file for all the filters found
546  * in activity
547  */
548 class backup_filters_structure_step extends backup_structure_step {
550     protected function define_structure() {
552         // Define each element separated
554         $filters = new backup_nested_element('filters');
556         $actives = new backup_nested_element('filter_actives');
558         $active = new backup_nested_element('filter_active', null, array('filter', 'active'));
560         $configs = new backup_nested_element('filter_configs');
562         $config = new backup_nested_element('filter_config', null, array('filter', 'name', 'value'));
564         // Build the tree
566         $filters->add_child($actives);
567         $filters->add_child($configs);
569         $actives->add_child($active);
570         $configs->add_child($config);
572         // Define sources
574         list($activearr, $configarr) = filter_get_all_local_settings($this->task->get_contextid());
576         $active->set_source_array($activearr);
577         $config->set_source_array($configarr);
579         // Return the root element (filters)
580         return $filters;
581     }
584 /**
585  * structure step in charge of constructing the comments.xml file for all the comments found
586  * in a given context
587  */
588 class backup_comments_structure_step extends backup_structure_step {
590     protected function define_structure() {
592         // Define each element separated
594         $comments = new backup_nested_element('comments');
596         $comment = new backup_nested_element('comment', array('id'), array(
597             'commentarea', 'itemid', 'content', 'format',
598             'userid', 'timecreated'));
600         // Build the tree
602         $comments->add_child($comment);
604         // Define sources
606         $comment->set_source_table('comments', array('contextid' => backup::VAR_CONTEXTID));
608         // Define id annotations
610         $comment->annotate_ids('user', 'userid');
612         // Return the root element (comments)
613         return $comments;
614     }
617 /**
618  * structure step in charge of constructing the gradebook.xml file for all the gradebook config in the course
619  * NOTE: the backup of the grade items themselves is handled by backup_activity_grades_structure_step
620  */
621 class backup_gradebook_structure_step extends backup_structure_step {
623     /**
624      * We need to decide conditionally, based on dynamic information
625      * about the execution of this step. Only will be executed if all
626      * the module gradeitems have been already included in backup
627      */
628     protected function execute_condition() {
629         return backup_plan_dbops::require_gradebook_backup($this->get_courseid(), $this->get_backupid());
630     }
632     protected function define_structure() {
634         // are we including user info?
635         $userinfo = $this->get_setting_value('users');
637         $gradebook = new backup_nested_element('gradebook');
639         //grade_letters are done in backup_activity_grades_structure_step()
641         //calculated grade items
642         $grade_items = new backup_nested_element('grade_items');
643         $grade_item = new backup_nested_element('grade_item', array('id'), array(
644             'categoryid', 'itemname', 'itemtype', 'itemmodule',
645             'iteminstance', 'itemnumber', 'iteminfo', 'idnumber',
646             'calculation', 'gradetype', 'grademax', 'grademin',
647             'scaleid', 'outcomeid', 'gradepass', 'multfactor',
648             'plusfactor', 'aggregationcoef', 'sortorder', 'display',
649             'decimals', 'hidden', 'locked', 'locktime',
650             'needsupdate', 'timecreated', 'timemodified'));
652         $grade_grades = new backup_nested_element('grade_grades');
653         $grade_grade = new backup_nested_element('grade_grade', array('id'), array(
654             'userid', 'rawgrade', 'rawgrademax', 'rawgrademin',
655             'rawscaleid', 'usermodified', 'finalgrade', 'hidden',
656             'locked', 'locktime', 'exported', 'overridden',
657             'excluded', 'feedback', 'feedbackformat', 'information',
658             'informationformat', 'timecreated', 'timemodified'));
660         //grade_categories
661         $grade_categories = new backup_nested_element('grade_categories');
662         $grade_category   = new backup_nested_element('grade_category', null, array('courseid',
663                 'parent', 'depth', 'path', 'fullname', 'aggregation', 'keephigh',
664                 'dropload', 'aggregateonlygraded', 'aggregateoutcomes', 'aggregatesubcats',
665                 'timecreated', 'timemodified'));
667         $letters = new backup_nested_element('grade_letters');
668         $letter = new backup_nested_element('grade_letter', 'id', array(
669             'lowerboundary', 'letter'));
672         // Build the tree
674         $gradebook->add_child($grade_items);
675         $grade_items->add_child($grade_item);
676         $grade_item->add_child($grade_grades);
677         $grade_grades->add_child($grade_grade);
679         //$grade_item->add_child($grade_scale);
681         $gradebook->add_child($grade_categories);
682         $grade_categories->add_child($grade_category);
684         $gradebook->add_child($letters);
685         $letters->add_child($letter);
687         // Define sources
689         //Include manual, category and the course grade item
690         $grade_items_sql ="SELECT * FROM {grade_items} 
691                            WHERE courseid = :courseid
692                            AND (itemtype='manual' OR itemtype='course' OR itemtype='category')";
693         $grade_items_params = array('courseid'=>backup::VAR_COURSEID);
694         $grade_item->set_source_sql($grade_items_sql, $grade_items_params);
696         if ($userinfo) {
697             $grade_grade->set_source_table('grade_grades', array('itemid' => backup::VAR_PARENTID));
698         }
700         $grade_category_sql = "SELECT gc.*, gi.sortorder
701                                FROM {grade_categories} gc
702                                JOIN {grade_items} gi ON (gi.iteminstance = gc.id)
703                                WHERE gc.courseid = :courseid
704                                AND (gi.itemtype='course' OR gi.itemtype='category')
705                                ORDER BY gc.parent ASC";//need parent categories before their children
706         $grade_category_params = array('courseid'=>backup::VAR_COURSEID);
707         $grade_category->set_source_sql($grade_category_sql, $grade_category_params);
709         $letter->set_source_table('grade_letters', array('contextid' => backup::VAR_CONTEXTID));
711         // Annotations (both as final as far as they are going to be exported in next steps)
712         $grade_item->annotate_ids('scalefinal', 'scaleid'); // Straight as scalefinal because it's > 0
713         $grade_item->annotate_ids('outcomefinal', 'outcomeid');
715         // Return the root element
716         return $gradebook;
717     }
720 /**
721  * structure step in charge if constructing the completion.xml file for all the users completion
722  * information in a given activity
723  */
724 class backup_userscompletion_structure_step extends backup_structure_step {
726     protected function define_structure() {
728         // Define each element separated
730         $completions = new backup_nested_element('completions');
732         $completion = new backup_nested_element('completion', array('id'), array(
733             'userid', 'completionstate', 'viewed', 'timemodified'));
735         // Build the tree
737         $completions->add_child($completion);
739         // Define sources
741         $completion->set_source_table('course_modules_completion', array('coursemoduleid' => backup::VAR_MODID));
743         // Define id annotations
745         $completion->annotate_ids('user', 'userid');
747         // Return the root element (completions)
748         return $completions;
749     }
752 /**
753  * structure step in charge of constructing the main groups.xml file for all the groups and
754  * groupings information already annotated
755  */
756 class backup_groups_structure_step extends backup_structure_step {
758     protected function define_structure() {
760         // To know if we are including users
761         $users = $this->get_setting_value('users');
763         // Define each element separated
765         $groups = new backup_nested_element('groups');
767         $group = new backup_nested_element('group', array('id'), array(
768             'name', 'description', 'descriptionformat', 'enrolmentkey',
769             'picture', 'hidepicture', 'timecreated', 'timemodified'));
771         $members = new backup_nested_element('group_members');
773         $member = new backup_nested_element('group_member', array('id'), array(
774             'userid', 'timeadded'));
776         $groupings = new backup_nested_element('groupings');
778         $grouping = new backup_nested_element('grouping', 'id', array(
779             'name', 'description', 'descriptionformat', 'configdata',
780             'timecreated', 'timemodified'));
782         $groupinggroups = new backup_nested_element('grouping_groups');
784         $groupinggroup = new backup_nested_element('grouping_group', array('id'), array(
785             'groupid', 'timeadded'));
787         // Build the tree
789         $groups->add_child($group);
790         $groups->add_child($groupings);
792         $group->add_child($members);
793         $members->add_child($member);
795         $groupings->add_child($grouping);
796         $grouping->add_child($groupinggroups);
797         $groupinggroups->add_child($groupinggroup);
799         // Define sources
801         $group->set_source_sql("
802             SELECT g.*
803               FROM {groups} g
804               JOIN {backup_ids_temp} bi ON g.id = bi.itemid
805              WHERE bi.backupid = ?
806                AND bi.itemname = 'groupfinal'", array(backup::VAR_BACKUPID));
808         // This only happens if we are including users
809         if ($users) {
810             $member->set_source_table('groups_members', array('groupid' => backup::VAR_PARENTID));
811         }
813         $grouping->set_source_sql("
814             SELECT g.*
815               FROM {groupings} g
816               JOIN {backup_ids_temp} bi ON g.id = bi.itemid
817              WHERE bi.backupid = ?
818                AND bi.itemname = 'groupingfinal'", array(backup::VAR_BACKUPID));
820         $groupinggroup->set_source_table('groupings_groups', array('groupingid' => backup::VAR_PARENTID));
822         // Define id annotations (as final)
824         $member->annotate_ids('userfinal', 'userid');
826         // Define file annotations
828         $group->annotate_files('group', 'description', 'id');
829         $group->annotate_files('group', 'icon', 'id');
831         // Return the root element (groups)
832         return $groups;
833     }
836 /**
837  * structure step in charge of constructing the main users.xml file for all the users already
838  * annotated (final). Includes custom profile fields, preferences, tags, role assignments and
839  * overrides.
840  */
841 class backup_users_structure_step extends backup_structure_step {
843     protected function define_structure() {
844         global $CFG;
846         // To know if we are anonymizing users
847         $anonymize = $this->get_setting_value('anonymize');
848         // To know if we are including role assignments
849         $roleassignments = $this->get_setting_value('role_assignments');
851         // Define each element separated
853         $users = new backup_nested_element('users');
855         // Create the array of user fields by hand, as far as we have various bits to control
856         // anonymize option, password backup, mnethostid...
858         // First, the fields not needing anonymization nor special handling
859         $normalfields = array(
860             'confirmed', 'policyagreed', 'deleted',
861             'lang', 'theme', 'timezone', 'firstaccess',
862             'lastaccess', 'lastlogin', 'currentlogin',
863             'mailformat', 'maildigest', 'maildisplay', 'htmleditor',
864             'ajax', 'autosubscribe', 'trackforums', 'timecreated',
865             'timemodified', 'trustbitmask', 'screenreader');
867         // Then, the fields potentially needing anonymization
868         $anonfields = array(
869             'username', 'idnumber', 'firstname', 'lastname',
870             'email', 'emailstop', 'icq', 'skype',
871             'yahoo', 'aim', 'msn', 'phone1',
872             'phone2', 'institution', 'department', 'address',
873             'city', 'country', 'lastip', 'picture',
874             'url', 'description', 'descriptionformat', 'imagealt', 'auth');
876         // Add anonymized fields to $userfields with custom final element
877         foreach ($anonfields as $field) {
878             if ($anonymize) {
879                 $userfields[] = new anonymizer_final_element($field);
880             } else {
881                 $userfields[] = $field; // No anonymization, normally added
882             }
883         }
885         // mnethosturl requires special handling (custom final element)
886         $userfields[] = new mnethosturl_final_element('mnethosturl');
888         // password added conditionally
889         if (!empty($CFG->includeuserpasswordsinbackup)) {
890             $userfields[] = 'password';
891         }
893         // Merge all the fields
894         $userfields = array_merge($userfields, $normalfields);
896         $user = new backup_nested_element('user', array('id', 'contextid'), $userfields);
898         $customfields = new backup_nested_element('custom_fields');
900         $customfield = new backup_nested_element('custom_field', array('id'), array(
901             'field_name', 'field_type', 'field_data'));
903         $tags = new backup_nested_element('tags');
905         $tag = new backup_nested_element('tag', array('id'), array(
906             'name', 'rawname'));
908         $preferences = new backup_nested_element('preferences');
910         $preference = new backup_nested_element('preference', array('id'), array(
911             'name', 'value'));
913         $roles = new backup_nested_element('roles');
915         $overrides = new backup_nested_element('role_overrides');
917         $override = new backup_nested_element('override', array('id'), array(
918             'roleid', 'capability', 'permission', 'timemodified',
919             'modifierid'));
921         $assignments = new backup_nested_element('role_assignments');
923         $assignment = new backup_nested_element('assignment', array('id'), array(
924             'roleid', 'userid', 'timemodified', 'modifierid', 'component', //TODO: MDL-22793 add itemid here
925             'sortorder'));
927         // Build the tree
929         $users->add_child($user);
931         $user->add_child($customfields);
932         $customfields->add_child($customfield);
934         $user->add_child($tags);
935         $tags->add_child($tag);
937         $user->add_child($preferences);
938         $preferences->add_child($preference);
940         $user->add_child($roles);
942         $roles->add_child($overrides);
943         $roles->add_child($assignments);
945         $overrides->add_child($override);
946         $assignments->add_child($assignment);
948         // Define sources
950         $user->set_source_sql('SELECT u.*, c.id AS contextid, m.wwwroot AS mnethosturl
951                                  FROM {user} u
952                                  JOIN {backup_ids_temp} bi ON bi.itemid = u.id
953                                  JOIN {context} c ON c.instanceid = u.id
954                             LEFT JOIN {mnet_host} m ON m.id = u.mnethostid
955                                 WHERE bi.backupid = ?
956                                   AND bi.itemname = ?
957                                   AND c.contextlevel = ?', array(
958                                       backup_helper::is_sqlparam($this->get_backupid()),
959                                       backup_helper::is_sqlparam('userfinal'),
960                                       backup_helper::is_sqlparam(CONTEXT_USER)));
962         // All the rest on information is only added if we arent
963         // in an anonymized backup
964         if (!$anonymize) {
965             $customfield->set_source_sql('SELECT f.id, f.shortname, f.datatype, d.data
966                                             FROM {user_info_field} f
967                                             JOIN {user_info_data} d ON d.fieldid = f.id
968                                            WHERE d.userid = ?', array(backup::VAR_PARENTID));
970             $customfield->set_source_alias('shortname', 'field_name');
971             $customfield->set_source_alias('datatype',  'field_type');
972             $customfield->set_source_alias('data',      'field_data');
974             $tag->set_source_sql('SELECT t.id, t.name, t.rawname
975                                     FROM {tag} t
976                                     JOIN {tag_instance} ti ON ti.tagid = t.id
977                                    WHERE ti.itemtype = ?
978                                      AND ti.itemid = ?', array(
979                                          backup_helper::is_sqlparam('user'),
980                                          backup::VAR_PARENTID));
982             $preference->set_source_table('user_preferences', array('userid' => backup::VAR_PARENTID));
984             $override->set_source_table('role_capabilities', array('contextid' => '/users/user/contextid'));
986             // Assignments only added if specified
987             if ($roleassignments) {
988                 $assignment->set_source_table('role_assignments', array('contextid' => '/users/user/contextid'));
989             }
991             // Define id annotations (as final)
992             $override->annotate_ids('rolefinal', 'roleid');
993         }
995         // Return root element (users)
996         return $users;
997     }
1000 /**
1001  * structure step in charge of constructing the block.xml file for one
1002  * given block (instance and positions). If the block has custom DB structure
1003  * that will go to a separate file (different step defined in block class)
1004  */
1005 class backup_block_instance_structure_step extends backup_structure_step {
1007     protected function define_structure() {
1008         global $DB;
1010         // Define each element separated
1012         $block = new backup_nested_element('block', array('id', 'contextid', 'version'), array(
1013             'blockname', 'parentcontextid', 'showinsubcontexts', 'pagetypepattern',
1014             'subpagepattern', 'defaultregion', 'defaultweight', 'configdata'));
1016         $positions = new backup_nested_element('block_positions', null, array(
1017             'contextid', 'pagetype', 'subpage', 'visible',
1018             'region', 'weight'));
1020         // Build the tree
1022         $block->add_child($positions);
1024         // Transform configdata information if needed (process links and friends)
1025         $blockrec = $DB->get_record('block_instances', array('id' => $this->task->get_blockid()));
1026         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
1027             $configdata = (array)unserialize(base64_decode($blockrec->configdata));
1028             foreach ($configdata as $attribute => $value) {
1029                 if (in_array($attribute, $attrstotransform)) {
1030                     $configdata[$attribute] = $this->contenttransformer->process($value);
1031                 }
1032             }
1033             $blockrec->configdata = base64_encode(serialize((object)$configdata));
1034         }
1035         $blockrec->contextid = $this->task->get_contextid();
1036         // Get the version of the block
1037         $blockrec->version = $DB->get_field('block', 'version', array('name' => $this->task->get_blockname()));
1039         // Define sources
1041         $block->set_source_array(array($blockrec));
1043         $positions->set_source_table('block_positions', array('blockinstanceid' => backup::VAR_PARENTID));
1045         // Return the root element (block)
1046         return $block;
1047     }
1050 /**
1051  * structure step in charge of constructing the logs.xml file for all the log records found
1052  * in activity
1053  */
1054 class backup_activity_logs_structure_step extends backup_structure_step {
1056     protected function define_structure() {
1058         // Define each element separated
1060         $logs = new backup_nested_element('logs');
1062         $log = new backup_nested_element('log', array('id'), array(
1063             'time', 'userid', 'ip', 'module',
1064             'action', 'url', 'info'));
1066         // Build the tree
1068         $logs->add_child($log);
1070         // Define sources
1072         $log->set_source_table('log', array('cmid' => backup::VAR_MODID));
1074         // Annotations
1075         // NOTE: We don't annotate users from logs as far as they MUST be
1076         //       always annotated by the activity.
1078         // Return the root element (logs)
1080         return $logs;
1081     }
1084 /**
1085  * structure in charge of constructing the inforef.xml file for all the items we want
1086  * to have referenced there (users, roles, files...)
1087  */
1088 class backup_inforef_structure_step extends backup_structure_step {
1090     protected function define_structure() {
1092         // Items we want to include in the inforef file.
1093         $items = backup_helper::get_inforef_itemnames();
1095         // Build the tree
1097         $inforef = new backup_nested_element('inforef');
1099         // For each item, conditionally, if there are already records, build element
1100         foreach ($items as $itemname) {
1101             if (backup_structure_dbops::annotations_exist($this->get_backupid(), $itemname)) {
1102                 $elementroot = new backup_nested_element($itemname . 'ref');
1103                 $element = new backup_nested_element($itemname, array(), array('id'));
1104                 $inforef->add_child($elementroot);
1105                 $elementroot->add_child($element);
1106                 $element->set_source_sql("
1107                     SELECT itemid AS id
1108                      FROM {backup_ids_temp}
1109                     WHERE backupid = ?
1110                       AND itemname = ?",
1111                    array(backup::VAR_BACKUPID, backup_helper::is_sqlparam($itemname)));
1112             }
1113         }
1115         // We don't annotate anything there, but rely in the next step
1116         // (move_inforef_annotations_to_final) that will change all the
1117         // already saved 'inforref' entries to their 'final' annotations.
1118         return $inforef;
1119     }
1122 /**
1123  * This step will get all the annotations already processed to inforef.xml file and
1124  * transform them into 'final' annotations.
1125  */
1126 class move_inforef_annotations_to_final extends backup_execution_step {
1128     protected function define_execution() {
1130         // Items we want to include in the inforef file
1131         $items = backup_helper::get_inforef_itemnames();
1132         foreach ($items as $itemname) {
1133             // Delegate to dbops
1134             backup_structure_dbops::move_annotations_to_final($this->get_backupid(), $itemname);
1135         }
1136     }
1139 /**
1140  * structure in charge of constructing the files.xml file with all the
1141  * annotated (final) files along the process. At, the same time, and
1142  * using one specialised nested_element, will copy them form moodle storage
1143  * to backup storage
1144  */
1145 class backup_final_files_structure_step extends backup_structure_step {
1147     protected function define_structure() {
1149         // Define elements
1151         $files = new backup_nested_element('files');
1153         $file = new file_nested_element('file', array('id'), array(
1154             'contenthash', 'contextid', 'component', 'filearea', 'itemid',
1155             'filepath', 'filename', 'userid', 'filesize',
1156             'mimetype', 'status', 'timecreated', 'timemodified',
1157             'source', 'author', 'license', 'sortorder'));
1159         // Build the tree
1161         $files->add_child($file);
1163         // Define sources
1165         $file->set_source_sql("SELECT f.*
1166                                  FROM {files} f
1167                                  JOIN {backup_ids_temp} bi ON f.id = bi.itemid
1168                                 WHERE bi.backupid = ?
1169                                   AND bi.itemname = 'filefinal'", array(backup::VAR_BACKUPID));
1171         return $files;
1172     }
1175 /**
1176  * Structure step in charge of creating the main moodle_backup.xml file
1177  * where all the information related to the backup, settings, license and
1178  * other information needed on restore is added*/
1179 class backup_main_structure_step extends backup_structure_step {
1181     protected function define_structure() {
1183         global $CFG;
1185         $info = array();
1187         $info['name'] = $this->get_setting_value('filename');
1188         $info['moodle_version'] = $CFG->version;
1189         $info['moodle_release'] = $CFG->release;
1190         $info['backup_version'] = $CFG->backup_version;
1191         $info['backup_release'] = $CFG->backup_release;
1192         $info['backup_date']    = time();
1193         $info['backup_uniqueid']= $this->get_backupid();
1194         $info['original_wwwroot']=$CFG->wwwroot;
1195         $info['original_site_identifier_hash'] = md5(get_site_identifier());
1196         $info['original_course_id'] = $this->get_courseid();
1197         $info['original_course_contextid'] = get_context_instance(CONTEXT_COURSE, $this->get_courseid())->id;
1199         // Get more information from controller
1200         list($dinfo, $cinfo, $sinfo) = backup_controller_dbops::get_moodle_backup_information($this->get_backupid());
1202         // Define elements
1204         $moodle_backup = new backup_nested_element('moodle_backup');
1206         $information = new backup_nested_element('information', null, array(
1207             'name', 'moodle_version', 'moodle_release', 'backup_version',
1208             'backup_release', 'backup_date', 'original_wwwroot',
1209             'original_site_identifier_hash', 'original_course_id', 'original_course_contextid'));
1211         $details = new backup_nested_element('details');
1213         $detail = new backup_nested_element('detail', array('backup_id'), array(
1214             'type', 'format', 'interactive', 'mode',
1215             'execution', 'executiontime'));
1217         $contents = new backup_nested_element('contents');
1219         $activities = new backup_nested_element('activities');
1221         $activity = new backup_nested_element('activity', null, array(
1222             'moduleid', 'sectionid', 'modulename', 'title',
1223             'directory'));
1225         $sections = new backup_nested_element('sections');
1227         $section = new backup_nested_element('section', null, array(
1228             'sectionid', 'title', 'directory'));
1230         $course = new backup_nested_element('course', null, array(
1231             'courseid', 'title', 'directory'));
1233         $settings = new backup_nested_element('settings');
1235         $setting = new backup_nested_element('setting', null, array(
1236             'level', 'section', 'activity', 'name', 'value'));
1238         // Build the tree
1240         $moodle_backup->add_child($information);
1242         $information->add_child($details);
1243         $details->add_child($detail);
1245         $information->add_child($contents);
1246         if (!empty($cinfo['activities'])) {
1247             $contents->add_child($activities);
1248             $activities->add_child($activity);
1249         }
1250         if (!empty($cinfo['sections'])) {
1251             $contents->add_child($sections);
1252             $sections->add_child($section);
1253         }
1254         if (!empty($cinfo['course'])) {
1255             $contents->add_child($course);
1256         }
1258         $information->add_child($settings);
1259         $settings->add_child($setting);
1262         // Set the sources
1264         $information->set_source_array(array((object)$info));
1266         $detail->set_source_array($dinfo);
1268         $activity->set_source_array($cinfo['activities']);
1270         $section->set_source_array($cinfo['sections']);
1272         $course->set_source_array($cinfo['course']);
1274         $setting->set_source_array($sinfo);
1276         // Prepare some information to be sent to main moodle_backup.xml file
1277         return $moodle_backup;
1278     }
1282 /**
1283  * Execution step that will generate the final zip file with all the contents
1284  */
1285 class backup_zip_contents extends backup_execution_step {
1287     protected function define_execution() {
1289         // Get basepath
1290         $basepath = $this->get_basepath();
1292         // Get the list of files in directory
1293         $filestemp = get_directory_list($basepath, '', false, true, true);
1294         $files = array();
1295         foreach ($filestemp as $file) { // Add zip paths and fs paths to all them
1296             $files[$file] = $basepath . '/' . $file;
1297         }
1299         // Add the log file if exists
1300         $logfilepath = $basepath . '.log';
1301         if (file_exists($logfilepath)) {
1302              $files['moodle_backup.log'] = $logfilepath;
1303         }
1305         // Calculate the zip fullpath (in OS temp area it's always backup.zip)
1306         $zipfile = $basepath . '/backup.zip';
1308         // Get the zip packer
1309         $zippacker = get_file_packer('application/zip');
1311         // Zip files
1312         $zippacker->archive_to_pathname($files, $zipfile);
1313     }
1316 /**
1317  * This step will send the generated backup file to its final destination
1318  */
1319 class backup_store_backup_file extends backup_execution_step {
1321     protected function define_execution() {
1323         // Get basepath
1324         $basepath = $this->get_basepath();
1326         // Calculate the zip fullpath (in OS temp area it's always backup.zip)
1327         $zipfile = $basepath . '/backup.zip';
1329         // Perform storage and return it (TODO: shouldn't be array but proper result object)
1330         return array('backup_destination' => backup_helper::store_backup_file($this->get_backupid(), $zipfile));
1331     }
1335 /**
1336  * This step will search for all the activity (not calculations, categories nor aggregations) grade items
1337  * and put them to the backup_ids tables, to be used later as base to backup them
1338  */
1339 class backup_activity_grade_items_to_ids extends backup_execution_step {
1341     protected function define_execution() {
1343         // Fetch all activity grade items
1344         if ($items = grade_item::fetch_all(array(
1345                          'itemtype' => 'mod', 'itemmodule' => $this->task->get_modulename(),
1346                          'iteminstance' => $this->task->get_activityid(), 'courseid' => $this->task->get_courseid()))) {
1347             // Annotate them in backup_ids
1348             foreach ($items as $item) {
1349                 backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'grade_item', $item->id);
1350             }
1351         }
1352     }
1355 /**
1356  * This step will annotate all the groups belonging to already annotated groupings
1357  */
1358 class backup_annotate_groups_from_groupings extends backup_execution_step {
1360     protected function define_execution() {
1361         global $DB;
1363         // Fetch all the annotated groupings
1364         if ($groupings = $DB->get_records('backup_ids_temp', array(
1365                 'backupid' => $this->get_backupid(), 'itemname' => 'grouping'))) {
1366             foreach ($groupings as $grouping) {
1367                 if ($groups = $DB->get_records('groupings_groups', array(
1368                         'groupingid' => $grouping->itemid))) {
1369                     foreach ($groups as $group) {
1370                         backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'group', $group->groupid);
1371                     }
1372                 }
1373             }
1374         }
1375     }
1378 /**
1379  * This step will annotate all the scales belonging to already annotated outcomes
1380  */
1381 class backup_annotate_scales_from_outcomes extends backup_execution_step {
1383     protected function define_execution() {
1384         global $DB;
1386         // Fetch all the annotated outcomes
1387         if ($outcomes = $DB->get_records('backup_ids_temp', array(
1388                 'backupid' => $this->get_backupid(), 'itemname' => 'outcome'))) {
1389             foreach ($outcomes as $outcome) {
1390                 if ($scale = $DB->get_record('grade_outcomes', array(
1391                         'id' => $outcome->itemid))) {
1392                     // Annotate as scalefinal because it's > 0
1393                     backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'scalefinal', $scale->scaleid);
1394                 }
1395             }
1396         }
1397     }
1400 /**
1401  * This step will generate all the file  annotations for the already
1402  * annotated (final) users. Need to do this here because each user
1403  * has its own context and structure tasks only are able to handle
1404  * one context. Also, this step will guarantee that every user has
1405  * its context created (req for other steps)
1406  */
1407 class backup_annotate_all_user_files extends backup_execution_step {
1409     protected function define_execution() {
1410         global $DB;
1412         // List of fileareas we are going to annotate
1413         $fileareas = array('profile', 'icon');
1415         if ($this->get_setting_value('user_files')) { // private files only if enabled in settings
1416             $fileareas[] = 'private';
1417         }
1419         // Fetch all annotated (final) users
1420         $rs = $DB->get_recordset('backup_ids_temp', array(
1421             'backupid' => $this->get_backupid(), 'itemname' => 'userfinal'));
1422         foreach ($rs as $record) {
1423             $userid = $record->itemid;
1424             $userctxid = get_context_instance(CONTEXT_USER, $userid)->id;
1425             // Proceed with every user filearea
1426             foreach ($fileareas as $filearea) {
1427                 // We don't need to specify itemid ($userid - 5th param) as far as by
1428                 // context we can get all the associated files. See MDL-22092
1429                 backup_structure_dbops::annotate_files($this->get_backupid(), $userctxid, 'user', $filearea, null);
1430             }
1431         }
1432         $rs->close();
1433     }
1436 /**
1437  * structure step in charge of constructing the grades.xml file for all the grade items
1438  * and letters related to one activity
1439  */
1440 class backup_activity_grades_structure_step extends backup_structure_step {
1442     protected function define_structure() {
1444         // To know if we are including userinfo
1445         $userinfo = $this->get_setting_value('userinfo');
1447         // Define each element separated
1449         $book = new backup_nested_element('activity_gradebook');
1451         $items = new backup_nested_element('grade_items');
1453         $item = new backup_nested_element('grade_item', array('id'), array(
1454             'categoryid', 'itemname', 'itemtype', 'itemmodule',
1455             'iteminstance', 'itemnumber', 'iteminfo', 'idnumber',
1456             'calculation', 'gradetype', 'grademax', 'grademin',
1457             'scaleid', 'outcomeid', 'gradepass', 'multfactor',
1458             'plusfactor', 'aggregationcoef', 'sortorder', 'display',
1459             'decimals', 'hidden', 'locked', 'locktime',
1460             'needsupdate', 'timecreated', 'timemodified'));
1462         $grades = new backup_nested_element('grade_grades');
1464         $grade = new backup_nested_element('grade_grade', array('id'), array(
1465             'userid', 'rawgrade', 'rawgrademax', 'rawgrademin',
1466             'rawscaleid', 'usermodified', 'finalgrade', 'hidden',
1467             'locked', 'locktime', 'exported', 'overridden',
1468             'excluded', 'feedback', 'feedbackformat', 'information',
1469             'informationformat', 'timecreated', 'timemodified'));
1471         $letters = new backup_nested_element('grade_letters');
1473         $letter = new backup_nested_element('grade_letter', 'id', array(
1474             'lowerboundary', 'letter'));
1476         // Build the tree
1478         $book->add_child($items);
1479         $items->add_child($item);
1481         $item->add_child($grades);
1482         $grades->add_child($grade);
1484         $book->add_child($letters);
1485         $letters->add_child($letter);
1487         // Define sources
1489         $item->set_source_sql("SELECT gi.*
1490                                FROM {grade_items} gi
1491                                JOIN {backup_ids_temp} bi ON gi.id = bi.itemid
1492                                WHERE bi.backupid = ?
1493                                AND bi.itemname = 'grade_item'", array(backup::VAR_BACKUPID));
1495         // This only happens if we are including user info
1496         if ($userinfo) {
1497             $grade->set_source_table('grade_grades', array('itemid' => backup::VAR_PARENTID));
1498         }
1500         $letter->set_source_table('grade_letters', array('contextid' => backup::VAR_CONTEXTID));
1502         // Annotations
1504         $item->annotate_ids('scalefinal', 'scaleid'); // Straight as scalefinal because it's > 0
1505         $item->annotate_ids('outcome', 'outcomeid');
1507         $grade->annotate_ids('user', 'userid');
1508         $grade->annotate_ids('user', 'usermodified');
1510         // Return the root element (book)
1512         return $book;
1513     }