класс ActionDispatch::Request

Родитель:: Rack::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) Протокол управления доступом к WebDAV (Web Distributed Authoring and Versioning) (www.ietf.org/rfc/rfc3744.txt) WebDAV (Web Distributed Authoring and Versioning) поиск (www.ietf.org/rfc/rfc5323.txt) PATCH Метод для HTTP (www.ietf.org/rfc/rfc5789.txt)
RFC3253
RFC3648
RFC3744
RFC5323
RFC5789

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

Вызывает метод родительского класса ActionDispatch::Http::URL.new

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

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

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

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 273
def GET
  @env["action_dispatch.request.query_parameters"] ||= Utils.deep_munge((normalize_encode_params(super) || {}))
rescue TypeError => e
  raise ActionController::BadRequest.new(:query, e)
end

Также алиасирован как: query_parameters

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

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 281
def POST
  @env["action_dispatch.request.request_parameters"] ||= Utils.deep_munge((normalize_encode_params(super) || {}))
rescue TypeError => e
  raise ActionController::BadRequest.new(:request, e)
end

Также алиасирован как: request_parameters

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 290
def authorization
  @env['HTTP_AUTHORIZATION']   ||
  @env['X-HTTP_AUTHORIZATION'] ||
  @env['X_HTTP_AUTHORIZATION'] ||
  @env['REDIRECT_X_HTTP_AUTHORIZATION']
end

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 236
def body
  if raw_post = @env['RAW_POST_DATA']
    raw_post.force_encoding(Encoding::BINARY)
    StringIO.new(raw_post)
  else
    @env['rack.input']
  end
end

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

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

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

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

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

# File actionpack/lib/action_dispatch/middleware/cookies.rb, line 9
def cookie_jar
  env['action_dispatch.cookies'] ||= Cookies::CookieJar.build(self)
end

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

Вынесено в ActionDispatch::Request::Utils.deep_munge, но оставлено здесь для обратной совместимости.

# File actionpack/lib/action_dispatch/http/request.rb, line 303
def deep_munge(hash)
  ActiveSupport::Deprecation.warn(
    "This method has been extracted into ActionDispatch::Request::Utils.deep_munge. Please start using that instead."
  )

  Utils.deep_munge(hash)
end

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

Это запрос DELETE? Эквивалентно request.request_method_symbol == :delete.

# File actionpack/lib/action_dispatch/http/request.rb, line 138
def delete?
  HTTP_METHOD_LOOKUP[request_method] == :delete
end

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

Доступ к содержимому flash. Используйте flash["notice"] для чтения уведомления, помещённого туда, или flash["notice"] = "hello" для добавления нового.

# File actionpack/lib/action_dispatch/middleware/flash.rb, line 8
def flash
  @env[Flash::KEY] ||= Flash::FlashHash.from_session_value(session["flash"])
end

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

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

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

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

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

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

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

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

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

Является ли это запросом #GET (или HEAD)? Эквивалентно request.request_method_symbol == :get.

# File actionpack/lib/action_dispatch/http/request.rb, line 114
def get?
  HTTP_METHOD_LOOKUP[request_method] == :get
end

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

Это запрос HEAD? Эквивалентно request.request_method_symbol == :head.

# File actionpack/lib/action_dispatch/http/request.rb, line 144
def head?
  HTTP_METHOD_LOOKUP[request_method] == :head
end

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

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 151
def headers
  Http::Headers.new(@env)
end

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

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

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 56
def key?(key)
  @env.key?(key)
end

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

Истина, если запрос пришёл с локального хоста, 127.0.0.1.

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

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

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

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

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

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

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

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

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

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

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 155
def original_fullpath
  @original_fullpath ||= (env["ORIGINAL_FULLPATH"] || fullpath)
end

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

Возвращает исходный URL запроса как String.

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

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

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

Это запрос PATCH? Эквивалентно request.request_method == :patch.

# File actionpack/lib/action_dispatch/http/request.rb, line 126
def patch?
  HTTP_METHOD_LOOKUP[request_method] == :patch
end

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

Это запрос #POST? Эквивалентно request.request_method_symbol == :post.

# File actionpack/lib/action_dispatch/http/request.rb, line 120
def post?
  HTTP_METHOD_LOOKUP[request_method] == :post
end

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

Это запрос PUT? Эквивалентно request.request_method_symbol == :put.

# File actionpack/lib/action_dispatch/http/request.rb, line 132
def put?
  HTTP_METHOD_LOOKUP[request_method] == :put
end

query_parameters()

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

END_OF_DOCUMENT_MARKER

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 225
def raw_post
  unless @env.include? 'RAW_POST_DATA'
    raw_post_body = body
    @env['RAW_POST_DATA'] = raw_post_body.read(content_length)
    raw_post_body.rewind if raw_post_body.respond_to?(:rewind)
  end
  @env['RAW_POST_DATA']
end

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

IP-адрес отправителя, обычно устанавливается посредством middleware RemoteIp.

# File actionpack/lib/action_dispatch/http/request.rb, line 204
def remote_ip
  @remote_ip ||= (@env["action_dispatch.remote_ip"] || ip).to_s
end

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 91
def request_method
  @request_method ||= check_method(env["REQUEST_METHOD"])
end

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

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

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

request_parameters()

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

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

TODO Это следует разделить на AD::Request::Session и, вероятно, включить в middleware для сессий.

# File actionpack/lib/action_dispatch/http/request.rb, line 255
def reset_session
  if session && session.respond_to?(:destroy)
    session.destroy
  else
    self.session = {}
  end
  @env['action_dispatch.request.flash_hash'] = nil
end

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

Возвращает имя HTTP серверного программного обеспечения в нижнем регистре.

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

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

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

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

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 214
def uuid
  @uuid ||= env["action_dispatch.request_id"]
end

xhr?()

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

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 194
def xml_http_request?
  @env['HTTP_X_REQUESTED_WITH'] =~ /XMLHttpRequest/i
end

Также является псевдонимом для: xhr?

Защищённые методы экземпляра

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

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

# File actionpack/lib/action_dispatch/http/request.rb, line 312
def parse_query(qs)
  Utils.deep_munge(super)
end