/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-01 21:02:50 UTC
  • mto: This revision was merged to the branch mainline in revision 5842.
  • Revision ID: jelmer@samba.org-20110501210250-24jq6hrxxc9psvzf
Actually use branch format 5 in branch format 5 test.

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, fetch_spec=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.
 
678
        :param fetch_spec: If specified, a SearchResult or
 
679
            PendingAncestryResult that describes which revisions to copy.  This
 
680
            allows copying multiple heads at once.  Mutually exclusive with
 
681
            last_revision.
636
682
        :return: None
637
683
        """
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()
 
684
        return InterBranch.get(from_branch, self).fetch(last_revision,
 
685
            fetch_spec)
654
686
 
655
687
    def get_bound_location(self):
656
688
        """Return the URL of the branch we are bound to.
667
699
 
668
700
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
701
                           timezone=None, committer=None, revprops=None,
670
 
                           revision_id=None):
 
702
                           revision_id=None, lossy=False):
671
703
        """Obtain a CommitBuilder for this branch.
672
704
 
673
705
        :param parents: Revision ids of the parents of the new revision.
677
709
        :param committer: Optional committer to set for commit.
678
710
        :param revprops: Optional dictionary of revision properties.
679
711
        :param revision_id: Optional revision id.
 
712
        :param lossy: Whether to discard data that can not be natively
 
713
            represented, when pushing to a foreign VCS 
680
714
        """
681
715
 
682
716
        if config is None:
683
717
            config = self.get_config()
684
718
 
685
719
        return self.repository.get_commit_builder(self, parents, config,
686
 
            timestamp, timezone, committer, revprops, revision_id)
 
720
            timestamp, timezone, committer, revprops, revision_id,
 
721
            lossy)
687
722
 
688
723
    def get_master_branch(self, possible_transports=None):
689
724
        """Return the branch we are bound to.
716
751
        """Print `file` to stdout."""
717
752
        raise NotImplementedError(self.print_file)
718
753
 
 
754
    @deprecated_method(deprecated_in((2, 4, 0)))
 
755
    @needs_write_lock
719
756
    def set_revision_history(self, rev_history):
720
 
        raise NotImplementedError(self.set_revision_history)
 
757
        """See Branch.set_revision_history."""
 
758
        if len(rev_history) == 0:
 
759
            revid = _mod_revision.NULL_REVISION
 
760
        else:
 
761
            revid = rev_history[-1]
 
762
        self.set_last_revision_info(len(rev_history), revid)
 
763
        self._cache_revision_history(rev_history)
 
764
 
 
765
    @needs_write_lock
 
766
    def set_last_revision_info(self, revno, revision_id):
 
767
        """Set the last revision of this branch.
 
768
 
 
769
        The caller is responsible for checking that the revno is correct
 
770
        for this revision id.
 
771
 
 
772
        It may be possible to set the branch last revision to an id not
 
773
        present in the repository.  However, branches can also be
 
774
        configured to check constraints on history, in which case this may not
 
775
        be permitted.
 
776
        """
 
777
        raise NotImplementedError(self.last_revision_info)
 
778
 
 
779
    @needs_write_lock
 
780
    def generate_revision_history(self, revision_id, last_rev=None,
 
781
                                  other_branch=None):
 
782
        """See BzrBranch5.generate_revision_history"""
 
783
        # FIXME: This shouldn't have to fetch the entire history
 
784
        history = self._lefthand_history(revision_id, last_rev, other_branch)
 
785
        revno = len(history)
 
786
        self.set_last_revision_info(revno, revision_id)
 
787
        self._cache_revision_history(history)
721
788
 
722
789
    @needs_write_lock
723
790
    def set_parent(self, url):
767
834
 
768
835
    def _unstack(self):
769
836
        """Change a branch to be unstacked, copying data as needed.
770
 
        
 
837
 
771
838
        Don't call this directly, use set_stacked_on_url(None).
772
839
        """
773
840
        pb = ui.ui_factory.nested_progress_bar()
782
849
            old_repository = self.repository
783
850
            if len(old_repository._fallback_repositories) != 1:
784
851
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
 
852
                    "of %r (fallbacks: %r)" % (old_repository,
 
853
                        old_repository._fallback_repositories))
 
854
            # Open the new repository object.
 
855
            # Repositories don't offer an interface to remove fallback
 
856
            # repositories today; take the conceptually simpler option and just
 
857
            # reopen it.  We reopen it starting from the URL so that we
 
858
            # get a separate connection for RemoteRepositories and can
 
859
            # stream from one of them to the other.  This does mean doing
 
860
            # separate SSH connection setup, but unstacking is not a
 
861
            # common operation so it's tolerable.
 
862
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
863
            new_repository = new_bzrdir.find_repository()
 
864
            if new_repository._fallback_repositories:
 
865
                raise AssertionError("didn't expect %r to have "
 
866
                    "fallback_repositories"
 
867
                    % (self.repository,))
 
868
            # Replace self.repository with the new repository.
 
869
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
870
            # lock count) of self.repository to the new repository.
 
871
            lock_token = old_repository.lock_write().repository_token
 
872
            self.repository = new_repository
 
873
            if isinstance(self, remote.RemoteBranch):
 
874
                # Remote branches can have a second reference to the old
 
875
                # repository that need to be replaced.
 
876
                if self._real_branch is not None:
 
877
                    self._real_branch.repository = new_repository
 
878
            self.repository.lock_write(token=lock_token)
 
879
            if lock_token is not None:
 
880
                old_repository.leave_lock_in_place()
787
881
            old_repository.unlock()
 
882
            if lock_token is not None:
 
883
                # XXX: self.repository.leave_lock_in_place() before this
 
884
                # function will not be preserved.  Fortunately that doesn't
 
885
                # affect the current default format (2a), and would be a
 
886
                # corner-case anyway.
 
887
                #  - Andrew Bennetts, 2010/06/30
 
888
                self.repository.dont_leave_lock_in_place()
 
889
            old_lock_count = 0
 
890
            while True:
 
891
                try:
 
892
                    old_repository.unlock()
 
893
                except errors.LockNotHeld:
 
894
                    break
 
895
                old_lock_count += 1
 
896
            if old_lock_count == 0:
 
897
                raise AssertionError(
 
898
                    'old_repository should have been locked at least once.')
 
899
            for i in range(old_lock_count-1):
 
900
                self.repository.lock_write()
 
901
            # Fetch from the old repository into the new.
788
902
            old_repository.lock_read()
789
903
            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
904
                # XXX: If you unstack a branch while it has a working tree
809
905
                # with a pending merge, the pending-merged revisions will no
810
906
                # 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)
 
907
                try:
 
908
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
909
                except errors.TagsNotSupported:
 
910
                    tags_to_fetch = set()
 
911
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
912
                    old_repository, required_ids=[self.last_revision()],
 
913
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
914
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
818
915
            finally:
819
916
                old_repository.unlock()
820
917
        finally:
825
922
 
826
923
        :seealso: Branch._get_tags_bytes.
827
924
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
925
        return _run_with_write_locked_target(self, self._set_tags_bytes_locked,
 
926
                bytes)
 
927
 
 
928
    def _set_tags_bytes_locked(self, bytes):
 
929
        self._tags_bytes = bytes
 
930
        return self._transport.put_bytes('tags', bytes)
830
931
 
831
932
    def _cache_revision_history(self, rev_history):
832
933
        """Set the cached revision history to rev_history.
859
960
        self._revision_history_cache = None
860
961
        self._revision_id_to_revno_cache = None
861
962
        self._last_revision_info_cache = None
 
