QueueManager.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.queue;
 
import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
import org.amic.util.date.CheckDate;
import org.turro.action.Contacts;
import org.turro.action.queue.ConstraintKeys;
import org.turro.string.Strings;
import org.turro.action.queue.NotificationCategory;
import org.turro.action.queue.Notifications;
import org.turro.action.queue.QueuePeriod;
import org.turro.elephant.context.IConstructor;
import org.turro.elephant.db.ElephantPU;
import org.turro.elephant.db.WhereClause;
import org.turro.elephant.entities.db.MailItem;
import org.turro.elephant.entities.db.QueueOptions;
import org.turro.jpa.Dao;
import org.turro.mail.message.MailMessage;
import org.turro.plugin.contacts.IContact;
import org.turro.sql.SqlClause;
 
public class QueueManager {
  
  public static void send(IConstructor constructor, QueuePeriod period) {
    boolean lockAcquired = QUEUEMANAGER_LOCK.tryLock();
    if(lockAcquired) {
      try {
        QueueManager qm = new QueueManager();
        qm.removeWithoutOptions();
        qm.removeOldsByPeriod();
        ContactMap cm = qm.getContactMap(qm.getPending(period));
        for(String idContact : cm.keySet()) {
          new ContactQueueSender(constructor, qm, period, cm.get(idContact)).send();
        }
      } finally {
        QUEUEMANAGER_LOCK.unlock();
      }
    }
  }
  
  public MailItem addToQueue(NotificationCategory category, IContact contact, 
          MailMessage mmt, String reason, String poolName) {
    if(contact.isWebUser()) {
      MailItem mi = new MailItem();
      mi.setIdCategory(category.getIdCategory());
      mi.setCategory(category.getCategory());
      mi.setDescription(category.getDescription());
      mi.setIContact(contact);
      mi.setItemDate(mmt.getSentDate());
      mi.setSubject(mmt.getSubject());
      mi.setMessage(mmt.getMessage());
      mi.setReason(cleanSubject(reason));
      mi.setPoolName(poolName);
      if(category.isUnique()) {
        removeUniquesFor(category.getIdCategory(), contact.getId());
      }
      checkConfiguration(contact, category.getIdCategory(), category.getDefaultPeriod());
      return getDao().saveObject(mi);
    }
    return null;
  }
  
  public MailItem addToQueue(NotificationCategory category, IContact contact, 
          String subject, String message, String reason, String poolName) {
    if(contact.isWebUser()) {
      MailItem mi = new MailItem();
      mi.setIdCategory(category.getIdCategory());
      mi.setCategory(category.getCategory());
      mi.setDescription(category.getDescription());
      mi.setIContact(contact);
      mi.setItemDate(new Date());
      mi.setSubject(subject);
      mi.setMessage(message);
      mi.setReason(cleanSubject(reason));
      mi.setPoolName(poolName);
      if(category.isUnique()) {
        removeUniquesFor(category.getIdCategory(), contact.getId());
      }
      checkConfiguration(contact, category.getIdCategory(), category.getDefaultPeriod());
      return getDao().saveObject(mi);
    }
    return null;
  }
  
  public void checkConfiguration(IContact contact, String idCategory, QueuePeriod queuePeriod) {
    QueueOptions qo = getConfiguration(contact, idCategory);
    if(qo == null) {
      qo = new QueueOptions();
      qo.setIdCategory(idCategory);
      qo.setIdContact(contact.getId());
      qo.setPeriod(queuePeriod);
      qo.setSingleMail(true);
      configQueue(qo);
    }
  }
 
  public void setPeriod(IContact contact, String idCategory, QueuePeriod queuePeriod, boolean override) {
    QueueOptions qo = getConfiguration(contact, idCategory);
    if(qo != null && !override) return;
    if(qo == null) {
      qo = new QueueOptions();
      qo.setIdCategory(idCategory);
      qo.setIdContact(contact.getId());
      qo.setSingleMail(true);
    }
    qo.setPeriod(queuePeriod);
    configQueue(qo);
  }
 
  public void subscribeDefaults(ConstraintKeys keys) {
    for(NotificationCategory nc : Notifications.getCategories()) {
      if(nc.wideBond(keys)) {
        checkConfiguration(keys.contact(), nc.getIdCategory(), nc.getDefaultPeriod());
      } else if(!nc.strongBond(keys)) {
        removeOptions(getConfiguration(keys.contact(), nc.getIdCategory()));
      }
    }
  }
 
  public QueueOptions getConfiguration(IContact contact, String idCategory) {
    WhereClause wc = new WhereClause();
    wc.addClause("select o from QueueOptions o");
    wc.addClause("where o.idContact = :idContact");
    wc.addClause("and o.idCategory = :idCategory");
    wc.addNamedValue("idContact", contact.getId());
    wc.addNamedValue("idCategory", idCategory);
    return (QueueOptions) getDao().getSingleResultOrNull(wc);
  }
  
