/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: 2009-12-18 10:09:49 UTC
  • mfrom: (4871.5.4 admin-guide-submit)
  • Revision ID: pqm@pqm.ubuntu.com-20091218100949-2c1ityvnbqjtdf3g
(nmb) Add backup section to admin-guide

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
29
29
        errors,
30
30
        lockdir,
31
31
        lockable_files,
32
 
        remote,
33
32
        repository,
34
33
        revision as _mod_revision,
35
34
        rio,
50
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
51
50
from bzrlib.hooks import HookPoint, Hooks
52
51
from bzrlib.inter import InterObject
53
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
52
from bzrlib.lock import _RelockDebugMixin
54
53
from bzrlib import registry
55
54
from bzrlib.symbol_versioning import (
56
55
    deprecated_in,
64
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
65
64
 
66
65
 
67
 
class Branch(bzrdir.ControlComponent):
 
66
# TODO: Maybe include checks for common corruption of newlines, etc?
 
67
 
 
68
# TODO: Some operations like log might retrieve the same revisions
 
69
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
70
# cache in memory to make this faster.  In general anything can be
 
71
# cached in memory between lock and unlock operations. .. nb thats
 
72
# what the transaction identity map provides
 
73
 
 
74
 
 
75
######################################################################
 
76
# branch objects
 
77
 
 
78
class Branch(object):
68
79
    """Branch holding a history of revisions.
69
80
 
70
 
    :ivar base:
71
 
        Base directory/url of the branch; using control_url and
72
 
        control_transport is more standardized.
 
81
    base
 
82
        Base directory/url of the branch.
73
83
 
74
84
    hooks: An instance of BranchHooks.
75
85
    """
77
87
    # - RBC 20060112
78
88
    base = None
79
89
 
80
 
    @property
81
 
    def control_transport(self):
82
 
        return self._transport
83
 
 
84
 
    @property
85
 
    def user_transport(self):
86
 
        return self.bzrdir.user_transport
87
 
 
88
90
    def __init__(self, *ignored, **ignored_too):
89
91
        self.tags = self._format.make_tags(self)
90
92
        self._revision_history_cache = None
105
107
        """Activate the branch/repository from url as a fallback repository."""
106
108
        repo = self._get_fallback_repository(url)
107
109
        if repo.has_same_location(self.repository):
108
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
110
            raise errors.UnstackableLocationError(self.base, url)
109
111
        self.repository.add_fallback_repository(repo)
110
112
 
111
113
    def break_lock(self):
165
167
        """
166
168
        control = bzrdir.BzrDir.open(base, _unsupported,
167
169
                                     possible_transports=possible_transports)
168
 
        return control.open_branch(unsupported=_unsupported)
 
170
        return control.open_branch(_unsupported)
169
171
 
170
172
    @staticmethod
171
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
173
    def open_from_transport(transport, _unsupported=False):
172
174
        """Open the branch rooted at transport"""
173
175
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
174
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
176
        return control.open_branch(_unsupported)
175
177
 
176
178
    @staticmethod
177
179
    def open_containing(url, possible_transports=None):
198
200
        return self.supports_tags() and self.tags.get_tag_dict()
199
201
 
200
202
    def get_config(self):
201
 
        """Get a bzrlib.config.BranchConfig for this Branch.
202
 
 
203
 
        This can then be used to get and set configuration options for the
204
 
        branch.
205
 
 
206
 
        :return: A bzrlib.config.BranchConfig.
207
 
        """
208
203
        return BranchConfig(self)
209
204
 
210
205
    def _get_config(self):
222
217
    def _get_fallback_repository(self, url):
223
218
        """Get the repository we fallback to at url."""
224
219
        url = urlutils.join(self.base, url)
225
 
        a_branch = Branch.open(url,
 
220
        a_bzrdir = bzrdir.BzrDir.open(url,
226
221
            possible_transports=[self.bzrdir.root_transport])
227
 
        return a_branch.repository
 
222
        return a_bzrdir.open_branch().repository
228
223
 
229
224
    def _get_tags_bytes(self):
230
225
        """Get the bytes of a serialised tags dict.
246
241
        if not local and not config.has_explicit_nickname():
247
242
            try:
248
243
                master = self.get_master_branch(possible_transports)
249
 
                if master and self.user_url == master.user_url:
250
 
                    raise errors.RecursiveBind(self.user_url)
251
244
                if master is not None:
252
245
                    # return the master branch value
253
246
                    return master.nick
254
 
            except errors.RecursiveBind, e:
255
 
                raise e
256
247
            except errors.BzrError, e:
257
248
                # Silently fall back to local implicit nick if the master is
258
249
                # unavailable
295
286
        new_history.reverse()
296
287
        return new_history
297
288
 
298
 
    def lock_write(self, token=None):
299
 
        """Lock the branch for write operations.
300
 
 
301
 
        :param token: A token to permit reacquiring a previously held and
302
 
            preserved lock.
303
 
        :return: A BranchWriteLockResult.
304
 
        """
 
289
    def lock_write(self):
305
290
        raise NotImplementedError(self.lock_write)
306
291
 
307
292
    def lock_read(self):
308
 
        """Lock the branch for read operations.
309
 
 
310
 
        :return: A bzrlib.lock.LogicalLockResult.
311
 
        """
312
293
        raise NotImplementedError(self.lock_read)
313
294
 
314
295
    def unlock(self):
439
420
            * 'include' - the stop revision is the last item in the result
440
421
            * 'with-merges' - include the stop revision and all of its
441
422
              merged revisions in the result
442
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
443
 
              that are in both ancestries
444
423
        :param direction: either 'reverse' or 'forward':
445
424
            * reverse means return the start_revision_id first, i.e.
446
425
              start at the most recent revision and go backwards in history
468
447
        # start_revision_id.
469
448
        if self._merge_sorted_revisions_cache is None:
470
449
            last_revision = self.last_revision()
471
 
            known_graph = self.repository.get_known_graph_ancestry(
472
 
                [last_revision])
 
450
            last_key = (last_revision,)
 
451
            known_graph = self.repository.revisions.get_known_graph_ancestry(
 
452
                [last_key])
473
453
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
474
 
                last_revision)
 
454
                last_key)
475
455
        filtered = self._filter_merge_sorted_revisions(
476
456
            self._merge_sorted_revisions_cache, start_revision_id,
477
457
            stop_revision_id, stop_rule)
478
 
        # Make sure we don't return revisions that are not part of the
479
 
        # start_revision_id ancestry.
480
 
        filtered = self._filter_start_non_ancestors(filtered)
481
458
        if direction == 'reverse':
482
459
            return filtered
483
460
        if direction == 'forward':
520
497
                       node.end_of_merge)
521
498
                if rev_id == stop_revision_id:
522
499
                    return
523
 
        elif stop_rule == 'with-merges-without-common-ancestry':
524
 
            # We want to exclude all revisions that are already part of the
525
 
            # stop_revision_id ancestry.
526
 
            graph = self.repository.get_graph()
527
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
528
 
                                                    [stop_revision_id])
529
 
            for node in rev_iter:
530
 
                rev_id = node.key[-1]
531
 
                if rev_id not in ancestors:
532
 
                    continue
533
 
                yield (rev_id, node.merge_depth, node.revno,
534
 
                       node.end_of_merge)
535
500
        elif stop_rule == 'with-merges':
536
501
            stop_rev = self.repository.get_revision(stop_revision_id)
537
502
            if stop_rev.parent_ids:
560
525
        else:
561
526
            raise ValueError('invalid stop_rule %r' % stop_rule)
562
527
 
563
 
    def _filter_start_non_ancestors(self, rev_iter):
564
 
        # If we started from a dotted revno, we want to consider it as a tip
