Class: Net::HTTP

# File 'lib/net/http.rb', line 661

def initialize(address, port = nil)
  @address = address
  @port    = (port || HTTP.default_port)
  @ipaddr = nil
  @local_host = nil
  @local_port = nil
  @curr_http_version = HTTPVersion
  @keep_alive_timeout = 2
  @last_communicated = nil
  @close_on_empty_response = false
  @socket  = nil
  @started = false
  @open_timeout = 60
  @read_timeout = 60
  @write_timeout = 60
  @continue_timeout = nil
  @max_retries = 1
  @debug_output = nil

  @proxy_from_env = false
  @proxy_uri      = nil
  @proxy_address  = nil
  @proxy_port     = nil
  @proxy_user     = nil
  @proxy_pass     = nil

  @use_ssl = false
  @ssl_context = nil
  @ssl_session = nil
  @sspi_enabled = false
  SSL_IVNAMES.each do |ivname|
    instance_variable_set ivname, nil
  end
end

# File 'lib/net/http.rb', line 420

alias is_version_1_2? version_1_2?   #:nodoc:

# File 'lib/net/http.rb', line 1094

attr_reader :proxy_address

# File 'lib/net/http.rb', line 1089

def proxy_class?
  defined?(@is_proxy_class) ? @is_proxy_class : false
end

# File 'lib/net/http.rb', line 1104

attr_reader :proxy_pass

# File 'lib/net/http.rb', line 1097

attr_reader :proxy_port

# File 'lib/net/http.rb', line 1100

attr_reader :proxy_user

# File 'lib/net/http.rb', line 414

def HTTP.version_1_1?  #:nodoc:
  false
end

# File 'lib/net/http.rb', line 404

def HTTP.version_1_2
  true
end

# File 'lib/net/http.rb', line 410

def HTTP.version_1_2?
  true
end

# File 'lib/net/http.rb', line 457

def HTTP.get(uri_or_host, path = nil, port = nil)
  get_response(uri_or_host, path, port).body
end

# File 'lib/net/http.rb', line 438

def HTTP.get_print(uri_or_host, path = nil, port = nil)
  get_response(uri_or_host, path, port) {|res|
    res.read_body do |chunk|
      $stdout.print chunk
    end
  }
  nil
end

# File 'lib/net/http.rb', line 473

def HTTP.get_response(uri_or_host, path = nil, port = nil, &block)
  if path
    host = uri_or_host
    new(host, port || HTTP.default_port).start {|http|
      return http.request_get(path, &block)
    }
  else
    uri = uri_or_host
    start(uri.hostname, uri.port,
          :use_ssl => uri.scheme == 'https') {|http|
      return http.request_get(uri, &block)
    }
  end
end

# File 'lib/net/http.rb', line 544

def HTTP.http_default_port
  80
end

# File 'lib/net/http.rb', line 549

def HTTP.https_default_port
  443
end

# File 'lib/net/http.rb', line 610

alias newobj new # :nodoc:

# File 'lib/net/http.rb', line 499

def HTTP.post(url, data, header = nil)
  start(url.hostname, url.port,
        :use_ssl => url.scheme == 'https' ) {|http|
    http.post(url, data, header)
  }
end

# File 'lib/net/http.rb', line 524

def HTTP.post_form(url, params)
  req = Post.new(url)
  req.form_data = params
  req.basic_auth url.user, url.password if url.user
  start(url.hostname, url.port,
        :use_ssl => url.scheme == 'https' ) {|http|
    http.request(req)
  }
end

# File 'lib/net/http.rb', line 1066

def HTTP.Proxy(p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil)
  return self unless p_addr

  Class.new(self) {
    @is_proxy_class = true

    if p_addr == :ENV then
      @proxy_from_env = true
      @proxy_address = nil
      @proxy_port    = nil
    else
      @proxy_from_env = false
      @proxy_address = p_addr
      @proxy_port    = p_port || default_port
    end

    @proxy_user = p_user
    @proxy_pass = p_pass
  }
