fix: allow Parameters like $1,$2

- fixes #1970

Signed-off-by: Andreas Reichel <[email protected]>

Author: manticore-projects

src/main/java/net/sf/jsqlparser/expression/JdbcParameter.java

@@ -11,20 +11,43 @@
 
 import net.sf.jsqlparser.parser.ASTNodeAccessImpl;
 
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
 /**
  * A '?' in a statement or a ?<number> e.g. ?4
  */
 public class JdbcParameter extends ASTNodeAccessImpl implements Expression {
 
+    private String parameterCharacter = "?";
     private Integer index;
     private boolean useFixedIndex = false;
 
-    public JdbcParameter() {
-    }
+    public JdbcParameter() {}
 
-    public JdbcParameter(Integer index, boolean useFixedIndex) {
+    public JdbcParameter(Integer index, boolean useFixedIndex, String parameterCharacter) {
         this.index = index;
         this.useFixedIndex = useFixedIndex;
+        this.parameterCharacter = parameterCharacter;
+
+        // This is needed for Parameters starting with "$" like "$2"
+        // Those will contain the index in the parameterCharacter
+        final Pattern pattern = Pattern.compile("(\\$)(\\d*)");
+        final Matcher matcher = pattern.matcher(parameterCharacter);
+        if (matcher.find() && matcher.groupCount() == 2) {
+            this.useFixedIndex = true;
+            this.parameterCharacter = matcher.group(1);
+            this.index = Integer.valueOf(matcher.group(2));
+        }
+    }
+
+    public String getParameterCharacter() {
+        return parameterCharacter;
+    }
+
+    public JdbcParameter setParameterCharacter(String parameterCharacter) {
+        this.parameterCharacter = parameterCharacter;
+        return this;
     }
 
     public Integer getIndex() {
@@ -50,7 +73,7 @@ public void accept(ExpressionVisitor expressionVisitor) {
 
     @Override
     public String toString() {
-        return useFixedIndex ? "?" + index : "?";
+        return useFixedIndex ? parameterCharacter + index : parameterCharacter;
     }
 
     public JdbcParameter withIndex(Integer index) {

src/main/java/net/sf/jsqlparser/util/deparser/ExpressionDeParser.java

@@ -328,7 +328,7 @@ public void visit(IsBooleanExpression isBooleanExpression) {
 
     @Override
     public void visit(JdbcParameter jdbcParameter) {
-        buffer.append("?");
+        buffer.append(jdbcParameter.getParameterCharacter());
         if (jdbcParameter.isUseFixedIndex()) {
             buffer.append(jdbcParameter.getIndex());
         }

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

@@ -530,6 +530,8 @@ SPECIAL_TOKEN:
 
 TOKEN:
 {
+<S_PARAMETER: ["$"] (["0"-"9"])+ >
+|
 <S_IDENTIFIER: <LETTER> (<PART_LETTER>)*>
 |   <#LETTER: <UnicodeIdentifierStart>
                 | <Nd> | [ "$" , "#", "_" ] // Not SQL:2016 compliant!
@@ -3126,27 +3128,20 @@ OrderByElement OrderByElement():
     }
 }
 
-JdbcParameter SimpleJdbcParameter() : {
+JdbcParameter JdbcParameter() : {
+    Token tk;
     JdbcParameter retval;
 }
 {
-    "?" { retval = new JdbcParameter(++jdbcParameterIndex, false); }
-		[ LOOKAHEAD(2) token = <S_LONG> { retval.setUseFixedIndex(true); retval.setIndex(Integer.valueOf(token.image)); } ]
-    {
-        return retval;
-    }
-}
+    ( tk="?" | tk=<S_PARAMETER> )
+    { retval = new JdbcParameter(++jdbcParameterIndex, false, tk.image); }
 
-JdbcNamedParameter SimpleJdbcNamedParameter() : {
-    String name;
-}
-{
-    ":" name = RelObjectNameExt()
-    {
-        return new JdbcNamedParameter(token.image);
-    }
+    [ LOOKAHEAD(2) token = <S_LONG> { retval.setUseFixedIndex(true); retval.setIndex(Integer.valueOf(token.image)); } ]
+
+    { return retval; }
 }
 
+
 Limit LimitWithOffset() #LimitWithOffset:
 {
     Limit limit = new Limit();
@@ -3323,7 +3318,7 @@ Top Top():
     (
          token=<S_LONG>                      { top.setExpression(new LongValue(token.image)); }
        |
-         jdbc = SimpleJdbcParameter() { top.setExpression(jdbc); }
+         jdbc = JdbcParameter() { top.setExpression(jdbc); }
          /*"?"                                 { top.setExpression(new JdbcParameter(++jdbcParameterIndex, false)); } [ LOOKAHEAD(2) token = <S_LONG> { ((JdbcParameter)(top.getExpression())).setUseFixedIndex(true); ((JdbcParameter)(top.getExpression())).setIndex(Integer.valueOf(token.image)); } ]*/
        |
        ":"                                  { top.setExpression(new JdbcNamedParameter()); } [ LOOKAHEAD(2) token = <S_IDENTIFIER> { ((JdbcNamedParameter)top.getExpression()).setName(token.image); } ]
@@ -3354,7 +3349,7 @@ Skip Skip():
     (
          token=<S_LONG>                      { skip.setRowCount(Long.parseLong(token.image)); }
                 | token=<S_IDENTIFIER>              { skip.setVariable(token.image); }
-                | jdbc = SimpleJdbcParameter() { skip.setJdbcParameter(jdbc); }
+                | jdbc = JdbcParameter() { skip.setJdbcParameter(jdbc); }
                    /* "?" { skip.setJdbcParameter(new JdbcParameter(++jdbcParameterIndex, false)); } [ LOOKAHEAD(2) token = <S_LONG> { skip.getJdbcParameter().setUseFixedIndex(true); skip.getJdbcParameter().setIndex(Integer.valueOf(token.image)); } ] */
     )
     {
@@ -3396,7 +3391,7 @@ First First():
         |
         token=<S_IDENTIFIER> { first.setVariable(token.image); }
         |
-        jdbc = SimpleJdbcParameter() { first.setJdbcParameter(jdbc); }
+        jdbc = JdbcParameter() { first.setJdbcParameter(jdbc); }
     )
     {
         return first;
@@ -4235,9 +4230,9 @@ Expression PrimaryExpression() #PrimaryExpression:
 
         | LOOKAHEAD(3, {!interrupted}) retval=CaseWhenExpression()
 
-        | LOOKAHEAD(3) retval = SimpleJdbcParameter()
+        | retval = JdbcParameter()
 
-        | LOOKAHEAD(2) retval=JdbcNamedParameter()
+        | LOOKAHEAD(2) retval =JdbcNamedParameter()
 
         | LOOKAHEAD(3) retval=UserVariable()
 
@@ -4758,7 +4753,7 @@ IntervalExpression IntervalExpression() : {
 {
 
 { interval = new IntervalExpression(); }
-    <K_INTERVAL> ["-" {signed=true;}] (token=<S_LONG> | token=<S_DOUBLE> | token=<S_CHAR_LITERAL> | LOOKAHEAD(SimpleJdbcParameter()) expr = SimpleJdbcParameter() | expr = JdbcNamedParameter() | LOOKAHEAD(Function()) expr = Function() | expr = Column())
+    <K_INTERVAL> ["-" {signed=true;}] (token=<S_LONG> | token=<S_DOUBLE> | token=<S_CHAR_LITERAL> | LOOKAHEAD(JdbcParameter()) expr = JdbcParameter() | expr = JdbcNamedParameter() | LOOKAHEAD(Function()) expr = Function() | expr = Column())
     {
         if (expr != null) {
             if (signed) expr = new SignedExpression('-', expr);
@@ -5099,9 +5094,9 @@ FullTextSearch FullTextSearch() : {
     (
       againstValue=<S_CHAR_LITERAL> { fs.setAgainstValue(new StringValue(againstValue.image)); }
       |
-      jdbcParameter=SimpleJdbcParameter() { fs.setAgainstValue(  jdbcParameter ); }
+      jdbcParameter=JdbcParameter() { fs.setAgainstValue(  jdbcParameter ); }
       |
-      jdbcNamedParameter=SimpleJdbcNamedParameter() { fs.setAgainstValue(  jdbcNamedParameter ); }
+      jdbcNamedParameter=JdbcNamedParameter() { fs.setAgainstValue(  jdbcNamedParameter ); }
     )
     [
         (

src/test/java/net/sf/jsqlparser/expression/JdbcNamedParameterTest.java

@@ -11,8 +11,10 @@
 
 import net.sf.jsqlparser.JSQLParserException;
 import net.sf.jsqlparser.expression.operators.arithmetic.BitwiseAnd;
+import net.sf.jsqlparser.expression.operators.relational.EqualsTo;
 import net.sf.jsqlparser.statement.select.PlainSelect;
 import net.sf.jsqlparser.test.TestUtils;
+import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertTrue;
@@ -39,4 +41,16 @@ void testIssue1785() throws JSQLParserException {
                 + "where owner = &myowner";
         TestUtils.assertSqlCanBeParsedAndDeparsed(sqlStr, true);
     }
+
+    @Test
+    void testIssue1970() throws JSQLParserException {
+        String sqlStr = "SELECT a from tbl where col = $2";
+        PlainSelect select = (PlainSelect) TestUtils.assertSqlCanBeParsedAndDeparsed(sqlStr, true);
+
+        EqualsTo where = (EqualsTo) select.getWhere();
+        Assertions.assertInstanceOf(JdbcParameter.class, where.getRightExpression());
+
+        JdbcParameter p = (JdbcParameter) where.getRightExpression();
+        Assertions.assertEquals(2, p.getIndex());
+    }
 }