EntityDaoContentIterator.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.jpa.content;
 
import java.io.Writer;
import java.nio.file.Paths;
import java.util.Optional;
import org.turro.string.Strings;
import org.turro.action.IEntityCtrl;
import org.turro.action.Plugins;
import org.turro.elephant.context.IConstructor;
import org.turro.entities.EmptyController;
import org.turro.entities.Entities;
import org.turro.entities.IElephantEntity;
import org.turro.jpa.Dao;
import org.turro.jpa.entity.EntityWebUrls;
import org.turro.jpa.iterator.DaoHtmlIterator;
import org.turro.marker.ElephantMarker;
import org.turro.marker.MarkerHelper;
import org.turro.parser.processor.MacroProcessorContext;
import org.turro.participation.ParticipationReason;
import org.turro.plugin.contacts.IContact;
 
public abstract class EntityDaoContentIterator<E, ID> extends DaoHtmlIterator<E, ID>  {
 
  private final String contextPath;
  private final IContact contact;
  private final boolean mail;
  private SeenStatusCheck seenStatus = SeenStatusCheck.DONT_CHECK;
 
  public EntityDaoContentIterator(Dao dao, IConstructor constructor, 
          Writer writer, IContact contact, boolean mail, String contextPath) {
    super(dao, new ElephantMarker(constructor, mail), writer);
    this.contextPath = Optional.ofNullable(contextPath)
            .orElse(
                    Optional.ofNullable(constructor)
                            .map(cons -> cons.getCurrentContext())
                            .map(ctx -> ctx.getFullPath())
                            .filter(path -> !path.endsWith("/user"))
                            .orElse(null)
            );
    this.contact = contact;
    this.mail = mail;
  }
 
  public void setSeenStatus(SeenStatusCheck seenStatus) {
    this.seenStatus = seenStatus;
  }
 
  public SeenStatusCheck getSeenStatus() {
    return seenStatus;
  }
 
  public String getId() {
    int hash = Paths.get(contextPath).hashCode();
    return "UID_" + (hash < 0 ? -hash : hash);
  }
 
  public String getContextPath() {
    return contextPath;
  }
 
  public IContact getContact() {
    return contact;
  }
 
  public boolean isMail() {
    return mail;
  }
 
  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(iee, getContact());
      }
    }
    return null;
  }
 
  /* Macro helpers */
  
  public void assignDefaultsByName(String name) {
    if(name.contains("summary")) {
      setNavigatorTop(false);
      setNavigatorBottom(false);
    }
    setAllowRanking(name.contains("ranking"));
    setRestricted(name.contains("restricted"));
  }
  
  public void assignDefaultsByMacro(MacroProcessorContext context) {
    setPage(context.getPage());
    setNavigatorTop(context.isNavigation());
    setNavigatorBottom(context.isNavigation());
    setAllowRanking(context.isRanking());
    setAllowMatching(context.isMatching());
    setRestricted(context.isRestricted());
    setSummaryTemplate(context.getTemplate());
  }
  
  /* Participation helpers */
  
  public Object getParticipationCtrl(E e, ParticipationReason reason) {
    return Entities.getController(e).getParticipationControl(constructor, contact, reason);
  }
  
  public Object getSpamCtrl(E e) {
    return getParticipationCtrl(e, ParticipationReason.REASON_SPAM);
  }
  
  public Object getFollowCtrl(E e) {
    return getParticipationCtrl(e, ParticipationReason.REASON_FOLLOW);
  }
  
  public Object getSeenCtrl(E e) {
    return getParticipationCtrl(e, ParticipationReason.REASON_SEEN);
  }
  
  public Object getLikeCtrl(E e) {
    return getParticipationCtrl(e, ParticipationReason.REASON_LIKE);
  }
  
  public Object getApplyCtrl(E e) {
    return getParticipationCtrl(e, ParticipationReason.REASON_APPLY);
  }
  
  public Object getCtrlByLabel(String ctrl, E e, IContact contact) {
    IEntityCtrl ec = Plugins.loadImplementation(IEntityCtrl.class, ctrl);
    if(ec != null) {
      IElephantEntity iee = Entities.getController(e);
      if(!Strings.isBlank(iee.getPath())) {
        ec.setConstructor(constructor);
        ec.setEntityPath(iee.getPath());
        return iee.configureCtrl(ec, contact);
      }
    }
    return null;
  }
 
  protected void prepareControls(E entity, int page) {   
    marker.put("entiter", this);
    if(!marker.contains("iee")) {
      IElephantEntity iee = Entities.getController(entity);
      if(!(iee instanceof EmptyController)) {
        marker.put("iee", iee);
      }
    }
    if(isMail()) {
      marker.put("itemLink", "{liveref:" + getItemLink(entity) + "}");
      marker.put("allLink", "{liveref:" + getReadAllLink() + "}");
      marker.put("restrictedLink", "{liveref:" + getRestrictedLink() + "}");
    } else {
      marker.put("itemLink", getItemLink(entity));
      marker.put("allLink", getReadAllLink());
      marker.put("restrictedLink", getRestrictedLink());
    }
  }
  
  protected String doItemLink(E entity, ID id, boolean obfuscated) {
    String ewu = EntityWebUrls.getUrlFromEntity(entity);
    if(ewu != null) {
      return getReadAllLink() + ewu;
    } else {
      if(obfuscated) {
        return getReadAllLink() + "?" + MarkerHelper.setObfuscatedPars("item=" + stringId(id));
      } else {
        return getReadAllLink() + "?item=" + stringId(id);
      }
    }
  }
  
  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 String getItemLink(E e);
  protected abstract String getReadAllLink();
  protected abstract String getRestrictedLink();
 
}