/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: A. S. Budden
  • Date: 2011-05-04 13:26:14 UTC
  • mto: (5816.6.16 bazaar_source)
  • mto: This revision was merged to the branch mainline in revision 5835.
  • Revision ID: abudden@gmail.com-20110504132614-3ghb1ajucl6plc5z
Set the parent location of the bound branch to that of the master branch.

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):
630
673
        """Copy revisions from from_branch into this branch.
631
674
 
632
675
        :param from_branch: Where to copy from.
633
676
        :param last_revision: What revision to stop at (None for at the end
634
677
                              of the branch.
635
 
        :param pb: An optional progress bar to use.
636
678
        :return: None
637
679
        """
638
 
        if self.base == from_branch.base:
639
 
            return (0, [])
640
 
        if pb is not None:
641
 
            symbol_versioning.warn(
642
 
                symbol_versioning.deprecated_in((1, 14, 0))
643
 
                % "pb parameter to fetch()")
644
 
        from_branch.lock_read()
645
 
        try:
646
 
            if last_revision is None:
647
 
                last_revision = from_branch.last_revision()
648
 
                last_revision = _mod_revision.ensure_null(last_revision)
649
 
            return self.repository.fetch(from_branch.repository,
650
 
                                         revision_id=last_revision,
651
 
                                         pb=pb)
652
 
        finally:
653
 
            from_branch.unlock()
 
680
        return InterBranch.get(from_branch, self).fetch(last_revision)
654
681
 
655
682
    def get_bound_location(self):
656
683
        """Return the URL of the branch we are bound to.
667
694
 
668
695
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
696
                           timezone=None, committer=None, revprops=None,
670
 
                           revision_id=None):
 
697
                           revision_id=None, lossy=False):
671
698
        """Obtain a CommitBuilder for this branch.
672
699
 
673
700
        :param parents: Revision ids of the parents of the new revision.
677
704
        :param committer: Optional committer to set for commit.
678
705
        :param revprops: Optional dictionary of revision properties.
679
706
        :param revision_id: Optional revision id.
 
707
        :param lossy: Whether to discard data that can not be natively
 
708
            represented, when pushing to a foreign VCS 
680
709
        """
681
710
 
682
711
        if config is None:
683
712
            config = self.get_config()
684
713
 
685
714
        return self.repository.get_commit_builder(self, parents, config,
686
 
            timestamp, timezone, committer, revprops, revision_id)
 
715
            timestamp, timezone, committer, revprops, revision_id,
 
716
            lossy)
687
717
 
688
718
    def get_master_branch(self, possible_transports=None):
689
719
        """Return the branch we are bound to.
767
797
 
768
798
    def _unstack(self):
769
799
        """Change a branch to be unstacked, copying data as needed.
770
 
        
 
800
 
771
801
        Don't call this directly, use set_stacked_on_url(None).
772
802
        """
773
803
        pb = ui.ui_factory.nested_progress_bar()
782
812
            old_repository = self.repository
783
813
            if len(old_repository._fallback_repositories) != 1:
784
814
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
 
815
                    "of %r (fallbacks: %r)" % (old_repository,
 
816
                        old_repository._fallback_repositories))
 
817
            # Open the new repository object.
 
818
            # Repositories don't offer an interface to remove fallback
 
819
            # repositories today; take the conceptually simpler option and just
 
820
            # reopen it.  We reopen it starting from the URL so that we
 
821
            # get a separate connection for RemoteRepositories and can
 
822
            # stream from one of them to the other.  This does mean doing
 
823
            # separate SSH connection setup, but unstacking is not a
 
824
            # common operation so it's tolerable.
 
825
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
826
            new_repository = new_bzrdir.find_repository()
 
827
            if new_repository._fallback_repositories:
 
828
                raise AssertionError("didn't expect %r to have "
 
829
                    "fallback_repositories"
 
830
                    % (self.repository,))
 
831
            # Replace self.repository with the new repository.
 
832
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
833
            # lock count) of self.repository to the new repository.
 
834
            lock_token = old_repository.lock_write().repository_token
 
835
            self.repository = new_repository
 
836
            if isinstance(self, remote.RemoteBranch):
 
837
                # Remote branches can have a second reference to the old
 
838
                # repository that need to be replaced.
 
839
                if self._real_branch is not None:
 
840
                    self._real_branch.repository = new_repository
 
841
            self.repository.lock_write(token=lock_token)
 
842
            if lock_token is not None:
 
843
                old_repository.leave_lock_in_place()
787
844
            old_repository.unlock()
 
845
            if lock_token is not None:
 
846
                # XXX: self.repository.leave_lock_in_place() before this
 
847
                # function will not be preserved.  Fortunately that doesn't
 
848
                # affect the current default format (2a), and would be a
 
849
                # corner-case anyway.
 
850
                #  - Andrew Bennetts, 2010/06/30
 
851
                self.repository.dont_leave_lock_in_place()
 
852
            old_lock_count = 0
 
853
            while True:
 
854
                try:
 
855
                    old_repository.unlock()
 
856
                except errors.LockNotHeld:
 
857
                    break
 
858
                old_lock_count += 1
 
859
            if old_lock_count == 0:
 
860
                raise AssertionError(
 
861
                    'old_repository should have been locked at least once.')
 
862
            for i in range(old_lock_count-1):
 
863
                self.repository.lock_write()
 
864
            # Fetch from the old repository into the new.
788
865
            old_repository.lock_read()
789
866
            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
867
                # XXX: If you unstack a branch while it has a working tree
809
868
                # with a pending merge, the pending-merged revisions will no
810
869
                # 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)
 
870
                try:
 
871
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
872
                except errors.TagsNotSupported:
 
873
                    tags_to_fetch = set()
 
874
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
875
                    old_repository, required_ids=[self.last_revision()],
 
876
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
877
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
818
878
            finally:
819
879
                old_repository.unlock()
820
880
        finally:
825
885
 
826
886
        :seealso: Branch._get_tags_bytes.
827
887
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
888
        return _run_with_write_locked_target(self, self._set_tags_bytes_locked,
 
889
                bytes)
 
890
 
 
891
    def _set_tags_bytes_locked(self, bytes):
 
892
        self._tags_bytes = bytes
 
893
        return self._transport.put_bytes('tags', bytes)
830
894
 
831
895
    def _cache_revision_history(self, rev_history):