565
 
        # and don't want to yield revisions that are not part of its
566
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
567
 
        # uninteresting descendants of the first parent of our tip before the
568
 
        # tip itself.
569
 
        first = rev_iter.next()
570
 
        (rev_id, merge_depth, revno, end_of_merge) = first
571
 
        yield first
572
 
        if not merge_depth:
573
 
            # We start at a mainline revision so by definition, all others
574
 
            # revisions in rev_iter are ancestors
575
 
            for node in rev_iter:
576
 
                yield node
577
 
 
578
 
        clean = False
579
 
        whitelist = set()
580
 
        pmap = self.repository.get_parent_map([rev_id])
581
 
        parents = pmap.get(rev_id, [])
582
 
        if parents:
583
 
            whitelist.update(parents)
584
 
        else:
585
 
            # If there is no parents, there is nothing of interest left
586
 
 
587
 
            # FIXME: It's hard to test this scenario here as this code is never
588
 
            # called in that case. -- vila 20100322
589
 
            return
590
 
 
591
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
592
 
            if not clean:
593
 
                if rev_id in whitelist:
594
 
                    pmap = self.repository.get_parent_map([rev_id])
595
 
                    parents = pmap.get(rev_id, [])
596
 
                    whitelist.remove(rev_id)
597
 
                    whitelist.update(parents)
598
 
                    if merge_depth == 0:
599
 
                        # We've reached the mainline, there is nothing left to
600
 
                        # filter
601
 
                        clean = True
602
 
                else:
603
 
                    # A revision that is not part of the ancestry of our
604
 
                    # starting revision.
605
 
                    continue
606
 
            yield (rev_id, merge_depth, revno, end_of_merge)
607
 
 
608
528
    def leave_lock_in_place(self):
609
529
        """Tell this branch object not to release the physical lock when this
610
530
        object is unlocked.
627
547
        :param other: The branch to bind to
628
548
        :type other: Branch
629
549
        """
630
 
        raise errors.UpgradeRequired(self.user_url)
 
550
        raise errors.UpgradeRequired(self.base)
631
551
 
632
552
    def set_append_revisions_only(self, enabled):
633
553
        if not self._format.supports_set_append_revisions_only():
634
 
            raise errors.UpgradeRequired(self.user_url)
 
554
            raise errors.UpgradeRequired(self.base)
635
555
        if enabled:
636
556
            value = 'True'
637
557
        else:
685
605
    def get_old_bound_location(self):
686
606
        """Return the URL of the branch we used to be bound to
687
607
        """
688
 
        raise errors.UpgradeRequired(self.user_url)
 
608
        raise errors.UpgradeRequired(self.base)
689
609
 
690
610
    def get_commit_builder(self, parents, config=None, timestamp=None,
691
611
                           timezone=None, committer=None, revprops=None,
769
689
            stacking.
770
690
        """
771
691
        if not self._format.supports_stacking():
772
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
692
            raise errors.UnstackableBranchFormat(self._format, self.base)
773
693
        # XXX: Changing from one fallback repository to another does not check
774
694
        # that all the data you need is present in the new fallback.
775
695
        # Possibly it should.
805
725
            if len(old_repository._fallback_repositories) != 1:
806
726
                raise AssertionError("can't cope with fallback repositories "
807
727
                    "of %r" % (self.repository,))
808
 
            # Open the new repository object.
809
 
            # Repositories don't offer an interface to remove fallback
810
 
            # repositories today; take the conceptually simpler option and just
811
 
            # reopen it.  We reopen it starting from the URL so that we
812
 
            # get a separate connection for RemoteRepositories and can
813
 
            # stream from one of them to the other.  This does mean doing
814
 
            # separate SSH connection setup, but unstacking is not a
815
 
            # common operation so it's tolerable.
816
 
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
817
 
            new_repository = new_bzrdir.find_repository()
818
 
            if new_repository._fallback_repositories:
819
 
                raise AssertionError("didn't expect %r to have "
820
 
                    "fallback_repositories"
821
 
                    % (self.repository,))
822
 
            # Replace self.repository with the new repository.
823
 
            # Do our best to transfer the lock state (i.e. lock-tokens and
824
 
            # lock count) of self.repository to the new repository.
825
 
            lock_token = old_repository.lock_write().repository_token
826
 
            self.repository = new_repository
827
 
            if isinstance(self, remote.RemoteBranch):
828
 
                # Remote branches can have a second reference to the old
829
 
                # repository that need to be replaced.
830
 
                if self._real_branch is not None:
831
 
                    self._real_branch.repository = new_repository
832
 
            self.repository.lock_write(token=lock_token)
833
 
            if lock_token is not None:
834
 
                old_repository.leave_lock_in_place()
 
728
            # unlock it, including unlocking the fallback
835
729
            old_repository.unlock()
836
 
            if lock_token is not None:
837
 
                # XXX: self.repository.leave_lock_in_place() before this
838
 
                # function will not be preserved.  Fortunately that doesn't
839
 
                # affect the current default format (2a), and would be a
840
 
                # corner-case anyway.
841
 
                #  - Andrew Bennetts, 2010/06/30
842
 
                self.repository.dont_leave_lock_in_place()
843
 
            old_lock_count = 0
844
 
            while True:
845
 
                try:
846
 
                    old_repository.unlock()
847
 
                except errors.LockNotHeld:
848
 
                    break
849
 
                old_lock_count += 1
850
 
            if old_lock_count == 0:
851
 
                raise AssertionError(
852
 
                    'old_repository should have been locked at least once.')
853
 
            for i in range(old_lock_count-1):
 
730
            old_repository.lock_read()
 
731
            try:
 
732
                # Repositories don't offer an interface to remove fallback
 
733
                # repositories today; take the conceptually simpler option and just
 
734
                # reopen it.  We reopen it starting from the URL so that we
 
735
                # get a separate connection for RemoteRepositories and can
 
736
                # stream from one of them to the other.  This does mean doing
 
737
                # separate SSH connection setup, but unstacking is not a
 
738
                # common operation so it's tolerable.
 
739
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
740
                new_repository = new_bzrdir.find_repository()
 
741
                self.repository = new_repository
 
742
                if self.repository._fallback_repositories:
 
743
                    raise AssertionError("didn't expect %r to have "
 
744
                        "fallback_repositories"
 
745
                        % (self.repository,))
 
746
                # this is not paired with an unlock because it's just restoring
 
747
                # the previous state; the lock's released when set_stacked_on_url
 
748
                # returns
854
749
                self.repository.lock_write()
855
 
            # Fetch from the old repository into the new.
856
 
            old_repository.lock_read()
857
 
            try:
858
750
                # XXX: If you unstack a branch while it has a working tree
859
751
                # with a pending merge, the pending-merged revisions will no
860
752
                # longer be present.  You can (probably) revert and remerge.
954
846
 
955
847
    def unbind(self):
956
848
        """Older format branches cannot bind or unbind."""
957
 
        raise errors.UpgradeRequired(self.user_url)
 
849
        raise errors.UpgradeRequired(self.base)
958
850
 
959
851
    def last_revision(self):
960
852
        """Return last revision id, or NULL_REVISION."""
1001
893
                raise errors.NoSuchRevision(self, stop_revision)
1002
894
        return other_history[self_len:stop_revision]
1003
895
 
 
896
    @needs_write_lock
1004
897
    def update_revisions(self, other, stop_revision=None, overwrite=False,
1005
898
                         graph=None):
1006
899
        """Pull in new perfect-fit revisions.
1055
948
            self._extend_partial_history(distance_from_last)
1056
949
        return self._partial_revision_history_cache[distance_from_last]
1057
950
 
 
951
    @needs_write_lock
1058
952
    def pull(self, source, overwrite=False, stop_revision=None,
1059
953
             possible_transports=None, *args, **kwargs):
1060
954
        """Mirror source into this branch.
1118
1012
        try:
1119
1013
            return urlutils.join(self.base[:-1], parent)
1120
1014
        except errors.InvalidURLJoin, e:
1121
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
1015
            raise errors.InaccessibleParent(parent, self.base)
1122
1016
 
1123
1017
    def _get_parent_location(self):
1124
1018
        raise NotImplementedError(self._get_parent_location)
1209
1103
        params = ChangeBranchTipParams(
1210
1104
            self, old_revno, new_revno, old_revid, new_revid)
1211
1105
        for hook in hooks:
1212
 
            hook(params)
 
1106
            try:
 
1107
                hook(params)
 
1108
            except errors.TipChangeRejected:
 
1109
                raise
 
1110
            except Exception:
 
1111
                exc_info = sys.exc_info()
 
1112
                hook_name = Branch.hooks.get_hook_name(hook)
 
1113
                raise errors.HookFailed(
 
1114
                    'pre_change_branch_tip', hook_name, exc_info)
1213
1115
 
1214
1116
    @needs_write_lock
1215
1117
    def update(self):
1303
1205
                revno = 1
1304
1206
        destination.set_last_revision_info(revno, revision_id)
1305
1207
 
 
1208
    @needs_read_lock
1306
1209
    def copy_content_into(self, destination, revision_id=None):
1307
1210
        """Copy the content of self into destination.
1308
1211
 
1309
1212
        revision_id: if not None, the revision history in the new branch will
1310
1213
                     be truncated to end with revision_id.
1311
1214
        """
1312
 
        return InterBranch.get(self, destination).copy_content_into(
1313
 
            revision_id=revision_id)
 
1215
        self.update_references(destination)
 
1216
        self._synchronize_history(destination, revision_id)
 
1217
        try:
 
1218
            parent = self.get_parent()
 
1219
        except errors.InaccessibleParent, e:
 
1220
            mutter('parent was not accessible to copy: %s', e)
 
1221
        else:
 
1222
            if parent:
 
1223
                destination.set_parent(parent)
 
1224
        if self._push_should_merge_tags():
 
1225
            self.tags.merge_to(destination.tags)
1314
1226
 
1315
1227
    def update_references(self, target):
1316
1228
        if not getattr(self._format, 'supports_reference_locations', False):
1384
1296
        """
1385
1297
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1386
1298
        # clone call. Or something. 20090224 RBC/spiv.
1387
 
        # XXX: Should this perhaps clone colocated branches as well, 
1388
 
        # rather than just the default branch? 20100319 JRV
1389
1299
        if revision_id is None:
1390
1300
            revision_id = self.last_revision()
1391
1301
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1415
1325
        if lightweight:
1416
1326
            format = self._get_checkout_format()
1417
1327
            checkout = format.initialize_on_transport(t)
1418
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1419
 
                target_branch=self)
 
