/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: Martin Pool
  • Date: 2011-04-19 03:23:05 UTC
  • mto: This revision was merged to the branch mainline in revision 5802.
  • Revision ID: mbp@sourcefrog.net-20110419032305-6qzm1yo30x56dnu2
Fix slightly broken test

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,
39
42
        urlutils,
40
43
        )
41
44
from bzrlib.config import BranchConfig, TransportConfig
42
 
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
45
from bzrlib.tag import (
44
46
    BasicTags,
45
47
    DisabledTags,
46
48
    )
47
49
""")
48
50
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
 
from bzrlib.hooks import HookPoint, Hooks
 
51
from bzrlib import (
 
52
    controldir,
 
53
    )
 
54
from bzrlib.decorators import (
 
55
    needs_read_lock,
 
56
    needs_write_lock,
 
57
    only_raises,
 
58
    )
 
59
from bzrlib.hooks import Hooks
51
60
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
 
61
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
62
from bzrlib import registry
54
63
from bzrlib.symbol_versioning import (
55
64
    deprecated_in,
63
72
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
73
 
65
74
 
66
 
class Branch(bzrdir.ControlComponent):
 
75
class Branch(controldir.ControlComponent):
67
76
    """Branch holding a history of revisions.
68
77
 
69
78
    :ivar base:
70
79
        Base directory/url of the branch; using control_url and
71
80
        control_transport is more standardized.
72
 
 
73
 
    hooks: An instance of BranchHooks.
 
81
    :ivar hooks: An instance of BranchHooks.
 
82
    :ivar _master_branch_cache: cached result of get_master_branch, see
 
83
        _clear_cached_state.
74
84
    """
75
85
    # this is really an instance variable - FIXME move it there
76
86
    # - RBC 20060112
90
100
        self._revision_id_to_revno_cache = None
91
101
        self._partial_revision_id_to_revno_cache = {}
92
102
        self._partial_revision_history_cache = []
 
103
        self._tags_bytes = None
93
104
        self._last_revision_info_cache = None
 
105
        self._master_branch_cache = None
94
106
        self._merge_sorted_revisions_cache = None
95
107
        self._open_hook()
96
108
        hooks = Branch.hooks['open']
102
114
 
103
115
    def _activate_fallback_location(self, url):
104
116
        """Activate the branch/repository from url as a fallback repository."""
 
117
        for existing_fallback_repo in self.repository._fallback_repositories:
 
118
            if existing_fallback_repo.user_url == url:
 
119
                # This fallback is already configured.  This probably only
 
120
                # happens because BzrDir.sprout is a horrible mess.  To avoid
 
121
                # confusing _unstack we don't add this a second time.
 
122
                mutter('duplicate activation of fallback %r on %r', url, self)
 
123
                return
105
124
        repo = self._get_fallback_repository(url)
106
125
        if repo.has_same_location(self.repository):
107
126
            raise errors.UnstackableLocationError(self.user_url, url)
197
216
        return self.supports_tags() and self.tags.get_tag_dict()
198
217
 
199
218
    def get_config(self):
 
219
        """Get a bzrlib.config.BranchConfig for this Branch.
 
220
 
 
221
        This can then be used to get and set configuration options for the
 
222
        branch.
 
223
 
 
224
        :return: A bzrlib.config.BranchConfig.
 
225
        """
200
226
        return BranchConfig(self)
201
227
 
202
228
    def _get_config(self):
218
244
            possible_transports=[self.bzrdir.root_transport])
219
245
        return a_branch.repository
220
246
 
 
247
    @needs_read_lock
221
248
    def _get_tags_bytes(self):
222
249
        """Get the bytes of a serialised tags dict.
223
250
 
230
257
        :return: The bytes of the tags file.
231
258
        :seealso: Branch._set_tags_bytes.
232
259
        """
233
 
        return self._transport.get_bytes('tags')
 
260
        if self._tags_bytes is None:
 
261
            self._tags_bytes = self._transport.get_bytes('tags')
 
262
        return self._tags_bytes
234
263
 
235
264
    def _get_nick(self, local=False, possible_transports=None):
236
265
        config = self.get_config()
238
267
        if not local and not config.has_explicit_nickname():
239
268
            try:
240
269
                master = self.get_master_branch(possible_transports)
 
270
                if master and self.user_url == master.user_url:
 
271
                    raise errors.RecursiveBind(self.user_url)
241
272
                if master is not None:
242
273
                    # return the master branch value
243
274
                    return master.nick
 
275
            except errors.RecursiveBind, e:
 
276
                raise e
244
277
            except errors.BzrError, e:
245
278
                # Silently fall back to local implicit nick if the master is
246
279
                # unavailable
283
316
        new_history.reverse()
284
317
        return new_history
285
318
 
286
 
    def lock_write(self):
 
319
    def lock_write(self, token=None):
 
320
        """Lock the branch for write operations.
 
321
 
 
322
        :param token: A token to permit reacquiring a previously held and
 
323
            preserved lock.
 
324
        :return: A BranchWriteLockResult.
 
325
        """
287
326
        raise NotImplementedError(self.lock_write)
288
327
 
289
328
    def lock_read(self):
 
329
        """Lock the branch for read operations.
 
330
 
 
331
        :return: A bzrlib.lock.LogicalLockResult.
 
332
        """
290
333
        raise NotImplementedError(self.lock_read)
291
334
 
292
335
    def unlock(self):
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, fetch_spec=None):
630
673
        """Copy revisions from from_branch into this branch.
631
674
 
632
675
        :param from_branch: Where to copy from.
633
676
        :param last_revision: What revision to stop at (None for at the end
634
677
                              of the branch.
635
 
        :param pb: An optional progress bar to use.
 
678
        :param fetch_spec: If specified, a SearchResult or
 
679
            PendingAncestryResult that describes which revisions to copy.  This
 
680
            allows copying multiple heads at once.  Mutually exclusive with
 
681
            last_revision.
636
682
        :return: None
637
683
        """
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()
 
684
        return InterBranch.get(from_branch, self).fetch(last_revision,
 
685
            fetch_spec)
654
686
 
655
687
    def get_bound_location(self):
656
688
        """Return the URL of the branch we are bound to.
767
799
 
768
800
    def _unstack(self):
769
801
        """Change a branch to be unstacked, copying data as needed.
770
 
        
 
802
 
771
803
        Don't call this directly, use set_stacked_on_url(None).
772
804
        """
773
805
        pb = ui.ui_factory.nested_progress_bar()
782
814
            old_repository = self.repository
783
815
            if len(old_repository._fallback_repositories) != 1:
784
816
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
 
817
                    "of %r (fallbacks: %r)" % (old_repository,
 
818
                        old_repository._fallback_repositories))
 
