Continuation of #60: Fix Text Overlay configuration using Dependency Injection

config/install/islandora_mirador.settings.yml

@@ -1,4 +1,6 @@
 mirador_library_installation_type: 'remote'
-mirador_enabled_plugins: {  }
+mirador_enabled_plugins: 
+  miradorImageToolsPlugin: miradorImageToolsPlugin
+  textOverlayPlugin: textOverlayPlugin
 iiif_manifest_url: '[node:url:unaliased:absolute]/manifest'
 mirador_library_minified: false

islandora_mirador.module

@@ -42,19 +42,22 @@ function template_preprocess_mirador(&$variables) {
   $config = \Drupal::service('config.factory')
     ->get('islandora_mirador.settings');
 
+  // Add config as cache dependency so changes invalidate the render cache.
+  $variables['#cache']['tags'][] = 'config:islandora_mirador.settings';
+
   $mirador_plugins = $mirador_plugin_manager->getDefinitions();
   $enabled_plugins = $config->get('mirador_enabled_plugins');
   $variables['#attached']['drupalSettings']['mirador']['enabled_plugins'] = array_filter(array_values($enabled_plugins));
 
   $window_config = $variables['window_config'];
   foreach ($mirador_plugins as $plugin_id => $plugin_definition) {
-    if (isset($enabled_plugins[$plugin_id])) {
-      $plugin_instance = $mirador_plugin_manager->createInstance($plugin_id);
-      /**
-       * @var Drupal\islandora_mirador\IslandoraMiradorPluginInterface
-       */
-      $plugin_instance->windowConfigAlter($window_config);
-    }
+
+    // Always call plugins - they will check their own state.
+    /**
+     * @var Drupal\islandora_mirador\IslandoraMiradorPluginInterface
+     */
+    $plugin_instance = $mirador_plugin_manager->createInstance($plugin_id);
+    $plugin_instance->windowConfigAlter($window_config);
   }
 
   // XXX: Maintain the original properties, for now.

islandora_mirador.post_update.php

@@ -0,0 +1,36 @@
+<?php
+
+/**
+ * @file
+ * Post update functions for the module Islandora Mirador.
+ */
+
+/**
+ * Enable plugins by default for existing sites.
+ */
+function islandora_mirador_post_update_enable_plugins() {
+  $config_factory = \Drupal::configFactory();
+  $config = $config_factory->getEditable('islandora_mirador.settings');
+
+  // Get currently enabled plugins. Default to empty array.
+  $enabled_plugins = $config->get('mirador_enabled_plugins');
+  if (!is_array($enabled_plugins)) {
+    $enabled_plugins = [];
+  }
+
+  // The array of plugins we want to be enabled.
+  $plugins_to_add = ['textOverlayPlugin', 'miradorImageToolsPlugin'];
+  $changed = FALSE;
+
+  foreach ($plugins_to_add as $plugin_id) {
+    if (empty($enabled_plugins[$plugin_id])) {
+      $enabled_plugins[$plugin_id] = $plugin_id;
+      $changed = TRUE;
+    }
+  }
+
+  if ($changed) {
+    $config->set('mirador_enabled_plugins', $enabled_plugins);
+    $config->save(TRUE);
+  }
+}

src/Plugin/IslandoraMiradorPlugin/MiradorImageTools.php

@@ -3,6 +3,9 @@
 namespace Drupal\islandora_mirador\Plugin\IslandoraMiradorPlugin;
 
 use Drupal\islandora_mirador\IslandoraMiradorPluginPluginBase;
+use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Plugin implementation of the islandora_mirador.
@@ -13,14 +16,54 @@
  *   description = @Translation("MIrador image manipluation..")
  * )
  */
