/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/transport/http/response.py

  • Committer: Jelmer Vernooij
  • Date: 2019-11-03 12:38:45 UTC
  • mto: This revision was merged to the branch mainline in revision 7413.
  • Revision ID: jelmer@jelmer.uk-20191103123845-5726o8n89u0i5bjw
Fix tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/transport/http/response.py
1
 
# Copyright (C) 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2006-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
21
21
responses.
22
22
"""
23
23
 
24
 
 
25
 
import httplib
26
 
from cStringIO import StringIO
27
 
import rfc822
28
 
 
29
 
from bzrlib import (
 
24
from __future__ import absolute_import
 
25
 
 
26
import cgi
 
27
import os
 
28
try:
 
29
    import http.client as http_client
 
30
except ImportError:  # python < 3
 
31
    import httplib as http_client
 
32
try:
 
33
    import email.utils as email_utils
 
34
except ImportError:  # python < 3
 
35
    import rfc822 as email_utils
 
36
 
 
37
from ... import (
30
38
    errors,
31
 
    trace,
32
39
    osutils,
33
40
    )
34
 
 
 
41
from ...sixish import (
 
42
    BytesIO,
 
43
    PY3,
 
44
    )
 
45
 
 
46
 
 
47
class ResponseFile(object):
 
48
    """A wrapper around the http socket containing the result of a GET request.
 
49
 
 
50
    Only read() and seek() (forward) are supported.
 
51
 
 
52
    """
 
53
 
 
54
    def __init__(self, path, infile):
 
55
        """Constructor.
 
56
 
 
57
        :param path: File url, for error reports.
 
58
 
 
59
        :param infile: File-like socket set at body start.
 
60
        """
 
61
        self._path = path
 
62
        self._file = infile
 
63
        self._pos = 0
 
64
 
 
65
    def close(self):
 
66
        """Close this file.
 
67
 
 
68
        Dummy implementation for consistency with the 'file' API.
 
69
        """
 
70
 
 
71
    def __enter__(self):
 
72
        return self
 
73
 
 
74
    def __exit__(self, exc_type, exc_val, exc_tb):
 
75
        return False  # propogate exceptions.
 
76
 
 
77
    def read(self, size=None):
 
78
        """Read size bytes from the current position in the file.
 
79
 
 
80
        :param size:  The number of bytes to read.  Leave unspecified or pass
 
81
            -1 to read to EOF.
 
82
        """
 
83
        if size is None and not PY3:
 
84
            size = -1
 
85
        data = self._file.read(size)
 
86
        self._pos += len(data)
 
87
        return data
 
88
 
 
89
    def readline(self):
 
90
        data = self._file.readline()
 
91
        self._pos += len(data)
 
92
        return data
 
93
 
 
94
    def __iter__(self):
 
95
        while True:
 
96
            line = self.readline()
 
97
            if not line:
 
98
                return
 
99
            yield line
 
100
 
 
101
    def tell(self):
 
102
        return self._pos
 
103
 
 
104
    def seek(self, offset, whence=os.SEEK_SET):
 
105
        if whence == os.SEEK_SET:
 
106
            if offset < self._pos:
 
107
                raise AssertionError(
 
108
                    "Can't seek backwards, pos: %s, offset: %s"
 
109
                    % (self._pos, offset))
 
110
            to_discard = offset - self._pos
 
111
        elif whence == os.SEEK_CUR:
 
112
            to_discard = offset
 
113
        else:
 
114
            raise AssertionError("Can't seek backwards")
 
115
        if to_discard:
 
116
            # Just discard the unwanted bytes
 
117
            self.read(to_discard)
35
118
 
36
119
# A RangeFile expects the following grammar (simplified to outline the
37
120
# assumptions we rely upon).
38
121
 
39
 
# file: whole_file
40
 
#     | single_range
 
122
# file: single_range
41
123
#     | multiple_range
42
124
 
43
 
# whole_file: [content_length_header] data
44
 
 
45
125
# single_range: content_range_header data
46
126
 
47
127
# multiple_range: boundary_header boundary (content_range_header data boundary)+
48
128
 
49
 
class RangeFile(object):
 
129
 
 
130
class RangeFile(ResponseFile):
50
131
    """File-like object that allow access to partial available data.
51
132
 
