class MySQLiSource in Backup and Migrate 8.4

Class MySQLiSource.

@package BackupMigrate\Core\Source

Hierarchy

class \BackupMigrate\Core\Plugin\PluginBase implements ConfigurableInterface, PluginInterface uses ConfigurableTrait
- class \BackupMigrate\Core\Source\DatabaseSource implements FileProcessorInterface, DatabaseSourceInterface uses FileProcessorTrait
  - class \BackupMigrate\Core\Source\MySQLiSource implements PluginCallerInterface uses PluginCallerTrait

Expanded class hierarchy of MySQLiSource

2 files declare their use of MySQLiSource

DrupalFilesSourcePlugin.php in src/Plugin/BackupMigrateSource/DrupalFilesSourcePlugin.php
DrupalMySQLiSource.php in src/Source/DrupalMySQLiSource.php

File

lib/backup_migrate_core/src/Source/MySQLiSource.php, line 17

Namespace

BackupMigrate\Core\Source

View source

class MySQLiSource extends DatabaseSource implements PluginCallerInterface {
  use PluginCallerTrait;

  /**
   * @var resource A MySQLi connection.
   */
  protected $connection;

  /**
   * {@inheritdoc}
   */
  public function supportedOps() {
    return [
      'exportToFile' => [],
      'importFromFile' => [],
    ];
  }

  /**
   * Export this source to the given temp file. This should be the main
   * back up function for this source.
   *
   * @return \BackupMigrate\Core\File\BackupFileReadableInterface $file
   *    A backup file with the contents of the source dumped to it..
   */
  public function exportToFile() {
    if ($connection = $this
      ->_getConnection()) {
      $file = $this
        ->getTempFileManager()
        ->create('mysql');
      $exclude = (array) $this
        ->confGet('exclude_tables');
      $nodata = (array) $this
        ->confGet('nodata_tables');
      $file
        ->write($this
        ->_getSQLHeader());
      $tables = $this
        ->_getTables();
      $lines = 0;
      foreach ($tables as $table) {

        // @TODO reenable this.
        //        if (_backup_migrate_check_timeout()) {
        //          return FALSE;
        //        }
        $table = $this
          ->plugins()
          ->call('beforeDBTableBackup', $table, [
          'source' => $this,
        ]);
        if ($table['name'] && !isset($exclude[$table['name']]) && empty($table['exclude'])) {
          $file
            ->write($this
            ->_getTableCreateSQL($table));
          $lines++;
          if (empty($table['nodata']) && !in_array($table['name'], $nodata)) {
            $lines += $this
              ->_dumpTableSQLToFile($file, $table);
          }
        }
      }
      $file
        ->write($this
        ->_getSQLFooter());
      $file
        ->close();
      return $file;
    }
    else {

      // @TODO: Throw exception
      return $this
        ->getTempFileManager()
        ->create('mysql');
    }
  }

  /**
   * Import to this source from the given backup file. This is the main restore
   * function for this source.
   *
   * @param \BackupMigrate\Core\File\BackupFileReadableInterface $file
   *    The file to read the backup from. It will not be opened for reading
   *
   * @return bool|int
   */
  public function importFromFile(BackupFileReadableInterface $file) {
    $num = 0;
    if ($conn = $this
      ->_getConnection()) {

      // Open (or rewind) the file.
      $file
        ->openForRead();

      // Read one line at a time and run the query.
      while ($line = $this
        ->_readSQLCommand($file)) {

        //        if (_backup_migrate_check_timeout()) {
        //          return FALSE;
        //        }
        if ($line) {

          // Execute the sql query from the file.
          $conn
            ->query($line);
          $num++;
        }
      }

      // Close the file, we're done reading it.
      $file
        ->close();
    }
    return $num;
  }

