/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: Canonical.com Patch Queue Manager
  • Date: 2011-05-19 10:51:37 UTC
  • mfrom: (5891.1.3 api-docs)
  • Revision ID: pqm@pqm.ubuntu.com-20110519105137-amzagrral2ldm1lq
(spiv) Fix the formatting of more docstrings. (Andrew Bennetts)

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