/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: Jelmer Vernooij
  • Date: 2011-02-10 17:03:01 UTC
  • mto: (5582.12.2 weave-plugin)
  • mto: This revision was merged to the branch mainline in revision 5718.
  • Revision ID: jelmer@samba.org-20110210170301-dy1eidk19mcax23k
Revert unnecessary changes.

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
25
25
        bzrdir,
26
26
        cache_utf8,
27
27
        config as _mod_config,
 
28
        controldir,
28
29
        debug,
29
30
        errors,
 
31
        fetch,
 
32
        graph as _mod_graph,
30
33
        lockdir,
31
34
        lockable_files,
 
35
        remote,
32
36
        repository,
33
37
        revision as _mod_revision,
34
38
        rio,
49
53
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
54
from bzrlib.hooks import HookPoint, Hooks
51
55
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
 
56
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
57
from bzrlib import registry
54
58
from bzrlib.symbol_versioning import (
55
59
    deprecated_in,
63
67
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
68
 
65
69
 
66
 
class Branch(bzrdir.ControlComponent):
 
70
class Branch(controldir.ControlComponent):
67
71
    """Branch holding a history of revisions.
68
72
 
69
73
    :ivar base:
90
94
        self._revision_id_to_revno_cache = None
91
95
        self._partial_revision_id_to_revno_cache = {}
92
96
        self._partial_revision_history_cache = []
 
97
        self._tags_bytes = None
93
98
        self._last_revision_info_cache = None
94
99
        self._merge_sorted_revisions_cache = None
95
100
        self._open_hook()
102
107
 
103
108
    def _activate_fallback_location(self, url):
104
109
        """Activate the branch/repository from url as a fallback repository."""
 
110
        for existing_fallback_repo in self.repository._fallback_repositories:
 
111
            if existing_fallback_repo.user_url == url:
 
112
                # This fallback is already configured.  This probably only
 
113
                # happens because BzrDir.sprout is a horrible mess.  To avoid
 
114
                # confusing _unstack we don't add this a second time.
 
115
                mutter('duplicate activation of fallback %r on %r', url, self)
 
116
                return
105
117
        repo = self._get_fallback_repository(url)
106
118
        if repo.has_same_location(self.repository):
107
119
            raise errors.UnstackableLocationError(self.user_url, url)
197
209
        return self.supports_tags() and self.tags.get_tag_dict()
198
210
 
199
211
    def get_config(self):
 
212
        """Get a bzrlib.config.BranchConfig for this Branch.
 
213
 
 
214
        This can then be used to get and set configuration options for the
 
215
        branch.
 
216
 
 
217
        :return: A bzrlib.config.BranchConfig.
 
218
        """
200
219
        return BranchConfig(self)
201
220
 
202
221
    def _get_config(self):
218
237
            possible_transports=[self.bzrdir.root_transport])
219
238
        return a_branch.repository
220
239
 
 
240
    @needs_read_lock
221
241
    def _get_tags_bytes(self):
222
242
        """Get the bytes of a serialised tags dict.
223
243
 
230
250
        :return: The bytes of the tags file.
231
251
        :seealso: Branch._set_tags_bytes.
232
252
        """
233
 
        return self._transport.get_bytes('tags')
 
253
        if self._tags_bytes is None:
 
254
            self._tags_bytes = self._transport.get_bytes('tags')
 
255
        return self._tags_bytes
234
256
 
235
257
    def _get_nick(self, local=False, possible_transports=None):
236
258
        config = self.get_config()
238
260
        if not local and not config.has_explicit_nickname():
239
261
            try:
240
262
                master = self.get_master_branch(possible_transports)
 
263
                if master and self.user_url == master.user_url:
 
264
                    raise errors.RecursiveBind(self.user_url)
241
265
                if master is not None:
242
266
                    # return the master branch value
243
267
                    return master.nick
 
268
            except errors.RecursiveBind, e:
 
269
                raise e
244
270
            except errors.BzrError, e:
245
271
                # Silently fall back to local implicit nick if the master is
246
272
                # unavailable
283
309
        new_history.reverse()
284
310
        return new_history
285
311
 
286
 
    def lock_write(self):
 
312
    def lock_write(self, token=None):
 
313
        """Lock the branch for write operations.
 
314
 
 
315
        :param token: A token to permit reacquiring a previously held and
 
316
            preserved lock.
 
317
        :return: A BranchWriteLockResult.
 
318
        """
287
319
        raise NotImplementedError(self.lock_write)
288
320
 
289
321
    def lock_read(self):
 
322
        """Lock the branch for read operations.
 
323
 
 
324
        :return: A bzrlib.lock.LogicalLockResult.
 
325
        """
290
326
        raise NotImplementedError(self.lock_read)
291
327
 
292
328
    def unlock(self):
626
662
        raise errors.UnsupportedOperation(self.get_reference_info, self)
627
663
 
628
664
    @needs_write_lock
629
 
    def fetch(self, from_branch, last_revision=None, pb=None):
 
665
    def fetch(self, from_branch, last_revision=None, pb=None, fetch_spec=None):
630
666
        """Copy revisions from from_branch into this branch.
631
667
 
632
668
        :param from_branch: Where to copy from.
633
669
        :param last_revision: What revision to stop at (None for at the end
634
670
                              of the branch.
635
671
        :param pb: An optional progress bar to use.
 
672
        :param fetch_spec: If specified, a SearchResult or
 
673
            PendingAncestryResult that describes which revisions to copy.  This
 
674
            allows copying multiple heads at once.  Mutually exclusive with
 
675
            last_revision.
636
676
        :return: None
637
677
        """
 
678
        if fetch_spec is not None and last_revision is not None:
 
679
            raise AssertionError(
 
680
                "fetch_spec and last_revision are mutually exclusive.")
638
681
        if self.base == from_branch.base:
639
682
            return (0, [])
640
683
        if pb is not None:
643
686
                % "pb parameter to fetch()")
644
687
        from_branch.lock_read()
645
688
        try:
646
 
            if last_revision is None:
 
689
            if last_revision is None and fetch_spec is None:
647
690
                last_revision = from_branch.last_revision()
648
691
                last_revision = _mod_revision.ensure_null(last_revision)
649
692
            return self.repository.fetch(from_branch.repository,
650
693
                                         revision_id=last_revision,
651
 
                                         pb=pb)
 
694
                                         pb=pb, fetch_spec=fetch_spec)
652
695
        finally:
653
696
            from_branch.unlock()
654
697
 
782
825
            old_repository = self.repository
783
826
            if len(old_repository._fallback_repositories) != 1:
784
827
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
 
828
                    "of %r (fallbacks: %r)" % (old_repository,
 
829
                        old_repository._fallback_repositories))
 
830
            # Open the new repository object.
 
831
            # Repositories don't offer an interface to remove fallback
 
832
            # repositories today; take the conceptually simpler option and just
 
833
            # reopen it.  We reopen it starting from the URL so that we
 
834
            # get a separate connection for RemoteRepositories and can
 
835
            # stream from one of them to the other.  This does mean doing
 
836
            # separate SSH connection setup, but unstacking is not a
 
837
            # common operation so it's tolerable.
 
838
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
839
            new_repository = new_bzrdir.find_repository()
 
840
            if new_repository._fallback_repositories:
 
841
                raise AssertionError("didn't expect %r to have "
 
842
                    "fallback_repositories"
 
843
                    % (self.repository,))
 
844
            # Replace self.repository with the new repository.
 
845
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
846
            # lock count) of self.repository to the new repository.
 
847
            lock_token = old_repository.lock_write().repository_token
 
848
            self.repository = new_repository
 
849
            if isinstance(self, remote.RemoteBranch):
 
850
                # Remote branches can have a second reference to the old
 
851
                # repository that need to be replaced.
 
852
                if self._real_branch is not None:
 
853
                    self._real_branch.repository = new_repository
 
854
            self.repository.lock_write(token=lock_token)
 
855
            if lock_token is not None:
 
856
                old_repository.leave_lock_in_place()
787
857
            old_repository.unlock()
 
858
            if lock_token is not None:
 
859
                # XXX: self.repository.leave_lock_in_place() before this
 
860
                # function will not be preserved.  Fortunately that doesn't
 
861
                # affect the current default format (2a), and would be a
 
862
                # corner-case anyway.
 
863
                #  - Andrew Bennetts, 2010/06/30
 
864
                self.repository.dont_leave_lock_in_place()
 
865
            old_lock_count = 0
 
866
            while True:
 
867
                try:
 
868
                    old_repository.unlock()
 
869
                except errors.LockNotHeld:
 
870
                    break
 
871
                old_lock_count += 1
 
872
            if old_lock_count == 0:
 
873
                raise AssertionError(
 
874
                    'old_repository should have been locked at least once.')
 
875
            for i in range(old_lock_count-1):
 
876
                self.repository.lock_write()
 
877
            # Fetch from the old repository into the new.
788
878
            old_repository.lock_read()
789
879
            try:
790
 
                # Repositories don't offer an interface to remove fallback
791
 
                # repositories today; take the conceptually simpler option and just
792
 
                # reopen it.  We reopen it starting from the URL so that we
793
 
                # get a separate connection for RemoteRepositories and can
794
 
                # stream from one of them to the other.  This does mean doing
795
 
                # separate SSH connection setup, but unstacking is not a
796
 
                # common operation so it's tolerable.
797
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
798
 
                new_repository = new_bzrdir.find_repository()
799
 
                self.repository = new_repository
800
 
                if self.repository._fallback_repositories:
801
 
                    raise AssertionError("didn't expect %r to have "
802
 
                        "fallback_repositories"
803
 
                        % (self.repository,))
804
 
                # this is not paired with an unlock because it's just restoring
805
 
                # the previous state; the lock's released when set_stacked_on_url
806
 
                # returns
807
 
                self.repository.lock_write()
808
880
                # XXX: If you unstack a branch while it has a working tree
809
881
                # with a pending merge, the pending-merged revisions will no
810
882
                # longer be present.  You can (probably) revert and remerge.
825
897
 
826
898
        :seealso: Branch._get_tags_bytes.
827
899
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
900
        return _run_with_write_locked_target(self, self._set_tags_bytes_locked,
 
901
                bytes)
 
902
 
 
903
    def _set_tags_bytes_locked(self, bytes):
 
904
        self._tags_bytes = bytes
 
905
        return self._transport.put_bytes('tags', bytes)
830
906
 
831
907
    def _cache_revision_history(self, rev_history):
832
908
        """Set the cached revision history to rev_history.
862
938
        self._merge_sorted_revisions_cache = None
863
939
        self._partial_revision_history_cache = []
864
940
        self._partial_revision_id_to_revno_cache = {}
 
941
        self._tags_bytes = None
865
942
 
866
943
    def _gen_revision_history(self):
867
944
        """Return sequence of revision hashes on to this branch.
951
1028
                raise errors.NoSuchRevision(self, stop_revision)
952
1029
        return other_history[self_len:stop_revision]
953
1030
 
954
 
    @needs_write_lock
955
1031
    def update_revisions(self, other, stop_revision=None, overwrite=False,
956
 
                         graph=None):
 
1032
                         graph=None, fetch_tags=True):
957
1033
        """Pull in new perfect-fit revisions.
958
1034
 
959
1035
        :param other: Another Branch to pull from
962
1038
            to see if it is a proper descendant.
963
1039
        :param graph: A Graph object that can be used to query history
964
1040
            information. This can be None.
 
1041
        :param fetch_tags: Flag that specifies if tags from other should be
 
1042
            fetched too.
965
1043
        :return: None
966
1044
        """
967
1045
        return InterBranch.get(other, self).update_revisions(stop_revision,
968
 
            overwrite, graph)
 
1046
            overwrite, graph, fetch_tags=fetch_tags)
969
1047
 
 
1048
    @deprecated_method(deprecated_in((2, 4, 0)))
970
1049
    def import_last_revision_info(self, source_repo, revno, revid):
971
1050
        """Set the last revision info, importing from another repo if necessary.
972
1051
 
973
 
        This is used by the bound branch code to upload a revision to
974
 
        the master branch first before updating the tip of the local branch.
975
 
 
976
1052
        :param source_repo: Source repository to optionally fetch from
977
1053
        :param revno: Revision number of the new tip
978
1054
        :param revid: Revision id of the new tip
981
1057
            self.repository.fetch(source_repo, revision_id=revid)
982
1058
        self.set_last_revision_info(revno, revid)
983
1059
 
 
1060
    def import_last_revision_info_and_tags(self, source, revno, revid):
 
1061
        """Set the last revision info, importing from another repo if necessary.
 
1062
 
 
1063
        This is used by the bound branch code to upload a revision to
 
1064
        the master branch first before updating the tip of the local branch.
 
1065
        Revisions referenced by source's tags are also transferred.
 
1066
 
 
1067
        :param source: Source branch to optionally fetch from
 
1068
        :param revno: Revision number of the new tip
 
1069
        :param revid: Revision id of the new tip
 
1070
        """
 
1071
        if not self.repository.has_same_location(source.repository):
 
1072
            try:
 
1073
                tags_to_fetch = set(source.tags.get_reverse_tag_dict())
 
1074
            except errors.TagsNotSupported:
 
1075
                tags_to_fetch = set()
 
1076
            fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
1077
                source.repository, [revid],
 
1078
                if_present_ids=tags_to_fetch).execute()
 
1079
            self.repository.fetch(source.repository, fetch_spec=fetch_spec)
 
1080
        self.set_last_revision_info(revno, revid)
 
1081
 
984
1082
    def revision_id_to_revno(self, revision_id):
985
1083
        """Given a revision id, return its revno"""
986
1084
        if _mod_revision.is_null(revision_id):
1006
1104
            self._extend_partial_history(distance_from_last)
1007
1105
        return self._partial_revision_history_cache[distance_from_last]
1008
1106
 
1009
 
    @needs_write_lock
1010
1107
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1108
             possible_transports=None, *args, **kwargs):
