AbstractDirectContentCtrl.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.elephant.direct;
 
import java.io.IOException;
import java.util.Collections;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.turro.collections.parser.ParserException;
import org.turro.string.Strings;
import org.turro.action.Actions;
import org.turro.collections.KeyValueMap;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.context.IConstructor;
import org.turro.elephant.security.IUser;
import org.turro.marker.ElephantMarker;
import org.turro.plugin.contacts.IContact;
import org.turro.util.IdGenerator;
 
public abstract class AbstractDirectContentCtrl implements IDirectContent {
 
  private final String tmplRoot;
  private boolean needsUser = false;
  protected String template = "full";
 
  public AbstractDirectContentCtrl(String tmplRoot) {
    this.tmplRoot = tmplRoot;
  }
 
  public String createFormAction() {
    return DirectContents.createRelativeURL(getIdentifier());
  }
  
  public String createPOST(String values) {
    return "$.post('" + ElephantContext.getRootWebPath() + DirectContents.DIRECT_CONTENT_PATH + getIdentifier() + "'," +
           "{ exrino : '" + Actions.createRightNowParameter(values) + "' })";
  }
  
  public String getAjaxSubmitUrl(String containerId) {
    return "$.post('" + ElephantContext.getRootWebPath() + DirectContents.DIRECT_CONTENT_PATH + getIdentifier() + "'," +
           "$('#form_" + containerId + "').serialize())" +
           ".done(function(data) { $('#" + containerId + "').html(data); });" +
           "return false;";
  }
 
  public String getAjaxUrl(String containerId, String values) {
    try {
      return getAjaxUrl(containerId, new KeyValueMap(values));
    } catch (ParserException ex) {
      Logger.getLogger(AbstractDirectContentCtrl.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(values), ex);
    }
    return "";
  }
  
  public String getAjaxUrl(String containerId, KeyValueMap values) {
    values.put("domid", containerId);
    return "$.post('" + ElephantContext.getRootWebPath() + DirectContents.DIRECT_CONTENT_PATH + getIdentifier() + "'," +
           "{ exrino : '" + Actions.createRightNowParameter(values) + "' })" +
           ".done(function(data) { $('#" + containerId + "').html(data); });";
  }
  
  public String getAjaxEvalUrl(KeyValueMap values) {
    return "$.post('" + ElephantContext.getRootWebPath() + DirectContents.DIRECT_CONTENT_PATH + getIdentifier() + "'," +
           "{ exrino : '" + Actions.createRightNowParameter(values) + "' })" +
           ".done(function(data) { eval(data); });";
  }
 
  public String createRightNowURL(String values) {
    try {
      return createRightNowURL(new KeyValueMap(values));
    } catch (ParserException ex) {
      Logger.getLogger(AbstractDirectContentCtrl.class.getName()).log(Level.SEVERE, null, ex);
    }
    return null;
  }
  
  public String createRightNowURL(KeyValueMap values) {
    return ElephantContext.getRootWebPath() +
            DirectContents.DIRECT_CONTENT_PATH + getIdentifier() +
            "?" + Actions.createRightNowAction(values);
  }
  
  public String createLinkTo(String link, KeyValueMap values) {
    return ElephantContext.getRootWebPath() +
            link + "?" + Actions.createAction(values);
  }
  
  public String createURL() {
    return ElephantContext.getRootWebPath() +
           DirectContents.DIRECT_CONTENT_PATH + getIdentifier();
  }
  
  public String createURL(IConstructor constructor, String values) {
    return createURL(constructor, values, 7, false);
  }
  
  public String createURL(IConstructor constructor, String values, int daysValid) {
    return createURL(constructor, values, daysValid, false);    
  }
  
  public String createURL(IConstructor constructor, String values, int daysValid, boolean withDomain) {
    return createURL(constructor, (IContact) constructor.getUser(), values, daysValid, withDomain);
//    String exrino = null;
//    try {
//      KeyValueMap kvm = new KeyValueMap(values);
//      kvm.put(Actions.USER_PAR, ((IContact) constructor.getUser()).getConnector(IUser.CONNECTOR_EMAIL));
//      kvm.put(Actions.REDIR_PAR, getRedirContext(withDomain));
//      exrino = Actions.createAction(kvm, daysValid, false);
//    } catch (ParserException ex) {
//      Logger.getLogger(AbstractDirectContentCtrl.class.getName()).log(Level.SEVERE, null, ex);
//    }
//    return (withDomain ? ElephantContext.getServerBase("http") : "") +
//            ElephantContext.getRootWebPath() +
//            DirectContents.DIRECT_CONTENT_PATH + getIdentifier() +
//            "?" + exrino;
  }
  
