/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

Integrate into bzr-2.4.
Only include the release-notes in 2.4, because we haven't officially
decided to backport it to 2.3 yet.
Remove the duplicated 'qastaging' entries.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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,
46
49
    )
47
50
""")
48
51
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
52
from bzrlib import (
 
53
    controldir,
 
54
    )
 
55
from bzrlib.decorators import (
 
56
    needs_read_lock,
 
57
    needs_write_lock,
 
58
    only_raises,
 
59
    )
50
60
from bzrlib.hooks import HookPoint, Hooks
51
61
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
 
62
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
63
from bzrlib import registry
54
64
from bzrlib.symbol_versioning import (
55
65
    deprecated_in,
63
73
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
74
 
65
75
 
66
 
class Branch(bzrdir.ControlComponent):
 
76
class Branch(controldir.ControlComponent):
67
77
    """Branch holding a history of revisions.
68
78
 
69
79
    :ivar base:
70
80
        Base directory/url of the branch; using control_url and
71
81
        control_transport is more standardized.
72
 
 
73
 
    hooks: An instance of BranchHooks.
 
82
    :ivar hooks: An instance of BranchHooks.
 
83
    :ivar _master_branch_cache: cached result of get_master_branch, see
 
84
        _clear_cached_state.
74
85
    """
75
86
    # this is really an instance variable - FIXME move it there
76
87
    # - RBC 20060112
90
101
        self._revision_id_to_revno_cache = None
91
102
        self._partial_revision_id_to_revno_cache = {}
92
103
        self._partial_revision_history_cache = []
 
104
        self._tags_bytes = None
93
105
        self._last_revision_info_cache = None
 
106
        self._master_branch_cache = None
94
107
        self._merge_sorted_revisions_cache = None
95
108
        self._open_hook()
96
109
        hooks = Branch.hooks['open']
102
115
 
103
116
    def _activate_fallback_location(self, url):
104
117
        """Activate the branch/repository from url as a fallback repository."""
 
118
        for existing_fallback_repo in self.repository._fallback_repositories:
 
119
            if existing_fallback_repo.user_url == url:
 
120
                # This fallback is already configured.  This probably only
 
121
                # happens because BzrDir.sprout is a horrible mess.  To avoid
 
122
                # confusing _unstack we don't add this a second time.
 
123
                mutter('duplicate activation of fallback %r on %r', url, self)
 
124
                return
105
125
        repo = self._get_fallback_repository(url)
106
126
        if repo.has_same_location(self.repository):
107
127
            raise errors.UnstackableLocationError(self.user_url, url)
197
217
        return self.supports_tags() and self.tags.get_tag_dict()
198
218
 
199
219
    def get_config(self):
 
220
        """Get a bzrlib.config.BranchConfig for this Branch.
 
221
 
 
222
        This can then be used to get and set configuration options for the
 
223
        branch.
 
224
 
 
225
        :return: A bzrlib.config.BranchConfig.
 
226
        """
200
227
        return BranchConfig(self)
201
228
 
202
229
    def _get_config(self):
218
245
            possible_transports=[self.bzrdir.root_transport])
219
246
        return a_branch.repository
220
247
 
 
248
    @needs_read_lock
221
249
    def _get_tags_bytes(self):
222
250
        """Get the bytes of a serialised tags dict.
223
251
 
230
258
        :return: The bytes of the tags file.
231
259
        :seealso: Branch._set_tags_bytes.
232
260
        """
233
 
        return self._transport.get_bytes('tags')
 
261
        if self._tags_bytes is None:
 
262
            self._tags_bytes = self._transport.get_bytes('tags')
 
263
        return self._tags_bytes
234
264
 
235
265
    def _get_nick(self, local=False, possible_transports=None):
236
266
        config = self.get_config()
238
268
        if not local and not config.has_explicit_nickname():
239
269
            try:
240
270
                master = self.get_master_branch(possible_transports)
 
271
                if master and self.user_url == master.user_url:
 
272
                    raise errors.RecursiveBind(self.user_url)
241
273
                if master is not None:
242
274
                    # return the master branch value
243
275
                    return master.nick
 
276
            except errors.RecursiveBind, e:
 
277
                raise e
244
278
            except errors.BzrError, e:
245
279
                # Silently fall back to local implicit nick if the master is
246
280
                # unavailable
283
317
        new_history.reverse()
284
318
        return new_history
285
319
 
286
 
    def lock_write(self):
 
320
    def lock_write(self, token=None):
 
321
        """Lock the branch for write operations.
 
322
 
 
323
        :param token: A token to permit reacquiring a previously held and
 
324
            preserved lock.
 
325
        :return: A BranchWriteLockResult.
 
326
        """
287
327
        raise NotImplementedError(self.lock_write)
288
328
 
289
329
    def lock_read(self):
 
330
        """Lock the branch for read operations.
 
331
 
 
332
        :return: A bzrlib.lock.LogicalLockResult.
 
333
        """
290
334
        raise NotImplementedError(self.lock_read)
291
335
 
292
336
    def unlock(self):
626
670
        raise errors.UnsupportedOperation(self.get_reference_info, self)
627
671
 
628
672
    @needs_write_lock
629
 
    def fetch(self, from_branch, last_revision=None, pb=None):
 
673
    def fetch(self, from_branch, last_revision=None, fetch_spec=None):
630
674
        """Copy revisions from from_branch into this branch.
631
675
 
632
676
        :param from_branch: Where to copy from.