1012
1109
        """Mirror source into this branch.
1208
1305
        return result
1209
1306
 
1210
1307
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1308
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1309
            repository=None):
1212
1310
        """Create a new line of development from the branch, into to_bzrdir.
1213
1311
 
1214
1312
        to_bzrdir controls the branch format.
1219
1317
        if (repository_policy is not None and
1220
1318
            repository_policy.requires_stacking()):
1221
1319
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
 
        result = to_bzrdir.create_branch()
 
1320
        result = to_bzrdir.create_branch(repository=repository)
1223
1321
        result.lock_write()
1224
1322
        try:
1225
1323
            if repository_policy is not None:
1255
1353
                revno = 1
1256
1354
        destination.set_last_revision_info(revno, revision_id)
1257
1355
 
1258
 
    @needs_read_lock
1259
1356
    def copy_content_into(self, destination, revision_id=None):
1260
1357
        """Copy the content of self into destination.
1261
1358
 
1262
1359
        revision_id: if not None, the revision history in the new branch will
1263
1360
                     be truncated to end with revision_id.
1264
1361
        """
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)
 
1362
        return InterBranch.get(self, destination).copy_content_into(
 
1363
            revision_id=revision_id)
1276
1364
 
1277
1365
    def update_references(self, target):
1278
1366
        if not getattr(self._format, 'supports_reference_locations', False):
