DossierParser.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2014 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.io.IOException;
import java.util.Arrays;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.turro.string.ObjectString;
import org.turro.string.Strings;
import org.turro.annotation.ExternalParser;
import org.turro.auth.Authentication;
import org.turro.dossier.entity.IssueType;
import org.turro.dossier.www.AddInformationCtrl;
import org.turro.dossier.www.CategoriesTree;
import org.turro.dossier.www.CreateIssueCtrl;
import org.turro.dossier.www.DossierIterator;
import org.turro.dossier.www.EditDossierCtrl;
import org.turro.dossier.www.IssueIterator;
import org.turro.dossier.www.IssueOrdering;
import org.turro.dossier.www.QuestionCtrl;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.context.IConstructor;
import org.turro.path.Path;
import org.turro.util.IdGenerator;
 
@ExternalParser
public class DossierParser extends AbstractParser {
 
  @Override
  public String getParserName() {
    return "Dossier";
  }
 
  @Override
  protected boolean doExecute() {
    boolean done = false;
    if("issues".equals(getMacroName()) || "issue-summary".equals(getMacroName()) ||
       "myissues".equals(getMacroName()) || "myissue-summary".equals(getMacroName()) ||
       "assisted-issues".equals(getMacroName()) || "assisted-issue-summary".equals(getMacroName())) {
      IssueIterator ii = new IssueIterator(constructor, 
              Strings.isBlank(getToken(2)) ? null : ElephantContext.getRootWebPath() + getToken(2), 
              IdGenerator.generate());
      if("onwork".equals(getToken(1))) {
        ii.setIssueStatus(Arrays.asList("STATUS_NEW,STATUS_STARTED,STATUS_INCOMPLETE,STATUS_REOPENED,STATUS_REUNION,STATUS_FROZEN,STATUS_RESOLVED,STATUS_VERIFIED".split(",")));
      } else if("closed".equals(getToken(1))) {
        ii.setIssueStatus(Arrays.asList("STATUS_CLOSED".split(",")));
      }
      ii.setCategoryId((Integer) ObjectString.parseNativeString(getToken(3), Integer.class, true));
      ii.setDossierId((Integer) ObjectString.parseNativeString(getToken(4), Integer.class, true));
      ii.setPage((Integer) ObjectString.parseNativeString(getToken(5), Integer.class, true));
      ii.setAllowAttachments(true);
      ii.setAllowDescriptions(true);
      ii.setAllowInterest(true);
      ii.setAllowVotes(true);
      ii.setAllowComments(true);
      ii.setRestricted(false);
      ii.setSummaryTemplate(getToken(6));
      if(getMacroName().contains("summary")) {
        ii.setOrderBy(IssueOrdering.ORDER_BY_ACTIVITY);
        ii.setNavigatorTop(false);
        ii.setNavigatorBottom(false);
      }
      if(getMacroName().contains("myissue")) {
        ii.setRestricted(true);
      }
      if(getMacroName().contains("assisted")) {
        ii.setRestricted(true);
        ii.setOnlyAssists(true);
      }
      ii.load();
      ii.render();
      done = true;
    } else if("dossiers".equals(getMacroName()) || "dossier-summary".equals(getMacroName()) ||
              "mydossiers".equals(getMacroName()) || "mydossier-summary".equals(getMacroName())) {
      //{@dossiers:onwork|closed|all:context:categoryIds:dossierId:count[:summary]}
      DossierIterator di = new DossierIterator(constructor, 
              Strings.isBlank(getToken(2)) ? null : ElephantContext.getRootWebPath() + getToken(2), 
              IdGenerator.generate());
      if("onwork".equals(getToken(1))) {
        di.setDossierStatus(Arrays.asList("DOSSIER_OPENED,DOSSIER_FROZEN".split(",")));
      } else if("closed".equals(getToken(1))) {
        di.setDossierStatus(Arrays.asList("DOSSIER_CLOSED".split(",")));
      } else if("not-frozen".equals(getToken(1))) {
        di.setDossierStatus(Arrays.asList("DOSSIER_OPENED,DOSSIER_CLOSED".split(",")));
      } else if("frozen".equals(getToken(1))) {
        di.setDossierStatus(Arrays.asList("DOSSIER_FROZEN".split(",")));
      }
      di.setAllowedCategories(getToken(3));
      di.setDossierId((Integer) ObjectString.parseNativeString(getToken(4), Integer.class, true));
      di.setPage((Integer) ObjectString.parseNativeString(getToken(5), Integer.class, true));
      di.setAllowAttachments(true);
      di.setAllowDescriptions(true);
      di.setAllowInterest(true);
      di.setAllowVotes(true);
      di.setAllowComments(true);
      di.setRestricted(false);
      di.setSummaryTemplate(getToken(6));
      if(getMacroName().contains("summary")) {
        di.setNavigatorTop(false);
        di.setNavigatorBottom(false);
      }
      if(getMacroName().contains("mydossiers")) {
        di.setRestricted(true);
      }
      di.load();
      di.render();
      done = true;
    } else if("direct-dossiers".equals(getMacroName()) || "direct-dossier-summary".equals(getMacroName()) ||
              "related-dossiers".equals(getMacroName()) || "related-dossier-summary".equals(getMacroName())) {      
      DossierIterator di = new DossierIterator(constructor, 
              Strings.isBlank(getToken(2)) ? null : ElephantContext.getRootWebPath() + getToken(2), 
              IdGenerator.generate());
      if("onwork".equals(getToken(1))) {
        di.setDossierStatus(Arrays.asList("DOSSIER_OPENED,DOSSIER_FROZEN".split(",")));
      } else if("closed".equals(getToken(1))) {
        di.setDossierStatus(Arrays.asList("DOSSIER_CLOSED".split(",")));
      } else if("not-frozen".equals(getToken(1))) {
        di.setDossierStatus(Arrays.asList("DOSSIER_OPENED,DOSSIER_CLOSED".split(",")));
      } else if("frozen".equals(getToken(1))) {
        di.setDossierStatus(Arrays.asList("DOSSIER_FROZEN".split(",")));
      }
      di.setAllowedCategories(getToken(3));
      di.setPage((Integer) ObjectString.parseNativeString(getToken(4), Integer.class, true));
      di.setAllowAttachments(true);
      di.setAllowDescriptions(true);
      di.setAllowInterest(true);
      di.setAllowVotes(true);
      di.setAllowComments(true);
      if(getMacroName().contains("direct")) {
        di.setRestricted(true);
        di.setDirect(true);
      }
      if(getMacroName().contains("related")) {
        di.setRestricted(false);
        di.setRelated(Authentication.getIContact().getCoworkers());
      }
      di.setSummaryTemplate(getToken(5));
      if(getMacroName().contains("summary")) {
        di.setNavigatorTop(false);
        di.setNavigatorBottom(false);
      }
      di.load();
      di.render();
      done = true;
    } else if("pending-vote".equals(getMacroName())) {
      DossierIterator di = new DossierIterator(constructor, 
              Strings.isBlank(getToken(1)) ? null : ElephantContext.getRootWebPath() + getToken(1), 
              IdGenerator.generate());
      di.setProjectPhases(Arrays.asList(new String[] { getToken(2) }));
      di.setAllowedCategories(getToken(4));
      di.setPage((Integer) ObjectString.parseNativeString(getToken(5), Integer.class, true));
      di.setAllowAttachments(true);
      di.setAllowDescriptions(true);
      di.setAllowInterest(true);
      di.setAllowVotes(true);
      di.setAllowComments(true);
      di.setRestricted(false);
      di.setPendingWorths(getToken(3));
      di.setSummaryTemplate(getToken(6));
      di.setNavigatorTop(false);
      di.setNavigatorBottom(false);
      di.load();
      di.render();
      done = true;
    } else if("categories".equals(getMacroName())) {
      out.write(getCategories(constructor, 
              null,
              null,
              getToken(1),
              getToken(2)));
      done = true;
    } else if("web-path".equals(getMacroName())) {
      if(getToken(1).startsWith("/dossier/")) { 
        Path path = new Path(getToken(1));
        out.write("/user/mydossiers/?item=" + path.getLastNode());
        done = true;
      } else if(getToken(1).startsWith("/issue/")) { 
        Path path = new Path(getToken(1));
        out.write("/user/myissues/?item=" + path.getLastNode());
        done = true;
      }
    } else if("edit-dossier".equals(getMacroName())) {
      out.write(EditDossierCtrl.editDossier(getToken(1), getToken(2), getToken(3)));
      done = true;
    } else if("create-issue".equals(getMacroName())) {
      out.write(CreateIssueCtrl.createIssue(getToken(1), getToken(2), getToken(3)));
      done = true;
    } else if("edit-question".equals(getMacroName())) {
      out.write(QuestionCtrl.editQuestion(getToken(1), getToken(2), IssueType.valueOf(getToken(3)), getToken(4)));
      done = true;
    } else if("issue-add-info".equals(getMacroName())) { 
      out.write(AddInformationCtrl.addInformation(getToken(1), getToken(3), getToken(2)));
      done = true;
    }
    return done;
  }
 
