PhaseDefinitions.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.phase;
 
import java.io.File;
import java.io.IOException;
import java.io.Writer;
import java.util.Set;
import java.util.TreeSet;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.impl.util.FileUtil;
import org.turro.file.FileWatch;
import org.turro.lock.Initializer;
import org.turro.reflection.JSONSerializer;
import org.turro.security.ConceptPermission;
 
public class PhaseDefinitions extends TreeSet<PhaseDefinition> {
 
  public PhaseDefinition get(int index) {
    return stream().filter(pd -> pd.getIndex() == index).findFirst().orElse(null);
  }
  
  public PhaseDefinition get(String name) {
    return stream().filter(pd -> pd.getName().equals(name)).findFirst().orElse(null);
  }
  
  public int getMapping(int index, String serverId) {
    PhaseDefinition pd = get(index);
    if(pd == null) return index;
    return pd.getMapping().getOrDefault(serverId, index);
  }
  
  /* Defaults */
  
  private void setDefaults() {
    add(PhaseDefinition.create(0, "Idea", Set.of(PhaseType.CREATION))
            .icon("lightbulb yellow")
            .described("New idea")
            .addPermission(ConceptPermission.allow(ConceptPermission.TAGS))
            .addPermission(ConceptPermission.allow(ConceptPermission.SUPPORT).max(1))
            .addPermission(ConceptPermission.allow(ConceptPermission.BENEFICIARY))
            .addPermission(ConceptPermission.allow(ConceptPermission.OFFERER)));
    add(PhaseDefinition.create(1, "Incubator", Set.of(PhaseType.INCUBATOR))
            .icon("egg orange")
            .described("Project incubation")
            .addPermission(ConceptPermission.allow(ConceptPermission.TAGS))
            .addPermission(ConceptPermission.allow(ConceptPermission.SUPPORT).max(1))
            .addPermission(ConceptPermission.allow(ConceptPermission.BENEFICIARY))
            .addPermission(ConceptPermission.allow(ConceptPermission.OFFERER)));
    add(PhaseDefinition.create(2, "Votes", Set.of(PhaseType.VOTES))
            .icon("vote yea violet")
            .described("Internally voted")
            .addMapping("domain/axserver", 2)
            .addPermission(ConceptPermission.allow(ConceptPermission.TAGS))
            .addPermission(ConceptPermission.allow(ConceptPermission.VOTES))
            .addPermission(ConceptPermission.allow(ConceptPermission.PROPOSALS))
            .addPermission(ConceptPermission.allow(ConceptPermission.BENEFICIARY))
            .addPermission(ConceptPermission.allow(ConceptPermission.OFFERER))
            .addPermission(ConceptPermission.allow(ConceptPermission.CONSORTIUM)));
    add(PhaseDefinition.create(3, "Deciding", Set.of(PhaseType.DECISION))
            .icon("users olive")
            .described("Next step based on votes")
            .addMapping("domain/axserver", 2)
            .addPermission(ConceptPermission.allow(ConceptPermission.TAGS))
            .addPermission(ConceptPermission.forbid(ConceptPermission.VOTES).show())
            .addPermission(ConceptPermission.allow(ConceptPermission.PROPOSALS))
            .addPermission(ConceptPermission.allow(ConceptPermission.BENEFICIARY))
            .addPermission(ConceptPermission.allow(ConceptPermission.OFFERER))
            .addPermission(ConceptPermission.allow(ConceptPermission.CONSORTIUM)));
    add(PhaseDefinition.create(4, "Proposals", Set.of(PhaseType.PROPOSALS))
            .icon("user tag brown")
            .described("Request for proposal")
            .addMapping("domain/axserver", 2)
            .addPermission(ConceptPermission.allow(ConceptPermission.TAGS))
            .addPermission(ConceptPermission.allow(ConceptPermission.PROPOSALS))
            .addPermission(ConceptPermission.allow(ConceptPermission.BENEFICIARY))
            .addPermission(ConceptPermission.allow(ConceptPermission.OFFERER))
            .addPermission(ConceptPermission.allow(ConceptPermission.CONSORTIUM)));
    add(PhaseDefinition.create(5, "Execution", Set.of(PhaseType.EXECUTION))
            .icon("cogs teal")
            .described("Being executed")
            .addMapping("domain/axserver", 3)
            .addPermission(ConceptPermission.allow(ConceptPermission.TAGS))
            .addPermission(ConceptPermission.allow(ConceptPermission.DEBATES))
            .addPermission(ConceptPermission.allow(ConceptPermission.DELIVERABLES)
                    .showRole("@partner:on|@admin:is")
                    .actionScript("user.admin || dpl.isDriver(user)"))
            .addPermission(ConceptPermission.allow(ConceptPermission.BENEFICIARY))
            .addPermission(ConceptPermission.allow(ConceptPermission.OFFERER))
            .addPermission(ConceptPermission.allow(ConceptPermission.CONSORTIUM)));
    add(PhaseDefinition.create(6, "Resolution", Set.of(PhaseType.ARCHIVE))
            .icon("check green")
            .described("Project archive")
            .addMapping("domain/axserver", 4)
            .addPermission(ConceptPermission.allow(ConceptPermission.TAGS))
            .addPermission(ConceptPermission.allow(ConceptPermission.DEBATES))
            .addPermission(ConceptPermission.forbid(ConceptPermission.DELIVERABLES).show()
                    .showRole("@partner:on|@admin:is")
                    .actionScript("user.admin || dpl.isDriver(user)"))
            .addPermission(ConceptPermission.allow(ConceptPermission.BENEFICIARY))
            .addPermission(ConceptPermission.allow(ConceptPermission.OFFERER))
            .addPermission(ConceptPermission.allow(ConceptPermission.CONSORTIUM)));
  }
 
  /* Factory */
  
  private static final Initializer<PhaseDefinitions> INIT = new Initializer<>();
  private static final FileWatch watch = new FileWatch(definitionsFile());
  
  public static PhaseDefinitions instance() {
    return INIT.instance(() -> !watch.isNewer(), () -> load());
  }
  
  public static void reset() {
    INIT.reset();
  }
  
  private static final String PROJECT_PHASES_FILE = "/WEB-INF/elephant/conf/project-phases.json";
 
  protected static PhaseDefinitions load() {
    PhaseDefinitions definitions = null;
    if(watch.exists()) try {
      watch.reset();
      JSONSerializer ser = new JSONSerializer(true);
      definitions = ser.fromJson(FileUtil.getContent(watch.getFile()), PhaseDefinitions.class);
    } catch (IOException ex) {
      Logger.getLogger(PhaseDefinitions.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
    if(definitions == null) {
      definitions = new PhaseDefinitions();
      definitions.setDefaults();
      save(definitions);
    }
    return definitions;
  }
  
  private static void save(PhaseDefinitions definitions) {
    try (Writer writer = FileUtil.getFileWriter(watch.getFileSafe())) {
      JSONSerializer ser = new JSONSerializer(definitions, true);
      writer.write(ser.toJson());
    } catch (IOException ex) {
      Logger.getLogger(PhaseDefinitions.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
  }
  
  private static File definitionsFile() {
    return new File(ElephantContext.getRealPath(PROJECT_PHASES_FILE));
  }
 
}