832
896
        """Set the cached revision history to rev_history.
859
923
        self._revision_history_cache = None
860
924
        self._revision_id_to_revno_cache = None
861
925
        self._last_revision_info_cache = None
 
926
        self._master_branch_cache = None
862
927
        self._merge_sorted_revisions_cache = None
863
928
        self._partial_revision_history_cache = []
864
929
        self._partial_revision_id_to_revno_cache = {}
 
930
        self._tags_bytes = None
865
931
 
866
932
    def _gen_revision_history(self):
867
933
        """Return sequence of revision hashes on to this branch.
928
994
        else:
929
995
            return (0, _mod_revision.NULL_REVISION)
930
996
 
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
997
    def update_revisions(self, other, stop_revision=None, overwrite=False,
956
 
                         graph=None):
 
998
            graph=None):
957
999
        """Pull in new perfect-fit revisions.
958
1000
 
959
1001
        :param other: Another Branch to pull from
967
1009
        return InterBranch.get(other, self).update_revisions(stop_revision,
968
1010
            overwrite, graph)
969
1011
 
 
1012
    @deprecated_method(deprecated_in((2, 4, 0)))
970
1013
    def import_last_revision_info(self, source_repo, revno, revid):
971
1014
        """Set the last revision info, importing from another repo if necessary.
972
1015
 
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
1016
        :param source_repo: Source repository to optionally fetch from
977
1017
        :param revno: Revision number of the new tip
978
1018
        :param revid: Revision id of the new tip
981
1021
            self.repository.fetch(source_repo, revision_id=revid)
982
1022
        self.set_last_revision_info(revno, revid)
983
1023
 
 
1024
    def import_last_revision_info_and_tags(self, source, revno, revid,
 
1025
                                           lossy=False):
 
1026
        """Set the last revision info, importing from another repo if necessary.
 
1027
 
 
1028
        This is used by the bound branch code to upload a revision to
 
1029
        the master branch first before updating the tip of the local branch.
 
1030
        Revisions referenced by source's tags are also transferred.
 
1031
 
 
1032
        :param source: Source branch to optionally fetch from
 
1033
        :param revno: Revision number of the new tip
 
1034
        :param revid: Revision id of the new tip
 
1035
        :param lossy: Whether to discard metadata that can not be
 
1036
            natively represented
 
1037
        :return: Tuple with the new revision number and revision id
 
1038
            (should only be different from the arguments when lossy=True)
 
1039
        """
 
1040
        if not self.repository.has_same_location(source.repository):
 
1041
            self.fetch(source, revid)
 
1042
        self.set_last_revision_info(revno, revid)
 
1043
        return (revno, revid)
 
1044
 
984
1045
    def revision_id_to_revno(self, revision_id):
985
1046
        """Given a revision id, return its revno"""
986
1047
        if _mod_revision.is_null(revision_id):
1006
1067
            self._extend_partial_history(distance_from_last)
1007
1068
        return self._partial_revision_history_cache[distance_from_last]
1008
1069
 
1009
 
    @needs_write_lock
1010
1070
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1071
             possible_transports=None, *args, **kwargs):
1012
1072
        """Mirror source into this branch.
1208
1268
        return result
1209
1269
 
1210
1270
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1271
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1272
            repository=None):
1212
1273
        """Create a new line of development from the branch, into to_bzrdir.
1213
1274
 
1214
1275
        to_bzrdir controls the branch format.
1219
1280
        if (repository_policy is not None and
1220
1281
            repository_policy.requires_stacking()):
1221
1282
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
 
        result = to_bzrdir.create_branch()
 
1283
        result = to_bzrdir.create_branch(repository=repository)
1223
1284
        result.lock_write()
1224
1285
        try:
1225
1286
            if repository_policy is not None:
1226
1287
                repository_policy.configure_branch(result)
1227
1288
            self.copy_content_into(result, revision_id=revision_id)
1228
 
            result.set_parent(self.bzrdir.root_transport.base)
 
1289
            bound_branch = self.get_master_branch()
 
1290
            if bound_branch is None:
 
1291
                result.set_parent(self.bzrdir.root_transport.base)
 
1292
            else:
 
1293
                result.set_parent(bound_branch.bzrdir.root_transport.base)
1229
1294
        finally:
1230
1295
            result.unlock()
1231
1296
        return result
1255
1320
                revno = 1
1256
1321
        destination.set_last_revision_info(revno, revision_id)
1257
1322
 
1258
 
    @needs_read_lock
1259
1323
    def copy_content_into(self, destination, revision_id=None):
1260
1324
        """Copy the content of self into destination.
1261
1325
 
1262
1326
        revision_id: if not None, the revision history in the new branch will
1263
1327
                     be truncated to end with revision_id.
1264
1328
        """
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)
 
1329
        return InterBranch.get(self, destination).copy_content_into(
 
1330
            revision_id=revision_id)
1276
1331
 
1277
1332
    def update_references(self, target):
1278
1333
        if not getattr(self._format, 'supports_reference_locations', False):
1323
1378
        """Return the most suitable metadir for a checkout of this branch.
1324
1379
        Weaves are used if this branch's repository uses weaves.
1325
1380
        """
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)
 
1381
        format = self.repository.bzrdir.checkout_metadir()
 
1382
        format.set_branch_format(self._format)
1333
1383
        return format
1334
1384
 
1335
1385
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1386
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1387
        no_tree=None):
1337
1388
        """Create a clone of this branch and its bzrdir.
1338
1389
 
1339
1390
        :param to_transport: The transport to clone onto.
1346
1397
        """
1347
1398
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1399
        # clone call. Or something. 20090224 RBC/spiv.
 
1400
        # XXX: Should this perhaps clone colocated branches as well, 
 
1401
        # rather than just the default branch? 20100319 JRV
1349
1402
        if revision_id is None:
1350
1403
            revision_id = self.last_revision()
1351
1404
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
1405
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1406
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1407
            no_tree=no_tree)
1354
1408
        return dir_to.open_branch()
1355
1409
 
