2007-05-18 02:24:50 -04:00
|
|
|
require 'tempfile'
|
|
|
|
require 'stringio'
|
|
|
|
require 'strscan'
|
|
|
|
|
2009-05-13 04:10:37 -04:00
|
|
|
require 'active_support/core_ext/hash/indifferent_access'
|
2009-11-07 14:23:21 -05:00
|
|
|
require 'active_support/core_ext/string/access'
|
2009-12-12 19:41:26 -05:00
|
|
|
require 'action_dispatch/http/headers'
|
2007-11-28 21:08:51 -05:00
|
|
|
|
2009-01-27 19:54:01 -05:00
|
|
|
module ActionDispatch
|
2009-01-09 12:15:38 -05:00
|
|
|
class Request < Rack::Request
|
2010-01-16 07:17:03 -05:00
|
|
|
include ActionDispatch::Http::Cache::Request
|
|
|
|
include ActionDispatch::Http::MimeNegotiation
|
|
|
|
include ActionDispatch::Http::Parameters
|
2010-01-21 05:39:57 -05:00
|
|
|
include ActionDispatch::Http::FilterParameters
|
2010-01-16 07:17:03 -05:00
|
|
|
include ActionDispatch::Http::Upload
|
|
|
|
include ActionDispatch::Http::URL
|
2008-12-22 19:15:08 -05:00
|
|
|
|
2009-01-09 12:15:38 -05:00
|
|
|
%w[ AUTH_TYPE GATEWAY_INTERFACE
|
2008-12-22 19:15:08 -05:00
|
|
|
PATH_TRANSLATED REMOTE_HOST
|
2009-01-09 12:15:38 -05:00
|
|
|
REMOTE_IDENT REMOTE_USER REMOTE_ADDR
|
2008-12-22 19:15:08 -05:00
|
|
|
SERVER_NAME SERVER_PROTOCOL
|
|
|
|
|
|
|
|
HTTP_ACCEPT HTTP_ACCEPT_CHARSET HTTP_ACCEPT_ENCODING
|
|
|
|
HTTP_ACCEPT_LANGUAGE HTTP_CACHE_CONTROL HTTP_FROM
|
2009-12-22 17:09:41 -05:00
|
|
|
HTTP_NEGOTIATE HTTP_PRAGMA ].each do |env|
|
2010-01-16 07:17:03 -05:00
|
|
|
class_eval <<-METHOD, __FILE__, __LINE__ + 1
|
|
|
|
def #{env.sub(/^HTTP_/n, '').downcase}
|
|
|
|
@env["#{env}"]
|
|
|
|
end
|
|
|
|
METHOD
|
2008-12-22 19:15:08 -05:00
|
|
|
end
|
|
|
|
|
2010-03-08 18:57:07 -05:00
|
|
|
def self.new(env)
|
|
|
|
if request = env["action_dispatch.request"] && request.instance_of?(self)
|
|
|
|
return request
|
|
|
|
end
|
|
|
|
|
|
|
|
super
|
|
|
|
end
|
|
|
|
|
2008-12-22 19:15:08 -05:00
|
|
|
def key?(key)
|
|
|
|
@env.key?(key)
|
|
|
|
end
|
|
|
|
|
2008-08-08 02:43:12 -04:00
|
|
|
HTTP_METHODS = %w(get head put post delete options)
|
|
|
|
HTTP_METHOD_LOOKUP = HTTP_METHODS.inject({}) { |h, m| h[m] = h[m.upcase] = m.to_sym; h }
|
|
|
|
|
2010-04-03 23:23:23 -04:00
|
|
|
# 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.
|
2007-11-28 21:08:51 -05:00
|
|
|
def request_method
|
2010-04-03 23:23:23 -04:00
|
|
|
method = env["REQUEST_METHOD"]
|
2010-01-15 13:35:18 -05:00
|
|
|
HTTP_METHOD_LOOKUP[method] || raise(ActionController::UnknownHttpMethod, "#{method}, accepted HTTP methods are #{HTTP_METHODS.to_sentence(:locale => :en)}")
|
2010-04-03 23:23:23 -04:00
|
|
|
method
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns a symbol form of the #request_method
|
|
|
|
def request_method_symbol
|
|
|
|
HTTP_METHOD_LOOKUP[request_method]
|
2007-11-28 21:08:51 -05:00
|
|
|
end
|
|
|
|
|
2010-04-03 23:23:23 -04:00
|
|
|
# Returns the original value of the environment's REQUEST_METHOD,
|
|
|
|
# even if it was overridden by middleware. See #request_method for
|
|
|
|
# more information.
|
2004-11-23 20:04:44 -05:00
|
|
|
def method
|
2010-04-03 23:23:23 -04:00
|
|
|
method = env["rack.methodoverride.original_method"] || env['REQUEST_METHOD']
|
2010-01-15 13:35:18 -05:00
|
|
|
HTTP_METHOD_LOOKUP[method] || raise(ActionController::UnknownHttpMethod, "#{method}, accepted HTTP methods are #{HTTP_METHODS.to_sentence(:locale => :en)}")
|
2010-04-03 23:23:23 -04:00
|
|
|
method
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns a symbol form of the #method
|
|
|
|
def method_symbol
|
|
|
|
HTTP_METHOD_LOOKUP[method]
|
2004-11-23 20:04:44 -05:00
|
|
|
end
|
|
|
|
|
2010-04-03 23:23:23 -04:00
|
|
|
# Is this a GET (or HEAD) request?
|
|
|
|
# Equivalent to <tt>request.request_method == :get</tt>.
|
2004-11-23 20:04:44 -05:00
|
|
|
def get?
|
2010-04-03 23:23:23 -04:00
|
|
|
HTTP_METHOD_LOOKUP[request_method] == :get
|
2004-11-23 20:04:44 -05:00
|
|
|
end
|
|
|
|
|
2010-04-03 23:23:23 -04:00
|
|
|
# Is this a POST request?
|
|
|
|
# Equivalent to <tt>request.request_method == :post</tt>.
|
2004-11-23 20:04:44 -05:00
|
|
|
def post?
|
2010-04-03 23:23:23 -04:00
|
|
|
HTTP_METHOD_LOOKUP[request_method] == :post
|
2004-11-23 20:04:44 -05:00
|
|
|
end
|
|
|
|
|
2010-04-03 23:23:23 -04:00
|
|
|
# Is this a PUT request?
|
|
|
|
# Equivalent to <tt>request.request_method == :put</tt>.
|
2004-11-23 20:04:44 -05:00
|
|
|
def put?
|
2010-04-03 23:23:23 -04:00
|
|
|
HTTP_METHOD_LOOKUP[request_method] == :put
|
2004-11-23 20:04:44 -05:00
|
|
|
end
|
|
|
|
|
2010-04-03 23:23:23 -04:00
|
|
|
# Is this a DELETE request?
|
|
|
|
# Equivalent to <tt>request.request_method == :delete</tt>.
|
2004-11-23 20:04:44 -05:00
|
|
|
def delete?
|
2010-04-03 23:23:23 -04:00
|
|
|
HTTP_METHOD_LOOKUP[request_method] == :delete
|
2004-11-23 20:04:44 -05:00
|
|
|
end
|
|
|
|
|
2010-04-03 23:23:23 -04:00
|
|
|
# Is this a HEAD request?
|
|
|
|
# Equivalent to <tt>request.method == :head</tt>.
|
2004-12-07 05:50:26 -05:00
|
|
|
def head?
|
2010-04-03 23:23:23 -04:00
|
|
|
HTTP_METHOD_LOOKUP[method] == :head
|
2004-12-07 05:50:26 -05:00
|
|
|
end
|
2005-05-14 04:36:19 -04:00
|
|
|
|
2008-07-16 08:00:36 -04:00
|
|
|
# Provides access to the request's HTTP headers, for example:
|
2008-09-03 12:58:47 -04:00
|
|
|
#
|
|
|
|
# request.headers["Content-Type"] # => "text/plain"
|
2007-02-17 13:16:44 -05:00
|
|
|
def headers
|
2009-01-27 19:54:01 -05:00
|
|
|
Http::Headers.new(@env)
|
2007-02-17 13:16:44 -05:00
|
|
|
end
|
|
|
|
|
2009-10-28 03:12:35 -04:00
|
|
|
def forgery_whitelisted?
|
2010-04-03 23:23:23 -04:00
|
|
|
get? || xhr? || content_mime_type.nil? || !content_mime_type.verify_request?
|
2009-10-28 03:12:35 -04:00
|
|
|
end
|
|
|
|
|
2009-04-25 14:56:37 -04:00
|
|
|
def media_type
|
2010-03-28 16:40:38 -04:00
|
|
|
content_mime_type.to_s
|
2009-04-25 14:56:37 -04:00
|
|
|
end
|
|
|
|
|
2010-01-16 07:17:03 -05:00
|
|
|
# Returns the content length of the request as an integer.
|
|
|
|
def content_length
|
|
|
|
super.to_i
|
2008-06-27 14:24:21 -04:00
|
|
|
end
|
|
|
|
|
2005-06-24 12:40:01 -04:00
|
|
|
# Returns true if the request's "X-Requested-With" header contains
|
|
|
|
# "XMLHttpRequest". (The Prototype Javascript library sends this header with
|
|
|
|
# every Ajax request.)
|
2005-05-22 03:43:05 -04:00
|
|
|
def xml_http_request?
|
2007-10-02 01:32:14 -04:00
|
|
|
!(@env['HTTP_X_REQUESTED_WITH'] !~ /XMLHttpRequest/i)
|
2005-05-22 03:43:05 -04:00
|
|
|
end
|
2009-07-28 15:29:29 -04:00
|
|
|
alias :xhr? :xml_http_request?
|
2005-05-22 03:43:05 -04:00
|
|
|
|
2008-03-28 17:38:01 -04:00
|
|
|
# Which IP addresses are "trusted proxies" that can be stripped from
|
|
|
|
# the right-hand-side of X-Forwarded-For
|
|
|
|
TRUSTED_PROXIES = /^127\.0\.0\.1$|^(10|172\.(1[6-9]|2[0-9]|30|31)|192\.168)\./i
|
|
|
|
|
2008-09-03 12:58:47 -04:00
|
|
|
# Determines originating IP address. REMOTE_ADDR is the standard
|
2004-11-23 20:04:44 -05:00
|
|
|
# but will fail if the user is behind a proxy. HTTP_CLIENT_IP and/or
|
2008-03-28 17:38:01 -04:00
|
|
|
# HTTP_X_FORWARDED_FOR are set by proxies so check for these if
|
|
|
|
# REMOTE_ADDR is a proxy. HTTP_X_FORWARDED_FOR may be a comma-
|
|
|
|
# delimited list in the case of multiple chained proxies; the last
|
|
|
|
# address which is not trusted is the originating IP.
|
2004-11-23 20:04:44 -05:00
|
|
|
def remote_ip
|
2010-03-03 19:22:30 -05:00
|
|
|
(@env["action_dispatch.remote_ip"] || ip).to_s
|
2004-11-23 20:04:44 -05:00
|
|
|
end
|
|
|
|
|
2007-03-04 15:32:38 -05:00
|
|
|
# Returns the lowercase name of the HTTP server software.
|
|
|
|
def server_software
|
|
|
|
(@env['SERVER_SOFTWARE'] && /^([a-zA-Z]+)/ =~ @env['SERVER_SOFTWARE']) ? $1.downcase : nil
|
|
|
|
end
|
|
|
|
|
2008-09-03 12:58:47 -04:00
|
|
|
# Read the request \body. This is useful for web services that need to
|
2007-05-23 15:09:37 -04:00
|
|
|
# work with raw requests directly.
|
2007-03-04 15:32:38 -05:00
|
|
|
def raw_post
|
2009-01-17 21:29:50 -05:00
|
|
|
unless @env.include? 'RAW_POST_DATA'
|
|
|
|
@env['RAW_POST_DATA'] = body.read(@env['CONTENT_LENGTH'].to_i)
|
|
|
|
body.rewind if body.respond_to?(:rewind)
|
|
|
|
end
|
|
|
|
@env['RAW_POST_DATA']
|
2004-12-18 13:01:28 -05:00
|
|
|
end
|
|
|
|
|
2009-01-17 21:29:50 -05:00
|
|
|
# The request body is an IO input stream. If the RAW_POST_DATA environment
|
|
|
|
# variable is already set, wrap it in a StringIO.
|
2008-08-08 02:43:12 -04:00
|
|
|
def body
|
2009-01-17 21:29:50 -05:00
|
|
|
if raw_post = @env['RAW_POST_DATA']
|
|
|
|
raw_post.force_encoding(Encoding::BINARY) if raw_post.respond_to?(:force_encoding)
|
|
|
|
StringIO.new(raw_post)
|
|
|
|
else
|
|
|
|
@env['rack.input']
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def form_data?
|
2010-03-28 16:40:38 -04:00
|
|
|
FORM_DATA_MEDIA_TYPES.include?(content_mime_type.to_s)
|
2008-08-08 02:43:12 -04:00
|
|
|
end
|
2005-06-24 10:43:15 -04:00
|
|
|
|
2008-08-08 02:43:12 -04:00
|
|
|
def body_stream #:nodoc:
|
2008-12-22 19:15:08 -05:00
|
|
|
@env['rack.input']
|
2004-11-23 20:04:44 -05:00
|
|
|
end
|
|
|
|
|
2009-04-26 15:33:57 -04:00
|
|
|
def reset_session
|
|
|
|
self.session_options.delete(:id)
|
|
|
|
self.session = {}
|
2004-11-23 20:04:44 -05:00
|
|
|
end
|
|
|
|
|
2006-02-09 15:05:11 -05:00
|
|
|
def session=(session) #:nodoc:
|
2009-01-05 04:10:55 -05:00
|
|
|
@env['rack.session'] = session
|
2006-02-09 15:05:11 -05:00
|
|
|
end
|
|
|
|
|
2008-12-22 19:15:08 -05:00
|
|
|
def session_options=(options)
|
|
|
|
@env['rack.session.options'] = options
|
|
|
|
end
|
|
|
|
|
2010-01-16 07:17:03 -05:00
|
|
|
# Override Rack's GET method to support indifferent access
|
|
|
|
def GET
|
|
|
|
@env["action_dispatch.request.query_parameters"] ||= normalize_parameters(super)
|
|
|
|
end
|
|
|
|
alias :query_parameters :GET
|
|
|
|
|
|
|
|
# Override Rack's POST method to support indifferent access
|
|
|
|
def POST
|
|
|
|
@env["action_dispatch.request.request_parameters"] ||= normalize_parameters(super)
|
|
|
|
end
|
|
|
|
alias :request_parameters :POST
|
|
|
|
|
|
|
|
|
2009-12-20 21:30:50 -05:00
|
|
|
# Returns the authorization header regardless of whether it was specified directly or through one of the
|
|
|
|
# proxy alternatives.
|
|
|
|
def authorization
|
|
|
|
@env['HTTP_AUTHORIZATION'] ||
|
|
|
|
@env['X-HTTP_AUTHORIZATION'] ||
|
|
|
|
@env['X_HTTP_AUTHORIZATION'] ||
|
|
|
|
@env['REDIRECT_X_HTTP_AUTHORIZATION']
|
|
|
|
end
|
2007-10-06 07:40:13 -04:00
|
|
|
end
|
2007-10-02 01:32:14 -04:00
|
|
|
end
|