← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Aaron Bentley
  • Date: 2009-05-11 19:11:14 UTC
  • mto: This revision was merged to the branch mainline in revision 4351.
  • Revision ID: aaron@aaronbentley.com-20090511191114-g0u190bdpfou9bbw
Gracefully handle mail clients that don't support bodies.

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()
100
101
    def _open_hook(self):
101
102
        """Called by init to allow simpler extension of the base class."""
102
103
 
103
 
    def _activate_fallback_location(self, url):
 
104
    def _activate_fallback_location(self, url, lock_style):
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)
 
107
        if lock_style == 'write':
 
108
            repo.lock_write()
 
109
        elif lock_style == 'read':
 
110
            repo.lock_read()
108
111
        self.repository.add_fallback_repository(repo)
109
112
 
110
113
    def break_lock(self):
126
129
            raise errors.UnstackableRepositoryFormat(self.repository._format,
127
130
                self.repository.base)
128
131
 
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
132
    @staticmethod
159
133
    def open(base, _unsupported=False, possible_transports=None):
160
134
        """Open the branch rooted at base.
164
138
        """
165
139
        control = bzrdir.BzrDir.open(base, _unsupported,
166
140
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
141
        return control.open_branch(_unsupported)
168
142
 
169
143
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
144
    def open_from_transport(transport, _unsupported=False):
171
145
        """Open the branch rooted at transport"""
172
146
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
147
        return control.open_branch(_unsupported)
174
148
 
175
149
    @staticmethod
176
150
    def open_containing(url, possible_transports=None):
214
188
    def _get_fallback_repository(self, url):
215
189
        """Get the repository we fallback to at url."""
216
190
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
191
        a_bzrdir = bzrdir.BzrDir.open(url,
218
192
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
193
        return a_bzrdir.open_branch().repository
220
194
 
221
195
    def _get_tags_bytes(self):
222
196
        """Get the bytes of a serialised tags dict.
417
391
            * 'include' - the stop revision is the last item in the result
418
392
            * 'with-merges' - include the stop revision and all of its
419
393
              merged revisions in the result
420
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
 
              that are in both ancestries
422
394
        :param direction: either 'reverse' or 'forward':
423
395
            * reverse means return the start_revision_id first, i.e.
424
396
              start at the most recent revision and go backwards in history
446
418
        # start_revision_id.
447
419
        if self._merge_sorted_revisions_cache is None:
448
420
            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)
 
421
            graph = self.repository.get_graph()
 
422
            parent_map = dict(((key, value) for key, value in
 
423
                     graph.iter_ancestry([last_revision]) if value is not None))
 
424
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
425
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
426
                generate_revno=True)
 
427
            # Drop the sequence # before caching
 
428
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
429
 
453
430
        filtered = self._filter_merge_sorted_revisions(
454
431
            self._merge_sorted_revisions_cache, start_revision_id,
455
432
            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
433
        if direction == 'reverse':
460
434
            return filtered
461
435
        if direction == 'forward':
468
442
        """Iterate over an inclusive range of sorted revisions."""
469
443
        rev_iter = iter(merge_sorted_revisions)
470
444
        if start_revision_id is not None:
471
 
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
445
            for rev_id, depth, revno, end_of_merge in rev_iter:
473
446
                if rev_id != start_revision_id:
474
447
                    continue
475
448
                else:
476
449
                    # The decision to include the start or not
477
450
                    # 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)
 
451
                    rev_iter = chain(
 
452
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
453
                        rev_iter)
480
454
                    break
481
455
        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)
 
456
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
457
                yield rev_id, depth, revno, end_of_merge
487
458
        elif stop_rule == 'exclude':
488
 
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
459
            for rev_id, depth, revno, end_of_merge in rev_iter:
490
460
                if rev_id == stop_revision_id:
491
461
                    return
492
 
                yield (rev_id, node.merge_depth, node.revno,
493
 
                       node.end_of_merge)
 
462
                yield rev_id, depth, revno, end_of_merge
494
463
        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)
 
464
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
465
                yield rev_id, depth, revno, end_of_merge
499
466
                if rev_id == stop_revision_id:
500
467
                    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
468
        elif stop_rule == 'with-merges':
514
469
            stop_rev = self.repository.get_revision(stop_revision_id)
515
470
            if stop_rev.parent_ids:
516
471
                left_parent = stop_rev.parent_ids[0]
517
472
            else:
518
473
                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]
 
474
            for rev_id, depth, revno, end_of_merge in rev_iter:
525
475
                if rev_id == left_parent:
526
 
                    # reached the left parent after the stop_revision
527
476
                    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)
 
477
                yield rev_id, depth, revno, end_of_merge
538
478
        else:
539
479
            raise ValueError('invalid stop_rule %r' % stop_rule)
540
480
 
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
481
    def leave_lock_in_place(self):
587
482
        """Tell this branch object not to release the physical lock when this
588
483
        object is unlocked.
605
500
        :param other: The branch to bind to
606
501
        :type other: Branch
607
502
        """
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)
 
503
        raise errors.UpgradeRequired(self.base)
619
504
 
620
505
    def set_reference_info(self, file_id, tree_path, branch_location):
621
506
        """Set the branch location to use for a tree reference."""
663
548
    def get_old_bound_location(self):
664
549
        """Return the URL of the branch we used to be bound to
665
550
        """
666
 
        raise errors.UpgradeRequired(self.user_url)
 
551
        raise errors.UpgradeRequired(self.base)
667
552
 
668
553
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
554
                           timezone=None, committer=None, revprops=None,
747
632
            stacking.
748
633
        """
749
634
        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.
 
635
            raise errors.UnstackableBranchFormat(self._format, self.base)
754
636
        self._check_stackable_repo()
755
637
        if not url:
756
638
            try:
758
640
            except (errors.NotStacked, errors.UnstackableBranchFormat,
759
641
                errors.UnstackableRepositoryFormat):
760
642
                return
761
 
            self._unstack()
 
643
            url = ''
 
644
            # XXX: Lock correctness - should unlock our old repo if we were
 
645
            # locked.
 
646
            # repositories don't offer an interface to remove fallback
 
647
            # repositories today; take the conceptually simpler option and just
 
648
            # reopen it.
 
649
            self.repository = self.bzrdir.find_repository()
 
650
            self.repository.lock_write()
 
651
            # for every revision reference the branch has, ensure it is pulled
 
652
            # in.
 
653
            source_repository = self._get_fallback_repository(old_url)
 
654
            for revision_id in chain([self.last_revision()],
 
655
                self.tags.get_reverse_tag_dict()):
 
656
                self.repository.fetch(source_repository, revision_id,
 
657
                    find_ghosts=True)
762
658
        else:
763
 
            self._activate_fallback_location(url)
 
659
            self._activate_fallback_location(url, 'write')
764
660
        # write this out after the repository is stacked to avoid setting a
765
661
        # stacked config that doesn't work.
766
662
        self._set_config_location('stacked_on_location', url)
767
663
 
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
664
 
823
665
    def _set_tags_bytes(self, bytes):
824
666
        """Mirror method for _get_tags_bytes.
860
702
        self._revision_id_to_revno_cache = None
861
703
        self._last_revision_info_cache = None
862
704
        self._merge_sorted_revisions_cache = None
863
 
        self._partial_revision_history_cache = []
864
 
        self._partial_revision_id_to_revno_cache = {}
865
705
 
866
706
    def _gen_revision_history(self):
867
707
        """Return sequence of revision hashes on to this branch.
904
744
 
905
745
    def unbind(self):
906
746
        """Older format branches cannot bind or unbind."""
907
 
        raise errors.UpgradeRequired(self.user_url)
 
747
        raise errors.UpgradeRequired(self.base)
 
748
 
 
749
    def set_append_revisions_only(self, enabled):
 
750
        """Older format branches are never restricted to append-only"""
 
751
        raise errors.UpgradeRequired(self.base)
908
752
 
909
753
    def last_revision(self):
910
754
        """Return last revision id, or NULL_REVISION."""
991
835
        except ValueError:
992
836
            raise errors.NoSuchRevision(self, revision_id)
993
837
 
994
 
    @needs_read_lock
995
838
    def get_rev_id(self, revno, history=None):
996
839
        """Find the revision id of the specified revno."""
997
840
        if revno == 0:
998
841
            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:
 
842
        if history is None:
 
843
            history = self.revision_history()
 
844
        if revno <= 0 or revno > len(history):
1003
845
            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]
 
846
        return history[revno - 1]
1008
847
 
1009
848
    @needs_write_lock
1010
849
    def pull(self, source, overwrite=False, stop_revision=None,
1028
867
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1029
868
            *args, **kwargs)
1030
869
 
1031
 
    def lossy_push(self, target, stop_revision=None):
1032
 
        """Push deltas into another branch.
1033
 
 
1034
 
        :note: This does not, like push, retain the revision ids from 
1035
 
            the source branch and will, rather than adding bzr-specific 
1036
 
            metadata, push only those semantics of the revision that can be 
1037
 
            natively represented by this branch' VCS.
1038
 
 
1039
 
        :param target: Target branch
1040
 
        :param stop_revision: Revision to push, defaults to last revision.
1041
 
        :return: BranchPushResult with an extra member revidmap: 
1042
 
            A dictionary mapping revision ids from the target branch 
1043
 
            to new revision ids in the target branch, for each 
1044
 
            revision that was pushed.
1045
 
        """
1046
 
        inter = InterBranch.get(self, target)
1047
 
        lossy_push = getattr(inter, "lossy_push", None)
1048
 
        if lossy_push is None:
1049
 
            raise errors.LossyPushToSameVCS(self, target)
1050
 
        return lossy_push(stop_revision)
1051
 
 
1052
870
    def basis_tree(self):
1053
871
        """Return `Tree` object for last revision."""
1054
872
        return self.repository.revision_tree(self.last_revision())
1070
888
        try:
1071
889
            return urlutils.join(self.base[:-1], parent)
1072
890
        except errors.InvalidURLJoin, e:
1073
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
891
            raise errors.InaccessibleParent(parent, self.base)
1074
892
 
1075
893
    def _get_parent_location(self):
1076
894
        raise NotImplementedError(self._get_parent_location)
1093
911
            location = None
1094
912
        return location
1095
913
 
1096
 
    def get_child_submit_format(self):
1097
 
        """Return the preferred format of submissions to this branch."""
1098
 
        return self.get_config().get_user_option("child_submit_format")
1099
 
 
1100
914
    def get_submit_branch(self):
1101
915
        """Return the submit location of the branch.
1102
916
 
1161
975
        params = ChangeBranchTipParams(
1162
976
            self, old_revno, new_revno, old_revid, new_revid)
1163
977
        for hook in hooks:
1164
 
            hook(params)
 
978
            try:
 
979
                hook(params)
 
980
            except errors.TipChangeRejected:
 
981
                raise
 
982
            except Exception:
 
983
                exc_info = sys.exc_info()
 
984
                hook_name = Branch.hooks.get_hook_name(hook)
 
985
                raise errors.HookFailed(
 
986
                    'pre_change_branch_tip', hook_name, exc_info)
1165
987
 
1166
988
    @needs_write_lock
1167
989
    def update(self):
1216
1038
        revision_id: if not None, the revision history in the new branch will
1217
1039
                     be truncated to end with revision_id.
1218
1040
        """
1219
 
        if (repository_policy is not None and
1220
 
            repository_policy.requires_stacking()):
1221
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
1041
        result = to_bzrdir.create_branch()
1223
1042
        result.lock_write()
1224
1043
        try:
1245
1064
        source_revno, source_revision_id = self.last_revision_info()
1246
1065
        if revision_id is None:
1247
1066
            revno, revision_id = source_revno, source_revision_id
 
1067
        elif source_revision_id == revision_id:
 
1068
            # we know the revno without needing to walk all of history
 
1069
            revno = source_revno
1248
1070
        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
 
1071
            # To figure out the revno for a random revision, we need to build
 
1072
            # the revision history, and count its length.
 
1073
            # We don't care about the order, just how long it is.
 
1074
            # Alternatively, we could start at the current location, and count
 
1075
            # backwards. But there is no guarantee that we will find it since
 
1076
            # it may be a merged revision.
 
1077
            revno = len(list(self.repository.iter_reverse_revision_history(
 
1078
                                                                revision_id)))
1256
1079
        destination.set_last_revision_info(revno, revision_id)
1257
1080
 
1258
1081
    @needs_read_lock
1292
1115
        target._set_all_reference_info(target_reference_dict)
1293
1116
 
1294
1117
    @needs_read_lock
1295
 
    def check(self, refs):
 
1118
    def check(self):
1296
1119
        """Check consistency of the branch.
1297
1120
 
1298
1121
        In particular this checks that revisions given in the revision-history
1301
1124
 
1302
1125
        Callers will typically also want to check the repository.
1303
1126
 
1304
 
        :param refs: Calculated refs for this branch as specified by
1305
 
            branch._get_check_refs()
1306
1127
        :return: A BranchCheckResult.
1307
1128
        """
1308
 
        result = BranchCheckResult(self)
 
1129
        mainline_parent_id = None
1309
1130
        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
 
1131
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
1132
                                last_revision_id))
 
