All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.impossibl.postgres.jdbc.SQLText Maven / Gradle / Ivy

There is a newer version: 0.8.9
Show newest version
/**
 * Copyright (c) 2013, impossibl.com
 * 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 impossibl.com 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.impossibl.postgres.jdbc;

import com.impossibl.postgres.jdbc.SQLTextTree.CommentPiece;
import com.impossibl.postgres.jdbc.SQLTextTree.CompositeNode;
import com.impossibl.postgres.jdbc.SQLTextTree.EscapeNode;
import com.impossibl.postgres.jdbc.SQLTextTree.GrammarPiece;
import com.impossibl.postgres.jdbc.SQLTextTree.MultiStatementNode;
import com.impossibl.postgres.jdbc.SQLTextTree.NumericLiteralPiece;
import com.impossibl.postgres.jdbc.SQLTextTree.ParameterPiece;
import com.impossibl.postgres.jdbc.SQLTextTree.ParenGroupNode;
import com.impossibl.postgres.jdbc.SQLTextTree.Processor;
import com.impossibl.postgres.jdbc.SQLTextTree.QuotedIdentifierPiece;
import com.impossibl.postgres.jdbc.SQLTextTree.StatementNode;
import com.impossibl.postgres.jdbc.SQLTextTree.StringLiteralPiece;
import com.impossibl.postgres.jdbc.SQLTextTree.UnquotedIdentifierPiece;
import com.impossibl.postgres.jdbc.SQLTextTree.WhitespacePiece;

import java.sql.SQLException;
import java.text.ParseException;
import java.util.Deque;
import java.util.LinkedList;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

public class SQLText {

  private MultiStatementNode root;

  public SQLText(String sqlText) throws ParseException {
    root = parse(sqlText);
  }

  private SQLText(MultiStatementNode copyRoot) {
    root = copyRoot;
  }

  public SQLText copy() {
    return new SQLText((MultiStatementNode) root.copy());
  }

  public int getStatementCount() {
    if (root == null)
      return 0;
    return root.getNodeCount();
  }

  public StatementNode getFirstStatement() {
    if (root == null || root.getNodeCount() == 0)
      return null;
    return (StatementNode) root.get(0);
  }

  public StatementNode getLastStatement() {
    if (root == null || root.getNodeCount() == 0)
      return null;
    return (StatementNode) root.get(root.getNodeCount() - 1);
  }

  public void addStatements(SQLText sqlText) {
    root.nodes.addAll(sqlText.root.nodes);
  }

  public void process(Processor processor, boolean recurse) throws SQLException {
    root.process(processor, recurse);
  }

  @Override
  public String toString() {
    return root.toString();
  }

  /*
   * Lexical pattern for the parser that finds these things:
   *  > SQL identifier
   *  > SQL quoted identifier (ignoring escaped double quotes)
   *  > Single quoted strings (ignoring escaped single quotes)
   *  > SQL comments... from "--" to end of line
   *  > C-Style comments (including nested sections)
   *  > ? Parameter placeholders
   *  > ; Statement breaks
   */
  private static final Pattern LEXER = Pattern
      .compile(
          "(?:\"((?:[^\"\"]|\\\\.)*)\")|" +                   /* Quoted identifier */
          "(?:'((?:[^\'\']|\\\\.)*)')|" +                     /* String literal */
          "((?:\\-\\-.*$)|(?:/\\*(?:(?:.|\\n)*)\\*/))|" +     /* Comments */
          "(\\?)|" +                                          /* Parameter marker */
          "(;)|" +                                            /* Statement break */
          "(\\{|\\})|" +                                      /* Escape open/close */
          "([a-zA-Z_][\\w_]*)|" +                             /* Unquoted identifier */
          "((?:[+-]?(?:\\d+)?(?:\\.\\d+(?:[eE][+-]?\\d+)?))|(?:[+-]?\\d+))|" + /* Numeric literal */
          "(\\(|\\))|" +                                      /* Parens (grouping) */
          "(,)|" +                                            /* Comma (breaking) */
          "(\\s+)|" +                                         /* Whitespace */
          "(\\$\\w*\\$)",                                     /* Dollar quote */
          Pattern.MULTILINE);

  public static MultiStatementNode parse(String sql) throws ParseException {

    Deque parents = new LinkedList<>();

    parents.push(new MultiStatementNode(0));
    parents.push(new StatementNode(0));

    Matcher matcher = LEXER.matcher(sql);

    int paramId = 1;
    int startIdx = 0;

    try {

      while (matcher.find(startIdx)) {

        //Add the unmatched region as grammar...
        if (startIdx != matcher.start()) {
          String txt = sql.substring(startIdx, matcher.start()).trim();
          parents.peek().add(new GrammarPiece(txt, matcher.start()));
        }

        startIdx = matcher.end();

        //Add whatever we matched...
        String val;
        if ((val = matcher.group(1)) != null) {

          parents.peek().add(new QuotedIdentifierPiece(val, matcher.start()));
        }
        else if ((val = matcher.group(2)) != null) {

          parents.peek().add(new StringLiteralPiece(val, matcher.start()));
        }
        else if ((val = matcher.group(3)) != null) {

          parents.peek().add(new CommentPiece(val, matcher.start()));
        }
        else if ((val = matcher.group(4)) != null) {

          parents.peek().add(new ParameterPiece(paramId++, matcher.start()));
        }
        else if ((val = matcher.group(5)) != null) {

          if (parents.size() == 2) {

            paramId = 1;

            CompositeNode comp = parents.pop();
            comp.setEndPos(matcher.end());
            parents.peek().add(comp);
            parents.push(new StatementNode(matcher.start()));
          }
          else {

            parents.peek().add(new GrammarPiece(val, matcher.start()));
          }

        }
        else if ((val = matcher.group(6)) != null) {

          if (val.equals("{")) {
            parents.push(new EscapeNode(matcher.start()));
          }
          else {

            if (parents.peek() instanceof EscapeNode) {

              EscapeNode tmp = (EscapeNode) parents.pop();
              tmp.setEndPos(matcher.end());
              parents.peek().add(tmp);
            }
            else {

              throw new ParseException("Mismatched curly brace", matcher.start());
            }
          }
        }
        else if ((val = matcher.group(7)) != null) {

          parents.peek().add(new UnquotedIdentifierPiece(val, matcher.start()));
        }
        else if ((val = matcher.group(8)) != null) {

          parents.peek().add(new NumericLiteralPiece(val, matcher.start()));
        }
        else if ((val = matcher.group(9)) != null) {

          if (val.equals("(")) {
            parents.push(new ParenGroupNode(matcher.start()));
          }
          else {

            if (parents.peek() instanceof ParenGroupNode) {

              ParenGroupNode tmp = (ParenGroupNode) parents.pop();
              tmp.setEndPos(matcher.end());
              parents.peek().add(tmp);
            }
            else {

              throw new ParseException("Mismmatched parenthesis", matcher.start());
            }
          }
        }
        else if ((val = matcher.group(10)) != null) {

          parents.peek().add(new GrammarPiece(",", matcher.start()));
        }
        else if ((val = matcher.group(11)) != null) {

          parents.peek().add(new WhitespacePiece(val, matcher.start()));
        }
        else if ((val = matcher.group(12)) != null) {

          //Find the end of the $$ quoted block
          int pos = sql.indexOf(val, matcher.end());

          //Is this part of an identifier?
          boolean ident = parents.peek().getLastNode() instanceof UnquotedIdentifierPiece;

          //For $$ quotes to be valid they
          //  a) need to be closed
          //  b) must not be adjacent to an identifier

          if (!ident && pos != -1) {

            String quotedText = sql.substring(matcher.end(), pos);

            parents.peek().add(new StringLiteralPiece(quotedText, val, matcher.start()));

            startIdx = pos + val.length();

          }
          else {

            //No end found... treat it as grammar
            parents.peek().add(new GrammarPiece(val, matcher.start()));
          }

        }

      }

      //Add last grammar node
      if (startIdx != sql.length()) {
        parents.peek().add(new GrammarPiece(sql.substring(startIdx), startIdx));
      }

      //Auto close last statement
      if (parents.peek() instanceof StatementNode) {

        StatementNode stmt = (StatementNode) parents.peek();

        stmt.trim();

        if (stmt.getNodeCount() > 0) {
          CompositeNode tmp = parents.pop();
          tmp.setEndPos(startIdx);
          parents.peek().add(tmp);
        }
      }

      if (parents.peek() instanceof StatementNode == false && parents.peek() instanceof MultiStatementNode == false) {
        throw new IllegalArgumentException("error parsing SQL");
      }

      return (MultiStatementNode)parents.getLast();

    }
    catch (ParseException e) {
      throw e;
    }
    catch (Exception e) {

      //Grab about 10 characters to report context of error
      String errorTxt = sql.substring(startIdx, Math.min(sql.length(), startIdx + 10));

      throw new ParseException("Error near: " + errorTxt, startIdx);
    }

  }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy