Module: ActionController::Redirecting

Extended by:
ActiveSupport::Concern
Includes:
AbstractController::Logger, UrlFor
Defined in:
lib/action_controller/metal/redirecting.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from UrlFor

#url_options

Methods included from AbstractController::UrlFor

#_routes

Methods included from ActionDispatch::Routing::UrlFor

#initialize, #url_for, #url_options

Methods included from ActionDispatch::Routing::PolymorphicRoutes

#polymorphic_path, #polymorphic_url

Class Method Details

._compute_redirect_to_location(request, options) ⇒ Object

:nodoc:



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/action_controller/metal/redirecting.rb', line 96

def _compute_redirect_to_location(request, options) #:nodoc:
  case options
  # The scheme name consist of a letter followed by any combination of
  # letters, digits, and the plus ("+"), period ("."), or hyphen ("-")
  # characters; and is terminated by a colon (":").
  # See http://tools.ietf.org/html/rfc3986#section-3.1
  # The protocol relative scheme starts with a double slash "//".
  when /\A([a-z][a-z\d\-+\.]*:|\/\/).*/i
    options
  when String
    request.protocol + request.host_with_port + options
  when :back
    ActiveSupport::Deprecation.warn(<<-MESSAGE.squish)
      `redirect_to :back` is deprecated and will be removed from Rails 5.1.
      Please use `redirect_back(fallback_location: fallback_location)` where
      `fallback_location` represents the location to use if the request has
      no HTTP referer information.
    MESSAGE
    request.headers["Referer"] or raise RedirectBackError
  when Proc
    _compute_redirect_to_location request, options.call
  else
    url_for(options)
  end.delete("\0\r\n")
end

Instance Method Details

#_compute_redirect_to_location(request, options) ⇒ Object

:nodoc:



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/action_controller/metal/redirecting.rb', line 96

def _compute_redirect_to_location(request, options) #:nodoc:
  case options
  # The scheme name consist of a letter followed by any combination of
  # letters, digits, and the plus ("+"), period ("."), or hyphen ("-")
  # characters; and is terminated by a colon (":").
  # See http://tools.ietf.org/html/rfc3986#section-3.1
  # The protocol relative scheme starts with a double slash "//".
  when /\A([a-z][a-z\d\-+\.]*:|\/\/).*/i
    options
  when String
    request.protocol + request.host_with_port + options
  when :back
    ActiveSupport::Deprecation.warn(<<-MESSAGE.squish)
      `redirect_to :back` is deprecated and will be removed from Rails 5.1.
      Please use `redirect_back(fallback_location: fallback_location)` where
      `fallback_location` represents the location to use if the request has
      no HTTP referer information.
    MESSAGE
    request.headers["Referer"] or raise RedirectBackError
  when Proc
    _compute_redirect_to_location request, options.call
  else
    url_for(options)
  end.delete("\0\r\n")
end

#redirect_back(fallback_location:, **args) ⇒ Object

Redirects the browser to the page that issued the request (the referrer) if possible, otherwise redirects to the provided default fallback location.

The referrer information is pulled from the HTTP ‘Referer` (sic) header on the request. This is an optional header and its presence on the request is subject to browser security settings and user preferences. If the request is missing this header, the fallback_location will be used.

redirect_back fallback_location: { action: "show", id: 5 }
redirect_back fallback_location: post
redirect_back fallback_location: "http://www.rubyonrails.org"
redirect_back fallback_location:  "/images/screenshot.jpg"
redirect_back fallback_location:  articles_url
redirect_back fallback_location:  proc { edit_post_url(@post) }

All options that can be passed to redirect_to are accepted as options and the behavior is identical.



88
89
90
91
92
93
94
 
# File 'lib/action_controller/metal/redirecting.rb', line 88

def redirect_back(fallback_location:, **args)
  if referer = request.headers["Referer"]
    redirect_to referer, **args
  else
    redirect_to fallback_location, **args
  end
end

#redirect_to(options = {}, response_status = {}) ⇒ Object

Redirects the browser to the target specified in options. This parameter can be any one of:

  • Hash - The URL will be generated by calling url_for with the options.

  • Record - The URL will be generated by calling url_for with the options, which will reference a named URL for that record.

  • String starting with protocol:// (like http://) or a protocol relative reference (like //) - Is passed straight through as the target for redirection.

  • String not containing a protocol - The current protocol and host is prepended to the string.

  • Proc - A block that will be executed in the controller’s context. Should return any option accepted by redirect_to.

Examples:

redirect_to action: "show", id: 5
redirect_to post
redirect_to "http://www.rubyonrails.org"
redirect_to "/images/screenshot.jpg"
redirect_to articles_url
redirect_to proc { edit_post_url(@post) }

The redirection happens as a “302 Found” header unless otherwise specified using the :status option:

redirect_to post_url(@post), status: :found
redirect_to action: 'atom', status: :moved_permanently
redirect_to post_url(@post), status: 301
redirect_to action: 'atom', status: 302

The status code can either be a standard HTTP Status code as an integer, or a symbol representing the downcased, underscored and symbolized description. Note that the status code must be a 3xx HTTP code, or redirection will not occur.

If you are using XHR requests other than GET or POST and redirecting after the request then some browsers will follow the redirect using the original request method. This may lead to undesirable behavior such as a double DELETE. To work around this you can return a 303 See Other status code which will be followed using a GET request.

redirect_to posts_url, status: :see_other
redirect_to action: 'index', status: 303

It is also possible to assign a flash message as part of the redirection. There are two special accessors for the commonly used flash names alert and notice as well as a general purpose flash bucket.

redirect_to post_url(@post), alert: "Watch it, mister!"
redirect_to post_url(@post), status: :found, notice: "Pay attention to the road"
redirect_to post_url(@post), status: 301, flash: { updated_post_id: @post.id }
redirect_to({ action: 'atom' }, alert: "Something serious happened")

Raises:



61
62
63
64
65
66
67
68
 
# File 'lib/action_controller/metal/redirecting.rb', line 61

def redirect_to(options = {}, response_status = {}) #:doc:
  raise ActionControllerError.new("Cannot redirect to nil!") unless options
  raise AbstractController::DoubleRenderError if response_body

  self.status        = _extract_redirect_to_status(options, response_status)
  self.location      = _compute_redirect_to_location(request, options)
  self.response_body = "<html><body>You are being <a href=\"#{ERB::Util.unwrapped_html_escape(location)}\">redirected</a>.</body></html>"
end