/*
    * 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.transcription.workflowoperation;
  
  import org.opencastproject.caption.api.CaptionService;
  import org.opencastproject.job.api.Job;
  import org.opencastproject.job.api.JobContext;
  import org.opencastproject.mediapackage.Attachment;
  import org.opencastproject.mediapackage.MediaPackage;
  import org.opencastproject.mediapackage.MediaPackageElement;
  import org.opencastproject.mediapackage.MediaPackageElementFlavor;
  import org.opencastproject.mediapackage.MediaPackageElementParser;
  import org.opencastproject.mediapackage.Track;
  import org.opencastproject.serviceregistry.api.ServiceRegistry;
  import org.opencastproject.transcription.api.TranscriptionService;
  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.opencastproject.workspace.api.Workspace;
  
  import org.apache.commons.lang3.StringUtils;
  import org.osgi.service.component.ComponentContext;
  import org.osgi.service.component.annotations.Activate;
  import org.osgi.service.component.annotations.Component;
  import org.osgi.service.component.annotations.Reference;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  @Component(
      immediate = true,
      service = WorkflowOperationHandler.class,
      property = {
          "service.description=Attach Transcription Workflow Operation Handler",
          "workflow.operation=attach-watson-transcription"
      }
  )
  public class AttachTranscriptionOperationHandler extends AbstractWorkflowOperationHandler {
  
    /** The logging facility */
    private static final Logger logger = LoggerFactory.getLogger(AttachTranscriptionOperationHandler.class);
  
    /** Workflow configuration option keys */
    static final String TRANSCRIPTION_JOB_ID = "transcription-job-id";
    static final String TARGET_CAPTION_FORMAT = "target-caption-format";
    static final String TARGET_TYPE = "target-element-type";
  
    /** The transcription service */
    private TranscriptionService service = null;
    private Workspace workspace;
    private CaptionService captionService;
  
    @Override
    @Activate
    protected void activate(ComponentContext cc) {
      super.activate(cc);
    }
  
    @Override
    public WorkflowOperationResult start(final WorkflowInstance workflowInstance, JobContext context)
            throws WorkflowOperationException {
      MediaPackage mediaPackage = workflowInstance.getMediaPackage();
      WorkflowOperationInstance operation = workflowInstance.getCurrentOperation();
  
      logger.debug("Attach transcription for mediapackage {} started", mediaPackage);
  
      // Get job id.
      String jobId = StringUtils.trimToNull(operation.getConfiguration(TRANSCRIPTION_JOB_ID));
      if (jobId == null) {
        throw new WorkflowOperationException(TRANSCRIPTION_JOB_ID + " missing");
      }
  
      // Check which tags/flavors have been configured
      ConfiguredTagsAndFlavors tagsAndFlavors = getTagsAndFlavors(
          workflowInstance, Configuration.none, Configuration.none, Configuration.many, Configuration.one);
      ConfiguredTagsAndFlavors.TargetTags targetTagOption = tagsAndFlavors.getTargetTags();
      MediaPackageElementFlavor targetFlavor = tagsAndFlavors.getSingleTargetFlavor();
     String captionFormatOption = StringUtils.trimToNull(operation.getConfiguration(TARGET_CAPTION_FORMAT));
     String typeUnparsed = StringUtils.trimToEmpty(operation.getConfiguration(TARGET_TYPE));
     MediaPackageElement.Type type = null;
     if (!typeUnparsed.isEmpty()) {
       // Case insensitive matching between user input (workflow config key) and enum value
       for (MediaPackageElement.Type t : MediaPackageElement.Type.values()) {
         if (t.name().equalsIgnoreCase(typeUnparsed)) {
           type = t;
         }
       }
       if (type == null || (type != Track.TYPE && type != Attachment.TYPE)) {
         throw new IllegalArgumentException(String.format("The given type '%s' for mediapackage %s was illegal. Please"
                 + "check the operations' configuration keys.", type, mediaPackage.getIdentifier()));
       }
     } else {
       type = Track.TYPE;
     }
 
     try {
       // Get transcription file from the service
       MediaPackageElement original = service.getGeneratedTranscription(mediaPackage.getIdentifier().toString(), jobId,
               type);
       MediaPackageElement transcription = original;
 
       // If caption format passed, convert to desired format
       if (captionFormatOption != null) {
         Job job = captionService.convert(transcription, "ibm-watson", captionFormatOption, service.getLanguage());
         if (!waitForStatus(job).isSuccess()) {
           throw new WorkflowOperationException("Transcription format conversion job did not complete successfully");
         }
         transcription = MediaPackageElementParser.getFromXml(job.getPayload());
       }
 
       // Set the target flavor if informed
       transcription.setFlavor(targetFlavor);
 
       // Add tags
       applyTargetTagsToElement(targetTagOption, transcription);
 
       // Add to media package
       mediaPackage.add(transcription);
 
       String uri = transcription.getURI().toString();
       String ext = uri.substring(uri.lastIndexOf("."));
       transcription.setURI(workspace.moveTo(transcription.getURI(), mediaPackage.getIdentifier().toString(),
               transcription.getIdentifier(), "captions." + ext));
     } catch (Exception e) {
       throw new WorkflowOperationException(e);
     }
 
     return createResult(mediaPackage, Action.CONTINUE);
   }
 
   @Reference(target = "(provider=ibm.watson)")
   public void setTranscriptionService(TranscriptionService service) {
     this.service = service;
   }
 
   @Reference
   public void setWorkspace(Workspace service) {
     this.workspace = service;
   }
 
   @Reference
   public void setCaptionService(CaptionService service) {
     this.captionService = service;
   }
 
   @Reference
   @Override
   public void setServiceRegistry(ServiceRegistry serviceRegistry) {
     super.setServiceRegistry(serviceRegistry);
   }
 
 }