← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Barry Warsaw
  • Date: 2009-06-04 19:56:42 UTC
  • mto: This revision was merged to the branch mainline in revision 4409.
  • Revision ID: barry@python.org-20090604195642-1scssnbhcv1xhs0a
Add test for including body text for Claws.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
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
90
92
        self._revision_id_to_revno_cache = None
91
93
        self._partial_revision_id_to_revno_cache = {}
92
 
        self._partial_revision_history_cache = []
93
94
        self._last_revision_info_cache = None
94
95
        self._merge_sorted_revisions_cache = None
95
96
        self._open_hook()
103
104
    def _activate_fallback_location(self, url):
104
105
        """Activate the branch/repository from url as a fallback repository."""
105
106
        repo = self._get_fallback_repository(url)
106
 
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
108
107
        self.repository.add_fallback_repository(repo)
109
108
 
110
109
    def break_lock(self):
126
125
            raise errors.UnstackableRepositoryFormat(self.repository._format,
127
126
                self.repository.base)
128
127
 
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
 
 
158
128
    @staticmethod
159
129
    def open(base, _unsupported=False, possible_transports=None):
160
130
        """Open the branch rooted at base.
164
134
        """
165
135
        control = bzrdir.BzrDir.open(base, _unsupported,
166
136
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
137
        return control.open_branch(_unsupported)
168
138
 
169
139
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
140
    def open_from_transport(transport, _unsupported=False):
171
141
        """Open the branch rooted at transport"""
172
142
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
143
        return control.open_branch(_unsupported)
174
144
 
175
145
    @staticmethod
176
146
    def open_containing(url, possible_transports=None):
214
184
    def _get_fallback_repository(self, url):
215
185
        """Get the repository we fallback to at url."""
216
186
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
187
        a_bzrdir = bzrdir.BzrDir.open(url,
218
188
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
189
        return a_bzrdir.open_branch().repository
220
190
 
221
191
    def _get_tags_bytes(self):
222
192
        """Get the bytes of a serialised tags dict.
417
387
            * 'include' - the stop revision is the last item in the result
418
388
            * 'with-merges' - include the stop revision and all of its
419
389
              merged revisions in the result
420
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
 
              that are in both ancestries
422
390
        :param direction: either 'reverse' or 'forward':
423
391
            * reverse means return the start_revision_id first, i.e.
424
392
              start at the most recent revision and go backwards in history
446
414
        # start_revision_id.
447
415
        if self._merge_sorted_revisions_cache is None:
448
416
            last_revision = self.last_revision()
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)
 
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
 
453
426
        filtered = self._filter_merge_sorted_revisions(
454
427
            self._merge_sorted_revisions_cache, start_revision_id,
455
428
            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)
459
429
        if direction == 'reverse':
460
430
            return filtered
461
431
        if direction == 'forward':
468
438
        """Iterate over an inclusive range of sorted revisions."""
469
439
        rev_iter = iter(merge_sorted_revisions)
470
440
        if start_revision_id is not None:
471
 
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
441
            for rev_id, depth, revno, end_of_merge in rev_iter:
473
442
                if rev_id != start_revision_id:
474
443
                    continue
475
444
                else:
476
445
                    # The decision to include the start or not
477
446
                    # depends on the stop_rule if a stop is provided
478
 
                    # so pop this node back into the iterator
479
 
                    rev_iter = chain(iter([node]), rev_iter)
 
447
                    rev_iter = chain(
 
448
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
449
                        rev_iter)
480
450
                    break
481
451
        if stop_revision_id is None:
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)
 
452
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
453
                yield rev_id, depth, revno, end_of_merge
487
454
        elif stop_rule == 'exclude':
488
 
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
455
            for rev_id, depth, revno, end_of_merge in rev_iter:
490
456
                if rev_id == stop_revision_id:
491
457
                    return
492
 
                yield (rev_id, node.merge_depth, node.revno,
493
 
                       node.end_of_merge)
 
458
                yield rev_id, depth, revno, end_of_merge
494
459
        elif stop_rule == 'include':
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)
 
460
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
461
                yield rev_id, depth, revno, end_of_merge
499
462
                if rev_id == stop_revision_id:
500
463
                    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)
513
464
        elif stop_rule == 'with-merges':
514
465
            stop_rev = self.repository.get_revision(stop_revision_id)
515
466
            if stop_rev.parent_ids:
516
467
                left_parent = stop_rev.parent_ids[0]
517
468
            else:
518
469
                left_parent = _mod_revision.NULL_REVISION
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]
 
470
            for rev_id, depth, revno, end_of_merge in rev_iter:
525
471
                if rev_id == left_parent:
526
 
                    # reached the left parent after the stop_revision
527
472
                    return
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)
 
473
                yield rev_id, depth, revno, end_of_merge
538
474
        else:
539
475
            raise ValueError('invalid stop_rule %r' % stop_rule)
540
476
 
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
 
 
586
477
    def leave_lock_in_place(self):
587
478
        """Tell this branch object not to release the physical lock when this
588
479
        object is unlocked.
605
496
        :param other: The branch to bind to
606
497
        :type other: Branch
607
498
        """
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)
 
499
        raise errors.UpgradeRequired(self.base)
619
500
 
620
501
    def set_reference_info(self, file_id, tree_path, branch_location):
621
502
        """Set the branch location to use for a tree reference."""
663
544
    def get_old_bound_location(self):
664
545
        """Return the URL of the branch we used to be bound to
665
546
        """
666
 
        raise errors.UpgradeRequired(self.user_url)
 
547
        raise errors.UpgradeRequired(self.base)
667
548
 
668
549
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
550
                           timezone=None, committer=None, revprops=None,
747
628
            stacking.
748
629
        """
749
630
        if not self._format.supports_stacking():
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.
 
631
            raise errors.UnstackableBranchFormat(self._format, self.base)
754
632
        self._check_stackable_repo()
755
633
        if not url:
756
634
            try:
758
636
            except (errors.NotStacked, errors.UnstackableBranchFormat,
759
637
                errors.UnstackableRepositoryFormat):
760
638
                return
761
 
            self._unstack()
 
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)
762
654
        else:
763
655
            self._activate_fallback_location(url)
764
656
        # write this out after the repository is stacked to avoid setting a
765
657
        # stacked config that doesn't work.
766
658
        self._set_config_location('stacked_on_location', url)
767
659
 
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()
822
660
 
823
661
    def _set_tags_bytes(self, bytes):
824
662
        """Mirror method for _get_tags_bytes.
860
698
        self._revision_id_to_revno_cache = None
861
699
        self._last_revision_info_cache = None
862
700
        self._merge_sorted_revisions_cache = None
863
 
        self._partial_revision_history_cache = []
864
 
        self._partial_revision_id_to_revno_cache = {}
865
701
 
866
702
    def _gen_revision_history(self):
867
703
        """Return sequence of revision hashes on to this branch.
904
740
 
905
741
    def unbind(self):
906
742
        """Older format branches cannot bind or unbind."""
907
 
        raise errors.UpgradeRequired(self.user_url)
 
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)
908
748
 
