From d65e25f59cde468e853d46f7023d7ccf43fa9d7f Mon Sep 17 00:00:00 2001
From: Mark Jordan <mark2jordan@gmail.com>
Date: Wed, 26 Jun 2019 12:22:07 -0700
Subject: [PATCH] Create a Context Condition that detects the namespace in the
 PID field (#147)

---
 config/schema/islandora.schema.yml        |  10 ++
 islandora.module                          |   1 +
 src/Plugin/Condition/NodeHadNamespace.php | 187 ++++++++++++++++++++++
 3 files changed, 198 insertions(+)
 create mode 100644 src/Plugin/Condition/NodeHadNamespace.php

diff --git a/config/schema/islandora.schema.yml b/config/schema/islandora.schema.yml
index ade716c3..7b89a25c 100644
--- a/config/schema/islandora.schema.yml
+++ b/config/schema/islandora.schema.yml
@@ -138,6 +138,16 @@ condition.plugin.content_entity_type:
       sequence:
         type: string
 
+condition.plugin.node_had_namespace:
+  type: condition.plugin
+  mapping:
+    namespace:
+      type: text
+      label: 'Namespace'
+    pid_field:
+      type: ignore
+      label: 'PID field'
+
 field.formatter.settings.islandora_image:
   type: mapping
   label: 'Image field display format settings'
diff --git a/islandora.module b/islandora.module
index 3a20e6b2..183adabc 100644
--- a/islandora.module
+++ b/islandora.module
@@ -343,6 +343,7 @@ function islandora_form_block_form_alter(&$form, FormStateInterface $form_state,
   // to alter block layout.
   unset($form['visibility']['content_entity_type']);
   unset($form['visibility']['parent_node_has_term']);
+  unset($form['visibility']['node_had_namespace']);
   unset($form['visibility']['media_has_term']);
   unset($form['visibility']['file_uses_filesystem']);
   unset($form['visibility']['node_has_term']);
diff --git a/src/Plugin/Condition/NodeHadNamespace.php b/src/Plugin/Condition/NodeHadNamespace.php
new file mode 100644
index 00000000..eb0f43d4
--- /dev/null
+++ b/src/Plugin/Condition/NodeHadNamespace.php
@@ -0,0 +1,187 @@
+<?php
+
+namespace Drupal\islandora\Plugin\Condition;
+
+use Drupal\Core\Condition\ConditionPluginBase;
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Entity\EntityTypeManager;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Drupal\islandora\IslandoraUtils;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Provides a Islandora 7.x namespace condition for nodes.
+ *
+ * @Condition(
+ *   id = "node_had_namespace",
+ *   label = @Translation("Node had 7.x namespace"),
+ *   context = {
+ *     "node" = @ContextDefinition("entity:node", required = TRUE , label = @Translation("node"))
+ *   }
+ * )
+ */
+class NodeHadNamespace extends ConditionPluginBase implements ContainerFactoryPluginInterface {
+
+  /**
+   * Islandora utils.
+   *
+   * @var \Drupal\islandora\IslandoraUtils
+   */
+  protected $utils;
+
+  /**
+   * Term storage.
+   *
+   * @var \Drupal\Core\Entity\EntityTypeManager
+   */
+  protected $entityTypeManager;
+
+  /**
+   * Constructor.
+   *
+   * @param array $configuration
+   *   The plugin configuration, i.e. an array with configuration values keyed
+   *   by configuration option name. The special key 'context' may be used to
+   *   initialize the defined contexts by setting it to an array of context
+   *   values keyed by context names.
+   * @param string $plugin_id
+   *   The plugin_id for the plugin instance.
+   * @param mixed $plugin_definition
+   *   The plugin implementation definition.
+   * @param \Drupal\islandora\IslandoraUtils $utils
+   *   Islandora utils.
+   * @param \Drupal\Core\Entity\EntityTypeManager $entity_type_manager
+   *   Entity type manager.
+   */
+  public function __construct(
+    array $configuration,
+    $plugin_id,
+    $plugin_definition,
+    IslandoraUtils $utils,
+    EntityTypeManager $entity_type_manager
+  ) {
+    parent::__construct($configuration, $plugin_id, $plugin_definition);
+    $this->utils = $utils;
+    $this->entityTypeManager = $entity_type_manager;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+    return new static(
+      $configuration,
+      $plugin_id,
+      $plugin_definition,
+      $container->get('islandora.utils'),
+      $container->get('entity_type.manager')
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
+    $form['namespace'] = [
+      '#type' => 'textfield',
+      '#title' => $this->t('Islandora 7.x Namespaces'),
+      '#description' => $this->t('Comma-delimited list of 7.x PID namespaces, including the trailing colon (e.g., "islandora:,ir:").'),
+      '#default_value' => $this->configuration['namespace'],
+      '#maxlength' => 256,
+    ];
+    $field_map = \Drupal::service('entity_field.manager')->getFieldMapByFieldType('string');
+    $node_fields = array_keys($field_map['node']);
+    $options = array_combine($node_fields, $node_fields);
+    $form['pid_field'] = [
+      '#type' => 'select',
+      '#title' => t('Field that contains the PID'),
+      '#options' => $options,
+      '#default_value' => $this->configuration['pid_field'],
+      '#required' => TRUE,
+      '#description' => t("Machine name of the field that contains the PID."),
+    ];
+
+    return parent::buildConfigurationForm($form, $form_state);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
+    $this->configuration['namespace'] = NULL;
+    $namespace = $form_state->getValue('namespace');
+    if (!empty($namespace)) {
+      if ($namespace) {
+        $this->configuration['namespace'] = $namespace;
+      }
+    }
+    $this->configuration['pid_field'] = $form_state->getValue('pid_field');
+    parent::submitConfigurationForm($form, $form_state);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function evaluate() {
+    if (empty($this->configuration['namespace']) && !$this->isNegated()) {
+      return TRUE;
+    }
+
+    $node = $this->getContextValue('node');
+    if (!$node) {
+      return FALSE;
+    }
+    return $this->evaluateEntity($node);
+  }
+
+  /**
+   * Evaluates if the value of field_pid with a registered 7.x namespace.
+   *
+   * @param \Drupal\Core\Entity\EntityInterface $entity
+   *   The entity to evalute.
+   *
+   * @return bool
+   *   TRUE if entity has the specified namespace, otherwise FALSE.
+   */
+  protected function evaluateEntity(EntityInterface $entity) {
+    if ($entity->hasField('field_pid')) {
+      $pid_field = $this->configuration['pid_field'];
+      $pid_value = $entity->get($pid_field)->getValue();
+      $pid = $pid_value[0]['value'];
+      $namespace = strtok($pid, ':') . ':';
+      $registered_namespaces = explode(',', $this->configuration['namespace']);
+      foreach ($registered_namespaces as &$registered_namespace) {
+        $registered_namespace = trim($registered_namespace);
+        if (in_array($namespace, $registered_namespaces)) {
+          return $this->isNegated() ? FALSE : TRUE;
+        }
+      }
+    }
+
+    return $this->isNegated() ? TRUE : FALSE;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function summary() {
+    if (!empty($this->configuration['negate'])) {
+      return $this->t('The node does not have a value in its PID field with the namespace @namespace.', ['@namespace' => $this->configuration['namespace']]);
+    }
+    else {
+      return $this->t('The node has a value in its PID field with the namespace @namespace.', ['@namespace' => $this->configuration['namespace']]);
+    }
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function defaultConfiguration() {
+    return array_merge(
+      ['namespace' => '', 'pid_field' => 'field_pid'],
+      parent::defaultConfiguration()
+    );
+  }
+
+}