/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: John Arbash Meinel
  • Date: 2011-05-17 11:27:58 UTC
  • mto: This revision was merged to the branch mainline in revision 5880.
  • Revision ID: john@arbash-meinel.com-20110517112758-eayd47x2h1jdp4zo
Fix bug #781168, and allow WT.update_basis_by_delta
to apply a delta that does not match the WT state. The check is nice to have
for commit, but it doesn't make sense to have for uncommit, etc.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
27
27
        config as _mod_config,
28
28
        debug,
29
29
        errors,
 
30
        fetch,
 
31
        graph as _mod_graph,
30
32
        lockdir,
31
33
        lockable_files,
 
34
        remote,
32
35
        repository,
33
36
        revision as _mod_revision,
34
37
        rio,
35
 
        symbol_versioning,
36
38
        transport,
37
 
        tsort,
38
39
        ui,
39
40
        urlutils,
40
41
        )
41
42
from bzrlib.config import BranchConfig, TransportConfig
42
 
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
43
from bzrlib.tag import (
44
44
    BasicTags,
45
45
    DisabledTags,
46
46
    )
47
47
""")
48
48
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
 
from bzrlib.hooks import HookPoint, Hooks
 
49
from bzrlib import (
 
50
    controldir,
 
51
    )
 
52
from bzrlib.decorators import (
 
53
    needs_read_lock,
 
54
    needs_write_lock,
 
55
    only_raises,
 
56
    )
 
57
from bzrlib.hooks import Hooks
51
58
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
 
59
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
60
from bzrlib import registry
54
61
from bzrlib.symbol_versioning import (
55
62
    deprecated_in,
63
70
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
71
 
65
72
 
66
 
class Branch(bzrdir.ControlComponent):
 
73
class Branch(controldir.ControlComponent):
67
74
    """Branch holding a history of revisions.
68
75
 
69
76
    :ivar base:
70
77
        Base directory/url of the branch; using control_url and
71
78
        control_transport is more standardized.
72
 
 
73
 
    hooks: An instance of BranchHooks.
 
79
    :ivar hooks: An instance of BranchHooks.
 
80
    :ivar _master_branch_cache: cached result of get_master_branch, see
 
81
        _clear_cached_state.
74
82
    """
75
83
    # this is really an instance variable - FIXME move it there
76
84
    # - RBC 20060112
90
98
        self._revision_id_to_revno_cache = None
91
99
        self._partial_revision_id_to_revno_cache = {}
92
100
        self._partial_revision_history_cache = []
 
101
        self._tags_bytes = None
93
102
        self._last_revision_info_cache = None
 
103
        self._master_branch_cache = None
94
104
        self._merge_sorted_revisions_cache = None
95
105
        self._open_hook()
96
106
        hooks = Branch.hooks['open']
102
112
 
103
113
    def _activate_fallback_location(self, url):
104
114
        """Activate the branch/repository from url as a fallback repository."""
 
115
        for existing_fallback_repo in self.repository._fallback_repositories:
 
116
            if existing_fallback_repo.user_url == url:
 
117
                # This fallback is already configured.  This probably only
 
118
                # happens because BzrDir.sprout is a horrible mess.  To avoid
 
119
                # confusing _unstack we don't add this a second time.
 
120
                mutter('duplicate activation of fallback %r on %r', url, self)
 
121
                return
105
122
        repo = self._get_fallback_repository(url)
106
123
        if repo.has_same_location(self.repository):
107
124
            raise errors.UnstackableLocationError(self.user_url, url)
197
214
        return self.supports_tags() and self.tags.get_tag_dict()
198
215
 
199
216
    def get_config(self):
 
217
        """Get a bzrlib.config.BranchConfig for this Branch.
 
218
 
 
219
        This can then be used to get and set configuration options for the
 
220
        branch.
 
221
 
 
222
        :return: A bzrlib.config.BranchConfig.
 
223
        """
200
224
        return BranchConfig(self)
201
225
 
202
226
    def _get_config(self):
218
242
            possible_transports=[self.bzrdir.root_transport])
219
243
        return a_branch.repository
220
244
 
 
245
    @needs_read_lock
221
246
    def _get_tags_bytes(self):
222
247
        """Get the bytes of a serialised tags dict.
223
248
 
230
255
        :return: The bytes of the tags file.
231
256
        :seealso: Branch._set_tags_bytes.
232
257
        """
233
 
        return self._transport.get_bytes('tags')
 
258
        if self._tags_bytes is None:
 
259
            self._tags_bytes = self._transport.get_bytes('tags')
 
260
        return self._tags_bytes
234
261
 
235
262
    def _get_nick(self, local=False, possible_transports=None):
236
263
        config = self.get_config()
238
265
        if not local and not config.has_explicit_nickname():
239
266
            try:
240
267
                master = self.get_master_branch(possible_transports)
 
268
                if master and self.user_url == master.user_url:
 
269
                    raise errors.RecursiveBind(self.user_url)
241
270
                if master is not None:
242
271
                    # return the master branch value
243
272
                    return master.nick
 
273
            except errors.RecursiveBind, e:
 
274
                raise e
244
275
            except errors.BzrError, e:
245
276
                # Silently fall back to local implicit nick if the master is
246
277
                # unavailable
283
314
        new_history.reverse()
284
315
        return new_history
285
316
 
286
 
    def lock_write(self):
 
317
    def lock_write(self, token=None):
 
318
        """Lock the branch for write operations.
 
319
 
 
320
        :param token: A token to permit reacquiring a previously held and
 
321
            preserved lock.
 
322
        :return: A BranchWriteLockResult.
 
323
        """
287
324
        raise NotImplementedError(self.lock_write)
288
325
 
289
326
    def lock_read(self):
 
327
        """Lock the branch for read operations.
 
328
 
 
329
        :return: A bzrlib.lock.LogicalLockResult.
 
330
        """
290
331
        raise NotImplementedError(self.lock_read)
291
332
 
292
333
    def unlock(self):
626
667
        raise errors.UnsupportedOperation(self.get_reference_info, self)
627
668
 
628
669
    @needs_write_lock
629
 
    def fetch(self, from_branch, last_revision=None, pb=None):
 
670
    def fetch(self, from_branch, last_revision=None):
630
671
        """Copy revisions from from_branch into this branch.
631
672
 
632
673
        :param from_branch: Where to copy from.
633
674
        :param last_revision: What revision to stop at (None for at the end
634
675
                              of the branch.
635
 
        :param pb: An optional progress bar to use.
636
676
        :return: None
637
677
        """
638
 
        if self.base == from_branch.base:
639
 
            return (0, [])
640
 
        if pb is not None:
641
 
            symbol_versioning.warn(
642
 
                symbol_versioning.deprecated_in((1, 14, 0))
643
 
                % "pb parameter to fetch()")
644
 
        from_branch.lock_read()
645
 
        try:
646
 
            if last_revision is None:
647
 
                last_revision = from_branch.last_revision()
648
 
                last_revision = _mod_revision.ensure_null(last_revision)
649
 
            return self.repository.fetch(from_branch.repository,
650
 
                                         revision_id=last_revision,
651
 
                                         pb=pb)
652
 
        finally:
653
 
            from_branch.unlock()
 
678
        return InterBranch.get(from_branch, self).fetch(last_revision)
654
679
 
655
680
    def get_bound_location(self):
656
681
        """Return the URL of the branch we are bound to.
667
692
 
668
693
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
694
                           timezone=None, committer=None, revprops=None,
670
 
                           revision_id=None):
 
695
                           revision_id=None, lossy=False):
671
696
        """Obtain a CommitBuilder for this branch.
672
697
 
673
698
        :param parents: Revision ids of the parents of the new revision.
677
702
        :param committer: Optional committer to set for commit.
678
703
        :param revprops: Optional dictionary of revision properties.
679
704
        :param revision_id: Optional revision id.
 
705
        :param lossy: Whether to discard data that can not be natively
 
706
            represented, when pushing to a foreign VCS 
680
707
        """
681
708
 
682
709
        if config is None:
683
710
            config = self.get_config()
684
711
 
685
712
        return self.repository.get_commit_builder(self, parents, config,
686
 
            timestamp, timezone, committer, revprops, revision_id)
 
713
            timestamp, timezone, committer, revprops, revision_id,
 
714
            lossy)
687
715
 
688
716
    def get_master_branch(self, possible_transports=None):
689
717
        """Return the branch we are bound to.
716
744
        """Print `file` to stdout."""
717
745
        raise NotImplementedError(self.print_file)
718
746
 
 
747
    @deprecated_method(deprecated_in((2, 4, 0)))
719
748
    def set_revision_history(self, rev_history):
720
 
        raise NotImplementedError(self.set_revision_history)
 
749
        """See Branch.set_revision_history."""
 
750
        self._set_revision_history(rev_history)
 
751
 
 
752
    @needs_write_lock
 
753
    def _set_revision_history(self, rev_history):
 
754
        if len(rev_history) == 0:
 
755
            revid = _mod_revision.NULL_REVISION
 
756
        else:
 
757
            revid = rev_history[-1]
 
758
        if rev_history != self._lefthand_history(revid):
 
759
            raise errors.NotLefthandHistory(rev_history)
 
760
        self.set_last_revision_info(len(rev_history), revid)
 
761
        self._cache_revision_history(rev_history)
 
762
        for hook in Branch.hooks['set_rh']:
 
763
            hook(self, rev_history)
 
764
 
 
765
    @needs_write_lock
 
766
    def set_last_revision_info(self, revno, revision_id):
 
767
        """Set the last revision of this branch.
 
768
 
 
769
        The caller is responsible for checking that the revno is correct
 
770
        for this revision id.
 
771
 
 
772
        It may be possible to set the branch last revision to an id not
 
773
        present in the repository.  However, branches can also be
 
774
        configured to check constraints on history, in which case this may not
 
775
        be permitted.
 
776
        """
 
777
        raise NotImplementedError(self.last_revision_info)
 
778
 
 
779
    @needs_write_lock
 
780
    def generate_revision_history(self, revision_id, last_rev=None,
 
781
                                  other_branch=None):
 
782
        """See Branch.generate_revision_history"""
 
783
        graph = self.repository.get_graph()
 
784
        known_revision_ids = [
 
785
            self.last_revision_info(),
 
786
            (_mod_revision.NULL_REVISION, 0),
 
787
            ]
 
788
        if last_rev is not None:
 
789
            if not graph.is_ancestor(last_rev, revision_id):
 
790
                # our previous tip is not merged into stop_revision
 
791
                raise errors.DivergedBranches(self, other_branch)
 
792
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
 
793
        self.set_last_revision_info(revno, revision_id)
721
794
 
722
795
    @needs_write_lock
723
796
    def set_parent(self, url):
767
840
 
768
841
    def _unstack(self):
769
842
        """Change a branch to be unstacked, copying data as needed.
770
 
        
 
843
 
771
844
        Don't call this directly, use set_stacked_on_url(None).