909
749
    def last_revision(self):
910
750
        """Return last revision id, or NULL_REVISION."""
991
831
        except ValueError:
992
832
            raise errors.NoSuchRevision(self, revision_id)
993
833
 
994
 
    @needs_read_lock
995
834
    def get_rev_id(self, revno, history=None):
996
835
        """Find the revision id of the specified revno."""
997
836
        if revno == 0:
998
837
            return _mod_revision.NULL_REVISION
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:
 
838
        if history is None:
 
839
            history = self.revision_history()
 
840
        if revno <= 0 or revno > len(history):
1003
841
            raise errors.NoSuchRevision(self, revno)
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]
 
842
        return history[revno - 1]
1008
843
 
1009
844
    @needs_write_lock
1010
845
    def pull(self, source, overwrite=False, stop_revision=None,
1070
905
        try:
1071
906
            return urlutils.join(self.base[:-1], parent)
1072
907
        except errors.InvalidURLJoin, e:
1073
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
908
            raise errors.InaccessibleParent(parent, self.base)
1074
909
 
1075
910
    def _get_parent_location(self):
1076
911
        raise NotImplementedError(self._get_parent_location)
1161
996
        params = ChangeBranchTipParams(
1162
997
            self, old_revno, new_revno, old_revid, new_revid)
1163
998
        for hook in hooks:
1164
 
            hook(params)
 
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)
1165
1008
 
