類別 CGI::Cookie

類別代表 HTTP Cookie。

除了其特定欄位和方法外，Cookie 執行個體也是其值的陣列委派。

請參閱 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

常數

DOMAIN_VALUE_RE
PATH_VALUE_RE
TOKEN_RE

屬性

domain[R]

此 Cookie 套用的網域，為 字串

expires[RW]

時間此 Cookie 過期，為 時間

httponly[R]

如果此 Cookie 為 httponly，則為 True；否則為 false

name[R]

此 Cookie 的名稱，為 字串

path[R]

此 Cookie 套用的路徑，為 字串

secure[R]

如果此 Cookie 為安全，則為 True；否則為 false

公開類別方法

new(name_string,*value) 按一下以切換來源

new(options_hash)

建立新的 CGI::Cookie 物件。

name_string

Cookie 的名稱；在此形式中，沒有 網域 或過期時間。路徑 從 SCRIPT_NAME 環境變數取得，而 安全 為 false。

*value

Cookie 的值或值清單

options_hash

雜湊選項用於初始化此 Cookie。可能的選項為

name: Cookie 的名稱。必填。
value: Cookie 的值或值清單。
path: 此 cookie 套用的路徑。預設為 SCRIPT_NAME 環境變數的值。
網域: 此 cookie 套用的網域。
過期: 此 cookie 過期時間，為 Time 物件。
安全: 此 cookie 是否為安全 cookie（預設為 false）。安全 cookie 僅傳輸至 HTTPS 伺服器。
僅限 HTTP: 此 cookie 是否為 HttpOnly cookie（預設為

false).  HttpOnly cookies are not available to javascript.

這些關鍵字對應至 cookie 物件的屬性。

呼叫超類別方法 Array::new

# File lib/cgi/cookie.rb, line 75
def initialize(name = "", *value)
  @domain = nil
  @expires = nil
  if name.kind_of?(String)
    self.name = name
    self.path = (%r|\A(.*/)| =~ ENV["SCRIPT_NAME"] ? $1 : "")
    @secure = false
    @httponly = false
    return super(value)
  end

  options = name
  unless options.has_key?("name")
    raise ArgumentError, "`name' required"
  end

  self.name = options["name"]
  value = Array(options["value"])
  # simple support for IE
  self.path = options["path"] || (%r|\A(.*/)| =~ ENV["SCRIPT_NAME"] ? $1 : "")
  self.domain = options["domain"]
  @expires = options["expires"]
  @secure = options["secure"] == true
  @httponly = options["httponly"] == true

  super(value)
end

剖析(raw_cookie) 按一下以切換來源

將原始 cookie 字串剖析為 cookie 名稱=>Cookie 對的雜湊。

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

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

公開實例方法

網域=(str) 按一下以切換來源

設定此 cookie 套用的網域

# File lib/cgi/cookie.rb, line 126
def domain=(str)
  if str and ((str = str.b).bytesize > 255 or !DOMAIN_VALUE_RE.match?(str))
    raise ArgumentError, "invalid domain: #{str.dump}"
  end
  @domain = str
end

僅限 HTTP=(val) 按一下以切換來源

設定 Cookie 是否為僅限 HTTP cookie。

val 必須為布林值。

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

檢查() 按一下以切換來源

cookie 字串摘要。

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

名稱=(str) 按一下以切換來源

設定此 cookie 的名稱

# File lib/cgi/cookie.rb, line 106
def name=(str)
  if str and !TOKEN_RE.match?(str)
    raise ArgumentError, "invalid name: #{str.dump}"
  end
  @name = str
end

路徑=(str) 按一下以切換來源

設定此 cookie 套用的路徑

# File lib/cgi/cookie.rb, line 116
def path=(str)
  if str and !PATH_VALUE_RE.match?(str)
    raise ArgumentError, "invalid path: #{str.dump}"
  end
  @path = str
end

安全=(val) 按一下以切換來源

設定 Cookie 是否為安全 cookie。

val 必須為布林值。

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

轉為字串() 按一下以切換來源

將 Cookie 轉換為其字串表示。

# File lib/cgi/cookie.rb, line 166
def to_s
  val = collect{|v| CGI.escape(v) }.join("&")
  buf = "#{@name}=#{val}".dup
  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

值() 按一下以切換來源

傳回此 cookie 的值或值清單。

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

值=(val) 按一下以切換來源

以新值或值清單取代此 cookie 的值。

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

使用範例¶ ↑