You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by mr...@apache.org on 2003/10/11 00:03:33 UTC
cvs commit: jakarta-struts/src/share/org/apache/struts/config/impl ModuleConfigImpl.java
mrdon 2003/10/10 15:03:33
Modified: src/share/org/apache/struts/action RequestProcessor.java
src/share/org/apache/struts/config/impl
ModuleConfigImpl.java
Added: src/share/org/apache/struts/config ActionConfigMatcher.java
Removed: src/share/org/apache/struts/action ActionMappingMatcher.java
Log:
Moved wildcard action matching code into ModuleConfigImpl.findActionConfig()
as several taglibs needed to match action mappings containing wildcards.
Improved action mapping cloning to truely clone ActionConfig to support
alternate action mapping classes.
Revision Changes Path
1.38 +5 -15 jakarta-struts/src/share/org/apache/struts/action/RequestProcessor.java
Index: RequestProcessor.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/action/RequestProcessor.java,v
retrieving revision 1.37
retrieving revision 1.38
diff -u -r1.37 -r1.38
--- RequestProcessor.java 5 Oct 2003 17:45:14 -0000 1.37
+++ RequestProcessor.java 10 Oct 2003 22:03:33 -0000 1.38
@@ -145,11 +145,6 @@
*/
protected ActionServlet servlet = null;
- /**
- * Matches action mapping paths against compiled wildcard patterns
- */
- protected ActionMappingMatcher matcher = null;
-
// --------------------------------------------------------- Public Methods
@@ -188,7 +183,6 @@
this.servlet = servlet;
this.moduleConfig = moduleConfig;
- matcher = new ActionMappingMatcher(moduleConfig.findActionConfigs());
}
/**
@@ -663,13 +657,9 @@
String path)
throws IOException {
- // Is there a directly defined or wildcard-matched mapping for this
- // path?
+ // Is there a mapping for this path?
ActionMapping mapping = (ActionMapping)
moduleConfig.findActionConfig(path);
- if (mapping == null) {
- mapping = matcher.match(path);
- }
// If a mapping is found, put it in the request and return it
if (mapping != null) {
1.1 jakarta-struts/src/share/org/apache/struts/config/ActionConfigMatcher.java
Index: ActionConfigMatcher.java
===================================================================
/*
* $Header: /home/cvs/jakarta-struts/src/share/org/apache/struts/config/ActionConfigMatcher.java,v 1.1 2003/10/10 22:03:33 mrdon Exp $
* $Revision: 1.1 $
* $Date: 2003/10/10 22:03:33 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowledgement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Struts", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.struts.config;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.commons.beanutils.BeanUtils;
import org.apache.struts.action.ActionForward;
import org.apache.struts.util.WildcardHelper;
/**
* Matches paths against pre-compiled wildcard expressions pulled from
* action configs. It uses the wildcard matcher from the Apache
* Cocoon project.
*
* @author Don Brown
*/
public class ActionConfigMatcher {
/**
* The logging instance
*/
private static final Log log =
LogFactory.getLog(ActionConfigMatcher.class);
/**
* The compiled paths and their associated ActionConfig's
*/
private List compiledPaths;
/**
* Finds and precompiles the wildcard patterns from the ActionConfig
* "path" attributes.
* ActionConfig's will be evaluated in the order they exist in the
* Struts config file. Only paths that actually contain a wildcard
* will be compiled.
*
* @param configs An array of ActionConfig's to process
*/
public ActionConfigMatcher(ActionConfig[] configs) {
compiledPaths = new ArrayList();
int[] pattern;
String path;
for (int x = 0; x < configs.length; x++) {
path = configs[x].getPath();
if (path.indexOf('*') > -1) {
if (path.length() > 0 && path.charAt(0) == '/') {
path = path.substring(1);
}
if (log.isDebugEnabled()) {
log.debug("Compiling action config path '" + path + "'");
}
pattern = WildcardHelper.compilePattern(path);
compiledPaths.add(new Mapping(pattern, configs[x]));
}
}
}
/**
* Matches the path against the compiled wildcard patterns.
*
* @param path The portion of the request URI for selecting a
* config
* @return The action config if matched, else null
*/
public ActionConfig match(String path) {
ActionConfig config = null;
if (compiledPaths.size() > 0) {
if (log.isDebugEnabled()) {
log.debug("Attempting to match '" + path
+ "' to a wildcard pattern");
}
if (path.length() > 0 && path.charAt(0) == '/') {
path = path.substring(1);
}
Mapping m;
HashMap vars = new HashMap();
for (Iterator i = compiledPaths.iterator(); i.hasNext();) {
m = (Mapping) i.next();
if (WildcardHelper.match(vars, path, m.getPattern())) {
config = convertActionConfig(
path,
(ActionConfig) m.getActionConfig(),
vars);
}
}
}
return config;
}
/**
* Clones the ActionConfig and its children, replacing various properties
* with the values of the wildcard-matched strings.
*
* @param path The requested path
* @param orig The original ActionConfig
* @param vars A Map of wildcard-matched strings
* @return A cloned ActionConfig with appropriate properties replaced
* with wildcard-matched values
*/
protected ActionConfig convertActionConfig(String path,
ActionConfig orig, Map vars) {
ActionConfig config = null;
try {
config = (ActionConfig) BeanUtils.cloneBean(orig);
}
catch (Exception ex) {
log.warn("Unable to clone action config, recommend not using "
+ "wildcards", ex);
return null;
}
config.setName(convertParam(orig.getName(), vars));
if (path.charAt(0) != '/') {
path = "/" + path;
}
config.setPath(path);
config.setType(convertParam(orig.getType(), vars));
config.setRoles(convertParam(orig.getRoles(), vars));
config.setParameter(convertParam(orig.getParameter(), vars));
config.setAttribute(convertParam(orig.getAttribute(), vars));
config.setForward(convertParam(orig.getForward(), vars));
config.setInclude(convertParam(orig.getInclude(), vars));
config.setInput(convertParam(orig.getInput(), vars));
ForwardConfig[] fConfigs = orig.findForwardConfigs();
ForwardConfig cfg;
for (int x = 0; x < fConfigs.length; x++) {
cfg = new ActionForward();
cfg.setContextRelative(fConfigs[x].getContextRelative());
cfg.setName(fConfigs[x].getName());
cfg.setPath(convertParam(fConfigs[x].getPath(), vars));
config.removeForwardConfig(fConfigs[x]);
config.addForwardConfig(cfg);
}
return config;
}
/**
* Inserts into a value wildcard-matched strings where specified.
*
* @param val The value to convert
* @param vars A Map of wildcard-matched strings
* @return The new value
*/
protected String convertParam(String val, Map vars) {
if (val == null) {
return null;
} else if (val.indexOf("{") == -1) {
return val;
}
Map.Entry entry;
StringBuffer key = new StringBuffer("{0}");
StringBuffer ret = new StringBuffer(val);
int x;
for (Iterator i = vars.entrySet().iterator(); i.hasNext();) {
entry = (Map.Entry) i.next();
key.setCharAt(1, ((String) entry.getKey()).charAt(0));
x = ret.toString().indexOf(key.toString());
if (x > -1) {
ret.replace(x, x + 3, (String) entry.getValue());
}
}
return ret.toString();
}
/**
* Stores a compiled wildcard pattern and the ActionConfig it came from.
*/
private class Mapping {
/** The compiled pattern. */
private int[] pattern;
/** The original ActionConfig. */
private ActionConfig config;
/**
* Contructs a read-only Mapping instance.
*
* @param pattern The compiled pattern
* @param config The original ActionConfig
*/
public Mapping(int[] pattern, ActionConfig config) {
this.pattern = pattern;
this.config = config;
}
/**
* Gets the compiled wildcard pattern.
*
* @return The compiled pattern
*/
public int[] getPattern() {
return this.pattern;
}
/**
* Gets the ActionConfig that contains the pattern.
*
* @return The associated ActionConfig
*/
public ActionConfig getActionConfig() {
return this.config;
}
}
}
1.7 +22 -7 jakarta-struts/src/share/org/apache/struts/config/impl/ModuleConfigImpl.java
Index: ModuleConfigImpl.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/config/impl/ModuleConfigImpl.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ModuleConfigImpl.java 16 Jul 2003 04:52:44 -0000 1.6
+++ ModuleConfigImpl.java 10 Oct 2003 22:03:33 -0000 1.7
@@ -66,6 +66,7 @@
import java.util.HashMap;
import org.apache.struts.config.ActionConfig;
+import org.apache.struts.config.ActionConfigMatcher;
import org.apache.struts.config.ControllerConfig;
import org.apache.struts.config.DataSourceConfig;
import org.apache.struts.config.ExceptionConfig;
@@ -312,14 +313,23 @@
}
/**
- * Return the action configuration for the specified path, if any;
+ * Return the action configuration for the specified path, first looking
+ * a direct match, then if none found, a wildcard pattern match;
* otherwise return <code>null</code>.
*
* @param path Path of the action configuration to return
*/
public ActionConfig findActionConfig(String path) {
- return ((ActionConfig) actionConfigs.get(path));
+ ActionConfig config = (ActionConfig) actionConfigs.get(path);
+
+ // If a direct match cannot be found, try to match action configs
+ // containing wildcard patterns
+ if (config == null) {
+ config = matcher.match(path);
+ }
+
+ return config;
}
@@ -475,6 +485,7 @@
for (int i = 0; i < aconfigs.length; i++) {
aconfigs[i].freeze();
}
+ matcher = new ActionConfigMatcher(aconfigs);
getControllerConfig().freeze();
@@ -507,7 +518,6 @@
for (int i = 0; i < piconfigs.length; i++) {
piconfigs[i].freeze();
}
-
}
/**
@@ -685,5 +695,10 @@
* instances.
*/
protected String actionMappingClass = "org.apache.struts.action.ActionMapping";
+
+ /**
+ * Matches action config paths against compiled wildcard patterns
+ */
+ protected ActionConfigMatcher matcher = null;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: struts-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: struts-dev-help@jakarta.apache.org