1356
1410
    def create_checkout(self, to_location, revision_id=None,
1471
1525
        else:
1472
1526
            raise AssertionError("invalid heads: %r" % (heads,))
1473
1527
 
1474
 
 
1475
 
class BranchFormat(object):
 
1528
    def heads_to_fetch(self):
 
1529
        """Return the heads that must and that should be fetched to copy this
 
1530
        branch into another repo.
 
1531
 
 
1532
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1533
            set of heads that must be fetched.  if_present_fetch is a set of
 
1534
            heads that must be fetched if present, but no error is necessary if
 
1535
            they are not present.
 
1536
        """
 
1537
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
 
1538
        # are the tags.
 
1539
        must_fetch = set([self.last_revision()])
 
1540
        try:
 
1541
            if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1542
        except errors.TagsNotSupported:
 
1543
            if_present_fetch = set()
 
1544
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1545
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1546
        return must_fetch, if_present_fetch
 
1547
 
 
1548
 
 
1549
class BranchFormat(controldir.ControlComponentFormat):
1476
1550
    """An encapsulation of the initialization and open routines for a format.
1477
1551
 
1478
1552
    Formats provide three things:
1481
1555
     * an open routine.
1482
1556
 
1483
1557
    Formats are placed in an dict by their format string for reference
1484
 
    during branch opening. Its not required that these be instances, they
 
1558
    during branch opening. It's not required that these be instances, they
1485
1559
    can be classes themselves with class methods - it simply depends on
1486
1560
    whether state is needed for a given format or not.
1487
1561
 
1490
1564
    object will be created every time regardless.
1491
1565
    """
1492
1566
 
1493
 
    _default_format = None
1494
 
    """The default format used for new branches."""
1495
 
 
1496
 
    _formats = {}
1497
 
    """The known formats."""
1498
 
 
1499
1567
    can_set_append_revisions_only = True
1500
1568
 
1501
1569
    def __eq__(self, other):
1510
1578
        try:
1511
1579
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
1580
            format_string = transport.get_bytes("format")
1513
 
            return klass._formats[format_string]
 
1581
            return format_registry.get(format_string)
1514
1582
        except errors.NoSuchFile:
1515
1583
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1516
1584
        except KeyError:
1517
1585
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1586
 
1519
1587
    @classmethod
 
1588
    @deprecated_method(deprecated_in((2, 4, 0)))
1520
1589
    def get_default_format(klass):
1521
1590
        """Return the current default format."""
1522
 
        return klass._default_format
1523
 
 
1524
 
    def get_reference(self, a_bzrdir):
 
1591
        return format_registry.get_default()
 
1592
 
 
1593
    @classmethod
 
1594
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1595
    def get_formats(klass):
 
1596
        """Get all the known formats.
 
1597
 
 
1598
        Warning: This triggers a load of all lazy registered formats: do not
 
1599
        use except when that is desireed.
 
1600
        """
 
1601
        return format_registry._get_all()
 
1602
 
 
1603
    def get_reference(self, a_bzrdir, name=None):
1525
1604
        """Get the target reference of the branch in a_bzrdir.
1526
1605
 
1527
1606
        format probing must have been completed before calling
1529
1608
        in a_bzrdir is correct.
1530
1609
 
1531
1610
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1611
        :param name: Name of the colocated branch to fetch
1532
1612
        :return: None if the branch is not a reference branch.
1533
1613
        """
1534
1614
        return None
1535
1615
 
1536
1616
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
 
1617
    def set_reference(self, a_bzrdir, name, to_branch):
1538
1618
        """Set the target reference of the branch in a_bzrdir.
1539
1619
 
1540
1620
        format probing must have been completed before calling
1542
1622
        in a_bzrdir is correct.
1543
1623
 
1544
1624
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1625
        :param name: Name of colocated branch to set, None for default
1545
1626
        :param to_branch: branch that the checkout is to reference
1546
1627
        """
1547
1628
        raise NotImplementedError(self.set_reference)
1562
1643
        for hook in hooks:
1563
1644
            hook(params)
1564
1645
 
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):
 
1646
    def initialize(self, a_bzrdir, name=None, repository=None):
1611
1647
        """Create a branch of this format in a_bzrdir.
1612
1648
        
1613
1649
        :param name: Name of the colocated branch to create.
1647
1683
        """
1648
1684
        raise NotImplementedError(self.network_name)
1649
1685
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1686
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
1687
            found_repository=None):
1651
1688
        """Return the branch object for a_bzrdir
1652
1689
 
1653
1690
        :param a_bzrdir: A BzrDir that contains a branch.
1660
1697
        raise NotImplementedError(self.open)
1661
1698
 
1662
1699
    @classmethod
 
1700
    @deprecated_method(deprecated_in((2, 4, 0)))
1663
1701
    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__)
 
1702
        """Register a metadir format.
 
1703
 
 
1704
        See MetaDirBranchFormatFactory for the ability to register a format
 
1705
        without loading the code the format needs until it is actually used.
 
1706
        """
 
1707
        format_registry.register(format)
1669
1708
 
1670
1709
    @classmethod
 
1710
    @deprecated_method(deprecated_in((2, 4, 0)))
1671
1711
    def set_default_format(klass, format):
1672
 
        klass._default_format = format
 
1712
        format_registry.set_default(format)
1673
1713
 
1674
1714
    def supports_set_append_revisions_only(self):
1675
1715
        """True if this format supports set_append_revisions_only."""
1679
1719
        """True if this format records a stacked-on branch."""
1680
1720
        return False
1681
1721
 
 
1722
    def supports_leaving_lock(self):
 
1723
        """True if this format supports leaving locks in place."""
 
1724
        return False # by default
 
1725
 
1682
1726
    @classmethod
 
1727
    @deprecated_method(deprecated_in((2, 4, 0)))
1683
1728
    def unregister_format(klass, format):
1684
 
        del klass._formats[format.get_format_string()]
 
1729
        format_registry.remove(format)
1685
1730
 
1686
1731
    def __str__(self):
1687
1732
        return self.get_format_description().rstrip()
1691
1736
        return False  # by default
1692
1737
 
1693
1738
 
 
1739
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1740
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1741
    
 
1742
    While none of the built in BranchFormats are lazy registered yet,
 
1743
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1744
    use it, and the bzr-loom plugin uses it as well (see
 
1745
    bzrlib.plugins.loom.formats).
 
1746
    """
 
1747
 
 
1748
    def __init__(self, format_string, module_name, member_name):
 
1749
        """Create a MetaDirBranchFormatFactory.
 
1750
 
 
1751
        :param format_string: The format string the format has.
 
1752
        :param module_name: Module to load the format class from.
 
1753
        :param member_name: Attribute name within the module for the format class.
 
1754
        """
 
1755
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1756
        self._format_string = format_string
 
1757
        
 
1758
    def get_format_string(self):
 
1759
        """See BranchFormat.get_format_string."""
 
1760
        return self._format_string
 
1761
 
 
1762
    def __call__(self):
 
