TreeDaoContentIterator.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.jpa.content;
 
import java.util.List;
import java.util.Map;
import org.turro.action.IEntityCtrl;
import org.turro.action.Plugins;
import org.turro.collections.Item;
import org.turro.elephant.context.IConstructor;
import org.turro.elephant.db.WhereClause;
import org.turro.entities.Entities;
import org.turro.entities.IElephantEntity;
import org.turro.jpa.Dao;
import org.turro.jpa.iterator.DaoHtmlTree;
import org.turro.marker.ElephantMarker;
import org.turro.marker.MarkerHelper;
import org.turro.plugin.contacts.IContact;
 
public abstract class TreeDaoContentIterator<E, ID> extends DaoHtmlTree<E, ID> {
 
  private boolean restricted, allowInterest, allowComments, allowVotes, 
          allowDescriptions, allowAttachments, allowFiles, allowPolls,
          allowForum;
  private final String contextPath;
  private final IContact contact;
 
  public TreeDaoContentIterator(Dao dao, ElephantMarker marker, String contextPath, IContact contact) {
    super(dao, marker);
    this.contextPath = contextPath;
    this.contact = contact;
    processParameters();
  }
 
  public boolean isRestricted() {
    return restricted;
  }
 
  public void setRestricted(boolean restricted) {
    this.restricted = restricted;
  }
 
  public boolean isAllowInterest() {
    return allowInterest;
  }
 
  public void setAllowInterest(boolean allowInterest) {
    this.allowInterest = allowInterest;
  }
 
  public boolean isAllowComments() {
    return allowComments;
  }
 
  public void setAllowComments(boolean allowComments) {
    this.allowComments = allowComments;
  }
 
  public boolean isAllowVotes() {
    return allowVotes;
  }
 
  public void setAllowVotes(boolean allowVotes) {
    this.allowVotes = allowVotes;
  }
 
  public boolean isAllowDescriptions() {
    return allowDescriptions;
  }
 
  public void setAllowDescriptions(boolean allowDescriptions) {
    this.allowDescriptions = allowDescriptions;
  }
 
  public boolean isAllowAttachments() {
    return allowAttachments;
  }
 
  public void setAllowAttachments(boolean allowAttachments) {
    this.allowAttachments = allowAttachments;
  }
 
  public boolean isAllowFiles() {
    return allowFiles;
  }
 
  public void setAllowFiles(boolean allowFiles) {
    this.allowFiles = allowFiles;
  }
 
  public boolean isAllowPolls() {
    return allowPolls;
  }
 
  public void setAllowPolls(boolean allowPolls) {
    this.allowPolls = allowPolls;
  }
 
  public boolean isAllowForum() {
    return allowForum;
  }
 
  public void setAllowForum(boolean allowForum) {
    this.allowForum = allowForum;
  }
 
  public String getContextPath() {
    return contextPath;
  }
 
  public IContact getContact() {
    return contact;
  }
  
  /* Parameters */
  
  public static String getSelectionLink(String path) {
    return MarkerHelper.setObfuscatedPars("selected=" + path);
  }
  
  public String getCssClass(String path) {
    String selected = getSelectedItem();
    if(path == null || selected == null) {
      return "";
    } else if(path.equals(selected)) {
      return "active";
    } else if(selected.startsWith(path)) {
      return "inpath";
    } else {
      return "";
    }
  }
 
  private void processParameters() {
    Map map = MarkerHelper.getObfuscatedParameters();
    if(map != null) {
      setSelectedItem((String) map.get("selected"));
    }
  }
 
  protected void setSelectedItem(String value) {
    if(value != null) {
      constructor.setSessionAttribute(contextPath + "-selected-tree-item", value);
    }
  }
  
  public String getSelectedItem() {
    return (String) constructor.getSessionAttribute(contextPath + "-selected-tree-item");
  }
  
  public static String getSelectedItem(IConstructor constructor, String pathOrigin) {
    return (String) constructor.getSessionAttribute(pathOrigin + "-selected-tree-item");
  }
  
  /* Abstract */
  
