Copy Mediapackage elements from the publication to mediapackage (#3554)

* A Workflowoperation handler to copy Mediapackage elements from the publication channel to the mediapackage.

Co-authored-by: Arne Wilken <Arnei@users.noreply.github.com>

docs/guides/admin/docs/workflowoperationhandlers/index.md

@@ -74,6 +74,7 @@ The following table contains the workflow operations that are available in an ou
 |prepare-av          |Preparing audio and video work versions                        |[Documentation](prepareav-woh.md)|
 |probe-resolution    |Set workflow instance variables based on video resolution      |[Documentation](probe-resolution-woh.md)|
 |process-smil        |Edit and Encode media defined by a SMIL file                   |[Documentation](process-smil-woh.md)|
+|publication-to-workspace|Copy publication element to mediapackage in workspace       |[Documentation](publication-to-workspace-woh.md)|
 |publish-configure-aws|Distribute and publish media to the configured publication using Amazon S3 and Cloudfront|[Documentation](publish-configure-aws-woh.md)|
 |publish-configure   |Distribute and publish media to the configured publication     |[Documentation](publish-configure-woh.md)|
 |publish-engage-aws  |Distribute and publish media to the engage player using Amazon S3 and Cloudfront|[Documentation](publish-engage-aws-woh.md)|

docs/guides/admin/docs/workflowoperationhandlers/publication-to-workspace-woh.md

@@ -0,0 +1,30 @@
+# PublicationToWorkspaceWorkflowOperationHandler
+
+## Description
+The PublicationToWorkspaceWorkflowOperationHandler can be used to copy the content from publication channels to workspace.
+With this workflow one can copy or manipulate published elements without re-encoding.
+## Parameter Table
+
+|Configuration Key  |Example           |Description                                           |
+|-------------------|------------------|------------------------------------------------------|
+|publication-channel|engage-player, internal, oaipmh    |the publication-channel |
+|source-flavors     |presenter/delivery|the "," separated source flavor list to move        |
+|source-tags        |engage-download   |the "," separated source tag list to move             | 
+|target-tags        |archive           |the "," separated list of tags to add to the moved elements| 
+
+
+
+## Operation Example
+```
+  <operation id="publication-channel-to-workspace"
+      description="Copy publication channel to workspace"
+      fail-on-error="true"
+      exception-handler-workflow="partial-error">
+    <configurations>
+      <configuration key="source-channel">engage-player</configuration>
+      <configuration key="source-flavors">presenter-delivery,presentation-delivery</configuration>
+      <configuration key="source-tags">engage-download,engage-streaming</configuration>
+      <configuration key="target-tags">archive</configuration>
+    </configurations>
+  </operation>
+```

docs/guides/admin/mkdocs.yml

@@ -216,6 +216,7 @@ nav:
    - Prepare A/V: 'workflowoperationhandlers/prepareav-woh.md'
    - Probe Resolution: 'workflowoperationhandlers/probe-resolution-woh.md'
    - Process Smil: 'workflowoperationhandlers/process-smil-woh.md'
+   - Publication to Workspace: 'workflowoperationhandlers/publication-to-workspace-woh.md'
    - Publish Configure AWS: 'workflowoperationhandlers/publish-configure-aws-woh.md'
    - Publish Configure: 'workflowoperationhandlers/publish-configure-woh.md'
    - Publish Engage AWS: 'workflowoperationhandlers/publish-engage-aws-woh.md'

modules/workflow-workflowoperation/src/main/java/org/opencastproject/workflow/handler/workflow/PublicationChannelToWorkspace.java

@@ -0,0 +1,158 @@
+/**
+ * Licensed to The Apereo Foundation under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ *
+ * The Apereo Foundation licenses this file to you under the Educational
+ * Community License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of the License
+ * at:
+ *
+ *   http://opensource.org/licenses/ecl2.txt
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ *
+ */
+package org.opencastproject.workflow.handler.workflow;
+
+import org.opencastproject.job.api.JobContext;
+import org.opencastproject.mediapackage.MediaPackage;
+import org.opencastproject.mediapackage.MediaPackageElement;
+import org.opencastproject.mediapackage.MediaPackageElementFlavor;
+import org.opencastproject.mediapackage.Publication;
+import org.opencastproject.workflow.api.AbstractWorkflowOperationHandler;
+import org.opencastproject.workflow.api.ConfiguredTagsAndFlavors;
+import org.opencastproject.workflow.api.WorkflowInstance;
+import org.opencastproject.workflow.api.WorkflowOperationException;
+import org.opencastproject.workflow.api.WorkflowOperationHandler;
+import org.opencastproject.workflow.api.WorkflowOperationInstance;
+import org.opencastproject.workflow.api.WorkflowOperationResult;
+import org.opencastproject.workflow.api.WorkflowOperationResult.Action;
+
+import org.apache.commons.lang3.StringUtils;
+import org.osgi.service.component.annotations.Component;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
+
+/**
+ * Workflow operation handler to move elements from publication channel to workspace
+ */
+@Component(
+    immediate = true,
+    service = WorkflowOperationHandler.class,
+    property = {
+        "service.description=move publication elements to workspace",
+        "workflow.operation=publication-channel-to-workspace"
+    }
+)
+
+public class PublicationChannelToWorkspace extends AbstractWorkflowOperationHandler {
+
+  /** Configuration key for the "source-channel" to use as a source input */
+  static final String OPT_SOURCE_PUBLICATION_CHANNEL = "source-channel";
+
+  /** The logging facility */
+  private static final Logger logger = LoggerFactory
+          .getLogger(PublicationChannelToWorkspace.class);
+
+  @Override
+  public WorkflowOperationResult start(WorkflowInstance workflowInstance, JobContext context)
+      throws WorkflowOperationException {
+
+    logger.info("Copying artifacts from published media package {} to workspace", workflowInstance.getId());
+    final MediaPackage mediaPackage = workflowInstance.getMediaPackage();
+
+    WorkflowOperationInstance currentOperation = workflowInstance.getCurrentOperation();
+
+    ConfiguredTagsAndFlavors tagsAndFlavors = getTagsAndFlavors(workflowInstance, Configuration.many,
+        Configuration.many, Configuration.many, Configuration.many);
+    List<MediaPackageElementFlavor> configuredSourceFlavors = tagsAndFlavors.getSrcFlavors();
+    List<String> configuredSourceTags = tagsAndFlavors.getSrcTags();
+    List <String> configuredTargetTags = tagsAndFlavors.getTargetTags();
+    String publicationChannel = StringUtils
+        .trimToEmpty(currentOperation.getConfiguration(OPT_SOURCE_PUBLICATION_CHANNEL));
+    if (publicationChannel.isEmpty()) {
+      logger.error("No source publication-channel set.");
+      throw new WorkflowOperationException("No source Publication channel set.");
+    }
+
+    Optional<Publication> publication = Arrays.stream(mediaPackage.getPublications())
+        .filter(channel -> channel.getChannel().equals(publicationChannel)).findFirst();
+    if (publication.get().getTracks().length >= 0) {
+
+      Collection<MediaPackageElement> tracks =  new ArrayList<MediaPackageElement>();
+
+      //get tracks from publicationchannel with tags and flavors
+      Arrays.stream(publication.get().getTracks())
+          .filter(element -> element.containsTag(configuredSourceTags))
+          .filter(Objects::nonNull)
+          .forEach(element -> tracks.add(element));
+      Arrays.stream(publication.get().getTracks())
+          .filter(element -> configuredSourceFlavors.contains(element.getFlavor()))
+          .filter(Objects::nonNull)
+          .forEach(element -> tracks.add(element));
+
+      if (!configuredTargetTags.isEmpty()) {
+        tracks.stream().forEach(track -> {
+          configuredTargetTags.stream().forEach(targetTag -> track.addTag(targetTag.toString()));
+        });
+      }
+      tracks.stream().forEach(track -> mediaPackage.add(track));
+    }
+
+    //get attachements from publicationchannel with tags and flavors
+    if (publication.get().getAttachments().length >= 0) {
+      Collection<MediaPackageElement> attachments = new ArrayList<MediaPackageElement>();
+      Arrays.stream(publication.get().getAttachments())
+          .filter(element -> element.containsTag(configuredSourceTags))
+          .filter(Objects::nonNull)
+          .forEach(element -> attachments.add(element));
+      Arrays.stream(publication.get().getAttachments())
+          .filter(element -> configuredSourceFlavors.contains(element.getFlavor()))
+          .filter(Objects::nonNull)
+          .forEach(element -> attachments.add(element));
+
+      if (!configuredTargetTags.isEmpty()) {
+        attachments.stream().forEach(attachment -> {
+          configuredTargetTags.stream().forEach(targetTag -> attachment.addTag(targetTag.toString()));
+        });
+      }
+      attachments.stream().forEach(attachment -> mediaPackage.add(attachment));
+    }
+
+    //get catalogs from publicationchannel with tags and flavors
+    if (publication.get().getCatalogs().length >= 0) {
+      Collection<MediaPackageElement> catalogs = new ArrayList<MediaPackageElement>();
+      Arrays.stream(publication.get().getCatalogs())
+          .filter(element -> element.containsTag(configuredSourceTags))
+          .filter(Objects::nonNull)
+          .forEach(element -> catalogs.add(element));
+      Arrays.stream(publication.get().getCatalogs())
+          .filter(element -> configuredSourceFlavors.contains(element.getFlavor()))
+          .filter(Objects::nonNull)
+          .forEach(element -> catalogs.add(element));
+
+      if (!configuredTargetTags.isEmpty()) {
+        catalogs.stream().forEach(catalog -> {
+          configuredTargetTags.stream().forEach(targetTag -> catalog.addTag(targetTag.toString()));
+        });
+      }
+      catalogs.stream().forEach(catalog -> mediaPackage.add(catalog));
+    }
+
+    return createResult(mediaPackage, Action.CONTINUE, 0);
+  }
+
+}