base.rb 59.5 KB
Newer Older
1
require 'set'
D
Initial  
David Heinemeier Hansson 已提交
2 3 4 5

module ActionController #:nodoc:
  class ActionControllerError < StandardError #:nodoc:
  end
6

D
Initial  
David Heinemeier Hansson 已提交
7 8
  class SessionRestoreError < ActionControllerError #:nodoc:
  end
9

10 11
  class RenderError < ActionControllerError #:nodoc:
  end
12

13
  class RoutingError < ActionControllerError #:nodoc:
14 15 16 17 18 19
    attr_reader :failures
    def initialize(message, failures=[])
      super(message)
      @failures = failures
    end
  end
20

21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
  class MethodNotAllowed < ActionControllerError #:nodoc:
    attr_reader :allowed_methods

    def initialize(*allowed_methods)
      super("Only #{allowed_methods.to_sentence} requests are allowed.")
      @allowed_methods = allowed_methods
    end

    def allowed_methods_header
      allowed_methods.map { |method_symbol| method_symbol.to_s.upcase } * ', '
    end

    def handle_response!(response)
      response.headers['Allow'] ||= allowed_methods_header
    end
  end
37

38 39
  class NotImplemented < MethodNotAllowed #:nodoc:
  end
40

41 42
  class UnknownController < ActionControllerError #:nodoc:
  end
43

D
Initial  
David Heinemeier Hansson 已提交
44 45
  class UnknownAction < ActionControllerError #:nodoc:
  end
46

47 48
  class MissingFile < ActionControllerError #:nodoc:
  end
49

50 51
  class RenderError < ActionControllerError #:nodoc:
  end
52

53 54
  class SessionOverflowError < ActionControllerError #:nodoc:
    DEFAULT_MESSAGE = 'Your session data is larger than the data column in which it is to be stored. You must increase the size of your data column if you intend to store large data.'
55 56 57 58

    def initialize(message = nil)
      super(message || DEFAULT_MESSAGE)
    end
59
  end
60

61
  class DoubleRenderError < ActionControllerError #:nodoc:
62
    DEFAULT_MESSAGE = "Render and/or redirect were called multiple times in this action. Please note that you may only call render OR redirect, and at most once per action. Also note that neither redirect nor render terminate execution of the action, so if you want to exit an action after redirecting, you need to do something like \"redirect_to(...) and return\"."
63

64
    def initialize(message = nil)
65 66
      super(message || DEFAULT_MESSAGE)
    end
67
  end
68

69
  class RedirectBackError < ActionControllerError #:nodoc:
70 71
    DEFAULT_MESSAGE = 'No HTTP_REFERER was set in the request to this action, so redirect_to :back could not be called successfully. If this is a test, make sure to specify request.env["HTTP_REFERER"].'

72 73 74 75
    def initialize(message = nil)
      super(message || DEFAULT_MESSAGE)
    end
  end
D
Initial  
David Heinemeier Hansson 已提交
76

77 78
  class UnknownHttpMethod < ActionControllerError #:nodoc:
  end
79

80
  # Action Controllers are the core of a web request in Rails. They are made up of one or more actions that are executed
81
  # on request and then either render a template or redirect to another action. An action is defined as a public method
82
  # on the controller, which will automatically be made accessible to the web-server through Rails Routes.
83 84
  #
  # A sample controller could look like this:
D
Initial  
David Heinemeier Hansson 已提交
85 86 87
  #
  #   class GuestBookController < ActionController::Base
  #     def index
88
  #       @entries = Entry.find(:all)
D
Initial  
David Heinemeier Hansson 已提交
89
  #     end
90
  #
D
Initial  
David Heinemeier Hansson 已提交
91
  #     def sign
92
  #       Entry.create(params[:entry])
D
Initial  
David Heinemeier Hansson 已提交
93 94 95 96
  #       redirect_to :action => "index"
  #     end
  #   end
  #
97
  # Actions, by default, render a template in the <tt>app/views</tt> directory corresponding to the name of the controller and action
P
Pratik Naik 已提交
98
  # after executing code in the action. For example, the +index+ action of the GuestBookController would render the
99
  # template <tt>app/views/guestbook/index.erb</tt> by default after populating the <tt>@entries</tt> instance variable.
D
Initial  
David Heinemeier Hansson 已提交
100
  #
101 102
  # Unlike index, the sign action will not render a template. After performing its main purpose (creating a
  # new entry in the guest book), it initiates a redirect instead. This redirect works by returning an external
103
  # "302 Moved" HTTP response that takes the user to the index action.
D
Initial  
David Heinemeier Hansson 已提交
104 105 106 107 108 109 110 111
  #
  # The index and sign represent the two basic action archetypes used in Action Controllers. Get-and-show and do-and-redirect.
  # Most actions are variations of these themes.
  #
  # == Requests
  #
  # Requests are processed by the Action Controller framework by extracting the value of the "action" key in the request parameters.
  # This value should hold the name of the action to be performed. Once the action has been identified, the remaining
P
Pratik Naik 已提交
112
  # request parameters, the session (if one is available), and the full request with all the HTTP headers are made available to
D
Initial  
David Heinemeier Hansson 已提交
113 114
  # the action through instance variables. Then the action is performed.
  #
P
Pratik Naik 已提交
115
  # The full request object is available with the request accessor and is primarily used to query for HTTP headers. These queries
116
  # are made by accessing the environment hash, like this:
D
Initial  
David Heinemeier Hansson 已提交
117
  #
118 119 120
  #   def server_ip
  #     location = request.env["SERVER_ADDR"]
  #     render :text => "This server hosted at #{location}"
D
Initial  
David Heinemeier Hansson 已提交
121 122 123 124
  #   end
  #
  # == Parameters
  #
125
  # All request parameters, whether they come from a GET or POST request, or from the URL, are available through the params method
126
  # which returns a hash. For example, an action that was performed through <tt>/weblog/list?category=All&limit=5</tt> will include
127
  # <tt>{ "category" => "All", "limit" => 5 }</tt> in params.
D
Initial  
David Heinemeier Hansson 已提交
128 129 130 131 132 133
  #
  # It's also possible to construct multi-dimensional parameter hashes by specifying keys using brackets, such as:
  #
  #   <input type="text" name="post[name]" value="david">
  #   <input type="text" name="post[address]" value="hyacintvej">
  #
D
David Heinemeier Hansson 已提交
134
  # A request stemming from a form holding these inputs will include <tt>{ "post" => { "name" => "david", "address" => "hyacintvej" } }</tt>.
135
  # If the address input had been named "post[address][street]", the params would have included
D
David Heinemeier Hansson 已提交
136
  # <tt>{ "post" => { "address" => { "street" => "hyacintvej" } } }</tt>. There's no limit to the depth of the nesting.
D
Initial  
David Heinemeier Hansson 已提交
137 138 139
  #
  # == Sessions
  #
140
  # Sessions allows you to store objects in between requests. This is useful for objects that are not yet ready to be persisted,
D
Initial  
David Heinemeier Hansson 已提交
141
  # such as a Signup object constructed in a multi-paged process, or objects that don't change much and are needed all the time, such
142
  # as a User object for a system that requires login. The session should not be used, however, as a cache for objects where it's likely
D
Initial  
David Heinemeier Hansson 已提交
143 144
  # they could be changed unknowingly. It's usually too much work to keep it all synchronized -- something databases already excel at.
  #
145
  # You can place objects in the session by using the <tt>session</tt> method, which accesses a hash:
D
Initial  
David Heinemeier Hansson 已提交
146
  #
147
  #   session[:person] = Person.authenticate(user_name, password)
D
Initial  
David Heinemeier Hansson 已提交
148 149 150
  #
  # And retrieved again through the same hash:
  #
151
  #   Hello #{session[:person]}
D
Initial  
David Heinemeier Hansson 已提交
152
  #
P
Pratik Naik 已提交
153
  # For removing objects from the session, you can either assign a single key to +nil+:
154
  #
P
Pratik Naik 已提交
155 156
  #   # removes :person from session
  #   session[:person] = nil
157
  #