  public QueueOptions configQueue(QueueOptions qo) {
    return getDao().saveObject(qo);
  }
  
  public boolean contactWants(IContact contact, String idCategory) {
    QueueOptions qo = getConfiguration(contact, idCategory);
    return qo != null && !QueuePeriod.DONT_SEND.equals(qo.getPeriod());
  }
 
  public boolean contactMayWant(IContact contact, String idCategory) {
    QueueOptions qo = getConfiguration(contact, idCategory);
    return qo == null || !QueuePeriod.DONT_SEND.equals(qo.getPeriod());
  }
 
  public List<MailItem> getPending(QueuePeriod period) {
    WhereClause wc = new WhereClause();
    wc.addClause("select m from MailItem m, QueueOptions o");
    wc.addClause("where o.period = :period");
    wc.addClause("and m.idContact = o.idContact");
    wc.addClause("and m.idCategory = o.idCategory");
    wc.addClause("order by m.idContact, m.idCategory");
    wc.addNamedValue("period", period);
    return getDao().getResultList(wc);
  }
  
  public ContactMap getContactMap(List<MailItem> list) {
    ContactMap cm = new ContactMap();
    for(MailItem mi : list) {
      cm.addMailItem(mi);
    }
    return cm;
  }
  
  public void removeUniquesFor(String idCategory, String idContact) {
    WhereClause wc = new WhereClause();
    wc.addClause("delete from MailItem m");
    wc.addClause("where m.idContact = :contact");
    wc.addClause("and m.idCategory = :category");
    wc.addNamedValue("contact", idContact);
    wc.addNamedValue("category", idCategory);
    getDao().executeUpdate(wc);
  }
  
  public void removeMails(QueuePeriod period, String idContact, String idCategory) {
    WhereClause wc = new WhereClause();
    wc.addClause("delete from MailItem m");
    wc.addClause("where m.idContact = :contact");
    wc.addClause("and m.idCategory = :category");
    wc.addClause("and exists (");
    wc.addClause("select o from QueueOptions o");
    wc.addClause("where o.period = :period");
    wc.addClause("and m.idContact = o.idContact");
    wc.addClause("and m.idCategory = o.idCategory");
    wc.addClause(")");
    wc.addNamedValue("contact", idContact);
    wc.addNamedValue("category", idCategory);
    wc.addNamedValue("period", period);
    getDao().executeUpdate(wc);
  }
  
  public void removeContactMails(String idContact) {
    WhereClause wc = new WhereClause();
    wc.addClause("delete from MailItem m");
    wc.addClause("where m.idContact = :contact");
    wc.addNamedValue("contact", idContact);
    getDao().executeUpdate(wc);
  }
  
  public void removeWithoutOptions() {
    WhereClause wc = new WhereClause();
    wc.addClause("delete from MailItem m");
    wc.addClause("where not exists (");
    wc.addClause("select o from QueueOptions o");
    wc.addClause("where m.idContact = o.idContact");
    wc.addClause("and m.idCategory = o.idCategory");
    wc.addClause(")");
    getDao().executeUpdate(wc);
  }
 
  public void removeOldsByPeriod() {
    WhereClause wc = new WhereClause();
    wc.addClause("delete from MailItem m");
    wc.addClause("where exists (");
    wc.addClause("select o from QueueOptions o");
    wc.addClause("where m.idContact = o.idContact");
    wc.addClause("and m.idCategory = o.idCategory");
    wc.addClause("and (");
    wc.addClause("o.period = :dontSend");
    wc.addClause("or (o.period = :asGenerated and m.itemDate < :oneDay)");
    wc.addClause("or (o.period = :daily and m.itemDate < :oneDay)");
    wc.addClause("or (o.period = :weekly and m.itemDate < :oneWeek)");
    wc.addClause("or (o.period = :fortnightly and m.itemDate < :twoWeeks)");
    wc.addClause("or (o.period = :monthly and m.itemDate < :oneMonth)");
    wc.addClause("or (o.period = :quarterly and m.itemDate < :threeMonths)");
    wc.addClause("or (o.period = :everySix and m.itemDate < :sixMonths)");
    wc.addClause("or (o.period = :yearly and m.itemDate < :oneYear)");
    wc.addClause("))");
    wc.addNamedValue("dontSend", QueuePeriod.DONT_SEND);
    wc.addNamedValue("asGenerated", QueuePeriod.AS_GENERATED);
    wc.addNamedValue("daily", QueuePeriod.DAILY);
    wc.addNamedValue("oneDay", new CheckDate().addDays(-2).getDate());
    wc.addNamedValue("weekly", QueuePeriod.WEEKLY);
    wc.addNamedValue("oneWeek", new CheckDate().addWeeks(-1).addDays(-2).getDate());
    wc.addNamedValue("fortnightly", QueuePeriod.FORTNIGHTLY);
    wc.addNamedValue("twoWeeks", new CheckDate().addWeeks(-2).addDays(-2).getDate());
    wc.addNamedValue("monthly", QueuePeriod.MONTHLY);
    wc.addNamedValue("oneMonth", new CheckDate().addMonths(-1).addDays(-2).getDate());
    wc.addNamedValue("quarterly", QueuePeriod.QUARTERLY);
    wc.addNamedValue("threeMonths", new CheckDate().addMonths(-3).addDays(-2).getDate());
    wc.addNamedValue("everySix", QueuePeriod.EVERY_SIX_MONTHS);
    wc.addNamedValue("sixMonths", new CheckDate().addMonths(-6).addDays(-2).getDate());
    wc.addNamedValue("yearly", QueuePeriod.YEARLY);
    wc.addNamedValue("oneYear", new CheckDate().addYears(-1).addDays(-2).getDate());
    getDao().executeUpdate(wc);
  }
  