1763
        """Used for network_format_registry support."""
 
1764
        return self.get_obj()()
 
1765
 
 
1766
 
1694
1767
class BranchHooks(Hooks):
1695
1768
    """A dictionary mapping hook name to a list of callables for branch hooks.
1696
1769
 
1704
1777
        These are all empty initially, because by default nothing should get
1705
1778
        notified.
1706
1779
        """
1707
 
        Hooks.__init__(self)
1708
 
        self.create_hook(HookPoint('set_rh',
 
1780
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1781
        self.add_hook('set_rh',
1709
1782
            "Invoked whenever the revision history has been set via "
1710
1783
            "set_revision_history. The api signature is (branch, "
1711
1784
            "revision_history), and the branch will be write-locked. "
1712
1785
            "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',
 
1786
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
 
1787
        self.add_hook('open',
1715
1788
            "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',
 
1789
            "branch is opened.", (1, 8))
 
1790
        self.add_hook('post_push',
1718
1791
            "Called after a push operation completes. post_push is called "
1719
1792
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
 
            "bzr client.", (0, 15), None))
1721
 
        self.create_hook(HookPoint('post_pull',
 
1793
            "bzr client.", (0, 15))
 
1794
        self.add_hook('post_pull',
1722
1795
            "Called after a pull operation completes. post_pull is called "
1723
1796
            "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 "
 
1797
            "bzr client.", (0, 15))
 
1798
        self.add_hook('pre_commit',
 
1799
            "Called after a commit is calculated but before it is "
1727
1800
            "completed. pre_commit is called with (local, master, old_revno, "
1728
1801
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
1802
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1731
1804
            "basis revision. hooks MUST NOT modify this delta. "
1732
1805
            " future_tree is an in-memory tree obtained from "
1733
1806
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
 
            "tree.", (0,91), None))
1735
 
        self.create_hook(HookPoint('post_commit',
 
1807
            "tree.", (0,91))
 
1808
        self.add_hook('post_commit',
1736
1809
            "Called in the bzr client after a commit has completed. "
1737
1810
            "post_commit is called with (local, master, old_revno, old_revid, "
1738
1811
            "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',
 
1812
            "commit to a branch.", (0, 15))
 
1813
        self.add_hook('post_uncommit',
1741
1814
            "Called in the bzr client after an uncommit completes. "
1742
1815
            "post_uncommit is called with (local, master, old_revno, "
1743
1816
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
1817
            "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',
 
1818
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1819
        self.add_hook('pre_change_branch_tip',
1747
1820
            "Called in bzr client and server before a change to the tip of a "
1748
1821
            "branch is made. pre_change_branch_tip is called with a "
1749
1822
            "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',
 
1823
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1824
        self.add_hook('post_change_branch_tip',
1752
1825
            "Called in bzr client and server after a change to the tip of a "
1753
1826
            "branch is made. post_change_branch_tip is called with a "
1754
1827
            "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',
 
1828
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1829
        self.add_hook('transform_fallback_location',
1757
1830
            "Called when a stacked branch is activating its fallback "
1758
1831
            "locations. transform_fallback_location is called with (branch, "
1759
1832
            "url), and should return a new url. Returning the same url "
1764
1837
            "fallback locations have not been activated. When there are "
1765
1838
            "multiple hooks installed for transform_fallback_location, "
1766
1839
            "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."
 
1840
            "The order is however undefined.", (1, 9))
 
1841
        self.add_hook('automatic_tag_name',
 
1842
            "Called to determine an automatic tag name for a revision. "
1770
1843
            "automatic_tag_name is called with (branch, revision_id) and "
1771
1844
            "should return a tag name or None if no tag name could be "
1772
1845
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
 
1846
            (2, 2))
 
1847
        self.add_hook('post_branch_init',
1775
1848
            "Called after new branch initialization completes. "
1776
1849
            "post_branch_init is called with a "
1777
1850
            "bzrlib.branch.BranchInitHookParams. "
1778
1851
            "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',
 
1852
            "lightweight) will all trigger this hook.", (2, 2))
 
1853
        self.add_hook('post_switch',
1781
1854
            "Called after a checkout switches branch. "
1782
1855
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1856
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1784
1857
 
1785
1858
 
1786
1859
 
1863
1936
        return self.__dict__ == other.__dict__
1864
1937
 
1865
1938
    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)
 
1939
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1872
1940
 
1873
1941
 
1874
1942
class SwitchHookParams(object):
1904
1972
            self.revision_id)
1905
1973
 
1906
1974
 
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
1975
class BranchFormatMetadir(BranchFormat):
1951
1976
    """Common logic for meta-dir based branch formats."""
1952
1977
 
1954
1979
        """What class to instantiate on open calls."""
1955
1980
        raise NotImplementedError(self._branch_class)
1956
1981
 
 
1982
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
1983
                           repository=None):
 
1984
        """Initialize a branch in a bzrdir, with specified files
 
1985
 
 
1986
        :param a_bzrdir: The bzrdir to initialize the branch in
 
1987
        :param utf8_files: The files to create as a list of
 
1988
            (filename, content) tuples
 
1989
        :param name: Name of colocated branch to create, if any
 
1990
        :return: a branch in this format
 
1991
        """
 
1992
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1993
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1994
        control_files = lockable_files.LockableFiles(branch_transport,
 
1995
            'lock', lockdir.LockDir)
 
1996
        control_files.create_lock()
 
1997
        control_files.lock_write()
 
1998
        try:
 
1999
            utf8_files += [('format', self.get_format_string())]
 
2000
            for (filename, content) in utf8_files:
 
2001
                branch_transport.put_bytes(
 
2002
                    filename, content,
 
2003
                    mode=a_bzrdir._get_file_mode())
 
2004
        finally:
 
2005
            control_files.unlock()
 
2006
        branch = self.open(a_bzrdir, name, _found=True,
 
2007
                found_repository=repository)
 
2008
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2009
        return branch
 
2010
 
1957
2011
    def network_name(self):
1958
2012
        """A simple byte string uniquely identifying this format for RPC calls.
1959
2013
 
1961
2015
        """
1962
2016
        return self.get_format_string()
1963
2017
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2018
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2019
            found_repository=None):
1965
2020
        """See BranchFormat.open()."""
1966
2021
        if not _found:
1967
2022
            format = BranchFormat.find_format(a_bzrdir, name=name)
1972
2027
        try:
1973
2028
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
2029
                                                         lockdir.LockDir)
 
2030
            if found_repository is None:
 
2031
                found_repository = a_bzrdir.find_repository()
1975
2032
            return self._branch_class()(_format=self,
1976
2033
                              _control_files=control_files,
1977
2034
                              name=name,
1978
2035
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
 
2036
                              _repository=found_repository,
1980
2037
                              ignore_fallbacks=ignore_fallbacks)
1981
2038
        except errors.NoSuchFile:
1982
2039
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1989
2046
    def supports_tags(self):
1990
2047
        return True
1991
2048
 
 
2049
    def supports_leaving_lock(self):
 
2050
        return True
 
2051
 
1992
2052
 
1993
2053
class BzrBranchFormat5(BranchFormatMetadir):
1994
2054
    """Bzr branch format 5.
2014
2074
        """See BranchFormat.get_format_description()."""
2015
2075
        return "Branch format 5"
2016
2076
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
2077
    def initialize(self, a_bzrdir, name=None, repository=None):
2018
2078
        """Create a branch of this format in a_bzrdir."""
2019
2079
        utf8_files = [('revision-history', ''),
2020
2080
                      ('branch-name', ''),
2021
2081
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2082
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2023
2083
 
2024
2084
    def supports_tags(self):
2025
2085
        return False
2047
2107
        """See BranchFormat.get_format_description()."""
2048
2108
        return "Branch format 6"
2049
2109
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
2110
    def initialize(self, a_bzrdir, name=None, repository=None):
2051
2111
        """Create a branch of this format in a_bzrdir."""
2052
2112
        utf8_files = [('last-revision', '0 null:\n'),
2053
2113
                      ('branch.conf', ''),
2054
2114
                      ('tags', ''),
2055
2115
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2116
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2057
2117
 
2058
2118
    def make_tags(self, branch):
2059
2119
        """See bzrlib.branch.BranchFormat.make_tags()."""
2077
2137
        """See BranchFormat.get_format_description()."""
2078
2138
        return "Branch format 8"
2079
2139
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
2140
    def initialize(self, a_bzrdir, name=None, repository=None):
2081
2141
        """Create a branch of this format in a_bzrdir."""
2082
2142
        utf8_files = [('last-revision', '0 null:\n'),
2083
2143
                      ('branch.conf', ''),
2084
2144
                      ('tags', ''),
2085
2145
                      ('references', '')
2086
2146
                      ]
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()
 
2147
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2093
2148
 
2094
2149
    def make_tags(self, branch):
2095
2150
        """See bzrlib.branch.BranchFormat.make_tags()."""
2104
2159
    supports_reference_locations = True
2105
2160
 
2106
2161
 
2107
 
class BzrBranchFormat7(BzrBranchFormat8):
 
2162
class BzrBranchFormat7(BranchFormatMetadir):
2108
2163
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
2164
 
2110
2165
    The stacked location pointer is passed down to the repository and requires
2113
2168
    This format was introduced in bzr 1.6.
2114
2169
    """
2115
2170
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
2171
    def initialize(self, a_bzrdir, name=None, repository=None):
2117
2172
        """Create a branch of this format in a_bzrdir."""
2118
2173
        utf8_files = [('last-revision', '0 null:\n'),
2119
2174
                      ('branch.conf', ''),
2120
2175
                      ('tags', ''),
2121
2176
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2177
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2123
2178
 
2124
2179
    def _branch_class(self):
2125
2180
        return BzrBranch7
2135
2190
    def supports_set_append_revisions_only(self):
2136
2191
        return True
2137
2192
 
 
2193
    def supports_stacking(self):
 
2194
        return True
 
2195
 
 
2196
    def make_tags(self, branch):
 
2197
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2198
        return BasicTags(branch)
 
2199
 
2138
2200
    supports_reference_locations = False
2139
2201
 
2140
2202
 
2157
2219
        """See BranchFormat.get_format_description()."""
2158
2220
        return "Checkout reference format 1"
2159
2221
 
2160
 
    def get_reference(self, a_bzrdir):
 
2222
    def get_reference(self, a_bzrdir, name=None):
2161
2223
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2224
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2225
        return transport.get_bytes('location')
2164
2226
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2227
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2228
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2229
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2230
        location = transport.put_bytes('location', to_branch.base)
2169
2231
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2232
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2233
            repository=None):
2171
2234
        """Create a branch of this format in a_bzrdir."""
2172
2235
        if target_branch is None:
2173
2236
            # this format does not implement branch itself, thus the implicit
2201
2264
        return clone
2202
2265
 
2203
2266
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
2267
             possible_transports=None, ignore_fallbacks=False,
 
2268
             found_repository=None):
2205
2269
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2270
 
2207
2271
        :param a_bzrdir: A BzrDir that contains a branch.
2221
2285
                raise AssertionError("wrong format %r found for %r" %
2222
2286
                    (format, self))
2223
2287
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
 
2288
            location = self.get_reference(a_bzrdir, name)
2225
2289
        real_bzrdir = bzrdir.BzrDir.open(
2226
2290
            location, possible_transports=possible_transports)
2227
2291
        result = real_bzrdir.open_branch(name=name, 
2238
2302
        return result
2239
2303
 
2240
2304
 
 
2305
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2306
    """Branch format registry."""
 
2307
 
 
2308
    def __init__(self, other_registry=None):
 
2309
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2310
        self._default_format = None
 
2311
 
 
2312
    def set_default(self, format):
 
2313
        self._default_format = format
 
2314
 
 
2315
    def get_default(self):
 
2316
        return self._default_format
 
2317
 
 
2318
 
2241
2319
network_format_registry = registry.FormatRegistry()
2242
2320
"""Registry of formats indexed by their network name.
2243
2321
 
2246
2324
BranchFormat.network_name() for more detail.
2247
2325
"""
2248
2326
 
 
2327
format_registry = BranchFormatRegistry(network_format_registry)
 
2328
 
2249
2329
 
2250
2330
# formats which have no format string are not discoverable
2251
2331
# and not independently creatable, so are not registered.
2253
2333
__format6 = BzrBranchFormat6()
2254
2334
__format7 = BzrBranchFormat7()
2255
2335
__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__)
 
2336
format_registry.register(__format5)
 
2337
format_registry.register(BranchReferenceFormat())
 
2338
format_registry.register(__format6)
 
2339
format_registry.register(__format7)
 
2340
format_registry.register(__format8)
 
2341
format_registry.set_default(__format7)
 
2342
 
 
2343
 
 
2344
class BranchWriteLockResult(LogicalLockResult):
 
2345
    """The result of write locking a branch.
 
2346
 
 
2347
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2348
        None.
 
2349
    :ivar unlock: A callable which will unlock the lock.
 
2350
    """
 
2351
 
 
2352
    def __init__(self, unlock, branch_token):
 
2353
        LogicalLockResult.__init__(self, unlock)
 
2354
        self.branch_token = branch_token
 
2355
 
 
2356
    def __repr__(self):
 
2357
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2358
            self.unlock)
