IssueEventInfo.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2015 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.dossier.command;
 
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import org.amic.util.date.CheckDate;
import org.turro.string.Strings;
import org.turro.action.EntitiesInfo;
import org.turro.action.EntityInfoType;
import org.turro.action.LinkType;
import org.turro.annotation.ExternalEvent;
import org.turro.dossier.db.DossierPU;
import org.turro.dossier.entity.Issue;
import org.turro.dossier.issue.IssueWrapper;
import org.turro.dossier.search.CategoryResults;
import org.turro.elephant.context.Application;
import org.turro.elephant.db.WhereClause;
import org.turro.i18n.I_;
import org.turro.plugin.calendar.CalendarColor;
import org.turro.plugin.calendar.DefaultCalendarEvent;
import org.turro.plugin.calendar.ICalendarEvent;
import org.turro.plugin.calendar.ICalendarInfo;
import org.turro.www.describeit.DescribeItCtrl;
 
@ExternalEvent
public class IssueEventInfo implements ICalendarInfo {
 
  /*
  dossierCategories=1,...,n | all
  required=(S) start, (C) control, (D) delivery, (R) resolution, (I) creation, TODO: (M) modification
  */
  @Override
  public Collection<ICalendarEvent> execute(Date start, Date end, HashMap<String, String> args) {
    return getEvents(start, end, args);
  }
 
  private Collection<ICalendarEvent> getEvents(Date start, Date end, HashMap<String, String> args) {
    ArrayList<ICalendarEvent> events = new ArrayList<>();
    for(Issue issue : getIssues(start, end, args)) {
      checkIssue(events, new IssueWrapper(issue), args);
    }
    return events;
  }
 
  private List<Issue> getIssues(Date start, Date end, HashMap<String, String> args) {
    String dossierCategories = args.get("dossierCategories");
    String required = args.get("required");
    WhereClause wc = new WhereClause();
    wc.addClause("select distinct i from Issue as i");
    wc.addClause("where i.publishable = TRUE");
    wc.addClause("and (");
    String join = "";
    if(isRequired("S", required)) {
      wc.addClause(join + " (i.startDate >= :start and i.startDate <= :end)");
      join = "or";
    }
    if(isRequired("C", required)) {
      wc.addClause(join + " (i.controlDate >= :start and i.controlDate <= :end)");
      join = "or";
    }
    if(isRequired("D", required)) {
      wc.addClause(join + " (i.delivery >= :start and i.delivery <= :end)");
      join = "or";
    }
    if(isRequired("R", required)) {
      wc.addClause(join + " (i.solvedDate >= :start and i.solvedDate <= :end)");
      join = "or";
    }
    if(isRequired("I", required)) {
      wc.addClause(join + " (i.issueDate >= :start and i.issueDate <= :end)");
      join = "or";
    }
    if(isRequired("M", required)) {
      wc.addClause(join + " (i.modification >= :start and i.modification <= :end)");
      join = "or";
    }
    wc.addClause(")");
    wc.addNamedValue("start", start);
    wc.addNamedValue("end", end);
    if(!Strings.isBlank(dossierCategories)) {
      if(!"all".equals(dossierCategories)) {
        CategoryResults.addExistsCategoryAffiliance(wc, dossierCategories, "i.dossier");
      }
      return new DossierPU().getResultList(Issue.class, wc);
    } else {
      return Collections.EMPTY_LIST;
    }
  }
 