1323
1411
        """Return the most suitable metadir for a checkout of this branch.
1324
1412
        Weaves are used if this branch's repository uses weaves.
1325
1413
        """
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)
 
1414
        format = self.repository.bzrdir.checkout_metadir()
 
1415
        format.set_branch_format(self._format)
1333
1416
        return format
1334
1417
 
1335
1418
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1419
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1420
        no_tree=None):
1337
1421
        """Create a clone of this branch and its bzrdir.
1338
1422
 
1339
1423
        :param to_transport: The transport to clone onto.
1346
1430
        """
1347
1431
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1432
        # clone call. Or something. 20090224 RBC/spiv.
 
1433
        # XXX: Should this perhaps clone colocated branches as well, 
 
1434
        # rather than just the default branch? 20100319 JRV
1349
1435
        if revision_id is None:
1350
1436
            revision_id = self.last_revision()
1351
1437
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
1438
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1439
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1440
            no_tree=no_tree)
1354
1441
        return dir_to.open_branch()
1355
1442
 
1356
1443
    def create_checkout(self, to_location, revision_id=None,
1481
1568
     * an open routine.
1482
1569
 
1483
1570
    Formats are placed in an dict by their format string for reference
1484
 
    during branch opening. Its not required that these be instances, they
 
1571
    during branch opening. It's not required that these be instances, they
1485
1572
    can be classes themselves with class methods - it simply depends on
1486
1573
    whether state is needed for a given format or not.
1487
1574
 
1496
1583
    _formats = {}
1497
1584
    """The known formats."""
1498
1585
 
 
1586
    _extra_formats = []
 
1587
    """Extra formats that can not be part of a metadir."""
 
1588
 
1499
1589
    can_set_append_revisions_only = True
1500
1590
 
1501
1591
    def __eq__(self, other):
1510
1600
        try:
1511
1601
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
1602
            format_string = transport.get_bytes("format")
1513
 
            return klass._formats[format_string]
 
1603
            format = klass._formats[format_string]
 
1604
            if isinstance(format, MetaDirBranchFormatFactory):
 
1605
                return format()
 
1606
            return format
1514
1607
        except errors.NoSuchFile:
1515
1608
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1516
1609
        except KeyError:
1521
1614
        """Return the current default format."""
1522
1615
        return klass._default_format
1523
1616
 
1524
 
    def get_reference(self, a_bzrdir):
 
1617
    @classmethod
 
1618
    def get_formats(klass):
 
1619
        """Get all the known formats.
 
1620
 
 
1621
        Warning: This triggers a load of all lazy registered formats: do not
 
1622
        use except when that is desireed.
 
1623
        """
 
1624
        result = []
 
1625
        for fmt in klass._formats.values():
 
1626
            if isinstance(fmt, MetaDirBranchFormatFactory):
 
1627
                fmt = fmt()
 
1628
            result.append(fmt)
 
1629
        return result + klass._extra_formats
 
1630
 
 
1631
    def get_reference(self, a_bzrdir, name=None):
1525
1632
        """Get the target reference of the branch in a_bzrdir.
1526
1633
 
1527
1634
        format probing must have been completed before calling
1529
1636
        in a_bzrdir is correct.
1530
1637
 
1531
1638
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1639
        :param name: Name of the colocated branch to fetch
1532
1640
        :return: None if the branch is not a reference branch.
1533
1641
        """
1534
1642
        return None
1535
1643
 
1536
1644
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
 
1645
    def set_reference(self, a_bzrdir, name, to_branch):
1538
1646
        """Set the target reference of the branch in a_bzrdir.
1539
1647
 
1540
1648
        format probing must have been completed before calling
1542
1650
        in a_bzrdir is correct.
1543
1651
 
1544
1652
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1653
        :param name: Name of colocated branch to set, None for default
1545
1654
        :param to_branch: branch that the checkout is to reference
1546
1655
        """
1547
1656
        raise NotImplementedError(self.set_reference)
1563
1672
            hook(params)
1564
1673
 
1565
1674
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
 
                           lock_type='metadir', set_format=True):
 