819
            # Open the new repository object.
 
820
            # Repositories don't offer an interface to remove fallback
 
821
            # repositories today; take the conceptually simpler option and just
 
822
            # reopen it.  We reopen it starting from the URL so that we
 
823
            # get a separate connection for RemoteRepositories and can
 
824
            # stream from one of them to the other.  This does mean doing
 
825
            # separate SSH connection setup, but unstacking is not a
 
826
            # common operation so it's tolerable.
 
827
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
828
            new_repository = new_bzrdir.find_repository()
 
829
            if new_repository._fallback_repositories:
 
830
                raise AssertionError("didn't expect %r to have "
 
831
                    "fallback_repositories"
 
832
                    % (self.repository,))
 
833
            # Replace self.repository with the new repository.
 
834
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
835
            # lock count) of self.repository to the new repository.
 
836
            lock_token = old_repository.lock_write().repository_token
 
837
            self.repository = new_repository
 
838
            if isinstance(self, remote.RemoteBranch):
 
839
                # Remote branches can have a second reference to the old
 
840
                # repository that need to be replaced.
 
841
                if self._real_branch is not None:
 
842
                    self._real_branch.repository = new_repository
 
843
            self.repository.lock_write(token=lock_token)
 
844
            if lock_token is not None:
 
845
                old_repository.leave_lock_in_place()
787
846
            old_repository.unlock()
 
847
            if lock_token is not None:
 
848
                # XXX: self.repository.leave_lock_in_place() before this
 
849
                # function will not be preserved.  Fortunately that doesn't
 
850
                # affect the current default format (2a), and would be a
 
851
                # corner-case anyway.
 
852
                #  - Andrew Bennetts, 2010/06/30
 
853
                self.repository.dont_leave_lock_in_place()
 
854
            old_lock_count = 0
 
855
            while True:
 
856
                try:
 
857
                    old_repository.unlock()
 
858
                except errors.LockNotHeld:
 
859
                    break
 
860
                old_lock_count += 1
 
861
            if old_lock_count == 0:
 
862
                raise AssertionError(
 
863
                    'old_repository should have been locked at least once.')
 
864
            for i in range(old_lock_count-1):
 
865
                self.repository.lock_write()
 
866
            # Fetch from the old repository into the new.
788
867
            old_repository.lock_read()
789
868
            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
869
                # XXX: If you unstack a branch while it has a working tree
809
870
                # with a pending merge, the pending-merged revisions will no
810
871
                # 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)
 
872
                try:
 
873
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
874
                except errors.TagsNotSupported:
 
875
                    tags_to_fetch = set()
 
876
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
877
                    old_repository, required_ids=[self.last_revision()],
 
878
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
879
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
818
880
            finally:
819
881
                old_repository.unlock()
820
882
        finally:
825
887
 
826
888
        :seealso: Branch._get_tags_bytes.
827
889
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
890
        return _run_with_write_locked_target(self, self._set_tags_bytes_locked,
 
891
                bytes)
 
892
 
 
893
    def _set_tags_bytes_locked(self, bytes):
 
894
        self._tags_bytes = bytes
 
895
        return self._transport.put_bytes('tags', bytes)
830
896
 
831
897
    def _cache_revision_history(self, rev_history):
832
898
        """Set the cached revision history to rev_history.
859
925
        self._revision_history_cache = None
860
926
        self._revision_id_to_revno_cache = None
861
927
        self._last_revision_info_cache = None
 
928
        self._master_branch_cache = None
862
929
        self._merge_sorted_revisions_cache = None
863
930
        self._partial_revision_history_cache = []
864
931
        self._partial_revision_id_to_revno_cache = {}
 
932
        self._tags_bytes = None
865
933
 
866
934
    def _gen_revision_history(self):
867
935
        """Return sequence of revision hashes on to this branch.
928
996
        else:
929
997
            return (0, _mod_revision.NULL_REVISION)
930
998
 
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
999
    def update_revisions(self, other, stop_revision=None, overwrite=False,
956
 
                         graph=None):
 
1000
                         graph=None, fetch_tags=True):
957
1001
        """Pull in new perfect-fit revisions.
958
1002
 
959
1003
        :param other: Another Branch to pull from
962
1006
            to see if it is a proper descendant.
963
1007
        :param graph: A Graph object that can be used to query history
964
1008
            information. This can be None.
 
1009
        :param fetch_tags: Flag that specifies if tags from other should be
 
1010
            fetched too.
965
1011
        :return: None
966
1012
        """
967
1013
        return InterBranch.get(other, self).update_revisions(stop_revision,
968
 
            overwrite, graph)
 
1014
            overwrite, graph, fetch_tags=fetch_tags)
969
1015
 
 
1016
    @deprecated_method(deprecated_in((2, 4, 0)))
970
1017
    def import_last_revision_info(self, source_repo, revno, revid):
971
1018
        """Set the last revision info, importing from another repo if necessary.
972
1019
 
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
1020
        :param source_repo: Source repository to optionally fetch from
977
1021
        :param revno: Revision number of the new tip
978
1022
        :param revid: Revision id of the new tip
981
1025
            self.repository.fetch(source_repo, revision_id=revid)
982
1026
        self.set_last_revision_info(revno, revid)
983
1027
 
 
1028
    def import_last_revision_info_and_tags(self, source, revno, revid):
 
1029
        """Set the last revision info, importing from another repo if necessary.
 
1030
 
 
1031
        This is used by the bound branch code to upload a revision to
 
1032
        the master branch first before updating the tip of the local branch.
 
1033
        Revisions referenced by source's tags are also transferred.
 
1034
 
 
1035
        :param source: Source branch to optionally fetch from
 
1036
        :param revno: Revision number of the new tip
 
1037
        :param revid: Revision id of the new tip
 
1038
        """
 
1039
        if not self.repository.has_same_location(source.repository):
 
1040
            try:
 
1041
                tags_to_fetch = set(source.tags.get_reverse_tag_dict())
 
1042
            except errors.TagsNotSupported:
 
1043
                tags_to_fetch = set()
 
1044
            fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
1045
                source.repository, [revid],
 
1046
                if_present_ids=tags_to_fetch).execute()
 
1047
            self.repository.fetch(source.repository, fetch_spec=fetch_spec)
 
1048
        self.set_last_revision_info(revno, revid)
 
1049
 
984
1050
    def revision_id_to_revno(self, revision_id):
985
1051
        """Given a revision id, return its revno"""
986
1052
        if _mod_revision.is_null(revision_id):
1006
1072
            self._extend_partial_history(distance_from_last)
1007
1073
        return self._partial_revision_history_cache[distance_from_last]
1008
1074
 
1009
 
    @needs_write_lock
1010
1075
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1076
             possible_transports=None, *args, **kwargs):
1012
1077
        """Mirror source into this branch.
