/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-04-05 14:47:26 UTC
  • mfrom: (5752.2.11 2.4-windows-lfstat)
  • Revision ID: pqm@pqm.ubuntu.com-20110405144726-zi3lj2kwvjml4kx5
(jameinel) Add osutils.lstat/fstat so that even on Windows lstat(fname) ==
 fstat(open(fname).fileno()) (John A Meinel)

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,
46
49
    )
47
50
""")
48
51
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
 
from bzrlib.hooks import HookPoint, Hooks
 
52
from bzrlib import (
 
53
    controldir,
 
54
    )
 
55
from bzrlib.decorators import (
 
56
    needs_read_lock,
 
57
    needs_write_lock,
 
58
    only_raises,
 
59
    )
 
60
from bzrlib.hooks import Hooks
51
61
from bzrlib.inter import InterObject
52
62
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
63
from bzrlib import registry
63
73
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
74
 
65
75
 
66
 
class Branch(bzrdir.ControlComponent):
 
76
class Branch(controldir.ControlComponent):
67
77
    """Branch holding a history of revisions.
68
78
 
69
79
    :ivar base:
70
80
        Base directory/url of the branch; using control_url and
71
81
        control_transport is more standardized.
72
 
 
73
 
    hooks: An instance of BranchHooks.
 
82
    :ivar hooks: An instance of BranchHooks.
 
83
    :ivar _master_branch_cache: cached result of get_master_branch, see
 
84
        _clear_cached_state.
74
85
    """
75
86
    # this is really an instance variable - FIXME move it there
76
87
    # - RBC 20060112
90
101
        self._revision_id_to_revno_cache = None
91
102
        self._partial_revision_id_to_revno_cache = {}
92
103
        self._partial_revision_history_cache = []
 
104
        self._tags_bytes = None
93
105
        self._last_revision_info_cache = None
 
106
        self._master_branch_cache = None
94
107
        self._merge_sorted_revisions_cache = None
95
108
        self._open_hook()
96
109
        hooks = Branch.hooks['open']
102
115
 
103
116
    def _activate_fallback_location(self, url):
104
117
        """Activate the branch/repository from url as a fallback repository."""
 
118
        for existing_fallback_repo in self.repository._fallback_repositories:
 
119
            if existing_fallback_repo.user_url == url:
 
120
                # This fallback is already configured.  This probably only
 
121
                # happens because BzrDir.sprout is a horrible mess.  To avoid
 
122
                # confusing _unstack we don't add this a second time.
 
123
                mutter('duplicate activation of fallback %r on %r', url, self)
 
124
                return
105
125
        repo = self._get_fallback_repository(url)
106
126
        if repo.has_same_location(self.repository):
107
127
            raise errors.UnstackableLocationError(self.user_url, url)
197
217
        return self.supports_tags() and self.tags.get_tag_dict()
198
218
 
199
219
    def get_config(self):
 
220
        """Get a bzrlib.config.BranchConfig for this Branch.
 
221
 
 
222
        This can then be used to get and set configuration options for the
 
223
        branch.
 
224
 
 
225
        :return: A bzrlib.config.BranchConfig.
 
226
        """
200
227
        return BranchConfig(self)
201
228
 
202
229
    def _get_config(self):
218
245
            possible_transports=[self.bzrdir.root_transport])
219
246
        return a_branch.repository
220
247
 
 
248
    @needs_read_lock
221
249
    def _get_tags_bytes(self):
222
250
        """Get the bytes of a serialised tags dict.
223
251
 
230
258
        :return: The bytes of the tags file.
231
259
        :seealso: Branch._set_tags_bytes.
232
260
        """
233
 
        return self._transport.get_bytes('tags')
 
261
        if self._tags_bytes is None:
 
262
            self._tags_bytes = self._transport.get_bytes('tags')
 
263
        return self._tags_bytes
234
264
 
235
265
    def _get_nick(self, local=False, possible_transports=None):
236
266
        config = self.get_config()
238
268
        if not local and not config.has_explicit_nickname():
239
269
            try:
240
270
                master = self.get_master_branch(possible_transports)
 
271
                if master and self.user_url == master.user_url:
 
272
                    raise errors.RecursiveBind(self.user_url)
241
273
                if master is not None:
242
274
                    # return the master branch value
243
275
                    return master.nick
 
276
            except errors.RecursiveBind, e:
 
277
                raise e
244
278
            except errors.BzrError, e:
245
279
                # Silently fall back to local implicit nick if the master is
246
280
                # unavailable
636
670
        raise errors.UnsupportedOperation(self.get_reference_info, self)
637
671
 
638
672
    @needs_write_lock
639
 
    def fetch(self, from_branch, last_revision=None, pb=None):
 
673
    def fetch(self, from_branch, last_revision=None, fetch_spec=None):
640
674
        """Copy revisions from from_branch into this branch.
641
675
 
642
676
        :param from_branch: Where to copy from.
643
677
        :param last_revision: What revision to stop at (None for at the end
644
678
                              of the branch.
645
 
        :param pb: An optional progress bar to use.
 
679
        :param fetch_spec: If specified, a SearchResult or
 
680
            PendingAncestryResult that describes which revisions to copy.  This
 
681
            allows copying multiple heads at once.  Mutually exclusive with
 
682
            last_revision.
646
683
        :return: None
647
684
        """
648
 
        if self.base == from_branch.base:
649
 
            return (0, [])
650
 
        if pb is not None:
651
 
            symbol_versioning.warn(
652
 
                symbol_versioning.deprecated_in((1, 14, 0))
653
 
                % "pb parameter to fetch()")
654
 
        from_branch.lock_read()
655
 
        try:
656
 
            if last_revision is None:
657
 
                last_revision = from_branch.last_revision()
658
 
                last_revision = _mod_revision.ensure_null(last_revision)
659
 
            return self.repository.fetch(from_branch.repository,
660
 
                                         revision_id=last_revision,
661
 
                                         pb=pb)
662
 
        finally:
663
 
            from_branch.unlock()
 
685
        return InterBranch.get(from_branch, self).fetch(last_revision,
 
686
            fetch_spec)
664
687
 
665
688
    def get_bound_location(self):
666
689
        """Return the URL of the branch we are bound to.
777
800
 
778
801
    def _unstack(self):
779
802
        """Change a branch to be unstacked, copying data as needed.
780
 
        
 
803
 
781
804
        Don't call this directly, use set_stacked_on_url(None).
782
805
        """
783
806
        pb = ui.ui_factory.nested_progress_bar()
792
815
            old_repository = self.repository
793
816
            if len(old_repository._fallback_repositories) != 1:
794
817
                raise AssertionError("can't cope with fallback repositories "
795
 
                    "of %r" % (self.repository,))
796
 
            # unlock it, including unlocking the fallback
 
818
                    "of %r (fallbacks: %r)" % (old_repository,
 
819
                        old_repository._fallback_repositories))
 
820
            # Open the new repository object.
 
821
            # Repositories don't offer an interface to remove fallback
 
822
            # repositories today; take the conceptually simpler option and just
 
823
            # reopen it.  We reopen it starting from the URL so that we
 
824
            # get a separate connection for RemoteRepositories and can
 
825
            # stream from one of them to the other.  This does mean doing
 
826
            # separate SSH connection setup, but unstacking is not a
 
827
            # common operation so it's tolerable.
 
828
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
829
            new_repository = new_bzrdir.find_repository()
 
830
            if new_repository._fallback_repositories:
 
831
                raise AssertionError("didn't expect %r to have "
 
832
                    "fallback_repositories"
 
833
                    % (self.repository,))
 
834
            # Replace self.repository with the new repository.
 
835
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
836
            # lock count) of self.repository to the new repository.
 
837
            lock_token = old_repository.lock_write().repository_token
 
838
            self.repository = new_repository
 
839
            if isinstance(self, remote.RemoteBranch):
 