1675
                           repository=None, lock_type='metadir',
 
1676
                           set_format=True):
1567
1677
        """Initialize a branch in a bzrdir, with specified files
1568
1678
 
1569
1679
        :param a_bzrdir: The bzrdir to initialize the branch in
1603
1713
        finally:
1604
1714
            if lock_taken:
1605
1715
                control_files.unlock()
1606
 
        branch = self.open(a_bzrdir, name, _found=True)
 
1716
        branch = self.open(a_bzrdir, name, _found=True,
 
1717
                found_repository=repository)
1607
1718
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1608
1719
        return branch
1609
1720
 
1610
 
    def initialize(self, a_bzrdir, name=None):
 
1721
    def initialize(self, a_bzrdir, name=None, repository=None):
1611
1722
        """Create a branch of this format in a_bzrdir.
1612
1723
        
1613
1724
        :param name: Name of the colocated branch to create.
1647
1758
        """
1648
1759
        raise NotImplementedError(self.network_name)
1649
1760
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1761
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
1762
            found_repository=None):
1651
1763
        """Return the branch object for a_bzrdir
1652
1764
 
1653
1765
        :param a_bzrdir: A BzrDir that contains a branch.
1660
1772
        raise NotImplementedError(self.open)
1661
1773
 
1662
1774
    @classmethod
 
1775
    def register_extra_format(klass, format):
 
1776
        """Register a branch format that can not be part of a metadir.
 
1777
 
 
1778
        This is mainly useful to allow custom branch formats, such as
 
1779
        older Bazaar formats and foreign formats, to be tested
 
1780
        """
 
1781
        klass._extra_formats.append(format)
 
1782
        network_format_registry.register(
 
1783
            format.network_name(), format.__class__)
 
1784
 
 
1785
    @classmethod
1663
1786
    def register_format(klass, format):
1664
 
        """Register a metadir format."""
 
1787
        """Register a metadir format.
 
1788
        
 
1789
        See MetaDirBranchFormatFactory for the ability to register a format
 
1790
        without loading the code the format needs until it is actually used.
 
1791
        """
1665
1792
        klass._formats[format.get_format_string()] = format
1666
1793
        # 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__)
 
1794
        # registered as factories.
 
1795
        if isinstance(format, MetaDirBranchFormatFactory):
 
1796
            network_format_registry.register(format.get_format_string(), format)
 
1797
        else:
 
1798
            network_format_registry.register(format.get_format_string(),
 
1799
                format.__class__)
1669
1800
 
1670
1801
    @classmethod
1671
1802
    def set_default_format(klass, format):
1683
1814
    def unregister_format(klass, format):
1684
1815
        del klass._formats[format.get_format_string()]
1685
1816
 
 
1817
    @classmethod
 
1818
    def unregister_extra_format(klass, format):
 
1819
        klass._extra_formats.remove(format)
 
1820
 
1686
1821
    def __str__(self):
1687
1822
        return self.get_format_description().rstrip()
1688
1823
 
1691
1826
        return False  # by default
1692
1827
 
1693
1828
 
 
1829
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1830
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1831
    
 
1832
    While none of the built in BranchFormats are lazy registered yet,
 
1833
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1834
    use it, and the bzr-loom plugin uses it as well (see
 
1835
    bzrlib.plugins.loom.formats).
 
1836
    """
 
1837
 
 
1838
    def __init__(self, format_string, module_name, member_name):
 
1839
        """Create a MetaDirBranchFormatFactory.
 
1840
 
 
1841
        :param format_string: The format string the format has.
 
1842
        :param module_name: Module to load the format class from.
 
1843
        :param member_name: Attribute name within the module for the format class.
 
1844
        """
 
1845
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1846
        self._format_string = format_string
 
1847
        
 
1848
    def get_format_string(self):
 
1849
        """See BranchFormat.get_format_string."""
 
1850
        return self._format_string
 
1851
 
 
1852
    def __call__(self):
 
1853
        """Used for network_format_registry support."""
 
1854
        return self.get_obj()()
 
1855
 
 
1856
 
1694
1857
class BranchHooks(Hooks):
1695
1858
    """A dictionary mapping hook name to a list of callables for branch hooks.
1696
1859
 
1723
1886
            "with a bzrlib.branch.PullResult object and only runs in the "
1724
1887
            "bzr client.", (0, 15), None))
1725
1888
        self.create_hook(HookPoint('pre_commit',
1726
 
            "Called after a commit is calculated but before it is is "
 
1889
            "Called after a commit is calculated but before it is "
1727
1890
            "completed. pre_commit is called with (local, master, old_revno, "
1728
1891
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
1892
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1766
1929
            "all are called with the url returned from the previous hook."
1767
1930
            "The order is however undefined.", (1, 9), None))