633
677
        :param last_revision: What revision to stop at (None for at the end
634
678
                              of the branch.
635
 
        :param pb: An optional progress bar to use.
 
679
        :param fetch_spec: If specified, a SearchResult or
 
680
            PendingAncestryResult that describes which revisions to copy.  This
 
681
            allows copying multiple heads at once.  Mutually exclusive with
 
682
            last_revision.
636
683
        :return: None
637
684
        """
 
685
        if fetch_spec is not None and last_revision is not None:
 
686
            raise AssertionError(
 
687
                "fetch_spec and last_revision are mutually exclusive.")
638
688
        if self.base == from_branch.base:
639
689
            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
690
        from_branch.lock_read()
645
691
        try:
646
 
            if last_revision is None:
 
692
            if last_revision is None and fetch_spec is None:
647
693
                last_revision = from_branch.last_revision()
648
694
                last_revision = _mod_revision.ensure_null(last_revision)
649
695
            return self.repository.fetch(from_branch.repository,
650
696
                                         revision_id=last_revision,
651
 
                                         pb=pb)
 
697
                                         fetch_spec=fetch_spec)
652
698
        finally:
653
699
            from_branch.unlock()
654
700
 
767
813
 
768
814
    def _unstack(self):
769
815
        """Change a branch to be unstacked, copying data as needed.
770
 
        
 
816
 
771
817
        Don't call this directly, use set_stacked_on_url(None).
772
818
        """
773
819
        pb = ui.ui_factory.nested_progress_bar()
782
828
            old_repository = self.repository
783
829
            if len(old_repository._fallback_repositories) != 1:
784
830
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
 
831
                    "of %r (fallbacks: %r)" % (old_repository,
 
832
                        old_repository._fallback_repositories))
 
833
            # Open the new repository object.
 
834
            # Repositories don't offer an interface to remove fallback
 
835
            # repositories today; take the conceptually simpler option and just
 
836
            # reopen it.  We reopen it starting from the URL so that we
 
837
            # get a separate connection for RemoteRepositories and can
 
838
            # stream from one of them to the other.  This does mean doing
 
839
            # separate SSH connection setup, but unstacking is not a
 
840
            # common operation so it's tolerable.
 
841
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
842
            new_repository = new_bzrdir.find_repository()
 
843
            if new_repository._fallback_repositories:
 
844
                raise AssertionError("didn't expect %r to have "
 
845
                    "fallback_repositories"
 
846
                    % (self.repository,))
 
847
            # Replace self.repository with the new repository.
 
848
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
849
            # lock count) of self.repository to the new repository.
 
850
            lock_token = old_repository.lock_write().repository_token
 
851
            self.repository = new_repository
 
852
            if isinstance(self, remote.RemoteBranch):
 
853
                # Remote branches can have a second reference to the old
 
854
                # repository that need to be replaced.
 
855
                if self._real_branch is not None:
 
856
                    self._real_branch.repository = new_repository
 
857
            self.repository.lock_write(token=lock_token)
 
858
            if lock_token is not None:
 
859
                old_repository.leave_lock_in_place()
787
860
            old_repository.unlock()
 
861
            if lock_token is not None:
 
862
                # XXX: self.repository.leave_lock_in_place() before this
 
863
                # function will not be preserved.  Fortunately that doesn't
 
864
                # affect the current default format (2a), and would be a
 
865
                # corner-case anyway.
 
866
                #  - Andrew Bennetts, 2010/06/30
 
867
                self.repository.dont_leave_lock_in_place()
 
868
            old_lock_count = 0
 
869
            while True:
 
870
                try:
 
871
                    old_repository.unlock()
 
872
                except errors.LockNotHeld:
 
873
                    break
 
874
                old_lock_count += 1
 
875
            if old_lock_count == 0:
 
876
                raise AssertionError(
 
877
                    'old_repository should have been locked at least once.')
 
878
            for i in range(old_lock_count-1):
 
879
                self.repository.lock_write()
 
880
            # Fetch from the old repository into the new.
788
881
            old_repository.lock_read()
789
882
            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
883
                # XXX: If you unstack a branch while it has a working tree
809
884
                # with a pending merge, the pending-merged revisions will no
810
885
                # 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)
 
886
                try:
 
887
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
888
                except errors.TagsNotSupported:
 
889
                    tags_to_fetch = set()
 
890
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
891
                    old_repository, required_ids=[self.last_revision()],
 
892
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
893
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
818
894
            finally:
819
895
                old_repository.unlock()
820
896
        finally:
825
901
 
826
902
        :seealso: Branch._get_tags_bytes.
827
903
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
904
        return _run_with_write_locked_target(self, self._set_tags_bytes_locked,
 
905
                bytes)
 
906
 
 
907
    def _set_tags_bytes_locked(self, bytes):
 
908
        self._tags_bytes = bytes
 
909
        return self._transport.put_bytes('tags', bytes)
830
910
 
831
911
    def _cache_revision_history(self, rev_history):
832
912
        """Set the cached revision history to rev_history.
859
939
        self._revision_history_cache = None
860
940
        self._revision_id_to_revno_cache = None
861
941
        self._last_revision_info_cache = None
 
942
        self._master_branch_cache = None
862
943
        self._merge_sorted_revisions_cache = None
863
944
        self._partial_revision_history_cache = []
864
945
        self._partial_revision_id_to_revno_cache = {}
 
946
        self._tags_bytes = None
865
947
 
866
948
    def _gen_revision_history(self):
867
949
        """Return sequence of revision hashes on to this branch.
928
1010
        else:
929
1011
            return (0, _mod_revision.NULL_REVISION)
930
1012
 
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
1013
    def update_revisions(self, other, stop_revision=None, overwrite=False,
956
 
                         graph=None):
 
1014
                         graph=None, fetch_tags=True):
957
1015
        """Pull in new perfect-fit revisions.
958
1016
 
959
1017
        :param other: Another Branch to pull from
962
1020
            to see if it is a proper descendant.
963
1021
        :param graph: A Graph object that can be used to query history
964
1022
            information. This can be None.
 
1023
        :param fetch_tags: Flag that specifies if tags from other should be
 
1024
            fetched too.
965
1025
        :return: None
966
1026
        """
967
1027
        return InterBranch.get(other, self).update_revisions(stop_revision,
968
 
            overwrite, graph)
 
1028
            overwrite, graph, fetch_tags=fetch_tags)
969
1029
 
 
1030
    @deprecated_method(deprecated_in((2, 4, 0)))
970
1031
    def import_last_revision_info(self, source_repo, revno, revid):
971
1032
        """Set the last revision info, importing from another repo if necessary.
972
1033
 
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
1034
        :param source_repo: Source repository to optionally fetch from
977
1035
        :param revno: Revision number of the new tip
978
1036
        :param revid: Revision id of the new tip
981
1039
            self.repository.fetch(source_repo, revision_id=revid)
982
1040
        self.set_last_revision_info(revno, revid)
983
1041
 
 
1042
    def import_last_revision_info_and_tags(self, source, revno, revid):
 
1043
        """Set the last revision info, importing from another repo if necessary.
 
1044
 
 
1045
        This is used by the bound branch code to upload a revision to
 
1046
        the master branch first before updating the tip of the local branch.
 
1047
        Revisions referenced by source's tags are also transferred.
 
1048
 
 
1049
        :param source: Source branch to optionally fetch from
 
1050
        :param revno: Revision number of the new tip
 
1051
        :param revid: Revision id of the new tip
 
1052
        """
 
1053
        if not self.repository.has_same_location(source.repository):
 
1054
            try:
 
1055
                tags_to_fetch = set(source.tags.get_reverse_tag_dict())
 
1056
            except errors.TagsNotSupported:
 
1057
                tags_to_fetch = set()
 
1058
            fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
1059
                source.repository, [revid],
 
1060
                if_present_ids=tags_to_fetch).execute()
 
