← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: John Arbash Meinel
  • Date: 2005-11-14 17:02:35 UTC
  • mto: (1587.1.6 bound-branches)
  • mto: This revision was merged to the branch mainline in revision 1590.
  • Revision ID: john@arbash-meinel.com-20051114170235-f85afa458bae956e
Fixing up the error message for a failed bind.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
from copy import deepcopy
 
18
import shutil
 
19
import sys
 
20
import os
 
21
import errno
 
22
from warnings import warn
19
23
from cStringIO import StringIO
20
 
from unittest import TestSuite
21
 
from warnings import warn
 
24
 
22
25
 
23
26
import bzrlib
24
 
from bzrlib import bzrdir, errors, lockdir, osutils, revision, \
25
 
        tree, \
26
 
        ui, \
27
 
        urlutils
28
 
from bzrlib.config import TreeConfig
29
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
27
from bzrlib.inventory import InventoryEntry
 
28
import bzrlib.inventory as inventory
 
29
from bzrlib.trace import mutter, note
 
30
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes, 
 
31
                            rename, splitpath, sha_file, appendpath, 
 
32
                            file_kind, abspath)
30
33
import bzrlib.errors as errors
31
 
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches, 
32
 
                           HistoryMissing, InvalidRevisionId, 
33
 
                           InvalidRevisionNumber, LockError, NoSuchFile, 
34
 
                           NoSuchRevision, NoWorkingTree, NotVersionedError,
35
 
                           NotBranchError, UninitializableFormat, 
36
 
                           UnlistableStore, UnlistableBranch, 
37
 
                           )
38
 
from bzrlib.lockable_files import LockableFiles, TransportLock
39
 
from bzrlib.symbol_versioning import (deprecated_function,
40
 
                                      deprecated_method,
41
 
                                      DEPRECATED_PARAMETER,
42
 
                                      deprecated_passed,
43
 
                                      zero_eight, zero_nine,
44
 
                                      )
45
 
from bzrlib.trace import mutter, note
 
34
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
 
35
                           NoSuchRevision, HistoryMissing, NotBranchError,
 
36
                           DivergedBranches, LockError, UnlistableStore,
 
37
                           UnlistableBranch, NoSuchFile, NotVersionedError,
 
38
                           NoWorkingTree)
 
39
from bzrlib.textui import show_status
 
40
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions,
 
41
                             NULL_REVISION)
 
42
 
 
43
from bzrlib.delta import compare_trees
 
44
from bzrlib.tree import EmptyTree, RevisionTree
 
45
from bzrlib.inventory import Inventory
 
46
from bzrlib.store import copy_all
 
47
from bzrlib.store.compressed_text import CompressedTextStore
 
48
from bzrlib.store.text import TextStore
 
49
from bzrlib.store.weave import WeaveStore
 
50
from bzrlib.testament import Testament
 
51
import bzrlib.transactions as transactions
 
52
from bzrlib.transport import Transport, get_transport
 
53
import bzrlib.xml5
 
54
import bzrlib.ui
46
55
 
47
56
 
48
57
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
49
58
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
50
59
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
51
 
 
52
 
 
53
 
# TODO: Maybe include checks for common corruption of newlines, etc?
 
60
## TODO: Maybe include checks for common corruption of newlines, etc?
 
61
 
54
62
 
55
63
# TODO: Some operations like log might retrieve the same revisions
56
64
# repeatedly to calculate deltas.  We could perhaps have a weakref
57
65
# cache in memory to make this faster.  In general anything can be
58
 
# cached in memory between lock and unlock operations. .. nb thats
59
 
# what the transaction identity map provides
60
 
 
 
66
# cached in memory between lock and unlock operations.
 
67
 
 
68
def find_branch(*ignored, **ignored_too):
 
69
    # XXX: leave this here for about one release, then remove it
 
70
    raise NotImplementedError('find_branch() is not supported anymore, '
 
71
                              'please use one of the new branch constructors')
 
72
 
 
73
 
 
74
def needs_read_lock(unbound):
 
75
    """Decorate unbound to take out and release a read lock."""
 
76
    def decorated(self, *args, **kwargs):
 
77
        self.lock_read()
 
78
        try:
 
79
            return unbound(self, *args, **kwargs)
 
80
        finally:
 
81
            self.unlock()
 
82
    return decorated
 
83
 
 
84
 
 
85
def needs_write_lock(unbound):
 
86
    """Decorate unbound to take out and release a write lock."""
 
87
    def decorated(self, *args, **kwargs):
 
88
        self.lock_write()
 
89
        try:
 
90
            return unbound(self, *args, **kwargs)
 
91
        finally:
 
92
            self.unlock()
 
93
    return decorated
61
94
 
62
95
######################################################################
63
96
# branch objects
68
101
    base
69
102
        Base directory/url of the branch.
70
103
    """
71
 
    # this is really an instance variable - FIXME move it there
72
 
    # - RBC 20060112
73
104
    base = None
74
105
 
75
106
    def __init__(self, *ignored, **ignored_too):
76
107
        raise NotImplementedError('The Branch class is abstract')
77
108
 
78
 
    def break_lock(self):
79
 
        """Break a lock if one is present from another instance.
80
 
 
81
 
        Uses the ui factory to ask for confirmation if the lock may be from
82
 
        an active process.
83
 
 
84
 
        This will probe the repository for its lock as well.
85
 
        """
86
 
        self.control_files.break_lock()
87
 
        self.repository.break_lock()
88
 
        master = self.get_master_branch()
89
 
        if master is not None:
90
 
            master.break_lock()
91
 
 
92
109
    @staticmethod
93
 
    @deprecated_method(zero_eight)
94
110
    def open_downlevel(base):
95
 
        """Open a branch which may be of an old format."""
96
 
        return Branch.open(base, _unsupported=True)
 
111
        """Open a branch which may be of an old format.
 
112
        
 
113
        Only local branches are supported."""
 
114
        return _Branch(get_transport(base), relax_version_check=True)
97
115
        
98
116
    @staticmethod
99
 
    def open(base, _unsupported=False):
100
 
        """Open the branch rooted at base.
101
 
 
102
 
        For instance, if the branch is at URL/.bzr/branch,
103
 
        Branch.open(URL) -> a Branch instance.
104
 
        """
105
 
        control = bzrdir.BzrDir.open(base, _unsupported)
106
 
        return control.open_branch(_unsupported)
 
117
    def open(base):
 
118
        """Open an existing branch, rooted at 'base' (url)"""
 
119
        t = get_transport(base)
 
120
        mutter("trying to open %r with transport %r", base, t)
 
121
        return _Branch(t)
107
122
 
108
123
    @staticmethod
109
124
    def open_containing(url):
113
128
 
114
129
        Basically we keep looking up until we find the control directory or
115
130
        run into the root.  If there isn't one, raises NotBranchError.
116
 
        If there is one and it is either an unrecognised format or an unsupported 
117
 
        format, UnknownFormatError or UnsupportedFormatError are raised.
118
131
        If there is one, it is returned, along with the unused portion of url.
119
132
        """
120
 
        control, relpath = bzrdir.BzrDir.open_containing(url)
121
 
        return control.open_branch(), relpath
 
133
        t = get_transport(url)
 
134
        while True:
 
135
            try:
 
136
                return _Branch(t), t.relpath(url)
 
137
            except NotBranchError:
 
138
                pass
 
139
            new_t = t.clone('..')
 
140
            if new_t.base == t.base:
 
141
                # reached the root, whatever that may be
 
142
                raise NotBranchError(path=url)
 
143
            t = new_t
122
144
 
123
145
    @staticmethod
124
 
    @deprecated_function(zero_eight)
125
146
    def initialize(base):
126
 
        """Create a new working tree and branch, rooted at 'base' (url)
127
 
 
128
 
        NOTE: This will soon be deprecated in favour of creation
129
 
        through a BzrDir.
130
 
        """
131
 
        return bzrdir.BzrDir.create_standalone_workingtree(base).branch
 
147
        """Create a new branch, rooted at 'base' (url)"""
 
148
        t = get_transport(base)
 
149
        return _Branch(t, init=True)
132
150
 
133
151
    def setup_caching(self, cache_root):
134
152
        """Subclasses that care about caching should override this, and set
135
153
        up cached stores located under cache_root.
136
154
        """
137
 
        # seems to be unused, 2006-01-13 mbp
138
 
        warn('%s is deprecated' % self.setup_caching)
139
155
        self.cache_root = cache_root
140
156
 
141
 
    def get_config(self):
142
 
        return bzrlib.config.BranchConfig(self)
143
 
 
144
 
    def _get_nick(self):
145
 
        return self.get_config().get_nickname()
146
 
 
147
 
    def _set_nick(self, nick):
148
 
        self.get_config().set_user_option('nickname', nick)
149
 
 
150
 
    nick = property(_get_nick, _set_nick)
151
 
 
152
 
    def is_locked(self):
153
 
        raise NotImplementedError('is_locked is abstract')
 
157
 
 
158
class _Branch(Branch):
 
159
    """A branch stored in the actual filesystem.
 
160
 
 
161
    Note that it's "local" in the context of the filesystem; it doesn't
 
162
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
 
163
    it's writable, and can be accessed via the normal filesystem API.
 
164
 
 
165
    _lock_mode
 
166
        None, or 'r' or 'w'
 
167
 
 
168
    _lock_count
 
169
        If _lock_mode is true, a positive count of the number of times the
 
170
        lock has been taken.
 
171
 
 
172
    _lock
 
173
        Lock object from bzrlib.lock.
 
174
    """
 
175
    # We actually expect this class to be somewhat short-lived; part of its
 
176
    # purpose is to try to isolate what bits of the branch logic are tied to
 
177
    # filesystem access, so that in a later step, we can extricate them to
 
178
    # a separarte ("storage") class.
 
179
    _lock_mode = None
 
180
    _lock_count = None
 
181
    _lock = None
 
182
    _inventory_weave = None
 
183
    
 
184
    # Map some sort of prefix into a namespace
 
185
    # stuff like "revno:10", "revid:", etc.
 
186
    # This should match a prefix with a function which accepts
 
187
    REVISION_NAMESPACES = {}
 
188
 
 
189
    def push_stores(self, branch_to):
 
190
        """Copy the content of this branches store to branch_to."""
 
191
        if (self._branch_format != branch_to._branch_format
 
192
            or self._branch_format != 4):
 
193
            from bzrlib.fetch import greedy_fetch
 
194
            mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
 
195
                   self, self._branch_format, branch_to, branch_to._branch_format)
 
196
            greedy_fetch(to_branch=branch_to, from_branch=self,
 
197
                         revision=self.last_revision())
 
198
            return
 
199
 
 
200
        store_pairs = ((self.text_store,      branch_to.text_store),
 
201
                       (self.inventory_store, branch_to.inventory_store),
 
202
                       (self.revision_store,  branch_to.revision_store))
 
203
        try:
 
204
            for from_store, to_store in store_pairs: 
 
205
                copy_all(from_store, to_store)
 
206
        except UnlistableStore:
 
207
            raise UnlistableBranch(from_store)
 
208
 
 
209
    def __init__(self, transport, init=False,
 
210
                 relax_version_check=False):
 
211
        """Create new branch object at a particular location.
 
212
 
 
213
        transport -- A Transport object, defining how to access files.
 
214
        
 
215
        init -- If True, create new control files in a previously
 
216
             unversioned directory.  If False, the branch must already
 
217
             be versioned.
 
218
 
 
219
        relax_version_check -- If true, the usual check for the branch
 
220
            version is not applied.  This is intended only for
 
221
            upgrade/recovery type use; it's not guaranteed that
 
222
            all operations will work on old format branches.
 
223
 
 
224
        In the test suite, creation of new trees is tested using the
 
225
        `ScratchBranch` class.
 
226
        """
 
227
        assert isinstance(transport, Transport), \
 
228
            "%r is not a Transport" % transport
 
229
        self._transport = transport
 
230
        if init:
 
231
            self._make_control()
 
232
        self._check_format(relax_version_check)
 
233
 
 
234
        def get_store(name, compressed=True, prefixed=False):
 
235
            # FIXME: This approach of assuming stores are all entirely compressed
 
236
            # or entirely uncompressed is tidy, but breaks upgrade from 
 
237
            # some existing branches where there's a mixture; we probably 
 
238
            # still want the option to look for both.
 