1768
1931
        self.create_hook(HookPoint('automatic_tag_name',
1769
 
            "Called to determine an automatic tag name for a revision."
 
1932
            "Called to determine an automatic tag name for a revision. "
1770
1933
            "automatic_tag_name is called with (branch, revision_id) and "
1771
1934
            "should return a tag name or None if no tag name could be "
1772
1935
            "determined. The first non-None tag name returned will be used.",
1863
2026
        return self.__dict__ == other.__dict__
1864
2027
 
1865
2028
    def __repr__(self):
1866
 
        if self.branch:
1867
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1868
 
        else:
1869
 
            return "<%s of format:%s bzrdir:%s>" % (
1870
 
                self.__class__.__name__, self.branch,
1871
 
                self.format, self.bzrdir)
 
2029
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1872
2030
 
1873
2031
 
1874
2032
class SwitchHookParams(object):
1904
2062
            self.revision_id)
1905
2063
 
1906
2064
 
1907
 
class BzrBranchFormat4(BranchFormat):
1908
 
    """Bzr branch format 4.
1909
 
 
1910
 
    This format has:
1911
 
     - a revision-history file.
1912
 
     - a branch-lock lock file [ to be shared with the bzrdir ]
1913
 
    """
1914
 
 
1915
 
    def get_format_description(self):
1916
 
        """See BranchFormat.get_format_description()."""
1917
 
        return "Branch format 4"
1918
 
 
1919
 
    def initialize(self, a_bzrdir, name=None):
1920
 
        """Create a branch of this format in a_bzrdir."""
1921
 
        utf8_files = [('revision-history', ''),
1922
 
                      ('branch-name', ''),
1923
 
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1925
 
                                       lock_type='branch4', set_format=False)
1926
 
 
1927
 
    def __init__(self):
1928
 
        super(BzrBranchFormat4, self).__init__()
1929
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1930
 
 
1931
 
    def network_name(self):
1932
 
        """The network name for this format is the control dirs disk label."""
1933
 
        return self._matchingbzrdir.get_format_string()
1934
 
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1936
 
        """See BranchFormat.open()."""
1937
 
        if not _found:
1938
 
            # we are being called directly and must probe.
1939
 
            raise NotImplementedError
1940
 
        return BzrBranch(_format=self,
1941
 
                         _control_files=a_bzrdir._control_files,
1942
 
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
 
                         _repository=a_bzrdir.open_repository())
1945
 
 
1946
 
    def __str__(self):
1947
 
        return "Bazaar-NG branch format 4"
1948
 
 
1949
 
 
1950
2065
class BranchFormatMetadir(BranchFormat):
1951
2066
    """Common logic for meta-dir based branch formats."""
1952
2067
 
1961
2076
        """
1962
2077
        return self.get_format_string()
1963
2078
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2079
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2080
            found_repository=None):
1965
2081
        """See BranchFormat.open()."""
1966
2082
        if not _found:
1967
2083
            format = BranchFormat.find_format(a_bzrdir, name=name)
1972
2088
        try:
1973
2089
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
2090
                                                         lockdir.LockDir)
 
2091
            if found_repository is None:
 
2092
                found_repository = a_bzrdir.find_repository()
1975
2093
            return self._branch_class()(_format=self,
1976
2094
                              _control_files=control_files,
1977
2095
                              name=name,
1978
2096
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
 
2097
                              _repository=found_repository,
1980
2098
                              ignore_fallbacks=ignore_fallbacks)
1981
2099
        except errors.NoSuchFile:
1982
2100
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2014
2132
        """See BranchFormat.get_format_description()."""
2015
2133
        return "Branch format 5"
2016
2134
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
2135
    def initialize(self, a_bzrdir, name=None, repository=None):
2018
2136
        """Create a branch of this format in a_bzrdir."""
2019
2137
        utf8_files = [('revision-history', ''),
2020
2138
                      ('branch-name', ''),
2021
2139
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2140
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2023
2141
 
2024
2142
    def supports_tags(self):
2025
2143
        return False
2047
2165
        """See BranchFormat.get_format_description()."""
2048
2166
        return "Branch format 6"
2049
2167
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
2168
    def initialize(self, a_bzrdir, name=None, repository=None):
2051
2169
        """Create a branch of this format in a_bzrdir."""
2052
2170
        utf8_files = [('last-revision', '0 null:\n'),
2053
2171
                      ('branch.conf', ''),
2054
2172
                      ('tags', ''),
2055
2173
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2174
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2057
2175
 
2058
2176
    def make_tags(self, branch):
2059
2177
        """See bzrlib.branch.BranchFormat.make_tags()."""
2077
2195
        """See BranchFormat.get_format_description()."""
2078
2196
        return "Branch format 8"
2079
2197
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
2198
    def initialize(self, a_bzrdir, name=None, repository=None):
2081
2199
        """Create a branch of this format in a_bzrdir."""
2082
2200
        utf8_files = [('last-revision', '0 null:\n'),
2083
2201
                      ('branch.conf', ''),
2084
2202
                      ('tags', ''),
2085
2203
                      ('references', '')
2086
2204
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2205
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2088
2206
 
2089
2207
    def __init__(self):
2090
2208
        super(BzrBranchFormat8, self).__init__()
2113
2231
    This format was introduced in bzr 1.6.
2114
2232
    """
2115
2233
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
2234
    def initialize(self, a_bzrdir, name=None, repository=None):
2117
2235
        """Create a branch of this format in a_bzrdir."""
2118
2236
        utf8_files = [('last-revision', '0 null:\n'),
2119
2237
                      ('branch.conf', ''),
2120
2238
                      ('tags', ''),
2121
2239
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2240
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2123
2241
 
2124
2242
    def _branch_class(self):
2125
2243
        return BzrBranch7
2157
2275
        """See BranchFormat.get_format_description()."""
2158
2276
        return "Checkout reference format 1"
2159
2277
 
2160
 
    def get_reference(self, a_bzrdir):
 
2278
    def get_reference(self, a_bzrdir, name=None):
2161
2279
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2280
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2281
        return transport.get_bytes('location')
2164
2282
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2283
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2284
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2285
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2286
        location = transport.put_bytes('location', to_branch.base)
2169
2287
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2288
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2289
            repository=None):
2171
2290
        """Create a branch of this format in a_bzrdir."""
2172
2291
        if target_branch is None:
2173
2292
            # this format does not implement branch itself, thus the implicit
2201
2320
        return clone
2202
2321
 
2203
2322
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
2323
             possible_transports=None, ignore_fallbacks=False,
 
2324
             found_repository=None):
2205
2325
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2326
 
2207
2327
        :param a_bzrdir: A BzrDir that contains a branch.
2221
2341
                raise AssertionError("wrong format %r found for %r" %
2222
2342
                    (format, self))
2223
2343
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
 
2344
            location = self.get_reference(a_bzrdir, name)
2225
2345
        real_bzrdir = bzrdir.BzrDir.open(
2226
2346
            location, possible_transports=possible_transports)
2227
2347
        result = real_bzrdir.open_branch(name=name, 
2259
2379
BranchFormat.register_format(__format7)
2260
2380
BranchFormat.register_format(__format8)
2261
2381
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__)
 
2382
 
 
2383
 
 
2384
class BranchWriteLockResult(LogicalLockResult):
 
2385
    """The result of write locking a branch.
 
2386
 
 
2387
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2388
        None.
 
2389
    :ivar unlock: A callable which will unlock the lock.
 
2390
    """
 
2391
 
 
2392
    def __init__(self, unlock, branch_token):
 
