MDL-69995 backup: padding before activity icons.
[moodle.git] / backup / moodle2 / restore_activity_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 restore_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
26  */
28 defined('MOODLE_INTERNAL') || die();
30 /**
31  * abstract activity task that provides all the properties and common tasks to be performed
32  * when one activity is being restored
33  *
34  * TODO: Finish phpdocs
35  */
36 abstract class restore_activity_task extends restore_task {
38     protected $info; // info related to activity gathered from backup file
39     protected $modulename;  // name of the module
40     protected $moduleid;    // new (target) id of the course module
41     protected $oldmoduleid; // old (original) id of the course module
42     protected $oldmoduleversion; // old (original) version of the module
43     protected $contextid;   // new (target) context of the activity
44     protected $oldcontextid;// old (original) context of the activity
45     protected $activityid;  // new (target) id of the activity
46     protected $oldactivityid;// old (original) id of the activity
48     /**
49      * Constructor - instantiates one object of this class
50      */
51     public function __construct($name, $info, $plan = null) {
52         $this->info = $info;
53         $this->modulename = $this->info->modulename;
54         $this->moduleid = 0;
55         $this->oldmoduleid = $this->info->moduleid;
56         $this->oldmoduleversion = 0;
57         $this->contextid = 0;
58         $this->oldcontextid = 0;
59         $this->activityid = 0;
60         $this->oldactivityid = 0;
61         parent::__construct($name, $plan);
62     }
64     /**
65      * Activity tasks have their own directory to read files
66      */
67     public function get_taskbasepath() {
68         return $this->get_basepath() . '/' . $this->info->directory;
69     }
71     public function set_moduleid($moduleid) {
72         $this->moduleid = $moduleid;
73     }
75     public function set_old_moduleversion($oldmoduleversion) {
76         $this->oldmoduleversion = $oldmoduleversion;
77     }
79     public function set_activityid($activityid) {
80         $this->activityid = $activityid;
81     }
83     public function set_old_activityid($activityid) {
84         $this->oldactivityid = $activityid;
85     }
87     public function set_contextid($contextid) {
88         $this->contextid = $contextid;
89     }
91     public function set_old_contextid($contextid) {
92         $this->oldcontextid = $contextid;
93     }
95     public function get_modulename() {
96         return $this->modulename;
97     }
99     public function get_moduleid() {
100         return $this->moduleid;
101     }
103     public function get_old_moduleversion() {
104         return $this->oldmoduleversion;
105     }
107     public function get_activityid() {
108         return $this->activityid;
109     }
111     public function get_old_activityid() {
112         return $this->oldactivityid;
113     }
115     public function get_contextid() {
116         return $this->contextid;
117     }
119     public function get_old_contextid() {
120         return $this->oldcontextid;
121     }
123     /**
124      * Create all the steps that will be part of this task
125      */
126     public function build() {
128         // If we have decided not to restore activities, prevent anything to be built
129         if (!$this->get_setting_value('activities')) {
130             $this->built = true;
131             return;
132         }
134         // Load he course_module estructure, generating it (with instance = 0)
135         // but allowing the creation of the target context needed in following steps
136         $this->add_step(new restore_module_structure_step('module_info', 'module.xml'));
138         // Here we add all the common steps for any activity and, in the point of interest
139         // we call to define_my_steps() is order to get the particular ones inserted in place.
140         $this->define_my_steps();
142         // Roles (optionally role assignments and always role overrides)
143         $this->add_step(new restore_ras_and_caps_structure_step('course_ras_and_caps', 'roles.xml'));
145         // Filters (conditionally)
146         if ($this->get_setting_value('filters')) {
147             $this->add_step(new restore_filters_structure_step('activity_filters', 'filters.xml'));
148         }
150         // Comments (conditionally)
151         if ($this->get_setting_value('comments')) {
152             $this->add_step(new restore_comments_structure_step('activity_comments', 'comments.xml'));
153         }
155         // Calendar events (conditionally)
156         if ($this->get_setting_value('calendarevents')) {
157             $this->add_step(new restore_calendarevents_structure_step('activity_calendar', 'calendar.xml'));
158         }
160         // Grades (module-related, rest of gradebook is restored later if possible: cats, calculations...)
161         $this->add_step(new restore_activity_grades_structure_step('activity_grades', 'grades.xml'));
163         // Advanced grading methods attached to the module
164         $this->add_step(new restore_activity_grading_structure_step('activity_grading', 'grading.xml'));
166         // Grade history. The setting 'grade_history' is handled in the step.
167         $this->add_step(new restore_activity_grade_history_structure_step('activity_grade_history', 'grade_history.xml'));
169         // Userscompletion (conditionally)
170         if ($this->get_setting_value('userscompletion')) {
171             $this->add_step(new restore_userscompletion_structure_step('activity_userscompletion', 'completion.xml'));
172         }
174         // Logs (conditionally)
175         if ($this->get_setting_value('logs')) {
176             // Legacy logs.
177             $this->add_step(new restore_activity_logs_structure_step('activity_logs', 'logs.xml'));
178             // New log stores.
179             $this->add_step(new restore_activity_logstores_structure_step('activity_logstores', 'logstores.xml'));
180         }
182         // Activity competencies.
183         $this->add_step(new restore_activity_competencies_structure_step('activity_competencies', 'competencies.xml'));
185         // Search reindexing, if enabled and if not restoring entire course.
186         if (\core_search\manager::is_indexing_enabled()) {
187             $wholecourse = $this->get_target() == backup::TARGET_NEW_COURSE;
188             $wholecourse = $wholecourse || ($this->setting_exists('overwrite_conf') && $this->get_setting_value('overwrite_conf'));
189             if (!$wholecourse) {
190                 $this->add_step(new restore_activity_search_index('activity_search_index'));
191             }
192         }
194         // At the end, mark it as built
195         $this->built = true;
196     }
198     /**
199      * Exceptionally override the execute method, so, based in the activity_included setting, we are able
200      * to skip the execution of one task completely
201      */
202     public function execute() {
204         // Find activity_included_setting
205         if (!$this->get_setting_value('included')) {
206             $this->log('activity skipped by _included setting', backup::LOG_DEBUG, $this->name);
207             $this->plan->set_excluding_activities(); // Inform plan we are excluding actvities
209         } else { // Setting tells us it's ok to execute
210             parent::execute();
211         }
212     }
215     /**
216      * Specialisation that, first of all, looks for the setting within
217      * the task with the the prefix added and later, delegates to parent
218      * without adding anything
219      */
220     public function get_setting($name) {
221         $namewithprefix = $this->info->modulename . '_' . $this->info->moduleid . '_' . $name;
222         $result = null;
223         foreach ($this->settings as $key => $setting) {
224             if ($setting->get_name() == $namewithprefix) {
225                 if ($result != null) {
226                     throw new base_task_exception('multiple_settings_by_name_found', $namewithprefix);
227                 } else {
228                     $result = $setting;
229                 }
230             }
231         }
232         if ($result) {
233             return $result;
234         } else {
235             // Fallback to parent
236             return parent::get_setting($name);
237         }
238     }
240     /**
241      * Given a commment area, return the itemname that contains the itemid mappings
242      *
243      * By default both are the same (commentarea = itemname), so return it. If some
244      * module uses a different approach, this method can be overriden in its taks
245      */
246     public function get_comment_mapping_itemname($commentarea) {
247         return $commentarea;
248     }
250     /**
251      * Define (add) particular steps that each activity can have
252      */
253     abstract protected function define_my_steps();
255     /**
256      * Define the contents in the activity that must be
257      * processed by the link decoder
258      */
259     static public function define_decode_contents() {
260         throw new coding_exception('define_decode_contents() method needs to be overridden in each subclass of restore_activity_task');
261     }
263     /**
264      * Define the decoding rules for links belonging
265      * to the activity to be executed by the link decoder
266      */
267     static public function define_decode_rules() {
268         throw new coding_exception('define_decode_rules() method needs to be overridden in each subclass of restore_activity_task');
269     }
271     /**
272      * Define the restore log rules that will be applied
273      * by the {@link restore_logs_processor} when restoring
274      * activity logs. It must return one array
275      * of {@link restore_log_rule} objects
276      */
277     static public function define_restore_log_rules() {
278         throw new coding_exception('define_restore_log_rules() method needs to be overridden in each subclass of restore_activity_task');
279     }
281 // Protected API starts here
283     /**
284      * Define the common setting that any restore activity will have
285      */
286     protected function define_settings() {
288         // All the settings related to this activity will include this prefix
289         $settingprefix = $this->info->modulename . '_' . $this->info->moduleid . '_';
291         // All these are common settings to be shared by all activities
293         // Define activity_include (to decide if the whole task must be really executed)
294         // Dependent of:
295         // - activities root setting
296         // - section_included setting (if exists)
297         $settingname = $settingprefix . 'included';
298         $activity_included = new restore_activity_generic_setting($settingname, base_setting::IS_BOOLEAN, true);
299         $activity_included->get_ui()->set_icon(new image_icon('icon', get_string('pluginname', $this->modulename),
300             $this->modulename, array('class' => 'iconlarge icon-post ml-1')));
301         $this->add_setting($activity_included);
302         // Look for "activities" root setting
303         $activities = $this->plan->get_setting('activities');
304         $activities->add_dependency($activity_included);
305         // Look for "section_included" section setting (if exists)
306         $settingname = 'section_' . $this->info->sectionid . '_included';
307         if ($this->plan->setting_exists($settingname)) {
308             $section_included = $this->plan->get_setting($settingname);
309             $section_included->add_dependency($activity_included);
310         }
312         // Define activity_userinfo. Dependent of:
313         // - users root setting
314         // - section_userinfo setting (if exists)
315         // - activity_included setting.
316         $settingname = $settingprefix . 'userinfo';
317         $defaultvalue = false;
318         if (isset($this->info->settings[$settingname]) && $this->info->settings[$settingname]) { // Only enabled when available
319             $defaultvalue = true;
320         }
322         $activity_userinfo = new restore_activity_userinfo_setting($settingname, base_setting::IS_BOOLEAN, $defaultvalue);
323         if (!$defaultvalue) {
324             // This is a bit hacky, but if there is no user data to restore, then
325             // we replace the standard check-box with a select menu with the
326             // single choice 'No', and the select menu is clever enough that if
327             // there is only one choice, it just displays a static string.
328             //
329             // It would probably be better design to have a special UI class
330             // setting_ui_checkbox_or_no, rather than this hack, but I am not
331             // going to do that today.
332             $activity_userinfo->set_ui(new backup_setting_ui_select($activity_userinfo, '-',
333                     array(0 => get_string('no'))));
334         } else {
335             $activity_userinfo->get_ui()->set_label('-');
336         }
338         $this->add_setting($activity_userinfo);
340         // Look for "users" root setting
341         $users = $this->plan->get_setting('users');
342         $users->add_dependency($activity_userinfo);
344         // Look for "section_userinfo" section setting (if exists)
345         $settingname = 'section_' . $this->info->sectionid . '_userinfo';
346         if ($this->plan->setting_exists($settingname)) {
347             $section_userinfo = $this->plan->get_setting($settingname);
348             $section_userinfo->add_dependency($activity_userinfo);
349         }
351         // Look for "activity_included" setting.
352         $activity_included->add_dependency($activity_userinfo);
354         // End of common activity settings, let's add the particular ones.
355         $this->define_my_settings();
356     }
358     /**
359      * Define (add) particular settings that each activity can have
360      */
361     abstract protected function define_my_settings();