EmailWorkflowOperationHandler.java

/*
 * 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.notification;

import org.opencastproject.email.template.api.EmailTemplateService;
import org.opencastproject.job.api.JobContext;
import org.opencastproject.kernel.mail.SmtpService;
import org.opencastproject.mediapackage.MediaPackage;
import org.opencastproject.security.api.User;
import org.opencastproject.security.api.UserDirectoryService;
import org.opencastproject.serviceregistry.api.ServiceRegistry;
import org.opencastproject.workflow.api.AbstractWorkflowOperationHandler;
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.BooleanUtils;
import org.apache.commons.lang3.StringUtils;
import org.osgi.service.component.ComponentContext;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.Objects;

import javax.mail.MessagingException;
import javax.mail.internet.InternetAddress;

/**
 * Please describe what this handler does.
 */
@Component(
    immediate = true,
    service = WorkflowOperationHandler.class,
    property = {
        "service.description=Sends an email with the parameters indicated",
        "workflow.operation=send-email"
    }
)
public class EmailWorkflowOperationHandler extends AbstractWorkflowOperationHandler {

  private static final Logger logger = LoggerFactory.getLogger(EmailWorkflowOperationHandler.class);

  /** The smtp service */
  private SmtpService smtpService = null;

  /** The email template service */
  private EmailTemplateService emailTemplateService = null;

  /** The user directory service */
  private UserDirectoryService userDirectoryService;

  // Configuration properties used in the workflow definition
  static final String TO_PROPERTY = "to";
  static final String CC_PROPERTY = "cc";
  static final String BCC_PROPERTY = "bcc";
  static final String SUBJECT_PROPERTY = "subject";
  static final String BODY_PROPERTY = "body";
  static final String BODY_TEMPLATE_FILE_PROPERTY = "body-template-file";
  static final String BODY_HTML_PROPERTY = "body-html";
  static final String BODY_HTML_TEMPLATE_FILE_PROPERTY = "body-html-template-file";
  static final String ADDRESS_SEPARATOR_PROPERTY = "address-separator";
  static final String ADDRESS_SEPARATOR_DEFAULT = ", \t";
  static final String SKIP_INVALID_ADDRESS_PROPERTY = "skip-invalid-address";

