/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: Martin
  • Date: 2011-05-21 16:43:19 UTC
  • mto: This revision was merged to the branch mainline in revision 5907.
  • Revision ID: gzlist@googlemail.com-20110521164319-5ua6aoazejsvef0w
Avoid implicit str casting in trace methods by calling unicode() on conflict objects first

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
27
27
        config as _mod_config,
28
28
        debug,
29
29
        errors,
 
30
        fetch,
 
31
        graph as _mod_graph,
30
32
        lockdir,
31
33
        lockable_files,
 
34
        remote,
32
35
        repository,
33
36
        revision as _mod_revision,
34
37
        rio,
35
 
        symbol_versioning,
36
38
        transport,
37
 
        tsort,
38
39
        ui,
39
40
        urlutils,
40
41
        )
41
42
from bzrlib.config import BranchConfig, TransportConfig
42
 
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
43
from bzrlib.tag import (
44
44
    BasicTags,
45
45
    DisabledTags,
46
46
    )
47
47
""")
48
48
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
 
from bzrlib.hooks import HookPoint, Hooks
 
49
from bzrlib import (
 
50
    controldir,
 
51
    )
 
52
from bzrlib.decorators import (
 
53
    needs_read_lock,
 
54
    needs_write_lock,
 
55
    only_raises,
 
56
    )
 
57
from bzrlib.hooks import Hooks
51
58
from bzrlib.inter import InterObject
52
59
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
60
from bzrlib import registry
63
70
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
71
 
65
72
 
66
 
class Branch(bzrdir.ControlComponent):
 
73
class Branch(controldir.ControlComponent):
67
74
    """Branch holding a history of revisions.
68
75
 
69
76
    :ivar base:
70
77
        Base directory/url of the branch; using control_url and
71
78
        control_transport is more standardized.
72
 
 
73
 
    hooks: An instance of BranchHooks.
 
79
    :ivar hooks: An instance of BranchHooks.
 
80
    :ivar _master_branch_cache: cached result of get_master_branch, see
 
81
        _clear_cached_state.
74
82
    """
75
83
    # this is really an instance variable - FIXME move it there
76
84
    # - RBC 20060112
90
98
        self._revision_id_to_revno_cache = None
91
99
        self._partial_revision_id_to_revno_cache = {}
92
100
        self._partial_revision_history_cache = []
 
101
        self._tags_bytes = None
93
102
        self._last_revision_info_cache = None
 
103
        self._master_branch_cache = None
94
104
        self._merge_sorted_revisions_cache = None
95
105
        self._open_hook()
96
106
        hooks = Branch.hooks['open']
102
112
 
103
113
    def _activate_fallback_location(self, url):
104
114
        """Activate the branch/repository from url as a fallback repository."""
 
115
        for existing_fallback_repo in self.repository._fallback_repositories:
 
116
            if existing_fallback_repo.user_url == url:
 
117
                # This fallback is already configured.  This probably only
 
118
                # happens because BzrDir.sprout is a horrible mess.  To avoid
 
119
                # confusing _unstack we don't add this a second time.
 
120
                mutter('duplicate activation of fallback %r on %r', url, self)
 
121
                return
105
122
        repo = self._get_fallback_repository(url)
106
123
        if repo.has_same_location(self.repository):
107
124
            raise errors.UnstackableLocationError(self.user_url, url)
197
214
        return self.supports_tags() and self.tags.get_tag_dict()
198
215
 
199
216
    def get_config(self):
 
217
        """Get a bzrlib.config.BranchConfig for this Branch.
 
218
 
 
219
        This can then be used to get and set configuration options for the
 
220
        branch.
 
221
 
 
222
        :return: A bzrlib.config.BranchConfig.
 
223
        """
200
224
        return BranchConfig(self)
201
225
 
202
226
    def _get_config(self):
218
242
            possible_transports=[self.bzrdir.root_transport])
219
243
        return a_branch.repository
220
244
 
 
245
    @needs_read_lock
221
246
    def _get_tags_bytes(self):
222
247
        """Get the bytes of a serialised tags dict.
223
248
 
230
255
        :return: The bytes of the tags file.
231
256
        :seealso: Branch._set_tags_bytes.
232
257
        """
233
 
        return self._transport.get_bytes('tags')
 
258
        if self._tags_bytes is None:
 
259
            self._tags_bytes = self._transport.get_bytes('tags')
 
260
        return self._tags_bytes
234
261
 
235
262
    def _get_nick(self, local=False, possible_transports=None):
236
263
        config = self.get_config()
238
265
        if not local and not config.has_explicit_nickname():
239
266
            try:
240
267
                master = self.get_master_branch(possible_transports)
 
268
                if master and self.user_url == master.user_url:
 
269
                    raise errors.RecursiveBind(self.user_url)
241
270
                if master is not None:
242
271
                    # return the master branch value
243
272
                    return master.nick
 
273
            except errors.RecursiveBind, e:
 
274
                raise e
244
275
            except errors.BzrError, e:
245
276
                # Silently fall back to local implicit nick if the master is
246
277
                # unavailable
423
454
            after. If None, the rest of history is included.
424
455
        :param stop_rule: if stop_revision_id is not None, the precise rule
425
456
            to use for termination:
 
457
 
426
458
            * 'exclude' - leave the stop revision out of the result (default)
427
459
            * 'include' - the stop revision is the last item in the result
428
460
            * 'with-merges' - include the stop revision and all of its
430
462
            * 'with-merges-without-common-ancestry' - filter out revisions 
431
463
              that are in both ancestries
432
464
        :param direction: either 'reverse' or 'forward':
 
465
 
433
466
            * reverse means return the start_revision_id first, i.e.
434
467
              start at the most recent revision and go backwards in history
435
468
            * forward returns tuples in the opposite order to reverse.
636
669
        raise errors.UnsupportedOperation(self.get_reference_info, self)
637
670
 
638
671
    @needs_write_lock
639
 
    def fetch(self, from_branch, last_revision=None, pb=None):
 
672
    def fetch(self, from_branch, last_revision=None):
640
673
        """Copy revisions from from_branch into this branch.
641
674
 
642
675
        :param from_branch: Where to copy from.
643
676
        :param last_revision: What revision to stop at (None for at the end
644
677
                              of the branch.
645
 
        :param pb: An optional progress bar to use.
646
678
        :return: None
647
679
        """
648
 
        if self.base == from_branch.base:
649
 
            return (0, [])
650
 
        if pb is not None:
651
 
            symbol_versioning.warn(
652
 
                symbol_versioning.deprecated_in((1, 14, 0))
653
 
                % "pb parameter to fetch()")
654
 
        from_branch.lock_read()
655
 
        try:
656
 
            if last_revision is None:
657
 
                last_revision = from_branch.last_revision()
658
 
                last_revision = _mod_revision.ensure_null(last_revision)
659
 
            return self.repository.fetch(from_branch.repository,
660
 
                                         revision_id=last_revision,
661
 
                                         pb=pb)
662
 
        finally:
663
 
            from_branch.unlock()
 
680
        return InterBranch.get(from_branch, self).fetch(last_revision)
664
681
 
665
682
    def get_bound_location(self):
666
683
        """Return the URL of the branch we are bound to.
677
694
 
678
695
    def get_commit_builder(self, parents, config=None, timestamp=None,
679
696
                           timezone=None, committer=None, revprops=None,
680
 
                           revision_id=None):
 
697
                           revision_id=None, lossy=False):
681
698
        """Obtain a CommitBuilder for this branch.
682
699
 
683
700
        :param parents: Revision ids of the parents of the new revision.
687
704
        :param committer: Optional committer to set for commit.
688
705
        :param revprops: Optional dictionary of revision properties.
689
706
        :param revision_id: Optional revision id.
 
707
        :param lossy: Whether to discard data that can not be natively
 
708
            represented, when pushing to a foreign VCS 
690
709
        """
691
710
 
692
711
        if config is None:
693
712
            config = self.get_config()
694
713
 
695
714
        return self.repository.get_commit_builder(self, parents, config,
696
 
            timestamp, timezone, committer, revprops, revision_id)
 
715
            timestamp, timezone, committer, revprops, revision_id,
 
716
            lossy)
697
717
 
698
718
    def get_master_branch(self, possible_transports=None):
699
719
        """Return the branch we are bound to.
726
746
        """Print `file` to stdout."""
727
747
        raise NotImplementedError(self.print_file)
728
748
 
 
749
    @deprecated_method(deprecated_in((2, 4, 0)))
729
750
    def set_revision_history(self, rev_history):
730
 
        raise NotImplementedError(self.set_revision_history)
 
751
        """See Branch.set_revision_history."""
 
752
        self._set_revision_history(rev_history)
 
753
 
 
754
    @needs_write_lock
 
755
    def _set_revision_history(self, rev_history):
 
756
        if len(rev_history) == 0:
 
757
            revid = _mod_revision.NULL_REVISION
 
758
        else:
 
759
            revid = rev_history[-1]
 
760
        if rev_history != self._lefthand_history(revid):
 
761
            raise errors.NotLefthandHistory(rev_history)
 
762
        self.set_last_revision_info(len(rev_history), revid)
 
763
        self._cache_revision_history(rev_history)
 
764
        for hook in Branch.hooks['set_rh']:
 
765
            hook(self, rev_history)
 
766
 
 
767
    @needs_write_lock
 
768
    def set_last_revision_info(self, revno, revision_id):
 
769
        """Set the last revision of this branch.
 
770
 
 
771
        The caller is responsible for checking that the revno is correct
 
772
        for this revision id.
 
773
 
 
774
        It may be possible to set the branch last revision to an id not
 
775
        present in the repository.  However, branches can also be
 
776
        configured to check constraints on history, in which case this may not
 
777
        be permitted.
 
778
        """
 
779
        raise NotImplementedError(self.last_revision_info)
 
780
 
 
781
    @needs_write_lock
 
782
    def generate_revision_history(self, revision_id, last_rev=None,
 
783
                                  other_branch=None):
 
784
        """See Branch.generate_revision_history"""
 
785
        graph = self.repository.get_graph()
 
786
        known_revision_ids = [
 
787
            self.last_revision_info(),
 
788
            (_mod_revision.NULL_REVISION, 0),
 
789
            ]
 
790
        if last_rev is not None:
 
791
            if not graph.is_ancestor(last_rev, revision_id):
 
792
                # our previous tip is not merged into stop_revision
 
793
                raise errors.DivergedBranches(self, other_branch)
 
794
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
 
795
        self.set_last_revision_info(revno, revision_id)
731
796
 
732
797
    @needs_write_lock
733
798
    def set_parent(self, url):
777
842
 
778
843
    def _unstack(self):
779
844
        """Change a branch to be unstacked, copying data as needed.
780
 
        
 
845
 
781
846
        Don't call this directly, use set_stacked_on_url(None).
