Class: HTTPClient::Session

Inherits:
Object
  • Object
show all
Includes:
Timeout, Util
Defined in:
lib/httpclient.rb,
lib/httpclient/session.rb

Overview

Manages a HTTP session with a Site.

Direct Known Subclasses

HTTPAccess2::Session

Defined Under Namespace

Classes: LenientInflater

Constant Summary collapse

BadResponse =
::HTTPClient::BadResponseError

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Util

#argument_to_hash, hash_find_value, #http?, #https?, #keyword_argument, try_require, uri_dirname, uri_part_of, urify, #warning

Methods included from Timeout

#timeout

Constructor Details

#initialize(client, dest, agent_name, from) ⇒ Session

Returns a new instance of Session.


468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
# File 'lib/httpclient/session.rb', line 468

def initialize(client, dest, agent_name, from)
  @client = client
  @dest = dest
  @proxy = nil
  @socket_sync = true
  @tcp_keepalive = false
  @requested_version = nil

  @debug_dev = nil

  @connect_timeout = nil
  @connect_retry = 1
  @send_timeout = nil
  @receive_timeout = nil
  @read_block_size = nil
  @protocol_retry_count = 5

  @ssl_config = nil
  @ssl_peer_cert = nil

  @test_loopback_http_response = nil
  @strict_response_size_check = false
  @socket_local = Site::EMPTY

  @agent_name = agent_name
  @from = from
  @state = :INIT

  @requests = []

  @status = nil
  @reason = nil
  @headers = []

  @socket = nil
  @readbuf = nil

  @transparent_gzip_decompression = false
  @last_used = nil
end

Instance Attribute Details

#connect_retryObject

Returns the value of attribute connect_retry


452
453
454
# File 'lib/httpclient/session.rb', line 452

def connect_retry
  @connect_retry
end

#connect_timeoutObject

Returns the value of attribute connect_timeout


451
452
453
# File 'lib/httpclient/session.rb', line 451

def connect_timeout
  @connect_timeout
end

#debug_devObject

Device for dumping log for debugging


449
450
451
# File 'lib/httpclient/session.rb', line 449

def debug_dev
  @debug_dev
end

#destObject (readonly)

Destination site


439
440
441
# File 'lib/httpclient/session.rb', line 439

def dest
  @dest
end

#last_usedObject (readonly)

Returns the value of attribute last_used


466
467
468
# File 'lib/httpclient/session.rb', line 466

def last_used
  @last_used
end

#protocol_retry_countObject

Returns the value of attribute protocol_retry_count


456
457
458
# File 'lib/httpclient/session.rb', line 456

def protocol_retry_count
  @protocol_retry_count
end

#proxyObject

Proxy site


441
442
443
# File 'lib/httpclient/session.rb', line 441

def proxy
  @proxy
end

#read_block_sizeObject

Returns the value of attribute read_block_size


455
456
457
# File 'lib/httpclient/session.rb', line 455

def read_block_size
  @read_block_size
end

#receive_timeoutObject

Returns the value of attribute receive_timeout


454
455
456
# File 'lib/httpclient/session.rb', line 454

def receive_timeout
  @receive_timeout
end

#requested_versionObject

Requested protocol version


447
448
449
# File 'lib/httpclient/session.rb', line 447

def requested_version
  @requested_version
end

#send_timeoutObject

Returns the value of attribute send_timeout


453
454
455
# File 'lib/httpclient/session.rb', line 453

def send_timeout
  @send_timeout
end

#socket_localObject

Returns the value of attribute socket_local


459
460
461
# File 'lib/httpclient/session.rb', line 459

def socket_local
  @socket_local
end

#socket_syncObject

Boolean value for Socket#sync


443
444
445
# File 'lib/httpclient/session.rb', line 443

def socket_sync
  @socket_sync
end

#ssl_configObject

Returns the value of attribute ssl_config


461
462
463
# File 'lib/httpclient/session.rb', line 461

def ssl_config
  @ssl_config
end

#ssl_peer_certObject (readonly)

Returns the value of attribute ssl_peer_cert


462
463
464
# File 'lib/httpclient/session.rb', line 462

def ssl_peer_cert
  @ssl_peer_cert
end

#strict_response_size_checkObject

Returns the value of attribute strict_response_size_check


458
459
460
# File 'lib/httpclient/session.rb', line 458

def strict_response_size_check
  @strict_response_size_check
end

#tcp_keepaliveObject

Boolean value to send TCP keepalive packets; no timing settings exist at present


445
446
447
# File 'lib/httpclient/session.rb', line 445

def tcp_keepalive
  @tcp_keepalive
end

#test_loopback_http_responseObject

Returns the value of attribute test_loopback_http_response


463
464
465
# File 'lib/httpclient/session.rb', line 463

def test_loopback_http_response
  @test_loopback_http_response
end

#transparent_gzip_decompressionObject

Returns the value of attribute transparent_gzip_decompression


465
466
467
# File 'lib/httpclient/session.rb', line 465

def transparent_gzip_decompression
  @transparent_gzip_decompression
end

Instance Method Details

#closeObject


543
544
545
546
547
548
549
550
# File 'lib/httpclient/session.rb', line 543