1328
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1420
1329
        else:
1421
1330
            format = self._get_checkout_format()
1422
1331
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1464
1373
    def supports_tags(self):
1465
1374
        return self._format.supports_tags()
1466
1375
 
1467
 
    def automatic_tag_name(self, revision_id):
1468
 
        """Try to automatically find the tag name for a revision.
1469
 
 
1470
 
        :param revision_id: Revision id of the revision.
1471
 
        :return: A tag name or None if no tag name could be determined.
1472
 
        """
1473
 
        for hook in Branch.hooks['automatic_tag_name']:
1474
 
            ret = hook(self, revision_id)
1475
 
            if ret is not None:
1476
 
                return ret
1477
 
        return None
1478
 
 
1479
1376
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1480
1377
                                         other_branch):
1481
1378
        """Ensure that revision_b is a descendant of revision_a.
1545
1442
        return not (self == other)
1546
1443
 
1547
1444
    @classmethod
1548
 
    def find_format(klass, a_bzrdir, name=None):
 
1445
    def find_format(klass, a_bzrdir):
1549
1446
        """Return the format for the branch object in a_bzrdir."""
1550
1447
        try:
1551
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
 
1448
            transport = a_bzrdir.get_branch_transport(None)
1552
1449
            format_string = transport.get_bytes("format")
1553
 
            format = klass._formats[format_string]
1554
 
            if isinstance(format, MetaDirBranchFormatFactory):
1555
 
                return format()
1556
 
            return format
 
1450
            return klass._formats[format_string]
1557
1451
        except errors.NoSuchFile:
1558
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1452
            raise errors.NotBranchError(path=transport.base)
1559
1453
        except KeyError:
1560
1454
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1561
1455
 
1564
1458
        """Return the current default format."""
1565
1459
        return klass._default_format
1566
1460
 
1567
 
    @classmethod
1568
 
    def get_formats(klass):
1569
 
        """Get all the known formats.
1570
 
 
1571
 
        Warning: This triggers a load of all lazy registered formats: do not
1572
 
        use except when that is desireed.
1573
 
        """
1574
 
        result = []
1575
 
        for fmt in klass._formats.values():
1576
 
            if isinstance(fmt, MetaDirBranchFormatFactory):
1577
 
                fmt = fmt()
1578
 
            result.append(fmt)
1579
 
        return result
1580
 
 
1581
 
    def get_reference(self, a_bzrdir, name=None):
 
1461
    def get_reference(self, a_bzrdir):
1582
1462
        """Get the target reference of the branch in a_bzrdir.
1583
1463
 
1584
1464
        format probing must have been completed before calling
1586
1466
        in a_bzrdir is correct.
1587
1467
 
1588
1468
        :param a_bzrdir: The bzrdir to get the branch data from.
1589
 
        :param name: Name of the colocated branch to fetch
1590
1469
        :return: None if the branch is not a reference branch.
1591
1470
        """
1592
1471
        return None
1593
1472
 
1594
1473
    @classmethod
1595
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1474
    def set_reference(self, a_bzrdir, to_branch):
1596
1475
        """Set the target reference of the branch in a_bzrdir.
1597
1476
 
1598
1477
        format probing must have been completed before calling
1600
1479
        in a_bzrdir is correct.
1601
1480
 
1602
1481
        :param a_bzrdir: The bzrdir to set the branch reference for.
1603
 
        :param name: Name of colocated branch to set, None for default
1604
1482
        :param to_branch: branch that the checkout is to reference
1605
1483
        """
1606
1484
        raise NotImplementedError(self.set_reference)
1613
1491
        """Return the short format description for this format."""
1614
1492
        raise NotImplementedError(self.get_format_description)
1615
1493
 
1616
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1617
 
        hooks = Branch.hooks['post_branch_init']
1618
 
        if not hooks:
1619
 
            return
1620
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1621
 
        for hook in hooks:
1622
 
            hook(params)
1623
 
 
1624
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1625
 
                           lock_type='metadir', set_format=True):
 
1494
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1495
                           set_format=True):
1626
1496
        """Initialize a branch in a bzrdir, with specified files
1627
1497
 
1628
1498
        :param a_bzrdir: The bzrdir to initialize the branch in
1629
1499
        :param utf8_files: The files to create as a list of
1630
1500
            (filename, content) tuples
1631
 
        :param name: Name of colocated branch to create, if any
1632
1501
        :param set_format: If True, set the format with
1633
1502
            self.get_format_string.  (BzrBranch4 has its format set
1634
1503
            elsewhere)
1635
1504
        :return: a branch in this format