1133
        real_rev_history.reverse()
 
1134
        if len(real_rev_history) != last_revno:
 
1135
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1136
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1137
        # TODO: We should probably also check that real_rev_history actually
 
1138
        #       matches self.revision_history()
 
1139
        for revision_id in real_rev_history:
 
1140
            try:
 
1141
                revision = self.repository.get_revision(revision_id)
 
1142
            except errors.NoSuchRevision, e:
 
1143
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1144
                            % revision_id)
 
1145
            # In general the first entry on the revision history has no parents.
 
1146
            # But it's not illegal for it to have parents listed; this can happen
 
1147
            # in imports from Arch when the parents weren't reachable.
 
1148
            if mainline_parent_id is not None:
 
1149
                if mainline_parent_id not in revision.parent_ids:
 
1150
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1151
                                        "parents of {%s}"
 
1152
                                        % (mainline_parent_id, revision_id))
 
1153
            mainline_parent_id = revision_id
 
1154
        return BranchCheckResult(self)
1321
1155
 
1322
1156
    def _get_checkout_format(self):
1323
1157
        """Return the most suitable metadir for a checkout of this branch.
1348
1182
        # clone call. Or something. 20090224 RBC/spiv.
1349
1183
        if revision_id is None:
1350
1184
            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)
 
1185
        try:
 
1186
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1187
                revision_id=revision_id, stacked_on=stacked_on,
 
1188
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1189
        except errors.FileExists:
 
1190
            if not use_existing_dir:
 
1191
                raise
 
1192
        except errors.NoSuchFile:
 
1193
            if not create_prefix:
 
1194
                raise
1354
1195
        return dir_to.open_branch()
1355
1196
 
1356
1197
    def create_checkout(self, to_location, revision_id=None,
1375
1216
        if lightweight:
1376
1217
            format = self._get_checkout_format()
1377
1218
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1219
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1220
        else:
1381
1221
            format = self._get_checkout_format()
1382
1222
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1424
1264
    def supports_tags(self):
1425
1265
        return self._format.supports_tags()
1426
1266
 
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
1267
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1268
                                         other_branch):
1441
1269
        """Ensure that revision_b is a descendant of revision_a.