1061
            self.repository.fetch(source.repository, fetch_spec=fetch_spec)
 
1062
        self.set_last_revision_info(revno, revid)
 
1063
 
984
1064
    def revision_id_to_revno(self, revision_id):
985
1065
        """Given a revision id, return its revno"""
986
1066
        if _mod_revision.is_null(revision_id):
1006
1086
            self._extend_partial_history(distance_from_last)
1007
1087
        return self._partial_revision_history_cache[distance_from_last]
1008
1088
 
1009
 
    @needs_write_lock
1010
1089
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1090
             possible_transports=None, *args, **kwargs):
1012
1091
        """Mirror source into this branch.
1208
1287
        return result
1209
1288
 
1210
1289
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1290
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1291
            repository=None):
1212
1292
        """Create a new line of development from the branch, into to_bzrdir.
1213
1293
 
1214
1294
        to_bzrdir controls the branch format.
1219
1299
        if (repository_policy is not None and
1220
1300
            repository_policy.requires_stacking()):
1221
1301
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
 
        result = to_bzrdir.create_branch()
 
1302
        result = to_bzrdir.create_branch(repository=repository)
1223
1303
        result.lock_write()
1224
1304
        try:
1225
1305
            if repository_policy is not None:
1255
1335
                revno = 1
1256
1336
        destination.set_last_revision_info(revno, revision_id)
1257
1337
 
1258
 
    @needs_read_lock
1259
1338
    def copy_content_into(self, destination, revision_id=None):
1260
1339
        """Copy the content of self into destination.
1261
1340
 
1262
1341
        revision_id: if not None, the revision history in the new branch will
1263
1342
                     be truncated to end with revision_id.
1264
1343
        """
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)
 
1344
        return InterBranch.get(self, destination).copy_content_into(
 
1345
            revision_id=revision_id)
1276
1346
 
1277
1347
    def update_references(self, target):
1278
1348
        if not getattr(self._format, 'supports_reference_locations', False):
1323
1393
        """Return the most suitable metadir for a checkout of this branch.
1324
1394
        Weaves are used if this branch's repository uses weaves.
1325
1395
        """
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)
 
1396
        format = self.repository.bzrdir.checkout_metadir()
 
1397
        format.set_branch_format(self._format)
1333
1398
        return format
1334
1399
 
1335
1400
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1401
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1402
        no_tree=None):
1337
1403
        """Create a clone of this branch and its bzrdir.
1338
1404
 
1339
1405
        :param to_transport: The transport to clone onto.
1346
1412
        """
1347
1413
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1414
        # clone call. Or something. 20090224 RBC/spiv.
 
1415
        # XXX: Should this perhaps clone colocated branches as well, 
 
1416
        # rather than just the default branch? 20100319 JRV
1349
1417
        if revision_id is None:
1350
1418
            revision_id = self.last_revision()
1351
1419
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
1420
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1421
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1422
            no_tree=no_tree)
1354
1423
        return dir_to.open_branch()
1355
1424
 
1356
1425
    def create_checkout(self, to_location, revision_id=None,
1471
1540
        else:
1472
1541
            raise AssertionError("invalid heads: %r" % (heads,))
1473
1542
 
1474
 
 
1475
 
class BranchFormat(object):
 
1543
    def heads_to_fetch(self):
 
1544
        """Return the heads that must and that should be fetched to copy this
 
1545
        branch into another repo.
 
1546
 
 
1547
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1548
            set of heads that must be fetched.  if_present_fetch is a set of
 
1549
            heads that must be fetched if present, but no error is necessary if
 
1550
            they are not present.
 
1551
        """
 
1552
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
 
1553
        # are the tags.
 
1554
        must_fetch = set([self.last_revision()])
 
1555
        try:
 
1556
            if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1557
        except errors.TagsNotSupported:
 
1558
            if_present_fetch = set()
 
1559
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1560
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1561
        return must_fetch, if_present_fetch
 
1562
 
 
1563
 
 
1564
class BranchFormat(controldir.ControlComponentFormat):
1476
1565
    """An encapsulation of the initialization and open routines for a format.
1477
1566
 
1478
1567
    Formats provide three things:
1481
1570
     * an open routine.
1482
1571
 
1483
1572
    Formats are placed in an dict by their format string for reference
1484
 
    during branch opening. Its not required that these be instances, they
 
1573
    during branch opening. It's not required that these be instances, they
1485
1574
    can be classes themselves with class methods - it simply depends on
1486
1575
    whether state is needed for a given format or not.
1487
1576
 
1490
1579
    object will be created every time regardless.
1491
1580
    """
1492
1581
 
1493
 
    _default_format = None
1494
 
    """The default format used for new branches."""
1495
 
 
1496
 
    _formats = {}
1497
 
    """The known formats."""
1498
 
 
1499
1582
    can_set_append_revisions_only = True
1500
1583
 
1501
1584
    def __eq__(self, other):
1510
1593
        try:
1511
1594
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
1595
            format_string = transport.get_bytes("format")
1513
 
            return klass._formats[format_string]
 
1596
            return format_registry.get(format_string)
1514
1597
        except errors.NoSuchFile:
1515
1598
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1516
1599
        except KeyError:
1517
1600
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1601
 
1519
1602
    @classmethod
 
1603
    @deprecated_method(deprecated_in((2, 4, 0)))
1520
1604
    def get_default_format(klass):
1521
1605
        """Return the current default format."""
1522
 
        return klass._default_format
1523
 
 
1524
 
    def get_reference(self, a_bzrdir):
 
1606
        return format_registry.get_default()
 
1607
 
 
1608
    @classmethod
 
1609
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1610
    def get_formats(klass):
 
1611
        """Get all the known formats.
 
1612
 
 
1613
        Warning: This triggers a load of all lazy registered formats: do not
 
1614
        use except when that is desireed.
 
1615
        """
 
1616
        return format_registry._get_all()
 
1617
 
 
1618
    def get_reference(self, a_bzrdir, name=None):
1525
1619
        """Get the target reference of the branch in a_bzrdir.
1526
1620
 
1527
1621
        format probing must have been completed before calling
1529
1623
        in a_bzrdir is correct.
1530
1624
 
1531
1625
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1626
        :param name: Name of the colocated branch to fetch
1532
1627
        :return: None if the branch is not a reference branch.
1533
1628
        """
1534
1629
        return None
1535
1630
 
1536
1631
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
 
1632
    def set_reference(self, a_bzrdir, name, to_branch):
1538
1633
        """Set the target reference of the branch in a_bzrdir.
1539
1634
 
1540
1635
        format probing must have been completed before calling
1542
1637
        in a_bzrdir is correct.
1543
1638
 
1544
1639
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1640
        :param name: Name of colocated branch to set, None for default
1545
1641
        :param to_branch: branch that the checkout is to reference
1546
1642
        """
1547
1643
        raise NotImplementedError(self.set_reference)
1563
1659
            hook(params)
1564
1660
 
1565
1661
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
 
                           lock_type='metadir', set_format=True):
 
