класс ActionDispatch::Request

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

Константы

ENV_METHODS
HTTP_METHODS
HTTP_METHOD_LOOKUP
LOCALHOST
RFC2518
RFC2616: Список HTTP-методов запросов из следующих RFC: Протокол передачи гипертекста – HTTP/1.1 (www.ietf.org/rfc/rfc2616.txt) Расширения HTTP для распределенного редактирования – WEBDAV (www.ietf.org/rfc/rfc2518.txt) Расширения версии для WebDAV (www.ietf.org/rfc/rfc3253.txt) Протокол упорядоченных коллекций (WebDAV) (www.ietf.org/rfc/rfc3648.txt) Web Distributed Authoring and Versioning (WebDAV) Протокол управления доступом (www.ietf.org/rfc/rfc3744.txt) Web Distributed Authoring and Versioning (WebDAV) SEARCH (www.ietf.org/rfc/rfc5323.txt) Расширения для календарей WebDAV (www.ietf.org/rfc/rfc4791.txt) PATCH Метод для HTTP (www.ietf.org/rfc/rfc5789.txt)
RFC3253
RFC3648
RFC3744
RFC4791
RFC5323
RFC5789

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

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 56
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 339
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.message}")
end

Переопределите метод #GET Rack для поддержки неопределенного доступа

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

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 352
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 ParamsParser::ParseError # one of the parse strategies blew up
  self.request_parameters = Request::Utils.normalize_encode_params(super || {})
  raise
rescue Rack::Utils::ParameterTypeError, Rack::Utils::InvalidParameterError => 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 369
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 295
def body
  if raw_post = get_header('RAW_POST_DATA')
    raw_post.force_encoding(Encoding::BINARY)
    StringIO.new(raw_post)
  else
    body_stream
  end
end

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

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

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 232
def content_length
  super.to_i
end

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

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 74
def controller_class
  params = path_parameters

  if params.key?(:controller)
    controller_param = params[:controller].underscore
    params[:action] ||= 'index'
    const_name = "#{controller_param.camelize}Controller"
    ActiveSupport::Dependencies.constantize(const_name)
  else
    PASS_NOT_FOUND
  end
end

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

# File actionpack/lib/action_dispatch/middleware/cookies.rb, line 9
def cookie_jar
  fetch_header('action_dispatch.cookies'.freeze) do
    self.cookie_jar = Cookies::CookieJar.build(self, cookies)
  end
end

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

# File actionpack/lib/action_dispatch/http/request.rb, line 312
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 211
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 189
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 158
def http_auth_salt
  get_header "action_dispatch.http_auth_salt"
end

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

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

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

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

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

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 377
def local?
  LOCALHOST =~ remote_addr && LOCALHOST =~ remote_ip
end

Истинно, если запрос поступил с локального хоста, 127.0.0.1 или ::1.

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

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

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

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

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

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 177
def method
  @method ||= check_method(get_header("rack.methodoverride.original_method") || get_header('REQUEST_METHOD'))
end

Возвращает исходное значение REQUEST_METHOD среды, даже если оно было переопределено middleware. См. request_method для получения дополнительной информации.

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

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

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

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

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 284
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() Показать исходный код

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

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

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

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

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

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

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

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

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 124
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 170
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 381
def request_parameters=(params)
  raise if params.nil?
  set_header("action_dispatch.request.request_parameters".freeze, params)
end

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

# File actionpack/lib/action_dispatch/http/request.rb, line 322
def reset_session
  if session && session.respond_to?(:destroy)
    session.destroy
  else
    self.session = {}
  end
end

TODO Необходимо разделить на AD::Request::Session и, вероятно, включить в middleware сессии.

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

# File actionpack/lib/action_dispatch/http/request.rb, line 278
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 334
def session_options=(options)
  Session::Options.set self, options
end

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

# File actionpack/lib/action_dispatch/http/request.rb, line 393
def ssl?
  super || scheme == 'wss'.freeze
end

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

uuid()

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

xhr?()

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 239
def xml_http_request?
  get_header('HTTP_X_REQUESTED_WITH') =~ /XMLHttpRequest/i
end

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

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