1496
1324
    _formats = {}
1497
1325
    """The known formats."""
1498
1326
 
1499
 
    can_set_append_revisions_only = True
1500
 
 
1501
1327
    def __eq__(self, other):
1502
1328
        return self.__class__ is other.__class__
1503
1329
 
1505
1331
        return not (self == other)
1506
1332
 
1507
1333
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1334
    def find_format(klass, a_bzrdir):
1509
1335
        """Return the format for the branch object in a_bzrdir."""
1510
1336
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1337
            transport = a_bzrdir.get_branch_transport(None)
 
1338
            format_string = transport.get("format").read()
1513
1339
            return klass._formats[format_string]
1514
1340
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1341
            raise errors.NotBranchError(path=transport.base)
1516
1342
        except KeyError:
1517
1343
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1344
 
1554
1380
        """Return the short format description for this format."""
1555
1381
        raise NotImplementedError(self.get_format_description)
1556
1382
 
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):
 
1383
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1384
                           set_format=True):
1567
1385
        """Initialize a branch in a bzrdir, with specified files
1568
1386
 
1569
1387
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1388
        :param utf8_files: The files to create as a list of
1571
1389
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1390
        :param set_format: If True, set the format with
1574
1391
            self.get_format_string.  (BzrBranch4 has its format set
1575
1392
            elsewhere)
1576
1393
        :return: a branch in this format
1577
1394
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1395
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1396
        branch_transport = a_bzrdir.get_branch_transport(self)
1580
1397
        lock_map = {
1581
1398
            'metadir': ('lock', lockdir.LockDir),
1582
1399
            'branch4': ('branch-lock', lockable_files.TransportLock),
1603
1420
        finally:
1604
1421
            if lock_taken:
1605
1422
                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
 
1423
        return self.open(a_bzrdir, _found=True)
1609
1424
 
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
 
        """
 