963
        self._master_branch_cache = None
862
964
        self._merge_sorted_revisions_cache = None
863
965
        self._partial_revision_history_cache = []
864
966
        self._partial_revision_id_to_revno_cache = {}
 
967
        self._tags_bytes = None
865
968
 
866
969
    def _gen_revision_history(self):
867
970
        """Return sequence of revision hashes on to this branch.
917
1020
        :return: A tuple (revno, revision_id).
918
1021
        """
919
1022
        if self._last_revision_info_cache is None:
920
 
            self._last_revision_info_cache = self._last_revision_info()
 
1023
            self._last_revision_info_cache = self._read_last_revision_info()
921
1024
        return self._last_revision_info_cache
922
1025
 
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
 
1026
    def _read_last_revision_info(self):
 
1027
        raise NotImplementedError(self._read_last_revision_info)
 
1028
 
955
1029
    def update_revisions(self, other, stop_revision=None, overwrite=False,
956
 
                         graph=None):
 
1030
                         graph=None, fetch_tags=True):
957
1031
        """Pull in new perfect-fit revisions.
958
1032
 
959
1033
        :param other: Another Branch to pull from
962
1036
            to see if it is a proper descendant.
963
1037
        :param graph: A Graph object that can be used to query history
964
1038
            information. This can be None.
 
1039
        :param fetch_tags: Flag that specifies if tags from other should be
 
1040
            fetched too.
965
1041
        :return: None
966
1042
        """
967
1043
        return InterBranch.get(other, self).update_revisions(stop_revision,
968
 
            overwrite, graph)
 
1044
            overwrite, graph, fetch_tags=fetch_tags)
969
1045
 
 
1046
    @deprecated_method(deprecated_in((2, 4, 0)))
970
1047
    def import_last_revision_info(self, source_repo, revno, revid):
971
1048
        """Set the last revision info, importing from another repo if necessary.
972
1049
 
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
1050
        :param source_repo: Source repository to optionally fetch from
977
1051
        :param revno: Revision number of the new tip
978
1052
        :param revid: Revision id of the new tip
981
1055
            self.repository.fetch(source_repo, revision_id=revid)
982
1056
        self.set_last_revision_info(revno, revid)
983
1057
 
 
1058
    def import_last_revision_info_and_tags(self, source, revno, revid,
 
1059
                                           lossy=False):
 
1060
        """Set the last revision info, importing from another repo if necessary.
 
1061
 
 
1062
        This is used by the bound branch code to upload a revision to
 
1063
        the master branch first before updating the tip of the local branch.
 
1064
        Revisions referenced by source's tags are also transferred.
 
1065
 
 
1066
        :param source: Source branch to optionally fetch from
 
1067
        :param revno: Revision number of the new tip
 
1068
        :param revid: Revision id of the new tip
 
1069
        :param lossy: Whether to discard metadata that can not be
 
1070
            natively represented
 
1071
        :return: Tuple with the new revision number and revision id
 
1072
            (should only be different from the arguments when lossy=True)
 
1073
        """
 
1074
        if not self.repository.has_same_location(source.repository):
 
1075
            try:
 
1076
                tags_to_fetch = set(source.tags.get_reverse_tag_dict())
 
1077
            except errors.TagsNotSupported:
 
1078
                tags_to_fetch = set()
 
1079
            fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
1080
                source.repository, [revid],
 
1081
                if_present_ids=tags_to_fetch).execute()
 
1082
            self.repository.fetch(source.repository, fetch_spec=fetch_spec)
 
1083
        self.set_last_revision_info(revno, revid)
 
1084
        return (revno, revid)
 
1085
 
984
1086
    def revision_id_to_revno(self, revision_id):
985
1087
        """Given a revision id, return its revno"""
986
1088
        if _mod_revision.is_null(revision_id):
1006
1108
            self._extend_partial_history(distance_from_last)
1007
1109
        return self._partial_revision_history_cache[distance_from_last]
1008
1110
 
1009
 
    @needs_write_lock
1010
1111
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1112
             possible_transports=None, *args, **kwargs):
1012
1113
        """Mirror source into this branch.
1208
1309
        return result
1209
1310
 
1210
1311
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1312
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1313
            repository=None):
1212
1314
        """Create a new line of development from the branch, into to_bzrdir.
1213
1315
 
1214
1316
        to_bzrdir controls the branch format.
1219
1321
        if (repository_policy is not None and
1220
1322
            repository_policy.requires_stacking()):
1221
1323
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
 
        result = to_bzrdir.create_branch()
 
1324
        result = to_bzrdir.create_branch(repository=repository)
1223
1325
        result.lock_write()
1224
1326
        try:
1225
1327
            if repository_policy is not None:
1255
1357
                revno = 1
1256
1358
        destination.set_last_revision_info(revno, revision_id)
1257
1359
 
1258
 
    @needs_read_lock
1259
1360
    def copy_content_into(self, destination, revision_id=None):
1260
1361
        """Copy the content of self into destination.
1261
1362
 
1262
1363
        revision_id: if not None, the revision history in the new branch will
1263
1364
                     be truncated to end with revision_id.
1264
1365
        """
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)
 
1366
        return InterBranch.get(self, destination).copy_content_into(
 
1367
            revision_id=revision_id)
1276
1368
 
1277
1369
    def update_references(self, target):
1278
1370
        if not getattr(self._format, 'supports_reference_locations', False):
1323
1415
        """Return the most suitable metadir for a checkout of this branch.
1324
1416
        Weaves are used if this branch's repository uses weaves.
1325
1417
        """
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)
 
1418
        format = self.repository.bzrdir.checkout_metadir()
 
1419
        format.set_branch_format(self._format)
1333
1420
        return format
1334
1421
 
1335
1422
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1423
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1424
        no_tree=None):
1337
1425
        """Create a clone of this branch and its bzrdir.
1338
1426
 
1339
1427
        :param to_transport: The transport to clone onto.
1346
1434
        """
1347
1435
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1436
        # clone call. Or something. 20090224 RBC/spiv.
 
1437
        # XXX: Should this perhaps clone colocated branches as well, 
 
1438
        # rather than just the default branch? 20100319 JRV
1349
1439
        if revision_id is None:
1350
1440
            revision_id = self.last_revision()
1351
1441
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
1442
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1443
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1444
            no_tree=no_tree)
1354
1445
        return dir_to.open_branch()
1355
1446
 
1356
1447
    def create_checkout(self, to_location, revision_id=None,
1471
1562
        else:
1472
1563
            raise AssertionError("invalid heads: %r" % (heads,))
1473
1564
 
1474
 
 
1475
 
class BranchFormat(object):
 
1565
    def heads_to_fetch(self):
 
1566
        """Return the heads that must and that should be fetched to copy this
 
1567
        branch into another repo.
 
1568
 
 
1569
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1570
            set of heads that must be fetched.  if_present_fetch is a set of
 
1571
            heads that must be fetched if present, but no error is necessary if
 
1572
            they are not present.
 
1573
        """
 
1574
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
 
1575
        # are the tags.
 
1576
        must_fetch = set([self.last_revision()])
 
1577
        try:
 
1578
            if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1579
        except errors.TagsNotSupported:
 
1580
            if_present_fetch = set()
 
1581
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1582
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1583
        return must_fetch, if_present_fetch
 
1584
 
 
1585
 
 
1586
class BranchFormat(controldir.ControlComponentFormat):
1476
1587
    """An encapsulation of the initialization and open routines for a format.
1477
1588
 
1478
1589
    Formats provide three things:
1481
1592
     * an open routine.
