scnr-ethon 0.15.0

data/lib/ethon/curls/classes.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+module Ethon
+  module Curl
+    # :nodoc:
+    class MsgData < ::FFI::Union
+      layout :whatever, :pointer, :code, :easy_code
+    end
+
+    # :nodoc:
+    class Msg < ::FFI::Struct
+      layout :code, :msg_code, :easy_handle, :pointer, :data, MsgData
+    end
+
+    class VersionInfoData < ::FFI::Struct
+      layout :curl_version, :uint8,
+        :version, :string,
+        :version_num, :int,
+        :host, :string,
+        :features, :int,
+        :ssl_version, :string,
+        :ssl_version_num, :long,
+        :libz_version, :string,
+        :protocols, :pointer
+    end
+
+    # :nodoc:
+    class FDSet < ::FFI::Struct
+      if Curl.windows?
+        layout :fd_count, :uint,
+               # TODO: Make it future proof by dynamically grabbing FD_SETSIZE.
+               :fd_array, [:uint, 2048]
+
+        def clear; self[:fd_count] = 0; end
+      else
+        # https://github.com/typhoeus/ethon/issues/182
+        FD_SETSIZE = begin
+          # Allow to override the (new) default cap
+          if ENV['ETHON_FD_SIZE']
+            ENV['ETHON_FD_SIZE']
+
+          # auto-detect ulimit, but cap at 2^16
+          else
+            [::Ethon::Libc.getdtablesize, 65_536].min
+          end
+        end
+
+        layout :fds_bits, [:long, FD_SETSIZE / ::FFI::Type::LONG.size]
+
+        # :nodoc:
+        def clear; super; end
+      end
+    end
+
+    # :nodoc:
+    class Timeval < ::FFI::Struct
+      if Curl.windows?
+        layout :sec, :long,
+               :usec, :long
+      else
+        layout :sec, :time_t,
+               :usec, :suseconds_t
+      end
+    end
+  end
+end

data/lib/ethon/curls/codes.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+module Ethon
+  module Curls # :nodoc:
+
+    # This module contains all easy and
+    # multi return codes.
+    module Codes
+
+      # Libcurl error codes, refer
+      # https://github.com/bagder/curl/blob/master/include/curl/curl.h for details
+      def easy_codes
+        [
+          :ok,
+          :unsupported_protocol,
+          :failed_init,
+          :url_malformat,
+          :not_built_in,
+          :couldnt_resolve_proxy,
+          :couldnt_resolve_host,
+          :couldnt_connect,
+          :ftp_weird_server_reply,
+          :remote_access_denied,
+          :ftp_accept_failed,
+          :ftp_weird_pass_reply,
+          :ftp_accept_timeout,
+          :ftp_weird_pasv_reply,
+          :ftp_weird_227_format,
+          :ftp_cant_get_host,
+          :obsolete16,
+          :ftp_couldnt_set_type,
+          :partial_file,
+          :ftp_couldnt_retr_file,
+          :obsolete20,
+          :quote_error,
+          :http_returned_error,
+          :write_error,
+          :obsolete24,
+          :upload_failed,
+          :read_error,
+          :out_of_memory,
+          :operation_timedout,
+          :obsolete29,
+          :ftp_port_failed,
+          :ftp_couldnt_use_rest,
+          :obsolete32,
+          :range_error,
+          :http_post_error,
+          :ssl_connect_error,
+          :bad_download_resume,
+          :file_couldnt_read_file,
+          :ldap_cannot_bind,
+          :ldap_search_failed,
+          :obsolete40,
+          :function_not_found,
+          :aborted_by_callback,
+          :bad_function_argument,
+          :obsolete44,
+          :interface_failed,
+          :obsolete46,
+          :too_many_redirects ,
+          :unknown_option,
+          :telnet_option_syntax ,
+          :obsolete50,
+          :peer_failed_verification,
+          :got_nothing,
+          :ssl_engine_notfound,
+          :ssl_engine_setfailed,
+          :send_error,
+          :recv_error,
+          :obsolete57,
+          :ssl_certproblem,
+          :ssl_cipher,
+          :bad_content_encoding,
+          :ldap_invalid_url,
+          :filesize_exceeded,
+          :use_ssl_failed,
+          :send_fail_rewind,
+          :ssl_engine_initfailed,
+          :login_denied,
+          :tftp_notfound,
+          :tftp_perm,
+          :remote_disk_full,
+          :tftp_illegal,
+          :tftp_unknownid,
+          :remote_file_exists,
+          :tftp_nosuchuser,
+          :conv_failed,
+          :conv_reqd,
+          :ssl_cacert_badfile,
+          :remote_file_not_found,
+          :ssh,
+          :ssl_shutdown_failed,
+          :again,
+          :ssl_crl_badfile,
+          :ssl_issuer_error,
+          :ftp_pret_failed,
+          :rtsp_cseq_error,
+          :rtsp_session_error,
+          :ftp_bad_file_list,
+          :chunk_failed,
+          :last
+        ]
+      end
+
+      # Curl-Multi socket error codes, refer
+      # https://github.com/bagder/curl/blob/master/include/curl/multi.h for details
+      def multi_codes
+        [
+          :call_multi_perform, -1,
+          :ok,
+          :bad_handle,
+          :bad_easy_handle,
+          :out_of_memory,
+          :internal_error,
+          :bad_socket,
+          :unknown_option,
+          :last
+        ]
+      end
+    end
+  end
+end

