~bzr-pqm/bzr/bzr.dev

# Copyright (C) 2006 Michael Ellerman

#           modified by John Arbash Meinel (Canonical Ltd)

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

"""Handlers for HTTP Responses.

The purpose of these classes is to provide a uniform interface for clients

to standard HTTP responses, single range responses and multipart range

responses.

"""

from bisect import bisect

from cStringIO import StringIO

import re

from bzrlib import errors

from bzrlib.trace import mutter

class ResponseRange(object):

    """A range in a RangeFile-object."""

    __slots__ = ['_ent_start', '_ent_end', '_data_start']

    def __init__(self, ent_start, ent_end, data_start):

        self._ent_start = ent_start

        self._ent_end = ent_end

        self._data_start = data_start

    def __cmp__(self, other):

        """Compare this to other.

        We need this both for sorting, and so that we can

        bisect the list of ranges.

        """

        if isinstance(other, int):

            # Later on we bisect for a starting point

            # so we allow comparing against a single integer

            return cmp(self._ent_start, other)

        else:

            return cmp((self._ent_start, self._ent_end, self._data_start),

                       (other._ent_start, other._ent_end, other._data_start))

    def __str__(self):

        return "%s(%s-%s,%s)" % (self.__class__.__name__,

                                 self._ent_start, self._ent_end,

                                 self._data_start)

    __repr__ = __str__

class RangeFile(object):

    """File-like object that allow access to partial available data.

    Specified by a set of ranges.

    """

    def __init__(self, path, input_file):

        self._path = path

        self._pos = 0

        self._len = 0

        self._ranges = []

        self._data = input_file.read()

    def _add_range(self, ent_start, ent_end, data_start):

        """Add an entity range.

        :param ent_start: Start offset of entity

        :param ent_end: End offset of entity (inclusive)

        :param data_start: Start offset of data in data stream.

        """

        self._ranges.append(ResponseRange(ent_start, ent_end, data_start))

        self._len = max(self._len, ent_end)

    def _finish_ranges(self):

        self._ranges.sort()

    def read(self, size):

        """Read size bytes from the current position in the file.

        Reading across ranges is not supported.

        """

        # find the last range which has a start <= pos

        i = bisect(self._ranges, self._pos) - 1

        if i < 0 or self._pos > self._ranges[i]._ent_end:

            mutter('Bisect for pos: %s failed. Found offset: %d, ranges:%s',

                   self._pos, i, self._ranges)

            raise errors.InvalidRange(self._path, self._pos)

        r = self._ranges[i]

        # mutter('found range %s %s for pos %s', i, self._ranges[i], self._pos)

        if (self._pos + size - 1) > r._ent_end:

            raise errors.InvalidRange(self._path, self._pos)

        start = r._data_start + (self._pos - r._ent_start)

        end   = start + size

        # mutter("range read %d bytes at %d == %d-%d", size, self._pos,

        #         start, end)

        self._pos += (end-start)

        return self._data[start:end]

    def seek(self, offset, whence=0):

        if whence == 0:

            self._pos = offset

        elif whence == 1:

            self._pos += offset

        elif whence == 2:

            self._pos = self._len + offset

        else:

            raise ValueError("Invalid value %s for whence." % whence)

        if self._pos < 0:

            self._pos = 0

    def tell(self):

        return self._pos

class HttpRangeResponse(RangeFile):

    """A single-range HTTP response."""

    # TODO: jam 20060706 Consider compiling these regexes on demand

    _CONTENT_RANGE_RE = re.compile(

        r'\s*([^\s]+)\s+([0-9]+)-([0-9]+)/([0-9]+)\s*$')

    def __init__(self, path, content_range, input_file):

        # mutter("parsing 206 non-multipart response for %s", path)

        RangeFile.__init__(self, path, input_file)

        start, end = self._parse_range(content_range, path)

        self._add_range(start, end, 0)

        self._finish_ranges()

    @staticmethod

    def _parse_range(range, path='<unknown>'):

        """Parse an http Content-range header and return start + end

        :param range: The value for Content-range

        :param path: Provide to give better error messages.

        :return: (start, end) A tuple of integers

        """

        match = HttpRangeResponse._CONTENT_RANGE_RE.match(range)

        if not match:

            raise errors.InvalidHttpRange(path, range,

                                          "Invalid Content-range")

        rtype, start, end, total = match.groups()

        if rtype != 'bytes':

            raise errors.InvalidHttpRange(path, range,

                    "Unsupported range type '%s'" % (rtype,))

        try:

            start = int(start)

            end = int(end)

        except ValueError, e:

            raise errors.InvalidHttpRange(path, range, str(e))

        return start, end

