activerecord-jdbc-alt-adapter 50.3.0-java

data/src/java/arjdbc/mysql/MySQLModule.java

@@ -0,0 +1,152 @@
+/***** BEGIN LICENSE BLOCK *****
+ * Copyright (c) 2012-2013 Karol Bucek <self@kares.org>
+ * Copyright (c) 2006-2010 Nick Sieger <nick@nicksieger.com>
+ * Copyright (c) 2006-2007 Ola Bini <ola.bini@gmail.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ ***** END LICENSE BLOCK *****/
+
+package arjdbc.mysql;
+
+import org.jcodings.specific.UTF8Encoding;
+import org.jruby.Ruby;
+import org.jruby.RubyFixnum;
+import org.jruby.RubyModule;
+import org.jruby.RubyString;
+import org.jruby.anno.JRubyMethod;
+import org.jruby.runtime.ThreadContext;
+import org.jruby.runtime.builtin.IRubyObject;
+import org.jruby.util.ByteList;
+
+import static arjdbc.util.QuotingUtils.BYTES_0;
+import static arjdbc.util.QuotingUtils.BYTES_1;
+import static arjdbc.util.QuotingUtils.quoteCharAndDecorateWith;
+
+public class MySQLModule {
+
+    public static RubyModule load(final RubyModule arJdbc) {
+        RubyModule mysql = arJdbc.defineModuleUnder("MySQL");
+        mysql.defineAnnotatedMethods(MySQLModule.class);
+        return mysql;
+    }
+
+    public static RubyModule load(final Ruby runtime) {
+        return load( arjdbc.ArJdbcModule.get(runtime) );
+    }
+
+    // ActiveRecord::ConnectionAdapters::MySQL::Quoting (almost all of)
+    // without the column/table name 'caches' replicated across threads
+
+    //private final static byte[] ZERO = new byte[] {'\\','0'};
+    //private final static byte[] NEWLINE = new byte[] {'\\','n'};
+    //private final static byte[] CARRIAGE = new byte[] {'\\','r'};
+    //private final static byte[] ZED = new byte[] {'\\','Z'};
+    //private final static byte[] DBL = new byte[] {'\\','"'};
+    //private final static byte[] SINGLE = new byte[] {'\\','\''};
+    //private final static byte[] ESCAPE = new byte[] {'\\','\\'};
+
+    private static final int STRING_QUOTES_OPTIMISTIC_QUESS = 24;
+
+    @JRubyMethod(name = "quote_string", required = 1)
+    public static IRubyObject quote_string(final ThreadContext context,
+        final IRubyObject recv, final IRubyObject string) {
+
+        final ByteList stringBytes = ((RubyString) string).getByteList();
+        final byte[] bytes = stringBytes.unsafeBytes();
+        final int begin = stringBytes.getBegin();
+        final int realSize = stringBytes.getRealSize();
+
+        ByteList quotedBytes = null; int appendFrom = begin;
+        for ( int i = begin; i < begin + realSize; i++ ) {
+            final byte byte2;
+            switch ( bytes[i] ) {
+                case   0  : byte2 = '0';  break;
+                case '\n' : byte2 = 'n';  break;
+                case '\r' : byte2 = 'r';  break;
+                case  26  : byte2 = 'Z';  break;
+                case '"'  : byte2 = '"';  break;
+                case '\'' : byte2 = '\''; break;
+                case '\\' : byte2 = '\\'; break;
+                default   : byte2 = 0;
+            }
+            if ( byte2 != 0 ) {
+                if ( quotedBytes == null ) {
+                    quotedBytes = new ByteList(
+                        new byte[realSize + STRING_QUOTES_OPTIMISTIC_QUESS],
+                        stringBytes.getEncoding()
+                    );
+                    quotedBytes.setBegin(0);
+                    quotedBytes.setRealSize(0);
+                } // copy string on-first quote we "optimize" for non-quoted
+                quotedBytes.append(bytes, appendFrom, i - appendFrom);
+                quotedBytes.append('\\').append(byte2);
+                appendFrom = i + 1;
+            }
+        }
+        if ( quotedBytes != null ) { // append what's left in the end :
+            quotedBytes.append(bytes, appendFrom, begin + realSize - appendFrom);
+        }
+        else return string; // nothing changed, can return original
+
+        final Ruby runtime = context.runtime;
+        final RubyString quoted = runtime.newString(quotedBytes);
+
+        quoted.associateEncoding(UTF8Encoding.INSTANCE);
+
+        return quoted;
+    }
+
+    @JRubyMethod(name = "quoted_true")
+    public static IRubyObject quoted_true(
+            final ThreadContext context,
+            final IRubyObject self) {
+        return RubyString.newString(context.runtime, BYTES_1).freeze(context);
+    }
+
+    @JRubyMethod(name = "quoted_false")
+    public static IRubyObject quoted_false(
+            final ThreadContext context,
+            final IRubyObject self) {
+        return RubyString.newString(context.runtime, BYTES_0).freeze(context);
+    }
+
+    @JRubyMethod(name = "unquoted_true")
+    public static IRubyObject unquoted_true(
+            final ThreadContext context,
+            final IRubyObject self) {
+        return RubyFixnum.one(context.runtime);
+    }
+
+    @JRubyMethod(name = "unquoted_false")
+    public static IRubyObject unquoted_false(
+            final ThreadContext context,
+            final IRubyObject self) {
+        return RubyFixnum.zero(context.runtime);
+    }
+
+    @JRubyMethod(name = "quote_column_name", required = 1)
+    public static IRubyObject quote_column_name(
+            final ThreadContext context,
+            final IRubyObject self,
+            final IRubyObject string) { // "`#{name.to_s.gsub('`', '``')}`"
+        return quoteCharAndDecorateWith(context, string.asString(), '`', '`', (byte) '`', (byte) '`');
+    }
+
+}

