2994689 Allow disabling indexes

elasticsearch_helper.services.yml

@@ -13,7 +13,7 @@ services:
 
   plugin.manager.elasticsearch_index.processor:
     class: Drupal\elasticsearch_helper\Plugin\ElasticsearchIndexManager
-    arguments: ['@container.namespaces', '@cache.discovery', '@module_handler', '@entity_type.manager', '@queue', '@logger.factory']
+    arguments: ['@container.namespaces', '@cache.discovery', '@module_handler', '@entity_type.manager', '@queue', '@logger.factory', '@config.factory']
 
   elasticsearch_helper.type_event_subscriber:
     class: Drupal\elasticsearch_helper\EventSubscriber\TypeEventSubscriber

src/Plugin/ElasticsearchIndexManager.php

@@ -2,6 +2,7 @@
 
 namespace Drupal\elasticsearch_helper\Plugin;
 
+use Drupal\Core\Config\ConfigFactory;
 use Drupal\Core\Entity\EntityInterface;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Logger\LoggerChannelFactoryInterface;
@@ -34,6 +35,11 @@ class ElasticsearchIndexManager extends DefaultPluginManager {
    */
   protected $logger;
 
+  /**
+   * @var \Drupal\Core\Config\Config|\Drupal\Core\Config\ImmutableConfig
+   */
+  protected $config;
+
   /**
    * Constructor for ElasticsearchIndexManager objects.
    *
@@ -50,15 +56,18 @@ class ElasticsearchIndexManager extends DefaultPluginManager {
    *   Queue factory.
    * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_factory
    *   Logger factory.
+   * @param \Drupal\Core\Config\ConfigFactory $config_factory
+   *   Config factory service.
    */
-  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, EntityTypeManagerInterface $entity_type_manager, QueueFactory $queue_factory, LoggerChannelFactoryInterface $logger_factory) {
+  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, EntityTypeManagerInterface $entity_type_manager, QueueFactory $queue_factory, LoggerChannelFactoryInterface $logger_factory, ConfigFactory $config_factory) {
     parent::__construct('Plugin/ElasticsearchIndex', $namespaces, $module_handler, 'Drupal\elasticsearch_helper\Plugin\ElasticsearchIndexInterface', 'Drupal\elasticsearch_helper\Annotation\ElasticsearchIndex');
 
     $this->alterInfo('elasticsearch_helper_elasticsearch_index_info');
     $this->setCacheBackend($cache_backend, 'elasticsearch_helper_elasticsearch_index_plugins');
     $this->entityTypeManager = $entity_type_manager;
     $this->queue = $queue_factory->get('elasticsearch_helper_indexing');
     $this->logger = $logger_factory->get('elasticsearch_helper');
+    $this->config = $config_factory->get('elasticsearch_helper.settings');
   }
 
   /**
@@ -70,6 +79,10 @@ public function __construct(\Traversable $namespaces, CacheBackendInterface $cac
    */
   public function indexEntity(EntityInterface $entity) {
     foreach ($this->getDefinitions() as $plugin) {
+      if (!$this->indexIsEnabled($plugin['id'])) {
+        continue;
+      }
+
       if (isset($plugin['entityType']) && $entity->getEntityTypeId() == $plugin['entityType']) {
         if (!empty($plugin['bundle']) && $plugin['bundle'] != $entity->bundle()) {
           // Do not index if defined plugin bundle differs from entity bundle.
@@ -100,6 +113,10 @@ public function indexEntity(EntityInterface $entity) {
    */
   public function deleteEntity(EntityInterface $entity) {
     foreach ($this->getDefinitions() as $plugin) {
+      if (!$this->indexIsEnabled($plugin['id'])) {
+        continue;
+      }
+
       if (isset($plugin['entityType']) && $entity->getEntityTypeId() == $plugin['entityType']) {
         if (!empty($plugin['bundle']) && $plugin['bundle'] != $entity->bundle()) {
           // Do not delete if defined plugin bundle differs from entity bundle.
@@ -130,6 +147,10 @@ public function deleteEntity(EntityInterface $entity) {
    */
   public function reindex($indices = [], array $context = []) {
     foreach ($this->getDefinitions() as $definition) {
+      if (!$this->indexIsEnabled($definition['id'])) {
+        continue;
+      }
+
       if (empty($indices) || in_array($definition['id'], $indices)) {
         /** @var \Drupal\elasticsearch_helper\Plugin\ElasticsearchIndexInterface $plugin */
         $plugin = $this->createInstance($definition['id']);
@@ -184,4 +205,21 @@ public function addToQueue($entity_type, $entity_id) {
     ]);
   }
 
+  /**
+   * Check whether an index is enabled according to configuration.
+   *
+   * @param string $index
+   *   Id of the index to check.
+   *
+   * @return bool
+   *   Whether the index should be considered enabled.
+   */
+  public function indexIsEnabled($index) {
+    $index_statuses = $this->config->get('index_statuses');
+
+    // When an index is not yet known in configuration, we default to enabling
+    // it.
+    return isset($index_statuses[$index]) ? $index_statuses[$index] : TRUE;
+  }
+
 }