~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: John Arbash Meinel
  • Date: 2009-06-19 19:26:32 UTC
  • mto: This revision was merged to the branch mainline in revision 4466.
  • Revision ID: john@arbash-meinel.com-20090619192632-1a4ntoq61fkhlp2x
Make a note of the 'worst case' for heads.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
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
46
46
    )
47
47
""")
48
48
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
50
from bzrlib.hooks import HookPoint, Hooks
51
51
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
53
52
from bzrlib import registry
54
53
from bzrlib.symbol_versioning import (
55
54
    deprecated_in,
63
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
63
 
65
64
 
66
 
class Branch(bzrdir.ControlComponent):
 
65
# TODO: Maybe include checks for common corruption of newlines, etc?
 
66
 
 
67
# TODO: Some operations like log might retrieve the same revisions
 
68
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
69
# cache in memory to make this faster.  In general anything can be
 
70
# cached in memory between lock and unlock operations. .. nb thats
 
71
# what the transaction identity map provides
 
72
 
 
73
 
 
74
######################################################################
 
75
# branch objects
 
76
 
 
77
class Branch(object):
67
78
    """Branch holding a history of revisions.
68
79
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
80
    base
 
81
        Base directory/url of the branch.
72
82
 
73
83
    hooks: An instance of BranchHooks.
74
84
    """
76
86
    # - RBC 20060112
77
87
    base = None
78
88
 
79
 
    @property
80
 
    def control_transport(self):
81
 
        return self._transport
82
 
 
83
 
    @property
84
 
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
86
 
 
87
89
    def __init__(self, *ignored, **ignored_too):
88
90
        self.tags = self._format.make_tags(self)
89
91
        self._revision_history_cache = None
103
105
    def _activate_fallback_location(self, url):
104
106
        """Activate the branch/repository from url as a fallback repository."""
105
107
        repo = self._get_fallback_repository(url)
106
 
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
108
108
        self.repository.add_fallback_repository(repo)
109
109
 
110
110
    def break_lock(self):
147
147
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
148
            self._partial_revision_history_cache.pop()
149
149
 
150
 
    def _get_check_refs(self):
151
 
        """Get the references needed for check().
152
 
 
153
 
        See bzrlib.check.
154
 
        """
155
 
        revid = self.last_revision()
156
 
        return [('revision-existence', revid), ('lefthand-distance', revid)]
157
 
 
158
150
    @staticmethod
159
151
    def open(base, _unsupported=False, possible_transports=None):
160
152
        """Open the branch rooted at base.
164
156
        """
165
157
        control = bzrdir.BzrDir.open(base, _unsupported,
166
158
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
159
        return control.open_branch(_unsupported)
168
160
 
169
161
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
162
    def open_from_transport(transport, _unsupported=False):
171
163
        """Open the branch rooted at transport"""
172
164
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
165
        return control.open_branch(_unsupported)
174
166
 
175
167
    @staticmethod
176
168
    def open_containing(url, possible_transports=None):
214
206
    def _get_fallback_repository(self, url):
215
207
        """Get the repository we fallback to at url."""
216
208
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
209
        a_bzrdir = bzrdir.BzrDir.open(url,
218
210
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
211
        return a_bzrdir.open_branch().repository
220
212
 
221
213
    def _get_tags_bytes(self):
222
214
        """Get the bytes of a serialised tags dict.
283
275
        new_history.reverse()
284
276
        return new_history
285
277
 
286
 
    def lock_write(self, token=None):
287
 
        """Lock the branch for write operations.
288
 
 
289
 
        :param token: A token to permit reacquiring a previously held and
290
 
            preserved lock.
291
 
        :return: A BranchWriteLockResult.
292
 
        """
 
278
    def lock_write(self):
293
279
        raise NotImplementedError(self.lock_write)
294
280
 
295
281
    def lock_read(self):
296
 
        """Lock the branch for read operations.
297
 
 
298
 
        :return: An object with an unlock method which will release the lock
299
 
            obtained.
300
 
        """
301
282
        raise NotImplementedError(self.lock_read)
302
283
 
303
284
    def unlock(self):
428
409
            * 'include' - the stop revision is the last item in the result
429
410
            * 'with-merges' - include the stop revision and all of its
430
411
              merged revisions in the result
431
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
432
 
              that are in both ancestries
433
412
        :param direction: either 'reverse' or 'forward':
434
413
            * reverse means return the start_revision_id first, i.e.
435
414
              start at the most recent revision and go backwards in history
457
436
        # start_revision_id.
458
437
        if self._merge_sorted_revisions_cache is None:
459
438
            last_revision = self.last_revision()
460
 
            known_graph = self.repository.get_known_graph_ancestry(
461
 
                [last_revision])
462
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
 
                last_revision)
 
439
            graph = self.repository.get_graph()
 
440
            parent_map = dict(((key, value) for key, value in
 
441
                     graph.iter_ancestry([last_revision]) if value is not None))
 
442
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
443
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
444
                generate_revno=True)
 
445
            # Drop the sequence # before caching
 
446
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
447
 
464
448
        filtered = self._filter_merge_sorted_revisions(
465
449
            self._merge_sorted_revisions_cache, start_revision_id,
466
450
            stop_revision_id, stop_rule)
467
 
        # Make sure we don't return revisions that are not part of the
468
 
        # start_revision_id ancestry.
469
 
        filtered = self._filter_start_non_ancestors(filtered)
470
451
        if direction == 'reverse':
471
452
            return filtered
472
453
        if direction == 'forward':
479
460
        """Iterate over an inclusive range of sorted revisions."""
480
461
        rev_iter = iter(merge_sorted_revisions)
481
462
        if start_revision_id is not None:
482
 
            for node in rev_iter:
483
 
                rev_id = node.key[-1]
 
463
            for rev_id, depth, revno, end_of_merge in rev_iter:
484
464
                if rev_id != start_revision_id:
485
465
                    continue
486
466
                else:
487
467
                    # The decision to include the start or not
488
468
                    # depends on the stop_rule if a stop is provided
