/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: Jelmer Vernooij
  • Date: 2011-05-09 13:55:20 UTC
  • mto: This revision was merged to the branch mainline in revision 5843.
  • Revision ID: jelmer@samba.org-20110509135520-8r5rgkjd30iunztg
Fix two warnings.

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,
39
42
        urlutils,
40
43
        )
41
44
from bzrlib.config import BranchConfig, TransportConfig
42
 
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
45
from bzrlib.tag import (
44
46
    BasicTags,
45
47
    DisabledTags,
46
48
    )
47
49
""")
48
50
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
 
from bzrlib.hooks import HookPoint, Hooks
 
51
from bzrlib import (
 
52
    controldir,
 
53
    )
 
54
from bzrlib.decorators import (
 
55
    needs_read_lock,
 
56
    needs_write_lock,
 
57
    only_raises,
 
58
    )
 
59
from bzrlib.hooks import Hooks
51
60
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
 
61
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
62
from bzrlib import registry
54
63
from bzrlib.symbol_versioning import (
55
64
    deprecated_in,
63
72
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
73
 
65
74
 
66
 
class Branch(bzrdir.ControlComponent):
 
75
class Branch(controldir.ControlComponent):
67
76
    """Branch holding a history of revisions.
68
77
 
69
78
    :ivar base:
70
79
        Base directory/url of the branch; using control_url and
71
80
        control_transport is more standardized.
72
 
 
73
 
    hooks: An instance of BranchHooks.
 
81
    :ivar hooks: An instance of BranchHooks.
 
82
    :ivar _master_branch_cache: cached result of get_master_branch, see
 
83
        _clear_cached_state.
74
84
    """
75
85
    # this is really an instance variable - FIXME move it there
76
86
    # - RBC 20060112
90
100
        self._revision_id_to_revno_cache = None
91
101
        self._partial_revision_id_to_revno_cache = {}
92
102
        self._partial_revision_history_cache = []
 
103
        self._tags_bytes = None
93
104
        self._last_revision_info_cache = None
 
105
        self._master_branch_cache = None
94
106
        self._merge_sorted_revisions_cache = None
95
107
        self._open_hook()
96
108
        hooks = Branch.hooks['open']
102
114
 
103
115
    def _activate_fallback_location(self, url):
104
116
        """Activate the branch/repository from url as a fallback repository."""
 
117
        for existing_fallback_repo in self.repository._fallback_repositories:
 
118
            if existing_fallback_repo.user_url == url:
 
119
                # This fallback is already configured.  This probably only
 
120
                # happens because BzrDir.sprout is a horrible mess.  To avoid
 
121
                # confusing _unstack we don't add this a second time.
 
122
                mutter('duplicate activation of fallback %r on %r', url, self)
 
123
                return
105
124
        repo = self._get_fallback_repository(url)
106
125
        if repo.has_same_location(self.repository):
107
126
            raise errors.UnstackableLocationError(self.user_url, url)
197
216
        return self.supports_tags() and self.tags.get_tag_dict()
198
217
 
199
218
    def get_config(self):
 
219
        """Get a bzrlib.config.BranchConfig for this Branch.
 
220
 
 
221
        This can then be used to get and set configuration options for the
 
222
        branch.
 
223
 
 
224
        :return: A bzrlib.config.BranchConfig.
 
225
        """
200
226
        return BranchConfig(self)
201
227
 
202
228
    def _get_config(self):
218
244
            possible_transports=[self.bzrdir.root_transport])
219
245
        return a_branch.repository
220
246
 
 
247
    @needs_read_lock
221
248
    def _get_tags_bytes(self):
222
249
        """Get the bytes of a serialised tags dict.
223
250
 
230
257
        :return: The bytes of the tags file.
231
258
        :seealso: Branch._set_tags_bytes.
232
259
        """
233
 
        return self._transport.get_bytes('tags')
 
260
        if self._tags_bytes is None:
 
261
            self._tags_bytes = self._transport.get_bytes('tags')
 
262
        return self._tags_bytes
234
263
 
235
264
    def _get_nick(self, local=False, possible_transports=None):
236
265
        config = self.get_config()
238
267
        if not local and not config.has_explicit_nickname():
239
268
            try:
240
269
                master = self.get_master_branch(possible_transports)
 
270
                if master and self.user_url == master.user_url:
 
271
                    raise errors.RecursiveBind(self.user_url)
241
272
                if master is not None:
242
273
                    # return the master branch value
243
274
                    return master.nick
 
275
            except errors.RecursiveBind, e:
 
276
                raise e
244
277
            except errors.BzrError, e:
245
278
                # Silently fall back to local implicit nick if the master is
246
279
                # unavailable
283
316
        new_history.reverse()
284
317
        return new_history
285
318
 
286
 
    def lock_write(self):
 
319
    def lock_write(self, token=None):
 
320
        """Lock the branch for write operations.
 
321
 
 
322
        :param token: A token to permit reacquiring a previously held and
 
323
            preserved lock.
 
324
        :return: A BranchWriteLockResult.
 
325
        """
287
326
        raise NotImplementedError(self.lock_write)
288
327
 
289
328
    def lock_read(self):
 
329
        """Lock the branch for read operations.
 
330
 
 
331
        :return: A bzrlib.lock.LogicalLockResult.
 
332
        """
290
333
        raise NotImplementedError(self.lock_read)
291
334
 
292
335
    def unlock(self):
626
669
        raise errors.UnsupportedOperation(self.get_reference_info, self)
627
670
 
628
671
    @needs_write_lock
629
 
    def fetch(self, from_branch, last_revision=None, pb=None):
 
672
    def fetch(self, from_branch, last_revision=None):
630
673
        """Copy revisions from from_branch into this branch.
631
674
 
632
675
        :param from_branch: Where to copy from.
633
676
        :param last_revision: What revision to stop at (None for at the end
634
677
                              of the branch.
635
 
        :param pb: An optional progress bar to use.
636
678
        :return: None
637
679
        """
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()
 
680
        return InterBranch.get(from_branch, self).fetch(last_revision)
654
681
 
655
682
    def get_bound_location(self):
656
683
        """Return the URL of the branch we are bound to.
667
694
 
668
695
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
696
                           timezone=None, committer=None, revprops=None,
670
 
                           revision_id=None):
 
697
                           revision_id=None, lossy=False):
671
698
        """Obtain a CommitBuilder for this branch.
672
699
 
673
700
        :param parents: Revision ids of the parents of the new revision.
677
704
        :param committer: Optional committer to set for commit.
678
705
        :param revprops: Optional dictionary of revision properties.
679
706
        :param revision_id: Optional revision id.
 
707
        :param lossy: Whether to discard data that can not be natively
 
708
            represented, when pushing to a foreign VCS 
680
709
        """
681
710
 
682
711
        if config is None:
683
712
            config = self.get_config()
684
713
 
685
714
        return self.repository.get_commit_builder(self, parents, config,
686
 
            timestamp, timezone, committer, revprops, revision_id)
 
715
            timestamp, timezone, committer, revprops, revision_id,
 
716
            lossy)
687
717
 
688
718
    def get_master_branch(self, possible_transports=None):
689
719
        """Return the branch we are bound to.
716
746
        """Print `file` to stdout."""
717
747
        raise NotImplementedError(self.print_file)
718
748
 
 
749
    @deprecated_method(deprecated_in((2, 4, 0)))
719
750
    def set_revision_history(self, rev_history):
720
 
        raise NotImplementedError(self.set_revision_history)
 
751
        """See Branch.set_revision_history."""
 
752
        self._set_revision_history(rev_history)
 
753
 
 
754
    @needs_write_lock
 
755
    def _set_revision_history(self, rev_history):
 
756
        if len(rev_history) == 0:
 
757
            revid = _mod_revision.NULL_REVISION
 
758
        else:
 
759
            revid = rev_history[-1]
 
760
        if rev_history != self._lefthand_history(revid):
 
761
            raise errors.NotLefthandHistory(rev_history)
 
762
        self.set_last_revision_info(len(rev_history), revid)
 
763
        self._cache_revision_history(rev_history)
 
764
        for hook in Branch.hooks['set_rh']:
 
765
            hook(self, rev_history)
 
766
 
 
767
    @needs_write_lock
 
768
    def set_last_revision_info(self, revno, revision_id):
 
769
        """Set the last revision of this branch.
 