2393
        LogicalLockResult.__init__(self, unlock)
 
2394
        self.branch_token = branch_token
 
2395
 
 
2396
    def __repr__(self):
 
2397
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2398
            self.unlock)
2266
2399
 
2267
2400
 
2268
2401
class BzrBranch(Branch, _RelockDebugMixin):
2324
2457
        return self.control_files.is_locked()
2325
2458
 
2326
2459
    def lock_write(self, token=None):
 
2460
        """Lock the branch for write operations.
 
2461
 
 
2462
        :param token: A token to permit reacquiring a previously held and
 
2463
            preserved lock.
 
2464
        :return: A BranchWriteLockResult.
 
2465
        """
2327
2466
        if not self.is_locked():
2328
2467
            self._note_lock('w')
2329
2468
        # All-in-one needs to always unlock/lock.
2335
2474
        else:
2336
2475
            took_lock = False
2337
2476
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2477
            return BranchWriteLockResult(self.unlock,
 
2478
                self.control_files.lock_write(token=token))
2339
2479
        except:
2340
2480
            if took_lock:
2341
2481
                self.repository.unlock()
2342
2482
            raise
2343
2483
 
2344
2484
    def lock_read(self):
 
2485
        """Lock the branch for read operations.
 
2486
 
 
2487
        :return: A bzrlib.lock.LogicalLockResult.
 
2488
        """
2345
2489
        if not self.is_locked():
2346
2490
            self._note_lock('r')
2347
2491
        # All-in-one needs to always unlock/lock.
2354
2498
            took_lock = False
2355
2499
        try:
2356
2500
            self.control_files.lock_read()
 
2501
            return LogicalLockResult(self.unlock)
2357
2502
        except:
2358
2503
            if took_lock:
2359
2504
                self.repository.unlock()
2515
2660
        result.target_branch = target
2516
2661
        result.old_revno, result.old_revid = target.last_revision_info()
2517
2662
        self.update_references(target)
2518
 
        if result.old_revid != self.last_revision():
 
2663
        if result.old_revid != stop_revision:
2519
2664
            # We assume that during 'push' this repository is closer than
2520
2665
            # the target.
2521
2666
            graph = self.repository.get_graph(target.repository)
2544
2689
                mode=self.bzrdir._get_file_mode())
2545
2690
 
2546
2691
 
 
2692
class BzrBranchPreSplitOut(BzrBranch):
 
2693
 
 
2694
    def _get_checkout_format(self):
 
2695
        """Return the most suitable metadir for a checkout of this branch.
 
2696
        Weaves are used if this branch's repository uses weaves.
 
2697
        """
 
2698
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
 
2699
        from bzrlib.bzrdir import BzrDirMetaFormat1
 
2700
        format = BzrDirMetaFormat1()
 
2701
        format.repository_format = RepositoryFormat7()
 
2702
        return format
 
2703
 
 
2704
 
2547
2705
class BzrBranch5(BzrBranch):
2548
2706
    """A format 5 branch. This supports new features over plain branches.
2549
2707
 
2983
3141
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2984
3142
    """
2985
3143
 
 
3144
    @deprecated_method(deprecated_in((2, 3, 0)))
2986
3145
    def __int__(self):
2987
 
        # DEPRECATED: pull used to return the change in revno
 
3146
        """Return the relative change in revno.
 
3147
 
 
3148
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3149
        """
2988
3150
        return self.new_revno - self.old_revno
2989
3151
 
2990
3152
    def report(self, to_file):
3015
3177
        target, otherwise it will be None.
3016
3178
    """
3017
3179
 
 
3180
    @deprecated_method(deprecated_in((2, 3, 0)))
3018
3181
    def __int__(self):
3019
 
        # DEPRECATED: push used to return the change in revno
 
3182
        """Return the relative change in revno.
 
3183
 
 
3184
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3185
        """
3020
3186
        return self.new_revno - self.old_revno
3021
3187
 
3022
3188
    def report(self, to_file):
3145
3311
    _optimisers = []
3146
3312
    """The available optimised InterBranch types."""
3147
3313
 
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)
 
3314
    @classmethod
 
3315
    def _get_branch_formats_to_test(klass):
 
3316
        """Return an iterable of format tuples for testing.
 
3317
        
 
3318
        :return: An iterable of (from_format, to_format) to use when testing
 
3319
            this InterBranch class. Each InterBranch class should define this
 
3320
            method itself.
 
3321
        """
 
3322
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3323
 
 
3324
    @needs_write_lock
3153
3325
    def pull(self, overwrite=False, stop_revision=None,
3154
3326
             possible_transports=None, local=False):
3155
3327
        """Mirror source into target branch.
3160
3332
        """
3161
3333
        raise NotImplementedError(self.pull)
3162
3334
 
 
3335
    @needs_write_lock
3163
3336
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
 
                         graph=None):
 
3337
                         graph=None, fetch_tags=True):
3165
3338
        """Pull in new perfect-fit revisions.
3166
3339
 
3167
3340
        :param stop_revision: Updated until the given revision
3169
3342
            to see if it is a proper descendant.
3170
3343
        :param graph: A Graph object that can be used to query history
3171
3344
            information. This can be None.
 
3345
        :param fetch_tags: Flag that specifies if tags from source should be
 
3346
            fetched too.
3172
3347
        :return: None
3173
3348
        """
3174
3349
        raise NotImplementedError(self.update_revisions)
3175
3350
 
 
3351
    @needs_write_lock
3176
3352
    def push(self, overwrite=False, stop_revision=None,
3177
3353
             _override_hook_source_branch=None):
3178
3354
        """Mirror the source branch into the target branch.
3181
3357
        """
3182
3358
        raise NotImplementedError(self.push)
3183
3359
 
 
3360
    @needs_write_lock
 
3361
    def copy_content_into(self, revision_id=None):
 
3362
        """Copy the content of source into target
 
3363
 
 
3364
        revision_id: if not None, the revision history in the new branch will
 
3365
                     be truncated to end with revision_id.
 
3366
        """
 
3367
        raise NotImplementedError(self.copy_content_into)
 
3368
 
3184
3369
 
3185
3370
class GenericInterBranch(InterBranch):
3186
 
    """InterBranch implementation that uses public Branch functions.