782
847
        """
783
848
        pb = ui.ui_factory.nested_progress_bar()
792
857
            old_repository = self.repository
793
858
            if len(old_repository._fallback_repositories) != 1:
794
859
                raise AssertionError("can't cope with fallback repositories "
795
 
                    "of %r" % (self.repository,))
796
 
            # unlock it, including unlocking the fallback
 
860
                    "of %r (fallbacks: %r)" % (old_repository,
 
861
                        old_repository._fallback_repositories))
 
862
            # Open the new repository object.
 
863
            # Repositories don't offer an interface to remove fallback
 
864
            # repositories today; take the conceptually simpler option and just
 
865
            # reopen it.  We reopen it starting from the URL so that we
 
866
            # get a separate connection for RemoteRepositories and can
 
867
            # stream from one of them to the other.  This does mean doing
 
868
            # separate SSH connection setup, but unstacking is not a
 
869
            # common operation so it's tolerable.
 
870
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
871
            new_repository = new_bzrdir.find_repository()
 
872
            if new_repository._fallback_repositories:
 
873
                raise AssertionError("didn't expect %r to have "
 
874
                    "fallback_repositories"
 
875
                    % (self.repository,))
 
876
            # Replace self.repository with the new repository.
 
877
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
878
            # lock count) of self.repository to the new repository.
 
879
            lock_token = old_repository.lock_write().repository_token
 
880
            self.repository = new_repository
 
881
            if isinstance(self, remote.RemoteBranch):
 
882
                # Remote branches can have a second reference to the old
 
883
                # repository that need to be replaced.
 
884
                if self._real_branch is not None:
 
885
                    self._real_branch.repository = new_repository
 
886
            self.repository.lock_write(token=lock_token)
 
887
            if lock_token is not None:
 
888
                old_repository.leave_lock_in_place()
797
889
            old_repository.unlock()
 
890
            if lock_token is not None:
 
891
                # XXX: self.repository.leave_lock_in_place() before this
 
892
                # function will not be preserved.  Fortunately that doesn't
 
893
                # affect the current default format (2a), and would be a
 
894
                # corner-case anyway.
 
895
                #  - Andrew Bennetts, 2010/06/30
 
896
                self.repository.dont_leave_lock_in_place()
 
897
            old_lock_count = 0
 
898
            while True:
 
899
                try:
 
900
                    old_repository.unlock()
 
901
                except errors.LockNotHeld:
 
902
                    break
 
903
                old_lock_count += 1
 
904
            if old_lock_count == 0:
 
905
                raise AssertionError(
 
906
                    'old_repository should have been locked at least once.')
 
907
            for i in range(old_lock_count-1):
 
908
                self.repository.lock_write()
 
909
            # Fetch from the old repository into the new.
798
910
            old_repository.lock_read()
799
911
            try:
800
 
                # Repositories don't offer an interface to remove fallback
801
 
                # repositories today; take the conceptually simpler option and just
802
 
                # reopen it.  We reopen it starting from the URL so that we
803
 
                # get a separate connection for RemoteRepositories and can
804
 
                # stream from one of them to the other.  This does mean doing
805
 
                # separate SSH connection setup, but unstacking is not a
806
 
                # common operation so it's tolerable.
807
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
808
 
                new_repository = new_bzrdir.find_repository()
809
 
                self.repository = new_repository
810
 
                if self.repository._fallback_repositories:
811
 
                    raise AssertionError("didn't expect %r to have "
812
 
                        "fallback_repositories"
813
 
                        % (self.repository,))
814
 
                # this is not paired with an unlock because it's just restoring
815
 
                # the previous state; the lock's released when set_stacked_on_url
816
 
                # returns
817
 
                self.repository.lock_write()
818
912
                # XXX: If you unstack a branch while it has a working tree
819
913
                # with a pending merge, the pending-merged revisions will no
820
914
                # longer be present.  You can (probably) revert and remerge.
821
 
                #
822
 
                # XXX: This only fetches up to the tip of the repository; it
823
 
                # doesn't bring across any tags.  That's fairly consistent
824
 
                # with how branch works, but perhaps not ideal.
825
 
                self.repository.fetch(old_repository,
826
 
                    revision_id=self.last_revision(),
827
 
                    find_ghosts=True)
 
915
                try:
 
916
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
917
                except errors.TagsNotSupported:
 
918
                    tags_to_fetch = set()
 
919
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
920
                    old_repository, required_ids=[self.last_revision()],
 
921
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
922
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
828
923
            finally:
829
924
                old_repository.unlock()
830
925
        finally:
835
930
 
836
931
        :seealso: Branch._get_tags_bytes.
837
932
        """
838
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
839
 
            'tags', bytes)
 
933
        return _run_with_write_locked_target(self, self._set_tags_bytes_locked,
 
934
                bytes)
 
935
 
 
936
    def _set_tags_bytes_locked(self, bytes):
 
937
        self._tags_bytes = bytes
 
938
        return self._transport.put_bytes('tags', bytes)
840
939
 
841
940
    def _cache_revision_history(self, rev_history):
842
941
        """Set the cached revision history to rev_history.
869
968
        self._revision_history_cache = None
870
969
        self._revision_id_to_revno_cache = None
871
970
        self._last_revision_info_cache = None
 
971
        self._master_branch_cache = None
872
972
        self._merge_sorted_revisions_cache = None
873
973
        self._partial_revision_history_cache = []
874
974
        self._partial_revision_id_to_revno_cache = {}
 
975
        self._tags_bytes = None
875
976
 
876
977
    def _gen_revision_history(self):
877
978
        """Return sequence of revision hashes on to this branch.
927
1028
        :return: A tuple (revno, revision_id).
928
1029
        """
929
1030
        if self._last_revision_info_cache is None:
930
 
            self._last_revision_info_cache = self._last_revision_info()
 
1031
            self._last_revision_info_cache = self._read_last_revision_info()
931
1032
        return self._last_revision_info_cache
932
1033
 
933
 
    def _last_revision_info(self):
934
 
        rh = self.revision_history()
935
 
        revno = len(rh)
936
 
        if revno:
937
 
            return (revno, rh[-1])
938
 
        else:
939
 
            return (0, _mod_revision.NULL_REVISION)
940
 
 
941
 
    @deprecated_method(deprecated_in((1, 6, 0)))
942
 
    def missing_revisions(self, other, stop_revision=None):
943
 
        """Return a list of new revisions that would perfectly fit.
944
 
 
945
 
        If self and other have not diverged, return a list of the revisions
946
 
        present in other, but missing from self.
947
 
        """
948
 
        self_history = self.revision_history()
949
 
        self_len = len(self_history)
950
 
        other_history = other.revision_history()
951
 
        other_len = len(other_history)
952
 
        common_index = min(self_len, other_len) -1
953
 
        if common_index >= 0 and \
954
 
            self_history[common_index] != other_history[common_index]:
955
 
            raise errors.DivergedBranches(self, other)
956
 
 
957
 
        if stop_revision is None:
958
 
            stop_revision = other_len
959
 
        else:
960
 
            if stop_revision > other_len:
961
 
                raise errors.NoSuchRevision(self, stop_revision)
962
 
        return other_history[self_len:stop_revision]
963
 
 
964
 
    @needs_write_lock
965
 
    def update_revisions(self, other, stop_revision=None, overwrite=False,
966
 
                         graph=None):
967
 
        """Pull in new perfect-fit revisions.
968
 
 
969
 
        :param other: Another Branch to pull from
970
 
        :param stop_revision: Updated until the given revision
971
 
        :param overwrite: Always set the branch pointer, rather than checking
972
 
            to see if it is a proper descendant.
973
 
        :param graph: A Graph object that can be used to query history
974
 
            information. This can be None.
975
 
        :return: None
976
 
        """
977
 
        return InterBranch.get(other, self).update_revisions(stop_revision,
978
 
            overwrite, graph)
979
 
 
 
1034
    def _read_last_revision_info(self):
 
1035
        raise NotImplementedError(self._read_last_revision_info)
 
1036
 
 
1037
    @deprecated_method(deprecated_in((2, 4, 0)))
980
1038
    def import_last_revision_info(self, source_repo, revno, revid):
981
1039
        """Set the last revision info, importing from another repo if necessary.
982
1040
 
983
 
        This is used by the bound branch code to upload a revision to
984
 
        the master branch first before updating the tip of the local branch.
985
 
 
986
1041
        :param source_repo: Source repository to optionally fetch from
987
1042
        :param revno: Revision number of the new tip
988
1043
        :param revid: Revision id of the new tip
991
1046
            self.repository.fetch(source_repo, revision_id=revid)
992
1047
        self.set_last_revision_info(revno, revid)
993
1048
 
 
1049
    def import_last_revision_info_and_tags(self, source, revno, revid,
 
1050
                                           lossy=False):
 
1051
        """Set the last revision info, importing from another repo if necessary.
 
1052
 
 
1053
        This is used by the bound branch code to upload a revision to
 
1054
        the master branch first before updating the tip of the local branch.
 
1055
        Revisions referenced by source's tags are also transferred.
 
1056
 
 
1057
        :param source: Source branch to optionally fetch from
 
1058
        :param revno: Revision number of the new tip
 
1059
        :param revid: Revision id of the new tip
 
1060
        :param lossy: Whether to discard metadata that can not be
 
1061
            natively represented
 
1062
        :return: Tuple with the new revision number and revision id
 
1063
            (should only be different from the arguments when lossy=True)
 
1064
        """
 
1065
        if not self.repository.has_same_location(source.repository):
 
1066
            self.fetch(source, revid)
 
1067
        self.set_last_revision_info(revno, revid)
 
1068
        return (revno, revid)
 
1069
 
994
1070
    def revision_id_to_revno(self, revision_id):
995
1071
        """Given a revision id, return its revno"""
996
1072
        if _mod_revision.is_null(revision_id):
1016
1092
            self._extend_partial_history(distance_from_last)
1017
1093
        return self._partial_revision_history_cache[distance_from_last]
1018
1094
 
1019
 
    @needs_write_lock
1020
1095
    def pull(self, source, overwrite=False, stop_revision=None,
1021
1096
             possible_transports=None, *args, **kwargs):
1022
1097
        """Mirror source into this branch.
1029
1104
            stop_revision=stop_revision,
1030
1105
            possible_transports=possible_transports, *args, **kwargs)
1031
1106
 
1032
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1033
 
        **kwargs):
 
1107
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
 
1108
            *args, **kwargs):
1034
1109
        """Mirror this branch into target.
1035
1110
 
1036
1111
        This branch is considered to be 'local', having low latency.
1037
1112
        """
1038
1113
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1039
 
            *args, **kwargs)
1040
 
 
1041
 
    def lossy_push(self, target, stop_revision=None):
1042
 
        """Push deltas into another branch.
1043
 
 
1044
 
        :note: This does not, like push, retain the revision ids from 
1045
 
            the source branch and will, rather than adding bzr-specific 
1046
 
            metadata, push only those semantics of the revision that can be 
1047
 
            natively represented by this branch' VCS.
1048
 
 
1049
 
        :param target: Target branch
1050
 
        :param stop_revision: Revision to push, defaults to last revision.
1051
 
        :return: BranchPushResult with an extra member revidmap: 
1052
 
            A dictionary mapping revision ids from the target branch 
1053
 
            to new revision ids in the target branch, for each 
1054
 
            revision that was pushed.
1055
 
        """
1056
 
        inter = InterBranch.get(self, target)
1057
 
        lossy_push = getattr(inter, "lossy_push", None)
1058
 
        if lossy_push is None:
1059
 
            raise errors.LossyPushToSameVCS(self, target)
1060
 
        return lossy_push(stop_revision)
 
1114
            lossy, *args, **kwargs)
1061
1115
 
1062
1116
    def basis_tree(self):
1063
1117
        """Return `Tree` object for last revision."""
1218
1272
        return result
1219
1273
 
1220
1274
    @needs_read_lock
1221
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1275
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1276
            repository=None):
1222
1277
        """Create a new line of development from the branch, into to_bzrdir.
1223
1278
 
1224
1279
        to_bzrdir controls the branch format.
1229
1284
        if (repository_policy is not None and
1230
1285
            repository_policy.requires_stacking()):
1231
1286
            to_bzrdir._format.require_stacking(_skip_repo=True)
1232
 
        result = to_bzrdir.create_branch()
 
1287
        result = to_bzrdir.create_branch(repository=repository)
1233
1288
        result.lock_write()
1234
1289
        try:
1235
1290
            if repository_policy is not None:
1236
1291
                repository_policy.configure_branch(result)
1237
1292
            self.copy_content_into(result, revision_id=revision_id)
1238
 
            result.set_parent(self.bzrdir.root_transport.base)
 
1293
            master_branch = self.get_master_branch()
 
1294
            if master_branch is None:
 
1295
                result.set_parent(self.bzrdir.root_transport.base)
 
1296
            else:
 
1297
                result.set_parent(master_branch.bzrdir.root_transport.base)
1239
1298
        finally:
1240
1299
            result.unlock()
1241
1300
        return result
1265
1324
                revno = 1
1266
1325
        destination.set_last_revision_info(revno, revision_id)
1267
1326
 
1268
 
    @needs_read_lock
1269
1327
    def copy_content_into(self, destination, revision_id=None):
1270
1328
        """Copy the content of self into destination.
1271
1329
 
1272
1330
        revision_id: if not None, the revision history in the new branch will
1273
1331
                     be truncated to end with revision_id.
1274
1332
        """
