1 /**
2 * This file Copyright (c) 2003-2015 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 *
44 * TODO rewrite this class using ant-style path comparison and avoiding regexp. See
45 * org.springframework.util.AntPathMatcher in spring 1.2 for a nice implementation.
46 */
47 public final class SimpleUrlPattern implements UrlPattern {
48
49 /**
50 * Any char, newline included.
51 */
52 public static final String URL_CHAR_PATTERN = ".";
53
54 /**
55 * Regexp pattern used for the simple keyword <code>*</code>. Matches 0 or more characters.
56 */
57 public static final String MULTIPLE_CHAR_PATTERN = URL_CHAR_PATTERN + "*";
58
59 /**
60 * Regexp pattern used for the simple keyword <code>?</code>. Matches 0 or 1 character.
61 */
62 public static final String SINGLE_CHAR_PATTERN = URL_CHAR_PATTERN + "?";
63
64 /**
65 * Regexp pattern used in match().
66 */
67 private Pattern pattern;
68
69 /**
70 * Pattern length. Longer patterns have higher priority.
71 */
72 private int length;
73
74 /**
75 * internal pattern string.
76 */
77 private String patternString;
78
79 /**
80 * Default constructor used by ContentToBean.
81 */
82 public SimpleUrlPattern() {
83 }
84
85 /**
86 * Compile a regexp pattern handling <code>*</code> and <code>?</code> chars.
87 * @param string input string
88 * @return a RegExp pattern
89 */
90 public SimpleUrlPattern(String string) {
91 this.length = StringUtils.removeEnd(string, "*").length();
92 this.pattern = Pattern.compile(getEncodedString(string), Pattern.DOTALL);
93 this.patternString = string;
94 }
95
96 /**
97 * Replace all "*" with <code>RegexWildcardPattern.MULTIPLE_CHAR_PATTERN</code>.
98 * @param str input string
99 * @return string where all the occurrences of <code>*</code> and <code>?</code> are replaced with a regexp
100 * pattern.
101 */
102 public static String getEncodedString(String str) {
103 StringBuffer stringBuffer = new StringBuffer();
104 char[] chars = str.toCharArray();
105 int i = 0, last = 0;
106 while (i < chars.length) {
107 char c = chars[i];
108 if (c == '*') {
109 stringBuffer.append('(');
110 stringBuffer.append(chars, last, i - last);
111 stringBuffer.append(')');
112 stringBuffer.append(MULTIPLE_CHAR_PATTERN);
113 last = i + 1;
114 }
115 else if (c == '?') {
116 stringBuffer.append('(');
117 stringBuffer.append(chars, last, i - last);
118 stringBuffer.append(')');
119 stringBuffer.append(SINGLE_CHAR_PATTERN);
120 last = i + 1;
121 }
122 i++;
123 }
124 stringBuffer.append(chars, last, i - last);
125 return stringBuffer.toString();
126 }
127
128 /**
129 * @see info.magnolia.cms.util.UrlPattern#match(java.lang.String)
130 */
131 @Override
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 @Override
140 public int getLength() {
141 return this.length;
142 }
143
144 /**
145 * @see info.magnolia.cms.util.UrlPattern#getString()
146 */
147 @Override
148 public String getPatternString() {
149 return patternString;
150 }
151
152 /**
153 * Mainly used by ContentToBean.
154 */
155 public void setPatternString(String patternString) {
156 this.length = StringUtils.removeEnd(patternString, "*").length();
157 this.pattern = Pattern.compile(getEncodedString(patternString), Pattern.DOTALL);
158 this.patternString = patternString;
159 }
160
161 @Override
162 public String toString() {
163 // don't use pattern.pattern(), but keep the original string.
164 // The "compiled" pattern will display the ugly patterns like MULTIPLE_CHAR_PATTERN instead of simple *
165 return "SimpleUrlPattern{" + patternString + '}';
166 }
167 }