curb 0.9.2 → 0.9.11

data/ext/curb_multi.h

@@ -14,7 +14,6 @@
 typedef struct {
   int active;
   int running;
-  VALUE requests; /* hash of handles currently added */
   CURLM *handle;
 } ruby_curl_multi;
 

data/ext/extconf.rb

@@ -59,6 +59,9 @@ def have_constant(name)
   end
 end
 
+have_constant "curlopt_tcp_keepalive"
+have_constant "curlopt_tcp_keepidle"
+have_constant "curlopt_tcp_keepintvl"
 have_constant "curlinfo_appconnect_time"
 have_constant "curlinfo_redirect_time"
 have_constant "curlinfo_response_code"
@@ -66,6 +69,7 @@ have_constant "curlinfo_filetime"
 have_constant "curlinfo_redirect_count"
 have_constant "curlinfo_os_errno"
 have_constant "curlinfo_num_connects"
+have_constant "curlinfo_cookielist"
 have_constant "curlinfo_ftp_entry_path"
 have_constant "curl_version_ssl"
 have_constant "curl_version_libz"
@@ -83,6 +87,7 @@ have_constant "curlproxy_http"
 have_constant "curlproxy_socks4"
 have_constant "curlproxy_socks4a"
 have_constant "curlproxy_socks5"
+have_constant "curlproxy_socks5_hostname"
 have_constant "curlauth_basic"
 have_constant "curlauth_digest"
 have_constant "curlauth_gssnegotiate"
@@ -101,6 +106,12 @@ have_constant "curle_send_fail_rewind"
 have_constant "curle_ssl_engine_initfailed"
 have_constant "curle_login_denied"
 
+# older than 7.10.0
+have_constant "curlopt_nosignal"
+
+# older than 7.16.0
+have_constant "curlmopt_pipelining"
+
 # older than 7.16.3
 have_constant "curlmopt_maxconnects"
 
@@ -145,6 +156,8 @@ have_func("curl_multi_timeout")
 have_func("curl_multi_fdset")
 have_func("curl_multi_perform")
 
+have_constant "curlopt_haproxyprotocol"
+
 # constants
 have_constant "curlopt_interleavefunction"
 have_constant "curlopt_interleavedata"
@@ -209,6 +222,7 @@ have_constant "curlopt_httppost"
 have_constant "curlopt_referer"
 have_constant "curlopt_useragent"
 have_constant "curlopt_httpheader"
+have_constant "curlopt_proxyheader"
 have_constant "curlopt_http200aliases"
 have_constant "curlopt_cookie"
 have_constant "curlopt_cookiefile"
@@ -321,9 +335,12 @@ have_constant "curl_sslversion_default"
 have_constant :CURL_SSLVERSION_TLSv1
 have_constant :CURL_SSLVERSION_SSLv2
 have_constant :CURL_SSLVERSION_SSLv3
+
+# Added in 7.34.0
 have_constant :CURL_SSLVERSION_TLSv1_0
 have_constant :CURL_SSLVERSION_TLSv1_1
 have_constant :CURL_SSLVERSION_TLSv1_2
+
 have_constant "curlopt_ssl_verifypeer"
 have_constant "curlopt_cainfo"
 have_constant "curlopt_issuercert"
@@ -357,6 +374,16 @@ have_constant "curle_not_built_in"
 
 have_constant "curle_obsolete" # removed in 7.24 ?
 
+have_constant "curle_ftp_pret_failed"
+have_constant "curle_rtsp_cseq_error"
+have_constant "curle_rtsp_session_error"
+have_constant "curle_ftp_bad_file_list"
+have_constant "curle_chunk_failed"
+have_constant "curle_no_connection_available"
+have_constant "curle_ssl_pinnedpubkeynotmatch"
+have_constant "curle_ssl_invalidcertstatus"
+have_constant "curle_http2_stream"
+
 # gssapi/spnego delegation related constants
 have_constant "curlopt_gssapi_delegation"
 have_constant "curlgssapi_delegation_policy_flag"
@@ -367,6 +394,12 @@ have_constant "CURLM_ADDED_ALREADY"
 # added in 7.40.0
 have_constant "curlopt_unix_socket_path"
 
+# added in 7.42.0
+have_constant "curlopt_path_as_is"
+
+# added in 7.43.0
+have_constant "curlopt_pipewait"
+
 if try_compile('int main() { return 0; }','-Wall')
   $CFLAGS << ' -Wall'
 end
