class backup_migrate_destination_db_mysql

  1. nittany7 modules/contrib/backup_migrate/includes/destinations.db.mysql.inc backup_migrate_destination_db_mysql
  2. mooc7 modules/contrib/backup_migrate/includes/destinations.db.mysql.inc backup_migrate_destination_db_mysql

Hierarchy

Expanded class hierarchy of backup_migrate_destination_db_mysql

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
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.
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 Create an ini file and write the meta data.
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.
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::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
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.
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.
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.
backup_migrate_destination::_file_info_file function Create the info file object.
backup_migrate_destination::_file_info_filename function Determine the file name of the info file for a file.
backup_migrate_destination::_list_files function List all the available files in the given destination with their destination specific id.
backup_migrate_destination::_save_file function Save the given file to the destination.
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_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_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::unlock_tables function Unlock any tables that have been locked.
backup_migrate_destination_db_mysql::backup_settings_form function Get the form for the backup settings for this destination. Overrides backup_migrate_destination_db::backup_settings_form
backup_migrate_destination_db_mysql::destinations function Declare any mysql databases defined in the settings.php file as a possible destination.
backup_migrate_destination_db_mysql::file_types function Return a list of backup filetypes. Overrides backup_migrate_destination::file_types
backup_migrate_destination_db_mysql::get_file_type_id function Get the file type for to backup this destination to. Overrides backup_migrate_destination_db::get_file_type_id
backup_migrate_destination_db_mysql::query function Run a db query on this destination's db.
backup_migrate_destination_db_mysql::type_name function Overrides backup_migrate_destination_db::type_name
backup_migrate_destination_db_mysql::_backup_db_to_file function Backup the databases to a file. Overrides backup_migrate_destination_db::_backup_db_to_file
backup_migrate_destination_db_mysql::_backup_db_to_file_mysqldump function Backup the databases to a file using the mysqldump command.
backup_migrate_destination_db_mysql::_dump_table_data_sql_to_file function Get the sql to insert the data for a given table
backup_migrate_destination_db_mysql::_get_db_connection function Get the db connection for the specified db. Overrides backup_migrate_destination_db::_get_db_connection
backup_migrate_destination_db_mysql::_get_sql_file_footer function The footer of the sql dump file.
backup_migrate_destination_db_mysql::_get_sql_file_header function The header for the top of the sql dump file. These commands set the connection character encoding to help prevent encoding conversion issues.
backup_migrate_destination_db_mysql::_get_tables function Get a list of tables in the db.
backup_migrate_destination_db_mysql::_get_table_names function Get a list of tables in the database. Overrides backup_migrate_destination_db::_get_table_names
backup_migrate_destination_db_mysql::_get_table_structure_sql function Get the sql for the structure of the given table.
backup_migrate_destination_db_mysql::_lock_tables function Lock the list of given tables in the database. Overrides backup_migrate_destination_db::_lock_tables
backup_migrate_destination_db_mysql::_read_sql_command_from_file function Read a multiline sql command from a file.
backup_migrate_destination_db_mysql::_restore_db_from_file function Backup the databases to a file. Overrides backup_migrate_destination_db::_restore_db_from_file
backup_migrate_destination_db_mysql::_unlock_tables function Unlock all tables in the database. Overrides backup_migrate_destination_db::_unlock_tables
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
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::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.
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.
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.

File

modules/contrib/backup_migrate/includes/destinations.db.mysql.inc, line 16
Functions to handle the direct to database destination.

View source
class backup_migrate_destination_db_mysql extends backup_migrate_destination_db {
  function type_name() {
    return t("MySQL Database");
  }

  /**
   * Return a list of backup filetypes.
   */
  function file_types() {
    return array(
      "sql" => array(
        "extension" => "sql",
        "filemime" => "text/x-sql",
        "backup" => TRUE,
        "restore" => TRUE,
      ),
      "mysql" => array(
        "extension" => "mysql",
        "filemime" => "text/x-sql",
        "backup" => TRUE,
        "restore" => TRUE,
      ),
    );
  }

  /**
   * Declare any mysql databases defined in the settings.php file as a possible destination.
   */
  function destinations() {
    $out = array();
    global $databases;
    foreach ((array) $databases as $db_key => $target) {
      foreach ((array) $target as $tgt_key => $info) {
        // Only mysql/mysqli supported by this destination.
        $key = $db_key . ':' . $tgt_key;
        if ($info['driver'] === 'mysql') {
          $url = $info['driver'] . '://' . $info['username'] . ':' . $info['password'] . '@' . $info['host'] . (isset($info['port']) ? ':' . $info['port'] : '') . '/' . $info['database'];
          if ($destination = backup_migrate_create_destination('mysql', array('url' => $url))) {
            // Make sure the connection is valid.
            if ($destination->_get_db_connection()) {
              // Treat the default database differently because it is probably the only one available.
              if ($key == 'default:default') {
                $destination->set_id('db');
                $destination->set_name(t('Default Database'));
                // Dissalow backing up to the default database because that's confusing and potentially dangerous.
                $destination->remove_op('scheduled backup');
                $destination->remove_op('manual backup');
              }
              else {
                $destination->set_id('db:' . $key);
                $destination->set_name($key . ": " . $destination->get_display_location());
              }
              $out[$destination->get_id()] = $destination;
            }
          }
        }
      }
    }
    return $out;
  }

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

