/usr/lib/python2.7/dist-packages/twext/web2/http.py is in calendarserver 5.2+dfsg-1.
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 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 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 | # -*- test-case-name: twext.web2.test.test_http -*-
##
# Copyright (c) 2001-2004 Twisted Matrix Laboratories.
# Copyright (c) 2010-2014 Apple Computer, Inc. All rights reserved.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#
##
"""HyperText Transfer Protocol implementation.
The second coming.
Maintainer: James Y Knight
"""
# import traceback; log.info(''.join(traceback.format_stack()))
import json
import time
from twisted.internet import interfaces, error
from twisted.python import components
from twisted.web.template import Element, XMLString, renderer, flattenString
from zope.interface import implements
from twext.python.log import Logger
from twext.web2 import responsecode
from twext.web2 import http_headers
from twext.web2 import iweb
from twext.web2 import stream
from twext.web2.stream import IByteStream, readAndDiscard
log = Logger()
defaultPortForScheme = {'http': 80, 'https': 443, 'ftp': 21}
def splitHostPort(scheme, hostport):
"""Split the host in "host:port" format into host and port fields.
If port was not specified, use the default for the given scheme, if
known. Returns a tuple of (hostname, portnumber)."""
# Split hostport into host and port
hostport = hostport.split(':', 1)
try:
if len(hostport) == 2:
return hostport[0], int(hostport[1])
except ValueError:
pass
return hostport[0], defaultPortForScheme.get(scheme, 0)
def parseVersion(strversion):
"""Parse version strings of the form Protocol '/' Major '.' Minor. E.g. 'HTTP/1.1'.
Returns (protocol, major, minor).
Will raise ValueError on bad syntax."""
proto, strversion = strversion.split('/')
major, minor = strversion.split('.')
major, minor = int(major), int(minor)
if major < 0 or minor < 0:
raise ValueError("negative number")
return (proto.lower(), major, minor)
class HTTPError(Exception):
def __init__(self, codeOrResponse):
"""An Exception for propagating HTTP Error Responses.
@param codeOrResponse: The numeric HTTP code or a complete http.Response
object.
@type codeOrResponse: C{int} or L{http.Response}
"""
self.response = iweb.IResponse(codeOrResponse)
Exception.__init__(self, str(self.response))
def __repr__(self):
return "<%s %s>" % (self.__class__.__name__, self.response)
class Response(object):
"""An object representing an HTTP Response to be sent to the client.
"""
implements(iweb.IResponse)
code = responsecode.OK
headers = None
stream = None
def __init__(self, code=None, headers=None, stream=None):
"""
@param code: The HTTP status code for this Response
@type code: C{int}
@param headers: Headers to be sent to the client.
@type headers: C{dict}, L{twext.web2.http_headers.Headers}, or
C{None}
@param stream: Content body to send to the HTTP client
@type stream: L{twext.web2.stream.IByteStream}
"""
if code is not None:
self.code = int(code)
if headers is not None:
if isinstance(headers, dict):
headers = http_headers.Headers(headers)
self.headers = headers
else:
self.headers = http_headers.Headers()
if stream is not None:
self.stream = IByteStream(stream)
def __repr__(self):
if self.stream is None:
streamlen = None
else:
streamlen = self.stream.length
return "<%s.%s code=%d, streamlen=%s>" % (self.__module__, self.__class__.__name__, self.code, streamlen)
class StatusResponseElement(Element):
"""
Render the HTML for a L{StatusResponse}
"""
loader = XMLString("""<html
xmlns:t="http://twistedmatrix.com/ns/twisted.web.template/0.1"
t:render="response"><head><title><t:slot name="title"
/></title></head><body><h1><t:slot name="title"
/></h1><p><t:slot name="description"
/></p></body></html>""")
def __init__(self, title, description):
super(StatusResponseElement, self).__init__()
self.title = title
self.description = description
@renderer
def response(self, request, tag):
"""
Top-level renderer.
"""
return tag.fillSlots(title=self.title, description=self.description)
class StatusResponse (Response):
"""
A L{Response} object which simply contains a status code and a description
of what happened.
"""
def __init__(self, code, description, title=None):
"""
@param code: a response code in L{responsecode.RESPONSES}.
@param description: a string description.
@param title: the message title. If not specified or C{None}, defaults
to C{responsecode.RESPONSES[code]}.
"""
if title is None:
title = responsecode.RESPONSES[code]
element = StatusResponseElement(title, description)
out = []
flattenString(None, element).addCallback(out.append)
mime_params = {"charset": "utf-8"}
super(StatusResponse, self).__init__(code=code, stream=out[0])
self.headers.setHeader(
"content-type", http_headers.MimeType("text", "html", mime_params)
)
self.description = description
def __repr__(self):
return "<%s %s %s>" % (self.__class__.__name__, self.code, self.description)
class RedirectResponse (StatusResponse):
"""
A L{Response} object that contains a redirect to another network location.
"""
def __init__(self, location, temporary=False):
"""
@param location: the URI to redirect to.
@param temporary: whether it's a temporary redirect or permanent
"""
code = responsecode.TEMPORARY_REDIRECT if temporary else responsecode.MOVED_PERMANENTLY
super(RedirectResponse, self).__init__(
code,
"Document moved to %s." % (location,)
)
self.headers.setHeader("location", location)
def NotModifiedResponse(oldResponse=None):
if oldResponse is not None:
headers = http_headers.Headers()
for header in (
# Required from sec 10.3.5:
'date', 'etag', 'content-location', 'expires',
'cache-control', 'vary',
# Others:
'server', 'proxy-authenticate', 'www-authenticate', 'warning'):
value = oldResponse.headers.getRawHeaders(header)
if value is not None:
headers.setRawHeaders(header, value)
else:
headers = None
return Response(code=responsecode.NOT_MODIFIED, headers=headers)
def checkPreconditions(request, response=None, entityExists=True, etag=None, lastModified=None):
"""Check to see if this request passes the conditional checks specified
by the client. May raise an HTTPError with result codes L{NOT_MODIFIED}
or L{PRECONDITION_FAILED}, as appropriate.
This function is called automatically as an output filter for GET and
HEAD requests. With GET/HEAD, it is not important for the precondition
check to occur before doing the action, as the method is non-destructive.
However, if you are implementing other request methods, like PUT
for your resource, you will need to call this after determining
the etag and last-modified time of the existing resource but
before actually doing the requested action. In that case,
This examines the appropriate request headers for conditionals,
(If-Modified-Since, If-Unmodified-Since, If-Match, If-None-Match,
or If-Range), compares with the etag and last and
and then sets the response code as necessary.
@param response: This should be provided for GET/HEAD methods. If
it is specified, the etag and lastModified arguments will
be retrieved automatically from the response headers and
shouldn't be separately specified. Not providing the
response with a GET request may cause the emitted
"Not Modified" responses to be non-conformant.
@param entityExists: Set to False if the entity in question doesn't
yet exist. Necessary for PUT support with 'If-None-Match: *'.
@param etag: The etag of the resource to check against, or None.
@param lastModified: The last modified date of the resource to check
against, or None.
@raise: HTTPError: Raised when the preconditions fail, in order to
abort processing and emit an error page.
"""
if response:
assert etag is None and lastModified is None
# if the code is some sort of error code, don't do anything
if not ((response.code >= 200 and response.code <= 299)
or response.code == responsecode.PRECONDITION_FAILED):
return False
etag = response.headers.getHeader("etag")
lastModified = response.headers.getHeader("last-modified")
def matchETag(tags, allowWeak):
if entityExists and '*' in tags:
return True
if etag is None:
return False
return ((allowWeak or not etag.weak) and
([etagmatch for etagmatch in tags if etag.match(etagmatch, strongCompare=not allowWeak)]))
# First check if-match/if-unmodified-since
# If either one fails, we return PRECONDITION_FAILED
match = request.headers.getHeader("if-match")
if match:
if not matchETag(match, False):
raise HTTPError(StatusResponse(responsecode.PRECONDITION_FAILED, "Requested resource does not have a matching ETag."))
unmod_since = request.headers.getHeader("if-unmodified-since")
if unmod_since:
if not lastModified or lastModified > unmod_since:
raise HTTPError(StatusResponse(responsecode.PRECONDITION_FAILED, "Requested resource has changed."))
# Now check if-none-match/if-modified-since.
# This bit is tricky, because of the requirements when both IMS and INM
# are present. In that case, you can't return a failure code
# unless *both* checks think it failed.
# Also, if the INM check succeeds, ignore IMS, because INM is treated
# as more reliable.
# I hope I got the logic right here...the RFC is quite poorly written
# in this area. Someone might want to verify the testcase against
# RFC wording.
# If IMS header is later than current time, ignore it.
notModified = None
ims = request.headers.getHeader('if-modified-since')
if ims:
notModified = (ims < time.time() and lastModified and lastModified <= ims)
inm = request.headers.getHeader("if-none-match")
if inm:
if request.method in ("HEAD", "GET"):
# If it's a range request, don't allow a weak ETag, as that
# would break.
canBeWeak = not request.headers.hasHeader('Range')
if notModified != False and matchETag(inm, canBeWeak):
raise HTTPError(NotModifiedResponse(response))
else:
if notModified != False and matchETag(inm, False):
raise HTTPError(StatusResponse(responsecode.PRECONDITION_FAILED, "Requested resource has a matching ETag."))
else:
if notModified == True:
raise HTTPError(NotModifiedResponse(response))
def checkIfRange(request, response):
"""Checks for the If-Range header, and if it exists, checks if the
test passes. Returns true if the server should return partial data."""
ifrange = request.headers.getHeader("if-range")
if ifrange is None:
return True
if isinstance(ifrange, http_headers.ETag):
return ifrange.match(response.headers.getHeader("etag"), strongCompare=True)
else:
return ifrange == response.headers.getHeader("last-modified")
class _NotifyingProducerStream(stream.ProducerStream):
doStartReading = None
def __init__(self, length=None, doStartReading=None):
stream.ProducerStream.__init__(self, length=length)
self.doStartReading = doStartReading
def read(self):
if self.doStartReading is not None:
doStartReading = self.doStartReading
self.doStartReading = None
doStartReading()
return stream.ProducerStream.read(self)
def write(self, data):
self.doStartReading = None
stream.ProducerStream.write(self, data)
def finish(self):
self.doStartReading = None
stream.ProducerStream.finish(self)
# response codes that must have empty bodies
NO_BODY_CODES = (responsecode.NO_CONTENT, responsecode.NOT_MODIFIED)
class Request(object):
"""A HTTP request.
Subclasses should override the process() method to determine how
the request will be processed.
@ivar method: The HTTP method that was used.
@ivar uri: The full URI that was requested (includes arguments).
@ivar headers: All received headers
@ivar clientproto: client HTTP version
@ivar stream: incoming data stream.
"""
implements(iweb.IRequest, interfaces.IConsumer)
known_expects = ('100-continue',)
def __init__(self, chanRequest, command, path, version, contentLength, headers):
"""
@param chanRequest: the channel request we're associated with.
"""
self.chanRequest = chanRequest
self.method = command
self.uri = path
self.clientproto = version
self.headers = headers
if '100-continue' in self.headers.getHeader('expect', ()):
doStartReading = self._sendContinue
else:
doStartReading = None
self.stream = _NotifyingProducerStream(contentLength, doStartReading)
self.stream.registerProducer(self.chanRequest, True)
def checkExpect(self):
"""Ensure there are no expectations that cannot be met.
Checks Expect header against self.known_expects."""
expects = self.headers.getHeader('expect', ())
for expect in expects:
if expect not in self.known_expects:
raise HTTPError(responsecode.EXPECTATION_FAILED)
def process(self):
"""Called by channel to let you process the request.
Can be overridden by a subclass to do something useful."""
pass
def handleContentChunk(self, data):
"""Callback from channel when a piece of data has been received.
Puts the data in .stream"""
self.stream.write(data)
def handleContentComplete(self):
"""Callback from channel when all data has been received. """
self.stream.unregisterProducer()
self.stream.finish()
def connectionLost(self, reason):
"""connection was lost"""
pass
def __repr__(self):
return '<%s %s %s>' % (self.method, self.uri, self.clientproto)
def _sendContinue(self):
self.chanRequest.writeIntermediateResponse(responsecode.CONTINUE)
def _reallyFinished(self, x):
"""We are finished writing data."""
self.chanRequest.finish()
def _finished(self, x):
"""
We are finished writing data.
But we need to check that we have also finished reading all data as we
might have sent a, for example, 401 response before we read any data.
To make sure that the stream/producer sequencing works properly we need
to discard the remaining data in the request.
"""
if self.stream.length != 0:
return readAndDiscard(self.stream).addCallback(self._reallyFinished).addErrback(self._error)
else:
self._reallyFinished(x)
def _error(self, reason):
if reason.check(error.ConnectionLost):
log.info("Request error: {message}", message=reason.getErrorMessage())
else:
log.failure("Request error", reason)
# Only bother with cleanup on errors other than lost connection.
self.chanRequest.abortConnection()
def writeResponse(self, response):
"""
Write a response.
"""
if self.stream.doStartReading is not None:
# Expect: 100-continue was requested, but 100 response has not been
# sent, and there's a possibility that data is still waiting to be
# sent.
#
# Ideally this means the remote side will not send any data.
# However, because of compatibility requirements, it might timeout,
# and decide to do so anyways at the same time we're sending back
# this response. Thus, the read state is unknown after this.
# We must close the connection.
self.chanRequest.channel.setReadPersistent(False)
# Nothing more will be read
self.chanRequest.allContentReceived()
if response.code != responsecode.NOT_MODIFIED:
# Not modified response is *special* and doesn't get a content-length.
if response.stream is None:
response.headers.setHeader('content-length', 0)
elif response.stream.length is not None:
response.headers.setHeader('content-length', response.stream.length)
self.chanRequest.writeHeaders(response.code, response.headers)
# if this is a "HEAD" request, or a special response code,
# don't return any data.
if self.method == "HEAD" or response.code in NO_BODY_CODES:
if response.stream is not None:
response.stream.close()
self._finished(None)
return
d = stream.StreamProducer(response.stream).beginProducing(self.chanRequest)
d.addCallback(self._finished).addErrback(self._error)
class XMLResponse (Response):
"""
XML L{Response} object.
Renders itself as an XML document.
"""
def __init__(self, code, element):
"""
@param xml_responses: an iterable of davxml.Response objects.
"""
Response.__init__(self, code, stream=element.toxml())
self.headers.setHeader("content-type", http_headers.MimeType("text", "xml"))
class JSONResponse (Response):
"""
JSON L{Response} object.
Renders itself as an JSON document.
"""
def __init__(self, code, jobj):
"""
@param xml_responses: an iterable of davxml.Response objects.
"""
Response.__init__(self, code, stream=json.dumps(jobj))
self.headers.setHeader("content-type", http_headers.MimeType("application", "json"))
components.registerAdapter(Response, int, iweb.IResponse)
__all__ = ['HTTPError', 'NotModifiedResponse', 'Request', 'Response', 'StatusResponse', 'RedirectResponse', 'checkIfRange', 'checkPreconditions', 'defaultPortForScheme', 'parseVersion', 'splitHostPort', "XMLResponse", "JSONResponse"]
|