FunnelDashboard.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.web.funnel;
 
import java.io.IOException;
import java.io.PrintWriter;
import java.util.List;
import java.util.Set;
import javax.servlet.ServletException;
import org.turro.elephant.entities.web.WebGoal;
import org.turro.elephant.entities.web.WebItem;
import org.turro.elephant.impl.abstracts.AbstractElement;
import org.turro.elephant.impl.util.Parser;
import org.turro.elephant.web.actions.WebLink;
import org.turro.elephant.web.tags.SessionTags;
import org.turro.elephant.web.tags.TagsServlet;
import org.turro.marker.ElephantMarker;
import org.turro.marker.construct.Markers;
import org.turro.string.Nullable;
import org.turro.string.Strings;
import org.turro.web.funnel.graph.FunnelVertex;
import org.turro.web.funnel.model.FunnelVertices;
 
public class FunnelDashboard extends AbstractElement {
 
  private FunnelVertices vertices;
  private List<String> goalActions; 
 
  private boolean test;
 
  public boolean isTest() {
    return test;
  }
  
  @Override
  public void startConstruction() throws ServletException, IOException {
    goalActions = Strings.csvToList(getAttributes().getAttributeValue("attrib:goals", null));
    if(!goalActions.isEmpty()) SessionGoals.get(constructor).goals(goalActions);
    test = getAttributes().getAttributeBooleanValue("attrib:test", false);
    checkClean();
    vertices = FunnelVertices.load(constructor);
    FunnelVertex vertex = vertices.current();
    if(vertex == null) {
      constructTargets();
    } else {
      constructVertex(vertex);
    }
  }
 
  private void constructTargets() throws IOException, ServletException {
    processVertices(vertices.bySelection(false).targets(), "hlist");    
    if(test) constructTest(null);
  }
 
  private void constructVertex(FunnelVertex vertex) throws IOException, ServletException {
    PrintWriter out = getConstructor().getOut();
    WebItem webItem = vertex.getItem();
    Parser.processMacros(constructor, out, Strings.isBlank(webItem.getContent(), "NO_CONTENT"));
    if(test) constructTest(vertex);
  }
 
  private void constructTest(FunnelVertex vertex) throws IOException, ServletException {
    Markers.divider().cssClass("hidden").render(constructor);
    Markers.segment().start().render(constructor);
    Markers.header().level(3).cssClass("dividing")
            .caption(Nullable.of(vertex).get(v -> v.getItem().getCaption(), () -> "[TEST FUNNEL]"))
            .render(constructor);
    Markers.header().level(4).caption(SessionTags.get(constructor).path()).render(constructor);
    if(vertex != null) {
      vertices.bySelection(true);
      Set<FunnelVertex> nexts = vertices.nexts();
      if(nexts != null && !nexts.isEmpty()) {
        Markers.header().level(4).caption("Next steps").render(constructor);
        processVertices(nexts, "vlist");
      }
      constructBackTo(vertices.previous());
      Set<WebGoal> goals = vertices.goals();
      if(goals != null && !goals.isEmpty()) {
        Markers.header().level(4).caption("Goals").render(constructor);
        processGoals(goals, "gsummary");
      }
      Set<FunnelVertex> siblings = vertices.siblings();
      if(siblings != null && !siblings.isEmpty()) {
        Markers.header().level(4).caption("Also interesting").render(constructor);
        processVertices(siblings, "vlist");
      }
      Set<WebLink> externals = vertices.externals();
      if(externals != null && !externals.isEmpty()) {
        Markers.header().level(4).caption("Learn more").render(constructor);
        linkWebLinks(externals);
      }
    }
    constructCleanner();
    Markers.segment().end().render(constructor);
  }
  
  private void constructCleanner() {
    ElephantMarker marker = new ElephantMarker(constructor);
    marker.put("backLink", constructor.getCurrentContext().getFullPath() + "?clean=true");
    marker.put("dashboard", this);
    marker.process("web/funnel", "cleanner");
  }
 
  private void constructBackTo(FunnelVertex vertex) throws IOException, ServletException {
    ElephantMarker marker = new ElephantMarker(constructor);
    marker.put("vertex", vertex);
    marker.put("backLink", TagsServlet.navigateBack(constructor, constructor.getCurrentContext().getPath()));
    marker.put("dashboard", this);
    marker.process("web/funnel", "back");
  }
  
  private void processVertices(Set<FunnelVertex> vertices, String template) {
    ElephantMarker marker = new ElephantMarker(constructor);
    marker.put("vertices", vertices);
    marker.put("dashboard", this);
    marker.process("web/funnel", template);
  }
 
  private void processGoals(Set<WebGoal> goals, String template) {
    ElephantMarker marker = new ElephantMarker(constructor);
    marker.put("goals", goals);
    marker.put("dashboard", this);
    marker.process("web/funnel", template);
  }
 
  private void linkWebLinks(Set<WebLink> links) {
    ElephantMarker marker = new ElephantMarker(constructor);
    marker.put("links", links);
    marker.put("dashboard", this);
    marker.process("web/funnel", "webLinks");
  }
 
  /* Test clean */
  
  private void checkClean() {
    if(constructor.getParameter("clean") != null) {
      SessionTags.remove(constructor);
    }
  }
 
}