1208
1273
        return result
1209
1274
 
1210
1275
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1276
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1277
            repository=None):
1212
1278
        """Create a new line of development from the branch, into to_bzrdir.
1213
1279
 
1214
1280
        to_bzrdir controls the branch format.
1219
1285
        if (repository_policy is not None and
1220
1286
            repository_policy.requires_stacking()):
1221
1287
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
 
        result = to_bzrdir.create_branch()
 
1288
        result = to_bzrdir.create_branch(repository=repository)
1223
1289
        result.lock_write()
1224
1290
        try:
1225
1291
            if repository_policy is not None:
1255
1321
                revno = 1
1256
1322
        destination.set_last_revision_info(revno, revision_id)
1257
1323
 
1258
 
    @needs_read_lock
1259
1324
    def copy_content_into(self, destination, revision_id=None):
1260
1325
        """Copy the content of self into destination.
1261
1326
 
1262
1327
        revision_id: if not None, the revision history in the new branch will
1263
1328
                     be truncated to end with revision_id.
1264
1329
        """
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)
 
1330
        return InterBranch.get(self, destination).copy_content_into(
 
1331
            revision_id=revision_id)
1276
1332
 
1277
1333
    def update_references(self, target):
1278
1334
        if not getattr(self._format, 'supports_reference_locations', False):
1323
1379
        """Return the most suitable metadir for a checkout of this branch.
1324
1380
        Weaves are used if this branch's repository uses weaves.
1325
1381
        """
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)
 
1382
        format = self.repository.bzrdir.checkout_metadir()
 
1383
        format.set_branch_format(self._format)
1333
1384
        return format
1334
1385
 
1335
1386
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1387
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1388
        no_tree=None):
1337
1389
        """Create a clone of this branch and its bzrdir.
1338
1390
 
1339
1391
        :param to_transport: The transport to clone onto.
1346
1398
        """
1347
1399
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1400
        # clone call. Or something. 20090224 RBC/spiv.
 
1401
        # XXX: Should this perhaps clone colocated branches as well, 
 
1402
        # rather than just the default branch? 20100319 JRV
1349
1403
        if revision_id is None:
1350
1404
            revision_id = self.last_revision()
1351
1405
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
1406
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1407
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1408
            no_tree=no_tree)
1354
1409
        return dir_to.open_branch()
1355
1410
 
1356
1411
    def create_checkout(self, to_location, revision_id=None,
1471
1526
        else:
1472
1527
            raise AssertionError("invalid heads: %r" % (heads,))
1473
1528
 
1474
 
 
1475
 
class BranchFormat(object):
 
1529
    def heads_to_fetch(self):
 
1530
        """Return the heads that must and that should be fetched to copy this
 
1531
        branch into another repo.
 
1532
 
 
1533
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1534
            set of heads that must be fetched.  if_present_fetch is a set of
 
1535
            heads that must be fetched if present, but no error is necessary if
 
1536
            they are not present.
 
1537
        """
 
1538
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
 
1539
        # are the tags.
 
1540
        must_fetch = set([self.last_revision()])
 
1541
        try:
 
1542
            if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1543
        except errors.TagsNotSupported:
 
1544
            if_present_fetch = set()
 
1545
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1546
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1547
        return must_fetch, if_present_fetch
 
1548
 
 
1549
 
 
1550
class BranchFormat(controldir.ControlComponentFormat):
1476
1551
    """An encapsulation of the initialization and open routines for a format.
1477
1552
 
1478
1553
    Formats provide three things:
1481
1556
     * an open routine.
1482
1557
 
1483
1558
    Formats are placed in an dict by their format string for reference
1484
 
    during branch opening. Its not required that these be instances, they
 
1559
    during branch opening. It's not required that these be instances, they
1485
1560
    can be classes themselves with class methods - it simply depends on
1486
1561
    whether state is needed for a given format or not.
1487
1562
 
1490
1565
    object will be created every time regardless.
1491
1566
    """
1492
1567
 
1493
 
    _default_format = None
1494
 
    """The default format used for new branches."""
1495
 
 
1496
 
    _formats = {}
1497
 
    """The known formats."""
1498
 
 
1499
1568
    can_set_append_revisions_only = True
1500
1569
 
1501
1570
    def __eq__(self, other):
1510
1579
        try:
1511
1580
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
1581
            format_string = transport.get_bytes("format")
1513
 
            return klass._formats[format_string]
 
1582
            return format_registry.get(format_string)
1514
1583
        except errors.NoSuchFile:
1515
1584
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1516
1585
        except KeyError:
1517
1586
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1587
 
1519
1588
    @classmethod
 
1589
    @deprecated_method(deprecated_in((2, 4, 0)))
1520
1590
    def get_default_format(klass):
1521
1591
        """Return the current default format."""
1522
 
        return klass._default_format
1523
 
 
1524
 
    def get_reference(self, a_bzrdir):
 
1592
        return format_registry.get_default()
 
1593
 
 
1594
    @classmethod
 
1595
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1596
    def get_formats(klass):
 
1597
        """Get all the known formats.
 
1598
 
 
1599
        Warning: This triggers a load of all lazy registered formats: do not
 
1600
        use except when that is desireed.
 
1601
        """
 
1602
        return format_registry._get_all()
 
1603
 
 
1604
    def get_reference(self, a_bzrdir, name=None):
1525
1605
        """Get the target reference of the branch in a_bzrdir.
1526
1606
 
1527
1607
        format probing must have been completed before calling
1529
1609
        in a_bzrdir is correct.
1530
1610
 
1531
1611
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1612
        :param name: Name of the colocated branch to fetch
1532
1613
        :return: None if the branch is not a reference branch.
1533
1614
        """
1534
1615
        return None
1535
1616
 
1536
1617
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
 
1618
    def set_reference(self, a_bzrdir, name, to_branch):
1538
1619
        """Set the target reference of the branch in a_bzrdir.
1539
1620
 
1540
1621
        format probing must have been completed before calling
1542
1623
        in a_bzrdir is correct.
1543
1624
 
1544
1625
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1626
        :param name: Name of colocated branch to set, None for default
1545
1627
        :param to_branch: branch that the checkout is to reference
1546
1628
        """
1547
1629
        raise NotImplementedError(self.set_reference)
1562
1644
        for hook in hooks:
1563
1645
            hook(params)
1564
1646
 
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):
 
1647
    def initialize(self, a_bzrdir, name=None, repository=None):
1611
1648
        """Create a branch of this format in a_bzrdir.