489
 
                    # so pop this node back into the iterator
490
 
                    rev_iter = chain(iter([node]), rev_iter)
 
469
                    rev_iter = chain(
 
470
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
471
                        rev_iter)
491
472
                    break
492
473
        if stop_revision_id is None:
493
 
            # Yield everything
494
 
            for node in rev_iter:
495
 
                rev_id = node.key[-1]
496
 
                yield (rev_id, node.merge_depth, node.revno,
497
 
                       node.end_of_merge)
 
474
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
475
                yield rev_id, depth, revno, end_of_merge
498
476
        elif stop_rule == 'exclude':
499
 
            for node in rev_iter:
500
 
                rev_id = node.key[-1]
 
477
            for rev_id, depth, revno, end_of_merge in rev_iter:
501
478
                if rev_id == stop_revision_id:
502
479
                    return
503
 
                yield (rev_id, node.merge_depth, node.revno,
504
 
                       node.end_of_merge)
 
480
                yield rev_id, depth, revno, end_of_merge
505
481
        elif stop_rule == 'include':
506
 
            for node in rev_iter:
507
 
                rev_id = node.key[-1]
508
 
                yield (rev_id, node.merge_depth, node.revno,
509
 
                       node.end_of_merge)
 
482
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
483
                yield rev_id, depth, revno, end_of_merge
510
484
                if rev_id == stop_revision_id:
511
485
                    return
512
 
        elif stop_rule == 'with-merges-without-common-ancestry':
513
 
            # We want to exclude all revisions that are already part of the
514
 
            # stop_revision_id ancestry.
515
 
            graph = self.repository.get_graph()
516
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
517
 
                                                    [stop_revision_id])
518
 
            for node in rev_iter:
519
 
                rev_id = node.key[-1]
520
 
                if rev_id not in ancestors:
521
 
                    continue
522
 
                yield (rev_id, node.merge_depth, node.revno,
523
 
                       node.end_of_merge)
524
486
        elif stop_rule == 'with-merges':
525
487
            stop_rev = self.repository.get_revision(stop_revision_id)
526
488
            if stop_rev.parent_ids:
527
489
                left_parent = stop_rev.parent_ids[0]
528
490
            else:
529
491
                left_parent = _mod_revision.NULL_REVISION
530
 
            # left_parent is the actual revision we want to stop logging at,
531
 
            # since we want to show the merged revisions after the stop_rev too
532
 
            reached_stop_revision_id = False
533
 
            revision_id_whitelist = []
534
 
            for node in rev_iter:
535
 
                rev_id = node.key[-1]
 
492
            for rev_id, depth, revno, end_of_merge in rev_iter:
536
493
                if rev_id == left_parent:
537
 
                    # reached the left parent after the stop_revision
538
494
                    return
539
 
                if (not reached_stop_revision_id or
540
 
                        rev_id in revision_id_whitelist):
541
 
                    yield (rev_id, node.merge_depth, node.revno,
542
 
                       node.end_of_merge)
543
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
544
 
                        # only do the merged revs of rev_id from now on
545
 
                        rev = self.repository.get_revision(rev_id)
546
 
                        if rev.parent_ids:
547
 
                            reached_stop_revision_id = True
548
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
495
                yield rev_id, depth, revno, end_of_merge
549
496
        else:
550
497
            raise ValueError('invalid stop_rule %r' % stop_rule)
551
498
 
552
 
    def _filter_start_non_ancestors(self, rev_iter):
553
 
        # If we started from a dotted revno, we want to consider it as a tip
554
 
        # and don't want to yield revisions that are not part of its
555
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
556
 
        # uninteresting descendants of the first parent of our tip before the
557
 
        # tip itself.
558
 
        first = rev_iter.next()
559
 
        (rev_id, merge_depth, revno, end_of_merge) = first
560
 
        yield first
561
 
        if not merge_depth:
562
 
            # We start at a mainline revision so by definition, all others
563
 
            # revisions in rev_iter are ancestors
564
 
            for node in rev_iter:
565
 
                yield node
566
 
 
567
 
        clean = False
568
 
        whitelist = set()
569
 
        pmap = self.repository.get_parent_map([rev_id])
570
 
        parents = pmap.get(rev_id, [])
571
 
        if parents:
572
 
            whitelist.update(parents)
573
 
        else:
574
 
            # If there is no parents, there is nothing of interest left
575
 
 
576
 
            # FIXME: It's hard to test this scenario here as this code is never
577
 
            # called in that case. -- vila 20100322
578
 
            return
579
 
 
580
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
 
            if not clean:
582
 
                if rev_id in whitelist:
583
 
                    pmap = self.repository.get_parent_map([rev_id])
584
 
                    parents = pmap.get(rev_id, [])
585
 
                    whitelist.remove(rev_id)
586
 
                    whitelist.update(parents)
587
 
                    if merge_depth == 0:
588
 
                        # We've reached the mainline, there is nothing left to
589
 
                        # filter
590
 
                        clean = True
591
 
                else:
592
 
                    # A revision that is not part of the ancestry of our
593
 
                    # starting revision.
594
 
                    continue
595
 
            yield (rev_id, merge_depth, revno, end_of_merge)
596
 
 
597
499
    def leave_lock_in_place(self):
598
500
        """Tell this branch object not to release the physical lock when this
599
501
        object is unlocked.
616
518
        :param other: The branch to bind to
617
519
        :type other: Branch
618
520
        """
619
 
        raise errors.UpgradeRequired(self.user_url)
 
521
        raise errors.UpgradeRequired(self.base)
620
522
 
621
523
    def set_append_revisions_only(self, enabled):
622
524
        if not self._format.supports_set_append_revisions_only():
623
 
            raise errors.UpgradeRequired(self.user_url)
 
525
            raise errors.UpgradeRequired(self.base)
624
526
        if enabled:
625
527
            value = 'True'
626
528
        else:
674
576
    def get_old_bound_location(self):
675
577
        """Return the URL of the branch we used to be bound to
676
578
        """
