You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by iv...@apache.org on 2009/09/06 07:39:34 UTC
svn commit: r811762 - in
/wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/coding:
MixedParamHybridUrlCodingStrategy.java MixedParamUrlCodingStrategy.java
Author: ivaynberg
Date: Sun Sep 6 05:39:34 2009
New Revision: 811762
URL: http://svn.apache.org/viewvc?rev=811762&view=rev
Log:
WICKET-2439 Improve MixedParamUrlCodingStrategy, introduce Hybrid
Issue: WICKET-2439
Added:
wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/coding/MixedParamHybridUrlCodingStrategy.java (with props)
Modified:
wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/coding/MixedParamUrlCodingStrategy.java
Added: wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/coding/MixedParamHybridUrlCodingStrategy.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/coding/MixedParamHybridUrlCodingStrategy.java?rev=811762&view=auto
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/coding/MixedParamHybridUrlCodingStrategy.java (added)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/coding/MixedParamHybridUrlCodingStrategy.java Sun Sep 6 05:39:34 2009
@@ -0,0 +1,226 @@
+/*
+ * 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.wicket.request.target.coding;
+
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+import org.apache.wicket.PageParameters;
+import org.apache.wicket.RequestCycle;
+import org.apache.wicket.Page;
+import org.apache.wicket.protocol.http.WebRequest;
+import org.apache.wicket.util.string.AppendingStringBuffer;
+import org.apache.wicket.util.string.Strings;
+import org.apache.wicket.util.value.ValueMap;
+import org.slf4j.LoggerFactory;
+import org.slf4j.Logger;
+
+import javax.servlet.http.HttpServletRequest;
+
+/**
+ * Url coding strategy for bookmarkable pages with Ajax components that encodes a set of given
+ * parameters in the url's path and the rest in the query-string. In addition, the page version
+ * is added to the end of the url's path.
+ * <p/>
+ * Strategy looks for path-parameters whose name is read from an array of names e.g. ["param0",
+ * "param1"]. Found parameters will be appended to the url in the form
+ * <code>/mount-path/paramvalue0/paramvalue1</code>.
+ * <p/>
+ * All other parameters are added as parameter in the form:
+ * <code>/mount-path/paramvalue0?otherparam0=otherparamvalue0&otherparam1=otherparamvalue1</code>.
+ * <p/>
+ * Decode is symmetric except for when a path parameter that is not at the end has no value during
+ * encode. For example, the names for the path parameters are: "a", "b" and "c". When "b" is not
+ * specified upon encoding, but "c" is, upon a decode "b" will get the empty string as value. When
+ * both "b" and "c" are missing on encode, the will not get a value during decode.
+ *
+ * @author erik.van.oosten
+ * @see MixedParamUrlCodingStrategy
+ */
+public class MixedParamHybridUrlCodingStrategy extends HybridUrlCodingStrategy
+{
+ private static Logger logger = LoggerFactory.getLogger(MixedParamHybridUrlCodingStrategy.class);
+
+ private final String[] parameterNames;
+ private boolean ignoreUndeclaredParameters = true;
+
+ /**
+ * Construct.
+ *
+ * @param mountPath mount path
+ * @param pageClass class of mounted page
+ * @param redirectOnBookmarkableRequest
+ * whether after hitting the page with URL in bookmarkable form it should be
+ * redirected to hybrid URL - needed for ajax to work properly after page refresh
+ * @param parameterNames the parameter names (not null)
+ */
+ public MixedParamHybridUrlCodingStrategy(
+ String mountPath, Class<? extends Page> pageClass,
+ boolean redirectOnBookmarkableRequest, String[] parameterNames)
+ {
+ super(mountPath, pageClass, redirectOnBookmarkableRequest);
+ this.parameterNames = parameterNames;
+ }
+
+ /**
+ * Construct.
+ *
+ * @param mountPath mount path
+ * @param pageClass class of mounted page
+ * @param parameterNames the parameter names (not null)
+ */
+ public MixedParamHybridUrlCodingStrategy(String mountPath, Class<? extends Page> pageClass, String[] parameterNames)
+ {
+ super(mountPath, pageClass);
+ this.parameterNames = parameterNames;
+ }
+
+ /**
+ * @param ignoreUndeclaredParameters true to ignore undeclared parameters in
+ * the URL (still logged), false to throw an exception when this
+ * happens (default is true)
+ * @return this
+ */
+ public MixedParamHybridUrlCodingStrategy setIgnoreUndeclaredParameters(boolean ignoreUndeclaredParameters)
+ {
+ this.ignoreUndeclaredParameters = ignoreUndeclaredParameters;
+ return this;
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ protected void appendParameters(AppendingStringBuffer url, Map<String, ?> parameters)
+ {
+ if (!url.endsWith("/"))
+ {
+ url.append("/");
+ }
+
+ Set<String> parameterNamesToAdd = new HashSet<String>(parameters.keySet());
+
+ // Find index of last specified parameter
+ boolean foundParameter = false;
+ int lastSpecifiedParameter = parameterNames.length;
+ while (lastSpecifiedParameter != 0 && !foundParameter)
+ {
+ foundParameter = parameters.containsKey(parameterNames[--lastSpecifiedParameter]);
+ }
+
+ if (foundParameter) {
+ for (int i = 0; i <= lastSpecifiedParameter; i++)
+ {
+ String parameterName = parameterNames[i];
+ final Object param = parameters.get(parameterName);
+ String value = param instanceof String[] ? ((String[])param)[0] : (String)param;
+ if (value == null)
+ {
+ value = "";
+ }
+ if (!url.endsWith("/"))
+ {
+ url.append("/");
+ }
+ url.append(urlEncodePathComponent(value));
+ parameterNamesToAdd.remove(parameterName);
+ }
+ }
+
+ if (!parameterNamesToAdd.isEmpty())
+ {
+ boolean first = true;
+ for (String parameterName : parameterNamesToAdd)
+ {
+ url.append(first ? '?' : '&');
+ final Object param = parameters.get(parameterName);
+ String value = param instanceof String[] ? ((String[])param)[0] : String.valueOf(param);
+ url.append(urlEncodeQueryComponent(parameterName)).append("=").append(urlEncodeQueryComponent(value));
+ first = false;
+ }
+ }
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ protected String addPageInfo(String url, PageInfo pageInfo)
+ {
+ if (pageInfo == null)
+ {
+ return url;
+ }
+ else
+ {
+ // Insert the page info at the and of the path and before the querystring.
+ if (url.indexOf('?') == -1)
+ {
+ return url + getBeginSeparator() + pageInfo.toString() + getEndSeparator();
+ }
+ else
+ {
+ return Strings.firstPathComponent(url, '?') + getBeginSeparator() + pageInfo.toString() + getEndSeparator() + '?' + Strings.afterFirstPathComponent(url, '?');
+ }
+ }
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ protected ValueMap decodeParameters(String urlFragment, Map<String, ?> urlParameters)
+ {
+ PageParameters params = new PageParameters();
+ // Add all url parameters
+ params.putAll(urlParameters);
+ String urlPath = urlFragment;
+ if (urlPath.startsWith("/"))
+ {
+ urlPath = urlPath.substring(1);
+ }
+
+ if (urlPath.length() > 0)
+ {
+ String[] pathParts = urlPath.split("/");
+ if (pathParts.length > parameterNames.length)
+ {
+ // Some known causes of this situation:
+ // - user edits the URL manually
+ // - a javascript requests resources relative to the current page instead of to the web context
+ String msg = String.format("Found more URL path parts then expected, these will be ignored. Url: '%s', mountpath: '%s', urlPath: '%s', expected %d parameters was %d", getRequestUrl(), getMountPath(), urlPath, parameterNames.length, pathParts.length);
+ if (ignoreUndeclaredParameters)
+ {
+ logger.info(msg);
+ }
+ else
+ {
+ throw new IllegalArgumentException(msg);
+ }
+ }
+
+ int actualParameterCount = Math.min(pathParts.length, parameterNames.length);
+ for (int i = 0; i < actualParameterCount; i++)
+ {
+ params.put(parameterNames[i], urlDecodePathComponent(pathParts[i]));
+ }
+ }
+
+ return params;
+ }
+
+ private String getRequestUrl()
+ {
+ HttpServletRequest request = ((WebRequest) RequestCycle.get().getRequest()).getHttpServletRequest();
+ return request.getRequestURL().toString();
+ }
+}
\ No newline at end of file
Propchange: wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/coding/MixedParamHybridUrlCodingStrategy.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/coding/MixedParamUrlCodingStrategy.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/coding/MixedParamUrlCodingStrategy.java?rev=811762&r1=811761&r2=811762&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/coding/MixedParamUrlCodingStrategy.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/coding/MixedParamUrlCodingStrategy.java Sun Sep 6 05:39:34 2009
@@ -20,11 +20,17 @@
import java.util.Map;
import java.util.Set;
+import org.apache.wicket.PageParameters;
+import org.apache.wicket.RequestCycle;
import org.apache.wicket.Page;
import org.apache.wicket.PageMap;
-import org.apache.wicket.PageParameters;
+import org.apache.wicket.protocol.http.WebRequest;
import org.apache.wicket.util.string.AppendingStringBuffer;
import org.apache.wicket.util.value.ValueMap;
+import org.slf4j.LoggerFactory;
+import org.slf4j.Logger;
+
+import javax.servlet.http.HttpServletRequest;
/**
* Url coding strategy for bookmarkable pages that encodes a set of given parameters in the url's
@@ -46,7 +52,10 @@
*/
public class MixedParamUrlCodingStrategy extends BookmarkablePageRequestTargetUrlCodingStrategy
{
- private final String[] parameterNames;
+ private static Logger logger = LoggerFactory.getLogger(MixedParamUrlCodingStrategy.class);
+
+ private final String[] parameterNames;
+ private boolean ignoreUndeclaredParameters = true;
/**
* Construct.
@@ -86,6 +95,18 @@
this.parameterNames = parameterNames;
}
+ /**
+ * @param ignoreUndeclaredParameters true to ignore undeclared parameters in
+ * the URL (still logged), false to throw an exception when this
+ * happens (default is true)
+ * @return this
+ */
+ public MixedParamUrlCodingStrategy setIgnoreUndeclaredParameters(boolean ignoreUndeclaredParameters)
+ {
+ this.ignoreUndeclaredParameters = ignoreUndeclaredParameters;
+ return this;
+ }
+
/**
* @see org.apache.wicket.request.target.coding.AbstractRequestTargetUrlCodingStrategy#appendParameters(org.apache.wicket.util.string.AppendingStringBuffer,
* java.util.Map)
@@ -135,7 +156,7 @@
{
url.append(first ? '?' : '&');
final Object param = parameters.get(parameterName);
- String value = param instanceof String[] ? ((String[])param)[0] : (String)param;
+ String value = param instanceof String[] ? ((String[])param)[0] : String.valueOf(param);
url.append(urlEncodeQueryComponent(parameterName)).append("=").append(
urlEncodeQueryComponent(value));
first = false;
@@ -164,16 +185,29 @@
String[] pathParts = urlPath.split("/");
if (pathParts.length > parameterNames.length)
{
- throw new IllegalArgumentException(
- "Too many path parts, please provide sufficient number of path parameter names");
+ // Some known causes of this situation:
+ // - user edits the URL manually
+ // - a javascript requests resources relative to the current page instead of to the web context
+ String msg = String.format("Found more URL path parts then expected, these will be ignored. Url: '%s', mountpath: '%s', urlPath: '%s', expected %d parameters was %d", getRequestUrl(), getMountPath(), urlPath, parameterNames.length, pathParts.length);
+ if (ignoreUndeclaredParameters) {
+ logger.info(msg);
+ } else {
+ throw new IllegalArgumentException(msg);
+ }
}
- for (int i = 0; i < pathParts.length; i++)
- {
- params.put(parameterNames[i], urlDecodePathComponent(pathParts[i]));
- }
+ int actualParameterCount = Math.min(pathParts.length, parameterNames.length);
+ for (int i = 0; i < actualParameterCount; i++) {
+ params.put(parameterNames[i], urlDecodePathComponent(pathParts[i]));
+ }
}
return params;
}
-}
+
+ private String getRequestUrl()
+ {
+ HttpServletRequest request = ((WebRequest) RequestCycle.get().getRequest()).getHttpServletRequest();
+ return request.getRequestURL().toString();
+ }
+}
\ No newline at end of file