trunk/core/src/main/java/org/apache/struts2/views/util/UrlHelper.java - struts - Git at Google

 /*
  * $Id$
  *
  * Copyright 2006 The Apache Software Foundation.
  *
  * Licensed 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.views.util;

 import java.io.UnsupportedEncodingException;
 import java.net.URLDecoder;
 import java.net.URLEncoder;
 import java.util.Collections;
 import java.util.Iterator;
 import java.util.LinkedHashMap;
 import java.util.Map;

 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;

 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.apache.struts2.ServletActionContext;
 import org.apache.struts2.StrutsConstants;
 import org.apache.struts2.config.Settings;

 import com.opensymphony.xwork2.ActionContext;
 import com.opensymphony.xwork2.util.OgnlValueStack;
 import com.opensymphony.xwork2.util.TextParseUtil;
 import com.opensymphony.xwork2.util.XWorkContinuationConfig;


 /**
  * UrlHelper
  *
  */
 public class UrlHelper {
     private static final Log LOG = LogFactory.getLog(UrlHelper.class);

     /**
      * Default HTTP port (80).
      */
     private static final int DEFAULT_HTTP_PORT = 80;

     /**
      * Default HTTPS port (443).
      */
     private static final int DEFAULT_HTTPS_PORT = 443;

     private static final String AMP = "&amp;";

     public static String buildUrl(String action, HttpServletRequest request, HttpServletResponse response, Map params) {
         return buildUrl(action, request, response, params, null, true, true);
     }

     public static String buildUrl(String action, HttpServletRequest request, HttpServletResponse response, Map params, String scheme, boolean includeContext, boolean encodeResult) {
     	return buildUrl(action, request, response, params, scheme, includeContext, encodeResult, false);
     }

     public static String buildUrl(String action, HttpServletRequest request, HttpServletResponse response, Map params, String scheme, boolean includeContext, boolean encodeResult, boolean forceAddSchemeHostAndPort) {
         StringBuffer link = new StringBuffer();

         boolean changedScheme = false;

         int httpPort = DEFAULT_HTTP_PORT;

         try {
             httpPort = Integer.parseInt((String) Settings.get(StrutsConstants.STRUTS_URL_HTTP_PORT));
         } catch (Exception ex) {
         }

         int httpsPort = DEFAULT_HTTPS_PORT;

         try {
             httpsPort = Integer.parseInt((String) Settings.get(StrutsConstants.STRUTS_URL_HTTPS_PORT));
         } catch (Exception ex) {
         }

         // only append scheme if it is different to the current scheme *OR*
         // if we explicity want it to be appended by having forceAddSchemeHostAndPort = true
         if (forceAddSchemeHostAndPort) {
         	String reqScheme = request.getScheme();
         	changedScheme = true;
         	link.append(scheme != null ? scheme : reqScheme);
         	link.append("://");
         	link.append(request.getServerName());

         	if ((scheme.equals("http") && (httpPort != DEFAULT_HTTP_PORT)) || (scheme.equals("https") && httpsPort != DEFAULT_HTTPS_PORT))
             {
                 link.append(":");
                 link.append(scheme.equals("http") ? httpPort : httpsPort);
             }
         }
         else if (
            (scheme != null) && !scheme.equals(request.getScheme())) {
             changedScheme = true;
             link.append(scheme);
             link.append("://");
             link.append(request.getServerName());

             if ((scheme.equals("http") && (httpPort != DEFAULT_HTTP_PORT)) || (scheme.equals("https") && httpsPort != DEFAULT_HTTPS_PORT))
             {
                 link.append(":");
                 link.append(scheme.equals("http") ? httpPort : httpsPort);
             }
         }

         if (action != null) {
             // Check if context path needs to be added
             // Add path to absolute links
             if (action.startsWith("/") && includeContext) {
                 String contextPath = request.getContextPath();
                 if (!contextPath.equals("/")) {
                     link.append(contextPath);
                 }
             } else if (changedScheme) {
                 String uri = request.getRequestURI();
                 link.append(uri.substring(0, uri.lastIndexOf('/')));
             }

             // Add page
             link.append(action);
         } else {
             // Go to "same page"
             String requestURI = (String) request.getAttribute("struts.request_uri");

             if (requestURI == null) {
                 requestURI = request.getRequestURI();
             }

             link.append(requestURI);
         }

         // tie in the continuation parameter
         String continueId = (String) ActionContext.getContext().get(XWorkContinuationConfig.CONTINUE_KEY);
         if (continueId != null) {
             if (params == null) {
                 params = Collections.singletonMap(XWorkContinuationConfig.CONTINUE_PARAM, continueId);
             } else {
                 params.put(XWorkContinuationConfig.CONTINUE_PARAM, continueId);
             }
         }

         //if the action was not explicitly set grab the params from the request
         buildParametersString(params, link);

         String result;

         try {
             result = encodeResult ? response.encodeURL(link.toString()) : link.toString();
         } catch (Exception ex) {
             // Could not encode the URL for some reason
             // Use it unchanged
             result = link.toString();
         }

         return result;
     }

     public static void buildParametersString(Map params, StringBuffer link) {
     	buildParametersString(params, link, AMP);
     }

     public static void buildParametersString(Map params, StringBuffer link, String paramSeparator) {
         if ((params != null) && (params.size() > 0)) {
             if (link.toString().indexOf("?") == -1) {
                 link.append("?");
             } else {
                 link.append(paramSeparator);
             }

             // Set params
             Iterator iter = params.entrySet().iterator();

             String[] valueHolder = new String[1];

             while (iter.hasNext()) {
                 Map.Entry entry = (Map.Entry) iter.next();
                 String name = (String) entry.getKey();
                 Object value = entry.getValue();

                 String[] values;

                 if (value instanceof String[]) {
                     values = (String[]) value;
                 } else {
                     valueHolder[0] = value.toString();
                     values = valueHolder;
                 }

                 for (int i = 0; i < values.length; i++) {
                     if (values[i] != null) {
                         link.append(name);
                         link.append('=');
                         link.append(translateAndEncode(values[i]));
                     }

                     if (i < (values.length - 1)) {
                         link.append(paramSeparator);
                     }
                 }

                 if (iter.hasNext()) {
                     link.append(paramSeparator);
                 }
             }
         }
     }

     /**
      * Translates any script expressions using {@link com.opensymphony.xwork2.util.TextParseUtil#translateVariables} and
      * encodes the URL using {@link java.net.URLEncoder#encode} with the encoding specified in the configuration.
      *
      * @param input
      * @return the translated and encoded string
      */
     public static String translateAndEncode(String input) {
         String translatedInput = translateVariable(input);
         String encoding = getEncodingFromConfiguration();

         try {
             return URLEncoder.encode(translatedInput, encoding);
         } catch (UnsupportedEncodingException e) {
             LOG.warn("Could not encode URL parameter '" + input + "', returning value un-encoded");
             return translatedInput;
         }
     }

     public static String translateAndDecode(String input) {
     	String translatedInput = translateVariable(input);
     	String encoding = getEncodingFromConfiguration();

         try {
             return URLDecoder.decode(translatedInput, encoding);
         } catch (UnsupportedEncodingException e) {
             LOG.warn("Could not encode URL parameter '" + input + "', returning value un-encoded");
             return translatedInput;
         }
     }

     private static String translateVariable(String input) {
     	OgnlValueStack valueStack = ServletActionContext.getContext().getValueStack();
         String output = TextParseUtil.translateVariables(input, valueStack);
         return output;
     }

     private static String getEncodingFromConfiguration() {
     	final String encoding;
         if (Settings.isSet(StrutsConstants.STRUTS_I18N_ENCODING)) {
             encoding = Settings.get(StrutsConstants.STRUTS_I18N_ENCODING);
         } else {
             encoding = "UTF-8";
         }
         return encoding;
     }

     public static Map parseQueryString(String queryString) {
     	Map queryParams = new LinkedHashMap();
     	if (queryString != null) {
     		String[] params = queryString.split("&");
     		for (int a=0; a< params.length; a++) {
     			if (params[a].trim().length() > 0) {
     				String[] tmpParams = params[a].split("=");
     				String paramName = null;
     				String paramValue = "";
     				if (tmpParams.length > 0) {
     					paramName = tmpParams[0];
     				}
     				if (tmpParams.length > 1) {
     					paramValue = tmpParams[1];
     				}
     				if (paramName != null) {
     					String translatedParamValue = translateAndDecode(paramValue);
     					queryParams.put(paramName, translatedParamValue);
     				}
     			}
     		}
     	}
     	return queryParams;
     }
 }
	/*
	* $Id$
	*
	* Copyright 2006 The Apache Software Foundation.
	*
	* Licensed 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.views.util;

	import java.io.UnsupportedEncodingException;
	import java.net.URLDecoder;
	import java.net.URLEncoder;
	import java.util.Collections;
	import java.util.Iterator;
	import java.util.LinkedHashMap;
	import java.util.Map;

	import javax.servlet.http.HttpServletRequest;
	import javax.servlet.http.HttpServletResponse;

	import org.apache.commons.logging.Log;
	import org.apache.commons.logging.LogFactory;
	import org.apache.struts2.ServletActionContext;
	import org.apache.struts2.StrutsConstants;
	import org.apache.struts2.config.Settings;

	import com.opensymphony.xwork2.ActionContext;
	import com.opensymphony.xwork2.util.OgnlValueStack;
	import com.opensymphony.xwork2.util.TextParseUtil;
	import com.opensymphony.xwork2.util.XWorkContinuationConfig;


	/**
	* UrlHelper
	*
	*/
	public class UrlHelper {
	private static final Log LOG = LogFactory.getLog(UrlHelper.class);

	/**
	* Default HTTP port (80).
	*/
	private static final int DEFAULT_HTTP_PORT = 80;

	/**
	* Default HTTPS port (443).
	*/
	private static final int DEFAULT_HTTPS_PORT = 443;

	private static final String AMP = "&";

	public static String buildUrl(String action, HttpServletRequest request, HttpServletResponse response, Map params) {
	return buildUrl(action, request, response, params, null, true, true);
	}

	public static String buildUrl(String action, HttpServletRequest request, HttpServletResponse response, Map params, String scheme, boolean includeContext, boolean encodeResult) {
	return buildUrl(action, request, response, params, scheme, includeContext, encodeResult, false);
	}

	public static String buildUrl(String action, HttpServletRequest request, HttpServletResponse response, Map params, String scheme, boolean includeContext, boolean encodeResult, boolean forceAddSchemeHostAndPort) {
	StringBuffer link = new StringBuffer();

	boolean changedScheme = false;

	int httpPort = DEFAULT_HTTP_PORT;

	try {
	httpPort = Integer.parseInt((String) Settings.get(StrutsConstants.STRUTS_URL_HTTP_PORT));
	} catch (Exception ex) {
	}

	int httpsPort = DEFAULT_HTTPS_PORT;

	try {
	httpsPort = Integer.parseInt((String) Settings.get(StrutsConstants.STRUTS_URL_HTTPS_PORT));
	} catch (Exception ex) {
	}

	// only append scheme if it is different to the current scheme OR
	// if we explicity want it to be appended by having forceAddSchemeHostAndPort = true
	if (forceAddSchemeHostAndPort) {
	String reqScheme = request.getScheme();
	changedScheme = true;
	link.append(scheme != null ? scheme : reqScheme);
	link.append("://");
	link.append(request.getServerName());

	if ((scheme.equals("http") && (httpPort != DEFAULT_HTTP_PORT)) \|\| (scheme.equals("https") && httpsPort != DEFAULT_HTTPS_PORT))
	{
	link.append(":");
	link.append(scheme.equals("http") ? httpPort : httpsPort);
	}
	}
	else if (
	(scheme != null) && !scheme.equals(request.getScheme())) {
	changedScheme = true;
	link.append(scheme);
	link.append("://");
	link.append(request.getServerName());

	if ((scheme.equals("http") && (httpPort != DEFAULT_HTTP_PORT)) \|\| (scheme.equals("https") && httpsPort != DEFAULT_HTTPS_PORT))
	{
	link.append(":");
	link.append(scheme.equals("http") ? httpPort : httpsPort);
	}
	}

	if (action != null) {
	// Check if context path needs to be added
	// Add path to absolute links
	if (action.startsWith("/") && includeContext) {
	String contextPath = request.getContextPath();
	if (!contextPath.equals("/")) {
	link.append(contextPath);
	}
	} else if (changedScheme) {
	String uri = request.getRequestURI();
	link.append(uri.substring(0, uri.lastIndexOf('/')));
	}

	// Add page
	link.append(action);
	} else {
	// Go to "same page"
	String requestURI = (String) request.getAttribute("struts.request_uri");

	if (requestURI == null) {
	requestURI = request.getRequestURI();
	}

	link.append(requestURI);
	}

	// tie in the continuation parameter
	String continueId = (String) ActionContext.getContext().get(XWorkContinuationConfig.CONTINUE_KEY);
	if (continueId != null) {
	if (params == null) {
	params = Collections.singletonMap(XWorkContinuationConfig.CONTINUE_PARAM, continueId);
	} else {
	params.put(XWorkContinuationConfig.CONTINUE_PARAM, continueId);
	}
	}

	//if the action was not explicitly set grab the params from the request
	buildParametersString(params, link);

	String result;

	try {
	result = encodeResult ? response.encodeURL(link.toString()) : link.toString();
	} catch (Exception ex) {
	// Could not encode the URL for some reason
	// Use it unchanged
	result = link.toString();
	}

	return result;
	}

	public static void buildParametersString(Map params, StringBuffer link) {
	buildParametersString(params, link, AMP);
	}

	public static void buildParametersString(Map params, StringBuffer link, String paramSeparator) {
	if ((params != null) && (params.size() > 0)) {
	if (link.toString().indexOf("?") == -1) {
	link.append("?");
	} else {
	link.append(paramSeparator);
	}

	// Set params
	Iterator iter = params.entrySet().iterator();

	String[] valueHolder = new String[1];

	while (iter.hasNext()) {
	Map.Entry entry = (Map.Entry) iter.next();
	String name = (String) entry.getKey();
	Object value = entry.getValue();

	String[] values;

	if (value instanceof String[]) {
	values = (String[]) value;
	} else {
	valueHolder[0] = value.toString();
	values = valueHolder;
	}

	for (int i = 0; i < values.length; i++) {
	if (values[i] != null) {
	link.append(name);
	link.append('=');
	link.append(translateAndEncode(values[i]));
	}

	if (i < (values.length - 1)) {
	link.append(paramSeparator);
	}
	}

	if (iter.hasNext()) {
	link.append(paramSeparator);
	}
	}
	}
	}

	/**
	* Translates any script expressions using {@link com.opensymphony.xwork2.util.TextParseUtil#translateVariables} and
	* encodes the URL using {@link java.net.URLEncoder#encode} with the encoding specified in the configuration.
	*
	* @param input
	* @return the translated and encoded string
	*/
	public static String translateAndEncode(String input) {
	String translatedInput = translateVariable(input);
	String encoding = getEncodingFromConfiguration();

	try {
	return URLEncoder.encode(translatedInput, encoding);
	} catch (UnsupportedEncodingException e) {
	LOG.warn("Could not encode URL parameter '" + input + "', returning value un-encoded");
	return translatedInput;
	}
	}

	public static String translateAndDecode(String input) {
	String translatedInput = translateVariable(input);
	String encoding = getEncodingFromConfiguration();

	try {
	return URLDecoder.decode(translatedInput, encoding);
	} catch (UnsupportedEncodingException e) {
	LOG.warn("Could not encode URL parameter '" + input + "', returning value un-encoded");
	return translatedInput;
	}
	}

	private static String translateVariable(String input) {
	OgnlValueStack valueStack = ServletActionContext.getContext().getValueStack();
	String output = TextParseUtil.translateVariables(input, valueStack);
	return output;
	}

	private static String getEncodingFromConfiguration() {
	final String encoding;
	if (Settings.isSet(StrutsConstants.STRUTS_I18N_ENCODING)) {
	encoding = Settings.get(StrutsConstants.STRUTS_I18N_ENCODING);
	} else {
	encoding = "UTF-8";
	}
	return encoding;
	}

	public static Map parseQueryString(String queryString) {
	Map queryParams = new LinkedHashMap();
	if (queryString != null) {
	String[] params = queryString.split("&");
	for (int a=0; a< params.length; a++) {
	if (params[a].trim().length() > 0) {
	String[] tmpParams = params[a].split("=");
	String paramName = null;
	String paramValue = "";
	if (tmpParams.length > 0) {
	paramName = tmpParams[0];
	}
	if (tmpParams.length > 1) {
	paramValue = tmpParams[1];
	}
	if (paramName != null) {
	String translatedParamValue = translateAndDecode(paramValue);
	queryParams.put(paramName, translatedParamValue);
	}
	}
	}
	}
	return queryParams;
	}
	}