-class MiradorImageTools extends IslandoraMiradorPluginPluginBase {
+class MiradorImageTools extends IslandoraMiradorPluginPluginBase implements ContainerFactoryPluginInterface {
+  /**
+   * The config factory.
+   *
+   * @var \Drupal\Core\Config\ConfigFactoryInterface
+   */
+  protected $configFactory;
+
+  /**
+   * Constructs a TextOverlay object.
+   *
+   * @param array $configuration
+   *   A configuration array containing information about the plugin instance.
+   * @param string $plugin_id
+   *   The plugin_id for the plugin instance.
+   * @param mixed $plugin_definition
+   *   The plugin implementation definition.
+   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
+   *   The config factory.
+   */
+  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory) {
+    parent::__construct($configuration, $plugin_id, $plugin_definition);
+    $this->configFactory = $config_factory;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+    return new static(
+      $configuration,
+      $plugin_id,
+      $plugin_definition,
+      $container->get('config.factory')
+    );
+  }
 
   /**
    * {@inheritdoc}
    */
   public function windowConfigAlter(array &$windowConfig) {
-    $windowConfig['imageToolsEnabled'] = TRUE;
-    $windowConfig['imageToolsOpen'] = TRUE;
+    // Get the config to check if this plugin is enabled.
+    $config = $this->configFactory->get('islandora_mirador.settings');
+    $enabled_plugins = $config->get('mirador_enabled_plugins');
+
+    $enabled = !empty($enabled_plugins['miradorImageToolsPlugin']);
+    $windowConfig['imageToolsEnabled'] = $enabled;
+    $windowConfig['imageToolsOpen'] = $enabled;
   }
 
 }

src/Plugin/IslandoraMiradorPlugin/TextOverlay.php

@@ -3,6 +3,9 @@
 namespace Drupal\islandora_mirador\Plugin\IslandoraMiradorPlugin;
 
 use Drupal\islandora_mirador\IslandoraMiradorPluginPluginBase;
+use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Plugin implementation of the islandora_mirador.
@@ -13,15 +16,56 @@
  *   description = @Translation("Mirador text overlay plugin for text selection and accessibility.")
  * )
  */
-class TextOverlay extends IslandoraMiradorPluginPluginBase {
+class TextOverlay extends IslandoraMiradorPluginPluginBase implements ContainerFactoryPluginInterface {
+  /**
+   * The config factory.
+   *
+   * @var \Drupal\Core\Config\ConfigFactoryInterface
+   */
+  protected $configFactory;
+
+  /**
+   * Constructs a TextOverlay object.
+   *
+   * @param array $configuration
+   *   A configuration array containing information about the plugin instance.
+   * @param string $plugin_id
+   *   The plugin_id for the plugin instance.
+   * @param mixed $plugin_definition
+   *   The plugin implementation definition.
+   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
+   *   The config factory.
+   */
+  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory) {
+    parent::__construct($configuration, $plugin_id, $plugin_definition);
+    $this->configFactory = $config_factory;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+    return new static(
+      $configuration,
+      $plugin_id,
+      $plugin_definition,
+      $container->get('config.factory')
+    );
+  }
 
   /**
    * {@inheritdoc}
    */
   public function windowConfigAlter(array &$windowConfig) {
+    // Get the config to check if this plugin is enabled.
+    $config = $this->configFactory->get('islandora_mirador.settings');
+    $enabled_plugins = $config->get('mirador_enabled_plugins');
+
+    // Enable config based on the checkbox.
+    $enabled = !empty($enabled_plugins['textOverlayPlugin']);
     $windowConfig['textOverlay'] = [
-      "enabled" => TRUE,
-      "selectable" => TRUE,
+      "enabled" => $enabled,
+      "selectable" => $enabled,
       "visible" => FALSE,
     ];
   }

tests/src/Kernel/IslandoraMiradorPluginManagerTest.php

@@ -31,6 +31,7 @@ class IslandoraMiradorPluginManagerTest extends KernelTestBase {
    */
   protected function setUp(): void {
     parent::setUp();
+    $this->installConfig(['islandora_mirador']);
     $this->pluginManager = $this->container->get('plugin.manager.islandora_mirador');
   }