/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: John Arbash Meinel
  • Date: 2011-05-25 13:44:28 UTC
  • mto: This revision was merged to the branch mainline in revision 5913.
  • Revision ID: john@arbash-meinel.com-20110525134428-pgce0hkk91qhjyyc
Fix a test that was failing on win32.

You can't open() a file that is exclusive locked.
So just read it from the raw file.

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):
413
454
            after. If None, the rest of history is included.
414
455
        :param stop_rule: if stop_revision_id is not None, the precise rule
415
456
            to use for termination:
 
457
 
416
458
            * 'exclude' - leave the stop revision out of the result (default)
417
459
            * 'include' - the stop revision is the last item in the result
418
460
            * 'with-merges' - include the stop revision and all of its
420
462
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
463
              that are in both ancestries
422
464
        :param direction: either 'reverse' or 'forward':
 
465
 
423
466
            * reverse means return the start_revision_id first, i.e.
424
467
              start at the most recent revision and go backwards in history
425
468
            * forward returns tuples in the opposite order to reverse.
626
669
        raise errors.UnsupportedOperation(self.get_reference_info, self)
627
670
 
628
671
    @needs_write_lock
629
 
    def fetch(self, from_branch, last_revision=None, pb=None):
 
672
    def fetch(self, from_branch, last_revision=None, limit=None):
630
673
        """Copy revisions from from_branch into this branch.
631
674
 
632
675
        :param from_branch: Where to copy from.
633
676
        :param last_revision: What revision to stop at (None for at the end
634
677
                              of the branch.
635
 
        :param pb: An optional progress bar to use.
 
678
        :param limit: Optional rough limit of revisions to fetch
636
679
        :return: None
637
680
        """
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()
 
681
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
654
682
 
655
683
    def get_bound_location(self):
656
684
        """Return the URL of the branch we are bound to.
667
695
 
668
696
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
697
                           timezone=None, committer=None, revprops=None,
670
 
                           revision_id=None):
 
698
                           revision_id=None, lossy=False):
671
699
        """Obtain a CommitBuilder for this branch.
672
700
 
673
701
        :param parents: Revision ids of the parents of the new revision.
677
705
        :param committer: Optional committer to set for commit.
678
706
        :param revprops: Optional dictionary of revision properties.
679
707
        :param revision_id: Optional revision id.
 
708
        :param lossy: Whether to discard data that can not be natively
 
709
            represented, when pushing to a foreign VCS 
680
710
        """
681
711
 
682
712
        if config is None:
683
713
            config = self.get_config()
684
714
 
685
715
        return self.repository.get_commit_builder(self, parents, config,
686
 
            timestamp, timezone, committer, revprops, revision_id)
 
716
            timestamp, timezone, committer, revprops, revision_id,
 
717
            lossy)
687
718
 
688
719
    def get_master_branch(self, possible_transports=None):
689
720
        """Return the branch we are bound to.
716
747
        """Print `file` to stdout."""
717
748
        raise NotImplementedError(self.print_file)
718
749
 
 
750
    @deprecated_method(deprecated_in((2, 4, 0)))
719
751
    def set_revision_history(self, rev_history):
720
 
        raise NotImplementedError(self.set_revision_history)
 
752
        """See Branch.set_revision_history."""
 
753
        self._set_revision_history(rev_history)
 
754
 
 
755
    @needs_write_lock
 
756
    def _set_revision_history(self, rev_history):
 
757
        if len(rev_history) == 0:
 
758
            revid = _mod_revision.NULL_REVISION
 
759
        else:
 
760
            revid = rev_history[-1]
 
761
        if rev_history != self._lefthand_history(revid):
 
762
            raise errors.NotLefthandHistory(rev_history)
 
763
        self.set_last_revision_info(len(rev_history), revid)
 
764
        self._cache_revision_history(rev_history)
 
765
        for hook in Branch.hooks['set_rh']:
 
766
            hook(self, rev_history)
 
767
 
 
768
    @needs_write_lock
 
769
    def set_last_revision_info(self, revno, revision_id):
 
770
        """Set the last revision of this branch.
 
771
 
 
772
        The caller is responsible for checking that the revno is correct
 
773
        for this revision id.
 
774
 
 
775
        It may be possible to set the branch last revision to an id not
 
776
        present in the repository.  However, branches can also be
 
777
        configured to check constraints on history, in which case this may not
 
778
        be permitted.
 
779
        """
 
780
        raise NotImplementedError(self.set_last_revision_info)
 
781
 
 
782
    @needs_write_lock
 
783
    def generate_revision_history(self, revision_id, last_rev=None,
 
784
                                  other_branch=None):
 
785
        """See Branch.generate_revision_history"""
 
786
        graph = self.repository.get_graph()
 
787
        known_revision_ids = [
 
788
            self.last_revision_info(),
 
789
            (_mod_revision.NULL_REVISION, 0),
 
790
            ]
 
791
        if last_rev is not None:
 
792
            if not graph.is_ancestor(last_rev, revision_id):
 
793
                # our previous tip is not merged into stop_revision
 
794
                raise errors.DivergedBranches(self, other_branch)
 
795
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
 
796
        self.set_last_revision_info(revno, revision_id)
721
797
 
722
798
    @needs_write_lock
723
799
    def set_parent(self, url):
767
843
 
768
844
    def _unstack(self):
769
845
        """Change a branch to be unstacked, copying data as needed.
770
 
        
 
846
 
771
847
        Don't call this directly, use set_stacked_on_url(None).
772
848
        """
773
849
        pb = ui.ui_factory.nested_progress_bar()
782
858
            old_repository = self.repository
783
859
            if len(old_repository._fallback_repositories) != 1:
784
860
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
 
861
                    "of %r (fallbacks: %r)" % (old_repository,
 
862
                        old_repository._fallback_repositories))
 
863
            # Open the new repository object.
 
864
            # Repositories don't offer an interface to remove fallback
 
865
            # repositories today; take the conceptually simpler option and just
 
866
            # reopen it.  We reopen it starting from the URL so that we
 
867
            # get a separate connection for RemoteRepositories and can
 
868
            # stream from one of them to the other.  This does mean doing
 
869
            # separate SSH connection setup, but unstacking is not a
 
870
            # common operation so it's tolerable.
 
871
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
872
            new_repository = new_bzrdir.find_repository()
 
873
            if new_repository._fallback_repositories:
 
874
                raise AssertionError("didn't expect %r to have "
 
875
                    "fallback_repositories"
 
876
                    % (self.repository,))
 
877
            # Replace self.repository with the new repository.
 
878
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
879
            # lock count) of self.repository to the new repository.
 
880
            lock_token = old_repository.lock_write().repository_token
 
881
            self.repository = new_repository
 
882
            if isinstance(self, remote.RemoteBranch):
 
883
                # Remote branches can have a second reference to the old
 
884
                # repository that need to be replaced.
 
885
                if self._real_branch is not None:
 
886
                    self._real_branch.repository = new_repository
 
887
            self.repository.lock_write(token=lock_token)
 
888
            if lock_token is not None:
 
889
                old_repository.leave_lock_in_place()
787
890
            old_repository.unlock()
 
891
            if lock_token is not None:
 
892
                # XXX: self.repository.leave_lock_in_place() before this
 
893
                # function will not be preserved.  Fortunately that doesn't
 
894
                # affect the current default format (2a), and would be a
 
895
                # corner-case anyway.
 
896
                #  - Andrew Bennetts, 2010/06/30
 
897
                self.repository.dont_leave_lock_in_place()
 
898
            old_lock_count = 0
 
899
            while True:
 
900
                try:
 
901
                    old_repository.unlock()
 
902
                except errors.LockNotHeld:
 
903
                    break
 
904
                old_lock_count += 1
 
905
            if old_lock_count == 0:
 
906
                raise AssertionError(
 
907
                    'old_repository should have been locked at least once.')
 
908
            for i in range(old_lock_count-1):
 
909
                self.repository.lock_write()
 
910
            # Fetch from the old repository into the new.
788
911
            old_repository.lock_read()
789
912
            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
