Class: EventMachine::Protocols::HttpClient

Inherits:
Connection
  • Object
show all
Includes:
Deferrable
Defined in:
lib/em/protocols/httpclient.rb

Overview

Note: This class is deprecated and will be removed. Please use EM-HTTP-Request instead.

– TODO: Add streaming so we can support enormous POSTs. Current max is 20meg. Timeout for connections that run too long or hang somewhere in the middle. Persistent connections (HTTP/1.1), may need a associated delegate object. DNS: Some way to cache DNS lookups for hostnames we connect to. Ruby's DNS lookups are unbelievably slow. HEAD requests. Convenience methods for requests. get, post, url, etc. SSL. Handle status codes like 304, 100, etc. Refactor this code so that protocol errors all get handled one way (an exception?), instead of sprinkling set_deferred_status :failed calls everywhere.

Examples:

EventMachine.run {
  http = EventMachine::Protocols::HttpClient.request(
    :host => server,
    :port => 80,
    :request => "/index.html",
    :query_string => "parm1=value1&parm2=value2"
  )
  http.callback {|response|
    puts response[:status]
    puts response[:headers]
    puts response[:content]
  }
}

Constant Summary

MaxPostContentLength =
20 * 1024 * 1024

Constants included from Deferrable

Deferrable::Pool

Instance Attribute Summary

Attributes inherited from Connection

#signature

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Deferrable

#callback, #cancel_callback, #cancel_errback, #cancel_timeout, #errback, #fail, future, #set_deferred_status, #succeed, #timeout

Methods inherited from Connection

#associate_callback_target, #close_connection, #close_connection_after_writing, #comm_inactivity_timeout, #comm_inactivity_timeout=, #detach, #error?, #get_cipher_bits, #get_cipher_name, #get_cipher_protocol, #get_idle_time, #get_outbound_data_size, #get_peer_cert, #get_peername, #get_pid, #get_proxied_bytes, #get_sni_hostname, #get_sock_opt, #get_sockname, #get_status, new, #notify_readable=, #notify_readable?, #notify_writable=, #notify_writable?, #pause, #paused?, #pending_connect_timeout, #pending_connect_timeout=, #proxy_completed, #proxy_incoming_to, #proxy_target_unbound, #reconnect, #resume, #send_data, #send_datagram, #send_file_data, #set_sock_opt, #ssl_handshake_completed, #ssl_verify_peer, #start_tls, #stop_proxying, #stream_file_data

Constructor Details

#initializeHttpClient

Returns a new instance of HttpClient



63
64
65
66
# File 'lib/em/protocols/httpclient.rb', line 63

def initialize
  warn "HttpClient is deprecated and will be removed. EM-Http-Request should be used instead."
  @connected = false
end

Class Method Details

.request(args = {}) ⇒ Object

Parameters:

  • args (Hash) (defaults to: {})

    The request arguments

Options Hash (args):

  • :host (String)

    The host IP/DNS name

  • :port (Integer)

    The port to connect too

  • :verb (String)

    The request type [GET | POST | DELETE | PUT]

  • :request (String)

    The request path

  • :basic_auth (Hash)

    The basic auth credentials (:username and :password)

  • :content (String)

    The request content

  • :contenttype (String)

    The content type (e.g. text/plain)

  • :query_string (String)

    The query string

  • :host_header (String)

    The host header to set

  • :cookie (String)

    Cookies to set



79
80
81
82
83
84
85
# File 'lib/em/protocols/httpclient.rb', line 79

def self.request( args = {} )
  args[:port] ||= 80
  EventMachine.connect( args[:host], args[:port], self ) {|c|
    # According to the docs, we will get here AFTER post_init is called.
    c.instance_eval {@args = args}
  }
end

Instance Method Details

#connection_completedObject

We send the request when we get a connection. AND, we set an instance variable to indicate we passed through here. That allows #unbind to know whether there was a successful connection. NB: This naive technique won't work when we have to support multiple requests on a single connection.



98
99
100
101
# File 'lib/em/protocols/httpclient.rb', line 98

def connection_completed
  @connected = true
  send_request @args
end

#dispatch_responseObject



280
281
282
283
284
285
286
287
288
289
# File 'lib/em/protocols/httpclient.rb', line 280

def dispatch_response
  @read_state = :base
  set_deferred_status :succeeded, {
    :content => @content,
    :headers => @headers,
    :status => @status
  }
  # TODO, we close the connection for now, but this is wrong for persistent clients.
  close_connection
end

#post_initObject



87
88
89
90
91
# File 'lib/em/protocols/httpclient.rb', line 87

def post_init
  @start_time = Time.now
  @data = ""
  @read_state = :base
end

#receive_data(data) ⇒ Object



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/em/protocols/httpclient.rb', line 175

