← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: John Arbash Meinel
  • Date: 2009-06-05 01:48:32 UTC
  • mto: This revision was merged to the branch mainline in revision 4410.
  • Revision ID: john@arbash-meinel.com-20090605014832-vxltjd08943mylqd
Fix the GPL header

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:
1292
1132
        target._set_all_reference_info(target_reference_dict)
1293
1133
 
1294
1134
    @needs_read_lock
1295
 
    def check(self, refs):
 
1135
    def check(self):
1296
1136
        """Check consistency of the branch.
1297
1137
 
1298
1138
        In particular this checks that revisions given in the revision-history
1301
1141
 
1302
1142
        Callers will typically also want to check the repository.
1303
1143
 
1304
 
        :param refs: Calculated refs for this branch as specified by
1305
 
            branch._get_check_refs()
1306
1144
        :return: A BranchCheckResult.
1307
1145
        """
1308
 
        result = BranchCheckResult(self)
 
1146
        ret = BranchCheckResult(self)
 
1147
        mainline_parent_id = None
1309
1148
        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
 
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
1321
1180
 
1322
1181
    def _get_checkout_format(self):
1323
1182
        """Return the most suitable metadir for a checkout of this branch.
1348
1207
        # clone call. Or something. 20090224 RBC/spiv.
1349
1208
        if revision_id is None:
1350
1209
            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)
 
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
1354
1220
        return dir_to.open_branch()
1355
1221
 
1356
1222
    def create_checkout(self, to_location, revision_id=None,
1375
1241
        if lightweight:
1376
1242
            format = self._get_checkout_format()
1377
1243
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1244
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1245
        else:
1381
1246
            format = self._get_checkout_format()
1382
1247
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1424
1289
    def supports_tags(self):
1425
1290
        return self._format.supports_tags()
1426
1291
 
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
1292
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1293
                                         other_branch):
1441
1294
        """Ensure that revision_b is a descendant of revision_a.
1496
1349
    _formats = {}
1497
1350
    """The known formats."""
1498
1351
 
1499
 
    can_set_append_revisions_only = True
1500
 
 
1501
1352
    def __eq__(self, other):
1502
1353
        return self.__class__ is other.__class__
1503
1354
 
1505
1356
        return not (self == other)
1506
1357
 
1507
1358
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1359
    def find_format(klass, a_bzrdir):
1509
1360
        """Return the format for the branch object in a_bzrdir."""
1510
1361
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1362
            transport = a_bzrdir.get_branch_transport(None)
 
1363
            format_string = transport.get("format").read()
1513
1364
            return klass._formats[format_string]
1514
1365
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1366
            raise errors.NotBranchError(path=transport.base)
1516
1367
        except KeyError:
1517
1368
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1369
 
1554
1405
        """Return the short format description for this format."""
1555
1406
        raise NotImplementedError(self.get_format_description)
1556
1407
 
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):
 
1408
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1409
                           set_format=True):
1567
1410
        """Initialize a branch in a bzrdir, with specified files
1568
1411
 
1569
1412
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1413
        :param utf8_files: The files to create as a list of
1571
1414
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1415
        :param set_format: If True, set the format with
1574
1416
            self.get_format_string.  (BzrBranch4 has its format set
1575
1417
            elsewhere)
1576
1418
        :return: a branch in this format
1577
1419
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1420
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1421
        branch_transport = a_bzrdir.get_branch_transport(self)
1580
1422
        lock_map = {
1581
1423
            'metadir': ('lock', lockdir.LockDir),
1582
1424
            'branch4': ('branch-lock', lockable_files.TransportLock),
1603
1445
        finally:
1604
1446
            if lock_taken:
1605
1447
                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
 
1448
        return self.open(a_bzrdir, _found=True)
1609
1449
 
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
 
        """
 
1450
    def initialize(self, a_bzrdir):
 
1451
        """Create a branch of this format in a_bzrdir."""
1615
1452
        raise NotImplementedError(self.initialize)
1616
1453
 
1617
1454
    def is_supported(self):