1425
    def initialize(self, a_bzrdir):
 
1426
        """Create a branch of this format in a_bzrdir."""
1615
1427
        raise NotImplementedError(self.initialize)
1616
1428
 
1617
1429
    def is_supported(self):
1647
1459
        """
1648
1460
        raise NotImplementedError(self.network_name)
1649
1461
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1462
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1651
1463
        """Return the branch object for a_bzrdir
1652
1464
 
1653
1465
        :param a_bzrdir: A BzrDir that contains a branch.
1654
 
        :param name: Name of colocated branch to open
1655
1466
        :param _found: a private parameter, do not use it. It is used to
1656
1467
            indicate if format probing has already be done.
1657
1468
        :param ignore_fallbacks: when set, no fallback branches will be opened
1671
1482
    def set_default_format(klass, format):
1672
1483
        klass._default_format = format
1673
1484
 
1674
 
    def supports_set_append_revisions_only(self):
1675
 
        """True if this format supports set_append_revisions_only."""
1676
 
        return False
1677
 
 
1678
1485
    def supports_stacking(self):
1679
1486
        """True if this format records a stacked-on branch."""
1680
1487
        return False
1765
1572
            "multiple hooks installed for transform_fallback_location, "
1766
1573
            "all are called with the url returned from the previous hook."