def receive_data data
  while data and data.length > 0
    case @read_state
    when :base
      # Perform any per-request initialization here and don't consume any data.
      @data = ""
      @headers = []
      @content_length = nil # not zero
      @content = ""
      @status = nil
      @chunked = false
      @chunk_length = nil
      @read_state = :header
      @connection_close = nil
    when :header
      ary = data.split( /\r?\n/m, 2 )
      if ary.length == 2
        data = ary.last
        if ary.first == ""
          if (@content_length and @content_length > 0) || @chunked || @connection_close
            @read_state = :content
          else
            dispatch_response
            @read_state = :base
          end
        else
          @headers << ary.first
          if @headers.length == 1
            parse_response_line
          elsif ary.first =~ /\Acontent-length:\s*/i
            # Only take the FIRST content-length header that appears,
            # which we can distinguish because @content_length is nil.
            # TODO, it's actually a fatal error if there is more than one
            # content-length header, because the caller is presumptively
            # a bad guy. (There is an exploit that depends on multiple
            # content-length headers.)
            @content_length ||= $'.to_i
          elsif ary.first =~ /\Aconnection:\s*close/i
            @connection_close = true
          elsif ary.first =~ /\Atransfer-encoding:\s*chunked/i
            @chunked = true
          end
        end
      else
        @data << data
        data = ""
      end
    when :content
      if @chunked && @chunk_length
        bytes_needed = @chunk_length - @chunk_read
        new_data = data[0, bytes_needed]
        @chunk_read += new_data.length
        @content += new_data
        data = data[bytes_needed..-1] || ""
        if @chunk_length == @chunk_read && data[0,2] == "\r\n"
          @chunk_length = nil
          data = data[2..-1]
        end
      elsif @chunked
        if (m = data.match(/\A(\S*)\r\n/m))
          data = data[m[0].length..-1]
          @chunk_length = m[1].to_i(16)
          @chunk_read = 0
          if @chunk_length == 0
            dispatch_response
            @read_state = :base
          end
        end
      elsif @content_length
        # If there was no content-length header, we have to wait until the connection
        # closes. Everything we get until that point is content.
        # TODO: Must impose a content-size limit, and also must implement chunking.
        # Also, must support either temporary files for large content, or calling
        # a content-consumer block supplied by the user.
        bytes_needed = @content_length - @content.length
        @content += data[0, bytes_needed]
        data = data[bytes_needed..-1] || ""
        if @content_length == @content.length
          dispatch_response
          @read_state = :base
        end
      else
        @content << data
        data = ""
      end
    end
  end
end

#send_request(args) ⇒ Object



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'lib/em/protocols/httpclient.rb', line 103

def send_request args
  args[:verb] ||= args[:method] # Support :method as an alternative to :verb.
  args[:verb] ||= :get # IS THIS A GOOD IDEA, to default to GET if nothing was specified?

  verb = args[:verb].to_s.upcase
  unless ["GET", "POST", "PUT", "DELETE", "HEAD"].include?(verb)
    set_deferred_status :failed, {:status => 0} # TODO, not signalling the error type
    return # NOTE THE EARLY RETURN, we're not sending any data.
  end

  request = args[:request] || "/"
  unless request[0,1] == "/"
    request = "/" + request
  end

  qs = args[:query_string] || ""
  if qs.length > 0 and qs[0,1] != '?'
    qs = "?" + qs
  end

  version = args[:version] || "1.1"

  # Allow an override for the host header if it's not the connect-string.
  host = args[:host_header] || args[:host] || "_"
  # For now, ALWAYS tuck in the port string, although we may want to omit it if it's the default.
  port = args[:port].to_i != 80 ? ":#{args[:port]}" : ""

  # POST items.
  postcontenttype = args[:contenttype] || "application/octet-stream"
  postcontent = args[:content] || ""
  raise "oversized content in HTTP POST" if postcontent.length > MaxPostContentLength

  # ESSENTIAL for the request's line-endings to be CRLF, not LF. Some servers misbehave otherwise.
  # TODO: We ASSUME the caller wants to send a 1.1 request. May not be a good assumption.
  req = [
    "#{verb} #{request}#{qs} HTTP/#{version}",
    "Host: #{host}#{port}",
    "User-agent: Ruby EventMachine",
  ]

    if verb == "POST" || verb == "PUT"
      req << "Content-type: #{postcontenttype}"
      req << "Content-length: #{postcontent.length}"
    end

    # TODO, this cookie handler assumes it's getting a single, semicolon-delimited string.
    # Eventually we will want to deal intelligently with arrays and hashes.
    if args[:cookie]
      req << "Cookie: #{args[:cookie]}"
    end

    # Allow custom HTTP headers, e.g. SOAPAction
    args[:custom_headers].each do |k,v|
      req << "#{k}: #{v}"
    end if args[:custom_headers]

    # Basic-auth stanza contributed by Matt Murphy.
    if args[:basic_auth]
      basic_auth_string = ["#{args[:basic_auth][:username]}:#{args[:basic_auth][:password]}"].pack('m').strip.gsub(/\n/,'')
      req << "Authorization: Basic #{basic_auth_string}"
    end

    req << ""
    reqstring = req.map {|l| "#{l}\r\n"}.join
    send_data reqstring

    if verb == "POST" || verb == "PUT"
      send_data postcontent
    end
end

#unbindObject



291
292
293
294
295
296
297
# File 'lib/em/protocols/httpclient.rb', line 291

def unbind
  if !@connected
    set_deferred_status :failed, {:status => 0} # YECCCCH. Find a better way to signal no-connect/network error.
  elsif (@read_state == :content and @content_length == nil)
    dispatch_response
  end
end