1482
1593
 
1483
1594
    Formats are placed in an dict by their format string for reference
1484
 
    during branch opening. Its not required that these be instances, they
 
1595
    during branch opening. It's not required that these be instances, they
1485
1596
    can be classes themselves with class methods - it simply depends on
1486
1597
    whether state is needed for a given format or not.
1487
1598
 
1490
1601
    object will be created every time regardless.
1491
1602
    """
1492
1603
 
1493
 
    _default_format = None
1494
 
    """The default format used for new branches."""
1495
 
 
1496
 
    _formats = {}
1497
 
    """The known formats."""
1498
 
 
1499
1604
    can_set_append_revisions_only = True
1500
1605
 
1501
1606
    def __eq__(self, other):
1510
1615
        try:
1511
1616
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
1617
            format_string = transport.get_bytes("format")
1513
 
            return klass._formats[format_string]
 
1618
            return format_registry.get(format_string)
1514
1619
        except errors.NoSuchFile:
1515
1620
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1516
1621
        except KeyError:
1517
1622
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1623
 
1519
1624
    @classmethod
 
1625
    @deprecated_method(deprecated_in((2, 4, 0)))
1520
1626
    def get_default_format(klass):
1521
1627
        """Return the current default format."""
1522
 
        return klass._default_format
1523
 
 
1524
 
    def get_reference(self, a_bzrdir):
 
1628
        return format_registry.get_default()
 
1629
 
 
1630
    @classmethod
 
1631
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1632
    def get_formats(klass):
 
1633
        """Get all the known formats.
 
1634
 
 
1635
        Warning: This triggers a load of all lazy registered formats: do not
 
1636
        use except when that is desireed.
 
1637
        """
 
1638
        return format_registry._get_all()
 
1639
 
 
1640
    def get_reference(self, a_bzrdir, name=None):
1525
1641
        """Get the target reference of the branch in a_bzrdir.
1526
1642
 
1527
1643
        format probing must have been completed before calling
1529
1645
        in a_bzrdir is correct.
1530
1646
 
1531
1647
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1648
        :param name: Name of the colocated branch to fetch
1532
1649
        :return: None if the branch is not a reference branch.
1533
1650
        """
1534
1651
        return None
1535
1652
 
1536
1653
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
 
1654
    def set_reference(self, a_bzrdir, name, to_branch):
1538
1655
        """Set the target reference of the branch in a_bzrdir.
1539
1656
 
1540
1657
        format probing must have been completed before calling
1542
1659
        in a_bzrdir is correct.
1543
1660
 
1544
1661
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1662
        :param name: Name of colocated branch to set, None for default
1545
1663
        :param to_branch: branch that the checkout is to reference
1546
1664
        """
1547
1665
        raise NotImplementedError(self.set_reference)
1562
1680
        for hook in hooks:
1563
1681
            hook(params)
1564
1682
 
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):
 
1683
    def initialize(self, a_bzrdir, name=None, repository=None):
1611
1684
        """Create a branch of this format in a_bzrdir.
1612
1685
        
1613
1686
        :param name: Name of the colocated branch to create.
1647
1720
        """
1648
1721
        raise NotImplementedError(self.network_name)
1649
1722
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1723
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
1724
            found_repository=None):
1651
1725
        """Return the branch object for a_bzrdir
1652
1726
 
1653
1727
        :param a_bzrdir: A BzrDir that contains a branch.
1660
1734
        raise NotImplementedError(self.open)
1661
1735
 
1662
1736
    @classmethod
 
1737
    @deprecated_method(deprecated_in((2, 4, 0)))
1663
1738
    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__)
 
1739
        """Register a metadir format.
 
1740
 
 
1741
        See MetaDirBranchFormatFactory for the ability to register a format
 
1742
        without loading the code the format needs until it is actually used.
 
1743
        """
 
1744
        format_registry.register(format)
1669
1745
 
1670
1746
    @classmethod
 
1747
    @deprecated_method(deprecated_in((2, 4, 0)))
1671
1748
    def set_default_format(klass, format):
1672
 
        klass._default_format = format
 
1749
        format_registry.set_default(format)
1673
1750
 
1674
1751
    def supports_set_append_revisions_only(self):
1675
1752
        """True if this format supports set_append_revisions_only."""
1679
1756
        """True if this format records a stacked-on branch."""
1680
1757
        return False
1681
1758
 
 
1759
    def supports_leaving_lock(self):
 
1760
        """True if this format supports leaving locks in place."""
 
1761
        return False # by default
 
1762
 
1682
1763
    @classmethod
 
1764
    @deprecated_method(deprecated_in((2, 4, 0)))
1683
1765
    def unregister_format(klass, format):
1684
 
        del klass._formats[format.get_format_string()]
 
1766
        format_registry.remove(format)
1685
1767
 
1686
1768
    def __str__(self):
1687
1769
        return self.get_format_description().rstrip()
1691
1773
        return False  # by default
1692
1774
 
1693
1775
 
 
1776
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1777
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1778
    
 
1779
    While none of the built in BranchFormats are lazy registered yet,
 
1780
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1781
    use it, and the bzr-loom plugin uses it as well (see
 
1782
    bzrlib.plugins.loom.formats).
 
1783
    """
 
1784
 
 
1785
    def __init__(self, format_string, module_name, member_name):
 
1786
        """Create a MetaDirBranchFormatFactory.
 
1787
 
 
1788
        :param format_string: The format string the format has.
 
1789
        :param module_name: Module to load the format class from.
 
1790
        :param member_name: Attribute name within the module for the format class.
 
1791
        """
 
1792
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1793
        self._format_string = format_string
 
1794
        
 
1795
    def get_format_string(self):
 
1796
        """See BranchFormat.get_format_string."""
 
1797
        return self._format_string
 
1798
 
 
1799
    def __call__(self):
 
1800
        """Used for network_format_registry support."""
 
1801
        return self.get_obj()()
 
1802
 
 
1803
 
1694
1804
class BranchHooks(Hooks):
1695
1805
    """A dictionary mapping hook name to a list of callables for branch hooks.
1696
1806
 
1704
1814
        These are all empty initially, because by default nothing should get
1705
1815
        notified.
