Merge branch 'MDL-12403-master' of git://github.com/danpoltawski/moodle
[moodle.git] / backup / moodle2 / backup_course_task.class.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 backup_course_task
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 /**
29  * course task that provides all the properties and common steps to be performed
30  * when one course is being backup
31  *
32  * TODO: Finish phpdocs
33  */
34 class backup_course_task extends backup_task {
36     protected $courseid;
37     protected $contextid;
39     /**
40      * Constructor - instantiates one object of this class
41      */
42     public function __construct($name, $courseid, $plan = null) {
44         $this->courseid   = $courseid;
45         $this->contextid  = context_course::instance($this->courseid)->id;
47         parent::__construct($name, $plan);
48     }
50     public function get_contextid() {
51         return $this->contextid;
52     }
54     /**
55      * Course tasks have their own directory to write files
56      */
57     public function get_taskbasepath() {
59         return $this->get_basepath() . '/course';
60     }
62     /**
63      * Create all the steps that will be part of this task
64      */
65     public function build() {
67         // Add some extra settings that related processors are going to need
68         $this->add_setting(new backup_activity_generic_setting(backup::VAR_COURSEID, base_setting::IS_INTEGER, $this->get_courseid()));
69         $this->add_setting(new backup_activity_generic_setting(backup::VAR_CONTEXTID, base_setting::IS_INTEGER, $this->contextid));
71         // Create the course directory
72         $this->add_step(new create_taskbasepath_directory('create_course_directory'));
74         // Create the course.xml file with course & category information
75         // annotating some bits, tags and module restrictions
76         $this->add_step(new backup_course_structure_step('course_info', 'course.xml'));
78         // Generate the enrolment file (conditionally, prevent it in any IMPORT/HUB operation)
79         if ($this->plan->get_mode() != backup::MODE_IMPORT && $this->plan->get_mode() != backup::MODE_HUB) {
80             $this->add_step(new backup_enrolments_structure_step('course_enrolments', 'enrolments.xml'));
81         }
83         // Annotate all the groups and groupings belonging to the course
84         $this->add_step(new backup_annotate_course_groups_and_groupings('annotate_course_groups'));
86         // Annotate the groups used in already annotated groupings (note this may be
87         // unnecessary now that we are annotating all the course groups and groupings in the
88         // step above. But we keep it working in case we decide, someday, to introduce one
89         // setting to transform the step above into an optional one. This is here to support
90         // course->defaultgroupingid
91         $this->add_step(new backup_annotate_groups_from_groupings('annotate_groups_from_groupings'));
93         // Annotate the question_categories belonging to the course context (conditionally).
94         if ($this->get_setting_value('questionbank')) {
95             $this->add_step(new backup_calculate_question_categories('course_question_categories'));
96         }
98         // Generate the roles file (optionally role assignments and always role overrides)
99         $this->add_step(new backup_roles_structure_step('course_roles', 'roles.xml'));
101         // Generate the filter file (conditionally)
102         if ($this->get_setting_value('filters')) {
103             $this->add_step(new backup_filters_structure_step('course_filters', 'filters.xml'));
104         }
106         // Generate the comments file (conditionally)
107         if ($this->get_setting_value('comments')) {
108             $this->add_step(new backup_comments_structure_step('course_comments', 'comments.xml'));
109         }
111         // Generate the calender events file (conditionally)
112         if ($this->get_setting_value('calendarevents')) {
113             $this->add_step(new backup_calendarevents_structure_step('course_calendar', 'calendar.xml'));
114         }
116         // Generate the logs file (conditionally)
117         if ($this->get_setting_value('logs')) {
118             $this->add_step(new backup_course_logs_structure_step('course_logs', 'logs.xml'));
119         }
121         // Generate the inforef file (must be after ALL steps gathering annotations of ANY type)
122         $this->add_step(new backup_inforef_structure_step('course', 'inforef.xml'));
124         // Migrate the already exported inforef entries to final ones
125         $this->add_step(new move_inforef_annotations_to_final('migrate_inforef'));
127         // At the end, mark it as built
128         $this->built = true;
129     }
131     /**
132      * Code the transformations to perform in the course in
133      * order to get transportable (encoded) links
134      */
135     static public function encode_content_links($content) {
136         global $CFG;
138         $base = preg_quote($CFG->wwwroot, '/');
140         // Link to the course main page (it also covers "&topic=xx" and "&week=xx"
141         // because they don't become transformed (section number) in backup/restore
142         $search = '/(' . $base . '\/course\/view.php\?id\=)([0-9]+)/';
143         $content= preg_replace($search, '$@COURSEVIEWBYID*$2@$', $content);
145         return $content;
146     }
148 // Protected API starts here
150     /**
151      * Define the common setting that any backup section will have
152      */
153     protected function define_settings() {
155         // Nothing to add, sections doesn't have common settings (for now)
157     }