ActionDispatch::Request (original) (raw)

Methods

G

P

A

B

C

E

F

H

I

K

L

M

N

O

Q

R

S

U

X

Included Modules

Constants

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 ].freeze
HTTP_METHODS = RFC2616 + RFC2518 + RFC3253 + RFC3648 + RFC3744 + RFC5323 + RFC4791 + RFC5789
HTTP_METHOD_LOOKUP = {}
LOCALHOST = Regexp.union [/^127\.\d{1,3}\.\d{1,3}\.\d{1,3}$/, /^::1$/, /^0:0:0:0:0:0:0:1(%.*)?$/]
RFC2518 = %w(PROPFIND PROPPATCH MKCOL COPY MOVE LOCK UNLOCK)
HTTP methods from RFC 2518: HTTP Extensions for Distributed Authoring – WEBDAV
RFC2616 = %w(OPTIONS GET HEAD POST PUT DELETE TRACE CONNECT)
HTTP methods from RFC 2616: Hypertext Transfer Protocol – HTTP/1.1
RFC3253 = %w(VERSION-CONTROL REPORT CHECKOUT CHECKIN UNCHECKOUT MKWORKSPACE UPDATE LABEL MERGE BASELINE-CONTROL MKACTIVITY)
HTTP methods from RFC 3253: Versioning Extensions to WebDAV
RFC3648 = %w(ORDERPATCH)
HTTP methods from RFC 3648: WebDAV Ordered Collections Protocol
RFC3744 = %w(ACL)
HTTP methods from RFC 3744: WebDAV Access Control Protocol
RFC4791 = %w(MKCALENDAR)
HTTP methods from RFC 4791: Calendaring Extensions to WebDAV
RFC5323 = %w(SEARCH)
HTTP methods from RFC 5323: WebDAV SEARCH
RFC5789 = %w(PATCH)
HTTP methods from RFC 5789: PATCH Method for HTTP

Attributes

Class Public methods

Source: show | on GitHub

def initialize(env) super

@rack_request = Rack::Request.new(env)

@method = nil @request_method = nil @remote_ip = nil @original_fullpath = nil @fullpath = nil @ip = nil end

Instance Public methods

Override Rack’s GET method to support indifferent access.

Source: show | on GitHub

def GET fetch_header("action_dispatch.request.query_parameters") do |k| encoding_template = Request::Utils::CustomParamEncoder.action_encoding_template(self, path_parameters[:controller], path_parameters[:action]) rack_query_params = ActionDispatch::ParamBuilder.from_query_string(rack_request.query_string, encoding_template: encoding_template)

set_header k, rack_query_params

end rescue ActionDispatch::ParamError => e raise ActionController::BadRequest.new("Invalid query parameters: #{e.message}") end

Override Rack’s POST method to support indifferent access.

Source: show | on GitHub

def POST fetch_header("action_dispatch.request.request_parameters") do encoding_template = Request::Utils::CustomParamEncoder.action_encoding_template(self, path_parameters[:controller], path_parameters[:action])

param_list = nil
pr = parse_formatted_parameters(params_parsers) do
  if param_list = request_parameters_list
    ActionDispatch::ParamBuilder.from_pairs(param_list, encoding_template: encoding_template)
  else
    
    
    fallback_request_parameters
  end
end


if param_list.nil?
  pr = ActionDispatch::ParamBuilder.from_hash(pr, encoding_template: encoding_template)
end

self.request_parameters = pr

end rescue ActionDispatch::ParamError, EOFError => e raise ActionController::BadRequest.new("Invalid request parameters: #{e.message}") end

Returns the authorization header regardless of whether it was specified directly or through one of the proxy alternatives.

Source: show | on GitHub

def authorization get_header("HTTP_AUTHORIZATION") || get_header("X-HTTP_AUTHORIZATION") || get_header("X_HTTP_AUTHORIZATION") || get_header("REDIRECT_X_HTTP_AUTHORIZATION") end

The request body is an IO input stream. If the RAW_POST_DATA environment variable is already set, wrap it in a StringIO.

Source: show | on GitHub

def body if raw_post = get_header("RAW_POST_DATA") raw_post = (+raw_post).force_encoding(Encoding::BINARY) StringIO.new(raw_post) else body_stream end end

Source: show | on GitHub

def commit_csrf_token controller_instance.commit_csrf_token(self) if controller_instance.respond_to?(:commit_csrf_token) end

content_length()Link

Returns the content length of the request as an integer.

Source: show | on GitHub

def content_length return raw_post.bytesize if has_header?(TRANSFER_ENCODING) super.to_i end

Source: show | on GitHub

