Replication filter

replication.services.yml

@@ -3,10 +3,15 @@ services:
     class: Drupal\replication\ProcessFileAttachment
     arguments: ['@current_user', '@entity_type.manager', '@multiversion.entity_index.factory']
 
+#Managers
+  plugin.manager.replication_filter:
+    class: Drupal\replication\Plugin\ReplicationFilterManager
+    parent: default_plugin_manager
+
 #Factories
   replication.changes_factory:
     class: Drupal\replication\ChangesFactory
-    arguments: ['@multiversion.entity_index.sequence', '@entity.manager', '@serializer']
+    arguments: ['@multiversion.entity_index.sequence', '@entity.manager', '@serializer', '@plugin.manager.replication_filter']
   replication.revisiondiff_factory:
     class: Drupal\replication\RevisionDiffFactory
     arguments: ['@multiversion.entity_index.rev']
@@ -94,4 +99,4 @@ services:
   replication.normalizer.comment_item:
     class: Drupal\replication\Normalizer\CommentItemNormalizer
     tags:
-      - { name: normalizer, priority: 10 }
+      - { name: normalizer, priority: 10 }

src/Annotation/ReplicationFilter.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Drupal\replication\Annotation;
+
+use Drupal\Component\Annotation\Plugin;
+
+/**
+ * Defines a ReplicationFilter annotation object.
+ *
+ * Plugin Namespace: Plugin\ReplicationFilter
+ *
+ * For a working example, see
+ * \Drupal\replication\Plugin\ReplicationFilter\PublishedFilter
+ *
+ * @see \Drupal\replication\Plugin\ReplicationFilterInterface
+ * @see \Drupal\replication\Plugin\ReplicationFilterManager
+ * @see plugin_api
+ *
+ * @Annotation
+ */
+class ReplicationFilter extends Plugin {
+
+  /**
+   * The plugin ID.
+   *
+   * @var string
+   */
+  public $id;
+
+  /**
+   * The human-readable name of the ReplicationFilter plugin.
+   *
+   * @var \Drupal\Core\Annotation\Translation
+   *
+   * @ingroup plugin_translatable
+   */
+  public $label;
+
+  /**
+   * A short description of the ReplicationFilter plugin.
+   *
+   * @var \Drupal\Core\Annotation\Translation
+   *
+   * @ingroup plugin_translatable
+   */
+  public $description;
+
+}

src/Changes/Changes.php

@@ -1,27 +1,25 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\replication\Changes\Changes.
- */
-
 namespace Drupal\replication\Changes;
 
+use Drupal\Core\DependencyInjection\DependencySerializationTrait;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\multiversion\Entity\Index\SequenceIndexInterface;
 use Drupal\multiversion\Entity\WorkspaceInterface;
+use Drupal\replication\Plugin\ReplicationFilterManagerInterface;
+// @todo where is the ParameterBagInterface???
+use Symfony\Component\HttpFoundation\ParameterBag;
 use Symfony\Component\Serializer\SerializerInterface;
