Create a new CGI::Cookie object.
The contents of the cookie can be specified as a name and one or more value arguments. Alternatively, the contents can be specified as a single hash argument. The possible keywords of this hash are as follows:
name |
the name of the cookie. Required. |
value |
the cookie’s value or list of values. |
path |
the path for which this cookie applies. Defaults to the base directory of the CGI script. |
domain |
the domain for which this cookie applies. |
expires |
the time at which this cookie expires, as a Time object. |
secure |
whether this cookie is a secure cookie or not (default to false). Secure cookies are only transmitted to HTTPS servers. |
These keywords correspond to attributes of the cookie object.
# File cgi/cookie.rb, line 56
def initialize(name = "", *value)
@domain = nil
@expires = nil
if name.kind_of?(String)
@name = name
%^(.*/)|.match(ENV["SCRIPT_NAME"])
@path = ($1 or "")
@secure = false
return super(value)
end
options = name
unless options.has_key?("name")
raise ArgumentError, "`name' required"
end
@name = options["name"]
value = Array(options["value"])
# simple support for IE
if options["path"]
@path = options["path"]
else
%^(.*/)|.match(ENV["SCRIPT_NAME"])
@path = ($1 or "")
end
@domain = options["domain"]
@expires = options["expires"]
@secure = options["secure"] == true ? true : false
super(value)
end
Parse a raw cookie string into a hash of cookie-name=>Cookie pairs.
cookies = CGI::Cookie::parse("raw_cookie_string") # { "name1" => cookie1, "name2" => cookie2, ... }
# File cgi/cookie.rb, line 127
def Cookie::parse(raw_cookie)
cookies = Hash.new([])
return cookies unless raw_cookie
raw_cookie.split(/[;,]\s?/).each do |pairs|
name, values = pairs.split('=',2)
next unless name and values
name = CGI::unescape(name)
values ||= ""
values = values.split('&').collect{|v| CGI::unescape(v,@@accept_charset) }
if cookies.has_key?(name)
values = cookies[name].value + values
end
cookies[name] = Cookie::new(name, *values)
end
cookies
end
Set whether the Cookie is a secure cookie or not.
val must be a boolean.
# File cgi/cookie.rb, line 102
def secure=(val)
@secure = val if val == true or val == false
@secure
end
Convert the Cookie to its string representation.
# File cgi/cookie.rb, line 108
def to_s
val = collect{|v| CGI::escape(v) }.join("&")
buf = "#{@name}=#{val}"
buf << "; domain=#{@domain}" if @domain
buf << "; path=#{@path}" if @path
buf << "; expires=#{CGI::rfc1123_date(@expires)}" if @expires
buf << "; secure" if @secure == true
buf
end