1612
1649
        
1613
1650
        :param name: Name of the colocated branch to create.
1647
1684
        """
1648
1685
        raise NotImplementedError(self.network_name)
1649
1686
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1687
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
1688
            found_repository=None):
1651
1689
        """Return the branch object for a_bzrdir
1652
1690
 
1653
1691
        :param a_bzrdir: A BzrDir that contains a branch.
1660
1698
        raise NotImplementedError(self.open)
1661
1699
 
1662
1700
    @classmethod
 
1701
    @deprecated_method(deprecated_in((2, 4, 0)))
1663
1702
    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__)
 
1703
        """Register a metadir format.
 
1704
 
 
1705
        See MetaDirBranchFormatFactory for the ability to register a format
 
1706
        without loading the code the format needs until it is actually used.
 
1707
        """
 
1708
        format_registry.register(format)
1669
1709
 
1670
1710
    @classmethod
 
1711
    @deprecated_method(deprecated_in((2, 4, 0)))
1671
1712
    def set_default_format(klass, format):
1672
 
        klass._default_format = format
 
1713
        format_registry.set_default(format)
1673
1714
 
1674
1715
    def supports_set_append_revisions_only(self):
1675
1716
        """True if this format supports set_append_revisions_only."""
1679
1720
        """True if this format records a stacked-on branch."""
1680
1721
        return False
1681
1722
 
 
1723
    def supports_leaving_lock(self):
 
1724
        """True if this format supports leaving locks in place."""
 
1725
        return False # by default
 
1726
 
1682
1727
    @classmethod
 
1728
    @deprecated_method(deprecated_in((2, 4, 0)))
1683
1729
    def unregister_format(klass, format):
1684
 
        del klass._formats[format.get_format_string()]
 
1730
        format_registry.remove(format)
1685
1731
 
1686
1732
    def __str__(self):
1687
1733
        return self.get_format_description().rstrip()
1691
1737
        return False  # by default
1692
1738
 
1693
1739
 
 
1740
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1741
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1742
    
 
1743
    While none of the built in BranchFormats are lazy registered yet,
 
1744
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1745
    use it, and the bzr-loom plugin uses it as well (see
 
1746
    bzrlib.plugins.loom.formats).
 
1747
    """
 
1748
 
 
1749
    def __init__(self, format_string, module_name, member_name):
 
1750
        """Create a MetaDirBranchFormatFactory.
 
1751
 
 
1752
        :param format_string: The format string the format has.
 
1753
        :param module_name: Module to load the format class from.
 
1754
        :param member_name: Attribute name within the module for the format class.
 
1755
        """
 
1756
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1757
        self._format_string = format_string
 
1758
        
 
1759
    def get_format_string(self):
 
1760
        """See BranchFormat.get_format_string."""
 
1761
        return self._format_string
 
1762
 
 
1763
    def __call__(self):
 
1764
        """Used for network_format_registry support."""
 
1765
        return self.get_obj()()
 
1766
 
 
1767
 
1694
1768
class BranchHooks(Hooks):
1695
1769
    """A dictionary mapping hook name to a list of callables for branch hooks.
1696
1770
 
1704
1778
        These are all empty initially, because by default nothing should get
1705
1779
        notified.
1706
1780
        """
1707
 
        Hooks.__init__(self)
1708
 
        self.create_hook(HookPoint('set_rh',
 
1781
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1782
        self.add_hook('set_rh',
1709
1783
            "Invoked whenever the revision history has been set via "
1710
1784
            "set_revision_history. The api signature is (branch, "
1711
1785
            "revision_history), and the branch will be write-locked. "
1712
1786
            "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',
 
1787
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
 
1788
        self.add_hook('open',
1715
1789
            "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',
 
1790
            "branch is opened.", (1, 8))
 
1791
        self.add_hook('post_push',
1718
1792
            "Called after a push operation completes. post_push is called "
1719
1793
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
 
            "bzr client.", (0, 15), None))
1721
 
        self.create_hook(HookPoint('post_pull',
 
1794
            "bzr client.", (0, 15))
 
1795
        self.add_hook('post_pull',
1722
1796
            "Called after a pull operation completes. post_pull is called "
1723
1797
            "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 "
 
1798
            "bzr client.", (0, 15))
 
1799
        self.add_hook('pre_commit',
 
1800
            "Called after a commit is calculated but before it is "
1727
1801
            "completed. pre_commit is called with (local, master, old_revno, "
1728
1802
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
1803
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1731
1805
            "basis revision. hooks MUST NOT modify this delta. "
1732
1806
            " future_tree is an in-memory tree obtained from "
1733
1807
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
 
            "tree.", (0,91), None))
1735
 
        self.create_hook(HookPoint('post_commit',
 
1808
            "tree.", (0,91))
 
1809
        self.add_hook('post_commit',
1736
1810
            "Called in the bzr client after a commit has completed. "
1737
1811
            "post_commit is called with (local, master, old_revno, old_revid, "
1738
1812
            "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',
 
1813
            "commit to a branch.", (0, 15))
 
1814
        self.add_hook('post_uncommit',
1741
1815
            "Called in the bzr client after an uncommit completes. "
1742
1816
            "post_uncommit is called with (local, master, old_revno, "
1743
1817
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
1818
            "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',
 
1819
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1820
        self.add_hook('pre_change_branch_tip',
1747
1821
            "Called in bzr client and server before a change to the tip of a "
1748
1822
            "branch is made. pre_change_branch_tip is called with a "
1749
1823
            "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',
 
1824
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1825
        self.add_hook('post_change_branch_tip',
1752
1826
            "Called in bzr client and server after a change to the tip of a "
1753
1827
            "branch is made. post_change_branch_tip is called with a "
1754
1828
            "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',
 
1829
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1830
        self.add_hook('transform_fallback_location',
1757
1831
            "Called when a stacked branch is activating its fallback "
1758
1832
            "locations. transform_fallback_location is called with (branch, "
1759
1833
            "url), and should return a new url. Returning the same url "
1764
1838
            "fallback locations have not been activated. When there are "
1765
1839
            "multiple hooks installed for transform_fallback_location, "
1766
1840
            "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."
 
1841
            "The order is however undefined.", (1, 9))
 
1842
        self.add_hook('automatic_tag_name',
 
1843
            "Called to determine an automatic tag name for a revision. "
1770
1844
            "automatic_tag_name is called with (branch, revision_id) and "
1771
1845
            "should return a tag name or None if no tag name could be "
1772
1846
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
 
1847
            (2, 2))
 
1848
        self.add_hook('post_branch_init',
1775
1849
            "Called after new branch initialization completes. "
1776
1850
            "post_branch_init is called with a "
1777
1851
            "bzrlib.branch.BranchInitHookParams. "
1778
1852
            "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',
 
1853
            "lightweight) will all trigger this hook.", (2, 2))
 
1854
        self.add_hook('post_switch',
1781
1855
            "Called after a checkout switches branch. "
1782
1856
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1857
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1784
1858
 
1785
1859
 
1786
1860
 
1863
1937
        return self.__dict__ == other.__dict__
1864
1938
 
1865
1939
    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)
 
1940
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1872
1941
 
1873
1942
 
1874
1943
class SwitchHookParams(object):
1904
1973
            self.revision_id)
1905
1974
 
1906
1975
 
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
1976
class BranchFormatMetadir(BranchFormat):
1951
1977
    """Common logic for meta-dir based branch formats."""
1952
1978
 
1954
1980
        """What class to instantiate on open calls."""
1955
1981
        raise NotImplementedError(self._branch_class)
1956
1982
 
 
1983
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
1984
                           repository=None):
 
1985
        """Initialize a branch in a bzrdir, with specified files
 
