/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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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,
32
30
        lockdir,
33
31
        lockable_files,
34
 
        remote,
35
32
        repository,
36
33
        revision as _mod_revision,
37
34
        rio,
42
39
        urlutils,
43
40
        )
44
41
from bzrlib.config import BranchConfig, TransportConfig
 
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
45
43
from bzrlib.tag import (
46
44
    BasicTags,
47
45
    DisabledTags,
48
46
    )
49
47
""")
50
48
 
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
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
50
from bzrlib.hooks import HookPoint, Hooks
60
51
from bzrlib.inter import InterObject
61
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
52
from bzrlib.lock import _RelockDebugMixin
62
53
from bzrlib import registry
63
54
from bzrlib.symbol_versioning import (
64
55
    deprecated_in,
72
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
73
64
 
74
65
 
75
 
class Branch(controldir.ControlComponent):
 
66
class Branch(bzrdir.ControlComponent):
76
67
    """Branch holding a history of revisions.
77
68
 
78
69
    :ivar base:
79
70
        Base directory/url of the branch; using control_url and
80
71
        control_transport is more standardized.
81
 
    :ivar hooks: An instance of BranchHooks.
82
 
    :ivar _master_branch_cache: cached result of get_master_branch, see
83
 
        _clear_cached_state.
 
72
 
 
73
    hooks: An instance of BranchHooks.
84
74
    """
85
75
    # this is really an instance variable - FIXME move it there
86
76
    # - RBC 20060112
100
90
        self._revision_id_to_revno_cache = None
101
91
        self._partial_revision_id_to_revno_cache = {}
102
92
        self._partial_revision_history_cache = []
103
 
        self._tags_bytes = None
104
93
        self._last_revision_info_cache = None
105
 
        self._master_branch_cache = None
106
94
        self._merge_sorted_revisions_cache = None
107
95
        self._open_hook()
108
96
        hooks = Branch.hooks['open']
114
102
 
115
103
    def _activate_fallback_location(self, url):
116
104
        """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
124
105
        repo = self._get_fallback_repository(url)
125
106
        if repo.has_same_location(self.repository):
126
107
            raise errors.UnstackableLocationError(self.user_url, url)
216
197
        return self.supports_tags() and self.tags.get_tag_dict()
217
198
 
218
199
    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
 
        """
226
200
        return BranchConfig(self)
227
201
 
228
202
    def _get_config(self):
244
218
            possible_transports=[self.bzrdir.root_transport])
245
219
        return a_branch.repository
246
220
 
247
 
    @needs_read_lock
248
221
    def _get_tags_bytes(self):
249
222
        """Get the bytes of a serialised tags dict.
250
223
 
257
230
        :return: The bytes of the tags file.
258
231
        :seealso: Branch._set_tags_bytes.
259
232
        """
260
 
        if self._tags_bytes is None:
261
 
            self._tags_bytes = self._transport.get_bytes('tags')
262
 
        return self._tags_bytes
 
233
        return self._transport.get_bytes('tags')
263
234
 
264
235
    def _get_nick(self, local=False, possible_transports=None):
265
236
        config = self.get_config()
267
238
        if not local and not config.has_explicit_nickname():
268
239
            try:
269
240
                master = self.get_master_branch(possible_transports)
270
 
                if master and self.user_url == master.user_url:
271
 
                    raise errors.RecursiveBind(self.user_url)
272
241
                if master is not None:
273
242
                    # return the master branch value
274
243
                    return master.nick
275
 
            except errors.RecursiveBind, e:
276
 
                raise e
277
244
            except errors.BzrError, e:
278
245
                # Silently fall back to local implicit nick if the master is
279
246
                # unavailable
316
283
        new_history.reverse()
317
284
        return new_history
318
285
 
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
 
        """
 
286
    def lock_write(self):
326
287
        raise NotImplementedError(self.lock_write)
327
288
 
328
289
    def lock_read(self):
329
 
        """Lock the branch for read operations.
330
 
 
331
 
        :return: A bzrlib.lock.LogicalLockResult.
332
 
        """
333
290
        raise NotImplementedError(self.lock_read)
334
291
 
335
292
    def unlock(self):
669
626
        raise errors.UnsupportedOperation(self.get_reference_info, self)
670
627
 
671
628
    @needs_write_lock
672
 
    def fetch(self, from_branch, last_revision=None):
 
629
    def fetch(self, from_branch, last_revision=None, pb=None):
673
630
        """Copy revisions from from_branch into this branch.
674
631
 
675
632
        :param from_branch: Where to copy from.
676
633
        :param last_revision: What revision to stop at (None for at the end
677
634
                              of the branch.
 
635
        :param pb: An optional progress bar to use.
678
636
        :return: None
679
637
        """
680
 
        return InterBranch.get(from_branch, self).fetch(last_revision)
 
638
        if self.base == from_branch.base:
 
639
            return (0, [])
 
640
        if pb is not None:
 
641
            symbol_versioning.warn(
 
642
                symbol_versioning.deprecated_in((1, 14, 0))
 
643
                % "pb parameter to fetch()")
 
644
        from_branch.lock_read()
 
645
        try:
 
646
            if last_revision is None:
 
647
                last_revision = from_branch.last_revision()
 
648
                last_revision = _mod_revision.ensure_null(last_revision)
 
649
            return self.repository.fetch(from_branch.repository,
 
650
                                         revision_id=last_revision,
 
651
                                         pb=pb)
 
652
        finally:
 
653
            from_branch.unlock()
681
654
 
682
655
    def get_bound_location(self):
683
656
        """Return the URL of the branch we are bound to.
694
667
 
695
668
    def get_commit_builder(self, parents, config=None, timestamp=None,
696
669
                           timezone=None, committer=None, revprops=None,
697
 
                           revision_id=None, lossy=False):
 
670
                           revision_id=None):
698
671
        """Obtain a CommitBuilder for this branch.
699
672
 
700
673
        :param parents: Revision ids of the parents of the new revision.
704
677
        :param committer: Optional committer to set for commit.
705
678
        :param revprops: Optional dictionary of revision properties.
706
679
        :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 
709
680
        """
710
681
 
711
682
        if config is None:
712
683
            config = self.get_config()
713
684
 
714
685
        return self.repository.get_commit_builder(self, parents, config,
715
 
            timestamp, timezone, committer, revprops, revision_id,
716
 
            lossy)
 
686
            timestamp, timezone, committer, revprops, revision_id)
717
687
 
718
688
    def get_master_branch(self, possible_transports=None):
719
689
        """Return the branch we are bound to.
797
767
 
798
768
    def _unstack(self):
799
769
        """Change a branch to be unstacked, copying data as needed.
800
 
 
 
770
        
801
771
        Don't call this directly, use set_stacked_on_url(None).
802
772
        """
803
773
        pb = ui.ui_factory.nested_progress_bar()
812
782
            old_repository = self.repository
813
783
            if len(old_repository._fallback_repositories) != 1:
814
784
                raise AssertionError("can't cope with fallback repositories "
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()
 
785
                    "of %r" % (self.repository,))
 
786
            # unlock it, including unlocking the fallback
844
787
            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):
 
788
            old_repository.lock_read()
 
