/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Johan Walles
  • Date: 2009-05-06 05:36:28 UTC
  • mfrom: (4332 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4343.
  • Revision ID: johan.walles@gmail.com-20090506053628-tbf1wz4a0m9t684g
Merge from upstream.

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
 
    @needs_write_lock
1010
848
    def pull(self, source, overwrite=False, stop_revision=None,
1011
 
             possible_transports=None, *args, **kwargs):
 
849
             possible_transports=None, _override_hook_target=None):
1012
850
        """Mirror source into this branch.
1013
851
 
1014
852
        This branch is considered to be 'local', having low latency.
1015
853
 
1016
854
        :returns: PullResult instance
1017
855
        """
1018
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1019
 
            stop_revision=stop_revision,
1020
 
            possible_transports=possible_transports, *args, **kwargs)
 
856
        raise NotImplementedError(self.pull)
1021
857
 
1022
858
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
859
        **kwargs):
1028
864
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1029
865
            *args, **kwargs)
1030
866
 
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
867
    def basis_tree(self):
1053
868
        """Return `Tree` object for last revision."""
1054
869
        return self.repository.revision_tree(self.last_revision())
1070
885
        try:
1071
886
            return urlutils.join(self.base[:-1], parent)
1072
887
        except errors.InvalidURLJoin, e:
1073
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
888
            raise errors.InaccessibleParent(parent, self.base)
1074
889
 
1075
890
    def _get_parent_location(self):
1076
891
        raise NotImplementedError(self._get_parent_location)
1093
908
            location = None
1094
909
        return location
1095
910
 
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
911
    def get_submit_branch(self):
1101
912
        """Return the submit location of the branch.
1102
913
 
1161
972
        params = ChangeBranchTipParams(
1162
973
            self, old_revno, new_revno, old_revid, new_revid)
1163
974
        for hook in hooks:
1164
 
            hook(params)
 
975
            try:
 
976
                hook(params)
 
977
            except errors.TipChangeRejected:
 
978
                raise
 
979
            except Exception:
 
980
                exc_info = sys.exc_info()
 
981
                hook_name = Branch.hooks.get_hook_name(hook)
 
982
                raise errors.HookFailed(
 
983
                    'pre_change_branch_tip', hook_name, exc_info)
1165
984
 
1166
985
    @needs_write_lock
1167
986
    def update(self):
1216
1035
        revision_id: if not None, the revision history in the new branch will
1217
1036
                     be truncated to end with revision_id.
1218
1037
        """
1219
 
        if (repository_policy is not None and
1220
 
            repository_policy.requires_stacking()):
1221
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
1038
        result = to_bzrdir.create_branch()
1223
1039
        result.lock_write()
1224
1040
        try:
1245
1061
        source_revno, source_revision_id = self.last_revision_info()
1246
1062
        if revision_id is None:
1247
1063
            revno, revision_id = source_revno, source_revision_id
 
1064
        elif source_revision_id == revision_id:
 
1065
            # we know the revno without needing to walk all of history
 
1066
            revno = source_revno
1248
1067
        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
 
1068
            # To figure out the revno for a random revision, we need to build
 
1069
            # the revision history, and count its length.
 
1070
            # We don't care about the order, just how long it is.
 
1071
            # Alternatively, we could start at the current location, and count
 
1072
            # backwards. But there is no guarantee that we will find it since
 
1073
            # it may be a merged revision.
 
1074
            revno = len(list(self.repository.iter_reverse_revision_history(
 
1075
                                                                revision_id)))
1256
1076
        destination.set_last_revision_info(revno, revision_id)
1257
1077
 
1258
1078
    @needs_read_lock
1292
1112
        target._set_all_reference_info(target_reference_dict)
1293
1113
 
1294
1114
    @needs_read_lock
1295
 
    def check(self, refs):
 
1115
    def check(self):
1296
1116
        """Check consistency of the branch.
1297
1117
 
1298
1118
        In particular this checks that revisions given in the revision-history
1301
1121
 
1302
1122
        Callers will typically also want to check the repository.
1303
1123
 
1304
 
        :param refs: Calculated refs for this branch as specified by
1305
 
            branch._get_check_refs()
1306
1124
        :return: A BranchCheckResult.
1307
1125
        """
