Merge pull request #1365 from ostephens/reg-ex-validator
User-friendly regular expression errors
This commit is contained in:
Jacky
GitHub
commit
38cc4c7743
@ -50,6 +50,7 @@ import com.google.refine.expr.Evaluable;
|
|||||||
import com.google.refine.grel.ast.VariableExpr;
|
import com.google.refine.grel.ast.VariableExpr;
|
||||||
import com.google.refine.model.Column;
|
import com.google.refine.model.Column;
|
||||||
import com.google.refine.model.Project;
|
import com.google.refine.model.Project;
|
||||||
|
import com.google.refine.util.PatternSyntaxExceptionParser;
|
||||||
|
|
||||||
public class TextSearchFacet implements Facet {
|
public class TextSearchFacet implements Facet {
|
||||||
/*
|
/*
|
||||||
@ -106,7 +107,8 @@ public class TextSearchFacet implements Facet {
|
|||||||
_query,
|
_query,
|
||||||
_caseSensitive ? 0 : Pattern.CASE_INSENSITIVE);
|
_caseSensitive ? 0 : Pattern.CASE_INSENSITIVE);
|
||||||
} catch (java.util.regex.PatternSyntaxException e) {
|
} catch (java.util.regex.PatternSyntaxException e) {
|
||||||
throw new JSONException(e);
|
PatternSyntaxExceptionParser err = new PatternSyntaxExceptionParser(e);
|
||||||
|
throw new JSONException(err.getUserMessage());
|
||||||
}
|
}
|
||||||
} else if (!_caseSensitive) {
|
} else if (!_caseSensitive) {
|
||||||
_query = _query.toLowerCase();
|
_query = _query.toLowerCase();
|
||||||
|
|||||||
@ -0,0 +1,125 @@
|
|||||||
|
/*
|
||||||
|
|
||||||
|
Copyright 2017, Owen Stephens.
|
||||||
|
All rights reserved.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without
|
||||||
|
modification, are permitted provided that the following conditions are
|
||||||
|
met:
|
||||||
|
|
||||||
|
* Redistributions of source code must retain the above copyright
|
||||||
|
notice, this list of conditions and the following disclaimer.
|
||||||
|
* Redistributions in binary form must reproduce the above
|
||||||
|
copyright notice, this list of conditions and the following disclaimer
|
||||||
|
in the documentation and/or other materials provided with the
|
||||||
|
distribution.
|
||||||
|
* Neither the name of the copyright holder nor the names of its
|
||||||
|
contributors may be used to endorse or promote products derived from
|
||||||
|
this software without specific prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
package com.google.refine.util;
|
||||||
|
|
||||||
|
import java.util.regex.PatternSyntaxException;
|
||||||
|
|
||||||
|
public class PatternSyntaxExceptionParser {
|
||||||
|
/* Class to translate PatternSyntaxExceptions into more user friendly error messages
|
||||||
|
Currently translates the following error messages from java.util.regex.Pattern
|
||||||
|
"Unclosed character class"
|
||||||
|
"Unmatched closing ')'"
|
||||||
|
"Unexpected internal error"
|
||||||
|
"Dangling meta character '" + ((char)ch) + "'"
|
||||||
|
"Unclosed counted closure"
|
||||||
|
"Illegal repetition"
|
||||||
|
"Illegal repetition range"
|
||||||
|
"Illegal character range"
|
||||||
|
|
||||||
|
The following messages are not currently translated and are output as per PatternSyntaxException
|
||||||
|
"\\k is not followed by '<' for named capturing group"
|
||||||
|
"(named capturing group <"+ name+"> does not exist"
|
||||||
|
"Illegal/unsupported escape sequence"
|
||||||
|
"Bad class syntax"
|
||||||
|
"Unexpected character '"+((char)ch)+"'"
|
||||||
|
"Unclosed character family"
|
||||||
|
"Empty character family"
|
||||||
|
"Unknown Unicode property {name=<" + name + ">, "+ "value=<" + value + ">}"
|
||||||
|
"Unknown character script name {" + name + "}"
|
||||||
|
"Unknown character block name {" + name + "}"
|
||||||
|
"Unknown character property name {" + name + "}"
|
||||||
|
"named capturing group has 0 length name"
|
||||||
|
"named capturing group is missing trailing '>'"
|
||||||
|
"Named capturing group <" + name + "> is already defined"
|
||||||
|
"Look-behind group does not have " + "an obvious maximum length"
|
||||||
|
"Unknown look-behind group"
|
||||||
|
"Unknown group type"
|
||||||
|
"Unknown inline modifier"
|
||||||
|
"Internal logic error"
|
||||||
|
"Illegal control escape sequence"
|
||||||
|
"Illegal octal escape sequence"
|
||||||
|
"Hexadecimal codepoint is too big"
|
||||||
|
"Unclosed hexadecimal escape sequence"
|
||||||
|
"Illegal hexadecimal escape sequence"
|
||||||
|
"Illegal Unicode escape sequence"
|
||||||
|
*/
|
||||||
|
private final PatternSyntaxException exception;
|
||||||
|
|
||||||
|
public PatternSyntaxExceptionParser(PatternSyntaxException e) {
|
||||||
|
this.exception = e;
|
||||||
|
}
|
||||||
|
|
||||||
|
public String getUserMessage() {
|
||||||
|
String msg = "";
|
||||||
|
String desc = exception.getDescription();
|
||||||
|
switch(desc)
|
||||||
|
{
|
||||||
|
case "Unclosed character class":
|
||||||
|
msg = "The regular expression is missing a closing ']' character, or has an empty pair of square brackets '[]'.";
|
||||||
|
break;
|
||||||
|
case "Unmatched closing ')'":
|
||||||
|
msg = "The regular expression is missing a opening '(' character.";
|
||||||
|
break;
|
||||||
|
case "Unclosed group":
|
||||||
|
msg = "The regular expression is missing a closing ')' character.";
|
||||||
|
break;
|
||||||
|
case "Dangling meta character '*'":
|
||||||
|
case "Dangling meta character '+'":
|
||||||
|
case "Dangling meta character '?'":
|
||||||
|
msg = "The regular expression has a '*','+' or '?' in the wrong place.";
|
||||||
|
break;
|
||||||
|
case "Unexpected internal error":
|
||||||
|
msg = "The regular expression has a backslash '\\' at the end.";
|
||||||
|
break;
|
||||||
|
case "Unclosed counted closure":
|
||||||
|
msg = "The regular expression is missing a closing '}' character, or has an incorrect quantifier statement in curly brackets '{}'.";
|
||||||
|
break;
|
||||||
|
case "Illegal repetition":
|
||||||
|
msg = "The regular expression has an incomplete or incorrect quantifier statement in curly brackets '{}'.";
|
||||||
|
break;
|
||||||
|
case "Illegal repetition range":
|
||||||
|
msg = "The regular expression has a quantifier statement where the minimum is larger than the maximum (e.g. {4,3}).";
|
||||||
|
break;
|
||||||
|
case "Illegal character range":
|
||||||
|
msg = "The regular expression has a range statement which is incomplete or has the characters in the incorrect order (e.g. [9-0])";
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
// If no special handling in place fall back on error msg
|
||||||
|
// created by java.util.regex.PatternSyntaxException
|
||||||
|
msg = exception.getMessage();
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
return msg;
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,169 @@
|
|||||||
|
/*
|
||||||
|
|
||||||
|
Copyright 2017, Owen Stephens.
|
||||||
|
All rights reserved.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without
|
||||||
|
modification, are permitted provided that the following conditions are
|
||||||
|
met:
|
||||||
|
|
||||||
|
* Redistributions of source code must retain the above copyright
|
||||||
|
notice, this list of conditions and the following disclaimer.
|
||||||
|
* Redistributions in binary form must reproduce the above
|
||||||
|
copyright notice, this list of conditions and the following disclaimer
|
||||||
|
in the documentation and/or other materials provided with the
|
||||||
|
distribution.
|
||||||
|
* Neither the name of the copyright holder nor the names of its
|
||||||
|
contributors may be used to endorse or promote products derived from
|
||||||
|
this software without specific prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
package com.google.refine.tests.util;
|
||||||
|
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
import org.testng.Assert;
|
||||||
|
import org.testng.annotations.BeforeTest;
|
||||||
|
import org.testng.annotations.Test;
|
||||||
|
|
||||||
|
import java.util.regex.Pattern;
|
||||||
|
import java.util.regex.PatternSyntaxException;
|
||||||
|
|
||||||
|
import com.google.refine.tests.RefineTest;
|
||||||
|
import com.google.refine.util.PatternSyntaxExceptionParser;
|
||||||
|
|
||||||
|
public class PatternSyntaxExceptionParserTests extends RefineTest {
|
||||||
|
|
||||||
|
@Override
|
||||||
|
@BeforeTest
|
||||||
|
public void init() {
|
||||||
|
logger = LoggerFactory.getLogger(this.getClass());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void unmatchedOpeningParenthesisTest(){
|
||||||
|
String s = "(abc";
|
||||||
|
try {
|
||||||
|
Pattern.compile(s);
|
||||||
|
Assert.assertTrue(false,"Test pattern successfully compiled when it should fail");
|
||||||
|
} catch (PatternSyntaxException err) {
|
||||||
|
PatternSyntaxExceptionParser e = new PatternSyntaxExceptionParser(err);
|
||||||
|
Assert.assertEquals(e.getUserMessage(),
|
||||||
|
"The regular expression is missing a closing ')' character.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void unmatchedClosingParenthesisTest(){
|
||||||
|
String s = "abc)";
|
||||||
|
try {
|
||||||
|
Pattern.compile(s);
|
||||||
|
Assert.assertTrue(false,"Test pattern successfully compiled when it should fail");
|
||||||
|
} catch (PatternSyntaxException err) {
|
||||||
|
PatternSyntaxExceptionParser e = new PatternSyntaxExceptionParser(err);
|
||||||
|
Assert.assertEquals(e.getUserMessage(),
|
||||||
|
"The regular expression is missing a opening '(' character.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void unmatchedOpeningSquareBracketTest(){
|
||||||
|
String s = "[abc";
|
||||||
|
try {
|
||||||
|
Pattern.compile(s);
|
||||||
|
} catch (PatternSyntaxException err) {
|
||||||
|
PatternSyntaxExceptionParser e = new PatternSyntaxExceptionParser(err);
|
||||||
|
Assert.assertEquals(e.getUserMessage(),
|
||||||
|
"The regular expression is missing a closing ']' character, or has an empty pair of square brackets '[]'.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void danglingBackslashTest(){
|
||||||
|
String s = "abc\\";
|
||||||
|
try {
|
||||||
|
Pattern.compile(s);
|
||||||
|
Assert.assertTrue(false,"Test pattern successfully compiled when it should fail");
|
||||||
|
} catch (PatternSyntaxException err) {
|
||||||
|
PatternSyntaxExceptionParser e = new PatternSyntaxExceptionParser(err);
|
||||||
|
Assert.assertEquals(e.getUserMessage(),
|
||||||
|
"The regular expression has a backslash '\\' at the end.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void unmatchedOpeningCurlyBracketTest(){
|
||||||
|
String s = "abc{3";
|
||||||
|
try {
|
||||||
|
Pattern.compile(s);
|
||||||
|
} catch (PatternSyntaxException err) {
|
||||||
|
PatternSyntaxExceptionParser e = new PatternSyntaxExceptionParser(err);
|
||||||
|
Assert.assertEquals(e.getUserMessage(),
|
||||||
|
"The regular expression is missing a closing '}' character, or has an incorrect quantifier statement in curly brackets '{}'.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void illegalQuantifierStatement(){
|
||||||
|
String s = "abc{";
|
||||||
|
try {
|
||||||
|
Pattern.compile(s);
|
||||||
|
} catch (PatternSyntaxException err) {
|
||||||
|
PatternSyntaxExceptionParser e = new PatternSyntaxExceptionParser(err);
|
||||||
|
Assert.assertEquals(e.getUserMessage(),
|
||||||
|
"The regular expression has an incomplete or incorrect quantifier statement in curly brackets '{}'.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void quantifierTargetValidityTest(){
|
||||||
|
String s = "abc+*";
|
||||||
|
try {
|
||||||
|
Pattern.compile(s);
|
||||||
|
Assert.assertTrue(false,"Test pattern successfully compiled when it should fail");
|
||||||
|
} catch (PatternSyntaxException err) {
|
||||||
|
PatternSyntaxExceptionParser e = new PatternSyntaxExceptionParser(err);
|
||||||
|
Assert.assertEquals(e.getUserMessage(),
|
||||||
|
"The regular expression has a '*','+' or '?' in the wrong place.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void quantifierMagnitudeTest(){
|
||||||
|
String s = "a{4,3}";
|
||||||
|
try {
|
||||||
|
Pattern.compile(s);
|
||||||
|
Assert.assertTrue(false,"Test pattern successfully compiled when it should fail");
|
||||||
|
} catch (PatternSyntaxException err) {
|
||||||
|
PatternSyntaxExceptionParser e = new PatternSyntaxExceptionParser(err);
|
||||||
|
Assert.assertEquals(e.getUserMessage(),
|
||||||
|
"The regular expression has a quantifier statement where the minimum is larger than the maximum (e.g. {4,3}).");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void rangeOrderTest(){
|
||||||
|
String s = "abc[9-0]";
|
||||||
|
try {
|
||||||
|
Pattern.compile(s);
|
||||||
|
Assert.assertTrue(false,"Test pattern successfully compiled when it should fail");
|
||||||
|
} catch (PatternSyntaxException err) {
|
||||||
|
PatternSyntaxExceptionParser e = new PatternSyntaxExceptionParser(err);
|
||||||
|
Assert.assertEquals(e.getUserMessage(),
|
||||||
|
"The regular expression has a range statement which is incomplete or has the characters in the incorrect order (e.g. [9-0])");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue
Block a user