ElContext.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.elephant.web;
 
import java.io.File;
import java.io.IOException;
import java.nio.file.Path;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.TreeSet;
import java.util.function.Function;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.servlet.ServletException;
import org.turro.string.Strings;
import org.jdom.Document;
import org.jdom.Element;
import org.jdom.JDOMException;
import org.jdom.input.SAXBuilder;
import org.turro.collections.Item;
import org.turro.collections.Tree;
import org.turro.elephant.context.Application;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.context.IConstructor;
import org.turro.elephant.context.IContext;
import org.turro.elephant.context.IElement;
import org.turro.elephant.impl.abstracts.AbstractElement;
import org.turro.elephant.impl.context.ContextFactory;
import org.turro.elephant.impl.repository.Repository;
import org.turro.elephant.impl.util.Files;
import org.turro.elephant.search.FoundList;
import org.turro.elephant.search.SearchFormatter;
import org.turro.elephant.user.menu.UserMenus;
import org.turro.elephant.web.context.WebContext;
import org.turro.elephant.web.context.WebResources;
import org.turro.plugin.contacts.IContact;
import org.turro.util.CompareUtil;
 
public class ElContext implements Comparable<ElContext> {
 
  public static final String
          CONTEXT_FOLDER = "/_internal",
          CONTEXT_FILE = CONTEXT_FOLDER + "/context.xml",
          CONTEXT_REPOSITORY = CONTEXT_FOLDER + "/repository";
 
  protected File folder;
  protected String title, path, params;
  protected int level;
  protected Set<String> defaultLocales;
  protected ElContext parent;
  protected TreeSet<ElContext> children;
 
  protected WebContext webContext;
  
  public ElContext() {
    this("", null, new File(ElephantContext.getRealPath("/")), null);
  }
 
  protected ElContext(String path, File folder, ElContext parent) {
    this(path, null, folder, parent);
  }
  
  protected ElContext(String path, String params, File folder, ElContext parent) {
    this.path = path;
    this.params = params;
    this.folder = folder;
    this.parent = parent;
    init();
  }
  
  public String getId() {
    return folder.getName();
  }
  
  public String getName() {
    return Optional.ofNullable(webContext.getName()).orElse(getId());
  }
  
  public String getFullPath() {
    String tmp = ElephantContext.getRootWebPath() + path;
    return (Strings.isBlank(tmp) ? "/" : tmp + (Strings.isBlank(params) ? "" : params));
  }
 
  public String getWebPath() {
    if(Strings.isBlank(webContext.getRedirect())) {
      return getFullPath();
    } else if(webContext.getRedirect().startsWith("/")) {
      return ElephantContext.getRootWebPath() + webContext.getRedirect();
    } else if(webContext.getRedirect().contains("://")) {
      return webContext.getRedirect();
    } else {
      return getFullPath() + "/" + webContext.getRedirect();
    }
  }
 
  public String getPath() {
    return path;
  }
 
  public boolean inPath(ElContext context) {
    return context.getFullPath().matches(getFullPath() + "(\\/.*)?");
  }
 
  public int getLevel() {
    return path == null ? 0 : path.split("\\/").length - 1;
  }
  
  public File getFile() {
    return folder;
  }
  
  public String getVerbosePath() {
    return getVerbosePath(null);
  }
  
  public String getVerbosePath(ElContext root) {
    String result = getName();
    ElContext ctx = parent;
    while(ctx != null && !ctx.equals(root)) {
      result = ctx.getName() + " " + result;
      ctx = ctx.parent;
    }
    return result;
  }
 
  public String getTarget() {
    return webContext.getTarget();
  }
 
  public boolean isPublic() {
    return Strings.isBlank(webContext.getRole());
  }
  
  public boolean canShowTo(IContact contact) {
    if(isPublic()) return true;
    return contact.getPermissions().isInRole(webContext.getRole());
  }
  
  public boolean canDisplay() {
    return isSelectable() && (webContext.isShowAlways() || isInRole());
  }
 
  public boolean hasRestrictions() {
    return !(webContext.isShowInNavigators() && (webContext.isShowAlways() || Strings.isEmpty(webContext.getRole())));
  }
 
  public boolean isSelectable() {
    return webContext.isShowInNavigators();
  }
 
  public boolean isInRole() {
    if(parent != null && !parent.isInRole()) return false;
    if(Strings.isBlank(webContext.getRole())) return true;
    return UserMenus.isInRole(path) && Application.getApplication().isInRole(webContext.getRole());
  }
 
  public boolean canPrint() {
    return (webContext.isPrintContext() && isInRole());
  }
 
  public ElContext getParent() {
    return parent;
  }
 