  /**
   * Get the form for the backup settings for this destination.
   */
  function backup_settings_form($settings) {
    $form = parent::backup_settings_form($settings);

    $form['use_mysqldump'] = array(
      "#type" => "checkbox",
      "#title" => t("Use mysqldump command"),
      "#default_value" => !empty($settings['use_mysqldump']),
      "#description" => t("Use the mysqldump command line tool if available. This can be faster for large databases but will not work on all servers. EXPERIMENTAL"),
    );

    return $form;
  }


  /**
   * Backup the databases to a 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_db_to_file($file, $settings) {
    if (!empty($settings->filters['use_mysqldump']) && $this->_backup_db_to_file_mysqldump($file, $settings)) {
      return TRUE;
    }

    $lines = 0;
    $exclude = !empty($settings->filters['exclude_tables']) ? $settings->filters['exclude_tables'] : array();
    $nodata = !empty($settings->filters['nodata_tables']) ? $settings->filters['nodata_tables'] : array();
    if ($file->open(TRUE)) {
      $file->write($this->_get_sql_file_header());
      $alltables = $this->_get_tables();
      foreach ($alltables as $table) {
        if (_backup_migrate_check_timeout()) {
          return FALSE;
        }
        if ($table['name'] && !isset($exclude[$table['name']])) {
          $file->write($this->_get_table_structure_sql($table));
          $lines++;
          if (!in_array($table['name'], $nodata)) {
            $lines += $this->_dump_table_data_sql_to_file($file, $table);
          }
        }
      }
      $file->write($this->_get_sql_file_footer());
      $file->close();
      return $lines;
    }
    else {
      return FALSE;
    }
  }


  /**
   * Backup the databases to a file using the mysqldump command.
   */
  function _backup_db_to_file_mysqldump($file, $settings) {
    $success = FALSE;
    $nodata_tables = array();
    $alltables = $this->_get_tables();


    $command = 'mysqldump --result-file=%file --opt -Q --host=%host --port=%port --user=%user --password=%pass %db';
    $args = array(
      '%file' => $file->filepath(),
      '%host' => $this->dest_url['host'],
      '%port' => !empty($this->dest_url['port']) ? $this->dest_url['port'] : '3306',
      '%user' => $this->dest_url['user'],
      '%pass' => $this->dest_url['pass'],
      '%db' => $this->dest_url['path'],
    );

    // Ignore the excluded and no-data tables.
    if (!empty($settings->filters['exclude_tables'])) {
      $db = $this->dest_url['path'];
      foreach ((array) $settings->filters['exclude_tables'] as $table) {
        if (isset($alltables[$table])) {
          $command .= ' --ignore-table=' . $db . '.' . $table;
        }
      }
      foreach ((array) $settings->filters['nodata_tables'] as $table) {
        if (isset($alltables[$table])) {
          $nodata_tables[] = $table;
          $command .= ' --ignore-table=' . $db . '.' . $table;
        }
      }
    }
    $success = backup_migrate_exec($command, $args);

    // Get the nodata tables.
    if ($success && !empty($nodata_tables)) {
      $tables = implode(' ', array_unique($nodata_tables));
      $command = "mysqldump --no-data --opt -Q --host=%host --port=%port --user=%user --password=%pass %db $tables >> %file";
      $success = backup_migrate_exec($command, $args);
    }
    return $success;
  }

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