1647
1484
        """
1648
1485
        raise NotImplementedError(self.network_name)
1649
1486
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1487
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1651
1488
        """Return the branch object for a_bzrdir
1652
1489
 
1653
1490
        :param a_bzrdir: A BzrDir that contains a branch.
1654
 
        :param name: Name of colocated branch to open
1655
1491
        :param _found: a private parameter, do not use it. It is used to
1656
1492
            indicate if format probing has already be done.
1657
1493
        :param ignore_fallbacks: when set, no fallback branches will be opened
1671
1507
    def set_default_format(klass, format):
1672
1508
        klass._default_format = format
1673
1509
 
1674
 
    def supports_set_append_revisions_only(self):
1675
 
        """True if this format supports set_append_revisions_only."""
1676
 
        return False
1677
 
 
1678
1510
    def supports_stacking(self):
1679
1511
        """True if this format records a stacked-on branch."""
1680
1512
        return False
1765
1597
            "multiple hooks installed for transform_fallback_location, "
1766
1598
            "all are called with the url returned from the previous hook."
1767
1599
            "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
1600
 
1786
1601
 
1787
1602
# install the default hooks into the Branch class.
1826
1641
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1642
 
1828
1643
 
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
1644
class BzrBranchFormat4(BranchFormat):
1908
1645
    """Bzr branch format 4.
1909
1646
 
1916
1653
        """See BranchFormat.get_format_description()."""
1917
1654
        return "Branch format 4"
1918
1655
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1656
    def initialize(self, a_bzrdir):
1920
1657
        """Create a branch of this format in a_bzrdir."""
1921
1658
        utf8_files = [('revision-history', ''),
1922
1659
                      ('branch-name', ''),
1923
1660
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1661
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1662
                                       lock_type='branch4', set_format=False)
1926
1663
 
1927
1664
    def __init__(self):
1932
1669
        """The network name for this format is the control dirs disk label."""
1933
1670
        return self._matchingbzrdir.get_format_string()
1934
1671
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1672
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1936
1673
        """See BranchFormat.open()."""
1937
1674
        if not _found:
1938
1675
            # we are being called directly and must probe.
1940
1677
        return BzrBranch(_format=self,
1941
1678
                         _control_files=a_bzrdir._control_files,
1942
1679
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1680
                         _repository=a_bzrdir.open_repository())
1945
1681
 
1946
1682
    def __str__(self):
1961
1697
        """
1962
1698
        return self.get_format_string()
1963
1699
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1700
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1965
1701
        """See BranchFormat.open()."""
1966
1702
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1703
            format = BranchFormat.find_format(a_bzrdir)
1968
1704
            if format.__class__ != self.__class__:
1969
1705
                raise AssertionError("wrong format %r found for %r" %
1970
1706
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1707
        try:
 
1708
            transport = a_bzrdir.get_branch_transport(None)
1973
1709
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1710
                                                         lockdir.LockDir)
1975
1711
            return self._branch_class()(_format=self,
1976
1712
                              _control_files=control_files,
1977
 
                              name=name,
1978
1713
                              a_bzrdir=a_bzrdir,
1979
1714
                              _repository=a_bzrdir.find_repository(),
1980
1715
                              ignore_fallbacks=ignore_fallbacks)
1981
1716
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1717
            raise errors.NotBranchError(path=transport.base)
1983
1718
 
1984
1719
    def __init__(self):
1985
1720
        super(BranchFormatMetadir, self).__init__()
2014
1749
        """See BranchFormat.get_format_description()."""
2015
1750
        return "Branch format 5"
2016
1751
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1752
    def initialize(self, a_bzrdir):
2018
1753
        """Create a branch of this format in a_bzrdir."""