1662
                           repository=None):
1567
1663
        """Initialize a branch in a bzrdir, with specified files
1568
1664
 
1569
1665
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1666
        :param utf8_files: The files to create as a list of
1571
1667
            (filename, content) tuples
1572
1668
        :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
1669
        :return: a branch in this format
1577
1670
        """
1578
1671
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
1672
        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
1673
        control_files = lockable_files.LockableFiles(branch_transport,
1586
 
            lock_name, lock_class)
 
1674
            'lock', lockdir.LockDir)
1587
1675
        control_files.create_lock()
 
1676
        control_files.lock_write()
1588
1677
        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
1678
            utf8_files += [('format', self.get_format_string())]
1598
 
        try:
1599
1679
            for (filename, content) in utf8_files:
1600
1680
                branch_transport.put_bytes(
1601
1681
                    filename, content,
1602
1682
                    mode=a_bzrdir._get_file_mode())
1603
1683
        finally:
1604
 
            if lock_taken:
1605
 
                control_files.unlock()
1606
 
        branch = self.open(a_bzrdir, name, _found=True)
 
1684
            control_files.unlock()
 
1685
        branch = self.open(a_bzrdir, name, _found=True,
 
1686
                found_repository=repository)
1607
1687
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1608
1688
        return branch
1609
1689
 
1610
 
    def initialize(self, a_bzrdir, name=None):
 
1690
    def initialize(self, a_bzrdir, name=None, repository=None):
1611
1691
        """Create a branch of this format in a_bzrdir.
1612
1692
        
1613
1693
        :param name: Name of the colocated branch to create.
1647
1727
        """
1648
1728
        raise NotImplementedError(self.network_name)
1649
1729
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1730
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
1731
            found_repository=None):
1651
1732
        """Return the branch object for a_bzrdir
1652
1733
 
1653
1734
        :param a_bzrdir: A BzrDir that contains a branch.
1660
1741
        raise NotImplementedError(self.open)
1661
1742
 
1662
1743
    @classmethod
 
1744
    @deprecated_method(deprecated_in((2, 4, 0)))
1663
1745
    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__)
 
1746
        """Register a metadir format.
 
1747
 
 
1748
        See MetaDirBranchFormatFactory for the ability to register a format
 
1749
        without loading the code the format needs until it is actually used.
 
1750
        """
 
1751
        format_registry.register(format)
1669
1752
 
1670
1753
    @classmethod
 
1754
    @deprecated_method(deprecated_in((2, 4, 0)))
1671
1755
    def set_default_format(klass, format):
1672
 
        klass._default_format = format
 
1756
        format_registry.set_default(format)
1673
1757
 
1674
1758
    def supports_set_append_revisions_only(self):
1675
1759
        """True if this format supports set_append_revisions_only."""
1679
1763
        """True if this format records a stacked-on branch."""
1680
1764
        return False
1681
1765
 
 
1766
    def supports_leaving_lock(self):
 
1767
        """True if this format supports leaving locks in place."""
 
1768
        return False # by default
 
1769
 
1682
1770
    @classmethod
 
1771
    @deprecated_method(deprecated_in((2, 4, 0)))
1683
1772
    def unregister_format(klass, format):
1684
 
        del klass._formats[format.get_format_string()]
 
1773
        format_registry.remove(format)
1685
1774
 
1686
1775
    def __str__(self):
1687
1776
        return self.get_format_description().rstrip()
1691
1780
        return False  # by default
1692
1781
 
1693
1782
 
 
1783
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1784
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1785
    
 
1786
    While none of the built in BranchFormats are lazy registered yet,
 
1787
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1788
    use it, and the bzr-loom plugin uses it as well (see
 
1789
    bzrlib.plugins.loom.formats).
 
1790
    """
 
1791
 
 
1792
    def __init__(self, format_string, module_name, member_name):
 
1793
        """Create a MetaDirBranchFormatFactory.
 
1794
 
 
1795
        :param format_string: The format string the format has.
 
1796
        :param module_name: Module to load the format class from.
 
1797
        :param member_name: Attribute name within the module for the format class.
 
1798
        """
 
1799
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1800
        self._format_string = format_string
 
1801
        
 
1802
    def get_format_string(self):
 
1803
        """See BranchFormat.get_format_string."""
 
1804
        return self._format_string
 
1805
 
 
1806
    def __call__(self):
 
1807
        """Used for network_format_registry support."""
 
1808
        return self.get_obj()()
 
1809
 
 
1810
 