1706
1816
        """
1707
 
        Hooks.__init__(self)
1708
 
        self.create_hook(HookPoint('set_rh',
 
1817
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1818
        self.add_hook('set_rh',
1709
1819
            "Invoked whenever the revision history has been set via "
1710
1820
            "set_revision_history. The api signature is (branch, "
1711
1821
            "revision_history), and the branch will be write-locked. "
1712
1822
            "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',
 
1823
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
 
1824
        self.add_hook('open',
1715
1825
            "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',
 
1826
            "branch is opened.", (1, 8))
 
1827
        self.add_hook('post_push',
1718
1828
            "Called after a push operation completes. post_push is called "
1719
1829
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
 
            "bzr client.", (0, 15), None))
1721
 
        self.create_hook(HookPoint('post_pull',
 
1830
            "bzr client.", (0, 15))
 
1831
        self.add_hook('post_pull',
1722
1832
            "Called after a pull operation completes. post_pull is called "
1723
1833
            "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 "
 
1834
            "bzr client.", (0, 15))
 
1835
        self.add_hook('pre_commit',
 
1836
            "Called after a commit is calculated but before it is "
1727
1837
            "completed. pre_commit is called with (local, master, old_revno, "
1728
1838
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
1839
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1731
1841
            "basis revision. hooks MUST NOT modify this delta. "
1732
1842
            " future_tree is an in-memory tree obtained from "
1733
1843
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
 
            "tree.", (0,91), None))
1735
 
        self.create_hook(HookPoint('post_commit',
 
1844
            "tree.", (0,91))
 
1845
        self.add_hook('post_commit',
1736
1846
            "Called in the bzr client after a commit has completed. "
1737
1847
            "post_commit is called with (local, master, old_revno, old_revid, "
1738
1848
            "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',
 
1849
            "commit to a branch.", (0, 15))
 
1850
        self.add_hook('post_uncommit',
1741
1851
            "Called in the bzr client after an uncommit completes. "
1742
1852
            "post_uncommit is called with (local, master, old_revno, "
1743
1853
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
1854
            "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',
 
1855
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1856
        self.add_hook('pre_change_branch_tip',
1747
1857
            "Called in bzr client and server before a change to the tip of a "
1748
1858
            "branch is made. pre_change_branch_tip is called with a "
1749
1859
            "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',
 
1860
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1861
        self.add_hook('post_change_branch_tip',
1752
1862
            "Called in bzr client and server after a change to the tip of a "
1753
1863
            "branch is made. post_change_branch_tip is called with a "
1754
1864
            "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',
 
1865
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1866
        self.add_hook('transform_fallback_location',
1757
1867
            "Called when a stacked branch is activating its fallback "
1758
1868
            "locations. transform_fallback_location is called with (branch, "
1759
1869
            "url), and should return a new url. Returning the same url "
1764
1874
            "fallback locations have not been activated. When there are "
1765
1875
            "multiple hooks installed for transform_fallback_location, "
1766
1876
            "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."
 
1877
            "The order is however undefined.", (1, 9))
 
1878
        self.add_hook('automatic_tag_name',
 
1879
            "Called to determine an automatic tag name for a revision. "
1770
1880
            "automatic_tag_name is called with (branch, revision_id) and "
1771
1881
            "should return a tag name or None if no tag name could be "
1772
1882
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
 
1883
            (2, 2))
 
1884
        self.add_hook('post_branch_init',
1775
1885
            "Called after new branch initialization completes. "
1776
1886
            "post_branch_init is called with a "
1777
1887
            "bzrlib.branch.BranchInitHookParams. "
1778
1888
            "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',
 
1889
            "lightweight) will all trigger this hook.", (2, 2))
 
1890
        self.add_hook('post_switch',
1781
1891
            "Called after a checkout switches branch. "
1782
1892
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1893
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1784
1894
 
1785
1895
 
1786
1896
 
1863
1973
        return self.__dict__ == other.__dict__
1864
1974
 
1865
1975
    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)
 
1976
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1872
1977
 
1873
1978
 
1874
1979
class SwitchHookParams(object):
1904
2009
            self.revision_id)
1905
2010
 
1906
2011
 
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
2012
class BranchFormatMetadir(BranchFormat):
1951
2013
    """Common logic for meta-dir based branch formats."""
1952
2014
 
1954
2016
        """What class to instantiate on open calls."""
1955
2017
        raise NotImplementedError(self._branch_class)
1956
2018
 
 
2019
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
2020
                           repository=None):
 
2021
        """Initialize a branch in a bzrdir, with specified files
 
2022
 
 
2023
        :param a_bzrdir: The bzrdir to initialize the branch in
 
2024
        :param utf8_files: The files to create as a list of
 
2025
            (filename, content) tuples
 
2026
        :param name: Name of colocated branch to create, if any
 
2027
        :return: a branch in this format
 
2028
        """
 
2029
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
2030
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
2031
        control_files = lockable_files.LockableFiles(branch_transport,
 
2032
            'lock', lockdir.LockDir)
 
2033
        control_files.create_lock()
 
2034
        control_files.lock_write()
 
2035
        try:
 
2036
            utf8_files += [('format', self.get_format_string())]
 
2037
            for (filename, content) in utf8_files:
 
2038
                branch_transport.put_bytes(
 
2039
                    filename, content,
 
2040
                    mode=a_bzrdir._get_file_mode())
 
2041
        finally:
 
2042
            control_files.unlock()
 
2043
        branch = self.open(a_bzrdir, name, _found=True,
 
2044
                found_repository=repository)
 
2045
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2046
        return branch
 
2047
 
1957
2048
    def network_name(self):
1958
2049
        """A simple byte string uniquely identifying this format for RPC calls.
1959
2050
 
1961
2052
        """
1962
2053
        return self.get_format_string()
1963
2054
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2055
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2056
            found_repository=None):
1965
2057
        """See BranchFormat.open()."""
1966
2058
        if not _found:
1967
2059
            format = BranchFormat.find_format(a_bzrdir, name=name)
1972
2064
        try:
1973
2065
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
2066
                                                         lockdir.LockDir)
 
2067
            if found_repository is None:
 
2068
                found_repository = a_bzrdir.find_repository()
1975
2069
            return self._branch_class()(_format=self,
1976
2070
                              _control_files=control_files,
1977
2071
                              name=name,
1978
2072
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
 
2073
                              _repository=found_repository,
1980
2074
                              ignore_fallbacks=ignore_fallbacks)
1981
2075
        except errors.NoSuchFile:
1982
2076
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1989
2083
    def supports_tags(self):
1990
2084
        return True
1991
2085
 
 
2086
    def supports_leaving_lock(self):
 
2087
        return True
 
2088
 
1992
2089
 
1993
2090
class BzrBranchFormat5(BranchFormatMetadir):
1994
2091
    """Bzr branch format 5.
2014
2111
        """See BranchFormat.get_format_description()."""
2015
2112
        return "Branch format 5"
2016
2113
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
2114
    def initialize(self, a_bzrdir, name=None, repository=None):
2018
2115
        """Create a branch of this format in a_bzrdir."""