239
            relpath = self._rel_controlfilename(name)
 
240
            if compressed:
 
241
                store = CompressedTextStore(self._transport.clone(relpath),
 
242
                                            prefixed=prefixed)
 
243
            else:
 
244
                store = TextStore(self._transport.clone(relpath),
 
245
                                  prefixed=prefixed)
 
246
            #if self._transport.should_cache():
 
247
            #    cache_path = os.path.join(self.cache_root, name)
 
248
            #    os.mkdir(cache_path)
 
249
            #    store = bzrlib.store.CachedStore(store, cache_path)
 
250
            return store
 
251
        def get_weave(name, prefixed=False):
 
252
            relpath = self._rel_controlfilename(name)
 
253
            ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
 
254
            if self._transport.should_cache():
 
255
                ws.enable_cache = True
 
256
            return ws
 
257
 
 
258
        if self._branch_format == 4:
 
259
            self.inventory_store = get_store('inventory-store')
 
260
            self.text_store = get_store('text-store')
 
261
            self.revision_store = get_store('revision-store')
 
262
        elif self._branch_format == 5:
 
263
            self.control_weaves = get_weave('')
 
264
            self.weave_store = get_weave('weaves')
 
265
            self.revision_store = get_store('revision-store', compressed=False)
 
266
        elif self._branch_format == 6:
 
267
            self.control_weaves = get_weave('')
 
268
            self.weave_store = get_weave('weaves', prefixed=True)
 
269
            self.revision_store = get_store('revision-store', compressed=False,
 
270
                                            prefixed=True)
 
271
        self.revision_store.register_suffix('sig')
 
272
        self._transaction = None
 
273
 
 
274
    def __str__(self):
 
275
        return '%s(%r)' % (self.__class__.__name__, self._transport.base)
 
276
 
 
277
    __repr__ = __str__
 
278
 
 
279
    def __del__(self):
 
280
        if self._lock_mode or self._lock:
 
281
            # XXX: This should show something every time, and be suitable for
 
282
            # headless operation and embedding
 
283
            warn("branch %r was not explicitly unlocked" % self)
 
284
            self._lock.unlock()
 
285
 
 
286
        # TODO: It might be best to do this somewhere else,
 
287
        # but it is nice for a Branch object to automatically
 
288
        # cache it's information.
 
289
        # Alternatively, we could have the Transport objects cache requests
 
290
        # See the earlier discussion about how major objects (like Branch)
 
291
        # should never expect their __del__ function to run.
 
292
        if hasattr(self, 'cache_root') and self.cache_root is not None:
 
293
            try:
 
294
                shutil.rmtree(self.cache_root)
 
295
            except:
 
296
                pass
 
297
            self.cache_root = None
 
298
 
 
299
    def _get_base(self):
 
300
        if self._transport:
 
301
            return self._transport.base
 
302
        return None
 
303
 
 
304
    base = property(_get_base, doc="The URL for the root of this branch.")
 
305
 
 
306
    def _finish_transaction(self):
 
307
        """Exit the current transaction."""
 
308
        if self._transaction is None:
 
309
            raise errors.LockError('Branch %s is not in a transaction' %
 
310
                                   self)
 
311
        transaction = self._transaction
 
312
        self._transaction = None
 
313
        transaction.finish()
 
314
 
 
315
    def get_transaction(self):
 
316
        """Return the current active transaction.
 
317
 
 
318
        If no transaction is active, this returns a passthrough object
 
319
        for which all data is immediately flushed and no caching happens.
 
320
        """
 
321
        if self._transaction is None:
 
322
            return transactions.PassThroughTransaction()
 
323
        else:
 
324
            return self._transaction
 
325
 
 
326
    def _set_transaction(self, new_transaction):
 
327
        """Set a new active transaction."""
 
328
        if self._transaction is not None:
 
329
            raise errors.LockError('Branch %s is in a transaction already.' %
 
330
                                   self)
 
331
        self._transaction = new_transaction
154
332
 
155
333
    def lock_write(self):
156
 
        raise NotImplementedError('lock_write is abstract')
 
334
        mutter("lock write: %s (%s)", self, self._lock_count)
 
335
        # TODO: Upgrade locking to support using a Transport,
 
336
        # and potentially a remote locking protocol
 
337
        if self._lock_mode:
 
338
            if self._lock_mode != 'w':
 
339
                raise LockError("can't upgrade to a write lock from %r" %
 
340
                                self._lock_mode)
 
341
            self._lock_count += 1
 
342
        else:
 
343
            self._lock = self._transport.lock_write(
 
344
                    self._rel_controlfilename('branch-lock'))
 
345
            self._lock_mode = 'w'
 
346
            self._lock_count = 1
 
347
            self._set_transaction(transactions.PassThroughTransaction())
157
348
 
158
349
    def lock_read(self):
159
 
        raise NotImplementedError('lock_read is abstract')
160
 
 
 
350
        mutter("lock read: %s (%s)", self, self._lock_count)
 
351
        if self._lock_mode:
 
352
            assert self._lock_mode in ('r', 'w'), \
 
353
                   "invalid lock mode %r" % self._lock_mode
 
354
            self._lock_count += 1
 
355
        else:
 
356
            self._lock = self._transport.lock_read(
 
357
                    self._rel_controlfilename('branch-lock'))
 
358
            self._lock_mode = 'r'
 
359
            self._lock_count = 1
 
360
            self._set_transaction(transactions.ReadOnlyTransaction())
 
361
            # 5K may be excessive, but hey, its a knob.
 
362
            self.get_transaction().set_cache_size(5000)
 
363
                        
161
364
    def unlock(self):
162
 
        raise NotImplementedError('unlock is abstract')
163
 
 
164
 
    def peek_lock_mode(self):
165
 
        """Return lock mode for the Branch: 'r', 'w' or None"""
166
 
        raise NotImplementedError(self.peek_lock_mode)
167
 
 
168
 
    def get_physical_lock_status(self):
169
 
        raise NotImplementedError('get_physical_lock_status is abstract')
 
365
        mutter("unlock: %s (%s)", self, self._lock_count)
 
366
        if not self._lock_mode:
 
367
            raise LockError('branch %r is not locked' % (self))
 
368
 
 
369
        if self._lock_count > 1:
 
370
            self._lock_count -= 1
 
371
        else:
 
372
            self._finish_transaction()
 
373
            self._lock.unlock()
 
374
            self._lock = None
 
375
            self._lock_mode = self._lock_count = None
170
376
 
171
377
    def abspath(self, name):
172
378
        """Return absolute filename for something in the branch
174
380
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
175
381
        method and not a tree method.
176
382
        """
177
 
        raise NotImplementedError('abspath is abstract')
178
 
 
179
 
    def bind(self, other):
180
 
        """Bind the local branch the other branch.
181
 
 
182
 
        :param other: The branch to bind to
183
 
        :type other: Branch
184
 
        """
185
 
        raise errors.UpgradeRequired(self.base)
186
 
 
187
 
    @needs_write_lock
188
 
    def fetch(self, from_branch, last_revision=None, pb=None):
189
 
        """Copy revisions from from_branch into this branch.
190
 
 
191
 
        :param from_branch: Where to copy from.
192
 
        :param last_revision: What revision to stop at (None for at the end
193
 
                              of the branch.
194
 
        :param pb: An optional progress bar to use.
195
 
 
196
 
        Returns the copied revision count and the failed revisions in a tuple:
197
 
        (copied, failures).
198
 
        """
199
 
        if self.base == from_branch.base:
200
 
            return (0, [])
201
 
        if pb is None:
202
 
            nested_pb = ui.ui_factory.nested_progress_bar()
203
 
            pb = nested_pb
 
383
        return self._transport.abspath(name)
 
384
 
 
385
    def _rel_controlfilename(self, file_or_path):
 
386
        if not isinstance(file_or_path, basestring):
 
387
            file_or_path = '/'.join(file_or_path)
 
388
        if file_or_path == '':
 
389
            return bzrlib.BZRDIR
 
390
        return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + file_or_path)
 
391
 
 
392
    def controlfilename(self, file_or_path):
 
393
        """Return location relative to branch."""
 
394
        return self._transport.abspath(self._rel_controlfilename(file_or_path))
 
395
 
 
396
    def controlfile(self, file_or_path, mode='r'):
 
397
        """Open a control file for this branch.
 
398
 
 
399
        There are two classes of file in the control directory: text
 
400
        and binary.  binary files are untranslated byte streams.  Text
 
401
        control files are stored with Unix newlines and in UTF-8, even
 
402
        if the platform or locale defaults are different.
 
403
 
 
404
        Controlfiles should almost never be opened in write mode but
 
405
        rather should be atomically copied and replaced using atomicfile.
 
406
        """
 
407
        import codecs
 
408
 
 
409
        relpath = self._rel_controlfilename(file_or_path)
 
410
        #TODO: codecs.open() buffers linewise, so it was overloaded with
 
411
        # a much larger buffer, do we need to do the same for getreader/getwriter?
 
412
        if mode == 'rb': 
 
413
            return self._transport.get(relpath)
 
414
        elif mode == 'wb':
 
415
            raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
 
416
        elif mode == 'r':
 
417
            # XXX: Do we really want errors='replace'?   Perhaps it should be
 
418
            # an error, or at least reported, if there's incorrectly-encoded
 
419
            # data inside a file.
 
420
            # <https://launchpad.net/products/bzr/+bug/3823>
 
421
            return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
 
422
        elif mode == 'w':
 
423
            raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
204
424
        else:
205
 
            nested_pb = None
206
 
 
207
 
        from_branch.lock_read()
208
 
        try:
209
 
            if last_revision is None:
210
 
                pb.update('get source history')
211
 
                from_history = from_branch.revision_history()
212
 
                if from_history:
213
 
                    last_revision = from_history[-1]
 
425
            raise BzrError("invalid controlfile mode %r" % mode)
 
426
 
 
427
    def put_controlfile(self, path, f, encode=True):
 
428
        """Write an entry as a controlfile.
 
429
 
 
430
        :param path: The path to put the file, relative to the .bzr control
 
431
                     directory
 
432
        :param f: A file-like or string object whose contents should be copied.
 
433
        :param encode:  If true, encode the contents as utf-8
 
434
        """
 
435
        self.put_controlfiles([(path, f)], encode=encode)
 
436
 
 
437
    def put_controlfiles(self, files, encode=True):
 
438
        """Write several entries as controlfiles.
 
439
 
 
440
        :param files: A list of [(path, file)] pairs, where the path is the directory
 
441
                      underneath the bzr control directory
 
442
        :param encode:  If true, encode the contents as utf-8
 
443
        """
 
444
        import codecs
 
445
        ctrl_files = []
 
446
        for path, f in files:
 
447
            if encode:
 
448
                if isinstance(f, basestring):
 
449
                    f = f.encode('utf-8', 'replace')
214
450
                else:
215
 
                    # no history in the source branch
216
 
                    last_revision = revision.NULL_REVISION
217
 
            return self.repository.fetch(from_branch.repository,
218
 
                                         revision_id=last_revision,
219
 
                                         pb=nested_pb)
220
 
        finally:
221
 
            if nested_pb is not None:
222
 
                nested_pb.finished()
223
 
            from_branch.unlock()
224
 
 
225
 
    def get_bound_location(self):
226
 
        """Return the URL of the branch we are bound to.
227
 
 
228
 
        Older format branches cannot bind, please be sure to use a metadir
229
 
        branch.
230
 
        """
231
 
        return None
232
 
    
233
 
    def get_commit_builder(self, parents, config=None, timestamp=None, 
234
 
                           timezone=None, committer=None, revprops=None, 
235
 
                           revision_id=None):
236
 
        """Obtain a CommitBuilder for this branch.
237
 
        
238
 
        :param parents: Revision ids of the parents of the new revision.
239
 
        :param config: Optional configuration to use.
240
 
        :param timestamp: Optional timestamp recorded for commit.
241
 
        :param timezone: Optional timezone for timestamp.
242
 
        :param committer: Optional committer to set for commit.
243
 
        :param revprops: Optional dictionary of revision properties.
244
 
        :param revision_id: Optional revision id.
245
 
        """
246
 
 
247
 
        if config is None:
248
 
            config = self.get_config()
249
 
        
250
 
        return self.repository.get_commit_builder(self, parents, config, 
251
 
            timestamp, timezone, committer, revprops, revision_id)
