This will delete some or all of your data and cannot be undone. If there is a sessions table in the backup file, you and all other currently logged in users will be logged out. Always test your backups on a non-production server!
'), ); $form[] = array( '#type' => 'submit', '#value' => t('Restore Database'), ); if (user_access('access backup files')) { $form[] = array( '#type' => 'markup', '#value' => t('Or you can restore one of the files in the saved backup directory.
', array("!url" => url("admin/content/backup_migrate/files"))), ); } $form['#attributes'] = array('enctype' => 'multipart/form-data'); return $form; } /** * The restore submit. Do the restore. */ function backup_migrate_restore_submit($form_id, $form_values) { if ($file = file_check_upload('backup_migrate_restore_upload')) { _backup_migrate_restore_file($file->filepath, $file->filename, true); watchdog('backup_migrate', t('Database restored from upload %file', array('%file' => $file->filename))); } return 'admin/content/backup_migrate/restore'; } /** * Action to backup the drupal site. Requires actions.module. */ function action_backup_migrate_backup($op, $edit = array()) { switch ($op) { case 'do': _backup_migrate_backup_with_defaults(); watchdog('action', t('Backed up database')); break; case 'metadata': return array( 'description' => t('Backup the database with the default settings'), 'type' => t('Backup and Migrate'), 'batchable' => TRUE, 'configurable' => FALSE, ); // Return an HTML config form for the action. case 'form': return ''; // Validate the HTML form. case 'validate': return TRUE; // Process the HTML form to store configuration. case 'submit': return ''; } } /* * Implementation of hook_action_info(). */ function backup_migrate_action_info() { return array( 'backup_migrate_action_backup' => array( '#label' => t('Backup the database'), '#module' => t('Backup and Migrate'), '#description' => t('Backup the database with the default settings.'), ), ); } /* * Action callback. */ function backup_migrate_action_backup() { _backup_migrate_backup_with_defaults(); } /** * Backup the database with the default settings. */ function _backup_migrate_backup_with_defaults($mode = "manual") { _backup_migrate_dump_tables( variable_get("backup_migrate_file_name", _backup_migrate_default_file_name()), variable_get("backup_migrate_exclude_tables", _backup_migrate_default_exclude_tables()), variable_get("backup_migrate_nodata_tables", _backup_migrate_default_structure_only_tables()), 'sql', 'save', variable_get("backup_migrate_compression", "none"), $mode, variable_get("backup_migrate_append_timestamp", 1) ? variable_get("backup_migrate_timestamp_format", 'Y-m-d\TH-i-s') : FALSE ); } /** * Build the database dump file. Takes a list of tables to exclude and some formatting options. */ function _backup_migrate_dump_tables($filename, $exclude_tables, $nodata_tables, $type = "sql", $destination = "download", $compression = "none", $mode = "manual", $append_timestamp = FALSE) { $file_mime = "text/plain"; $success = FALSE; if ($append_timestamp) { $filename .= "-". date($append_timestamp); } $filename = _backup_migrate_clean_filename($filename); // Dump the database. $temp_file = _backup_migrate_temp_file(); switch ($type) { case "sql": $success = _backup_migrate_get_dump_sql($temp_file, $exclude_tables, $nodata_tables); $filename .= ".sql"; $filemime = 'text/x-sql'; break; } // Compress the results. if ($success) { switch ($compression) { case "gzip": $temp_gz = _backup_migrate_temp_file('gz'); if ($success = _backup_migrate_gzip_encode($temp_file, $temp_gz, 9)) { $temp_file = $temp_gz; $filename .= ".gz"; $filemime = 'application/x-gzip'; } break; case "bzip": $temp_bz = _backup_migrate_temp_file('bz'); if ($success = _backup_migrate_bzip_encode($temp_file, $temp_bz)) { $temp_file = $temp_bz; $filename .= ".bz"; $filemime = 'application/x-bzip'; } break; case "zip": $temp_zip = _backup_migrate_temp_file('zip'); if ($success = _backup_migrate_zip_encode($temp_file, $temp_zip, $filename)) { $temp_file = $temp_zip; $filename .= ".zip"; $filemime = 'application/zip'; } break; } } // Save or download the results. if ($success) { switch ($destination) { case "save": _backup_migrate_save_to_disk($temp_file, $filename, $mode); break; case "download": _backup_migrate_send_file_to_download($filename, $file_mime, $temp_file); break; } } // Delete any temporary files we've created. _backup_migrate_temp_file("", TRUE); } /** * Force a browser download for the file. */ function _backup_migrate_send_file_to_download($filename, $filetype, $file_path) { header('Content-Type: '. $filetype); header('Expires: '. gmdate('D, d M Y H:i:s') .' GMT'); header('Content-Length: '. filesize($file_path)); header('Content-Disposition: attachment; filename="'. $filename .'"'); // Transfer file in 1024 byte chunks to save memory usage. if ($fd = fopen($file_path, 'rb')) { while (!feof($fd)) { print fread($fd, 1024); } fclose($fd); } // Delete any temporary files we've created. _backup_migrate_temp_file("", TRUE); watchdog('backup_migrate', t('Database backup file')); module_invoke_all('exit'); exit(); } /** * Get the sql dump file. Returns a list of sql commands, one command per line. * That makes it easier to import without loading the whole file into memory. * The files are a little harder to read, but human-readability is not a priority */ function _backup_migrate_get_dump_sql($file, $exclude_tables, $nodata_tables) { if ($dst = fopen($file, "w")) { $exclude = variable_get("backup_migrate_exclude_tables", _backup_migrate_default_exclude_tables()); $nodata = variable_get("backup_migrate_nodata_tables", _backup_migrate_default_structure_only_tables()); fwrite($dst, _backup_migrate_get_sql_file_header()); $alltables = _backup_migrate_get_tables(); foreach ($alltables as $table) { if ($table['Name'] && !isset($exclude[$table['Name']])) { fwrite($dst, _backup_migrate_get_table_structure_sql($table)); if (!in_array($table['Name'], $nodata)) { _backup_migrate_dump_table_data_sql_to_handle($dst, $table); } } } fwrite($dst, _backup_migrate_get_sql_file_footer()); fclose($dst); return TRUE; } else { return FALSE; } } /** * Get the sql for the structure of the given table. */ function _backup_migrate_get_table_structure_sql($table) { $out = ""; $result = db_query("SHOW CREATE TABLE `". $table['Name'] ."`"); if ($create = db_fetch_array($result)) { $out .= "DROP TABLE IF EXISTS `". $table['Name'] ."`;\n"; $out .= strtr($create['Create Table'], "\n", " "); if ($table['Auto_increment']) { $out .= " AUTO_INCREMENT=". $table['Auto_increment']; } $out .= ";\n"; } return $out; } /** * Get the sql to insert the data for a given table */ function _backup_migrate_dump_table_data_sql_to_handle($dst, $table) { /* the maximum # of values per INSERT INTO {table}' - to many inserted values = MySQL server goes away. - *Do* put more than one value per insert for performance: http://dev.mysql.com/doc/refman/5.0/en/insert-speed.html - *Do not* put them all in one statement: phpmyadmin can split large .sql files to deal with Apache/PHP timeouts. Set this to around 5-50 is my guess to end disk-bound inserts. */ $MAX_ITEMS = 30; // stop adding to the insert statement after exceeding this many bytes. Size 8000 made lines 5000->900 $CUTOFF_BYTES = 2000; // our current row. Updated to row 1 on first use. $i = -1; // track the number of bytes we've added for this INSERT $bytes = 0; $data = db_query("SELECT * FROM `". $table['Name'] ."`"); while ($row = db_fetch_array($data)) { $items = array(); foreach ($row as $key => $value) { $items[] = is_null($value) ? "null" : "'". db_escape_string($value) ."'"; } // If there is data, let's make an INSERT INTO statement. When RESTORING, we load one statement per line. So only one ;\n at end please. if ($items) { // It's a brand new record! Let's get busy! $i++; // close previous INSERT INTO statement on every $MAX_PER_INSERT-th item if ($i==$MAX_ITEMS || $bytes>$CUTOFF_BYTES) { fwrite($dst, ";\n"); $bytes=0; $i=0; } // EITHER: start a new INSERT INTO statement on every 0th item. NOTE: RESET $size if ($i==0) $bytes=fwrite($dst, "INSERT INTO `". $table['Name'] ."` VALUES "); // OR: if it's the 2nd or more-th item, add a comma. if ($i>0) $bytes+=fwrite($dst, ","); // write the values $bytes+=fwrite($dst, "(". implode(",", $items) .")"); // add what's written to $size } } // while ($row = ...) if ($i != -1) fwrite($dst, ";\n"); // close previous INSERT INTO statement } /** * The header for the top of the sql dump file. These commands set the connection * character encoding to help prevent encoding conversion issues. */ function _backup_migrate_get_sql_file_header() { return " /*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */; /*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */; /*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */; /*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */; /*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */; /*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE=NO_AUTO_VALUE_ON_ZERO */; SET NAMES utf8; "; } /** * The footer of the sql dump file. */ function _backup_migrate_get_sql_file_footer() { return " /*!40101 SET SQL_MODE=@OLD_SQL_MODE */; /*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */; /*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */; /*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */; /*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */; /*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */; "; } /** * Get a list of tables in the db. Works with MySQL, Postgres not tested. */ function _backup_migrate_get_tables() { $out = ""; // get auto_increment values and names of all tables $tables = db_query("show table status"); while ($table = db_fetch_array($tables)) { $out[$table['Name']] = $table; } return $out; } /** * Get the list of table names. */ function _backup_migrate_get_table_names() { $out = ""; // Get auto_increment values and names of all tables. $tables = db_query("show table status"); while ($table = db_fetch_array($tables)) { $out[$table['Name']] = $table['Name']; } return $out; } /** * Restore from a previously backed up files. Accepts any file created by the backup function. */ function _backup_migrate_restore_file($filepath, $filename = "", $delete = FALSE) { if (!$filename) { $filename = $filepath; } $file_is_temp = $delete; $open_func = "fopen"; $read_func = "fgets"; $close_func = "fclose"; // figure out if the file is compressed by the file extention if (drupal_substr($filename, -4, 4) == ".sql") { // No compression. } if (drupal_substr($filename, -3, 3) == ".gz") { if (function_exists("gzopen")) { $open_func = "gzopen"; $read_func = "gzgets"; $close_func = "gzclose"; } else { // GZip compression... not supported. drupal_set_message(t("This version of PHP does not support gzip comressed files. Please try using an uncompressed sql backup."), 'error'); drupal_goto("admin/content/backup_migrate/restore"); } } // BZip compression. if (drupal_substr($filename, -3, 3) == ".bz") { if (function_exists("bzopen")) { $open_func = "fopen"; $read_func = "fgets"; // Decompress the file to a temp file. $tmp = tempnam(file_directory_temp(), 'tmp_'); if (($dst = fopen($tmp, "w")) && ($src = bzopen($filepath, "r"))) { while ($data = bzread($src)) { fwrite($dst, $data); } fclose($dst); bzclose($src); if ($delete) { unlink($filepath); } $filepath = $tmp; $delete = TRUE; } else { drupal_set_message(t("Unable to decompress bzip file. Please try using an uncompressed backup."), 'error'); drupal_goto("admin/content/backup_migrate/restore"); } } else { // BZip compression... not supported. drupal_set_message(t("This version of PHP does not support bzip compressed files. Please try using an uncompressed backup."), 'error'); drupal_goto("admin/content/backup_migrate/restore"); } } // Zip compression. if (drupal_substr($filename, -4, 4) == ".zip") { if (class_exists('ZipArchive')) { if ($filepath != $filename) { rename($filepath, $filepath .".zip"); $filepath .= ".zip"; } $tmp = tempnam(file_directory_temp(), 'tmp_'); $zip = new ZipArchive; if (($dst = fopen($tmp, "w")) && ($src = $zip->open($filepath))) { if ($data = $zip->getFromIndex(0)) { fwrite($dst, $data); } fclose($dst); $zip->close(); if ($delete) { unlink($filepath); } $filepath = $tmp; $delete = TRUE; } else { drupal_set_message(t("Unable to decompress zip file. Please try using an uncompressed backup."), 'error'); drupal_goto("admin/content/backup_migrate/restore"); } } else { // Zip compression... not supported. drupal_set_message(t("This version of PHP does not support zip comressed files. Please try using an uncompressed backup."), 'error'); drupal_goto("admin/content/backup_migrate/restore"); } } // Open the file (with fopen or gzopen depending on file format). if ($handle = @$open_func($filepath, "r")) { $num = 0; // Read one line at a time and run the query. while ($line = $read_func($handle)) { $line = trim($line); if ($line) { // Use the helper instead of the api function to avoid substitution of '{' etc. _db_query($line); $num++; } } // Close the file with fclose/gzclose. $close_func($handle); // Delete the file if it is temporary. if ($delete) { unlink($filepath); } $message = t("Restore complete. %num SQL commands executed.", array("%num" => $num)); $message .= $file_is_temp ? "" : "(". l(t("Restore Again..."), "admin/content/backup_migrate/restorefile/". $filepath) .")"; drupal_set_message($message); } else { drupal_set_message(t("Unable to open file %file to restore database", array("%file" => $filepath)), 'error'); } // Delete any temp files we've created. _backup_migrate_temp_file("", TRUE); } /* Backup File Management */ /** * Return a list of backup filetypes. */ function _backup_migrate_filetypes() { return array( "sql" => array( "extension" => ".sql", "filemime" => "text/x-sql", ), "gzip" => array( "extension" => ".gz", "filemime" => "application/x-gzip", ), "bzip" => array( "extension" => ".bz", "filemime" => "application/x-bzip", ), "zip" => array( "extension" => ".zip", "filemime" => "application/zip", ), ); } /** * Get the basic info for a backup file on the server. */ function _backup_migrate_file_info($path) { $types = _backup_migrate_filetypes(); foreach ($types as $type) { $extlen = drupal_strlen($type['extension']); if (drupal_substr($path, -$extlen, $extlen) === $type['extension']) { $out = $type; $out['filesize'] = filesize($path); $out['filename'] = basename($path); $out['filemtime'] = filemtime($path); $out['filectime'] = filectime($path); $out['filepath'] = $path; return $out; } } return NULL; } /** * Save the backup file to the appropriete folder on the server. */ function _backup_migrate_save_to_disk($temp_file, $filename, $mode = "manual") { if ($dir = _backup_migrate_check_destination_dir($mode)) { $filepath = $dir ."/". $filename; rename($temp_file, $filepath); $message = t('Database backup saved to %file. ', array('%file' => $filepath)); watchdog('backup_migrate', $message); if ($mode == "manual" && user_access('perform backup')) { $message .= user_access("access backup files") ? "(". l(t("Download"), "system/files/". $filepath) .") " : ""; $message .= user_access("delete backup files") ? "(". l(t("Delete..."), "admin/content/backup_migrate/delete/". $filepath) .") " : ""; $message .= user_access("restore from backup") ? "(". l(t("Restore..."), "admin/content/backup_migrate/restorefile/". $filepath) .")" : ""; drupal_set_message($message); } } } /** * Implementation of hook_file_download.() * * Allow users with the appropriate permissions to download backup files. */ function backup_migrate_file_download($path) { if (_backup_migrate_path_is_in_save_dir($path)) { if (user_access('access backup files') && $info = _backup_migrate_file_info($path)) { return array( 'Content-Type: '. $info['filemime'], 'Content-Length: '. $info['filesize'], 'Content-Disposition: attachment; filename="'. $info['filename'] .'"', ); } else { return -1; } } return NULL; } /** * Get a temp file. Store it in the normal save path for slightly better security * in shared environments. */ function _backup_migrate_temp_file($extension = "", $delete_all = FALSE) { static $files = array(); if ($delete_all) { _backup_migrate_temp_files_delete($files); } else { $file = tempnam(file_directory_temp(), 'backup_migrate_'); if (!empty($extension)) { unlink($file); $file .= '.'. $extension; } $files[] = $file; return $file; } } /** * Delete all temporary files. */ function _backup_migrate_temp_files_delete($files) { foreach ($files as $file) { if (file_exists($file)) { @unlink($file); } } } /** * List the previously created backup files. */ function _backup_migrate_list_files($mode = "manual") { $files = array(); if ($dir = _backup_migrate_check_destination_dir($mode)) { if ($handle = opendir($dir)) { while (FALSE !== ($file = readdir($handle))) { $filepath = $dir ."/". $file; if ($info = _backup_migrate_file_info($filepath)) { $files[$file] = array( $file, format_date($info['filemtime']), format_size($info['filesize']), l(t("Download"), "system/files/". $filepath), user_access('restore from backup') ? l(t("Restore"), "admin/content/backup_migrate/restorefile/". $filepath) : '', user_access('delete backup files') ? l(t("Delete"), "admin/content/backup_migrate/delete/". $filepath) : '', ); } } } } krsort($files); return theme("table", array(), $files); } /** * Remove older backups keeping only the number specified by the aministrator. */ function _backup_migrate_remove_expired_backups() { $num_to_keep = variable_get("backup_migrate_schedule_backup_keep", 0); // If num to keep is not 0 (0 is infinity). if ($num_to_keep && $dir = _backup_migrate_check_destination_dir("scheduled")) { // Create a list of backup files indexed by time (with an aditional index to // prevent two files with the same create time from overwriting each other). $res = opendir($dir); $files = array(); $i = 0; if ($res) { // Read all files and sort them by modified time. while ($file = readdir($res)) { $filepath = $dir ."/". $file; if ($info = _backup_migrate_file_info($filepath)) { $files[str_pad($info['filemtime'], 10, "0", STR_PAD_LEFT) ."-". $i++] = $filepath; } } } // If we are beyond our limit, remove as many as we need. $num_files = count($files); if ($num_files > $num_to_keep) { $num_to_delete = $num_files - $num_to_keep; // Sort by date. ksort($files); // Delete from the start of the list (earliest). for ($i = 0; $i < $num_to_delete; $i++) { $filepath = array_shift($files); file_delete($filepath); } } } } /** * Return the path on the server to save the dump files. */ function _backup_migrate_path_is_in_save_dir($path, $mode = "") { $backup_dir = _backup_migrate_get_save_path($mode); return file_exists($backup_dir) && file_check_location($path, $backup_dir); } /** * Return the path on the server to save the dump files. */ function _backup_migrate_get_save_path($mode = "") { $dir = file_directory_path() ."/backup_migrate"; if ($mode) { $dir .= $mode == "manual" ? "/manual" : "/scheduled"; } return $dir; } /** * Prepare the destination directory for the backups. */ function _backup_migrate_check_destination_dir($mode = "") { $directory = _backup_migrate_get_save_path(); $out = $subdir = rtrim($directory ."/". $mode, "/"); // Check for the main directory. if (!file_check_directory($directory, TRUE)) { // unable to create main directory $message = t("Unable to create or write to the save directory '%directory'. Please check the file permissions on your files directory.", array('%directory' => $directory)); drupal_set_message($message, "error"); return FALSE; } // Create subdir if needed. if (($subdir != $directory) && !file_check_directory($subdir, TRUE)) { // Unable to create sub directory. $message = t("Unable to create or write to the save directory '%directory'. Please check the file permissions on your files directory.", array('%directory' => $subdir)); drupal_set_message($message, "error"); return FALSE; } // Check for a htaccess file which adequately protects the backup files. $htaccess_lines = "order allow,deny\ndeny from all\n"; if (!is_file($directory .'/.htaccess') || strpos(file_get_contents($directory .'/.htaccess'), $htaccess_lines) === FALSE) { // Attempt to protect the backup files from public access using htaccess. if (($fp = @fopen($directory .'/.htaccess', 'w')) && @fputs($fp, $htaccess_lines)) { fclose($fp); chmod($directory .'/.htaccess', 0664); } // Unable to create htaccess... warn the user. else { $message = "Security warning: Couldn't modify .htaccess file. Please create a .htaccess file in your %directory directory which contains the following lines:!htaccess or add them to the existing .htaccess file";
$replace = array('%directory' => $directory, '!htaccess' => '