770
 
 
771
        The caller is responsible for checking that the revno is correct
 
772
        for this revision id.
 
773
 
 
774
        It may be possible to set the branch last revision to an id not
 
775
        present in the repository.  However, branches can also be
 
776
        configured to check constraints on history, in which case this may not
 
777
        be permitted.
 
778
        """
 
779
        raise NotImplementedError(self.last_revision_info)
 
780
 
 
781
    @needs_write_lock
 
782
    def generate_revision_history(self, revision_id, last_rev=None,
 
783
                                  other_branch=None):
 
784
        """See Branch.generate_revision_history"""
 
785
        # FIXME: This shouldn't have to fetch the entire history
 
786
        history = self._lefthand_history(revision_id, last_rev, other_branch)
 
787
        revno = len(history)
 
788
        self.set_last_revision_info(revno, revision_id)
 
789
        self._cache_revision_history(history)
721
790
 
722
791
    @needs_write_lock
723
792
    def set_parent(self, url):
767
836
 
768
837
    def _unstack(self):
769
838
        """Change a branch to be unstacked, copying data as needed.
770
 
        
 
839
 
771
840
        Don't call this directly, use set_stacked_on_url(None).
772
841
        """
773
842
        pb = ui.ui_factory.nested_progress_bar()
782
851
            old_repository = self.repository
783
852
            if len(old_repository._fallback_repositories) != 1:
784
853
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
 
854
                    "of %r (fallbacks: %r)" % (old_repository,
 
855
                        old_repository._fallback_repositories))
 
856
            # Open the new repository object.
 
857
            # Repositories don't offer an interface to remove fallback
 
858
            # repositories today; take the conceptually simpler option and just
 
859
            # reopen it.  We reopen it starting from the URL so that we
 
860
            # get a separate connection for RemoteRepositories and can
 
861
            # stream from one of them to the other.  This does mean doing
 
862
            # separate SSH connection setup, but unstacking is not a
 
863
            # common operation so it's tolerable.
 
864
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
865
            new_repository = new_bzrdir.find_repository()
 
866
            if new_repository._fallback_repositories:
 
867
                raise AssertionError("didn't expect %r to have "
 
868
                    "fallback_repositories"
 
869
                    % (self.repository,))
 
870
            # Replace self.repository with the new repository.
 
871
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
872
            # lock count) of self.repository to the new repository.
 
873
            lock_token = old_repository.lock_write().repository_token
 
874
            self.repository = new_repository
 
875
            if isinstance(self, remote.RemoteBranch):
 
876
                # Remote branches can have a second reference to the old
 
877
                # repository that need to be replaced.
 
878
                if self._real_branch is not None:
 
879
                    self._real_branch.repository = new_repository
 
880
            self.repository.lock_write(token=lock_token)
 
881
            if lock_token is not None:
 
882
                old_repository.leave_lock_in_place()
787
883
            old_repository.unlock()
 
884
            if lock_token is not None:
 
885
                # XXX: self.repository.leave_lock_in_place() before this
 
886
                # function will not be preserved.  Fortunately that doesn't
 
887
                # affect the current default format (2a), and would be a
 
888
                # corner-case anyway.
 
889
                #  - Andrew Bennetts, 2010/06/30
 
890
                self.repository.dont_leave_lock_in_place()
 
891
            old_lock_count = 0
 
892
            while True:
 
893
                try:
 
894
                    old_repository.unlock()
 
895
                except errors.LockNotHeld:
 
896
                    break
 
897
                old_lock_count += 1
 
898
            if old_lock_count == 0:
 
899
                raise AssertionError(
 
900
                    'old_repository should have been locked at least once.')
 
901
            for i in range(old_lock_count-1):
 
902
                self.repository.lock_write()
 
903
            # Fetch from the old repository into the new.
788
904
            old_repository.lock_read()
789
905
            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
906
                # XXX: If you unstack a branch while it has a working tree
809
907
                # with a pending merge, the pending-merged revisions will no
810
908
                # 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)
 
909
                try:
 
910
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
911
                except errors.TagsNotSupported:
 
912
                    tags_to_fetch = set()
 
913
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
914
                    old_repository, required_ids=[self.last_revision()],
 
915
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
916
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
818
917
            finally:
819
918
                old_repository.unlock()
820
919
        finally:
825
924
 
826
925
        :seealso: Branch._get_tags_bytes.
827
926
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
927
        return _run_with_write_locked_target(self, self._set_tags_bytes_locked,
 
928
                bytes)
 
929
 
 
930
    def _set_tags_bytes_locked(self, bytes):
 
931
        self._tags_bytes = bytes
 
932
        return self._transport.put_bytes('tags', bytes)
830
933
 
831
934
    def _cache_revision_history(self, rev_history):
832
935
        """Set the cached revision history to rev_history.
859
962
        self._revision_history_cache = None
860
963
        self._revision_id_to_revno_cache = None
861
964
        self._last_revision_info_cache = None
 
965
        self._master_branch_cache = None
862
966
        self._merge_sorted_revisions_cache = None
863
967
        self._partial_revision_history_cache = []
864
968
        self._partial_revision_id_to_revno_cache = {}
 
969
        self._tags_bytes = None
865
970
 
866
971
    def _gen_revision_history(self):
867
972
        """Return sequence of revision hashes on to this branch.
917
1022
        :return: A tuple (revno, revision_id).
918
1023
        """
919
1024
        if self._last_revision_info_cache is None:
920
 
            self._last_revision_info_cache = self._last_revision_info()
 
1025
            self._last_revision_info_cache = self._read_last_revision_info()
921
1026
        return self._last_revision_info_cache
922
1027
 
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
 
 
 
1028
    def _read_last_revision_info(self):
 
1029
        raise NotImplementedError(self._read_last_revision_info)
 
1030
 
 
1031
    @deprecated_method(deprecated_in((2, 4, 0)))
970
1032
    def import_last_revision_info(self, source_repo, revno, revid):
971
1033
        """Set the last revision info, importing from another repo if necessary.
972
1034
 
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
1035
        :param source_repo: Source repository to optionally fetch from
977
1036
        :param revno: Revision number of the new tip
978
1037
        :param revid: Revision id of the new tip
981
1040
            self.repository.fetch(source_repo, revision_id=revid)
982
1041
        self.set_last_revision_info(revno, revid)
983
1042
 
 
1043
    def import_last_revision_info_and_tags(self, source, revno, revid,
 
1044
                                           lossy=False):
 
1045
        """Set the last revision info, importing from another repo if necessary.
 
1046
 
 
1047
        This is used by the bound branch code to upload a revision to
 
1048
        the master branch first before updating the tip of the local branch.
 
1049
        Revisions referenced by source's tags are also transferred.
 
1050
 
 
1051
        :param source: Source branch to optionally fetch from
 
1052
        :param revno: Revision number of the new tip
 
1053
        :param revid: Revision id of the new tip
 
1054
        :param lossy: Whether to discard metadata that can not be
 
1055
            natively represented
 
1056
        :return: Tuple with the new revision number and revision id
 
1057
            (should only be different from the arguments when lossy=True)
 
1058
        """
 
1059
        if not self.repository.has_same_location(source.repository):
 
1060
            self.fetch(source, revid)
 
1061
        self.set_last_revision_info(revno, revid)
 
1062
        return (revno, revid)
 
1063
 
984
1064
    def revision_id_to_revno(self, revision_id):
985
1065
        """Given a revision id, return its revno"""
986
1066
        if _mod_revision.is_null(revision_id):
1006
1086
            self._extend_partial_history(distance_from_last)
1007
1087
        return self._partial_revision_history_cache[distance_from_last]
1008
1088
 
1009
 
    @needs_write_lock
1010
1089
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1090
             possible_transports=None, *args, **kwargs):
1012
1091
        """Mirror source into this branch.
1208
1287
        return result
1209
1288
 
1210
1289
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1290
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1291
            repository=None):