1166
1009
    @needs_write_lock
1167
1010
    def update(self):
1216
1059
        revision_id: if not None, the revision history in the new branch will
1217
1060
                     be truncated to end with revision_id.
1218
1061
        """
1219
 
        if (repository_policy is not None and
1220
 
            repository_policy.requires_stacking()):
1221
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
1062
        result = to_bzrdir.create_branch()
1223
1063
        result.lock_write()
1224
1064
        try:
1245
1085
        source_revno, source_revision_id = self.last_revision_info()
1246
1086
        if revision_id is None:
1247
1087
            revno, revision_id = source_revno, source_revision_id
 
1088
        elif source_revision_id == revision_id:
 
1089
            # we know the revno without needing to walk all of history
 
1090
            revno = source_revno
1248
1091
        else:
1249
 
            graph = self.repository.get_graph()
1250
 
            try:
1251
 
                revno = graph.find_distance_to_null(revision_id, 
1252
 
                    [(source_revision_id, source_revno)])
1253
 
            except errors.GhostRevisionsHaveNoRevno:
1254
 
                # Default to 1, if we can't find anything else
1255
 
                revno = 1
 
1092
            # To figure out the revno for a random revision, we need to build
 
1093
            # the revision history, and count its length.
 
1094
            # We don't care about the order, just how long it is.
 
1095
            # Alternatively, we could start at the current location, and count
 
1096
            # backwards. But there is no guarantee that we will find it since
 
1097
            # it may be a merged revision.
 
1098
            revno = len(list(self.repository.iter_reverse_revision_history(
 
1099
                                                                revision_id)))
1256
1100
        destination.set_last_revision_info(revno, revision_id)
1257
1101
 
1258
1102
    @needs_read_lock
1292
1136
        target._set_all_reference_info(target_reference_dict)
1293
1137
 
1294
1138
    @needs_read_lock
1295
 
    def check(self, refs):
 
1139
    def check(self):
1296
1140
        """Check consistency of the branch.
1297
1141
 
1298
1142
        In particular this checks that revisions given in the revision-history
1301
1145
 
1302
1146
        Callers will typically also want to check the repository.
1303
1147
 
1304
 
        :param refs: Calculated refs for this branch as specified by
1305
 
            branch._get_check_refs()
1306
1148
        :return: A BranchCheckResult.
1307
1149
        """
1308
 
        result = BranchCheckResult(self)
 
1150
        mainline_parent_id = None
1309
1151
        last_revno, last_revision_id = self.last_revision_info()
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
 
1152
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
1153
                                last_revision_id))
 
1154
        real_rev_history.reverse()
 
1155
        if len(real_rev_history) != last_revno:
 
1156
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1157
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1158
        # TODO: We should probably also check that real_rev_history actually
 
1159
        #       matches self.revision_history()
 
1160
        for revision_id in real_rev_history:
 
1161
            try:
 
1162
                revision = self.repository.get_revision(revision_id)
 
1163
            except errors.NoSuchRevision, e:
 
1164
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1165
                            % revision_id)
 
1166
            # In general the first entry on the revision history has no parents.
 
1167
            # But it's not illegal for it to have parents listed; this can happen
 
1168
            # in imports from Arch when the parents weren't reachable.
 
1169
            if mainline_parent_id is not None:
 
1170
                if mainline_parent_id not in revision.parent_ids:
 
1171
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1172
                                        "parents of {%s}"
 
1173
                                        % (mainline_parent_id, revision_id))
 
1174
            mainline_parent_id = revision_id
 
1175
        return BranchCheckResult(self)
1321
1176
 
1322
1177
    def _get_checkout_format(self):
1323
1178
        """Return the most suitable metadir for a checkout of this branch.
1348
1203
        # clone call. Or something. 20090224 RBC/spiv.
1349
1204
        if revision_id is None:
1350
1205
            revision_id = self.last_revision()
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)
 
1206
        try:
 
1207
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1208
                revision_id=revision_id, stacked_on=stacked_on,
 