252
 
 
253
 
    def get_master_branch(self):
254
 
        """Return the branch we are bound to.
255
 
        
256
 
        :return: Either a Branch, or None
257
 
        """
258
 
        return None
 
451
                    f = codecs.getwriter('utf-8')(f, errors='replace')
 
452
            path = self._rel_controlfilename(path)
 
453
            ctrl_files.append((path, f))
 
454
        self._transport.put_multi(ctrl_files)
 
455
 
 
456
    def _make_control(self):
 
457
        from bzrlib.inventory import Inventory
 
458
        from bzrlib.weavefile import write_weave_v5
 
459
        from bzrlib.weave import Weave
 
460
        
 
461
        # Create an empty inventory
 
462
        sio = StringIO()
 
463
        # if we want per-tree root ids then this is the place to set
 
464
        # them; they're not needed for now and so ommitted for
 
465
        # simplicity.
 
466
        bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
 
467
        empty_inv = sio.getvalue()
 
468
        sio = StringIO()
 
469
        bzrlib.weavefile.write_weave_v5(Weave(), sio)
 
470
        empty_weave = sio.getvalue()
 
471
 
 
472
        dirs = [[], 'revision-store', 'weaves']
 
473
        files = [('README', 
 
474
            "This is a Bazaar-NG control directory.\n"
 
475
            "Do not change any files in this directory.\n"),
 
476
            ('branch-format', BZR_BRANCH_FORMAT_6),
 
477
            ('revision-history', ''),
 
478
            ('branch-name', ''),
 
479
            ('branch-lock', ''),
 
480
            ('pending-merges', ''),
 
481
            ('inventory', empty_inv),
 
482
            ('inventory.weave', empty_weave),
 
483
            ('ancestry.weave', empty_weave)
 
484
        ]
 
485
        cfn = self._rel_controlfilename
 
486
        self._transport.mkdir_multi([cfn(d) for d in dirs])
 
487
        self.put_controlfiles(files)
 
488
        mutter('created control directory in ' + self._transport.base)
 
489
 
 
490
    def _check_format(self, relax_version_check):
 
491
        """Check this branch format is supported.
 
492
 
 
493
        The format level is stored, as an integer, in
 
494
        self._branch_format for code that needs to check it later.
 
495
 
 
496
        In the future, we might need different in-memory Branch
 
497
        classes to support downlevel branches.  But not yet.
 
498
        """
 
499
        try:
 
500
            fmt = self.controlfile('branch-format', 'r').read()
 
501
        except NoSuchFile:
 
502
            raise NotBranchError(path=self.base)
 
503
        mutter("got branch format %r", fmt)
 
504
        if fmt == BZR_BRANCH_FORMAT_6:
 
505
            self._branch_format = 6
 
506
        elif fmt == BZR_BRANCH_FORMAT_5:
 
507
            self._branch_format = 5
 
508
        elif fmt == BZR_BRANCH_FORMAT_4:
 
509
            self._branch_format = 4
 
510
 
 
511
        if (not relax_version_check
 
512
            and self._branch_format not in (5, 6)):
 
513
            raise errors.UnsupportedFormatError(
 
514
                           'sorry, branch format %r not supported' % fmt,
 
515
                           ['use a different bzr version',
 
516
                            'or remove the .bzr directory'
 
517
                            ' and "bzr init" again'])
 
518
 
 
519
    def get_root_id(self):
 
520
        """Return the id of this branches root"""
 
521
        inv = self.get_inventory(self.last_revision())
 
522
        return inv.root.file_id
 
523
 
 
524
    @needs_write_lock
 
525
    def add(self, files, ids=None):
 
526
        """Make files versioned.
 
527
 
 
528
        Note that the command line normally calls smart_add instead,
 
529
        which can automatically recurse.
 
530
 
 
531
        This puts the files in the Added state, so that they will be
 
532
        recorded by the next commit.
 
533
 
 
534
        files
 
535
            List of paths to add, relative to the base of the tree.
 
536
 
 
537
        ids
 
538
            If set, use these instead of automatically generated ids.
 
539
            Must be the same length as the list of files, but may
 
540
            contain None for ids that are to be autogenerated.
 
541
 
 
542
        TODO: Perhaps have an option to add the ids even if the files do
 
543
              not (yet) exist.
 
544
 
 
545
        TODO: Perhaps yield the ids and paths as they're added.
 
546
        """
 
547
        # TODO: Re-adding a file that is removed in the working copy
 
548
        # should probably put it back with the previous ID.
 
549
        if isinstance(files, basestring):
 
550
            assert(ids is None or isinstance(ids, basestring))
 
551
            files = [files]
 
552
            if ids is not None:
 
553
                ids = [ids]
 
554
 
 
555
        if ids is None:
 
556
            ids = [None] * len(files)
 
557
        else:
 
558
            assert(len(ids) == len(files))
 
559
 
 
560
        inv = self.working_tree().read_working_inventory()
 
561
        for f,file_id in zip(files, ids):
 
562
            if is_control_file(f):
 
563
                raise BzrError("cannot add control file %s" % quotefn(f))
 
564
 
 
565
            fp = splitpath(f)
 
566
 
 
567
            if len(fp) == 0:
 
568
                raise BzrError("cannot add top-level %r" % f)
 
569
 
 
570
            fullpath = os.path.normpath(self.abspath(f))
 
571
 
 
572
            try:
 
573
                kind = file_kind(fullpath)
 
574
            except OSError:
 
575
                # maybe something better?
 
576
                raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
 
577
 
 
578
            if not InventoryEntry.versionable_kind(kind):
 
579
                raise BzrError('cannot add: not a versionable file ('
 
580
                               'i.e. regular file, symlink or directory): %s' % quotefn(f))
 
581
 
 
582
            if file_id is None:
 
583
                file_id = gen_file_id(f)
 
584
            inv.add_path(f, kind=kind, file_id=file_id)
 
585
 
 
586
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
587
 
 
588
        self.working_tree()._write_inventory(inv)
 
589
 
 
590
    @needs_read_lock
 
591
    def print_file(self, file, revno):
 
592
        """Print `file` to stdout."""
 
593
        tree = self.revision_tree(self.get_rev_id(revno))
 
594
        # use inventory as it was in that revision
 
595
        file_id = tree.inventory.path2id(file)
 
596
        if not file_id:
 
597
            raise BzrError("%r is not present in revision %s" % (file, revno))
 
598
        tree.print_file(file_id)
 
599
 
 
600
    def unknowns(self):
 
601
        """Return all unknown files.
 
602
 
 
603
        These are files in the working directory that are not versioned or
 
604
        control files or ignored.
 
605
        
 
606
        >>> from bzrlib.workingtree import WorkingTree
 
607
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
608
        >>> map(str, b.unknowns())
 
609
        ['foo']
 
610
        >>> b.add('foo')
 
611
        >>> list(b.unknowns())
 
612
        []
 
613
        >>> WorkingTree(b.base, b).remove('foo')
 
614
        >>> list(b.unknowns())
 
615
        [u'foo']
 
616
        """
 
617
        return self.working_tree().unknowns()
 
618
 
 
619
    @needs_write_lock
 
620
    def append_revision(self, *revision_ids):
 
621
        for revision_id in revision_ids:
 
622
            mutter("add {%s} to revision-history" % revision_id)
 
623
        rev_history = self.revision_history()
 
624
        rev_history.extend(revision_ids)
 
625
        self.set_revision_history(rev_history)
 
626
 
 
627
    @needs_write_lock
 
628
    def set_revision_history(self, rev_history):
 
629
        bound_loc = self.get_bound_location()
 
630
        if bound_loc is not None:
 
631
            # TODO: At this point, we could get a NotBranchError
 
632
            # because we can't connect to the remote location.
 
633
            # How do we distinguish this from a remote branch
 
634
            # which has been deleted?
 
635
            try:
 
636
                rev_history = self._update_remote_location(bound_loc,
 
637
                                                           rev_history)
 
638
            except DivergedBranches:
 
639
                raise errors.CannotInstallRevisions('Remote tree has commits.'
 
640
                            ' Use bzr pull to come up to date')
 
641
        self.put_controlfile('revision-history', '\n'.join(rev_history))
 
642
 
 
643
    def has_revision(self, revision_id):
 
644
        """True if this branch has a copy of the revision.
 
645
 
 
646
        This does not necessarily imply the revision is merge
 
647
        or on the mainline."""
 
648
        return (revision_id is None
 
649
                or self.revision_store.has_id(revision_id))
 
650
 
 
651
    @needs_read_lock
 
652
    def get_revision_xml_file(self, revision_id):
 
653
        """Return XML file object for revision object."""
 
654
        if not revision_id or not isinstance(revision_id, basestring):
 
655
            raise InvalidRevisionId(revision_id=revision_id, branch=self)
 
656
        try:
 
657
            return self.revision_store.get(revision_id)
 
658
        except (IndexError, KeyError):
 
659
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
660
 
 
661
    #deprecated
 
662
    get_revision_xml = get_revision_xml_file
 
663
 
 
664
    def get_revision_xml(self, revision_id):
 
665
        return self.get_revision_xml_file(revision_id).read()
 
666
 
 
667
 
 
668
    def get_revision(self, revision_id):
 
669
        """Return the Revision object for a named revision"""
 
670
        xml_file = self.get_revision_xml_file(revision_id)
 
671
 
 
672
        try:
 
673
            r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
 
674
        except SyntaxError, e:
 
675
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
 
676
                                         [revision_id,
 
677
                                          str(e)])
 
678
            
 
679
        assert r.revision_id == revision_id
 
680
        return r
259
681
 
260
682
    def get_revision_delta(self, revno):
261
683
        """Return the delta for one revision.
267
689
        rh = self.revision_history()
268
690
        if not (1 <= revno <= len(rh)):
269
691
            raise InvalidRevisionNumber(revno)
270
 
        return self.repository.get_revision_delta(rh[revno-1])
271
 
 
272
 
    def get_root_id(self):
273
 
        """Return the id of this branches root"""
274
 
        raise NotImplementedError('get_root_id is abstract')
275
 
 
276
 
    def print_file(self, file, revision_id):
277
 
        """Print `file` to stdout."""
278
 
        raise NotImplementedError('print_file is abstract')
279
 
 
280
 
    def append_revision(self, *revision_ids):
281
 
        raise NotImplementedError('append_revision is abstract')
282
 
 
283
 
    def set_revision_history(self, rev_history):
284
 
        raise NotImplementedError('set_revision_history is abstract')
285
 
 
 
692
 
 
693
        # revno is 1-based; list is 0-based
 
694
 
 
695
        new_tree = self.revision_tree(rh[revno-1])
 
696
        if revno == 1:
 
697
            old_tree = EmptyTree()
 
698
        else:
 
699
            old_tree = self.revision_tree(rh[revno-2])
 
700
 
 
701
        return compare_trees(old_tree, new_tree)
 
702
 
 
703
    def get_revision_sha1(self, revision_id):
 
704
        """Hash the stored value of a revision, and return it."""
 
705
        # In the future, revision entries will be signed. At that
 
706
        # point, it is probably best *not* to include the signature
 
707
        # in the revision hash. Because that lets you re-sign
 
708
        # the revision, (add signatures/remove signatures) and still
 
709
        # have all hash pointers stay consistent.
 
710
        # But for now, just hash the contents.
 
711
        return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
 
712
 
 
713
    def get_ancestry(self, revision_id):
 
714
        """Return a list of revision-ids integrated by a revision.
 
715
        
 
716
        This currently returns a list, but the ordering is not guaranteed:
 
717
        treat it as a set.
 
718
        """
 
719
        if revision_id is None:
 
720
            return [None]
 
721
        w = self.get_inventory_weave()
 
722
        return [None] + map(w.idx_to_name,
 
723
                            w.inclusions([w.lookup(revision_id)]))
 
724
 
 
725
    def get_inventory_weave(self):
 
726
        return self.control_weaves.get_weave('inventory',
 
727
                                             self.get_transaction())
 
728
 
 
729
    def get_inventory(self, revision_id):
 
730
        """Get Inventory object by hash."""
 
731
        xml = self.get_inventory_xml(revision_id)
 
732
        return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
 
733
 
 
734
    def get_inventory_xml(self, revision_id):
 
735
        """Get inventory XML as a file object."""
 
736
        try:
 
737
            assert isinstance(revision_id, basestring), type(revision_id)
 
738
            iw = self.get_inventory_weave()
 
739
            return iw.get_text(iw.lookup(revision_id))
 
740
        except IndexError:
 
741
            raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
 
742
 
 
743
    def get_inventory_sha1(self, revision_id):
 
744
        """Return the sha1 hash of the inventory entry
 
