AbstractMailSender.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2017 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.mail.sender;
 
import java.io.File;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.function.Consumer;
import java.util.function.Supplier;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.apache.commons.mail.EmailException;
import org.turro.action.Contacts;
import org.turro.action.IMailSender;
import org.turro.action.MailAttachment;
import org.turro.action.queue.NotificationCategory;
import org.turro.action.queue.Notifications;
import org.turro.assistant.Assistant;
import org.turro.assistant.AssistantSet;
import org.turro.assistant.Assistants;
import org.turro.elephant.context.ElephantContext;
import org.turro.entities.Entities;
import org.turro.mail.message.MailUtils;
import org.turro.mail.queue.GenericElephantNotification;
import org.turro.plugin.contacts.IContact;
import org.turro.security.SecurityGroup;
 
public abstract class AbstractMailSender implements IMailSender {
 
  public final AssistantSet assistants = new AssistantSet();
  
  protected String defaultCategory = GenericElephantNotification.SYSTEM_NOTIFICATION;  
  protected String reason, pool, root;
  protected Set<File> attachments = new HashSet<>();
  protected Set<MailAttachment> mailAttachments = new HashSet<>();
  protected Consumer onStart, onCancel, onBuild, onFinish;
  protected IContact from;
  
  @Override
  public IMailSender setCategory(String idCategory) {
    defaultCategory = idCategory;
    return this;
  }
 
  @Override
  public IMailSender setReason(String reason) {
    this.reason = reason;
    return this;
  }
 
  @Override
  public IMailSender setPool(String pool) {
    this.pool = pool;
    return this;
  }
 
  @Override
  public IMailSender setFrom(IContact from) {
    this.from = from;
    return this;
  }
 
  protected boolean isFromValid() {
    return from != null && from.isWebUser();
  }
  
  protected String getFromString() {
    return isFromValid() ? from.getEmail() : null;
  }
  
  @Override
  public IMailSender setRoot(String root) {
    this.root = root;
    return this;
  }
  
  @Override
  public IMailSender addAdministrators() {
    addBySyndication(SecurityGroup.BRIGHTSIDE_ADMIN);
    return this;
  }
  
  @Override
  public IMailSender addBySyndication(String syndication) {
    assistants.addContacts(Contacts.getBySyndication(syndication));
    return this;
  }
  
  @Override
  public IMailSender addByRole(String role) {
    assistants.addContacts(Contacts.getByRole(role));
    return this;
  }
  
  @Override
  public IMailSender addByEntity(Object entity, Object data) {
    addByEntity(entity, true, data);
    return this;
  }
  
  @Override
  public IMailSender addByEntity(Object entity, boolean deep, Object data) {
    addByEntity(Entities.getController(entity).getPath(), deep, data);
    return this;
  }
  
  @Override
  public IMailSender addByEntity(String path, Object data) {
    addByEntity(path, true, data);
    return this;
  }
  
  @Override
  public IMailSender addByEntity(String path, boolean deep, Object data) {
    Assistants.addAssistants(path, true, assistants, data);
    return this;
  }
  
  @Override
  public IMailSender addContact(IContact contact) {
    assistants.addContact(contact, null);
    return this;
  }
 
  @Override
  public IMailSender addContacts(Collection<IContact> contacts) {
    assistants.addContacts(contacts);
    return this;
  }
 
  @Override
  public IMailSender addAssistant(Assistant assistant) {
    this.assistants.add(assistant);
    return this;
  }
 
  @Override
  public IMailSender addAssistants(AssistantSet assistants) {
    for(Assistant assistant : assistants) {
      this.assistants.add(assistant);
    }
    return this;
  }
 
  @Override
  public IMailSender addUser(String name, String email) {
    assistants.addUser(name, email, null);
    return this;
  }
 
  
  @Override
  public IMailSender addAttachment(File file) {
    attachments.add(file);
    return this;
  }
  
  @Override
  public IMailSender addAttachments(Collection<File> files) {
    attachments.addAll(files);
    return this;
  }
  
  @Override
  public IMailSender addMailAttachments(Collection<MailAttachment> mas) {
    mailAttachments.addAll(mas);
    return this;
  }
 
  @Override
  public IMailSender onStart(Consumer command) {
    onStart = command;
    return this;
  }
 
  @Override
  public IMailSender onCancel(Consumer command) {
    onCancel = command;
    return this;
  }
 
  @Override
  public IMailSender onBuild(Consumer command) {
    onBuild = command;
    return this;
  }
  
  @Override
  public IMailSender onFinish(Consumer command) {
    onFinish = command;
    return this;
  }
 
  @Override
  public AssistantSet getAssistants() {
    return assistants;
  }
 
  @Override
  public void removeAttachments() {
    attachments.forEach(file -> {
      file.delete();
    });
  }
  
  /* Attributes */
  
  private final Map attributes = new HashMap();
 
  @Override
  public IMailSender putIf(Object key, Supplier<Boolean> condition, Supplier value) {
    if(condition.get()) put(key, value.get());
    return this;
  }
 
  @Override
  public IMailSender put(Object key, Object value) {
    if(key != null && value != null) attributes.put(key, value);
    return this;
  }
 
  @Override
  public IMailSender putAll(Map attributes) {
    this.attributes.putAll(attributes);
    return this;
  }
 
  protected Map getAttributes() {
    return attributes;
  }
  
  /* Direct sending */
  
  @Override
  public void send(String subject, String message) {
    NotificationCategory category = Notifications.getCategory(defaultCategory);
    send(category, subject, message);
  }
  
  @Override
  public void send(NotificationCategory category, String subject, String message) {
    doSend(category, subject, message);
  }
  
  protected abstract void doSend(NotificationCategory category, String subject, String message);
 
  /* Template sending */
  
  @Override
  public void sendTemplate(String template, String subject) throws EmailException {
    NotificationCategory category = Notifications.getCategory(defaultCategory);
    sendTemplate(category, null, template, subject);
  }
  
  @Override
  public void sendTemplate(Object entity, String template, String subject) throws EmailException {
    NotificationCategory category = Notifications.getCategory(defaultCategory);
    sendTemplate(category, entity, template, subject);
  }
  
  @Override
  public void sendTemplate(NotificationCategory category, Object entity, String template, String subject) throws EmailException {
    doSendTemplate(category, entity, template, subject);
  }
 
  @Override
  public void silentSendTemplate(String template, String subject) {
    try {
      sendTemplate(template, subject);
    } catch (EmailException ex) {
      Logger.getLogger(AbstractMailSender.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
  }
 
  @Override
  public void silentSendTemplate(Object entity, String template, String subject) {
    try {
      sendTemplate(entity, template, subject);
    } catch (EmailException ex) {
      Logger.getLogger(AbstractMailSender.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
  }
 
  @Override
  public void silentSendTemplate(NotificationCategory category, Object entity, String template, String subject) {
    try {
      sendTemplate(category, entity, template, subject);
    } catch (EmailException ex) {
      Logger.getLogger(AbstractMailSender.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
  }
 
  protected abstract void doSendTemplate(NotificationCategory category, Object entity, String template, 
          String subject) throws EmailException;
 
  /* Utils */
 
  @Override
  public String processMacros(IContact contact, String text, boolean web) {
    return web ? MailUtils.processMacrosForWeb(contact, text) :
            MailUtils.processMacros(contact, text);
  }
  
}