P
Pratik Naik 已提交
158 159 160 161 162 163
  # or you can remove the entire session with +reset_session+.
  #
  # Sessions are stored by default in a browser cookie that's cryptographically signed, but unencrypted.
  # This prevents the user from tampering with the session but also allows him to see its contents.
  #
  # Do not put secret information in cookie-based sessions!
164 165 166
  #
  # Other options for session storage are:
  #
J
Joshua Peek 已提交
167 168
  # * ActiveRecord::SessionStore - Sessions are stored in your database, which works better than PStore with multiple app servers and,
  #   unlike CookieStore, hides your session contents from the user. To use ActiveRecord::SessionStore, set
169
  #
P
Pratik Naik 已提交
170
  #     config.action_controller.session_store = :active_record_store
171
  #
P
Pratik Naik 已提交
172
  #   in your <tt>config/environment.rb</tt> and run <tt>rake db:sessions:create</tt>.
173
  #
P
Pratik Naik 已提交
174 175
  # * MemCacheStore - Sessions are stored as entries in your memcached cache.
  #   Set the session store type in <tt>config/environment.rb</tt>:
176
  #
P
Pratik Naik 已提交
177
  #     config.action_controller.session_store = :mem_cache_store
178
  #
P
Pratik Naik 已提交
179 180
  #   This assumes that memcached has been installed and configured properly.
  #   See the MemCacheStore docs for more information.
181
  #
D
Initial  
David Heinemeier Hansson 已提交
182 183 184
  # == Responses
  #
  # Each action results in a response, which holds the headers and document to be sent to the user's browser. The actual response
185
  # object is generated automatically through the use of renders and redirects and requires no user intervention.
D
Initial  
David Heinemeier Hansson 已提交
186 187 188 189 190 191 192 193
  #
  # == Renders
  #
  # Action Controller sends content to the user by using one of five rendering methods. The most versatile and common is the rendering
  # of a template. Included in the Action Pack is the Action View, which enables rendering of ERb templates. It's automatically configured.
  # The controller passes objects to the view by assigning instance variables:
  #
  #   def show
194
  #     @post = Post.find(params[:id])
D
Initial  
David Heinemeier Hansson 已提交
195 196 197 198 199 200 201 202 203 204
  #   end
  #
  # Which are then automatically available to the view:
  #
  #   Title: <%= @post.title %>
  #
  # You don't have to rely on the automated rendering. Especially actions that could result in the rendering of different templates will use
  # the manual rendering methods:
  #
  #   def search
205
  #     @results = Search.find(params[:query])
D
Initial  
David Heinemeier Hansson 已提交
206
  #     case @results
207 208 209
  #       when 0 then render :action => "no_results"
  #       when 1 then render :action => "show"
  #       when 2..10 then render :action => "show_many"
D
Initial  
David Heinemeier Hansson 已提交
210 211 212 213 214 215 216
  #     end
  #   end
  #
  # Read more about writing ERb and Builder templates in link:classes/ActionView/Base.html.
  #
  # == Redirects
  #
217 218 219 220 221 222 223 224 225 226 227 228 229
  # Redirects are used to move from one action to another. For example, after a <tt>create</tt> action, which stores a blog entry to a database,
  # we might like to show the user the new entry. Because we're following good DRY principles (Don't Repeat Yourself), we're going to reuse (and redirect to)
  # a <tt>show</tt> action that we'll assume has already been created. The code might look like this:
  #
  #   def create
  #     @entry = Entry.new(params[:entry])
  #     if @entry.save
  #       # The entry was saved correctly, redirect to show
  #       redirect_to :action => 'show', :id => @entry.id
  #     else
  #       # things didn't go so well, do something else
  #     end
  #   end
D
Initial  
David Heinemeier Hansson 已提交
230
  #
231
  # In this case, after saving our new entry to the database, the user is redirected to the <tt>show</tt> method which is then executed.
D
Initial  
David Heinemeier Hansson 已提交
232
  #
233 234
  # == Calling multiple redirects or renders
  #
235
  # An action may contain only a single render or a single redirect. Attempting to try to do either again will result in a DoubleRenderError:
236 237 238
  #
  #   def do_something
  #     redirect_to :action => "elsewhere"
239
  #     render :action => "overthere" # raises DoubleRenderError
240 241
  #   end
  #
242
  # If you need to redirect on the condition of something, then be sure to add "and return" to halt execution.
243
  #
244 245
  #   def do_something
  #     redirect_to(:action => "elsewhere") and return if monkeys.nil?
P
Pratik Naik 已提交
246
  #     render :action => "overthere" # won't be called if monkeys is nil
247 248
  #   end
  #
D
Initial  
David Heinemeier Hansson 已提交
249 250
  class Base
    DEFAULT_RENDER_STATUS_CODE = "200 OK"
251

252
    include StatusCodes
253

254
    cattr_reader :protected_instance_variables
255
    # Controller specific instance variables which will not be accessible inside views.
256
    @@protected_instance_variables = %w(@assigns @performed_redirect @performed_render @variables_added @request_origin @url @parent_controller
257
                                        @action_name @before_filter_chain_aborted @action_cache_path @_session @_headers @_params
258
                                        @_flash @_response)
259

260 261
    # Prepends all the URL-generating helpers from AssetHelper. This makes it possible to easily move javascripts, stylesheets,
    # and images to a dedicated asset server away from the main web server. Example:
262 263 264 265
    #   ActionController::Base.asset_host = "http://assets.example.com"
    @@asset_host = ""
    cattr_accessor :asset_host

D
Initial  
David Heinemeier Hansson 已提交
266 267 268 269 270
    # All requests are considered local by default, so everyone will be exposed to detailed debugging screens on errors.
    # When the application is ready to go public, this should be set to false, and the protected method <tt>local_request?</tt>
    # should instead be implemented in the controller to determine when debugging screens should be shown.
    @@consider_all_requests_local = true
    cattr_accessor :consider_all_requests_local
271

272 273 274 275 276 277
    # Indicates whether to allow concurrent action processing. Your
    # controller actions and any other code they call must also behave well
    # when called from concurrent threads. Turned off by default.
    @@allow_concurrency = false
    cattr_accessor :allow_concurrency

278
    # Modern REST web services often need to submit complex data to the web application.
P
Pratik Naik 已提交
279 280
    # The <tt>@@param_parsers</tt> hash lets you register handlers which will process the HTTP body and add parameters to the
    # <tt>params</tt> hash. These handlers are invoked for POST and PUT requests.
281
    #
P
Pratik Naik 已提交
282
    # By default <tt>application/xml</tt> is enabled. A XmlSimple class with the same param name as the root will be instantiated
283
    # in the <tt>params</tt>. This allows XML requests to mask themselves as regular form submissions, so you can have one
284
    # action serve both regular forms and web service requests.
285
    #
286
    # Example of doing your own parser for a custom content type:
287
    #
288 289
    #   ActionController::Base.param_parsers[Mime::Type.lookup('application/atom+xml')] = Proc.new do |data|
    #      node = REXML::Document.new(post)
290 291 292
    #     { node.root.name => node.root }
    #   end
    #
293
    # Note: Up until release 1.1 of Rails, Action Controller would default to using XmlSimple configured to discard the
294
    # root node for such requests. The new default is to keep the root, such that "<r><name>David</name></r>" results
P
Pratik Naik 已提交
295
    # in <tt>params[:r][:name]</tt> for "David" instead of <tt>params[:name]</tt>. To get the old behavior, you can
296
    # re-register XmlSimple as application/xml handler ike this:
297
    #
298
    #   ActionController::Base.param_parsers[Mime::XML] =
299
    #     Proc.new { |data| XmlSimple.xml_in(data, 'ForceArray' => false) }
300 301 302 303
    #
    # A YAML parser is also available and can be turned on with:
    #
    #   ActionController::Base.param_parsers[Mime::YAML] = :yaml
304
    @@param_parsers = { Mime::MULTIPART_FORM   => :multipart_form,
305
                        Mime::URL_ENCODED_FORM => :url_encoded_form,
306 307
                        Mime::XML              => :xml_simple,
                        Mime::JSON             => :json }