1212
1292
        """Create a new line of development from the branch, into to_bzrdir.
1213
1293
 
1214
1294
        to_bzrdir controls the branch format.
1219
1299
        if (repository_policy is not None and
1220
1300
            repository_policy.requires_stacking()):
1221
1301
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
 
        result = to_bzrdir.create_branch()
 
1302
        result = to_bzrdir.create_branch(repository=repository)
1223
1303
        result.lock_write()
1224
1304
        try:
1225
1305
            if repository_policy is not None:
1226
1306
                repository_policy.configure_branch(result)
1227
1307
            self.copy_content_into(result, revision_id=revision_id)
1228
 
            result.set_parent(self.bzrdir.root_transport.base)
 
1308
            master_branch = self.get_master_branch()
 
1309
            if master_branch is None:
 
1310
                result.set_parent(self.bzrdir.root_transport.base)
 
1311
            else:
 
1312
                result.set_parent(master_branch.bzrdir.root_transport.base)
1229
1313
        finally:
1230
1314
            result.unlock()
1231
1315
        return result
1255
1339
                revno = 1
1256
1340
        destination.set_last_revision_info(revno, revision_id)
1257
1341
 
1258
 
    @needs_read_lock
1259
1342
    def copy_content_into(self, destination, revision_id=None):
1260
1343
        """Copy the content of self into destination.
1261
1344
 
1262
1345
        revision_id: if not None, the revision history in the new branch will
1263
1346
                     be truncated to end with revision_id.
1264
1347
        """
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)
 
1348
        return InterBranch.get(self, destination).copy_content_into(
 
1349
            revision_id=revision_id)
1276
1350
 
1277
1351
    def update_references(self, target):
1278
1352
        if not getattr(self._format, 'supports_reference_locations', False):
1323
1397
        """Return the most suitable metadir for a checkout of this branch.
1324
1398
        Weaves are used if this branch's repository uses weaves.
1325
1399
        """
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)
 
1400
        format = self.repository.bzrdir.checkout_metadir()
 
1401
        format.set_branch_format(self._format)
1333
1402
        return format
1334
1403
 
1335
1404
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1405
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1406
        no_tree=None):
1337
1407
        """Create a clone of this branch and its bzrdir.
1338
1408
 
1339
1409
        :param to_transport: The transport to clone onto.
1346
1416
        """
1347
1417
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1418
        # clone call. Or something. 20090224 RBC/spiv.
 
1419
        # XXX: Should this perhaps clone colocated branches as well, 
 
1420
        # rather than just the default branch? 20100319 JRV
1349
1421
        if revision_id is None:
1350
1422
            revision_id = self.last_revision()
1351
1423
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
1424
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1425
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1426
            no_tree=no_tree)
1354
1427
        return dir_to.open_branch()
1355
1428
 
1356
1429
    def create_checkout(self, to_location, revision_id=None,
1471
1544
        else:
1472
1545
            raise AssertionError("invalid heads: %r" % (heads,))
1473
1546
 
1474
 
 
1475
 
class BranchFormat(object):
 
1547
    def heads_to_fetch(self):
 
1548
        """Return the heads that must and that should be fetched to copy this
 
1549
        branch into another repo.
 
1550
 
 
1551
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1552
            set of heads that must be fetched.  if_present_fetch is a set of
 
1553
            heads that must be fetched if present, but no error is necessary if
 
1554
            they are not present.
 
1555
        """
 
1556
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
 
1557
        # are the tags.
 
1558
        must_fetch = set([self.last_revision()])
 
1559
        try:
 
1560
            if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1561
        except errors.TagsNotSupported:
 
1562
            if_present_fetch = set()
 
1563
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1564
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1565
        return must_fetch, if_present_fetch
 
1566
 
 
1567
 
 
1568
class BranchFormat(controldir.ControlComponentFormat):
1476
1569
    """An encapsulation of the initialization and open routines for a format.
1477
1570
 
1478
1571
    Formats provide three things:
1481
1574
     * an open routine.
1482
1575
 
1483
1576
    Formats are placed in an dict by their format string for reference
1484
 
    during branch opening. Its not required that these be instances, they
 
1577
    during branch opening. It's not required that these be instances, they
1485
1578
    can be classes themselves with class methods - it simply depends on
1486
1579
    whether state is needed for a given format or not.
1487
1580
 
1490
1583
    object will be created every time regardless.
1491
1584
    """
1492
1585
 
1493
 
    _default_format = None
1494
 
    """The default format used for new branches."""
1495
 
 
1496
 
    _formats = {}
1497
 
    """The known formats."""
1498
 
 
1499
1586
    can_set_append_revisions_only = True
1500
1587
 
1501
1588
    def __eq__(self, other):
1510
1597
        try:
1511
1598
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
1599
            format_string = transport.get_bytes("format")
1513
 
            return klass._formats[format_string]
 
1600
            return format_registry.get(format_string)
1514
1601
        except errors.NoSuchFile:
1515
1602
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1516
1603
        except KeyError:
1517
1604
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1605
 
1519
1606
    @classmethod
 
1607
    @deprecated_method(deprecated_in((2, 4, 0)))
1520
1608
    def get_default_format(klass):
1521
1609
        """Return the current default format."""
1522
 
        return klass._default_format
1523
 
 
1524
 
    def get_reference(self, a_bzrdir):
 
1610
        return format_registry.get_default()
 
1611
 
 
1612
    @classmethod
 
1613
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1614
    def get_formats(klass):
 
1615
        """Get all the known formats.
 
1616
 
 
1617
        Warning: This triggers a load of all lazy registered formats: do not
 
1618
        use except when that is desireed.
 
1619
        """
 
1620
        return format_registry._get_all()
 
1621
 
 
1622
    def get_reference(self, a_bzrdir, name=None):
1525
1623
        """Get the target reference of the branch in a_bzrdir.
1526
1624
 
1527
1625
        format probing must have been completed before calling
1529
1627
        in a_bzrdir is correct.
1530
1628
 
1531
1629
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1630
        :param name: Name of the colocated branch to fetch
1532
1631
        :return: None if the branch is not a reference branch.
1533
1632
        """
1534
1633
        return None
1535
1634
 
1536
1635
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
 
1636
    def set_reference(self, a_bzrdir, name, to_branch):
1538
1637
        """Set the target reference of the branch in a_bzrdir.
1539
1638
 
1540
1639
        format probing must have been completed before calling
1542
1641
        in a_bzrdir is correct.
1543
1642
 
1544
1643
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1644
        :param name: Name of colocated branch to set, None for default
1545
1645
        :param to_branch: branch that the checkout is to reference
1546
1646
        """
1547
1647
        raise NotImplementedError(self.set_reference)
1562
1662
        for hook in hooks:
1563
1663
            hook(params)
1564
1664
 
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):
 
1665
    def initialize(self, a_bzrdir, name=None, repository=None):
1611
1666
        """Create a branch of this format in a_bzrdir.
1612
1667
        
1613
1668
        :param name: Name of the colocated branch to create.
1647
1702
        """
1648
1703
        raise NotImplementedError(self.network_name)
1649
1704
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1705
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
1706
            found_repository=None):
1651
1707
        """Return the branch object for a_bzrdir
1652
1708
 
1653
1709
        :param a_bzrdir: A BzrDir that contains a branch.
1660
1716
        raise NotImplementedError(self.open)
1661
1717
 
1662
1718
    @classmethod
 
1719
    @deprecated_method(deprecated_in((2, 4, 0)))
1663
1720
    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__)
 
1721
        """Register a metadir format.
 
1722
 
 
1723
        See MetaDirBranchFormatFactory for the ability to register a format
 
1724
        without loading the code the format needs until it is actually used.
 
1725
        """
 
1726
        format_registry.register(format)
1669
1727
 
1670
1728
    @classmethod
 
1729
    @deprecated_method(deprecated_in((2, 4, 0)))
1671
1730
    def set_default_format(klass, format):
1672
 
        klass._default_format = format
 
1731
        format_registry.set_default(format)
1673
1732
 
1674
1733
    def supports_set_append_revisions_only(self):