1308
 
        result = BranchCheckResult(self)
 
1126
        mainline_parent_id = None
1309
1127
        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
 
1128
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
1129
                                last_revision_id))
 
1130
        real_rev_history.reverse()
 
1131
        if len(real_rev_history) != last_revno:
 
1132
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1133
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1134
        # TODO: We should probably also check that real_rev_history actually
 
1135
        #       matches self.revision_history()
 
1136
        for revision_id in real_rev_history:
 
1137
            try:
 
1138
                revision = self.repository.get_revision(revision_id)
 
1139
            except errors.NoSuchRevision, e:
 
1140
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1141
                            % revision_id)
 
1142
            # In general the first entry on the revision history has no parents.
 
1143
            # But it's not illegal for it to have parents listed; this can happen
 
1144
            # in imports from Arch when the parents weren't reachable.
 
1145
            if mainline_parent_id is not None:
 
1146
                if mainline_parent_id not in revision.parent_ids:
 
1147
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1148
                                        "parents of {%s}"
 
1149
                                        % (mainline_parent_id, revision_id))
 
1150
            mainline_parent_id = revision_id
 
1151
        return BranchCheckResult(self)
1321
1152
 
1322
1153
    def _get_checkout_format(self):
1323
1154
        """Return the most suitable metadir for a checkout of this branch.
1348
1179
        # clone call. Or something. 20090224 RBC/spiv.
1349
1180
        if revision_id is None:
1350
1181
            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)
 
1182
        try:
 
1183
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1184
                revision_id=revision_id, stacked_on=stacked_on,
 
1185
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1186
        except errors.FileExists:
 
1187
            if not use_existing_dir:
 
1188
                raise
 
1189
        except errors.NoSuchFile:
 
1190
            if not create_prefix:
 
1191
                raise
1354
1192
        return dir_to.open_branch()
1355
1193
 
1356
1194
    def create_checkout(self, to_location, revision_id=None,
1375
1213
        if lightweight:
1376
1214
            format = self._get_checkout_format()
1377
1215
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1216
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1217
        else:
1381
1218
            format = self._get_checkout_format()
1382
1219
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1424
1261
    def supports_tags(self):
1425
1262
        return self._format.supports_tags()
1426
1263
 
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
1264
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1265
                                         other_branch):
1441
1266
        """Ensure that revision_b is a descendant of revision_a.
1496
1321
    _formats = {}
1497
1322
    """The known formats."""
1498
1323
 
1499
 
    can_set_append_revisions_only = True
1500
 
 
1501
1324
    def __eq__(self, other):
1502
1325
        return self.__class__ is other.__class__
1503
1326
 
1505
1328
        return not (self == other)
1506
1329
 
1507
1330
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1331
    def find_format(klass, a_bzrdir):
1509
1332
        """Return the format for the branch object in a_bzrdir."""
1510
1333
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1334
            transport = a_bzrdir.get_branch_transport(None)
 
1335
            format_string = transport.get("format").read()
1513
1336
            return klass._formats[format_string]
1514
1337
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1338
            raise errors.NotBranchError(path=transport.base)
1516
1339
        except KeyError:
1517
1340
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1341
 
1554
1377
        """Return the short format description for this format."""
1555
1378
        raise NotImplementedError(self.get_format_description)
1556
1379
 
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):
 
1380
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1381
                           set_format=True):
1567
1382
        """Initialize a branch in a bzrdir, with specified files
1568
1383
 
1569
1384
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1385
        :param utf8_files: The files to create as a list of
1571
1386
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1387
        :param set_format: If True, set the format with
1574
1388
            self.get_format_string.  (BzrBranch4 has its format set
1575
1389
            elsewhere)
1576
1390
        :return: a branch in this format
1577
1391
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1392
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1393
        branch_transport = a_bzrdir.get_branch_transport(self)
1580
1394
        lock_map = {
1581
1395
            'metadir': ('lock', lockdir.LockDir),
1582
1396
            'branch4': ('branch-lock', lockable_files.TransportLock),
1603
1417
        finally:
1604
1418
            if lock_taken:
1605
1419
                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
 
1420
        return self.open(a_bzrdir, _found=True)
1609
1421
 
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
 
        """
 
1422
    def initialize(self, a_bzrdir):
 
