You are here

Home » API reference » Backup and Migrate 6.3 » sources.db.inc

class backup_migrate_source_db in Backup and Migrate 6.3

Same name and namespace in other branches
  1. 8.3 includes/sources.db.inc \backup_migrate_source_db
  2. 7.3 includes/sources.db.inc \backup_migrate_source_db

A destination type for saving to a database server.

Hierarchy

Expanded class hierarchy of backup_migrate_source_db

1 string reference to 'backup_migrate_source_db'
backup_migrate_backup_migrate_source_subtypes in includes/sources.inc
Implementation of hook_backup_migrate_source_subtypes().

File

includes/sources.db.inc, line 14
Functions to handle the direct to database destination.

View source 
class backup_migrate_source_db extends backup_migrate_source_remote {
  var $supported_ops = array(
    'configure',
    'source',
  );
  function type_name() {
    return t("Database");
  }

  /**
   * Save the info by importing it into the database.
   */
  function save_file($file, $settings) {
    backup_migrate_include('files');

    // Set the source_id to the destination_id in the settings since for a restore, the source_id is the
    // database that gets restored to.
    $settings
      ->set_source($this
      ->get_id());

    // Restore the file to the source database.
    $file = backup_migrate_perform_restore($this
      ->get_id(), $file, $settings);
    return $file;
  }

  /**
   * Destination configuration callback.
   */
  function edit_form() {
    $form = parent::edit_form();
    $form['scheme']['#default_value'] = $this
      ->default_scheme();
    $form['scheme']['#access'] = FALSE;
    $form['path']['#title'] = t('Database name');
    $form['path']['#description'] = t('The name of the database. The database must exist, it will not be created for you.');
    $form['user']['#description'] = t('Enter the name of a user who has write access to the database.');
    return $form;
  }

  /**
   * Validate the configuration form. Make sure the db info is valid.
   */
  function edit_form_validate($form, &$form_state) {
    if (!preg_match('/[a-zA-Z0-9_\\$]+/', $form_state['values']['path'])) {
      form_set_error('path', t('The database name is not valid.'));
    }
    parent::edit_form_validate($form, $form_state);
  }

  /**
   * Get the form for the settings for this destination.
   *
   * Return the default tables whose data can be ignored. These tables mostly contain
   *  info which can be easily reproducted (such as cache or search index)
   *  but also tables which can become quite bloated but are not necessarily extremely
   *  important to back up or migrate during development (such ass access log and watchdog)
   */
  function backup_settings_default() {
    $core = array(
      'cache',
      'cache_filter',
      'cache_rules',
      'cache_calendar_ical',
      'cache_menu',
      'cache_page',
      'cache_views',
      'cache_views_data',
      'cache_block',
      'cache_update',
      'cache_form',
      'sessions',
      'search_dataset',
      'search_index',
      'search_keywords_log',
      'search_total',
      'watchdog',
      'accesslog',
      'devel_queries',
      'devel_times',
    );
    $nodata_tables = array_merge($core, module_invoke_all('devel_caches'));
    return array(
      'nodata_tables' => $nodata_tables,
      'exclude_tables' => array(),
      'utils_lock_tables' => FALSE,
    );
  }

  /**
   * Get the form for the backup settings for this destination.
   */
  function backup_settings_form($settings) {
    $tables = $this
      ->get_table_names();
    $form['#description'] = t("You may omit specific tables, or specific table data from the backup file. Only omit data that you know you will not need such as cache data, or tables from other applications. Excluding tables can break your Drupal install, so <strong>do not change these settings unless you know what you're doing</strong>.");
    $form['exclude_tables'] = array(
      "#type" => "select",
      "#multiple" => TRUE,
      "#title" => t("Exclude the following tables altogether"),
      "#options" => $tables,
      "#default_value" => $settings['exclude_tables'],
      "#description" => t("The selected tables will not be added to the backup file."),
    );
    $form['nodata_tables'] = array(
      "#type" => "select",
      "#multiple" => TRUE,
      "#title" => t("Exclude the data from the following tables"),
      "#options" => $tables,
      "#default_value" => $settings['nodata_tables'],
      "#description" => t("The selected tables will have their structure backed up but not their contents. This is useful for excluding cache data to reduce file size."),
    );
    $form['utils_lock_tables'] = array(
      '#type' => 'checkbox',
      '#title' => t('Lock tables during backup'),
      '#default_value' => !empty($settings['utils_lock_tables']) ? $settings['utils_lock_tables'] : NULL,
      '#description' => t('This can help reduce data corruption, but will make your site unresponsive.'),
    );
    return $form;
  }

