класс ActionDispatch::Request

Родитель:: Объект
Включенные модули:: ActionDispatch::Http::Cache::Request, ActionDispatch::Http::MimeNegotiation, ActionDispatch::Http::Parameters, ActionDispatch::Http::FilterParameters, ActionDispatch::Http::URL, ActionDispatch::ContentSecurityPolicy::Request, ActionDispatch::PermissionsPolicy::Request

Константы

ENV_METHODS
HTTP_METHODS
HTTP_METHOD_LOOKUP
LOCALHOST
RFC2518: HTTP-методы из RFC 2518: HTTP Extensions for Distributed Authoring – WEBDAV
RFC2616: HTTP-методы из RFC 2616: Hypertext Transfer Protocol – HTTP/1.1
RFC3253: HTTP-методы из RFC 3253: Versioning Extensions to WebDAV
RFC3648: HTTP-методы из RFC 3648: WebDAV Ordered Collections Protocol
RFC3744: HTTP-методы из RFC 3744: WebDAV Access Control Protocol
RFC4791: HTTP-методы из RFC 4791: Calendaring Extensions to WebDAV
RFC5323: HTTP-методы из RFC 5323: WebDAV SEARCH
RFC5789: HTTP-методы из RFC 5789: PATCH Method for HTTP

Публичные методы класса

# File actionpack/lib/action_dispatch/http/request.rb, line 58
def self.empty
  new({})
end

new(env) Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 62
def initialize(env)
  super
  @method            = nil
  @request_method    = nil
  @remote_ip         = nil
  @original_fullpath = nil
  @fullpath          = nil
  @ip                = nil
end

Вызывает метод суперкласса ActionDispatch::Http::URL::new

Общие методы экземпляра

GET() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 387
def GET
  fetch_header("action_dispatch.request.query_parameters") do |k|
    rack_query_params = super || {}
    controller = path_parameters[:controller]
    action = path_parameters[:action]
    rack_query_params = Request::Utils.set_binary_encoding(self, rack_query_params, controller, action)
    # 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, Rack::QueryParser::ParamsTooDeepError => e
  raise ActionController::BadRequest.new("Invalid query parameters: #{e.message}")
end

Переопределяет метод GET фреймворка Rack для поддержки независимого доступа.

Вызывает метод суперкласса

Также алиасируется как: query_parameters

POST() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 403
def POST
  fetch_header("action_dispatch.request.request_parameters") do
    pr = parse_formatted_parameters(params_parsers) do |params|
      super || {}
    end
    pr = Request::Utils.set_binary_encoding(self, pr, path_parameters[:controller], path_parameters[:action])
    Request::Utils.check_param_encoding(pr)
    self.request_parameters = Request::Utils.normalize_encode_params(pr)
  end
rescue Rack::Utils::ParameterTypeError, Rack::Utils::InvalidParameterError, Rack::QueryParser::ParamsTooDeepError, EOFError => e
  raise ActionController::BadRequest.new("Invalid request parameters: #{e.message}")
end

Переопределяет метод POST фреймворка Rack для поддержки независимого доступа.

Вызывает метод суперкласса

Также алиасируется как: request_parameters

authorization() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 419
def authorization
  get_header("HTTP_AUTHORIZATION")   ||
  get_header("X-HTTP_AUTHORIZATION") ||
  get_header("X_HTTP_AUTHORIZATION") ||
  get_header("REDIRECT_X_HTTP_AUTHORIZATION")
end

Возвращает заголовок авторизации независимо от того, был ли он указан напрямую или через один из альтернативных прокси.

body() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 349
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

Тело запроса — это IO входной поток. Если переменная среды RAW_POST_DATA уже установлена, оберните её в StringIO.

commit_csrf_token() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 451
def commit_csrf_token
  controller_instance.commit_csrf_token(self) if controller_instance.respond_to?(:commit_csrf_token)
end

commit_flash() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 440
def commit_flash
end

content_length() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 284
def content_length
  return raw_post.bytesize if headers.key?("Transfer-Encoding")
  super.to_i
end

Возвращает длину содержимого запроса как целое число.

Вызывает метод суперкласса

controller_class() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 81
def controller_class
  params = path_parameters
  params[:action] ||= "index"
  controller_class_for(params[:controller])
end

controller_class_for(name) Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 87
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

form_data?() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 365
def form_data?
  FORM_DATA_MEDIA_TYPES.include?(media_type)
end

Определяет, содержит ли тело запроса данные формы, проверяя запрос Content-Type на соответствие одному из типов медиа: application/x-www-form-urlencoded или multipart/form-data. Список типов медиа для данных формы можно изменить через массив FORM_DATA_MEDIA_TYPES.

Тело запроса не предполагается содержащим данные формы, если не указан заголовок Content-Type и request_method имеет значение POST.

fullpath() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 263
def fullpath
  @fullpath ||= super
end

Возвращает полное String путь, включая параметры последнего запрошенного URL.

# get "/articles"
request.fullpath # => "/articles"

# get "/articles?page=2"
request.fullpath # => "/articles?page=2"

Вызывает метод суперкласса

headers() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 225
def headers
  @headers ||= Http::Headers.new(self)
end

Обеспечивает доступ к HTTP-заголовкам запроса, например:

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

http_auth_salt() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 191
def http_auth_salt
  get_header "action_dispatch.http_auth_salt"
end

ip() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 298
def ip
  @ip ||= super
end

Возвращает IP-адрес клиента в виде String.

Вызывает метод суперкласса

key?(key) Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 108
def key?(key)
  has_header? key
end

Возвращает true, если запрос имеет заголовок, соответствующий заданному ключу.

request.key? :ip_spoofing_check # => true