1423
        """Create a branch of this format in a_bzrdir."""
1615
1424
        raise NotImplementedError(self.initialize)
1616
1425
 
1617
1426
    def is_supported(self):
1647
1456
        """
1648
1457
        raise NotImplementedError(self.network_name)
1649
1458
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1459
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1651
1460
        """Return the branch object for a_bzrdir
1652
1461
 
1653
1462
        :param a_bzrdir: A BzrDir that contains a branch.
1654
 
        :param name: Name of colocated branch to open
1655
1463
        :param _found: a private parameter, do not use it. It is used to
1656
1464
            indicate if format probing has already be done.
1657
1465
        :param ignore_fallbacks: when set, no fallback branches will be opened
1671
1479
    def set_default_format(klass, format):
1672
1480
        klass._default_format = format
1673
1481
 
1674
 
    def supports_set_append_revisions_only(self):
1675
 
        """True if this format supports set_append_revisions_only."""
1676
 
        return False
1677
 
 
1678
1482
    def supports_stacking(self):
1679
1483
        """True if this format records a stacked-on branch."""
1680
1484
        return False
1765
1569
            "multiple hooks installed for transform_fallback_location, "
1766
1570
            "all are called with the url returned from the previous hook."
1767
1571
            "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
1572
 
1786
1573
 
1787
1574
# install the default hooks into the Branch class.
1826
1613
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1614
 
1828
1615
 
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
1616
class BzrBranchFormat4(BranchFormat):
1908
1617
    """Bzr branch format 4.
1909
1618
 
1916
1625
        """See BranchFormat.get_format_description()."""
1917
1626
        return "Branch format 4"
1918
1627
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1628
    def initialize(self, a_bzrdir):
1920
1629
        """Create a branch of this format in a_bzrdir."""
1921
1630
        utf8_files = [('revision-history', ''),
1922
1631
                      ('branch-name', ''),
1923
1632
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1633
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1634
                                       lock_type='branch4', set_format=False)
1926
1635
 
1927
1636
    def __init__(self):
1932
1641
        """The network name for this format is the control dirs disk label."""
1933
1642
        return self._matchingbzrdir.get_format_string()
1934
1643
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1644
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1936
1645
        """See BranchFormat.open()."""
1937
1646
        if not _found:
1938
1647
            # we are being called directly and must probe.
1940
1649
        return BzrBranch(_format=self,
1941
1650
                         _control_files=a_bzrdir._control_files,
1942
1651
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1652
                         _repository=a_bzrdir.open_repository())
1945
1653
 
1946
1654
    def __str__(self):
1961
1669
        """
1962
1670
        return self.get_format_string()
1963
1671
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1672
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1965
1673
        """See BranchFormat.open()."""
1966
1674
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1675
            format = BranchFormat.find_format(a_bzrdir)
1968
1676
            if format.__class__ != self.__class__:
1969
1677
                raise AssertionError("wrong format %r found for %r" %
1970
1678
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1679
        try:
 
1680
            transport = a_bzrdir.get_branch_transport(None)
1973
1681
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1682
                                                         lockdir.LockDir)
1975
1683
            return self._branch_class()(_format=self,
1976
1684
                              _control_files=control_files,
1977
 
                              name=name,
1978
1685
                              a_bzrdir=a_bzrdir,
1979
1686
                              _repository=a_bzrdir.find_repository(),
1980
1687
                              ignore_fallbacks=ignore_fallbacks)
1981
1688
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1689
            raise errors.NotBranchError(path=transport.base)
1983
1690
 
1984
1691
    def __init__(self):
1985
1692
        super(BranchFormatMetadir, self).__init__()
2014
1721
        """See BranchFormat.get_format_description()."""
2015
1722
        return "Branch format 5"
2016
1723
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1724
    def initialize(self, a_bzrdir):
2018
1725
        """Create a branch of this format in a_bzrdir."""