data/lib/ethon/curls/constants.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+module Ethon
+  module Curl
+    # :nodoc:
+    VERSION_NOW = 3
+
+    # Flag. Initialize SSL.
+    GLOBAL_SSL     = 0x01
+    # Flag. Initialize win32 socket libraries.
+    GLOBAL_WIN32   = 0x02
+    # Flag. Initialize everything possible.
+    GLOBAL_ALL     = (GLOBAL_SSL | GLOBAL_WIN32)
+    # Flag. Initialize everything by default.
+    GLOBAL_DEFAULT = GLOBAL_ALL
+
+    # :nodoc:
+    EasyCode = enum(:easy_code, easy_codes)
+    # :nodoc:
+    MultiCode = enum(:multi_code, multi_codes)
+
+    # :nodoc:
+    EasyOption = enum(:easy_option, easy_options(:enum).to_a.flatten)
+    # :nodoc:
+    MultiOption = enum(:multi_option, multi_options(:enum).to_a.flatten)
+
+    # Used by curl_debug_callback when setting CURLOPT_DEBUGFUNCTION
+    # https://github.com/bagder/curl/blob/master/include/curl/curl.h#L378 for details
+    DebugInfoType = enum(:debug_info_type, debug_info_types)
+
+    # :nodoc:
+    InfoType = enum(info_types.to_a.flatten)
+
+    # Info details, refer
+    # https://github.com/bagder/curl/blob/master/src/tool_writeout.c#L66 for details
+    Info = enum(:info, infos.to_a.flatten)
+
+    # Form options, used by FormAdd for temporary storage, refer
+    # https://github.com/bagder/curl/blob/master/lib/formdata.h#L51 for details
+    FormOption = enum(:form_option, form_options)
+
+    # :nodoc:
+    MsgCode = enum(:msg_code, msg_codes)
+
+    VERSION_IPV6 = (1<<0)  # IPv6-enabled
+    VERSION_KERBEROS4 = (1<<1)  # kerberos auth is supported
+    VERSION_SSL = (1<<2)  # SSL options are present
+    VERSION_LIBZ = (1<<3)  # libz features are present
+    VERSION_NTLM = (1<<4)  # NTLM auth is supported
+    VERSION_GSSNEGOTIATE = (1<<5) # Negotiate auth supp
+    VERSION_DEBUG = (1<<6)  # built with debug capabilities
+    VERSION_ASYNCHDNS = (1<<7)  # asynchronous dns resolves
+    VERSION_SPNEGO = (1<<8)  # SPNEGO auth is supported
+    VERSION_LARGEFILE = (1<<9)  # supports files bigger than 2GB
+    VERSION_IDN = (1<<10) # International Domain Names support
+    VERSION_SSPI = (1<<11) # SSPI is supported
+    VERSION_CONV = (1<<12) # character conversions supported
+    VERSION_CURLDEBUG = (1<<13) # debug memory tracking supported
+    VERSION_TLSAUTH_SRP = (1<<14) # TLS-SRP auth is supported
+    VERSION_NTLM_WB = (1<<15) # NTLM delegating to winbind helper
+    VERSION_HTTP2 = (1<<16) # HTTP2 support built
+    VERSION_GSSAPI = (1<<17) # GSS-API is supported
+
+    SOCKET_BAD = -1
+    SOCKET_TIMEOUT = SOCKET_BAD
+
+    PollAction = enum(:poll_action, [
+      :none,
+      :in,
+      :out,
+      :inout,
+      :remove
+    ])
+
+    SocketReadiness = bitmask(:socket_readiness, [
+      :in,  # CURL_CSELECT_IN  - 0x01 (bit 0)
+      :out, # CURL_CSELECT_OUT - 0x02 (bit 1)
+      :err, # CURL_CSELECT_ERR - 0x04 (bit 2)
+    ])
+  end
+end

