CGI::Cookie

class CGI::Cookie

Parent:Array

代表HTTP cookie的类。

除了其特定的字段和方法外，Cookie实例是其值的数组的委托者。

See RFC 2965.

使用示例

cookie1 = CGI::Cookie.new("name", "value1", "value2", ...)
cookie1 = CGI::Cookie.new("name" => "name", "value" => "value")
cookie1 = CGI::Cookie.new('name'     => 'name',
                          'value'    => ['value1', 'value2', ...],
                          'path'     => 'path',   # optional
                          'domain'   => 'domain', # optional
                          'expires'  => Time.now, # optional
                          'secure'   => true,     # optional
                          'httponly' => true      # optional
                          )

cgi.out("cookie" => [cookie1, cookie2]) { "string" }

name     = cookie1.name
values   = cookie1.value
path     = cookie1.path
domain   = cookie1.domain
expires  = cookie1.expires
secure   = cookie1.secure
httponly = cookie1.httponly

cookie1.name     = 'name'
cookie1.value    = ['value1', 'value2', ...]
cookie1.path     = 'path'
cookie1.domain   = 'domain'
cookie1.expires  = Time.now + 30
cookie1.secure   = true
cookie1.httponly = true

属性

domainRW

这个cookie适用于的域名为a String

expiresRW

这个cookie到期的时间，如 Time

httponlyR

如果此cookie很安全，则为true; 否则为假

nameRW

这个cookie的名称，作为一个 String

pathRW

此cookie适用的路径，如 String

secureR

如果这个cookie是安全的，则为真; 否则为假

公共类方法

new(name_string,*value) 显示源

new(options_hash)

Create a new CGI::Cookie object.

name_string

Cookie的名称; 在这种形式下，没有域名或到期。该路径是从SCRIPT_NAME环境变量中收集的，安全性是错误的。

*value

值或Cookie的值的列表

options_hash

初始化此Cookie的一堆选项。可能的选项是：

name

cookie的名称。需要。

value

cookie的值或值列表。

path

此cookie适用的路径。缺省为SCRIPT_NAME环境变量的值。

domain

此Cookie适用的域名。

expires

这个cookie到期的时间，作为一个Time对象。

secure

这个cookie是否是一个安全的cookie（默认为false）。安全cookie仅传输到HTTPS服务器。

httponly

无论这个cookie是否是一个HttpOnly cookie（默认为

false).  HttpOnly cookies are not available to javascript.

这些关键字对应于cookie对象的属性。

调用超类方法Array.new

# File lib/cgi/cookie.rb, line 70
def initialize(name = "", *value)
  @domain = nil
  @expires = nil
  if name.kind_of?(String)
    @name = name
    %r|^(.*/)|.match(ENV["SCRIPT_NAME"])
    @path = ($1 or "")
    @secure = false
    @httponly = 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
    %r|^(.*/)|.match(ENV["SCRIPT_NAME"])
    @path = ($1 or "")
  end
  @domain = options["domain"]
  @expires = options["expires"]
  @secure = options["secure"] == true
  @httponly = options["httponly"] == true

  super(value)
end

解析（raw_cookie）显示源文件

将原始cookie字符串解析为cookie-name => Cookie对的散列。

cookies = CGI::Cookie.parse("raw_cookie_string")
  # { "name1" => cookie1, "name2" => cookie2, ... }

# File lib/cgi/cookie.rb, line 160
def self.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

公共实例方法

httponly=(val) Show source

设置Cookie是否为httponly cookie。

val must be a boolean.

# File lib/cgi/cookie.rb, line 138
def httponly=(val)
  @httponly = !!val
end

inspect() Show source

Cookie字符串的摘要。

# File lib/cgi/cookie.rb, line 180
def inspect
  "#<CGI::Cookie: #{self.to_s.inspect}>"
end

secure=(val) Show source

设置Cookie是否是安全cookie。

val must be a boolean.

# File lib/cgi/cookie.rb, line 130
def secure=(val)
  @secure = val if val == true or val == false
  @secure
end

to_s() Show source

将Cookie转换为其字符串表示形式。

# File lib/cgi/cookie.rb, line 143
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
  buf << "; HttpOnly"          if @httponly
  buf
end

value() 显示源

返回此cookie的值或值列表。

# File lib/cgi/cookie.rb, line 118
def value
  self
end

value=(val) Show source

用新值或值列表替换此Cookie的值。

# File lib/cgi/cookie.rb, line 123
def value=(val)
  replace(Array(val))
end