ForumCtrl.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2020 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.forum.www;
 
import java.io.IOException;
import java.util.Date;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.amic.util.date.CheckDate;
import org.turro.string.Strings;
import org.turro.activity.ParticipationCatchers;
import org.turro.annotation.ElephantPlugin;
import org.turro.assistant.ParticipationInfo;
import org.turro.auth.Authentication;
import org.turro.collections.KeyValueMap;
import org.turro.elephant.context.Application;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.context.IConstructor;
import org.turro.elephant.db.ElephantPU;
import org.turro.elephant.db.WhereClause;
import org.turro.elephant.direct.AbstractDirectEntityCtrl;
import org.turro.elephant.direct.DirectContent;
import org.turro.elephant.entities.db.Post;
import org.turro.elephant.entities.db.Topic;
import org.turro.entities.Entities;
import org.turro.entities.IElephantEntity;
import org.turro.forum.Forums;
import org.turro.forum.db.UniquePath;
import org.turro.html.HTMLEntities;
import org.turro.jpa.Dao;
import org.turro.marker.ElephantMarker;
import org.turro.marker.MarkerHelper;
import org.turro.participation.ParticipationReason;
import org.turro.plugin.contacts.IContact;
import org.turro.util.IdGenerator;
 
@ElephantPlugin(label="forum-ctrl")
@DirectContent(identifier="forum-action")
public class ForumCtrl extends AbstractDirectEntityCtrl {
 
  private List<Topic> topics;
 
  public ForumCtrl() {
    super("forum", "forum");
  }
 
  /* Delete */
  
  public boolean canDelete(Topic topic) {
    IContact contact = Authentication.getIContact();
    Date allowed = new CheckDate().addDays(-1).getDate();
    return (Application.getApplication().isInRole("contact-comment:delete") ||
        (topic.getAuthorId().equals(contact.getId()) && allowed.before(topic.getCreation()))) && 
        topic.getPosts().isEmpty();
  }
  
  public boolean canDelete(Post post) {
    IContact contact = Authentication.getIContact();
    Date allowed = new CheckDate().addDays(-1).getDate();
    return (Application.getApplication().isInRole("contact-comment:delete") ||
        (post.getAuthorId().equals(contact.getId()) && allowed.before(post.getCreation()))) && 
        post.getPosts().isEmpty();
  }
  
  public String getDeleteLink(Topic topic) {
    return createRightNowURL("type=delete;topic=" + topic.getId());
  }
  
  public String getDeleteLink(Post post) {
    return createRightNowURL("type=delete;post=" + post.getId());
  }
  
  @Override
  protected void prepareCleanMarker(ElephantMarker marker, KeyValueMap map) {
    throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
  }
 
  /* IEntityCtrl */
  
  @Override
  public boolean hasContent() {
    getRelatedTopics();
    return !topics.isEmpty() && super.hasContent();
  }
 
  @Override
  protected void prepareMarker(ElephantMarker marker) {
    marker.put("topics", getRelatedTopics());
  }
  
  /* IDirectContent */
 
  @Override
  protected String getIdentifier() {
    return ForumCtrl.class.getAnnotation(DirectContent.class).identifier();
  }
 
  @Override
  protected void doExecute(IConstructor constructor, KeyValueMap map) {
    String type = map.get("type");
    if("participate".equals(type)) {
      processParticipate(map, constructor);
    } else if("new-topic-form". equals(type)) {
      renderNewTopicForm(map, constructor);
    } else if("new-topic". equals(type)) {
      processNewTopic(map, constructor);
    } else if("reply-form". equals(type)) {
      renderReplyForm(map, constructor);
    } else if("reply". equals(type)) {
      processReply(map, constructor);
    } else if("delete". equals(type)) {
      processDelete(map, constructor);
    }
  }
 
  /* ForumCtrl */
  
