JERSEY-2656: Form parameters without equal sign are processed with Null value

Change-Id: I99357c3b03dcc27282901a274a8b3fd8eb6e8eec

Author: Petr Bouda

core-common/src/main/java/org/glassfish/jersey/internal/util/collection/NullableMultivaluedHashMap.java

@@ -0,0 +1,82 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved.
+ *
+ * The contents of this file are subject to the terms of either the GNU
+ * General Public License Version 2 only ("GPL") or the Common Development
+ * and Distribution License("CDDL") (collectively, the "License").  You
+ * may not use this file except in compliance with the License.  You can
+ * obtain a copy of the License at
+ * http://glassfish.java.net/public/CDDL+GPL_1_1.html
+ * or packager/legal/LICENSE.txt.  See the License for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing the software, include this License Header Notice in each
+ * file and include the License file at packager/legal/LICENSE.txt.
+ *
+ * GPL Classpath Exception:
+ * Oracle designates this particular file as subject to the "Classpath"
+ * exception as provided by Oracle in the GPL Version 2 section of the License
+ * file that accompanied this code.
+ *
+ * Modifications:
+ * If applicable, add the following below the License Header, with the fields
+ * enclosed by brackets [] replaced by your own identifying information:
+ * "Portions Copyright [year] [name of copyright owner]"
+ *
+ * Contributor(s):
+ * If you wish your version of this file to be governed by only the CDDL or
+ * only the GPL Version 2, indicate your decision by adding "[Contributor]
+ * elects to include this software in this distribution under the [CDDL or GPL
+ * Version 2] license."  If you don't indicate a single choice of license, a
+ * recipient has the option to distribute your version of this file under
+ * either the CDDL, the GPL Version 2 or to extend the choice of license to
+ * its licensees as provided above.  However, if you add GPL Version 2 code
+ * and therefore, elected the GPL Version 2 license, then the option applies
+ * only if the new code is made subject to such option by the copyright
+ * holder.
+ */
+package org.glassfish.jersey.internal.util.collection;
+
+import java.util.List;
+
+import javax.ws.rs.core.MultivaluedHashMap;
+import javax.ws.rs.core.MultivaluedMap;
+
+/**
+ * An implementation of {@link MultivaluedMap} where values can be {@code null}.
+ *
+ * @param <K> the type of keys maintained by this map
+ * @param <V> the type of mapped values which can contain {@code null} values
+ *
+ * @author Petr Bouda (petr.bouda at oracle.com)
+ */
+public class NullableMultivaluedHashMap<K, V> extends MultivaluedHashMap<K, V> {
+
+    public NullableMultivaluedHashMap() {
+        super();
+    }
+
+    public NullableMultivaluedHashMap(int initialCapacity) {
+        super(initialCapacity);
+    }
+
+    public NullableMultivaluedHashMap(int initialCapacity, float loadFactor) {
+        super(initialCapacity, loadFactor);
+    }
+
+    public NullableMultivaluedHashMap(MultivaluedMap<? extends K, ? extends V> map) {
+        super(map);
+    }
+
+    @Override
+    protected void addFirstNull(final List<V> values) {
+        values.add(null);
+    }
+
+    @Override
+    protected void addNull(final List<V> values) {
+        values.add(null);
+    }
+}

core-common/src/main/java/org/glassfish/jersey/message/internal/FormMultivaluedMapProvider.java

@@ -1,7 +1,7 @@
 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
- * Copyright (c) 2010-2012 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2010-2015 Oracle and/or its affiliates. All rights reserved.
  *
  * The contents of this file are subject to the terms of either the GNU
  * General Public License Version 2 only ("GPL") or the Common Development
@@ -49,11 +49,12 @@
 import javax.ws.rs.Consumes;
 import javax.ws.rs.Produces;
 import javax.ws.rs.core.MediaType;
-import javax.ws.rs.core.MultivaluedHashMap;
 import javax.ws.rs.core.MultivaluedMap;
 
 import javax.inject.Singleton;
 
