Merge branch 'MDL-34118' of git://github.com/timhunt/moodle
[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  * Defines various backup steps that will be used by common tasks in backup
20  *
21  * @package     core_backup
22  * @subpackage  moodle2
23  * @category    backup
24  * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
25  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 defined('MOODLE_INTERNAL') || die();
30 /**
31  * create the temp dir where backup/restore will happen,
32  * delete old directories and create temp ids table
33  */
34 class create_and_clean_temp_stuff extends backup_execution_step {
36     protected function define_execution() {
37         backup_helper::check_and_create_backup_dir($this->get_backupid());// Create backup temp dir
38         backup_helper::clear_backup_dir($this->get_backupid());           // Empty temp dir, just in case
39         backup_helper::delete_old_backup_dirs(time() - (4 * 60 * 60));    // Delete > 4 hours temp dirs
40         backup_controller_dbops::create_backup_ids_temp_table($this->get_backupid()); // Create ids temp table
41     }
42 }
44 /**
45  * delete the temp dir used by backup/restore (conditionally),
46  * delete old directories and drop tem ids table. Note we delete
47  * the directory but not the corresponding log file that will be
48  * there for, at least, 4 hours - only delete_old_backup_dirs()
49  * deletes log files (for easier access to them)
50  */
51 class drop_and_clean_temp_stuff extends backup_execution_step {
53     protected $skipcleaningtempdir = false;
55     protected function define_execution() {
56         global $CFG;
58         backup_controller_dbops::drop_backup_ids_temp_table($this->get_backupid()); // Drop ids temp table
59         backup_helper::delete_old_backup_dirs(time() - (4 * 60 * 60));              // Delete > 4 hours temp dirs
60         // Delete temp dir conditionally:
61         // 1) If $CFG->keeptempdirectoriesonbackup is not enabled
62         // 2) If backup temp dir deletion has been marked to be avoided
63         if (empty($CFG->keeptempdirectoriesonbackup) && !$this->skipcleaningtempdir) {
64             backup_helper::delete_backup_dir($this->get_backupid()); // Empty backup dir
65         }
66     }
68     public function skip_cleaning_temp_dir($skip) {
69         $this->skipcleaningtempdir = $skip;
70     }
71 }
73 /**
74  * Create the directory where all the task (activity/block...) information will be stored
75  */
76 class create_taskbasepath_directory extends backup_execution_step {
78     protected function define_execution() {
79         global $CFG;
80         $basepath = $this->task->get_taskbasepath();
81         if (!check_dir_exists($basepath, true, true)) {
82             throw new backup_step_exception('cannot_create_taskbasepath_directory', $basepath);
83         }
84     }
85 }
87 /**
88  * Abstract structure step, parent of all the activity structure steps. Used to wrap the
89  * activity structure definition within the main <activity ...> tag. Also provides
90  * subplugin support for activities (that must be properly declared)
91  */
92 abstract class backup_activity_structure_step extends backup_structure_step {
94     /**
95      * Add subplugin structure to any element in the activity backup tree
96      *
97      * @param string $subplugintype type of subplugin as defined in activity db/subplugins.php
98      * @param backup_nested_element $element element in the activity backup tree that
99      *                                       we are going to add subplugin information to
100      * @param bool $multiple to define if multiple subplugins can produce information
101      *                       for each instance of $element (true) or no (false)
102      * @return void
103      */
104     protected function add_subplugin_structure($subplugintype, $element, $multiple) {
106         global $CFG;
108         // Check the requested subplugintype is a valid one
109         $subpluginsfile = $CFG->dirroot . '/mod/' . $this->task->get_modulename() . '/db/subplugins.php';
110         if (!file_exists($subpluginsfile)) {
111              throw new backup_step_exception('activity_missing_subplugins_php_file', $this->task->get_modulename());
112         }
113         include($subpluginsfile);
114         if (!array_key_exists($subplugintype, $subplugins)) {
115              throw new backup_step_exception('incorrect_subplugin_type', $subplugintype);
116         }
118         // Arrived here, subplugin is correct, let's create the optigroup
119         $optigroupname = $subplugintype . '_' . $element->get_name() . '_subplugin';
120         $optigroup = new backup_optigroup($optigroupname, null, $multiple);
121         $element->add_child($optigroup); // Add optigroup to stay connected since beginning
123         // Get all the optigroup_elements, looking across all the subplugin dirs
124         $subpluginsdirs = get_plugin_list($subplugintype);
125         foreach ($subpluginsdirs as $name => $subpluginsdir) {
126             $classname = 'backup_' . $subplugintype . '_' . $name . '_subplugin';
127             $backupfile = $subpluginsdir . '/backup/moodle2/' . $classname . '.class.php';
128             if (file_exists($backupfile)) {
129                 require_once($backupfile);
130                 $backupsubplugin = new $classname($subplugintype, $name, $optigroup, $this);
131                 // Add subplugin returned structure to optigroup
132                 $backupsubplugin->define_subplugin_structure($element->get_name());
133             }
134         }
135     }
137     /**
138      * As far as activity backup steps are implementing backup_subplugin stuff, they need to
139      * have the parent task available for wrapping purposes (get course/context....)
140      *
141      * @return backup_activity_task
142      */
143     public function get_task() {
144         return $this->task;
145     }
147     /**
148      * Wraps any activity backup structure within the common 'activity' element
149      * that will include common to all activities information like id, context...
150      *
151      * @param backup_nested_element $activitystructure the element to wrap
152      * @return backup_nested_element the $activitystructure wrapped by the common 'activity' element
153      */
154     protected function prepare_activity_structure($activitystructure) {
156         // Create the wrap element
157         $activity = new backup_nested_element('activity', array('id', 'moduleid', 'modulename', 'contextid'), null);
159         // Build the tree
160         $activity->add_child($activitystructure);
162         // Set the source
163         $activityarr = array((object)array(
164             'id'         => $this->task->get_activityid(),
165             'moduleid'   => $this->task->get_moduleid(),
166             'modulename' => $this->task->get_modulename(),
167             'contextid'  => $this->task->get_contextid()));
169         $activity->set_source_array($activityarr);
171         // Return the root element (activity)
172         return $activity;
173     }
176 /**
177  * Abstract structure step, to be used by all the activities using core questions stuff
178  * (namely quiz module), supporting question plugins, states and sessions
179  */
180 abstract class backup_questions_activity_structure_step extends backup_activity_structure_step {
182     /**
183      * Attach to $element (usually attempts) the needed backup structures
184      * for question_usages and all the associated data.
185      *
186      * @param backup_nested_element $element the element that will contain all the question_usages data.
187      * @param string $usageidname the name of the element that holds the usageid.
188      *      This must be child of $element, and must be a final element.
189      * @param string $nameprefix this prefix is added to all the element names we create.
190      *      Element names in the XML must be unique, so if you are using usages in
191      *      two different ways, you must give a prefix to at least one of them. If
192      *      you only use one sort of usage, then you can just use the default empty prefix.
193      *      This should include a trailing underscore. For example "myprefix_"
194      */
195     protected function add_question_usages($element, $usageidname, $nameprefix = '') {
196         global $CFG;
197         require_once($CFG->dirroot . '/question/engine/lib.php');
199         // Check $element is one nested_backup_element
200         if (! $element instanceof backup_nested_element) {
201             throw new backup_step_exception('question_states_bad_parent_element', $element);
202         }
203         if (! $element->get_final_element($usageidname)) {
204             throw new backup_step_exception('question_states_bad_question_attempt_element', $usageidname);
205         }
207         $quba = new backup_nested_element($nameprefix . 'question_usage', array('id'),
208                 array('component', 'preferredbehaviour'));
210         $qas = new backup_nested_element($nameprefix . 'question_attempts');
211         $qa = new backup_nested_element($nameprefix . 'question_attempt', array('id'), array(
212                 'slot', 'behaviour', 'questionid', 'maxmark', 'minfraction',
213                 'flagged', 'questionsummary', 'rightanswer', 'responsesummary',
214                 'timemodified'));
216         $steps = new backup_nested_element($nameprefix . 'steps');
217         $step = new backup_nested_element($nameprefix . 'step', array('id'), array(
218                 'sequencenumber', 'state', 'fraction', 'timecreated', 'userid'));
220         $response = new backup_nested_element($nameprefix . 'response');
221         $variable = new backup_nested_element($nameprefix . 'variable', null,  array('name', 'value'));
223         // Build the tree
224         $element->add_child($quba);
225         $quba->add_child($qas);
226         $qas->add_child($qa);
227         $qa->add_child($steps);
228         $steps->add_child($step);
229         $step->add_child($response);
230         $response->add_child($variable);
232         // Set the sources
233         $quba->set_source_table('question_usages',
234                 array('id'                => '../' . $usageidname));
235         $qa->set_source_sql('
236                 SELECT *
237                 FROM {question_attempts}
238                 WHERE questionusageid = :questionusageid
239                 ORDER BY slot',
240                 array('questionusageid'   => backup::VAR_PARENTID));
241         $step->set_source_sql('
242                 SELECT *
243                 FROM {question_attempt_steps}
244                 WHERE questionattemptid = :questionattemptid
245                 ORDER BY sequencenumber',
246                 array('questionattemptid' => backup::VAR_PARENTID));
247         $variable->set_source_table('question_attempt_step_data',
248                 array('attemptstepid'     => backup::VAR_PARENTID));
250         // Annotate ids
251         $qa->annotate_ids('question', 'questionid');
252         $step->annotate_ids('user', 'userid');
254         // Annotate files
255         $fileareas = question_engine::get_all_response_file_areas();
256         foreach ($fileareas as $filearea) {
257             $step->annotate_files('question', $filearea, 'id');
258         }
259     }
263 /**
264  * backup structure step in charge of calculating the categories to be
265  * included in backup, based in the context being backuped (module/course)
266  * and the already annotated questions present in backup_ids_temp
267  */
268 class backup_calculate_question_categories extends backup_execution_step {
270     protected function define_execution() {
271         backup_question_dbops::calculate_question_categories($this->get_backupid(), $this->task->get_contextid());
272     }
275 /**
276  * backup structure step in charge of deleting all the questions annotated
277  * in the backup_ids_temp table
278  */
279 class backup_delete_temp_questions extends backup_execution_step {
281     protected function define_execution() {
282         backup_question_dbops::delete_temp_questions($this->get_backupid());
283     }
286 /**
287  * Abstract structure step, parent of all the block structure steps. Used to wrap the
288  * block structure definition within the main <block ...> tag
289  */
290 abstract class backup_block_structure_step extends backup_structure_step {
292     protected function prepare_block_structure($blockstructure) {
294         // Create the wrap element
295         $block = new backup_nested_element('block', array('id', 'blockname', 'contextid'), null);
297         // Build the tree
298         $block->add_child($blockstructure);
300         // Set the source
301         $blockarr = array((object)array(
302             'id'         => $this->task->get_blockid(),
303             'blockname'  => $this->task->get_blockname(),
304             'contextid'  => $this->task->get_contextid()));
306         $block->set_source_array($blockarr);
308         // Return the root element (block)
309         return $block;
310     }
313 /**
314  * structure step that will generate the module.xml file for the activity,
315  * accumulating various information about the activity, annotating groupings
316  * and completion/avail conf
317  */
318 class backup_module_structure_step extends backup_structure_step {
320     protected function define_structure() {
322         // Define each element separated
324         $module = new backup_nested_element('module', array('id', 'version'), array(
325             'modulename', 'sectionid', 'sectionnumber', 'idnumber',
326             'added', 'score', 'indent', 'visible',
327             'visibleold', 'groupmode', 'groupingid', 'groupmembersonly',
328             'completion', 'completiongradeitemnumber', 'completionview', 'completionexpected',
329             'availablefrom', 'availableuntil', 'showavailability', 'showdescription'));
331         $availinfo = new backup_nested_element('availability_info');
332         $availability = new backup_nested_element('availability', array('id'), array(
333             'sourcecmid', 'requiredcompletion', 'gradeitemid', 'grademin', 'grademax'));
334         $availabilityfield = new backup_nested_element('availability_field', array('id'), array(
335             'userfield', 'customfield', 'customfieldtype', 'operator', 'value'));
337         // attach format plugin structure to $module element, only one allowed
338         $this->add_plugin_structure('format', $module, false);
340         // attach plagiarism plugin structure to $module element, there can be potentially
341         // many plagiarism plugins storing information about this course
342         $this->add_plugin_structure('plagiarism', $module, true);
344         // Define the tree
345         $module->add_child($availinfo);
346         $availinfo->add_child($availability);
347         $availinfo->add_child($availabilityfield);
349         // Set the sources
350         $module->set_source_sql('
351             SELECT cm.*, m.version, m.name AS modulename, s.id AS sectionid, s.section AS sectionnumber
352               FROM {course_modules} cm
353               JOIN {modules} m ON m.id = cm.module
354               JOIN {course_sections} s ON s.id = cm.section
355              WHERE cm.id = ?', array(backup::VAR_MODID));
357         $availability->set_source_table('course_modules_availability', array('coursemoduleid' => backup::VAR_MODID));
358         $availabilityfield->set_source_sql('
359             SELECT cmaf.*, uif.shortname AS customfield, uif.datatype AS customfieldtype
360               FROM {course_modules_avail_fields} cmaf
361          LEFT JOIN {user_info_field} uif ON uif.id = cmaf.customfieldid
362              WHERE cmaf.coursemoduleid = ?', array(backup::VAR_MODID));
364         // Define annotations
365         $module->annotate_ids('grouping', 'groupingid');
367         // Return the root element ($module)
368         return $module;
369     }
372 /**
373  * structure step that will generate the section.xml file for the section
374  * annotating files
375  */
376 class backup_section_structure_step extends backup_structure_step {
378     protected function define_structure() {
380         // Define each element separated
382         $section = new backup_nested_element('section', array('id'), array(
383                 'number', 'name', 'summary', 'summaryformat', 'sequence', 'visible',
384                 'availablefrom', 'availableuntil', 'showavailability', 'groupingid'));
386         // attach format plugin structure to $section element, only one allowed
387         $this->add_plugin_structure('format', $section, false);
389         // Add nested elements for _availability table
390         $avail = new backup_nested_element('availability', array('id'), array(
391                 'sourcecmid', 'requiredcompletion', 'gradeitemid', 'grademin', 'grademax'));
392         $availfield = new backup_nested_element('availability_field', array('id'), array(
393             'userfield', 'operator', 'value', 'customfield', 'customfieldtype'));
394         $section->add_child($avail);
395         $section->add_child($availfield);
397         // Define sources
398         $section->set_source_table('course_sections', array('id' => backup::VAR_SECTIONID));
399         $avail->set_source_table('course_sections_availability', array('coursesectionid' => backup::VAR_SECTIONID));
400         $availfield->set_source_sql('
401             SELECT csaf.*, uif.shortname AS customfield, uif.datatype AS customfieldtype
402               FROM {course_sections_avail_fields} csaf
403          LEFT JOIN {user_info_field} uif ON uif.id = csaf.customfieldid
404              WHERE csaf.coursesectionid = ?', array(backup::VAR_SECTIONID));
406         // Aliases
407         $section->set_source_alias('section', 'number');
409         // Set annotations
410         $section->annotate_ids('grouping', 'groupingid');
411         $section->annotate_files('course', 'section', 'id');
413         return $section;
414     }
417 /**
418  * structure step that will generate the course.xml file for the course, including
419  * course category reference, tags, modules restriction information
420  * and some annotations (files & groupings)
421  */
422 class backup_course_structure_step extends backup_structure_step {
424     protected function define_structure() {
425         global $DB;
427         // Define each element separated
429         $course = new backup_nested_element('course', array('id', 'contextid'), array(
430             'shortname', 'fullname', 'idnumber',
431             'summary', 'summaryformat', 'format', 'coursedisplay', 'showgrades',
432             'newsitems', 'startdate', 'numsections',
433             'marker', 'maxbytes', 'legacyfiles', 'showreports',
434             'visible', 'hiddensections', 'groupmode', 'groupmodeforce',
435             'defaultgroupingid', 'lang', 'theme',
436             'timecreated', 'timemodified',
437             'requested',
438             'enablecompletion', 'completionstartonenrol', 'completionnotify'));
440         $category = new backup_nested_element('category', array('id'), array(
441             'name', 'description'));
443         $tags = new backup_nested_element('tags');
445         $tag = new backup_nested_element('tag', array('id'), array(
446             'name', 'rawname'));
448         // attach format plugin structure to $course element, only one allowed
449         $this->add_plugin_structure('format', $course, false);
451         // attach theme plugin structure to $course element; multiple themes can
452         // save course data (in case of user theme, legacy theme, etc)
453         $this->add_plugin_structure('theme', $course, true);
455         // attach general report plugin structure to $course element; multiple
456         // reports can save course data if required
457         $this->add_plugin_structure('report', $course, true);
459         // attach course report plugin structure to $course element; multiple
460         // course reports can save course data if required
461         $this->add_plugin_structure('coursereport', $course, true);
463         // attach plagiarism plugin structure to $course element, there can be potentially
464         // many plagiarism plugins storing information about this course
465         $this->add_plugin_structure('plagiarism', $course, true);
467         // Build the tree
469         $course->add_child($category);
471         $course->add_child($tags);
472         $tags->add_child($tag);
474         // Set the sources
476         $courserec = $DB->get_record('course', array('id' => $this->task->get_courseid()));
477         $courserec->contextid = $this->task->get_contextid();
479         $course->set_source_array(array($courserec));
481         $categoryrec = $DB->get_record('course_categories', array('id' => $courserec->category));
483         $category->set_source_array(array($categoryrec));
485         $tag->set_source_sql('SELECT t.id, t.name, t.rawname
486                                 FROM {tag} t
487                                 JOIN {tag_instance} ti ON ti.tagid = t.id
488                                WHERE ti.itemtype = ?
489                                  AND ti.itemid = ?', array(
490                                      backup_helper::is_sqlparam('course'),
491                                      backup::VAR_PARENTID));
493         // Some annotations
495         $course->annotate_ids('grouping', 'defaultgroupingid');
497         $course->annotate_files('course', 'summary', null);
498         $course->annotate_files('course', 'legacy', null);
500         // Return root element ($course)
502         return $course;
503     }
506 /**
507  * structure step that will generate the enrolments.xml file for the given course
508  */
509 class backup_enrolments_structure_step extends backup_structure_step {
511     protected function define_structure() {
513         // To know if we are including users
514         $users = $this->get_setting_value('users');
516         // Define each element separated
518         $enrolments = new backup_nested_element('enrolments');
520         $enrols = new backup_nested_element('enrols');
522         $enrol = new backup_nested_element('enrol', array('id'), array(
523             'enrol', 'status', 'sortorder', 'name', 'enrolperiod', 'enrolstartdate',
524             'enrolenddate', 'expirynotify', 'expirytreshold', 'notifyall',
525             'password', 'cost', 'currency', 'roleid', 'customint1', 'customint2', 'customint3',
526             'customint4', 'customchar1', 'customchar2', 'customdec1', 'customdec2',
527             'customtext1', 'customtext2', 'timecreated', 'timemodified'));
529         $userenrolments = new backup_nested_element('user_enrolments');
531         $enrolment = new backup_nested_element('enrolment', array('id'), array(
532             'status', 'userid', 'timestart', 'timeend', 'modifierid',
533             'timemodified'));
535         // Build the tree
536         $enrolments->add_child($enrols);
537         $enrols->add_child($enrol);
538         $enrol->add_child($userenrolments);
539         $userenrolments->add_child($enrolment);
541         // Define sources
543         $enrol->set_source_table('enrol', array('courseid' => backup::VAR_COURSEID));
545         // User enrolments only added only if users included
546         if ($users) {
547             $enrolment->set_source_table('user_enrolments', array('enrolid' => backup::VAR_PARENTID));
548             $enrolment->annotate_ids('user', 'userid');
549         }
551         $enrol->annotate_ids('role', 'roleid');
553         //TODO: let plugins annotate custom fields too and add more children
555         return $enrolments;
556     }
559 /**
560  * structure step that will generate the roles.xml file for the given context, observing
561  * the role_assignments setting to know if that part needs to be included
562  */
563 class backup_roles_structure_step extends backup_structure_step {
565     protected function define_structure() {
567         // To know if we are including role assignments
568         $roleassignments = $this->get_setting_value('role_assignments');
570         // Define each element separated
572         $roles = new backup_nested_element('roles');
574         $overrides = new backup_nested_element('role_overrides');
576         $override = new backup_nested_element('override', array('id'), array(
577             'roleid', 'capability', 'permission', 'timemodified',
578             'modifierid'));
580         $assignments = new backup_nested_element('role_assignments');
582         $assignment = new backup_nested_element('assignment', array('id'), array(
583             'roleid', 'userid', 'timemodified', 'modifierid', 'component', 'itemid',
584             'sortorder'));
586         // Build the tree
587         $roles->add_child($overrides);
588         $roles->add_child($assignments);
590         $overrides->add_child($override);
591         $assignments->add_child($assignment);
593         // Define sources
595         $override->set_source_table('role_capabilities', array('contextid' => backup::VAR_CONTEXTID));
597         // Assignments only added if specified
598         if ($roleassignments) {
599             $assignment->set_source_table('role_assignments', array('contextid' => backup::VAR_CONTEXTID));
600         }
602         // Define id annotations
603         $override->annotate_ids('role', 'roleid');
605         $assignment->annotate_ids('role', 'roleid');
607         $assignment->annotate_ids('user', 'userid');
609         //TODO: how do we annotate the itemid? the meaning depends on the content of component table (skodak)
611         return $roles;
612     }
615 /**
616  * structure step that will generate the roles.xml containing the
617  * list of roles used along the whole backup process. Just raw
618  * list of used roles from role table
619  */
620 class backup_final_roles_structure_step extends backup_structure_step {
622     protected function define_structure() {
624         // Define elements
626         $rolesdef = new backup_nested_element('roles_definition');
628         $role = new backup_nested_element('role', array('id'), array(
629             'name', 'shortname', 'nameincourse', 'description',
630             'sortorder', 'archetype'));
632         // Build the tree
634         $rolesdef->add_child($role);
636         // Define sources
638         $role->set_source_sql("SELECT r.*, rn.name AS nameincourse
639                                  FROM {role} r
640                                  JOIN {backup_ids_temp} bi ON r.id = bi.itemid
641                             LEFT JOIN {role_names} rn ON r.id = rn.roleid AND rn.contextid = ?
642                                 WHERE bi.backupid = ?
643                                   AND bi.itemname = 'rolefinal'", array(backup::VAR_CONTEXTID, backup::VAR_BACKUPID));
645         // Return main element (rolesdef)
646         return $rolesdef;
647     }
650 /**
651  * structure step that will generate the scales.xml containing the
652  * list of scales used along the whole backup process.
653  */
654 class backup_final_scales_structure_step extends backup_structure_step {
656     protected function define_structure() {
658         // Define elements
660         $scalesdef = new backup_nested_element('scales_definition');
662         $scale = new backup_nested_element('scale', array('id'), array(
663             'courseid', 'userid', 'name', 'scale',
664             'description', 'descriptionformat', 'timemodified'));
666         // Build the tree
668         $scalesdef->add_child($scale);
670         // Define sources
672         $scale->set_source_sql("SELECT s.*
673                                   FROM {scale} s
674                                   JOIN {backup_ids_temp} bi ON s.id = bi.itemid
675                                  WHERE bi.backupid = ?
676                                    AND bi.itemname = 'scalefinal'", array(backup::VAR_BACKUPID));
678         // Annotate scale files (they store files in system context, so pass it instead of default one)
679         $scale->annotate_files('grade', 'scale', 'id', context_system::instance()->id);
681         // Return main element (scalesdef)
682         return $scalesdef;
683     }
686 /**
687  * structure step that will generate the outcomes.xml containing the
688  * list of outcomes used along the whole backup process.
689  */
690 class backup_final_outcomes_structure_step extends backup_structure_step {
692     protected function define_structure() {
694         // Define elements
696         $outcomesdef = new backup_nested_element('outcomes_definition');
698         $outcome = new backup_nested_element('outcome', array('id'), array(
699             'courseid', 'userid', 'shortname', 'fullname',
700             'scaleid', 'description', 'descriptionformat', 'timecreated',
701             'timemodified','usermodified'));
703         // Build the tree
705         $outcomesdef->add_child($outcome);
707         // Define sources
709         $outcome->set_source_sql("SELECT o.*
710                                     FROM {grade_outcomes} o
711                                     JOIN {backup_ids_temp} bi ON o.id = bi.itemid
712                                    WHERE bi.backupid = ?
713                                      AND bi.itemname = 'outcomefinal'", array(backup::VAR_BACKUPID));
715         // Annotate outcome files (they store files in system context, so pass it instead of default one)
716         $outcome->annotate_files('grade', 'outcome', 'id', context_system::instance()->id);
718         // Return main element (outcomesdef)
719         return $outcomesdef;
720     }
723 /**
724  * structure step in charge of constructing the filters.xml file for all the filters found
725  * in activity
726  */
727 class backup_filters_structure_step extends backup_structure_step {
729     protected function define_structure() {
731         // Define each element separated
733         $filters = new backup_nested_element('filters');
735         $actives = new backup_nested_element('filter_actives');
737         $active = new backup_nested_element('filter_active', null, array('filter', 'active'));
739         $configs = new backup_nested_element('filter_configs');
741         $config = new backup_nested_element('filter_config', null, array('filter', 'name', 'value'));
743         // Build the tree
745         $filters->add_child($actives);
746         $filters->add_child($configs);
748         $actives->add_child($active);
749         $configs->add_child($config);
751         // Define sources
753         list($activearr, $configarr) = filter_get_all_local_settings($this->task->get_contextid());
755         $active->set_source_array($activearr);
756         $config->set_source_array($configarr);
758         // Return the root element (filters)
759         return $filters;
760     }
763 /**
764  * structure step in charge of constructing the comments.xml file for all the comments found
765  * in a given context
766  */
767 class backup_comments_structure_step extends backup_structure_step {
769     protected function define_structure() {
771         // Define each element separated
773         $comments = new backup_nested_element('comments');
775         $comment = new backup_nested_element('comment', array('id'), array(
776             'commentarea', 'itemid', 'content', 'format',
777             'userid', 'timecreated'));
779         // Build the tree
781         $comments->add_child($comment);
783         // Define sources
785         $comment->set_source_table('comments', array('contextid' => backup::VAR_CONTEXTID));
787         // Define id annotations
789         $comment->annotate_ids('user', 'userid');
791         // Return the root element (comments)
792         return $comments;
793     }
796 /**
797  * structure step in charge of constructing the calender.xml file for all the events found
798  * in a given context
799  */
800 class backup_calendarevents_structure_step extends backup_structure_step {
802     protected function define_structure() {
804         // Define each element separated
806         $events = new backup_nested_element('events');
808         $event = new backup_nested_element('event', array('id'), array(
809                 'name', 'description', 'format', 'courseid', 'groupid', 'userid',
810                 'repeatid', 'modulename', 'instance', 'eventtype', 'timestart',
811                 'timeduration', 'visible', 'uuid', 'sequence', 'timemodified'));
813         // Build the tree
814         $events->add_child($event);
816         // Define sources
817         if ($this->name == 'course_calendar') {
818             $calendar_items_sql ="SELECT * FROM {event}
819                         WHERE courseid = :courseid
820                         AND (eventtype = 'course' OR eventtype = 'group')";
821             $calendar_items_params = array('courseid'=>backup::VAR_COURSEID);
822             $event->set_source_sql($calendar_items_sql, $calendar_items_params);
823         } else {
824             $event->set_source_table('event', array('courseid' => backup::VAR_COURSEID, 'instance' => backup::VAR_ACTIVITYID, 'modulename' => backup::VAR_MODNAME));
825         }
827         // Define id annotations
829         $event->annotate_ids('user', 'userid');
830         $event->annotate_ids('group', 'groupid');
831         $event->annotate_files('calendar', 'event_description', 'id');
833         // Return the root element (events)
834         return $events;
835     }
838 /**
839  * structure step in charge of constructing the gradebook.xml file for all the gradebook config in the course
840  * NOTE: the backup of the grade items themselves is handled by backup_activity_grades_structure_step
841  */
842 class backup_gradebook_structure_step extends backup_structure_step {
844     /**
845      * We need to decide conditionally, based on dynamic information
846      * about the execution of this step. Only will be executed if all
847      * the module gradeitems have been already included in backup
848      */
849     protected function execute_condition() {
850         return backup_plan_dbops::require_gradebook_backup($this->get_courseid(), $this->get_backupid());
851     }
853     protected function define_structure() {
855         // are we including user info?
856         $userinfo = $this->get_setting_value('users');
858         $gradebook = new backup_nested_element('gradebook');
860         //grade_letters are done in backup_activity_grades_structure_step()
862         //calculated grade items
863         $grade_items = new backup_nested_element('grade_items');
864         $grade_item = new backup_nested_element('grade_item', array('id'), array(
865             'categoryid', 'itemname', 'itemtype', 'itemmodule',
866             'iteminstance', 'itemnumber', 'iteminfo', 'idnumber',
867             'calculation', 'gradetype', 'grademax', 'grademin',
868             'scaleid', 'outcomeid', 'gradepass', 'multfactor',
869             'plusfactor', 'aggregationcoef', 'sortorder', 'display',
870             'decimals', 'hidden', 'locked', 'locktime',
871             'needsupdate', 'timecreated', 'timemodified'));
873         $grade_grades = new backup_nested_element('grade_grades');
874         $grade_grade = new backup_nested_element('grade_grade', array('id'), array(
875             'userid', 'rawgrade', 'rawgrademax', 'rawgrademin',
876             'rawscaleid', 'usermodified', 'finalgrade', 'hidden',
877             'locked', 'locktime', 'exported', 'overridden',
878             'excluded', 'feedback', 'feedbackformat', 'information',
879             'informationformat', 'timecreated', 'timemodified'));
881         //grade_categories
882         $grade_categories = new backup_nested_element('grade_categories');
883         $grade_category   = new backup_nested_element('grade_category', array('id'), array(
884                 //'courseid',
885                 'parent', 'depth', 'path', 'fullname', 'aggregation', 'keephigh',
886                 'dropload', 'aggregateonlygraded', 'aggregateoutcomes', 'aggregatesubcats',
887                 'timecreated', 'timemodified', 'hidden'));
889         $letters = new backup_nested_element('grade_letters');
890         $letter = new backup_nested_element('grade_letter', 'id', array(
891             'lowerboundary', 'letter'));
893         $grade_settings = new backup_nested_element('grade_settings');
894         $grade_setting = new backup_nested_element('grade_setting', 'id', array(
895             'name', 'value'));
898         // Build the tree
899         $gradebook->add_child($grade_categories);
900         $grade_categories->add_child($grade_category);
902         $gradebook->add_child($grade_items);
903         $grade_items->add_child($grade_item);
904         $grade_item->add_child($grade_grades);
905         $grade_grades->add_child($grade_grade);
907         $gradebook->add_child($letters);
908         $letters->add_child($letter);
910         $gradebook->add_child($grade_settings);
911         $grade_settings->add_child($grade_setting);
913         // Define sources
915         //Include manual, category and the course grade item
916         $grade_items_sql ="SELECT * FROM {grade_items}
917                            WHERE courseid = :courseid
918                            AND (itemtype='manual' OR itemtype='course' OR itemtype='category')";
919         $grade_items_params = array('courseid'=>backup::VAR_COURSEID);
920         $grade_item->set_source_sql($grade_items_sql, $grade_items_params);
922         if ($userinfo) {
923             $grade_grade->set_source_table('grade_grades', array('itemid' => backup::VAR_PARENTID));
924         }
926         $grade_category_sql = "SELECT gc.*, gi.sortorder
927                                FROM {grade_categories} gc
928                                JOIN {grade_items} gi ON (gi.iteminstance = gc.id)
929                                WHERE gc.courseid = :courseid
930                                AND (gi.itemtype='course' OR gi.itemtype='category')
931                                ORDER BY gc.parent ASC";//need parent categories before their children
932         $grade_category_params = array('courseid'=>backup::VAR_COURSEID);
933         $grade_category->set_source_sql($grade_category_sql, $grade_category_params);
935         $letter->set_source_table('grade_letters', array('contextid' => backup::VAR_CONTEXTID));
937         $grade_setting->set_source_table('grade_settings', array('courseid' => backup::VAR_COURSEID));
939         // Annotations (both as final as far as they are going to be exported in next steps)
940         $grade_item->annotate_ids('scalefinal', 'scaleid'); // Straight as scalefinal because it's > 0
941         $grade_item->annotate_ids('outcomefinal', 'outcomeid');
943         //just in case there are any users not already annotated by the activities
944         $grade_grade->annotate_ids('userfinal', 'userid');
946         // Return the root element
947         return $gradebook;
948     }
951 /**
952  * structure step in charge if constructing the completion.xml file for all the users completion
953  * information in a given activity
954  */
955 class backup_userscompletion_structure_step extends backup_structure_step {
957     protected function define_structure() {
959         // Define each element separated
961         $completions = new backup_nested_element('completions');
963         $completion = new backup_nested_element('completion', array('id'), array(
964             'userid', 'completionstate', 'viewed', 'timemodified'));
966         // Build the tree
968         $completions->add_child($completion);
970         // Define sources
972         $completion->set_source_table('course_modules_completion', array('coursemoduleid' => backup::VAR_MODID));
974         // Define id annotations
976         $completion->annotate_ids('user', 'userid');
978         // Return the root element (completions)
979         return $completions;
980     }
983 /**
984  * structure step in charge of constructing the main groups.xml file for all the groups and
985  * groupings information already annotated
986  */
987 class backup_groups_structure_step extends backup_structure_step {
989     protected function define_structure() {
991         // To know if we are including users
992         $users = $this->get_setting_value('users');
994         // Define each element separated
996         $groups = new backup_nested_element('groups');
998         $group = new backup_nested_element('group', array('id'), array(
999             'name', 'idnumber', 'description', 'descriptionformat', 'enrolmentkey',
1000             'picture', 'hidepicture', 'timecreated', 'timemodified'));
1002         $members = new backup_nested_element('group_members');
1004         $member = new backup_nested_element('group_member', array('id'), array(
1005             'userid', 'timeadded'));
1007         $groupings = new backup_nested_element('groupings');
1009         $grouping = new backup_nested_element('grouping', 'id', array(
1010             'name', 'idnumber', 'description', 'descriptionformat', 'configdata',
1011             'timecreated', 'timemodified'));
1013         $groupinggroups = new backup_nested_element('grouping_groups');
1015         $groupinggroup = new backup_nested_element('grouping_group', array('id'), array(
1016             'groupid', 'timeadded'));
1018         // Build the tree
1020         $groups->add_child($group);
1021         $groups->add_child($groupings);
1023         $group->add_child($members);
1024         $members->add_child($member);
1026         $groupings->add_child($grouping);
1027         $grouping->add_child($groupinggroups);
1028         $groupinggroups->add_child($groupinggroup);
1030         // Define sources
1032         $group->set_source_sql("
1033             SELECT g.*
1034               FROM {groups} g
1035               JOIN {backup_ids_temp} bi ON g.id = bi.itemid
1036              WHERE bi.backupid = ?
1037                AND bi.itemname = 'groupfinal'", array(backup::VAR_BACKUPID));
1039         // This only happens if we are including users
1040         if ($users) {
1041             $member->set_source_table('groups_members', array('groupid' => backup::VAR_PARENTID));
1042         }
1044         $grouping->set_source_sql("
1045             SELECT g.*
1046               FROM {groupings} g
1047               JOIN {backup_ids_temp} bi ON g.id = bi.itemid
1048              WHERE bi.backupid = ?
1049                AND bi.itemname = 'groupingfinal'", array(backup::VAR_BACKUPID));
1051         $groupinggroup->set_source_table('groupings_groups', array('groupingid' => backup::VAR_PARENTID));
1053         // Define id annotations (as final)
1055         $member->annotate_ids('userfinal', 'userid');
1057         // Define file annotations
1059         $group->annotate_files('group', 'description', 'id');
1060         $group->annotate_files('group', 'icon', 'id');
1061         $grouping->annotate_files('grouping', 'description', 'id');
1063         // Return the root element (groups)
1064         return $groups;
1065     }
1068 /**
1069  * structure step in charge of constructing the main users.xml file for all the users already
1070  * annotated (final). Includes custom profile fields, preferences, tags, role assignments and
1071  * overrides.
1072  */
1073 class backup_users_structure_step extends backup_structure_step {
1075     protected function define_structure() {
1076         global $CFG;
1078         // To know if we are anonymizing users
1079         $anonymize = $this->get_setting_value('anonymize');
1080         // To know if we are including role assignments
1081         $roleassignments = $this->get_setting_value('role_assignments');
1083         // Define each element separated
1085         $users = new backup_nested_element('users');
1087         // Create the array of user fields by hand, as far as we have various bits to control
1088         // anonymize option, password backup, mnethostid...
1090         // First, the fields not needing anonymization nor special handling
1091         $normalfields = array(
1092             'confirmed', 'policyagreed', 'deleted',
1093             'lang', 'theme', 'timezone', 'firstaccess',
1094             'lastaccess', 'lastlogin', 'currentlogin',
1095             'mailformat', 'maildigest', 'maildisplay', 'htmleditor',
1096             'autosubscribe', 'trackforums', 'timecreated',
1097             'timemodified', 'trustbitmask', 'screenreader');
1099         // Then, the fields potentially needing anonymization
1100         $anonfields = array(
1101             'username', 'idnumber', 'firstname', 'lastname',
1102             'email', 'icq', 'skype',
1103             'yahoo', 'aim', 'msn', 'phone1',
1104             'phone2', 'institution', 'department', 'address',
1105             'city', 'country', 'lastip', 'picture',
1106             'url', 'description', 'descriptionformat', 'imagealt', 'auth');
1108         // Add anonymized fields to $userfields with custom final element
1109         foreach ($anonfields as $field) {
1110             if ($anonymize) {
1111                 $userfields[] = new anonymizer_final_element($field);
1112             } else {
1113                 $userfields[] = $field; // No anonymization, normally added
1114             }
1115         }
1117         // mnethosturl requires special handling (custom final element)
1118         $userfields[] = new mnethosturl_final_element('mnethosturl');
1120         // password added conditionally
1121         if (!empty($CFG->includeuserpasswordsinbackup)) {
1122             $userfields[] = 'password';
1123         }
1125         // Merge all the fields
1126         $userfields = array_merge($userfields, $normalfields);
1128         $user = new backup_nested_element('user', array('id', 'contextid'), $userfields);
1130         $customfields = new backup_nested_element('custom_fields');
1132         $customfield = new backup_nested_element('custom_field', array('id'), array(
1133             'field_name', 'field_type', 'field_data'));
1135         $tags = new backup_nested_element('tags');
1137         $tag = new backup_nested_element('tag', array('id'), array(
1138             'name', 'rawname'));
1140         $preferences = new backup_nested_element('preferences');
1142         $preference = new backup_nested_element('preference', array('id'), array(
1143             'name', 'value'));
1145         $roles = new backup_nested_element('roles');
1147         $overrides = new backup_nested_element('role_overrides');
1149         $override = new backup_nested_element('override', array('id'), array(
1150             'roleid', 'capability', 'permission', 'timemodified',
1151             'modifierid'));
1153         $assignments = new backup_nested_element('role_assignments');
1155         $assignment = new backup_nested_element('assignment', array('id'), array(
1156             'roleid', 'userid', 'timemodified', 'modifierid', 'component', //TODO: MDL-22793 add itemid here
1157             'sortorder'));
1159         // Build the tree
1161         $users->add_child($user);
1163         $user->add_child($customfields);
1164         $customfields->add_child($customfield);
1166         $user->add_child($tags);
1167         $tags->add_child($tag);
1169         $user->add_child($preferences);
1170         $preferences->add_child($preference);
1172         $user->add_child($roles);
1174         $roles->add_child($overrides);
1175         $roles->add_child($assignments);
1177         $overrides->add_child($override);
1178         $assignments->add_child($assignment);
1180         // Define sources
1182         $user->set_source_sql('SELECT u.*, c.id AS contextid, m.wwwroot AS mnethosturl
1183                                  FROM {user} u
1184                                  JOIN {backup_ids_temp} bi ON bi.itemid = u.id
1185                             LEFT JOIN {context} c ON c.instanceid = u.id AND c.contextlevel = ' . CONTEXT_USER . '
1186                             LEFT JOIN {mnet_host} m ON m.id = u.mnethostid
1187                                 WHERE bi.backupid = ?
1188                                   AND bi.itemname = ?', array(
1189                                       backup_helper::is_sqlparam($this->get_backupid()),
1190                                       backup_helper::is_sqlparam('userfinal')));
1192         // All the rest on information is only added if we arent
1193         // in an anonymized backup
1194         if (!$anonymize) {
1195             $customfield->set_source_sql('SELECT f.id, f.shortname, f.datatype, d.data
1196                                             FROM {user_info_field} f
1197                                             JOIN {user_info_data} d ON d.fieldid = f.id
1198                                            WHERE d.userid = ?', array(backup::VAR_PARENTID));
1200             $customfield->set_source_alias('shortname', 'field_name');
1201             $customfield->set_source_alias('datatype',  'field_type');
1202             $customfield->set_source_alias('data',      'field_data');
1204             $tag->set_source_sql('SELECT t.id, t.name, t.rawname
1205                                     FROM {tag} t
1206                                     JOIN {tag_instance} ti ON ti.tagid = t.id
1207                                    WHERE ti.itemtype = ?
1208                                      AND ti.itemid = ?', array(
1209                                          backup_helper::is_sqlparam('user'),
1210                                          backup::VAR_PARENTID));
1212             $preference->set_source_table('user_preferences', array('userid' => backup::VAR_PARENTID));
1214             $override->set_source_table('role_capabilities', array('contextid' => '/users/user/contextid'));
1216             // Assignments only added if specified
1217             if ($roleassignments) {
1218                 $assignment->set_source_table('role_assignments', array('contextid' => '/users/user/contextid'));
1219             }
1221             // Define id annotations (as final)
1222             $override->annotate_ids('rolefinal', 'roleid');
1223         }
1225         // Return root element (users)
1226         return $users;
1227     }
1230 /**
1231  * structure step in charge of constructing the block.xml file for one
1232  * given block (instance and positions). If the block has custom DB structure
1233  * that will go to a separate file (different step defined in block class)
1234  */
1235 class backup_block_instance_structure_step extends backup_structure_step {
1237     protected function define_structure() {
1238         global $DB;
1240         // Define each element separated
1242         $block = new backup_nested_element('block', array('id', 'contextid', 'version'), array(
1243             'blockname', 'parentcontextid', 'showinsubcontexts', 'pagetypepattern',
1244             'subpagepattern', 'defaultregion', 'defaultweight', 'configdata'));
1246         $positions = new backup_nested_element('block_positions');
1248         $position = new backup_nested_element('block_position', array('id'), array(
1249             'contextid', 'pagetype', 'subpage', 'visible',
1250             'region', 'weight'));
1252         // Build the tree
1254         $block->add_child($positions);
1255         $positions->add_child($position);
1257         // Transform configdata information if needed (process links and friends)
1258         $blockrec = $DB->get_record('block_instances', array('id' => $this->task->get_blockid()));
1259         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
1260             $configdata = (array)unserialize(base64_decode($blockrec->configdata));
1261             foreach ($configdata as $attribute => $value) {
1262                 if (in_array($attribute, $attrstotransform)) {
1263                     $configdata[$attribute] = $this->contenttransformer->process($value);
1264                 }
1265             }
1266             $blockrec->configdata = base64_encode(serialize((object)$configdata));
1267         }
1268         $blockrec->contextid = $this->task->get_contextid();
1269         // Get the version of the block
1270         $blockrec->version = $DB->get_field('block', 'version', array('name' => $this->task->get_blockname()));
1272         // Define sources
1274         $block->set_source_array(array($blockrec));
1276         $position->set_source_table('block_positions', array('blockinstanceid' => backup::VAR_PARENTID));
1278         // File anotations (for fileareas specified on each block)
1279         foreach ($this->task->get_fileareas() as $filearea) {
1280             $block->annotate_files('block_' . $this->task->get_blockname(), $filearea, null);
1281         }
1283         // Return the root element (block)
1284         return $block;
1285     }
1288 /**
1289  * structure step in charge of constructing the logs.xml file for all the log records found
1290  * in course. Note that we are sending to backup ALL the log records having cmid = 0. That
1291  * includes some records that won't be restoreable (like 'upload', 'calendar'...) but we do
1292  * that just in case they become restored some day in the future
1293  */
1294 class backup_course_logs_structure_step extends backup_structure_step {
1296     protected function define_structure() {
1298         // Define each element separated
1300         $logs = new backup_nested_element('logs');
1302         $log = new backup_nested_element('log', array('id'), array(
1303             'time', 'userid', 'ip', 'module',
1304             'action', 'url', 'info'));
1306         // Build the tree
1308         $logs->add_child($log);
1310         // Define sources (all the records belonging to the course, having cmid = 0)
1312         $log->set_source_table('log', array('course' => backup::VAR_COURSEID, 'cmid' => backup_helper::is_sqlparam(0)));
1314         // Annotations
1315         // NOTE: We don't annotate users from logs as far as they MUST be
1316         //       always annotated by the course (enrol, ras... whatever)
1318         // Return the root element (logs)
1320         return $logs;
1321     }
1324 /**
1325  * structure step in charge of constructing the logs.xml file for all the log records found
1326  * in activity
1327  */
1328 class backup_activity_logs_structure_step extends backup_structure_step {
1330     protected function define_structure() {
1332         // Define each element separated
1334         $logs = new backup_nested_element('logs');
1336         $log = new backup_nested_element('log', array('id'), array(
1337             'time', 'userid', 'ip', 'module',
1338             'action', 'url', 'info'));
1340         // Build the tree
1342         $logs->add_child($log);
1344         // Define sources
1346         $log->set_source_table('log', array('cmid' => backup::VAR_MODID));
1348         // Annotations
1349         // NOTE: We don't annotate users from logs as far as they MUST be
1350         //       always annotated by the activity (true participants).
1352         // Return the root element (logs)
1354         return $logs;
1355     }
1358 /**
1359  * structure in charge of constructing the inforef.xml file for all the items we want
1360  * to have referenced there (users, roles, files...)
1361  */
1362 class backup_inforef_structure_step extends backup_structure_step {
1364     protected function define_structure() {
1366         // Items we want to include in the inforef file.
1367         $items = backup_helper::get_inforef_itemnames();
1369         // Build the tree
1371         $inforef = new backup_nested_element('inforef');
1373         // For each item, conditionally, if there are already records, build element
1374         foreach ($items as $itemname) {
1375             if (backup_structure_dbops::annotations_exist($this->get_backupid(), $itemname)) {
1376                 $elementroot = new backup_nested_element($itemname . 'ref');
1377                 $element = new backup_nested_element($itemname, array(), array('id'));
1378                 $inforef->add_child($elementroot);
1379                 $elementroot->add_child($element);
1380                 $element->set_source_sql("
1381                     SELECT itemid AS id
1382                      FROM {backup_ids_temp}
1383                     WHERE backupid = ?
1384                       AND itemname = ?",
1385                    array(backup::VAR_BACKUPID, backup_helper::is_sqlparam($itemname)));
1386             }
1387         }
1389         // We don't annotate anything there, but rely in the next step
1390         // (move_inforef_annotations_to_final) that will change all the
1391         // already saved 'inforref' entries to their 'final' annotations.
1392         return $inforef;
1393     }
1396 /**
1397  * This step will get all the annotations already processed to inforef.xml file and
1398  * transform them into 'final' annotations.
1399  */
1400 class move_inforef_annotations_to_final extends backup_execution_step {
1402     protected function define_execution() {
1404         // Items we want to include in the inforef file
1405         $items = backup_helper::get_inforef_itemnames();
1406         foreach ($items as $itemname) {
1407             // Delegate to dbops
1408             backup_structure_dbops::move_annotations_to_final($this->get_backupid(), $itemname);
1409         }
1410     }
1413 /**
1414  * structure in charge of constructing the files.xml file with all the
1415  * annotated (final) files along the process. At, the same time, and
1416  * using one specialised nested_element, will copy them form moodle storage
1417  * to backup storage
1418  */
1419 class backup_final_files_structure_step extends backup_structure_step {
1421     protected function define_structure() {
1423         // Define elements
1425         $files = new backup_nested_element('files');
1427         $file = new file_nested_element('file', array('id'), array(
1428             'contenthash', 'contextid', 'component', 'filearea', 'itemid',
1429             'filepath', 'filename', 'userid', 'filesize',
1430             'mimetype', 'status', 'timecreated', 'timemodified',
1431             'source', 'author', 'license', 'sortorder',
1432             'repositorytype', 'repositoryid', 'reference'));
1434         // Build the tree
1436         $files->add_child($file);
1438         // Define sources
1440         $file->set_source_sql("SELECT f.*, r.type AS repositorytype, fr.repositoryid, fr.reference
1441                                  FROM {files} f
1442                                       LEFT JOIN {files_reference} fr ON fr.id = f.referencefileid
1443                                       LEFT JOIN {repository_instances} ri ON ri.id = fr.repositoryid
1444                                       LEFT JOIN {repository} r ON r.id = ri.typeid
1445                                       JOIN {backup_ids_temp} bi ON f.id = bi.itemid
1446                                 WHERE bi.backupid = ?
1447                                   AND bi.itemname = 'filefinal'", array(backup::VAR_BACKUPID));
1449         return $files;
1450     }
1453 /**
1454  * Structure step in charge of creating the main moodle_backup.xml file
1455  * where all the information related to the backup, settings, license and
1456  * other information needed on restore is added*/
1457 class backup_main_structure_step extends backup_structure_step {
1459     protected function define_structure() {
1461         global $CFG;
1463         $info = array();
1465         $info['name'] = $this->get_setting_value('filename');
1466         $info['moodle_version'] = $CFG->version;
1467         $info['moodle_release'] = $CFG->release;
1468         $info['backup_version'] = $CFG->backup_version;
1469         $info['backup_release'] = $CFG->backup_release;
1470         $info['backup_date']    = time();
1471         $info['backup_uniqueid']= $this->get_backupid();
1472         $info['mnet_remoteusers']=backup_controller_dbops::backup_includes_mnet_remote_users($this->get_backupid());
1473         $info['include_file_references_to_external_content'] =
1474                 backup_controller_dbops::backup_includes_file_references($this->get_backupid());
1475         $info['original_wwwroot']=$CFG->wwwroot;
1476         $info['original_site_identifier_hash'] = md5(get_site_identifier());
1477         $info['original_course_id'] = $this->get_courseid();
1478         $originalcourseinfo = backup_controller_dbops::backup_get_original_course_info($this->get_courseid());
1479         $info['original_course_fullname']  = $originalcourseinfo->fullname;
1480         $info['original_course_shortname'] = $originalcourseinfo->shortname;
1481         $info['original_course_startdate'] = $originalcourseinfo->startdate;
1482         $info['original_course_contextid'] = context_course::instance($this->get_courseid())->id;
1483         $info['original_system_contextid'] = context_system::instance()->id;
1485         // Get more information from controller
1486         list($dinfo, $cinfo, $sinfo) = backup_controller_dbops::get_moodle_backup_information($this->get_backupid());
1488         // Define elements
1490         $moodle_backup = new backup_nested_element('moodle_backup');
1492         $information = new backup_nested_element('information', null, array(
1493             'name', 'moodle_version', 'moodle_release', 'backup_version',
1494             'backup_release', 'backup_date', 'mnet_remoteusers', 'include_file_references_to_external_content', 'original_wwwroot',
1495             'original_site_identifier_hash', 'original_course_id',
1496             'original_course_fullname', 'original_course_shortname', 'original_course_startdate',
1497             'original_course_contextid', 'original_system_contextid'));
1499         $details = new backup_nested_element('details');
1501         $detail = new backup_nested_element('detail', array('backup_id'), array(
1502             'type', 'format', 'interactive', 'mode',
1503             'execution', 'executiontime'));
1505         $contents = new backup_nested_element('contents');
1507         $activities = new backup_nested_element('activities');
1509         $activity = new backup_nested_element('activity', null, array(
1510             'moduleid', 'sectionid', 'modulename', 'title',
1511             'directory'));
1513         $sections = new backup_nested_element('sections');
1515         $section = new backup_nested_element('section', null, array(
1516             'sectionid', 'title', 'directory'));
1518         $course = new backup_nested_element('course', null, array(
1519             'courseid', 'title', 'directory'));
1521         $settings = new backup_nested_element('settings');
1523         $setting = new backup_nested_element('setting', null, array(
1524             'level', 'section', 'activity', 'name', 'value'));
1526         // Build the tree
1528         $moodle_backup->add_child($information);
1530         $information->add_child($details);
1531         $details->add_child($detail);
1533         $information->add_child($contents);
1534         if (!empty($cinfo['activities'])) {
1535             $contents->add_child($activities);
1536             $activities->add_child($activity);
1537         }
1538         if (!empty($cinfo['sections'])) {
1539             $contents->add_child($sections);
1540             $sections->add_child($section);
1541         }
1542         if (!empty($cinfo['course'])) {
1543             $contents->add_child($course);
1544         }
1546         $information->add_child($settings);
1547         $settings->add_child($setting);
1550         // Set the sources
1552         $information->set_source_array(array((object)$info));
1554         $detail->set_source_array($dinfo);
1556         $activity->set_source_array($cinfo['activities']);
1558         $section->set_source_array($cinfo['sections']);
1560         $course->set_source_array($cinfo['course']);
1562         $setting->set_source_array($sinfo);
1564         // Prepare some information to be sent to main moodle_backup.xml file
1565         return $moodle_backup;
1566     }
1570 /**
1571  * Execution step that will generate the final zip (.mbz) file with all the contents
1572  */
1573 class backup_zip_contents extends backup_execution_step {
1575     protected function define_execution() {
1577         // Get basepath
1578         $basepath = $this->get_basepath();
1580         // Get the list of files in directory
1581         $filestemp = get_directory_list($basepath, '', false, true, true);
1582         $files = array();
1583         foreach ($filestemp as $file) { // Add zip paths and fs paths to all them
1584             $files[$file] = $basepath . '/' . $file;
1585         }
1587         // Add the log file if exists
1588         $logfilepath = $basepath . '.log';
1589         if (file_exists($logfilepath)) {
1590              $files['moodle_backup.log'] = $logfilepath;
1591         }
1593         // Calculate the zip fullpath (in OS temp area it's always backup.mbz)
1594         $zipfile = $basepath . '/backup.mbz';
1596         // Get the zip packer
1597         $zippacker = get_file_packer('application/zip');
1599         // Zip files
1600         $zippacker->archive_to_pathname($files, $zipfile);
1601     }
1604 /**
1605  * This step will send the generated backup file to its final destination
1606  */
1607 class backup_store_backup_file extends backup_execution_step {
1609     protected function define_execution() {
1611         // Get basepath
1612         $basepath = $this->get_basepath();
1614         // Calculate the zip fullpath (in OS temp area it's always backup.mbz)
1615         $zipfile = $basepath . '/backup.mbz';
1617         $has_file_references = backup_controller_dbops::backup_includes_file_references($this->get_backupid());
1618         // Perform storage and return it (TODO: shouldn't be array but proper result object)
1619         return array(
1620             'backup_destination' => backup_helper::store_backup_file($this->get_backupid(), $zipfile),
1621             'include_file_references_to_external_content' => $has_file_references
1622         );
1623     }
1627 /**
1628  * This step will search for all the activity (not calculations, categories nor aggregations) grade items
1629  * and put them to the backup_ids tables, to be used later as base to backup them
1630  */
1631 class backup_activity_grade_items_to_ids extends backup_execution_step {
1633     protected function define_execution() {
1635         // Fetch all activity grade items
1636         if ($items = grade_item::fetch_all(array(
1637                          'itemtype' => 'mod', 'itemmodule' => $this->task->get_modulename(),
1638                          'iteminstance' => $this->task->get_activityid(), 'courseid' => $this->task->get_courseid()))) {
1639             // Annotate them in backup_ids
1640             foreach ($items as $item) {
1641                 backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'grade_item', $item->id);
1642             }
1643         }
1644     }
1647 /**
1648  * This step will annotate all the groups and groupings belonging to the course
1649  */
1650 class backup_annotate_course_groups_and_groupings extends backup_execution_step {
1652     protected function define_execution() {
1653         global $DB;
1655         // Get all the course groups
1656         if ($groups = $DB->get_records('groups', array(
1657                 'courseid' => $this->task->get_courseid()))) {
1658             foreach ($groups as $group) {
1659                 backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'group', $group->id);
1660             }
1661         }
1663         // Get all the course groupings
1664         if ($groupings = $DB->get_records('groupings', array(
1665                 'courseid' => $this->task->get_courseid()))) {
1666             foreach ($groupings as $grouping) {
1667                 backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'grouping', $grouping->id);
1668             }
1669         }
1670     }
1673 /**
1674  * This step will annotate all the groups belonging to already annotated groupings
1675  */
1676 class backup_annotate_groups_from_groupings extends backup_execution_step {
1678     protected function define_execution() {
1679         global $DB;
1681         // Fetch all the annotated groupings
1682         if ($groupings = $DB->get_records('backup_ids_temp', array(
1683                 'backupid' => $this->get_backupid(), 'itemname' => 'grouping'))) {
1684             foreach ($groupings as $grouping) {
1685                 if ($groups = $DB->get_records('groupings_groups', array(
1686                         'groupingid' => $grouping->itemid))) {
1687                     foreach ($groups as $group) {
1688                         backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'group', $group->groupid);
1689                     }
1690                 }
1691             }
1692         }
1693     }
1696 /**
1697  * This step will annotate all the scales belonging to already annotated outcomes
1698  */
1699 class backup_annotate_scales_from_outcomes extends backup_execution_step {
1701     protected function define_execution() {
1702         global $DB;
1704         // Fetch all the annotated outcomes
1705         if ($outcomes = $DB->get_records('backup_ids_temp', array(
1706                 'backupid' => $this->get_backupid(), 'itemname' => 'outcome'))) {
1707             foreach ($outcomes as $outcome) {
1708                 if ($scale = $DB->get_record('grade_outcomes', array(
1709                         'id' => $outcome->itemid))) {
1710                     // Annotate as scalefinal because it's > 0
1711                     backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'scalefinal', $scale->scaleid);
1712                 }
1713             }
1714         }
1715     }
1718 /**
1719  * This step will generate all the file annotations for the already
1720  * annotated (final) question_categories. It calculates the different
1721  * contexts that are being backup and, annotates all the files
1722  * on every context belonging to the "question" component. As far as
1723  * we are always including *complete* question banks it is safe and
1724  * optimal to do that in this (one pass) way
1725  */
1726 class backup_annotate_all_question_files extends backup_execution_step {
1728     protected function define_execution() {
1729         global $DB;
1731         // Get all the different contexts for the final question_categories
1732         // annotated along the whole backup
1733         $rs = $DB->get_recordset_sql("SELECT DISTINCT qc.contextid
1734                                         FROM {question_categories} qc
1735                                         JOIN {backup_ids_temp} bi ON bi.itemid = qc.id
1736                                        WHERE bi.backupid = ?
1737                                          AND bi.itemname = 'question_categoryfinal'", array($this->get_backupid()));
1738         // To know about qtype specific components/fileareas
1739         $components = backup_qtype_plugin::get_components_and_fileareas();
1740         // Let's loop
1741         foreach($rs as $record) {
1742             // We don't need to specify filearea nor itemid as far as by
1743             // component and context it's enough to annotate the whole bank files
1744             // This backups "questiontext", "generalfeedback" and "answerfeedback" fileareas (all them
1745             // belonging to the "question" component
1746             backup_structure_dbops::annotate_files($this->get_backupid(), $record->contextid, 'question', null, null);
1747             // Again, it is enough to pick files only by context and component
1748             // Do it for qtype specific components
1749             foreach ($components as $component => $fileareas) {
1750                 backup_structure_dbops::annotate_files($this->get_backupid(), $record->contextid, $component, null, null);
1751             }
1752         }
1753         $rs->close();
1754     }
1757 /**
1758  * structure step in charge of constructing the questions.xml file for all the
1759  * question categories and questions required by the backup
1760  * and letters related to one activity
1761  */
1762 class backup_questions_structure_step extends backup_structure_step {
1764     protected function define_structure() {
1766         // Define each element separated
1768         $qcategories = new backup_nested_element('question_categories');
1770         $qcategory = new backup_nested_element('question_category', array('id'), array(
1771             'name', 'contextid', 'contextlevel', 'contextinstanceid',
1772             'info', 'infoformat', 'stamp', 'parent',
1773             'sortorder'));
1775         $questions = new backup_nested_element('questions');
1777         $question = new backup_nested_element('question', array('id'), array(
1778             'parent', 'name', 'questiontext', 'questiontextformat',
1779             'generalfeedback', 'generalfeedbackformat', 'defaultmark', 'penalty',
1780             'qtype', 'length', 'stamp', 'version',
1781             'hidden', 'timecreated', 'timemodified', 'createdby', 'modifiedby'));
1783         // attach qtype plugin structure to $question element, only one allowed
1784         $this->add_plugin_structure('qtype', $question, false);
1786         $qhints = new backup_nested_element('question_hints');
1788         $qhint = new backup_nested_element('question_hint', array('id'), array(
1789             'hint', 'hintformat', 'shownumcorrect', 'clearwrong', 'options'));
1791         // Build the tree
1793         $qcategories->add_child($qcategory);
1794         $qcategory->add_child($questions);
1795         $questions->add_child($question);
1796         $question->add_child($qhints);
1797         $qhints->add_child($qhint);
1799         // Define the sources
1801         $qcategory->set_source_sql("
1802             SELECT gc.*, contextlevel, instanceid AS contextinstanceid
1803               FROM {question_categories} gc
1804               JOIN {backup_ids_temp} bi ON bi.itemid = gc.id
1805               JOIN {context} co ON co.id = gc.contextid
1806              WHERE bi.backupid = ?
1807                AND bi.itemname = 'question_categoryfinal'", array(backup::VAR_BACKUPID));
1809         $question->set_source_table('question', array('category' => backup::VAR_PARENTID));
1811         $qhint->set_source_sql('
1812                 SELECT *
1813                 FROM {question_hints}
1814                 WHERE questionid = :questionid
1815                 ORDER BY id',
1816                 array('questionid' => backup::VAR_PARENTID));
1818         // don't need to annotate ids nor files
1819         // (already done by {@link backup_annotate_all_question_files}
1821         return $qcategories;
1822     }
1827 /**
1828  * This step will generate all the file  annotations for the already
1829  * annotated (final) users. Need to do this here because each user
1830  * has its own context and structure tasks only are able to handle
1831  * one context. Also, this step will guarantee that every user has
1832  * its context created (req for other steps)
1833  */
1834 class backup_annotate_all_user_files extends backup_execution_step {
1836     protected function define_execution() {
1837         global $DB;
1839         // List of fileareas we are going to annotate
1840         $fileareas = array('profile', 'icon');
1842         // Fetch all annotated (final) users
1843         $rs = $DB->get_recordset('backup_ids_temp', array(
1844             'backupid' => $this->get_backupid(), 'itemname' => 'userfinal'));
1845         foreach ($rs as $record) {
1846             $userid = $record->itemid;
1847             $userctx = context_user::instance($userid, IGNORE_MISSING);
1848             if (!$userctx) {
1849                 continue; // User has not context, sure it's a deleted user, so cannot have files
1850             }
1851             // Proceed with every user filearea
1852             foreach ($fileareas as $filearea) {
1853                 // We don't need to specify itemid ($userid - 5th param) as far as by
1854                 // context we can get all the associated files. See MDL-22092
1855                 backup_structure_dbops::annotate_files($this->get_backupid(), $userctx->id, 'user', $filearea, null);
1856             }
1857         }
1858         $rs->close();
1859     }
1863 /**
1864  * Defines the backup step for advanced grading methods attached to the activity module
1865  */
1866 class backup_activity_grading_structure_step extends backup_structure_step {
1868     /**
1869      * Include the grading.xml only if the module supports advanced grading
1870      */
1871     protected function execute_condition() {
1872         return plugin_supports('mod', $this->get_task()->get_modulename(), FEATURE_ADVANCED_GRADING, false);
1873     }
1875     /**
1876      * Declares the gradable areas structures and data sources
1877      */
1878     protected function define_structure() {
1880         // To know if we are including userinfo
1881         $userinfo = $this->get_setting_value('userinfo');
1883         // Define the elements
1885         $areas = new backup_nested_element('areas');
1887         $area = new backup_nested_element('area', array('id'), array(
1888             'areaname', 'activemethod'));
1890         $definitions = new backup_nested_element('definitions');
1892         $definition = new backup_nested_element('definition', array('id'), array(
1893             'method', 'name', 'description', 'descriptionformat', 'status',
1894             'timecreated', 'timemodified', 'options'));
1896         $instances = new backup_nested_element('instances');
1898         $instance = new backup_nested_element('instance', array('id'), array(
1899             'raterid', 'itemid', 'rawgrade', 'status', 'feedback',
1900             'feedbackformat', 'timemodified'));
1902         // Build the tree including the method specific structures
1903         // (beware - the order of how gradingform plugins structures are attached is important)
1904         $areas->add_child($area);
1905         $area->add_child($definitions);
1906         $definitions->add_child($definition);
1907         $this->add_plugin_structure('gradingform', $definition, true);
1908         $definition->add_child($instances);
1909         $instances->add_child($instance);
1910         $this->add_plugin_structure('gradingform', $instance, false);
1912         // Define data sources
1914         $area->set_source_table('grading_areas', array('contextid' => backup::VAR_CONTEXTID,
1915             'component' => array('sqlparam' => 'mod_'.$this->get_task()->get_modulename())));
1917         $definition->set_source_table('grading_definitions', array('areaid' => backup::VAR_PARENTID));
1919         if ($userinfo) {
1920             $instance->set_source_table('grading_instances', array('definitionid' => backup::VAR_PARENTID));
1921         }
1923         // Annotate references
1924         $definition->annotate_files('grading', 'description', 'id');
1925         $instance->annotate_ids('user', 'raterid');
1927         // Return the root element
1928         return $areas;
1929     }
1933 /**
1934  * structure step in charge of constructing the grades.xml file for all the grade items
1935  * and letters related to one activity
1936  */
1937 class backup_activity_grades_structure_step extends backup_structure_step {
1939     protected function define_structure() {
1941         // To know if we are including userinfo
1942         $userinfo = $this->get_setting_value('userinfo');
1944         // Define each element separated
1946         $book = new backup_nested_element('activity_gradebook');
1948         $items = new backup_nested_element('grade_items');
1950         $item = new backup_nested_element('grade_item', array('id'), array(
1951             'categoryid', 'itemname', 'itemtype', 'itemmodule',
1952             'iteminstance', 'itemnumber', 'iteminfo', 'idnumber',
1953             'calculation', 'gradetype', 'grademax', 'grademin',
1954             'scaleid', 'outcomeid', 'gradepass', 'multfactor',
1955             'plusfactor', 'aggregationcoef', 'sortorder', 'display',
1956             'decimals', 'hidden', 'locked', 'locktime',
1957             'needsupdate', 'timecreated', 'timemodified'));
1959         $grades = new backup_nested_element('grade_grades');
1961         $grade = new backup_nested_element('grade_grade', array('id'), array(
1962             'userid', 'rawgrade', 'rawgrademax', 'rawgrademin',
1963             'rawscaleid', 'usermodified', 'finalgrade', 'hidden',
1964             'locked', 'locktime', 'exported', 'overridden',
1965             'excluded', 'feedback', 'feedbackformat', 'information',
1966             'informationformat', 'timecreated', 'timemodified'));
1968         $letters = new backup_nested_element('grade_letters');
1970         $letter = new backup_nested_element('grade_letter', 'id', array(
1971             'lowerboundary', 'letter'));
1973         // Build the tree
1975         $book->add_child($items);
1976         $items->add_child($item);
1978         $item->add_child($grades);
1979         $grades->add_child($grade);
1981         $book->add_child($letters);
1982         $letters->add_child($letter);
1984         // Define sources
1986         $item->set_source_sql("SELECT gi.*
1987                                FROM {grade_items} gi
1988                                JOIN {backup_ids_temp} bi ON gi.id = bi.itemid
1989                                WHERE bi.backupid = ?
1990                                AND bi.itemname = 'grade_item'", array(backup::VAR_BACKUPID));
1992         // This only happens if we are including user info
1993         if ($userinfo) {
1994             $grade->set_source_table('grade_grades', array('itemid' => backup::VAR_PARENTID));
1995         }
1997         $letter->set_source_table('grade_letters', array('contextid' => backup::VAR_CONTEXTID));
1999         // Annotations
2001         $item->annotate_ids('scalefinal', 'scaleid'); // Straight as scalefinal because it's > 0
2002         $item->annotate_ids('outcome', 'outcomeid');
2004         $grade->annotate_ids('user', 'userid');
2005         $grade->annotate_ids('user', 'usermodified');
2007         // Return the root element (book)
2009         return $book;
2010     }
2013 /**
2014  * Backups up the course completion information for the course.
2015  */
2016 class backup_course_completion_structure_step extends backup_structure_step {
2018     protected function execute_condition() {
2019         // Check that all activities have been included
2020         if ($this->task->is_excluding_activities()) {
2021             return false;
2022         }
2023         return true;
2024     }
2026     /**
2027      * The structure of the course completion backup
2028      *
2029      * @return backup_nested_element
2030      */
2031     protected function define_structure() {
2033         // To know if we are including user completion info
2034         $userinfo = $this->get_setting_value('userscompletion');
2036         $cc = new backup_nested_element('course_completion');
2038         $criteria = new backup_nested_element('course_completion_criteria', array('id'), array(
2039             'course','criteriatype', 'module', 'moduleinstance', 'courseinstanceshortname', 'enrolperiod', 'timeend', 'gradepass', 'role'
2040         ));
2042         $criteriacompletions = new backup_nested_element('course_completion_crit_completions');
2044         $criteriacomplete = new backup_nested_element('course_completion_crit_compl', array('id'), array(
2045             'criteriaid', 'userid', 'gradefinal', 'unenrolled', 'timecompleted'
2046         ));
2048         $coursecompletions = new backup_nested_element('course_completions', array('id'), array(
2049             'userid', 'course', 'timeenrolled', 'timestarted', 'timecompleted', 'reaggregate'
2050         ));
2052         $aggregatemethod = new backup_nested_element('course_completion_aggr_methd', array('id'), array(
2053             'course','criteriatype','method','value'
2054         ));
2056         $cc->add_child($criteria);
2057             $criteria->add_child($criteriacompletions);
2058                 $criteriacompletions->add_child($criteriacomplete);
2059         $cc->add_child($coursecompletions);
2060         $cc->add_child($aggregatemethod);
2062         // We need to get the courseinstances shortname rather than an ID for restore
2063         $criteria->set_source_sql("SELECT ccc.*, c.shortname AS courseinstanceshortname
2064                                    FROM {course_completion_criteria} ccc
2065                                    LEFT JOIN {course} c ON c.id = ccc.courseinstance
2066                                    WHERE ccc.course = ?", array(backup::VAR_COURSEID));
2069         $aggregatemethod->set_source_table('course_completion_aggr_methd', array('course' => backup::VAR_COURSEID));
2071         if ($userinfo) {
2072             $criteriacomplete->set_source_table('course_completion_crit_compl', array('criteriaid' => backup::VAR_PARENTID));
2073             $coursecompletions->set_source_table('course_completions', array('course' => backup::VAR_COURSEID));
2074         }
2076         $criteria->annotate_ids('role', 'role');
2077         $criteriacomplete->annotate_ids('user', 'userid');
2078         $coursecompletions->annotate_ids('user', 'userid');
2080         return $cc;
2082     }