Class: ActionDispatch::Request
- Includes:
- ContentSecurityPolicy::Request, FeaturePolicy::Request, Http::Cache::Request, Http::FilterParameters, Http::MimeNegotiation, Http::Parameters, Http::URL, Rack::Request::Env, Rack::Request::Helpers
- Defined in:
- actionpack/lib/action_dispatch/http/request.rb,
actionpack/lib/action_dispatch/request/utils.rb,
actionpack/lib/action_dispatch/request/session.rb,
actionpack/lib/action_dispatch/middleware/flash.rb,
actionpack/lib/action_dispatch/middleware/cookies.rb
Direct Known Subclasses
Defined Under Namespace
Constant Summary collapse
- LOCALHOST =
Regexp.union [/^127\.\d{1,3}\.\d{1,3}\.\d{1,3}$/, /^::1$/, /^0:0:0:0:0:0:0:1(%.*)?$/]
- ENV_METHODS =
%w[ AUTH_TYPE GATEWAY_INTERFACE PATH_TRANSLATED REMOTE_HOST REMOTE_IDENT REMOTE_USER REMOTE_ADDR SERVER_NAME SERVER_PROTOCOL ORIGINAL_SCRIPT_NAME HTTP_ACCEPT HTTP_ACCEPT_CHARSET HTTP_ACCEPT_ENCODING HTTP_ACCEPT_LANGUAGE HTTP_CACHE_CONTROL HTTP_FROM HTTP_NEGOTIATE HTTP_PRAGMA HTTP_CLIENT_IP HTTP_X_FORWARDED_FOR HTTP_ORIGIN HTTP_VERSION HTTP_X_CSRF_TOKEN HTTP_X_REQUEST_ID HTTP_X_FORWARDED_HOST SERVER_ADDR ].freeze
- PASS_NOT_FOUND =
:nodoc:
Class.new { # :nodoc: def self.action(_); self; end def self.call(_); [404, { "X-Cascade" => "pass" }, []]; end def self.binary_params_for?(action); false; end }
- RFC2616 =
List of HTTP request methods from the following RFCs: Hypertext Transfer Protocol – HTTP/1.1 (www.ietf.org/rfc/rfc2616.txt) HTTP Extensions for Distributed Authoring – WEBDAV (www.ietf.org/rfc/rfc2518.txt) Versioning Extensions to WebDAV (www.ietf.org/rfc/rfc3253.txt) Ordered Collections Protocol (WebDAV) (www.ietf.org/rfc/rfc3648.txt) Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol (www.ietf.org/rfc/rfc3744.txt) Web Distributed Authoring and Versioning (WebDAV) SEARCH (www.ietf.org/rfc/rfc5323.txt) Calendar Extensions to WebDAV (www.ietf.org/rfc/rfc4791.txt) PATCH Method for HTTP (www.ietf.org/rfc/rfc5789.txt)
%w(OPTIONS GET HEAD POST PUT DELETE TRACE CONNECT)
- RFC2518 =
%w(PROPFIND PROPPATCH MKCOL COPY MOVE LOCK UNLOCK)
- RFC3253 =
%w(VERSION-CONTROL REPORT CHECKOUT CHECKIN UNCHECKOUT MKWORKSPACE UPDATE LABEL MERGE BASELINE-CONTROL MKACTIVITY)
- RFC3648 =
%w(ORDERPATCH)
- RFC3744 =
%w(ACL)
- RFC5323 =
%w(SEARCH)
- RFC4791 =
%w(MKCALENDAR)
- RFC5789 =
%w(PATCH)
- HTTP_METHODS =
RFC2616 + RFC2518 + RFC3253 + RFC3648 + RFC3744 + RFC5323 + RFC4791 + RFC5789
- HTTP_METHOD_LOOKUP =
{}
- ACTION_DISPATCH_REQUEST_ID =
:nodoc:
"action_dispatch.request_id"
Constants included from FeaturePolicy::Request
FeaturePolicy::Request::POLICY
Constants included from ContentSecurityPolicy::Request
ContentSecurityPolicy::Request::NONCE, ContentSecurityPolicy::Request::NONCE_DIRECTIVES, ContentSecurityPolicy::Request::NONCE_GENERATOR, ContentSecurityPolicy::Request::POLICY, ContentSecurityPolicy::Request::POLICY_REPORT_ONLY
Constants included from Http::URL
Http::URL::HOST_REGEXP, Http::URL::IP_HOST_REGEXP, Http::URL::PROTOCOL_REGEXP
Constants included from Http::FilterParameters
Http::FilterParameters::ENV_MATCH, Http::FilterParameters::NULL_ENV_FILTER, Http::FilterParameters::NULL_PARAM_FILTER
Constants included from Http::Parameters
Http::Parameters::DEFAULT_PARSERS, Http::Parameters::PARAMETERS_KEY
Constants included from Http::MimeNegotiation
Http::MimeNegotiation::RESCUABLE_MIME_FORMAT_ERRORS
Constants included from Http::Cache::Request
Http::Cache::Request::HTTP_IF_MODIFIED_SINCE, Http::Cache::Request::HTTP_IF_NONE_MATCH
Class Method Summary collapse
Instance Method Summary collapse
- #authenticated_encrypted_cookie_salt ⇒ Object
-
#authorization ⇒ Object
Returns the authorization header regardless of whether it was specified directly or through one of the proxy alternatives.
-
#body ⇒ Object
The request body is an IO input stream.
-
#body_stream ⇒ Object
:nodoc:.
-
#commit_cookie_jar! ⇒ Object
:nodoc:.
- #commit_flash ⇒ Object
-
#content_length ⇒ Object
Returns the content length of the request as an integer.
- #controller_class ⇒ Object
- #controller_class_for(name) ⇒ Object
-
#controller_instance ⇒ Object
:nodoc:.
-
#controller_instance=(controller) ⇒ Object
:nodoc:.
- #cookie_jar ⇒ Object
- #cookie_jar=(jar) ⇒ Object
- #cookies_digest ⇒ Object
- #cookies_rotations ⇒ Object
- #cookies_same_site_protection ⇒ Object
- #cookies_serializer ⇒ Object
- #encrypted_cookie_cipher ⇒ Object
- #encrypted_cookie_salt ⇒ Object
- #encrypted_signed_cookie_salt ⇒ Object
-
#engine_script_name(_routes) ⇒ Object
:nodoc:.
-
#engine_script_name=(name) ⇒ Object
:nodoc:.
-
#form_data? ⇒ Boolean
Determine whether the request body contains form-data by checking the request Content-Type for one of the media-types: “application/x-www-form-urlencoded” or “multipart/form-data”.
-
#fullpath ⇒ Object
Returns the
String
full path including params of the last URL requested. -
#GET ⇒ Object
(also: #query_parameters)
Override Rack’s GET method to support indifferent access.
- #have_cookie_jar? ⇒ Boolean
-
#headers ⇒ Object
Provides access to the request’s HTTP headers, for example:.
- #http_auth_salt ⇒ Object
-
#initialize(env) ⇒ Request
constructor
A new instance of Request.
-
#ip ⇒ Object
Returns the IP address of client as a
String
. -
#key?(key) ⇒ Boolean
Returns true if the request has a header matching the given key parameter.
- #key_generator ⇒ Object
-
#local? ⇒ Boolean
True if the request came from localhost, 127.0.0.1, or ::1.
- #logger ⇒ Object
-
#media_type ⇒ Object
The
String
MIME type of the request. -
#method ⇒ Object
Returns the original value of the environment’s REQUEST_METHOD, even if it was overridden by middleware.
-
#method_symbol ⇒ Object
Returns a symbol form of the #method.
-
#original_fullpath ⇒ Object
Returns a
String
with the last requested path including their params. -
#original_url ⇒ Object
Returns the original request URL as a
String
. -
#POST ⇒ Object
(also: #request_parameters)
Override Rack’s POST method to support indifferent access.
-
#raw_post ⇒ Object
Read the request body.
-
#remote_ip ⇒ Object
Returns the IP address of client as a
String
, usually set by the RemoteIp middleware. - #remote_ip=(remote_ip) ⇒ Object
-
#request_id ⇒ Object
(also: #uuid)
Returns the unique request id, which is based on either the X-Request-Id header that can be generated by a firewall, load balancer, or web server or by the RequestId middleware (which sets the action_dispatch.request_id environment variable).
-
#request_id=(id) ⇒ Object
:nodoc:.
-
#request_method ⇒ Object
Returns the HTTP method that the application should see.
-
#request_method=(request_method) ⇒ Object
:nodoc:.
-
#request_method_symbol ⇒ Object
Returns a symbol form of the #request_method.
- #request_parameters=(params) ⇒ Object
-
#reset_session ⇒ Object
TODO This should be broken apart into AD::Request::Session and probably be included by the session middleware.
-
#routes ⇒ Object
:nodoc:.
-
#routes=(routes) ⇒ Object
:nodoc:.
- #secret_key_base ⇒ Object
-
#send_early_hints(links) ⇒ Object
Early Hints is an HTTP/2 status code that indicates hints to help a client start making preparations for processing the final response.
-
#server_software ⇒ Object
Returns the lowercase name of the HTTP server software.
-
#session=(session) ⇒ Object
:nodoc:.
- #session_options=(options) ⇒ Object
-
#show_exceptions? ⇒ Boolean
:nodoc:.
- #signed_cookie_digest ⇒ Object
- #signed_cookie_salt ⇒ Object
- #ssl? ⇒ Boolean
- #use_authenticated_cookie_encryption ⇒ Object
- #use_cookies_with_metadata ⇒ Object
-
#xml_http_request? ⇒ Boolean
(also: #xhr?)
Returns true if the “X-Requested-With” header contains “XMLHttpRequest” (case-insensitive), which may need to be manually added depending on the choice of JavaScript libraries and frameworks.
Methods included from FeaturePolicy::Request
#feature_policy, #feature_policy=
Methods included from ContentSecurityPolicy::Request
#content_security_policy, #content_security_policy=, #content_security_policy_nonce, #content_security_policy_nonce_directives, #content_security_policy_nonce_directives=, #content_security_policy_nonce_generator, #content_security_policy_nonce_generator=, #content_security_policy_report_only, #content_security_policy_report_only=
Methods included from Http::URL
#domain, extract_domain, extract_subdomain, extract_subdomains, full_url_for, #host, #host_with_port, #optional_port, path_for, #port, #port_string, #protocol, #raw_host_with_port, #server_port, #standard_port, #standard_port?, #subdomain, #subdomains, #url, url_for
Methods included from Http::FilterParameters
#filtered_env, #filtered_parameters, #filtered_path
Methods included from Http::Parameters
#parameters, #path_parameters, #path_parameters=
Methods included from ActiveSupport::Concern
#append_features, #class_methods, extended, #included
Methods included from Http::MimeNegotiation
#accepts, #content_mime_type, #content_type, #format, #format=, #formats, #formats=, #has_content_type?, #negotiate_mime, #should_apply_vary_header?, #variant, #variant=
Methods included from Http::Cache::Request
#etag_matches?, #fresh?, #if_modified_since, #if_none_match, #if_none_match_etags, #not_modified?
Constructor Details
#initialize(env) ⇒ Request
Returns a new instance of Request.
60 61 62 63 64 65 66 67 68 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 60 def initialize(env) super @method = nil @request_method = nil @remote_ip = nil @original_fullpath = nil @fullpath = nil @ip = nil end |
Class Method Details
.empty ⇒ Object
56 57 58 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 56 def self.empty new({}) end |
Instance Method Details
#authenticated_encrypted_cookie_salt ⇒ Object
48 49 50 |
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 48 def get_header Cookies::AUTHENTICATED_ENCRYPTED_COOKIE_SALT end |
#authorization ⇒ Object
Returns the authorization header regardless of whether it was specified directly or through one of the proxy alternatives.
403 404 405 406 407 408 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 403 def get_header("HTTP_AUTHORIZATION") || get_header("X-HTTP_AUTHORIZATION") || get_header("X_HTTP_AUTHORIZATION") || get_header("REDIRECT_X_HTTP_AUTHORIZATION") end |
#body ⇒ Object
The request body is an IO input stream. If the RAW_POST_DATA environment variable is already set, wrap it in a StringIO.
332 333 334 335 336 337 338 339 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 332 def body if raw_post = get_header("RAW_POST_DATA") raw_post = raw_post.dup.force_encoding(Encoding::BINARY) StringIO.new(raw_post) else body_stream end end |
#body_stream ⇒ Object
:nodoc:
353 354 355 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 353 def body_stream #:nodoc: get_header("rack.input") end |
#commit_cookie_jar! ⇒ Object
:nodoc:
70 71 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 70 def # :nodoc: end |
#commit_flash ⇒ Object
424 425 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 424 def commit_flash end |
#content_length ⇒ Object
Returns the content length of the request as an integer.
268 269 270 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 268 def content_length super.to_i end |
#controller_class ⇒ Object
79 80 81 82 83 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 79 def controller_class params = path_parameters params[:action] ||= "index" controller_class_for(params[:controller]) end |
#controller_class_for(name) ⇒ Object
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 85 def controller_class_for(name) if name controller_param = name.underscore const_name = controller_param.camelize << "Controller" begin ActiveSupport::Dependencies.constantize(const_name) rescue NameError => error if error.missing_name == const_name || const_name.start_with?("#{error.missing_name}::") raise MissingController.new(error., error.name) else raise end end else PASS_NOT_FOUND end end |
#controller_instance ⇒ Object
:nodoc:
169 170 171 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 169 def controller_instance # :nodoc: get_header("action_controller.instance") end |
#controller_instance=(controller) ⇒ Object
:nodoc:
173 174 175 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 173 def controller_instance=(controller) # :nodoc: set_header("action_controller.instance", controller) end |
#cookie_jar ⇒ Object
11 12 13 14 15 |
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 11 def fetch_header("action_dispatch.cookies") do self. = Cookies::CookieJar.build(self, ) end end |
#cookie_jar=(jar) ⇒ Object
28 29 30 |
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 28 def (jar) set_header "action_dispatch.cookies", jar end |
#cookies_digest ⇒ Object
76 77 78 |
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 76 def get_header Cookies::COOKIES_DIGEST end |
#cookies_rotations ⇒ Object
80 81 82 |
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 80 def get_header Cookies::COOKIES_ROTATIONS end |
#cookies_same_site_protection ⇒ Object
72 73 74 |
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 72 def get_header Cookies::COOKIES_SAME_SITE_PROTECTION end |
#cookies_serializer ⇒ Object
68 69 70 |
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 68 def get_header Cookies::COOKIES_SERIALIZER end |
#encrypted_cookie_cipher ⇒ Object
56 57 58 |
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 56 def get_header Cookies::ENCRYPTED_COOKIE_CIPHER end |
#encrypted_cookie_salt ⇒ Object
40 41 42 |
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 40 def get_header Cookies::ENCRYPTED_COOKIE_SALT end |
#encrypted_signed_cookie_salt ⇒ Object
44 45 46 |
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 44 def get_header Cookies::ENCRYPTED_SIGNED_COOKIE_SALT end |
#engine_script_name(_routes) ⇒ Object
:nodoc:
155 156 157 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 155 def engine_script_name(_routes) # :nodoc: get_header(_routes.env_key) end |
#engine_script_name=(name) ⇒ Object
:nodoc:
159 160 161 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 159 def engine_script_name=(name) # :nodoc: set_header(routes.env_key, name.dup) end |
#form_data? ⇒ Boolean
Determine whether the request body contains form-data by checking the request Content-Type for one of the media-types: “application/x-www-form-urlencoded” or “multipart/form-data”. The list of form-data media types can be modified through the FORM_DATA_MEDIA_TYPES
array.
A request body is not assumed to contain form-data when no Content-Type header is provided and the request_method is POST.
349 350 351 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 349 def form_data? FORM_DATA_MEDIA_TYPES.include?(media_type) end |
#fullpath ⇒ Object
Returns the String
full path including params of the last URL requested.
# get "/articles"
request.fullpath # => "/articles"
# get "/articles?page=2"
request.fullpath # => "/articles?page=2"
247 248 249 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 247 def fullpath @fullpath ||= super end |
#GET ⇒ Object Also known as: query_parameters
Override Rack’s GET method to support indifferent access.
376 377 378 379 380 381 382 383 384 385 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 376 def GET fetch_header("action_dispatch.request.query_parameters") do |k| rack_query_params = super || {} # Check for non UTF-8 parameter values, which would cause errors later Request::Utils.check_param_encoding(rack_query_params) set_header k, Request::Utils.normalize_encode_params(rack_query_params) end rescue Rack::Utils::ParameterTypeError, Rack::Utils::InvalidParameterError => e raise ActionController::BadRequest.new("Invalid query parameters: #{e.}") end |
#have_cookie_jar? ⇒ Boolean
24 25 26 |
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 24 def has_header? "action_dispatch.cookies" end |
#headers ⇒ Object
Provides access to the request’s HTTP headers, for example:
request.headers["Content-Type"] # => "text/plain"
208 209 210 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 208 def headers @headers ||= Http::Headers.new(self) end |
#http_auth_salt ⇒ Object
177 178 179 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 177 def http_auth_salt get_header "action_dispatch.http_auth_salt" end |
#ip ⇒ Object
Returns the IP address of client as a String
.
281 282 283 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 281 def ip @ip ||= super end |
#key?(key) ⇒ Boolean
Returns true if the request has a header matching the given key parameter.
request.key? :ip_spoofing_check # => true
106 107 108 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 106 def key?(key) has_header? key end |
#key_generator ⇒ Object
32 33 34 |
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 32 def key_generator get_header Cookies::GENERATOR_KEY end |
#local? ⇒ Boolean
True if the request came from localhost, 127.0.0.1, or ::1.
411 412 413 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 411 def local? LOCALHOST.match?(remote_addr) && LOCALHOST.match?(remote_ip) end |
#logger ⇒ Object
420 421 422 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 420 def logger get_header("action_dispatch.logger") end |
#media_type ⇒ Object
The String
MIME type of the request.
# get "/articles"
request.media_type # => "application/x-www-form-urlencoded"
263 264 265 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 263 def media_type content_mime_type.to_s end |
#method ⇒ Object
Returns the original value of the environment’s REQUEST_METHOD, even if it was overridden by middleware. See #request_method for more information.
196 197 198 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 196 def method @method ||= check_method(get_header("rack.methodoverride.original_method") || get_header("REQUEST_METHOD")) end |
#method_symbol ⇒ Object
Returns a symbol form of the #method.
201 202 203 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 201 def method_symbol HTTP_METHOD_LOOKUP[method] end |
#original_fullpath ⇒ Object
Returns a String
with the last requested path including their params.
# get '/foo'
request.original_fullpath # => '/foo'
# get '/foo?bar'
request.original_fullpath # => '/foo?bar'
236 237 238 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 236 def original_fullpath @original_fullpath ||= (get_header("ORIGINAL_FULLPATH") || fullpath) end |
#original_url ⇒ Object
Returns the original request URL as a String
.
# get "/articles?page=2"
request.original_url # => "http://www.example.com/articles?page=2"
255 256 257 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 255 def original_url base_url + original_fullpath end |
#POST ⇒ Object Also known as: request_parameters
Override Rack’s POST method to support indifferent access.
389 390 391 392 393 394 395 396 397 398 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 389 def POST fetch_header("action_dispatch.request.request_parameters") do pr = parse_formatted_parameters(params_parsers) do |params| super || {} end self.request_parameters = Request::Utils.normalize_encode_params(pr) end rescue Rack::Utils::ParameterTypeError, Rack::Utils::InvalidParameterError => e raise ActionController::BadRequest.new("Invalid request parameters: #{e.}") end |
#raw_post ⇒ Object
Read the request body. This is useful for web services that need to work with raw requests directly.
321 322 323 324 325 326 327 328 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 321 def raw_post unless has_header? "RAW_POST_DATA" raw_post_body = body set_header("RAW_POST_DATA", raw_post_body.read(content_length)) raw_post_body.rewind if raw_post_body.respond_to?(:rewind) end get_header "RAW_POST_DATA" end |
#remote_ip ⇒ Object
Returns the IP address of client as a String
, usually set by the RemoteIp middleware.
287 288 289 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 287 def remote_ip @remote_ip ||= (get_header("action_dispatch.remote_ip") || ip).to_s end |
#remote_ip=(remote_ip) ⇒ Object
291 292 293 294 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 291 def remote_ip=(remote_ip) @remote_ip = nil set_header "action_dispatch.remote_ip", remote_ip end |
#request_id ⇒ Object Also known as: uuid
Returns the unique request id, which is based on either the X-Request-Id header that can be generated by a firewall, load balancer, or web server or by the RequestId middleware (which sets the action_dispatch.request_id environment variable).
This unique ID is useful for tracing a request from end-to-end as part of logging or debugging. This relies on the Rack variable set by the ActionDispatch::RequestId middleware.
304 305 306 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 304 def request_id get_header ACTION_DISPATCH_REQUEST_ID end |
#request_id=(id) ⇒ Object
:nodoc:
308 309 310 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 308 def request_id=(id) # :nodoc: set_header ACTION_DISPATCH_REQUEST_ID, id end |
#request_method ⇒ Object
Returns the HTTP method that the application should see. In the case where the method was overridden by a middleware (for instance, if a HEAD request was converted to a GET, or if a _method parameter was used to determine the method the application should use), this method returns the overridden value, not the original.
143 144 145 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 143 def request_method @request_method ||= check_method(super) end |
#request_method=(request_method) ⇒ Object
:nodoc:
163 164 165 166 167 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 163 def request_method=(request_method) #:nodoc: if check_method(request_method) @request_method = set_header("REQUEST_METHOD", request_method) end end |
#request_method_symbol ⇒ Object
Returns a symbol form of the #request_method.
189 190 191 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 189 def request_method_symbol HTTP_METHOD_LOOKUP[request_method] end |
#request_parameters=(params) ⇒ Object
415 416 417 418 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 415 def request_parameters=(params) raise if params.nil? set_header("action_dispatch.request.request_parameters", params) end |
#reset_session ⇒ Object
TODO This should be broken apart into AD::Request::Session and probably be included by the session middleware.
359 360 361 362 363 364 365 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 359 def reset_session if session && session.respond_to?(:destroy) session.destroy else self.session = {} end end |
#routes ⇒ Object
:nodoc:
147 148 149 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 147 def routes # :nodoc: get_header("action_dispatch.routes") end |
#routes=(routes) ⇒ Object
:nodoc:
151 152 153 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 151 def routes=(routes) # :nodoc: set_header("action_dispatch.routes", routes) end |
#secret_key_base ⇒ Object
64 65 66 |
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 64 def secret_key_base get_header Cookies::SECRET_KEY_BASE end |
#send_early_hints(links) ⇒ Object
Early Hints is an HTTP/2 status code that indicates hints to help a client start making preparations for processing the final response.
If the env contains rack.early_hints
then the server accepts HTTP2 push for Link headers.
The send_early_hints
method accepts a hash of links as follows:
send_early_hints("Link" => "</style.css>; rel=preload; as=style\n</script.js>; rel=preload")
If you are using javascript_include_tag
or stylesheet_link_tag
the Early Hints headers are included by default if supported.
223 224 225 226 227 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 223 def send_early_hints(links) return unless env["rack.early_hints"] env["rack.early_hints"].call(links) end |
#server_software ⇒ Object
Returns the lowercase name of the HTTP server software.
315 316 317 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 315 def server_software (get_header("SERVER_SOFTWARE") && /^([a-zA-Z]+)/ =~ get_header("SERVER_SOFTWARE")) ? $1.downcase : nil end |
#session=(session) ⇒ Object
:nodoc:
367 368 369 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 367 def session=(session) #:nodoc: Session.set self, session end |
#session_options=(options) ⇒ Object
371 372 373 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 371 def () Session::Options.set self, end |
#show_exceptions? ⇒ Boolean
:nodoc:
181 182 183 184 185 186 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 181 def show_exceptions? # :nodoc: # We're treating `nil` as "unset", and we want the default setting to be # `true`. This logic should be extracted to `env_config` and calculated # once. !(get_header("action_dispatch.show_exceptions") == false) end |
#signed_cookie_digest ⇒ Object
60 61 62 |
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 60 def get_header Cookies::SIGNED_COOKIE_DIGEST end |
#signed_cookie_salt ⇒ Object
36 37 38 |
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 36 def get_header Cookies::SIGNED_COOKIE_SALT end |
#ssl? ⇒ Boolean
427 428 429 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 427 def ssl? super || scheme == "wss" end |
#use_authenticated_cookie_encryption ⇒ Object
52 53 54 |
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 52 def get_header Cookies::USE_AUTHENTICATED_COOKIE_ENCRYPTION end |
#use_cookies_with_metadata ⇒ Object
84 85 86 |
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 84 def get_header Cookies::USE_COOKIES_WITH_METADATA end |
#xml_http_request? ⇒ Boolean Also known as: xhr?
Returns true if the “X-Requested-With” header contains “XMLHttpRequest” (case-insensitive), which may need to be manually added depending on the choice of JavaScript libraries and frameworks.
275 276 277 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 275 def xml_http_request? /XMLHttpRequest/i.match?(get_header("HTTP_X_REQUESTED_WITH")) end |