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

com.impossibl.postgres.jdbc.SQLTextEscapes 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.CompositeNode;
import com.impossibl.postgres.jdbc.SQLTextTree.EscapeNode;
import com.impossibl.postgres.jdbc.SQLTextTree.Node;
import com.impossibl.postgres.jdbc.SQLTextTree.ParameterPiece;
import com.impossibl.postgres.jdbc.SQLTextTree.ParenGroupNode;
import com.impossibl.postgres.jdbc.SQLTextTree.PieceNode;
import com.impossibl.postgres.jdbc.SQLTextTree.Processor;
import com.impossibl.postgres.jdbc.SQLTextTree.StringLiteralPiece;
import com.impossibl.postgres.jdbc.SQLTextTree.UnquotedIdentifierPiece;
import com.impossibl.postgres.jdbc.SQLTextTree.WhitespacePiece;
import com.impossibl.postgres.system.Context;

import static com.impossibl.postgres.jdbc.SQLTextEscapeFunctions.concat;
import static com.impossibl.postgres.jdbc.SQLTextEscapeFunctions.getEscapeMethod;
import static com.impossibl.postgres.jdbc.SQLTextEscapeFunctions.grammar;
import static com.impossibl.postgres.jdbc.SQLTextEscapeFunctions.groupedSequence;
import static com.impossibl.postgres.jdbc.SQLTextEscapeFunctions.invokeEscape;
import static com.impossibl.postgres.jdbc.SQLTextEscapeFunctions.literal;
import static com.impossibl.postgres.jdbc.SQLTextEscapeFunctions.sequence;
import static com.impossibl.postgres.jdbc.SQLTextEscapeFunctions.space;

import java.lang.reflect.Method;
import java.sql.Date;
import java.sql.SQLException;
import java.sql.Time;
import java.sql.Timestamp;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

public class SQLTextEscapes {

  static void processEscapes(SQLText text, final Context context) throws SQLException {

    text.process(new Processor() {

      @Override
      public Node process(Node node) throws SQLException {

        if (!(node instanceof EscapeNode)) {
          return node;
        }

        return processEscape((EscapeNode) node, context);
      }

    }, true);

  }

  private static Node processEscape(EscapeNode escape, Context context) throws SQLException {

    PieceNode type = getNodeNotOf(escape, 0, WhitespacePiece.class, PieceNode.class);

    Node result = null;

    switch(type.toString().toLowerCase()) {
      case "fn":
        result = processFunctionEscape(escape);
        break;

      case "d":
        result = processDateEscape(escape, context);
        break;

      case "t":
        result = processTimeEscape(escape, context);
        break;

      case "ts":
        result = processTimestampEscape(escape, context);
        break;

      case "oj":
        result = processOuterJoinEscape(escape);
        break;

      case "call":
        result = processCallEscape(escape);
        break;

      case "$1":
        result = processCallAssignEscape(escape);
        break;

      case "limit":
        result = processLimitEscape(escape);
        break;

      case "escape":
        result = processLikeEscape(escape);
        break;

      default:
        throw new SQLException("Invalid escape (" + escape.getStartPos() + ")", "Syntax Error");
    }

    return result;
  }

  private static Node processFunctionEscape(EscapeNode escape) throws SQLException {

    escape.removeAll(WhitespacePiece.class, false);

    checkSize(escape, 3);

    UnquotedIdentifierPiece name = getNode(escape, 1, UnquotedIdentifierPiece.class);
    List args = split(getNode(escape, 2, ParenGroupNode.class), false, ",");

    Method method = getEscapeMethod(name.toString());
    if (method == null) {
      throw new SQLException("Escape function not supported (" + escape.getStartPos() + "): " + name, "Syntax Error");
    }

    return invokeEscape(method, name.toString(), args);
  }

  private static Node processDateEscape(EscapeNode escape, Context context) throws SQLException {

    escape.removeAll(WhitespacePiece.class, false);

    checkSize(escape, 2);

    StringLiteralPiece dateLit = getNode(escape, 1, StringLiteralPiece.class);

    Date date;
    try {
      date = Date.valueOf(dateLit.getText());
    }
    catch (Exception e1) {
      throw new SQLException("invalid date format in escape (" + escape.getStartPos() + ")");
    }

    return sequence("DATE", space(), literal(date.toString()));
  }

  private static Node processTimeEscape(EscapeNode escape, Context context) throws SQLException {

    escape.removeAll(WhitespacePiece.class, false);

    checkSize(escape, 2);

    StringLiteralPiece timeLit = getNode(escape, 1, StringLiteralPiece.class);

    Time time;
    try {
      time = Time.valueOf(timeLit.toString());
    }
    catch (Exception e1) {
      throw new SQLException("invalid time format in escape (" + escape.getStartPos() + ")");
    }

    return sequence("TIME", space(), literal(time.toString()));
  }

  private static Node processTimestampEscape(EscapeNode escape, Context context) throws SQLException {

    escape.removeAll(WhitespacePiece.class, false);

    checkSize(escape, 2);

    StringLiteralPiece tsLit = getNode(escape, 1, StringLiteralPiece.class);

    Timestamp timestamp;
    try {
      timestamp = Timestamp.valueOf(tsLit.toString());
    }
    catch (Exception e) {
      throw new SQLException("invalid timestamp format in escape (" + escape.getStartPos() + ")");
    }

    return sequence("TIMESTAMP", space(), literal(timestamp.toString()));
  }

