MDL-41840 Restore: Page title, breadcrumbs show incorrect stage
[moodle.git] / backup / import.php
CommitLineData
ad93ddd5
SH
1<?php
2
3// Require both the backup and restore libs
4require_once('../config.php');
5require_once($CFG->dirroot . '/backup/util/includes/backup_includes.php');
6require_once($CFG->dirroot . '/backup/moodle2/backup_plan_builder.class.php');
7require_once($CFG->dirroot . '/backup/util/includes/restore_includes.php');
8require_once($CFG->dirroot . '/backup/util/ui/import_extensions.php');
9
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);
db6539c6 14// We just want to check if a search has been run. True if anything is there.
17270572 15$searchcourses = optional_param('searchcourses', false, PARAM_BOOL);
ad93ddd5
SH
16// The target method for the restore (adding or deleting)
17$restoretarget = optional_param('target', backup::TARGET_CURRENT_ADDING, PARAM_INT);
18
19// Load the course and context
74df2951 20$course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
a689cd1d 21$context = context_course::instance($courseid);
ad93ddd5
SH
22
23// Must pass login
24require_login($course);
25// Must hold restoretargetimport in the current course
26require_capability('moodle/restore:restoretargetimport', $context);
27
ad93ddd5 28// Set up the page
8d137307 29$PAGE->set_title($course->shortname . ': ' . get_string('import'));
30$PAGE->set_heading($course->fullname);
ad93ddd5
SH
31$PAGE->set_url(new moodle_url('/backup/import.php', array('id'=>$courseid)));
32$PAGE->set_context($context);
33$PAGE->set_pagelayout('incourse');
34
35// Prepare the backup renderer
36$renderer = $PAGE->get_renderer('core','backup');
37
38// Check if we already have a import course id
17270572 39if ($importcourseid === false || $searchcourses) {
ad93ddd5
SH
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));
43
44 // show the course selector
45 echo $OUTPUT->header();
46 echo $renderer->import_course_selector($url, $search);
47 echo $OUTPUT->footer();
48 die();
49}
50
51// Load the course +context to import from
74df2951 52$importcourse = $DB->get_record('course', array('id'=>$importcourseid), '*', MUST_EXIST);
a689cd1d 53$importcontext = context_course::instance($importcourseid);
ad93ddd5
SH
54
55// Make sure the user can backup from that course
56require_capability('moodle/backup:backuptargetimport', $importcontext);
57
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);
60if (!($bc = backup_ui::load_controller($backupid))) {
61 $bc = new backup_controller(backup::TYPE_1COURSE, $importcourse->id, backup::FORMAT_MOODLE,
dc1e4cce 62 backup::INTERACTIVE_YES, backup::MODE_IMPORT, $USER->id);
ad93ddd5
SH
63 $bc->get_plan()->get_setting('users')->set_status(backup_setting::LOCKED_BY_CONFIG);
64 $settings = $bc->get_plan()->get_settings();
65
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}
78
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();
83
84// If this is the confirmation stage remove the filename setting
85if ($backup->get_stage() == backup_ui::STAGE_CONFIRMATION) {
86 $backup->get_setting('filename')->set_visibility(backup_setting::HIDDEN);
87}
88
89// If it's the final stage process the import
90if ($backup->get_stage() == backup_ui::STAGE_FINAL) {
f06abc2a 91 echo $OUTPUT->header();
92
93 // Display an extra progress bar so that we can show the current stage.
94 echo html_writer::start_div('', array('id' => 'executionprogress'));
95 echo $renderer->progress_bar($backup->get_progress_bar());
96
97 // Start the progress display - we split into 2 chunks for backup and restore.
98 $progress = new core_backup_display_progress();
99 $progress->start_progress('', 2);
100 $backup->get_controller()->set_progress($progress);
101
ad93ddd5
SH
102 // First execute the backup
103 $backup->execute();
44bb101d
SH
104 $backup->destroy();
105 unset($backup);
dc1e4cce 106
f06abc2a 107 // Note that we've done that progress.
108 $progress->progress(1);
109
dc1e4cce
EL
110 // Check whether the backup directory still exists. If missing, something
111 // went really wrong in backup, throw error. Note that backup::MODE_IMPORT
112 // backups don't store resulting files ever
7aa06e6d 113 $tempdestination = $CFG->tempdir . '/backup/' . $backupid;
ad93ddd5 114 if (!file_exists($tempdestination) || !is_dir($tempdestination)) {
dc1e4cce 115 print_error('unknownbackupexporterror'); // shouldn't happen ever
24736932 116 }
ad93ddd5
SH
117
118 // Prepare the restore controller. We don't need a UI here as we will just use what
119 // ever the restore has (the user has just chosen).
dc1e4cce 120 $rc = new restore_controller($backupid, $course->id, backup::INTERACTIVE_YES, backup::MODE_IMPORT, $USER->id, $restoretarget);
f06abc2a 121 $rc->set_progress($progress);
ad93ddd5
SH
122 // Convert the backup if required.... it should NEVER happed
123 if ($rc->get_status() == backup::STATUS_REQUIRE_CONV) {
124 $rc->convert();
125 }
126 // Mark the UI finished.
127 $rc->finish_ui();
128 // Execute prechecks
55e41006 129 $warnings = false;
ad93ddd5
SH
130 if (!$rc->execute_precheck()) {
131 $precheckresults = $rc->get_precheck_results();
55e41006
HB
132 if (is_array($precheckresults)) {
133 if (!empty($precheckresults['errors'])) { // If errors are found, terminate the import.
134 fulldelete($tempdestination);
135
136 echo $OUTPUT->header();
137 echo $renderer->precheck_notices($precheckresults);
138 echo $OUTPUT->continue_button(new moodle_url('/course/view.php', array('id'=>$course->id)));
139 echo $OUTPUT->footer();
140 die();
141 }
142 if (!empty($precheckresults['warnings'])) { // If warnings are found, go ahead but display warnings later.
143 $warnings = $precheckresults['warnings'];
144 }
ad93ddd5 145 }
ad93ddd5 146 }
55e41006
HB
147 if ($restoretarget == backup::TARGET_CURRENT_DELETING || $restoretarget == backup::TARGET_EXISTING_DELETING) {
148 restore_dbops::delete_course_content($course->id);
149 }
150 // Execute the restore.
151 $rc->execute_plan();
ad93ddd5
SH
152
153 // Delete the temp directory now
154 fulldelete($tempdestination);
155
f06abc2a 156 // All progress complete. Hide progress area.
157 $progress->end_progress();
158 echo html_writer::end_div();
159 echo html_writer::script('document.getElementById("executionprogress").style.display = "none";');
160
ad93ddd5 161 // Display a notification and a continue button
55e41006
HB
162 if ($warnings) {
163 echo $OUTPUT->box_start();
164 echo $OUTPUT->notification(get_string('warning'), 'notifywarning');
165 echo html_writer::start_tag('ul', array('class'=>'list'));
166 foreach ($warnings as $warning) {
167 echo html_writer::tag('li', $warning);
168 }
169 echo html_writer::end_tag('ul');
170 echo $OUTPUT->box_end();
171 }
172 echo $OUTPUT->notification(get_string('importsuccess', 'backup'), 'notifysuccess');
ad93ddd5
SH
173 echo $OUTPUT->continue_button(new moodle_url('/course/view.php', array('id'=>$course->id)));
174 echo $OUTPUT->footer();
175
176 die();
177
178} else {
179 // Otherwise save the controller and progress
180 $backup->save_controller();
181}
182
ad93ddd5
SH
183// Display the current stage
184echo $OUTPUT->header();
185if ($backup->enforce_changed_dependencies()) {
c8d1e4aa 186 debugging('Your settings have been altered due to unmet dependencies', DEBUG_DEVELOPER);
ad93ddd5
SH
187}
188echo $renderer->progress_bar($backup->get_progress_bar());
748e9651 189echo $backup->display($renderer);
44bb101d
SH
190$backup->destroy();
191unset($backup);
17270572 192echo $OUTPUT->footer();