840
                # Remote branches can have a second reference to the old
 
841
                # repository that need to be replaced.
 
842
                if self._real_branch is not None:
 
843
                    self._real_branch.repository = new_repository
 
844
            self.repository.lock_write(token=lock_token)
 
845
            if lock_token is not None:
 
846
                old_repository.leave_lock_in_place()
797
847
            old_repository.unlock()
 
848
            if lock_token is not None:
 
849
                # XXX: self.repository.leave_lock_in_place() before this
 
850
                # function will not be preserved.  Fortunately that doesn't
 
851
                # affect the current default format (2a), and would be a
 
852
                # corner-case anyway.
 
853
                #  - Andrew Bennetts, 2010/06/30
 
854
                self.repository.dont_leave_lock_in_place()
 
855
            old_lock_count = 0
 
856
            while True:
 
857
                try:
 
858
                    old_repository.unlock()
 
859
                except errors.LockNotHeld:
 
860
                    break
 
861
                old_lock_count += 1
 
862
            if old_lock_count == 0:
 
863
                raise AssertionError(
 
864
                    'old_repository should have been locked at least once.')
 
865
            for i in range(old_lock_count-1):
 
866
                self.repository.lock_write()
 
867
            # Fetch from the old repository into the new.
798
868
            old_repository.lock_read()
799
869
            try:
800
 
                # Repositories don't offer an interface to remove fallback
801
 
                # repositories today; take the conceptually simpler option and just
802
 
                # reopen it.  We reopen it starting from the URL so that we
803
 
                # get a separate connection for RemoteRepositories and can
804
 
                # stream from one of them to the other.  This does mean doing
805
 
                # separate SSH connection setup, but unstacking is not a
806
 
                # common operation so it's tolerable.
807
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
808
 
                new_repository = new_bzrdir.find_repository()
809
 
                self.repository = new_repository
810
 
                if self.repository._fallback_repositories:
811
 
                    raise AssertionError("didn't expect %r to have "
812
 
                        "fallback_repositories"
813
 
                        % (self.repository,))
814
 
                # this is not paired with an unlock because it's just restoring
815
 
                # the previous state; the lock's released when set_stacked_on_url
816
 
                # returns
817
 
                self.repository.lock_write()
818
870
                # XXX: If you unstack a branch while it has a working tree
819
871
                # with a pending merge, the pending-merged revisions will no
820
872
                # longer be present.  You can (probably) revert and remerge.
821
 
                #
822
 
                # XXX: This only fetches up to the tip of the repository; it
823
 
                # doesn't bring across any tags.  That's fairly consistent
824
 
                # with how branch works, but perhaps not ideal.
825
 
                self.repository.fetch(old_repository,
826
 
                    revision_id=self.last_revision(),
827
 
                    find_ghosts=True)
 
873
                try:
 
874
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
875
                except errors.TagsNotSupported:
 
876
                    tags_to_fetch = set()
 
877
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
878
                    old_repository, required_ids=[self.last_revision()],
 
879
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
880
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
828
881
            finally:
829
882
                old_repository.unlock()
830
883
        finally:
835
888
 
836
889
        :seealso: Branch._get_tags_bytes.
837
890
        """
838
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
839
 
            'tags', bytes)
 
891
        return _run_with_write_locked_target(self, self._set_tags_bytes_locked,
 
892
                bytes)
 
893
 
 
894
    def _set_tags_bytes_locked(self, bytes):
 
895
        self._tags_bytes = bytes
 
896
        return self._transport.put_bytes('tags', bytes)
840
897
 
841
898
    def _cache_revision_history(self, rev_history):
842
899
        """Set the cached revision history to rev_history.
869
926
        self._revision_history_cache = None
870
927
        self._revision_id_to_revno_cache = None
871
928
        self._last_revision_info_cache = None
 
929
        self._master_branch_cache = None
872
930
        self._merge_sorted_revisions_cache = None
873
931
        self._partial_revision_history_cache = []
874
932
        self._partial_revision_id_to_revno_cache = {}
 
933
        self._tags_bytes = None
875
934
 
876
935
    def _gen_revision_history(self):
877
936
        """Return sequence of revision hashes on to this branch.
938
997
        else:
939
998
            return (0, _mod_revision.NULL_REVISION)
940
999
 
941
 
    @deprecated_method(deprecated_in((1, 6, 0)))
942
 
    def missing_revisions(self, other, stop_revision=None):
943
 
        """Return a list of new revisions that would perfectly fit.
944
 
 
945
 
        If self and other have not diverged, return a list of the revisions
946
 
        present in other, but missing from self.
947
 
        """
948
 
        self_history = self.revision_history()
949
 
        self_len = len(self_history)
950
 
        other_history = other.revision_history()
951
 
        other_len = len(other_history)
952
 
        common_index = min(self_len, other_len) -1
953
 
        if common_index >= 0 and \
954
 
            self_history[common_index] != other_history[common_index]:
955
 
            raise errors.DivergedBranches(self, other)
956
 
 
957
 
        if stop_revision is None:
958
 
            stop_revision = other_len
959
 
        else:
960
 
            if stop_revision > other_len:
961
 
                raise errors.NoSuchRevision(self, stop_revision)
962
 
        return other_history[self_len:stop_revision]
963
 
 
964
 
    @needs_write_lock
965
1000
    def update_revisions(self, other, stop_revision=None, overwrite=False,
966
 
                         graph=None):
 
1001
                         graph=None, fetch_tags=True):
967
1002
        """Pull in new perfect-fit revisions.
968
1003
 
969
1004
        :param other: Another Branch to pull from
972
1007
            to see if it is a proper descendant.
973
1008
        :param graph: A Graph object that can be used to query history
974
1009
            information. This can be None.
 
1010
        :param fetch_tags: Flag that specifies if tags from other should be
 
1011
            fetched too.
975
1012
        :return: None
976
1013
        """
977
1014
        return InterBranch.get(other, self).update_revisions(stop_revision,
978
 
            overwrite, graph)
 
1015
            overwrite, graph, fetch_tags=fetch_tags)
979
1016
 
 
1017
    @deprecated_method(deprecated_in((2, 4, 0)))
980
1018
    def import_last_revision_info(self, source_repo, revno, revid):
981
1019
        """Set the last revision info, importing from another repo if necessary.
982
1020
 
983
 
        This is used by the bound branch code to upload a revision to
984
 
        the master branch first before updating the tip of the local branch.
985
 
 
986
1021
        :param source_repo: Source repository to optionally fetch from
987
1022
        :param revno: Revision number of the new tip
988
1023
        :param revid: Revision id of the new tip
991
1026
            self.repository.fetch(source_repo, revision_id=revid)
992
1027
        self.set_last_revision_info(revno, revid)
993
1028
 
 
1029
    def import_last_revision_info_and_tags(self, source, revno, revid):
 
1030
        """Set the last revision info, importing from another repo if necessary.
 
1031
 
 
1032
        This is used by the bound branch code to upload a revision to
 
1033
        the master branch first before updating the tip of the local branch.
 
1034
        Revisions referenced by source's tags are also transferred.
 
1035
 
 
1036
        :param source: Source branch to optionally fetch from
 
1037
        :param revno: Revision number of the new tip
 
1038
        :param revid: Revision id of the new tip
 
1039
        """
 
1040
        if not self.repository.has_same_location(source.repository):
 
1041
            try:
 
1042
                tags_to_fetch = set(source.tags.get_reverse_tag_dict())
 
1043
            except errors.TagsNotSupported:
 
1044
                tags_to_fetch = set()
 
1045
            fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
1046
                source.repository, [revid],
 
1047
                if_present_ids=tags_to_fetch).execute()
 
1048
            self.repository.fetch(source.repository, fetch_spec=fetch_spec)
 
1049
        self.set_last_revision_info(revno, revid)
 
1050
 
994
1051
    def revision_id_to_revno(self, revision_id):