  /**
   * Get the db connection for the specified db.
   *
   * @return \mysqli Connection object.
   *
   * @throws \Exception
   */
  protected function _getConnection() {
    if (!$this->connection) {
      if (!function_exists('mysqli_init') && !extension_loaded('mysqli')) {
        throw new BackupMigrateException('Cannot connect to the database because the MySQLi extension is missing.');
      }
      $pdo_config = $this
        ->confGet('pdo');
      $ssl_config = [
        'key' => !empty($pdo_config[PDO::MYSQL_ATTR_SSL_KEY]) ? $pdo_config[PDO::MYSQL_ATTR_SSL_KEY] : NULL,
        'cert' => !empty($pdo_config[PDO::MYSQL_ATTR_SSL_CERT]) ? $pdo_config[PDO::MYSQL_ATTR_SSL_CERT] : NULL,
        'ca' => !empty($pdo_config[PDO::MYSQL_ATTR_SSL_CA]) ? $pdo_config[PDO::MYSQL_ATTR_SSL_CA] : NULL,
        'capath' => !empty($pdo_config[PDO::MYSQL_ATTR_SSL_CAPATH]) ? $pdo_config[PDO::MYSQL_ATTR_SSL_CAPATH] : NULL,
        'cypher' => !empty($pdo_config[PDO::MYSQL_ATTR_SSL_CIPHER]) ? $pdo_config[PDO::MYSQL_ATTR_SSL_CIPHER] : NULL,
      ];
      if (defined('PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT')) {
        $ssl_config['verify_server_cert'] = isset($pdo_config[PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT]) ? $pdo_config[PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT] : TRUE;
      }
      else {
        $ssl_config['verify_server_cert'] = TRUE;
      }
      if ($ssl_config['key'] || $ssl_config['cert'] || $ssl_config['ca'] || $ssl_config['capath'] || $ssl_config['cypher']) {

        // Provide a workaround for PHP7 peer certificate verification issues:
        // - https://bugs.php.net/bug.php?id=68344
        // - https://bugs.php.net/bug.php?id=71003
        if ($ssl_config['verify_server_cert']) {
          $flags = MYSQLI_CLIENT_SSL;
        }
        else {
          $flags = MYSQLI_CLIENT_SSL_DONT_VERIFY_SERVER_CERT;
        }

        // Connect using PDO SSL config.
        $this->connection = new \mysqli();
        $this->connection
          ->ssl_set($ssl_config['key'], $ssl_config['cert'], $ssl_config['ca'], $ssl_config['capath'], $ssl_config['cypher']);
        $this->connection
          ->real_connect($this
          ->confGet('host'), $this
          ->confGet('username'), $this
          ->confGet('password'), $this
          ->confGet('database'), $this
          ->confGet('port'), $this
          ->confGet('socket'), $flags);
      }
      else {
        $this->connection = new \mysqli($this
          ->confGet('host'), $this
          ->confGet('username'), $this
          ->confGet('password'), $this
          ->confGet('database'), $this
          ->confGet('port'), $this
          ->confGet('socket'));
      }

      // Throw an error on fail.
      if ($this->connection->connect_errno || !$this->connection
        ->ping()) {
        throw new BackupMigrateException("Failed to connect to MySQL server.");
      }

      // Ensure, that the character set is utf8mb4.
      if (!$this->connection
        ->set_charset('utf8mb4')) {
        throw new BackupMigrateException('UTF8 is not supported by the MySQL server.');
      }
    }
    return $this->connection;
  }

  /**
   * Get the header for the top of the SQL file.
   *
   * @return string
   */
  protected function _getSQLHeader() {
    $info = $this
      ->_dbInfo();
    $version = $info['version'];
    $host = $this
      ->confGet('host');
    $db = $this
      ->confGet('database');
    $timestamp = gmdate('r');
    $generator = $this
      ->confGet('generator');
    return <<<HEADER
-- Backup and Migrate MySQL Dump
-- http://github.com/backupmigrate
--
-- Generator: {<span class="php-variable">$generator</span>}
-- Host: {<span class="php-variable">$host</span>}
-- Database: {<span class="php-variable">$db</span>}
-- Generation Time: {<span class="php-variable">$timestamp</span>}
-- MySQL Version: {<span class="php-variable">$version</span>}

/*!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 */;

/* @TODO expose these options in config with the ability to turn on and off */

SET AUTOCOMMIT = 0;
SET FOREIGN_KEY_CHECKS=0;
SET SQL_MODE="NO_AUTO_VALUE_ON_ZERO";
SET NAMES utf8mb4;

HEADER;
  }

  /**
   * The footer of the sql dump file.
   */
  protected function _getSQLFooter() {
    return <<<FOOTER


/*!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 */;

/* @TODO expose these options in config with the ability to turn on and off */
SET FOREIGN_KEY_CHECKS = 1;
COMMIT;
SET AUTOCOMMIT = 1;
FOOTER;
  }