913
                # XXX: If you unstack a branch while it has a working tree
809
914
                # with a pending merge, the pending-merged revisions will no
810
915
                # 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)
 
916
                try:
 
917
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
918
                except errors.TagsNotSupported:
 
919
                    tags_to_fetch = set()
 
920
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
921
                    old_repository, required_ids=[self.last_revision()],
 
922
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
923
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
818
924
            finally:
819
925
                old_repository.unlock()
820
926
        finally:
825
931
 
826
932
        :seealso: Branch._get_tags_bytes.
827
933
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
934
        return _run_with_write_locked_target(self, self._set_tags_bytes_locked,
 
935
                bytes)
 
936
 
 
937
    def _set_tags_bytes_locked(self, bytes):
 
938
        self._tags_bytes = bytes
 
939
        return self._transport.put_bytes('tags', bytes)
830
940
 
831
941
    def _cache_revision_history(self, rev_history):
832
942
        """Set the cached revision history to rev_history.
859
969
        self._revision_history_cache = None
860
970
        self._revision_id_to_revno_cache = None
861
971
        self._last_revision_info_cache = None
 
972
        self._master_branch_cache = None
862
973
        self._merge_sorted_revisions_cache = None
863
974
        self._partial_revision_history_cache = []
864
975
        self._partial_revision_id_to_revno_cache = {}
 
976
        self._tags_bytes = None
865
977
 
866
978
    def _gen_revision_history(self):
867
979
        """Return sequence of revision hashes on to this branch.
917
1029
        :return: A tuple (revno, revision_id).
918
1030
        """
919
1031
        if self._last_revision_info_cache is None:
920
 
            self._last_revision_info_cache = self._last_revision_info()
 
1032
            self._last_revision_info_cache = self._read_last_revision_info()
921
1033
        return self._last_revision_info_cache
922
1034
 
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
 
 
 
1035
    def _read_last_revision_info(self):
 
1036
        raise NotImplementedError(self._read_last_revision_info)
 
1037
 
 
1038
    @deprecated_method(deprecated_in((2, 4, 0)))
970
1039
    def import_last_revision_info(self, source_repo, revno, revid):
971
1040
        """Set the last revision info, importing from another repo if necessary.
972
1041
 
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
1042
        :param source_repo: Source repository to optionally fetch from
977
1043
        :param revno: Revision number of the new tip
978
1044
        :param revid: Revision id of the new tip
981
1047
            self.repository.fetch(source_repo, revision_id=revid)
982
1048
        self.set_last_revision_info(revno, revid)
983
1049
 
 
1050
    def import_last_revision_info_and_tags(self, source, revno, revid,
 
1051
                                           lossy=False):
 
1052
        """Set the last revision info, importing from another repo if necessary.
 
1053
 
 
1054
        This is used by the bound branch code to upload a revision to
 
1055
        the master branch first before updating the tip of the local branch.
 
1056
        Revisions referenced by source's tags are also transferred.
 
1057
 
 
1058
        :param source: Source branch to optionally fetch from
 
1059
        :param revno: Revision number of the new tip
 
1060
        :param revid: Revision id of the new tip
 
1061
        :param lossy: Whether to discard metadata that can not be
 
1062
            natively represented
 
1063
        :return: Tuple with the new revision number and revision id
 
1064
            (should only be different from the arguments when lossy=True)
 
1065
        """
 
1066
        if not self.repository.has_same_location(source.repository):
 
1067
            self.fetch(source, revid)
 
1068
        self.set_last_revision_info(revno, revid)
 
1069
        return (revno, revid)
 
1070
 
984
1071
    def revision_id_to_revno(self, revision_id):
985
1072
        """Given a revision id, return its revno"""
986
1073
        if _mod_revision.is_null(revision_id):
1006
1093
            self._extend_partial_history(distance_from_last)
1007
1094
        return self._partial_revision_history_cache[distance_from_last]
1008
1095
 
1009
 
    @needs_write_lock
1010
1096
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1097
             possible_transports=None, *args, **kwargs):
1012
1098
        """Mirror source into this branch.
1019
1105
            stop_revision=stop_revision,
1020
1106
            possible_transports=possible_transports, *args, **kwargs)
1021
1107
 
1022
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
 
        **kwargs):
 
1108
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
 
1109
            *args, **kwargs):
1024
1110
        """Mirror this branch into target.
1025
1111
 
1026
1112
        This branch is considered to be 'local', having low latency.
1027
1113
        """
1028
1114
        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)
 
1115
            lossy, *args, **kwargs)
1051
1116
 
1052
1117
    def basis_tree(self):
1053
1118
        """Return `Tree` object for last revision."""
1208
1273
        return result
1209
1274
 
1210
1275
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1276
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1277
            repository=None):
1212
1278
        """Create a new line of development from the branch, into to_bzrdir.
1213
1279
 
1214
1280
        to_bzrdir controls the branch format.
1219
1285
        if (repository_policy is not None and
1220
1286
            repository_policy.requires_stacking()):
1221
1287
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
 
        result = to_bzrdir.create_branch()
 
1288
        result = to_bzrdir.create_branch(repository=repository)
1223
1289
        result.lock_write()
1224
1290
        try:
1225
1291
            if repository_policy is not None:
1226
1292
                repository_policy.configure_branch(result)
1227
1293
            self.copy_content_into(result, revision_id=revision_id)
1228
 
            result.set_parent(self.bzrdir.root_transport.base)
 
1294
            master_branch = self.get_master_branch()
 
1295
            if master_branch is None:
 
1296
                result.set_parent(self.bzrdir.root_transport.base)
 
1297
            else:
 
1298
                result.set_parent(master_branch.bzrdir.root_transport.base)
1229
1299
        finally:
1230
1300
            result.unlock()
1231
1301
        return result
1255
1325
                revno = 1
1256
1326
        destination.set_last_revision_info(revno, revision_id)
1257
1327
 
1258
 
    @needs_read_lock
1259
1328
    def copy_content_into(self, destination, revision_id=None):
1260
1329
        """Copy the content of self into destination.
1261
1330
 
1262
1331
        revision_id: if not None, the revision history in the new branch will
1263
1332
                     be truncated to end with revision_id.
1264
1333
        """
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)
 
1334
        return InterBranch.get(self, destination).copy_content_into(
 
1335
            revision_id=revision_id)
1276
1336
 
1277
1337
    def update_references(self, target):
1278
1338
        if not getattr(self._format, 'supports_reference_locations', False):
1323
1383
        """Return the most suitable metadir for a checkout of this branch.
1324
1384
        Weaves are used if this branch's repository uses weaves.
1325
1385
        """
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)
 
1386
        format = self.repository.bzrdir.checkout_metadir()
 
1387
        format.set_branch_format(self._format)
1333
1388
        return format
1334
1389
 
1335
1390
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1391
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1392
        no_tree=None):
1337
1393
        """Create a clone of this branch and its bzrdir.
1338
1394
 
1339
1395
        :param to_transport: The transport to clone onto.
1346
1402
        """
1347
1403
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1404
        # clone call. Or something. 20090224 RBC/spiv.
 
1405
        # XXX: Should this perhaps clone colocated branches as well, 
 
1406
        # rather than just the default branch? 20100319 JRV
1349
1407
        if revision_id is None:
1350
1408
            revision_id = self.last_revision()
1351
1409
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
1410
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1411
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1412
            no_tree=no_tree)
1354
1413
        return dir_to.open_branch()
1355
1414
 