677
 
        raise errors.UpgradeRequired(self.user_url)
 
579
        raise errors.UpgradeRequired(self.base)
678
580
 
679
581
    def get_commit_builder(self, parents, config=None, timestamp=None,
680
582
                           timezone=None, committer=None, revprops=None,
758
660
            stacking.
759
661
        """
760
662
        if not self._format.supports_stacking():
761
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
762
 
        # XXX: Changing from one fallback repository to another does not check
763
 
        # that all the data you need is present in the new fallback.
764
 
        # Possibly it should.
 
663
            raise errors.UnstackableBranchFormat(self._format, self.base)
765
664
        self._check_stackable_repo()
766
665
        if not url:
767
666
            try:
769
668
            except (errors.NotStacked, errors.UnstackableBranchFormat,
770
669
                errors.UnstackableRepositoryFormat):
771
670
                return
772
 
            self._unstack()
 
671
            url = ''
 
672
            # XXX: Lock correctness - should unlock our old repo if we were
 
673
            # locked.
 
674
            # repositories don't offer an interface to remove fallback
 
675
            # repositories today; take the conceptually simpler option and just
 
676
            # reopen it.
 
677
            self.repository = self.bzrdir.find_repository()
 
678
            self.repository.lock_write()
 
679
            # for every revision reference the branch has, ensure it is pulled
 
680
            # in.
 
681
            source_repository = self._get_fallback_repository(old_url)
 
682
            for revision_id in chain([self.last_revision()],
 
683
                self.tags.get_reverse_tag_dict()):
 
684
                self.repository.fetch(source_repository, revision_id,
 
685
                    find_ghosts=True)
773
686
        else:
774
687
            self._activate_fallback_location(url)
775
688
        # write this out after the repository is stacked to avoid setting a
776
689
        # stacked config that doesn't work.
777
690
        self._set_config_location('stacked_on_location', url)
778
691
 
779
 
    def _unstack(self):
780
 
        """Change a branch to be unstacked, copying data as needed.
781
 
        
782
 
        Don't call this directly, use set_stacked_on_url(None).
783
 
        """
784
 
        pb = ui.ui_factory.nested_progress_bar()
785
 
        try:
786
 
            pb.update("Unstacking")
787
 
            # The basic approach here is to fetch the tip of the branch,
788
 
            # including all available ghosts, from the existing stacked
789
 
            # repository into a new repository object without the fallbacks. 
790
 
            #
791
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
792
 
            # correct for CHKMap repostiories
793
 
            old_repository = self.repository
794
 
            if len(old_repository._fallback_repositories) != 1:
795
 
                raise AssertionError("can't cope with fallback repositories "
796
 
                    "of %r" % (self.repository,))
797
 
            # unlock it, including unlocking the fallback
798
 
            old_repository.unlock()
799
 
            old_repository.lock_read()
800
 
            try:
801
 
                # Repositories don't offer an interface to remove fallback
802
 
                # repositories today; take the conceptually simpler option and just
803
 
                # reopen it.  We reopen it starting from the URL so that we
804
 
                # get a separate connection for RemoteRepositories and can
805
 
                # stream from one of them to the other.  This does mean doing
806
 
                # separate SSH connection setup, but unstacking is not a
807
 
                # common operation so it's tolerable.
808
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
809
 
                new_repository = new_bzrdir.find_repository()
810
 
                self.repository = new_repository
811
 
                if self.repository._fallback_repositories:
812
 
                    raise AssertionError("didn't expect %r to have "
813
 
                        "fallback_repositories"
814
 
                        % (self.repository,))
815
 
                # this is not paired with an unlock because it's just restoring
816
 
                # the previous state; the lock's released when set_stacked_on_url
817
 
                # returns
818
 
                self.repository.lock_write()
819
 
                # XXX: If you unstack a branch while it has a working tree
820
 
                # with a pending merge, the pending-merged revisions will no
821
 
                # longer be present.  You can (probably) revert and remerge.
822
 
                #
823
 
                # XXX: This only fetches up to the tip of the repository; it
824
 
                # doesn't bring across any tags.  That's fairly consistent
825
 
                # with how branch works, but perhaps not ideal.
826
 
                self.repository.fetch(old_repository,
827
 
                    revision_id=self.last_revision(),
828
 
                    find_ghosts=True)
829
 
            finally:
830
 
                old_repository.unlock()
831
 
        finally:
832
 
            pb.finished()
833
692
 
834
693
    def _set_tags_bytes(self, bytes):
835
694
        """Mirror method for _get_tags_bytes.
915
774
 
916
775
    def unbind(self):
917
776
        """Older format branches cannot bind or unbind."""
918
 
        raise errors.UpgradeRequired(self.user_url)
 
777
        raise errors.UpgradeRequired(self.base)
919
778
 
920
779
    def last_revision(self):
921
780
        """Return last revision id, or NULL_REVISION."""
1081
940
        try:
1082
941
            return urlutils.join(self.base[:-1], parent)
1083
942
        except errors.InvalidURLJoin, e:
1084
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
943
            raise errors.InaccessibleParent(parent, self.base)
1085
944
 
1086
945
    def _get_parent_location(self):
1087
946
        raise NotImplementedError(self._get_parent_location)
1172
1031
        params = ChangeBranchTipParams(
1173
1032
            self, old_revno, new_revno, old_revid, new_revid)
1174
1033
        for hook in hooks:
1175
 
            hook(params)
 
1034
            try:
 
1035
                hook(params)
 
1036
            except errors.TipChangeRejected:
 
1037
                raise
 
1038
            except Exception:
 
1039
                exc_info = sys.exc_info()
 
1040
                hook_name = Branch.hooks.get_hook_name(hook)
 
1041
                raise errors.HookFailed(
 
1042
                    'pre_change_branch_tip', hook_name, exc_info)
1176
1043
 
1177
1044
    @needs_write_lock
1178
1045
    def update(self):
1227
1094
        revision_id: if not None, the revision history in the new branch will
1228
1095
                     be truncated to end with revision_id.
1229
1096
        """
1230
 
        if (repository_policy is not None and
1231
 
            repository_policy.requires_stacking()):
1232
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1233
1097
        result = to_bzrdir.create_branch()
1234
1098
        result.lock_write()
1235
1099
        try:
1303
1167
        target._set_all_reference_info(target_reference_dict)
1304
1168
 
1305
1169
    @needs_read_lock
1306
 
    def check(self, refs):
 
1170
    def check(self):
1307
1171
        """Check consistency of the branch.
1308
1172
 
1309
1173
        In particular this checks that revisions given in the revision-history
1312
1176
 
1313
1177
        Callers will typically also want to check the repository.
1314
1178
 
1315
 
        :param refs: Calculated refs for this branch as specified by
1316
 
            branch._get_check_refs()
1317
1179
        :return: A BranchCheckResult.
1318
1180
        """
1319
 
        result = BranchCheckResult(self)
 
1181
        ret = BranchCheckResult(self)
 
1182
        mainline_parent_id = None
1320
1183
        last_revno, last_revision_id = self.last_revision_info()
1321
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1322
 
        if actual_revno != last_revno:
1323
 
            result.errors.append(errors.BzrCheckError(
1324
 
                'revno does not match len(mainline) %s != %s' % (
1325
 
                last_revno, actual_revno)))
1326
 
        # TODO: We should probably also check that self.revision_history
1327
 
        # matches the repository for older branch formats.
1328
 
        # If looking for the code that cross-checks repository parents against
1329
 
        # the iter_reverse_revision_history output, that is now a repository
1330
 
        # specific check.
1331
 
        return result
 
1184
        real_rev_history = []
 
1185
        try:
 
1186
            for revid in self.repository.iter_reverse_revision_history(
 
1187
                last_revision_id):
 
1188
                real_rev_history.append(revid)
 
1189
        except errors.RevisionNotPresent:
 
1190
            ret.ghosts_in_mainline = True
 
1191
        else:
 
1192
            ret.ghosts_in_mainline = False
 
1193
        real_rev_history.reverse()
 
1194
        if len(real_rev_history) != last_revno:
 
1195
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1196
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1197
        # TODO: We should probably also check that real_rev_history actually
 
1198
        #       matches self.revision_history()
 
1199
        for revision_id in real_rev_history:
 
1200
            try:
 
1201
                revision = self.repository.get_revision(revision_id)
 
1202
            except errors.NoSuchRevision, e:
 
1203
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1204
                            % revision_id)
 
1205
            # In general the first entry on the revision history has no parents.
 
1206
            # But it's not illegal for it to have parents listed; this can happen
 
1207
            # in imports from Arch when the parents weren't reachable.
 
1208
            if mainline_parent_id is not None:
 
1209
                if mainline_parent_id not in revision.parent_ids:
 
1210
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1211
                                        "parents of {%s}"
 
1212
                                        % (mainline_parent_id, revision_id))
 
1213
            mainline_parent_id = revision_id
 
1214
        return ret
1332
1215
 
1333
1216
    def _get_checkout_format(self):
1334
1217
        """Return the most suitable metadir for a checkout of this branch.
1359
1242
        # clone call. Or something. 20090224 RBC/spiv.
1360
1243
        if revision_id is None:
1361
1244
            revision_id = self.last_revision()
1362
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1363
 
            revision_id=revision_id, stacked_on=stacked_on,
1364
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1245
        try:
 
1246
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1247
                revision_id=revision_id, stacked_on=stacked_on,
 
1248
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1249
        except errors.FileExists:
 
1250
            if not use_existing_dir:
 
1251
                raise
 
1252
        except errors.NoSuchFile:
 
1253
            if not create_prefix:
 
1254
                raise
1365
1255
        return dir_to.open_branch()
1366
1256
 
1367
1257
    def create_checkout(self, to_location, revision_id=None,
1386
1276
        if lightweight:
1387
1277
            format = self._get_checkout_format()
1388
1278
            checkout = format.initialize_on_transport(t)
1389
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1390
 
                target_branch=self)
 
1279
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1391
1280
        else:
1392
1281
            format = self._get_checkout_format()
1393
1282
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1435
1324
    def supports_tags(self):
1436
1325
        return self._format.supports_tags()
1437
1326
 
1438
 
    def automatic_tag_name(self, revision_id):
1439
 
        """Try to automatically find the tag name for a revision.
1440
 
 
1441
 
        :param revision_id: Revision id of the revision.
1442
 
        :return: A tag name or None if no tag name could be determined.
1443
 
        """
1444
 
        for hook in Branch.hooks['automatic_tag_name']:
1445
 
            ret = hook(self, revision_id)
1446
 
            if ret is not None:
1447
 
                return ret
1448
 
        return None
1449
 
 
1450
1327
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1451
1328
                                         other_branch):
