strong_parameters.rb 27.9 KB
Newer Older
1
require 'active_support/core_ext/hash/indifferent_access'
R
Rafael Mendonça França 已提交
2
require 'active_support/core_ext/array/wrap'
X
Xavier Noria 已提交
3
require 'active_support/core_ext/string/filters'
4
require 'active_support/rescuable'
5
require 'action_dispatch/http/upload'
6
require 'stringio'
7
require 'set'
8 9

module ActionController
10 11 12 13
  # Raised when a required parameter is missing.
  #
  #   params = ActionController::Parameters.new(a: {})
  #   params.fetch(:b)
14
  #   # => ActionController::ParameterMissing: param is missing or the value is empty: b
15
  #   params.require(:a)
16
  #   # => ActionController::ParameterMissing: param is missing or the value is empty: a
17
  class ParameterMissing < KeyError
18
    attr_reader :param # :nodoc:
19

20
    def initialize(param) # :nodoc:
21
      @param = param
22
      super("param is missing or the value is empty: #{param}")
23 24 25
    end
  end

26 27
  # Raised when a supplied parameter is not expected and
  # ActionController::Parameters.action_on_unpermitted_parameters
28
  # is set to <tt>:raise</tt>.
29 30 31
  #
  #   params = ActionController::Parameters.new(a: "123", b: "456")
  #   params.permit(:c)
32
  #   # => ActionController::UnpermittedParameters: found unpermitted parameters: a, b
33 34
  class UnpermittedParameters < IndexError
    attr_reader :params # :nodoc:
35

36
    def initialize(params) # :nodoc:
37
      @params = params
38
      super("found unpermitted parameter#{'s' if params.size > 1 }: #{params.join(", ")}")
39 40 41
    end
  end

42
  # == Action Controller \Parameters
43 44
  #
  # Allows to choose which attributes should be whitelisted for mass updating
45
  # and thus prevent accidentally exposing that which shouldn't be exposed.
46 47
  # Provides two methods for this purpose: #require and #permit. The former is
  # used to mark parameters as required. The latter is used to set the parameter
48
  # as permitted and limit which attributes should be allowed for mass updating.
49 50 51 52 53 54 55 56 57 58 59 60 61 62
  #
  #   params = ActionController::Parameters.new({
  #     person: {
  #       name: 'Francesco',
  #       age:  22,
  #       role: 'admin'
  #     }
  #   })
  #
  #   permitted = params.require(:person).permit(:name, :age)
  #   permitted            # => {"name"=>"Francesco", "age"=>22}
  #   permitted.class      # => ActionController::Parameters
  #   permitted.permitted? # => true
  #
63
  #   Person.first.update!(permitted)
64
  #   # => #<Person id: 1, name: "Francesco", age: 22, role: "user">
65
  #
66 67 68 69 70 71 72 73 74
  # It provides two options that controls the top-level behavior of new instances:
  #
  # * +permit_all_parameters+ - If it's +true+, all the parameters will be
  #   permitted by default. The default is +false+.
  # * +action_on_unpermitted_parameters+ - Allow to control the behavior when parameters
  #   that are not explicitly permitted are found. The values can be <tt>:log</tt> to
  #   write a message on the logger or <tt>:raise</tt> to raise
  #   ActionController::UnpermittedParameters exception. The default value is <tt>:log</tt>
  #   in test and development environments, +false+ otherwise.
75
  #
76 77
  # Examples:
  #
78
  #   params = ActionController::Parameters.new
79
  #   params.permitted? # => false
80 81 82 83 84 85
  #
  #   ActionController::Parameters.permit_all_parameters = true
  #
  #   params = ActionController::Parameters.new
  #   params.permitted? # => true
  #
86 87 88 89 90 91 92 93 94 95
  #   params = ActionController::Parameters.new(a: "123", b: "456")
  #   params.permit(:c)
  #   # => {}
  #
  #   ActionController::Parameters.action_on_unpermitted_parameters = :raise
  #
  #   params = ActionController::Parameters.new(a: "123", b: "456")
  #   params.permit(:c)
  #   # => ActionController::UnpermittedParameters: found unpermitted keys: a, b
  #