745
        """
 
746
        return self.get_revision(revision_id).inventory_sha1
 
747
 
 
748
    def get_revision_inventory(self, revision_id):
 
749
        """Return inventory of a past revision."""
 
750
        # TODO: Unify this with get_inventory()
 
751
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
752
        # must be the same as its revision, so this is trivial.
 
753
        if revision_id == None:
 
754
            # This does not make sense: if there is no revision,
 
755
            # then it is the current tree inventory surely ?!
 
756
            # and thus get_root_id() is something that looks at the last
 
757
            # commit on the branch, and the get_root_id is an inventory check.
 
758
            raise NotImplementedError
 
759
            # return Inventory(self.get_root_id())
 
760
        else:
 
761
            return self.get_inventory(revision_id)
 
762
 
 
763
    @needs_read_lock
286
764
    def revision_history(self):
287
765
        """Return sequence of revision hashes on to this branch."""
288
 
        raise NotImplementedError('revision_history is abstract')
 
766
        transaction = self.get_transaction()
 
767
        history = transaction.map.find_revision_history()
 
768
        if history is not None:
 
769
            mutter("cache hit for revision-history in %s", self)
 
770
            return list(history)
 
771
        history = [l.rstrip('\r\n') for l in
 
772
                self.controlfile('revision-history', 'r').readlines()]
 
773
        transaction.map.add_revision_history(history)
 
774
        # this call is disabled because revision_history is 
 
775
        # not really an object yet, and the transaction is for objects.
 
776
        # transaction.register_clean(history, precious=True)
 
777
        return list(history)
289
778
 
290
779
    def revno(self):
291
780
        """Return current revision number for this branch.
295
784
        """
296
785
        return len(self.revision_history())
297
786
 
298
 
    def unbind(self):
299
 
        """Older format branches cannot bind or unbind."""
300
 
        raise errors.UpgradeRequired(self.base)
301
 
 
302
787
    def last_revision(self):
303
 
        """Return last patch hash, or None if no history."""
 
788
        """Return last patch hash, or None if no history.
 
789
        """
304
790
        ph = self.revision_history()
305
791
        if ph:
306
792
            return ph[-1]
307
793
        else:
308
794
            return None
309
795
 
310
 
    def missing_revisions(self, other, stop_revision=None):
 
796
    def missing_revisions(self, other, stop_revision=None, other_history=None):
311
797
        """Return a list of new revisions that would perfectly fit.
312
798
        
313
799
        If self and other have not diverged, return a list of the revisions
314
800
        present in other, but missing from self.
 
801
 
 
802
        >>> from bzrlib.commit import commit
 
803
        >>> bzrlib.trace.silent = True
 
804
        >>> br1 = ScratchBranch()
 
805
        >>> br2 = ScratchBranch()
 
806
        >>> br1.missing_revisions(br2)
 
807
        []
 
808
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
809
        >>> br1.missing_revisions(br2)
 
810
        [u'REVISION-ID-1']
 
811
        >>> br2.missing_revisions(br1)
 
812
        []
 
813
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
814
        >>> br1.missing_revisions(br2)
 
815
        []
 
816
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
817
        >>> br1.missing_revisions(br2)
 
818
        [u'REVISION-ID-2A']
 
819
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
820
        >>> br1.missing_revisions(br2)
 
821
        Traceback (most recent call last):
 
822
        DivergedBranches: These branches have diverged.
315
823
        """
316
824
        self_history = self.revision_history()
317
825
        self_len = len(self_history)
318
 
        other_history = other.revision_history()
 
826
        if other_history is None:
 
827
            other_history = other.revision_history()
319
828
        other_len = len(other_history)
320
829
        common_index = min(self_len, other_len) -1
321
830
        if common_index >= 0 and \
327
836
        else:
328
837
            assert isinstance(stop_revision, int)
329
838
            if stop_revision > other_len:
330
 
                raise errors.NoSuchRevision(self, stop_revision)
 
839
                raise bzrlib.errors.NoSuchRevision(self, stop_revision)
331
840
        return other_history[self_len:stop_revision]
332
841
 
333
 
    def update_revisions(self, other, stop_revision=None):
 
842
    def update_revisions(self, other, stop_revision=None, other_history=None):
334
843
        """Pull in new perfect-fit revisions.
335
844
 
336
845
        :param other: Another Branch to pull from
337
846
        :param stop_revision: Updated until the given revision
 
847
        :param other_history: Alternative history to other.revision_history()
338
848
        :return: None
339
849
        """
340
 
        raise NotImplementedError('update_revisions is abstract')
 
850
        from bzrlib.fetch import greedy_fetch
 
851
        if stop_revision is None:
 
852
            if other_history is not None:
 
853
                stop_revision = other_history[-1]
 
854
            else:
 
855
                stop_revision = other.last_revision()
 
856
        ### Should this be checking is_ancestor instead of revision_history?
 
857
        if (stop_revision is not None and 
 
858
            stop_revision in self.revision_history()):
 
859
            return
 
860
        greedy_fetch(to_branch=self, from_branch=other,
 
861
                     revision=stop_revision)
 
862
        pullable_revs = self.pullable_revisions(other, stop_revision,
 
863
                other_history=other_history)
 
864
        if len(pullable_revs) > 0:
 
865
            self.append_revision(*pullable_revs)
341
866
 
 
867
    def pullable_revisions(self, other, stop_revision, other_history=None):
 
868
        if other_history is not None:
 
869
            try:
 
870
                other_revno = other_history.index(stop_revision) + 1
 
871
            except ValueError:
 
872
                raise errors.NoSuchRevision(self, stop_revision)
 
873
        else:
 
874
            other_revno = other.revision_id_to_revno(stop_revision)
 
875
        try:
 
876
            return self.missing_revisions(other, other_revno,
 
877
                    other_history=other_history)
 
878
        except DivergedBranches, e:
 
879
            try:
 
880
                pullable_revs = get_intervening_revisions(self.last_revision(),
 
881
                                                          stop_revision, self)
 
882
                assert self.last_revision() not in pullable_revs
 
883
                return pullable_revs
 
884
            except bzrlib.errors.NotAncestor:
 
885
                if is_ancestor(self.last_revision(), stop_revision, self):
 
886
                    return []
 
887
                else:
 
888
                    raise e
 
889
        
342
890
    def revision_id_to_revno(self, revision_id):
343
891
        """Given a revision id, return its revno"""
344
892
        if revision_id is None:
359
907
            raise bzrlib.errors.NoSuchRevision(self, revno)
360
908
        return history[revno - 1]
361
909
 
362
 
    def pull(self, source, overwrite=False, stop_revision=None):
363
 
        raise NotImplementedError('pull is abstract')
 
910
    def revision_tree(self, revision_id):
 
911
        """Return Tree for a revision on this branch.
 
912
 
 
913
        `revision_id` may be None for the null revision, in which case
 
914
        an `EmptyTree` is returned."""
 
915
        # TODO: refactor this to use an existing revision object
 
916
        # so we don't need to read it in twice.
 
917
        if revision_id == None or revision_id == NULL_REVISION:
 
918
            return EmptyTree()
 
919
        else:
 
920
            inv = self.get_revision_inventory(revision_id)
 
921
            return RevisionTree(self.weave_store, inv, revision_id)
 
922
 
 
923
    def working_tree(self):
 
924
        """Return a `Tree` for the working copy."""
 
925
        from bzrlib.workingtree import WorkingTree
 
926
        # TODO: In the future, perhaps WorkingTree should utilize Transport
 
927
        # RobertCollins 20051003 - I don't think it should - working trees are
 
928
        # much more complex to keep consistent than our careful .bzr subset.
 
929
        # instead, we should say that working trees are local only, and optimise
 
930
        # for that.
 
931
        if self._transport.base.find('://') != -1:
 
932
            raise NoWorkingTree(self.base)
 
933
        return WorkingTree(self.base, branch=self)
 
934
 
 
935
    @needs_write_lock
 
936
    def pull(self, source, overwrite=False):
 
937
        source.lock_read()
 
938
        try:
 
939
            try:
 
940
                self.update_revisions(source)
 
941
            except DivergedBranches:
 
942
                if not overwrite:
 
943
                    raise
 
944
                self.set_revision_history(source.revision_history())
 
945
        finally:
 
946
            source.unlock()
364
947
 
365
948
    def basis_tree(self):
366
949
        """Return `Tree` object for last revision.
367
950
 
368
951
        If there are no revisions yet, return an `EmptyTree`.
369
952
        """
370
 
        return self.repository.revision_tree(self.last_revision())
 
953
        return self.revision_tree(self.last_revision())
371
954
 
 
955
    @needs_write_lock
372
956
    def rename_one(self, from_rel, to_rel):
373
957
        """Rename one file.
374
958
 
375
959
        This can change the directory or the filename or both.
376
960
        """
377
 
        raise NotImplementedError('rename_one is abstract')
378
 
 
 
961
        tree = self.working_tree()
 
962
        inv = tree.inventory
 
963
        if not tree.has_filename(from_rel):
 
964
            raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
965
        if tree.has_filename(to_rel):
 
966
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
967
 
 
968
        file_id = inv.path2id(from_rel)
 
969
        if file_id == None:
 
970
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
971
 
 
972
        if inv.path2id(to_rel):
 
973
            raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
974
 
 
975
        to_dir, to_tail = os.path.split(to_rel)
 
976
        to_dir_id = inv.path2id(to_dir)
 
977
        if to_dir_id == None and to_dir != '':
 
978
            raise BzrError("can't determine destination directory id for %r" % to_dir)
 
979
 
 
980
        mutter("rename_one:")
 
981
        mutter("  file_id    {%s}" % file_id)
 
982
        mutter("  from_rel   %r" % from_rel)
 
983
        mutter("  to_rel     %r" % to_rel)
 
984
        mutter("  to_dir     %r" % to_dir)
 
985
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
986
 
 
987
        inv.rename(file_id, to_dir_id, to_tail)
 
988
 
 
989
        from_abs = self.abspath(from_rel)
 
990
        to_abs = self.abspath(to_rel)
 
991
        try:
 
992
            rename(from_abs, to_abs)
 
993
        except OSError, e:
 
994
            raise BzrError("failed to rename %r to %r: %s"
 
995
                    % (from_abs, to_abs, e[1]),
 
996
                    ["rename rolled back"])
 
997
 
 
998
        self.working_tree()._write_inventory(inv)
 
999
 
 
1000
    @needs_write_lock
379
1001
    def move(self, from_paths, to_name):
380
1002
        """Rename files.
381
1003
 
390
1012
        This returns a list of (from_path, to_path) pairs for each
391
1013
        entry that is moved.
392
1014
        """
393
 
        raise NotImplementedError('move is abstract')
 
1015
        result = []
 
1016
        ## TODO: Option to move IDs only
 
1017
        assert not isinstance(from_paths, basestring)
 
1018
        tree = self.working_tree()
 
1019
        inv = tree.inventory
 
1020
        to_abs = self.abspath(to_name)
 
1021
        if not isdir(to_abs):
 
1022
            raise BzrError("destination %r is not a directory" % to_abs)
 
1023
        if not tree.has_filename(to_name):
 
1024
            raise BzrError("destination %r not in working directory" % to_abs)
 
1025
        to_dir_id = inv.path2id(to_name)
 
1026
        if to_dir_id == None and to_name != '':
 
1027
            raise BzrError("destination %r is not a versioned directory" % to_name)
 
1028
        to_dir_ie = inv[to_dir_id]
 
1029
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
1030
            raise BzrError("destination %r is not a directory" % to_abs)
 
1031
 
 
1032
        to_idpath = inv.get_idpath(to_dir_id)
 
1033
 
 
1034
        for f in from_paths:
 
1035
            if not tree.has_filename(f):
 
1036
                raise BzrError("%r does not exist in working tree" % f)
 
1037
            f_id = inv.path2id(f)
 
1038
            if f_id == None:
 
1039
                raise BzrError("%r is not versioned" % f)
 
1040
            name_tail = splitpath(f)[-1]
 
1041
            dest_path = appendpath(to_name, name_tail)
 
1042
            if tree.has_filename(dest_path):
 
1043
                raise BzrError("destination %r already exists" % dest_path)
 
1044
            if f_id in to_idpath:
 
1045
                raise BzrError("can't move %r to a subdirectory of itself" % f)
 
1046
 
 
1047
        # OK, so there's a race here, it's possible that someone will
 
1048
        # create a file in this interval and then the rename might be
 
1049
        # left half-done.  But we should have caught most problems.
 
1050
 
 
1051
        for f in from_paths:
 
1052
            name_tail = splitpath(f)[-1]
 
1053
            dest_path = appendpath(to_name, name_tail)
 
1054
            result.append((f, dest_path))
 
1055
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
1056
            try:
 
1057
                rename(self.abspath(f), self.abspath(dest_path))
 
1058
            except OSError, e:
 
1059
                raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
1060
                        ["rename rolled back"])
 
1061
 
 
1062
        self.working_tree()._write_inventory(inv)
 
1063
        return result
394
1064
 
395
1065
    def get_parent(self):
396
1066
        """Return the parent location of the branch.