2266
2359
 
2267
2360
 
2268
2361
class BzrBranch(Branch, _RelockDebugMixin):
2324
2417
        return self.control_files.is_locked()
2325
2418
 
2326
2419
    def lock_write(self, token=None):
 
2420
        """Lock the branch for write operations.
 
2421
 
 
2422
        :param token: A token to permit reacquiring a previously held and
 
2423
            preserved lock.
 
2424
        :return: A BranchWriteLockResult.
 
2425
        """
2327
2426
        if not self.is_locked():
2328
2427
            self._note_lock('w')
2329
2428
        # All-in-one needs to always unlock/lock.
2335
2434
        else:
2336
2435
            took_lock = False
2337
2436
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2437
            return BranchWriteLockResult(self.unlock,
 
2438
                self.control_files.lock_write(token=token))
2339
2439
        except:
2340
2440
            if took_lock:
2341
2441
                self.repository.unlock()
2342
2442
            raise
2343
2443
 
2344
2444
    def lock_read(self):
 
2445
        """Lock the branch for read operations.
 
2446
 
 
2447
        :return: A bzrlib.lock.LogicalLockResult.
 
2448
        """
2345
2449
        if not self.is_locked():
2346
2450
            self._note_lock('r')
2347
2451
        # All-in-one needs to always unlock/lock.
