AbstractChallengeNotification.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2019 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.students.mail;
 
import java.net.URLEncoder;
import java.util.HashMap;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.apache.commons.mail.EmailException;
import org.turro.action.Actions;
import org.turro.action.LinkType;
import org.turro.action.MailSenders;
import org.turro.action.queue.NotificationCategory;
import org.turro.assistant.Assistant;
import org.turro.assistant.AssistantSet;
import org.turro.auth.Authentication;
import org.turro.elephant.context.Application;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.context.IConstructor;
import org.turro.elephant.security.IUser;
import org.turro.mail.message.MailMessageTemplate;
import org.turro.mail.provider.MailProviders;
import org.turro.mail.queue.GenericElephantNotification;
import org.turro.mail.queue.QueueManager;
import org.turro.marker.ElephantMarker;
import org.turro.path.Path;
import org.turro.plugin.contacts.IContact;
import org.turro.students.command.StudentsEntityInfo;
import org.turro.students.db.StudentsPU;
import org.turro.students.entities.Challenge;
import org.turro.students.entities.Response;
import org.turro.students.wrappers.ChallengeWrapper;
 
public abstract class AbstractChallengeNotification {
 
  protected final Challenge challenge;
  protected final Response response;
  protected final IConstructor constructor;
  protected final IContact loggedContact;
  
  public AbstractChallengeNotification(Challenge challenge) {
    this.challenge = challenge;
    this.response = null;
    constructor = Application.getApplication().getConstructor();
    loggedContact = Authentication.getIContact();
  }
 
  public AbstractChallengeNotification(Response response) {
    this.response = response;
    this.challenge = response.getChallenge();
    constructor = Application.getApplication().getConstructor();
    loggedContact = Authentication.getIContact();
  }
 
  public void send(String template, String reason) {
    addToQueue(template, reason);
  }
  
  public String create(IConstructor constructor, Challenge challenge, IContact contact) throws Exception {
    return create(constructor, 
            StudentsEntityInfo.linkForPath(new Path(StudentsPU.getObjectPath(challenge)), contact, LinkType.WEB),
            contact.getConnector(IUser.CONNECTOR_EMAIL));
  }
 
  public String create(IConstructor constructor, String redir, String email) throws Exception {
    HashMap<String, String> values = new HashMap<>();
    values.put(Actions.USER_PAR, email);
    values.put(Actions.REDIR_PAR, URLEncoder.encode(redir, "UTF-8"));
    return Actions.createAction(values, 7, false);
  }
  
  public String createRef(IConstructor constructor, Challenge challenge, IContact contact) throws Exception {
    return createRef(constructor, 
            StudentsEntityInfo.linkForPath(new Path(StudentsPU.getObjectPath(challenge)), contact, LinkType.WEB));
  }
 
  public String createRef(IConstructor constructor, String redir) throws Exception {
    return "{liveref:" + redir + "}";
  }
  
  private void addToQueue(String template, String reason) {
    QueueManager qm = new QueueManager();
    NotificationCategory nc = new GenericElephantNotification().getCategory(GenericElephantNotification.GENERIC_NOTIFICATION);
    for(Assistant assistant : getAssistants()) {
      try {
        if(qm.contactMayWant(assistant.contact, nc.getIdCategory())) {
          MailMessageTemplate mmt = MailMessageTemplate.of(MailProviders.instance().getProvider("Students"));
          mmt.setProcessLiveLinks(false);
          mmt.setRoot("/challenges");
          mmt.setSubject(getSubject(reason));
          mmt.addTo(assistant.email, assistant.name);
          ElephantMarker em = new ElephantMarker(constructor, true);
          em.put("challenge", challenge);
          em.put("response", response);
          em.put("wrapper", new ChallengeWrapper(challenge));
          em.put("contact", assistant.contact);
          em.put("email", assistant.email);
          em.put("notifier", this);
          initMarker(em);
          mmt.setMessage(em, template, assistant.contact);
          qm.addToQueue(nc, assistant.contact, mmt, reason, "Students");
        }
      } catch (EmailException ex) {
        Logger.getLogger(AbstractChallengeNotification.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
      }
    }
  }
  
  protected String getSubject(String reason) {
    return String.format("[%s #%d %s] %s", 
            reason,
            challenge.getId(),
            loggedContact.getName(),
            challenge.getQuestion());
  }
 
  public abstract void sendNotification();
  protected abstract AssistantSet getAssistants();
  protected abstract void initMarker(ElephantMarker marker);
  
}