data/lib/ethon/curls/form_options.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+module Ethon
+  module Curls
+
+    # This module contains the available options for forms.
+    module FormOptions
+
+      # Form options, used by FormAdd for temporary storage, refer
+      # https://github.com/bagder/curl/blob/master/lib/formdata.h#L51 for details
+      def form_options
+        [
+          :none,
+          :copyname,
+          :ptrname,
+          :namelength,
+          :copycontents,
+          :ptrcontents,
+          :contentslength,
+          :filecontent,
+          :array,
+          :obsolete,
+          :file,
+          :buffer,
+          :bufferptr,
+          :bufferlength,
+          :contenttype,
+          :contentheader,
+          :filename,
+          :end,
+          :obsolete2,
+          :stream,
+          :last
+        ]
+      end
+    end
+  end
+end

data/lib/ethon/curls/functions.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+module Ethon
+  module Curls
+
+    # This module contains the functions to be attached in order to work with
+    # libcurl.
+    module Functions
+
+      # :nodoc:
+      def self.extended(base)
+        base.attach_function :global_init,                :curl_global_init,         [:long],                        :int
+        base.attach_function :global_cleanup,             :curl_global_cleanup,      [],                             :void
+        base.attach_function :free,                       :curl_free,                [:pointer],                     :void
+
+        base.attach_function :easy_init,                  :curl_easy_init,           [],                             :pointer
+        base.attach_function :easy_cleanup,               :curl_easy_cleanup,        [:pointer],                     :void
+        base.attach_function :easy_getinfo,               :curl_easy_getinfo,        [:pointer, :info, :varargs],    :easy_code
+        base.attach_function :easy_setopt,                :curl_easy_setopt,         [:pointer, :easy_option, :varargs], :easy_code
+        base.instance_variable_set(:@blocking, true)
+        base.attach_function :easy_perform,               :curl_easy_perform,        [:pointer],                     :easy_code
+        base.attach_function :easy_strerror,              :curl_easy_strerror,       [:easy_code],                   :string
+        base.attach_function :easy_escape,                :curl_easy_escape,         [:pointer, :pointer, :int],     :pointer
+        base.attach_function :easy_reset,                 :curl_easy_reset,          [:pointer],                     :void
+        base.attach_function :easy_duphandle,             :curl_easy_duphandle,      [:pointer],                     :pointer
+
+        base.attach_function :formadd,                    :curl_formadd,             [:pointer, :pointer, :varargs], :int
+        base.attach_function :formfree,                   :curl_formfree,            [:pointer],                     :void
+
+        base.attach_function :multi_init,                 :curl_multi_init,          [],                             :pointer
+        base.attach_function :multi_cleanup,              :curl_multi_cleanup,       [:pointer],                     :void
+        base.attach_function :multi_add_handle,           :curl_multi_add_handle,    [:pointer, :pointer],           :multi_code
+        base.attach_function :multi_remove_handle,        :curl_multi_remove_handle, [:pointer, :pointer],           :multi_code
+        base.attach_function :multi_info_read,            :curl_multi_info_read,     [:pointer, :pointer],           Curl::Msg.ptr
+        base.attach_function :multi_perform,              :curl_multi_perform,       [:pointer, :pointer],           :multi_code
+        base.attach_function :multi_timeout,              :curl_multi_timeout,       [:pointer, :pointer],           :multi_code
+        base.attach_function :multi_fdset,                :curl_multi_fdset,         [:pointer, Curl::FDSet.ptr, Curl::FDSet.ptr, Curl::FDSet.ptr, :pointer], :multi_code
+        base.attach_function :multi_strerror,             :curl_multi_strerror,      [:int],                         :string
+        base.attach_function :multi_setopt,               :curl_multi_setopt,        [:pointer, :multi_option, :varargs], :multi_code
+        base.attach_function :multi_socket_action,        :curl_multi_socket_action, [:pointer, :int, :socket_readiness, :pointer], :multi_code
+
+        base.attach_function :version,                    :curl_version,             [],                             :string
+        base.attach_function :version_info,               :curl_version_info,        [],                             Curl::VersionInfoData.ptr
+
+        base.attach_function :slist_append,               :curl_slist_append,        [:pointer, :string],            :pointer
+        base.attach_function :slist_free_all,             :curl_slist_free_all,      [:pointer],                     :void
+        base.instance_variable_set(:@blocking, true)
+
+        if Curl.windows?
+            base.ffi_lib 'ws2_32'
+        else
+            base.ffi_lib ::FFI::Library::LIBC
+        end
+
+        base.attach_function :select,                                            [:int, Curl::FDSet.ptr, Curl::FDSet.ptr, Curl::FDSet.ptr, Curl::Timeval.ptr], :int
+      end
+    end
+  end
+end