  private void checkIssue(ArrayList<ICalendarEvent> events, IssueWrapper iw, HashMap<String, String> args) {
    String required = args.get("required");
    String target = args.get("target");
    if("self".equals(target) && !(Application.getApplication().isInRole("issue:all") || iw.isFullParticipant())) {
      return;
    }
    HashSet<Date> dates = new HashSet<>();
    if(iw.getBeginDate()!= null && isRequired("S", required)) {
      DefaultCalendarEvent calendarEvent = new DefaultCalendarEvent();
      calendarEvent.setLocked(false);
      calendarEvent.setDone(iw.getIssue().getStatus().isFinished());
      calendarEvent.setHeaderColor(CalendarColor.RED.getHeader());
      calendarEvent.setContentColor(CalendarColor.RED.getContent());
      calendarEvent.setBeginDate(iw.getBeginDate());
      dates.add(calendarEvent.getBeginDate());
      if(isRequired("D", required) && new CheckDate(iw.getBeginDate()).sameDay(iw.getEndDate())) {
        calendarEvent.setEndDate(iw.getEndDate());
        dates.add(iw.getEndDate());
      } else {
        calendarEvent.setEndDate(calendarEvent.getBeginDate());
      }
      calendarEvent.setPath(DossierPU.getObjectPath(iw.getIssue()));
      calendarEvent.setTitle(iw.getIssue().getDescription());
      calendarEvent.setContent(getContent(iw));
      calendarEvent.setMotive(I_.get("Start date"));
      events.add(calendarEvent);
    }
    if(iw.getEndDate()!= null && !dates.contains(iw.getEndDate()) && isRequired("D", required)) {
      DefaultCalendarEvent calendarEvent = new DefaultCalendarEvent();
      calendarEvent.setLocked(false);
      calendarEvent.setDone(iw.getIssue().getStatus().isFinished());
      calendarEvent.setHeaderColor(CalendarColor.RED.getHeader());
      calendarEvent.setContentColor(CalendarColor.RED.getContent());
      calendarEvent.setBeginDate(iw.getEndDate());
      dates.add(calendarEvent.getBeginDate());
      calendarEvent.setEndDate(calendarEvent.getBeginDate());
      calendarEvent.setPath(DossierPU.getObjectPath(iw.getIssue()));
      calendarEvent.setTitle(iw.getIssue().getDescription());
      calendarEvent.setContent(getContent(iw));
      calendarEvent.setMotive(I_.get("End date"));
      events.add(calendarEvent);
    }
    if(iw.getControlDate() != null && !dates.contains(iw.getControlDate()) && isRequired("C", required)) {
      DefaultCalendarEvent calendarEvent = new DefaultCalendarEvent();
      calendarEvent.setLocked(false);
      calendarEvent.setDone(iw.getIssue().getStatus().isFinished());
      calendarEvent.setHeaderColor(CalendarColor.RED.getHeader());
      calendarEvent.setContentColor(CalendarColor.RED.getContent());
      calendarEvent.setBeginDate(iw.getControlDate());
      dates.add(calendarEvent.getBeginDate());
      calendarEvent.setEndDate(calendarEvent.getBeginDate());
      calendarEvent.setPath(DossierPU.getObjectPath(iw.getIssue()));
      calendarEvent.setTitle(iw.getIssue().getDescription());
      calendarEvent.setContent(getContent(iw));
      calendarEvent.setMotive(I_.get("Control"));
      events.add(calendarEvent);
    }
    if(iw.getIssue().getSolvedDate() != null && !dates.contains(iw.getIssue().getSolvedDate()) && isRequired("R", required)) {
      DefaultCalendarEvent calendarEvent = new DefaultCalendarEvent();
      calendarEvent.setLocked(false);
      calendarEvent.setDone(iw.getIssue().getStatus().isFinished());
      calendarEvent.setHeaderColor(CalendarColor.RED.getHeader());
      calendarEvent.setContentColor(CalendarColor.RED.getContent());
      calendarEvent.setBeginDate(iw.getIssue().getSolvedDate());
      dates.add(calendarEvent.getBeginDate());
      calendarEvent.setEndDate(calendarEvent.getBeginDate());
      calendarEvent.setPath(DossierPU.getObjectPath(iw.getIssue()));
      calendarEvent.setTitle(iw.getIssue().getDescription());
      calendarEvent.setContent(getContent(iw));
      calendarEvent.setMotive(I_.get("Closing"));
      events.add(calendarEvent);
    }
    if(iw.getIssue().getIssueDate() != null && !dates.contains(iw.getIssue().getIssueDate()) && isRequired("I", required)) {
      DefaultCalendarEvent calendarEvent = new DefaultCalendarEvent();
      calendarEvent.setLocked(false);
      calendarEvent.setDone(iw.getIssue().getStatus().isFinished());
      calendarEvent.setHeaderColor(CalendarColor.RED.getHeader());
      calendarEvent.setContentColor(CalendarColor.RED.getContent());
      calendarEvent.setBeginDate(iw.getIssue().getIssueDate());
      dates.add(calendarEvent.getBeginDate());
      calendarEvent.setEndDate(calendarEvent.getBeginDate());
      calendarEvent.setPath(DossierPU.getObjectPath(iw.getIssue()));
      calendarEvent.setTitle(iw.getIssue().getDescription());
      calendarEvent.setContent(getContent(iw));
      calendarEvent.setMotive(I_.get("Creation"));
      events.add(calendarEvent);
    }
    if(iw.getIssue().getModification() != null && !dates.contains(iw.getIssue().getModification()) && isRequired("M", required)) {
      DefaultCalendarEvent calendarEvent = new DefaultCalendarEvent();
      calendarEvent.setLocked(false);
      calendarEvent.setDone(iw.getIssue().getStatus().isFinished());
      calendarEvent.setHeaderColor(CalendarColor.RED.getHeader());
      calendarEvent.setContentColor(CalendarColor.RED.getContent());
      calendarEvent.setBeginDate(iw.getIssue().getModification());
      dates.add(calendarEvent.getBeginDate());
      calendarEvent.setEndDate(calendarEvent.getBeginDate());
      calendarEvent.setPath(DossierPU.getObjectPath(iw.getIssue()));
      calendarEvent.setTitle(iw.getIssue().getDescription());
      calendarEvent.setContent(getContent(iw));
      calendarEvent.setMotive(I_.get("Modification"));
      events.add(calendarEvent);
    }
  }
  
  private String getContent(IssueWrapper iw) {
    DescribeItCtrl dic = new DescribeItCtrl(Application.getApplication().getConstructor());
    dic.setEntityPath(DossierPU.getObjectPath(iw.getIssue()));
    HashMap<String, Object> args = new HashMap<>();
    args.put("dic", dic);
    return EntitiesInfo.getString(iw.getIssue(), iw, "issue", EntityInfoType.SUMMARY, LinkType.NONE, args);
  }
  
  private boolean isRequired(String value, String param) {
    if(!Strings.isBlank(value) && !Strings.isBlank(param)) {
      return param.contains(value);
    }
    return true;
  }
  
}