WebParser.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2022 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 java.util.Collections;
import java.util.Set;
import org.turro.annotation.ExternalParser;
import org.turro.collections.CollectionUtil;
import org.turro.elephant.entities.web.WebGoal;
import org.turro.elephant.web.actions.WebLink;
import org.turro.elephant.web.tags.TagsServlet;
import org.turro.marker.ElephantMarker;
import org.turro.web.funnel.graph.FunnelGraphDOT;
import org.turro.web.funnel.graph.FunnelVertex;
import org.turro.web.funnel.model.FunnelVertices;
 
@ExternalParser
public class WebParser extends AbstractParser {
 
  @Override
  public String getParserName() {
    return "Elephant Web";
  }
 
  @Override
  protected boolean doExecute() {
    boolean done = false;
    if("wtargets".equals(getMacroName())) {
      FunnelVertices fv = FunnelVertices.load(constructor);
      fv.bySelection("true".equals(getToken(2)));
      Set<FunnelVertex> vertices = switch(getToken(1)) {
        case "all" -> fv.targets();
        case "current" -> CollectionUtil.setOf(fv.currentTarget());
        default -> Collections.EMPTY_SET;
      };
      vertexMarker(vertices, getToken(3));
      done = true;
    } else if("wsolutions".equals(getMacroName())) {
      FunnelVertices fv = FunnelVertices.load(constructor);
      fv.bySelection("true".equals(getToken(2)));
      Set<FunnelVertex> vertices = switch(getToken(1)) {
        case "all" -> fv.solutions();
        case "current" -> CollectionUtil.setOf(fv.currentSolution());
        default -> Collections.EMPTY_SET;
      };
      vertexMarker(vertices, getToken(3));
      done = true;
    } else if("wservices".equals(getMacroName())) {
      FunnelVertices fv = FunnelVertices.load(constructor);
      fv.bySelection("true".equals(getToken(2)));
      Set<FunnelVertex> vertices = switch(getToken(1)) {
        case "all" -> fv.services();
        case "current" -> CollectionUtil.setOf(fv.currentService());
        default -> Collections.EMPTY_SET;
      };
      vertexMarker(vertices, getToken(3));
      done = true;
    } else if("wnexts".equals(getMacroName())) {
      FunnelVertices fv = FunnelVertices.load(constructor);
      Set<FunnelVertex> vertices = fv.nexts();
      vertexMarker(vertices, getToken(1));
      done = true;
    } else if("wsiblings".equals(getMacroName())) {
      FunnelVertices fv = FunnelVertices.load(constructor);
      Set<FunnelVertex> vertices = fv.siblings();
      vertexMarker(vertices, getToken(1));
      done = true;
    } else if("wgoals".equals(getMacroName())) {
      FunnelVertices fv = FunnelVertices.load(constructor);
      Set<WebGoal> goals = fv.goals();
      goalMarker(goals, getToken(1));
      done = true;
    } else if("witem".equals(getMacroName())) {
      FunnelVertices fv = FunnelVertices.load(constructor);
      vertexMarker(CollectionUtil.setOf(fv.getVertex(getToken(1))), getToken(2));
      done = true;
    } else if("wgoal".equals(getMacroName())) {
      FunnelVertices fv = FunnelVertices.load(constructor);
      goalMarker(CollectionUtil.setOf(fv.getGoal(getToken(1))), getToken(2));
      done = true;
    } else if("wexternals".equals(getMacroName())) {
      FunnelVertices fv = FunnelVertices.load(constructor);
      linkMarker(fv.externals(), getToken(1));
      done = true;
    } else if("funneling-graph".equals(getMacroName())) {
      FunnelGraphDOT.DOT(out);
      done = true;
    }
    return done;
  }
 
  @Override
  protected void explainMacros(ParserMacroSet macros) {
    macros.addMacro("wtargets")
            .addParameter("mode", false, "all")
            .addPossibleValue("all")
            .addPossibleValue("current")
            .addParameter("selection", true, "true")
            .addPossibleValue("true")
            .addPossibleValue("false")
            .addParameter("template", true, "summary")
            .addPossibleValue("summary")
            .addPossibleValue("vlist")
            .addPossibleValue("hlist");
    macros.addMacro("wsolutions")
            .copyParametersFrom("wtargets", macros);
    macros.addMacro("wservices")
            .copyParametersFrom("wtargets", macros);
    macros.addMacro("wnexts")
            .addParameter("template", true, "summary")
            .addPossibleValue("summary")
            .addPossibleValue("vlist")
            .addPossibleValue("hlist");
    macros.addMacro("wsiblings")
            .copyParametersFrom("wnexts", macros);
    macros.addMacro("wgoals")
            .addParameter("template", true, "gsummary");
    macros.addMacro("wcurrent")
            .addParameter("template", true, "full");
    macros.addMacro("witem")
            .addParameter("wtag", false)
            .addParameter("template", true, "full");
    macros.addMacro("wgoal")
            .addParameter("waction", false)
            .addParameter("template", true, "gfull");
    macros.addMacro("wexternals")
            .addParameter("template", true, "webLinks");
  }
 
  private void vertexMarker(Set<FunnelVertex> vertices, String template) {
    if(CollectionUtil.from(vertices).isEmpty()) return;
    ElephantMarker marker = new ElephantMarker(constructor);
    marker.put("vertices", vertices);
    marker.put("backLink", TagsServlet.navigateBack(constructor, null));
    out.write(marker.parse("web/funnel", template));
  }
  
  private void goalMarker(Set<WebGoal> goals, String template) {
    if(CollectionUtil.from(goals).isEmpty()) return;
    ElephantMarker marker = new ElephantMarker(constructor);
    marker.put("goals", goals);
    out.write(marker.parse("web/funnel", template));
  }
  
  private void linkMarker(Set<WebLink> links, String template) {
    ElephantMarker marker = new ElephantMarker(constructor);
    marker.put("links", links);
    out.write(marker.parse("web/funnel", template));
  }
  
}