@@ -394,6 +427,8 @@ test_for("curl_easy_escape", "CURL_EASY_ESCAPE", %{
 
 have_func('rb_thread_blocking_region')
 have_header('ruby/thread.h') && have_func('rb_thread_call_without_gvl', 'ruby/thread.h')
+have_header('ruby/io.h')
+have_func('rb_io_stdio_file')
 
 create_header('curb_config.h')
 create_makefile('curb_core')

data/lib/curb.rb

@@ -1 +1,2 @@
+# frozen_string_literal: true
 require 'curl'

data/lib/curl/easy.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Curl
   class Easy
 
@@ -19,9 +20,9 @@ module Curl
     #   easy.status  => String
     #
     def status
-      # Matches the last HTTP Status - following the HTTP protocol specification 'Status-Line = HTTP-Version SP Status-Code SP Reason-Phrase CRLF'
-      statuses = self.header_str.scan(/HTTP\/\d\.\d\s(\d+\s.*)\r\n/).map{ |match|  match[0] }
-      statuses.last.strip
+      # Matches the last HTTP Status - following the HTTP protocol specification 'Status-Line = HTTP-Version SP Status-Code SP (Opt:)Reason-Phrase CRLF'
+      statuses = self.header_str.scan(/HTTP\/\d(\.\d)?\s(\d+\s.*)\r\n/).map{ |match| match[1] }
+      statuses.last.strip if statuses.length > 0
     end
 
     #
@@ -68,9 +69,14 @@ module Curl
       ret = self.multi.perform
       self.multi.remove self
 
+      if Curl::Multi.autoclose
+        self.multi.close
+        self.multi = nil
+      end
+
       if self.last_result != 0 && self.on_failure.nil?
         error = Curl::Easy.error(self.last_result)
-        raise error.first.new(error.last)
+        raise error.first.new(self.head)
       end
 
       ret

data/lib/curl/multi.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
 module Curl
-
   class Multi
     class << self
       # call-seq:
       #   Curl::Multi.get(['url1','url2','url3','url4','url5'], :follow_location => true) do|easy|
       #     easy
       #   end
-      # 
+      #
       # Blocking call to fetch multiple url's in parallel.
       def get(urls, easy_options={}, multi_options={}, &blk)
         url_confs = []
@@ -25,10 +25,10 @@ module Curl
       #                    {:pipeline => Curl::CURLPIPE_HTTP1}) do|easy|
       #     easy_handle_on_request_complete
       #   end
-      # 
+      #
       # Blocking call to POST multiple form's in parallel.
-      # 
-      # urls_with_config: is a hash of url's pointing to the postfields to send 
+      #
+      # urls_with_config: is a hash of url's pointing to the postfields to send
       # easy_options: are a set of common options to set on all easy handles
       # multi_options: options to set on the Curl::Multi handle
       #
@@ -49,10 +49,10 @@ module Curl
       #                    {:pipeline => Curl::CURLPIPE_HTTP1}) do|easy|
       #     easy_handle_on_request_complete
       #   end
-      # 
+      #
       # Blocking call to POST multiple form's in parallel.
-      # 
-      # urls_with_config: is a hash of url's pointing to the postfields to send 
+      #
+      # urls_with_config: is a hash of url's pointing to the postfields to send
       # easy_options: are a set of common options to set on all easy handles
       # multi_options: options to set on the Curl::Multi handle
       #
@@ -79,7 +79,7 @@ module Curl
       # Blocking call to issue multiple HTTP requests with varying verb's.
       #
       # urls_with_config: is a hash of url's pointing to the easy handle options as well as the special option :method, that can by one of [:get, :post, :put, :delete, :head], when no verb is provided e.g. :method => nil -> GET is used
-      # multi_options: options for the multi handle 
+      # multi_options: options for the multi handle
       # blk: a callback, that yeilds when a handle is completed
       #
       def http(urls_with_config, multi_options={}, &blk)
@@ -128,7 +128,7 @@ module Curl
 
           # headers is a special key
           headers.each {|k,v| easy.headers[k] = v } if headers
- 
+
           #
           # use the remaining options as specific configuration to the easy handle
           # bad options should raise an undefined method error
@@ -144,7 +144,7 @@ module Curl
 
         max_connects.times do
           conf = urls_with_config.pop
-          add_free_handle.call conf, nil
+          add_free_handle.call(conf, nil) if conf
           break if urls_with_config.empty?
         end
 
@@ -153,7 +153,7 @@ module Curl
           if urls_with_config.size > 0 && free_handles.size > 0
             easy = free_handles.pop
             conf = urls_with_config.pop
-            add_free_handle.call conf, easy
+            add_free_handle.call(conf, easy) if conf
           end
         end
 
@@ -168,6 +168,7 @@ module Curl
           end
           free_handles = nil
         end
+
       end
 
       # call-seq:
@@ -175,7 +176,7 @@ module Curl
       # Curl::Multi.download(['http://example.com/p/a/t/h/file1.txt','http://example.com/p/a/t/h/file2.txt']){|c|}
       #
       # will create 2 new files file1.txt and file2.txt
-      # 
+      #
       # 2 files will be opened, and remain open until the call completes
       #
       # when using the :post or :put method, urls should be a hash, including the individual post fields per post
@@ -242,7 +243,45 @@ module Curl
         }
         raise errors unless errors.empty?
       end
+    end
 
+    def cancel!
+      requests.each do |_,easy|
+        remove(easy)
+      end
     end
+
+    def idle?
+      requests.empty?
+    end
+
+    def requests
+      @requests ||= {}
+    end
+
+    def add(easy)
+      return self if requests[easy.object_id]
+      requests[easy.object_id] = easy
+      _add(easy)
+      self
+    end
+
+    def remove(easy)
+      return self if !requests[easy.object_id]
+      requests.delete(easy.object_id)
+      _remove(easy)
+      self
+    end
+
+    def close
+      requests.values.each {|easy|
+        _remove(easy)
+      }
+      @requests = {}
+      _close
+      self
+    end
+
+
   end
 end

data/lib/curl.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'curb_core'
 require 'curl/easy'
 require 'curl/multi'
@@ -6,7 +7,7 @@ require 'cgi'
 
 # expose shortcut methods
 module Curl
-  
+
   def self.http(verb, url, post_body=nil, put_data=nil, &block)
     handle = Thread.current[:curb_curl] ||= Curl::Easy.new
     handle.reset
@@ -47,14 +48,13 @@ module Curl
   end
 
   def self.urlalize(url, params={})
-    query_str = params.map {|k,v| "#{URI.escape(k.to_s)}=#{CGI.escape(v.to_s)}" }.join('&')
-    if url.match(/\?/) && query_str.size > 0
-      "#{url}&#{query_str}"
-    elsif query_str.size > 0
-      "#{url}?#{query_str}"
-    else
-      url
-    end
+    uri = URI(url)
+    # early return if we didn't specify any extra params
+    return uri.to_s if (params || {}).empty?
+
+    params_query = URI.encode_www_form(params || {})
+    uri.query = [uri.query.to_s, params_query].reject(&:empty?).join('&')
+    uri.to_s
   end
 
   def self.postalize(params={})

data/tests/bug_issue277.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+
+
+require 'curb'
+
+class BugIssue102 < Test::Unit::TestCase
+
+  def test_gc_closewait
+		100.times do
+			responses = {}
+			requests = ["http://www.google.co.uk/", "http://www.ruby-lang.org/"]
+			m = Curl::Multi.new
+			# add a few easy handles
+			requests.each do |url|
+				responses[url] = ""
+				c = Curl::Easy.new(url) do|curl|
+					curl.follow_location = true
+					curl.on_body{|data| responses[url] << data; data.size }
+					curl.on_success {|easy| #puts "success, add more easy handles"
+          }
+				end
+				m.add(c)
+			end
+
+			m.perform do
+				#puts "idling... can do some work here"
+			end
+      GC.start
+		end
+	end
+
+end

data/tests/helper.rb

@@ -2,6 +2,7 @@
 # Copyright (c)2006 Ross Bamford. See LICENSE.
 $CURB_TESTING = true
 require 'uri'
+require 'stringio'
 
 $TOPDIR = File.expand_path(File.join(File.dirname(__FILE__), '..'))
 $EXTDIR = File.join($TOPDIR, 'ext')
@@ -18,7 +19,7 @@ rescue LoadError
 end
 require 'fileutils'
 
-$TEST_URL = "file://#{URI.escape(File.expand_path(__FILE__).tr('\\','/').tr(':','|'))}"
+$TEST_URL = "file://#{'/' if RUBY_DESCRIPTION =~ /mswin|msys|mingw|cygwin|bccwin|wince|emc/}#{File.expand_path(__FILE__).tr('\\','/')}"
 
 require 'thread'
 require 'webrick'
@@ -30,19 +31,22 @@ require 'webrick'
 TEST_SINGLE_THREADED=false
 
 # keep webrick quiet
-class ::WEBrick::HTTPServer
+::WEBrick::HTTPServer.send(:remove_method,:access_log) if ::WEBrick::HTTPServer.instance_methods.include?(:access_log)
+::WEBrick::BasicLog.send(:remove_method,:log) if ::WEBrick::BasicLog.instance_methods.include?(:log)
+
+::WEBrick::HTTPServer.class_eval do
   def access_log(config, req, res)
     # nop
   end
 end
-class ::WEBrick::BasicLog
+::WEBrick::BasicLog.class_eval do
   def log(level, data)
     # nop
   end
 end
 
 #
-# Simple test server to record number of times a request is sent/recieved of a specific 
+# Simple test server to record number of times a request is sent/recieved of a specific
 # request type, e.g. GET,POST,PUT,DELETE
 #
 class TestServlet < WEBrick::HTTPServlet::AbstractServlet
@@ -52,13 +56,12 @@ class TestServlet < WEBrick::HTTPServlet::AbstractServlet
   end
 
   def self.port
-    (@port or 9129)
+    @port ||= 9129
   end
 
   def self.path
     '/methods'
   end
-
   def self.url
     "http://127.0.0.1:#{port}#{path}"
   end
@@ -70,12 +73,12 @@ class TestServlet < WEBrick::HTTPServlet::AbstractServlet
   end
 
   def do_GET(req,res)
-    if req.path.match /redirect$/
+    if req.path.match(/redirect$/)
       res.status = 302
       res['Location'] = '/foo'
-    elsif req.path.match /not_here$/
+    elsif req.path.match(/not_here$/)
       res.status = 404
-    elsif req.path.match /error$/
+    elsif req.path.match(/error$/)
       res.status = 500
     end
     respond_with("GET#{req.query_string}",req,res)
@@ -94,6 +97,9 @@ class TestServlet < WEBrick::HTTPServlet::AbstractServlet
       end
       if params and params['s'] == '500'
         res.status = 500
+      elsif params and params['c']
+        cookie = URI.decode_www_form_component(params['c']).split('=')
+        res.cookies << WEBrick::Cookie.new(*cookie)
       else
         respond_with("POST\n#{req.body}",req,res)
       end
@@ -136,7 +142,7 @@ module TestServerMethods
 
   def server_setup(port=9129,servlet=TestServlet)
     @__port = port
-    if @server.nil? and !File.exist?(locked_file)
+    if (@server ||= nil).nil? and !File.exist?(locked_file)
 
       File.open(locked_file,'w') {|f| f << 'locked' }
       if TEST_SINGLE_THREADED
@@ -145,7 +151,7 @@ module TestServerMethods
           rd.close
           rd = nil
 
-          # start up a webrick server for testing delete 
+          # start up a webrick server for testing delete
           server = WEBrick::HTTPServer.new :Port => port, :DocumentRoot => File.expand_path(File.dirname(__FILE__))
 
           server.mount(servlet.path, servlet)
@@ -161,7 +167,7 @@ module TestServerMethods
         rd.read
         rd.close
       else
-        # start up a webrick server for testing delete 
+        # start up a webrick server for testing delete
         @server = WEBrick::HTTPServer.new :Port => port, :DocumentRoot => File.expand_path(File.dirname(__FILE__))
 
         @server.mount(servlet.path, servlet)
@@ -202,3 +208,81 @@ module TestServerMethods
   rescue Errno::EADDRINUSE
   end
 end
+
+
+
+# Backport for Ruby 1.8
+module Backports
+  module Ruby18
+    module URIFormEncoding
+      TBLENCWWWCOMP_ = {}
+      TBLDECWWWCOMP_ = {}
+
+      def encode_www_form_component(str)
+        if TBLENCWWWCOMP_.empty?
+          256.times do |i|
+            TBLENCWWWCOMP_[i.chr] = '%%%02X' % i
+          end
+          TBLENCWWWCOMP_[' '] = '+'
+          TBLENCWWWCOMP_.freeze
+        end
+        str.to_s.gsub( /([^*\-.0-9A-Z_a-z])/ ) {|*| TBLENCWWWCOMP_[$1] }
+      end
+
+      def decode_www_form_component(str)
+        if TBLDECWWWCOMP_.empty?
+          256.times do |i|
+            h, l = i>>4, i&15
+            TBLDECWWWCOMP_['%%%X%X' % [h, l]] = i.chr
+            TBLDECWWWCOMP_['%%%x%X' % [h, l]] = i.chr
+            TBLDECWWWCOMP_['%%%X%x' % [h, l]] = i.chr
+            TBLDECWWWCOMP_['%%%x%x' % [h, l]] = i.chr
+          end
+          TBLDECWWWCOMP_['+'] = ' '
+          TBLDECWWWCOMP_.freeze
+        end
+
+        raise ArgumentError, "invalid %-encoding (#{str.dump})" unless /\A(?:%[[:xdigit:]]{2}|[^%]+)*\z/ =~ str
+        str.gsub( /(\+|%[[:xdigit:]]{2})/ ) {|*| TBLDECWWWCOMP_[$1] }
+      end
+
+      def encode_www_form( enum )
+        enum.map do |k,v|
+          if v.nil?
+            encode_www_form_component(k)
+          elsif v.respond_to?(:to_ary)
+            v.to_ary.map do |w|
+              str = encode_www_form_component(k)
+              unless w.nil?
+                str << '='
+                str << encode_www_form_component(w)
+              end
+            end.join('&')
+          else
+            str = encode_www_form_component(k)
+            str << '='
+            str << encode_www_form_component(v)
+          end
+        end.join('&')
+      end
+
+      WFKV_ = '(?:%\h\h|[^%#=;&])'
+      def decode_www_form(str, _)
+        return [] if str.to_s == ''
+
+        unless /\A#{WFKV_}=#{WFKV_}(?:[;&]#{WFKV_}=#{WFKV_})*\z/ =~ str
+          raise ArgumentError, "invalid data of application/x-www-form-urlencoded (#{str})"
+        end
+        ary = []
+        $&.scan(/([^=;&]+)=([^;&]*)/) do
+          ary << [decode_www_form_component($1, enc), decode_www_form_component($2, enc)]
+        end
+        ary
+      end
+    end
+  end
+end
+
+unless URI.methods.include?(:encode_www_form)
+  URI.extend(Backports::Ruby18::URIFormEncoding)
+end

data/tests/tc_curl.rb

@@ -31,7 +31,37 @@ class TestCurl < Test::Unit::TestCase
     assert_equal "OPTIONSfoo=bar", curl.body_str
   end
 
-  include TestServerMethods 
+  def test_urlalize_without_extra_params
+    url_no_params = 'http://localhost/test'
+    url_with_params = 'http://localhost/test?a=1'
+
+    assert_equal(url_no_params, Curl.urlalize(url_no_params))
+    assert_equal(url_with_params, Curl.urlalize(url_with_params))
+  end
+
+  def test_urlalize_with_nil_as_params
+    url = 'http://localhost/test'
+    assert_equal(url, Curl.urlalize(url, nil))
+  end
+
+  def test_urlalize_with_extra_params
+    url_no_params = 'http://localhost/test'
+    url_with_params = 'http://localhost/test?a=1'
+    extra_params = { :b => 2 }
+
+    expected_url_no_params = 'http://localhost/test?b=2'
+    expected_url_with_params = 'http://localhost/test?a=1&b=2'
+
+    assert_equal(expected_url_no_params, Curl.urlalize(url_no_params, extra_params))
+    assert_equal(expected_url_with_params, Curl.urlalize(url_with_params, extra_params))
+  end
+
+  def test_urlalize_does_not_strip_trailing_?
+    url_empty_params = 'http://localhost/test?'
+    assert_equal(url_empty_params, Curl.urlalize(url_empty_params))
+  end
+
+  include TestServerMethods
 
   def setup
     server_setup

data/tests/tc_curl_download.rb

@@ -11,7 +11,7 @@ class TestCurbCurlDownload < Test::Unit::TestCase
     dl_url = "http://127.0.0.1:9129/ext/curb_easy.c"
     dl_path = File.join(Dir::tmpdir, "dl_url_test.file")
 
-    curb = Curl::Easy.download(dl_url, dl_path)
+    Curl::Easy.download(dl_url, dl_path)
     assert File.exist?(dl_path)
     assert_equal File.read(File.join(File.dirname(__FILE__), '..','ext','curb_easy.c')), File.read(dl_path)
   ensure
@@ -23,7 +23,7 @@ class TestCurbCurlDownload < Test::Unit::TestCase
     dl_path = File.join(Dir::tmpdir, "dl_url_test.file")
     io = File.open(dl_path, 'wb')
 
-    curb = Curl::Easy.download(dl_url, io)
+    Curl::Easy.download(dl_url, io)
     assert io.closed?
     assert File.exist?(dl_path)
     assert_equal File.read(File.join(File.dirname(__FILE__), '..','ext','curb_easy.c')), File.read(dl_path)
@@ -49,7 +49,7 @@ class TestCurbCurlDownload < Test::Unit::TestCase
     # Download remote source
     begin
       reader.close
-      curb = Curl::Easy.download(dl_url, writer)
+      Curl::Easy.download(dl_url, writer)
       Process.wait
     ensure
       writer.close rescue IOError # if the stream has already been closed, which occurs in Easy::download