1452
1329
        """Ensure that revision_b is a descendant of revision_a.
1516
1393
        return not (self == other)
1517
1394
 
1518
1395
    @classmethod
1519
 
    def find_format(klass, a_bzrdir, name=None):
 
1396
    def find_format(klass, a_bzrdir):
1520
1397
        """Return the format for the branch object in a_bzrdir."""
1521
1398
        try:
1522
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1523
 
            format_string = transport.get_bytes("format")
 
1399
            transport = a_bzrdir.get_branch_transport(None)
 
1400
            format_string = transport.get("format").read()
1524
1401
            return klass._formats[format_string]
1525
1402
        except errors.NoSuchFile:
1526
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1403
            raise errors.NotBranchError(path=transport.base)
1527
1404
        except KeyError:
1528
1405
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1529
1406
 
1565
1442
        """Return the short format description for this format."""
1566
1443
        raise NotImplementedError(self.get_format_description)
1567
1444
 
1568
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1569
 
        hooks = Branch.hooks['post_branch_init']
1570
 
        if not hooks:
1571
 
            return
1572
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1573
 
        for hook in hooks:
1574
 
            hook(params)
1575
 
 
1576
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1577
 
                           lock_type='metadir', set_format=True):
 
1445
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1446
                           set_format=True):
1578
1447
        """Initialize a branch in a bzrdir, with specified files
