9c2ef17d474e2e12a880dfb2a3dd41dca3aabe78
[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 $skipcleaningtempdir = false;
54     protected function define_execution() {
55         global $CFG;
57         backup_controller_dbops::drop_backup_ids_temp_table($this->get_backupid()); // Drop ids temp table
58         backup_helper::delete_old_backup_dirs(time() - (4 * 60 * 60));              // Delete > 4 hours temp dirs
59         // Delete temp dir conditionally:
60         // 1) If $CFG->keeptempdirectoriesonbackup is not enabled
61         // 2) If backup temp dir deletion has been marked to be avoided
62         if (empty($CFG->keeptempdirectoriesonbackup) && !$this->skipcleaningtempdir) {
63             backup_helper::delete_backup_dir($this->get_backupid()); // Empty backup dir
64         }
65     }
67     public function skip_cleaning_temp_dir($skip) {
68         $this->skipcleaningtempdir = $skip;
69     }
70 }
72 /**
73  * Create the directory where all the task (activity/block...) information will be stored
74  */
75 class create_taskbasepath_directory extends backup_execution_step {
77     protected function define_execution() {
78         global $CFG;
79         $basepath = $this->task->get_taskbasepath();
80         if (!check_dir_exists($basepath, true, true)) {
81             throw new backup_step_exception('cannot_create_taskbasepath_directory', $basepath);
82         }
83     }
84 }
86 /**
87  * Abstract structure step, parent of all the activity structure steps. Used to wrap the
88  * activity structure definition within the main <activity ...> tag. Also provides
89  * subplugin support for activities (that must be properly declared)
90  */
91 abstract class backup_activity_structure_step extends backup_structure_step {
93     /**
94      * Add subplugin structure to any element in the activity backup tree
95      *
96      * @param string $subplugintype type of subplugin as defined in activity db/subplugins.php
97      * @param backup_nested_element $element element in the activity backup tree that
98      *                                       we are going to add subplugin information to
99      * @param bool $multiple to define if multiple subplugins can produce information
100      *                       for each instance of $element (true) or no (false)
101      */
102     protected function add_subplugin_structure($subplugintype, $element, $multiple) {
104         global $CFG;
106         // Check the requested subplugintype is a valid one
107         $subpluginsfile = $CFG->dirroot . '/mod/' . $this->task->get_modulename() . '/db/subplugins.php';
108         if (!file_exists($subpluginsfile)) {
109              throw new backup_step_exception('activity_missing_subplugins_php_file', $this->task->get_modulename());
110         }
111         include($subpluginsfile);
112         if (!array_key_exists($subplugintype, $subplugins)) {
113              throw new backup_step_exception('incorrect_subplugin_type', $subplugintype);
114         }
116         // Arrived here, subplugin is correct, let's create the optigroup
117         $optigroupname = $subplugintype . '_' . $element->get_name() . '_subplugin';
118         $optigroup = new backup_optigroup($optigroupname, null, $multiple);
119         $element->add_child($optigroup); // Add optigroup to stay connected since beginning
121         // Get all the optigroup_elements, looking across all the subplugin dirs
122         $subpluginsdirs = get_plugin_list($subplugintype);
123         foreach ($subpluginsdirs as $name => $subpluginsdir) {
124             $classname = 'backup_' . $subplugintype . '_' . $name . '_subplugin';
125             $backupfile = $subpluginsdir . '/backup/moodle2/' . $classname . '.class.php';
126             if (file_exists($backupfile)) {
127                 require_once($backupfile);
128                 $backupsubplugin = new $classname($subplugintype, $name, $optigroup, $this);
129                 // Add subplugin returned structure to optigroup
130                 $backupsubplugin->define_subplugin_structure($element->get_name());
131             }
132         }
133     }
135     /**
136      * As far as activity backup steps are implementing backup_subplugin stuff, they need to
137      * have the parent task available for wrapping purposes (get course/context....)
138      */
139     public function get_task() {
140         return $this->task;
141     }
143     /**
144      * Wraps any activity backup structure within the common 'activity' element
145      * that will include common to all activities information like id, context...
146      */
147     protected function prepare_activity_structure($activitystructure) {
149         // Create the wrap element
150         $activity = new backup_nested_element('activity', array('id', 'moduleid', 'modulename', 'contextid'), null);
152         // Build the tree
153         $activity->add_child($activitystructure);
155         // Set the source
156         $activityarr = array((object)array(
157             'id'         => $this->task->get_activityid(),
158             'moduleid'   => $this->task->get_moduleid(),
159             'modulename' => $this->task->get_modulename(),
160             'contextid'  => $this->task->get_contextid()));
162         $activity->set_source_array($activityarr);
164         // Return the root element (activity)
165         return $activity;
166     }
169 /**
170  * Abstract structure step, to be used by all the activities using core questions stuff
171  * (namely quiz module), supporting question plugins, states and sessions
172  */
173 abstract class backup_questions_activity_structure_step extends backup_activity_structure_step {
175     /**
176      * Attach to $element (usually attempts) the needed backup structures
177      * for question_usages and all the associated data.
178      */
179     protected function add_question_usages($element, $usageidname) {
180         global $CFG;
181         require_once($CFG->dirroot . '/question/engine/lib.php');
183         // Check $element is one nested_backup_element
184         if (! $element instanceof backup_nested_element) {
185             throw new backup_step_exception('question_states_bad_parent_element', $element);
186         }
187         if (! $element->get_final_element($usageidname)) {
188             throw new backup_step_exception('question_states_bad_question_attempt_element', $usageidname);
189         }
191         $quba = new backup_nested_element('question_usage', array('id'),
192                 array('component', 'preferredbehaviour'));
194         $qas = new backup_nested_element('question_attempts');
195         $qa = new backup_nested_element('question_attempt', array('id'), array(
196                 'slot', 'behaviour', 'questionid', 'maxmark', 'minfraction',
197                 'flagged', 'questionsummary', 'rightanswer', 'responsesummary',
198                 'timemodified'));
200         $steps = new backup_nested_element('steps');
201         $step = new backup_nested_element('step', array('id'), array(
202                 'sequencenumber', 'state', 'fraction', 'timecreated', 'userid'));
204         $response = new backup_nested_element('response');
205         $variable = new backup_nested_element('variable', null,  array('name', 'value'));
207         // Build the tree
208         $element->add_child($quba);
209         $quba->add_child($qas);
210         $qas->add_child($qa);
211         $qa->add_child($steps);
212         $steps->add_child($step);
213         $step->add_child($response);
214         $response->add_child($variable);
216         // Set the sources
217         $quba->set_source_table('question_usages',
218                 array('id'                => '../' . $usageidname));
219         $qa->set_source_sql('
220                 SELECT *
221                 FROM {question_attempts}
222                 WHERE questionusageid = :questionusageid
223                 ORDER BY slot',
224                 array('questionusageid'   => backup::VAR_PARENTID));
225         $step->set_source_sql('
226                 SELECT *
227                 FROM {question_attempt_steps}
228                 WHERE questionattemptid = :questionattemptid
229                 ORDER BY sequencenumber',
230                 array('questionattemptid' => backup::VAR_PARENTID));
231         $variable->set_source_table('question_attempt_step_data',
232                 array('attemptstepid'     => backup::VAR_PARENTID));
234         // Annotate ids
235         $qa->annotate_ids('question', 'questionid');
236         $step->annotate_ids('user', 'userid');
238         // Annotate files
239         $fileareas = question_engine::get_all_response_file_areas();
240         foreach ($fileareas as $filearea) {
241             $step->annotate_files('question', $filearea, 'id');
242         }
243     }
247 /**
248  * backup structure step in charge of calculating the categories to be
249  * included in backup, based in the context being backuped (module/course)
250  * and the already annotated questions present in backup_ids_temp
251  */
252 class backup_calculate_question_categories extends backup_execution_step {
254     protected function define_execution() {
255         backup_question_dbops::calculate_question_categories($this->get_backupid(), $this->task->get_contextid());
256     }
259 /**
260  * backup structure step in charge of deleting all the questions annotated
261  * in the backup_ids_temp table
262  */
263 class backup_delete_temp_questions extends backup_execution_step {
265     protected function define_execution() {
266         backup_question_dbops::delete_temp_questions($this->get_backupid());
267     }
270 /**
271  * Abstract structure step, parent of all the block structure steps. Used to wrap the
272  * block structure definition within the main <block ...> tag
273  */
274 abstract class backup_block_structure_step extends backup_structure_step {
276     protected function prepare_block_structure($blockstructure) {
278         // Create the wrap element
279         $block = new backup_nested_element('block', array('id', 'blockname', 'contextid'), null);
281         // Build the tree
282         $block->add_child($blockstructure);
284         // Set the source
285         $blockarr = array((object)array(
286             'id'         => $this->task->get_blockid(),
287             'blockname'  => $this->task->get_blockname(),
288             'contextid'  => $this->task->get_contextid()));
290         $block->set_source_array($blockarr);
292         // Return the root element (block)
293         return $block;
294     }
297 /**
298  * structure step that will generate the module.xml file for the activity,
299  * accumulating various information about the activity, annotating groupings
300  * and completion/avail conf
301  */
302 class backup_module_structure_step extends backup_structure_step {
304     protected function define_structure() {
306         // Define each element separated
308         $module = new backup_nested_element('module', array('id', 'version'), array(
309             'modulename', 'sectionid', 'sectionnumber', 'idnumber',
310             'added', 'score', 'indent', 'visible',
311             'visibleold', 'groupmode', 'groupingid', 'groupmembersonly',
312             'completion', 'completiongradeitemnumber', 'completionview', 'completionexpected',
313             'availablefrom', 'availableuntil', 'showavailability', 'showdescription'));
315         $availinfo = new backup_nested_element('availability_info');
316         $availability = new backup_nested_element('availability', array('id'), array(
317             'sourcecmid', 'requiredcompletion', 'gradeitemid', 'grademin', 'grademax'));
319         // attach format plugin structure to $module element, only one allowed
320         $this->add_plugin_structure('format', $module, false);
322         // attach plagiarism plugin structure to $module element, there can be potentially
323         // many plagiarism plugins storing information about this course
324         $this->add_plugin_structure('plagiarism', $module, true);
326         // Define the tree
327         $module->add_child($availinfo);
328         $availinfo->add_child($availability);
330         // Set the sources
332         $module->set_source_sql('
333             SELECT cm.*, m.version, m.name AS modulename, s.id AS sectionid, s.section AS sectionnumber
334               FROM {course_modules} cm
335               JOIN {modules} m ON m.id = cm.module
336               JOIN {course_sections} s ON s.id = cm.section
337              WHERE cm.id = ?', array(backup::VAR_MODID));
339         $availability->set_source_table('course_modules_availability', array('coursemoduleid' => backup::VAR_MODID));
341         // Define annotations
342         $module->annotate_ids('grouping', 'groupingid');
344         // Return the root element ($module)
345         return $module;
346     }
349 /**
350  * structure step that will generate the section.xml file for the section
351  * annotating files
352  */
353 class backup_section_structure_step extends backup_structure_step {
355     protected function define_structure() {
357         // Define each element separated
359         $section = new backup_nested_element('section', array('id'), array(
360             'number', 'name', 'summary', 'summaryformat', 'sequence', 'visible'));
362         // attach format plugin structure to $section element, only one allowed
363         $this->add_plugin_structure('format', $section, false);
365         // Define sources
367         $section->set_source_table('course_sections', array('id' => backup::VAR_SECTIONID));
369         // Aliases
370         $section->set_source_alias('section', 'number');
372         // Set annotations
373         $section->annotate_files('course', 'section', 'id');
375         return $section;
376     }
379 /**
380  * structure step that will generate the course.xml file for the course, including
381  * course category reference, tags, modules restriction information
382  * and some annotations (files & groupings)
383  */
384 class backup_course_structure_step extends backup_structure_step {
386     protected function define_structure() {
387         global $DB;
389         // Define each element separated
391         $course = new backup_nested_element('course', array('id', 'contextid'), array(
392             'shortname', 'fullname', 'idnumber',
393             'summary', 'summaryformat', 'format', 'showgrades',
394             'newsitems', 'startdate', 'numsections',
395             'marker', 'maxbytes', 'legacyfiles', 'showreports',
396             'visible', 'hiddensections', 'groupmode', 'groupmodeforce',
397             'defaultgroupingid', 'lang', 'theme',
398             'timecreated', 'timemodified',
399             'requested', 'restrictmodules',
400             'enablecompletion', 'completionstartonenrol', 'completionnotify'));
402         $category = new backup_nested_element('category', array('id'), array(
403             'name', 'description'));
405         $tags = new backup_nested_element('tags');
407         $tag = new backup_nested_element('tag', array('id'), array(
408             'name', 'rawname'));
410         $allowedmodules = new backup_nested_element('allowed_modules');
412         $module = new backup_nested_element('module', array(), array('modulename'));
414         // attach format plugin structure to $course element, only one allowed
415         $this->add_plugin_structure('format', $course, false);
417         // attach theme plugin structure to $course element; multiple themes can
418         // save course data (in case of user theme, legacy theme, etc)
419         $this->add_plugin_structure('theme', $course, true);
421         // attach general report plugin structure to $course element; multiple
422         // reports can save course data if required
423         $this->add_plugin_structure('report', $course, true);
425         // attach course report plugin structure to $course element; multiple
426         // course reports can save course data if required
427         $this->add_plugin_structure('coursereport', $course, true);
429         // attach plagiarism plugin structure to $course element, there can be potentially
430         // many plagiarism plugins storing information about this course
431         $this->add_plugin_structure('plagiarism', $course, true);
433         // Build the tree
435         $course->add_child($category);
437         $course->add_child($tags);
438         $tags->add_child($tag);
440         $course->add_child($allowedmodules);
441         $allowedmodules->add_child($module);
443         // Set the sources
445         $courserec = $DB->get_record('course', array('id' => $this->task->get_courseid()));
446         $courserec->contextid = $this->task->get_contextid();
448         $course->set_source_array(array($courserec));
450         $categoryrec = $DB->get_record('course_categories', array('id' => $courserec->category));
452         $category->set_source_array(array($categoryrec));
454         $tag->set_source_sql('SELECT t.id, t.name, t.rawname
455                                 FROM {tag} t
456                                 JOIN {tag_instance} ti ON ti.tagid = t.id
457                                WHERE ti.itemtype = ?
458                                  AND ti.itemid = ?', array(
459                                      backup_helper::is_sqlparam('course'),
460                                      backup::VAR_PARENTID));
462         $module->set_source_sql('SELECT m.name AS modulename
463                                    FROM {modules} m
464                                    JOIN {course_allowed_modules} cam ON m.id = cam.module
465                                   WHERE course = ?', array(backup::VAR_COURSEID));
467         // Some annotations
469         $course->annotate_ids('grouping', 'defaultgroupingid');
471         $course->annotate_files('course', 'summary', null);
472         $course->annotate_files('course', 'legacy', null);
474         // Return root element ($course)
476         return $course;
477     }
480 /**
481  * structure step that will generate the enrolments.xml file for the given course
482  */
483 class backup_enrolments_structure_step extends backup_structure_step {
485     protected function define_structure() {
487         // To know if we are including users
488         $users = $this->get_setting_value('users');
490         // Define each element separated
492         $enrolments = new backup_nested_element('enrolments');
494         $enrols = new backup_nested_element('enrols');
496         $enrol = new backup_nested_element('enrol', array('id'), array(
497             'enrol', 'status', 'sortorder', 'name', 'enrolperiod', 'enrolstartdate',
498             'enrolenddate', 'expirynotify', 'expirytreshold', 'notifyall',
499             'password', 'cost', 'currency', 'roleid', 'customint1', 'customint2', 'customint3',
500             'customint4', 'customchar1', 'customchar2', 'customdec1', 'customdec2',
501             'customtext1', 'customtext2', 'timecreated', 'timemodified'));
503         $userenrolments = new backup_nested_element('user_enrolments');
505         $enrolment = new backup_nested_element('enrolment', array('id'), array(
506             'status', 'userid', 'timestart', 'timeend', 'modifierid',
507             'timemodified'));
509         // Build the tree
510         $enrolments->add_child($enrols);
511         $enrols->add_child($enrol);
512         $enrol->add_child($userenrolments);
513         $userenrolments->add_child($enrolment);
515         // Define sources
517         $enrol->set_source_table('enrol', array('courseid' => backup::VAR_COURSEID));
519         // User enrolments only added only if users included
520         if ($users) {
521             $enrolment->set_source_table('user_enrolments', array('enrolid' => backup::VAR_PARENTID));
522             $enrolment->annotate_ids('user', 'userid');
523         }
525         $enrol->annotate_ids('role', 'roleid');
527         //TODO: let plugins annotate custom fields too and add more children
529         return $enrolments;
530     }
533 /**
534  * structure step that will generate the roles.xml file for the given context, observing
535  * the role_assignments setting to know if that part needs to be included
536  */
537 class backup_roles_structure_step extends backup_structure_step {
539     protected function define_structure() {
541         // To know if we are including role assignments
542         $roleassignments = $this->get_setting_value('role_assignments');
544         // Define each element separated
546         $roles = new backup_nested_element('roles');
548         $overrides = new backup_nested_element('role_overrides');
550         $override = new backup_nested_element('override', array('id'), array(
551             'roleid', 'capability', 'permission', 'timemodified',
552             'modifierid'));
554         $assignments = new backup_nested_element('role_assignments');
556         $assignment = new backup_nested_element('assignment', array('id'), array(
557             'roleid', 'userid', 'timemodified', 'modifierid', 'component', 'itemid',
558             'sortorder'));
560         // Build the tree
561         $roles->add_child($overrides);
562         $roles->add_child($assignments);
564         $overrides->add_child($override);
565         $assignments->add_child($assignment);
567         // Define sources
569         $override->set_source_table('role_capabilities', array('contextid' => backup::VAR_CONTEXTID));
571         // Assignments only added if specified
572         if ($roleassignments) {
573             $assignment->set_source_table('role_assignments', array('contextid' => backup::VAR_CONTEXTID));
574         }
576         // Define id annotations
577         $override->annotate_ids('role', 'roleid');
579         $assignment->annotate_ids('role', 'roleid');
581         $assignment->annotate_ids('user', 'userid');
583         //TODO: how do we annotate the itemid? the meaning depends on the content of component table (skodak)
585         return $roles;
586     }
589 /**
590  * structure step that will generate the roles.xml containing the
591  * list of roles used along the whole backup process. Just raw
592  * list of used roles from role table
593  */
594 class backup_final_roles_structure_step extends backup_structure_step {
596     protected function define_structure() {
598         // Define elements
600         $rolesdef = new backup_nested_element('roles_definition');
602         $role = new backup_nested_element('role', array('id'), array(
603             'name', 'shortname', 'nameincourse', 'description',
604             'sortorder', 'archetype'));
606         // Build the tree
608         $rolesdef->add_child($role);
610         // Define sources
612         $role->set_source_sql("SELECT r.*, rn.name AS nameincourse
613                                  FROM {role} r
614                                  JOIN {backup_ids_temp} bi ON r.id = bi.itemid
615                             LEFT JOIN {role_names} rn ON r.id = rn.roleid AND rn.contextid = ?
616                                 WHERE bi.backupid = ?
617                                   AND bi.itemname = 'rolefinal'", array(backup::VAR_CONTEXTID, backup::VAR_BACKUPID));
619         // Return main element (rolesdef)
620         return $rolesdef;
621     }
624 /**
625  * structure step that will generate the scales.xml containing the
626  * list of scales used along the whole backup process.
627  */
628 class backup_final_scales_structure_step extends backup_structure_step {
630     protected function define_structure() {
632         // Define elements
634         $scalesdef = new backup_nested_element('scales_definition');
636         $scale = new backup_nested_element('scale', array('id'), array(
637             'courseid', 'userid', 'name', 'scale',
638             'description', 'descriptionformat', 'timemodified'));
640         // Build the tree
642         $scalesdef->add_child($scale);
644         // Define sources
646         $scale->set_source_sql("SELECT s.*
647                                   FROM {scale} s
648                                   JOIN {backup_ids_temp} bi ON s.id = bi.itemid
649                                  WHERE bi.backupid = ?
650                                    AND bi.itemname = 'scalefinal'", array(backup::VAR_BACKUPID));
652         // Annotate scale files (they store files in system context, so pass it instead of default one)
653         $scale->annotate_files('grade', 'scale', 'id', get_context_instance(CONTEXT_SYSTEM)->id);
655         // Return main element (scalesdef)
656         return $scalesdef;
657     }
660 /**
661  * structure step that will generate the outcomes.xml containing the
662  * list of outcomes used along the whole backup process.
663  */
664 class backup_final_outcomes_structure_step extends backup_structure_step {
666     protected function define_structure() {
668         // Define elements
670         $outcomesdef = new backup_nested_element('outcomes_definition');
672         $outcome = new backup_nested_element('outcome', array('id'), array(
673             'courseid', 'userid', 'shortname', 'fullname',
674             'scaleid', 'description', 'descriptionformat', 'timecreated',
675             'timemodified','usermodified'));
677         // Build the tree
679         $outcomesdef->add_child($outcome);
681         // Define sources
683         $outcome->set_source_sql("SELECT o.*
684                                     FROM {grade_outcomes} o
685                                     JOIN {backup_ids_temp} bi ON o.id = bi.itemid
686                                    WHERE bi.backupid = ?
687                                      AND bi.itemname = 'outcomefinal'", array(backup::VAR_BACKUPID));
689         // Annotate outcome files (they store files in system context, so pass it instead of default one)
690         $outcome->annotate_files('grade', 'outcome', 'id', get_context_instance(CONTEXT_SYSTEM)->id);
692         // Return main element (outcomesdef)
693         return $outcomesdef;
694     }
697 /**
698  * structure step in charge of constructing the filters.xml file for all the filters found
699  * in activity
700  */
701 class backup_filters_structure_step extends backup_structure_step {
703     protected function define_structure() {
705         // Define each element separated
707         $filters = new backup_nested_element('filters');
709         $actives = new backup_nested_element('filter_actives');
711         $active = new backup_nested_element('filter_active', null, array('filter', 'active'));
713         $configs = new backup_nested_element('filter_configs');
715         $config = new backup_nested_element('filter_config', null, array('filter', 'name', 'value'));
717         // Build the tree
719         $filters->add_child($actives);
720         $filters->add_child($configs);
722         $actives->add_child($active);
723         $configs->add_child($config);
725         // Define sources
727         list($activearr, $configarr) = filter_get_all_local_settings($this->task->get_contextid());
729         $active->set_source_array($activearr);
730         $config->set_source_array($configarr);
732         // Return the root element (filters)
733         return $filters;
734     }
737 /**
738  * structure step in charge of constructing the comments.xml file for all the comments found
739  * in a given context
740  */
741 class backup_comments_structure_step extends backup_structure_step {
743     protected function define_structure() {
745         // Define each element separated
747         $comments = new backup_nested_element('comments');
749         $comment = new backup_nested_element('comment', array('id'), array(
750             'commentarea', 'itemid', 'content', 'format',
751             'userid', 'timecreated'));
753         // Build the tree
755         $comments->add_child($comment);
757         // Define sources
759         $comment->set_source_table('comments', array('contextid' => backup::VAR_CONTEXTID));
761         // Define id annotations
763         $comment->annotate_ids('user', 'userid');
765         // Return the root element (comments)
766         return $comments;
767     }
770 /**
771  * structure step in charge of constructing the gradebook.xml file for all the gradebook config in the course
772  * NOTE: the backup of the grade items themselves is handled by backup_activity_grades_structure_step
773  */
774 class backup_gradebook_structure_step extends backup_structure_step {
776     /**
777      * We need to decide conditionally, based on dynamic information
778      * about the execution of this step. Only will be executed if all
779      * the module gradeitems have been already included in backup
780      */
781     protected function execute_condition() {
782         return backup_plan_dbops::require_gradebook_backup($this->get_courseid(), $this->get_backupid());
783     }
785     protected function define_structure() {
787         // are we including user info?
788         $userinfo = $this->get_setting_value('users');
790         $gradebook = new backup_nested_element('gradebook');
792         //grade_letters are done in backup_activity_grades_structure_step()
794         //calculated grade items
795         $grade_items = new backup_nested_element('grade_items');
796         $grade_item = new backup_nested_element('grade_item', array('id'), array(
797             'categoryid', 'itemname', 'itemtype', 'itemmodule',
798             'iteminstance', 'itemnumber', 'iteminfo', 'idnumber',
799             'calculation', 'gradetype', 'grademax', 'grademin',
800             'scaleid', 'outcomeid', 'gradepass', 'multfactor',
801             'plusfactor', 'aggregationcoef', 'sortorder', 'display',
802             'decimals', 'hidden', 'locked', 'locktime',
803             'needsupdate', 'timecreated', 'timemodified'));
805         $grade_grades = new backup_nested_element('grade_grades');
806         $grade_grade = new backup_nested_element('grade_grade', array('id'), array(
807             'userid', 'rawgrade', 'rawgrademax', 'rawgrademin',
808             'rawscaleid', 'usermodified', 'finalgrade', 'hidden',
809             'locked', 'locktime', 'exported', 'overridden',
810             'excluded', 'feedback', 'feedbackformat', 'information',
811             'informationformat', 'timecreated', 'timemodified'));
813         //grade_categories
814         $grade_categories = new backup_nested_element('grade_categories');
815         $grade_category   = new backup_nested_element('grade_category', array('id'), array(
816                 //'courseid',
817                 'parent', 'depth', 'path', 'fullname', 'aggregation', 'keephigh',
818                 'dropload', 'aggregateonlygraded', 'aggregateoutcomes', 'aggregatesubcats',
819                 'timecreated', 'timemodified', 'hidden'));
821         $letters = new backup_nested_element('grade_letters');
822         $letter = new backup_nested_element('grade_letter', 'id', array(
823             'lowerboundary', 'letter'));
825         $grade_settings = new backup_nested_element('grade_settings');
826         $grade_setting = new backup_nested_element('grade_setting', 'id', array(
827             'name', 'value'));
830         // Build the tree
831         $gradebook->add_child($grade_categories);
832         $grade_categories->add_child($grade_category);
834         $gradebook->add_child($grade_items);
835         $grade_items->add_child($grade_item);
836         $grade_item->add_child($grade_grades);
837         $grade_grades->add_child($grade_grade);
839         $gradebook->add_child($letters);
840         $letters->add_child($letter);
842         $gradebook->add_child($grade_settings);
843         $grade_settings->add_child($grade_setting);
845         // Define sources
847         //Include manual, category and the course grade item
848         $grade_items_sql ="SELECT * FROM {grade_items}
849                            WHERE courseid = :courseid
850                            AND (itemtype='manual' OR itemtype='course' OR itemtype='category')";
851         $grade_items_params = array('courseid'=>backup::VAR_COURSEID);
852         $grade_item->set_source_sql($grade_items_sql, $grade_items_params);
854         if ($userinfo) {
855             $grade_grade->set_source_table('grade_grades', array('itemid' => backup::VAR_PARENTID));
856         }
858         $grade_category_sql = "SELECT gc.*, gi.sortorder
859                                FROM {grade_categories} gc
860                                JOIN {grade_items} gi ON (gi.iteminstance = gc.id)
861                                WHERE gc.courseid = :courseid
862                                AND (gi.itemtype='course' OR gi.itemtype='category')
863                                ORDER BY gc.parent ASC";//need parent categories before their children
864         $grade_category_params = array('courseid'=>backup::VAR_COURSEID);
865         $grade_category->set_source_sql($grade_category_sql, $grade_category_params);
867         $letter->set_source_table('grade_letters', array('contextid' => backup::VAR_CONTEXTID));
869         $grade_setting->set_source_table('grade_settings', array('courseid' => backup::VAR_COURSEID));
871         // Annotations (both as final as far as they are going to be exported in next steps)
872         $grade_item->annotate_ids('scalefinal', 'scaleid'); // Straight as scalefinal because it's > 0
873         $grade_item->annotate_ids('outcomefinal', 'outcomeid');
875         //just in case there are any users not already annotated by the activities
876         $grade_grade->annotate_ids('userfinal', 'userid');
878         // Return the root element
879         return $gradebook;
880     }
883 /**
884  * structure step in charge if constructing the completion.xml file for all the users completion
885  * information in a given activity
886  */
887 class backup_userscompletion_structure_step extends backup_structure_step {
889     protected function define_structure() {
891         // Define each element separated
893         $completions = new backup_nested_element('completions');
895         $completion = new backup_nested_element('completion', array('id'), array(
896             'userid', 'completionstate', 'viewed', 'timemodified'));
898         // Build the tree
900         $completions->add_child($completion);
902         // Define sources
904         $completion->set_source_table('course_modules_completion', array('coursemoduleid' => backup::VAR_MODID));
906         // Define id annotations
908         $completion->annotate_ids('user', 'userid');
910         // Return the root element (completions)
911         return $completions;
912     }
915 /**
916  * structure step in charge of constructing the main groups.xml file for all the groups and
917  * groupings information already annotated
918  */
919 class backup_groups_structure_step extends backup_structure_step {
921     protected function define_structure() {
923         // To know if we are including users
924         $users = $this->get_setting_value('users');
926         // Define each element separated
928         $groups = new backup_nested_element('groups');
930         $group = new backup_nested_element('group', array('id'), array(
931             'name', 'description', 'descriptionformat', 'enrolmentkey',
932             'picture', 'hidepicture', 'timecreated', 'timemodified'));
934         $members = new backup_nested_element('group_members');
936         $member = new backup_nested_element('group_member', array('id'), array(
937             'userid', 'timeadded'));
939         $groupings = new backup_nested_element('groupings');
941         $grouping = new backup_nested_element('grouping', 'id', array(
942             'name', 'description', 'descriptionformat', 'configdata',
943             'timecreated', 'timemodified'));
945         $groupinggroups = new backup_nested_element('grouping_groups');
947         $groupinggroup = new backup_nested_element('grouping_group', array('id'), array(
948             'groupid', 'timeadded'));
950         // Build the tree
952         $groups->add_child($group);
953         $groups->add_child($groupings);
955         $group->add_child($members);
956         $members->add_child($member);
958         $groupings->add_child($grouping);
959         $grouping->add_child($groupinggroups);
960         $groupinggroups->add_child($groupinggroup);
962         // Define sources
964         $group->set_source_sql("
965             SELECT g.*
966               FROM {groups} g
967               JOIN {backup_ids_temp} bi ON g.id = bi.itemid
968              WHERE bi.backupid = ?
969                AND bi.itemname = 'groupfinal'", array(backup::VAR_BACKUPID));
971         // This only happens if we are including users
972         if ($users) {
973             $member->set_source_table('groups_members', array('groupid' => backup::VAR_PARENTID));
974         }
976         $grouping->set_source_sql("
977             SELECT g.*
978               FROM {groupings} g
979               JOIN {backup_ids_temp} bi ON g.id = bi.itemid
980              WHERE bi.backupid = ?
981                AND bi.itemname = 'groupingfinal'", array(backup::VAR_BACKUPID));
983         $groupinggroup->set_source_table('groupings_groups', array('groupingid' => backup::VAR_PARENTID));
985         // Define id annotations (as final)
987         $member->annotate_ids('userfinal', 'userid');
989         // Define file annotations
991         $group->annotate_files('group', 'description', 'id');
992         $group->annotate_files('group', 'icon', 'id');
993         $grouping->annotate_files('grouping', 'description', 'id');
995         // Return the root element (groups)
996         return $groups;
997     }
1000 /**
1001  * structure step in charge of constructing the main users.xml file for all the users already
1002  * annotated (final). Includes custom profile fields, preferences, tags, role assignments and
1003  * overrides.
1004  */
1005 class backup_users_structure_step extends backup_structure_step {
1007     protected function define_structure() {
1008         global $CFG;
1010         // To know if we are anonymizing users
1011         $anonymize = $this->get_setting_value('anonymize');
1012         // To know if we are including role assignments
1013         $roleassignments = $this->get_setting_value('role_assignments');
1015         // Define each element separated
1017         $users = new backup_nested_element('users');
1019         // Create the array of user fields by hand, as far as we have various bits to control
1020         // anonymize option, password backup, mnethostid...
1022         // First, the fields not needing anonymization nor special handling
1023         $normalfields = array(
1024             'confirmed', 'policyagreed', 'deleted',
1025             'lang', 'theme', 'timezone', 'firstaccess',
1026             'lastaccess', 'lastlogin', 'currentlogin',
1027             'mailformat', 'maildigest', 'maildisplay', 'htmleditor',
1028             'ajax', 'autosubscribe', 'trackforums', 'timecreated',
1029             'timemodified', 'trustbitmask', 'screenreader');
1031         // Then, the fields potentially needing anonymization
1032         $anonfields = array(
1033             'username', 'idnumber', 'firstname', 'lastname',
1034             'email', 'icq', 'skype',
1035             'yahoo', 'aim', 'msn', 'phone1',
1036             'phone2', 'institution', 'department', 'address',
1037             'city', 'country', 'lastip', 'picture',
1038             'url', 'description', 'descriptionformat', 'imagealt', 'auth');
1040         // Add anonymized fields to $userfields with custom final element
1041         foreach ($anonfields as $field) {
1042             if ($anonymize) {
1043                 $userfields[] = new anonymizer_final_element($field);
1044             } else {
1045                 $userfields[] = $field; // No anonymization, normally added
1046             }
1047         }
1049         // mnethosturl requires special handling (custom final element)
1050         $userfields[] = new mnethosturl_final_element('mnethosturl');
1052         // password added conditionally
1053         if (!empty($CFG->includeuserpasswordsinbackup)) {
1054             $userfields[] = 'password';
1055         }
1057         // Merge all the fields
1058         $userfields = array_merge($userfields, $normalfields);
1060         $user = new backup_nested_element('user', array('id', 'contextid'), $userfields);
1062         $customfields = new backup_nested_element('custom_fields');
1064         $customfield = new backup_nested_element('custom_field', array('id'), array(
1065             'field_name', 'field_type', 'field_data'));
1067         $tags = new backup_nested_element('tags');
1069         $tag = new backup_nested_element('tag', array('id'), array(
1070             'name', 'rawname'));
1072         $preferences = new backup_nested_element('preferences');
1074         $preference = new backup_nested_element('preference', array('id'), array(
1075             'name', 'value'));
1077         $roles = new backup_nested_element('roles');
1079         $overrides = new backup_nested_element('role_overrides');
1081         $override = new backup_nested_element('override', array('id'), array(
1082             'roleid', 'capability', 'permission', 'timemodified',
1083             'modifierid'));
1085         $assignments = new backup_nested_element('role_assignments');
1087         $assignment = new backup_nested_element('assignment', array('id'), array(
1088             'roleid', 'userid', 'timemodified', 'modifierid', 'component', //TODO: MDL-22793 add itemid here
1089             'sortorder'));
1091         // Build the tree
1093         $users->add_child($user);
1095         $user->add_child($customfields);
1096         $customfields->add_child($customfield);
1098         $user->add_child($tags);
1099         $tags->add_child($tag);
1101         $user->add_child($preferences);
1102         $preferences->add_child($preference);
1104         $user->add_child($roles);
1106         $roles->add_child($overrides);
1107         $roles->add_child($assignments);
1109         $overrides->add_child($override);
1110         $assignments->add_child($assignment);
1112         // Define sources
1114         $user->set_source_sql('SELECT u.*, c.id AS contextid, m.wwwroot AS mnethosturl
1115                                  FROM {user} u
1116                                  JOIN {backup_ids_temp} bi ON bi.itemid = u.id
1117                                  JOIN {context} c ON c.instanceid = u.id
1118                             LEFT JOIN {mnet_host} m ON m.id = u.mnethostid
1119                                 WHERE bi.backupid = ?
1120                                   AND bi.itemname = ?
1121                                   AND c.contextlevel = ?', array(
1122                                       backup_helper::is_sqlparam($this->get_backupid()),
1123                                       backup_helper::is_sqlparam('userfinal'),
1124                                       backup_helper::is_sqlparam(CONTEXT_USER)));
1126         // All the rest on information is only added if we arent
1127         // in an anonymized backup
1128         if (!$anonymize) {
1129             $customfield->set_source_sql('SELECT f.id, f.shortname, f.datatype, d.data
1130                                             FROM {user_info_field} f
1131                                             JOIN {user_info_data} d ON d.fieldid = f.id
1132                                            WHERE d.userid = ?', array(backup::VAR_PARENTID));
1134             $customfield->set_source_alias('shortname', 'field_name');
1135             $customfield->set_source_alias('datatype',  'field_type');
1136             $customfield->set_source_alias('data',      'field_data');
1138             $tag->set_source_sql('SELECT t.id, t.name, t.rawname
1139                                     FROM {tag} t
1140                                     JOIN {tag_instance} ti ON ti.tagid = t.id
1141                                    WHERE ti.itemtype = ?
1142                                      AND ti.itemid = ?', array(
1143                                          backup_helper::is_sqlparam('user'),
1144                                          backup::VAR_PARENTID));
1146             $preference->set_source_table('user_preferences', array('userid' => backup::VAR_PARENTID));
1148             $override->set_source_table('role_capabilities', array('contextid' => '/users/user/contextid'));
1150             // Assignments only added if specified
1151             if ($roleassignments) {
1152                 $assignment->set_source_table('role_assignments', array('contextid' => '/users/user/contextid'));
1153             }
1155             // Define id annotations (as final)
1156             $override->annotate_ids('rolefinal', 'roleid');
1157         }
1159         // Return root element (users)
1160         return $users;
1161     }
1164 /**
1165  * structure step in charge of constructing the block.xml file for one
1166  * given block (instance and positions). If the block has custom DB structure
1167  * that will go to a separate file (different step defined in block class)
1168  */
1169 class backup_block_instance_structure_step extends backup_structure_step {
1171     protected function define_structure() {
1172         global $DB;
1174         // Define each element separated
1176         $block = new backup_nested_element('block', array('id', 'contextid', 'version'), array(
1177             'blockname', 'parentcontextid', 'showinsubcontexts', 'pagetypepattern',
1178             'subpagepattern', 'defaultregion', 'defaultweight', 'configdata'));
1180         $positions = new backup_nested_element('block_positions');
1182         $position = new backup_nested_element('block_position', array('id'), array(
1183             'contextid', 'pagetype', 'subpage', 'visible',
1184             'region', 'weight'));
1186         // Build the tree
1188         $block->add_child($positions);
1189         $positions->add_child($position);
1191         // Transform configdata information if needed (process links and friends)
1192         $blockrec = $DB->get_record('block_instances', array('id' => $this->task->get_blockid()));
1193         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
1194             $configdata = (array)unserialize(base64_decode($blockrec->configdata));
1195             foreach ($configdata as $attribute => $value) {
1196                 if (in_array($attribute, $attrstotransform)) {
1197                     $configdata[$attribute] = $this->contenttransformer->process($value);
1198                 }
1199             }
1200             $blockrec->configdata = base64_encode(serialize((object)$configdata));
1201         }
1202         $blockrec->contextid = $this->task->get_contextid();
1203         // Get the version of the block
1204         $blockrec->version = $DB->get_field('block', 'version', array('name' => $this->task->get_blockname()));
1206         // Define sources
1208         $block->set_source_array(array($blockrec));
1210         $position->set_source_table('block_positions', array('blockinstanceid' => backup::VAR_PARENTID));
1212         // File anotations (for fileareas specified on each block)
1213         foreach ($this->task->get_fileareas() as $filearea) {
1214             $block->annotate_files('block_' . $this->task->get_blockname(), $filearea, null);
1215         }
1217         // Return the root element (block)
1218         return $block;
1219     }
1222 /**
1223  * structure step in charge of constructing the logs.xml file for all the log records found
1224  * in course. Note that we are sending to backup ALL the log records having cmid = 0. That
1225  * includes some records that won't be restoreable (like 'upload', 'calendar'...) but we do
1226  * that just in case they become restored some day in the future
1227  */
1228 class backup_course_logs_structure_step extends backup_structure_step {
1230     protected function define_structure() {
1232         // Define each element separated
1234         $logs = new backup_nested_element('logs');
1236         $log = new backup_nested_element('log', array('id'), array(
1237             'time', 'userid', 'ip', 'module',
1238             'action', 'url', 'info'));
1240         // Build the tree
1242         $logs->add_child($log);
1244         // Define sources (all the records belonging to the course, having cmid = 0)
1246         $log->set_source_table('log', array('course' => backup::VAR_COURSEID, 'cmid' => backup_helper::is_sqlparam(0)));
1248         // Annotations
1249         // NOTE: We don't annotate users from logs as far as they MUST be
1250         //       always annotated by the course (enrol, ras... whatever)
1252         // Return the root element (logs)
1254         return $logs;
1255     }
1258 /**
1259  * structure step in charge of constructing the logs.xml file for all the log records found
1260  * in activity
1261  */
1262 class backup_activity_logs_structure_step extends backup_structure_step {
1264     protected function define_structure() {
1266         // Define each element separated
1268         $logs = new backup_nested_element('logs');
1270         $log = new backup_nested_element('log', array('id'), array(
1271             'time', 'userid', 'ip', 'module',
1272             'action', 'url', 'info'));
1274         // Build the tree
1276         $logs->add_child($log);
1278         // Define sources
1280         $log->set_source_table('log', array('cmid' => backup::VAR_MODID));
1282         // Annotations
1283         // NOTE: We don't annotate users from logs as far as they MUST be
1284         //       always annotated by the activity (true participants).
1286         // Return the root element (logs)
1288         return $logs;
1289     }
1292 /**
1293  * structure in charge of constructing the inforef.xml file for all the items we want
1294  * to have referenced there (users, roles, files...)
1295  */
1296 class backup_inforef_structure_step extends backup_structure_step {
1298     protected function define_structure() {
1300         // Items we want to include in the inforef file.
1301         $items = backup_helper::get_inforef_itemnames();
1303         // Build the tree
1305         $inforef = new backup_nested_element('inforef');
1307         // For each item, conditionally, if there are already records, build element
1308         foreach ($items as $itemname) {
1309             if (backup_structure_dbops::annotations_exist($this->get_backupid(), $itemname)) {
1310                 $elementroot = new backup_nested_element($itemname . 'ref');
1311                 $element = new backup_nested_element($itemname, array(), array('id'));
1312                 $inforef->add_child($elementroot);
1313                 $elementroot->add_child($element);
1314                 $element->set_source_sql("
1315                     SELECT itemid AS id
1316                      FROM {backup_ids_temp}
1317                     WHERE backupid = ?
1318                       AND itemname = ?",
1319                    array(backup::VAR_BACKUPID, backup_helper::is_sqlparam($itemname)));
1320             }
1321         }
1323         // We don't annotate anything there, but rely in the next step
1324         // (move_inforef_annotations_to_final) that will change all the
1325         // already saved 'inforref' entries to their 'final' annotations.
1326         return $inforef;
1327     }
1330 /**
1331  * This step will get all the annotations already processed to inforef.xml file and
1332  * transform them into 'final' annotations.
1333  */
1334 class move_inforef_annotations_to_final extends backup_execution_step {
1336     protected function define_execution() {
1338         // Items we want to include in the inforef file
1339         $items = backup_helper::get_inforef_itemnames();
1340         foreach ($items as $itemname) {
1341             // Delegate to dbops
1342             backup_structure_dbops::move_annotations_to_final($this->get_backupid(), $itemname);
1343         }
1344     }
1347 /**
1348  * structure in charge of constructing the files.xml file with all the
1349  * annotated (final) files along the process. At, the same time, and
1350  * using one specialised nested_element, will copy them form moodle storage
1351  * to backup storage
1352  */
1353 class backup_final_files_structure_step extends backup_structure_step {
1355     protected function define_structure() {
1357         // Define elements
1359         $files = new backup_nested_element('files');
1361         $file = new file_nested_element('file', array('id'), array(
1362             'contenthash', 'contextid', 'component', 'filearea', 'itemid',
1363             'filepath', 'filename', 'userid', 'filesize',
1364             'mimetype', 'status', 'timecreated', 'timemodified',
1365             'source', 'author', 'license', 'sortorder'));
1367         // Build the tree
1369         $files->add_child($file);
1371         // Define sources
1373         $file->set_source_sql("SELECT f.*
1374                                  FROM {files} f
1375                                  JOIN {backup_ids_temp} bi ON f.id = bi.itemid
1376                                 WHERE bi.backupid = ?
1377                                   AND bi.itemname = 'filefinal'", array(backup::VAR_BACKUPID));
1379         return $files;
1380     }
1383 /**
1384  * Structure step in charge of creating the main moodle_backup.xml file
1385  * where all the information related to the backup, settings, license and
1386  * other information needed on restore is added*/
1387 class backup_main_structure_step extends backup_structure_step {
1389     protected function define_structure() {
1391         global $CFG;
1393         $info = array();
1395         $info['name'] = $this->get_setting_value('filename');
1396         $info['moodle_version'] = $CFG->version;
1397         $info['moodle_release'] = $CFG->release;
1398         $info['backup_version'] = $CFG->backup_version;
1399         $info['backup_release'] = $CFG->backup_release;
1400         $info['backup_date']    = time();
1401         $info['backup_uniqueid']= $this->get_backupid();
1402         $info['mnet_remoteusers']=backup_controller_dbops::backup_includes_mnet_remote_users($this->get_backupid());
1403         $info['original_wwwroot']=$CFG->wwwroot;
1404         $info['original_site_identifier_hash'] = md5(get_site_identifier());
1405         $info['original_course_id'] = $this->get_courseid();
1406         $originalcourseinfo = backup_controller_dbops::backup_get_original_course_info($this->get_courseid());
1407         $info['original_course_fullname']  = $originalcourseinfo->fullname;
1408         $info['original_course_shortname'] = $originalcourseinfo->shortname;
1409         $info['original_course_startdate'] = $originalcourseinfo->startdate;
1410         $info['original_course_contextid'] = get_context_instance(CONTEXT_COURSE, $this->get_courseid())->id;
1411         $info['original_system_contextid'] = get_context_instance(CONTEXT_SYSTEM)->id;
1413         // Get more information from controller
1414         list($dinfo, $cinfo, $sinfo) = backup_controller_dbops::get_moodle_backup_information($this->get_backupid());
1416         // Define elements
1418         $moodle_backup = new backup_nested_element('moodle_backup');
1420         $information = new backup_nested_element('information', null, array(
1421             'name', 'moodle_version', 'moodle_release', 'backup_version',
1422             'backup_release', 'backup_date', 'mnet_remoteusers', 'original_wwwroot',
1423             'original_site_identifier_hash', 'original_course_id',
1424             'original_course_fullname', 'original_course_shortname', 'original_course_startdate',
1425             'original_course_contextid', 'original_system_contextid'));
1427         $details = new backup_nested_element('details');
1429         $detail = new backup_nested_element('detail', array('backup_id'), array(
1430             'type', 'format', 'interactive', 'mode',
1431             'execution', 'executiontime'));
1433         $contents = new backup_nested_element('contents');
1435         $activities = new backup_nested_element('activities');
1437         $activity = new backup_nested_element('activity', null, array(
1438             'moduleid', 'sectionid', 'modulename', 'title',
1439             'directory'));
1441         $sections = new backup_nested_element('sections');
1443         $section = new backup_nested_element('section', null, array(
1444             'sectionid', 'title', 'directory'));
1446         $course = new backup_nested_element('course', null, array(
1447             'courseid', 'title', 'directory'));
1449         $settings = new backup_nested_element('settings');
1451         $setting = new backup_nested_element('setting', null, array(
1452             'level', 'section', 'activity', 'name', 'value'));
1454         // Build the tree
1456         $moodle_backup->add_child($information);
1458         $information->add_child($details);
1459         $details->add_child($detail);
1461         $information->add_child($contents);
1462         if (!empty($cinfo['activities'])) {
1463             $contents->add_child($activities);
1464             $activities->add_child($activity);
1465         }
1466         if (!empty($cinfo['sections'])) {
1467             $contents->add_child($sections);
1468             $sections->add_child($section);
1469         }
1470         if (!empty($cinfo['course'])) {
1471             $contents->add_child($course);
1472         }
1474         $information->add_child($settings);
1475         $settings->add_child($setting);
1478         // Set the sources
1480         $information->set_source_array(array((object)$info));
1482         $detail->set_source_array($dinfo);
1484         $activity->set_source_array($cinfo['activities']);
1486         $section->set_source_array($cinfo['sections']);
1488         $course->set_source_array($cinfo['course']);
1490         $setting->set_source_array($sinfo);
1492         // Prepare some information to be sent to main moodle_backup.xml file
1493         return $moodle_backup;
1494     }
1498 /**
1499  * Execution step that will generate the final zip (.mbz) file with all the contents
1500  */
1501 class backup_zip_contents extends backup_execution_step {
1503     protected function define_execution() {
1505         // Get basepath
1506         $basepath = $this->get_basepath();
1508         // Get the list of files in directory
1509         $filestemp = get_directory_list($basepath, '', false, true, true);
1510         $files = array();
1511         foreach ($filestemp as $file) { // Add zip paths and fs paths to all them
1512             $files[$file] = $basepath . '/' . $file;
1513         }
1515         // Add the log file if exists
1516         $logfilepath = $basepath . '.log';
1517         if (file_exists($logfilepath)) {
1518              $files['moodle_backup.log'] = $logfilepath;
1519         }
1521         // Calculate the zip fullpath (in OS temp area it's always backup.mbz)
1522         $zipfile = $basepath . '/backup.mbz';
1524         // Get the zip packer
1525         $zippacker = get_file_packer('application/zip');
1527         // Zip files
1528         $zippacker->archive_to_pathname($files, $zipfile);
1529     }
1532 /**
1533  * This step will send the generated backup file to its final destination
1534  */
1535 class backup_store_backup_file extends backup_execution_step {
1537     protected function define_execution() {
1539         // Get basepath
1540         $basepath = $this->get_basepath();
1542         // Calculate the zip fullpath (in OS temp area it's always backup.mbz)
1543         $zipfile = $basepath . '/backup.mbz';
1545         // Perform storage and return it (TODO: shouldn't be array but proper result object)
1546         return array('backup_destination' => backup_helper::store_backup_file($this->get_backupid(), $zipfile));
1547     }
1551 /**
1552  * This step will search for all the activity (not calculations, categories nor aggregations) grade items
1553  * and put them to the backup_ids tables, to be used later as base to backup them
1554  */
1555 class backup_activity_grade_items_to_ids extends backup_execution_step {
1557     protected function define_execution() {
1559         // Fetch all activity grade items
1560         if ($items = grade_item::fetch_all(array(
1561                          'itemtype' => 'mod', 'itemmodule' => $this->task->get_modulename(),
1562                          'iteminstance' => $this->task->get_activityid(), 'courseid' => $this->task->get_courseid()))) {
1563             // Annotate them in backup_ids
1564             foreach ($items as $item) {
1565                 backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'grade_item', $item->id);
1566             }
1567         }
1568     }
1571 /**
1572  * This step will annotate all the groups and groupings belonging to the course
1573  */
1574 class backup_annotate_course_groups_and_groupings extends backup_execution_step {
1576     protected function define_execution() {
1577         global $DB;
1579         // Get all the course groups
1580         if ($groups = $DB->get_records('groups', array(
1581                 'courseid' => $this->task->get_courseid()))) {
1582             foreach ($groups as $group) {
1583                 backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'group', $group->id);
1584             }
1585         }
1587         // Get all the course groupings
1588         if ($groupings = $DB->get_records('groupings', array(
1589                 'courseid' => $this->task->get_courseid()))) {
1590             foreach ($groupings as $grouping) {
1591                 backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'grouping', $grouping->id);
1592             }
1593         }
1594     }
1597 /**
1598  * This step will annotate all the groups belonging to already annotated groupings
1599  */
1600 class backup_annotate_groups_from_groupings extends backup_execution_step {
1602     protected function define_execution() {
1603         global $DB;
1605         // Fetch all the annotated groupings
1606         if ($groupings = $DB->get_records('backup_ids_temp', array(
1607                 'backupid' => $this->get_backupid(), 'itemname' => 'grouping'))) {
1608             foreach ($groupings as $grouping) {
1609                 if ($groups = $DB->get_records('groupings_groups', array(
1610                         'groupingid' => $grouping->itemid))) {
1611                     foreach ($groups as $group) {
1612                         backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'group', $group->groupid);
1613                     }
1614                 }
1615             }
1616         }
1617     }
1620 /**
1621  * This step will annotate all the scales belonging to already annotated outcomes
1622  */
1623 class backup_annotate_scales_from_outcomes extends backup_execution_step {
1625     protected function define_execution() {
1626         global $DB;
1628         // Fetch all the annotated outcomes
1629         if ($outcomes = $DB->get_records('backup_ids_temp', array(
1630                 'backupid' => $this->get_backupid(), 'itemname' => 'outcome'))) {
1631             foreach ($outcomes as $outcome) {
1632                 if ($scale = $DB->get_record('grade_outcomes', array(
1633                         'id' => $outcome->itemid))) {
1634                     // Annotate as scalefinal because it's > 0
1635                     backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'scalefinal', $scale->scaleid);
1636                 }
1637             }
1638         }
1639     }
1642 /**
1643  * This step will generate all the file annotations for the already
1644  * annotated (final) question_categories. It calculates the different
1645  * contexts that are being backup and, annotates all the files
1646  * on every context belonging to the "question" component. As far as
1647  * we are always including *complete* question banks it is safe and
1648  * optimal to do that in this (one pass) way
1649  */
1650 class backup_annotate_all_question_files extends backup_execution_step {
1652     protected function define_execution() {
1653         global $DB;
1655         // Get all the different contexts for the final question_categories
1656         // annotated along the whole backup
1657         $rs = $DB->get_recordset_sql("SELECT DISTINCT qc.contextid
1658                                         FROM {question_categories} qc
1659                                         JOIN {backup_ids_temp} bi ON bi.itemid = qc.id
1660                                        WHERE bi.backupid = ?
1661                                          AND bi.itemname = 'question_categoryfinal'", array($this->get_backupid()));
1662         // To know about qtype specific components/fileareas
1663         $components = backup_qtype_plugin::get_components_and_fileareas();
1664         // Let's loop
1665         foreach($rs as $record) {
1666             // We don't need to specify filearea nor itemid as far as by
1667             // component and context it's enough to annotate the whole bank files
1668             // This backups "questiontext", "generalfeedback" and "answerfeedback" fileareas (all them
1669             // belonging to the "question" component
1670             backup_structure_dbops::annotate_files($this->get_backupid(), $record->contextid, 'question', null, null);
1671             // Again, it is enough to pick files only by context and component
1672             // Do it for qtype specific components
1673             foreach ($components as $component => $fileareas) {
1674                 backup_structure_dbops::annotate_files($this->get_backupid(), $record->contextid, $component, null, null);
1675             }
1676         }
1677         $rs->close();
1678     }
1681 /**
1682  * structure step in charge of constructing the questions.xml file for all the
1683  * question categories and questions required by the backup
1684  * and letters related to one activity
1685  */
1686 class backup_questions_structure_step extends backup_structure_step {
1688     protected function define_structure() {
1690         // Define each element separated
1692         $qcategories = new backup_nested_element('question_categories');
1694         $qcategory = new backup_nested_element('question_category', array('id'), array(
1695             'name', 'contextid', 'contextlevel', 'contextinstanceid',
1696             'info', 'infoformat', 'stamp', 'parent',
1697             'sortorder'));
1699         $questions = new backup_nested_element('questions');
1701         $question = new backup_nested_element('question', array('id'), array(
1702             'parent', 'name', 'questiontext', 'questiontextformat',
1703             'generalfeedback', 'generalfeedbackformat', 'defaultmark', 'penalty',
1704             'qtype', 'length', 'stamp', 'version',
1705             'hidden', 'timecreated', 'timemodified', 'createdby', 'modifiedby'));
1707         // attach qtype plugin structure to $question element, only one allowed
1708         $this->add_plugin_structure('qtype', $question, false);
1710         $qhints = new backup_nested_element('question_hints');
1712         $qhint = new backup_nested_element('question_hint', array('id'), array(
1713             'hint', 'hintformat', 'shownumcorrect', 'clearwrong', 'options'));
1715         // Build the tree
1717         $qcategories->add_child($qcategory);
1718         $qcategory->add_child($questions);
1719         $questions->add_child($question);
1720         $question->add_child($qhints);
1721         $qhints->add_child($qhint);
1723         // Define the sources
1725         $qcategory->set_source_sql("
1726             SELECT gc.*, contextlevel, instanceid AS contextinstanceid
1727               FROM {question_categories} gc
1728               JOIN {backup_ids_temp} bi ON bi.itemid = gc.id
1729               JOIN {context} co ON co.id = gc.contextid
1730              WHERE bi.backupid = ?
1731                AND bi.itemname = 'question_categoryfinal'", array(backup::VAR_BACKUPID));
1733         $question->set_source_table('question', array('category' => backup::VAR_PARENTID));
1735         $qhint->set_source_sql('
1736                 SELECT *
1737                 FROM {question_hints}
1738                 WHERE questionid = :questionid
1739                 ORDER BY id',
1740                 array('questionid' => backup::VAR_PARENTID));
1742         // don't need to annotate ids nor files
1743         // (already done by {@link backup_annotate_all_question_files}
1745         return $qcategories;
1746     }
1751 /**
1752  * This step will generate all the file  annotations for the already
1753  * annotated (final) users. Need to do this here because each user
1754  * has its own context and structure tasks only are able to handle
1755  * one context. Also, this step will guarantee that every user has
1756  * its context created (req for other steps)
1757  */
1758 class backup_annotate_all_user_files extends backup_execution_step {
1760     protected function define_execution() {
1761         global $DB;
1763         // List of fileareas we are going to annotate
1764         $fileareas = array('profile', 'icon');
1766         if ($this->get_setting_value('user_files')) { // private files only if enabled in settings
1767             $fileareas[] = 'private';
1768         }
1770         // Fetch all annotated (final) users
1771         $rs = $DB->get_recordset('backup_ids_temp', array(
1772             'backupid' => $this->get_backupid(), 'itemname' => 'userfinal'));
1773         foreach ($rs as $record) {
1774             $userid = $record->itemid;
1775             $userctxid = get_context_instance(CONTEXT_USER, $userid)->id;
1776             // Proceed with every user filearea
1777             foreach ($fileareas as $filearea) {
1778                 // We don't need to specify itemid ($userid - 5th param) as far as by
1779                 // context we can get all the associated files. See MDL-22092
1780                 backup_structure_dbops::annotate_files($this->get_backupid(), $userctxid, 'user', $filearea, null);
1781             }
1782         }
1783         $rs->close();
1784     }
1788 /**
1789  * Defines the backup step for advanced grading methods attached to the activity module
1790  */
1791 class backup_activity_grading_structure_step extends backup_structure_step {
1793     /**
1794      * Include the grading.xml only if the module supports advanced grading
1795      */
1796     protected function execute_condition() {
1797         return plugin_supports('mod', $this->get_task()->get_modulename(), FEATURE_ADVANCED_GRADING, false);
1798     }
1800     /**
1801      * Declares the gradable areas structures and data sources
1802      */
1803     protected function define_structure() {
1805         // To know if we are including userinfo
1806         $userinfo = $this->get_setting_value('userinfo');
1808         // Define the elements
1810         $areas = new backup_nested_element('areas');
1812         $area = new backup_nested_element('area', array('id'), array(
1813             'areaname', 'activemethod'));
1815         $definitions = new backup_nested_element('definitions');
1817         $definition = new backup_nested_element('definition', array('id'), array(
1818             'method', 'name', 'description', 'descriptionformat', 'status',
1819             'timecreated', 'timemodified', 'options'));
1821         $instances = new backup_nested_element('instances');
1823         $instance = new backup_nested_element('instance', array('id'), array(
1824             'raterid', 'itemid', 'rawgrade', 'status', 'feedback',
1825             'feedbackformat', 'timemodified'));
1827         // Build the tree including the method specific structures
1828         // (beware - the order of how gradingform plugins structures are attached is important)
1829         $areas->add_child($area);
1830         $area->add_child($definitions);
1831         $definitions->add_child($definition);
1832         $this->add_plugin_structure('gradingform', $definition, true);
1833         $definition->add_child($instances);
1834         $instances->add_child($instance);
1835         $this->add_plugin_structure('gradingform', $instance, false);
1837         // Define data sources
1839         $area->set_source_table('grading_areas', array('contextid' => backup::VAR_CONTEXTID,
1840             'component' => array('sqlparam' => 'mod_'.$this->get_task()->get_modulename())));
1842         $definition->set_source_table('grading_definitions', array('areaid' => backup::VAR_PARENTID));
1844         if ($userinfo) {
1845             $instance->set_source_table('grading_instances', array('definitionid' => backup::VAR_PARENTID));
1846         }
1848         // Annotate references
1849         $definition->annotate_files('grading', 'description', 'id');
1850         $instance->annotate_ids('user', 'raterid');
1852         // Return the root element
1853         return $areas;
1854     }
1858 /**
1859  * structure step in charge of constructing the grades.xml file for all the grade items
1860  * and letters related to one activity
1861  */
1862 class backup_activity_grades_structure_step extends backup_structure_step {
1864     protected function define_structure() {
1866         // To know if we are including userinfo
1867         $userinfo = $this->get_setting_value('userinfo');
1869         // Define each element separated
1871         $book = new backup_nested_element('activity_gradebook');
1873         $items = new backup_nested_element('grade_items');
1875         $item = new backup_nested_element('grade_item', array('id'), array(
1876             'categoryid', 'itemname', 'itemtype', 'itemmodule',
1877             'iteminstance', 'itemnumber', 'iteminfo', 'idnumber',
1878             'calculation', 'gradetype', 'grademax', 'grademin',
1879             'scaleid', 'outcomeid', 'gradepass', 'multfactor',
1880             'plusfactor', 'aggregationcoef', 'sortorder', 'display',
1881             'decimals', 'hidden', 'locked', 'locktime',
1882             'needsupdate', 'timecreated', 'timemodified'));
1884         $grades = new backup_nested_element('grade_grades');
1886         $grade = new backup_nested_element('grade_grade', array('id'), array(
1887             'userid', 'rawgrade', 'rawgrademax', 'rawgrademin',
1888             'rawscaleid', 'usermodified', 'finalgrade', 'hidden',
1889             'locked', 'locktime', 'exported', 'overridden',
1890             'excluded', 'feedback', 'feedbackformat', 'information',
1891             'informationformat', 'timecreated', 'timemodified'));
1893         $letters = new backup_nested_element('grade_letters');
1895         $letter = new backup_nested_element('grade_letter', 'id', array(
1896             'lowerboundary', 'letter'));
1898         // Build the tree
1900         $book->add_child($items);
1901         $items->add_child($item);
1903         $item->add_child($grades);
1904         $grades->add_child($grade);
1906         $book->add_child($letters);
1907         $letters->add_child($letter);
1909         // Define sources
1911         $item->set_source_sql("SELECT gi.*
1912                                FROM {grade_items} gi
1913                                JOIN {backup_ids_temp} bi ON gi.id = bi.itemid
1914                                WHERE bi.backupid = ?
1915                                AND bi.itemname = 'grade_item'", array(backup::VAR_BACKUPID));
1917         // This only happens if we are including user info
1918         if ($userinfo) {
1919             $grade->set_source_table('grade_grades', array('itemid' => backup::VAR_PARENTID));
1920         }
1922         $letter->set_source_table('grade_letters', array('contextid' => backup::VAR_CONTEXTID));
1924         // Annotations
1926         $item->annotate_ids('scalefinal', 'scaleid'); // Straight as scalefinal because it's > 0
1927         $item->annotate_ids('outcome', 'outcomeid');
1929         $grade->annotate_ids('user', 'userid');
1930         $grade->annotate_ids('user', 'usermodified');
1932         // Return the root element (book)
1934         return $book;
1935     }
1938 /**
1939  * Backups up the course completion information for the course.
1940  */
1941 class backup_course_completion_structure_step extends backup_structure_step {
1943     protected function execute_condition() {
1944         // Check that all activities have been included
1945         if ($this->task->is_excluding_activities()) {
1946             return false;
1947         }
1948         return true;
1949     }
1951     /**
1952      * The structure of the course completion backup
1953      *
1954      * @return backup_nested_element
1955      */
1956     protected function define_structure() {
1958         // To know if we are including user completion info
1959         $userinfo = $this->get_setting_value('userscompletion');
1961         $cc = new backup_nested_element('course_completion');
1963         $criteria = new backup_nested_element('course_completion_criteria', array('id'), array(
1964             'course','criteriatype', 'module', 'moduleinstance', 'courseinstanceshortname', 'enrolperiod', 'timeend', 'gradepass', 'role'
1965         ));
1967         $criteriacompletions = new backup_nested_element('course_completion_crit_completions');
1969         $criteriacomplete = new backup_nested_element('course_completion_crit_compl', array('id'), array(
1970             'criteriaid', 'userid','gradefinal','unenrolled','deleted','timecompleted'
1971         ));
1973         $coursecompletions = new backup_nested_element('course_completions', array('id'), array(
1974             'userid', 'course', 'deleted', 'timenotified', 'timeenrolled','timestarted','timecompleted','reaggregate'
1975         ));
1977         $notify = new backup_nested_element('course_completion_notify', array('id'), array(
1978             'course','role','message','timesent'
1979         ));
1981         $aggregatemethod = new backup_nested_element('course_completion_aggr_methd', array('id'), array(
1982             'course','criteriatype','method','value'
1983         ));
1985         $cc->add_child($criteria);
1986             $criteria->add_child($criteriacompletions);
1987                 $criteriacompletions->add_child($criteriacomplete);
1988         $cc->add_child($coursecompletions);
1989         $cc->add_child($notify);
1990         $cc->add_child($aggregatemethod);
1992         // We need to get the courseinstances shortname rather than an ID for restore
1993         $criteria->set_source_sql("SELECT ccc.*, c.shortname AS courseinstanceshortname
1994                                    FROM {course_completion_criteria} ccc
1995                                    LEFT JOIN {course} c ON c.id = ccc.courseinstance
1996                                    WHERE ccc.course = ?", array(backup::VAR_COURSEID));
1999         $notify->set_source_table('course_completion_notify', array('course' => backup::VAR_COURSEID));
2000         $aggregatemethod->set_source_table('course_completion_aggr_methd', array('course' => backup::VAR_COURSEID));
2002         if ($userinfo) {
2003             $criteriacomplete->set_source_table('course_completion_crit_compl', array('criteriaid' => backup::VAR_PARENTID));
2004             $coursecompletions->set_source_table('course_completions', array('course' => backup::VAR_COURSEID));
2005         }
2007         $criteria->annotate_ids('role', 'role');
2008         $criteriacomplete->annotate_ids('user', 'userid');
2009         $coursecompletions->annotate_ids('user', 'userid');
2010         $notify->annotate_ids('role', 'role');
2012         return $cc;
2014     }