data/src/java/arjdbc/mysql/MySQLRubyJdbcConnection.java

@@ -0,0 +1,294 @@
+/***** BEGIN LICENSE BLOCK *****
+ * Copyright (c) 2012-2013 Karol Bucek <self@kares.org>
+ * Copyright (c) 2006-2010 Nick Sieger <nick@nicksieger.com>
+ * Copyright (c) 2006-2007 Ola Bini <ola.bini@gmail.com>
+ * Copyright (c) 2008-2009 Thomas E Enebo <enebo@acm.org>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ ***** END LICENSE BLOCK *****/
+package arjdbc.mysql;
+
+import arjdbc.jdbc.Callable;
+import arjdbc.jdbc.DriverWrapper;
+import arjdbc.jdbc.RubyJdbcConnection;
+import arjdbc.util.DateTimeUtils;
+
+import java.lang.reflect.InvocationTargetException;
+import java.sql.Connection;
+import java.sql.DatabaseMetaData;
+import java.sql.PreparedStatement;
+import java.sql.SQLException;
+import java.sql.ResultSet;
+import java.sql.Statement;
+import java.sql.Timestamp;
+import java.sql.Types;
+
+import org.joda.time.DateTime;
+import org.joda.time.DateTimeZone;
+import org.jruby.*;
+import org.jruby.anno.JRubyMethod;
+import org.jruby.exceptions.RaiseException;
+import org.jruby.runtime.ObjectAllocator;
+import org.jruby.runtime.ThreadContext;
+import org.jruby.runtime.builtin.IRubyObject;
+import org.jruby.util.SafePropertyAccessor;
+
+import static arjdbc.util.StringHelper.newString;
+
+/**
+ *
+ * @author nicksieger
+ */
+@org.jruby.anno.JRubyClass(name = "ActiveRecord::ConnectionAdapters::MySQLJdbcConnection")
+public class MySQLRubyJdbcConnection extends RubyJdbcConnection {
+    private static final long serialVersionUID = -8842614212147138733L;
+
+    public MySQLRubyJdbcConnection(Ruby runtime, RubyClass metaClass) {
+        super(runtime, metaClass);
+    }
+
+    public static RubyClass createMySQLJdbcConnectionClass(Ruby runtime, RubyClass jdbcConnection) {
+        RubyClass clazz = getConnectionAdapters(runtime).
+            defineClassUnder("MySQLJdbcConnection", jdbcConnection, ALLOCATOR);
+        clazz.defineAnnotatedMethods(MySQLRubyJdbcConnection.class);
+        return clazz;
+    }
+
+    public static RubyClass load(final Ruby runtime) {
+        RubyClass jdbcConnection = getJdbcConnection(runtime);
+        return createMySQLJdbcConnectionClass(runtime, jdbcConnection);
+    }
+
+    protected static final ObjectAllocator ALLOCATOR = new ObjectAllocator() {
+        public IRubyObject allocate(Ruby runtime, RubyClass klass) {
+            return new MySQLRubyJdbcConnection(runtime, klass);
+        }
+    };
+
+    @JRubyMethod
+    public IRubyObject query(final ThreadContext context, final IRubyObject sql) throws SQLException {
+        return execute_update(context, sql);
+    }
+
+    @JRubyMethod(name = { "full_version" })
+    public IRubyObject db_version(final ThreadContext context) {
+        return withConnection(context, new Callable<IRubyObject>() {
+            public IRubyObject call(final Connection connection) throws SQLException {
+                final DatabaseMetaData metaData = connection.getMetaData();
+                return context.runtime.newString(metaData.getDatabaseProductVersion());
+            }
+        });
+    }
+
+    @Override
+    protected DriverWrapper newDriverWrapper(final ThreadContext context, final String driver) {
+        DriverWrapper driverWrapper = super.newDriverWrapper(context, driver);
+
+        final java.sql.Driver jdbcDriver = driverWrapper.getDriverInstance();
+        if ( jdbcDriver.getClass().getName().startsWith("com.mysql.jdbc.") ) {
+            final int major = jdbcDriver.getMajorVersion();
+            final int minor = jdbcDriver.getMinorVersion();
+            if ( major < 5 ) {
+                final RubyClass errorClass = getConnectionNotEstablished(context.runtime);
+                throw context.runtime.newRaiseException(errorClass,
+                    "MySQL adapter requires driver >= 5.0 got: " + major + "." + minor + "");
+            }
+            if ( major == 5 && minor < 1 ) { // need 5.1 for JDBC 4.0
+                // lightweight validation query: "/* ping */ SELECT 1"
+                setConfigValueIfNotSet(context, "connection_alive_sql", context.runtime.newString("/* ping */ SELECT 1"));
+            }
+            driverAdapter = new MySQLDriverAdapter(); // short-circuit
+        }
+        else {
+            driverAdapter = new DriverAdapter(); // short-circuit (MariaDB)
+        }
+
+        return driverWrapper;
+    }
+
+    private static transient Class MYSQL_CONNECTION;
+    private static transient Boolean MYSQL_CONNECTION_FOUND;
+
+    private static boolean checkMySQLConnection(final Connection connection) {
+        Class mysqlDriverIface = MYSQL_CONNECTION;
+        if (mysqlDriverIface == null && MYSQL_CONNECTION_FOUND == null) {
+            try {
+                MYSQL_CONNECTION = Class.forName("com.mysql.jdbc.MySQLConnection", false, MySQLRubyJdbcConnection.class.getClassLoader());
+                MYSQL_CONNECTION_FOUND = Boolean.TRUE;
+            }
+            catch (ClassNotFoundException ex) {
+                MYSQL_CONNECTION_FOUND = Boolean.FALSE;
+            }
+            mysqlDriverIface = MYSQL_CONNECTION;
+        }
+        if (mysqlDriverIface == null) return false;
+        try {
+            return connection.isWrapperFor(mysqlDriverIface);
+        }
+        catch (SQLException ex) {
+            return false;
+        }
+    }
+
+    private boolean usingMySQLDriver() {
+        return checkMySQLConnection(getConnection(true));
+    }
+
+    private transient DriverAdapter driverAdapter;
+
+    // NOTE: currently un-used but we'll need it if we attempt to handle fast string extraction
+    private DriverAdapter getDriverAdapter() {
+        if (driverAdapter == null) {
+            driverAdapter = usingMySQLDriver() ? new MySQLDriverAdapter() : new DriverAdapter();
+        }
+        return driverAdapter;
+    }
+
+    private class DriverAdapter { // sensible driver without quirks (MariaDB)
+        // left in for encoding specific extraction from driver - would allow us 'fast' string byte[] extraction
+    }
+
+    private class MySQLDriverAdapter extends DriverAdapter { // Connector/J (bloated) 5.x version
+        // left in for encoding specific extraction from driver - would allow us 'fast' string byte[] extraction
+    }
+
+    @Override
+    protected boolean doExecute(final Statement statement, final String query) throws SQLException {
+        return statement.execute(query, Statement.RETURN_GENERATED_KEYS);
+    }
+
+    @Override
+    protected IRubyObject jdbcToRuby(final ThreadContext context, final Ruby runtime,
+        final int column, final int type, final ResultSet resultSet) throws SQLException {
+        if ( type == Types.BIT ) {
+            final int value = resultSet.getInt(column);
+            return resultSet.wasNull() ? context.nil : runtime.newFixnum(value);
+        }
+        return super.jdbcToRuby(context, runtime, column, type, resultSet);
+    }
+
+    @Override
+    protected void setTimeParameter(final ThreadContext context,
+        final Connection connection, final PreparedStatement statement,
+        final int index, IRubyObject value,
+        final IRubyObject attribute, final int type) throws SQLException {
+        // MySQL's TIME supports fractional seconds up-to nano precision: .000000
+        setTimestampParameter(context, connection, statement, index, value, attribute, type);
+    }
+
+    @Override
+    protected IRubyObject timeToRuby(final ThreadContext context,
+        final Ruby runtime, final ResultSet resultSet, final int column)
+        throws SQLException { // due MySQL's TIME precision (up to nanos)
+
+        final Timestamp value = resultSet.getTimestamp(column);
+        if ( value == null ) {
+            return resultSet.wasNull() ? context.nil : RubyString.newEmptyString(runtime);
+        }
+
+        if ( rawDateTime != null && rawDateTime.booleanValue() ) {
+            return RubyString.newString(runtime, DateTimeUtils.dummyTimeToString(value));
+        }
+
+        return DateTimeUtils.newDummyTime(context, value, getDefaultTimeZone(context));
+    }
+
+    @Override
+    protected IRubyObject streamToRuby(final ThreadContext context,
+        final Ruby runtime, final ResultSet resultSet, final int column)
+        throws SQLException {
+        final byte[] bytes = resultSet.getBytes(column);
+        if ( bytes == null /* || resultSet.wasNull() */ ) return context.nil;
+        return newString(runtime, bytes);
+    }
+
+    // MySQL does never storesUpperCaseIdentifiers() :
+    // storesLowerCaseIdentifiers() depends on "lower_case_table_names" server variable
+
+    @Override
+    protected final String caseConvertIdentifierForRails(final Connection connection, final String value) {
+        return value; // MySQL does not storesUpperCaseIdentifiers() :
+    }
+
+    private transient Boolean lowerCaseIdentifiers;
+
+    @Override
+    protected final String caseConvertIdentifierForJdbc(
+        final Connection connection, final String value) throws SQLException {
+        if ( value == null ) return null;
+        Boolean lowerCase = lowerCaseIdentifiers;
+        if (lowerCase == null) {
+            lowerCase = lowerCaseIdentifiers = connection.getMetaData().storesLowerCaseIdentifiers();
+        }
+        return lowerCase.booleanValue() ? value.toLowerCase() : value;
+    }
+
+    @Override
+    protected Connection newConnection() throws RaiseException, SQLException {
+        final Connection connection;
+        try {
+            connection = super.newConnection();
+        }
+        catch (SQLException ex) {
+            if (ex.getErrorCode() == 1049) throw newNoDatabaseError(ex);
+            throw ex;
+        }
+        if ( doStopCleanupThread() ) shutdownCleanupThread();
+        return connection;
+    }
+
+    private static Boolean stopCleanupThread;
+    static {
+        final String stopThread = SafePropertyAccessor.getProperty("arjdbc.mysql.stop_cleanup_thread");
+        if ( stopThread != null ) stopCleanupThread = Boolean.parseBoolean(stopThread);
+    }
+
+    private static boolean doStopCleanupThread() throws SQLException {
+        return stopCleanupThread != null && stopCleanupThread.booleanValue();
+    }
+
+    private static boolean cleanupThreadShutdown;
+
+    @SuppressWarnings("unchecked")
+    private static void shutdownCleanupThread() {
+        if ( cleanupThreadShutdown ) return;
+        try {
+            Class threadClass = Class.forName("com.mysql.jdbc.AbandonedConnectionCleanupThread");
+            threadClass.getMethod("shutdown").invoke(null);
+        }
+        catch (ClassNotFoundException e) {
+            debugMessage(null, "missing MySQL JDBC cleanup thread ", e);
+        }
+        catch (NoSuchMethodException e) {
+            debugMessage(null, e);
+        }
+        catch (IllegalAccessException e) {
+            debugMessage(null, e);
+        }
+        catch (InvocationTargetException e) {
+            debugMessage(null, e.getTargetException());
+        }
+        catch (SecurityException e) {
+            debugMessage(null, e);
+        }
+        finally { cleanupThreadShutdown = true; }
+    }
+
+}