96 97 98 99 100
  # Please note that these options *are not thread-safe*. In a multi-threaded
  # environment they should only be set once at boot-time and never mutated at
  # runtime.
  #
  # <tt>ActionController::Parameters</tt> inherits from
101 102 103 104 105 106
  # <tt>ActiveSupport::HashWithIndifferentAccess</tt>, this means
  # that you can fetch values using either <tt>:key</tt> or <tt>"key"</tt>.
  #
  #   params = ActionController::Parameters.new(key: 'value')
  #   params[:key]  # => "value"
  #   params["key"] # => "value"
107
  class Parameters
108
    cattr_accessor :permit_all_parameters, instance_accessor: false
109 110
    cattr_accessor :action_on_unpermitted_parameters, instance_accessor: false

111 112
    delegate :keys, :key?, :has_key?, :empty?, :inspect, to: :@parameters

113 114 115 116
    # By default, never raise an UnpermittedParameters exception if these
    # params are present. The default includes both 'controller' and 'action'
    # because they are added by Rails and should be of no concern. One way
    # to change these is to specify `always_permitted_parameters` in your
R
Rafael Chacón 已提交
117 118 119
    # config. For instance:
    #
    #    config.always_permitted_parameters = %w( controller action format )
120 121 122 123
    cattr_accessor :always_permitted_parameters
    self.always_permitted_parameters = %w( controller action )

    def self.const_missing(const_name)
124
      return super unless const_name == :NEVER_UNPERMITTED_PARAMS
X
Xavier Noria 已提交
125 126 127 128 129 130
      ActiveSupport::Deprecation.warn(<<-MSG.squish)
        `ActionController::Parameters::NEVER_UNPERMITTED_PARAMS` has been deprecated.
        Use `ActionController::Parameters.always_permitted_parameters` instead.
      MSG

      always_permitted_parameters
131
    end
132

133 134 135 136
    # Returns a new instance of <tt>ActionController::Parameters</tt>.
    # Also, sets the +permitted+ attribute to the default value of
    # <tt>ActionController::Parameters.permit_all_parameters</tt>.
    #
U
Uģis Ozols 已提交
137
    #   class Person < ActiveRecord::Base
138 139 140 141
    #   end
    #
    #   params = ActionController::Parameters.new(name: 'Francesco')
    #   params.permitted?  # => false
142
    #   Person.new(params) # => ActiveModel::ForbiddenAttributesError
143 144 145 146
    #
    #   ActionController::Parameters.permit_all_parameters = true
    #
    #   params = ActionController::Parameters.new(name: 'Francesco')
147
    #   params.permitted?  # => true
148
    #   Person.new(params) # => #<Person id: nil, name: "Francesco">
149 150
    def initialize(parameters = {})
      @parameters = parameters.with_indifferent_access
151
      @permitted = self.class.permit_all_parameters
152 153
    end

154 155 156
    # Returns true if another +Parameters+ object contains the same content and
    # permitted flag, or other Hash-like object contains the same content. This
    # override is in place so you can perform a comparison with `Hash`.
157 158 159 160 161 162 163 164
    def ==(other_hash)
      if other_hash.respond_to?(:permitted?)
        super
      else
        @parameters == other_hash
      end
    end

165 166 167 168 169 170 171 172 173 174 175 176 177
    # Returns a safe +Hash+ representation of this parameter with all
    # unpermitted keys removed.
    #
    #   params = ActionController::Parameters.new({
    #     name: 'Senjougahara Hitagi',
    #     oddity: 'Heavy stone crab'
    #   })
    #   params.to_h # => {}
    #
    #   safe_params = params.permit(:name)
    #   safe_params.to_h # => {"name"=>"Senjougahara Hitagi"}
    def to_h
      if permitted?