1356
1415
    def create_checkout(self, to_location, revision_id=None,
1361
1420
        :param to_location: The url to produce the checkout at
1362
1421
        :param revision_id: The revision to check out
1363
1422
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1364
 
        produce a bound branch (heavyweight checkout)
 
1423
            produce a bound branch (heavyweight checkout)
1365
1424
        :param accelerator_tree: A tree which can be used for retrieving file
1366
1425
            contents more quickly than the revision tree, i.e. a workingtree.
1367
1426
            The revision tree will be used for cases where accelerator_tree's
1413
1472
 
1414
1473
    def reference_parent(self, file_id, path, possible_transports=None):
1415
1474
        """Return the parent branch for a tree-reference file_id
 
1475
 
1416
1476
        :param file_id: The file_id of the tree reference
1417
1477
        :param path: The path of the file_id in the tree
1418
1478
        :return: A branch associated with the file_id
1471
1531
        else:
1472
1532
            raise AssertionError("invalid heads: %r" % (heads,))
1473
1533
 
1474
 
 
1475
 
class BranchFormat(object):
 
1534
    def heads_to_fetch(self):
 
1535
        """Return the heads that must and that should be fetched to copy this
 
1536
        branch into another repo.
 
1537
 
 
1538
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1539
            set of heads that must be fetched.  if_present_fetch is a set of
 
1540
            heads that must be fetched if present, but no error is necessary if
 
1541
            they are not present.
 
1542
        """
 
1543
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
 
1544
        # are the tags.
 
1545
        must_fetch = set([self.last_revision()])
 
1546
        try:
 
1547
            if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1548
        except errors.TagsNotSupported:
 
1549
            if_present_fetch = set()
 
1550
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1551
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1552
        return must_fetch, if_present_fetch
 
1553
 
 
1554
 
 
1555
class BranchFormat(controldir.ControlComponentFormat):
1476
1556
    """An encapsulation of the initialization and open routines for a format.
1477
1557
 
1478
1558
    Formats provide three things:
1481
1561
     * an open routine.
1482
1562
 
1483
1563
    Formats are placed in an dict by their format string for reference
1484
 
    during branch opening. Its not required that these be instances, they
 
1564
    during branch opening. It's not required that these be instances, they
1485
1565
    can be classes themselves with class methods - it simply depends on
1486
1566
    whether state is needed for a given format or not.
1487
1567
 
1490
1570
    object will be created every time regardless.
1491
1571
    """
1492
1572
 
1493
 
    _default_format = None
1494
 
    """The default format used for new branches."""
1495
 
 
1496
 
    _formats = {}
1497
 
    """The known formats."""
1498
 
 
1499
1573
    can_set_append_revisions_only = True
1500
1574
 
1501
1575
    def __eq__(self, other):
1510
1584
        try:
1511
1585
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
1586
            format_string = transport.get_bytes("format")
1513
 
            return klass._formats[format_string]
 
1587
            return format_registry.get(format_string)
1514
1588
        except errors.NoSuchFile:
1515
1589
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1516
1590
        except KeyError:
1517
1591
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1592
 
1519
1593
    @classmethod
 
1594
    @deprecated_method(deprecated_in((2, 4, 0)))
1520
1595
    def get_default_format(klass):
1521
1596
        """Return the current default format."""
1522
 
        return klass._default_format
1523
 
 
1524
 
    def get_reference(self, a_bzrdir):
 
1597
        return format_registry.get_default()
 
1598
 
 
1599
    @classmethod
 
1600
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1601
    def get_formats(klass):
 
1602
        """Get all the known formats.
 
1603
 
 
1604
        Warning: This triggers a load of all lazy registered formats: do not
 
1605
        use except when that is desireed.
 
1606
        """
 
1607
        return format_registry._get_all()
 
1608
 
 
1609
    def get_reference(self, a_bzrdir, name=None):
1525
1610
        """Get the target reference of the branch in a_bzrdir.
1526
1611
 
1527
1612
        format probing must have been completed before calling
1529
1614
        in a_bzrdir is correct.
1530
1615
 
1531
1616
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1617
        :param name: Name of the colocated branch to fetch
1532
1618
        :return: None if the branch is not a reference branch.
1533
1619
        """
1534
1620
        return None
1535
1621
 
1536
1622
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
 
1623
    def set_reference(self, a_bzrdir, name, to_branch):
1538
1624
        """Set the target reference of the branch in a_bzrdir.
1539
1625
 
1540
1626
        format probing must have been completed before calling
1542
1628
        in a_bzrdir is correct.
1543
1629
 
1544
1630
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1631
        :param name: Name of colocated branch to set, None for default
1545
1632
        :param to_branch: branch that the checkout is to reference
1546
1633
        """
1547
1634
        raise NotImplementedError(self.set_reference)
1562
1649
        for hook in hooks:
1563
1650
            hook(params)
1564
1651
 
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):
 
1652
    def initialize(self, a_bzrdir, name=None, repository=None):
1611
1653
        """Create a branch of this format in a_bzrdir.
1612
1654
        
1613
1655
        :param name: Name of the colocated branch to create.
1647
1689
        """
1648
1690
        raise NotImplementedError(self.network_name)
1649
1691
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1692
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
1693
            found_repository=None):
1651
1694
        """Return the branch object for a_bzrdir
1652
1695
 
1653
1696
        :param a_bzrdir: A BzrDir that contains a branch.
1660
1703
        raise NotImplementedError(self.open)
1661
1704
 
1662
1705
    @classmethod
 
1706
    @deprecated_method(deprecated_in((2, 4, 0)))
1663
1707
    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__)
 
1708
        """Register a metadir format.
 
1709
 
 
1710
        See MetaDirBranchFormatFactory for the ability to register a format
 
1711
        without loading the code the format needs until it is actually used.
 
1712
        """
 
1713
        format_registry.register(format)
1669
1714
 
1670
1715
    @classmethod
 
1716
    @deprecated_method(deprecated_in((2, 4, 0)))
1671
1717
    def set_default_format(klass, format):
1672
 
        klass._default_format = format
 
1718
        format_registry.set_default(format)
1673
1719
 
1674
1720
    def supports_set_append_revisions_only(self):
1675
1721
        """True if this format supports set_append_revisions_only."""
1679
1725
        """True if this format records a stacked-on branch."""
1680
1726
        return False
1681
1727
 
 
1728
    def supports_leaving_lock(self):
 
1729
        """True if this format supports leaving locks in place."""
 
1730
        return False # by default
 
1731
 
1682
1732
    @classmethod
 
1733
    @deprecated_method(deprecated_in((2, 4, 0)))
1683
1734
    def unregister_format(klass, format):
1684
 
        del klass._formats[format.get_format_string()]
 
1735
        format_registry.remove(format)
1685
1736
 
1686
1737
    def __str__(self):
1687
1738
        return self.get_format_description().rstrip()
1691
1742
        return False  # by default
1692
1743
 
1693
1744
 
 
1745
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1746
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1747
    
 
1748
    While none of the built in BranchFormats are lazy registered yet,
 
1749
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1750
    use it, and the bzr-loom plugin uses it as well (see
 
1751
    bzrlib.plugins.loom.formats).
 
1752
    """
 
1753
 
 
1754
    def __init__(self, format_string, module_name, member_name):
 
1755
        """Create a MetaDirBranchFormatFactory.
 
1756
 
 
1757
        :param format_string: The format string the format has.
 
1758
        :param module_name: Module to load the format class from.
 
1759
        :param member_name: Attribute name within the module for the format class.
 
1760
        """
 
1761
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1762
        self._format_string = format_string
 
1763
        
 
1764
    def get_format_string(self):
 
1765
        """See BranchFormat.get_format_string."""
 
1766
        return self._format_string
 
1767
 
 
1768
    def __call__(self):
 
1769
        """Used for network_format_registry support."""
 
1770
        return self.get_obj()()
 
1771
 
 
1772
 
1694
1773
class BranchHooks(Hooks):
1695
1774
    """A dictionary mapping hook name to a list of callables for branch hooks.
1696
1775
 
1704
1783
        These are all empty initially, because by default nothing should get
1705
1784
        notified.
