/** * @param string $errorstr passed by reference, if silent is true, * errorstr will be populated and this function will return false rather than calling print_error() or notify() * @param boolean $noredirect (optional) if this is passed, this function will not print continue, or * redirect to the next step in the restore process, instead will return $backup_unique_code */ function restore_precheck($id, $file, &$errorstr, $noredirect = false) { global $CFG, $SESSION; //Prepend dataroot to variable to have the absolute path $file = $CFG->dataroot . "/" . $file; if (!defined('RESTORE_SILENTLY')) { //Start the main table echo "<table cellpadding=\"5\">"; echo "<tr><td>"; //Start the mail ul echo "<ul>"; } //Check the file exists if (!is_file($file)) { if (!defined('RESTORE_SILENTLY')) { print_error('nofile'); } else { $errorstr = "File not exists ({$file})"; return false; } } //Check the file name ends with .zip if (!substr($file, -4) == ".zip") { if (!defined('RESTORE_SILENTLY')) { print_error('incorrectext'); } else { $errorstr = get_string('incorrectext', 'error'); return false; } } //Now calculate the unique_code for this restore $backup_unique_code = time(); //Now check and create the backup dir (if it doesn't exist) if (!defined('RESTORE_SILENTLY')) { echo "<li>" . get_string("creatingtemporarystructures") . '</li>'; } $status = check_and_create_backup_dir($backup_unique_code); //Empty dir if ($status) { $status = clear_backup_dir($backup_unique_code); } //Now delete old data and directories under dataroot/temp/backup if ($status) { if (!defined('RESTORE_SILENTLY')) { echo "<li>" . get_string("deletingolddata") . '</li>'; } if (!backup_delete_old_data()) { $errorstr = "An error occurred deleting old data"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'restoreprecheck'); if (!defined('RESTORE_SILENTLY')) { notify($errorstr); } } } //Now copy he zip file to dataroot/temp/backup/backup_unique_code if ($status) { if (!defined('RESTORE_SILENTLY')) { echo "<li>" . get_string("copyingzipfile") . '</li>'; } if (!($status = backup_copy_file($file, $CFG->dataroot . "/temp/backup/" . $backup_unique_code . "/" . basename($file)))) { if (!defined('RESTORE_SILENTLY')) { notify("Error copying backup file. Invalid name or bad perms."); } else { $errorstr = "Error copying backup file. Invalid name or bad perms"; return false; } } } //Now unzip the file if ($status) { if (!defined('RESTORE_SILENTLY')) { echo "<li>" . get_string("unzippingbackup") . '</li>'; } if (!($status = restore_unzip($CFG->dataroot . "/temp/backup/" . $backup_unique_code . "/" . basename($file)))) { if (!defined('RESTORE_SILENTLY')) { notify("Error unzipping backup file. Invalid zip file."); } else { $errorstr = "Error unzipping backup file. Invalid zip file."; return false; } } } //Check for Blackboard backups and convert if ($status) { require_once "{$CFG->dirroot}/backup/bb/restore_bb.php"; if (!defined('RESTORE_SILENTLY')) { echo "<li>" . get_string("checkingforbbexport") . '</li>'; } $status = blackboard_convert($CFG->dataroot . "/temp/backup/" . $backup_unique_code); } //Now check for the moodle.xml file if ($status) { $xml_file = $CFG->dataroot . "/temp/backup/" . $backup_unique_code . "/moodle.xml"; if (!defined('RESTORE_SILENTLY')) { echo "<li>" . get_string("checkingbackup") . '</li>'; } if (!($status = restore_check_moodle_file($xml_file))) { if (!is_file($xml_file)) { $errorstr = 'Error checking backup file. moodle.xml not found at root level of zip file.'; } else { $errorstr = 'Error checking backup file. moodle.xml is incorrect or corrupted.'; } if (!defined('RESTORE_SILENTLY')) { notify($errorstr); } else { return false; } } } $info = ""; $course_header = ""; //Now read the info tag (all) if ($status) { if (!defined('RESTORE_SILENTLY')) { echo "<li>" . get_string("readinginfofrombackup") . '</li>'; } //Reading info from file $info = restore_read_xml_info($xml_file); //Reading course_header from file $course_header = restore_read_xml_course_header($xml_file); if (!is_object($course_header)) { // ensure we fail if there is no course header $course_header = false; } } if (!defined('RESTORE_SILENTLY')) { //End the main ul echo "</ul>\n"; //End the main table echo "</td></tr>"; echo "</table>"; } //We compare Moodle's versions if ($CFG->version < $info->backup_moodle_version && $status) { $message = new object(); $message->serverversion = $CFG->version; $message->serverrelease = $CFG->release; $message->backupversion = $info->backup_moodle_version; $message->backuprelease = $info->backup_moodle_release; print_simple_box(get_string('noticenewerbackup', '', $message), "center", "70%", '', "20", "noticebox"); } //Now we print in other table, the backup and the course it contains info if ($info and $course_header and $status) { //First, the course info if (!defined('RESTORE_SILENTLY')) { $status = restore_print_course_header($course_header); } //Now, the backup info if ($status) { if (!defined('RESTORE_SILENTLY')) { $status = restore_print_info($info); } } } //Save course header and info into php session if ($status) { $SESSION->info = $info; $SESSION->course_header = $course_header; } //Finally, a little form to continue //with some hidden fields if ($status) { if (!defined('RESTORE_SILENTLY')) { echo "<br /><div style='text-align:center'>"; $hidden["backup_unique_code"] = $backup_unique_code; $hidden["launch"] = "form"; $hidden["file"] = $file; $hidden["id"] = $id; print_single_button("restore.php", $hidden, get_string("continue"), "post"); echo "</div>"; } else { if (empty($noredirect)) { // in 2.0 we must not print "Continue" redirect link here, because ppl click on it and the execution gets interrupted on next page!!! // imo RESTORE_SILENTLY is an ugly hack :-P $sillystr = get_string('donotclickcontinue'); redirect($CFG->wwwroot . '/backup/restore.php?backup_unique_code=' . $backup_unique_code . '&launch=form&file=' . $file . '&id=' . $id, $sillystr, 0); } else { return $backup_unique_code; } } } if (!$status) { if (!defined('RESTORE_SILENTLY')) { print_error('error'); } else { $errorstr = "An error has occured"; // helpful! :P return false; } } return true; }
function schedule_backup_log($starttime, $courseid, $message) { global $DB; if ($starttime) { add_to_backup_log($starttime, $courseid, $message, 'scheduledbackup'); } }
function backup_execute(&$preferences, &$errorstr) { global $CFG, $DB; $status = true; //Check for temp and backup and backup_unique_code directory //Create them as needed if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("creatingtemporarystructures") . '</li>'; } $status = check_and_create_backup_dir($preferences->backup_unique_code); //Empty dir if ($status) { $status = clear_backup_dir($preferences->backup_unique_code); } //Delete old_entries from backup tables if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("deletingolddata") . '</li>'; } $status = backup_delete_old_data(); if (!$status) { $errorstr = "An error occurred deleting old backup data"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } } //Create the moodle.xml file if ($status) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("creatingxmlfile"); //Begin a new list to xml contents echo "<ul>"; echo "<li>" . get_string("writingheader") . '</li>'; } //Obtain the xml file (create and open) and print prolog information $backup_file = backup_open_xml($preferences->backup_unique_code); if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("writinggeneralinfo") . '</li>'; } //Prints general info about backup to file if ($backup_file) { if (!($status = backup_general_info($backup_file, $preferences))) { $errorstr = "An error occurred while backing up general info"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("writingcoursedata"); //Start new ul (for course) echo "<ul>"; echo "<li>" . get_string("courseinfo") . '</li>'; } //Prints course start (tag and general info) if ($status) { if (!($status = backup_course_start($backup_file, $preferences))) { $errorstr = "An error occurred while backing up course start"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } //Metacourse information if ($status && $preferences->backup_metacourse) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("metacourse") . '</li>'; } if (!($status = backup_course_metacourse($backup_file, $preferences))) { $errorstr = "An error occurred while backing up metacourse info"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("blocks") . '</li>'; } //Blocks information if ($status) { if (!($status = backup_course_blocks($backup_file, $preferences))) { $errorstr = "An error occurred while backing up course blocks"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("sections") . '</li>'; } //Section info if ($status) { if (!($status = backup_course_sections($backup_file, $preferences))) { $errorstr = "An error occurred while backing up course sections"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } //End course contents (close ul) if (!defined('BACKUP_SILENTLY')) { echo "</ul></li>"; } //User info if ($status) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("writinguserinfo") . '</li>'; } if (!($status = backup_user_info($backup_file, $preferences))) { $errorstr = "An error occurred while backing up user info"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } //If we have selected to backup messages and we are //doing a SITE backup, let's do it if ($status && $preferences->backup_messages && $preferences->backup_course == SITEID) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("writingmessagesinfo") . '</li>'; } if (!($status = backup_messages($backup_file, $preferences))) { $errorstr = "An error occurred while backing up messages"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } //If we have selected to backup blogs and we are //doing a SITE backup, let's do it if ($status && $preferences->backup_blogs && $preferences->backup_course == SITEID) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("writingblogsinfo") . '</li>'; } if (!($status = backup_blogs($backup_file, $preferences))) { $errorstr = "An error occurred while backing up blogs"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } //If we have selected to backup quizzes or other modules that use questions //we've already added ids of categories and questions to backup to backup_ids table if ($status) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("writingcategoriesandquestions") . '</li>'; } require_once $CFG->dirroot . '/question/backuplib.php'; if (!($status = backup_question_categories($backup_file, $preferences))) { $errorstr = "An error occurred while backing up quiz categories"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } //Print logs if selected if ($status) { if ($preferences->backup_logs) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("writingloginfo") . '</li>'; } if (!($status = backup_log_info($backup_file, $preferences))) { $errorstr = "An error occurred while backing up log info"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } } //Print scales info if ($status) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("writingscalesinfo") . '</li>'; } if (!($status = backup_scales_info($backup_file, $preferences))) { $errorstr = "An error occurred while backing up scales"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } //Print groups info if ($status) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("writinggroupsinfo") . '</li>'; } if (!($status = backup_groups_info($backup_file, $preferences))) { $errostr = "An error occurred while backing up groups"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errostr); } else { return false; } } } //Print groupings info if ($status) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("writinggroupingsinfo") . '</li>'; } if (!($status = backup_groupings_info($backup_file, $preferences))) { $errorstr = "An error occurred while backing up groupings"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } //Print groupings_groups info if ($status) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("writinggroupingsgroupsinfo") . '</li>'; } if (!($status = backup_groupings_groups_info($backup_file, $preferences))) { $errorstr = "An error occurred while backing up groupings groups"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } //Print events info if ($status) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("writingeventsinfo") . '</li>'; } if (!($status = backup_events_info($backup_file, $preferences))) { $errorstr = "An error occurred while backing up events"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } //Print gradebook info if ($status) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("writinggradebookinfo") . '</li>'; } if (!($status = backup_gradebook_info($backup_file, $preferences))) { $errorstr = "An error occurred while backing up gradebook"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } //Module info, this unique function makes all the work!! //db export and module fileis copy if ($status) { $mods_to_backup = false; //Check if we have any mod to backup foreach ($preferences->mods as $module) { if ($module->backup) { $mods_to_backup = true; } } //If we have to backup some module if ($mods_to_backup) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("writingmoduleinfo"); } //Start modules tag if (!($status = backup_modules_start($backup_file, $preferences))) { $errorstr = "An error occurred while backing up module info"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } //Open ul for module list if (!defined('BACKUP_SILENTLY')) { echo "<ul>"; } //Iterate over modules and call backup foreach ($preferences->mods as $module) { if ($module->backup and $status) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("modulenameplural", $module->name) . '</li>'; } if (!($status = backup_module($backup_file, $preferences, $module->name))) { $errorstr = "An error occurred while backing up '{$module->name}'"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } } //Close ul for module list if (!defined('BACKUP_SILENTLY')) { echo "</ul></li>"; } //Close modules tag if (!($status = backup_modules_end($backup_file, $preferences))) { $errorstr = "An error occurred while finishing the module backups"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } } //Backup course format data, if any. if (!defined('BACKUP_SILENTLY')) { echo '<li>' . get_string("courseformatdata") . '</li>'; } if ($status) { if (!($status = backup_format_data($backup_file, $preferences))) { $errorstr = "An error occurred while backing up the course format data"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } //Prints course end if ($status) { if (!($status = backup_course_end($backup_file, $preferences))) { $errorstr = "An error occurred while closing the course backup"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } //Close the xml file and xml data if ($backup_file) { backup_close_xml($backup_file); } //End xml contents (close ul) if (!defined('BACKUP_SILENTLY')) { echo "</ul></li>"; } } //Now, if selected, copy user files if ($status) { if ($preferences->backup_user_files) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("copyinguserfiles") . '</li>'; } if (!($status = backup_copy_user_files($preferences))) { $errorstr = "An error occurred while copying user files"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } } //Now, if selected, copy course files if ($status) { if ($preferences->backup_course_files) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("copyingcoursefiles") . '</li>'; } if (!($status = backup_copy_course_files($preferences))) { $errorstr = "An error occurred while copying course files"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } } //Now, if selected, copy site files if ($status) { if ($preferences->backup_site_files) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("copyingsitefiles") . '</li>'; } if (!($status = backup_copy_site_files($preferences))) { $errorstr = "An error occurred while copying site files"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } } //Now, zip all the backup directory contents if ($status) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("zippingbackup") . '</li>'; } if (!($status = backup_zip($preferences))) { $errorstr = "An error occurred while zipping the backup"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } //Now, copy the zip file to course directory if ($status) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("copyingzipfile") . '</li>'; } if (!($status = copy_zip_to_course_dir($preferences))) { $errorstr = "An error occurred while copying the zip file to the course directory"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } //Now, clean temporary data (db and filesystem) if ($status) { if (!defined('BACKUP_SILENTLY')) { echo "<li>" . get_string("cleaningtempdata") . '</li>'; } if (!($status = clean_temp_data($preferences))) { $errorstr = "An error occurred while cleaning up temporary data"; add_to_backup_log(time(), $preferences->backup_course, $errorstr, 'manual'); if (!defined('BACKUP_SILENTLY')) { notify($errorstr); } else { return false; } } } return $status; }