ContactsParser.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.contacts.Contact;
import org.turro.contacts.ContactServiceRole;
import org.turro.contacts.content.ContactServiceContentIterator;
import org.turro.contacts.content.ConvocationContentIterator;
import org.turro.contacts.content.DirectoryContentIterator;
import org.turro.contacts.content.OldDirectoryContentIterator;
import org.turro.contacts.db.ContactsPU;
import org.turro.contacts.mydata.MyDataList;
import org.turro.contacts.profile.ProfileCtrl;
import org.turro.contacts.www.ContactIterator;
import org.turro.contacts.zul.register.SignUpCtrl;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.context.IConstructor;
import org.turro.elephant.db.WhereClause;
import org.turro.jpa.search.DaoHtmlSearch;
import org.turro.plugin.contacts.IContact;
import org.turro.www.convocation.ConvocationCheck;
import org.turro.www.describeit.DescribeItCtrl;
import org.turro.www.groupit.GroupsTree;
 
@ExternalParser
public class ContactsParser extends AbstractParser {
 
  @Override
  public String getParserName() {
    return "Contacts";
  }
 
  @Override
  protected boolean doExecute() {
    boolean done = false;
    if("groups".equals(getMacroName())) {
      out.write(getGroups(constructor, 
              null,
              null,
              getToken(1),
              getToken(2)));
      done = true;
    } else if("contacts".equals(getMacroName()) || "contacts-summary".equals(getMacroName())) { 
      out.write(getPublished(constructor, 
              (Integer) ObjectString.parseNativeString(getToken(1), Integer.class, true),
              getToken(2),
              getToken(3),
              getToken(5),
              getToken(4),
              "contacts".equals(getMacroName())));
      done = true;
    } else if("contacts-by-group".equals(getMacroName()) || "contacts-by-group-summary".equals(getMacroName())) {
      out.write(getContactByGroup(constructor, 
              (Integer) ObjectString.parseNativeString(getToken(1), Integer.class, true),
              getToken(2),
              getToken(3),
              null,
              "contacts-by-group".equals(getMacroName())));
      done = true;
    } else if("contactcount".equals(getMacroName())) { 
      Long count = getCount(constructor, getToken(1)); 
      out.write(count != null ? count + "" : "0");
      done = true;
    } else if("contacts-connector".equals(getMacroName()) || "contacts-connector-summary".equals(getMacroName())) { 
      out.write(getPublished(constructor, 
              (Integer) ObjectString.parseNativeString(getToken(1), Integer.class, true),
              getToken(2),
              getToken(3),
              getToken(4),
              getToken(6),
              getToken(5),
              "contacts-connector".equals(getMacroName())));
      done = true;
    } else if("my-data".equals(getMacroName())) { 
      out.write(checkMyData() ? getToken(1) : getToken(2));
      done = true;
    } else if("describe-it".equals(getMacroName())) { 
      if(!Strings.isBlank(getToken(1))) {
        DescribeItCtrl dic = new DescribeItCtrl(constructor);
        dic.setEntityPath(getToken(1));
        dic.renderDescriptions(getToken(2), true);
        done = true;
      }
    } else if("convocation-check".equals(getMacroName())) { 
      ConvocationCheck cc = new ConvocationCheck(constructor);
      if(tokens.length == 2) {
        cc.setTemplate(getToken(1));
      }
      out.write(cc.check());
    } else if("convocations".equals(getMacroName()) || "convocation-summary".equals(getMacroName()) ||
              "public-convocations".equals(getMacroName()) || "public-convocation-summary".equals(getMacroName()) ||
              "myconvocations".equals(getMacroName()) || "myconvocation-summary".equals(getMacroName())) {
      DaoHtmlSearch.renderInstance(constructor);
      ConvocationContentIterator cci = new ConvocationContentIterator(constructor, out, Authentication.getIContact(), false,
              Strings.isBlank(getToken(2)) ? null : ElephantContext.getRootWebPath() + getToken(2));
      cci.setMode(getToken(1));
      cci.setPage((Integer) ObjectString.parseNativeString(getToken(3), Integer.class, true));
      cci.setAllowAttachments(true);
      cci.setAllowComments(true);
      cci.setSummaryTemplate(getToken(4));
      if(getMacroName().contains("summary")) {
        cci.setNavigatorTop(false);
        cci.setNavigatorBottom(false);
      }
      if(getMacroName().contains("myconvocation")) {
        cci.setRestricted(true);
      }
      if(getMacroName().contains("public-")) {
        cci.setPublishable(true);
      }
      cci.load();
      cci.render();
      done = true;
    } else if("old-directory".equals(getMacroName())) {
      DaoHtmlSearch.renderInstance(constructor);
      OldDirectoryContentIterator dci = new OldDirectoryContentIterator(constructor, out, Authentication.getIContact(), false,
              Strings.isBlank(getToken(1)) ? null : ElephantContext.getRootWebPath() + getToken(1));
      dci.setPage((Integer) ObjectString.parseNativeString(getToken(2), Integer.class, true));
      dci.setAllowAttachments(true);
      dci.setAllowFiles(true);
      dci.setAllowComments(true);
      dci.setRestricted(true);
      dci.setSummaryTemplate(getToken(3));
      dci.load();
      dci.render();
      done = true;
    } else if(getMacroName().startsWith("directory")) {
      DaoHtmlSearch.renderInstance(constructor);
      DirectoryContentIterator pci = new DirectoryContentIterator(constructor, out, Authentication.getIContact(), false,
              Strings.isBlank(getToken(2)) ? null : ElephantContext.getRootWebPath() + getToken(2));
      pci.setPage((Integer) ObjectString.parseNativeString(getToken(3), Integer.class, true));
      pci.setAllowAttachments(true);
      pci.setAllowFiles(true);
      pci.setRestricted(false);
      pci.setTypes(getToken(1));
      pci.setSummaryTemplate(getToken(4));
      pci.assignDefaultsByName(getMacroName());
      pci.load();
      pci.render();
      done = true;
    } else if(getMacroName().startsWith("syndications")) {
      DaoHtmlSearch.renderInstance(constructor);
      DirectoryContentIterator pci = new DirectoryContentIterator(constructor, out, Authentication.getIContact(), false,
              Strings.isBlank(getToken(3)) ? null : ElephantContext.getRootWebPath() + getToken(3));
      pci.setPage((Integer) ObjectString.parseNativeString(getToken(4), Integer.class, true));
      pci.setAllowAttachments(true);
      pci.setAllowFiles(true);
      pci.setRestricted(false);
      pci.setTypes(getToken(1));
      pci.setSyndications(getToken(2));
      pci.setSummaryTemplate(getToken(5));
      pci.assignDefaultsByName(getMacroName());
      pci.load();
      pci.render();
      done = true;
    } else if("services".equals(getMacroName()) || "service-summary".equals(getMacroName()) ||
              "myservices".equals(getMacroName()) || "myservice-summary".equals(getMacroName()) ||
              "lastservices".equals(getMacroName()) || "lastservice-summary".equals(getMacroName()) ||
              "mylastservices".equals(getMacroName()) || "mylastservice-summary".equals(getMacroName())) {
      ContactServiceContentIterator csci = new ContactServiceContentIterator(constructor, out, Authentication.getIContact(), false,
              Strings.isBlank(getToken(3)) ? null : ElephantContext.getRootWebPath() + getToken(3));
      String role = getToken(1);
      csci.setRole("all".equals(role) ? null : ContactServiceRole.valueOf(role));
      String type = getToken(2);
      csci.setType("all".equals(type) ? null : type);
      csci.setPage((Integer) ObjectString.parseNativeString(getToken(4), Integer.class, true));
      csci.setAllowAttachments(true);
      csci.setAllowComments(true);
      csci.setSummaryTemplate(getToken(5));
      if(getMacroName().contains("summary")) {
        csci.setNavigatorTop(false);
        csci.setNavigatorBottom(false);
      }
      if(getMacroName().contains("my")) {
        csci.setRestricted(true);
      }
      if(getMacroName().contains("last")) {
        csci.setLastEntries(true);
        csci.setForceSummary(true);
      }
      csci.load();
      csci.render();
      done = true;
    } else if("register".equals(getMacroName())) { 
      SignUpCtrl ctrl = new SignUpCtrl();
      ctrl.setConstructor(constructor);
      ctrl.setTemplate(getToken(1));
      out.write(ctrl.parse(constructor));
    } else if("profile".equals(getMacroName())) { 
      DirectoryContentIterator pci = new DirectoryContentIterator(constructor, out, Authentication.getIContact(), false, null);
      pci.setPage(100);
      pci.setNavigatorTop(false);
      pci.setNavigatorBottom(false);
      pci.setAllowAttachments(true);
      pci.setAllowFiles(true);
      pci.setRestricted(false);
      pci.setContactIds(Strings.toList(getToken(1), ";"));
      pci.setSummaryTemplate(getToken(2));
      pci.assignDefaultsByName(getMacroName());
      pci.load();
      pci.render();
      done = true;
    } else if("myprofile".equals(getMacroName())) { 
      ProfileCtrl ctrl = new ProfileCtrl();
      ctrl.setConstructor(constructor);
      ctrl.setTemplate(getToken(1));
      ctrl.setContact(null); // forces current
      out.write(ctrl.parse(constructor));
    }
    return done;
  }
 
