Issue #2161591 by pwolanin, beejeebus, sun: Change default active config from...

Issue #2161591 by pwolanin, beejeebus, sun: Change default active config from file storage to DB storage.

core/core.services.yml

@@ -74,16 +74,9 @@ services:
     factory_method: get
     factory_service: cache_factory
     arguments: [discovery]
-  config.cachedstorage.storage:
-    class: Drupal\Core\Config\FileStorage
-    factory_class: Drupal\Core\Config\FileStorageFactory
-    factory_method: getActive
   config.manager:
     class: Drupal\Core\Config\ConfigManager
     arguments: ['@entity.manager', '@config.factory', '@config.typed', '@string_translation', '@config.storage']
-  config.storage:
-    class: Drupal\Core\Config\CachedStorage
-    arguments: ['@config.cachedstorage.storage', '@cache.config']
   config.factory:
     class: Drupal\Core\Config\ConfigFactory
     tags:
@@ -92,6 +85,15 @@ services:
   config.installer:
     class: Drupal\Core\Config\ConfigInstaller
     arguments: ['@config.factory', '@config.storage', '@config.typed', '@config.manager', '@event_dispatcher']
+  config.storage:
+    alias: config.storage.active
+  config.storage.active:
+    class: Drupal\Core\Config\DatabaseStorage
+    arguments: ['@database', 'config']
+  config.storage.file:
+    class: Drupal\Core\Config\FileStorage
+    factory_class: Drupal\Core\Config\FileStorageFactory
+    factory_method: getActive
   config.storage.staging:
     class: Drupal\Core\Config\FileStorage
     factory_class: Drupal\Core\Config\FileStorageFactory

core/includes/install.core.inc

