WW-4572 Http parameters

core/src/main/java/com/opensymphony/xwork2/ActionContext.java

@@ -17,6 +17,7 @@
 
 import com.opensymphony.xwork2.inject.Container;
 import com.opensymphony.xwork2.util.ValueStack;
+import org.apache.struts2.dispatcher.HttpParameters;
 
 import java.io.Serializable;
 import java.util.HashMap;
@@ -259,7 +260,7 @@ public String getName() {
      *
      * @param parameters the parameters for the current action.
      */
-    public void setParameters(Map<String, Object> parameters) {
+    public void setParameters(HttpParameters parameters) {
         put(PARAMETERS, parameters);
     }
 
@@ -270,8 +271,8 @@ public void setParameters(Map<String, Object> parameters) {
      * @return a Map of HttpServletRequest parameters or a multipart map when in a servlet environment, or a
      *         generic Map of parameters otherwise.
      */
-    public Map<String, Object> getParameters() {
-        return (Map<String, Object>) get(PARAMETERS);
+    public HttpParameters getParameters() {
+        return (HttpParameters) get(PARAMETERS);
     }
 
     /**

core/src/main/java/com/opensymphony/xwork2/interceptor/AliasInterceptor.java

@@ -22,12 +22,14 @@
 import com.opensymphony.xwork2.config.entities.ActionConfig;
 import com.opensymphony.xwork2.inject.Inject;
 import com.opensymphony.xwork2.util.ClearableValueStack;
+import com.opensymphony.xwork2.util.Evaluated;
 import com.opensymphony.xwork2.util.LocalizedTextUtil;
 import com.opensymphony.xwork2.util.ValueStack;
 import com.opensymphony.xwork2.util.ValueStackFactory;
 import com.opensymphony.xwork2.util.reflection.ReflectionContextState;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.apache.struts2.dispatcher.HttpParameters;
 
 import java.util.Map;
 
@@ -157,18 +159,18 @@ public void setAliasesKey(String aliasesKey) {
                     Map.Entry entry = (Map.Entry) o;
                     String name = entry.getKey().toString();
                     String alias = (String) entry.getValue();
-                    Object value = stack.findValue(name);
-                    if (null == value) {
+                    Evaluated value = new Evaluated(stack.findValue(name));
+                    if (!value.isDefined()) {
                         // workaround
-                        Map<String, Object> contextParameters = ActionContext.getContext().getParameters();
+                        HttpParameters contextParameters = ActionContext.getContext().getParameters();
 
                         if (null != contextParameters) {
-                            value = contextParameters.get(name);
+                            value = new Evaluated(contextParameters.get(name));
                         }
                     }
-                    if (null != value) {
+                    if (value.isDefined()) {
                         try {
-                            newStack.setValue(alias, value);
+                            newStack.setValue(alias, value.get());
                         } catch (RuntimeException e) {
                             if (devMode) {
                                 String developerNotification = LocalizedTextUtil.findText(ParametersInterceptor.class, "devmode.notification", ActionContext.getContext().getLocale(), "Developer Notification:\n{0}", new Object[]{

core/src/main/java/com/opensymphony/xwork2/interceptor/ExceptionMappingInterceptor.java

@@ -19,8 +19,8 @@
 import com.opensymphony.xwork2.config.entities.ExceptionMappingConfig;
 import org.apache.logging.log4j.Logger;
 import org.apache.logging.log4j.LogManager;
+import org.apache.struts2.dispatcher.HttpParameters;
 
-import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
@@ -198,9 +198,10 @@ public String intercept(ActionInvocation invocation) throws Exception {
             List<ExceptionMappingConfig> exceptionMappings = invocation.getProxy().getConfig().getExceptionMappings();
             ExceptionMappingConfig mappingConfig = this.findMappingFromExceptions(exceptionMappings, e);
             if (mappingConfig != null && mappingConfig.getResult()!=null) {
-                Map parameterMap = mappingConfig.getParams();
+                Map<String, String> mappingParams = mappingConfig.getParams();
                 // create a mutable HashMap since some interceptors will remove parameters, and parameterMap is immutable
-                invocation.getInvocationContext().setParameters(new HashMap<String, Object>(parameterMap));
+                HttpParameters parameters = HttpParameters.create(mappingParams).build();
+                invocation.getInvocationContext().setParameters(parameters);
                 result = mappingConfig.getResult();
                 publishException(invocation, new ExceptionHolder(e));
             } else {

core/src/main/java/com/opensymphony/xwork2/interceptor/I18nInterceptor.java

@@ -20,6 +20,8 @@
 import com.opensymphony.xwork2.util.LocalizedTextUtil;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.apache.struts2.dispatcher.Parameter;
+import org.apache.struts2.dispatcher.HttpParameters;
 
 import java.util.Arrays;
 import java.util.Locale;
@@ -167,7 +169,7 @@ protected Locale storeLocale(ActionInvocation invocation, Locale locale, String
 
     protected class LocaleFinder {
         protected String storage = Storage.SESSION.toString();
-        protected Object requestedLocale = null;
+        protected Parameter requestedLocale = null;
 
         protected ActionInvocation actionInvocation = null;
 
@@ -178,17 +180,17 @@ protected LocaleFinder(ActionInvocation invocation) {
 
         protected void find() {
             //get requested locale
-            Map<String, Object> params = actionInvocation.getInvocationContext().getParameters();
+            HttpParameters params = actionInvocation.getInvocationContext().getParameters();
 
             storage = Storage.SESSION.toString();
 
             requestedLocale = findLocaleParameter(params, parameterName);
-            if (requestedLocale != null) {
+            if (requestedLocale.isDefined()) {
                 return;
             }
 
             requestedLocale = findLocaleParameter(params, requestOnlyParameterName);
-            if (requestedLocale != null) {
+            if (requestedLocale.isDefined()) {
                 storage = Storage.NONE.toString();
             }
         }
@@ -197,8 +199,8 @@ public String getStorage() {
             return storage;
         }
 
-        public Object getRequestedLocale() {
-            return requestedLocale;
+        public String getRequestedLocale() {
+            return requestedLocale.getValue();
         }
     }
 
@@ -264,13 +266,11 @@ protected Locale readStoredLocalFromCurrentInvocation(ActionInvocation invocatio
         return locale;
     }
 
-    protected Object findLocaleParameter(Map<String, Object> params, String parameterName) {
-        Object requestedLocale = params.remove(parameterName);
-        if (requestedLocale != null && requestedLocale.getClass().isArray()
-                && ((Object[]) requestedLocale).length > 0) {
-            requestedLocale = ((Object[]) requestedLocale)[0];
-
-            LOG.debug("Requested locale: {}", requestedLocale);
+    protected Parameter findLocaleParameter(HttpParameters params, String parameterName) {
+        Parameter requestedLocale = params.get(parameterName);
+        params.remove(parameterName);
+        if (requestedLocale.isDefined()) {
+            LOG.debug("Requested locale: {}", requestedLocale.getValue());
         }
         return requestedLocale;
     }

core/src/main/java/com/opensymphony/xwork2/interceptor/ParameterFilterInterceptor.java

@@ -20,6 +20,7 @@
 import org.apache.commons.lang3.StringUtils;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.apache.struts2.dispatcher.HttpParameters;
 
 import java.util.Collection;
 import java.util.HashSet;
@@ -107,31 +108,27 @@ public class ParameterFilterInterceptor extends AbstractInterceptor {
     @Override
     public String intercept(ActionInvocation invocation) throws Exception {
 
-        Map<String, Object> parameters = invocation.getInvocationContext().getParameters();
-        HashSet<String> paramsToRemove = new HashSet<>();
+        HttpParameters parameters = invocation.getInvocationContext().getParameters();
 
         Map<String, Boolean> includesExcludesMap = getIncludesExcludesMap();
 
-        for (String param : parameters.keySet()) {
+        for (String param : parameters.getNames()) {
             boolean currentAllowed = !isDefaultBlock();
 
             for (String currRule : includesExcludesMap.keySet()) {
-                if (param.startsWith(currRule)
-                        && (param.length() == currRule.length()
-                        || isPropertySeparator(param.charAt(currRule.length())))) {
-                    currentAllowed = includesExcludesMap.get(currRule).booleanValue();
+                if (param.startsWith(currRule) &&
+                    (param.length() == currRule.length() || isPropertySeparator(param.charAt(currRule.length())))
+                ) {
+                    currentAllowed = includesExcludesMap.get(currRule);
                 }
             }
             if (!currentAllowed) {
-                paramsToRemove.add(param);
+                LOG.debug("Removing param: {}", param);
+                parameters = parameters.remove(param);
             }
         }
 
-        LOG.debug("Params to remove: {}", paramsToRemove);
-
-        for (Object aParamsToRemove : paramsToRemove) {
-            parameters.remove(aParamsToRemove);
-        }
+        invocation.getInvocationContext().setParameters(parameters);
 
         return invocation.invoke();
     }
@@ -142,7 +139,7 @@ public String intercept(ActionInvocation invocation) throws Exception {
      * @param c the char
      * @return <tt>true</tt>, if char is property separator, <tt>false</tt> otherwise.
      */
-    private static boolean isPropertySeparator(char c) {
+    private boolean isPropertySeparator(char c) {
         return c == '.' || c == '(' || c == '[';
     }
 

core/src/main/java/com/opensymphony/xwork2/interceptor/ParameterRemoverInterceptor.java

@@ -20,9 +20,10 @@
 import com.opensymphony.xwork2.util.TextParseUtil;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.apache.struts2.dispatcher.Parameter;
+import org.apache.struts2.dispatcher.HttpParameters;
 
 import java.util.Collections;
-import java.util.Map;
 import java.util.Set;
 
 /**
@@ -98,22 +99,17 @@ public String intercept(ActionInvocation invocation) throws Exception {
 		if (!(invocation.getAction() instanceof NoParameters)
 				&& (null != this.paramNames)) {
 			ActionContext ac = invocation.getInvocationContext();
-			final Map<String, Object> parameters = ac.getParameters();
+			HttpParameters parameters = ac.getParameters();
 
 			if (parameters != null) {
                 for (String removeName : paramNames) {
-                    // see if the field is in the parameter map
-                    if (parameters.containsKey(removeName)) {
-
-                        try {
-							String[] values = (String[]) parameters.get(removeName);
-							String value = values[0];
-							if (null != value && this.paramValues.contains(value)) {
-                                parameters.remove(removeName);
-                            }
-                        } catch (Exception e) {
-							LOG.error("Failed to convert parameter to string", e);
+					try {
+						Parameter parameter = parameters.get(removeName);
+						if (parameter.isDefined() && this.paramValues.contains(parameter.getValue())) {
+							parameters.remove(removeName);
 						}
+					} catch (Exception e) {
+						LOG.error("Failed to convert parameter to string", e);
 					}
                 }
 			}

core/src/main/java/com/opensymphony/xwork2/interceptor/ParametersInterceptor.java

@@ -18,8 +18,6 @@
 import com.opensymphony.xwork2.ActionContext;
 import com.opensymphony.xwork2.ActionInvocation;
 import com.opensymphony.xwork2.XWorkConstants;
-import com.opensymphony.xwork2.conversion.impl.InstantiatingNullHandler;
-import com.opensymphony.xwork2.conversion.impl.XWorkConverter;
 import com.opensymphony.xwork2.inject.Inject;
 import com.opensymphony.xwork2.security.AcceptedPatternsChecker;
 import com.opensymphony.xwork2.security.ExcludedPatternsChecker;
@@ -28,6 +26,8 @@
 import org.apache.commons.lang3.BooleanUtils;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.apache.struts2.dispatcher.Parameter;
+import org.apache.struts2.dispatcher.HttpParameters;
 
 import java.util.Collection;
 import java.util.Comparator;
@@ -108,7 +108,7 @@ public String doIntercept(ActionInvocation invocation) throws Exception {
         Object action = invocation.getAction();
         if (!(action instanceof NoParameters)) {
             ActionContext ac = invocation.getInvocationContext();
-            final Map<String, Object> parameters = retrieveParameters(ac);
+            HttpParameters parameters = retrieveParameters(ac);
 
             if (LOG.isDebugEnabled()) {
                 LOG.debug("Setting params {}", getParameterLogMap(parameters));
@@ -139,7 +139,7 @@ public String doIntercept(ActionInvocation invocation) throws Exception {
      * @param ac The action context
      * @return The parameter map to apply
      */
-    protected Map<String, Object> retrieveParameters(ActionContext ac) {
+    protected HttpParameters retrieveParameters(ActionContext ac) {
         return ac.getParameters();
     }
 
@@ -154,26 +154,24 @@ protected Map<String, Object> retrieveParameters(ActionContext ac) {
      *                  In subclasses both retrieveParameters() and addParametersToContext() should be overridden.
      *                  </p>
      */
-    protected void addParametersToContext(ActionContext ac, Map<String, Object> newParams) {
+    protected void addParametersToContext(ActionContext ac, Map<String, ?> newParams) {
     }
 
-    protected void setParameters(final Object action, ValueStack stack, final Map<String, Object> parameters) {
-        Map<String, Object> params;
-        Map<String, Object> acceptableParameters;
+    protected void setParameters(final Object action, ValueStack stack, HttpParameters parameters) {
+        HttpParameters params;
+        Map<String, Parameter> acceptableParameters;
         if (ordered) {
-            params = new TreeMap<>(getOrderedComparator());
+            params = HttpParameters.createEmpty().withComparator(getOrderedComparator()).withParent(parameters).build();
             acceptableParameters = new TreeMap<>(getOrderedComparator());
-            params.putAll(parameters);
         } else {
-            params = new TreeMap<>(parameters);
+            params = HttpParameters.createEmpty().withParent(parameters).build();
             acceptableParameters = new TreeMap<>();
         }
 
-        for (Map.Entry<String, Object> entry : params.entrySet()) {
-            String name = entry.getKey();
-            Object value = entry.getValue();
+        for (String name : params.getNames()) {
+            Parameter parameter = params.get(name);
             if (isAcceptableParameter(name, action)) {
-                acceptableParameters.put(name, entry.getValue());
+                acceptableParameters.put(name, parameter);
             }
         }
 
@@ -201,11 +199,11 @@ protected void setParameters(final Object action, ValueStack stack, final Map<St
             accessValueStack.setExcludeProperties(excludedPatterns.getExcludedPatterns());
         }
 
-        for (Map.Entry<String, Object> entry : acceptableParameters.entrySet()) {
+        for (Map.Entry<String, Parameter> entry : acceptableParameters.entrySet()) {
             String name = entry.getKey();
-            Object value = entry.getValue();
+            Parameter value = entry.getValue();
             try {
-                newStack.setParameter(name, value);
+                newStack.setParameter(name, value.getValue());
             } catch (RuntimeException e) {
                 if (devMode) {
                     notifyDeveloperParameterException(action, name, e.getMessage());
@@ -258,30 +256,16 @@ protected Comparator<String> getOrderedComparator() {
         return rbCollator;
     }
 
-    protected String getParameterLogMap(Map<String, Object> parameters) {
+    protected String getParameterLogMap(HttpParameters parameters) {
         if (parameters == null) {
             return "NONE";
         }
 
         StringBuilder logEntry = new StringBuilder();
-        for (Map.Entry entry : parameters.entrySet()) {
-            logEntry.append(String.valueOf(entry.getKey()));
+        for (String name : parameters.getNames()) {
+            logEntry.append(String.valueOf(name));
             logEntry.append(" => ");
-            if (entry.getValue() instanceof Object[]) {
-                Object[] valueArray = (Object[]) entry.getValue();
-                logEntry.append("[ ");
-                if (valueArray.length > 0 ) {
-                    for (int indexA = 0; indexA < (valueArray.length - 1); indexA++) {
-                        Object valueAtIndex = valueArray[indexA];
-                        logEntry.append(String.valueOf(valueAtIndex));
-                        logEntry.append(", ");
-                    }
-                    logEntry.append(String.valueOf(valueArray[valueArray.length - 1]));
-                }
-                logEntry.append(" ] ");
-            } else {
-                logEntry.append(String.valueOf(entry.getValue()));
-            }
+            logEntry.append(parameters.get(name).getValue());
         }
 
         return logEntry.toString();