CoreParser.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.parser;
 
import freemarker.ext.dom.NodeModel;
import java.io.File;
import java.io.IOException;
import java.util.Date;
import java.util.Random;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.servlet.ServletException;
import javax.servlet.http.Cookie;
import javax.xml.parsers.ParserConfigurationException;
import org.amic.util.date.DateFormats;
import org.turro.collections.parser.ParserException;
import org.turro.string.ObjectString;
import org.turro.string.Strings;
import org.turro.action.ContentService;
import org.turro.action.IEntityCtrl;
import org.turro.action.Plugins;
import org.turro.action.UserSummaries;
import org.turro.annotation.ExternalParser;
import org.turro.collections.KeyObjectMap;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.impl.feed.FeedMacro;
import org.turro.elephant.impl.util.CookieUtil;
import org.turro.elephant.impl.util.FileUtil;
import org.turro.elephant.impl.util.Files;
import org.turro.elephant.impl.util.Parser;
import org.turro.elephant.impl.util.StringParser;
import org.turro.elephant.security.IUser;
import org.turro.entities.Entities;
import org.turro.entities.IElephantEntity;
import org.turro.html.HTMLHelper;
import org.turro.i18n.I_;
import org.turro.indicator.IndicatorResult;
import org.turro.indicator.Indicators;
import org.turro.json.JsonSearch;
import org.turro.marker.ElephantMarker;
import org.turro.plugin.contacts.IContact;
import org.turro.reflection.Reflections;
import org.turro.user.content.UserContents;
import org.xml.sax.SAXException;
 
@ExternalParser
public class CoreParser extends AbstractParser {
 
  @Override
  public String getParserName() {
    return "Core";
  }
 