2354
2458
            took_lock = False
2355
2459
        try:
2356
2460
            self.control_files.lock_read()
 
2461
            return LogicalLockResult(self.unlock)
2357
2462
        except:
2358
2463
            if took_lock:
2359
2464
                self.repository.unlock()
2396
2501
            'revision-history', '\n'.join(history),
2397
2502
            mode=self.bzrdir._get_file_mode())
2398
2503
 
2399
 
    @needs_write_lock
 
2504
    @deprecated_method(deprecated_in((2, 4, 0)))
2400
2505
    def set_revision_history(self, rev_history):
2401
2506
        """See Branch.set_revision_history."""
 
2507
        self._set_revision_history(rev_history)
 
2508
 
 
2509
    @needs_write_lock
 
2510
    def _set_revision_history(self, rev_history):
2402
2511
        if 'evil' in debug.debug_flags:
2403
2512
            mutter_callsite(3, "set_revision_history scales with history.")
2404
2513
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2448
2557
            except ValueError:
2449
2558
                rev = self.repository.get_revision(revision_id)
2450
2559
                new_history = rev.get_history(self.repository)[1:]
2451
 
        destination.set_revision_history(new_history)
 
2560
        destination._set_revision_history(new_history)
2452
2561
 
2453
2562
    @needs_write_lock
2454
2563
    def set_last_revision_info(self, revno, revision_id):
2462
2571
        configured to check constraints on history, in which case this may not
2463
2572
        be permitted.
2464
2573
        """
2465
 
        revision_id = _mod_revision.ensure_null(revision_id)
 
2574
        if not revision_id or not isinstance(revision_id, basestring):
 
2575
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2466
2576
        # this old format stores the full history, but this api doesn't
2467
2577
        # provide it, so we must generate, and might as well check it's
2468
2578
        # correct
2469
2579
        history = self._lefthand_history(revision_id)
2470
2580
        if len(history) != revno:
2471
2581
            raise AssertionError('%d != %d' % (len(history), revno))
2472
 
        self.set_revision_history(history)
 
2582
        self._set_revision_history(history)
2473
2583
 
2474
2584
    def _gen_revision_history(self):
2475
2585
        history = self._transport.get_bytes('revision-history').split('\n')
2489
2599
        :param other_branch: The other branch that DivergedBranches should
2490
2600
            raise with respect to.
2491
2601
        """