end

# File 'lib/net/http.rb', line 553

def HTTP.socket_type   #:nodoc: obsolete
  BufferedIO
end

# File 'lib/net/http.rb', line 587

def HTTP.start(address, *arg, &block) # :yield: http
  arg.pop if opt = Hash.try_convert(arg[-1])
  port, p_addr, p_port, p_user, p_pass = *arg
  p_addr = :ENV if arg.size < 2
  port = https_default_port if !port && opt && opt[:use_ssl]
  http = new(address, port, p_addr, p_port, p_user, p_pass)
  http.ipaddr = opt[:ipaddr] if opt && opt[:ipaddr]

  if opt
    if opt[:use_ssl]
      opt = {verify_mode: OpenSSL::SSL::VERIFY_PEER}.update(opt)
    end
    http.methods.grep(/\A(\w+)=\z/) do |meth|
      key = $1.to_sym
      opt.key?(key) or next
      http.__send__(meth, opt[key])
    end
  end

  http.start(&block)
end

# File 'lib/net/http.rb', line 715

attr_reader :address

# File 'lib/net/http.rb', line 867

attr_accessor :ca_file

# File 'lib/net/http.rb', line 871

attr_accessor :ca_path

# File 'lib/net/http.rb', line 875

attr_accessor :cert

# File 'lib/net/http.rb', line 878

attr_accessor :cert_store

# File 'lib/net/http.rb', line 881

attr_accessor :ciphers

# File 'lib/net/http.rb', line 814

attr_accessor :close_on_empty_response

# File 'lib/net/http.rb', line 793

attr_reader :continue_timeout

# File 'lib/net/http.rb', line 796

def continue_timeout=(sec)
  @socket.continue_timeout = sec if @socket
  @continue_timeout = sec
end

# File 'lib/net/http.rb', line 733

def ipaddr
  started? ?  @socket.io.peeraddr[3] : @ipaddr
end

# File 'lib/net/http.rb', line 738

def ipaddr=(addr)
  raise IOError, "ipaddr value changed, but session already started" if started?
  @ipaddr = addr
end

# File 'lib/net/http.rb', line 805

attr_accessor :keep_alive_timeout

# File 'lib/net/http.rb', line 885

attr_accessor :key

# File 'lib/net/http.rb', line 721

attr_accessor :local_host

# File 'lib/net/http.rb', line 724

attr_accessor :local_port

# File 'lib/net/http.rb', line 776

attr_reader :max_retries

# File 'lib/net/http.rb', line 768

def max_retries=(retries)
  retries = retries.to_int
  if retries < 0
    raise ArgumentError, 'max_retries should be non-negative integer number'
  end
  @max_retries = retries
end

# File 'lib/net/http.rb', line 897

attr_accessor :max_version

# File 'lib/net/http.rb', line 894

attr_accessor :min_version

# File 'lib/net/http.rb', line 747

attr_accessor :open_timeout

# File 'lib/net/http.rb', line 718

attr_reader :port

# File 'lib/net/http.rb', line 1108

def proxy?
  !!(@proxy_from_env ? proxy_uri : @proxy_address)
end

# File 'lib/net/http.rb', line 1127

def proxy_address
  if @proxy_from_env then
    proxy_uri&.hostname
  else
    @proxy_address
  end
end

# File 'lib/net/http.rb', line 727

attr_writer :proxy_address

# File 'lib/net/http.rb', line 726

attr_writer :proxy_from_env

# File 'lib/net/http.rb', line 1113

def proxy_from_env?
  @proxy_from_env
end

# File 'lib/net/http.rb', line 1161

def proxy_pass
  if ENVIRONMENT_VARIABLE_IS_MULTIUSER_SAFE && @proxy_from_env
    proxy_uri&.password
  else
    @proxy_pass
  end
end

# File 'lib/net/http.rb', line 730

attr_writer :proxy_pass

