Connection.php 8.2 KB
Newer Older
1
2
<?php

3
4
namespace Drupal\Database\Driver\mysql;

5
use Drupal\Database\Database;
Crell's avatar
Crell committed
6
use Drupal\Database\DatabaseTransactionCommitFailedException;
7
8
9
use Drupal\Database\Connection as DatabaseConnection;

use PDO;
10
11
12
13
14
15

/**
 * @ingroup database
 * @{
 */

16
class Connection extends DatabaseConnection {
17

18
19
20
21
22
23
24
  /**
   * Flag to indicate if we have registered the nextID cleanup function.
   *
   * @var boolean
   */
  protected $shutdownRegistered = FALSE;

25
  public function __construct(array $connection_options = array()) {
26
27
    // This driver defaults to transaction support, except if explicitly passed FALSE.
    $this->transactionSupport = !isset($connection_options['transactions']) || ($connection_options['transactions'] !== FALSE);
Dries's avatar
Dries committed
28

29
30
    // MySQL never supports transactional DDL.
    $this->transactionalDDLSupport = FALSE;
31

32
33
    $this->connectionOptions = $connection_options;

34
35
36
37
38
39
40
41
42
    // The DSN should use either a socket or a host/port.
    if (isset($connection_options['unix_socket'])) {
      $dsn = 'mysql:unix_socket=' . $connection_options['unix_socket'];
    }
    else {
      // Default to TCP connection on port 3306.
      $dsn = 'mysql:host=' . $connection_options['host'] . ';port=' . (empty($connection_options['port']) ? 3306 : $connection_options['port']);
    }
    $dsn .= ';dbname=' . $connection_options['database'];
43
44
45
46
47
    // Allow PDO options to be overridden.
    $connection_options += array(
      'pdo' => array(),
    );
    $connection_options['pdo'] += array(
48
49
50
51
      // So we don't have to mess around with cursors and unbuffered queries by default.
      PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => TRUE,
      // Because MySQL's prepared statements skip the query cache, because it's dumb.
      PDO::ATTR_EMULATE_PREPARES => TRUE,
52
53
      // Force column names to lower case.
      PDO::ATTR_CASE => PDO::CASE_LOWER,
54
55
56
    );

    parent::__construct($dsn, $connection_options['username'], $connection_options['password'], $connection_options['pdo']);
57

58
59
60
61
62
63
64
65
66
    // Force MySQL to use the UTF-8 character set. Also set the collation, if a
    // certain one has been set; otherwise, MySQL defaults to 'utf8_general_ci'
    // for UTF-8.
    if (!empty($connection_options['collation'])) {
      $this->exec('SET NAMES utf8 COLLATE ' . $connection_options['collation']);
    }
    else {
      $this->exec('SET NAMES utf8');
    }
67

68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
    // Set MySQL init_commands if not already defined.  Default Drupal's MySQL
    // behavior to conform more closely to SQL standards.  This allows Drupal
    // to run almost seamlessly on many different kinds of database systems.
    // These settings force MySQL to behave the same as postgresql, or sqlite
    // in regards to syntax interpretation and invalid data handling.  See
    // http://drupal.org/node/344575 for further discussion. Also, as MySQL 5.5
    // changed the meaning of TRADITIONAL we need to spell out the modes one by
    // one.
    $connection_options += array(
      'init_commands' => array(),
    );
    $connection_options['init_commands'] += array(
      'sql_mode' => "SET sql_mode = 'ANSI,STRICT_TRANS_TABLES,STRICT_ALL_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER'",
    );
    // Set connection options.
    $this->exec(implode('; ', $connection_options['init_commands']));
84
85
  }

86
  public function queryRange($query, $from, $count, array $args = array(), array $options = array()) {
87
    return $this->query($query . ' LIMIT ' . (int) $from . ', ' . (int) $count, $args, $options);
88
89
  }

90
  public function queryTemporary($query, array $args = array(), array $options = array()) {
91
92
93
    $tablename = $this->generateTemporaryTableName();
    $this->query(preg_replace('/^SELECT/i', 'CREATE TEMPORARY TABLE {' . $tablename . '} Engine=MEMORY SELECT', $query), $args, $options);
    return $tablename;
94
95
96
97
98
99
100
101
102
103
104
105
106
107
  }

  public function driver() {
    return 'mysql';
  }