1986
 
 
1987
        :param a_bzrdir: The bzrdir to initialize the branch in
 
1988
        :param utf8_files: The files to create as a list of
 
1989
            (filename, content) tuples
 
1990
        :param name: Name of colocated branch to create, if any
 
1991
        :return: a branch in this format
 
1992
        """
 
1993
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1994
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1995
        control_files = lockable_files.LockableFiles(branch_transport,
 
1996
            'lock', lockdir.LockDir)
 
1997
        control_files.create_lock()
 
1998
        control_files.lock_write()
 
1999
        try:
 
2000
            utf8_files += [('format', self.get_format_string())]
 
2001
            for (filename, content) in utf8_files:
 
2002
                branch_transport.put_bytes(
 
2003
                    filename, content,
 
2004
                    mode=a_bzrdir._get_file_mode())
 
2005
        finally:
 
2006
            control_files.unlock()
 
2007
        branch = self.open(a_bzrdir, name, _found=True,
 
2008
                found_repository=repository)
 
2009
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2010
        return branch
 
2011
 
1957
2012
    def network_name(self):
1958
2013
        """A simple byte string uniquely identifying this format for RPC calls.
1959
2014
 
1961
2016
        """
1962
2017
        return self.get_format_string()
1963
2018
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2019
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2020
            found_repository=None):
1965
2021
        """See BranchFormat.open()."""
1966
2022
        if not _found:
1967
2023
            format = BranchFormat.find_format(a_bzrdir, name=name)
1972
2028
        try:
1973
2029
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
2030
                                                         lockdir.LockDir)
 
2031
            if found_repository is None:
 
2032
                found_repository = a_bzrdir.find_repository()
1975
2033
            return self._branch_class()(_format=self,
1976
2034
                              _control_files=control_files,
1977
2035
                              name=name,
1978
2036
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
 
2037
                              _repository=found_repository,
1980
2038
                              ignore_fallbacks=ignore_fallbacks)
1981
2039
        except errors.NoSuchFile:
1982
2040
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1989
2047
    def supports_tags(self):
1990
2048
        return True
1991
2049
 
 
2050
    def supports_leaving_lock(self):
 
2051
        return True
 
2052
 
1992
2053
 
1993
2054
class BzrBranchFormat5(BranchFormatMetadir):
1994
2055
    """Bzr branch format 5.
2014
2075
        """See BranchFormat.get_format_description()."""
2015
2076
        return "Branch format 5"
2016
2077
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
2078
    def initialize(self, a_bzrdir, name=None, repository=None):
2018
2079
        """Create a branch of this format in a_bzrdir."""
