1
# Copyright (C) 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Handlers for HTTP Responses.
19
The purpose of these classes is to provide a uniform interface for clients
20
to standard HTTP responses, single range responses and multipart range
26
from cStringIO import StringIO
36
# A RangeFile expects the following grammar (simplified to outline the
37
# assumptions we rely upon).
43
# whole_file: [content_length_header] data
45
# single_range: content_range_header data
47
# multiple_range: boundary_header boundary (content_range_header data boundary)+
49
class RangeFile(object):
50
"""File-like object that allow access to partial available data.
52
All accesses should happen sequentially since the acquisition occurs during
53
an http response reception (as sockets can't be seeked, we simulate the
54
seek by just reading and discarding the data).
56
The access pattern is defined by a set of ranges discovered as reading
57
progress. Only one range is available at a given time, so all accesses
58
should happen with monotonically increasing offsets.
61
# in _checked_read() below, we may have to discard several MB in the worst
62
# case. To avoid buffering that much, we read and discard by chunks
63
# instead. The underlying file is either a socket or a StringIO, so reading
64
# 8k chunks should be fine.
65
_discarded_buf_size = 8192
67
# maximum size of read requests -- used to avoid MemoryError issues in recv
68
_max_read_size = 512 * 1024
70
def __init__(self, path, infile):
73
:param path: File url, for error reports.
74
:param infile: File-like socket set at body start.
79
# When using multi parts response, this will be set with the headers
80
# associated with the range currently read.
82
# Default to the whole file of unspecified size
85
def set_range(self, start, size):
86
"""Change the range mapping"""
89
# Set the new _pos since that's what we want to expose
90
self._pos = self._start
92
def set_boundary(self, boundary):
93
"""Define the boundary used in a multi parts message.
95
The file should be at the beginning of the body, the first range
96
definition is read and taken into account.
98
self._boundary = boundary
99
# Decode the headers and setup the first range
101
self.read_range_definition()
103
def read_boundary(self):
104
"""Read the boundary headers defining a new range"""
105
boundary_line = '\r\n'
106
while boundary_line == '\r\n':
107
# RFC2616 19.2 Additional CRLFs may precede the first boundary
109
# To be on the safe side we allow it before any boundary line
110
boundary_line = self._file.readline()
112
if boundary_line != '--' + self._boundary + '\r\n':
113
# rfc822.unquote() incorrectly unquotes strings enclosed in <>
114
# IIS 6 and 7 incorrectly wrap boundary strings in <>
115
# together they make a beautiful bug, which we will be gracious
117
if (self._unquote_boundary(boundary_line) !=
118
'--' + self._boundary + '\r\n'):
119
raise errors.InvalidHttpResponse(
121
"Expected a boundary (%s) line, got '%s'"
122
% (self._boundary, boundary_line))
124
def _unquote_boundary(self, b):
125
return b[:2] + rfc822.unquote(b[2:-2]) + b[-2:]
127
def read_range_definition(self):
128
"""Read a new range definition in a multi parts message.
130
Parse the headers including the empty line following them so that we
131
are ready to read the data itself.
133
self._headers = httplib.HTTPMessage(self._file, seekable=0)
134
# Extract the range definition
135
content_range = self._headers.getheader('content-range', None)
136
if content_range is None:
137
raise errors.InvalidHttpResponse(
139
'Content-Range header missing in a multi-part response')
140
self.set_range_from_header(content_range)
142
def set_range_from_header(self, content_range):
143
"""Helper to set the new range from its description in the headers"""
145
rtype, values = content_range.split()
147
raise errors.InvalidHttpRange(self._path, content_range,
150
raise errors.InvalidHttpRange(self._path, content_range,
151
"Unsupported range type '%s'" % rtype)
153
# We don't need total, but note that it may be either the file size
154
# or '*' if the server can't or doesn't want to return the file
156
start_end, total = values.split('/')
157
start, end = start_end.split('-')
161
raise errors.InvalidHttpRange(self._path, content_range,
162
'Invalid range values')
163
size = end - start + 1
165
raise errors.InvalidHttpRange(self._path, content_range,
166
'Invalid range, size <= 0')
167
self.set_range(start, size)
169
def _checked_read(self, size):
170
"""Read the file checking for short reads.
172
The data read is discarded along the way.
177
data = self._file.read(min(remaining, self._discarded_buf_size))
178
remaining -= len(data)
180
raise errors.ShortReadvError(self._path, pos, size,
184
def _seek_to_next_range(self):
185
# We will cross range boundaries
186
if self._boundary is None:
187
# If we don't have a boundary, we can't find another range
188
raise errors.InvalidRange(self._path, self._pos,
189
"Range (%s, %s) exhausted"
190
% (self._start, self._size))
192
self.read_range_definition()
194
def read(self, size=-1):
195
"""Read size bytes from the current position in the file.
197
Reading across ranges is not supported. We rely on the underlying http
198
client to clean the socket if we leave bytes unread. This may occur for
199
the final boundary line of a multipart response or for any range
200
request not entirely consumed by the client (due to offset coalescing)
202
:param size: The number of bytes to read. Leave unspecified or pass
206
and self._pos == self._start + self._size):
210
self._seek_to_next_range()
211
elif self._pos < self._start:
212
raise errors.InvalidRange(
213
self._path, self._pos,
214
"Can't read %s bytes before range (%s, %s)"
215
% (size, self._start, self._size))
217
if size > 0 and self._pos + size > self._start + self._size:
218
raise errors.InvalidRange(
219
self._path, self._pos,
220
"Can't read %s bytes across range (%s, %s)"
221
% (size, self._start, self._size))
223
# read data from file
227
# Don't read past the range definition
228
limited = self._start + self._size - self._pos
230
limited = min(limited, size)
231
osutils.pumpfile(self._file, buffer, limited, self._max_read_size)
232
data = buffer.getvalue()
234
# Update _pos respecting the data effectively read
235
self._pos += len(data)
238
def seek(self, offset, whence=0):
239
start_pos = self._pos
243
final_pos = start_pos + offset
246
final_pos = self._start + self._size + offset # offset < 0
248
raise errors.InvalidRange(
249
self._path, self._pos,
250
"RangeFile: can't seek from end while size is unknown")
252
raise ValueError("Invalid value %s for whence." % whence)
254
if final_pos < self._pos:
255
# Can't seek backwards
256
raise errors.InvalidRange(
257
self._path, self._pos,
258
'RangeFile: trying to seek backwards to %s' % final_pos)
261
cur_limit = self._start + self._size
262
while final_pos > cur_limit:
263
# We will cross range boundaries
264
remain = cur_limit - self._pos
266
# Finish reading the current range
267
self._checked_read(remain)
268
self._seek_to_next_range()
269
cur_limit = self._start + self._size
271
size = final_pos - self._pos
272
if size > 0: # size can be < 0 if we crossed a range boundary
273
# We don't need the data, just read it and throw it away
274
self._checked_read(size)
280
def handle_response(url, code, msg, data):
281
"""Interpret the code & headers and wrap the provided data in a RangeFile.
283
This is a factory method which returns an appropriate RangeFile based on
284
the code & headers it's given.
286
:param url: The url being processed. Mostly for error reporting
287
:param code: The integer HTTP response code
288
:param msg: An HTTPMessage containing the headers for the response
289
:param data: A file-like object that can be read() to get the
291
:return: A file-like object that can seek()+read() the
292
ranges indicated by the headers.
294
rfile = RangeFile(url, data)
297
size = msg.getheader('content-length', None)
302
rfile.set_range(0, size)
304
content_type = msg.getheader('content-type', None)
305
if content_type is None:
306
# When there is no content-type header we treat the response as
307
# being of type 'application/octet-stream' as per RFC2616 section
309
# Therefore it is obviously not multipart
310
content_type = 'application/octet-stream'
313
is_multipart = (msg.getmaintype() == 'multipart'
314
and msg.getsubtype() == 'byteranges')
317
# Full fledged multipart response
318
rfile.set_boundary(msg.getparam('boundary'))
320
# A response to a range request, but not multipart
321
content_range = msg.getheader('content-range', None)
322
if content_range is None:
323
raise errors.InvalidHttpResponse(url,
324
'Missing the Content-Range header in a 206 range response')
325
rfile.set_range_from_header(content_range)
327
raise errors.InvalidHttpResponse(url,
328
'Unknown response code %s' % code)
added
removed
bzrlib/transport/http/response.py