789
            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
863
807
                self.repository.lock_write()
864
 
            # Fetch from the old repository into the new.
865
 
            old_repository.lock_read()
866
 
            try:
867
808
                # XXX: If you unstack a branch while it has a working tree
868
809
                # with a pending merge, the pending-merged revisions will no
869
810
                # longer be present.  You can (probably) revert and remerge.
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)
 
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)
878
818
            finally:
879
819
                old_repository.unlock()
880
820
        finally:
885
825
 
886
826
        :seealso: Branch._get_tags_bytes.
887
827
        """
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)
 
828
        return _run_with_write_locked_target(self, self._transport.put_bytes,
 
829
            'tags', bytes)
894
830
 
895
831
    def _cache_revision_history(self, rev_history):
896
832
        """Set the cached revision history to rev_history.
923
859
        self._revision_history_cache = None
924
860
        self._revision_id_to_revno_cache = None
925
861
        self._last_revision_info_cache = None
926
 
        self._master_branch_cache = None
927
862
        self._merge_sorted_revisions_cache = None
928
863
        self._partial_revision_history_cache = []
929
864
        self._partial_revision_id_to_revno_cache = {}
930
 
        self._tags_bytes = None
931
865
 
932
866
    def _gen_revision_history(self):
933
867
        """Return sequence of revision hashes on to this branch.
994
928
        else:
995
929
            return (0, _mod_revision.NULL_REVISION)
996
930
 
 
931
    @deprecated_method(deprecated_in((1, 6, 0)))
 
932
    def missing_revisions(self, other, stop_revision=None):
 
933
        """Return a list of new revisions that would perfectly fit.
 
934
 
 
935
        If self and other have not diverged, return a list of the revisions
 
936
        present in other, but missing from self.
 
937
        """
 
938
        self_history = self.revision_history()
 
939
        self_len = len(self_history)
 
940
        other_history = other.revision_history()
 
941
        other_len = len(other_history)
 
942
        common_index = min(self_len, other_len) -1
 
943
        if common_index >= 0 and \
 
944
            self_history[common_index] != other_history[common_index]:
 
945
            raise errors.DivergedBranches(self, other)
 
946
 
 
947
        if stop_revision is None:
 
948
            stop_revision = other_len
 
949
        else:
 
950
            if stop_revision > other_len:
 
951
                raise errors.NoSuchRevision(self, stop_revision)
 
952
        return other_history[self_len:stop_revision]
 
953
 
 
954
    @needs_write_lock
997
955
    def update_revisions(self, other, stop_revision=None, overwrite=False,
998
 
            graph=None):
 
956
                         graph=None):
999
957
        """Pull in new perfect-fit revisions.
1000
958
 
1001
959
        :param other: Another Branch to pull from
1009
967
        return InterBranch.get(other, self).update_revisions(stop_revision,
1010
968
            overwrite, graph)
1011
969
 
1012
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1013
970
    def import_last_revision_info(self, source_repo, revno, revid):
1014
971
        """Set the last revision info, importing from another repo if necessary.
1015
972
 
 
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
 
1016
976
        :param source_repo: Source repository to optionally fetch from
1017
977
        :param revno: Revision number of the new tip
1018
978
        :param revid: Revision id of the new tip
1021
981
            self.repository.fetch(source_repo, revision_id=revid)
1022
982
        self.set_last_revision_info(revno, revid)
1023
983
 
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
 
 
1045
984
    def revision_id_to_revno(self, revision_id):
1046
985
        """Given a revision id, return its revno"""
1047
986
        if _mod_revision.is_null(revision_id):
1067
1006
            self._extend_partial_history(distance_from_last)
1068
1007
        return self._partial_revision_history_cache[distance_from_last]
1069
1008
 
 
1009
    @needs_write_lock
1070
1010
    def pull(self, source, overwrite=False, stop_revision=None,
1071
1011
             possible_transports=None, *args, **kwargs):
1072
1012
        """Mirror source into this branch.
1268
1208
        return result
1269
1209
 
1270
1210
    @needs_read_lock
1271
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1272
 
            repository=None):
 
1211
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1273
1212
        """Create a new line of development from the branch, into to_bzrdir.
1274
1213
 
1275
1214
        to_bzrdir controls the branch format.
1280
1219
        if (repository_policy is not None and
1281
1220
            repository_policy.requires_stacking()):
1282
1221
            to_bzrdir._format.require_stacking(_skip_repo=True)
1283
 
        result = to_bzrdir.create_branch(repository=repository)
 
1222
        result = to_bzrdir.create_branch()
1284
1223
        result.lock_write()
1285
1224
        try:
1286
1225
            if repository_policy is not None:
1316
1255
                revno = 1
1317
1256
        destination.set_last_revision_info(revno, revision_id)
1318
1257
 
 
1258
    @needs_read_lock
1319
1259
    def copy_content_into(self, destination, revision_id=None):
1320
1260
        """Copy the content of self into destination.
1321
1261
 
1322
1262
        revision_id: if not None, the revision history in the new branch will
1323
1263
                     be truncated to end with revision_id.
1324
1264
        """
1325
 
        return InterBranch.get(self, destination).copy_content_into(
1326
 
            revision_id=revision_id)
 
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)
1327
1276
 
1328
1277
    def update_references(self, target):
1329
1278
        if not getattr(self._format, 'supports_reference_locations', False):
1374
1323
        """Return the most suitable metadir for a checkout of this branch.
1375
1324
        Weaves are used if this branch's repository uses weaves.
1376
1325
        """
1377
 
        format = self.repository.bzrdir.checkout_metadir()
1378
 
        format.set_branch_format(self._format)
 
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)
1379
1333
        return format
1380
1334
 
1381
1335
    def create_clone_on_transport(self, to_transport, revision_id=None,
1382
 
        stacked_on=None, create_prefix=False, use_existing_dir=False,
1383
 
        no_tree=None):
 
1336
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1384
1337
        """Create a clone of this branch and its bzrdir.
1385
1338
 
1386
1339
        :param to_transport: The transport to clone onto.
1393
1346
        """
1394
1347
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1395
1348
        # clone call. Or something. 20090224 RBC/spiv.
1396
 
        # XXX: Should this perhaps clone colocated branches as well, 
1397
 
        # rather than just the default branch? 20100319 JRV
1398
1349
        if revision_id is None:
1399
1350
            revision_id = self.last_revision()
1400
1351
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1401
1352
            revision_id=revision_id, stacked_on=stacked_on,
1402
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1403
 
            no_tree=no_tree)
 
1353
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1404
1354
        return dir_to.open_branch()
1405
1355
 
1406
1356
    def create_checkout(self, to_location, revision_id=None,
1521
1471
        else:
1522
1472
            raise AssertionError("invalid heads: %r" % (heads,))
1523
1473
 
1524
 
    def heads_to_fetch(self):
1525
 
        """Return the heads that must and that should be fetched to copy this
1526
 
        branch into another repo.
1527
 
 
1528
 
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
1529
 
            set of heads that must be fetched.  if_present_fetch is a set of
1530
 
            heads that must be fetched if present, but no error is necessary if
1531
 
            they are not present.
