/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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
50
from bzrlib.hooks import HookPoint, Hooks
51
51
from bzrlib.inter import InterObject
 
52
from bzrlib.lock import _RelockDebugMixin
52
53
from bzrlib import registry
53
54
from bzrlib.symbol_versioning import (
54
55
    deprecated_in,
62
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
63
64
 
64
65
 
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):
 
66
class Branch(bzrdir.ControlComponent):
78
67
    """Branch holding a history of revisions.
79
68
 
80
 
    base
81
 
        Base directory/url of the branch.
 
69
    :ivar base:
 
70
        Base directory/url of the branch; using control_url and
 
71
        control_transport is more standardized.
82
72
 
83
73
    hooks: An instance of BranchHooks.
84
74
    """
86
76
    # - RBC 20060112
87
77
    base = None
88
78
 
 
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
 
89
87
    def __init__(self, *ignored, **ignored_too):
90
88
        self.tags = self._format.make_tags(self)
91
89
        self._revision_history_cache = None
92
90
        self._revision_id_to_revno_cache = None
93
91
        self._partial_revision_id_to_revno_cache = {}
 
92
        self._partial_revision_history_cache = []
94
93
        self._last_revision_info_cache = None
95
94
        self._merge_sorted_revisions_cache = None
96
95
        self._open_hook()
104
103
    def _activate_fallback_location(self, url):
105
104
        """Activate the branch/repository from url as a fallback repository."""
106
105
        repo = self._get_fallback_repository(url)
 
106
        if repo.has_same_location(self.repository):
 
107
            raise errors.UnstackableLocationError(self.user_url, url)
107
108
        self.repository.add_fallback_repository(repo)
108
109
 
109
110
    def break_lock(self):
125
126
            raise errors.UnstackableRepositoryFormat(self.repository._format,
126
127
                self.repository.base)
127
128
 
 
129
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
130
        """Extend the partial history to include a given index
 
131
 
 
132
        If a stop_index is supplied, stop when that index has been reached.
 
133
        If a stop_revision is supplied, stop when that revision is
 
134
        encountered.  Otherwise, stop when the beginning of history is
 
135
        reached.
 
136
 
 
137
        :param stop_index: The index which should be present.  When it is
 
138
            present, history extension will stop.
 
139
        :param stop_revision: The revision id which should be present.  When
 
140
            it is encountered, history extension will stop.
 
141
        """
 
142
        if len(self._partial_revision_history_cache) == 0:
 
143
            self._partial_revision_history_cache = [self.last_revision()]
 
144
        repository._iter_for_revno(
 
145
            self.repository, self._partial_revision_history_cache,
 
146
            stop_index=stop_index, stop_revision=stop_revision)
 
147
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
 
148
            self._partial_revision_history_cache.pop()
 
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
 
128
158
    @staticmethod
129
159
    def open(base, _unsupported=False, possible_transports=None):
130
160
        """Open the branch rooted at base.
134
164
        """
135
165
        control = bzrdir.BzrDir.open(base, _unsupported,
136
166
                                     possible_transports=possible_transports)
137
 
        return control.open_branch(_unsupported)
 
167
        return control.open_branch(unsupported=_unsupported)
138
168
 
139
169
    @staticmethod
140
 
    def open_from_transport(transport, _unsupported=False):
 
170
    def open_from_transport(transport, name=None, _unsupported=False):
141
171
        """Open the branch rooted at transport"""
142
172
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
143
 
        return control.open_branch(_unsupported)
 
173
        return control.open_branch(name=name, unsupported=_unsupported)
144
174
 
145
175
    @staticmethod
146
176
    def open_containing(url, possible_transports=None):
184
214
    def _get_fallback_repository(self, url):
185
215
        """Get the repository we fallback to at url."""
186
216
        url = urlutils.join(self.base, url)
