3
module ActionController #:nodoc:
4
class ActionControllerError < StandardError #:nodoc:
7
class SessionRestoreError < ActionControllerError #:nodoc:
10
class RenderError < ActionControllerError #:nodoc:
13
class RoutingError < ActionControllerError #:nodoc:
15
def initialize(message, failures=[])
21
class MethodNotAllowed < ActionControllerError #:nodoc:
22
attr_reader :allowed_methods
24
def initialize(*allowed_methods)
25
super("Only #{allowed_methods.to_sentence(:locale => :en)} requests are allowed.")
26
@allowed_methods = allowed_methods
29
def allowed_methods_header
30
allowed_methods.map { |method_symbol| method_symbol.to_s.upcase } * ', '
33
def handle_response!(response)
34
response.headers['Allow'] ||= allowed_methods_header
38
class NotImplemented < MethodNotAllowed #:nodoc:
41
class UnknownController < ActionControllerError #:nodoc:
44
class UnknownAction < ActionControllerError #:nodoc:
47
class MissingFile < ActionControllerError #:nodoc:
50
class RenderError < ActionControllerError #:nodoc:
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.'
56
def initialize(message = nil)
57
super(message || DEFAULT_MESSAGE)
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\"."
64
def initialize(message = nil)
65
super(message || DEFAULT_MESSAGE)
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"].'
72
def initialize(message = nil)
73
super(message || DEFAULT_MESSAGE)
77
class UnknownHttpMethod < ActionControllerError #:nodoc:
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.
84
# A sample controller could look like this:
86
# class GuestBookController < ActionController::Base
88
# @entries = Entry.find(:all)
92
# Entry.create(params[:entry])
93
# redirect_to :action => "index"
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.
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.
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.
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.
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:
119
# location = request.env["SERVER_ADDR"]
120
# render :text => "This server hosted at #{location}"
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.
129
# It's also possible to construct multi-dimensional parameter hashes by specifying keys using brackets, such as:
131
# <input type="text" name="post[name]" value="david">
132
# <input type="text" name="post[address]" value="hyacintvej">
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.
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.
145
# You can place objects in the session by using the <tt>session</tt> method, which accesses a hash:
147
# session[:person] = Person.authenticate(user_name, password)
149
# And retrieved again through the same hash:
151
# Hello #{session[:person]}
153
# For removing objects from the session, you can either assign a single key to +nil+:
155
# # removes :person from session
156
# session[:person] = nil
158
# or you can remove the entire session with +reset_session+.
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.
163
# Do not put secret information in cookie-based sessions!
165
# Other options for session storage are:
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
170
# config.action_controller.session_store = :active_record_store
172
# in your <tt>config/environment.rb</tt> and run <tt>rake db:sessions:create</tt>.
174
# * MemCacheStore - Sessions are stored as entries in your memcached cache.
175
# Set the session store type in <tt>config/environment.rb</tt>:
177
# config.action_controller.session_store = :mem_cache_store
179
# This assumes that memcached has been installed and configured properly.
180
# See the MemCacheStore docs for more information.
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.
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:
194
# @post = Post.find(params[:id])
197
# Which are then automatically available to the view:
199
# Title: <%= @post.title %>
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:
205
# @results = Search.find(params[:query])
207
# when 0 then render :action => "no_results"
208
# when 1 then render :action => "show"
209
# when 2..10 then render :action => "show_many"
213
# Read more about writing ERb and Builder templates in link:classes/ActionView/Base.html.
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:
222
# @entry = Entry.new(params[:entry])
224
# # The entry was saved correctly, redirect to show
225
# redirect_to :action => 'show', :id => @entry.id
227
# # things didn't go so well, do something else
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.
233
# == Calling multiple redirects or renders
235
# An action may contain only a single render or a single redirect. Attempting to try to do either again will result in a DoubleRenderError:
238
# redirect_to :action => "elsewhere"
239
# render :action => "overthere" # raises DoubleRenderError
242
# If you need to redirect on the condition of something, then be sure to add "and return" to halt execution.
245
# redirect_to(:action => "elsewhere") and return if monkeys.nil?
246
# render :action => "overthere" # won't be called if monkeys is nil
250
DEFAULT_RENDER_STATUS_CODE = "200 OK"
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
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"
264
cattr_accessor :asset_host
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
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
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.
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.
286
# Example of doing your own parser for a custom content type:
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 }
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:
298
# ActionController::Base.param_parsers[Mime::XML] =
299
# Proc.new { |data| XmlSimple.xml_in(data, 'ForceArray' => false) }
301
# A YAML parser is also available and can be turned on with:
303
# ActionController::Base.param_parsers[Mime::YAML] = :yaml
305
cattr_accessor :param_parsers
307
# Controls the default charset for all renders.
308
@@default_charset = "utf-8"
309
cattr_accessor :default_charset
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
315
# Controls the resource action separator
316
@@resource_action_separator = "/"
317
cattr_accessor :resource_action_separator
319
# Allow to override path names for default resources' actions
320
@@resources_path_names = { :new => 'new', :edit => 'edit' }
321
cattr_accessor :resources_path_names
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
327
# Controls the IP Spoofing check when determining the remote IP.
328
@@ip_spoofing_check = true
329
cattr_accessor :ip_spoofing_check
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
336
# Indicates whether the response format should be determined by examining the Accept HTTP header,
337
# or by using the simpler params + ajax rules.
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
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
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']
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
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
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
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
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
378
# Returns the name of the action this controller is processing.
379
attr_accessor :action_name
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)
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)
394
# Converts the class name from something like "OneModule::TwoModule::NeatController" to "NeatController".
395
def controller_class_name
396
@controller_class_name ||= name.demodulize
399
# Converts the class name from something like "OneModule::TwoModule::NeatController" to "neat".
401
@controller_name ||= controller_class_name.sub(/Controller$/, '').underscore
404
# Converts the class name from something like "OneModule::TwoModule::NeatController" to "one_module/two_module/neat".
406
@controller_path ||= name.gsub(/Controller$/, '').underscore
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>.
413
read_inheritable_attribute(:hidden_actions) || write_inheritable_attribute(:hidden_actions, [])
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 })
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
425
if defined? @view_paths
428
superclass.view_paths
432
def view_paths=(value)
433
@view_paths = ActionView::Base.process_view_paths(value) if value
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.
440
# ArticleController.prepend_view_path("views/default")
441
# ArticleController.prepend_view_path(["views/default", "views/custom"])
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)
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.
452
# ArticleController.append_view_path("views/default")
453
# ArticleController.append_view_path(["views/default", "views/custom"])
455
def append_view_path(path)
456
@view_paths = superclass.view_paths.dup if @view_paths.nil?
457
@view_paths.push(*path)
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.
468
# filter_parameter_logging
469
# => Does nothing, just slows the logging process down
471
# filter_parameter_logging :password
472
# => replaces the value to all keys matching /password/i with "[FILTERED]"
474
# filter_parameter_logging :foo, "bar"
475
# => replaces the value to all keys matching /foo|bar/i with "[FILTERED]"
477
# filter_parameter_logging { |k,v| v.reverse! if k =~ /secret/i }
478
# => reverses the value to all keys matching /secret/i
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
486
define_method(:filter_parameters) do |unfiltered_parameters|
487
filtered_parameters = {}
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 value.is_a?(Array)
495
filtered_parameters[key] = value.collect do |item|
498
filter_parameters(item)
505
value = value.dup if value.duplicable?
507
filtered_parameters[key] = value
509
filtered_parameters[key] = value
515
protected :filter_parameters
518
delegate :exempt_from_layout, :to => 'ActionView::Template'
522
# Extracts the action_name from the request parameters and performs that action.
523
def process(request, response, method = :perform_action, *arguments) #:nodoc:
524
response.request = request
526
initialize_template_class(response)
527
assign_shortcuts(request, response)
528
initialize_current_url
532
send(method, *arguments)
544
# Returns a URL that has been rewritten according to the options hash and the defined routes.
545
# (For doing a complete redirect, use +redirect_to+).
547
# <tt>url_for</tt> is used to:
549
# All keys given to +url_for+ are forwarded to the Route module, save for the following:
550
# * <tt>:anchor</tt> - Specifies the anchor name to be appended to the path. For example,
551
# <tt>url_for :controller => 'posts', :action => 'show', :id => 10, :anchor => 'comments'</tt>
552
# will produce "/posts/show/10#comments".
553
# * <tt>:only_path</tt> - If true, returns the relative URL (omitting the protocol, host name, and port) (<tt>false</tt> by default).
554
# * <tt>:trailing_slash</tt> - If true, adds a trailing slash, as in "/archive/2005/". Note that this
555
# is currently not recommended since it breaks caching.
556
# * <tt>:host</tt> - Overrides the default (current) host if provided.
557
# * <tt>:protocol</tt> - Overrides the default (current) protocol if provided.
558
# * <tt>:port</tt> - Optionally specify the port to connect to.
559
# * <tt>:user</tt> - Inline HTTP authentication (only plucked out if <tt>:password</tt> is also present).
560
# * <tt>:password</tt> - Inline HTTP authentication (only plucked out if <tt>:user</tt> is also present).
561
# * <tt>:skip_relative_url_root</tt> - If true, the url is not constructed using the +relative_url_root+
562
# of the request so the path will include the web server relative installation directory.
564
# The URL is generated from the remaining keys in the hash. A URL contains two key parts: the <base> and a query string.
565
# Routes composes a query string as the key/value pairs not included in the <base>.
567
# The default Routes setup supports a typical Rails path of "controller/action/id" where action and id are optional, with
568
# action defaulting to 'index' when not given. Here are some typical url_for statements and their corresponding URLs:
570
# url_for :controller => 'posts', :action => 'recent' # => 'proto://host.com/posts/recent'
571
# url_for :controller => 'posts', :action => 'index' # => 'proto://host.com/posts'
572
# url_for :controller => 'posts', :action => 'index', :port=>'8033' # => 'proto://host.com:8033/posts'
573
# url_for :controller => 'posts', :action => 'show', :id => 10 # => 'proto://host.com/posts/show/10'
574
# url_for :controller => 'posts', :user => 'd', :password => '123' # => 'proto://d:123@host.com/posts'
576
# When generating a new URL, missing values may be filled in from the current request's parameters. For example,
577
# <tt>url_for :action => 'some_action'</tt> will retain the current controller, as expected. This behavior extends to
578
# other parameters, including <tt>:controller</tt>, <tt>:id</tt>, and any other parameters that are placed into a Route's
581
# The URL helpers such as <tt>url_for</tt> have a limited form of memory: when generating a new URL, they can look for
582
# missing values in the current request's parameters. Routes attempts to guess when a value should and should not be
583
# taken from the defaults. There are a few simple rules on how this is performed:
585
# * If the controller name begins with a slash no defaults are used:
587
# url_for :controller => '/home'
589
# In particular, a leading slash ensures no namespace is assumed. Thus,
590
# while <tt>url_for :controller => 'users'</tt> may resolve to
591
# <tt>Admin::UsersController</tt> if the current controller lives under
592
# that module, <tt>url_for :controller => '/users'</tt> ensures you link
593
# to <tt>::UsersController</tt> no matter what.
594
# * If the controller changes, the action will default to index unless provided
596
# The final rule is applied while the URL is being generated and is best illustrated by an example. Let us consider the
597
# route given by <tt>map.connect 'people/:last/:first/:action', :action => 'bio', :controller => 'people'</tt>.
599
# Suppose that the current URL is "people/hh/david/contacts". Let's consider a few different cases of URLs which are generated
602
# * <tt>url_for :action => 'bio'</tt> -- During the generation of this URL, default values will be used for the first and
603
# last components, and the action shall change. The generated URL will be, "people/hh/david/bio".
604
# * <tt>url_for :first => 'davids-little-brother'</tt> This generates the URL 'people/hh/davids-little-brother' -- note
605
# that this URL leaves out the assumed action of 'bio'.
607
# However, you might ask why the action from the current request, 'contacts', isn't carried over into the new URL. The
608
# answer has to do with the order in which the parameters appear in the generated path. In a nutshell, since the
609
# value that appears in the slot for <tt>:first</tt> is not equal to default value for <tt>:first</tt> we stop using
610
# defaults. On its own, this rule can account for much of the typical Rails URL behavior.
612
# Although a convenience, defaults can occasionally get in your way. In some cases a default persists longer than desired.
613
# The default may be cleared by adding <tt>:name => nil</tt> to <tt>url_for</tt>'s options.
614
# This is often required when writing form helpers, since the defaults in play may vary greatly depending upon where the
615
# helper is used from. The following line will redirect to PostController's default action, regardless of the page it is
618
# url_for :controller => 'posts', :action => nil
620
# If you explicitly want to create a URL that's almost the same as the current URL, you can do so using the
621
# <tt>:overwrite_params</tt> options. Say for your posts you have different views for showing and printing them.
622
# Then, in the show view, you get the URL for the print view like this
624
# url_for :overwrite_params => { :action => 'print' }
626
# This takes the current URL as is and only exchanges the action. In contrast, <tt>url_for :action => 'print'</tt>
627
# would have slashed-off the path components after the changed action.
628
def url_for(options = {})
634
@url.rewrite(rewrite_options(options))
636
polymorphic_url(options)
640
# Converts the class name from something like "OneModule::TwoModule::NeatController" to "NeatController".
641
def controller_class_name
642
self.class.controller_class_name
645
# Converts the class name from something like "OneModule::TwoModule::NeatController" to "neat".
647
self.class.controller_name
650
# Converts the class name from something like "OneModule::TwoModule::NeatController" to "one_module/two_module/neat".
652
self.class.controller_path
656
ActiveSupport::Deprecation.warn("Sessions are now lazy loaded. So if you don't access them, consider them disabled.", caller)
661
# View load paths for controller.
666
def view_paths=(value)
667
@template.view_paths = ActionView::Base.process_view_paths(value)
670
# Adds a view_path to the front of the view_paths array.
671
# This change affects the current request only.
673
# self.prepend_view_path("views/default")
674
# self.prepend_view_path(["views/default", "views/custom"])
676
def prepend_view_path(path)
677
@template.view_paths.unshift(*path)
680
# Adds a view_path to the end of the view_paths array.
681
# This change affects the current request only.
683
# self.append_view_path("views/default")
684
# self.append_view_path(["views/default", "views/custom"])
686
def append_view_path(path)
687
@template.view_paths.push(*path)
691
# Renders the content that will be returned to the browser as the response body.
693
# === Rendering an action
695
# Action rendering is the most common form and the type used automatically by Action Controller when nothing else is
696
# specified. By default, actions are rendered within the current layout (if one exists).
698
# # Renders the template for the action "goal" within the current controller
699
# render :action => "goal"
701
# # Renders the template for the action "short_goal" within the current controller,
702
# # but without the current active layout
703
# render :action => "short_goal", :layout => false
705
# # Renders the template for the action "long_goal" within the current controller,
706
# # but with a custom layout
707
# render :action => "long_goal", :layout => "spectacular"
709
# === Rendering partials
711
# Partial rendering in a controller is most commonly used together with Ajax calls that only update one or a few elements on a page
712
# without reloading. Rendering of partials from the controller makes it possible to use the same partial template in
713
# both the full-page rendering (by calling it from within the template) and when sub-page updates happen (from the
714
# controller action responding to Ajax calls). By default, the current layout is not used.
716
# # Renders the same partial with a local variable.
717
# render :partial => "person", :locals => { :name => "david" }
719
# # Renders the partial, making @new_person available through
720
# # the local variable 'person'
721
# render :partial => "person", :object => @new_person
723
# # Renders a collection of the same partial by making each element
724
# # of @winners available through the local variable "person" as it
725
# # builds the complete response.
726
# render :partial => "person", :collection => @winners
728
# # Renders a collection of partials but with a custom local variable name
729
# render :partial => "admin_person", :collection => @winners, :as => :person
731
# # Renders the same collection of partials, but also renders the
732
# # person_divider partial between each person partial.
733
# render :partial => "person", :collection => @winners, :spacer_template => "person_divider"
735
# # Renders a collection of partials located in a view subfolder
736
# # outside of our current controller. In this example we will be
737
# # rendering app/views/shared/_note.r(html|xml) Inside the partial
738
# # each element of @new_notes is available as the local var "note".
739
# render :partial => "shared/note", :collection => @new_notes
741
# # Renders the partial with a status code of 500 (internal error).
742
# render :partial => "broken", :status => 500
744
# Note that the partial filename must also be a valid Ruby variable name,
745
# so e.g. 2005 and register-user are invalid.
748
# == Automatic etagging
750
# Rendering will automatically insert the etag header on 200 OK responses. The etag is calculated using MD5 of the
751
# response body. If a request comes in that has a matching etag, the response will be changed to a 304 Not Modified
752
# and the response body will be set to an empty string. No etag header will be inserted if it's already set.
754
# === Rendering a template
756
# Template rendering works just like action rendering except that it takes a path relative to the template root.
757
# The current layout is automatically applied.
759
# # Renders the template located in [TEMPLATE_ROOT]/weblog/show.r(html|xml) (in Rails, app/views/weblog/show.erb)
760
# render :template => "weblog/show"
762
# # Renders the template with a local variable
763
# render :template => "weblog/show", :locals => {:customer => Customer.new}
765
# === Rendering a file
767
# File rendering works just like action rendering except that it takes a filesystem path. By default, the path
768
# is assumed to be absolute, and the current layout is not applied.
770
# # Renders the template located at the absolute filesystem path
771
# render :file => "/path/to/some/template.erb"
772
# render :file => "c:/path/to/some/template.erb"
774
# # Renders a template within the current layout, and with a 404 status code
775
# render :file => "/path/to/some/template.erb", :layout => true, :status => 404
776
# render :file => "c:/path/to/some/template.erb", :layout => true, :status => 404
780
# Rendering of text is usually used for tests or for rendering prepared content, such as a cache. By default, text
781
# rendering is not done within the active layout.
783
# # Renders the clear text "hello world" with status code 200
784
# render :text => "hello world!"
786
# # Renders the clear text "Explosion!" with status code 500
787
# render :text => "Explosion!", :status => 500
789
# # Renders the clear text "Hi there!" within the current active layout (if one exists)
790
# render :text => "Hi there!", :layout => true
792
# # Renders the clear text "Hi there!" within the layout
793
# # placed in "app/views/layouts/special.r(html|xml)"
794
# render :text => "Hi there!", :layout => "special"
796
# === Streaming data and/or controlling the page generation
798
# The <tt>:text</tt> option can also accept a Proc object, which can be used to:
800
# 1. stream on-the-fly generated data to the browser. Note that you should
801
# use the methods provided by ActionController::Steaming instead if you
802
# want to stream a buffer or a file.
803
# 2. manually control the page generation. This should generally be avoided,
804
# as it violates the separation between code and content, and because almost
805
# everything that can be done with this method can also be done more cleanly
806
# using one of the other rendering methods, most notably templates.
808
# Two arguments are passed to the proc, a <tt>response</tt> object and an
809
# <tt>output</tt> object. The response object is equivalent to the return
810
# value of the ActionController::Base#response method, and can be used to
811
# control various things in the HTTP response, such as setting the
812
# Content-Type header. The output object is an writable <tt>IO</tt>-like
813
# object, so one can call <tt>write</tt> and <tt>flush</tt> on it.
815
# The following example demonstrates how one can stream a large amount of
816
# on-the-fly generated data to the browser:
818
# # Streams about 180 MB of generated data to the browser.
819
# render :text => proc { |response, output|
820
# 10_000_000.times do |i|
821
# output.write("This is line #{i}\n")
827
# # Renders "Hello from code!"
828
# render :text => proc { |response, output| output.write("Hello from code!") }
832
# Rendering XML sets the content type to application/xml.
834
# # Renders '<name>David</name>'
835
# render :xml => {:name => "David"}.to_xml
837
# It's not necessary to call <tt>to_xml</tt> on the object you want to render, since <tt>render</tt> will
838
# automatically do that for you:
840
# # Also renders '<name>David</name>'
841
# render :xml => {:name => "David"}
845
# Rendering JSON sets the content type to application/json and optionally wraps the JSON in a callback. It is expected
846
# that the response will be parsed (or eval'd) for use as a data structure.
848
# # Renders '{"name": "David"}'
849
# render :json => {:name => "David"}.to_json
851
# It's not necessary to call <tt>to_json</tt> on the object you want to render, since <tt>render</tt> will
852
# automatically do that for you:
854
# # Also renders '{"name": "David"}'
855
# render :json => {:name => "David"}
857
# Sometimes the result isn't handled directly by a script (such as when the request comes from a SCRIPT tag),
858
# so the <tt>:callback</tt> option is provided for these cases.
860
# # Renders 'show({"name": "David"})'
861
# render :json => {:name => "David"}.to_json, :callback => 'show'
863
# === Rendering an inline template
865
# Rendering of an inline template works as a cross between text and action rendering where the source for the template
866
# is supplied inline, like text, but its interpreted with ERb or Builder, like action. By default, ERb is used for rendering
867
# and the current layout is not used.
869
# # Renders "hello, hello, hello, again"
870
# render :inline => "<%= 'hello, ' * 3 + 'again' %>"
872
# # Renders "<p>Good seeing you!</p>" using Builder
873
# render :inline => "xml.p { 'Good seeing you!' }", :type => :builder
875
# # Renders "hello david"
876
# render :inline => "<%= 'hello ' + name %>", :locals => { :name => "david" }
878
# === Rendering inline JavaScriptGenerator page updates
880
# In addition to rendering JavaScriptGenerator page updates with Ajax in RJS templates (see ActionView::Base for details),
881
# you can also pass the <tt>:update</tt> parameter to +render+, along with a block, to render page updates inline.
883
# render :update do |page|
884
# page.replace_html 'user_list', :partial => 'user', :collection => @users
885
# page.visual_effect :highlight, 'user_list'
888
# === Rendering vanilla JavaScript
890
# In addition to using RJS with render :update, you can also just render vanilla JavaScript with :js.
892
# # Renders "alert('hello')" and sets the mime type to text/javascript
893
# render :js => "alert('hello')"
895
# === Rendering with status and location headers
896
# All renders take the <tt>:status</tt> and <tt>:location</tt> options and turn them into headers. They can even be used together:
898
# render :xml => post.to_xml, :status => :created, :location => post_url(post)
899
def render(options = nil, extra_options = {}, &block) #:doc:
900
raise DoubleRenderError, "Can only render or redirect once per action" if performed?
902
validate_render_arguments(options, extra_options, block_given?)
905
options = { :template => default_template, :layout => true }
906
elsif options == :update
907
options = extra_options.merge({ :update => true })
908
elsif options.is_a?(String) || options.is_a?(Symbol)
909
case options.to_s.index('/')
911
extra_options[:file] = options
913
extra_options[:action] = options
915
extra_options[:template] = options
918
options = extra_options
919
elsif !options.is_a?(Hash)
920
extra_options[:partial] = options
921
options = extra_options
924
layout = pick_layout(options)
925
response.layout = layout.path_without_format_and_extension if layout
926
logger.info("Rendering template within #{layout.path_without_format_and_extension}") if logger && layout
928
if content_type = options[:content_type]
929
response.content_type = content_type.to_s
932
if location = options[:location]
933
response.headers["Location"] = url_for(location)
936
if options.has_key?(:text)
937
text = layout ? @template.render(options.merge(:text => options[:text], :layout => layout)) : options[:text]
938
render_for_text(text, options[:status])
941
if file = options[:file]
942
render_for_file(file, options[:status], layout, options[:locals] || {})
944
elsif template = options[:template]
945
render_for_file(template, options[:status], layout, options[:locals] || {})
947
elsif inline = options[:inline]
948
render_for_text(@template.render(options.merge(:layout => layout)), options[:status])
950
elsif action_name = options[:action]
951
render_for_file(default_template(action_name.to_s), options[:status], layout)
953
elsif xml = options[:xml]
954
response.content_type ||= Mime::XML
955
render_for_text(xml.respond_to?(:to_xml) ? xml.to_xml : xml, options[:status])
957
elsif js = options[:js]
958
response.content_type ||= Mime::JS
959
render_for_text(js, options[:status])
961
elsif options.include?(:json)
962
json = options[:json]
963
json = ActiveSupport::JSON.encode(json) unless json.is_a?(String)
964
json = "#{options[:callback]}(#{json})" unless options[:callback].blank?
965
response.content_type ||= Mime::JSON
966
render_for_text(json, options[:status])
968
elsif options[:partial]
969
options[:partial] = default_template_name if options[:partial] == true
971
render_for_text(@template.render(:text => @template.render(options), :layout => layout), options[:status])
973
render_for_text(@template.render(options), options[:status])
976
elsif options[:update]
977
@template.send(:_evaluate_assigns_and_ivars)
979
generator = ActionView::Helpers::PrototypeHelper::JavaScriptGenerator.new(@template, &block)
980
response.content_type = Mime::JS
981
render_for_text(generator.to_s, options[:status])
983
elsif options[:nothing]
984
render_for_text(nil, options[:status])
987
render_for_file(default_template, options[:status], layout)
992
# Renders according to the same rules as <tt>render</tt>, but returns the result in a string instead
993
# of sending it as the response body to the browser.
994
def render_to_string(options = nil, &block) #:doc:
995
render(options, &block)
997
response.content_type = nil
999
reset_variables_added_to_assigns
1002
# Return a response that has no content (merely headers). The options
1003
# argument is interpreted to be a hash of header names and values.
1004
# This allows you to easily return a response that consists only of
1005
# significant headers:
1007
# head :created, :location => person_path(@person)
1009
# It can also be used to return exceptional conditions:
1011
# return head(:method_not_allowed) unless request.post?
1012
# return head(:bad_request) unless valid_request?
1016
raise ArgumentError, "too many arguments to head"
1018
raise ArgumentError, "too few arguments to head"
1020
options = args.extract_options!
1021
status = interpret_status(args.shift || options.delete(:status) || :ok)
1023
options.each do |key, value|
1024
headers[key.to_s.dasherize.split(/-/).map { |v| v.capitalize }.join("-")] = value.to_s
1027
render :nothing => true, :status => status
1030
# Clears the rendered results, allowing for another render to be performed.
1031
def erase_render_results #:nodoc:
1033
@performed_render = false
1036
# Clears the redirected results from the headers, resets the status to 200 and returns
1037
# the URL that was used to redirect or nil if there was no redirected URL
1038
# Note that +redirect_to+ will change the body of the response to indicate a redirection.
1039
# The response body is not reset here, see +erase_render_results+
1040
def erase_redirect_results #:nodoc:
1041
@performed_redirect = false
1042
response.redirected_to = nil
1043
response.redirected_to_method_params = nil
1044
response.status = DEFAULT_RENDER_STATUS_CODE
1045
response.headers.delete('Location')
1048
# Erase both render and redirect results
1049
def erase_results #:nodoc:
1050
erase_render_results
1051
erase_redirect_results
1054
def rewrite_options(options) #:nodoc:
1055
if defaults = default_url_options(options)
1056
defaults.merge(options)
1062
# Overwrite to implement a number of default options that all url_for-based methods will use. The default options should come in
1063
# the form of a hash, just like the one you would use for url_for directly. Example:
1065
# def default_url_options(options)
1066
# { :project => @project.active? ? @project.url_name : "unknown" }
1069
# As you can infer from the example, this is mostly useful for situations where you want to centralize dynamic decisions about the
1070
# urls as they stem from the business domain. Please note that any individual url_for call can always override the defaults set
1072
def default_url_options(options = nil)
1075
# Redirects the browser to the target specified in +options+. This parameter can take one of three forms:
1077
# * <tt>Hash</tt> - The URL will be generated by calling url_for with the +options+.
1078
# * <tt>Record</tt> - The URL will be generated by calling url_for with the +options+, which will reference a named URL for that record.
1079
# * <tt>String</tt> starting with <tt>protocol://</tt> (like <tt>http://</tt>) - Is passed straight through as the target for redirection.
1080
# * <tt>String</tt> not containing a protocol - The current protocol and host is prepended to the string.
1081
# * <tt>:back</tt> - Back to the page that issued the request. Useful for forms that are triggered from multiple places.
1082
# Short-hand for <tt>redirect_to(request.env["HTTP_REFERER"])</tt>
1085
# redirect_to :action => "show", :id => 5
1087
# redirect_to "http://www.rubyonrails.org"
1088
# redirect_to "/images/screenshot.jpg"
1089
# redirect_to articles_url
1092
# The redirection happens as a "302 Moved" header unless otherwise specified.
1095
# redirect_to post_url(@post), :status=>:found
1096
# redirect_to :action=>'atom', :status=>:moved_permanently
1097
# redirect_to post_url(@post), :status=>301
1098
# redirect_to :action=>'atom', :status=>302
1100
# When using <tt>redirect_to :back</tt>, if there is no referrer,
1101
# RedirectBackError will be raised. You may specify some fallback
1102
# behavior for this case by rescuing RedirectBackError.
1103
def redirect_to(options = {}, response_status = {}) #:doc:
1104
raise ActionControllerError.new("Cannot redirect to nil!") if options.nil?
1106
if options.is_a?(Hash) && options[:status]
1107
status = options.delete(:status)
1108
elsif response_status[:status]
1109
status = response_status[:status]
1114
response.redirected_to = options
1117
# The scheme name consist of a letter followed by any combination of
1118
# letters, digits, and the plus ("+"), period ("."), or hyphen ("-")
1119
# characters; and is terminated by a colon (":").
1120
when %r{^\w[\w\d+.-]*:.*}
1121
redirect_to_full_url(options, status)
1123
redirect_to_full_url(request.protocol + request.host_with_port + options, status)
1125
if referer = request.headers["Referer"]
1126
redirect_to(referer, :status=>status)
1128
raise RedirectBackError
1131
redirect_to_full_url(url_for(options), status)
1135
def redirect_to_full_url(url, status)
1136
raise DoubleRenderError if performed?
1137
logger.info("Redirected to #{url}") if logger && logger.info?
1138
response.redirect(url, interpret_status(status))
1139
@performed_redirect = true
1142
# Sets the etag and/or last_modified on the response and checks it against
1143
# the client request. If the request doesn't match the options provided, the
1144
# request is considered stale and should be generated from scratch. Otherwise,
1145
# it's fresh and we don't need to generate anything and a reply of "304 Not Modified" is sent.
1149
# * <tt>:last_modified</tt>
1150
# * <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).
1155
# @article = Article.find(params[:id])
1157
# if stale?(:etag => @article, :last_modified => @article.created_at.utc)
1158
# @statistics = @article.really_expensive_call
1159
# respond_to do |format|
1160
# # all the supported formats
1166
!request.fresh?(response)
1169
# Sets the etag, last_modified, or both on the response and renders a
1170
# "304 Not Modified" response if the request is already fresh.
1174
# * <tt>:last_modified</tt>
1175
# * <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).
1180
# @article = Article.find(params[:id])
1181
# fresh_when(:etag => @article, :last_modified => @article.created_at.utc, :public => true)
1184
# This will render the show template if the request isn't sending a matching etag or
1185
# If-Modified-Since header and just a "304 Not Modified" response if there's a match.
1187
def fresh_when(options)
1188
options.assert_valid_keys(:etag, :last_modified, :public)
1190
response.etag = options[:etag] if options[:etag]
1191
response.last_modified = options[:last_modified] if options[:last_modified]
1194
cache_control = response.headers["Cache-Control"].split(",").map {|k| k.strip }
1195
cache_control.delete("private")
1196
cache_control.delete("no-cache")
1197
cache_control << "public"
1198
response.headers["Cache-Control"] = cache_control.join(', ')
1201
if request.fresh?(response)
1206
# Sets a HTTP 1.1 Cache-Control header. Defaults to issuing a "private" instruction, so that
1207
# intermediate caches shouldn't cache the response.
1210
# expires_in 20.minutes
1211
# expires_in 3.hours, :public => true
1212
# expires in 3.hours, 'max-stale' => 5.hours, :public => true
1214
# This method will overwrite an existing Cache-Control header.
1215
# See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html for more possibilities.
1216
def expires_in(seconds, options = {}) #:doc:
1217
cache_control = response.headers["Cache-Control"].split(",").map {|k| k.strip }
1219
cache_control << "max-age=#{seconds}"
1220
cache_control.delete("no-cache")
1222
cache_control.delete("private")
1223
cache_control << "public"
1225
cache_control << "private"
1228
# This allows for additional headers to be passed through like 'max-stale' => 5.hours
1229
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}"}
1231
response.headers["Cache-Control"] = cache_control.join(', ')
1234
# Sets a HTTP 1.1 Cache-Control header of "no-cache" so no caching should occur by the browser or
1235
# intermediate caches (like caching proxy servers).
1236
def expires_now #:doc:
1237
response.headers["Cache-Control"] = "no-cache"
1240
# Resets the session by clearing out all the objects stored within and initializing a new session object.
1241
def reset_session #:doc:
1242
request.reset_session
1243
@_session = request.session
1247
def render_for_file(template_path, status = nil, layout = nil, locals = {}) #:nodoc:
1248
path = template_path.respond_to?(:path_without_format_and_extension) ? template_path.path_without_format_and_extension : template_path
1249
logger.info("Rendering #{path}" + (status ? " (#{status})" : '')) if logger
1250
render_for_text @template.render(:file => template_path, :locals => locals, :layout => layout), status
1253
def render_for_text(text = nil, status = nil, append_response = false) #:nodoc:
1254
@performed_render = true
1256
response.status = interpret_status(status || DEFAULT_RENDER_STATUS_CODE)
1259
response.body ||= ''
1260
response.body << text.to_s
1262
response.body = case text
1264
when nil then " " # Safari doesn't pass the headers of the return if the response is zero length
1270
def validate_render_arguments(options, extra_options, has_block)
1271
if options && (has_block && options != :update) && !options.is_a?(String) && !options.is_a?(Hash) && !options.is_a?(Symbol)
1272
raise RenderError, "You called render with invalid options : #{options.inspect}"
1275
if !extra_options.is_a?(Hash)
1276
raise RenderError, "You called render with invalid options : #{options.inspect}, #{extra_options.inspect}"
1280
def initialize_template_class(response)
1281
response.template = ActionView::Base.new(self.class.view_paths, {}, self)
1282
response.template.helpers.send :include, self.class.master_helper_module
1283
response.redirected_to = nil
1284
@performed_render = @performed_redirect = false
1287
def assign_shortcuts(request, response)
1288
@_request, @_params = request, request.parameters
1290
@_response = response
1291
@_response.session = request.session
1293
@_session = @_response.session
1294
@template = @_response.template
1296
@_headers = @_response.headers
1299
def initialize_current_url
1300
@url = UrlRewriter.new(request, params.clone)
1304
if logger && logger.info?
1305
log_processing_for_request_id
1306
log_processing_for_parameters
1310
def log_processing_for_request_id
1311
request_id = "\n\nProcessing #{self.class.name}\##{action_name} "
1312
request_id << "to #{params[:format]} " if params[:format]
1313
request_id << "(for #{request_origin}) [#{request.method.to_s.upcase}]"
1315
logger.info(request_id)
1318
def log_processing_for_parameters
1319
parameters = respond_to?(:filter_parameters) ? filter_parameters(params) : params.dup
1320
parameters = parameters.except!(:controller, :action, :format, :_method)
1322
logger.info " Parameters: #{parameters.inspect}" unless parameters.empty?
1325
def default_render #:nodoc:
1330
if action_methods.include?(action_name)
1332
default_render unless performed?
1333
elsif respond_to? :method_missing
1334
method_missing action_name
1335
default_render unless performed?
1339
rescue ActionView::MissingTemplate => e
1340
# Was the implicit template missing, or was it another template?
1341
if e.path == default_template_name
1342
raise UnknownAction, "No action responded to #{action_name}. Actions: #{action_methods.sort.to_sentence(:locale => :en)}", caller
1351
@performed_render || @performed_redirect
1355
@action_name = (params['action'] || 'index')
1359
self.class.action_methods
1362
def self.action_methods
1364
# All public instance methods of this class, including ancestors
1365
public_instance_methods(true).map { |m| m.to_s }.to_set -
1366
# Except for public instance methods of Base and its ancestors
1367
Base.public_instance_methods(true).map { |m| m.to_s } +
1368
# Be sure to include shadowed public instance methods of this class
1369
public_instance_methods(false).map { |m| m.to_s } -
1370
# And always exclude explicitly hidden actions
1374
def reset_variables_added_to_assigns
1375
@template.instance_variable_set("@assigns_added", nil)
1379
# this *needs* to be cached!
1380
# otherwise you'd get different results if calling it more than once
1381
@request_origin ||= "#{request.remote_ip} at #{Time.now.to_s(:db)}"
1384
def complete_request_uri
1385
"#{request.protocol}#{request.host}#{request.request_uri}"
1388
def default_template(action_name = self.action_name)
1389
self.view_paths.find_template(default_template_name(action_name), default_template_format)
1392
def default_template_name(action_name = self.action_name)
1394
action_name = action_name.to_s
1395
if action_name.include?('/') && template_path_includes_controller?(action_name)
1396
action_name = strip_out_controller(action_name)
1399
"#{self.controller_path}/#{action_name}"
1402
def strip_out_controller(path)
1403
path.split('/', 2).last
1406
def template_path_includes_controller?(path)
1407
self.controller_path.split('/')[-1] == path.split('/')[0]
1415
[ Filters, Layout, Benchmarking, Rescue, Flash, MimeResponds, Helpers,
1416
Cookies, Caching, Verification, Streaming, SessionManagement,
1417
HttpAuthentication::Basic::ControllerMethods, HttpAuthentication::Digest::ControllerMethods,
1418
RecordIdentifier, RequestForgeryProtection, Translation
added
removed
vendor/rails/actionpack/lib/action_controller/base.rb
