bdddd2e0761cb56618ad791cd8209ea52edef43d
[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  * @package moodlecore
20  * @subpackage backup-moodle2
21  * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 /**
26  * abstract activity task that provides all the properties and common tasks to be performed
27  * when one activity is being restored
28  *
29  * TODO: Finish phpdocs
30  */
31 abstract class restore_activity_task extends restore_task {
33     protected $info; // info related to activity gathered from backup file
34     protected $modulename;  // name of the module
35     protected $moduleid;    // new (target) id of the course module
36     protected $oldmoduleid; // old (original) id of the course module
37     protected $contextid;   // new (target) context of the activity
38     protected $oldcontextid;// old (original) context of the activity
39     protected $activityid;  // new (target) id of the activity
40     protected $oldactivityid;// old (original) id of the activity
42     /**
43      * Constructor - instantiates one object of this class
44      */
45     public function __construct($name, $info, $plan = null) {
47         $this->info = $info;
48         $this->modulename = $this->info->modulename;
49         $this->moduleid = 0;
50         $this->oldmoduleid = $this->info->moduleid;
51         $this->contextid = 0;
52         $this->oldcontextid = 0;
53         $this->activityid = 0;
54         $this->oldactivityid = 0;
55         parent::__construct($name, $plan);
56     }
58     /**
59      * Activity tasks have their own directory to read files
60      */
61     public function get_taskbasepath() {
62         return $this->get_basepath() . '/' . $this->info->directory;
63     }
65     public function set_moduleid($moduleid) {
66         $this->moduleid = $moduleid;
67     }
69     public function set_activityid($activityid) {
70         $this->activityid = $activityid;
71     }
73     public function set_old_activityid($activityid) {
74         $this->oldactivityid = $activityid;
75     }
77     public function set_contextid($contextid) {
78         $this->contextid = $contextid;
79     }
81     public function set_old_contextid($contextid) {
82         $this->oldcontextid = $contextid;
83     }
85     public function get_modulename() {
86         return $this->modulename;
87     }
89     public function get_moduleid() {
90         return $this->moduleid;
91     }
93     public function get_activityid() {
94         return $this->activityid;
95     }
97     public function get_old_activityid() {
98         return $this->oldactivityid;
99     }
101     public function get_contextid() {
102         return $this->contextid;
103     }
105     public function get_old_contextid() {
106         return $this->oldcontextid;
107     }
109     /**
110      * Create all the steps that will be part of this task
111      */
112     public function build() {
114         // If we have decided not to restore activities, prevent anything to be built
115         if (!$this->get_setting_value('activities')) {
116             $this->built = true;
117             return;
118         }
120         // Load he course_module estructure, generating it (with instance = 0)
121         // but allowing the creation of the target context needed in following steps
122         $this->add_step(new restore_module_structure_step('module_info', 'module.xml'));
124         // Here we add all the common steps for any activity and, in the point of interest
125         // we call to define_my_steps() is order to get the particular ones inserted in place.
126         $this->define_my_steps();
128         // Roles (optionally role assignments and always role overrides)
129         $this->add_step(new restore_ras_and_caps_structure_step('course_ras_and_caps', 'roles.xml'));
131         // Filters (conditionally)
132         if ($this->get_setting_value('filters')) {
133             $this->add_step(new restore_filters_structure_step('activity_filters', 'filters.xml'));
134         }
136         // Comments (conditionally)
137         if ($this->get_setting_value('comments')) {
138             $this->add_step(new restore_comments_structure_step('activity_comments', 'comments.xml'));
139         }
141         // Grades (module-related, rest of gradebook is restored later if possible: cats, calculations...)
142         $this->add_step(new restore_activity_grades_structure_step('activity_grades', 'grades.xml'));
144         // Userscompletion (conditionally)
145         if ($this->get_setting_value('userscompletion')) {
146             $this->add_step(new restore_userscompletion_structure_step('activity_userscompletion', 'completion.xml'));
147         }
149         // TODO: Logs (conditionally)
150         if ($this->get_setting_value('logs')) {
151             //$this->add_step(new restore_activity_logs_structure_step('activity_logs', 'logs.xml'));
152         }
154         // At the end, mark it as built
155         $this->built = true;
156     }
158     /**
159      * Exceptionally override the execute method, so, based in the activity_included setting, we are able
160      * to skip the execution of one task completely
161      */
162     public function execute() {
164         // Find activity_included_setting
165         if (!$this->get_setting_value('included')) {
166             $this->log('activity skipped by _included setting', backup::LOG_DEBUG, $this->name);
167             $this->plan->set_excluding_activities(); // Inform plan we are excluding actvities
169         } else { // Setting tells us it's ok to execute
170             parent::execute();
171         }
172     }
175     /**
176      * Specialisation that, first of all, looks for the setting within
177      * the task with the the prefix added and later, delegates to parent
178      * without adding anything
179      */
180     public function get_setting($name) {
181         $namewithprefix = $this->info->modulename . '_' . $this->info->moduleid . '_' . $name;
182         $result = null;
183         foreach ($this->settings as $key => $setting) {
184             if ($setting->get_name() == $namewithprefix) {
185                 if ($result != null) {
186                     throw new base_task_exception('multiple_settings_by_name_found', $namewithprefix);
187                 } else {
188                     $result = $setting;
189                 }
190             }
191         }
192         if ($result) {
193             return $result;
194         } else {
195             // Fallback to parent
196             return parent::get_setting($name);
197         }
198     }
200     /**
201      * Given a commment area, return the itemname that contains the itemid mappings
202      *
203      * By default both are the same (commentarea = itemname), so return it. If some
204      * module uses a different approach, this method can be overriden in its taks
205      */
206     public function get_comment_mapping_itemname($commentarea) {
207         return $commentarea;
208     }
210     /**
211      * Define (add) particular steps that each activity can have
212      */
213     abstract protected function define_my_steps();
215     /**
216      * Define the contents in the activity that must be
217      * processed by the link decoder
218      */
219     static public function define_decode_contents() {
220         throw new coding_exception('define_decode_contents() method needs to be overridden in each subclass of restore_activity_task');
221     }
223     /**
224      * Define the decoding rules for links belonging
225      * to the activity to be executed by the link decoder
226      */
227     static public function define_decode_rules() {
228         throw new coding_exception('define_decode_rules() method needs to be overridden in each subclass of restore_activity_task');
229     }
231 // Protected API starts here
233     /**
234      * Define the common setting that any restore activity will have
235      */
236     protected function define_settings() {
238         // All the settings related to this activity will include this prefix
239         $settingprefix = $this->info->modulename . '_' . $this->info->moduleid . '_';
241         // All these are common settings to be shared by all activities
243         // Define activity_include (to decide if the whole task must be really executed)
244         // Dependent of:
245         // - activities root setting
246         // - section_included setting (if exists)
247         $settingname = $settingprefix . 'included';
248         $activity_included = new restore_activity_generic_setting($settingname, base_setting::IS_BOOLEAN, true);
249         $activity_included->get_ui()->set_icon(new pix_icon('icon', get_string('pluginname', $this->modulename), $this->modulename));
250         $this->add_setting($activity_included);
251         // Look for "activities" root setting
252         $activities = $this->plan->get_setting('activities');
253         $activities->add_dependency($activity_included);
254         // Look for "section_included" section setting (if exists)
255         $settingname = 'section_' . $this->info->sectionid . '_included';
256         if ($this->plan->setting_exists($settingname)) {
257             $section_included = $this->plan->get_setting($settingname);
258             $section_included->add_dependency($activity_included);
259         }
261         // Define activity_userinfo. Dependent of:
262         // - users root setting
263         // - section_userinfo setting (if exists)
264         // - activity_included setting
265         $settingname = $settingprefix . 'userinfo';
266         $selectvalues = array(0=>get_string('no')); // Safer options
267         $defaultvalue = false;                      // Safer default
268         if (isset($this->info->settings[$settingname]) && $this->info->settings[$settingname]) { // Only enabled when available
269             $selectvalues = array(1=>get_string('yes'), 0=>get_string('no'));
270             $defaultvalue = true;
271         }
272         $activity_userinfo = new restore_activity_userinfo_setting($settingname, base_setting::IS_BOOLEAN, $defaultvalue);
273         $activity_userinfo->set_ui(new backup_setting_ui_select($activity_userinfo, get_string('includeuserinfo','backup'), $selectvalues));
274         $this->add_setting($activity_userinfo);
275         // Look for "users" root setting
276         $users = $this->plan->get_setting('users');
277         $users->add_dependency($activity_userinfo);
278         // Look for "section_userinfo" section setting (if exists)
279         $settingname = 'section_' . $this->info->sectionid . '_userinfo';
280         if ($this->plan->setting_exists($settingname)) {
281             $section_userinfo = $this->plan->get_setting($settingname);
282             $section_userinfo->add_dependency($activity_userinfo);
283         }
284         // Look for "activity_included" setting
285         $activity_included->add_dependency($activity_userinfo);
287         // End of common activity settings, let's add the particular ones
288         $this->define_my_settings();
289     }
291     /**
292      * Define (add) particular settings that each activity can have
293      */
294     abstract protected function define_my_settings();