2019
2080
        utf8_files = [('revision-history', ''),
2020
2081
                      ('branch-name', ''),
2021
2082
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2083
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2023
2084
 
2024
2085
    def supports_tags(self):
2025
2086
        return False
2047
2108
        """See BranchFormat.get_format_description()."""
2048
2109
        return "Branch format 6"
2049
2110
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
2111
    def initialize(self, a_bzrdir, name=None, repository=None):
2051
2112
        """Create a branch of this format in a_bzrdir."""
2052
2113
        utf8_files = [('last-revision', '0 null:\n'),
2053
2114
                      ('branch.conf', ''),
2054
2115
                      ('tags', ''),
2055
2116
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2117
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2057
2118
 
2058
2119
    def make_tags(self, branch):
2059
2120
        """See bzrlib.branch.BranchFormat.make_tags()."""
2077
2138
        """See BranchFormat.get_format_description()."""
2078
2139
        return "Branch format 8"
2079
2140
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
2141
    def initialize(self, a_bzrdir, name=None, repository=None):
2081
2142
        """Create a branch of this format in a_bzrdir."""
2082
2143
        utf8_files = [('last-revision', '0 null:\n'),
2083
2144
                      ('branch.conf', ''),
2084
2145
                      ('tags', ''),
2085
2146
                      ('references', '')
2086
2147
                      ]
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()
 
2148
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2093
2149
 
2094
2150
    def make_tags(self, branch):
2095
2151
        """See bzrlib.branch.BranchFormat.make_tags()."""
2104
2160
    supports_reference_locations = True
2105
2161
 
2106
2162
 
2107
 
class BzrBranchFormat7(BzrBranchFormat8):
 
2163
class BzrBranchFormat7(BranchFormatMetadir):
2108
2164
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
2165
 
2110
2166
    The stacked location pointer is passed down to the repository and requires
2113
2169
    This format was introduced in bzr 1.6.
2114
2170
    """
2115
2171
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
2172
    def initialize(self, a_bzrdir, name=None, repository=None):
2117
2173
        """Create a branch of this format in a_bzrdir."""
2118
2174
        utf8_files = [('last-revision', '0 null:\n'),
2119
2175
                      ('branch.conf', ''),
2120
2176
                      ('tags', ''),
2121
2177
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2178
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2123
2179
 
2124
2180
    def _branch_class(self):
2125
2181
        return BzrBranch7
2135
2191
    def supports_set_append_revisions_only(self):
2136
2192
        return True
2137
2193
 
 
2194
    def supports_stacking(self):
 
2195
        return True
 
2196
 
 
2197
    def make_tags(self, branch):
 
2198
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2199
        return BasicTags(branch)
 
2200
 
2138
2201
    supports_reference_locations = False
2139
2202
 
2140
2203
 
2157
2220
        """See BranchFormat.get_format_description()."""
2158
2221
        return "Checkout reference format 1"
2159
2222
 
2160
 
    def get_reference(self, a_bzrdir):
 
2223
    def get_reference(self, a_bzrdir, name=None):
2161
2224
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2225
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2226
        return transport.get_bytes('location')
2164
2227
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2228
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2229
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2230
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2231
        location = transport.put_bytes('location', to_branch.base)
2169
2232
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2233
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2234
            repository=None):
2171
2235
        """Create a branch of this format in a_bzrdir."""
2172
2236
        if target_branch is None:
2173
2237
            # this format does not implement branch itself, thus the implicit
2201
2265
        return clone
2202
2266
 
2203
2267
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
2268
             possible_transports=None, ignore_fallbacks=False,
 
2269
             found_repository=None):
2205
2270
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2271
 
2207
2272
        :param a_bzrdir: A BzrDir that contains a branch.
2221
2286
                raise AssertionError("wrong format %r found for %r" %
2222
2287
                    (format, self))
2223
2288
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
 
2289
            location = self.get_reference(a_bzrdir, name)
2225
2290
        real_bzrdir = bzrdir.BzrDir.open(
2226
2291
            location, possible_transports=possible_transports)
2227
2292
        result = real_bzrdir.open_branch(name=name, 
2238
2303
        return result
2239
2304
 
2240
2305
 
 
2306
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2307
    """Branch format registry."""
 
2308
 
 
2309
    def __init__(self, other_registry=None):
 
2310
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2311
        self._default_format = None
 
2312
 
 
2313
    def set_default(self, format):
 
2314
        self._default_format = format
 
2315
 
 
2316
    def get_default(self):
 
2317
        return self._default_format
 
2318
 
 
2319
 
2241
2320
network_format_registry = registry.FormatRegistry()
2242
2321
"""Registry of formats indexed by their network name.
2243
2322
 
2246
2325
BranchFormat.network_name() for more detail.
2247
2326
"""
2248
2327
 
 
2328
format_registry = BranchFormatRegistry(network_format_registry)
 
2329
 
2249
2330
 
2250
2331
# formats which have no format string are not discoverable
2251
2332
# and not independently creatable, so are not registered.
2253
2334
__format6 = BzrBranchFormat6()
2254
2335
__format7 = BzrBranchFormat7()
2255
2336
__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__)
 
2337
format_registry.register(__format5)
 
2338
format_registry.register(BranchReferenceFormat())
 
2339
format_registry.register(__format6)
 
2340
format_registry.register(__format7)
 
2341
format_registry.register(__format8)
 
2342
format_registry.set_default(__format7)
 
2343
 
 
2344
 
 
2345
class BranchWriteLockResult(LogicalLockResult):
 
2346
    """The result of write locking a branch.
 
2347
 
 
2348
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2349
        None.
 
2350
    :ivar unlock: A callable which will unlock the lock.
 
2351
    """
 
2352
 
 
2353
    def __init__(self, unlock, branch_token):
 
2354
        LogicalLockResult.__init__(self, unlock)
 
2355
        self.branch_token = branch_token
 
2356
 
 
2357
    def __repr__(self):
 
2358
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2359
            self.unlock)
2266
2360
 
2267
2361
 
2268
2362
class BzrBranch(Branch, _RelockDebugMixin):
2324
2418
        return self.control_files.is_locked()
2325
2419
 
2326
2420
    def lock_write(self, token=None):
 
2421
        """Lock the branch for write operations.
 
2422
 
 
2423
        :param token: A token to permit reacquiring a previously held and
 
2424
            preserved lock.
 
2425
        :return: A BranchWriteLockResult.
 
2426
        """
2327
2427
        if not self.is_locked():
2328
2428
            self._note_lock('w')
2329
2429
        # All-in-one needs to always unlock/lock.
2335
2435
        else:
2336
2436
            took_lock = False
2337
2437
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2438
            return BranchWriteLockResult(self.unlock,
 
2439
                self.control_files.lock_write(token=token))
2339
2440
        except:
2340
2441
            if took_lock:
2341
2442
                self.repository.unlock()
2342
2443
            raise
2343
2444
 
2344
2445
    def lock_read(self):
 
2446
        """Lock the branch for read operations.
 
2447
 
 
2448
        :return: A bzrlib.lock.LogicalLockResult.
 
2449
        """
2345
2450
        if not self.is_locked():
2346
2451
            self._note_lock('r')
2347
2452
        # All-in-one needs to always unlock/lock.
2354
2459
            took_lock = False
2355
2460
        try:
2356
2461
            self.control_files.lock_read()
 
2462
            return LogicalLockResult(self.unlock)
2357
2463
        except:
2358
2464
            if took_lock:
2359
2465
                self.repository.unlock()
2515
2621
        result.target_branch = target
2516
2622
        result.old_revno, result.old_revid = target.last_revision_info()
2517
2623
        self.update_references(target)
2518
 
        if result.old_revid != self.last_revision():
 
2624
        if result.old_revid != stop_revision:
2519
2625
            # We assume that during 'push' this repository is closer than
2520
2626
            # the target.
2521
2627
            graph = self.repository.get_graph(target.repository)
2522
2628
            target.update_revisions(self, stop_revision,
2523
2629
                overwrite=overwrite, graph=graph)
2524
2630
        if self._push_should_merge_tags():
2525
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2526
 
                overwrite)
 
2631
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2527
2632
        result.new_revno, result.new_revid = target.last_revision_info()
2528
2633
        return result
2529
2634
 
2561
2666
        """Return the branch we are bound to.
2562
2667
 
2563
2668
        :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
2669
        """
 
2670
        if self._master_branch_cache is None:
 
2671
            self._master_branch_cache = self._get_master_branch(
 
2672
                possible_transports)
 
2673
        return self._master_branch_cache
 
2674
 
 
2675
    def _get_master_branch(self, possible_transports):
2570
2676
        bound_loc = self.get_bound_location()
2571
2677
        if not bound_loc:
2572
2678
            return None
2583
2689
 
2584
2690
        :param location: URL to the target branch
2585
2691
        """
 
2692
        self._master_branch_cache = None
2586
2693
        if location:
2587
2694
            self._transport.put_bytes('bound', location+'\n',
2588
2695
                mode=self.bzrdir._get_file_mode())
2840
2947
 
2841
2948
    def set_bound_location(self, location):
2842
2949
        """See Branch.set_push_location."""
 
2950
        self._master_branch_cache = None
2843
2951
        result = None
2844
2952
        config = self.get_config()
2845
2953
        if location is None:
2922
3030
        try:
2923
3031
            index = self._partial_revision_history_cache.index(revision_id)
2924
3032
        except ValueError:
2925
 
            self._extend_partial_history(stop_revision=revision_id)
 
3033
            try:
 
3034
                self._extend_partial_history(stop_revision=revision_id)
 
3035
            except errors.RevisionNotPresent, e:
 
3036
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2926
3037
            index = len(self._partial_revision_history_cache) - 1
2927
3038
            if self._partial_revision_history_cache[index] != revision_id:
2928
3039
                raise errors.NoSuchRevision(self, revision_id)
2983
3094
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2984
3095
    """
2985
3096
 
 
3097
    @deprecated_method(deprecated_in((2, 3, 0)))
2986
3098
    def __int__(self):
2987
 
        # DEPRECATED: pull used to return the change in revno
 
3099
        """Return the relative change in revno.
 
3100
 
 
3101
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3102
        """
2988
3103
        return self.new_revno - self.old_revno
2989
3104
 
2990
3105
    def report(self, to_file):
3015
3130
        target, otherwise it will be None.
3016
3131
    """
3017
3132
 
 
3133
    @deprecated_method(deprecated_in((2, 3, 0)))
3018
3134
    def __int__(self):
3019
 
        # DEPRECATED: push used to return the change in revno
 
3135
        """Return the relative change in revno.
 
3136
 
 
3137
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3138
        """
3020
3139
        return self.new_revno - self.old_revno
3021
3140
 
3022
3141
    def report(self, to_file):
3145
3264
    _optimisers = []
3146
3265
    """The available optimised InterBranch types."""
3147
3266
 
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)
 
3267
    @classmethod
 
3268
    def _get_branch_formats_to_test(klass):
 
3269
        """Return an iterable of format tuples for testing.
 
3270
        
 
3271
        :return: An iterable of (from_format, to_format) to use when testing
 
3272
            this InterBranch class. Each InterBranch class should define this
 
3273
            method itself.
 
3274
        """
 
3275
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3276
 
 
3277
    @needs_write_lock
3153
3278
    def pull(self, overwrite=False, stop_revision=None,
3154
3279
             possible_transports=None, local=False):
3155
3280
        """Mirror source into target branch.
3160
3285
        """
3161
3286
        raise NotImplementedError(self.pull)
3162
3287
 
 
3288
    @needs_write_lock
3163
3289
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
 
                         graph=None):
 