3187
 
    """
3188
 
 
3189
 
    @staticmethod
3190
 
    def _get_branch_formats_to_test():
3191
 
        return BranchFormat._default_format, BranchFormat._default_format
3192
 
 
 
3371
    """InterBranch implementation that uses public Branch functions."""
 
3372
 
 
3373
    @classmethod
 
3374
    def is_compatible(klass, source, target):
 
3375
        # GenericBranch uses the public API, so always compatible
 
3376
        return True
 
3377
 
 
3378
    @classmethod
 
3379
    def _get_branch_formats_to_test(klass):
 
3380
        return [(BranchFormat._default_format, BranchFormat._default_format)]
 
3381
 
 
3382
    @classmethod
 
3383
    def unwrap_format(klass, format):
 
3384
        if isinstance(format, remote.RemoteBranchFormat):
 
3385
            format._ensure_real()
 
3386
            return format._custom_format
 
3387
        return format
 
3388
 
 
3389
    @needs_write_lock
 
3390
    def copy_content_into(self, revision_id=None):
 
3391
        """Copy the content of source into target
 
3392
 
 
3393
        revision_id: if not None, the revision history in the new branch will
 
3394
                     be truncated to end with revision_id.
 
3395
        """
 
3396
        self.source.update_references(self.target)
 
3397
        self.source._synchronize_history(self.target, revision_id)
 
3398
        try:
 
3399
            parent = self.source.get_parent()
 
3400
        except errors.InaccessibleParent, e:
 
3401
            mutter('parent was not accessible to copy: %s', e)
 
3402
        else:
 
3403
            if parent:
 
3404
                self.target.set_parent(parent)
 
3405
        if self.source._push_should_merge_tags():
 
3406
            self.source.tags.merge_to(self.target.tags)
 
3407
 
 
3408
    @needs_write_lock
3193
3409
    def update_revisions(self, stop_revision=None, overwrite=False,
3194
 
        graph=None):
 
3410
        graph=None, fetch_tags=True):
3195
3411
        """See InterBranch.update_revisions()."""
3196
 
        self.source.lock_read()
3197
 
        try:
3198
 
            other_revno, other_last_revision = self.source.last_revision_info()
3199
 
            stop_revno = None # unknown
3200
 
            if stop_revision is None:
3201
 
                stop_revision = other_last_revision
3202
 
                if _mod_revision.is_null(stop_revision):
3203
 
                    # if there are no commits, we're done.
3204
 
                    return
3205
 
                stop_revno = other_revno
3206
 
 
3207
 
            # what's the current last revision, before we fetch [and change it
3208
 
            # possibly]
3209
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3210
 
            # we fetch here so that we don't process data twice in the common
3211
 
            # case of having something to pull, and so that the check for
3212
 
            # already merged can operate on the just fetched graph, which will
3213
 
            # be cached in memory.
3214
 
            self.target.fetch(self.source, stop_revision)
3215
 
            # Check to see if one is an ancestor of the other
3216
 
            if not overwrite:
3217
 
                if graph is None:
3218
 
                    graph = self.target.repository.get_graph()
3219
 
                if self.target._check_if_descendant_or_diverged(
3220
 
                        stop_revision, last_rev, graph, self.source):
3221
 
                    # stop_revision is a descendant of last_rev, but we aren't
3222
 
                    # overwriting, so we're done.
3223
 
                    return
3224
 
            if stop_revno is None:
3225
 
                if graph is None:
3226
 
                    graph = self.target.repository.get_graph()
3227
 
                this_revno, this_last_revision = \
3228
 
                        self.target.last_revision_info()
3229
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3230
 
                                [(other_last_revision, other_revno),
3231
 
                                 (this_last_revision, this_revno)])
3232
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
3233
 
        finally:
3234
 
            self.source.unlock()
3235
 
 
 
3412
        other_revno, other_last_revision = self.source.last_revision_info()
 
3413
        stop_revno = None # unknown
 
3414
        if stop_revision is None:
 
3415
            stop_revision = other_last_revision
 
3416
            if _mod_revision.is_null(stop_revision):
 
3417
                # if there are no commits, we're done.
 
3418
                return
 
3419
            stop_revno = other_revno
 
3420
 
 
3421
        # what's the current last revision, before we fetch [and change it
 
3422
        # possibly]
 
3423
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3424
        # we fetch here so that we don't process data twice in the common
 
3425
        # case of having something to pull, and so that the check for
 
3426
        # already merged can operate on the just fetched graph, which will
 
3427
        # be cached in memory.
 
3428
        if fetch_tags:
 
3429
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3430
            fetch_spec_factory.source_branch = self.source
 
3431
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3432
            fetch_spec_factory.source_repo = self.source.repository
 
3433
            fetch_spec_factory.target_repo = self.target.repository
 
3434
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3435
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3436
        else:
 
3437
            fetch_spec = _mod_graph.NotInOtherForRevs(self.target.repository,
 
3438
                self.source.repository, revision_ids=[stop_revision]).execute()
 
3439
        self.target.fetch(self.source, fetch_spec=fetch_spec)
 
3440
        # Check to see if one is an ancestor of the other
 
3441
        if not overwrite:
 
3442
            if graph is None:
 
3443
                graph = self.target.repository.get_graph()
 
3444
            if self.target._check_if_descendant_or_diverged(
 
3445
                    stop_revision, last_rev, graph, self.source):
 
3446
                # stop_revision is a descendant of last_rev, but we aren't
 
3447
                # overwriting, so we're done.
 
3448
                return
 
3449
        if stop_revno is None:
 
3450
            if graph is None:
 
3451
                graph = self.target.repository.get_graph()
 
3452
            this_revno, this_last_revision = \
 
3453
                    self.target.last_revision_info()
 
3454
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3455
                            [(other_last_revision, other_revno),
 
3456
                             (this_last_revision, this_revno)])
 
3457
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3458
 
 
3459
    @needs_write_lock
3236
3460
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3461
             possible_transports=None, run_hooks=True,
3238
3462
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
 
3463
        """Pull from source into self, updating my master if any.
3240
3464
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
3465
        :param run_hooks: Private parameter - if false, this branch
3244
3466
            is being called because it's the master of the primary branch,
3245
3467
            so it should not run its hooks.
3246
 
        :param _override_hook_target: Private parameter - set the branch to be
3247
 
            supplied as the target_branch to pull hooks.
3248
 
        :param local: Only update the local branch, and not the bound branch.
3249
3468
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
 
3469
        bound_location = self.target.get_bound_location()
 