1694
1811
class BranchHooks(Hooks):
1695
1812
    """A dictionary mapping hook name to a list of callables for branch hooks.
1696
1813
 
1723
1840
            "with a bzrlib.branch.PullResult object and only runs in the "
1724
1841
            "bzr client.", (0, 15), None))
1725
1842
        self.create_hook(HookPoint('pre_commit',
1726
 
            "Called after a commit is calculated but before it is is "
 
1843
            "Called after a commit is calculated but before it is "
1727
1844
            "completed. pre_commit is called with (local, master, old_revno, "
1728
1845
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
1846
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1766
1883
            "all are called with the url returned from the previous hook."
1767
1884
            "The order is however undefined.", (1, 9), None))
1768
1885
        self.create_hook(HookPoint('automatic_tag_name',
1769
 
            "Called to determine an automatic tag name for a revision."
 
1886
            "Called to determine an automatic tag name for a revision. "
1770
1887
            "automatic_tag_name is called with (branch, revision_id) and "
1771
1888
            "should return a tag name or None if no tag name could be "
1772
1889
            "determined. The first non-None tag name returned will be used.",
1863
1980
        return self.__dict__ == other.__dict__
1864
1981
 
1865
1982
    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)
 
1983
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1872
1984
 
1873
1985
 
1874
1986
class SwitchHookParams(object):
1904
2016
            self.revision_id)
1905
2017
 
1906
2018
 
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
2019
class BranchFormatMetadir(BranchFormat):
1951
2020
    """Common logic for meta-dir based branch formats."""
1952
2021
 
1961
2030
        """
1962
2031
        return self.get_format_string()
1963
2032
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2033
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2034
            found_repository=None):
1965
2035
        """See BranchFormat.open()."""
1966
2036
        if not _found:
1967
2037
            format = BranchFormat.find_format(a_bzrdir, name=name)
1972
2042
        try:
1973
2043
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
2044
                                                         lockdir.LockDir)
 
2045
            if found_repository is None:
 
2046
                found_repository = a_bzrdir.find_repository()
1975
2047
            return self._branch_class()(_format=self,
1976
2048
                              _control_files=control_files,
1977
2049
                              name=name,
1978
2050
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
 
2051
                              _repository=found_repository,
1980
2052
                              ignore_fallbacks=ignore_fallbacks)
1981
2053
        except errors.NoSuchFile:
1982
2054
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1989
2061
    def supports_tags(self):
1990
2062
        return True
1991
2063
 
 
2064
    def supports_leaving_lock(self):
 
2065
        return True
 
2066
 
1992
2067
 
1993
2068
class BzrBranchFormat5(BranchFormatMetadir):
1994
2069
    """Bzr branch format 5.
2014
2089
        """See BranchFormat.get_format_description()."""
2015
2090
        return "Branch format 5"
2016
2091
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
2092
    def initialize(self, a_bzrdir, name=None, repository=None):
2018
2093
        """Create a branch of this format in a_bzrdir."""
2019
2094
        utf8_files = [('revision-history', ''),
2020
2095
                      ('branch-name', ''),
2021
2096
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2097
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2023
2098
 
2024
2099
    def supports_tags(self):
2025
2100
        return False
2047
2122
        """See BranchFormat.get_format_description()."""
2048
2123
        return "Branch format 6"
2049
2124
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
2125
    def initialize(self, a_bzrdir, name=None, repository=None):
2051
2126
        """Create a branch of this format in a_bzrdir."""
2052
2127
        utf8_files = [('last-revision', '0 null:\n'),
2053
2128
                      ('branch.conf', ''),
2054
2129
                      ('tags', ''),
2055
2130
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2131
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2057
2132
 
2058
2133
    def make_tags(self, branch):
2059
2134
        """See bzrlib.branch.BranchFormat.make_tags()."""
2077
2152
        """See BranchFormat.get_format_description()."""
2078
2153
        return "Branch format 8"
2079
2154
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
2155
    def initialize(self, a_bzrdir, name=None, repository=None):
2081
2156
        """Create a branch of this format in a_bzrdir."""
2082
2157
        utf8_files = [('last-revision', '0 null:\n'),
2083
2158
                      ('branch.conf', ''),
2084
2159
                      ('tags', ''),
2085
2160
                      ('references', '')
2086
2161
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2162
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2088
2163
 
2089
2164
    def __init__(self):
2090
2165
        super(BzrBranchFormat8, self).__init__()
2113
2188
    This format was introduced in bzr 1.6.
2114
2189
    """
2115
2190
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
2191
    def initialize(self, a_bzrdir, name=None, repository=None):
2117
2192
        """Create a branch of this format in a_bzrdir."""
2118
2193
        utf8_files = [('last-revision', '0 null:\n'),
2119
2194
                      ('branch.conf', ''),
2120
2195
                      ('tags', ''),
2121
2196
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2197
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2123
2198
 
2124
2199
    def _branch_class(self):
2125
2200
        return BzrBranch7
2157
2232
        """See BranchFormat.get_format_description()."""
2158
2233
        return "Checkout reference format 1"
2159
2234
 
2160
 
    def get_reference(self, a_bzrdir):
 
2235
    def get_reference(self, a_bzrdir, name=None):
2161
2236
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2237
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2238
        return transport.get_bytes('location')
2164
2239
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2240
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2241
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2242
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2243
        location = transport.put_bytes('location', to_branch.base)
2169
2244
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2245
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2246
            repository=None):
2171
2247
        """Create a branch of this format in a_bzrdir."""
2172
2248
        if target_branch is None:
2173
2249
            # this format does not implement branch itself, thus the implicit
2201
2277
        return clone
2202
2278
 
2203
2279
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
2280
             possible_transports=None, ignore_fallbacks=False,
 
2281
             found_repository=None):
2205
2282
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2283
 
2207
2284
        :param a_bzrdir: A BzrDir that contains a branch.
2221
2298
                raise AssertionError("wrong format %r found for %r" %
2222
2299
                    (format, self))
2223
2300
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
 
2301
            location = self.get_reference(a_bzrdir, name)
2225
2302
        real_bzrdir = bzrdir.BzrDir.open(
2226
2303
            location, possible_transports=possible_transports)
2227
2304
        result = real_bzrdir.open_branch(name=name, 
2238
2315
        return result
2239
2316
 
2240
2317
 
 
2318
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2319
    """Branch format registry."""
 
2320
 
 
2321
    def __init__(self, other_registry=None):
 
2322
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2323
        self._default_format = None
 
2324
 
 
2325
    def set_default(self, format):
 
2326
        self._default_format = format
 
2327
 
 
2328
    def get_default(self):
 
2329
        return self._default_format
 
2330
 
 
2331
 
2241
2332
network_format_registry = registry.FormatRegistry()
2242
2333
"""Registry of formats indexed by their network name.
2243
2334
 
2246
2337
BranchFormat.network_name() for more detail.
2247
2338
"""
2248
2339
 
 
2340
format_registry = BranchFormatRegistry(network_format_registry)
 
2341
 
2249
2342
 
2250
2343
# formats which have no format string are not discoverable
2251
2344
# and not independently creatable, so are not registered.
2253
2346
__format6 = BzrBranchFormat6()
2254
2347
__format7 = BzrBranchFormat7()
2255
2348
__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__)
 
