Newsletter.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2018 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.publication.entity;
 
import java.io.IOException;
import java.io.Writer;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.OneToMany;
import javax.persistence.Temporal;
import org.turro.string.Strings;
import org.turro.action.queue.NotificationCategory;
import org.turro.action.queue.Notifications;
import org.turro.elephant.entities.db.MailTracker;
import org.turro.elephant.util.DateFormats;
import org.turro.html.HTMLEntities;
import org.turro.jpa.entity.IDaoEntity;
import org.turro.newsletter.SendingChoice;
import org.turro.plugin.contacts.IContact;
import org.turro.reflection.MappingSet;
 
@Entity
public class Newsletter implements java.io.Serializable, IDaoEntity {
  
  @Id
  @GeneratedValue(strategy=GenerationType.IDENTITY)
  @Column(name="IDENTIFIER")
  private Long id;
 
  @Temporal(value = javax.persistence.TemporalType.TIMESTAMP)
  private java.util.Date creation;
 
  private boolean accepted, staticContent;
 
  private String idCategory;
  
  @Temporal(value = javax.persistence.TemporalType.DATE)
  @Column(name="NEWS_DATE")
  private java.util.Date date;
 
  private String title, lang, template;
  
  private SendingChoice sendingChoice;
 
  @OneToMany(mappedBy = "newsletter", fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval=true)
  private Set<NewsSection> newsSections = new TreeSet<NewsSection>();
 
  public boolean isAccepted() {
    return accepted;
  }
 
  public void setAccepted(boolean accepted) {
    this.accepted = accepted;
  }
 
  public boolean isStaticContent() {
    return staticContent;
  }
 
  public void setStaticContent(boolean staticContent) {
    this.staticContent = staticContent;
  }
 
  public String getIdCategory() {
    return idCategory;
  }
 
  public void setIdCategory(String idCategory) {
    this.idCategory = idCategory;
  }
 
  public Date getCreation() {
    return creation;
  }
 
  public void setCreation(Date creation) {
    this.creation = creation;
  }
 
  public Date getDate() {
    return date;
  }
 
  public String getDateStr() {
    return DateFormats.format(date, true);
  }
 
  public void setDate(Date date) {
    this.date = date;
  }
 
  public Long getId() {
    return id;
  }
 
  public void setId(Long id) {
    this.id = id;
  }
 
  public String getTitle() {
    return title;
  }
 
  public void setTitle(String title) {
    this.title = HTMLEntities.escape(title);
  }
 
  public String getUnescapedTitle() {
    return HTMLEntities.unescape(title);
  }
 
  public String getLang() {
    return lang;
  }
 
  public void setLang(String lang) {
    this.lang = lang;
  }
 
  public String getTemplate() {
    return template;
  }
 
  public void setTemplate(String template) {
    this.template = template;
  }
 
  public SendingChoice getSendingChoice() {
    return sendingChoice;
  }
 
  public void setSendingChoice(SendingChoice sendingChoice) {
    this.sendingChoice = sendingChoice;
  }
 
  public Set<NewsSection> getNewsSections() {
    return newsSections;
  }
 
  public void setNewsSections(Set<NewsSection> newsSections) {
    this.newsSections = newsSections;
  }
 
  /* IDaoEntity */
  
  @Override
  public Object entityId() {
    return id;
  }
 
  @Override
  public boolean isEmpty() {
    return Strings.isBlank(title) || newsSections.isEmpty();
  }
  
  public boolean trigger(IContact contact) {
    if(newsSections.stream().anyMatch((ns) -> (ns.isUseAsTrigger()))) {
      return newsSections.stream().anyMatch((ns) -> (ns.isUseAsTrigger() && ns.canShow(contact)));
    } else {
      return true;
    }
  }
 
  public NotificationCategory getCategory() {
    return idCategory != null ? Notifications.getCategory(idCategory) : null;
  }
  
  public void setCategory(NotificationCategory category) {
    idCategory = category != null ? category.getIdCategory() : null;
  }
  
  public List<MailTracker> getTrackers() {
    return new ArrayList<>();
  }
  
  public void generateNewsletter(IContact contact, Writer writer) throws IOException {
    writer.write("<#include \"/macros/site/*/buttonMacro.ftl\">\n");
    writer.write("<#include \"/macros/site/*/summaryMacro.ftl\">\n");
    writer.write("<#include \"/envelope/site/*/header" + 
            (Strings.isBlank(template) ? "" : template) + 
            "Template.html\">\n");
    
    writer.write("<@start_full_table \"2\" \"2\"/>\n");
    
    for(NewsSection ns : new TreeSet<>(newsSections)) {
      if(ns.canShow(contact)) {
        ns.generateSection(writer);
      }
    }
 
    writer.write("<@end_table/>\n");
    
    writer.write("<#include \"/envelope/site/*/footer" + 
            (Strings.isBlank(template) ? "" : template) + 
            "Template.html\">\n");
  } 
  
  public boolean checkStartRow(NewsSection newsSection) {
    NewsSection ns = new TreeSet<>(newsSections).lower(newsSection);
    return ns == null || !ns.isNewColumn();
  }
  
  public boolean checkEndRow(NewsSection newsSection) {
    NewsSection ns = new TreeSet<>(newsSections).higher(newsSection);
    return ns == null || !ns.isNewColumn();
  }
  
  public void resetSections() {
    newsSections.forEach((ns) -> {
      ns.reset();
    });
  }
  
  public void resetGlobalContext() {
    newsSections.forEach((ns) -> {
      ns.resetGlobalContext();
    });
  }
  
  /* XML Serializer */
 
  public MappingSet getSerializerMappings() {
    MappingSet set = new MappingSet();
    set.addMapping(Newsletter.class, 1, 
            new String[] { "id", "creation", "date", "accepted", "staticContent" }, 
            new String[] { "title", "lang", "template", "idCategory", "sendingChoice",
              "newsSections" });
    set.addMapping(NewsSection.class, 2,
            new String[] { "id", "newsOrder", "newColumn", "width", "useAsTrigger", 
              "hideIfEmpty", "type" }, 
            new String[] { "body", "wiki", "banner" });
    return set;
  }
 
}