bugfix: sql statement escape symbol

rm-datasource/src/main/java/io/seata/rm/datasource/AbstractConnectionProxy.java

@@ -23,6 +23,7 @@
 import io.seata.rm.datasource.sql.SQLVisitorFactory;
 import io.seata.rm.datasource.sql.struct.TableMeta;
 import io.seata.rm.datasource.sql.struct.TableMetaCache;
+import io.seata.rm.datasource.sql.struct.TableMetaCacheAdapter;
 import io.seata.rm.datasource.sql.struct.TableMetaCacheOracle;
 
 import java.sql.Array;
@@ -112,14 +113,7 @@ public PreparedStatement prepareStatement(String sql) throws SQLException {
         PreparedStatement targetPreparedStatement;
         SQLRecognizer sqlRecognizer = SQLVisitorFactory.get(sql, dbType);
         if (sqlRecognizer != null && sqlRecognizer.getSQLType() == SQLType.INSERT) {
-            final boolean oracle = StringUtils.equalsIgnoreCase(JdbcConstants.ORACLE, dbType);
-            final String tableName = sqlRecognizer.getTableName();
-            TableMeta tableMeta;
-            if (oracle) {
-                tableMeta = TableMetaCacheOracle.getTableMeta(getDataSourceProxy(), tableName);
-            } else {
-                tableMeta = TableMetaCache.getTableMeta(getDataSourceProxy(), tableName);
-            }
+            TableMeta tableMeta = TableMetaCacheAdapter.getTableMeta(dbType, getDataSourceProxy(), sqlRecognizer.getTableName(), false);
             targetPreparedStatement = getTargetConnection().prepareStatement(sql, new String[]{ tableMeta.getPkName() });
         } else {
             targetPreparedStatement = getTargetConnection().prepareStatement(sql);

rm-datasource/src/main/java/io/seata/rm/datasource/ColumnUtils.java

@@ -0,0 +1,160 @@
+/*
+ *  Copyright 1999-2019 Seata.io Group.
+ *
+ *  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 io.seata.rm.datasource;
+
+import com.alibaba.druid.util.JdbcConstants;
+import io.seata.common.util.StringUtils;
+
+import java.util.List;
+
+/**
+ * column utils
+ * @author jsbxyyx
+ * @date 2019/09/17
+ */
+public final class ColumnUtils {
+
+    /**
+     * The escape
+     */
+    public enum Escape {
+        /** standard escape */
+        STANDARD('"'),
+        /** mysql escape */
+        MYSQL('`')
+        ;
+        public final char value;
+        Escape(char value) {
+            this.value = value;
+        }
+    }
+
+    /**
+     * del escape by db type
+     * @param cols the cols
+     * @param dbType the db type
+     */
+    public static void delEscape(List<String> cols, String dbType) {
+        // sql standard
+        // https://db.apache.org/derby/docs/10.1/ref/crefsqlj1003454.html
+        // https://docs.oracle.com/javadb/10.8.3.0/ref/crefsqlj1003454.html
+        // https://www.informit.com/articles/article.aspx?p=2036581&seqNum=2
+        delEscape(cols, Escape.STANDARD);
+        if (StringUtils.equalsIgnoreCase(dbType, JdbcConstants.MYSQL)) {
+            delEscape(cols, Escape.MYSQL);
+        }
+    }
+
+    /**
+     * del escape
+     * @param cols the cols
+     * @param escape the escape
+     * @throws NullPointerException if cols is null
+     */
+    public static void delEscape(List<String> cols, Escape escape) {
+        if (cols == null) {
+            throw new NullPointerException("cols is null");
+        }
+        for (int i = 0, len = cols.size(); i < len; i++) {
+            String col = cols.get(i);
+            if (col != null && col.charAt(0) == escape.value && col.charAt(col.length() - 1) == escape.value) {
+                cols.set(i, delEscape(col, escape));
+            }
+        }
+    }
+
+    /**
+     * del escape by db type
+     * @param colName the column name
+     * @param dbType the db type
+     * @return
+     */
+    public static String delEscape(String colName, String dbType) {
+        String newColName = delEscape(colName, Escape.STANDARD);
+        if (StringUtils.equalsIgnoreCase(dbType, JdbcConstants.MYSQL)) {
+            newColName = delEscape(newColName, Escape.MYSQL);
+        }
+        return newColName;
+    }
+
+    /**
+     * del escape by escape
+     * @param colName the column name
+     * @param escape the escape
+     * @return
+     */
+    public static String delEscape(String colName, Escape escape) {
+        if (colName == null) {
+            throw new NullPointerException("colName is null");
+        }
+        if (colName.isEmpty()) {
+            return colName;
+        }
+        if (colName.charAt(0) == escape.value && colName.charAt(colName.length() - 1) == escape.value) {
+            return colName.substring(1, colName.length() - 1);
+        }
+        return colName;
+    }
+
+    /**
+     * add escape by db type
+     * @param cols the column name list
+     * @param dbType the db type
+     */
+    public static void addEscape(List<String> cols, String dbType) {
+        if (cols == null || cols.isEmpty()) {
+            throw new NullPointerException("cols is null");
+        }
+        for (int i = 0, len = cols.size(); i < len; i++) {
+            String col = cols.get(i);
+            if (col != null) {
+                cols.set(i, addEscape(col, dbType));
+            }
+        }
+    }
+
+    /**
+     * add escape by db type
+     * @param colName the column name
+     * @param dbType the db type
+     * @return the colName left and right add escape
+     */
+    public static String addEscape(String colName, String dbType) {
+        if (StringUtils.equalsIgnoreCase(dbType, JdbcConstants.MYSQL)) {
+            return addEscape(colName, ColumnUtils.Escape.MYSQL);
+        }
+        return addEscape(colName, ColumnUtils.Escape.STANDARD);
+    }
+
+    /**
+     * add escape
+     * @param colName the column name
+     * @param escape the escape
+     */
+    public static String addEscape(String colName, Escape escape) {
+        if (colName == null) {
+            throw new NullPointerException("colName is null");
+        }
+        if (colName.isEmpty()) {
+            return colName;
+        }
+        if (colName.charAt(0) == escape.value && colName.charAt(colName.length() - 1) == escape.value) {
+            return colName;
+        }
+        return String.format("%s%s%s", escape.value, colName, escape.value);
+    }
+
+}

rm-datasource/src/main/java/io/seata/rm/datasource/exec/BaseTransactionalExecutor.java

@@ -23,7 +23,6 @@
 import java.util.List;
 import java.util.StringJoiner;
 
-import com.alibaba.druid.util.JdbcConstants;
 import io.seata.common.util.CollectionUtils;
 import io.seata.common.util.StringUtils;
 import io.seata.core.context.RootContext;
@@ -35,8 +34,7 @@
 import io.seata.rm.datasource.sql.WhereRecognizer;
 import io.seata.rm.datasource.sql.struct.Field;
 import io.seata.rm.datasource.sql.struct.TableMeta;
-import io.seata.rm.datasource.sql.struct.TableMetaCache;
-import io.seata.rm.datasource.sql.struct.TableMetaCacheOracle;
+import io.seata.rm.datasource.sql.struct.TableMetaCacheAdapter;
 import io.seata.rm.datasource.sql.struct.TableRecords;
 import io.seata.rm.datasource.undo.SQLUndoLog;
 
@@ -188,11 +186,7 @@ protected TableMeta getTableMeta(String tableName) {
         if (tableMeta != null) {
             return tableMeta;
         }
-        if (JdbcConstants.ORACLE.equalsIgnoreCase(statementProxy.getConnectionProxy().getDbType())) {
-            tableMeta = TableMetaCacheOracle.getTableMeta(statementProxy.getConnectionProxy().getDataSourceProxy(), tableName);
-        } else {
-            tableMeta = TableMetaCache.getTableMeta(statementProxy.getConnectionProxy().getDataSourceProxy(), tableName);
-        }
+        tableMeta = TableMetaCacheAdapter.getTableMeta(getDbType(), statementProxy.getConnectionProxy().getDataSourceProxy(), tableName);
         return tableMeta;
     }
 

rm-datasource/src/main/java/io/seata/rm/datasource/exec/InsertExecutor.java

@@ -26,6 +26,7 @@
 import com.alibaba.druid.util.JdbcConstants;
 import io.seata.common.exception.NotSupportYetException;
 import io.seata.common.exception.ShouldNeverHappenException;
+import io.seata.rm.datasource.ColumnUtils;
 import io.seata.common.util.StringUtils;
 import io.seata.rm.datasource.PreparedStatementProxy;
 import io.seata.rm.datasource.StatementProxy;
@@ -104,6 +105,9 @@ protected List<Object> getPkValuesByColumn() throws SQLException {
         // insert values including PK
         SQLInsertRecognizer recognizer = (SQLInsertRecognizer) sqlRecognizer;
         final int pkIndex = getPkIndex();
+        if (pkIndex == -1) {
+            throw new ShouldNeverHappenException("pkIndex is " + pkIndex);
+        }
         List<Object> pkValues = null;
         if (statementProxy instanceof PreparedStatementProxy) {
             PreparedStatementProxy preparedStatementProxy = (PreparedStatementProxy) statementProxy;
@@ -126,6 +130,10 @@ protected List<Object> getPkValuesByColumn() throws SQLException {
                     pkValues = new ArrayList<>(rowSize);
                     for (int i = 0; i < rowSize; i++) {
                         List<Object> row = insertRows.get(i);
+                        // oracle insert parameter count may be than the actual +1
+                        if (row.isEmpty()) {
+                            continue;
+                        }
                         Object pkValue = row.get(pkIndex);
                         int currentRowPlaceholderNum = -1;
                         for (Object r : row) {
@@ -219,6 +227,8 @@ protected int getPkIndex() {
         String pkName = getTableMeta().getPkName();
         List<String> insertColumns = recognizer.getInsertColumns();
         if (insertColumns != null && !insertColumns.isEmpty()) {
+            // add escape
+            ColumnUtils.addEscape(insertColumns, getDbType());
             final int insertColumnsSize = insertColumns.size();
             int pkIndex = -1;
             for (int paramIdx = 0; paramIdx < insertColumnsSize; paramIdx++) {

rm-datasource/src/main/java/io/seata/rm/datasource/sql/struct/ColumnMeta.java

@@ -108,6 +108,14 @@ public void setTableSchemaName(String tableSchemaName) {
         this.tableSchemaName = tableSchemaName;
     }
 
+    /**
+     * Gets table schema name
+     * @return
+     */
+    protected String getTableSchemaName() {
+        return tableSchemaName;
+    }
+
     /**
      * Sets table name.
      *
@@ -117,6 +125,15 @@ public void setTableName(String tableName) {
         this.tableName = tableName;
     }
 
+
+    /**
+     * Gets table name
+     * @return
+     */
+    protected String getTableName() {
+        return tableName;
+    }
+
     /**
      * Gets column name.
      *

rm-datasource/src/main/java/io/seata/rm/datasource/sql/struct/IndexMeta.java

@@ -206,15 +206,6 @@ public void setIndextype(IndexType indextype) {
         this.indextype = indextype;
     }
 
-    /**
-     * Gets indexvalue.
-     *
-     * @return the indexvalue
-     */
-    public List<ColumnMeta> getIndexvalue() {
-        return values;
-    }
-
     @Override
     public boolean equals(Object o) {
         if (this == o) {

rm-datasource/src/main/java/io/seata/rm/datasource/sql/struct/TableMeta.java

@@ -34,7 +34,13 @@
 public class TableMeta {
     private String tableName;
 
+    /**
+     * key: column name
+     */
     private Map<String, ColumnMeta> allColumns = new LinkedHashMap<String, ColumnMeta>();
+    /**
+     * key: index name
+     */
     private Map<String, IndexMeta> allIndexes = new LinkedHashMap<String, IndexMeta>();
 
     /**

rm-datasource/src/main/java/io/seata/rm/datasource/sql/struct/TableMetaAdapter.java

@@ -0,0 +1,75 @@
+/*
+ *  Copyright 1999-2019 Seata.io Group.
+ *
+ *  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 io.seata.rm.datasource.sql.struct;
+
+import io.seata.common.util.CollectionUtils;
+import io.seata.rm.datasource.ColumnUtils;
+
+import java.util.List;
+
+/**
+ * @author jsbxyyx
+ */
+public class TableMetaAdapter extends TableMeta {
+
+    private String dbType;
+
+    public String getDbType() {
+        return dbType;
+    }
+
+    public void setDbType(String dbType) {
+        this.dbType = dbType;
+    }
+
+    @Override
+    public void setTableName(String tableName) {
+        if (tableName == null) {
+            return ;
+        }
+        super.setTableName(ColumnUtils.addEscape(tableName, dbType));
+    }
+
+    @Override
+    public ColumnMeta getColumnMeta(String colName) {
+        if (colName == null) {
+            return null;
+        }
+        ColumnMeta col = getAllColumns().get(ColumnUtils.addEscape(colName, dbType));
+        return col;
+    }
+
+    @Override
+    public boolean containsPK(List<String> cols) {
+        if (cols == null) {
+            return false;
+        }
+
+        List<String> pk = getPrimaryKeyOnlyName();
+        if (pk.isEmpty()) {
+            return false;
+        }
+
+        ColumnUtils.addEscape(cols, dbType);
+
+        if (cols.containsAll(pk)) {
+            return true;
+        } else {
+            return CollectionUtils.toUpperList(cols).containsAll(CollectionUtils.toUpperList(pk));
+        }
+    }
+
+}