Merge branch 'wip-MDL-35056-stable23' of git://github.com/phalacee/moodle into MOODLE...
[moodle.git] / backup / import.php
1 <?php
3 // Require both the backup and restore libs
4 require_once('../config.php');
5 require_once($CFG->dirroot . '/backup/util/includes/backup_includes.php');
6 require_once($CFG->dirroot . '/backup/moodle2/backup_plan_builder.class.php');
7 require_once($CFG->dirroot . '/backup/util/includes/restore_includes.php');
8 require_once($CFG->dirroot . '/backup/util/ui/import_extensions.php');
10 // The courseid we are importing to
11 $courseid = required_param('id', PARAM_INT);
12 // The id of the course we are importing FROM (will only be set if past first stage
13 $importcourseid = optional_param('importid', false, PARAM_INT);
14 // The target method for the restore (adding or deleting)
15 $restoretarget = optional_param('target', backup::TARGET_CURRENT_ADDING, PARAM_INT);
17 // Load the course and context
18 $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
19 $context = get_context_instance(CONTEXT_COURSE, $courseid);
21 // Must pass login
22 require_login($course);
23 // Must hold restoretargetimport in the current course
24 require_capability('moodle/restore:restoretargetimport', $context);
26 $heading = get_string('import');
28 // Set up the page
29 $PAGE->set_title($heading);
30 $PAGE->set_heading($heading);
31 $PAGE->set_url(new moodle_url('/backup/import.php', array('id'=>$courseid)));
32 $PAGE->set_context($context);
33 $PAGE->set_pagelayout('incourse');
35 // Prepare the backup renderer
36 $renderer = $PAGE->get_renderer('core','backup');
38 // Check if we already have a import course id
39 if ($importcourseid === false) {
40     // Obviously not... show the selector so one can be chosen
41     $url = new moodle_url('/backup/import.php', array('id'=>$courseid));
42     $search = new import_course_search(array('url'=>$url));
44     // show the course selector
45     echo $OUTPUT->header();
46     echo $renderer->import_course_selector($url, $search);
47     echo $OUTPUT->footer();
48     die();
49 }
51 // Load the course +context to import from
52 $importcourse = $DB->get_record('course', array('id'=>$importcourseid), '*', MUST_EXIST);
53 $importcontext = get_context_instance(CONTEXT_COURSE, $importcourseid);
55 // Make sure the user can backup from that course
56 require_capability('moodle/backup:backuptargetimport', $importcontext);
58 // Attempt to load the existing backup controller (backupid will be false if there isn't one)
59 $backupid = optional_param('backup', false, PARAM_ALPHANUM);
60 if (!($bc = backup_ui::load_controller($backupid))) {
61     $bc = new backup_controller(backup::TYPE_1COURSE, $importcourse->id, backup::FORMAT_MOODLE,
62                             backup::INTERACTIVE_YES, backup::MODE_IMPORT, $USER->id);
63     $bc->get_plan()->get_setting('users')->set_status(backup_setting::LOCKED_BY_CONFIG);
64     $settings = $bc->get_plan()->get_settings();
66     // For the initial stage we want to hide all locked settings and if there are
67     // no visible settings move to the next stage
68     $visiblesettings = false;
69     foreach ($settings as $setting) {
70         if ($setting->get_status() !== backup_setting::NOT_LOCKED) {
71             $setting->set_visibility(backup_setting::HIDDEN);
72         } else {
73             $visiblesettings = true;
74         }
75     }
76     import_ui::skip_current_stage(!$visiblesettings);
77 }
79 // Prepare the import UI
80 $backup = new import_ui($bc, array('importid'=>$importcourse->id, 'target'=>$restoretarget));
81 // Process the current stage
82 $backup->process();
84 // If this is the confirmation stage remove the filename setting
85 if ($backup->get_stage() == backup_ui::STAGE_CONFIRMATION) {
86     $backup->get_setting('filename')->set_visibility(backup_setting::HIDDEN);
87 }
89 // If it's the final stage process the import
90 if ($backup->get_stage() == backup_ui::STAGE_FINAL) {
91     // First execute the backup
92     $backup->execute();
93     $backup->destroy();
94     unset($backup);
96     // Check whether the backup directory still exists. If missing, something
97     // went really wrong in backup, throw error. Note that backup::MODE_IMPORT
98     // backups don't store resulting files ever
99     $tempdestination = $CFG->tempdir . '/backup/' . $backupid;
100     if (!file_exists($tempdestination) || !is_dir($tempdestination)) {
101         print_error('unknownbackupexporterror'); // shouldn't happen ever
102     }
104     // Prepare the restore controller. We don't need a UI here as we will just use what
105     // ever the restore has (the user has just chosen).
106     $rc = new restore_controller($backupid, $course->id, backup::INTERACTIVE_YES, backup::MODE_IMPORT, $USER->id, $restoretarget);
107     // Convert the backup if required.... it should NEVER happed
108     if ($rc->get_status() == backup::STATUS_REQUIRE_CONV) {
109         $rc->convert();
110     }
111     // Mark the UI finished.
112     $rc->finish_ui();
113     // Execute prechecks
114     if (!$rc->execute_precheck()) {
115         $precheckresults = $rc->get_precheck_results();
116         if (is_array($precheckresults) && !empty($precheckresults['errors'])) {
117             fulldelete($tempdestination);
119             echo $OUTPUT->header();
120             echo $renderer->precheck_notices($precheckresults);
121             echo $OUTPUT->continue_button(new moodle_url('/course/view.php', array('id'=>$course->id)));
122             echo $OUTPUT->footer();
123             die();
124         }
125     } else {
126         if ($restoretarget == backup::TARGET_CURRENT_DELETING || $restoretarget == backup::TARGET_EXISTING_DELETING) {
127             restore_dbops::delete_course_content($course->id);
128         }
129         // Execute the restore
130         $rc->execute_plan();
131     }
133     // Delete the temp directory now
134     fulldelete($tempdestination);
136     // Display a notification and a continue button
137     echo $OUTPUT->header();
138     echo $OUTPUT->notification(get_string('importsuccess', 'backup'),'notifysuccess');
139     echo $OUTPUT->continue_button(new moodle_url('/course/view.php', array('id'=>$course->id)));
140     echo $OUTPUT->footer();
142     die();
144 } else {
145     // Otherwise save the controller and progress
146     $backup->save_controller();
149 // Adjust the page for the stage
150 $PAGE->set_title($heading.': '.$backup->get_stage_name());
151 $PAGE->set_heading($heading.': '.$backup->get_stage_name());
152 $PAGE->navbar->add($backup->get_stage_name());
154 // Display the current stage
155 echo $OUTPUT->header();
156 if ($backup->enforce_changed_dependencies()) {
157     debugging('Your settings have been altered due to unmet dependencies', DEBUG_DEVELOPER);
159 echo $renderer->progress_bar($backup->get_progress_bar());
160 echo $backup->display($renderer);
161 $backup->destroy();
162 unset($backup);
163 echo $OUTPUT->footer();