1675
1734
        """True if this format supports set_append_revisions_only."""
1679
1738
        """True if this format records a stacked-on branch."""
1680
1739
        return False
1681
1740
 
 
1741
    def supports_leaving_lock(self):
 
1742
        """True if this format supports leaving locks in place."""
 
1743
        return False # by default
 
1744
 
1682
1745
    @classmethod
 
1746
    @deprecated_method(deprecated_in((2, 4, 0)))
1683
1747
    def unregister_format(klass, format):
1684
 
        del klass._formats[format.get_format_string()]
 
1748
        format_registry.remove(format)
1685
1749
 
1686
1750
    def __str__(self):
1687
1751
        return self.get_format_description().rstrip()
1691
1755
        return False  # by default
1692
1756
 
1693
1757
 
 
1758
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1759
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1760
    
 
1761
    While none of the built in BranchFormats are lazy registered yet,
 
1762
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1763
    use it, and the bzr-loom plugin uses it as well (see
 
1764
    bzrlib.plugins.loom.formats).
 
1765
    """
 
1766
 
 
1767
    def __init__(self, format_string, module_name, member_name):
 
1768
        """Create a MetaDirBranchFormatFactory.
 
1769
 
 
1770
        :param format_string: The format string the format has.
 
1771
        :param module_name: Module to load the format class from.
 
1772
        :param member_name: Attribute name within the module for the format class.
 
1773
        """
 
1774
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1775
        self._format_string = format_string
 
1776
        
 
1777
    def get_format_string(self):
 
1778
        """See BranchFormat.get_format_string."""
 
1779
        return self._format_string
 
1780
 
 
1781
    def __call__(self):
 
1782
        """Used for network_format_registry support."""
 
1783
        return self.get_obj()()
 
1784
 
 
1785
 
1694
1786
class BranchHooks(Hooks):
1695
1787
    """A dictionary mapping hook name to a list of callables for branch hooks.
1696
1788
 
1704
1796
        These are all empty initially, because by default nothing should get
1705
1797
        notified.
1706
1798
        """
1707
 
        Hooks.__init__(self)
1708
 
        self.create_hook(HookPoint('set_rh',
 
1799
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1800
        self.add_hook('set_rh',
1709
1801
            "Invoked whenever the revision history has been set via "
1710
1802
            "set_revision_history. The api signature is (branch, "
1711
1803
            "revision_history), and the branch will be write-locked. "
1712
1804
            "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',
 
1805
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
 
1806
        self.add_hook('open',
1715
1807
            "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',
 
1808
            "branch is opened.", (1, 8))
 
1809
        self.add_hook('post_push',
1718
1810
            "Called after a push operation completes. post_push is called "
1719
1811
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
 
            "bzr client.", (0, 15), None))
1721
 
        self.create_hook(HookPoint('post_pull',
 
1812
            "bzr client.", (0, 15))
 
1813
        self.add_hook('post_pull',
1722
1814
            "Called after a pull operation completes. post_pull is called "
1723
1815
            "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 "
 
1816
            "bzr client.", (0, 15))
 
1817
        self.add_hook('pre_commit',
 
1818
            "Called after a commit is calculated but before it is "
1727
1819
            "completed. pre_commit is called with (local, master, old_revno, "
1728
1820
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
1821
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1731
1823
            "basis revision. hooks MUST NOT modify this delta. "
1732
1824
            " future_tree is an in-memory tree obtained from "
1733
1825
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
 
            "tree.", (0,91), None))
1735
 
        self.create_hook(HookPoint('post_commit',
 
1826
            "tree.", (0,91))
 
1827
        self.add_hook('post_commit',
1736
1828
            "Called in the bzr client after a commit has completed. "
1737
1829
            "post_commit is called with (local, master, old_revno, old_revid, "
1738
1830
            "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',
 
1831
            "commit to a branch.", (0, 15))
 
1832
        self.add_hook('post_uncommit',
1741
1833
            "Called in the bzr client after an uncommit completes. "
1742
1834
            "post_uncommit is called with (local, master, old_revno, "
1743
1835
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
1836
            "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',
 
1837
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1838
        self.add_hook('pre_change_branch_tip',
1747
1839
            "Called in bzr client and server before a change to the tip of a "
1748
1840
            "branch is made. pre_change_branch_tip is called with a "
1749
1841
            "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',
 
1842
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1843
        self.add_hook('post_change_branch_tip',
1752
1844
            "Called in bzr client and server after a change to the tip of a "
1753
1845
            "branch is made. post_change_branch_tip is called with a "
1754
1846
            "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',
 
1847
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1848
        self.add_hook('transform_fallback_location',
1757
1849
            "Called when a stacked branch is activating its fallback "
1758
1850
            "locations. transform_fallback_location is called with (branch, "
1759
1851
            "url), and should return a new url. Returning the same url "
1764
1856
            "fallback locations have not been activated. When there are "
1765
1857
            "multiple hooks installed for transform_fallback_location, "
1766
1858
            "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."
 
1859
            "The order is however undefined.", (1, 9))
 
1860
        self.add_hook('automatic_tag_name',
 
1861
            "Called to determine an automatic tag name for a revision. "
1770
1862
            "automatic_tag_name is called with (branch, revision_id) and "
1771
1863
            "should return a tag name or None if no tag name could be "
1772
1864
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
 
1865
            (2, 2))
 
1866
        self.add_hook('post_branch_init',
1775
1867
            "Called after new branch initialization completes. "
1776
1868
            "post_branch_init is called with a "
1777
1869
            "bzrlib.branch.BranchInitHookParams. "
1778
1870
            "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',
 
1871
            "lightweight) will all trigger this hook.", (2, 2))
 
1872
        self.add_hook('post_switch',
1781
1873
            "Called after a checkout switches branch. "
1782
1874
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1875
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1784
1876
 
1785
1877
 
1786
1878
 
1863
1955
        return self.__dict__ == other.__dict__
1864
1956
 
1865
1957
    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)
 
1958
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1872
1959
 
1873
1960
 
1874
1961
class SwitchHookParams(object):
1904
1991
            self.revision_id)
1905
1992
 
1906
1993
 
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
1994
class BranchFormatMetadir(BranchFormat):
1951
1995
    """Common logic for meta-dir based branch formats."""
1952
1996
 
1954
1998
        """What class to instantiate on open calls."""
1955
1999
        raise NotImplementedError(self._branch_class)
1956
2000
 
 
2001
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
2002
                           repository=None):
 
2003
        """Initialize a branch in a bzrdir, with specified files
 
2004
 
 
2005
        :param a_bzrdir: The bzrdir to initialize the branch in
 
2006
        :param utf8_files: The files to create as a list of
 
2007
            (filename, content) tuples
 
2008
        :param name: Name of colocated branch to create, if any
 
2009
        :return: a branch in this format
 
2010
        """
 
2011
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
2012
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
2013
        control_files = lockable_files.LockableFiles(branch_transport,
 
2014
            'lock', lockdir.LockDir)
 
2015
        control_files.create_lock()
 
2016
        control_files.lock_write()
 
2017
        try:
 
2018
            utf8_files += [('format', self.get_format_string())]
 
2019
            for (filename, content) in utf8_files:
 
2020
                branch_transport.put_bytes(
 
2021
                    filename, content,
 
2022
                    mode=a_bzrdir._get_file_mode())
 
2023
        finally:
 
2024
            control_files.unlock()
 
2025
        branch = self.open(a_bzrdir, name, _found=True,
 
2026
                found_repository=repository)
 
2027
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2028
        return branch
 
2029
 
1957
2030
    def network_name(self):
1958
2031
        """A simple byte string uniquely identifying this format for RPC calls.
1959
2032
 