-use Drupal\Core\DependencyInjection\DependencySerializationTrait;
 
 /**
- * @todo {@link https://www.drupal.org/node/2282295 Implement remaining feed
- *   query types.}
+ * {@inheritdoc}
  */
 class Changes implements ChangesInterface {
   use DependencySerializationTrait;
 
   /**
    * @var string
+   *   The workspace to generate the changeset from.
    */
   protected $workspaceId;
 
@@ -35,13 +33,32 @@ class Changes implements ChangesInterface {
    */
   protected $serializer;
 
+  /**
+   * @var \Drupal\replication\Plugin\ReplicationFilterManagerInterface
+   */
+  protected $filterManager;
+
+  /**
+   * @var string
+   *   The id of the filter plugin to use during replication.
+   */
+  protected $filterName;
+
+  /**
+   * @var ParameterBag
+   *   The parameters passed to the filter function.
+   */
+  protected $parameters;
+
   /**
    * @var boolean
+   *   Whether to include entities in the changeset.
    */
   protected $includeDocs = FALSE;
 
   /**
    * @var int
+   *   The sequence ID to start including changes from. Result includes $lastSeq.
    */
   protected $lastSeq = 0;
 
@@ -50,19 +67,38 @@ class Changes implements ChangesInterface {
    * @param \Drupal\multiversion\Entity\WorkspaceInterface $workspace
    * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
    * @param \Symfony\Component\Serializer\SerializerInterface $serializer
+   * @param \Drupal\replication\Plugin\ReplicationFilterManagerInterface $filter_manager
    */
-  public function __construct(SequenceIndexInterface $sequence_index, WorkspaceInterface $workspace, EntityTypeManagerInterface $entity_type_manager, SerializerInterface $serializer) {
+  public function __construct(SequenceIndexInterface $sequence_index, WorkspaceInterface $workspace, EntityTypeManagerInterface $entity_type_manager, SerializerInterface $serializer, ReplicationFilterManagerInterface $filter_manager) {
     $this->sequenceIndex = $sequence_index;
     $this->workspaceId = $workspace->id();
     $this->entityTypeManager = $entity_type_manager;
     $this->serializer = $serializer;
+    $this->filterManager = $filter_manager;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function filter($filter_name) {
+    $this->filterName = $filter_name;
+    return $this;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function parameters(ParameterBag $parameters) {
+    $this->parameters = $parameters;
+    return $this;
   }
 
   /**
    * {@inheritdoc}
    */
   public function includeDocs($include_docs) {
     $this->includeDocs = $include_docs;
+    return $this;
   }
 
   /**
@@ -81,13 +117,39 @@ public function getNormal() {
       ->useWorkspace($this->workspaceId)
       ->getRange($this->lastSeq, NULL);
 
+    // Setup filter plugin.
+    $parameters = ($this->parameters instanceof ParameterBag) ? $this->parameters : new ParameterBag();
+    $filter = NULL;
+    if (is_string($this->filterName) && $this->filterName) {
+      $filter = $this->filterManager->createInstance($this->filterName);
+    }
+    // If UUIDs are sent as a parameter, but no filter is set, automatically
+    // select the "uuid" filter.
+    elseif ($parameters->has('uuids')) {
+      $filter = $this->filterManager->createInstance('uuid');
+    }
+
     // Format the result array.
     $changes = array();
     foreach ($sequences as $sequence) {
       if (!empty($sequence['local']) || !empty($sequence['is_stub'])) {
         continue;
       }
 
+      // Get the document.
+      $revision = NULL;
+      if ($this->includeDocs == TRUE || $filter !== NULL) {
+        /** @var \Drupal\multiversion\Entity\Storage\ContentEntityStorageInterface $storage */
+        $storage = $this->entityTypeManager->getStorage($sequence['entity_type_id']);
+        $storage->useWorkspace($this->workspaceId);
+        $revision = $storage->loadRevision($sequence['revision_id']);
+      }
+
+      // Filter the document.
+      if ($filter !== NULL && !$filter->filter($revision, $parameters)) {
+        continue;
+      }
+
       $uuid = $sequence['entity_uuid'];
       $changes[$uuid] = array(
         'changes' => array(
@@ -99,10 +161,9 @@ public function getNormal() {
       if ($sequence['deleted']) {
         $changes[$uuid]['deleted'] = TRUE;
       }
+
+      // Include the document.
       if ($this->includeDocs == TRUE) {
-        /** @var \Drupal\multiversion\Entity\Storage\ContentEntityStorageInterface $storage */
-        $storage = $this->entityTypeManager->getStorage($sequence['entity_type_id']);
-        $revision = $storage->loadRevision($sequence['revision_id']);
         $changes[$uuid]['doc'] = $this->serializer->normalize($revision);
       }
     }

src/Changes/ChangesInterface.php

@@ -1,29 +1,61 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\replication\Changes\ChangesInterface.
- */
-
 namespace Drupal\replication\Changes;
 
-use Drupal\multiversion\Entity\Index\SequenceIndexInterface;
-use Drupal\multiversion\Entity\WorkspaceInterface;
-use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\HttpFoundation\ParameterBag;
 
+/**
+ * Define and build a changeset for a Workspace.
+ *
+ * @todo {@link https://www.drupal.org/node/2282295 Implement remaining feed
+ *   query types.}
+ * @todo break this class into a value object and a service object: one that
+ * defines the parameters for getting the changeset and the other for executing
+ * the code to build the changeset
+ */
 interface ChangesInterface {
 
   /**
-   * @param boolean $include_docs
+   * Set the id of the filter plugin to use to refine the changeset.
+   *
+   * @param string $filter_name
+   *   The plugin id of a Drupal\replication\Plugin\ReplicationFilterInterface.
+   *
+   * @return \Drupal\replication\Changes\ChangesInterface
+   *   Returns $this.
+   */
+  public function filter($filter_name);
+
+  /**
+   * Set the parameters for the filter plugin.
+   *
+   * @param ParameterBag $parameters
+   *   The parameters passed to the filter function.
+   *
+   * @return \Drupal\replication\Changes\ChangesInterface
+   *   Returns $this.
+   */
+  public function parameters(ParameterBag $parameters);
+
+  /**
+   * Set the flag for including entities in the changeset.
+   *
+   * @param bool $include_docs
+   *   Whether to include entities in the changeset.
+   *
    * @return \Drupal\replication\Changes\ChangesInterface
+   *   Returns $this.
    */
   public function includeDocs($include_docs);
 
   /**
    * Sets from what sequence number to check for changes.
    *
    * @param int $seq
+   *   The sequence ID to start including changes from. Result includes $seq.
+   *
    * @return \Drupal\replication\Changes\ChangesInterface
+   *   Returns $this.
    */
   public function lastSeq($seq);
 

src/ChangesFactory.php

@@ -6,6 +6,7 @@
 use Drupal\multiversion\Entity\Index\SequenceIndexInterface;
 use Drupal\multiversion\Entity\WorkspaceInterface;
 use Drupal\replication\Changes\Changes;
+use Drupal\replication\Plugin\ReplicationFilterManagerInterface;
 use Symfony\Component\Serializer\SerializerInterface;
 
 class ChangesFactory implements ChangesFactoryInterface {
@@ -25,6 +26,11 @@ class ChangesFactory implements ChangesFactoryInterface {
    */
   protected $serializer;
 
+  /**
+   * @var \Drupal\replication\Plugin\ReplicationFilterManagerInterface
+   */
+  protected $filterManager;
+
   /**
    * @var \Drupal\replication\Changes\Changes[]
    */
@@ -34,11 +40,13 @@ class ChangesFactory implements ChangesFactoryInterface {
    * @param \Drupal\multiversion\Entity\Index\SequenceIndexInterface $sequence_index
    * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
    * @param \Symfony\Component\Serializer\SerializerInterface $serializer
+   * @param \Drupal\replication\Plugin\ReplicationFilterManagerInterface $filter_manager
    */
-  public function __construct(SequenceIndexInterface $sequence_index, EntityTypeManagerInterface $entity_type_manager, SerializerInterface $serializer) {
+  public function __construct(SequenceIndexInterface $sequence_index, EntityTypeManagerInterface $entity_type_manager, SerializerInterface $serializer, ReplicationFilterManagerInterface $filter_manager) {
     $this->sequenceIndex = $sequence_index;
     $this->entityTypeManager = $entity_type_manager;
     $this->serializer = $serializer;
+    $this->filterManager = $filter_manager;
   }
 
   /**
@@ -50,7 +58,8 @@ public function get(WorkspaceInterface $workspace) {
         $this->sequenceIndex,
         $workspace,
         $this->entityTypeManager,
-        $this->serializer
+        $this->serializer,
+        $this->filterManager
       );
     }
     return $this->instances[$workspace->id()];

src/Plugin/ReplicationFilter/EntityTypeFilter.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Drupal\replication\Plugin\ReplicationFilter;
+
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\replication\Plugin\ReplicationFilter\ReplicationFilterBase;
+use Symfony\Component\HttpFoundation\ParameterBag;
+
+/**
+ * Provides a filter based on entity type.
+ *
+ * Supported parameters:
+ *   entity_type: a comma delimited list of entity type id's to include
+ *
+ * @ReplicationFilter(
+ *   id = "entity_type",
+ *   label = @Translation("Filter By Entity Type"),
+ *   description = @Translation("Replicate only entities that match a given type.")
+ * )
+ */
+class EntityTypeFilter extends ReplicationFilterBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function filter(EntityInterface $entity, ParameterBag $parameters) {
+    if ($parameters->has('entity_type')) {
+      $types = $parameters->get('entity_type');
+    }
+    else {
+      $types = '';
+    }
+    $types = explode(',', $types);
+    $types = array_filter(array_map('trim', $types));
+    return in_array($entity->bundle(), $types);
+  }
+
+}