1275
 
        self.update_references(destination)
1276
 
        self._synchronize_history(destination, revision_id)
1277
 
        try:
1278
 
            parent = self.get_parent()
1279
 
        except errors.InaccessibleParent, e:
1280
 
            mutter('parent was not accessible to copy: %s', e)
1281
 
        else:
1282
 
            if parent:
1283
 
                destination.set_parent(parent)
1284
 
        if self._push_should_merge_tags():
1285
 
            self.tags.merge_to(destination.tags)
 
1333
        return InterBranch.get(self, destination).copy_content_into(
 
1334
            revision_id=revision_id)
1286
1335
 
1287
1336
    def update_references(self, target):
1288
1337
        if not getattr(self._format, 'supports_reference_locations', False):
1333
1382
        """Return the most suitable metadir for a checkout of this branch.
1334
1383
        Weaves are used if this branch's repository uses weaves.
1335
1384
        """
1336
 
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1337
 
            from bzrlib.repofmt import weaverepo
1338
 
            format = bzrdir.BzrDirMetaFormat1()
1339
 
            format.repository_format = weaverepo.RepositoryFormat7()
1340
 
        else:
1341
 
            format = self.repository.bzrdir.checkout_metadir()
1342
 
            format.set_branch_format(self._format)
 
1385
        format = self.repository.bzrdir.checkout_metadir()
 
1386
        format.set_branch_format(self._format)
1343
1387
        return format
1344
1388
 
1345
1389
    def create_clone_on_transport(self, to_transport, revision_id=None,
1346
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1390
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1391
        no_tree=None):
1347
1392
        """Create a clone of this branch and its bzrdir.
1348
1393
 
1349
1394
        :param to_transport: The transport to clone onto.
1362
1407
            revision_id = self.last_revision()
1363
1408
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1364
1409
            revision_id=revision_id, stacked_on=stacked_on,
1365
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1410
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1411
            no_tree=no_tree)
1366
1412
        return dir_to.open_branch()
1367
1413
 
1368
1414
    def create_checkout(self, to_location, revision_id=None,
1373
1419
        :param to_location: The url to produce the checkout at
1374
1420
        :param revision_id: The revision to check out
1375
1421
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1376
 
        produce a bound branch (heavyweight checkout)
 
1422
            produce a bound branch (heavyweight checkout)
1377
1423
        :param accelerator_tree: A tree which can be used for retrieving file
1378
1424
            contents more quickly than the revision tree, i.e. a workingtree.
1379
1425
            The revision tree will be used for cases where accelerator_tree's
1425
1471
 
1426
1472
    def reference_parent(self, file_id, path, possible_transports=None):
1427
1473
        """Return the parent branch for a tree-reference file_id
 
1474
 
1428
1475
        :param file_id: The file_id of the tree reference
1429
1476
        :param path: The path of the file_id in the tree
1430
1477
        :return: A branch associated with the file_id
1483
1530
        else:
1484
1531
            raise AssertionError("invalid heads: %r" % (heads,))
1485
1532
 
1486
 
 
1487
 
class BranchFormat(object):
 
1533
    def heads_to_fetch(self):
 
1534
        """Return the heads that must and that should be fetched to copy this
 
1535
        branch into another repo.
 
1536
 
 
1537
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1538
            set of heads that must be fetched.  if_present_fetch is a set of
 
1539
            heads that must be fetched if present, but no error is necessary if
 
1540
            they are not present.
 
1541
        """
 
1542
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
 
1543
        # are the tags.
 
1544
        must_fetch = set([self.last_revision()])
 
1545
        try:
 
1546
            if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1547
        except errors.TagsNotSupported:
 
1548
            if_present_fetch = set()
 
1549
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1550
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1551
        return must_fetch, if_present_fetch
 
1552
 
 
1553
 
 
1554
class BranchFormat(controldir.ControlComponentFormat):
1488
1555
    """An encapsulation of the initialization and open routines for a format.
1489
1556
 
1490
1557
    Formats provide three things:
1493
1560
     * an open routine.
1494
1561
 
1495
1562
    Formats are placed in an dict by their format string for reference
1496
 
    during branch opening. Its not required that these be instances, they
 
1563
    during branch opening. It's not required that these be instances, they
1497
1564
    can be classes themselves with class methods - it simply depends on
1498
1565
    whether state is needed for a given format or not.
1499
1566
 
1502
1569
    object will be created every time regardless.
1503
1570
    """
1504
1571
 
1505
 
    _default_format = None
1506
 
    """The default format used for new branches."""
1507
 
 
1508
 
    _formats = {}
1509
 
    """The known formats."""
1510
 
 
1511
1572
    can_set_append_revisions_only = True
1512
1573
 
1513
1574
    def __eq__(self, other):
1522
1583
        try:
1523
1584
            transport = a_bzrdir.get_branch_transport(None, name=name)
1524
1585
            format_string = transport.get_bytes("format")
1525
 
            return klass._formats[format_string]
 
1586
            return format_registry.get(format_string)
1526
1587
        except errors.NoSuchFile:
1527
1588
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1528
1589
        except KeyError:
1529
1590
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1530
1591
 
1531
1592
    @classmethod
 
1593
    @deprecated_method(deprecated_in((2, 4, 0)))
1532
1594
    def get_default_format(klass):
1533
1595
        """Return the current default format."""
1534
 
        return klass._default_format
 
1596
        return format_registry.get_default()
 
1597
 
 
1598
    @classmethod
 
1599
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1600
    def get_formats(klass):
 
1601
        """Get all the known formats.
 
1602
 
 
1603
        Warning: This triggers a load of all lazy registered formats: do not
 
1604
        use except when that is desireed.
 
1605
        """
 
1606
        return format_registry._get_all()
1535
1607
 
1536
1608
    def get_reference(self, a_bzrdir, name=None):
1537
1609
        """Get the target reference of the branch in a_bzrdir.
1576
1648
        for hook in hooks:
1577
1649
            hook(params)
1578
1650
 
1579
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1580
 
                           lock_type='metadir', set_format=True):
1581
 
        """Initialize a branch in a bzrdir, with specified files
1582
 
 
1583
 
        :param a_bzrdir: The bzrdir to initialize the branch in
1584
 
        :param utf8_files: The files to create as a list of
1585
 
            (filename, content) tuples
1586
 
        :param name: Name of colocated branch to create, if any
1587
 
        :param set_format: If True, set the format with
1588
 
            self.get_format_string.  (BzrBranch4 has its format set
1589
 
            elsewhere)
1590
 
        :return: a branch in this format
1591
 
        """
1592
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1593
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1594
 
        lock_map = {
1595
 
            'metadir': ('lock', lockdir.LockDir),
1596
 
            'branch4': ('branch-lock', lockable_files.TransportLock),
1597
 
        }
1598
 
        lock_name, lock_class = lock_map[lock_type]
1599
 
        control_files = lockable_files.LockableFiles(branch_transport,
1600
 
            lock_name, lock_class)
1601
 
        control_files.create_lock()
1602
 
        try:
1603
 
            control_files.lock_write()
1604
 
        except errors.LockContention:
1605
 
            if lock_type != 'branch4':
1606
 
                raise
1607
 
            lock_taken = False
1608
 
        else:
1609
 
            lock_taken = True
1610
 
        if set_format:
1611
 
            utf8_files += [('format', self.get_format_string())]
1612
 
        try:
1613
 
            for (filename, content) in utf8_files:
1614
 
                branch_transport.put_bytes(
1615
 
                    filename, content,
1616
 
                    mode=a_bzrdir._get_file_mode())
1617
 
        finally:
1618
 
            if lock_taken:
1619
 
                control_files.unlock()
1620
 
        branch = self.open(a_bzrdir, name, _found=True)
1621
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1622
 
        return branch
1623
 
 
1624
 
    def initialize(self, a_bzrdir, name=None):
 
1651
    def initialize(self, a_bzrdir, name=None, repository=None):
1625
1652
        """Create a branch of this format in a_bzrdir.
1626
1653
        
1627
1654
        :param name: Name of the colocated branch to create.
1661
1688
        """
1662
1689
        raise NotImplementedError(self.network_name)
1663
1690
 
1664
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1691
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
1692
            found_repository=None):
1665
1693
        """Return the branch object for a_bzrdir
1666
1694
 
1667
1695
        :param a_bzrdir: A BzrDir that contains a branch.
1674
1702
        raise NotImplementedError(self.open)
1675
1703
 
1676
1704
    @classmethod
 
1705
    @deprecated_method(deprecated_in((2, 4, 0)))
1677
1706
    def register_format(klass, format):
1678
 
        """Register a metadir format."""
1679
 
        klass._formats[format.get_format_string()] = format
1680
 
        # Metadir formats have a network name of their format string, and get
1681
 
        # registered as class factories.
1682
 
        network_format_registry.register(format.get_format_string(), format.__class__)
 
1707
        """Register a metadir format.
 
1708
 
 
1709
        See MetaDirBranchFormatFactory for the ability to register a format
 
1710
        without loading the code the format needs until it is actually used.
 
1711
        """
 
1712
        format_registry.register(format)
1683
1713
 
1684
1714
    @classmethod
 
1715
    @deprecated_method(deprecated_in((2, 4, 0)))
1685
1716
    def set_default_format(klass, format):
1686
 
        klass._default_format = format
 
1717
        format_registry.set_default(format)
1687
1718
 
1688
1719
    def supports_set_append_revisions_only(self):
1689
1720
        """True if this format supports set_append_revisions_only."""
1693
1724
        """True if this format records a stacked-on branch."""
1694
1725
        return False
1695
1726
 
 
1727
    def supports_leaving_lock(self):
 
1728
        """True if this format supports leaving locks in place."""
 
1729
        return False # by default
 
1730
 
1696
1731
    @classmethod
 
1732
    @deprecated_method(deprecated_in((2, 4, 0)))
1697
1733
    def unregister_format(klass, format):
1698
 
        del klass._formats[format.get_format_string()]
 
1734
        format_registry.remove(format)
1699
1735
 
1700
1736
    def __str__(self):
1701
1737
        return self.get_format_description().rstrip()
1705
1741
        return False  # by default
1706
1742
 
1707
1743
 
 
1744
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1745
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1746
    
 
1747
    While none of the built in BranchFormats are lazy registered yet,
 
1748
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1749
    use it, and the bzr-loom plugin uses it as well (see
 
1750
    bzrlib.plugins.loom.formats).
 
1751
    """
 
1752
 
 
1753
    def __init__(self, format_string, module_name, member_name):
 
1754
        """Create a MetaDirBranchFormatFactory.
 
1755
 
 
1756
        :param format_string: The format string the format has.
 
1757
        :param module_name: Module to load the format class from.
 
1758
        :param member_name: Attribute name within the module for the format class.
 
1759
        """
 
1760
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1761
        self._format_string = format_string
 
1762
        
 
1763
    def get_format_string(self):
 
1764
        """See BranchFormat.get_format_string."""
 
1765
        return self._format_string
 
1766
 
 
1767
    def __call__(self):
 
1768
        """Used for network_format_registry support."""
 
1769
        return self.get_obj()()
 
1770
 
 
1771
 
1708
1772
class BranchHooks(Hooks):
1709
1773
    """A dictionary mapping hook name to a list of callables for branch hooks.
1710
1774
 
1718
1782
        These are all empty initially, because by default nothing should get
1719
1783
        notified.
