/*
* Copyright (c) 2002-2012 Alibaba Group Holding Limited.
* All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.alibaba.citrus.util.regex;
import static com.alibaba.citrus.util.Assert.*;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
/**
* 这个类将一个包含通配符的文件路径, 编译成正则表达式. 格式描述如下:
* <ul>
* <li>合法的<em>文件名字符</em>包括: 字母/数字/下划线/小数点/短横线;</li>
* <li>合法的<em>路径分隔符</em>为斜杠"/";</li>
* <li>"＊"代表0个或多个<em>文件名字符</em>;</li>
* <li>"？"代表1个<em>文件名字符</em>;</li>
* <li>"＊＊"代表0个或多个<em>文件名字符</em>或<em>路径分隔符</em>;</li>
* <li>不能连续出现3个"＊";</li>
* <li>不能连续出现2个<em>路径分隔符</em>;</li>
* <li>"＊＊"的前后只能是<em>路径分隔符</em>.</li>
* </ul>
* <p>
* 转换后的正则表达式, 对每一个通配符建立<em>引用变量</em>, 依次为<code>$1</code>, <code>$2</code>, ...
* </p>
*
* @author Michael Zhou
*/
public class PathNameWildcardCompiler {
/** 强制使用绝对路径 */
public static final int FORCE_ABSOLUTE_PATH = 0x1000;
/** 强制使用相对路径 */
public static final int FORCE_RELATIVE_PATH = 0x2000;
/** 从头匹配 */
public static final int FORCE_MATCH_PREFIX = 0x4000;
// 私有常量
private static final char ESCAPE_CHAR = '\\';
private static final char SLASH = '/';
private static final char UNDERSCORE = '_';
private static final char DASH = '-';
private static final char DOT = '.';
private static final char STAR = '*';
private static final char QUESTION = '?';
private static final String REGEX_MATCH_PREFIX = "^";
private static final String REGEX_WORD_BOUNDARY = "\\b";
private static final String REGEX_SLASH = "\\/";
private static final String REGEX_SLASH_NO_DUP = "\\/(?!\\/)";
private static final String REGEX_FILE_NAME_CHAR = "[\\w\\-\\.]";
private static final String REGEX_FILE_NAME_SINGLE_CHAR = "(" + REGEX_FILE_NAME_CHAR + ")";
private static final String REGEX_FILE_NAME = "(" + REGEX_FILE_NAME_CHAR + "*)";
private static final String REGEX_FILE_PATH = "(" + REGEX_FILE_NAME_CHAR + "+(?:" + REGEX_SLASH_NO_DUP
+ REGEX_FILE_NAME_CHAR + "*)*(?=" + REGEX_SLASH + "|$)|)" + REGEX_SLASH + "?";
private static final String REGEX_END_OF_PATH = "(?=" + REGEX_SLASH + "|$)" + REGEX_SLASH + "?";
// 上一个token的状态
private static final int LAST_TOKEN_START = 0;
private static final int LAST_TOKEN_SLASH = 1;
private static final int LAST_TOKEN_FILE_NAME = 2;
private static final int LAST_TOKEN_STAR = 3;
private static final int LAST_TOKEN_DOUBLE_STAR = 4;
private static final int LAST_TOKEN_QUESTION = 5;
private PathNameWildcardCompiler() {
}
/** 将包含通配符的路径表达式, 编译成正则表达式. */
public static Pattern compilePathName(String pattern) throws PatternSyntaxException {
return compilePathName(pattern, 0);
}
/** 将包含通配符的路径表达式, 编译成正则表达式. */
public static Pattern compilePathName(String pattern, int options) throws PatternSyntaxException {
return Pattern.compile(pathNameToRegex(pattern, options), options);
}
/**
* 取得相关度数值。
* <p>
* 所谓相关度数值，即除去分隔符和通配符以后，剩下的字符长度。
* 相关度数值可用来对匹配结果排序。例如：/a/b/c既匹配/a又匹配/*，但显然前者为更“相关”的匹配。
* </p>
*/
public static int getPathNameRelevancy(String pattern) {
pattern = normalizePathName(pattern);
if (pattern == null) {
return 0;
}
int relevant = 0;
for (int i = 0; i < pattern.length(); i++) {
switch (pattern.charAt(i)) {
case SLASH:
case STAR:
case QUESTION:
continue;
default:
relevant++;
}
}
return relevant;
}
/** 将包含通配符的路径表达式, 转换成正则表达式. */
public static String pathNameToRegex(String pattern, int options) throws PatternSyntaxException {
pattern = assertNotNull(normalizePathName(pattern), "pattern");
int lastToken = LAST_TOKEN_START;
StringBuilder buf = new StringBuilder(pattern.length() * 2);
boolean forceMatchPrefix = (options & FORCE_MATCH_PREFIX) != 0;
boolean forceAbsolutePath = (options & FORCE_ABSOLUTE_PATH) != 0;
boolean forceRelativePath = (options & FORCE_RELATIVE_PATH) != 0;
// 如果第一个字符为slash, 或调用者要求forceMatchPrefix, 则从头匹配
if (forceMatchPrefix || pattern.length() > 0 && pattern.charAt(0) == SLASH) {
buf.append(REGEX_MATCH_PREFIX);
}
// 特殊情况：/看作""
if (pattern.length() == 1 && pattern.charAt(0) == SLASH) {
pattern = "";
}
for (int i = 0; i < pattern.length(); i++) {
char ch = pattern.charAt(i);
if (forceAbsolutePath && lastToken == LAST_TOKEN_START && ch != SLASH) {
throw new PatternSyntaxException("Syntax Error", pattern, i);
}
switch (ch) {
case SLASH:
// slash后面不能是slash, slash不能位于首字符(如果指定了force relative path的话)
if (lastToken == LAST_TOKEN_SLASH) {
throw new PatternSyntaxException("Syntax Error", pattern, i);
} else if (forceRelativePath && lastToken == LAST_TOKEN_START) {
throw new PatternSyntaxException("Syntax Error", pattern, i);
}
// 因为**已经包括了slash, 所以不需要额外地匹配slash
if (lastToken != LAST_TOKEN_DOUBLE_STAR) {
buf.append(REGEX_SLASH_NO_DUP);
}
lastToken = LAST_TOKEN_SLASH;
break;
case STAR:
int j = i + 1;
if (j < pattern.length() && pattern.charAt(j) == STAR) {
i = j;
// **前面只能是slash
if (lastToken != LAST_TOKEN_START && lastToken != LAST_TOKEN_SLASH) {
throw new PatternSyntaxException("Syntax Error", pattern, i);
}
lastToken = LAST_TOKEN_DOUBLE_STAR;
buf.append(REGEX_FILE_PATH);
} else {
// *前面不能是*或**
if (lastToken == LAST_TOKEN_STAR || lastToken == LAST_TOKEN_DOUBLE_STAR) {
throw new PatternSyntaxException("Syntax Error", pattern, i);
}
lastToken = LAST_TOKEN_STAR;
buf.append(REGEX_FILE_NAME);
}
break;
case QUESTION:
if (lastToken == LAST_TOKEN_START) {
buf.append(REGEX_WORD_BOUNDARY).append(REGEX_FILE_NAME_SINGLE_CHAR); // 前边界
} else if (i + 1 == pattern.length()) {
buf.append(REGEX_FILE_NAME_SINGLE_CHAR).append(REGEX_END_OF_PATH); // 后边界
} else {
buf.append(REGEX_FILE_NAME_SINGLE_CHAR);
}
lastToken = LAST_TOKEN_QUESTION;
break;
default:
// **后只能是slash
if (lastToken == LAST_TOKEN_DOUBLE_STAR) {
throw new PatternSyntaxException("Syntax Error", pattern, i);
}
if (Character.isLetterOrDigit(ch) || ch == UNDERSCORE || ch == DASH) {
// 加上word边界, 进行整字匹配
if (lastToken == LAST_TOKEN_START) {
buf.append(REGEX_WORD_BOUNDARY).append(ch); // 前边界
} else if (i + 1 == pattern.length()) {
buf.append(ch).append(REGEX_WORD_BOUNDARY); // 后边界
} else {
buf.append(ch);
}
} else if (ch == DOT) {
buf.append(ESCAPE_CHAR).append(DOT);
} else {
throw new PatternSyntaxException("Syntax Error", pattern, i);
}
lastToken = LAST_TOKEN_FILE_NAME;
}
}
return buf.toString();
}
/**
* 规格化类名。
* <ul>
* <li>除去两端空白</li>
* <li>将"\\"转换成"//"</li>
* <li>将重复的"/"转换成单个的"/"</li>
* </ul>
*/
public static String normalizePathName(String name) {
if (name == null) {
return null;
}
return name.trim().replaceAll("[/\\\\]+", "/");
}
}