  @Override
  protected void explainMacros(ParserMacroSet macros) {
    macros.addMacro("groups")
            .addParameter("context", false)
            .addParameter("group-category", false);
    macros.addMacro("contacts")
            .addParameter("count", true, "10")
            .addParameter("syndicationId", true)
            .addParameter("summaryTemplate", true, "summary")
            .addParameter("context", true)
            .addParameter("fullTemplate", true, "full");
    macros.addMacro("contacts-summary")
            .copyParametersFrom("contacts", macros);
    macros.addMacro("contacts-by-group")
            .addParameter("count", true, "10")
            .addParameter("groupings", true)
            .addParameter("summaryTemplate", true, "summary");
    macros.addMacro("contacts-by-group-summary")
            .copyParametersFrom("contacts-by-group", macros);
    macros.addMacro("contactcount")
            .addParameter("syndicationId", true);
    macros.addMacro("contacts-connector")
            .addParameter("count", false, "10")
            .addParameter("connector", false)
            .addParameter("value", true, null, true)
            .addParameter("summaryTemplate", true, "summary")
            .addParameter("context", true)
            .addParameter("fullTemplate", true, "full");
    macros.addMacro("contacts-connector-summary")
            .copyParametersFrom("contacts-connector", macros);
    macros.addMacro("my-data")
            .addParameter("valid", false)
            .addParameter("not-valid", false);
    macros.addMacro("describe-it")
            .addParameter("entityPath", false)
            .addParameter("id", true, "Default");
    macros.addMacro("convocation-check")
            .addParameter("template", true, "check");
    macros.addMacro("convocations")
            .addParameter("mode", false)
            .addPossibleValue("open")
            .addPossibleValue("closed")
            .addPossibleValue("all")
            .addParameter("context", true)
            .addParameter("count", true, "10")
            .addParameter("template", true, "summary");
    macros.addMacro("convocation-summary")
            .copyParametersFrom("convocations", macros);
    macros.addMacro("myconvocations")
            .copyParametersFrom("convocations", macros);
    macros.addMacro("myconvocation-summary")
            .copyParametersFrom("convocations", macros);
    macros.addMacro("public-convocations")
            .copyParametersFrom("convocations", macros);
    macros.addMacro("public-convocation-summary")
            .copyParametersFrom("convocations", macros);
    macros.addMacro("old-directory")
            .addParameter("context", true)
            .addParameter("count", true, "12")
            .addParameter("template", true, "summary");
    macros.addMacro("directory")
            .addParameter("type", true, "all", true)
            .addPossibleValue("all")
            .addPossibleValue("typed")
            .addPossibleValue("companies")
            .addPossibleValue("centers")
            .addPossibleValue("professionals")
            .addPossibleValue("educators")
            .addPossibleValue("students")
            .addPossibleValue("singletons")
            .addParameter("context", true)
            .addParameter("count", true, "12")
            .addParameter("template", true, "summary");
    macros.addDefaultsFor("directory", macros);
    macros.addMacro("syndications")
            .addParameter("type", true, "all", true)
            .addPossibleValue("all")
            .addPossibleValue("typed")
            .addPossibleValue("companies")
            .addPossibleValue("centers")
            .addPossibleValue("professionals")
            .addPossibleValue("educators")
            .addPossibleValue("students")
            .addPossibleValue("singletons")
            .addParameter("syndicationId", true)
            .addParameter("context", true)
            .addParameter("count", true, "12")
            .addParameter("template", true, "summary");
    macros.addDefaultsFor("syndications", macros);
    macros.addMacro("services")
            .addParameter("role", false)
            .addPossibleValue("SERVICE_SUPPLY")
            .addPossibleValue("SERVICE_DEMAND")
            .addParameter("type", false)
            .addParameter("context", true)
            .addParameter("count", true, "10")
            .addParameter("template", true, "summary");
    macros.addMacro("service-summary")
            .copyParametersFrom("services", macros);
    macros.addMacro("myservices")
            .copyParametersFrom("services", macros);
    macros.addMacro("myservice-summary")
            .copyParametersFrom("services", macros);
    macros.addMacro("lastservices")
            .copyParametersFrom("services", macros);
    macros.addMacro("lastservice-summary")
            .copyParametersFrom("services", macros);
    macros.addMacro("mylastservices")
            .copyParametersFrom("services", macros);
    macros.addMacro("mylastservice-summary")
            .copyParametersFrom("services", macros);
    macros.addMacro("register")
            .addParameter("template", true, "signup");
    macros.addMacro("profile")
            .addParameter("contactIds", false)
            .addParameter("template", true, "summary");
    macros.addMacro("myprofile")
            .addParameter("template", true, "profile");
  }
 
