StickyUtils.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.pdd.core.behaviour.built_in.load_balance.sticky;

  22. import java.io.ByteArrayOutputStream;
  23. import java.util.HashMap;
  24. import java.util.List;
  25. import java.util.Map;

  27. import javax.servlet.http.Cookie;
  28. import javax.servlet.http.HttpServletRequest;

  30. import org.apache.commons.lang.StringUtils;
  31. import org.openspcoop2.core.config.PortaApplicativa;
  32. import org.openspcoop2.core.config.Proprieta;
  33. import org.openspcoop2.core.id.IDPortaApplicativa;
  34. import org.openspcoop2.message.OpenSPCoop2Message;
  35. import org.openspcoop2.message.constants.MessageType;
  36. import org.openspcoop2.message.constants.ServiceBinding;
  37. import org.openspcoop2.pdd.config.ConfigurazionePdDManager;
  38. import org.openspcoop2.pdd.config.OpenSPCoop2Properties;
  39. import org.openspcoop2.pdd.core.CostantiPdD;
  40. import org.openspcoop2.pdd.core.PdDContext;
  41. import org.openspcoop2.pdd.core.behaviour.BehaviourEmitDiagnosticException;
  42. import org.openspcoop2.pdd.core.behaviour.BehaviourException;
  43. import org.openspcoop2.pdd.core.behaviour.BehaviourPropertiesUtils;
  44. import org.openspcoop2.pdd.core.behaviour.conditional.ConditionalUtils;
  45. import org.openspcoop2.pdd.core.dynamic.DynamicUtils;
  46. import org.openspcoop2.pdd.core.dynamic.ErrorHandler;
  47. import org.openspcoop2.pdd.core.dynamic.MessageContent;
  48. import org.openspcoop2.pdd.core.dynamic.Template;
  49. import org.openspcoop2.pdd.logger.MsgDiagnosticiProperties;
  50. import org.openspcoop2.pdd.logger.MsgDiagnostico;
  51. import org.openspcoop2.pdd.services.connector.FormUrlEncodedHttpServletRequest;
  52. import org.openspcoop2.protocol.sdk.Busta;
  53. import org.openspcoop2.protocol.sdk.state.IState;
  54. import org.openspcoop2.protocol.sdk.state.RequestInfo;
  55. import org.openspcoop2.utils.regexp.RegExpNotFoundException;
  56. import org.openspcoop2.utils.regexp.RegularExpressionEngine;
  57. import org.openspcoop2.utils.transport.TransportUtils;
  58. import org.openspcoop2.utils.transport.http.HttpServletTransportRequestContext;
  59. import org.openspcoop2.utils.xml.AbstractXPathExpressionEngine;
  60. import org.openspcoop2.utils.xml2json.JsonXmlPathExpressionEngine;
  61. import org.slf4j.Logger;

  63. /**
  64.  * ConditionalUtils
  65.  *
  66.  * @author Andrea Poli (apoli@link.it)
  67.  * @author $Author$
  68.  * @version $Rev$, $Date$
  69.  */
  70. public class StickyUtils  {
  71.     
  72.     public static StickyResult getStickyResult(PortaApplicativa pa, OpenSPCoop2Message message, Busta busta, 
  73.             RequestInfo requestInfo, PdDContext pddContext, 
  74.             MsgDiagnostico msgDiag, Logger log,
  75.             IState state) throws BehaviourException, BehaviourEmitDiagnosticException {
  76.         
  77.         if(isConfigurazioneSticky(pa, log)==false) {
  78.             return null; // non vi è da fare alcun filtro condizionale
  79.         }
  80.         
  81.         StickyResult result = new StickyResult();
  82.         
  83.         StickyConfigurazione config = read(pa, log);

  85.         StickyTipoSelettore tipoSelettore = config.getTipoSelettore();
  86.         String patternSelettore = config.getPattern();
  87.         
  88.         String pattern = "";
  89.         try {
  90.             Map<String, List<String>> pTrasporto = null;
  91.             String urlInvocazione = null;
  92.             Map<String, List<String>> pQuery = null;
  93.             Map<String, List<String>> pForm = null;
  94.             if(requestInfo!=null && requestInfo.getProtocolContext()!=null) {
  95.                 pTrasporto = requestInfo.getProtocolContext().getHeaders();
  96.                 urlInvocazione = requestInfo.getProtocolContext().getUrlInvocazione_formBased();
  97.                 pQuery = requestInfo.getProtocolContext().getParameters();
  98.                 if(requestInfo.getProtocolContext() instanceof HttpServletTransportRequestContext) {
  99.                     HttpServletTransportRequestContext httpServletContext = (HttpServletTransportRequestContext) requestInfo.getProtocolContext();
  100.                     HttpServletRequest httpServletRequest = httpServletContext.getHttpServletRequest();
  101.                     if(httpServletRequest!=null && httpServletRequest instanceof FormUrlEncodedHttpServletRequest) {
  102.                         FormUrlEncodedHttpServletRequest formServlet = (FormUrlEncodedHttpServletRequest) httpServletRequest;
  103.                         if(formServlet.getFormUrlEncodedParametersValues()!=null &&
  104.                                 !formServlet.getFormUrlEncodedParametersValues().isEmpty()) {
  105.                             pForm = formServlet.getFormUrlEncodedParametersValues();
  106.                         }
  107.                     }
  108.                 }
  109.             }
  110.             MessageContent messageContent = null;
  111.             boolean bufferMessage_readOnly =  OpenSPCoop2Properties.getInstance().isReadByPathBufferEnabled();
  112.             if(StickyTipoSelettore.CONTENT_BASED.equals(tipoSelettore) || tipoSelettore.isTemplate()) {
  113.                 if(ServiceBinding.SOAP.equals(message.getServiceBinding())){
  114.                     messageContent = new MessageContent(message.castAsSoap(), bufferMessage_readOnly, pddContext);
  115.                 }
  116.                 else{
  117.                     if(MessageType.XML.equals(message.getMessageType())){
  118.                         messageContent = new MessageContent(message.castAsRestXml(), bufferMessage_readOnly, pddContext);
  119.                     }
  120.                     else if(MessageType.JSON.equals(message.getMessageType())){
  121.                         messageContent = new MessageContent(message.castAsRestJson(), bufferMessage_readOnly, pddContext);
  122.                     }
  123.                     else{
  124.                         if(StickyTipoSelettore.CONTENT_BASED.equals(tipoSelettore) 
  125.                                 // Nei template potrei utilizzare gli header o altre informazioni che non entrano nel merito del contenuto //|| tipoSelettore.isTemplate()
  126.                                 ) {
  127.                             throw new Exception("Selettore '"+tipoSelettore.getValue()+"' non supportato per il message-type '"+message.getMessageType()+"'");
  128.                         }
  129.                     }
  130.                 }
  131.             }
  132.             
  133.             msgDiag.addKeyword(CostantiPdD.KEY_TIPO_SELETTORE, tipoSelettore.getValue());
  134.             msgDiag.addKeyword(CostantiPdD.KEY_PATTERN_SELETTORE, pattern); // per eliminare @@ dove non serve
  135.             
  136.             String condition = null;
  137.             switch (tipoSelettore) {
  138.             
  139.             case COOKIE_BASED:
  140.                 pattern = " (Cookie: "+patternSelettore+")";
  141.                 msgDiag.addKeyword(CostantiPdD.KEY_PATTERN_SELETTORE, pattern);
  142.                 StickyCookieConfig stickyCookie = new StickyCookieConfig(patternSelettore);
  143.                 if(requestInfo!=null && requestInfo.getProtocolContext()!=null && requestInfo.getProtocolContext().getHttpServletRequest()!=null) {
  144.                     Cookie [] cookies = requestInfo.getProtocolContext().getHttpServletRequest().getCookies();
  145.                     if(cookies!=null && cookies.length>0) {
  146.                         for (Cookie cookie : cookies) {
  147.                             if(cookie.getName().equalsIgnoreCase(stickyCookie.getName())) {
  148.                                 
  149.                                 // NOTA: Nelle richieste il domani e il path non dovrebbero mai esserci. Lascio comunque il codice.
  150.                                 
  151.                                 if(!StringUtils.isEmpty(stickyCookie.getDomain())) {
  152.                                     if(!stickyCookie.getDomain().equals(cookie.getDomain())) {
  153.                                         continue; // il cookie non ha un match sul domain
  154.                                     }
  155.                                 }
  156.                                 if(!StringUtils.isEmpty(stickyCookie.getPath())) {
  157.                                     if(!stickyCookie.getPath().equals(cookie.getPath())) {
  158.                                         continue; // il cookie non ha un match sul domain
  159.                                     }
  160.                                 }
  161.                                 
  162.                                 condition = cookie.getValue();
  163.                                 
  164.                                 if(cookie.getMaxAge()>0) {
  165.                                     result.setMaxAgeSeconds(cookie.getMaxAge());
  166.                                 }
  167.                                 
  168.                                 break;
  169.                             }
  170.                         }
  171.                     }
  172.                 }
  173.                 if(condition==null) {
  174.                     throw new Exception("cookie non presente");
  175.                 }
  176.                 break;
  177.             
  178.             case HEADER_BASED:
  179.                 pattern = " (Header HTTP: "+patternSelettore+")";
  180.                 msgDiag.addKeyword(CostantiPdD.KEY_PATTERN_SELETTORE, pattern);
  181.                 condition = TransportUtils.getFirstValue(pTrasporto, patternSelettore);
  182.                 if(condition==null) {
  183.                     throw new Exception("header non presente");
  184.                 }
  185.                 break;
  186.                 
  187.             case URLBASED:
  188.                 pattern = " (Espressione Regolare: "+patternSelettore+")";
  189.                 msgDiag.addKeyword(CostantiPdD.KEY_PATTERN_SELETTORE, pattern);
  190.                 try{
  191.                     condition = RegularExpressionEngine.getStringMatchPattern(urlInvocazione, patternSelettore);
  192.                 }catch(RegExpNotFoundException notFound){}
  193.                 break;
  194.                 
  195.             case FORM_BASED:
  196.                 pattern = " (Parametro URL: "+patternSelettore+")";
  197.                 msgDiag.addKeyword(CostantiPdD.KEY_PATTERN_SELETTORE, pattern);
  198.                 condition = TransportUtils.getFirstValue(pQuery, patternSelettore);
  199.                 if(condition==null) {
  200.                     throw new Exception("parametro della url non presente");
  201.                 }
  202.                 break;
  203.                 
  204.             case CONTENT_BASED:
  205.                 AbstractXPathExpressionEngine xPathEngine = null;
  206.                 if(messageContent==null) {
  207.                     throw new Exception("messaggio non presente");
  208.                 }
  209.                 if(messageContent.isXml()) {
  210.                     pattern = " (xPath: "+patternSelettore+")";
  211.                     msgDiag.addKeyword(CostantiPdD.KEY_PATTERN_SELETTORE, pattern);
  212.                     xPathEngine = new org.openspcoop2.message.xml.XPathExpressionEngine(message.getFactory());
  213.                     condition = AbstractXPathExpressionEngine.extractAndConvertResultAsString(messageContent.getElement(), xPathEngine, patternSelettore,  log);
  214.                 }
  215.                 else {
  216.                     pattern = " (jsonPath: "+patternSelettore+")";
  217.                     msgDiag.addKeyword(CostantiPdD.KEY_PATTERN_SELETTORE, pattern);
  218.                     condition = JsonXmlPathExpressionEngine.extractAndConvertResultAsString(messageContent.getElementJson(), patternSelettore, log);
  219.                 }
  220.                 break;
  221.                 
  222.             case INDIRIZZO_IP:
  223.                 if(pddContext!=null && pddContext.containsKey(org.openspcoop2.core.constants.Costanti.CLIENT_IP_REMOTE_ADDRESS)) {
  224.                     condition = (String) pddContext.getObject(org.openspcoop2.core.constants.Costanti.CLIENT_IP_REMOTE_ADDRESS);
  225.                 }
  226.                 break;
  227.                 
  228.             case INDIRIZZO_IP_FORWARDED:
  229.                 if(pddContext!=null && pddContext.containsKey(org.openspcoop2.core.constants.Costanti.CLIENT_IP_TRANSPORT_ADDRESS)) {
  230.                     condition = (String) pddContext.getObject(org.openspcoop2.core.constants.Costanti.CLIENT_IP_TRANSPORT_ADDRESS);
  231.                 }
  232.                 break;
  233.                 
  234.             case TEMPLATE:
  235.                 if(patternSelettore.length()<50) {
  236.                     pattern = " ("+patternSelettore+")";
  237.                 }
  238.                 else {
  239.                     pattern = "";
  240.                 }
  241.                 msgDiag.addKeyword(CostantiPdD.KEY_PATTERN_SELETTORE, pattern);
  242.                 Map<String, Object> dynamicMap = new HashMap<>();
  243.                 ErrorHandler errorHandler = new ErrorHandler();
  244.                 DynamicUtils.fillDynamicMapRequest(log, dynamicMap, pddContext, urlInvocazione,
  245.                         message,
  246.                         messageContent, 
  247.                         busta, 
  248.                         pTrasporto, 
  249.                         pQuery,
  250.                         pForm,
  251.                         errorHandler);
  252.                 condition = DynamicUtils.convertDynamicPropertyValue("ConditionalConfig.gwt", patternSelettore, dynamicMap, pddContext);
  253.                 if(condition!=null) {
  254.                     condition = ConditionalUtils.normalizeTemplateResult(condition);
  255.                 }
  256.                 break;
  257.                 
  258.             case FREEMARKER_TEMPLATE:
  259.                 if(patternSelettore.length()<50) {
  260.                     pattern = " ("+patternSelettore+")";
  261.                 }
  262.                 else {
  263.                     pattern = "";
  264.                 }
  265.                 msgDiag.addKeyword(CostantiPdD.KEY_PATTERN_SELETTORE, pattern);
  266.                 dynamicMap = new HashMap<>();
  267.                 errorHandler = new ErrorHandler();
  268.                 DynamicUtils.fillDynamicMapRequest(log, dynamicMap, pddContext, urlInvocazione,
  269.                         message,
  270.                         messageContent, 
  271.                         busta, 
  272.                         pTrasporto, 
  273.                         pQuery,
  274.                         pForm,
  275.                         errorHandler);
  276.                 ByteArrayOutputStream bout = new ByteArrayOutputStream();
  277.                 ConfigurazionePdDManager configurazionePdDManager = ConfigurazionePdDManager.getInstance(state);
  278.                 IDPortaApplicativa idPA = new IDPortaApplicativa();
  279.                 idPA.setNome(pa.getNome());
  280.                 Template template = configurazionePdDManager.getTemplateConnettoreMultiploSticky(idPA, patternSelettore.getBytes(), requestInfo);
  281.                 DynamicUtils.convertFreeMarkerTemplate(template, dynamicMap, bout);
  282.                 bout.flush();
  283.                 bout.close();
  284.                 condition = bout.toString();
  285.                 if(condition!=null) {
  286.                     condition = ConditionalUtils.normalizeTemplateResult(condition);
  287.                 }
  288.                 break;
  289.                 
  290.             case VELOCITY_TEMPLATE:
  291.                 if(patternSelettore.length()<50) {
  292.                     pattern = " ("+patternSelettore+")";
  293.                 }
  294.                 else {
  295.                     pattern = "";
  296.                 }
  297.                 msgDiag.addKeyword(CostantiPdD.KEY_PATTERN_SELETTORE, pattern);
  298.                 dynamicMap = new HashMap<>();
  299.                 errorHandler = new ErrorHandler();
  300.                 DynamicUtils.fillDynamicMapRequest(log, dynamicMap, pddContext, urlInvocazione,
  301.                         message,
  302.                         messageContent, 
  303.                         busta, 
  304.                         pTrasporto, 
  305.                         pQuery,
  306.                         pForm,
  307.                         errorHandler);
  308.                 bout = new ByteArrayOutputStream();
  309.                 configurazionePdDManager = ConfigurazionePdDManager.getInstance(state);
  310.                 idPA = new IDPortaApplicativa();
  311.                 idPA.setNome(pa.getNome());
  312.                 template = configurazionePdDManager.getTemplateConnettoreMultiploSticky(idPA, patternSelettore.getBytes(), requestInfo);
  313.                 DynamicUtils.convertVelocityTemplate(template, dynamicMap, bout);
  314.                 bout.flush();
  315.                 bout.close();
  316.                 condition = bout.toString();
  317.                 if(condition!=null) {
  318.                     condition = ConditionalUtils.normalizeTemplateResult(condition);
  319.                 }
  320.                 break;
  321.             }
  322.         
  323.             if(condition==null || "".equals(condition)) {
  324.                 throw new Exception("Nessuna condizione estratta");
  325.             }
  326.             else {
  327.                 result.setCondition(condition);
  328.                 result.setFound(true);              
  329.                 
  330.                 msgDiag.addKeyword(CostantiPdD.KEY_CONDIZIONE_STICKY, condition);
  331.                 
  332.                 msgDiag.logPersonalizzato(MsgDiagnosticiProperties.MSG_DIAG_CONSEGNA_CONTENUTI_APPLICATIVI, 
  333.                         "connettoriMultipli.loadBalancer.sticky.identificazioneRiuscita");
  334.                 
  335.             }
  336.             
  337.         }catch(Exception e) {
  338.             
  339.             msgDiag.addKeyword(CostantiPdD.KEY_ERRORE_PROCESSAMENTO, e.getMessage());
  340.             
  341.             msgDiag.logPersonalizzato(MsgDiagnosticiProperties.MSG_DIAG_CONSEGNA_CONTENUTI_APPLICATIVI, 
  342.                             "connettoriMultipli.loadBalancer.sticky.identificazioneFallita");
  343.         }
  344.         
  345.         
  346.         if(result.isFound()) {
  347.             if(config.getMaxAgeSeconds()!=null) {
  348.                 if(result.getMaxAgeSeconds()==null) {
  349.                     result.setMaxAgeSeconds(config.getMaxAgeSeconds());
  350.                 }
  351.             }
  352.         }
  353.         
  354.         return result;
  355.     }
  356.     
  357.     
  358.     public static boolean isConfigurazioneSticky(PortaApplicativa pa, Logger log) {
  359.         if(pa.getBehaviour()==null || pa.getBehaviour().sizeProprietaList()<=0) {
  360.             return false;
  361.         }
  362.         String type = null;
  363.         for (Proprieta p : pa.getBehaviour().getProprietaList()) {
  364.             if(StickyCostanti.STICKY.equals(p.getNome())) {
  365.                 type = p.getValore();
  366.                 break;
  367.             }
  368.         }
  369.         if(type==null) {
  370.             return false;
  371.         }
  372.         return "true".equals(type);
  373.     }
  374.         
  375.     public static StickyConfigurazione read(PortaApplicativa pa, Logger log) throws BehaviourException {
  376.         StickyConfigurazione config = new StickyConfigurazione();
  377.         if(pa.getBehaviour()==null || pa.getBehaviour().sizeProprietaList()<=0) {
  378.             throw new BehaviourException("Configurazione sticky non disponibile");
  379.         }
  380.         
  381.         for (Proprieta p : pa.getBehaviour().getProprietaList()) {
  382.             
  383.             String nome = p.getNome();
  384.             String valore = p.getValore().trim();
  385.             
  386.             try {
  387.                 if(StickyCostanti.STICKY.equals(nome)) {
  388.                     config.setStickyEnabled("true".equals(valore));
  389.                 }
  390.                 else if(StickyCostanti.STICKY_TIPO_SELETTORE.equals(nome)) {
  391.                     config.setTipoSelettore(StickyTipoSelettore.toEnumConstant(valore, true));
  392.                 }
  393.                 else if(StickyCostanti.STICKY_PATTERN.equals(nome)) {
  394.                     config.setPattern(valore);
  395.                 }
  396.                 else if(StickyCostanti.STICKY_EXPIRE.equals(nome)) {
  397.                     config.setMaxAgeSeconds(Integer.valueOf(valore));
  398.                 }
  399.             }catch(Exception e) {
  400.                 throw new BehaviourException("Configurazione sticky non corretta (proprietà:"+p.getNome()+" valore:'"+p.getValore()+"'): "+e.getMessage(),e);
  401.             }
  402.             
  403.         }

  405.         return config;
  406.     }
  407.     

  409.     public static void save(PortaApplicativa pa, StickyConfigurazione configurazione) throws BehaviourException {
  410.         
  411.         if(pa.getBehaviour()==null) {
  412.             throw new BehaviourException("Configurazione behaviour non abilitata");
  413.         }
  414.         if(configurazione==null) {
  415.             throw new BehaviourException("Configurazione condizionale non fornita");
  416.         }
  417.         BehaviourPropertiesUtils.addProprieta(pa.getBehaviour(),StickyCostanti.STICKY, configurazione.isStickyEnabled()+"");
  418.         
  419.         BehaviourPropertiesUtils.removeProprieta(pa.getBehaviour(),StickyCostanti.STICKY_TIPO_SELETTORE);
  420.         BehaviourPropertiesUtils.removeProprieta(pa.getBehaviour(),StickyCostanti.STICKY_PATTERN);
  421.         BehaviourPropertiesUtils.removeProprieta(pa.getBehaviour(),StickyCostanti.STICKY_EXPIRE);
  422.         
  423.         if(configurazione.isStickyEnabled()) {
  424.             if(configurazione.getTipoSelettore()!=null) {
  425.                 BehaviourPropertiesUtils.addProprieta(pa.getBehaviour(),StickyCostanti.STICKY_TIPO_SELETTORE, configurazione.getTipoSelettore().getValue());
  426.             }
  427.     
  428.             if(StringUtils.isNotEmpty(configurazione.getPattern())) {
  429.                 BehaviourPropertiesUtils.addProprieta(pa.getBehaviour(),StickyCostanti.STICKY_PATTERN, configurazione.getPattern());
  430.             }
  431.             
  432.             if(configurazione.getMaxAgeSeconds()!=null && configurazione.getMaxAgeSeconds().intValue()>0) {
  433.                 BehaviourPropertiesUtils.addProprieta(pa.getBehaviour(),StickyCostanti.STICKY_EXPIRE, configurazione.getMaxAgeSeconds().intValue()+"");
  434.             }
  435.         }
  436.         
  437.     }
  438.     
  439. }
Created with JaCoCo 0.8.8.202204050719