2492
 
        self.set_revision_history(self._lefthand_history(revision_id,
 
2602
        self._set_revision_history(self._lefthand_history(revision_id,
2493
2603
            last_rev, other_branch))
2494
2604
 
2495
2605
    def basis_tree(self):
2515
2625
        result.target_branch = target
2516
2626
        result.old_revno, result.old_revid = target.last_revision_info()
2517
2627
        self.update_references(target)
2518
 
        if result.old_revid != self.last_revision():
 
2628
        if result.old_revid != stop_revision:
2519
2629
            # We assume that during 'push' this repository is closer than
2520
2630
            # the target.
2521
2631
            graph = self.repository.get_graph(target.repository)
2522
2632
            target.update_revisions(self, stop_revision,
2523
2633
                overwrite=overwrite, graph=graph)
2524
2634
        if self._push_should_merge_tags():
2525
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2526
 
                overwrite)
 
2635
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2527
2636
        result.new_revno, result.new_revid = target.last_revision_info()
2528
2637
        return result
2529
2638
 
2561
2670
        """Return the branch we are bound to.
2562
2671
 
2563
2672
        :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
2673
        """
 
2674
        if self._master_branch_cache is None:
 
2675
            self._master_branch_cache = self._get_master_branch(
 
2676
                possible_transports)
 
2677
        return self._master_branch_cache
 
2678
 
 
2679
    def _get_master_branch(self, possible_transports):
2570
2680
        bound_loc = self.get_bound_location()
2571
2681
        if not bound_loc:
2572
2682
            return None
2583
2693
 
2584
2694
        :param location: URL to the target branch
2585
2695
        """
 
2696
        self._master_branch_cache = None
2586
2697
        if location:
2587
2698
            self._transport.put_bytes('bound', location+'\n',
2588
2699
                mode=self.bzrdir._get_file_mode())
2697
2808
 
2698
2809
    @needs_write_lock
2699
2810
    def set_last_revision_info(self, revno, revision_id):
2700
 
        revision_id = _mod_revision.ensure_null(revision_id)
 
2811
        if not revision_id or not isinstance(revision_id, basestring):
 
2812
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2701
2813
        old_revno, old_revid = self.last_revision_info()
2702
2814
        if self._get_append_revisions_only():
2703
2815
            self._check_history_violation(revision_id)
2840
2952
 
2841
2953
    def set_bound_location(self, location):
2842
2954
        """See Branch.set_push_location."""
 
2955
        self._master_branch_cache = None
2843
2956
        result = None
2844
2957
        config = self.get_config()
2845
2958
        if location is None:
2922
3035
        try:
2923
3036
            index = self._partial_revision_history_cache.index(revision_id)
2924
3037
        except ValueError:
2925
 
            self._extend_partial_history(stop_revision=revision_id)
 
3038
            try:
 
3039
                self._extend_partial_history(stop_revision=revision_id)
 
3040
            except errors.RevisionNotPresent, e:
 
3041
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2926
3042
            index = len(self._partial_revision_history_cache) - 1
2927
3043
            if self._partial_revision_history_cache[index] != revision_id:
2928
3044
                raise errors.NoSuchRevision(self, revision_id)
2983
3099
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2984
3100
    """
2985
3101
 
 
3102
    @deprecated_method(deprecated_in((2, 3, 0)))
2986
3103
    def __int__(self):
2987
 
        # DEPRECATED: pull used to return the change in revno
 
3104
        """Return the relative change in revno.
 
3105
 
 
3106
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3107
        """
2988
3108
        return self.new_revno - self.old_revno
2989
3109
 
2990
3110
    def report(self, to_file):
3015
3135
        target, otherwise it will be None.
3016
3136
    """
3017
3137
 
 
3138
    @deprecated_method(deprecated_in((2, 3, 0)))
3018
3139
    def __int__(self):
3019
 
        # DEPRECATED: push used to return the change in revno
 
3140
        """Return the relative change in revno.
 
3141
 
 
3142
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3143
        """
3020
3144
        return self.new_revno - self.old_revno
3021
3145
 
3022
3146
    def report(self, to_file):
3145
3269
    _optimisers = []
3146
3270
    """The available optimised InterBranch types."""
3147
3271
 
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)
 
3272
    @classmethod
 
3273
    def _get_branch_formats_to_test(klass):
 
3274
        """Return an iterable of format tuples for testing.
 
3275
        
 
3276
        :return: An iterable of (from_format, to_format) to use when testing
 
3277
            this InterBranch class. Each InterBranch class should define this
 
3278
            method itself.
 
3279
        """
 
3280
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3281
 
 
3282
    @needs_write_lock
3153
3283
    def pull(self, overwrite=False, stop_revision=None,
3154
3284
             possible_transports=None, local=False):
3155
3285
        """Mirror source into target branch.
3160
3290
        """
3161
3291
        raise NotImplementedError(self.pull)
3162
3292
 
 
3293
    @needs_write_lock
3163
3294
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
 
                         graph=None):
 
3295
            graph=None):
3165
3296
        """Pull in new perfect-fit revisions.
3166
3297
 
3167
3298
        :param stop_revision: Updated until the given revision
3173
3304
        """
3174
3305
        raise NotImplementedError(self.update_revisions)
3175
3306
 
 
3307
    @needs_write_lock
3176
3308
    def push(self, overwrite=False, stop_revision=None,
3177
3309
             _override_hook_source_branch=None):
3178
3310
        """Mirror the source branch into the target branch.
3181
3313
        """
3182
3314
        raise NotImplementedError(self.push)
3183
3315
 
 
3316
    @needs_write_lock
 
3317
    def copy_content_into(self, revision_id=None):
 
3318
        """Copy the content of source into target
 
3319
 
 
3320
        revision_id: if not None, the revision history in the new branch will
 
3321
                     be truncated to end with revision_id.
 
3322
        """
 
3323
        raise NotImplementedError(self.copy_content_into)
 
3324
 
 
3325
    @needs_write_lock
 
3326
    def fetch(self, stop_revision=None):
 
3327
        """Fetch revisions.
 
3328
 
 
3329
        :param stop_revision: Last revision to fetch
 
3330
        """
 
3331
        raise NotImplementedError(self.fetch)
 
3332
 
3184
3333
 
3185
3334
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
 
 
 
3335
    """InterBranch implementation that uses public Branch functions."""
 
3336
 
 
3337
    @classmethod
 
3338
    def is_compatible(klass, source, target):
 
3339
        # GenericBranch uses the public API, so always compatible
 
3340
        return True
 
3341
 
 
3342
    @classmethod
 
3343
    def _get_branch_formats_to_test(klass):
 
3344
        return [(format_registry.get_default(), format_registry.get_default())]
 
3345
 
 
3346
    @classmethod
 
3347
    def unwrap_format(klass, format):
 
3348
        if isinstance(format, remote.RemoteBranchFormat):
 
3349
            format._ensure_real()
 
3350
            return format._custom_format
 
3351
        return format
 
3352
 
 
3353
    @needs_write_lock
 
3354
    def copy_content_into(self, revision_id=None):
 
3355
        """Copy the content of source into target
 
3356
 
 
3357
        revision_id: if not None, the revision history in the new branch will
 
3358
                     be truncated to end with revision_id.
 
3359
        """
 
3360
        self.source.update_references(self.target)
 
3361
        self.source._synchronize_history(self.target, revision_id)
 
3362
        try:
 
3363
            parent = self.source.get_parent()
 
3364
        except errors.InaccessibleParent, e:
 
3365
            mutter('parent was not accessible to copy: %s', e)
 
3366
        else:
 
3367
            if parent:
 
3368
                self.target.set_parent(parent)
 
3369
        if self.source._push_should_merge_tags():
 
3370
            self.source.tags.merge_to(self.target.tags)
 
3371
 
 
3372
    @needs_write_lock
 
3373
    def fetch(self, stop_revision=None):
 
3374
        if self.target.base == self.source.base:
 
3375
            return (0, [])
 
3376
        self.source.lock_read()
 
3377
        try:
 
3378
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3379
            fetch_spec_factory.source_branch = self.source
 
3380
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3381
            fetch_spec_factory.source_repo = self.source.repository
 
3382
            fetch_spec_factory.target_repo = self.target.repository
 
3383
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3384
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3385
            return self.target.repository.fetch(self.source.repository,
 
3386
                fetch_spec=fetch_spec)
 
3387
        finally:
 
3388
            self.source.unlock()
 
3389
 
 
3390
    @needs_write_lock
3193
3391
    def update_revisions(self, stop_revision=None, overwrite=False,
3194
 
        graph=None):
 
3392
            graph=None):
3195
3393
        """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
 
 
 
3394
        other_revno, other_last_revision = self.source.last_revision_info()
 
3395
        stop_revno = None # unknown
 
3396
        if stop_revision is None:
 
3397
            stop_revision = other_last_revision
 
3398
            if _mod_revision.is_null(stop_revision):
 
3399
                # if there are no commits, we're done.
 
3400
                return
 
3401
            stop_revno = other_revno
 
3402
 
 
3403
        # what's the current last revision, before we fetch [and change it
 
3404
        # possibly]
 
3405
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3406
        # we fetch here so that we don't process data twice in the common
 
3407
        # case of having something to pull, and so that the check for
 
3408
        # already merged can operate on the just fetched graph, which will
 
3409
        # be cached in memory.
 
3410
        self.fetch(stop_revision=stop_revision)
 
3411
        # Check to see if one is an ancestor of the other
 
3412
        if not overwrite:
 
3413
            if graph is None:
 
3414
                graph = self.target.repository.get_graph()
 
3415
            if self.target._check_if_descendant_or_diverged(
 
3416
                    stop_revision, last_rev, graph, self.source):
 
3417
                # stop_revision is a descendant of last_rev, but we aren't
 
3418
                # overwriting, so we're done.
 
3419
                return
 
3420
        if stop_revno is None:
 
3421
            if graph is None:
 
3422
                graph = self.target.repository.get_graph()
 
3423
            this_revno, this_last_revision = \
 
3424
                    self.target.last_revision_info()
 
3425
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3426
                            [(other_last_revision, other_revno),
 
3427
                             (this_last_revision, this_revno)])
 