class HttpMultipartRangeResponse(RangeFile):

    """A multi-range HTTP response."""

    _CONTENT_TYPE_RE = re.compile(

        r'^\s*multipart/byteranges\s*;\s*boundary\s*=\s*("?)([^"]*?)\1\s*$')

    # Start with --<boundary>\r\n

    # and ignore all headers ending in \r\n

    # except for content-range:

    # and find the two trailing \r\n separators

    # indicating the start of the text

    # TODO: jam 20060706 This requires exact conformance

    #       to the spec, we probably could relax the requirement

    #       of \r\n, and use something more like (\r?\n)

    _BOUNDARY_PATT = (

        "^--%s(?:\r\n(?:(?:content-range:([^\r]+))|[^\r]+))+\r\n\r\n")

    def __init__(self, path, content_type, input_file):

        # mutter("parsing 206 multipart response for %s", path)

        # TODO: jam 20060706 Is it valid to initialize a

        #       grandparent without initializing parent?

        RangeFile.__init__(self, path, input_file)

        self.boundary_regex = self._parse_boundary(content_type, path)

        # mutter('response:\n%r', self._data)

        for match in self.boundary_regex.finditer(self._data):

            ent_start, ent_end = HttpRangeResponse._parse_range(match.group(1),

                                                                path)

            self._add_range(ent_start, ent_end, match.end())

        self._finish_ranges()

    @staticmethod

    def _parse_boundary(ctype, path='<unknown>'):

        """Parse the Content-type field.

        This expects a multipart Content-type, and returns a

        regex which is capable of finding the boundaries

        in the multipart data.

        """

        match = HttpMultipartRangeResponse._CONTENT_TYPE_RE.match(ctype)

        if not match:

            raise errors.InvalidHttpContentType(path, ctype,

                    "Expected multipart/byteranges with boundary")

        boundary = match.group(2)

        # mutter('multipart boundary is %s', boundary)

        pattern = HttpMultipartRangeResponse._BOUNDARY_PATT

        return re.compile(pattern % re.escape(boundary),

                          re.IGNORECASE | re.MULTILINE)

def _is_multipart(content_type):

    return content_type.startswith('multipart/byteranges;')

def handle_response(url, code, headers, data):

    """Interpret the code & headers and return a HTTP response.

    This is a factory method which returns an appropriate HTTP response

    based on the code & headers it's given.

    :param url: The url being processed. Mostly for error reporting

    :param code: The integer HTTP response code

    :param headers: A dict-like object that contains the HTTP response headers

    :param data: A file-like object that can be read() to get the

                 requested data

    :return: A file-like object that can seek()+read() the 

             ranges indicated by the headers.

    """

    if code == 206:

        try:

            content_type = headers['Content-Type']

        except KeyError:

            raise errors.InvalidHttpContentType(url, '',

                msg='Missing Content-Type')

        if _is_multipart(content_type):

            # Full fledged multipart response

            return HttpMultipartRangeResponse(url, content_type, data)

        else:

            # A response to a range request, but not multipart

            try:

                content_range = headers['Content-Range']

            except KeyError:

                raise errors.InvalidHttpResponse(url,

                    'Missing the Content-Range header in a 206 range response')

            return HttpRangeResponse(url, content_range, data)

    elif code == 200:

        # A regular non-range response, unfortunately the result from

        # urllib doesn't support seek, so we wrap it in a StringIO

        tell = getattr(data, 'tell', None)

        if tell is None:

            return StringIO(data.read())

        return data

    elif code == 404:

        raise errors.NoSuchFile(url)

    # TODO: jam 20060713 Properly handle redirects (302 Found, etc)

    #       The '_get' code says to follow redirects, we probably 

    #       should actually handle the return values

    else:

        raise errors.InvalidHttpResponse(url, "Unknown response code %s" 

                                              % (code,))