+import org.glassfish.jersey.internal.util.collection.NullableMultivaluedHashMap;
+
 /**
  * Provider for marshalling/un-marshalling of {@code application/x-www-form-urlencoded}
  * entity type to/from {@link MultivaluedMap multi-valued map} instance.
@@ -88,7 +89,7 @@ public MultivaluedMap<String, String> readFrom(
             MediaType mediaType,
             MultivaluedMap<String, String> httpHeaders,
             InputStream entityStream) throws IOException {
-        return readFrom(new MultivaluedHashMap<String, String>(), mediaType, true, entityStream);
+        return readFrom(new NullableMultivaluedHashMap<String, String>(), mediaType, true, entityStream);
     }
 
     @Override
@@ -107,4 +108,4 @@ public void writeTo(
             OutputStream entityStream) throws IOException {
         writeTo(t, mediaType, entityStream);
     }
-}
+}

core-common/src/main/java/org/glassfish/jersey/message/internal/FormProvider.java

@@ -1,7 +1,7 @@
 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
- * Copyright (c) 2010-2012 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2010-2015 Oracle and/or its affiliates. All rights reserved.
  *
  * The contents of this file are subject to the terms of either the GNU
  * General Public License Version 2 only ("GPL") or the Common Development
@@ -50,11 +50,12 @@
 import javax.ws.rs.Produces;
 import javax.ws.rs.core.Form;
 import javax.ws.rs.core.MediaType;
-import javax.ws.rs.core.MultivaluedHashMap;
 import javax.ws.rs.core.MultivaluedMap;
 
 import javax.inject.Singleton;
 
+import org.glassfish.jersey.internal.util.collection.NullableMultivaluedHashMap;
+
 /**
  * Provider for marshalling/un-marshalling of {@code application/x-www-form-urlencoded}
  * entity type to/from {@link Form JAX-RS Form} instance.
@@ -81,7 +82,7 @@ public Form readFrom(
             MultivaluedMap<String, String> httpHeaders,
             InputStream entityStream) throws IOException {
 
-        return new Form(readFrom(new MultivaluedHashMap<String, String>(), mediaType, decode(annotations), entityStream));
+        return new Form(readFrom(new NullableMultivaluedHashMap<String, String>(), mediaType, decode(annotations), entityStream));
     }
 
 
@@ -110,4 +111,4 @@ public void writeTo(
             OutputStream entityStream) throws IOException {
         writeTo(t.asMap(), mediaType, entityStream);
     }
-}
+}

core-common/src/test/java/org/glassfish/jersey/message/internal/FormMultivaluedMapProviderTest.java

@@ -0,0 +1,103 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved.
+ *
+ * The contents of this file are subject to the terms of either the GNU
+ * General Public License Version 2 only ("GPL") or the Common Development
+ * and Distribution License("CDDL") (collectively, the "License").  You
+ * may not use this file except in compliance with the License.  You can
+ * obtain a copy of the License at
+ * http://glassfish.java.net/public/CDDL+GPL_1_1.html
+ * or packager/legal/LICENSE.txt.  See the License for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing the software, include this License Header Notice in each
+ * file and include the License file at packager/legal/LICENSE.txt.
+ *
+ * GPL Classpath Exception:
+ * Oracle designates this particular file as subject to the "Classpath"
+ * exception as provided by Oracle in the GPL Version 2 section of the License
+ * file that accompanied this code.
+ *
+ * Modifications:
+ * If applicable, add the following below the License Header, with the fields
+ * enclosed by brackets [] replaced by your own identifying information:
+ * "Portions Copyright [year] [name of copyright owner]"
+ *
+ * Contributor(s):
+ * If you wish your version of this file to be governed by only the CDDL or
+ * only the GPL Version 2, indicate your decision by adding "[Contributor]
+ * elects to include this software in this distribution under the [CDDL or GPL
+ * Version 2] license."  If you don't indicate a single choice of license, a
+ * recipient has the option to distribute your version of this file under
+ * either the CDDL, the GPL Version 2 or to extend the choice of license to
+ * its licensees as provided above.  However, if you add GPL Version 2 code
+ * and therefore, elected the GPL Version 2 license, then the option applies
+ * only if the new code is made subject to such option by the copyright
+ * holder.
+ */
+package org.glassfish.jersey.message.internal;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.lang.annotation.Annotation;
+import java.nio.charset.StandardCharsets;
+import java.util.List;
+
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.MultivaluedHashMap;
+import javax.ws.rs.core.MultivaluedMap;
+
+import org.junit.Test;
+
+import static junit.framework.Assert.assertEquals;
+import static junit.framework.Assert.assertNull;
+
+/**
+ * {@link FormProvider} unit tests
+ *
+ * @author Petr Bouda (petr.bouda at oracle.com)
+ */
+public class FormMultivaluedMapProviderTest {
+
+    private static final FormMultivaluedMapProvider PROVIDER = new FormMultivaluedMapProvider();
+
+    @Test
+    public void testReadFormParam() {
+        MultivaluedMap<String, String> map = readFrom("name&age=26");
+        assertEquals(2, map.size());
+
+        List<String> nameEntry = map.get("name");
+        assertEquals(1, nameEntry.size());
+        assertNull(nameEntry.get(0));
+
+        List<String> ageEntry = map.get("age");
+        assertEquals(1, ageEntry.size());
+        assertEquals("26", ageEntry.get(0));
+    }
+
+    @Test
+    public void testReadMultipleSameFormParam() {
+        MultivaluedMap<String, String> map = readFrom("name&name=George");
+        assertEquals(1, map.size());
+
+        List<String> nameEntry = map.get("name");
+        assertEquals(2, nameEntry.size());
+        assertNull(nameEntry.get(0));
+        assertEquals("George", nameEntry.get(1));
+    }
+
+    @SuppressWarnings("unchecked")
+    private static MultivaluedMap<String, String> readFrom(String body) {
+        try {
+            InputStream stream = new ByteArrayInputStream(body.getBytes(StandardCharsets.UTF_8));
+            Class<MultivaluedMap<String, String>> clazz =
+                    (Class<MultivaluedMap<String, String>>) (Class<?>) MultivaluedHashMap.class;
+            return PROVIDER.readFrom(clazz, clazz, new Annotation[] {}, MediaType.APPLICATION_FORM_URLENCODED_TYPE, null, stream);
+        } catch (IOException e) {
+            throw new RuntimeException("Unexpected exception", e);
+        }
+    }
+}