1720
1784
        """
1721
 
        Hooks.__init__(self)
1722
 
        self.create_hook(HookPoint('set_rh',
 
1785
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1786
        self.add_hook('set_rh',
1723
1787
            "Invoked whenever the revision history has been set via "
1724
1788
            "set_revision_history. The api signature is (branch, "
1725
1789
            "revision_history), and the branch will be write-locked. "
1726
1790
            "The set_rh hook can be expensive for bzr to trigger, a better "
1727
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1728
 
        self.create_hook(HookPoint('open',
 
1791
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
 
1792
        self.add_hook('open',
1729
1793
            "Called with the Branch object that has been opened after a "
1730
 
            "branch is opened.", (1, 8), None))
1731
 
        self.create_hook(HookPoint('post_push',
 
1794
            "branch is opened.", (1, 8))
 
1795
        self.add_hook('post_push',
1732
1796
            "Called after a push operation completes. post_push is called "
1733
1797
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1734
 
            "bzr client.", (0, 15), None))
1735
 
        self.create_hook(HookPoint('post_pull',
 
1798
            "bzr client.", (0, 15))
 
1799
        self.add_hook('post_pull',
1736
1800
            "Called after a pull operation completes. post_pull is called "
1737
1801
            "with a bzrlib.branch.PullResult object and only runs in the "
1738
 
            "bzr client.", (0, 15), None))
1739
 
        self.create_hook(HookPoint('pre_commit',
1740
 
            "Called after a commit is calculated but before it is is "
 
1802
            "bzr client.", (0, 15))
 
1803
        self.add_hook('pre_commit',
 
1804
            "Called after a commit is calculated but before it is "
1741
1805
            "completed. pre_commit is called with (local, master, old_revno, "
1742
1806
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1743
1807
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1745
1809
            "basis revision. hooks MUST NOT modify this delta. "
1746
1810
            " future_tree is an in-memory tree obtained from "
1747
1811
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1748
 
            "tree.", (0,91), None))
1749
 
        self.create_hook(HookPoint('post_commit',
 
1812
            "tree.", (0,91))
 
1813
        self.add_hook('post_commit',
1750
1814
            "Called in the bzr client after a commit has completed. "
1751
1815
            "post_commit is called with (local, master, old_revno, old_revid, "
1752
1816
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1753
 
            "commit to a branch.", (0, 15), None))
1754
 
        self.create_hook(HookPoint('post_uncommit',
 
1817
            "commit to a branch.", (0, 15))
 
1818
        self.add_hook('post_uncommit',
1755
1819
            "Called in the bzr client after an uncommit completes. "
1756
1820
            "post_uncommit is called with (local, master, old_revno, "
1757
1821
            "old_revid, new_revno, new_revid) where local is the local branch "
1758
1822
            "or None, master is the target branch, and an empty branch "
1759
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1760
 
        self.create_hook(HookPoint('pre_change_branch_tip',
 
1823
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1824
        self.add_hook('pre_change_branch_tip',
1761
1825
            "Called in bzr client and server before a change to the tip of a "
1762
1826
            "branch is made. pre_change_branch_tip is called with a "
1763
1827
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1764
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1765
 
        self.create_hook(HookPoint('post_change_branch_tip',
 
1828
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1829
        self.add_hook('post_change_branch_tip',
1766
1830
            "Called in bzr client and server after a change to the tip of a "
1767
1831
            "branch is made. post_change_branch_tip is called with a "
1768
1832
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1769
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1770
 
        self.create_hook(HookPoint('transform_fallback_location',
 
1833
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1834
        self.add_hook('transform_fallback_location',
1771
1835
            "Called when a stacked branch is activating its fallback "
1772
1836
            "locations. transform_fallback_location is called with (branch, "
1773
1837
            "url), and should return a new url. Returning the same url "
1778
1842
            "fallback locations have not been activated. When there are "
1779
1843
            "multiple hooks installed for transform_fallback_location, "
1780
1844
            "all are called with the url returned from the previous hook."
1781
 
            "The order is however undefined.", (1, 9), None))
1782
 
        self.create_hook(HookPoint('automatic_tag_name',
1783
 
            "Called to determine an automatic tag name for a revision."
 
1845
            "The order is however undefined.", (1, 9))
 
1846
        self.add_hook('automatic_tag_name',
 
1847
            "Called to determine an automatic tag name for a revision. "
1784
1848
            "automatic_tag_name is called with (branch, revision_id) and "
1785
1849
            "should return a tag name or None if no tag name could be "
1786
1850
            "determined. The first non-None tag name returned will be used.",
1787
 
            (2, 2), None))
1788
 
        self.create_hook(HookPoint('post_branch_init',
 
1851
            (2, 2))
 
1852
        self.add_hook('post_branch_init',
1789
1853
            "Called after new branch initialization completes. "
1790
1854
            "post_branch_init is called with a "
1791
1855
            "bzrlib.branch.BranchInitHookParams. "
1792
1856
            "Note that init, branch and checkout (both heavyweight and "
1793
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1794
 
        self.create_hook(HookPoint('post_switch',
 
1857
            "lightweight) will all trigger this hook.", (2, 2))
 
1858
        self.add_hook('post_switch',
1795
1859
            "Called after a checkout switches branch. "
1796
1860
            "post_switch is called with a "
1797
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1861
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1798
1862
 
1799
1863
 
1800
1864
 
1803
1867
 
1804
1868
 
1805
1869
class ChangeBranchTipParams(object):
1806
 
    """Object holding parameters passed to *_change_branch_tip hooks.
 
1870
    """Object holding parameters passed to `*_change_branch_tip` hooks.
1807
1871
 
1808
1872
    There are 5 fields that hooks may wish to access:
1809
1873
 
1841
1905
 
1842
1906
 
1843
1907
class BranchInitHookParams(object):
1844
 
    """Object holding parameters passed to *_branch_init hooks.
 
1908
    """Object holding parameters passed to `*_branch_init` hooks.
1845
1909
 
1846
1910
    There are 4 fields that hooks may wish to access:
1847
1911
 
1877
1941
        return self.__dict__ == other.__dict__
1878
1942
 
1879
1943
    def __repr__(self):
1880
 
        if self.branch:
1881
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1882
 
        else:
1883
 
            return "<%s of format:%s bzrdir:%s>" % (
1884
 
                self.__class__.__name__, self.branch,
1885
 
                self.format, self.bzrdir)
 
1944
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1886
1945
 
1887
1946
 
1888
1947
class SwitchHookParams(object):
1889
 
    """Object holding parameters passed to *_switch hooks.
 
1948
    """Object holding parameters passed to `*_switch` hooks.
1890
1949
 
1891
1950
    There are 4 fields that hooks may wish to access:
1892
1951
 
1918
1977
            self.revision_id)
1919
1978
 
1920
1979
 
1921
 
class BzrBranchFormat4(BranchFormat):
1922
 
    """Bzr branch format 4.
1923
 
 
1924
 
    This format has:
1925
 
     - a revision-history file.
1926
 
     - a branch-lock lock file [ to be shared with the bzrdir ]
1927
 
    """
1928
 
 
1929
 
    def get_format_description(self):
1930
 
        """See BranchFormat.get_format_description()."""
1931
 
        return "Branch format 4"
1932
 
 
1933
 
    def initialize(self, a_bzrdir, name=None):
1934
 
        """Create a branch of this format in a_bzrdir."""
1935
 
        utf8_files = [('revision-history', ''),
1936
 
                      ('branch-name', ''),
1937
 
                      ]
1938
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1939
 
                                       lock_type='branch4', set_format=False)
1940
 
 
1941
 
    def __init__(self):
1942
 
        super(BzrBranchFormat4, self).__init__()
1943
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1944
 
 
1945
 
    def network_name(self):
1946
 
        """The network name for this format is the control dirs disk label."""
1947
 
        return self._matchingbzrdir.get_format_string()
1948
 
 
1949
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1950
 
        """See BranchFormat.open()."""
1951
 
        if not _found:
1952
 
            # we are being called directly and must probe.
1953
 
            raise NotImplementedError
1954
 
        return BzrBranch(_format=self,
1955
 
                         _control_files=a_bzrdir._control_files,
1956
 
                         a_bzrdir=a_bzrdir,
1957
 
                         name=name,
1958
 
                         _repository=a_bzrdir.open_repository())
1959
 
 
1960
 
    def __str__(self):
1961
 
        return "Bazaar-NG branch format 4"
1962
 
 
1963
 
 
1964
1980
class BranchFormatMetadir(BranchFormat):
1965
1981
    """Common logic for meta-dir based branch formats."""
1966
1982
 
1968
1984
        """What class to instantiate on open calls."""
1969
1985
        raise NotImplementedError(self._branch_class)
1970
1986
 
 
1987
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
1988
                           repository=None):
 
1989
        """Initialize a branch in a bzrdir, with specified files
 
1990
 
 
1991
        :param a_bzrdir: The bzrdir to initialize the branch in
 
1992
        :param utf8_files: The files to create as a list of
 
1993
            (filename, content) tuples
 
1994
        :param name: Name of colocated branch to create, if any
 
1995
        :return: a branch in this format
 
1996
        """
 
1997
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1998
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1999
        control_files = lockable_files.LockableFiles(branch_transport,
 
2000
            'lock', lockdir.LockDir)
 
2001
        control_files.create_lock()
 
2002
        control_files.lock_write()
 
2003
        try:
 
2004
            utf8_files += [('format', self.get_format_string())]
 
2005
            for (filename, content) in utf8_files:
 
2006
                branch_transport.put_bytes(
 
2007
                    filename, content,
 
2008
                    mode=a_bzrdir._get_file_mode())
 
2009
        finally:
 
2010
            control_files.unlock()
 
2011
        branch = self.open(a_bzrdir, name, _found=True,
 
2012
                found_repository=repository)
 
2013
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2014
        return branch
 
2015
 
1971
2016
    def network_name(self):
1972
2017
        """A simple byte string uniquely identifying this format for RPC calls.
1973
2018
 
1975
2020
        """
1976
2021
        return self.get_format_string()
1977
2022
 
1978
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2023
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2024
            found_repository=None):
1979
2025
        """See BranchFormat.open()."""
1980
2026
        if not _found:
1981
2027
            format = BranchFormat.find_format(a_bzrdir, name=name)
1986
2032
        try:
1987
2033
            control_files = lockable_files.LockableFiles(transport, 'lock',
1988
2034
                                                         lockdir.LockDir)
 
2035
            if found_repository is None:
 
2036
                found_repository = a_bzrdir.find_repository()
1989
2037
            return self._branch_class()(_format=self,
1990
2038
                              _control_files=control_files,
1991
2039
                              name=name,
1992
2040
                              a_bzrdir=a_bzrdir,
1993
 
                              _repository=a_bzrdir.find_repository(),
 
2041
                              _repository=found_repository,
1994
2042
                              ignore_fallbacks=ignore_fallbacks)
1995
2043
        except errors.NoSuchFile:
1996
2044
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2003
2051
    def supports_tags(self):
2004
2052
        return True
2005
2053
 
 
2054
    def supports_leaving_lock(self):
 
2055
        return True
 
2056
 
2006
2057
 
2007
2058
class BzrBranchFormat5(BranchFormatMetadir):
2008
2059
    """Bzr branch format 5.
2028
2079
        """See BranchFormat.get_format_description()."""
2029
2080
        return "Branch format 5"
2030
2081
 
2031
 
    def initialize(self, a_bzrdir, name=None):
 
2082
    def initialize(self, a_bzrdir, name=None, repository=None):
2032
2083
        """Create a branch of this format in a_bzrdir."""
2033
2084
        utf8_files = [('revision-history', ''),
2034
2085
                      ('branch-name', ''),
2035
2086
                      ]
2036
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2087
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2037
2088
 
2038
2089
    def supports_tags(self):
2039
2090
        return False
2061
2112
        """See BranchFormat.get_format_description()."""
2062
2113
        return "Branch format 6"
2063
2114
 
2064
 
    def initialize(self, a_bzrdir, name=None):
 
2115
    def initialize(self, a_bzrdir, name=None, repository=None):
2065
2116
        """Create a branch of this format in a_bzrdir."""
2066
2117
        utf8_files = [('last-revision', '0 null:\n'),
2067
2118
                      ('branch.conf', ''),
2068
2119
                      ('tags', ''),
2069
2120
                      ]
2070
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2121
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2071
2122
 
2072
2123
    def make_tags(self, branch):
2073
2124
        """See bzrlib.branch.BranchFormat.make_tags()."""
2091
2142
        """See BranchFormat.get_format_description()."""
2092
2143
        return "Branch format 8"
2093
2144
 
2094
 
    def initialize(self, a_bzrdir, name=None):
 
