/*
Copyright (c) 2012 LinkedIn Corp.
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.
*/
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
/**
* LinkedIn elects to include this software in this distribution under the CDDL license.
*
* Modifications:
* Repackaged original source under com.linkedin.jersey package.
* Added JavaDoc documentation to conform to Pegasus style guidelines
*/
package com.linkedin.jersey.api.uri;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
/**
* A URI template parser that parses JAX-RS specific URI templates.
*
* @author Paul.Sandoz@Sun.Com
*/
public class UriTemplateParser {
/* package */ static final int[] EMPTY_INT_ARRAY = new int[0];
private static Set<Character> RESERVED_REGEX_CHARACTERS = createReserved();
private static Set<Character> createReserved() {
// TODO need to escape all regex characters present
char[] reserved = {
'.',
'?',
'(',
')'};
Set<Character> s = new HashSet<Character>(reserved.length);
for (char c : reserved) s.add(c);
return s;
}
private static final Pattern TEMPLATE_VALUE_PATTERN = Pattern.compile("[^/]+?");
private interface CharacterIterator {
boolean hasNext();
char next();
char peek();
int pos();
}
private static final class StringCharacterIterator implements CharacterIterator {
int pos;
String s;
public StringCharacterIterator(String s) {
this.s = s;
}
public boolean hasNext() {
return pos < s.length();
}
public char next() {
if (!hasNext())
throw new NoSuchElementException();
return s.charAt(pos++);
}
public char peek() {
if (!hasNext())
throw new NoSuchElementException();
return s.charAt(pos++);
}
public int pos() {
if (pos == 0) return 0;
return pos - 1;
}
}
private final String template;
private final StringBuffer regex = new StringBuffer();;
private final StringBuffer normalizedTemplate = new StringBuffer();;
private final StringBuffer literalCharactersBuffer = new StringBuffer();;
private int numOfExplicitRegexes;
private int literalCharacters;
private final Pattern pattern;
private final List<String> names = new ArrayList<String>();
private final List<Integer> groupCounts = new ArrayList<Integer>();
private final Map<String, Pattern> nameToPattern = new HashMap<String, Pattern>();
/**
* Parse a template.
*
* @param template the template.
* @throws IllegalArgumentException if the template is null, an empty string
* or does not conform to a JAX-RS URI template.
*/
public UriTemplateParser(String template) throws IllegalArgumentException {
if (template == null || template.length() == 0)
throw new IllegalArgumentException();
this.template = template;
parse(new StringCharacterIterator(template));
try {
pattern = Pattern.compile(regex.toString());
} catch (PatternSyntaxException ex) {
throw new IllegalArgumentException("Invalid syntax for the template expression '" +
regex + "'",
ex);
}
}
/**
* Get the template.
*
* @return the template.
*/
public final String getTemplate() {
return template;
}
/**
* Get the pattern.
*
* @return the pattern.
*/
public final Pattern getPattern() {
return pattern;
}
/**
* Get the normalized template.
* <p>
* A normalized template is a template without any explicit regular
* expressions.
*
* @return the normalized template.
*/
public final String getNormalizedTemplate() {
return normalizedTemplate.toString();
}
/**
* Get the map of template names to patterns.
*
* @return the map of template names to patterns.
*/
public final Map<String, Pattern> getNameToPattern() {
return nameToPattern;
}
/**
* Get the list of template names.
*
* @return the list of template names.
*/
public final List<String> getNames() {
return names;
}
/**
* Get the capturing group counts for each template variable.
*
* @return the capturing group counts.
*/
public final List<Integer> getGroupCounts() {
return groupCounts;
}
/**
* Get the group indexes to capturing groups.
* <p>
* Any nested capturing groups will be ignored and the
* the group index will refer to the top-level capturing
* groups associated with the templates variables.
*
* @return the group indexes to capturing groups.
*/
public final int[] getGroupIndexes() {
if (names.isEmpty()) return EMPTY_INT_ARRAY;
int[] indexes = new int[names.size() + 1];
indexes[0] = 1;
for (int i = 1; i < indexes.length; i++) {
indexes[i] = indexes[i - 1] + groupCounts.get(i - 1);
}
for (int i = 0; i < indexes.length; i++) {
if (indexes[i] != i + 1)
return indexes;
}
return EMPTY_INT_ARRAY;
}
/**
* Get the number of explicit regular expressions.
*
* @return the number of explicit regular expressions.
*/
public final int getNumberOfExplicitRegexes() {
return numOfExplicitRegexes;
}
/**
* Get the number of literal characters.
*
* @return the number of literal characters.
*/
public final int getNumberOfLiteralCharacters() {
return literalCharacters;
}
/**
* Encode literal characters of a template.
*
* @param literalCharacters the literal characters
* @return the encoded literal characters.
*/
protected String encodeLiteralCharacters(String literalCharacters) {
return literalCharacters;
}
private void parse(CharacterIterator ci) {
try {
while (ci.hasNext()) {
char c = ci.next();
if (c == '{') {
processLiteralCharacters();
parseName(ci);
} else {
literalCharactersBuffer.append(c);
}
}
processLiteralCharacters();
} catch (NoSuchElementException ex) {
throw new IllegalArgumentException(
"Invalid syntax for the template, \"" + template +
"\". Check if a path parameter is terminated with a '}'.",
ex);
}
}
private void processLiteralCharacters() {
if (literalCharactersBuffer.length() > 0) {
literalCharacters += literalCharactersBuffer.length();
String s = encodeLiteralCharacters(literalCharactersBuffer.toString());
normalizedTemplate.append(s);
// Escape if reserved regex character
for (int i = 0; i < s.length(); i++) {
char c = s.charAt(i);
if (RESERVED_REGEX_CHARACTERS.contains(c))
regex.append("\\");
regex.append(c);
}
literalCharactersBuffer.setLength(0);
}
}
private void parseName(CharacterIterator ci) {
char c = consumeWhiteSpace(ci);
StringBuffer nameBuffer = new StringBuffer();
if (Character.isLetterOrDigit(c) || c == '_') {
// Template name character
nameBuffer.append(c);
} else {
throw new IllegalArgumentException("Illegal character '" + c +
"' at position " + ci.pos() + " is not as the start of a name");
}
String nameRegexString = "";
while(true) {
c = ci.next();
// "\\{(\\w[-\\w\\.]*)
if (Character.isLetterOrDigit(c) || c == '_' || c == '-' || c == '.') {
// Template name character
nameBuffer.append(c);
} else if (c == ':') {
nameRegexString = parseRegex(ci);
break;
} else if (c == '}') {
break;
} else if (c == ' ') {
c = consumeWhiteSpace(ci);
if (c == ':') {
nameRegexString = parseRegex(ci);
break;
} else if (c == '}') {
break;
} else {
// Error
throw new IllegalArgumentException("Illegal character '" + c +
"' at position " + ci.pos() + " is not allowed after a name");
}
} else {
throw new IllegalArgumentException("Illegal character '" + c +
"' at position " + ci.pos() + " is not allowed as part of a name");
}
}
String name = nameBuffer.toString();
names.add(name);
try {
if (nameRegexString.length() > 0)
numOfExplicitRegexes++;
Pattern namePattern = (nameRegexString.length() == 0)
? TEMPLATE_VALUE_PATTERN : Pattern.compile(nameRegexString);
if (nameToPattern.containsKey(name)) {
if (!nameToPattern.get(name).equals(namePattern)) {
throw new IllegalArgumentException("The name '" + name +
"' is declared " +
"more than once with different regular expressions");
}
} else {
nameToPattern.put(name, namePattern);
}
// Determine group count of pattern
Matcher m = namePattern.matcher("");
int g = m.groupCount();
groupCounts.add(g + 1);
regex.append('(').
append(namePattern).
append(')');
normalizedTemplate.append('{').
append(name).
append('}');
} catch (PatternSyntaxException ex) {
throw new IllegalArgumentException("Invalid syntax for the expression '" + nameRegexString +
"' associated with the name '" + name + "'",
ex);
}
}
private String parseRegex(CharacterIterator ci) {
StringBuffer regexBuffer = new StringBuffer();
int braceCount = 1;
while (true) {
char c = ci.next();
if (c == '{') {
braceCount++;
} else if (c == '}') {
braceCount--;
if (braceCount == 0)
break;
}
regexBuffer.append(c);
}
return regexBuffer.toString().trim();
}
private char consumeWhiteSpace(CharacterIterator ci) {
char c = ci.next();
// Consume white space;
// TODO use correct c
while (c == ' ') c = ci.next();
return c;
}
}