995
1052
        """Given a revision id, return its revno"""
996
1053
        if _mod_revision.is_null(revision_id):
1016
1073
            self._extend_partial_history(distance_from_last)
1017
1074
        return self._partial_revision_history_cache[distance_from_last]
1018
1075
 
1019
 
    @needs_write_lock
1020
1076
    def pull(self, source, overwrite=False, stop_revision=None,
1021
1077
             possible_transports=None, *args, **kwargs):
1022
1078
        """Mirror source into this branch.
1218
1274
        return result
1219
1275
 
1220
1276
    @needs_read_lock
1221
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1277
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1278
            repository=None):
1222
1279
        """Create a new line of development from the branch, into to_bzrdir.
1223
1280
 
1224
1281
        to_bzrdir controls the branch format.
1229
1286
        if (repository_policy is not None and
1230
1287
            repository_policy.requires_stacking()):
1231
1288
            to_bzrdir._format.require_stacking(_skip_repo=True)
1232
 
        result = to_bzrdir.create_branch()
 
1289
        result = to_bzrdir.create_branch(repository=repository)
1233
1290
        result.lock_write()
1234
1291
        try:
1235
1292
            if repository_policy is not None:
1265
1322
                revno = 1
1266
1323
        destination.set_last_revision_info(revno, revision_id)
1267
1324
 
1268
 
    @needs_read_lock
1269
1325
    def copy_content_into(self, destination, revision_id=None):
1270
1326
        """Copy the content of self into destination.
1271
1327
 
1272
1328
        revision_id: if not None, the revision history in the new branch will
1273
1329
                     be truncated to end with revision_id.
1274
1330
        """
1275
 
        self.update_references(destination)
1276
 
        self._synchronize_history(destination, revision_id)
1277
 
        try:
1278
 
            parent = self.get_parent()
1279
 
        except errors.InaccessibleParent, e:
1280
 
            mutter('parent was not accessible to copy: %s', e)
1281
 
        else:
1282
 
            if parent:
1283
 
                destination.set_parent(parent)
1284
 
        if self._push_should_merge_tags():
1285
 
            self.tags.merge_to(destination.tags)
 
1331
        return InterBranch.get(self, destination).copy_content_into(
 
1332
            revision_id=revision_id)
1286
1333
 
1287
1334
    def update_references(self, target):
1288
1335
        if not getattr(self._format, 'supports_reference_locations', False):
1333
1380
        """Return the most suitable metadir for a checkout of this branch.
1334
1381
        Weaves are used if this branch's repository uses weaves.
1335
1382
        """
1336
 
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1337
 
            from bzrlib.repofmt import weaverepo
1338
 
            format = bzrdir.BzrDirMetaFormat1()
1339
 
            format.repository_format = weaverepo.RepositoryFormat7()
1340
 
        else:
1341
 
            format = self.repository.bzrdir.checkout_metadir()
1342
 
            format.set_branch_format(self._format)
 
1383
        format = self.repository.bzrdir.checkout_metadir()
 
1384
        format.set_branch_format(self._format)
1343
1385
        return format
1344
1386
 
1345
1387
    def create_clone_on_transport(self, to_transport, revision_id=None,
1346
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1388
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1389
        no_tree=None):
1347
1390
        """Create a clone of this branch and its bzrdir.
1348
1391
 
1349
1392
        :param to_transport: The transport to clone onto.
1362
1405
            revision_id = self.last_revision()
1363
1406
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1364
1407
            revision_id=revision_id, stacked_on=stacked_on,
1365
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1408
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1409
            no_tree=no_tree)
1366
1410
        return dir_to.open_branch()
1367
1411
 
1368
1412
    def create_checkout(self, to_location, revision_id=None,
1483
1527
        else:
1484
1528
            raise AssertionError("invalid heads: %r" % (heads,))
1485
1529
 
1486
 
 
1487
 
class BranchFormat(object):
 
1530
    def heads_to_fetch(self):
 
1531
        """Return the heads that must and that should be fetched to copy this
 
1532
        branch into another repo.
 
1533
 
 
1534
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1535
            set of heads that must be fetched.  if_present_fetch is a set of
 
1536
            heads that must be fetched if present, but no error is necessary if
 
1537
            they are not present.
 
1538
        """
 
1539
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
 
1540
        # are the tags.
 
1541
        must_fetch = set([self.last_revision()])
 
1542
        try:
 
1543
            if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1544
        except errors.TagsNotSupported:
 
1545
            if_present_fetch = set()
 
1546
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1547
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1548
        return must_fetch, if_present_fetch
 
1549
 
 
1550
 
 
1551
class BranchFormat(controldir.ControlComponentFormat):
1488
1552
    """An encapsulation of the initialization and open routines for a format.
1489
1553
 
1490
1554
    Formats provide three things:
1493
1557
     * an open routine.
1494
1558
 
1495
1559
    Formats are placed in an dict by their format string for reference
1496
 
    during branch opening. Its not required that these be instances, they
 
1560
    during branch opening. It's not required that these be instances, they
1497
1561
    can be classes themselves with class methods - it simply depends on
1498
1562
    whether state is needed for a given format or not.
1499
1563
 
1502
1566
    object will be created every time regardless.
1503
1567
    """
1504
1568
 
1505
 
    _default_format = None
1506
 
    """The default format used for new branches."""
1507
 
 
1508
 
    _formats = {}
1509
 
    """The known formats."""
1510
 
 
1511
1569
    can_set_append_revisions_only = True
1512
1570
 
1513
1571
    def __eq__(self, other):
1522
1580
        try:
1523
1581
            transport = a_bzrdir.get_branch_transport(None, name=name)
1524
1582
            format_string = transport.get_bytes("format")
1525
 
            return klass._formats[format_string]
 
1583
            return format_registry.get(format_string)
1526
1584
        except errors.NoSuchFile:
1527
1585
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1528
1586
        except KeyError:
1529
1587
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1530
1588
 
1531
1589
    @classmethod
 
1590
    @deprecated_method(deprecated_in((2, 4, 0)))
1532
1591
    def get_default_format(klass):
1533
1592
        """Return the current default format."""
1534
 
        return klass._default_format
 
1593
        return format_registry.get_default()
 
1594
 
 
1595
    @classmethod
 
1596
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1597
    def get_formats(klass):
 
1598
        """Get all the known formats.
 
1599
 
 
1600
        Warning: This triggers a load of all lazy registered formats: do not
 
1601
        use except when that is desireed.
 
1602
        """
 
1603
        return format_registry._get_all()
1535
1604
 
1536
1605
    def get_reference(self, a_bzrdir, name=None):
1537
1606
        """Get the target reference of the branch in a_bzrdir.
1577
1646
            hook(params)
1578
1647
 
1579
1648
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1580
 
                           lock_type='metadir', set_format=True):
 
1649
                           repository=None):
1581
1650
        """Initialize a branch in a bzrdir, with specified files
1582
1651
 
1583
1652
        :param a_bzrdir: The bzrdir to initialize the branch in
1584
1653
        :param utf8_files: The files to create as a list of
1585
1654
            (filename, content) tuples
1586
1655
        :param name: Name of colocated branch to create, if any
1587
 
        :param set_format: If True, set the format with
1588
 
            self.get_format_string.  (BzrBranch4 has its format set
1589
 
            elsewhere)
1590
1656
        :return: a branch in this format
1591
1657
        """
1592
1658
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1593
1659
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1594
 
        lock_map = {
1595
 
            'metadir': ('lock', lockdir.LockDir),
1596
 
            'branch4': ('branch-lock', lockable_files.TransportLock),
1597
 
        }
1598
 
        lock_name, lock_class = lock_map[lock_type]
1599
1660
        control_files = lockable_files.LockableFiles(branch_transport,
1600
 
            lock_name, lock_class)
 
1661
            'lock', lockdir.LockDir)