  public Long getCount(IConstructor constructor, String syndicationId) {
    WhereClause wc = new WhereClause();
    wc.addClause("select count(c) from Contact as c");
    if(!Strings.isBlank(syndicationId)) {
      wc.addClause("join c.syndications as s");
      wc.addClause("where s.name = :syndication");
      wc.addNamedValue("syndication", syndicationId);
    }
    return (Long) new ContactsPU().getSingleResultOrNull(wc);
  }
  
  public String getPublished(IConstructor constructor, int count, String syndicationId, 
          String summaryTemplate, String fullTemplate, String context, boolean navigator) {
    try {
      if(context == null) {
        context = constructor.getCurrentContext().getPath();
      }
      constructor.setOutputToString();
      DaoHtmlSearch.renderInstance(constructor);
      ContactIterator pi = new ContactIterator(constructor, ElephantContext.getRootWebPath() + context, null);
      pi.setNavigatorTop(navigator);
      pi.setNavigatorBottom(navigator);
      pi.setFullTemplate(fullTemplate);
      pi.setSummaryTemplate(summaryTemplate);
      pi.setPage(count);
      pi.setSyndicationId(syndicationId);
      pi.load();
      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;
  }
  
  public String getPublished(IConstructor constructor, int count, String connector, String values, 
          String summaryTemplate, String fullTemplate, String context, boolean navigator) {
    try {
      constructor.setOutputToString();
      DaoHtmlSearch.renderInstance(constructor);
      ContactIterator pi = new ContactIterator(constructor, ElephantContext.getRootWebPath() + context, null);
      pi.setNavigatorTop(navigator);
      pi.setNavigatorBottom(navigator);
      pi.setFullTemplate(fullTemplate);
      pi.setSummaryTemplate(summaryTemplate);
      pi.setPage(count);
      pi.setConnector(connector, values);
      pi.load();
      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;
  }
  
  private String getContactByGroup(IConstructor constructor, int count, String groupings,
          String summaryTemplate, String context, boolean navigator) {
    
    try {
      constructor.setOutputToString();
      DaoHtmlSearch.renderInstance(constructor);
      ContactIterator pi = new ContactIterator(constructor, ElephantContext.getRootWebPath() + context, null);
      pi.setNavigatorTop(navigator);
      pi.setNavigatorBottom(navigator);
      pi.setSummaryTemplate(summaryTemplate);
      pi.setPage(count);
      pi.setGroupings(Arrays.asList(groupings.split(",")));
      pi.load();
      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;
  }
  
  public String getGroups(IConstructor constructor, String summaryTemplate, String fullTemplate, String context, String category) {
    try {
      constructor.setOutputToString();
      GroupsTree pi = new GroupsTree(constructor, ElephantContext.getRootWebPath() + context, category);
      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;
  }
 
  private boolean checkMyData() {
    IContact icontact = Authentication.getIContact();
    if(icontact.isValid()) {
      Object contact = icontact.getContact();
      if(contact instanceof Contact) {
        MyDataList myData = ((Contact) contact).getMyData();
        return myData.isValid();
      } else {
        return false;
      }
    }
    return true;
  }
 
}