772
845
        """
773
846
        pb = ui.ui_factory.nested_progress_bar()
782
855
            old_repository = self.repository
783
856
            if len(old_repository._fallback_repositories) != 1:
784
857
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
 
858
                    "of %r (fallbacks: %r)" % (old_repository,
 
859
                        old_repository._fallback_repositories))
 
860
            # Open the new repository object.
 
861
            # Repositories don't offer an interface to remove fallback
 
862
            # repositories today; take the conceptually simpler option and just
 
863
            # reopen it.  We reopen it starting from the URL so that we
 
864
            # get a separate connection for RemoteRepositories and can
 
865
            # stream from one of them to the other.  This does mean doing
 
866
            # separate SSH connection setup, but unstacking is not a
 
867
            # common operation so it's tolerable.
 
868
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
869
            new_repository = new_bzrdir.find_repository()
 
870
            if new_repository._fallback_repositories:
 
871
                raise AssertionError("didn't expect %r to have "
 
872
                    "fallback_repositories"
 
873
                    % (self.repository,))
 
874
            # Replace self.repository with the new repository.
 
875
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
876
            # lock count) of self.repository to the new repository.
 
877
            lock_token = old_repository.lock_write().repository_token
 
878
            self.repository = new_repository
 
879
            if isinstance(self, remote.RemoteBranch):
 
880
                # Remote branches can have a second reference to the old
 
881
                # repository that need to be replaced.
 
882
                if self._real_branch is not None:
 
883
                    self._real_branch.repository = new_repository
 
884
            self.repository.lock_write(token=lock_token)
 
885
            if lock_token is not None:
 
886
                old_repository.leave_lock_in_place()
787
887
            old_repository.unlock()
 
888
            if lock_token is not None:
 
889
                # XXX: self.repository.leave_lock_in_place() before this
 
890
                # function will not be preserved.  Fortunately that doesn't
 
891
                # affect the current default format (2a), and would be a
 
892
                # corner-case anyway.
 
893
                #  - Andrew Bennetts, 2010/06/30
 
894
                self.repository.dont_leave_lock_in_place()
 
895
            old_lock_count = 0
 
896
            while True:
 
897
                try:
 
898
                    old_repository.unlock()
 
899
                except errors.LockNotHeld:
 
900
                    break
 
901
                old_lock_count += 1
 
902
            if old_lock_count == 0:
 
903
                raise AssertionError(
 
904
                    'old_repository should have been locked at least once.')
 
905
            for i in range(old_lock_count-1):
 
906
                self.repository.lock_write()
 
907
            # Fetch from the old repository into the new.
788
908
            old_repository.lock_read()
789
909
            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
910
                # XXX: If you unstack a branch while it has a working tree
809
911
                # with a pending merge, the pending-merged revisions will no
810
912
                # 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)
 
913
                try:
 
914
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
915
                except errors.TagsNotSupported:
 
916
                    tags_to_fetch = set()
 
917
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
918
                    old_repository, required_ids=[self.last_revision()],
 
919
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
920
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
818
921
            finally:
819
922
                old_repository.unlock()
820
923
        finally:
825
928
 
826
929
        :seealso: Branch._get_tags_bytes.
827
930
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
931
        return _run_with_write_locked_target(self, self._set_tags_bytes_locked,
 
932
                bytes)
 
933
 
 
934
    def _set_tags_bytes_locked(self, bytes):
 
935
        self._tags_bytes = bytes
 
936
        return self._transport.put_bytes('tags', bytes)
830
937
 
831
938
    def _cache_revision_history(self, rev_history):
832
939
        """Set the cached revision history to rev_history.
859
966
        self._revision_history_cache = None
860
967
        self._revision_id_to_revno_cache = None
861
968
        self._last_revision_info_cache = None
 
969
        self._master_branch_cache = None
862
970
        self._merge_sorted_revisions_cache = None
863
971
        self._partial_revision_history_cache = []
864
972
        self._partial_revision_id_to_revno_cache = {}
 
973
        self._tags_bytes = None
865
974
 
866
975
    def _gen_revision_history(self):
867
976
        """Return sequence of revision hashes on to this branch.
917
1026
        :return: A tuple (revno, revision_id).
918
1027
        """
919
1028
        if self._last_revision_info_cache is None:
920
 
            self._last_revision_info_cache = self._last_revision_info()
 
1029
            self._last_revision_info_cache = self._read_last_revision_info()
921
1030
        return self._last_revision_info_cache
922
1031
 
923
 
    def _last_revision_info(self):
924
 
        rh = self.revision_history()
925
 
        revno = len(rh)
926
 
        if revno:
927
 
            return (revno, rh[-1])
928
 
        else:
929
 
            return (0, _mod_revision.NULL_REVISION)
930
 
 
931
 
    @deprecated_method(deprecated_in((1, 6, 0)))
932
 
    def missing_revisions(self, other, stop_revision=None):
933
 
        """Return a list of new revisions that would perfectly fit.
934
 
 
935
 
        If self and other have not diverged, return a list of the revisions
936
 
        present in other, but missing from self.
937
 
        """
938
 
        self_history = self.revision_history()
939
 
        self_len = len(self_history)
940
 
        other_history = other.revision_history()
941
 
        other_len = len(other_history)
942
 
        common_index = min(self_len, other_len) -1
943
 
        if common_index >= 0 and \
944
 
            self_history[common_index] != other_history[common_index]:
945
 
            raise errors.DivergedBranches(self, other)
946
 
 
947
 
        if stop_revision is None:
948
 
            stop_revision = other_len
949
 
        else:
950
 
            if stop_revision > other_len:
951
 
                raise errors.NoSuchRevision(self, stop_revision)
952
 
        return other_history[self_len:stop_revision]
953
 
 
954
 
    @needs_write_lock
955
 
    def update_revisions(self, other, stop_revision=None, overwrite=False,
956
 
                         graph=None):
957
 
        """Pull in new perfect-fit revisions.
958
 
 
959
 
        :param other: Another Branch to pull from
960
 
        :param stop_revision: Updated until the given revision
961
 
        :param overwrite: Always set the branch pointer, rather than checking
962
 
            to see if it is a proper descendant.
963
 
        :param graph: A Graph object that can be used to query history
964
 
            information. This can be None.
965
 
        :return: None
966
 
        """
967
 
        return InterBranch.get(other, self).update_revisions(stop_revision,
968
 
            overwrite, graph)
969
 
 
 
1032
    def _read_last_revision_info(self):
 
1033
        raise NotImplementedError(self._read_last_revision_info)
 
1034
 
 
1035
    @deprecated_method(deprecated_in((2, 4, 0)))
970
1036
    def import_last_revision_info(self, source_repo, revno, revid):
971
1037
        """Set the last revision info, importing from another repo if necessary.
972
1038
 
973
 
        This is used by the bound branch code to upload a revision to
974
 
        the master branch first before updating the tip of the local branch.
975
 
 
976
1039
        :param source_repo: Source repository to optionally fetch from
977
1040
        :param revno: Revision number of the new tip
978
1041
        :param revid: Revision id of the new tip
981
1044
            self.repository.fetch(source_repo, revision_id=revid)
982
1045
        self.set_last_revision_info(revno, revid)
983
1046
 
 
1047
    def import_last_revision_info_and_tags(self, source, revno, revid,
 
1048
                                           lossy=False):
 
1049
        """Set the last revision info, importing from another repo if necessary.
 
1050
 
 
1051
        This is used by the bound branch code to upload a revision to
 
1052
        the master branch first before updating the tip of the local branch.
 
1053
        Revisions referenced by source's tags are also transferred.
 
1054
 
 
1055
        :param source: Source branch to optionally fetch from
 
1056
        :param revno: Revision number of the new tip
 
1057
        :param revid: Revision id of the new tip
 
1058
        :param lossy: Whether to discard metadata that can not be
 
1059
            natively represented
 
1060
        :return: Tuple with the new revision number and revision id
 
1061
            (should only be different from the arguments when lossy=True)
 
1062
        """
 
1063
        if not self.repository.has_same_location(source.repository):
 
1064
            self.fetch(source, revid)
 
1065
        self.set_last_revision_info(revno, revid)
 
1066
        return (revno, revid)
 
1067
 
984
1068
    def revision_id_to_revno(self, revision_id):
985
1069
        """Given a revision id, return its revno"""
986
1070
        if _mod_revision.is_null(revision_id):
1006
1090
            self._extend_partial_history(distance_from_last)
1007
1091
        return self._partial_revision_history_cache[distance_from_last]
1008
1092
 
1009
 
    @needs_write_lock
1010
1093
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1094
             possible_transports=None, *args, **kwargs):
1012
1095
        """Mirror source into this branch.
1208
1291
        return result
1209
1292
 
1210
1293
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1294
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1295
            repository=None):
1212
1296
        """Create a new line of development from the branch, into to_bzrdir.
1213
1297
 
1214
1298
        to_bzrdir controls the branch format.
1219
1303
        if (repository_policy is not None and
1220
1304
            repository_policy.requires_stacking()):
1221
1305
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
 
        result = to_bzrdir.create_branch()
 
1306
        result = to_bzrdir.create_branch(repository=repository)
1223
1307
        result.lock_write()
1224
1308
        try:
1225
1309
            if repository_policy is not None:
1226
1310
                repository_policy.configure_branch(result)
1227
1311
            self.copy_content_into(result, revision_id=revision_id)
1228
 
            result.set_parent(self.bzrdir.root_transport.base)
 
1312
            master_branch = self.get_master_branch()
 
1313
            if master_branch is None:
 
1314
                result.set_parent(self.bzrdir.root_transport.base)
 
1315
            else:
 
1316
                result.set_parent(master_branch.bzrdir.root_transport.base)
1229
1317
        finally:
1230
1318
            result.unlock()
1231
1319
        return result
1255
1343
                revno = 1
1256
1344
        destination.set_last_revision_info(revno, revision_id)
1257
1345
 
1258
 
    @needs_read_lock
1259
1346
    def copy_content_into(self, destination, revision_id=None):
1260
1347
        """Copy the content of self into destination.
1261
1348
 
1262
1349
        revision_id: if not None, the revision history in the new branch will
1263
1350
                     be truncated to end with revision_id.
1264
1351
        """
1265
 
        self.update_references(destination)
1266
 
        self._synchronize_history(destination, revision_id)
1267
 
        try:
1268
 
            parent = self.get_parent()
1269
 
        except errors.InaccessibleParent, e:
1270
 
            mutter('parent was not accessible to copy: %s', e)
1271
 
        else:
1272
 
            if parent:
1273
 
                destination.set_parent(parent)
1274
 
        if self._push_should_merge_tags():
1275
 
            self.tags.merge_to(destination.tags)
 
1352
        return InterBranch.get(self, destination).copy_content_into(
 
1353
            revision_id=revision_id)
1276
1354
 
1277
1355
    def update_references(self, target):
1278
1356
        if not getattr(self._format, 'supports_reference_locations', False):
1323
1401
        """Return the most suitable metadir for a checkout of this branch.
1324
1402
        Weaves are used if this branch's repository uses weaves.