1767
1574
            "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
1575
 
1786
1576
 
1787
1577
# install the default hooks into the Branch class.
1826
1616
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1617
 
1828
1618
 
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
1619
class BzrBranchFormat4(BranchFormat):
1908
1620
    """Bzr branch format 4.
1909
1621
 
1916
1628
        """See BranchFormat.get_format_description()."""
1917
1629
        return "Branch format 4"
1918
1630
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1631
    def initialize(self, a_bzrdir):
1920
1632
        """Create a branch of this format in a_bzrdir."""
1921
1633
        utf8_files = [('revision-history', ''),
1922
1634
                      ('branch-name', ''),
1923
1635
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1636
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1637
                                       lock_type='branch4', set_format=False)
1926
1638
 
1927
1639
    def __init__(self):
1932
1644
        """The network name for this format is the control dirs disk label."""
1933
1645
        return self._matchingbzrdir.get_format_string()
1934
1646
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1647
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1936
1648
        """See BranchFormat.open()."""
1937
1649
        if not _found:
1938
1650
            # we are being called directly and must probe.
1940
1652
        return BzrBranch(_format=self,
1941
1653
                         _control_files=a_bzrdir._control_files,
1942
1654
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1655
                         _repository=a_bzrdir.open_repository())
1945
1656
 
1946
1657
    def __str__(self):
1961
1672
        """
1962
1673
        return self.get_format_string()
1963
1674
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1675
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1965
1676
        """See BranchFormat.open()."""
1966
1677
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1678
            format = BranchFormat.find_format(a_bzrdir)
1968
1679
            if format.__class__ != self.__class__:
1969
1680
                raise AssertionError("wrong format %r found for %r" %
1970
1681
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1682
        try:
 
1683
            transport = a_bzrdir.get_branch_transport(None)
1973
1684
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1685
                                                         lockdir.LockDir)
1975
1686
            return self._branch_class()(_format=self,
1976
1687
                              _control_files=control_files,
1977
 
                              name=name,
1978
1688
                              a_bzrdir=a_bzrdir,
1979
1689
                              _repository=a_bzrdir.find_repository(),
1980
1690
                              ignore_fallbacks=ignore_fallbacks)
1981
1691
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1692
            raise errors.NotBranchError(path=transport.base)
1983
1693
 
1984
1694
    def __init__(self):
1985
1695
        super(BranchFormatMetadir, self).__init__()
2014
1724
        """See BranchFormat.get_format_description()."""
2015
1725
        return "Branch format 5"
2016
1726
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1727
    def initialize(self, a_bzrdir):
2018
1728
        """Create a branch of this format in a_bzrdir."""