# File 'lib/net/http.rb', line 1136

def proxy_port
  if @proxy_from_env then
    proxy_uri&.port
  else
    @proxy_port
  end
end

# File 'lib/net/http.rb', line 728

attr_writer :proxy_port

# File 'lib/net/http.rb', line 1152

def proxy_user
  if ENVIRONMENT_VARIABLE_IS_MULTIUSER_SAFE && @proxy_from_env
    proxy_uri&.user
  else
    @proxy_user
  end
end

# File 'lib/net/http.rb', line 729

attr_writer :proxy_user

# File 'lib/net/http.rb', line 1169

alias proxyaddr proxy_address   #:nodoc: obsolete

# File 'lib/net/http.rb', line 1170

alias proxyport proxy_port      #:nodoc: obsolete

# File 'lib/net/http.rb', line 753

attr_reader :read_timeout

# File 'lib/net/http.rb', line 779

def read_timeout=(sec)
  @socket.read_timeout = sec if @socket
  @read_timeout = sec
end

# File 'lib/net/http.rb', line 888

attr_accessor :ssl_timeout

# File 'lib/net/http.rb', line 891

attr_accessor :ssl_version

# File 'lib/net/http.rb', line 808

def started?
  @started
end

# File 'lib/net/http.rb', line 825

def use_ssl=(flag)
  flag = flag ? true : false
  if started? and @use_ssl != flag
    raise IOError, "use_ssl value changed, but session already started"
  end
  @use_ssl = flag
end

# File 'lib/net/http.rb', line 817

def use_ssl?
  @use_ssl
end

# File 'lib/net/http.rb', line 900

attr_accessor :verify_callback

# File 'lib/net/http.rb', line 903

attr_accessor :verify_depth

# File 'lib/net/http.rb', line 909

attr_accessor :verify_mode

# File 'lib/net/http.rb', line 760

attr_reader :write_timeout

# File 'lib/net/http.rb', line 785

def write_timeout=(sec)
  @socket.write_timeout = sec if @socket
  @write_timeout = sec
end

# File 'lib/net/http.rb', line 1565

def begin_transport(req)
  if @socket.closed?
    connect
  elsif @last_communicated
    if @last_communicated + @keep_alive_timeout < Process.clock_gettime(Process::CLOCK_MONOTONIC)
      D 'Conn close because of keep_alive_timeout'
      @socket.close
      connect
    elsif @socket.io.to_io.wait_readable(0) && @socket.eof?
      D "Conn close because of EOF"
      @socket.close
      connect
    end
  end

  if not req.response_body_permitted? and @close_on_empty_response
    req['connection'] ||= 'close'
  end

  req.update_uri address, port, use_ssl?
  req['host'] ||= addr_port()
end

# File 'lib/net/http.rb', line 1176

def conn_address # :nodoc:
  @ipaddr || address()
end

# File 'lib/net/http.rb', line 1180

def conn_port # :nodoc:
  port()
end

# File 'lib/net/http.rb', line 948