core-common/src/test/java/org/glassfish/jersey/message/internal/FormProviderTest.java

@@ -0,0 +1,103 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved.
+ *
+ * The contents of this file are subject to the terms of either the GNU
+ * General Public License Version 2 only ("GPL") or the Common Development
+ * and Distribution License("CDDL") (collectively, the "License").  You
+ * may not use this file except in compliance with the License.  You can
+ * obtain a copy of the License at
+ * http://glassfish.java.net/public/CDDL+GPL_1_1.html
+ * or packager/legal/LICENSE.txt.  See the License for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing the software, include this License Header Notice in each
+ * file and include the License file at packager/legal/LICENSE.txt.
+ *
+ * GPL Classpath Exception:
+ * Oracle designates this particular file as subject to the "Classpath"
+ * exception as provided by Oracle in the GPL Version 2 section of the License
+ * file that accompanied this code.
+ *
+ * Modifications:
+ * If applicable, add the following below the License Header, with the fields
+ * enclosed by brackets [] replaced by your own identifying information:
+ * "Portions Copyright [year] [name of copyright owner]"
+ *
+ * Contributor(s):
+ * If you wish your version of this file to be governed by only the CDDL or
+ * only the GPL Version 2, indicate your decision by adding "[Contributor]
+ * elects to include this software in this distribution under the [CDDL or GPL
+ * Version 2] license."  If you don't indicate a single choice of license, a
+ * recipient has the option to distribute your version of this file under
+ * either the CDDL, the GPL Version 2 or to extend the choice of license to
+ * its licensees as provided above.  However, if you add GPL Version 2 code
+ * and therefore, elected the GPL Version 2 license, then the option applies
+ * only if the new code is made subject to such option by the copyright
+ * holder.
+ */
+package org.glassfish.jersey.message.internal;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.lang.annotation.Annotation;
+import java.nio.charset.StandardCharsets;
+import java.util.List;
+
+import javax.ws.rs.core.Form;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.MultivaluedMap;
+
+import org.junit.Test;
+
+import static junit.framework.Assert.assertEquals;
+import static junit.framework.Assert.assertNull;
+
+/**
+ * {@link FormProvider} unit tests
+ *
+ * @author Petr Bouda (petr.bouda at oracle.com)
+ */
+public class FormProviderTest {
+
+    private static final FormProvider PROVIDER = new FormProvider();
+
+    @Test
+    public void testReadFormParam() {
+        Form form = readFrom("name&age=26");
+        MultivaluedMap<String, String> map = form.asMap();
+        assertEquals(2, map.size());
+
+        List<String> nameEntry = map.get("name");
+        assertEquals(1, nameEntry.size());
+        assertNull(nameEntry.get(0));
+
+        List<String> ageEntry = map.get("age");
+        assertEquals(1, ageEntry.size());
+        assertEquals("26", ageEntry.get(0));
+    }
+
+    @Test
+    public void testReadMultipleSameFormParam() {
+        Form form = readFrom("name&name=George");
+        MultivaluedMap<String, String> map = form.asMap();
+        assertEquals(1, map.size());
+
+        List<String> nameEntry = map.get("name");
+        assertEquals(2, nameEntry.size());
+        assertNull(nameEntry.get(0));
+        assertEquals("George", nameEntry.get(1));
+    }
+
+    private static Form readFrom(String body) {
+        try {
+            InputStream stream = new ByteArrayInputStream(body.getBytes(StandardCharsets.UTF_8));
+            return PROVIDER.readFrom(Form.class, Form.class, new Annotation[] {},
+                    MediaType.APPLICATION_FORM_URLENCODED_TYPE, null, stream);
+        } catch (IOException e) {
+            throw new RuntimeException("Unexpected exception", e);
+        }
+    }
+}