  /**
   * Backup from this source.
   */
  function backup_to_file($file, $settings) {
    $file
      ->push_type($this
      ->get_file_type_id());

    // Switch to a different db if specified.
    $this
      ->switch_db();
    $this
      ->lock_tables($settings);
    $success = $this
      ->_backup_db_to_file($file, $settings);
    $this
      ->unlock_tables($settings);

    // Switch back to the previous db.
    $this
      ->switch_db(TRUE);
    return $success ? $file : FALSE;
  }

  /**
   * Restore to this source.
   */
  function restore_from_file($file, &$settings) {
    $num = 0;
    $type = $this
      ->get_file_type_id();

    // Open the file using the file wrapper. Check that the dump is of the right type (allow .sql for legacy reasons).
    if ($file
      ->type_id() !== $this
      ->get_file_type_id() && $file
      ->type_id() !== 'sql') {
      _backup_migrate_message("Unable to restore from file %file because a %type file can't be restored to this database.", array(
        "%file" => $file
          ->filepath(),
        '%type' => $file
          ->type_id(),
      ), 'error');
    }
    else {
      backup_migrate_filters_invoke_all('pre_restore', $file, $settings);

      // Switch to a different db if specified.
      $this
        ->switch_db();

      // Restore the database.
      $num = $this
        ->_restore_db_from_file($file, $settings);
      $settings->performed_action = $num ? t('%num SQL commands executed.', array(
        '%num' => $num,
      )) : '';

      // Switch back to the previous db.
      $this
        ->switch_db(TRUE);
      backup_migrate_filters_invoke_all('post_restore', $file, $settings, $num);
    }
    return $num;
  }

  /**
   * Backup the databases to a file.
   */
  function _backup_db_to_file($file, $settings) {

    // Must be overridden.
  }

  /**
   * Backup the databases to a file.
   */
  function _restore_db_from_file($file, $settings) {

    // Must be overridden.
  }

  /**
   * Get a list of tables in the database.
   */
  function get_table_names() {

    // Switch to a different db if specified.
    $this
      ->switch_db();

    // Must be overridden.
    $out = $this
      ->_get_table_names();
    $this
      ->switch_db(TRUE);
    return $out;
  }

  /**
   * Get a list of tables in the database.
   */
  function _get_table_names() {

    // Must be overridden.
    return array();
  }

  /**
   * Switch to the current database. Pass true to switch back to the previous db.
   */
  function switch_db($switch_back = FALSE) {
    static $db_stack = array(), $db_url_stack = array();

    // If switch back is specified, pop the previous db and activate it.
    if ($switch_back && $db_stack) {

      // Reset the db_url.
      $GLOBALS['db_url'] = array_pop($db_url_stack);

      // Set the active db to the first one on the stack.
      db_set_active(array_pop($db_stack));
      return;
    }

    // If there is a valid DB URL, switch to it.
    if ($url = $this
      ->get_location()) {

      // Add the current db_url to the stack.
      $db_url_stack[] = $GLOBALS['db_url'];

      // Make the db_url into an array if needed.
      if (!is_array($GLOBALS['db_url'])) {
        $GLOBALS['db_url'] = array(
          'default' => $GLOBALS['db_url'],
        );
      }

      // Add the new db to the db_url array.
      $GLOBALS['db_url'][$url] = $url;

      // Switch to the new db and push the old one on the stack
      $db_stack[] = db_set_active($url);
    }
  }

  /**
   * Lock the database in anticipation of a backup.
   */
  function lock_tables($settings) {
    if ($settings->filters['utils_lock_tables']) {
      $tables = array();
      foreach ($this
        ->get_table_names() as $table) {

        // There's no need to lock excluded or structure only tables because it doesn't matter if they change.
        if (empty($settings->filters['exclude_tables']) || !in_array($table, (array) $settings->filters['exclude_tables'])) {
          $tables[] = $table;
        }
      }
      $this
        ->_lock_tables($tables);
    }
  }

