← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remotebranch.py

  • Committer: Robert Collins
  • Date: 2005-09-30 14:27:41 UTC
  • mto: This revision was merged to the branch mainline in revision 1397.
  • Revision ID: robertc@robertcollins.net-20050930142741-fc326c828b5bbefd
text_version and name_version unification looking reasonable

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/remotebranch.py
 
1
# Copyright (C) 2005 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
 
 
18
"""Proxy object for access to remote branches.
 
19
 
 
20
At the moment remote branches are only for HTTP and only for read
 
21
access.
 
22
"""
 
23
 
 
24
 
 
25
import gzip
 
26
from cStringIO import StringIO
 
27
import os
 
28
import urllib2
 
29
import urlparse
 
30
 
 
31
from bzrlib.errors import BzrError, BzrCheckError
 
32
from bzrlib.branch import Branch, LocalBranch, BZR_BRANCH_FORMAT_5
 
33
from bzrlib.trace import mutter
 
34
from bzrlib.weavestore import WeaveStore
 
35
from bzrlib.xml5 import serializer_v5
 
36
 
 
37
 
 
38
# velocitynet.com.au transparently proxies connections and thereby
 
39
# breaks keep-alive -- sucks!
 
40
 
 
41
 
 
42
ENABLE_URLGRABBER = False
 
43
 
 
44
from bzrlib.errors import BzrError, NoSuchRevision
 
45
 
 
46
class GetFailed(BzrError):
 
47
    def __init__(self, url, status):
 
48
        BzrError.__init__(self, "Get %s failed with status %s" % (url, status))
 
49
        self.url = url
 
50
        self.status = status
 
51
 
 
52
if ENABLE_URLGRABBER:
 
53
    import util.urlgrabber
 
54
    import util.urlgrabber.keepalive
 
55
    util.urlgrabber.keepalive.DEBUG = 0
 
56
    def get_url(path, compressed=False):
 
57
        try:
 
58
            url = path
 
59
            if compressed:
 
60
                url += '.gz'
 
61
            mutter("grab url %s" % url)
 
62
            url_f = util.urlgrabber.urlopen(url, keepalive=1, close_connection=0)
 
63
            if url_f.status != 200:
 
64
                raise GetFailed(url, url_f.status)
 
65
            if not compressed:
 
66
                return url_f
 
67
            else:
 
68
                return gzip.GzipFile(fileobj=StringIO(url_f.read()))
 
69
        except urllib2.URLError, e:
 
70
            raise BzrError("remote fetch failed: %r: %s" % (url, e))
 
71
else:
 
72
    def get_url(url, compressed=False):
 
73
        import urllib2
 
74
        if compressed:
 
75
            url += '.gz'
 
76
        mutter("get_url %s" % url)
 
77
        url_f = urllib2.urlopen(url)
 
78
        if compressed:
 
79
            return gzip.GzipFile(fileobj=StringIO(url_f.read()))
 
80
        else:
 
81
            return url_f
 
82
 
 
83
 
 
84
def _find_remote_root(url):
 
85
    """Return the prefix URL that corresponds to the branch root."""
 
86
    orig_url = url
 
87
    while True:
 
88
        try:
 
89
            fmt_url = url + '/.bzr/branch-format'
 
90
            ff = get_url(fmt_url)
 
91
            fmt = ff.read()
 
92
            ff.close()
 
93
 
 
94
            if fmt != BZR_BRANCH_FORMAT_5:
 
95
                raise BzrError("sorry, branch format %r not supported at url %s"
 
96
                               % (fmt, url))
 
97
            
 
98
            return url
 
99
        except urllib2.URLError:
 
100
            pass
 
101
 
 
102
        scheme, host, path = list(urlparse.urlparse(url))[:3]
 
103
        # discard params, query, fragment
 
104
        
 
105
        # strip off one component of the path component
 
106
        idx = path.rfind('/')
 
107
        if idx == -1 or path == '/':
 
108
            raise BzrError('no branch root found for URL %s'
 
109
                           ' or enclosing directories'
 
110
                           % orig_url)
 
111
        path = path[:idx]
 
112
        url = urlparse.urlunparse((scheme, host, path, '', '', ''))
 
113
        
 
114
 
 
115
 
 
116
class RemoteBranch(LocalBranch):
 
117
 
 
118
    def __init__(self, baseurl, find_root=True):
 
119
        """Create new proxy for a remote branch."""
 
120
        # circular import protection
 
121
        from bzrlib.store import RemoteStore
 
122
        if find_root:
 
123
            self.base = _find_remote_root(baseurl)
 
124
        else:
 
125
            self.base = baseurl
 
126
        self._check_format(False)
 
127
        # is guaranteed to be a v5 store
 
128
 
 
129
        cfn = self.controlfilename
 
130
        assert self._branch_format == 5
 
131
        self.control_weaves = WeaveStore(cfn([]), get_url)
 
132
        self.weave_store = WeaveStore(cfn('weaves'), get_url)
 
133
        self.revision_store = RemoteStore(cfn('revision-store'))
 
134
 
 
135
    def __str__(self):
 
136
        b = getattr(self, 'baseurl', 'undefined')
 
137
        return '%s(%r)' % (self.__class__.__name__, b)
 
138
 
 
139
    __repr__ = __str__
 
140
 
 
141
    def setup_caching(self, cache_root):
 
142
        """Set up cached stores located under cache_root"""
 
143
        from bzrlib.meta_store import CachedStore
 
144
        for store_name in ('revision_store',):
 
145
            if not isinstance(getattr(self, store_name), CachedStore):
 
146
                cache_path = os.path.join(cache_root, store_name)
 
147
                os.mkdir(cache_path)
 
148
                new_store = CachedStore(getattr(self, store_name), cache_path)
 
149
                setattr(self, store_name, new_store)
 
150
 
 
151
    def controlfile(self, filename, mode):
 
152
        if mode not in ('rb', 'rt', 'r'):
 
153
            raise BzrError("file mode %r not supported for remote branches" % mode)
 
154
        return get_url(self.base + '/.bzr/' + filename, False)
 
155
 
 
156
 
 
157
    def lock_read(self):
 
158
        # no locking for remote branches yet
 
159
        pass
 
160
 
 
161
    def lock_write(self):
 
162
        from errors import LockError
 
163
        raise LockError("write lock not supported for remote branch %s"
 
164
                        % self.base)
 
165
 
 
166
    def unlock(self):
 
167
        pass
 
168
    
 
169
 
 
170
    def relpath(self, path):
 
171
        if not path.startswith(self.base):
 
172
            raise BzrError('path %r is not under base URL %r'
 
173
                           % (path, self.base))
 
174
        pl = len(self.base)
 
175
        return path[pl:].lstrip('/')
 
176
 
 
177
 
 
178
    def get_revision(self, revision_id):
 
179
        try:
 
180
            revf = self.revision_store[revision_id]
 
181
        except KeyError:
 
182
            raise NoSuchRevision(self, revision_id)
 
183
        r = serializer_v5.read_revision(revf)
 
184
        if r.revision_id != revision_id:
 
185
            raise BzrCheckError('revision stored as {%s} actually contains {%s}'
 
186
                                % (revision_id, r.revision_id))
 
187
        return r