1961
2034
        """
1962
2035
        return self.get_format_string()
1963
2036
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2037
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2038
            found_repository=None):
1965
2039
        """See BranchFormat.open()."""
1966
2040
        if not _found:
1967
2041
            format = BranchFormat.find_format(a_bzrdir, name=name)
1972
2046
        try:
1973
2047
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
2048
                                                         lockdir.LockDir)
 
2049
            if found_repository is None:
 
2050
                found_repository = a_bzrdir.find_repository()
1975
2051
            return self._branch_class()(_format=self,
1976
2052
                              _control_files=control_files,
1977
2053
                              name=name,
1978
2054
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
 
2055
                              _repository=found_repository,
1980
2056
                              ignore_fallbacks=ignore_fallbacks)
1981
2057
        except errors.NoSuchFile:
1982
2058
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1989
2065
    def supports_tags(self):
1990
2066
        return True
1991
2067
 
 
2068
    def supports_leaving_lock(self):
 
2069
        return True
 
2070
 
1992
2071
 
1993
2072
class BzrBranchFormat5(BranchFormatMetadir):
1994
2073
    """Bzr branch format 5.
2014
2093
        """See BranchFormat.get_format_description()."""
2015
2094
        return "Branch format 5"
2016
2095
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
2096
    def initialize(self, a_bzrdir, name=None, repository=None):
2018
2097
        """Create a branch of this format in a_bzrdir."""
2019
2098
        utf8_files = [('revision-history', ''),
2020
2099
                      ('branch-name', ''),
2021
2100
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2101
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2023
2102
 
2024
2103
    def supports_tags(self):
2025
2104
        return False
2047
2126
        """See BranchFormat.get_format_description()."""
2048
2127
        return "Branch format 6"
2049
2128
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
2129
    def initialize(self, a_bzrdir, name=None, repository=None):
2051
2130
        """Create a branch of this format in a_bzrdir."""
2052
2131
        utf8_files = [('last-revision', '0 null:\n'),
2053
2132
                      ('branch.conf', ''),
2054
2133
                      ('tags', ''),
2055
2134
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2135
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2057
2136
 
2058
2137
    def make_tags(self, branch):
2059
2138
        """See bzrlib.branch.BranchFormat.make_tags()."""
2077
2156
        """See BranchFormat.get_format_description()."""
2078
2157
        return "Branch format 8"
2079
2158
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
2159
    def initialize(self, a_bzrdir, name=None, repository=None):
2081
2160
        """Create a branch of this format in a_bzrdir."""
2082
2161
        utf8_files = [('last-revision', '0 null:\n'),
2083
2162
                      ('branch.conf', ''),
2084
2163
                      ('tags', ''),
2085
2164
                      ('references', '')
2086
2165
                      ]
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()
 
2166
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2093
2167
 
2094
2168
    def make_tags(self, branch):
2095
2169
        """See bzrlib.branch.BranchFormat.make_tags()."""
2104
2178
    supports_reference_locations = True
2105
2179
 
2106
2180
 
2107
 
class BzrBranchFormat7(BzrBranchFormat8):
 
2181
class BzrBranchFormat7(BranchFormatMetadir):
2108
2182
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
2183
 
2110
2184
    The stacked location pointer is passed down to the repository and requires
2113
2187
    This format was introduced in bzr 1.6.
2114
2188
    """
2115
2189
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
2190
    def initialize(self, a_bzrdir, name=None, repository=None):
2117
2191
        """Create a branch of this format in a_bzrdir."""
2118
2192
        utf8_files = [('last-revision', '0 null:\n'),
2119
2193
                      ('branch.conf', ''),
2120
2194
                      ('tags', ''),
2121
2195
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2196
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2123
2197
 
2124
2198
    def _branch_class(self):
2125
2199
        return BzrBranch7
2135
2209
    def supports_set_append_revisions_only(self):
2136
2210
        return True
2137
2211
 
 
2212
    def supports_stacking(self):
 
2213
        return True
 
2214
 
 
2215
    def make_tags(self, branch):
 
2216
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2217
        return BasicTags(branch)
 
2218
 
2138
2219
    supports_reference_locations = False
2139
2220
 
2140
2221
 
2157
2238
        """See BranchFormat.get_format_description()."""
2158
2239
        return "Checkout reference format 1"
2159
2240
 
2160
 
    def get_reference(self, a_bzrdir):
 
2241
    def get_reference(self, a_bzrdir, name=None):
2161
2242
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2243
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2244
        return transport.get_bytes('location')
2164
2245
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2246
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2247
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2248
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2249
        location = transport.put_bytes('location', to_branch.base)
2169
2250
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2251
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2252
            repository=None):
2171
2253
        """Create a branch of this format in a_bzrdir."""
2172
2254
        if target_branch is None:
2173
2255
            # this format does not implement branch itself, thus the implicit
2201
2283
        return clone
2202
2284
 
2203
2285
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
2286
             possible_transports=None, ignore_fallbacks=False,
 
2287
             found_repository=None):
2205
2288
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2289
 
2207
2290
        :param a_bzrdir: A BzrDir that contains a branch.
2221
2304
                raise AssertionError("wrong format %r found for %r" %
2222
2305
                    (format, self))
2223
2306
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
 
2307
            location = self.get_reference(a_bzrdir, name)
2225
2308
        real_bzrdir = bzrdir.BzrDir.open(
2226
2309
            location, possible_transports=possible_transports)
2227
2310
        result = real_bzrdir.open_branch(name=name, 
2238
2321
        return result
2239
2322
 
2240
2323
 
 
2324
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2325
    """Branch format registry."""
 
2326
 
 
2327
    def __init__(self, other_registry=None):
 
2328
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2329
        self._default_format = None
 
2330
 
 
2331
    def set_default(self, format):
 
2332
        self._default_format = format
 
2333
 
 
2334
    def get_default(self):
 
2335
        return self._default_format
 
2336
 
 
2337
 
2241
2338
network_format_registry = registry.FormatRegistry()
2242
2339
"""Registry of formats indexed by their network name.
2243
2340
 
2246
2343
BranchFormat.network_name() for more detail.
2247
2344
"""
2248
2345
 
 
2346
format_registry = BranchFormatRegistry(network_format_registry)
 
2347
 
2249
2348
 
2250
2349
# formats which have no format string are not discoverable
2251
2350
# and not independently creatable, so are not registered.
2253
2352
__format6 = BzrBranchFormat6()
2254
2353
__format7 = BzrBranchFormat7()
2255
2354
__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__)
 
2355
format_registry.register(__format5)
 
2356
format_registry.register(BranchReferenceFormat())
 
2357
format_registry.register(__format6)
 
2358
format_registry.register(__format7)
 
2359
format_registry.register(__format8)
 
2360
format_registry.set_default(__format7)
 
2361
 
 
2362
 
 
2363
class BranchWriteLockResult(LogicalLockResult):
 
2364
    """The result of write locking a branch.
 
2365
 
 
2366
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2367
        None.
 
2368
    :ivar unlock: A callable which will unlock the lock.
 
2369
    """
 
2370
 
 
2371
    def __init__(self, unlock, branch_token):
 
2372
        LogicalLockResult.__init__(self, unlock)
 
2373
        self.branch_token = branch_token
 
2374
 
 
2375
    def __repr__(self):
 
2376
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2377
            self.unlock)
2266
2378
 
2267
2379
 
2268
2380
class BzrBranch(Branch, _RelockDebugMixin):
2324
2436
        return self.control_files.is_locked()
2325
2437
 
2326
2438
    def lock_write(self, token=None):
 
2439
        """Lock the branch for write operations.
 
2440
 
 
2441
        :param token: A token to permit reacquiring a previously held and
 
2442
            preserved lock.
 
2443
        :return: A BranchWriteLockResult.
 
2444
        """
2327
2445
        if not self.is_locked():
2328
2446
            self._note_lock('w')
2329
2447
        # All-in-one needs to always unlock/lock.
2335
2453
        else:
2336
2454
            took_lock = False
2337
2455
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2456
            return BranchWriteLockResult(self.unlock,
 
2457
                self.control_files.lock_write(token=token))
2339
2458
        except:
2340
2459
            if took_lock:
2341
2460
                self.repository.unlock()
2342
2461
            raise
2343
2462
 
2344
2463
    def lock_read(self):
 
2464
        """Lock the branch for read operations.
 
2465
 
 
2466
        :return: A bzrlib.lock.LogicalLockResult.
 
2467
        """
2345
2468
        if not self.is_locked():
2346
2469
            self._note_lock('r')
2347
2470
        # All-in-one needs to always unlock/lock.
2354
2477
            took_lock = False
2355
2478
        try:
2356
2479
            self.control_files.lock_read()
 
2480
            return LogicalLockResult(self.unlock)
2357
2481
        except:
2358
2482
            if took_lock:
2359
2483
                self.repository.unlock()
2387
2511
        """See Branch.print_file."""
2388
2512
        return self.repository.print_file(file, revision_id)
2389
2513
 
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
2514
    @needs_write_lock
2454
2515
    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
 
        """
 
2516
        if not revision_id or not isinstance(revision_id, basestring):
 
2517
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2465
2518
        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))
 
