MDL-21432 backup - handle mnet_remoteusers and support for prechecks
[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         // Annotate scale files (they store files in system context, so pass it instead of default one)
506         $scale->annotate_files('grade', 'scale', 'id', get_context_instance(CONTEXT_SYSTEM)->id);
508         // Return main element (scalesdef)
509         return $scalesdef;
510     }
513 /**
514  * structure step that will generate the outcomes.xml containing the
515  * list of outcomes used along the whole backup process.
516  */
517 class backup_final_outcomes_structure_step extends backup_structure_step {
519     protected function define_structure() {
521         // Define elements
523         $outcomesdef = new backup_nested_element('outcomes_definition');
525         $outcome = new backup_nested_element('outcome', array('id'), array(
526             'courseid', 'userid', 'shortname', 'fullname',
527             'scaleid', 'description', 'descriptionformat', 'timecreated',
528             'timemodified','usermodified'));
530         // Build the tree
532         $outcomesdef->add_child($outcome);
534         // Define sources
536         $outcome->set_source_sql("SELECT o.*
537                                     FROM {grade_outcomes} o
538                                     JOIN {backup_ids_temp} bi ON o.id = bi.itemid
539                                    WHERE bi.backupid = ?
540                                      AND bi.itemname = 'outcomefinal'", array(backup::VAR_BACKUPID));
542         // Return main element (outcomesdef)
543         return $outcomesdef;
544     }
547 /**
548  * structure step in charge of constructing the filters.xml file for all the filters found
549  * in activity
550  */
551 class backup_filters_structure_step extends backup_structure_step {
553     protected function define_structure() {
555         // Define each element separated
557         $filters = new backup_nested_element('filters');
559         $actives = new backup_nested_element('filter_actives');
561         $active = new backup_nested_element('filter_active', null, array('filter', 'active'));
563         $configs = new backup_nested_element('filter_configs');
565         $config = new backup_nested_element('filter_config', null, array('filter', 'name', 'value'));
567         // Build the tree
569         $filters->add_child($actives);
570         $filters->add_child($configs);
572         $actives->add_child($active);
573         $configs->add_child($config);
575         // Define sources
577         list($activearr, $configarr) = filter_get_all_local_settings($this->task->get_contextid());
579         $active->set_source_array($activearr);
580         $config->set_source_array($configarr);
582         // Return the root element (filters)
583         return $filters;
584     }
587 /**
588  * structure step in charge of constructing the comments.xml file for all the comments found
589  * in a given context
590  */
591 class backup_comments_structure_step extends backup_structure_step {
593     protected function define_structure() {
595         // Define each element separated
597         $comments = new backup_nested_element('comments');
599         $comment = new backup_nested_element('comment', array('id'), array(
600             'commentarea', 'itemid', 'content', 'format',
601             'userid', 'timecreated'));
603         // Build the tree
605         $comments->add_child($comment);
607         // Define sources
609         $comment->set_source_table('comments', array('contextid' => backup::VAR_CONTEXTID));
611         // Define id annotations
613         $comment->annotate_ids('user', 'userid');
615         // Return the root element (comments)
616         return $comments;
617     }
620 /**
621  * structure step in charge of constructing the gradebook.xml file for all the gradebook config in the course
622  * NOTE: the backup of the grade items themselves is handled by backup_activity_grades_structure_step
623  */
624 class backup_gradebook_structure_step extends backup_structure_step {
626     /**
627      * We need to decide conditionally, based on dynamic information
628      * about the execution of this step. Only will be executed if all
629      * the module gradeitems have been already included in backup
630      */
631     protected function execute_condition() {
632         return backup_plan_dbops::require_gradebook_backup($this->get_courseid(), $this->get_backupid());
633     }
635     protected function define_structure() {
637         // are we including user info?
638         $userinfo = $this->get_setting_value('users');
640         $gradebook = new backup_nested_element('gradebook');
642         //grade_letters are done in backup_activity_grades_structure_step()
644         //calculated grade items
645         $grade_items = new backup_nested_element('grade_items');
646         $grade_item = new backup_nested_element('grade_item', array('id'), array(
647             'categoryid', 'itemname', 'itemtype', 'itemmodule',
648             'iteminstance', 'itemnumber', 'iteminfo', 'idnumber',
649             'calculation', 'gradetype', 'grademax', 'grademin',
650             'scaleid', 'outcomeid', 'gradepass', 'multfactor',
651             'plusfactor', 'aggregationcoef', 'sortorder', 'display',
652             'decimals', 'hidden', 'locked', 'locktime',
653             'needsupdate', 'timecreated', 'timemodified'));
655         $grade_grades = new backup_nested_element('grade_grades');
656         $grade_grade = new backup_nested_element('grade_grade', array('id'), array(
657             'userid', 'rawgrade', 'rawgrademax', 'rawgrademin',
658             'rawscaleid', 'usermodified', 'finalgrade', 'hidden',
659             'locked', 'locktime', 'exported', 'overridden',
660             'excluded', 'feedback', 'feedbackformat', 'information',
661             'informationformat', 'timecreated', 'timemodified'));
663         //grade_categories
664         $grade_categories = new backup_nested_element('grade_categories');
665         $grade_category   = new backup_nested_element('grade_category', null, array('courseid',
666                 'parent', 'depth', 'path', 'fullname', 'aggregation', 'keephigh',
667                 'dropload', 'aggregateonlygraded', 'aggregateoutcomes', 'aggregatesubcats',
668                 'timecreated', 'timemodified'));
670         $letters = new backup_nested_element('grade_letters');
671         $letter = new backup_nested_element('grade_letter', 'id', array(
672             'lowerboundary', 'letter'));
675         // Build the tree
677         $gradebook->add_child($grade_items);
678         $grade_items->add_child($grade_item);
679         $grade_item->add_child($grade_grades);
680         $grade_grades->add_child($grade_grade);
682         //$grade_item->add_child($grade_scale);
684         $gradebook->add_child($grade_categories);
685         $grade_categories->add_child($grade_category);
687         $gradebook->add_child($letters);
688         $letters->add_child($letter);
690         // Define sources
692         //Include manual, category and the course grade item
693         $grade_items_sql ="SELECT * FROM {grade_items} 
694                            WHERE courseid = :courseid
695                            AND (itemtype='manual' OR itemtype='course' OR itemtype='category')";
696         $grade_items_params = array('courseid'=>backup::VAR_COURSEID);
697         $grade_item->set_source_sql($grade_items_sql, $grade_items_params);
699         if ($userinfo) {
700             $grade_grade->set_source_table('grade_grades', array('itemid' => backup::VAR_PARENTID));
701         }
703         $grade_category_sql = "SELECT gc.*, gi.sortorder
704                                FROM {grade_categories} gc
705                                JOIN {grade_items} gi ON (gi.iteminstance = gc.id)
706                                WHERE gc.courseid = :courseid
707                                AND (gi.itemtype='course' OR gi.itemtype='category')
708                                ORDER BY gc.parent ASC";//need parent categories before their children
709         $grade_category_params = array('courseid'=>backup::VAR_COURSEID);
710         $grade_category->set_source_sql($grade_category_sql, $grade_category_params);
712         $letter->set_source_table('grade_letters', array('contextid' => backup::VAR_CONTEXTID));
714         // Annotations (both as final as far as they are going to be exported in next steps)
715         $grade_item->annotate_ids('scalefinal', 'scaleid'); // Straight as scalefinal because it's > 0
716         $grade_item->annotate_ids('outcomefinal', 'outcomeid');
718         // Return the root element
719         return $gradebook;
720     }
723 /**
724  * structure step in charge if constructing the completion.xml file for all the users completion
725  * information in a given activity
726  */
727 class backup_userscompletion_structure_step extends backup_structure_step {
729     protected function define_structure() {
731         // Define each element separated
733         $completions = new backup_nested_element('completions');
735         $completion = new backup_nested_element('completion', array('id'), array(
736             'userid', 'completionstate', 'viewed', 'timemodified'));
738         // Build the tree
740         $completions->add_child($completion);
742         // Define sources
744         $completion->set_source_table('course_modules_completion', array('coursemoduleid' => backup::VAR_MODID));
746         // Define id annotations
748         $completion->annotate_ids('user', 'userid');
750         // Return the root element (completions)
751         return $completions;
752     }
755 /**
756  * structure step in charge of constructing the main groups.xml file for all the groups and
757  * groupings information already annotated
758  */
759 class backup_groups_structure_step extends backup_structure_step {
761     protected function define_structure() {
763         // To know if we are including users
764         $users = $this->get_setting_value('users');
766         // Define each element separated
768         $groups = new backup_nested_element('groups');
770         $group = new backup_nested_element('group', array('id'), array(
771             'name', 'description', 'descriptionformat', 'enrolmentkey',
772             'picture', 'hidepicture', 'timecreated', 'timemodified'));
774         $members = new backup_nested_element('group_members');
776         $member = new backup_nested_element('group_member', array('id'), array(
777             'userid', 'timeadded'));
779         $groupings = new backup_nested_element('groupings');
781         $grouping = new backup_nested_element('grouping', 'id', array(
782             'name', 'description', 'descriptionformat', 'configdata',
783             'timecreated', 'timemodified'));
785         $groupinggroups = new backup_nested_element('grouping_groups');
787         $groupinggroup = new backup_nested_element('grouping_group', array('id'), array(
788             'groupid', 'timeadded'));
790         // Build the tree
792         $groups->add_child($group);
793         $groups->add_child($groupings);
795         $group->add_child($members);
796         $members->add_child($member);
798         $groupings->add_child($grouping);
799         $grouping->add_child($groupinggroups);
800         $groupinggroups->add_child($groupinggroup);
802         // Define sources
804         $group->set_source_sql("
805             SELECT g.*
806               FROM {groups} g
807               JOIN {backup_ids_temp} bi ON g.id = bi.itemid
808              WHERE bi.backupid = ?
809                AND bi.itemname = 'groupfinal'", array(backup::VAR_BACKUPID));
811         // This only happens if we are including users
812         if ($users) {
813             $member->set_source_table('groups_members', array('groupid' => backup::VAR_PARENTID));
814         }
816         $grouping->set_source_sql("
817             SELECT g.*
818               FROM {groupings} g
819               JOIN {backup_ids_temp} bi ON g.id = bi.itemid
820              WHERE bi.backupid = ?
821                AND bi.itemname = 'groupingfinal'", array(backup::VAR_BACKUPID));
823         $groupinggroup->set_source_table('groupings_groups', array('groupingid' => backup::VAR_PARENTID));
825         // Define id annotations (as final)
827         $member->annotate_ids('userfinal', 'userid');
829         // Define file annotations
831         $group->annotate_files('group', 'description', 'id');
832         $group->annotate_files('group', 'icon', 'id');
834         // Return the root element (groups)
835         return $groups;
836     }
839 /**
840  * structure step in charge of constructing the main users.xml file for all the users already
841  * annotated (final). Includes custom profile fields, preferences, tags, role assignments and
842  * overrides.
843  */
844 class backup_users_structure_step extends backup_structure_step {
846     protected function define_structure() {
847         global $CFG;
849         // To know if we are anonymizing users
850         $anonymize = $this->get_setting_value('anonymize');
851         // To know if we are including role assignments
852         $roleassignments = $this->get_setting_value('role_assignments');
854         // Define each element separated
856         $users = new backup_nested_element('users');
858         // Create the array of user fields by hand, as far as we have various bits to control
859         // anonymize option, password backup, mnethostid...
861         // First, the fields not needing anonymization nor special handling
862         $normalfields = array(
863             'confirmed', 'policyagreed', 'deleted',
864             'lang', 'theme', 'timezone', 'firstaccess',
865             'lastaccess', 'lastlogin', 'currentlogin',
866             'mailformat', 'maildigest', 'maildisplay', 'htmleditor',
867             'ajax', 'autosubscribe', 'trackforums', 'timecreated',
868             'timemodified', 'trustbitmask', 'screenreader');
870         // Then, the fields potentially needing anonymization
871         $anonfields = array(
872             'username', 'idnumber', 'firstname', 'lastname',
873             'email', 'emailstop', 'icq', 'skype',
874             'yahoo', 'aim', 'msn', 'phone1',
875             'phone2', 'institution', 'department', 'address',
876             'city', 'country', 'lastip', 'picture',
877             'url', 'description', 'descriptionformat', 'imagealt', 'auth');
879         // Add anonymized fields to $userfields with custom final element
880         foreach ($anonfields as $field) {
881             if ($anonymize) {
882                 $userfields[] = new anonymizer_final_element($field);
883             } else {
884                 $userfields[] = $field; // No anonymization, normally added
885             }
886         }
888         // mnethosturl requires special handling (custom final element)
889         $userfields[] = new mnethosturl_final_element('mnethosturl');
891         // password added conditionally
892         if (!empty($CFG->includeuserpasswordsinbackup)) {
893             $userfields[] = 'password';
894         }
896         // Merge all the fields
897         $userfields = array_merge($userfields, $normalfields);
899         $user = new backup_nested_element('user', array('id', 'contextid'), $userfields);
901         $customfields = new backup_nested_element('custom_fields');
903         $customfield = new backup_nested_element('custom_field', array('id'), array(
904             'field_name', 'field_type', 'field_data'));
906         $tags = new backup_nested_element('tags');
908         $tag = new backup_nested_element('tag', array('id'), array(
909             'name', 'rawname'));
911         $preferences = new backup_nested_element('preferences');
913         $preference = new backup_nested_element('preference', array('id'), array(
914             'name', 'value'));
916         $roles = new backup_nested_element('roles');
918         $overrides = new backup_nested_element('role_overrides');
920         $override = new backup_nested_element('override', array('id'), array(
921             'roleid', 'capability', 'permission', 'timemodified',
922             'modifierid'));
924         $assignments = new backup_nested_element('role_assignments');
926         $assignment = new backup_nested_element('assignment', array('id'), array(
927             'roleid', 'userid', 'timemodified', 'modifierid', 'component', //TODO: MDL-22793 add itemid here
928             'sortorder'));
930         // Build the tree
932         $users->add_child($user);
934         $user->add_child($customfields);
935         $customfields->add_child($customfield);
937         $user->add_child($tags);
938         $tags->add_child($tag);
940         $user->add_child($preferences);
941         $preferences->add_child($preference);
943         $user->add_child($roles);
945         $roles->add_child($overrides);
946         $roles->add_child($assignments);
948         $overrides->add_child($override);
949         $assignments->add_child($assignment);
951         // Define sources
953         $user->set_source_sql('SELECT u.*, c.id AS contextid, m.wwwroot AS mnethosturl
954                                  FROM {user} u
955                                  JOIN {backup_ids_temp} bi ON bi.itemid = u.id
956                                  JOIN {context} c ON c.instanceid = u.id
957                             LEFT JOIN {mnet_host} m ON m.id = u.mnethostid
958                                 WHERE bi.backupid = ?
959                                   AND bi.itemname = ?
960                                   AND c.contextlevel = ?', array(
961                                       backup_helper::is_sqlparam($this->get_backupid()),
962                                       backup_helper::is_sqlparam('userfinal'),
963                                       backup_helper::is_sqlparam(CONTEXT_USER)));
965         // All the rest on information is only added if we arent
966         // in an anonymized backup
967         if (!$anonymize) {
968             $customfield->set_source_sql('SELECT f.id, f.shortname, f.datatype, d.data
969                                             FROM {user_info_field} f
970                                             JOIN {user_info_data} d ON d.fieldid = f.id
971                                            WHERE d.userid = ?', array(backup::VAR_PARENTID));
973             $customfield->set_source_alias('shortname', 'field_name');
974             $customfield->set_source_alias('datatype',  'field_type');
975             $customfield->set_source_alias('data',      'field_data');
977             $tag->set_source_sql('SELECT t.id, t.name, t.rawname
978                                     FROM {tag} t
979                                     JOIN {tag_instance} ti ON ti.tagid = t.id
980                                    WHERE ti.itemtype = ?
981                                      AND ti.itemid = ?', array(
982                                          backup_helper::is_sqlparam('user'),
983                                          backup::VAR_PARENTID));
985             $preference->set_source_table('user_preferences', array('userid' => backup::VAR_PARENTID));
987             $override->set_source_table('role_capabilities', array('contextid' => '/users/user/contextid'));
989             // Assignments only added if specified
990             if ($roleassignments) {
991                 $assignment->set_source_table('role_assignments', array('contextid' => '/users/user/contextid'));
992             }
994             // Define id annotations (as final)
995             $override->annotate_ids('rolefinal', 'roleid');
996         }
998         // Return root element (users)
999         return $users;
1000     }
1003 /**
1004  * structure step in charge of constructing the block.xml file for one
1005  * given block (instance and positions). If the block has custom DB structure
1006  * that will go to a separate file (different step defined in block class)
1007  */
1008 class backup_block_instance_structure_step extends backup_structure_step {
1010     protected function define_structure() {
1011         global $DB;
1013         // Define each element separated
1015         $block = new backup_nested_element('block', array('id', 'contextid', 'version'), array(
1016             'blockname', 'parentcontextid', 'showinsubcontexts', 'pagetypepattern',
1017             'subpagepattern', 'defaultregion', 'defaultweight', 'configdata'));
1019         $positions = new backup_nested_element('block_positions', null, array(
1020             'contextid', 'pagetype', 'subpage', 'visible',
1021             'region', 'weight'));
1023         // Build the tree
1025         $block->add_child($positions);
1027         // Transform configdata information if needed (process links and friends)
1028         $blockrec = $DB->get_record('block_instances', array('id' => $this->task->get_blockid()));
1029         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
1030             $configdata = (array)unserialize(base64_decode($blockrec->configdata));
1031             foreach ($configdata as $attribute => $value) {
1032                 if (in_array($attribute, $attrstotransform)) {
1033                     $configdata[$attribute] = $this->contenttransformer->process($value);
1034                 }
1035             }
1036             $blockrec->configdata = base64_encode(serialize((object)$configdata));
1037         }
1038         $blockrec->contextid = $this->task->get_contextid();
1039         // Get the version of the block
1040         $blockrec->version = $DB->get_field('block', 'version', array('name' => $this->task->get_blockname()));
1042         // Define sources
1044         $block->set_source_array(array($blockrec));
1046         $positions->set_source_table('block_positions', array('blockinstanceid' => backup::VAR_PARENTID));
1048         // Return the root element (block)
1049         return $block;
1050     }
1053 /**
1054  * structure step in charge of constructing the logs.xml file for all the log records found
1055  * in activity
1056  */
1057 class backup_activity_logs_structure_step extends backup_structure_step {
1059     protected function define_structure() {
1061         // Define each element separated
1063         $logs = new backup_nested_element('logs');
1065         $log = new backup_nested_element('log', array('id'), array(
1066             'time', 'userid', 'ip', 'module',
1067             'action', 'url', 'info'));
1069         // Build the tree
1071         $logs->add_child($log);
1073         // Define sources
1075         $log->set_source_table('log', array('cmid' => backup::VAR_MODID));
1077         // Annotations
1078         // NOTE: We don't annotate users from logs as far as they MUST be
1079         //       always annotated by the activity.
1081         // Return the root element (logs)
1083         return $logs;
1084     }
1087 /**
1088  * structure in charge of constructing the inforef.xml file for all the items we want
1089  * to have referenced there (users, roles, files...)
1090  */
1091 class backup_inforef_structure_step extends backup_structure_step {
1093     protected function define_structure() {
1095         // Items we want to include in the inforef file.
1096         $items = backup_helper::get_inforef_itemnames();
1098         // Build the tree
1100         $inforef = new backup_nested_element('inforef');
1102         // For each item, conditionally, if there are already records, build element
1103         foreach ($items as $itemname) {
1104             if (backup_structure_dbops::annotations_exist($this->get_backupid(), $itemname)) {
1105                 $elementroot = new backup_nested_element($itemname . 'ref');
1106                 $element = new backup_nested_element($itemname, array(), array('id'));
1107                 $inforef->add_child($elementroot);
1108                 $elementroot->add_child($element);
1109                 $element->set_source_sql("
1110                     SELECT itemid AS id
1111                      FROM {backup_ids_temp}
1112                     WHERE backupid = ?
1113                       AND itemname = ?",
1114                    array(backup::VAR_BACKUPID, backup_helper::is_sqlparam($itemname)));
1115             }
1116         }
1118         // We don't annotate anything there, but rely in the next step
1119         // (move_inforef_annotations_to_final) that will change all the
1120         // already saved 'inforref' entries to their 'final' annotations.
1121         return $inforef;
1122     }
1125 /**
1126  * This step will get all the annotations already processed to inforef.xml file and
1127  * transform them into 'final' annotations.
1128  */
1129 class move_inforef_annotations_to_final extends backup_execution_step {
1131     protected function define_execution() {
1133         // Items we want to include in the inforef file
1134         $items = backup_helper::get_inforef_itemnames();
1135         foreach ($items as $itemname) {
1136             // Delegate to dbops
1137             backup_structure_dbops::move_annotations_to_final($this->get_backupid(), $itemname);
1138         }
1139     }
1142 /**
1143  * structure in charge of constructing the files.xml file with all the
1144  * annotated (final) files along the process. At, the same time, and
1145  * using one specialised nested_element, will copy them form moodle storage
1146  * to backup storage
1147  */
1148 class backup_final_files_structure_step extends backup_structure_step {
1150     protected function define_structure() {
1152         // Define elements
1154         $files = new backup_nested_element('files');
1156         $file = new file_nested_element('file', array('id'), array(
1157             'contenthash', 'contextid', 'component', 'filearea', 'itemid',
1158             'filepath', 'filename', 'userid', 'filesize',
1159             'mimetype', 'status', 'timecreated', 'timemodified',
1160             'source', 'author', 'license', 'sortorder'));
1162         // Build the tree
1164         $files->add_child($file);
1166         // Define sources
1168         $file->set_source_sql("SELECT f.*
1169                                  FROM {files} f
1170                                  JOIN {backup_ids_temp} bi ON f.id = bi.itemid
1171                                 WHERE bi.backupid = ?
1172                                   AND bi.itemname = 'filefinal'", array(backup::VAR_BACKUPID));
1174         return $files;
1175     }
1178 /**
1179  * Structure step in charge of creating the main moodle_backup.xml file
1180  * where all the information related to the backup, settings, license and
1181  * other information needed on restore is added*/
1182 class backup_main_structure_step extends backup_structure_step {
1184     protected function define_structure() {
1186         global $CFG;
1188         $info = array();
1190         $info['name'] = $this->get_setting_value('filename');
1191         $info['moodle_version'] = $CFG->version;
1192         $info['moodle_release'] = $CFG->release;
1193         $info['backup_version'] = $CFG->backup_version;
1194         $info['backup_release'] = $CFG->backup_release;
1195         $info['backup_date']    = time();
1196         $info['backup_uniqueid']= $this->get_backupid();
1197         $info['mnet_remoteusers']=backup_controller_dbops::backup_includes_mnet_remote_users($this->get_backupid());
1198         $info['original_wwwroot']=$CFG->wwwroot;
1199         $info['original_site_identifier_hash'] = md5(get_site_identifier());
1200         $info['original_course_id'] = $this->get_courseid();
1201         $info['original_course_contextid'] = get_context_instance(CONTEXT_COURSE, $this->get_courseid())->id;
1202         $info['original_system_contextid'] = get_context_instance(CONTEXT_SYSTEM)->id;
1204         // Get more information from controller
1205         list($dinfo, $cinfo, $sinfo) = backup_controller_dbops::get_moodle_backup_information($this->get_backupid());
1207         // Define elements
1209         $moodle_backup = new backup_nested_element('moodle_backup');
1211         $information = new backup_nested_element('information', null, array(
1212             'name', 'moodle_version', 'moodle_release', 'backup_version',
1213             'backup_release', 'backup_date', 'mnet_remoteusers', 'original_wwwroot',
1214             'original_site_identifier_hash', 'original_course_id', 'original_course_contextid', 'original_system_contextid'));
1216         $details = new backup_nested_element('details');
1218         $detail = new backup_nested_element('detail', array('backup_id'), array(
1219             'type', 'format', 'interactive', 'mode',
1220             'execution', 'executiontime'));
1222         $contents = new backup_nested_element('contents');
1224         $activities = new backup_nested_element('activities');
1226         $activity = new backup_nested_element('activity', null, array(
1227             'moduleid', 'sectionid', 'modulename', 'title',
1228             'directory'));
1230         $sections = new backup_nested_element('sections');
1232         $section = new backup_nested_element('section', null, array(
1233             'sectionid', 'title', 'directory'));
1235         $course = new backup_nested_element('course', null, array(
1236             'courseid', 'title', 'directory'));
1238         $settings = new backup_nested_element('settings');
1240         $setting = new backup_nested_element('setting', null, array(
1241             'level', 'section', 'activity', 'name', 'value'));
1243         // Build the tree
1245         $moodle_backup->add_child($information);
1247         $information->add_child($details);
1248         $details->add_child($detail);
1250         $information->add_child($contents);
1251         if (!empty($cinfo['activities'])) {
1252             $contents->add_child($activities);
1253             $activities->add_child($activity);
1254         }
1255         if (!empty($cinfo['sections'])) {
1256             $contents->add_child($sections);
1257             $sections->add_child($section);
1258         }
1259         if (!empty($cinfo['course'])) {
1260             $contents->add_child($course);
1261         }
1263         $information->add_child($settings);
1264         $settings->add_child($setting);
1267         // Set the sources
1269         $information->set_source_array(array((object)$info));
1271         $detail->set_source_array($dinfo);
1273         $activity->set_source_array($cinfo['activities']);
1275         $section->set_source_array($cinfo['sections']);
1277         $course->set_source_array($cinfo['course']);
1279         $setting->set_source_array($sinfo);
1281         // Prepare some information to be sent to main moodle_backup.xml file
1282         return $moodle_backup;
1283     }
1287 /**
1288  * Execution step that will generate the final zip file with all the contents
1289  */
1290 class backup_zip_contents extends backup_execution_step {
1292     protected function define_execution() {
1294         // Get basepath
1295         $basepath = $this->get_basepath();
1297         // Get the list of files in directory
1298         $filestemp = get_directory_list($basepath, '', false, true, true);
1299         $files = array();
1300         foreach ($filestemp as $file) { // Add zip paths and fs paths to all them
1301             $files[$file] = $basepath . '/' . $file;
1302         }
1304         // Add the log file if exists
1305         $logfilepath = $basepath . '.log';
1306         if (file_exists($logfilepath)) {
1307              $files['moodle_backup.log'] = $logfilepath;
1308         }
1310         // Calculate the zip fullpath (in OS temp area it's always backup.zip)
1311         $zipfile = $basepath . '/backup.zip';
1313         // Get the zip packer
1314         $zippacker = get_file_packer('application/zip');
1316         // Zip files
1317         $zippacker->archive_to_pathname($files, $zipfile);
1318     }
1321 /**
1322  * This step will send the generated backup file to its final destination
1323  */
1324 class backup_store_backup_file extends backup_execution_step {
1326     protected function define_execution() {
1328         // Get basepath
1329         $basepath = $this->get_basepath();
1331         // Calculate the zip fullpath (in OS temp area it's always backup.zip)
1332         $zipfile = $basepath . '/backup.zip';
1334         // Perform storage and return it (TODO: shouldn't be array but proper result object)
1335         return array('backup_destination' => backup_helper::store_backup_file($this->get_backupid(), $zipfile));
1336     }
1340 /**
1341  * This step will search for all the activity (not calculations, categories nor aggregations) grade items
1342  * and put them to the backup_ids tables, to be used later as base to backup them
1343  */
1344 class backup_activity_grade_items_to_ids extends backup_execution_step {
1346     protected function define_execution() {
1348         // Fetch all activity grade items
1349         if ($items = grade_item::fetch_all(array(
1350                          'itemtype' => 'mod', 'itemmodule' => $this->task->get_modulename(),
1351                          'iteminstance' => $this->task->get_activityid(), 'courseid' => $this->task->get_courseid()))) {
1352             // Annotate them in backup_ids
1353             foreach ($items as $item) {
1354                 backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'grade_item', $item->id);
1355             }
1356         }
1357     }
1360 /**
1361  * This step will annotate all the groups belonging to already annotated groupings
1362  */
1363 class backup_annotate_groups_from_groupings extends backup_execution_step {
1365     protected function define_execution() {
1366         global $DB;
1368         // Fetch all the annotated groupings
1369         if ($groupings = $DB->get_records('backup_ids_temp', array(
1370                 'backupid' => $this->get_backupid(), 'itemname' => 'grouping'))) {
1371             foreach ($groupings as $grouping) {
1372                 if ($groups = $DB->get_records('groupings_groups', array(
1373                         'groupingid' => $grouping->itemid))) {
1374                     foreach ($groups as $group) {
1375                         backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'group', $group->groupid);
1376                     }
1377                 }
1378             }
1379         }
1380     }
1383 /**
1384  * This step will annotate all the scales belonging to already annotated outcomes
1385  */
1386 class backup_annotate_scales_from_outcomes extends backup_execution_step {
1388     protected function define_execution() {
1389         global $DB;
1391         // Fetch all the annotated outcomes
1392         if ($outcomes = $DB->get_records('backup_ids_temp', array(
1393                 'backupid' => $this->get_backupid(), 'itemname' => 'outcome'))) {
1394             foreach ($outcomes as $outcome) {
1395                 if ($scale = $DB->get_record('grade_outcomes', array(
1396                         'id' => $outcome->itemid))) {
1397                     // Annotate as scalefinal because it's > 0
1398                     backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'scalefinal', $scale->scaleid);
1399                 }
1400             }
1401         }
1402     }
1405 /**
1406  * This step will generate all the file  annotations for the already
1407  * annotated (final) users. Need to do this here because each user
1408  * has its own context and structure tasks only are able to handle
1409  * one context. Also, this step will guarantee that every user has
1410  * its context created (req for other steps)
1411  */
1412 class backup_annotate_all_user_files extends backup_execution_step {
1414     protected function define_execution() {
1415         global $DB;
1417         // List of fileareas we are going to annotate
1418         $fileareas = array('profile', 'icon');
1420         if ($this->get_setting_value('user_files')) { // private files only if enabled in settings
1421             $fileareas[] = 'private';
1422         }
1424         // Fetch all annotated (final) users
1425         $rs = $DB->get_recordset('backup_ids_temp', array(
1426             'backupid' => $this->get_backupid(), 'itemname' => 'userfinal'));
1427         foreach ($rs as $record) {
1428             $userid = $record->itemid;
1429             $userctxid = get_context_instance(CONTEXT_USER, $userid)->id;
1430             // Proceed with every user filearea
1431             foreach ($fileareas as $filearea) {
1432                 // We don't need to specify itemid ($userid - 5th param) as far as by
1433                 // context we can get all the associated files. See MDL-22092
1434                 backup_structure_dbops::annotate_files($this->get_backupid(), $userctxid, 'user', $filearea, null);
1435             }
1436         }
1437         $rs->close();
1438     }
1441 /**
1442  * structure step in charge of constructing the grades.xml file for all the grade items
1443  * and letters related to one activity
1444  */
1445 class backup_activity_grades_structure_step extends backup_structure_step {
1447     protected function define_structure() {
1449         // To know if we are including userinfo
1450         $userinfo = $this->get_setting_value('userinfo');
1452         // Define each element separated
1454         $book = new backup_nested_element('activity_gradebook');
1456         $items = new backup_nested_element('grade_items');
1458         $item = new backup_nested_element('grade_item', array('id'), array(
1459             'categoryid', 'itemname', 'itemtype', 'itemmodule',
1460             'iteminstance', 'itemnumber', 'iteminfo', 'idnumber',
1461             'calculation', 'gradetype', 'grademax', 'grademin',
1462             'scaleid', 'outcomeid', 'gradepass', 'multfactor',
1463             'plusfactor', 'aggregationcoef', 'sortorder', 'display',
1464             'decimals', 'hidden', 'locked', 'locktime',
1465             'needsupdate', 'timecreated', 'timemodified'));
1467         $grades = new backup_nested_element('grade_grades');
1469         $grade = new backup_nested_element('grade_grade', array('id'), array(
1470             'userid', 'rawgrade', 'rawgrademax', 'rawgrademin',
1471             'rawscaleid', 'usermodified', 'finalgrade', 'hidden',
1472             'locked', 'locktime', 'exported', 'overridden',
1473             'excluded', 'feedback', 'feedbackformat', 'information',
1474             'informationformat', 'timecreated', 'timemodified'));
1476         $letters = new backup_nested_element('grade_letters');
1478         $letter = new backup_nested_element('grade_letter', 'id', array(
1479             'lowerboundary', 'letter'));
1481         // Build the tree
1483         $book->add_child($items);
1484         $items->add_child($item);
1486         $item->add_child($grades);
1487         $grades->add_child($grade);
1489         $book->add_child($letters);
1490         $letters->add_child($letter);
1492         // Define sources
1494         $item->set_source_sql("SELECT gi.*
1495                                FROM {grade_items} gi
1496                                JOIN {backup_ids_temp} bi ON gi.id = bi.itemid
1497                                WHERE bi.backupid = ?
1498                                AND bi.itemname = 'grade_item'", array(backup::VAR_BACKUPID));
1500         // This only happens if we are including user info
1501         if ($userinfo) {
1502             $grade->set_source_table('grade_grades', array('itemid' => backup::VAR_PARENTID));
1503         }
1505         $letter->set_source_table('grade_letters', array('contextid' => backup::VAR_CONTEXTID));
1507         // Annotations
1509         $item->annotate_ids('scalefinal', 'scaleid'); // Straight as scalefinal because it's > 0
1510         $item->annotate_ids('outcome', 'outcomeid');
1512         $grade->annotate_ids('user', 'userid');
1513         $grade->annotate_ids('user', 'usermodified');
1515         // Return the root element (book)
1517         return $book;
1518     }