1601
1662
        control_files.create_lock()
 
1663
        control_files.lock_write()
1602
1664
        try:
1603
 
            control_files.lock_write()
1604
 
        except errors.LockContention:
1605
 
            if lock_type != 'branch4':
1606
 
                raise
1607
 
            lock_taken = False
1608
 
        else:
1609
 
            lock_taken = True
1610
 
        if set_format:
1611
1665
            utf8_files += [('format', self.get_format_string())]
1612
 
        try:
1613
1666
            for (filename, content) in utf8_files:
1614
1667
                branch_transport.put_bytes(
1615
1668
                    filename, content,
1616
1669
                    mode=a_bzrdir._get_file_mode())
1617
1670
        finally:
1618
 
            if lock_taken:
1619
 
                control_files.unlock()
1620
 
        branch = self.open(a_bzrdir, name, _found=True)
 
1671
            control_files.unlock()
 
1672
        branch = self.open(a_bzrdir, name, _found=True,
 
1673
                found_repository=repository)
1621
1674
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1622
1675
        return branch
1623
1676
 
1624
 
    def initialize(self, a_bzrdir, name=None):
 
1677
    def initialize(self, a_bzrdir, name=None, repository=None):
1625
1678
        """Create a branch of this format in a_bzrdir.
1626
1679
        
1627
1680
        :param name: Name of the colocated branch to create.
1661
1714
        """
1662
1715
        raise NotImplementedError(self.network_name)
1663
1716
 
1664
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1717
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
1718
            found_repository=None):
1665
1719
        """Return the branch object for a_bzrdir
1666
1720
 
1667
1721
        :param a_bzrdir: A BzrDir that contains a branch.
1674
1728
        raise NotImplementedError(self.open)
1675
1729
 
1676
1730
    @classmethod
 
1731
    @deprecated_method(deprecated_in((2, 4, 0)))
1677
1732
    def register_format(klass, format):
1678
 
        """Register a metadir format."""
1679
 
        klass._formats[format.get_format_string()] = format
1680
 
        # Metadir formats have a network name of their format string, and get
1681
 
        # registered as class factories.
1682
 
        network_format_registry.register(format.get_format_string(), format.__class__)
 
1733
        """Register a metadir format.
 
1734
 
 
1735
        See MetaDirBranchFormatFactory for the ability to register a format
 
1736
        without loading the code the format needs until it is actually used.
 
1737
        """
 
1738
        format_registry.register(format)
1683
1739
 
1684
1740
    @classmethod
 
1741
    @deprecated_method(deprecated_in((2, 4, 0)))
1685
1742
    def set_default_format(klass, format):
1686
 
        klass._default_format = format
 
1743
        format_registry.set_default(format)
1687
1744
 
1688
1745
    def supports_set_append_revisions_only(self):
1689
1746
        """True if this format supports set_append_revisions_only."""
1693
1750
        """True if this format records a stacked-on branch."""
1694
1751
        return False
1695
1752
 
 
1753
    def supports_leaving_lock(self):
 
1754
        """True if this format supports leaving locks in place."""
 
1755
        return False # by default
 
1756
 
1696
1757
    @classmethod
 
1758
    @deprecated_method(deprecated_in((2, 4, 0)))
1697
1759
    def unregister_format(klass, format):
1698
 
        del klass._formats[format.get_format_string()]
 
1760
        format_registry.remove(format)
1699
1761
 
1700
1762
    def __str__(self):
1701
1763
        return self.get_format_description().rstrip()
1705
1767
        return False  # by default
1706
1768
 
1707
1769
 
 
1770
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1771
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1772
    
 
1773
    While none of the built in BranchFormats are lazy registered yet,
 
1774
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1775
    use it, and the bzr-loom plugin uses it as well (see
 
1776
    bzrlib.plugins.loom.formats).
 
1777
    """
 
1778
 
 
1779
    def __init__(self, format_string, module_name, member_name):
 
1780
        """Create a MetaDirBranchFormatFactory.
 
1781
 
 
1782
        :param format_string: The format string the format has.
 
1783
        :param module_name: Module to load the format class from.
 
1784
        :param member_name: Attribute name within the module for the format class.
 
1785
        """
 
1786
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1787
        self._format_string = format_string
 
1788
        
 
1789
    def get_format_string(self):
 
1790
        """See BranchFormat.get_format_string."""
 
1791
        return self._format_string
 
1792
 
 
1793
    def __call__(self):
 
1794
        """Used for network_format_registry support."""
 
1795
        return self.get_obj()()
 
1796
 
 
1797
 
1708
1798
class BranchHooks(Hooks):
1709
1799
    """A dictionary mapping hook name to a list of callables for branch hooks.
1710
1800
 
1718
1808
        These are all empty initially, because by default nothing should get
1719
1809
        notified.
1720
1810
        """
1721
 
        Hooks.__init__(self)