1636
1505
        """
1637
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1638
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1506
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1507
        branch_transport = a_bzrdir.get_branch_transport(self)
1639
1508
        lock_map = {
1640
1509
            'metadir': ('lock', lockdir.LockDir),
1641
1510
            'branch4': ('branch-lock', lockable_files.TransportLock),
1662
1531
        finally:
1663
1532
            if lock_taken:
1664
1533
                control_files.unlock()
1665
 
        branch = self.open(a_bzrdir, name, _found=True)
1666
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1667
 
        return branch
 
1534
        return self.open(a_bzrdir, _found=True)
1668
1535
 
1669
 
    def initialize(self, a_bzrdir, name=None):
1670
 
        """Create a branch of this format in a_bzrdir.
1671
 
        
1672
 
        :param name: Name of the colocated branch to create.
1673
 
        """
 
1536
    def initialize(self, a_bzrdir):
 
1537
        """Create a branch of this format in a_bzrdir."""
1674
1538
        raise NotImplementedError(self.initialize)
1675
1539
 
1676
1540
    def is_supported(self):
1706
1570
        """
1707
1571
        raise NotImplementedError(self.network_name)
1708
1572
 
1709
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1573
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1710
1574
        """Return the branch object for a_bzrdir
1711
1575
 
1712
1576
        :param a_bzrdir: A BzrDir that contains a branch.
1713
 
        :param name: Name of colocated branch to open
1714
1577
        :param _found: a private parameter, do not use it. It is used to
1715
1578
            indicate if format probing has already be done.
1716
1579
        :param ignore_fallbacks: when set, no fallback branches will be opened
1720
1583
 
1721
1584
    @classmethod
1722
1585
    def register_format(klass, format):
1723
 
        """Register a metadir format.
1724
 
        
1725
 
        See MetaDirBranchFormatFactory for the ability to register a format
1726
 
        without loading the code the format needs until it is actually used.
1727
 
        """
 
1586
        """Register a metadir format."""
1728
1587
        klass._formats[format.get_format_string()] = format
1729
1588
        # Metadir formats have a network name of their format string, and get
1730
 
        # registered as factories.
1731
 
        if isinstance(format, MetaDirBranchFormatFactory):
1732
 
            network_format_registry.register(format.get_format_string(), format)
1733
 
        else:
1734
 
            network_format_registry.register(format.get_format_string(),
1735
 
                format.__class__)
 
1589
        # registered as class factories.
 
1590
        network_format_registry.register(format.get_format_string(), format.__class__)
1736
1591
 
1737
1592
    @classmethod
1738
1593
    def set_default_format(klass, format):
1758
1613
        return False  # by default
1759
1614
 
1760
1615
 
1761
 
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1762
 
    """A factory for a BranchFormat object, permitting simple lazy registration.
1763
 
    
1764
 
    While none of the built in BranchFormats are lazy registered yet,
1765
 
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1766
 
    use it, and the bzr-loom plugin uses it as well (see
1767
 
    bzrlib.plugins.loom.formats).
1768
 
    """
1769
 
 
1770
 
    def __init__(self, format_string, module_name, member_name):
1771
 
        """Create a MetaDirBranchFormatFactory.
1772
 
 
1773
 
        :param format_string: The format string the format has.
1774
 
        :param module_name: Module to load the format class from.
1775
 
        :param member_name: Attribute name within the module for the format class.
1776
 
        """
1777
 
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
1778
 
        self._format_string = format_string
1779
 
        
1780
 
    def get_format_string(self):
1781
 
        """See BranchFormat.get_format_string."""
1782
 
        return self._format_string
1783
 
 
1784
 
    def __call__(self):
1785
 
        """Used for network_format_registry support."""
1786
 
        return self.get_obj()()
1787
 
 
1788
 
 
1789
1616
class BranchHooks(Hooks):
1790
1617
    """A dictionary mapping hook name to a list of callables for branch hooks.
1791
1618
 
1860
1687
            "multiple hooks installed for transform_fallback_location, "
1861
1688
            "all are called with the url returned from the previous hook."
1862
1689
            "The order is however undefined.", (1, 9), None))
1863
 
        self.create_hook(HookPoint('automatic_tag_name',
1864
 
            "Called to determine an automatic tag name for a revision. "
1865
 
            "automatic_tag_name is called with (branch, revision_id) and "
1866
 
            "should return a tag name or None if no tag name could be "
1867
 
            "determined. The first non-None tag name returned will be used.",
1868
 
            (2, 2), None))
