3 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
19 * Defines backup_course_task
21 * @package core_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
29 * course task that provides all the properties and common steps to be performed
30 * when one course is being backup
32 * TODO: Finish phpdocs
34 class backup_course_task
extends backup_task
{
40 * Constructor - instantiates one object of this class
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);
50 public function get_contextid() {
51 return $this->contextid
;
55 * Course tasks have their own directory to write files
57 public function get_taskbasepath() {
59 return $this->get_basepath() . '/course';
63 * Create all the steps that will be part of this task
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'));
83 // Annotate enrolment custom fields.
84 $this->add_step(new backup_enrolments_execution_step('annotate_enrol_custom_fields'));
86 // Annotate all the groups and groupings belonging to the course
87 $this->add_step(new backup_annotate_course_groups_and_groupings('annotate_course_groups'));
89 // Annotate the groups used in already annotated groupings (note this may be
90 // unnecessary now that we are annotating all the course groups and groupings in the
91 // step above. But we keep it working in case we decide, someday, to introduce one
92 // setting to transform the step above into an optional one. This is here to support
93 // course->defaultgroupingid
94 $this->add_step(new backup_annotate_groups_from_groupings('annotate_groups_from_groupings'));
96 // Annotate the question_categories belonging to the course context (conditionally).
97 if ($this->get_setting_value('questionbank')) {
98 $this->add_step(new backup_calculate_question_categories('course_question_categories'));
101 // Generate the roles file (optionally role assignments and always role overrides)
102 $this->add_step(new backup_roles_structure_step('course_roles', 'roles.xml'));
104 // Generate the filter file (conditionally)
105 if ($this->get_setting_value('filters')) {
106 $this->add_step(new backup_filters_structure_step('course_filters', 'filters.xml'));
109 // Generate the comments file (conditionally)
110 if ($this->get_setting_value('comments')) {
111 $this->add_step(new backup_comments_structure_step('course_comments', 'comments.xml'));
114 // Generate the calender events file (conditionally)
115 if ($this->get_setting_value('calendarevents')) {
116 $this->add_step(new backup_calendarevents_structure_step('course_calendar', 'calendar.xml'));
119 // Generate the logs file (conditionally)
120 if ($this->get_setting_value('logs')) {
121 $this->add_step(new backup_course_logs_structure_step('course_logs', 'logs.xml'));
124 // Generate the inforef file (must be after ALL steps gathering annotations of ANY type)
125 $this->add_step(new backup_inforef_structure_step('course', 'inforef.xml'));
127 // Migrate the already exported inforef entries to final ones
128 $this->add_step(new move_inforef_annotations_to_final('migrate_inforef'));
130 // At the end, mark it as built
135 * Code the transformations to perform in the course in
136 * order to get transportable (encoded) links
137 * @param string $content content in which to encode links.
138 * @return string content with links encoded.
140 static public function encode_content_links($content) {
142 // Link to the course main page (it also covers "&topic=xx" and "&week=xx"
143 // because they don't become transformed (section number) in backup/restore.
144 $content = self
::encode_links_helper($content, 'COURSEVIEWBYID', '/course/view.php?id=');
146 // A few other key course links.
147 $content = self
::encode_links_helper($content, 'GRADEINDEXBYID', '/grade/index.php?id=');
148 $content = self
::encode_links_helper($content, 'GRADEREPORTINDEXBYID', '/grade/report/index.php?id=');
149 $content = self
::encode_links_helper($content, 'BADGESVIEWBYID', '/badges/view.php?type=2&id=');
150 $content = self
::encode_links_helper($content, 'USERINDEXVIEWBYID', '/user/index.php?id=');
156 * Helper method, used by encode_content_links.
157 * @param string $content content in which to encode links.
158 * @param unknown_type $name the name of this type of encoded link.
159 * @param unknown_type $path the path that identifies this type of link, up
160 * to the ?paramname= bit.
161 * @return string content with one type of link encoded.
163 static private function encode_links_helper($content, $name, $path) {
165 $base = preg_quote($CFG->wwwroot
. $path, '/');
166 return preg_replace('/(' . $base . ')([0-9]+)/', '$@' . $name . '*$2@$', $content);
169 // Protected API starts here
172 * Define the common setting that any backup section will have
174 protected function define_settings() {
176 // Nothing to add, sections doesn't have common settings (for now)