2349
format_registry.register(__format5)
 
2350
format_registry.register(BranchReferenceFormat())
 
2351
format_registry.register(__format6)
 
2352
format_registry.register(__format7)
 
2353
format_registry.register(__format8)
 
2354
format_registry.set_default(__format7)
 
2355
 
 
2356
 
 
2357
class BranchWriteLockResult(LogicalLockResult):
 
2358
    """The result of write locking a branch.
 
2359
 
 
2360
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2361
        None.
 
2362
    :ivar unlock: A callable which will unlock the lock.
 
2363
    """
 
2364
 
 
2365
    def __init__(self, unlock, branch_token):
 
2366
        LogicalLockResult.__init__(self, unlock)
 
2367
        self.branch_token = branch_token
 
2368
 
 
2369
    def __repr__(self):
 
2370
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2371
            self.unlock)
2266
2372
 
2267
2373
 
2268
2374
class BzrBranch(Branch, _RelockDebugMixin):
2324
2430
        return self.control_files.is_locked()
2325
2431
 
2326
2432
    def lock_write(self, token=None):
 
2433
        """Lock the branch for write operations.
 
2434
 
 
2435
        :param token: A token to permit reacquiring a previously held and
 
2436
            preserved lock.
 
2437
        :return: A BranchWriteLockResult.
 
2438
        """
2327
2439
        if not self.is_locked():
2328
2440
            self._note_lock('w')
2329
2441
        # All-in-one needs to always unlock/lock.
2335
2447
        else:
2336
2448
            took_lock = False
2337
2449
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2450
            return BranchWriteLockResult(self.unlock,
 
2451
                self.control_files.lock_write(token=token))
2339
2452
        except:
2340
2453
            if took_lock:
2341
2454
                self.repository.unlock()
2342
2455
            raise
2343
2456
 
2344
2457
    def lock_read(self):
 
2458
        """Lock the branch for read operations.
 
2459
 
 
2460
        :return: A bzrlib.lock.LogicalLockResult.
 
2461
        """
2345
2462
        if not self.is_locked():
2346
2463
            self._note_lock('r')
2347
2464
        # All-in-one needs to always unlock/lock.
2354
2471
            took_lock = False
2355
2472
        try:
2356
2473
            self.control_files.lock_read()
 
2474
            return LogicalLockResult(self.unlock)
2357
2475
        except:
2358
2476
            if took_lock:
2359
2477
                self.repository.unlock()
2515
2633
        result.target_branch = target
2516
2634
        result.old_revno, result.old_revid = target.last_revision_info()
2517
2635
        self.update_references(target)
2518
 
        if result.old_revid != self.last_revision():
 
2636
        if result.old_revid != stop_revision:
2519
2637
            # We assume that during 'push' this repository is closer than
2520
2638
            # the target.
2521
2639
            graph = self.repository.get_graph(target.repository)
2522
2640
            target.update_revisions(self, stop_revision,
2523
2641
                overwrite=overwrite, graph=graph)
2524
2642
        if self._push_should_merge_tags():
2525
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2526
 
                overwrite)
 
2643
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2527
2644
        result.new_revno, result.new_revid = target.last_revision_info()
2528
2645
        return result
2529
2646
 
2561
2678
        """Return the branch we are bound to.
2562
2679
 
2563
2680
        :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
2681
        """
 
2682
        if self._master_branch_cache is None:
 
2683
            self._master_branch_cache = self._get_master_branch(
 
2684
                possible_transports)
 
2685
        return self._master_branch_cache
 
2686
 
 
2687
    def _get_master_branch(self, possible_transports):
2570
2688
        bound_loc = self.get_bound_location()
2571
2689
        if not bound_loc:
2572
2690
            return None
2583
2701
 
2584
2702
        :param location: URL to the target branch
2585
2703
        """
 
2704
        self._master_branch_cache = None
2586
2705
        if location:
2587
2706
            self._transport.put_bytes('bound', location+'\n',
2588
2707
                mode=self.bzrdir._get_file_mode())
2840
2959
 
2841
2960
    def set_bound_location(self, location):
2842
2961
        """See Branch.set_push_location."""
 
2962
        self._master_branch_cache = None
2843
2963
        result = None
2844
2964
        config = self.get_config()
2845
2965
        if location is None:
2922
3042
        try:
2923
3043
            index = self._partial_revision_history_cache.index(revision_id)
2924
3044
        except ValueError:
2925
 
            self._extend_partial_history(stop_revision=revision_id)
 
3045
            try:
 
3046
                self._extend_partial_history(stop_revision=revision_id)
 
3047
            except errors.RevisionNotPresent, e:
 
3048
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2926
3049
            index = len(self._partial_revision_history_cache) - 1
2927
3050
            if self._partial_revision_history_cache[index] != revision_id:
2928
3051
                raise errors.NoSuchRevision(self, revision_id)
2983
3106
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2984
3107
    """
2985
3108
 
 
3109
    @deprecated_method(deprecated_in((2, 3, 0)))
2986
3110
    def __int__(self):
2987
 
        # DEPRECATED: pull used to return the change in revno
 
3111
        """Return the relative change in revno.
 
3112
 
 
3113
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3114
        """
2988
3115
        return self.new_revno - self.old_revno
2989
3116
 
2990
3117
    def report(self, to_file):
3015
3142
        target, otherwise it will be None.
3016
3143
    """
3017
3144
 
 
3145
    @deprecated_method(deprecated_in((2, 3, 0)))
3018
3146
    def __int__(self):
3019
 
        # DEPRECATED: push used to return the change in revno
 
3147
        """Return the relative change in revno.
 
3148
 
 
3149
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3150
        """
3020
3151
        return self.new_revno - self.old_revno
3021
3152
 
3022
3153
    def report(self, to_file):
3145
3276
    _optimisers = []
3146
3277
    """The available optimised InterBranch types."""
3147
3278
 
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)
 
3279
    @classmethod
 
3280
    def _get_branch_formats_to_test(klass):
 
3281
        """Return an iterable of format tuples for testing.
 