1706
1785
        """
1707
 
        Hooks.__init__(self)
1708
 
        self.create_hook(HookPoint('set_rh',
 
1786
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1787
        self.add_hook('set_rh',
1709
1788
            "Invoked whenever the revision history has been set via "
1710
1789
            "set_revision_history. The api signature is (branch, "
1711
1790
            "revision_history), and the branch will be write-locked. "
1712
1791
            "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',
 
1792
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
 
1793
        self.add_hook('open',
1715
1794
            "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',
 
1795
            "branch is opened.", (1, 8))
 
1796
        self.add_hook('post_push',
1718
1797
            "Called after a push operation completes. post_push is called "
1719
1798
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
 
            "bzr client.", (0, 15), None))
1721
 
        self.create_hook(HookPoint('post_pull',
 
1799
            "bzr client.", (0, 15))
 
1800
        self.add_hook('post_pull',
1722
1801
            "Called after a pull operation completes. post_pull is called "
1723
1802
            "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 "
 
1803
            "bzr client.", (0, 15))
 
1804
        self.add_hook('pre_commit',
 
1805
            "Called after a commit is calculated but before it is "
1727
1806
            "completed. pre_commit is called with (local, master, old_revno, "
1728
1807
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
1808
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1731
1810
            "basis revision. hooks MUST NOT modify this delta. "
1732
1811
            " future_tree is an in-memory tree obtained from "
1733
1812
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
 
            "tree.", (0,91), None))
1735
 
        self.create_hook(HookPoint('post_commit',
 
1813
            "tree.", (0,91))
 
1814
        self.add_hook('post_commit',
1736
1815
            "Called in the bzr client after a commit has completed. "
1737
1816
            "post_commit is called with (local, master, old_revno, old_revid, "
1738
1817
            "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',
 
1818
            "commit to a branch.", (0, 15))
 
1819
        self.add_hook('post_uncommit',
1741
1820
            "Called in the bzr client after an uncommit completes. "
1742
1821
            "post_uncommit is called with (local, master, old_revno, "
1743
1822
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
1823
            "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',
 
1824
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1825
        self.add_hook('pre_change_branch_tip',
1747
1826
            "Called in bzr client and server before a change to the tip of a "
1748
1827
            "branch is made. pre_change_branch_tip is called with a "
1749
1828
            "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',
 
1829
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1830
        self.add_hook('post_change_branch_tip',
1752
1831
            "Called in bzr client and server after a change to the tip of a "
1753
1832
            "branch is made. post_change_branch_tip is called with a "
1754
1833
            "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',
 
1834
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1835
        self.add_hook('transform_fallback_location',
1757
1836
            "Called when a stacked branch is activating its fallback "
1758
1837
            "locations. transform_fallback_location is called with (branch, "
1759
1838
            "url), and should return a new url. Returning the same url "
1764
1843
            "fallback locations have not been activated. When there are "
1765
1844
            "multiple hooks installed for transform_fallback_location, "
1766
1845
            "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."
 
1846
            "The order is however undefined.", (1, 9))
 
1847
        self.add_hook('automatic_tag_name',
 
1848
            "Called to determine an automatic tag name for a revision. "
1770
1849
            "automatic_tag_name is called with (branch, revision_id) and "
1771
1850
            "should return a tag name or None if no tag name could be "
1772
1851
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
 
1852
            (2, 2))
 
1853
        self.add_hook('post_branch_init',
1775
1854
            "Called after new branch initialization completes. "
1776
1855
            "post_branch_init is called with a "
1777
1856
            "bzrlib.branch.BranchInitHookParams. "
1778
1857
            "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',
 
1858
            "lightweight) will all trigger this hook.", (2, 2))
 
1859
        self.add_hook('post_switch',
1781
1860
            "Called after a checkout switches branch. "
1782
1861
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1862
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1784
1863
 
1785
1864
 
1786
1865
 
1789
1868
 
1790
1869
 
1791
1870
class ChangeBranchTipParams(object):
1792
 
    """Object holding parameters passed to *_change_branch_tip hooks.
 
1871
    """Object holding parameters passed to `*_change_branch_tip` hooks.
1793
1872
 
1794
1873
    There are 5 fields that hooks may wish to access:
1795
1874
 
1827
1906
 
1828
1907
 
1829
1908
class BranchInitHookParams(object):
1830
 
    """Object holding parameters passed to *_branch_init hooks.
 
1909
    """Object holding parameters passed to `*_branch_init` hooks.
1831
1910
 
1832
1911
    There are 4 fields that hooks may wish to access:
1833
1912
 
1863
1942
        return self.__dict__ == other.__dict__
1864
1943
 
1865
1944
    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)
 
1945
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1872
1946
 
1873
1947
 
1874
1948
class SwitchHookParams(object):
1875
 
    """Object holding parameters passed to *_switch hooks.
 
1949
    """Object holding parameters passed to `*_switch` hooks.
1876
1950
 
1877
1951
    There are 4 fields that hooks may wish to access:
1878
1952
 
1904
1978
            self.revision_id)
1905
1979
 
1906
1980
 
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
1981
class BranchFormatMetadir(BranchFormat):
1951
1982
    """Common logic for meta-dir based branch formats."""
1952
1983
 
1954
1985
        """What class to instantiate on open calls."""
1955
1986
        raise NotImplementedError(self._branch_class)
1956
1987
 
 
1988
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
1989
                           repository=None):
 
1990
        """Initialize a branch in a bzrdir, with specified files
 
1991
 
 
1992
        :param a_bzrdir: The bzrdir to initialize the branch in
 
1993
        :param utf8_files: The files to create as a list of
 
1994
            (filename, content) tuples
 
1995
        :param name: Name of colocated branch to create, if any
 
1996
        :return: a branch in this format
 
1997
        """
 
1998
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1999
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
2000
        control_files = lockable_files.LockableFiles(branch_transport,
 
2001
            'lock', lockdir.LockDir)
 
2002
        control_files.create_lock()
 
2003
        control_files.lock_write()
 
2004
        try:
 
2005
            utf8_files += [('format', self.get_format_string())]
 
2006
            for (filename, content) in utf8_files:
 
2007
                branch_transport.put_bytes(
 
2008
                    filename, content,
 
2009
                    mode=a_bzrdir._get_file_mode())
 
2010
        finally:
 
2011
            control_files.unlock()
 
2012
        branch = self.open(a_bzrdir, name, _found=True,
 
2013
                found_repository=repository)
 
2014
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2015
        return branch
 
2016
 
1957
2017
    def network_name(self):
1958
2018
        """A simple byte string uniquely identifying this format for RPC calls.
1959
2019
 
1961
2021
        """
1962
2022
        return self.get_format_string()
1963
2023
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2024
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2025
            found_repository=None):
1965
2026
        """See BranchFormat.open()."""
1966
2027
        if not _found:
1967
2028
            format = BranchFormat.find_format(a_bzrdir, name=name)
1972
2033
        try:
1973
2034
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
2035
                                                         lockdir.LockDir)
 
2036
            if found_repository is None:
 
2037
                found_repository = a_bzrdir.find_repository()
1975
2038
            return self._branch_class()(_format=self,
1976
2039
                              _control_files=control_files,
1977
2040
                              name=name,
1978
2041
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
 
2042
                              _repository=found_repository,
1980
2043
                              ignore_fallbacks=ignore_fallbacks)
1981
2044
        except errors.NoSuchFile:
1982
2045
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1989
2052
    def supports_tags(self):
1990
2053
        return True
1991
2054
 
 
2055
    def supports_leaving_lock(self):
 
2056
        return True
 
2057
 
1992
2058
 
1993
2059
class BzrBranchFormat5(BranchFormatMetadir):
1994
2060
    """Bzr branch format 5.
2014
2080
        """See BranchFormat.get_format_description()."""
2015
2081
        return "Branch format 5"
2016
2082
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
2083
    def initialize(self, a_bzrdir, name=None, repository=None):
2018
2084
        """Create a branch of this format in a_bzrdir."""