1325
1403
        """
1326
 
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1327
 
            from bzrlib.repofmt import weaverepo
1328
 
            format = bzrdir.BzrDirMetaFormat1()
1329
 
            format.repository_format = weaverepo.RepositoryFormat7()
1330
 
        else:
1331
 
            format = self.repository.bzrdir.checkout_metadir()
1332
 
            format.set_branch_format(self._format)
 
1404
        format = self.repository.bzrdir.checkout_metadir()
 
1405
        format.set_branch_format(self._format)
1333
1406
        return format
1334
1407
 
1335
1408
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1409
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1410
        no_tree=None):
1337
1411
        """Create a clone of this branch and its bzrdir.
1338
1412
 
1339
1413
        :param to_transport: The transport to clone onto.
1346
1420
        """
1347
1421
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1422
        # clone call. Or something. 20090224 RBC/spiv.
 
1423
        # XXX: Should this perhaps clone colocated branches as well, 
 
1424
        # rather than just the default branch? 20100319 JRV
1349
1425
        if revision_id is None:
1350
1426
            revision_id = self.last_revision()
1351
1427
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
1428
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1429
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1430
            no_tree=no_tree)
1354
1431
        return dir_to.open_branch()
1355
1432
 
1356
1433
    def create_checkout(self, to_location, revision_id=None,
1471
1548
        else:
1472
1549
            raise AssertionError("invalid heads: %r" % (heads,))
1473
1550
 
1474
 
 
1475
 
class BranchFormat(object):
 
1551
    def heads_to_fetch(self):
 
1552
        """Return the heads that must and that should be fetched to copy this
 
1553
        branch into another repo.
 
1554
 
 
1555
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1556
            set of heads that must be fetched.  if_present_fetch is a set of
 
1557
            heads that must be fetched if present, but no error is necessary if
 
1558
            they are not present.
 
1559
        """
 
1560
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
 
1561
        # are the tags.
 
1562
        must_fetch = set([self.last_revision()])
 
1563
        try:
 
1564
            if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1565
        except errors.TagsNotSupported:
 
1566
            if_present_fetch = set()
 
1567
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1568
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1569
        return must_fetch, if_present_fetch
 
1570
 
 
1571
 
 
1572
class BranchFormat(controldir.ControlComponentFormat):
1476
1573
    """An encapsulation of the initialization and open routines for a format.
1477
1574
 
1478
1575
    Formats provide three things:
1481
1578
     * an open routine.
1482
1579
 
1483
1580
    Formats are placed in an dict by their format string for reference
1484
 
    during branch opening. Its not required that these be instances, they
 
1581
    during branch opening. It's not required that these be instances, they
1485
1582
    can be classes themselves with class methods - it simply depends on
1486
1583
    whether state is needed for a given format or not.
1487
1584
 
1490
1587
    object will be created every time regardless.
1491
1588
    """
1492
1589
 
1493
 
    _default_format = None
1494
 
    """The default format used for new branches."""
1495
 
 
1496
 
    _formats = {}
1497
 
    """The known formats."""
1498
 
 
1499
1590
    can_set_append_revisions_only = True
1500
1591
 
1501
1592
    def __eq__(self, other):
1510
1601
        try:
1511
1602
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
1603
            format_string = transport.get_bytes("format")
1513
 
            return klass._formats[format_string]
 
1604
            return format_registry.get(format_string)
1514
1605
        except errors.NoSuchFile:
1515
1606
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1516
1607
        except KeyError:
1517
1608
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1609
 
1519
1610
    @classmethod
 
1611
    @deprecated_method(deprecated_in((2, 4, 0)))
1520
1612
    def get_default_format(klass):
1521
1613
        """Return the current default format."""
1522
 
        return klass._default_format
1523
 
 
1524
 
    def get_reference(self, a_bzrdir):
 
1614
        return format_registry.get_default()
 
1615
 
 
1616
    @classmethod
 
1617
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1618
    def get_formats(klass):
 
1619
        """Get all the known formats.
 
1620
 
 
1621
        Warning: This triggers a load of all lazy registered formats: do not
 
1622
        use except when that is desireed.
 
1623
        """
 
1624
        return format_registry._get_all()
 
1625
 
 
1626
    def get_reference(self, a_bzrdir, name=None):
1525
1627
        """Get the target reference of the branch in a_bzrdir.
1526
1628
 
1527
1629
        format probing must have been completed before calling
1529
1631
        in a_bzrdir is correct.
1530
1632
 
1531
1633
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1634
        :param name: Name of the colocated branch to fetch
1532
1635
        :return: None if the branch is not a reference branch.
1533
1636
        """
1534
1637
        return None
1535
1638
 
1536
1639
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
 
1640
    def set_reference(self, a_bzrdir, name, to_branch):
1538
1641
        """Set the target reference of the branch in a_bzrdir.
1539
1642
 
1540
1643
        format probing must have been completed before calling
1542
1645
        in a_bzrdir is correct.
1543
1646
 
1544
1647
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1648
        :param name: Name of colocated branch to set, None for default
1545
1649
        :param to_branch: branch that the checkout is to reference
1546
1650
        """
1547
1651
        raise NotImplementedError(self.set_reference)
1562
1666
        for hook in hooks:
1563
1667
            hook(params)
1564
1668
 
1565
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
 
                           lock_type='metadir', set_format=True):
1567
 
        """Initialize a branch in a bzrdir, with specified files
1568
 
 
1569
 
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
 
        :param utf8_files: The files to create as a list of
1571
 
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
 
        :param set_format: If True, set the format with
1574
 
            self.get_format_string.  (BzrBranch4 has its format set
1575
 
            elsewhere)
1576
 
        :return: a branch in this format
1577
 
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1580
 
        lock_map = {
1581
 
            'metadir': ('lock', lockdir.LockDir),
1582
 
            'branch4': ('branch-lock', lockable_files.TransportLock),
1583
 
        }
1584
 
        lock_name, lock_class = lock_map[lock_type]
1585
 
        control_files = lockable_files.LockableFiles(branch_transport,
1586
 
            lock_name, lock_class)
1587
 
        control_files.create_lock()
1588
 
        try:
1589
 
            control_files.lock_write()
1590
 
        except errors.LockContention:
1591
 
            if lock_type != 'branch4':
1592
 
                raise
1593
 
            lock_taken = False
1594
 
        else:
1595
 
            lock_taken = True
1596
 
        if set_format:
1597
 
            utf8_files += [('format', self.get_format_string())]
1598
 
        try:
1599
 
            for (filename, content) in utf8_files:
1600
 
                branch_transport.put_bytes(
1601
 
                    filename, content,
1602
 
                    mode=a_bzrdir._get_file_mode())
1603
 
        finally:
1604
 
            if lock_taken:
1605
 
                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
1609
 
 
1610
 
    def initialize(self, a_bzrdir, name=None):
 
1669
    def initialize(self, a_bzrdir, name=None, repository=None):
1611
1670
        """Create a branch of this format in a_bzrdir.
1612
1671
        
1613
1672
        :param name: Name of the colocated branch to create.
1647
1706
        """
1648
1707
        raise NotImplementedError(self.network_name)
1649
1708
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1709
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
1710
            found_repository=None):
1651
1711
        """Return the branch object for a_bzrdir
1652
1712
 
1653
1713
        :param a_bzrdir: A BzrDir that contains a branch.
1660
1720
        raise NotImplementedError(self.open)
1661
1721
 
1662
1722
    @classmethod
 
1723
    @deprecated_method(deprecated_in((2, 4, 0)))
1663
1724
    def register_format(klass, format):
1664
 
        """Register a metadir format."""
1665
 
        klass._formats[format.get_format_string()] = format
1666
 
        # Metadir formats have a network name of their format string, and get
1667
 
        # registered as class factories.
1668
 
        network_format_registry.register(format.get_format_string(), format.__class__)
 
1725
        """Register a metadir format.
 
1726
 
 
1727
        See MetaDirBranchFormatFactory for the ability to register a format
 
1728
        without loading the code the format needs until it is actually used.
 
1729
        """
 
1730
        format_registry.register(format)
1669
1731
 
1670
1732
    @classmethod
 
1733
    @deprecated_method(deprecated_in((2, 4, 0)))
1671
1734
    def set_default_format(klass, format):
1672
 
        klass._default_format = format
 
1735
        format_registry.set_default(format)
1673
1736
 
1674
1737
    def supports_set_append_revisions_only(self):
1675
1738
        """True if this format supports set_append_revisions_only."""
1679
1742
        """True if this format records a stacked-on branch."""
1680
1743
        return False
1681
1744
 
 
1745
    def supports_leaving_lock(self):
 
1746
        """True if this format supports leaving locks in place."""
 
1747
        return False # by default
 
1748
 
1682
1749
    @classmethod
 
1750
    @deprecated_method(deprecated_in((2, 4, 0)))
1683
1751
    def unregister_format(klass, format):
1684
 
        del klass._formats[format.get_format_string()]
 
1752
        format_registry.remove(format)
1685
1753
 
1686
1754
    def __str__(self):
1687
1755
        return self.get_format_description().rstrip()
1691
1759
        return False  # by default
1692
1760
 
1693
1761
 
 
1762
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1763
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1764
    
 
1765
    While none of the built in BranchFormats are lazy registered yet,
 
1766
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1767
    use it, and the bzr-loom plugin uses it as well (see
 
1768
    bzrlib.plugins.loom.formats).
 
1769
    """
 
1770
 
 
1771
    def __init__(self, format_string, module_name, member_name):
 
1772
        """Create a MetaDirBranchFormatFactory.
 
1773
 
 
1774
        :param format_string: The format string the format has.
 
1775
        :param module_name: Module to load the format class from.
 
1776
        :param member_name: Attribute name within the module for the format class.
 
1777
        """
 
1778
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1779
        self._format_string = format_string
 
1780
        
 
1781
    def get_format_string(self):
 
1782
        """See BranchFormat.get_format_string."""
 
1783
        return self._format_string
 
1784
 
 
1785
    def __call__(self):
 
1786
        """Used for network_format_registry support."""
 
1787
        return self.get_obj()()
 
1788
 
 
1789
 
1694
1790
class BranchHooks(Hooks):
1695
1791
    """A dictionary mapping hook name to a list of callables for branch hooks.
1696
1792
 
1704
1800
        These are all empty initially, because by default nothing should get
1705
1801
        notified.
1706
1802
        """
1707
 
        Hooks.__init__(self)
