diff --git a/core/lib/Drupal/Core/Cache/DatabaseBackend.php b/core/lib/Drupal/Core/Cache/DatabaseBackend.php index 1e24968..6c181b8 100644 --- a/core/lib/Drupal/Core/Cache/DatabaseBackend.php +++ b/core/lib/Drupal/Core/Cache/DatabaseBackend.php @@ -9,7 +9,7 @@ use Drupal\Component\Utility\Crypt; use Drupal\Core\Database\Connection; -use Drupal\Core\Database\SchemaObjectExistsException; +use Drupal\Core\Database\SchemaProviderInterface; /** * Defines a default cache implementation. @@ -19,7 +19,7 @@ * * @ingroup cache */ -class DatabaseBackend implements CacheBackendInterface { +class DatabaseBackend implements CacheBackendInterface, SchemaProviderInterface { /** * @var string @@ -74,13 +74,7 @@ public function getMultiple(&$cids, $allow_invalid = FALSE) { // is used here only due to the performance overhead we would incur // otherwise. When serving an uncached page, the overhead of using // ::select() is a much smaller proportion of the request. - $result = array(); - try { - $result = $this->connection->query('SELECT cid, data, created, expire, serialized, tags, checksum_invalidations, checksum_deletions FROM {' . $this->connection->escapeTable($this->bin) . '} WHERE cid IN (:cids)', array(':cids' => array_keys($cid_mapping))); - } - catch (\Exception $e) { - // Nothing to do. - } + $result = $this->connection->query('SELECT cid, data, created, expire, serialized, tags, checksum_invalidations, checksum_deletions FROM {' . $this->connection->escapeTable($this->bin) . '} WHERE cid IN (:cids)', array(':cids' => array_keys($cid_mapping))); $cache = array(); foreach ($result as $item) { // Map the cache ID back to the original. @@ -151,29 +145,6 @@ public function set($cid, $data, $expire = Cache::PERMANENT, array $tags = array $tags = array_unique($tags); // Sort the cache tags so that they are stored consistently in the database. sort($tags); - $try_again = FALSE; - try { - // The bin might not yet exist. - $this->doSet($cid, $data, $expire, $tags); - } - catch (\Exception $e) { - // If there was an exception, try to create the bins. - if (!$try_again = $this->ensureBinExists()) { - // If the exception happened for other reason than the missing bin - // table, propagate the exception. - throw $e; - } - } - // Now that the bin has been created, try again if necessary. - if ($try_again) { - $this->doSet($cid, $data, $expire, $tags); - } - } - - /** - * Actually set the cache. - */ - protected function doSet($cid, $data, $expire, $tags) { $deleted_tags = &drupal_static('Drupal\Core\Cache\DatabaseBackend::deletedTags', array()); $invalidated_tags = &drupal_static('Drupal\Core\Cache\DatabaseBackend::invalidatedTags', array()); // Remove tags that were already deleted or invalidated during this request @@ -298,21 +269,11 @@ public function delete($cid) { */ public function deleteMultiple(array $cids) { $cids = array_values(array_map(array($this, 'normalizeCid'), $cids)); - try { - // Delete in chunks when a large array is passed. - foreach (array_chunk($cids, 1000) as $cids_chunk) { - $this->connection->delete($this->bin) - ->condition('cid', $cids_chunk, 'IN') - ->execute(); - } - } - catch (\Exception $e) { - // Create the cache table, which will be empty. This fixes cases during - // core install where a cache table is cleared before it is set - // with {cache_render} and {cache_data}. - if (!$this->ensureBinExists()) { - $this->catchException($e); - } + // Delete in chunks when a large array is passed. + foreach (array_chunk($cids, 1000) as $cids_chunk) { + $this->connection->delete($this->bin) + ->condition('cid', $cids_chunk, 'IN') + ->execute(); } } @@ -329,16 +290,11 @@ public function deleteTags(array $tags) { } $deleted_tags[$tag] = TRUE; unset($tag_cache[$tag]); - try { - $this->connection->merge('cachetags') - ->insertFields(array('deletions' => 1)) - ->expression('deletions', 'deletions + 1') - ->key('tag', $tag) - ->execute(); - } - catch (\Exception $e) { - $this->catchException($e, 'cachetags'); - } + $this->connection->merge('cachetags') + ->insertFields(array('deletions' => 1)) + ->expression('deletions', 'deletions + 1') + ->key('tag', $tag) + ->execute(); } } @@ -346,17 +302,7 @@ public function deleteTags(array $tags) { * Implements Drupal\Core\Cache\CacheBackendInterface::deleteAll(). */ public function deleteAll() { - try { - $this->connection->truncate($this->bin)->execute(); - } - catch (\Exception $e) { - // Create the cache table, which will be empty. This fixes cases during - // core install where a cache table is cleared before it is set - // with {cache_render} and {cache_data}. - if (!$this->ensureBinExists()) { - $this->catchException($e); - } - } + $this->connection->truncate($this->bin)->execute(); } /** @@ -371,17 +317,12 @@ public function invalidate($cid) { */ public function invalidateMultiple(array $cids) { $cids = array_values(array_map(array($this, 'normalizeCid'), $cids)); - try { - // Update in chunks when a large array is passed. - foreach (array_chunk($cids, 1000) as $cids_chunk) { - $this->connection->update($this->bin) - ->fields(array('expire' => REQUEST_TIME - 1)) - ->condition('cid', $cids_chunk, 'IN') - ->execute(); - } - } - catch (\Exception $e) { - $this->catchException($e); + // Update in chunks when a large array is passed. + foreach (array_chunk($cids, 1000) as $cids_chunk) { + $this->connection->update($this->bin) + ->fields(array('expire' => REQUEST_TIME - 1)) + ->condition('cid', $cids_chunk, 'IN') + ->execute(); } } @@ -389,25 +330,20 @@ public function invalidateMultiple(array $cids) { * Implements Drupal\Core\Cache\CacheBackendInterface::invalidateTags(). */ public function invalidateTags(array $tags) { - try { - $tag_cache = &drupal_static('Drupal\Core\Cache\CacheBackendInterface::tagCache', array()); - $invalidated_tags = &drupal_static('Drupal\Core\Cache\DatabaseBackend::invalidatedTags', array()); - foreach ($tags as $tag) { - // Only invalidate tags once per request unless they are written again. - if (isset($invalidated_tags[$tag])) { - continue; - } - $invalidated_tags[$tag] = TRUE; - unset($tag_cache[$tag]); - $this->connection->merge('cachetags') - ->insertFields(array('invalidations' => 1)) - ->expression('invalidations', 'invalidations + 1') - ->key('tag', $tag) - ->execute(); + $tag_cache = &drupal_static('Drupal\Core\Cache\CacheBackendInterface::tagCache', array()); + $invalidated_tags = &drupal_static('Drupal\Core\Cache\DatabaseBackend::invalidatedTags', array()); + foreach ($tags as $tag) { + // Only invalidate tags once per request unless they are written again. + if (isset($invalidated_tags[$tag])) { + continue; } - } - catch (\Exception $e) { - $this->catchException($e, 'cachetags'); + $invalidated_tags[$tag] = TRUE; + unset($tag_cache[$tag]); + $this->connection->merge('cachetags') + ->insertFields(array('invalidations' => 1)) + ->expression('invalidations', 'invalidations + 1') + ->key('tag', $tag) + ->execute(); } } @@ -415,14 +351,9 @@ public function invalidateTags(array $tags) { * Implements Drupal\Core\Cache\CacheBackendInterface::invalidateAll(). */ public function invalidateAll() { - try { - $this->connection->update($this->bin) - ->fields(array('expire' => REQUEST_TIME - 1)) - ->execute(); - } - catch (\Exception $e) { - $this->catchException($e); - } + $this->connection->update($this->bin) + ->fields(array('expire' => REQUEST_TIME - 1)) + ->execute(); } /** @@ -484,51 +415,10 @@ public function removeBin() { $this->connection->schema()->dropTable($this->bin); } catch (\Exception $e) { - $this->catchException($e); - } - } - - /** - * Check if the cache bin exists and create it if not. - */ - protected function ensureBinExists() { - try { - $database_schema = $this->connection->schema(); - if (!$database_schema->tableExists($this->bin)) { - $schema_definition = $this->schemaDefinition(); - $database_schema->createTable($this->bin, $schema_definition['bin']); - // If the bin doesn't exist, the cache tags table may also not exist. - if (!$database_schema->tableExists('cachetags')) { - $database_schema->createTable('cachetags', $schema_definition['cachetags']); - } - return TRUE; + if ($this->connection->schema()->tableExists($this->bin)) { + throw $e; } } - // If another process has already created the cache table, attempting to - // recreate it will throw an exception. In this case just catch the - // exception and do nothing. - catch (SchemaObjectExistsException $e) { - return TRUE; - } - return FALSE; - } - - /** - * Act on an exception when cache might be stale. - * - * If the {cachetags} table does not yet exist, that's fine but if the table - * exists and yet the query failed, then the cache is stale and the - * exception needs to propagate. - * - * @param $e - * The exception. - * @param string|null $table_name - * The table name, defaults to $this->bin. Can be cachetags. - */ - protected function catchException(\Exception $e, $table_name = NULL) { - if ($this->connection->schema()->tableExists($table_name ?: $this->bin)) { - throw $e; - } } /** @@ -554,8 +444,8 @@ protected function normalizeCid($cid) { /** * Defines the schema for the {cache_*} bin and {cachetags} tables. */ - public function schemaDefinition() { - $schema['bin'] = array( + public function getSchema($table_name = '') { + $schema[$this->bin] = array( 'description' => 'Storage for the cache API.', 'fields' => array( 'cid' => array( @@ -641,6 +531,7 @@ public function schemaDefinition() { ), 'primary key' => array('tag'), ); - return $schema; + return isset($schema[$table_name]) ? $schema[$table_name] : NULL; } + } diff --git a/core/lib/Drupal/Core/Config/DatabaseStorage.php b/core/lib/Drupal/Core/Config/DatabaseStorage.php index 471590a..5de5d8e 100644 --- a/core/lib/Drupal/Core/Config/DatabaseStorage.php +++ b/core/lib/Drupal/Core/Config/DatabaseStorage.php @@ -9,13 +9,14 @@ use Drupal\Core\Database\Database; use Drupal\Core\Database\Connection; -use Drupal\Core\Database\SchemaObjectExistsException; +use Drupal\Core\Database\SchemaProviderInterface; use Drupal\Core\DependencyInjection\DependencySerializationTrait; /** * Defines the Database storage. */ -class DatabaseStorage implements StorageInterface { +class DatabaseStorage implements StorageInterface, SchemaProviderInterface { + use DependencySerializationTrait; /** @@ -70,11 +71,14 @@ public function __construct(Connection $connection, $table, array $options = arr * Implements Drupal\Core\Config\StorageInterface::exists(). */ public function exists($name) { + $options = array( + 'create_missing_table' => FALSE, + ) + $this->options; try { return (bool) $this->connection->queryRange('SELECT 1 FROM {' . $this->connection->escapeTable($this->table) . '} WHERE collection = :collection AND name = :name', 0, 1, array( ':collection' => $this->collection, ':name' => $name, - ), $this->options)->fetchField(); + ), $options)->fetchField(); } catch (\Exception $e) { // If we attempt a read without actually having the database or the table @@ -87,36 +91,16 @@ public function exists($name) { * {@inheritdoc} */ public function read($name) { - $data = FALSE; - try { - $raw = $this->connection->query('SELECT data FROM {' . $this->connection->escapeTable($this->table) . '} WHERE collection = :collection AND name = :name', array(':collection' => $this->collection, ':name' => $name), $this->options)->fetchField(); - if ($raw !== FALSE) { - $data = $this->decode($raw); - } - } - catch (\Exception $e) { - // If we attempt a read without actually having the database or the table - // available, just return FALSE so the caller can handle it. - } - return $data; + $raw = $this->connection->query('SELECT data FROM {' . $this->connection->escapeTable($this->table) . '} WHERE collection = :collection AND name = :name', array(':collection' => $this->collection, ':name' => $name), $this->options)->fetchField(); + return $raw !== FALSE ? $this->decode($raw) : FALSE; } /** * {@inheritdoc} */ public function readMultiple(array $names) { - $list = array(); - try { - $list = $this->connection->query('SELECT name, data FROM {' . $this->connection->escapeTable($this->table) . '} WHERE collection = :collection AND name IN (:names)', array(':collection' => $this->collection, ':names' => $names), $this->options)->fetchAllKeyed(); - foreach ($list as &$data) { - $data = $this->decode($data); - } - } - catch (\Exception $e) { - // If we attempt a read without actually having the database or the table - // available, just return an empty array so the caller can handle it. - } - return $list; + $list = $this->connection->query('SELECT name, data FROM {' . $this->connection->escapeTable($this->table) . '} WHERE collection = :collection AND name IN (:names)', array(':collection' => $this->collection, ':names' => $names), $this->options)->fetchAllKeyed(); + return array_map([$this, 'decode'], $list); } /** @@ -124,30 +108,6 @@ public function readMultiple(array $names) { */ public function write($name, array $data) { $data = $this->encode($data); - try { - return $this->doWrite($name, $data); - } - catch (\Exception $e) { - // If there was an exception, try to create the table. - if ($this->ensureTableExists()) { - return $this->doWrite($name, $data); - } - // Some other failure that we can not recover from. - throw $e; - } - } - - /** - * Helper method so we can re-try a write. - * - * @param string $name - * The config name. - * @param string $data - * The config data, already dumped to a string. - * - * @return bool - */ - protected function doWrite($name, $data) { $options = array('return' => Database::RETURN_AFFECTED) + $this->options; return (bool) $this->connection->merge($this->table, $options) ->keys(array('collection', 'name'), array($this->collection, $name)) @@ -156,37 +116,9 @@ protected function doWrite($name, $data) { } /** - * Check if the config table exists and create it if not. - * - * @return bool - * TRUE if the table was created, FALSE otherwise. - * - * @throws \Drupal\Core\Config\StorageException - * If a database error occurs. - */ - protected function ensureTableExists() { - try { - if (!$this->connection->schema()->tableExists($this->table)) { - $this->connection->schema()->createTable($this->table, static::schemaDefinition()); - return TRUE; - } - } - // If another process has already created the config table, attempting to - // recreate it will throw an exception. In this case just catch the - // exception and do nothing. - catch (SchemaObjectExistsException $e) { - return TRUE; - } - catch (\Exception $e) { - throw new StorageException($e->getMessage(), NULL, $e); - } - return FALSE; - } - - /** * Defines the schema for the configuration table. */ - protected static function schemaDefinition() { + public function getSchema($table_name = '') { $schema = array( 'description' => 'The base table for configuration data.', 'fields' => array( @@ -224,7 +156,10 @@ protected static function schemaDefinition() { * @todo Ignore replica targets for data manipulation operations. */ public function delete($name) { - $options = array('return' => Database::RETURN_AFFECTED) + $this->options; + $options = array( + 'return' => Database::RETURN_AFFECTED, + 'create_missing_table' => FALSE, + ) + $this->options; return (bool) $this->connection->delete($this->table, $options) ->condition('collection', $this->collection) ->condition('name', $name) @@ -285,7 +220,10 @@ public function listAll($prefix = '') { */ public function deleteAll($prefix = '') { try { - $options = array('return' => Database::RETURN_AFFECTED) + $this->options; + $options = array( + 'return' => Database::RETURN_AFFECTED, + 'create_missing_table' => FALSE, + ) + $this->options; return (bool) $this->connection->delete($this->table, $options) ->condition('name', $prefix . '%', 'LIKE') ->condition('collection', $this->collection) diff --git a/core/lib/Drupal/Core/Database/Connection.php b/core/lib/Drupal/Core/Database/Connection.php index e0c1714..b35e0e1 100644 --- a/core/lib/Drupal/Core/Database/Connection.php +++ b/core/lib/Drupal/Core/Database/Connection.php @@ -218,6 +218,12 @@ public function destroy() { * - Database::RETURN_NULL: Do not return anything, as there is no * meaningful value to return. That is the case for INSERT queries on * tables that do not contain a serial column. + * - create_missing_table: When a string, it is a table name. If the query + * fails with a table missing error then this table is created and if + * the creation succeeded then the query is re-run. When TRUE and + * return is set to Database::RETURN_STATEMENT and the query is failing + * with a table missing error then an empty statement is returned. Defaults + * to TRUE. * - throw_exception: By default, the database system will catch any errors * on a query as an Exception, log it, and then rethrow it so that code * further up the call chain can take an appropriate action. To suppress @@ -232,6 +238,7 @@ protected function defaultOptions() { 'target' => 'default', 'fetch' => \PDO::FETCH_OBJ, 'return' => Database::RETURN_STATEMENT, + 'create_missing_table' => TRUE, 'throw_exception' => TRUE, ); } @@ -555,6 +562,31 @@ public function query($query, array $args = array(), $options = array()) { } } catch (\PDOException $e) { + if ($this->isTableMissingException($e) && !empty($options['create_missing_table'])) { + if ($options['return'] == Database::RETURN_STATEMENT) { + // This is a SELECT on a missing table. Creating the table and + // re-runing the query will result in an empty result so return that + // early instead. + return new StatementEmpty(); + } + if (is_string($options['create_missing_table'])) { + $table = $options['create_missing_table']; + foreach (debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT) as $bt) { + if (isset($bt['object']) && $bt['object'] instanceof SchemaProviderInterface && ($schema = $bt['object']->getSchema($table))) { + if ($this->schema()->ensureTableExists($table, $schema)) { + // Theoretically the table must exist at this point so this + // should not matter but still, databases. This makes sure + // no infinite recursion happens. + $options['create_missing_table'] = FALSE; + return $this->query($query, $args, $options); + } + } + } + } + elseif ($options['create_missing_table'] === TRUE) { + return NULL; + } + } if ($options['throw_exception']) { // Wrap the exception in another exception, because PHP does not allow // overriding Exception::getMessage(). Its message is the extra database @@ -1270,4 +1302,16 @@ public function unserialize($serialized) { } } + /** + * Determines whether an exception means missing table. + * + * @param \Exception $e + * The exception being investigated. Use + * \Drupal\Core\Database\Database::getSqlState($e) instead of + * $e->getCode() to get the SQLSTATE. + * + * @return bool + * TRUE if this exception means table missing, FALSE otherwise. + */ + abstract public function isTableMissingException(\Exception $e); } diff --git a/core/lib/Drupal/Core/Database/Database.php b/core/lib/Drupal/Core/Database/Database.php index a799926..a5d104d 100644 --- a/core/lib/Drupal/Core/Database/Database.php +++ b/core/lib/Drupal/Core/Database/Database.php @@ -443,4 +443,26 @@ public static function closeConnection($target = NULL, $key = NULL) { public static function ignoreTarget($key, $target) { self::$ignoreTargets[$key][$target] = TRUE; } + + + /** + * Extracts the SQLSTATE error from the PDOException. + * + * @param \Exception $e + * The exception + * + * @return string + * The five character error code. + */ + public static function getSQLState(\Exception $e) { + // The PDOException code is not always reliable, try to see whether the + // message has something usable. + if (!$e->getCode() && preg_match('/^SQLSTATE\[(\w{5})\]/', $e->getMessage(), $matches)) { + return $matches[1]; + } + else { + return $e->getCode(); + } + } + } diff --git a/core/lib/Drupal/Core/Database/Driver/fake/FakeConnection.php b/core/lib/Drupal/Core/Database/Driver/fake/FakeConnection.php index 1be5147..f50cd38 100644 --- a/core/lib/Drupal/Core/Database/Driver/fake/FakeConnection.php +++ b/core/lib/Drupal/Core/Database/Driver/fake/FakeConnection.php @@ -164,4 +164,10 @@ public function nextId($existing_id = 0) { throw new \Exception('Method not supported'); } + /** + * {@inheritdoc} + */ + public function isTableMissingException(\Exception $e) { + } + } diff --git a/core/lib/Drupal/Core/Database/Driver/mysql/Connection.php b/core/lib/Drupal/Core/Database/Driver/mysql/Connection.php index 66cd34f..3e4a6e1 100644 --- a/core/lib/Drupal/Core/Database/Driver/mysql/Connection.php +++ b/core/lib/Drupal/Core/Database/Driver/mysql/Connection.php @@ -267,6 +267,16 @@ protected function popCommittableTransactions() { } } } + + /** + * {@inheritdoc} + */ + public function isTableMissingException(\Exception $e) { + // "42S02" is the MySQL error code for "Unknown table". + // @see http://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html + return Database::getSQLState($e) === '42S02'; + } + } diff --git a/core/lib/Drupal/Core/Database/Driver/mysql/Schema.php b/core/lib/Drupal/Core/Database/Driver/mysql/Schema.php index 9ff22e1..cf9c0f7 100644 --- a/core/lib/Drupal/Core/Database/Driver/mysql/Schema.php +++ b/core/lib/Drupal/Core/Database/Driver/mysql/Schema.php @@ -513,7 +513,8 @@ public function tableExists($table) { // @todo This override should be removed once we require a version of MySQL // that has that bug fixed. try { - $this->connection->queryRange("SELECT 1 FROM {" . $table . "}", 0, 1); + $options['create_missing_table'] = FALSE; + $this->connection->queryRange("SELECT 1 FROM {" . $table . "}", 0, 1, [], $options); return TRUE; } catch (\Exception $e) { diff --git a/core/lib/Drupal/Core/Database/Driver/pgsql/Connection.php b/core/lib/Drupal/Core/Database/Driver/pgsql/Connection.php index 98b7a6b..7a92ee1 100644 --- a/core/lib/Drupal/Core/Database/Driver/pgsql/Connection.php +++ b/core/lib/Drupal/Core/Database/Driver/pgsql/Connection.php @@ -323,6 +323,16 @@ public function rollbackSavepoint($savepoint_name = 'mimic_implicit_commit') { $this->rollback($savepoint_name); } } + + /** + * {@inheritdoc} + */ + public function isTableMissingException(\Exception $e) { + // "42P01" is the PostgreSQL error code for "undefined_table". + // @see http://www.postgresql.org/docs/9.3/static/errcodes-appendix.html + return Database::getSQLState($e) === '42P01'; + } + } /** diff --git a/core/lib/Drupal/Core/Database/Driver/sqlite/Connection.php b/core/lib/Drupal/Core/Database/Driver/sqlite/Connection.php index bca72c4..0209687 100644 --- a/core/lib/Drupal/Core/Database/Driver/sqlite/Connection.php +++ b/core/lib/Drupal/Core/Database/Driver/sqlite/Connection.php @@ -408,4 +408,11 @@ public function popTransaction($name) { } } + /** + * {@inheritdoc} + */ + public function isTableMissingException(\Exception $e) { + return preg_match('/^SQLSTATE\[HY000\]: General error: 1 no such table/', $e->getMessage()); + } + } diff --git a/core/lib/Drupal/Core/Database/Query/Delete.php b/core/lib/Drupal/Core/Database/Query/Delete.php index 33727a7..920e70b 100644 --- a/core/lib/Drupal/Core/Database/Query/Delete.php +++ b/core/lib/Drupal/Core/Database/Query/Delete.php @@ -139,7 +139,6 @@ public function execute() { $this->condition->compile($this->connection, $this); $values = $this->condition->arguments(); } - return $this->connection->query((string) $this, $values, $this->queryOptions); } diff --git a/core/lib/Drupal/Core/Database/Query/Insert.php b/core/lib/Drupal/Core/Database/Query/Insert.php index 392c8c2..62415b4 100644 --- a/core/lib/Drupal/Core/Database/Query/Insert.php +++ b/core/lib/Drupal/Core/Database/Query/Insert.php @@ -72,9 +72,10 @@ class Insert extends Query { * Array of database options. */ public function __construct($connection, $table, array $options = array()) { - if (!isset($options['return'])) { - $options['return'] = Database::RETURN_INSERT_ID; - } + $options += array( + 'return' => Database::RETURN_INSERT_ID, + 'create_missing_table' => $table, + ); parent::__construct($connection, $options); $this->table = $table; } diff --git a/core/lib/Drupal/Core/Database/Query/Merge.php b/core/lib/Drupal/Core/Database/Query/Merge.php index be71de3..cbff7aa 100644 --- a/core/lib/Drupal/Core/Database/Query/Merge.php +++ b/core/lib/Drupal/Core/Database/Query/Merge.php @@ -135,6 +135,9 @@ class Merge extends Query implements ConditionInterface { */ public function __construct(Connection $connection, $table, array $options = array()) { $options['return'] = Database::RETURN_AFFECTED; + if (!isset($options['create_missing_table'])) { + $options['create_missing_table'] = $table; + } parent::__construct($connection, $options); $this->table = $table; $this->conditionTable = $table; diff --git a/core/lib/Drupal/Core/Database/Query/Select.php b/core/lib/Drupal/Core/Database/Query/Select.php index 3c687da..e7ec5a8 100644 --- a/core/lib/Drupal/Core/Database/Query/Select.php +++ b/core/lib/Drupal/Core/Database/Query/Select.php @@ -682,6 +682,9 @@ public function rightJoin($table, $alias = NULL, $condition = NULL, $arguments = * {@inheritdoc} */ public function addJoin($type, $table, $alias = NULL, $condition = NULL, $arguments = array()) { + if (isset($type)) { + $this->queryOptions['create_missing_table'] = FALSE; + } if (empty($alias)) { if ($table instanceof SelectInterface) { $alias = 'subquery'; diff --git a/core/lib/Drupal/Core/Database/Query/Truncate.php b/core/lib/Drupal/Core/Database/Query/Truncate.php index 857e199..f160c78 100644 --- a/core/lib/Drupal/Core/Database/Query/Truncate.php +++ b/core/lib/Drupal/Core/Database/Query/Truncate.php @@ -60,7 +60,16 @@ public function compiled() { * Return value is dependent on the database type. */ public function execute() { - return $this->connection->query((string) $this, array(), $this->queryOptions); + try { + return $this->connection->query((string) $this, array(), $this->queryOptions); + } + catch (\Exception $e) { + if ($this->connection->isTableMissingException($e)) { + // The table is quite empty. It doesn't even exist but that's fine. + return 0; + } + throw $e; + } } /** diff --git a/core/lib/Drupal/Core/Database/Schema.php b/core/lib/Drupal/Core/Database/Schema.php index b588756..2fedd97 100644 --- a/core/lib/Drupal/Core/Database/Schema.php +++ b/core/lib/Drupal/Core/Database/Schema.php @@ -7,7 +7,6 @@ namespace Drupal\Core\Database; -use Drupal\Core\Database\SchemaObjectExistsException; use Drupal\Core\Database\Query\Condition; use Drupal\Core\Database\Query\PlaceholderInterface; @@ -684,6 +683,34 @@ public function createTable($name, $table) { } /** + * Checks a table for existence and creates it as necessary. + * + * @param $table_name + * The name of the table to check and create. + * @param array $schema + * A Schema API table definition array. + * + * @return bool + * TRUE if the table already existed or now exists, FALSE if there was an + * error and it does not. + */ + public function ensureTableExists($table_name, array $schema) { + try { + if (!$this->tableExists($table_name)) { + $this->createTable($table_name, $schema); + } + return TRUE; + } + catch (SchemaObjectExistsException $e) { + // If another process has already created the table, attempting to + // recreate it will throw an exception. In this case just catch the + // exception and do nothing. + return TRUE; + } + return FALSE; + } + + /** * Return an array of field names from an array of key/index column specifiers. * * This is usually an identity function but if a key/index uses a column prefix diff --git a/core/lib/Drupal/Core/Database/SchemaProviderInterface.php b/core/lib/Drupal/Core/Database/SchemaProviderInterface.php new file mode 100644 index 0000000..fe1231c --- /dev/null +++ b/core/lib/Drupal/Core/Database/SchemaProviderInterface.php @@ -0,0 +1,33 @@ +execute(); - } - catch (\Exception $e) { - // If there was an exception, try to create the table. - if ($this->ensureTableExists()) { - return $query->execute(); - } - // Some other failure that we can not recover from. - throw $e; - } - } - - /** * {@inheritdoc} */ public function save(array $link) { @@ -337,7 +309,7 @@ protected function doSave(array $link) { protected function preSave(array &$link, array $original) { static $schema_fields, $schema_defaults; if (empty($schema_fields)) { - $schema = static::schemaDefinition(); + $schema = $this->getSchema(); $schema_fields = $schema['fields']; foreach ($schema_fields as $name => $spec) { if (isset($spec['default'])) { @@ -470,7 +442,7 @@ protected function doFindChildrenRelativeDepth(array $original) { $query->condition("p$i", $original["p$i"]); } - $max_depth = $this->safeExecuteSelect($query)->fetchField(); + $max_depth = $query->execute()->fetchField(); return ($max_depth > $original['depth']) ? $max_depth - $original['depth'] : 0; } @@ -646,7 +618,7 @@ public function loadByProperties(array $properties) { } $query->condition($name, $value); } - $loaded = $this->safeExecuteSelect($query)->fetchAllAssoc('id', \PDO::FETCH_ASSOC); + $loaded = $query->execute()->fetchAllAssoc('id', \PDO::FETCH_ASSOC); foreach ($loaded as $id => $link) { $loaded[$id] = $this->prepareLink($link); } @@ -675,7 +647,7 @@ public function loadByRoute($route_name, array $route_parameters = array(), $men $query->orderBy('depth'); $query->orderBy('weight'); $query->orderBy('id'); - $loaded = $this->safeExecuteSelect($query)->fetchAllAssoc('id', \PDO::FETCH_ASSOC); + $loaded = $query->execute()->fetchAllAssoc('id', \PDO::FETCH_ASSOC); foreach ($loaded as $id => $link) { $loaded[$id] = $this->prepareLink($link); } @@ -692,7 +664,7 @@ public function loadMultiple(array $ids) { $query = $this->connection->select($this->table, $this->options); $query->fields($this->table, $this->definitionFields()); $query->condition('id', $missing_ids, 'IN'); - $loaded = $this->safeExecuteSelect($query)->fetchAllAssoc('id', \PDO::FETCH_ASSOC); + $loaded = $query->execute()->fetchAllAssoc('id', \PDO::FETCH_ASSOC); foreach ($loaded as $id => $link) { $this->definitions[$id] = $this->prepareLink($link); } @@ -738,7 +710,7 @@ protected function loadFullMultiple(array $ids) { $query = $this->connection->select($this->table, $this->options); $query->fields($this->table); $query->condition('id', $ids, 'IN'); - $loaded = $this->safeExecuteSelect($query)->fetchAllAssoc('id', \PDO::FETCH_ASSOC); + $loaded = $query->execute()->fetchAllAssoc('id', \PDO::FETCH_ASSOC); foreach ($loaded as &$link) { foreach ($this->serializedFields() as $name) { $link[$name] = unserialize($link[$name]); @@ -766,7 +738,7 @@ public function getRootPathIds($id) { $query->condition('mlid', $ids, 'IN'); // @todo Cache this result in memory if we find it is being used more // than once per page load. https://www.drupal.org/node/2302185 - return $this->safeExecuteSelect($query)->fetchAllKeyed(0, 0); + return $query->execute()->fetchAllKeyed(0, 0); } return array(); } @@ -786,7 +758,7 @@ public function getExpanded($menu_name, array $parents) { $query->condition('enabled', 1); $query->condition('parent', $parents, 'IN'); $query->condition('id', $parents, 'NOT IN'); - $result = $this->safeExecuteSelect($query)->fetchAllKeyed(0, 0); + $result = $query->execute()->fetchAllKeyed(0, 0); $parents += $result; } while (!empty($result)); return $parents; @@ -944,7 +916,7 @@ protected function loadLinks($menu_name, MenuTreeParameters $parameters) { } } - $links = $this->safeExecuteSelect($query)->fetchAllAssoc('id', \PDO::FETCH_ASSOC); + $links = $query->execute()->fetchAllAssoc('id', \PDO::FETCH_ASSOC); return $links; } @@ -1011,7 +983,7 @@ public function menuNameInUse($menu_name) { $query->addField($this->table, 'mlid'); $query->condition('menu_name', $menu_name); $query->range(0, 1); - return (bool) $this->safeExecuteSelect($query); + return (bool) $query->execute(); } /** @@ -1021,7 +993,7 @@ public function getMenuNames() { $query = $this->connection->select($this->table, $this->options); $query->addField($this->table, 'menu_name'); $query->distinct(); - return $this->safeExecuteSelect($query)->fetchAllKeyed(0, 0); + return $query->execute()->fetchAllKeyed(0, 0); } /** @@ -1032,7 +1004,7 @@ public function countMenuLinks($menu_name = NULL) { if ($menu_name) { $query->condition('menu_name', $menu_name); } - return $this->safeExecuteSelect($query->countQuery())->fetchField(); + return $query->countQuery()->execute()->fetchField(); } /** @@ -1051,7 +1023,7 @@ public function getAllChildIds($id) { } // The next p column should not be empty. This excludes the root link. $query->condition("p$i", 0, '>'); - return $this->safeExecuteSelect($query)->fetchAllKeyed(0, 0); + return $query->execute()->fetchAllKeyed(0, 0); } /** @@ -1131,34 +1103,6 @@ protected function treeDataRecursive(array &$links, array $parents, $depth) { } /** - * Checks if the tree table exists and create it if not. - * - * @return bool - * TRUE if the table was created, FALSE otherwise. - * - * @throws \Drupal\Component\Plugin\Exception\PluginException - * If a database error occurs. - */ - protected function ensureTableExists() { - try { - if (!$this->connection->schema()->tableExists($this->table)) { - $this->connection->schema()->createTable($this->table, static::schemaDefinition()); - return TRUE; - } - } - catch (SchemaObjectExistsException $e) { - // If another process has already created the config table, attempting to - // recreate it will throw an exception. In this case just catch the - // exception and do nothing. - return TRUE; - } - catch (\Exception $e) { - throw new PluginException($e->getMessage(), NULL, $e); - } - return FALSE; - } - - /** * Determines serialized fields in the storage. * * @return array @@ -1166,7 +1110,7 @@ protected function ensureTableExists() { */ protected function serializedFields() { if (empty($this->serializedFields)) { - $schema = static::schemaDefinition(); + $schema = $this->getSchema(); foreach ($schema['fields'] as $name => $field) { if (!empty($field['serialize'])) { $this->serializedFields[] = $name; @@ -1192,7 +1136,7 @@ protected function definitionFields() { * @return array * The schema API definition for the SQL storage table. */ - protected static function schemaDefinition() { + public function getSchema($table_name = '') { $schema = array( 'description' => 'Contains the menu tree hierarchy.', 'fields' => array( diff --git a/core/modules/system/src/Tests/Cache/DatabaseBackendTagTest.php b/core/modules/system/src/Tests/Cache/DatabaseBackendTagTest.php index c832ded..9004b25 100644 --- a/core/modules/system/src/Tests/Cache/DatabaseBackendTagTest.php +++ b/core/modules/system/src/Tests/Cache/DatabaseBackendTagTest.php @@ -8,6 +8,7 @@ namespace Drupal\system\Tests\Cache; use Drupal\Core\Cache\Cache; +use Drupal\Core\Database\Database; use Drupal\Core\DependencyInjection\ContainerBuilder; use Drupal\simpletest\DrupalUnitTestBase; use Symfony\Component\DependencyInjection\Reference; @@ -47,8 +48,9 @@ public function testTagInvalidations() { $bin->set('test', 'value', Cache::PERMANENT, $tags); $this->assertTrue($bin->get('test'), 'Cache item was set in bin.'); } - - $invalidations_before = intval(db_select('cachetags')->fields('cachetags', array('invalidations'))->condition('tag', 'test_tag:2')->execute()->fetchField()); + // Just setting cache data does not create the cachetags table, that only + // happens when tags are invalidated. + $this->assertFalse(Database::getConnection()->schema()->tableExists('cachetags')); Cache::invalidateTags(array('test_tag:2')); // Test that cache entry has been invalidated in multiple bins. @@ -59,7 +61,7 @@ public function testTagInvalidations() { // Test that only one tag invalidation has occurred. $invalidations_after = intval(db_select('cachetags')->fields('cachetags', array('invalidations'))->condition('tag', 'test_tag:2')->execute()->fetchField()); - $this->assertEqual($invalidations_after, $invalidations_before + 1, 'Only one addition cache tag invalidation has occurred after invalidating a tag used in multiple bins.'); + $this->assertEqual($invalidations_after, 1, 'Only one addition cache tag invalidation has occurred after invalidating a tag used in multiple bins.'); } public function testTagDeletions() { @@ -72,7 +74,7 @@ public function testTagDeletions() { $this->assertTrue($bin->get('test'), 'Cache item was set in bin.'); } - $deletions_before = intval(db_select('cachetags')->fields('cachetags', array('deletions'))->condition('tag', 'test_tag:2')->execute()->fetchField()); + $this->assertFalse(Database::getConnection()->schema()->tableExists('cachetags')); Cache::deleteTags(array('test_tag:2')); // Test that cache entry has been deleted in multiple bins. @@ -83,7 +85,7 @@ public function testTagDeletions() { // Test that only one tag deletion has occurred. $deletions_after = intval(db_select('cachetags')->fields('cachetags', array('deletions'))->condition('tag', 'test_tag:2')->execute()->fetchField()); - $this->assertEqual($deletions_after, $deletions_before + 1, 'Only one addition cache tag deletion has occurred after deleting a tag used in multiple bins.'); + $this->assertEqual($deletions_after, 1, 'Only one addition cache tag deletion has occurred after deleting a tag used in multiple bins.'); } } diff --git a/core/modules/system/src/Tests/Database/SchemaTest.php b/core/modules/system/src/Tests/Database/SchemaTest.php index 9009e72..79f860a 100644 --- a/core/modules/system/src/Tests/Database/SchemaTest.php +++ b/core/modules/system/src/Tests/Database/SchemaTest.php @@ -135,6 +135,8 @@ function testSchema() { // Try to drop the table. db_drop_table('test_table2'); $this->assertFalse(db_table_exists('test_table2'), 'The dropped table does not exist.'); + // Try to ensure the table exists. + $this->assertTrue(Database::getConnection()->schema()->ensureTableExists('test_table2', drupal_get_schema_unprocessed('database_test', 'test'))); // Recreate the table. db_create_table('test_table', $table_specification); diff --git a/core/modules/system/src/Tests/Database/SelectTest.php b/core/modules/system/src/Tests/Database/SelectTest.php index 26dd109..b2db5d1 100644 --- a/core/modules/system/src/Tests/Database/SelectTest.php +++ b/core/modules/system/src/Tests/Database/SelectTest.php @@ -7,13 +7,14 @@ namespace Drupal\system\Tests\Database; use Drupal\Core\Database\InvalidQueryException; +use Drupal\Core\Database\SchemaProviderInterface; /** * Tests the Select query builder. * * @group Database */ -class SelectTest extends DatabaseTestBase { +class SelectTest extends DatabaseTestBase implements SchemaProviderInterface { /** * Tests rudimentary SELECT statements. @@ -28,6 +29,29 @@ function testSimpleSelect() { } /** + * Tests rudimentary SELECT statements with table dropping and recreation. + */ + function testSimpleSelectWithEnsuringTable() { + db_drop_table('test'); + $query = db_select('test'); + $query->addField('test', 'name'); + $query->addField('test', 'age', 'age'); + $num_records = $query->countQuery()->execute()->fetchField(); + // The real test is not getting a fatal error from the exception over the + // missing table. + $this->assertEqual($num_records, 0, 'Returned the correct number of rows.'); + // The table should be recreated, add back the sample data and re-run the + // test. + try { + static::addSampleData(); + } + catch (\Exception $e) { + // Ignore adding rows to tables already filled. + } + $this->testSimpleSelect(); + } + + /** * Tests rudimentary SELECT statement with a COMMENT. */ function testSimpleComment() { @@ -453,7 +477,7 @@ function testInvalidSelectCount() { try { // This query will fail because the table does not exist. - db_select('some_table_that_doesnt_exist', 't') + db_select('some_table_that_doesnt_exist', 't', ['create_missing_table' => FALSE]) ->fields('t') ->countQuery() ->execute(); @@ -494,4 +518,12 @@ function testEmptyInCondition() { } } + /** + * A schema API array. + * + * @return array + */ + public function getSchema($table_name = '') { + return drupal_get_schema_unprocessed('database_test', 'test'); + } } diff --git a/core/modules/system/src/Tests/Menu/MenuTreeStorageTest.php b/core/modules/system/src/Tests/Menu/MenuTreeStorageTest.php index 39c403c..f19e96e 100644 --- a/core/modules/system/src/Tests/Menu/MenuTreeStorageTest.php +++ b/core/modules/system/src/Tests/Menu/MenuTreeStorageTest.php @@ -76,7 +76,7 @@ protected function doTestTable() { // that selecting from the storage creates the table. $tree_storage = new MenuTreeStorage($this->container->get('database'), $this->container->get('cache.menu'), 'test_menu_tree'); $this->assertFalse($this->connection->schema()->tableExists('test_menu_tree'), 'Test table is not yet created'); - $tree_storage->countMenuLinks(); + $tree_storage->save($this->getLinkArray($this->randomMachineName())); $this->assertTrue($this->connection->schema()->tableExists('test_menu_tree'), 'Test table was created'); } @@ -329,17 +329,7 @@ public function testLoadByProperties() { * Adds a link with the given ID and supply defaults. */ protected function addMenuLink($id, $parent = '', $route_name = 'test', $route_parameters = array(), $menu_name = 'tools', $extra = array()) { - $link = array( - 'id' => $id, - 'menu_name' => $menu_name, - 'route_name' => $route_name, - 'route_parameters' => $route_parameters, - 'title_arguments' => array(), - 'title' => 'test', - 'parent' => $parent, - 'options' => array(), - 'metadata' => array(), - ) + $extra; + $link = $this->getLinkArray($id, $parent, $route_name, $route_parameters, $menu_name) + $extra; $this->treeStorage->save($link); } @@ -412,4 +402,26 @@ protected function assertMenuLink($id, array $expected_properties, array $parent $this->assertEqual(array_intersect($children, $found_children), $children, 'Child IDs match'); } + /** + * @param $id + * @param $parent + * @param $route_name + * @param $route_parameters + * @param $menu_name + * @return array + */ + protected function getLinkArray($id, $parent = '', $route_name = 'test', $route_parameters = array(), $menu_name = 'tools') { + return array( + 'id' => $id, + 'menu_name' => $menu_name, + 'route_name' => $route_name, + 'route_parameters' => $route_parameters, + 'title_arguments' => array(), + 'title' => 'test', + 'parent' => $parent, + 'options' => array(), + 'metadata' => array(), + ); + } + } diff --git a/core/modules/system/tests/modules/error_test/src/Controller/ErrorTestController.php b/core/modules/system/tests/modules/error_test/src/Controller/ErrorTestController.php index 8ba584a..a753d35 100644 --- a/core/modules/system/tests/modules/error_test/src/Controller/ErrorTestController.php +++ b/core/modules/system/tests/modules/error_test/src/Controller/ErrorTestController.php @@ -69,7 +69,7 @@ public function triggerException() { */ public function triggerPDOException() { define('SIMPLETEST_COLLECT_ERRORS', FALSE); - $this->database->query('SELECT * FROM bananas_are_awesome'); + $this->database->query('SELECT * FROM bananas_are_awesome', [], ['create_missing_table' => FALSE]); } } diff --git a/core/tests/Drupal/Tests/Core/Database/Stub/StubConnection.php b/core/tests/Drupal/Tests/Core/Database/Stub/StubConnection.php index d36a8d1..f9f2fb9 100644 --- a/core/tests/Drupal/Tests/Core/Database/Stub/StubConnection.php +++ b/core/tests/Drupal/Tests/Core/Database/Stub/StubConnection.php @@ -74,4 +74,9 @@ public function nextId($existing_id = 0) { return 0; } + /** + * {@inheritdoc} + */ + public function isTableMissingException(\Exception $e) { + } }