52
133
    All accesses should happen sequentially since the acquisition occurs during
60
141
 
61
142
    # in _checked_read() below, we may have to discard several MB in the worst
62
143
    # 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
 
144
    # instead. The underlying file is either a socket or a BytesIO, so reading
64
145
    # 8k chunks should be fine.
65
146
    _discarded_buf_size = 8192
66
147
 
71
152
        """Constructor.
72
153
 
73
154
        :param path: File url, for error reports.
 
155
 
74
156
        :param infile: File-like socket set at body start.
75
157
        """
76
 
        self._path = path
77
 
        self._file = infile
 
158
        super(RangeFile, self).__init__(path, infile)
78
159
        self._boundary = None
79
160
        # When using multi parts response, this will be set with the headers
80
161
        # associated with the range currently read.
95
176
        The file should be at the beginning of the body, the first range
96
177
        definition is read and taken into account.
97
178
        """
 
179
        if not isinstance(boundary, bytes):
 
180
            raise TypeError(boundary)
98
181
        self._boundary = boundary
99
182
        # Decode the headers and setup the first range
100
183
        self.read_boundary()
102
185
 
103
186
    def read_boundary(self):
104
187
        """Read the boundary headers defining a new range"""
105
 
        boundary_line = '\r\n'
106
 
        while boundary_line == '\r\n':
 
188
        boundary_line = b'\r\n'
 
189
        while boundary_line == b'\r\n':
107
190
            # RFC2616 19.2 Additional CRLFs may precede the first boundary
108
191
            # string entity.
109
192
            # To be on the safe side we allow it before any boundary line
110
193
            boundary_line = self._file.readline()
111
194
 
112
 
        if boundary_line != '--' + self._boundary + '\r\n':
113
 
            # rfc822.unquote() incorrectly unquotes strings enclosed in <>
 
195
        if boundary_line == b'':
 
196
            # A timeout in the proxy server caused the response to end early.
 
197
            # See launchpad bug 198646.
 
198
            raise errors.HttpBoundaryMissing(
 
199
                self._path,
 
200
                self._boundary)
 
201
 
 
202
        if boundary_line != b'--' + self._boundary + b'\r\n':
 
203
            # email_utils.unquote() incorrectly unquotes strings enclosed in <>
114
204
            # IIS 6 and 7 incorrectly wrap boundary strings in <>
115
205
            # together they make a beautiful bug, which we will be gracious
116
206
            # about here
117
207
            if (self._unquote_boundary(boundary_line) !=
118
 
                '--' + self._boundary + '\r\n'):
 
208
                    b'--' + self._boundary + b'\r\n'):
119
209
                raise errors.InvalidHttpResponse(
120
210
                    self._path,
121
211
                    "Expected a boundary (%s) line, got '%s'"
122
212
                    % (self._boundary, boundary_line))
123
213
 
124
214
    def _unquote_boundary(self, b):
125
 
        return b[:2] + rfc822.unquote(b[2:-2]) + b[-2:]
 
215
        return b[:2] + email_utils.unquote(b[2:-2].decode('ascii')).encode('ascii') + b[-2:]
126
216
 
127
217
    def read_range_definition(self):
128
218
        """Read a new range definition in a multi parts message.
130
220
        Parse the headers including the empty line following them so that we
131
221
        are ready to read the data itself.
132
222
        """
133
 
        self._headers = httplib.HTTPMessage(self._file, seekable=0)
 
223
        if PY3:
 
224
            self._headers = http_client.parse_headers(self._file)
 
225
        else:
 
226
            self._headers = http_client.HTTPMessage(self._file, seekable=0)
134
227
        # Extract the range definition
135
 
        content_range = self._headers.getheader('content-range', None)
 
228
        content_range = self._headers.get('content-range', None)
136
229
        if content_range is None:
137
230
            raise errors.InvalidHttpResponse(
138
231
                self._path,
203
296
            -1 to read to EOF.
204
297
        """
205
298
        if (self._size > 0
206
 
            and self._pos == self._start + self._size):
 
299
                and self._pos == self._start + self._size):
207
300
            if size == 0:
208
 
                return ''
 
301
                return b''
209
302
            else:
210
303
                self._seek_to_next_range()
211
304
        elif self._pos < self._start:
221
314
                    % (size, self._start, self._size))
222
315
 