2019
1754
        utf8_files = [('revision-history', ''),
2020
1755
                      ('branch-name', ''),
2021
1756
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1757
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1758
 
2024
1759
    def supports_tags(self):
2025
1760
        return False
2047
1782
        """See BranchFormat.get_format_description()."""
2048
1783
        return "Branch format 6"
2049
1784
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
1785
    def initialize(self, a_bzrdir):
2051
1786
        """Create a branch of this format in a_bzrdir."""
2052
1787
        utf8_files = [('last-revision', '0 null:\n'),
2053
1788
                      ('branch.conf', ''),
2054
1789
                      ('tags', ''),
2055
1790
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1791
        return self._initialize_helper(a_bzrdir, utf8_files)
2057
1792
 
2058
1793
    def make_tags(self, branch):
2059
1794
        """See bzrlib.branch.BranchFormat.make_tags()."""
2060
1795
        return BasicTags(branch)
2061
1796
 
2062
 
    def supports_set_append_revisions_only(self):
2063
 
        return True
2064
1797
 
2065
1798
 
2066
1799
class BzrBranchFormat8(BranchFormatMetadir):
2077
1810
        """See BranchFormat.get_format_description()."""
2078
1811
        return "Branch format 8"
2079
1812
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
1813
    def initialize(self, a_bzrdir):
2081
1814
        """Create a branch of this format in a_bzrdir."""
2082
1815
        utf8_files = [('last-revision', '0 null:\n'),
2083
1816
                      ('branch.conf', ''),
2084
1817
                      ('tags', ''),
2085
1818
                      ('references', '')
2086
1819
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1820
        return self._initialize_helper(a_bzrdir, utf8_files)
2088
1821
 
2089
1822
    def __init__(self):
2090
1823
        super(BzrBranchFormat8, self).__init__()
2095
1828
        """See bzrlib.branch.BranchFormat.make_tags()."""
2096
1829
        return BasicTags(branch)
2097
1830
 
2098
 
    def supports_set_append_revisions_only(self):
2099
 
        return True
2100
 
 
2101
1831
    def supports_stacking(self):
2102
1832
        return True
2103
1833
 
2113
1843
    This format was introduced in bzr 1.6.
2114
1844
    """
2115
1845
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
1846
    def initialize(self, a_bzrdir):
2117
1847
        """Create a branch of this format in a_bzrdir."""
2118
1848
        utf8_files = [('last-revision', '0 null:\n'),
2119
1849
                      ('branch.conf', ''),
2120
1850
                      ('tags', ''),
2121
1851
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1852
        return self._initialize_helper(a_bzrdir, utf8_files)
2123
1853
 
2124
1854
    def _branch_class(self):
2125
1855
        return BzrBranch7
2132
1862
        """See BranchFormat.get_format_description()."""
2133
1863
        return "Branch format 7"
2134
1864
 
2135
 
    def supports_set_append_revisions_only(self):
2136
 
        return True
2137
 
 
2138
1865
    supports_reference_locations = False
2139
1866
 
2140
1867
 
2160
1887
    def get_reference(self, a_bzrdir):
2161
1888
        """See BranchFormat.get_reference()."""
2162
1889
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1890
        return transport.get('location').read()
2164
1891
 
2165
1892
    def set_reference(self, a_bzrdir, to_branch):
2166
1893
        """See BranchFormat.set_reference()."""
2167
1894
        transport = a_bzrdir.get_branch_transport(None)
2168
1895
        location = transport.put_bytes('location', to_branch.base)
2169
1896
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1897
    def initialize(self, a_bzrdir, target_branch=None):
2171
1898
        """Create a branch of this format in a_bzrdir."""
2172
1899
        if target_branch is None:
2173
1900
            # this format does not implement branch itself, thus the implicit
2174
1901
            # creation contract must see it as uninitializable
2175
1902
            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)
 
1903
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1904
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1905
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1906
            target_branch.bzrdir.root_transport.base)
2180
1907
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
1908
        return self.open(
 
1909
            a_bzrdir, _found=True,
2183
1910
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
1911
 
2187
1912
    def __init__(self):
2188
1913
        super(BranchReferenceFormat, self).__init__()
2194
1919
        def clone(to_bzrdir, revision_id=None,
2195
1920
            repository_policy=None):
2196
1921
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1922
            return format.initialize(to_bzrdir, a_branch)
2198
1923
            # cannot obey revision_id limits when cloning a reference ...
2199
1924
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
1925
            # emit some sort of warning/error to the caller ?!
2201
1926
        return clone
2202
1927
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1928
    def open(self, a_bzrdir, _found=False, location=None,
2204
1929
             possible_transports=None, ignore_fallbacks=False):
2205
1930
        """Return the branch that the branch reference in a_bzrdir points at.
2206
1931
 
2207
1932
        :param a_bzrdir: A BzrDir that contains a branch.
2208
 
        :param name: Name of colocated branch to open, if any
2209
1933
        :param _found: a private parameter, do not use it. It is used to
2210
1934
            indicate if format probing has already be done.
2211
1935
        :param ignore_fallbacks: when set, no fallback branches will be opened
2216
1940
        :param possible_transports: An optional reusable transports list.
2217
1941
        """
2218
1942
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1943
            format = BranchFormat.find_format(a_bzrdir)
2220
1944
            if format.__class__ != self.__class__:
2221
1945
                raise AssertionError("wrong format %r found for %r" %
2222
1946
                    (format, self))
2224
1948
            location = self.get_reference(a_bzrdir)
2225
1949
        real_bzrdir = bzrdir.BzrDir.open(
2226
1950
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
1951
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2229
1952
        # this changes the behaviour of result.clone to create a new reference
2230
1953
        # rather than a copy of the content of the branch.
2231
1954
        # I did not use a proxy object because that needs much more extensive
2258
1981
BranchFormat.register_format(__format6)
2259
1982
BranchFormat.register_format(__format7)
2260
1983
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
 
1984
BranchFormat.set_default_format(__format6)
2262
1985
_legacy_formats = [BzrBranchFormat4(),
2263
1986
    ]
2264
1987
network_format_registry.register(
2265
1988
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
1989
 
2267
1990
 
2268
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1991
class BzrBranch(Branch):
2269
1992
    """A branch stored in the actual filesystem.
2270
1993
 
2271
1994
    Note that it's "local" in the context of the filesystem; it doesn't
2277
2000
    :ivar repository: Repository for this branch.
2278
2001
    :ivar base: The url of the base directory for this branch; the one
2279
2002
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
2003
    """
2283
2004
 
2284
2005
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
2006
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2007
                 ignore_fallbacks=False):
2287
2008
        """Create new branch object at a particular location."""
2288
2009
        if a_bzrdir is None:
2289
2010
            raise ValueError('a_bzrdir must be supplied')
2290
2011
        else:
2291
2012
            self.bzrdir = a_bzrdir
2292
2013
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
2014
        # XXX: We should be able to just do
2295
2015
        #   self.base = self.bzrdir.root_transport.base
2296
2016
        # but this does not quite work yet -- mbp 20080522
2303
2023
        Branch.__init__(self)
2304
2024
 
2305
2025
    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)
 
2026
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
2027
 
2312
2028
    __repr__ = __str__
2313
2029
 
2324
2040
        return self.control_files.is_locked()
2325
2041
 
2326
2042
    def lock_write(self, token=None):
2327
 
        if not self.is_locked():
2328
 
            self._note_lock('w')
2329
2043
        # All-in-one needs to always unlock/lock.
2330
2044
        repo_control = getattr(self.repository, 'control_files', None)
2331
2045
        if self.control_files == repo_control or not self.is_locked():
2332
 
            self.repository._warn_if_deprecated(self)
2333
2046
            self.repository.lock_write()
2334
2047
            took_lock = True
2335
2048
        else:
2342
2055
            raise
2343
2056
 
2344
2057
    def lock_read(self):
2345
 
        if not self.is_locked():
2346
 
            self._note_lock('r')
2347
2058
        # All-in-one needs to always unlock/lock.
2348
2059
        repo_control = getattr(self.repository, 'control_files', None)
2349
2060
        if self.control_files == repo_control or not self.is_locked():
2350
 
            self.repository._warn_if_deprecated(self)
2351
2061
            self.repository.lock_read()
2352
2062
            took_lock = True
2353
2063
        else:
2359
2069
                self.repository.unlock()
2360
2070
            raise
2361
2071
 
2362
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
2072
    def unlock(self):
2364
2073
        try:
2365
2074
            self.control_files.unlock()
2528
2237
        return result
2529
2238
 
2530
2239
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2240
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2241
 
2533
2242
    def set_push_location(self, location):
2534
2243
        """See Branch.set_push_location."""
2667
2376
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2668
2377
        super(BzrBranch8, self).__init__(*args, **kwargs)
2669
2378
        self._last_revision_info_cache = None
 
2379
        self._partial_revision_history_cache = []
2670
2380
        self._reference_info = None
2671
2381
 
2672
2382
    def _clear_cached_state(self):
2673
2383
        super(BzrBranch8, self)._clear_cached_state()
2674
2384
        self._last_revision_info_cache = None
 
2385
        self._partial_revision_history_cache = []
2675
2386
        self._reference_info = None
2676
2387
 
2677
2388
    def _last_revision_info(self):
2724
2435
        if _mod_revision.is_null(last_revision):
2725
2436
            return
2726
2437
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2438
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2439
 
2729
2440
    def _gen_revision_history(self):
2730
2441
        """Generate the revision history from last revision
2733
2444
        self._extend_partial_history(stop_index=last_revno-1)
2734
2445
        return list(reversed(self._partial_revision_history_cache))
2735
2446
 
 
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
 
2736
2476
    def _write_revision_history(self, history):
2737
2477
        """Factored out of set_revision_history.
2738
2478
 
2830
2570
        if branch_location is None:
2831
2571
            return Branch.reference_parent(self, file_id, path,
2832
2572
                                           possible_transports)
2833
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2573
        branch_location = urlutils.join(self.base, branch_location)
2834
2574
        return Branch.open(branch_location,
2835
2575
                           possible_transports=possible_transports)
2836
2576
 
2881
2621
            raise errors.NotStacked(self)
2882
2622
        return stacked_url
2883
2623
 
 
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
 
2884
2632
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2633
        value = self.get_config().get_user_option('append_revisions_only')
 
2634
        return value == 'True'
2887
2635
 
2888
2636
    @needs_write_lock
2889
2637
    def generate_revision_history(self, revision_id, last_rev=None,
2951
2699
    """
2952
2700
 
2953
2701
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2702
        raise errors.UnstackableBranchFormat(self._format, self.base)
2955
2703
 
2956
2704
 
2957
2705
######################################################################
3036
2784
 
3037
2785
    def __init__(self, branch):
3038
2786
        self.branch = branch
3039
 
        self.errors = []
 
2787
        self.ghosts_in_mainline = False
3040
2788
 
3041
2789
    def report_results(self, verbose):
3042
2790
        """Report the check results via trace.note.
3044
2792
        :param verbose: Requests more detailed display of what was checked,
3045
2793
            if any.
3046
2794
        """
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)
 
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')
3051
2800
 
3052
2801
 
3053
2802
class Converter5to6(object):
3148
2897
    @staticmethod
3149
2898
    def _get_branch_formats_to_test():
3150
2899
        """Return a tuple with the Branch formats to use when testing."""
3151
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
2900
        raise NotImplementedError(self._get_branch_formats_to_test)
3152
2901
 
3153
2902
    def pull(self, overwrite=False, stop_revision=None,
3154
2903
             possible_transports=None, local=False):
3309
3058
                _override_hook_source_branch=_override_hook_source_branch)
3310
3059
        finally:
3311
3060
            self.source.unlock()
 
3061
        return result
3312
3062
 
3313
3063
    def _push_with_bound_branches(self, overwrite, stop_revision,
3314
3064
            _override_hook_source_branch=None):
3379
3129
        if local and not bound_location:
3380
3130
            raise errors.LocalRequiresBoundBranch()
3381
3131
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3132
        if not local and bound_location and self.source.base != bound_location:
3383
3133
            # not pulling from master, so we need to update master.
3384
3134
            master_branch = self.target.get_master_branch(possible_transports)
3385
3135
            master_branch.lock_write()