def controller_class params = path_parameters params[:action] ||= "index" controller_class_for(params[:controller]) end

Source: show | on GitHub

def controller_class_for(name) if name controller_param = name.underscore const_name = controller_param.camelize << "Controller" begin const_name.constantize rescue NameError => error if error.missing_name == const_name || const_name.start_with?("#{error.missing_name}::") raise MissingController.new(error.message, error.name) else raise end end else PASS_NOT_FOUND end end

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.

Source: show | on GitHub

def form_data? FORM_DATA_MEDIA_TYPES.include?(media_type) end

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"

Provides access to the request’s HTTP headers, for example:

request.headers["Content-Type"] # => "text/plain"

Source: show | on GitHub

def http_auth_salt get_header "action_dispatch.http_auth_salt" end

Returns the IP address of client as a String.

Returns true if the request has a header matching the given key parameter.

request.key? :ip_spoofing_check # => true

True if the request came from localhost, 127.0.0.1, or ::1.

Source: show | on GitHub

def local? LOCALHOST.match?(remote_addr) && LOCALHOST.match?(remote_ip) end

Source: show | on GitHub

def logger get_header("action_dispatch.logger") end

The String MIME type of the request.

# get "/articles"
request.media_type # => "application/x-www-form-urlencoded"

Returns the original value of the environment’s REQUEST_METHOD, even if it was overridden by middleware. See request_method for more information.

For debugging purposes, when called with arguments this method will fall back to Object#method

Source: show | on GitHub

def method(*args) if args.empty? @method ||= check_method( get_header("rack.methodoverride.original_method") || get_header("REQUEST_METHOD") ) else super end end

Returns a symbol form of the method.

Source: show | on GitHub

def method_symbol HTTP_METHOD_LOOKUP[method] end

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'

Source: show | on GitHub

def original_fullpath @original_fullpath ||= (get_header("ORIGINAL_FULLPATH") || fullpath) end

Returns the original request URL as a String.

# get "/articles?page=2"
request.original_url # => "http://www.example.com/articles?page=2"

Source: show | on GitHub

def original_url base_url + original_fullpath end

Alias for: GET

Read the request body. This is useful for web services that need to work with raw requests directly.

Source: show | on GitHub

def raw_post unless has_header? "RAW_POST_DATA" set_header("RAW_POST_DATA", read_body_stream) end get_header "RAW_POST_DATA" end

Returns the IP address of client as a String, usually set by the RemoteIp middleware.

Source: show | on GitHub

def remote_ip @remote_ip ||= (get_header("action_dispatch.remote_ip") || ip).to_s end

Source: show | on GitHub

def remote_ip=(remote_ip) @remote_ip = nil set_header "action_dispatch.remote_ip", remote_ip end

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.

Also aliased as: uuid

Source: show | on GitHub

def request_id get_header ACTION_DISPATCH_REQUEST_ID end

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.

Source: show | on GitHub

def request_method @request_method ||= check_method(super) end

Source: show | on GitHub

def request_method_symbol HTTP_METHOD_LOOKUP[request_method] end

Source: show | on GitHub

def request_parameters=(params) raise if params.nil? set_header("action_dispatch.request.request_parameters", params) end

Source: show | on GitHub

def request_parameters_list

rack_post = rack_request.POST

if form_pairs = get_header("rack.request.form_pairs")

form_pairs

elsif form_vars = get_header("rack.request.form_vars")

ActionDispatch::QueryParser.each_pair(form_vars)

elsif rack_post && !rack_post.empty?

nil

else

[]

end end

Source: show | on GitHub

def reset_csrf_token controller_instance.reset_csrf_token(self) if controller_instance.respond_to?(:reset_csrf_token) end

Source: show | on GitHub

def reset_session session.destroy reset_csrf_token end

Returns the URI pattern of the matched route for the request, using the same format as bin/rails routes:

request.route_uri_pattern # => "/:controller(/:action(/:id))(.:format)"

Source: show | on GitHub

def route_uri_pattern get_header("action_dispatch.route_uri_pattern") end

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,</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.

Source: show | on GitHub

def send_early_hints(links) env["rack.early_hints"]&.call(links) end

Returns the lowercase name of the HTTP server software.

Source: show | on GitHub

def server_software (get_header("SERVER_SOFTWARE") && /^([a-zA-Z]+)/ =~ get_header("SERVER_SOFTWARE")) ? $1.downcase : nil end

Source: show | on GitHub

def session_options=(options) Session::Options.set self, options end

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.

Also aliased as: xhr?

Source: show | on GitHub

def xml_http_request? /XMLHttpRequest/i.match?(get_header("HTTP_X_REQUESTED_WITH")) end