399
1069
        pattern is that the user can override it by specifying a
400
1070
        location.
401
1071
        """
402
 
        raise NotImplementedError('get_parent is abstract')
403
 
 
404
 
    def get_submit_branch(self):
405
 
        """Return the submit location of the branch.
406
 
 
407
 
        This is the default location for bundle.  The usual
408
 
        pattern is that the user can override it by specifying a
409
 
        location.
410
 
        """
411
 
        return self.get_config().get_user_option('submit_branch')
412
 
 
413
 
    def set_submit_branch(self, location):
414
 
        """Return the submit location of the branch.
415
 
 
416
 
        This is the default location for bundle.  The usual
417
 
        pattern is that the user can override it by specifying a
418
 
        location.
419
 
        """
420
 
        self.get_config().set_user_option('submit_branch', location)
 
1072
        import errno
 
1073
        _locs = ['parent', 'pull', 'x-pull']
 
1074
        for l in _locs:
 
1075
            try:
 
1076
                return self.controlfile(l, 'r').read().strip('\n')
 
1077
            except IOError, e:
 
1078
                if e.errno != errno.ENOENT:
 
1079
                    raise
 
1080
        return None
421
1081
 
422
1082
    def get_push_location(self):
423
1083
        """Return the None or the location to push this branch to."""
424
 
        raise NotImplementedError('get_push_location is abstract')
 
1084
        config = bzrlib.config.BranchConfig(self)
 
1085
        push_loc = config.get_user_option('push_location')
 
1086
        return push_loc
425
1087
 
426
1088
    def set_push_location(self, location):
427
1089
        """Set a new push location for this branch."""
428
 
        raise NotImplementedError('set_push_location is abstract')
 
1090
        config = bzrlib.config.LocationConfig(self.base)
 
1091
        config.set_user_option('push_location', location)
429
1092
 
 
1093
    @needs_write_lock
430
1094
    def set_parent(self, url):
431
 
        raise NotImplementedError('set_parent is abstract')
432
 
 
433
 
    @needs_write_lock
434
 
    def update(self):
435
 
        """Synchronise this branch with the master branch if any. 
436
 
 
437
 
        :return: None or the last_revision pivoted out during the update.
438
 
        """
439
 
        return None
 
1095
        # TODO: Maybe delete old location files?
 
1096
        from bzrlib.atomicfile import AtomicFile
 
1097
        f = AtomicFile(self.controlfilename('parent'))
 
1098
        try:
 
1099
            f.write(url + '\n')
 
1100
            f.commit()
 
1101
        finally:
 
1102
            f.close()
440
1103
 
441
1104
    def check_revno(self, revno):
442
1105
        """\
453
1116
        """
454
1117
        if revno < 1 or revno > self.revno():
455
1118
            raise InvalidRevisionNumber(revno)
456
 
 
457
 
    @needs_read_lock
458
 
    def clone(self, *args, **kwargs):
459
 
        """Clone this branch into to_bzrdir preserving all semantic values.
460
 
        
461
 
        revision_id: if not None, the revision history in the new branch will
462
 
                     be truncated to end with revision_id.
463
 
        """
464
 
        # for API compatibility, until 0.8 releases we provide the old api:
465
 
        # def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
466
 
        # after 0.8 releases, the *args and **kwargs should be changed:
467
 
        # def clone(self, to_bzrdir, revision_id=None):
468
 
        if (kwargs.get('to_location', None) or
469
 
            kwargs.get('revision', None) or
470
 
            kwargs.get('basis_branch', None) or
471
 
            (len(args) and isinstance(args[0], basestring))):
472
 
            # backwards compatibility api:
473
 
            warn("Branch.clone() has been deprecated for BzrDir.clone() from"
474
 
                 " bzrlib 0.8.", DeprecationWarning, stacklevel=3)
475
 
            # get basis_branch
476
 
            if len(args) > 2:
477
 
                basis_branch = args[2]
478
 
            else:
479
 
                basis_branch = kwargs.get('basis_branch', None)
480
 
            if basis_branch:
481
 
                basis = basis_branch.bzrdir
482
 
            else:
483
 
                basis = None
484
 
            # get revision
485
 
            if len(args) > 1:
486
 
                revision_id = args[1]
487
 
            else:
488
 
                revision_id = kwargs.get('revision', None)
489
 
            # get location
490
 
            if len(args):
491
 
                url = args[0]
492
 
            else:
493
 
                # no default to raise if not provided.
494
 
                url = kwargs.get('to_location')
495
 
            return self.bzrdir.clone(url,
496
 
                                     revision_id=revision_id,
497
 
                                     basis=basis).open_branch()
498
 
        # new cleaner api.
499
 
        # generate args by hand 
500
 
        if len(args) > 1:
501
 
            revision_id = args[1]
502
 
        else:
503
 
            revision_id = kwargs.get('revision_id', None)
504
 
        if len(args):
505
 
            to_bzrdir = args[0]
506
 
        else:
507
 
            # no default to raise if not provided.
508
 
            to_bzrdir = kwargs.get('to_bzrdir')
509
 
        result = self._format.initialize(to_bzrdir)
510
 
        self.copy_content_into(result, revision_id=revision_id)
511
 
        return  result
512
 
 
513
 
    @needs_read_lock
514
 
    def sprout(self, to_bzrdir, revision_id=None):
515
 
        """Create a new line of development from the branch, into to_bzrdir.
516
 
        
517
 
        revision_id: if not None, the revision history in the new branch will
518
 
                     be truncated to end with revision_id.
519
 
        """
520
 
        result = self._format.initialize(to_bzrdir)
521
 
        self.copy_content_into(result, revision_id=revision_id)
522
 
        result.set_parent(self.bzrdir.root_transport.base)
523
 
        return result
524
 
 
525
 
    @needs_read_lock
526
 
    def copy_content_into(self, destination, revision_id=None):
527
 
        """Copy the content of self into destination.
528
 
 
529
 
        revision_id: if not None, the revision history in the new branch will
530
 
                     be truncated to end with revision_id.
531
 
        """
532
 
        new_history = self.revision_history()
533
 
        if revision_id is not None:
534
 
            try:
535
 
                new_history = new_history[:new_history.index(revision_id) + 1]
536
 
            except ValueError:
537
 
                rev = self.repository.get_revision(revision_id)
538
 
                new_history = rev.get_history(self.repository)[1:]
539
 
        destination.set_revision_history(new_history)
540
 
        parent = self.get_parent()
541
 
        if parent:
542
 
            destination.set_parent(parent)
543
 
 
544
 
    @needs_read_lock
545
 
    def check(self):
546
 
        """Check consistency of the branch.
547
 
 
548
 
        In particular this checks that revisions given in the revision-history
549
 
        do actually match up in the revision graph, and that they're all 
550
 
        present in the repository.
551
 
        
552
 
        Callers will typically also want to check the repository.
553
 
 
554
 
        :return: A BranchCheckResult.
555
 
        """
556
 
        mainline_parent_id = None
557
 
        for revision_id in self.revision_history():
558
 
            try:
559
 
                revision = self.repository.get_revision(revision_id)
560
 
            except errors.NoSuchRevision, e:
561
 
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
562
 
                            % revision_id)
563
 
            # In general the first entry on the revision history has no parents.
564
 
            # But it's not illegal for it to have parents listed; this can happen
565
 
            # in imports from Arch when the parents weren't reachable.
566
 
            if mainline_parent_id is not None:
567
 
                if mainline_parent_id not in revision.parent_ids:
568
 
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
569
 
                                        "parents of {%s}"
570
 
                                        % (mainline_parent_id, revision_id))
571
 
            mainline_parent_id = revision_id
572
 
        return BranchCheckResult(self)
573
 
 
574
 
 
575
 
class BranchFormat(object):
576
 
    """An encapsulation of the initialization and open routines for a format.
577
 
 
578
 
    Formats provide three things:
579
 
     * An initialization routine,
580
 
     * a format string,
581
 
     * an open routine.
582
 
 
583
 
    Formats are placed in an dict by their format string for reference 
584
 
    during branch opening. Its not required that these be instances, they
585
 
    can be classes themselves with class methods - it simply depends on 
586
 
    whether state is needed for a given format or not.
587
 
 
588
 
    Once a format is deprecated, just deprecate the initialize and open
589
 
    methods on the format class. Do not deprecate the object, as the 
590
 
    object will be created every time regardless.
591
 
    """
592
 
 
593
 
    _default_format = None
594
 
    """The default format used for new branches."""
595
 
 
596
 
    _formats = {}
597
 
    """The known formats."""
598
 
 
599
 
    @classmethod
600
 
    def find_format(klass, a_bzrdir):
601
 
        """Return the format for the branch object in a_bzrdir."""
 
1119
        
 
1120
    def sign_revision(self, revision_id, gpg_strategy):
 
1121
        plaintext = Testament.from_revision(self, revision_id).as_short_text()
 
1122
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
 
1123
 
 
1124
    @needs_write_lock
 
1125
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
 
1126
        self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)), 
 
1127
                                revision_id, "sig")
 
1128
 
 
1129
    # Do we want a read lock?
 
1130
    def get_bound_location(self):
 
1131
        bound_path = self._rel_controlfilename('bound')
602
1132
        try:
603
 
            transport = a_bzrdir.get_branch_transport(None)
604
 
            format_string = transport.get("format").read()
605
 
            return klass._formats[format_string]
 
1133
            f = self._transport.get(bound_path)
606
1134
        except NoSuchFile:
607
 
            raise NotBranchError(path=transport.base)
608
 
        except KeyError:
609
 
            raise errors.UnknownFormatError(format=format_string)
610
 
 
611
 
    @classmethod
612
 
    def get_default_format(klass):
613
 
        """Return the current default format."""
614
 
        return klass._default_format
615
 
 
616
 
    def get_format_string(self):
617
 
        """Return the ASCII format string that identifies this format."""
618
 
        raise NotImplementedError(self.get_format_string)
619
 
 
620
 
    def get_format_description(self):
621
 
        """Return the short format description for this format."""
622
 
        raise NotImplementedError(self.get_format_string)
623
 
 
624
 
    def initialize(self, a_bzrdir):
625
 
        """Create a branch of this format in a_bzrdir."""
626
 
        raise NotImplementedError(self.initialize)
627
 
 
628
 
    def is_supported(self):
629
 
        """Is this format supported?
630
 
 
631
 
        Supported formats can be initialized and opened.
632
 
        Unsupported formats may not support initialization or committing or 
633
 
        some other features depending on the reason for not being supported.
634
 
        """
635
 
        return True
636
 
 
637
 
    def open(self, a_bzrdir, _found=False):
638
 
        """Return the branch object for a_bzrdir
639
 
 
640
 
        _found is a private parameter, do not use it. It is used to indicate
641
 
               if format probing has already be done.
642
 
        """
643
 
        raise NotImplementedError(self.open)
644
 
 
645
 
    @classmethod
646
 
    def register_format(klass, format):
647
 
        klass._formats[format.get_format_string()] = format
648
 
 
649
 
    @classmethod
650
 
    def set_default_format(klass, format):
651
 
        klass._default_format = format
652
 
 
653
 
    @classmethod
654
 
    def unregister_format(klass, format):
655
 
        assert klass._formats[format.get_format_string()] is format
656
 
        del klass._formats[format.get_format_string()]
657
 
 
658
 
    def __str__(self):
659
 
        return self.get_format_string().rstrip()
660
 
 
661
 
 
662
 
class BzrBranchFormat4(BranchFormat):
663
 
    """Bzr branch format 4.
