ef99fa6792042826604b3616fe5fde9c4a7c5997
[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 and create temp ids table.
32  */
33 class create_and_clean_temp_stuff extends backup_execution_step {
35     protected function define_execution() {
36         $progress = $this->task->get_progress();
37         $progress->start_progress('Deleting backup directories');
38         backup_helper::check_and_create_backup_dir($this->get_backupid());// Create backup temp dir
39         backup_helper::clear_backup_dir($this->get_backupid(), $progress);           // Empty temp dir, just in case
40         backup_controller_dbops::drop_backup_ids_temp_table($this->get_backupid()); // Drop ids temp table
41         backup_controller_dbops::create_backup_ids_temp_table($this->get_backupid()); // Create ids temp table
42         $progress->end_progress();
43     }
44 }
46 /**
47  * Delete the temp dir used by backup/restore (conditionally),
48  * delete old directories and drop temp ids table. Note we delete
49  * the directory but not the corresponding log file that will be
50  * there for, at least, 1 week - only delete_old_backup_dirs() or cron
51  * deletes log files (for easier access to them).
52  */
53 class drop_and_clean_temp_stuff extends backup_execution_step {
55     protected $skipcleaningtempdir = false;
57     protected function define_execution() {
58         global $CFG;
60         backup_controller_dbops::drop_backup_ids_temp_table($this->get_backupid()); // Drop ids temp table
61         backup_helper::delete_old_backup_dirs(strtotime('-1 week'));                // Delete > 1 week old temp dirs.
62         // Delete temp dir conditionally:
63         // 1) If $CFG->keeptempdirectoriesonbackup is not enabled
64         // 2) If backup temp dir deletion has been marked to be avoided
65         if (empty($CFG->keeptempdirectoriesonbackup) && !$this->skipcleaningtempdir) {
66             $progress = $this->task->get_progress();
67             $progress->start_progress('Deleting backup dir');
68             backup_helper::delete_backup_dir($this->get_backupid(), $progress); // Empty backup dir
69             $progress->end_progress();
70         }
71     }
73     public function skip_cleaning_temp_dir($skip) {
74         $this->skipcleaningtempdir = $skip;
75     }
76 }
78 /**
79  * Create the directory where all the task (activity/block...) information will be stored
80  */
81 class create_taskbasepath_directory extends backup_execution_step {
83     protected function define_execution() {
84         global $CFG;
85         $basepath = $this->task->get_taskbasepath();
86         if (!check_dir_exists($basepath, true, true)) {
87             throw new backup_step_exception('cannot_create_taskbasepath_directory', $basepath);
88         }
89     }
90 }
92 /**
93  * Abstract structure step, parent of all the activity structure steps. Used to wrap the
94  * activity structure definition within the main <activity ...> tag.
95  */
96 abstract class backup_activity_structure_step extends backup_structure_step {
98     /**
99      * Wraps any activity backup structure within the common 'activity' element
100      * that will include common to all activities information like id, context...
101      *
102      * @param backup_nested_element $activitystructure the element to wrap
103      * @return backup_nested_element the $activitystructure wrapped by the common 'activity' element
104      */
105     protected function prepare_activity_structure($activitystructure) {
107         // Create the wrap element
108         $activity = new backup_nested_element('activity', array('id', 'moduleid', 'modulename', 'contextid'), null);
110         // Build the tree
111         $activity->add_child($activitystructure);
113         // Set the source
114         $activityarr = array((object)array(
115             'id'         => $this->task->get_activityid(),
116             'moduleid'   => $this->task->get_moduleid(),
117             'modulename' => $this->task->get_modulename(),
118             'contextid'  => $this->task->get_contextid()));
120         $activity->set_source_array($activityarr);
122         // Return the root element (activity)
123         return $activity;
124     }
127 /**
128  * Abstract structure step, to be used by all the activities using core questions stuff
129  * (namely quiz module), supporting question plugins, states and sessions
130  */
131 abstract class backup_questions_activity_structure_step extends backup_activity_structure_step {
133     /**
134      * Attach to $element (usually attempts) the needed backup structures
135      * for question_usages and all the associated data.
136      *
137      * @param backup_nested_element $element the element that will contain all the question_usages data.
138      * @param string $usageidname the name of the element that holds the usageid.
139      *      This must be child of $element, and must be a final element.
140      * @param string $nameprefix this prefix is added to all the element names we create.
141      *      Element names in the XML must be unique, so if you are using usages in
142      *      two different ways, you must give a prefix to at least one of them. If
143      *      you only use one sort of usage, then you can just use the default empty prefix.
144      *      This should include a trailing underscore. For example "myprefix_"
145      */
146     protected function add_question_usages($element, $usageidname, $nameprefix = '') {
147         global $CFG;
148         require_once($CFG->dirroot . '/question/engine/lib.php');
150         // Check $element is one nested_backup_element
151         if (! $element instanceof backup_nested_element) {
152             throw new backup_step_exception('question_states_bad_parent_element', $element);
153         }
154         if (! $element->get_final_element($usageidname)) {
155             throw new backup_step_exception('question_states_bad_question_attempt_element', $usageidname);
156         }
158         $quba = new backup_nested_element($nameprefix . 'question_usage', array('id'),
159                 array('component', 'preferredbehaviour'));
161         $qas = new backup_nested_element($nameprefix . 'question_attempts');
162         $qa = new backup_nested_element($nameprefix . 'question_attempt', array('id'), array(
163                 'slot', 'behaviour', 'questionid', 'variant', 'maxmark', 'minfraction', 'maxfraction',
164                 'flagged', 'questionsummary', 'rightanswer', 'responsesummary',
165                 'timemodified'));
167         $steps = new backup_nested_element($nameprefix . 'steps');
168         $step = new backup_nested_element($nameprefix . 'step', array('id'), array(
169                 'sequencenumber', 'state', 'fraction', 'timecreated', 'userid'));
171         $response = new backup_nested_element($nameprefix . 'response');
172         $variable = new backup_nested_element($nameprefix . 'variable', null,  array('name', 'value'));
174         // Build the tree
175         $element->add_child($quba);
176         $quba->add_child($qas);
177         $qas->add_child($qa);
178         $qa->add_child($steps);
179         $steps->add_child($step);
180         $step->add_child($response);
181         $response->add_child($variable);
183         // Set the sources
184         $quba->set_source_table('question_usages',
185                 array('id'                => '../' . $usageidname));
186         $qa->set_source_table('question_attempts', array('questionusageid' => backup::VAR_PARENTID), 'slot ASC');
187         $step->set_source_table('question_attempt_steps', array('questionattemptid' => backup::VAR_PARENTID), 'sequencenumber ASC');
188         $variable->set_source_table('question_attempt_step_data', array('attemptstepid' => backup::VAR_PARENTID));
190         // Annotate ids
191         $qa->annotate_ids('question', 'questionid');
192         $step->annotate_ids('user', 'userid');
194         // Annotate files
195         $fileareas = question_engine::get_all_response_file_areas();
196         foreach ($fileareas as $filearea) {
197             $step->annotate_files('question', $filearea, 'id');
198         }
199     }
203 /**
204  * backup structure step in charge of calculating the categories to be
205  * included in backup, based in the context being backuped (module/course)
206  * and the already annotated questions present in backup_ids_temp
207  */
208 class backup_calculate_question_categories extends backup_execution_step {
210     protected function define_execution() {
211         backup_question_dbops::calculate_question_categories($this->get_backupid(), $this->task->get_contextid());
212     }
215 /**
216  * backup structure step in charge of deleting all the questions annotated
217  * in the backup_ids_temp table
218  */
219 class backup_delete_temp_questions extends backup_execution_step {
221     protected function define_execution() {
222         backup_question_dbops::delete_temp_questions($this->get_backupid());
223     }
226 /**
227  * Abstract structure step, parent of all the block structure steps. Used to wrap the
228  * block structure definition within the main <block ...> tag
229  */
230 abstract class backup_block_structure_step extends backup_structure_step {
232     protected function prepare_block_structure($blockstructure) {
234         // Create the wrap element
235         $block = new backup_nested_element('block', array('id', 'blockname', 'contextid'), null);
237         // Build the tree
238         $block->add_child($blockstructure);
240         // Set the source
241         $blockarr = array((object)array(
242             'id'         => $this->task->get_blockid(),
243             'blockname'  => $this->task->get_blockname(),
244             'contextid'  => $this->task->get_contextid()));
246         $block->set_source_array($blockarr);
248         // Return the root element (block)
249         return $block;
250     }
253 /**
254  * structure step that will generate the module.xml file for the activity,
255  * accumulating various information about the activity, annotating groupings
256  * and completion/avail conf
257  */
258 class backup_module_structure_step extends backup_structure_step {
260     protected function define_structure() {
261         global $DB;
263         // Define each element separated
265         $module = new backup_nested_element('module', array('id', 'version'), array(
266             'modulename', 'sectionid', 'sectionnumber', 'idnumber',
267             'added', 'score', 'indent', 'visible', 'visibleoncoursepage',
268             'visibleold', 'groupmode', 'groupingid',
269             'completion', 'completiongradeitemnumber', 'completionview', 'completionexpected',
270             'availability', 'showdescription'));
272         $tags = new backup_nested_element('tags');
273         $tag = new backup_nested_element('tag', array('id'), array('name', 'rawname'));
275         // attach format plugin structure to $module element, only one allowed
276         $this->add_plugin_structure('format', $module, false);
278         // attach plagiarism plugin structure to $module element, there can be potentially
279         // many plagiarism plugins storing information about this course
280         $this->add_plugin_structure('plagiarism', $module, true);
282         // attach local plugin structure to $module, multiple allowed
283         $this->add_plugin_structure('local', $module, true);
285         // Attach admin tools plugin structure to $module.
286         $this->add_plugin_structure('tool', $module, true);
288         $module->add_child($tags);
289         $tags->add_child($tag);
291         // Set the sources
292         $concat = $DB->sql_concat("'mod_'", 'm.name');
293         $module->set_source_sql("
294             SELECT cm.*, cp.value AS version, m.name AS modulename, s.id AS sectionid, s.section AS sectionnumber
295               FROM {course_modules} cm
296               JOIN {modules} m ON m.id = cm.module
297               JOIN {config_plugins} cp ON cp.plugin = $concat AND cp.name = 'version'
298               JOIN {course_sections} s ON s.id = cm.section
299              WHERE cm.id = ?", array(backup::VAR_MODID));
301         $tag->set_source_sql("SELECT t.id, t.name, t.rawname
302                                 FROM {tag} t
303                                 JOIN {tag_instance} ti ON ti.tagid = t.id
304                                WHERE ti.itemtype = 'course_modules'
305                                  AND ti.component = 'core'
306                                  AND ti.itemid = ?", array(backup::VAR_MODID));
308         // Define annotations
309         $module->annotate_ids('grouping', 'groupingid');
311         // Return the root element ($module)
312         return $module;
313     }
316 /**
317  * structure step that will generate the section.xml file for the section
318  * annotating files
319  */
320 class backup_section_structure_step extends backup_structure_step {
322     protected function define_structure() {
324         // Define each element separated
326         $section = new backup_nested_element('section', array('id'), array(
327                 'number', 'name', 'summary', 'summaryformat', 'sequence', 'visible',
328                 'availabilityjson', 'timemodified'));
330         // attach format plugin structure to $section element, only one allowed
331         $this->add_plugin_structure('format', $section, false);
333         // attach local plugin structure to $section element, multiple allowed
334         $this->add_plugin_structure('local', $section, true);
336         // Add nested elements for course_format_options table
337         $formatoptions = new backup_nested_element('course_format_options', array('id'), array(
338             'format', 'name', 'value'));
339         $section->add_child($formatoptions);
341         // Define sources.
342         $section->set_source_table('course_sections', array('id' => backup::VAR_SECTIONID));
343         $formatoptions->set_source_sql('SELECT cfo.id, cfo.format, cfo.name, cfo.value
344               FROM {course} c
345               JOIN {course_format_options} cfo
346               ON cfo.courseid = c.id AND cfo.format = c.format
347               WHERE c.id = ? AND cfo.sectionid = ?',
348                 array(backup::VAR_COURSEID, backup::VAR_SECTIONID));
350         // Aliases
351         $section->set_source_alias('section', 'number');
352         // The 'availability' field needs to be renamed because it clashes with
353         // the old nested element structure for availability data.
354         $section->set_source_alias('availability', 'availabilityjson');
356         // Set annotations
357         $section->annotate_files('course', 'section', 'id');
359         return $section;
360     }
363 /**
364  * structure step that will generate the course.xml file for the course, including
365  * course category reference, tags, modules restriction information
366  * and some annotations (files & groupings)
367  */
368 class backup_course_structure_step extends backup_structure_step {
370     protected function define_structure() {
371         global $DB;
373         // Define each element separated
375         $course = new backup_nested_element('course', array('id', 'contextid'), array(
376             'shortname', 'fullname', 'idnumber',
377             'summary', 'summaryformat', 'format', 'showgrades',
378             'newsitems', 'startdate', 'enddate',
379             'marker', 'maxbytes', 'legacyfiles', 'showreports',
380             'visible', 'groupmode', 'groupmodeforce',
381             'defaultgroupingid', 'lang', 'theme',
382             'timecreated', 'timemodified',
383             'requested',
384             'enablecompletion', 'completionstartonenrol', 'completionnotify'));
386         $category = new backup_nested_element('category', array('id'), array(
387             'name', 'description'));
389         $tags = new backup_nested_element('tags');
391         $tag = new backup_nested_element('tag', array('id'), array(
392             'name', 'rawname'));
394         // attach format plugin structure to $course element, only one allowed
395         $this->add_plugin_structure('format', $course, false);
397         // attach theme plugin structure to $course element; multiple themes can
398         // save course data (in case of user theme, legacy theme, etc)
399         $this->add_plugin_structure('theme', $course, true);
401         // attach general report plugin structure to $course element; multiple
402         // reports can save course data if required
403         $this->add_plugin_structure('report', $course, true);
405         // attach course report plugin structure to $course element; multiple
406         // course reports can save course data if required
407         $this->add_plugin_structure('coursereport', $course, true);
409         // attach plagiarism plugin structure to $course element, there can be potentially
410         // many plagiarism plugins storing information about this course
411         $this->add_plugin_structure('plagiarism', $course, true);
413         // attach local plugin structure to $course element; multiple local plugins
414         // can save course data if required
415         $this->add_plugin_structure('local', $course, true);
417         // Attach admin tools plugin structure to $course element; multiple plugins
418         // can save course data if required.
419         $this->add_plugin_structure('tool', $course, true);
421         // Build the tree
423         $course->add_child($category);
425         $course->add_child($tags);
426         $tags->add_child($tag);
428         // Set the sources
430         $courserec = $DB->get_record('course', array('id' => $this->task->get_courseid()));
431         $courserec->contextid = $this->task->get_contextid();
433         $formatoptions = course_get_format($courserec)->get_format_options();
434         $course->add_final_elements(array_keys($formatoptions));
435         foreach ($formatoptions as $key => $value) {
436             $courserec->$key = $value;
437         }
439         // Add 'numsections' in order to be able to restore in previous versions of Moodle.
440         // Even though Moodle does not officially support restore into older verions of Moodle from the
441         // version where backup was made, without 'numsections' restoring will go very wrong.
442         if (!property_exists($courserec, 'numsections') && course_get_format($courserec)->uses_sections()) {
443             $courserec->numsections = course_get_format($courserec)->get_last_section_number();
444         }
446         $course->set_source_array(array($courserec));
448         $categoryrec = $DB->get_record('course_categories', array('id' => $courserec->category));
450         $category->set_source_array(array($categoryrec));
452         $tag->set_source_sql('SELECT t.id, t.name, t.rawname
453                                 FROM {tag} t
454                                 JOIN {tag_instance} ti ON ti.tagid = t.id
455                                WHERE ti.itemtype = ?
456                                  AND ti.itemid = ?', array(
457                                      backup_helper::is_sqlparam('course'),
458                                      backup::VAR_PARENTID));
460         // Some annotations
462         $course->annotate_ids('grouping', 'defaultgroupingid');
464         $course->annotate_files('course', 'summary', null);
465         $course->annotate_files('course', 'overviewfiles', null);
466         $course->annotate_files('course', 'legacy', null);
468         // Return root element ($course)
470         return $course;
471     }
474 /**
475  * structure step that will generate the enrolments.xml file for the given course
476  */
477 class backup_enrolments_structure_step extends backup_structure_step {
479     /**
480      * Skip enrolments on the front page.
481      * @return bool
482      */
483     protected function execute_condition() {
484         return ($this->get_courseid() != SITEID);
485     }
487     protected function define_structure() {
489         // To know if we are including users
490         $users = $this->get_setting_value('users');
492         // Define each element separated
494         $enrolments = new backup_nested_element('enrolments');
496         $enrols = new backup_nested_element('enrols');
498         $enrol = new backup_nested_element('enrol', array('id'), array(
499             'enrol', 'status', 'name', 'enrolperiod', 'enrolstartdate',
500             'enrolenddate', 'expirynotify', 'expirythreshold', 'notifyall',
501             'password', 'cost', 'currency', 'roleid',
502             'customint1', 'customint2', 'customint3', 'customint4', 'customint5', 'customint6', 'customint7', 'customint8',
503             'customchar1', 'customchar2', 'customchar3',
504             'customdec1', 'customdec2',
505             'customtext1', 'customtext2', 'customtext3', 'customtext4',
506             'timecreated', 'timemodified'));
508         $userenrolments = new backup_nested_element('user_enrolments');
510         $enrolment = new backup_nested_element('enrolment', array('id'), array(
511             'status', 'userid', 'timestart', 'timeend', 'modifierid',
512             'timemodified'));
514         // Build the tree
515         $enrolments->add_child($enrols);
516         $enrols->add_child($enrol);
517         $enrol->add_child($userenrolments);
518         $userenrolments->add_child($enrolment);
520         // Define sources - the instances are restored using the same sortorder, we do not need to store it in xml and deal with it afterwards.
521         $enrol->set_source_table('enrol', array('courseid' => backup::VAR_COURSEID), 'sortorder ASC');
523         // User enrolments only added only if users included
524         if ($users) {
525             $enrolment->set_source_table('user_enrolments', array('enrolid' => backup::VAR_PARENTID));
526             $enrolment->annotate_ids('user', 'userid');
527         }
529         $enrol->annotate_ids('role', 'roleid');
531         // Add enrol plugin structure.
532         $this->add_plugin_structure('enrol', $enrol, true);
534         return $enrolments;
535     }
538 /**
539  * structure step that will generate the roles.xml file for the given context, observing
540  * the role_assignments setting to know if that part needs to be included
541  */
542 class backup_roles_structure_step extends backup_structure_step {
544     protected function define_structure() {
546         // To know if we are including role assignments
547         $roleassignments = $this->get_setting_value('role_assignments');
549         // Define each element separated
551         $roles = new backup_nested_element('roles');
553         $overrides = new backup_nested_element('role_overrides');
555         $override = new backup_nested_element('override', array('id'), array(
556             'roleid', 'capability', 'permission', 'timemodified',
557             'modifierid'));
559         $assignments = new backup_nested_element('role_assignments');
561         $assignment = new backup_nested_element('assignment', array('id'), array(
562             'roleid', 'userid', 'timemodified', 'modifierid', 'component', 'itemid',
563             'sortorder'));
565         // Build the tree
566         $roles->add_child($overrides);
567         $roles->add_child($assignments);
569         $overrides->add_child($override);
570         $assignments->add_child($assignment);
572         // Define sources
574         $override->set_source_table('role_capabilities', array('contextid' => backup::VAR_CONTEXTID));
576         // Assignments only added if specified
577         if ($roleassignments) {
578             $assignment->set_source_table('role_assignments', array('contextid' => backup::VAR_CONTEXTID));
579         }
581         // Define id annotations
582         $override->annotate_ids('role', 'roleid');
584         $assignment->annotate_ids('role', 'roleid');
586         $assignment->annotate_ids('user', 'userid');
588         //TODO: how do we annotate the itemid? the meaning depends on the content of component table (skodak)
590         return $roles;
591     }
594 /**
595  * structure step that will generate the roles.xml containing the
596  * list of roles used along the whole backup process. Just raw
597  * list of used roles from role table
598  */
599 class backup_final_roles_structure_step extends backup_structure_step {
601     protected function define_structure() {
603         // Define elements
605         $rolesdef = new backup_nested_element('roles_definition');
607         $role = new backup_nested_element('role', array('id'), array(
608             'name', 'shortname', 'nameincourse', 'description',
609             'sortorder', 'archetype'));
611         // Build the tree
613         $rolesdef->add_child($role);
615         // Define sources
617         $role->set_source_sql("SELECT r.*, rn.name AS nameincourse
618                                  FROM {role} r
619                                  JOIN {backup_ids_temp} bi ON r.id = bi.itemid
620                             LEFT JOIN {role_names} rn ON r.id = rn.roleid AND rn.contextid = ?
621                                 WHERE bi.backupid = ?
622                                   AND bi.itemname = 'rolefinal'", array(backup::VAR_CONTEXTID, backup::VAR_BACKUPID));
624         // Return main element (rolesdef)
625         return $rolesdef;
626     }
629 /**
630  * structure step that will generate the scales.xml containing the
631  * list of scales used along the whole backup process.
632  */
633 class backup_final_scales_structure_step extends backup_structure_step {
635     protected function define_structure() {
637         // Define elements
639         $scalesdef = new backup_nested_element('scales_definition');
641         $scale = new backup_nested_element('scale', array('id'), array(
642             'courseid', 'userid', 'name', 'scale',
643             'description', 'descriptionformat', 'timemodified'));
645         // Build the tree
647         $scalesdef->add_child($scale);
649         // Define sources
651         $scale->set_source_sql("SELECT s.*
652                                   FROM {scale} s
653                                   JOIN {backup_ids_temp} bi ON s.id = bi.itemid
654                                  WHERE bi.backupid = ?
655                                    AND bi.itemname = 'scalefinal'", array(backup::VAR_BACKUPID));
657         // Annotate scale files (they store files in system context, so pass it instead of default one)
658         $scale->annotate_files('grade', 'scale', 'id', context_system::instance()->id);
660         // Return main element (scalesdef)
661         return $scalesdef;
662     }
665 /**
666  * structure step that will generate the outcomes.xml containing the
667  * list of outcomes used along the whole backup process.
668  */
669 class backup_final_outcomes_structure_step extends backup_structure_step {
671     protected function define_structure() {
673         // Define elements
675         $outcomesdef = new backup_nested_element('outcomes_definition');
677         $outcome = new backup_nested_element('outcome', array('id'), array(
678             'courseid', 'userid', 'shortname', 'fullname',
679             'scaleid', 'description', 'descriptionformat', 'timecreated',
680             'timemodified','usermodified'));
682         // Build the tree
684         $outcomesdef->add_child($outcome);
686         // Define sources
688         $outcome->set_source_sql("SELECT o.*
689                                     FROM {grade_outcomes} o
690                                     JOIN {backup_ids_temp} bi ON o.id = bi.itemid
691                                    WHERE bi.backupid = ?
692                                      AND bi.itemname = 'outcomefinal'", array(backup::VAR_BACKUPID));
694         // Annotate outcome files (they store files in system context, so pass it instead of default one)
695         $outcome->annotate_files('grade', 'outcome', 'id', context_system::instance()->id);
697         // Return main element (outcomesdef)
698         return $outcomesdef;
699     }
702 /**
703  * structure step in charge of constructing the filters.xml file for all the filters found
704  * in activity
705  */
706 class backup_filters_structure_step extends backup_structure_step {
708     protected function define_structure() {
710         // Define each element separated
712         $filters = new backup_nested_element('filters');
714         $actives = new backup_nested_element('filter_actives');
716         $active = new backup_nested_element('filter_active', null, array('filter', 'active'));
718         $configs = new backup_nested_element('filter_configs');
720         $config = new backup_nested_element('filter_config', null, array('filter', 'name', 'value'));
722         // Build the tree
724         $filters->add_child($actives);
725         $filters->add_child($configs);
727         $actives->add_child($active);
728         $configs->add_child($config);
730         // Define sources
732         list($activearr, $configarr) = filter_get_all_local_settings($this->task->get_contextid());
734         $active->set_source_array($activearr);
735         $config->set_source_array($configarr);
737         // Return the root element (filters)
738         return $filters;
739     }
742 /**
743  * structure step in charge of constructing the comments.xml file for all the comments found
744  * in a given context
745  */
746 class backup_comments_structure_step extends backup_structure_step {
748     protected function define_structure() {
750         // Define each element separated
752         $comments = new backup_nested_element('comments');
754         $comment = new backup_nested_element('comment', array('id'), array(
755             'commentarea', 'itemid', 'content', 'format',
756             'userid', 'timecreated'));
758         // Build the tree
760         $comments->add_child($comment);
762         // Define sources
764         $comment->set_source_table('comments', array('contextid' => backup::VAR_CONTEXTID));
766         // Define id annotations
768         $comment->annotate_ids('user', 'userid');
770         // Return the root element (comments)
771         return $comments;
772     }
775 /**
776  * structure step in charge of constructing the badges.xml file for all the badges found
777  * in a given context
778  */
779 class backup_badges_structure_step extends backup_structure_step {
781     protected function execute_condition() {
782         // Check that all activities have been included.
783         if ($this->task->is_excluding_activities()) {
784             return false;
785         }
786         return true;
787     }
789     protected function define_structure() {
791         // Define each element separated.
793         $badges = new backup_nested_element('badges');
794         $badge = new backup_nested_element('badge', array('id'), array('name', 'description',
795                 'timecreated', 'timemodified', 'usercreated', 'usermodified', 'issuername',
796                 'issuerurl', 'issuercontact', 'expiredate', 'expireperiod', 'type', 'courseid',
797                 'message', 'messagesubject', 'attachment', 'notification', 'status', 'nextcron'));
799         $criteria = new backup_nested_element('criteria');
800         $criterion = new backup_nested_element('criterion', array('id'), array('badgeid',
801                 'criteriatype', 'method', 'description', 'descriptionformat'));
803         $parameters = new backup_nested_element('parameters');
804         $parameter = new backup_nested_element('parameter', array('id'), array('critid',
805                 'name', 'value', 'criteriatype'));
807         $manual_awards = new backup_nested_element('manual_awards');
808         $manual_award = new backup_nested_element('manual_award', array('id'), array('badgeid',
809                 'recipientid', 'issuerid', 'issuerrole', 'datemet'));
811         // Build the tree.
813         $badges->add_child($badge);
814         $badge->add_child($criteria);
815         $criteria->add_child($criterion);
816         $criterion->add_child($parameters);
817         $parameters->add_child($parameter);
818         $badge->add_child($manual_awards);
819         $manual_awards->add_child($manual_award);
821         // Define sources.
823         $badge->set_source_table('badge', array('courseid' => backup::VAR_COURSEID));
824         $criterion->set_source_table('badge_criteria', array('badgeid' => backup::VAR_PARENTID));
826         $parametersql = 'SELECT cp.*, c.criteriatype
827                              FROM {badge_criteria_param} cp JOIN {badge_criteria} c
828                                  ON cp.critid = c.id
829                              WHERE critid = :critid';
830         $parameterparams = array('critid' => backup::VAR_PARENTID);
831         $parameter->set_source_sql($parametersql, $parameterparams);
833         $manual_award->set_source_table('badge_manual_award', array('badgeid' => backup::VAR_PARENTID));
835         // Define id annotations.
837         $badge->annotate_ids('user', 'usercreated');
838         $badge->annotate_ids('user', 'usermodified');
839         $criterion->annotate_ids('badge', 'badgeid');
840         $parameter->annotate_ids('criterion', 'critid');
841         $badge->annotate_files('badges', 'badgeimage', 'id');
842         $manual_award->annotate_ids('badge', 'badgeid');
843         $manual_award->annotate_ids('user', 'recipientid');
844         $manual_award->annotate_ids('user', 'issuerid');
845         $manual_award->annotate_ids('role', 'issuerrole');
847         // Return the root element ($badges).
848         return $badges;
849     }
852 /**
853  * structure step in charge of constructing the calender.xml file for all the events found
854  * in a given context
855  */
856 class backup_calendarevents_structure_step extends backup_structure_step {
858     protected function define_structure() {
860         // Define each element separated
862         $events = new backup_nested_element('events');
864         $event = new backup_nested_element('event', array('id'), array(
865                 'name', 'description', 'format', 'courseid', 'groupid', 'userid',
866                 'repeatid', 'modulename', 'instance', 'type', 'eventtype', 'timestart',
867                 'timeduration', 'timesort', 'visible', 'uuid', 'sequence', 'timemodified',
868                 'priority', 'location'));
870         // Build the tree
871         $events->add_child($event);
873         // Define sources
874         if ($this->name == 'course_calendar') {
875             $calendar_items_sql ="SELECT * FROM {event}
876                         WHERE courseid = :courseid
877                         AND (eventtype = 'course' OR eventtype = 'group')";
878             $calendar_items_params = array('courseid'=>backup::VAR_COURSEID);
879             $event->set_source_sql($calendar_items_sql, $calendar_items_params);
880         } else if ($this->name == 'activity_calendar') {
881             // We don't backup action events.
882             $params = array('instance' => backup::VAR_ACTIVITYID, 'modulename' => backup::VAR_MODNAME,
883                 'type' => array('sqlparam' => CALENDAR_EVENT_TYPE_ACTION));
884             // If we don't want to include the userinfo in the backup then setting the courseid
885             // will filter out all of the user override events (which have a course id of zero).
886             $coursewhere = "";
887             if (!$this->get_setting_value('userinfo')) {
888                 $params['courseid'] = backup::VAR_COURSEID;
889                 $coursewhere = " AND courseid = :courseid";
890             }
891             $calendarsql = "SELECT * FROM {event}
892                              WHERE instance = :instance
893                                AND type <> :type
894                                AND modulename = :modulename";
895             $calendarsql = $calendarsql . $coursewhere;
896             $event->set_source_sql($calendarsql, $params);
897         } else {
898             $event->set_source_table('event', array('courseid' => backup::VAR_COURSEID, 'instance' => backup::VAR_ACTIVITYID, 'modulename' => backup::VAR_MODNAME));
899         }
901         // Define id annotations
903         $event->annotate_ids('user', 'userid');
904         $event->annotate_ids('group', 'groupid');
905         $event->annotate_files('calendar', 'event_description', 'id');
907         // Return the root element (events)
908         return $events;
909     }
912 /**
913  * structure step in charge of constructing the gradebook.xml file for all the gradebook config in the course
914  * NOTE: the backup of the grade items themselves is handled by backup_activity_grades_structure_step
915  */
916 class backup_gradebook_structure_step extends backup_structure_step {
918     /**
919      * We need to decide conditionally, based on dynamic information
920      * about the execution of this step. Only will be executed if all
921      * the module gradeitems have been already included in backup
922      */
923     protected function execute_condition() {
924         $courseid = $this->get_courseid();
925         if ($courseid == SITEID) {
926             return false;
927         }
929         return backup_plan_dbops::require_gradebook_backup($courseid, $this->get_backupid());
930     }
932     protected function define_structure() {
933         global $CFG, $DB;
935         // are we including user info?
936         $userinfo = $this->get_setting_value('users');
938         $gradebook = new backup_nested_element('gradebook');
940         //grade_letters are done in backup_activity_grades_structure_step()
942         //calculated grade items
943         $grade_items = new backup_nested_element('grade_items');
944         $grade_item = new backup_nested_element('grade_item', array('id'), array(
945             'categoryid', 'itemname', 'itemtype', 'itemmodule',
946             'iteminstance', 'itemnumber', 'iteminfo', 'idnumber',
947             'calculation', 'gradetype', 'grademax', 'grademin',
948             'scaleid', 'outcomeid', 'gradepass', 'multfactor',
949             'plusfactor', 'aggregationcoef', 'aggregationcoef2', 'weightoverride',
950             'sortorder', 'display', 'decimals', 'hidden', 'locked', 'locktime',
951             'needsupdate', 'timecreated', 'timemodified'));
953         $grade_grades = new backup_nested_element('grade_grades');
954         $grade_grade = new backup_nested_element('grade_grade', array('id'), array(
955             'userid', 'rawgrade', 'rawgrademax', 'rawgrademin',
956             'rawscaleid', 'usermodified', 'finalgrade', 'hidden',
957             'locked', 'locktime', 'exported', 'overridden',
958             'excluded', 'feedback', 'feedbackformat', 'information',
959             'informationformat', 'timecreated', 'timemodified',
960             'aggregationstatus', 'aggregationweight'));
962         //grade_categories
963         $grade_categories = new backup_nested_element('grade_categories');
964         $grade_category   = new backup_nested_element('grade_category', array('id'), array(
965                 //'courseid',
966                 'parent', 'depth', 'path', 'fullname', 'aggregation', 'keephigh',
967                 'droplow', 'aggregateonlygraded', 'aggregateoutcomes',
968                 'timecreated', 'timemodified', 'hidden'));
970         $letters = new backup_nested_element('grade_letters');
971         $letter = new backup_nested_element('grade_letter', 'id', array(
972             'lowerboundary', 'letter'));
974         $grade_settings = new backup_nested_element('grade_settings');
975         $grade_setting = new backup_nested_element('grade_setting', 'id', array(
976             'name', 'value'));
978         $gradebook_attributes = new backup_nested_element('attributes', null, array('calculations_freeze'));
980         // Build the tree
981         $gradebook->add_child($gradebook_attributes);
983         $gradebook->add_child($grade_categories);
984         $grade_categories->add_child($grade_category);
986         $gradebook->add_child($grade_items);
987         $grade_items->add_child($grade_item);
988         $grade_item->add_child($grade_grades);
989         $grade_grades->add_child($grade_grade);
991         $gradebook->add_child($letters);
992         $letters->add_child($letter);
994         $gradebook->add_child($grade_settings);
995         $grade_settings->add_child($grade_setting);
997         // Define sources
999         // Add attribute with gradebook calculation freeze date if needed.
1000         $attributes = new stdClass();
1001         $gradebookcalculationfreeze = get_config('core', 'gradebook_calculations_freeze_' . $this->get_courseid());
1002         if ($gradebookcalculationfreeze) {
1003             $attributes->calculations_freeze = $gradebookcalculationfreeze;
1004         }
1005         $gradebook_attributes->set_source_array([$attributes]);
1007         //Include manual, category and the course grade item
1008         $grade_items_sql ="SELECT * FROM {grade_items}
1009                            WHERE courseid = :courseid
1010                            AND (itemtype='manual' OR itemtype='course' OR itemtype='category')";
1011         $grade_items_params = array('courseid'=>backup::VAR_COURSEID);
1012         $grade_item->set_source_sql($grade_items_sql, $grade_items_params);
1014         if ($userinfo) {
1015             $grade_grade->set_source_table('grade_grades', array('itemid' => backup::VAR_PARENTID));
1016         }
1018         $grade_category_sql = "SELECT gc.*, gi.sortorder
1019                                FROM {grade_categories} gc
1020                                JOIN {grade_items} gi ON (gi.iteminstance = gc.id)
1021                                WHERE gc.courseid = :courseid
1022                                AND (gi.itemtype='course' OR gi.itemtype='category')
1023                                ORDER BY gc.parent ASC";//need parent categories before their children
1024         $grade_category_params = array('courseid'=>backup::VAR_COURSEID);
1025         $grade_category->set_source_sql($grade_category_sql, $grade_category_params);
1027         $letter->set_source_table('grade_letters', array('contextid' => backup::VAR_CONTEXTID));
1029         // Set the grade settings source, forcing the inclusion of minmaxtouse if not present.
1030         $settings = array();
1031         $rs = $DB->get_recordset('grade_settings', array('courseid' => $this->get_courseid()));
1032         foreach ($rs as $record) {
1033             $settings[$record->name] = $record;
1034         }
1035         $rs->close();
1036         if (!isset($settings['minmaxtouse'])) {
1037             $settings['minmaxtouse'] = (object) array('name' => 'minmaxtouse', 'value' => $CFG->grade_minmaxtouse);
1038         }
1039         $grade_setting->set_source_array($settings);
1042         // Annotations (both as final as far as they are going to be exported in next steps)
1043         $grade_item->annotate_ids('scalefinal', 'scaleid'); // Straight as scalefinal because it's > 0
1044         $grade_item->annotate_ids('outcomefinal', 'outcomeid');
1046         //just in case there are any users not already annotated by the activities
1047         $grade_grade->annotate_ids('userfinal', 'userid');
1049         // Return the root element
1050         return $gradebook;
1051     }
1054 /**
1055  * Step in charge of constructing the grade_history.xml file containing the grade histories.
1056  */
1057 class backup_grade_history_structure_step extends backup_structure_step {
1059     /**
1060      * Limit the execution.
1061      *
1062      * This applies the same logic than the one applied to {@link backup_gradebook_structure_step},
1063      * because we do not want to save the history of items which are not backed up. At least for now.
1064      */
1065     protected function execute_condition() {
1066         $courseid = $this->get_courseid();
1067         if ($courseid == SITEID) {
1068             return false;
1069         }
1071         return backup_plan_dbops::require_gradebook_backup($courseid, $this->get_backupid());
1072     }
1074     protected function define_structure() {
1076         // Settings to use.
1077         $userinfo = $this->get_setting_value('users');
1078         $history = $this->get_setting_value('grade_histories');
1080         // Create the nested elements.
1081         $bookhistory = new backup_nested_element('grade_history');
1082         $grades = new backup_nested_element('grade_grades');
1083         $grade = new backup_nested_element('grade_grade', array('id'), array(
1084             'action', 'oldid', 'source', 'loggeduser', 'itemid', 'userid',
1085             'rawgrade', 'rawgrademax', 'rawgrademin', 'rawscaleid',
1086             'usermodified', 'finalgrade', 'hidden', 'locked', 'locktime', 'exported', 'overridden',
1087             'excluded', 'feedback', 'feedbackformat', 'information',
1088             'informationformat', 'timemodified'));
1090         // Build the tree.
1091         $bookhistory->add_child($grades);
1092         $grades->add_child($grade);
1094         // This only happens if we are including user info and history.
1095         if ($userinfo && $history) {
1096             // Only keep the history of grades related to items which have been backed up, The query is
1097             // similar (but not identical) to the one used in backup_gradebook_structure_step::define_structure().
1098             $gradesql = "SELECT ggh.*
1099                            FROM {grade_grades_history} ggh
1100                            JOIN {grade_items} gi ON ggh.itemid = gi.id
1101                           WHERE gi.courseid = :courseid
1102                             AND (gi.itemtype = 'manual' OR gi.itemtype = 'course' OR gi.itemtype = 'category')";
1103             $grade->set_source_sql($gradesql, array('courseid' => backup::VAR_COURSEID));
1104         }
1106         // Annotations. (Final annotations as this step is part of the final task).
1107         $grade->annotate_ids('scalefinal', 'rawscaleid');
1108         $grade->annotate_ids('userfinal', 'loggeduser');
1109         $grade->annotate_ids('userfinal', 'userid');
1110         $grade->annotate_ids('userfinal', 'usermodified');
1112         // Return the root element.
1113         return $bookhistory;
1114     }
1118 /**
1119  * structure step in charge if constructing the completion.xml file for all the users completion
1120  * information in a given activity
1121  */
1122 class backup_userscompletion_structure_step extends backup_structure_step {
1124     /**
1125      * Skip completion on the front page.
1126      * @return bool
1127      */
1128     protected function execute_condition() {
1129         return ($this->get_courseid() != SITEID);
1130     }
1132     protected function define_structure() {
1134         // Define each element separated
1136         $completions = new backup_nested_element('completions');
1138         $completion = new backup_nested_element('completion', array('id'), array(
1139             'userid', 'completionstate', 'viewed', 'timemodified'));
1141         // Build the tree
1143         $completions->add_child($completion);
1145         // Define sources
1147         $completion->set_source_table('course_modules_completion', array('coursemoduleid' => backup::VAR_MODID));
1149         // Define id annotations
1151         $completion->annotate_ids('user', 'userid');
1153         // Return the root element (completions)
1154         return $completions;
1155     }
1158 /**
1159  * structure step in charge of constructing the main groups.xml file for all the groups and
1160  * groupings information already annotated
1161  */
1162 class backup_groups_structure_step extends backup_structure_step {
1164     protected function define_structure() {
1166         // To know if we are including users.
1167         $userinfo = $this->get_setting_value('users');
1168         // To know if we are including groups and groupings.
1169         $groupinfo = $this->get_setting_value('groups');
1171         // Define each element separated
1173         $groups = new backup_nested_element('groups');
1175         $group = new backup_nested_element('group', array('id'), array(
1176             'name', 'idnumber', 'description', 'descriptionformat', 'enrolmentkey',
1177             'picture', 'hidepicture', 'timecreated', 'timemodified'));
1179         $members = new backup_nested_element('group_members');
1181         $member = new backup_nested_element('group_member', array('id'), array(
1182             'userid', 'timeadded', 'component', 'itemid'));
1184         $groupings = new backup_nested_element('groupings');
1186         $grouping = new backup_nested_element('grouping', 'id', array(
1187             'name', 'idnumber', 'description', 'descriptionformat', 'configdata',
1188             'timecreated', 'timemodified'));
1190         $groupinggroups = new backup_nested_element('grouping_groups');
1192         $groupinggroup = new backup_nested_element('grouping_group', array('id'), array(
1193             'groupid', 'timeadded'));
1195         // Build the tree
1197         $groups->add_child($group);
1198         $groups->add_child($groupings);
1200         $group->add_child($members);
1201         $members->add_child($member);
1203         $groupings->add_child($grouping);
1204         $grouping->add_child($groupinggroups);
1205         $groupinggroups->add_child($groupinggroup);
1207         // Define sources
1209         // This only happens if we are including groups/groupings.
1210         if ($groupinfo) {
1211             $group->set_source_sql("
1212                 SELECT g.*
1213                   FROM {groups} g
1214                   JOIN {backup_ids_temp} bi ON g.id = bi.itemid
1215                  WHERE bi.backupid = ?
1216                    AND bi.itemname = 'groupfinal'", array(backup::VAR_BACKUPID));
1218             $grouping->set_source_sql("
1219                 SELECT g.*
1220                   FROM {groupings} g
1221                   JOIN {backup_ids_temp} bi ON g.id = bi.itemid
1222                  WHERE bi.backupid = ?
1223                    AND bi.itemname = 'groupingfinal'", array(backup::VAR_BACKUPID));
1224             $groupinggroup->set_source_table('groupings_groups', array('groupingid' => backup::VAR_PARENTID));
1226             // This only happens if we are including users.
1227             if ($userinfo) {
1228                 $member->set_source_table('groups_members', array('groupid' => backup::VAR_PARENTID));
1229             }
1230         }
1232         // Define id annotations (as final)
1234         $member->annotate_ids('userfinal', 'userid');
1236         // Define file annotations
1238         $group->annotate_files('group', 'description', 'id');
1239         $group->annotate_files('group', 'icon', 'id');
1240         $grouping->annotate_files('grouping', 'description', 'id');
1242         // Return the root element (groups)
1243         return $groups;
1244     }
1247 /**
1248  * structure step in charge of constructing the main users.xml file for all the users already
1249  * annotated (final). Includes custom profile fields, preferences, tags, role assignments and
1250  * overrides.
1251  */
1252 class backup_users_structure_step extends backup_structure_step {
1254     protected function define_structure() {
1255         global $CFG;
1257         // To know if we are anonymizing users
1258         $anonymize = $this->get_setting_value('anonymize');
1259         // To know if we are including role assignments
1260         $roleassignments = $this->get_setting_value('role_assignments');
1262         // Define each element separate.
1264         $users = new backup_nested_element('users');
1266         // Create the array of user fields by hand, as far as we have various bits to control
1267         // anonymize option, password backup, mnethostid...
1269         // First, the fields not needing anonymization nor special handling
1270         $normalfields = array(
1271             'confirmed', 'policyagreed', 'deleted',
1272             'lang', 'theme', 'timezone', 'firstaccess',
1273             'lastaccess', 'lastlogin', 'currentlogin',
1274             'mailformat', 'maildigest', 'maildisplay',
1275             'autosubscribe', 'trackforums', 'timecreated',
1276             'timemodified', 'trustbitmask');
1278         // Then, the fields potentially needing anonymization
1279         $anonfields = array(
1280             'username', 'idnumber', 'email', 'icq', 'skype',
1281             'yahoo', 'aim', 'msn', 'phone1',
1282             'phone2', 'institution', 'department', 'address',
1283             'city', 'country', 'lastip', 'picture',
1284             'url', 'description', 'descriptionformat', 'imagealt', 'auth');
1285         $anonfields = array_merge($anonfields, get_all_user_name_fields());
1287         // Add anonymized fields to $userfields with custom final element
1288         foreach ($anonfields as $field) {
1289             if ($anonymize) {
1290                 $userfields[] = new anonymizer_final_element($field);
1291             } else {
1292                 $userfields[] = $field; // No anonymization, normally added
1293             }
1294         }
1296         // mnethosturl requires special handling (custom final element)
1297         $userfields[] = new mnethosturl_final_element('mnethosturl');
1299         // password added conditionally
1300         if (!empty($CFG->includeuserpasswordsinbackup)) {
1301             $userfields[] = 'password';
1302         }
1304         // Merge all the fields
1305         $userfields = array_merge($userfields, $normalfields);
1307         $user = new backup_nested_element('user', array('id', 'contextid'), $userfields);
1309         $customfields = new backup_nested_element('custom_fields');
1311         $customfield = new backup_nested_element('custom_field', array('id'), array(
1312             'field_name', 'field_type', 'field_data'));
1314         $tags = new backup_nested_element('tags');
1316         $tag = new backup_nested_element('tag', array('id'), array(
1317             'name', 'rawname'));
1319         $preferences = new backup_nested_element('preferences');
1321         $preference = new backup_nested_element('preference', array('id'), array(
1322             'name', 'value'));
1324         $roles = new backup_nested_element('roles');
1326         $overrides = new backup_nested_element('role_overrides');
1328         $override = new backup_nested_element('override', array('id'), array(
1329             'roleid', 'capability', 'permission', 'timemodified',
1330             'modifierid'));
1332         $assignments = new backup_nested_element('role_assignments');
1334         $assignment = new backup_nested_element('assignment', array('id'), array(
1335             'roleid', 'userid', 'timemodified', 'modifierid', 'component', //TODO: MDL-22793 add itemid here
1336             'sortorder'));
1338         // Build the tree
1340         $users->add_child($user);
1342         $user->add_child($customfields);
1343         $customfields->add_child($customfield);
1345         $user->add_child($tags);
1346         $tags->add_child($tag);
1348         $user->add_child($preferences);
1349         $preferences->add_child($preference);
1351         $user->add_child($roles);
1353         $roles->add_child($overrides);
1354         $roles->add_child($assignments);
1356         $overrides->add_child($override);
1357         $assignments->add_child($assignment);
1359         // Define sources
1361         $user->set_source_sql('SELECT u.*, c.id AS contextid, m.wwwroot AS mnethosturl
1362                                  FROM {user} u
1363                                  JOIN {backup_ids_temp} bi ON bi.itemid = u.id
1364                             LEFT JOIN {context} c ON c.instanceid = u.id AND c.contextlevel = ' . CONTEXT_USER . '
1365                             LEFT JOIN {mnet_host} m ON m.id = u.mnethostid
1366                                 WHERE bi.backupid = ?
1367                                   AND bi.itemname = ?', array(
1368                                       backup_helper::is_sqlparam($this->get_backupid()),
1369                                       backup_helper::is_sqlparam('userfinal')));
1371         // All the rest on information is only added if we arent
1372         // in an anonymized backup
1373         if (!$anonymize) {
1374             $customfield->set_source_sql('SELECT f.id, f.shortname, f.datatype, d.data
1375                                             FROM {user_info_field} f
1376                                             JOIN {user_info_data} d ON d.fieldid = f.id
1377                                            WHERE d.userid = ?', array(backup::VAR_PARENTID));
1379             $customfield->set_source_alias('shortname', 'field_name');
1380             $customfield->set_source_alias('datatype',  'field_type');
1381             $customfield->set_source_alias('data',      'field_data');
1383             $tag->set_source_sql('SELECT t.id, t.name, t.rawname
1384                                     FROM {tag} t
1385                                     JOIN {tag_instance} ti ON ti.tagid = t.id
1386                                    WHERE ti.itemtype = ?
1387                                      AND ti.itemid = ?', array(
1388                                          backup_helper::is_sqlparam('user'),
1389                                          backup::VAR_PARENTID));
1391             $preference->set_source_table('user_preferences', array('userid' => backup::VAR_PARENTID));
1393             $override->set_source_table('role_capabilities', array('contextid' => '/users/user/contextid'));
1395             // Assignments only added if specified
1396             if ($roleassignments) {
1397                 $assignment->set_source_table('role_assignments', array('contextid' => '/users/user/contextid'));
1398             }
1400             // Define id annotations (as final)
1401             $override->annotate_ids('rolefinal', 'roleid');
1402         }
1404         // Return root element (users)
1405         return $users;
1406     }
1409 /**
1410  * structure step in charge of constructing the block.xml file for one
1411  * given block (instance and positions). If the block has custom DB structure
1412  * that will go to a separate file (different step defined in block class)
1413  */
1414 class backup_block_instance_structure_step extends backup_structure_step {
1416     protected function define_structure() {
1417         global $DB;
1419         // Define each element separated
1421         $block = new backup_nested_element('block', array('id', 'contextid', 'version'), array(
1422                 'blockname', 'parentcontextid', 'showinsubcontexts', 'pagetypepattern',
1423                 'subpagepattern', 'defaultregion', 'defaultweight', 'configdata',
1424                 'timecreated', 'timemodified'));
1426         $positions = new backup_nested_element('block_positions');
1428         $position = new backup_nested_element('block_position', array('id'), array(
1429             'contextid', 'pagetype', 'subpage', 'visible',
1430             'region', 'weight'));
1432         // Build the tree
1434         $block->add_child($positions);
1435         $positions->add_child($position);
1437         // Transform configdata information if needed (process links and friends)
1438         $blockrec = $DB->get_record('block_instances', array('id' => $this->task->get_blockid()));
1439         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
1440             $configdata = (array)unserialize(base64_decode($blockrec->configdata));
1441             foreach ($configdata as $attribute => $value) {
1442                 if (in_array($attribute, $attrstotransform)) {
1443                     $configdata[$attribute] = $this->contenttransformer->process($value);
1444                 }
1445             }
1446             $blockrec->configdata = base64_encode(serialize((object)$configdata));
1447         }
1448         $blockrec->contextid = $this->task->get_contextid();
1449         // Get the version of the block
1450         $blockrec->version = get_config('block_'.$this->task->get_blockname(), 'version');
1452         // Define sources
1454         $block->set_source_array(array($blockrec));
1456         $position->set_source_table('block_positions', array('blockinstanceid' => backup::VAR_PARENTID));
1458         // File anotations (for fileareas specified on each block)
1459         foreach ($this->task->get_fileareas() as $filearea) {
1460             $block->annotate_files('block_' . $this->task->get_blockname(), $filearea, null);
1461         }
1463         // Return the root element (block)
1464         return $block;
1465     }
1468 /**
1469  * structure step in charge of constructing the logs.xml file for all the log records found
1470  * in course. Note that we are sending to backup ALL the log records having cmid = 0. That
1471  * includes some records that won't be restoreable (like 'upload', 'calendar'...) but we do
1472  * that just in case they become restored some day in the future
1473  */
1474 class backup_course_logs_structure_step extends backup_structure_step {
1476     protected function define_structure() {
1478         // Define each element separated
1480         $logs = new backup_nested_element('logs');
1482         $log = new backup_nested_element('log', array('id'), array(
1483             'time', 'userid', 'ip', 'module',
1484             'action', 'url', 'info'));
1486         // Build the tree
1488         $logs->add_child($log);
1490         // Define sources (all the records belonging to the course, having cmid = 0)
1492         $log->set_source_table('log', array('course' => backup::VAR_COURSEID, 'cmid' => backup_helper::is_sqlparam(0)));
1494         // Annotations
1495         // NOTE: We don't annotate users from logs as far as they MUST be
1496         //       always annotated by the course (enrol, ras... whatever)
1498         // Return the root element (logs)
1500         return $logs;
1501     }
1504 /**
1505  * structure step in charge of constructing the logs.xml file for all the log records found
1506  * in activity
1507  */
1508 class backup_activity_logs_structure_step extends backup_structure_step {
1510     protected function define_structure() {
1512         // Define each element separated
1514         $logs = new backup_nested_element('logs');
1516         $log = new backup_nested_element('log', array('id'), array(
1517             'time', 'userid', 'ip', 'module',
1518             'action', 'url', 'info'));
1520         // Build the tree
1522         $logs->add_child($log);
1524         // Define sources
1526         $log->set_source_table('log', array('cmid' => backup::VAR_MODID));
1528         // Annotations
1529         // NOTE: We don't annotate users from logs as far as they MUST be
1530         //       always annotated by the activity (true participants).
1532         // Return the root element (logs)
1534         return $logs;
1535     }
1538 /**
1539  * Structure step in charge of constructing the logstores.xml file for the course logs.
1540  *
1541  * This backup step will backup the logs for all the enabled logstore subplugins supporting
1542  * it, for logs belonging to the course level.
1543  */
1544 class backup_course_logstores_structure_step extends backup_structure_step {
1546     protected function define_structure() {
1548         // Define the structure of logstores container.
1549         $logstores = new backup_nested_element('logstores');
1550         $logstore = new backup_nested_element('logstore');
1551         $logstores->add_child($logstore);
1553         // Add the tool_log logstore subplugins information to the logstore element.
1554         $this->add_subplugin_structure('logstore', $logstore, true, 'tool', 'log');
1556         return $logstores;
1557     }
1560 /**
1561  * Structure step in charge of constructing the logstores.xml file for the activity logs.
1562  *
1563  * Note: Activity structure is completely equivalent to the course one, so just extend it.
1564  */
1565 class backup_activity_logstores_structure_step extends backup_course_logstores_structure_step {
1568 /**
1569  * Course competencies backup structure step.
1570  */
1571 class backup_course_competencies_structure_step extends backup_structure_step {
1573     protected function define_structure() {
1574         $userinfo = $this->get_setting_value('users');
1576         $wrapper = new backup_nested_element('course_competencies');
1578         $settings = new backup_nested_element('settings', array('id'), array('pushratingstouserplans'));
1579         $wrapper->add_child($settings);
1581         $sql = 'SELECT s.pushratingstouserplans
1582                   FROM {' . \core_competency\course_competency_settings::TABLE . '} s
1583                  WHERE s.courseid = :courseid';
1584         $settings->set_source_sql($sql, array('courseid' => backup::VAR_COURSEID));
1586         $competencies = new backup_nested_element('competencies');
1587         $wrapper->add_child($competencies);
1589         $competency = new backup_nested_element('competency', null, array('id', 'idnumber', 'ruleoutcome',
1590             'sortorder', 'frameworkid', 'frameworkidnumber'));
1591         $competencies->add_child($competency);
1593         $sql = 'SELECT c.id, c.idnumber, cc.ruleoutcome, cc.sortorder, f.id AS frameworkid, f.idnumber AS frameworkidnumber
1594                   FROM {' . \core_competency\course_competency::TABLE . '} cc
1595                   JOIN {' . \core_competency\competency::TABLE . '} c ON c.id = cc.competencyid
1596                   JOIN {' . \core_competency\competency_framework::TABLE . '} f ON f.id = c.competencyframeworkid
1597                  WHERE cc.courseid = :courseid
1598               ORDER BY cc.sortorder';
1599         $competency->set_source_sql($sql, array('courseid' => backup::VAR_COURSEID));
1601         $usercomps = new backup_nested_element('user_competencies');
1602         $wrapper->add_child($usercomps);
1603         if ($userinfo) {
1604             $usercomp = new backup_nested_element('user_competency', null, array('userid', 'competencyid',
1605                 'proficiency', 'grade'));
1606             $usercomps->add_child($usercomp);
1608             $sql = 'SELECT ucc.userid, ucc.competencyid, ucc.proficiency, ucc.grade
1609                       FROM {' . \core_competency\user_competency_course::TABLE . '} ucc
1610                      WHERE ucc.courseid = :courseid
1611                        AND ucc.grade IS NOT NULL';
1612             $usercomp->set_source_sql($sql, array('courseid' => backup::VAR_COURSEID));
1613             $usercomp->annotate_ids('user', 'userid');
1614         }
1616         return $wrapper;
1617     }
1619     /**
1620      * Execute conditions.
1621      *
1622      * @return bool
1623      */
1624     protected function execute_condition() {
1626         // Do not execute if competencies are not included.
1627         if (!$this->get_setting_value('competencies')) {
1628             return false;
1629         }
1631         return true;
1632     }
1635 /**
1636  * Activity competencies backup structure step.
1637  */
1638 class backup_activity_competencies_structure_step extends backup_structure_step {
1640     protected function define_structure() {
1641         $wrapper = new backup_nested_element('course_module_competencies');
1643         $competencies = new backup_nested_element('competencies');
1644         $wrapper->add_child($competencies);
1646         $competency = new backup_nested_element('competency', null, array('idnumber', 'ruleoutcome',
1647             'sortorder', 'frameworkidnumber'));
1648         $competencies->add_child($competency);
1650         $sql = 'SELECT c.idnumber, cmc.ruleoutcome, cmc.sortorder, f.idnumber AS frameworkidnumber
1651                   FROM {' . \core_competency\course_module_competency::TABLE . '} cmc
1652                   JOIN {' . \core_competency\competency::TABLE . '} c ON c.id = cmc.competencyid
1653                   JOIN {' . \core_competency\competency_framework::TABLE . '} f ON f.id = c.competencyframeworkid
1654                  WHERE cmc.cmid = :coursemoduleid
1655               ORDER BY cmc.sortorder';
1656         $competency->set_source_sql($sql, array('coursemoduleid' => backup::VAR_MODID));
1658         return $wrapper;
1659     }
1661     /**
1662      * Execute conditions.
1663      *
1664      * @return bool
1665      */
1666     protected function execute_condition() {
1668         // Do not execute if competencies are not included.
1669         if (!$this->get_setting_value('competencies')) {
1670             return false;
1671         }
1673         return true;
1674     }
1677 /**
1678  * structure in charge of constructing the inforef.xml file for all the items we want
1679  * to have referenced there (users, roles, files...)
1680  */
1681 class backup_inforef_structure_step extends backup_structure_step {
1683     protected function define_structure() {
1685         // Items we want to include in the inforef file.
1686         $items = backup_helper::get_inforef_itemnames();
1688         // Build the tree
1690         $inforef = new backup_nested_element('inforef');
1692         // For each item, conditionally, if there are already records, build element
1693         foreach ($items as $itemname) {
1694             if (backup_structure_dbops::annotations_exist($this->get_backupid(), $itemname)) {
1695                 $elementroot = new backup_nested_element($itemname . 'ref');
1696                 $element = new backup_nested_element($itemname, array(), array('id'));
1697                 $inforef->add_child($elementroot);
1698                 $elementroot->add_child($element);
1699                 $element->set_source_sql("
1700                     SELECT itemid AS id
1701                      FROM {backup_ids_temp}
1702                     WHERE backupid = ?
1703                       AND itemname = ?",
1704                    array(backup::VAR_BACKUPID, backup_helper::is_sqlparam($itemname)));
1705             }
1706         }
1708         // We don't annotate anything there, but rely in the next step
1709         // (move_inforef_annotations_to_final) that will change all the
1710         // already saved 'inforref' entries to their 'final' annotations.
1711         return $inforef;
1712     }
1715 /**
1716  * This step will get all the annotations already processed to inforef.xml file and
1717  * transform them into 'final' annotations.
1718  */
1719 class move_inforef_annotations_to_final extends backup_execution_step {
1721     protected function define_execution() {
1723         // Items we want to include in the inforef file
1724         $items = backup_helper::get_inforef_itemnames();
1725         $progress = $this->task->get_progress();
1726         $progress->start_progress($this->get_name(), count($items));
1727         $done = 1;
1728         foreach ($items as $itemname) {
1729             // Delegate to dbops
1730             backup_structure_dbops::move_annotations_to_final($this->get_backupid(),
1731                     $itemname, $progress);
1732             $progress->progress($done++);
1733         }
1734         $progress->end_progress();
1735     }
1738 /**
1739  * structure in charge of constructing the files.xml file with all the
1740  * annotated (final) files along the process. At, the same time, and
1741  * using one specialised nested_element, will copy them form moodle storage
1742  * to backup storage
1743  */
1744 class backup_final_files_structure_step extends backup_structure_step {
1746     protected function define_structure() {
1748         // Define elements
1750         $files = new backup_nested_element('files');
1752         $file = new file_nested_element('file', array('id'), array(
1753             'contenthash', 'contextid', 'component', 'filearea', 'itemid',
1754             'filepath', 'filename', 'userid', 'filesize',
1755             'mimetype', 'status', 'timecreated', 'timemodified',
1756             'source', 'author', 'license', 'sortorder',
1757             'repositorytype', 'repositoryid', 'reference'));
1759         // Build the tree
1761         $files->add_child($file);
1763         // Define sources
1765         $file->set_source_sql("SELECT f.*, r.type AS repositorytype, fr.repositoryid, fr.reference
1766                                  FROM {files} f
1767                                       LEFT JOIN {files_reference} fr ON fr.id = f.referencefileid
1768                                       LEFT JOIN {repository_instances} ri ON ri.id = fr.repositoryid
1769                                       LEFT JOIN {repository} r ON r.id = ri.typeid
1770                                       JOIN {backup_ids_temp} bi ON f.id = bi.itemid
1771                                 WHERE bi.backupid = ?
1772                                   AND bi.itemname = 'filefinal'", array(backup::VAR_BACKUPID));
1774         return $files;
1775     }
1778 /**
1779  * Structure step in charge of creating the main moodle_backup.xml file
1780  * where all the information related to the backup, settings, license and
1781  * other information needed on restore is added*/
1782 class backup_main_structure_step extends backup_structure_step {
1784     protected function define_structure() {
1786         global $CFG;
1788         $info = array();
1790         $info['name'] = $this->get_setting_value('filename');
1791         $info['moodle_version'] = $CFG->version;
1792         $info['moodle_release'] = $CFG->release;
1793         $info['backup_version'] = $CFG->backup_version;
1794         $info['backup_release'] = $CFG->backup_release;
1795         $info['backup_date']    = time();
1796         $info['backup_uniqueid']= $this->get_backupid();
1797         $info['mnet_remoteusers']=backup_controller_dbops::backup_includes_mnet_remote_users($this->get_backupid());
1798         $info['include_files'] = backup_controller_dbops::backup_includes_files($this->get_backupid());
1799         $info['include_file_references_to_external_content'] =
1800                 backup_controller_dbops::backup_includes_file_references($this->get_backupid());
1801         $info['original_wwwroot']=$CFG->wwwroot;
1802         $info['original_site_identifier_hash'] = md5(get_site_identifier());
1803         $info['original_course_id'] = $this->get_courseid();
1804         $originalcourseinfo = backup_controller_dbops::backup_get_original_course_info($this->get_courseid());
1805         $info['original_course_format'] = $originalcourseinfo->format;
1806         $info['original_course_fullname']  = $originalcourseinfo->fullname;
1807         $info['original_course_shortname'] = $originalcourseinfo->shortname;
1808         $info['original_course_startdate'] = $originalcourseinfo->startdate;
1809         $info['original_course_enddate']   = $originalcourseinfo->enddate;
1810         $info['original_course_contextid'] = context_course::instance($this->get_courseid())->id;
1811         $info['original_system_contextid'] = context_system::instance()->id;
1813         // Get more information from controller
1814         list($dinfo, $cinfo, $sinfo) = backup_controller_dbops::get_moodle_backup_information(
1815                 $this->get_backupid(), $this->get_task()->get_progress());
1817         // Define elements
1819         $moodle_backup = new backup_nested_element('moodle_backup');
1821         $information = new backup_nested_element('information', null, array(
1822             'name', 'moodle_version', 'moodle_release', 'backup_version',
1823             'backup_release', 'backup_date', 'mnet_remoteusers', 'include_files', 'include_file_references_to_external_content', 'original_wwwroot',
1824             'original_site_identifier_hash', 'original_course_id', 'original_course_format',
1825             'original_course_fullname', 'original_course_shortname', 'original_course_startdate', 'original_course_enddate',
1826             'original_course_contextid', 'original_system_contextid'));
1828         $details = new backup_nested_element('details');
1830         $detail = new backup_nested_element('detail', array('backup_id'), array(
1831             'type', 'format', 'interactive', 'mode',
1832             'execution', 'executiontime'));
1834         $contents = new backup_nested_element('contents');
1836         $activities = new backup_nested_element('activities');
1838         $activity = new backup_nested_element('activity', null, array(
1839             'moduleid', 'sectionid', 'modulename', 'title',
1840             'directory'));
1842         $sections = new backup_nested_element('sections');
1844         $section = new backup_nested_element('section', null, array(
1845             'sectionid', 'title', 'directory'));
1847         $course = new backup_nested_element('course', null, array(
1848             'courseid', 'title', 'directory'));
1850         $settings = new backup_nested_element('settings');
1852         $setting = new backup_nested_element('setting', null, array(
1853             'level', 'section', 'activity', 'name', 'value'));
1855         // Build the tree
1857         $moodle_backup->add_child($information);
1859         $information->add_child($details);
1860         $details->add_child($detail);
1862         $information->add_child($contents);
1863         if (!empty($cinfo['activities'])) {
1864             $contents->add_child($activities);
1865             $activities->add_child($activity);
1866         }
1867         if (!empty($cinfo['sections'])) {
1868             $contents->add_child($sections);
1869             $sections->add_child($section);
1870         }
1871         if (!empty($cinfo['course'])) {
1872             $contents->add_child($course);
1873         }
1875         $information->add_child($settings);
1876         $settings->add_child($setting);
1879         // Set the sources
1881         $information->set_source_array(array((object)$info));
1883         $detail->set_source_array($dinfo);
1885         $activity->set_source_array($cinfo['activities']);
1887         $section->set_source_array($cinfo['sections']);
1889         $course->set_source_array($cinfo['course']);
1891         $setting->set_source_array($sinfo);
1893         // Prepare some information to be sent to main moodle_backup.xml file
1894         return $moodle_backup;
1895     }
1899 /**
1900  * Execution step that will generate the final zip (.mbz) file with all the contents
1901  */
1902 class backup_zip_contents extends backup_execution_step implements file_progress {
1903     /**
1904      * @var bool True if we have started tracking progress
1905      */
1906     protected $startedprogress;
1908     protected function define_execution() {
1910         // Get basepath
1911         $basepath = $this->get_basepath();
1913         // Get the list of files in directory
1914         $filestemp = get_directory_list($basepath, '', false, true, true);
1915         $files = array();
1916         foreach ($filestemp as $file) { // Add zip paths and fs paths to all them
1917             $files[$file] = $basepath . '/' . $file;
1918         }
1920         // Add the log file if exists
1921         $logfilepath = $basepath . '.log';
1922         if (file_exists($logfilepath)) {
1923              $files['moodle_backup.log'] = $logfilepath;
1924         }
1926         // Calculate the zip fullpath (in OS temp area it's always backup.mbz)
1927         $zipfile = $basepath . '/backup.mbz';
1929         // Get the zip packer
1930         $zippacker = get_file_packer('application/vnd.moodle.backup');
1932         // Track overall progress for the 2 long-running steps (archive to
1933         // pathname, get backup information).
1934         $reporter = $this->task->get_progress();
1935         $reporter->start_progress('backup_zip_contents', 2);
1937         // Zip files
1938         $result = $zippacker->archive_to_pathname($files, $zipfile, true, $this);
1940         // If any sub-progress happened, end it.
1941         if ($this->startedprogress) {
1942             $this->task->get_progress()->end_progress();
1943             $this->startedprogress = false;
1944         } else {
1945             // No progress was reported, manually move it on to the next overall task.
1946             $reporter->progress(1);
1947         }
1949         // Something went wrong.
1950         if ($result === false) {
1951             @unlink($zipfile);
1952             throw new backup_step_exception('error_zip_packing', '', 'An error was encountered while trying to generate backup zip');
1953         }
1954         // Read to make sure it is a valid backup. Refer MDL-37877 . Delete it, if found not to be valid.
1955         try {
1956             backup_general_helper::get_backup_information_from_mbz($zipfile, $this);
1957         } catch (backup_helper_exception $e) {
1958             @unlink($zipfile);
1959             throw new backup_step_exception('error_zip_packing', '', $e->debuginfo);
1960         }
1962         // If any sub-progress happened, end it.
1963         if ($this->startedprogress) {
1964             $this->task->get_progress()->end_progress();
1965             $this->startedprogress = false;
1966         } else {
1967             $reporter->progress(2);
1968         }
1969         $reporter->end_progress();
1970     }
1972     /**
1973      * Implementation for file_progress interface to display unzip progress.
1974      *
1975      * @param int $progress Current progress
1976      * @param int $max Max value
1977      */
1978     public function progress($progress = file_progress::INDETERMINATE, $max = file_progress::INDETERMINATE) {
1979         $reporter = $this->task->get_progress();
1981         // Start tracking progress if necessary.
1982         if (!$this->startedprogress) {
1983             $reporter->start_progress('extract_file_to_dir', ($max == file_progress::INDETERMINATE)
1984                     ? \core\progress\base::INDETERMINATE : $max);
1985             $this->startedprogress = true;
1986         }
1988         // Pass progress through to whatever handles it.
1989         $reporter->progress(($progress == file_progress::INDETERMINATE)
1990                 ? \core\progress\base::INDETERMINATE : $progress);
1991      }
1994 /**
1995  * This step will send the generated backup file to its final destination
1996  */
1997 class backup_store_backup_file extends backup_execution_step {
1999     protected function define_execution() {
2001         // Get basepath
2002         $basepath = $this->get_basepath();
2004         // Calculate the zip fullpath (in OS temp area it's always backup.mbz)
2005         $zipfile = $basepath . '/backup.mbz';
2007         $has_file_references = backup_controller_dbops::backup_includes_file_references($this->get_backupid());
2008         // Perform storage and return it (TODO: shouldn't be array but proper result object)
2009         return array(
2010             'backup_destination' => backup_helper::store_backup_file($this->get_backupid(), $zipfile,
2011                     $this->task->get_progress()),
2012             'include_file_references_to_external_content' => $has_file_references
2013         );
2014     }
2018 /**
2019  * This step will search for all the activity (not calculations, categories nor aggregations) grade items
2020  * and put them to the backup_ids tables, to be used later as base to backup them
2021  */
2022 class backup_activity_grade_items_to_ids extends backup_execution_step {
2024     protected function define_execution() {
2026         // Fetch all activity grade items
2027         if ($items = grade_item::fetch_all(array(
2028                          'itemtype' => 'mod', 'itemmodule' => $this->task->get_modulename(),
2029                          'iteminstance' => $this->task->get_activityid(), 'courseid' => $this->task->get_courseid()))) {
2030             // Annotate them in backup_ids
2031             foreach ($items as $item) {
2032                 backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'grade_item', $item->id);
2033             }
2034         }
2035     }
2039 /**
2040  * This step allows enrol plugins to annotate custom fields.
2041  *
2042  * @package   core_backup
2043  * @copyright 2014 University of Wisconsin
2044  * @author    Matt Petro
2045  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2046  */
2047 class backup_enrolments_execution_step extends backup_execution_step {
2049     /**
2050      * Function that will contain all the code to be executed.
2051      */
2052     protected function define_execution() {
2053         global $DB;
2055         $plugins = enrol_get_plugins(true);
2056         $enrols = $DB->get_records('enrol', array(
2057                 'courseid' => $this->task->get_courseid()));
2059         // Allow each enrol plugin to add annotations.
2060         foreach ($enrols as $enrol) {
2061             if (isset($plugins[$enrol->enrol])) {
2062                 $plugins[$enrol->enrol]->backup_annotate_custom_fields($this, $enrol);
2063             }
2064         }
2065     }
2067     /**
2068      * Annotate a single name/id pair.
2069      * This can be called from {@link enrol_plugin::backup_annotate_custom_fields()}.
2070      *
2071      * @param string $itemname
2072      * @param int $itemid
2073      */
2074     public function annotate_id($itemname, $itemid) {
2075         backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), $itemname, $itemid);
2076     }
2079 /**
2080  * This step will annotate all the groups and groupings belonging to the course
2081  */
2082 class backup_annotate_course_groups_and_groupings extends backup_execution_step {
2084     protected function define_execution() {
2085         global $DB;
2087         // Get all the course groups
2088         if ($groups = $DB->get_records('groups', array(
2089                 'courseid' => $this->task->get_courseid()))) {
2090             foreach ($groups as $group) {
2091                 backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'group', $group->id);
2092             }
2093         }
2095         // Get all the course groupings
2096         if ($groupings = $DB->get_records('groupings', array(
2097                 'courseid' => $this->task->get_courseid()))) {
2098             foreach ($groupings as $grouping) {
2099                 backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'grouping', $grouping->id);
2100             }
2101         }
2102     }
2105 /**
2106  * This step will annotate all the groups belonging to already annotated groupings
2107  */
2108 class backup_annotate_groups_from_groupings extends backup_execution_step {
2110     protected function define_execution() {
2111         global $DB;
2113         // Fetch all the annotated groupings
2114         if ($groupings = $DB->get_records('backup_ids_temp', array(
2115                 'backupid' => $this->get_backupid(), 'itemname' => 'grouping'))) {
2116             foreach ($groupings as $grouping) {
2117                 if ($groups = $DB->get_records('groupings_groups', array(
2118                         'groupingid' => $grouping->itemid))) {
2119                     foreach ($groups as $group) {
2120                         backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'group', $group->groupid);
2121                     }
2122                 }
2123             }
2124         }
2125     }
2128 /**
2129  * This step will annotate all the scales belonging to already annotated outcomes
2130  */
2131 class backup_annotate_scales_from_outcomes extends backup_execution_step {
2133     protected function define_execution() {
2134         global $DB;
2136         // Fetch all the annotated outcomes
2137         if ($outcomes = $DB->get_records('backup_ids_temp', array(
2138                 'backupid' => $this->get_backupid(), 'itemname' => 'outcome'))) {
2139             foreach ($outcomes as $outcome) {
2140                 if ($scale = $DB->get_record('grade_outcomes', array(
2141                         'id' => $outcome->itemid))) {
2142                     // Annotate as scalefinal because it's > 0
2143                     backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'scalefinal', $scale->scaleid);
2144                 }
2145             }
2146         }
2147     }
2150 /**
2151  * This step will generate all the file annotations for the already
2152  * annotated (final) question_categories. It calculates the different
2153  * contexts that are being backup and, annotates all the files
2154  * on every context belonging to the "question" component. As far as
2155  * we are always including *complete* question banks it is safe and
2156  * optimal to do that in this (one pass) way
2157  */
2158 class backup_annotate_all_question_files extends backup_execution_step {
2160     protected function define_execution() {
2161         global $DB;
2163         // Get all the different contexts for the final question_categories
2164         // annotated along the whole backup
2165         $rs = $DB->get_recordset_sql("SELECT DISTINCT qc.contextid
2166                                         FROM {question_categories} qc
2167                                         JOIN {backup_ids_temp} bi ON bi.itemid = qc.id
2168                                        WHERE bi.backupid = ?
2169                                          AND bi.itemname = 'question_categoryfinal'", array($this->get_backupid()));
2170         // To know about qtype specific components/fileareas
2171         $components = backup_qtype_plugin::get_components_and_fileareas();
2172         // Let's loop
2173         foreach($rs as $record) {
2174             // Backup all the file areas the are managed by the core question component.
2175             // That is, by the question_type base class. In particular, we don't want
2176             // to include files belonging to responses here.
2177             backup_structure_dbops::annotate_files($this->get_backupid(), $record->contextid, 'question', 'questiontext', null);
2178             backup_structure_dbops::annotate_files($this->get_backupid(), $record->contextid, 'question', 'generalfeedback', null);
2179             backup_structure_dbops::annotate_files($this->get_backupid(), $record->contextid, 'question', 'answer', null);
2180             backup_structure_dbops::annotate_files($this->get_backupid(), $record->contextid, 'question', 'answerfeedback', null);
2181             backup_structure_dbops::annotate_files($this->get_backupid(), $record->contextid, 'question', 'hint', null);
2182             backup_structure_dbops::annotate_files($this->get_backupid(), $record->contextid, 'question', 'correctfeedback', null);
2183             backup_structure_dbops::annotate_files($this->get_backupid(), $record->contextid, 'question', 'partiallycorrectfeedback', null);
2184             backup_structure_dbops::annotate_files($this->get_backupid(), $record->contextid, 'question', 'incorrectfeedback', null);
2186             // For files belonging to question types, we make the leap of faith that
2187             // all the files belonging to the question type are part of the question definition,
2188             // so we can just backup all the files in bulk, without specifying each
2189             // file area name separately.
2190             foreach ($components as $component => $fileareas) {
2191                 backup_structure_dbops::annotate_files($this->get_backupid(), $record->contextid, $component, null, null);
2192             }
2193         }
2194         $rs->close();
2195     }
2198 /**
2199  * structure step in charge of constructing the questions.xml file for all the
2200  * question categories and questions required by the backup
2201  * and letters related to one activity
2202  */
2203 class backup_questions_structure_step extends backup_structure_step {
2205     protected function define_structure() {
2207         // Define each element separated
2209         $qcategories = new backup_nested_element('question_categories');
2211         $qcategory = new backup_nested_element('question_category', array('id'), array(
2212             'name', 'contextid', 'contextlevel', 'contextinstanceid',
2213             'info', 'infoformat', 'stamp', 'parent',
2214             'sortorder', 'idnumber'));
2216         $questions = new backup_nested_element('questions');
2218         $question = new backup_nested_element('question', array('id'), array(
2219             'parent', 'name', 'questiontext', 'questiontextformat',
2220             'generalfeedback', 'generalfeedbackformat', 'defaultmark', 'penalty',
2221             'qtype', 'length', 'stamp', 'version',
2222             'hidden', 'timecreated', 'timemodified', 'createdby', 'modifiedby', 'idnumber'));
2224         // attach qtype plugin structure to $question element, only one allowed
2225         $this->add_plugin_structure('qtype', $question, false);
2227         // attach local plugin stucture to $question element, multiple allowed
2228         $this->add_plugin_structure('local', $question, true);
2230         $qhints = new backup_nested_element('question_hints');
2232         $qhint = new backup_nested_element('question_hint', array('id'), array(
2233             'hint', 'hintformat', 'shownumcorrect', 'clearwrong', 'options'));
2235         $tags = new backup_nested_element('tags');
2237         $tag = new backup_nested_element('tag', array('id', 'contextid'), array('name', 'rawname'));
2239         // Build the tree
2241         $qcategories->add_child($qcategory);
2242         $qcategory->add_child($questions);
2243         $questions->add_child($question);
2244         $question->add_child($qhints);
2245         $qhints->add_child($qhint);
2247         $question->add_child($tags);
2248         $tags->add_child($tag);
2250         // Define the sources
2252         $qcategory->set_source_sql("
2253             SELECT gc.*, contextlevel, instanceid AS contextinstanceid
2254               FROM {question_categories} gc
2255               JOIN {backup_ids_temp} bi ON bi.itemid = gc.id
2256               JOIN {context} co ON co.id = gc.contextid
2257              WHERE bi.backupid = ?
2258                AND bi.itemname = 'question_categoryfinal'", array(backup::VAR_BACKUPID));
2260         $question->set_source_table('question', array('category' => backup::VAR_PARENTID));
2262         $qhint->set_source_sql('
2263                 SELECT *
2264                 FROM {question_hints}
2265                 WHERE questionid = :questionid
2266                 ORDER BY id',
2267                 array('questionid' => backup::VAR_PARENTID));
2269         $tag->set_source_sql("SELECT t.id, ti.contextid, t.name, t.rawname
2270                               FROM {tag} t
2271                               JOIN {tag_instance} ti ON ti.tagid = t.id
2272                               WHERE ti.itemid = ?
2273                               AND ti.itemtype = 'question'", array(backup::VAR_PARENTID));
2275         // don't need to annotate ids nor files
2276         // (already done by {@link backup_annotate_all_question_files}
2278         return $qcategories;
2279     }
2284 /**
2285  * This step will generate all the file  annotations for the already
2286  * annotated (final) users. Need to do this here because each user
2287  * has its own context and structure tasks only are able to handle
2288  * one context. Also, this step will guarantee that every user has
2289  * its context created (req for other steps)
2290  */
2291 class backup_annotate_all_user_files extends backup_execution_step {
2293     protected function define_execution() {
2294         global $DB;
2296         // List of fileareas we are going to annotate
2297         $fileareas = array('profile', 'icon');
2299         // Fetch all annotated (final) users
2300         $rs = $DB->get_recordset('backup_ids_temp', array(
2301             'backupid' => $this->get_backupid(), 'itemname' => 'userfinal'));
2302         $progress = $this->task->get_progress();
2303         $progress->start_progress($this->get_name());
2304         foreach ($rs as $record) {
2305             $userid = $record->itemid;
2306             $userctx = context_user::instance($userid, IGNORE_MISSING);
2307             if (!$userctx) {
2308                 continue; // User has not context, sure it's a deleted user, so cannot have files
2309             }
2310             // Proceed with every user filearea
2311             foreach ($fileareas as $filearea) {
2312                 // We don't need to specify itemid ($userid - 5th param) as far as by
2313                 // context we can get all the associated files. See MDL-22092
2314                 backup_structure_dbops::annotate_files($this->get_backupid(), $userctx->id, 'user', $filearea, null);
2315                 $progress->progress();
2316             }
2317         }
2318         $progress->end_progress();
2319         $rs->close();
2320     }
2324 /**
2325  * Defines the backup step for advanced grading methods attached to the activity module
2326  */
2327 class backup_activity_grading_structure_step extends backup_structure_step {
2329     /**
2330      * Include the grading.xml only if the module supports advanced grading
2331      */
2332     protected function execute_condition() {
2334         // No grades on the front page.
2335         if ($this->get_courseid() == SITEID) {
2336             return false;
2337         }
2339         return plugin_supports('mod', $this->get_task()->get_modulename(), FEATURE_ADVANCED_GRADING, false);
2340     }
2342     /**
2343      * Declares the gradable areas structures and data sources
2344      */
2345     protected function define_structure() {
2347         // To know if we are including userinfo
2348         $userinfo = $this->get_setting_value('userinfo');
2350         // Define the elements
2352         $areas = new backup_nested_element('areas');
2354         $area = new backup_nested_element('area', array('id'), array(
2355             'areaname', 'activemethod'));
2357         $definitions = new backup_nested_element('definitions');
2359         $definition = new backup_nested_element('definition', array('id'), array(
2360             'method', 'name', 'description', 'descriptionformat', 'status',
2361             'timecreated', 'timemodified', 'options'));
2363         $instances = new backup_nested_element('instances');
2365         $instance = new backup_nested_element('instance', array('id'), array(
2366             'raterid', 'itemid', 'rawgrade', 'status', 'feedback',
2367             'feedbackformat', 'timemodified'));
2369         // Build the tree including the method specific structures
2370         // (beware - the order of how gradingform plugins structures are attached is important)
2371         $areas->add_child($area);
2372         // attach local plugin stucture to $area element, multiple allowed
2373         $this->add_plugin_structure('local', $area, true);
2374         $area->add_child($definitions);
2375         $definitions->add_child($definition);
2376         $this->add_plugin_structure('gradingform', $definition, true);
2377         // attach local plugin stucture to $definition element, multiple allowed
2378         $this->add_plugin_structure('local', $definition, true);
2379         $definition->add_child($instances);
2380         $instances->add_child($instance);
2381         $this->add_plugin_structure('gradingform', $instance, false);
2382         // attach local plugin stucture to $instance element, multiple allowed
2383         $this->add_plugin_structure('local', $instance, true);
2385         // Define data sources
2387         $area->set_source_table('grading_areas', array('contextid' => backup::VAR_CONTEXTID,
2388             'component' => array('sqlparam' => 'mod_'.$this->get_task()->get_modulename())));
2390         $definition->set_source_table('grading_definitions', array('areaid' => backup::VAR_PARENTID));
2392         if ($userinfo) {
2393             $instance->set_source_table('grading_instances', array('definitionid' => backup::VAR_PARENTID));
2394         }
2396         // Annotate references
2397         $definition->annotate_files('grading', 'description', 'id');
2398         $instance->annotate_ids('user', 'raterid');
2400         // Return the root element
2401         return $areas;
2402     }
2406 /**
2407  * structure step in charge of constructing the grades.xml file for all the grade items
2408  * and letters related to one activity
2409  */
2410 class backup_activity_grades_structure_step extends backup_structure_step {
2412     /**
2413      * No grades on the front page.
2414      * @return bool
2415      */
2416     protected function execute_condition() {
2417         return ($this->get_courseid() != SITEID);
2418     }
2420     protected function define_structure() {
2421         global $CFG;
2423         require_once($CFG->libdir . '/grade/constants.php');
2425         // To know if we are including userinfo
2426         $userinfo = $this->get_setting_value('userinfo');
2428         // Define each element separated
2430         $book = new backup_nested_element('activity_gradebook');
2432         $items = new backup_nested_element('grade_items');
2434         $item = new backup_nested_element('grade_item', array('id'), array(
2435             'categoryid', 'itemname', 'itemtype', 'itemmodule',
2436             'iteminstance', 'itemnumber', 'iteminfo', 'idnumber',
2437             'calculation', 'gradetype', 'grademax', 'grademin',
2438             'scaleid', 'outcomeid', 'gradepass', 'multfactor',
2439             'plusfactor', 'aggregationcoef', 'aggregationcoef2', 'weightoverride',
2440             'sortorder', 'display', 'decimals', 'hidden', 'locked', 'locktime',
2441             'needsupdate', 'timecreated', 'timemodified'));
2443         $grades = new backup_nested_element('grade_grades');
2445         $grade = new backup_nested_element('grade_grade', array('id'), array(
2446             'userid', 'rawgrade', 'rawgrademax', 'rawgrademin',
2447             'rawscaleid', 'usermodified', 'finalgrade', 'hidden',
2448             'locked', 'locktime', 'exported', 'overridden',
2449             'excluded', 'feedback', 'feedbackformat', 'information',
2450             'informationformat', 'timecreated', 'timemodified',
2451             'aggregationstatus', 'aggregationweight'));
2453         $letters = new backup_nested_element('grade_letters');
2455         $letter = new backup_nested_element('grade_letter', 'id', array(
2456             'lowerboundary', 'letter'));
2458         // Build the tree
2460         $book->add_child($items);
2461         $items->add_child($item);
2463         $item->add_child($grades);
2464         $grades->add_child($grade);
2466         $book->add_child($letters);
2467         $letters->add_child($letter);
2469         // Define sources
2471         $item->set_source_sql("SELECT gi.*
2472                                FROM {grade_items} gi
2473                                JOIN {backup_ids_temp} bi ON gi.id = bi.itemid
2474                                WHERE bi.backupid = ?
2475                                AND bi.itemname = 'grade_item'", array(backup::VAR_BACKUPID));
2477         // This only happens if we are including user info
2478         if ($userinfo) {
2479             $grade->set_source_table('grade_grades', array('itemid' => backup::VAR_PARENTID));
2480             $grade->annotate_files(GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA, 'id');
2481         }
2483         $letter->set_source_table('grade_letters', array('contextid' => backup::VAR_CONTEXTID));
2485         // Annotations
2487         $item->annotate_ids('scalefinal', 'scaleid'); // Straight as scalefinal because it's > 0
2488         $item->annotate_ids('outcome', 'outcomeid');
2490         $grade->annotate_ids('user', 'userid');
2491         $grade->annotate_ids('user', 'usermodified');
2493         // Return the root element (book)
2495         return $book;
2496     }
2499 /**
2500  * Structure step in charge of constructing the grade history of an activity.
2501  *
2502  * This step is added to the task regardless of the setting 'grade_histories'.
2503  * The reason is to allow for a more flexible step in case the logic needs to be
2504  * split accross different settings to control the history of items and/or grades.
2505  */
2506 class backup_activity_grade_history_structure_step extends backup_structure_step {
2508     /**
2509      * No grades on the front page.
2510      * @return bool
2511      */
2512     protected function execute_condition() {
2513         return ($this->get_courseid() != SITEID);
2514     }
2516     protected function define_structure() {
2517         global $CFG;
2519         require_once($CFG->libdir . '/grade/constants.php');
2521         // Settings to use.
2522         $userinfo = $this->get_setting_value('userinfo');
2523         $history = $this->get_setting_value('grade_histories');
2525         // Create the nested elements.
2526         $bookhistory = new backup_nested_element('grade_history');
2527         $grades = new backup_nested_element('grade_grades');
2528         $grade = new backup_nested_element('grade_grade', array('id'), array(
2529             'action', 'oldid', 'source', 'loggeduser', 'itemid', 'userid',
2530             'rawgrade', 'rawgrademax', 'rawgrademin', 'rawscaleid',
2531             'usermodified', 'finalgrade', 'hidden', 'locked', 'locktime', 'exported', 'overridden',
2532             'excluded', 'feedback', 'feedbackformat', 'information',
2533             'informationformat', 'timemodified'));
2535         // Build the tree.
2536         $bookhistory->add_child($grades);
2537         $grades->add_child($grade);
2539         // This only happens if we are including user info and history.
2540         if ($userinfo && $history) {
2541             // Define sources. Only select the history related to existing activity items.
2542             $grade->set_source_sql("SELECT ggh.*
2543                                      FROM {grade_grades_history} ggh
2544                                      JOIN {backup_ids_temp} bi ON ggh.itemid = bi.itemid
2545                                     WHERE bi.backupid = ?
2546                                       AND bi.itemname = 'grade_item'", array(backup::VAR_BACKUPID));
2547             $grade->annotate_files(GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA, 'id');
2548         }
2550         // Annotations.
2551         $grade->annotate_ids('scalefinal', 'rawscaleid'); // Straight as scalefinal because it's > 0.
2552         $grade->annotate_ids('user', 'loggeduser');
2553         $grade->annotate_ids('user', 'userid');
2554         $grade->annotate_ids('user', 'usermodified');
2556         // Return the root element.
2557         return $bookhistory;
2558     }
2561 /**
2562  * Backups up the course completion information for the course.
2563  */
2564 class backup_course_completion_structure_step extends backup_structure_step {
2566     protected function execute_condition() {
2568         // No completion on front page.
2569         if ($this->get_courseid() == SITEID) {
2570             return false;
2571         }
2573         // Check that all activities have been included
2574         if ($this->task->is_excluding_activities()) {
2575             return false;
2576         }
2577         return true;
2578     }
2580     /**
2581      * The structure of the course completion backup
2582      *
2583      * @return backup_nested_element
2584      */
2585     protected function define_structure() {
2587         // To know if we are including user completion info
2588         $userinfo = $this->get_setting_value('userscompletion');
2590         $cc = new backup_nested_element('course_completion');
2592         $criteria = new backup_nested_element('course_completion_criteria', array('id'), array(
2593             'course', 'criteriatype', 'module', 'moduleinstance', 'courseinstanceshortname', 'enrolperiod',
2594             'timeend', 'gradepass', 'role', 'roleshortname'
2595         ));
2597         $criteriacompletions = new backup_nested_element('course_completion_crit_completions');
2599         $criteriacomplete = new backup_nested_element('course_completion_crit_compl', array('id'), array(
2600             'criteriaid', 'userid', 'gradefinal', 'unenrolled', 'timecompleted'
2601         ));
2603         $coursecompletions = new backup_nested_element('course_completions', array('id'), array(
2604             'userid', 'course', 'timeenrolled', 'timestarted', 'timecompleted', 'reaggregate'
2605         ));
2607         $aggregatemethod = new backup_nested_element('course_completion_aggr_methd', array('id'), array(
2608             'course','criteriatype','method','value'
2609         ));
2611         $cc->add_child($criteria);
2612             $criteria->add_child($criteriacompletions);
2613                 $criteriacompletions->add_child($criteriacomplete);
2614         $cc->add_child($coursecompletions);
2615         $cc->add_child($aggregatemethod);
2617         // We need some extra data for the restore.
2618         // - courseinstances shortname rather than an ID.
2619         // - roleshortname in case restoring on a different site.
2620         $sourcesql = "SELECT ccc.*, c.shortname AS courseinstanceshortname, r.shortname AS roleshortname
2621                         FROM {course_completion_criteria} ccc
2622                    LEFT JOIN {course} c ON c.id = ccc.courseinstance
2623                    LEFT JOIN {role} r ON r.id = ccc.role
2624                        WHERE ccc.course = ?";
2625         $criteria->set_source_sql($sourcesql, array(backup::VAR_COURSEID));
2627         $aggregatemethod->set_source_table('course_completion_aggr_methd', array('course' => backup::VAR_COURSEID));
2629         if ($userinfo) {
2630             $criteriacomplete->set_source_table('course_completion_crit_compl', array('criteriaid' => backup::VAR_PARENTID));
2631             $coursecompletions->set_source_table('course_completions', array('course' => backup::VAR_COURSEID));
2632         }
2634         $criteria->annotate_ids('role', 'role');
2635         $criteriacomplete->annotate_ids('user', 'userid');
2636         $coursecompletions->annotate_ids('user', 'userid');
2638         return $cc;
2640     }
2643 /**
2644  * Backup completion defaults for each module type.
2645  *
2646  * @package     core_backup
2647  * @copyright   2017 Marina Glancy
2648  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2649  */
2650 class backup_completion_defaults_structure_step extends backup_structure_step {
2652     /**
2653      * To conditionally decide if one step will be executed or no
2654      */
2655     protected function execute_condition() {
2656         // No completion on front page.
2657         if ($this->get_courseid() == SITEID) {
2658             return false;
2659         }
2660         return true;
2661     }
2663     /**
2664      * The structure of the course completion backup
2665      *
2666      * @return backup_nested_element
2667      */
2668     protected function define_structure() {
2670         $cc = new backup_nested_element('course_completion_defaults');
2672         $defaults = new backup_nested_element('course_completion_default', array('id'), array(
2673             'modulename', 'completion', 'completionview', 'completionusegrade', 'completionexpected', 'customrules'
2674         ));
2676         // Use module name instead of module id so we can insert into another site later.
2677         $sourcesql = "SELECT d.id, m.name as modulename, d.completion, d.completionview, d.completionusegrade,
2678                   d.completionexpected, d.customrules
2679                 FROM {course_completion_defaults} d join {modules} m on d.module = m.id
2680                 WHERE d.course = ?";
2681         $defaults->set_source_sql($sourcesql, array(backup::VAR_COURSEID));
2683         $cc->add_child($defaults);
2684         return $cc;
2686     }