  public function databaseType() {
    return 'mysql';
  }

  public function mapConditionOperator($operator) {
    // We don't want to override any of the defaults.
    return NULL;
  }
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

  public function nextId($existing_id = 0) {
    $new_id = $this->query('INSERT INTO {sequences} () VALUES ()', array(), array('return' => Database::RETURN_INSERT_ID));
    // This should only happen after an import or similar event.
    if ($existing_id >= $new_id) {
      // If we INSERT a value manually into the sequences table, on the next
      // INSERT, MySQL will generate a larger value. However, there is no way
      // of knowing whether this value already exists in the table. MySQL
      // provides an INSERT IGNORE which would work, but that can mask problems
      // other than duplicate keys. Instead, we use INSERT ... ON DUPLICATE KEY
      // UPDATE in such a way that the UPDATE does not do anything. This way,
      // duplicate keys do not generate errors but everything else does.
      $this->query('INSERT INTO {sequences} (value) VALUES (:value) ON DUPLICATE KEY UPDATE value = value', array(':value' => $existing_id));
      $new_id = $this->query('INSERT INTO {sequences} () VALUES ()', array(), array('return' => Database::RETURN_INSERT_ID));
    }
123
    if (!$this->shutdownRegistered) {
124
125
126
      // Use register_shutdown_function() here to keep the database system
      // independent of Drupal.
      register_shutdown_function(array($this, 'nextIdDelete'));
127
      $shutdownRegistered = TRUE;
128
129
130
131
    }
    return $new_id;
  }

132
  public function nextIdDelete() {
133
134
135
136
137
138
139
140
    // While we want to clean up the table to keep it up from occupying too
    // much storage and memory, we must keep the highest value in the table
    // because InnoDB  uses an in-memory auto-increment counter as long as the
    // server runs. When the server is stopped and restarted, InnoDB
    // reinitializes the counter for each table for the first INSERT to the
    // table based solely on values from the table so deleting all values would
    // be a problem in this case. Also, TRUNCATE resets the auto increment
    // counter.
141
142
143
144
145
146
147
148
149
150
151
152
153
    try {
      $max_id = $this->query('SELECT MAX(value) FROM {sequences}')->fetchField();
      // We know we are using MySQL here, no need for the slower db_delete().
      $this->query('DELETE FROM {sequences} WHERE value < :value', array(':value' => $max_id));
    }
    // During testing, this function is called from shutdown with the
    // simpletest prefix stored in $this->connection, and those tables are gone
    // by the time shutdown is called so we need to ignore the database
    // errors. There is no problem with completely ignoring errors here: if
    // these queries fail, the sequence will work just fine, just use a bit
    // more database storage and memory.
    catch (PDOException $e) {
    }
154
  }
155
156
157
158

  /**
   * Overridden to work around issues to MySQL not supporting transactional DDL.
   */
159
160
161
162
163
164
  protected function popCommittableTransactions() {
    // Commit all the committable layers.
    foreach (array_reverse($this->transactionLayers) as $name => $active) {
      // Stop once we found an active transaction.
      if ($active) {
        break;
165
166
167
      }

      // If there are no more layers left then we should commit.
168
      unset($this->transactionLayers[$name]);
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
      if (empty($this->transactionLayers)) {
        if (!PDO::commit()) {
          throw new DatabaseTransactionCommitFailedException();
        }
      }
      else {
        // Attempt to release this savepoint in the standard way.
        try {
          $this->query('RELEASE SAVEPOINT ' . $name);
        }
        catch (PDOException $e) {
          // However, in MySQL (InnoDB), savepoints are automatically committed
          // when tables are altered or created (DDL transactions are not
          // supported). This can cause exceptions due to trying to release
          // savepoints which no longer exist.
          //
          // To avoid exceptions when no actual error has occurred, we silently
186
187
          // succeed for MySQL error code 1305 ("SAVEPOINT does not exist").
          if ($e->errorInfo[1] == '1305') {
188
189
            // If one SAVEPOINT was released automatically, then all were.
            // Therefore, we keep just the topmost transaction.
190
            $this->transactionLayers = array('drupal_transaction' => 'drupal_transaction');
191
192
          }
          else {
193
194
195
196
197
198
            throw $e;
          }
        }
      }
    }
  }
199
200
201
202
203
204
}


/**
 * @} End of "ingroup database".
 */