  public boolean isIndexable() {
    return !webContext.isNoIndex() && Strings.isBlank(webContext.getRedirect()) &&
            !getPath().startsWith("/user");
  }
  
  public boolean isFollowable() {
    return !webContext.isNoFollow();
  }
  
  public TreeSet<ElContext> getChildren() {
    generateDynamic();
    return children;
  }
 
  public TreeSet<ElContext> getStaticChildren() {
    TreeSet<ElContext> statics = new TreeSet<>();
    for(ElContext ctx : children) {
      if(!ctx.getWebContext().isDynamic()) statics.add(ctx);
    }
    return statics;
  }
 
  public TreeSet<ElContext> getVisibleChildren() {
    TreeSet<ElContext> visible = new TreeSet<>();
    for(ElContext ctx : children) {
      if(ctx.canDisplay()) visible.add(ctx);
    }
    return visible;
  }
 
  public TreeSet<ElContext> getSiblings() {
    if(parent == null) {
      TreeSet<ElContext> set = new TreeSet<>();
      set.add(this);
      return set;
    } else {
      return parent.getChildren();
    }
  }
  
  public TreeSet<ElContext> getVisibleSiblings() {
    TreeSet<ElContext> visible = new TreeSet<>();
    for(ElContext ctx : getSiblings()) {
      if(ctx.canDisplay()) visible.add(ctx);
    }
    return visible;
  }
 
  public TreeSet<ElContext> getAncestors() {
    TreeSet<ElContext> ancestors = new TreeSet<>();
    ElContext ctx = this;
    while(ctx != null) {
      ancestors.add(ctx);
      ctx = ctx.parent;
    }
    return ancestors;
  }
  
  public ElContext getPrevious() {
    if(getParent() != null) {
      boolean found = false;
      for (ElContext sibling : getVisibleSiblings().descendingSet()) {
        if(found && sibling.canDisplay()) return getLastChildren(sibling);
        if(sibling.equals(this)) found = true;
      }
      return getParent();
    }
    return null;
  }
 
  private ElContext getLastChildren(ElContext context) {
    TreeSet<ElContext> ctxs = context.getVisibleChildren();
    if(!ctxs.isEmpty()) {
      return getLastChildren(ctxs.last());
    }
    return context;
  }
 
  public ElContext getNext(boolean doChildren) {
    if(doChildren) {
      TreeSet<ElContext> set = getVisibleChildren();
      if(!set.isEmpty()) return set.first();
    }
    if(getParent() != null) {
      boolean found = false;
      for (ElContext sibling : getVisibleSiblings()) {
        if(found && sibling.canDisplay()) return sibling;
        if(sibling.equals(this)) found = true;
      }
    }
    return parent.getNext(false);
  }
 
  public IContext getContext() {
    return ContextFactory.getContext(Application.getApplication().getConstructor(), path);
  }
  
  public String getRepositoryPath() {
    return WebContext.repository(Path.of(path)).toString();
  }
  
  public Repository getRepository() {
    return new Repository(Application.getApplication().getConstructor(), WebContext.repository(Path.of(path)).toString());
  }
  
  public WebResources getResources() {
    return folder != null ? new WebResources(folder.toPath()) : null;
  }
  
  protected final void init() {
    readConfiguration();
    level = path == null ? 0 : path.split("\\/").length - 1;
    ElContextMap.addContext(this);
    if(children == null) {
      children = new TreeSet<>();
      if(folder.isDirectory()) {
        File[] subfolders = folder.listFiles();
        for(File subfolder: subfolders) {
          if(subfolder.isDirectory() && !subfolder.isHidden()) {
            if(!isInternal(subfolder)) {
              if(Files.exists(path + "/" + subfolder.getName() + CONTEXT_FILE) ||
                 WebContext.existsConf(Path.of(path))) {
                children.add(new ElContext(path + "/" + subfolder.getName(), subfolder, this));
              }
            }
          }
        }
      }
    }
  }
  
  public Set<String> getDefaultLocales() {
    if(defaultLocales == null) {
      ElContext ctx = this;
      while(ctx != null && ctx.webContext.getLangs().isEmpty()) {
        ctx = ctx.parent;
      }
      defaultLocales = ctx.webContext.getLangs();
    }
    return defaultLocales;
  }
 
  public WebContext getWebContext() {
    return webContext;
  }
 
  public static boolean isInternal(File file) {
    if(file == null) return true;
    String fileName = file.isFile() ? file.getName() : file.getAbsolutePath();
    String internals = ElephantContext.getSiteInternalFiles();
    if(internals != null) {
      String tmp[] = internals.split(",");
      for(String s : tmp) {
        if(fileName.matches(Strings.convertToRegEx(s))) return true;
      }
    }
    return (fileName.matches("google.*\\.html")) ||
            (fileName.matches("site.*\\.xml")) ||
            (fileName.matches("robots\\.txt")) ||
            (fileName.contains("_internal")) ||
            (fileName.contains("_zul")) ||
            (fileName.contains("resources")) ||
            (fileName.contains("WEB-INF")) ||
            (fileName.contains("META-INF"));
  }
 
