". $section['body'] ."
"; if (!empty($section['more'])) { $out .= "". $section['more'] ."
"; } } return $out; } } /** * Implementation of hook_menu(). */ function backup_migrate_menu() { $items = array(); $items[BACKUP_MIGRATE_MENU_PATH] = array( 'title' => 'Backup and Migrate', 'description' => 'Backup/restore your database or migrate data to or from another Drupal site.', 'page callback' => 'backup_migrate_menu_callback', 'page arguments' => array('', 'backup_migrate_ui_manual_backup_quick', TRUE), 'access arguments' => array('access backup and migrate'), 'type' => MENU_NORMAL_ITEM, ); $items[BACKUP_MIGRATE_MENU_PATH . '/export'] = array( 'title' => 'Backup', 'description' => 'Backup the database.', 'page callback' => 'backup_migrate_menu_callback', 'page arguments' => array('', 'backup_migrate_ui_manual_backup_quick', TRUE), 'access arguments' => array('access backup and migrate'), 'weight' => 0, 'type' => MENU_DEFAULT_LOCAL_TASK, ); $items[BACKUP_MIGRATE_MENU_PATH . '/export/quick'] = array( 'title' => 'Quick Backup', 'description' => 'Backup the database.', 'page callback' => 'backup_migrate_menu_callback', 'page arguments' => array('', 'backup_migrate_ui_manual_backup_quick', TRUE), 'access arguments' => array('access backup and migrate'), 'weight' => 0, 'type' => MENU_DEFAULT_LOCAL_TASK, ); $items[BACKUP_MIGRATE_MENU_PATH . '/export/advanced'] = array( 'title' => 'Advanced Backup', 'description' => 'Backup the database.', 'page callback' => 'backup_migrate_menu_callback', 'page arguments' => array('', 'backup_migrate_ui_manual_backup_advanced', TRUE), 'access arguments' => array('perform backup'), 'weight' => 1, 'type' => MENU_LOCAL_TASK, ); $items[BACKUP_MIGRATE_MENU_PATH . '/restore'] = array( 'title' => 'Restore', 'description' => 'Restore the database from a previous backup', 'page callback' => 'backup_migrate_menu_callback', 'page arguments' => array('', 'backup_migrate_ui_manual_restore', TRUE), 'access arguments' => array('restore from backup'), 'weight' => 1, 'type' => MENU_LOCAL_TASK, ); backup_migrate_include('crud'); $items += backup_migrate_crud_menu(); return $items; } /** * Implementation of hook_cron(). * * Takes care of scheduled backups and deletes abandoned temp files. */ function backup_migrate_cron() { // Set the message mode to logging. _backup_migrate_message_callback('_backup_migrate_message_log'); backup_migrate_include('schedules'); backup_migrate_schedules_run(); backup_migrate_include('files'); _backup_migrate_temp_files_delete(); } /** * Implementation of hook_permission(). */ function backup_migrate_permission() { return array( 'access backup and migrate' => array( 'title' => t('Access Backup and Migrate'), 'description' => t('Access the Backup and Migrate admin section.'), ), 'perform backup' => array( 'title' => t('Perform a backup'), 'description' => t('Back up any of the available databases.'), ), 'access backup files' => array( 'title' => t('Access backup files'), 'description' => t('Access and download the previously created backup files.'), ), 'delete backup files' => array( 'title' => t('Delete backup files'), 'description' => t('Delete the previously created backup files.'), ), 'restore from backup' => array( 'title' => t('Restore the site'), 'description' => t('Restore the site\'s database from a backup file.'), ), 'administer backup and migrate' => array( 'title' => t('Administer Backup and Migrate'), 'description' => t('Edit Backup and Migrate profiles, schedules and destinations.'), ), ); } /** * Implementation of hook_simpletest(). */ function backup_migrate_simpletest() { $dir = drupal_get_path('module', 'backup_migrate') .'/tests'; $tests = file_scan_directory($dir, '\.test$'); return array_keys($tests); } /** * Implementation of hook_theme(). */ function backup_migrate_theme() { $themes = array( 'backup_migrate_ui_manual_quick_backup_form' => array( 'arguments' => array('form'), 'render element' => 'form', ), ); return $themes; } /* Menu Callbacks */ /** * A menu callback helper. Handles file includes and interactivity setting. */ function backup_migrate_menu_callback($include, $function, $interactive = TRUE) { if ($include) { backup_migrate_include($include); } // Set the message handler based on interactivity setting. _backup_migrate_message_callback($interactive ? '_backup_migrate_message_browser' : '_backup_migrate_message_log'); // Get the arguments with the first 3 removed. $args = array_slice(func_get_args(), 3); return call_user_func_array($function, $args); } /** * Include views .inc files as necessary. */ function backup_migrate_include() { static $used = array(); foreach (func_get_args() as $file) { if (!isset($used[$file])) { require_once DRUPAL_ROOT . '/' . drupal_get_path('module', 'backup_migrate') . "/includes/$file.inc"; } $used[$file] = TRUE; } } /** * The menu callback for easy manual backups. */ function backup_migrate_ui_manual_backup_quick() { $out = array(); if (user_access('perform backup')) { return drupal_get_form('backup_migrate_ui_manual_quick_backup_form'); } else { return t('You do not have permission to back up this site.'); } return $out; } /** * The menu callback for advanced manual backups. */ function backup_migrate_ui_manual_backup_advanced() { backup_migrate_include('profiles'); $out = array(); $profile_id = arg(BACKUP_MIGRATE_MENU_DEPTH + 2); $profile = _backup_migrate_profile_saved_default_profile($profile_id); $out[] = drupal_get_form('backup_migrate_ui_manual_backup_load_profile_form', $profile); $out[] = drupal_get_form('backup_migrate_ui_manual_backup_form', $profile); return $out; } /** * The backup/export load profile form. */ function backup_migrate_ui_manual_backup_load_profile_form($form, &$form_state, $profile = NULL) { $form = array(); $profile_options = _backup_migrate_get_profile_form_item_options(); if (count($profile_options) > 0) { $profile_options = array(0 => t('-- Select a Settings Profile --')) + $profile_options; $form['profile'] = array( "#title" => t("Settings Profile"), "#collapsible" => TRUE, "#collapsed" => FALSE, "#prefix" => 'Or you can restore one of the files in your saved backup destinations.
', array("!url" => url(BACKUP_MIGRATE_MENU_PATH . "/destination"))), ); } $form['#attributes'] = array('enctype' => 'multipart/form-data'); return $form; } /** * The restore submit. Do the restore. */ function backup_migrate_ui_manual_restore_form_submit($form, &$form_state) { $validators = array('file_validate_extensions' => array('gz zip sql mysql bz bz2')); if ($file = file_save_upload('backup_migrate_restore_upload', $validators)) { backup_migrate_include('destinations'); backup_migrate_perform_restore('upload', $file->uri, $form_state['values']); } $form_state['redirect'] = BACKUP_MIGRATE_MENU_PATH . '/restore'; } /** * Convert an item to an 'exportable'. */ function backup_migrate_ui_export_form($form, &$form_state, $item) { if ($item && function_exists('ctools_var_export')) { $code = ctools_var_export($item); $form = ctools_export_form($form_state, $code); return $form; } return array(); } /** * Perform a backup with the given settings. */ function backup_migrate_perform_backup(&$settings) { backup_migrate_include('destinations', 'files', 'filters'); timer_start('backup_migrate_backup'); // If not in 'safe mode', increase the maximum execution time: if (!ini_get('safe_mode') && strpos(ini_get('disable_functions'), 'set_time_limit') === FALSE && ini_get('max_execution_time') < 1200) { set_time_limit(variable_get('backup_migrate_backup_max_time', 1200)); } $timestamp = ''; if ($settings->append_timestamp && $settings->timestamp_format) { $timestamp = format_date(time(), 'custom', $settings->timestamp_format); } $filename = _backup_migrate_construct_filename($settings->filename, $timestamp); $file = new backup_file(array('filename' => $filename)); if (!$file) { backup_migrate_backup_fail("Could not run backup because a temporary file could not be created.", array(), $settings); return FALSE; } // Register shutdown callback to deal with timeouts. register_shutdown_function('backup_migrate_shutdown', $settings); $file = backup_migrate_filters_backup($file, $settings); if (!$file) { if (_backup_migrate_check_timeout()) { backup_migrate_backup_fail('Could not complete the backup because the script timed out. Try increasing your PHP max_execution_time setting.', array('!url' => 'http://www.php.net/manual/en/info.configuration.php#ini.max-execution-time'), $settings); } else { backup_migrate_backup_fail("Could not complete the backup.", array(), $settings); } return FALSE; } $file = backup_migrate_destination_save_file($file, $settings); if (!$file) { backup_migrate_backup_fail("Could not run backup because the file could not be saved to the destination.", array(), $settings); return FALSE; } // Backup succeeded, $time = timer_stop('backup_migrate_backup'); $message = '%source backed up successfully to %file in destination %dest in !time ms. !action'; $params = array( '%file' => $filename, '%dest' => $settings->get_destination_name(), '%source' => $settings->get_source_name(), '!time' => $time['time'], '!action' => !empty($settings->performed_action) ? $settings->performed_action : '', ); if (($destination = $settings->get_destination()) && ($links = $destination->get_file_links($file->file_id()))) { $params['!links'] = implode(", ", $links); } backup_migrate_backup_succeed($message, $params, $settings); return $file; } /** * Restore from a file in the given destination. */ function backup_migrate_perform_restore($destination_id, $file, $settings = array()) { backup_migrate_include('files', 'filters'); timer_start('backup_migrate_restore'); // If not in 'safe mode', increase the maximum execution time: if (!ini_get('safe_mode') && strpos(ini_get('disable_functions'), 'set_time_limit') === FALSE && ini_get('max_execution_time') < variable_get('backup_migrate_backup_max_time', 1200)) { set_time_limit(variable_get('backup_migrate_restore_max_time', 1200)); } // Make the settings into a default profile. if (!is_object($settings)) { $settings = backup_migrate_crud_create_item('profile', $settings); $settings->source_id = empty($settings->source_id) ? 'db' : $settings->source_id; } // Register shutdown callback. register_shutdown_function('backup_migrate_shutdown', $settings); if (!is_object($file)) { // Load the file from the destination. $file = backup_migrate_destination_get_file($destination_id, $file); if (!$file) { _backup_migrate_message("Could not restore because the file could not be loaded from the destination.", array(), 'error'); backup_migrate_cleanup(); return FALSE; } } $file_id = $file->file_id(); // Filter the file and perform the restore. $file = backup_migrate_filters_restore($file, $settings); if (!$file) { if (_backup_migrate_check_timeout()) { backup_migrate_restore_fail('Could not perform the restore because the script timed out. Try increasing your PHP max_execution_time setting.', array('!url' => 'http://www.php.net/manual/en/info.configuration.php#ini.max-execution-time'), 'error'); } else { backup_migrate_restore_fail("Could not perform the restore.", array(), 'error'); } backup_migrate_cleanup(); return FALSE; } $time = timer_stop('backup_migrate_restore'); if ($file) { $destination = backup_migrate_get_destination($destination_id); $message = '%source restored from %dest file %file in !time ms. !action'; $params = array( '%file' => $file->filename(), '%source' => $settings->get_source_name(), '%dest' => $destination->get_name(), '!time' => $time['time'], '!action' => !empty($settings->performed_action) ? $settings->performed_action : '', ); if ($destination && $destination->op('list files')) { $params['!links'] = t('Restore again', array('!restoreurl' => url(BACKUP_MIGRATE_MENU_PATH . '/destination/restorefile/'. $destination_id ."/". $file_id))); } backup_migrate_restore_succeed($message, $params, $settings); } // Delete any temp files we've created. backup_migrate_cleanup(); // No errors. Return the file. return $file; } /** * Clean up when a backup operation fails. */ function backup_migrate_backup_fail($message, $params, $settings) { backup_migrate_include('files', 'filters'); _backup_migrate_message($message, $params, 'error'); backup_migrate_cleanup(); backup_migrate_filters_invoke_all('backup_fail', $settings, $message, $params); return FALSE; } /** * Clean up when a backup operation suceeds. */ function backup_migrate_backup_succeed($message, $params, $settings) { backup_migrate_include('filters', 'files'); _backup_migrate_message($message, $params, 'success'); backup_migrate_cleanup(); backup_migrate_filters_invoke_all('backup_succeed', $settings, $message, $params); return FALSE; } /** * Clean up when a restore operation fails. */ function backup_migrate_restore_fail($message, $params, $settings) { backup_migrate_include('files', 'filters'); _backup_migrate_message($message, $params, 'error'); backup_migrate_cleanup(); backup_migrate_filters_invoke_all('restore_fail', $settings, $message, $params); return FALSE; } /** * Clean up when a restore operation suceeds. */ function backup_migrate_restore_succeed($message, $params, $settings) { backup_migrate_include('filters', 'files'); _backup_migrate_message($message, $params, 'success'); backup_migrate_cleanup(); backup_migrate_filters_invoke_all('restore_succeed', $settings, $message, $params); return FALSE; } /** * Cleanup after a success or failure. */ function backup_migrate_cleanup() { // Check that the cleanup function exists. If it doesn't then we probably didn't create any files to be cleaned up. if (function_exists('_backup_migrate_temp_files_delete')) { _backup_migrate_temp_files_delete(); } } /** * Shutdown callback. Called when the script terminates even if the script timed out. */ function backup_migrate_shutdown($settings) { // If we ran out of time, set an error so the user knows what happened if (_backup_migrate_check_timeout()) { backup_migrate_cleanup(); backup_migrate_backup_fail('The operation timed out. Try increasing your PHP max_execution_time setting.', array('!url' => 'http://www.php.net/manual/en/info.configuration.php#ini.max-execution-time'), $settings); // The session will have already been written and closed, so we need to write any changes directly. _drupal_session_write(session_id(), session_encode()); // Add a redirect or we'll just get whitescreened. drupal_goto(BACKUP_MIGRATE_MENU_PATH); } } /* Actions/Workflow integration */ /** * 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', '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'), 'description' => t('Backup the database with the default settings.'), ), ); } */ /* * Action callback. */ function backup_migrate_action_backup() { _backup_migrate_backup_with_defaults(); } /* Utilities */ /** * Backup the database with the default settings. */ function _backup_migrate_backup_with_defaults($destination_id = "manual") { backup_migrate_include('files', 'profiles'); $settings = _backup_migrate_profile_saved_default_profile(); $settings->destination_id = $destination_id; $settings->source_id = 'db'; backup_migrate_perform_backup($settings); } /** * Helper function to set a drupal message and watchdog message depending on whether the module is being run interactively. */ function _backup_migrate_message($message, $replace = array(), $type = 'status') { // Only set a message if there is a callback handler to handle the message. if (($callback = _backup_migrate_message_callback()) && function_exists($callback)) { $callback($message, $replace, $type); } // Store the message in case it's needed (for the status notification filter for example). _backup_migrate_messages($message, $replace, $type); } /** * Helper function to set a drupal message and watchdog message depending on whether the module is being run interactively. */ function _backup_migrate_messages($message = NULL, $replace = array(), $type = 'status') { static $messages = array(); if ($message) { $messages[] = array('message' => $message, 'replace' => $replace, 'type' => 'status'); } return $messages; } /** * Send a message to the browser. The normal type of message handling for interactive use. */ function _backup_migrate_message_browser($message, $replace, $type) { // Log the message as well for admins. _backup_migrate_message_log($message, $replace, $type); // If there are links, we can display them in the browser. if (!empty($replace['!links'])) { $message .= " (!links)"; } // Use drupal_set_message to display to the user. drupal_set_message(t($message, $replace), str_replace('success', 'status', $type), FALSE); } /** * Log message if we are in a non-interactive mode such as a cron run. */ function _backup_migrate_message_log($message, $replace, $type) { // We only want to log the errors or successful completions. if (in_array($type, array('error', 'success'))) { watchdog('backup_migrate', $message, $replace, $type == 'error' ? WATCHDOG_ERROR : WATCHDOG_NOTICE); } } /** * Set or retrieve a message handler. */ function _backup_migrate_message_callback($callback = NULL) { static $current_callback = '_backup_migrate_message_log'; if ($callback !== NULL) { $current_callback = $callback; } return $current_callback; } function _backup_migrate_check_timeout() { static $timeout; // Max execution of 0 means unlimited. if (ini_get('max_execution_time') == 0) { return false; } // Figure out when we should stop execution. if (!$timeout) { $timeout = (!empty($_SERVER['REQUEST_TIME']) ? $_SERVER['REQUEST_TIME'] : time()) + ini_get('max_execution_time') - variable_get('backup_migrate_timeout_buffer', 5); } return (time() > $timeout); } /** * Convert an associated array to an ini format string. */ function _backup_migrate_array_to_ini($data, $prefix = '') { $content = ""; foreach ($data as $key => $val) { if ($prefix) { $key = $prefix . '[' . $key .']'; } if (is_array($val)) { $content .= _backup_migrate_array_to_ini($val, $key); } else { $content .= $key . " = \"". $val ."\"\n"; } } return $content; } /** * Execute a command line command. Returns false if the function failed. */ function backup_migrate_exec($command, $args = array()) { if (!function_exists('exec') || ini_get('safe_mode')) { return FALSE; } // Escape the arguments foreach ($args as $key => $arg) { $args[$key] = escapeshellarg($arg); } $command = strtr($command, $args); $output = $result = NULL; // Run the command. exec($command . ' 2>&1', $output, $result); return $result == 0; }