3428
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3429
 
 
3430
    @needs_write_lock
3236
3431
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3432
             possible_transports=None, run_hooks=True,
3238
3433
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
 
3434
        """Pull from source into self, updating my master if any.
3240
3435
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
3436
        :param run_hooks: Private parameter - if false, this branch
3244
3437
            is being called because it's the master of the primary branch,
3245
3438
            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
3439
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
 
3440
        bound_location = self.target.get_bound_location()
 
3441
        if local and not bound_location:
3252
3442
            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()
 
3443
        master_branch = None
 
3444
        source_is_master = (self.source.user_url == bound_location)
 
3445
        if not local and bound_location and not source_is_master:
 
3446
            # not pulling from master, so we need to update master.
 
3447
            master_branch = self.target.get_master_branch(possible_transports)
 
3448
            master_branch.lock_write()
3260
3449
        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)
 
3450
            if master_branch:
 
3451
                # pull from source into master.
 
3452
                master_branch.pull(self.source, overwrite, stop_revision,
 
3453
                    run_hooks=False)
 
3454
            return self._pull(overwrite,
 
3455
                stop_revision, _hook_master=master_branch,
 
3456
                run_hooks=run_hooks,
 
3457
                _override_hook_target=_override_hook_target,
 
3458
                merge_tags_to_master=not source_is_master)
3287
3459
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
 
3460
            if master_branch:
 
3461
                master_branch.unlock()
3290
3462
 
3291
3463
    def push(self, overwrite=False, stop_revision=None,
3292
3464
             _override_hook_source_branch=None):
3332
3504
                # push into the master from the source branch.
3333
3505
                self.source._basic_push(master_branch, overwrite, stop_revision)
3334
3506
                # and push into the target branch from the source. Note that we
3335
 
                # push from the source branch again, because its considered the
 
3507
                # push from the source branch again, because it's considered the
3336
3508
                # highest bandwidth repository.
3337
3509
                result = self.source._basic_push(self.target, overwrite,
3338
3510
                    stop_revision)
3354
3526
            _run_hooks()
3355
3527
            return result
3356
3528
 
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
 
 
 
3529
    def _pull(self, overwrite=False, stop_revision=None,
 
3530
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3531
             _override_hook_target=None, local=False,
 
3532
             merge_tags_to_master=True):
 
3533
        """See Branch.pull.
 
3534
 
 
3535
        This function is the core worker, used by GenericInterBranch.pull to
 
3536
        avoid duplication when pulling source->master and source->local.
 
3537
 
 
3538
        :param _hook_master: Private parameter - set the branch to
 
3539
            be supplied as the master to pull hooks.
3374
3540
        :param run_hooks: Private parameter - if false, this branch
3375
3541
            is being called because it's the master of the primary branch,
3376
3542
            so it should not run its hooks.
 
3543
            is being called because it's the master of the primary branch,
 
3544
            so it should not run its hooks.
 
3545
        :param _override_hook_target: Private parameter - set the branch to be
 
3546
            supplied as the target_branch to pull hooks.
 
3547
        :param local: Only update the local branch, and not the bound branch.
3377
3548
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
 
3549
        # This type of branch can't be bound.
 
3550
        if local:
3380
3551
            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()
 
3552
        result = PullResult()
 
3553
        result.source_branch = self.source
 
3554
        if _override_hook_target is None:
 
3555
            result.target_branch = self.target
 
3556
        else:
 
3557
            result.target_branch = _override_hook_target
 
3558
        self.source.lock_read()
3386
3559
        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)
 
3560
            # We assume that during 'pull' the target repository is closer than
 
3561
            # the source one.
 
3562
            self.source.update_references(self.target)
 
3563
            graph = self.target.repository.get_graph(self.source.repository)
 
3564
            # TODO: Branch formats should have a flag that indicates 
 
3565
            # that revno's are expensive, and pull() should honor that flag.
 
3566
            # -- JRV20090506
 
3567
            result.old_revno, result.old_revid = \
 
3568
                self.target.last_revision_info()
 
3569
            self.target.update_revisions(self.source, stop_revision,
 
3570
                overwrite=overwrite, graph=graph)
 
3571
            # TODO: The old revid should be specified when merging tags, 
 
3572
            # so a tags implementation that versions tags can only 
 
3573
            # pull in the most recent changes. -- JRV20090506
 
3574
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3575
                overwrite, ignore_master=not merge_tags_to_master)
 
3576
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3577
            if _hook_master:
 
3578
                result.master_branch = _hook_master
 
3579
                result.local_branch = result.target_branch
 
3580
            else:
 
3581
                result.master_branch = result.target_branch
 
3582
                result.local_branch = None
 
3583
            if run_hooks:
 
3584
                for hook in Branch.hooks['post_pull']:
 
3585
                    hook(result)
3395
3586
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
 
3587
            self.source.unlock()
 
3588
        return result
3398
3589
 
3399
3590
 
3400
3591
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)