~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Jelmer Vernooij
  • Date: 2011-06-16 11:58:04 UTC
  • mto: This revision was merged to the branch mainline in revision 5987.
  • Revision ID: jelmer@samba.org-20110616115804-7tnqon61emrbdoxm
RemoveĀ unusedĀ Tree._get_ancestors.

Show diffs side-by-side

added added

removed removed

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