You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by bd...@apache.org on 2015/05/22 13:45:54 UTC
svn commit: r1681080 - in /sling/trunk/contrib/extensions/bgservlets: pom.xml
src/main/java/org/apache/sling/bgservlets/BackgroundHttpServletRequest.java
src/test/java/org/apache/sling/bgservlets/QueryStringFilterTest.java
Author: bdelacretaz
Date: Fri May 22 11:45:53 2015
New Revision: 1681080
URL: http://svn.apache.org/r1681080
Log:
SLING-4740 - filter query string in BackgroundHttpServletRequest
Added:
sling/trunk/contrib/extensions/bgservlets/src/test/java/org/apache/sling/bgservlets/QueryStringFilterTest.java
Modified:
sling/trunk/contrib/extensions/bgservlets/pom.xml
sling/trunk/contrib/extensions/bgservlets/src/main/java/org/apache/sling/bgservlets/BackgroundHttpServletRequest.java
Modified: sling/trunk/contrib/extensions/bgservlets/pom.xml
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/bgservlets/pom.xml?rev=1681080&r1=1681079&r2=1681080&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/bgservlets/pom.xml (original)
+++ sling/trunk/contrib/extensions/bgservlets/pom.xml Fri May 22 11:45:53 2015
@@ -124,6 +124,12 @@
<version>3.0.0</version>
</dependency>
<dependency>
+ <groupId>org.mockito</groupId>
+ <artifactId>mockito-core</artifactId>
+ <version>1.9.5</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<scope>test</scope>
Modified: sling/trunk/contrib/extensions/bgservlets/src/main/java/org/apache/sling/bgservlets/BackgroundHttpServletRequest.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/bgservlets/src/main/java/org/apache/sling/bgservlets/BackgroundHttpServletRequest.java?rev=1681080&r1=1681079&r2=1681080&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/bgservlets/src/main/java/org/apache/sling/bgservlets/BackgroundHttpServletRequest.java (original)
+++ sling/trunk/contrib/extensions/bgservlets/src/main/java/org/apache/sling/bgservlets/BackgroundHttpServletRequest.java Fri May 22 11:45:53 2015
@@ -19,6 +19,7 @@
package org.apache.sling.bgservlets;
import java.io.BufferedReader;
+
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
@@ -36,9 +37,14 @@ import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
/** Minimal HttpServletRequest for background processing */
public class BackgroundHttpServletRequest implements HttpServletRequest {
+ private static final Logger log = LoggerFactory.getLogger(BackgroundHttpServletRequest.class);
+
private final String contextPath;
private final String method;
private final String pathInfo;
@@ -104,7 +110,7 @@ public class BackgroundHttpServletReques
method = r.getMethod();
pathInfo = r.getPathInfo();
servletPath = r.getServletPath();
- queryString = r.getQueryString();
+ queryString = filterQueryString(r.getQueryString(), parametersToRemove);
requestURI = r.getRequestURI();
requestURL = r.getRequestURL();
characterEncoding = r.getCharacterEncoding();
@@ -134,6 +140,32 @@ public class BackgroundHttpServletReques
parameters.remove(key);
}
}
+
+ private String filterQueryString(String original, String [] parametersToRemove) {
+ if(original == null) {
+ return null;
+ }
+
+ final StringBuilder sb = new StringBuilder(original.length());
+ final String SEP = "&";
+ final String [] params = original.split(SEP);
+ for(String param : params) {
+ final String name = param.split("=")[0].trim();
+ boolean ignore = false;
+ for(String p : parametersToRemove) {
+ if(name.equals(p)) {
+ ignore=true;
+ break;
+ }
+ }
+ if(!ignore) {
+ sb.append(param).append(SEP);
+ }
+ }
+ final String result = sb.toString();
+ log.debug("Filtered query string to '{}'", result);
+ return result;
+ }
public String getAuthType() {
return null;
Added: sling/trunk/contrib/extensions/bgservlets/src/test/java/org/apache/sling/bgservlets/QueryStringFilterTest.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/bgservlets/src/test/java/org/apache/sling/bgservlets/QueryStringFilterTest.java?rev=1681080&view=auto
==============================================================================
--- sling/trunk/contrib/extensions/bgservlets/src/test/java/org/apache/sling/bgservlets/QueryStringFilterTest.java (added)
+++ sling/trunk/contrib/extensions/bgservlets/src/test/java/org/apache/sling/bgservlets/QueryStringFilterTest.java Fri May 22 11:45:53 2015
@@ -0,0 +1,74 @@
+/*
+ * 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.sling.bgservlets;
+
+import java.util.Arrays;
+
+import javax.servlet.http.HttpServletRequest;
+
+import static org.junit.Assert.assertEquals;
+import org.junit.Test;
+import org.mockito.Mockito;
+
+public class QueryStringFilterTest {
+
+ private void assertFilter(String [] toRemove, String orig, String expected) {
+ final HttpServletRequest mock = Mockito.mock(HttpServletRequest.class);
+ Mockito.when(mock.getQueryString()).thenReturn(orig);
+ final BackgroundHttpServletRequest r = new BackgroundHttpServletRequest(mock, toRemove);
+ final String result = r.getQueryString();
+ assertEquals("Expecting correct queryString after removal of " + Arrays.asList(toRemove), expected, result);
+
+ }
+
+ @Test
+ public void testNothingToRemove() {
+ final String [] toRemove = {};
+ assertFilter(toRemove, null, null);
+ assertFilter(toRemove, "sling:bg=true", "sling:bg=true&");
+ assertFilter(toRemove, "a=b&sling:bg=true", "a=b&sling:bg=true&");
+ assertFilter(toRemove, "sling:bg=true&c=d", "sling:bg=true&c=d&");
+ assertFilter(toRemove, "a=b&sling:bg=true&c=d", "a=b&sling:bg=true&c=d&");
+ }
+
+ @Test
+ public void testRemoveOne() {
+ final String [] toRemove = { "sling:bg" };
+ assertFilter(toRemove, null, null);
+ assertFilter(toRemove, "sling:bg=true", "");
+ assertFilter(toRemove, "a=b&sling:bg=true", "a=b&");
+ assertFilter(toRemove, "sling:bg=true&c=d", "c=d&");
+ assertFilter(toRemove, "a=b&sling:bg=true&c=d", "a=b&c=d&");
+ assertFilter(toRemove, "a=b&sling:bg = true+with+spaces&c=d", "a=b&c=d&");
+ }
+
+ @Test
+ public void testRemoveTwo() {
+ final String [] toRemove = { "sling:bg", "some_other_param" };
+ assertFilter(toRemove, null, null);
+ assertFilter(toRemove, "sling:bg=true", "");
+ assertFilter(toRemove, "a=b&sling:bg=true", "a=b&");
+ assertFilter(toRemove, "sling:bg=true&c=d", "c=d&");
+ assertFilter(toRemove, "a=b&sling:bg=true&c=d", "a=b&c=d&");
+ assertFilter(toRemove, "a=b&sling:bg = true+with+spaces&c=d", "a=b&c=d&");
+ assertFilter(toRemove, "a=b&sling:bg = true+with+spaces&c=d&some_other_param=foo", "a=b&c=d&");
+ assertFilter(toRemove, "sling:bg=true&some_other_param=foo", "");
+ assertFilter(toRemove, "sling:bg=true&some_other_param=foo&", "");
+ }
+}