backup/import.php

   1 <?php
   2
   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');
   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);
  14 // We just want to check if a search has been run. True if anything is there.
  15 $searchcourses = optional_param('searchcourses', false, PARAM_BOOL);
  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
  20 $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
  21 $context = context_course::instance($courseid);
  22
  23 // Must pass login
  24 require_login($course);
  25 // Must hold restoretargetimport in the current course
  26 require_capability('moodle/restore:restoretargetimport', $context);
  27
  28 // Set up the page
  29 $PAGE->set_title($course->shortname . ': ' . get_string('import'));
  30 $PAGE->set_heading($course->fullname);
  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
  39 if ($importcourseid === false || $searchcourses) {
  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
  52 $importcourse = $DB->get_record('course', array('id'=>$importcourseid), '*', MUST_EXIST);
  53 $importcontext = context_course::instance($importcourseid);
  54
  55 // Make sure the user can backup from that course
  56 require_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);
  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();
  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
  85 if ($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
  90 if ($backup->get_stage() == backup_ui::STAGE_FINAL) {
  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\progress\display();
  99     $progress->start_progress('', 2);
 100     $backup->get_controller()->set_progress($progress);
 101
 102     // Prepare logger for backup.
 103     $logger = new core_backup_html_logger($CFG->debugdeveloper ? backup::LOG_DEBUG : backup::LOG_INFO);
 104     $backup->get_controller()->add_logger($logger);
 105
 106     // First execute the backup
 107     $backup->execute();
 108     $backup->destroy();
 109     unset($backup);
 110
 111     // Note that we've done that progress.
 112     $progress->progress(1);
 113
 114     // Check whether the backup directory still exists. If missing, something
 115     // went really wrong in backup, throw error. Note that backup::MODE_IMPORT
 116     // backups don't store resulting files ever
 117     $tempdestination = $CFG->tempdir . '/backup/' . $backupid;
 118     if (!file_exists($tempdestination) || !is_dir($tempdestination)) {
 119         print_error('unknownbackupexporterror'); // shouldn't happen ever
 120     }
 121
 122     // Prepare the restore controller. We don't need a UI here as we will just use what
 123     // ever the restore has (the user has just chosen).
 124     $rc = new restore_controller($backupid, $course->id, backup::INTERACTIVE_YES, backup::MODE_IMPORT, $USER->id, $restoretarget);
 125
 126     // Start a progress section for the restore, which will consist of 2 steps
 127     // (the precheck and then the actual restore).
 128     $progress->start_progress('Restore process', 2);
 129     $rc->set_progress($progress);
 130
 131     // Set logger for restore.
 132     $rc->add_logger($logger);
 133
 134     // Convert the backup if required.... it should NEVER happed
 135     if ($rc->get_status() == backup::STATUS_REQUIRE_CONV) {
 136         $rc->convert();
 137     }
 138     // Mark the UI finished.
 139     $rc->finish_ui();
 140     // Execute prechecks
 141     $warnings = false;
 142     if (!$rc->execute_precheck()) {
 143         $precheckresults = $rc->get_precheck_results();
 144         if (is_array($precheckresults)) {
 145             if (!empty($precheckresults['errors'])) { // If errors are found, terminate the import.
 146                 fulldelete($tempdestination);
 147
 148                 echo $renderer->precheck_notices($precheckresults);
 149                 echo $OUTPUT->continue_button(new moodle_url('/course/view.php', array('id'=>$course->id)));
 150                 echo $OUTPUT->footer();
 151                 die();
 152             }
 153             if (!empty($precheckresults['warnings'])) { // If warnings are found, go ahead but display warnings later.
 154                 $warnings = $precheckresults['warnings'];
 155             }
 156         }
 157     }
 158     if ($restoretarget == backup::TARGET_CURRENT_DELETING || $restoretarget == backup::TARGET_EXISTING_DELETING) {
 159         restore_dbops::delete_course_content($course->id);
 160     }
 161     // Execute the restore.
 162     $rc->execute_plan();
 163
 164     // Delete the temp directory now
 165     fulldelete($tempdestination);
 166
 167     // End restore section of progress tracking (restore/precheck).
 168     $progress->end_progress();
 169
 170     // All progress complete. Hide progress area.
 171     $progress->end_progress();
 172     echo html_writer::end_div();
 173     echo html_writer::script('document.getElementById("executionprogress").style.display = "none";');
 174
 175     // Display a notification and a continue button
 176     if ($warnings) {
 177         echo $OUTPUT->box_start();
 178         echo $OUTPUT->notification(get_string('warning'), 'notifyproblem');
 179         echo html_writer::start_tag('ul', array('class'=>'list'));
 180         foreach ($warnings as $warning) {
 181             echo html_writer::tag('li', $warning);
 182         }
 183         echo html_writer::end_tag('ul');
 184         echo $OUTPUT->box_end();
 185     }
 186     echo $OUTPUT->notification(get_string('importsuccess', 'backup'), 'notifysuccess');
 187     echo $OUTPUT->continue_button(new moodle_url('/course/view.php', array('id'=>$course->id)));
 188
 189     // Get and display log data if there was any.
 190     $loghtml = $logger->get_html();
 191     if ($loghtml != '') {
 192         echo $renderer->log_display($loghtml);
 193     }
 194
 195     echo $OUTPUT->footer();
 196
 197     die();
 198
 199 } else {
 200     // Otherwise save the controller and progress
 201     $backup->save_controller();
 202 }
 203
 204 // Display the current stage
 205 echo $OUTPUT->header();
 206 if ($backup->enforce_changed_dependencies()) {
 207     debugging('Your settings have been altered due to unmet dependencies', DEBUG_DEVELOPER);
 208 }
 209 echo $renderer->progress_bar($backup->get_progress_bar());
 210 echo $backup->display($renderer);
 211 $backup->destroy();
 212 unset($backup);
 213 echo $OUTPUT->footer();