2519
        old_revno, old_revid = self.last_revision_info()
 
2520
        if self._get_append_revisions_only():
 
2521
            self._check_history_violation(revision_id)
 
2522
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2523
        self._write_last_revision_info(revno, revision_id)
 
2524
        self._clear_cached_state()
 
2525
        self._last_revision_info_cache = revno, revision_id
 
2526
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2494
2527
 
2495
2528
    def basis_tree(self):
2496
2529
        """See Branch.basis_tree."""
2505
2538
                pass
2506
2539
        return None
2507
2540
 
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
2541
    def get_stacked_on_url(self):
2531
2542
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2532
2543
 
2543
2554
            self._transport.put_bytes('parent', url + '\n',
2544
2555
                mode=self.bzrdir._get_file_mode())
2545
2556
 
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
2557
    @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
 
2558
    def unbind(self):
 
2559
        """If bound, unbind"""
 
2560
        return self.set_bound_location(None)
2595
2561
 
2596
2562
    @needs_write_lock
2597
2563
    def bind(self, other):
2619
2585
        # history around
2620
2586
        self.set_bound_location(other.base)
2621
2587
 
 
2588
    def get_bound_location(self):
 
2589
        try:
 
2590
            return self._transport.get_bytes('bound')[:-1]
 
2591
        except errors.NoSuchFile:
 
2592
            return None
 
2593
 
 
2594
    @needs_read_lock
 
2595
    def get_master_branch(self, possible_transports=None):
 
2596
        """Return the branch we are bound to.
 
2597
 
 
2598
        :return: Either a Branch, or None
 
2599
        """
 
2600
        if self._master_branch_cache is None:
 
2601
            self._master_branch_cache = self._get_master_branch(
 
2602
                possible_transports)
 
2603
        return self._master_branch_cache
 
2604
 
 
2605
    def _get_master_branch(self, possible_transports):
 
2606
        bound_loc = self.get_bound_location()
 
2607
        if not bound_loc:
 
2608
            return None
 
2609
        try:
 
2610
            return Branch.open(bound_loc,
 
2611
                               possible_transports=possible_transports)
 
2612
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2613
            raise errors.BoundBranchConnectionFailure(
 
2614
                    self, bound_loc, e)
 
2615
 
2622
2616
    @needs_write_lock
2623
 
    def unbind(self):
2624
 
        """If bound, unbind"""
2625
 
        return self.set_bound_location(None)
 
2617
    def set_bound_location(self, location):
 
2618
        """Set the target where this branch is bound to.
 
2619
 
 
2620
        :param location: URL to the target branch
 
2621
        """
 
2622
        self._master_branch_cache = None
 
2623
        if location:
 
2624
            self._transport.put_bytes('bound', location+'\n',
 
2625
                mode=self.bzrdir._get_file_mode())
 
2626
        else:
 
2627
            try:
 
2628
                self._transport.delete('bound')
 
2629
            except errors.NoSuchFile:
 
2630
                return False
 
2631
            return True
2626
2632
 
2627
2633
    @needs_write_lock
2628
2634
    def update(self, possible_transports=None):
2641
2647
            return old_tip
2642
2648
        return None
2643
2649
 
2644
 
 
2645
 
class BzrBranch8(BzrBranch5):
 
2650
    def _read_last_revision_info(self):
 
2651
        revision_string = self._transport.get_bytes('last-revision')
 
2652
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2653
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2654
        revno = int(revno)
 
2655
        return revno, revision_id
 
2656
 
 
2657
    def _write_last_revision_info(self, revno, revision_id):
 
2658
        """Simply write out the revision id, with no checks.
 
2659
 
 
2660
        Use set_last_revision_info to perform this safely.
 
2661
 
 
2662
        Does not update the revision_history cache.
 
2663
        """
 
2664
        revision_id = _mod_revision.ensure_null(revision_id)
 
2665
        out_string = '%d %s\n' % (revno, revision_id)
 
2666
        self._transport.put_bytes('last-revision', out_string,
 
2667
            mode=self.bzrdir._get_file_mode())
 
2668
 
 
2669
 
 
2670
class FullHistoryBzrBranch(BzrBranch):
 
2671
    """Bzr branch which contains the full revision history."""
 
2672
 
 
2673
    @needs_write_lock
 
2674
    def set_last_revision_info(self, revno, revision_id):
 
2675
        if not revision_id or not isinstance(revision_id, basestring):
 
2676
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2677
        revision_id = _mod_revision.ensure_null(revision_id)
 
2678
        # this old format stores the full history, but this api doesn't
 
2679
        # provide it, so we must generate, and might as well check it's
 
2680
        # correct
 
2681
        history = self._lefthand_history(revision_id)
 
2682
        if len(history) != revno:
 
2683
            raise AssertionError('%d != %d' % (len(history), revno))
 
2684
        self._set_revision_history(history)
 
2685
 
 
2686
    def _read_last_revision_info(self):
 
2687
        rh = self.revision_history()
 
2688
        revno = len(rh)
 
2689
        if revno:
 
2690
            return (revno, rh[-1])
 
2691
        else:
 
2692
            return (0, _mod_revision.NULL_REVISION)
 
2693
 
 
2694
    @deprecated_method(deprecated_in((2, 4, 0)))
 
2695
    @needs_write_lock
 
2696
    def set_revision_history(self, rev_history):
 
2697
        """See Branch.set_revision_history."""
 
2698
        self._set_revision_history(rev_history)
 
2699
 
 
2700
    def _set_revision_history(self, rev_history):
 
2701
        if 'evil' in debug.debug_flags:
 
2702
            mutter_callsite(3, "set_revision_history scales with history.")
 
2703
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2704
        for rev_id in rev_history:
 
2705
            check_not_reserved_id(rev_id)
 
2706
        if Branch.hooks['post_change_branch_tip']:
 
2707
            # Don't calculate the last_revision_info() if there are no hooks
 
2708
            # that will use it.
 
2709
            old_revno, old_revid = self.last_revision_info()
 
2710
        if len(rev_history) == 0:
 
2711
            revid = _mod_revision.NULL_REVISION
 
2712
        else:
 
2713
            revid = rev_history[-1]
 
2714
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2715
        self._write_revision_history(rev_history)
 
2716
        self._clear_cached_state()
 
2717
        self._cache_revision_history(rev_history)
 
2718
        for hook in Branch.hooks['set_rh']:
 
2719
            hook(self, rev_history)
 
2720
        if Branch.hooks['post_change_branch_tip']:
 
2721
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2722
 
 
2723
    def _write_revision_history(self, history):
 
2724
        """Factored out of set_revision_history.
 
2725
 
 
2726
        This performs the actual writing to disk.
 
2727
        It is intended to be called by set_revision_history."""
 
2728
        self._transport.put_bytes(
 
2729
            'revision-history', '\n'.join(history),
 
2730
            mode=self.bzrdir._get_file_mode())
 
2731
 
 
2732
    def _gen_revision_history(self):
 
2733
        history = self._transport.get_bytes('revision-history').split('\n')
 
2734
        if history[-1:] == ['']:
 
2735
            # There shouldn't be a trailing newline, but just in case.
 
2736
            history.pop()
 
2737
        return history
 
2738
 
 
2739
    def _synchronize_history(self, destination, revision_id):
 
2740
        if not isinstance(destination, FullHistoryBzrBranch):
 
2741
            super(BzrBranch, self)._synchronize_history(
 
2742
                destination, revision_id)
 
2743
            return
 
