2006-03-10 20:23:29 -05:00
require 'action_controller/mime_type'
2004-11-23 20:04:44 -05:00
require 'action_controller/request'
require 'action_controller/response'
2005-02-14 20:45:35 -05:00
require 'action_controller/routing'
2006-07-31 14:59:58 -04:00
require 'action_controller/resources'
2004-11-23 20:04:44 -05:00
require 'action_controller/url_rewriter'
2006-09-28 15:13:55 -04:00
require 'action_controller/status_codes'
2005-01-08 18:32:11 -05:00
require 'drb'
2005-10-20 17:59:48 -04:00
require 'set'
2004-11-23 20:04:44 -05:00
module ActionController #:nodoc:
class ActionControllerError < StandardError #:nodoc:
end
class SessionRestoreError < ActionControllerError #:nodoc:
end
class MissingTemplate < ActionControllerError #:nodoc:
end
2005-06-24 12:40:01 -04:00
class RoutingError < ActionControllerError #:nodoc:
2005-02-14 20:45:35 -05:00
attr_reader :failures
def initialize ( message , failures = [ ] )
super ( message )
@failures = failures
end
end
class UnknownController < ActionControllerError #:nodoc:
end
2004-11-23 20:04:44 -05:00
class UnknownAction < ActionControllerError #:nodoc:
end
2005-01-01 11:29:11 -05:00
class MissingFile < ActionControllerError #:nodoc:
end
2006-08-29 20:34:36 -04:00
class RenderError < ActionControllerError #:nodoc:
end
2005-10-15 10:39:29 -04:00
class SessionOverflowError < ActionControllerError #:nodoc:
DEFAULT_MESSAGE = 'Your session data is larger than the data column in which it is to be stored. You must increase the size of your data column if you intend to store large data.'
2005-11-08 20:03:24 -05:00
def initialize ( message = nil )
super ( message || DEFAULT_MESSAGE )
end
2005-10-15 10:39:29 -04:00
end
2005-05-21 14:51:08 -04:00
class DoubleRenderError < ActionControllerError #:nodoc:
2006-09-04 00:58:08 -04:00
DEFAULT_MESSAGE = " Render and/or redirect were called multiple times in this action. Please note that you may only call render OR redirect, and only once per action. Also note that neither redirect nor render terminate execution of the action, so if you want to exit an action after redirecting, you need to do something like \" redirect_to(...) and return \" . Finally, note that to cause a before filter to halt execution of the rest of the filter chain, the filter must return false, explicitly, so \" render(...) and return false \" . "
2005-07-09 11:31:06 -04:00
2005-11-08 20:03:24 -05:00
def initialize ( message = nil )
2005-07-09 11:31:06 -04:00
super ( message || DEFAULT_MESSAGE )
end
2005-05-21 14:51:08 -04:00
end
2006-01-21 20:52:23 -05:00
class RedirectBackError < ActionControllerError #:nodoc:
2006-08-07 02:11:56 -04:00
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"].'
2006-01-21 20:52:23 -05:00
def initialize ( message = nil )
super ( message || DEFAULT_MESSAGE )
end
end
2004-11-23 20:04:44 -05:00
2006-09-04 00:58:08 -04:00
# Action Controllers are the core of a web request in Rails. They are made up of one or more actions that are executed
2006-04-27 14:22:20 -04:00
# on request and then either render a template or redirect to another action. An action is defined as a public method
2006-09-04 00:58:08 -04:00
# on the controller, which will automatically be made accessible to the web-server through Rails Routes.
2006-04-27 14:22:20 -04:00
#
# A sample controller could look like this:
2004-11-23 20:04:44 -05:00
#
# class GuestBookController < ActionController::Base
# def index
2006-04-27 14:22:20 -04:00
# @entries = Entry.find(:all)
2004-11-23 20:04:44 -05:00
# end
2006-08-07 02:11:56 -04:00
#
2004-11-23 20:04:44 -05:00
# def sign
2005-10-16 11:42:03 -04:00
# Entry.create(params[:entry])
2004-11-23 20:04:44 -05:00
# redirect_to :action => "index"
# end
# end
#
2006-04-27 14:22:20 -04:00
# Actions, by default, render a template in the <tt>app/views</tt> directory corresponding to the name of the controller and action
2006-09-04 00:58:08 -04:00
# after executing code in the action. For example, the +index+ action of the +GuestBookController+ would render the
2007-02-20 17:09:12 -05:00
# template <tt>app/views/guestbook/index.erb</tt> by default after populating the <tt>@entries</tt> instance variable.
2004-11-23 20:04:44 -05:00
#
2006-09-04 00:58:08 -04:00
# Unlike index, the sign action will not render a template. After performing its main purpose (creating a
# new entry in the guest book), it initiates a redirect instead. This redirect works by returning an external
2006-04-27 14:22:20 -04:00
# "302 Moved" HTTP response that takes the user to the index action.
2004-11-23 20:04:44 -05:00
#
# The index and sign represent the two basic action archetypes used in Action Controllers. Get-and-show and do-and-redirect.
# Most actions are variations of these themes.
#
# == Requests
#
# Requests are processed by the Action Controller framework by extracting the value of the "action" key in the request parameters.
# This value should hold the name of the action to be performed. Once the action has been identified, the remaining
# request parameters, the session (if one is available), and the full request with all the http headers are made available to
# the action through instance variables. Then the action is performed.
#
2005-07-06 04:27:11 -04:00
# The full request object is available with the request accessor and is primarily used to query for http headers. These queries
# are made by accessing the environment hash, like this:
2004-11-23 20:04:44 -05:00
#
2006-05-17 15:52:06 -04:00
# def server_ip
# location = request.env["SERVER_ADDR"]
# render :text => "This server hosted at #{location}"
2004-11-23 20:04:44 -05:00
# end
#
# == Parameters
#
2006-04-27 14:22:20 -04:00
# All request parameters, whether they come from a GET or POST request, or from the URL, are available through the params method
2006-09-04 00:58:08 -04:00
# which returns a hash. For example, an action that was performed through <tt>/weblog/list?category=All&limit=5</tt> will include
2006-04-27 14:22:20 -04:00
# <tt>{ "category" => "All", "limit" => 5 }</tt> in params.
2004-11-23 20:04:44 -05:00
#
# It's also possible to construct multi-dimensional parameter hashes by specifying keys using brackets, such as:
#
# <input type="text" name="post[name]" value="david">
# <input type="text" name="post[address]" value="hyacintvej">
#
2005-02-23 20:29:43 -05:00
# A request stemming from a form holding these inputs will include <tt>{ "post" => { "name" => "david", "address" => "hyacintvej" } }</tt>.
2006-09-04 00:58:08 -04:00
# If the address input had been named "post[address][street]", the params would have included
2005-02-23 20:29:43 -05:00
# <tt>{ "post" => { "address" => { "street" => "hyacintvej" } } }</tt>. There's no limit to the depth of the nesting.
2004-11-23 20:04:44 -05:00
#
# == Sessions
#
2006-04-27 14:22:20 -04:00
# Sessions allows you to store objects in between requests. This is useful for objects that are not yet ready to be persisted,
2004-11-23 20:04:44 -05:00
# 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
2006-09-04 00:58:08 -04:00
# 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
2004-11-23 20:04:44 -05:00
# they could be changed unknowingly. It's usually too much work to keep it all synchronized -- something databases already excel at.
#
2006-04-27 14:22:20 -04:00
# You can place objects in the session by using the <tt>session</tt> method, which accesses a hash:
2004-11-23 20:04:44 -05:00
#
2005-07-06 04:27:11 -04:00
# session[:person] = Person.authenticate(user_name, password)
2004-11-23 20:04:44 -05:00
#
# And retrieved again through the same hash:
#
2005-07-06 04:27:11 -04:00
# Hello #{session[:person]}
2004-11-23 20:04:44 -05:00
#
2005-09-01 17:54:29 -04:00
# For removing objects from the session, you can either assign a single key to nil, like <tt>session[:person] = nil</tt>, or you can
2005-03-20 08:34:07 -05:00
# remove the entire session with reset_session.
#
2006-09-04 00:58:08 -04:00
# By default, sessions are stored on the file system in <tt>RAILS_ROOT/tmp/sessions</tt>. Any object can be placed in the session
2006-04-27 14:22:20 -04:00
# (as long as it can be Marshalled). But remember that 1000 active sessions each storing a 50kb object could lead to a 50MB store on the filesystem.
# In other words, think carefully about size and caching before resorting to the use of the session on the filesystem.
#
# An alternative to storing sessions on disk is to use ActiveRecordStore to store sessions in your database, which can solve problems
# caused by storing sessions in the file system and may speed up your application. To use ActiveRecordStore, uncomment the line:
2006-09-04 00:58:08 -04:00
#
2006-04-27 14:22:20 -04:00
# config.action_controller.session_store = :active_record_store
#
# in your <tt>environment.rb</tt> and run <tt>rake db:sessions:create</tt>.
#
2004-11-23 20:04:44 -05:00
# == Responses
#
# Each action results in a response, which holds the headers and document to be sent to the user's browser. The actual response
2006-04-27 14:22:20 -04:00
# object is generated automatically through the use of renders and redirects and requires no user intervention.
2004-11-23 20:04:44 -05:00
#
# == Renders
#
# Action Controller sends content to the user by using one of five rendering methods. The most versatile and common is the rendering
# of a template. Included in the Action Pack is the Action View, which enables rendering of ERb templates. It's automatically configured.
# The controller passes objects to the view by assigning instance variables:
#
# def show
2005-07-06 04:27:11 -04:00
# @post = Post.find(params[:id])
2004-11-23 20:04:44 -05:00
# end
#
# Which are then automatically available to the view:
#
# Title: <%= @post.title %>
#
# You don't have to rely on the automated rendering. Especially actions that could result in the rendering of different templates will use
# the manual rendering methods:
#
# def search
2005-07-06 04:27:11 -04:00
# @results = Search.find(params[:query])
2004-11-23 20:04:44 -05:00
# case @results
2006-04-27 14:22:20 -04:00
# when 0 then render :action => "no_results"
# when 1 then render :action => "show"
# when 2..10 then render :action => "show_many"
2004-11-23 20:04:44 -05:00
# end
# end
#
# Read more about writing ERb and Builder templates in link:classes/ActionView/Base.html.
#
# == Redirects
#
2006-04-27 14:22:20 -04:00
# Redirects are used to move from one action to another. For example, after a <tt>create</tt> action, which stores a blog entry to a database,
# we might like to show the user the new entry. Because we're following good DRY principles (Don't Repeat Yourself), we're going to reuse (and redirect to)
# a <tt>show</tt> action that we'll assume has already been created. The code might look like this:
#
# def create
# @entry = Entry.new(params[:entry])
# if @entry.save
# # The entry was saved correctly, redirect to show
# redirect_to :action => 'show', :id => @entry.id
# else
# # things didn't go so well, do something else
# end
# end
2004-11-23 20:04:44 -05:00
#
2006-04-27 14:22:20 -04:00
# 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.
2004-11-23 20:04:44 -05:00
#
2005-01-20 09:13:34 -05:00
# == Calling multiple redirects or renders
#
2005-10-26 09:20:46 -04:00
# An action should conclude with a single render or redirect. Attempting to try to do either again will result in a DoubleRenderError:
2005-01-20 09:13:34 -05:00
#
# def do_something
# redirect_to :action => "elsewhere"
2005-07-10 01:26:55 -04:00
# render :action => "overthere" # raises DoubleRenderError
2005-01-20 09:13:34 -05:00
# end
#
2005-07-10 01:26:55 -04:00
# If you need to redirect on the condition of something, then be sure to add "and return" to halt execution.
2005-01-20 09:13:34 -05:00
#
2005-07-10 01:26:55 -04:00
# def do_something
# redirect_to(:action => "elsewhere") and return if monkeys.nil?
# render :action => "overthere" # won't be called unless monkeys is nil
2005-09-01 17:54:29 -04:00
# end
#
2004-11-23 20:04:44 -05:00
class Base
DEFAULT_RENDER_STATUS_CODE = " 200 OK "
2006-09-04 00:58:08 -04:00
2006-08-08 17:21:04 -04:00
include Reloadable :: Deprecated
2006-09-28 15:13:55 -04:00
include StatusCodes
2006-09-04 00:58:08 -04:00
2004-11-23 20:04:44 -05:00
# Determines whether the view has access to controller internals @request, @response, @session, and @template.
# By default, it does.
@@view_controller_internals = true
cattr_accessor :view_controller_internals
2005-07-23 05:00:05 -04:00
# Protected instance variable cache
@@protected_variables_cache = nil
cattr_accessor :protected_variables_cache
2006-09-04 00:58:08 -04:00
# Prepends all the URL-generating helpers from AssetHelper. This makes it possible to easily move javascripts, stylesheets,
# and images to a dedicated asset server away from the main web server. Example:
2005-05-06 01:10:36 -04:00
# ActionController::Base.asset_host = "http://assets.example.com"
@@asset_host = " "
cattr_accessor :asset_host
2004-11-23 20:04:44 -05:00
# All requests are considered local by default, so everyone will be exposed to detailed debugging screens on errors.
# When the application is ready to go public, this should be set to false, and the protected method <tt>local_request?</tt>
# should instead be implemented in the controller to determine when debugging screens should be shown.
@@consider_all_requests_local = true
cattr_accessor :consider_all_requests_local
2006-09-04 00:58:08 -04:00
2005-02-14 20:45:35 -05:00
# Enable or disable the collection of failure information for RoutingErrors.
# This information can be extremely useful when tweaking custom routes, but is
# pointless once routes have been tested and verified.
@@debug_routes = true
cattr_accessor :debug_routes
2004-11-23 20:04:44 -05:00
2005-10-26 09:20:46 -04:00
# Controls whether the application is thread-safe, so multi-threaded servers like WEBrick know whether to apply a mutex
2005-06-23 02:56:12 -04:00
# around the performance of each action. Action Pack and Active Record are by default thread-safe, but many applications
# may not be. Turned off by default.
@@allow_concurrency = false
cattr_accessor :allow_concurrency
2006-09-04 00:58:08 -04:00
# Modern REST web services often need to submit complex data to the web application.
2006-09-04 12:47:48 -04:00
# The param_parsers hash lets you register handlers which will process the http body and add parameters to the
2006-04-25 13:42:48 -04:00
# <tt>params</tt> hash. These handlers are invoked for post and put requests.
2006-03-05 13:59:58 -05:00
#
2006-09-04 00:58:08 -04:00
# By default application/xml is enabled. A XmlSimple class with the same param name as the root will be instanciated
2006-04-25 13:42:48 -04:00
# in the <tt>params</tt>. This allows XML requests to mask themselves as regular form submissions, so you can have one
2006-04-04 15:28:25 -04:00
# action serve both regular forms and web service requests.
2006-09-04 00:58:08 -04:00
#
2006-03-06 23:42:13 -05:00
# Example of doing your own parser for a custom content type:
2006-03-05 13:59:58 -05:00
#
2006-09-04 00:58:08 -04:00
# ActionController::Base.param_parsers[Mime::Type.lookup('application/atom+xml')] = Proc.new do |data|
# node = REXML::Document.new(post)
2006-03-05 13:59:58 -05:00
# { node.root.name => node.root }
# end
#
2006-09-04 00:58:08 -04:00
# Note: Up until release 1.1 of Rails, Action Controller would default to using XmlSimple configured to discard the
2006-03-06 23:42:13 -05:00
# root node for such requests. The new default is to keep the root, such that "<r><name>David</name></r>" results
2006-09-04 00:58:08 -04:00
# in params[:r][:name] for "David" instead of params[:name]. To get the old behavior, you can
2006-03-25 13:44:28 -05:00
# re-register XmlSimple as application/xml handler ike this:
2006-03-05 13:59:58 -05:00
#
2006-09-04 00:58:08 -04:00
# ActionController::Base.param_parsers[Mime::XML] =
2006-03-06 23:42:13 -05:00
# Proc.new { |data| XmlSimple.xml_in(data, 'ForceArray' => false) }
2006-04-04 15:28:25 -04:00
#
# A YAML parser is also available and can be turned on with:
#
# ActionController::Base.param_parsers[Mime::YAML] = :yaml
@@param_parsers = { Mime :: XML = > :xml_simple }
2006-09-04 00:58:08 -04:00
cattr_accessor :param_parsers
2006-03-05 13:59:58 -05:00
2006-09-17 12:20:32 -04:00
# Controls the default charset for all renders.
@@default_charset = " utf-8 "
cattr_accessor :default_charset
2007-02-04 15:47:05 -05:00
2004-11-23 20:04:44 -05:00
# The logger is used for generating information on the action run-time (including benchmarking) if available.
# Can be set to nil for no logging. Compatible with both Ruby's own Logger and Log4r loggers.
cattr_accessor :logger
2006-09-04 00:58:08 -04:00
2004-11-23 20:04:44 -05:00
# Determines which template class should be used by ActionController.
cattr_accessor :template_class
# Turn on +ignore_missing_templates+ if you want to unit test actions without making the associated templates.
cattr_accessor :ignore_missing_templates
# Holds the request object that's primarily used to get environment variables through access like
2005-04-16 12:08:29 -04:00
# <tt>request.env["REQUEST_URI"]</tt>.
2006-09-29 03:34:02 -04:00
attr_internal :request
2006-08-07 08:40:14 -04:00
2005-09-01 17:54:29 -04:00
# Holds a hash of all the GET, POST, and Url parameters passed to the action. Accessed like <tt>params["post_id"]</tt>
2004-11-23 20:04:44 -05:00
# to get the post_id. No type casts are made, so all values are returned as strings.
2006-08-07 08:40:14 -04:00
attr_internal :params
2006-09-04 00:58:08 -04:00
# Holds the response object that's primarily used to set additional HTTP headers through access like
2005-04-16 12:08:29 -04:00
# <tt>response.headers["Cache-Control"] = "no-cache"</tt>. Can also be used to access the final body HTML after a template
# has been rendered through response.body -- useful for <tt>after_filter</tt>s that wants to manipulate the output,
2004-11-23 20:04:44 -05:00
# such as a OutputCompressionFilter.
2006-09-29 04:26:45 -04:00
attr_internal :response
2006-08-07 08:40:14 -04:00
2005-04-16 12:08:29 -04:00
# Holds a hash of objects in the session. Accessed like <tt>session[:person]</tt> to get the object tied to the "person"
2005-10-26 09:20:46 -04:00
# key. The session will hold any type of object as values, but the key should be a string or symbol.
2006-08-07 02:11:56 -04:00
attr_internal :session
2005-04-16 12:08:29 -04:00
# Holds a hash of header names and values. Accessed like <tt>headers["Cache-Control"]</tt> to get the value of the Cache-Control
2004-11-23 20:04:44 -05:00
# directive. Values should always be specified as strings.
2006-09-29 04:12:16 -04:00
attr_internal :headers
2006-09-04 00:58:08 -04:00
2004-11-23 20:04:44 -05:00
# Holds the hash of variables that are passed on to the template class to be made available to the view. This hash
# is generated by taking a snapshot of all the instance variables in the current scope just before a template is rendered.
attr_accessor :assigns
2005-07-04 21:30:44 -04:00
# Returns the name of the action this controller is processing.
attr_accessor :action_name
2006-09-04 00:58:08 -04:00
2006-09-15 21:31:17 -04:00
# Templates that are exempt from layouts
@@exempt_from_layout = Set . new ( [ / \ .rjs$ / ] )
2004-11-23 20:04:44 -05:00
class << self
# Factory for the standard create, process loop where the controller is discarded after processing.
2006-02-12 00:51:02 -05:00
def process ( request , response ) #:nodoc:
new . process ( request , response )
2004-11-23 20:04:44 -05:00
end
2006-09-04 00:58:08 -04:00
2004-11-23 20:04:44 -05:00
# Converts the class name from something like "OneModule::TwoModule::NeatController" to "NeatController".
def controller_class_name
2005-07-04 21:30:49 -04:00
@controller_class_name || = name . demodulize
2004-11-23 20:04:44 -05:00
end
# Converts the class name from something like "OneModule::TwoModule::NeatController" to "neat".
def controller_name
2005-07-04 21:30:49 -04:00
@controller_name || = controller_class_name . sub ( / Controller$ / , '' ) . underscore
2004-11-23 20:04:44 -05:00
end
2006-09-04 00:58:08 -04:00
2005-10-26 09:20:46 -04:00
# Converts the class name from something like "OneModule::TwoModule::NeatController" to "one_module/two_module/neat".
2005-02-14 20:45:35 -05:00
def controller_path
2006-03-13 10:54:33 -05:00
@controller_path || = name . gsub ( / Controller$ / , '' ) . underscore
2005-02-14 20:45:35 -05:00
end
2005-02-17 13:59:51 -05:00
# Return an array containing the names of public methods that have been marked hidden from the action processor.
# By default, all methods defined in ActionController::Base and included modules are hidden.
2006-02-11 19:46:01 -05:00
# More methods can be hidden using <tt>hide_actions</tt>.
2005-02-17 13:59:51 -05:00
def hidden_actions
write_inheritable_attribute ( :hidden_actions , ActionController :: Base . public_instance_methods ) unless read_inheritable_attribute ( :hidden_actions )
read_inheritable_attribute ( :hidden_actions )
end
# Hide each of the given methods from being callable as actions.
2005-02-23 07:53:08 -05:00
def hide_action ( * names )
2006-02-11 19:46:01 -05:00
write_inheritable_attribute ( :hidden_actions , hidden_actions | names . collect { | n | n . to_s } )
2005-02-20 08:50:13 -05:00
end
2007-02-04 15:47:05 -05:00
# Deprecated. Use view_paths instead.
def template_root = ( path )
2007-02-04 17:27:45 -05:00
prepend_view_path path
template_root
2007-02-04 15:47:05 -05:00
end
# Deprecated. Use view_paths instead.
def template_root
view_paths . first
end
deprecate :template_root = > :view_paths
@@view_paths = { }
# View load paths determine the bases from which template references can be made. So a call to
# render("test/template") will be looked up in the view load paths array and the closest match will be
# returned.
def view_paths = ( value )
@@view_paths [ name ] = value
end
2007-02-04 17:27:45 -05:00
2007-02-04 15:47:05 -05:00
# View load paths for controller.
def view_paths
if paths = @@view_paths [ name ]
paths
else
if superclass . respond_to? ( :view_paths )
superclass . view_paths . dup . freeze
else
@@view_paths [ name ] = [ ]
end
end
end
2007-02-04 17:27:45 -05:00
# Adds a view_path to the front of the view_paths array.
# If the current class has no view paths, copy them from
# the superclass
def prepend_view_path ( path )
self . view_paths = view_paths . dup if view_paths . frozen?
view_paths . unshift ( path )
end
# Adds a view_path to the end of the view_paths array.
# If the current class has no view paths, copy them from
# the superclass
def append_view_path ( path )
self . view_paths = view_paths . dup if view_paths . frozen?
view_paths << path
end
2006-04-07 18:26:25 -04:00
# Replace sensitive paramater data from the request log.
# Filters paramaters that have any of the arguments as a substring.
# Looks in all subhashes of the param hash for keys to filter.
# If a block is given, each key and value of the paramater hash and all
# subhashes is passed to it, the value or key
# can be replaced using String#replace or similar method.
#
# Examples:
# filter_parameter_logging
# => Does nothing, just slows the logging process down
#
# filter_parameter_logging :password
# => replaces the value to all keys matching /password/i with "[FILTERED]"
#
# filter_parameter_logging :foo, "bar"
# => replaces the value to all keys matching /foo|bar/i with "[FILTERED]"
#
# filter_parameter_logging { |k,v| v.reverse! if k =~ /secret/i }
# => reverses the value to all keys matching /secret/i
#
# filter_parameter_logging(:foo, "bar") { |k,v| v.reverse! if k =~ /secret/i }
2006-09-04 00:58:08 -04:00
# => reverses the value to all keys matching /secret/i, and
2006-04-07 18:26:25 -04:00
# replaces the value to all keys matching /foo|bar/i with "[FILTERED]"
def filter_parameter_logging ( * filter_words , & block )
parameter_filter = Regexp . new ( filter_words . collect { | s | s . to_s } . join ( '|' ) , true ) if filter_words . length > 0
2006-04-29 13:47:10 -04:00
define_method ( :filter_parameters ) do | unfiltered_parameters |
filtered_parameters = { }
2006-04-07 18:26:25 -04:00
2006-04-29 13:47:10 -04:00
unfiltered_parameters . each do | key , value |
if key =~ parameter_filter
filtered_parameters [ key ] = '[FILTERED]'
elsif value . is_a? ( Hash )
2006-09-04 00:58:08 -04:00
filtered_parameters [ key ] = filter_parameters ( value )
2006-04-29 13:47:10 -04:00
elsif block_given?
key , value = key . dup , value . dup
yield key , value
filtered_parameters [ key ] = value
2006-09-04 00:58:08 -04:00
else
2006-04-29 13:47:10 -04:00
filtered_parameters [ key ] = value
2006-04-07 18:26:25 -04:00
end
2006-04-29 12:34:23 -04:00
end
2006-04-29 13:47:10 -04:00
filtered_parameters
2006-04-07 18:26:25 -04:00
end
end
2006-09-15 21:31:17 -04:00
# Don't render layouts for templates with the given extensions.
def exempt_from_layout ( * extensions )
regexps = extensions . collect do | extension |
extension . is_a? ( Regexp ) ? extension : / \ . #{ Regexp . escape ( extension . to_s ) } $ /
end
@@exempt_from_layout . merge regexps
end
2004-11-23 20:04:44 -05:00
end
2006-09-04 00:58:08 -04:00
public
2004-11-23 20:04:44 -05:00
# Extracts the action_name from the request parameters and performs that action.
2004-12-06 13:25:01 -05:00
def process ( request , response , method = :perform_action , * arguments ) #:nodoc:
2004-11-23 20:04:44 -05:00
initialize_template_class ( response )
assign_shortcuts ( request , response )
initialize_current_url
2006-03-19 23:01:10 -05:00
assign_names
2006-02-12 00:51:02 -05:00
forget_variables_added_to_assigns
2006-09-04 00:58:08 -04:00
2006-02-12 00:51:02 -05:00
log_processing
2004-12-06 13:25:01 -05:00
send ( method , * arguments )
2006-09-04 00:58:08 -04:00
2006-09-17 12:20:32 -04:00
assign_default_content_type_and_charset
2007-02-18 19:27:19 -05:00
response . request = request
response . prepare!
2006-03-19 23:01:10 -05:00
response
2005-11-01 20:23:34 -05:00
ensure
2006-02-12 00:51:02 -05:00
process_cleanup
2004-11-23 20:04:44 -05:00
end
2006-09-04 00:58:08 -04:00
# Returns a URL that has been rewritten according to the options hash and the defined Routes.
2005-02-23 09:05:00 -05:00
# (For doing a complete redirect, use redirect_to).
2006-01-20 17:04:07 -05:00
#
2005-02-23 09:05:00 -05:00
# <tt>url_for</tt> is used to:
2006-01-20 17:04:07 -05:00
#
2005-10-26 09:20:46 -04:00
# All keys given to url_for are forwarded to the Route module, save for the following:
2006-09-04 00:58:08 -04:00
# * <tt>:anchor</tt> -- specifies the anchor name to be appended to the path. For example,
# <tt>url_for :controller => 'posts', :action => 'show', :id => 10, :anchor => 'comments'</tt>
2005-02-23 09:05:00 -05:00
# will produce "/posts/show/10#comments".
2006-05-14 15:03:14 -04:00
# * <tt>:only_path</tt> -- if true, returns the relative URL (omitting the protocol, host name, and port) (<tt>false</tt> by default)
2005-03-26 08:38:21 -05:00
# * <tt>:trailing_slash</tt> -- if true, adds a trailing slash, as in "/archive/2005/". Note that this
# is currently not recommended since it breaks caching.
2005-02-23 09:05:00 -05:00
# * <tt>:host</tt> -- overrides the default (current) host if provided
# * <tt>:protocol</tt> -- overrides the default (current) protocol if provided
2007-03-03 17:19:54 -05:00
# * <tt>:user</tt> -- Inline HTTP authentication (only plucked out if :password is also present)
# * <tt>:password</tt> -- Inline HTTP authentication (only plucked out if :user is also present)
2005-02-23 20:29:43 -05:00
#
2005-02-23 09:57:08 -05:00
# The URL is generated from the remaining keys in the hash. A URL contains two key parts: the <base> and a query string.
# Routes composes a query string as the key/value pairs not included in the <base>.
2005-02-23 20:29:43 -05:00
#
2005-02-23 09:05:00 -05:00
# The default Routes setup supports a typical Rails path of "controller/action/id" where action and id are optional, with
# action defaulting to 'index' when not given. Here are some typical url_for statements and their corresponding URLs:
2006-01-20 17:04:07 -05:00
#
2007-03-03 17:19:54 -05:00
# url_for :controller => 'posts', :action => 'recent' # => 'proto://host.com/posts/recent'
# url_for :controller => 'posts', :action => 'index' # => 'proto://host.com/posts'
# url_for :controller => 'posts', :action => 'show', :id => 10 # => 'proto://host.com/posts/show/10'
# url_for :controller => 'posts', :user => 'd', :password => '123' # => 'proto://d:123@host.com/posts'
2005-02-23 20:29:43 -05:00
#
2005-02-23 09:05:00 -05:00
# When generating a new URL, missing values may be filled in from the current request's parameters. For example,
# <tt>url_for :action => 'some_action'</tt> will retain the current controller, as expected. This behavior extends to
# other parameters, including <tt>:controller</tt>, <tt>:id</tt>, and any other parameters that are placed into a Route's
# path.
2006-01-20 17:04:07 -05:00
#
2005-02-23 09:05:00 -05:00
# The URL helpers such as <tt>url_for</tt> have a limited form of memory: when generating a new URL, they can look for
# missing values in the current request's parameters. Routes attempts to guess when a value should and should not be
# taken from the defaults. There are a few simple rules on how this is performed:
2005-02-23 20:29:43 -05:00
#
2005-02-23 09:05:00 -05:00
# * If the controller name begins with a slash, no defaults are used: <tt>url_for :controller => '/home'</tt>
# * If the controller changes, the action will default to index unless provided
2005-02-23 20:29:43 -05:00
#
2005-02-23 09:05:00 -05:00
# The final rule is applied while the URL is being generated and is best illustrated by an example. Let us consider the
# route given by <tt>map.connect 'people/:last/:first/:action', :action => 'bio', :controller => 'people'</tt>.
2005-02-23 20:29:43 -05:00
#
2005-10-26 09:20:46 -04:00
# Suppose that the current URL is "people/hh/david/contacts". Let's consider a few different cases of URLs which are generated
2005-02-23 09:05:00 -05:00
# from this page.
2005-02-23 20:29:43 -05:00
#
2005-02-23 09:05:00 -05:00
# * <tt>url_for :action => 'bio'</tt> -- During the generation of this URL, default values will be used for the first and
2005-04-30 09:36:40 -04:00
# last components, and the action shall change. The generated URL will be, "people/hh/david/bio".
2005-02-23 09:05:00 -05:00
# * <tt>url_for :first => 'davids-little-brother'</tt> This generates the URL 'people/hh/davids-little-brother' -- note
# that this URL leaves out the assumed action of 'bio'.
2005-02-23 20:29:43 -05:00
#
2005-02-23 09:05:00 -05:00
# However, you might ask why the action from the current request, 'contacts', isn't carried over into the new URL. The
# answer has to do with the order in which the parameters appear in the generated path. In a nutshell, since the
# value that appears in the slot for <tt>:first</tt> is not equal to default value for <tt>:first</tt> we stop using
# defaults. On it's own, this rule can account for much of the typical Rails URL behavior.
2006-01-20 17:04:07 -05:00
#
2005-02-23 09:05:00 -05:00
# Although a convienence, defaults can occasionaly get in your way. In some cases a default persists longer than desired.
# The default may be cleared by adding <tt>:name => nil</tt> to <tt>url_for</tt>'s options.
# This is often required when writing form helpers, since the defaults in play may vary greatly depending upon where the
# helper is used from. The following line will redirect to PostController's default action, regardless of the page it is
# displayed on:
2004-11-23 20:04:44 -05:00
#
2005-02-23 09:05:00 -05:00
# url_for :controller => 'posts', :action => nil
2006-09-04 00:58:08 -04:00
#
2005-09-09 03:50:14 -04:00
# If you explicitly want to create a URL that's almost the same as the current URL, you can do so using the
# :overwrite_params options. Say for your posts you have different views for showing and printing them.
# Then, in the show view, you get the URL for the print view like this
#
# url_for :overwrite_params => { :action => 'print' }
#
# This takes the current URL as is and only exchanges the action. In contrast, <tt>url_for :action => 'print'</tt>
2005-10-26 09:20:46 -04:00
# would have slashed-off the path components after the changed action.
2007-03-13 01:44:18 -04:00
def url_for ( options = nil ) #:doc:
case options || { }
2006-09-03 18:35:31 -04:00
when String
options
when Hash
@url . rewrite ( rewrite_options ( options ) )
2007-03-13 01:44:18 -04:00
else
raise ArgumentError , " Unrecognized url_for options: #{ options . inspect } "
2004-11-23 20:04:44 -05:00
end
end
# Converts the class name from something like "OneModule::TwoModule::NeatController" to "NeatController".
def controller_class_name
self . class . controller_class_name
end
# Converts the class name from something like "OneModule::TwoModule::NeatController" to "neat".
def controller_name
self . class . controller_name
end
2006-09-04 00:58:08 -04:00
2006-08-04 21:56:58 -04:00
# Converts the class name from something like "OneModule::TwoModule::NeatController" to "one_module/two_module/neat".
def controller_path
self . class . controller_path
end
2007-02-04 15:47:05 -05:00
2005-11-22 03:37:04 -05:00
def session_enabled?
2007-02-27 01:36:25 -05:00
request . session_options && request . session_options [ :disabled ] != false
2005-11-22 03:37:04 -05:00
end
2007-02-04 15:47:05 -05:00
# View load paths for controller.
def view_paths
self . class . view_paths
end
2005-11-22 03:37:04 -05:00
2004-11-23 20:04:44 -05:00
protected
2005-11-13 19:12:46 -05:00
# Renders the content that will be returned to the browser as the response body.
2005-07-06 04:27:11 -04:00
#
# === Rendering an action
2006-09-04 00:58:08 -04:00
#
2005-07-06 04:27:11 -04:00
# Action rendering is the most common form and the type used automatically by Action Controller when nothing else is
# specified. By default, actions are rendered within the current layout (if one exists).
#
# # Renders the template for the action "goal" within the current controller
# render :action => "goal"
#
# # Renders the template for the action "short_goal" within the current controller,
# # but without the current active layout
# render :action => "short_goal", :layout => false
#
# # Renders the template for the action "long_goal" within the current controller,
# # but with a custom layout
2005-07-22 02:27:07 -04:00
# render :action => "long_goal", :layout => "spectacular"
2005-07-06 04:27:11 -04:00
#
# _Deprecation_ _notice_: This used to have the signatures <tt>render_action("action", status = 200)</tt>,
2006-09-04 00:58:08 -04:00
# <tt>render_without_layout("controller/action", status = 200)</tt>, and
2005-07-06 04:27:11 -04:00
# <tt>render_with_layout("controller/action", status = 200, layout)</tt>.
#
# === Rendering partials
2006-07-07 21:50:58 -04:00
#
# Partial rendering in a controller is most commonly used together with Ajax calls that only update one or a few elements on a page
2005-07-06 04:27:11 -04:00
# without reloading. Rendering of partials from the controller makes it possible to use the same partial template in
# both the full-page rendering (by calling it from within the template) and when sub-page updates happen (from the
# controller action responding to Ajax calls). By default, the current layout is not used.
#
2006-07-07 21:50:58 -04:00
# # Renders the same partial with a local variable.
# render :partial => "person", :locals => { :name => "david" }
2005-07-06 04:27:11 -04:00
#
2006-07-07 21:50:58 -04:00
# # Renders a collection of the same partial by making each element
# # of @winners available through the local variable "person" as it
# # builds the complete response.
# render :partial => "person", :collection => @winners
2005-07-06 04:27:11 -04:00
#
2006-07-07 21:50:58 -04:00
# # Renders the same collection of partials, but also renders the
# # person_divider partial between each person partial.
# render :partial => "person", :collection => @winners, :spacer_template => "person_divider"
2005-07-06 04:27:11 -04:00
#
2006-07-07 21:50:58 -04:00
# # Renders a collection of partials located in a view subfolder
# # outside of our current controller. In this example we will be
# # rendering app/views/shared/_note.r(html|xml) Inside the partial
# # each element of @new_notes is available as the local var "note".
# render :partial => "shared/note", :collection => @new_notes
2005-07-06 04:27:11 -04:00
#
2006-07-07 21:50:58 -04:00
# # Renders the partial with a status code of 500 (internal error).
# render :partial => "broken", :status => 500
2005-07-06 04:27:11 -04:00
#
2006-07-07 18:53:46 -04:00
# Note that the partial filename must also be a valid Ruby variable name,
# so e.g. 2005 and register-user are invalid.
#
2005-07-06 04:27:11 -04:00
#
2007-02-17 13:16:44 -05:00
# == Automatic etagging
#
# Rendering will automatically insert the etag header on 200 OK responses. The etag is calculated using MD5 of the
# response body. If a request comes in that has a matching etag, the response will be changed to a 304 Not Modified
2007-02-18 11:32:05 -05:00
# and the response body will be set to an empty string. No etag header will be inserted if it's already set.
2007-02-17 13:16:44 -05:00
#
2005-10-03 17:20:52 -04:00
# === Rendering a template
2006-09-04 00:58:08 -04:00
#
# Template rendering works just like action rendering except that it takes a path relative to the template root.
2005-10-03 17:20:52 -04:00
# The current layout is automatically applied.
2005-07-11 03:10:32 -04:00
#
2007-02-20 17:09:12 -05:00
# # Renders the template located in [TEMPLATE_ROOT]/weblog/show.r(html|xml) (in Rails, app/views/weblog/show.erb)
2005-10-03 17:20:52 -04:00
# render :template => "weblog/show"
#
# === Rendering a file
2006-09-04 00:58:08 -04:00
#
2005-11-13 19:12:46 -05:00
# File rendering works just like action rendering except that it takes a filesystem path. By default, the path
# is assumed to be absolute, and the current layout is not applied.
2005-07-06 04:27:11 -04:00
#
2005-11-13 19:12:46 -05:00
# # Renders the template located at the absolute filesystem path
2007-02-20 17:09:12 -05:00
# render :file => "/path/to/some/template.erb"
# render :file => "c:/path/to/some/template.erb"
2005-07-06 04:27:11 -04:00
#
2005-11-13 19:12:46 -05:00
# # Renders a template within the current layout, and with a 404 status code
2007-02-20 17:09:12 -05:00
# render :file => "/path/to/some/template.erb", :layout => true, :status => 404
# render :file => "c:/path/to/some/template.erb", :layout => true, :status => 404
2005-11-13 19:12:46 -05:00
#
# # Renders a template relative to the template root and chooses the proper file extension
# render :file => "some/template", :use_full_path => true
2005-07-06 04:27:11 -04:00
#
# _Deprecation_ _notice_: This used to have the signature <tt>render_file(path, status = 200)</tt>
#
# === Rendering text
2006-09-04 00:58:08 -04:00
#
2005-07-06 04:27:11 -04:00
# Rendering of text is usually used for tests or for rendering prepared content, such as a cache. By default, text
# rendering is not done within the active layout.
#
# # Renders the clear text "hello world" with status code 200
# render :text => "hello world!"
#
# # Renders the clear text "Explosion!" with status code 500
2006-09-04 00:58:08 -04:00
# render :text => "Explosion!", :status => 500
2005-07-06 04:27:11 -04:00
#
# # Renders the clear text "Hi there!" within the current active layout (if one exists)
# render :text => "Explosion!", :layout => true
#
2006-09-04 00:58:08 -04:00
# # Renders the clear text "Hi there!" within the layout
2005-07-06 04:27:11 -04:00
# # placed in "app/views/layouts/special.r(html|xml)"
# render :text => "Explosion!", :layout => "special"
#
2006-07-04 22:18:34 -04:00
# The :text option can also accept a Proc object, which can be used to manually control the page generation. This should
# generally be avoided, as it violates the separation between code and content, and because almost everything that can be
# done with this method can also be done more cleanly using one of the other rendering methods, most notably templates.
#
# # Renders "Hello from code!"
# render :text => proc { |response, output| output.write("Hello from code!") }
#
2005-07-06 04:27:11 -04:00
# _Deprecation_ _notice_: This used to have the signature <tt>render_text("text", status = 200)</tt>
#
2006-12-06 17:27:08 -05:00
# === Rendering JSON
#
# Rendering JSON sets the content type to text/x-json and optionally wraps the JSON in a callback. It is expected
# that the response will be eval'd for use as a data structure.
#
# # Renders '{name: "David"}'
# render :json => {:name => "David"}.to_json
#
# Sometimes the result isn't handled directly by a script (such as when the request comes from a SCRIPT tag),
# so the callback option is provided for these cases.
#
# # Renders 'show({name: "David"})'
# render :json => {:name => "David"}.to_json, :callback => 'show'
#
2005-07-06 04:27:11 -04:00
# === Rendering an inline template
#
# Rendering of an inline template works as a cross between text and action rendering where the source for the template
# is supplied inline, like text, but its interpreted with ERb or Builder, like action. By default, ERb is used for rendering
# and the current layout is not used.
#
# # Renders "hello, hello, hello, again"
2006-09-04 00:58:08 -04:00
# render :inline => "<%= 'hello, ' * 3 + 'again' %>"
2005-07-06 04:27:11 -04:00
#
# # Renders "<p>Good seeing you!</p>" using Builder
2007-02-20 17:09:12 -05:00
# render :inline => "xml.p { 'Good seeing you!' }", :type => :builder
2005-07-06 04:27:11 -04:00
#
# # Renders "hello david"
# render :inline => "<%= 'hello ' + name %>", :locals => { :name => "david" }
#
# _Deprecation_ _notice_: This used to have the signature <tt>render_template(template, status = 200, type = :rhtml)</tt>
#
2006-01-20 17:04:07 -05:00
# === Rendering inline JavaScriptGenerator page updates
#
# In addition to rendering JavaScriptGenerator page updates with Ajax in RJS templates (see ActionView::Base for details),
# you can also pass the <tt>:update</tt> parameter to +render+, along with a block, to render page updates inline.
#
# render :update do |page|
# page.replace_html 'user_list', :partial => 'user', :collection => @users
# page.visual_effect :highlight, 'user_list'
# end
#
2005-07-06 04:27:11 -04:00
# === Rendering nothing
#
# Rendering nothing is often convenient in combination with Ajax calls that perform their effect client-side or
2005-07-12 15:31:48 -04:00
# when you just want to communicate a status code. Due to a bug in Safari, nothing actually means a single space.
2005-07-06 04:27:11 -04:00
#
# # Renders an empty response with status code 200
# render :nothing => true
#
# # Renders an empty response with status code 401 (access denied)
# render :nothing => true, :status => 401
2006-01-20 17:04:07 -05:00
def render ( options = nil , deprecated_status = nil , & block ) #:doc:
2005-07-24 12:45:39 -04:00
raise DoubleRenderError , " Can only render or redirect once per action " if performed?
2005-05-22 04:58:43 -04:00
2006-09-03 19:02:56 -04:00
if options . nil?
return render_file ( default_template_name , deprecated_status , true )
else
# Backwards compatibility
unless options . is_a? ( Hash )
if options == :update
options = { :update = > true }
else
ActiveSupport :: Deprecation . warn (
2006-09-03 19:22:24 -04:00
" You called render(' #{ options } '), which is a deprecated API call. Instead you use " +
2006-09-03 23:36:13 -04:00
" render :file => #{ options } . Calling render with just a string will be removed from Rails 2.0. " ,
caller
2006-09-03 19:02:56 -04:00
)
return render_file ( options , deprecated_status , true )
end
2006-01-20 17:04:07 -05:00
end
2005-07-24 12:45:39 -04:00
end
2005-05-22 04:58:43 -04:00
2006-03-12 20:33:57 -05:00
if content_type = options [ :content_type ]
2006-09-17 12:20:32 -04:00
response . content_type = content_type . to_s
2006-03-12 20:33:57 -05:00
end
2005-07-24 12:45:39 -04:00
if text = options [ :text ]
render_text ( text , options [ :status ] )
2005-05-22 03:43:05 -04:00
else
2005-07-24 12:45:39 -04:00
if file = options [ :file ]
2005-11-22 03:37:04 -05:00
render_file ( file , options [ :status ] , options [ :use_full_path ] , options [ :locals ] || { } )
2005-07-24 12:45:39 -04:00
elsif template = options [ :template ]
render_file ( template , options [ :status ] , true )
2006-09-04 00:58:08 -04:00
2005-07-24 12:45:39 -04:00
elsif inline = options [ :inline ]
2005-10-13 16:26:39 -04:00
render_template ( inline , options [ :status ] , options [ :type ] , options [ :locals ] || { } )
2006-09-04 00:58:08 -04:00
2005-07-24 12:45:39 -04:00
elsif action_name = options [ :action ]
2006-09-04 00:58:08 -04:00
ActiveSupport :: Deprecation . silence do
render_action ( action_name , options [ :status ] , options [ :layout ] )
end
2006-03-10 20:23:29 -05:00
elsif xml = options [ :xml ]
render_xml ( xml , options [ :status ] )
2006-12-06 18:16:25 -05:00
2006-12-06 17:27:08 -05:00
elsif json = options [ :json ]
render_json ( json , options [ :callback ] , options [ :status ] )
2006-03-10 20:23:29 -05:00
2005-07-24 12:45:39 -04:00
elsif partial = options [ :partial ]
partial = default_template_name if partial == true
if collection = options [ :collection ]
render_partial_collection ( partial , collection , options [ :spacer_template ] , options [ :locals ] , options [ :status ] )
else
2005-09-09 03:27:44 -04:00
render_partial ( partial , ActionView :: Base :: ObjectWrapper . new ( options [ :object ] ) , options [ :locals ] , options [ :status ] )
2005-07-24 12:45:39 -04:00
end
2006-01-20 17:04:07 -05:00
elsif options [ :update ]
2006-01-29 23:49:17 -05:00
add_variables_to_assigns
@template . send :evaluate_assigns
2006-09-04 00:58:08 -04:00
2006-01-20 17:04:07 -05:00
generator = ActionView :: Helpers :: PrototypeHelper :: JavaScriptGenerator . new ( @template , & block )
render_javascript ( generator . to_s )
2005-07-24 12:45:39 -04:00
elsif options [ :nothing ]
# Safari doesn't pass the headers of the return if the response is zero length
render_text ( " " , options [ :status ] )
2006-09-04 00:58:08 -04:00
2005-07-24 12:45:39 -04:00
else
render_file ( default_template_name , options [ :status ] , true )
2006-09-04 00:58:08 -04:00
2005-07-24 12:45:39 -04:00
end
2005-05-22 03:43:05 -04:00
end
end
2004-11-23 20:04:44 -05:00
2005-07-06 04:27:11 -04:00
# Renders according to the same rules as <tt>render</tt>, but returns the result in a string instead
# of sending it as the response body to the browser.
2006-01-20 17:08:41 -05:00
def render_to_string ( options = nil , & block ) #:doc:
2006-11-20 06:03:21 -05:00
ActiveSupport :: Deprecation . silence { render ( options , & block ) }
ensure
2005-05-22 04:58:43 -04:00
erase_render_results
2006-02-12 00:51:02 -05:00
forget_variables_added_to_assigns
reset_variables_added_to_assigns
2006-09-04 00:58:08 -04:00
end
2005-07-24 12:45:39 -04:00
2006-03-27 22:19:27 -05:00
def render_action ( action_name , status = nil , with_layout = true ) #:nodoc:
2006-02-18 19:46:34 -05:00
template = default_template_name ( action_name . to_s )
2006-09-04 00:58:08 -04:00
if with_layout && ! template_exempt_from_layout? ( template )
2006-09-04 01:24:08 -04:00
render_with_layout ( :file = > template , :status = > status , :use_full_path = > true , :layout = > true )
2005-07-24 12:45:39 -04:00
else
2006-09-04 01:24:08 -04:00
render_without_layout ( :file = > template , :status = > status , :use_full_path = > true )
2005-07-24 12:45:39 -04:00
end
end
2006-03-27 22:19:27 -05:00
def render_file ( template_path , status = nil , use_full_path = false , locals = { } ) #:nodoc:
2005-07-24 12:45:39 -04:00
add_variables_to_assigns
2006-03-27 18:43:50 -05:00
assert_existence_of_template_file ( template_path ) if use_full_path
2005-09-28 04:43:17 -04:00
logger . info ( " Rendering #{ template_path } " + ( status ? " ( #{ status } ) " : '' ) ) if logger
2005-11-22 03:37:04 -05:00
render_text ( @template . render_file ( template_path , use_full_path , locals ) , status )
2005-02-23 09:57:08 -05:00
end
2005-07-24 12:45:39 -04:00
2007-02-20 17:09:12 -05:00
def render_template ( template , status = nil , type = :erb , local_assigns = { } ) #:nodoc:
2005-07-24 12:45:39 -04:00
add_variables_to_assigns
2005-10-13 16:26:39 -04:00
render_text ( @template . render_template ( type , template , nil , local_assigns ) , status )
2005-07-24 12:45:39 -04:00
end
2006-10-08 21:26:35 -04:00
def render_text ( text = nil , status = nil , append_response = false ) #:nodoc:
2005-07-24 12:45:39 -04:00
@performed_render = true
2006-10-08 21:26:35 -04:00
2006-09-28 15:13:55 -04:00
response . headers [ 'Status' ] = interpret_status ( status || DEFAULT_RENDER_STATUS_CODE )
2006-10-08 21:26:35 -04:00
if append_response
response . body || = ''
response . body << text
else
response . body = text
2007-02-17 13:16:44 -05:00
end
2005-07-24 12:45:39 -04:00
end
2006-10-08 21:26:35 -04:00
def render_javascript ( javascript , status = nil , append_response = true ) #:nodoc:
2006-09-17 12:20:32 -04:00
response . content_type = Mime :: JS
2006-10-08 21:26:35 -04:00
render_text ( javascript , status , append_response )
2006-01-20 17:04:07 -05:00
end
2006-03-27 22:19:27 -05:00
def render_xml ( xml , status = nil ) #:nodoc:
2006-09-17 12:20:32 -04:00
response . content_type = Mime :: XML
2006-03-10 20:23:29 -05:00
render_text ( xml , status )
end
2006-12-06 18:16:25 -05:00
2006-12-06 17:27:08 -05:00
def render_json ( json , callback = nil , status = nil ) #:nodoc:
json = " #{ callback } ( #{ json } ) " unless callback . blank?
2006-12-06 18:16:25 -05:00
2006-12-06 17:27:08 -05:00
response . content_type = Mime :: JSON
render_text ( json , status )
end
2006-03-10 20:23:29 -05:00
2006-03-27 22:19:27 -05:00
def render_nothing ( status = nil ) #:nodoc:
2005-07-24 12:45:39 -04:00
render_text ( ' ' , status )
end
2006-03-27 22:19:27 -05:00
def render_partial ( partial_path = default_template_name , object = nil , local_assigns = nil , status = nil ) #:nodoc:
2005-07-24 12:45:39 -04:00
add_variables_to_assigns
2007-03-13 01:06:41 -04:00
render_text ( @template . send ( :render_partial , partial_path , object , local_assigns ) , status )
2005-07-24 12:45:39 -04:00
end
2006-03-27 22:19:27 -05:00
def render_partial_collection ( partial_name , collection , partial_spacer_template = nil , local_assigns = nil , status = nil ) #:nodoc:
2005-07-24 12:45:39 -04:00
add_variables_to_assigns
2007-03-13 01:06:41 -04:00
render_text ( @template . send ( :render_partial_collection , partial_name , collection , partial_spacer_template , local_assigns ) , status )
2005-07-24 12:45:39 -04:00
end
2006-03-27 22:19:27 -05:00
def render_with_layout ( template_name = default_template_name , status = nil , layout = nil ) #:nodoc:
2005-07-24 12:45:39 -04:00
render_with_a_layout ( template_name , status , layout )
end
2006-03-27 22:19:27 -05:00
def render_without_layout ( template_name = default_template_name , status = nil ) #:nodoc:
2005-07-24 12:45:39 -04:00
render_with_no_layout ( template_name , status )
end
2005-07-06 04:27:11 -04:00
2006-09-28 15:13:55 -04:00
# Return a response that has no content (merely headers). The options
# argument is interpreted to be a hash of header names and values.
# This allows you to easily return a response that consists only of
# significant headers:
#
2006-09-28 15:32:40 -04:00
# head :created, :location => person_path(@person)
2006-09-28 15:13:55 -04:00
#
# It can also be used to return exceptional conditions:
#
2006-09-28 15:32:40 -04:00
# return head(:method_not_allowed) unless request.post?
# return head(:bad_request) unless valid_request?
2006-09-28 15:13:55 -04:00
# render
2006-09-28 15:32:40 -04:00
def head ( * args )
if args . length > 2
raise ArgumentError , " too many arguments to head "
elsif args . empty?
raise ArgumentError , " too few arguments to head "
elsif args . length == 2
status = args . shift
options = args . shift
elsif args . first . is_a? ( Hash )
options = args . first
else
status = args . first
options = { }
end
raise ArgumentError , " head requires an options hash " if ! options . is_a? ( Hash )
status = interpret_status ( status || options . delete ( :status ) || :ok )
2006-09-28 15:13:55 -04:00
options . each do | key , value |
headers [ key . to_s . dasherize . split ( / - / ) . map { | v | v . capitalize } . join ( " - " ) ] = value . to_s
end
render :nothing = > true , :status = > status
end
2005-06-28 13:42:51 -04:00
# Clears the rendered results, allowing for another render to be performed.
2006-03-27 22:19:27 -05:00
def erase_render_results #:nodoc:
2006-08-07 02:11:56 -04:00
response . body = nil
2005-05-21 14:51:08 -04:00
@performed_render = false
end
2006-09-04 00:58:08 -04:00
# Clears the redirected results from the headers, resets the status to 200 and returns
2005-06-28 13:42:51 -04:00
# the URL that was used to redirect or nil if there was no redirected URL
# Note that +redirect_to+ will change the body of the response to indicate a redirection.
# The response body is not reset here, see +erase_render_results+
2006-03-27 22:19:27 -05:00
def erase_redirect_results #:nodoc:
2005-06-28 13:42:51 -04:00
@performed_redirect = false
response . redirected_to = nil
response . redirected_to_method_params = nil
response . headers [ 'Status' ] = DEFAULT_RENDER_STATUS_CODE
2006-11-26 00:35:53 -05:00
response . headers . delete ( 'Location' )
2005-06-28 13:42:51 -04:00
end
2005-07-25 04:49:19 -04:00
# Erase both render and redirect results
2006-03-27 22:19:27 -05:00
def erase_results #:nodoc:
2005-07-25 04:49:19 -04:00
erase_render_results
erase_redirect_results
end
2005-07-06 04:27:11 -04:00
2006-03-27 22:19:27 -05:00
def rewrite_options ( options ) #:nodoc:
2004-11-23 20:04:44 -05:00
if defaults = default_url_options ( options )
defaults . merge ( options )
else
options
end
end
2006-09-04 00:58:08 -04:00
2004-11-23 20:04:44 -05:00
# Overwrite to implement a number of default options that all url_for-based methods will use. The default options should come in
# the form of a hash, just like the one you would use for url_for directly. Example:
#
# def default_url_options(options)
2005-02-23 09:05:00 -05:00
# { :project => @project.active? ? @project.url_name : "unknown" }
2004-11-23 20:04:44 -05:00
# end
#
# As you can infer from the example, this is mostly useful for situations where you want to centralize dynamic decisions about the
# urls as they stem from the business domain. Please note that any individual url_for call can always override the defaults set
# by this method.
def default_url_options ( options ) #:doc:
end
2006-09-04 00:58:08 -04:00
2005-05-22 03:43:05 -04:00
# Redirects the browser to the target specified in +options+. This parameter can take one of three forms:
#
# * <tt>Hash</tt>: The URL will be generated by calling url_for with the +options+.
# * <tt>String starting with protocol:// (like http://)</tt>: Is passed straight through as the target for redirection.
2005-11-07 04:36:43 -05:00
# * <tt>String not containing a protocol</tt>: The current protocol and host is prepended to the string.
2005-11-02 09:47:03 -05:00
# * <tt>:back</tt>: Back to the page that issued the request. Useful for forms that are triggered from multiple places.
# Short-hand for redirect_to(request.env["HTTP_REFERER"])
2006-09-04 00:58:08 -04:00
#
2005-05-22 03:43:05 -04:00
# Examples:
# redirect_to :action => "show", :id => 5
# redirect_to "http://www.rubyonrails.org"
# redirect_to "/images/screenshot.jpg"
2005-11-02 09:47:03 -05:00
# redirect_to :back
2005-05-22 03:43:05 -04:00
#
# The redirection happens as a "302 Moved" header.
2006-04-25 02:32:07 -04:00
#
# When using <tt>redirect_to :back</tt>, if there is no referrer,
# RedirectBackError will be raised. You may specify some fallback
# behavior for this case by rescueing RedirectBackError.
2004-11-23 20:04:44 -05:00
def redirect_to ( options = { } , * parameters_for_method_reference ) #:doc:
2005-05-22 03:43:05 -04:00
case options
when %r{ ^ \ w+://.* }
2005-07-09 11:31:06 -04:00
raise DoubleRenderError if performed?
2006-02-09 15:05:11 -05:00
logger . info ( " Redirected to #{ options } " ) if logger
2005-05-22 12:52:54 -04:00
response . redirect ( options )
response . redirected_to = options
2005-05-22 03:43:05 -04:00
@performed_redirect = true
when String
redirect_to ( request . protocol + request . host_with_port + options )
2006-09-04 00:58:08 -04:00
2005-11-02 09:47:03 -05:00
when :back
2006-01-21 20:52:23 -05:00
request . env [ " HTTP_REFERER " ] ? redirect_to ( request . env [ " HTTP_REFERER " ] ) : raise ( RedirectBackError )
2005-05-22 03:43:05 -04:00
else
if parameters_for_method_reference . empty?
redirect_to ( url_for ( options ) )
2005-05-22 12:52:54 -04:00
response . redirected_to = options
2005-05-22 03:43:05 -04:00
else
2006-09-03 18:35:31 -04:00
# TOOD: Deprecate me!
2007-03-16 01:21:19 -04:00
redirect_to ( url_for ( options ) )
2005-05-22 12:52:54 -04:00
response . redirected_to , response . redirected_to_method_params = options , parameters_for_method_reference
2005-05-22 03:43:05 -04:00
end
2004-11-23 20:04:44 -05:00
end
end
2006-09-04 00:58:08 -04:00
2005-07-17 05:20:20 -04:00
# Sets a HTTP 1.1 Cache-Control header. Defaults to issuing a "private" instruction, so that
# intermediate caches shouldn't cache the response.
#
# Examples:
# expires_in 20.minutes
# expires_in 3.hours, :private => false
# expires in 3.hours, 'max-stale' => 5.hours, :private => nil, :public => true
2006-09-04 00:58:08 -04:00
#
2005-07-17 05:20:20 -04:00
# This method will overwrite an existing Cache-Control header.
# See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html for more possibilities.
2005-07-23 04:43:01 -04:00
def expires_in ( seconds , options = { } ) #:doc:
2005-07-17 05:20:20 -04:00
cache_options = { 'max-age' = > seconds , 'private' = > true } . symbolize_keys . merge! ( options . symbolize_keys )
cache_options . delete_if { | k , v | v . nil? or v == false }
cache_control = cache_options . map { | k , v | v == true ? k . to_s : " #{ k . to_s } = #{ v . to_s } " }
2006-08-07 02:11:56 -04:00
response . headers [ " Cache-Control " ] = cache_control . join ( ', ' )
2005-07-17 05:20:20 -04:00
end
2006-09-04 00:58:08 -04:00
2005-07-17 05:20:20 -04:00
# Sets a HTTP 1.1 Cache-Control header of "no-cache" so no caching should occur by the browser or
# intermediate caches (like caching proxy servers).
2005-07-23 04:43:01 -04:00
def expires_now #:doc:
2006-08-07 02:11:56 -04:00
response . headers [ " Cache-Control " ] = " no-cache "
2005-07-17 05:20:20 -04:00
end
2004-11-23 20:04:44 -05:00
2005-02-07 09:15:53 -05:00
# Resets the session by clearing out all the objects stored within and initializing a new session object.
2004-11-23 20:04:44 -05:00
def reset_session #:doc:
2006-08-07 02:11:56 -04:00
request . reset_session
@_session = request . session
response . session = @_session
2004-11-23 20:04:44 -05:00
end
2006-09-04 00:58:08 -04:00
2004-11-23 20:04:44 -05:00
private
2005-09-08 08:08:24 -04:00
def self . view_class
2006-03-19 23:01:10 -05:00
@view_class || =
2005-09-08 08:08:24 -04:00
# create a new class based on the default template class and include helper methods
2006-03-19 23:37:32 -05:00
returning Class . new ( ActionView :: Base ) do | view_class |
2006-03-19 23:01:10 -05:00
view_class . send ( :include , master_helper_module )
end
2005-09-08 08:08:24 -04:00
end
def initialize_template_class ( response )
raise " You must assign a template class through ActionController.template_class= before processing a request " unless @@template_class
2006-09-04 00:58:08 -04:00
2007-02-04 15:47:05 -05:00
response . template = self . class . view_class . new ( view_paths , { } , self )
2005-10-30 08:13:02 -05:00
response . redirected_to = nil
2004-11-23 20:04:44 -05:00
@performed_render = @performed_redirect = false
end
2006-08-07 02:11:56 -04:00
2004-11-23 20:04:44 -05:00
def assign_shortcuts ( request , response )
2006-09-29 04:04:39 -04:00
@_request , @_params , @_cookies = request , request . parameters , request . cookies
2004-11-23 20:04:44 -05:00
2006-09-29 04:26:45 -04:00
@_response = response
@_response . session = request . session
2004-11-23 20:04:44 -05:00
2006-09-29 04:26:45 -04:00
@_session = @_response . session
@template = @_response . template
@assigns = @_response . template . assigns
2006-08-07 02:11:56 -04:00
2006-09-29 04:26:45 -04:00
@_headers = @_response . headers
2006-08-07 02:11:56 -04:00
end
2004-11-23 20:04:44 -05:00
def initialize_current_url
2006-08-07 02:11:56 -04:00
@url = UrlRewriter . new ( request , params . clone )
2004-11-23 20:04:44 -05:00
end
def log_processing
2006-02-12 00:51:02 -05:00
if logger
logger . info " \n \n Processing #{ controller_class_name } \# #{ action_name } (for #{ request_origin } ) [ #{ request . method . to_s . upcase } ] "
2006-08-07 02:11:56 -04:00
logger . info " Session ID: #{ @_session . session_id } " if @_session and @_session . respond_to? ( :session_id )
logger . info " Parameters: #{ respond_to? ( :filter_parameters ) ? filter_parameters ( params ) . inspect : params . inspect } "
2006-02-12 00:51:02 -05:00
end
2004-11-23 20:04:44 -05:00
end
2006-09-04 00:58:08 -04:00
2004-11-23 20:04:44 -05:00
def perform_action
2006-08-13 00:15:22 -04:00
if self . class . action_methods . include? ( action_name )
2004-11-23 20:04:44 -05:00
send ( action_name )
2005-01-20 09:13:34 -05:00
render unless performed?
2006-08-13 00:15:22 -04:00
elsif respond_to? :method_missing
send ( :method_missing , action_name )
render unless performed?
2004-11-23 20:04:44 -05:00
elsif template_exists? && template_public?
render
else
raise UnknownAction , " No action responded to #{ action_name } " , caller
end
end
2006-09-04 00:58:08 -04:00
2005-01-20 09:13:34 -05:00
def performed?
@performed_render || @performed_redirect
end
2004-11-23 20:04:44 -05:00
2006-03-19 23:01:10 -05:00
def assign_names
@action_name = ( params [ 'action' ] || 'index' )
end
2006-09-04 00:58:08 -04:00
2006-09-17 12:20:32 -04:00
def assign_default_content_type_and_charset
response . content_type || = Mime :: HTML
2006-11-25 14:29:10 -05:00
response . charset || = self . class . default_charset unless sending_file?
end
def sending_file?
response . headers [ " Content-Transfer-Encoding " ] == " binary "
2006-09-17 12:20:32 -04:00
end
2004-11-23 20:04:44 -05:00
def action_methods
2005-07-23 05:00:05 -04:00
self . class . action_methods
2004-11-23 20:04:44 -05:00
end
2005-05-22 04:58:43 -04:00
2005-07-23 05:00:05 -04:00
def self . action_methods
2005-10-20 17:59:48 -04:00
@action_methods || = Set . new ( public_instance_methods - hidden_actions )
2005-07-23 05:00:05 -04:00
end
2005-05-22 04:58:43 -04:00
2004-11-23 20:04:44 -05:00
def add_variables_to_assigns
2005-07-23 05:00:05 -04:00
unless @variables_added
add_instance_variables_to_assigns
add_class_variables_to_assigns if view_controller_internals
@variables_added = true
end
2004-11-23 20:04:44 -05:00
end
2006-09-04 00:58:08 -04:00
2006-02-12 00:51:02 -05:00
def forget_variables_added_to_assigns
@variables_added = nil
end
2006-09-04 00:58:08 -04:00
2006-02-12 00:51:02 -05:00
def reset_variables_added_to_assigns
@template . instance_variable_set ( " @assigns_added " , nil )
end
2004-11-23 20:04:44 -05:00
def add_instance_variables_to_assigns
2006-08-07 17:58:31 -04:00
@@protected_variables_cache || = Set . new ( protected_instance_variables )
2004-11-23 20:04:44 -05:00
instance_variables . each do | var |
2005-07-04 21:31:03 -04:00
next if @@protected_variables_cache . include? ( var )
2004-11-23 20:04:44 -05:00
@assigns [ var [ 1 .. - 1 ] ] = instance_variable_get ( var )
end
end
def add_class_variables_to_assigns
2007-02-04 15:47:05 -05:00
%w( view_paths logger template_class ignore_missing_templates ) . each do | cvar |
2004-11-23 20:04:44 -05:00
@assigns [ cvar ] = self . send ( cvar )
end
end
def protected_instance_variables
if view_controller_internals
2006-08-07 08:40:14 -04:00
%w( @assigns @performed_redirect @performed_render )
2004-11-23 20:04:44 -05:00
else
2006-08-07 08:40:14 -04:00
%w( @assigns @performed_redirect @performed_render
2006-09-29 04:26:45 -04:00
@_request @request @_response @response @_params @params
@_session @session @_cookies @cookies
@template @request_origin @parent_controller )
2004-11-23 20:04:44 -05:00
end
end
def request_origin
2006-02-09 15:05:11 -05:00
# this *needs* to be cached!
# otherwise you'd get different results if calling it more than once
2006-08-07 02:11:56 -04:00
@request_origin || = " #{ request . remote_ip } at #{ Time . now . to_s ( :db ) } "
2004-11-23 20:04:44 -05:00
end
2006-08-07 02:11:56 -04:00
2005-07-05 13:23:41 -04:00
def complete_request_uri
2006-08-07 02:11:56 -04:00
" #{ request . protocol } #{ request . host } #{ request . request_uri } "
2005-07-05 13:23:41 -04:00
end
2004-11-23 20:04:44 -05:00
def close_session
2006-08-07 02:11:56 -04:00
@_session . close if @_session && @_session . respond_to? ( :close )
2004-11-23 20:04:44 -05:00
end
2006-08-07 02:11:56 -04:00
2004-11-23 20:04:44 -05:00
def template_exists? ( template_name = default_template_name )
@template . file_exists? ( template_name )
end
def template_public? ( template_name = default_template_name )
@template . file_public? ( template_name )
end
2005-11-18 03:32:17 -05:00
def template_exempt_from_layout? ( template_name = default_template_name )
2007-01-14 08:57:44 -05:00
extension = @template . pick_template_extension ( template_name ) rescue nil
name_with_extension = ! template_name . include? ( '.' ) && extension ? " #{ template_name } . #{ extension } " : template_name
extension == :rjs || @@exempt_from_layout . any? { | ext | name_with_extension =~ ext }
2005-11-18 03:32:17 -05:00
end
2006-03-27 18:43:50 -05:00
def assert_existence_of_template_file ( template_name )
2004-11-23 20:04:44 -05:00
unless template_exists? ( template_name ) || ignore_missing_templates
2007-02-20 17:09:12 -05:00
full_template_path = @template . send ( :full_template_path , template_name , 'erb' )
2004-11-23 20:04:44 -05:00
template_type = ( template_name =~ / layouts /i ) ? 'layout' : 'template'
raise ( MissingTemplate , " Missing #{ template_type } #{ full_template_path } " )
end
end
2006-03-19 23:01:10 -05:00
def default_template_name ( action_name = self . action_name )
if action_name
action_name = action_name . to_s
if action_name . include? ( '/' ) && template_path_includes_controller? ( action_name )
action_name = strip_out_controller ( action_name )
end
2005-12-20 00:32:39 -05:00
end
2006-03-19 23:01:10 -05:00
" #{ self . class . controller_path } / #{ action_name } "
2004-11-23 20:04:44 -05:00
end
2006-09-04 00:58:08 -04:00
2006-03-19 23:01:10 -05:00
def strip_out_controller ( path )
path . split ( '/' , 2 ) . last
2005-12-17 01:38:06 -05:00
end
2006-09-04 00:58:08 -04:00
2005-12-17 01:38:06 -05:00
def template_path_includes_controller? ( path )
2006-03-19 23:01:10 -05:00
self . class . controller_path . split ( '/' ) [ - 1 ] == path . split ( '/' ) [ 0 ]
2005-12-17 01:38:06 -05:00
end
2006-02-12 00:51:02 -05:00
def process_cleanup
close_session
end
2004-11-23 20:04:44 -05:00
end
end