1579
1448
 
1580
1449
        :param a_bzrdir: The bzrdir to initialize the branch in
1581
1450
        :param utf8_files: The files to create as a list of
1582
1451
            (filename, content) tuples
1583
 
        :param name: Name of colocated branch to create, if any
1584
1452
        :param set_format: If True, set the format with
1585
1453
            self.get_format_string.  (BzrBranch4 has its format set
1586
1454
            elsewhere)
1587
1455
        :return: a branch in this format
1588
1456
        """
1589
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1590
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1457
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1458
        branch_transport = a_bzrdir.get_branch_transport(self)
1591
1459
        lock_map = {
1592
1460
            'metadir': ('lock', lockdir.LockDir),
1593
1461
            'branch4': ('branch-lock', lockable_files.TransportLock),
1614
1482
        finally:
1615
1483
            if lock_taken:
1616
1484
                control_files.unlock()
1617
 
        branch = self.open(a_bzrdir, name, _found=True)
1618
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1619
 
        return branch
 
1485
        return self.open(a_bzrdir, _found=True)
1620
1486
 
1621
 
    def initialize(self, a_bzrdir, name=None):
1622
 
        """Create a branch of this format in a_bzrdir.
1623
 
        
1624
 
        :param name: Name of the colocated branch to create.
1625
 
        """
 
1487
    def initialize(self, a_bzrdir):
 
1488
        """Create a branch of this format in a_bzrdir."""
1626
1489
        raise NotImplementedError(self.initialize)
1627
1490
 
1628
1491
    def is_supported(self):
1658
1521
        """
1659
1522
        raise NotImplementedError(self.network_name)
1660
1523
 
1661
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1524
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1662
1525
        """Return the branch object for a_bzrdir
1663
1526
 
1664
1527
        :param a_bzrdir: A BzrDir that contains a branch.
1665
 
        :param name: Name of colocated branch to open
1666
1528
        :param _found: a private parameter, do not use it. It is used to
1667
1529
            indicate if format probing has already be done.
1668
1530
        :param ignore_fallbacks: when set, no fallback branches will be opened
1776
1638
            "multiple hooks installed for transform_fallback_location, "
1777
1639
            "all are called with the url returned from the previous hook."
1778
1640
            "The order is however undefined.", (1, 9), None))
1779
 
        self.create_hook(HookPoint('automatic_tag_name',
1780
 
            "Called to determine an automatic tag name for a revision."
1781
 
            "automatic_tag_name is called with (branch, revision_id) and "
1782
 
            "should return a tag name or None if no tag name could be "
1783
 
            "determined. The first non-None tag name returned will be used.",
1784
 
            (2, 2), None))
1785
 
        self.create_hook(HookPoint('post_branch_init',
1786
 
            "Called after new branch initialization completes. "
1787
 
            "post_branch_init is called with a "
1788
 
            "bzrlib.branch.BranchInitHookParams. "
1789
 
            "Note that init, branch and checkout (both heavyweight and "
1790
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1791
 
        self.create_hook(HookPoint('post_switch',
1792
 
            "Called after a checkout switches branch. "
1793
 
            "post_switch is called with a "
1794
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1795
 
 
1796
1641
 
1797
1642
 
1798
1643
# install the default hooks into the Branch class.
1837
1682
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1838
1683
 
1839
1684
 
1840
 
class BranchInitHookParams(object):
1841
 
    """Object holding parameters passed to *_branch_init hooks.
1842
 
 
1843
 
    There are 4 fields that hooks may wish to access:
1844
 
 
1845
 
    :ivar format: the branch format
1846
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
 
    :ivar name: name of colocated branch, if any (or None)
1848
 
    :ivar branch: the branch created
1849
 
 
1850
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
 
    the checkout, hence they are different from the corresponding fields in
1852
 
    branch, which refer to the original branch.
1853
 
    """
1854
 
 
1855
 
    def __init__(self, format, a_bzrdir, name, branch):
1856
 
        """Create a group of BranchInitHook parameters.
1857
 
 
1858
 
        :param format: the branch format
1859
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1860
 
            initialized
1861
 
        :param name: name of colocated branch, if any (or None)
1862
 
        :param branch: the branch created
1863
 
 
1864
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1865
 
        to the checkout, hence they are different from the corresponding fields
1866
 
        in branch, which refer to the original branch.
1867
 
        """
1868
 
        self.format = format
1869
 
        self.bzrdir = a_bzrdir
1870
 
        self.name = name
1871
 
        self.branch = branch
1872
 
 
1873
 
    def __eq__(self, other):
1874
 
        return self.__dict__ == other.__dict__
1875
 
 
1876
 
    def __repr__(self):
1877
 
        if self.branch:
1878
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1879
 
        else:
1880
 
            return "<%s of format:%s bzrdir:%s>" % (
1881
 
                self.__class__.__name__, self.branch,
1882
 
                self.format, self.bzrdir)
1883
 
 
1884
 
 
1885
 
class SwitchHookParams(object):
1886
 
    """Object holding parameters passed to *_switch hooks.
1887
 
 
1888
 
    There are 4 fields that hooks may wish to access:
1889
 
 
1890
 
    :ivar control_dir: BzrDir of the checkout to change
1891
 
    :ivar to_branch: branch that the checkout is to reference
1892
 
    :ivar force: skip the check for local commits in a heavy checkout
1893
 
    :ivar revision_id: revision ID to switch to (or None)
1894
 
    """
1895
 
 
1896
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1897
 
        """Create a group of SwitchHook parameters.
1898
 
 
1899
 
        :param control_dir: BzrDir of the checkout to change
1900
 
        :param to_branch: branch that the checkout is to reference
1901
 
        :param force: skip the check for local commits in a heavy checkout
1902
 
        :param revision_id: revision ID to switch to (or None)