178
        @parameters.to_h
179 180 181 182 183
      else
        slice(*self.class.always_permitted_parameters).permit!.to_h
      end
    end

P
Prem Sichanugrist 已提交
184 185
    # Returns an unsafe, unfiltered +Hash+ representation of this parameter.
    def to_unsafe_h
186
      @parameters.to_h
P
Prem Sichanugrist 已提交
187 188 189
    end
    alias_method :to_unsafe_hash, :to_unsafe_h

190 191 192
    # Convert all hashes in values into parameters, then yield each pair like
    # the same way as <tt>Hash#each_pair</tt>
    def each_pair(&block)
193 194
      @parameters.each_pair do |key, value|
        yield key, convert_hashes_to_parameters(key, value)
195 196 197 198
      end
    end
    alias_method :each, :each_pair

199 200 201
    # Attribute that keeps track of converted arrays, if any, to avoid double
    # looping in the common use case permit + mass-assignment. Defined in a
    # method to instantiate it only if needed.
202 203 204 205
    #
    # Testing membership still loops, but it's going to be faster than our own
    # loop that converts values. Also, we are not going to build a new array
    # object per fetch.
206
    def converted_arrays
207
      @converted_arrays ||= Set.new
208 209
    end

210 211 212 213 214 215 216 217 218 219
    # Returns +true+ if the parameter is permitted, +false+ otherwise.
    #
    #   params = ActionController::Parameters.new
    #   params.permitted? # => false
    #   params.permit!
    #   params.permitted? # => true
    def permitted?
      @permitted
    end

220 221 222 223 224 225 226
    # Sets the +permitted+ attribute to +true+. This can be used to pass
    # mass assignment. Returns +self+.
    #
    #   class Person < ActiveRecord::Base
    #   end
    #
    #   params = ActionController::Parameters.new(name: 'Francesco')
227
    #   params.permitted?  # => false
228 229 230 231
    #   Person.new(params) # => ActiveModel::ForbiddenAttributesError
    #   params.permit!
    #   params.permitted?  # => true
    #   Person.new(params) # => #<Person id: nil, name: "Francesco">
232
    def permit!
233
      each_pair do |key, value|
C
Corey Ward 已提交
234 235
        Array.wrap(value).each do |v|
          v.permit! if v.respond_to? :permit!
236
        end
237 238
      end

239 240 241 242
      @permitted = true
      self
    end

243 244 245 246
    # This method accepts both a single key and an array of keys.
    #
    # When passed a single key, if it exists and its associated value is
    # either present or the singleton +false+, returns said value:
247
    #
248
    #   ActionController::Parameters.new(person: { name: 'Francesco' }).require(:person)
249
    #   # => {"name"=>"Francesco"}
250
    #
251 252 253 254 255
    # Otherwise raises <tt>ActionController::ParameterMissing</tt>:
    #
    #   ActionController::Parameters.new.require(:person)
    #   # ActionController::ParameterMissing: param is missing or the value is empty: person
    #
256
    #   ActionController::Parameters.new(person: nil).require(:person)
257 258 259 260
    #   # ActionController::ParameterMissing: param is missing or the value is empty: person
    #
    #   ActionController::Parameters.new(person: "\t").require(:person)
    #   # ActionController::ParameterMissing: param is missing or the value is empty: person
261
    #
262
    #   ActionController::Parameters.new(person: {}).require(:person)
263 264 265
    #   # ActionController::ParameterMissing: param is missing or the value is empty: person
    #
    # When given an array of keys, the method tries to require each one of them
X
Xavier Noria 已提交
266
    # in order. If it succeeds, an array with the respective return values is
267 268 269 270
    # returned:
    #
    #   params = ActionController::Parameters.new(user: { ... }, profile: { ... })
    #   user_params, profile_params = params.require(:user, :profile)
271
    #
272
    # Otherwise, the method reraises the first exception found:
273
    #
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
    #   params = ActionController::Parameters.new(user: {}, profile: {})
    #   user_params, profile_params = params.require(:user, :profile)
    #   # ActionController::ParameterMissing: param is missing or the value is empty: user
    #
    # Technically this method can be used to fetch terminal values:
    #
    #   # CAREFUL
    #   params = ActionController::Parameters.new(person: { name: 'Finn' })
    #   name = params.require(:person).require(:name) # CAREFUL
    #
    # but take into account that at some point those ones have to be permitted:
    #
    #   def user_params
    #     params.require(:person).permit(:name).tap do |user_params|
    #       user_params.require(:name) # SAFER
    #     end
    #   end
291
    #
292
    # for example.
293
    def require(key)
X
Xavier Noria 已提交
294
      return key.map { |k| require(k) } if key.is_a?(Array)
295 296 297 298 299 300
      value = self[key]
      if value.present? || value == false
        value
      else
        raise ParameterMissing.new(key)
      end
301 302
    end

303
    # Alias of #require.
304 305
    alias :required :require

306
    # Returns a new <tt>ActionController::Parameters</tt> instance that
307 308
    # includes only the given +filters+ and sets the +permitted+ attribute
    # for the object to +true+. This is useful for limiting which attributes
309 310 311 312
    # should be allowed for mass updating.
    #
    #   params = ActionController::Parameters.new(user: { name: 'Francesco', age: 22, role: 'admin' })
    #   permitted = params.require(:user).permit(:name, :age)
313
    #   permitted.permitted?      # => true
314 315 316 317
    #   permitted.has_key?(:name) # => true
    #   permitted.has_key?(:age)  # => true
    #   permitted.has_key?(:role) # => false
    #
318 319 320 321
    # Only permitted scalars pass the filter. For example, given
    #
    #   params.permit(:name)
    #
322
    # +:name+ passes if it is a key of +params+ whose associated value is of type
323
    # +String+, +Symbol+, +NilClass+, +Numeric+, +TrueClass+, +FalseClass+,
324 325 326
    # +Date+, +Time+, +DateTime+, +StringIO+, +IO+,
    # +ActionDispatch::Http::UploadedFile+ or +Rack::Test::UploadedFile+.
    # Otherwise, the key +:name+ is filtered out.
327 328 329 330
    #
    # You may declare that the parameter should be an array of permitted scalars
    # by mapping it to an empty array:
    #
331
    #   params = ActionController::Parameters.new(tags: ['rails', 'parameters'])
332
    #   params.permit(tags: [])
333
    #
334 335 336
    # You can also use +permit+ on nested parameters, like:
    #
    #   params = ActionController::Parameters.new({
337
    #     person: {
338 339 340 341 342 343 344 345 346
    #       name: 'Francesco',
    #       age:  22,
    #       pets: [{
    #         name: 'Purplish',
    #         category: 'dogs'
    #       }]
    #     }
    #   })
    #
347
    #   permitted = params.permit(person: [ :name, { pets: :name } ])
348 349
    #   permitted.permitted?                    # => true
    #   permitted[:person][:name]               # => "Francesco"
350
    #   permitted[:person][:age]                # => nil
351 352
    #   permitted[:person][:pets][0][:name]     # => "Purplish"
    #   permitted[:person][:pets][0][:category] # => nil
353 354 355 356 357 358 359 360
    #
    # Note that if you use +permit+ in a key that points to a hash,
    # it won't allow all the hash. You also need to specify which
    # attributes inside the hash should be whitelisted.
    #
    #   params = ActionController::Parameters.new({
    #     person: {
    #       contact: {
I
Ilya Vorontsov 已提交
361
    #         email: 'none@test.com',
362 363 364 365 366 367 368 369 370
    #         phone: '555-1234'
    #       }
    #     }
    #   })
    #
    #   params.require(:person).permit(:contact)
    #   # => {}
    #
    #   params.require(:person).permit(contact: :phone)
371
    #   # => {"contact"=>{"phone"=>"555-1234"}}