@@ -438,7 +438,7 @@ function install_begin_request(&$install_state) {
   // Ensure that the active configuration directory is empty before installation
   // starts.
   if ($install_state['config_verified'] && empty($task)) {
-    $config = glob(config_get_config_directory(CONFIG_ACTIVE_DIRECTORY) . '/*.' . FileStorage::getFileExtension());
+    $config = \Drupal::service('config.storage')->listAll();
     if (!empty($config)) {
       $task = NULL;
       throw new AlreadyInstalledException($container->get('string_translation'));

core/lib/Drupal/Core/Config/BootstrapConfigStorageFactory.php

@@ -7,6 +7,7 @@
 
 namespace Drupal\Core\Config;
 
+use Drupal\Core\Database\Database;
 use Drupal\Component\Utility\Settings;
 
 /**
@@ -21,13 +22,29 @@ class BootstrapConfigStorageFactory {
    *   A configuration storage implementation.
    */
   public static function get() {
-    $drupal_bootstrap_config_storage = Settings::get('drupal_bootstrap_config_storage');
-    if ($drupal_bootstrap_config_storage && is_callable($drupal_bootstrap_config_storage)) {
-      return call_user_func($drupal_bootstrap_config_storage);
-    }
-    else {
-      return new FileStorage(config_get_config_directory(CONFIG_ACTIVE_DIRECTORY));
+    $bootstrap_config_storage = Settings::get('bootstrap_config_storage');
+    if (!empty($bootstrap_config_storage) && is_callable($bootstrap_config_storage)) {
+      return call_user_func($bootstrap_config_storage);
     }
+    // Fallback to the DatabaseStorage.
+    return self::getDatabaseStorage();
+  }
+
+  /**
+   * Returns a Database configuration storage implementation.
+   *
+   * @return \Drupal\Core\Config\DatabaseStorage
+   */
+  public static function getDatabaseStorage() {
+    return new DatabaseStorage(Database::getConnection(), 'config');
   }
 
+  /**
+   * Returns a File-based configuration storage implementation.
+   *
+   * @return \Drupal\Core\Config\FileStorage
+   */
+  public static function getFileStorage() {
+    return new FileStorage(config_get_config_directory(CONFIG_ACTIVE_DIRECTORY));
+  }
 }

core/lib/Drupal/Core/Config/Config.php

@@ -2,7 +2,7 @@
 
 /**
  * @file
- * Definition of Drupal\Core\Config\Config.
+ * Contains \Drupal\Core\Config\Config.
  */
 
 namespace Drupal\Core\Config;
@@ -215,6 +215,11 @@ public function save() {
         $this->data[$key] = $this->castValue($key, $value);
       }
     }
+    else {
+      foreach ($this->data as $key => $value) {
+        $this->validateValue($key, $value);
+      }
+    }
 
     $this->storage->write($this->name, $this->data);
     $this->isNew = FALSE;

core/lib/Drupal/Core/Config/DatabaseStorage.php

@@ -2,13 +2,14 @@
 
 /**
  * @file
- * Definition of Drupal\Core\Config\DatabaseStorage.
+ * Contains \Drupal\Core\Config\DatabaseStorage.
  */
 
 namespace Drupal\Core\Config;
 
 use Drupal\Core\Database\Database;
 use Drupal\Core\Database\Connection;
+use Drupal\Core\Database\SchemaObjectExistsException;
 
 /**
  * Defines the Database storage.
@@ -56,24 +57,23 @@ public function __construct(Connection $connection, $table, array $options = arr
    * Implements Drupal\Core\Config\StorageInterface::exists().
    */
   public function exists($name) {
-    return (bool) $this->connection->queryRange('SELECT 1 FROM {' . $this->connection->escapeTable($this->table) . '} WHERE name = :name', 0, 1, array(
-      ':name' => $name,
-    ), $this->options)->fetchField();
+    try {
+      return (bool) $this->connection->queryRange('SELECT 1 FROM {' . $this->connection->escapeTable($this->table) . '} WHERE name = :name', 0, 1, array(
+        ':name' => $name,
+      ), $this->options)->fetchField();
+    }
+    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 FALSE;
+    }
   }
 
   /**
-   * Implements Drupal\Core\Config\StorageInterface::read().
-   *
-   * @throws PDOException
-   * @throws \Drupal\Core\Database\DatabaseExceptionWrapper
-   *   Only thrown in case $this->options['throw_exception'] is TRUE.
+   * {@inheritdoc}
    */
   public function read($name) {
     $data = FALSE;
-    // There are situations, like in the installer, where we may attempt a
-    // read without actually having the database available. In this case,
-    // catch the exception and just return an empty array so the caller can
-    // handle it if need be.
     try {
       $raw = $this->connection->query('SELECT data FROM {' . $this->connection->escapeTable($this->table) . '} WHERE name = :name', array(':name' => $name), $this->options)->fetchField();
       if ($raw !== FALSE) {
@@ -81,6 +81,8 @@ public function read($name) {
       }
     }
     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;
   }
@@ -89,10 +91,6 @@ public function read($name) {
    * {@inheritdoc}
    */
   public function readMultiple(array $names) {
-    // There are situations, like in the installer, where we may attempt a
-    // read without actually having the database available. In this case,
-    // catch the exception and just return an empty array so the caller can
-    // handle it if need be.
     $list = array();
     try {
       $list = $this->connection->query('SELECT name, data FROM {' . $this->connection->escapeTable($this->table) . '} WHERE name IN (:names)', array(':names' => $names), $this->options)->fetchAllKeyed();
@@ -100,20 +98,42 @@ public function readMultiple(array $names) {
         $data = $this->decode($data);
       }
     }
-    catch (Exception $e) {
+    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;
   }
 
   /**
-   * Implements Drupal\Core\Config\StorageInterface::write().
-   *
-   * @throws PDOException
-   *
-   * @todo Ignore slave targets for data manipulation operations.
+   * {@inheritdoc}
    */
   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)
       ->key('name', $name)
@@ -121,6 +141,60 @@ public function write($name, array $data) {
       ->execute();
   }
 
+  /**
+   * 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() {
+    $schema = array(
+      'description' => 'The base table for configuration data.',
+      'fields' => array(
+        'name' => array(
+          'description' => 'Primary Key: Unique config object name.',
+          'type' => 'varchar',
+          'length' => 255,
+          'not null' => TRUE,
+          'default' => '',
+        ),
+        'data' => array(
+          'description' => 'A serialized configuration object data.',
+          'type' => 'blob',
+          'not null' => FALSE,
+          'size' => 'big',
+        ),
+      ),
+      'primary key' => array('name'),
+    );
+    return $schema;
+  }
+
   /**
    * Implements Drupal\Core\Config\StorageInterface::delete().
    *
@@ -168,29 +242,31 @@ public function decode($raw) {
   }
 
   /**
-   * Implements Drupal\Core\Config\StorageInterface::listAll().
-   *
-   * @throws PDOException
-   * @throws \Drupal\Core\Database\DatabaseExceptionWrapper
-   *   Only thrown in case $this->options['throw_exception'] is TRUE.
+   * {@inheritdoc}
    */
   public function listAll($prefix = '') {
-    return $this->connection->query('SELECT name FROM {' . $this->connection->escapeTable($this->table) . '} WHERE name LIKE :name', array(
-      ':name' => db_like($prefix) . '%',
-    ), $this->options)->fetchCol();
+    try {
+      return $this->connection->query('SELECT name FROM {' . $this->connection->escapeTable($this->table) . '} WHERE name LIKE :name', array(
+        ':name' => $this->connection->escapeLike($prefix) . '%',
+      ), $this->options)->fetchCol();
+    }
+    catch (\Exception $e) {
+      return array();
+    }
   }
 
   /**
-   * Implements Drupal\Core\Config\StorageInterface::deleteAll().
-   *
-   * @throws PDOException
-   * @throws \Drupal\Core\Database\DatabaseExceptionWrapper
-   *   Only thrown in case $this->options['throw_exception'] is TRUE.
+   * {@inheritdoc}
    */
   public function deleteAll($prefix = '') {
-    $options = array('return' => Database::RETURN_AFFECTED) + $this->options;
-    return (bool) $this->connection->delete($this->table, $options)
-      ->condition('name', $prefix . '%', 'LIKE')
-      ->execute();
+    try {
+      $options = array('return' => Database::RETURN_AFFECTED) + $this->options;
+      return (bool) $this->connection->delete($this->table, $options)
+        ->condition('name', $prefix . '%', 'LIKE')
+        ->execute();
+    }
+    catch (\Exception $e) {
+      return FALSE;
+    }
   }
 }

core/lib/Drupal/Core/Config/FileStorage.php

@@ -68,6 +68,18 @@ public static function getFileExtension() {
     return 'yml';
   }
 
+  /**
+   * Check if the directory exists and create it if not.
+   */
+  protected function ensureStorage() {
+    $success = file_prepare_directory($this->directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
+    $success = $success && file_save_htaccess($this->directory, TRUE, TRUE);
+    if (!$success) {
+      throw new StorageException("Failed to create config directory {$this->directory}");
+    }
+    return $this;
+  }
+
   /**
    * Implements Drupal\Core\Config\StorageInterface::exists().
    */
@@ -105,21 +117,23 @@ public function readMultiple(array $names) {
   }
 
   /**
-   * Implements Drupal\Core\Config\StorageInterface::write().
-   *
-   * @throws \Drupal\Core\Config\UnsupportedDataTypeConfigException
-   * @throws \Drupal\Core\Config\StorageException
+   * {@inheritdoc}
    */
   public function write($name, array $data) {
     try {
       $data = $this->encode($data);
     }
     catch(DumpException $e) {
-      throw new UnsupportedDataTypeConfigException(String::format('Invalid data type for used in config: @name', array('@name' => $name)));
+      throw new StorageException(String::format('Invalid data type for used in config: @name', array('@name' => $name)));
     }
 
     $target = $this->getFilePath($name);
     $status = @file_put_contents($target, $data);
+    if ($status === FALSE) {
+      // Try to make sure the directory exists and try witing again.
+      $this->ensureStorage();
+      $status = @file_put_contents($target, $data);
+    }
     if ($status === FALSE) {
       throw new StorageException('Failed to write configuration file: ' . $this->getFilePath($name));
     }
@@ -213,7 +227,7 @@ public function listAll($prefix = '') {
     // glob() silently ignores the error of a non-existing search directory,
     // even with the GLOB_ERR flag.
     if (!file_exists($this->directory)) {
-      throw new StorageException($this->directory . '/ not found.');
+      return array();
     }
     $extension = '.' . static::getFileExtension();
     // \GlobIterator on Windows requires an absolute path.

core/lib/Drupal/Core/Config/StorableConfigBase.php

@@ -131,6 +131,27 @@ protected function getSchemaWrapper() {
     return $this->schemaWrapper;
   }
 
+  /**
+   * Validate the values are allowed data types.
+   *
+   * @throws UnsupportedDataTypeConfigException
+   *   If there is any invalid value.
+   */
+  protected function validateValue($key, $value) {
+    // Minimal validation. Should not try to serialize resources or non-arrays.
+    if (is_array($value)) {
+      foreach ($value as $nested_value_key => $nested_value) {
+        $this->validateValue($key . '.' . $nested_value_key, $nested_value);
+      }
+    }
+    elseif ($value !== NULL && !is_scalar($value)) {
+      throw new UnsupportedDataTypeConfigException(String::format('Invalid data type for config element @name:@key', array(
+        '@name' => $this->getName(),
+        '@key' => $key,
+      )));
+    }
+  }
+
   /**
    * Casts the value to correct data type using the configuration schema.
    *

core/lib/Drupal/Core/Config/StorageInterface.php

@@ -41,7 +41,7 @@ public function read($name);
   /**
    * Reads configuration data from the storage.
    *
-   * @param array $name
+   * @param array $names
    *   List of names of the configuration objects to load.
    *
    * @return array
@@ -60,6 +60,9 @@ public function readMultiple(array $names);
    *
    * @return bool
    *   TRUE on success, FALSE in case of an error.
+   *
+   * @throws \Drupal\Core\Config\StorageException
+   *   If the back-end storage does not exist and cannot be created.
    */
   public function write($name, array $data);
 

core/lib/Drupal/Core/DependencyInjection/UpdateServiceProvider.php

@@ -28,11 +28,11 @@ public function register(ContainerBuilder $container) {
       $container
         ->register('lock', 'Drupal\Core\Lock\NullLockBackend');
 
-      // Prevent config from accessing {cache_config}.
-      // @see $conf['cache_classes'], update_prepare_d8_bootstrap()
-      $container
-        ->register('config.storage', 'Drupal\Core\Config\FileStorage')
-        ->addArgument(config_get_config_directory(CONFIG_ACTIVE_DIRECTORY));
+      // Prevent config from being accessed via a cache wrapper by removing
+      // any existing definition and setting an alias to the actual storage.
+      $container->removeDefinition('config.storage');
+      $container->setAlias('config.storage', 'config.storage.active');
+
       $container->register('module_handler', 'Drupal\Core\Extension\UpdateModuleHandler')
         ->addArgument('%container.modules%');
       $container

core/modules/config/lib/Drupal/config/Controller/ConfigController.php

@@ -12,6 +12,7 @@
 use Drupal\Core\Config\StorageInterface;
 use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
 use Drupal\system\FileDownloadController;
+use Symfony\Component\Yaml\Dumper;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\Request;
 
@@ -81,13 +82,15 @@ public function __construct(StorageInterface $target_storage, StorageInterface $