httpclient 2.1.5 → 2.8.3

data/lib/httpclient/timeout.rb

@@ -1,5 +1,5 @@
 # HTTPClient - HTTP client library.
-# Copyright (C) 2000-2009  NAKAMURA, Hiroshi  <nahi@ruby-lang.org>.
+# Copyright (C) 2000-2015  NAKAMURA, Hiroshi  <nahi@ruby-lang.org>.
 #
 # This program is copyrighted free software by NAKAMURA, Hiroshi.  You can
 # redistribute it and/or modify it under the same terms of Ruby's license;
@@ -23,6 +23,7 @@ class HTTPClient
   #   timeout scheduler.
   # * Do not wakeup the scheduler thread so often.  Let scheduler thread sleep
   #   until the nearest period.
+if !defined?(JRUBY_VERSION) and RUBY_VERSION < '1.9'
   class TimeoutScheduler
 
     # Represents timeout period.
@@ -117,17 +118,20 @@ class HTTPClient
     end
   end
   timeout_scheduler # initialize at first time.
+end
 
   module Timeout
-    def timeout(sec, ex = nil, &block)
-      return yield if sec == nil or sec.zero?
-      scheduler = nil
-      begin
-        scheduler = HTTPClient.timeout_scheduler
-        period = scheduler.register(Thread.current, sec, ex)
-        yield(sec)
-      ensure
-        scheduler.cancel(period) if scheduler and period
+    if !defined?(JRUBY_VERSION) and RUBY_VERSION < '1.9'
+      def timeout(sec, ex = nil, &block)
+        return yield if sec == nil or sec.zero?
+        scheduler = nil
+        begin
+          scheduler = HTTPClient.timeout_scheduler
+          period = scheduler.register(Thread.current, sec, ex)
+          yield(sec)
+        ensure
+          scheduler.cancel(period) if scheduler and period
+        end
       end
     end
   end

data/lib/httpclient/util.rb

@@ -1,12 +1,49 @@
 # HTTPClient - HTTP client library.
-# Copyright (C) 2000-2009  NAKAMURA, Hiroshi  <nahi@ruby-lang.org>.
+# Copyright (C) 2000-2015  NAKAMURA, Hiroshi  <nahi@ruby-lang.org>.
 #
 # This program is copyrighted free software by NAKAMURA, Hiroshi.  You can
 # redistribute it and/or modify it under the same terms of Ruby's license;
 # either the dual license version in 2003, or any later version.
 
 
-require 'uri'
+unless ''.respond_to?(:bytesize)
+  class String
+    alias bytesize size
+  end
+end
+
+if RUBY_VERSION < "1.9.3"
+  require 'uri'
+  module URI
+    class Generic
+      def hostname
+        v = self.host
+        /\A\[(.*)\]\z/ =~ v ? $1 : v
+      end
+    end
+  end
+end
+
+# With recent JRuby 1.7 + jruby-openssl, X509CRL#extentions_to_text causes
+# StringIndexOOBException when we try to dump SSL Server Certificate.
+# when one of extensions has "" as value.
+if defined?(JRUBY_VERSION)
+  require 'openssl'
+  require 'java'
+  module OpenSSL
+    module X509
+      class Certificate
+        java_import 'java.security.cert.Certificate'
+        java_import 'java.security.cert.CertificateFactory'
+        java_import 'java.io.ByteArrayInputStream'
+        def to_text
+          cf = CertificateFactory.getInstance('X.509')
+          cf.generateCertificate(ByteArrayInputStream.new(self.to_der.to_java_bytes)).toString
+        end
+      end
+    end
+  end
+end
 
 
 class HTTPClient
@@ -14,6 +51,47 @@ class HTTPClient
 
   # A module for common function.
   module Util