372 373 374
    #
    #   params.require(:person).permit(contact: [ :email, :phone ])
    #   # => {"contact"=>{"email"=>"none@test.com", "phone"=>"555-1234"}}
375 376 377
    def permit(*filters)
      params = self.class.new

378
      filters.flatten.each do |filter|
379
        case filter
380 381
        when Symbol, String
          permitted_scalar_filter(params, filter)
382
        when Hash then
383
          hash_filter(params, filter)
384 385 386
        end
      end

387
      unpermitted_parameters!(params) if self.class.action_on_unpermitted_parameters
388

389 390 391
      params.permit!
    end

392 393 394
    # Returns a parameter for the given +key+. If not found,
    # returns +nil+.
    #
395
    #   params = ActionController::Parameters.new(person: { name: 'Francesco' })
396
    #   params[:person] # => {"name"=>"Francesco"}
397
    #   params[:none]   # => nil
398
    def [](key)
399 400 401
      convert_hashes_to_parameters(key, @parameters[key])
    end

402 403
    # Assigns a value to a given +key+. The given key may still get filtered out
    # when +permit+ is called.
404 405
    def []=(key, value)
      @parameters[key] = value
406 407
    end

408 409 410 411 412 413 414
    # Returns a parameter for the given +key+. If the +key+
    # can't be found, there are several options: With no other arguments,
    # it will raise an <tt>ActionController::ParameterMissing</tt> error;
    # if more arguments are given, then that will be returned; if a block
    # is given, then that will be run and its result returned.
    #
    #   params = ActionController::Parameters.new(person: { name: 'Francesco' })
415
    #   params.fetch(:person)               # => {"name"=>"Francesco"}
416
    #   params.fetch(:none)                 # => ActionController::ParameterMissing: param is missing or the value is empty: none
417
    #   params.fetch(:none, 'Francesco')    # => "Francesco"
418
    #   params.fetch(:none) { 'Francesco' } # => "Francesco"
419
    def fetch(key, *args, &block)
420
      convert_value_to_parameters(
421 422 423 424 425 426
        @parameters.fetch(key) {
          if block_given?
            yield
          else
            args.fetch(0) { raise ActionController::ParameterMissing.new(key) }
          end
427
        }
428
      )
429 430
    end

431 432 433 434 435 436 437
    # Returns a new <tt>ActionController::Parameters</tt> instance that
    # includes only the given +keys+. If the given +keys+
    # don't exist, returns an empty hash.
    #
    #   params = ActionController::Parameters.new(a: 1, b: 2, c: 3)
    #   params.slice(:a, :b) # => {"a"=>1, "b"=>2}
    #   params.slice(:d)     # => {}
438
    def slice(*keys)
439 440 441
      new_instance_with_inherited_permitted_status(@parameters.slice(*keys))
    end

442 443
    # Returns current <tt>ActionController::Parameters</tt> instance which
    # contains only the given +keys+.
444 445 446 447 448
    def slice!(*keys)
      @parameters.slice!(*keys)
      self
    end

449 450 451 452 453 454
    # Returns a new <tt>ActionController::Parameters</tt> instance that
    # filters out the given +keys+.
    #
    #   params = ActionController::Parameters.new(a: 1, b: 2, c: 3)
    #   params.except(:a, :b) # => {"c"=>3}
    #   params.except(:d)     # => {"a"=>1,"b"=>2,"c"=>3}
455 456
    def except(*keys)
      new_instance_with_inherited_permitted_status(@parameters.except(*keys))
457 458
    end

459 460 461 462 463 464
    # Removes and returns the key/value pairs matching the given keys.
    #
    #   params = ActionController::Parameters.new(a: 1, b: 2, c: 3)
    #   params.extract!(:a, :b) # => {"a"=>1, "b"=>2}
    #   params                  # => {"c"=>3}
    def extract!(*keys)
465
      new_instance_with_inherited_permitted_status(@parameters.extract!(*keys))
