ValidationEngine.java

  1. /*
  2.  * GovWay - A customizable API Gateway 
  3.  * https://govway.org
  4.  * 
  5.  * Copyright (c) 2005-2025 Link.it srl (https://link.it).
  6.  * 
  7.  * This program is free software: you can redistribute it and/or modify
  8.  * it under the terms of the GNU General Public License version 3, as published by
  9.  * the Free Software Foundation.
  10.  *
  11.  * This program is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14.  * GNU General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public License
  17.  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18.  *
  19.  */
  20. package org.openspcoop2.web.lib.mvc.properties.utils;

  22. import java.util.List;

  24. import org.apache.commons.lang.StringUtils;
  25. import org.openspcoop2.core.mvc.properties.Collection;
  26. import org.openspcoop2.core.mvc.properties.Condition;
  27. import org.openspcoop2.core.mvc.properties.Conditions;
  28. import org.openspcoop2.core.mvc.properties.Config;
  29. import org.openspcoop2.core.mvc.properties.Defined;
  30. import org.openspcoop2.core.mvc.properties.Equals;
  31. import org.openspcoop2.core.mvc.properties.Item;
  32. import org.openspcoop2.core.mvc.properties.Property;
  33. import org.openspcoop2.core.mvc.properties.Section;
  34. import org.openspcoop2.core.mvc.properties.Selected;
  35. import org.openspcoop2.core.mvc.properties.Subsection;
  36. import org.openspcoop2.web.lib.mvc.properties.beans.BaseItemBean;
  37. import org.openspcoop2.web.lib.mvc.properties.beans.ConfigBean;
  38. import org.openspcoop2.web.lib.mvc.properties.beans.ItemBean;
  39. import org.openspcoop2.web.lib.mvc.properties.beans.SectionBean;
  40. import org.openspcoop2.web.lib.mvc.properties.beans.SubsectionBean;
  41. import org.openspcoop2.web.lib.mvc.properties.exception.ValidationException;
  42. import org.openspcoop2.core.mvc.properties.constants.ItemType;
  43. import org.openspcoop2.core.mvc.properties.provider.ExternalResources;
  44. import org.openspcoop2.core.mvc.properties.provider.IProvider;
  45. import org.openspcoop2.core.mvc.properties.provider.ProviderException;
  46. import org.openspcoop2.utils.resources.ClassLoaderUtilities;

  48. /****
  49.  * 
  50.  * ValidationEngine validatore delle configurazioni
  51.  * 
  52.  * @author Pintori Giuliano (pintori@link.it)
  53.  * @author $Author$
  54.  * @version $Rev$, $Date$
  55.  *
  56.  */
  57. public class ValidationEngine {
  58.     
  59.     

  61.     public static boolean validateConfig(Config config, ExternalResources externalResources)  throws ValidationException{
  62.         
  63.         // controllo l'univocita' delle chiavi e le conservo per riutilizzarle per verificare 
  64.         //che gli elementi riferiti nelle conditions esistano.
  65.         
  66.         ConfigBean metadata = getMetadata(config);
  67.         
  68.         List<Section> sectionList = config.getSectionList();
  69.         try {
  70.             for (int i= 0; i < sectionList.size() ; i++) {
  71.                 Section section = sectionList.get(i);
  72.                 validateSection(section,metadata, externalResources);
  73.             }
  74.         
  75.             // controllo che tutti gli item che vanno a finire dentro una unica property abbiano lo stesso separatore
  76.             for (String nomeProperty : metadata.getMapPropertyItem().keySet()) {
  77.                 String separatore = null;
  78.                 List<BaseItemBean<?>> list = metadata.getMapPropertyItem().get(nomeProperty);
  79.                 if(list.size() > 1) {
  80.                     for (BaseItemBean<?> itemBean : list) {
  81.                         if(itemBean.getSaveProperty()!= null && itemBean.getSaveProperty().isAppend()) {
  82.                             if(separatore == null) {
  83.                                 separatore = itemBean.getSaveProperty().getAppendSeparator();
  84.                             } else {
  85.                                 if(!separatore.equals(itemBean.getSaveProperty().getAppendSeparator()))
  86.                                     throw new ValidationException("I separatori di append per la property ["+nomeProperty+"] devono essere tutti uguali.");
  87.                             }
  88.                         }
  89.                     }
  90.                 }
  91.             }
  92.         
  93.         }catch(ValidationException e) {
  94.             throw new ValidationException("Errore durante la validazione della configurazione ["+config.getId()+"]: "+ e.getMessage(),e);
  95.         }
  96.         
  97.         return true;
  98.     }

  100.     private static void validateSection(Section section,ConfigBean metadata, ExternalResources externalResources) throws ValidationException{
  101.         try {
  102.             validaConditions(section.getConditions(),metadata);
  103.     
  104.             if(section.getItemList() != null) {
  105.                 for (Item item : section.getItemList()) {
  106.                     validaItem(item,metadata, externalResources);
  107.                 }
  108.             }
  109.             
  110.             if(section.getSubsectionList() != null) {
  111.                 for (int i= 0; i < section.getSubsectionList().size() ; i++) {
  112.                     Subsection subSection  = section.getSubsectionList().get(i);
  113.                     validaSubsection(subSection,metadata, externalResources);
  114.                 }
  115.             }
  116.         }catch(ValidationException e) {
  117.             throw new ValidationException("Section ["+section.getLabel()+"] -> "+ e.getMessage(), e);
  118.         }
  119.     }

  121.     private static void validaSubsection(Subsection subSection,ConfigBean metadata, ExternalResources externalResources) throws ValidationException {
  122.         try {
  123.             validaConditions(subSection.getConditions(),metadata);
  124.     
  125.             if(subSection.getItemList() != null) {
  126.                 for (Item item : subSection.getItemList()) {
  127.                     validaItem(item,metadata, externalResources);
  128.                 }
  129.             }
  130.         }catch(ValidationException e) {
  131.             throw new ValidationException("Subsection ["+subSection.getLabel()+"] -> "+ e.getMessage(), e);
  132.         }
  133.     }

  135.     private static void validaItem(Item item,ConfigBean metadata, ExternalResources externalResources) throws ValidationException {
  136.         try {
  137.             validaConditions(item.getConditions(),metadata);
  138.             
  139.             if(item.getProperty().getProperties() != null) {
  140.                 if(!metadata.getListaNomiProperties().contains(item.getProperty().getProperties()))
  141.                     throw new ValidationException("Il nome delle properties ["+item.getProperty().getProperties()+"] indicato nella collection non e' dichiarato nella sezione collection della configurazione");
  142.             }
  143.             
  144.             // il force puo' essere utilizzato solo da elementi hidden
  145.             if(item.getProperty().isForce() && !item.getType().equals(ItemType.HIDDEN)) {
  146.                 throw new ValidationException("L'attributo Force puo' essere utilizzato solo per gli items di tipo Hidden");
  147.             }
  148.             
  149.             switch(item.getType()){
  150.             case CHECKBOX:
  151.                 validaCheckBox(item);
  152.                 break;
  153.             case HIDDEN:
  154.             case LOCK_HIDDEN:
  155.                 validaHidden(item);
  156.                 break;
  157.             case NUMBER:
  158.                 validaNumber(item,metadata, externalResources);
  159.                 break;
  160.             case SELECT:
  161.                 validaSelect(item,metadata, externalResources);
  162.                 break;
  163.             case TEXT:
  164.             case TEXTAREA:
  165.             case LOCK:
  166.                 validaText(item,metadata, externalResources);
  167.                 break;
  168.             }
  169.         }catch(Exception e) {
  170.             throw new ValidationException("Item ["+item.getName()+"] non valido: "+ e.getMessage(), e);
  171.         }
  172.     }

  174.     private static void validaCheckBox(Item item) throws ValidationException{
  175.         Property property = item.getProperty();
  176.         // se e' una property di tipo append valido il separatore
  177.         if(property.isAppend()) {
  178.             if(property.getSelectedValue().contains(property.getAppendSeparator()))
  179.                 throw new ValidationException("Il valore indicato per l'attributo SelectedValue ["+property.getSelectedValue()+"] contiene il separatore previsto per il salvataggio ["+property.getAppendSeparator()+"]");
  180.             
  181.             if(property.getUnselectedValue().contains(property.getAppendSeparator()))
  182.                 throw new ValidationException("Il valore indicato per l'attributo UnselectedValue ["+property.getUnselectedValue()+"] contiene il separatore previsto per il salvataggio ["+property.getAppendSeparator()+"]");
  183.         }
  184.         
  185.     }

  187.     private static void validaHidden(Item item) throws ValidationException{
  188.         Property property = item.getProperty();
  189.         
  190.         if(item.getValue() == null) {
  191.             throw new ValidationException("L'attributo Value e' obbligatorio per gli elementi di tipo Hidden");
  192.         }
  193.         
  194.         // se e' una property di tipo append valido il separatore
  195.         if(property.isAppend()) {
  196.             if(item.getValue().contains(property.getAppendSeparator()))
  197.                 throw new ValidationException("Il valore indicato per l'attributo Value ["+item.getValue()+"] contiene il separatore previsto per il salvataggio ["+property.getAppendSeparator()+"]");
  198.         }
  199.         
  200.         
  201.     }

  203.     private static String getDefault(Item item,ConfigBean metadata, ExternalResources externalResources) throws ProviderException {
  204.         if(StringUtils.isNotEmpty(item.getDefault())) {
  205.             return item.getDefault();
  206.         }
  207.         else if(metadata.getProvider()!=null) {
  208.             return metadata.getProvider().getDefault(item.getName(), externalResources);
  209.         }
  210.         return null;
  211.     }
  212.     
  213.     private static void validaNumber(Item item,ConfigBean metadata, ExternalResources externalResources) throws ValidationException, ProviderException{
  214.         Property property = item.getProperty();
  215.         // se e' una property di tipo append valido il separatore
  216.         if(property.isAppend()) {
  217.             String defaultValue = getDefault(item, metadata, externalResources);
  218.             if(defaultValue != null && defaultValue.contains(property.getAppendSeparator()))
  219.                 throw new ValidationException("Il valore indicato per l'attributo Default ["+item.getValue()+"] contiene il separatore previsto per il salvataggio ["+property.getAppendSeparator()+"]");
  220.         }
  221.     }

  223.     private static void validaSelect(Item item,ConfigBean metadata, ExternalResources externalResources) throws ValidationException, ProviderException{
  224.         Property property = item.getProperty();
  225.         // se e' una property di tipo append valido il separatore
  226.         if(property.isAppend()) {
  227.             String defaultValue = getDefault(item, metadata, externalResources);
  228.             if(defaultValue != null && defaultValue.contains(property.getAppendSeparator()))
  229.                 throw new ValidationException("Il valore indicato per l'attributo Default ["+item.getValue()+"] contiene il separatore previsto per il salvataggio ["+property.getAppendSeparator()+"]");
  230.         }
  231.         
  232.         if(item.getValues() == null || item.getValues().sizeValueList() == 0) {
  233.             if(metadata.getProvider()==null || metadata.getProvider().getValues(item.getName(), externalResources)==null || metadata.getProvider().getValues(item.getName(), externalResources).size()<=0) {
  234.                 throw new ValidationException("E' necessario indicare una lista di Values, o definirli in un plugins, per gli Item di tipo Select");
  235.             }
  236.         }
  237.     }

  239.     private static void validaText(Item item,ConfigBean metadata, ExternalResources externalResources) throws ValidationException, ProviderException{
  240.         Property property = item.getProperty();
  241.         // se e' una property di tipo append valido il separatore
  242.         if(property.isAppend()) {
  243.             String defaultValue = getDefault(item, metadata, externalResources);
  244.             if(defaultValue != null &&  defaultValue.contains(property.getAppendSeparator()))
  245.                 throw new ValidationException("Il valore indicato per l'attributo Default ["+item.getValue()+"] contiene il separatore previsto per il salvataggio ["+property.getAppendSeparator()+"]");
  246.         }
  247.     }

  249.     private static void validaConditions(Conditions conditions,ConfigBean metadata) throws ValidationException {
  250.         if(conditions == null) return;
  251.         
  252.         for (int i = 0; i < conditions.sizeConditionList(); i ++) {
  253.         Condition condition = conditions.getCondition(i);
  254.             validaCondition(condition, (i+1),metadata);
  255.         }
  256.     }

  258.     private static void validaCondition(Condition condition, int indice,ConfigBean metadata) throws ValidationException{ 
  259.         if((condition.getDefinedList() == null || condition.getDefinedList().size() == 0) 
  260.                 && (condition.getEqualsList() == null || condition.getEqualsList().size() == 0)
  261.                 && (condition.getLessEqualsList() == null || condition.getLessEqualsList().size() == 0)
  262.                 && (condition.getLessThenList() == null || condition.getLessThenList().size() == 0)
  263.                 && (condition.getGreaterEqualsList() == null || condition.getGreaterEqualsList().size() == 0)
  264.                 && (condition.getGreaterThenList() == null || condition.getGreaterThenList().size() == 0)
  265.                 && (condition.getStartsWithList() == null || condition.getStartsWithList().size() == 0)
  266.                 && (condition.getEndsWithList() == null || condition.getEndsWithList().size() == 0)
  267.                 && (condition.getSelectedList() == null || condition.getSelectedList().size() == 0))
  268.             throw new ValidationException("La condition numero ["+indice+"] non e' valida: indicare almeno un elemento tra Defined, Equals o Selected.");
  269.         
  270.         // controlli sulle condizioni le condizioni devono riferire a elementi presenti
  271.         for (int i = 0; i < condition.getDefinedList().size(); i++) {
  272.             Defined defined = condition.getDefined(i);
  273.             if(!itemDefined(defined.getName(),metadata))
  274.                 throw new ValidationException("L'elemento Defined numero ["+(i+1)+"] della Condition numero ["
  275.                         +indice+"] non e' valido: si riferisce ad un elemento ["+defined.getName()+"] non presente nella configurazione.");
  276.                 
  277.             BaseItemBean<?> itemToCheck = metadata.getItem(defined.getName()); 
  278.             ItemType itemToCheckType = itemToCheck.getItemType();
  279.             
  280.             // la condizione defined non si puo' attivare su un elemento checkbox
  281.             if(itemToCheckType.equals(ItemType.CHECKBOX)) {
  282.                 throw new ValidationException("L'elemento Defined numero ["+(i+1)+"] della Condition numero ["
  283.                         +indice+"] non e' valido: si riferisce ad un elemento ["+defined.getName()+"] che ha un tipo non compatibile con la regola, non si puo' controllare se una CheckBox e' Defined");
  284.             }
  285.         }
  286.         
  287.         for (int i = 0; i < condition.getEqualsList().size(); i++) {
  288.             checkEqualsTypeCondition(condition.getEquals(i), condition, indice, metadata, i, "equals");
  289.         }
  290.         for (int i = 0; i < condition.getLessEqualsList().size(); i++) {
  291.             checkEqualsTypeCondition(condition.getLessEquals(i), condition, indice, metadata, i, "lessEquals");
  292.         }
  293.         for (int i = 0; i < condition.getLessThenList().size(); i++) {
  294.             checkEqualsTypeCondition(condition.getLessThen(i), condition, indice, metadata, i, "lessThen");
  295.         }
  296.         for (int i = 0; i < condition.getGreaterEqualsList().size(); i++) {
  297.             checkEqualsTypeCondition(condition.getGreaterEquals(i), condition, indice, metadata, i, "greaterEquals");
  298.         }
  299.         for (int i = 0; i < condition.getGreaterThenList().size(); i++) {
  300.             checkEqualsTypeCondition(condition.getGreaterThen(i), condition, indice, metadata, i, "greaterThen");
  301.         }
  302.         for (int i = 0; i < condition.getStartsWithList().size(); i++) {
  303.             checkEqualsTypeCondition(condition.getStartsWith(i), condition, indice, metadata, i, "startsWith");
  304.         }
  305.         for (int i = 0; i < condition.getEndsWithList().size(); i++) {
  306.             checkEqualsTypeCondition(condition.getEndsWith(i), condition, indice, metadata, i, "endsWith");
  307.         }
  308.         
  309.         for (int i = 0; i < condition.getSelectedList().size(); i++) {
  310.             Selected selected = condition.getSelected(i);
  311.             if(!itemDefined(selected.getName(),metadata))
  312.                 throw new ValidationException("L'elemento Selected numero ["+(i+1)+"] della Condition numero ["
  313.                         +indice+"] non e' valido: si riferisce ad un elemento ["+selected.getName()+"] non presente nella configurazione.");
  314.             
  315.             BaseItemBean<?> itemToCheck = metadata.getItem(selected.getName()); 
  316.             ItemType itemToCheckType = itemToCheck.getItemType();
  317.             
  318.             // la condizione selected si puo' attivare su un elemento checkbox
  319.             if(!itemToCheckType.equals(ItemType.CHECKBOX)
  320.                     && !itemToCheckType.equals(ItemType.HIDDEN) // aggiunto hidden perche' puo' essere utile quando si disattiva un checbox ma non si vuole eliminare il codice
  321.                     ) {
  322.                 throw new ValidationException("L'elemento Selected numero ["+(i+1)+"] della Condition numero ["
  323.                         +indice+"] non e' valido: si riferisce ad un elemento ["+selected.getName()+"] che non e' di tipo CheckBox");
  324.             }
  325.         }
  326.     }
  327.     
  328.     private static void checkEqualsTypeCondition(Equals equals, Condition condition, int indice,ConfigBean metadata, int i, String tipo) throws ValidationException {
  329.         if(!itemDefined(equals.getName(),metadata))
  330.             throw new ValidationException("L'elemento '"+tipo+"' numero ["+(i+1)+"] della Condition numero ["
  331.                     +indice+"] non e' valido: si riferisce ad un elemento ["+equals.getName()+"] non presente nella configurazione.");
  332.             
  333.         BaseItemBean<?> itemToCheck = metadata.getItem(equals.getName()); 
  334.         ItemType itemToCheckType = itemToCheck.getItemType();
  335.         
  336.         // la condizione equals non si puo' attivare su un elemento checkbox
  337.         if(itemToCheckType.equals(ItemType.CHECKBOX)) {
  338.             throw new ValidationException("L'elemento '"+tipo+"' numero ["+(i+1)+"] della Condition numero ["
  339.                     +indice+"] non e' valido: si riferisce ad un elemento ["+equals.getName()+"] che ha un tipo non compatibile con la regola, non si puo' controllare se una CheckBox e' Equals");
  340.         }
  341.     }
  342.     
  343.     private static boolean itemDefined(String itemName, ConfigBean metadata) {
  344.         return metadata.getListakeys().contains(itemName);
  345.     }
  346.     
  347.     public static ConfigBean getMetadata(Config config)  throws ValidationException{
  348.         IProvider provider = null;
  349.         if(StringUtils.isNotEmpty(config.getProvider())) {
  350.             try {
  351.                 provider = (IProvider) ClassLoaderUtilities.newInstance(config.getProvider());
  352.             }catch(Exception e) {
  353.                 throw new ValidationException("Errore durante l'istanziazione del provider ["+config.getProvider()+"]: "+e.getMessage(),e);
  354.             }
  355.         }
  356.         ConfigBean cbTmp = new ConfigBean(provider);
  357.         cbTmp.setId(config.getId());
  358.         
  359.         org.openspcoop2.core.mvc.properties.Properties properties = config.getProperties();
  360.         if(properties != null) {
  361.             List<Collection> collectionList = properties.getCollectionList();
  362.             for (Collection collection : collectionList) {
  363.                 cbTmp.getListaNomiProperties().add(collection.getName());
  364.             }
  365.         }
  366.         
  367.         List<Section> sectionList = config.getSectionList();
  368.         
  369.         for (int i= 0; i < sectionList.size() ; i++) {
  370.             Section section = sectionList.get(i);
  371.             getMetadataSection(section,"s"+i,cbTmp);
  372.         }
  373.         
  374.         return cbTmp;
  375.     }
  376.     
  377.     private static void getMetadataSection(Section section, String sectionIdx,ConfigBean cbTmp) throws ValidationException{
  378.         SectionBean sectionBean = new SectionBean(section,sectionIdx, cbTmp.getProvider());
  379.         cbTmp.addItem(sectionBean);
  380.         
  381.         if(section.getItemList() != null) {
  382.             for (Item item : section.getItemList()) {
  383.                 ItemBean itemBean = new ItemBean(item, item.getName(), cbTmp.getProvider()); 
  384.                 cbTmp.addItem(itemBean);
  385.             }
  386.         }
  387.         
  388.         if(section.getSubsectionList() != null) {
  389.             for (int i= 0; i < section.getSubsectionList().size() ; i++) {
  390.                 Subsection subSection  = section.getSubsectionList().get(i);
  391.                 getMetadataSubsection(subSection,sectionIdx+ "_ss"+i,cbTmp);
  392.             }
  393.         }
  394.      
  395.     }

  397.     private static void getMetadataSubsection(Subsection subSection, String subsectionIdx, ConfigBean cbTmp) throws ValidationException {
  398.         SubsectionBean subsectionBean = new SubsectionBean(subSection,subsectionIdx,cbTmp.getProvider());
  399.         cbTmp.addItem(subsectionBean);
  400.         
  401.         if(subSection.getItemList() != null) {
  402.             for (Item item : subSection.getItemList()) {
  403.                 ItemBean itemBean = new ItemBean(item, item.getName(),cbTmp.getProvider()); 
  404.                 cbTmp.addItem(itemBean);
  405.             }
  406.         }
  407.     }
  408. }
Created with JaCoCo 0.8.8.202204050719