← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/smart/client.py

  • Committer: Eric Holmberg
  • Date: 2008-05-06 15:02:27 UTC
  • mto: This revision was merged to the branch mainline in revision 3449.
  • Revision ID: eholmberg@arrow.com-20080506150227-l3arq1yntdvnoxum
Fix for Bug #215426 in which bzr can cause a MemoryError in socket.recv while
downloading large packs over http.  This patch limits the request size for
socket.recv to avoid this problem.

Changes:
Added mock file object bzrlib.tests.file_utils.
Added new parameters to bzrlib.osutils.pumpfile.
Added unit tests for bzrlib.osutils.pumpfile.
Added usage of bzrlib.osutils.pumpfile to bzrlib.transport.http.response.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/smart/client.py
 
1
# Copyright (C) 2006 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
import urllib
 
18
from urlparse import urlparse
 
19
 
 
20
from bzrlib.smart import protocol
 
21
from bzrlib import (
 
22
    errors,
 
23
    urlutils,
 
24
    )
 
25
 
 
26
 
 
27
class _SmartClient(object):
 
28
 
 
29
    def __init__(self, medium, base):
 
30
        """Constructor.
 
31
 
 
32
        :param medium: a SmartClientMedium
 
33
        :param base: a URL
 
34
        """
 
35
        self._medium = medium
 
36
        self._base = base
 
37
 
 
38
    def _build_client_protocol(self):
 
39
        version = self._medium.protocol_version()
 
40
        request = self._medium.get_request()
 
41
        if version == 2:
 
42
            smart_protocol = protocol.SmartClientRequestProtocolTwo(request)
 
43
        else:
 
44
            smart_protocol = protocol.SmartClientRequestProtocolOne(request)
 
45
        return smart_protocol
 
46
 
 
47
    def call(self, method, *args):
 
48
        """Call a method on the remote server."""
 
49
        result, protocol = self.call_expecting_body(method, *args)
 
50
        protocol.cancel_read_body()
 
51
        return result
 
52
 
 
53
    def call_expecting_body(self, method, *args):
 
54
        """Call a method and return the result and the protocol object.
 
55
        
 
56
        The body can be read like so::
 
57
 
 
58
            result, smart_protocol = smart_client.call_expecting_body(...)
 
59
            body = smart_protocol.read_body_bytes()
 
60
        """
 
61
        smart_protocol = self._build_client_protocol()
 
62
        smart_protocol.call(method, *args)
 
63
        return smart_protocol.read_response_tuple(expect_body=True), smart_protocol
 
64
 
 
65
    def call_with_body_bytes(self, method, args, body):
 
66
        """Call a method on the remote server with body bytes."""
 
67
        if type(method) is not str:
 
68
            raise TypeError('method must be a byte string, not %r' % (method,))
 
69
        for arg in args:
 
70
            if type(arg) is not str:
 
71
                raise TypeError('args must be byte strings, not %r' % (args,))
 
72
        if type(body) is not str:
 
73
            raise TypeError('body must be byte string, not %r' % (body,))
 
74
        smart_protocol = self._build_client_protocol()
 
75
        smart_protocol.call_with_body_bytes((method, ) + args, body)
 
76
        return smart_protocol.read_response_tuple()
 
77
 
 
78
    def call_with_body_bytes_expecting_body(self, method, args, body):
 
79
        """Call a method on the remote server with body bytes."""
 
80
        if type(method) is not str:
 
81
            raise TypeError('method must be a byte string, not %r' % (method,))
 
82
        for arg in args:
 
83
            if type(arg) is not str:
 
84
                raise TypeError('args must be byte strings, not %r' % (args,))
 
85
        if type(body) is not str:
 
86
            raise TypeError('body must be byte string, not %r' % (body,))
 
87
        smart_protocol = self._build_client_protocol()
 
88
        smart_protocol.call_with_body_bytes((method, ) + args, body)
 
89
        return smart_protocol.read_response_tuple(expect_body=True), smart_protocol
 
90
 
 
91
    def remote_path_from_transport(self, transport):
 
92
        """Convert transport into a path suitable for using in a request.
 
93
        
 
94
        Note that the resulting remote path doesn't encode the host name or
 
95
        anything but path, so it is only safe to use it in requests sent over
 
96
        the medium from the matching transport.
 
97
        """
 
98
        base = self._base
 
99
        if (base.startswith('bzr+http://') or base.startswith('bzr+https://')
 
100
            or base.startswith('http://') or base.startswith('https://')):
 
101
            medium_base = self._base
 
102
        else:
 
103
            medium_base = urlutils.join(self._base, '/')
 
104
            
 
105
        rel_url = urlutils.relative_url(medium_base, transport.base)
 
106
        return urllib.unquote(rel_url)
 
107