  public void removeOptions(String idCategory) {
    WhereClause wc = new WhereClause();
    wc.addClause("delete from QueueOptions o");
    wc.addClause("where o.idCategory = :category");
    wc.addNamedValue("category", idCategory);
    getDao().executeUpdate(wc);
  }
 
  public void setPeriodToAll(String idCategory, QueuePeriod period) {
    WhereClause wc = new WhereClause();
    wc.addClause("update QueueOptions o");
    wc.addClause("set o.period = :period");
    wc.addClause("where o.idCategory = :category");
    wc.addNamedValue("period", period);
    wc.addNamedValue("category", idCategory);
    getDao().executeUpdate(wc);
  }
 
  public void checkConstraints(String idCategory) {
    NotificationCategory nc = Notifications.getCategory(idCategory);
    if(nc.getConstraints().isRestricted()) {
      List<QueueOptions> toDelete = new ArrayList<>();
      SqlClause.select("o").from("QueueOptions o")
              .where().equal("o.idCategory", idCategory)
              .dao(getDao())
              .resultList(QueueOptions.class)
              .forEach(o -> {
                IContact contact = Contacts.getContactById(o.getIdContact());
                if(contact.isValid()) {
                  ConstraintKeys keys = ConstraintKeys.from(contact);
                  if(!nc.strongBond(keys)) {
                    toDelete.add(o);
                    //removeOptions(getConfiguration(keys.contact(), nc.getIdCategory()));
                  }
                } else {
                  toDelete.add(o);
                }
              });
      getDao().deleteCollection(toDelete);
    }
  }
 
  public Collection<QueueOptions> getSubcribers(String idCategory) {
    WhereClause wc = new WhereClause();
    wc.addClause("select o from QueueOptions o");
    wc.addClause("where o.idCategory = :category");
    wc.addNamedValue("category", idCategory);
    return getDao().getResultList(wc);
  }
  
  public Collection<Long> getSubcribersId(String idCategory) {
    WhereClause wc = new WhereClause();
    wc.addClause("select o.id from QueueOptions o");
    wc.addClause("where o.idCategory = :category");
    wc.addNamedValue("category", idCategory);
    return getDao().getResultList(wc);
  }
  
  public void createBulk() {
//    IContact contact = Contacts.getContactByEmail("lluis@turro.org");
//    if(contact != null && contact.isWebUser()) {
//      QueueOptions qo = new QueueOptions();
//      qo.setIdCategory("/myissues");
//      qo.setIdContact(contact.getId());
//      qo.setPeriod(QueuePeriod.AS_GENERATED);
//      qo.setSingleMail(true);
//      configQueue(qo);
//      MailItem mi = new MailItem();
//      mi.setIdCategory("/myissues");
//      mi.setIContact(contact);
//      mi.setDescription("cosa");
//      mi.setCategory("My issues");
//      mi.setItemDate(new Date());
//      mi.setMessage("Message");
//      mi.setSubject("Subject");
//      mi.setPoolName("Dossier");
//      addToQueue(mi);
//    }
  }
 
  public void removeMail(MailItem mi) {
    getDao().deleteObject(mi);
  }
  
  public void removeOptions(QueueOptions qo) {
    if(qo != null) getDao().deleteObject(qo);
  }
  
  private String cleanSubject(String reason) {
    if(Strings.isBlank(reason)) {
      return reason;
    } else {
      int p = reason.indexOf(":");
      return (p > -1 ? reason.substring(0, p) : reason);
    }
  }
 
  /* Migration tools */
  
  public Collection<QueueOptions> getSubcribersByRoot(String root) {
    WhereClause wc = new WhereClause();
    wc.addClause("select o from QueueOptions o");
    wc.addClause("where o.idCategory like :category");
    wc.addNamedValue("category", root + "/%");
    return getDao().getResultList(wc);
  }
 
  /* Dao */
  
  private Dao _dao;
  
  private Dao getDao() {
    if(_dao == null) {
      _dao = new ElephantPU();
    }
    return _dao;
  }
  
  /* Lock */
  
  private static final Lock QUEUEMANAGER_LOCK = new ReentrantLock();
 
}