466 467 468 469 470 471 472 473
    end

    # Returns a new <tt>ActionController::Parameters</tt> with the results of
    # running +block+ once for every value. The keys are unchanged.
    #
    #   params = ActionController::Parameters.new(a: 1, b: 2, c: 3)
    #   params.transform_values { |x| x * 2 }
    #   # => {"a"=>2, "b"=>4, "c"=>6}
474 475 476 477 478
    def transform_values(&block)
      if block
        new_instance_with_inherited_permitted_status(
          @parameters.transform_values(&block)
        )
479
      else
480
        @parameters.transform_values
481 482 483
      end
    end

484 485
    # Performs values transformation and returns the altered
    # <tt>ActionController::Parameters</tt> instance.
486 487 488 489 490
    def transform_values!(&block)
      @parameters.transform_values!(&block)
      self
    end

491 492 493
    # Returns a new <tt>ActionController::Parameters</tt> instance with the
    # results of running +block+ once for every key. The values are unchanged.
    def transform_keys(&block)
494 495 496 497
      if block
        new_instance_with_inherited_permitted_status(
          @parameters.transform_keys(&block)
        )
498
      else
499
        @parameters.transform_keys
500 501 502
      end
    end

J
Jon Atack 已提交
503
    # Performs keys transformation and returns the altered
504
    # <tt>ActionController::Parameters</tt> instance.
505 506 507 508 509
    def transform_keys!(&block)
      @parameters.transform_keys!(&block)
      self
    end

510 511 512 513 514
    # Deletes and returns a key-value pair from +Parameters+ whose key is equal
    # to key. If the key is not found, returns the default value. If the
    # optional code block is given and the key is not found, pass in the key
    # and return the result of block.
    def delete(key, &block)
515
      convert_value_to_parameters(@parameters.delete(key))
516 517
    end

518 519
    # Returns a new instance of <tt>ActionController::Parameters</tt> with only
    # items that the block evaluates to true.
520 521
    def select(&block)
      new_instance_with_inherited_permitted_status(@parameters.select(&block))
522 523 524 525
    end

    # Equivalent to Hash#keep_if, but returns nil if no changes were made.
    def select!(&block)
526 527 528 529 530
      @parameters.select!(&block)
      self
    end
    alias_method :keep_if, :select!

531 532
    # Returns a new instance of <tt>ActionController::Parameters</tt> with items
    # that the block evaluates to true removed.
533 534 535 536
    def reject(&block)
      new_instance_with_inherited_permitted_status(@parameters.reject(&block))
    end

537
    # Removes items that the block evaluates to true and returns self.
538 539 540 541 542 543
    def reject!(&block)
      @parameters.reject!(&block)
      self
    end
    alias_method :delete_if, :reject!

544 545
    # Return values that were assigned to the given +keys+. Note that all the
    # +Hash+ objects will be converted to <tt>ActionController::Parameters</tt>.
546 547
    def values_at(*keys)
      convert_value_to_parameters(@parameters.values_at(*keys))
548 549
    end

550 551 552 553 554 555 556 557
    # Returns an exact copy of the <tt>ActionController::Parameters</tt>
    # instance. +permitted+ state is kept on the duped object.
    #
    #   params = ActionController::Parameters.new(a: 1)
    #   params.permit!
    #   params.permitted?        # => true
    #   copy_params = params.dup # => {"a"=>1}
    #   copy_params.permitted?   # => true
558 559
    def dup
      super.tap do |duplicate|
560
        duplicate.permitted = @permitted
561 562 563
      end
    end

564 565
    # Returns a new <tt>ActionController::Parameters</tt> with all keys from
    # +other_hash+ merges into current hash.
566 567 568 569 570 571 572
    def merge(other_hash)
      new_instance_with_inherited_permitted_status(
        @parameters.merge(other_hash)
      )
    end

    # This is required by ActiveModel attribute assignment, so that user can