2019
2116
        utf8_files = [('revision-history', ''),
2020
2117
                      ('branch-name', ''),
2021
2118
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2119
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2023
2120
 
2024
2121
    def supports_tags(self):
2025
2122
        return False
2047
2144
        """See BranchFormat.get_format_description()."""
2048
2145
        return "Branch format 6"
2049
2146
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
2147
    def initialize(self, a_bzrdir, name=None, repository=None):
2051
2148
        """Create a branch of this format in a_bzrdir."""
2052
2149
        utf8_files = [('last-revision', '0 null:\n'),
2053
2150
                      ('branch.conf', ''),
2054
2151
                      ('tags', ''),
2055
2152
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2153
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2057
2154
 
2058
2155
    def make_tags(self, branch):
2059
2156
        """See bzrlib.branch.BranchFormat.make_tags()."""
2077
2174
        """See BranchFormat.get_format_description()."""
2078
2175
        return "Branch format 8"
2079
2176
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
2177
    def initialize(self, a_bzrdir, name=None, repository=None):
2081
2178
        """Create a branch of this format in a_bzrdir."""
2082
2179
        utf8_files = [('last-revision', '0 null:\n'),
2083
2180
                      ('branch.conf', ''),
2084
2181
                      ('tags', ''),
2085
2182
                      ('references', '')
2086
2183
                      ]
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()
 
2184
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2093
2185
 
2094
2186
    def make_tags(self, branch):
2095
2187
        """See bzrlib.branch.BranchFormat.make_tags()."""
2104
2196
    supports_reference_locations = True
2105
2197
 
2106
2198
 
2107
 
class BzrBranchFormat7(BzrBranchFormat8):
 
2199
class BzrBranchFormat7(BranchFormatMetadir):
2108
2200
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
2201
 
2110
2202
    The stacked location pointer is passed down to the repository and requires
2113
2205
    This format was introduced in bzr 1.6.
2114
2206
    """
2115
2207
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
2208
    def initialize(self, a_bzrdir, name=None, repository=None):
2117
2209
        """Create a branch of this format in a_bzrdir."""
2118
2210
        utf8_files = [('last-revision', '0 null:\n'),
2119
2211
                      ('branch.conf', ''),
2120
2212
                      ('tags', ''),
2121
2213
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2214
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2123
2215
 
2124
2216
    def _branch_class(self):
2125
2217
        return BzrBranch7
2135
2227
    def supports_set_append_revisions_only(self):
2136
2228
        return True
2137
2229
 
 
2230
    def supports_stacking(self):
 
2231
        return True
 
2232
 
 
2233
    def make_tags(self, branch):
 
2234
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2235
        return BasicTags(branch)
 
2236
 
2138
2237
    supports_reference_locations = False
2139
2238
 
2140
2239
 
2157
2256
        """See BranchFormat.get_format_description()."""
2158
2257
        return "Checkout reference format 1"
2159
2258
 
2160
 
    def get_reference(self, a_bzrdir):
 
2259
    def get_reference(self, a_bzrdir, name=None):
2161
2260
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2261
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2262
        return transport.get_bytes('location')
2164
2263
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2264
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2265
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2266
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2267
        location = transport.put_bytes('location', to_branch.base)
2169
2268
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2269
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2270
            repository=None):
2171
2271
        """Create a branch of this format in a_bzrdir."""
2172
2272
        if target_branch is None:
2173
2273
            # this format does not implement branch itself, thus the implicit
2201
2301
        return clone
2202
2302
 
2203
2303
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
2304
             possible_transports=None, ignore_fallbacks=False,
 
2305
             found_repository=None):
2205
2306
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2307
 
2207
2308
        :param a_bzrdir: A BzrDir that contains a branch.
2221
2322
                raise AssertionError("wrong format %r found for %r" %
2222
2323
                    (format, self))
2223
2324
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
 
2325
            location = self.get_reference(a_bzrdir, name)
2225
2326
        real_bzrdir = bzrdir.BzrDir.open(
2226
2327
            location, possible_transports=possible_transports)
2227
2328
        result = real_bzrdir.open_branch(name=name, 
2238
2339
        return result
2239
2340
 
2240
2341
 
 
2342
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2343
    """Branch format registry."""
 
2344
 
 
2345
    def __init__(self, other_registry=None):
 
2346
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2347
        self._default_format = None
 
2348
 
 
2349
    def set_default(self, format):
 
2350
        self._default_format = format
 
2351
 
 
2352
    def get_default(self):
 
2353
        return self._default_format
 
2354
 
 
2355
 
2241
2356
network_format_registry = registry.FormatRegistry()
2242
2357
"""Registry of formats indexed by their network name.
2243
2358
 
2246
2361
BranchFormat.network_name() for more detail.
2247
2362
"""
2248
2363
 
 
2364
format_registry = BranchFormatRegistry(network_format_registry)
 
2365
 
2249
2366
 
2250
2367
# formats which have no format string are not discoverable
2251
2368
# and not independently creatable, so are not registered.
2253
2370
__format6 = BzrBranchFormat6()
2254
2371
__format7 = BzrBranchFormat7()
2255
2372
__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__)
 
2373
format_registry.register(__format5)
 
2374
format_registry.register(BranchReferenceFormat())
 
2375
format_registry.register(__format6)
 
2376
format_registry.register(__format7)
 
2377
format_registry.register(__format8)
 
2378
format_registry.set_default(__format7)
 
2379
 
 
2380
 
 
2381
class BranchWriteLockResult(LogicalLockResult):
 
2382
    """The result of write locking a branch.
 
2383
 
 
2384
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2385
        None.
 
2386
    :ivar unlock: A callable which will unlock the lock.
 
2387
    """
 
2388
 
 
2389
    def __init__(self, unlock, branch_token):
 
2390
        LogicalLockResult.__init__(self, unlock)
 
2391
        self.branch_token = branch_token
 
2392
 
 
2393
    def __repr__(self):
 
2394
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2395
            self.unlock)
2266
2396
 
2267
2397
 
2268
2398
class BzrBranch(Branch, _RelockDebugMixin):
2324
2454
        return self.control_files.is_locked()
2325
2455
 
2326
2456
    def lock_write(self, token=None):
 
2457
        """Lock the branch for write operations.
 
2458
 
 
2459
        :param token: A token to permit reacquiring a previously held and
 
2460
            preserved lock.
 
2461
        :return: A BranchWriteLockResult.
 
2462
        """
2327
2463
        if not self.is_locked():
2328
2464
            self._note_lock('w')
2329
2465
        # All-in-one needs to always unlock/lock.
2335
2471
        else:
2336
2472
            took_lock = False
2337
2473
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2474
            return BranchWriteLockResult(self.unlock,
 
2475
                self.control_files.lock_write(token=token))
2339
2476
        except:
2340
2477
            if took_lock:
2341
2478
                self.repository.unlock()
2342
2479
            raise
2343
2480
 
2344
2481
    def lock_read(self):
 
2482
        """Lock the branch for read operations.
 
2483
 
 
2484
        :return: A bzrlib.lock.LogicalLockResult.
 
2485
        """
2345
2486
        if not self.is_locked():
2346
2487
            self._note_lock('r')
2347
2488
        # All-in-one needs to always unlock/lock.
2354
2495
            took_lock = False
2355
2496
        try:
2356
2497
            self.control_files.lock_read()
 
2498
            return LogicalLockResult(self.unlock)
2357
2499
        except:
2358
2500
            if took_lock:
2359
2501
                self.repository.unlock()
2387
2529
        """See Branch.print_file."""
2388
2530
        return self.repository.print_file(file, revision_id)
2389
2531
 
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
2532
    @needs_write_lock
2454
2533
    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
 
        """
2465
2534
        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))
 
2535
        old_revno, old_revid = self.last_revision_info()
 
2536
        if self._get_append_revisions_only():
 
2537
            self._check_history_violation(revision_id)
 
2538
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2539
        self._write_last_revision_info(revno, revision_id)
 
2540
        self._clear_cached_state()
 
2541
        self._last_revision_info_cache = revno, revision_id
 
2542
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2494
2543
 
2495
2544
    def basis_tree(self):
2496
2545
        """See Branch.basis_tree."""
2515
2564
        result.target_branch = target
2516
2565
        result.old_revno, result.old_revid = target.last_revision_info()
2517
2566
        self.update_references(target)
2518
 
        if result.old_revid != self.last_revision():
 
2567
        if result.old_revid != stop_revision:
2519
2568
            # We assume that during 'push' this repository is closer than
2520
2569
            # the target.
2521
2570
            graph = self.repository.get_graph(target.repository)
2522
2571
            target.update_revisions(self, stop_revision,
2523
2572
                overwrite=overwrite, graph=graph)
2524
2573
        if self._push_should_merge_tags():
2525
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2526
 
                overwrite)
 
2574
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2527
2575
        result.new_revno, result.new_revid = target.last_revision_info()
2528
2576
        return result
2529
2577
 
2543
2591
            self._transport.put_bytes('parent', url + '\n',
2544
2592
                mode=self.bzrdir._get_file_mode())
2545
2593
 
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
2594
    @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
 
2595
    def unbind(self):
 
2596
        """If bound, unbind"""
 
2597
        return self.set_bound_location(None)
2595
2598
 
2596
2599
    @needs_write_lock
2597
2600
    def bind(self, other):
2619
2622
        # history around
2620
2623
        self.set_bound_location(other.base)
2621
2624
 
 
2625
    def get_bound_location(self):
 
2626
        try:
 
2627
            return self._transport.get_bytes('bound')[:-1]
 
2628
        except errors.NoSuchFile:
 
2629
            return None
 
2630
 
 
2631
    @needs_read_lock
 
2632
    def get_master_branch(self, possible_transports=None):
 
2633
        """Return the branch we are bound to.
 
2634
 
 
2635
        :return: Either a Branch, or None
 
2636
        """
 
2637
        if self._master_branch_cache is None:
 
2638
            self._master_branch_cache = self._get_master_branch(
 
2639
                possible_transports)
 
2640
        return self._master_branch_cache
 
2641
 
 
2642
    def _get_master_branch(self, possible_transports):
 
2643
        bound_loc = self.get_bound_location()
 
2644
        if not bound_loc:
 
2645
            return None
 
2646
        try:
 
2647
            return Branch.open(bound_loc,
 
2648
                               possible_transports=possible_transports)
 
2649
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2650
            raise errors.BoundBranchConnectionFailure(
 
2651
                    self, bound_loc, e)
 
2652
 
2622
2653
    @needs_write_lock
2623
 
    def unbind(self):
2624
 
        """If bound, unbind"""
2625
 
        return self.set_bound_location(None)
 
2654
    def set_bound_location(self, location):
 
2655
        """Set the target where this branch is bound to.
 
2656
 
 
2657
        :param location: URL to the target branch
 
2658
        """
 
2659
        self._master_branch_cache = None
 
2660
        if location:
 
2661
            self._transport.put_bytes('bound', location+'\n',
 
2662
                mode=self.bzrdir._get_file_mode())
 
2663
        else:
 
2664
            try:
 
2665
                self._transport.delete('bound')
 
2666
            except errors.NoSuchFile:
 
2667
                return False
 
2668
            return True
2626
2669
 
2627
2670
    @needs_write_lock
2628
2671
    def update(self, possible_transports=None):
2641
2684
            return old_tip
2642
2685
        return None
2643
2686
 
2644
 
 
2645
 
class BzrBranch8(BzrBranch5):
 
2687
    def _read_last_revision_info(self):
 
2688
        revision_string = self._transport.get_bytes('last-revision')
 
2689
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2690
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2691
        revno = int(revno)
 
2692
        return revno, revision_id
 
2693
 
 
2694
    def _write_last_revision_info(self, revno, revision_id):
 
2695
        """Simply write out the revision id, with no checks.
 
2696
 
 
2697
        Use set_last_revision_info to perform this safely.
 
2698
 
 
2699
        Does not update the revision_history cache.
 
2700
        """
 
2701
        revision_id = _mod_revision.ensure_null(revision_id)
 
2702
        out_string = '%d %s\n' % (revno, revision_id)
 
2703
        self._transport.put_bytes('last-revision', out_string,
 
2704
            mode=self.bzrdir._get_file_mode())
 
2705
 
 
2706
 
 
2707
class FullHistoryBzrBranch(BzrBranch):
 
2708
    """Bzr branch which contains the full revision history."""
 
2709
 
 
2710
    @needs_write_lock
 
2711
    def set_last_revision_info(self, revno, revision_id):
 
2712
        revision_id = _mod_revision.ensure_null(revision_id)
 
2713
        # this old format stores the full history, but this api doesn't
 
2714
        # provide it, so we must generate, and might as well check it's
 
2715
        # correct
 
2716
        history = self._lefthand_history(revision_id)
 
2717
        if len(history) != revno:
 
2718
            raise AssertionError('%d != %d' % (len(history), revno))
 
2719
        self._set_revision_history(history)
 
2720
 
 
2721
    def _read_last_revision_info(self):
 
2722
        rh = self.revision_history()
 
2723
        revno = len(rh)
 
2724
        if revno:
 
2725
            return (revno, rh[-1])
 
2726
        else:
 
2727
            return (0, _mod_revision.NULL_REVISION)
 
2728
 
 
2729
    @deprecated_method(deprecated_in((2, 4, 0)))
 
2730
    @needs_write_lock
 
2731
    def set_revision_history(self, rev_history):
 
2732
        """See Branch.set_revision_history."""
 
2733
        self._set_revision_history(rev_history)
 
2734
        for hook in Branch.hooks['set_rh']:
 
2735
            hook(self, rev_history)
 
2736
 
 
2737
    def _set_revision_history(self, rev_history):
 
2738
        if 'evil' in debug.debug_flags:
 
2739
            mutter_callsite(3, "set_revision_history scales with history.")
 
2740
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2741
        for rev_id in rev_history:
 
2742
            check_not_reserved_id(rev_id)
 
2743
        if Branch.hooks['post_change_branch_tip']:
 
2744
            # Don't calculate the last_revision_info() if there are no hooks
 
2745
            # that will use it.
 
2746
            old_revno, old_revid = self.last_revision_info()
 
2747
        if len(rev_history) == 0:
 
2748
            revid = _mod_revision.NULL_REVISION
 
2749
        else:
 
2750
            revid = rev_history[-1]
 
2751
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2752
        self._write_revision_history(rev_history)
 
2753
        self._clear_cached_state()
 
2754
        self._cache_revision_history(rev_history)
 
2755
        for hook in Branch.hooks['set_rh']:
 
2756
            hook(self, rev_history)
 
2757
        if Branch.hooks['post_change_branch_tip']:
 
2758
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2759
 
 
2760
    def _write_revision_history(self, history):
 
2761
        """Factored out of set_revision_history.
 
2762
 
 
2763
        This performs the actual writing to disk.
 
2764
        It is intended to be called by set_revision_history."""
 
2765
        self._transport.put_bytes(
 
2766
            'revision-history', '\n'.join(history),
 
2767
            mode=self.bzrdir._get_file_mode())
 
2768
 
 
2769
    def _gen_revision_history(self):
 
2770
        history = self._transport.get_bytes('revision-history').split('\n')
 
2771
        if history[-1:] == ['']:
 
2772
            # There shouldn't be a trailing newline, but just in case.
 
2773
            history.pop()
 
2774
        return history
 
2775
 
 
2776
    def _synchronize_history(self, destination, revision_id):
 
2777
        if not isinstance(destination._format, FullHistoryBzrBranch):
 
2778
            super(BzrBranch, self)._synchronize_history(
 
2779
                destination, revision_id)
 
2780
            return
 
2781
        if revision_id == _mod_revision.NULL_REVISION:
 
2782
            new_history = []
 
2783
        else:
 
2784
            new_history = self.revision_history()
 
2785
        if revision_id is not None and new_history != []:
 
2786
            try:
 
2787
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2788
            except ValueError:
 
2789
                rev = self.repository.get_revision(revision_id)
 
2790
                new_history = rev.get_history(self.repository)[1:]
 
2791
        destination._set_revision_history(new_history)
 
2792
 
 
2793
    @needs_write_lock
 
2794
    def generate_revision_history(self, revision_id, last_rev=None,
 
2795
        other_branch=None):
 
2796
        """Create a new revision history that will finish with revision_id.
 
2797
 
 
2798
        :param revision_id: the new tip to use.
 
2799
        :param last_rev: The previous last_revision. If not None, then this
 
2800
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2801
        :param other_branch: The other branch that DivergedBranches should
 
2802
            raise with respect to.
 
2803
        """
 
2804
        self._set_revision_history(self._lefthand_history(revision_id,
 
2805
            last_rev, other_branch))
 
2806
 
 
2807
 
 
2808
class BzrBranch5(FullHistoryBzrBranch):
 
2809
    """A format 5 branch. This supports new features over plain branches.
 
2810
 
 
2811
    It has support for a master_branch which is the data for bound branches.
 
2812
    """
 
2813
 
 
2814
 
 
2815
class BzrBranch8(BzrBranch):
2646
2816
    """A branch that stores tree-reference locations."""
2647
2817
 
2648
2818
    def _open_hook(self):
2674
2844
        self._last_revision_info_cache = None
2675
2845
        self._reference_info = None
2676
2846
 
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
2847
    def _check_history_violation(self, revision_id):
2723
2848
        last_revision = _mod_revision.ensure_null(self.last_revision())
2724
2849
        if _mod_revision.is_null(last_revision):
2840
2965
 
2841
2966
    def set_bound_location(self, location):
2842
2967
        """See Branch.set_push_location."""
 
2968
        self._master_branch_cache = None
2843
2969
        result = None
2844
2970
        config = self.get_config()
2845
2971
        if location is None:
2885
3011
        return self.get_config(
2886
3012
            ).get_user_option_as_bool('append_revisions_only')
2887
3013
 
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
3014
    @needs_read_lock
2897
3015
    def get_rev_id(self, revno, history=None):
2898
3016
        """Find the revision id of the specified revno."""
2922
3040
        try:
2923
3041
            index = self._partial_revision_history_cache.index(revision_id)
2924
3042
        except ValueError:
2925
 
            self._extend_partial_history(stop_revision=revision_id)
 
3043
            try:
 
3044
                self._extend_partial_history(stop_revision=revision_id)
 
3045
            except errors.RevisionNotPresent, e:
 
3046
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2926
3047
            index = len(self._partial_revision_history_cache) - 1
2927
3048
            if self._partial_revision_history_cache[index] != revision_id:
2928
3049
                raise errors.NoSuchRevision(self, revision_id)
2983
3104
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2984
3105
    """
2985
3106
 
 
3107
    @deprecated_method(deprecated_in((2, 3, 0)))
2986
3108
    def __int__(self):
2987
 
        # DEPRECATED: pull used to return the change in revno
 
3109
        """Return the relative change in revno.
 
3110
 
 
3111
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3112
        """
2988
3113
        return self.new_revno - self.old_revno
2989
3114
 
2990
3115
    def report(self, to_file):
3015
3140
        target, otherwise it will be None.
3016
3141
    """
3017
3142
 
 
3143
    @deprecated_method(deprecated_in((2, 3, 0)))
3018
3144
    def __int__(self):
3019
 
        # DEPRECATED: push used to return the change in revno
 
3145
        """Return the relative change in revno.
 
3146
 
 
3147
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3148
        """
3020
3149
        return self.new_revno - self.old_revno
3021
3150
 
3022
3151
    def report(self, to_file):
3145
3274
    _optimisers = []
3146
3275
    """The available optimised InterBranch types."""
3147
3276
 
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)
 
3277
    @classmethod
 
3278
    def _get_branch_formats_to_test(klass):
 
3279
        """Return an iterable of format tuples for testing.
 
3280
        
 
3281
        :return: An iterable of (from_format, to_format) to use when testing
 
3282
            this InterBranch class. Each InterBranch class should define this
 
3283
            method itself.
 
3284
        """
 
3285
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3286
 
 
3287
    @needs_write_lock
3153
3288
    def pull(self, overwrite=False, stop_revision=None,
3154
3289
             possible_transports=None, local=False):
3155
3290
        """Mirror source into target branch.
3160
3295
        """
3161
3296
        raise NotImplementedError(self.pull)
3162
3297
 
 
3298
    @needs_write_lock
3163
3299
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
 
                         graph=None):
 
3300
                         graph=None, fetch_tags=True):
3165
3301
        """Pull in new perfect-fit revisions.
3166
3302
 
3167
3303
        :param stop_revision: Updated until the given revision
3169
3305
            to see if it is a proper descendant.
3170
3306
        :param graph: A Graph object that can be used to query history
3171
3307
            information. This can be None.
 
3308
        :param fetch_tags: Flag that specifies if tags from source should be
 
3309
            fetched too.
3172
3310
        :return: None
3173
3311
        """
3174
3312
        raise NotImplementedError(self.update_revisions)
3175
3313
 
 
3314
    @needs_write_lock
3176
3315
    def push(self, overwrite=False, stop_revision=None,
3177
3316
             _override_hook_source_branch=None):
3178
3317
        """Mirror the source branch into the target branch.
3181
3320
        """
3182
3321
        raise NotImplementedError(self.push)
3183
3322
 
 
3323
    @needs_write_lock
 
3324
    def copy_content_into(self, revision_id=None):
 
3325
        """Copy the content of source into target
 
3326
 
 
3327
        revision_id: if not None, the revision history in the new branch will
 
3328
                     be truncated to end with revision_id.
 
3329
        """
 
3330
        raise NotImplementedError(self.copy_content_into)
 
3331
 
 
3332
    @needs_write_lock
 
3333
    def fetch(self, stop_revision=None, fetch_spec=None):
 
3334
        """Fetch revisions.
 
3335
 
 
3336
        :param stop_revision: Last revision to fetch
 
3337
        :param fetch_spec: Fetch spec.
 
3338
        """
 
3339
        raise NotImplementedError(self.fetch)
 
3340
 
3184
3341
 
3185
3342
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
 
 
 
3343
    """InterBranch implementation that uses public Branch functions."""
 
3344
 
 
3345
    @classmethod
 
3346
    def is_compatible(klass, source, target):
 
3347
        # GenericBranch uses the public API, so always compatible
 
3348
        return True
 
3349
 
 
3350
    @classmethod
 
3351
    def _get_branch_formats_to_test(klass):
 
3352
        return [(format_registry.get_default(), format_registry.get_default())]
 
3353
 
 
3354
    @classmethod
 
3355
    def unwrap_format(klass, format):
 
3356
        if isinstance(format, remote.RemoteBranchFormat):
 
3357
            format._ensure_real()
 
3358
            return format._custom_format
 
3359
        return format
 
3360
 
 
3361
    @needs_write_lock
 
3362
    def copy_content_into(self, revision_id=None):
 
3363
        """Copy the content of source into target
 
3364
 
 
3365
        revision_id: if not None, the revision history in the new branch will
 
3366
                     be truncated to end with revision_id.
 
3367
        """
 
3368
        self.source.update_references(self.target)
 
3369
        self.source._synchronize_history(self.target, revision_id)
 
3370
        try:
 
3371
            parent = self.source.get_parent()
 
3372
        except errors.InaccessibleParent, e:
 
3373
            mutter('parent was not accessible to copy: %s', e)
 
3374
        else:
 
3375
            if parent:
 
3376
                self.target.set_parent(parent)
 
3377
        if self.source._push_should_merge_tags():
 
3378
            self.source.tags.merge_to(self.target.tags)
 
3379
 
 
3380
    @needs_write_lock
 
3381
    def fetch(self, stop_revision=None, fetch_spec=None):
 
3382
        if fetch_spec is not None and stop_revision is not None:
 
3383
            raise AssertionError(
 
3384
                "fetch_spec and last_revision are mutually exclusive.")
 
3385
        if self.target.base == self.source.base:
 
3386
            return (0, [])
 
3387
        self.source.lock_read()
 
3388
        try:
 
3389
            if stop_revision is None and fetch_spec is None:
 
3390
                stop_revision = self.source.last_revision()
 
3391
                stop_revision = _mod_revision.ensure_null(stop_revision)
 
