quoting.rb 3.8 KB
Newer Older
J
Jeremy Kemper 已提交
1 2
require 'active_support/core_ext/big_decimal/conversions'

3 4 5
module ActiveRecord
  module ConnectionAdapters # :nodoc:
    module Quoting
6 7
      # Quotes the column value to help prevent
      # {SQL injection attacks}[http://en.wikipedia.org/wiki/SQL_injection].
8
      def quote(value, column = nil)
9 10 11
        # records are quoted as their primary key
        return value.quoted_id if value.respond_to?(:quoted_id)

12
        case value
A
Aaron Patterson 已提交
13 14
        when String, ActiveSupport::Multibyte::Chars
          value = value.to_s
15 16
          return "'#{quote_string(value)}'" unless column

A
Aaron Patterson 已提交
17 18 19
          case column.type
          when :integer then value.to_i.to_s
          when :float then value.to_f.to_s
A
Aaron Patterson 已提交
20
          else
A
Aaron Patterson 已提交
21
            "'#{quote_string(value)}'"
A
Aaron Patterson 已提交
22
          end
23

A
Aaron Patterson 已提交
24 25 26 27 28 29
        when true, false
          if column && column.type == :integer
            value ? '1' : '0'
          else
            value ? quoted_true : quoted_false
          end
30
          # BigDecimals need to be put in a non-normalized form and quoted.
A
Aaron Patterson 已提交
31
        when nil        then "NULL"
32 33
        when BigDecimal then value.to_s('F')
        when Numeric, ActiveSupport::Duration then value.to_s
34
        when Date, Time then "'#{quoted_date(value)}'"
P
Pratik Naik 已提交
35
        when Symbol     then "'#{quote_string(value.to_s)}'"
36
        when Class      then "'#{value.to_s}'"
A
Aaron Patterson 已提交
37
        else
38
          "'#{quote_string(YAML.dump(value))}'"
39 40 41
        end
      end

42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
      # Cast a +value+ to a type that the database understands. For example,
      # SQLite does not understand dates, so this method will convert a Date
      # to a String.
      def type_cast(value, column)
        return value.id if value.respond_to?(:quoted_id)

        case value
        when String, ActiveSupport::Multibyte::Chars
          value = value.to_s
          return value unless column

          case column.type
          when :integer then value.to_i
          when :float then value.to_f
          else
            value
          end

        when true, false
          if column && column.type == :integer
            value ? 1 : 0
          else
            value ? 't' : 'f'
          end
          # BigDecimals need to be put in a non-normalized form and quoted.
        when nil        then nil
68
        when BigDecimal then value.to_s('F')
69 70 71 72
        when Numeric    then value
        when Date, Time then quoted_date(value)
        when Symbol     then value.to_s
        else
73 74
          to_type = column ? " to #{column.type}" : ""
          raise TypeError, "can't cast #{value.class}#{to_type}"
75 76 77
        end
      end

78 79
      # Quotes a string, escaping any ' (single quote) and \ (backslash)
      # characters.
80 81 82 83
      def quote_string(s)
        s.gsub(/\\/, '\&\&').gsub(/'/, "''") # ' (for ruby-mode)
      end

84 85 86 87 88 89 90 91
      # Quotes the column name. Defaults to no quoting.
      def quote_column_name(column_name)
        column_name
      end

      # Quotes the table name. Defaults to column name quoting.
      def quote_table_name(table_name)
        quote_column_name(table_name)
92 93
      end

94 95 96 97 98 99
      # Override to return the quoted table name for assignment. Defaults to
      # table quoting.
      #
      # This works for mysql and mysql2 where table.column can be used to
      # resolve ambiguity.
      #
100
      # We override this in the sqlite and postgresql adapters to use only
101 102 103 104 105
      # the column name (as per syntax requirements).
      def quote_table_name_for_assignment(table, attr)
        quote_table_name("#{table}.#{attr}")
      end

106 107 108
      def quoted_true
        "'t'"
      end
109

110 111 112
      def quoted_false
        "'f'"
      end
113

114
      def quoted_date(value)
115 116
        if value.acts_like?(:time)
          zone_conversion_method = ActiveRecord::Base.default_timezone == :utc ? :getutc : :getlocal
J
Jon Leighton 已提交
117 118 119 120 121 122 123

          if value.respond_to?(zone_conversion_method)
            value = value.send(zone_conversion_method)
          end
        end

        value.to_s(:db)
124
      end
125 126
    end
  end
127
end