187
 
        a_bzrdir = bzrdir.BzrDir.open(url,
 
217
        a_branch = Branch.open(url,
188
218
            possible_transports=[self.bzrdir.root_transport])
189
 
        return a_bzrdir.open_branch().repository
 
219
        return a_branch.repository
190
220
 
191
221
    def _get_tags_bytes(self):
192
222
        """Get the bytes of a serialised tags dict.
387
417
            * 'include' - the stop revision is the last item in the result
388
418
            * 'with-merges' - include the stop revision and all of its
389
419
              merged revisions in the result
 
420
            * 'with-merges-without-common-ancestry' - filter out revisions 
 
421
              that are in both ancestries
390
422
        :param direction: either 'reverse' or 'forward':
391
423
            * reverse means return the start_revision_id first, i.e.
392
424
              start at the most recent revision and go backwards in history
414
446
        # start_revision_id.
415
447
        if self._merge_sorted_revisions_cache is None:
416
448
            last_revision = self.last_revision()
417
 
            graph = self.repository.get_graph()
418
 
            parent_map = dict(((key, value) for key, value in
419
 
                     graph.iter_ancestry([last_revision]) if value is not None))
420
 
            revision_graph = repository._strip_NULL_ghosts(parent_map)
421
 
            revs = tsort.merge_sort(revision_graph, last_revision, None,
422
 
                generate_revno=True)
423
 
            # Drop the sequence # before caching
424
 
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
425
 
 
 
449
            known_graph = self.repository.get_known_graph_ancestry(
 
450
                [last_revision])
 
451
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
 
452
                last_revision)
426
453
        filtered = self._filter_merge_sorted_revisions(
427
454
            self._merge_sorted_revisions_cache, start_revision_id,
428
455
            stop_revision_id, stop_rule)
 
456
        # Make sure we don't return revisions that are not part of the
 
457
        # start_revision_id ancestry.
 
458
        filtered = self._filter_start_non_ancestors(filtered)
429
459
        if direction == 'reverse':
430
460
            return filtered
431
461
        if direction == 'forward':
438
468
        """Iterate over an inclusive range of sorted revisions."""
439
469
        rev_iter = iter(merge_sorted_revisions)
440
470
        if start_revision_id is not None:
441
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
471
            for node in rev_iter:
 
472
                rev_id = node.key[-1]
442
473
                if rev_id != start_revision_id:
443
474
                    continue
444
475
                else:
445
476
                    # The decision to include the start or not
446
477
                    # depends on the stop_rule if a stop is provided
447
 
                    rev_iter = chain(
448
 
                        iter([(rev_id, depth, revno, end_of_merge)]),
449
 
                        rev_iter)
 
478
                    # so pop this node back into the iterator
 
479
                    rev_iter = chain(iter([node]), rev_iter)
450
480
                    break
451
481
        if stop_revision_id is None:
452
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
453
 
                yield rev_id, depth, revno, end_of_merge
 
482
            # Yield everything
 
483
            for node in rev_iter:
 
484
                rev_id = node.key[-1]
 
485
                yield (rev_id, node.merge_depth, node.revno,
 
486
                       node.end_of_merge)
454
487
        elif stop_rule == 'exclude':
455
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
488
            for node in rev_iter:
 
489
                rev_id = node.key[-1]
456
490
                if rev_id == stop_revision_id:
457
491
                    return
458
 
                yield rev_id, depth, revno, end_of_merge
 
492
                yield (rev_id, node.merge_depth, node.revno,
 
493
                       node.end_of_merge)
459
494
        elif stop_rule == 'include':
460
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
461
 
                yield rev_id, depth, revno, end_of_merge
 
495
            for node in rev_iter:
 
496
                rev_id = node.key[-1]
 
497
                yield (rev_id, node.merge_depth, node.revno,
 
498
                       node.end_of_merge)
462
499
                if rev_id == stop_revision_id:
463
500
                    return
 
501
        elif stop_rule == 'with-merges-without-common-ancestry':
 
502
            # We want to exclude all revisions that are already part of the
 
503
            # stop_revision_id ancestry.
 
504
            graph = self.repository.get_graph()
 
505
            ancestors = graph.find_unique_ancestors(start_revision_id,
 
506
                                                    [stop_revision_id])
 
507
            for node in rev_iter:
 
508
                rev_id = node.key[-1]
 
509
                if rev_id not in ancestors:
 
510
                    continue
 
511
                yield (rev_id, node.merge_depth, node.revno,
 
512
                       node.end_of_merge)
464
513
        elif stop_rule == 'with-merges':
465
514
            stop_rev = self.repository.get_revision(stop_revision_id)
466
515
            if stop_rev.parent_ids:
467
516
                left_parent = stop_rev.parent_ids[0]
468
517
            else:
469
518
                left_parent = _mod_revision.NULL_REVISION
470
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
519
            # left_parent is the actual revision we want to stop logging at,
 
520
            # since we want to show the merged revisions after the stop_rev too
 
521
            reached_stop_revision_id = False
 
522
            revision_id_whitelist = []
 
523
            for node in rev_iter:
 
524
                rev_id = node.key[-1]
471
525
                if rev_id == left_parent:
 
526
                    # reached the left parent after the stop_revision
472
527
                    return
473
 
                yield rev_id, depth, revno, end_of_merge
 
528
                if (not reached_stop_revision_id or
 
529
                        rev_id in revision_id_whitelist):
 
530
                    yield (rev_id, node.merge_depth, node.revno,
 
531
                       node.end_of_merge)
 
532
                    if reached_stop_revision_id or rev_id == stop_revision_id:
 
533
                        # only do the merged revs of rev_id from now on
 
534
                        rev = self.repository.get_revision(rev_id)
 
535
                        if rev.parent_ids:
 
536
                            reached_stop_revision_id = True
 
537
                            revision_id_whitelist.extend(rev.parent_ids)
474
538
        else:
475
539
            raise ValueError('invalid stop_rule %r' % stop_rule)
476
540
 
 
541
    def _filter_start_non_ancestors(self, rev_iter):
 
542
        # If we started from a dotted revno, we want to consider it as a tip
 
543
        # and don't want to yield revisions that are not part of its
 
544
        # ancestry. Given the order guaranteed by the merge sort, we will see
 
545
        # uninteresting descendants of the first parent of our tip before the
 
546
        # tip itself.
 
547
        first = rev_iter.next()
 
548
        (rev_id, merge_depth, revno, end_of_merge) = first
 
549
        yield first
 
550
        if not merge_depth:
 
551
            # We start at a mainline revision so by definition, all others
 
552
            # revisions in rev_iter are ancestors
 
553
            for node in rev_iter:
 
554
                yield node
 
555
 
 
556
        clean = False
 
557
        whitelist = set()
 
558
        pmap = self.repository.get_parent_map([rev_id])
 
559
        parents = pmap.get(rev_id, [])
 
560
        if parents:
 
561
            whitelist.update(parents)
 
562
        else:
 
563
            # If there is no parents, there is nothing of interest left
 
564
 
 
565
            # FIXME: It's hard to test this scenario here as this code is never
 
566
            # called in that case. -- vila 20100322
 
567
            return
 
568
 
 
569
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
 
570
            if not clean:
 
571
                if rev_id in whitelist:
 
572
                    pmap = self.repository.get_parent_map([rev_id])
 
573
                    parents = pmap.get(rev_id, [])
 
574
                    whitelist.remove(rev_id)
 
575
                    whitelist.update(parents)
 
576
                    if merge_depth == 0:
 
577
                        # We've reached the mainline, there is nothing left to
 
578
                        # filter
 
579
                        clean = True
 
580
                else:
 
581
                    # A revision that is not part of the ancestry of our
 
582
                    # starting revision.
 
583
                    continue
 
584
            yield (rev_id, merge_depth, revno, end_of_merge)
 
585
 
477
586
    def leave_lock_in_place(self):
478
587
        """Tell this branch object not to release the physical lock when this
479
588
        object is unlocked.
496
605
        :param other: The branch to bind to
497
606
        :type other: Branch
498
607
        """
499
 
        raise errors.UpgradeRequired(self.base)
 
608
        raise errors.UpgradeRequired(self.user_url)
 
609
 
 
610
    def set_append_revisions_only(self, enabled):
 
611
        if not self._format.supports_set_append_revisions_only():
 
612
            raise errors.UpgradeRequired(self.user_url)
 
613
        if enabled:
 
614
            value = 'True'
 
615
        else:
 
616
            value = 'False'
 
617
        self.get_config().set_user_option('append_revisions_only', value,
 
618
            warn_masked=True)
500
619
 
501
620
    def set_reference_info(self, file_id, tree_path, branch_location):
502
621
        """Set the branch location to use for a tree reference."""
544
663
    def get_old_bound_location(self):
545
664
        """Return the URL of the branch we used to be bound to
546
665
        """
547
 
        raise errors.UpgradeRequired(self.base)
 
666
        raise errors.UpgradeRequired(self.user_url)
548
667
 
549
668
    def get_commit_builder(self, parents, config=None, timestamp=None,
550
669
                           timezone=None, committer=None, revprops=None,
628
747
            stacking.
629
748
        """
630
749
        if not self._format.supports_stacking():
631
 
            raise errors.UnstackableBranchFormat(self._format, self.base)
 
750
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
751
        # XXX: Changing from one fallback repository to another does not check
 
752
        # that all the data you need is present in the new fallback.
 
753
        # Possibly it should.
632
754
        self._check_stackable_repo()
633
755
        if not url:
634
756
            try:
636
758
            except (errors.NotStacked, errors.UnstackableBranchFormat,
637
759
                errors.UnstackableRepositoryFormat):
638
760
                return
639
 
            url = ''
640
 
            # XXX: Lock correctness - should unlock our old repo if we were
641
 
            # locked.
642
 
            # repositories don't offer an interface to remove fallback
643
 
            # repositories today; take the conceptually simpler option and just
644
 
            # reopen it.
645
 
            self.repository = self.bzrdir.find_repository()
646
 
            self.repository.lock_write()
647
 
            # for every revision reference the branch has, ensure it is pulled
648
 
            # in.
649
 
            source_repository = self._get_fallback_repository(old_url)
650
 
            for revision_id in chain([self.last_revision()],
651
 
                self.tags.get_reverse_tag_dict()):
652
 
                self.repository.fetch(source_repository, revision_id,
653
 
                    find_ghosts=True)
 
761
            self._unstack()
654
762
        else:
655
763
            self._activate_fallback_location(url)
656
764
        # write this out after the repository is stacked to avoid setting a
657
765
        # stacked config that doesn't work.
658
766
        self._set_config_location('stacked_on_location', url)
659
767
 
 
768
    def _unstack(self):
 
769
        """Change a branch to be unstacked, copying data as needed.
 
770
        
 
771
        Don't call this directly, use set_stacked_on_url(None).
 
772
        """
 
773
        pb = ui.ui_factory.nested_progress_bar()
 
774
        try:
 
775
            pb.update("Unstacking")
 
776
            # The basic approach here is to fetch the tip of the branch,
 
777
            # including all available ghosts, from the existing stacked
 
778
            # repository into a new repository object without the fallbacks. 
 
779
            #
 
780
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
 
781
            # correct for CHKMap repostiories
 
782
            old_repository = self.repository
 
783
            if len(old_repository._fallback_repositories) != 1:
 
784
                raise AssertionError("can't cope with fallback repositories "
 
785
                    "of %r" % (self.repository,))
 
786
            # unlock it, including unlocking the fallback
 
787
            old_repository.unlock()
 
788
            old_repository.lock_read()
 
789
            try:
 
790
                # Repositories don't offer an interface to remove fallback
 
791
                # repositories today; take the conceptually simpler option and just
 
792
                # reopen it.  We reopen it starting from the URL so that we
 
793
                # get a separate connection for RemoteRepositories and can
 
794
                # stream from one of them to the other.  This does mean doing
 
795
                # separate SSH connection setup, but unstacking is not a
 
796
                # common operation so it's tolerable.
 
797
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
798
                new_repository = new_bzrdir.find_repository()
 
799
                self.repository = new_repository
 
800
                if self.repository._fallback_repositories:
 
801
                    raise AssertionError("didn't expect %r to have "
 
802
                        "fallback_repositories"
 
803
                        % (self.repository,))
 
804
                # this is not paired with an unlock because it's just restoring
 
805
                # the previous state; the lock's released when set_stacked_on_url
 
806
                # returns
 
807
                self.repository.lock_write()
 
808
                # XXX: If you unstack a branch while it has a working tree
 
809
                # with a pending merge, the pending-merged revisions will no
 
810
                # longer be present.  You can (probably) revert and remerge.
 
811
                #
 
812
                # XXX: This only fetches up to the tip of the repository; it
 
813
                # doesn't bring across any tags.  That's fairly consistent
 
814
                # with how branch works, but perhaps not ideal.
 
815
                self.repository.fetch(old_repository,
 
816
                    revision_id=self.last_revision(),
 
817
                    find_ghosts=True)
 
818
            finally:
 
819
                old_repository.unlock()
 
820
        finally:
 
821
            pb.finished()
660
822
 
661
823
    def _set_tags_bytes(self, bytes):
662
824
        """Mirror method for _get_tags_bytes.
698
860
        self._revision_id_to_revno_cache = None
699
861
        self._last_revision_info_cache = None
700
862
        self._merge_sorted_revisions_cache = None
 
863
        self._partial_revision_history_cache = []
 
864
        self._partial_revision_id_to_revno_cache = {}
701
865
 
702
866
    def _gen_revision_history(self):
703
867
        """Return sequence of revision hashes on to this branch.
740
904
 
741
905
    def unbind(self):
742
906
        """Older format branches cannot bind or unbind."""
743
 
        raise errors.UpgradeRequired(self.base)
744
 
 
745
 
    def set_append_revisions_only(self, enabled):
746
 
        """Older format branches are never restricted to append-only"""
747
 
        raise errors.UpgradeRequired(self.base)
 
907
        raise errors.UpgradeRequired(self.user_url)
748
908
 
749
909
    def last_revision(self):
750
910
        """Return last revision id, or NULL_REVISION."""
831
991
        except ValueError:
832
992
            raise errors.NoSuchRevision(self, revision_id)
833
993
 
 
994
    @needs_read_lock
834
995
    def get_rev_id(self, revno, history=None):
835
996
        """Find the revision id of the specified revno."""
836
997
        if revno == 0:
837
998
            return _mod_revision.NULL_REVISION
838
 
        if history is None:
839
 
            history = self.revision_history()
840
 
        if revno <= 0 or revno > len(history):
 
999
        last_revno, last_revid = self.last_revision_info()
 
1000
        if revno == last_revno:
 
1001
            return last_revid
 
1002
        if revno <= 0 or revno > last_revno:
841
1003
            raise errors.NoSuchRevision(self, revno)
842
 
        return history[revno - 1]
 
1004
        distance_from_last = last_revno - revno
 
1005
        if len(self._partial_revision_history_cache) <= distance_from_last:
 
1006
            self._extend_partial_history(distance_from_last)
 
1007
        return self._partial_revision_history_cache[distance_from_last]
843
1008
 
844
1009
    @needs_write_lock
845
1010
    def pull(self, source, overwrite=False, stop_revision=None,
905
1070
        try:
906
1071
            return urlutils.join(self.base[:-1], parent)
907
1072
        except errors.InvalidURLJoin, e:
908
 
            raise errors.InaccessibleParent(parent, self.base)
 
1073
            raise errors.InaccessibleParent(parent, self.user_url)
909
1074
 
910
1075
    def _get_parent_location(self):
911
1076
        raise NotImplementedError(self._get_parent_location)
996
1161
        params = ChangeBranchTipParams(
997
1162
            self, old_revno, new_revno, old_revid, new_revid)
998
1163
        for hook in hooks:
999
 
            try:
1000
 
                hook(params)
1001
 
            except errors.TipChangeRejected:
1002
 
                raise
1003
 
            except Exception:
1004
 
                exc_info = sys.exc_info()
1005
 
                hook_name = Branch.hooks.get_hook_name(hook)
1006
 
                raise errors.HookFailed(
1007
 
                    'pre_change_branch_tip', hook_name, exc_info)
 
1164
            hook(params)
1008
1165
 
1009
1166
    @needs_write_lock
1010
1167
    def update(self):
1059
1216
        revision_id: if not None, the revision history in the new branch will
1060
1217
                     be truncated to end with revision_id.
1061
1218
        """
 
1219
        if (repository_policy is not None and
 
1220
            repository_policy.requires_stacking()):
 
1221
            to_bzrdir._format.require_stacking(_skip_repo=True)
1062
1222
        result = to_bzrdir.create_branch()
1063
1223
        result.lock_write()
1064
1224
        try:
1132
1292
        target._set_all_reference_info(target_reference_dict)
1133
1293
 
1134
1294
    @needs_read_lock
1135
 
    def check(self):
 
1295
    def check(self, refs):
1136
1296
        """Check consistency of the branch.
1137
1297
 
1138
1298
        In particular this checks that revisions given in the revision-history
1141
1301
 
1142
1302
        Callers will typically also want to check the repository.
1143
1303
 
 
1304
        :param refs: Calculated refs for this branch as specified by
 
1305
            branch._get_check_refs()
1144
1306
        :return: A BranchCheckResult.
1145
1307
        """
1146
 
        ret = BranchCheckResult(self)
1147
 
        mainline_parent_id = None
 
1308
        result = BranchCheckResult(self)
1148
1309
        last_revno, last_revision_id = self.last_revision_info()
1149
 
        real_rev_history = []
1150
 
        try:
1151
 
            for revid in self.repository.iter_reverse_revision_history(
1152
 
                last_revision_id):
1153
 
                real_rev_history.append(revid)
1154
 
        except errors.RevisionNotPresent:
1155
 
            ret.ghosts_in_mainline = True
1156
 
        else:
1157
 
            ret.ghosts_in_mainline = False
1158
 
        real_rev_history.reverse()
1159
 
        if len(real_rev_history) != last_revno:
1160
 
            raise errors.BzrCheckError('revno does not match len(mainline)'
1161
 
                ' %s != %s' % (last_revno, len(real_rev_history)))
1162
 
        # TODO: We should probably also check that real_rev_history actually
1163
 
        #       matches self.revision_history()
1164
 
        for revision_id in real_rev_history:
1165
 
            try:
1166
 
                revision = self.repository.get_revision(revision_id)
1167
 
            except errors.NoSuchRevision, e:
1168
 
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
1169
 
                            % revision_id)
1170
 
            # In general the first entry on the revision history has no parents.
1171
 
            # But it's not illegal for it to have parents listed; this can happen
1172
 
            # in imports from Arch when the parents weren't reachable.
1173
 
            if mainline_parent_id is not None:
1174
 
                if mainline_parent_id not in revision.parent_ids:
1175
 
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
1176
 
                                        "parents of {%s}"
1177
 
                                        % (mainline_parent_id, revision_id))
1178
 
            mainline_parent_id = revision_id
1179
 
        return ret
 
1310
        actual_revno = refs[('lefthand-distance', last_revision_id)]
 
1311
        if actual_revno != last_revno:
 
1312
            result.errors.append(errors.BzrCheckError(
 
1313
                'revno does not match len(mainline) %s != %s' % (
 
1314
                last_revno, actual_revno)))
 
1315
        # TODO: We should probably also check that self.revision_history
 
1316
        # matches the repository for older branch formats.
 
1317
        # If looking for the code that cross-checks repository parents against
 
1318
        # the iter_reverse_revision_history output, that is now a repository
 
1319
        # specific check.
 
1320
        return result
1180
1321
 
1181
1322
    def _get_checkout_format(self):
1182
1323
        """Return the most suitable metadir for a checkout of this branch.
1207
1348
        # clone call. Or something. 20090224 RBC/spiv.
1208
1349
        if revision_id is None:
1209
1350
            revision_id = self.last_revision()
1210
 
        try:
1211
 
            dir_to = self.bzrdir.clone_on_transport(to_transport,
1212
 
                revision_id=revision_id, stacked_on=stacked_on,
1213
 
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1214
 
        except errors.FileExists:
1215
 
            if not use_existing_dir:
1216
 
                raise
1217
 
        except errors.NoSuchFile:
1218
 
            if not create_prefix:
1219
 
                raise
 
1351
        dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1352
            revision_id=revision_id, stacked_on=stacked_on,
 
1353
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1220
1354
        return dir_to.open_branch()
1221
1355
 
1222
1356
    def create_checkout(self, to_location, revision_id=None,
1241
1375
        if lightweight:
1242
1376
            format = self._get_checkout_format()
1243
1377
            checkout = format.initialize_on_transport(t)
1244
 
            from_branch = BranchReferenceFormat().initialize(checkout, self)
 
1378
            from_branch = BranchReferenceFormat().initialize(checkout, 
 
1379
                target_branch=self)
1245
1380
        else:
1246
1381
            format = self._get_checkout_format()
1247
1382
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1289
1424
    def supports_tags(self):
1290
1425
        return self._format.supports_tags()
1291
1426
 
 
1427
    def automatic_tag_name(self, revision_id):
 
1428
        """Try to automatically find the tag name for a revision.
 
1429
 
 
1430
        :param revision_id: Revision id of the revision.
 
1431
        :return: A tag name or None if no tag name could be determined.
 
1432
        """
 
1433
        for hook in Branch.hooks['automatic_tag_name']:
 
1434
            ret = hook(self, revision_id)
 
1435
            if ret is not None:
 
1436
                return ret
 
1437
        return None
 
1438
 
1292
1439
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1293
1440
                                         other_branch):
1294
1441
        """Ensure that revision_b is a descendant of revision_a.
1349
1496
    _formats = {}
1350
1497
    """The known formats."""
1351
1498
 
 
1499
    can_set_append_revisions_only = True
 
1500
 
1352
1501
    def __eq__(self, other):
1353
1502
        return self.__class__ is other.__class__
1354
1503
 
1356
1505
        return not (self == other)
1357
1506
 
1358
1507
    @classmethod
1359
 
    def find_format(klass, a_bzrdir):
 
1508
    def find_format(klass, a_bzrdir, name=None):
1360
1509
        """Return the format for the branch object in a_bzrdir."""
1361
1510
        try:
1362
 
            transport = a_bzrdir.get_branch_transport(None)
1363
 
            format_string = transport.get("format").read()
 
1511
            transport = a_bzrdir.get_branch_transport(None, name=name)
 
1512
            format_string = transport.get_bytes("format")
1364
1513
            return klass._formats[format_string]
1365
1514
        except errors.NoSuchFile:
1366
 
            raise errors.NotBranchError(path=transport.base)
 
1515
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1367
1516
        except KeyError:
1368
1517
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1369
1518
 
1405
1554
        """Return the short format description for this format."""
1406
1555
        raise NotImplementedError(self.get_format_description)
1407
1556
 
1408
 
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1409
 
                           set_format=True):
 
1557
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
 
1558
        hooks = Branch.hooks['post_branch_init']
 
1559
        if not hooks:
 
1560
            return
 
1561
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
 
1562
        for hook in hooks:
 
1563
            hook(params)
 
1564
 
 
1565
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
1566
                           lock_type='metadir', set_format=True):
1410
1567
        """Initialize a branch in a bzrdir, with specified files
1411
1568
 
1412
1569
        :param a_bzrdir: The bzrdir to initialize the branch in
1413
1570
        :param utf8_files: The files to create as a list of
1414
1571
            (filename, content) tuples
 
1572
        :param name: Name of colocated branch to create, if any
1415
1573
        :param set_format: If True, set the format with
1416
1574
            self.get_format_string.  (BzrBranch4 has its format set
1417
1575
            elsewhere)
1418
1576
        :return: a branch in this format
1419
1577
        """
1420
 
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1421
 
        branch_transport = a_bzrdir.get_branch_transport(self)
 
1578
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1579
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1422
1580
        lock_map = {
1423
1581
            'metadir': ('lock', lockdir.LockDir),
1424
1582
            'branch4': ('branch-lock', lockable_files.TransportLock),
1445
1603
        finally:
1446
1604
            if lock_taken:
1447
1605
                control_files.unlock()
1448
 
        return self.open(a_bzrdir, _found=True)
 
1606
        branch = self.open(a_bzrdir, name, _found=True)
 
1607
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
1608
        return branch
1449
1609
 
1450
 
    def initialize(self, a_bzrdir):
1451
 
        """Create a branch of this format in a_bzrdir."""
 
1610
    def initialize(self, a_bzrdir, name=None):
 
1611
        """Create a branch of this format in a_bzrdir.
 
1612
        
 
1613
        :param name: Name of the colocated branch to create.
 
1614
        """
1452
1615
        raise NotImplementedError(self.initialize)
1453
1616
 
1454
1617
    def is_supported(self):
1484
1647
        """
1485
1648
        raise NotImplementedError(self.network_name)
1486
1649
 
1487
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1650
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1488
1651
        """Return the branch object for a_bzrdir
1489
1652
 
1490
1653
        :param a_bzrdir: A BzrDir that contains a branch.
 
1654
        :param name: Name of colocated branch to open
1491
1655
        :param _found: a private parameter, do not use it. It is used to
1492
1656
            indicate if format probing has already be done.
1493
1657
        :param ignore_fallbacks: when set, no fallback branches will be opened
1507
1671
    def set_default_format(klass, format):
1508
1672
        klass._default_format = format
1509
1673
 
 
1674
    def supports_set_append_revisions_only(self):
 
1675
        """True if this format supports set_append_revisions_only."""
 
1676
        return False
 
1677
 
1510
1678
    def supports_stacking(self):
1511
1679
        """True if this format records a stacked-on branch."""
1512
1680
        return False
1597
1765
            "multiple hooks installed for transform_fallback_location, "
1598
1766
            "all are called with the url returned from the previous hook."
1599
1767
            "The order is however undefined.", (1, 9), None))
 
1768
        self.create_hook(HookPoint('automatic_tag_name',
 
1769
            "Called to determine an automatic tag name for a revision."
 
1770
            "automatic_tag_name is called with (branch, revision_id) and "
 
1771
            "should return a tag name or None if no tag name could be "
 
1772
            "determined. The first non-None tag name returned will be used.",
 
1773
            (2, 2), None))
 
1774
        self.create_hook(HookPoint('post_branch_init',
 
1775
            "Called after new branch initialization completes. "
 
1776
            "post_branch_init is called with a "
 
1777
            "bzrlib.branch.BranchInitHookParams. "
 
1778
            "Note that init, branch and checkout (both heavyweight and "
 
1779
            "lightweight) will all trigger this hook.", (2, 2), None))
 
1780
        self.create_hook(HookPoint('post_switch',
 
1781
            "Called after a checkout switches branch. "
 
1782
            "post_switch is called with a "
 
1783
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1784
 
1600
1785
 
1601
1786
 
1602
1787
# install the default hooks into the Branch class.
1641
1826
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1642
1827
 
1643
1828
 
 
1829
class BranchInitHookParams(object):
 
1830
    """Object holding parameters passed to *_branch_init hooks.
 
1831
 
 
1832
    There are 4 fields that hooks may wish to access:
 
1833
 
 
1834
    :ivar format: the branch format
 
1835
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
 
1836
    :ivar name: name of colocated branch, if any (or None)
 
1837
    :ivar branch: the branch created
 
1838
 
 
1839
    Note that for lightweight checkouts, the bzrdir and format fields refer to
 
1840
    the checkout, hence they are different from the corresponding fields in
 
1841
    branch, which refer to the original branch.
 
1842
    """
 
1843
 
 
1844
    def __init__(self, format, a_bzrdir, name, branch):
 
1845
        """Create a group of BranchInitHook parameters.
 
1846
 
 
1847
        :param format: the branch format
 
1848
        :param a_bzrdir: the BzrDir where the branch will be/has been
 
1849
            initialized
 
1850
        :param name: name of colocated branch, if any (or None)
 
1851
        :param branch: the branch created
 
1852
 
 
1853
        Note that for lightweight checkouts, the bzrdir and format fields refer
 
1854
        to the checkout, hence they are different from the corresponding fields
 
1855
        in branch, which refer to the original branch.
 
1856
        """
 
1857
        self.format = format
 
1858
        self.bzrdir = a_bzrdir
 
1859
        self.name = name
 
1860
        self.branch = branch
 
1861
 
 
1862
    def __eq__(self, other):
 
1863
        return self.__dict__ == other.__dict__
 
1864
 
 
1865
    def __repr__(self):
 
1866
        if self.branch:
 
1867
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
 
1868
        else:
 
1869
            return "<%s of format:%s bzrdir:%s>" % (
 
1870
                self.__class__.__name__, self.branch,
 
1871
                self.format, self.bzrdir)
 
1872
 
 
1873
 
 
1874
class SwitchHookParams(object):
 
1875
    """Object holding parameters passed to *_switch hooks.
 
1876
 
 
1877
    There are 4 fields that hooks may wish to access:
 
1878
 
 
1879
    :ivar control_dir: BzrDir of the checkout to change
 
1880
    :ivar to_branch: branch that the checkout is to reference
 
1881
    :ivar force: skip the check for local commits in a heavy checkout
 
1882
    :ivar revision_id: revision ID to switch to (or None)
 
1883
    """
 
1884
 
 
1885
    def __init__(self, control_dir, to_branch, force, revision_id):
 
1886
        """Create a group of SwitchHook parameters.
 
1887
 
 
1888
        :param control_dir: BzrDir of the checkout to change
 
1889
        :param to_branch: branch that the checkout is to reference
 
1890
        :param force: skip the check for local commits in a heavy checkout
 
1891
        :param revision_id: revision ID to switch to (or None)
 
1892
        """
 
1893
        self.control_dir = control_dir
 
1894
        self.to_branch = to_branch
 
1895
        self.force = force
 
1896
        self.revision_id = revision_id
 
1897
 
 
1898
    def __eq__(self, other):
 
1899
        return self.__dict__ == other.__dict__
 
1900
 
 
1901
    def __repr__(self):
 
1902
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
 
1903
            self.control_dir, self.to_branch,
 
1904
            self.revision_id)
 
1905
 
 
1906
 
1644
1907
class BzrBranchFormat4(BranchFormat):
1645
1908
    """Bzr branch format 4.
1646
1909
 
1653
1916
        """See BranchFormat.get_format_description()."""
1654
1917
        return "Branch format 4"
1655
1918
 
1656
 
    def initialize(self, a_bzrdir):
 
1919
    def initialize(self, a_bzrdir, name=None):
1657
1920
        """Create a branch of this format in a_bzrdir."""
1658
1921
        utf8_files = [('revision-history', ''),
1659
1922
                      ('branch-name', ''),
1660
1923
                      ]
1661
 
        return self._initialize_helper(a_bzrdir, utf8_files,
 
1924
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1662
1925
                                       lock_type='branch4', set_format=False)
1663
1926
 
1664
1927
    def __init__(self):
1669
1932
        """The network name for this format is the control dirs disk label."""
1670
1933
        return self._matchingbzrdir.get_format_string()
1671
1934
 
1672
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1935
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1673
1936
        """See BranchFormat.open()."""
1674
1937
        if not _found:
1675
1938
            # we are being called directly and must probe.
1677
1940
        return BzrBranch(_format=self,
1678
1941
                         _control_files=a_bzrdir._control_files,
1679
1942
                         a_bzrdir=a_bzrdir,
 
1943
                         name=name,
1680
1944
                         _repository=a_bzrdir.open_repository())
1681
1945
 
1682
1946
    def __str__(self):
1697
1961
        """
1698
1962
        return self.get_format_string()
1699
1963
 
1700
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1964
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1701
1965
        """See BranchFormat.open()."""
1702
1966
        if not _found:
1703
 
            format = BranchFormat.find_format(a_bzrdir)
 
1967
            format = BranchFormat.find_format(a_bzrdir, name=name)
1704
1968
            if format.__class__ != self.__class__:
1705
1969
                raise AssertionError("wrong format %r found for %r" %
1706
1970
                    (format, self))
 
1971
        transport = a_bzrdir.get_branch_transport(None, name=name)
1707
1972
        try:
1708
 
            transport = a_bzrdir.get_branch_transport(None)
1709
1973
            control_files = lockable_files.LockableFiles(transport, 'lock',
1710
1974
                                                         lockdir.LockDir)
1711
1975
            return self._branch_class()(_format=self,
1712
1976
                              _control_files=control_files,
 
1977
                              name=name,
1713
1978
                              a_bzrdir=a_bzrdir,
1714
1979
                              _repository=a_bzrdir.find_repository(),
1715
1980
                              ignore_fallbacks=ignore_fallbacks)
1716
1981
        except errors.NoSuchFile:
1717
 
            raise errors.NotBranchError(path=transport.base)
 
1982
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1718
1983
 
1719
1984
    def __init__(self):
1720
1985
        super(BranchFormatMetadir, self).__init__()
1749
2014
        """See BranchFormat.get_format_description()."""
1750
2015
        return "Branch format 5"
1751
2016
 
1752
 
    def initialize(self, a_bzrdir):
 
2017
    def initialize(self, a_bzrdir, name=None):
1753
2018
        """Create a branch of this format in a_bzrdir."""
1754
2019
        utf8_files = [('revision-history', ''),
1755
2020
                      ('branch-name', ''),
1756
2021
                      ]
1757
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2022
        return self._initialize_helper(a_bzrdir, utf8_files, name)
1758
2023
 
1759
2024
    def supports_tags(self):
1760
2025
        return False
1782
2047
        """See BranchFormat.get_format_description()."""
1783
2048
        return "Branch format 6"
1784
2049
 
1785
 
    def initialize(self, a_bzrdir):
 
2050
    def initialize(self, a_bzrdir, name=None):
1786
2051
        """Create a branch of this format in a_bzrdir."""
1787
2052
        utf8_files = [('last-revision', '0 null:\n'),
1788
2053
                      ('branch.conf', ''),
1789
2054
                      ('tags', ''),
1790
2055
                      ]
1791
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2056
        return self._initialize_helper(a_bzrdir, utf8_files, name)
1792
2057
 
1793
2058
    def make_tags(self, branch):
1794
2059
        """See bzrlib.branch.BranchFormat.make_tags()."""
1795
2060
        return BasicTags(branch)
1796
2061
 
 
2062
    def supports_set_append_revisions_only(self):
 
2063
        return True
1797
2064
 
1798
2065
 
1799
2066
class BzrBranchFormat8(BranchFormatMetadir):
1810
2077
        """See BranchFormat.get_format_description()."""
1811
2078
        return "Branch format 8"
1812
2079
 
1813
 
    def initialize(self, a_bzrdir):
 
2080
    def initialize(self, a_bzrdir, name=None):
1814
2081
        """Create a branch of this format in a_bzrdir."""
1815
2082
        utf8_files = [('last-revision', '0 null:\n'),
1816
2083
                      ('branch.conf', ''),
1817
2084
                      ('tags', ''),
1818
2085
                      ('references', '')
1819
2086
                      ]
1820
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2087
        return self._initialize_helper(a_bzrdir, utf8_files, name)
1821
2088
 
1822
2089
    def __init__(self):
1823
2090
        super(BzrBranchFormat8, self).__init__()
1828
2095
        """See bzrlib.branch.BranchFormat.make_tags()."""
1829
2096
        return BasicTags(branch)
1830
2097
 
 
2098
    def supports_set_append_revisions_only(self):
 
2099
        return True
 
2100
 
1831
2101
    def supports_stacking(self):
1832
2102
        return True
1833
2103
 
1843
2113
    This format was introduced in bzr 1.6.
1844
2114
    """
1845
2115
 
1846
 
    def initialize(self, a_bzrdir):
 
2116
    def initialize(self, a_bzrdir, name=None):
1847
2117
        """Create a branch of this format in a_bzrdir."""
1848
2118
        utf8_files = [('last-revision', '0 null:\n'),
1849
2119
                      ('branch.conf', ''),
1850
2120
                      ('tags', ''),
1851
2121
                      ]
1852
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2122
        return self._initialize_helper(a_bzrdir, utf8_files, name)
1853
2123
 
1854
2124
    def _branch_class(self):
1855
2125
        return BzrBranch7
1862
2132
        """See BranchFormat.get_format_description()."""
1863
2133
        return "Branch format 7"
1864
2134
 
 
2135
    def supports_set_append_revisions_only(self):
 
2136
        return True
 
2137
 
1865
2138
    supports_reference_locations = False
1866
2139
 
1867
2140
 
1887
2160
    def get_reference(self, a_bzrdir):
1888
2161
        """See BranchFormat.get_reference()."""
1889
2162
        transport = a_bzrdir.get_branch_transport(None)
1890
 
        return transport.get('location').read()
 
2163
        return transport.get_bytes('location')
1891
2164
 
1892
2165
    def set_reference(self, a_bzrdir, to_branch):
1893
2166
        """See BranchFormat.set_reference()."""
1894
2167
        transport = a_bzrdir.get_branch_transport(None)
1895
2168
        location = transport.put_bytes('location', to_branch.base)
1896
2169
 
1897
 
    def initialize(self, a_bzrdir, target_branch=None):
 
2170
    def initialize(self, a_bzrdir, name=None, target_branch=None):
1898
2171
        """Create a branch of this format in a_bzrdir."""
1899
2172
        if target_branch is None:
1900
2173
            # this format does not implement branch itself, thus the implicit
1901
2174
            # creation contract must see it as uninitializable
1902
2175
            raise errors.UninitializableFormat(self)
1903
 
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
1904
 
        branch_transport = a_bzrdir.get_branch_transport(self)
 
2176
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2177
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1905
2178
        branch_transport.put_bytes('location',
1906
 
            target_branch.bzrdir.root_transport.base)
 
2179
            target_branch.bzrdir.user_url)
1907
2180
        branch_transport.put_bytes('format', self.get_format_string())
1908
 
        return self.open(
1909
 
            a_bzrdir, _found=True,
 
2181
        branch = self.open(
 
2182
            a_bzrdir, name, _found=True,
1910
2183
            possible_transports=[target_branch.bzrdir.root_transport])
 
2184
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2185
        return branch
1911
2186
 
1912
2187
    def __init__(self):
1913
2188
        super(BranchReferenceFormat, self).__init__()
1919
2194
        def clone(to_bzrdir, revision_id=None,
1920
2195
            repository_policy=None):
1921
2196
            """See Branch.clone()."""
1922
 
            return format.initialize(to_bzrdir, a_branch)
 
2197
            return format.initialize(to_bzrdir, target_branch=a_branch)
1923
2198
            # cannot obey revision_id limits when cloning a reference ...
1924
2199
            # FIXME RBC 20060210 either nuke revision_id for clone, or
1925
2200
            # emit some sort of warning/error to the caller ?!
1926
2201
        return clone
1927
2202
 
1928
 
    def open(self, a_bzrdir, _found=False, location=None,
 
2203
    def open(self, a_bzrdir, name=None, _found=False, location=None,
1929
2204
             possible_transports=None, ignore_fallbacks=False):
1930
2205
        """Return the branch that the branch reference in a_bzrdir points at.
1931
2206
 
1932
2207
        :param a_bzrdir: A BzrDir that contains a branch.
 
2208
        :param name: Name of colocated branch to open, if any
1933
2209
        :param _found: a private parameter, do not use it. It is used to
1934
2210
            indicate if format probing has already be done.
1935
2211
        :param ignore_fallbacks: when set, no fallback branches will be opened
1940
2216
        :param possible_transports: An optional reusable transports list.
1941
2217
        """
1942
2218
        if not _found:
1943
 
            format = BranchFormat.find_format(a_bzrdir)
 
2219
            format = BranchFormat.find_format(a_bzrdir, name=name)
1944
2220
            if format.__class__ != self.__class__:
1945
2221
                raise AssertionError("wrong format %r found for %r" %
1946
2222
                    (format, self))
1948
2224
            location = self.get_reference(a_bzrdir)
1949
2225
        real_bzrdir = bzrdir.BzrDir.open(
1950
2226
            location, possible_transports=possible_transports)
1951
 
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
 
2227
        result = real_bzrdir.open_branch(name=name, 
 
2228
            ignore_fallbacks=ignore_fallbacks)
1952
2229
        # this changes the behaviour of result.clone to create a new reference
1953
2230
        # rather than a copy of the content of the branch.
1954
2231
        # I did not use a proxy object because that needs much more extensive
1981
2258
BranchFormat.register_format(__format6)
1982
2259
BranchFormat.register_format(__format7)
1983
2260
BranchFormat.register_format(__format8)
1984
 
BranchFormat.set_default_format(__format6)
 
2261
BranchFormat.set_default_format(__format7)
1985
2262
_legacy_formats = [BzrBranchFormat4(),
1986
2263
    ]
1987
2264
network_format_registry.register(
1988
2265
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1989
2266
 
1990
2267
 
1991
 
class BzrBranch(Branch):
 
2268
class BzrBranch(Branch, _RelockDebugMixin):
1992
2269
    """A branch stored in the actual filesystem.
1993
2270
 
1994
2271
    Note that it's "local" in the context of the filesystem; it doesn't
2000
2277
    :ivar repository: Repository for this branch.
2001
2278
    :ivar base: The url of the base directory for this branch; the one
2002
2279
        containing the .bzr directory.
 
2280
    :ivar name: Optional colocated branch name as it exists in the control
 
2281
        directory.
2003
2282
    """
2004
2283
 
2005
2284
    def __init__(self, _format=None,
2006
 
                 _control_files=None, a_bzrdir=None, _repository=None,
2007
 
                 ignore_fallbacks=False):
 
2285
                 _control_files=None, a_bzrdir=None, name=None,
 
2286
                 _repository=None, ignore_fallbacks=False):
2008
2287
        """Create new branch object at a particular location."""
2009
2288
        if a_bzrdir is None:
2010
2289
            raise ValueError('a_bzrdir must be supplied')
2011
2290
        else:
2012
2291
            self.bzrdir = a_bzrdir
2013
2292
        self._base = self.bzrdir.transport.clone('..').base
 
2293
        self.name = name
2014
2294
        # XXX: We should be able to just do
2015
2295
        #   self.base = self.bzrdir.root_transport.base
2016
2296
        # but this does not quite work yet -- mbp 20080522
2023
2303
        Branch.__init__(self)
2024
2304
 
2025
2305
    def __str__(self):
2026
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
2306
        if self.name is None:
 
2307
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
 
2308
        else:
 
2309
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
 
2310
                self.name)
2027
2311
 
2028
2312
    __repr__ = __str__
2029
2313
 
2040
2324
        return self.control_files.is_locked()
2041
2325
 
2042
2326
    def lock_write(self, token=None):
 
2327
        if not self.is_locked():
 
2328
            self._note_lock('w')
2043
2329
        # All-in-one needs to always unlock/lock.
2044
2330
        repo_control = getattr(self.repository, 'control_files', None)
2045
2331
        if self.control_files == repo_control or not self.is_locked():
 
2332
            self.repository._warn_if_deprecated(self)
2046
2333
            self.repository.lock_write()
2047
2334
            took_lock = True
2048
2335
        else:
2055
2342
            raise
2056
2343
 
2057
2344
    def lock_read(self):
 
2345
        if not self.is_locked():
 
2346
            self._note_lock('r')
2058
2347
        # All-in-one needs to always unlock/lock.
2059
2348
        repo_control = getattr(self.repository, 'control_files', None)
2060
2349
        if self.control_files == repo_control or not self.is_locked():
 
2350
            self.repository._warn_if_deprecated(self)
2061
2351
            self.repository.lock_read()
2062
2352
            took_lock = True
2063
2353
        else:
2069
2359
                self.repository.unlock()
2070
2360
            raise
2071
2361
 
 
2362
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2072
2363
    def unlock(self):
2073
2364
        try:
2074
2365
            self.control_files.unlock()
2237
2528
        return result
2238
2529
 
2239
2530
    def get_stacked_on_url(self):
2240
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2531
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2241
2532
 
2242
2533
    def set_push_location(self, location):
2243
2534
        """See Branch.set_push_location."""
2376
2667
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2377
2668
        super(BzrBranch8, self).__init__(*args, **kwargs)
2378
2669
        self._last_revision_info_cache = None
2379
 
        self._partial_revision_history_cache = []
2380
2670
        self._reference_info = None
2381
2671
 
2382
2672
    def _clear_cached_state(self):
2383
2673
        super(BzrBranch8, self)._clear_cached_state()
2384
2674
        self._last_revision_info_cache = None
2385
 
        self._partial_revision_history_cache = []
2386
2675
        self._reference_info = None
2387
2676
 
2388
2677
    def _last_revision_info(self):
2435
2724
        if _mod_revision.is_null(last_revision):
2436
2725
            return
2437
2726
        if last_revision not in self._lefthand_history(revision_id):
2438
 
            raise errors.AppendRevisionsOnlyViolation(self.base)
 
2727
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
2439
2728
 
2440
2729
    def _gen_revision_history(self):
2441
2730
        """Generate the revision history from last revision
2444
2733
        self._extend_partial_history(stop_index=last_revno-1)
2445
2734
        return list(reversed(self._partial_revision_history_cache))
2446
2735
 
2447
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
2448
 
        """Extend the partial history to include a given index
2449
 
 
2450
 
        If a stop_index is supplied, stop when that index has been reached.
2451
 
        If a stop_revision is supplied, stop when that revision is
2452
 
        encountered.  Otherwise, stop when the beginning of history is
2453
 
        reached.
2454
 
 
2455
 
        :param stop_index: The index which should be present.  When it is
2456
 
            present, history extension will stop.
2457
 
        :param revision_id: The revision id which should be present.  When
2458
 
            it is encountered, history extension will stop.
2459
 
        """
2460
 
        repo = self.repository
2461
 
        if len(self._partial_revision_history_cache) == 0:
2462
 
            iterator = repo.iter_reverse_revision_history(self.last_revision())
2463
 
        else:
2464
 
            start_revision = self._partial_revision_history_cache[-1]
2465
 
            iterator = repo.iter_reverse_revision_history(start_revision)
2466
 
            #skip the last revision in the list
2467
 
            next_revision = iterator.next()
2468
 
        for revision_id in iterator:
2469
 
            self._partial_revision_history_cache.append(revision_id)
2470
 
            if (stop_index is not None and
2471
 
                len(self._partial_revision_history_cache) > stop_index):
2472
 
                break
2473
 
            if revision_id == stop_revision:
2474
 
                break
2475
 
 
2476
2736
    def _write_revision_history(self, history):
2477
2737
        """Factored out of set_revision_history.
2478
2738
 
2570
2830
        if branch_location is None:
2571
2831
            return Branch.reference_parent(self, file_id, path,
2572
2832
                                           possible_transports)
2573
 
        branch_location = urlutils.join(self.base, branch_location)
 
2833
        branch_location = urlutils.join(self.user_url, branch_location)
2574
2834
        return Branch.open(branch_location,
2575
2835
                           possible_transports=possible_transports)
2576
2836
 
2621
2881
            raise errors.NotStacked(self)
2622
2882
        return stacked_url
2623
2883
 
2624
 
    def set_append_revisions_only(self, enabled):
2625
 
        if enabled:
2626
 
            value = 'True'
2627
 
        else:
2628
 
            value = 'False'
2629
 
        self.get_config().set_user_option('append_revisions_only', value,
2630
 
            warn_masked=True)
2631
 
 
2632
2884
    def _get_append_revisions_only(self):
2633
 
        value = self.get_config().get_user_option('append_revisions_only')
2634
 
        return value == 'True'
 
2885
        return self.get_config(
 
2886
            ).get_user_option_as_bool('append_revisions_only')
2635
2887
 
2636
2888
    @needs_write_lock
2637
2889
    def generate_revision_history(self, revision_id, last_rev=None,
2699
2951
    """
2700
2952
 
2701
2953
    def get_stacked_on_url(self):
2702
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2954
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2703
2955
 
2704
2956
 
2705
2957
######################################################################
2784
3036
 
2785
3037
    def __init__(self, branch):
2786
3038
        self.branch = branch
2787
 
        self.ghosts_in_mainline = False
 
3039
        self.errors = []
2788
3040
 
2789
3041
    def report_results(self, verbose):
2790
3042
        """Report the check results via trace.note.
2792
3044
        :param verbose: Requests more detailed display of what was checked,
2793
3045
            if any.
2794
3046
        """
2795
 
        note('checked branch %s format %s',
2796
 
             self.branch.base,
2797
 
             self.branch._format)
2798
 
        if self.ghosts_in_mainline:
2799
 
            note('branch contains ghosts in mainline')
 
3047
        note('checked branch %s format %s', self.branch.user_url,
 
3048
            self.branch._format)
 
3049
        for error in self.errors:
 
3050
            note('found error:%s', error)
2800
3051
 
2801
3052
 
2802
3053
class Converter5to6(object):
2897
3148
    @staticmethod
2898
3149
    def _get_branch_formats_to_test():
2899
3150
        """Return a tuple with the Branch formats to use when testing."""
2900
 
        raise NotImplementedError(self._get_branch_formats_to_test)
 
3151
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
2901
3152
 
2902
3153
    def pull(self, overwrite=False, stop_revision=None,
2903
3154
             possible_transports=None, local=False):
3058
3309
                _override_hook_source_branch=_override_hook_source_branch)
3059
3310
        finally:
3060
3311
            self.source.unlock()
3061
 
        return result
3062
3312
 
3063
3313
    def _push_with_bound_branches(self, overwrite, stop_revision,
3064
3314
            _override_hook_source_branch=None):
3129
3379
        if local and not bound_location:
3130
3380
            raise errors.LocalRequiresBoundBranch()
3131
3381
        master_branch = None
3132
 
        if not local and bound_location and self.source.base != bound_location:
 
3382
        if not local and bound_location and self.source.user_url != bound_location:
3133
3383
            # not pulling from master, so we need to update master.
3134
3384
            master_branch = self.target.get_master_branch(possible_transports)
3135
3385
            master_branch.lock_write()