1 /** 2 * This file Copyright (c) 2010-2013 Magnolia International 3 * Ltd. (http://www.magnolia-cms.com). All rights reserved. 4 * 5 * 6 * This file is dual-licensed under both the Magnolia 7 * Network Agreement and the GNU General Public License. 8 * You may elect to use one or the other of these licenses. 9 * 10 * This file is distributed in the hope that it will be 11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the 12 * implied warranty of MERCHANTABILITY or FITNESS FOR A 13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT. 14 * Redistribution, except as permitted by whichever of the GPL 15 * or MNA you select, is prohibited. 16 * 17 * 1. For the GPL license (GPL), you can redistribute and/or 18 * modify this file under the terms of the GNU General 19 * Public License, Version 3, as published by the Free Software 20 * Foundation. You should have received a copy of the GNU 21 * General Public License, Version 3 along with this program; 22 * if not, write to the Free Software Foundation, Inc., 51 23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 24 * 25 * 2. For the Magnolia Network Agreement (MNA), this file 26 * and the accompanying materials are made available under the 27 * terms of the MNA which accompanies this distribution, and 28 * is available at http://www.magnolia-cms.com/mna.html 29 * 30 * Any modifications to this file must keep this entire header 31 * intact. 32 * 33 */ 34 package info.magnolia.cms.filters; 35 36 import info.magnolia.cms.util.SimpleUrlPattern; 37 import info.magnolia.context.MgnlContext; 38 import info.magnolia.context.WebContext; 39 import org.apache.commons.lang.StringUtils; 40 import org.slf4j.Logger; 41 import org.slf4j.LoggerFactory; 42 43 import javax.servlet.http.HttpServletRequest; 44 import java.util.ArrayList; 45 import java.util.Collection; 46 import java.util.Iterator; 47 import java.util.regex.Matcher; 48 import java.util.regex.Pattern; 49 50 51 /** 52 * A URI mapping as configured for filters and servlets. 53 * @version $Id$ 54 * 55 */ 56 public class Mapping { 57 58 private static Logger log = LoggerFactory.getLogger(Mapping.class); 59 60 private static final String METACHARACTERS = "([\\^\\(\\)\\{\\}\\[\\]*$+])"; 61 62 protected static String escapeMetaCharacters(String str) { 63 return str.replaceAll(METACHARACTERS, "\\\\$1"); 64 } 65 66 protected Collection<Pattern> mappings = new ArrayList<Pattern>(); 67 68 public MatchingResult match(HttpServletRequest request) { 69 Matcher matcher = findMatcher(request); 70 boolean matches = matcher != null; 71 int matchingEndPosition = determineMatchingEnd(matcher); 72 return new MatchingResult(matcher, matches, matchingEndPosition); 73 } 74 75 /** 76 * Determines the index of the first pathInfo character. If the uri does not match any mapping 77 * this method returns -1. 78 */ 79 private int determineMatchingEnd(Matcher matcher) { 80 if (matcher == null) { 81 return -1; 82 } 83 if (matcher.groupCount() > 0) { 84 return matcher.end(1); 85 } 86 return matcher.end(); 87 } 88 89 private Matcher findMatcher(HttpServletRequest request) { 90 String uri = null; 91 WebContext ctx = MgnlContext.getWebContextOrNull(); 92 if (ctx != null) { 93 uri = ctx.getAggregationState().getCurrentURI(); 94 } 95 if (uri == null) { 96 // the web context is not available during installation 97 uri = StringUtils.substringAfter(request.getRequestURI(), request.getContextPath()); 98 } 99 return findMatcher(uri); 100 } 101 102 private Matcher findMatcher(String uri) { 103 for (Iterator iter = mappings.iterator(); iter.hasNext();) { 104 final Matcher matcher = ((Pattern) iter.next()).matcher(uri); 105 106 if (matcher.find()) { 107 return matcher; 108 } 109 } 110 111 return null; 112 } 113 114 public Collection<Pattern> getMappings() { 115 return mappings; 116 } 117 118 /** 119 * See SRV.11.2 Specification of Mappings in the Servlet Specification for the syntax of 120 * mappings. Additionally, you can also use plain regular expressions to map your servlets, by 121 * prefix the mapping by "regex:". (in which case anything in the request url following the 122 * expression's match will be the pathInfo - if your pattern ends with a $, extra pathInfo won't 123 * match) 124 */ 125 public void addMapping(final String mapping) { 126 final String pattern; 127 128 // we're building a Pattern with 3 groups: (1) servletPath (2) ignored (3) pathInfo 129 130 if (isDefaultMapping(mapping)) { 131 // the mapping is exactly '/*', the servlet path should be 132 // an empty string and everything else should be the path info 133 pattern = "^()(/)(" + SimpleUrlPattern.MULTIPLE_CHAR_PATTERN + ")"; 134 } 135 else if (isPathMapping(mapping)) { 136 // the pattern ends with /*, escape out metacharacters for 137 // use in a regex, and replace the ending * with MULTIPLE_CHAR_PATTERN 138 final String mappingWithoutSuffix = StringUtils.removeEnd(mapping, "/*"); 139 pattern = "^(" + escapeMetaCharacters(mappingWithoutSuffix) + ")(/)(" + SimpleUrlPattern.MULTIPLE_CHAR_PATTERN + ")"; 140 } 141 else if (isExtensionMapping(mapping)) { 142 // something like '*.jsp', everything should be the servlet path 143 // and the path info should be null 144 final String regexedMapping = StringUtils.replace(mapping, "*.", SimpleUrlPattern.MULTIPLE_CHAR_PATTERN + "\\."); 145 pattern = "^(" + regexedMapping + ")$"; 146 } 147 else if (isRegexpMapping(mapping)) { 148 final String mappingWithoutPrefix = StringUtils.removeStart(mapping, "regex:"); 149 pattern = "^(" + mappingWithoutPrefix + ")($|/)(" + SimpleUrlPattern.MULTIPLE_CHAR_PATTERN + ")"; 150 } 151 else { 152 // just literal text, ensure metacharacters are escaped, and that only 153 // the exact string is matched. 154 pattern = "^(" + escapeMetaCharacters(mapping) + ")$"; 155 } 156 log.debug("Adding new mapping for {}", mapping); 157 158 mappings.add(Pattern.compile(pattern)); 159 } 160 161 /** 162 * This is order specific, this method should not be called until after the isDefaultMapping() 163 * method else it will return true for a default mapping. 164 */ 165 private boolean isPathMapping(String mapping) { 166 return mapping.startsWith("/") && mapping.endsWith("/*"); 167 } 168 169 private boolean isExtensionMapping(String mapping) { 170 return mapping.startsWith("*."); 171 } 172 173 private boolean isDefaultMapping(String mapping) { 174 // TODO : default mapping per spec is "/" - do we really want to support this? is there a 175 // point ? 176 return mapping.equals("/"); 177 } 178 179 private boolean isRegexpMapping(String mapping) { 180 return mapping.startsWith("regex:"); 181 } 182 183 /** 184 * Result of {@link ThemeReader} {@link Mapping#match(HttpServletRequest)} method. 185 * @version $Id$ 186 */ 187 public static class MatchingResult { 188 189 Matcher matcher; 190 191 boolean matches; 192 193 int matchingEndPosition; 194 195 public MatchingResult(Matcher matcher, boolean matches, int matchingEndPosition) { 196 this.matcher = matcher; 197 this.matches = matches; 198 this.matchingEndPosition = matchingEndPosition; 199 } 200 201 public Matcher getMatcher() { 202 return matcher; 203 } 204 205 public boolean isMatching() { 206 return matches; 207 } 208 209 public int getMatchingEndPosition() { 210 return matchingEndPosition; 211 } 212 } 213 214 }