3290
                         graph=None, fetch_tags=True):
3165
3291
        """Pull in new perfect-fit revisions.
3166
3292
 
3167
3293
        :param stop_revision: Updated until the given revision
3169
3295
            to see if it is a proper descendant.
3170
3296
        :param graph: A Graph object that can be used to query history
3171
3297
            information. This can be None.
 
3298
        :param fetch_tags: Flag that specifies if tags from source should be
 
3299
            fetched too.
3172
3300
        :return: None
3173
3301
        """
3174
3302
        raise NotImplementedError(self.update_revisions)
3175
3303
 
 
3304
    @needs_write_lock
3176
3305
    def push(self, overwrite=False, stop_revision=None,
3177
3306
             _override_hook_source_branch=None):
3178
3307
        """Mirror the source branch into the target branch.
3181
3310
        """
3182
3311
        raise NotImplementedError(self.push)
3183
3312
 
 
3313
    @needs_write_lock
 
3314
    def copy_content_into(self, revision_id=None):
 
3315
        """Copy the content of source into target
 
3316
 
 
3317
        revision_id: if not None, the revision history in the new branch will
 
3318
                     be truncated to end with revision_id.
 
3319
        """
 
3320
        raise NotImplementedError(self.copy_content_into)
 
3321
 
 
3322
    @needs_write_lock
 
3323
    def fetch(self, stop_revision=None, fetch_spec=None):
 
3324
        """Fetch revisions.
 
3325
 
 
3326
        :param stop_revision: Last revision to fetch
 
3327
        :param fetch_spec: Fetch spec.
 
3328
        """
 
3329
        raise NotImplementedError(self.fetch)
 
3330
 
3184
3331
 
3185
3332
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
 
 
 
3333
    """InterBranch implementation that uses public Branch functions."""
 
3334
 
 
3335
    @classmethod
 
3336
    def is_compatible(klass, source, target):
 
3337
        # GenericBranch uses the public API, so always compatible
 
3338
        return True
 
3339
 
 
3340
    @classmethod
 
3341
    def _get_branch_formats_to_test(klass):
 
3342
        return [(format_registry.get_default(), format_registry.get_default())]
 
3343
 
 
3344
    @classmethod
 
3345
    def unwrap_format(klass, format):
 
3346
        if isinstance(format, remote.RemoteBranchFormat):
 
3347
            format._ensure_real()
 
3348
            return format._custom_format
 
3349
        return format
 
3350
 
 
3351
    @needs_write_lock
 
3352
    def copy_content_into(self, revision_id=None):
 
3353
        """Copy the content of source into target
 
3354
 
 
3355
        revision_id: if not None, the revision history in the new branch will
 
3356
                     be truncated to end with revision_id.
 
3357
        """
 
3358
        self.source.update_references(self.target)
 
3359
        self.source._synchronize_history(self.target, revision_id)
 
3360
        try:
 
3361
            parent = self.source.get_parent()
 
3362
        except errors.InaccessibleParent, e:
 
3363
            mutter('parent was not accessible to copy: %s', e)
 
3364
        else:
 
3365
            if parent:
 
3366
                self.target.set_parent(parent)
 
3367
        if self.source._push_should_merge_tags():
 
3368
            self.source.tags.merge_to(self.target.tags)
 
3369
 
 
3370
    @needs_write_lock
 
3371
    def fetch(self, stop_revision=None, fetch_spec=None):
 
3372
        if fetch_spec is not None and stop_revision is not None:
 
3373
            raise AssertionError(
 
3374
                "fetch_spec and last_revision are mutually exclusive.")
 
3375
        if self.target.base == self.source.base:
 
3376
            return (0, [])
 
3377
        self.source.lock_read()
 
3378
        try:
 
3379
            if stop_revision is None and fetch_spec is None:
 
3380
                stop_revision = self.source.last_revision()
 
3381
                stop_revision = _mod_revision.ensure_null(stop_revision)
 
3382
            return self.target.repository.fetch(self.source.repository,
 
3383
                revision_id=stop_revision, fetch_spec=fetch_spec)
 
3384
        finally:
 
3385
            self.source.unlock()
 
3386
 
 
3387
    @needs_write_lock
3193
3388
    def update_revisions(self, stop_revision=None, overwrite=False,
3194
 
        graph=None):
 
3389
        graph=None, fetch_tags=True):