2019
1729
        utf8_files = [('revision-history', ''),
2020
1730
                      ('branch-name', ''),
2021
1731
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1732
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1733
 
2024
1734
    def supports_tags(self):
2025
1735
        return False
2047
1757
        """See BranchFormat.get_format_description()."""
2048
1758
        return "Branch format 6"
2049
1759
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
1760
    def initialize(self, a_bzrdir):
2051
1761
        """Create a branch of this format in a_bzrdir."""
2052
1762
        utf8_files = [('last-revision', '0 null:\n'),
2053
1763
                      ('branch.conf', ''),
2054
1764
                      ('tags', ''),
2055
1765
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1766
        return self._initialize_helper(a_bzrdir, utf8_files)
2057
1767
 
2058
1768
    def make_tags(self, branch):
2059
1769
        """See bzrlib.branch.BranchFormat.make_tags()."""
2060
1770
        return BasicTags(branch)
2061
1771
 
2062
 
    def supports_set_append_revisions_only(self):
2063
 
        return True
2064
1772
 
2065
1773
 
2066
1774
class BzrBranchFormat8(BranchFormatMetadir):
2077
1785
        """See BranchFormat.get_format_description()."""
2078
1786
        return "Branch format 8"
2079
1787
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
1788
    def initialize(self, a_bzrdir):
2081
1789
        """Create a branch of this format in a_bzrdir."""
2082
1790
        utf8_files = [('last-revision', '0 null:\n'),
2083
1791
                      ('branch.conf', ''),
2084
1792
                      ('tags', ''),
2085
1793
                      ('references', '')
2086
1794
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1795
        return self._initialize_helper(a_bzrdir, utf8_files)
2088
1796
 
2089
1797
    def __init__(self):
2090
1798
        super(BzrBranchFormat8, self).__init__()
2095
1803
        """See bzrlib.branch.BranchFormat.make_tags()."""
2096
1804
        return BasicTags(branch)
2097
1805
 
2098
 
    def supports_set_append_revisions_only(self):
2099
 
        return True
2100
 
 
2101
1806
    def supports_stacking(self):
2102
1807
        return True
2103
1808
 
2113
1818
    This format was introduced in bzr 1.6.
2114
1819
    """
2115
1820
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
1821
    def initialize(self, a_bzrdir):
2117
1822
        """Create a branch of this format in a_bzrdir."""
2118
1823
        utf8_files = [('last-revision', '0 null:\n'),
2119
1824
                      ('branch.conf', ''),
2120
1825
                      ('tags', ''),
2121
1826
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1827
        return self._initialize_helper(a_bzrdir, utf8_files)
2123
1828
 
2124
1829
    def _branch_class(self):
2125
1830
        return BzrBranch7
2132
1837
        """See BranchFormat.get_format_description()."""
2133
1838
        return "Branch format 7"
2134
1839
 
2135
 
    def supports_set_append_revisions_only(self):
2136
 
        return True
2137
 
 
2138
1840
    supports_reference_locations = False
2139
1841
 
2140
1842
 
2160
1862
    def get_reference(self, a_bzrdir):
2161
1863
        """See BranchFormat.get_reference()."""
2162
1864
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1865
        return transport.get('location').read()
2164
1866
 
2165
1867
    def set_reference(self, a_bzrdir, to_branch):
2166
1868
        """See BranchFormat.set_reference()."""
2167
1869
        transport = a_bzrdir.get_branch_transport(None)
2168
1870
        location = transport.put_bytes('location', to_branch.base)
2169
1871
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1872
    def initialize(self, a_bzrdir, target_branch=None):
2171
1873
        """Create a branch of this format in a_bzrdir."""
2172
1874
        if target_branch is None:
2173
1875
            # this format does not implement branch itself, thus the implicit
2174
1876
            # creation contract must see it as uninitializable
2175
1877
            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)
 
1878
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1879
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1880
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1881
            target_branch.bzrdir.root_transport.base)
2180
1882
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
1883
        return self.open(
 
1884
            a_bzrdir, _found=True,
2183
1885
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
1886
 
2187
1887
    def __init__(self):
2188
1888
        super(BranchReferenceFormat, self).__init__()
2194
1894
        def clone(to_bzrdir, revision_id=None,
2195
1895
            repository_policy=None):
2196
1896
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1897
            return format.initialize(to_bzrdir, a_branch)
2198
1898
            # cannot obey revision_id limits when cloning a reference ...
2199
1899
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
1900
            # emit some sort of warning/error to the caller ?!
2201
1901
        return clone
2202
1902
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1903
    def open(self, a_bzrdir, _found=False, location=None,
2204
1904
             possible_transports=None, ignore_fallbacks=False):
2205
1905
        """Return the branch that the branch reference in a_bzrdir points at.
2206
1906
 
2207
1907
        :param a_bzrdir: A BzrDir that contains a branch.
2208
 
        :param name: Name of colocated branch to open, if any
2209
1908
        :param _found: a private parameter, do not use it. It is used to
2210
1909
            indicate if format probing has already be done.
2211
1910
        :param ignore_fallbacks: when set, no fallback branches will be opened
2216
1915
        :param possible_transports: An optional reusable transports list.
2217
1916
        """
2218
1917
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1918
            format = BranchFormat.find_format(a_bzrdir)
2220
1919
            if format.__class__ != self.__class__:
2221
1920
                raise AssertionError("wrong format %r found for %r" %
2222
1921
                    (format, self))
2224
1923
            location = self.get_reference(a_bzrdir)
2225
1924
        real_bzrdir = bzrdir.BzrDir.open(
2226
1925
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
1926
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2229
1927
        # this changes the behaviour of result.clone to create a new reference
2230
1928
        # rather than a copy of the content of the branch.
2231
1929
        # I did not use a proxy object because that needs much more extensive
2258
1956
BranchFormat.register_format(__format6)
2259
1957
BranchFormat.register_format(__format7)
2260
1958
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
 
1959
BranchFormat.set_default_format(__format6)
2262
1960
_legacy_formats = [BzrBranchFormat4(),
2263
1961
    ]
2264
1962
network_format_registry.register(
2265
1963
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
1964
 
2267
1965
 
2268
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1966
class BzrBranch(Branch):
2269
1967
    """A branch stored in the actual filesystem.
2270
1968
 
2271
1969
    Note that it's "local" in the context of the filesystem; it doesn't
2277
1975
    :ivar repository: Repository for this branch.
2278
1976
    :ivar base: The url of the base directory for this branch; the one
2279
1977
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
1978
    """
2283
1979
 
2284
1980
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
1981
                 _control_files=None, a_bzrdir=None, _repository=None,
 
1982
                 ignore_fallbacks=False):
2287
1983
        """Create new branch object at a particular location."""
2288
1984
        if a_bzrdir is None:
2289
1985
            raise ValueError('a_bzrdir must be supplied')
2290
1986
        else:
2291
1987
            self.bzrdir = a_bzrdir
2292
1988
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
1989
        # XXX: We should be able to just do
2295
1990
        #   self.base = self.bzrdir.root_transport.base
2296
1991
        # but this does not quite work yet -- mbp 20080522
2303
1998
        Branch.__init__(self)
2304
1999
 
2305
2000
    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)
 
2001
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
2002
 
2312
2003
    __repr__ = __str__
2313
2004
 
2324
2015
        return self.control_files.is_locked()
2325
2016
 
2326
2017
    def lock_write(self, token=None):
2327
 
        if not self.is_locked():
2328
 
            self._note_lock('w')
2329
2018
        # All-in-one needs to always unlock/lock.
2330
2019
        repo_control = getattr(self.repository, 'control_files', None)
2331
2020
        if self.control_files == repo_control or not self.is_locked():
2332
 
            self.repository._warn_if_deprecated(self)
2333
2021
            self.repository.lock_write()
2334
2022
            took_lock = True
2335
2023
        else:
2342
2030
            raise
2343
2031
 
2344
2032
    def lock_read(self):
2345
 
        if not self.is_locked():
2346
 
            self._note_lock('r')
2347
2033
        # All-in-one needs to always unlock/lock.
2348
2034
        repo_control = getattr(self.repository, 'control_files', None)
2349
2035
        if self.control_files == repo_control or not self.is_locked():
2350
 
            self.repository._warn_if_deprecated(self)
2351
2036
            self.repository.lock_read()
2352
2037
            took_lock = True
2353
2038
        else:
2359
2044
                self.repository.unlock()
2360
2045
            raise
2361
2046
 
2362
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
2047
    def unlock(self):
2364
2048
        try:
2365
2049
            self.control_files.unlock()
2528
2212
        return result
2529
2213
 
2530
2214
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2215
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2216
 
2533
2217
    def set_push_location(self, location):
2534
2218
        """See Branch.set_push_location."""
2661
2345
                    raise AssertionError(
2662
2346
                        "'transform_fallback_location' hook %s returned "
2663
2347
                        "None, not a URL." % hook_name)
2664
 
            self._activate_fallback_location(url)
 
2348
            self._activate_fallback_location(url, None)
2665
2349
 
2666
2350
    def __init__(self, *args, **kwargs):
2667
2351
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2668
2352
        super(BzrBranch8, self).__init__(*args, **kwargs)
2669
2353
        self._last_revision_info_cache = None
 
2354
        self._partial_revision_history_cache = []
2670
2355
        self._reference_info = None
2671
2356
 
2672
2357
    def _clear_cached_state(self):
2673
2358
        super(BzrBranch8, self)._clear_cached_state()
2674
2359
        self._last_revision_info_cache = None
 
2360
        self._partial_revision_history_cache = []
2675
2361
        self._reference_info = None
2676
2362
 
2677
2363
    def _last_revision_info(self):
2724
2410
        if _mod_revision.is_null(last_revision):
2725
2411
            return
2726
2412
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2413
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2414
 
2729
2415
    def _gen_revision_history(self):
2730
2416
        """Generate the revision history from last revision
2733
2419
        self._extend_partial_history(stop_index=last_revno-1)
2734
2420
        return list(reversed(self._partial_revision_history_cache))
2735
2421
 
 
2422
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2423
        """Extend the partial history to include a given index
 
2424
 
 
2425
        If a stop_index is supplied, stop when that index has been reached.
 
2426
        If a stop_revision is supplied, stop when that revision is
 
2427
        encountered.  Otherwise, stop when the beginning of history is
 
2428
        reached.
 
2429
 
 
2430
        :param stop_index: The index which should be present.  When it is
 
2431
            present, history extension will stop.
 
2432
        :param revision_id: The revision id which should be present.  When
 
2433
            it is encountered, history extension will stop.
 
2434
        """
 
2435
        repo = self.repository
 
2436
        if len(self._partial_revision_history_cache) == 0:
 
2437
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2438
        else:
 
2439
            start_revision = self._partial_revision_history_cache[-1]
 
2440
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2441
            #skip the last revision in the list
 
2442
            next_revision = iterator.next()
 
2443
        for revision_id in iterator:
 
2444
            self._partial_revision_history_cache.append(revision_id)
 
2445
            if (stop_index is not None and
 
2446
                len(self._partial_revision_history_cache) > stop_index):
 
2447
                break
 
2448
            if revision_id == stop_revision:
 
2449
                break
 
2450
 
2736
2451
    def _write_revision_history(self, history):
2737
2452
        """Factored out of set_revision_history.
2738
2453
 
2830
2545
        if branch_location is None:
2831
2546
            return Branch.reference_parent(self, file_id, path,
2832
2547
                                           possible_transports)
2833
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2548
        branch_location = urlutils.join(self.base, branch_location)
2834
2549
        return Branch.open(branch_location,
2835
2550
                           possible_transports=possible_transports)
2836
2551
 
2881
2596
            raise errors.NotStacked(self)
2882
2597
        return stacked_url
2883
2598
 
 
2599
    def set_append_revisions_only(self, enabled):
 
2600
        if enabled:
 
2601
            value = 'True'
 
2602
        else:
 
2603
            value = 'False'
 
2604
        self.get_config().set_user_option('append_revisions_only', value,
 
2605
            warn_masked=True)
 
2606
 
2884
2607
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2608
        value = self.get_config().get_user_option('append_revisions_only')
 
2609
        return value == 'True'
2887
2610
 
2888
2611
    @needs_write_lock
2889
2612
    def generate_revision_history(self, revision_id, last_rev=None,
2951
2674
    """
2952
2675
 
2953
2676
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2677
        raise errors.UnstackableBranchFormat(self._format, self.base)
2955
2678
 
2956
2679
 
2957
2680
######################################################################
3036
2759
 
3037
2760
    def __init__(self, branch):
3038
2761
        self.branch = branch
3039
 
        self.errors = []
3040
2762
 
3041
2763
    def report_results(self, verbose):
3042
2764
        """Report the check results via trace.note.
3044
2766
        :param verbose: Requests more detailed display of what was checked,
3045
2767
            if any.
3046
2768
        """
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)
 
2769
        note('checked branch %s format %s',
 
2770
             self.branch.base,
 
2771
             self.branch._format)
3051
2772
 
3052
2773
 
3053
2774
class Converter5to6(object):
3148
2869
    @staticmethod
3149
2870
    def _get_branch_formats_to_test():
3150
2871
        """Return a tuple with the Branch formats to use when testing."""
3151
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
2872
        raise NotImplementedError(self._get_branch_formats_to_test)
3152
2873
 
3153
2874
    def pull(self, overwrite=False, stop_revision=None,
3154
2875
             possible_transports=None, local=False):
3309
3030
                _override_hook_source_branch=_override_hook_source_branch)
3310
3031
        finally:
3311
3032
            self.source.unlock()
 
3033
        return result
3312
3034
 
3313
3035
    def _push_with_bound_branches(self, overwrite, stop_revision,
3314
3036
            _override_hook_source_branch=None):
3379
3101
        if local and not bound_location:
3380
3102
            raise errors.LocalRequiresBoundBranch()
3381
3103
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3104
        if not local and bound_location and self.source.base != bound_location:
3383
3105
            # not pulling from master, so we need to update master.
3384
3106
            master_branch = self.target.get_master_branch(possible_transports)
3385
3107
            master_branch.lock_write()