  public String renderNewTopicContainer(IConstructor constructor) {
    if(!Strings.isBlank(entityPath)) {
      ElephantMarker marker = new ElephantMarker(constructor);
      marker.put("entityPath", entityPath);
      String containerId = "cic_" + IdGenerator.generate();
      marker.put("containerId", containerId);
      marker.put("newTopicLink", getAjaxUrl(containerId, 
              "type=new-topic-form;entityPath=" + entityPath +
              ";containerId=" + containerId));
      return marker.parse("forum", "new-topic-container");
    }
    return null;
  }
  
  public String renderReplyContainer(IConstructor constructor, Topic topic) {
    ElephantMarker marker = new ElephantMarker(constructor);
    marker.put("topic", topic);
    String containerId = "cic_" + IdGenerator.generate();
    marker.put("containerId", containerId);
    marker.put("replyLink", getAjaxUrl(containerId, 
            "type=reply-form;topic=" + topic.getId() +
            ";containerId=" + containerId));
    return marker.parse("forum", "reply-container");
  }
  
  public String renderReplyContainer(IConstructor constructor, Post post) {
    ElephantMarker marker = new ElephantMarker(constructor);
    marker.put("post", post);
    String containerId = "cic_" + IdGenerator.generate();
    marker.put("containerId", containerId);
    marker.put("replyLink", getAjaxUrl(containerId, 
            "type=reply-form;post=" + post.getId() +
            ";containerId=" + containerId));
    return marker.parse("forum", "reply-container");
  }
  
  public String getParticipationLink(Topic topic) {
    return createPOST("type=participate;topic=" + topic.getId());
  }
  
  public boolean isMine(Topic topic) {
    IContact contact = Authentication.getIContact();
    return topic.isParticipant(contact); 
  }
 
  private List<Topic> getRelatedTopics() {
    if(topics == null) {
      WhereClause wc = new WhereClause();
      wc.addClause("select c from Topic c");
      wc.addClause("where c.entityPath = :entityPath");
      wc.addNamedValue("entityPath", entityPath);
      topics = getDao().getResultList(wc);
    }
    return topics;
  }
  
  private void processParticipate(KeyValueMap map, IConstructor constructor) {
    Long toid = map.get(Long.class, "topic");
    Topic topic = getDao().find(Topic.class, toid);
    if(topic != null && Authentication.hasContact()) {
      new ParticipationInfo("/topic/" + topic.getId(), ParticipationReason.REASON_PARTICIPATE).check();
    }
  }
 