data/src/java/arjdbc/oracle/OracleModule.java

@@ -0,0 +1,80 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2013-2014 Karol Bucek.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package arjdbc.oracle;
+
+import static arjdbc.util.QuotingUtils.BYTES_0;
+import static arjdbc.util.QuotingUtils.BYTES_1;
+import static arjdbc.util.QuotingUtils.quoteCharWith;
+
+import org.jruby.Ruby;
+import org.jruby.RubyModule;
+import org.jruby.RubyString;
+import org.jruby.anno.JRubyMethod;
+import org.jruby.runtime.ThreadContext;
+import org.jruby.runtime.builtin.IRubyObject;
+
+/**
+ * ArJdbc::Oracle
+ *
+ * @author kares
+ */
+public class OracleModule {
+
+    public static RubyModule load(final RubyModule arJdbc) {
+        RubyModule oracle = arJdbc.defineModuleUnder("Oracle");
+        oracle.defineAnnotatedMethods( OracleModule.class );
+        return oracle;
+    }
+
+    public static RubyModule load(final Ruby runtime) {
+        return load( arjdbc.ArJdbcModule.get(runtime) );
+    }
+
+    @JRubyMethod(name = "quote_string", required = 1)
+    public static IRubyObject quote_string(
+            final ThreadContext context,
+            final IRubyObject self,
+            final IRubyObject string) { // string.gsub("'", "''") :
+        final char single = '\'';
+        final RubyString quoted = quoteCharWith(
+            context, (RubyString) string, single, single
+        );
+        return quoted;
+    }
+
+    @JRubyMethod(name = "quoted_true", required = 0)
+    public static IRubyObject quoted_true(
+            final ThreadContext context,
+            final IRubyObject self) {
+        return RubyString.newString(context.runtime, BYTES_1);
+    }
+
+    @JRubyMethod(name = "quoted_false", required = 0)
+    public static IRubyObject quoted_false(
+            final ThreadContext context,
+            final IRubyObject self) {
+        return RubyString.newString(context.runtime, BYTES_0);
+    }
+
+}