2019
2085
        utf8_files = [('revision-history', ''),
2020
2086
                      ('branch-name', ''),
2021
2087
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2088
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2023
2089
 
2024
2090
    def supports_tags(self):
2025
2091
        return False
2047
2113
        """See BranchFormat.get_format_description()."""
2048
2114
        return "Branch format 6"
2049
2115
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
2116
    def initialize(self, a_bzrdir, name=None, repository=None):
2051
2117
        """Create a branch of this format in a_bzrdir."""
2052
2118
        utf8_files = [('last-revision', '0 null:\n'),
2053
2119
                      ('branch.conf', ''),
2054
2120
                      ('tags', ''),
2055
2121
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2122
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2057
2123
 
2058
2124
    def make_tags(self, branch):
2059
2125
        """See bzrlib.branch.BranchFormat.make_tags()."""
2077
2143
        """See BranchFormat.get_format_description()."""
2078
2144
        return "Branch format 8"
2079
2145
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
2146
    def initialize(self, a_bzrdir, name=None, repository=None):
2081
2147
        """Create a branch of this format in a_bzrdir."""
2082
2148
        utf8_files = [('last-revision', '0 null:\n'),
2083
2149
                      ('branch.conf', ''),
2084
2150
                      ('tags', ''),
2085
2151
                      ('references', '')
2086
2152
                      ]
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()
 
2153
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2093
2154
 
2094
2155
    def make_tags(self, branch):
2095
2156
        """See bzrlib.branch.BranchFormat.make_tags()."""
2104
2165
    supports_reference_locations = True
2105
2166
 
2106
2167
 
2107
 
class BzrBranchFormat7(BzrBranchFormat8):
 
2168
class BzrBranchFormat7(BranchFormatMetadir):
2108
2169
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
2170
 
2110
2171
    The stacked location pointer is passed down to the repository and requires
2113
2174
    This format was introduced in bzr 1.6.
2114
2175
    """
2115
2176
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
2177
    def initialize(self, a_bzrdir, name=None, repository=None):
2117
2178
        """Create a branch of this format in a_bzrdir."""
2118
2179
        utf8_files = [('last-revision', '0 null:\n'),
2119
2180
                      ('branch.conf', ''),
2120
2181
                      ('tags', ''),
2121
2182
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2183
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2123
2184
 
2124
2185
    def _branch_class(self):
2125
2186
        return BzrBranch7
2135
2196
    def supports_set_append_revisions_only(self):
2136
2197
        return True
2137
2198
 
 
2199
    def supports_stacking(self):
 
2200
        return True
 
2201
 
 
2202
    def make_tags(self, branch):
 
2203
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2204
        return BasicTags(branch)
 
2205
 
2138
2206
    supports_reference_locations = False
2139
2207
 
2140
2208
 
2157
2225
        """See BranchFormat.get_format_description()."""
2158
2226
        return "Checkout reference format 1"
2159
2227
 
2160
 
    def get_reference(self, a_bzrdir):
 
2228
    def get_reference(self, a_bzrdir, name=None):
2161
2229
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2230
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2231
        return transport.get_bytes('location')
2164
2232
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2233
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2234
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2235
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2236
        location = transport.put_bytes('location', to_branch.base)
2169
2237
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2238
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2239
            repository=None):
2171
2240
        """Create a branch of this format in a_bzrdir."""
2172
2241
        if target_branch is None:
2173
2242
            # this format does not implement branch itself, thus the implicit
2201
2270
        return clone
2202
2271
 
2203
2272
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
2273
             possible_transports=None, ignore_fallbacks=False,
 
2274
             found_repository=None):
2205
2275
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2276
 
2207
2277
        :param a_bzrdir: A BzrDir that contains a branch.
2221
2291
                raise AssertionError("wrong format %r found for %r" %
2222
2292
                    (format, self))
2223
2293
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
 
2294
            location = self.get_reference(a_bzrdir, name)
2225
2295
        real_bzrdir = bzrdir.BzrDir.open(
2226
2296
            location, possible_transports=possible_transports)
2227
2297
        result = real_bzrdir.open_branch(name=name, 
2238
2308
        return result
2239
2309
 
2240
2310
 
 
2311
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2312
    """Branch format registry."""
 
2313
 
 
2314
    def __init__(self, other_registry=None):
 
2315
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2316
        self._default_format = None
 
2317
 
 
2318
    def set_default(self, format):
 
2319
        self._default_format = format
 
2320
 
 
2321
    def get_default(self):
 
2322
        return self._default_format
 
2323
 
 
2324
 
2241
2325
network_format_registry = registry.FormatRegistry()
2242
2326
"""Registry of formats indexed by their network name.
2243
2327
 
2246
2330
BranchFormat.network_name() for more detail.
2247
2331
"""
2248
2332
 
 
2333
format_registry = BranchFormatRegistry(network_format_registry)
 
2334
 
2249
2335
 
2250
2336
# formats which have no format string are not discoverable
2251
2337
# and not independently creatable, so are not registered.
2253
2339
__format6 = BzrBranchFormat6()
2254
2340
__format7 = BzrBranchFormat7()
2255
2341
__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__)
 
2342
format_registry.register(__format5)
 
2343
format_registry.register(BranchReferenceFormat())
 
2344
format_registry.register(__format6)
 
2345
format_registry.register(__format7)
 
2346
format_registry.register(__format8)
 
2347
format_registry.set_default(__format7)
 
2348
 
 
2349
 
 
2350
class BranchWriteLockResult(LogicalLockResult):
 
2351
    """The result of write locking a branch.
 
2352
 
 
2353
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2354
        None.
 
2355
    :ivar unlock: A callable which will unlock the lock.
 
2356
    """
 
2357
 
 
2358
    def __init__(self, unlock, branch_token):
 
2359
        LogicalLockResult.__init__(self, unlock)
 
2360
        self.branch_token = branch_token
 
2361
 
 
2362
    def __repr__(self):
 
2363
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2364
            self.unlock)
2266
2365
 
2267
2366
 
2268
2367
class BzrBranch(Branch, _RelockDebugMixin):
2324
2423
        return self.control_files.is_locked()
2325
2424
 
2326
2425
    def lock_write(self, token=None):
 
2426
        """Lock the branch for write operations.
 
2427
 
 
2428
        :param token: A token to permit reacquiring a previously held and
 
2429
            preserved lock.
 
2430
        :return: A BranchWriteLockResult.
 
2431
        """
2327
2432
        if not self.is_locked():
2328
2433
            self._note_lock('w')
2329
2434
        # All-in-one needs to always unlock/lock.
2335
2440
        else:
2336
2441
            took_lock = False
2337
2442
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2443
            return BranchWriteLockResult(self.unlock,
 
2444
                self.control_files.lock_write(token=token))
2339
2445
        except:
2340
2446
            if took_lock:
2341
2447
                self.repository.unlock()
2342
2448
            raise
2343
2449
 
2344
2450
    def lock_read(self):
 
2451
        """Lock the branch for read operations.
 
2452
 
 
2453
        :return: A bzrlib.lock.LogicalLockResult.
 
2454
        """
2345
2455
        if not self.is_locked():
2346
2456
            self._note_lock('r')
2347
2457
        # All-in-one needs to always unlock/lock.
2354
2464
            took_lock = False
2355
2465
        try:
2356
2466
            self.control_files.lock_read()
 
2467
            return LogicalLockResult(self.unlock)
2357
2468
        except:
2358
2469
            if took_lock:
2359
2470
                self.repository.unlock()
2387
2498
        """See Branch.print_file."""
2388
2499
        return self.repository.print_file(file, revision_id)
2389
2500
 
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
2501
    @needs_write_lock
2454
2502
    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
 
        """
 
2503
        if not revision_id or not isinstance(revision_id, basestring):
 
2504
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2465
2505
        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))
 
2506
        old_revno, old_revid = self.last_revision_info()
 
2507
        if self._get_append_revisions_only():
 
2508
            self._check_history_violation(revision_id)
 
2509
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2510
        self._write_last_revision_info(revno, revision_id)
 
2511
        self._clear_cached_state()
 
2512
        self._last_revision_info_cache = revno, revision_id
 
2513
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2494
2514
 
2495
2515
    def basis_tree(self):
2496
2516
        """See Branch.basis_tree."""
2505
2525
                pass
2506
2526
        return None
2507
2527
 
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
2528
    def get_stacked_on_url(self):
2531
2529
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2532
2530
 
2543
2541
            self._transport.put_bytes('parent', url + '\n',
2544
2542
                mode=self.bzrdir._get_file_mode())
2545
2543
 
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
2544
    @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
 
2545
    def unbind(self):
 
2546
        """If bound, unbind"""
 
2547
        return self.set_bound_location(None)
