/usr/share/pyshared/twisted/web2/client/http.py is in python-twisted-web2 8.1.0-3build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | # -*- test-case-name: twisted.web2.test.test_client -*-
# Copyright (c) 2001-2007 Twisted Matrix Laboratories.
# See LICENSE for details.
"""
Client-side HTTP implementation.
"""
from zope.interface import implements
from twisted.internet.defer import Deferred
from twisted.protocols.basic import LineReceiver
from twisted.protocols.policies import TimeoutMixin
from twisted.web2.responsecode import BAD_REQUEST, HTTP_VERSION_NOT_SUPPORTED
from twisted.web2.http import parseVersion, Response
from twisted.web2.http_headers import Headers
from twisted.web2.stream import ProducerStream, StreamProducer, IByteStream
from twisted.web2.channel.http import HTTPParser, PERSIST_NO_PIPELINE, PERSIST_PIPELINE
from twisted.web2.client.interfaces import IHTTPClientManager
class ProtocolError(Exception):
"""
Exception raised when a HTTP error happened.
"""
class ClientRequest(object):
"""
A class for describing an HTTP request to be sent to the server.
"""
def __init__(self, method, uri, headers, stream):
"""
@param method: The HTTP method to for this request, ex: 'GET', 'HEAD',
'POST', etc.
@type method: C{str}
@param uri: The URI of the resource to request, this may be absolute or
relative, however the interpretation of this URI is left up to the
remote server.
@type uri: C{str}
@param headers: Headers to be sent to the server. It is important to
note that this object does not create any implicit headers. So it
is up to the HTTP Client to add required headers such as 'Host'.
@type headers: C{dict}, L{twisted.web2.http_headers.Headers}, or
C{None}
@param stream: Content body to send to the remote HTTP server.
@type stream: L{twisted.web2.stream.IByteStream}
"""
self.method = method
self.uri = uri
if isinstance(headers, Headers):
self.headers = headers
else:
self.headers = Headers(headers or {})
if stream is not None:
self.stream = IByteStream(stream)
else:
self.stream = None
class HTTPClientChannelRequest(HTTPParser):
parseCloseAsEnd = True
outgoing_version = "HTTP/1.1"
chunkedOut = False
finished = False
closeAfter = False
def __init__(self, channel, request, closeAfter):
HTTPParser.__init__(self, channel)
self.request = request
self.closeAfter = closeAfter
self.transport = self.channel.transport
self.responseDefer = Deferred()
def submit(self):
l = []
request = self.request
if request.method == "HEAD":
# No incoming data will arrive.
self.length = 0
l.append('%s %s %s\r\n' % (request.method, request.uri,
self.outgoing_version))
if request.headers is not None:
for name, valuelist in request.headers.getAllRawHeaders():
for value in valuelist:
l.append("%s: %s\r\n" % (name, value))
if request.stream is not None:
if request.stream.length is not None:
l.append("%s: %s\r\n" % ('Content-Length', request.stream.length))
else:
# Got a stream with no length. Send as chunked and hope, against
# the odds, that the server actually supports chunked uploads.
l.append("%s: %s\r\n" % ('Transfer-Encoding', 'chunked'))
self.chunkedOut = True
if self.closeAfter:
l.append("%s: %s\r\n" % ('Connection', 'close'))
else:
l.append("%s: %s\r\n" % ('Connection', 'Keep-Alive'))
l.append("\r\n")
self.transport.writeSequence(l)
d = StreamProducer(request.stream).beginProducing(self)
d.addCallback(self._finish).addErrback(self._error)
def registerProducer(self, producer, streaming):
"""
Register a producer.
"""
self.transport.registerProducer(producer, streaming)
def unregisterProducer(self):
self.transport.unregisterProducer()
def write(self, data):
if not data:
return
elif self.chunkedOut:
self.transport.writeSequence(("%X\r\n" % len(data), data, "\r\n"))
else:
self.transport.write(data)
def _finish(self, x):
"""
We are finished writing data.
"""
if self.chunkedOut:
# write last chunk and closing CRLF
self.transport.write("0\r\n\r\n")
self.finished = True
self.channel.requestWriteFinished(self)
del self.transport
def _error(self, err):
"""
Abort parsing, and depending of the status of the request, either fire
the C{responseDefer} if no response has been sent yet, or close the
stream.
"""
self.abortParse()
if hasattr(self, 'stream') and self.stream is not None:
self.stream.finish(err)
else:
self.responseDefer.errback(err)
def _abortWithError(self, errcode, text):
"""
Abort parsing by forwarding a C{ProtocolError} to C{_error}.
"""
self._error(ProtocolError(text))
def connectionLost(self, reason):
self._error(reason)
def gotInitialLine(self, initialLine):
parts = initialLine.split(' ', 2)
# Parse the initial request line
if len(parts) != 3:
self._abortWithError(BAD_REQUEST,
"Bad response line: %s" % (initialLine,))
return
strversion, self.code, message = parts
try:
protovers = parseVersion(strversion)
if protovers[0] != 'http':
raise ValueError()
except ValueError:
self._abortWithError(BAD_REQUEST,
"Unknown protocol: %s" % (strversion,))
return
self.version = protovers[1:3]
# Ensure HTTP 0 or HTTP 1.
if self.version[0] != 1:
self._abortWithError(HTTP_VERSION_NOT_SUPPORTED,
'Only HTTP 1.x is supported.')
return
## FIXME: Actually creates Response, function is badly named!
def createRequest(self):
self.stream = ProducerStream(self.length)
self.response = Response(self.code, self.inHeaders, self.stream)
self.stream.registerProducer(self, True)
del self.inHeaders
## FIXME: Actually processes Response, function is badly named!
def processRequest(self):
self.responseDefer.callback(self.response)
def handleContentChunk(self, data):
self.stream.write(data)
def handleContentComplete(self):
self.stream.finish()
class EmptyHTTPClientManager(object):
"""
A dummy HTTPClientManager. It doesn't do any client management, and is
meant to be used only when creating an HTTPClientProtocol directly.
"""
implements(IHTTPClientManager)
def clientBusy(self, proto):
pass
def clientIdle(self, proto):
pass
def clientPipelining(self, proto):
pass
def clientGone(self, proto):
pass
class HTTPClientProtocol(LineReceiver, TimeoutMixin, object):
"""
A HTTP 1.1 Client with request pipelining support.
"""
chanRequest = None
maxHeaderLength = 10240
firstLine = 1
readPersistent = PERSIST_NO_PIPELINE
# inputTimeOut should be pending whenever a complete request has
# been written but the complete response has not yet been
# received, and be reset every time data is received.
inputTimeOut = 60 * 4
def __init__(self, manager=None):
"""
@param manager: The object this client reports it state to.
@type manager: L{IHTTPClientManager}
"""
self.outRequest = None
self.inRequests = []
if manager is None:
manager = EmptyHTTPClientManager()
self.manager = manager
def lineReceived(self, line):
if not self.inRequests:
# server sending random unrequested data.
self.transport.loseConnection()
return
# If not currently writing this request, set timeout
if self.inRequests[0] is not self.outRequest:
self.setTimeout(self.inputTimeOut)
if self.firstLine:
self.firstLine = 0
self.inRequests[0].gotInitialLine(line)
else:
self.inRequests[0].lineReceived(line)
def rawDataReceived(self, data):
if not self.inRequests:
# Server sending random unrequested data.
self.transport.loseConnection()
return
# If not currently writing this request, set timeout
if self.inRequests[0] is not self.outRequest:
self.setTimeout(self.inputTimeOut)
self.inRequests[0].rawDataReceived(data)
def submitRequest(self, request, closeAfter=True):
"""
@param request: The request to send to a remote server.
@type request: L{ClientRequest}
@param closeAfter: If True the 'Connection: close' header will be sent,
otherwise 'Connection: keep-alive'
@type closeAfter: C{bool}
@rtype: L{twisted.internet.defer.Deferred}
@return: A Deferred which will be called back with the
L{twisted.web2.http.Response} from the server.
"""
# Assert we're in a valid state to submit more
assert self.outRequest is None
assert ((self.readPersistent is PERSIST_NO_PIPELINE
and not self.inRequests)
or self.readPersistent is PERSIST_PIPELINE)
self.manager.clientBusy(self)
if closeAfter:
self.readPersistent = False
self.outRequest = chanRequest = HTTPClientChannelRequest(self,
request, closeAfter)
self.inRequests.append(chanRequest)
chanRequest.submit()
return chanRequest.responseDefer
def requestWriteFinished(self, request):
assert request is self.outRequest
self.outRequest = None
# Tell the manager if more requests can be submitted.
self.setTimeout(self.inputTimeOut)
if self.readPersistent is PERSIST_PIPELINE:
self.manager.clientPipelining(self)
def requestReadFinished(self, request):
assert self.inRequests[0] is request
del self.inRequests[0]
self.firstLine = True
if not self.inRequests:
if self.readPersistent:
self.setTimeout(None)
self.manager.clientIdle(self)
else:
self.transport.loseConnection()
def setReadPersistent(self, persist):
self.readPersistent = persist
if not persist:
# Tell all requests but first to abort.
for request in self.inRequests[1:]:
request.connectionLost(None)
del self.inRequests[1:]
def connectionLost(self, reason):
self.readPersistent = False
self.setTimeout(None)
self.manager.clientGone(self)
# Tell all requests to abort.
for request in self.inRequests:
if request is not None:
request.connectionLost(reason)
|