  /**
   * Lock the list of given tables in the database.
   */
  function _lock_tables($tables) {

    // Must be overridden.
  }

  /**
   * Unlock any tables that have been locked.
   */
  function unlock_tables($settings) {
    if ($settings->filters['utils_lock_tables']) {
      $this
        ->_unlock_tables();
    }
  }

  /**
   * Unlock the list of given tables in the database.
   */
  function _unlock_tables($tables) {

    // Must be overridden.
  }

  /**
   * Get the file type for to backup this destination to.
   */
  function get_file_type_id() {
    return 'sql';
  }

  /**
   * Get the version info for the given DB.
   */
  function _db_info() {
    return array(
      'type' => FALSE,
      'version' => t('Unknown'),
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
backup_migrate_item::$settings_path property
backup_migrate_item::$show_in_list property
backup_migrate_item::$storage property
backup_migrate_item::all_items function Get all of the given items.
backup_migrate_item::decode_db_row function Decode a loaded db row (unserialize necessary fields).
backup_migrate_item::delete function Delete the item from the database.
backup_migrate_item::export function Return as an exported array of values.
backup_migrate_item::from_array function Load an existing item from an array.
backup_migrate_item::generate_id function Return a random (very very likely unique) string id for a new item.
backup_migrate_item::get function Get the member with the given key.
backup_migrate_item::get_actions function Get the rendered action links for a destination.
backup_migrate_item::get_default_values function Get the default values for standard parameters. 2
backup_migrate_item::get_id function Get the primary id for this item (if any is set).
backup_migrate_item::get_list function Get a table of all items of this type. 1
backup_migrate_item::get_list_header function Get header for a lost of this type.
backup_migrate_item::get_machine_name_field function Get the machine name field name from the schema.
backup_migrate_item::get_menu_items function Get the menu items for manipulating this type. 2
backup_migrate_item::get_primary_key function Get the primary key field title from the schema.
backup_migrate_item::get_schema function Get the schema for the item type.
backup_migrate_item::get_serialized_fields function Return the fields which must be serialized before saving to the db.
backup_migrate_item::get_settings_path function Get the columns needed to list the type.
backup_migrate_item::item function A particular item.
backup_migrate_item::item_exists function A particular item.
backup_migrate_item::load_row function Load an existing item from an database (serialized) array.
backup_migrate_item::revert_confirm_message function Get the message to send to the user when confirming the deletion of the item.
backup_migrate_item::save function Save the item to the database.
backup_migrate_item::set_id function Set the primary id for this item (if any is set).
backup_migrate_item::show_in_list function Get the columns needed to list the type.
backup_migrate_item::to_array function Return as an array of values. 1
backup_migrate_item::unique_id function Make sure this item has a unique id. Should only be called for new items or the item will collide with itself.
backup_migrate_item::_merge_defaults function Merge parameters with the given defaults.
backup_migrate_item::__construct function Constructor, set the basic info pulled from the db or generated programatically. 4
backup_migrate_location::$default_values property Overrides backup_migrate_item::$default_values 1
backup_migrate_location::$subtype property
backup_migrate_location::backup_settings_form_submit function Submit the settings form. Any values returned will be saved.
backup_migrate_location::backup_settings_form_validate function Get the form for the settings for this filter.
backup_migrate_location::can_read_file function Determine if we can read the given file. 1
backup_migrate_location::create function Create a new location of the correct type. Overrides backup_migrate_item::create
backup_migrate_location::delete_confirm_message function Get the message to send to the user when confirming the deletion of the item. Overrides backup_migrate_item::delete_confirm_message 1
backup_migrate_location::file_types function Retrieve a list of filetypes supported by this source/destination. 2
backup_migrate_location::get_action_links function Get the action links for a location. Overrides backup_migrate_item::get_action_links 1
backup_migrate_location::get_list_column_info function Get the columns needed to list the type. Overrides backup_migrate_item::get_list_column_info
backup_migrate_location::get_list_row function Get a row of data to be used in a list of items of this type. Overrides backup_migrate_item::get_list_row 1
backup_migrate_location::get_name function Get the name of the item. Overrides backup_migrate_item::get_name 1
backup_migrate_location::get_subtype_name function Get the type name of this location for display to the user.
backup_migrate_location::glue_url function Glue a URLs component parts back into a URL. 1
backup_migrate_location::op function Does this location support the given operation.
backup_migrate_location::ops function
backup_migrate_location::remove_op function Remove the given op from the support list.
backup_migrate_location::restore_settings_default function Get the form for the settings for this filter.
backup_migrate_location::restore_settings_form function Get the form for the settings for this filter.
backup_migrate_location::restore_settings_form_submit function Submit the settings form. Any values returned will be saved.
backup_migrate_location::restore_settings_form_validate function Get the form for the settings for this filter.
backup_migrate_location::settings function
backup_migrate_location::settings_default function Get the form for the settings for this location type. 1
backup_migrate_location::settings_form function Get the form for the settings for this location. 1
backup_migrate_location::settings_form_submit function Submit the settings form. Any values returned will be saved. 1
backup_migrate_location::settings_form_validate function Validate the form for the settings for this location. 1
backup_migrate_location::set_name function
backup_migrate_location::set_url function Break a URL into it's component parts. 1
backup_migrate_location::url function Get a url from the parts. 1
backup_migrate_source::$db_table property Overrides backup_migrate_location::$db_table
backup_migrate_source::$plural property Overrides backup_migrate_location::$plural
backup_migrate_source::$singular property Overrides backup_migrate_location::$singular
backup_migrate_source::$title_plural property Overrides backup_migrate_location::$title_plural
backup_migrate_source::$title_singular property Overrides backup_migrate_location::$title_singular
backup_migrate_source::$type_name property Overrides backup_migrate_location::$type_name
backup_migrate_source::location_types function Get the available location types. Overrides backup_migrate_location::location_types
backup_migrate_source::strings function This function is not supposed to be called. It is just here to help the po extractor out. Overrides backup_migrate_location::strings
backup_migrate_source_db::$supported_ops property Overrides backup_migrate_location::$supported_ops
backup_migrate_source_db::backup_settings_default function Get the form for the settings for this destination. Overrides backup_migrate_location::backup_settings_default
backup_migrate_source_db::backup_settings_form function Get the form for the backup settings for this destination. Overrides backup_migrate_location::backup_settings_form
backup_migrate_source_db::backup_to_file function Backup from this source.
backup_migrate_source_db::edit_form function Destination configuration callback. Overrides backup_migrate_source_remote::edit_form
backup_migrate_source_db::edit_form_validate function Validate the configuration form. Make sure the db info is valid. Overrides backup_migrate_item::edit_form_validate
backup_migrate_source_db::get_file_type_id function Get the file type for to backup this destination to. 1
backup_migrate_source_db::get_table_names function Get a list of tables in the database.
backup_migrate_source_db::lock_tables function Lock the database in anticipation of a backup.
backup_migrate_source_db::restore_from_file function Restore to this source.
backup_migrate_source_db::save_file function Save the info by importing it into the database.
backup_migrate_source_db::switch_db function Switch to the current database. Pass true to switch back to the previous db.
backup_migrate_source_db::type_name function 1
backup_migrate_source_db::unlock_tables function Unlock any tables that have been locked.
backup_migrate_source_db::_backup_db_to_file function Backup the databases to a file. 1
backup_migrate_source_db::_db_info function Get the version info for the given DB. 1
backup_migrate_source_db::_get_table_names function Get a list of tables in the database. 1
backup_migrate_source_db::_lock_tables function Lock the list of given tables in the database. 1
backup_migrate_source_db::_restore_db_from_file function Backup the databases to a file. 1
backup_migrate_source_db::_unlock_tables function Unlock the list of given tables in the database. 1
backup_migrate_source_remote::edit_form_submit function Submit the configuration form. Glue the url together and add the old password back if a new one was not specified. Overrides backup_migrate_item::edit_form_submit
backup_migrate_source_remote::get_display_location function The location to display is the url without the password. Overrides backup_migrate_location::get_display_location
backup_migrate_source_remote::get_location function The location is a URI so parse it and store the parts. Overrides backup_migrate_location::get_location
backup_migrate_source_remote::set_location function Return the location with the password. Overrides backup_migrate_location::set_location