def connect
  if proxy? then
    conn_addr = proxy_address
    conn_port = proxy_port
  else
    conn_addr = conn_address
    conn_port = port
  end

  D "opening connection to #{conn_addr}:#{conn_port}..."
  s = Timeout.timeout(@open_timeout, Net::OpenTimeout) {
    begin
      TCPSocket.open(conn_addr, conn_port, @local_host, @local_port)
    rescue => e
      raise e, "Failed to open TCP connection to " +
        "#{conn_addr}:#{conn_port} (#{e.message})"
    end
  }
  s.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
  D "opened"
  if use_ssl?
    if proxy?
      plain_sock = BufferedIO.new(s, read_timeout: @read_timeout,
                                  write_timeout: @write_timeout,
                                  continue_timeout: @continue_timeout,
                                  debug_output: @debug_output)
      buf = "CONNECT #{conn_address}:#{@port} HTTP/#{HTTPVersion}\r\n"
      buf << "Host: #{@address}:#{@port}\r\n"
      if proxy_user
        credential = ["#{proxy_user}:#{proxy_pass}"].pack('m0')
        buf << "Proxy-Authorization: Basic #{credential}\r\n"
      end
      buf << "\r\n"
      plain_sock.write(buf)
      HTTPResponse.read_new(plain_sock).value
      # assuming nothing left in buffers after successful CONNECT response
    end

    ssl_parameters = Hash.new
    iv_list = instance_variables
    SSL_IVNAMES.each_with_index do |ivname, i|
      if iv_list.include?(ivname) and
        value = instance_variable_get(ivname)
        ssl_parameters[SSL_ATTRIBUTES[i]] = value if value
      end
    end
    @ssl_context = OpenSSL::SSL::SSLContext.new
    @ssl_context.set_params(ssl_parameters)
    @ssl_context.session_cache_mode =
      OpenSSL::SSL::SSLContext::SESSION_CACHE_CLIENT |
      OpenSSL::SSL::SSLContext::SESSION_CACHE_NO_INTERNAL_STORE
    @ssl_context.session_new_cb = proc {|sock, sess| @ssl_session = sess }
    D "starting SSL for #{conn_addr}:#{conn_port}..."
    s = OpenSSL::SSL::SSLSocket.new(s, @ssl_context)
    s.sync_close = true
    # Server Name Indication (SNI) RFC 3546
    s.hostname = @address if s.respond_to? :hostname=
    if @ssl_session and
       Process.clock_gettime(Process::CLOCK_REALTIME) < @ssl_session.time.to_f + @ssl_session.timeout
      s.session = @ssl_session
    end
    ssl_socket_connect(s, @open_timeout)
    if @ssl_context.verify_mode != OpenSSL::SSL::VERIFY_NONE
      s.post_connection_check(@address)
    end
    D "SSL established, protocol: #{s.ssl_version}, cipher: #{s.cipher[0]}"
  end
  @socket = BufferedIO.new(s, read_timeout: @read_timeout,
                           write_timeout: @write_timeout,
                           continue_timeout: @continue_timeout,
                           debug_output: @debug_output)
  on_connect
rescue => exception
  if s
    D "Conn close because of connect error #{exception}"
    s.close
  end
  raise
end

# File 'lib/net/http.rb', line 1351

def copy(path, initheader = nil)
  request(Copy.new(path, initheader))
end

# File 'lib/net/http.rb', line 1655

def D(msg)
  return unless @debug_output
  @debug_output << msg
  @debug_output << "\n"
end

# File 'lib/net/http.rb', line 1339

def delete(path, initheader = {'Depth' => 'Infinity'})
  request(Delete.new(path, initheader))
end

# File 'lib/net/http.rb', line 1040

def do_finish
  @started = false
  @socket.close if @socket
  @socket = nil
end

# File 'lib/net/http.rb', line 942

def do_start
  connect
  @started = true
end

# File 'lib/net/http.rb', line 1184

def edit_path(path)
  if proxy?
    if path.start_with?("ftp://") || use_ssl?
      path
    else
      "http://#{addr_port}#{path}"
    end
  else
    path
  end
end

# File 'lib/net/http.rb', line 1588

def end_transport(req, res)
  @curr_http_version = res.http_version
  @last_communicated = nil
  if @socket.closed?
    D 'Conn socket closed'
  elsif not res.body and @close_on_empty_response
    D 'Conn close'
    @socket.close
  elsif keep_alive?(req, res)
    D 'Conn keep-alive'
    @last_communicated = Process.clock_gettime(Process::CLOCK_MONOTONIC)
  else
    D 'Conn close'
    @socket.close
  end
end

# File 'lib/net/http.rb', line 1035

def finish
  raise IOError, 'HTTP session not yet started' unless started?
  do_finish
end

# File 'lib/net/http.rb', line 1239