3392
            return self.target.repository.fetch(self.source.repository,
 
3393
                revision_id=stop_revision, fetch_spec=fetch_spec)
 
3394
        finally:
 
3395
            self.source.unlock()
 
3396
 
 
3397
    @needs_write_lock
3193
3398
    def update_revisions(self, stop_revision=None, overwrite=False,
3194
 
        graph=None):
 
3399
        graph=None, fetch_tags=True):
3195
3400
        """See InterBranch.update_revisions()."""
3196
 
        self.source.lock_read()
3197
 
        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)
3233
 
        finally:
3234
 
            self.source.unlock()
3235
 
 
 
3401
        other_revno, other_last_revision = self.source.last_revision_info()
 
3402
        stop_revno = None # unknown
 
3403
        if stop_revision is None:
 
3404
            stop_revision = other_last_revision
 
3405
            if _mod_revision.is_null(stop_revision):
 
3406
                # if there are no commits, we're done.
 
3407
                return
 
3408
            stop_revno = other_revno
 
3409
 
 
3410
        # what's the current last revision, before we fetch [and change it
 
3411
        # possibly]
 
3412
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3413
        # we fetch here so that we don't process data twice in the common
 
3414
        # case of having something to pull, and so that the check for
 
3415
        # already merged can operate on the just fetched graph, which will
 
3416
        # be cached in memory.
 
3417
        if fetch_tags:
 
3418
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3419
            fetch_spec_factory.source_branch = self.source
 
3420
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3421
            fetch_spec_factory.source_repo = self.source.repository
 
3422
            fetch_spec_factory.target_repo = self.target.repository
 
3423
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3424
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3425
        else:
 
3426
            fetch_spec = _mod_graph.NotInOtherForRevs(self.target.repository,
 
3427
                self.source.repository, revision_ids=[stop_revision]).execute()
 
3428
        self.target.fetch(self.source, fetch_spec=fetch_spec)
 
3429
        # Check to see if one is an ancestor of the other
 
3430
        if not overwrite:
 
3431
            if graph is None:
 
3432
                graph = self.target.repository.get_graph()
 
3433
            if self.target._check_if_descendant_or_diverged(
 
3434
                    stop_revision, last_rev, graph, self.source):
 
3435
                # stop_revision is a descendant of last_rev, but we aren't
 
3436
                # overwriting, so we're done.
 
3437
                return
 
3438
        if stop_revno is None:
 
3439
            if graph is None:
 
3440
                graph = self.target.repository.get_graph()
 
3441
            this_revno, this_last_revision = \
 
3442
                    self.target.last_revision_info()
 
3443
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3444
                            [(other_last_revision, other_revno),
 
3445
                             (this_last_revision, this_revno)])
 
3446
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3447
 
 
3448
    @needs_write_lock
3236
3449
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3450
             possible_transports=None, run_hooks=True,
3238
3451
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
 
3452
        """Pull from source into self, updating my master if any.
3240
3453
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
3454
        :param run_hooks: Private parameter - if false, this branch
3244
3455
            is being called because it's the master of the primary branch,
3245
3456
            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
3457
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
 
3458
        bound_location = self.target.get_bound_location()
 
3459
        if local and not bound_location:
3252
3460
            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()
 
3461
        master_branch = None
 
3462
        source_is_master = (self.source.user_url == bound_location)
 
3463
        if not local and bound_location and not source_is_master:
 
3464
            # not pulling from master, so we need to update master.
 
3465
            master_branch = self.target.get_master_branch(possible_transports)
 
3466
            master_branch.lock_write()
3260
3467
        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)
 
3468
            if master_branch:
 
3469
                # pull from source into master.
 
3470
                master_branch.pull(self.source, overwrite, stop_revision,
 
3471
                    run_hooks=False)
 
3472
            return self._pull(overwrite,
 
3473
                stop_revision, _hook_master=master_branch,
 
3474
                run_hooks=run_hooks,
 
3475
                _override_hook_target=_override_hook_target,
 
3476
                merge_tags_to_master=not source_is_master)
3287
3477
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
 
3478
            if master_branch:
 
3479
                master_branch.unlock()
3290
3480
 
3291
3481
    def push(self, overwrite=False, stop_revision=None,
3292
3482
             _override_hook_source_branch=None):
3332
3522
                # push into the master from the source branch.
3333
3523
                self.source._basic_push(master_branch, overwrite, stop_revision)
3334
3524
                # and push into the target branch from the source. Note that we
3335
 
                # push from the source branch again, because its considered the
 
3525
                # push from the source branch again, because it's considered the
3336
3526
                # highest bandwidth repository.
3337
3527
                result = self.source._basic_push(self.target, overwrite,
3338
3528
                    stop_revision)
3354
3544
            _run_hooks()
3355
3545
            return result
3356
3546
 
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
 
 
 
3547
    def _pull(self, overwrite=False, stop_revision=None,
 
3548
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3549
             _override_hook_target=None, local=False,
 
3550
             merge_tags_to_master=True):
 
3551
        """See Branch.pull.
 
3552
 
 
3553
        This function is the core worker, used by GenericInterBranch.pull to
 
3554
        avoid duplication when pulling source->master and source->local.
 
3555
 
 
3556
        :param _hook_master: Private parameter - set the branch to
 
3557
            be supplied as the master to pull hooks.
3374
3558
        :param run_hooks: Private parameter - if false, this branch
3375
3559
            is being called because it's the master of the primary branch,
3376
3560
            so it should not run its hooks.
 
3561
            is being called because it's the master of the primary branch,
 
3562
            so it should not run its hooks.
 
3563
        :param _override_hook_target: Private parameter - set the branch to be
 
3564
            supplied as the target_branch to pull hooks.
 
3565
        :param local: Only update the local branch, and not the bound branch.
3377
3566
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
 
3567
        # This type of branch can't be bound.
 
3568
        if local:
3380
3569
            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()
 
3570
        result = PullResult()
 
3571
        result.source_branch = self.source
 
3572
        if _override_hook_target is None:
 
3573
            result.target_branch = self.target
 
3574
        else:
 
3575
            result.target_branch = _override_hook_target
 
3576
        self.source.lock_read()
3386
3577
        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)
 
3578
            # We assume that during 'pull' the target repository is closer than
 
3579
            # the source one.
 
3580
            self.source.update_references(self.target)
 
3581
            graph = self.target.repository.get_graph(self.source.repository)
 
3582
            # TODO: Branch formats should have a flag that indicates 
 
3583
            # that revno's are expensive, and pull() should honor that flag.
 
3584
            # -- JRV20090506
 
3585
            result.old_revno, result.old_revid = \
 
3586
                self.target.last_revision_info()
 
3587
            self.target.update_revisions(self.source, stop_revision,
 
3588
                overwrite=overwrite, graph=graph)
 
3589
            # TODO: The old revid should be specified when merging tags, 
 
3590
            # so a tags implementation that versions tags can only 
 
3591
            # pull in the most recent changes. -- JRV20090506
 
3592
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3593
                overwrite, ignore_master=not merge_tags_to_master)
 
3594
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3595
            if _hook_master:
 
3596
                result.master_branch = _hook_master
 
3597
                result.local_branch = result.target_branch
 
3598
            else:
 
3599
                result.master_branch = result.target_branch
 
3600
                result.local_branch = None
 
3601
            if run_hooks:
 
3602
                for hook in Branch.hooks['post_pull']:
 
3603
                    hook(result)
3395
3604
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
 
3605
            self.source.unlock()
 
3606
        return result
3398
3607
 
3399
3608
 
3400
3609
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)