3282
        
 
3283
        :return: An iterable of (from_format, to_format) to use when testing
 
3284
            this InterBranch class. Each InterBranch class should define this
 
3285
            method itself.
 
3286
        """
 
3287
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3288
 
 
3289
    @needs_write_lock
3153
3290
    def pull(self, overwrite=False, stop_revision=None,
3154
3291
             possible_transports=None, local=False):
3155
3292
        """Mirror source into target branch.
3160
3297
        """
3161
3298
        raise NotImplementedError(self.pull)
3162
3299
 
 
3300
    @needs_write_lock
3163
3301
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
 
                         graph=None):
 
3302
                         graph=None, fetch_tags=True):
3165
3303
        """Pull in new perfect-fit revisions.
3166
3304
 
3167
3305
        :param stop_revision: Updated until the given revision
3169
3307
            to see if it is a proper descendant.
3170
3308
        :param graph: A Graph object that can be used to query history
3171
3309
            information. This can be None.
 
3310
        :param fetch_tags: Flag that specifies if tags from source should be
 
3311
            fetched too.
3172
3312
        :return: None
3173
3313
        """
3174
3314
        raise NotImplementedError(self.update_revisions)
3175
3315
 
 
3316
    @needs_write_lock
3176
3317
    def push(self, overwrite=False, stop_revision=None,
3177
3318
             _override_hook_source_branch=None):
3178
3319
        """Mirror the source branch into the target branch.
3181
3322
        """
3182
3323
        raise NotImplementedError(self.push)
3183
3324
 
 
3325
    @needs_write_lock
 
3326
    def copy_content_into(self, revision_id=None):
 
3327
        """Copy the content of source into target
 
3328
 
 
3329
        revision_id: if not None, the revision history in the new branch will
 
3330
                     be truncated to end with revision_id.
 
3331
        """
 
3332
        raise NotImplementedError(self.copy_content_into)
 
3333
 
3184
3334
 
3185
3335
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
 
 
 
3336
    """InterBranch implementation that uses public Branch functions."""
 
3337
 
 
3338
    @classmethod
 
3339
    def is_compatible(klass, source, target):
 
3340
        # GenericBranch uses the public API, so always compatible
 
3341
        return True
 
3342
 
 
3343
    @classmethod
 
3344
    def _get_branch_formats_to_test(klass):
 
3345
        return [(format_registry.get_default(), format_registry.get_default())]
 
3346
 
 
3347
    @classmethod
 
3348
    def unwrap_format(klass, format):
 
3349
        if isinstance(format, remote.RemoteBranchFormat):
 
3350
            format._ensure_real()
 
3351
            return format._custom_format
 
3352
        return format
 
3353
 
 
3354
    @needs_write_lock
 
3355
    def copy_content_into(self, revision_id=None):
 
3356
        """Copy the content of source into target
 
3357
 
 
3358
        revision_id: if not None, the revision history in the new branch will
 
3359
                     be truncated to end with revision_id.
 
3360
        """
 
3361
        self.source.update_references(self.target)
 
3362
        self.source._synchronize_history(self.target, revision_id)
 
3363
        try:
 
3364
            parent = self.source.get_parent()
 
3365
        except errors.InaccessibleParent, e:
 
3366
            mutter('parent was not accessible to copy: %s', e)
 
3367
        else:
 
3368
            if parent:
 
3369
                self.target.set_parent(parent)
 
3370
        if self.source._push_should_merge_tags():
 
3371
            self.source.tags.merge_to(self.target.tags)
 
3372
 
 
3373
    @needs_write_lock
3193
3374
    def update_revisions(self, stop_revision=None, overwrite=False,
3194
 
        graph=None):
 
3375
        graph=None, fetch_tags=True):
3195
3376
        """See InterBranch.update_revisions()."""
3196
 
        self.source.lock_read()
3197
 
        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)
3233
 
        finally:
3234
 
            self.source.unlock()
3235
 
 
 
3377
        other_revno, other_last_revision = self.source.last_revision_info()
 
3378
        stop_revno = None # unknown
 
3379
        if stop_revision is None:
 
3380
            stop_revision = other_last_revision
 
3381
            if _mod_revision.is_null(stop_revision):
 
3382
                # if there are no commits, we're done.
 
3383
                return
 
3384
            stop_revno = other_revno
 
3385
 
 
3386
        # what's the current last revision, before we fetch [and change it
 
3387
        # possibly]
 
3388
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3389
        # we fetch here so that we don't process data twice in the common
 
3390
        # case of having something to pull, and so that the check for
 
3391
        # already merged can operate on the just fetched graph, which will
 
3392
        # be cached in memory.
 
3393
        if fetch_tags:
 
3394
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3395
            fetch_spec_factory.source_branch = self.source
 
3396
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3397
            fetch_spec_factory.source_repo = self.source.repository
 
3398
            fetch_spec_factory.target_repo = self.target.repository
 
3399
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3400
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3401
        else:
 
3402
            fetch_spec = _mod_graph.NotInOtherForRevs(self.target.repository,
 
3403
                self.source.repository, revision_ids=[stop_revision]).execute()
 
3404
        self.target.fetch(self.source, fetch_spec=fetch_spec)
 
3405
        # Check to see if one is an ancestor of the other
 
3406
        if not overwrite:
 
3407
            if graph is None:
 
3408
                graph = self.target.repository.get_graph()
 
3409
            if self.target._check_if_descendant_or_diverged(
 
3410
                    stop_revision, last_rev, graph, self.source):
 
3411
                # stop_revision is a descendant of last_rev, but we aren't
 
3412
                # overwriting, so we're done.
 
3413
                return
 
3414
        if stop_revno is None:
 
3415
            if graph is None:
 
3416
                graph = self.target.repository.get_graph()
 
3417
            this_revno, this_last_revision = \
 
3418
                    self.target.last_revision_info()
 
3419
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3420
                            [(other_last_revision, other_revno),
 
3421
                             (this_last_revision, this_revno)])
 
3422
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3423
 
 
3424
    @needs_write_lock
3236
3425
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3426
             possible_transports=None, run_hooks=True,
3238
3427
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
 
3428
        """Pull from source into self, updating my master if any.