  /*
   * (non-Javadoc)
   *
   * @see org.opencastproject.workflow.api.AbstractWorkflowOperationHandler#activate
   * (org.osgi.service.component.ComponentContext )
   */
  @Override
  protected void activate(ComponentContext cc) {
    super.activate(cc);
    logger.debug("Activating email workflow operation handler");
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public WorkflowOperationResult start(WorkflowInstance workflowInstance, JobContext context)
          throws WorkflowOperationException {

    // The current workflow operation instance
    WorkflowOperationInstance operation = workflowInstance.getCurrentOperation();

    // MediaPackage from previous workflow operations
    MediaPackage srcPackage = workflowInstance.getMediaPackage();

    // "To", "CC", "BCC", subject, body can be Freemarker templates
    String[] to = processDestination(workflowInstance, operation, TO_PROPERTY);
    String[] cc = processDestination(workflowInstance, operation, CC_PROPERTY);
    String[] bcc = processDestination(workflowInstance, operation, BCC_PROPERTY);

    if (to.length + cc.length + bcc.length == 0) {
      logger.info("No recipients. Skipping operation.");
      return createResult(srcPackage, Action.SKIP);
    }

    String subject = applyTemplateIfNecessary(workflowInstance, operation, SUBJECT_PROPERTY);

    String bodyCfg = operation.getConfiguration(BODY_PROPERTY);
    String bodyTemplateFileCfg = operation.getConfiguration(BODY_TEMPLATE_FILE_PROPERTY);
    String bodyHtmlCfg = operation.getConfiguration(BODY_HTML_PROPERTY);
    String bodyHtmlTemplateFileCfg = operation.getConfiguration(BODY_HTML_TEMPLATE_FILE_PROPERTY);

    String bodyText = null;
    String bodyHTML = null;

    // Body informed? If not, use the default.
    if (bodyCfg == null && bodyHtmlCfg == null && bodyTemplateFileCfg == null && bodyHtmlTemplateFileCfg == null) {
      // Set the body of the message to be the ID of the media package
      bodyText = String.format("%s (%s)", srcPackage.getTitle(), srcPackage.getIdentifier());
    }

    if (bodyCfg != null) {
      bodyText = applyTemplateIfNecessary(workflowInstance, operation, BODY_PROPERTY);
    } else if (bodyTemplateFileCfg != null) {
      bodyText = applyTemplateIfNecessary(workflowInstance, operation, BODY_TEMPLATE_FILE_PROPERTY);
    }

    if (bodyHtmlCfg != null) {
      bodyHTML = applyTemplateIfNecessary(workflowInstance, operation, BODY_HTML_PROPERTY);
    } else if (bodyHtmlTemplateFileCfg != null) {
      bodyHTML = applyTemplateIfNecessary(workflowInstance, operation, BODY_HTML_TEMPLATE_FILE_PROPERTY);
    }

    try {
      logger.debug("Sending e-mail notification with subject '{}' and text body '{}' / HTML body '{}' "
              + "to '{}', CC '{}' and BCC '{}'",
              subject, bodyText, bodyHTML, to, cc, bcc);
      // "To", "CC" and "BCC" can be comma- or space-separated lists of emails
      smtpService.send(to, cc, bcc, subject, bodyText, bodyHTML);
      logger.info("E-mail notification sent to {}, CC addresses {} and BCC addresses {}", to, cc, bcc);
    } catch (MessagingException e) {
      throw new WorkflowOperationException(e);
    }

    // Return the source mediapackage and tell processing to continue
    return createResult(srcPackage, Action.CONTINUE);
  }

  private String[] processDestination(
      final WorkflowInstance workflowInstance,
      final WorkflowOperationInstance operation,
      final String emailHeader) throws WorkflowOperationException {
    final String separator = Objects.toString(
        operation.getConfiguration(ADDRESS_SEPARATOR_PROPERTY),
        ADDRESS_SEPARATOR_DEFAULT);
    // First apply the template if there's one
    final String templateApplied = applyTemplateIfNecessary(workflowInstance, operation, emailHeader, separator);
    if (templateApplied == null) {
      return new String[0];
    }

    // Are these valid email addresses?
    final ArrayList<String> recipients = new ArrayList<>();
    final boolean skipInvalid = BooleanUtils.toBoolean(operation.getConfiguration(SKIP_INVALID_ADDRESS_PROPERTY));
    for (final String part : StringUtils.split(templateApplied, separator)) {
      // Is this a user name? Look for that user via user directory service.
      final User user = userDirectoryService.loadUser(part);
      if (user != null && StringUtils.isNotEmpty(user.getEmail())) {
        // Yes, this is a user name and the user has an email registered. Use it.
        recipients.add(user.getEmail());
      } else {
        // Either not a user name or user doesn't have an email registered.
        try {
          // Validate it as an email address
          new InternetAddress(part).validate();
          recipients.add(part);
        } catch (Exception e) {
          // Otherwise, log an error
          if (skipInvalid) {
            logger.debug("Skip sending mail to invalid email address {}", part);
          } else {
            throw new WorkflowOperationException(
                String.format("Email address invalid or user doesn't have an email: %s.", part), e);
          }
        }
      }
    }
    return recipients.toArray(new String[0]);
  }

  private String applyTemplateIfNecessary(WorkflowInstance workflowInstance, WorkflowOperationInstance operation,
      String configName) {
    return applyTemplateIfNecessary(workflowInstance, operation, configName, null);
  }

  private String applyTemplateIfNecessary(WorkflowInstance workflowInstance, WorkflowOperationInstance operation,
          String configName, String separator) {
    String configValue = operation.getConfiguration(configName);

    // Templates are cached, use as template name: the template name or, if
    // in-line, the
    // workflow name + the operation number + body/to/subject
    String templateName = null;
    String templateContent = null;

    if (BODY_TEMPLATE_FILE_PROPERTY.equals(configName) || BODY_HTML_TEMPLATE_FILE_PROPERTY.equals(configName)) {
      templateName = configValue; // Use body template file name
    } else if (configValue != null && configValue.contains("${")) {
      // If value contains a "${", it may be a template so apply it
      // Give a name to the inline template
      templateName = workflowInstance.getTemplate() + "_" + operation.getId() + "_" + configName;
      // Only alphanumeric and _
      templateName = templateName.replaceAll("[^A-Za-z0-9 ]", "_");
      templateContent = configValue;
    } else {
      // If value doesn't contain a "${", assume it is NOT a Freemarker
      // template and thus return the value as it is
      return configValue;
    }

    // Apply the template
    if (separator == null) {
      return emailTemplateService.applyTemplate(templateName, templateContent, workflowInstance);
    }
    return emailTemplateService.applyTemplate(templateName, templateContent, workflowInstance, separator);
  }

  /**
   * Callback for OSGi to set the {@link SmtpService}.
   *
   * @param smtpService
   *          the smtp service
   */
  @Reference
  void setSmtpService(SmtpService smtpService) {
    this.smtpService = smtpService;
  }

  /**
   * Callback for OSGi to set the {@link SmtpService}.
   *
   * @param service
   *          the email template service
   */
  @Reference
  void setEmailTemplateService(EmailTemplateService service) {
    this.emailTemplateService = service;
  }

  /**
   * Callback for OSGi to set the {@link UserDirectoryService}.
   *
   * @param service
   *          the user directory service
   */
  @Reference
  void setUserDirectoryService(UserDirectoryService service) {
    this.userDirectoryService = service;
  }

  @Reference
  @Override
  public void setServiceRegistry(ServiceRegistry serviceRegistry) {
    super.setServiceRegistry(serviceRegistry);
  }

}