MDL-21432 backup - root task, inforef and users handling completed, various fixes
[moodle.git] / backup / moodle2 / restore_root_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  * Start task that provides all the settings common to all restores and other initial steps
27  *
28  * TODO: Finish phpdocs
29  */
30 class restore_root_task extends restore_task {
32     /**
33      * Create all the steps that will be part of this task
34      */
35     public function build() {
37         // Conditionally create the temp table (can exist from prechecks) and delete old stuff
38         $this->add_step(new restore_create_and_clean_temp_stuff('create_and_clean_temp_stuff'));
40         // If we haven't preloaded information, load all the included inforef records to temp_ids table
41         $this->add_step(new restore_load_included_inforef_records('load_inforef_records'));
43         // If we haven't preloaded information and are restoring user info, load all the needed users to temp_ids table
44         $this->add_step(new restore_load_included_users('load_user_records'));
46         // If we haven't preloaded information and are restoring user info, process all those needed users
47         // creating/mapping them as needed. Any problem here will cause exception as far as prechecks have
48         // performed the same process so, it's not possible to have errors here
49         $this->add_step(new restore_process_included_users('process_user_records'));
51         // At the end, mark it as built
52         $this->built = true;
53     }
55 // Protected API starts here
57     /**
58      * Define the common setting that any restore type will have
59      */
60     protected function define_settings() {
62         // Load all the root settings found in backup file from controller
63         $rootsettings = $this->get_info()->root_settings;
65         // Define users setting (keeping it on hand to define dependencies)
66         $selectvalues = array(0=>get_string('no')); // Safer options
67         $defaultvalue = false;                      // Safer default
68         if (isset($rootsettings['users']) && $rootsettings['users']) { // Only enabled when available
69             $selectvalues = array(1=>get_string('yes'), 0=>get_string('no'));
70             $defaultvalue = true;
71         }
72         $users = new restore_users_setting('users', base_setting::IS_BOOLEAN, $defaultvalue);
73         $users->set_ui(new backup_setting_ui_select($users, $users->get_name(), $selectvalues));
74         $this->add_setting($users);
76         // Define role_assignments (dependent of users)
77         $selectvalues = array(0=>get_string('no')); // Safer options
78         $defaultvalue = false;                      // Safer default
79         if (isset($rootsettings['role_assignments']) && $rootsettings['role_assignments']) { // Only enabled when available
80             $selectvalues = array(1=>get_string('yes'), 0=>get_string('no'));
81             $defaultvalue = true;
82         }
83         $roleassignments = new restore_role_assignments_setting('role_assignments', base_setting::IS_BOOLEAN, $defaultvalue);
84         $roleassignments->set_ui(new backup_setting_ui_select($roleassignments, $roleassignments->get_name(), $selectvalues));
85         $this->add_setting($roleassignments);
86         $users->add_dependency($roleassignments);
88         // Define user_files (dependent of users)
89         $selectvalues = array(0=>get_string('no')); // Safer options
90         $defaultvalue = false;                      // Safer default
91         if (isset($rootsettings['user_files']) && $rootsettings['user_files']) { // Only enabled when available
92             $selectvalues = array(1=>get_string('yes'), 0=>get_string('no'));
93             $defaultvalue = true;
94         }
95         $userfiles = new restore_user_files_setting('user_files', base_setting::IS_BOOLEAN, $defaultvalue);
96         $userfiles->set_ui(new backup_setting_ui_select($userfiles, $userfiles->get_name(), $selectvalues));
97         $this->add_setting($userfiles);
98         $users->add_dependency($userfiles);
100         // Define activitites
101         $selectvalues = array(0=>get_string('no')); // Safer options
102         $defaultvalue = false;                      // Safer default
103         if (isset($rootsettings['activities']) && $rootsettings['activities']) { // Only enabled when available
104             $selectvalues = array(1=>get_string('yes'), 0=>get_string('no'));
105             $defaultvalue = true;
106         }
107         $activities = new restore_activities_setting('activities', base_setting::IS_BOOLEAN, $defaultvalue);
108         $activities->set_ui(new backup_setting_ui_select($activities, $activities->get_name(), $selectvalues));
109         $this->add_setting($activities);
111         // Define blocks
112         $selectvalues = array(0=>get_string('no')); // Safer options
113         $defaultvalue = false;                      // Safer default
114         if (isset($rootsettings['blocks']) && $rootsettings['blocks']) { // Only enabled when available
115             $selectvalues = array(1=>get_string('yes'), 0=>get_string('no'));
116             $defaultvalue = true;
117         }
118         $blocks = new restore_generic_setting('blocks', base_setting::IS_BOOLEAN, $defaultvalue);
119         $blocks->set_ui(new backup_setting_ui_select($blocks, $blocks->get_name(), $selectvalues));
120         $this->add_setting($blocks);
122         // Define filters
123         $selectvalues = array(0=>get_string('no')); // Safer options
124         $defaultvalue = false;                      // Safer default
125         if (isset($rootsettings['filters']) && $rootsettings['filters']) { // Only enabled when available
126             $selectvalues = array(1=>get_string('yes'), 0=>get_string('no'));
127             $defaultvalue = true;
128         }
129         $filters = new restore_generic_setting('filters', base_setting::IS_BOOLEAN, $defaultvalue);
130         $filters->set_ui(new backup_setting_ui_select($filters, $filters->get_name(), $selectvalues));
131         $this->add_setting($filters);
133         // Define comments (dependent of users)
134         $selectvalues = array(0=>get_string('no')); // Safer options
135         $defaultvalue = false;                      // Safer default
136         if (isset($rootsettings['comments']) && $rootsettings['comments']) { // Only enabled when available
137             $selectvalues = array(1=>get_string('yes'), 0=>get_string('no'));
138             $defaultvalue = true;
139         }
140         $comments = new restore_comments_setting('comments', base_setting::IS_BOOLEAN, $defaultvalue);
141         $comments->set_ui(new backup_setting_ui_select($comments, $comments->get_name(), $selectvalues));
142         $this->add_setting($comments);
143         $users->add_dependency($comments);
145         // Define completion (dependent of users)
146         $selectvalues = array(0=>get_string('no')); // Safer options
147         $defaultvalue = false;                      // Safer default
148         if (isset($rootsettings['userscompletion']) && $rootsettings['userscompletion']) { // Only enabled when available
149             $selectvalues = array(1=>get_string('yes'), 0=>get_string('no'));
150             $defaultvalue = true;
151         }
152         $completion = new restore_userscompletion_setting('userscompletion', base_setting::IS_BOOLEAN, $defaultvalue);
153         $completion->set_ui(new backup_setting_ui_select($completion, $completion->get_name(), $selectvalues));
154         $this->add_setting($completion);
155         $users->add_dependency($completion);
157         // Define logs (dependent of users)
158         $selectvalues = array(0=>get_string('no')); // Safer options
159         $defaultvalue = false;                      // Safer default
160         if (isset($rootsettings['logs']) && $rootsettings['logs']) { // Only enabled when available
161             $selectvalues = array(1=>get_string('yes'), 0=>get_string('no'));
162             $defaultvalue = true;
163         }
164         $logs = new restore_logs_setting('logs', base_setting::IS_BOOLEAN, $defaultvalue);
165         $logs->set_ui(new backup_setting_ui_select($logs, $logs->get_name(), $selectvalues));
166         $this->add_setting($logs);
167         $users->add_dependency($logs);
169         // Define grade_histories (dependent of users)
170         $selectvalues = array(0=>get_string('no')); // Safer options
171         $defaultvalue = false;                      // Safer default
172         if (isset($rootsettings['grade_histories']) && $rootsettings['grade_histories']) { // Only enabled when available
173             $selectvalues = array(1=>get_string('yes'), 0=>get_string('no'));
174             $defaultvalue = true;
175         }
176         $gradehistories = new restore_grade_histories_setting('grade_histories', base_setting::IS_BOOLEAN, $defaultvalue);
177         $gradehistories->set_ui(new backup_setting_ui_select($gradehistories, $gradehistories->get_name(), $selectvalues));
178         $this->add_setting($gradehistories);
179         $users->add_dependency($gradehistories);
180     }