664
 
 
665
 
    This format has:
666
 
     - a revision-history file.
667
 
     - a branch-lock lock file [ to be shared with the bzrdir ]
668
 
    """
669
 
 
670
 
    def get_format_description(self):
671
 
        """See BranchFormat.get_format_description()."""
672
 
        return "Branch format 4"
673
 
 
674
 
    def initialize(self, a_bzrdir):
675
 
        """Create a branch of this format in a_bzrdir."""
676
 
        mutter('creating branch in %s', a_bzrdir.transport.base)
677
 
        branch_transport = a_bzrdir.get_branch_transport(self)
678
 
        utf8_files = [('revision-history', ''),
679
 
                      ('branch-name', ''),
680
 
                      ]
681
 
        control_files = LockableFiles(branch_transport, 'branch-lock',
682
 
                                      TransportLock)
683
 
        control_files.create_lock()
684
 
        control_files.lock_write()
685
 
        try:
686
 
            for file, content in utf8_files:
687
 
                control_files.put_utf8(file, content)
688
 
        finally:
689
 
            control_files.unlock()
690
 
        return self.open(a_bzrdir, _found=True)
691
 
 
692
 
    def __init__(self):
693
 
        super(BzrBranchFormat4, self).__init__()
694
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
695
 
 
696
 
    def open(self, a_bzrdir, _found=False):
697
 
        """Return the branch object for a_bzrdir
698
 
 
699
 
        _found is a private parameter, do not use it. It is used to indicate
700
 
               if format probing has already be done.
701
 
        """
702
 
        if not _found:
703
 
            # we are being called directly and must probe.
704
 
            raise NotImplementedError
705
 
        return BzrBranch(_format=self,
706
 
                         _control_files=a_bzrdir._control_files,
707
 
                         a_bzrdir=a_bzrdir,
708
 
                         _repository=a_bzrdir.open_repository())
709
 
 
710
 
    def __str__(self):
711
 
        return "Bazaar-NG branch format 4"
712
 
 
713
 
 
714
 
class BzrBranchFormat5(BranchFormat):
715
 
    """Bzr branch format 5.
716
 
 
717
 
    This format has:
718
 
     - a revision-history file.
719
 
     - a format string
720
 
     - a lock dir guarding the branch itself
721
 
     - all of this stored in a branch/ subdirectory
722
 
     - works with shared repositories.
723
 
 
724
 
    This format is new in bzr 0.8.
725
 
    """
726
 
 
727
 
    def get_format_string(self):
728
 
        """See BranchFormat.get_format_string()."""
729
 
        return "Bazaar-NG branch format 5\n"
730
 
 
731
 
    def get_format_description(self):
732
 
        """See BranchFormat.get_format_description()."""
733
 
        return "Branch format 5"
734
 
        
735
 
    def initialize(self, a_bzrdir):
736
 
        """Create a branch of this format in a_bzrdir."""
737
 
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
738
 
        branch_transport = a_bzrdir.get_branch_transport(self)
739
 
        utf8_files = [('revision-history', ''),
740
 
                      ('branch-name', ''),
741
 
                      ]
742
 
        control_files = LockableFiles(branch_transport, 'lock', lockdir.LockDir)
743
 
        control_files.create_lock()
744
 
        control_files.lock_write()
745
 
        control_files.put_utf8('format', self.get_format_string())
746
 
        try:
747
 
            for file, content in utf8_files:
748
 
                control_files.put_utf8(file, content)
749
 
        finally:
750
 
            control_files.unlock()
751
 
        return self.open(a_bzrdir, _found=True, )
752
 
 
753
 
    def __init__(self):
754
 
        super(BzrBranchFormat5, self).__init__()
755
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
756
 
 
757
 
    def open(self, a_bzrdir, _found=False):
758
 
        """Return the branch object for a_bzrdir
759
 
 
760
 
        _found is a private parameter, do not use it. It is used to indicate
761
 
               if format probing has already be done.
762
 
        """
763
 
        if not _found:
764
 
            format = BranchFormat.find_format(a_bzrdir)
765
 
            assert format.__class__ == self.__class__
766
 
        transport = a_bzrdir.get_branch_transport(None)
767
 
        control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
768
 
        return BzrBranch5(_format=self,
769
 
                          _control_files=control_files,
770
 
                          a_bzrdir=a_bzrdir,
771
 
                          _repository=a_bzrdir.find_repository())
772
 
 
773
 
    def __str__(self):
774
 
        return "Bazaar-NG Metadir branch format 5"
775
 
 
776
 
 
777
 
class BranchReferenceFormat(BranchFormat):
778
 
    """Bzr branch reference format.
779
 
 
780
 
    Branch references are used in implementing checkouts, they
781
 
    act as an alias to the real branch which is at some other url.
782
 
 
783
 
    This format has:
784
 
     - A location file
785
 
     - a format string
786
 
    """
787
 
 
788
 
    def get_format_string(self):
789
 
        """See BranchFormat.get_format_string()."""
790
 
        return "Bazaar-NG Branch Reference Format 1\n"
791
 
 
792
 
    def get_format_description(self):
793
 
        """See BranchFormat.get_format_description()."""
794
 
        return "Checkout reference format 1"
795
 
        
796
 
    def initialize(self, a_bzrdir, target_branch=None):
797
 
        """Create a branch of this format in a_bzrdir."""
798
 
        if target_branch is None:
799
 
            # this format does not implement branch itself, thus the implicit
800
 
            # creation contract must see it as uninitializable
801
 
            raise errors.UninitializableFormat(self)
802
 
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
803
 
        branch_transport = a_bzrdir.get_branch_transport(self)
804
 
        # FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
805
 
        branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
806
 
        branch_transport.put('format', StringIO(self.get_format_string()))
807
 
        return self.open(a_bzrdir, _found=True)
808
 
 
809
 
    def __init__(self):
810
 
        super(BranchReferenceFormat, self).__init__()
811
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
812
 
 
813
 
    def _make_reference_clone_function(format, a_branch):
814
 
        """Create a clone() routine for a branch dynamically."""
815
 
        def clone(to_bzrdir, revision_id=None):
816
 
            """See Branch.clone()."""
817
 
            return format.initialize(to_bzrdir, a_branch)
818
 
            # cannot obey revision_id limits when cloning a reference ...
819
 
            # FIXME RBC 20060210 either nuke revision_id for clone, or
820
 
            # emit some sort of warning/error to the caller ?!
821
 
        return clone
822
 
 
823
 
    def open(self, a_bzrdir, _found=False):
824
 
        """Return the branch that the branch reference in a_bzrdir points at.
825
 
 
826
 
        _found is a private parameter, do not use it. It is used to indicate
827
 
               if format probing has already be done.
828
 
        """
829
 
        if not _found:
830
 
            format = BranchFormat.find_format(a_bzrdir)
831
 
            assert format.__class__ == self.__class__
832
 
        transport = a_bzrdir.get_branch_transport(None)
833
 
        real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
834
 
        result = real_bzrdir.open_branch()
835
 
        # this changes the behaviour of result.clone to create a new reference
836
 
        # rather than a copy of the content of the branch.
837
 
        # I did not use a proxy object because that needs much more extensive
838
 
        # testing, and we are only changing one behaviour at the moment.
839
 
        # If we decide to alter more behaviours - i.e. the implicit nickname
840
 
        # then this should be refactored to introduce a tested proxy branch
841
 
        # and a subclass of that for use in overriding clone() and ....
842
 
        # - RBC 20060210
843
 
        result.clone = self._make_reference_clone_function(result)
844
 
        return result
845
 
 
846
 
 
847
 
# formats which have no format string are not discoverable
848
 
# and not independently creatable, so are not registered.
849
 
__default_format = BzrBranchFormat5()
850
 
BranchFormat.register_format(__default_format)
851
 
BranchFormat.register_format(BranchReferenceFormat())
852
 
BranchFormat.set_default_format(__default_format)
853
 
_legacy_formats = [BzrBranchFormat4(),
854
 
                   ]
855
 
 
856
 
class BzrBranch(Branch):
857
 
    """A branch stored in the actual filesystem.
858
 
 
859
 
    Note that it's "local" in the context of the filesystem; it doesn't
860
 
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
861
 
    it's writable, and can be accessed via the normal filesystem API.
862
 
    """
863
 
    
864
 
    def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
865
 
                 relax_version_check=DEPRECATED_PARAMETER, _format=None,
866
 
                 _control_files=None, a_bzrdir=None, _repository=None):
867
 
        """Create new branch object at a particular location.
868
 
 
869
 
        transport -- A Transport object, defining how to access files.
870
 
        
871
 
        init -- If True, create new control files in a previously
872
 
             unversioned directory.  If False, the branch must already
873
 
             be versioned.
874
 
 
875
 
        relax_version_check -- If true, the usual check for the branch
876
 
            version is not applied.  This is intended only for
877
 
            upgrade/recovery type use; it's not guaranteed that
878
 
            all operations will work on old format branches.
879
 
        """
880
 
        if a_bzrdir is None:
881
 
            self.bzrdir = bzrdir.BzrDir.open(transport.base)
882
 
        else:
883
 
            self.bzrdir = a_bzrdir
884
 
        self._transport = self.bzrdir.transport.clone('..')
885
 
        self._base = self._transport.base
886
 
        self._format = _format
887
 
        if _control_files is None:
888
 
            raise ValueError('BzrBranch _control_files is None')
889
 
        self.control_files = _control_files
890
 
        if deprecated_passed(init):
891
 
            warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
892
 
                 "deprecated as of bzr 0.8. Please use Branch.create().",
893
 
                 DeprecationWarning,
894
 
                 stacklevel=2)
895
 
            if init:
896
 
                # this is slower than before deprecation, oh well never mind.
897
 
                # -> its deprecated.
898
 
                self._initialize(transport.base)
899
 
        self._check_format(_format)
900
 
        if deprecated_passed(relax_version_check):
901
 
            warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
902
 
                 "relax_version_check parameter is deprecated as of bzr 0.8. "
903
 
                 "Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
904
 
                 "open() method.",
905
 
                 DeprecationWarning,
906
 
                 stacklevel=2)
907
 
            if (not relax_version_check
908
 
                and not self._format.is_supported()):
909
 
                raise errors.UnsupportedFormatError(format=fmt)
910
 
        if deprecated_passed(transport):
911
 
            warn("BzrBranch.__init__(transport=XXX...): The transport "
912
 
                 "parameter is deprecated as of bzr 0.8. "
913
 
                 "Please use Branch.open, or bzrdir.open_branch().",
914
 
                 DeprecationWarning,
915
 
                 stacklevel=2)
916
 
        self.repository = _repository
917
 
 
918
 
    def __str__(self):
919
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
920
 
 
921
 
    __repr__ = __str__
922
 
 
923
 
    def __del__(self):
924
 
        # TODO: It might be best to do this somewhere else,
925
 
        # but it is nice for a Branch object to automatically
926
 
        # cache it's information.
927
 
        # Alternatively, we could have the Transport objects cache requests
928
 
        # See the earlier discussion about how major objects (like Branch)
929
 
        # should never expect their __del__ function to run.
930
 
        # XXX: cache_root seems to be unused, 2006-01-13 mbp
931
 
        if hasattr(self, 'cache_root') and self.cache_root is not None:
932
 
            try:
933
 
                osutils.rmtree(self.cache_root)
934
 
            except:
935
 
                pass
936
 
            self.cache_root = None
937
 
 
938
 
    def _get_base(self):
939
 
        return self._base
940
 
 
941
 
    base = property(_get_base, doc="The URL for the root of this branch.")
942
 
 
943
 
    def _finish_transaction(self):
944
 
        """Exit the current transaction."""
945
 
        return self.control_files._finish_transaction()
946
 
 
947
 
    def get_transaction(self):
948
 
        """Return the current active transaction.
949
 
 
950
 
        If no transaction is active, this returns a passthrough object
951
 
        for which all data is immediately flushed and no caching happens.
