Class: WebAgent::CookieManager

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

Defined Under Namespace

Classes: Error, ErrorOverrideOK, SpecialError

Constant Summary collapse

SPECIAL_DOMAIN =
[".com",".edu",".gov",".mil",".net",".org",".int"]

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from CookieUtils

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

Constructor Details

#initialize(file = nil) ⇒ CookieManager

Returns a new instance of CookieManager.


223
224
225
226
227
228
229
230
231
# File 'lib/httpclient/cookie.rb', line 223

def initialize(file=nil)
  @cookies = Array.new()
  @cookies.extend(MonitorMixin)
  @cookies_file = file
  @is_saved = true
  @reject_domains = Array.new()
  @accept_domains = Array.new()
  @netscape_rule = false
end

Instance Attribute Details

#accept_domainsObject

Returns the value of attribute accept_domains


217
218
219
# File 'lib/httpclient/cookie.rb', line 217

def accept_domains
  @accept_domains
end

#cookiesObject

Returns the value of attribute cookies


215
216
217
# File 'lib/httpclient/cookie.rb', line 215

def cookies
  @cookies
end

#cookies_fileObject

Returns the value of attribute cookies_file


216
217
218
# File 'lib/httpclient/cookie.rb', line 216

def cookies_file
  @cookies_file
end

#netscape_ruleObject


220
221
222
# File 'lib/httpclient/cookie.rb', line 220

def netscape_rule
  @netscape_rule
end

#reject_domainsObject

Returns the value of attribute reject_domains


217
218
219
# File 'lib/httpclient/cookie.rb', line 217

def reject_domains
  @reject_domains
end

Instance Method Details

#add(cookie) ⇒ Object


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
# File 'lib/httpclient/cookie.rb', line 328

def add(cookie)
  url = cookie.url
  name, value = cookie.name, cookie.value
  expires, domain, path = 
	cookie.expires, cookie.domain, cookie.path
  secure, domain_orig, path_orig = 
	cookie.secure?, cookie.domain_orig?, cookie.path_orig?
  discard, override = 
	cookie.discard?, cookie.override?

  domainname = url.host
  domain_orig, path_orig = domain, path
  use_security = override

  if domain

	# [DRAFT 12] s. 4.2.2 (does not apply in the case that
	# host name is the same as domain attribute for version 0
	# cookie)
	# I think that this rule has almost the same effect as the
	# tail match of [NETSCAPE].
	if domain !~ /^\./ && domainname != domain
	  domain = '.'+domain
	end

    # [NETSCAPE] rule
    if @netscape_rule
      n = total_dot_num(domain)
      if n < 2
        cookie_error(SpecialError.new(), override)
      elsif n == 2
        ## [NETSCAPE] rule
        ok = SPECIAL_DOMAIN.select{|sdomain|
          sdomain == domain[-(sdomain.length)..-1]
        }
        if ok.empty?
          cookie_error(SpecialError.new(), override)
        end
      end
    end

    # this implementation does not check RFC2109 4.3.2 case 2;
    # the portion of host not in domain does not contain a dot.
    # according to nsCookieService.cpp in Firefox 3.0.4, Firefox 3.0.4
    # and IE does not check, too.
  end

  path ||= url.path.sub(%r|/[^/]*|, '')
  domain ||= domainname
  @cookies.synchronize do
    cookie = find_cookie_info(domain, path, name)
    if !cookie
      cookie = WebAgent::Cookie.new()
      cookie.use = true
      @cookies << cookie
    end
    check_expired_cookies()
  end

  cookie.url = url
  cookie.name = name
  cookie.value = value
  cookie.expires = expires
  cookie.domain = domain
  cookie.path = path

  ## for flag
  cookie.secure = secure
  cookie.domain_orig = domain_orig
  cookie.path_orig = path_orig
  if discard || cookie.expires == nil
	cookie.discard = true
  else
	cookie.discard = false
	@is_saved = false
  end
end

431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
# File 'lib/httpclient/cookie.rb', line 431

def check_cookie_accept_domain(domain)
  unless domain
	return false
  end
  @accept_domains.each{|dom|
	if domain_match(domain, dom)
	  return true
	end
  }
  @reject_domains.each{|dom|
	if domain_match(domain, dom)
	  return false
	end
  }
  return true
end

#check_expired_cookiesObject


266
267
268
269
270
271
272
273
274
# File 'lib/httpclient/cookie.rb', line 266

def check_expired_cookies()
  @cookies.reject!{|cookie|
    is_expired = (cookie.expires && (cookie.expires < Time.now.gmtime))
    if is_expired && !cookie.discard?
      @is_saved = false
    end
    is_expired
  }
end

#find(url) ⇒ Object


298
299
300
301
302
303
304
305
306
307
308
309
310
311
# File 'lib/httpclient/cookie.rb', line 298

def find(url)
  return nil if @cookies.empty?

  cookie_list = Array.new()
  @cookies.each{|cookie|
    is_expired = (cookie.expires && (cookie.expires < Time.now.gmtime))
    if cookie.use? && !is_expired && cookie.match?(url)
      if cookie_list.select{|c1| c1.name == cookie.name}.empty?
        cookie_list << cookie
      end
    end
  }
  return make_cookie_str(cookie_list)
end

#load_cookiesObject


406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# File 'lib/httpclient/cookie.rb', line 406

def load_cookies()
  return if !File.readable?(@cookies_file)
  @cookies.synchronize do
    @cookies.clear
    File.open(@cookies_file,'r'){|f|
      while line = f.gets
        cookie = WebAgent::Cookie.new()
        @cookies << cookie
        col = line.chomp.split(/\t/)
        cookie.url = URI.parse(col[0])
        cookie.name = col[1]
        cookie.value = col[2]
        if col[3].empty? or col[3] == '0'
          cookie.expires = nil
        else
          cookie.expires = Time.at(col[3].to_i).gmtime
        end
        cookie.domain = col[4]
        cookie.path = col[5]
        cookie.set_flag(col[6])
      end
    }
  end
end

#parse(str, url) ⇒ Object


276
277
278
279
280
# File 'lib/httpclient/cookie.rb', line 276

def parse(str, url)
  cookie = WebAgent::Cookie.new()
  cookie.parse(str, url)
  add(cookie)
end

#save_all_cookies(force = nil, save_unused = true, save_discarded = true) ⇒ Object


238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
# File 'lib/httpclient/cookie.rb', line 238

def save_all_cookies(force = nil, save_unused = true, save_discarded = true)
  @cookies.synchronize do
    check_expired_cookies()
    if @is_saved and !force
      return
    end
    File.open(@cookies_file, 'w') do |f|
      @cookies.each do |cookie|
        if (cookie.use? or save_unused) and
            (!cookie.discard? or save_discarded)
          f.print(cookie.url.to_s,"\t",
                  cookie.name,"\t",
                  cookie.value,"\t",
                  cookie.expires.to_i,"\t",
                  cookie.domain,"\t",
                  cookie.path,"\t",
                  cookie.flag,"\n")
        end
      end
    end
  end
  @is_saved = true
end

#save_cookies(force = nil) ⇒ Object


262
263
264
# File 'lib/httpclient/cookie.rb', line 262

def save_cookies(force = nil)
  save_all_cookies(force, false, false)
end