2744
        if revision_id == _mod_revision.NULL_REVISION:
 
2745
            new_history = []
 
2746
        else:
 
2747
            new_history = self.revision_history()
 
2748
        if revision_id is not None and new_history != []:
 
2749
            try:
 
2750
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2751
            except ValueError:
 
2752
                rev = self.repository.get_revision(revision_id)
 
2753
                new_history = rev.get_history(self.repository)[1:]
 
2754
        destination._set_revision_history(new_history)
 
2755
 
 
2756
    @needs_write_lock
 
2757
    def generate_revision_history(self, revision_id, last_rev=None,
 
2758
        other_branch=None):
 
2759
        """Create a new revision history that will finish with revision_id.
 
2760
 
 
2761
        :param revision_id: the new tip to use.
 
2762
        :param last_rev: The previous last_revision. If not None, then this
 
2763
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2764
        :param other_branch: The other branch that DivergedBranches should
 
2765
            raise with respect to.
 
2766
        """
 
2767
        self._set_revision_history(self._lefthand_history(revision_id,
 
2768
            last_rev, other_branch))
 
2769
 
 
2770
 
 
2771
class BzrBranch5(FullHistoryBzrBranch):
 
2772
    """A format 5 branch. This supports new features over plain branches.
 
2773
 
 
2774
    It has support for a master_branch which is the data for bound branches.
 
2775
    """
 
2776
 
 
2777
 
 
2778
class BzrBranch8(BzrBranch):
2646
2779
    """A branch that stores tree-reference locations."""
2647
2780
 
2648
2781
    def _open_hook(self):
2674
2807
        self._last_revision_info_cache = None
2675
2808
        self._reference_info = None
2676
2809
 
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
2810
    def _check_history_violation(self, revision_id):
2723
2811
        last_revision = _mod_revision.ensure_null(self.last_revision())
2724
2812
        if _mod_revision.is_null(last_revision):
2733
2821
        self._extend_partial_history(stop_index=last_revno-1)
2734
2822
        return list(reversed(self._partial_revision_history_cache))
2735
2823
 
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
2824
    @needs_write_lock
2753
2825
    def _set_parent_location(self, url):
2754
2826
        """Set the parent branch"""
2840
2912
 
2841
2913
    def set_bound_location(self, location):
2842
2914
        """See Branch.set_push_location."""
 
2915
        self._master_branch_cache = None
2843
2916
        result = None
2844
2917
        config = self.get_config()
2845
2918
        if location is None:
2885
2958
        return self.get_config(
2886
2959
            ).get_user_option_as_bool('append_revisions_only')
2887
2960
 
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
2961
    @needs_read_lock
2897
2962
    def get_rev_id(self, revno, history=None):
2898
2963
        """Find the revision id of the specified revno."""
2922
2987
        try:
2923
2988
            index = self._partial_revision_history_cache.index(revision_id)
2924
2989
        except ValueError:
2925
 
            self._extend_partial_history(stop_revision=revision_id)
 
2990
            try:
 
2991
                self._extend_partial_history(stop_revision=revision_id)
 
2992
            except errors.RevisionNotPresent, e:
 
2993
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2926
2994
            index = len(self._partial_revision_history_cache) - 1
2927
2995
            if self._partial_revision_history_cache[index] != revision_id:
2928
2996
                raise errors.NoSuchRevision(self, revision_id)
2983
3051
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2984
3052
    """
2985
3053
 
 
3054
    @deprecated_method(deprecated_in((2, 3, 0)))
2986
3055
    def __int__(self):
2987
 
        # DEPRECATED: pull used to return the change in revno
 
3056
        """Return the relative change in revno.
 
3057
 
 
3058
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3059
        """
2988
3060
        return self.new_revno - self.old_revno
2989
3061
 
2990
3062
    def report(self, to_file):
3015
3087
        target, otherwise it will be None.
3016
3088
    """
3017
3089
 
 
3090
    @deprecated_method(deprecated_in((2, 3, 0)))
3018
3091
    def __int__(self):
3019
 
        # DEPRECATED: push used to return the change in revno
 
3092
        """Return the relative change in revno.
 
3093
 
 
3094
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3095
        """
3020
3096
        return self.new_revno - self.old_revno
3021
3097
 
3022
3098
    def report(self, to_file):
3145
3221
    _optimisers = []
3146
3222
    """The available optimised InterBranch types."""
3147
3223
 
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)
 
3224
    @classmethod
 
3225
    def _get_branch_formats_to_test(klass):
 
3226
        """Return an iterable of format tuples for testing.
 
3227
        
 
3228
        :return: An iterable of (from_format, to_format) to use when testing
 
3229
            this InterBranch class. Each InterBranch class should define this
 
3230
            method itself.
 
3231
        """
 
3232
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3233
 
 
3234
    @needs_write_lock
3153
3235
    def pull(self, overwrite=False, stop_revision=None,
3154
3236
             possible_transports=None, local=False):
3155
3237
        """Mirror source into target branch.
3160
3242
        """
3161
3243
        raise NotImplementedError(self.pull)
3162
3244
 
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
 
 
 
3245
    @needs_write_lock
3176
3246
    def push(self, overwrite=False, stop_revision=None,
3177
3247
             _override_hook_source_branch=None):
3178
3248
        """Mirror the source branch into the target branch.
3181
3251
        """
3182
3252
        raise NotImplementedError(self.push)
3183
3253
 
 
3254
    @needs_write_lock
 
3255
    def copy_content_into(self, revision_id=None):
 
3256
        """Copy the content of source into target
 
3257
 
 
3258
        revision_id: if not None, the revision history in the new branch will
 
3259
                     be truncated to end with revision_id.
 
3260
        """
 
3261
        raise NotImplementedError(self.copy_content_into)
 
3262
 
 
3263
    @needs_write_lock
 
3264
    def fetch(self, stop_revision=None):
 
3265
        """Fetch revisions.
 
3266
 
 
3267
        :param stop_revision: Last revision to fetch
 
3268
        """
 
3269
        raise NotImplementedError(self.fetch)
 
3270
 
3184
3271
 
3185
3272
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()."""
 
3273
    """InterBranch implementation that uses public Branch functions."""
 
3274
 
 
3275
    @classmethod
 
3276
    def is_compatible(klass, source, target):
 
3277
        # GenericBranch uses the public API, so always compatible
 
3278
        return True
 
3279
 
 
3280
    @classmethod
 
3281
    def _get_branch_formats_to_test(klass):
 
3282
        return [(format_registry.get_default(), format_registry.get_default())]
 
3283
 
 
3284
    @classmethod
 
3285
    def unwrap_format(klass, format):
 
3286
        if isinstance(format, remote.RemoteBranchFormat):
 
3287
            format._ensure_real()
 
3288
            return format._custom_format
 
3289
        return format
 
3290
 
 
3291
    @needs_write_lock
 
3292
    def copy_content_into(self, revision_id=None):
 
3293
        """Copy the content of source into target
 
3294
 
 
3295
        revision_id: if not None, the revision history in the new branch will
 
3296
                     be truncated to end with revision_id.
 
