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.web2.client.interfaces import IHTTPClientManager
6 from twisted.web2.client.http import ProtocolError, ClientRequest, HTTPClientProtocol
7 from twisted.web2 import stream as stream_mod, http_headers
8 from twisted.web2 import version as web2_version
9 from twisted.trial import unittest
10 from zope.interface import implements
12 from apt_dht_conf import version
14 class HTTPClientManager(ClientFactory):
15 """A manager for all HTTP requests to a single site.
17 Controls all requests that got to a single site (host and port).
18 This includes buffering requests until they can be sent and reconnecting
19 in the even of the connection being closed.
23 implements(IHTTPClientManager)
25 def __init__(self, host, port=80):
31 self.connecting = False
32 self.request_queue = []
33 self.response_queue = []
38 assert(self.closed and not self.connecting)
39 self.connecting = True
40 d = protocol.ClientCreator(reactor, HTTPClientProtocol, self).connectTCP(self.host, self.port)
41 d.addCallback(self.connected)
43 def connected(self, proto):
45 self.connecting = False
51 self.proto.transport.loseConnection()
54 return not self.busy and not self.request_queue and not self.response_queue
56 def submitRequest(self, request):
57 request.deferRequest = defer.Deferred()
58 self.request_queue.append(request)
60 return request.deferRequest
62 def processQueue(self):
63 if not self.request_queue:
70 if self.busy and not self.pipeline:
72 if self.response_queue and not self.pipeline:
75 req = self.request_queue.pop(0)
76 self.response_queue.append(req)
77 req.deferResponse = self.proto.submitRequest(req, False)
78 req.deferResponse.addCallback(self.requestComplete)
79 req.deferResponse.addErrback(self.requestError)
81 def requestComplete(self, resp):
82 req = self.response_queue.pop(0)
83 req.deferRequest.callback(resp)
85 def requestError(self, error):
86 req = self.response_queue.pop(0)
87 req.deferRequest.errback(error)
89 def clientBusy(self, proto):
92 def clientIdle(self, proto):
96 def clientPipelining(self, proto):
100 def clientGone(self, proto):
101 for req in self.response_queue:
102 req.deferRequest.errback(ProtocolError('lost connection'))
104 self.pipeline = False
106 self.connecting = False
107 self.response_queue = []
109 if self.request_queue:
112 def setCommonHeaders(self):
113 headers = http_headers.Headers()
114 headers.setHeader('Host', self.host)
115 headers.setHeader('User-Agent', 'apt-dht/%s (twisted/%s twisted.web2/%s)' %
116 (version.short(), twisted_version.short(), web2_version.short()))
119 def get(self, path, method="GET", modtime=None):
120 headers = self.setCommonHeaders()
122 headers.setHeader('If-Modified-Since', modtime)
123 return self.submitRequest(ClientRequest(method, path, headers, None))
125 def getRange(self, path, rangeStart, rangeEnd, method="GET"):
126 headers = self.setCommonHeaders()
127 headers.setHeader('Range', ('bytes', [(rangeStart, rangeEnd)]))
128 return self.submitRequest(ClientRequest(method, path, headers, None))
130 class TestClientManager(unittest.TestCase):
131 """Unit tests for the HTTPClientManager."""
136 def gotResp(self, resp, num, expect):
137 self.failUnless(resp.code >= 200 and resp.code < 300, "Got a non-200 response: %r" % resp.code)
138 if expect is not None:
139 self.failUnless(resp.stream.length == expect, "Length was incorrect, got %r, expected %r" % (resp.stream.length, expect))
144 stream_mod.readStream(resp.stream, print_).addCallback(printdone)
146 def test_download(self):
147 host = 'www.camrdale.org'
148 self.client = HTTPClientManager(host, 80)
151 d = self.client.get('/robots.txt')
152 d.addCallback(self.gotResp, 1, 309)
156 host = 'www.camrdale.org'
157 self.client = HTTPClientManager(host, 80)
160 d = self.client.get('/robots.txt', "HEAD")
161 d.addCallback(self.gotResp, 1, 0)
164 def test_multiple_downloads(self):
165 host = 'www.camrdale.org'
166 self.client = HTTPClientManager(host, 80)
168 lastDefer = defer.Deferred()
170 def newRequest(path, num, expect, last=False):
171 d = self.client.get(path)
172 d.addCallback(self.gotResp, num, expect)
174 d.addBoth(lastDefer.callback)
176 newRequest("/", 1, 3433)
177 newRequest("/blog/", 2, 37121)
178 newRequest("/camrdale.html", 3, 2234)
179 self.pending_calls.append(reactor.callLater(1, newRequest, '/robots.txt', 4, 309))
180 self.pending_calls.append(reactor.callLater(10, newRequest, '/wikilink.html', 5, 3084))
181 self.pending_calls.append(reactor.callLater(30, newRequest, '/sitemap.html', 6, 4750))
182 self.pending_calls.append(reactor.callLater(31, newRequest, '/PlanetLab.html', 7, 2783))
183 self.pending_calls.append(reactor.callLater(32, newRequest, '/openid.html', 8, 2525))
184 self.pending_calls.append(reactor.callLater(32, newRequest, '/subpage.html', 9, 2381))
185 self.pending_calls.append(reactor.callLater(62, newRequest, '/sitemap2.rss', 0, 302362, True))
188 def test_multiple_quick_downloads(self):
189 host = 'www.camrdale.org'
190 self.client = HTTPClientManager(host, 80)
192 lastDefer = defer.Deferred()
194 def newRequest(path, num, expect, last=False):
195 d = self.client.get(path)
196 d.addCallback(self.gotResp, num, expect)
198 d.addBoth(lastDefer.callback)
200 newRequest("/", 1, 3433)
201 newRequest("/blog/", 2, 37121)
202 newRequest("/camrdale.html", 3, 2234)
203 self.pending_calls.append(reactor.callLater(0, newRequest, '/robots.txt', 4, 309))
204 self.pending_calls.append(reactor.callLater(0, newRequest, '/wikilink.html', 5, 3084))
205 self.pending_calls.append(reactor.callLater(0, newRequest, '/sitemap.html', 6, 4750))
206 self.pending_calls.append(reactor.callLater(0, newRequest, '/PlanetLab.html', 7, 2783))
207 self.pending_calls.append(reactor.callLater(0, newRequest, '/openid.html', 8, 2525))
208 self.pending_calls.append(reactor.callLater(0, newRequest, '/subpage.html', 9, 2381))
209 self.pending_calls.append(reactor.callLater(0, newRequest, '/sitemap2.rss', 0, 302362, True))
212 def test_range(self):
213 host = 'www.camrdale.org'
214 self.client = HTTPClientManager(host, 80)
217 d = self.client.getRange('/robots.txt', 100, 199)
218 d.addCallback(self.gotResp, 1, 100)
222 for p in self.pending_calls:
225 self.pending_calls = []