Fix for Bug#21294134, DBMD.GETPROCEDURECOLUMNS() IS UNABLE TO DEAL WITH PROCEDURE COLUMNS WITH SPACES.

Change-Id: I8705a6e364deb699bfd64fd19e7038ee390fb6f1

Author: Axyoan Marcelo

CHANGES

@@ -3,6 +3,8 @@
 
 Version 9.4.0
 
+  - Fix for Bug#21294134, DBMD.GETPROCEDURECOLUMNS() IS UNABLE TO DEAL WITH PROCEDURE COLUMNS WITH SPACES.
+
   - Fix for Bug#77658 (Bug#21946136), Incorrect java.sql.Statement.cancel() behavior.
 
   - Fix for Bug#118100 (Bug#37900711), `You have an error in your SQL syntax` exception thrown after `mysql-connector-j` `9.2.0` -> `9.3.0` upgrade.

src/main/user-impl/java/com/mysql/cj/jdbc/DatabaseMetaDataMysqlSchema.java

@@ -52,6 +52,7 @@
 import com.mysql.cj.result.Field;
 import com.mysql.cj.result.Row;
 import com.mysql.cj.util.SearchMode;
+import com.mysql.cj.util.StringInspector;
 import com.mysql.cj.util.StringUtils;
 
 /**
@@ -921,52 +922,52 @@ private List<Row> extractStoredRoutineColumnsTypeInfo(String dbName, String rout
                 boolean isOutParam = false;
                 boolean isInParam = false;
 
-                // Bug#52167, tokenizer will break if declaration contains special characters like '\n'.
-                declaration = declaration.replaceAll("[\\t\\n\\x0B\\f\\r]", " ");
-                StringTokenizer declarationTok = new StringTokenizer(declaration, " ");
-                if (declarationTok.hasMoreTokens()) {
-                    String possibleParamName = declarationTok.nextToken();
+                boolean noBackslashEscapes = getSession().getServerSession().isNoBackslashEscapesSet();
+                StringInspector strInspector = new StringInspector(declaration, openingDelimiters, closingDelimiters, "",
+                        noBackslashEscapes ? SearchMode.__MRK_COM_MYM_HNT_WS : SearchMode.__BSE_MRK_COM_MYM_HNT_WS);
+
+                int endPos = strInspector.indexOfNextWsChar();
+                int startPos = 0;
+                if (endPos != -1) {
+                    String possibleParamName = declaration.substring(startPos, endPos);
+                    boolean firstStringWasParamType = false;
                     if (possibleParamName.equalsIgnoreCase("OUT")) {
                         isOutParam = true;
                         isInParam = false;
-                        if (declarationTok.hasMoreTokens()) {
-                            paramName = declarationTok.nextToken();
-                        } else {
-                            throw SQLError.createSQLException(Messages.getString("DatabaseMetaData.6"), MysqlErrorNumbers.SQLSTATE_CONNJ_GENERAL_ERROR,
-                                    getExceptionInterceptor());
-                        }
+                        firstStringWasParamType = true;
                     } else if (possibleParamName.equalsIgnoreCase("INOUT")) {
                         isOutParam = true;
                         isInParam = true;
-                        if (declarationTok.hasMoreTokens()) {
-                            paramName = declarationTok.nextToken();
-                        } else {
-                            throw SQLError.createSQLException(Messages.getString("DatabaseMetaData.6"), MysqlErrorNumbers.SQLSTATE_CONNJ_GENERAL_ERROR,
-                                    getExceptionInterceptor());
-                        }
+                        firstStringWasParamType = true;
                     } else if (possibleParamName.equalsIgnoreCase("IN")) {
                         isOutParam = false;
                         isInParam = true;
-                        if (declarationTok.hasMoreTokens()) {
-                            paramName = declarationTok.nextToken();
-                        } else {
-                            throw SQLError.createSQLException(Messages.getString("DatabaseMetaData.6"), MysqlErrorNumbers.SQLSTATE_CONNJ_GENERAL_ERROR,
-                                    getExceptionInterceptor());
-                        }
+                        firstStringWasParamType = true;
                     } else {
                         isOutParam = false;
                         isInParam = true;
                         paramName = possibleParamName;
                     }
 
-                    TypeDescriptor typeDesc = null;
-                    if (declarationTok.hasMoreTokens()) {
-                        StringBuilder typeInfo = new StringBuilder(declarationTok.nextToken());
-                        while (declarationTok.hasMoreTokens()) {
-                            typeInfo.append(" ");
-                            typeInfo.append(declarationTok.nextToken());
+                    if (firstStringWasParamType) {
+                        while (Character.isWhitespace(strInspector.getChar())) {
+                            strInspector.incrementPosition();
+                        }
+                        startPos = strInspector.getPosition();
+                        endPos = strInspector.indexOfNextWsChar();
+                        if (endPos != -1) {
+                            paramName = declaration.substring(startPos, endPos);
+                        } else {
+                            throw SQLError.createSQLException(Messages.getString("DatabaseMetaData.6"), MysqlErrorNumbers.SQLSTATE_CONNJ_GENERAL_ERROR,
+                                    getExceptionInterceptor());
                         }
-                        typeDesc = new TypeDescriptor(typeInfo.toString(), "YES");
+                    }
+
+                    TypeDescriptor typeDesc = null;
+                    if (strInspector.getPosition() != declaration.length()) {
+                        startPos = strInspector.indexOfNextNonWsChar();
+                        endPos = declaration.length();
+                        typeDesc = new TypeDescriptor(declaration.substring(startPos, endPos), "YES");
                     } else {
                         throw SQLError.createSQLException(Messages.getString("DatabaseMetaData.7"), MysqlErrorNumbers.SQLSTATE_CONNJ_GENERAL_ERROR,
                                 getExceptionInterceptor());

src/test/java/testsuite/regression/MetaDataRegressionTest.java

@@ -5964,4 +5964,57 @@ void testBug118100() throws Exception {
         } while (useIS = !useIS);
     }
 
+    /**
+     * Tests fix for Bug#21294134, DBMD.GETPROCEDURECOLUMNS() IS UNABLE TO DEAL WITH PROCEDURE COLUMNS WITH SPACES.
+     *
+     * @throws Exception
+     */
+    @Test
+    void testBug21294134() throws Exception {
+        boolean useIS = false;
+        boolean useAnsiQuotes = false;
+        do {
+            String sqlMode = getMysqlVariable("sql_mode");
+            sqlMode = removeSqlMode("ANSI_QUOTES", sqlMode);
+            if (sqlMode.length() > 0) {
+                sqlMode += ",";
+            }
+            if (useAnsiQuotes) {
+                sqlMode += "ANSI_QUOTES";
+            }
+            Properties props = new Properties();
+            props.setProperty(PropertyKey.useInformationSchema.getKeyName(), Boolean.toString(useIS));
+            props.setProperty(PropertyKey.sessionVariables.getKeyName(), "sql_mode='" + sqlMode + "'");
+            this.conn = getConnectionWithProps(props);
+
+            String procDef = "(IN `a 1` ENUM ('a', 'b'), INOUT `a\n2` SET ('c', 'd')) BEGIN SELECT CONCAT(`a 1`, `a\n2`) INTO `a\n2`;  END";
+            String funcDef = "(`b 1` ENUM ('a', 'b'), `b\n2` SET ('c', 'd')) RETURNS INT DETERMINISTIC RETURN CONCAT(`b 1`, `b\n2`)";
+            if (useAnsiQuotes) {
+                procDef.replaceAll("`", "\"");
+                funcDef.replaceAll("`", "\"");
+            }
+
+            Statement testStmt = this.conn.createStatement();
+            createProcedure(testStmt, "testBug21294134p", procDef);
+            createFunction(testStmt, "testBug21294134f", funcDef);
+
+            final String testCase = String.format("Case: [useIS: %s, useAnsiQuotes: %s]", useIS ? "Y" : "N", useAnsiQuotes ? "Y" : "N");
+
+            DatabaseMetaData dbmd = this.conn.getMetaData();
+
+            this.rs = dbmd.getProcedureColumns(null, null, "testBug21294134p", null);
+            assertTrue(this.rs.next());
+            assertEquals("a 1", this.rs.getString("COLUMN_NAME"), testCase);
+            assertTrue(this.rs.next());
+            assertEquals("a\n2", this.rs.getString("COLUMN_NAME"), testCase);
+
+            this.rs = dbmd.getFunctionColumns(null, null, "testBug21294134f", null);
+            assertTrue(this.rs.next());
+            assertTrue(this.rs.next());
+            assertEquals("b 1", this.rs.getString("COLUMN_NAME"), testCase);
+            assertTrue(this.rs.next());
+            assertEquals("b\n2", this.rs.getString("COLUMN_NAME"), testCase);
+        } while (useIS = !useIS);
+    }
+
 }