1722
 
        self.create_hook(HookPoint('set_rh',
 
1811
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1812
        self.add_hook('set_rh',
1723
1813
            "Invoked whenever the revision history has been set via "
1724
1814
            "set_revision_history. The api signature is (branch, "
1725
1815
            "revision_history), and the branch will be write-locked. "
1726
1816
            "The set_rh hook can be expensive for bzr to trigger, a better "
1727
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1728
 
        self.create_hook(HookPoint('open',
 
1817
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
 
1818
        self.add_hook('open',
1729
1819
            "Called with the Branch object that has been opened after a "
1730
 
            "branch is opened.", (1, 8), None))
1731
 
        self.create_hook(HookPoint('post_push',
 
1820
            "branch is opened.", (1, 8))
 
1821
        self.add_hook('post_push',
1732
1822
            "Called after a push operation completes. post_push is called "
1733
1823
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1734
 
            "bzr client.", (0, 15), None))
1735
 
        self.create_hook(HookPoint('post_pull',
 
1824
            "bzr client.", (0, 15))
 
1825
        self.add_hook('post_pull',
1736
1826
            "Called after a pull operation completes. post_pull is called "
1737
1827
            "with a bzrlib.branch.PullResult object and only runs in the "
1738
 
            "bzr client.", (0, 15), None))
1739
 
        self.create_hook(HookPoint('pre_commit',
1740
 
            "Called after a commit is calculated but before it is is "
 
1828
            "bzr client.", (0, 15))
 
1829
        self.add_hook('pre_commit',
 
1830
            "Called after a commit is calculated but before it is "
1741
1831
            "completed. pre_commit is called with (local, master, old_revno, "
1742
1832
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1743
1833
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1745
1835
            "basis revision. hooks MUST NOT modify this delta. "
1746
1836
            " future_tree is an in-memory tree obtained from "
1747
1837
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1748
 
            "tree.", (0,91), None))
1749
 
        self.create_hook(HookPoint('post_commit',
 
1838
            "tree.", (0,91))
 
1839
        self.add_hook('post_commit',
1750
1840
            "Called in the bzr client after a commit has completed. "
1751
1841
            "post_commit is called with (local, master, old_revno, old_revid, "
1752
1842
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1753
 
            "commit to a branch.", (0, 15), None))
1754
 
        self.create_hook(HookPoint('post_uncommit',
 
1843
            "commit to a branch.", (0, 15))
 
1844
        self.add_hook('post_uncommit',
1755
1845
            "Called in the bzr client after an uncommit completes. "
1756
1846
            "post_uncommit is called with (local, master, old_revno, "
1757
1847
            "old_revid, new_revno, new_revid) where local is the local branch "
1758
1848
            "or None, master is the target branch, and an empty branch "
1759
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1760
 
        self.create_hook(HookPoint('pre_change_branch_tip',
 
1849
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1850
        self.add_hook('pre_change_branch_tip',
1761
1851
            "Called in bzr client and server before a change to the tip of a "
1762
1852
            "branch is made. pre_change_branch_tip is called with a "
1763
1853
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1764
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1765
 
        self.create_hook(HookPoint('post_change_branch_tip',
 
1854
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1855
        self.add_hook('post_change_branch_tip',
1766
1856
            "Called in bzr client and server after a change to the tip of a "
1767
1857
            "branch is made. post_change_branch_tip is called with a "
1768
1858
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1769
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1770
 
        self.create_hook(HookPoint('transform_fallback_location',
 
1859
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1860
        self.add_hook('transform_fallback_location',
1771
1861
            "Called when a stacked branch is activating its fallback "
1772
1862
            "locations. transform_fallback_location is called with (branch, "
1773
1863
            "url), and should return a new url. Returning the same url "
1778
1868
            "fallback locations have not been activated. When there are "
1779
1869
            "multiple hooks installed for transform_fallback_location, "
1780
1870
            "all are called with the url returned from the previous hook."
1781
 
            "The order is however undefined.", (1, 9), None))
1782
 
        self.create_hook(HookPoint('automatic_tag_name',
1783
 
            "Called to determine an automatic tag name for a revision."
 
1871
            "The order is however undefined.", (1, 9))
 
1872
        self.add_hook('automatic_tag_name',
 
1873
            "Called to determine an automatic tag name for a revision. "
1784
1874
            "automatic_tag_name is called with (branch, revision_id) and "
1785
1875
            "should return a tag name or None if no tag name could be "
1786
1876
            "determined. The first non-None tag name returned will be used.",
1787
 
            (2, 2), None))
1788
 
        self.create_hook(HookPoint('post_branch_init',
 
1877
            (2, 2))
 
1878
        self.add_hook('post_branch_init',
1789
1879
            "Called after new branch initialization completes. "
1790
1880
            "post_branch_init is called with a "
1791
1881
            "bzrlib.branch.BranchInitHookParams. "
1792
1882
            "Note that init, branch and checkout (both heavyweight and "
1793
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1794
 
        self.create_hook(HookPoint('post_switch',
 
1883
            "lightweight) will all trigger this hook.", (2, 2))
 
1884
        self.add_hook('post_switch',
1795
1885
            "Called after a checkout switches branch. "
1796
1886
            "post_switch is called with a "
1797
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1887
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1798
1888
 
1799
1889
 
1800
1890
 
1877
1967
        return self.__dict__ == other.__dict__
1878
1968
 
1879
1969
    def __repr__(self):
1880
 
        if self.branch:
1881
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1882
 
        else:
1883
 
            return "<%s of format:%s bzrdir:%s>" % (
1884
 
                self.__class__.__name__, self.branch,
1885
 
                self.format, self.bzrdir)
 
1970
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1886
1971
 
1887
1972
 
1888
1973
class SwitchHookParams(object):
1918
2003
            self.revision_id)
1919
2004
 
1920
2005
 
1921
 
class BzrBranchFormat4(BranchFormat):
1922
 
    """Bzr branch format 4.
1923
 
 
1924
 
    This format has:
1925
 
     - a revision-history file.
1926
 
     - a branch-lock lock file [ to be shared with the bzrdir ]
1927
 
    """
1928
 
 
1929
 
    def get_format_description(self):
1930
 
        """See BranchFormat.get_format_description()."""
1931
 
        return "Branch format 4"
1932
 
 
1933
 
    def initialize(self, a_bzrdir, name=None):
1934
 
        """Create a branch of this format in a_bzrdir."""
1935
 
        utf8_files = [('revision-history', ''),
1936
 
                      ('branch-name', ''),
1937
 
                      ]
1938
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1939
 
                                       lock_type='branch4', set_format=False)
1940
 
 
1941
 
    def __init__(self):
1942
 
        super(BzrBranchFormat4, self).__init__()
1943
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1944
 
 
1945
 
    def network_name(self):
1946
 
        """The network name for this format is the control dirs disk label."""
1947
 
        return self._matchingbzrdir.get_format_string()
1948
 
 
1949
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1950
 
        """See BranchFormat.open()."""
1951
 
        if not _found:
1952
 
            # we are being called directly and must probe.
1953
 
            raise NotImplementedError
1954
 
        return BzrBranch(_format=self,
1955
 
                         _control_files=a_bzrdir._control_files,
1956
 
                         a_bzrdir=a_bzrdir,
1957
 
                         name=name,
1958
 
                         _repository=a_bzrdir.open_repository())
1959
 
 
1960
 
    def __str__(self):
1961
 
        return "Bazaar-NG branch format 4"
1962
 
 
1963
 
 
1964
2006
class BranchFormatMetadir(BranchFormat):
1965
2007
    """Common logic for meta-dir based branch formats."""
1966
2008
 
1975
2017
        """
1976
2018
        return self.get_format_string()
1977
2019
 
1978
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2020
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2021
            found_repository=None):
1979
2022
        """See BranchFormat.open()."""
1980
2023
        if not _found:
1981
2024
            format = BranchFormat.find_format(a_bzrdir, name=name)
1986
2029
        try:
1987
2030
            control_files = lockable_files.LockableFiles(transport, 'lock',
1988
2031
                                                         lockdir.LockDir)
 
2032
            if found_repository is None:
 
2033
                found_repository = a_bzrdir.find_repository()
1989
2034
            return self._branch_class()(_format=self,
1990
2035
                              _control_files=control_files,
1991
2036
                              name=name,
1992
2037
                              a_bzrdir=a_bzrdir,
1993
 
                              _repository=a_bzrdir.find_repository(),
 
2038
                              _repository=found_repository,
1994
2039
                              ignore_fallbacks=ignore_fallbacks)
1995
2040
        except errors.NoSuchFile:
1996
2041
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2003
2048
    def supports_tags(self):
2004
2049
        return True
2005
2050
 
 
2051
    def supports_leaving_lock(self):
 
2052
        return True
 
2053
 
2006
2054
 
2007
2055
class BzrBranchFormat5(BranchFormatMetadir):
2008
2056
    """Bzr branch format 5.
2028
2076
        """See BranchFormat.get_format_description()."""
2029
2077
        return "Branch format 5"
2030
2078
 
2031
 
    def initialize(self, a_bzrdir, name=None):
 
2079
    def initialize(self, a_bzrdir, name=None, repository=None):
2032
2080
        """Create a branch of this format in a_bzrdir."""
2033
2081
        utf8_files = [('revision-history', ''),
2034
2082
                      ('branch-name', ''),
2035
2083
                      ]
2036
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2084
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2037
2085
 
2038
2086
    def supports_tags(self):
2039
2087
        return False
2061
2109
        """See BranchFormat.get_format_description()."""
2062
2110
        return "Branch format 6"
2063
2111
 
2064
 
    def initialize(self, a_bzrdir, name=None):
 
2112
    def initialize(self, a_bzrdir, name=None, repository=None):
2065
2113
        """Create a branch of this format in a_bzrdir."""
2066
2114
        utf8_files = [('last-revision', '0 null:\n'),
2067
2115
                      ('branch.conf', ''),
2068
2116
                      ('tags', ''),
2069
2117
                      ]
2070
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2118
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2071
2119
 
2072
2120
    def make_tags(self, branch):
2073
2121
        """See bzrlib.branch.BranchFormat.make_tags()."""
2091
2139
        """See BranchFormat.get_format_description()."""
2092
2140
        return "Branch format 8"
2093
2141
 
2094
 
    def initialize(self, a_bzrdir, name=None):
 
2142
    def initialize(self, a_bzrdir, name=None, repository=None):
2095
2143
        """Create a branch of this format in a_bzrdir."""
2096
2144
        utf8_files = [('last-revision', '0 null:\n'),
2097
2145
                      ('branch.conf', ''),
2098
2146
                      ('tags', ''),
2099
2147
                      ('references', '')
2100
2148
                      ]
2101
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2149
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2102
2150
 
2103
2151
    def __init__(self):
2104
2152
        super(BzrBranchFormat8, self).__init__()
2127
2175
    This format was introduced in bzr 1.6.
2128
2176
    """
2129
2177
 
2130
 
    def initialize(self, a_bzrdir, name=None):
 
2178
    def initialize(self, a_bzrdir, name=None, repository=None):
2131
2179
        """Create a branch of this format in a_bzrdir."""
2132
2180
        utf8_files = [('last-revision', '0 null:\n'),
2133
2181
                      ('branch.conf', ''),
2134
2182
                      ('tags', ''),
2135
2183
                      ]
2136
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2184
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2137
2185
 
2138
2186
    def _branch_class(self):
2139
2187
        return BzrBranch7
2181
2229
        transport = a_bzrdir.get_branch_transport(None, name=name)
2182
2230
        location = transport.put_bytes('location', to_branch.base)
2183
2231
 
2184
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2232
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2233
            repository=None):
2185
2234
        """Create a branch of this format in a_bzrdir."""
2186
2235
        if target_branch is None:
2187
2236
            # this format does not implement branch itself, thus the implicit
2215
2264
        return clone
2216
2265
 
2217
2266
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2218
 
             possible_transports=None, ignore_fallbacks=False):
 
2267
             possible_transports=None, ignore_fallbacks=False,
 
2268
             found_repository=None):
2219
2269
        """Return the branch that the branch reference in a_bzrdir points at.
2220
2270
 
2221
2271
        :param a_bzrdir: A BzrDir that contains a branch.
2252
2302
        return result
2253
2303
 
2254
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
 
2255
2319
network_format_registry = registry.FormatRegistry()
2256
2320
"""Registry of formats indexed by their network name.
2257
2321
 
2260
2324
BranchFormat.network_name() for more detail.
2261
2325
"""
2262
2326
 
 
2327
format_registry = BranchFormatRegistry(network_format_registry)
 
2328
 
2263
2329
 
2264
2330
# formats which have no format string are not discoverable
2265
2331
# and not independently creatable, so are not registered.
2267
2333
__format6 = BzrBranchFormat6()
2268
2334
__format7 = BzrBranchFormat7()
2269
2335
__format8 = BzrBranchFormat8()
2270
 
BranchFormat.register_format(__format5)
2271
 
BranchFormat.register_format(BranchReferenceFormat())
2272
 
BranchFormat.register_format(__format6)
2273
 
BranchFormat.register_format(__format7)
2274
 
BranchFormat.register_format(__format8)
2275
 
BranchFormat.set_default_format(__format7)
2276
 
_legacy_formats = [BzrBranchFormat4(),
2277
 
    ]
2278
 
network_format_registry.register(
2279
 
    _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)
2280
2342
 
2281
2343
 
2282
2344
class BranchWriteLockResult(LogicalLockResult):
2558
2620
        result.target_branch = target
2559
2621
        result.old_revno, result.old_revid = target.last_revision_info()
2560
2622
        self.update_references(target)
2561
 
        if result.old_revid != self.last_revision():
 
2623
        if result.old_revid != stop_revision:
2562
2624
            # We assume that during 'push' this repository is closer than
2563
2625
            # the target.
2564
2626
            graph = self.repository.get_graph(target.repository)
2565
2627
            target.update_revisions(self, stop_revision,
2566
2628
                overwrite=overwrite, graph=graph)
2567
2629
        if self._push_should_merge_tags():
2568
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2569
 
                overwrite)
 
2630
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2570
2631
        result.new_revno, result.new_revid = target.last_revision_info()
2571
2632
        return result
2572
2633
 
2604
2665
        """Return the branch we are bound to.
2605
2666
 
2606
2667
        :return: Either a Branch, or None
2607
 
 
2608
 
        This could memoise the branch, but if thats done
2609
 
        it must be revalidated on each new lock.
2610
 
        So for now we just don't memoise it.
2611
 
        # RBC 20060304 review this decision.
2612
2668
        """
 
2669
        if self._master_branch_cache is None:
 
2670
            self._master_branch_cache = self._get_master_branch(
 
2671
                possible_transports)
 
2672
        return self._master_branch_cache
 
2673
 
 
2674
    def _get_master_branch(self, possible_transports):
2613
2675
        bound_loc = self.get_bound_location()
2614
2676
        if not bound_loc:
2615
2677
            return None
2626
2688
 
2627
2689
        :param location: URL to the target branch
2628
2690
        """
 
2691
        self._master_branch_cache = None
2629
2692
        if location:
2630
2693
            self._transport.put_bytes('bound', location+'\n',
2631
2694
                mode=self.bzrdir._get_file_mode())
2883
2946
 
2884
2947
    def set_bound_location(self, location):
2885
2948
        """See Branch.set_push_location."""
 
2949
        self._master_branch_cache = None
2886
2950
        result = None
2887
2951
        config = self.get_config()
2888
2952
        if location is None:
2965
3029
        try:
2966
3030
            index = self._partial_revision_history_cache.index(revision_id)
2967
3031
        except ValueError:
2968
 
            self._extend_partial_history(stop_revision=revision_id)
 
3032
            try:
 
3033
                self._extend_partial_history(stop_revision=revision_id)
 
3034
            except errors.RevisionNotPresent, e:
 
3035
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2969
3036
            index = len(self._partial_revision_history_cache) - 1
2970
3037
            if self._partial_revision_history_cache[index] != revision_id:
2971
3038
                raise errors.NoSuchRevision(self, revision_id)
3026
3093
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3027
3094
    """
3028
3095
 
 
3096
    @deprecated_method(deprecated_in((2, 3, 0)))
3029
3097
    def __int__(self):
3030
 
        # DEPRECATED: pull used to return the change in revno
 
3098
        """Return the relative change in revno.
 
3099
 
 
3100
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3101
        """
3031
3102
        return self.new_revno - self.old_revno
3032
3103
 
3033
3104
    def report(self, to_file):
3058
3129
        target, otherwise it will be None.
3059
3130
    """
3060
3131
 
 
3132
    @deprecated_method(deprecated_in((2, 3, 0)))
3061
3133
    def __int__(self):
3062
 
        # DEPRECATED: push used to return the change in revno
 
3134
        """Return the relative change in revno.
 
3135
 
 
3136
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3137
        """
3063
3138
        return self.new_revno - self.old_revno
3064
3139
 
3065
3140
    def report(self, to_file):
3188
3263
    _optimisers = []
3189
3264
    """The available optimised InterBranch types."""
3190
3265
 
3191
 
    @staticmethod
3192
 
    def _get_branch_formats_to_test():
3193
 
        """Return a tuple with the Branch formats to use when testing."""
3194
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
3266
    @classmethod
 
3267
    def _get_branch_formats_to_test(klass):
 
3268
        """Return an iterable of format tuples for testing.
 
3269
        
 
3270
        :return: An iterable of (from_format, to_format) to use when testing
 
3271
            this InterBranch class. Each InterBranch class should define this
 
3272
            method itself.
 
3273
        """
 
3274
        raise NotImplementedError(klass._get_branch_formats_to_test)
3195
3275
 
 
3276
    @needs_write_lock
3196
3277
    def pull(self, overwrite=False, stop_revision=None,
3197
3278
             possible_transports=None, local=False):
3198
3279
        """Mirror source into target branch.
3203
3284
        """
3204
3285
        raise NotImplementedError(self.pull)
3205
3286
 
 
3287
    @needs_write_lock
3206
3288
    def update_revisions(self, stop_revision=None, overwrite=False,
3207
 
                         graph=None):
 
3289
                         graph=None, fetch_tags=True):
3208
3290
        """Pull in new perfect-fit revisions.
3209
3291
 
3210
3292
        :param stop_revision: Updated until the given revision
3212
3294
            to see if it is a proper descendant.
3213
3295
        :param graph: A Graph object that can be used to query history
3214
3296
            information. This can be None.
 
3297
        :param fetch_tags: Flag that specifies if tags from source should be
 
3298
            fetched too.
3215
3299
        :return: None
3216
3300
        """
3217
3301
        raise NotImplementedError(self.update_revisions)
3218
3302
 
 
3303
    @needs_write_lock
3219
3304
    def push(self, overwrite=False, stop_revision=None,
3220
3305
             _override_hook_source_branch=None):
3221
3306
        """Mirror the source branch into the target branch.
3224
3309
        """
3225
3310
        raise NotImplementedError(self.push)
3226
3311
 
 
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, fetch_spec=None):
 
3323
        """Fetch revisions.
 
3324
 
 
3325
        :param stop_revision: Last revision to fetch
 
3326
        :param fetch_spec: Fetch spec.
 
3327
        """
 
3328
        raise NotImplementedError(self.fetch)
 
3329
 
3227
3330
 
3228
3331
class GenericInterBranch(InterBranch):
3229
 
    """InterBranch implementation that uses public Branch functions.
3230
 
    """
3231
 
 
3232
 
    @staticmethod
3233
 
    def _get_branch_formats_to_test():
3234
 
        return BranchFormat._default_format, BranchFormat._default_format
3235
 
 
 
3332
    """InterBranch implementation that uses public Branch functions."""
 
3333
 
 
3334
    @classmethod
 
3335
    def is_compatible(klass, source, target):
 
3336
        # GenericBranch uses the public API, so always compatible
 
3337
        return True
 
3338
 
 
3339
    @classmethod
 
3340
    def _get_branch_formats_to_test(klass):
 
3341
        return [(format_registry.get_default(), format_registry.get_default())]
 
3342
 
 
3343
    @classmethod
 
3344
    def unwrap_format(klass, format):
 
3345
        if isinstance(format, remote.RemoteBranchFormat):
 
3346
            format._ensure_real()
 
3347
            return format._custom_format
 
3348
        return format
 
3349
 
 
3350
    @needs_write_lock
 
3351
    def copy_content_into(self, revision_id=None):
 
3352
        """Copy the content of source into target
 
3353
 
 
3354
        revision_id: if not None, the revision history in the new branch will
 
3355
                     be truncated to end with revision_id.
 
3356
        """
 
3357
        self.source.update_references(self.target)
 
3358
        self.source._synchronize_history(self.target, revision_id)
 
3359
        try:
 
3360
            parent = self.source.get_parent()
 
3361
        except errors.InaccessibleParent, e:
 
3362
            mutter('parent was not accessible to copy: %s', e)
 
3363
        else:
 
3364
            if parent:
 
3365
                self.target.set_parent(parent)
 
3366
        if self.source._push_should_merge_tags():
 
3367
            self.source.tags.merge_to(self.target.tags)
 
3368
 
 
3369
    @needs_write_lock
 
3370
    def fetch(self, stop_revision=None, fetch_spec=None):
 
3371
        if fetch_spec is not None and stop_revision is not None:
 
3372
            raise AssertionError(
 
3373
                "fetch_spec and last_revision are mutually exclusive.")
 
3374
        if self.target.base == self.source.base:
 
3375
            return (0, [])
 
3376
        self.source.lock_read()
 
3377
        try:
 
3378
            if stop_revision is None and fetch_spec is None:
 
3379
                stop_revision = self.source.last_revision()
 
3380
                stop_revision = _mod_revision.ensure_null(stop_revision)
 
3381
            return self.target.repository.fetch(self.source.repository,
 
3382
                revision_id=stop_revision, fetch_spec=fetch_spec)
 
3383
        finally:
 
3384
            self.source.unlock()
 
3385
 
 
3386
    @needs_write_lock
3236
3387
    def update_revisions(self, stop_revision=None, overwrite=False,
3237
 
        graph=None):
 
3388
        graph=None, fetch_tags=True):
3238
3389
        """See InterBranch.update_revisions()."""
3239
 
        self.source.lock_read()
3240
 
        try:
3241
 
            other_revno, other_last_revision = self.source.last_revision_info()
3242
 
            stop_revno = None # unknown
3243
 
            if stop_revision is None:
3244
 
                stop_revision = other_last_revision
3245
 
                if _mod_revision.is_null(stop_revision):
3246
 
                    # if there are no commits, we're done.
3247
 
                    return
3248
 
                stop_revno = other_revno
3249
 
 
3250
 
            # what's the current last revision, before we fetch [and change it
3251
 
            # possibly]
3252
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3253
 
            # we fetch here so that we don't process data twice in the common
3254
 
            # case of having something to pull, and so that the check for
3255
 
            # already merged can operate on the just fetched graph, which will
3256
 
            # be cached in memory.
3257
 
            self.target.fetch(self.source, stop_revision)
3258
 
            # Check to see if one is an ancestor of the other
3259
 
            if not overwrite:
3260
 
                if graph is None:
3261
 
                    graph = self.target.repository.get_graph()
3262
 
                if self.target._check_if_descendant_or_diverged(
3263
 
                        stop_revision, last_rev, graph, self.source):
3264
 
                    # stop_revision is a descendant of last_rev, but we aren't
3265
 
                    # overwriting, so we're done.
3266
 
                    return
3267
 
            if stop_revno is None:
3268
 
                if graph is None:
3269
 
                    graph = self.target.repository.get_graph()
3270
 
                this_revno, this_last_revision = \
3271
 
                        self.target.last_revision_info()
3272
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3273
 
                                [(other_last_revision, other_revno),
3274
 
                                 (this_last_revision, this_revno)])
3275
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
3276
 
        finally:
3277
 
            self.source.unlock()
3278
 
 
 
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
        if fetch_tags:
 
3407
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3408
            fetch_spec_factory.source_branch = self.source
 
3409
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3410
            fetch_spec_factory.source_repo = self.source.repository
 
3411
            fetch_spec_factory.target_repo = self.target.repository
 
3412
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3413
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3414
        else:
 
3415
            fetch_spec = _mod_graph.NotInOtherForRevs(self.target.repository,
 
3416
                self.source.repository, revision_ids=[stop_revision]).execute()
 
3417
        self.target.fetch(self.source, fetch_spec=fetch_spec)
 
3418
        # Check to see if one is an ancestor of the other
 
3419
        if not overwrite:
 
3420
            if graph is None:
 
3421
                graph = self.target.repository.get_graph()
 
3422
            if self.target._check_if_descendant_or_diverged(
 
3423
                    stop_revision, last_rev, graph, self.source):
 
3424
                # stop_revision is a descendant of last_rev, but we aren't
 
3425
                # overwriting, so we're done.
 
3426
                return
 
3427
        if stop_revno is None:
 
3428
            if graph is None:
 
3429
                graph = self.target.repository.get_graph()
 
3430
            this_revno, this_last_revision = \
 
3431
                    self.target.last_revision_info()
 
3432
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3433
                            [(other_last_revision, other_revno),
 
3434
                             (this_last_revision, this_revno)])
 
3435
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3436
 
 
3437
    @needs_write_lock
3279
3438
    def pull(self, overwrite=False, stop_revision=None,
3280
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3439
             possible_transports=None, run_hooks=True,
3281
3440
             _override_hook_target=None, local=False):
3282
 
        """See Branch.pull.
 
3441
        """Pull from source into self, updating my master if any.
3283
3442
 
3284
 
        :param _hook_master: Private parameter - set the branch to
3285
 
            be supplied as the master to pull hooks.
3286
3443
        :param run_hooks: Private parameter - if false, this branch
3287
3444
            is being called because it's the master of the primary branch,
3288
3445
            so it should not run its hooks.
3289
 
        :param _override_hook_target: Private parameter - set the branch to be
3290
 
            supplied as the target_branch to pull hooks.
3291
 
        :param local: Only update the local branch, and not the bound branch.
3292
3446
        """
3293
 
        # This type of branch can't be bound.
3294
 
        if local:
 
3447
        bound_location = self.target.get_bound_location()
 
3448
        if local and not bound_location:
3295
3449
            raise errors.LocalRequiresBoundBranch()
3296
 
        result = PullResult()
3297
 
        result.source_branch = self.source
3298
 
        if _override_hook_target is None:
3299
 
            result.target_branch = self.target
3300
 
        else:
3301
 
            result.target_branch = _override_hook_target
3302
 
        self.source.lock_read()
 
3450
        master_branch = None
 
3451
        source_is_master = (self.source.user_url == bound_location)
 
3452
        if not local and bound_location and not source_is_master:
 
3453
            # not pulling from master, so we need to update master.
 
3454
            master_branch = self.target.get_master_branch(possible_transports)
 
3455
            master_branch.lock_write()
3303
3456
        try:
3304
 
            # We assume that during 'pull' the target repository is closer than
3305
 
            # the source one.
3306
 
            self.source.update_references(self.target)
3307
 
            graph = self.target.repository.get_graph(self.source.repository)
3308
 
            # TODO: Branch formats should have a flag that indicates 
3309
 
            # that revno's are expensive, and pull() should honor that flag.
3310
 
            # -- JRV20090506
3311
 
            result.old_revno, result.old_revid = \
3312
 
                self.target.last_revision_info()
3313
 
            self.target.update_revisions(self.source, stop_revision,
3314
 
                overwrite=overwrite, graph=graph)
3315
 
            # TODO: The old revid should be specified when merging tags, 
3316
 
            # so a tags implementation that versions tags can only 
3317
 
            # pull in the most recent changes. -- JRV20090506
3318
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3319
 
                overwrite)
3320
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3321
 
            if _hook_master:
3322
 
                result.master_branch = _hook_master
3323
 
                result.local_branch = result.target_branch
3324
 
            else:
3325
 
                result.master_branch = result.target_branch
3326
 
                result.local_branch = None
3327
 
            if run_hooks:
3328
 
                for hook in Branch.hooks['post_pull']:
3329
 
                    hook(result)
 
3457
            if master_branch:
 
3458
                # pull from source into master.
 
3459
                master_branch.pull(self.source, overwrite, stop_revision,
 
3460
                    run_hooks=False)
 
3461
            return self._pull(overwrite,
 
3462
                stop_revision, _hook_master=master_branch,
 
3463
                run_hooks=run_hooks,
 
3464
                _override_hook_target=_override_hook_target,
 
3465
                merge_tags_to_master=not source_is_master)
3330
3466
        finally:
3331
 
            self.source.unlock()
3332
 
        return result
 
3467
            if master_branch:
 
3468
                master_branch.unlock()
3333
3469
 
3334
3470
    def push(self, overwrite=False, stop_revision=None,
3335
3471
             _override_hook_source_branch=None):
3375
3511
                # push into the master from the source branch.
3376
3512
                self.source._basic_push(master_branch, overwrite, stop_revision)
3377
3513
                # and push into the target branch from the source. Note that we
3378
 
                # push from the source branch again, because its considered the
 
3514
                # push from the source branch again, because it's considered the
3379
3515
                # highest bandwidth repository.
3380
3516
                result = self.source._basic_push(self.target, overwrite,
3381
3517
                    stop_revision)
3397
3533
            _run_hooks()
3398
3534
            return result
3399
3535
 
3400
 
    @classmethod
3401
 
    def is_compatible(self, source, target):
3402
 
        # GenericBranch uses the public API, so always compatible
3403
 
        return True
3404
 
 
3405
 
 
3406
 
class InterToBranch5(GenericInterBranch):
3407
 
 
3408
 
    @staticmethod
3409
 
    def _get_branch_formats_to_test():
3410
 
        return BranchFormat._default_format, BzrBranchFormat5()
3411
 
 
3412
 
    def pull(self, overwrite=False, stop_revision=None,
3413
 
             possible_transports=None, run_hooks=True,
3414
 
             _override_hook_target=None, local=False):
3415
 
        """Pull from source into self, updating my master if any.
3416
 
 
 
3536
    def _pull(self, overwrite=False, stop_revision=None,
 
3537
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3538
             _override_hook_target=None, local=False,
 
3539
             merge_tags_to_master=True):
 
3540
        """See Branch.pull.
 
3541
 
 
3542
        This function is the core worker, used by GenericInterBranch.pull to
 
3543
        avoid duplication when pulling source->master and source->local.
 
3544
 
 
3545
        :param _hook_master: Private parameter - set the branch to
 
3546
            be supplied as the master to pull hooks.
3417
3547
        :param run_hooks: Private parameter - if false, this branch
3418
3548
            is being called because it's the master of the primary branch,
3419
3549
            so it should not run its hooks.
 
3550
            is being called because it's the master of the primary branch,
 
3551
            so it should not run its hooks.
 
3552
        :param _override_hook_target: Private parameter - set the branch to be
 
3553
            supplied as the target_branch to pull hooks.
 
3554
        :param local: Only update the local branch, and not the bound branch.
3420
3555
        """
3421
 
        bound_location = self.target.get_bound_location()
3422
 
        if local and not bound_location:
 
3556
        # This type of branch can't be bound.
 
3557
        if local:
3423
3558
            raise errors.LocalRequiresBoundBranch()
3424
 
        master_branch = None
3425
 
        if not local and bound_location and self.source.user_url != bound_location:
3426
 
            # not pulling from master, so we need to update master.
3427
 
            master_branch = self.target.get_master_branch(possible_transports)
3428
 
            master_branch.lock_write()
 
3559
        result = PullResult()
 
3560
        result.source_branch = self.source
 
3561
        if _override_hook_target is None:
 
3562
            result.target_branch = self.target
 
3563
        else:
 
3564
            result.target_branch = _override_hook_target
 
3565
        self.source.lock_read()
3429
3566
        try:
3430
 
            if master_branch:
3431
 
                # pull from source into master.
3432
 
                master_branch.pull(self.source, overwrite, stop_revision,
3433
 
                    run_hooks=False)
3434
 
            return super(InterToBranch5, self).pull(overwrite,
3435
 
                stop_revision, _hook_master=master_branch,
3436
 
                run_hooks=run_hooks,
3437
 
                _override_hook_target=_override_hook_target)
 
3567
            # We assume that during 'pull' the target repository is closer than
 
3568
            # the source one.
 
3569
            self.source.update_references(self.target)
 
3570
            graph = self.target.repository.get_graph(self.source.repository)
 
3571
            # TODO: Branch formats should have a flag that indicates 
 
3572
            # that revno's are expensive, and pull() should honor that flag.
 
3573
            # -- JRV20090506
 
3574
            result.old_revno, result.old_revid = \
 
3575
                self.target.last_revision_info()
 
3576
            self.target.update_revisions(self.source, stop_revision,
 
3577
                overwrite=overwrite, graph=graph)
 
3578
            # TODO: The old revid should be specified when merging tags, 
 
3579
            # so a tags implementation that versions tags can only 
 
3580
            # pull in the most recent changes. -- JRV20090506
 
3581
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3582
                overwrite, ignore_master=not merge_tags_to_master)
 
3583
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3584
            if _hook_master:
 
3585
                result.master_branch = _hook_master
 
3586
                result.local_branch = result.target_branch
 
3587
            else:
 
3588
                result.master_branch = result.target_branch
 
3589
                result.local_branch = None
 
3590
            if run_hooks:
 
3591
                for hook in Branch.hooks['post_pull']:
 
3592
                    hook(result)
3438
3593
        finally:
3439
 
            if master_branch:
3440
 
                master_branch.unlock()
 
3594
            self.source.unlock()
 
3595
        return result
3441
3596
 
3442
3597
 
3443
3598
InterBranch.register_optimiser(GenericInterBranch)
3444
 
InterBranch.register_optimiser(InterToBranch5)