data/lib/ethon/curls/infos.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+module Ethon
+  module Curls
+
+    # This module contains logic for the available informations
+    # on an easy, eg.: connect_time.
+    module Infos
+
+      # Return info types.
+      #
+      # @example Return info types.
+      #   Ethon::Curl.info_types
+      #
+      # @return [ Hash ] The info types.
+      def info_types
+        {
+          :string =>0x100000,
+          :long =>  0x200000,
+          :double =>0x300000,
+          :slist => 0x400000
+        }
+      end
+
+      # http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTDEBUGFUNCTION
+      # https://github.com/bagder/curl/blob/master/include/curl/curl.h#L378
+      #
+      # @example Return debug info types.
+      #   Ethon::Curl.debug_info_types
+      #
+      # @return [ Hash ] The info types available to curl_debug_callback.
+      def debug_info_types
+        [
+          :text, 0,
+          :header_in,
+          :header_out,
+          :data_in,
+          :data_out,
+          :ssl_data_in,
+          :ssl_data_out
+        ]
+      end
+
+      # Return Info details, refer
+      # https://github.com/bagder/curl/blob/master/src/tool_writeout.c#L66 for details
+      #
+      # @example Return infos.
+      #   Ethon::Curl.infos
+      #
+      # @return [ Hash ] The infos.
+      def infos
+        {
+          :effective_url =>          info_types[:string] + 1,
+          :response_code =>          info_types[:long]   + 2,
+          :total_time =>             info_types[:double] + 3,
+          :namelookup_time =>        info_types[:double] + 4,
+          :connect_time =>           info_types[:double] + 5,
+          :pretransfer_time =>       info_types[:double] + 6,
+          :size_upload =>            info_types[:double] + 7,
+          :size_download =>          info_types[:double] + 8,
+          :speed_download =>         info_types[:double] + 9,
+          :speed_upload =>           info_types[:double] + 10,
+          :header_size =>            info_types[:long]   + 11,
+          :request_size =>           info_types[:long]   + 12,
+          :ssl_verifyresult =>       info_types[:long]   + 13,
+          :filetime =>               info_types[:long]   + 14,
+          :content_length_download =>info_types[:double] + 15,
+          :content_length_upload =>  info_types[:double] + 16,
+          :starttransfer_time =>     info_types[:double] + 17,
+          :content_type =>           info_types[:string] + 18,
+          :redirect_time =>          info_types[:double] + 19,
+          :redirect_count =>         info_types[:long]   + 20,
+          :private =>                info_types[:string] + 21,
+          :http_connectcode =>       info_types[:long]   + 22,
+          :httpauth_avail =>         info_types[:long]   + 23,
+          :proxyauth_avail =>        info_types[:long]   + 24,
+          :os_errno =>               info_types[:long]   + 25,
+          :num_connects =>           info_types[:long]   + 26,
+          :ssl_engines =>            info_types[:slist]  + 27,
+          :cookielist =>             info_types[:slist]  + 28,
+          :lastsocket =>             info_types[:long]   + 29,
+          :ftp_entry_path =>         info_types[:string] + 30,
+          :redirect_url =>           info_types[:string] + 31,
+          :primary_ip =>             info_types[:string] + 32,
+          :appconnect_time =>        info_types[:double] + 33,
+          :certinfo =>               info_types[:slist]  + 34,
+          :condition_unmet =>        info_types[:long]   + 35,
+          :rtsp_session_id =>        info_types[:string] + 36,
+          :rtsp_client_cseq =>       info_types[:long]   + 37,
+          :rtsp_server_cseq =>       info_types[:long]   + 38,
+          :rtsp_cseq_recv =>         info_types[:long]   + 39,
+          :primary_port =>           info_types[:long]   + 40,
+          :local_ip =>               info_types[:string] + 41,
+          :local_port =>             info_types[:long]   + 42,
+          :last =>42
+        }
+      end
+
+      # Return info as string.
+      #
+      # @example Return info.
+      #   Curl.get_info_string(:primary_ip, easy)
+      #
+      # @param [ Symbol ] option The option name.
+      # @param [ ::FFI::Pointer ] handle The easy handle.
+      #
+      # @return [ String ] The info.
+      def get_info_string(option, handle)
+        string_ptr = ::FFI::MemoryPointer.new(:pointer)
+
+        if easy_getinfo(handle, option, :pointer, string_ptr) == :ok
+          ptr=string_ptr.read_pointer
+          ptr.null? ? nil : ptr.read_string
+        end
+      end
+
+      # Return info as integer.
+      #
+      # @example Return info.
+      #   Curl.get_info_long(:response_code, easy)
+      #
+      # @param [ Symbol ] option The option name.
+      # @param [ ::FFI::Pointer ] handle The easy handle.
+      #
+      # @return [ Integer ] The info.
+      def get_info_long(option, handle)
+        long_ptr = ::FFI::MemoryPointer.new(:long)
+
+        if easy_getinfo(handle, option, :pointer, long_ptr) == :ok
+          long_ptr.read_long
+        end
+      end
+
+      # Return info as float
+      #
+      # @example Return info.
+      #   Curl.get_info_double(:response_code, easy)
+      #
+      # @param [ Symbol ] option The option name.
+      # @param [ ::FFI::Pointer ] handle The easy handle.
+      #
+      # @return [ Float ] The info.
+      def get_info_double(option, handle)
+        double_ptr = ::FFI::MemoryPointer.new(:double)
+
+        if easy_getinfo(handle, option, :pointer, double_ptr) == :ok
+          double_ptr.read_double
+        end
+      end
+    end
+  end
+end

data/lib/ethon/curls/messages.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module Ethon
+  module Curls
+
+    # This module contains available message codes.
+    module Messages
+
+      # Return message codes.
+      #
+      # @example Return message codes.
+      #   Ethon::Curl.msg_codes
+      #
+      # @return [ Array ] The messages codes.
+      def msg_codes
+        [:none, :done, :last]
+      end
+    end
+  end
+end