573 574 575
    # pass +Parameters+ to a mass assignment methods in a model. It should not
    # matter as we are using +HashWithIndifferentAccess+ internally.
    def stringify_keys # :nodoc:
576 577 578
      dup
    end

579 580 581 582 583
    protected
      def permitted=(new_permitted)
        @permitted = new_permitted
      end

584 585 586 587
      def fields_for_style?
        @parameters.all? { |k, v| k =~ /\A-?\d+\z/ && v.is_a?(Hash) }
      end

588
    private
589 590 591 592 593 594
      def new_instance_with_inherited_permitted_status(hash)
        self.class.new(hash).tap do |new_instance|
          new_instance.permitted = @permitted
        end
      end

595
      def convert_hashes_to_parameters(key, value)
596
        converted = convert_value_to_parameters(value)
597
        @parameters[key] = converted unless converted.equal?(value)
598 599 600
        converted
      end

601
      def convert_value_to_parameters(value)
602 603 604
        case value
        when Array
          return value if converted_arrays.member?(value)
605 606
          converted = value.map { |_| convert_value_to_parameters(_) }
          converted_arrays << converted
607
          converted
608
        when Hash
609
          self.class.new(value)
610 611
        else
          value
612 613 614 615
        end
      end

      def each_element(object)
A
Aaron Patterson 已提交
616 617 618 619
        case object
        when Array
          object.grep(Parameters).map { |el| yield el }.compact
        when Parameters
620
          if object.fields_for_style?
A
Aaron Patterson 已提交
621 622 623 624 625 626
            hash = object.class.new
            object.each { |k,v| hash[k] = yield v }
            hash
          else
            yield object
          end
627 628
        end
      end
629 630 631 632 633 634

      def unpermitted_parameters!(params)
        unpermitted_keys = unpermitted_keys(params)
        if unpermitted_keys.any?
          case self.class.action_on_unpermitted_parameters
          when :log
635 636
            name = "unpermitted_parameters.action_controller"
            ActiveSupport::Notifications.instrument(name, keys: unpermitted_keys)
637 638 639 640 641 642 643
          when :raise
            raise ActionController::UnpermittedParameters.new(unpermitted_keys)
          end
        end
      end

      def unpermitted_keys(params)
644
        self.keys - params.keys - self.always_permitted_parameters
645
      end
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669

      #
      # --- Filtering ----------------------------------------------------------
      #

      # This is a white list of permitted scalar types that includes the ones
      # supported in XML and JSON requests.
      #
      # This list is in particular used to filter ordinary requests, String goes
      # as first element to quickly short-circuit the common case.
      #
      # If you modify this collection please update the API of +permit+ above.
      PERMITTED_SCALAR_TYPES = [
        String,
        Symbol,
        NilClass,
        Numeric,
        TrueClass,
        FalseClass,
        Date,
        Time,
        # DateTimes are Dates, we document the type but avoid the redundant check.
        StringIO,
        IO,
670
        ActionDispatch::Http::UploadedFile,
671
        Rack::Test::UploadedFile,
672 673 674 675 676 677 678 679 680 681 682
      ]

      def permitted_scalar?(value)
        PERMITTED_SCALAR_TYPES.any? {|type| value.is_a?(type)}
      end

      def permitted_scalar_filter(params, key)
        if has_key?(key) && permitted_scalar?(self[key])
          params[key] = self[key]
        end

