Module: ActiveRecord::ConnectionAdapters::Quoting

Extended by:
ActiveSupport::Concern
Included in:
AbstractAdapter
Defined in:
activerecord/lib/active_record/connection_adapters/abstract/quoting.rb

Overview

Active Record Connection Adapters Quoting

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Methods included from ActiveSupport::Concern

append_features, class_methods, extended, included, prepend_features, prepended

Instance Method Details

#cast_bound_value(value) ⇒ Object

Cast a value to be used as a bound parameter of unknown type. For example, MySQL might perform dangerous castings when comparing a string to a number, so this method will cast numbers to string.



113
114
115
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 113

def cast_bound_value(value) # :nodoc:
  value
end

#lookup_cast_type(sql_type) ⇒ Object

:nodoc:



213
214
215
216
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 213

def lookup_cast_type(sql_type) # :nodoc:
  # TODO: Make this method private after we release 8.1.
  type_map.lookup(sql_type)
end

#quote(value) ⇒ Object

Quotes the column value to help prevent SQL injection attacks.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 72

def quote(value)
  case value
  when String, Symbol, ActiveSupport::Multibyte::Chars
    "'#{quote_string(value.to_s)}'"
  when true       then quoted_true
  when false      then quoted_false
  when nil        then "NULL"
  # BigDecimals need to be put in a non-normalized form and quoted.
  when BigDecimal then value.to_s("F")
  when Numeric then value.to_s
  when Type::Binary::Data then quoted_binary(value)
  when Type::Time::Value then "'#{quoted_time(value)}'"
  when Date, Time then "'#{quoted_date(value)}'"
  when Class      then "'#{value}'"
  else
    raise TypeError, "can't quote #{value.class.name}"
  end
end

#quote_column_name(column_name) ⇒ Object

Quotes the column name.



124
125
126
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 124

def quote_column_name(column_name)
  self.class.quote_column_name(column_name)
end

#quote_default_expression(value, column) ⇒ Object

:nodoc:



145
146
147
148
149
150
151
152
153
154
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 145

def quote_default_expression(value, column) # :nodoc:
  if value.is_a?(Proc)
    value.call
  else
    # TODO: Remove fetch_cast_type and the need for connection after we release 8.1.
    cast_type = column.fetch_cast_type(self)
    value = cast_type.serialize(value)
    quote(value)
  end
end

#quote_string(s) ⇒ Object

Quotes a string, escaping any ‘ (single quote) and \ (backslash) characters.



119
120
121
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 119

def quote_string(s)
  s.gsub("\\", '\&\&').gsub("'", "''") # ' (for ruby-mode)
end

#quote_table_name(table_name) ⇒ Object

Quotes the table name.



129
130
131
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 129

def quote_table_name(table_name)
  self.class.quote_table_name(table_name)
end

#quote_table_name_for_assignment(table, attr) ⇒ Object

Override to return the quoted table name for assignment. Defaults to table quoting.

This works for MySQL where table.column can be used to resolve ambiguity.

We override this in the sqlite3 and postgresql adapters to use only the column name (as per syntax requirements).



141
142
143
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 141

def quote_table_name_for_assignment(table, attr)
  quote_table_name("#{table}.#{attr}")
end

#quoted_binary(value) ⇒ Object

:nodoc:



196
197
198
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 196

def quoted_binary(value) # :nodoc:
  "'#{quote_string(value.to_s)}'"
end

#quoted_date(value) ⇒ Object

Quote date/time values for use in SQL input. Includes microseconds if the value is a Time responding to usec.



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 174

def quoted_date(value)
  if value.acts_like?(:time)
    if default_timezone == :utc
      value = value.getutc if !value.utc?
    else
      value = value.getlocal
    end
  end

  result = value.to_fs(:db)
  if value.respond_to?(:usec) && value.usec > 0
    result << "." << sprintf("%06d", value.usec)
  else
    result
  end
end

#quoted_false ⇒ Object 



164
165
166
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 164

def quoted_false
  "FALSE"
end

#quoted_time(value) ⇒ Object

:nodoc:



191
192
193
194
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 191

def quoted_time(value) # :nodoc:
  value = value.change(year: 2000, month: 1, day: 1)
  quoted_date(value).sub(/\A\d\d\d\d-\d\d-\d\d /, "")
end

#quoted_true ⇒ Object 



156
157
158
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 156

def quoted_true
  "TRUE"
end

#sanitize_as_sql_comment(value) ⇒ Object

:nodoc:



200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 200

def sanitize_as_sql_comment(value) # :nodoc:
  # Sanitize a string to appear within a SQL comment
  # For compatibility, this also surrounding "/*+", "/*", and "*/"
  # charcacters, possibly with single surrounding space.
  # Then follows that by replacing any internal "*/" or "/*" with
  # "* /" or "/ *"
  comment = value.to_s.dup
  comment.gsub!(%r{\A\s*/\*\+?\s?|\s?\*/\s*\Z}, "")
  comment.gsub!("*/", "* /")
  comment.gsub!("/*", "/ *")
  comment
end

#type_cast(value) ⇒ Object

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.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 94

def type_cast(value)
  case value
  when Symbol, Type::Binary::Data, ActiveSupport::Multibyte::Chars
    value.to_s
  when true       then unquoted_true
  when false      then unquoted_false
  # BigDecimals need to be put in a non-normalized form and quoted.
  when BigDecimal then value.to_s("F")
  when nil, Numeric, String then value
  when Type::Time::Value then quoted_time(value)
  when Date, Time then quoted_date(value)
  else
    raise TypeError, "can't cast #{value.class.name}"
  end
end

#unquoted_false ⇒ Object 



168
169
170
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 168

def unquoted_false
  false
end

#unquoted_true ⇒ Object 



160
161
162
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 160

def unquoted_true
  true
end