activerecord 1.0.0 → 4.0.0

data/lib/active_record/connection_adapters/mysql_adapter.rb

@@ -1,131 +1,558 @@
-require 'active_record/connection_adapters/abstract_adapter'
-require 'parsedate'
-
-begin
-  begin
-    # Only include the MySQL driver if one hasn't already been loaded
-    require 'mysql' unless self.class.const_defined?(:Mysql)
-  rescue LoadError
-    # Only use the supplied backup Ruby/MySQL driver if no driver is already in place
-    require 'active_record/vendor/mysql'
+require 'active_record/connection_adapters/abstract_mysql_adapter'
+require 'active_record/connection_adapters/statement_pool'
+require 'active_support/core_ext/hash/keys'
+
+gem 'mysql', '~> 2.9'
+require 'mysql'
+
+class Mysql
+  class Time
+    def to_date
+      Date.new(year, month, day)
+    end
   end
+  class Stmt; include Enumerable end
+  class Result; include Enumerable end
+end
 
 module ActiveRecord
-  class Base
-    # Establishes a connection to the database that's used by all Active Record objects
-    def self.mysql_connection(config) # :nodoc:
-      symbolize_strings_in_hash(config)
+  module ConnectionHandling # :nodoc:
+    # Establishes a connection to the database that's used by all Active Record objects.
+    def mysql_connection(config)
+      config = config.symbolize_keys
       host     = config[:host]
       port     = config[:port]
       socket   = config[:socket]
-      username = config[:username] || "root"
-      password = config[:password]
+      username = config[:username] ? config[:username].to_s : 'root'
+      password = config[:password].to_s
+      database = config[:database]
 
-      if config.has_key?(:database)
-        database = config[:database]
-      else
-        raise ArgumentError, "No database specified. Missing argument: database."
-      end
+      mysql = Mysql.init
+      mysql.ssl_set(config[:sslkey], config[:sslcert], config[:sslca], config[:sslcapath], config[:sslcipher]) if config[:sslca] || config[:sslkey]
 
-      ConnectionAdapters::MysqlAdapter.new(
-        Mysql::real_connect(host, username, password, database, port, socket), logger
-      )
+      default_flags = Mysql.const_defined?(:CLIENT_MULTI_RESULTS) ? Mysql::CLIENT_MULTI_RESULTS : 0
+      default_flags |= Mysql::CLIENT_FOUND_ROWS if Mysql.const_defined?(:CLIENT_FOUND_ROWS)
+      options = [host, username, password, database, port, socket, default_flags]
+      ConnectionAdapters::MysqlAdapter.new(mysql, logger, options, config)
     end
   end
 
   module ConnectionAdapters
-    class MysqlAdapter < AbstractAdapter # :nodoc:
-      def select_all(sql, name = nil)
-        select(sql, name)
+    # The MySQL adapter will work with both Ruby/MySQL, which is a Ruby-based MySQL adapter that comes bundled with Active Record, and with
+    # the faster C-based MySQL/Ruby adapter (available both as a gem and from http://www.tmtm.org/en/mysql/ruby/).
+    #
+    # Options:
+    #
+    # * <tt>:host</tt> - Defaults to "localhost".
+    # * <tt>:port</tt> - Defaults to 3306.
+    # * <tt>:socket</tt> - Defaults to "/tmp/mysql.sock".
+    # * <tt>:username</tt> - Defaults to "root"
+    # * <tt>:password</tt> - Defaults to nothing.
+    # * <tt>:database</tt> - The name of the database. No default, must be provided.
+    # * <tt>:encoding</tt> - (Optional) Sets the client encoding by executing "SET NAMES <encoding>" after connection.
+    # * <tt>:reconnect</tt> - Defaults to false (See MySQL documentation: http://dev.mysql.com/doc/refman/5.0/en/auto-reconnect.html).
+    # * <tt>:strict</tt> - Defaults to true. Enable STRICT_ALL_TABLES. (See MySQL documentation: http://dev.mysql.com/doc/refman/5.0/en/server-sql-mode.html)
+    # * <tt>:variables</tt> - (Optional) A hash session variables to send as `SET @@SESSION.key = value` on each database connection. Use the value `:default` to set a variable to its DEFAULT value. (See MySQL documentation: http://dev.mysql.com/doc/refman/5.0/en/set-statement.html).
+    # * <tt>:sslca</tt> - Necessary to use MySQL with an SSL connection.
+    # * <tt>:sslkey</tt> - Necessary to use MySQL with an SSL connection.
+    # * <tt>:sslcert</tt> - Necessary to use MySQL with an SSL connection.
+    # * <tt>:sslcapath</tt> - Necessary to use MySQL with an SSL connection.
+    # * <tt>:sslcipher</tt> - Necessary to use MySQL with an SSL connection.
+    #
+    class MysqlAdapter < AbstractMysqlAdapter
+
+      class Column < AbstractMysqlAdapter::Column #:nodoc:
+        def self.string_to_time(value)
+          return super unless Mysql::Time === value
+          new_time(
+            value.year,
+            value.month,
+            value.day,
+            value.hour,
+            value.minute,
+            value.second,
+            value.second_part)
+        end
+
+        def self.string_to_dummy_time(v)
+          return super unless Mysql::Time === v
+          new_time(2000, 01, 01, v.hour, v.minute, v.second, v.second_part)
+        end
+
+        def self.string_to_date(v)
+          return super unless Mysql::Time === v
+          new_date(v.year, v.month, v.day)
+        end
+
+        def adapter
+          MysqlAdapter
+        end
       end
 