952
 
        """
953
 
        # this is an explicit function so that we can do tricky stuff
954
 
        # when the storage in rev_storage is elsewhere.
955
 
        # we probably need to hook the two 'lock a location' and 
956
 
        # 'have a transaction' together more delicately, so that
957
 
        # we can have two locks (branch and storage) and one transaction
958
 
        # ... and finishing the transaction unlocks both, but unlocking
959
 
        # does not. - RBC 20051121
960
 
        return self.control_files.get_transaction()
961
 
 
962
 
    def _set_transaction(self, transaction):
963
 
        """Set a new active transaction."""
964
 
        return self.control_files._set_transaction(transaction)
965
 
 
966
 
    def abspath(self, name):
967
 
        """See Branch.abspath."""
968
 
        return self.control_files._transport.abspath(name)
969
 
 
970
 
    def _check_format(self, format):
971
 
        """Identify the branch format if needed.
972
 
 
973
 
        The format is stored as a reference to the format object in
974
 
        self._format for code that needs to check it later.
975
 
 
976
 
        The format parameter is either None or the branch format class
977
 
        used to open this branch.
978
 
 
979
 
        FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
980
 
        """
981
 
        if format is None:
982
 
            format = BranchFormat.find_format(self.bzrdir)
983
 
        self._format = format
984
 
        mutter("got branch format %s", self._format)
985
 
 
986
 
    @needs_read_lock
987
 
    def get_root_id(self):
988
 
        """See Branch.get_root_id."""
989
 
        tree = self.repository.revision_tree(self.last_revision())
990
 
        return tree.inventory.root.file_id
991
 
 
992
 
    def is_locked(self):
993
 
        return self.control_files.is_locked()
994
 
 
995
 
    def lock_write(self):
996
 
        # TODO: test for failed two phase locks. This is known broken.
997
 
        self.control_files.lock_write()
998
 
        self.repository.lock_write()
999
 
 
1000
 
    def lock_read(self):
1001
 
        # TODO: test for failed two phase locks. This is known broken.
1002
 
        self.control_files.lock_read()
1003
 
        self.repository.lock_read()
1004
 
 
1005
 
    def unlock(self):
1006
 
        # TODO: test for failed two phase locks. This is known broken.
1007
 
        try:
1008
 
            self.repository.unlock()
1009
 
        finally:
1010
 
            self.control_files.unlock()
1011
 
        
1012
 
    def peek_lock_mode(self):
1013
 
        if self.control_files._lock_count == 0:
1014
 
            return None
1015
 
        else:
1016
 
            return self.control_files._lock_mode
1017
 
 
1018
 
    def get_physical_lock_status(self):
1019
 
        return self.control_files.get_physical_lock_status()
1020
 
 
1021
 
    @needs_read_lock
1022
 
    def print_file(self, file, revision_id):
1023
 
        """See Branch.print_file."""
1024
 
        return self.repository.print_file(file, revision_id)
1025
 
 
1026
 
    @needs_write_lock
1027
 
    def append_revision(self, *revision_ids):
1028
 
        """See Branch.append_revision."""
1029
 
        for revision_id in revision_ids:
1030
 
            mutter("add {%s} to revision-history" % revision_id)
1031
 
        rev_history = self.revision_history()
1032
 
        rev_history.extend(revision_ids)
1033
 
        self.set_revision_history(rev_history)
1034
 
 
1035
 
    @needs_write_lock
1036
 
    def set_revision_history(self, rev_history):
1037
 
        """See Branch.set_revision_history."""
1038
 
        self.control_files.put_utf8(
1039
 
            'revision-history', '\n'.join(rev_history))
1040
 
        transaction = self.get_transaction()
1041
 
        history = transaction.map.find_revision_history()
1042
 
        if history is not None:
1043
 
            # update the revision history in the identity map.
1044
 
            history[:] = list(rev_history)
1045
 
            # this call is disabled because revision_history is 
1046
 
            # not really an object yet, and the transaction is for objects.
1047
 
            # transaction.register_dirty(history)
1048
 
        else:
1049
 
            transaction.map.add_revision_history(rev_history)
1050
 
            # this call is disabled because revision_history is 
1051
 
            # not really an object yet, and the transaction is for objects.
1052
 
            # transaction.register_clean(history)
1053
 
 
1054
 
    @needs_read_lock
1055
 
    def revision_history(self):
1056
 
        """See Branch.revision_history."""
1057
 
        transaction = self.get_transaction()
1058
 
        history = transaction.map.find_revision_history()
1059
 
        if history is not None:
1060
 
            mutter("cache hit for revision-history in %s", self)
1061
 
            return list(history)
1062
 
        history = [l.rstrip('\r\n') for l in
1063
 
                self.control_files.get_utf8('revision-history').readlines()]
1064
 
        transaction.map.add_revision_history(history)
1065
 
        # this call is disabled because revision_history is 
1066
 
        # not really an object yet, and the transaction is for objects.
1067
 
        # transaction.register_clean(history, precious=True)
1068
 
        return list(history)
1069
 
 
1070
 
    @needs_write_lock
1071
 
    def generate_revision_history(self, revision_id, last_rev=None, 
1072
 
        other_branch=None):
1073
 
        """Create a new revision history that will finish with revision_id.
1074
 
        
1075
 
        :param revision_id: the new tip to use.
1076
 
        :param last_rev: The previous last_revision. If not None, then this
1077
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
1078
 
        :param other_branch: The other branch that DivergedBranches should
1079
 
            raise with respect to.
1080
 
        """
1081
 
        # stop_revision must be a descendant of last_revision
1082
 
        stop_graph = self.repository.get_revision_graph(revision_id)
1083
 
        if last_rev is not None and last_rev not in stop_graph:
1084
 
            # our previous tip is not merged into stop_revision
1085
 
            raise errors.DivergedBranches(self, other_branch)
1086
 
        # make a new revision history from the graph
1087
 
        current_rev_id = revision_id
1088
 
        new_history = []
1089
 
        while current_rev_id not in (None, revision.NULL_REVISION):
1090
 
            new_history.append(current_rev_id)
1091
 
            current_rev_id_parents = stop_graph[current_rev_id]
1092
 
            try:
1093
 
                current_rev_id = current_rev_id_parents[0]
1094
 
            except IndexError:
1095
 
                current_rev_id = None
1096
 
        new_history.reverse()
1097
 
        self.set_revision_history(new_history)
1098
 
 
1099
 
    @needs_write_lock
1100
 
    def update_revisions(self, other, stop_revision=None):
1101
 
        """See Branch.update_revisions."""
1102
 
        other.lock_read()
1103
 
        try:
1104
 
            if stop_revision is None:
1105
 
                stop_revision = other.last_revision()
1106
 
                if stop_revision is None:
1107
 
                    # if there are no commits, we're done.
1108
 
                    return
1109
 
            # whats the current last revision, before we fetch [and change it
1110
 
            # possibly]
1111
 
            last_rev = self.last_revision()
1112
 
            # we fetch here regardless of whether we need to so that we pickup
1113
 
            # filled in ghosts.
1114
 
            self.fetch(other, stop_revision)
1115
 
            my_ancestry = self.repository.get_ancestry(last_rev)
1116
 
            if stop_revision in my_ancestry:
1117
 
                # last_revision is a descendant of stop_revision
1118
 
                return
1119
 
            self.generate_revision_history(stop_revision, last_rev=last_rev,
1120
 
                other_branch=other)
1121
 
        finally:
1122
 
            other.unlock()
1123
 
 
1124
 
    def basis_tree(self):
1125
 
        """See Branch.basis_tree."""
1126
 
        return self.repository.revision_tree(self.last_revision())
1127
 
 
1128
 
    @deprecated_method(zero_eight)
1129
 
    def working_tree(self):
1130
 
        """Create a Working tree object for this branch."""
1131
 
 
1132
 
        from bzrlib.transport.local import LocalTransport
1133
 
        if (self.base.find('://') != -1 or 
1134
 
            not isinstance(self._transport, LocalTransport)):
1135
 
            raise NoWorkingTree(self.base)
1136
 
        return self.bzrdir.open_workingtree()
1137
 
 
1138
 
    @needs_write_lock
1139
 
    def pull(self, source, overwrite=False, stop_revision=None):
1140
 
        """See Branch.pull."""
1141
 
        source.lock_read()
1142
 
        try:
1143
 
            old_count = len(self.revision_history())
1144
 
            try:
1145
 
                self.update_revisions(source,stop_revision)
1146
 
            except DivergedBranches:
1147
 
                if not overwrite:
1148
 
                    raise
1149
 
            if overwrite:
1150
 
                self.set_revision_history(source.revision_history())
1151
 
            new_count = len(self.revision_history())
1152
 
            return new_count - old_count
1153
 
        finally:
1154
 
            source.unlock()
1155
 
 
1156
 
    def get_parent(self):
1157
 
        """See Branch.get_parent."""
1158
 
 
1159
 
        _locs = ['parent', 'pull', 'x-pull']
1160
 
        assert self.base[-1] == '/'
1161
 
        for l in _locs:
1162
 
            try:
1163
 
                parent = self.control_files.get(l).read().strip('\n')
1164
 
            except NoSuchFile:
1165
 
                continue
1166
 
            # This is an old-format absolute path to a local branch
1167
 
            # turn it into a url
1168
 
            if parent.startswith('/'):
1169
 
                parent = urlutils.local_path_to_url(parent.decode('utf8'))
1170
 
            return urlutils.join(self.base[:-1], parent)
1171
 
        return None
1172
 
 
1173
 
    def get_push_location(self):
1174
 
        """See Branch.get_push_location."""
1175
 
        push_loc = self.get_config().get_user_option('push_location')
1176
 
        return push_loc
1177
 
 
1178
 
    def set_push_location(self, location):
1179
 
        """See Branch.set_push_location."""
1180
 
        self.get_config().set_user_option('push_location', location, 
1181
 
                                          local=True)
1182
 
 
1183
 
    @needs_write_lock
1184
 
    def set_parent(self, url):
1185
 
        """See Branch.set_parent."""
1186
 
        # TODO: Maybe delete old location files?
1187
 
        # URLs should never be unicode, even on the local fs,
1188
 
        # FIXUP this and get_parent in a future branch format bump:
1189
 
        # read and rewrite the file, and have the new format code read
1190
 
        # using .get not .get_utf8. RBC 20060125
1191
 
        if url is None:
1192
 
            self.control_files._transport.delete('parent')
1193
 
        else:
1194
 
            if isinstance(url, unicode):
1195
 
                try: 
1196
 
                    url = url.encode('ascii')
1197
 
                except UnicodeEncodeError:
1198
 
                    raise bzrlib.errors.InvalidURL(url,
1199
 
                        "Urls must be 7-bit ascii, "
1200
 
                        "use bzrlib.urlutils.escape")
1201
 
                    
1202
 
            url = urlutils.relative_url(self.base, url)
1203
 
            self.control_files.put('parent', url + '\n')
1204
 
 
1205
 
    @deprecated_function(zero_nine)
1206
 
    def tree_config(self):
1207
 
        """DEPRECATED; call get_config instead.  
1208
 
        TreeConfig has become part of BranchConfig."""
1209
 
        return TreeConfig(self)
1210
 
 
1211
 
 
1212
 
class BzrBranch5(BzrBranch):
1213
 
    """A format 5 branch. This supports new features over plan branches.
1214
 
 
1215
 
    It has support for a master_branch which is the data for bound branches.
1216
 
    """
1217
 
 
1218
 
    def __init__(self,
1219
 
                 _format,
1220
 
                 _control_files,
1221
 
                 a_bzrdir,
1222
 
                 _repository):
1223
 
        super(BzrBranch5, self).__init__(_format=_format,
1224
 
                                         _control_files=_control_files,
1225
 
                                         a_bzrdir=a_bzrdir,
1226
 
                                         _repository=_repository)
1227
 
        
1228
 
    @needs_write_lock
1229
 
    def pull(self, source, overwrite=False, stop_revision=None):
1230
 
        """Updates branch.pull to be bound branch aware."""
1231
 
        bound_location = self.get_bound_location()
1232
 
        if source.base != bound_location:
1233
 
            # not pulling from master, so we need to update master.
1234
 
            master_branch = self.get_master_branch()
1235
 
            if master_branch:
1236
 
                master_branch.pull(source)
1237
 
                source = master_branch
1238
 
        return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1239
 
 
1240
 
    def get_bound_location(self):
1241
 
        try:
1242
 
            return self.control_files.get_utf8('bound').read()[:-1]
1243
 
        except errors.NoSuchFile:
1244
 
            return None
1245
 
 
1246
 
    @needs_read_lock
1247
 
    def get_master_branch(self):
1248
 
        """Return the branch we are bound to.
