rubyforge 0.4.5 → 1.0.0

data/lib/http-access2/cookie.rb

@@ -1,537 +0,0 @@
-# cookie.rb is redistributed file which is originally included in Webagent
-# version 0.6.2 by TAKAHASHI `Maki' Masayoshi.  And it contains some bug fixes.
-# You can download the entire package of Webagent from
-# http://www.rubycolor.org/arc/.
-
-
-# Cookie class
-#
-# I refered to w3m's source to make these classes. Some comments
-# are quoted from it. I'm thanksful for author(s) of it.
-#
-#    w3m homepage:  http://ei5nazha.yz.yamagata-u.ac.jp/~aito/w3m/eng/
-
-require 'uri'
-
-class WebAgent
-
-  module CookieUtils
-
-    def head_match?(str1, str2)
-      str1 == str2[0, str1.length]
-    end
-
-    def tail_match?(str1, str2)
-      if str1.length > 0
-	str1 == str2[-str1.length..-1].to_s
-      else
-	true
-      end
-    end
-
-    def domain_match(host, domain)
-      case domain
-      when /\d+\.\d+\.\d+\.\d+/
-	return (host == domain)
-      when '.' 
-	return true
-      when /^\./
-	return tail_match?(domain, host)
-      else
-	return (host == domain)
-      end
-    end
-
-    def total_dot_num(string)
-      string.scan(/\./).length()
-    end
-
-  end
-
-  class Cookie
-    include CookieUtils
-
-    require 'time'
-
-    attr_accessor :name, :value
-    attr_accessor :domain, :path
-    attr_accessor :expires      ## for Netscape Cookie
-    attr_accessor :url
-    attr_writer :use, :secure, :discard, :domain_orig, :path_orig, :override
-
-    USE = 1
-    SECURE = 2
-    DOMAIN = 4
-    PATH = 8
-    DISCARD = 16
-    OVERRIDE = 32
-    OVERRIDE_OK = 32
-
-    def initialize()
-      @discard = @use = @secure = @domain_orig = @path_orig = @override = nil
-    end
-
-    def discard?
-      @discard
-    end
-
-    def use?
-      @use
-    end
-
-    def secure?
-      @secure
-    end
-
-    def domain_orig?
-      @domain_orig
-    end
-
-    def path_orig?
-      @path_orig
-    end
-
-    def override?
-      @override
-    end
-
-    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
-
-    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
-
-    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
-
-    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
-
-    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.parse(value).gmtime
-	  rescue ArgumentError
-	    @expires = nil
-	  end
-	when 'path'
-	  @path = value
-	when 'secure'
-	  @secure = true  ## value may nil, but must 'true'.
-	else
-	  ## ignore
-	end
-      }
-    end
-
-  end
-
-  class CookieManager
-    include CookieUtils
-
-    ### errors
-    class Error < StandardError; end
-    class ErrorOverrideOK < Error; end
-    class SpecialError < Error; end
-    class NoDotError < ErrorOverrideOK; end
-
-    SPECIAL_DOMAIN = [".com",".edu",".gov",".mil",".net",".org",".int"]
-
-    attr_accessor :cookies
-    attr_accessor :cookies_file
-    attr_accessor :accept_domains, :reject_domains
-    attr_accessor :netscape_rule
-
-    def initialize(file=nil)
-      @cookies = Array.new()
-      @cookies_file = file
-      @is_saved = true
-      @reject_domains = Array.new()
-      @accept_domains = Array.new()
-      # for conformance to http://wp.netscape.com/newsref/std/cookie_spec.html
-      @netscape_rule = false
-    end
-
-    def save_all_cookies(force = nil, save_unused = true, save_discarded = true)
-      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
-
-    def save_cookies(force = nil)
-      save_all_cookies(force, false, false)
-    end
-
-    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
-
-    def parse(str, url)
-      cookie = WebAgent::Cookie.new()
-      cookie.parse(str, url)
-      add(cookie)
-    end
-
-    def make_cookie_str(cookie_list)
-      if cookie_list.empty?
-	return nil
-      end
-
-      ret = ''
-      c = cookie_list.shift
-      ret += "#{c.name}=#{c.value}"
-      cookie_list.each{|cookie|
-	ret += "; #{cookie.name}=#{cookie.value}"
-      }
-      return ret
-    end
-    private :make_cookie_str
-
-
-    def find(url)
-
-      check_expired_cookies()
-
-      cookie_list = Array.new()
-
-      @cookies.each{|cookie|
-	if cookie.use? && 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
-
-    def find_cookie_info(domain, path, name)
-      @cookies.find{|c|
-	c.domain == domain && c.path == path && c.name == name
-      }
-    end
-    private :find_cookie_info
-
-    def cookie_error(err, override)
-      if err.kind_of?(ErrorOverrideOK) || !override
-	raise err
-      end
-    end
-    private :cookie_error
-
-    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 !domainname
-	cookie_error(NodotError.new(), override)
-      end
-
-      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
-
-	n = total_dot_num(domain)
-	if n < 2
-	  cookie_error(SpecialError.new(), override)
-	elsif @netscape_rule and 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
-
-      path ||= url.path.sub!(%r|/[^/]*|, '')
-      domain ||= domainname
-      cookie = find_cookie_info(domain, path, name)
-
-      if !cookie
-	cookie = WebAgent::Cookie.new()
-	cookie.use = true
-	@cookies << cookie
-      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
-
-      check_expired_cookies()
-      return false
-    end
-
-    def load_cookies()
-      return if !File.readable?(@cookies_file)
-      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]
-	  cookie.expires = Time.at(col[3].to_i)
-	  cookie.domain = col[4]
-	  cookie.path = col[5]
-	  cookie.set_flag(col[6])
-	end
-      }
-    end
-
-    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
-  end
-end
-
-__END__
-
-=begin
-
-== WebAgent::CookieManager Class
-
-Load, save, parse and send cookies.
-
-=== Usage
-
-  ## initialize
-  cm = WebAgent::CookieManager.new("/home/foo/bar/cookie")
-
-  ## load cookie data
-  cm.load_cookies()
-
-  ## parse cookie from string (maybe "Set-Cookie:" header)
-  cm.parse(str)
-
-  ## send cookie data to url
-  f.write(cm.find(url))
-
-  ## save cookie to cookiefile
-  cm.save_cookies()
-
-
-=== Class Methods
-
- -- CookieManager::new(file=nil)
-
-     create new CookieManager. If a file is provided,
-     use it as cookies' file.
-
-=== Methods
-
- -- CookieManager#save_cookies(force = nil)
-
-     save cookies' data into file. if argument is true,
-     save data although data is not modified.
-
- -- CookieManager#parse(str, url)
-
-     parse string and store cookie (to parse HTTP response header).
-
- -- CookieManager#find(url)
-
-     get cookies and make into string (to send as HTTP request header).
-
- -- CookieManager#add(cookie)
-
-     add new cookie.
-
- -- CookieManager#load_cookies()
-
-     load cookies' data from file.
-
-
-== WebAgent::CookieUtils Module
-
- -- CookieUtils::head_match?(str1, str2)
- -- CookieUtils::tail_match?(str1, str2)
- -- CookieUtils::domain_match(host, domain)
- -- CookieUtils::total_dot_num(str)
-
-
-== WebAgent::Cookie Class
-
-=== Class Methods
-
- -- Cookie::new()
-
-      create new cookie.
-
-=== Methods
-
- -- Cookie#match?(url)
-
-       match cookie by url. if match, return true. otherwise,
-       return false.
-
- -- Cookie#name
- -- Cookie#name=(name)
- -- Cookie#value
- -- Cookie#value=(value)
- -- Cookie#domain
- -- Cookie#domain=(domain)
- -- Cookie#path
- -- Cookie#path=(path)
- -- Cookie#expires
- -- Cookie#expires=(expires)
- -- Cookie#url
- -- Cookie#url=(url)
-
-      accessor methods for cookie's items.
-
- -- Cookie#discard?
- -- Cookie#discard=(discard)
- -- Cookie#use?
- -- Cookie#use=(use)
- -- Cookie#secure?
- -- Cookie#secure=(secure)
- -- Cookie#domain_orig?
- -- Cookie#domain_orig=(domain_orig)
- -- Cookie#path_orig?
- -- Cookie#path_orig=(path_orig)
- -- Cookie#override?
- -- Cookie#override=(override)
- -- Cookie#flag
- -- Cookie#set_flag(flag_num)
-
-      accessor methods for flags.
-
-=end