/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Andrew Bennetts
  • Date: 2011-05-18 16:42:48 UTC
  • mto: This revision was merged to the branch mainline in revision 5895.
  • Revision ID: andrew.bennetts@canonical.com-20110518164248-o84lxxjpbn1ib6zv
Fix a bunch of docstring formatting nits, making pydoctor a bit happier.

Show diffs side-by-side

added added

removed removed

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