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 $heading = get_string('import');
  29
  30 // Set up the page
  31 $PAGE->set_title($heading);
  32 $PAGE->set_heading($heading);
  33 $PAGE->set_url(new moodle_url('/backup/import.php', array('id'=>$courseid)));
  34 $PAGE->set_context($context);
  35 $PAGE->set_pagelayout('incourse');
  36
  37 // Prepare the backup renderer
  38 $renderer = $PAGE->get_renderer('core','backup');
  39
  40 // Check if we already have a import course id
  41 if ($importcourseid === false || $searchcourses) {
  42     // Obviously not... show the selector so one can be chosen
  43     $url = new moodle_url('/backup/import.php', array('id'=>$courseid));
  44     $search = new import_course_search(array('url'=>$url));
  45
  46     // show the course selector
  47     echo $OUTPUT->header();
  48     echo $renderer->import_course_selector($url, $search);
  49     echo $OUTPUT->footer();
  50     die();
  51 }
  52
  53 // Load the course +context to import from
  54 $importcourse = $DB->get_record('course', array('id'=>$importcourseid), '*', MUST_EXIST);
  55 $importcontext = context_course::instance($importcourseid);
  56
  57 // Make sure the user can backup from that course
  58 require_capability('moodle/backup:backuptargetimport', $importcontext);
  59
  60 // Attempt to load the existing backup controller (backupid will be false if there isn't one)
  61 $backupid = optional_param('backup', false, PARAM_ALPHANUM);
  62 if (!($bc = backup_ui::load_controller($backupid))) {
  63     $bc = new backup_controller(backup::TYPE_1COURSE, $importcourse->id, backup::FORMAT_MOODLE,
  64                             backup::INTERACTIVE_YES, backup::MODE_IMPORT, $USER->id);
  65     $bc->get_plan()->get_setting('users')->set_status(backup_setting::LOCKED_BY_CONFIG);
  66     $settings = $bc->get_plan()->get_settings();
  67
  68     // For the initial stage we want to hide all locked settings and if there are
  69     // no visible settings move to the next stage
  70     $visiblesettings = false;
  71     foreach ($settings as $setting) {
  72         if ($setting->get_status() !== backup_setting::NOT_LOCKED) {
  73             $setting->set_visibility(backup_setting::HIDDEN);
  74         } else {
  75             $visiblesettings = true;
  76         }
  77     }
  78     import_ui::skip_current_stage(!$visiblesettings);
  79 }
  80
  81 // Prepare the import UI
  82 $backup = new import_ui($bc, array('importid'=>$importcourse->id, 'target'=>$restoretarget));
  83 // Process the current stage
  84 $backup->process();
  85
  86 // If this is the confirmation stage remove the filename setting
  87 if ($backup->get_stage() == backup_ui::STAGE_CONFIRMATION) {
  88     $backup->get_setting('filename')->set_visibility(backup_setting::HIDDEN);
  89 }
  90
  91 // If it's the final stage process the import
  92 if ($backup->get_stage() == backup_ui::STAGE_FINAL) {
  93     // First execute the backup
  94     $backup->execute();
  95     $backup->destroy();
  96     unset($backup);
  97
  98     // Check whether the backup directory still exists. If missing, something
  99     // went really wrong in backup, throw error. Note that backup::MODE_IMPORT
 100     // backups don't store resulting files ever
 101     $tempdestination = $CFG->tempdir . '/backup/' . $backupid;
 102     if (!file_exists($tempdestination) || !is_dir($tempdestination)) {
 103         print_error('unknownbackupexporterror'); // shouldn't happen ever
 104     }
 105
 106     // Prepare the restore controller. We don't need a UI here as we will just use what
 107     // ever the restore has (the user has just chosen).
 108     $rc = new restore_controller($backupid, $course->id, backup::INTERACTIVE_YES, backup::MODE_IMPORT, $USER->id, $restoretarget);
 109     // Convert the backup if required.... it should NEVER happed
 110     if ($rc->get_status() == backup::STATUS_REQUIRE_CONV) {
 111         $rc->convert();
 112     }
 113     // Mark the UI finished.
 114     $rc->finish_ui();
 115     // Execute prechecks
 116     $warnings = false;
 117     if (!$rc->execute_precheck()) {
 118         $precheckresults = $rc->get_precheck_results();
 119         if (is_array($precheckresults)) {
 120             if (!empty($precheckresults['errors'])) { // If errors are found, terminate the import.
 121                 fulldelete($tempdestination);
 122
 123                 echo $OUTPUT->header();
 124                 echo $renderer->precheck_notices($precheckresults);
 125                 echo $OUTPUT->continue_button(new moodle_url('/course/view.php', array('id'=>$course->id)));
 126                 echo $OUTPUT->footer();
 127                 die();
 128             }
 129             if (!empty($precheckresults['warnings'])) { // If warnings are found, go ahead but display warnings later.
 130                 $warnings = $precheckresults['warnings'];
 131             }
 132         }
 133     }
 134     if ($restoretarget == backup::TARGET_CURRENT_DELETING || $restoretarget == backup::TARGET_EXISTING_DELETING) {
 135         restore_dbops::delete_course_content($course->id);
 136     }
 137     // Execute the restore.
 138     $rc->execute_plan();
 139
 140     // Delete the temp directory now
 141     fulldelete($tempdestination);
 142
 143     // Display a notification and a continue button
 144     echo $OUTPUT->header();
 145     if ($warnings) {
 146         echo $OUTPUT->box_start();
 147         echo $OUTPUT->notification(get_string('warning'), 'notifywarning');
 148         echo html_writer::start_tag('ul', array('class'=>'list'));
 149         foreach ($warnings as $warning) {
 150             echo html_writer::tag('li', $warning);
 151         }
 152         echo html_writer::end_tag('ul');
 153         echo $OUTPUT->box_end();
 154     }
 155     echo $OUTPUT->notification(get_string('importsuccess', 'backup'), 'notifysuccess');
 156     echo $OUTPUT->continue_button(new moodle_url('/course/view.php', array('id'=>$course->id)));
 157     echo $OUTPUT->footer();
 158
 159     die();
 160
 161 } else {
 162     // Otherwise save the controller and progress
 163     $backup->save_controller();
 164 }
 165
 166 // Adjust the page for the stage
 167 $PAGE->set_title($heading.': '.$backup->get_stage_name());
 168 $PAGE->set_heading($heading.': '.$backup->get_stage_name());
 169 $PAGE->navbar->add($backup->get_stage_name());
 170
 171 // Display the current stage
 172 echo $OUTPUT->header();
 173 if ($backup->enforce_changed_dependencies()) {
 174     debugging('Your settings have been altered due to unmet dependencies', DEBUG_DEVELOPER);
 175 }
 176 echo $renderer->progress_bar($backup->get_progress_bar());
 177 echo $backup->display($renderer);
 178 $backup->destroy();
 179 unset($backup);
 180 echo $OUTPUT->footer();