223
316
        # read data from file
224
 
        buffer = StringIO()
 
317
        buf = BytesIO()
225
318
        limited = size
226
319
        if self._size > 0:
227
320
            # Don't read past the range definition
228
321
            limited = self._start + self._size - self._pos
229
322
            if size >= 0:
230
323
                limited = min(limited, size)
231
 
        osutils.pumpfile(self._file, buffer, limited, self._max_read_size)
232
 
        data = buffer.getvalue()
 
324
        osutils.pumpfile(self._file, buf, limited, self._max_read_size)
 
325
        data = buf.getvalue()
233
326
 
234
327
        # Update _pos respecting the data effectively read
235
328
        self._pos += len(data)
243
336
            final_pos = start_pos + offset
244
337
        elif whence == 2:
245
338
            if self._size > 0:
246
 
                final_pos = self._start + self._size + offset # offset < 0
 
339
                final_pos = self._start + self._size + offset  # offset < 0
247
340
            else:
248
341
                raise errors.InvalidRange(
249
342
                    self._path, self._pos,
269
362
                cur_limit = self._start + self._size
270
363
 
271
364
        size = final_pos - self._pos
272
 
        if size > 0: # size can be < 0 if we crossed a range boundary
 
365
        if size > 0:  # size can be < 0 if we crossed a range boundary
273
366
            # We don't need the data, just read it and throw it away
274
367
            self._checked_read(size)
275
368
 
277
370
        return self._pos
278
371
 
279
372
 
280
 
def handle_response(url, code, msg, data):
 
373
def handle_response(url, code, getheader, data):
281
374
    """Interpret the code & headers and wrap the provided data in a RangeFile.
282
375
 
283
376
    This is a factory method which returns an appropriate RangeFile based on
285
378
 
286
379
    :param url: The url being processed. Mostly for error reporting
287
380
    :param code: The integer HTTP response code
288
 
    :param msg: An HTTPMessage containing the headers for the response
 
381
    :param getheader: Function for retrieving header
289
382
    :param data: A file-like object that can be read() to get the
290
383
                 requested data
291
384
    :return: A file-like object that can seek()+read() the
292
385
             ranges indicated by the headers.
293
386
    """
294
 
    rfile = RangeFile(url, data)
295
387
    if code == 200:
296
388
        # A whole file
297
 
        size = msg.getheader('content-length', None)
298
 
        if size is None:
299
 
            size = -1
300
 
        else:
301
 
            size = int(size)
302
 
        rfile.set_range(0, size)
 
389
        rfile = ResponseFile(url, data)
303
390
    elif code == 206:
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
308
 
            # 7.2.1.
309
 
            # Therefore it is obviously not multipart
310
 
            content_type = 'application/octet-stream'
311
 
            is_multipart = False
312
 
        else:
313
 
            is_multipart = (msg.getmaintype() == 'multipart'
314
 
                            and msg.getsubtype() == 'byteranges')
315
 
 
316
 
        if is_multipart:
317
 
            # Full fledged multipart response
318
 
            rfile.set_boundary(msg.getparam('boundary'))
 
391
        rfile = RangeFile(url, data)
 
392
        # When there is no content-type header we treat the response as
 
393
        # being of type 'application/octet-stream' as per RFC2616 section
 
394
        # 7.2.1.
 
395
        # Therefore it is obviously not multipart
 
396
        content_type = getheader('content-type', 'application/octet-stream')
 
397
        mimetype, options = cgi.parse_header(content_type)
 
398
        if mimetype == 'multipart/byteranges':
 
399
            rfile.set_boundary(options['boundary'].encode('ascii'))
319
400
        else:
320
401
            # A response to a range request, but not multipart
321
 
            content_range = msg.getheader('content-range', None)
 
402
            content_range = getheader('content-range', None)
322
403
            if content_range is None:
323
 
                raise errors.InvalidHttpResponse(url,
324
 
                    'Missing the Content-Range header in a 206 range response')
 
404
                raise errors.InvalidHttpResponse(
 
405
                    url, 'Missing the Content-Range header in a 206 range response')
325
406
            rfile.set_range_from_header(content_range)
326
407
    else:
327
408
        raise errors.InvalidHttpResponse(url,
328
409
                                         'Unknown response code %s' % code)
329
410
 
330
411
    return rfile
331