3297
        """
 
3298
        self.source.update_references(self.target)
 
3299
        self.source._synchronize_history(self.target, revision_id)
 
3300
        try:
 
3301
            parent = self.source.get_parent()
 
3302
        except errors.InaccessibleParent, e:
 
3303
            mutter('parent was not accessible to copy: %s', e)
 
3304
        else:
 
3305
            if parent:
 
3306
                self.target.set_parent(parent)
 
3307
        if self.source._push_should_merge_tags():
 
3308
            self.source.tags.merge_to(self.target.tags)
 
3309
 
 
3310
    @needs_write_lock
 
3311
    def fetch(self, stop_revision=None):
 
3312
        if self.target.base == self.source.base:
 
3313
            return (0, [])
3196
3314
        self.source.lock_read()
3197
3315
        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)
 
3316
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3317
            fetch_spec_factory.source_branch = self.source
 
3318
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3319
            fetch_spec_factory.source_repo = self.source.repository
 
3320
            fetch_spec_factory.target_repo = self.target.repository
 
3321
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3322
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3323
            return self.target.repository.fetch(self.source.repository,
 
3324
                fetch_spec=fetch_spec)
3233
3325
        finally:
3234
3326
            self.source.unlock()
3235
3327
 
 
3328
    @needs_write_lock
 
3329
    def _update_revisions(self, stop_revision=None, overwrite=False,
 
3330
            graph=None):
 
3331
        other_revno, other_last_revision = self.source.last_revision_info()
 
3332
        stop_revno = None # unknown
 
3333
        if stop_revision is None:
 
3334
            stop_revision = other_last_revision
 
3335
            if _mod_revision.is_null(stop_revision):
 
3336
                # if there are no commits, we're done.
 
3337
                return
 
3338
            stop_revno = other_revno
 
3339
 
 
3340
        # what's the current last revision, before we fetch [and change it
 
3341
        # possibly]
 
3342
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3343
        # we fetch here so that we don't process data twice in the common
 
3344
        # case of having something to pull, and so that the check for
 
3345
        # already merged can operate on the just fetched graph, which will
 
3346
        # be cached in memory.
 
3347
        self.fetch(stop_revision=stop_revision)
 
3348
        # Check to see if one is an ancestor of the other
 
3349
        if not overwrite:
 
3350
            if graph is None:
 
3351
                graph = self.target.repository.get_graph()
 
3352
            if self.target._check_if_descendant_or_diverged(
 
3353
                    stop_revision, last_rev, graph, self.source):
 
3354
                # stop_revision is a descendant of last_rev, but we aren't
 
3355
                # overwriting, so we're done.
 
3356
                return
 
3357
        if stop_revno is None:
 
3358
            if graph is None:
 
3359
                graph = self.target.repository.get_graph()
 
3360
            this_revno, this_last_revision = \
 
3361
                    self.target.last_revision_info()
 
3362
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3363
                            [(other_last_revision, other_revno),
 
3364
                             (this_last_revision, this_revno)])
 
3365
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3366
 
 
3367
    @needs_write_lock
3236
3368
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3369
             possible_transports=None, run_hooks=True,
3238
3370
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
 
3371
        """Pull from source into self, updating my master if any.
3240
3372
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
3373
        :param run_hooks: Private parameter - if false, this branch
3244
3374
            is being called because it's the master of the primary branch,
3245
3375
            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
3376
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
 
3377
        bound_location = self.target.get_bound_location()
 
3378
        if local and not bound_location:
3252
3379
            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()
 
3380
        master_branch = None
 
3381
        source_is_master = (self.source.user_url == bound_location)
 
3382
        if not local and bound_location and not source_is_master:
 
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()
3260
3386
        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)
 
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 self._pull(overwrite,
 
3392
                stop_revision, _hook_master=master_branch,
 
3393
                run_hooks=run_hooks,
 
3394
                _override_hook_target=_override_hook_target,
 
3395
                merge_tags_to_master=not source_is_master)
3287
3396
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
 
3397
            if master_branch:
 
3398
                master_branch.unlock()
3290
3399
 
3291
3400
    def push(self, overwrite=False, stop_revision=None,
3292
3401
             _override_hook_source_branch=None):
3310
3419
        finally:
3311
3420
            self.source.unlock()
3312
3421
 
 
3422
    def _basic_push(self, overwrite, stop_revision):
 
3423
        """Basic implementation of push without bound branches or hooks.
 
3424
 
 
3425
        Must be called with source read locked and target write locked.
 
3426
        """
 
3427
        result = BranchPushResult()
 
3428
        result.source_branch = self.source
 
3429
        result.target_branch = self.target
 
3430
        result.old_revno, result.old_revid = self.target.last_revision_info()
 
3431
        self.source.update_references(self.target)
 
3432
        if result.old_revid != stop_revision:
 
3433
            # We assume that during 'push' this repository is closer than
 
3434
            # the target.
 
3435
            graph = self.source.repository.get_graph(self.target.repository)
 
3436
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3437
                    graph=graph)
 
3438
        if self.source._push_should_merge_tags():
 
3439
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3440
                overwrite)
 
3441
        result.new_revno, result.new_revid = self.target.last_revision_info()
 
3442
        return result
 
3443
 
3313
3444
    def _push_with_bound_branches(self, overwrite, stop_revision,
3314
3445
            _override_hook_source_branch=None):
3315
3446
        """Push from source into target, and into target's master if any.
3330
3461
            master_branch.lock_write()
3331
3462
            try:
3332
3463
                # 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)
 
3464
                master_inter = InterBranch.get(self.source, master_branch)
 
3465
                master_inter._basic_push(overwrite, stop_revision)
 
3466
                # and push into the target branch from the source. Note that
 
3467
                # we push from the source branch again, because it's considered
 
3468
                # the highest bandwidth repository.
 
3469
                result = self._basic_push(overwrite, stop_revision)
3339
3470
                result.master_branch = master_branch
3340
3471
                result.local_branch = self.target
3341
3472
                _run_hooks()
3344
3475
                master_branch.unlock()
3345
3476
        else:
3346
3477
            # no master branch
3347
 
            result = self.source._basic_push(self.target, overwrite,
3348
 
                stop_revision)
 
3478
            result = self._basic_push(overwrite, stop_revision)
3349
3479
            # TODO: Why set master_branch and local_branch if there's no
3350
3480
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3351
3481
            # 20070504
3354
3484
            _run_hooks()
3355
3485
            return result
3356
3486
 
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
 
 
 
3487
    def _pull(self, overwrite=False, stop_revision=None,
 
3488
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3489
             _override_hook_target=None, local=False,
 
3490
             merge_tags_to_master=True):
 
3491
        """See Branch.pull.
 
3492
 
 
3493
        This function is the core worker, used by GenericInterBranch.pull to
 
3494
        avoid duplication when pulling source->master and source->local.
 
3495
 
 
3496
        :param _hook_master: Private parameter - set the branch to
 
3497
            be supplied as the master to pull hooks.
3374
3498
        :param run_hooks: Private parameter - if false, this branch
3375
3499
            is being called because it's the master of the primary branch,
3376
3500
            so it should not run its hooks.
 
3501
            is being called because it's the master of the primary branch,
 
3502
            so it should not run its hooks.
 
3503
        :param _override_hook_target: Private parameter - set the branch to be
 
3504
            supplied as the target_branch to pull hooks.
 
3505
        :param local: Only update the local branch, and not the bound branch.
3377
3506
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
 
3507
        # This type of branch can't be bound.
 
3508
        if local:
3380
3509
            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()
 
3510
        result = PullResult()
 
3511
        result.source_branch = self.source
 
3512
        if _override_hook_target is None:
 
3513
            result.target_branch = self.target
 
3514
        else:
 
3515
            result.target_branch = _override_hook_target
 
3516
        self.source.lock_read()
3386
3517
        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)
 
3518
            # We assume that during 'pull' the target repository is closer than
 
3519
            # the source one.
 
3520
            self.source.update_references(self.target)
 
3521
            graph = self.target.repository.get_graph(self.source.repository)
 
3522
            # TODO: Branch formats should have a flag that indicates 
 
3523
            # that revno's are expensive, and pull() should honor that flag.
 
3524
            # -- JRV20090506
 
3525
            result.old_revno, result.old_revid = \
 
3526
                self.target.last_revision_info()
 
3527
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3528
                graph=graph)
 
3529
            # TODO: The old revid should be specified when merging tags, 
 
3530
            # so a tags implementation that versions tags can only 
 
3531
            # pull in the most recent changes. -- JRV20090506
 
3532
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3533
                overwrite, ignore_master=not merge_tags_to_master)
 
3534
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3535
            if _hook_master:
 
3536
                result.master_branch = _hook_master
 
3537
                result.local_branch = result.target_branch
 
3538
            else:
 
3539
                result.master_branch = result.target_branch
 
3540
                result.local_branch = None
 
3541
            if run_hooks:
 
3542
                for hook in Branch.hooks['post_pull']:
 
3543
                    hook(result)
3395
3544
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
 
3545
            self.source.unlock()
 
3546
        return result
3398
3547
 
3399
3548
 
3400
3549
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)