2145
    def initialize(self, a_bzrdir, name=None, repository=None):
2095
2146
        """Create a branch of this format in a_bzrdir."""
2096
2147
        utf8_files = [('last-revision', '0 null:\n'),
2097
2148
                      ('branch.conf', ''),
2098
2149
                      ('tags', ''),
2099
2150
                      ('references', '')
2100
2151
                      ]
2101
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2102
 
 
2103
 
    def __init__(self):
2104
 
        super(BzrBranchFormat8, self).__init__()
2105
 
        self._matchingbzrdir.repository_format = \
2106
 
            RepositoryFormatKnitPack5RichRoot()
 
2152
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2107
2153
 
2108
2154
    def make_tags(self, branch):
2109
2155
        """See bzrlib.branch.BranchFormat.make_tags()."""
2118
2164
    supports_reference_locations = True
2119
2165
 
2120
2166
 
2121
 
class BzrBranchFormat7(BzrBranchFormat8):
 
2167
class BzrBranchFormat7(BranchFormatMetadir):
2122
2168
    """Branch format with last-revision, tags, and a stacked location pointer.
2123
2169
 
2124
2170
    The stacked location pointer is passed down to the repository and requires
2127
2173
    This format was introduced in bzr 1.6.
2128
2174
    """
2129
2175
 
2130
 
    def initialize(self, a_bzrdir, name=None):
 
2176
    def initialize(self, a_bzrdir, name=None, repository=None):
2131
2177
        """Create a branch of this format in a_bzrdir."""
2132
2178
        utf8_files = [('last-revision', '0 null:\n'),
2133
2179
                      ('branch.conf', ''),
2134
2180
                      ('tags', ''),
2135
2181
                      ]
2136
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2182
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2137
2183
 
2138
2184
    def _branch_class(self):
2139
2185
        return BzrBranch7
2149
2195
    def supports_set_append_revisions_only(self):
2150
2196
        return True
2151
2197
 
 
2198
    def supports_stacking(self):
 
2199
        return True
 
2200
 
 
2201
    def make_tags(self, branch):
 
2202
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2203
        return BasicTags(branch)
 
2204
 
2152
2205
    supports_reference_locations = False
2153
2206
 
2154
2207
 
2181
2234
        transport = a_bzrdir.get_branch_transport(None, name=name)
2182
2235
        location = transport.put_bytes('location', to_branch.base)
2183
2236
 
2184
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2237
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2238
            repository=None):
2185
2239
        """Create a branch of this format in a_bzrdir."""
2186
2240
        if target_branch is None:
2187
2241
            # this format does not implement branch itself, thus the implicit
2215
2269
        return clone
2216
2270
 
2217
2271
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2218
 
             possible_transports=None, ignore_fallbacks=False):
 
2272
             possible_transports=None, ignore_fallbacks=False,
 
2273
             found_repository=None):
2219
2274
        """Return the branch that the branch reference in a_bzrdir points at.
2220
2275
 
2221
2276
        :param a_bzrdir: A BzrDir that contains a branch.
2252
2307
        return result
2253
2308
 
2254
2309
 
 
2310
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2311
    """Branch format registry."""
 
2312
 
 
2313
    def __init__(self, other_registry=None):
 
2314
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2315
        self._default_format = None
 
2316
 
 
2317
    def set_default(self, format):
 
2318
        self._default_format = format
 
2319
 
 
2320
    def get_default(self):
 
2321
        return self._default_format
 
2322
 
 
2323
 
2255
2324
network_format_registry = registry.FormatRegistry()
2256
2325
"""Registry of formats indexed by their network name.
2257
2326
 
2260
2329
BranchFormat.network_name() for more detail.
2261
2330
"""
2262
2331
 
 
2332
format_registry = BranchFormatRegistry(network_format_registry)
 
2333
 
2263
2334
 
2264
2335
# formats which have no format string are not discoverable
2265
2336
# and not independently creatable, so are not registered.
2267
2338
__format6 = BzrBranchFormat6()
2268
2339
__format7 = BzrBranchFormat7()
2269
2340
__format8 = BzrBranchFormat8()
2270
 
BranchFormat.register_format(__format5)
2271
 
BranchFormat.register_format(BranchReferenceFormat())
2272
 
BranchFormat.register_format(__format6)
2273
 
BranchFormat.register_format(__format7)
2274
 
BranchFormat.register_format(__format8)
2275
 
BranchFormat.set_default_format(__format7)
2276
 
_legacy_formats = [BzrBranchFormat4(),
2277
 
    ]
2278
 
network_format_registry.register(
2279
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
 
2341
format_registry.register(__format5)
 
2342
format_registry.register(BranchReferenceFormat())
 
2343
format_registry.register(__format6)
 
2344
format_registry.register(__format7)
 
2345
format_registry.register(__format8)
 
2346
format_registry.set_default(__format7)
2280
2347
 
2281
2348
 
2282
2349
class BranchWriteLockResult(LogicalLockResult):
2430
2497
        """See Branch.print_file."""
2431
2498
        return self.repository.print_file(file, revision_id)
2432
2499
 
2433
 
    def _write_revision_history(self, history):
2434
 
        """Factored out of set_revision_history.
2435
 
 
2436
 
        This performs the actual writing to disk.
2437
 
        It is intended to be called by BzrBranch5.set_revision_history."""
2438
 
        self._transport.put_bytes(
2439
 
            'revision-history', '\n'.join(history),
2440
 
            mode=self.bzrdir._get_file_mode())
2441
 
 
2442
 
    @needs_write_lock
2443
 
    def set_revision_history(self, rev_history):
2444
 
        """See Branch.set_revision_history."""
2445
 
        if 'evil' in debug.debug_flags:
2446
 
            mutter_callsite(3, "set_revision_history scales with history.")
2447
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2448
 
        for rev_id in rev_history:
2449
 
            check_not_reserved_id(rev_id)
2450
 
        if Branch.hooks['post_change_branch_tip']:
2451
 
            # Don't calculate the last_revision_info() if there are no hooks
2452
 
            # that will use it.
2453
 
            old_revno, old_revid = self.last_revision_info()
2454
 
        if len(rev_history) == 0:
2455
 
            revid = _mod_revision.NULL_REVISION
2456
 
        else:
2457
 
            revid = rev_history[-1]
2458
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2459
 
        self._write_revision_history(rev_history)
2460
 
        self._clear_cached_state()
2461
 
        self._cache_revision_history(rev_history)
2462
 
        for hook in Branch.hooks['set_rh']:
2463
 
            hook(self, rev_history)
2464
 
        if Branch.hooks['post_change_branch_tip']:
2465
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2466
 
 
2467
 
    def _synchronize_history(self, destination, revision_id):
2468
 
        """Synchronize last revision and revision history between branches.
2469
 
 
2470
 
        This version is most efficient when the destination is also a
2471
 
        BzrBranch5, but works for BzrBranch6 as long as the revision
2472
 
        history is the true lefthand parent history, and all of the revisions
2473
 
        are in the destination's repository.  If not, set_revision_history
2474
 
        will fail.
2475
 
 
2476
 
        :param destination: The branch to copy the history into
2477
 
        :param revision_id: The revision-id to truncate history at.  May
2478
 
          be None to copy complete history.
2479
 
        """
2480
 
        if not isinstance(destination._format, BzrBranchFormat5):
2481
 
            super(BzrBranch, self)._synchronize_history(
2482
 
                destination, revision_id)
2483
 
            return
2484
 
        if revision_id == _mod_revision.NULL_REVISION:
2485
 
            new_history = []
2486
 
        else:
2487
 
            new_history = self.revision_history()
2488
 
        if revision_id is not None and new_history != []:
2489
 
            try:
2490
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2491
 
            except ValueError:
2492
 
                rev = self.repository.get_revision(revision_id)
2493
 
                new_history = rev.get_history(self.repository)[1:]
2494
 
        destination.set_revision_history(new_history)
2495
 
 
2496
2500
    @needs_write_lock
2497
2501
    def set_last_revision_info(self, revno, revision_id):
2498
 
        """Set the last revision of this branch.
2499
 
 
2500
 
        The caller is responsible for checking that the revno is correct
2501
 
        for this revision id.
2502
 
 
2503
 
        It may be possible to set the branch last revision to an id not
2504
 
        present in the repository.  However, branches can also be
2505
 
        configured to check constraints on history, in which case this may not
2506
 
        be permitted.
2507
 
        """
 
2502
        if not revision_id or not isinstance(revision_id, basestring):
 
2503
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2508
2504
        revision_id = _mod_revision.ensure_null(revision_id)
2509
 
        # this old format stores the full history, but this api doesn't
2510
 
        # provide it, so we must generate, and might as well check it's
2511
 
        # correct
2512
 
        history = self._lefthand_history(revision_id)
2513
 
        if len(history) != revno:
2514
 
            raise AssertionError('%d != %d' % (len(history), revno))
2515
 
        self.set_revision_history(history)
2516
 
 
2517
 
    def _gen_revision_history(self):
2518
 
        history = self._transport.get_bytes('revision-history').split('\n')
2519
 
        if history[-1:] == ['']:
2520
 
            # There shouldn't be a trailing newline, but just in case.
2521
 
            history.pop()
2522
 
        return history
2523
 
 
2524
 
    @needs_write_lock
2525
 
    def generate_revision_history(self, revision_id, last_rev=None,
2526
 
        other_branch=None):
2527
 
        """Create a new revision history that will finish with revision_id.
2528
 
 
2529
 
        :param revision_id: the new tip to use.
2530
 
        :param last_rev: The previous last_revision. If not None, then this
2531
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
2532
 
        :param other_branch: The other branch that DivergedBranches should
2533
 
            raise with respect to.
2534
 
        """
2535
 
        self.set_revision_history(self._lefthand_history(revision_id,
2536
 
            last_rev, other_branch))
 
2505
        old_revno, old_revid = self.last_revision_info()
 
2506
        if self._get_append_revisions_only():
 
2507
            self._check_history_violation(revision_id)
 
2508
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2509
        self._write_last_revision_info(revno, revision_id)
 
2510
        self._clear_cached_state()
 
2511
        self._last_revision_info_cache = revno, revision_id
 
2512
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2537
2513
 
2538
2514
    def basis_tree(self):
2539
2515
        """See Branch.basis_tree."""
2548
2524
                pass
2549
2525
        return None
2550
2526
 
2551
 
    def _basic_push(self, target, overwrite, stop_revision):
2552
 
        """Basic implementation of push without bound branches or hooks.
2553
 
 
2554
 
        Must be called with source read locked and target write locked.
2555
 
        """
2556
 
        result = BranchPushResult()
2557
 
        result.source_branch = self
2558
 
        result.target_branch = target
2559
 
        result.old_revno, result.old_revid = target.last_revision_info()
2560
 
        self.update_references(target)
2561
 
        if result.old_revid != self.last_revision():
2562
 
            # We assume that during 'push' this repository is closer than
2563
 
            # the target.
2564
 
            graph = self.repository.get_graph(target.repository)
2565
 
            target.update_revisions(self, stop_revision,
2566
 
                overwrite=overwrite, graph=graph)
2567
 
        if self._push_should_merge_tags():
2568
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2569
 
                overwrite)
2570
 
        result.new_revno, result.new_revid = target.last_revision_info()
2571
 
        return result
2572
 
 
2573
2527
    def get_stacked_on_url(self):
2574
2528
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2575
2529
 
2586
2540
            self._transport.put_bytes('parent', url + '\n',
2587
2541
                mode=self.bzrdir._get_file_mode())
2588
2542
 
2589
 
 
2590
 
class BzrBranch5(BzrBranch):
2591
 
    """A format 5 branch. This supports new features over plain branches.
2592
 
 
2593
 
    It has support for a master_branch which is the data for bound branches.
2594
 
    """
2595
 
 
2596
 
    def get_bound_location(self):
2597
 
        try:
2598
 
            return self._transport.get_bytes('bound')[:-1]
2599
 
        except errors.NoSuchFile:
2600
 
            return None
2601
 
 
2602
 
    @needs_read_lock
2603
 
    def get_master_branch(self, possible_transports=None):
2604
 
        """Return the branch we are bound to.