1869
 
        self.create_hook(HookPoint('post_branch_init',
1870
 
            "Called after new branch initialization completes. "
1871
 
            "post_branch_init is called with a "
1872
 
            "bzrlib.branch.BranchInitHookParams. "
1873
 
            "Note that init, branch and checkout (both heavyweight and "
1874
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1875
 
        self.create_hook(HookPoint('post_switch',
1876
 
            "Called after a checkout switches branch. "
1877
 
            "post_switch is called with a "
1878
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1879
 
 
1880
1690
 
1881
1691
 
1882
1692
# install the default hooks into the Branch class.
1921
1731
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1922
1732
 
1923
1733
 
1924
 
class BranchInitHookParams(object):
1925
 
    """Object holding parameters passed to *_branch_init hooks.
1926
 
 
1927
 
    There are 4 fields that hooks may wish to access:
1928
 
 
1929
 
    :ivar format: the branch format
1930
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1931
 
    :ivar name: name of colocated branch, if any (or None)
1932
 
    :ivar branch: the branch created
1933
 
 
1934
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1935
 
    the checkout, hence they are different from the corresponding fields in
1936
 
    branch, which refer to the original branch.
1937
 
    """
1938
 
 
1939
 
    def __init__(self, format, a_bzrdir, name, branch):
1940
 
        """Create a group of BranchInitHook parameters.
1941
 
 
1942
 
        :param format: the branch format
1943
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1944
 
            initialized
1945
 
        :param name: name of colocated branch, if any (or None)
1946
 
        :param branch: the branch created
1947
 
 
1948
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1949
 
        to the checkout, hence they are different from the corresponding fields
1950
 
        in branch, which refer to the original branch.
1951
 
        """
1952
 
        self.format = format
1953
 
        self.bzrdir = a_bzrdir
1954
 
        self.name = name
1955
 
        self.branch = branch
1956
 
 
1957
 
    def __eq__(self, other):
1958
 
        return self.__dict__ == other.__dict__
1959
 
 
1960
 
    def __repr__(self):
1961
 
        if self.branch:
1962
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1963
 
        else:
1964
 
            return "<%s of format:%s bzrdir:%s>" % (
1965
 
                self.__class__.__name__, self.branch,
1966
 
                self.format, self.bzrdir)
1967
 
 
1968
 
 
1969
 
class SwitchHookParams(object):
1970
 
    """Object holding parameters passed to *_switch hooks.
1971
 
 
1972
 
    There are 4 fields that hooks may wish to access:
1973
 
 
1974
 
    :ivar control_dir: BzrDir of the checkout to change
1975
 
    :ivar to_branch: branch that the checkout is to reference
1976
 
    :ivar force: skip the check for local commits in a heavy checkout
1977
 
    :ivar revision_id: revision ID to switch to (or None)
1978
 
    """
1979
 
 
1980
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1981
 
        """Create a group of SwitchHook parameters.
1982
 
 
1983
 
        :param control_dir: BzrDir of the checkout to change
1984
 
        :param to_branch: branch that the checkout is to reference
1985
 
        :param force: skip the check for local commits in a heavy checkout
1986
 
        :param revision_id: revision ID to switch to (or None)
1987
 
        """
1988
 
        self.control_dir = control_dir
1989
 
        self.to_branch = to_branch
1990
 
        self.force = force
1991
 
        self.revision_id = revision_id
1992
 
 
1993
 
    def __eq__(self, other):
1994
 
        return self.__dict__ == other.__dict__
1995
 
 
1996
 
    def __repr__(self):
1997
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1998
 
            self.control_dir, self.to_branch,
1999
 
            self.revision_id)
2000
 
 
2001
 
 
2002
1734
class BzrBranchFormat4(BranchFormat):
2003
1735
    """Bzr branch format 4.
2004
1736
 
2011
1743
        """See BranchFormat.get_format_description()."""
2012
1744
        return "Branch format 4"
2013
1745
 
2014
 
    def initialize(self, a_bzrdir, name=None):
 
1746
    def initialize(self, a_bzrdir):
2015
1747
        """Create a branch of this format in a_bzrdir."""
2016
1748
        utf8_files = [('revision-history', ''),
2017
1749
                      ('branch-name', ''),
2018
1750
                      ]
2019
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1751
        return self._initialize_helper(a_bzrdir, utf8_files,
2020
1752
                                       lock_type='branch4', set_format=False)
2021
1753
 
2022
1754
    def __init__(self):
2027
1759
        """The network name for this format is the control dirs disk label."""
2028
1760
        return self._matchingbzrdir.get_format_string()
2029
1761
 
2030
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1762
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2031
1763
        """See BranchFormat.open()."""
2032
1764
        if not _found:
2033
1765
            # we are being called directly and must probe.
2035
1767
        return BzrBranch(_format=self,
2036
1768
                         _control_files=a_bzrdir._control_files,
2037
1769
                         a_bzrdir=a_bzrdir,
2038
 
                         name=name,
2039
1770
                         _repository=a_bzrdir.open_repository())
2040
1771
 
2041
1772
    def __str__(self):
2056
1787
        """
2057
1788
        return self.get_format_string()
2058
1789
 
2059
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1790
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2060
1791
        """See BranchFormat.open()."""
2061
1792
        if not _found:
2062
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1793
            format = BranchFormat.find_format(a_bzrdir)
2063
1794
            if format.__class__ != self.__class__:
2064
1795
                raise AssertionError("wrong format %r found for %r" %
2065
1796
                    (format, self))
2066
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2067
1797
        try:
 
1798
            transport = a_bzrdir.get_branch_transport(None)
2068
1799
            control_files = lockable_files.LockableFiles(transport, 'lock',
2069
1800
                                                         lockdir.LockDir)
2070
1801
            return self._branch_class()(_format=self,
2071
1802
                              _control_files=control_files,
2072
 
                              name=name,
2073
1803
                              a_bzrdir=a_bzrdir,
2074
1804
                              _repository=a_bzrdir.find_repository(),
2075
1805
                              ignore_fallbacks=ignore_fallbacks)
2076
1806
        except errors.NoSuchFile:
2077
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1807
            raise errors.NotBranchError(path=transport.base)
2078
1808
 
2079
1809
    def __init__(self):
2080
1810
        super(BranchFormatMetadir, self).__init__()
2109
1839
        """See BranchFormat.get_format_description()."""
2110
1840
        return "Branch format 5"
2111
1841
 
2112
 
    def initialize(self, a_bzrdir, name=None):
 
1842
    def initialize(self, a_bzrdir):
2113
1843
        """Create a branch of this format in a_bzrdir."""
2114
1844
        utf8_files = [('revision-history', ''),
2115
1845
                      ('branch-name', ''),
2116
1846
                      ]
2117
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1847
        return self._initialize_helper(a_bzrdir, utf8_files)
2118
1848
 
2119
1849
    def supports_tags(self):
2120
1850
        return False
2142
1872
        """See BranchFormat.get_format_description()."""
2143
1873
        return "Branch format 6"
2144
1874
 
2145
 
    def initialize(self, a_bzrdir, name=None):
 
1875
    def initialize(self, a_bzrdir):
2146
1876
        """Create a branch of this format in a_bzrdir."""
2147
1877
        utf8_files = [('last-revision', '0 null:\n'),
2148
1878
                      ('branch.conf', ''),
2149
1879
                      ('tags', ''),
2150
1880
                      ]
2151
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1881
        return self._initialize_helper(a_bzrdir, utf8_files)
2152
1882
 
2153
1883
    def make_tags(self, branch):
2154
1884
        """See bzrlib.branch.BranchFormat.make_tags()."""
2172
1902
        """See BranchFormat.get_format_description()."""
2173
1903
        return "Branch format 8"
2174
1904
 
2175
 
    def initialize(self, a_bzrdir, name=None):
 
1905
    def initialize(self, a_bzrdir):
2176
1906
        """Create a branch of this format in a_bzrdir."""
2177
1907
        utf8_files = [('last-revision', '0 null:\n'),
2178
1908
                      ('branch.conf', ''),
2179
1909
                      ('tags', ''),
2180
1910
                      ('references', '')
2181
1911
                      ]
2182
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1912
        return self._initialize_helper(a_bzrdir, utf8_files)
2183
1913
 
2184
1914
    def __init__(self):
2185
1915
        super(BzrBranchFormat8, self).__init__()
2208
1938
    This format was introduced in bzr 1.6.
2209
1939
    """
2210
1940
 
2211
 
    def initialize(self, a_bzrdir, name=None):
 
1941
    def initialize(self, a_bzrdir):
2212
1942
        """Create a branch of this format in a_bzrdir."""
2213
1943
        utf8_files = [('last-revision', '0 null:\n'),
2214
1944
                      ('branch.conf', ''),
2215
1945
                      ('tags', ''),
2216
1946
                      ]
2217
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1947
        return self._initialize_helper(a_bzrdir, utf8_files)
2218
1948
 
2219
1949
    def _branch_class(self):
2220
1950
        return BzrBranch7
2252
1982
        """See BranchFormat.get_format_description()."""
2253
1983
        return "Checkout reference format 1"
2254
1984
 
2255
 
    def get_reference(self, a_bzrdir, name=None):
 
1985
    def get_reference(self, a_bzrdir):
2256
1986
        """See BranchFormat.get_reference()."""
2257
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1987
        transport = a_bzrdir.get_branch_transport(None)
2258
1988
        return transport.get_bytes('location')
2259
1989
 
2260
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1990
    def set_reference(self, a_bzrdir, to_branch):
2261
1991
        """See BranchFormat.set_reference()."""
2262
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1992
        transport = a_bzrdir.get_branch_transport(None)
2263
1993
        location = transport.put_bytes('location', to_branch.base)
2264
1994
 
2265
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1995
    def initialize(self, a_bzrdir, target_branch=None):
2266
1996
        """Create a branch of this format in a_bzrdir."""
2267
1997
        if target_branch is None:
2268
1998
            # this format does not implement branch itself, thus the implicit
2269
1999
            # creation contract must see it as uninitializable
2270
2000
            raise errors.UninitializableFormat(self)
2271
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2272
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
2001
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
2002
        branch_transport = a_bzrdir.get_branch_transport(self)
2273
2003
        branch_transport.put_bytes('location',
2274
 
            target_branch.bzrdir.user_url)
 
2004
            target_branch.bzrdir.root_transport.base)
2275
2005
        branch_transport.put_bytes('format', self.get_format_string())
2276
 
        branch = self.open(
2277
 
            a_bzrdir, name, _found=True,
 
2006
        return self.open(
 
2007
            a_bzrdir, _found=True,
2278
2008
            possible_transports=[target_branch.bzrdir.root_transport])
2279
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2280
 
        return branch
2281
2009
 
2282
2010
    def __init__(self):
2283
2011
        super(BranchReferenceFormat, self).__init__()
2289
2017
        def clone(to_bzrdir, revision_id=None,
2290
2018
            repository_policy=None):
2291
2019
            """See Branch.clone()."""
2292
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
2020
            return format.initialize(to_bzrdir, a_branch)
2293
2021
            # cannot obey revision_id limits when cloning a reference ...
2294
2022
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2295
2023
            # emit some sort of warning/error to the caller ?!
2296
2024
        return clone
2297
2025
 
2298
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
2026
    def open(self, a_bzrdir, _found=False, location=None,
2299
2027
             possible_transports=None, ignore_fallbacks=False):
2300
2028
        """Return the branch that the branch reference in a_bzrdir points at.
2301
2029
 
2302
2030
        :param a_bzrdir: A BzrDir that contains a branch.
2303
 
        :param name: Name of colocated branch to open, if any
2304
2031
        :param _found: a private parameter, do not use it. It is used to
2305
2032
            indicate if format probing has already be done.
2306
2033
        :param ignore_fallbacks: when set, no fallback branches will be opened
2311
2038
        :param possible_transports: An optional reusable transports list.
2312
2039
        """
2313
2040
        if not _found:
2314
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2041
            format = BranchFormat.find_format(a_bzrdir)
2315
2042
            if format.__class__ != self.__class__:
2316
2043
                raise AssertionError("wrong format %r found for %r" %
2317
2044
                    (format, self))
2318
2045
        if location is None:
2319
 
            location = self.get_reference(a_bzrdir, name)
 
2046
            location = self.get_reference(a_bzrdir)
2320
2047
        real_bzrdir = bzrdir.BzrDir.open(
2321
2048
            location, possible_transports=possible_transports)
2322
 
        result = real_bzrdir.open_branch(name=name, 
2323
 
            ignore_fallbacks=ignore_fallbacks)
 
2049
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2324
2050
        # this changes the behaviour of result.clone to create a new reference
2325
2051
        # rather than a copy of the content of the branch.
2326
2052
        # I did not use a proxy object because that needs much more extensive
2360
2086
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2361
2087
 
2362
2088
 
2363
 
class BranchWriteLockResult(LogicalLockResult):
2364
 
    """The result of write locking a branch.
2365
 
 
2366
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2367
 
        None.
2368
 
    :ivar unlock: A callable which will unlock the lock.
2369
 
    """
2370
 
 
2371
 
    def __init__(self, unlock, branch_token):
2372
 
        LogicalLockResult.__init__(self, unlock)
2373
 
        self.branch_token = branch_token
2374
 
 
2375
 
    def __repr__(self):
2376
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2377
 
            self.unlock)
2378
 
 
2379
 
 
2380
2089
class BzrBranch(Branch, _RelockDebugMixin):
2381
2090
    """A branch stored in the actual filesystem.
2382
2091
 
2389
2098
    :ivar repository: Repository for this branch.
2390
2099
    :ivar base: The url of the base directory for this branch; the one
2391
2100
        containing the .bzr directory.
2392
 
    :ivar name: Optional colocated branch name as it exists in the control
2393
 
        directory.
2394
2101
    """
2395
2102
 
2396
2103
    def __init__(self, _format=None,
2397
 
                 _control_files=None, a_bzrdir=None, name=None,
2398
 
                 _repository=None, ignore_fallbacks=False):
 
2104
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2105
                 ignore_fallbacks=False):
2399
2106
        """Create new branch object at a particular location."""
2400
2107
        if a_bzrdir is None:
2401
2108
            raise ValueError('a_bzrdir must be supplied')
2402
2109
        else:
2403
2110
            self.bzrdir = a_bzrdir
2404
2111
        self._base = self.bzrdir.transport.clone('..').base
2405
 
        self.name = name
2406
2112
        # XXX: We should be able to just do
2407
2113
        #   self.base = self.bzrdir.root_transport.base
2408
2114
        # but this does not quite work yet -- mbp 20080522
2415
2121
        Branch.__init__(self)
2416
2122
 
2417
2123
    def __str__(self):
2418
 
        if self.name is None:
2419
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2420
 
        else:
2421
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2422
 
                self.name)
 
2124
        return '%s(%r)' % (self.__class__.__name__, self.base)
2423
2125
 
2424
2126
    __repr__ = __str__
2425
2127
 
2436
2138
        return self.control_files.is_locked()
2437
2139
 
2438
2140
    def lock_write(self, token=None):
2439
 
        """Lock the branch for write operations.
2440
 
 
2441
 
        :param token: A token to permit reacquiring a previously held and
2442
 
            preserved lock.
2443
 
        :return: A BranchWriteLockResult.
2444
 
        """
2445
2141
        if not self.is_locked():
2446
2142
            self._note_lock('w')
2447
2143
        # All-in-one needs to always unlock/lock.
2453
2149
        else:
2454
2150
            took_lock = False
2455
2151
        try:
2456
 
            return BranchWriteLockResult(self.unlock,
2457
 
                self.control_files.lock_write(token=token))
 
2152
            return self.control_files.lock_write(token=token)
2458
2153
        except:
2459
2154
            if took_lock:
2460
2155
                self.repository.unlock()
2461
2156
            raise
2462
2157
 
2463
2158
    def lock_read(self):
2464
 
        """Lock the branch for read operations.
2465
 
 
2466
 
        :return: A bzrlib.lock.LogicalLockResult.
2467
 
        """
2468
2159
        if not self.is_locked():
2469
2160
            self._note_lock('r')
2470
2161
        # All-in-one needs to always unlock/lock.
2477
2168
            took_lock = False
2478
2169
        try:
2479
2170
            self.control_files.lock_read()
2480
 
            return LogicalLockResult(self.unlock)
2481
2171
        except:
2482
2172
            if took_lock:
2483
2173
                self.repository.unlock()
2652
2342
        return result
2653
2343
 
2654
2344
    def get_stacked_on_url(self):
2655
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2345
        raise errors.UnstackableBranchFormat(self._format, self.base)
2656
2346
 
2657
2347
    def set_push_location(self, location):
2658
2348
        """See Branch.set_push_location."""
2848
2538
        if _mod_revision.is_null(last_revision):
2849
2539
            return
2850
2540
        if last_revision not in self._lefthand_history(revision_id):
2851
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2541
            raise errors.AppendRevisionsOnlyViolation(self.base)
2852
2542
 
2853
2543
    def _gen_revision_history(self):
2854
2544
        """Generate the revision history from last revision
2954
2644
        if branch_location is None:
2955
2645
            return Branch.reference_parent(self, file_id, path,
2956
2646
                                           possible_transports)
2957
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2647
        branch_location = urlutils.join(self.base, branch_location)
2958
2648
        return Branch.open(branch_location,
2959
2649
                           possible_transports=possible_transports)
2960
2650
 
3006
2696
        return stacked_url
3007
2697
 
3008
2698
    def _get_append_revisions_only(self):
3009
 
        return self.get_config(
3010
 
            ).get_user_option_as_bool('append_revisions_only')
 
2699
        value = self.get_config().get_user_option('append_revisions_only')
 
2700
        return value == 'True'
3011
2701
 
3012
2702
    @needs_write_lock
3013
2703
    def generate_revision_history(self, revision_id, last_rev=None,
3075
2765
    """
3076
2766
 
3077
2767
    def get_stacked_on_url(self):
3078
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2768
        raise errors.UnstackableBranchFormat(self._format, self.base)
3079
2769
 
3080
2770
 
3081
2771
######################################################################
3168
2858
        :param verbose: Requests more detailed display of what was checked,
3169
2859
            if any.
3170
2860
        """
3171
 
        note('checked branch %s format %s', self.branch.user_url,
 
2861
        note('checked branch %s format %s', self.branch.base,
3172
2862
            self.branch._format)
3173
2863
        for error in self.errors:
3174
2864
            note('found error:%s', error)
3269
2959
    _optimisers = []
3270
2960
    """The available optimised InterBranch types."""
3271
2961
 
3272
 
    @classmethod
3273
 
    def _get_branch_formats_to_test(klass):
3274
 
        """Return an iterable of format tuples for testing.
3275
 
        
3276
 
        :return: An iterable of (from_format, to_format) to use when testing
3277
 
            this InterBranch class. Each InterBranch class should define this
3278
 
            method itself.
3279
 
        """
3280
 
        raise NotImplementedError(klass._get_branch_formats_to_test)
 
2962
    @staticmethod
 
2963
    def _get_branch_formats_to_test():
 
2964
        """Return a tuple with the Branch formats to use when testing."""
 
2965
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3281
2966
 
3282
 
    @needs_write_lock
3283
2967
    def pull(self, overwrite=False, stop_revision=None,
3284
2968
             possible_transports=None, local=False):
3285
2969
        """Mirror source into target branch.
3290
2974
        """
3291
2975
        raise NotImplementedError(self.pull)
3292
2976
 
3293
 
    @needs_write_lock
3294
2977
    def update_revisions(self, stop_revision=None, overwrite=False,
3295
2978
                         graph=None):
3296
2979
        """Pull in new perfect-fit revisions.
3304
2987
        """
3305
2988
        raise NotImplementedError(self.update_revisions)
3306
2989
 
3307
 
    @needs_write_lock
3308
2990
    def push(self, overwrite=False, stop_revision=None,
3309
2991
             _override_hook_source_branch=None):
3310
2992
        """Mirror the source branch into the target branch.
3315
2997
 
3316
2998
 
3317
2999
class GenericInterBranch(InterBranch):
3318
 
    """InterBranch implementation that uses public Branch functions."""
3319
 
 
3320
 
    @classmethod
3321
 
    def is_compatible(klass, source, target):
3322
 
        # GenericBranch uses the public API, so always compatible
3323
 
        return True
3324
 
 
3325
 
    @classmethod
3326
 
    def _get_branch_formats_to_test(klass):
3327
 
        return [(BranchFormat._default_format, BranchFormat._default_format)]
3328
 
 
3329
 
    @classmethod
3330
 
    def unwrap_format(klass, format):
3331
 
        if isinstance(format, remote.RemoteBranchFormat):
3332
 
            format._ensure_real()
3333
 
            return format._custom_format
3334
 
        return format                                                                                                  
3335
 
 
3336
 
    @needs_write_lock
3337
 
    def copy_content_into(self, revision_id=None):
3338
 
        """Copy the content of source into target
3339
 
 
3340
 
        revision_id: if not None, the revision history in the new branch will
3341
 
                     be truncated to end with revision_id.
3342
 
        """
3343
 
        self.source.update_references(self.target)
3344
 
        self.source._synchronize_history(self.target, revision_id)
3345
 
        try:
3346
 
            parent = self.source.get_parent()
3347
 
        except errors.InaccessibleParent, e:
3348
 
            mutter('parent was not accessible to copy: %s', e)
3349
 
        else:
3350
 
            if parent:
3351
 
                self.target.set_parent(parent)
3352
 
        if self.source._push_should_merge_tags():
3353
 
            self.source.tags.merge_to(self.target.tags)
3354
 
 
3355
 
    @needs_write_lock
 
3000
    """InterBranch implementation that uses public Branch functions.
 
3001
    """
 
3002
 
 
3003
    @staticmethod
 
3004
    def _get_branch_formats_to_test():
 
3005
        return BranchFormat._default_format, BranchFormat._default_format
 
3006
 
3356
3007
    def update_revisions(self, stop_revision=None, overwrite=False,
3357
3008
        graph=None):
3358
3009
        """See InterBranch.update_revisions()."""
3359
 
        other_revno, other_last_revision = self.source.last_revision_info()
3360
 
        stop_revno = None # unknown
3361
 
        if stop_revision is None:
3362
 
            stop_revision = other_last_revision
3363
 
            if _mod_revision.is_null(stop_revision):
3364
 
                # if there are no commits, we're done.
3365
 
                return
3366
 
            stop_revno = other_revno
3367
 
 
3368
 
        # what's the current last revision, before we fetch [and change it
3369
 
        # possibly]
3370
 
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
3371
 
        # we fetch here so that we don't process data twice in the common
3372
 
        # case of having something to pull, and so that the check for
3373
 
        # already merged can operate on the just fetched graph, which will
3374
 
        # be cached in memory.
3375
 
        self.target.fetch(self.source, stop_revision)
3376
 
        # Check to see if one is an ancestor of the other
3377
 
        if not overwrite:
3378
 
            if graph is None:
3379
 
                graph = self.target.repository.get_graph()
3380
 
            if self.target._check_if_descendant_or_diverged(
3381
 
                    stop_revision, last_rev, graph, self.source):
3382
 
                # stop_revision is a descendant of last_rev, but we aren't
3383
 
                # overwriting, so we're done.
3384
 
                return
3385
 
        if stop_revno is None:
3386
 
            if graph is None:
3387
 
                graph = self.target.repository.get_graph()
3388
 
            this_revno, this_last_revision = \
3389
 
                    self.target.last_revision_info()
3390
 
            stop_revno = graph.find_distance_to_null(stop_revision,
3391
 
                            [(other_last_revision, other_revno),
3392
 
                             (this_last_revision, this_revno)])
3393
 
        self.target.set_last_revision_info(stop_revno, stop_revision)
3394
 
 
3395
 
    @needs_write_lock
 
3010
        self.source.lock_read()
 
3011
        try:
 
3012
            other_revno, other_last_revision = self.source.last_revision_info()
 
3013
            stop_revno = None # unknown
 
3014
            if stop_revision is None:
 
3015
                stop_revision = other_last_revision
 
3016
                if _mod_revision.is_null(stop_revision):
 
3017
                    # if there are no commits, we're done.
 
3018
                    return
 
3019
                stop_revno = other_revno
 
3020
 
 
3021
            # what's the current last revision, before we fetch [and change it
 
3022
            # possibly]
 
3023
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3024
            # we fetch here so that we don't process data twice in the common
 
3025
            # case of having something to pull, and so that the check for
 
3026
            # already merged can operate on the just fetched graph, which will
 
3027
            # be cached in memory.
 
3028
            self.target.fetch(self.source, stop_revision)
 
3029
            # Check to see if one is an ancestor of the other
 
3030
            if not overwrite:
 
3031
                if graph is None:
 
3032
                    graph = self.target.repository.get_graph()
 
3033
                if self.target._check_if_descendant_or_diverged(
 
3034
                        stop_revision, last_rev, graph, self.source):
 
3035
                    # stop_revision is a descendant of last_rev, but we aren't
 
3036
                    # overwriting, so we're done.
 
3037
                    return
 
3038
            if stop_revno is None:
 
3039
                if graph is None:
 
3040
                    graph = self.target.repository.get_graph()
 
3041
                this_revno, this_last_revision = \
 
3042
                        self.target.last_revision_info()
 
3043
                stop_revno = graph.find_distance_to_null(stop_revision,
 
3044
                                [(other_last_revision, other_revno),
 
3045
                                 (this_last_revision, this_revno)])
 
3046
            self.target.set_last_revision_info(stop_revno, stop_revision)
 
3047
        finally:
 
3048
            self.source.unlock()
 
3049
 
3396
3050
    def pull(self, overwrite=False, stop_revision=None,
3397
 
             possible_transports=None, run_hooks=True,
 
3051
             possible_transports=None, _hook_master=None, run_hooks=True,
3398
3052
             _override_hook_target=None, local=False):
3399
 
        """Pull from source into self, updating my master if any.
 
3053
        """See Branch.pull.
3400
3054
 
 
3055
        :param _hook_master: Private parameter - set the branch to
 
3056
            be supplied as the master to pull hooks.
3401
3057
        :param run_hooks: Private parameter - if false, this branch
3402
3058
            is being called because it's the master of the primary branch,
3403
3059
            so it should not run its hooks.
 
3060
        :param _override_hook_target: Private parameter - set the branch to be
 
3061
            supplied as the target_branch to pull hooks.
 
3062
        :param local: Only update the local branch, and not the bound branch.
3404
3063
        """
3405
 
        bound_location = self.target.get_bound_location()
3406
 
        if local and not bound_location:
 
3064
        # This type of branch can't be bound.
 
3065
        if local:
3407
3066
            raise errors.LocalRequiresBoundBranch()
3408
 
        master_branch = None
3409
 
        if not local and bound_location and self.source.user_url != bound_location:
3410
 
            # not pulling from master, so we need to update master.
3411
 
            master_branch = self.target.get_master_branch(possible_transports)
3412
 
            master_branch.lock_write()
 
3067
        result = PullResult()
 
3068
        result.source_branch = self.source
 
3069
        if _override_hook_target is None:
 
3070
            result.target_branch = self.target
 
3071
        else:
 
3072
            result.target_branch = _override_hook_target
 
3073
        self.source.lock_read()
3413
3074
        try:
3414
 
            if master_branch:
3415
 
                # pull from source into master.
3416
 
                master_branch.pull(self.source, overwrite, stop_revision,
3417
 
                    run_hooks=False)
3418
 
            return self._pull(overwrite,
3419
 
                stop_revision, _hook_master=master_branch,
3420
 
                run_hooks=run_hooks,
3421
 
                _override_hook_target=_override_hook_target)
 
3075
            # We assume that during 'pull' the target repository is closer than
 
3076
            # the source one.
 
3077
            self.source.update_references(self.target)
 
3078
            graph = self.target.repository.get_graph(self.source.repository)
 
3079
            # TODO: Branch formats should have a flag that indicates 
 
3080
            # that revno's are expensive, and pull() should honor that flag.
 
3081
            # -- JRV20090506
 
3082
            result.old_revno, result.old_revid = \
 
3083
                self.target.last_revision_info()
 
3084
            self.target.update_revisions(self.source, stop_revision,
 
3085
                overwrite=overwrite, graph=graph)
 
3086
            # TODO: The old revid should be specified when merging tags, 
 
3087
            # so a tags implementation that versions tags can only 
 
3088
            # pull in the most recent changes. -- JRV20090506
 
3089
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3090
                overwrite)
 
3091
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3092
            if _hook_master:
 
3093
                result.master_branch = _hook_master
 
3094
                result.local_branch = result.target_branch
 
3095
            else:
 
3096
                result.master_branch = result.target_branch
 
3097
                result.local_branch = None
 
3098
            if run_hooks:
 
3099
                for hook in Branch.hooks['post_pull']:
 
3100
                    hook(result)
3422
3101
        finally:
3423
 
            if master_branch:
3424
 
                master_branch.unlock()
 
3102
            self.source.unlock()
 
3103
        return result
3425
3104
 
3426
3105
    def push(self, overwrite=False, stop_revision=None,
3427
3106
             _override_hook_source_branch=None):
3489
3168
            _run_hooks()
3490
3169
            return result
3491
3170
 
3492
 
    def _pull(self, overwrite=False, stop_revision=None,
3493
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3171
    @classmethod
 
3172
    def is_compatible(self, source, target):
 
3173
        # GenericBranch uses the public API, so always compatible
 
3174
        return True
 
3175
 
 
3176
 
 
3177
class InterToBranch5(GenericInterBranch):
 
3178
 
 
3179
    @staticmethod
 
3180
    def _get_branch_formats_to_test():
 
3181
        return BranchFormat._default_format, BzrBranchFormat5()
 
3182
 
 
3183
    def pull(self, overwrite=False, stop_revision=None,
 
3184
             possible_transports=None, run_hooks=True,
3494
3185
             _override_hook_target=None, local=False):
3495
 
        """See Branch.pull.
3496
 
 
3497
 
        This function is the core worker, used by GenericInterBranch.pull to
3498
 
        avoid duplication when pulling source->master and source->local.
3499
 
 
3500
 
        :param _hook_master: Private parameter - set the branch to
3501
 
            be supplied as the master to pull hooks.
 
3186
        """Pull from source into self, updating my master if any.
 
3187
 
3502
3188
        :param run_hooks: Private parameter - if false, this branch
3503
3189
            is being called because it's the master of the primary branch,
3504
3190
            so it should not run its hooks.
3505
 
        :param _override_hook_target: Private parameter - set the branch to be
3506
 
            supplied as the target_branch to pull hooks.
3507
 
        :param local: Only update the local branch, and not the bound branch.
3508
3191
        """
3509
 
        # This type of branch can't be bound.
3510
 
        if local:
 
3192
        bound_location = self.target.get_bound_location()
 
3193
        if local and not bound_location:
3511
3194
            raise errors.LocalRequiresBoundBranch()
3512
 
        result = PullResult()
3513
 
        result.source_branch = self.source
3514
 
        if _override_hook_target is None:
3515
 
            result.target_branch = self.target
3516
 
        else:
3517
 
            result.target_branch = _override_hook_target
3518
 
        self.source.lock_read()
 
3195
        master_branch = None
 
3196
        if not local and bound_location and self.source.base != bound_location:
 
3197
            # not pulling from master, so we need to update master.
 
3198
            master_branch = self.target.get_master_branch(possible_transports)
 
3199
            master_branch.lock_write()
3519
3200
        try:
3520
 
            # We assume that during 'pull' the target repository is closer than
3521
 
            # the source one.
3522
 
            self.source.update_references(self.target)
3523
 
            graph = self.target.repository.get_graph(self.source.repository)
3524
 
            # TODO: Branch formats should have a flag that indicates 
3525
 
            # that revno's are expensive, and pull() should honor that flag.
3526
 
            # -- JRV20090506
3527
 
            result.old_revno, result.old_revid = \
3528
 
                self.target.last_revision_info()
3529
 
            self.target.update_revisions(self.source, stop_revision,
3530
 
                overwrite=overwrite, graph=graph)
3531
 
            # TODO: The old revid should be specified when merging tags, 
3532
 
            # so a tags implementation that versions tags can only 
3533
 
            # pull in the most recent changes. -- JRV20090506
3534
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3535
 
                overwrite)
3536
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3537
 
            if _hook_master:
3538
 
                result.master_branch = _hook_master
3539
 
                result.local_branch = result.target_branch
3540
 
            else:
3541
 
                result.master_branch = result.target_branch
3542
 
                result.local_branch = None
3543
 
            if run_hooks:
3544
 
                for hook in Branch.hooks['post_pull']:
3545
 
                    hook(result)
 
3201
            if master_branch:
 
3202
                # pull from source into master.
 
3203
                master_branch.pull(self.source, overwrite, stop_revision,
 
3204
                    run_hooks=False)
 
3205
            return super(InterToBranch5, self).pull(overwrite,
 
3206
                stop_revision, _hook_master=master_branch,
 
3207
                run_hooks=run_hooks,
 
3208
                _override_hook_target=_override_hook_target)
3546
3209
        finally:
3547
 
            self.source.unlock()
3548
 
        return result
 
3210
            if master_branch:
 
3211
                master_branch.unlock()
3549
3212
 
3550
3213
 
3551
3214
InterBranch.register_optimiser(GenericInterBranch)
 
3215
InterBranch.register_optimiser(InterToBranch5)