/* * Copyright 1999-2011 Alibaba Group Holding Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.alibaba.druid.sql; import java.util.ArrayList; import java.util.List; import com.alibaba.druid.DruidRuntimeException; import com.alibaba.druid.sql.ast.SQLExpr; import com.alibaba.druid.sql.ast.SQLObject; import com.alibaba.druid.sql.ast.SQLStatement; import com.alibaba.druid.sql.ast.expr.SQLBinaryOpExpr; import com.alibaba.druid.sql.ast.expr.SQLBinaryOperator; import com.alibaba.druid.sql.ast.statement.SQLDeleteStatement; import com.alibaba.druid.sql.ast.statement.SQLSelectItem; import com.alibaba.druid.sql.ast.statement.SQLSelectOrderByItem; import com.alibaba.druid.sql.ast.statement.SQLSelectQuery; import com.alibaba.druid.sql.ast.statement.SQLSelectQueryBlock; import com.alibaba.druid.sql.ast.statement.SQLSelectStatement; import com.alibaba.druid.sql.ast.statement.SQLUpdateSetItem; import com.alibaba.druid.sql.ast.statement.SQLUpdateStatement; import com.alibaba.druid.sql.dialect.db2.visitor.DB2OutputVisitor; import com.alibaba.druid.sql.dialect.db2.visitor.DB2SchemaStatVisitor; import com.alibaba.druid.sql.dialect.mysql.visitor.MySqlOutputVisitor; import com.alibaba.druid.sql.dialect.mysql.visitor.MySqlSchemaStatVisitor; import com.alibaba.druid.sql.dialect.odps.visitor.OdpsOutputVisitor; import com.alibaba.druid.sql.dialect.oracle.visitor.OracleOutputVisitor; import com.alibaba.druid.sql.dialect.oracle.visitor.OracleSchemaStatVisitor; import com.alibaba.druid.sql.dialect.oracle.visitor.OracleToMySqlOutputVisitor; import com.alibaba.druid.sql.dialect.postgresql.visitor.PGOutputVisitor; import com.alibaba.druid.sql.dialect.postgresql.visitor.PGSchemaStatVisitor; import com.alibaba.druid.sql.dialect.sqlserver.visitor.SQLServerOutputVisitor; import com.alibaba.druid.sql.dialect.sqlserver.visitor.SQLServerSchemaStatVisitor; import com.alibaba.druid.sql.parser.ParserException; import com.alibaba.druid.sql.parser.SQLExprParser; import com.alibaba.druid.sql.parser.SQLParserUtils; import com.alibaba.druid.sql.parser.SQLStatementParser; import com.alibaba.druid.sql.parser.Token; import com.alibaba.druid.sql.visitor.SQLASTOutputVisitor; import com.alibaba.druid.sql.visitor.SchemaStatVisitor; import com.alibaba.druid.support.logging.Log; import com.alibaba.druid.support.logging.LogFactory; import com.alibaba.druid.util.JdbcConstants; import com.alibaba.druid.util.JdbcUtils; import com.alibaba.druid.util.StringUtils; public class SQLUtils { private final static Log LOG = LogFactory.getLog(SQLUtils.class); public static String toSQLString(SQLObject sqlObject, String dbType) { if (JdbcUtils.MYSQL.equals(dbType) || // JdbcUtils.MARIADB.equals(dbType) || // JdbcUtils.H2.equals(dbType)) { return toMySqlString(sqlObject); } if (JdbcUtils.ORACLE.equals(dbType) || JdbcUtils.ALI_ORACLE.equals(dbType)) { return toOracleString(sqlObject); } if (JdbcUtils.POSTGRESQL.equals(dbType)) { return toPGString(sqlObject); } if (JdbcUtils.DB2.equals(dbType)) { return toDB2String(sqlObject); } if (JdbcUtils.ODPS.equals(dbType)) { return toOdpsString(sqlObject); } return toSQLServerString(sqlObject); } public static String toSQLString(SQLObject sqlObject) { StringBuilder out = new StringBuilder(); sqlObject.accept(new SQLASTOutputVisitor(out)); String sql = out.toString(); return sql; } public static String toOdpsString(SQLObject sqlObject) { StringBuilder out = new StringBuilder(); sqlObject.accept(new OdpsOutputVisitor(out)); String sql = out.toString(); return sql; } public static String toMySqlString(SQLObject sqlObject) { StringBuilder out = new StringBuilder(); sqlObject.accept(new MySqlOutputVisitor(out)); String sql = out.toString(); return sql; } public static SQLExpr toMySqlExpr(String sql) { return toSQLExpr(sql, JdbcUtils.MYSQL); } public static String formatMySql(String sql) { return format(sql, JdbcUtils.MYSQL); } public static String formatOracle(String sql) { return format(sql, JdbcUtils.ORACLE); } public static String formatOdps(String sql) { return format(sql, JdbcUtils.ODPS); } public static String formatSQLServer(String sql) { return format(sql, JdbcUtils.SQL_SERVER); } public static String toOracleString(SQLObject sqlObject) { StringBuilder out = new StringBuilder(); sqlObject.accept(new OracleOutputVisitor(out, false)); String sql = out.toString(); return sql; } public static String toPGString(SQLObject sqlObject) { StringBuilder out = new StringBuilder(); sqlObject.accept(new PGOutputVisitor(out)); String sql = out.toString(); return sql; } public static String toDB2String(SQLObject sqlObject) { StringBuilder out = new StringBuilder(); sqlObject.accept(new DB2OutputVisitor(out)); String sql = out.toString(); return sql; } public static String toSQLServerString(SQLObject sqlObject) { StringBuilder out = new StringBuilder(); sqlObject.accept(new SQLServerOutputVisitor(out)); String sql = out.toString(); return sql; } public static String formatPGSql(String sql) { return format(sql, JdbcUtils.POSTGRESQL); } public static SQLExpr toSQLExpr(String sql, String dbType) { SQLExprParser parser = SQLParserUtils.createExprParser(sql, dbType); SQLExpr expr = parser.expr(); if (parser.getLexer().token() != Token.EOF) { throw new ParserException("illegal sql expr : " + sql); } return expr; } public static SQLSelectOrderByItem toOrderByItem(String sql, String dbType) { SQLExprParser parser = SQLParserUtils.createExprParser(sql, dbType); SQLSelectOrderByItem orderByItem = parser.parseSelectOrderByItem(); if (parser.getLexer().token() != Token.EOF) { throw new ParserException("illegal sql expr : " + sql); } return orderByItem; } public static SQLUpdateSetItem toUpdateSetItem(String sql, String dbType) { SQLExprParser parser = SQLParserUtils.createExprParser(sql, dbType); SQLUpdateSetItem updateSetItem = parser.parseUpdateSetItem(); if (parser.getLexer().token() != Token.EOF) { throw new ParserException("illegal sql expr : " + sql); } return updateSetItem; } public static SQLSelectItem toSelectItem(String sql, String dbType) { SQLExprParser parser = SQLParserUtils.createExprParser(sql, dbType); SQLSelectItem selectItem = parser.parseSelectItem(); if (parser.getLexer().token() != Token.EOF) { throw new ParserException("illegal sql expr : " + sql); } return selectItem; } public static List toStatementList(String sql, String dbType) { SQLStatementParser parser = SQLParserUtils.createSQLStatementParser(sql, dbType); return parser.parseStatementList(); } public static SQLExpr toSQLExpr(String sql) { return toSQLExpr(sql, null); } public static String format(String sql, String dbType) { return format(sql, dbType, null); } public static String format(String sql, String dbType, List parameters) { try { SQLStatementParser parser = SQLParserUtils.createSQLStatementParser(sql, dbType); parser.setKeepComments(true); List statementList = parser.parseStatementList(); return toSQLString(statementList, dbType, parameters); } catch (ParserException ex) { LOG.warn("format error", ex); return sql; } } public static String toSQLString(List statementList, String dbType) { return toSQLString(statementList, dbType, null); } public static String toSQLString(List statementList, String dbType, List parameters) { StringBuilder out = new StringBuilder(); SQLASTOutputVisitor visitor = createFormatOutputVisitor(out, statementList, dbType); if (parameters != null) { visitor.setParameters(parameters); } for (int i = 0; i < statementList.size(); i++) { SQLStatement stmt = statementList.get(i); if (i > 0) { visitor.print(";"); SQLStatement preStmt = statementList.get(i - 1); List comments = preStmt.getAfterCommentsDirect(); if (comments != null){ for (int j = 0; j < comments.size(); ++j) { String comment = comments.get(j); if (j != 0) { visitor.println(); } visitor.print(comment); } } visitor.println(); } { List comments = stmt.getBeforeCommentsDirect(); if (comments != null){ for(String comment : comments) { visitor.println(comment); } } } stmt.accept(visitor); if (i == statementList.size() - 1) { Boolean semi = (Boolean) stmt.getAttribute("format.semi"); if (semi != null && semi.booleanValue()) { // if (stmt.hasAfterComment()) { // visitor.println(); // } visitor.print(";"); } List comments = stmt.getAfterCommentsDirect(); if (comments != null){ for (int j = 0; j < comments.size(); ++j) { String comment = comments.get(j); if (j != 0) { visitor.println(); } visitor.print(comment); } } } } return out.toString(); } public static SQLASTOutputVisitor createFormatOutputVisitor(Appendable out, List statementList, String dbType) { if (JdbcUtils.ORACLE.equals(dbType) || JdbcUtils.ALI_ORACLE.equals(dbType)) { if (statementList.size() == 1) { return new OracleOutputVisitor(out, false); } else { return new OracleOutputVisitor(out, true); } } if (JdbcUtils.MYSQL.equals(dbType) || // JdbcUtils.MARIADB.equals(dbType) || // JdbcUtils.H2.equals(dbType)) { return new MySqlOutputVisitor(out); } if (JdbcUtils.POSTGRESQL.equals(dbType)) { return new PGOutputVisitor(out); } if (JdbcUtils.SQL_SERVER.equals(dbType) || JdbcUtils.JTDS.equals(dbType)) { return new SQLServerOutputVisitor(out); } if (JdbcUtils.DB2.equals(dbType)) { return new DB2OutputVisitor(out); } if (JdbcUtils.ODPS.equals(dbType)) { return new OdpsOutputVisitor(out); } return new SQLASTOutputVisitor(out); } @Deprecated public static SchemaStatVisitor createSchemaStatVisitor(List statementList, String dbType) { return createSchemaStatVisitor(dbType); } public static SchemaStatVisitor createSchemaStatVisitor(String dbType) { if (JdbcUtils.ORACLE.equals(dbType) || JdbcUtils.ALI_ORACLE.equals(dbType)) { return new OracleSchemaStatVisitor(); } if (JdbcUtils.MYSQL.equals(dbType) || // JdbcUtils.MARIADB.equals(dbType) || // JdbcUtils.H2.equals(dbType)) { return new MySqlSchemaStatVisitor(); } if (JdbcUtils.POSTGRESQL.equals(dbType)) { return new PGSchemaStatVisitor(); } if (JdbcUtils.SQL_SERVER.equals(dbType) || JdbcUtils.JTDS.equals(dbType)) { return new SQLServerSchemaStatVisitor(); } if (JdbcUtils.DB2.equals(dbType)) { return new DB2SchemaStatVisitor(); } return new SchemaStatVisitor(); } public static List parseStatements(String sql, String dbType) { SQLStatementParser parser = SQLParserUtils.createSQLStatementParser(sql, dbType); List stmtList = parser.parseStatementList(); if (parser.getLexer().token() != Token.EOF) { throw new DruidRuntimeException("syntax error : " + sql); } return stmtList; } /** * @author owenludong.lud * @param columnName * @param tableAlias * @param pattern if pattern is null,it will be set {%Y-%m-%d %H:%i:%s} as mysql default value and set {yyyy-mm-dd * hh24:mi:ss} as oracle default value * @param dbType {@link JdbcConstants} if dbType is null ,it will be set the mysql as a default value */ public static String buildToDate(String columnName, String tableAlias, String pattern, String dbType) { StringBuilder sql = new StringBuilder(); if (StringUtils.isEmpty(columnName)) return ""; if (StringUtils.isEmpty(dbType)) dbType = JdbcConstants.MYSQL; String formatMethod = ""; if (JdbcConstants.MYSQL.equalsIgnoreCase(dbType)) { formatMethod = "STR_TO_DATE"; if (StringUtils.isEmpty(pattern)) pattern = "%Y-%m-%d %H:%i:%s"; } else if (JdbcConstants.ORACLE.equalsIgnoreCase(dbType)) { formatMethod = "TO_DATE"; if (StringUtils.isEmpty(pattern)) pattern = "yyyy-mm-dd hh24:mi:ss"; } else { return ""; // expand date's handle method for other database } sql.append(formatMethod).append("("); if (!StringUtils.isEmpty(tableAlias)) sql.append(tableAlias).append("."); sql.append(columnName).append(","); sql.append("'"); sql.append(pattern); sql.append("')"); return sql.toString(); } public static List split(SQLBinaryOpExpr x) { List groupList = new ArrayList(); groupList.add(x.getRight()); SQLExpr left = x.getLeft(); for (;;) { if (left instanceof SQLBinaryOpExpr && ((SQLBinaryOpExpr) left).getOperator() == x.getOperator()) { SQLBinaryOpExpr binaryLeft = (SQLBinaryOpExpr) left; groupList.add(binaryLeft.getRight()); left = binaryLeft.getLeft(); } else { groupList.add(left); break; } } return groupList; } public static String translateOracleToMySql(String sql) { List stmtList = toStatementList(sql, JdbcConstants.ORACLE); StringBuilder out = new StringBuilder(); OracleToMySqlOutputVisitor visitor = new OracleToMySqlOutputVisitor(out, false); for (int i = 0; i < stmtList.size(); ++i) { stmtList.get(i).accept(visitor); } String mysqlSql = out.toString(); return mysqlSql; } public static String addCondition(String sql, String condition, String dbType) { String result = addCondition(sql, condition, SQLBinaryOperator.BooleanAnd, false, dbType); return result; } public static String addCondition(String sql, String condition, SQLBinaryOperator op, boolean left, String dbType) { if (sql == null) { throw new IllegalArgumentException("sql is null"); } if (condition == null) { return sql; } if (op == null) { op = SQLBinaryOperator.BooleanAnd; } if (op != SQLBinaryOperator.BooleanAnd // && op != SQLBinaryOperator.BooleanOr) { throw new IllegalArgumentException("add condition not support : " + op); } List stmtList = parseStatements(sql, dbType); if (stmtList.size() == 0) { throw new IllegalArgumentException("not support empty-statement :" + sql); } if (stmtList.size() > 1) { throw new IllegalArgumentException("not support multi-statement :" + sql); } SQLStatement stmt = stmtList.get(0); SQLExpr conditionExpr = toSQLExpr(condition, dbType); addCondition(stmt, op, conditionExpr, left); return toSQLString(stmt, dbType); } public static void addCondition(SQLStatement stmt, SQLBinaryOperator op, SQLExpr condition, boolean left) { if (stmt instanceof SQLSelectStatement) { SQLSelectQuery query = ((SQLSelectStatement) stmt).getSelect().getQuery(); if (query instanceof SQLSelectQueryBlock) { SQLSelectQueryBlock queryBlock = (SQLSelectQueryBlock) query; SQLExpr newCondition = buildCondition(op, condition, left, queryBlock.getWhere()); queryBlock.setWhere(newCondition); } else { throw new IllegalArgumentException("add condition not support " + stmt.getClass().getName()); } return; } if (stmt instanceof SQLDeleteStatement) { SQLDeleteStatement delete = (SQLDeleteStatement) stmt; SQLExpr newCondition = buildCondition(op, condition, left, delete.getWhere()); delete.setWhere(newCondition); return; } if (stmt instanceof SQLUpdateStatement) { SQLUpdateStatement update = (SQLUpdateStatement) stmt; SQLExpr newCondition = buildCondition(op, condition, left, update.getWhere()); update.setWhere(newCondition); return; } throw new IllegalArgumentException("add condition not support " + stmt.getClass().getName()); } public static SQLExpr buildCondition(SQLBinaryOperator op, SQLExpr condition, boolean left, SQLExpr where) { if (where == null) { return condition; } SQLBinaryOpExpr newCondition; if (left) { newCondition = new SQLBinaryOpExpr(condition, op, where); } else { newCondition = new SQLBinaryOpExpr(where, op, condition); } return newCondition; } public static String addSelectItem(String selectSql, String expr, String alias, String dbType) { return addSelectItem(selectSql, expr, alias, false, dbType); } public static String addSelectItem(String selectSql, String expr, String alias, boolean first, String dbType) { List stmtList = parseStatements(selectSql, dbType); if (stmtList.size() == 0) { throw new IllegalArgumentException("not support empty-statement :" + selectSql); } if (stmtList.size() > 1) { throw new IllegalArgumentException("not support multi-statement :" + selectSql); } SQLStatement stmt = stmtList.get(0); SQLExpr columnExpr = toSQLExpr(expr, dbType); addSelectItem(stmt, columnExpr, alias, first); return toSQLString(stmt, dbType); } public static void addSelectItem(SQLStatement stmt, SQLExpr expr, String alias, boolean first) { if (expr == null) { return; } if (stmt instanceof SQLSelectStatement) { SQLSelectQuery query = ((SQLSelectStatement) stmt).getSelect().getQuery(); if (query instanceof SQLSelectQueryBlock) { SQLSelectQueryBlock queryBlock = (SQLSelectQueryBlock) query; addSelectItem(queryBlock, expr, alias, first); } else { throw new IllegalArgumentException("add condition not support " + stmt.getClass().getName()); } return; } throw new IllegalArgumentException("add selectItem not support " + stmt.getClass().getName()); } public static void addSelectItem(SQLSelectQueryBlock queryBlock, SQLExpr expr, String alias, boolean first) { SQLSelectItem selectItem = new SQLSelectItem(expr, alias); queryBlock.getSelectList().add(selectItem); selectItem.setParent(selectItem); } }