local?() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 427
def local?
  LOCALHOST.match?(remote_addr) && LOCALHOST.match?(remote_ip)
end

True, если запрос пришёл с localhost, 127.0.0.1 или ::1.

logger() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 436
def logger
  get_header("action_dispatch.logger")
end

media_type() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 279
def media_type
  content_mime_type&.to_s
end

Тип MIME запроса.

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

method(*args) Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 205
def method(*args)
  if args.empty?
    @method ||= check_method(
      get_header("rack.methodoverride.original_method") ||
      get_header("REQUEST_METHOD")
    )
  else
    super
  end
end

Возвращает исходное значение REQUEST_METHOD из окружения, даже если оно было переопределено посредством мидлвара. Подробнее см. request_method.

Для целей отладки, при вызове с аргументами, этот метод обратится к Object#method.

Вызывает метод суперкласса

method_symbol() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 218
def method_symbol
  HTTP_METHOD_LOOKUP[method]
end

Возвращает символьное представление method.

original_fullpath() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 252
def original_fullpath
  @original_fullpath ||= (get_header("ORIGINAL_FULLPATH") || fullpath)
end

Возвращает String с последним запрошенным путём, включая параметры.

# get '/foo'
request.original_fullpath # => '/foo'

# get '/foo?bar'
request.original_fullpath # => '/foo?bar'

original_url() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 271
def original_url
  base_url + original_fullpath
end

Возвращает оригинальный URL запроса в виде String.

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

query_parameters()

Псевдоним для: GET

END_OF_DOCUMENT_MARKER

raw_post() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 340
def raw_post
  unless has_header? "RAW_POST_DATA"
    set_header("RAW_POST_DATA", read_body_stream)
  end
  get_header "RAW_POST_DATA"
end

Считывает тело запроса. Это полезно для веб-сервисов, которые нуждаются в работе с сырыми запросами напрямую.

remote_ip() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 304
def remote_ip
  @remote_ip ||= (get_header("action_dispatch.remote_ip") || ip).to_s
end

Возвращает IP-адрес клиента в формате String, обычно устанавливаемый посредством RemoteIp middleware.

remote_ip=(remote_ip) Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 308
def remote_ip=(remote_ip)
  @remote_ip = nil
  set_header "action_dispatch.remote_ip", remote_ip
end

request_id() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 323
def request_id
  get_header ACTION_DISPATCH_REQUEST_ID
end

Возвращает уникальный идентификатор запроса, основанный на заголовке X-Request-Id, который может генерироваться брандмауэром, балансировщиком нагрузки или веб-сервером, или на RequestId middleware (которое устанавливает переменную окружения action_dispatch.request_id).

Этот уникальный идентификатор полезен для отслеживания запроса от начала до конца в рамках регистрации или отладки. Это зависит от переменной Rack, установленной ActionDispatch::RequestId middleware.

Также известен как: uuid

request_method() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 145
def request_method
  @request_method ||= check_method(super)
end

Возвращает HTTP-метод, который должно увидеть приложение. В случае, если метод был переопределен middleware (например, если запрос HEAD был преобразован в GET, или если параметр _method был использован для определения метода, который должно использовать приложение), этот метод возвращает переопределенное значение, а не исходное.

Вызывает метод суперкласса

request_method_symbol() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 196
def request_method_symbol
  HTTP_METHOD_LOOKUP[request_method]
end

Возвращает символьную форму request_method.

request_parameters()

Псевдоним для: POST

request_parameters=(params) Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 431
def request_parameters=(params)
  raise if params.nil?
  set_header("action_dispatch.request.request_parameters", params)
end

reset_csrf_token() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 447
def reset_csrf_token
  controller_instance.reset_csrf_token(self) if controller_instance.respond_to?(:reset_csrf_token)
end

reset_session() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 373
def reset_session
  session.destroy
  reset_csrf_token
end

route_uri_pattern() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 153
def route_uri_pattern
  get_header("action_dispatch.route_uri_pattern")
end

Возвращает шаблон URI сопоставленного маршрута для запроса, используя тот же формат, что и bin/rails routes.

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

send_early_hints(links) Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 241
def send_early_hints(links)
  env["rack.early_hints"]&.call(links)
end

Early Hints — это HTTP/2 код состояния, который указывает подсказки, помогающие клиенту начать подготовку к обработке конечного ответа.

Если env содержит rack.early_hints, то сервер принимает HTTP2 push для заголовков ссылок.

Метод send_early_hints принимает хеш ссылок следующим образом:

send_early_hints("link" => "</style.css>; rel=preload; as=style,</script.js>; rel=preload")

Если вы используете javascript_include_tag или stylesheet_link_tag, заголовки Early Hints включаются по умолчанию, если поддерживаются.

server_software() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 334
def server_software
  (get_header("SERVER_SOFTWARE") && /^([a-zA-Z]+)/ =~ get_header("SERVER_SOFTWARE")) ? $1.downcase : nil
end

Возвращает имя HTTP-серверного ПО в нижнем регистре.

session_options=(options) Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 382
def session_options=(options)
  Session::Options.set self, options
end

uuid()

Псевдоним для: request_id

xhr?()

Псевдоним для: xml_http_request?

xml_http_request?() Показать исходный код

# File actionpack/lib/action_dispatch/http/request.rb, line 292
def xml_http_request?
  /XMLHttpRequest/i.match?(get_header("HTTP_X_REQUESTED_WITH"))
end

Возвращает true, если заголовок X-Requested-With содержит “XMLHttpRequest” (регистр не учитывается), что может потребоваться добавить вручную в зависимости от выбора JavaScript библиотек и фреймворков.

Также известен как: xhr?