  private static Node processOuterJoinEscape(EscapeNode escape) throws SQLException {

    List nodes = split(escape, true, "OJ", "LEFT", "RIGHT", "FULL", "OUTER", "JOIN", "ON");

    checkSize(nodes, escape.getStartPos(), 8);
    checkLiteralNode(nodes.get(3), "OUTER");
    checkLiteralNode(nodes.get(4), "JOIN");
    checkLiteralNode(nodes.get(6), "ON");

    return sequence(nodes.get(1), space(), nodes.get(2), "OUTER", "JOIN", nodes.get(5), "ON", nodes.get(7));
  }

  private static Node processCallAssignEscape(EscapeNode escape) throws SQLException {

    escape.removeAll(WhitespacePiece.class, false);

    checkSize(escape, 4, 5);

    checkLiteralNode(escape, 1, "=");
    checkLiteralNode(escape, 2, "call");

    escape.process(new Processor() {

      @Override
      public Node process(Node node) throws SQLException {

        if (node instanceof ParameterPiece) {
          ParameterPiece pp = (ParameterPiece) node;
          pp.setIdx(pp.getIdx() - 1);
        }

        return node;
      }

    }, true);

    return groupedSequence("SELECT", space(), grammar("*"), "FROM", getNode(escape, 3, UnquotedIdentifierPiece.class), space(), getNode(escape, 4, ParenGroupNode.class));
  }

  private static Node processCallEscape(EscapeNode escape) throws SQLException {

    escape.removeAll(WhitespacePiece.class, false);

    checkSize(escape, 2, 3);

    return groupedSequence("SELECT", space(), grammar("*"), "FROM", getNode(escape, 1, UnquotedIdentifierPiece.class), space(), getNode(escape, 2, ParenGroupNode.class));
  }

  private static Node processLimitEscape(EscapeNode escape) throws SQLException {

    escape.removeAll(WhitespacePiece.class, false);

    checkSize(escape, 2, 4);

    Node rows = getNode(escape, 1, Node.class);

    Node offset = null;
    if (escape.getNodeCount() == 4) {
      checkLiteralNode(escape, 2, "OFFSET");
      offset = getNode(escape, 3, Node.class);
    }

    Node limit = sequence("LIMIT", rows);

    if (offset != null) {
      limit = concat(limit, sequence(space(), "OFFSET", offset));
    }

    return limit;
  }

  private static Node processLikeEscape(EscapeNode escape) throws SQLException {

    escape.removeAll(WhitespacePiece.class, false);

    checkSize(escape, 2);

    return sequence("ESCAPE", space(), getNode(escape, 1, Node.class));
  }

  private static void checkSize(CompositeNode comp, int... sizes) throws SQLException {

    checkSize(comp.nodes, comp.getStartPos(),  sizes);
  }

  private static void checkSize(List nodes, int startPos, int... sizes) throws SQLException {

    for (int size : sizes) {
      if (nodes.size() == size) {
        return;
      }
    }

    throw new SQLException("Invalid escape syntax (" + startPos + ")", "Syntax Error");
  }

  private static void checkLiteralNode(CompositeNode comp, int index, String text) throws SQLException {

    checkLiteralNode(getNode(comp, index, Node.class), text);
  }

  private static void checkLiteralNode(Node test, String text) throws SQLException {

    if (!test.toString().toUpperCase().equals(text.toUpperCase())) {
      throw new SQLException("Invalid escape (" + test.getStartPos() + ")", "Syntax Error");
    }

  }

  private static  T getNode(CompositeNode comp, int idx, Class nodeType) throws SQLException {

    Node node = comp.get(idx);
    if (!nodeType.isInstance(node))
      throw new SQLException("invalid escape (" + comp.getStartPos() + ")", "Syntax Error");

    return nodeType.cast(node);
  }

  private static  U getNodeNotOf(CompositeNode comp, int idx, Class notNodeType, Class nodeType) throws SQLException {

    Node node = null;

    while (idx < comp.getNodeCount()) {
      node = comp.get(idx);
      if (!notNodeType.isInstance(node))
        break;
      idx++;
    }

    return nodeType.cast(node);
  }

  private static List split(CompositeNode comp, boolean includeMatches, String... matches) {

    return split(comp.nodes, comp.getStartPos(), includeMatches, matches);
  }

  private static List split(List nodes, int startPos, boolean includeMatches, String... matches) {

    List matchList = Arrays.asList(matches);

    if (nodes.size() == 0) {
      return Collections.emptyList();
    }

    CompositeNode current = new CompositeNode(startPos);

    List comps = new ArrayList<>();

    Iterator nodeIter = nodes.iterator();
    while (nodeIter.hasNext()) {

      Node node = nodeIter.next();

      if (node instanceof PieceNode && matchList.contains(((PieceNode) node).getText().toUpperCase())) {

        current.trim();

        if (current.getNodeCount() > 0) {

          comps.add(current);
          current = new CompositeNode(node.getEndPos());

        }

        if (includeMatches) {
          comps.add(node);
        }

      }
      else {

        current.add(node);
      }

    }

    current.trim();

    if (current.getNodeCount() > 0) {
      comps.add(current);
    }

    return comps;
  }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy