Updated README.rdoc again
[feedcatcher.git] / vendor / rails / actionpack / lib / action_controller / base.rb
1 require 'set'
2
3 module ActionController #:nodoc:
4 class ActionControllerError < StandardError #:nodoc:
5 end
6
7 class SessionRestoreError < ActionControllerError #:nodoc:
8 end
9
10 class RenderError < ActionControllerError #:nodoc:
11 end
12
13 class RoutingError < ActionControllerError #:nodoc:
14 attr_reader :failures
15 def initialize(message, failures=[])
16 super(message)
17 @failures = failures
18 end
19 end
20
21 class MethodNotAllowed < ActionControllerError #:nodoc:
22 attr_reader :allowed_methods
23
24 def initialize(*allowed_methods)
25 super("Only #{allowed_methods.to_sentence(:locale => :en)} requests are allowed.")
26 @allowed_methods = allowed_methods
27 end
28
29 def allowed_methods_header
30 allowed_methods.map { |method_symbol| method_symbol.to_s.upcase } * ', '
31 end
32
33 def handle_response!(response)
34 response.headers['Allow'] ||= allowed_methods_header
35 end
36 end
37
38 class NotImplemented < MethodNotAllowed #:nodoc:
39 end
40
41 class UnknownController < ActionControllerError #:nodoc:
42 end
43
44 class UnknownAction < ActionControllerError #:nodoc:
45 end
46
47 class MissingFile < ActionControllerError #:nodoc:
48 end
49
50 class RenderError < ActionControllerError #:nodoc:
51 end
52
53 class SessionOverflowError < ActionControllerError #:nodoc:
54 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 def initialize(message = nil)
57 super(message || DEFAULT_MESSAGE)
58 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 super(message || DEFAULT_MESSAGE)
66 end
67 end
68
69 class RedirectBackError < ActionControllerError #:nodoc:
70 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"].'
71
72 def initialize(message = nil)
73 super(message || DEFAULT_MESSAGE)
74 end
75 end
76
77 class UnknownHttpMethod < ActionControllerError #:nodoc:
78 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:
85 #
86 # class GuestBookController < ActionController::Base
87 # def index
88 # @entries = Entry.find(:all)
89 # end
90 #
91 # def sign
92 # Entry.create(params[:entry])
93 # redirect_to :action => "index"
94 # end
95 # end
96 #
97 # Actions, by default, render a template in the <tt>app/views</tt> directory corresponding to the name of the controller and action
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.
100 #
101 # Unlike index, the sign action will not render a template. After performing its main purpose (creating a
102 # 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.
104 #
105 # The index and sign represent the two basic action archetypes used in Action Controllers. Get-and-show and do-and-redirect.
106 # Most actions are variations of these themes.
107 #
108 # == Requests
109 #
110 # Requests are processed by the Action Controller framework by extracting the value of the "action" key in the request parameters.
111 # This value should hold the name of the action to be performed. Once the action has been identified, the remaining
112 # request parameters, the session (if one is available), and the full request with all the HTTP headers are made available to
113 # the action through instance variables. Then the action is performed.
114 #
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:
117 #
118 # def server_ip
119 # location = request.env["SERVER_ADDR"]
120 # render :text => "This server hosted at #{location}"
121 # end
122 #
123 # == Parameters
124 #
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.
128 #
129 # It's also possible to construct multi-dimensional parameter hashes by specifying keys using brackets, such as:
130 #
131 # <input type="text" name="post[name]" value="david">
132 # <input type="text" name="post[address]" value="hyacintvej">
133 #
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
136 # <tt>{ "post" => { "address" => { "street" => "hyacintvej" } } }</tt>. There's no limit to the depth of the nesting.
137 #
138 # == Sessions
139 #
140 # Sessions allows you to store objects in between requests. This is useful for objects that are not yet ready to be persisted,
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
143 # they could be changed unknowingly. It's usually too much work to keep it all synchronized -- something databases already excel at.
144 #
145 # You can place objects in the session by using the <tt>session</tt> method, which accesses a hash:
146 #
147 # session[:person] = Person.authenticate(user_name, password)
148 #
149 # And retrieved again through the same hash:
150 #
151 # Hello #{session[:person]}
152 #
153 # For removing objects from the session, you can either assign a single key to +nil+:
154 #
155 # # removes :person from session
156 # session[:person] = nil
157 #
158 # or you can remove the entire session with +reset_session+.
159 #
160 # Sessions are stored by default in a browser cookie that's cryptographically signed, but unencrypted.
161 # This prevents the user from tampering with the session but also allows him to see its contents.
162 #
163 # Do not put secret information in cookie-based sessions!
164 #
165 # Other options for session storage are:
166 #
167 # * ActiveRecord::SessionStore - Sessions are stored in your database, which works better than PStore with multiple app servers and,
168 # unlike CookieStore, hides your session contents from the user. To use ActiveRecord::SessionStore, set
169 #
170 # config.action_controller.session_store = :active_record_store
171 #
172 # in your <tt>config/environment.rb</tt> and run <tt>rake db:sessions:create</tt>.
173 #
174 # * MemCacheStore - Sessions are stored as entries in your memcached cache.
175 # Set the session store type in <tt>config/environment.rb</tt>:
176 #
177 # config.action_controller.session_store = :mem_cache_store
178 #
179 # This assumes that memcached has been installed and configured properly.
180 # See the MemCacheStore docs for more information.
181 #
182 # == Responses
183 #
184 # 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.
186 #
187 # == Renders
188 #
189 # Action Controller sends content to the user by using one of five rendering methods. The most versatile and common is the rendering
190 # of a template. Included in the Action Pack is the Action View, which enables rendering of ERb templates. It's automatically configured.
191 # The controller passes objects to the view by assigning instance variables:
192 #
193 # def show
194 # @post = Post.find(params[:id])
195 # end
196 #
197 # Which are then automatically available to the view:
198 #
199 # Title: <%= @post.title %>
200 #
201 # You don't have to rely on the automated rendering. Especially actions that could result in the rendering of different templates will use
202 # the manual rendering methods:
203 #
204 # def search
205 # @results = Search.find(params[:query])
206 # case @results
207 # when 0 then render :action => "no_results"
208 # when 1 then render :action => "show"
209 # when 2..10 then render :action => "show_many"
210 # end
211 # end
212 #
213 # Read more about writing ERb and Builder templates in link:classes/ActionView/Base.html.
214 #
215 # == Redirects
216 #
217 # 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,
218 # 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)
219 # a <tt>show</tt> action that we'll assume has already been created. The code might look like this:
220 #
221 # def create
222 # @entry = Entry.new(params[:entry])
223 # if @entry.save
224 # # The entry was saved correctly, redirect to show
225 # redirect_to :action => 'show', :id => @entry.id
226 # else
227 # # things didn't go so well, do something else
228 # end
229 # end
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.
232 #
233 # == Calling multiple redirects or renders
234 #
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 # def do_something
238 # redirect_to :action => "elsewhere"
239 # render :action => "overthere" # raises DoubleRenderError
240 # end
241 #
242 # If you need to redirect on the condition of something, then be sure to add "and return" to halt execution.
243 #
244 # def do_something
245 # redirect_to(:action => "elsewhere") and return if monkeys.nil?
246 # render :action => "overthere" # won't be called if monkeys is nil
247 # end
248 #
249 class Base
250 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 # Prepends all the URL-generating helpers from AssetHelper. This makes it possible to easily move javascripts, stylesheets,
261 # and images to a dedicated asset server away from the main web server. Example:
262 # ActionController::Base.asset_host = "http://assets.example.com"
263 @@asset_host = ""
264 cattr_accessor :asset_host
265
266 # All requests are considered local by default, so everyone will be exposed to detailed debugging screens on errors.
267 # When the application is ready to go public, this should be set to false, and the protected method <tt>local_request?</tt>
268 # should instead be implemented in the controller to determine when debugging screens should be shown.
269 @@consider_all_requests_local = true
270 cattr_accessor :consider_all_requests_local
271
272 # Indicates whether to allow concurrent action processing. Your
273 # controller actions and any other code they call must also behave well
274 # when called from concurrent threads. Turned off by default.
275 @@allow_concurrency = false
276 cattr_accessor :allow_concurrency
277
278 # Modern REST web services often need to submit complex data to the web application.
279 # The <tt>@@param_parsers</tt> hash lets you register handlers which will process the HTTP body and add parameters to the
280 # <tt>params</tt> hash. These handlers are invoked for POST and PUT requests.
281 #
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 # ActionController::Base.param_parsers[Mime::Type.lookup('application/atom+xml')] = Proc.new do |data|
289 # node = REXML::Document.new(post)
290 # { node.root.name => node.root }
291 # end
292 #
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
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 # A YAML parser is also available and can be turned on with:
302 #
303 # ActionController::Base.param_parsers[Mime::YAML] = :yaml
304 @@param_parsers = {}
305 cattr_accessor :param_parsers
306
307 # Controls the default charset for all renders.
308 @@default_charset = "utf-8"
309 cattr_accessor :default_charset
310
311 # The logger is used for generating information on the action run-time (including benchmarking) if available.
312 # Can be set to nil for no logging. Compatible with both Ruby's own Logger and Log4r loggers.
313 cattr_accessor :logger
314
315 # Controls the resource action separator
316 @@resource_action_separator = "/"
317 cattr_accessor :resource_action_separator
318
319 # Allow to override path names for default resources' actions
320 @@resources_path_names = { :new => 'new', :edit => 'edit' }
321 cattr_accessor :resources_path_names
322
323 # Sets the token parameter name for RequestForgery. Calling +protect_from_forgery+
324 # sets it to <tt>:authenticity_token</tt> by default.
325 cattr_accessor :request_forgery_protection_token
326
327 # Controls the IP Spoofing check when determining the remote IP.
328 @@ip_spoofing_check = true
329 cattr_accessor :ip_spoofing_check
330
331 # Indicates whether or not optimise the generated named
332 # route helper methods
333 cattr_accessor :optimise_named_routes
334 self.optimise_named_routes = true
335
336 # Indicates whether the response format should be determined by examining the Accept HTTP header,
337 # or by using the simpler params + ajax rules.
338 #
339 # If this is set to +true+ (the default) then +respond_to+ and +Request#format+ will take the Accept
340 # header into account. If it is set to false then the request format will be determined solely
341 # by examining params[:format]. If params format is missing, the format will be either HTML or
342 # Javascript depending on whether the request is an AJAX request.
343 cattr_accessor :use_accept_header
344 self.use_accept_header = true
345
346 # Controls whether request forgergy protection is turned on or not. Turned off by default only in test mode.
347 class_inheritable_accessor :allow_forgery_protection
348 self.allow_forgery_protection = true
349
350 # If you are deploying to a subdirectory, you will need to set
351 # <tt>config.action_controller.relative_url_root</tt>
352 # This defaults to ENV['RAILS_RELATIVE_URL_ROOT']
353 cattr_accessor :relative_url_root
354 self.relative_url_root = ENV['RAILS_RELATIVE_URL_ROOT']
355
356 # Holds the request object that's primarily used to get environment variables through access like
357 # <tt>request.env["REQUEST_URI"]</tt>.
358 attr_internal :request
359
360 # Holds a hash of all the GET, POST, and Url parameters passed to the action. Accessed like <tt>params["post_id"]</tt>
361 # to get the post_id. No type casts are made, so all values are returned as strings.
362 attr_internal :params
363
364 # Holds the response object that's primarily used to set additional HTTP headers through access like
365 # <tt>response.headers["Cache-Control"] = "no-cache"</tt>. Can also be used to access the final body HTML after a template
366 # has been rendered through response.body -- useful for <tt>after_filter</tt>s that wants to manipulate the output,
367 # such as a OutputCompressionFilter.
368 attr_internal :response
369
370 # Holds a hash of objects in the session. Accessed like <tt>session[:person]</tt> to get the object tied to the "person"
371 # key. The session will hold any type of object as values, but the key should be a string or symbol.
372 attr_internal :session
373
374 # Holds a hash of header names and values. Accessed like <tt>headers["Cache-Control"]</tt> to get the value of the Cache-Control
375 # directive. Values should always be specified as strings.
376 attr_internal :headers
377
378 # Returns the name of the action this controller is processing.
379 attr_accessor :action_name
380
381 class << self
382 def call(env)
383 # HACK: For global rescue to have access to the original request and response
384 request = env["action_controller.rescue.request"] ||= Request.new(env)
385 response = env["action_controller.rescue.response"] ||= Response.new
386 process(request, response)
387 end
388
389 # Factory for the standard create, process loop where the controller is discarded after processing.
390 def process(request, response) #:nodoc:
391 new.process(request, response)
392 end
393
394 # Converts the class name from something like "OneModule::TwoModule::NeatController" to "NeatController".
395 def controller_class_name
396 @controller_class_name ||= name.demodulize
397 end
398
399 # Converts the class name from something like "OneModule::TwoModule::NeatController" to "neat".
400 def controller_name
401 @controller_name ||= controller_class_name.sub(/Controller$/, '').underscore
402 end
403
404 # Converts the class name from something like "OneModule::TwoModule::NeatController" to "one_module/two_module/neat".
405 def controller_path
406 @controller_path ||= name.gsub(/Controller$/, '').underscore
407 end
408
409 # Return an array containing the names of public methods that have been marked hidden from the action processor.
410 # By default, all methods defined in ActionController::Base and included modules are hidden.
411 # More methods can be hidden using <tt>hide_actions</tt>.
412 def hidden_actions
413 read_inheritable_attribute(:hidden_actions) || write_inheritable_attribute(:hidden_actions, [])
414 end
415
416 # Hide each of the given methods from being callable as actions.
417 def hide_action(*names)
418 write_inheritable_attribute(:hidden_actions, hidden_actions | names.map { |name| name.to_s })
419 end
420
421 # View load paths determine the bases from which template references can be made. So a call to
422 # render("test/template") will be looked up in the view load paths array and the closest match will be
423 # returned.
424 def view_paths
425 if defined? @view_paths
426 @view_paths
427 else
428 superclass.view_paths
429 end
430 end
431
432 def view_paths=(value)
433 @view_paths = ActionView::Base.process_view_paths(value) if value
434 end
435
436 # Adds a view_path to the front of the view_paths array.
437 # If the current class has no view paths, copy them from
438 # the superclass. This change will be visible for all future requests.
439 #
440 # ArticleController.prepend_view_path("views/default")
441 # ArticleController.prepend_view_path(["views/default", "views/custom"])
442 #
443 def prepend_view_path(path)
444 @view_paths = superclass.view_paths.dup if !defined?(@view_paths) || @view_paths.nil?
445 @view_paths.unshift(*path)
446 end
447
448 # Adds a view_path to the end of the view_paths array.
449 # If the current class has no view paths, copy them from
450 # the superclass. This change will be visible for all future requests.
451 #
452 # ArticleController.append_view_path("views/default")
453 # ArticleController.append_view_path(["views/default", "views/custom"])
454 #
455 def append_view_path(path)
456 @view_paths = superclass.view_paths.dup if @view_paths.nil?
457 @view_paths.push(*path)
458 end
459
460 # Replace sensitive parameter data from the request log.
461 # Filters parameters that have any of the arguments as a substring.
462 # Looks in all subhashes of the param hash for keys to filter.
463 # If a block is given, each key and value of the parameter hash and all
464 # subhashes is passed to it, the value or key
465 # can be replaced using String#replace or similar method.
466 #
467 # Examples:
468 # filter_parameter_logging
469 # => Does nothing, just slows the logging process down
470 #
471 # filter_parameter_logging :password
472 # => replaces the value to all keys matching /password/i with "[FILTERED]"
473 #
474 # filter_parameter_logging :foo, "bar"
475 # => replaces the value to all keys matching /foo|bar/i with "[FILTERED]"
476 #
477 # filter_parameter_logging { |k,v| v.reverse! if k =~ /secret/i }
478 # => reverses the value to all keys matching /secret/i
479 #
480 # filter_parameter_logging(:foo, "bar") { |k,v| v.reverse! if k =~ /secret/i }
481 # => reverses the value to all keys matching /secret/i, and
482 # replaces the value to all keys matching /foo|bar/i with "[FILTERED]"
483 def filter_parameter_logging(*filter_words, &block)
484 parameter_filter = Regexp.new(filter_words.collect{ |s| s.to_s }.join('|'), true) if filter_words.length > 0
485
486 define_method(:filter_parameters) do |unfiltered_parameters|
487 filtered_parameters = {}
488
489 unfiltered_parameters.each do |key, value|
490 if key =~ parameter_filter
491 filtered_parameters[key] = '[FILTERED]'
492 elsif value.is_a?(Hash)
493 filtered_parameters[key] = filter_parameters(value)
494 elsif block_given?
495 key = key.dup
496 value = value.dup if value
497 yield key, value
498 filtered_parameters[key] = value
499 else
500 filtered_parameters[key] = value
501 end
502 end
503
504 filtered_parameters
505 end
506 protected :filter_parameters
507 end
508
509 delegate :exempt_from_layout, :to => 'ActionView::Template'
510 end
511
512 public
513 # Extracts the action_name from the request parameters and performs that action.
514 def process(request, response, method = :perform_action, *arguments) #:nodoc:
515 response.request = request
516
517 initialize_template_class(response)
518 assign_shortcuts(request, response)
519 initialize_current_url
520 assign_names
521
522 log_processing
523 send(method, *arguments)
524
525 send_response
526 ensure
527 process_cleanup
528 end
529
530 def send_response
531 response.prepare!
532 response
533 end
534
535 # Returns a URL that has been rewritten according to the options hash and the defined routes.
536 # (For doing a complete redirect, use +redirect_to+).
537 #
538 # <tt>url_for</tt> is used to:
539 #
540 # All keys given to +url_for+ are forwarded to the Route module, save for the following:
541 # * <tt>:anchor</tt> - Specifies the anchor name to be appended to the path. For example,
542 # <tt>url_for :controller => 'posts', :action => 'show', :id => 10, :anchor => 'comments'</tt>
543 # will produce "/posts/show/10#comments".
544 # * <tt>:only_path</tt> - If true, returns the relative URL (omitting the protocol, host name, and port) (<tt>false</tt> by default).
545 # * <tt>:trailing_slash</tt> - If true, adds a trailing slash, as in "/archive/2005/". Note that this
546 # is currently not recommended since it breaks caching.
547 # * <tt>:host</tt> - Overrides the default (current) host if provided.
548 # * <tt>:protocol</tt> - Overrides the default (current) protocol if provided.
549 # * <tt>:port</tt> - Optionally specify the port to connect to.
550 # * <tt>:user</tt> - Inline HTTP authentication (only plucked out if <tt>:password</tt> is also present).
551 # * <tt>:password</tt> - Inline HTTP authentication (only plucked out if <tt>:user</tt> is also present).
552 # * <tt>:skip_relative_url_root</tt> - If true, the url is not constructed using the +relative_url_root+
553 # of the request so the path will include the web server relative installation directory.
554 #
555 # The URL is generated from the remaining keys in the hash. A URL contains two key parts: the <base> and a query string.
556 # Routes composes a query string as the key/value pairs not included in the <base>.
557 #
558 # The default Routes setup supports a typical Rails path of "controller/action/id" where action and id are optional, with
559 # action defaulting to 'index' when not given. Here are some typical url_for statements and their corresponding URLs:
560 #
561 # url_for :controller => 'posts', :action => 'recent' # => 'proto://host.com/posts/recent'
562 # url_for :controller => 'posts', :action => 'index' # => 'proto://host.com/posts'
563 # url_for :controller => 'posts', :action => 'index', :port=>'8033' # => 'proto://host.com:8033/posts'
564 # url_for :controller => 'posts', :action => 'show', :id => 10 # => 'proto://host.com/posts/show/10'
565 # url_for :controller => 'posts', :user => 'd', :password => '123' # => 'proto://d:123@host.com/posts'
566 #
567 # When generating a new URL, missing values may be filled in from the current request's parameters. For example,
568 # <tt>url_for :action => 'some_action'</tt> will retain the current controller, as expected. This behavior extends to
569 # other parameters, including <tt>:controller</tt>, <tt>:id</tt>, and any other parameters that are placed into a Route's
570 # path.
571 #  
572 # The URL helpers such as <tt>url_for</tt> have a limited form of memory: when generating a new URL, they can look for
573 # missing values in the current request's parameters. Routes attempts to guess when a value should and should not be
574 # taken from the defaults. There are a few simple rules on how this is performed:
575 #
576 # * If the controller name begins with a slash no defaults are used:
577 #
578 # url_for :controller => '/home'
579 #
580 # In particular, a leading slash ensures no namespace is assumed. Thus,
581 # while <tt>url_for :controller => 'users'</tt> may resolve to
582 # <tt>Admin::UsersController</tt> if the current controller lives under
583 # that module, <tt>url_for :controller => '/users'</tt> ensures you link
584 # to <tt>::UsersController</tt> no matter what.
585 # * If the controller changes, the action will default to index unless provided
586 #
587 # The final rule is applied while the URL is being generated and is best illustrated by an example. Let us consider the
588 # route given by <tt>map.connect 'people/:last/:first/:action', :action => 'bio', :controller => 'people'</tt>.
589 #
590 # Suppose that the current URL is "people/hh/david/contacts". Let's consider a few different cases of URLs which are generated
591 # from this page.
592 #
593 # * <tt>url_for :action => 'bio'</tt> -- During the generation of this URL, default values will be used for the first and
594 # last components, and the action shall change. The generated URL will be, "people/hh/david/bio".
595 # * <tt>url_for :first => 'davids-little-brother'</tt> This generates the URL 'people/hh/davids-little-brother' -- note
596 # that this URL leaves out the assumed action of 'bio'.
597 #
598 # However, you might ask why the action from the current request, 'contacts', isn't carried over into the new URL. The
599 # answer has to do with the order in which the parameters appear in the generated path. In a nutshell, since the
600 # value that appears in the slot for <tt>:first</tt> is not equal to default value for <tt>:first</tt> we stop using
601 # defaults. On its own, this rule can account for much of the typical Rails URL behavior.
602 #  
603 # Although a convenience, defaults can occasionally get in your way. In some cases a default persists longer than desired.
604 # The default may be cleared by adding <tt>:name => nil</tt> to <tt>url_for</tt>'s options.
605 # This is often required when writing form helpers, since the defaults in play may vary greatly depending upon where the
606 # helper is used from. The following line will redirect to PostController's default action, regardless of the page it is
607 # displayed on:
608 #
609 # url_for :controller => 'posts', :action => nil
610 #
611 # If you explicitly want to create a URL that's almost the same as the current URL, you can do so using the
612 # <tt>:overwrite_params</tt> options. Say for your posts you have different views for showing and printing them.
613 # Then, in the show view, you get the URL for the print view like this
614 #
615 # url_for :overwrite_params => { :action => 'print' }
616 #
617 # This takes the current URL as is and only exchanges the action. In contrast, <tt>url_for :action => 'print'</tt>
618 # would have slashed-off the path components after the changed action.
619 def url_for(options = {})
620 options ||= {}
621 case options
622 when String
623 options
624 when Hash
625 @url.rewrite(rewrite_options(options))
626 else
627 polymorphic_url(options)
628 end
629 end
630
631 # Converts the class name from something like "OneModule::TwoModule::NeatController" to "NeatController".
632 def controller_class_name
633 self.class.controller_class_name
634 end
635
636 # Converts the class name from something like "OneModule::TwoModule::NeatController" to "neat".
637 def controller_name
638 self.class.controller_name
639 end
640
641 # Converts the class name from something like "OneModule::TwoModule::NeatController" to "one_module/two_module/neat".
642 def controller_path
643 self.class.controller_path
644 end
645
646 def session_enabled?
647 ActiveSupport::Deprecation.warn("Sessions are now lazy loaded. So if you don't access them, consider them disabled.", caller)
648 end
649
650 self.view_paths = []
651
652 # View load paths for controller.
653 def view_paths
654 @template.view_paths
655 end
656
657 def view_paths=(value)
658 @template.view_paths = ActionView::Base.process_view_paths(value)
659 end
660
661 # Adds a view_path to the front of the view_paths array.
662 # This change affects the current request only.
663 #
664 # self.prepend_view_path("views/default")
665 # self.prepend_view_path(["views/default", "views/custom"])
666 #
667 def prepend_view_path(path)
668 @template.view_paths.unshift(*path)
669 end
670
671 # Adds a view_path to the end of the view_paths array.
672 # This change affects the current request only.
673 #
674 # self.append_view_path("views/default")
675 # self.append_view_path(["views/default", "views/custom"])
676 #
677 def append_view_path(path)
678 @template.view_paths.push(*path)
679 end
680
681 protected
682 # Renders the content that will be returned to the browser as the response body.
683 #
684 # === Rendering an action
685 #
686 # Action rendering is the most common form and the type used automatically by Action Controller when nothing else is
687 # specified. By default, actions are rendered within the current layout (if one exists).
688 #
689 # # Renders the template for the action "goal" within the current controller
690 # render :action => "goal"
691 #
692 # # Renders the template for the action "short_goal" within the current controller,
693 # # but without the current active layout
694 # render :action => "short_goal", :layout => false
695 #
696 # # Renders the template for the action "long_goal" within the current controller,
697 # # but with a custom layout
698 # render :action => "long_goal", :layout => "spectacular"
699 #
700 # === Rendering partials
701 #
702 # Partial rendering in a controller is most commonly used together with Ajax calls that only update one or a few elements on a page
703 # without reloading. Rendering of partials from the controller makes it possible to use the same partial template in
704 # both the full-page rendering (by calling it from within the template) and when sub-page updates happen (from the
705 # controller action responding to Ajax calls). By default, the current layout is not used.
706 #
707 # # Renders the same partial with a local variable.
708 # render :partial => "person", :locals => { :name => "david" }
709 #
710 # # Renders the partial, making @new_person available through
711 # # the local variable 'person'
712 # render :partial => "person", :object => @new_person
713 #
714 # # Renders a collection of the same partial by making each element
715 # # of @winners available through the local variable "person" as it
716 # # builds the complete response.
717 # render :partial => "person", :collection => @winners
718 #
719 # # Renders a collection of partials but with a custom local variable name
720 # render :partial => "admin_person", :collection => @winners, :as => :person
721 #
722 # # Renders the same collection of partials, but also renders the
723 # # person_divider partial between each person partial.
724 # render :partial => "person", :collection => @winners, :spacer_template => "person_divider"
725 #
726 # # Renders a collection of partials located in a view subfolder
727 # # outside of our current controller. In this example we will be
728 # # rendering app/views/shared/_note.r(html|xml) Inside the partial
729 # # each element of @new_notes is available as the local var "note".
730 # render :partial => "shared/note", :collection => @new_notes
731 #
732 # # Renders the partial with a status code of 500 (internal error).
733 # render :partial => "broken", :status => 500
734 #
735 # Note that the partial filename must also be a valid Ruby variable name,
736 # so e.g. 2005 and register-user are invalid.
737 #
738 #
739 # == Automatic etagging
740 #
741 # Rendering will automatically insert the etag header on 200 OK responses. The etag is calculated using MD5 of the
742 # response body. If a request comes in that has a matching etag, the response will be changed to a 304 Not Modified
743 # and the response body will be set to an empty string. No etag header will be inserted if it's already set.
744 #
745 # === Rendering a template
746 #
747 # Template rendering works just like action rendering except that it takes a path relative to the template root.
748 # The current layout is automatically applied.
749 #
750 # # Renders the template located in [TEMPLATE_ROOT]/weblog/show.r(html|xml) (in Rails, app/views/weblog/show.erb)
751 # render :template => "weblog/show"
752 #
753 # # Renders the template with a local variable
754 # render :template => "weblog/show", :locals => {:customer => Customer.new}
755 #
756 # === Rendering a file
757 #
758 # File rendering works just like action rendering except that it takes a filesystem path. By default, the path
759 # is assumed to be absolute, and the current layout is not applied.
760 #
761 # # Renders the template located at the absolute filesystem path
762 # render :file => "/path/to/some/template.erb"
763 # render :file => "c:/path/to/some/template.erb"
764 #
765 # # Renders a template within the current layout, and with a 404 status code
766 # render :file => "/path/to/some/template.erb", :layout => true, :status => 404
767 # render :file => "c:/path/to/some/template.erb", :layout => true, :status => 404
768 #
769 # === Rendering text
770 #
771 # Rendering of text is usually used for tests or for rendering prepared content, such as a cache. By default, text
772 # rendering is not done within the active layout.
773 #
774 # # Renders the clear text "hello world" with status code 200
775 # render :text => "hello world!"
776 #
777 # # Renders the clear text "Explosion!" with status code 500
778 # render :text => "Explosion!", :status => 500
779 #
780 # # Renders the clear text "Hi there!" within the current active layout (if one exists)
781 # render :text => "Hi there!", :layout => true
782 #
783 # # Renders the clear text "Hi there!" within the layout
784 # # placed in "app/views/layouts/special.r(html|xml)"
785 # render :text => "Hi there!", :layout => "special"
786 #
787 # === Streaming data and/or controlling the page generation
788 #
789 # The <tt>:text</tt> option can also accept a Proc object, which can be used to:
790 #
791 # 1. stream on-the-fly generated data to the browser. Note that you should
792 # use the methods provided by ActionController::Steaming instead if you
793 # want to stream a buffer or a file.
794 # 2. manually control the page generation. This should generally be avoided,
795 # as it violates the separation between code and content, and because almost
796 # everything that can be done with this method can also be done more cleanly
797 # using one of the other rendering methods, most notably templates.
798 #
799 # Two arguments are passed to the proc, a <tt>response</tt> object and an
800 # <tt>output</tt> object. The response object is equivalent to the return
801 # value of the ActionController::Base#response method, and can be used to
802 # control various things in the HTTP response, such as setting the
803 # Content-Type header. The output object is an writable <tt>IO</tt>-like
804 # object, so one can call <tt>write</tt> and <tt>flush</tt> on it.
805 #
806 # The following example demonstrates how one can stream a large amount of
807 # on-the-fly generated data to the browser:
808 #
809 # # Streams about 180 MB of generated data to the browser.
810 # render :text => proc { |response, output|
811 # 10_000_000.times do |i|
812 # output.write("This is line #{i}\n")
813 # output.flush
814 # end
815 # }
816 #
817 # Another example:
818 #
819 # # Renders "Hello from code!"
820 # render :text => proc { |response, output| output.write("Hello from code!") }
821 #
822 # === Rendering XML
823 #
824 # Rendering XML sets the content type to application/xml.
825 #
826 # # Renders '<name>David</name>'
827 # render :xml => {:name => "David"}.to_xml
828 #
829 # It's not necessary to call <tt>to_xml</tt> on the object you want to render, since <tt>render</tt> will
830 # automatically do that for you:
831 #
832 # # Also renders '<name>David</name>'
833 # render :xml => {:name => "David"}
834 #
835 # === Rendering JSON
836 #
837 # Rendering JSON sets the content type to application/json and optionally wraps the JSON in a callback. It is expected
838 # that the response will be parsed (or eval'd) for use as a data structure.
839 #
840 # # Renders '{"name": "David"}'
841 # render :json => {:name => "David"}.to_json
842 #
843 # It's not necessary to call <tt>to_json</tt> on the object you want to render, since <tt>render</tt> will
844 # automatically do that for you:
845 #
846 # # Also renders '{"name": "David"}'
847 # render :json => {:name => "David"}
848 #
849 # Sometimes the result isn't handled directly by a script (such as when the request comes from a SCRIPT tag),
850 # so the <tt>:callback</tt> option is provided for these cases.
851 #
852 # # Renders 'show({"name": "David"})'
853 # render :json => {:name => "David"}.to_json, :callback => 'show'
854 #
855 # === Rendering an inline template
856 #
857 # Rendering of an inline template works as a cross between text and action rendering where the source for the template
858 # is supplied inline, like text, but its interpreted with ERb or Builder, like action. By default, ERb is used for rendering
859 # and the current layout is not used.
860 #
861 # # Renders "hello, hello, hello, again"
862 # render :inline => "<%= 'hello, ' * 3 + 'again' %>"
863 #
864 # # Renders "<p>Good seeing you!</p>" using Builder
865 # render :inline => "xml.p { 'Good seeing you!' }", :type => :builder
866 #
867 # # Renders "hello david"
868 # render :inline => "<%= 'hello ' + name %>", :locals => { :name => "david" }
869 #
870 # === Rendering inline JavaScriptGenerator page updates
871 #
872 # In addition to rendering JavaScriptGenerator page updates with Ajax in RJS templates (see ActionView::Base for details),
873 # you can also pass the <tt>:update</tt> parameter to +render+, along with a block, to render page updates inline.
874 #
875 # render :update do |page|
876 # page.replace_html 'user_list', :partial => 'user', :collection => @users
877 # page.visual_effect :highlight, 'user_list'
878 # end
879 #
880 # === Rendering vanilla JavaScript
881 #
882 # In addition to using RJS with render :update, you can also just render vanilla JavaScript with :js.
883 #
884 # # Renders "alert('hello')" and sets the mime type to text/javascript
885 # render :js => "alert('hello')"
886 #
887 # === Rendering with status and location headers
888 # All renders take the <tt>:status</tt> and <tt>:location</tt> options and turn them into headers. They can even be used together:
889 #
890 # render :xml => post.to_xml, :status => :created, :location => post_url(post)
891 def render(options = nil, extra_options = {}, &block) #:doc:
892 raise DoubleRenderError, "Can only render or redirect once per action" if performed?
893
894 validate_render_arguments(options, extra_options, block_given?)
895
896 if options.nil?
897 options = { :template => default_template, :layout => true }
898 elsif options == :update
899 options = extra_options.merge({ :update => true })
900 elsif options.is_a?(String) || options.is_a?(Symbol)
901 case options.to_s.index('/')
902 when 0
903 extra_options[:file] = options
904 when nil
905 extra_options[:action] = options
906 else
907 extra_options[:template] = options
908 end
909
910 options = extra_options
911 elsif !options.is_a?(Hash)
912 extra_options[:partial] = options
913 options = extra_options
914 end
915
916 layout = pick_layout(options)
917 response.layout = layout.path_without_format_and_extension if layout
918 logger.info("Rendering template within #{layout.path_without_format_and_extension}") if logger && layout
919
920 if content_type = options[:content_type]
921 response.content_type = content_type.to_s
922 end
923
924 if location = options[:location]
925 response.headers["Location"] = url_for(location)
926 end
927
928 if options.has_key?(:text)
929 text = layout ? @template.render(options.merge(:text => options[:text], :layout => layout)) : options[:text]
930 render_for_text(text, options[:status])
931
932 else
933 if file = options[:file]
934 render_for_file(file, options[:status], layout, options[:locals] || {})
935
936 elsif template = options[:template]
937 render_for_file(template, options[:status], layout, options[:locals] || {})
938
939 elsif inline = options[:inline]
940 render_for_text(@template.render(options.merge(:layout => layout)), options[:status])
941
942 elsif action_name = options[:action]
943 render_for_file(default_template(action_name.to_s), options[:status], layout)
944
945 elsif xml = options[:xml]
946 response.content_type ||= Mime::XML
947 render_for_text(xml.respond_to?(:to_xml) ? xml.to_xml : xml, options[:status])
948
949 elsif js = options[:js]
950 response.content_type ||= Mime::JS
951 render_for_text(js, options[:status])
952
953 elsif json = options[:json]
954 json = json.to_json unless json.is_a?(String)
955 json = "#{options[:callback]}(#{json})" unless options[:callback].blank?
956 response.content_type ||= Mime::JSON
957 render_for_text(json, options[:status])
958
959 elsif options[:partial]
960 options[:partial] = default_template_name if options[:partial] == true
961 if layout
962 render_for_text(@template.render(:text => @template.render(options), :layout => layout), options[:status])
963 else
964 render_for_text(@template.render(options), options[:status])
965 end
966
967 elsif options[:update]
968 @template.send(:_evaluate_assigns_and_ivars)
969
970 generator = ActionView::Helpers::PrototypeHelper::JavaScriptGenerator.new(@template, &block)
971 response.content_type = Mime::JS
972 render_for_text(generator.to_s, options[:status])
973
974 elsif options[:nothing]
975 render_for_text(nil, options[:status])
976
977 else
978 render_for_file(default_template, options[:status], layout)
979 end
980 end
981 end
982
983 # Renders according to the same rules as <tt>render</tt>, but returns the result in a string instead
984 # of sending it as the response body to the browser.
985 def render_to_string(options = nil, &block) #:doc:
986 render(options, &block)
987 ensure
988 response.content_type = nil
989 erase_render_results
990 reset_variables_added_to_assigns
991 end
992
993 # Return a response that has no content (merely headers). The options
994 # argument is interpreted to be a hash of header names and values.
995 # This allows you to easily return a response that consists only of
996 # significant headers:
997 #
998 # head :created, :location => person_path(@person)
999 #
1000 # It can also be used to return exceptional conditions:
1001 #
1002 # return head(:method_not_allowed) unless request.post?
1003 # return head(:bad_request) unless valid_request?
1004 # render
1005 def head(*args)
1006 if args.length > 2
1007 raise ArgumentError, "too many arguments to head"
1008 elsif args.empty?
1009 raise ArgumentError, "too few arguments to head"
1010 end
1011 options = args.extract_options!
1012 status = interpret_status(args.shift || options.delete(:status) || :ok)
1013
1014 options.each do |key, value|
1015 headers[key.to_s.dasherize.split(/-/).map { |v| v.capitalize }.join("-")] = value.to_s
1016 end
1017
1018 render :nothing => true, :status => status
1019 end
1020
1021 # Clears the rendered results, allowing for another render to be performed.
1022 def erase_render_results #:nodoc:
1023 response.body = nil
1024 @performed_render = false
1025 end
1026
1027 # Clears the redirected results from the headers, resets the status to 200 and returns
1028 # the URL that was used to redirect or nil if there was no redirected URL
1029 # Note that +redirect_to+ will change the body of the response to indicate a redirection.
1030 # The response body is not reset here, see +erase_render_results+
1031 def erase_redirect_results #:nodoc:
1032 @performed_redirect = false
1033 response.redirected_to = nil
1034 response.redirected_to_method_params = nil
1035 response.status = DEFAULT_RENDER_STATUS_CODE
1036 response.headers.delete('Location')
1037 end
1038
1039 # Erase both render and redirect results
1040 def erase_results #:nodoc:
1041 erase_render_results
1042 erase_redirect_results
1043 end
1044
1045 def rewrite_options(options) #:nodoc:
1046 if defaults = default_url_options(options)
1047 defaults.merge(options)
1048 else
1049 options
1050 end
1051 end
1052
1053 # Overwrite to implement a number of default options that all url_for-based methods will use. The default options should come in
1054 # the form of a hash, just like the one you would use for url_for directly. Example:
1055 #
1056 # def default_url_options(options)
1057 # { :project => @project.active? ? @project.url_name : "unknown" }
1058 # end
1059 #
1060 # As you can infer from the example, this is mostly useful for situations where you want to centralize dynamic decisions about the
1061 # urls as they stem from the business domain. Please note that any individual url_for call can always override the defaults set
1062 # by this method.
1063 def default_url_options(options = nil)
1064 end
1065
1066 # Redirects the browser to the target specified in +options+. This parameter can take one of three forms:
1067 #
1068 # * <tt>Hash</tt> - The URL will be generated by calling url_for with the +options+.
1069 # * <tt>Record</tt> - The URL will be generated by calling url_for with the +options+, which will reference a named URL for that record.
1070 # * <tt>String</tt> starting with <tt>protocol://</tt> (like <tt>http://</tt>) - Is passed straight through as the target for redirection.
1071 # * <tt>String</tt> not containing a protocol - The current protocol and host is prepended to the string.
1072 # * <tt>:back</tt> - Back to the page that issued the request. Useful for forms that are triggered from multiple places.
1073 # Short-hand for <tt>redirect_to(request.env["HTTP_REFERER"])</tt>
1074 #
1075 # Examples:
1076 # redirect_to :action => "show", :id => 5
1077 # redirect_to post
1078 # redirect_to "http://www.rubyonrails.org"
1079 # redirect_to "/images/screenshot.jpg"
1080 # redirect_to articles_url
1081 # redirect_to :back
1082 #
1083 # The redirection happens as a "302 Moved" header unless otherwise specified.
1084 #
1085 # Examples:
1086 # redirect_to post_url(@post), :status=>:found
1087 # redirect_to :action=>'atom', :status=>:moved_permanently
1088 # redirect_to post_url(@post), :status=>301
1089 # redirect_to :action=>'atom', :status=>302
1090 #
1091 # When using <tt>redirect_to :back</tt>, if there is no referrer,
1092 # RedirectBackError will be raised. You may specify some fallback
1093 # behavior for this case by rescuing RedirectBackError.
1094 def redirect_to(options = {}, response_status = {}) #:doc:
1095 raise ActionControllerError.new("Cannot redirect to nil!") if options.nil?
1096
1097 if options.is_a?(Hash) && options[:status]
1098 status = options.delete(:status)
1099 elsif response_status[:status]
1100 status = response_status[:status]
1101 else
1102 status = 302
1103 end
1104
1105 response.redirected_to = options
1106
1107 case options
1108 # The scheme name consist of a letter followed by any combination of
1109 # letters, digits, and the plus ("+"), period ("."), or hyphen ("-")
1110 # characters; and is terminated by a colon (":").
1111 when %r{^\w[\w\d+.-]*:.*}
1112 redirect_to_full_url(options, status)
1113 when String
1114 redirect_to_full_url(request.protocol + request.host_with_port + options, status)
1115 when :back
1116 if referer = request.headers["Referer"]
1117 redirect_to(referer, :status=>status)
1118 else
1119 raise RedirectBackError
1120 end
1121 else
1122 redirect_to_full_url(url_for(options), status)
1123 end
1124 end
1125
1126 def redirect_to_full_url(url, status)
1127 raise DoubleRenderError if performed?
1128 logger.info("Redirected to #{url}") if logger && logger.info?
1129 response.redirect(url, interpret_status(status))
1130 @performed_redirect = true
1131 end
1132
1133 # Sets the etag and/or last_modified on the response and checks it against
1134 # the client request. If the request doesn't match the options provided, the
1135 # request is considered stale and should be generated from scratch. Otherwise,
1136 # it's fresh and we don't need to generate anything and a reply of "304 Not Modified" is sent.
1137 #
1138 # Parameters:
1139 # * <tt>:etag</tt>
1140 # * <tt>:last_modified</tt>
1141 # * <tt>:public</tt> By default the Cache-Control header is private, set this to true if you want your application to be cachable by other devices (proxy caches).
1142 #
1143 # Example:
1144 #
1145 # def show
1146 # @article = Article.find(params[:id])
1147 #
1148 # if stale?(:etag => @article, :last_modified => @article.created_at.utc)
1149 # @statistics = @article.really_expensive_call
1150 # respond_to do |format|
1151 # # all the supported formats
1152 # end
1153 # end
1154 # end
1155 def stale?(options)
1156 fresh_when(options)
1157 !request.fresh?(response)
1158 end
1159
1160 # Sets the etag, last_modified, or both on the response and renders a
1161 # "304 Not Modified" response if the request is already fresh.
1162 #
1163 # Parameters:
1164 # * <tt>:etag</tt>
1165 # * <tt>:last_modified</tt>
1166 # * <tt>:public</tt> By default the Cache-Control header is private, set this to true if you want your application to be cachable by other devices (proxy caches).
1167 #
1168 # Example:
1169 #
1170 # def show
1171 # @article = Article.find(params[:id])
1172 # fresh_when(:etag => @article, :last_modified => @article.created_at.utc, :public => true)
1173 # end
1174 #
1175 # This will render the show template if the request isn't sending a matching etag or
1176 # If-Modified-Since header and just a "304 Not Modified" response if there's a match.
1177 #
1178 def fresh_when(options)
1179 options.assert_valid_keys(:etag, :last_modified, :public)
1180
1181 response.etag = options[:etag] if options[:etag]
1182 response.last_modified = options[:last_modified] if options[:last_modified]
1183
1184 if options[:public]
1185 cache_control = response.headers["Cache-Control"].split(",").map {|k| k.strip }
1186 cache_control.delete("private")
1187 cache_control.delete("no-cache")
1188 cache_control << "public"
1189 response.headers["Cache-Control"] = cache_control.join(', ')
1190 end
1191
1192 if request.fresh?(response)
1193 head :not_modified
1194 end
1195 end
1196
1197 # Sets a HTTP 1.1 Cache-Control header. Defaults to issuing a "private" instruction, so that
1198 # intermediate caches shouldn't cache the response.
1199 #
1200 # Examples:
1201 # expires_in 20.minutes
1202 # expires_in 3.hours, :public => true
1203 # expires in 3.hours, 'max-stale' => 5.hours, :public => true
1204 #
1205 # This method will overwrite an existing Cache-Control header.
1206 # See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html for more possibilities.
1207 def expires_in(seconds, options = {}) #:doc:
1208 cache_control = response.headers["Cache-Control"].split(",").map {|k| k.strip }
1209
1210 cache_control << "max-age=#{seconds}"
1211 cache_control.delete("no-cache")
1212 if options[:public]
1213 cache_control.delete("private")
1214 cache_control << "public"
1215 else
1216 cache_control << "private"
1217 end
1218
1219 # This allows for additional headers to be passed through like 'max-stale' => 5.hours
1220 cache_control += options.symbolize_keys.reject{|k,v| k == :public || k == :private }.map{ |k,v| v == true ? k.to_s : "#{k.to_s}=#{v.to_s}"}
1221
1222 response.headers["Cache-Control"] = cache_control.join(', ')
1223 end
1224
1225 # Sets a HTTP 1.1 Cache-Control header of "no-cache" so no caching should occur by the browser or
1226 # intermediate caches (like caching proxy servers).
1227 def expires_now #:doc:
1228 response.headers["Cache-Control"] = "no-cache"
1229 end
1230
1231 # Resets the session by clearing out all the objects stored within and initializing a new session object.
1232 def reset_session #:doc:
1233 request.reset_session
1234 @_session = request.session
1235 end
1236
1237 private
1238 def render_for_file(template_path, status = nil, layout = nil, locals = {}) #:nodoc:
1239 path = template_path.respond_to?(:path_without_format_and_extension) ? template_path.path_without_format_and_extension : template_path
1240 logger.info("Rendering #{path}" + (status ? " (#{status})" : '')) if logger
1241 render_for_text @template.render(:file => template_path, :locals => locals, :layout => layout), status
1242 end
1243
1244 def render_for_text(text = nil, status = nil, append_response = false) #:nodoc:
1245 @performed_render = true
1246
1247 response.status = interpret_status(status || DEFAULT_RENDER_STATUS_CODE)
1248
1249 if append_response
1250 response.body ||= ''
1251 response.body << text.to_s
1252 else
1253 response.body = case text
1254 when Proc then text
1255 when nil then " " # Safari doesn't pass the headers of the return if the response is zero length
1256 else text.to_s
1257 end
1258 end
1259 end
1260
1261 def validate_render_arguments(options, extra_options, has_block)
1262 if options && (has_block && options != :update) && !options.is_a?(String) && !options.is_a?(Hash) && !options.is_a?(Symbol)
1263 raise RenderError, "You called render with invalid options : #{options.inspect}"
1264 end
1265
1266 if !extra_options.is_a?(Hash)
1267 raise RenderError, "You called render with invalid options : #{options.inspect}, #{extra_options.inspect}"
1268 end
1269 end
1270
1271 def initialize_template_class(response)
1272 response.template = ActionView::Base.new(self.class.view_paths, {}, self)
1273 response.template.helpers.send :include, self.class.master_helper_module
1274 response.redirected_to = nil
1275 @performed_render = @performed_redirect = false
1276 end
1277
1278 def assign_shortcuts(request, response)
1279 @_request, @_params = request, request.parameters
1280
1281 @_response = response
1282 @_response.session = request.session
1283
1284 @_session = @_response.session
1285 @template = @_response.template
1286
1287 @_headers = @_response.headers
1288 end
1289
1290 def initialize_current_url
1291 @url = UrlRewriter.new(request, params.clone)
1292 end
1293
1294 def log_processing
1295 if logger && logger.info?
1296 log_processing_for_request_id
1297 log_processing_for_parameters
1298 end
1299 end
1300
1301 def log_processing_for_request_id
1302 request_id = "\n\nProcessing #{self.class.name}\##{action_name} "
1303 request_id << "to #{params[:format]} " if params[:format]
1304 request_id << "(for #{request_origin}) [#{request.method.to_s.upcase}]"
1305
1306 logger.info(request_id)
1307 end
1308
1309 def log_processing_for_parameters
1310 parameters = respond_to?(:filter_parameters) ? filter_parameters(params) : params.dup
1311 parameters = parameters.except!(:controller, :action, :format, :_method)
1312
1313 logger.info " Parameters: #{parameters.inspect}" unless parameters.empty?
1314 end
1315
1316 def default_render #:nodoc:
1317 render
1318 end
1319
1320 def perform_action
1321 if action_methods.include?(action_name)
1322 send(action_name)
1323 default_render unless performed?
1324 elsif respond_to? :method_missing
1325 method_missing action_name
1326 default_render unless performed?
1327 else
1328 begin
1329 default_render
1330 rescue ActionView::MissingTemplate => e
1331 # Was the implicit template missing, or was it another template?
1332 if e.path == default_template_name
1333 raise UnknownAction, "No action responded to #{action_name}. Actions: #{action_methods.sort.to_sentence(:locale => :en)}", caller
1334 else
1335 raise e
1336 end
1337 end
1338 end
1339 end
1340
1341 def performed?
1342 @performed_render || @performed_redirect
1343 end
1344
1345 def assign_names
1346 @action_name = (params['action'] || 'index')
1347 end
1348
1349 def action_methods
1350 self.class.action_methods
1351 end
1352
1353 def self.action_methods
1354 @action_methods ||=
1355 # All public instance methods of this class, including ancestors
1356 public_instance_methods(true).map { |m| m.to_s }.to_set -
1357 # Except for public instance methods of Base and its ancestors
1358 Base.public_instance_methods(true).map { |m| m.to_s } +
1359 # Be sure to include shadowed public instance methods of this class
1360 public_instance_methods(false).map { |m| m.to_s } -
1361 # And always exclude explicitly hidden actions
1362 hidden_actions
1363 end
1364
1365 def reset_variables_added_to_assigns
1366 @template.instance_variable_set("@assigns_added", nil)
1367 end
1368
1369 def request_origin
1370 # this *needs* to be cached!
1371 # otherwise you'd get different results if calling it more than once
1372 @request_origin ||= "#{request.remote_ip} at #{Time.now.to_s(:db)}"
1373 end
1374
1375 def complete_request_uri
1376 "#{request.protocol}#{request.host}#{request.request_uri}"
1377 end
1378
1379 def default_template(action_name = self.action_name)
1380 self.view_paths.find_template(default_template_name(action_name), default_template_format)
1381 end
1382
1383 def default_template_name(action_name = self.action_name)
1384 if action_name
1385 action_name = action_name.to_s
1386 if action_name.include?('/') && template_path_includes_controller?(action_name)
1387 action_name = strip_out_controller(action_name)
1388 end
1389 end
1390 "#{self.controller_path}/#{action_name}"
1391 end
1392
1393 def strip_out_controller(path)
1394 path.split('/', 2).last
1395 end
1396
1397 def template_path_includes_controller?(path)
1398 self.controller_path.split('/')[-1] == path.split('/')[0]
1399 end
1400
1401 def process_cleanup
1402 end
1403 end
1404
1405 Base.class_eval do
1406 [ Filters, Layout, Benchmarking, Rescue, Flash, MimeResponds, Helpers,
1407 Cookies, Caching, Verification, Streaming, SessionManagement,
1408 HttpAuthentication::Basic::ControllerMethods, HttpAuthentication::Digest::ControllerMethods,
1409 RecordIdentifier, RequestForgeryProtection, Translation
1410 ].each do |mod|
1411 include mod
1412 end
1413 end
1414 end