diff --git a/core/core.services.yml b/core/core.services.yml index 5959c44..4f204b5 100644 --- a/core/core.services.yml +++ b/core/core.services.yml @@ -719,7 +719,9 @@ services: - [setContainer, ['@service_container']] entity.query.config: class: Drupal\Core\Config\Entity\Query\QueryFactory - arguments: ['@config.factory'] + arguments: ['@config.factory', '@keyvalue', '@config.manager'] + tags: + - { name: event_subscriber } entity.query.sql: class: Drupal\Core\Entity\Query\Sql\QueryFactory arguments: ['@database'] diff --git a/core/lib/Drupal/Core/Config/Entity/ConfigEntityType.php b/core/lib/Drupal/Core/Config/Entity/ConfigEntityType.php index 0cb9772..3287511 100644 --- a/core/lib/Drupal/Core/Config/Entity/ConfigEntityType.php +++ b/core/lib/Drupal/Core/Config/Entity/ConfigEntityType.php @@ -35,6 +35,13 @@ class ConfigEntityType extends EntityType implements ConfigEntityTypeInterface { protected $static_cache = FALSE; /** + * Keys that are denormalised into a key value store for fast lookup. + * + * @var array + */ + protected $lookup_keys = []; + + /** * {@inheritdoc} * * @throws \Drupal\Core\Config\Entity\Exception\ConfigEntityStorageClassException @@ -58,6 +65,7 @@ public function __construct($definition) { $this->handlers += array( 'storage' => 'Drupal\Core\Config\Entity\ConfigEntityStorage', ); + $this->lookup_keys[] = 'uuid'; } /** @@ -146,4 +154,11 @@ protected function checkStorageClass($class) { } } + /** + * {@inheritdoc} + */ + public function getLookupKeys() { + return $this->lookup_keys; + } + } diff --git a/core/lib/Drupal/Core/Config/Entity/ConfigEntityTypeInterface.php b/core/lib/Drupal/Core/Config/Entity/ConfigEntityTypeInterface.php index a24c96f..a465a53 100644 --- a/core/lib/Drupal/Core/Config/Entity/ConfigEntityTypeInterface.php +++ b/core/lib/Drupal/Core/Config/Entity/ConfigEntityTypeInterface.php @@ -61,4 +61,12 @@ */ public function getConfigPrefix(); + /** + * Gets the keys that are available for fast lookup. + * + * @return array + * The list of lookup keys. + */ + public function getLookupKeys(); + } diff --git a/core/lib/Drupal/Core/Config/Entity/Query/Query.php b/core/lib/Drupal/Core/Config/Entity/Query/Query.php index 2ad4db5..f79656c 100644 --- a/core/lib/Drupal/Core/Config/Entity/Query/Query.php +++ b/core/lib/Drupal/Core/Config/Entity/Query/Query.php @@ -11,6 +11,8 @@ use Drupal\Core\Entity\EntityTypeInterface; use Drupal\Core\Entity\Query\QueryBase; use Drupal\Core\Entity\Query\QueryInterface; +use Drupal\Core\KeyValueStore\KeyValueFactoryInterface; +use Drupal\Core\KeyValueStore\KeyValueStoreInterface; /** * Defines the entity query for configuration entities. @@ -18,6 +20,13 @@ class Query extends QueryBase implements QueryInterface { /** + * Information about the entity type. + * + * @var \Drupal\Core\Config\Entity\ConfigEntityTypeInterface + */ + protected $entityType; + + /** * The config factory used by the config entity query. * * @var \Drupal\Core\Config\ConfigFactoryInterface @@ -25,6 +34,20 @@ class Query extends QueryBase implements QueryInterface { protected $configFactory; /** + * The config key store. + * + * @var \Drupal\Core\KeyValueStore\KeyValueStoreInterface + */ + protected $configKeyStore; + + /** + * The key value factory. + * + * @var \Drupal\Core\KeyValueStore\KeyValueFactoryInterface + */ + protected $keyValueFactory; + + /** * Constructs a Query object. * * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type @@ -34,12 +57,15 @@ class Query extends QueryBase implements QueryInterface { * - OR: at least one of the conditions on the query need to match. * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory * The config factory. + * @param \Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value_factory + * The key value factory. * @param array $namespaces * List of potential namespaces of the classes belonging to this query. */ - function __construct(EntityTypeInterface $entity_type, $conjunction, ConfigFactoryInterface $config_factory, array $namespaces) { + function __construct(EntityTypeInterface $entity_type, $conjunction, ConfigFactoryInterface $config_factory, KeyValueFactoryInterface $key_value_factory, array $namespaces) { parent::__construct($entity_type, $conjunction, $namespaces); $this->configFactory = $config_factory; + $this->keyValueFactory = $key_value_factory; } /** @@ -108,37 +134,47 @@ protected function loadRecords() { $prefix = $this->entityType->getConfigPrefix() . '.'; $prefix_length = strlen($prefix); - // Search the conditions for restrictions on entity IDs. - $ids = array(); + // Search the conditions for restrictions on configuration object names. + $names = FALSE; if ($this->condition->getConjunction() == 'AND') { - foreach ($this->condition->conditions() as $condition) { - if (is_string($condition['field']) && $condition['field'] == $this->entityType->getKey('id')) { - $operator = $condition['operator'] ?: (is_array($condition['value']) ? 'IN' : '='); - if ($operator == '=') { - $ids = array($condition['value']); - } - elseif ($operator == 'IN') { - $ids = $condition['value']; + $lookup_keys = $this->entityType->getLookupKeys(); + $conditions = $this->condition->conditions(); + foreach ($conditions as $condition_key =>$condition) { + $operator = $condition['operator'] ?: (is_array($condition['value']) ? 'IN' : '='); + if (is_string($condition['field']) && ($operator == 'IN' || $operator == '=')) { + // Special case ID lookups. + if ($condition['field'] == $this->entityType->getKey('id')) { + $ids = (array) $condition['value']; + $names = array_map(function ($id) use ($prefix) { + return $prefix . $id; + }, $ids); } - // We stop at the first restricting condition on ID. In the (weird) - // case where there are additional restricting conditions, results - // will be eliminated when the conditions are checked on the loaded - // records. - if ($ids) { - break; + elseif (in_array($condition['field'], $lookup_keys)) { + // If we don't find anything then there are no matches. No point in + // listing anything. + $names = array(); + $keys = (array) $condition['value']; + $keys = array_map(function ($value) use ($condition) { + return $condition['field'] . ':' . $value; + }, $keys); + foreach ($this->getConfigKeyStore()->getMultiple($keys) as $list) { + $names = array_merge($names, $list); + } } } + // We stop at the first restricting condition on name. In the case where + // there are additional restricting conditions, results will be + // eliminated when the conditions are checked on the loaded records. + if ($names !== FALSE) { + // If the condition has been responsible for narrowing the list of + // configuration to check there is no point in checking it further. + unset($conditions[$condition_key]); + break; + } } } - // If there are conditions restricting config ID, we can narrow the list of - // records to load and parse. - if ($ids) { - $names = array_map(function ($id) use ($prefix) { - return $prefix . $id; - }, $ids); - } // If no restrictions on IDs were found, we need to parse all records. - else { + if ($names === FALSE) { $names = $this->configFactory->listAll($prefix); } @@ -150,4 +186,17 @@ protected function loadRecords() { return $records; } + /** + * Gets the key value store used to store fast lookups. + * + * @return \Drupal\Core\KeyValueStore\KeyValueStoreInterface + * The key value store used to store fast lookups. + */ + protected function getConfigKeyStore() { + if (!isset($this->configKeyStore)) { + $this->configKeyStore = $this->keyValueFactory->get(QueryFactory::CONFIG_LOOKUP_PREFIX . $this->entityTypeId); + } + return $this->configKeyStore; + } + } diff --git a/core/lib/Drupal/Core/Config/Entity/Query/QueryFactory.php b/core/lib/Drupal/Core/Config/Entity/Query/QueryFactory.php index 78d38f9..52f16be 100644 --- a/core/lib/Drupal/Core/Config/Entity/Query/QueryFactory.php +++ b/core/lib/Drupal/Core/Config/Entity/Query/QueryFactory.php @@ -7,17 +7,28 @@ namespace Drupal\Core\Config\Entity\Query; +use Drupal\Core\Config\Config; +use Drupal\Core\Config\ConfigCrudEvent; +use Drupal\Core\Config\ConfigEvents; use Drupal\Core\Config\ConfigFactoryInterface; -use Drupal\Core\Entity\EntityManagerInterface; +use Drupal\Core\Config\ConfigManagerInterface; +use Drupal\Core\Config\Entity\ConfigEntityTypeInterface; use Drupal\Core\Entity\EntityTypeInterface; use Drupal\Core\Entity\Query\QueryBase; use Drupal\Core\Entity\Query\QueryException; use Drupal\Core\Entity\Query\QueryFactoryInterface; +use Drupal\Core\KeyValueStore\KeyValueFactoryInterface; +use Symfony\Component\EventDispatcher\EventSubscriberInterface; /** * Provides a factory for creating entity query objects for the config backend. */ -class QueryFactory implements QueryFactoryInterface { +class QueryFactory implements QueryFactoryInterface, EventSubscriberInterface { + + /** + * The prefix for the key value collection for fast lookups. + */ + const CONFIG_LOOKUP_PREFIX = 'config.entity.key_store.'; /** * The config factory used by the config entity query. @@ -36,13 +47,15 @@ class QueryFactory implements QueryFactoryInterface { /** * Constructs a QueryFactory object. * - * @param \Drupal\Core\Config\StorageInterface $config_storage - * The config storage used by the config entity query. * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory * The config storage used by the config entity query. + * @param \Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value + * The key value factory. */ - public function __construct(ConfigFactoryInterface $config_factory) { + public function __construct(ConfigFactoryInterface $config_factory, KeyValueFactoryInterface $key_value, ConfigManagerInterface $config_manager) { $this->configFactory = $config_factory; + $this->keyValueFactory = $key_value; + $this->configManager = $config_manager; $this->namespaces = QueryBase::getNamespaces($this); } @@ -50,7 +63,7 @@ public function __construct(ConfigFactoryInterface $config_factory) { * {@inheritdoc} */ public function get(EntityTypeInterface $entity_type, $conjunction) { - return new Query($entity_type, $conjunction, $this->configFactory, $this->namespaces); + return new Query($entity_type, $conjunction, $this->configFactory, $this->keyValueFactory, $this->namespaces); } /** @@ -60,4 +73,154 @@ public function getAggregate(EntityTypeInterface $entity_type, $conjunction) { throw new QueryException('Aggregation over configuration entities is not supported'); } + /** + * Gets the key value store where denormalized data is stored. + * + * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type + * The entity type. + * + * @return \Drupal\Core\KeyValueStore\KeyValueStoreInterface + * The key value store where denormalized data is stored. + */ + protected function getKeyValueStore(EntityTypeInterface $entity_type) { + return $this->keyValueFactory->get(static::CONFIG_LOOKUP_PREFIX . $entity_type->id()); + } + + /** + * Updates or adds lookup data. + * + * @param \Drupal\Core\Config\Entity\ConfigEntityTypeInterface $entity_type + * The entity type. + * @param \Drupal\Core\Config\Config $config + * The configuration object that is being saved. + */ + protected function updateConfigKeyStore(ConfigEntityTypeInterface $entity_type, Config $config) { + $config_key_store = $this->getKeyValueStore($entity_type); + foreach ($entity_type->getLookupKeys() as $lookup_key) { + foreach($this->getKeys($lookup_key, $config) as $key) { + $values = $config_key_store->get($key, []); + if (!in_array($config->getName(), $values, TRUE)) { + $values[] = $config->getName(); + $config_key_store->set($key, $values); + } + } + } + } + + /** + * Deletes lookup data. + * + * @param \Drupal\Core\Config\Entity\ConfigEntityTypeInterface $entity_type + * The entity type. + * @param \Drupal\Core\Config\Config $config + * The configuration object that is being deleted. + */ + protected function deleteConfigKeyStore(ConfigEntityTypeInterface $entity_type, Config $config) { + $config_key_store = $this->getKeyValueStore($entity_type); + foreach ($entity_type->getLookupKeys() as $lookup_key) { + foreach ($this->getKeys($lookup_key, $config, 'getOriginal') as $key) { + $values = $config_key_store->get($key, []); + if ($pos = array_search($config->getName(), $values, TRUE)) { + unset($values[$pos]); + } + if (empty($values)) { + $config_key_store->delete($key); + } + else { + $config_key_store->set($key, $values); + } + } + } + } + + /** + * Creates lookup keys for configuration data. + * + * @param $key + * The configuration key to look for. + * @param \Drupal\Core\Config\Config $config + * The configuration object. + * @param string $get_method + * Which method on the config object to call to get the value. Defaults to + * 'get'. + * + * @return array + * An array of lookup keys concatenated to their value + */ + protected function getKeys($key, Config $config, $get_method = 'get') { + $parts = explode('.*.', $key); + $values = (array) $this->getValues($config, $parts, $parts[0], $get_method); + return array_map(function($value) use ($key) { return $key . ':' . $value; }, $values); + } + + /** + * Finds all the values for a configuration key in a configuration object. + * + * @param \Drupal\Core\Config\Config $config + * The configuration object. + * @param array $parts + * All the parts of a configuration key we are checking. + * @param string $key + * The current key being checked. + * @param string $get_method + * Which method on the config object to call to get the value. Defaults to + * 'get'. + * @param int $start + * Which position of $parts we are pocessing. + * + * @return array + */ + protected function getValues(Config $config, array $parts, $key, $get_method = 'get', $start = 0) { + $value = $config->$get_method($key); + if (is_array($value)) { + $new_value = []; + $start++; + foreach (array_keys($value) as $key_bit) { + $new_key = $key . '.' . $key_bit . '.' . $parts[$start]; + $new_value[] = $this->getValues($config, $parts, $new_key, $get_method, $start); + } + $value = $new_value; + } + return $value; + } + + /** + * Updates configuration entity in the key store. + * + * @param ConfigCrudEvent $event + * The configuration event. + */ + public function onConfigSave(ConfigCrudEvent $event) { + $saved_config = $event->getConfig(); + $entity_type_id = $this->configManager->getEntityTypeIdByName($saved_config->getName()); + if ($entity_type_id) { + $entity_type = $this->configManager->getEntityManager()->getDefinition($entity_type_id); + $this->updateConfigKeyStore($entity_type, $saved_config); + } + } + + /** + * Removes configuration entity from key store. + * + * @param \Drupal\Core\Config\ConfigCrudEvent $event + * The configuration event. + */ + public function onConfigDelete(ConfigCrudEvent $event) { + $saved_config = $event->getConfig(); + $entity_type_id = $this->configManager->getEntityTypeIdByName($saved_config->getName()); + if ($entity_type_id) { + $entity_type = $this->configManager->getEntityManager()->getDefinition($entity_type_id); + $this->deleteConfigKeyStore($entity_type, $saved_config); + } + } + + /** + * {@inheritdoc} + */ + static function getSubscribedEvents() { + $events[ConfigEvents::SAVE][] = array('onConfigSave', 128); + $events[ConfigEvents::DELETE][] = array('onConfigDelete', 128); + return $events; + } + } diff --git a/core/lib/Drupal/Core/Field/BaseFieldOverrideStorage.php b/core/lib/Drupal/Core/Field/BaseFieldOverrideStorage.php index 0b559ba..04939d8 100644 --- a/core/lib/Drupal/Core/Field/BaseFieldOverrideStorage.php +++ b/core/lib/Drupal/Core/Field/BaseFieldOverrideStorage.php @@ -8,6 +8,7 @@ namespace Drupal\Core\Field; use Drupal\Core\Entity\EntityTypeInterface; +use Drupal\Core\KeyValueStore\KeyValueFactoryInterface; use Drupal\Core\Language\LanguageManagerInterface; use Symfony\Component\DependencyInjection\ContainerInterface; use Drupal\Core\Config\ConfigFactoryInterface; @@ -32,8 +33,8 @@ class BaseFieldOverrideStorage extends FieldConfigStorageBase { * @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager * The field type plugin manager. */ - public function __construct(EntityTypeInterface $entity_type, ConfigFactoryInterface $config_factory, UuidInterface $uuid_service, LanguageManagerInterface $language_manager, FieldTypePluginManagerInterface $field_type_manager) { - parent::__construct($entity_type, $config_factory, $uuid_service, $language_manager); + public function __construct(EntityTypeInterface $entity_type, ConfigFactoryInterface $config_factory, UuidInterface $uuid_service, LanguageManagerInterface $language_manager, KeyValueFactoryInterface $key_value, FieldTypePluginManagerInterface $field_type_manager) { + parent::__construct($entity_type, $config_factory, $uuid_service, $language_manager, $key_value); $this->fieldTypeManager = $field_type_manager; } @@ -46,6 +47,7 @@ public static function createInstance(ContainerInterface $container, EntityTypeI $container->get('config.factory'), $container->get('uuid'), $container->get('language_manager'), + $container->get('keyvalue'), $container->get('plugin.manager.field.field_type') ); } diff --git a/core/modules/block/src/Entity/Block.php b/core/modules/block/src/Entity/Block.php index 4af2f80..d45d2e4 100644 --- a/core/modules/block/src/Entity/Block.php +++ b/core/modules/block/src/Entity/Block.php @@ -38,6 +38,9 @@ * links = { * "delete-form" = "/admin/structure/block/manage/{block}/delete", * "edit-form" = "/admin/structure/block/manage/{block}" + * }, + * lookup_keys = { + * "theme" * } * ) */ diff --git a/core/modules/field/src/FieldConfigStorage.php b/core/modules/field/src/FieldConfigStorage.php index 89ea181..cfa10ca 100644 --- a/core/modules/field/src/FieldConfigStorage.php +++ b/core/modules/field/src/FieldConfigStorage.php @@ -12,6 +12,7 @@ use Drupal\Core\Entity\EntityTypeInterface; use Drupal\Core\Field\FieldConfigStorageBase; use Drupal\Core\Field\FieldTypePluginManagerInterface; +use Drupal\Core\KeyValueStore\KeyValueFactoryInterface; use Drupal\Core\Language\LanguageManagerInterface; use Symfony\Component\DependencyInjection\ContainerInterface; use Drupal\Core\Config\ConfigFactoryInterface; @@ -62,8 +63,8 @@ class FieldConfigStorage extends FieldConfigStorageBase { * @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager * The field type plugin manager. */ - public function __construct(EntityTypeInterface $entity_type, ConfigFactoryInterface $config_factory, UuidInterface $uuid_service, LanguageManagerInterface $language_manager, EntityManagerInterface $entity_manager, StateInterface $state, FieldTypePluginManagerInterface $field_type_manager) { - parent::__construct($entity_type, $config_factory, $uuid_service, $language_manager); + public function __construct(EntityTypeInterface $entity_type, ConfigFactoryInterface $config_factory, UuidInterface $uuid_service, LanguageManagerInterface $language_manager, KeyValueFactoryInterface $key_value, EntityManagerInterface $entity_manager, StateInterface $state, FieldTypePluginManagerInterface $field_type_manager) { + parent::__construct($entity_type, $config_factory, $uuid_service, $language_manager, $key_value); $this->entityManager = $entity_manager; $this->state = $state; $this->fieldTypeManager = $field_type_manager; @@ -78,6 +79,7 @@ public static function createInstance(ContainerInterface $container, EntityTypeI $container->get('config.factory'), $container->get('uuid'), $container->get('language_manager'), + $container->get('keyvalue'), $container->get('entity.manager'), $container->get('state'), $container->get('plugin.manager.field.field_type') diff --git a/core/modules/field/src/FieldStorageConfigStorage.php b/core/modules/field/src/FieldStorageConfigStorage.php index 55800b3..4673f4a 100644 --- a/core/modules/field/src/FieldStorageConfigStorage.php +++ b/core/modules/field/src/FieldStorageConfigStorage.php @@ -13,6 +13,7 @@ use Drupal\Core\Entity\EntityManagerInterface; use Drupal\Core\Entity\EntityTypeInterface; use Drupal\Core\Field\FieldTypePluginManagerInterface; +use Drupal\Core\KeyValueStore\KeyValueFactoryInterface; use Drupal\Core\Language\LanguageManagerInterface; use Symfony\Component\DependencyInjection\ContainerInterface; use Drupal\Core\Config\ConfigFactoryInterface; @@ -72,8 +73,8 @@ class FieldStorageConfigStorage extends ConfigEntityStorage { * @param \Drupal\Component\Plugin\PluginManagerInterface\FieldTypePluginManagerInterface * The field type plugin manager. */ - public function __construct(EntityTypeInterface $entity_type, ConfigFactoryInterface $config_factory, UuidInterface $uuid_service, LanguageManagerInterface $language_manager, EntityManagerInterface $entity_manager, ModuleHandler $module_handler, StateInterface $state, FieldTypePluginManagerInterface $field_type_manager) { - parent::__construct($entity_type, $config_factory, $uuid_service, $language_manager); + public function __construct(EntityTypeInterface $entity_type, ConfigFactoryInterface $config_factory, UuidInterface $uuid_service, LanguageManagerInterface $language_manager, KeyValueFactoryInterface $key_value, EntityManagerInterface $entity_manager, ModuleHandler $module_handler, StateInterface $state, FieldTypePluginManagerInterface $field_type_manager) { + parent::__construct($entity_type, $config_factory, $uuid_service, $language_manager, $key_value); $this->entityManager = $entity_manager; $this->moduleHandler = $module_handler; $this->state = $state; @@ -89,6 +90,7 @@ public static function createInstance(ContainerInterface $container, EntityTypeI $container->get('config.factory'), $container->get('uuid'), $container->get('language_manager'), + $container->get('keyvalue'), $container->get('entity.manager'), $container->get('module_handler'), $container->get('state'), diff --git a/core/modules/shortcut/src/ShortcutSetStorage.php b/core/modules/shortcut/src/ShortcutSetStorage.php index f575856..08e6d98 100644 --- a/core/modules/shortcut/src/ShortcutSetStorage.php +++ b/core/modules/shortcut/src/ShortcutSetStorage.php @@ -12,6 +12,7 @@ use Drupal\Core\Config\Entity\ConfigEntityStorage; use Drupal\Core\Entity\EntityTypeInterface; use Drupal\Core\Extension\ModuleHandlerInterface; +use Drupal\Core\KeyValueStore\KeyValueFactoryInterface; use Drupal\Core\Language\LanguageManagerInterface; use Drupal\Core\Session\AccountInterface; use Symfony\Component\DependencyInjection\ContainerInterface; @@ -44,8 +45,8 @@ class ShortcutSetStorage extends ConfigEntityStorage implements ShortcutSetStora * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager * The language manager. */ - public function __construct(EntityTypeInterface $entity_info, ConfigFactoryInterface $config_factory, UuidInterface $uuid_service, ModuleHandlerInterface $module_handler, LanguageManagerInterface $language_manager) { - parent::__construct($entity_info, $config_factory, $uuid_service, $language_manager); + public function __construct(EntityTypeInterface $entity_info, ConfigFactoryInterface $config_factory, UuidInterface $uuid_service, ModuleHandlerInterface $module_handler, LanguageManagerInterface $language_manager, KeyValueFactoryInterface $key_value) { + parent::__construct($entity_info, $config_factory, $uuid_service, $language_manager, $key_value); $this->moduleHandler = $module_handler; } @@ -59,7 +60,8 @@ public static function createInstance(ContainerInterface $container, EntityTypeI $container->get('config.factory'), $container->get('uuid'), $container->get('module_handler'), - $container->get('language_manager') + $container->get('language_manager'), + $container->get('keyvalue') ); } diff --git a/core/modules/tour/src/Entity/Tour.php b/core/modules/tour/src/Entity/Tour.php index d50caa9..d4204cd 100644 --- a/core/modules/tour/src/Entity/Tour.php +++ b/core/modules/tour/src/Entity/Tour.php @@ -24,6 +24,9 @@ * entity_keys = { * "id" = "id", * "label" = "label" + * }, + * lookup_keys = { + * "routes.*.route_name" * } * ) */