  /**
   * Read a multiline sql command from a file.
   *
   * Supports the formatting created by mysqldump, but won't handle multiline comments.
   *
   * @param \BackupMigrate\Core\File\BackupFileReadableInterface $file
   *
   * @return string
   */
  protected function _readSQLCommand(BackupFileReadableInterface $file) {
    $out = '';
    while ($line = $file
      ->readLine()) {
      $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);
  }

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

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

  /**
   * Get a list of tables in the db.
   */
  protected function _getTables() {
    $out = [];

    // get auto_increment values and names of all tables.
    $tables = $this
      ->query("SHOW TABLE STATUS");
    while ($tables && ($table = $tables
      ->fetch_assoc())) {

      // Lowercase the keys for consistency.
      $table = array_change_key_case($table);
      $out[$table['name']] = $table;
    }
    return $out;
  }

  /**
   * Get the sql for the structure of the given table.
   *
   * @param array $table
   *
   * @return string
   */
  protected function _getTableCreateSQL($table) {
    $out = "";

    // If this is a view.
    if (empty($table['engine'])) {

      // Switch SQL mode to for a simpler version of the create view syntax.
      $sql_mode = $this
        ->_fetchValue("SELECT @@SESSION.sql_mode");

      // @TODO: Setting the sql_mode does not seem to work.
      $this
        ->query("SET sql_mode = 'ANSI'");
      $create = $this
        ->_fetchAssoc("SHOW CREATE VIEW `" . $table['name'] . "`");
      if ($create) {

        // Lowercase the keys for consistency.
        $create = array_change_key_case($create);
        $out .= "DROP VIEW IF EXISTS `" . $table['name'] . "`;\n";
        $out .= "SET sql_mode = 'ANSI';\n";
        $out .= strtr($create['create view'], "\n", " ") . ";\n";
        $out .= "SET sql_mode = '{$sql_mode}';\n";
      }

      // Set the SQL_mode back to the original value.
      $this
        ->query("SET SQL_mode = '{$sql_mode}'");
    }
    else {
      $create = $this
        ->_fetchAssoc("SHOW CREATE TABLE `" . $table['name'] . "`");
      if ($create) {

        // Lowercase the keys for consistency.
        $create = array_change_key_case($create);
        $out .= "DROP TABLE IF EXISTS `" . $table['name'] . "`;\n";

        // Remove newlines.
        $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.
   */
  protected function _dumpTableSQLToFile(BackupFileWritableInterface $file, $table) {

    // If this is a view, do not export any data.
    if (empty($table['engine'])) {
      return 0;
    }

    // Otherwise export the table data.
    $rows_per_line = 30;

    // $this->confGet('rows_per_line');//variable_get('backup_migrate_data_rows_per_line', 30);
    $bytes_per_line = 2000;

    // $this->confGet('bytes_per_line'); variable_get('backup_migrate_data_bytes_per_line', 2000);
    $lines = 0;
    $result = $this
      ->query("SELECT * FROM `" . $table['name'] . "`");
    $rows = $bytes = 0;

    // Escape backslashes, PHP code, special chars.
    $search = [
      '\\',
      "'",
      "\0",
      "\n",
      "\r",
      "\32",
    ];
    $replace = [
      '\\\\',
      "''",
      '\\0',
      '\\n',
      '\\r',
      '\\Z',
    ];
    while ($result && ($row = $result
      ->fetch_assoc())) {

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

        // @TODO: escape binary data
      }

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

  /**
   * Run a db query on this destination's db.
   *
   * @param $query
   *
   * @return bool|\mysqli_result
   *
   * @throws \Exception
   */
  protected function query($query) {
    if ($conn = $this
      ->_getConnection()) {
      return $conn
        ->query($query);
    }
    else {
      throw new \Exception('Could not run any queries on the database as a connection could not be established');
    }
  }

  /**
   * Return the first result of the query as an associated array.
   *
   * @param string $query A SQL query.
   *
   * @return array
   *
   * @throws \Exception
   */
  protected function _fetchAssoc($query) {
    $result = $this
      ->query($query);
    if ($result) {
      return $result
        ->fetch_assoc();
    }
    return [];
  }

  /**
   * Return the first field of the first result of a query.
   *
   * @param string $query A SQL query.
   *
   * @return null|object
   *
   * @throws \Exception
   */
  protected function _fetchValue($query) {
    $result = $this
      ->_fetchAssoc($query);
    return reset($result);
  }

  /**
   * Get the version info for the given DB.
   */
  protected function _dbInfo() {
    $conn = $this
      ->_getConnection();
    return [
      'type' => 'mysql',
      'version' => $conn->server_version,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableTrait::$config	protected	property	The object's configuration object.
ConfigurableTrait::$init	protected	property	The initial configuration. These configuration options can be overriden by the config options but will not be overwritten. If the object is re-configured after construction any missing configuration options will revert to these values.
ConfigurableTrait::confGet	public	function	Get a specific value from the configuration.
ConfigurableTrait::config	public	function	Get the configuration object for this item.
ConfigurableTrait::configErrors	public	function	Get any validation errors in the config.
ConfigurableTrait::setConfig	public	function	Set the configuration for all plugins.	1
ConfigurableTrait::__construct	public	function		2
DatabaseSource::configDefaults	public	function	Get the default values for the plugin. Overrides ConfigurableTrait::configDefaults
DatabaseSource::configSchema	public	function	Get a definition for user-configurable settings. Overrides ConfigurableTrait::configSchema
DatabaseSource::getTableNames	public	function	Get a list of tables in this source. Overrides DatabaseSourceInterface::getTableNames
DatabaseSource::getTables	public	function	Get an array of tables with some info. Each entry must have at least a 'name' key containing the table name. Overrides DatabaseSourceInterface::getTables
DatabaseSource::_getTableNames	protected	function	Get the list of tables from this db.
FileProcessorTrait::$tempfilemanager	protected	property
FileProcessorTrait::alterMime	public	function	Provide the file mime for the given file extension if known.
FileProcessorTrait::getTempFileManager	public	function	Get the temp file manager.
FileProcessorTrait::setTempFileManager	public	function	Inject the temp file manager.
MySQLiSource::$connection	protected	property
MySQLiSource::exportToFile	public	function	Export this source to the given temp file. This should be the main back up function for this source. Overrides SourceInterface::exportToFile
MySQLiSource::importFromFile	public	function	Import to this source from the given backup file. This is the main restore function for this source. Overrides SourceInterface::importFromFile	1
MySQLiSource::query	protected	function	Run a db query on this destination's db.
MySQLiSource::supportedOps	public	function	Get a list of supported operations and their weight. Overrides PluginBase::supportedOps
MySQLiSource::_dbInfo	protected	function	Get the version info for the given DB.
MySQLiSource::_dumpTableSQLToFile	protected	function	Get the sql to insert the data for a given table.
MySQLiSource::_fetchAssoc	protected	function	Return the first result of the query as an associated array.
MySQLiSource::_fetchValue	protected	function	Return the first field of the first result of a query.
MySQLiSource::_getConnection	protected	function	Get the db connection for the specified db.
MySQLiSource::_getSQLFooter	protected	function	The footer of the sql dump file.
MySQLiSource::_getSQLHeader	protected	function	Get the header for the top of the SQL file.
MySQLiSource::_getTableCreateSQL	protected	function	Get the sql for the structure of the given table.
MySQLiSource::_getTables	protected	function	Get a list of tables in the db. Overrides DatabaseSource::_getTables
MySQLiSource::_lockTables	protected	function	Lock the list of given tables in the database.
MySQLiSource::_readSQLCommand	protected	function	Read a multiline sql command from a file.
MySQLiSource::_unlockTables	protected	function	Unlock all tables in the database.
PluginBase::opWeight	public	function	What is the weight of the given operation for this plugin. Overrides PluginInterface::opWeight
PluginBase::supportsOp	public	function	Does this plugin implement the given operation. Overrides PluginInterface::supportsOp
PluginCallerTrait::$plugins	protected	property
PluginCallerTrait::plugins	public	function	Get the plugin manager.
PluginCallerTrait::setPluginManager	public	function	Inject the plugin manager.
TranslatableTrait::$translator	protected	property
TranslatableTrait::setTranslator	public	function
TranslatableTrait::t	public	function	Translate the given string if there is a translator service available.

You are here

class MySQLiSource in Backup and Migrate 8.4

Hierarchy

File

Namespace

Members

API Navigation