← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remotebranch.py

add a clean target

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, BZR_BRANCH_FORMAT
 
33
from bzrlib.trace import mutter
 
34
from bzrlib.xml import serializer_v4
 
35
 
 
36
 
 
37
ENABLE_URLGRABBER = False
 
38
 
 
39
from bzrlib.errors import BzrError, NoSuchRevision
 
40
 
 
41
class GetFailed(BzrError):
 
42
    def __init__(self, url, status):
 
43
        BzrError.__init__(self, "Get %s failed with status %s" % (url, status))
 
44
        self.url = url
 
45
        self.status = status
 
46
 
 
47
if ENABLE_URLGRABBER:
 
48
    import util.urlgrabber
 
49
    import util.urlgrabber.keepalive
 
50
    util.urlgrabber.keepalive.DEBUG = 0
 
51
    def get_url(path, compressed=False):
 
52
        try:
 
53
            url = path
 
54
            if compressed:
 
55
                url += '.gz'
 
56
            mutter("grab url %s" % url)
 
57
            url_f = util.urlgrabber.urlopen(url, keepalive=1, close_connection=0)
 
58
            if url_f.status != 200:
 
59
                raise GetFailed(url, url_f.status)
 
60
            if not compressed:
 
61
                return url_f
 
62
            else:
 
63
                return gzip.GzipFile(fileobj=StringIO(url_f.read()))
 
64
        except urllib2.URLError, e:
 
65
            raise BzrError("remote fetch failed: %r: %s" % (url, e))
 
66
else:
 
67
    def get_url(url, compressed=False):
 
68
        import urllib2
 
69
        if compressed:
 
70
            url += '.gz'
 
71
        mutter("get_url %s" % url)
 
72
        url_f = urllib2.urlopen(url)
 
73
        if compressed:
 
74
            return gzip.GzipFile(fileobj=StringIO(url_f.read()))
 
75
        else:
 
76
            return url_f
 
77
 
 
78
 
 
79
 
 
80
def _find_remote_root(url):
 
81
    """Return the prefix URL that corresponds to the branch root."""
 
82
    orig_url = url
 
83
    while True:
 
84
        try:
 
85
            fmt_url = url + '/.bzr/branch-format'
 
86
            ff = get_url(fmt_url)
 
87
            fmt = ff.read()
 
88
            ff.close()
 
89
 
 
90
            fmt = fmt.rstrip('\r\n')
 
91
            if fmt != BZR_BRANCH_FORMAT.rstrip('\r\n'):
 
92
                raise BzrError("sorry, branch format %r not supported at url %s"
 
93
                               % (fmt, url))
 
94
            
 
95
            return url
 
96
        except urllib2.URLError:
 
97
            pass
 
98
 
 
99
        scheme, host, path = list(urlparse.urlparse(url))[:3]
 
100
        # discard params, query, fragment
 
101
        
 
102
        # strip off one component of the path component
 
103
        idx = path.rfind('/')
 
104
        if idx == -1 or path == '/':
 
105
            raise BzrError('no branch root found for URL %s'
 
106
                           ' or enclosing directories'
 
107
                           % orig_url)
 
108
        path = path[:idx]
 
109
        url = urlparse.urlunparse((scheme, host, path, '', '', ''))
 
110
        
 
111
 
 
112
 
 
113
class RemoteBranch(Branch):
 
114
    def __init__(self, baseurl, find_root=True):
 
115
        """Create new proxy for a remote branch."""
 
116
        if find_root:
 
117
            self.base = _find_remote_root(baseurl)
 
118
        else:
 
119
            self.base = baseurl
 
120
            self._check_format()
 
121
 
 
122
        self.inventory_store = RemoteStore(baseurl + '/.bzr/inventory-store/')
 
123
        self.text_store = RemoteStore(baseurl + '/.bzr/text-store/')
 
124
        self.revision_store = RemoteStore(baseurl + '/.bzr/revision-store/')
 
125
 
 
126
    def __str__(self):
 
127
        b = getattr(self, 'baseurl', 'undefined')
 
128
        return '%s(%r)' % (self.__class__.__name__, b)
 
129
 
 
130
    __repr__ = __str__
 
131
 
 
132
    def controlfile(self, filename, mode):
 
133
        if mode not in ('rb', 'rt', 'r'):
 
134
            raise BzrError("file mode %r not supported for remote branches" % mode)
 
135
        return get_url(self.base + '/.bzr/' + filename, False)
 
136
 
 
137
 
 
138
    def lock_read(self):
 
139
        # no locking for remote branches yet
 
140
        pass
 
141
 
 
142
    def lock_write(self):
 
143
        from errors import LockError
 
144
        raise LockError("write lock not supported for remote branch %s"
 
145
                        % self.base)
 
146
 
 
147
    def unlock(self):
 
148
        pass
 
149
    
 
150
 
 
151
    def relpath(self, path):
 
152
        if not path.startswith(self.base):
 
153
            raise BzrError('path %r is not under base URL %r'
 
154
                           % (path, self.base))
 
155
        pl = len(self.base)
 
156
        return path[pl:].lstrip('/')
 
157
 
 
158
 
 
159
    def get_revision(self, revision_id):
 
160
        try:
 
161
            revf = self.revision_store[revision_id]
 
162
        except KeyError:
 
163
            raise NoSuchRevision(self, revision_id)
 
164
        r = serializer_v4.read_revision(revf)
 
165
        if r.revision_id != revision_id:
 
166
            raise BzrCheckError('revision stored as {%s} actually contains {%s}'
 
167
                                % (revision_id, r.revision_id))
 
168
        return r
 
169
 
 
170
 
 
171
class RemoteStore(object):
 
172
    def __init__(self, baseurl):
 
173
        self._baseurl = baseurl
 
174
        
 
175
 
 
176
    def _path(self, name):
 
177
        if '/' in name:
 
178
            raise ValueError('invalid store id', name)
 
179
        return self._baseurl + '/' + name
 
180
        
 
181
    def __getitem__(self, fileid):
 
182
        p = self._path(fileid)
 
183
        try:
 
184
            return get_url(p, compressed=True)
 
185
        except urllib2.URLError:
 
186
            raise KeyError(fileid)
 
187
    
 
188
 
 
189