1532
 
        """
1533
 
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
1534
 
        # are the tags.
1535
 
        must_fetch = set([self.last_revision()])
1536
 
        try:
1537
 
            if_present_fetch = set(self.tags.get_reverse_tag_dict())
1538
 
        except errors.TagsNotSupported:
1539
 
            if_present_fetch = set()
1540
 
        must_fetch.discard(_mod_revision.NULL_REVISION)
1541
 
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
1542
 
        return must_fetch, if_present_fetch
1543
 
 
1544
 
 
1545
 
class BranchFormat(controldir.ControlComponentFormat):
 
1474
 
 
1475
class BranchFormat(object):
1546
1476
    """An encapsulation of the initialization and open routines for a format.
1547
1477
 
1548
1478
    Formats provide three things:
1551
1481
     * an open routine.
1552
1482
 
1553
1483
    Formats are placed in an dict by their format string for reference
1554
 
    during branch opening. It's not required that these be instances, they
 
1484
    during branch opening. Its not required that these be instances, they
1555
1485
    can be classes themselves with class methods - it simply depends on
1556
1486
    whether state is needed for a given format or not.
1557
1487
 
1560
1490
    object will be created every time regardless.
1561
1491
    """
1562
1492
 
 
1493
    _default_format = None
 
1494
    """The default format used for new branches."""
 
1495
 
 
1496
    _formats = {}
 
1497
    """The known formats."""
 
1498
 
1563
1499
    can_set_append_revisions_only = True
1564
1500
 
1565
1501
    def __eq__(self, other):
1574
1510
        try:
1575
1511
            transport = a_bzrdir.get_branch_transport(None, name=name)
1576
1512
            format_string = transport.get_bytes("format")
1577
 
            return format_registry.get(format_string)
 
1513
            return klass._formats[format_string]
1578
1514
        except errors.NoSuchFile:
1579
1515
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1580
1516
        except KeyError:
1581
1517
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1582
1518
 
1583
1519
    @classmethod
1584
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1585
1520
    def get_default_format(klass):
1586
1521
        """Return the current default format."""
1587
 
        return format_registry.get_default()
1588
 
 
1589
 
    @classmethod
1590
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1591
 
    def get_formats(klass):
1592
 
        """Get all the known formats.
1593
 
 
1594
 
        Warning: This triggers a load of all lazy registered formats: do not
1595
 
        use except when that is desireed.
1596
 
        """
1597
 
        return format_registry._get_all()
1598
 
 
1599
 
    def get_reference(self, a_bzrdir, name=None):
 
1522
        return klass._default_format
 
1523
 
 
1524
    def get_reference(self, a_bzrdir):
1600
1525
        """Get the target reference of the branch in a_bzrdir.
1601
1526
 
1602
1527
        format probing must have been completed before calling
1604
1529
        in a_bzrdir is correct.
1605
1530
 
1606
1531
        :param a_bzrdir: The bzrdir to get the branch data from.
1607
 
        :param name: Name of the colocated branch to fetch
1608
1532
        :return: None if the branch is not a reference branch.
1609
1533
        """
1610
1534
        return None
1611
1535
 
1612
1536
    @classmethod
1613
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1537
    def set_reference(self, a_bzrdir, to_branch):
1614
1538
        """Set the target reference of the branch in a_bzrdir.
1615
1539
 
1616
1540
        format probing must have been completed before calling
1618
1542
        in a_bzrdir is correct.
1619
1543
 
1620
1544
        :param a_bzrdir: The bzrdir to set the branch reference for.
1621
 
        :param name: Name of colocated branch to set, None for default
1622
1545
        :param to_branch: branch that the checkout is to reference
1623
1546
        """
1624
1547
        raise NotImplementedError(self.set_reference)
1639
1562
        for hook in hooks:
1640
1563
            hook(params)
1641
1564
 
1642
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
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):
1643
1611
        """Create a branch of this format in a_bzrdir.
1644
1612
        
1645
1613
        :param name: Name of the colocated branch to create.
1679
1647
        """
1680
1648
        raise NotImplementedError(self.network_name)
1681
1649
 
1682
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1683
 
            found_repository=None):
 
1650
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1684
1651
        """Return the branch object for a_bzrdir
1685
1652
 
1686
1653
        :param a_bzrdir: A BzrDir that contains a branch.
1693
1660
        raise NotImplementedError(self.open)
1694
1661
 
1695
1662
    @classmethod
1696
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1697
1663
    def register_format(klass, format):
1698
 
        """Register a metadir format.
1699
 
 
1700
 
        See MetaDirBranchFormatFactory for the ability to register a format
1701
 
        without loading the code the format needs until it is actually used.
1702
 
        """
1703
 
        format_registry.register(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__)
1704
1669
 
1705
1670
    @classmethod
1706
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1707
1671
    def set_default_format(klass, format):
1708
 
        format_registry.set_default(format)
 
1672
        klass._default_format = format
1709
1673
 
1710
1674
    def supports_set_append_revisions_only(self):
1711
1675
        """True if this format supports set_append_revisions_only."""
1715
1679
        """True if this format records a stacked-on branch."""
1716
1680
        return False
1717
1681
 
1718
 
    def supports_leaving_lock(self):
1719
 
        """True if this format supports leaving locks in place."""
1720
 
        return False # by default
1721
 
 
1722
1682
    @classmethod
1723
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1724
1683
    def unregister_format(klass, format):
1725
 
        format_registry.remove(format)
 
1684
        del klass._formats[format.get_format_string()]
1726
1685
 
1727
1686
    def __str__(self):
1728
1687
        return self.get_format_description().rstrip()
1732
1691
        return False  # by default
1733
1692
 
1734
1693
 
1735
 
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1736
 
    """A factory for a BranchFormat object, permitting simple lazy registration.
1737
 
    
1738
 
    While none of the built in BranchFormats are lazy registered yet,
1739
 
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1740
 
    use it, and the bzr-loom plugin uses it as well (see
1741
 
    bzrlib.plugins.loom.formats).
1742
 
    """
1743
 
 
1744
 
    def __init__(self, format_string, module_name, member_name):
1745
 
        """Create a MetaDirBranchFormatFactory.
1746
 
 
1747
 
        :param format_string: The format string the format has.
1748
 
        :param module_name: Module to load the format class from.
1749
 
        :param member_name: Attribute name within the module for the format class.
1750
 
        """
1751
 
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
1752
 
        self._format_string = format_string
1753
 
        
1754
 
    def get_format_string(self):
1755
 
        """See BranchFormat.get_format_string."""
1756
 
        return self._format_string
1757
 
 
1758
 
    def __call__(self):
1759
 
        """Used for network_format_registry support."""
1760
 
        return self.get_obj()()
1761
 
 
1762
 
 
1763
1694
class BranchHooks(Hooks):
1764
1695
    """A dictionary mapping hook name to a list of callables for branch hooks.
1765
1696
 
1773
1704
        These are all empty initially, because by default nothing should get
1774
1705
        notified.
1775
1706
        """
