forked from tornadoweb/tornado
-
Notifications
You must be signed in to change notification settings - Fork 1
/
httpclient.py
435 lines (377 loc) · 15.3 KB
/
httpclient.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
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
173
174
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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
#!/usr/bin/env python
#
# Copyright 2009 Facebook
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
"""Blocking and non-blocking HTTP client implementations using pycurl."""
import calendar
import collections
import io
import email.utils
import errno
import functools
import http.client
from . import ioloop
import logging
import pycurl
import time
class HTTPClient:
"""A blocking HTTP client backed with pycurl.
Typical usage looks like this:
http_client = httpclient.HTTPClient()
try:
response = http_client.fetch("http://www.google.com/")
print response.body
except httpclient.HTTPError, e:
print "Error:", e
fetch() can take a string URL or an HTTPRequest instance, which offers
more options, like executing POST/PUT/DELETE requests.
"""
def __init__(self, max_simultaneous_connections=None):
self._curl = _curl_create(max_simultaneous_connections)
def __del__(self):
self._curl.close()
def fetch(self, request, **kwargs):
"""Executes an HTTPRequest, returning an HTTPResponse.
If an error occurs during the fetch, we raise an HTTPError.
"""
if not isinstance(request, HTTPRequest):
request = HTTPRequest(url=request, **kwargs)
buffer = io.StringIO()
headers = {}
try:
_curl_setup_request(self._curl, request, buffer, headers)
self._curl.perform()
code = self._curl.getinfo(pycurl.HTTP_CODE)
if code < 200 or code >= 300:
raise HTTPError(code)
effective_url = self._curl.getinfo(pycurl.EFFECTIVE_URL)
return HTTPResponse(
request=request, code=code, headers=headers,
body=buffer.getvalue(), effective_url=effective_url)
except pycurl.error as e:
raise CurlError(*e)
finally:
buffer.close()
class AsyncHTTPClient:
"""An non-blocking HTTP client backed with pycurl.
Example usage:
import ioloop
def handle_request(response):
if response.error:
print "Error:", response.error
else:
print response.body
ioloop.IOLoop.instance().stop()
http_client = httpclient.AsyncHTTPClient()
http_client.fetch("http://www.google.com/", handle_request)
ioloop.IOLoop.instance().start()
fetch() can take a string URL or an HTTPRequest instance, which offers
more options, like executing POST/PUT/DELETE requests.
The keyword argument max_clients to the AsyncHTTPClient constructor
determines the maximum number of simultaneous fetch() operations that
can execute in parallel on each IOLoop.
"""
_ASYNC_CLIENTS = {}
def __new__(cls, io_loop=None, max_clients=10,
max_simultaneous_connections=None):
# There is one client per IOLoop since they share curl instances
io_loop = io_loop or ioloop.IOLoop.instance()
if id(io_loop) in cls._ASYNC_CLIENTS:
return cls._ASYNC_CLIENTS[id(io_loop)]
else:
instance = super(AsyncHTTPClient, cls).__new__(cls)
instance.io_loop = io_loop
instance._multi = pycurl.CurlMulti()
instance._curls = [_curl_create(max_simultaneous_connections)
for i in range(max_clients)]
instance._free_list = instance._curls[:]
instance._requests = collections.deque()
instance._fds = {}
instance._events = {}
instance._added_perform_callback = False
instance._timeout = None
cls._ASYNC_CLIENTS[id(io_loop)] = instance
return instance
def fetch(self, request, callback, **kwargs):
"""Executes an HTTPRequest, calling callback with an HTTPResponse.
If an error occurs during the fetch, the HTTPResponse given to the
callback has a non-None error attribute that contains the exception
encountered during the request. You can call response.reraise() to
throw the exception (if any) in the callback.
"""
if not isinstance(request, HTTPRequest):
request = HTTPRequest(url=request, **kwargs)
self._requests.append((request, callback))
self._add_perform_callback()
def _add_perform_callback(self):
if not self._added_perform_callback:
self.io_loop.add_callback(self._perform)
self._added_perform_callback = True
def _handle_events(self, fd, events):
self._events[fd] = events
self._add_perform_callback()
def _handle_timeout(self):
self._timeout = None
self._perform()
def _perform(self):
self._added_perform_callback = False
while True:
while True:
ret, num_handles = self._multi.perform()
if ret != pycurl.E_CALL_MULTI_PERFORM:
break
# Handle completed fetches
completed = 0
while True:
num_q, ok_list, err_list = self._multi.info_read()
for curl in ok_list:
self._finish(curl)
completed += 1
for curl, errnum, errmsg in err_list:
self._finish(curl, errnum, errmsg)
completed += 1
if num_q == 0:
break
# Start fetching new URLs
started = 0
while self._free_list and self._requests:
started += 1
curl = self._free_list.pop()
(request, callback) = self._requests.popleft()
curl.info = {
"headers": {},
"buffer": io.StringIO(),
"request": request,
"callback": callback,
"start_time": time.time(),
}
_curl_setup_request(curl, request, curl.info["buffer"],
curl.info["headers"])
self._multi.add_handle(curl)
if not started and not completed:
break
if self._timeout is not None:
self.io_loop.remove_timeout(self._timeout)
self._timeout = None
if num_handles:
self._timeout = self.io_loop.add_timeout(
time.time() + 0.2, self._handle_timeout)
# Wait for more I/O
fds = {}
(readable, writable, exceptable) = self._multi.fdset()
for fd in readable:
fds[fd] = fds.get(fd, 0) | 0x1 | 0x2
for fd in writable:
fds[fd] = fds.get(fd, 0) | 0x4
for fd in exceptable:
fds[fd] = fds.get(fd, 0) | 0x8 | 0x10
for fd in self._fds:
if fd not in fds:
self.io_loop.remove_handler(fd)
for fd, events in fds.items():
old_events = self._fds.get(fd, None)
if old_events is None:
self.io_loop.add_handler(fd, self._handle_events, events)
elif old_events != events:
try:
self.io_loop.update_handler(fd, events)
except OSError as e:
if e[0] == errno.ENOENT:
self.io_loop.add_handler(fd, self._handle_events,
events)
else:
raise
self._fds = fds
def _finish(self, curl, curl_error=None, curl_message=None):
info = curl.info
curl.info = None
self._multi.remove_handle(curl)
self._free_list.append(curl)
if curl_error:
error = CurlError(curl_error, curl_message)
code = error.code
body = None
effective_url = None
else:
error = None
code = curl.getinfo(pycurl.HTTP_CODE)
body = info["buffer"].getvalue()
effective_url = curl.getinfo(pycurl.EFFECTIVE_URL)
info["buffer"].close()
info["callback"](HTTPResponse(
request=info["request"], code=code, headers=info["headers"],
body=body, effective_url=effective_url, error=error,
request_time=time.time() - info["start_time"]))
class HTTPRequest:
def __init__(self, url, method="GET", headers={}, body=None,
auth_username=None, auth_password=None,
connect_timeout=None, request_timeout=None,
if_modified_since=None, follow_redirects=True,
max_redirects=5, user_agent=None, use_gzip=True,
network_interface=None, streaming_callback=None):
if if_modified_since:
timestamp = calendar.timegm(if_modified_since.utctimetuple())
headers["If-Modified-Since"] = email.utils.formatdate(
timestamp, localtime=False, usegmt=True)
if "Pragma" not in headers:
headers["Pragma"] = ""
self.url = _utf8(url)
self.method = method
self.headers = headers
self.body = body
self.auth_username = _utf8(auth_username)
self.auth_password = _utf8(auth_password)
self.connect_timeout = connect_timeout or 20.0
self.request_timeout = request_timeout or 20.0
self.follow_redirects = follow_redirects
self.max_redirects = max_redirects
self.user_agent = user_agent
self.use_gzip = use_gzip
self.network_interface = network_interface
self.streaming_callback = streaming_callback
class HTTPResponse:
def __init__(self, request, code, headers={}, body="", effective_url=None,
error=None, request_time=None):
self.request = request
self.code = code
self.headers = headers
self.body = body
if effective_url is None:
self.effective_url = request.url
else:
self.effective_url = effective_url
if error is None:
if self.code < 200 or self.code >= 300:
self.error = HTTPError(self.code)
else:
self.error = None
else:
self.error = error
self.request_time = request_time
def rethrow(self):
if self.error:
raise self.error
def __repr__(self):
args = ",".join("%s=%r" % i for i in self.__dict__.items())
return "%s(%s)" % (self.__class__.__name__, args)
class HTTPError(Exception):
def __init__(self, code, message=None):
self.code = code
message = message or http.client.responses.get(code, "Unknown")
Exception.__init__(self, "HTTP %d: %s" % (self.code, message))
class CurlError(HTTPError):
def __init__(self, errno, message):
HTTPError.__init__(self, 599, message)
self.errno = errno
def _curl_create(max_simultaneous_connections=None):
curl = pycurl.Curl()
if logging.getLogger().isEnabledFor(logging.DEBUG):
curl.setopt(pycurl.VERBOSE, 1)
curl.setopt(pycurl.DEBUGFUNCTION, _curl_debug)
curl.setopt(pycurl.MAXCONNECTS, max_simultaneous_connections or 5)
return curl
def _curl_setup_request(curl, request, buffer, headers):
curl.setopt(pycurl.URL, request.url)
curl.setopt(pycurl.HTTPHEADER,
["%s: %s" % i for i in request.headers.items()])
try:
curl.setopt(pycurl.HEADERFUNCTION,
functools.partial(_curl_header_callback, headers))
except:
# Old version of curl; response will not include headers
pass
if request.streaming_callback:
curl.setopt(pycurl.WRITEFUNCTION, request.streaming_callback)
else:
curl.setopt(pycurl.WRITEFUNCTION, buffer.write)
curl.setopt(pycurl.FOLLOWLOCATION, request.follow_redirects)
curl.setopt(pycurl.MAXREDIRS, request.max_redirects)
curl.setopt(pycurl.CONNECTTIMEOUT, int(request.connect_timeout))
curl.setopt(pycurl.TIMEOUT, int(request.request_timeout))
if request.user_agent:
curl.setopt(pycurl.USERAGENT, request.user_agent)
else:
curl.setopt(pycurl.USERAGENT, "Mozilla/5.0 (compatible; pycurl)")
if request.network_interface:
curl.setopt(pycurl.INTERFACE, request.network_interface)
if request.use_gzip:
curl.setopt(pycurl.ENCODING, "gzip,deflate")
else:
curl.setopt(pycurl.ENCODING, "none")
# Set the request method through curl's retarded interface which makes
# up names for almost every single method
curl_options = {
"GET": pycurl.HTTPGET,
"POST": pycurl.POST,
"PUT": pycurl.UPLOAD,
"HEAD": pycurl.NOBODY,
}
custom_methods = set(["DELETE"])
for o in list(curl_options.values()):
curl.setopt(o, False)
if request.method in curl_options:
curl.unsetopt(pycurl.CUSTOMREQUEST)
curl.setopt(curl_options[request.method], True)
elif request.method in custom_methods:
curl.setopt(pycurl.CUSTOMREQUEST, request.method)
else:
raise KeyError('unknown method ' + request.method)
# Handle curl's cryptic options for every individual HTTP method
if request.method in ("POST", "PUT"):
request_buffer = io.StringIO(request.body)
curl.setopt(pycurl.READFUNCTION, request_buffer.read)
if request.method == "POST":
def ioctl(cmd):
if cmd == curl.IOCMD_RESTARTREAD:
request_buffer.seek(0)
curl.setopt(pycurl.IOCTLFUNCTION, ioctl)
curl.setopt(pycurl.POSTFIELDSIZE, len(request.body))
else:
curl.setopt(pycurl.INFILESIZE, len(request.body))
if request.auth_username and request.auth_password:
userpwd = "%s:%s" % (request.auth_username, request.auth_password)
curl.setopt(pycurl.HTTPAUTH, pycurl.HTTPAUTH_BASIC)
curl.setopt(pycurl.USERPWD, userpwd)
logging.info("%s %s (username: %r)", request.method, request.url,
request.auth_username)
else:
curl.unsetopt(pycurl.USERPWD)
logging.info("%s %s", request.method, request.url)
def _curl_header_callback(headers, header_line):
if header_line.startswith("HTTP/"):
headers.clear()
return
if header_line == "\r\n":
return
parts = header_line.split(": ")
if len(parts) != 2:
logging.warning("Invalid HTTP response header line %r", header_line)
return
headers[parts[0].strip()] = parts[1].strip()
def _curl_debug(debug_type, debug_msg):
debug_types = ('I', '<', '>', '<', '>')
if debug_type == 0:
logging.debug('%s', debug_msg.strip())
elif debug_type in (1, 2):
for line in debug_msg.splitlines():
logging.debug('%s %s', debug_types[debug_type], line)
elif debug_type == 4:
logging.debug('%s %r', debug_types[debug_type], debug_msg)
def _utf8(value):
if value is None:
return value
if isinstance(value, bytes):
return str(value, 'utf8')
assert isinstance(value, str)
return value