base.rb 40.9 KB
Newer Older
D
Initial  
David Heinemeier Hansson 已提交
1 2
require 'action_controller/request'
require 'action_controller/response'
3
require 'action_controller/routing'
4
require 'action_controller/code_generation'
D
Initial  
David Heinemeier Hansson 已提交
5
require 'action_controller/url_rewriter'
6
require 'drb'
D
Initial  
David Heinemeier Hansson 已提交
7 8 9 10 11 12 13 14

module ActionController #:nodoc:
  class ActionControllerError < StandardError #:nodoc:
  end
  class SessionRestoreError < ActionControllerError #:nodoc:
  end
  class MissingTemplate < ActionControllerError #:nodoc:
  end
15
  class RoutingError < ActionControllerError #:nodoc:
16 17 18 19 20 21 22 23
    attr_reader :failures
    def initialize(message, failures=[])
      super(message)
      @failures = failures
    end
  end
  class UnknownController < ActionControllerError #:nodoc:
  end
D
Initial  
David Heinemeier Hansson 已提交
24 25
  class UnknownAction < ActionControllerError #:nodoc:
  end
26 27
  class MissingFile < ActionControllerError #:nodoc:
  end
28
  class DoubleRenderError < ActionControllerError #:nodoc:
29 30 31 32 33
    DEFAULT_MESSAGE = "Render and/or redirect were called multiple times in this action. Please note that you may only call render OR redirect, and only 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\". Finally, note that to cause a before filter to halt execution of the rest of the filter chain, the filter must return false, explicitly, so \"render(...) and return false\"." 

    def initialize(message=nil)
      super(message || DEFAULT_MESSAGE)
    end
34
  end
D
Initial  
David Heinemeier Hansson 已提交
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67

  # Action Controllers are made up of one or more actions that performs its purpose and then either renders a template or
  # redirects to another action. An action is defined as a public method on the controller, which will automatically be 
  # made accessible to the web-server through a mod_rewrite mapping. A sample controller could look like this:
  #
  #   class GuestBookController < ActionController::Base
  #     def index
  #       @entries = Entry.find_all
  #     end
  #     
  #     def sign
  #       Entry.create(@params["entry"])
  #       redirect_to :action => "index"
  #     end
  #   end
  #
  #   GuestBookController.template_root = "templates/"
  #   GuestBookController.process_cgi
  #
  # All actions assume that you want to render a template matching the name of the action at the end of the performance
  # unless you tell it otherwise. The index action complies with this assumption, so after populating the @entries instance
  # variable, the GuestBookController will render "templates/guestbook/index.rhtml".
  #
  # Unlike index, the sign action isn't interested in rendering a template. So after performing its main purpose (creating a 
  # new entry in the guest book), it sheds the rendering assumption and initiates a redirect instead. This redirect works by
  # returning an external "302 Moved" HTTP response that takes the user to the index action.
  #
  # 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.
  #
  # Also note that it's the final call to <tt>process_cgi</tt> that actually initiates the action performance. It will extract
  # request and response objects from the CGI
  #
68 69 70
  # When Action Pack is used inside of Rails, the template_root is automatically configured and you don't need to call process_cgi
  # yourself.
  #
D
Initial  
David Heinemeier Hansson 已提交
71 72 73 74 75 76 77
  # == 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
  # request parameters, the session (if one is available), and the full request with all the http headers are made available to
  # the action through instance variables. Then the action is performed.
  #
78 79
  # The full request object is available with the request accessor and is primarily used to query for http headers. These queries
  # are made by accessing the environment hash, like this:
D
Initial  
David Heinemeier Hansson 已提交
80 81
  #
  #   def hello_ip
82
  #     location = request.env["REMOTE_IP"]
D
Initial  
David Heinemeier Hansson 已提交
83 84 85 86 87
  #     render_text "Hello stranger from #{location}"
  #   end
  #
  # == Parameters
  #
88
  # All request parameters whether they come from a GET or POST request, or from the URL, are available through the params hash.
D
Initial  
David Heinemeier Hansson 已提交
89
  # So an action that was performed through /weblog/list?category=All&limit=5 will include { "category" => "All", "limit" => 5 }
90
  # in params.
D
Initial  
David Heinemeier Hansson 已提交
91 92 93 94 95 96
  #
  # 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 已提交
97
  # A request stemming from a form holding these inputs will include <tt>{ "post" => { "name" => "david", "address" => "hyacintvej" } }</tt>.
98
  # If the address input had been named "post[address][street]", the params would have included 
D
David Heinemeier Hansson 已提交
99
  # <tt>{ "post" => { "address" => { "street" => "hyacintvej" } } }</tt>. There's no limit to the depth of the nesting.
D
Initial  
David Heinemeier Hansson 已提交
100 101 102 103 104 105 106 107
  #
  # == Sessions
  #
  # Sessions allows you to store objects in memory between requests. This is useful for objects that are not yet ready to be persisted,
  # 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
  # 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 
  # they could be changed unknowingly. It's usually too much work to keep it all synchronized -- something databases already excel at.
  #
108
  # You can place objects in the session by using the <tt>session</tt> hash accessor:
D
Initial  
David Heinemeier Hansson 已提交
109
  #
110
  #   session[:person] = Person.authenticate(user_name, password)
D
Initial  
David Heinemeier Hansson 已提交
111 112 113
  #
  # And retrieved again through the same hash:
  #
114
  #   Hello #{session[:person]}
D
Initial  
David Heinemeier Hansson 已提交
115 116 117 118 119
  #
  # Any object can be placed in the session (as long as it can be Marshalled). But remember that 1000 active sessions each storing a
  # 50kb object could lead to a 50MB memory overhead. In other words, think carefully about size and caching before resorting to the use
  # of the session.
  #
120 121 122
  # For removing objects from the session, you can either assign a single key to nil, like <tt>@session[:person] = nil</tt>, or you can
  # remove the entire session with reset_session.
  #
D
Initial  
David Heinemeier Hansson 已提交
123 124 125 126 127 128 129 130 131 132 133 134
  # == Responses
  #
  # Each action results in a response, which holds the headers and document to be sent to the user's browser. The actual response
  # object is generated automatically through the use of renders and redirects, so it's normally nothing you'll need to be concerned about.
  #
  # == 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
135
  #     @post = Post.find(params[:id])
D
Initial  
David Heinemeier Hansson 已提交
136 137 138 139 140 141 142 143 144 145
  #   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
146
  #     @results = Search.find(params[:query])
D
Initial  
David Heinemeier Hansson 已提交
147
  #     case @results
148 149 150
  #       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 已提交
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
  #     end
  #   end
  #
  # Read more about writing ERb and Builder templates in link:classes/ActionView/Base.html.
  #
  # == Redirects
  #
  # Redirecting is what actions that update the model do when they're done. The <tt>save_post</tt> method shouldn't be responsible for also
  # showing the post once it's saved -- that's the job for <tt>show_post</tt>. So once <tt>save_post</tt> has completed its business, it'll
  # redirect to <tt>show_post</tt>. All redirects are external, which means that when the user refreshes his browser, it's not going to save
  # the post again, but rather just show it one more time.
  # 
  # This sounds fairly simple, but the redirection is complicated by the quest for a phenomenon known as "pretty urls". Instead of accepting
  # the dreadful beings that is "weblog_controller?action=show&post_id=5", Action Controller goes out of its way to represent the former as
  # "/weblog/show/5". And this is even the simple case. As an example of a more advanced pretty url consider
  # "/library/books/ISBN/0743536703/show", which can be mapped to books_controller?action=show&type=ISBN&id=0743536703.
  # 
  # Redirects work by rewriting the URL of the current action. So if the show action was called by "/library/books/ISBN/0743536703/show", 
  # we can redirect to an edit action simply by doing <tt>redirect_to(:action => "edit")</tt>, which could throw the user to 
D
David Heinemeier Hansson 已提交
170 171
  # "/library/books/ISBN/0743536703/edit". Naturally, you'll need to setup the routes configuration file to point to the proper controller
  # and action in the first place, but once you have, it can be rewritten with ease.
D
Initial  
David Heinemeier Hansson 已提交
172
  # 
D
David Heinemeier Hansson 已提交
173
  # Let's consider a bunch of examples on how to go from "/clients/37signals/basecamp/project/dash" to somewhere else:
D
Initial  
David Heinemeier Hansson 已提交
174
  #
D
David Heinemeier Hansson 已提交
175 176 177 178 179
  #   redirect_to(:action => "edit") =>
  #     /clients/37signals/basecamp/project/dash
  #   
  #   redirect_to(:client_name => "nextangle", :project_name => "rails") =>
  #     /clients/nextangle/rails/project/dash
D
Initial  
David Heinemeier Hansson 已提交
180
  #
D
David Heinemeier Hansson 已提交
181
  # Those redirects happen under the configuration of:
D
Initial  
David Heinemeier Hansson 已提交
182
  #
D
David Heinemeier Hansson 已提交
183
  #   map.connect 'clients/:client_name/:project_name/:controller/:action'
D
Initial  
David Heinemeier Hansson 已提交
184
  #
185 186
  # == Calling multiple redirects or renders
  #
187
  # An action should conclude by a single render or redirect. Attempting to try to do either again will result in a DoubleRenderError:
188 189 190
  #
  #   def do_something
  #     redirect_to :action => "elsewhere"
191
  #     render :action => "overthere" # raises DoubleRenderError
192 193
  #   end
  #
194
  # If you need to redirect on the condition of something, then be sure to add "and return" to halt execution.
195
  #
196 197 198 199
  #   def do_something
  #     redirect_to(:action => "elsewhere") and return if monkeys.nil?
  #     render :action => "overthere" # won't be called unless monkeys is nil
  #   end  # == Environments
D
Initial  
David Heinemeier Hansson 已提交
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
  #
  # Action Controller works out of the box with CGI, FastCGI, and mod_ruby. CGI and mod_ruby controllers are triggered just the same using:
  #
  #   WeblogController.process_cgi
  #
  # FastCGI controllers are triggered using:
  #
  #   FCGI.each_cgi{ |cgi| WeblogController.process_cgi(cgi) }
  class Base
    include ClassInheritableAttributes
  
    DEFAULT_RENDER_STATUS_CODE = "200 OK"
  
    # Determines whether the view has access to controller internals @request, @response, @session, and @template.
    # By default, it does.
    @@view_controller_internals = true
    cattr_accessor :view_controller_internals

218 219 220 221 222 223
    # 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: 
    #   ActionController::Base.asset_host = "http://assets.example.com"
    @@asset_host = ""
    cattr_accessor :asset_host

D
Initial  
David Heinemeier Hansson 已提交
224 225 226 227 228
    # 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
229 230 231 232 233 234
    
    # Enable or disable the collection of failure information for RoutingErrors.
    # This information can be extremely useful when tweaking custom routes, but is
    # pointless once routes have been tested and verified.
    @@debug_routes = true
    cattr_accessor :debug_routes
D
Initial  
David Heinemeier Hansson 已提交
235

236 237 238 239 240 241
    # Controls whether the application is thread-safe, so multi-threaded servers like WEBrick knows whether to apply a mutex
    # around the performance of each action. Action Pack and Active Record are by default thread-safe, but many applications
    # may not be. Turned off by default.
    @@allow_concurrency = false
    cattr_accessor :allow_concurrency

D
Initial  
David Heinemeier Hansson 已提交
242 243
    # Template root determines the base from which template references will be made. So a call to render("test/template")
    # will be converted to "#{template_root}/test/template.rhtml".
244
    class_inheritable_accessor :template_root
D
Initial  
David Heinemeier Hansson 已提交
245 246 247 248 249 250 251 252 253 254 255 256

    # 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
    
    # Determines which template class should be used by ActionController.
    cattr_accessor :template_class

    # Turn on +ignore_missing_templates+ if you want to unit test actions without making the associated templates.
    cattr_accessor :ignore_missing_templates

    # Holds the request object that's primarily used to get environment variables through access like
257
    # <tt>request.env["REQUEST_URI"]</tt>.
D
Initial  
David Heinemeier Hansson 已提交
258 259 260 261 262 263 264
    attr_accessor :request
    
    # Holds a hash of all the GET, POST, and Url parameters passed to the action. Accessed like <tt>@params["post_id"]</tt>
    # to get the post_id. No type casts are made, so all values are returned as strings.
    attr_accessor :params
    
    # Holds the response object that's primarily used to set additional HTTP headers through access like 
265 266
    # <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 已提交
267 268 269
    # such as a OutputCompressionFilter.
    attr_accessor :response
    
270
    # Holds a hash of objects in the session. Accessed like <tt>session[:person]</tt> to get the object tied to the "person"
D
Initial  
David Heinemeier Hansson 已提交
271 272 273
    # key. The session will hold any type of object as values, but the key should be a string.
    attr_accessor :session
    
274
    # 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 已提交
275 276 277 278 279 280 281
    # directive. Values should always be specified as strings.
    attr_accessor :headers
    
    # Holds the hash of variables that are passed on to the template class to be made available to the view. This hash
    # is generated by taking a snapshot of all the instance variables in the current scope just before a template is rendered.
    attr_accessor :assigns

282 283 284
    # Returns the name of the action this controller is processing.
    attr_accessor :action_name

D
Initial  
David Heinemeier Hansson 已提交
285 286 287 288 289
    class << self
      # Factory for the standard create, process loop where the controller is discarded after processing.
      def process(request, response) #:nodoc:
        new.process(request, response)
      end
290
      
D
Initial  
David Heinemeier Hansson 已提交
291 292
      # Converts the class name from something like "OneModule::TwoModule::NeatController" to "NeatController".
      def controller_class_name
293
        @controller_class_name ||= name.demodulize
D
Initial  
David Heinemeier Hansson 已提交
294 295 296 297
      end

      # Converts the class name from something like "OneModule::TwoModule::NeatController" to "neat".
      def controller_name
298
        @controller_name ||= controller_class_name.sub(/Controller$/, '').underscore
D
Initial  
David Heinemeier Hansson 已提交
299
      end
300 301 302
      
      # Convert the class name from something like "OneModule::TwoModule::NeatController" to "one_module/two_module/neat".
      def controller_path
303 304 305 306 307 308 309 310
        unless @controller_path
          components = self.name.to_s.split('::')
          components[-1] = $1 if /^(.*)Controller$/ =~ components.last
          # Accomodate the root Controllers module.
          components.shift if components.first == 'Controllers'
          @controller_path = components.map { |name| name.underscore }.join('/')
        end
        @controller_path
311
      end
312 313 314 315 316 317 318 319 320 321

      # 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.
      # More methods can be hidden using +hide_actions+.
      def hidden_actions
        write_inheritable_attribute(:hidden_actions, ActionController::Base.public_instance_methods) unless read_inheritable_attribute(:hidden_actions)
        read_inheritable_attribute(:hidden_actions)
      end

      # Hide each of the given methods from being callable as actions.
322
      def hide_action(*names)
323 324
        write_inheritable_attribute(:hidden_actions, hidden_actions | names.collect {|n| n.to_s})
      end
325 326 327 328 329 330 331 332 333 334 335

      # Set the template root to be one directory behind the root dir of the controller. Examples:
      #   /code/weblog/components/admin/users_controller.rb with Admin::UsersController 
      #     will use /code/weblog/components as template root 
      #     and find templates in /code/weblog/components/admin/users/
      #
      #   /code/weblog/components/admin/parties/users_controller.rb with Admin::Parties::UsersController 
      #     will also use /code/weblog/components as template root 
      #     and find templates in /code/weblog/components/admin/parties/users/
      def uses_component_template_root
        path_of_calling_controller = File.dirname(caller[0].split(/:\d+:/).first)
336
        path_of_controller_root    = path_of_calling_controller.sub(/#{controller_path.split("/")[0..-2]}$/, "") # " (for ruby-mode)
337 338
        self.template_root = path_of_controller_root
      end
339 340 341 342 343 344

      # Temporary method for enabling upload progress until it's ready to leave experimental mode
      def enable_upload_progress # :nodoc:
        require 'action_controller/upload_progress'
        include ActionController::UploadProgress
      end
D
Initial  
David Heinemeier Hansson 已提交
345 346 347 348
    end

    public
      # Extracts the action_name from the request parameters and performs that action.
349
      def process(request, response, method = :perform_action, *arguments) #:nodoc:
D
Initial  
David Heinemeier Hansson 已提交
350 351 352
        initialize_template_class(response)
        assign_shortcuts(request, response)
        initialize_current_url
353
        @action_name = params[:action] || 'index'
D
Initial  
David Heinemeier Hansson 已提交
354 355

        log_processing unless logger.nil?
356
        send(method, *arguments)
D
Initial  
David Heinemeier Hansson 已提交
357 358 359 360 361
        close_session

        return @response
      end

362 363 364 365 366 367 368 369 370
      # Returns a URL that has been rewritten according to the options hash and the defined Routes. 
      # (For doing a complete redirect, use redirect_to).
      #  
      # <tt>url_for</tt> is used to:
      #  
      # 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, 
      #   <tt>url_for :controller => 'posts', :action => 'show', :id => 10, :anchor => 'comments'</tt> 
      #   will produce "/posts/show/10#comments".
D
David Heinemeier Hansson 已提交
371
      # * <tt>:only_path</tt> --  if true, returns the absolute URL (omitting the protocol, host name, and port)
372 373
      # * <tt>:trailing_slash</tt> --  if true, adds a trailing slash, as in "/archive/2005/". Note that this
      #   is currently not recommended since it breaks caching.
374 375
      # * <tt>:host</tt> -- overrides the default (current) host if provided
      # * <tt>:protocol</tt> -- overrides the default (current) protocol if provided
D
David Heinemeier Hansson 已提交
376
      #
377 378
      # 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 已提交
379
      #
380 381 382 383 384 385
      # 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:
      #  
      #   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 => 'show', :id => 10 # => 'proto://host.com/posts/show/10'
D
David Heinemeier Hansson 已提交
386
      #
387 388 389 390 391 392 393 394
      # 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.
      #  
      # 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 已提交
395
      #
396 397
      # * If the controller name begins with a slash, no defaults are used: <tt>url_for :controller => '/home'</tt>
      # * If the controller changes, the action will default to index unless provided
D
David Heinemeier Hansson 已提交
398
      #
399 400
      # 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 已提交
401
      #
402 403
      # Suppose that the current URL is "people/hh/david/contacts". Let's consider a few different cases URLs which are generated
      # from this page.
D
David Heinemeier Hansson 已提交
404
      #
405
      # * <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 已提交
406
      # last components, and the action shall change. The generated URL will be, "people/hh/david/bio".
407 408
      # * <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 已提交
409
      #
410 411 412 413 414 415 416 417 418 419
      # 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
      # defaults. On it's own, this rule can account for much of the typical Rails URL behavior.
      #  
      # Although a convienence, defaults can occasionaly get in your way. In some cases a default persists longer than desired.
      # 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 已提交
420
      #
421 422
      #   url_for :controller => 'posts', :action => nil
      #      
D
Initial  
David Heinemeier Hansson 已提交
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
      # Instead of passing an options hash, you can also pass a method reference in the form of a symbol. Consider this example:
      #
      #   class WeblogController < ActionController::Base
      #     def update
      #       # do some update
      #       redirect_to :dashboard_url
      #     end
      #     
      #     protected
      #       def dashboard_url
      #         url_for :controller => (@project.active? ? "project" : "account"), :action => "dashboard"
      #       end
      #   end
      def url_for(options = {}, *parameters_for_method_reference) #:doc:
        case options
          when String then options
          when Symbol then send(options, *parameters_for_method_reference)
          when Hash   then @url.rewrite(rewrite_options(options))
        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

    protected
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
      # Renders the content that'll be returned to the browser as the response body. This can just be as regular text, but is
      # more often the compilation of a template.
      #
      # === Rendering an action
      # 
      # 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
472
      #   render :action => "long_goal", :layout => "spectacular"
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
      #
      # _Deprecation_ _notice_: This used to have the signatures <tt>render_action("action", status = 200)</tt>,
      # <tt>render_without_layout("controller/action", status = 200)</tt>, and 
      # <tt>render_with_layout("controller/action", status = 200, layout)</tt>.
      #
      # === Rendering partials
      # 
      # Partial rendering is most commonly used together with Ajax calls that only updates one or a few elements on a page
      # 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.
      #
      #   # Renders the partial located at app/views/controller/_win.r(html|xml)
      #   render :partial => "win"
      #
      #   # Renders the partial with a status code of 500 (internal error)
      #   render :partial => "broken", :status => 500
      #
      #   # Renders the same partial but also makes a local variable available to it
      #   render :partial => "win", :locals => { :name => "david" }
      #
      #   # Renders a collection of the same partial by making each element of @wins available through 
      #   # the local variable "win" as it builds the complete response
      #   render :partial => "win", :collection => @wins
      #
      #   # Renders the same collection of partials, but also renders the win_divider partial in between
      #   # each win partial.
      #   render :partial => "win", :collection => @wins, :spacer_template => "win_divider"
      #
      # _Deprecation_ _notice_: This used to have the signatures 
      # <tt>render_partial(partial_path = default_template_name, object = nil, local_assigns = {})</tt> and
      # <tt>render_partial_collection(partial_name, collection, partial_spacer_template = nil, local_assigns = {})</tt>.
      #
      # === Rendering a file
      # 
508 509 510 511 512
      # File rendering works just like action rendering except that it takes a path relative to the template root or an absolute
      # path if use_full_path is passed as true. The current layout is not applied automatically.
      #
      #   # Renders the template located in [TEMPLATE_ROOT]/weblog/show.r(html|xml) (in Rails, app/views/weblog/show.rhtml)
      #   render :file => "weblog/show"
513 514
      #
      #   # Renders the template located in /path/to/some/template.r(html|xml)
515
      #   render :file => "/path/to/some/template", :use_full_path => false
516 517
      #
      #   # Renders the same template within the current layout, but with a 404 status code
518
      #   render :file => "/path/to/some/template", :use_full_path => false, :layout => true, :status => 404
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
      #
      # _Deprecation_ _notice_: This used to have the signature <tt>render_file(path, status = 200)</tt>
      #
      # === Rendering text
      # 
      # 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
      #   render :text => "Explosion!", :status => 500 
      #
      #   # Renders the clear text "Hi there!" within the current active layout (if one exists)
      #   render :text => "Explosion!", :layout => true
      #
      #   # Renders the clear text "Hi there!" within the the layout 
      #   # placed in "app/views/layouts/special.r(html|xml)"
      #   render :text => "Explosion!", :layout => "special"
      #
      # _Deprecation_ _notice_: This used to have the signature <tt>render_text("text", status = 200)</tt>
      #
      # === 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"
      #   render :inline => "<%= 'hello, ' * 3 + 'again' %>" 
      #
      #   # Renders "<p>Good seeing you!</p>" using Builder
      #   render :inline => "xml.p { 'Good seeing you!' }", :type => :rxml
      #
      #   # Renders "hello david"
      #   render :inline => "<%= 'hello ' + name %>", :locals => { :name => "david" }
      #
      # _Deprecation_ _notice_: This used to have the signature <tt>render_template(template, status = 200, type = :rhtml)</tt>
      #
      # === Rendering nothing
      #
      # Rendering nothing is often convenient in combination with Ajax calls that perform their effect client-side or
562
      # when you just want to communicate a status code. Due to a bug in Safari, nothing actually means a single space.
563 564 565 566 567 568 569
      #
      #   # Renders an empty response with status code 200
      #   render :nothing => true
      #
      #   # Renders an empty response with status code 401 (access denied)
      #   render :nothing => true, :status => 401
      def render(options = {}, deprecated_status = nil) #:doc:
570
        # puts "Rendering: #{options.inspect}"
571
        raise DoubleRenderError if performed?
572 573 574 575

        # Backwards compatibility
        return render({ :template => options || default_template_name, :status => deprecated_status }) if !options.is_a?(Hash)

576 577 578 579 580
        add_variables_to_assigns
        options[:status] = (options[:status] || DEFAULT_RENDER_STATUS_CODE).to_s

        if options[:text]
          @response.headers["Status"] = options[:status]
581
          @response.body = options[:text]
582 583 584 585 586 587
          @performed_render = true
          return options[:text]

        elsif options[:file]
          assert_existance_of_template_file(options[:file]) if options[:use_full_path]
          logger.info("Rendering #{options[:file]} (#{options[:status]})") unless logger.nil?
588
          render(options.merge({ :text => @template.render_file(options[:file], options[:use_full_path])}))
589 590

        elsif options[:template]
591
          render(options.merge({ :file => options[:template], :use_full_path => true }))
592 593

        elsif options[:inline]
594 595 596 597 598
          render(options.merge({
            :text =>
              @template.render_template(
                options[:type] || :rhtml,
                options[:inline],
599
                nil,
600 601 602
                options[:locals] || {}
              )
          }))
603 604

        elsif options[:action]
605
          render(options.merge({ :template => default_template_name(options[:action]) }))
606 607

        elsif options[:partial] && options[:collection]
608
          render(options.merge({ 
609 610
            :text => (
              @template.render_partial_collection(
611 612 613
                options[:partial] == true ? default_template_name : options[:partial],
                options[:collection], options[:spacer_template],
                options[:locals] || {}
614 615 616 617 618
              ) || ''
            )
          }))

        elsif options[:partial]
619 620 621 622
          render(options.merge({ :text => @template.render_partial(
            options[:partial] == true ? default_template_name : options[:partial],
            options[:object], options[:locals] || {}
          ) }))
623 624
          
        elsif options[:nothing]
625 626
          # Safari doesn't pass the headers of the return if the response is zero length
          render(options.merge({ :text => " " }))
627 628

        else
629
          render(options.merge({ :action => action_name }))
630 631
        end
      end
D
Initial  
David Heinemeier Hansson 已提交
632

633 634
      # 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.
635
      def render_to_string(options = {}) #:doc:
636 637 638
        result = render(options)
        erase_render_results
        return result
639
      end
640
      
641

642
      # Clears the rendered results, allowing for another render to be performed.
643 644 645 646
      def erase_render_results #:nodoc:
        @response.body = nil
        @performed_render = false
      end
D
Initial  
David Heinemeier Hansson 已提交
647

648 649 650 651 652 653 654 655 656 657 658 659
      # Clears the redirected results from the headers, resetting the status to 200 and returns 
      # 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+
      def erase_redirect_results #:nodoc:
        @performed_redirect = false
        response.redirected_to = nil
        response.redirected_to_method_params = nil
        response.headers['Status'] = DEFAULT_RENDER_STATUS_CODE
        response.headers.delete('location')
      end

660

D
Initial  
David Heinemeier Hansson 已提交
661 662 663 664 665 666 667 668 669 670 671 672
      def rewrite_options(options)
        if defaults = default_url_options(options)
          defaults.merge(options)
        else
          options
        end
      end
      
      # 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)
673
      #     { :project => @project.active? ? @project.url_name : "unknown" }
D
Initial  
David Heinemeier Hansson 已提交
674 675 676 677 678 679 680 681
      #   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.
      def default_url_options(options) #:doc:
      end
      
682 683 684 685 686 687 688 689 690 691 692 693
      # Redirects the browser to the target specified in +options+. This parameter can take one of three forms:
      #
      # * <tt>Hash</tt>: The URL will be generated by calling url_for with the +options+.
      # * <tt>String starting with protocol:// (like http://)</tt>: Is passed straight through as the target for redirection.
      # * <tt>String not containing a protocol</tt>: The current current protocol and host is prepended to the string.
      # 
      # Examples:
      #   redirect_to :action => "show", :id => 5
      #   redirect_to "http://www.rubyonrails.org"
      #   redirect_to "/images/screenshot.jpg"
      #
      # The redirection happens as a "302 Moved" header.
D
Initial  
David Heinemeier Hansson 已提交
694
      def redirect_to(options = {}, *parameters_for_method_reference) #:doc:
695 696
        case options
          when %r{^\w+://.*}
697
            raise DoubleRenderError if performed?
698
            logger.info("Redirected to #{options}") unless logger.nil?
699 700
            response.redirect(options)
            response.redirected_to = options
701 702 703 704 705 706 707 708
            @performed_redirect = true

          when String
            redirect_to(request.protocol + request.host_with_port + options)

          else
            if parameters_for_method_reference.empty?
              redirect_to(url_for(options))
709
              response.redirected_to = options
710 711
            else
              redirect_to(url_for(options, *parameters_for_method_reference))
712
              response.redirected_to, response.redirected_to_method_params = options, parameters_for_method_reference
713
            end
D
Initial  
David Heinemeier Hansson 已提交
714 715
        end
      end
716 717 718 719 720 721 722 723 724 725 726
      
      # 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
      # 
      # This method will overwrite an existing Cache-Control header.
      # See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html for more possibilities.
727
      def expires_in(seconds, options = {}) #:doc:
728 729 730 731 732 733 734 735
        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}"}
        @response.headers["Cache-Control"] = cache_control.join(', ')
      end
      
      # 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).
736
      def expires_now #:doc:
737 738
        @response.headers["Cache-Control"] = "no-cache"
      end
D
Initial  
David Heinemeier Hansson 已提交
739

740
      # Resets the session by clearing out all the objects stored within and initializing a new session object.
D
Initial  
David Heinemeier Hansson 已提交
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
      def reset_session #:doc:
        @request.reset_session
        @session = @request.session
        @response.session = @session
      end
    
    private
      def initialize_template_class(response)
        begin
          response.template = template_class.new(template_root, {}, self)
        rescue
          raise "You must assign a template class through ActionController.template_class= before processing a request"
        end
        
        @performed_render = @performed_redirect = false
      end
    
      def assign_shortcuts(request, response)
        @request, @params, @cookies = request, request.parameters, request.cookies

        @response         = response
        @response.session = request.session

        @session  = @response.session
        @template = @response.template
        @assigns  = @response.template.assigns        
        @headers  = @response.headers
      end
      
      def initialize_current_url
771
        @url = UrlRewriter.new(@request, @params.clone())
D
Initial  
David Heinemeier Hansson 已提交
772 773 774 775 776 777 778 779
      end

      def log_processing
        logger.info "\n\nProcessing #{controller_class_name}\##{action_name} (for #{request_origin})"
        logger.info "  Parameters: #{@params.inspect}"
      end
    
      def perform_action
780
        if action_methods.include?(action_name) || action_methods.include?('method_missing')
D
Initial  
David Heinemeier Hansson 已提交
781
          send(action_name)
782
          render unless performed?
D
Initial  
David Heinemeier Hansson 已提交
783 784 785 786 787 788
        elsif template_exists? && template_public?
          render
        else
          raise UnknownAction, "No action responded to #{action_name}", caller
        end
      end
789 790 791 792
      
      def performed?
        @performed_render || @performed_redirect
      end
D
Initial  
David Heinemeier Hansson 已提交
793 794

      def action_methods
795
        @action_methods ||= (self.class.public_instance_methods - self.class.hidden_actions)
D
Initial  
David Heinemeier Hansson 已提交
796
      end
797 798


D
Initial  
David Heinemeier Hansson 已提交
799 800 801 802 803 804
      def add_variables_to_assigns
        add_instance_variables_to_assigns
        add_class_variables_to_assigns if view_controller_internals
      end

      def add_instance_variables_to_assigns
805
        @@protected_variables_cache = protected_instance_variables.inject({}) { |h, k| h[k] = true; h }
D
Initial  
David Heinemeier Hansson 已提交
806
        instance_variables.each do |var|
807
          next if @@protected_variables_cache.include?(var)
D
Initial  
David Heinemeier Hansson 已提交
808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
          @assigns[var[1..-1]] = instance_variable_get(var)
        end
      end

      def add_class_variables_to_assigns
        %w( template_root logger template_class ignore_missing_templates ).each do |cvar|
          @assigns[cvar] = self.send(cvar)
        end
      end

      def protected_instance_variables
        if view_controller_internals
          [ "@assigns", "@performed_redirect", "@performed_render" ]
        else
          [ "@assigns", "@performed_redirect", "@performed_render", "@request", "@response", "@session", "@cookies", "@template" ]
        end
      end

826

D
Initial  
David Heinemeier Hansson 已提交
827 828 829 830
      def request_origin
        "#{@request.remote_ip} at #{Time.now.to_s}"
      end
      
831 832 833 834
      def complete_request_uri
        request.protocol + request.host + request.request_uri
      end

D
Initial  
David Heinemeier Hansson 已提交
835 836 837
      def close_session
        @session.close unless @session.nil? || Hash === @session
      end
838

D
Initial  
David Heinemeier Hansson 已提交
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
      
      def template_exists?(template_name = default_template_name)
        @template.file_exists?(template_name)
      end

      def template_public?(template_name = default_template_name)
        @template.file_public?(template_name)
      end

      def assert_existance_of_template_file(template_name)
        unless template_exists?(template_name) || ignore_missing_templates
          full_template_path = @template.send(:full_template_path, template_name, 'rhtml')
          template_type = (template_name =~ /layouts/i) ? 'layout' : 'template'
          raise(MissingTemplate, "Missing #{template_type} #{full_template_path}")
        end
      end

      def default_template_name(default_action_name = action_name)
857
        "#{self.class.controller_path}/#{default_action_name}"
D
Initial  
David Heinemeier Hansson 已提交
858 859 860
      end
  end
end