def close
  if !@socket.nil? and !@socket.closed?
    # @socket.flush may block when it the socket is already closed by
    # foreign host and the client runs under MT-condition.
    @socket.close
  end
  @state = :INIT
end

#closed?Boolean

Returns:

  • (Boolean)

552
553
554
# File 'lib/httpclient/session.rb', line 552

def closed?
  @state == :INIT
end

#connect_ssl_proxy(socket, uri) ⇒ Object


644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
# File 'lib/httpclient/session.rb', line 644

def connect_ssl_proxy(socket, uri)
  req = HTTP::Message.new_connect_request(uri)
  @client.request_filter.each do |filter|
    filter.filter_request(req)
  end
  set_header(req)
  req.dump(socket)
  socket.flush unless @socket_sync
  res = HTTP::Message.new_response('')
  parse_header(socket)
  res.http_version, res.status, res.reason = @version, @status, @reason
  @headers.each do |key, value|
    res.header.set(key.to_s, value)
  end
  commands = @client.request_filter.collect { |filter|
    filter.filter_response(req, res)
  }
  if commands.find { |command| command == :retry }
    raise RetryableResponse.new(res)
  end
  unless @status == 200
    raise BadResponseError.new("connect to ssl proxy failed with status #{@status} #{@reason}", res)
  end
end

#create_loopback_socket(host, port, str) ⇒ Object


630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'lib/httpclient/session.rb', line 630

def create_loopback_socket(host, port, str)
  @debug_dev << "! CONNECT TO #{host}:#{port}\n" if @debug_dev
  socket = LoopBackSocket.new(host, port, str)
  if @debug_dev
    @debug_dev << "! CONNECTION ESTABLISHED\n"
    socket.extend(DebugSocket)
    socket.debug_dev = @debug_dev
  end
  if https?(@dest) && @proxy
    connect_ssl_proxy(socket, Util.urify(@dest.to_s))
  end
  socket
end

#create_socket(host, port) ⇒ Object


605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
# File 'lib/httpclient/session.rb', line 605

def create_socket(host, port)
  socket = nil
  begin
    @debug_dev << "! CONNECT TO #{host}:#{port}\n" if @debug_dev
    clean_host = host.delete("[]")
    if @socket_local == Site::EMPTY
      socket = TCPSocket.new(clean_host, port)
    else
      clean_local = @socket_local.host.delete("[]")
      socket = TCPSocket.new(clean_host, port, clean_local, @socket_local.port)
    end
    socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true) if @tcp_keepalive
    if @debug_dev
      @debug_dev << "! CONNECTION ESTABLISHED\n"
      socket.extend(DebugSocket)
      socket.debug_dev = @debug_dev
    end
  rescue SystemCallError => e
    raise e.class, e.message + " (#{host}:#{port})"
  rescue SocketError => e
    raise e.class, e.message + " (#{host}:#{port})"
  end
  socket
end

#eof?Boolean

Returns:

  • (Boolean)

569
570
571
572
573
574
575
# File 'lib/httpclient/session.rb', line 569

def eof?
  if !@content_length.nil?
    @content_length == 0
  else
    @socket.closed? or @socket.eof?
  end
end

#get_body(&block) ⇒ Object


577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
# File 'lib/httpclient/session.rb', line 577

def get_body(&block)
  begin
    read_header if @state == :META
    return nil if @state != :DATA
    if @transparent_gzip_decompression
      block = content_inflater_block(@content_encoding, block)
    end
    if @chunked
      read_body_chunked(&block)
    elsif @content_length
      read_body_length(&block)
    else
      read_body_rest(&block)
    end
  rescue
    close
    raise
  end
  if eof?
    if @next_connection
      @state = :WAIT
    else
      close
    end
  end
  nil
end

#get_headerObject


556
557
558
559
560
561
562
563
564
565
566
567
# File 'lib/httpclient/session.rb', line 556

def get_header
  begin
    if @state != :META
      raise RuntimeError.new("get_status must be called at the beginning of a session")
    end
    read_header
  rescue
    close
    raise
  end
  [@version, @status, @reason, @headers]
end

#query(req) ⇒ Object

Send a request to the server


510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
# File 'lib/httpclient/session.rb', line 510

def query(req)
  connect if @state == :INIT
  # Use absolute URI (not absolute path) iif via proxy AND not HTTPS.
  req.header.request_absolute_uri = !@proxy.nil? && !https?(@dest)
  begin
    ::Timeout.timeout(@send_timeout, SendTimeoutError) do
      set_header(req)
      req.dump(@socket)
      # flush the IO stream as IO::sync mode is false
      @socket.flush unless @socket_sync
    end
  rescue Errno::ECONNABORTED, Errno::ECONNRESET, Errno::EPIPE, IOError
    # JRuby can raise IOError instead of ECONNRESET for now
    close
    raise KeepAliveDisconnected.new(self, $!)
  rescue HTTPClient::TimeoutError
    close
    raise
  rescue => e
    close
    if SSLEnabled and e.is_a?(OpenSSL::SSL::SSLError)
      raise KeepAliveDisconnected.new(self, e)
    else
      raise
    end
  end

  @state = :META if @state == :WAIT
  @next_connection = nil
  @requests.push(req)
  @last_used = Time.now
end