308
    cattr_accessor :param_parsers
309

310 311 312
    # Controls the default charset for all renders.
    @@default_charset = "utf-8"
    cattr_accessor :default_charset
313

D
Initial  
David Heinemeier Hansson 已提交
314 315 316
    # The logger is used for generating information on the action run-time (including benchmarking) if available.
    # Can be set to nil for no logging. Compatible with both Ruby's own Logger and Log4r loggers.
    cattr_accessor :logger
317

318 319 320
    # Controls the resource action separator
    @@resource_action_separator = "/"
    cattr_accessor :resource_action_separator
321

322 323 324 325
    # Allow to override path names for default resources' actions
    @@resources_path_names = { :new => 'new', :edit => 'edit' }
    cattr_accessor :resources_path_names

326 327
    # Sets the token parameter name for RequestForgery. Calling +protect_from_forgery+
    # sets it to <tt>:authenticity_token</tt> by default.
328
    cattr_accessor :request_forgery_protection_token
329

330 331 332 333
    # Controls the IP Spoofing check when determining the remote IP.
    @@ip_spoofing_check = true
    cattr_accessor :ip_spoofing_check

334 335 336 337 338
    # Indicates whether or not optimise the generated named
    # route helper methods
    cattr_accessor :optimise_named_routes
    self.optimise_named_routes = true

339 340 341
    # Indicates whether the response format should be determined by examining the Accept HTTP header,
    # or by using the simpler params + ajax rules.
    #
342 343
    # If this is set to +true+ (the default) then +respond_to+ and +Request#format+ will take the Accept
    # header into account.  If it is set to false then the request format will be determined solely
344 345 346
    # by examining params[:format].  If params format is missing, the format will be either HTML or
    # Javascript depending on whether the request is an AJAX request.
    cattr_accessor :use_accept_header
347
    self.use_accept_header = true
348

349 350 351
    # Controls whether request forgergy protection is turned on or not. Turned off by default only in test mode.
    class_inheritable_accessor :allow_forgery_protection
    self.allow_forgery_protection = true
352

353 354
    # If you are deploying to a subdirectory, you will need to set
    # <tt>config.action_controller.relative_url_root</tt>
355
    # This defaults to ENV['RAILS_RELATIVE_URL_ROOT']
356 357
    cattr_accessor :relative_url_root
    self.relative_url_root = ENV['RAILS_RELATIVE_URL_ROOT']
358

D
Initial  
David Heinemeier Hansson 已提交
359
    # Holds the request object that's primarily used to get environment variables through access like
360
    # <tt>request.env["REQUEST_URI"]</tt>.
361
    attr_internal :request
362

363
    # Holds a hash of all the GET, POST, and Url parameters passed to the action. Accessed like <tt>params["post_id"]</tt>
D
Initial  
David Heinemeier Hansson 已提交
364
    # to get the post_id. No type casts are made, so all values are returned as strings.
365 366
    attr_internal :params

367
    # Holds the response object that's primarily used to set additional HTTP headers through access like
368 369
    # <tt>response.headers["Cache-Control"] = "no-cache"</tt>. Can also be used to access the final body HTML after a template
    # has been rendered through response.body -- useful for <tt>after_filter</tt>s that wants to manipulate the output,
D
Initial  
David Heinemeier Hansson 已提交
370
    # such as a OutputCompressionFilter.
J
Jeremy Kemper 已提交
371
    attr_internal :response
372

373
    # Holds a hash of objects in the session. Accessed like <tt>session[:person]</tt> to get the object tied to the "person"
374
    # key. The session will hold any type of object as values, but the key should be a string or symbol.
375 376
    attr_internal :session

377
    # Holds a hash of header names and values. Accessed like <tt>headers["Cache-Control"]</tt> to get the value of the Cache-Control
D
Initial  
David Heinemeier Hansson 已提交
378
    # directive. Values should always be specified as strings.
J
Jeremy Kemper 已提交
379
    attr_internal :headers
380

381 382
    # Returns the name of the action this controller is processing.
    attr_accessor :action_name
383

D
Initial  
David Heinemeier Hansson 已提交
384
    class << self
385 386 387 388 389 390 391
      def call(env)
        # HACK: For global rescue to have access to the original request and response
        request = env["actioncontroller.rescue.request"] ||= Request.new(env)
        response = env["actioncontroller.rescue.response"] ||= Response.new
        process(request, response)
      end

D
Initial  
David Heinemeier Hansson 已提交
392
      # Factory for the standard create, process loop where the controller is discarded after processing.
393 394
      def process(request, response) #:nodoc:
        new.process(request, response)
D
Initial  
David Heinemeier Hansson 已提交
395
      end
396

D
Initial  
David Heinemeier Hansson 已提交
397 398
      # Converts the class name from something like "OneModule::TwoModule::NeatController" to "NeatController".
      def controller_class_name
399
        @controller_class_name ||= name.demodulize
D
Initial  
David Heinemeier Hansson 已提交
400 401 402 403
      end

      # Converts the class name from something like "OneModule::TwoModule::NeatController" to "neat".
      def controller_name
404
        @controller_name ||= controller_class_name.sub(/Controller$/, '').underscore
D
Initial  
David Heinemeier Hansson 已提交
405
      end
406

407
      # Converts the class name from something like "OneModule::TwoModule::NeatController" to "one_module/two_module/neat".
408
      def controller_path
N
Nicholas Seckar 已提交
409
        @controller_path ||= name.gsub(/Controller$/, '').underscore
410
      end
411 412 413

      # Return an array containing the names of public methods that have been marked hidden from the action processor.
      # By default, all methods defined in ActionController::Base and included modules are hidden.
414
      # More methods can be hidden using <tt>hide_actions</tt>.
415
      def hidden_actions
416
        read_inheritable_attribute(:hidden_actions) || write_inheritable_attribute(:hidden_actions, [])
417 418 419
      end

      # Hide each of the given methods from being callable as actions.
420
      def hide_action(*names)
421
        write_inheritable_attribute(:hidden_actions, hidden_actions | names.map { |name| name.to_s })
422
      end
423

424 425 426
      # View load paths determine the bases from which template references can be made. So a call to
      # render("test/template") will be looked up in the view load paths array and the closest match will be
      # returned.
427
      def view_paths
428 429 430 431 432
        if defined? @view_paths
          @view_paths
        else
          superclass.view_paths
        end
433
      end
434

435
      def view_paths=(value)
436
        @view_paths = ActionView::Base.process_view_paths(value) if value
437
      end
438 439

      # Adds a view_path to the front of the view_paths array.
440
      # If the current class has no view paths, copy them from
441
      # the superclass.  This change will be visible for all future requests.
442 443 444 445
      #
      #   ArticleController.prepend_view_path("views/default")
      #   ArticleController.prepend_view_path(["views/default", "views/custom"])
      #
446
      def prepend_view_path(path)
447
        @view_paths = superclass.view_paths.dup if !defined?(@view_paths) || @view_paths.nil?
448
        @view_paths.unshift(*path)
449
      end
450

451
      # Adds a view_path to the end of the view_paths array.
452
      # If the current class has no view paths, copy them from
453
      # the superclass. This change will be visible for all future requests.
454 455 456 457
      #
      #   ArticleController.append_view_path("views/default")
      #   ArticleController.append_view_path(["views/default", "views/custom"])
      #
458
      def append_view_path(path)
459
        @view_paths = superclass.view_paths.dup if @view_paths.nil?
460
        @view_paths.push(*path)
461
      end
462

463 464
      # Replace sensitive parameter data from the request log.
      # Filters parameters that have any of the arguments as a substring.
465
      # Looks in all subhashes of the param hash for keys to filter.
466
      # If a block is given, each key and value of the parameter hash and all
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
      # subhashes is passed to it, the value or key
      # can be replaced using String#replace or similar method.
      #
      # Examples:
      #   filter_parameter_logging
      #   => Does nothing, just slows the logging process down
      #
      #   filter_parameter_logging :password
      #   => replaces the value to all keys matching /password/i with "[FILTERED]"
      #
      #   filter_parameter_logging :foo, "bar"
      #   => replaces the value to all keys matching /foo|bar/i with "[FILTERED]"
      #
      #   filter_parameter_logging { |k,v| v.reverse! if k =~ /secret/i }
      #   => reverses the value to all keys matching /secret/i
      #
      #   filter_parameter_logging(:foo, "bar") { |k,v| v.reverse! if k =~ /secret/i }
484
      #   => reverses the value to all keys matching /secret/i, and
485 486 487 488
      #      replaces the value to all keys matching /foo|bar/i with "[FILTERED]"
      def filter_parameter_logging(*filter_words, &block)
        parameter_filter = Regexp.new(filter_words.collect{ |s| s.to_s }.join('|'), true) if filter_words.length > 0

489 490
        define_method(:filter_parameters) do |unfiltered_parameters|
          filtered_parameters = {}
491

492 493 494 495
          unfiltered_parameters.each do |key, value|
            if key =~ parameter_filter
              filtered_parameters[key] = '[FILTERED]'
            elsif value.is_a?(Hash)
496
              filtered_parameters[key] = filter_parameters(value)
497
            elsif block_given?
498 499
              key = key.dup
              value = value.dup if value
500 501
              yield key, value
              filtered_parameters[key] = value
502
            else
503
              filtered_parameters[key] = value
504
            end
M
Marcel Molina 已提交
505
          end
506 507

          filtered_parameters
508
        end
509
        protected :filter_parameters
510
      end
511

512
      delegate :exempt_from_layout, :to => 'ActionView::Template'
D
Initial  
David Heinemeier Hansson 已提交
513 514
    end

515
    public
D
Initial  
David Heinemeier Hansson 已提交
516
      # Extracts the action_name from the request parameters and performs that action.
517
      def process(request, response, method = :perform_action, *arguments) #:nodoc:
518 519
        response.request = request

D
Initial  
David Heinemeier Hansson 已提交
520 521 522
        initialize_template_class(response)
        assign_shortcuts(request, response)
        initialize_current_url
523
        assign_names
524

525
        log_processing
526
        send(method, *arguments)
527

P
Pratik Naik 已提交
528
        send_response
529
      ensure
530
        process_cleanup
D
Initial  
David Heinemeier Hansson 已提交
531 532
      end

P
Pratik Naik 已提交
533
      def send_response
534
        response.prepare!
P
Pratik Naik 已提交
535 536 537
        response
      end

P
Pratik Naik 已提交
538 539
      # Returns a URL that has been rewritten according to the options hash and the defined routes.
      # (For doing a complete redirect, use +redirect_to+).
540
      #
541
      # <tt>url_for</tt> is used to:
542
      #
P
Pratik Naik 已提交
543 544
      # All keys given to +url_for+ are forwarded to the Route module, save for the following:
      # * <tt>:anchor</tt> - Specifies the anchor name to be appended to the path. For example,
545
      #   <tt>url_for :controller => 'posts', :action => 'show', :id => 10, :anchor => 'comments'</tt>
546
      #   will produce "/posts/show/10#comments".
P
Pratik Naik 已提交
547 548
      # * <tt>:only_path</tt> - If true, returns the relative URL (omitting the protocol, host name, and port) (<tt>false</tt> by default).
      # * <tt>:trailing_slash</tt> - If true, adds a trailing slash, as in "/archive/2005/". Note that this
549
      #   is currently not recommended since it breaks caching.
P
Pratik Naik 已提交
550 551 552 553 554 555 556
      # * <tt>:host</tt> - Overrides the default (current) host if provided.
      # * <tt>:protocol</tt> - Overrides the default (current) protocol if provided.
      # * <tt>:port</tt> - Optionally specify the port to connect to.
      # * <tt>:user</tt> - Inline HTTP authentication (only plucked out if <tt>:password</tt> is also present).
      # * <tt>:password</tt> - Inline HTTP authentication (only plucked out if <tt>:user</tt> is also present).
      # * <tt>:skip_relative_url_root</tt> - If true, the url is not constructed using the +relative_url_root+
      #   of the request so the path will include the web server relative installation directory.
D
David Heinemeier Hansson 已提交
557
      #
558 559
      # The URL is generated from the remaining keys in the hash. A URL contains two key parts: the <base> and a query string.
      # Routes composes a query string as the key/value pairs not included in the <base>.
D
David Heinemeier Hansson 已提交
560
      #
561 562
      # The default Routes setup supports a typical Rails path of "controller/action/id" where action and id are optional, with
      # action defaulting to 'index' when not given. Here are some typical url_for statements and their corresponding URLs:
563 564 565 566 567 568
      #
      #   url_for :controller => 'posts', :action => 'recent'                # => 'proto://host.com/posts/recent'
      #   url_for :controller => 'posts', :action => 'index'                 # => 'proto://host.com/posts'
      #   url_for :controller => 'posts', :action => 'index', :port=>'8033'  # => 'proto://host.com:8033/posts'
      #   url_for :controller => 'posts', :action => 'show', :id => 10       # => 'proto://host.com/posts/show/10'
      #   url_for :controller => 'posts', :user => 'd', :password => '123'   # => 'proto://d:123@host.com/posts'
D
David Heinemeier Hansson 已提交
569
      #
570 571 572 573
      # When generating a new URL, missing values may be filled in from the current request's parameters. For example,
      # <tt>url_for :action => 'some_action'</tt> will retain the current controller, as expected. This behavior extends to
      # other parameters, including <tt>:controller</tt>, <tt>:id</tt>, and any other parameters that are placed into a Route's
      # path.
574
      #  
575 576 577
      # The URL helpers such as <tt>url_for</tt> have a limited form of memory: when generating a new URL, they can look for
      # missing values in the current request's parameters. Routes attempts to guess when a value should and should not be
      # taken from the defaults. There are a few simple rules on how this is performed:
D
David Heinemeier Hansson 已提交
578
      #
P
Pratik Naik 已提交
579 580 581 582 583 584 585 586 587
      # * If the controller name begins with a slash no defaults are used:
      #
      #     url_for :controller => '/home'
      #
      #   In particular, a leading slash ensures no namespace is assumed. Thus,
      #   while <tt>url_for :controller => 'users'</tt> may resolve to
      #   <tt>Admin::UsersController</tt> if the current controller lives under
      #   that module, <tt>url_for :controller => '/users'</tt> ensures you link
      #   to <tt>::UsersController</tt> no matter what.
588
      # * If the controller changes, the action will default to index unless provided
D
David Heinemeier Hansson 已提交
589
      #
590 591
      # The final rule is applied while the URL is being generated and is best illustrated by an example. Let us consider the
      # route given by <tt>map.connect 'people/:last/:first/:action', :action => 'bio', :controller => 'people'</tt>.
D
David Heinemeier Hansson 已提交
592
      #
593
      # Suppose that the current URL is "people/hh/david/contacts". Let's consider a few different cases of URLs which are generated
594
      # from this page.
D
David Heinemeier Hansson 已提交
595
      #
596
      # * <tt>url_for :action => 'bio'</tt> -- During the generation of this URL, default values will be used for the first and
D
David Heinemeier Hansson 已提交
597
      # last components, and the action shall change. The generated URL will be, "people/hh/david/bio".
598 599
      # * <tt>url_for :first => 'davids-little-brother'</tt> This generates the URL 'people/hh/davids-little-brother' -- note
      #   that this URL leaves out the assumed action of 'bio'.
D
David Heinemeier Hansson 已提交
600
      #
601 602 603
      # However, you might ask why the action from the current request, 'contacts', isn't carried over into the new URL. The
      # answer has to do with the order in which the parameters appear in the generated path. In a nutshell, since the
      # value that appears in the slot for <tt>:first</tt> is not equal to default value for <tt>:first</tt> we stop using
604
      # defaults. On its own, this rule can account for much of the typical Rails URL behavior.
605
      #  
606
      # Although a convenience, defaults can occasionally get in your way. In some cases a default persists longer than desired.
607 608 609 610
      # The default may be cleared by adding <tt>:name => nil</tt> to <tt>url_for</tt>'s options.
      # This is often required when writing form helpers, since the defaults in play may vary greatly depending upon where the
      # helper is used from. The following line will redirect to PostController's default action, regardless of the page it is
      # displayed on:
D
Initial  
David Heinemeier Hansson 已提交
611
      #
612
      #   url_for :controller => 'posts', :action => nil
613
      #
614
      # If you explicitly want to create a URL that's almost the same as the current URL, you can do so using the
615
      # <tt>:overwrite_params</tt> options. Say for your posts you have different views for showing and printing them.
616 617 618 619 620
      # Then, in the show view, you get the URL for the print view like this
      #
      #   url_for :overwrite_params => { :action => 'print' }
      #
      # This takes the current URL as is and only exchanges the action. In contrast, <tt>url_for :action => 'print'</tt>
621
      # would have slashed-off the path components after the changed action.
622 623
      def url_for(options = {})
        options ||= {}
624
        case options
D
David Heinemeier Hansson 已提交
625 626 627 628
          when String
            options
          when Hash
            @url.rewrite(rewrite_options(options))
629
          else
630
            polymorphic_url(options)
D
Initial  
David Heinemeier Hansson 已提交
631 632 633 634 635 636 637 638 639 640 641 642
        end
      end

      # Converts the class name from something like "OneModule::TwoModule::NeatController" to "NeatController".
      def controller_class_name
        self.class.controller_class_name
      end

      # Converts the class name from something like "OneModule::TwoModule::NeatController" to "neat".
      def controller_name
        self.class.controller_name
      end
643

644 645 646 647
      # Converts the class name from something like "OneModule::TwoModule::NeatController" to "one_module/two_module/neat".
      def controller_path
        self.class.controller_path
      end
648

649
      def session_enabled?
650
        request.session_options && request.session_options[:disabled] != false
651
      end
652

653
      self.view_paths = []
654

655 656
      # View load paths for controller.
      def view_paths
657
        @template.view_paths
658
      end
659

660
      def view_paths=(value)
661
        @template.view_paths = ActionView::Base.process_view_paths(value)
662
      end
663 664 665 666 667 668 669 670

      # Adds a view_path to the front of the view_paths array.
      # This change affects the current request only.
      #
      #   self.prepend_view_path("views/default")
      #   self.prepend_view_path(["views/default", "views/custom"])
      #
      def prepend_view_path(path)
671
        @template.view_paths.unshift(*path)
672
      end
673

674 675 676 677 678 679 680
      # Adds a view_path to the end of the view_paths array.
      # This change affects the current request only.
      #
      #   self.append_view_path("views/default")
      #   self.append_view_path(["views/default", "views/custom"])
      #
      def append_view_path(path)
681
        @template.view_paths.push(*path)
682 683
      end

D
Initial  
David Heinemeier Hansson 已提交
684
    protected
685
      # Renders the content that will be returned to the browser as the response body.
686 687
      #
      # === Rendering an action
688
      #
689 690 691 692 693 694 695 696 697 698 699 700
      # Action rendering is the most common form and the type used automatically by Action Controller when nothing else is
      # specified. By default, actions are rendered within the current layout (if one exists).
      #
      #   # Renders the template for the action "goal" within the current controller
      #   render :action => "goal"
      #
      #   # Renders the template for the action "short_goal" within the current controller,
      #   # but without the current active layout
      #   render :action => "short_goal", :layout => false
      #
      #   # Renders the template for the action "long_goal" within the current controller,
      #   # but with a custom layout
701
      #   render :action => "long_goal", :layout => "spectacular"
702 703
      #
      # === Rendering partials
704 705
      #
      # Partial rendering in a controller is most commonly used together with Ajax calls that only update one or a few elements on a page
706 707 708 709
      # without reloading. Rendering of partials from the controller makes it possible to use the same partial template in
      # both the full-page rendering (by calling it from within the template) and when sub-page updates happen (from the
      # controller action responding to Ajax calls). By default, the current layout is not used.
      #
710 711
      #   # Renders the same partial with a local variable.
      #   render :partial => "person", :locals => { :name => "david" }
712
      #
D
David Heinemeier Hansson 已提交
713 714 715 716
      #   # Renders the partial, making @new_person available through
      #   # the local variable 'person'
      #   render :partial => "person", :object => @new_person
      #
717 718 719 720
      #   # Renders a collection of the same partial by making each element
      #   # of @winners available through the local variable "person" as it
      #   # builds the complete response.
      #   render :partial => "person", :collection => @winners
721
      #
722 723 724
      #   # Renders a collection of partials but with a custom local variable name
      #   render :partial => "admin_person", :collection => @winners, :as => :person
      #
725 726 727
      #   # Renders the same collection of partials, but also renders the
      #   # person_divider partial between each person partial.
      #   render :partial => "person", :collection => @winners, :spacer_template => "person_divider"
728
      #
729 730 731 732 733
      #   # Renders a collection of partials located in a view subfolder
      #   # outside of our current controller.  In this example we will be
      #   # rendering app/views/shared/_note.r(html|xml)  Inside the partial
      #   # each element of @new_notes is available as the local var "note".
      #   render :partial => "shared/note", :collection => @new_notes
734
      #
735 736
      #   # Renders the partial with a status code of 500 (internal error).
      #   render :partial => "broken", :status => 500
737
      #
738 739 740
      # Note that the partial filename must also be a valid Ruby variable name,
      # so e.g. 2005 and register-user are invalid.
      #
741
      #
742 743 744 745
      # == Automatic etagging
      #
      # Rendering will automatically insert the etag header on 200 OK responses. The etag is calculated using MD5 of the
      # response body. If a request comes in that has a matching etag, the response will be changed to a 304 Not Modified
746
      # and the response body will be set to an empty string. No etag header will be inserted if it's already set.
747
      #
748
      # === Rendering a template
749 750
      #
      # Template rendering works just like action rendering except that it takes a path relative to the template root.
751
      # The current layout is automatically applied.
752
      #
753
      #   # Renders the template located in [TEMPLATE_ROOT]/weblog/show.r(html|xml) (in Rails, app/views/weblog/show.erb)
754 755
      #   render :template => "weblog/show"
      #
756 757 758
      #   # Renders the template with a local variable
      #   render :template => "weblog/show", :locals => {:customer => Customer.new}
      #
759
      # === Rendering a file
760
      #
761 762
      # File rendering works just like action rendering except that it takes a filesystem path. By default, the path
      # is assumed to be absolute, and the current layout is not applied.
763
      #
764
      #   # Renders the template located at the absolute filesystem path
765 766
      #   render :file => "/path/to/some/template.erb"
      #   render :file => "c:/path/to/some/template.erb"
767
      #
768
      #   # Renders a template within the current layout, and with a 404 status code
769 770
      #   render :file => "/path/to/some/template.erb", :layout => true, :status => 404
      #   render :file => "c:/path/to/some/template.erb", :layout => true, :status => 404
771
      #
772
      # === Rendering text
773
      #
774 775 776 777 778 779 780
      # Rendering of text is usually used for tests or for rendering prepared content, such as a cache. By default, text
      # rendering is not done within the active layout.
      #
      #   # Renders the clear text "hello world" with status code 200
      #   render :text => "hello world!"
      #
      #   # Renders the clear text "Explosion!"  with status code 500
781
      #   render :text => "Explosion!", :status => 500
782 783
      #
      #   # Renders the clear text "Hi there!" within the current active layout (if one exists)
784
      #   render :text => "Hi there!", :layout => true
785
      #
786
      #   # Renders the clear text "Hi there!" within the layout
787
      #   # placed in "app/views/layouts/special.r(html|xml)"
788
      #   render :text => "Hi there!", :layout => "special"
789
      #
790
      # The <tt>:text</tt> option can also accept a Proc object, which can be used to manually control the page generation. This should
791 792 793 794 795 796
      # generally be avoided, as it violates the separation between code and content, and because almost everything that can be
      # done with this method can also be done more cleanly using one of the other rendering methods, most notably templates.
      #
      #   # Renders "Hello from code!"
      #   render :text => proc { |response, output| output.write("Hello from code!") }
      #
797 798 799 800 801 802 803 804 805 806 807 808 809
      # === Rendering XML
      #
      # Rendering XML sets the content type to application/xml.
      #
      #   # Renders '<name>David</name>'
      #   render :xml => {:name => "David"}.to_xml
      #
      # It's not necessary to call <tt>to_xml</tt> on the object you want to render, since <tt>render</tt> will
      # automatically do that for you:
      #
      #   # Also renders '<name>David</name>'
      #   render :xml => {:name => "David"}
      #
810 811
      # === Rendering JSON
      #
812 813
      # Rendering JSON sets the content type to application/json and optionally wraps the JSON in a callback. It is expected
      # that the response will be parsed (or eval'd) for use as a data structure.
814
      #
815
      #   # Renders '{"name": "David"}'
816 817
      #   render :json => {:name => "David"}.to_json
      #
818 819 820 821 822 823
      # It's not necessary to call <tt>to_json</tt> on the object you want to render, since <tt>render</tt> will
      # automatically do that for you:
      #
      #   # Also renders '{"name": "David"}'
      #   render :json => {:name => "David"}
      #
824
      # Sometimes the result isn't handled directly by a script (such as when the request comes from a SCRIPT tag),
825
      # so the <tt>:callback</tt> option is provided for these cases.
826
      #
827
      #   # Renders 'show({"name": "David"})'
828 829
      #   render :json => {:name => "David"}.to_json, :callback => 'show'
      #
830 831 832 833 834 835 836
      # === Rendering an inline template
      #
      # Rendering of an inline template works as a cross between text and action rendering where the source for the template
      # is supplied inline, like text, but its interpreted with ERb or Builder, like action. By default, ERb is used for rendering
      # and the current layout is not used.
      #
      #   # Renders "hello, hello, hello, again"
837
      #   render :inline => "<%= 'hello, ' * 3 + 'again' %>"
838 839
      #
      #   # Renders "<p>Good seeing you!</p>" using Builder
840
      #   render :inline => "xml.p { 'Good seeing you!' }", :type => :builder
841 842 843 844
      #
      #   # Renders "hello david"
      #   render :inline => "<%= 'hello ' + name %>", :locals => { :name => "david" }
      #
845 846 847 848 849 850 851 852 853 854
      # === Rendering inline JavaScriptGenerator page updates
      #
      # In addition to rendering JavaScriptGenerator page updates with Ajax in RJS templates (see ActionView::Base for details),
      # you can also pass the <tt>:update</tt> parameter to +render+, along with a block, to render page updates inline.
      #
      #   render :update do |page|
      #     page.replace_html  'user_list', :partial => 'user', :collection => @users
      #     page.visual_effect :highlight, 'user_list'
      #   end
      #
855 856 857 858 859 860
      # === Rendering vanilla JavaScript
      #
      # In addition to using RJS with render :update, you can also just render vanilla JavaScript with :js.
      #
      #   # Renders "alert('hello')" and sets the mime type to text/javascript
      #   render :js => "alert('hello')"
861
      #
862
      # === Rendering with status and location headers
863
      # All renders take the <tt>:status</tt> and <tt>:location</tt> options and turn them into headers. They can even be used together:
864
      #
865
      #   render :xml => post.to_xml, :status => :created, :location => post_url(post)
866
      def render(options = nil, extra_options = {}, &block) #:doc:
867
        raise DoubleRenderError, "Can only render or redirect once per action" if performed?
868

869
        validate_render_arguments(options, extra_options, block_given?)
870

871
        if options.nil?
872
          options = { :template => default_template, :layout => true }
873 874
        elsif options == :update
          options = extra_options.merge({ :update => true })
875 876
        elsif options.is_a?(String) || options.is_a?(Symbol)
          case options.to_s.index('/')
877 878
          when 0
            extra_options[:file] = options
879 880
          when nil
            extra_options[:action] = options
881 882
          else
            extra_options[:template] = options
883 884 885
          end

          options = extra_options
886
        end
887

888 889 890
        layout = pick_layout(options)
        response.layout = layout.path_without_format_and_extension if layout
        logger.info("Rendering template within #{layout.path_without_format_and_extension}") if logger && layout
891

892
        if content_type = options[:content_type]
893
          response.content_type = content_type.to_s
894 895
        end

896
        if location = options[:location]
897
          response.headers["Location"] = url_for(location)
898 899
        end

900
        if options.has_key?(:text)
901 902
          text = layout ? @template.render(options.merge(:text => options[:text], :layout => layout)) : options[:text]
          render_for_text(text, options[:status])
903 904

        else
905
          if file = options[:file]
906
            render_for_file(file, options[:status], layout, options[:locals] || {})
907 908

          elsif template = options[:template]
909
            render_for_file(template, options[:status], layout, options[:locals] || {})
910

911
          elsif inline = options[:inline]
912
            render_for_text(@template.render(options.merge(:layout => layout)), options[:status])
913

914
          elsif action_name = options[:action]
915
            render_for_file(default_template(action_name.to_s), options[:status], layout)
916 917

          elsif xml = options[:xml]
918
            response.content_type ||= Mime::XML
919
            render_for_text(xml.respond_to?(:to_xml) ? xml.to_xml : xml, options[:status])
920

921 922 923 924
          elsif js = options[:js]
            response.content_type ||= Mime::JS
            render_for_text(js, options[:status])

925
          elsif json = options[:json]
926
            json = json.to_json unless json.is_a?(String)
927
            json = "#{options[:callback]}(#{json})" unless options[:callback].blank?
928
            response.content_type ||= Mime::JSON
929
            render_for_text(json, options[:status])
930

R
Ryan Bates 已提交
931 932
          elsif options[:partial]
            options[:partial] = default_template_name if options[:partial] == true
933 934 935 936 937
            if layout
              render_for_text(@template.render(:text => @template.render(options), :layout => layout), options[:status])
            else
              render_for_text(@template.render(options), options[:status])
            end
938

939
          elsif options[:update]
940
            @template.send(:_evaluate_assigns_and_ivars)
941

942
            generator = ActionView::Helpers::PrototypeHelper::JavaScriptGenerator.new(@template, &block)
943
            response.content_type = Mime::JS
944
            render_for_text(generator.to_s, options[:status])
945

946
          elsif options[:nothing]
947
            render_for_text(nil, options[:status])
948

949
          else
950
            render_for_file(default_template, options[:status], layout)
951
          end
952 953
        end
      end
D
Initial  
David Heinemeier Hansson 已提交
954

955 956
      # Renders according to the same rules as <tt>render</tt>, but returns the result in a string instead
      # of sending it as the response body to the browser.
957
      def render_to_string(options = nil, &block) #:doc:
958
        render(options, &block)
959
      ensure
960
        response.content_type = nil
961
        erase_render_results
962
        reset_variables_added_to_assigns
963
      end
964

965 966 967 968 969
      # Return a response that has no content (merely headers). The options
      # argument is interpreted to be a hash of header names and values.
      # This allows you to easily return a response that consists only of
      # significant headers:
      #
970
      #   head :created, :location => person_path(@person)
971 972 973
      #
      # It can also be used to return exceptional conditions:
      #
974 975
      #   return head(:method_not_allowed) unless request.post?
      #   return head(:bad_request) unless valid_request?
976
      #   render
977 978 979 980 981 982
      def head(*args)
        if args.length > 2
          raise ArgumentError, "too many arguments to head"
        elsif args.empty?
          raise ArgumentError, "too few arguments to head"
        end
983 984
        options = args.extract_options!
        status = interpret_status(args.shift || options.delete(:status) || :ok)
985 986 987 988 989 990 991 992

        options.each do |key, value|
          headers[key.to_s.dasherize.split(/-/).map { |v| v.capitalize }.join("-")] = value.to_s
        end

        render :nothing => true, :status => status
      end

993
      # Clears the rendered results, allowing for another render to be performed.
D
David Heinemeier Hansson 已提交
994
      def erase_render_results #:nodoc:
995
        response.body = nil
996 997
        @performed_render = false
      end