-      def select_one(sql, name = nil)
-        result = select(sql, name)
-        result.nil? ? nil : result.first
+      ADAPTER_NAME = 'MySQL'
+
+      class StatementPool < ConnectionAdapters::StatementPool
+        def initialize(connection, max = 1000)
+          super
+          @cache = Hash.new { |h,pid| h[pid] = {} }
+        end
+
+        def each(&block); cache.each(&block); end
+        def key?(key);    cache.key?(key); end
+        def [](key);      cache[key]; end
+        def length;       cache.length; end
+        def delete(key);  cache.delete(key); end
+
+        def []=(sql, key)
+          while @max <= cache.size
+            cache.shift.last[:stmt].close
+          end
+          cache[sql] = key
+        end
+
+        def clear
+          cache.values.each do |hash|
+            hash[:stmt].close
+          end
+          cache.clear
+        end
+
+        private
+        def cache
+          @cache[Process.pid]
+        end
+      end
+
+      def initialize(connection, logger, connection_options, config)
+        super
+        @statements = StatementPool.new(@connection,
+                                        self.class.type_cast_config_to_integer(config.fetch(:statement_limit) { 1000 }))
+        @client_encoding = nil
+        connect
+      end
+
+      # Returns true, since this connection adapter supports prepared statement
+      # caching.
+      def supports_statement_cache?
+        true
+      end
+
+      # HELPER METHODS ===========================================
+
+      def each_hash(result) # :nodoc:
+        if block_given?
+          result.each_hash do |row|
+            row.symbolize_keys!
+            yield row
+          end
+        else
+          to_enum(:each_hash, result)
+        end
       end
 
-      def columns(table_name, name = nil)
-        sql = "SHOW FIELDS FROM #{table_name}"
-        result = nil
-        log(sql, name, @connection) { |connection| result = connection.query(sql) }
+      def new_column(field, default, type, null, collation, extra = "") # :nodoc:
+        Column.new(field, default, type, null, collation, strict_mode?, extra)
+      end
 
-        columns = []
-        result.each { |field| columns << Column.new(field[0], field[4], field[1]) }
-        columns
+      def error_number(exception) # :nodoc:
+        exception.errno if exception.respond_to?(:errno)
       end
 
-      def insert(sql, name = nil, pk = nil, id_value = nil)
-        execute(sql, name = nil)
-        return id_value || @connection.insert_id
+      # QUOTING ==================================================
+
+      def type_cast(value, column)
+        return super unless value == true || value == false
+
+        value ? 1 : 0
       end
 
-      def execute(sql, name = nil)
-        log(sql, name, @connection) { |connection| connection.query(sql) }
+      def quote_string(string) #:nodoc:
+        @connection.quote(string)
       end
 
-      alias_method :update, :execute
-      alias_method :delete, :execute
-      
-      def begin_db_transaction
-        begin
-          execute "BEGIN"
-        rescue Exception
-          # Transactions aren't supported
+      # CONNECTION MANAGEMENT ====================================
+
+      def active?
+        if @connection.respond_to?(:stat)
+          @connection.stat
+        else
+          @connection.query 'select 1'
+        end
+
+        # mysql-ruby doesn't raise an exception when stat fails.
+        if @connection.respond_to?(:errno)
+          @connection.errno.zero?
+        else
+          true
         end