+
+    # URI abstraction; Addressable::URI or URI
+    require 'uri'
+    begin
+      require 'addressable/uri'
+      # Older versions doesn't have #default_port
+      unless Addressable::URI.instance_methods.include?(:default_port) # 1.9 only
+        raise LoadError
+      end
+      class AddressableURI < Addressable::URI
+        # Overwrites the original definition just for one line...
+        def authority
+          self.host && @authority ||= (begin
+            authority = ""
+            if self.userinfo != nil
+              authority << "#{self.userinfo}@"
+            end
+            authority << self.host
+            if self.port != self.default_port # ...HERE! Compares with default_port because self.port is not nil in this wrapper.
+              authority << ":#{self.port}"
+            end
+            authority
+          end)
+        end
+
+        # HTTPClient expects urify("http://foo/").port to be not nil but 80 like URI.
+        def port
+          super || default_port
+        end
+
+        # Captured from uri/generic.rb
+        def hostname
+          v = self.host
+          /\A\[(.*)\]\z/ =~ v ? $1 : v
+        end
+      end
+      AddressableEnabled = true
+    rescue LoadError
+      AddressableEnabled = false
+    end
+
     # Keyword argument helper.
     # args:: given arguments.
     # *field:: a list of arguments to be extracted.
@@ -35,11 +113,35 @@ class HTTPClient
     #   end
     #
     def keyword_argument(args, *field)
-      if args.size == 1 and args[0].is_a?(Hash)
-        args[0].values_at(*field)
-      else
-        args
+      if args.size == 1 and Hash === args[0]
+        h = args[0]
+        if field.any? { |f| h.key?(f) }
+          return h.values_at(*field)
+        end
       end
+      args
+    end
+
+    # Keyword argument to hash helper.
+    # args:: given arguments.
+    # *field:: a list of arguments to be extracted.
+    #
+    # Returns hash which has defined keys. When a Hash given, returns it
+    # including undefined keys. When an Array given, returns a Hash which only
+    # includes defined keys.
+    def argument_to_hash(args, *field)
+      return nil if args.empty?
+      if args.size == 1 and Hash === args[0]
+        h = args[0]
+        if field.any? { |f| h.key?(f) }
+          return h
+        end
+      end
+      h = {}
+      field.each_with_index do |e, idx|
+        h[e] = args[idx]
+      end
+      h
     end
 
     # Gets an URI instance.
@@ -48,10 +150,13 @@ class HTTPClient
         nil
       elsif uri.is_a?(URI)
         uri
+      elsif AddressableEnabled
+        AddressableURI.parse(uri.to_s)
       else
         URI.parse(uri.to_s)
       end
     end
+    module_function :urify
 
     # Returns true if the given 2 URIs have a part_of relationship.
     # * the same scheme
@@ -80,6 +185,37 @@ class HTTPClient
       v ? v[1] : nil
     end
     module_function :hash_find_value
+
+    # Try to require a feature and returns true/false if loaded
+    #
+    # It returns 'true' for the second require in contrast of the standard
+    # require returns false if the feature is already loaded.
+    def try_require(feature)
+      require feature
+      true
+    rescue LoadError
+      false
+    end
+    module_function :try_require
+
+    # show one warning message only once by caching message
+    #
+    # it cached all messages in memory so be careful not to show many kinds of warning message.
+    @@__warned = {}
+    def warning(message)
+      return if @@__warned.key?(message)
+      warn(message)
+      @@__warned[message] = true
+    end
+
+    # Checks if the given URI is https.
+    def https?(uri)
+      uri.scheme && uri.scheme.downcase == 'https'
+    end
+
+    def http?(uri)
+      uri.scheme && uri.scheme.downcase == 'http'
+    end
   end
 
 

data/lib/httpclient/version.rb

@@ -0,0 +1,3 @@
+class HTTPClient
+  VERSION = '2.8.3'
+end

data/lib/httpclient/webagent-cookie.rb

