1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
rails--rails/actionpack/lib/action_dispatch/http/headers.rb

87 lines
2.5 KiB
Ruby
Raw Normal View History

module ActionDispatch
module Http
2014-05-08 14:24:38 -04:00
# Provides access to the request's HTTP headers from the environment.
#
# env = { "CONTENT_TYPE" => "text/plain" }
# headers = ActionDispatch::Http::Headers.new(env)
# headers["Content-Type"] # => "text/plain"
2012-10-18 18:20:30 -04:00
class Headers
CGI_VARIABLES = %w(
CONTENT_TYPE CONTENT_LENGTH
HTTPS AUTH_TYPE GATEWAY_INTERFACE
PATH_INFO PATH_TRANSLATED QUERY_STRING
REMOTE_ADDR REMOTE_HOST REMOTE_IDENT REMOTE_USER
REQUEST_METHOD SCRIPT_NAME
SERVER_NAME SERVER_PORT SERVER_PROTOCOL SERVER_SOFTWARE
)
HTTP_HEADER = /\A[A-Za-z0-9-]+\z/
2012-10-18 18:20:30 -04:00
include Enumerable
attr_reader :env
2012-10-18 18:20:30 -04:00
2014-05-09 12:29:29 -04:00
def initialize(env = {}) # :nodoc:
@env = env
end
2014-05-09 12:29:29 -04:00
# Returns the value for the given key mapped to @env.
def [](key)
@env[env_name(key)]
end
2014-05-10 09:44:43 -04:00
# Sets the given value for the key mapped to @env.
def []=(key, value)
@env[env_name(key)] = value
end
def key?(key)
@env.key? env_name(key)
end
2012-10-18 18:20:30 -04:00
alias :include? :key?
2014-05-09 12:29:29 -04:00
# Returns the value for the given key mapped to @env.
2014-05-10 09:44:43 -04:00
#
# If the key is not found and an optional code block is not provided,
# raises a <tt>KeyError</tt> exception.
#
# If the code block is provided, then it will be run and
# its result returned.
def fetch(key, *args, &block)
@env.fetch env_name(key), *args, &block
2012-10-18 18:20:30 -04:00
end
def each(&block)
@env.each(&block)
end
2014-05-09 12:29:29 -04:00
# Returns a new Http::Headers instance containing the contents of
# <tt>headers_or_env</tt> and the original instance.
def merge(headers_or_env)
headers = Http::Headers.new(env.dup)
headers.merge!(headers_or_env)
headers
end
2014-05-09 12:29:29 -04:00
# Adds the contents of <tt>headers_or_env</tt> to original instance
2014-05-10 09:44:43 -04:00
# entries; duplicate keys are overwritten with the values from
2014-05-09 12:29:29 -04:00
# <tt>headers_or_env</tt>.
def merge!(headers_or_env)
headers_or_env.each do |key, value|
self[env_name(key)] = value
end
end
private
2014-05-09 12:29:29 -04:00
# Converts a HTTP header name to an environment variable name if it is
# not contained within the headers hash.
def env_name(key)
key = key.to_s
if key =~ HTTP_HEADER
key = key.upcase.tr('-', '_')
key = "HTTP_" + key unless CGI_VARIABLES.include?(key)
end
key
end
end
end
end