  /* Construction */
  
  public void construct(IConstructor constructor) throws ServletException, IOException {
    new ContextConstructor(constructor, this).start();
  }
 
  public void setTitle(String title) {
    this.title = title;
  }
  
  public String getTitle() {
    return Strings.isBlank(title) ? getName() : title;
  }
 
  /* XML configuration, migration */
  
  private void readConfiguration() {
    if(WebContext.existsConf(Path.of(path))) {
      webContext = WebContext.loadFrom(Path.of(path)); 
    } else {
      webContext = new WebContext();
      File confFile = new File(ElephantContext.getRealPath(this.path + CONTEXT_FILE));
      Element conf = readConfFile(confFile);
      if(conf != null) {
        Element i18n = conf.getChild("i18n");
        if(i18n != null) {
          Element name = i18n.getChild("name");
          if(name != null) {
            for(Element language : (List<Element>) name.getChildren()) {
              webContext.getNames().put(language.getName(), language.getValue());
            }
          }        
        }
        webContext.setOrder(conf.getAttributeValue("order", "000"));
        webContext.getLangs().addAll(Strings.csvToList(conf.getAttributeValue("lang")));
        webContext.setShowInNavigators("true".equals(conf.getAttributeValue("showInNavigators", "true")));
        webContext.setShowAlways("true".equals(conf.getAttributeValue("showAlways", "false")));
        webContext.setPrintContext("true".equals(conf.getAttributeValue("printContext", "true")));
        webContext.setRole(conf.getAttributeValue("contextRole"));
        webContext.setRedirect(conf.getAttributeValue("redirect"));
        webContext.setTarget(conf.getAttributeValue("target"));
        webContext.setNoIndex("true".equals(conf.getAttributeValue("noindex", "false")));
        webContext.setNoFollow("true".equals(conf.getAttributeValue("nofollow", "false")));
        webContext.setPrintVersion("true".equals(conf.getAttributeValue("print-version", "true")));
        webContext.setControlVersion("true".equals(conf.getAttributeValue("control-version", "true")));
        webContext.setTraversalNavigation("true".equals(conf.getAttributeValue("traversalNavigation", "false")));
        for(Element el : (List<Element>) conf.getChildren("element")) {
          if(el != null) {
            IContext ictx = getContext();
            IElement iel = ContextFactory.getContextElement(ictx, el);
            if(iel instanceof AbstractElement) {
              ((AbstractElement) iel).setConfiguration(el, null);
              el.getChildren("attrib").forEach(attrib -> {
                webContext.getElement().getAttributes().put(
                        ((Element) attrib).getAttributeValue("name"), 
                        ((Element) attrib).getAttributeValue("value"));
              });
              webContext.getElement().setElementClass(iel.getClass().getCanonicalName());
              iel = null;
            }
          }
        }
        Element layout = conf.getChild("layout");
        if(layout != null) {
          Element template = layout.getChild("template");
          if(template != null) {
            webContext.getLayout().setTemplate(template.getAttributeValue("name"));
          }
          Element localTemplate = layout.getChild("local-template");
          if(localTemplate != null) {
            webContext.getLayout().setLocal(localTemplate.getAttributeValue("name"));
          }
        }
        WebContext.saveTo(Path.of(path), webContext);
      }
    }
  }
  
