1 /** 2 * This file Copyright (c) 2003-2010 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.util; 35 36 import java.util.regex.Pattern; 37 38 import org.apache.commons.lang.StringUtils; 39 40 41 /** 42 * An implementation of URLPattern which matches strings using simple <code>*</code> or <code>?</code> wildcards. 43 * @author Sameer Charles 44 * @author Fabrizio Giustina 45 * @todo rewrite this class using ant-style path comparison and avoiding regexp. See 46 * org.springframework.util.AntPathMatcher in spring 1.2 for a nice implementation 47 * @version $Revision $ ($Author $) 48 */ 49 public final class SimpleUrlPattern implements UrlPattern { 50 51 /** 52 * Stable serialVersionUID. 53 */ 54 private static final long serialVersionUID = 223L; 55 56 /** 57 * Any char, newline included. 58 */ 59 public static final String URL_CHAR_PATTERN = "."; //$NON-NLS-1$ 60 61 /** 62 * Regexp pattern used for the simple keyword <code>*</code>. Matches 0 or more characters. 63 */ 64 public static final String MULTIPLE_CHAR_PATTERN = URL_CHAR_PATTERN + "*"; //$NON-NLS-1$ 65 66 /** 67 * Regexp pattern used for the simple keyword <code>?</code>. Matches 0 or 1 character. 68 */ 69 public static final String SINGLE_CHAR_PATTERN = URL_CHAR_PATTERN + "?"; //$NON-NLS-1$ 70 71 /** 72 * Regexp pattern used in match(). 73 */ 74 private Pattern pattern; 75 76 /** 77 * Pattern length. Longer patterns have higher priority. 78 */ 79 private int length; 80 81 /** 82 * internal pattern string. 83 */ 84 private String patternString; 85 86 /** 87 * Compile a regexp pattern handling <code>*</code> and <code>?</code> chars. 88 * @param string input string 89 * @return a RegExp pattern 90 */ 91 public SimpleUrlPattern(String string) { 92 this.length = StringUtils.removeEnd(string, "*").length(); 93 this.pattern = Pattern.compile(getEncodedString(string), Pattern.DOTALL); 94 this.patternString = string; 95 } 96 97 /** 98 * Replace all "*" with <code>RegexWildcardPattern.MULTIPLE_CHAR_PATTERN</code>. 99 * @param str input string 100 * @return string where all the occurrences of <code>*</code> and <code>?</code> are replaced with a regexp 101 * pattern. 102 */ 103 public static String getEncodedString(String str) { 104 StringBuffer stringBuffer = new StringBuffer(); 105 char[] chars = str.toCharArray(); 106 int i = 0, last = 0; 107 while (i < chars.length) { 108 char c = chars[i]; 109 if (c == '*') { 110 stringBuffer.append('('); 111 stringBuffer.append(chars, last, i - last); 112 stringBuffer.append(')'); 113 stringBuffer.append(MULTIPLE_CHAR_PATTERN); 114 last = i + 1; 115 } 116 else if (c == '?') { 117 stringBuffer.append('('); 118 stringBuffer.append(chars, last, i - last); 119 stringBuffer.append(')'); 120 stringBuffer.append(SINGLE_CHAR_PATTERN); 121 last = i + 1; 122 } 123 i++; 124 } 125 stringBuffer.append(chars, last, i - last); 126 return stringBuffer.toString(); 127 } 128 129 /** 130 * @see info.magnolia.cms.util.UrlPattern#match(java.lang.String) 131 */ 132 public boolean match(String str) { 133 return this.pattern.matcher(str).matches(); 134 } 135 136 /** 137 * @see info.magnolia.cms.util.UrlPattern#getLength() 138 */ 139 public int getLength() { 140 return this.length; 141 } 142 143 public String toString() { 144 // don't use pattern.pattern(), but keep the original string. 145 // The "compiled" pattern will display the ugly patterns like MULTIPLE_CHAR_PATTERN instead of simple * 146 return "SimpleUrlPattern{" + patternString + '}'; 147 } 148 }