diff --git a/core/core.services.yml b/core/core.services.yml index 9dca742..39e0b82 100644 --- a/core/core.services.yml +++ b/core/core.services.yml @@ -151,6 +151,14 @@ services: plugin.manager.entity: class: Drupal\Core\Entity\EntityManager arguments: ['@container.namespaces'] + config.comparer: + class: Drupal\Core\Config\StorageComparerManifest + arguments: ['@config.storage.staging', '@config.storage'] + calls: + - [createChangelist] + config.importer: + class: Drupal\Core\Config\ConfigImporter + arguments: ['config.importer', '@config.comparer', '@event_dispatcher', '@config.factory', '@plugin.manager.entity', '@lock'] plugin.manager.archiver: class: Drupal\Core\Archiver\ArchiverManager arguments: ['@container.namespaces'] @@ -360,6 +368,15 @@ services: class: Drupal\Core\EventSubscriber\ConfigGlobalOverrideSubscriber tags: - { name: event_subscriber } + config_import_subscriber: + class: Drupal\Core\EventSubscriber\ConfigImportSubscriber + tags: + - { name: event_subscriber } + config_snapshot_subscriber: + class: Drupal\Core\EventSubscriber\ConfigSnapshotSubscriber + tags: + - { name: event_subscriber } + arguments: ['@config.storage', '@config.storage.snapshot'] language_request_subscriber: class: Drupal\Core\EventSubscriber\LanguageRequestSubscriber tags: diff --git a/core/includes/config.inc b/core/includes/config.inc index f414845..e2ab40a 100644 --- a/core/includes/config.inc +++ b/core/includes/config.inc @@ -2,8 +2,10 @@ use Drupal\Core\Config\Config; use Drupal\Core\Config\ConfigException; +use Drupal\Core\Config\ConfigImporter; use Drupal\Core\Config\FileStorage; use Drupal\Core\Config\StorageInterface; +use Drupal\Core\Config\StorageComparer; use Symfony\Component\Yaml\Dumper; /** @@ -12,11 +14,6 @@ */ /** - * Config import lock name used to prevent concurrent synchronizations. - */ -const CONFIG_IMPORT_LOCK = 'config_import'; - -/** * Installs the default configuration of a given extension. * * @param string $type @@ -25,10 +22,6 @@ * The name of the module or theme to install default configuration for. */ function config_install_default_config($type, $name) { - // Use the override free context for config importing so that any overrides do - // not change the data on import. - config_context_enter('config.context.free'); - // If this module defines any ConfigEntity types then create an empty // manifest file for each of them. foreach (config_get_module_config_entities($name) as $entity_info) { @@ -38,22 +31,20 @@ function config_install_default_config($type, $name) { $config_dir = drupal_get_path($type, $name) . '/config'; if (is_dir($config_dir)) { $source_storage = new FileStorage($config_dir); - $target_storage = drupal_container()->get('config.storage'); - - // Ignore manifest files. - $config_changes = config_sync_get_changes($source_storage, $target_storage, FALSE); - if (empty($config_changes['create'])) { - return; - } - - // Do not overwrite or delete pre-existing configuration. - $config_changes['change'] = array(); - $config_changes['delete'] = array(); - $remaining_changes = config_import_invoke_owner($config_changes, $source_storage, $target_storage); - config_sync_changes($remaining_changes, $source_storage, $target_storage); + $storage_comparer = new StorageComparer($source_storage, Drupal::service('config.storage')); + // Only import new config. Changed config is from previous enables and + // should not be overwritten. + $storage_comparer->addChangelistCreate(); + $installer = new ConfigImporter( + 'config.installer', + $storage_comparer, + Drupal::service('event_dispatcher'), + Drupal::service('config.factory'), + Drupal::entityManager(), + Drupal::lock() + ); + $installer->import(); } - // Exit the override free context. - config_context_leave(); } /** @@ -155,227 +146,6 @@ function config_context_leave() { } /** - * Returns a list of differences between configuration storages. - * - * @param Drupal\Core\Config\StorageInterface $source_storage - * The storage to synchronize configuration from. - * @param Drupal\Core\Config\StorageInterface $target_storage - * The storage to synchronize configuration to. - * @param bool $use_manifest - * (optional) Whether to determine changes based on manifest files. Defaults - * to TRUE. - * - * @return array|bool - * An associative array containing the differences between source and target - * storage, or FALSE if there are no differences. - */ -function config_sync_get_changes(StorageInterface $source_storage, StorageInterface $target_storage, $use_manifest = TRUE) { - $config_changes = array( - 'create' => array(), - 'change' => array(), - 'delete' => array(), - ); - $all_source_names = $source_storage->listAll(); - $all_target_names = $target_storage->listAll(); - - // Config entities maintain 'manifest' files that list the objects they - // are currently handling. Each file is a simple indexed array of config - // object names. In order to generate a list of objects that have been - // created or deleted we need to open these files in both the source and - // target storage, generate an array of the objects, and compare them. - if ($use_manifest) { - $source_config_data = array(); - $target_config_data = array(); - foreach ($source_storage->listAll('manifest') as $name) { - if ($source_manifest_data = $source_storage->read($name)) { - $source_config_data = array_merge($source_config_data, $source_manifest_data); - } - - if ($target_manifest_data = $target_storage->read($name)) { - $target_config_data = array_merge($target_config_data, $target_manifest_data); - } - } - - foreach (array_diff_key($target_config_data, $source_config_data) as $name => $value) { - $config_changes['delete'][] = $value['name']; - } - - foreach (array_diff_key($source_config_data, $target_config_data) as $name => $value) { - $config_changes['create'][] = $value['name']; - } - } - else { - $config_changes['delete'] = array_diff($all_target_names, $all_source_names); - $config_changes['create'] = array_diff($all_source_names, $all_target_names); - } - - foreach (array_intersect($all_source_names, $all_target_names) as $name) { - // Ignore manifest files - if (substr($name, 0, 9) != 'manifest.') { - $source_config_data = $source_storage->read($name); - $target_config_data = $target_storage->read($name); - if ($source_config_data !== $target_config_data) { - $config_changes['change'][] = $name; - } - } - } - - // Do not trigger subsequent synchronization operations if there are no - // changes in any category. - if (empty($config_changes['create']) && empty($config_changes['change']) && empty($config_changes['delete'])) { - return FALSE; - } - return $config_changes; -} - -/** - * Writes an array of config file changes from a source storage to a target storage. - * - * @param array $config_changes - * An array of changes to be written. - * @param Drupal\Core\Config\StorageInterface $source_storage - * The storage to synchronize configuration from. - * @param Drupal\Core\Config\StorageInterface $target_storage - * The storage to synchronize configuration to. - */ -function config_sync_changes(array $config_changes, StorageInterface $source_storage, StorageInterface $target_storage) { - $target_context = drupal_container()->get('config.context.free'); - $factory = drupal_container()->get('config.factory'); - foreach (array('delete', 'create', 'change') as $op) { - foreach ($config_changes[$op] as $name) { - $config = new Config($name, $target_storage, $target_context); - if ($op == 'delete') { - $config->delete(); - } - else { - $data = $source_storage->read($name); - $config->setData($data ? $data : array()); - $config->save(); - } - $factory->reset($name); - } - } -} - -/** - * Imports configuration into the active configuration. - * - * @return bool|null - * TRUE if configuration was imported successfully, FALSE in case of a - * synchronization error, or NULL if there are no changes to synchronize. - */ -function config_import() { - // Retrieve a list of differences between staging and the active configuration. - $source_storage = drupal_container()->get('config.storage.staging'); - $snapshot_storage = drupal_container()->get('config.storage.snapshot'); - $target_storage = drupal_container()->get('config.storage'); - - $config_changes = config_sync_get_changes($source_storage, $target_storage); - if (empty($config_changes)) { - return; - } - - if (!lock()->acquire(CONFIG_IMPORT_LOCK)) { - // Another request is synchronizing configuration. - // Return a negative result for UI purposes. We do not differentiate between - // an actual synchronization error and a failed lock, because concurrent - // synchronizations are an edge-case happening only when multiple developers - // or site builders attempt to do it without coordinating. - return FALSE; - } - - $success = TRUE; - try { - // Use the override free context for config importing so that any overrides do - // not change the data on import. - config_context_enter('config.context.free'); - - $remaining_changes = config_import_invoke_owner($config_changes, $source_storage, $target_storage); - config_sync_changes($remaining_changes, $source_storage, $target_storage); - config_import_create_snapshot($target_storage, $snapshot_storage); - - // Exit the override free context. - config_context_leave(); - } - catch (ConfigException $e) { - watchdog_exception('config_import', $e); - $success = FALSE; - } - lock()->release(CONFIG_IMPORT_LOCK); - - return $success; -} - -/** - * Creates a configuration snapshot following a successful import. - * - * @param Drupal\Core\Config\StorageInterface $source_storage - * The storage to synchronize configuration from. - * @param Drupal\Core\Config\StorageInterface $target_storage - * The storage to synchronize configuration to. - */ -function config_import_create_snapshot(StorageInterface $source_storage, StorageInterface $snapshot_storage) { - $snapshot_storage->deleteAll(); - foreach ($source_storage->listAll() as $name) { - $snapshot_storage->write($name, $source_storage->read($name)); - } -} - -/** - * Invokes MODULE_config_import() callbacks for configuration changes. - * - * @param array $config_changes - * An array of changes to be loaded. - * @param Drupal\Core\Config\StorageInterface $source_storage - * The storage to synchronize configuration from. - * @param Drupal\Core\Config\StorageInterface $target_storage - * The storage to synchronize configuration to. - * - * @todo Add support for other extension types; e.g., themes etc. - */ -function config_import_invoke_owner(array $config_changes, StorageInterface $source_storage, StorageInterface $target_storage) { - $factory = drupal_container()->get('config.factory'); - // Use the admin context for config importing so that any overrides do not - // change the data on import. - $free_context = drupal_container()->get('config.context.free'); - // Allow modules to take over configuration change operations for - // higher-level configuration data. - // First pass deleted, then new, and lastly changed configuration, in order to - // handle dependencies correctly. - $manager = Drupal::entityManager(); - foreach (array('delete', 'create', 'change') as $op) { - foreach ($config_changes[$op] as $key => $name) { - // Call to the configuration entity's storage controller to handle the - // configuration change. - $handled_by_module = FALSE; - // Validate the configuration object name before importing it. - Config::validateName($name); - if ($entity_type = config_get_entity_type_by_name($name)) { - $old_config = new Config($name, $target_storage, $free_context); - $old_config->load(); - - $data = $source_storage->read($name); - $new_config = new Config($name, $source_storage, $free_context); - if ($data !== FALSE) { - $new_config->setData($data); - } - - $method = 'import' . ucfirst($op); - $handled_by_module = $manager->getStorageController($entity_type)->$method($name, $new_config, $old_config); - } - if (!empty($handled_by_module)) { - $factory->reset($name); - // Reset the manifest config object for the config entity. - $entity_info = Drupal::entityManager()->getDefinition($entity_type); - $factory->reset('manifest.' . $entity_info['config_prefix']); - unset($config_changes[$op][$key]); - } - } - } - return $config_changes; -} - -/** * Return a list of all config entity types provided by a module. * * @param string $module @@ -425,6 +195,21 @@ function config_typed() { } /** + * Creates a configuration snapshot following a successful import. + * + * @param Drupal\Core\Config\StorageInterface $source_storage + * The storage to synchronize configuration from. + * @param Drupal\Core\Config\StorageInterface $target_storage + * The storage to synchronize configuration to. + */ +function config_import_create_snapshot(StorageInterface $source_storage, StorageInterface $snapshot_storage) { + $snapshot_storage->deleteAll(); + foreach ($source_storage->listAll() as $name) { + $snapshot_storage->write($name, $source_storage->read($name)); + } +} + +/** * Return a formatted diff of a named config between two storages. * * @param Drupal\Core\Config\StorageInterface $source_storage diff --git a/core/lib/Drupal/Core/Config/ConfigFactory.php b/core/lib/Drupal/Core/Config/ConfigFactory.php index 0c3785c..dd5df1e 100644 --- a/core/lib/Drupal/Core/Config/ConfigFactory.php +++ b/core/lib/Drupal/Core/Config/ConfigFactory.php @@ -96,15 +96,13 @@ public function get($name) { */ public function reset($name = NULL) { if ($name) { - // Reinitialize the configuration object in all contexts. + // Clear the cached configuration object in all contexts. foreach ($this->getCacheKeys($name) as $cache_key) { - $this->cache[$cache_key]->init(); + unset($this->cache[$cache_key]); } } else { - foreach ($this->cache as $config) { - $config->init(); - } + $this->cache = array(); } return $this; } diff --git a/core/lib/Drupal/Core/Config/ConfigImporter.php b/core/lib/Drupal/Core/Config/ConfigImporter.php new file mode 100644 index 0000000..861473b --- /dev/null +++ b/core/lib/Drupal/Core/Config/ConfigImporter.php @@ -0,0 +1,347 @@ +serviceName = $service_name; + $this->storageComparer = $storage_comparer; + $this->eventDispatcher = $event_dispatcher; + $this->configFactory = $config_factory; + $this->entityManager = $entity_manager; + $this->lock = $lock; + $this->processed = $this->storageComparer->getEmptyChangelist(); + // Use an override free context for importing so that overrides to do not + // pollute the imported data. The context is hard coded to ensure this is + // the case. + $this->context = new FreeConfigContext($this->eventDispatcher); + } + + /** + * Gets the configuration storage comparer. + * + * @return \Drupal\Core\Config\StorageComparerInterface + * Storage comparer object used to calculate configuration changes. + */ + public function getStorageComparer() { + return $this->storageComparer; + } + + /** + * Resets the storage comparer and processed list. + * + * @return \Drupal\Core\Config\ConfigImporter + * The ConfigImporter instance. + */ + public function reset() { + $this->storageComparer->reset(); + $this->processed = $this->storageComparer->getEmptyChangelist(); + $this->validated = FALSE; + return $this; + } + + /** + * Checks if there are any unprocessed changes. + * + * @param array $changelists + * Changelists to check for changes. Defaults to all changelists, i.e. + * array('delete', 'create', 'update'). + * + * @return bool + * TRUE if there are changes to process and FALSE if not. + */ + public function hasChanges($changelists = array('delete', 'create', 'update')) { + foreach ($changelists as $op) { + if (count($this->getUnprocessed($op))) { + return TRUE; + } + } + return FALSE; + } + + /** + * Gets list of processed changes. + * + * @return array + * An array containing a list of processed changes. + */ + public function getProcessed() { + return $this->processed; + } + + /** + * Sets a change as processed. + * + * @param string $op + * The change operation performed, either delete, create or update. + * @param string $name + * The name of the configuration processed. + */ + protected function setProcessed($op, $name) { + $this->processed[$op][] = $name; + } + + /** + * Gets a list of unprocessed changes for a given operation. + * + * @param string $op + * The change operation to get the unprocessed list for, either delete, + * create or update. + * + * @return array + * An array of configuration names. + */ + public function getUnprocessed($op) { + return array_diff($this->storageComparer->getChangelist($op), $this->processed[$op]); + } + + /** + * Imports the changelist to the target storage. + * + * @throws \Drupal\Core\Config\ConfigException + * + * @return \Drupal\Core\Config\ConfigImporter + * The ConfigImporter instance. + */ + public function import() { + if ($this->hasChanges()) { + // Ensure that the changes have been validated. + $this->validate(); + + $this->configFactory->enterContext($this->context); + if (!$this->lock->acquire($this->serviceName)) { + // Another process is synchronizing configuration. + throw new ConfigImporterException(sprintf('Import service %s is already running', $this->serviceName)); + } + $this->importInvokeOwner(); + $this->importConfig(); + // Allow modules to react to a import. + $this->notify('import'); + + // The import is now complete. + $this->lock->release($this->serviceName); + $this->reset(); + // Leave the context used during import and clear the ConfigFactory's + // static cache. + $this->configFactory->leaveContext()->reset(); + } + return $this; + } + + /** + * Dispatches validate event for a ConfigImporter object. + * + * Events should throw a \Drupal\Core\Config\ConfigImporterException to + * prevent an import from occurring. + */ + public function validate() { + if (!$this->validated) { + $this->notify('validate'); + $this->validated = TRUE; + } + return $this; + } + + /** + * Writes an array of config changes from the source to the target storage. + * + * The changelist is modified as each change is processed. + */ + protected function importConfig() { + foreach (array('delete', 'create', 'update') as $op) { + foreach ($this->getUnprocessed($op) as $name) { + $config = new Config($name, $this->storageComparer->getTargetStorage(), $this->context); + if ($op == 'delete') { + $config->delete(); + } + else { + $data = $this->storageComparer->getSourceStorage()->read($name); + $config->setData($data ? $data : array()); + $config->save(); + } + $this->setProcessed($op, $name); + } + } + } + + /** + * Invokes import* methods on configuration entity storage controllers. + * + * The changelist is modified as each change is processed. + * + * @todo Add support for other extension types; e.g., themes etc. + */ + protected function importInvokeOwner() { + // Allow modules to take over configuration change operations for + // higher-level configuration data. + // First pass deleted, then new, and lastly changed configuration, in order to + // handle dependencies correctly. + foreach (array('delete', 'create', 'update') as $op) { + foreach ($this->getUnprocessed($op) as $name) { + // Call to the configuration entity's storage controller to handle the + // configuration change. + $handled_by_module = FALSE; + // Validate the configuration object name before importing it. + // Config::validateName($name); + if ($entity_type = config_get_entity_type_by_name($name)) { + $old_config = new Config($name, $this->storageComparer->getTargetStorage(), $this->context); + $old_config->load(); + + $data = $this->storageComparer->getSourceStorage()->read($name); + $new_config = new Config($name, $this->storageComparer->getTargetStorage(), $this->context); + if ($data !== FALSE) { + $new_config->setData($data); + } + + $method = 'import' . ucfirst($op); + $handled_by_module = $this->entityManager->getStorageController($entity_type)->$method($name, $new_config, $old_config); + } + if (!empty($handled_by_module)) { + $this->setProcessed($op, $name); + } + } + } + } + + /** + * Dispatches a config importer event. + * + * @param string $event_name + * The name of the config importer event to dispatch. + */ + protected function notify($event_name) { + $this->eventDispatcher->dispatch($this->serviceName . '.' . $event_name, new ConfigImporterEvent($this)); + } + + /** + * Determines if a import is already running. + * + * @return bool + * TRUE if an import is already running, FALSE if not. + */ + public function alreadyImporting() { + return !$this->lock->lockMayBeAvailable($this->serviceName); + } + + /** + * Returns the service name. + * + * @return string + * The service name. + */ + public function getServiceName() { + return $this->serviceName; + } + +} diff --git a/core/lib/Drupal/Core/Config/ConfigImporterEvent.php b/core/lib/Drupal/Core/Config/ConfigImporterEvent.php new file mode 100644 index 0000000..37e343f --- /dev/null +++ b/core/lib/Drupal/Core/Config/ConfigImporterEvent.php @@ -0,0 +1,39 @@ +configImporter = $config_importer; + } + + /** + * Gets the config import object. + * + * @return \Drupal\Core\Config\ConfigImporter + * The ConfigImporter object. + */ + public function getConfigImporter() { + return $this->configImporter; + } +} diff --git a/core/lib/Drupal/Core/Config/ConfigImporterException.php b/core/lib/Drupal/Core/Config/ConfigImporterException.php new file mode 100644 index 0000000..fd18c4d --- /dev/null +++ b/core/lib/Drupal/Core/Config/ConfigImporterException.php @@ -0,0 +1,13 @@ +entityInfo['config_prefix']); $entities = $this->load(array($id)); $entity = $entities[$id]; diff --git a/core/lib/Drupal/Core/Config/StorageComparer.php b/core/lib/Drupal/Core/Config/StorageComparer.php new file mode 100644 index 0000000..beda5fc --- /dev/null +++ b/core/lib/Drupal/Core/Config/StorageComparer.php @@ -0,0 +1,208 @@ +sourceStorage = $source_storage; + $this->targetStorage = $target_storage; + $this->changelist = $this->getEmptyChangelist(); + } + + /** + * {@inheritdoc} + */ + public function getSourceStorage() { + return $this->sourceStorage; + } + + /** + * {@inheritdoc} + */ + public function getTargetStorage() { + return $this->targetStorage; + } + + /** + * {@inheritdoc} + */ + public function getEmptyChangelist() { + return array( + 'create' => array(), + 'update' => array(), + 'delete' => array(), + ); + } + + /** + * {@inheritdoc} + */ + public function getChangelist($op = NULL) { + if ($op) { + return $this->changelist[$op]; + } + return $this->changelist; + } + + /** + * {@inheritdoc} + */ + public function addChangeList($op, array $changes) { + // Only add changes that aren't already listed. + $changes = array_diff($changes, $this->changelist[$op]); + $this->changelist[$op] = array_merge($this->changelist[$op], $changes); + return $this; + } + + /** + * {@inheritdoc} + */ + public function createChangelist() { + return $this + ->addChangelistCreate() + ->addChangelistUpdate() + ->addChangelistDelete(); + } + + /** + * {@inheritdoc} + */ + public function addChangelistDelete() { + return $this->addChangeList('delete', array_diff($this->getTargetNames(), $this->getSourceNames())); + } + + /** + * {@inheritdoc} + */ + public function addChangelistCreate() { + return $this->addChangeList('create', array_diff($this->getSourceNames(), $this->getTargetNames())); + } + + /** + * {@inheritdoc} + */ + public function addChangelistUpdate() { + foreach (array_intersect($this->getSourceNames(), $this->getTargetNames()) as $name) { + // Ignore manifest files + if (substr($name, 0, 9) != 'manifest.') { + $source_config_data = $this->sourceStorage->read($name); + $target_config_data = $this->targetStorage->read($name); + if ($source_config_data !== $target_config_data) { + $this->addChangeList('update', array($name)); + } + } + } + return $this; + } + + /** + * {@inheritdoc} + */ + public function reset() { + $this->changelist = $this->getEmptyChangelist(); + $this->sourceNames = $this->targetNames = array(); + return $this->createChangelist(); + } + + /** + * Checks if there is a changelist with changes to process. + * + * @param array $ops + * Operation to check for changes. Defaults to all operations, i.e. + * array('delete', 'create', 'update'). + * + * @return bool + * TRUE if there are changes to process and FALSE if not. + */ + public function hasChanges($ops = array('delete', 'create', 'update')) { + foreach ($ops as $op) { + if (!empty($this->changelist[$op])) { + return TRUE; + } + } + return FALSE; + } + + /** + * Gets all the configuration names in the source storage. + * + * @return array + * List of all the configuration names in the source storage. + */ + protected function getSourceNames() { + if (empty($this->sourceNames)) { + $this->sourceNames = $this->sourceStorage->listAll(); + } + return $this->sourceNames; + } + + /** + * Gets all the configuration names in the target storage. + * + * @return array + * List of all the configuration names in the target storage. + */ + protected function getTargetNames() { + if (empty($this->targetNames)) { + $this->targetNames = $this->targetStorage->listAll(); + } + return $this->targetNames; + } + +} diff --git a/core/lib/Drupal/Core/Config/StorageComparerInterface.php b/core/lib/Drupal/Core/Config/StorageComparerInterface.php new file mode 100644 index 0000000..16c67f8 --- /dev/null +++ b/core/lib/Drupal/Core/Config/StorageComparerInterface.php @@ -0,0 +1,120 @@ +getTargetManifestData(), $this->getSourceManifestData()) as $value) { + $this->addChangeList('delete', array($value['name'])); + } + return $this; + } + + /** + * {@inheritdoc} + */ + public function addChangelistCreate() { + foreach (array_diff_key($this->getSourceManifestData(), $this->getTargetManifestData()) as $value) { + $this->addChangeList('create', array($value['name'])); + } + return $this; + } + + /** + * Gets the list of config entities from the source storage's manifest files. + * + * @return array + * The list of config entities in the source storage whose entity type has a + * manifest in the source storage. + */ + protected function getSourceManifestData() { + if (empty($this->sourceManifestData)) { + foreach ($this->getSourceStorage()->listAll('manifest') as $name) { + if ($source_manifest_data = $this->getSourceStorage()->read($name)) { + $this->sourceManifestData = array_merge($this->sourceManifestData, $source_manifest_data); + } + } + } + return $this->sourceManifestData; + } + + /** + * Gets the list of config entities from the target storage's manifest files. + * + * @see \Drupal\Core\Config\ConfigImporter::getSourceManifestData() + * + * @return array + * The list of config entities in the target storage whose entity type has a + * manifest in the source storage. + */ + protected function getTargetManifestData() { + if (empty($this->targetManifestData)) { + foreach ($this->getSourceStorage()->listAll('manifest') as $name) { + if ($target_manifest_data = $this->targetStorage->read($name)) { + $this->targetManifestData = array_merge($this->targetManifestData, $target_manifest_data); + } + } + } + return $this->targetManifestData; + } + + /** + * {@inheritdoc} + */ + public function reset() { + $this->sourceManifestData = $this->targetManifestData = array(); + return parent::reset(); + } +} diff --git a/core/lib/Drupal/Core/EventSubscriber/ConfigImportSubscriber.php b/core/lib/Drupal/Core/EventSubscriber/ConfigImportSubscriber.php new file mode 100644 index 0000000..59000bf --- /dev/null +++ b/core/lib/Drupal/Core/EventSubscriber/ConfigImportSubscriber.php @@ -0,0 +1,48 @@ +getConfigImporter()->getUnprocessed($op) as $name) { + Config::validateName($name); + } + } + } + + /** + * Registers the methods in this class that should be listeners. + * + * @return array + * An array of event listener definitions. + */ + static function getSubscribedEvents() { + $events['config.importer.validate'][] = array('onConfigImporterValidate', 40); + $events['config.installer.validate'][] = array('onConfigImporterValidate', 40); + return $events; + } + +} diff --git a/core/lib/Drupal/Core/EventSubscriber/ConfigSnapshotSubscriber.php b/core/lib/Drupal/Core/EventSubscriber/ConfigSnapshotSubscriber.php new file mode 100644 index 0000000..04a52f1 --- /dev/null +++ b/core/lib/Drupal/Core/EventSubscriber/ConfigSnapshotSubscriber.php @@ -0,0 +1,68 @@ +sourceStorage = $source_storage; + $this->snapshotStorage = $snapshot_storage; + } + + /** + * Create config snapshot. + * + * @param \Drupal\Core\Config\ConfigImporterEvent $event + * The Event to process. + */ + public function onConfigImporterImport(ConfigImporterEvent $event) { + config_import_create_snapshot($this->sourceStorage, $this->snapshotStorage); + } + + /** + * Registers the methods in this class that should be listeners. + * + * @return array + * An array of event listener definitions. + */ + static function getSubscribedEvents() { + $events['config.importer.import'][] = array('onConfigImporterImport', 40); + return $events; + } + +} diff --git a/core/modules/config/config.admin.inc b/core/modules/config/config.admin.inc index 57704de..b6542c5 100644 --- a/core/modules/config/config.admin.inc +++ b/core/modules/config/config.admin.inc @@ -5,9 +5,10 @@ * Admin page callbacks for the config module. */ -use Drupal\Core\Config\StorageInterface; use Drupal\Core\Ajax\AjaxResponse; use Drupal\Core\Ajax\OpenModalDialogCommand; +use Drupal\Core\Config\ConfigException; +use Drupal\Core\Config\StorageInterface; /** * Helper function to construct the storage changes in a configuration synchronization form. @@ -21,7 +22,7 @@ * @param Drupal\Core\Config\StorageInterface $target_storage * The target storage to compare differences to. */ -function config_admin_sync_form(array &$form, array &$form_state, StorageInterface $source_storage, StorageInterface $target_storage) { +function config_admin_sync_form(array &$form, array &$form_state, StorageInterface $source_storage) { $source_list = $source_storage->listAll(); if (empty($source_list)) { $form['no_changes'] = array( @@ -31,18 +32,20 @@ function config_admin_sync_form(array &$form, array &$form_state, StorageInterfa return $form; } - $config_changes = config_sync_get_changes($source_storage, $target_storage); - if (empty($config_changes)) { + + $config_import = Drupal::service('config.importer'); + if (!$config_import->hasChanges()) { $form['no_changes'] = array( '#markup' => t('There are no configuration changes.'), ); + $form['actions']['#access'] = FALSE; return $form; } // Add the AJAX library to the form for dialog support. $form['#attached']['library'][] = array('system', 'drupal.ajax'); - foreach ($config_changes as $config_change_type => $config_files) { + foreach ($config_import->getStorageComparer()->getChangelist() as $config_change_type => $config_files) { if (empty($config_files)) { continue; } @@ -58,7 +61,7 @@ function config_admin_sync_form(array &$form, array &$form_state, StorageInterfa $form[$config_change_type]['heading']['#value'] = format_plural(count($config_files), '@count new', '@count new'); break; - case 'change': + case 'update': $form[$config_change_type]['heading']['#value'] = format_plural(count($config_files), '@count changed', '@count changed'); break; @@ -122,23 +125,30 @@ function config_admin_import_form($form, &$form_state) { * Form submission handler for config_admin_import_form(). */ function config_admin_import_form_submit($form, &$form_state) { - if (!lock()->lockMayBeAvailable(CONFIG_IMPORT_LOCK)) { + if (Drupal::service('config.importer')->alreadyImporting()) { drupal_set_message(t('Another request may be synchronizing configuration already.')); } - else if (config_import()) { - // Once a sync completes, we empty the staging directory. This prevents - // changes from being accidentally overwritten by stray files getting - // imported later. - $source_storage = drupal_container()->get('config.storage.staging'); - foreach ($source_storage->listAll() as $name) { - $source_storage->delete($name); - } + else{ + try { + Drupal::service('config.importer')->import(); + drupal_flush_all_caches(); + drupal_set_message(t('The configuration was imported successfully.')); - drupal_flush_all_caches(); - - drupal_set_message(t('The configuration was imported successfully.')); - } - else { - drupal_set_message(t('The import failed due to an error. Any errors have been logged.'), 'error'); + // Once a sync completes, we empty the staging directory. This prevents + // changes from being accidentally overwritten by stray files getting + // imported later. + $source_storage = Drupal::service('config.importer')->getStorageComparer()->getSourceStorage(); + foreach ($source_storage->listAll() as $name) { + $source_storage->delete($name); + } + } + catch (ConfigException $e) { + // Return a negative result for UI purposes. We do not differentiate between + // an actual synchronization error and a failed lock, because concurrent + // synchronizations are an edge-case happening only when multiple developers + // or site builders attempt to do it without coordinating. + watchdog_exception('config_import', $e); + drupal_set_message(t('The import failed due to an error. Any errors have been logged.'), 'error'); + } } } diff --git a/core/modules/config/lib/Drupal/config/Tests/ConfigCRUDTest.php b/core/modules/config/lib/Drupal/config/Tests/ConfigCRUDTest.php index 497fd52..4d8ed83 100644 --- a/core/modules/config/lib/Drupal/config/Tests/ConfigCRUDTest.php +++ b/core/modules/config/lib/Drupal/config/Tests/ConfigCRUDTest.php @@ -14,6 +14,14 @@ * Tests CRUD operations on configuration objects. */ class ConfigCRUDTest extends DrupalUnitTestBase { + + /** + * Modules to enable. + * + * @var array + */ + public static $modules = array('system'); + public static function getInfo() { return array( 'name' => 'CRUD operations', @@ -193,8 +201,15 @@ function testNameValidation() { $manifest_data['new']['name'] = 'invalid'; $staging->write('manifest.invalid_object_name', $manifest_data); - // Assert that config_import returns false indicating a failure. - $this->assertFalse(config_import(), "Config import failed when trying to importing an object with an invalid name"); + // Verify that an exception is thrown when importing. + $message = 'Expected ConfigNameException was thrown when attempting to sync invalid configuration.'; + try { + $this->container->get('config.importer')->import(); + $this->fail($message); + } + catch (ConfigNameException $e) { + $this->pass($message); + } } } diff --git a/core/modules/config/lib/Drupal/config/Tests/ConfigImportTest.php b/core/modules/config/lib/Drupal/config/Tests/ConfigImportTest.php index 03fda2a..f5ed2f3 100644 --- a/core/modules/config/lib/Drupal/config/Tests/ConfigImportTest.php +++ b/core/modules/config/lib/Drupal/config/Tests/ConfigImportTest.php @@ -2,7 +2,7 @@ /** * @file - * Definition of Drupal\config\Tests\ConfigImportTest. + * Contains \Drupal\config\Tests\ConfigImporterTest. */ namespace Drupal\config\Tests; @@ -12,7 +12,14 @@ /** * Tests importing configuration from files into active configuration. */ -class ConfigImportTest extends DrupalUnitTestBase { +class ConfigImporterTest extends DrupalUnitTestBase { + + /** + * Config Importer object used for testing. + * + * @var \Drupal\Core\Config\ConfigImporter + */ + protected $configImporter; /** * Modules to enable. @@ -39,6 +46,9 @@ function setUp() { // variable being used for recording hook invocations by this test already, // so it has to be cleared out manually. unset($GLOBALS['hook_config_test']); + + // Set up the ConfigImporter object for testing. + $this->configImporter = $this->container->get('config.importer'); } /** @@ -70,7 +80,7 @@ function testDeleted() { // Create an empty manifest to delete the configuration object. $staging->write('manifest.config_test.dynamic', array()); // Import. - config_import(); + $this->configImporter->reset()->import(); // Verify the values have disappeared. $this->assertIdentical($storage->read($dynamic_name), FALSE); @@ -87,7 +97,7 @@ function testDeleted() { $this->assertTrue(isset($GLOBALS['hook_config_test']['delete'])); // Verify that there is nothing more to import. - $this->assertFalse(config_sync_get_changes($staging, $storage)); + $this->assertFalse($this->configImporter->hasChanges()); } /** @@ -123,7 +133,7 @@ function testNew() { $this->assertIdentical($staging->exists($dynamic_name), TRUE, $dynamic_name . ' found.'); // Import. - config_import(); + $this->configImporter->reset()->import(); // Verify the values appeared. $config = config($dynamic_name); @@ -138,7 +148,7 @@ function testNew() { $this->assertFalse(isset($GLOBALS['hook_config_test']['delete'])); // Verify that there is nothing more to import. - $this->assertFalse(config_sync_get_changes($staging, $storage)); + $this->assertFalse($this->configImporter->hasChanges()); } /** @@ -174,7 +184,7 @@ function testUpdated() { $this->assertIdentical($config->get('label'), 'Default'); // Import. - config_import(); + $this->configImporter->reset()->import(); // Verify the values were updated. $config = config($name); @@ -195,7 +205,7 @@ function testUpdated() { $this->assertFalse(isset($GLOBALS['hook_config_test']['delete'])); // Verify that there is nothing more to import. - $this->assertFalse(config_sync_get_changes($staging, $storage)); + $this->assertFalse($this->configImporter->hasChanges()); } } diff --git a/core/modules/config/lib/Drupal/config/Tests/ConfigImportUITest.php b/core/modules/config/lib/Drupal/config/Tests/ConfigImportUITest.php index cf87bb3..1c1789a 100644 --- a/core/modules/config/lib/Drupal/config/Tests/ConfigImportUITest.php +++ b/core/modules/config/lib/Drupal/config/Tests/ConfigImportUITest.php @@ -112,7 +112,8 @@ function testImportLock() { $this->assertNoText(t('There are no configuration changes.')); // Acquire a fake-lock on the import mechanism. - lock()->acquire('config_import'); + $config_importer_lock = $this->container->get('config.importer')->getServiceName(); + lock()->acquire($config_importer_lock); // Attempt to import configuration and verify that an error message appears. $this->drupalPost(NULL, array(), t('Import all')); @@ -120,7 +121,7 @@ function testImportLock() { $this->assertText(t('Another request may be synchronizing configuration already.')); // Release the lock, just to keep testing sane. - lock()->release('config_import'); + lock()->release($config_importer_lock); // Verify site name has not changed. $this->assertNotEqual($new_site_name, config('system.site')->get('name')); diff --git a/core/modules/config/lib/Drupal/config/Tests/ConfigOverrideTest.php b/core/modules/config/lib/Drupal/config/Tests/ConfigOverrideTest.php index 6dfcf4e..f86c74a 100644 --- a/core/modules/config/lib/Drupal/config/Tests/ConfigOverrideTest.php +++ b/core/modules/config/lib/Drupal/config/Tests/ConfigOverrideTest.php @@ -118,7 +118,7 @@ function testConfOverride() { $staging->write('config_test.system', $expected_new_data); // Import changed data from staging to active. - config_import(); + $this->container->get('config.importer')->import(); $data = $active->read('config_test.system'); // Verify that the new configuration data exists. Have to read storage diff --git a/core/modules/config/lib/Drupal/config/Tests/ConfigSnapshotTest.php b/core/modules/config/lib/Drupal/config/Tests/ConfigSnapshotTest.php index 439f191..266f9cb 100644 --- a/core/modules/config/lib/Drupal/config/Tests/ConfigSnapshotTest.php +++ b/core/modules/config/lib/Drupal/config/Tests/ConfigSnapshotTest.php @@ -7,6 +7,7 @@ namespace Drupal\config\Tests; +use Drupal\Core\Config\StorageComparer; use Drupal\simpletest\DrupalUnitTestBase; /** @@ -45,21 +46,24 @@ function testSnapshot() { $config_key = 'foo'; $new_data = 'foobar'; + $active_snapshot_comparer = new StorageComparer($active, $snapshot); + $staging_snapshot_comparer = new StorageComparer($staging, $snapshot); + // Verify that we have an initial snapshot that matches the active // configuration. This has to be true as no config should be installed. - $this->assertFalse(config_sync_get_changes($snapshot, $active, FALSE)); + $this->assertFalse($active_snapshot_comparer->createChangelist()->hasChanges()); // Install the default config. config_install_default_config('module', 'config_test'); // Although we have imported config this has not affected the snapshot. - $this->assertTrue(config_sync_get_changes($snapshot, $active, FALSE)); + $this->assertTrue($active_snapshot_comparer->reset()->hasChanges()); // Update the config snapshot. config_import_create_snapshot($active, $snapshot); // The snapshot and active config should now contain the same config // objects. - $this->assertFalse(config_sync_get_changes($snapshot, $active, FALSE)); + $this->assertFalse($active_snapshot_comparer->reset()->hasChanges()); // Change a configuration value in staging. $staging_data = config($config_name)->get(); @@ -67,20 +71,19 @@ function testSnapshot() { $staging->write($config_name, $staging_data); // Verify that active and snapshot match, and that staging doesn't match - // either of them. - $this->assertFalse(config_sync_get_changes($snapshot, $active, FALSE)); - $this->assertTrue(config_sync_get_changes($snapshot, $staging, FALSE)); - $this->assertTrue(config_sync_get_changes($staging, $active, FALSE)); + // active. + $this->assertFalse($active_snapshot_comparer->reset()->hasChanges()); + $this->assertTrue($staging_snapshot_comparer->createChangelist()->hasChanges()); // Import changed data from staging to active. - config_import(); + $this->container->get('config.importer')->import(); // Verify changed config was properly imported. $this->assertIdentical(config($config_name)->get($config_key), $new_data); // Verify that a new snapshot was created which and that it matches // the active config. - $this->assertFalse(config_sync_get_changes($snapshot, $active, FALSE)); + $this->assertFalse($active_snapshot_comparer->reset()->hasChanges()); } } diff --git a/core/modules/config/tests/config_test/lib/Drupal/config_test/ConfigTestStorageController.php b/core/modules/config/tests/config_test/lib/Drupal/config_test/ConfigTestStorageController.php index e1fe4fe..a73cffb 100644 --- a/core/modules/config/tests/config_test/lib/Drupal/config_test/ConfigTestStorageController.php +++ b/core/modules/config/tests/config_test/lib/Drupal/config_test/ConfigTestStorageController.php @@ -26,13 +26,13 @@ public function importCreate($name, Config $new_config, Config $old_config) { } /** - * Overrides \Drupal\Core\Config\Entity\ConfigStorageController::importChange(). + * Overrides \Drupal\Core\Config\Entity\ConfigStorageController::importUpdate(). */ - public function importChange($name, Config $new_config, Config $old_config) { + public function importUpdate($name, Config $new_config, Config $old_config) { // Set a global value we can check in test code. $GLOBALS['hook_config_import'] = __METHOD__; - return parent::importChange($name, $new_config, $old_config); + return parent::importUpdate($name, $new_config, $old_config); } /** diff --git a/core/modules/field/lib/Drupal/field/Tests/FieldImportChangeTest.php b/core/modules/field/lib/Drupal/field/Tests/FieldImportChangeTest.php index aaf648d..53e94a2 100644 --- a/core/modules/field/lib/Drupal/field/Tests/FieldImportChangeTest.php +++ b/core/modules/field/lib/Drupal/field/Tests/FieldImportChangeTest.php @@ -54,7 +54,7 @@ function testImportChange() { $staging->write($instance_config_name, $instance); // Import the content of the staging directory. - config_import(); + $this->container->get('config.importer')->import(); // Check that the updated config was correctly imported. $instance = entity_load('field_instance', $instance_id); diff --git a/core/modules/field/lib/Drupal/field/Tests/FieldImportCreateTest.php b/core/modules/field/lib/Drupal/field/Tests/FieldImportCreateTest.php index ff21fac..b367b9c 100644 --- a/core/modules/field/lib/Drupal/field/Tests/FieldImportCreateTest.php +++ b/core/modules/field/lib/Drupal/field/Tests/FieldImportCreateTest.php @@ -69,7 +69,7 @@ function testImportCreate() { $staging->write($instance_manifest_name, $instance_manifest); // Import the content of the staging directory. - config_import(); + $this->container->get('config.importer')->import(); // Check that the field and instance were created. $field = entity_load('field_entity', $field_id); diff --git a/core/modules/field/lib/Drupal/field/Tests/FieldImportDeleteTest.php b/core/modules/field/lib/Drupal/field/Tests/FieldImportDeleteTest.php index 0db6455..a9d1e52 100644 --- a/core/modules/field/lib/Drupal/field/Tests/FieldImportDeleteTest.php +++ b/core/modules/field/lib/Drupal/field/Tests/FieldImportDeleteTest.php @@ -66,7 +66,7 @@ function testImportDelete() { $staging->write($instance_manifest_name, $instance_manifest); // Import the content of the staging directory. - config_import(); + $this->container->get('config.importer')->import(); // Check that the field and instance are gone. $field = entity_load('field_entity', $field_id, TRUE); diff --git a/core/modules/field/lib/Drupal/field/Tests/FieldUnitTestBase.php b/core/modules/field/lib/Drupal/field/Tests/FieldUnitTestBase.php index 223e0ac..23f5269 100644 --- a/core/modules/field/lib/Drupal/field/Tests/FieldUnitTestBase.php +++ b/core/modules/field/lib/Drupal/field/Tests/FieldUnitTestBase.php @@ -38,8 +38,8 @@ function setUp() { $this->installSchema('entity_test', 'entity_test'); $this->installSchema('field_test', array('test_entity', 'test_entity_revision', 'test_entity_bundle')); - // Set default storage backend. - $this->installConfig(array('field')); + // Set default storage backend and configure the theme system. + $this->installConfig(array('field', 'system')); } /** diff --git a/core/modules/image/lib/Drupal/image/Tests/ImageAdminStylesTest.php b/core/modules/image/lib/Drupal/image/Tests/ImageAdminStylesTest.php index 4cb1dca..308dbf3 100644 --- a/core/modules/image/lib/Drupal/image/Tests/ImageAdminStylesTest.php +++ b/core/modules/image/lib/Drupal/image/Tests/ImageAdminStylesTest.php @@ -367,7 +367,7 @@ function testConfigImport() { unset($manifest_data[$style_name]); $staging = $this->container->get('config.storage.staging'); $staging->write('manifest.image.style', $manifest_data); - config_import(); + $this->container->get('config.importer')->import(); $this->assertFalse(entity_load('image_style', $style_name), 'Style deleted after config import.'); $this->assertEqual($this->getImageCount($style), 0, 'Image style was flushed after being deleted by config import.'); diff --git a/core/modules/system/lib/Drupal/system/Tests/Database/RegressionTest.php b/core/modules/system/lib/Drupal/system/Tests/Database/RegressionTest.php index 4ad4417..f38b49f 100644 --- a/core/modules/system/lib/Drupal/system/Tests/Database/RegressionTest.php +++ b/core/modules/system/lib/Drupal/system/Tests/Database/RegressionTest.php @@ -12,6 +12,13 @@ */ class RegressionTest extends DatabaseTestBase { + /** + * Modules to enable. + * + * @var array + */ + public static $modules = array('node'); + public static function getInfo() { return array( 'name' => 'Regression tests', diff --git a/core/modules/text/lib/Drupal/text/Tests/Formatter/TextPlainUnitTest.php b/core/modules/text/lib/Drupal/text/Tests/Formatter/TextPlainUnitTest.php index 7126384..9530fd8 100644 --- a/core/modules/text/lib/Drupal/text/Tests/Formatter/TextPlainUnitTest.php +++ b/core/modules/text/lib/Drupal/text/Tests/Formatter/TextPlainUnitTest.php @@ -25,7 +25,7 @@ class TextPlainUnitTest extends DrupalUnitTestBase { * * @var array */ - public static $modules = array('entity', 'field', 'field_sql_storage', 'text', 'field_test'); + public static $modules = array('system', 'entity', 'field', 'field_sql_storage', 'text', 'field_test'); /** * Contains rendered content. @@ -45,7 +45,8 @@ public static function getInfo() { function setUp() { parent::setUp(); - $this->installConfig(array('field')); + // Configure the theme system. + $this->installConfig(array('system', 'field')); // @todo Add helper methods for all of the following. diff --git a/core/modules/views/lib/Drupal/views/Tests/ViewTestData.php b/core/modules/views/lib/Drupal/views/Tests/ViewTestData.php index cf2c0d8..94ae416 100644 --- a/core/modules/views/lib/Drupal/views/Tests/ViewTestData.php +++ b/core/modules/views/lib/Drupal/views/Tests/ViewTestData.php @@ -7,6 +7,8 @@ namespace Drupal\views\Tests; +use Drupal\Core\Config\ConfigImporter; +use Drupal\Core\Config\StorageComparer; use Drupal\Core\Config\FileStorage; /** @@ -39,13 +41,6 @@ public static function importTestViews($class, $modules = array()) { $class = get_parent_class($class); } if (!empty($views)) { - $target_storage = drupal_container()->get('config.storage'); - $config_changes = array( - 'delete' => array(), - 'create' => array(), - 'change' => array(), - ); - $module_handler = \Drupal::moduleHandler(); foreach ($modules as $module) { $config_dir = drupal_get_path('module', $module) . '/test_views'; @@ -54,16 +49,28 @@ public static function importTestViews($class, $modules = array()) { } $source_storage = new FileStorage($config_dir); + // Only import views used by test. + $views_to_import = array(); foreach ($source_storage->listAll('views.view.') as $config_name) { $id = str_replace('views.view.', '', $config_name); if (in_array($id, $views)) { - $config_changes['create'][] = $config_name; + $views_to_import[] = $config_name; } } - } - if (!empty($config_changes['create'])) { - $remaining_changes = config_import_invoke_owner($config_changes, $source_storage, $target_storage); - config_sync_changes($remaining_changes, $source_storage, $target_storage); + $storage_comparer = new StorageComparer( + $source_storage, + \Drupal::service('config.storage') + ); + $storage_comparer->addChangelist('create', $views_to_import); + $installer = new ConfigImporter( + 'views.test.installer', + $storage_comparer, + \Drupal::service('event_dispatcher'), + \Drupal::service('config.factory'), + \Drupal::entityManager(), + \Drupal::lock() + ); + $installer->import(); } } } diff --git a/core/modules/views/lib/Drupal/views/Tests/ViewUnitTestBase.php b/core/modules/views/lib/Drupal/views/Tests/ViewUnitTestBase.php index 80b659c..134b97a 100644 --- a/core/modules/views/lib/Drupal/views/Tests/ViewUnitTestBase.php +++ b/core/modules/views/lib/Drupal/views/Tests/ViewUnitTestBase.php @@ -29,7 +29,7 @@ * * @var array */ - public static $modules = array('views', 'views_test_config', 'views_test_data'); + public static $modules = array('system', 'views', 'views_test_config', 'views_test_data'); protected function setUp() { parent::setUp(); @@ -62,6 +62,9 @@ protected function setUpFixtures() { } $query->execute(); + // Tests implementing ViewUnitTestBase depend on the theme system being + // properly configured. + $this->installConfig(array('system')); ViewTestData::importTestViews(get_class($this), array('views_test_config')); }