2605
 
 
2606
 
        :return: Either a Branch, or None
2607
 
 
2608
 
        This could memoise the branch, but if thats done
2609
 
        it must be revalidated on each new lock.
2610
 
        So for now we just don't memoise it.
2611
 
        # RBC 20060304 review this decision.
2612
 
        """
2613
 
        bound_loc = self.get_bound_location()
2614
 
        if not bound_loc:
2615
 
            return None
2616
 
        try:
2617
 
            return Branch.open(bound_loc,
2618
 
                               possible_transports=possible_transports)
2619
 
        except (errors.NotBranchError, errors.ConnectionError), e:
2620
 
            raise errors.BoundBranchConnectionFailure(
2621
 
                    self, bound_loc, e)
2622
 
 
2623
2543
    @needs_write_lock
2624
 
    def set_bound_location(self, location):
2625
 
        """Set the target where this branch is bound to.
2626
 
 
2627
 
        :param location: URL to the target branch
2628
 
        """
2629
 
        if location:
2630
 
            self._transport.put_bytes('bound', location+'\n',
2631
 
                mode=self.bzrdir._get_file_mode())
2632
 
        else:
2633
 
            try:
2634
 
                self._transport.delete('bound')
2635
 
            except errors.NoSuchFile:
2636
 
                return False
2637
 
            return True
 
2544
    def unbind(self):
 
2545
        """If bound, unbind"""
 
2546
        return self.set_bound_location(None)
2638
2547
 
2639
2548
    @needs_write_lock
2640
2549
    def bind(self, other):
2662
2571
        # history around
2663
2572
        self.set_bound_location(other.base)
2664
2573
 
 
2574
    def get_bound_location(self):
 
2575
        try:
 
2576
            return self._transport.get_bytes('bound')[:-1]
 
2577
        except errors.NoSuchFile:
 
2578
            return None
 
2579
 
 
2580
    @needs_read_lock
 
2581
    def get_master_branch(self, possible_transports=None):
 
2582
        """Return the branch we are bound to.
 
2583
 
 
2584
        :return: Either a Branch, or None
 
2585
        """
 
2586
        if self._master_branch_cache is None:
 
2587
            self._master_branch_cache = self._get_master_branch(
 
2588
                possible_transports)
 
2589
        return self._master_branch_cache
 
2590
 
 
2591
    def _get_master_branch(self, possible_transports):
 
2592
        bound_loc = self.get_bound_location()
 
2593
        if not bound_loc:
 
2594
            return None
 
2595
        try:
 
2596
            return Branch.open(bound_loc,
 
2597
                               possible_transports=possible_transports)
 
2598
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2599
            raise errors.BoundBranchConnectionFailure(
 
2600
                    self, bound_loc, e)
 
2601
 
2665
2602
    @needs_write_lock
2666
 
    def unbind(self):
2667
 
        """If bound, unbind"""
2668
 
        return self.set_bound_location(None)
 
2603
    def set_bound_location(self, location):
 
2604
        """Set the target where this branch is bound to.
 
2605
 
 
2606
        :param location: URL to the target branch
 
2607
        """
 
2608
        self._master_branch_cache = None
 
2609
        if location:
 
2610
            self._transport.put_bytes('bound', location+'\n',
 
2611
                mode=self.bzrdir._get_file_mode())
 
2612
        else:
 
2613
            try:
 
2614
                self._transport.delete('bound')
 
2615
            except errors.NoSuchFile:
 
2616
                return False
 
2617
            return True
2669
2618
 
2670
2619
    @needs_write_lock
2671
2620
    def update(self, possible_transports=None):
2684
2633
            return old_tip
2685
2634
        return None
2686
2635
 
2687
 
 
2688
 
class BzrBranch8(BzrBranch5):
 
2636
    def _read_last_revision_info(self):
 
2637
        revision_string = self._transport.get_bytes('last-revision')
 
2638
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2639
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2640
        revno = int(revno)
 
2641
        return revno, revision_id
 
2642
 
 
2643
    def _write_last_revision_info(self, revno, revision_id):
 
2644
        """Simply write out the revision id, with no checks.
 
2645
 
 
2646
        Use set_last_revision_info to perform this safely.
 
2647
 
 
2648
        Does not update the revision_history cache.
 
2649
        """
 
2650
        revision_id = _mod_revision.ensure_null(revision_id)
 
2651
        out_string = '%d %s\n' % (revno, revision_id)
 
2652
        self._transport.put_bytes('last-revision', out_string,
 
2653
            mode=self.bzrdir._get_file_mode())
 
2654
 
 
2655
 
 
2656
class FullHistoryBzrBranch(BzrBranch):
 
2657
    """Bzr branch which contains the full revision history."""
 
2658
 
 
2659
    @needs_write_lock
 
2660
    def set_last_revision_info(self, revno, revision_id):
 
2661
        if not revision_id or not isinstance(revision_id, basestring):
 
2662
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2663
        revision_id = _mod_revision.ensure_null(revision_id)
 
2664
        # this old format stores the full history, but this api doesn't
 
2665
        # provide it, so we must generate, and might as well check it's
 
2666
        # correct
 
2667
        history = self._lefthand_history(revision_id)
 
2668
        if len(history) != revno:
 
2669
            raise AssertionError('%d != %d' % (len(history), revno))
 
2670
        self._set_revision_history(history)
 
2671
 
 
2672
    def _read_last_revision_info(self):
 
2673
        rh = self.revision_history()
 
2674
        revno = len(rh)
 
2675
        if revno:
 
2676
            return (revno, rh[-1])
 
2677
        else:
 
2678
            return (0, _mod_revision.NULL_REVISION)
 
2679
 
 
2680
    @deprecated_method(deprecated_in((2, 4, 0)))
 
2681
    @needs_write_lock
 
2682
    def set_revision_history(self, rev_history):
 
2683
        """See Branch.set_revision_history."""
 
2684
        self._set_revision_history(rev_history)
 
2685
 
 
2686
    def _set_revision_history(self, rev_history):
 
2687
        if 'evil' in debug.debug_flags:
 
2688
            mutter_callsite(3, "set_revision_history scales with history.")
 
2689
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2690
        for rev_id in rev_history:
 
2691
            check_not_reserved_id(rev_id)
 
2692
        if Branch.hooks['post_change_branch_tip']:
 
2693
            # Don't calculate the last_revision_info() if there are no hooks
 
2694
            # that will use it.
 
2695
            old_revno, old_revid = self.last_revision_info()
 
2696
        if len(rev_history) == 0:
 
2697
            revid = _mod_revision.NULL_REVISION
 
2698
        else:
 
2699
            revid = rev_history[-1]
 
2700
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2701
        self._write_revision_history(rev_history)
 
2702
        self._clear_cached_state()
 
2703
        self._cache_revision_history(rev_history)
 
2704
        for hook in Branch.hooks['set_rh']:
 
2705
            hook(self, rev_history)
 
2706
        if Branch.hooks['post_change_branch_tip']:
 
2707
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2708
 
 
2709
    def _write_revision_history(self, history):
 
2710
        """Factored out of set_revision_history.
 
2711
 
 
2712
        This performs the actual writing to disk.
 
2713
        It is intended to be called by set_revision_history."""
 
2714
        self._transport.put_bytes(
 
2715
            'revision-history', '\n'.join(history),
 
2716
            mode=self.bzrdir._get_file_mode())
 
2717
 
 
2718
    def _gen_revision_history(self):
 
2719
        history = self._transport.get_bytes('revision-history').split('\n')
 
2720
        if history[-1:] == ['']:
 
2721
            # There shouldn't be a trailing newline, but just in case.
 
2722
            history.pop()
 
2723
        return history
 
2724
 
 
2725
    def _synchronize_history(self, destination, revision_id):
 
2726
        if not isinstance(destination, FullHistoryBzrBranch):
 
2727
            super(BzrBranch, self)._synchronize_history(
 
2728
                destination, revision_id)
 
2729
            return
 
2730
        if revision_id == _mod_revision.NULL_REVISION:
 
2731
            new_history = []
 
2732
        else:
 
2733
            new_history = self.revision_history()
 
2734
        if revision_id is not None and new_history != []:
 
2735
            try:
 
2736
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2737
            except ValueError:
 
2738
                rev = self.repository.get_revision(revision_id)
 
2739
                new_history = rev.get_history(self.repository)[1:]
 
2740
        destination._set_revision_history(new_history)
 
2741
 
 
2742
    @needs_write_lock
 
2743
    def generate_revision_history(self, revision_id, last_rev=None,
 
2744
        other_branch=None):
 
2745
        """Create a new revision history that will finish with revision_id.
 
2746
 
 
2747
        :param revision_id: the new tip to use.
 
2748
        :param last_rev: The previous last_revision. If not None, then this
 
2749
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2750
        :param other_branch: The other branch that DivergedBranches should
 
2751
            raise with respect to.
 
2752
        """
 
2753
        self._set_revision_history(self._lefthand_history(revision_id,
 
2754
            last_rev, other_branch))
 
2755
 
 
2756
 
 
2757
class BzrBranch5(FullHistoryBzrBranch):
 
2758
    """A format 5 branch. This supports new features over plain branches.
 
2759
 
 
2760
    It has support for a master_branch which is the data for bound branches.
 
2761
    """
 
2762
 
 
2763
 
 
2764
class BzrBranch8(BzrBranch):
2689
2765
    """A branch that stores tree-reference locations."""
2690
2766
 
2691
2767
    def _open_hook(self):
2717
2793
        self._last_revision_info_cache = None
2718
2794
        self._reference_info = None
2719
2795
 
2720
 
    def _last_revision_info(self):
2721
 
        revision_string = self._transport.get_bytes('last-revision')
2722
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2723
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2724
 
        revno = int(revno)
2725
 
        return revno, revision_id
2726
 
 
2727
 
    def _write_last_revision_info(self, revno, revision_id):
2728
 
        """Simply write out the revision id, with no checks.
2729
 
 
2730
 
        Use set_last_revision_info to perform this safely.
2731
 
 
2732
 
        Does not update the revision_history cache.
2733
 
        Intended to be called by set_last_revision_info and
2734
 
        _write_revision_history.
2735
 
        """
2736
 
        revision_id = _mod_revision.ensure_null(revision_id)
2737
 
        out_string = '%d %s\n' % (revno, revision_id)
2738
 
        self._transport.put_bytes('last-revision', out_string,
2739
 
            mode=self.bzrdir._get_file_mode())
2740
 
 
2741
 
    @needs_write_lock
2742
 
    def set_last_revision_info(self, revno, revision_id):
2743
 
        revision_id = _mod_revision.ensure_null(revision_id)
2744
 
        old_revno, old_revid = self.last_revision_info()
2745
 
        if self._get_append_revisions_only():
2746
 
            self._check_history_violation(revision_id)
2747
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2748
 
        self._write_last_revision_info(revno, revision_id)
2749
 
        self._clear_cached_state()
2750
 
        self._last_revision_info_cache = revno, revision_id
2751
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2752
 
 
2753
 
    def _synchronize_history(self, destination, revision_id):
2754
 
        """Synchronize last revision and revision history between branches.
2755
 
 
2756
 
        :see: Branch._synchronize_history
2757
 
        """
2758
 
        # XXX: The base Branch has a fast implementation of this method based
2759
 
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2760
 
        # that uses set_revision_history.  This class inherits from BzrBranch5,
2761
 
        # but wants the fast implementation, so it calls
2762
 
        # Branch._synchronize_history directly.
2763
 
        Branch._synchronize_history(self, destination, revision_id)
2764
 
 
2765
2796
    def _check_history_violation(self, revision_id):
2766
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
 
2797
        current_revid = self.last_revision()
 
2798
        last_revision = _mod_revision.ensure_null(current_revid)
2767
2799
        if _mod_revision.is_null(last_revision):
2768
2800
            return
2769
 
        if last_revision not in self._lefthand_history(revision_id):
2770
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2801
        graph = self.repository.get_graph()
 
2802
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
 
2803
            if lh_ancestor == current_revid:
 
2804
                return
 
2805
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
2771
2806
 
2772
2807
    def _gen_revision_history(self):
2773
2808
        """Generate the revision history from last revision
