activerecord-sqlserver-adapter-2000 3.0.15

data/lib/active_record/connection_adapters/sqlserver_adapter.rb

@@ -0,0 +1,470 @@
+require 'arel/visitors/sqlserver'
+require 'active_record'
+require 'active_record/connection_adapters/abstract_adapter'
+require 'active_record/connection_adapters/sqlserver/core_ext/active_record'
+require 'active_record/connection_adapters/sqlserver/database_limits'
+require 'active_record/connection_adapters/sqlserver/database_statements'
+require 'active_record/connection_adapters/sqlserver/errors'
+require 'active_record/connection_adapters/sqlserver/query_cache'
+require 'active_record/connection_adapters/sqlserver/schema_statements'
+require 'active_record/connection_adapters/sqlserver/quoting'
+require 'active_support/core_ext/kernel/requires'
+require 'active_support/core_ext/string'
+require 'base64'
+
+module ActiveRecord
+  
+  class Base
+    
+    def self.sqlserver_connection(config) #:nodoc:
+      config = config.symbolize_keys
+      config.reverse_merge! :mode => :dblib, :host => 'localhost', :username => 'sa', :password => ''
+      mode = config[:mode].to_s.downcase.underscore.to_sym
+      case mode
+      when :dblib
+        require_library_or_gem 'tiny_tds'
+        warn("TinyTds v0.4.3 or higher required. Using #{TinyTds::VERSION}") unless TinyTds::Client.instance_methods.map(&:to_s).include?("active?")
+      when :odbc
+        raise ArgumentError, 'Missing :dsn configuration.' unless config.has_key?(:dsn)
+        if RUBY_VERSION < '1.9'
+          require_library_or_gem 'odbc'
+        else
+          begin
+            # TODO: [ODBC] Change this to 'odbc_utf8'
+            require_library_or_gem 'odbc'
+          rescue LoadError
+            require_library_or_gem 'odbc'
+          end
+        end unless ['::ODBC','::ODBC_UTF8','::ODBC_NONE'].any? { |odbc_ns| odbc_ns.constantize rescue nil }
+        require 'active_record/connection_adapters/sqlserver/core_ext/odbc'
+      when :adonet
+        require 'System.Data'
+        raise ArgumentError, 'Missing :database configuration.' unless config.has_key?(:database)
+      else
+        raise ArgumentError, "Unknown connection mode in #{config.inspect}."
+      end
+      ConnectionAdapters::SQLServerAdapter.new(logger,config.merge(:mode=>mode))
+    end
+    
+    protected
+    
+    def self.did_retry_sqlserver_connection(connection,count)
+      logger.info "CONNECTION RETRY: #{connection.class.name} retry ##{count}."
+    end
+    
+    def self.did_lose_sqlserver_connection(connection)
+      logger.info "CONNECTION LOST: #{connection.class.name}"
+    end
+    
+  end
+  
+  module ConnectionAdapters
+    
+    class SQLServerColumn < Column
+            
+      def initialize(name, default, sql_type = nil, null = true, sqlserver_options = {})
+        @sqlserver_options = sqlserver_options.symbolize_keys
+        super(name, default, sql_type, null)
+      end
+      
+      class << self
+        
+        def string_to_binary(value)
+         "0x#{value.unpack("H*")[0]}"
+        end
+        
+        def binary_to_string(value)
+          value =~ /[^[:xdigit:]]/ ? value : [value].pack('H*')
+        end
+        
+      end
+      
+      def is_identity?
+        @sqlserver_options[:is_identity]
+      end
+      
+      def is_utf8?
+        @sql_type =~ /nvarchar|ntext|nchar/i
+      end
+      
+      def default_function
+        @sqlserver_options[:default_function]
+      end
+      
+      def table_name
+        @sqlserver_options[:table_name]
+      end
+      
+      def table_klass
+        @table_klass ||= begin
+          table_name.classify.constantize
+        rescue StandardError, NameError, LoadError
+          nil
+        end
+        (@table_klass && @table_klass < ActiveRecord::Base) ? @table_klass : nil
+      end
+      
+      def database_year
+        @sqlserver_options[:database_year]
+      end
+      
+      
+      private
+      
+      def extract_limit(sql_type)
+        case sql_type
+        when /^smallint/i
+          2
+        when /^int/i
+          4
+        when /^bigint/i
+          8
+        when /\(max\)/, /decimal/, /numeric/
+          nil
+        else
+          super
+        end
+      end
+      
+      def simplified_type(field_type)
+        case field_type
+          when /real/i              then :float
+          when /money/i             then :decimal
+          when /image/i             then :binary
+          when /bit/i               then :boolean
+          when /uniqueidentifier/i  then :string
+          when /datetime/i          then simplified_datetime
+          when /varchar\(max\)/     then :text
+          when /timestamp/          then :binary
+          else super
+        end
+      end
+      
+      def simplified_datetime
+        if database_year >= 2008
+          :datetime
+        elsif table_klass && table_klass.coerced_sqlserver_date_columns.include?(name)
+          :date
+        elsif table_klass && table_klass.coerced_sqlserver_time_columns.include?(name)
+          :time
+        else
+          :datetime
+        end
+      end
+      
+    end #class SQLServerColumn
+    
+    class SQLServerAdapter < AbstractAdapter
+      
+      include Sqlserver::Quoting
+      include Sqlserver::DatabaseStatements
+      include Sqlserver::SchemaStatements
+      include Sqlserver::DatabaseLimits
+      include Sqlserver::QueryCache
+      include Sqlserver::Errors
+      
+      ADAPTER_NAME                = 'SQLServer'.freeze
+      VERSION                     = '3.0.15'.freeze
+      DATABASE_VERSION_REGEXP     = /Microsoft SQL Server\s+"?(\d{4}|\w+)"?/
+      SUPPORTED_VERSIONS          = [2000,2005,2008,2010,2011].freeze
+      
+      attr_reader :database_version, :database_year,
+                  :connection_supports_native_types
+      
+      cattr_accessor :native_text_database_type, :native_binary_database_type, :native_string_database_type,
+                     :log_info_schema_queries, :enable_default_unicode_types, :auto_connect,
+                     :cs_equality_operator
+      
+      def initialize(logger,config)
+        @connection_options = config
+        connect
+        super(@connection, logger)
+        @database_version = info_schema_query { select_value('SELECT @@version') }
+        @database_year = begin
+                           if @database_version =~ /Microsoft SQL Azure/i
+                             @sqlserver_azure = true
+                             @database_version.match(/\s(\d{4})\s/)[1].to_i
+                           else
+                             year = DATABASE_VERSION_REGEXP.match(@database_version)[1]
+                             year == "Denali" ? 2011 : year.to_i
+                           end
+                         rescue
+                           0
+                         end
+        initialize_sqlserver_caches
+        use_database
+        unless SUPPORTED_VERSIONS.include?(@database_year)
+          raise NotImplementedError, "Currently, only #{SUPPORTED_VERSIONS.to_sentence} are supported. We got back #{@database_version}."
+        end
+      end
+      
+      # === Abstract Adapter ========================================== #
+      
+      def adapter_name
+        ADAPTER_NAME
+      end
+      
+      def supports_migrations?
+        true
+      end
+      
+      def supports_primary_key?
+        true
+      end
+      
+      def supports_count_distinct?
+        true
+      end
+      
+      def supports_ddl_transactions?
+        true
+      end
+      
+      def supports_savepoints?
+        true
+      end
+      
+      def disable_referential_integrity
+        do_execute "EXEC sp_MSforeachtable 'ALTER TABLE ? NOCHECK CONSTRAINT ALL'"
+        yield
+      ensure
+        do_execute "EXEC sp_MSforeachtable 'ALTER TABLE ? CHECK CONSTRAINT ALL'"
+      end
+      
+      # === Abstract Adapter (Connection Management) ================== #
+      
+      def active?
+        case @connection_options[:mode]
+        when :dblib
+          return @connection.active?
+        end
+        raw_connection_do("SELECT 1")
+        true
+      rescue *lost_connection_exceptions
+        false
+      end
+
+      def reconnect!
+        disconnect!
+        connect
+        active?
+      end
+
+      def disconnect!
+        case @connection_options[:mode]
+        when :dblib
+          @connection.close rescue nil
+        when :odbc
+          @connection.disconnect rescue nil
+        else :adonet
+          @connection.close rescue nil
+        end
+      end
+      
+      def reset!
+        remove_database_connections_and_rollback { }
+      end
+      
+      # === Abstract Adapter (Misc Support) =========================== #
+      
+      def pk_and_sequence_for(table_name)
+        idcol = identity_column(table_name)
+        idcol ? [idcol.name,nil] : nil
+      end
+
+      def primary_key(table_name)
+        identity_column(table_name).try(:name)
+      end
+      
+      # === SQLServer Specific (DB Reflection) ======================== #
+      
+      def sqlserver?
+        true
+      end
+      
+      def sqlserver_2005?
+        @database_year == 2005
+      end
+      
+      def sqlserver_2008?
+        @database_year == 2008
+      end
+      
+      def sqlserver_2011?
+        @database_year == 2011
+      end
+      
+      def sqlserver_azure?
+        @sqlserver_azure
+      end
+      
+      def version
+        self.class::VERSION
+      end
+      
+      def inspect
+        "#<#{self.class} version: #{version}, year: #{@database_year}, connection_options: #{@connection_options.inspect}>"
+      end
+      
+      def auto_connect
+        @@auto_connect.is_a?(FalseClass) ? false : true
+      end
+      
+      def native_string_database_type
+        @@native_string_database_type || (enable_default_unicode_types ? 'nvarchar' : 'varchar') 
+      end
+      
+      def native_text_database_type
+        @@native_text_database_type || enable_default_unicode_types ? 'nvarchar(max)' : 'varchar(max)'
+      end
+      
+      def native_time_database_type
+        sqlserver_2005? ? 'datetime' : 'time'
+      end
+      
+      def native_date_database_type
+        sqlserver_2005? ? 'datetime' : 'date'
+      end
+      
+      def native_binary_database_type
+        @@native_binary_database_type || 'varbinary(max)'
+      end
+      
+      def cs_equality_operator
+        @@cs_equality_operator || 'COLLATE Latin1_General_CS_AS_WS ='
+      end
+      
+      
+      protected
+      
+      # === Abstract Adapter (Misc Support) =========================== #
+      
+      def translate_exception(e, message)
+        case message
+        when /cannot insert duplicate key .* with unique index/i
+          RecordNotUnique.new(message,e)
+        when /conflicted with the foreign key constraint/i
+          InvalidForeignKey.new(message,e)
+        when *lost_connection_messages
+          LostConnection.new(message,e)
+        else
+          super
+        end
+      end
+      
+      # === SQLServer Specific (Connection Management) ================ #
+      
+      def connect
+        config = @connection_options
+        @connection = case @connection_options[:mode]
+                      when :dblib
+                        appname = config[:appname] || Rails.application.class.name.split('::').first rescue nil
+                        login_timeout = config[:login_timeout].present? ? config[:login_timeout].to_i : nil
+                        timeout = config[:timeout].present? ? config[:timeout].to_i/1000 : nil
+                        encoding = config[:encoding].present? ? config[:encoding] : nil
+                        TinyTds::Client.new({ 
+                          :dataserver    => config[:dataserver],
+                          :host          => config[:host],
+                          :port          => config[:port],
+                          :username      => config[:username],
+                          :password      => config[:password],
+                          :database      => config[:database],
+                          :appname       => appname,
+                          :login_timeout => login_timeout,
+                          :timeout       => timeout,
+                          :encoding      => encoding,
+                          :azure         => config[:azure]
+                        }).tap do |client|
+                          if config[:azure]
+                            client.execute("SET ANSI_NULLS ON").do
+                            client.execute("SET CURSOR_CLOSE_ON_COMMIT OFF").do
+                            client.execute("SET ANSI_NULL_DFLT_ON ON").do
+                            client.execute("SET IMPLICIT_TRANSACTIONS OFF").do
+                            client.execute("SET ANSI_PADDING ON").do
+                            client.execute("SET QUOTED_IDENTIFIER ON")
+                            client.execute("SET ANSI_WARNINGS ON").do
+                          else
+                            client.execute("SET ANSI_DEFAULTS ON").do
+                            client.execute("SET CURSOR_CLOSE_ON_COMMIT OFF").do
+                            client.execute("SET IMPLICIT_TRANSACTIONS OFF").do
+                          end
+                        end
+                      when :odbc
+                        odbc = ['::ODBC','::ODBC_UTF8','::ODBC_NONE'].detect{ |odbc_ns| odbc_ns.constantize rescue nil }.constantize
+                        if config[:dsn].include?(';')
+                          driver = odbc::Driver.new.tap do |d|
+                            d.name = config[:dsn_name] || 'Driver1'
+                            d.attrs = config[:dsn].split(';').map{ |atr| atr.split('=') }.reject{ |kv| kv.size != 2 }.inject({}){ |h,kv| k,v = kv ; h[k] = v ; h }
+                          end
+                          odbc::Database.new.drvconnect(driver)
+                        else
+                          odbc.connect config[:dsn], config[:username], config[:password]
+                        end.tap do |c|
+                          if c.respond_to?(:use_time)
+                            c.use_time = true
+                            c.use_utc = ActiveRecord::Base.default_timezone == :utc
+                            @connection_supports_native_types = true
+                          end
+                        end
+                      when :adonet
+                        System::Data::SqlClient::SqlConnection.new.tap do |connection|
+                          connection.connection_string = System::Data::SqlClient::SqlConnectionStringBuilder.new.tap do |cs|
+                            if config[:integrated_security]
+                              cs.integrated_security = true
+                            else
+                              cs.user_i_d = config[:username]
+                              cs.password = config[:password]
+                            end
+                            cs.add 'Server', config[:host].to_clr_string
+                            cs.initial_catalog = config[:database]
+                            cs.multiple_active_result_sets = false
+                            cs.pooling = false
+                          end.to_s
+                          connection.open
+                        end
+                      end
+      rescue
+        raise unless @auto_connecting
+      end
+      
+      def remove_database_connections_and_rollback(database=nil)
+        database ||= current_database
+        do_execute "ALTER DATABASE #{quote_table_name(database)} SET SINGLE_USER WITH ROLLBACK IMMEDIATE"
+        begin
+          yield
+        ensure
+          do_execute "ALTER DATABASE #{quote_table_name(database)} SET MULTI_USER"
+        end if block_given?
+      end
+      
+      def with_auto_reconnect
+        begin
+          yield
+        rescue Exception => e
+          retry if translate_exception(e,e.message).is_a?(LostConnection) && auto_reconnected?
+          raise
+        end
+      end
+      
+      def auto_reconnected?
+        return false unless auto_connect
+        @auto_connecting = true
+        count = 0
+        while count <= 5
+          sleep 2** count
+          ActiveRecord::Base.did_retry_sqlserver_connection(self,count)
+          return true if reconnect!
+          count += 1
+        end
+        ActiveRecord::Base.did_lose_sqlserver_connection(self)
+        false
+      ensure
+        @auto_connecting = false
+      end
+            
+    end #class SQLServerAdapter < AbstractAdapter
+    
+  end #module ConnectionAdapters
+  
+end #module ActiveRecord
+