1903
 
        """
1904
 
        self.control_dir = control_dir
1905
 
        self.to_branch = to_branch
1906
 
        self.force = force
1907
 
        self.revision_id = revision_id
1908
 
 
1909
 
    def __eq__(self, other):
1910
 
        return self.__dict__ == other.__dict__
1911
 
 
1912
 
    def __repr__(self):
1913
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
 
            self.control_dir, self.to_branch,
1915
 
            self.revision_id)
1916
 
 
1917
 
 
1918
1685
class BzrBranchFormat4(BranchFormat):
1919
1686
    """Bzr branch format 4.
1920
1687
 
1927
1694
        """See BranchFormat.get_format_description()."""
1928
1695
        return "Branch format 4"
1929
1696
 
1930
 
    def initialize(self, a_bzrdir, name=None):
 
1697
    def initialize(self, a_bzrdir):
1931
1698
        """Create a branch of this format in a_bzrdir."""
1932
1699
        utf8_files = [('revision-history', ''),
1933
1700
                      ('branch-name', ''),
1934
1701
                      ]
1935
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1702
        return self._initialize_helper(a_bzrdir, utf8_files,
1936
1703
                                       lock_type='branch4', set_format=False)
1937
1704
 
1938
1705
    def __init__(self):
1943
1710
        """The network name for this format is the control dirs disk label."""
1944
1711
        return self._matchingbzrdir.get_format_string()
1945
1712
 
1946
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1713
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1947
1714
        """See BranchFormat.open()."""
1948
1715
        if not _found:
1949
1716
            # we are being called directly and must probe.
1951
1718
        return BzrBranch(_format=self,
1952
1719
                         _control_files=a_bzrdir._control_files,
1953
1720
                         a_bzrdir=a_bzrdir,
1954
 
                         name=name,
1955
1721
                         _repository=a_bzrdir.open_repository())
1956
1722
 
1957
1723
    def __str__(self):
1972
1738
        """
1973
1739
        return self.get_format_string()
1974
1740
 
1975
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1741
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1976
1742
        """See BranchFormat.open()."""
1977
1743
        if not _found:
1978
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1744
            format = BranchFormat.find_format(a_bzrdir)
1979
1745
            if format.__class__ != self.__class__:
1980
1746
                raise AssertionError("wrong format %r found for %r" %
1981
1747
                    (format, self))
1982
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1983
1748
        try:
 
1749
            transport = a_bzrdir.get_branch_transport(None)
1984
1750
            control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1751
                                                         lockdir.LockDir)
1986
1752
            return self._branch_class()(_format=self,
1987
1753
                              _control_files=control_files,
1988
 
                              name=name,
1989
1754
                              a_bzrdir=a_bzrdir,
1990
1755
                              _repository=a_bzrdir.find_repository(),
1991
1756
                              ignore_fallbacks=ignore_fallbacks)
1992
1757
        except errors.NoSuchFile:
1993
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1758
            raise errors.NotBranchError(path=transport.base)
1994
1759
 
1995
1760
    def __init__(self):
1996
1761
        super(BranchFormatMetadir, self).__init__()
2025
1790
        """See BranchFormat.get_format_description()."""
2026
1791
        return "Branch format 5"
2027
1792
 
2028
 
    def initialize(self, a_bzrdir, name=None):
 
1793
    def initialize(self, a_bzrdir):
2029
1794
        """Create a branch of this format in a_bzrdir."""
2030
1795
        utf8_files = [('revision-history', ''),
2031
1796
                      ('branch-name', ''),
2032
1797
                      ]
2033
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1798
        return self._initialize_helper(a_bzrdir, utf8_files)
2034
1799
 
2035
1800
    def supports_tags(self):
2036
1801
        return False
2058
1823
        """See BranchFormat.get_format_description()."""
2059
1824
        return "Branch format 6"
2060
1825
 
2061
 
    def initialize(self, a_bzrdir, name=None):
 
1826
    def initialize(self, a_bzrdir):
2062
1827
        """Create a branch of this format in a_bzrdir."""
2063
1828
        utf8_files = [('last-revision', '0 null:\n'),
2064
1829
                      ('branch.conf', ''),
2065
1830
                      ('tags', ''),
2066
1831
                      ]
2067
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1832
        return self._initialize_helper(a_bzrdir, utf8_files)
2068
1833
 
2069
1834
    def make_tags(self, branch):
2070
1835
        """See bzrlib.branch.BranchFormat.make_tags()."""
2088
1853
        """See BranchFormat.get_format_description()."""
2089
1854
        return "Branch format 8"
2090
1855
 
2091
 
    def initialize(self, a_bzrdir, name=None):
 
1856
    def initialize(self, a_bzrdir):
2092
1857
        """Create a branch of this format in a_bzrdir."""
2093
1858
        utf8_files = [('last-revision', '0 null:\n'),
2094
1859
                      ('branch.conf', ''),
2095
1860
                      ('tags', ''),
2096
1861
                      ('references', '')
2097
1862
                      ]
2098
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1863
        return self._initialize_helper(a_bzrdir, utf8_files)
2099
1864
 
2100
1865
    def __init__(self):
2101
1866
        super(BzrBranchFormat8, self).__init__()
2124
1889
    This format was introduced in bzr 1.6.
2125
1890
    """
2126
1891
 
2127
 
    def initialize(self, a_bzrdir, name=None):
 
1892
    def initialize(self, a_bzrdir):
2128
1893
        """Create a branch of this format in a_bzrdir."""
2129
1894
        utf8_files = [('last-revision', '0 null:\n'),
2130
1895
                      ('branch.conf', ''),
2131
1896
                      ('tags', ''),
2132
1897
                      ]
2133
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1898
        return self._initialize_helper(a_bzrdir, utf8_files)
2134
1899
 
2135
1900
    def _branch_class(self):
2136
1901
        return BzrBranch7
2171
1936
    def get_reference(self, a_bzrdir):
2172
1937
        """See BranchFormat.get_reference()."""
2173
1938
        transport = a_bzrdir.get_branch_transport(None)
2174
 
        return transport.get_bytes('location')
 
1939
        return transport.get('location').read()
2175
1940
 
