Skip to content

Commit

Permalink
Makes HttpParameters case-insensitive
Browse files Browse the repository at this point in the history
  • Loading branch information
lukaszlenart committed Dec 4, 2023
1 parent 236ae15 commit d8c6969
Show file tree
Hide file tree
Showing 2 changed files with 88 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,15 @@
import java.util.TreeSet;

@SuppressWarnings("unchecked")
public class HttpParameters implements Map<String, Parameter>, Cloneable {
public class HttpParameters implements Map<String, Parameter> {

final private Map<String, Parameter> parameters;

private HttpParameters(Map<String, Parameter> parameters) {
this.parameters = parameters;
}

@SuppressWarnings("rawtypes")
public static Builder create(Map requestParameterMap) {
return new Builder(requestParameterMap);
}
Expand All @@ -47,7 +48,7 @@ public static Builder create() {

public HttpParameters remove(Set<String> paramsToRemove) {
for (String paramName : paramsToRemove) {
parameters.remove(paramName);
parameters.entrySet().removeIf(p -> p.getKey().equalsIgnoreCase(paramName));
}
return this;
}
Expand All @@ -59,12 +60,15 @@ public HttpParameters remove(final String paramToRemove) {
}

public boolean contains(String name) {
return parameters.containsKey(name);
return parameters.keySet().stream().anyMatch(p -> p.equalsIgnoreCase(name));
}

/**
* Access to this method can be potentially dangerous as it allows access to raw parameter values.
*
* @deprecated since 6.4.0, it will be removed with a new major release
*/
@Deprecated
private Map<String, String[]> toMap() {
final Map<String, String[]> result = new HashMap<>(parameters.size());
for (Map.Entry<String, Parameter> entry : parameters.entrySet()) {
Expand All @@ -73,7 +77,14 @@ private Map<String, String[]> toMap() {
return result;
}

/**
* Appends all the parameters by overriding any existing params in a case-insensitive manner
*
* @param newParams A new params to append
* @return a current instance of {@link HttpParameters}
*/
public HttpParameters appendAll(Map<String, Parameter> newParams) {
remove(newParams.keySet());
parameters.putAll(newParams);
return this;
}
Expand All @@ -100,8 +111,11 @@ public boolean containsValue(Object value) {

@Override
public Parameter get(Object key) {
if (parameters.containsKey(key)) {
return parameters.get(key);
if (key != null && contains(String.valueOf(key))) {
return parameters.entrySet().stream()
.filter(p -> p.getKey().equalsIgnoreCase(String.valueOf(key)))
.findFirst().map(Entry::getValue)
.orElse(new Parameter.Empty(String.valueOf(key)));
} else {
return new Parameter.Empty(String.valueOf(key));
}
Expand Down Expand Up @@ -177,8 +191,8 @@ public Builder withComparator(Comparator<String> orderedComparator) {

public HttpParameters build() {
Map<String, Parameter> parameters = (parent == null)
? new HashMap<>()
: new HashMap<>(parent.parameters);
? new HashMap<>()
: new HashMap<>(parent.parameters);

for (Map.Entry<String, Object> entry : requestParameterMap.entrySet()) {
String name = entry.getKey();
Expand All @@ -197,8 +211,9 @@ public HttpParameters build() {
* Alternate Builder method which avoids wrapping any parameters that are already
* a {@link Parameter} element within another {@link Parameter} wrapper.
*
* @return
* @deprecated since 6.4.0, use {@link #build()} instead
*/
@Deprecated
public HttpParameters buildNoNestedWrapping() {
Map<String, Parameter> parameters = (parent == null)
? new HashMap<>()
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.struts2.dispatcher;

import org.junit.Test;

import java.util.HashMap;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;

public class HttpParametersTest {

@Test
public void shouldGetBeCaseInsensitive() {
// given
HttpParameters params = HttpParameters.create(new HashMap<String, Object>() {{
put("param1", "value1");
}}).build();

// then
assertEquals("value1", params.get("Param1").getValue());
assertEquals("value1", params.get("paraM1").getValue());
assertEquals("value1", params.get("pAraM1").getValue());
}

@Test
public void shouldAppendSameParamsIgnoringCase() {
// given
HttpParameters params = HttpParameters.create(new HashMap<String, Object>() {{
put("param1", "value1");
}}).build();

// when
assertEquals("value1", params.get("param1").getValue());

params = params.appendAll(HttpParameters.create(new HashMap<String, String>() {{
put("Param1", "Value1");
}}).build());

// then
assertTrue(params.contains("param1"));
assertTrue(params.contains("Param1"));

assertEquals("Value1", params.get("param1").getValue());
assertEquals("Value1", params.get("Param1").getValue());
}

}

0 comments on commit d8c6969

Please sign in to comment.