From 78ee4b8ba2f636ba8de9a49639d90b48251a0f1b Mon Sep 17 00:00:00 2001
From: Lukasz Lenart <lukaszlenart@apache.org>
Date: Wed, 11 Apr 2012 17:41:06 +0000
Subject: [PATCH] WW-3796 Changes logic to set encoding on HttpServletRequest
 if differs from configured

git-svn-id: https://svn.apache.org/repos/asf/struts/struts2/trunk@1324888 13f79535-47bb-0310-9956-ffa450edef68
---
 .../apache/struts2/dispatcher/Dispatcher.java | 18 +++++++---
 .../struts2/dispatcher/DispatcherTest.java    | 35 ++++++++++++++++---
 2 files changed, 43 insertions(+), 10 deletions(-)

diff --git a/core/src/main/java/org/apache/struts2/dispatcher/Dispatcher.java b/core/src/main/java/org/apache/struts2/dispatcher/Dispatcher.java
index d56a140a2..d54060e68 100644
--- a/core/src/main/java/org/apache/struts2/dispatcher/Dispatcher.java
+++ b/core/src/main/java/org/apache/struts2/dispatcher/Dispatcher.java
@@ -690,11 +690,7 @@ public class Dispatcher {
         }
 
         if (encoding != null) {
-            try {
-                request.setCharacterEncoding(encoding);
-            } catch (Exception e) {
-                LOG.error("Error setting character encoding to '" + encoding + "' - ignoring.", e);
-            }
+            applyEncoding(request, encoding);
         }
 
         if (locale != null) {
@@ -706,6 +702,18 @@ public class Dispatcher {
         }
     }
 
+    private void applyEncoding(HttpServletRequest request, String encoding) {
+        try {
+            if (!encoding.equals(request.getCharacterEncoding())) {
+                // if the encoding is already correctly set and the parameters have been already read
+                // do not try to set encoding because it is useless and will cause an error
+                request.setCharacterEncoding(encoding);
+            }
+        } catch (Exception e) {
+            LOG.error("Error setting character encoding to '" + encoding + "' - ignoring.", e);
+        }
+    }
+
     /**
      * Wrap and return the given request or return the original request object.
      * </p>
diff --git a/core/src/test/java/org/apache/struts2/dispatcher/DispatcherTest.java b/core/src/test/java/org/apache/struts2/dispatcher/DispatcherTest.java
index fd6b4dcc3..61ea8779a 100644
--- a/core/src/test/java/org/apache/struts2/dispatcher/DispatcherTest.java
+++ b/core/src/test/java/org/apache/struts2/dispatcher/DispatcherTest.java
@@ -70,7 +70,7 @@ public class DispatcherTest extends StrutsTestCase {
         HttpServletRequest req = new MockHttpServletRequest();
         HttpServletResponse res = new MockHttpServletResponse();
 
-        Dispatcher du = initDispatcher(new HashMap() {{
+        Dispatcher du = initDispatcher(new HashMap<String, String>() {{
             put(StrutsConstants.STRUTS_I18N_ENCODING, "utf-8");
         }});
         du.prepare(req, res);
@@ -82,9 +82,10 @@ public class DispatcherTest extends StrutsTestCase {
         // given
         MockHttpServletRequest req = new MockHttpServletRequest();
         req.addHeader("X-Requested-With", "XMLHttpRequest");
+        req.setCharacterEncoding("utf-8");
         HttpServletResponse res = new MockHttpServletResponse();
 
-        Dispatcher du = initDispatcher(new HashMap() {{
+        Dispatcher du = initDispatcher(new HashMap<String, String>() {{
             put(StrutsConstants.STRUTS_I18N_ENCODING, "latin-2");
         }});
 
@@ -95,12 +96,36 @@ public class DispatcherTest extends StrutsTestCase {
         assertEquals(req.getCharacterEncoding(), "utf-8");
     }
 
+    public void testSetEncodingIfDiffer() throws Exception {
+        // given
+        Mock mock = new Mock(HttpServletRequest.class);
+        mock.expectAndReturn("getCharacterEncoding", "utf-8");
+        mock.expectAndReturn("getHeader", "X-Requested-With", "");
+        mock.expectAndReturn("getLocale", Locale.getDefault());
+        mock.expectAndReturn("getCharacterEncoding", "utf-8");
+        HttpServletRequest req = (HttpServletRequest) mock.proxy();
+        HttpServletResponse res = new MockHttpServletResponse();
+
+        Dispatcher du = initDispatcher(new HashMap<String, String>() {{
+            put(StrutsConstants.STRUTS_I18N_ENCODING, "utf-8");
+        }});
+
+
+        // when
+        du.prepare(req, res);
+
+        // then
+
+        assertEquals(req.getCharacterEncoding(), "utf-8");
+        mock.verify();
+    }
+
     public void testPrepareSetEncodingPropertyWithMultipartRequest() throws Exception {
         MockHttpServletRequest req = new MockHttpServletRequest();
         MockHttpServletResponse res = new MockHttpServletResponse();
 
         req.setContentType("multipart/form-data");
-        Dispatcher du = initDispatcher(new HashMap() {{
+        Dispatcher du = initDispatcher(new HashMap<String, String>() {{
             put(StrutsConstants.STRUTS_I18N_ENCODING, "utf-8");
         }});
         du.prepare(req, res);
@@ -136,7 +161,7 @@ public class DispatcherTest extends StrutsTestCase {
     
     
     public void testConfigurationManager() {
-    	Dispatcher du = null;
+    	Dispatcher du;
     	InternalConfigurationManager configurationManager = new InternalConfigurationManager();
     	try {
     		du = new Dispatcher(new MockServletContext(), new HashMap<String, String>());
@@ -154,7 +179,7 @@ public class DispatcherTest extends StrutsTestCase {
             
     	}
     	finally {
-    		du.setInstance(null);
+    		Dispatcher.setInstance(null);
     	}
     }