Class: WebAgent::CookieManager

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

Defined Under Namespace

Classes: Error, ErrorOverrideOK, SpecialError

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from CookieUtils

#domain_match, #head_match?, #tail_match?

Constructor Details

#initialize(file = nil) ⇒ CookieManager

Returns a new instance of CookieManager.



232
233
234
235
236
237
238
239
 
# File 'lib/httpclient/cookie.rb', line 232

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

Instance Attribute Details

#accept_domains ⇒ Object

Returns the value of attribute accept_domains.



230
231
232
 
# File 'lib/httpclient/cookie.rb', line 230

def accept_domains
  @accept_domains
end

#cookies ⇒ Object

Returns the value of attribute cookies.



228
229
230
 
# File 'lib/httpclient/cookie.rb', line 228

def cookies
  @cookies
end

#cookies_file ⇒ Object

Returns the value of attribute cookies_file.



229
230
231
 
# File 'lib/httpclient/cookie.rb', line 229

def cookies_file
  @cookies_file
end

#reject_domains ⇒ Object

Returns the value of attribute reject_domains.



230
231
232
 
# File 'lib/httpclient/cookie.rb', line 230

def reject_domains
  @reject_domains
end

Instance Method Details

#add(given) ⇒ Object 



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/httpclient/cookie.rb', line 308

def add(given)
  check_domain(given.domain, given.url.host, given.override?)

  domain = given.domain || given.url.host
  path = given.path || given.url.path.sub(%r|/[^/]*\z|, '')

  cookie = nil
  @cookies.synchronize do
    check_expired_cookies
    cookie = @cookies.find { |c|
      c.domain == domain && c.path == path && c.name == given.name
    }
    if !cookie
      cookie = WebAgent::Cookie.new
      cookie.use = true
      @cookies << cookie
    end
  end

  cookie.domain = domain
  cookie.path = path
  cookie.url = given.url
  cookie.name = given.name
  cookie.value = given.value
  cookie.expires = given.expires
  cookie.secure = given.secure?
  cookie.http_only = given.http_only?
  cookie.domain_orig = given.domain
  cookie.path_orig = given.path

  if cookie.discard? || cookie.expires == nil
    cookie.discard = true
  else
    cookie.discard = false
    @is_saved = false
  end
end

#check_cookie_accept_domain(domain) ⇒ Object

Who use it?



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/httpclient/cookie.rb', line 372

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_cookies ⇒ Object 



277
278
279
280
281
282
283
284
285
 
# File 'lib/httpclient/cookie.rb', line 277

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 



293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/httpclient/cookie.rb', line 293

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_cookies ⇒ Object 



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/httpclient/cookie.rb', line 346

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 = HTTPClient::Util.urify(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 



287
288
289
290
291
 
# File 'lib/httpclient/cookie.rb', line 287

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 



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/httpclient/cookie.rb', line 249

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 



273
274
275
 
# File 'lib/httpclient/cookie.rb', line 273

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