1209
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1210
        except errors.FileExists:
 
1211
            if not use_existing_dir:
 
1212
                raise
 
1213
        except errors.NoSuchFile:
 
1214
            if not create_prefix:
 
1215
                raise
1354
1216
        return dir_to.open_branch()
1355
1217
 
1356
1218
    def create_checkout(self, to_location, revision_id=None,
1375
1237
        if lightweight:
1376
1238
            format = self._get_checkout_format()
1377
1239
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1240
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1241
        else:
1381
1242
            format = self._get_checkout_format()
1382
1243
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1424
1285
    def supports_tags(self):
1425
1286
        return self._format.supports_tags()
1426
1287
 
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
 
 
1439
1288
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1289
                                         other_branch):
1441
1290
        """Ensure that revision_b is a descendant of revision_a.
1496
1345
    _formats = {}
1497
1346
    """The known formats."""
1498
1347
 
1499
 
    can_set_append_revisions_only = True
1500
 
 
1501
1348
    def __eq__(self, other):
1502
1349
        return self.__class__ is other.__class__
1503
1350
 
1505
1352
        return not (self == other)
1506
1353
 
1507
1354
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1355
    def find_format(klass, a_bzrdir):
1509
1356
        """Return the format for the branch object in a_bzrdir."""
1510
1357
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1358
            transport = a_bzrdir.get_branch_transport(None)
 
1359
            format_string = transport.get("format").read()
1513
1360
            return klass._formats[format_string]
1514
1361
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1362
            raise errors.NotBranchError(path=transport.base)
1516
1363
        except KeyError:
1517
1364
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1365
 
1554
1401
        """Return the short format description for this format."""
1555
1402
        raise NotImplementedError(self.get_format_description)
1556
1403
 
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):
 
1404
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1405
                           set_format=True):
1567
1406
        """Initialize a branch in a bzrdir, with specified files
1568
1407
 
1569
1408
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1409
        :param utf8_files: The files to create as a list of
1571
1410
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1411
        :param set_format: If True, set the format with
1574
1412
            self.get_format_string.  (BzrBranch4 has its format set
1575
1413
            elsewhere)
1576
1414
        :return: a branch in this format
1577
1415
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1416
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1417
        branch_transport = a_bzrdir.get_branch_transport(self)