  protected abstract void prepareTree(ElephantMarker marker, List<Item<E, ID>> items);
  protected abstract void prepareItem(ElephantMarker marker, E item);
  protected abstract String getTemplateRoot();
  protected abstract Object doVotesCtrl(E e);
  protected abstract Object doInterestCtrl(E e);
  protected abstract Object doCommentsCtrl(E e);
  protected abstract Object doAttachmentsCtrl(E e);
  protected abstract Object doFilesCtrl(E e);
  protected abstract Object doDescriptionsCtrl(E e);
  protected abstract Object doPollsCtrl(E e);
  protected abstract WhereClause getItemClause(String currPath);
 
  /* DaoHtmlTree */
  
  @Override
  public void renderSelected() {
    Object selected = getDao().getSingleResultOrNull(getItemClause(getSelectedItem()));
    if(selected != null) {
      marker.put("iterator", this);
      marker.put("item", selected);
      marker.process(getTemplateRoot(), getFullTemplate());
    }
  }
  
  @Override
  public String parseSelected() {
    Object selected = getDao().getSingleResultOrNull(getItemClause(getSelectedItem()));
    if(selected != null) {
      marker.put("iterator", this);
      marker.put("item", selected);
      return marker.parse(getTemplateRoot(), getFullTemplate());
    }
    return "";
  }
 
  @Override
  protected void renderTree(ElephantMarker marker, List<Item<E, ID>> items) {
    marker.put("context", contextPath);
    marker.put("items", items);
    marker.put("tree", this);
    prepareTree(marker, items);
    marker.process(getTemplateRoot(), getTreeTemplate());
  }
 
  @Override
  protected void renderItem(ElephantMarker marker, E item) {
    marker.put("item", item);
    marker.put("tree", this);
    prepareItem(marker, item);
    marker.process(getTemplateRoot(), getFullTemplate());
  }
 
  @Override
  protected String parseTree(ElephantMarker marker, List<Item<E, ID>> items) {
    marker.put("context", contextPath);
    marker.put("items", items);
    marker.put("tree", this);
    prepareTree(marker, items);
    return marker.parse(getTemplateRoot(), getTreeTemplate());
  }
 
  @Override
  protected String parseItem(ElephantMarker marker, E item) {
    marker.put("item", item);
    marker.put("tree", this);
    prepareItem(marker, item);
    return marker.parse(getTemplateRoot(), getFullTemplate());
  }
 
  /* Controls */
  
  public Object getVotesCtrl(E e) {
    if(isAllowVotes()) {
      return doVotesCtrl(e);
    }
    return null;
  }
  
  public Object getInterestCtrl(E e) {
    if(isAllowInterest()) {
      return doInterestCtrl(e);
    }
    return null;
  }
  
  public Object getCommentsCtrl(E e) {
    if(isAllowComments()) {
      return doCommentsCtrl(e);
    }
    return null;
  }
 
  public Object getAttachmentsCtrl(E e) {
    if(isAllowAttachments()) {
      return doAttachmentsCtrl(e);
    }
    return null;
  }
 
  public Object getFilesCtrl(E e) {
    if(isAllowFiles()) {
      return doFilesCtrl(e);
    }
    return null;
  }
 
  public Object getDescriptionsCtrl(E e) {
    if(isAllowDescriptions()) {
      return doDescriptionsCtrl(e);
    }
    return null;
  }
  
  public Object getPollsCtrl(E e) {
    if(isAllowPolls()) {
      return doPollsCtrl(e);
    }
    return null;
  }
 
  public Object getForumCtrl(E e) {
    if(isAllowForum()) {
      IEntityCtrl ecf = Plugins.loadImplementation(IEntityCtrl.class, "forum-ctrl");
      if(ecf != null) {
        IElephantEntity iee = Entities.getController(e);
        ecf.setConstructor(constructor);
        ecf.setEntityPath(iee.getPath());
        ecf.setTemplate("related");
        marker.put("forum", ecf);
        return iee.configureCtrl(ecf, getContact());
      }
    }
    return null;
  }
  
}