1776
 
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1777
 
        self.add_hook('set_rh',
 
1707
        Hooks.__init__(self)
 
1708
        self.create_hook(HookPoint('set_rh',
1778
1709
            "Invoked whenever the revision history has been set via "
1779
1710
            "set_revision_history. The api signature is (branch, "
1780
1711
            "revision_history), and the branch will be write-locked. "
1781
1712
            "The set_rh hook can be expensive for bzr to trigger, a better "
1782
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
1783
 
        self.add_hook('open',
 
1713
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
 
1714
        self.create_hook(HookPoint('open',
1784
1715
            "Called with the Branch object that has been opened after a "
1785
 
            "branch is opened.", (1, 8))
1786
 
        self.add_hook('post_push',
 
1716
            "branch is opened.", (1, 8), None))
 
1717
        self.create_hook(HookPoint('post_push',
1787
1718
            "Called after a push operation completes. post_push is called "
1788
1719
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1789
 
            "bzr client.", (0, 15))
1790
 
        self.add_hook('post_pull',
 
1720
            "bzr client.", (0, 15), None))
 
1721
        self.create_hook(HookPoint('post_pull',
1791
1722
            "Called after a pull operation completes. post_pull is called "
1792
1723
            "with a bzrlib.branch.PullResult object and only runs in the "
1793
 
            "bzr client.", (0, 15))
1794
 
        self.add_hook('pre_commit',
1795
 
            "Called after a commit is calculated but before it is "
 
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 "
1796
1727
            "completed. pre_commit is called with (local, master, old_revno, "
1797
1728
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1798
1729
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1800
1731
            "basis revision. hooks MUST NOT modify this delta. "
1801
1732
            " future_tree is an in-memory tree obtained from "
1802
1733
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1803
 
            "tree.", (0,91))
1804
 
        self.add_hook('post_commit',
 
1734
            "tree.", (0,91), None))
 
1735
        self.create_hook(HookPoint('post_commit',
1805
1736
            "Called in the bzr client after a commit has completed. "
1806
1737
            "post_commit is called with (local, master, old_revno, old_revid, "
1807
1738
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1808
 
            "commit to a branch.", (0, 15))
1809
 
        self.add_hook('post_uncommit',
 
1739
            "commit to a branch.", (0, 15), None))
 
1740
        self.create_hook(HookPoint('post_uncommit',
1810
1741
            "Called in the bzr client after an uncommit completes. "
1811
1742
            "post_uncommit is called with (local, master, old_revno, "
1812
1743
            "old_revid, new_revno, new_revid) where local is the local branch "
1813
1744
            "or None, master is the target branch, and an empty branch "
1814
 
            "receives new_revno of 0, new_revid of None.", (0, 15))
1815
 
        self.add_hook('pre_change_branch_tip',
 
1745
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1746
        self.create_hook(HookPoint('pre_change_branch_tip',
1816
1747
            "Called in bzr client and server before a change to the tip of a "
1817
1748
            "branch is made. pre_change_branch_tip is called with a "
1818
1749
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1819
 
            "commit, uncommit will all trigger this hook.", (1, 6))
1820
 
        self.add_hook('post_change_branch_tip',
 
1750
            "commit, uncommit will all trigger this hook.", (1, 6), None))
 
1751
        self.create_hook(HookPoint('post_change_branch_tip',
1821
1752
            "Called in bzr client and server after a change to the tip of a "
1822
1753
            "branch is made. post_change_branch_tip is called with a "
1823
1754
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1824
 
            "commit, uncommit will all trigger this hook.", (1, 4))
1825
 
        self.add_hook('transform_fallback_location',
 
1755
            "commit, uncommit will all trigger this hook.", (1, 4), None))
 
1756
        self.create_hook(HookPoint('transform_fallback_location',
1826
1757
            "Called when a stacked branch is activating its fallback "
1827
1758
            "locations. transform_fallback_location is called with (branch, "
1828
1759
            "url), and should return a new url. Returning the same url "
1833
1764
            "fallback locations have not been activated. When there are "
1834
1765
            "multiple hooks installed for transform_fallback_location, "
1835
1766
            "all are called with the url returned from the previous hook."
1836
 
            "The order is however undefined.", (1, 9))
1837
 
        self.add_hook('automatic_tag_name',
1838
 
            "Called to determine an automatic tag name for a revision. "
 
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."
1839
1770
            "automatic_tag_name is called with (branch, revision_id) and "
1840
1771
            "should return a tag name or None if no tag name could be "
1841
1772
            "determined. The first non-None tag name returned will be used.",
1842
 
            (2, 2))
1843
 
        self.add_hook('post_branch_init',
 
1773
            (2, 2), None))
 
1774
        self.create_hook(HookPoint('post_branch_init',
1844
1775
            "Called after new branch initialization completes. "
1845
1776
            "post_branch_init is called with a "
1846
1777
            "bzrlib.branch.BranchInitHookParams. "
1847
1778
            "Note that init, branch and checkout (both heavyweight and "
1848
 
            "lightweight) will all trigger this hook.", (2, 2))
1849
 
        self.add_hook('post_switch',
 
1779
            "lightweight) will all trigger this hook.", (2, 2), None))
 
1780
        self.create_hook(HookPoint('post_switch',
1850
1781
            "Called after a checkout switches branch. "
1851
1782
            "post_switch is called with a "
1852
 
            "bzrlib.branch.SwitchHookParams.", (2, 2))
 
1783
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1853
1784
 
1854
1785
 
1855
1786
 
1932
1863
        return self.__dict__ == other.__dict__
1933
1864
 
1934
1865
    def __repr__(self):
1935
 
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
 
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)
1936
1872
 
1937
1873
 
1938
1874
class SwitchHookParams(object):
1968
1904
            self.revision_id)
1969
1905
 
1970
1906
 
 
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
 
1971
1950
class BranchFormatMetadir(BranchFormat):
1972
1951
    """Common logic for meta-dir based branch formats."""
1973
1952
 
1975
1954
        """What class to instantiate on open calls."""
1976
1955
        raise NotImplementedError(self._branch_class)
1977
1956
 
1978
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1979
 
                           repository=None):
1980
 
        """Initialize a branch in a bzrdir, with specified files
1981
 
 
1982
 
        :param a_bzrdir: The bzrdir to initialize the branch in
1983
 
        :param utf8_files: The files to create as a list of
1984
 
            (filename, content) tuples
1985
 
        :param name: Name of colocated branch to create, if any
1986
 
        :return: a branch in this format
1987
 
        """
1988
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1989
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1990
 
        control_files = lockable_files.LockableFiles(branch_transport,
1991
 
            'lock', lockdir.LockDir)
1992
 
        control_files.create_lock()
1993
 
        control_files.lock_write()
1994
 
        try:
1995
 
            utf8_files += [('format', self.get_format_string())]
1996
 
            for (filename, content) in utf8_files:
1997
 
                branch_transport.put_bytes(
1998
 
                    filename, content,
1999
 
                    mode=a_bzrdir._get_file_mode())
2000
 
        finally:
2001
 
            control_files.unlock()
2002
 
        branch = self.open(a_bzrdir, name, _found=True,
2003
 
                found_repository=repository)
2004
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2005
 
        return branch
2006
 
 
2007
1957
    def network_name(self):
2008
1958
        """A simple byte string uniquely identifying this format for RPC calls.
2009
1959
 
2011
1961
        """
2012
1962
        return self.get_format_string()
2013
1963
 
2014
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2015
 
            found_repository=None):
 
1964
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2016
1965
        """See BranchFormat.open()."""
2017
1966
        if not _found:
2018
1967
            format = BranchFormat.find_format(a_bzrdir, name=name)
2023
1972
        try:
2024
1973
            control_files = lockable_files.LockableFiles(transport, 'lock',
2025
1974
                                                         lockdir.LockDir)
2026
 
            if found_repository is None:
2027
 
                found_repository = a_bzrdir.find_repository()
2028
1975
            return self._branch_class()(_format=self,
2029
1976
                              _control_files=control_files,
2030
1977
                              name=name,
2031
1978
                              a_bzrdir=a_bzrdir,
2032
 
                              _repository=found_repository,
 
1979
                              _repository=a_bzrdir.find_repository(),
2033
1980
                              ignore_fallbacks=ignore_fallbacks)
2034
1981
        except errors.NoSuchFile:
2035
1982
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2042
1989
    def supports_tags(self):
2043
1990
        return True
2044
1991
 
2045
 
    def supports_leaving_lock(self):
2046
 
        return True
2047
 
 
2048
1992
 
2049
1993
class BzrBranchFormat5(BranchFormatMetadir):
2050
1994
    """Bzr branch format 5.
2070
2014
        """See BranchFormat.get_format_description()."""
2071
2015
        return "Branch format 5"
2072
2016
 
2073
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2017
    def initialize(self, a_bzrdir, name=None):
2074
2018
        """Create a branch of this format in a_bzrdir."""
2075
2019
        utf8_files = [('revision-history', ''),
2076
2020
                      ('branch-name', ''),
2077
2021
                      ]
2078
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
2022
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2079
2023
 
2080
2024
    def supports_tags(self):
2081
2025
        return False
2103
2047
        """See BranchFormat.get_format_description()."""
2104
2048
        return "Branch format 6"
2105
2049
 
2106
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2050
    def initialize(self, a_bzrdir, name=None):
2107
2051
        """Create a branch of this format in a_bzrdir."""
2108
2052
        utf8_files = [('last-revision', '0 null:\n'),
2109
2053
                      ('branch.conf', ''),
2110
2054
                      ('tags', ''),
2111
2055
                      ]
2112
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
2056
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2113
2057
 
2114
2058
    def make_tags(self, branch):
2115
2059
        """See bzrlib.branch.BranchFormat.make_tags()."""
2133
2077
        """See BranchFormat.get_format_description()."""
2134
2078
        return "Branch format 8"
2135
2079
 
2136
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2080
    def initialize(self, a_bzrdir, name=None):
2137
2081
        """Create a branch of this format in a_bzrdir."""
2138
2082
        utf8_files = [('last-revision', '0 null:\n'),
2139
2083
                      ('branch.conf', ''),
2140
2084
                      ('tags', ''),
2141
2085
                      ('references', '')
2142
2086
                      ]
2143
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
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()
2144
2093
 
2145
2094
    def make_tags(self, branch):
2146
2095
        """See bzrlib.branch.BranchFormat.make_tags()."""
2155
2104
    supports_reference_locations = True
2156
2105
 
2157
2106
 
2158
 
class BzrBranchFormat7(BranchFormatMetadir):
 
2107
class BzrBranchFormat7(BzrBranchFormat8):
2159
2108
    """Branch format with last-revision, tags, and a stacked location pointer.
2160
2109
 
2161
2110
    The stacked location pointer is passed down to the repository and requires
2164
2113
    This format was introduced in bzr 1.6.
2165
2114
    """
2166
2115
 
2167
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2116
    def initialize(self, a_bzrdir, name=None):
2168
2117
        """Create a branch of this format in a_bzrdir."""
2169
2118
        utf8_files = [('last-revision', '0 null:\n'),
2170
2119
                      ('branch.conf', ''),
2171
2120
                      ('tags', ''),
2172
2121
                      ]
2173
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
2122
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2174
2123
 
2175
2124
    def _branch_class(self):
2176
2125
        return BzrBranch7
2186
2135
    def supports_set_append_revisions_only(self):
2187
2136
        return True
2188
2137
 
2189
 
    def supports_stacking(self):
2190
 
        return True
2191
 
 
2192
 
    def make_tags(self, branch):
2193
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2194
 
        return BasicTags(branch)
2195
 
 
2196
2138
    supports_reference_locations = False
2197
2139
 
2198
2140
 
2215
2157
        """See BranchFormat.get_format_description()."""
2216
2158
        return "Checkout reference format 1"
2217
2159
 
2218
 
    def get_reference(self, a_bzrdir, name=None):
 
2160
    def get_reference(self, a_bzrdir):
2219
2161
        """See BranchFormat.get_reference()."""
2220
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
2162
        transport = a_bzrdir.get_branch_transport(None)
2221
2163
        return transport.get_bytes('location')
2222
2164
 
2223
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
2165
    def set_reference(self, a_bzrdir, to_branch):
2224
2166
        """See BranchFormat.set_reference()."""
2225
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
2167
        transport = a_bzrdir.get_branch_transport(None)
2226
2168
        location = transport.put_bytes('location', to_branch.base)
2227
2169
 
2228
 
    def initialize(self, a_bzrdir, name=None, target_branch=None,
2229
 
            repository=None):
 
2170
    def initialize(self, a_bzrdir, name=None, target_branch=None):
2230
2171
        """Create a branch of this format in a_bzrdir."""
2231
2172
        if target_branch is None:
2232
2173
            # this format does not implement branch itself, thus the implicit
2260
2201
        return clone
2261
2202
 
2262
2203
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2263
 
             possible_transports=None, ignore_fallbacks=False,
2264
 
             found_repository=None):
 
2204
             possible_transports=None, ignore_fallbacks=False):
2265
2205
        """Return the branch that the branch reference in a_bzrdir points at.
2266
2206
 
2267
2207
        :param a_bzrdir: A BzrDir that contains a branch.
2281
2221
                raise AssertionError("wrong format %r found for %r" %
2282
2222
                    (format, self))
2283
2223
        if location is None:
2284
 
            location = self.get_reference(a_bzrdir, name)
 
2224
            location = self.get_reference(a_bzrdir)
2285
2225
        real_bzrdir = bzrdir.BzrDir.open(
2286
2226
            location, possible_transports=possible_transports)
2287
2227
        result = real_bzrdir.open_branch(name=name, 
2298
2238
        return result
2299
2239
 
2300
2240
 
2301
 
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2302
 
    """Branch format registry."""
2303
 
 
2304
 
    def __init__(self, other_registry=None):
2305
 
        super(BranchFormatRegistry, self).__init__(other_registry)
2306
 
        self._default_format = None
2307
 
 
2308
 
    def set_default(self, format):
2309
 
        self._default_format = format
2310
 
 
2311
 
    def get_default(self):
2312
 
        return self._default_format
2313
 
 
2314
 
 
2315
2241
network_format_registry = registry.FormatRegistry()
2316
2242
"""Registry of formats indexed by their network name.
2317
2243
 
2320
2246
BranchFormat.network_name() for more detail.
2321
2247
"""
2322
2248
 
2323
 
format_registry = BranchFormatRegistry(network_format_registry)
2324
 
 
2325
2249
 
2326
2250
# formats which have no format string are not discoverable
2327
2251
# and not independently creatable, so are not registered.
2329
2253
__format6 = BzrBranchFormat6()
2330
2254
__format7 = BzrBranchFormat7()
2331
2255
__format8 = BzrBranchFormat8()
2332
 
format_registry.register(__format5)
2333
 
format_registry.register(BranchReferenceFormat())
2334
 
format_registry.register(__format6)
2335
 
format_registry.register(__format7)
2336
 
format_registry.register(__format8)
2337
 
format_registry.set_default(__format7)
2338
 
 
2339
 
 
2340
 
class BranchWriteLockResult(LogicalLockResult):
2341
 
    """The result of write locking a branch.
2342
 
 
2343
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2344
 
        None.
2345
 
    :ivar unlock: A callable which will unlock the lock.
2346
 
    """
2347
 
 
2348
 
    def __init__(self, unlock, branch_token):
2349
 
        LogicalLockResult.__init__(self, unlock)
2350
 
        self.branch_token = branch_token
2351
 
 
2352
 
    def __repr__(self):
2353
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2354
 
            self.unlock)
 
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__)
2355
2266
 
2356
2267
 
2357
2268
class BzrBranch(Branch, _RelockDebugMixin):
2413
2324
        return self.control_files.is_locked()
2414
2325
 
2415
2326
    def lock_write(self, token=None):
2416
 
        """Lock the branch for write operations.
2417
 
 
2418
 
        :param token: A token to permit reacquiring a previously held and
2419
 
            preserved lock.
2420
 
        :return: A BranchWriteLockResult.
2421
 
        """
2422
2327
        if not self.is_locked():
2423
2328
            self._note_lock('w')
2424
2329
        # All-in-one needs to always unlock/lock.
2430
2335
        else:
2431
2336
            took_lock = False
2432
2337
        try:
2433
 
            return BranchWriteLockResult(self.unlock,
2434
 
                self.control_files.lock_write(token=token))
 
2338
            return self.control_files.lock_write(token=token)
2435
2339
        except:
2436
2340
            if took_lock:
2437
2341
                self.repository.unlock()
2438
2342
            raise
2439
2343
 
2440
2344
    def lock_read(self):
2441
 
        """Lock the branch for read operations.
2442
 
 
2443
 
        :return: A bzrlib.lock.LogicalLockResult.
2444
 
        """
2445
2345
        if not self.is_locked():
2446
2346
            self._note_lock('r')
2447
2347
        # All-in-one needs to always unlock/lock.
2454
2354
            took_lock = False
2455
2355
        try:
2456
2356
            self.control_files.lock_read()
2457
 
            return LogicalLockResult(self.unlock)
2458
2357
        except:
2459
2358
            if took_lock:
2460
2359
                self.repository.unlock()
2497
2396
            'revision-history', '\n'.join(history),
2498
2397
            mode=self.bzrdir._get_file_mode())
2499
2398
 
2500
 
    @deprecated_method(deprecated_in((2, 4, 0)))
 
2399
    @needs_write_lock
2501
2400
    def set_revision_history(self, rev_history):
2502
2401
        """See Branch.set_revision_history."""
2503
 
        self._set_revision_history(rev_history)
2504
 
 
2505
 
    @needs_write_lock
2506
 
    def _set_revision_history(self, rev_history):
2507
2402
        if 'evil' in debug.debug_flags:
2508
2403
            mutter_callsite(3, "set_revision_history scales with history.")
2509
2404
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2553
2448
            except ValueError:
2554
2449
                rev = self.repository.get_revision(revision_id)
2555
2450
                new_history = rev.get_history(self.repository)[1:]
2556
 
        destination._set_revision_history(new_history)
 
2451
        destination.set_revision_history(new_history)
2557
2452
 
2558
2453
    @needs_write_lock
2559
2454
    def set_last_revision_info(self, revno, revision_id):
2567
2462
        configured to check constraints on history, in which case this may not
2568
2463
        be permitted.
2569
2464
        """
2570
 
        if not revision_id or not isinstance(revision_id, basestring):
2571
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2465
        revision_id = _mod_revision.ensure_null(revision_id)
2572
2466
        # this old format stores the full history, but this api doesn't
2573
2467
        # provide it, so we must generate, and might as well check it's
2574
2468
        # correct
2575
2469
        history = self._lefthand_history(revision_id)
2576
2470
        if len(history) != revno:
2577
2471
            raise AssertionError('%d != %d' % (len(history), revno))
2578
 
        self._set_revision_history(history)
 
2472
        self.set_revision_history(history)
2579
2473
 
2580
2474
    def _gen_revision_history(self):
2581
2475
        history = self._transport.get_bytes('revision-history').split('\n')
2595
2489
        :param other_branch: The other branch that DivergedBranches should
2596
2490
            raise with respect to.
2597
2491
        """
2598
 
        self._set_revision_history(self._lefthand_history(revision_id,
 
2492
        self.set_revision_history(self._lefthand_history(revision_id,
2599
2493
            last_rev, other_branch))
2600
2494
 
2601
2495
    def basis_tree(self):
2621
2515
        result.target_branch = target
2622
2516
        result.old_revno, result.old_revid = target.last_revision_info()
2623
2517
        self.update_references(target)
2624
 
        if result.old_revid != stop_revision:
 
2518
        if result.old_revid != self.last_revision():
2625
2519
            # We assume that during 'push' this repository is closer than
2626
2520
            # the target.
2627
2521
            graph = self.repository.get_graph(target.repository)
2628
2522
            target.update_revisions(self, stop_revision,
2629
2523
                overwrite=overwrite, graph=graph)
2630
2524
        if self._push_should_merge_tags():
2631
 
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
 
2525
            result.tag_conflicts = self.tags.merge_to(target.tags,
 
2526
                overwrite)
2632
2527
        result.new_revno, result.new_revid = target.last_revision_info()
2633
2528
        return result
2634
2529
 
2666
2561
        """Return the branch we are bound to.
2667
2562
 
2668
2563
        :return: Either a Branch, or None
 
2564
 
 
2565
        This could memoise the branch, but if thats done
 
2566
        it must be revalidated on each new lock.
 
2567
        So for now we just don't memoise it.
 
2568
        # RBC 20060304 review this decision.
2669
2569
        """
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):
2676
2570
        bound_loc = self.get_bound_location()
2677
2571
        if not bound_loc:
2678
2572
            return None
2689
2583
 
2690
2584
        :param location: URL to the target branch
2691
2585
        """
2692
 
        self._master_branch_cache = None
2693
2586
        if location:
2694
2587
            self._transport.put_bytes('bound', location+'\n',
2695
2588
                mode=self.bzrdir._get_file_mode())
2804
2697
 
2805
2698
    @needs_write_lock
2806
2699
    def set_last_revision_info(self, revno, revision_id):
2807
 
        if not revision_id or not isinstance(revision_id, basestring):
2808
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2700
        revision_id = _mod_revision.ensure_null(revision_id)
2809
2701
        old_revno, old_revid = self.last_revision_info()
2810
2702
        if self._get_append_revisions_only():
2811
2703
            self._check_history_violation(revision_id)
2948
2840
 
2949
2841
    def set_bound_location(self, location):
2950
2842
        """See Branch.set_push_location."""
2951
 
        self._master_branch_cache = None
2952
2843
        result = None
2953
2844
        config = self.get_config()
2954
2845
        if location is None:
3031
2922
        try:
3032
2923
            index = self._partial_revision_history_cache.index(revision_id)
3033
2924
        except ValueError:
3034
 
            try:
3035
 
                self._extend_partial_history(stop_revision=revision_id)
3036
 
            except errors.RevisionNotPresent, e:
3037
 
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
 
2925
            self._extend_partial_history(stop_revision=revision_id)
3038
2926
            index = len(self._partial_revision_history_cache) - 1
3039
2927
            if self._partial_revision_history_cache[index] != revision_id:
3040
2928
                raise errors.NoSuchRevision(self, revision_id)
3095
2983
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3096
2984
    """
3097
2985
 
3098
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3099
2986
    def __int__(self):
3100
 
        """Return the relative change in revno.
3101
 
 
3102
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3103
 
        """
 
2987
        # DEPRECATED: pull used to return the change in revno
3104
2988
        return self.new_revno - self.old_revno
3105
2989
 
3106
2990
    def report(self, to_file):
3131
3015
        target, otherwise it will be None.
3132
3016
    """
3133
3017
 
3134
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3135
3018
    def __int__(self):
3136
 
        """Return the relative change in revno.
3137
 
 
3138
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3139
 
        """
 
3019
        # DEPRECATED: push used to return the change in revno
3140
3020
        return self.new_revno - self.old_revno
3141
3021
 
3142
3022
    def report(self, to_file):
3265
3145
    _optimisers = []
3266
3146
    """The available optimised InterBranch types."""
3267
3147
 
3268
 
    @classmethod
3269
 
    def _get_branch_formats_to_test(klass):
3270
 
        """Return an iterable of format tuples for testing.
3271
 
        
3272
 
        :return: An iterable of (from_format, to_format) to use when testing
3273
 
            this InterBranch class. Each InterBranch class should define this
3274
 
            method itself.
3275
 
        """
3276
 
        raise NotImplementedError(klass._get_branch_formats_to_test)
 
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)
3277
3152
 
3278
 
    @needs_write_lock
3279
3153
    def pull(self, overwrite=False, stop_revision=None,
3280
3154
             possible_transports=None, local=False):
3281
3155
        """Mirror source into target branch.
3286
3160
        """
3287
3161
        raise NotImplementedError(self.pull)
3288
3162
 
3289
 
    @needs_write_lock
3290
3163
    def update_revisions(self, stop_revision=None, overwrite=False,
3291
 
            graph=None):
 
3164
                         graph=None):
3292
3165
        """Pull in new perfect-fit revisions.
3293
3166
 
3294
3167
        :param stop_revision: Updated until the given revision
3300
3173
        """
3301
3174
        raise NotImplementedError(self.update_revisions)
3302
3175
 
3303
 
    @needs_write_lock
3304
3176
    def push(self, overwrite=False, stop_revision=None,
3305
3177
             _override_hook_source_branch=None):
3306
3178
        """Mirror the source branch into the target branch.
3309
3181
        """
3310
3182
        raise NotImplementedError(self.push)
3311
3183
 
3312
 
    @needs_write_lock
3313
 
    def copy_content_into(self, revision_id=None):
3314
 
        """Copy the content of source into target
3315
 
 
3316
 
        revision_id: if not None, the revision history in the new branch will
3317
 
                     be truncated to end with revision_id.
3318
 
        """
3319
 
        raise NotImplementedError(self.copy_content_into)
3320
 
 
3321
 
    @needs_write_lock
3322
 
    def fetch(self, stop_revision=None):
3323
 
        """Fetch revisions.
3324
 
 
3325
 
        :param stop_revision: Last revision to fetch
3326
 
        """
3327
 
        raise NotImplementedError(self.fetch)
3328
 
 
3329
3184
 
3330
3185
class GenericInterBranch(InterBranch):
3331
 
    """InterBranch implementation that uses public Branch functions."""
3332
 
 
3333
 
    @classmethod
3334
 
    def is_compatible(klass, source, target):
3335
 
        # GenericBranch uses the public API, so always compatible
3336
 
        return True
3337
 
 
3338
 
    @classmethod
3339
 
    def _get_branch_formats_to_test(klass):
3340
 
        return [(format_registry.get_default(), format_registry.get_default())]
3341
 
 
3342
 
    @classmethod
3343
 
    def unwrap_format(klass, format):
3344
 
        if isinstance(format, remote.RemoteBranchFormat):
3345
 
            format._ensure_real()
3346
 
            return format._custom_format
3347
 
        return format
3348
 
 
3349
 
    @needs_write_lock
3350
 
    def copy_content_into(self, revision_id=None):
3351
 
        """Copy the content of source into target
3352
 
 
3353
 
        revision_id: if not None, the revision history in the new branch will
3354
 
                     be truncated to end with revision_id.
3355
 
        """
3356
 
        self.source.update_references(self.target)
3357
 
        self.source._synchronize_history(self.target, revision_id)
3358
 
        try:
3359
 
            parent = self.source.get_parent()
3360
 
        except errors.InaccessibleParent, e:
3361
 
            mutter('parent was not accessible to copy: %s', e)
3362
 
        else:
3363
 
            if parent:
3364
 
                self.target.set_parent(parent)
3365
 
        if self.source._push_should_merge_tags():
3366
 
            self.source.tags.merge_to(self.target.tags)
3367
 
 
3368
 
    @needs_write_lock
3369
 
    def fetch(self, stop_revision=None):
3370
 
        if self.target.base == self.source.base:
3371
 
            return (0, [])
3372
 
        self.source.lock_read()
3373
 
        try:
3374
 
            fetch_spec_factory = fetch.FetchSpecFactory()
3375
 
            fetch_spec_factory.source_branch = self.source
3376
 
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3377
 
            fetch_spec_factory.source_repo = self.source.repository
3378
 
            fetch_spec_factory.target_repo = self.target.repository
3379
 
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3380
 
            fetch_spec = fetch_spec_factory.make_fetch_spec()
3381
 
            return self.target.repository.fetch(self.source.repository,
3382
 
                fetch_spec=fetch_spec)
3383
 
        finally:
3384
 
            self.source.unlock()
3385
 
 
3386
 
    @needs_write_lock
 
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
 
3387
3193
    def update_revisions(self, stop_revision=None, overwrite=False,
3388
 
            graph=None):
 
3194
        graph=None):
3389
3195
        """See InterBranch.update_revisions()."""
3390
 
        other_revno, other_last_revision = self.source.last_revision_info()
3391
 
        stop_revno = None # unknown
3392
 
        if stop_revision is None:
3393
 
            stop_revision = other_last_revision
3394
 
            if _mod_revision.is_null(stop_revision):
3395
 
                # if there are no commits, we're done.
3396
 
                return
3397
 
            stop_revno = other_revno
3398
 
 
3399
 
        # what's the current last revision, before we fetch [and change it
3400
 
        # possibly]
3401
 
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
3402
 
        # we fetch here so that we don't process data twice in the common
3403
 
        # case of having something to pull, and so that the check for
3404
 
        # already merged can operate on the just fetched graph, which will
3405
 
        # be cached in memory.
3406
 
        self.fetch(stop_revision=stop_revision)
3407
 
        # Check to see if one is an ancestor of the other
3408
 
        if not overwrite:
3409
 
            if graph is None:
3410
 
                graph = self.target.repository.get_graph()
3411
 
            if self.target._check_if_descendant_or_diverged(
3412
 
                    stop_revision, last_rev, graph, self.source):
3413
 
                # stop_revision is a descendant of last_rev, but we aren't
3414
 
                # overwriting, so we're done.
3415
 
                return
3416
 
        if stop_revno is None:
3417
 
            if graph is None:
3418
 
                graph = self.target.repository.get_graph()
3419
 
            this_revno, this_last_revision = \
3420
 
                    self.target.last_revision_info()
3421
 
            stop_revno = graph.find_distance_to_null(stop_revision,
3422
 
                            [(other_last_revision, other_revno),
3423
 
                             (this_last_revision, this_revno)])
3424
 
        self.target.set_last_revision_info(stop_revno, stop_revision)
3425
 
 
3426
 
    @needs_write_lock
 
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
 
3427
3236
    def pull(self, overwrite=False, stop_revision=None,
3428
 
             possible_transports=None, run_hooks=True,
 
3237
             possible_transports=None, _hook_master=None, run_hooks=True,
3429
3238
             _override_hook_target=None, local=False):
3430
 
        """Pull from source into self, updating my master if any.
 
3239
        """See Branch.pull.
3431
3240
 
 
3241
        :param _hook_master: Private parameter - set the branch to
 
3242
            be supplied as the master to pull hooks.
3432
3243
        :param run_hooks: Private parameter - if false, this branch
3433
3244
            is being called because it's the master of the primary branch,
3434
3245
            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.
3435
3249
        """
3436
 
        bound_location = self.target.get_bound_location()
3437
 
        if local and not bound_location:
 
3250
        # This type of branch can't be bound.
 
3251
        if local:
3438
3252
            raise errors.LocalRequiresBoundBranch()
3439
 
        master_branch = None
3440
 
        source_is_master = (self.source.user_url == bound_location)
3441
 
        if not local and bound_location and not source_is_master:
3442
 
            # not pulling from master, so we need to update master.
3443
 
            master_branch = self.target.get_master_branch(possible_transports)
3444
 
            master_branch.lock_write()
 
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()
3445
3260
        try:
3446
 
            if master_branch:
3447
 
                # pull from source into master.
3448
 
                master_branch.pull(self.source, overwrite, stop_revision,
3449
 
                    run_hooks=False)
3450
 
            return self._pull(overwrite,
3451
 
                stop_revision, _hook_master=master_branch,
3452
 
                run_hooks=run_hooks,
3453
 
                _override_hook_target=_override_hook_target,
3454
 
                merge_tags_to_master=not source_is_master)
 
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)
3455
3287
        finally:
3456
 
            if master_branch:
3457
 
                master_branch.unlock()
 
3288
            self.source.unlock()
 
3289
        return result
3458
3290
 
3459
3291
    def push(self, overwrite=False, stop_revision=None,
3460
3292
             _override_hook_source_branch=None):
3500
3332
                # push into the master from the source branch.
3501
3333
                self.source._basic_push(master_branch, overwrite, stop_revision)
3502
3334
                # and push into the target branch from the source. Note that we
3503
 
                # push from the source branch again, because it's considered the
 
3335
                # push from the source branch again, because its considered the
3504
3336
                # highest bandwidth repository.
3505
3337
                result = self.source._basic_push(self.target, overwrite,
3506
3338
                    stop_revision)
3522
3354
            _run_hooks()
3523
3355
            return result
3524
3356
 
3525
 
    def _pull(self, overwrite=False, stop_revision=None,
3526
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3527
 
             _override_hook_target=None, local=False,
3528
 
             merge_tags_to_master=True):
3529
 
        """See Branch.pull.
3530
 
 
3531
 
        This function is the core worker, used by GenericInterBranch.pull to
3532
 
        avoid duplication when pulling source->master and source->local.
3533
 
 
3534
 
        :param _hook_master: Private parameter - set the branch to
3535
 
            be supplied as the master to pull hooks.
 
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
 
3536
3374
        :param run_hooks: Private parameter - if false, this branch
3537
3375
            is being called because it's the master of the primary branch,
3538
3376
            so it should not run its hooks.
3539
 
            is being called because it's the master of the primary branch,
3540
 
            so it should not run its hooks.
3541
 
        :param _override_hook_target: Private parameter - set the branch to be
3542
 
            supplied as the target_branch to pull hooks.
3543
 
        :param local: Only update the local branch, and not the bound branch.
3544
3377
        """
3545
 
        # This type of branch can't be bound.
3546
 
        if local:
 
3378
        bound_location = self.target.get_bound_location()
 
3379
        if local and not bound_location:
3547
3380
            raise errors.LocalRequiresBoundBranch()
3548
 
        result = PullResult()
3549
 
        result.source_branch = self.source
3550
 
        if _override_hook_target is None:
3551
 
            result.target_branch = self.target
3552
 
        else:
3553
 
            result.target_branch = _override_hook_target
3554
 
        self.source.lock_read()
 
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()
3555
3386
        try:
3556
 
            # We assume that during 'pull' the target repository is closer than
3557
 
            # the source one.
3558
 
            self.source.update_references(self.target)
3559
 
            graph = self.target.repository.get_graph(self.source.repository)
3560
 
            # TODO: Branch formats should have a flag that indicates 
3561
 
            # that revno's are expensive, and pull() should honor that flag.
3562
 
            # -- JRV20090506
3563
 
            result.old_revno, result.old_revid = \
3564
 
                self.target.last_revision_info()
3565
 
            self.target.update_revisions(self.source, stop_revision,
3566
 
                overwrite=overwrite, graph=graph)
3567
 
            # TODO: The old revid should be specified when merging tags, 
3568
 
            # so a tags implementation that versions tags can only 
3569
 
            # pull in the most recent changes. -- JRV20090506
3570
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3571
 
                overwrite, ignore_master=not merge_tags_to_master)
3572
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3573
 
            if _hook_master:
3574
 
                result.master_branch = _hook_master
3575
 
                result.local_branch = result.target_branch
3576
 
            else:
3577
 
                result.master_branch = result.target_branch
3578
 
                result.local_branch = None
3579
 
            if run_hooks:
3580
 
                for hook in Branch.hooks['post_pull']:
3581
 
                    hook(result)
 
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)
3582
3395
        finally:
3583
 
            self.source.unlock()
3584
 
        return result
 
3396
            if master_branch:
 
3397
                master_branch.unlock()
3585
3398
 
3586
3399
 
3587
3400
InterBranch.register_optimiser(GenericInterBranch)
 
3401
InterBranch.register_optimiser(InterToBranch5)