MDL-69995 backup: padding before activity icons.
[moodle.git] / backup / moodle2 / backup_activity_task.class.php
CommitLineData
77547b46
EL
1<?php
2
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/>.
17
18/**
cfab878c
DM
19 * Defines backup_activity_task class
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
77547b46
EL
26 */
27
cfab878c
DM
28defined('MOODLE_INTERNAL') || die();
29
77547b46 30/**
cfab878c 31 * Provides all the settings and steps to perform one complete backup of the activity
77547b46 32 *
cfab878c
DM
33 * Activities are supposed to provide the subclass of this class in their file
34 * mod/MODULENAME/backup/moodle2/backup_MODULENAME_activity_task.class.php
35 * The expected name of the subclass is backup_MODULENAME_activity_task
77547b46
EL
36 */
37abstract class backup_activity_task extends backup_task {
38
39 protected $moduleid;
40 protected $sectionid;
41 protected $modulename;
42 protected $activityid;
43 protected $contextid;
44
45 /**
46 * Constructor - instantiates one object of this class
cfab878c
DM
47 *
48 * @param string $name the task identifier
49 * @param int $moduleid course module id (id in course_modules table)
50 * @param backup_plan|null $plan the backup plan instance this task is part of
77547b46
EL
51 */
52 public function __construct($name, $moduleid, $plan = null) {
53
54 // Check moduleid exists
55 if (!$coursemodule = get_coursemodule_from_id(false, $moduleid)) {
2d3522ae 56 throw new backup_task_exception('activity_task_coursemodule_not_found', $moduleid);
77547b46
EL
57 }
58 // Check activity supports this moodle2 backup format
59 if (!plugin_supports('mod', $coursemodule->modname, FEATURE_BACKUP_MOODLE2)) {
2d3522ae 60 throw new backup_task_exception('activity_task_activity_lacks_moodle2_backup_support', $coursemodule->modname);
77547b46
EL
61 }
62
63 $this->moduleid = $moduleid;
64 $this->sectionid = $coursemodule->section;
65 $this->modulename = $coursemodule->modname;
66 $this->activityid = $coursemodule->instance;
a689cd1d 67 $this->contextid = context_module::instance($this->moduleid)->id;
77547b46
EL
68
69 parent::__construct($name, $plan);
70 }
71
cfab878c
DM
72 /**
73 * @return int the course module id (id in the course_modules table)
74 */
77547b46
EL
75 public function get_moduleid() {
76 return $this->moduleid;
77 }
78
cfab878c
DM
79 /**
80 * @return int the course section id (id in the course_sections table)
81 */
77547b46
EL
82 public function get_sectionid() {
83 return $this->sectionid;
84 }
85
cfab878c
DM
86 /**
87 * @return string the name of the module, eg 'workshop' (from the modules table)
88 */
77547b46
EL
89 public function get_modulename() {
90 return $this->modulename;
91 }
92
cfab878c
DM
93 /**
94 * @return int the id of the activity instance (id in the activity's instances table)
95 */
77547b46
EL
96 public function get_activityid() {
97 return $this->activityid;
98 }
99
cfab878c
DM
100 /**
101 * @return int the id of the associated CONTEXT_MODULE instance
102 */
77547b46
EL
103 public function get_contextid() {
104 return $this->contextid;
105 }
106
107 /**
cfab878c 108 * @return string full path to the directory where this task writes its files
77547b46
EL
109 */
110 public function get_taskbasepath() {
111 return $this->get_basepath() . '/activities/' . $this->modulename . '_' . $this->moduleid;
112 }
113
114 /**
115 * Create all the steps that will be part of this task
116 */
117 public function build() {
118
1c9e93c7
EL
119 // If we have decided not to backup activities, prevent anything to be built
120 if (!$this->get_setting_value('activities')) {
121 $this->built = true;
122 return;
123 }
124
77547b46
EL
125 // Add some extra settings that related processors are going to need
126 $this->add_setting(new backup_activity_generic_setting(backup::VAR_MODID, base_setting::IS_INTEGER, $this->moduleid));
127 $this->add_setting(new backup_activity_generic_setting(backup::VAR_COURSEID, base_setting::IS_INTEGER, $this->get_courseid()));
128 $this->add_setting(new backup_activity_generic_setting(backup::VAR_SECTIONID, base_setting::IS_INTEGER, $this->sectionid));
129 $this->add_setting(new backup_activity_generic_setting(backup::VAR_MODNAME, base_setting::IS_FILENAME, $this->modulename));
130 $this->add_setting(new backup_activity_generic_setting(backup::VAR_ACTIVITYID, base_setting::IS_INTEGER, $this->activityid));
131 $this->add_setting(new backup_activity_generic_setting(backup::VAR_CONTEXTID, base_setting::IS_INTEGER, $this->contextid));
132
133 // Create the activity directory
134 $this->add_step(new create_taskbasepath_directory('create_activity_directory'));
135
39b5371c 136 // Generate the module.xml file, containing general information for the
77547b46
EL
137 // activity and from its related course_modules record and availability
138 $this->add_step(new backup_module_structure_step('module_info', 'module.xml'));
139
868b086c
MS
140 // Annotate the groups used in already annotated groupings if groups are to be backed up.
141 if ($this->get_setting_value('groups')) {
142 $this->add_step(new backup_annotate_groups_from_groupings('annotate_groups'));
143 }
77547b46
EL
144
145 // Here we add all the common steps for any activity and, in the point of interest
146 // we call to define_my_steps() is order to get the particular ones inserted in place.
147 $this->define_my_steps();
148
149 // Generate the roles file (optionally role assignments and always role overrides)
150 $this->add_step(new backup_roles_structure_step('activity_roles', 'roles.xml'));
151
152 // Generate the filter file (conditionally)
153 if ($this->get_setting_value('filters')) {
154 $this->add_step(new backup_filters_structure_step('activity_filters', 'filters.xml'));
155 }
156
157 // Generate the comments file (conditionally)
158 if ($this->get_setting_value('comments')) {
159 $this->add_step(new backup_comments_structure_step('activity_comments', 'comments.xml'));
160 }
161
162 // Generate the userscompletion file (conditionally)
163 if ($this->get_setting_value('userscompletion')) {
164 $this->add_step(new backup_userscompletion_structure_step('activity_userscompletion', 'completion.xml'));
165 }
166
167 // Generate the logs file (conditionally)
168 if ($this->get_setting_value('logs')) {
73c2a354 169 // Legacy logs.
77547b46 170 $this->add_step(new backup_activity_logs_structure_step('activity_logs', 'logs.xml'));
73c2a354
EL
171 // New log stores.
172 $this->add_step(new backup_activity_logstores_structure_step('activity_logstores', 'logstores.xml'));
77547b46
EL
173 }
174
8331a159
AA
175 // Generate the calendar events file (conditionally)
176 if ($this->get_setting_value('calendarevents')) {
177 $this->add_step(new backup_calendarevents_structure_step('activity_calendar', 'calendar.xml'));
178 }
179
77547b46
EL
180 // Fetch all the activity grade items and put them to backup_ids
181 $this->add_step(new backup_activity_grade_items_to_ids('fetch_activity_grade_items'));
182
183 // Generate the grades file
184 $this->add_step(new backup_activity_grades_structure_step('activity_grades', 'grades.xml'));
185
9b553d47
DM
186 // Generate the grading file (conditionally)
187 $this->add_step(new backup_activity_grading_structure_step('activity_grading', 'grading.xml'));
188
167eb033
FM
189 // Generate the grade history file. The setting 'grade_histories' is handled in the step.
190 $this->add_step(new backup_activity_grade_history_structure_step('activity_grade_history', 'grade_history.xml'));
191
8417c3a6
FM
192 // Generate the competency file.
193 $this->add_step(new backup_activity_competencies_structure_step('activity_competencies', 'competencies.xml'));
194
77547b46
EL
195 // Annotate the scales used in already annotated outcomes
196 $this->add_step(new backup_annotate_scales_from_outcomes('annotate_scales'));
197
198 // NOTE: Historical grade information is saved completely at course level only (see 1.9)
199 // not per activity nor per selected activities (all or nothing).
200
201 // Generate the inforef file (must be after ALL steps gathering annotations of ANY type)
202 $this->add_step(new backup_inforef_structure_step('activity_inforef', 'inforef.xml'));
203
204 // Migrate the already exported inforef entries to final ones
205 $this->add_step(new move_inforef_annotations_to_final('migrate_inforef'));
206
207 // At the end, mark it as built
208 $this->built = true;
209 }
210
211 /**
212 * Exceptionally override the execute method, so, based in the activity_included setting, we are able
213 * to skip the execution of one task completely
214 */
215 public function execute() {
216
217 // Find activity_included_setting
218 if (!$this->get_setting_value('included')) {
219 $this->log('activity skipped by _included setting', backup::LOG_DEBUG, $this->name);
bd39b6f2 220 $this->plan->set_excluding_activities();
77547b46
EL
221 } else { // Setting tells us it's ok to execute
222 parent::execute();
223 }
224 }
225
226
227 /**
cfab878c
DM
228 * Tries to look for the instance specific setting value, task specific setting value or the
229 * common plan setting value - in that order
230 *
231 * @param string $name the name of the setting
232 * @return mixed|null the value of the setting or null if not found
77547b46
EL
233 */
234 public function get_setting($name) {
235 $namewithprefix = $this->modulename . '_' . $this->moduleid . '_' . $name;
236 $result = null;
237 foreach ($this->settings as $key => $setting) {
238 if ($setting->get_name() == $namewithprefix) {
239 if ($result != null) {
240 throw new base_task_exception('multiple_settings_by_name_found', $namewithprefix);
241 } else {
242 $result = $setting;
243 }
244 }
245 }
246 if ($result) {
247 return $result;
248 } else {
249 // Fallback to parent
250 return parent::get_setting($name);
251 }
252 }
253
254// Protected API starts here
255
256 /**
cfab878c 257 * Defines the common setting that any backup activity will have
77547b46
EL
258 */
259 protected function define_settings() {
f68fc388
DP
260 global $CFG;
261 require_once($CFG->libdir.'/questionlib.php');
77547b46
EL
262
263 // All the settings related to this activity will include this prefix
264 $settingprefix = $this->modulename . '_' . $this->moduleid . '_';
265
266 // All these are common settings to be shared by all activities
267
268 // Define activity_include (to decide if the whole task must be really executed)
b65e0220
EL
269 // Dependent of:
270 // - activities root setting
271 // - section_included setting (if exists)
77547b46 272 $settingname = $settingprefix . 'included';
1c9e93c7 273 $activity_included = new backup_activity_generic_setting($settingname, base_setting::IS_BOOLEAN, true);
3e6adcd6 274 $activity_included->get_ui()->set_icon(new image_icon('icon', get_string('pluginname', $this->modulename),
a9f5f809 275 $this->modulename, array('class' => 'iconlarge icon-post ml-1')));
1c9e93c7
EL
276 $this->add_setting($activity_included);
277 // Look for "activities" root setting
278 $activities = $this->plan->get_setting('activities');
279 $activities->add_dependency($activity_included);
f68fc388
DP
280
281 if (question_module_uses_questions($this->modulename)) {
282 $questionbank = $this->plan->get_setting('questionbank');
283 $questionbank->add_dependency($activity_included);
284 }
285
1c9e93c7
EL
286 // Look for "section_included" section setting (if exists)
287 $settingname = 'section_' . $this->sectionid . '_included';
288 if ($this->plan->setting_exists($settingname)) {
289 $section_included = $this->plan->get_setting($settingname);
290 $section_included->add_dependency($activity_included);
291 }
77547b46 292
b65e0220
EL
293 // Define activity_userinfo. Dependent of:
294 // - users root setting
295 // - section_userinfo setting (if exists)
296 // - activity_included setting
77547b46 297 $settingname = $settingprefix . 'userinfo';
77547b46 298 $activity_userinfo = new backup_activity_userinfo_setting($settingname, base_setting::IS_BOOLEAN, true);
83c000d9
SH
299 //$activity_userinfo->get_ui()->set_label(get_string('includeuserinfo','backup'));
300 $activity_userinfo->get_ui()->set_label('-');
77547b46
EL
301 $this->add_setting($activity_userinfo);
302 // Look for "users" root setting
303 $users = $this->plan->get_setting('users');
304 $users->add_dependency($activity_userinfo);
1c9e93c7
EL
305 // Look for "section_userinfo" section setting (if exists)
306 $settingname = 'section_' . $this->sectionid . '_userinfo';
307 if ($this->plan->setting_exists($settingname)) {
308 $section_userinfo = $this->plan->get_setting($settingname);
309 $section_userinfo->add_dependency($activity_userinfo);
310 }
b65e0220
EL
311 // Look for "activity_included" setting
312 $activity_included->add_dependency($activity_userinfo);
77547b46
EL
313
314 // End of common activity settings, let's add the particular ones
315 $this->define_my_settings();
316 }
317
318 /**
cfab878c
DM
319 * Defines activity specific settings to be added to the common ones
320 *
321 * This method is called from {@link self::define_settings()}. The activity module
322 * author may use it to define additional settings that influence the execution of
323 * the backup.
324 *
325 * Most activities just leave the method empty.
326 *
327 * @see self::define_settings() for the example how to define own settings
77547b46
EL
328 */
329 abstract protected function define_my_settings();
330
331 /**
cfab878c
DM
332 * Defines activity specific steps for this task
333 *
334 * This method is called from {@link self::build()}. Activities are supposed
335 * to call {self::add_step()} in it to include their specific steps in the
336 * backup plan.
77547b46
EL
337 */
338 abstract protected function define_my_steps();
339
340 /**
cfab878c
DM
341 * Encodes URLs to the activity instance's scripts into a site-independent form
342 *
343 * The current instance of the activity may be referenced from other places in
c1d4413e 344 * the course by URLs like http://my.moodle.site/mod/workshop/view.php?id=42
cfab878c
DM
345 * Obvisouly, such URLs are not valid any more once the course is restored elsewhere.
346 * For this reason the backup file does not store the original URLs but encodes them
347 * into a transportable form. During the restore, the reverse process is applied and
348 * the encoded URLs are replaced with the new ones valid for the target site.
349 *
350 * Every plugin must override this method in its subclass.
351 *
352 * @see backup_xml_transformer class that actually runs the transformation
353 * @param string $content some HTML text that eventually contains URLs to the activity instance scripts
354 * @return string the content with the URLs encoded
77547b46 355 */
7c109ea3
PS
356 static public function encode_content_links($content) {
357 throw new coding_exception('encode_content_links() method needs to be overridden in each subclass of backup_activity_task');
358 }
77547b46 359}