+      rescue Mysql::Error
+        false
+      end
+
+      def reconnect!
+        super
+        disconnect!
+        connect
+      end
+
+      # Disconnects from the database if already connected. Otherwise, this
+      # method does nothing.
+      def disconnect!
+        super
+        @connection.close rescue nil
       end
-      
-      def commit_db_transaction
-        begin
-          execute "COMMIT"
-        rescue Exception
-          # Transactions aren't supported
+
+      def reset!
+        if @connection.respond_to?(:change_user)
+          # See http://bugs.mysql.com/bug.php?id=33540 -- the workaround way to
+          # reset the connection is to change the user to the same user.
+          @connection.change_user(@config[:username], @config[:password], @config[:database])
+          configure_connection
         end
       end
-      
-      def rollback_db_transaction
-        begin
-          execute "ROLLBACK"
-        rescue Exception
-          # Transactions aren't supported
+
+      # DATABASE STATEMENTS ======================================
+
+      def select_rows(sql, name = nil)
+        @connection.query_with_result = true
+        rows = exec_query(sql, name).rows
+        @connection.more_results && @connection.next_result    # invoking stored procedures with CLIENT_MULTI_RESULTS requires this to tidy up else connection will be dropped
+        rows
+      end
+
+      # Clears the prepared statements cache.
+      def clear_cache!
+        @statements.clear
+      end
+
+      # Taken from here:
+      #   https://github.com/tmtm/ruby-mysql/blob/master/lib/mysql/charset.rb
+      # Author: TOMITA Masahiro <tommy@tmtm.org>
+      ENCODINGS = {
+        "armscii8" => nil,
+        "ascii"    => Encoding::US_ASCII,
+        "big5"     => Encoding::Big5,
+        "binary"   => Encoding::ASCII_8BIT,
+        "cp1250"   => Encoding::Windows_1250,
+        "cp1251"   => Encoding::Windows_1251,
+        "cp1256"   => Encoding::Windows_1256,
+        "cp1257"   => Encoding::Windows_1257,
+        "cp850"    => Encoding::CP850,
+        "cp852"    => Encoding::CP852,
+        "cp866"    => Encoding::IBM866,
+        "cp932"    => Encoding::Windows_31J,
+        "dec8"     => nil,
+        "eucjpms"  => Encoding::EucJP_ms,
+        "euckr"    => Encoding::EUC_KR,
+        "gb2312"   => Encoding::EUC_CN,
+        "gbk"      => Encoding::GBK,
+        "geostd8"  => nil,
+        "greek"    => Encoding::ISO_8859_7,
+        "hebrew"   => Encoding::ISO_8859_8,
+        "hp8"      => nil,
+        "keybcs2"  => nil,
+        "koi8r"    => Encoding::KOI8_R,
+        "koi8u"    => Encoding::KOI8_U,
+        "latin1"   => Encoding::ISO_8859_1,
+        "latin2"   => Encoding::ISO_8859_2,
+        "latin5"   => Encoding::ISO_8859_9,
+        "latin7"   => Encoding::ISO_8859_13,
+        "macce"    => Encoding::MacCentEuro,
+        "macroman" => Encoding::MacRoman,
+        "sjis"     => Encoding::SHIFT_JIS,
+        "swe7"     => nil,
+        "tis620"   => Encoding::TIS_620,
+        "ucs2"     => Encoding::UTF_16BE,
+        "ujis"     => Encoding::EucJP_ms,
+        "utf8"     => Encoding::UTF_8,
+        "utf8mb4"  => Encoding::UTF_8,
+      }
+
+      # Get the client encoding for this database
+      def client_encoding
+        return @client_encoding if @client_encoding
+
+        result = exec_query(
+          "SHOW VARIABLES WHERE Variable_name = 'character_set_client'",
+          'SCHEMA')
+        @client_encoding = ENCODINGS[result.rows.last.last]
+      end
+
+      def exec_query(sql, name = 'SQL', binds = [])
+        # If the configuration sets prepared_statements:false, binds will
+        # always be empty, since the bind variables will have been already
+        # substituted and removed from binds by BindVisitor, so this will
+        # effectively disable prepared statement usage completely.
+        if binds.empty?
+          result_set, affected_rows = exec_without_stmt(sql, name)
+        else
+          result_set, affected_rows = exec_stmt(sql, name, binds)
         end
+
+        yield affected_rows if block_given?
+
+        result_set
       end
 