1249
 
        
1250
 
        :return: Either a Branch, or None
1251
 
 
1252
 
        This could memoise the branch, but if thats done
1253
 
        it must be revalidated on each new lock.
1254
 
        So for now we just don't memoise it.
1255
 
        # RBC 20060304 review this decision.
1256
 
        """
1257
 
        bound_loc = self.get_bound_location()
1258
 
        if not bound_loc:
1259
 
            return None
1260
 
        try:
1261
 
            return Branch.open(bound_loc)
1262
 
        except (errors.NotBranchError, errors.ConnectionError), e:
1263
 
            raise errors.BoundBranchConnectionFailure(
1264
 
                    self, bound_loc, e)
 
1135
            return None
 
1136
        else:
 
1137
            return f.read().strip()
1265
1138
 
1266
1139
    @needs_write_lock
1267
1140
    def set_bound_location(self, location):
1268
 
        """Set the target where this branch is bound to.
1269
 
 
1270
 
        :param location: URL to the target branch
1271
 
        """
1272
 
        if location:
1273
 
            self.control_files.put_utf8('bound', location+'\n')
1274
 
        else:
1275
 
            try:
1276
 
                self.control_files._transport.delete('bound')
1277
 
            except NoSuchFile:
1278
 
                return False
1279
 
            return True
 
1141
        self.put_controlfile('bound', location+'\n')
1280
1142
 
1281
1143
    @needs_write_lock
1282
1144
    def bind(self, other):
1285
1147
        :param other: The branch to bind to
1286
1148
        :type other: Branch
1287
1149
        """
1288
 
        # TODO: jam 20051230 Consider checking if the target is bound
1289
 
        #       It is debatable whether you should be able to bind to
1290
 
        #       a branch which is itself bound.
1291
 
        #       Committing is obviously forbidden,
1292
 
        #       but binding itself may not be.
1293
 
        #       Since we *have* to check at commit time, we don't
1294
 
        #       *need* to check here
1295
 
        self.pull(other)
1296
 
 
1297
 
        # we are now equal to or a suffix of other.
 
1150
        # It is debatable whether you should be able to bind to
 
1151
        # a branch which is itself bound.
 
1152
        # Committing is obviously forbidden, but binding itself may not be.
 
1153
        #if other.is_bound():
 
1154
        #    raise errors.CannotBind(msg='branch %s is bound' % (other.base))
 
1155
        try:
 
1156
            self.working_tree().pull(other)
 
1157
        except NoWorkingTree:
 
1158
            self.pull(other)
1298
1159
 
1299
1160
        # Since we have 'pulled' from the remote location,
1300
1161
        # now we should try to pull in the opposite direction
1303
1164
        # There may be a different check you could do here
1304
1165
        # rather than actually trying to install revisions remotely.
1305
1166
        # TODO: capture an exception which indicates the remote branch
1306
 
        #       is not writable. 
 
1167
        #       is not writeable. 
1307
1168
        #       If it is up-to-date, this probably should not be a failure
1308
 
        
1309
 
        # lock other for write so the revision-history syncing cannot race
1310
 
        other.lock_write()
1311
1169
        try:
 
1170
            other.working_tree().pull(self)
 
1171
        except NoWorkingTree:
1312
1172
            other.pull(self)
1313
 
            # if this does not error, other now has the same last rev we do
1314
 
            # it can only error if the pull from other was concurrent with
1315
 
            # a commit to other from someone else.
1316
 
 
1317
 
            # until we ditch revision-history, we need to sync them up:
1318
 
            self.set_revision_history(other.revision_history())
1319
 
            # now other and self are up to date with each other and have the
1320
 
            # same revision-history.
1321
 
        finally:
1322
 
            other.unlock()
1323
 
 
 
1173
 
 
1174
        # Make sure the revision histories are now identical
 
1175
        other_rh = other.revision_history()
 
1176
        self.set_revision_history(other_rh)
 
1177
 
 
1178
        # Both branches should now be at the same revision
1324
1179
        self.set_bound_location(other.base)
1325
1180
 
1326
1181
    @needs_write_lock
1327
1182
    def unbind(self):
1328
1183
        """If bound, unbind"""
1329
 
        return self.set_bound_location(None)
1330
 
 
1331
 
    @needs_write_lock
1332
 
    def update(self):
1333
 
        """Synchronise this branch with the master branch if any. 
1334
 
 
1335
 
        :return: None or the last_revision that was pivoted out during the
1336
 
                 update.
 
1184
        bound_path = self._rel_controlfilename('bound')
 
1185
        try:
 
1186
            self._transport.delete(bound_path)
 
1187
        except NoSuchFile:
 
1188
            pass
 
1189
 
 
1190
    @needs_read_lock
 
1191
    def _update_remote_location(self, other_loc, revision_history):
 
1192
        """Make sure the remote location has the local changes.
 
1193
 
 
1194
        :param other_loc: Path to the other location
 
1195
        :param revision_history: Total history to be updated
 
1196
        :return: The remote revision_history
1337
1197
        """
1338
 
        master = self.get_master_branch()
1339
 
        if master is not None:
1340
 
            old_tip = self.last_revision()
1341
 
            self.pull(master, overwrite=True)
1342
 
            if old_tip in self.repository.get_ancestry(self.last_revision()):
1343
 
                return None
1344
 
            return old_tip
1345
 
        return None
1346
 
 
1347
 
 
1348
 
class BranchTestProviderAdapter(object):
1349
 
    """A tool to generate a suite testing multiple branch formats at once.
1350
 
 
1351
 
    This is done by copying the test once for each transport and injecting
1352
 
    the transport_server, transport_readonly_server, and branch_format
1353
 
    classes into each copy. Each copy is also given a new id() to make it
1354
 
    easy to identify.
 
1198
        from bzrlib.fetch import greedy_fetch
 
1199
        mutter('_update_remote_location: %r, %r', other_loc, revision_history)
 
1200
        other = Branch.open(other_loc)
 
1201
        bound_loc = other.get_bound_location()
 
1202
        if bound_loc is not None:
 
1203
            raise errors.CannotInstallRevisions('Remote tree is bound')
 
1204
        other.lock_write()
 
1205
        try:
 
1206
            # update_revisions should also append to the revision history.
 
1207
            other.update_revisions(self, other_history=revision_history)
 
1208
            return other.revision_history()
 
1209
        finally:
 
1210
            other.unlock()
 
1211
 
 
1212
 
 
1213
class ScratchBranch(_Branch):
 
1214
    """Special test class: a branch that cleans up after itself.
 
1215
 
 
1216
    >>> b = ScratchBranch()
 
1217
    >>> isdir(b.base)
 
1218
    True
 
1219
    >>> bd = b.base
 
1220
    >>> b._transport.__del__()
 
1221
    >>> isdir(bd)
 
1222
    False
1355
1223
    """
1356
1224
 
1357
 
    def __init__(self, transport_server, transport_readonly_server, formats):
1358
 
        self._transport_server = transport_server
1359
 
        self._transport_readonly_server = transport_readonly_server
1360
 
        self._formats = formats
 
1225
    def __init__(self, files=[], dirs=[], transport=None):
 
1226
        """Make a test branch.
 
1227
 
 
1228
        This creates a temporary directory and runs init-tree in it.
 
1229
 
 
1230
        If any files are listed, they are created in the working copy.
 
1231
        """
 
1232
        if transport is None:
 
1233
            transport = bzrlib.transport.local.ScratchTransport()
 
1234
            super(ScratchBranch, self).__init__(transport, init=True)
 
1235
        else:
 
1236
            super(ScratchBranch, self).__init__(transport)
 
1237
 
 
1238
        for d in dirs:
 
1239
            self._transport.mkdir(d)
 
1240
            
 
1241
        for f in files:
 
1242
            self._transport.put(f, 'content of %s' % f)
 
1243
 
 
1244
 
 
1245
    def clone(self):
 
1246
        """
 
1247
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1248
        >>> clone = orig.clone()
 
1249
        >>> if os.name != 'nt':
 
1250
        ...   os.path.samefile(orig.base, clone.base)
 
1251
        ... else:
 
1252
        ...   orig.base == clone.base
 
1253
        ...
 
1254
        False
 
1255
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1256
        True
 
1257
        """
 
1258
        from shutil import copytree
 
1259
        from tempfile import mkdtemp
 
1260
        base = mkdtemp()
 
1261
        os.rmdir(base)
 
1262
        copytree(self.base, base, symlinks=True)
 
1263
        return ScratchBranch(
 
1264
            transport=bzrlib.transport.local.ScratchTransport(base))
1361
1265
    
1362
 
    def adapt(self, test):
1363
 
        result = TestSuite()
1364
 
        for branch_format, bzrdir_format in self._formats:
1365
 
            new_test = deepcopy(test)
1366
 
            new_test.transport_server = self._transport_server
1367
 
            new_test.transport_readonly_server = self._transport_readonly_server
1368
 
            new_test.bzrdir_format = bzrdir_format
1369
 
            new_test.branch_format = branch_format
1370
 
            def make_new_test_id():
1371
 
                new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1372
 
                return lambda: new_id
1373
 
            new_test.id = make_new_test_id()
1374
 
            result.addTest(new_test)
1375
 
        return result
1376
 
 
1377
 
 
1378
 
class BranchCheckResult(object):
1379
 
    """Results of checking branch consistency.
1380
 
 
1381
 
    :see: Branch.check
1382
 
    """
1383
 
 
1384
 
    def __init__(self, branch):
1385
 
        self.branch = branch
1386
 
 
1387
 
    def report_results(self, verbose):
1388
 
        """Report the check results via trace.note.
1389
 
        
1390
 
        :param verbose: Requests more detailed display of what was checked,
1391
 
            if any.
1392
 
        """
1393
 
        note('checked branch %s format %s',
1394
 
             self.branch.base,
1395
 
             self.branch._format)
1396
 
 
1397
1266
 
1398
1267
######################################################################
1399
1268
# predicates
1400
1269
 
1401
1270
 
1402
 
@deprecated_function(zero_eight)
1403
 
def is_control_file(*args, **kwargs):
1404
 
    """See bzrlib.workingtree.is_control_file."""
1405
 
    return bzrlib.workingtree.is_control_file(*args, **kwargs)
 
1271
def is_control_file(filename):
 
1272
    ## FIXME: better check
 
1273
    filename = os.path.normpath(filename)
 
1274
    while filename != '':
 
1275
        head, tail = os.path.split(filename)
 
1276
        ## mutter('check %r for control file' % ((head, tail), ))
 
1277
        if tail == bzrlib.BZRDIR:
 
1278
            return True
 
1279
        if filename == head:
 
1280
            break
 
1281
        filename = head
 
1282
    return False
 
1283
 
 
1284
 
 
1285
 
 
1286
def gen_file_id(name):
 
1287
    """Return new file id.
 
1288
 
 
1289
    This should probably generate proper UUIDs, but for the moment we
 
1290
    cope with just randomness because running uuidgen every time is
 
1291
    slow."""
 
1292
    import re
 
1293
    from binascii import hexlify
 
1294
    from time import time
 
1295
 
 
1296
    # get last component
 
1297
    idx = name.rfind('/')
 
1298
    if idx != -1:
 
1299
        name = name[idx+1 : ]
 
1300
    idx = name.rfind('\\')
 
1301
    if idx != -1:
 
1302
        name = name[idx+1 : ]
 
1303
 
 
1304
    # make it not a hidden file
 
1305
    name = name.lstrip('.')
 
1306
 
 
1307
    # remove any wierd characters; we don't escape them but rather
 
1308
    # just pull them out
 
1309
    name = re.sub(r'[^\w.]', '', name)
 
1310
 
 
1311
    s = hexlify(rand_bytes(8))
 
1312
    return '-'.join((name, compact_date(time()), s))
 
1313
 
 
1314
 
 
1315
def gen_root_id():
 
1316
    """Return a new tree-root file id."""
 
1317
    return gen_file_id('TREE_ROOT')
 
1318
 
 
1319