683
        keys.grep(/\A#{Regexp.escape(key)}\(\d+[if]?\)\z/) do |k|
684 685
          if permitted_scalar?(self[k])
            params[k] = self[k]
686 687 688 689 690
          end
        end
      end

      def array_of_permitted_scalars?(value)
A
Aaron Patterson 已提交
691
        if value.is_a?(Array) && value.all? {|element| permitted_scalar?(element)}
692
          yield value
693 694 695
        end
      end

696
      EMPTY_ARRAY = []
697 698 699 700 701
      def hash_filter(params, filter)
        filter = filter.with_indifferent_access

        # Slicing filters out non-declared keys.
        slice(*filter.keys).each do |key, value|
702
          next unless value
A
Aaron Patterson 已提交
703
          next unless has_key? key
704

705
          if filter[key] == EMPTY_ARRAY
706
            # Declaration { comment_ids: [] }.
A
Aaron Patterson 已提交
707
            array_of_permitted_scalars?(self[key]) do |val|
708 709
              params[key] = val
            end
710
          else
V
Vipul A M 已提交
711
            # Declaration { user: :name } or { user: [:name, :age, { address: ... }] }.
712
            params[key] = each_element(value) do |element|
A
Aaron Patterson 已提交
713
              element.permit(*Array.wrap(filter[key]))
714 715 716 717
            end
          end
        end
      end
718 719
  end

720
  # == Strong \Parameters
721
  #
722
  # It provides an interface for protecting attributes from end-user
723
  # assignment. This makes Action Controller parameters forbidden
724
  # to be used in Active Model mass assignment until they have been
725 726 727 728 729 730 731
  # whitelisted.
  #
  # In addition, parameters can be marked as required and flow through a
  # predefined raise/rescue flow to end up as a 400 Bad Request with no
  # effort.
  #
  #   class PeopleController < ActionController::Base
732 733 734 735
  #     # Using "Person.create(params[:person])" would raise an
  #     # ActiveModel::ForbiddenAttributes exception because it'd
  #     # be using mass assignment without an explicit permit step.
  #     # This is the recommended form:
736
  #     def create
737
  #       Person.create(person_params)
738 739 740
  #     end
  #
  #     # This will pass with flying colors as long as there's a person key in the
741
  #     # parameters, otherwise it'll raise an ActionController::MissingParameter
742
  #     # exception, which will get caught by ActionController::Base and turned
743
  #     # into a 400 Bad Request reply.
744 745
  #     def update
  #       redirect_to current_account.people.find(params[:id]).tap { |person|
746
  #         person.update!(person_params)
747 748 749 750 751
  #       }
  #     end
  #
  #     private
  #       # Using a private method to encapsulate the permissible parameters is
752
  #       # just a good pattern since you'll be able to reuse the same permit
753 754 755 756 757 758 759
  #       # list between create and update. Also, you can specialize this method
  #       # with per-user checking of permissible attributes.
  #       def person_params
  #         params.require(:person).permit(:name, :age)
  #       end
  #   end
  #
760
  # In order to use <tt>accepts_nested_attributes_for</tt> with Strong \Parameters, you
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
  # will need to specify which nested attributes should be whitelisted.
  #
  #   class Person
  #     has_many :pets
  #     accepts_nested_attributes_for :pets
  #   end
  #
  #   class PeopleController < ActionController::Base
  #     def create
  #       Person.create(person_params)
  #     end
  #
  #     ...
  #
  #     private
  #
  #       def person_params
  #         # It's mandatory to specify the nested attributes that should be whitelisted.
  #         # If you use `permit` with just the key that points to the nested attributes hash,
  #         # it will return an empty hash.
781
  #         params.require(:person).permit(:name, :age, pets_attributes: [ :name, :category ])
782 783 784
  #       end
  #   end
  #
785 786
  # See ActionController::Parameters.require and ActionController::Parameters.permit
  # for more information.
787 788 789 790
  module StrongParameters
    extend ActiveSupport::Concern
    include ActiveSupport::Rescuable

791 792
    # Returns a new ActionController::Parameters object that
    # has been instantiated with the <tt>request.parameters</tt>.
793 794 795 796
    def params
      @_params ||= Parameters.new(request.parameters)
    end

797 798 799 800 801
    # Assigns the given +value+ to the +params+ hash. If +value+
    # is a Hash, this will create an ActionController::Parameters
    # object that has been instantiated with the given +value+ hash.
    def params=(value)
      @_params = value.is_a?(Hash) ? Parameters.new(value) : value
802 803 804
    end
  end
end