MDL-23362 backup - on restore detect missing modules / skipped activities, for gradebook.
[moodle.git] / backup / moodle2 / restore_plan_builder.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 defined('MOODLE_INTERNAL') || die();
27 require_once($CFG->dirroot . '/backup/moodle2/restore_root_task.class.php');
28 require_once($CFG->dirroot . '/backup/moodle2/restore_course_task.class.php');
29 require_once($CFG->dirroot . '/backup/moodle2/restore_section_task.class.php');
30 require_once($CFG->dirroot . '/backup/moodle2/restore_activity_task.class.php');
31 require_once($CFG->dirroot . '/backup/moodle2/restore_final_task.class.php');
32 require_once($CFG->dirroot . '/backup/moodle2/restore_block_task.class.php');
33 require_once($CFG->dirroot . '/backup/moodle2/restore_default_block_task.class.php');
34 require_once($CFG->dirroot . '/backup/moodle2/restore_subplugin.class.php');
35 require_once($CFG->dirroot . '/backup/moodle2/restore_settingslib.php');
36 require_once($CFG->dirroot . '/backup/moodle2/restore_stepslib.php');
38 // Load all the activity tasks for moodle2 format
39 $mods = get_plugin_list('mod');
40 foreach ($mods as $mod => $moddir) {
41     $taskpath = $moddir . '/backup/moodle2/restore_' . $mod . '_activity_task.class.php';
42     if (plugin_supports('mod', $mod, FEATURE_BACKUP_MOODLE2)) {
43         if (file_exists($taskpath)) {
44             require_once($taskpath);
45         }
46     }
47 }
49 // Load all the block tasks for moodle2 format
50 $blocks = get_plugin_list('block');
51 foreach ($blocks as $block => $blockdir) {
52     $taskpath = $blockdir . '/backup/moodle2/restore_' . $block . '_block_task.class.php';
53     if (file_exists($taskpath)) {
54         require_once($taskpath);
55     }
56 }
58 /**
59  * Abstract class defining the static method in charge of building the whole
60  * restore plan, based in @restore_controller preferences.
61  *
62  * TODO: Finish phpdocs
63  */
64 abstract class restore_plan_builder {
66     /**
67      * Dispatches, based on type to specialised builders
68      */
69     static public function build_plan($controller) {
71         $plan = $controller->get_plan();
73         // Add the root task, responsible for
74         // preparing everything, creating the
75         // needed structures (users, roles),
76         // preloading information to temp table
77         // and other init tasks
78         $plan->add_task(new restore_root_task('root_task'));
80         switch ($controller->get_type()) {
81             case backup::TYPE_1ACTIVITY:
82                 self::build_activity_plan($controller, key($controller->get_info()->activities));
83                 break;
84             case backup::TYPE_1SECTION:
85                 self::build_section_plan($controller, key($controller->get_info()->sections));
86                 break;
87             case backup::TYPE_1COURSE:
88                 self::build_course_plan($controller, $controller->get_courseid());
89                 break;
90         }
92         // Add the final task, responsible for closing
93         // all the pending bits (remapings, inter-links
94         // conversion...)
95         // and perform other various final actions.
96         $plan->add_task(new restore_final_task('final_task'));
97     }
100 // Protected API starts here
102     /**
103      * Restore one 1-activity backup
104      */
105     static protected function build_activity_plan($controller, $activityid) {
107         $plan = $controller->get_plan();
108         $info = $controller->get_info();
109         $infoactivity = $info->activities[$activityid];
111         // Add the activity task, responsible for restoring
112         // all the module related information. So it conditionally
113         // as far as the module can be missing on restore
114         if ($task = restore_factory::get_restore_activity_task($infoactivity)) { // can be missing
115             $plan->add_task($task);
117             // For the given activity path, add as many block tasks as necessary
118             // TODO: Add blocks, we need to introspect xml here
119             $blocks = backup_general_helper::get_blocks_from_path($task->get_taskbasepath());
120             foreach ($blocks as $basepath => $name) {
121                 if ($task = restore_factory::get_restore_block_task($name, $basepath)) {
122                     $plan->add_task($task);
123                 } else {
124                     // TODO: Debug information about block not supported
125                 }
126             }
127         } else { // Activity is missing in target site, inform plan about that
128             $plan->set_missing_modules();
129         }
131     }
133     /**
134      * Restore one 1-section backup
135      */
136     static protected function build_section_plan($controller, $sectionid) {
138         $plan = $controller->get_plan();
139         $info = $controller->get_info();
140         $infosection = $info->sections[$sectionid];
142         // Add the section task, responsible for restoring
143         // all the section related information
144         $plan->add_task(restore_factory::get_restore_section_task($infosection));
145         // For the given section, add as many activity tasks as necessary
146         foreach ($info->activities as $activityid => $activity) {
147             if ($activity->sectionid != $infosection->sectionid) {
148                 continue;
149             }
150             if (plugin_supports('mod', $activity->modulename, FEATURE_BACKUP_MOODLE2)) { // Check we support the format
151                 self::build_activity_plan($controller, $activityid);
152             } else {
153                 // TODO: Debug information about module not supported
154             }
155         }
156     }
158     /**
159      * Restore one 1-course backup
160      */
161     static protected function build_course_plan($controller, $courseid) {
163         $plan = $controller->get_plan();
164         $info = $controller->get_info();
166         // Add the course task, responsible for restoring
167         // all the course related information
168         $task = restore_factory::get_restore_course_task($info->course, $courseid);
169         $plan->add_task($task);
171         // For the given course path, add as many block tasks as necessary
172         // TODO: Add blocks, we need to introspect xml here
173         $blocks = backup_general_helper::get_blocks_from_path($task->get_taskbasepath());
174         foreach ($blocks as $basepath => $name) {
175             if ($task = restore_factory::get_restore_block_task($name, $basepath)) {
176                 $plan->add_task($task);
177             } else {
178                 // TODO: Debug information about block not supported
179             }
180         }
182         // For the given course, add as many section tasks as necessary
183         foreach ($info->sections as $sectionid => $section) {
184             self::build_section_plan($controller, $sectionid);
185         }
186     }