httpclient 2.5.3.3 → 2.6.0

data/lib/httpclient/http.rb

@@ -198,6 +198,7 @@ module HTTP
         @request_uri = uri || NIL_URI
         @request_query = query
         @request_absolute_uri = false
+        self
       end
 
       # Initialize this instance as a response.
@@ -209,6 +210,7 @@ module HTTP
           @request_uri = req.request_uri
           @request_query = req.request_query
         end
+        self
       end
 
       # Sets status code and reason phrase.
@@ -441,6 +443,8 @@ module HTTP
       attr_reader :size
       # maxbytes of IO#read for streaming request.  See DEFAULT_CHUNK_SIZE.
       attr_accessor :chunk_size
+      # Hash that keeps IO positions
+      attr_accessor :positions
 
       # Default value for chunk_size
       DEFAULT_CHUNK_SIZE = 1024 * 16
@@ -460,6 +464,7 @@ module HTTP
         @positions = {}
         set_content(body, boundary)
         @chunk_size = DEFAULT_CHUNK_SIZE
+        self
       end
 
       # Initialize this instance as a response.
@@ -472,6 +477,7 @@ module HTTP
         else
           @size = nil
         end
+        self
       end
 
       # Dumps message body to given dev.
@@ -481,13 +487,15 @@ module HTTP
       # reason. (header is dumped to dev, too)
       # If no dev (the second argument) given, this method returns a dumped
       # String.
+      #
+      # assert: @size is not nil
       def dump(header = '', dev = '')
         if @body.is_a?(Parts)
           dev << header
           @body.parts.each do |part|
             if Message.file?(part)
               reset_pos(part)
-              dump_file(part, dev)
+              dump_file(part, dev, @body.sizes[part])
             else
               dev << part
             end
@@ -495,7 +503,7 @@ module HTTP
         elsif Message.file?(@body)
           dev << header
           reset_pos(@body)
-          dump_file(@body, dev)
+          dump_file(@body, dev, @size)
         elsif @body
           dev << header + @body
         else
@@ -563,10 +571,14 @@ module HTTP
         io.pos = @positions[io] if @positions.key?(io)
       end
 
-      def dump_file(io, dev)
+      def dump_file(io, dev, sz)
         buf = ''
-        while !io.read(@chunk_size, buf).nil?
+        rest = sz
+        while rest > 0
+          n = io.read([rest, @chunk_size].min, buf)
+          raise ArgumentError.new("Illegal size value: #size returns #{sz} but cannot read") if n.nil?
           dev << buf
+          rest -= n.bytesize
         end
       end
 
@@ -591,10 +603,12 @@ module HTTP
 
       class Parts
         attr_reader :size
+        attr_reader :sizes
 
         def initialize
           @body = []
-          @size = 0
+          @sizes = {}
+          @size = 0 # total
           @as_stream = false
         end
 
@@ -603,15 +617,18 @@ module HTTP
             @as_stream = true
             @body << part
             if part.respond_to?(:lstat)
-              @size += part.lstat.size
+              sz = part.lstat.size
+              add_size(part, sz)
             elsif part.respond_to?(:size)
               if sz = part.size
-                @size += sz
+                add_size(part, sz)
               else
+                @sizes.clear
                 @size = nil
               end
             else
               # use chunked upload
+              @sizes.clear
               @size = nil
             end
           elsif @body[-1].is_a?(String)
@@ -630,6 +647,15 @@ module HTTP
             [@body.join]
           end
         end
+
+      private
+
+        def add_size(part, sz)
+          if @size
+            @sizes[part] = sz
+            @size += sz
+          end
+        end
       end
 
       def build_query_multipart_str(query, boundary)
@@ -908,12 +934,17 @@ module HTTP
     #                              used for retrieving the response.
     attr_accessor :peer_cert
 
+    # The other Message object when this Message is generated instead of
+    # the Message because of redirection, negotiation, or format conversion.
+    attr_accessor :previous
+
     # Creates a Message.  This method should be used internally.
     # Use Message.new_connect_request, Message.new_request or
     # Message.new_response instead.
     def initialize # :nodoc:
       @http_header = Headers.new
       @http_body = @peer_cert = nil
+      @previous = nil
     end
 
     # Dumps message (header and body) to given dev.
@@ -1023,10 +1054,8 @@ module HTTP
       unless set_cookies.empty?
         uri = http_header.request_uri
         set_cookies.map { |str|
-          cookie = WebAgent::Cookie.new
-          cookie.parse(str, uri)
-          cookie
-        }
+          WebAgent::Cookie.parse(str, uri)
+        }.flatten
       end
     end
 

data/lib/httpclient/session.rb

@@ -17,7 +17,7 @@ require 'thread'
 require 'stringio'
 require 'zlib'
 
-require 'httpclient/timeout'
+require 'httpclient/timeout' # TODO: remove this once we drop 1.8 support
 require 'httpclient/ssl_config'
 require 'httpclient/http'
 
@@ -183,16 +183,6 @@ class HTTPClient
       add_cached_session(sess)
     end
 
-    def invalidate(site)
-      @sess_pool_mutex.synchronize do
-        if pool = @sess_pool[site]
-          pool.each do |sess|
-            sess.invalidate
-          end
-        end
-      end
-    end
-
   private
 
     # TODO: create PR for webmock's httpclient adapter to use get_session
@@ -253,6 +243,9 @@ class HTTPClient
     end
 
     def get_cached_session(site)
+      if Thread.current[:HTTPClient_AcquireNewConnection]
+        return nil
+      end
       @sess_pool_mutex.synchronize do
         now = Time.now
         if now > @sess_pool_last_checked + @keep_alive_timeout
@@ -284,7 +277,7 @@ class HTTPClient
     end
 
     def valid_session?(sess, now)
-      !sess.invalidated? and (now <= sess.last_used + @keep_alive_timeout)
+      (now <= sess.last_used + @keep_alive_timeout)
     end
 
     def add_cached_session(sess)
@@ -578,7 +571,6 @@ class HTTPClient
     def initialize(client, dest, agent_name, from)
       @client = client
       @dest = dest
-      @invalidated = false
       @proxy = nil
       @socket_sync = true
       @requested_version = nil
@@ -662,14 +654,6 @@ class HTTPClient
       @state == :INIT
     end
 
-    def invalidate
-      @invalidated = true
-    end
-
-    def invalidated?
-      @invalidated
-    end
-
     def get_header
       begin
         if @state != :META
@@ -855,7 +839,7 @@ class HTTPClient
         filter.filter_response(req, res)
       }
       if commands.find { |command| command == :retry }
-        raise RetryableResponse.new
+        raise RetryableResponse.new(res)
       end
       unless @status == 200
         raise BadResponseError.new("connect to ssl proxy failed with status #{@status} #{@reason}", res)

data/lib/httpclient/version.rb

@@ -1,3 +1,3 @@
 class HTTPClient
-  VERSION = '2.5.3.3'
+  VERSION = '2.6.0'
 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