def get(path, initheader = nil, dest = nil, &block) # :yield: body_segment
  res = nil
  request(Get.new(path, initheader)) {|r|
    r.read_body dest, &block
    res = r
  }
  res
end

# File 'lib/net/http.rb', line 1444

alias get2   request_get    #:nodoc: obsolete

# File 'lib/net/http.rb', line 1261

def head(path, initheader = nil)
  request(Head.new(path, initheader))
end

# File 'lib/net/http.rb', line 1445

alias head2  request_head   #:nodoc: obsolete

# File 'lib/net/http.rb', line 696

def inspect
  "#<#{self.class} #{@address}:#{@port} open=#{started?}>"
end

# File 'lib/net/http.rb', line 1605

def keep_alive?(req, res)
  return false if req.connection_close?
  if @curr_http_version <= '1.0'
    res.connection_keep_alive?
  else   # HTTP/1.1 or later
    not res.connection_close?
  end
end

# File 'lib/net/http.rb', line 1315

def lock(path, body, initheader = nil)
  request(Lock.new(path, initheader), body)
end

# File 'lib/net/http.rb', line 1357

def mkcol(path, body = nil, initheader = nil)
  request(Mkcol.new(path, initheader), body)
end

# File 'lib/net/http.rb', line 1345

def move(path, initheader = nil)
  request(Move.new(path, initheader))
end

# File 'lib/net/http.rb', line 1029

def on_connect
end

# File 'lib/net/http.rb', line 1327

def options(path, initheader = nil)
  request(Options.new(path, initheader))
end

# File 'lib/net/http.rb', line 1299

def patch(path, data, initheader = nil, dest = nil, &block) # :yield: body_segment
  send_entity(path, data, initheader, dest, Patch, &block)
end

# File 'lib/net/http.rb', line 912

def peer_cert
  if not use_ssl? or not @socket
    return nil
  end
  @socket.io.peer_cert
end

# File 'lib/net/http.rb', line 1293

def post(path, data, initheader = nil, dest = nil, &block) # :yield: body_segment
  send_entity(path, data, initheader, dest, Post, &block)
end

# File 'lib/net/http.rb', line 1446

alias post2  request_post   #:nodoc: obsolete

# File 'lib/net/http.rb', line 1333

def propfind(path, body = nil, initheader = {'Depth' => '0'})
  request(Propfind.new(path, initheader), body)
end

# File 'lib/net/http.rb', line 1309

def proppatch(path, body, initheader = nil)
  request(Proppatch.new(path, initheader), body)
end

# File 'lib/net/http.rb', line 1118

def proxy_uri # :nodoc:
  return if @proxy_uri == false
  @proxy_uri ||= URI::HTTP.new(
    "http".freeze, nil, address, port, nil, nil, nil, nil, nil
  ).find_proxy || false
  @proxy_uri || nil
end

# File 'lib/net/http.rb', line 1303

def put(path, data, initheader = nil)   #:nodoc:
  request(Put.new(path, initheader), data)
end

# File 'lib/net/http.rb', line 1447

alias put2   request_put    #:nodoc: obsolete

# File 'lib/net/http.rb', line 1481

def request(req, body = nil, &block)  # :yield: response
  unless started?
    start {
      req['connection'] ||= 'close'
      return request(req, body, &block)
    }
  end
  if proxy_user()
    req.proxy_basic_auth proxy_user(), proxy_pass() unless use_ssl?
  end
  req.set_body_internal body
  res = transport_request(req, &block)
  if sspi_auth?(res)
    sspi_auth(req)
    res = transport_request(req, &block)
  end
  res
end

# File 'lib/net/http.rb', line 1392

def request_get(path, initheader = nil, &block) # :yield: response
  request(Get.new(path, initheader), &block)
end

# File 'lib/net/http.rb', line 1406

def request_head(path, initheader = nil, &block)
  request(Head.new(path, initheader), &block)
end

# File 'lib/net/http.rb', line 1436

def request_post(path, data, initheader = nil, &block) # :yield: response
  request Post.new(path, initheader), data, &block