1580
1418
        lock_map = {
1581
1419
            'metadir': ('lock', lockdir.LockDir),
1582
1420
            'branch4': ('branch-lock', lockable_files.TransportLock),
1603
1441
        finally:
1604
1442
            if lock_taken:
1605
1443
                control_files.unlock()
1606
 
        branch = self.open(a_bzrdir, name, _found=True)
1607
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1608
 
        return branch
 
1444
        return self.open(a_bzrdir, _found=True)
1609
1445
 
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
 
        """
 
1446
    def initialize(self, a_bzrdir):
 
1447
        """Create a branch of this format in a_bzrdir."""
1615
1448
        raise NotImplementedError(self.initialize)
1616
1449
 
1617
1450
    def is_supported(self):
1647
1480
        """
1648
1481
        raise NotImplementedError(self.network_name)
1649
1482
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1483
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1651
1484
        """Return the branch object for a_bzrdir
1652
1485
 
1653
1486
        :param a_bzrdir: A BzrDir that contains a branch.
1654
 
        :param name: Name of colocated branch to open
1655
1487
        :param _found: a private parameter, do not use it. It is used to
1656
1488
            indicate if format probing has already be done.
1657
1489
        :param ignore_fallbacks: when set, no fallback branches will be opened
1671
1503
    def set_default_format(klass, format):
1672
1504
        klass._default_format = format
1673
1505
 
1674
 
    def supports_set_append_revisions_only(self):
1675
 
        """True if this format supports set_append_revisions_only."""
1676
 
        return False
1677
 
 
1678
1506
    def supports_stacking(self):
1679
1507
        """True if this format records a stacked-on branch."""
1680
1508
        return False
1765
1593
            "multiple hooks installed for transform_fallback_location, "
1766
1594
            "all are called with the url returned from the previous hook."
1767
1595
            "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
 
 
1785
1596
 
1786
1597
 
1787
1598
# install the default hooks into the Branch class.
1826
1637
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1638
 
1828
1639
 
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
 
 
1907
1640
class BzrBranchFormat4(BranchFormat):
1908
1641
    """Bzr branch format 4.
1909
1642
 
1916
1649
        """See BranchFormat.get_format_description()."""
1917
1650
        return "Branch format 4"
1918
1651
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1652
    def initialize(self, a_bzrdir):
1920
1653
        """Create a branch of this format in a_bzrdir."""
1921
1654
        utf8_files = [('revision-history', ''),
1922
1655
                      ('branch-name', ''),
1923
1656
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1657
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1658
                                       lock_type='branch4', set_format=False)
1926
1659
 
1927
1660
    def __init__(self):
1932
1665
        """The network name for this format is the control dirs disk label."""
1933
1666
        return self._matchingbzrdir.get_format_string()
1934
1667
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1668
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1936
1669
        """See BranchFormat.open()."""
1937
1670
        if not _found:
1938
1671
            # we are being called directly and must probe.
1940
1673
        return BzrBranch(_format=self,
1941
1674
                         _control_files=a_bzrdir._control_files,
1942
1675
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1676
                         _repository=a_bzrdir.open_repository())
1945
1677
 
1946
1678
    def __str__(self):
1961
1693
        """
1962
1694
        return self.get_format_string()
1963
1695
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1696
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1965
1697
        """See BranchFormat.open()."""
1966
1698
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1699
            format = BranchFormat.find_format(a_bzrdir)
1968
1700
            if format.__class__ != self.__class__:
1969
1701
                raise AssertionError("wrong format %r found for %r" %
1970
1702
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1703
        try:
 
1704
            transport = a_bzrdir.get_branch_transport(None)
1973
1705
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1706
                                                         lockdir.LockDir)
1975
1707
            return self._branch_class()(_format=self,
1976
1708
                              _control_files=control_files,
1977
 
                              name=name,
1978
1709
                              a_bzrdir=a_bzrdir,
1979
1710
                              _repository=a_bzrdir.find_repository(),
1980
1711
                              ignore_fallbacks=ignore_fallbacks)
1981
1712
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1713
            raise errors.NotBranchError(path=transport.base)
1983
1714
 
1984
1715
    def __init__(self):
1985
1716
        super(BranchFormatMetadir, self).__init__()
2014
1745
        """See BranchFormat.get_format_description()."""
2015
1746
        return "Branch format 5"
2016
1747
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1748
    def initialize(self, a_bzrdir):
2018
1749
        """Create a branch of this format in a_bzrdir."""
2019
1750
        utf8_files = [('revision-history', ''),
2020
1751
                      ('branch-name', ''),
2021
1752
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1753
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1754
 
2024
1755
    def supports_tags(self):
2025
1756
        return False
2047
1778
        """See BranchFormat.get_format_description()."""
2048
1779
        return "Branch format 6"
2049
1780
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
1781
    def initialize(self, a_bzrdir):
2051
1782
        """Create a branch of this format in a_bzrdir."""
2052
1783
        utf8_files = [('last-revision', '0 null:\n'),
2053
1784
                      ('branch.conf', ''),
2054
1785
                      ('tags', ''),
2055
1786
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1787
        return self._initialize_helper(a_bzrdir, utf8_files)
2057
1788
 
2058
1789
    def make_tags(self, branch):
2059
1790
        """See bzrlib.branch.BranchFormat.make_tags()."""
2060
1791
        return BasicTags(branch)
2061
1792
 
2062
 
    def supports_set_append_revisions_only(self):
2063
 
        return True
2064
1793
 
2065
1794
 
2066
1795
class BzrBranchFormat8(BranchFormatMetadir):
2077
1806
        """See BranchFormat.get_format_description()."""
2078
1807
        return "Branch format 8"
2079
1808
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
1809
    def initialize(self, a_bzrdir):
2081
1810
        """Create a branch of this format in a_bzrdir."""
2082
1811
        utf8_files = [('last-revision', '0 null:\n'),
2083
1812
                      ('branch.conf', ''),
2084
1813
                      ('tags', ''),
2085
1814
                      ('references', '')
2086
1815
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1816
        return self._initialize_helper(a_bzrdir, utf8_files)
2088
1817
 
2089
1818
    def __init__(self):
2090
1819
        super(BzrBranchFormat8, self).__init__()
2095
1824
        """See bzrlib.branch.BranchFormat.make_tags()."""
2096
1825
        return BasicTags(branch)
2097
1826
 
2098
 
    def supports_set_append_revisions_only(self):
2099
 
        return True
2100
 
 
2101
1827
    def supports_stacking(self):
2102
1828
        return True
2103
1829
 
2113
1839
    This format was introduced in bzr 1.6.
2114
1840
    """
2115
1841
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
1842
    def initialize(self, a_bzrdir):
2117
1843
        """Create a branch of this format in a_bzrdir."""
2118
1844
        utf8_files = [('last-revision', '0 null:\n'),
2119
1845
                      ('branch.conf', ''),
2120
1846
                      ('tags', ''),
2121
1847
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1848
        return self._initialize_helper(a_bzrdir, utf8_files)
2123
1849
 
2124
1850
    def _branch_class(self):
2125
1851
        return BzrBranch7
2132
1858
        """See BranchFormat.get_format_description()."""
2133
1859
        return "Branch format 7"
2134
1860
 
2135
 
    def supports_set_append_revisions_only(self):
2136
 
        return True
2137
 
 
2138
1861
    supports_reference_locations = False
2139
1862
 
2140
1863
 
2160
1883
    def get_reference(self, a_bzrdir):
2161
1884
        """See BranchFormat.get_reference()."""
2162
1885
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1886
        return transport.get('location').read()
2164
1887
 
2165
1888
    def set_reference(self, a_bzrdir, to_branch):
2166
1889
        """See BranchFormat.set_reference()."""
2167
1890
        transport = a_bzrdir.get_branch_transport(None)
2168
1891
        location = transport.put_bytes('location', to_branch.base)
2169
1892
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1893
    def initialize(self, a_bzrdir, target_branch=None):
2171
1894
        """Create a branch of this format in a_bzrdir."""
2172
1895
        if target_branch is None:
2173
1896
            # this format does not implement branch itself, thus the implicit
2174
1897
            # creation contract must see it as uninitializable
2175
1898
            raise errors.UninitializableFormat(self)
2176
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2177
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1899
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1900
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1901
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1902
            target_branch.bzrdir.root_transport.base)
2180
1903
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
1904
        return self.open(
 
1905
            a_bzrdir, _found=True,
2183
1906
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
1907
 
2187
1908
    def __init__(self):
2188
1909
        super(BranchReferenceFormat, self).__init__()
2194
1915
        def clone(to_bzrdir, revision_id=None,
2195
1916
            repository_policy=None):
2196
1917
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1918
            return format.initialize(to_bzrdir, a_branch)
2198
1919
            # cannot obey revision_id limits when cloning a reference ...
2199
1920
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
1921
            # emit some sort of warning/error to the caller ?!
2201
1922
        return clone
2202
1923
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1924
    def open(self, a_bzrdir, _found=False, location=None,
2204
1925
             possible_transports=None, ignore_fallbacks=False):
2205
1926
        """Return the branch that the branch reference in a_bzrdir points at.
2206
1927
 
2207
1928
        :param a_bzrdir: A BzrDir that contains a branch.
2208
 
        :param name: Name of colocated branch to open, if any
2209
1929
        :param _found: a private parameter, do not use it. It is used to
2210
1930
            indicate if format probing has already be done.
2211
1931
        :param ignore_fallbacks: when set, no fallback branches will be opened
2216
1936
        :param possible_transports: An optional reusable transports list.
2217
1937
        """
2218
1938
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1939
            format = BranchFormat.find_format(a_bzrdir)
2220
1940
            if format.__class__ != self.__class__:
2221
1941
                raise AssertionError("wrong format %r found for %r" %
2222
1942
                    (format, self))
2224
1944
            location = self.get_reference(a_bzrdir)
2225
1945
        real_bzrdir = bzrdir.BzrDir.open(
2226
1946
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
1947
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2229
1948
        # this changes the behaviour of result.clone to create a new reference
2230
1949
        # rather than a copy of the content of the branch.
2231
1950
        # I did not use a proxy object because that needs much more extensive
2258
1977
BranchFormat.register_format(__format6)
2259
1978
BranchFormat.register_format(__format7)
2260
1979
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
 
1980
BranchFormat.set_default_format(__format6)
2262
1981
_legacy_formats = [BzrBranchFormat4(),
2263
1982
    ]
2264
1983
network_format_registry.register(
2265
1984
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
1985
 
2267
1986
 
2268
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1987
class BzrBranch(Branch):
2269
1988
    """A branch stored in the actual filesystem.
2270
1989
 
2271
1990
    Note that it's "local" in the context of the filesystem; it doesn't
2277
1996
    :ivar repository: Repository for this branch.
2278
1997
    :ivar base: The url of the base directory for this branch; the one
2279
1998
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
1999
    """
2283
2000
 
2284
2001
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
2002
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2003
                 ignore_fallbacks=False):
2287
2004
        """Create new branch object at a particular location."""
2288
2005
        if a_bzrdir is None:
2289
2006
            raise ValueError('a_bzrdir must be supplied')
2290
2007
        else:
2291
2008
            self.bzrdir = a_bzrdir
2292
2009
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
2010
        # XXX: We should be able to just do
2295
2011
        #   self.base = self.bzrdir.root_transport.base
2296
2012
        # but this does not quite work yet -- mbp 20080522
2303
2019
        Branch.__init__(self)
2304
2020
 
2305
2021
    def __str__(self):
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)
 
2022
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
2023
 
2312
2024
    __repr__ = __str__
2313
2025
 
2324
2036
        return self.control_files.is_locked()
2325
2037
 
2326
2038
    def lock_write(self, token=None):
2327
 
        if not self.is_locked():
2328
 
            self._note_lock('w')
2329
2039
        # All-in-one needs to always unlock/lock.
2330
2040
        repo_control = getattr(self.repository, 'control_files', None)
2331
2041
        if self.control_files == repo_control or not self.is_locked():
2332
 
            self.repository._warn_if_deprecated(self)
2333
2042
            self.repository.lock_write()
2334
2043
            took_lock = True
2335
2044
        else:
2342
2051
            raise
2343
2052
 
2344
2053
    def lock_read(self):
2345
 
        if not self.is_locked():
2346
 
            self._note_lock('r')
2347
2054
        # All-in-one needs to always unlock/lock.
2348
2055
        repo_control = getattr(self.repository, 'control_files', None)
2349
2056
        if self.control_files == repo_control or not self.is_locked():
2350
 
            self.repository._warn_if_deprecated(self)
2351
2057
            self.repository.lock_read()
2352
2058
            took_lock = True
2353
2059
        else:
2359
2065
                self.repository.unlock()
2360
2066
            raise
2361
2067
 
2362
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
2068
    def unlock(self):
2364
2069
        try:
2365
2070
            self.control_files.unlock()
2528
2233
        return result
2529
2234
 
2530
2235
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2236
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2237
 
2533
2238
    def set_push_location(self, location):
2534
2239
        """See Branch.set_push_location."""
2667
2372
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2668
2373
        super(BzrBranch8, self).__init__(*args, **kwargs)
2669
2374
        self._last_revision_info_cache = None
 
2375
        self._partial_revision_history_cache = []
2670
2376
        self._reference_info = None
2671
2377
 
2672
2378
    def _clear_cached_state(self):
2673
2379
        super(BzrBranch8, self)._clear_cached_state()
2674
2380
        self._last_revision_info_cache = None
 
2381
        self._partial_revision_history_cache = []
2675
2382
        self._reference_info = None
2676
2383
 
2677
2384
    def _last_revision_info(self):
2724
2431
        if _mod_revision.is_null(last_revision):
2725
2432
            return
2726
2433
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2434
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2435
 
2729
2436
    def _gen_revision_history(self):
2730
2437
        """Generate the revision history from last revision
2733
2440
        self._extend_partial_history(stop_index=last_revno-1)
2734
2441
        return list(reversed(self._partial_revision_history_cache))
2735
2442
 
 
2443
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2444
        """Extend the partial history to include a given index
 
2445
 
 
2446
        If a stop_index is supplied, stop when that index has been reached.
 
2447
        If a stop_revision is supplied, stop when that revision is
 
2448
        encountered.  Otherwise, stop when the beginning of history is
 
2449
        reached.
 
2450
 
 
2451
        :param stop_index: The index which should be present.  When it is
 
2452
            present, history extension will stop.
 
2453
        :param revision_id: The revision id which should be present.  When
 
2454
            it is encountered, history extension will stop.
 
2455
        """
 
2456
        repo = self.repository
 
2457
        if len(self._partial_revision_history_cache) == 0:
 
2458
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2459
        else:
 
2460
            start_revision = self._partial_revision_history_cache[-1]
 
2461
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2462
            #skip the last revision in the list
 
2463
            next_revision = iterator.next()
 
2464
        for revision_id in iterator:
 
2465
            self._partial_revision_history_cache.append(revision_id)
 
2466
            if (stop_index is not None and
 
2467
                len(self._partial_revision_history_cache) > stop_index):
 
2468
                break
 
2469
            if revision_id == stop_revision:
 
2470
                break
 
2471
 
2736
2472
    def _write_revision_history(self, history):
2737
2473
        """Factored out of set_revision_history.
2738
2474
 
2830
2566
        if branch_location is None:
2831
2567
            return Branch.reference_parent(self, file_id, path,
2832
2568
                                           possible_transports)
2833
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2569
        branch_location = urlutils.join(self.base, branch_location)
2834
2570
        return Branch.open(branch_location,
2835
2571
                           possible_transports=possible_transports)
2836
2572
 
2881
2617
            raise errors.NotStacked(self)
2882
2618
        return stacked_url
2883
2619
 
 
2620
    def set_append_revisions_only(self, enabled):
 
2621
        if enabled:
 
2622
            value = 'True'
 
2623
        else:
 
2624
            value = 'False'
 
2625
        self.get_config().set_user_option('append_revisions_only', value,
 
2626
            warn_masked=True)
 
2627
 
2884
2628
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2629
        value = self.get_config().get_user_option('append_revisions_only')
 
2630
        return value == 'True'
2887
2631
 
2888
2632
    @needs_write_lock
2889
2633
    def generate_revision_history(self, revision_id, last_rev=None,
2951
2695
    """
2952
2696
 
2953
2697
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2698
        raise errors.UnstackableBranchFormat(self._format, self.base)
2955
2699
 
2956
2700
 
2957
2701
######################################################################
3036
2780
 
3037
2781
    def __init__(self, branch):
3038
2782
        self.branch = branch
3039
 
        self.errors = []
3040
2783
 
3041
2784
    def report_results(self, verbose):
3042
2785
        """Report the check results via trace.note.
3044
2787
        :param verbose: Requests more detailed display of what was checked,
3045
2788
            if any.
3046
2789
        """
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)
 
2790
        note('checked branch %s format %s',
 
2791
             self.branch.base,
 
2792
             self.branch._format)
3051
2793
 
3052
2794
 
3053
2795
class Converter5to6(object):
3148
2890
    @staticmethod
3149
2891
    def _get_branch_formats_to_test():
3150
2892
        """Return a tuple with the Branch formats to use when testing."""
3151
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
2893
        raise NotImplementedError(self._get_branch_formats_to_test)
3152
2894
 
3153
2895
    def pull(self, overwrite=False, stop_revision=None,
3154
2896
             possible_transports=None, local=False):
3309
3051
                _override_hook_source_branch=_override_hook_source_branch)
3310
3052
        finally:
3311
3053
            self.source.unlock()
 
3054
        return result
3312
3055
 
3313
3056
    def _push_with_bound_branches(self, overwrite, stop_revision,
3314
3057
            _override_hook_source_branch=None):
3379
3122
        if local and not bound_location:
3380
3123
            raise errors.LocalRequiresBoundBranch()
3381
3124
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3125
        if not local and bound_location and self.source.base != bound_location:
3383
3126
            # not pulling from master, so we need to update master.
3384
3127
            master_branch = self.target.get_master_branch(possible_transports)
3385
3128
            master_branch.lock_write()