    if ($file->open() && $conn = $this->_get_db_connection()) {
      // Read one line at a time and run the query.
      while ($line = $this->_read_sql_command_from_file($file)) {
        if (_backup_migrate_check_timeout()) {
          return FALSE;
        }
        if ($line) {
          // Prepeare and exexute the statement instead of the api function to avoid substitution of '{' etc.
          $stmt = $conn->prepare($line);
          $stmt->execute();
          $num++;
        }
      }
      // Close the file with fclose/gzclose.
      $file->close();
    }
    else {
      drupal_set_message(t("Unable to open file %file to restore database", array("%file" => $file->filepath())), 'error');
      $num = FALSE;
    }
    return $num;
  }


  /**
   * Read a multiline sql command from a file.
   *
   * Supports the formatting created by mysqldump, but won't handle multiline comments.
   */
  function _read_sql_command_from_file($file) {
    $out = '';
    while ($line = $file->read()) {
      $first2 = substr($line, 0, 2);
      $first3 = substr($line, 0, 2);

      // Ignore single line comments. This function doesn't support multiline comments or inline comments.
      if ($first2 != '--' && ($first2 != '/*' || $first3 == '/*!')) {
        $out .= ' ' . trim($line);
        // If a line ends in ; or */ it is a sql command.
        if (substr($out, strlen($out) - 1, 1) == ';') {
          return trim($out);
        }
      }
    }
    return trim($out);
  }

  /**
   * Get a list of tables in the database.
   */
  function _get_table_names() {
    $out = array();
    foreach ($this->_get_tables() as $table) {
      $out[$table['name']] = $table['name'];
    }
    return $out;
  }

  /**
   * Lock the list of given tables in the database.
   */
  function _lock_tables($tables) {
    if ($tables) {
      $tables_escaped = array();
      foreach ($tables as $table) {
        $tables_escaped[] = '`' . db_escape_table($table) . '`  WRITE';
      }
      $this->query('LOCK TABLES ' . implode(', ', $tables_escaped));
    }
  }

  /**
   * Unlock all tables in the database.
   */
  function _unlock_tables($settings) {
    $this->query('UNLOCK TABLES');
  }

  /**
   * Get a list of tables in the db.
   */
  function _get_tables() {
    $out = array();
    // get auto_increment values and names of all tables
    $tables = $this->query("show table status", array(), array('fetch' => PDO::FETCH_ASSOC));
    foreach ($tables as $table) {
      // Lowercase the keys because between Drupal 7.12 and 7.13/14 the default query behavior was changed.
      // See: http://drupal.org/node/1171866
      $table = array_change_key_case($table);
      $out[$table['name']] = $table;
    }
    return $out;
  }

  /**
   * Get the sql for the structure of the given table.
   */
  function _get_table_structure_sql($table) {
    $out = "";
    $result = $this->query("SHOW CREATE TABLE `" . $table['name'] . "`", array(), array('fetch' => PDO::FETCH_ASSOC));
    foreach ($result as $create) {
      // Lowercase the keys because between Drupal 7.12 and 7.13/14 the default query behavior was changed.
      // See: http://drupal.org/node/1171866
      $create = array_change_key_case($create);
      $out .= "DROP TABLE IF EXISTS `" . $table['name'] . "`;\n";
      // Remove newlines and convert " to ` because PDO seems to convert those for some reason.
      $out .= strtr($create['create table'], array("\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 _dump_table_data_sql_to_file($file, $table) {
    $rows_per_line = variable_get('backup_migrate_data_rows_per_line', 30);
    $bytes_per_line = variable_get('backup_migrate_data_bytes_per_line', 2000);

    $lines = 0;
    $data = $this->query("SELECT * FROM `" . $table['name'] . "`", array(), array('fetch' => PDO::FETCH_ASSOC));
    $rows = $bytes = 0;

    // Escape backslashes, PHP code, special chars
    $search = array(
      '\\',
      "'",
      "\x00",
      "\x0a",
      "\x0d",
      "\x1a",
    );
    $replace = array(
      '\\\\',
      "''",
      '\0',
      '\n',
      '\r',
      '\Z',
    );

    $line = array();
    foreach ($data as $row) {
      // DB Escape the values.
      $items = array();
      foreach ($row as $key => $value) {
        $items[] = is_null($value) ? "null" : "'" . str_replace($search, $replace, $value) . "'";
      }

      // If there is a row to be added.
      if ($items) {
        // Start a new line if we need to.
        if ($rows == 0) {
          $file->write("INSERT INTO `" . $table['name'] . "` VALUES ");
          $bytes = $rows = 0;
        }
        // Otherwise add a comma to end the previous entry.
        else {
          $file->write(",");
        }

        // Write the data itself.
        $sql = implode(',', $items);
        $file->write('(' . $sql . ')');
        $bytes += strlen($sql);
        $rows++;

        // Finish the last line if we've added enough items
        if ($rows >= $rows_per_line || $bytes >= $bytes_per_line) {
          $file->write(";\n");
          $lines++;
          $bytes = $rows = 0;
        }
      }
    }
    // Finish any unfinished insert statements.
    if ($rows > 0) {
      $file->write(";\n");
      $lines++;
    }

    return $lines;
  }

  /**
   * Get the db connection for the specified db.
   */
  function _get_db_connection() {
    if (!$this->connection) {
      if ($this->connection = parent::_get_db_connection()) {
        // Set the sql mode because the default is ANSI,TRADITIONAL which is not aware of collation or storage engine.
        $this->connection->exec("SET sql_mode=''");
      }
    }
    return $this->connection;
  }

  /**
   * Run a db query on this destination's db.
   */
  function query($query, $args = array(), $options = array()) {
    if ($conn = $this->_get_db_connection()) {
      return $conn->query($query, $args, $options);
    }
  }

  /**
   * The header for the top of the sql dump file. These commands set the connection
   *  character encoding to help prevent encoding conversion issues.
   */
  function _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 _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 */;
";
  }
}