/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: John Arbash Meinel
  • Date: 2006-08-15 13:22:02 UTC
  • mto: This revision was merged to the branch mainline in revision 1926.
  • Revision ID: john@arbash-meinel.com-20060815132202-59340128f147361c
NEWS

Show diffs side-by-side

added added

removed removed

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