2595
2548
 
2596
2549
    @needs_write_lock
2597
2550
    def bind(self, other):
2619
2572
        # history around
2620
2573
        self.set_bound_location(other.base)
2621
2574
 
 
2575
    def get_bound_location(self):
 
2576
        try:
 
2577
            return self._transport.get_bytes('bound')[:-1]
 
2578
        except errors.NoSuchFile:
 
2579
            return None
 
2580
 
 
2581
    @needs_read_lock
 
2582
    def get_master_branch(self, possible_transports=None):
 
2583
        """Return the branch we are bound to.
 
2584
 
 
2585
        :return: Either a Branch, or None
 
2586
        """
 
2587
        if self._master_branch_cache is None:
 
2588
            self._master_branch_cache = self._get_master_branch(
 
2589
                possible_transports)
 
2590
        return self._master_branch_cache
 
2591
 
 
2592
    def _get_master_branch(self, possible_transports):
 
2593
        bound_loc = self.get_bound_location()
 
2594
        if not bound_loc:
 
2595
            return None
 
2596
        try:
 
2597
            return Branch.open(bound_loc,
 
2598
                               possible_transports=possible_transports)
 
2599
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2600
            raise errors.BoundBranchConnectionFailure(
 
2601
                    self, bound_loc, e)
 
2602
 
2622
2603
    @needs_write_lock
2623
 
    def unbind(self):
2624
 
        """If bound, unbind"""
2625
 
        return self.set_bound_location(None)
 
2604
    def set_bound_location(self, location):
 
2605
        """Set the target where this branch is bound to.
 
2606
 
 
2607
        :param location: URL to the target branch
 
2608
        """
 
2609
        self._master_branch_cache = None
 
2610
        if location:
 
2611
            self._transport.put_bytes('bound', location+'\n',
 
2612
                mode=self.bzrdir._get_file_mode())
 
2613
        else:
 
2614
            try:
 
2615
                self._transport.delete('bound')
 
2616
            except errors.NoSuchFile:
 
2617
                return False
 
2618
            return True
2626
2619
 
2627
2620
    @needs_write_lock
2628
2621
    def update(self, possible_transports=None):
2641
2634
            return old_tip
2642
2635
        return None
2643
2636
 
2644
 
 
2645
 
class BzrBranch8(BzrBranch5):
 
2637
    def _read_last_revision_info(self):
 
2638
        revision_string = self._transport.get_bytes('last-revision')
 
2639
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2640
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2641
        revno = int(revno)
 
2642
        return revno, revision_id
 
2643
 
 
2644
    def _write_last_revision_info(self, revno, revision_id):
 
2645
        """Simply write out the revision id, with no checks.
 
2646
 
 
2647
        Use set_last_revision_info to perform this safely.
 
2648
 
 
2649
        Does not update the revision_history cache.
 
2650
        """
 
2651
        revision_id = _mod_revision.ensure_null(revision_id)
 
2652
        out_string = '%d %s\n' % (revno, revision_id)
 
2653
        self._transport.put_bytes('last-revision', out_string,
 
2654
            mode=self.bzrdir._get_file_mode())
 
2655
 
 
2656
 
 
2657
class FullHistoryBzrBranch(BzrBranch):
 
2658
    """Bzr branch which contains the full revision history."""
 
2659
 
 
2660
    @needs_write_lock
 
2661
    def set_last_revision_info(self, revno, revision_id):
 
2662
        if not revision_id or not isinstance(revision_id, basestring):
 
2663
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2664
        revision_id = _mod_revision.ensure_null(revision_id)
 
2665
        # this old format stores the full history, but this api doesn't
 
2666
        # provide it, so we must generate, and might as well check it's
 
2667
        # correct
 
2668
        history = self._lefthand_history(revision_id)
 
2669
        if len(history) != revno:
 
2670
            raise AssertionError('%d != %d' % (len(history), revno))
 
2671
        self._set_revision_history(history)
 
2672
 
 
2673
    def _read_last_revision_info(self):
 
2674
        rh = self.revision_history()
 
2675
        revno = len(rh)
 
2676
        if revno:
 
2677
            return (revno, rh[-1])
 
2678
        else:
 
2679
            return (0, _mod_revision.NULL_REVISION)
 
2680
 
 
2681
    @deprecated_method(deprecated_in((2, 4, 0)))
 
2682
    @needs_write_lock
 
2683
    def set_revision_history(self, rev_history):
 
2684
        """See Branch.set_revision_history."""
 
2685
        self._set_revision_history(rev_history)
 
2686
 
 
2687
    def _set_revision_history(self, rev_history):
 
2688
        if 'evil' in debug.debug_flags:
 
2689
            mutter_callsite(3, "set_revision_history scales with history.")
 
2690
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2691
        for rev_id in rev_history:
 
2692
            check_not_reserved_id(rev_id)
 
2693
        if Branch.hooks['post_change_branch_tip']:
 
2694
            # Don't calculate the last_revision_info() if there are no hooks
 
2695
            # that will use it.
 
2696
            old_revno, old_revid = self.last_revision_info()
 
2697
        if len(rev_history) == 0:
 
2698
            revid = _mod_revision.NULL_REVISION
 
2699
        else:
 
2700
            revid = rev_history[-1]
 
2701
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2702
        self._write_revision_history(rev_history)
 
2703
        self._clear_cached_state()
 
2704
        self._cache_revision_history(rev_history)
 
2705
        for hook in Branch.hooks['set_rh']:
 
2706
            hook(self, rev_history)
 
2707
        if Branch.hooks['post_change_branch_tip']:
 
2708
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2709
 
 
2710
    def _write_revision_history(self, history):
 
2711
        """Factored out of set_revision_history.
 
2712
 
 
2713
        This performs the actual writing to disk.
 
2714
        It is intended to be called by set_revision_history."""
 
2715
        self._transport.put_bytes(
 
2716
            'revision-history', '\n'.join(history),
 
2717
            mode=self.bzrdir._get_file_mode())
 
2718
 
 
2719
    def _gen_revision_history(self):
 
2720
        history = self._transport.get_bytes('revision-history').split('\n')
 
2721
        if history[-1:] == ['']:
 
2722
            # There shouldn't be a trailing newline, but just in case.
 
2723
            history.pop()
 
2724
        return history
 
2725
 
 
2726
    def _synchronize_history(self, destination, revision_id):
 
2727
        if not isinstance(destination, FullHistoryBzrBranch):
 
2728
            super(BzrBranch, self)._synchronize_history(
 
2729
                destination, revision_id)
 
2730
            return
 
2731
        if revision_id == _mod_revision.NULL_REVISION:
 
2732
            new_history = []
 
2733
        else:
 
2734
            new_history = self.revision_history()
 
2735
        if revision_id is not None and new_history != []:
 
2736
            try:
 
2737
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2738
            except ValueError:
 
2739
                rev = self.repository.get_revision(revision_id)
 
2740
                new_history = rev.get_history(self.repository)[1:]
 
2741
        destination._set_revision_history(new_history)
 
2742
 
 
2743
    @needs_write_lock
 
2744
    def generate_revision_history(self, revision_id, last_rev=None,
 
2745
        other_branch=None):
 
2746
        """Create a new revision history that will finish with revision_id.
 
2747
 
 
2748
        :param revision_id: the new tip to use.
 
2749
        :param last_rev: The previous last_revision. If not None, then this
 
2750
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2751
        :param other_branch: The other branch that DivergedBranches should
 
2752
            raise with respect to.
 
2753
        """
 
2754
        self._set_revision_history(self._lefthand_history(revision_id,
 
2755
            last_rev, other_branch))
 
2756
 
 
2757
 
 
2758
class BzrBranch5(FullHistoryBzrBranch):
 
2759
    """A format 5 branch. This supports new features over plain branches.
 
2760
 
 
2761
    It has support for a master_branch which is the data for bound branches.
 
2762
    """
 
2763
 
 
2764
 
 
2765
class BzrBranch8(BzrBranch):
2646
2766
    """A branch that stores tree-reference locations."""
2647
2767
 
2648
2768
    def _open_hook(self):