3240
3429
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
3430
        :param run_hooks: Private parameter - if false, this branch
3244
3431
            is being called because it's the master of the primary branch,
3245
3432
            so it should not run its hooks.
3246
 
        :param _override_hook_target: Private parameter - set the branch to be
3247
 
            supplied as the target_branch to pull hooks.
3248
 
        :param local: Only update the local branch, and not the bound branch.
3249
3433
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
 
3434
        bound_location = self.target.get_bound_location()
 
3435
        if local and not bound_location:
3252
3436
            raise errors.LocalRequiresBoundBranch()
3253
 
        result = PullResult()
3254
 
        result.source_branch = self.source
3255
 
        if _override_hook_target is None:
3256
 
            result.target_branch = self.target
3257
 
        else:
3258
 
            result.target_branch = _override_hook_target
3259
 
        self.source.lock_read()
 
3437
        master_branch = None
 
3438
        source_is_master = (self.source.user_url == bound_location)
 
3439
        if not local and bound_location and not source_is_master:
 
3440
            # not pulling from master, so we need to update master.
 
3441
            master_branch = self.target.get_master_branch(possible_transports)
 
3442
            master_branch.lock_write()
3260
3443
        try:
3261
 
            # We assume that during 'pull' the target repository is closer than
3262
 
            # the source one.
3263
 
            self.source.update_references(self.target)
3264
 
            graph = self.target.repository.get_graph(self.source.repository)
3265
 
            # TODO: Branch formats should have a flag that indicates 
3266
 
            # that revno's are expensive, and pull() should honor that flag.
3267
 
            # -- JRV20090506
3268
 
            result.old_revno, result.old_revid = \
3269
 
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
3272
 
            # TODO: The old revid should be specified when merging tags, 
3273
 
            # so a tags implementation that versions tags can only 
3274
 
            # pull in the most recent changes. -- JRV20090506
3275
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
3277
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
 
            if _hook_master:
3279
 
                result.master_branch = _hook_master
3280
 
                result.local_branch = result.target_branch
3281
 
            else:
3282
 
                result.master_branch = result.target_branch
3283
 
                result.local_branch = None
3284
 
            if run_hooks:
3285
 
                for hook in Branch.hooks['post_pull']:
3286
 
                    hook(result)
 
3444
            if master_branch:
 
3445
                # pull from source into master.
 
3446
                master_branch.pull(self.source, overwrite, stop_revision,
 
3447
                    run_hooks=False)
 
3448
            return self._pull(overwrite,
 
3449
                stop_revision, _hook_master=master_branch,
 
3450
                run_hooks=run_hooks,
 
3451
                _override_hook_target=_override_hook_target,
 
3452
                merge_tags_to_master=not source_is_master)
3287
3453
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
 
3454
            if master_branch:
 
3455
                master_branch.unlock()
3290
3456
 
3291
3457
    def push(self, overwrite=False, stop_revision=None,
3292
3458
             _override_hook_source_branch=None):
3332
3498
                # push into the master from the source branch.
3333
3499
                self.source._basic_push(master_branch, overwrite, stop_revision)
3334
3500
                # and push into the target branch from the source. Note that we
3335
 
                # push from the source branch again, because its considered the
 
3501
                # push from the source branch again, because it's considered the
3336
3502
                # highest bandwidth repository.
3337
3503
                result = self.source._basic_push(self.target, overwrite,
3338
3504
                    stop_revision)
3354
3520
            _run_hooks()
3355
3521
            return result
3356
3522
 
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
 
 
 
3523
    def _pull(self, overwrite=False, stop_revision=None,
 
3524
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3525
             _override_hook_target=None, local=False,
 
3526
             merge_tags_to_master=True):
 
3527
        """See Branch.pull.
 
3528
 
 
3529
        This function is the core worker, used by GenericInterBranch.pull to
 
3530
        avoid duplication when pulling source->master and source->local.
 
3531
 
 
3532
        :param _hook_master: Private parameter - set the branch to
 
3533
            be supplied as the master to pull hooks.
3374
3534
        :param run_hooks: Private parameter - if false, this branch
3375
3535
            is being called because it's the master of the primary branch,
3376
3536
            so it should not run its hooks.
 
3537
            is being called because it's the master of the primary branch,
 
3538
            so it should not run its hooks.
 
3539
        :param _override_hook_target: Private parameter - set the branch to be
 
3540
            supplied as the target_branch to pull hooks.
 
3541
        :param local: Only update the local branch, and not the bound branch.
3377
3542
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
 
3543
        # This type of branch can't be bound.
 
3544
        if local:
3380
3545
            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()
 
3546
        result = PullResult()
 
3547
        result.source_branch = self.source
 
3548
        if _override_hook_target is None:
 
3549
            result.target_branch = self.target
 
3550
        else:
 
3551
            result.target_branch = _override_hook_target
 
3552
        self.source.lock_read()
3386
3553
        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)
 
3554
            # We assume that during 'pull' the target repository is closer than
 
3555
            # the source one.
 
3556
            self.source.update_references(self.target)
 
3557
            graph = self.target.repository.get_graph(self.source.repository)
 
3558
            # TODO: Branch formats should have a flag that indicates 
 
3559
            # that revno's are expensive, and pull() should honor that flag.
 
3560
            # -- JRV20090506
 
3561
            result.old_revno, result.old_revid = \
 
3562
                self.target.last_revision_info()
 
3563
            self.target.update_revisions(self.source, stop_revision,
 
3564
                overwrite=overwrite, graph=graph)
 
3565
            # TODO: The old revid should be specified when merging tags, 
 
3566
            # so a tags implementation that versions tags can only 
 
3567
            # pull in the most recent changes. -- JRV20090506
 
3568
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3569
                overwrite, ignore_master=not merge_tags_to_master)
 
3570
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3571
            if _hook_master:
 
3572
                result.master_branch = _hook_master
 
3573
                result.local_branch = result.target_branch
 
3574
            else:
 
3575
                result.master_branch = result.target_branch
 
3576
                result.local_branch = None
 
3577
            if run_hooks:
 
3578
                for hook in Branch.hooks['post_pull']:
 
3579
                    hook(result)
3395
3580
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
 
3581
            self.source.unlock()
 
3582
        return result
3398
3583
 
3399
3584
 
3400
3585
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)