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.lang3.StringUtils;
39
40
41 /**
42 * An implementation of URLPattern which matches strings using simple <code>*</code> or <code>?</code> wildcards.
43 */
44 public final class SimpleUrlPattern implements UrlPattern {
45
46 /**
47 * Any char, newline included.
48 */
49 public static final String URL_CHAR_PATTERN = ".";
50
51 /**
52 * Regexp pattern used for the simple keyword <code>*</code>. Matches 0 or more characters.
53 */
54 public static final String MULTIPLE_CHAR_PATTERN = URL_CHAR_PATTERN + "*";
55
56 /**
57 * Regexp pattern used for the simple keyword <code>?</code>. Matches 0 or 1 character.
58 */
59 public static final String SINGLE_CHAR_PATTERN = URL_CHAR_PATTERN + "?";
60
61 /**
62 * Regexp pattern used in match().
63 */
64 private Pattern pattern;
65
66 /**
67 * Pattern length. Longer patterns have higher priority.
68 */
69 private int length;
70
71 /**
72 * internal pattern string.
73 */
74 private String patternString;
75
76 /**
77 * Default constructor used by ContentToBean.
78 */
79 public SimpleUrlPattern() {
80 }
81
82 /**
83 * Compile a regexp pattern handling <code>*</code> and <code>?</code> chars.
84 *
85 * @param string input string
86 */
87 public SimpleUrlPattern(String string) {
88 setPatternString(string);
89 }
90
91 /**
92 * Replace all "*" with <code>RegexWildcardPattern.MULTIPLE_CHAR_PATTERN</code>.
93 *
94 * @param str input string
95 * @return string where all the occurrences of <code>*</code> and <code>?</code> are replaced with a regexp
96 * pattern.
97 */
98 public static String getEncodedString(String str) {
99 final StringBuilder builder = new StringBuilder();
100 char[] chars = str.toCharArray();
101 int i = 0, last = 0;
102 while (i < chars.length) {
103 char c = chars[i];
104 if (c == '*') {
105 builder.append('(');
106 builder.append(chars, last, i - last);
107 builder.append(')');
108 builder.append(MULTIPLE_CHAR_PATTERN);
109 last = i + 1;
110 } else if (c == '?') {
111 builder.append('(');
112 builder.append(chars, last, i - last);
113 builder.append(')');
114 builder.append(SINGLE_CHAR_PATTERN);
115 last = i + 1;
116 }
117 i++;
118 }
119 builder.append(chars, last, i - last);
120 return builder.toString();
121 }
122
123 @Override
124 public boolean match(String str) {
125 return this.pattern.matcher(str).matches();
126 }
127
128 @Override
129 public int getLength() {
130 return this.length;
131 }
132
133 @Override
134 public String getPatternString() {
135 return patternString;
136 }
137
138 /**
139 * Mainly used by ContentToBean.
140 */
141 public void setPatternString(String patternString) {
142 this.length = StringUtils.removeEnd(patternString, "*").length();
143 this.pattern = Pattern.compile(getEncodedString(patternString), Pattern.DOTALL);
144 this.patternString = patternString;
145 }
146
147 @Override
148 public String toString() {
149 // don't use pattern.pattern(), but keep the original string.
150 // The "compiled" pattern will display the ugly patterns like MULTIPLE_CHAR_PATTERN instead of simple *
151 return "SimpleUrlPattern{" + patternString + '}';
152 }
153 }