Skip to content

Commit 59bb9a4

Browse files
manticore-projectsmanticore-projects
authored
Unsupported statement (#1519)
* Adjust Gradle to JUnit 5 Parallel Test execution Gradle Caching Explicitly request for latest JavaCC 7.0.10 * Do not mark SpeedTest for concurrent execution * Remove unused imports * Adjust Gradle to JUnit 5 Parallel Test execution Gradle Caching Explicitly request for latest JavaCC 7.0.10 * Do not mark SpeedTest for concurrent execution * Remove unused imports * Adjust Gradle to JUnit 5 Parallel Test execution Gradle Caching Explicitly request for latest JavaCC 7.0.10 * Do not mark SpeedTest for concurrent execution * Remove unused imports * Adjust Gradle to JUnit 5 Parallel Test execution Gradle Caching Explicitly request for latest JavaCC 7.0.10 * Do not mark SpeedTest for concurrent execution * Remove unused imports * Implement UnsupportedStatement - Add Feature allowUnsupportedStatement, default=false - Fully implement UnsupportedStatement for the Statement() production - Partially implement UnsupportedStatement for the Statements() production, works only when UnsupportedStatement comes first * Revert unintended changes of the test resources * Reformat BLOCK production Disable STATEMENTS() test, which will never fail and add comments to this regard
1 parent 41a640a commit 59bb9a4

File tree

13 files changed

+247
-18
lines changed

13 files changed

+247
-18
lines changed

‎src/main/java/net/sf/jsqlparser/parser/AbstractJSqlParser.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ public P withSquareBracketQuotation(boolean allowSquareBracketQuotation) {
2828
public P withAllowComplexParsing(boolean allowComplexParsing) {
2929
return withFeature(Feature.allowComplexParsing, allowComplexParsing);
3030
}
31+
32+
public P withUnsupportedStatements(boolean allowUnsupportedStatements) {
33+
return withFeature(Feature.allowUnsupportedStatements, allowUnsupportedStatements);
34+
}
35+
3136
public P withFeature(Feature f, boolean enabled) {
3237
getConfiguration().setValue(f, enabled);
3338
return me();

‎src/main/java/net/sf/jsqlparser/parser/CCJSqlParserUtil.java

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,16 +271,31 @@ public Statement call() throws Exception {
271271
* @return the statements parsed
272272
*/
273273
public static Statements parseStatements(String sqls) throws JSQLParserException {
274+
return parseStatements(sqls, null);
275+
}
276+
277+
/**
278+
* Parse a statement list.
279+
*
280+
* @return the statements parsed
281+
*/
282+
public static Statements parseStatements(String sqls, Consumer<CCJSqlParser> consumer) throws JSQLParserException {
274283
Statements statements = null;
275284

276285
// first, try to parse fast and simple
277286
try {
278287
CCJSqlParser parser = newParser(sqls).withAllowComplexParsing(false);
288+
if (consumer != null) {
289+
consumer.accept(parser);
290+
}
279291
statements = parseStatements(parser);
280292
} catch (JSQLParserException ex) {
281293
// when fast simple parsing fails, try complex parsing but only if it has a chance to succeed
282294
if (getNestingDepth(sqls)<=ALLOWED_NESTING_DEPTH) {
283295
CCJSqlParser parser = newParser(sqls).withAllowComplexParsing(true);
296+
if (consumer != null) {
297+
consumer.accept(parser);
298+
}
284299
statements = parseStatements(parser);
285300
}
286301
}

‎src/main/java/net/sf/jsqlparser/parser/feature/Feature.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -725,7 +725,13 @@ public enum Feature {
725725
* allows complex expression parameters or named parameters for functions
726726
* will be switched off, when deep nesting of functions is detected
727727
*/
728-
allowComplexParsing(true)
728+
allowComplexParsing(true),
729+
730+
/**
731+
* allows passing through Unsupported Statements as a plain List of Tokens
732+
* needs to be switched off, when VALIDATING statements or parsing blocks
733+
*/
734+
allowUnsupportedStatements(false),
729735
;
730736

731737
private Object value;

‎src/main/java/net/sf/jsqlparser/statement/StatementVisitor.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,4 +120,6 @@ public interface StatementVisitor {
120120
void visit(PurgeStatement purgeStatement);
121121

122122
void visit(AlterSystemStatement alterSystemStatement);
123+
124+
void visit(UnsupportedStatement unsupportedStatement);
123125
}

‎src/main/java/net/sf/jsqlparser/statement/StatementVisitorAdapter.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,4 +234,9 @@ public void visit(PurgeStatement purgeStatement) {
234234
@Override
235235
public void visit(AlterSystemStatement alterSystemStatement) {
236236
}
237+
238+
@Override
239+
public void visit(UnsupportedStatement unsupportedStatement) {
240+
241+
}
237242
}

‎src/main/java/net/sf/jsqlparser/statement/UnsupportedStatement.java

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
/*-
2+
* #%L
3+
* JSQLParser library
4+
* %%
5+
* Copyright (C) 2004 - 2021 JSQLParser
6+
* %%
7+
* Dual licensed under GNU LGPL 2.1 or Apache License 2.0
8+
* #L%
9+
*/
10+
11+
package net.sf.jsqlparser.statement;
12+
13+
import java.util.List;
14+
import java.util.Objects;
15+
16+
/**
17+
*
18+
* @author <a href="mailto:andreas@manticore-projects.com">Andreas Reichel</a>
19+
*/
20+
21+
public class UnsupportedStatement implements Statement {
22+
private List<String> declarations;
23+
24+
public UnsupportedStatement(List<String> declarations) {
25+
this.declarations = Objects.requireNonNull(declarations, "The List of Tokens must not be null.");
26+
}
27+
28+
@Override
29+
public void accept(StatementVisitor statementVisitor) {
30+
statementVisitor.visit(this);
31+
}
32+
33+
@SuppressWarnings({"PMD.MissingBreakInSwitch", "PMD.SwitchStmtsShouldHaveDefault", "PMD.CyclomaticComplexity"})
34+
public StringBuilder appendTo(StringBuilder builder) {
35+
int i=0;
36+
for (String s:declarations) {
37+
if (i>0) {
38+
builder.append(" ");
39+
}
40+
builder.append(s);
41+
i++;
42+
}
43+
return builder;
44+
}
45+
46+
@Override
47+
public String toString() {
48+
return appendTo(new StringBuilder()).toString();
49+
}
50+
51+
public boolean isEmpty() {
52+
return declarations.isEmpty();
53+
}
54+
}

‎src/main/java/net/sf/jsqlparser/util/TablesNamesFinder.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1032,6 +1032,11 @@ public void visit(AlterSystemStatement alterSystemStatement) {
10321032
// no tables involved in this statement
10331033
}
10341034

1035+
@Override
1036+
public void visit(UnsupportedStatement unsupportedStatement) {
1037+
// no tables involved in this statement
1038+
}
1039+
10351040
@Override
10361041
public void visit(GeometryDistance geometryDistance) {
10371042
visitBinaryExpression(geometryDistance);

‎src/main/java/net/sf/jsqlparser/util/deparser/StatementDeParser.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
import net.sf.jsqlparser.statement.Statement;
3030
import net.sf.jsqlparser.statement.StatementVisitor;
3131
import net.sf.jsqlparser.statement.Statements;
32+
import net.sf.jsqlparser.statement.UnsupportedStatement;
3233
import net.sf.jsqlparser.statement.UseStatement;
3334
import net.sf.jsqlparser.statement.alter.Alter;
3435
import net.sf.jsqlparser.statement.alter.AlterSession;
@@ -373,4 +374,9 @@ public void visit(PurgeStatement purgeStatement) {
373374
public void visit(AlterSystemStatement alterSystemStatement) {
374375
alterSystemStatement.appendTo(buffer);
375376
}
377+
378+
@Override
379+
public void visit(UnsupportedStatement unsupportedStatement) {
380+
unsupportedStatement.appendTo(buffer);
381+
}
376382
}

‎src/main/java/net/sf/jsqlparser/util/validation/validator/StatementValidator.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
import net.sf.jsqlparser.statement.Statement;
2828
import net.sf.jsqlparser.statement.StatementVisitor;
2929
import net.sf.jsqlparser.statement.Statements;
30+
import net.sf.jsqlparser.statement.UnsupportedStatement;
3031
import net.sf.jsqlparser.statement.UseStatement;
3132
import net.sf.jsqlparser.statement.alter.Alter;
3233
import net.sf.jsqlparser.statement.alter.AlterSession;
@@ -303,4 +304,9 @@ public void visit(PurgeStatement purgeStatement) {
303304
public void visit(AlterSystemStatement alterSystemStatement) {
304305
//TODO: not yet implemented
305306
}
307+
308+
@Override
309+
public void visit(UnsupportedStatement unsupportedStatement) {
310+
311+
}
306312
}

‎src/main/jjtree/net/sf/jsqlparser/parser/JSqlParserCC.jjt

Lines changed: 71 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,7 @@ Statement Statement() #Statement:
508508
stm = SingleStatement() { ifElseStatement = new IfElseStatement(condition, stm); }
509509
[ <ST_SEMICOLON> { ifElseStatement.setUsingSemicolonForIfStatement(true); } ]
510510
[ LOOKAHEAD(2)
511-
<K_ELSE> stm2 = SingleStatement() { ifElseStatement.setElseStatement(stm2); }
511+
<K_ELSE> stm2 = SingleStatement() { ifElseStatement.setElseStatement(stm2); }
512512
[ <ST_SEMICOLON> { ifElseStatement.setUsingSemicolonForElseStatement(true); }]
513513
]
514514
<EOF>
@@ -519,6 +519,8 @@ Statement Statement() #Statement:
519519
[ <ST_SEMICOLON> ]
520520
<EOF>
521521
)
522+
|
523+
LOOKAHEAD( { getAsBoolean(Feature.allowUnsupportedStatements) } ) stm = UnsupportedStatement()
522524
} catch (ParseException e) {
523525
if (errorRecovery) {
524526
parseErrors.add(e);
@@ -655,10 +657,27 @@ Block Block() #Block : {
655657
}
656658
{
657659
<K_BEGIN>
658-
(<ST_SEMICOLON>)*
660+
(<ST_SEMICOLON>)*
659661
try {
660-
(stm = SingleStatement() | stm = Block()) { list.add(stm); } <ST_SEMICOLON>
661-
( (stm = SingleStatement() | stm = Block()) <ST_SEMICOLON> { list.add(stm); } )*
662+
(
663+
(
664+
stm = SingleStatement()
665+
| stm = Block()
666+
)
667+
<ST_SEMICOLON>
668+
{ list.add(stm); }
669+
)
670+
671+
(
672+
(
673+
(
674+
stm = SingleStatement()
675+
| stm = Block()
676+
)
677+
<ST_SEMICOLON>
678+
{ list.add(stm); }
679+
)
680+
)*
662681
} catch (ParseException e) {
663682
if (errorRecovery) {
664683
parseErrors.add(e);
@@ -667,11 +686,13 @@ Block Block() #Block : {
667686
throw e;
668687
}
669688
}
689+
670690
{
671691
stmts.setStatements(list);
672692
block.setStatements(stmts);
673693
}
674-
<K_END>
694+
695+
<K_END> [LOOKAHEAD(2) <ST_SEMICOLON>]
675696
{
676697
return block;
677698
}
@@ -707,33 +728,40 @@ Statements Statements() #Statements : {
707728

708729
[ LOOKAHEAD(2) <ST_SEMICOLON> ]
709730
) { list.add(stm); }
731+
|
732+
LOOKAHEAD( { getAsBoolean(Feature.allowUnsupportedStatements) } ) stm = UnsupportedStatement()
733+
{ if ( !((UnsupportedStatement) stm).isEmpty() ) list.add(stm); }
710734
)
711735

712-
713-
(
714-
<ST_SEMICOLON> { if (stm2!=null)
715-
ifElseStatement.setUsingSemicolonForElseStatement(true);
716-
else if (ifElseStatement!=null)
717-
ifElseStatement.setUsingSemicolonForIfStatement(true); }
736+
(
737+
<ST_SEMICOLON> { if (stm2!=null)
738+
ifElseStatement.setUsingSemicolonForElseStatement(true);
739+
else if (ifElseStatement!=null)
740+
ifElseStatement.setUsingSemicolonForIfStatement(true); }
718741
[
719742
(
720-
<K_IF> condition=Condition()
743+
<K_IF> condition=Condition()
721744
stm = SingleStatement() { ifElseStatement = new IfElseStatement(condition, stm); }
722-
[ LOOKAHEAD(2)
745+
[ LOOKAHEAD(2)
723746
[ <ST_SEMICOLON> { ifElseStatement.setUsingSemicolonForIfStatement(true); } ]
724-
<K_ELSE> stm2 = SingleStatement() { ifElseStatement.setElseStatement(stm2); }
747+
<K_ELSE> stm2 = SingleStatement() { ifElseStatement.setElseStatement(stm2); }
725748
]
726749

727750
{ list.add( ifElseStatement ); }
728751
)
729752
|
730753
(
731-
stm = SingleStatement()
754+
stm = SingleStatement()
732755
| stm = Block()
733756

734757
[ LOOKAHEAD(2) <ST_SEMICOLON> ]
735758
) { list.add(stm); }
736-
]
759+
|
760+
// For any reason, we can't LOOKAHEAD( { getAsBoolean(Feature.allowUnsupportedStatements) } ) here
761+
// As it will result in a Stack Overflow
762+
stm = UnsupportedStatement()
763+
{ if ( !((UnsupportedStatement) stm).isEmpty() ) list.add(stm); }
764+
]
737765
)*
738766
<EOF>
739767
} catch (ParseException e) {
@@ -6288,6 +6316,17 @@ Synonym Synonym() #Synonym :
62886316
}
62896317
}
62906318

6319+
UnsupportedStatement UnsupportedStatement():
6320+
{
6321+
List<String> tokens = new LinkedList<String>();
6322+
}
6323+
{
6324+
tokens=captureUnsupportedStatementDeclaration()
6325+
{
6326+
return new UnsupportedStatement(tokens);
6327+
}
6328+
}
6329+
62916330
JAVACODE
62926331
List<String> captureRest() {
62936332
List<String> tokens = new LinkedList<String>();
@@ -6302,3 +6341,19 @@ List<String> captureRest() {
63026341
}
63036342
return tokens;
63046343
}
6344+
6345+
JAVACODE
6346+
List<String> captureUnsupportedStatementDeclaration() {
6347+
List<String> tokens = new LinkedList<String>();
6348+
Token tok;
6349+
6350+
while(true) {
6351+
tok = getToken(1);
6352+
if( tok.kind == EOF || tok.kind== ST_SEMICOLON || tok.kind== K_END ) {
6353+
break;
6354+
}
6355+
tokens.add(tok.image);
6356+
tok = getNextToken();
6357+
}
6358+
return tokens;
6359+
}

‎src/test/java/net/sf/jsqlparser/parser/CCJSqlParserUtilTest.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@
2626
import static org.junit.jupiter.api.Assertions.assertEquals;
2727
import static org.junit.jupiter.api.Assertions.assertThrows;
2828
import static org.junit.jupiter.api.Assertions.assertTrue;
29+
30+
import org.junit.jupiter.api.Disabled;
2931
import org.junit.jupiter.api.Test;
3032

3133
public class CCJSqlParserUtilTest {
@@ -160,7 +162,10 @@ public void accept(Statement statement) {
160162
}
161163

162164
@Test
165+
@Disabled
163166
public void testParseStatementsFail() throws Exception {
167+
// This will not fail, but always return the Unsupported Statements
168+
// Since we can't LOOKAHEAD in the Statements() production
164169
assertThrows(JSQLParserException.class, () -> CCJSqlParserUtil.parseStatements("select * from dual;WHATEVER!!"));
165170
}
166171

0 commit comments

Comments
 (0)