1708
 
        self.create_hook(HookPoint('set_rh',
 
1803
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1804
        self.add_hook('set_rh',
1709
1805
            "Invoked whenever the revision history has been set via "
1710
1806
            "set_revision_history. The api signature is (branch, "
1711
1807
            "revision_history), and the branch will be write-locked. "
1712
1808
            "The set_rh hook can be expensive for bzr to trigger, a better "
1713
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1714
 
        self.create_hook(HookPoint('open',
 
1809
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
 
1810
        self.add_hook('open',
1715
1811
            "Called with the Branch object that has been opened after a "
1716
 
            "branch is opened.", (1, 8), None))
1717
 
        self.create_hook(HookPoint('post_push',
 
1812
            "branch is opened.", (1, 8))
 
1813
        self.add_hook('post_push',
1718
1814
            "Called after a push operation completes. post_push is called "
1719
1815
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
 
            "bzr client.", (0, 15), None))
1721
 
        self.create_hook(HookPoint('post_pull',
 
1816
            "bzr client.", (0, 15))
 
1817
        self.add_hook('post_pull',
1722
1818
            "Called after a pull operation completes. post_pull is called "
1723
1819
            "with a bzrlib.branch.PullResult object and only runs in the "
1724
 
            "bzr client.", (0, 15), None))
1725
 
        self.create_hook(HookPoint('pre_commit',
1726
 
            "Called after a commit is calculated but before it is is "
 
1820
            "bzr client.", (0, 15))
 
1821
        self.add_hook('pre_commit',
 
1822
            "Called after a commit is calculated but before it is "
1727
1823
            "completed. pre_commit is called with (local, master, old_revno, "
1728
1824
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
1825
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1731
1827
            "basis revision. hooks MUST NOT modify this delta. "
1732
1828
            " future_tree is an in-memory tree obtained from "
1733
1829
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
 
            "tree.", (0,91), None))
1735
 
        self.create_hook(HookPoint('post_commit',
 
1830
            "tree.", (0,91))
 
1831
        self.add_hook('post_commit',
1736
1832
            "Called in the bzr client after a commit has completed. "
1737
1833
            "post_commit is called with (local, master, old_revno, old_revid, "
1738
1834
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1739
 
            "commit to a branch.", (0, 15), None))
1740
 
        self.create_hook(HookPoint('post_uncommit',
 
1835
            "commit to a branch.", (0, 15))
 
1836
        self.add_hook('post_uncommit',
1741
1837
            "Called in the bzr client after an uncommit completes. "
1742
1838
            "post_uncommit is called with (local, master, old_revno, "
1743
1839
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
1840
            "or None, master is the target branch, and an empty branch "
1745
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1746
 
        self.create_hook(HookPoint('pre_change_branch_tip',
 
1841
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1842
        self.add_hook('pre_change_branch_tip',
1747
1843
            "Called in bzr client and server before a change to the tip of a "
1748
1844
            "branch is made. pre_change_branch_tip is called with a "
1749
1845
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1750
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1751
 
        self.create_hook(HookPoint('post_change_branch_tip',
 
1846
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1847
        self.add_hook('post_change_branch_tip',
1752
1848
            "Called in bzr client and server after a change to the tip of a "
1753
1849
            "branch is made. post_change_branch_tip is called with a "
1754
1850
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1755
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1756
 
        self.create_hook(HookPoint('transform_fallback_location',
 
1851
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1852
        self.add_hook('transform_fallback_location',
1757
1853
            "Called when a stacked branch is activating its fallback "
1758
1854
            "locations. transform_fallback_location is called with (branch, "
1759
1855
            "url), and should return a new url. Returning the same url "
1764
1860
            "fallback locations have not been activated. When there are "
1765
1861
            "multiple hooks installed for transform_fallback_location, "
1766
1862
            "all are called with the url returned from the previous hook."
1767
 
            "The order is however undefined.", (1, 9), None))
1768
 
        self.create_hook(HookPoint('automatic_tag_name',
1769
 
            "Called to determine an automatic tag name for a revision."
 
1863
            "The order is however undefined.", (1, 9))
 
1864
        self.add_hook('automatic_tag_name',
 
1865
            "Called to determine an automatic tag name for a revision. "
1770
1866
            "automatic_tag_name is called with (branch, revision_id) and "
1771
1867
            "should return a tag name or None if no tag name could be "
1772
1868
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
 
1869
            (2, 2))
 
1870
        self.add_hook('post_branch_init',
1775
1871
            "Called after new branch initialization completes. "
1776
1872
            "post_branch_init is called with a "
1777
1873
            "bzrlib.branch.BranchInitHookParams. "
1778
1874
            "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',
 
1875
            "lightweight) will all trigger this hook.", (2, 2))
 
1876
        self.add_hook('post_switch',
1781
1877
            "Called after a checkout switches branch. "
1782
1878
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1879
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1784
1880
 
1785
1881
 
1786
1882
 
1863
1959
        return self.__dict__ == other.__dict__
1864
1960
 
1865
1961
    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)
 
1962
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1872
1963
 
1873
1964
 
1874
1965
class SwitchHookParams(object):
1904
1995
            self.revision_id)
1905
1996
 
1906
1997
 
1907
 
class BzrBranchFormat4(BranchFormat):
1908
 
    """Bzr branch format 4.
1909
 
 
1910
 
    This format has:
1911
 
     - a revision-history file.
1912
 
     - a branch-lock lock file [ to be shared with the bzrdir ]
1913
 
    """
1914
 
 
1915
 
    def get_format_description(self):
1916
 
        """See BranchFormat.get_format_description()."""
1917
 
        return "Branch format 4"
1918
 
 
1919
 
    def initialize(self, a_bzrdir, name=None):
1920
 
        """Create a branch of this format in a_bzrdir."""
1921
 
        utf8_files = [('revision-history', ''),
1922
 
                      ('branch-name', ''),
1923
 
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1925
 
                                       lock_type='branch4', set_format=False)
1926
 
 
1927
 
    def __init__(self):
1928
 
        super(BzrBranchFormat4, self).__init__()
1929
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1930
 
 
1931
 
    def network_name(self):
1932
 
        """The network name for this format is the control dirs disk label."""
1933
 
        return self._matchingbzrdir.get_format_string()
1934
 
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1936
 
        """See BranchFormat.open()."""
1937
 
        if not _found:
1938
 
            # we are being called directly and must probe.
1939
 
            raise NotImplementedError
1940
 
        return BzrBranch(_format=self,
1941
 
                         _control_files=a_bzrdir._control_files,
1942
 
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
 
                         _repository=a_bzrdir.open_repository())
1945
 
 
1946
 
    def __str__(self):
1947
 
        return "Bazaar-NG branch format 4"
1948
 
 
1949
 
 
1950
1998
class BranchFormatMetadir(BranchFormat):
1951
1999
    """Common logic for meta-dir based branch formats."""
1952
2000
 
1954
2002
        """What class to instantiate on open calls."""
1955
2003
        raise NotImplementedError(self._branch_class)
1956
2004
 
 
2005
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
2006
                           repository=None):
 
2007
        """Initialize a branch in a bzrdir, with specified files
 
2008
 
 
2009
        :param a_bzrdir: The bzrdir to initialize the branch in
 
2010
        :param utf8_files: The files to create as a list of
 
2011
            (filename, content) tuples
 
2012
        :param name: Name of colocated branch to create, if any
 
2013
        :return: a branch in this format
 
2014
        """
 
2015
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
2016
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
2017
        control_files = lockable_files.LockableFiles(branch_transport,
 
2018
            'lock', lockdir.LockDir)
 
2019
        control_files.create_lock()
 
2020
        control_files.lock_write()
 
2021
        try:
 
2022
            utf8_files += [('format', self.get_format_string())]
 
2023
            for (filename, content) in utf8_files:
 
2024
                branch_transport.put_bytes(
 
2025
                    filename, content,
 
2026
                    mode=a_bzrdir._get_file_mode())
 
2027
        finally:
 
2028
            control_files.unlock()
 
2029
        branch = self.open(a_bzrdir, name, _found=True,
 
2030
                found_repository=repository)
 
2031
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2032
        return branch
 
2033
 
1957
2034
    def network_name(self):
1958
2035
        """A simple byte string uniquely identifying this format for RPC calls.
1959
2036
 
1961
2038
        """
1962
2039
        return self.get_format_string()
1963
2040
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2041
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2042
            found_repository=None):
1965
2043
        """See BranchFormat.open()."""
1966
2044
        if not _found:
1967
2045
            format = BranchFormat.find_format(a_bzrdir, name=name)
1972
2050
        try:
1973
2051
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
2052
                                                         lockdir.LockDir)
 
2053
            if found_repository is None:
 
2054
                found_repository = a_bzrdir.find_repository()
1975
2055
            return self._branch_class()(_format=self,
1976
2056
                              _control_files=control_files,
1977
2057
                              name=name,
1978
2058
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
 
2059
                              _repository=found_repository,
1980
2060
                              ignore_fallbacks=ignore_fallbacks)
1981
2061
        except errors.NoSuchFile:
1982
2062
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1989
2069
    def supports_tags(self):
1990
2070
        return True
1991
2071
 
 
2072
    def supports_leaving_lock(self):
 
2073
        return True
 
2074
 
1992
2075
 
1993
2076
class BzrBranchFormat5(BranchFormatMetadir):
1994
2077
    """Bzr branch format 5.
2014
2097
        """See BranchFormat.get_format_description()."""
2015
2098
        return "Branch format 5"
2016
2099
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
2100
    def initialize(self, a_bzrdir, name=None, repository=None):
2018
2101
        """Create a branch of this format in a_bzrdir."""
2019
2102
        utf8_files = [('revision-history', ''),
2020
2103
                      ('branch-name', ''),
2021
2104
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2105
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2023
2106
 
2024
2107
    def supports_tags(self):
2025
2108
        return False
2047
2130
        """See BranchFormat.get_format_description()."""
2048
2131
        return "Branch format 6"
2049
2132
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
2133
    def initialize(self, a_bzrdir, name=None, repository=None):
2051
2134
        """Create a branch of this format in a_bzrdir."""
2052
2135
        utf8_files = [('last-revision', '0 null:\n'),
2053
2136
                      ('branch.conf', ''),
2054
2137
                      ('tags', ''),
2055
2138
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2139
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2057
2140
 
2058
2141
    def make_tags(self, branch):
2059
2142
        """See bzrlib.branch.BranchFormat.make_tags()."""
2077
2160
        """See BranchFormat.get_format_description()."""
2078
2161
        return "Branch format 8"
2079
2162
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
2163
    def initialize(self, a_bzrdir, name=None, repository=None):
2081
2164
        """Create a branch of this format in a_bzrdir."""
2082
2165
        utf8_files = [('last-revision', '0 null:\n'),
2083
2166
                      ('branch.conf', ''),
2084
2167
                      ('tags', ''),
2085
2168
                      ('references', '')
2086
2169
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2088
 
 
2089
 
    def __init__(self):
2090
 
        super(BzrBranchFormat8, self).__init__()
2091
 
        self._matchingbzrdir.repository_format = \
2092
 
            RepositoryFormatKnitPack5RichRoot()
 
2170
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2093
2171
 
2094
2172
    def make_tags(self, branch):
2095
2173
        """See bzrlib.branch.BranchFormat.make_tags()."""
2104
2182
    supports_reference_locations = True
2105
2183
 
2106
2184
 
2107
 
class BzrBranchFormat7(BzrBranchFormat8):
 
2185
class BzrBranchFormat7(BranchFormatMetadir):
2108
2186
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
2187
 
2110
2188
    The stacked location pointer is passed down to the repository and requires
2113
2191
    This format was introduced in bzr 1.6.
2114
2192
    """
2115
2193
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
2194
    def initialize(self, a_bzrdir, name=None, repository=None):
2117
2195
        """Create a branch of this format in a_bzrdir."""
2118
2196
        utf8_files = [('last-revision', '0 null:\n'),
2119
2197
                      ('branch.conf', ''),
2120
2198
                      ('tags', ''),
2121
2199
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2200
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2123
2201
 
2124
2202
    def _branch_class(self):
2125
2203
        return BzrBranch7
2135
2213
    def supports_set_append_revisions_only(self):
2136
2214
        return True
2137
2215
 
 
2216
    def supports_stacking(self):
 
2217
        return True
 
2218
 
 
2219
    def make_tags(self, branch):
 
2220
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2221
        return BasicTags(branch)
 
2222
 
2138
2223
    supports_reference_locations = False
2139
2224
 
2140
2225
 
2157
2242
        """See BranchFormat.get_format_description()."""
2158
2243
        return "Checkout reference format 1"
2159
2244
 
2160
 
    def get_reference(self, a_bzrdir):
 
2245
    def get_reference(self, a_bzrdir, name=None):
2161
2246
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2247
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2248
        return transport.get_bytes('location')
2164
2249
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2250
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2251
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2252
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2253
        location = transport.put_bytes('location', to_branch.base)
2169
2254
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2255
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2256
            repository=None):
2171
2257
        """Create a branch of this format in a_bzrdir."""
2172
2258
        if target_branch is None:
2173
2259
            # this format does not implement branch itself, thus the implicit
2201
2287
        return clone
2202
2288
 
2203
2289
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
2290
             possible_transports=None, ignore_fallbacks=False,
 
2291
             found_repository=None):
2205
2292
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2293
 
2207
2294
        :param a_bzrdir: A BzrDir that contains a branch.
2221
2308
                raise AssertionError("wrong format %r found for %r" %
2222
2309
                    (format, self))
2223
2310
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
 
2311
            location = self.get_reference(a_bzrdir, name)
2225
2312
        real_bzrdir = bzrdir.BzrDir.open(
2226
2313
            location, possible_transports=possible_transports)
2227
2314
        result = real_bzrdir.open_branch(name=name, 
2238
2325
        return result
2239
2326
 
2240
2327
 
 
2328
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2329
    """Branch format registry."""
 
2330
 
 
2331
    def __init__(self, other_registry=None):
 
2332
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2333
        self._default_format = None
 
2334
 
 
2335
    def set_default(self, format):
 
2336
        self._default_format = format
 
2337
 
 
2338
    def get_default(self):
 
2339
        return self._default_format
 
2340
 
 
2341
 
2241
2342
network_format_registry = registry.FormatRegistry()
2242
2343
"""Registry of formats indexed by their network name.
2243
2344
 
2246
2347
BranchFormat.network_name() for more detail.
2247
2348
"""
2248
2349
 
 
2350
format_registry = BranchFormatRegistry(network_format_registry)
 
2351
 
2249
2352
 
2250
2353
# formats which have no format string are not discoverable
2251
2354
# and not independently creatable, so are not registered.
2253
2356
__format6 = BzrBranchFormat6()
2254
2357
__format7 = BzrBranchFormat7()
2255
2358
__format8 = BzrBranchFormat8()
2256
 
BranchFormat.register_format(__format5)
2257
 
BranchFormat.register_format(BranchReferenceFormat())
2258
 
BranchFormat.register_format(__format6)
2259
 
BranchFormat.register_format(__format7)
2260
 
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
2262
 
_legacy_formats = [BzrBranchFormat4(),
2263
 
    ]
2264
 
network_format_registry.register(
2265
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
 
2359
format_registry.register(__format5)
 
2360
format_registry.register(BranchReferenceFormat())
 
2361
format_registry.register(__format6)
 
2362
format_registry.register(__format7)
 
2363
format_registry.register(__format8)
 
2364
format_registry.set_default(__format7)
 
2365
 
 
2366
 
 
2367
class BranchWriteLockResult(LogicalLockResult):
 
2368
    """The result of write locking a branch.
 
2369
 
 
2370
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2371
        None.
 
2372
    :ivar unlock: A callable which will unlock the lock.
 
2373
    """
 
2374
 
 
2375
    def __init__(self, unlock, branch_token):
 
2376
        LogicalLockResult.__init__(self, unlock)
 
2377
        self.branch_token = branch_token
 
2378
 
 
2379
    def __repr__(self):
 
2380
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2381
            self.unlock)
2266
2382
 
2267
2383
 
2268
2384
class BzrBranch(Branch, _RelockDebugMixin):
2324
2440
        return self.control_files.is_locked()
2325
2441
 
2326
2442
    def lock_write(self, token=None):
 
2443
        """Lock the branch for write operations.
 
2444
 
 
2445
        :param token: A token to permit reacquiring a previously held and
 
2446
            preserved lock.
 
2447
        :return: A BranchWriteLockResult.
 
2448
        """
2327
2449
        if not self.is_locked():
2328
2450
            self._note_lock('w')
2329
2451
        # All-in-one needs to always unlock/lock.
2335
2457
        else:
2336
2458
            took_lock = False
2337
2459
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2460
            return BranchWriteLockResult(self.unlock,
 
2461
                self.control_files.lock_write(token=token))
2339
2462
        except:
2340
2463
            if took_lock:
2341
2464
                self.repository.unlock()
2342
2465
            raise
2343
2466
 
2344
2467
    def lock_read(self):
 
2468
        """Lock the branch for read operations.
 
2469
 
 
2470
        :return: A bzrlib.lock.LogicalLockResult.
 
2471
        """
2345
2472
        if not self.is_locked():
2346
2473
            self._note_lock('r')
2347
2474
        # All-in-one needs to always unlock/lock.
2354
2481
            took_lock = False
2355
2482
        try:
2356
2483
            self.control_files.lock_read()
 
2484
            return LogicalLockResult(self.unlock)
2357
2485
        except:
2358
2486
            if took_lock:
2359
2487
                self.repository.unlock()
2387
2515
        """See Branch.print_file."""
2388
2516
        return self.repository.print_file(file, revision_id)
2389
2517
 
2390
 
    def _write_revision_history(self, history):
2391
 
        """Factored out of set_revision_history.
2392
 
 
2393
 
        This performs the actual writing to disk.
2394
 
        It is intended to be called by BzrBranch5.set_revision_history."""
2395
 
        self._transport.put_bytes(
2396
 
            'revision-history', '\n'.join(history),
2397
 
            mode=self.bzrdir._get_file_mode())
2398
 
 
2399
 
    @needs_write_lock
2400
 
    def set_revision_history(self, rev_history):
2401
 
        """See Branch.set_revision_history."""
2402
 
        if 'evil' in debug.debug_flags:
2403
 
            mutter_callsite(3, "set_revision_history scales with history.")
2404
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2405
 
        for rev_id in rev_history:
2406
 
            check_not_reserved_id(rev_id)
2407
 
        if Branch.hooks['post_change_branch_tip']:
2408
 
            # Don't calculate the last_revision_info() if there are no hooks
2409
 
            # that will use it.
2410
 
            old_revno, old_revid = self.last_revision_info()
2411
 
        if len(rev_history) == 0:
2412
 
            revid = _mod_revision.NULL_REVISION
2413
 
        else:
2414
 
            revid = rev_history[-1]
2415
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2416
 
        self._write_revision_history(rev_history)
2417
 
        self._clear_cached_state()
2418
 
        self._cache_revision_history(rev_history)
2419
 
        for hook in Branch.hooks['set_rh']:
2420
 
            hook(self, rev_history)
2421
 
        if Branch.hooks['post_change_branch_tip']:
2422
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2423
 
 
2424
 
    def _synchronize_history(self, destination, revision_id):
2425
 
        """Synchronize last revision and revision history between branches.
2426
 
 
2427
 
        This version is most efficient when the destination is also a
2428
 
        BzrBranch5, but works for BzrBranch6 as long as the revision
2429
 
        history is the true lefthand parent history, and all of the revisions
2430
 
        are in the destination's repository.  If not, set_revision_history
2431
 
        will fail.
2432
 
 
2433
 
        :param destination: The branch to copy the history into
2434
 
        :param revision_id: The revision-id to truncate history at.  May
2435
 
          be None to copy complete history.
2436
 
        """
2437
 
        if not isinstance(destination._format, BzrBranchFormat5):
2438
 
            super(BzrBranch, self)._synchronize_history(
2439
 
                destination, revision_id)
2440
 
            return
2441
 
        if revision_id == _mod_revision.NULL_REVISION:
2442
 
            new_history = []
2443
 
        else:
2444
 
            new_history = self.revision_history()
2445
 
        if revision_id is not None and new_history != []:
2446
 
            try:
2447
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2448
 
            except ValueError:
2449
 
                rev = self.repository.get_revision(revision_id)
2450
 
                new_history = rev.get_history(self.repository)[1:]
2451
 
        destination.set_revision_history(new_history)
2452
 
 
2453
2518
    @needs_write_lock
2454
2519
    def set_last_revision_info(self, revno, revision_id):
2455
 
        """Set the last revision of this branch.
2456
 
 
2457
 
        The caller is responsible for checking that the revno is correct
2458
 
        for this revision id.
2459
 
 
2460
 
        It may be possible to set the branch last revision to an id not
2461
 
        present in the repository.  However, branches can also be
2462
 
        configured to check constraints on history, in which case this may not
2463
 
        be permitted.
2464
 
        """
 
2520
        if not revision_id or not isinstance(revision_id, basestring):
 
2521
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2465
2522
        revision_id = _mod_revision.ensure_null(revision_id)
2466
 
        # this old format stores the full history, but this api doesn't
2467
 
        # provide it, so we must generate, and might as well check it's
2468
 
        # correct
2469
 
        history = self._lefthand_history(revision_id)
2470
 
        if len(history) != revno:
2471
 
            raise AssertionError('%d != %d' % (len(history), revno))
2472
 
        self.set_revision_history(history)
2473
 
 
2474
 
    def _gen_revision_history(self):
2475
 
        history = self._transport.get_bytes('revision-history').split('\n')
2476
 
        if history[-1:] == ['']:
2477
 
            # There shouldn't be a trailing newline, but just in case.
2478
 
            history.pop()
2479
 
        return history
2480
 
 
2481
 
    @needs_write_lock
2482
 
    def generate_revision_history(self, revision_id, last_rev=None,
2483
 
        other_branch=None):
2484
 
        """Create a new revision history that will finish with revision_id.
2485
 
 
2486
 
        :param revision_id: the new tip to use.
2487
 
        :param last_rev: The previous last_revision. If not None, then this
2488
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
2489
 
        :param other_branch: The other branch that DivergedBranches should
2490
 
            raise with respect to.
2491
 
        """
2492
 
        self.set_revision_history(self._lefthand_history(revision_id,
2493
 
            last_rev, other_branch))
 
2523
        old_revno, old_revid = self.last_revision_info()
 
2524
        if self._get_append_revisions_only():
 
2525
            self._check_history_violation(revision_id)
 
2526
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2527
        self._write_last_revision_info(revno, revision_id)
 
2528
        self._clear_cached_state()
 
2529
        self._last_revision_info_cache = revno, revision_id
 
2530
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2494
2531
 
2495
2532
    def basis_tree(self):
2496
2533
        """See Branch.basis_tree."""
2505
2542
                pass
2506
2543
        return None
2507
2544
 
2508
 
    def _basic_push(self, target, overwrite, stop_revision):
2509
 
        """Basic implementation of push without bound branches or hooks.
2510
 
 
2511
 
        Must be called with source read locked and target write locked.
2512
 
        """
2513
 
        result = BranchPushResult()
2514
 
        result.source_branch = self
2515
 
        result.target_branch = target
2516
 
        result.old_revno, result.old_revid = target.last_revision_info()
2517
 
        self.update_references(target)
2518
 
        if result.old_revid != self.last_revision():
2519
 
            # We assume that during 'push' this repository is closer than
2520
 
            # the target.
2521
 
            graph = self.repository.get_graph(target.repository)
2522
 
            target.update_revisions(self, stop_revision,
2523
 
                overwrite=overwrite, graph=graph)
2524
 
        if self._push_should_merge_tags():
2525
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2526
 
                overwrite)
2527
 
        result.new_revno, result.new_revid = target.last_revision_info()
2528
 
        return result
2529
 
 
2530
2545
    def get_stacked_on_url(self):
2531
2546
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2532
2547
 
2543
2558
            self._transport.put_bytes('parent', url + '\n',
2544
2559
                mode=self.bzrdir._get_file_mode())
2545
2560
 
2546
 
 
2547
 
class BzrBranch5(BzrBranch):
2548
 
    """A format 5 branch. This supports new features over plain branches.
2549
 
 
2550
 
    It has support for a master_branch which is the data for bound branches.
2551
 
    """
2552
 
 
2553
 
    def get_bound_location(self):
2554
 
        try:
2555
 
            return self._transport.get_bytes('bound')[:-1]
2556
 
        except errors.NoSuchFile:
2557
 
            return None
2558
 
 
2559
 
    @needs_read_lock
2560
 
    def get_master_branch(self, possible_transports=None):
2561
 
        """Return the branch we are bound to.
2562
 
 
2563
 
        :return: Either a Branch, or None
2564
 
 
2565
 
        This could memoise the branch, but if thats done
2566
 
        it must be revalidated on each new lock.
2567
 
        So for now we just don't memoise it.
2568
 
        # RBC 20060304 review this decision.
2569
 
        """
2570
 
        bound_loc = self.get_bound_location()
2571
 
        if not bound_loc:
2572
 
            return None
2573
 
        try:
2574
 
            return Branch.open(bound_loc,
2575
 
                               possible_transports=possible_transports)
2576
 
        except (errors.NotBranchError, errors.ConnectionError), e:
2577
 
            raise errors.BoundBranchConnectionFailure(
2578
 
                    self, bound_loc, e)
2579
 
 
2580
2561
    @needs_write_lock
2581
 
    def set_bound_location(self, location):
2582
 
        """Set the target where this branch is bound to.
2583
 
 
2584
 
        :param location: URL to the target branch
2585
 
        """
2586
 
        if location:
2587
 
            self._transport.put_bytes('bound', location+'\n',
2588
 
                mode=self.bzrdir._get_file_mode())
2589
 
        else:
2590
 
            try:
2591
 
                self._transport.delete('bound')
2592
 
            except errors.NoSuchFile:
2593
 
                return False
2594
 
            return True
 
2562
    def unbind(self):
 
2563
        """If bound, unbind"""
 
2564
        return self.set_bound_location(None)
2595
2565
 
2596
2566
    @needs_write_lock
2597
2567
    def bind(self, other):
2619
2589
        # history around
2620
2590
        self.set_bound_location(other.base)
2621
2591
 
 
2592
    def get_bound_location(self):
 
2593
        try:
 
2594
            return self._transport.get_bytes('bound')[:-1]
 
2595
        except errors.NoSuchFile:
 
2596
            return None
 
2597
 
 
2598
    @needs_read_lock
 
2599
    def get_master_branch(self, possible_transports=None):
 
2600
        """Return the branch we are bound to.
 
2601
 
 
2602
        :return: Either a Branch, or None
 
2603
        """
 
2604
        if self._master_branch_cache is None:
 
2605
            self._master_branch_cache = self._get_master_branch(
 
2606
                possible_transports)
 
2607
        return self._master_branch_cache
 
2608
 
 
2609
    def _get_master_branch(self, possible_transports):
 
2610
        bound_loc = self.get_bound_location()
 
2611
        if not bound_loc:
 
2612
            return None
 
2613
        try:
 
2614
            return Branch.open(bound_loc,
 
2615
                               possible_transports=possible_transports)
 
2616
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2617
            raise errors.BoundBranchConnectionFailure(
 
2618
                    self, bound_loc, e)
 
2619
 
2622
2620
    @needs_write_lock
2623
 
    def unbind(self):
2624
 
        """If bound, unbind"""
2625
 
        return self.set_bound_location(None)
 
2621
    def set_bound_location(self, location):
 
2622
        """Set the target where this branch is bound to.
 
2623
 
 
2624
        :param location: URL to the target branch
 
2625
        """
 
2626
        self._master_branch_cache = None
 
2627
        if location:
 
2628
            self._transport.put_bytes('bound', location+'\n',
 
2629
                mode=self.bzrdir._get_file_mode())
 
2630
        else:
 
2631
            try:
 
2632
                self._transport.delete('bound')
 
2633
            except errors.NoSuchFile:
 
2634
                return False
 
2635
            return True
2626
2636
 
2627
2637
    @needs_write_lock
2628
2638
    def update(self, possible_transports=None):
2641
2651
            return old_tip
2642
2652
        return None
2643
2653
 
2644
 
 
2645
 
class BzrBranch8(BzrBranch5):
 
2654
    def _read_last_revision_info(self):
 
2655
        revision_string = self._transport.get_bytes('last-revision')
 
2656
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2657
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2658
        revno = int(revno)
 
2659
        return revno, revision_id
 
2660
 
 
2661
    def _write_last_revision_info(self, revno, revision_id):
 
2662
        """Simply write out the revision id, with no checks.
 
2663
 
 
2664
        Use set_last_revision_info to perform this safely.
 
2665
 
 
2666
        Does not update the revision_history cache.
 
2667
        """
 
2668
        revision_id = _mod_revision.ensure_null(revision_id)
 
2669
        out_string = '%d %s\n' % (revno, revision_id)
 
2670
        self._transport.put_bytes('last-revision', out_string,
 
2671
            mode=self.bzrdir._get_file_mode())
 
2672
 
 
2673
 
 
2674
class FullHistoryBzrBranch(BzrBranch):
 
2675
    """Bzr branch which contains the full revision history."""
 
2676
 
 
2677
    @needs_write_lock
 
2678
    def set_last_revision_info(self, revno, revision_id):
 
2679
        if not revision_id or not isinstance(revision_id, basestring):
 
2680
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2681
        revision_id = _mod_revision.ensure_null(revision_id)
 
2682
        # this old format stores the full history, but this api doesn't
 
2683
        # provide it, so we must generate, and might as well check it's
 
2684
        # correct
 
2685
        history = self._lefthand_history(revision_id)
 
2686
        if len(history) != revno:
 
2687
            raise AssertionError('%d != %d' % (len(history), revno))
 
2688
        self._set_revision_history(history)
 
2689
 
 
2690
    def _read_last_revision_info(self):
 
2691
        rh = self.revision_history()
 
2692
        revno = len(rh)
 
2693
        if revno:
 
2694
            return (revno, rh[-1])
 
2695
        else:
 
2696
            return (0, _mod_revision.NULL_REVISION)
 
2697
 
 
2698
    @deprecated_method(deprecated_in((2, 4, 0)))
 
2699
    @needs_write_lock
 
2700
    def set_revision_history(self, rev_history):
 
2701
        """See Branch.set_revision_history."""
 
2702
        self._set_revision_history(rev_history)
 
2703
 
 
2704
    def _set_revision_history(self, rev_history):
 
2705
        if 'evil' in debug.debug_flags:
 
2706
            mutter_callsite(3, "set_revision_history scales with history.")
 
2707
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2708
        for rev_id in rev_history:
 
2709
            check_not_reserved_id(rev_id)
 
2710
        if Branch.hooks['post_change_branch_tip']:
 
2711
            # Don't calculate the last_revision_info() if there are no hooks
 
2712
            # that will use it.
 
2713
            old_revno, old_revid = self.last_revision_info()
 
2714
        if len(rev_history) == 0:
 
2715
            revid = _mod_revision.NULL_REVISION
 
2716
        else:
 
2717
            revid = rev_history[-1]
 
2718
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2719
        self._write_revision_history(rev_history)
 
2720
        self._clear_cached_state()
 
2721
        self._cache_revision_history(rev_history)
 
2722
        for hook in Branch.hooks['set_rh']:
 
2723
            hook(self, rev_history)
 
2724
        if Branch.hooks['post_change_branch_tip']:
 
2725
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2726
 
 
2727
    def _write_revision_history(self, history):
 
2728
        """Factored out of set_revision_history.
 
2729
 
 
2730
        This performs the actual writing to disk.
 
2731
        It is intended to be called by set_revision_history."""
 
2732
        self._transport.put_bytes(
 
2733
            'revision-history', '\n'.join(history),
 
2734
            mode=self.bzrdir._get_file_mode())
 
2735
 
 
2736
    def _gen_revision_history(self):
 
2737
        history = self._transport.get_bytes('revision-history').split('\n')
 
2738
        if history[-1:] == ['']:
 
2739
            # There shouldn't be a trailing newline, but just in case.
 
2740
            history.pop()
 
2741
        return history
 
2742
 
 
2743
    def _synchronize_history(self, destination, revision_id):
 
2744
        if not isinstance(destination, FullHistoryBzrBranch):
 
2745
            super(BzrBranch, self)._synchronize_history(
 
2746
                destination, revision_id)
 
2747
            return
 
2748
        if revision_id == _mod_revision.NULL_REVISION:
 
2749
            new_history = []
 
2750
        else:
 
2751
            new_history = self.revision_history()
 
2752
        if revision_id is not None and new_history != []:
 
2753
            try:
 
2754
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2755
            except ValueError:
 
2756
                rev = self.repository.get_revision(revision_id)
 
2757
                new_history = rev.get_history(self.repository)[1:]
 
2758
        destination._set_revision_history(new_history)
 
2759
 
 
2760
    @needs_write_lock
 
2761
    def generate_revision_history(self, revision_id, last_rev=None,
 
2762
        other_branch=None):
 
2763
        """Create a new revision history that will finish with revision_id.
 
2764
 
 
2765
        :param revision_id: the new tip to use.
 
2766
        :param last_rev: The previous last_revision. If not None, then this
 
2767
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2768
        :param other_branch: The other branch that DivergedBranches should
 
2769
            raise with respect to.
 
2770
        """
 
2771
        self._set_revision_history(self._lefthand_history(revision_id,
 
2772
            last_rev, other_branch))
 
2773
 
 
2774
 
 
2775
class BzrBranch5(FullHistoryBzrBranch):
 
2776
    """A format 5 branch. This supports new features over plain branches.
 
2777
 
 
2778
    It has support for a master_branch which is the data for bound branches.
 
2779
    """
 
2780
 
 
2781
 
 
2782
class BzrBranch8(BzrBranch):
2646
2783
    """A branch that stores tree-reference locations."""
2647
2784
 
2648
2785
    def _open_hook(self):
2674
2811
        self._last_revision_info_cache = None
2675
2812
        self._reference_info = None
2676
2813
 
2677
 
    def _last_revision_info(self):
2678
 
        revision_string = self._transport.get_bytes('last-revision')
2679
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2680
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2681
 
        revno = int(revno)
2682
 
        return revno, revision_id
2683
 
 
2684
 
    def _write_last_revision_info(self, revno, revision_id):
2685
 
        """Simply write out the revision id, with no checks.
2686
 
 
2687
 
        Use set_last_revision_info to perform this safely.
2688
 
 
2689
 
        Does not update the revision_history cache.
2690
 
        Intended to be called by set_last_revision_info and
2691
 
        _write_revision_history.
2692
 
        """
2693
 
        revision_id = _mod_revision.ensure_null(revision_id)
2694
 
        out_string = '%d %s\n' % (revno, revision_id)
2695
 
        self._transport.put_bytes('last-revision', out_string,
2696
 
            mode=self.bzrdir._get_file_mode())
2697
 
 
2698
 
    @needs_write_lock
2699
 
    def set_last_revision_info(self, revno, revision_id):
2700
 
        revision_id = _mod_revision.ensure_null(revision_id)
2701
 
        old_revno, old_revid = self.last_revision_info()
2702
 
        if self._get_append_revisions_only():
2703
 
            self._check_history_violation(revision_id)
2704
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2705
 
        self._write_last_revision_info(revno, revision_id)
2706
 
        self._clear_cached_state()
2707
 
        self._last_revision_info_cache = revno, revision_id
2708
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2709
 
 
2710
 
    def _synchronize_history(self, destination, revision_id):
2711
 
        """Synchronize last revision and revision history between branches.
2712
 
 
2713
 
        :see: Branch._synchronize_history
2714
 
        """
2715
 
        # XXX: The base Branch has a fast implementation of this method based
2716
 
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2717
 
        # that uses set_revision_history.  This class inherits from BzrBranch5,
2718
 
        # but wants the fast implementation, so it calls
2719
 
        # Branch._synchronize_history directly.
2720
 
        Branch._synchronize_history(self, destination, revision_id)
2721
 
 
2722
2814
    def _check_history_violation(self, revision_id):
2723
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
 
2815
        current_revid = self.last_revision()
 
2816
        last_revision = _mod_revision.ensure_null(current_revid)
2724
2817
        if _mod_revision.is_null(last_revision):
2725
2818
            return
2726
 
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2819
        graph = self.repository.get_graph()
 
2820
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
 
2821
            if lh_ancestor == current_revid:
 
2822
                return
 
2823
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
2728
2824
 
2729
2825
    def _gen_revision_history(self):
2730
2826
        """Generate the revision history from last revision
2733
2829
        self._extend_partial_history(stop_index=last_revno-1)
2734
2830
        return list(reversed(self._partial_revision_history_cache))
2735
2831
 
2736
 
    def _write_revision_history(self, history):
2737
 
        """Factored out of set_revision_history.
2738
 
 
2739
 
        This performs the actual writing to disk, with format-specific checks.
2740
 
        It is intended to be called by BzrBranch5.set_revision_history.
2741
 
        """
2742
 
        if len(history) == 0:
2743
 
            last_revision = 'null:'
2744
 
        else:
2745
 
            if history != self._lefthand_history(history[-1]):
2746
 
                raise errors.NotLefthandHistory(history)
2747
 
            last_revision = history[-1]
2748
 
        if self._get_append_revisions_only():
2749
 
            self._check_history_violation(last_revision)
2750
 
        self._write_last_revision_info(len(history), last_revision)
2751
 
 
2752
2832
    @needs_write_lock
2753
2833
    def _set_parent_location(self, url):
2754
2834
        """Set the parent branch"""
2840
2920
 
2841
2921
    def set_bound_location(self, location):
2842
2922
        """See Branch.set_push_location."""
 
2923
        self._master_branch_cache = None
2843
2924
        result = None
2844
2925
        config = self.get_config()
2845
2926
        if location is None:
2885
2966
        return self.get_config(
2886
2967
            ).get_user_option_as_bool('append_revisions_only')
2887
2968
 
2888
 
    @needs_write_lock
2889
 
    def generate_revision_history(self, revision_id, last_rev=None,
2890
 
                                  other_branch=None):
2891
 
        """See BzrBranch5.generate_revision_history"""
2892
 
        history = self._lefthand_history(revision_id, last_rev, other_branch)
2893
 
        revno = len(history)
2894
 
        self.set_last_revision_info(revno, revision_id)
2895
 
 
2896
2969
    @needs_read_lock
2897
2970
    def get_rev_id(self, revno, history=None):
2898
2971
        """Find the revision id of the specified revno."""
2922
2995
        try:
2923
2996
            index = self._partial_revision_history_cache.index(revision_id)
2924
2997
        except ValueError:
2925
 
            self._extend_partial_history(stop_revision=revision_id)
 
2998
            try:
 
2999
                self._extend_partial_history(stop_revision=revision_id)
 
3000
            except errors.RevisionNotPresent, e:
 
3001
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2926
3002
            index = len(self._partial_revision_history_cache) - 1
2927
3003
            if self._partial_revision_history_cache[index] != revision_id:
2928
3004
                raise errors.NoSuchRevision(self, revision_id)
2983
3059
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2984
3060
    """
2985
3061
 
 
3062
    @deprecated_method(deprecated_in((2, 3, 0)))
2986
3063
    def __int__(self):
2987
 
        # DEPRECATED: pull used to return the change in revno
 
3064
        """Return the relative change in revno.
 
3065
 
 
3066
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3067
        """
2988
3068
        return self.new_revno - self.old_revno
2989
3069
 
2990
3070
    def report(self, to_file):
3015
3095
        target, otherwise it will be None.
3016
3096
    """
3017
3097
 
 
3098
    @deprecated_method(deprecated_in((2, 3, 0)))
3018
3099
    def __int__(self):
3019
 
        # DEPRECATED: push used to return the change in revno
 
3100
        """Return the relative change in revno.
 
3101
 
 
3102
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3103
        """
3020
3104
        return self.new_revno - self.old_revno
3021
3105
 
3022
3106
    def report(self, to_file):
3145
3229
    _optimisers = []
3146
3230
    """The available optimised InterBranch types."""
3147
3231
 
3148
 
    @staticmethod
3149
 
    def _get_branch_formats_to_test():
3150
 
        """Return a tuple with the Branch formats to use when testing."""
3151
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
3232
    @classmethod
 
3233
    def _get_branch_formats_to_test(klass):
 
3234
        """Return an iterable of format tuples for testing.
 
3235
        
 
3236
        :return: An iterable of (from_format, to_format) to use when testing
 
3237
            this InterBranch class. Each InterBranch class should define this
 
3238
            method itself.
 
3239
        """
 
3240
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3241
 
 
3242
    @needs_write_lock
3153
3243
    def pull(self, overwrite=False, stop_revision=None,
3154
3244
             possible_transports=None, local=False):
3155
3245
        """Mirror source into target branch.
3160
3250
        """
3161
3251
        raise NotImplementedError(self.pull)
3162
3252
 
3163
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
 
                         graph=None):
3165
 
        """Pull in new perfect-fit revisions.
3166
 
 
3167
 
        :param stop_revision: Updated until the given revision
3168
 
        :param overwrite: Always set the branch pointer, rather than checking
3169
 
            to see if it is a proper descendant.
3170
 
        :param graph: A Graph object that can be used to query history
3171
 
            information. This can be None.
3172
 
        :return: None
3173
 
        """
3174
 
        raise NotImplementedError(self.update_revisions)
3175
 
 
 
3253
    @needs_write_lock
3176
3254
    def push(self, overwrite=False, stop_revision=None,
3177
3255
             _override_hook_source_branch=None):
3178
3256
        """Mirror the source branch into the target branch.
3181
3259
        """
3182
3260
        raise NotImplementedError(self.push)
3183
3261
 
 
3262
    @needs_write_lock
 
3263
    def copy_content_into(self, revision_id=None):
 
3264
        """Copy the content of source into target
 
3265
 
 
3266
        revision_id: if not None, the revision history in the new branch will
 
3267
                     be truncated to end with revision_id.
 
3268
        """
 
3269
        raise NotImplementedError(self.copy_content_into)
 
3270
 
 
3271
    @needs_write_lock
 
3272
    def fetch(self, stop_revision=None):
 
3273
        """Fetch revisions.
 
3274
 
 
3275
        :param stop_revision: Last revision to fetch
 
3276
        """
 
3277
        raise NotImplementedError(self.fetch)
 
3278
 
3184
3279
 
3185
3280
class GenericInterBranch(InterBranch):
3186
 
    """InterBranch implementation that uses public Branch functions.
3187
 
    """
3188
 
 
3189
 
    @staticmethod
3190
 
    def _get_branch_formats_to_test():
3191
 
        return BranchFormat._default_format, BranchFormat._default_format
3192
 
 
3193
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3194
 
        graph=None):
3195
 
        """See InterBranch.update_revisions()."""
 
3281
    """InterBranch implementation that uses public Branch functions."""
 
3282
 
 
3283
    @classmethod
 
3284
    def is_compatible(klass, source, target):
 
3285
        # GenericBranch uses the public API, so always compatible
 
3286
        return True
 
3287
 
 
3288
    @classmethod
 
3289
    def _get_branch_formats_to_test(klass):
 
3290
        return [(format_registry.get_default(), format_registry.get_default())]
 
3291
 
 
3292
    @classmethod
 
3293
    def unwrap_format(klass, format):
 
3294
        if isinstance(format, remote.RemoteBranchFormat):
 
3295
            format._ensure_real()
 
3296
            return format._custom_format
 
3297
        return format
 
3298
 
 
3299
    @needs_write_lock
 
3300
    def copy_content_into(self, revision_id=None):
 
3301
        """Copy the content of source into target
 
3302
 
 
3303
        revision_id: if not None, the revision history in the new branch will
 
3304
                     be truncated to end with revision_id.
 
3305
        """
 
3306
        self.source.update_references(self.target)
 
3307
        self.source._synchronize_history(self.target, revision_id)
 
3308
        try:
 
3309
            parent = self.source.get_parent()
 
3310
        except errors.InaccessibleParent, e:
 
3311
            mutter('parent was not accessible to copy: %s', e)
 
3312
        else:
 
3313
            if parent:
 
3314
                self.target.set_parent(parent)
 
3315
        if self.source._push_should_merge_tags():
 
3316
            self.source.tags.merge_to(self.target.tags)
 
3317
 
 
3318
    @needs_write_lock
 
3319
    def fetch(self, stop_revision=None):
 
3320
        if self.target.base == self.source.base:
 
3321
            return (0, [])
3196
3322
        self.source.lock_read()
3197
3323
        try:
3198
 
            other_revno, other_last_revision = self.source.last_revision_info()
3199
 
            stop_revno = None # unknown
3200
 
            if stop_revision is None:
3201
 
                stop_revision = other_last_revision
3202
 
                if _mod_revision.is_null(stop_revision):
3203
 
                    # if there are no commits, we're done.
3204
 
                    return
3205
 
                stop_revno = other_revno
3206
 
 
3207
 
            # what's the current last revision, before we fetch [and change it
3208
 
            # possibly]
3209
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3210
 
            # we fetch here so that we don't process data twice in the common
3211
 
            # case of having something to pull, and so that the check for
3212
 
            # already merged can operate on the just fetched graph, which will
3213
 
            # be cached in memory.
3214
 
            self.target.fetch(self.source, stop_revision)
3215
 
            # Check to see if one is an ancestor of the other
3216
 
            if not overwrite:
3217
 
                if graph is None:
3218
 
                    graph = self.target.repository.get_graph()
3219
 
                if self.target._check_if_descendant_or_diverged(
3220
 
                        stop_revision, last_rev, graph, self.source):
3221
 
                    # stop_revision is a descendant of last_rev, but we aren't
3222
 
                    # overwriting, so we're done.
3223
 
                    return
3224
 
            if stop_revno is None:
3225
 
                if graph is None:
3226
 
                    graph = self.target.repository.get_graph()
3227
 
                this_revno, this_last_revision = \
3228
 
                        self.target.last_revision_info()
3229
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3230
 
                                [(other_last_revision, other_revno),
3231
 
                                 (this_last_revision, this_revno)])
3232
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
 
3324
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3325
            fetch_spec_factory.source_branch = self.source
 
3326
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3327
            fetch_spec_factory.source_repo = self.source.repository
 
3328
            fetch_spec_factory.target_repo = self.target.repository
 
3329
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3330
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3331
            return self.target.repository.fetch(self.source.repository,
 
3332
                fetch_spec=fetch_spec)
3233
3333
        finally:
3234
3334
            self.source.unlock()
3235
3335
 
 
3336
    @needs_write_lock
 
3337
    def _update_revisions(self, stop_revision=None, overwrite=False,
 
3338
            graph=None):
 
3339
        other_revno, other_last_revision = self.source.last_revision_info()
 
3340
        stop_revno = None # unknown
 
3341
        if stop_revision is None:
 
3342
            stop_revision = other_last_revision
 
3343
            if _mod_revision.is_null(stop_revision):
 
3344
                # if there are no commits, we're done.
 
3345
                return
 
3346
            stop_revno = other_revno
 
3347
 
 
3348
        # what's the current last revision, before we fetch [and change it
 
3349
        # possibly]
 
3350
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3351
        # we fetch here so that we don't process data twice in the common
 
3352
        # case of having something to pull, and so that the check for
 
3353
        # already merged can operate on the just fetched graph, which will
 
3354
        # be cached in memory.
 
3355
        self.fetch(stop_revision=stop_revision)
 
3356
        # Check to see if one is an ancestor of the other
 
3357
        if not overwrite:
 
3358
            if graph is None:
 
3359
                graph = self.target.repository.get_graph()
 
3360
            if self.target._check_if_descendant_or_diverged(
 
3361
                    stop_revision, last_rev, graph, self.source):
 
3362
                # stop_revision is a descendant of last_rev, but we aren't
 
3363
                # overwriting, so we're done.
 
3364
                return
 
3365
        if stop_revno is None:
 
3366
            if graph is None:
 
3367
                graph = self.target.repository.get_graph()
 
3368
            this_revno, this_last_revision = \
 
3369
                    self.target.last_revision_info()
 
3370
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3371
                            [(other_last_revision, other_revno),
 
3372
                             (this_last_revision, this_revno)])
 
3373
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3374
 
 
3375
    @needs_write_lock
3236
3376
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3377
             possible_transports=None, run_hooks=True,
3238
3378
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
 
3379
        """Pull from source into self, updating my master if any.
3240
3380
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
3381
        :param run_hooks: Private parameter - if false, this branch
3244
3382
            is being called because it's the master of the primary branch,
3245
3383
            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
3384
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
 
3385
        bound_location = self.target.get_bound_location()
 
3386
        if local and not bound_location:
3252
3387
            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()
 
3388
        master_branch = None
 
3389
        source_is_master = (self.source.user_url == bound_location)
 
3390
        if not local and bound_location and not source_is_master:
 
3391
            # not pulling from master, so we need to update master.
 
3392
            master_branch = self.target.get_master_branch(possible_transports)
 
3393
            master_branch.lock_write()
3260
3394
        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)
 
3395
            if master_branch:
 
3396
                # pull from source into master.
 
3397
                master_branch.pull(self.source, overwrite, stop_revision,
 
3398
                    run_hooks=False)
 
3399
            return self._pull(overwrite,
 
3400
                stop_revision, _hook_master=master_branch,
 
3401
                run_hooks=run_hooks,
 
3402
                _override_hook_target=_override_hook_target,
 
3403
                merge_tags_to_master=not source_is_master)
3287
3404
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
 
3405
            if master_branch:
 
3406
                master_branch.unlock()
3290
3407
 
3291
3408
    def push(self, overwrite=False, stop_revision=None,
3292
3409
             _override_hook_source_branch=None):
3310
3427
        finally:
3311
3428
            self.source.unlock()
3312
3429
 
 
3430
    def _basic_push(self, overwrite, stop_revision):
 
3431
        """Basic implementation of push without bound branches or hooks.
 
3432
 
 
3433
        Must be called with source read locked and target write locked.
 
3434
        """
 
3435
        result = BranchPushResult()
 
3436
        result.source_branch = self.source
 
3437
        result.target_branch = self.target
 
3438
        result.old_revno, result.old_revid = self.target.last_revision_info()
 
3439
        self.source.update_references(self.target)
 
3440
        if result.old_revid != stop_revision:
 
3441
            # We assume that during 'push' this repository is closer than
 
3442
            # the target.
 
3443
            graph = self.source.repository.get_graph(self.target.repository)
 
3444
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3445
                    graph=graph)
 
3446
        if self.source._push_should_merge_tags():
 
3447
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3448
                overwrite)
 
3449
        result.new_revno, result.new_revid = self.target.last_revision_info()
 
3450
        return result
 
3451
 
3313
3452
    def _push_with_bound_branches(self, overwrite, stop_revision,
3314
3453
            _override_hook_source_branch=None):
3315
3454
        """Push from source into target, and into target's master if any.
3330
3469
            master_branch.lock_write()
3331
3470
            try:
3332
3471
                # push into the master from the source branch.
3333
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3334
 
                # and push into the target branch from the source. Note that we
3335
 
                # push from the source branch again, because its considered the
3336
 
                # highest bandwidth repository.
3337
 
                result = self.source._basic_push(self.target, overwrite,
3338
 
                    stop_revision)
 
3472
                master_inter = InterBranch.get(self.source, master_branch)
 
3473
                master_inter._basic_push(overwrite, stop_revision)
 
3474
                # and push into the target branch from the source. Note that
 
3475
                # we push from the source branch again, because it's considered
 
3476
                # the highest bandwidth repository.
 
3477
                result = self._basic_push(overwrite, stop_revision)
3339
3478
                result.master_branch = master_branch
3340
3479
                result.local_branch = self.target
3341
3480
                _run_hooks()
3344
3483
                master_branch.unlock()
3345
3484
        else:
3346
3485
            # no master branch
3347
 
            result = self.source._basic_push(self.target, overwrite,
3348
 
                stop_revision)
 
3486
            result = self._basic_push(overwrite, stop_revision)
3349
3487
            # TODO: Why set master_branch and local_branch if there's no
3350
3488
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3351
3489
            # 20070504
3354
3492
            _run_hooks()
3355
3493
            return result
3356
3494
 
3357
 
    @classmethod
3358
 
    def is_compatible(self, source, target):
3359
 
        # GenericBranch uses the public API, so always compatible
3360
 
        return True
3361
 
 
3362
 
 
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
 
 
 
3495
    def _pull(self, overwrite=False, stop_revision=None,
 
3496
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3497
             _override_hook_target=None, local=False,
 
3498
             merge_tags_to_master=True):
 
3499
        """See Branch.pull.
 
3500
 
 
3501
        This function is the core worker, used by GenericInterBranch.pull to
 
3502
        avoid duplication when pulling source->master and source->local.
 
3503
 
 
3504
        :param _hook_master: Private parameter - set the branch to
 
3505
            be supplied as the master to pull hooks.
3374
3506
        :param run_hooks: Private parameter - if false, this branch
3375
3507
            is being called because it's the master of the primary branch,
3376
3508
            so it should not run its hooks.
 
3509
            is being called because it's the master of the primary branch,
 
3510
            so it should not run its hooks.
 
3511
        :param _override_hook_target: Private parameter - set the branch to be
 
3512
            supplied as the target_branch to pull hooks.
 
3513
        :param local: Only update the local branch, and not the bound branch.
3377
3514
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
 
3515
        # This type of branch can't be bound.
 
3516
        if local:
3380
3517
            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()
 
3518
        result = PullResult()
 
3519
        result.source_branch = self.source
 
3520
        if _override_hook_target is None:
 
3521
            result.target_branch = self.target
 
3522
        else:
 
3523
            result.target_branch = _override_hook_target
 
3524
        self.source.lock_read()
3386
3525
        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)
 
3526
            # We assume that during 'pull' the target repository is closer than
 
3527
            # the source one.
 
3528
            self.source.update_references(self.target)
 
3529
            graph = self.target.repository.get_graph(self.source.repository)
 
3530
            # TODO: Branch formats should have a flag that indicates 
 
3531
            # that revno's are expensive, and pull() should honor that flag.
 
3532
            # -- JRV20090506
 
3533
            result.old_revno, result.old_revid = \
 
3534
                self.target.last_revision_info()
 
3535
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3536
                graph=graph)
 
3537
            # TODO: The old revid should be specified when merging tags, 
 
3538
            # so a tags implementation that versions tags can only 
 
3539
            # pull in the most recent changes. -- JRV20090506
 
3540
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3541
                overwrite, ignore_master=not merge_tags_to_master)
 
3542
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3543
            if _hook_master:
 
3544
                result.master_branch = _hook_master
 
3545
                result.local_branch = result.target_branch
 
3546
            else:
 
3547
                result.master_branch = result.target_branch
 
3548
                result.local_branch = None
 
3549
            if run_hooks:
 
3550
                for hook in Branch.hooks['post_pull']:
 
3551
                    hook(result)
3395
3552
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
 
3553
            self.source.unlock()
 
3554
        return result
3398
3555
 
3399
3556
 
3400
3557
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)