2176
1941
    def set_reference(self, a_bzrdir, to_branch):
2177
1942
        """See BranchFormat.set_reference()."""
2178
1943
        transport = a_bzrdir.get_branch_transport(None)
2179
1944
        location = transport.put_bytes('location', to_branch.base)
2180
1945
 
2181
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1946
    def initialize(self, a_bzrdir, target_branch=None):
2182
1947
        """Create a branch of this format in a_bzrdir."""
2183
1948
        if target_branch is None:
2184
1949
            # this format does not implement branch itself, thus the implicit
2185
1950
            # creation contract must see it as uninitializable
2186
1951
            raise errors.UninitializableFormat(self)
2187
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2188
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1952
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1953
        branch_transport = a_bzrdir.get_branch_transport(self)
2189
1954
        branch_transport.put_bytes('location',
2190
 
            target_branch.bzrdir.user_url)
 
1955
            target_branch.bzrdir.root_transport.base)
2191
1956
        branch_transport.put_bytes('format', self.get_format_string())
2192
 
        branch = self.open(
2193
 
            a_bzrdir, name, _found=True,
 
1957
        return self.open(
 
1958
            a_bzrdir, _found=True,
2194
1959
            possible_transports=[target_branch.bzrdir.root_transport])
2195
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2196
 
        return branch
2197
1960
 
2198
1961
    def __init__(self):
2199
1962
        super(BranchReferenceFormat, self).__init__()
2205
1968
        def clone(to_bzrdir, revision_id=None,
2206
1969
            repository_policy=None):
2207
1970
            """See Branch.clone()."""
2208
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1971
            return format.initialize(to_bzrdir, a_branch)
2209
1972
            # cannot obey revision_id limits when cloning a reference ...
2210
1973
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2211
1974
            # emit some sort of warning/error to the caller ?!
2212
1975
        return clone
2213
1976
 
2214
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1977
    def open(self, a_bzrdir, _found=False, location=None,
2215
1978
             possible_transports=None, ignore_fallbacks=False):
2216
1979
        """Return the branch that the branch reference in a_bzrdir points at.
2217
1980
 
2218
1981
        :param a_bzrdir: A BzrDir that contains a branch.
2219
 
        :param name: Name of colocated branch to open, if any
2220
1982
        :param _found: a private parameter, do not use it. It is used to
2221
1983
            indicate if format probing has already be done.
2222
1984
        :param ignore_fallbacks: when set, no fallback branches will be opened
2227
1989
        :param possible_transports: An optional reusable transports list.
2228
1990
        """
2229
1991
        if not _found:
2230
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1992
            format = BranchFormat.find_format(a_bzrdir)
2231
1993
            if format.__class__ != self.__class__:
2232
1994
                raise AssertionError("wrong format %r found for %r" %
2233
1995
                    (format, self))
2235
1997
            location = self.get_reference(a_bzrdir)
2236
1998
        real_bzrdir = bzrdir.BzrDir.open(
2237
1999
            location, possible_transports=possible_transports)
2238
 
        result = real_bzrdir.open_branch(name=name, 
2239
 
            ignore_fallbacks=ignore_fallbacks)
 
2000
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2240
2001
        # this changes the behaviour of result.clone to create a new reference
2241
2002
        # rather than a copy of the content of the branch.
2242
2003
        # I did not use a proxy object because that needs much more extensive
2269
2030
BranchFormat.register_format(__format6)
2270
2031
BranchFormat.register_format(__format7)
2271
2032
BranchFormat.register_format(__format8)
2272
 
BranchFormat.set_default_format(__format7)
 
2033
BranchFormat.set_default_format(__format6)
2273
2034
_legacy_formats = [BzrBranchFormat4(),
2274
2035
    ]
2275
2036
network_format_registry.register(
2276
2037
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2277
2038
 
2278
2039
 
2279
 
class BranchWriteLockResult(object):
2280
 
    """The result of write locking a branch.
2281
 
 
2282
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2283
 
        None.
2284
 
    :ivar unlock: A callable which will unlock the lock.
2285
 
    """
2286
 
 
2287
 
    def __init__(self, unlock, branch_token):
2288
 
        self.branch_token = branch_token
2289
 
        self.unlock = unlock
2290
 
 
2291
 
    def __str__(self):
2292
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2293
 
            self.unlock)
2294
 
 
2295
 
 
2296
 
class BzrBranch(Branch, _RelockDebugMixin):
 
2040
class BzrBranch(Branch):
2297
2041
    """A branch stored in the actual filesystem.
2298
2042
 
2299
2043
    Note that it's "local" in the context of the filesystem; it doesn't
2305
2049
    :ivar repository: Repository for this branch.
2306
2050
    :ivar base: The url of the base directory for this branch; the one
2307
2051
        containing the .bzr directory.
2308
 
    :ivar name: Optional colocated branch name as it exists in the control
2309
 
        directory.
2310
2052
    """
2311
2053
 
2312
2054
    def __init__(self, _format=None,
2313
 
                 _control_files=None, a_bzrdir=None, name=None,
2314
 
                 _repository=None, ignore_fallbacks=False):
 
2055
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2056
                 ignore_fallbacks=False):
2315
2057
        """Create new branch object at a particular location."""
2316
2058
        if a_bzrdir is None:
2317
2059
            raise ValueError('a_bzrdir must be supplied')
2318
2060
        else:
2319
2061
            self.bzrdir = a_bzrdir
2320
2062
        self._base = self.bzrdir.transport.clone('..').base
2321
 
        self.name = name
2322
2063
        # XXX: We should be able to just do
2323
2064
        #   self.base = self.bzrdir.root_transport.base
2324
2065
        # but this does not quite work yet -- mbp 20080522
2331
2072
        Branch.__init__(self)
2332
2073
 
2333
2074
    def __str__(self):
2334
 
        if self.name is None:
2335
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2336
 
        else:
2337
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2338
 
                self.name)
 
2075
        return '%s(%r)' % (self.__class__.__name__, self.base)
2339
2076
 
2340
2077
    __repr__ = __str__