2674
2794
        self._last_revision_info_cache = None
2675
2795
        self._reference_info = None
2676
2796
 
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
2797
    def _check_history_violation(self, revision_id):
2723
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
 
2798
        current_revid = self.last_revision()
 
2799
        last_revision = _mod_revision.ensure_null(current_revid)
2724
2800
        if _mod_revision.is_null(last_revision):
2725
2801
            return
2726
 
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2802
        graph = self.repository.get_graph()
 
2803
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
 
2804
            if lh_ancestor == current_revid:
 
2805
                return
 
2806
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
2728
2807
 
2729
2808
    def _gen_revision_history(self):
2730
2809
        """Generate the revision history from last revision
2733
2812
        self._extend_partial_history(stop_index=last_revno-1)
2734
2813
        return list(reversed(self._partial_revision_history_cache))
2735
2814
 
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
2815
    @needs_write_lock
2753
2816
    def _set_parent_location(self, url):
2754
2817
        """Set the parent branch"""
2840
2903
 
2841
2904
    def set_bound_location(self, location):
2842
2905
        """See Branch.set_push_location."""
 
2906
        self._master_branch_cache = None
2843
2907
        result = None
2844
2908
        config = self.get_config()
2845
2909
        if location is None:
2885
2949
        return self.get_config(
2886
2950
            ).get_user_option_as_bool('append_revisions_only')
2887
2951
 
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
2952
    @needs_read_lock
2897
2953
    def get_rev_id(self, revno, history=None):
2898
2954
        """Find the revision id of the specified revno."""
2922
2978
        try:
2923
2979
            index = self._partial_revision_history_cache.index(revision_id)
2924
2980
        except ValueError:
2925
 
            self._extend_partial_history(stop_revision=revision_id)
 
2981
            try:
 
2982
                self._extend_partial_history(stop_revision=revision_id)
 
2983
            except errors.RevisionNotPresent, e:
 
2984
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2926
2985
            index = len(self._partial_revision_history_cache) - 1
2927
2986
            if self._partial_revision_history_cache[index] != revision_id:
2928
2987
                raise errors.NoSuchRevision(self, revision_id)
2983
3042
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2984
3043
    """
2985
3044
 
 
3045
    @deprecated_method(deprecated_in((2, 3, 0)))
2986
3046
    def __int__(self):
2987
 
        # DEPRECATED: pull used to return the change in revno
 
3047
        """Return the relative change in revno.
 
3048
 
 
3049
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3050
        """
2988
3051
        return self.new_revno - self.old_revno
2989
3052
 
2990
3053
    def report(self, to_file):
3015
3078
        target, otherwise it will be None.
3016
3079
    """
3017
3080
 
 
3081
    @deprecated_method(deprecated_in((2, 3, 0)))
3018
3082
    def __int__(self):
3019
 
        # DEPRECATED: push used to return the change in revno
 
3083
        """Return the relative change in revno.
 
3084
 
 
3085
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3086
        """
3020
3087
        return self.new_revno - self.old_revno
3021
3088
 
3022
3089
    def report(self, to_file):
3145
3212
    _optimisers = []
3146
3213
    """The available optimised InterBranch types."""
3147
3214
 
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)
 
3215
    @classmethod
 
3216
    def _get_branch_formats_to_test(klass):
 
3217
        """Return an iterable of format tuples for testing.
 
3218
        
 
3219
        :return: An iterable of (from_format, to_format) to use when testing
 
3220
            this InterBranch class. Each InterBranch class should define this
 
3221
            method itself.
 
3222
        """
 
3223
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3224
 
 
3225
    @needs_write_lock
3153
3226
    def pull(self, overwrite=False, stop_revision=None,
3154
3227
             possible_transports=None, local=False):
3155
3228
        """Mirror source into target branch.
3160
3233
        """
3161
3234
        raise NotImplementedError(self.pull)
3162
3235
 
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,
 
3236
    @needs_write_lock
 
3237
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3177
3238
             _override_hook_source_branch=None):
3178
3239
        """Mirror the source branch into the target branch.
3179
3240
 
3181
3242
        """
3182
3243
        raise NotImplementedError(self.push)
3183
3244
 
 
3245
    @needs_write_lock
 
3246
    def copy_content_into(self, revision_id=None):
 
3247
        """Copy the content of source into target
 
3248
 
 
3249
        revision_id: if not None, the revision history in the new branch will
 
3250
                     be truncated to end with revision_id.
 
3251
        """
 
3252
        raise NotImplementedError(self.copy_content_into)
 
3253
 
 
3254
    @needs_write_lock
 
3255
    def fetch(self, stop_revision=None, limit=None):
 
3256
        """Fetch revisions.
 
3257
 
 
3258
        :param stop_revision: Last revision to fetch
 
3259
        :param limit: Optional rough limit of revisions to fetch
 
3260
        """
 
3261
        raise NotImplementedError(self.fetch)
 
3262
 
3184
3263
 
3185
3264
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()."""
 
3265
    """InterBranch implementation that uses public Branch functions."""
 
3266
 
 
3267
    @classmethod
 
3268
    def is_compatible(klass, source, target):
 
3269
        # GenericBranch uses the public API, so always compatible
 
3270
        return True
 
3271
 
 
3272
    @classmethod
 
3273
    def _get_branch_formats_to_test(klass):
 
3274
        return [(format_registry.get_default(), format_registry.get_default())]
 
3275
 
 
3276
    @classmethod
 
3277
    def unwrap_format(klass, format):
 
3278
        if isinstance(format, remote.RemoteBranchFormat):
 
3279
            format._ensure_real()
 
3280
            return format._custom_format
 
3281
        return format
 
3282
 
 
3283
    @needs_write_lock
 
3284
    def copy_content_into(self, revision_id=None):
 
3285
        """Copy the content of source into target
 
3286
 
 
3287
        revision_id: if not None, the revision history in the new branch will
 
3288
                     be truncated to end with revision_id.
 
3289
        """
 
3290
        self.source.update_references(self.target)
 
3291
        self.source._synchronize_history(self.target, revision_id)
 
3292
        try:
 
3293
            parent = self.source.get_parent()
 
3294
        except errors.InaccessibleParent, e:
 
3295
            mutter('parent was not accessible to copy: %s', e)
 
3296
        else:
 
3297
            if parent:
 
3298
                self.target.set_parent(parent)
 
3299
        if self.source._push_should_merge_tags():
 
3300
            self.source.tags.merge_to(self.target.tags)
 
3301
 
 
3302
    @needs_write_lock
 
3303
    def fetch(self, stop_revision=None, limit=None):
 
3304
        if self.target.base == self.source.base:
 
3305
            return (0, [])
3196
3306
        self.source.lock_read()
3197
3307
        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)
 
3308
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3309
            fetch_spec_factory.source_branch = self.source
 
3310
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3311
            fetch_spec_factory.source_repo = self.source.repository
 
3312
            fetch_spec_factory.target_repo = self.target.repository
 
3313
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3314
            fetch_spec_factory.limit = limit
 
3315
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3316
            return self.target.repository.fetch(self.source.repository,
 
3317
                fetch_spec=fetch_spec)
3233
3318
        finally:
3234
3319
            self.source.unlock()
3235
3320
 
 
3321
    @needs_write_lock
 
3322
    def _update_revisions(self, stop_revision=None, overwrite=False,
 
3323
            graph=None):
 
3324
        other_revno, other_last_revision = self.source.last_revision_info()
 
3325
        stop_revno = None # unknown
 
3326
        if stop_revision is None:
 
3327
            stop_revision = other_last_revision
 
3328
            if _mod_revision.is_null(stop_revision):
 
3329
                # if there are no commits, we're done.
 
3330
                return
 
3331
            stop_revno = other_revno
 
3332
 
 
3333
        # what's the current last revision, before we fetch [and change it
 
3334
        # possibly]
 
3335
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3336
        # we fetch here so that we don't process data twice in the common
 
3337
        # case of having something to pull, and so that the check for
 
3338
        # already merged can operate on the just fetched graph, which will
 
3339
        # be cached in memory.
 
