# frozen_string_literal: true require "active_support/core_ext/big_decimal/conversions" require "active_support/multibyte/chars" module ActiveRecord module ConnectionAdapters # :nodoc: module Quoting # Quotes the column value to help prevent # {SQL injection attacks}[https://en.wikipedia.org/wiki/SQL_injection]. def quote(value) value = id_value_for_database(value) if value.is_a?(Base) if value.respond_to?(:value_for_database) value = value.value_for_database end _quote(value) end # 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 = nil) value = id_value_for_database(value) if value.is_a?(Base) if column value = type_cast_from_column(column, value) end _type_cast(value) rescue TypeError to_type = column ? " to #{column.type}" : "" raise TypeError, "can't cast #{value.class}#{to_type}" end # If you are having to call this function, you are likely doing something # wrong. The column does not have sufficient type information if the user # provided a custom type on the class level either explicitly (via # Attributes::ClassMethods#attribute) or implicitly (via # AttributeMethods::Serialization::ClassMethods#serialize, +time_zone_aware_attributes+). # In almost all cases, the sql type should only be used to change quoting behavior, when the primitive to # represent the type doesn't sufficiently reflect the differences # (varchar vs binary) for example. The type used to get this primitive # should have been provided before reaching the connection adapter. def type_cast_from_column(column, value) # :nodoc: if column type = lookup_cast_type_from_column(column) type.serialize(value) else value end end # See docs for #type_cast_from_column def lookup_cast_type_from_column(column) # :nodoc: lookup_cast_type(column.sql_type) end # Quotes a string, escaping any ' (single quote) and \ (backslash) # characters. def quote_string(s) s.gsub('\\', '\&\&').gsub("'", "''") # ' (for ruby-mode) end # Quotes the column name. Defaults to no quoting. def quote_column_name(column_name) column_name.to_s end # Quotes the table name. Defaults to column name quoting. def quote_table_name(table_name) quote_column_name(table_name) end # Override to return the quoted table name for assignment. Defaults to # table quoting. # # This works for mysql2 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). def quote_table_name_for_assignment(table, attr) quote_table_name("#{table}.#{attr}") end def quote_default_expression(value, column) # :nodoc: if value.is_a?(Proc) value.call else value = lookup_cast_type(column.sql_type).serialize(value) quote(value) end end def quoted_true "TRUE" end def unquoted_true true end def quoted_false "FALSE" end def unquoted_false false end # Quote date/time values for use in SQL input. Includes microseconds # if the value is a Time responding to usec. def quoted_date(value) if value.acts_like?(:time) if ActiveRecord::Base.default_timezone == :utc value = value.getutc if value.respond_to?(:getutc) && !value.utc? else value = value.getlocal if value.respond_to?(:getlocal) end end result = value.to_s(:db) if value.respond_to?(:usec) && value.usec > 0 result << "." << sprintf("%06d", value.usec) else result end end 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 def quoted_binary(value) # :nodoc: "'#{quote_string(value.to_s)}'" end def sanitize_as_sql_comment(value) # :nodoc: value.to_s.gsub(%r{ (/ (?: | \g<1>) \*) \+? \s* | \s* (\* (?: | \g<2>) /) }x, "") end def column_name_matcher # :nodoc: COLUMN_NAME end def column_name_with_order_matcher # :nodoc: COLUMN_NAME_WITH_ORDER end # Regexp for column names (with or without a table name prefix). # Matches the following: # # "#{table_name}.#{column_name}" # "#{column_name}" COLUMN_NAME = / \A ( (?: # table_name.column_name | function(one or no argument) ((?:\w+\.)?\w+) | \w+\((?:|\g<2>)\) ) (?:(?:\s+AS)?\s+\w+)? ) (?:\s*,\s*\g<1>)* \z /ix # Regexp for column names with order (with or without a table name prefix, # with or without various order modifiers). Matches the following: # # "#{table_name}.#{column_name}" # "#{table_name}.#{column_name} #{direction}" # "#{table_name}.#{column_name} #{direction} NULLS FIRST" # "#{table_name}.#{column_name} NULLS LAST" # "#{column_name}" # "#{column_name} #{direction}" # "#{column_name} #{direction} NULLS FIRST" # "#{column_name} NULLS LAST" COLUMN_NAME_WITH_ORDER = / \A ( (?: # table_name.column_name | function(one or no argument) ((?:\w+\.)?\w+) | \w+\((?:|\g<2>)\) ) (?:\s+ASC|\s+DESC)? (?:\s+NULLS\s+(?:FIRST|LAST))? ) (?:\s*,\s*\g<1>)* \z /ix private_constant :COLUMN_NAME, :COLUMN_NAME_WITH_ORDER private def type_casted_binds(binds) if binds.first.is_a?(Array) binds.map { |column, value| type_cast(value, column) } else binds.map { |attr| type_cast(attr.value_for_database) } end end def lookup_cast_type(sql_type) type_map.lookup(sql_type) end def id_value_for_database(value) if primary_key = value.class.primary_key value.instance_variable_get(:@attributes)[primary_key].value_for_database end end 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, ActiveSupport::Duration 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 def _type_cast(value) case value when Symbol, ActiveSupport::Multibyte::Chars, Type::Binary::Data 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 end end end end end