Merge pull request primefaces#3133 from jasonex7/button-params

Fixes primefaces#2749 - p:button does not use nested f:param when using href attribute

Author: tandraschko

src/main/java/org/primefaces/renderkit/CoreRenderer.java

@@ -96,6 +96,10 @@ protected String getResourceURL(FacesContext context, String value) {
         return ComponentUtils.getResourceURL(context, value);
     }
 
+    protected String getHrefURL(String baseUrl, Map<String, List<String>> params) {
+        return ComponentUtils.getHrefURL(baseUrl, params);
+    }
+    
     protected String getResourceRequestPath(FacesContext context, String resourceName) {
         Resource resource = context.getApplication().getResourceHandler().createResource(resourceName, "primefaces");
 

src/main/java/org/primefaces/renderkit/OutcomeTargetRenderer.java

@@ -165,7 +165,7 @@ protected String getTargetURL(FacesContext context, UIOutcomeTarget outcomeTarge
 
         String href = outcomeTarget.getHref();
         if (href != null) {
-            url = prependContextPathIfNecessary(context, href);
+            url = getHrefURL(prependContextPathIfNecessary(context, href), outcomeTarget.getParams());
         }
         else {
             NavigationCase navCase = findNavigationCase(context, outcomeTarget);

src/main/java/org/primefaces/util/ComponentUtils.java

@@ -291,6 +291,83 @@ else if (value.contains(ResourceHandler.RESOURCE_IDENTIFIER)) {
             return context.getExternalContext().encodeResourceURL(url);
         }
     }
+    
+    /**
+     * Generate an <code>href</code> URL considering a base URL and some other parameters.
+     * This method consider existing query string and fragment in the base URL.
+     * @param baseUrl An URL that may have query string and/or fragment.
+     * @param params A map with parameters for adding to <code>baseUrl</code>.
+     * @return An URL resulting in <code>params</code> added to <code>baseUrl</code> for using as <code>href</code> attribute.
+     */
+    public static String getHrefURL(String baseUrl, Map<String, List<String>> params) {
+        if (params == null || params.isEmpty()) {
+            return baseUrl;
+        }
+        //Fragment
+        String fragment = null;
+        int fragmentIndex = baseUrl.indexOf("#");
+        if (fragmentIndex != -1) {
+            fragment = baseUrl.substring(fragmentIndex + 1).trim();
+            baseUrl = baseUrl.substring(0, fragmentIndex);
+        }
+
+        //Query string and path
+        String queryString, path;
+        int queryStringIndex = baseUrl.indexOf("?");
+        if (queryStringIndex != -1) {
+            queryString = baseUrl.substring(queryStringIndex + 1).trim();
+            path = baseUrl.substring(0, queryStringIndex);
+        }
+        else {
+            queryString = null;
+            path = baseUrl;
+        }
+
+        boolean hasParam = false;
+        StringBuilder url = new StringBuilder(baseUrl.length() * 2);
+        url.append(path)
+                .append("?");
+        //If has previous queryString, set that first as is
+        if (!isValueBlank(queryString)) {
+            for (String pair : queryString.split("&")) {
+                String[] nameAndValue = pair.split("=");
+                // ignore malformed pair
+                if (nameAndValue.length != 2
+                        || isValueBlank(nameAndValue[0])) {
+                    continue;
+                }
+                if (hasParam) {
+                    url.append("&");
+                }
+                url.append(nameAndValue[0])
+                        .append("=")
+                        .append(nameAndValue[1]);
+                hasParam = true;
+            }
+        }
+        //Setting params Map passed
+        for (Map.Entry<String, List<String>> entry : params.entrySet()) {
+            for (String value : entry.getValue()) {
+                if (hasParam) {
+                    url.append("&");
+                }
+                try {
+                    url.append(entry.getKey())
+                            .append("=")
+                            .append(URLEncoder.encode(value, "UTF-8"));
+                }
+                catch (UnsupportedEncodingException e) {
+                    throw new RuntimeException(e);
+                }
+                hasParam = true;
+            }
+        }
+        if (!isValueBlank(fragment)) {
+            url.append("#")
+                    .append(fragment);
+        }
+        return url.toString();
+    }
 
     public static boolean isSkipIteration(VisitContext visitContext, FacesContext context) {
         if (PrimeApplicationContext.getCurrentInstance(context).getEnvironment().isAtLeastJsf21()) {

src/test/java/org/primefaces/util/ComponentUtilsTest.java

@@ -15,6 +15,10 @@
  */
 package org.primefaces.util;
 
+import java.util.Arrays;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
 import static org.junit.Assert.*;
 
 import org.junit.Test;
@@ -35,4 +39,44 @@ public void escapeSelector() {
     public void createContentDisposition() {
         assertEquals("attachment;filename=\"Test%20Spaces.txt\"; filename*=UTF-8''Test%20Spaces.txt", ComponentUtils.createContentDisposition("attachment", "Test Spaces.txt"));
     }
+    
+    @Test
+    public void getHrefURL() {
+        Map<String, List<String>> params = new LinkedHashMap<String, List<String>>();
+                
+        params.put("param1", Arrays.asList("value1"));
+        params.put("param2", Arrays.asList("enc?de&"));//URLEncoded: enc%3Fde%26
+        params.put("param3", Arrays.asList("two", "v@lues"));//v@lues URLEncoded: v%40lues
+        
+        Map<String, String> testCases = new LinkedHashMap<String, String>();
+        
+        //No query string nor fragment
+        testCases.put("https://foo.bar/some/path", 
+                "https://foo.bar/some/path?param1=value1&param2=enc%3Fde%26&param3=two&param3=v%40lues");
+        testCases.put("/internal/other/path", 
+                "/internal/other/path?param1=value1&param2=enc%3Fde%26&param3=two&param3=v%40lues");
+        
+        //Just Fragment
+        testCases.put("https://foo.bar/some/path#frg1", 
+                "https://foo.bar/some/path?param1=value1&param2=enc%3Fde%26&param3=two&param3=v%40lues#frg1");
+        testCases.put("/internal/other/path#frg1", 
+                "/internal/other/path?param1=value1&param2=enc%3Fde%26&param3=two&param3=v%40lues#frg1");
+        
+        //Just query string
+        testCases.put("https://foo.bar/some/path?q1=123&q2=456",
+                "https://foo.bar/some/path?q1=123&q2=456&param1=value1&param2=enc%3Fde%26&param3=two&param3=v%40lues");
+        testCases.put("/internal/other/path?q1=123&q2=456", 
+                "/internal/other/path?q1=123&q2=456&param1=value1&param2=enc%3Fde%26&param3=two&param3=v%40lues");
+        
+        //Query string and fragment
+        testCases.put("https://foo.bar/some/path?q1=123&q2=456#frg1",
+                "https://foo.bar/some/path?q1=123&q2=456&param1=value1&param2=enc%3Fde%26&param3=two&param3=v%40lues#frg1");
+        testCases.put("/internal/other/path?q1=123&q2=456#frg1", 
+                "/internal/other/path?q1=123&q2=456&param1=value1&param2=enc%3Fde%26&param3=two&param3=v%40lues#frg1");
+        
+        //Testing
+        for (Map.Entry<String, String> test : testCases.entrySet()) {
+            assertEquals(ComponentUtils.getHrefURL(test.getKey(), params), test.getValue());
+        }
+    }
 }