3340
        self.fetch(stop_revision=stop_revision)
 
3341
        # Check to see if one is an ancestor of the other
 
3342
        if not overwrite:
 
3343
            if graph is None:
 
3344
                graph = self.target.repository.get_graph()
 
3345
            if self.target._check_if_descendant_or_diverged(
 
3346
                    stop_revision, last_rev, graph, self.source):
 
3347
                # stop_revision is a descendant of last_rev, but we aren't
 
3348
                # overwriting, so we're done.
 
3349
                return
 
3350
        if stop_revno is None:
 
3351
            if graph is None:
 
3352
                graph = self.target.repository.get_graph()
 
3353
            this_revno, this_last_revision = \
 
3354
                    self.target.last_revision_info()
 
3355
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3356
                            [(other_last_revision, other_revno),
 
3357
                             (this_last_revision, this_revno)])
 
3358
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3359
 
 
3360
    @needs_write_lock
3236
3361
    def pull(self, overwrite=False, stop_revision=None,
 
3362
             possible_transports=None, run_hooks=True,
 
3363
             _override_hook_target=None, local=False):
 
3364
        """Pull from source into self, updating my master if any.
 
3365
 
 
3366
        :param run_hooks: Private parameter - if false, this branch
 
3367
            is being called because it's the master of the primary branch,
 
3368
            so it should not run its hooks.
 
3369
        """
 
3370
        bound_location = self.target.get_bound_location()
 
3371
        if local and not bound_location:
 
3372
            raise errors.LocalRequiresBoundBranch()
 
3373
        master_branch = None
 
3374
        source_is_master = (self.source.user_url == bound_location)
 
3375
        if not local and bound_location and not source_is_master:
 
3376
            # not pulling from master, so we need to update master.
 
3377
            master_branch = self.target.get_master_branch(possible_transports)
 
3378
            master_branch.lock_write()
 
3379
        try:
 
3380
            if master_branch:
 
3381
                # pull from source into master.
 
3382
                master_branch.pull(self.source, overwrite, stop_revision,
 
3383
                    run_hooks=False)
 
3384
            return self._pull(overwrite,
 
3385
                stop_revision, _hook_master=master_branch,
 
3386
                run_hooks=run_hooks,
 
3387
                _override_hook_target=_override_hook_target,
 
3388
                merge_tags_to_master=not source_is_master)
 
3389
        finally:
 
3390
            if master_branch:
 
3391
                master_branch.unlock()
 
3392
 
 
3393
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
3394
             _override_hook_source_branch=None):
 
3395
        """See InterBranch.push.
 
3396
 
 
3397
        This is the basic concrete implementation of push()
 
3398
 
 
3399
        :param _override_hook_source_branch: If specified, run the hooks
 
3400
            passing this Branch as the source, rather than self.  This is for
 
3401
            use of RemoteBranch, where push is delegated to the underlying
 
3402
            vfs-based Branch.
 
3403
        """
 
3404
        if lossy:
 
3405
            raise errors.LossyPushToSameVCS(self.source, self.target)
 
3406
        # TODO: Public option to disable running hooks - should be trivial but
 
3407
        # needs tests.
 
3408
        self.source.lock_read()
 
3409
        try:
 
3410
            return _run_with_write_locked_target(
 
3411
                self.target, self._push_with_bound_branches, overwrite,
 
3412
                stop_revision, 
 
3413
                _override_hook_source_branch=_override_hook_source_branch)
 
3414
        finally:
 
3415
            self.source.unlock()
 
3416
 
 
3417
    def _basic_push(self, overwrite, stop_revision):
 
3418
        """Basic implementation of push without bound branches or hooks.
 
3419
 
 
3420
        Must be called with source read locked and target write locked.
 
3421
        """
 
3422
        result = BranchPushResult()
 
3423
        result.source_branch = self.source
 
3424
        result.target_branch = self.target
 
3425
        result.old_revno, result.old_revid = self.target.last_revision_info()
 
3426
        self.source.update_references(self.target)
 
3427
        if result.old_revid != stop_revision:
 
3428
            # We assume that during 'push' this repository is closer than
 
3429
            # the target.
 
3430
            graph = self.source.repository.get_graph(self.target.repository)
 
3431
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3432
                    graph=graph)
 
3433
        if self.source._push_should_merge_tags():
 
3434
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3435
                overwrite)
 
3436
        result.new_revno, result.new_revid = self.target.last_revision_info()
 
3437
        return result
 
3438
 
 
3439
    def _push_with_bound_branches(self, overwrite, stop_revision,
 
3440
            _override_hook_source_branch=None):
 
3441
        """Push from source into target, and into target's master if any.
 
3442
        """
 
3443
        def _run_hooks():
 
3444
            if _override_hook_source_branch:
 
3445
                result.source_branch = _override_hook_source_branch
 
3446
            for hook in Branch.hooks['post_push']:
 
3447
                hook(result)
 
3448
 
 
3449
        bound_location = self.target.get_bound_location()
 
3450
        if bound_location and self.target.base != bound_location:
 
3451
            # there is a master branch.
 
3452
            #
 
3453
            # XXX: Why the second check?  Is it even supported for a branch to
 
3454
            # be bound to itself? -- mbp 20070507
 
3455
            master_branch = self.target.get_master_branch()
 
3456
            master_branch.lock_write()
 
3457
            try:
 
3458
                # push into the master from the source branch.
 
3459
                master_inter = InterBranch.get(self.source, master_branch)
 
3460
                master_inter._basic_push(overwrite, stop_revision)
 
3461
                # and push into the target branch from the source. Note that
 
3462
                # we push from the source branch again, because it's considered
 
3463
                # the highest bandwidth repository.
 
3464
                result = self._basic_push(overwrite, stop_revision)
 
3465
                result.master_branch = master_branch
 
3466
                result.local_branch = self.target
 
3467
                _run_hooks()
 
3468
                return result
 
3469
            finally:
 
3470
                master_branch.unlock()
 
3471
        else:
 
3472
            # no master branch
 
3473
            result = self._basic_push(overwrite, stop_revision)
 
3474
            # TODO: Why set master_branch and local_branch if there's no
 
3475
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3476
            # 20070504
 
3477
            result.master_branch = self.target
 
3478
            result.local_branch = None
 
3479
            _run_hooks()
 
3480
            return result
 
3481
 
 
3482
    def _pull(self, overwrite=False, stop_revision=None,
3237
3483
             possible_transports=None, _hook_master=None, run_hooks=True,
3238
 
             _override_hook_target=None, local=False):
 
3484
             _override_hook_target=None, local=False,
 
3485
             merge_tags_to_master=True):
3239
3486
        """See Branch.pull.
3240
3487
 
 
3488
        This function is the core worker, used by GenericInterBranch.pull to
 
3489
        avoid duplication when pulling source->master and source->local.
 
3490
 
3241
3491
        :param _hook_master: Private parameter - set the branch to
3242
3492
            be supplied as the master to pull hooks.
3243
3493
        :param run_hooks: Private parameter - if false, this branch
3244
3494
            is being called because it's the master of the primary branch,
3245
3495
            so it should not run its hooks.
 
3496
            is being called because it's the master of the primary branch,
 
3497
            so it should not run its hooks.
3246
3498
        :param _override_hook_target: Private parameter - set the branch to be
3247
3499
            supplied as the target_branch to pull hooks.
3248
3500
        :param local: Only update the local branch, and not the bound branch.
3267
3519
            # -- JRV20090506
3268
3520
            result.old_revno, result.old_revid = \
3269
3521
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
 
3522
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3523
                graph=graph)
3272
3524
            # TODO: The old revid should be specified when merging tags, 
3273
3525
            # so a tags implementation that versions tags can only 
3274
3526
            # pull in the most recent changes. -- JRV20090506
3275
3527
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
 
3528
                overwrite, ignore_master=not merge_tags_to_master)
3277
3529
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
3530
            if _hook_master:
3279
3531
                result.master_branch = _hook_master
3288
3540
            self.source.unlock()
3289
3541
        return result
3290
3542
 
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
3543
 
3400
3544
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)