  private Element readConfFile(File confFile) {
    if(confFile.exists()) {
      SAXBuilder builder = new SAXBuilder();
      Document doc;
      try {
        doc = builder.build(confFile);
        return doc.getRootElement();
      } catch (IOException | JDOMException ex) {
        Logger.getLogger(ElContext.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
      }
    }
    return null;
  }
 
  /* Element */
  
  public IElement getElement() {
    IElement iel = webContext.getElementInstance();
    iel.setConfiguration(Application.getApplication().getConstructor(), this);
    return iel;
  }
  
//  private IElement getElement(Element conf, String type) {
//    if(conf != null) {
//      for(Element el : (List<Element>) conf.getChildren("element")) {
//        if(el != null) {
//          IContext ictx = getContext();
//          IElement iel = ContextFactory.getContextElement(ictx, el);
//          if(iel != null) {
//            iel.setConfiguration(el, null);
//            el.getChildren("attrib").forEach(attrib -> {
//              webContext.getElement().getAttributes().put(
//                      ((Element) attrib).getAttributeValue("name"), 
//                      ((Element) attrib).getAttributeValue("value"));
//            });
//            webContext.getElement().setElementClass(iel.getClass().getCanonicalName());
//          }
//          return iel;
//        }
//      }
//    }
//    return null;
//  }
  
  /* Submenus based in containing elements */
  
  private boolean dynamicDone = false;
  
  private void generateDynamic() {
    if(!dynamicDone) { 
      // load categories as children
      if(!hasRestrictions() && !webContext.getElement().isEmpty()) {
        IElement iel = webContext.getElementInstance();
        iel.setConfiguration(Application.getApplication().getConstructor(), this);
        iel.setRootCategories(this);
      }
      dynamicDone = true;
    }
  }
  
  public void generateCategoriesChildren(Tree tree, Function<Item, String> onParam) {
    for(Item item : (List<Item>) tree.getItems()) {
      addCategoriesChildren(getPath(), item, onParam);
    }
  }
  
  private void addCategoriesChildren(String root, Item current, Function<Item, String> onParam) {
    String tmpPath = root + current.getPath();
    String realPath = ElephantContext.getRealPath(tmpPath);
    if(!Strings.isBlank(realPath)) {
      File subfolder = new File(realPath);
      ElContext child = new ElContext(Strings.unpunctuateKeepPath(tmpPath), onParam.apply(current), subfolder, this);
      child.webContext.setShowInNavigators(true);
      child.webContext.setNoIndex(true);
      child.webContext.setNoFollow(true);
      child.webContext.setOrder(current.getValue() == null ? "000" : "001");
      child.webContext.setDynamic(true);
      children.add(child);
      if(!current.isLeaf()) {
        for(Item item : (List<Item>) current.getChildren()) {
          child.addCategoriesChildren(root, item, onParam);
        }
      }
    }
  }
 
  /* Social */
  
  public SocialImage getSocialImage() {
    return SocialImageMap.getImage(getFullPath());
  }
  
  /* Template */
  
  public String getTemplateRoot() {
    return findRoot(this);
  }
 
  private String findRoot(ElContext ctx) {
    if(ctx == null) return ElephantContext.getTemplatesRoot();
    if(!Strings.isBlank(ctx.webContext.getLayout().getRoot())) {
      return ctx.webContext.getLayout().getRoot();      
    }
    return findRoot(ctx.parent);
  }
  
  public String getTemplate() {
    if(!Strings.isBlank(webContext.getLayout().getLocal())) {
      return webContext.getLayout().getLocal();      
    }
    return findTemplate(this);
  }
  
  private String findTemplate(ElContext ctx) {
    if(ctx == null) return "default-web";
    if(!Strings.isBlank(ctx.webContext.getLayout().getTemplate())) {
      return ctx.webContext.getLayout().getTemplate();      
    }
    return findTemplate(ctx.parent);
  }
  
  /* Search */
  
  public FoundList search(String value, boolean ignoreCase) {
    FoundList fl = new FoundList();
    SearchFormatter sf = new SearchFormatter(value, ignoreCase);
    sf.processLine(getName());
    if(sf.wasFound()) {
      fl.addItem(
              getId() == null ? "" : getId(),
              (getPath().length() == 0 ? "/" : getPath()),
              "<img src='" + ElephantContext.getRootResourcePath() + "/_internal/system/images/context.gif'/>",
              getName(),
              sf.getResult(),
              (double)sf.getFound(),
              value
              );
    }
    return fl;
  }
  
  /* Utils */
  
  public static String extractPath(String path) {
    if(path == null) {
      path = "/";
    } else {
      int p = path.indexOf("?");
      if(p > -1) {
        path = path.substring(0, p);
      }
    }
    return path;
  }
  
  public void resetDefaultLocales() {
    defaultLocales = null;
  }
  
  /* Comparable */
  
  @Override
  public int compareTo(ElContext o) {
    int result = 0;
    result = CompareUtil.compare(level, o.level);
    if(result == 0) {
      result = CompareUtil.compare(webContext.getOrder(), o.webContext.getOrder());
    }
    if(result == 0) {
      result = CompareUtil.compare(getName(), o.getName());
    }
    if(result == 0) {
      result = CompareUtil.compare(getId(), o.getId());
    }
    if(result == 0) {
      result = CompareUtil.compare(path, o.path);
    }
    return result;
  }
 
  /* Object */
  
  @Override
  public int hashCode() {
    int hash = 7;
    hash = 89 * hash + Objects.hashCode(this.path);
    return hash;
  }
 
  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }
    final ElContext other = (ElContext) obj;
    if (!Objects.equals(this.path, other.path)) {
      return false;
    }
    return true;
  }
 
}