2019
1726
        utf8_files = [('revision-history', ''),
2020
1727
                      ('branch-name', ''),
2021
1728
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1729
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1730
 
2024
1731
    def supports_tags(self):
2025
1732
        return False
2047
1754
        """See BranchFormat.get_format_description()."""
2048
1755
        return "Branch format 6"
2049
1756
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
1757
    def initialize(self, a_bzrdir):
2051
1758
        """Create a branch of this format in a_bzrdir."""
2052
1759
        utf8_files = [('last-revision', '0 null:\n'),
2053
1760
                      ('branch.conf', ''),
2054
1761
                      ('tags', ''),
2055
1762
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1763
        return self._initialize_helper(a_bzrdir, utf8_files)
2057
1764
 
2058
1765
    def make_tags(self, branch):
2059
1766
        """See bzrlib.branch.BranchFormat.make_tags()."""
2060
1767
        return BasicTags(branch)
2061
1768
 
2062
 
    def supports_set_append_revisions_only(self):
2063
 
        return True
2064
1769
 
2065
1770
 
2066
1771
class BzrBranchFormat8(BranchFormatMetadir):
2077
1782
        """See BranchFormat.get_format_description()."""
2078
1783
        return "Branch format 8"
2079
1784
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
1785
    def initialize(self, a_bzrdir):
2081
1786
        """Create a branch of this format in a_bzrdir."""
2082
1787
        utf8_files = [('last-revision', '0 null:\n'),
2083
1788
                      ('branch.conf', ''),
2084
1789
                      ('tags', ''),
2085
1790
                      ('references', '')
2086
1791
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1792
        return self._initialize_helper(a_bzrdir, utf8_files)
2088
1793
 
2089
1794
    def __init__(self):
2090
1795
        super(BzrBranchFormat8, self).__init__()
2095
1800
        """See bzrlib.branch.BranchFormat.make_tags()."""
2096
1801
        return BasicTags(branch)
2097
1802
 
2098
 
    def supports_set_append_revisions_only(self):
2099
 
        return True
2100
 
 
2101
1803
    def supports_stacking(self):
2102
1804
        return True
2103
1805
 
2113
1815
    This format was introduced in bzr 1.6.
2114
1816
    """
2115
1817
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
1818
    def initialize(self, a_bzrdir):
2117
1819
        """Create a branch of this format in a_bzrdir."""
2118
1820
        utf8_files = [('last-revision', '0 null:\n'),
2119
1821
                      ('branch.conf', ''),
2120
1822
                      ('tags', ''),
2121
1823
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1824
        return self._initialize_helper(a_bzrdir, utf8_files)
2123
1825
 
2124
1826
    def _branch_class(self):
2125
1827
        return BzrBranch7
2132
1834
        """See BranchFormat.get_format_description()."""
2133
1835
        return "Branch format 7"
2134
1836
 
2135
 
    def supports_set_append_revisions_only(self):
2136
 
        return True
2137
 
 
2138
1837
    supports_reference_locations = False
2139
1838
 
2140
1839
 
2160
1859
    def get_reference(self, a_bzrdir):
2161
1860
        """See BranchFormat.get_reference()."""
2162
1861
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1862
        return transport.get('location').read()
2164
1863
 
2165
1864
    def set_reference(self, a_bzrdir, to_branch):
2166
1865
        """See BranchFormat.set_reference()."""
2167
1866
        transport = a_bzrdir.get_branch_transport(None)
2168
1867
        location = transport.put_bytes('location', to_branch.base)
2169
1868
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1869
    def initialize(self, a_bzrdir, target_branch=None):
2171
1870
        """Create a branch of this format in a_bzrdir."""
2172
1871
        if target_branch is None:
2173
1872
            # this format does not implement branch itself, thus the implicit
2174
1873
            # creation contract must see it as uninitializable
2175
1874
            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)
 
1875
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1876
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1877
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1878
            target_branch.bzrdir.root_transport.base)
2180
1879
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
1880
        return self.open(
 
1881
            a_bzrdir, _found=True,
2183
1882
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
1883
 
2187
1884
    def __init__(self):
2188
1885
        super(BranchReferenceFormat, self).__init__()
2194
1891
        def clone(to_bzrdir, revision_id=None,
2195
1892
            repository_policy=None):
2196
1893
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1894
            return format.initialize(to_bzrdir, a_branch)
2198
1895
            # cannot obey revision_id limits when cloning a reference ...
2199
1896
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
1897
            # emit some sort of warning/error to the caller ?!
2201
1898
        return clone
2202
1899
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1900
    def open(self, a_bzrdir, _found=False, location=None,
2204
1901
             possible_transports=None, ignore_fallbacks=False):
2205
1902
        """Return the branch that the branch reference in a_bzrdir points at.
2206
1903
 
2207
1904
        :param a_bzrdir: A BzrDir that contains a branch.
2208
 
        :param name: Name of colocated branch to open, if any
2209
1905
        :param _found: a private parameter, do not use it. It is used to
2210
1906
            indicate if format probing has already be done.
2211
1907
        :param ignore_fallbacks: when set, no fallback branches will be opened
2216
1912
        :param possible_transports: An optional reusable transports list.
2217
1913
        """
2218
1914
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1915
            format = BranchFormat.find_format(a_bzrdir)
2220
1916
            if format.__class__ != self.__class__:
2221
1917
                raise AssertionError("wrong format %r found for %r" %
2222
1918
                    (format, self))
2224
1920
            location = self.get_reference(a_bzrdir)
2225
1921
        real_bzrdir = bzrdir.BzrDir.open(
2226
1922
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
1923
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2229
1924
        # this changes the behaviour of result.clone to create a new reference
2230
1925
        # rather than a copy of the content of the branch.
2231
1926
        # I did not use a proxy object because that needs much more extensive
2258
1953
BranchFormat.register_format(__format6)
2259
1954
BranchFormat.register_format(__format7)
2260
1955
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
 
1956
BranchFormat.set_default_format(__format6)
2262
1957
_legacy_formats = [BzrBranchFormat4(),
2263
1958
    ]
2264
1959
network_format_registry.register(
2265
1960
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
1961
 
2267
1962
 
2268
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1963
class BzrBranch(Branch):
2269
1964
    """A branch stored in the actual filesystem.
2270
1965
 
2271
1966
    Note that it's "local" in the context of the filesystem; it doesn't
2277
1972
    :ivar repository: Repository for this branch.
2278
1973
    :ivar base: The url of the base directory for this branch; the one
2279
1974
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
1975
    """
2283
1976
 
2284
1977
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
1978
                 _control_files=None, a_bzrdir=None, _repository=None,
 
1979
                 ignore_fallbacks=False):
2287
1980
        """Create new branch object at a particular location."""
2288
1981
        if a_bzrdir is None:
2289
1982
            raise ValueError('a_bzrdir must be supplied')
2290
1983
        else:
2291
1984
            self.bzrdir = a_bzrdir
2292
1985
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
1986
        # XXX: We should be able to just do
2295
1987
        #   self.base = self.bzrdir.root_transport.base
2296
1988
        # but this does not quite work yet -- mbp 20080522
2303
1995
        Branch.__init__(self)
2304
1996
 
2305
1997
    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)
 
1998
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
1999
 
2312
2000
    __repr__ = __str__
2313
2001
 
2324
2012
        return self.control_files.is_locked()
2325
2013
 
2326
2014
    def lock_write(self, token=None):
2327
 
        if not self.is_locked():
2328
 
            self._note_lock('w')
2329
2015
        # All-in-one needs to always unlock/lock.
2330
2016
        repo_control = getattr(self.repository, 'control_files', None)
2331
2017
        if self.control_files == repo_control or not self.is_locked():
2332
 
            self.repository._warn_if_deprecated(self)
2333
2018
            self.repository.lock_write()
2334
2019
            took_lock = True
2335
2020
        else:
2342
2027
            raise
2343
2028
 
2344
2029
    def lock_read(self):
2345
 
        if not self.is_locked():
2346
 
            self._note_lock('r')
2347
2030
        # All-in-one needs to always unlock/lock.
2348
2031
        repo_control = getattr(self.repository, 'control_files', None)
2349
2032
        if self.control_files == repo_control or not self.is_locked():
2350
 
            self.repository._warn_if_deprecated(self)
2351
2033
            self.repository.lock_read()
2352
2034
            took_lock = True
2353
2035
        else:
2359
2041
                self.repository.unlock()
2360
2042
            raise
2361
2043
 
2362
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
2044
    def unlock(self):
2364
2045
        try:
2365
2046
            self.control_files.unlock()
2496
2177
        """See Branch.basis_tree."""
2497
2178
        return self.repository.revision_tree(self.last_revision())
2498
2179
 
 
2180
    @needs_write_lock
 
2181
    def pull(self, source, overwrite=False, stop_revision=None,
 
2182
             _hook_master=None, run_hooks=True, possible_transports=None,
 
2183
             _override_hook_target=None):
 
2184
        """See Branch.pull.
 
2185
 
 
2186
        :param _hook_master: Private parameter - set the branch to
 
2187
            be supplied as the master to pull hooks.
 
2188
        :param run_hooks: Private parameter - if false, this branch
 
2189
            is being called because it's the master of the primary branch,
 
2190
            so it should not run its hooks.
 
2191
        :param _override_hook_target: Private parameter - set the branch to be
 
2192
            supplied as the target_branch to pull hooks.
 
2193
        """
 
2194
        result = PullResult()
 
2195
        result.source_branch = source
 
2196
        if _override_hook_target is None:
 
2197
            result.target_branch = self
 
2198
        else:
 
2199
            result.target_branch = _override_hook_target
 
2200
        source.lock_read()
 
2201
        try:
 
2202
            # We assume that during 'pull' the local repository is closer than
 
2203
            # the remote one.
 
2204
            source.update_references(self)
 
2205
            graph = self.repository.get_graph(source.repository)
 
2206
            result.old_revno, result.old_revid = self.last_revision_info()
 
2207
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
2208
                                  graph=graph)
 
2209
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
2210
            result.new_revno, result.new_revid = self.last_revision_info()
 
2211
            if _hook_master:
 
2212
                result.master_branch = _hook_master
 
2213
                result.local_branch = result.target_branch
 
2214
            else:
 
2215
                result.master_branch = result.target_branch
 
2216
                result.local_branch = None
 
2217
            if run_hooks:
 
2218
                for hook in Branch.hooks['post_pull']:
 
2219
                    hook(result)
 
2220
        finally:
 
2221
            source.unlock()
 
2222
        return result
 
2223
 
2499
2224
    def _get_parent_location(self):
2500
2225
        _locs = ['parent', 'pull', 'x-pull']
2501
2226
        for l in _locs:
2528
2253
        return result
2529
2254
 
2530
2255
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2256
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2257
 
2533
2258
    def set_push_location(self, location):
2534
2259
        """See Branch.set_push_location."""
2550
2275
    It has support for a master_branch which is the data for bound branches.
2551
2276
    """
2552
2277
 
 
2278
    @needs_write_lock
 
2279
    def pull(self, source, overwrite=False, stop_revision=None,
 
2280
             run_hooks=True, possible_transports=None,
 
2281
             _override_hook_target=None):
 
2282
        """Pull from source into self, updating my master if any.
 
2283
 
 
2284
        :param run_hooks: Private parameter - if false, this branch
 
2285
            is being called because it's the master of the primary branch,
 
2286
            so it should not run its hooks.
 
2287
        """
 
2288
        bound_location = self.get_bound_location()
 
2289
        master_branch = None
 
2290
        if bound_location and source.base != bound_location:
 
2291
            # not pulling from master, so we need to update master.
 
2292
            master_branch = self.get_master_branch(possible_transports)
 
2293
            master_branch.lock_write()
 
2294
        try:
 
2295
            if master_branch:
 
2296
                # pull from source into master.
 
2297
                master_branch.pull(source, overwrite, stop_revision,
 
2298
                    run_hooks=False)
 
2299
            return super(BzrBranch5, self).pull(source, overwrite,
 
2300
                stop_revision, _hook_master=master_branch,
 
2301
                run_hooks=run_hooks,
 
2302
                _override_hook_target=_override_hook_target)
 
2303
        finally:
 
2304
            if master_branch:
 
2305
                master_branch.unlock()
 
2306
 
2553
2307
    def get_bound_location(self):
2554
2308
        try:
2555
2309
            return self._transport.get_bytes('bound')[:-1]
2661
2415
                    raise AssertionError(
2662
2416
                        "'transform_fallback_location' hook %s returned "
2663
2417
                        "None, not a URL." % hook_name)
2664
 
            self._activate_fallback_location(url)
 
2418
            self._activate_fallback_location(url, None)
2665
2419
 
2666
2420
    def __init__(self, *args, **kwargs):
2667
2421
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2668
2422
        super(BzrBranch8, self).__init__(*args, **kwargs)
2669
2423
        self._last_revision_info_cache = None
 
2424
        self._partial_revision_history_cache = []
2670
2425
        self._reference_info = None
2671
2426
 
2672
2427
    def _clear_cached_state(self):
2673
2428
        super(BzrBranch8, self)._clear_cached_state()
2674
2429
        self._last_revision_info_cache = None
 
2430
        self._partial_revision_history_cache = []
2675
2431
        self._reference_info = None
2676
2432
 
2677
2433
    def _last_revision_info(self):
2724
2480
        if _mod_revision.is_null(last_revision):
2725
2481
            return
2726
2482
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2483
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2484
 
2729
2485
    def _gen_revision_history(self):
2730
2486
        """Generate the revision history from last revision
2733
2489
        self._extend_partial_history(stop_index=last_revno-1)
2734
2490
        return list(reversed(self._partial_revision_history_cache))
2735
2491
 
 
2492
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2493
        """Extend the partial history to include a given index
 
2494
 
 
2495
        If a stop_index is supplied, stop when that index has been reached.
 
2496
        If a stop_revision is supplied, stop when that revision is
 
2497
        encountered.  Otherwise, stop when the beginning of history is
 
2498
        reached.
 
2499
 
 
2500
        :param stop_index: The index which should be present.  When it is
 
2501
            present, history extension will stop.
 
2502
        :param revision_id: The revision id which should be present.  When
 
2503
            it is encountered, history extension will stop.
 
2504
        """
 
2505
        repo = self.repository
 
2506
        if len(self._partial_revision_history_cache) == 0:
 
2507
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2508
        else:
 
2509
            start_revision = self._partial_revision_history_cache[-1]
 
2510
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2511
            #skip the last revision in the list
 
2512
            next_revision = iterator.next()
 
2513
        for revision_id in iterator:
 
2514
            self._partial_revision_history_cache.append(revision_id)
 
2515
            if (stop_index is not None and
 
2516
                len(self._partial_revision_history_cache) > stop_index):
 
2517
                break
 
2518
            if revision_id == stop_revision:
 
2519
                break
 
2520
 
2736
2521
    def _write_revision_history(self, history):
2737
2522
        """Factored out of set_revision_history.
2738
2523
 
2830
2615
        if branch_location is None:
2831
2616
            return Branch.reference_parent(self, file_id, path,
2832
2617
                                           possible_transports)
2833
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2618
        branch_location = urlutils.join(self.base, branch_location)
2834
2619
        return Branch.open(branch_location,
2835
2620
                           possible_transports=possible_transports)
2836
2621
 
2881
2666
            raise errors.NotStacked(self)
2882
2667
        return stacked_url
2883
2668
 
 
2669
    def set_append_revisions_only(self, enabled):
 
2670
        if enabled:
 
2671
            value = 'True'
 
2672
        else:
 
2673
            value = 'False'
 
2674
        self.get_config().set_user_option('append_revisions_only', value,
 
2675
            warn_masked=True)
 
2676
 
2884
2677
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2678
        value = self.get_config().get_user_option('append_revisions_only')
 
2679
        return value == 'True'
2887
2680
 
2888
2681
    @needs_write_lock
2889
2682
    def generate_revision_history(self, revision_id, last_rev=None,
2951
2744
    """
2952
2745
 
2953
2746
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2747
        raise errors.UnstackableBranchFormat(self._format, self.base)
2955
2748
 
2956
2749
 
2957
2750
######################################################################
3036
2829
 
3037
2830
    def __init__(self, branch):
3038
2831
        self.branch = branch
3039
 
        self.errors = []
3040
2832
 
3041
2833
    def report_results(self, verbose):
3042
2834
        """Report the check results via trace.note.
3044
2836
        :param verbose: Requests more detailed display of what was checked,
3045
2837
            if any.
3046
2838
        """
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)
 
2839
        note('checked branch %s format %s',
 
2840
             self.branch.base,
 
2841
             self.branch._format)
3051
2842
 
3052
2843
 
3053
2844
class Converter5to6(object):
3148
2939
    @staticmethod
3149
2940
    def _get_branch_formats_to_test():
3150
2941
        """Return a tuple with the Branch formats to use when testing."""
3151
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3152
 
 
3153
 
    def pull(self, overwrite=False, stop_revision=None,
3154
 
             possible_transports=None, local=False):
3155
 
        """Mirror source into target branch.
3156
 
 
3157
 
        The target branch is considered to be 'local', having low latency.
3158
 
 
3159
 
        :returns: PullResult instance
3160
 
        """
3161
 
        raise NotImplementedError(self.pull)
 
2942
        raise NotImplementedError(self._get_branch_formats_to_test)
3162
2943
 
3163
2944
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
2945
                         graph=None):
3233
3014
        finally:
3234
3015
            self.source.unlock()
3235
3016
 
3236
 
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3238
 
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
3240
 
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
 
        :param run_hooks: Private parameter - if false, this branch
3244
 
            is being called because it's the master of the primary branch,
3245
 
            so it should not run its hooks.
3246
 
        :param _override_hook_target: Private parameter - set the branch to be
3247
 
            supplied as the target_branch to pull hooks.
3248
 
        :param local: Only update the local branch, and not the bound branch.
3249
 
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
3252
 
            raise errors.LocalRequiresBoundBranch()
3253
 
        result = PullResult()
3254
 
        result.source_branch = self.source
3255
 
        if _override_hook_target is None:
3256
 
            result.target_branch = self.target
3257
 
        else:
3258
 
            result.target_branch = _override_hook_target
3259
 
        self.source.lock_read()
3260
 
        try:
3261
 
            # We assume that during 'pull' the target repository is closer than
3262
 
            # the source one.
3263
 
            self.source.update_references(self.target)
3264
 
            graph = self.target.repository.get_graph(self.source.repository)
3265
 
            # TODO: Branch formats should have a flag that indicates 
3266
 
            # that revno's are expensive, and pull() should honor that flag.
3267
 
            # -- JRV20090506
3268
 
            result.old_revno, result.old_revid = \
3269
 
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
3272
 
            # TODO: The old revid should be specified when merging tags, 
3273
 
            # so a tags implementation that versions tags can only 
3274
 
            # pull in the most recent changes. -- JRV20090506
3275
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
3277
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
 
            if _hook_master:
3279
 
                result.master_branch = _hook_master
3280
 
                result.local_branch = result.target_branch
3281
 
            else:
3282
 
                result.master_branch = result.target_branch
3283
 
                result.local_branch = None
3284
 
            if run_hooks:
3285
 
                for hook in Branch.hooks['post_pull']:
3286
 
                    hook(result)
3287
 
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
3290
 
 
3291
3017
    def push(self, overwrite=False, stop_revision=None,
3292
3018
             _override_hook_source_branch=None):
3293
3019
        """See InterBranch.push.
3360
3086
        return True
3361
3087
 
3362
3088
 
3363
 
class InterToBranch5(GenericInterBranch):
3364
 
 
3365
 
    @staticmethod
3366
 
    def _get_branch_formats_to_test():
3367
 
        return BranchFormat._default_format, BzrBranchFormat5()
3368
 
 
3369
 
    def pull(self, overwrite=False, stop_revision=None,
3370
 
             possible_transports=None, run_hooks=True,
3371
 
             _override_hook_target=None, local=False):
3372
 
        """Pull from source into self, updating my master if any.
3373
 
 
3374
 
        :param run_hooks: Private parameter - if false, this branch
3375
 
            is being called because it's the master of the primary branch,
3376
 
            so it should not run its hooks.
3377
 
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
3380
 
            raise errors.LocalRequiresBoundBranch()
3381
 
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
3383
 
            # not pulling from master, so we need to update master.
3384
 
            master_branch = self.target.get_master_branch(possible_transports)
3385
 
            master_branch.lock_write()
3386
 
        try:
3387
 
            if master_branch:
3388
 
                # pull from source into master.
3389
 
                master_branch.pull(self.source, overwrite, stop_revision,
3390
 
                    run_hooks=False)
3391
 
            return super(InterToBranch5, self).pull(overwrite,
3392
 
                stop_revision, _hook_master=master_branch,
3393
 
                run_hooks=run_hooks,
3394
 
                _override_hook_target=_override_hook_target)
3395
 
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
3398
 
 
3399
 
 
3400
3089
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)