998 999

      # Clears the redirected results from the headers, resets the status to 200 and returns
1000 1001 1002
      # the URL that was used to redirect or nil if there was no redirected URL
      # Note that +redirect_to+ will change the body of the response to indicate a redirection.
      # The response body is not reset here, see +erase_render_results+
D
David Heinemeier Hansson 已提交
1003
      def erase_redirect_results #:nodoc:
1004 1005 1006
        @performed_redirect = false
        response.redirected_to = nil
        response.redirected_to_method_params = nil
1007
        response.status = DEFAULT_RENDER_STATUS_CODE
1008
        response.headers.delete('Location')
1009 1010
      end

1011
      # Erase both render and redirect results
D
David Heinemeier Hansson 已提交
1012
      def erase_results #:nodoc:
1013 1014 1015
        erase_render_results
        erase_redirect_results
      end
1016

D
David Heinemeier Hansson 已提交
1017
      def rewrite_options(options) #:nodoc:
D
Initial  
David Heinemeier Hansson 已提交
1018 1019 1020 1021 1022 1023
        if defaults = default_url_options(options)
          defaults.merge(options)
        else
          options
        end
      end
1024

D
Initial  
David Heinemeier Hansson 已提交
1025 1026 1027 1028
      # Overwrite to implement a number of default options that all url_for-based methods will use. The default options should come in
      # the form of a hash, just like the one you would use for url_for directly. Example:
      #
      #   def default_url_options(options)
1029
      #     { :project => @project.active? ? @project.url_name : "unknown" }
D
Initial  
David Heinemeier Hansson 已提交
1030 1031 1032 1033 1034
      #   end
      #
      # As you can infer from the example, this is mostly useful for situations where you want to centralize dynamic decisions about the
      # urls as they stem from the business domain. Please note that any individual url_for call can always override the defaults set
      # by this method.
1035
      def default_url_options(options = nil)
D
Initial  
David Heinemeier Hansson 已提交
1036
      end
1037

1038 1039
      # Redirects the browser to the target specified in +options+. This parameter can take one of three forms:
      #
1040 1041
      # * <tt>Hash</tt> - The URL will be generated by calling url_for with the +options+.
      # * <tt>Record</tt> - The URL will be generated by calling url_for with the +options+, which will reference a named URL for that record.
P
Pratik Naik 已提交
1042 1043
      # * <tt>String</tt> starting with <tt>protocol://</tt> (like <tt>http://</tt>) - Is passed straight through as the target for redirection.
      # * <tt>String</tt> not containing a protocol - The current protocol and host is prepended to the string.
1044
      # * <tt>:back</tt> - Back to the page that issued the request. Useful for forms that are triggered from multiple places.
P
Pratik Naik 已提交
1045
      #   Short-hand for <tt>redirect_to(request.env["HTTP_REFERER"])</tt>
1046
      #
1047 1048
      # Examples:
      #   redirect_to :action => "show", :id => 5
1049
      #   redirect_to post
1050 1051
      #   redirect_to "http://www.rubyonrails.org"
      #   redirect_to "/images/screenshot.jpg"
1052
      #   redirect_to articles_url
1053
      #   redirect_to :back
1054
      #
1055
      # The redirection happens as a "302 Moved" header unless otherwise specified.
1056 1057 1058 1059 1060 1061
      #
      # Examples:
      #   redirect_to post_url(@post), :status=>:found
      #   redirect_to :action=>'atom', :status=>:moved_permanently
      #   redirect_to post_url(@post), :status=>301
      #   redirect_to :action=>'atom', :status=>302
1062 1063 1064
      #
      # When using <tt>redirect_to :back</tt>, if there is no referrer,
      # RedirectBackError will be raised. You may specify some fallback
1065
      # behavior for this case by rescuing RedirectBackError.
1066
      def redirect_to(options = {}, response_status = {}) #:doc:
1067 1068
        raise ActionControllerError.new("Cannot redirect to nil!") if options.nil?

1069 1070 1071 1072 1073 1074
        if options.is_a?(Hash) && options[:status]
          status = options.delete(:status)
        elsif response_status[:status]
          status = response_status[:status]
        else
          status = 302
1075
        end
1076

1077
        response.redirected_to = options
1078 1079
        logger.info("Redirected to #{options}") if logger && logger.info?

1080
        case options
1081 1082 1083 1084
          # The scheme name consist of a letter followed by any combination of
          # letters, digits, and the plus ("+"), period ("."), or hyphen ("-")
          # characters; and is terminated by a colon (":").
          when %r{^\w[\w\d+.-]*:.*}
1085
            redirect_to_full_url(options, status)
1086
          when String
1087
            redirect_to_full_url(request.protocol + request.host_with_port + options, status)
1088
          when :back
1089 1090 1091 1092 1093
            if referer = request.headers["Referer"]
              redirect_to(referer, :status=>status)
            else
              raise RedirectBackError
            end
1094
          else
1095
            redirect_to_full_url(url_for(options), status)
D
Initial  
David Heinemeier Hansson 已提交
1096 1097
        end
      end
1098

1099 1100 1101 1102 1103 1104
      def redirect_to_full_url(url, status)
        raise DoubleRenderError if performed?
        response.redirect(url, interpret_status(status))
        @performed_redirect = true
      end

1105 1106 1107
      # Sets the etag and/or last_modified on the response and checks it against
      # the client request. If the request doesn't match the options provided, the
      # request is considered stale and should be generated from scratch. Otherwise,
1108
      # it's fresh and we don't need to generate anything and a reply of "304 Not Modified" is sent.
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
      #
      # Example:
      #
      #   def show
      #     @article = Article.find(params[:id])
      #
      #     if stale?(:etag => @article, :last_modified => @article.created_at.utc)
      #       @statistics = @article.really_expensive_call
      #       respond_to do |format|
      #         # all the supported formats
      #       end
      #     end
      #   end
      def stale?(options)
        fresh_when(options)
        !request.fresh?(response)
      end

1127
      # Sets the etag, last_modified, or both on the response and renders a
1128
      # "304 Not Modified" response if the request is already fresh.
1129 1130 1131 1132 1133 1134 1135
      #
      # Example:
      #
      #   def show
      #     @article = Article.find(params[:id])
      #     fresh_when(:etag => @article, :last_modified => @article.created_at.utc)
      #   end
1136 1137
      #
      # This will render the show template if the request isn't sending a matching etag or
1138 1139 1140 1141 1142 1143
      # If-Modified-Since header and just a "304 Not Modified" response if there's a match.
      def fresh_when(options)
        options.assert_valid_keys(:etag, :last_modified)

        response.etag          = options[:etag]          if options[:etag]
        response.last_modified = options[:last_modified] if options[:last_modified]
1144 1145 1146 1147

        if request.fresh?(response)
          head :not_modified
        end
1148 1149
      end

1150 1151 1152 1153 1154 1155 1156
      # Sets a HTTP 1.1 Cache-Control header. Defaults to issuing a "private" instruction, so that
      # intermediate caches shouldn't cache the response.
      #
      # Examples:
      #   expires_in 20.minutes
      #   expires_in 3.hours, :private => false
      #   expires in 3.hours, 'max-stale' => 5.hours, :private => nil, :public => true
1157
      #
1158 1159
      # This method will overwrite an existing Cache-Control header.
      # See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html for more possibilities.
1160
      def expires_in(seconds, options = {}) #:doc:
1161 1162 1163
        cache_options = { 'max-age' => seconds, 'private' => true }.symbolize_keys.merge!(options.symbolize_keys)
        cache_options.delete_if { |k,v| v.nil? or v == false }
        cache_control = cache_options.map{ |k,v| v == true ? k.to_s : "#{k.to_s}=#{v.to_s}"}
1164
        response.headers["Cache-Control"] = cache_control.join(', ')
1165
      end
1166

1167 1168
      # Sets a HTTP 1.1 Cache-Control header of "no-cache" so no caching should occur by the browser or
      # intermediate caches (like caching proxy servers).
1169
      def expires_now #:doc:
1170
        response.headers["Cache-Control"] = "no-cache"
1171
      end