2776
2811
        self._extend_partial_history(stop_index=last_revno-1)
2777
2812
        return list(reversed(self._partial_revision_history_cache))
2778
2813
 
2779
 
    def _write_revision_history(self, history):
2780
 
        """Factored out of set_revision_history.
2781
 
 
2782
 
        This performs the actual writing to disk, with format-specific checks.
2783
 
        It is intended to be called by BzrBranch5.set_revision_history.
2784
 
        """
2785
 
        if len(history) == 0:
2786
 
            last_revision = 'null:'
2787
 
        else:
2788
 
            if history != self._lefthand_history(history[-1]):
2789
 
                raise errors.NotLefthandHistory(history)
2790
 
            last_revision = history[-1]
2791
 
        if self._get_append_revisions_only():
2792
 
            self._check_history_violation(last_revision)
2793
 
        self._write_last_revision_info(len(history), last_revision)
2794
 
 
2795
2814
    @needs_write_lock
2796
2815
    def _set_parent_location(self, url):
2797
2816
        """Set the parent branch"""
2883
2902
 
2884
2903
    def set_bound_location(self, location):
2885
2904
        """See Branch.set_push_location."""
 
2905
        self._master_branch_cache = None
2886
2906
        result = None
2887
2907
        config = self.get_config()
2888
2908
        if location is None:
2928
2948
        return self.get_config(
2929
2949
            ).get_user_option_as_bool('append_revisions_only')
2930
2950
 
2931
 
    @needs_write_lock
2932
 
    def generate_revision_history(self, revision_id, last_rev=None,
2933
 
                                  other_branch=None):
2934
 
        """See BzrBranch5.generate_revision_history"""
2935
 
        history = self._lefthand_history(revision_id, last_rev, other_branch)
2936
 
        revno = len(history)
2937
 
        self.set_last_revision_info(revno, revision_id)
2938
 
 
2939
2951
    @needs_read_lock
2940
2952
    def get_rev_id(self, revno, history=None):
2941
2953
        """Find the revision id of the specified revno."""
2965
2977
        try:
2966
2978
            index = self._partial_revision_history_cache.index(revision_id)
2967
2979
        except ValueError:
2968
 
            self._extend_partial_history(stop_revision=revision_id)
 
2980
            try:
 
2981
                self._extend_partial_history(stop_revision=revision_id)
 
2982
            except errors.RevisionNotPresent, e:
 
2983
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2969
2984
            index = len(self._partial_revision_history_cache) - 1
2970
2985
            if self._partial_revision_history_cache[index] != revision_id:
2971
2986
                raise errors.NoSuchRevision(self, revision_id)
3026
3041
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3027
3042
    """
3028
3043
 
 
3044
    @deprecated_method(deprecated_in((2, 3, 0)))
3029
3045
    def __int__(self):
3030
 
        # DEPRECATED: pull used to return the change in revno
 
3046
        """Return the relative change in revno.
 
3047
 
 
3048
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3049
        """
3031
3050
        return self.new_revno - self.old_revno
3032
3051
 
3033
3052
    def report(self, to_file):
3058
3077
        target, otherwise it will be None.
3059
3078
    """
3060
3079
 
 
3080
    @deprecated_method(deprecated_in((2, 3, 0)))
3061
3081
    def __int__(self):
3062
 
        # DEPRECATED: push used to return the change in revno
 
3082
        """Return the relative change in revno.
 
3083
 
 
3084
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3085
        """
3063
3086
        return self.new_revno - self.old_revno
3064
3087
 
3065
3088
    def report(self, to_file):
3188
3211
    _optimisers = []
3189
3212
    """The available optimised InterBranch types."""
3190
3213
 
3191
 
    @staticmethod
3192
 
    def _get_branch_formats_to_test():
3193
 
        """Return a tuple with the Branch formats to use when testing."""
3194
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
3214
    @classmethod
 
3215
    def _get_branch_formats_to_test(klass):
 
3216
        """Return an iterable of format tuples for testing.
 
3217
        
 
3218
        :return: An iterable of (from_format, to_format) to use when testing
 
3219
            this InterBranch class. Each InterBranch class should define this
 
3220
            method itself.
 
3221
        """
 
3222
        raise NotImplementedError(klass._get_branch_formats_to_test)
3195
3223
 
 
3224
    @needs_write_lock
3196
3225
    def pull(self, overwrite=False, stop_revision=None,
3197
3226
             possible_transports=None, local=False):
3198
3227
        """Mirror source into target branch.
3203
3232
        """
3204
3233
        raise NotImplementedError(self.pull)
3205
3234
 
3206
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3207
 
                         graph=None):
3208
 
        """Pull in new perfect-fit revisions.
3209
 
 
3210
 
        :param stop_revision: Updated until the given revision
3211
 
        :param overwrite: Always set the branch pointer, rather than checking
3212
 
            to see if it is a proper descendant.
3213
 
        :param graph: A Graph object that can be used to query history
3214
 
            information. This can be None.
3215
 
        :return: None
3216
 
        """
3217
 
        raise NotImplementedError(self.update_revisions)
3218
 
 
3219
 
    def push(self, overwrite=False, stop_revision=None,
 
3235
    @needs_write_lock
 
3236
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3220
3237
             _override_hook_source_branch=None):
3221
3238
        """Mirror the source branch into the target branch.
3222
3239
 
3224
3241
        """
3225
3242
        raise NotImplementedError(self.push)
3226
3243
 
 
3244
    @needs_write_lock
 
3245
    def copy_content_into(self, revision_id=None):
 
3246
        """Copy the content of source into target
 
3247
 
 
3248
        revision_id: if not None, the revision history in the new branch will
 
3249
                     be truncated to end with revision_id.
 
3250
        """
 
3251
        raise NotImplementedError(self.copy_content_into)
 
3252
 
 
3253
    @needs_write_lock
 
3254
    def fetch(self, stop_revision=None):
 
3255
        """Fetch revisions.
 
3256
 
 
3257
        :param stop_revision: Last revision to fetch
 
3258
        """
 
3259
        raise NotImplementedError(self.fetch)
 
3260
 
3227
3261
 
3228
3262
class GenericInterBranch(InterBranch):
3229
 
    """InterBranch implementation that uses public Branch functions.
3230
 
    """
3231
 
 
3232
 
    @staticmethod
3233
 
    def _get_branch_formats_to_test():
3234
 
        return BranchFormat._default_format, BranchFormat._default_format
3235
 
 
3236
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3237
 
        graph=None):
3238
 
        """See InterBranch.update_revisions()."""
 
3263
    """InterBranch implementation that uses public Branch functions."""
 
3264
 
 
3265
    @classmethod
 
3266
    def is_compatible(klass, source, target):
 
3267
        # GenericBranch uses the public API, so always compatible
 
3268
        return True
 
3269
 
 
3270
    @classmethod
 
3271
    def _get_branch_formats_to_test(klass):
 
3272
        return [(format_registry.get_default(), format_registry.get_default())]
 
3273
 
 
3274
    @classmethod
 
3275
    def unwrap_format(klass, format):
 
3276
        if isinstance(format, remote.RemoteBranchFormat):
 
3277
            format._ensure_real()
 
3278
            return format._custom_format
 
3279
        return format
 
3280
 
 
3281
    @needs_write_lock
 
3282
    def copy_content_into(self, revision_id=None):
 
3283
        """Copy the content of source into target
 
3284
 
 
3285
        revision_id: if not None, the revision history in the new branch will
 
3286
                     be truncated to end with revision_id.
 
3287
        """
 
3288
        self.source.update_references(self.target)
 
3289
        self.source._synchronize_history(self.target, revision_id)
 
3290
        try:
 
3291
            parent = self.source.get_parent()
 
3292
        except errors.InaccessibleParent, e:
 
3293
            mutter('parent was not accessible to copy: %s', e)
 
3294
        else:
 
3295
            if parent:
 
3296
                self.target.set_parent(parent)
 
3297
        if self.source._push_should_merge_tags():
 
3298
            self.source.tags.merge_to(self.target.tags)
 
3299
 
 
3300
    @needs_write_lock
 
3301
    def fetch(self, stop_revision=None):
 
3302
        if self.target.base == self.source.base:
 
3303
            return (0, [])
3239
3304
        self.source.lock_read()
3240
3305
        try:
3241
 
            other_revno, other_last_revision = self.source.last_revision_info()
3242
 
            stop_revno = None # unknown
3243
 
            if stop_revision is None:
3244
 
                stop_revision = other_last_revision
3245
 
                if _mod_revision.is_null(stop_revision):
3246
 
                    # if there are no commits, we're done.
3247
 
                    return
3248
 
                stop_revno = other_revno
3249
 
 
3250
 
            # what's the current last revision, before we fetch [and change it
3251
 
            # possibly]
3252
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3253
 
            # we fetch here so that we don't process data twice in the common
3254
 
            # case of having something to pull, and so that the check for
3255
 
            # already merged can operate on the just fetched graph, which will
3256
 
            # be cached in memory.
3257
 
            self.target.fetch(self.source, stop_revision)
3258
 
            # Check to see if one is an ancestor of the other
3259
 
            if not overwrite:
3260
 
                if graph is None:
3261
 
                    graph = self.target.repository.get_graph()
3262
 
                if self.target._check_if_descendant_or_diverged(
3263
 
                        stop_revision, last_rev, graph, self.source):
3264
 
                    # stop_revision is a descendant of last_rev, but we aren't
3265
 
                    # overwriting, so we're done.
3266
 
                    return
3267
 
            if stop_revno is None:
3268
 
                if graph is None:
3269
 
                    graph = self.target.repository.get_graph()
3270
 
                this_revno, this_last_revision = \
3271
 
                        self.target.last_revision_info()
3272
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3273
 
                                [(other_last_revision, other_revno),
3274
 
                                 (this_last_revision, this_revno)])
3275
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
 
3306
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3307
            fetch_spec_factory.source_branch = self.source
 
3308
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3309
            fetch_spec_factory.source_repo = self.source.repository
 
3310
            fetch_spec_factory.target_repo = self.target.repository
 
3311
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3312
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3313
            return self.target.repository.fetch(self.source.repository,
 
3314
                fetch_spec=fetch_spec)
3276
3315
        finally:
3277
3316
            self.source.unlock()
3278
3317
 
 
3318
    @needs_write_lock
 
3319
    def _update_revisions(self, stop_revision=None, overwrite=False,
 
3320
            graph=None):
 
3321
        other_revno, other_last_revision = self.source.last_revision_info()
 
3322
        stop_revno = None # unknown
 
3323
        if stop_revision is None:
 
3324
            stop_revision = other_last_revision
 
3325
            if _mod_revision.is_null(stop_revision):
 
3326
                # if there are no commits, we're done.
 
3327
                return
 
3328
            stop_revno = other_revno
 
3329
 
 
3330
        # what's the current last revision, before we fetch [and change it
 
3331
        # possibly]
 
3332
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3333
        # we fetch here so that we don't process data twice in the common
 
3334
        # case of having something to pull, and so that the check for
 
3335
        # already merged can operate on the just fetched graph, which will
 
3336
        # be cached in memory.
 
3337
        self.fetch(stop_revision=stop_revision)
 
3338
        # Check to see if one is an ancestor of the other
 
3339
        if not overwrite:
 
3340
            if graph is None:
 
3341
                graph = self.target.repository.get_graph()
 
3342
            if self.target._check_if_descendant_or_diverged(
 
3343
                    stop_revision, last_rev, graph, self.source):
 
3344
                # stop_revision is a descendant of last_rev, but we aren't
 
3345
                # overwriting, so we're done.
 
3346
                return
 
3347
        if stop_revno is None:
 
3348
            if graph is None:
 
3349
                graph = self.target.repository.get_graph()
 
3350
            this_revno, this_last_revision = \
 
3351
                    self.target.last_revision_info()
 
3352
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3353
                            [(other_last_revision, other_revno),
 
3354
                             (this_last_revision, this_revno)])
 
3355
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3356
 
 
3357
    @needs_write_lock
3279
3358
    def pull(self, overwrite=False, stop_revision=None,
 
3359
             possible_transports=None, run_hooks=True,
 
3360
             _override_hook_target=None, local=False):
 
3361
        """Pull from source into self, updating my master if any.
 
3362
 
 
3363
        :param run_hooks: Private parameter - if false, this branch
 
3364
            is being called because it's the master of the primary branch,
 
3365
            so it should not run its hooks.
 
3366
        """
 
3367
        bound_location = self.target.get_bound_location()
 
3368
        if local and not bound_location:
 
3369
            raise errors.LocalRequiresBoundBranch()
 
3370
        master_branch = None
 
3371
        source_is_master = (self.source.user_url == bound_location)
 
3372
        if not local and bound_location and not source_is_master:
 
3373
            # not pulling from master, so we need to update master.
 
3374
            master_branch = self.target.get_master_branch(possible_transports)
 
3375
            master_branch.lock_write()
 
3376
        try:
 
3377
            if master_branch:
 
3378
                # pull from source into master.
 
3379
                master_branch.pull(self.source, overwrite, stop_revision,
 
3380
                    run_hooks=False)
 
3381
            return self._pull(overwrite,
 
3382
                stop_revision, _hook_master=master_branch,
 
3383
                run_hooks=run_hooks,
 
3384
                _override_hook_target=_override_hook_target,
 
3385
                merge_tags_to_master=not source_is_master)
 
3386
        finally:
 
3387
            if master_branch:
 
3388
                master_branch.unlock()
 
3389
 
 
3390
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
3391
             _override_hook_source_branch=None):
 
3392
        """See InterBranch.push.
 
3393
 
 
3394
        This is the basic concrete implementation of push()
 
3395
 
 
3396
        :param _override_hook_source_branch: If specified, run the hooks
 
3397
            passing this Branch as the source, rather than self.  This is for
 
3398
            use of RemoteBranch, where push is delegated to the underlying
 
3399
            vfs-based Branch.
 
3400
        """
 
3401
        if lossy:
 
3402
            raise errors.LossyPushToSameVCS(self.source, self.target)
 
3403
        # TODO: Public option to disable running hooks - should be trivial but
 
3404
        # needs tests.
 
3405
        self.source.lock_read()
 
3406
        try:
 
3407
            return _run_with_write_locked_target(
 
3408
                self.target, self._push_with_bound_branches, overwrite,
 
3409
                stop_revision, 
 
3410
                _override_hook_source_branch=_override_hook_source_branch)
 
3411
        finally:
 
3412
            self.source.unlock()
 
3413
 
 
3414
    def _basic_push(self, overwrite, stop_revision):
 
3415
        """Basic implementation of push without bound branches or hooks.
 
3416
 
 
3417
        Must be called with source read locked and target write locked.
 
3418
        """
 
3419
        result = BranchPushResult()
 
3420
        result.source_branch = self.source
 
3421
        result.target_branch = self.target
 
3422
        result.old_revno, result.old_revid = self.target.last_revision_info()
 
3423
        self.source.update_references(self.target)
 
3424
        if result.old_revid != stop_revision:
 
3425
            # We assume that during 'push' this repository is closer than
 
3426
            # the target.
 
3427
            graph = self.source.repository.get_graph(self.target.repository)
 
3428
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3429
                    graph=graph)
 
3430
        if self.source._push_should_merge_tags():
 
3431
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3432
                overwrite)
 
3433
        result.new_revno, result.new_revid = self.target.last_revision_info()
 
3434
        return result
 
3435
 
 
3436
    def _push_with_bound_branches(self, overwrite, stop_revision,
 
3437
            _override_hook_source_branch=None):
 
3438
        """Push from source into target, and into target's master if any.
 
3439
        """
 
3440
        def _run_hooks():
 
3441
            if _override_hook_source_branch:
 
3442
                result.source_branch = _override_hook_source_branch
 
3443
            for hook in Branch.hooks['post_push']:
 
3444
                hook(result)
 
3445
 
 
3446
        bound_location = self.target.get_bound_location()
 
3447
        if bound_location and self.target.base != bound_location:
 
3448
            # there is a master branch.
 
3449
            #
 
3450
            # XXX: Why the second check?  Is it even supported for a branch to
 
3451
            # be bound to itself? -- mbp 20070507
 
3452
            master_branch = self.target.get_master_branch()
 
3453
            master_branch.lock_write()
 
3454
            try:
 
3455
                # push into the master from the source branch.
 
3456
                master_inter = InterBranch.get(self.source, master_branch)
 
3457
                master_inter._basic_push(overwrite, stop_revision)
 
3458
                # and push into the target branch from the source. Note that
 
3459
                # we push from the source branch again, because it's considered
 
3460
                # the highest bandwidth repository.
 
3461
                result = self._basic_push(overwrite, stop_revision)
 
3462
                result.master_branch = master_branch
 
3463
                result.local_branch = self.target
 
3464
                _run_hooks()
 
3465
                return result
 
3466
            finally:
 
3467
                master_branch.unlock()
 
3468
        else:
 
3469
            # no master branch
 
3470
            result = self._basic_push(overwrite, stop_revision)
 
3471
            # TODO: Why set master_branch and local_branch if there's no
 
3472
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3473
            # 20070504
 
3474
            result.master_branch = self.target
 
3475
            result.local_branch = None
 
3476
            _run_hooks()
 
3477
            return result
 
3478
 
 
3479
    def _pull(self, overwrite=False, stop_revision=None,
3280
3480
             possible_transports=None, _hook_master=None, run_hooks=True,
3281
 
             _override_hook_target=None, local=False):
 
3481
             _override_hook_target=None, local=False,
 
3482
             merge_tags_to_master=True):
3282
3483
        """See Branch.pull.
3283
3484
 
 
3485
        This function is the core worker, used by GenericInterBranch.pull to
 
3486
        avoid duplication when pulling source->master and source->local.
 
3487
 
3284
3488
        :param _hook_master: Private parameter - set the branch to
3285
3489
            be supplied as the master to pull hooks.
3286
3490
        :param run_hooks: Private parameter - if false, this branch
3287
3491
            is being called because it's the master of the primary branch,
3288
3492
            so it should not run its hooks.
 
3493
            is being called because it's the master of the primary branch,
 
3494
            so it should not run its hooks.
3289
3495
        :param _override_hook_target: Private parameter - set the branch to be
3290
3496
            supplied as the target_branch to pull hooks.
3291
3497
        :param local: Only update the local branch, and not the bound branch.
3310
3516
            # -- JRV20090506
3311
3517
            result.old_revno, result.old_revid = \
3312
3518
                self.target.last_revision_info()
3313
 
            self.target.update_revisions(self.source, stop_revision,
3314
 
                overwrite=overwrite, graph=graph)
 
3519
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3520
                graph=graph)
3315
3521
            # TODO: The old revid should be specified when merging tags, 
3316
3522
            # so a tags implementation that versions tags can only 
3317
3523
            # pull in the most recent changes. -- JRV20090506
3318
3524
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3319
 
                overwrite)
 
3525
                overwrite, ignore_master=not merge_tags_to_master)
3320
3526
            result.new_revno, result.new_revid = self.target.last_revision_info()
3321
3527
            if _hook_master:
3322
3528
                result.master_branch = _hook_master
3331
3537
            self.source.unlock()
3332
3538
        return result
3333
3539
 
3334
 
    def push(self, overwrite=False, stop_revision=None,
3335
 
             _override_hook_source_branch=None):
3336
 
        """See InterBranch.push.
3337
 
 
3338
 
        This is the basic concrete implementation of push()
3339
 
 
3340
 
        :param _override_hook_source_branch: If specified, run
3341
 
        the hooks passing this Branch as the source, rather than self.
3342
 
        This is for use of RemoteBranch, where push is delegated to the
3343
 
        underlying vfs-based Branch.
3344
 
        """
3345
 
        # TODO: Public option to disable running hooks - should be trivial but
3346
 
        # needs tests.
3347
 
        self.source.lock_read()
3348
 
        try:
3349
 
            return _run_with_write_locked_target(
3350
 
                self.target, self._push_with_bound_branches, overwrite,
3351
 
                stop_revision,
3352
 
                _override_hook_source_branch=_override_hook_source_branch)
3353
 
        finally:
3354
 
            self.source.unlock()
3355
 
 
3356
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3357
 
            _override_hook_source_branch=None):
3358
 
        """Push from source into target, and into target's master if any.
3359
 
        """
3360
 
        def _run_hooks():
3361
 
            if _override_hook_source_branch:
3362
 
                result.source_branch = _override_hook_source_branch
3363
 
            for hook in Branch.hooks['post_push']:
3364
 
                hook(result)
3365
 
 
3366
 
        bound_location = self.target.get_bound_location()
3367
 
        if bound_location and self.target.base != bound_location:
3368
 
            # there is a master branch.
3369
 
            #
3370
 
            # XXX: Why the second check?  Is it even supported for a branch to
3371
 
            # be bound to itself? -- mbp 20070507
3372
 
            master_branch = self.target.get_master_branch()
3373
 
            master_branch.lock_write()
3374
 
            try:
3375
 
                # push into the master from the source branch.
3376
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3377
 
                # and push into the target branch from the source. Note that we
3378
 
                # push from the source branch again, because its considered the
3379
 
                # highest bandwidth repository.
3380
 
                result = self.source._basic_push(self.target, overwrite,
3381
 
                    stop_revision)
3382
 
                result.master_branch = master_branch
3383
 
                result.local_branch = self.target
3384
 
                _run_hooks()
3385
 
                return result
3386
 
            finally:
3387
 
                master_branch.unlock()
3388
 
        else:
3389
 
            # no master branch
3390
 
            result = self.source._basic_push(self.target, overwrite,
3391
 
                stop_revision)
3392
 
            # TODO: Why set master_branch and local_branch if there's no
3393
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3394
 
            # 20070504
3395
 
            result.master_branch = self.target
3396
 
            result.local_branch = None
3397
 
            _run_hooks()
3398
 
            return result
3399
 
 
3400
 
    @classmethod
3401
 
    def is_compatible(self, source, target):
3402
 
        # GenericBranch uses the public API, so always compatible
3403
 
        return True
3404
 
 
3405
 
 
3406
 
class InterToBranch5(GenericInterBranch):
3407
 
 
3408
 
    @staticmethod
3409
 
    def _get_branch_formats_to_test():
3410
 
        return BranchFormat._default_format, BzrBranchFormat5()
3411
 
 
3412
 
    def pull(self, overwrite=False, stop_revision=None,
3413
 
             possible_transports=None, run_hooks=True,
3414
 
             _override_hook_target=None, local=False):
3415
 
        """Pull from source into self, updating my master if any.
3416
 
 
3417
 
        :param run_hooks: Private parameter - if false, this branch
3418
 
            is being called because it's the master of the primary branch,
3419
 
            so it should not run its hooks.
3420
 
        """
3421
 
        bound_location = self.target.get_bound_location()
3422
 
        if local and not bound_location:
3423
 
            raise errors.LocalRequiresBoundBranch()
3424
 
        master_branch = None
3425
 
        if not local and bound_location and self.source.user_url != bound_location:
3426
 
            # not pulling from master, so we need to update master.
3427
 
            master_branch = self.target.get_master_branch(possible_transports)
3428
 
            master_branch.lock_write()
3429
 
        try:
3430
 
            if master_branch:
3431
 
                # pull from source into master.
3432
 
                master_branch.pull(self.source, overwrite, stop_revision,
3433
 
                    run_hooks=False)
3434
 
            return super(InterToBranch5, self).pull(overwrite,
3435
 
                stop_revision, _hook_master=master_branch,
3436
 
                run_hooks=run_hooks,
3437
 
                _override_hook_target=_override_hook_target)
3438
 
        finally:
3439
 
            if master_branch:
3440
 
                master_branch.unlock()
3441
 
 
3442
3540
 
3443
3541
InterBranch.register_optimiser(GenericInterBranch)
3444
 
InterBranch.register_optimiser(InterToBranch5)