-      def quote_column_name(name)
-        return "`#{name}`"
+      def last_inserted_id(result)
+        @connection.insert_id
       end
-      
-      def structure_dump
-        select_all("SHOW TABLES").inject("") do |structure, table|
-          structure += select_one("SHOW CREATE TABLE #{table.to_a.first.last}")["Create Table"] + ";\n\n"
+
+      module Fields
+        class Type
+          def type; end
+
+          def type_cast_for_write(value)
+            value
+          end
+        end
+
+        class Identity < Type
+          def type_cast(value); value; end
         end
+
+        class Integer < Type
+          def type_cast(value)
+            return if value.nil?
+
+            value.to_i rescue value ? 1 : 0
+          end
+        end
+
+        class Date < Type
+          def type; :date; end
+
+          def type_cast(value)
+            return if value.nil?
+
+            # FIXME: probably we can improve this since we know it is mysql
+            # specific
+            ConnectionAdapters::Column.value_to_date value
+          end
+        end
+
+        class DateTime < Type
+          def type; :datetime; end
+
+          def type_cast(value)
+            return if value.nil?
+
+            # FIXME: probably we can improve this since we know it is mysql
+            # specific
+            ConnectionAdapters::Column.string_to_time value
+          end
+        end
+
+        class Time < Type
+          def type; :time; end
+
+          def type_cast(value)
+            return if value.nil?
+
+            # FIXME: probably we can improve this since we know it is mysql
+            # specific
+            ConnectionAdapters::Column.string_to_dummy_time value
+          end
+        end
+
+        class Float < Type
+          def type; :float; end
+
+          def type_cast(value)
+            return if value.nil?
+
+            value.to_f
+          end
+        end
+
+        class Decimal < Type
+          def type_cast(value)
+            return if value.nil?
+
+            ConnectionAdapters::Column.value_to_decimal value
+          end
+        end
+
+        class Boolean < Type
+          def type_cast(value)
+            return if value.nil?
+
+            ConnectionAdapters::Column.value_to_boolean value
+          end
+        end
+
+        TYPES = {}
+
+        # Register an MySQL +type_id+ with a typecasting object in
+        # +type+.
+        def self.register_type(type_id, type)
+          TYPES[type_id] = type
+        end
+
+        def self.alias_type(new, old)
+          TYPES[new] = TYPES[old]
+        end
+
+        register_type Mysql::Field::TYPE_TINY,    Fields::Boolean.new
+        register_type Mysql::Field::TYPE_LONG,    Fields::Integer.new
+        alias_type Mysql::Field::TYPE_LONGLONG,   Mysql::Field::TYPE_LONG
+        alias_type Mysql::Field::TYPE_NEWDECIMAL, Mysql::Field::TYPE_LONG
+
+        register_type Mysql::Field::TYPE_VAR_STRING, Fields::Identity.new
+        register_type Mysql::Field::TYPE_BLOB, Fields::Identity.new
+        register_type Mysql::Field::TYPE_DATE, Fields::Date.new
+        register_type Mysql::Field::TYPE_DATETIME, Fields::DateTime.new
+        register_type Mysql::Field::TYPE_TIME, Fields::Time.new
+        register_type Mysql::Field::TYPE_FLOAT, Fields::Float.new
+
+        Mysql::Field.constants.grep(/TYPE/).map { |class_name|
+          Mysql::Field.const_get class_name
+        }.reject { |const| TYPES.key? const }.each do |const|
+          register_type const, Fields::Identity.new
+        end
+      end
+
+      def exec_without_stmt(sql, name = 'SQL') # :nodoc:
+        # Some queries, like SHOW CREATE TABLE don't work through the prepared
+        # statement API. For those queries, we need to use this method. :'(
+        log(sql, name) do
+          result = @connection.query(sql)
+          affected_rows = @connection.affected_rows
+
+          if result
+            types = {}
+            result.fetch_fields.each { |field|
+              if field.decimals > 0
+                types[field.name] = Fields::Decimal.new
+              else
+                types[field.name] = Fields::TYPES.fetch(field.type) {
+                  Fields::Identity.new
+                }
+              end
+            }
+            result_set = ActiveRecord::Result.new(types.keys, result.to_a, types)
+            result.free
+          else
+            result_set = ActiveRecord::Result.new([], [])
+          end
+
+          [result_set, affected_rows]
+        end
+      end
+
+      def execute_and_free(sql, name = nil)
+        result = execute(sql, name)
+        ret = yield result
+        result.free
+        ret
       end