3470
        if local and not bound_location:
3252
3471
            raise errors.LocalRequiresBoundBranch()
3253
 
        result = PullResult()
3254
 
        result.source_branch = self.source
3255
 
        if _override_hook_target is None:
3256
 
            result.target_branch = self.target
3257
 
        else:
3258
 
            result.target_branch = _override_hook_target
3259
 
        self.source.lock_read()
 
3472
        master_branch = None
 
3473
        source_is_master = (self.source.user_url == bound_location)
 
3474
        if not local and bound_location and not source_is_master:
 
3475
            # not pulling from master, so we need to update master.
 
3476
            master_branch = self.target.get_master_branch(possible_transports)
 
3477
            master_branch.lock_write()
3260
3478
        try:
3261
 
            # We assume that during 'pull' the target repository is closer than
3262
 
            # the source one.
3263
 
            self.source.update_references(self.target)
3264
 
            graph = self.target.repository.get_graph(self.source.repository)
3265
 
            # TODO: Branch formats should have a flag that indicates 
3266
 
            # that revno's are expensive, and pull() should honor that flag.
3267
 
            # -- JRV20090506
3268
 
            result.old_revno, result.old_revid = \
3269
 
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
3272
 
            # TODO: The old revid should be specified when merging tags, 
3273
 
            # so a tags implementation that versions tags can only 
3274
 
            # pull in the most recent changes. -- JRV20090506
3275
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
3277
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
 
            if _hook_master:
3279
 
                result.master_branch = _hook_master
3280
 
                result.local_branch = result.target_branch
3281
 
            else:
3282
 
                result.master_branch = result.target_branch
3283
 
                result.local_branch = None
3284
 
            if run_hooks:
3285
 
                for hook in Branch.hooks['post_pull']:
3286
 
                    hook(result)
 
3479
            if master_branch:
 
3480
                # pull from source into master.
 
3481
                master_branch.pull(self.source, overwrite, stop_revision,
 
3482
                    run_hooks=False)
 
3483
            return self._pull(overwrite,
 
3484
                stop_revision, _hook_master=master_branch,
 
3485
                run_hooks=run_hooks,
 
3486
                _override_hook_target=_override_hook_target,
 
3487
                merge_tags_to_master=not source_is_master)
3287
3488
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
 
3489
            if master_branch:
 
3490
                master_branch.unlock()
3290
3491
 
3291
3492
    def push(self, overwrite=False, stop_revision=None,
3292
3493
             _override_hook_source_branch=None):
3332
3533
                # push into the master from the source branch.
3333
3534
                self.source._basic_push(master_branch, overwrite, stop_revision)
3334
3535
                # and push into the target branch from the source. Note that we
3335
 
                # push from the source branch again, because its considered the
 
3536
                # push from the source branch again, because it's considered the
3336
3537
                # highest bandwidth repository.
3337
3538
                result = self.source._basic_push(self.target, overwrite,
3338
3539
                    stop_revision)
3354
3555
            _run_hooks()
3355
3556
            return result
3356
3557
 
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
 
 
 
3558
    def _pull(self, overwrite=False, stop_revision=None,
 
3559
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3560
             _override_hook_target=None, local=False,
 
3561
             merge_tags_to_master=True):
 
3562
        """See Branch.pull.
 
3563
 
 
3564
        This function is the core worker, used by GenericInterBranch.pull to
 
3565
        avoid duplication when pulling source->master and source->local.
 
3566
 
 
3567
        :param _hook_master: Private parameter - set the branch to
 
3568
            be supplied as the master to pull hooks.
3374
3569
        :param run_hooks: Private parameter - if false, this branch
3375
3570
            is being called because it's the master of the primary branch,
3376
3571
            so it should not run its hooks.
 
3572
        :param _override_hook_target: Private parameter - set the branch to be
 
3573
            supplied as the target_branch to pull hooks.
 
3574
        :param local: Only update the local branch, and not the bound branch.
3377
3575
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
 
3576
        # This type of branch can't be bound.
 
3577
        if local:
3380
3578
            raise errors.LocalRequiresBoundBranch()
3381
 
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
3383
 
            # not pulling from master, so we need to update master.
3384
 
            master_branch = self.target.get_master_branch(possible_transports)
3385
 
            master_branch.lock_write()
 
3579
        result = PullResult()
 
3580
        result.source_branch = self.source
 
3581
        if _override_hook_target is None:
 
3582
            result.target_branch = self.target
 
3583
        else:
 
3584
            result.target_branch = _override_hook_target
 
3585
        self.source.lock_read()
3386
3586
        try:
3387
 
            if master_branch:
3388
 
                # pull from source into master.
3389
 
                master_branch.pull(self.source, overwrite, stop_revision,
3390
 
                    run_hooks=False)
3391
 
            return super(InterToBranch5, self).pull(overwrite,
3392
 
                stop_revision, _hook_master=master_branch,
3393
 
                run_hooks=run_hooks,
3394
 
                _override_hook_target=_override_hook_target)
 
3587
            # We assume that during 'pull' the target repository is closer than
 
3588
            # the source one.
 
3589
            self.source.update_references(self.target)
 
3590
            graph = self.target.repository.get_graph(self.source.repository)
 
3591
            # TODO: Branch formats should have a flag that indicates 
 
3592
            # that revno's are expensive, and pull() should honor that flag.
 
3593
            # -- JRV20090506
 
3594
            result.old_revno, result.old_revid = \
 
3595
                self.target.last_revision_info()
 
3596
            self.target.update_revisions(self.source, stop_revision,
 
3597
                overwrite=overwrite, graph=graph)
 
3598
            # TODO: The old revid should be specified when merging tags, 
 
3599
            # so a tags implementation that versions tags can only 
 
3600
            # pull in the most recent changes. -- JRV20090506
 
3601
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3602
                overwrite, ignore_master=not merge_tags_to_master)
 
3603
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3604
            if _hook_master:
 
3605
                result.master_branch = _hook_master
 
3606
                result.local_branch = result.target_branch
 
3607
            else:
 
3608
                result.master_branch = result.target_branch
 
3609
                result.local_branch = None
 
3610
            if run_hooks:
 
3611
                for hook in Branch.hooks['post_pull']:
 
3612
                    hook(result)
3395
3613
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
 
3614
            self.source.unlock()
 
3615
        return result
3398
3616
 
3399
3617
 
3400
3618
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)