module ActiveRecord::Sanitization::ClassMethods

Public Instance Methods

sanitize_sql(condition)
sanitize_sql_array(ary) click to toggle source

Accepts an array of conditions. The array has each value sanitized and interpolated into the SQL statement.

sanitize_sql_array(["name=? and group_id=?", "foo'bar", 4])
# => "name='foo''bar' and group_id=4"

sanitize_sql_array(["name=:name and group_id=:group_id", name: "foo'bar", group_id: 4])
# => "name='foo''bar' and group_id=4"

sanitize_sql_array(["name='%s' and group_id='%s'", "foo'bar", 4])
# => "name='foo''bar' and group_id='4'"
# File lib/active_record/sanitization.rb, line 124
def sanitize_sql_array(ary)
  statement, *values = ary
  if values.first.is_a?(Hash) && /:\w+/.match?(statement)
    replace_named_bind_variables(statement, values.first)
  elsif statement.include?("?")
    replace_bind_variables(statement, values)
  elsif statement.blank?
    statement
  else
    statement % values.collect { |value| connection.quote_string(value.to_s) }
  end
end
sanitize_sql_for_assignment(assignments, default_table_name = table_name) click to toggle source

Accepts an array, hash, or string of SQL conditions and sanitizes them into a valid SQL fragment for a SET clause.

sanitize_sql_for_assignment(["name=? and group_id=?", nil, 4])
# => "name=NULL and group_id=4"

sanitize_sql_for_assignment(["name=:name and group_id=:group_id", name: nil, group_id: 4])
# => "name=NULL and group_id=4"

Post.sanitize_sql_for_assignment({ name: nil, group_id: 4 })
# => "`posts`.`name` = NULL, `posts`.`group_id` = 4"

sanitize_sql_for_assignment("name=NULL and group_id='4'")
# => "name=NULL and group_id='4'"
# File lib/active_record/sanitization.rb, line 46
def sanitize_sql_for_assignment(assignments, default_table_name = table_name)
  case assignments
  when Array; sanitize_sql_array(assignments)
  when Hash;  sanitize_sql_hash_for_assignment(assignments, default_table_name)
  else        assignments
  end
end
sanitize_sql_for_conditions(condition) click to toggle source

Accepts an array or string of SQL conditions and sanitizes them into a valid SQL fragment for a WHERE clause.

sanitize_sql_for_conditions(["name=? and group_id=?", "foo'bar", 4])
# => "name='foo''bar' and group_id=4"

sanitize_sql_for_conditions(["name=:name and group_id=:group_id", name: "foo'bar", group_id: 4])
# => "name='foo''bar' and group_id='4'"

sanitize_sql_for_conditions(["name='%s' and group_id='%s'", "foo'bar", 4])
# => "name='foo''bar' and group_id='4'"

sanitize_sql_for_conditions("name='foo''bar' and group_id='4'")
# => "name='foo''bar' and group_id='4'"
# File lib/active_record/sanitization.rb, line 22
def sanitize_sql_for_conditions(condition)
  return nil if condition.blank?

  case condition
  when Array; sanitize_sql_array(condition)
  else        condition
  end
end
Also aliased as: sanitize_sql
sanitize_sql_for_order(condition) click to toggle source

Accepts an array, or string of SQL conditions and sanitizes them into a valid SQL fragment for an ORDER clause.

sanitize_sql_for_order(["field(id, ?)", [1,3,2]])
# => "field(id, 1,3,2)"

sanitize_sql_for_order("id ASC")
# => "id ASC"
# File lib/active_record/sanitization.rb, line 62
def sanitize_sql_for_order(condition)
  if condition.is_a?(Array) && condition.first.to_s.include?("?")
    disallow_raw_sql!(
      [condition.first],
      permit: connection.column_name_with_order_matcher
    )

    # Ensure we aren't dealing with a subclass of String that might
    # override methods we use (e.g. Arel::Nodes::SqlLiteral).
    if condition.first.kind_of?(String) && !condition.first.instance_of?(String)
      condition = [String.new(condition.first), *condition[1..-1]]
    end

    Arel.sql(sanitize_sql_array(condition))
  else
    condition
  end
end
sanitize_sql_hash_for_assignment(attrs, table) click to toggle source

Sanitizes a hash of attribute/value pairs into SQL conditions for a SET clause.

sanitize_sql_hash_for_assignment({ status: nil, group_id: 1 }, "posts")
# => "`posts`.`status` = NULL, `posts`.`group_id` = 1"
# File lib/active_record/sanitization.rb, line 85
def sanitize_sql_hash_for_assignment(attrs, table)
  c = connection
  attrs.map do |attr, value|
    type = type_for_attribute(attr)
    value = type.serialize(type.cast(value))
    "#{c.quote_table_name_for_assignment(table, attr)} = #{c.quote(value)}"
  end.join(", ")
end
sanitize_sql_like(string, escape_character = "\\") click to toggle source

Sanitizes a string so that it is safe to use within an SQL LIKE statement. This method uses escape_character to escape all occurrences of “", ”_“ and ”%“.

sanitize_sql_like("100%")
# => "100\\%"

sanitize_sql_like("snake_cased_string")
# => "snake\\_cased\\_string"

sanitize_sql_like("100%", "!")
# => "100!%"

sanitize_sql_like("snake_cased_string", "!")
# => "snake!_cased!_string"
# File lib/active_record/sanitization.rb, line 108
def sanitize_sql_like(string, escape_character = "\\")
  pattern = Regexp.union(escape_character, "%", "_")
  string.gsub(pattern) { |x| [escape_character, x].join }
end

Private Instance Methods

quote_bound_value(value, c = connection) click to toggle source
# File lib/active_record/sanitization.rb, line 182
def quote_bound_value(value, c = connection)
  if value.respond_to?(:map) && !value.acts_like?(:string)
    values = value.map { |v| v.respond_to?(:id_for_database) ? v.id_for_database : v }
    if values.empty?
      c.quote(nil)
    else
      values.map! { |v| c.quote(v) }.join(",")
    end
  else
    value = value.id_for_database if value.respond_to?(:id_for_database)
    c.quote(value)
  end
end
raise_if_bind_arity_mismatch(statement, expected, provided) click to toggle source
# File lib/active_record/sanitization.rb, line 196
def raise_if_bind_arity_mismatch(statement, expected, provided)
  unless expected == provided
    raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
  end
end
replace_bind_variable(value, c = connection) click to toggle source
# File lib/active_record/sanitization.rb, line 162
def replace_bind_variable(value, c = connection)
  if ActiveRecord::Relation === value
    value.to_sql
  else
    quote_bound_value(value, c)
  end
end
replace_bind_variables(statement, values) click to toggle source
# File lib/active_record/sanitization.rb, line 153
def replace_bind_variables(statement, values)
  raise_if_bind_arity_mismatch(statement, statement.count("?"), values.size)
  bound = values.dup
  c = connection
  statement.gsub(/\?/) do
    replace_bind_variable(bound.shift, c)
  end
end
replace_named_bind_variables(statement, bind_vars) click to toggle source
# File lib/active_record/sanitization.rb, line 170
def replace_named_bind_variables(statement, bind_vars)
  statement.gsub(/(:?):([a-zA-Z]\w*)/) do |match|
    if $1 == ":" # skip postgresql casts
      match # return the whole match
    elsif bind_vars.include?(match = $2.to_sym)
      replace_bind_variable(bind_vars[match])
    else
      raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
    end
  end
end