2341
2078
 
2352
2089
        return self.control_files.is_locked()
2353
2090
 
2354
2091
    def lock_write(self, token=None):
2355
 
        """Lock the branch for write operations.
2356
 
 
2357
 
        :param token: A token to permit reacquiring a previously held and
2358
 
            preserved lock.
2359
 
        :return: A BranchWriteLockResult.
2360
 
        """
2361
 
        if not self.is_locked():
2362
 
            self._note_lock('w')
2363
2092
        # All-in-one needs to always unlock/lock.
2364
2093
        repo_control = getattr(self.repository, 'control_files', None)
2365
2094
        if self.control_files == repo_control or not self.is_locked():
2366
 
            self.repository._warn_if_deprecated(self)
2367
2095
            self.repository.lock_write()
2368
2096
            took_lock = True
2369
2097
        else:
2370
2098
            took_lock = False
2371
2099
        try:
2372
 
            return BranchWriteLockResult(self.unlock,
2373
 
                self.control_files.lock_write(token=token))
 
2100
            return self.control_files.lock_write(token=token)
2374
2101
        except:
2375
2102
            if took_lock:
2376
2103
                self.repository.unlock()
2377
2104
            raise
2378
2105
 
2379
2106
    def lock_read(self):
2380
 
        """Lock the branch for read operations.
2381
 
 
2382
 
        :return: An object with an unlock method which will release the lock
2383
 
            obtained.
2384
 
        """
2385
 
        if not self.is_locked():
2386
 
            self._note_lock('r')
2387
2107
        # All-in-one needs to always unlock/lock.
2388
2108
        repo_control = getattr(self.repository, 'control_files', None)
2389
2109
        if self.control_files == repo_control or not self.is_locked():
2390
 
            self.repository._warn_if_deprecated(self)
2391
2110
            self.repository.lock_read()
2392
2111
            took_lock = True
2393
2112
        else:
2394
2113
            took_lock = False
2395
2114
        try:
2396
2115
            self.control_files.lock_read()
2397
 
            return self
2398
2116
        except:
2399
2117
            if took_lock:
2400
2118
                self.repository.unlock()
2401
2119
            raise
2402
2120
 
2403
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2404
2121
    def unlock(self):
2405
2122
        try:
2406
2123
            self.control_files.unlock()
2569
2286
        return result
2570
2287
 
2571
2288
    def get_stacked_on_url(self):
2572
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2289
        raise errors.UnstackableBranchFormat(self._format, self.base)
2573
2290
 
2574
2291
    def set_push_location(self, location):
2575
2292
        """See Branch.set_push_location."""
2765
2482
        if _mod_revision.is_null(last_revision):
2766
2483
            return
2767
2484
        if last_revision not in self._lefthand_history(revision_id):
2768
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2485
            raise errors.AppendRevisionsOnlyViolation(self.base)
2769
2486
 
2770
2487
    def _gen_revision_history(self):
2771
2488
        """Generate the revision history from last revision
2871
2588
        if branch_location is None:
2872
2589
            return Branch.reference_parent(self, file_id, path,
2873
2590
                                           possible_transports)
2874
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2591
        branch_location = urlutils.join(self.base, branch_location)
2875
2592
        return Branch.open(branch_location,
2876
2593
                           possible_transports=possible_transports)
2877
2594
 
2923
2640
        return stacked_url
2924
2641
 
2925
2642
    def _get_append_revisions_only(self):
2926
 
        return self.get_config(
2927
 
            ).get_user_option_as_bool('append_revisions_only')
 
2643
        value = self.get_config().get_user_option('append_revisions_only')
 
2644
        return value == 'True'
2928
2645
 
2929
2646
    @needs_write_lock
2930
2647
    def generate_revision_history(self, revision_id, last_rev=None,
2992
2709
    """
2993
2710
 
2994
2711
    def get_stacked_on_url(self):
2995
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2712
        raise errors.UnstackableBranchFormat(self._format, self.base)
2996
2713
 
2997
2714
 
2998
2715
######################################################################
3077
2794
 
3078
2795
    def __init__(self, branch):
3079
2796
        self.branch = branch
3080
 
        self.errors = []
 
2797
        self.ghosts_in_mainline = False
3081
2798
 
3082
2799
    def report_results(self, verbose):
3083
2800
        """Report the check results via trace.note.
3085
2802
        :param verbose: Requests more detailed display of what was checked,
3086
2803
            if any.
3087
2804
        """
3088
 
        note('checked branch %s format %s', self.branch.user_url,
3089
 
            self.branch._format)
3090
 
        for error in self.errors:
3091
 
            note('found error:%s', error)
 
2805
        note('checked branch %s format %s',
 
2806
             self.branch.base,
 
2807
             self.branch._format)
 
2808
        if self.ghosts_in_mainline:
 
2809
            note('branch contains ghosts in mainline')
3092
2810
 
3093
2811
 
3094
2812
class Converter5to6(object):
3189
2907
    @staticmethod
3190
2908
    def _get_branch_formats_to_test():
3191
2909
        """Return a tuple with the Branch formats to use when testing."""
3192
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
2910
        raise NotImplementedError(self._get_branch_formats_to_test)
3193
2911
 
3194
2912
    def pull(self, overwrite=False, stop_revision=None,
3195
2913
             possible_transports=None, local=False):
3350
3068
                _override_hook_source_branch=_override_hook_source_branch)
3351
3069
        finally:
3352
3070
            self.source.unlock()
 
3071
        return result
3353
3072
 
3354
3073
    def _push_with_bound_branches(self, overwrite, stop_revision,
3355
3074
            _override_hook_source_branch=None):
3420
3139
        if local and not bound_location:
3421
3140
            raise errors.LocalRequiresBoundBranch()
3422
3141
        master_branch = None
3423
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3142
        if not local and bound_location and self.source.base != bound_location:
3424
3143
            # not pulling from master, so we need to update master.
3425
3144
            master_branch = self.target.get_master_branch(possible_transports)
3426
3145
            master_branch.lock_write()