end

# File 'lib/net/http.rb', line 1440

def request_put(path, data, initheader = nil, &block)   #:nodoc:
  request Put.new(path, initheader), data, &block
end

# File 'lib/net/http.rb', line 1504

def send_entity(path, data, initheader, dest, type, &block)
  res = nil
  request(type.new(path, initheader), data) {|r|
    r.read_body dest, &block
    res = r
  }
  res
end

# File 'lib/net/http.rb', line 1460

def send_request(name, path, data = nil, header = nil)
  has_response_body = name != 'HEAD'
  r = HTTPGenericRequest.new(name,(data ? true : false),has_response_body,path,header)
  request r, data
end

# File 'lib/net/http.rb', line 709

def set_debug_output(output)
  warn 'Net::HTTP#set_debug_output called after HTTP started', uplevel: 1 if started?
  @debug_output = output
end

# File 'lib/net/http.rb', line 1629

def sspi_auth(req)
  n = Win32::SSPI::NegotiateAuth.new
  req["Proxy-Authorization"] = "Negotiate #{n.get_initial_token}"
  # Some versions of ISA will close the connection if this isn't present.
  req["Connection"] = "Keep-Alive"
  req["Proxy-Connection"] = "Keep-Alive"
  res = transport_request(req)
  authphrase = res["Proxy-Authenticate"]  or return res
  req["Proxy-Authorization"] = "Negotiate #{n.complete_authentication(authphrase)}"
rescue => err
  raise HTTPAuthenticationError.new('HTTP authentication failed', err)
end

# File 'lib/net/http.rb', line 1614

def sspi_auth?(res)
  return false unless @sspi_enabled
  if res.kind_of?(HTTPProxyAuthenticationRequired) and
      proxy? and res["Proxy-Authenticate"].include?("Negotiate")
    begin
      require 'win32/sspi'
      true
    rescue LoadError
      false
    end
  else
    false
  end
end

# File 'lib/net/http.rb', line 928

def start  # :yield: http
  raise IOError, 'HTTP session already opened' if @started
  if block_given?
    begin
      do_start
      return yield(self)
    ensure
      do_finish
    end
  end
  do_start
  self
end

# File 'lib/net/http.rb', line 1363

def trace(path, initheader = nil)
  request(Trace.new(path, initheader))
end

# File 'lib/net/http.rb', line 1515

def transport_request(req)
  count = 0
  begin
    begin_transport req
    res = catch(:response) {
      begin
        req.exec @socket, @curr_http_version, edit_path(req.path)
      rescue Errno::EPIPE
        # Failure when writing full request, but we can probably
        # still read the received response.
      end

      begin
        res = HTTPResponse.read_new(@socket)
        res.decode_content = req.decode_content
      end while res.kind_of?(HTTPInformation)

      res.uri = req.uri

      res
    }
    res.reading_body(@socket, req.response_body_permitted?) {
      yield res if block_given?
    }
  rescue Net::OpenTimeout
    raise
  rescue Net::ReadTimeout, IOError, EOFError,
         Errno::ECONNRESET, Errno::ECONNABORTED, Errno::EPIPE, Errno::ETIMEDOUT,
         # avoid a dependency on OpenSSL
         defined?(OpenSSL::SSL) ? OpenSSL::SSL::SSLError : IOError,
         Timeout::Error => exception
    if count < max_retries && IDEMPOTENT_METHODS_.include?(req.method)
      count += 1
      @socket.close if @socket
      D "Conn close because of error #{exception}, and retry"
      retry
    end
    D "Conn close because of error #{exception}"
    @socket.close if @socket
    raise
  end

  end_transport req, res
  res
rescue => exception
  D "Conn close because of error #{exception}"
  @socket.close if @socket
  raise exception
end

# File 'lib/net/http.rb', line 1321

def unlock(path, body, initheader = nil)
  request(Unlock.new(path, initheader), body)
end