  private void renderNewTopicForm(KeyValueMap map, IConstructor constructor) {
    setEntityPath(map.get("entityPath"));
    ElephantMarker marker = getCleanMarkerFrom(constructor);
    addContainerId(marker, false);
    marker.putAll(map);
    marker.put("newTopicLink", getAjaxSubmitUrl(map.get("containerId")));
    try {
      constructor.getResponse().setContentType("text/html");
      constructor.getResponse().setCharacterEncoding(ElephantContext.getEncoding());
      marker.process("forum", "new-topic", constructor.getResponse().getWriter());
    } catch (IOException ex) {
      Logger.getLogger(ForumCtrl.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
  }
 
  private void processNewTopic(KeyValueMap map, IConstructor constructor) {
    IContact contact = Authentication.getIContact();
    if(contact != null && contact.isWebUser()) {
      Topic topic = new Topic();
      String body = map.get("body"),
             entityPath = map.get("entityPath");
      IElephantEntity iee = Entities.getController(entityPath);
      if(iee.getPath() != null && !Strings.isBlank(body) && body.length() > 100) {
        topic.setText(HTMLEntities.escape(body));
        topic.setCreation(new Date());
        topic.setAuthorId(contact.getId());
        topic.setEntityPath(entityPath);
        if(!topic.isEmpty()) {
          topic = getDao().saveObject(topic);
          UniquePath.normalizeUniquePaths(topic);
          Forums.markAsUnseenExceptFor(topic, contact);
          Forums.notify(topic);
          ElephantMarker marker = getCleanMarkerFrom(constructor);
          addContainerId(marker, false);
          marker.put("topic", topic);
          marker.put("containerId", map.get("containerId"));
          try {
            constructor.getResponse().setContentType("text/html");
            constructor.getResponse().setCharacterEncoding(ElephantContext.getEncoding());
            marker.process("forum", "single-related", constructor.getResponse().getWriter());
          } catch (IOException ex) {
            Logger.getLogger(ForumCtrl.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
          }
        }
      }
    }
  }
 
  private void renderReplyForm(KeyValueMap map, IConstructor constructor) {
    if(map.containsKey("post")) {
      setEntityPath("/post/" + map.get("post"));
    } else if(map.containsKey("topic")) {
      setEntityPath("/topic/" + map.get("topic"));
    }
    ElephantMarker marker = getCleanMarkerFrom(constructor);
    addContainerId(marker, false);
    marker.putAll(map);
    marker.put("replyLink", createURL());
    try {
      constructor.getResponse().setContentType("text/html");
      constructor.getResponse().setCharacterEncoding(ElephantContext.getEncoding());
      marker.process("forum", "reply", constructor.getResponse().getWriter());
    } catch (IOException ex) {
      Logger.getLogger(ForumCtrl.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
  }
  
  private void processReply(KeyValueMap map, IConstructor constructor) {
    IContact contact = Authentication.getIContact();
    if(contact != null && contact.isWebUser()) {
      Post post = new Post();
      String body = map.get("body");
      if(!Strings.isBlank(body)) {
        post.setText(HTMLEntities.escape(body));
        post.setCreation(new Date());
        post.setAuthorId(contact.getId());
        if(map.containsKey("post")) {
          Post parent = getDao().find(Post.class, map.get(Long.class, "post"));
          post.setParent(parent);
        } else if(map.containsKey("topic")) {
          Topic parent = getDao().find(Topic.class, map.get(Long.class, "topic"));
          post.setTopic(parent);
        }
        if(!post.isEmpty()) {
          post = getDao().saveObject(post);
          UniquePath.normalizeUniquePaths(post);
          Forums.markAsUnseenExceptFor(post, contact);
          Forums.notify(post);
          try {
            constructor.redirect("/user/forums?" + MarkerHelper.setObfuscatedPars("item=" + post.getParentTopic().getId()));
          } catch (IOException ex) {
            Logger.getLogger(ForumCtrl.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
          }
        }
      }
    }
  }
 
  private void processDelete(KeyValueMap map, IConstructor constructor) {
    IContact contact = Authentication.getIContact();
    Long redirectId = null;
    if(contact != null && contact.isWebUser()) {
      if(map.containsKey("post")) {
        Post post = getDao().find(Post.class, map.get(Long.class, "post"));
        if(post != null && post.getPosts(getDao()).isEmpty()) {
          redirectId = post.getParentTopic().getId();
          ParticipationCatchers.doDelete(post);
          getDao().deleteObject(post);
        }
      } else if(map.containsKey("topic")) {
        Topic topic = getDao().find(Topic.class, map.get(Long.class, "topic"));
        if(topic != null && topic.getPosts(getDao()).isEmpty()) {
          ParticipationCatchers.doDelete(topic);
          getDao().deleteObject(topic);
        }
      }
      try {
        if(redirectId != null) {
          constructor.redirect("/user/forums?" + MarkerHelper.setObfuscatedPars("item=" + redirectId));
        } else {
          constructor.redirect("/user/forums");
        }
      } catch (IOException ex) {
        Logger.getLogger(ForumCtrl.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
      }
    }
  }
 
  /* Dao */
  
  private Dao _dao;
  
  private Dao getDao() {
    if(_dao == null) {
      _dao = new ElephantPU();
    }
    return _dao;
  }
 
}