  @Override
  protected boolean doExecute() {
    boolean done = false;
    if("webroot".equals(getMacroName())) {
      out.write(ElephantContext.getRootWebPath());
      done = true;
    } else if("site".equals(getMacroName())) {
      out.write(ElephantContext.getSiteName());
      done = true;
    } else if("rendering".equals(getMacroName())) {
      out.write(constructor.getRenderingContext().getWebPath());
      done = true;
    } else if("lang".equals(getMacroName())) {
      out.write("_" + I_.api().used().getLanguage());
      done = true;
    } else if("user-summary".equals(getMacroName())) {
      if("init".equals(getToken(1))) {
        UserSummaries.initSummaries(constructor);
      } else {
        if(!constructor.isOutsider()) out.write(UserSummaries.parseSummaries(constructor));
      }
      done = true;
    } else if("user-contents".equals(getMacroName())) {
      out.write(UserContents.parseContents(constructor));
      done = true;
    } else if("include".equals(getMacroName())) {
      try {
        constructor.includeContent(getToken(1));
      } catch (ServletException | IOException ex) {
        Logger.getLogger(CoreParser.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
      }
      done = true;
    } else if("param".equals(getMacroName())) {
      String value = constructor.getParameter(getToken(1, getToken(2)));
      if(!Strings.isBlank(value)) {
        out.write(value);
      }
      done = true;
    } else if("render".equals(getMacroName())) {
      try {
        constructor.renderContext(getToken(1), getToken(2));
      } catch (ServletException | IOException ex) {
        Logger.getLogger(CoreParser.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
      }
      done = true;
    } else if("date".equals(getMacroName())) {
      Date now = new Date();
      if("date".equals(getToken(1))) {
        out.write(DateFormats.format(now, getToken(2), I_.api().used()));
      } else if("time".equals(getToken(1))) {
        out.write(DateFormats.formatTime(now, getToken(2), I_.api().used()));
      } else if("all".equals(getToken(1))) {
        out.write(DateFormats.format(now, getToken(2), getToken(2), I_.api().used()));
      }        
      done = true;
    } else if("feed".equals(getMacroName())) {
      FeedMacro.writeFeed(constructor, getToken(1));
    } else if("marker-json".equals(getMacroName())) {
      ElephantMarker marker = new ElephantMarker(constructor);
      File file = Files.file(constructor, getToken(3));
      if(file.exists()) {
        marker.put("json", JsonSearch.of(file));
      }
      marker.process(getToken(1), getToken(2));
      done = true;
    } else if("marker-xml".equals(getMacroName())) {
      ElephantMarker marker = new ElephantMarker(constructor);
      try {
        File file = Files.file(constructor, getToken(3));
        if(file.exists()) {
          marker.put("doc", NodeModel.parse(file));
        }
      } catch (SAXException | ParserConfigurationException | IOException ex) {
        Logger.getLogger(CoreParser.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
      }
      marker.process(getToken(1), getToken(2));
      done = true;
    } else if("marker-props".equals(getMacroName())) {
      ElephantMarker marker = new ElephantMarker(constructor);
      File file = Files.file(constructor, getToken(3));
      if(file.exists()) {
        try {
          marker.put("props", FileUtil.getOrderedProperties(file));
        } catch (IOException ex) {
          Logger.getLogger(CoreParser.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
        }
      }
      marker.process(getToken(1), getToken(2));
      done = true;
    } else if("marker".equals(getMacroName())) {
      ElephantMarker marker = new ElephantMarker(constructor);
      try {
        marker.putAll(new KeyObjectMap(getToken(3)));
      } catch (ParserException ex) {
        Logger.getLogger(Parser.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
      }
      marker.process(getToken(1), getToken(2));
      done = true;
    } else if("files".equals(getMacroName())) {
      if("sort".equals(getToken(3))) {
        out.write(Files.getJsonSortedFiles(getToken(1), getToken(2)));
      } else if("shuffle".equals(tokens[3])) {
        out.write(Files.getJsonShuffledFiles(getToken(1), getToken(2)));
      } else {
        out.write(Files.getJsonFiles(getToken(1), getToken(2)));
      }
      done = true;
    } else if("frame".equals(getMacroName())) {
      HTMLHelper hh = new HTMLHelper(out);
      String path = getToken(1);
      if(path.startsWith("/")) {
        path = ElephantContext.getRootWebPath() + path;
      }
      hh.startTag("iframe", "src=\"" + path + 
              "\" style=\"border:0;margin:0;padding:0;width:" + 
              getToken(2) + ";height:" + getToken(3) + "\"");
      hh.endTag();
      done = true;
    } else if("res".equals(getMacroName())) {
      String res = I_.compatibility().get(getToken(1)); 
      if(res != null) {
        out.write(Strings.transform(res, ((Integer)ObjectString.parseString(getToken(2), Integer.class, true)).intValue()));
      }
      done = true;
    } else if("i18n".equals(getMacroName())) {
      String res = I_.get(getToken(1)); 
      if(res != null) {
        out.write(Strings.transform(res, ((Integer)ObjectString.parseString(getToken(2), Integer.class, true)).intValue()));
      }
      done = true;
    } else if("random".equals(getMacroName())) {
      Random random = new Random();
      int v = random.nextInt(Integer.valueOf(getToken(1)));
      out.write(Integer.toString(v));
      done = true;
    } else if("context".equals(getMacroName())) {
      String[] s = constructor.getCurrentContext().getPath().split("\\/");
      int i = Integer.valueOf(getToken(1));
      if(i < s.length) {
        out.write(s[i]);
      }
      done = true;
    } else if("user".equals(getMacroName())) {
      IContact user = constructor.getUser();
      if(user != null) {
        if("name".equals(getToken(1))) {
          out.write(user.getName());
        }
        else if("id".equals(getToken(1))) {
          out.write(user.getId());
        }
        else if("email".equals(getToken(1))) {
          out.write(user.getProperty(IUser.CONNECTOR_EMAIL));
        }
      }
      done = true;
    } else if("if".equals(getMacroName())) {
      out.write(constructor.isInRole(getToken(1) + ":" + getToken(2)) ? getToken(3) : getToken(4));
      done = true;
    } else if("ifcookie".equals(getMacroName())) {
      Cookie cookie = CookieUtil.getCookie(constructor.getRequest(), getToken(1));
      if(cookie != null) {
        out.write(getToken(2).equals(cookie.getValue()) ? getToken(3) : getToken(4));
      }
      done = true;
    } else if("class".equals(getMacroName())) {
      out.write(Reflections.exist(getToken(1)) ? getToken(2) : getToken(3));
      done = true;
    } else if("equals".equals(getMacroName())) {
      out.write(getToken(1).equals(getToken(2)) ? getToken(3) : getToken(4));
      done = true;
    } else if("object".equals(getMacroName())) { 
      Object entity = constructor.findAttribute(getToken(1));
      if(entity == null) {
        entity = Entities.getController(getToken(1)).getEntity();
      }
      if(entity != null) {
        Object obj = StringParser.getValueFrom(getToken(2), entity);
        if(obj != null) {
          out.write(obj.toString());
        }
      }
      done = true;
    } else if("attribute".equals(getMacroName())) {
      Object obj = constructor.findAttribute(getToken(1));
      if(obj != null) {
        String format = getToken(2);
        if(!Strings.isBlank(format)) {
          out.format(I_.api().used(), format, obj);
        } else {
          out.write(obj.toString());
        }
      }
      done = true;
    } else if("entity".equals(getMacroName())) {
      IElephantEntity ee = Entities.getController(getToken(1));
      Object[] desc = new Object[] { ee.getName(), ee.getDescription() };
      if(ee != null) {
        out.format(getToken(2), desc);
      }
      done = true;
    } else if("entity-ctrl".equals(getMacroName())) {
      IEntityCtrl ec = Plugins.loadImplementation(IEntityCtrl.class, getToken(1));
      if(ec != null) {
        ec.setEntityPath(getToken(2));
        ec.setTemplate(getToken(3));
        if(ec.hasContent()) {
          out.write(ec.parse(constructor));
        }
      }
      done = true;
    } else if("cookie".equals(getMacroName())) {
      String value = getToken(2);
      if(Strings.isBlank(value)) {
        Cookie cookie = CookieUtil.getCookie(constructor.getRequest(), getToken(1));
        if(cookie != null) out.write(cookie.getValue());
      } else {
        CookieUtil.setCookie(constructor.getResponse(), getToken(1), value, "/", 30*24*60*60);
        out.write(value);
      }
      done = true;
    } else if("indicator".equals(getMacroName())) {
      String indicator = null;
      indicator = getToken(1) + ":" + getToken(2) + ":" + getToken(3) + 
              (getToken(5) != null ? "." + getToken(5) : "") + "." + getToken(4);
      IndicatorResult ir = Indicators.readIndicator(indicator);
      out.write(ObjectString.formatObject(Double.valueOf(ir.getValue()), "#,##0.00", true));
      out.write(" [" + ir.getCount() + "]");
      done = true;
    } else if("entry-point".equals(getMacroName())) {
      out.write(ContentService.createEntryPoint(constructor, getToken(1), getToken(2)));
      done = true;
    }
    return done;
  }
 
  @Override
  protected void explainMacros(ParserMacroSet macros) {
    macros.addMacro("webroot");
    macros.addMacro("site");
    macros.addMacro("rendering");
    macros.addMacro("lang");
    macros.addMacro("user-summary")
            .addParameter("mode", true)
            .addPossibleValue("init");
    macros.addMacro("user-contents");
    macros.addMacro("include")
            .addParameter("content-file", false);
    macros.addMacro("param")
            .addParameter("name", false)
            .addParameter("default", true);
    macros.addMacro("render")
            .addParameter("context", false)
            .addParameter("stopper", true);
    macros.addMacro("date")
            .addParameter("mode", true, "date")
            .addPossibleValue("date")
            .addPossibleValue("time")
            .addPossibleValue("all")
            .addParameter("format", true, "short")
            .addPossibleValue("full")
            .addPossibleValue("long")
            .addPossibleValue("medium")
            .addPossibleValue("short");
    macros.addMacro("feed")
            .addParameter("url", false);
    macros.addMacro("marker")
            .addParameter("tmpl-root", false)
            .addParameter("template", false)
            .addParameter("value-map", false);
    macros.addMacro("marker-props")
            .addParameter("tmpl-root", false)
            .addParameter("template", false)
            .addParameter("repository-file", false);
    macros.addMacro("marker-xml")
            .addParameter("tmpl-root", false)
            .addParameter("template", false)
            .addParameter("repository-file", false);
    macros.addMacro("marker-json")
            .addParameter("tmpl-root", false)
            .addParameter("template", false)
            .addParameter("repository-file", false);
    macros.addMacro("files")
            .addParameter("folder", false)
            .addParameter("pattern", false)
            .addParameter("mode", false)
            .addPossibleValue("normal")
            .addPossibleValue("sort")
            .addPossibleValue("shuffle");
    macros.addMacro("frame")
            .addParameter("url", false)
            .addParameter("width", false)
            .addParameter("height", false);
    macros.addMacro("res")
            .addParameter("resource-key", false)
            .addParameter("string-mode", true, "0");
    macros.addMacro("i18n")
            .addParameter("resource", false)
            .addParameter("string-mode", true, "0");
    macros.addMacro("random")
            .addParameter("random-limit", false);
    macros.addMacro("context")
            .addParameter("level", false);
    macros.addMacro("user")
            .addParameter("mode", true, "name")
            .addPossibleValue("name")
            .addPossibleValue("id")
            .addPossibleValue("email");
    macros.addMacro("if")
            .addParameter("role", false)
            .addParameter("attribute", false)
            .addParameter("true-expression", false)
            .addParameter("false-expression", false);
    macros.addMacro("ifcookie")
            .addParameter("cookie", false)
            .addParameter("value", false)
            .addParameter("true-expression", false)
            .addParameter("false-expression", false);
    macros.addMacro("class")
            .addParameter("class-name", false)
            .addParameter("true-expression", false)
            .addParameter("false-expression", false);
    macros.addMacro("equals")
            .addParameter("value", false)
            .addParameter("value", false)
            .addParameter("true-expression", false)
            .addParameter("false-expression", false);
    macros.addMacro("object")
            .addParameter("ref-object", false)
            .addParameter("attribute", false);
     macros.addMacro("attribute")
             .addParameter("attribute", false)
             .addParameter("format", true);
     macros.addMacro("entity")
             .addParameter("entityPath", false)
             .addParameter("fmt-name-desc", false);
     macros.addMacro("entity-ctrl")
             .addParameter("plugin", false)
             .addParameter("entityPath", false)
             .addParameter("template", true);
     macros.addMacro("cookie")
             .addParameter("name", false)
             .addParameter("value", true);
     macros.addMacro("indicator")
             .addParameter("storeClass", false)
             .addParameter("indicatorClass", false)
             .addParameter("entityPath", false)
             .addParameter("indicator", false)
             .addParameter("relatedPath", true);
     macros.addMacro("entry-point")
             .addParameter("identifier", false)
             .addParameter("values", true);
  }
 
}