  public String createURL(IConstructor constructor, IContact recipe, String values, int daysValid, boolean withDomain) {
    try {
      return createURL(constructor, recipe, new KeyValueMap(values), daysValid, withDomain);
    } catch (ParserException ex) {
      Logger.getLogger(AbstractDirectContentCtrl.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
    return null;
//    String exrino = null;
//    try {
//      KeyValueMap kvm = 
//      kvm.put(Actions.USER_PAR, recipe.getConnector(IUser.CONNECTOR_EMAIL));
//      kvm.put(Actions.REDIR_PAR, getRedirContext(withDomain));
//      exrino = Actions.createAction(kvm, daysValid, false);
//    } catch (ParserException ex) {
//      Logger.getLogger(AbstractDirectContentCtrl.class.getName()).log(Level.SEVERE, null, ex);
//    }
//    return (withDomain ? ElephantContext.getServerBase("http") : "") +
//            ElephantContext.getRootWebPath() +
//            DirectContents.DIRECT_CONTENT_PATH + getIdentifier() +
//            "?" + exrino;
  }
  
  public String createURL(IConstructor constructor, IContact recipe, KeyValueMap values, int daysValid, boolean withDomain) {
    values.put(Actions.USER_PAR, recipe.getConnector(IUser.CONNECTOR_EMAIL));
    values.put(Actions.REDIR_PAR, getRedirContext(constructor, withDomain));
    return (withDomain ? ElephantContext.getServerBase("http") : "") +
            ElephantContext.getRootWebPath() +
            DirectContents.DIRECT_CONTENT_PATH + getIdentifier() +
            "?" + Actions.createAction(values, daysValid, false);
  }
  
  protected String getRedirContext(IConstructor constructor, boolean withDomain) {
    if(withDomain) {
      return ElephantContext.getServerBase("http") + constructor.getCurrentContext().getWebPath();
    } else {
      return constructor.getCurrentContext().getPath();
    }
  }
  
  protected ElephantMarker getMarker(IConstructor constructor) {
    ElephantMarker marker = getCleanMarkerFrom(constructor);
    prepareMarker(marker);
    return marker;
  }
 
  protected ElephantMarker getCleanMarkerFrom(IConstructor constructor) {
    ElephantMarker marker = new ElephantMarker(constructor);
    marker.put("actions", this);
    return marker;
  }
 
  protected void addContainerId(ElephantMarker marker, boolean container) {
    marker.put("container", container);
    String domid = (String) marker.get("domid");
    if(Strings.isBlank(domid)) domid = marker.getConstructor().getParameter("domid");
    marker.put("containerId", container ? "cic_" + IdGenerator.generate() : domid);
  }
 
  protected String getTmplRoot() {
    return tmplRoot;
  }  
 
  protected String getTemplate() {
    return template;
  }
  
  protected void writeMarkerToResponse(IConstructor constructor, KeyValueMap map) {
    writeMarkerToResponse(constructor, map, null);
  }
  
  protected void writeMarkerToResponse(IConstructor constructor, KeyValueMap map, Map extra) {
    ElephantMarker marker = getCleanMarkerFrom(constructor);
    prepareCleanMarker(marker, map);
    addContainerId(marker, false);
    if(extra != null) marker.putAll(extra);
    try {
      constructor.getResponse().setContentType("text/html");
      constructor.getResponse().setCharacterEncoding(ElephantContext.getEncoding());
      marker.process(getTmplRoot(), getTemplate(), constructor.getResponse().getWriter());
    } catch (IOException ex) {
      Logger.getLogger(AbstractDirectContentCtrl.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
  }
 
  protected void setNeedsUser(boolean needsUser) {
    this.needsUser = needsUser;
  }
  
  public void setTemplate(String template) {
    if(template != null) this.template = template;
  }
  
  public void render(IConstructor constructor) {
    if(!needsUser || hasUser(constructor)) {
      getMarker(constructor).process(tmplRoot, template);
    }
  }
 
  public String parse(IConstructor constructor) {
    if(!needsUser || hasUser(constructor)) {
      return getMarker(constructor).parse(tmplRoot, template);
    }
    return "";
  }
 
  private boolean hasUser(IConstructor constructor) {
    return (constructor != null) && (constructor.getUser() != null);
  }
  
  /* IDirectContent */
 
  @Override
  public boolean itsMe(String id) {
    return getIdentifier().equals(id);
  }
 
  @Override
  public boolean myTurn(HttpServletRequest request) {
    return DirectContents.isYourTurn(request, getIdentifier());
  }
 
  @Override
  public void execute(ServletContext context, HttpServletRequest request, HttpServletResponse response) {
    execute(ElephantContext.getConstructor(request, response));
  }  
 
  public void execute(IConstructor constructor) {
    KeyValueMap map = Actions.isRightNowAction(constructor) ? 
            Actions.getRightNowAction(constructor) :
            Actions.getAction(constructor);
    if(map == null && "POST".equals(constructor.getRequest().getMethod())) {
      map = new KeyValueMap(Collections.EMPTY_MAP);
      for(String key : constructor.getRequest().getParameterMap().keySet()) {
        map.put(key, constructor.getRequest().getParameter(key));
      }
    }
    if(map != null) {
      doExecute(constructor, map);
      String redirect = map.get(Actions.REDIR_PAR);
      if(!Strings.isBlank(redirect)) {
        try {
          constructor.redirect(redirect);
        } catch (IOException ex) {
          Logger.getLogger(AbstractDirectContentCtrl.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
        }
      }
    }
  }
  
  protected abstract String getIdentifier();
  protected abstract void prepareMarker(ElephantMarker marker);
  protected abstract void prepareCleanMarker(ElephantMarker marker, KeyValueMap map);
  protected abstract void doExecute(IConstructor constructor, KeyValueMap map);
  
}