2 from twisted.internet import reactor, defer, protocol
3 from twisted.internet.protocol import ClientFactory
4 from twisted import version as twisted_version
5 from twisted.python import log
6 from twisted.web2.client.interfaces import IHTTPClientManager
7 from twisted.web2.client.http import ProtocolError, ClientRequest, HTTPClientProtocol
8 from twisted.web2 import stream as stream_mod, http_headers
9 from twisted.web2 import version as web2_version
10 from twisted.trial import unittest
11 from zope.interface import implements
13 from apt_dht_conf import version
15 class HTTPClientManager(ClientFactory):
16 """A manager for all HTTP requests to a single site.
18 Controls all requests that got to a single site (host and port).
19 This includes buffering requests until they can be sent and reconnecting
20 in the even of the connection being closed.
24 implements(IHTTPClientManager)
26 def __init__(self, host, port=80):
32 self.connecting = False
33 self.request_queue = []
34 self.response_queue = []
39 assert self.closed and not self.connecting
40 self.connecting = True
41 d = protocol.ClientCreator(reactor, HTTPClientProtocol, self).connectTCP(self.host, self.port)
42 d.addCallback(self.connected)
44 def connected(self, proto):
46 self.connecting = False
52 self.proto.transport.loseConnection()
55 return not self.busy and not self.request_queue and not self.response_queue
57 def submitRequest(self, request):
58 request.deferRequest = defer.Deferred()
59 self.request_queue.append(request)
61 return request.deferRequest
63 def processQueue(self):
64 if not self.request_queue:
71 if self.busy and not self.pipeline:
73 if self.response_queue and not self.pipeline:
76 req = self.request_queue.pop(0)
77 self.response_queue.append(req)
78 req.deferResponse = self.proto.submitRequest(req, False)
79 req.deferResponse.addCallbacks(self.requestComplete, self.requestError)
81 def requestComplete(self, resp):
82 req = self.response_queue.pop(0)
83 log.msg('%s of %s completed with code %d' % (req.method, req.uri, resp.code))
84 req.deferRequest.callback(resp)
86 def requestError(self, error):
87 req = self.response_queue.pop(0)
88 log.msg('Download of %s generated error %r' % (req.uri, error))
89 req.deferRequest.errback(error)
91 def clientBusy(self, proto):
94 def clientIdle(self, proto):
98 def clientPipelining(self, proto):
102 def clientGone(self, proto):
103 for req in self.response_queue:
104 req.deferRequest.errback(ProtocolError('lost connection'))
106 self.pipeline = False
108 self.connecting = False
109 self.response_queue = []
111 if self.request_queue:
114 def setCommonHeaders(self):
115 headers = http_headers.Headers()
116 headers.setHeader('Host', self.host)
117 headers.setHeader('User-Agent', 'apt-dht/%s (twisted/%s twisted.web2/%s)' %
118 (version.short(), twisted_version.short(), web2_version.short()))
121 def get(self, path, method="GET", modtime=None):
122 headers = self.setCommonHeaders()
124 headers.setHeader('If-Modified-Since', modtime)
125 return self.submitRequest(ClientRequest(method, path, headers, None))
127 def getRange(self, path, rangeStart, rangeEnd, method="GET"):
128 headers = self.setCommonHeaders()
129 headers.setHeader('Range', ('bytes', [(rangeStart, rangeEnd)]))
130 return self.submitRequest(ClientRequest(method, path, headers, None))
132 class TestClientManager(unittest.TestCase):
133 """Unit tests for the HTTPClientManager."""
138 def gotResp(self, resp, num, expect):
139 self.failUnless(resp.code >= 200 and resp.code < 300, "Got a non-200 response: %r" % resp.code)
140 if expect is not None:
141 self.failUnless(resp.stream.length == expect, "Length was incorrect, got %r, expected %r" % (resp.stream.length, expect))
146 stream_mod.readStream(resp.stream, print_).addCallback(printdone)
148 def test_download(self):
149 host = 'www.camrdale.org'
150 self.client = HTTPClientManager(host, 80)
153 d = self.client.get('/robots.txt')
154 d.addCallback(self.gotResp, 1, 309)
158 host = 'www.camrdale.org'
159 self.client = HTTPClientManager(host, 80)
162 d = self.client.get('/robots.txt', "HEAD")
163 d.addCallback(self.gotResp, 1, 0)
166 def test_multiple_downloads(self):
167 host = 'www.camrdale.org'
168 self.client = HTTPClientManager(host, 80)
170 lastDefer = defer.Deferred()
172 def newRequest(path, num, expect, last=False):
173 d = self.client.get(path)
174 d.addCallback(self.gotResp, num, expect)
176 d.addBoth(lastDefer.callback)
178 newRequest("/", 1, 3433)
179 newRequest("/blog/", 2, 39152)
180 newRequest("/camrdale.html", 3, 2234)
181 self.pending_calls.append(reactor.callLater(1, newRequest, '/robots.txt', 4, 309))
182 self.pending_calls.append(reactor.callLater(10, newRequest, '/wikilink.html', 5, 3084))
183 self.pending_calls.append(reactor.callLater(30, newRequest, '/sitemap.html', 6, 4756))
184 self.pending_calls.append(reactor.callLater(31, newRequest, '/PlanetLab.html', 7, 2783))
185 self.pending_calls.append(reactor.callLater(32, newRequest, '/openid.html', 8, 2525))
186 self.pending_calls.append(reactor.callLater(32, newRequest, '/subpage.html', 9, 2381))
187 self.pending_calls.append(reactor.callLater(62, newRequest, '/sitemap2.rss', 0, 313470, True))
190 def test_multiple_quick_downloads(self):
191 host = 'www.camrdale.org'
192 self.client = HTTPClientManager(host, 80)
194 lastDefer = defer.Deferred()
196 def newRequest(path, num, expect, last=False):
197 d = self.client.get(path)
198 d.addCallback(self.gotResp, num, expect)
200 d.addBoth(lastDefer.callback)
202 newRequest("/", 1, 3433)
203 newRequest("/blog/", 2, 39152)
204 newRequest("/camrdale.html", 3, 2234)
205 self.pending_calls.append(reactor.callLater(0, newRequest, '/robots.txt', 4, 309))
206 self.pending_calls.append(reactor.callLater(0, newRequest, '/wikilink.html', 5, 3084))
207 self.pending_calls.append(reactor.callLater(0, newRequest, '/sitemap.html', 6, 4756))
208 self.pending_calls.append(reactor.callLater(0, newRequest, '/PlanetLab.html', 7, 2783))
209 self.pending_calls.append(reactor.callLater(0, newRequest, '/openid.html', 8, 2525))
210 self.pending_calls.append(reactor.callLater(0, newRequest, '/subpage.html', 9, 2381))
211 self.pending_calls.append(reactor.callLater(0, newRequest, '/sitemap2.rss', 0, 313470, True))
214 def test_range(self):
215 host = 'www.camrdale.org'
216 self.client = HTTPClientManager(host, 80)
219 d = self.client.getRange('/robots.txt', 100, 199)
220 d.addCallback(self.gotResp, 1, 100)
224 for p in self.pending_calls:
227 self.pending_calls = []