class backup_migrate_destination_db in Backup and Migrate 8.2

Same name and namespace in other branches

8.3 includes/destinations.db.inc \backup_migrate_destination_db
6.2 includes/destinations.db.inc \backup_migrate_destination_db
7.3 includes/destinations.db.inc \backup_migrate_destination_db
7.2 includes/destinations.db.inc \backup_migrate_destination_db

A destination type for saving to a database server.

Hierarchy

class \backup_migrate_item
- class \backup_migrate_destination
  - class \backup_migrate_destination_remote
    class \backup_migrate_destination_db

Expanded class hierarchy of backup_migrate_destination_db

1 string reference to 'backup_migrate_destination_db'

backup_migrate_backup_migrate_destination_types in includes/destinations.inc: Implementation of hook_backup_migrate_destination_types().

File

includes/destinations.db.inc, line 17: Functions to handle the direct to database destination.

View source

class backup_migrate_destination_db extends backup_migrate_destination_remote {
  var $supported_ops = array(
    'scheduled backup',
    'manual backup',
    'configure',
    'source',
  );
  var $db_target = 'default';
  var $connection = null;
  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']['#title'] = t('Database type');

    //    $form['scheme']['#options'] = array($GLOBALS['db_type'] => $GLOBALS['db_type']);
    $form['scheme']['#description'] = t('The type of the database. Drupal only supports one database type at a time, so this must be the same as the current database type.');
    $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_admin_menu',
      'cache_browscap',
      'cache_content',
      'cache_filter',
      'cache_calendar_ical',
      'cache_location',
      'cache_menu',
      'cache_page',
      'cache_reptag',
      'cache_views',
      'cache_views_data',
      'cache_block',
      'cache_update',
      'cache_form',
      'cache_bootstrap',
      'cache_field',
      'cache_image',
      'cache_path',
      'sessions',
      'search_dataset',
      'search_index',
      'search_keywords_log',
      'search_total',
      'watchdog',
      'accesslog',
      'devel_queries',
      'devel_times',
    );
    $nodata_tables = array_merge($core, \Drupal::moduleHandler()
      ->invokeAll('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());
    backup_migrate_filters_invoke_all('pre_backup', $this, $file, $settings);

    //$this->lock_tables($settings);

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

    //$this->unlock_tables($settings);
    backup_migrate_filters_invoke_all('post_backup', $this, $file, $settings, $success);
    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);

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

  /**
   * Get the db connection for the specified db.
   */
  function _get_db_connection() {
    if (!$this->connection) {
      $target = $key = '';
      $parts = explode(':', $this
        ->get_id());

      // One of the predefined databases (set in settings.php)
      if ($parts[0] == 'db') {
        $key = empty($parts[1]) ? 'default' : $parts[1];
        $target = empty($parts[2]) ? 'default' : $parts[2];
      }
      else {

        // If the url is specified build it into a connection info array.
        if (!empty($this->dest_url)) {
          $info = array(
            'driver' => empty($this->dest_url['scheme']) ? NULL : $this->dest_url['scheme'],
            'host' => empty($this->dest_url['host']) ? NULL : $this->dest_url['host'],
            'port' => empty($this->dest_url['port']) ? NULL : $this->dest_url['port'],
            'username' => empty($this->dest_url['user']) ? NULL : $this->dest_url['user'],
            'password' => empty($this->dest_url['pass']) ? NULL : $this->dest_url['pass'],
            'database' => empty($this->dest_url['path']) ? NULL : $this->dest_url['path'],
          );
          $key = uniqid('backup_migrate_tmp_');
          $target = 'default';
          Database::addConnectionInfo($key, $target, $info);
        }
        else {
          $key = $target = 'default';
        }
      }
      if ($target && $key) {
        $this->connection = Database::getConnection($target, $key);
      }
    }
    return $this->connection;
  }

  /**
   * 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() {

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

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

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

  /**
   * 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';
  }

}

Members

Name	Type	Description	Overrides
backup_migrate_destination::$cache_expire	property
backup_migrate_destination::$cache_files	property		1
backup_migrate_destination::$db_table	property	Overrides backup_migrate_item::$db_table
backup_migrate_destination::$default_values	property	Overrides backup_migrate_item::$default_values
backup_migrate_destination::$destination_type	property
backup_migrate_destination::$fetch_time	property
backup_migrate_destination::$plural	property	Overrides backup_migrate_item::$plural
backup_migrate_destination::$singular	property	Overrides backup_migrate_item::$singular
backup_migrate_destination::$type_name	property	Overrides backup_migrate_item::$type_name
backup_migrate_destination::backup_settings_form_submit	function	Submit the settings form. Any values returned will be saved.
backup_migrate_destination::backup_settings_form_validate	function	Get the form for the settings for this filter.
backup_migrate_destination::can_delete_file	function	Determine if we can read the given file.
backup_migrate_destination::can_read_file	function	Determine if we can read the given file.	1
backup_migrate_destination::create	function	Create a new destination of the correct type. Overrides backup_migrate_item::create
backup_migrate_destination::create_info_file	function
backup_migrate_destination::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
backup_migrate_destination::delete_file	function	Delete the file with the given destination specific id.	1
backup_migrate_destination::file_cache_clear	function	Retrieve the file list.
backup_migrate_destination::file_cache_get	function	Retrieve the file list.
backup_migrate_destination::file_cache_set	function	Cache the file list.
backup_migrate_destination::file_exists	function	Check if a file exists in the given destination.
backup_migrate_destination::file_types	function		1
backup_migrate_destination::get_action_links	function	Get the action links for a destination. Overrides backup_migrate_item::get_action_links
backup_migrate_destination::get_destination_type_name	function	Get the type name of this destination for display to the user.
backup_migrate_destination::get_file_links	function	Get the action links for a file on a given destination.
backup_migrate_destination::get_list_column_info	function	Get the columns needed to list the type. Overrides backup_migrate_item::get_list_column_info
backup_migrate_destination::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_destination::get_menu_items	function	Add the menu items specific to the destination type. Overrides backup_migrate_item::get_menu_items
backup_migrate_destination::get_name	function	Get the name of the item. Overrides backup_migrate_item::get_name
backup_migrate_destination::list_files	function	List all the available files in the given destination with their destination specific id.
backup_migrate_destination::load_file	function	Load the file with the given destination specific id and return as a backup_file object.	4
backup_migrate_destination::load_files_info	function	Load up the file's metadata from the accompanying .info file if applicable.
backup_migrate_destination::op	function	Does this destination support the given operation.
backup_migrate_destination::ops	function
backup_migrate_destination::remove_op	function	Remove the given op from the support list.
backup_migrate_destination::restore_settings_default	function	Get the form for the settings for this filter.
backup_migrate_destination::restore_settings_form	function	Get the form for the settings for this filter.
backup_migrate_destination::restore_settings_form_submit	function	Submit the settings form. Any values returned will be saved.
backup_migrate_destination::restore_settings_form_validate	function	Get the form for the settings for this filter.
backup_migrate_destination::save_file_info	function	Save the file metadata
backup_migrate_destination::settings	function
backup_migrate_destination::settings_default	function	Get the form for the settings for this destination type.
backup_migrate_destination::settings_form	function	Get the form for the settings for this destination.
backup_migrate_destination::settings_form_submit	function	Submit the settings form. Any values returned will be saved.
backup_migrate_destination::settings_form_validate	function	Validate the form for the settings for this destination.	1
backup_migrate_destination::set_name	function
backup_migrate_destination::set_type	function
backup_migrate_destination::strings	function	This function is not supposed to be called. It is just here to help the po extractor out. Overrides backup_migrate_item::strings
backup_migrate_destination::_delete_file	function	Delete the file with the given destination specific id.	2
backup_migrate_destination::_list_files	function	List all the available files in the given destination with their destination specific id.	3
backup_migrate_destination::_save_file	function	Save the given file to the destination.	3
backup_migrate_destination_db::$connection	property
backup_migrate_destination_db::$db_target	property
backup_migrate_destination_db::$supported_ops	property	Overrides backup_migrate_destination::$supported_ops
backup_migrate_destination_db::backup_settings_default	function	Get the form for the settings for this destination. Overrides backup_migrate_destination::backup_settings_default
backup_migrate_destination_db::backup_settings_form	function	Get the form for the backup settings for this destination. Overrides backup_migrate_destination::backup_settings_form	1
backup_migrate_destination_db::backup_to_file	function	Backup from this source.
backup_migrate_destination_db::edit_form	function	Destination configuration callback. Overrides backup_migrate_destination_remote::edit_form
backup_migrate_destination_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_destination_db::get_file_type_id	function	Get the file type for to backup this destination to.	1
backup_migrate_destination_db::get_table_names	function	Get a list of tables in the database.
backup_migrate_destination_db::lock_tables	function	Lock the database in anticipation of a backup.
backup_migrate_destination_db::restore_from_file	function	Restore to this source.
backup_migrate_destination_db::save_file	function	Save the info by importing it into the database. Overrides backup_migrate_destination::save_file
backup_migrate_destination_db::type_name	function		1
backup_migrate_destination_db::unlock_tables	function	Unlock any tables that have been locked.
backup_migrate_destination_db::_backup_db_to_file	function	Backup the databases to a file.	1
backup_migrate_destination_db::_get_db_connection	function	Get the db connection for the specified db.	1
backup_migrate_destination_db::_get_table_names	function	Get a list of tables in the database.	1
backup_migrate_destination_db::_lock_tables	function	Lock the list of given tables in the database.	1
backup_migrate_destination_db::_restore_db_from_file	function	Backup the databases to a file.	1
backup_migrate_destination_db::_unlock_tables	function	Unlock the list of given tables in the database.	1
backup_migrate_destination_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	1
backup_migrate_destination_remote::get_display_location	function	The location to display is the url without the password. Overrides backup_migrate_destination::get_display_location
backup_migrate_destination_remote::get_location	function	The location is a URI so parse it and store the parts. Overrides backup_migrate_destination::get_location
backup_migrate_destination_remote::glue_url	function	Glue a URLs component parts back into a URL.
backup_migrate_destination_remote::set_location	function	Return the location with the password. Overrides backup_migrate_destination::set_location
backup_migrate_destination_remote::set_url	function	Break a URL into it's component parts.
backup_migrate_destination_remote::url	function	Get a url from the parts.
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_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::item	function	A particular item.
backup_migrate_item::load_row	function	Load an existing item from an database (serialized) array.
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::to_array	function	Return as an array of values.
backup_migrate_item::__construct	function	Constructor, set the basic info pulled from the db or generated programatically.	4

You are here

class backup_migrate_destination_db in Backup and Migrate 8.2

Hierarchy

File

Members

API Navigation