D
Initial  
David Heinemeier Hansson 已提交
1172

1173
      # Resets the session by clearing out all the objects stored within and initializing a new session object.
D
Initial  
David Heinemeier Hansson 已提交
1174
      def reset_session #:doc:
1175 1176
        request.reset_session
        @_session = request.session
D
Initial  
David Heinemeier Hansson 已提交
1177
      end
1178

1179
    private
1180
      def render_for_file(template_path, status = nil, layout = nil, locals = {}) #:nodoc:
1181 1182
        path = template_path.respond_to?(:path_without_format_and_extension) ? template_path.path_without_format_and_extension : template_path
        logger.info("Rendering #{path}" + (status ? " (#{status})" : '')) if logger
1183
        render_for_text @template.render(:file => template_path, :locals => locals, :layout => layout), status
1184 1185 1186 1187 1188
      end

      def render_for_text(text = nil, status = nil, append_response = false) #:nodoc:
        @performed_render = true

1189
        response.status = interpret_status(status || DEFAULT_RENDER_STATUS_CODE)
1190 1191 1192 1193 1194

        if append_response
          response.body ||= ''
          response.body << text.to_s
        else
1195 1196 1197 1198 1199
          response.body = case text
            when Proc then text
            when nil  then " " # Safari doesn't pass the headers of the return if the response is zero length
            else           text.to_s
          end
1200 1201
        end
      end
1202

1203 1204
      def validate_render_arguments(options, extra_options, has_block)
        if options && (has_block && options != :update) && !options.is_a?(String) && !options.is_a?(Hash) && !options.is_a?(Symbol)
1205 1206 1207 1208 1209 1210 1211 1212
          raise RenderError, "You called render with invalid options : #{options.inspect}"
        end

        if !extra_options.is_a?(Hash)
          raise RenderError, "You called render with invalid options : #{options.inspect}, #{extra_options.inspect}"
        end
      end

1213
      def initialize_template_class(response)
1214
        response.template = ActionView::Base.new(self.class.view_paths, {}, self)
1215
        response.template.helpers.send :include, self.class.master_helper_module
1216
        response.redirected_to = nil
D
Initial  
David Heinemeier Hansson 已提交
1217 1218
        @performed_render = @performed_redirect = false
      end
1219

D
Initial  
David Heinemeier Hansson 已提交
1220
      def assign_shortcuts(request, response)
1221
        @_request, @_params = request, request.parameters
D
Initial  
David Heinemeier Hansson 已提交
1222

J
Jeremy Kemper 已提交
1223 1224
        @_response         = response
        @_response.session = request.session
D
Initial  
David Heinemeier Hansson 已提交
1225

J
Jeremy Kemper 已提交
1226 1227
        @_session = @_response.session
        @template = @_response.template
1228

J
Jeremy Kemper 已提交
1229
        @_headers = @_response.headers
1230 1231
      end

D
Initial  
David Heinemeier Hansson 已提交
1232
      def initialize_current_url
1233
        @url = UrlRewriter.new(request, params.clone)
D
Initial  
David Heinemeier Hansson 已提交
1234 1235 1236
      end

      def log_processing
1237
        if logger && logger.info?
1238 1239 1240 1241
          log_processing_for_request_id
          log_processing_for_parameters
        end
      end
1242

1243 1244 1245 1246
      def log_processing_for_request_id
        request_id = "\n\nProcessing #{self.class.name}\##{action_name} "
        request_id << "to #{params[:format]} " if params[:format]
        request_id << "(for #{request_origin}) [#{request.method.to_s.upcase}]"
1247

1248 1249
        logger.info(request_id)
      end
1250

1251
      def log_processing_for_parameters
1252
        parameters = respond_to?(:filter_parameters) ? filter_parameters(params) : params.dup
1253
        parameters = parameters.except!(:controller, :action, :format, :_method)
1254

1255
        logger.info "  Parameters: #{parameters.inspect}" unless parameters.empty?
1256 1257
      end

1258
      def default_render #:nodoc:
1259
        render
1260 1261
      end

D
Initial  
David Heinemeier Hansson 已提交
1262
      def perform_action
1263
        if action_methods.include?(action_name)
D
Initial  
David Heinemeier Hansson 已提交
1264
          send(action_name)
1265
          default_render unless performed?
1266
        elsif respond_to? :method_missing
1267
          method_missing action_name
1268
          default_render unless performed?
D
Initial  
David Heinemeier Hansson 已提交
1269
        else
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279
          begin
            default_render
          rescue ActionView::MissingTemplate => e
            # Was the implicit template missing, or was it another template?
            if e.path == default_template_name
              raise UnknownAction, "No action responded to #{action_name}. Actions: #{action_methods.sort.to_sentence}", caller
            else
              raise e
            end
          end
D
Initial  
David Heinemeier Hansson 已提交
1280 1281
        end
      end
1282

1283 1284 1285
      def performed?
        @performed_render || @performed_redirect
      end
D
Initial  
David Heinemeier Hansson 已提交
1286

1287 1288 1289
      def assign_names
        @action_name = (params['action'] || 'index')
      end
1290

D
Initial  
David Heinemeier Hansson 已提交
1291
      def action_methods
1292
        self.class.action_methods
D
Initial  
David Heinemeier Hansson 已提交
1293
      end
1294

1295
      def self.action_methods
1296 1297 1298 1299 1300 1301 1302 1303 1304
        @action_methods ||=
          # All public instance methods of this class, including ancestors
          public_instance_methods(true).map { |m| m.to_s }.to_set -
          # Except for public instance methods of Base and its ancestors
          Base.public_instance_methods(true).map { |m| m.to_s } +
          # Be sure to include shadowed public instance methods of this class
          public_instance_methods(false).map { |m| m.to_s } -
          # And always exclude explicitly hidden actions
          hidden_actions
1305
      end
1306

1307 1308 1309
      def reset_variables_added_to_assigns
        @template.instance_variable_set("@assigns_added", nil)
      end
D
Initial  
David Heinemeier Hansson 已提交
1310 1311

      def request_origin
1312 1313
        # this *needs* to be cached!
        # otherwise you'd get different results if calling it more than once
1314
        @request_origin ||= "#{request.remote_ip} at #{Time.now.to_s(:db)}"
D
Initial  
David Heinemeier Hansson 已提交
1315
      end
1316

1317
      def complete_request_uri
1318
        "#{request.protocol}#{request.host}#{request.request_uri}"
1319 1320
      end

D
Initial  
David Heinemeier Hansson 已提交
1321
      def close_session
1322
        @_session.close if @_session && @_session.respond_to?(:close)
D
Initial  
David Heinemeier Hansson 已提交
1323
      end
1324

1325 1326
      def default_template(action_name = self.action_name)
        self.view_paths.find_template(default_template_name(action_name), default_template_format)
1327 1328
      end

1329 1330 1331 1332 1333 1334
      def default_template_name(action_name = self.action_name)
        if action_name
          action_name = action_name.to_s
          if action_name.include?('/') && template_path_includes_controller?(action_name)
            action_name = strip_out_controller(action_name)
          end
1335
        end
1336
        "#{self.controller_path}/#{action_name}"
D
Initial  
David Heinemeier Hansson 已提交
1337
      end
1338

1339 1340
      def strip_out_controller(path)
        path.split('/', 2).last
1341
      end
1342

1343
      def template_path_includes_controller?(path)
1344
        self.controller_path.split('/')[-1] == path.split('/')[0]
1345
      end
1346 1347 1348 1349

      def process_cleanup
        close_session
      end
D
Initial  
David Heinemeier Hansson 已提交
1350
  end
1351 1352

  Base.class_eval do
1353 1354 1355 1356 1357 1358 1359
    [ Flash, Filters, Layout, Benchmarking, Rescue, MimeResponds, Helpers,
      Cookies, Caching, Verification, Streaming, SessionManagement,
      HttpAuthentication::Basic::ControllerMethods, RecordIdentifier,
      RequestForgeryProtection, Translation
    ].each do |mod|
      include mod
    end
1360
  end
J
Jeremy Kemper 已提交
1361
end