-      
-      def recreate_database(name)
-        drop_database(name)
-        create_database(name)
+
+      def insert_sql(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil) #:nodoc:
+        super sql, name
+        id_value || @connection.insert_id
       end
-      
-      def drop_database(name)
-        execute "DROP DATABASE IF EXISTS #{name}"
+      alias :create :insert_sql
+
+      def exec_delete(sql, name, binds)
+        affected_rows = 0
+
+        exec_query(sql, name, binds) do |n|
+          affected_rows = n
+        end
+
+        affected_rows
       end
-      
-      def create_database(name)
-        execute "CREATE DATABASE #{name}"
+      alias :exec_update :exec_delete
+
+      def begin_db_transaction #:nodoc:
+        exec_query "BEGIN"
+      rescue Mysql::Error
+        # Transactions aren't supported
       end
-      
+
       private
-        def select(sql, name = nil)
-          result = nil
-          log(sql, name, @connection) { |connection| connection.query_with_result = true; result = connection.query(sql) }
-          rows = []
-          all_fields_initialized = result.fetch_fields.inject({}) { |all_fields, f| all_fields[f.name] = nil; all_fields }
-          result.each_hash { |row| rows << all_fields_initialized.dup.update(row) }
-          rows
+
+      def exec_stmt(sql, name, binds)
+        cache = {}
+        log(sql, name, binds) do
+          if binds.empty?
+            stmt = @connection.prepare(sql)
+          else
+            cache = @statements[sql] ||= {
+              :stmt => @connection.prepare(sql)
+            }
+            stmt = cache[:stmt]
+          end
+
+          begin
+            stmt.execute(*binds.map { |col, val| type_cast(val, col) })
+          rescue Mysql::Error => e
+            # Older versions of MySQL leave the prepared statement in a bad
+            # place when an error occurs. To support older mysql versions, we
+            # need to close the statement and delete the statement from the
+            # cache.
+            stmt.close
+            @statements.delete sql
+            raise e
+          end
+
+          cols = nil
+          if metadata = stmt.result_metadata
+            cols = cache[:cols] ||= metadata.fetch_fields.map { |field|
+              field.name
+            }
+          end
+
+          result_set = ActiveRecord::Result.new(cols, stmt.to_a) if cols
+          affected_rows = stmt.affected_rows
+
+          stmt.result_metadata.free if cols
+          stmt.free_result
+          stmt.close if binds.empty?
+
+          [result_set, affected_rows]
+        end
+      end
+
+      def connect
+        encoding = @config[:encoding]
+        if encoding
+          @connection.options(Mysql::SET_CHARSET_NAME, encoding) rescue nil
+        end
+
+        if @config[:sslca] || @config[:sslkey]
+          @connection.ssl_set(@config[:sslkey], @config[:sslcert], @config[:sslca], @config[:sslcapath], @config[:sslcipher])
         end
+
+        @connection.options(Mysql::OPT_CONNECT_TIMEOUT, @config[:connect_timeout]) if @config[:connect_timeout]
+        @connection.options(Mysql::OPT_READ_TIMEOUT, @config[:read_timeout]) if @config[:read_timeout]
+        @connection.options(Mysql::OPT_WRITE_TIMEOUT, @config[:write_timeout]) if @config[:write_timeout]
+
+        @connection.real_connect(*@connection_options)
+
+        # reconnect must be set after real_connect is called, because real_connect sets it to false internally
+        @connection.reconnect = !!@config[:reconnect] if @connection.respond_to?(:reconnect=)
+
+        configure_connection
+      end
+
+      # Many Rails applications monkey-patch a replacement of the configure_connection method
+      # and don't call 'super', so leave this here even though it looks superfluous.
+      def configure_connection
+        super
+      end
+
+      def select(sql, name = nil, binds = [])
+        @connection.query_with_result = true
+        rows = exec_query(sql, name, binds)
+        @connection.more_results && @connection.next_result    # invoking stored procedures with CLIENT_MULTI_RESULTS requires this to tidy up else connection will be dropped
+        rows
+      end
+
+      # Returns the version of the connected MySQL server.
+      def version
+        @version ||= @connection.server_info.scan(/^(\d+)\.(\d+)\.(\d+)/).flatten.map { |v| v.to_i }
+      end
     end
   end
 end
-
-rescue LoadError
-  # MySQL is not available, so neither should the adapter be
-end