3195
3390
        """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
 
 
 
3391
        other_revno, other_last_revision = self.source.last_revision_info()
 
3392
        stop_revno = None # unknown
 
3393
        if stop_revision is None:
 
3394
            stop_revision = other_last_revision
 
3395
            if _mod_revision.is_null(stop_revision):
 
3396
                # if there are no commits, we're done.
 
3397
                return
 
3398
            stop_revno = other_revno
 
3399
 
 
3400
        # what's the current last revision, before we fetch [and change it
 
3401
        # possibly]
 
3402
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3403
        # we fetch here so that we don't process data twice in the common
 
3404
        # case of having something to pull, and so that the check for
 
3405
        # already merged can operate on the just fetched graph, which will
 
3406
        # be cached in memory.
 
3407
        if fetch_tags:
 
3408
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3409
            fetch_spec_factory.source_branch = self.source
 
3410
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3411
            fetch_spec_factory.source_repo = self.source.repository
 
3412
            fetch_spec_factory.target_repo = self.target.repository
 
3413
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3414
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3415
        else:
 
3416
            fetch_spec = _mod_graph.NotInOtherForRevs(self.target.repository,
 
3417
                self.source.repository, revision_ids=[stop_revision]).execute()
 
3418
        self.target.fetch(self.source, fetch_spec=fetch_spec)
 
3419
        # Check to see if one is an ancestor of the other
 
3420
        if not overwrite:
 
3421
            if graph is None:
 
3422
                graph = self.target.repository.get_graph()
 
3423
            if self.target._check_if_descendant_or_diverged(
 
3424
                    stop_revision, last_rev, graph, self.source):
 
3425
                # stop_revision is a descendant of last_rev, but we aren't
 
3426
                # overwriting, so we're done.
 
3427
                return
 
3428
        if stop_revno is None:
 
3429
            if graph is None:
 
3430
                graph = self.target.repository.get_graph()
 
3431
            this_revno, this_last_revision = \
 
3432
                    self.target.last_revision_info()
 
3433
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3434
                            [(other_last_revision, other_revno),
 
3435
                             (this_last_revision, this_revno)])
 
3436
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3437
 
 
3438
    @needs_write_lock
3236
3439
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3440
             possible_transports=None, run_hooks=True,
3238
3441
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
 
3442
        """Pull from source into self, updating my master if any.
3240
3443
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
3444
        :param run_hooks: Private parameter - if false, this branch
3244
3445
            is being called because it's the master of the primary branch,
3245
3446
            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
3447
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
 
3448
        bound_location = self.target.get_bound_location()
 
3449
        if local and not bound_location:
3252
3450
            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()
 
3451
        master_branch = None
 
3452
        source_is_master = (self.source.user_url == bound_location)
 
3453
        if not local and bound_location and not source_is_master:
 
3454
            # not pulling from master, so we need to update master.
 
3455
            master_branch = self.target.get_master_branch(possible_transports)
 
3456
            master_branch.lock_write()
3260
3457
        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)
 
3458
            if master_branch:
 
3459
                # pull from source into master.
 
3460
                master_branch.pull(self.source, overwrite, stop_revision,
 
3461
                    run_hooks=False)
 
3462
            return self._pull(overwrite,
 
3463
                stop_revision, _hook_master=master_branch,
 
3464
                run_hooks=run_hooks,
 
3465
                _override_hook_target=_override_hook_target,
 
3466
                merge_tags_to_master=not source_is_master)
3287
3467
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
 
3468
            if master_branch:
 
3469
                master_branch.unlock()
3290
3470
 
3291
3471
    def push(self, overwrite=False, stop_revision=None,
3292
3472
             _override_hook_source_branch=None):
3332
3512
                # push into the master from the source branch.
3333
3513
                self.source._basic_push(master_branch, overwrite, stop_revision)
3334
3514
                # and push into the target branch from the source. Note that we
3335
 
                # push from the source branch again, because its considered the
 
3515
                # push from the source branch again, because it's considered the
3336
3516
                # highest bandwidth repository.
3337
3517
                result = self.source._basic_push(self.target, overwrite,
3338
3518
                    stop_revision)
3354
3534
            _run_hooks()
3355
3535
            return result
3356
3536
 
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
 
 
 
3537
    def _pull(self, overwrite=False, stop_revision=None,
 
3538
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3539
             _override_hook_target=None, local=False,
 
3540
             merge_tags_to_master=True):
 
3541
        """See Branch.pull.
 
3542
 
 
3543
        This function is the core worker, used by GenericInterBranch.pull to
 
3544
        avoid duplication when pulling source->master and source->local.
 
3545
 
 
3546
        :param _hook_master: Private parameter - set the branch to
 
3547
            be supplied as the master to pull hooks.
3374
3548
        :param run_hooks: Private parameter - if false, this branch
3375
3549
            is being called because it's the master of the primary branch,
3376
3550
            so it should not run its hooks.
 
3551
            is being called because it's the master of the primary branch,
 
3552
            so it should not run its hooks.
 
3553
        :param _override_hook_target: Private parameter - set the branch to be
 
3554
            supplied as the target_branch to pull hooks.
 
3555
        :param local: Only update the local branch, and not the bound branch.
3377
3556
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
 
3557
        # This type of branch can't be bound.
 
3558
        if local:
3380
3559
            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()
 
3560
        result = PullResult()
 
3561
        result.source_branch = self.source
 
3562
        if _override_hook_target is None:
 
3563
            result.target_branch = self.target
 
3564
        else:
 
3565
            result.target_branch = _override_hook_target
 
3566
        self.source.lock_read()
3386
3567
        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)
 
3568
            # We assume that during 'pull' the target repository is closer than
 
3569
            # the source one.
 
3570
            self.source.update_references(self.target)
 
3571
            graph = self.target.repository.get_graph(self.source.repository)
 
3572
            # TODO: Branch formats should have a flag that indicates 
 
3573
            # that revno's are expensive, and pull() should honor that flag.
 
3574
            # -- JRV20090506
 
3575
            result.old_revno, result.old_revid = \
 
3576
                self.target.last_revision_info()
 
3577
            self.target.update_revisions(self.source, stop_revision,
 
3578
                overwrite=overwrite, graph=graph)
 
3579
            # TODO: The old revid should be specified when merging tags, 
 
3580
            # so a tags implementation that versions tags can only 
 
3581
            # pull in the most recent changes. -- JRV20090506
 
3582
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3583
                overwrite, ignore_master=not merge_tags_to_master)
 
3584
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3585
            if _hook_master:
 
3586
                result.master_branch = _hook_master
 
3587
                result.local_branch = result.target_branch
 
3588
            else:
 
3589
                result.master_branch = result.target_branch
 
3590
                result.local_branch = None
 
3591
            if run_hooks:
 
3592
                for hook in Branch.hooks['post_pull']:
 
3593
                    hook(result)
3395
3594
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
 
3595
            self.source.unlock()
 
3596
        return result
3398
3597
 
3399
3598
 
3400
3599
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)