@@ -0,0 +1,459 @@
+# 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 'time'
+require 'monitor'
+require 'httpclient/util'
+
+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)
+      return false if domain.nil?
+      domainname = domain.sub(/\.\z/, '').downcase
+      hostname = host.sub(/\.\z/, '').downcase
+      case domain
+      when /\d+\.\d+\.\d+\.\d+/
+        return (hostname == domainname)
+      when '.'
+        return true
+      when /^\./
+        # allows; host == rubyforge.org, domain == .rubyforge.org
+        return tail_match?(domainname, '.' + hostname)
+      else
+        return (hostname == domainname)
+      end
+    end
+  end
+
+  class Cookie
+    include CookieUtils
+
+    attr_accessor :name, :value
+    attr_accessor :domain, :path
+    attr_accessor :expires      ## for Netscape Cookie
+    attr_accessor :url
+    attr_writer :use, :secure, :http_only, :discard, :domain_orig, :path_orig, :override
+
+    USE = 1
+    SECURE = 2
+    DOMAIN = 4
+    PATH = 8
+    DISCARD = 16
+    OVERRIDE = 32
+    OVERRIDE_OK = 32
+    HTTP_ONLY = 64
+
+    def self.parse(str, url)
+      cookie = new
+      cookie.parse(str, url)
+      cookie
+    end
+
+    def initialize
+      @name = @value = @domain = @path = nil
+      @expires = nil
+      @url = nil
+      @use = @secure = @http_only = @discard = @domain_orig = @path_orig = @override = nil
+    end
+
+    def discard?
+      @discard
+    end
+
+    def use?
+      @use
+    end
+
+    def secure?
+      @secure
+    end
+
+    def http_only?
+      @http_only
+    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 += HTTP_ONLY  if @http_only
+      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
+      @http_only = true   if flag & HTTP_ONLY > 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.empty? ? '/' : 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
+      # TODO: should not depend on join_quotedstr. scan with escape like CSV.
+      cookie_elem = str.split(/;/)
+      cookie_elem = join_quotedstr(cookie_elem, ';')
+      cookie_elem -= [""] # del empty elements, a cookie might included ";;"
+      first_elem = cookie_elem.shift
+      if first_elem !~ /([^=]*)(\=(.*))?/
+        return
+        ## raise ArgumentError 'invalid cookie value'
+      end
+      @name = $1.strip
+      @value = normalize_cookie_value($3)
+      cookie_elem.each{|pair|
+        key, value = pair.split(/=/, 2)  ## value may nil
+        key.strip!
+        value = normalize_cookie_value(value)
+        case key.downcase
+        when 'domain'
+          @domain = value
+        when 'expires'
+          @expires = nil
+          begin
+            @expires = Time.parse(value).gmtime if value
+          rescue ArgumentError
+          end
+        when 'path'
+          @path = value
+        when 'secure'
+          @secure = true  ## value may nil, but must 'true'.
+        when 'httponly'
+          @http_only = true  ## value may nil, but must 'true'.
+        else
+          warn("Unknown key: #{key} = #{value}")
+        end
+      }
+    end
+
+    private
+
+    def normalize_cookie_value(value)
+      if value
+        value = value.strip.sub(/\A"(.*)"\z/) { $1 }
+        value = nil if value.empty?
+      end
+      value
+    end
+  end
+
+  ##
+  # An Array class that already includes the MonitorMixin module.
+  #
+  class SynchronizedArray < Array
+    include MonitorMixin
+  end
+
+  class CookieManager
+    include CookieUtils
+
+    ### errors
+    class Error < StandardError; end
+    class ErrorOverrideOK < Error; end
+    class SpecialError < Error; end
+
+    attr_reader :cookies
+    attr_accessor :cookies_file
+    attr_accessor :accept_domains, :reject_domains
+
+    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
+
+    def cookies=(cookies)
+      if cookies.is_a?(SynchronizedArray)
+        @cookies = cookies
+      else
+        @cookies = SynchronizedArray.new(cookies)
+      end
+    end
+
+    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
+
+    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 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
+    alias cookie_value find
+
+    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
+
+    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
+
+    # Who use it?
+    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
+
+    private
+
+    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
+
+    # for conformance to http://wp.netscape.com/newsref/std/cookie_spec.html
+    attr_accessor :netscape_rule
+    SPECIAL_DOMAIN = [".com",".edu",".gov",".mil",".net",".org",".int"]
+
+    def check_domain(domain, hostname, override)
+      return unless 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 !~ /^\./ && hostname != domain
+        domain = '.'+domain
+      end
+      # [NETSCAPE] rule
+      if @netscape_rule
+        n = domain.scan(/\./).length
+        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
+
+    # not tested well; used only netscape_rule = true.
+    def cookie_error(err, override)
+      if !err.kind_of?(ErrorOverrideOK) || !override
+        raise err
+      end
+    end
+  end
+end
+
+class HTTPClient
+  CookieManager = WebAgent::CookieManager
+end unless defined?(HTTPClient::CookieManager)