Class: WebAgent::Cookie

Inherits:
Object
  • Object
show all
Includes:
ParseDate, CookieUtils
Defined in:
lib/httpclient/cookie.rb

Constant Summary collapse

USE = 
1
SECURE = 
2
DOMAIN = 
4
PATH = 
8
DISCARD = 
16
OVERRIDE = 
32
OVERRIDE_OK = 
32

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from CookieUtils

#domain_match, #head_match?, #tail_match?, #total_dot_num

Constructor Details

#initialize ⇒ Cookie

Returns a new instance of Cookie.



74
75
76
 
# File 'lib/httpclient/cookie.rb', line 74

def initialize()
  @discard = @use = @secure = @domain_orig = @path_orig = @override = nil
end

Instance Attribute Details

#discard=(value) ⇒ Object (writeonly)

Sets the attribute discard

Parameters:

  • value —

    the value to set the attribute discard to.



64
65
66
 
# File 'lib/httpclient/cookie.rb', line 64

def discard=(value)
  @discard = value
end

#domain ⇒ Object

Returns the value of attribute domain.



61
62
63
 
# File 'lib/httpclient/cookie.rb', line 61

def domain
  @domain
end

#domain_orig=(value) ⇒ Object (writeonly)

Sets the attribute domain_orig

Parameters:

  • value —

    the value to set the attribute domain_orig to.



64
65
66
 
# File 'lib/httpclient/cookie.rb', line 64

def domain_orig=(value)
  @domain_orig = value
end

#expires ⇒ Object

for Netscape Cookie



62
63
64
 
# File 'lib/httpclient/cookie.rb', line 62

def expires
  @expires
end

#name ⇒ Object

Returns the value of attribute name.



60
61
62
 
# File 'lib/httpclient/cookie.rb', line 60

def name
  @name
end

#override=(value) ⇒ Object (writeonly)

Sets the attribute override

Parameters:

  • value —

    the value to set the attribute override to.



64
65
66
 
# File 'lib/httpclient/cookie.rb', line 64

def override=(value)
  @override = value
end

#path ⇒ Object

Returns the value of attribute path.



61
62
63
 
# File 'lib/httpclient/cookie.rb', line 61

def path
  @path
end

#path_orig=(value) ⇒ Object (writeonly)

Sets the attribute path_orig

Parameters:

  • value —

    the value to set the attribute path_orig to.



64
65
66
 
# File 'lib/httpclient/cookie.rb', line 64

def path_orig=(value)
  @path_orig = value
end

#secure=(value) ⇒ Object (writeonly)

Sets the attribute secure

Parameters:

  • value —

    the value to set the attribute secure to.



64
65
66
 
# File 'lib/httpclient/cookie.rb', line 64

def secure=(value)
  @secure = value
end

#url ⇒ Object

Returns the value of attribute url.



63
64
65
 
# File 'lib/httpclient/cookie.rb', line 63

def url
  @url
end

#use=(value) ⇒ Object (writeonly)

Sets the attribute use

Parameters:

  • value —

    the value to set the attribute use to.



64
65
66
 
# File 'lib/httpclient/cookie.rb', line 64

def use=(value)
  @use = value
end

#value ⇒ Object

Returns the value of attribute value.



60
61
62
 
# File 'lib/httpclient/cookie.rb', line 60

def value
  @value
end

Instance Method Details

#discard? ⇒ Boolean

Returns:

  • (Boolean) 


78
79
80
 
# File 'lib/httpclient/cookie.rb', line 78

def discard?
  @discard
end

#domain_orig? ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/httpclient/cookie.rb', line 90

def domain_orig?
  @domain_orig
end

#flag ⇒ Object 



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/httpclient/cookie.rb', line 102

def flag
  flg = 0
  flg += USE  if @use
  flg += SECURE  if @secure
  flg += DOMAIN  if @domain_orig
  flg += PATH  if @path_orig
  flg += DISCARD if @discard
  flg += OVERRIDE if @override
  flg
end

#join_quotedstr(array, sep) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/httpclient/cookie.rb', line 135

def join_quotedstr(array, sep)
  ret = Array.new()
  old_elem = nil
  array.each{|elem|
	if (elem.scan(/"/).length % 2) == 0
	  if old_elem
 old_elem << sep << elem
	  else
 ret << elem
 old_elem = nil
	  end  
	else
	  if old_elem
 old_elem << sep << elem
 ret << old_elem
 old_elem = nil
	  else
 old_elem = elem.dup
	  end
	end
  }
  ret
end

#match?(url) ⇒ Boolean

Returns:

  • (Boolean) 


123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/httpclient/cookie.rb', line 123

def match?(url)
  domainname = url.host
  if (!domainname ||
	  !domain_match(domainname, @domain) ||
	  (@path && !head_match?(@path, url.path)) ||
	  (@secure && (url.scheme != 'https')) )
	return false
  else
	return true
  end
end

#override? ⇒ Boolean

Returns:

  • (Boolean) 


98
99
100
 
# File 'lib/httpclient/cookie.rb', line 98

def override?
  @override
end

#parse(str, url) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/httpclient/cookie.rb', line 159

def parse(str, url)
  @url = url
  cookie_elem = str.split(/;/)
  cookie_elem = join_quotedstr(cookie_elem, ';')
  first_elem = cookie_elem.shift
  if first_elem !~ /([^=]*)(\=(.*))?/
	return
	## raise ArgumentError 'invalid cookie value'
  end
  @name = $1.strip
  @value = $3
  if @value
	if @value =~ /^\s*"(.*)"\s*$/
	  @value = $1
	else
	  @value.dup.strip!
	end
  end
  cookie_elem.each{|pair|
	key, value = pair.split(/=/)  ## value may nil
	key.strip!
    if value
      value = value.strip.sub(/\A"(.*)"\z/) { $1 }
    end
	case key.downcase
	when 'domain'
	  @domain = value
	when 'expires'
	  begin
 @expires = Time.gm(*parsedate(value)[0,6])
	  rescue ArgumentError
 @expires = nil
	  end
	when 'path'
	  @path = value
	when 'secure'
	  @secure = true  ## value may nil, but must 'true'.
	else
	  ## ignore
	end
  }
end

#path_orig? ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/httpclient/cookie.rb', line 94

def path_orig?
  @path_orig
end

#secure? ⇒ Boolean

Returns:

  • (Boolean) 


86
87
88
 
# File 'lib/httpclient/cookie.rb', line 86

def secure?
  @secure
end

#set_flag(flag) ⇒ Object 



113
114
115
116
117
118
119
120
121
 
# File 'lib/httpclient/cookie.rb', line 113

def set_flag(flag)
  flag = flag.to_i
  @use = true      if flag & USE > 0
  @secure = true   if flag & SECURE > 0
  @domain_orig = true if flag & DOMAIN > 0
  @path_orig = true if flag & PATH > 0
  @discard  = true if flag & DISCARD > 0
  @override = true if flag & OVERRIDE > 0
end

#use? ⇒ Boolean

Returns:

  • (Boolean) 


82
83
84
 
# File 'lib/httpclient/cookie.rb', line 82

def use?
  @use
end