  @Override
  protected void explainMacros(ParserMacroSet macros) {
    macros.addMacro("issues")
            .addParameter("status", false)
            .addPossibleValue("onwork")
            .addPossibleValue("closed")
            .addPossibleValue("all")
            .addParameter("context", true)
            .addParameter("categoryId", true, "0")
            .addParameter("dossierId", true, "0")
            .addParameter("count", true, "10")
            .addParameter("template", true, "summary")
            .addPossibleValue("mySummary")
            .addPossibleValue("kbSummary")
            .addPossibleValue("questions")
            .addPossibleValue("proposals")
            .addPossibleValue("motions");
    macros.addMacro("issue-summary")
            .copyParametersFrom("issues", macros);
    macros.addMacro("myissues")
            .copyParametersFrom("issues", macros);
    macros.addMacro("myissues-summary")
            .copyParametersFrom("issues", macros);
    macros.addMacro("assisted-issues")
            .copyParametersFrom("issues", macros);
    macros.addMacro("assisted-issue-summary")
            .copyParametersFrom("issues", macros);
    macros.addMacro("dossiers")
            .addParameter("status", false)
            .addPossibleValue("onwork")
            .addPossibleValue("closed")
            .addPossibleValue("not-frozen")
            .addPossibleValue("frozen")
            .addPossibleValue("all")
            .addParameter("context", true)
            .addParameter("categoryIds", true, null, true)
            .addParameter("dossierId", true)
            .addParameter("count", true, "10")
            .addParameter("template", true, "summary")
            .addPossibleValue("projects")
            .addPossibleValue("dossiers");
    macros.addMacro("dossier-summary")
            .copyParametersFrom("dossiers", macros);
    macros.addMacro("mydossiers")
            .copyParametersFrom("dossiers", macros);
    macros.addMacro("mydossier-summary")
            .copyParametersFrom("dossiers", macros);
    macros.addMacro("direct-dossiers")
            .addParameter("status", false)
            .addPossibleValue("onwork")
            .addPossibleValue("closed")
            .addPossibleValue("not-frozen")
            .addPossibleValue("frozen")
            .addPossibleValue("all")
            .addParameter("context", true)
            .addParameter("categoryIds", true, null, true)
            .addParameter("count", true, "10")
            .addParameter("template", true, "summary")
            .addPossibleValue("projects")
            .addPossibleValue("dossiers");
    macros.addMacro("direct-dossier-summary")
            .copyParametersFrom("direct-dossiers", macros);
    macros.addMacro("related-dossiers")
            .copyParametersFrom("dossiers", macros);
    macros.addMacro("related-dossier-summary")
            .copyParametersFrom("dossiers", macros);
    macros.addMacro("pending-vote")
            .addParameter("context", false)
            .addParameter("phase", false)
            .addParameter("worths", false, null, true)
            .addParameter("categoryIds", true, null, true)
            .addParameter("count", true, "10")
            .addParameter("template", true, "summary")
            .addPossibleValue("projects")
            .addPossibleValue("dossiers");
    macros.addMacro("categories")
            .addParameter("status", false)
            .addPossibleValue("onwork")
            .addPossibleValue("closed")
            .addPossibleValue("not-frozen")
            .addPossibleValue("frozen")
            .addPossibleValue("all")
            .addParameter("context", true)
            .addParameter("categoryIds", true, null, true)
            .addParameter("template", true, "full");
    macros.addMacro("web-path")
            .addParameter("path", false);
    macros.addMacro("edit-dossier")
            .addParameter("id", false)
            .addParameter("template", true, "editDossier");
    macros.addMacro("create-issue")
            .addParameter("redirect", false)
            .addParameter("dossierId", true)
            .addParameter("template", true, "create");
    macros.addMacro("edit-question")
            .addParameter("id", false)
            .addParameter("redirect", false)
            .addParameter("type", true, "TYPE_QUESTION")
            .addParameter("template", true, "editQuestion");
    macros.addMacro("issue-add-info")
            .addParameter("id", false)
            .addParameter("template", true, "addinfo")
            .addParameter("redirect", true);
  }
 
  public String getCategories(IConstructor constructor, String summaryTemplate, String fullTemplate, String context, String categories) {
    try {
      constructor.setOutputToString();
      CategoriesTree pi = new CategoriesTree(constructor, context, Authentication.getIContact(), categories, null, null);
      pi.fillTree("");
      pi.render();
      constructor.setOut(null);
      return constructor.getOutputString();
    } catch (IOException ex) {
      Logger.getLogger(ContactsParser.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
    return null;
  }
 
}