~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-06-23 15:27:50 UTC
  • mfrom: (4398.9.1 _add_text_docstrings)
  • Revision ID: pqm@pqm.ubuntu.com-20090623152750-ecuv25e1te21w2pc
(Matt Nordhoff) Update _add_text docstrings that still referred to
        add_text.

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
46
46
    )
47
47
""")
48
48
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
50
from bzrlib.hooks import HookPoint, Hooks
51
51
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
53
52
from bzrlib import registry
54
53
from bzrlib.symbol_versioning import (
55
54
    deprecated_in,
63
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
63
 
65
64
 
66
 
class Branch(bzrdir.ControlComponent):
 
65
# TODO: Maybe include checks for common corruption of newlines, etc?
 
66
 
 
67
# TODO: Some operations like log might retrieve the same revisions
 
68
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
69
# cache in memory to make this faster.  In general anything can be
 
70
# cached in memory between lock and unlock operations. .. nb thats
 
71
# what the transaction identity map provides
 
72
 
 
73
 
 
74
######################################################################
 
75
# branch objects
 
76
 
 
77
class Branch(object):
67
78
    """Branch holding a history of revisions.
68
79
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
80
    base
 
81
        Base directory/url of the branch.
72
82
 
73
83
    hooks: An instance of BranchHooks.
74
84
    """
76
86
    # - RBC 20060112
77
87
    base = None
78
88
 
79
 
    @property
80
 
    def control_transport(self):
81
 
        return self._transport
82
 
 
83
 
    @property
84
 
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
86
 
 
87
89
    def __init__(self, *ignored, **ignored_too):
88
90
        self.tags = self._format.make_tags(self)
89
91
        self._revision_history_cache = None
104
106
        """Activate the branch/repository from url as a fallback repository."""
105
107
        repo = self._get_fallback_repository(url)
106
108
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
109
            raise errors.UnstackableLocationError(self.base, url)
108
110
        self.repository.add_fallback_repository(repo)
109
111
 
110
112
    def break_lock(self):
147
149
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
150
            self._partial_revision_history_cache.pop()
149
151
 
150
 
    def _get_check_refs(self):
151
 
        """Get the references needed for check().
152
 
 
153
 
        See bzrlib.check.
154
 
        """
155
 
        revid = self.last_revision()
156
 
        return [('revision-existence', revid), ('lefthand-distance', revid)]
157
 
 
158
152
    @staticmethod
159
153
    def open(base, _unsupported=False, possible_transports=None):
160
154
        """Open the branch rooted at base.
164
158
        """
165
159
        control = bzrdir.BzrDir.open(base, _unsupported,
166
160
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
161
        return control.open_branch(_unsupported)
168
162
 
169
163
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
164
    def open_from_transport(transport, _unsupported=False):
171
165
        """Open the branch rooted at transport"""
172
166
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
167
        return control.open_branch(_unsupported)
174
168
 
175
169
    @staticmethod
176
170
    def open_containing(url, possible_transports=None):
214
208
    def _get_fallback_repository(self, url):
215
209
        """Get the repository we fallback to at url."""
216
210
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
211
        a_bzrdir = bzrdir.BzrDir.open(url,
218
212
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
213
        return a_bzrdir.open_branch().repository
220
214
 
221
215
    def _get_tags_bytes(self):
222
216
        """Get the bytes of a serialised tags dict.
283
277
        new_history.reverse()
284
278
        return new_history
285
279
 
286
 
    def lock_write(self, token=None):
287
 
        """Lock the branch for write operations.
288
 
 
289
 
        :param token: A token to permit reacquiring a previously held and
290
 
            preserved lock.
291
 
        :return: A BranchWriteLockResult.
292
 
        """
 
280
    def lock_write(self):
293
281
        raise NotImplementedError(self.lock_write)
294
282
 
295
283
    def lock_read(self):
296
 
        """Lock the branch for read operations.
297
 
 
298
 
        :return: An object with an unlock method which will release the lock
299
 
            obtained.
300
 
        """
301
284
        raise NotImplementedError(self.lock_read)
302
285
 
303
286
    def unlock(self):
428
411
            * 'include' - the stop revision is the last item in the result
429
412
            * 'with-merges' - include the stop revision and all of its
430
413
              merged revisions in the result
431
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
432
 
              that are in both ancestries
433
414
        :param direction: either 'reverse' or 'forward':
434
415
            * reverse means return the start_revision_id first, i.e.
435
416
              start at the most recent revision and go backwards in history
457
438
        # start_revision_id.
458
439
        if self._merge_sorted_revisions_cache is None:
459
440
            last_revision = self.last_revision()
460
 
            known_graph = self.repository.get_known_graph_ancestry(
461
 
                [last_revision])
462
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
 
                last_revision)
 
441
            graph = self.repository.get_graph()
 
442
            parent_map = dict(((key, value) for key, value in
 
443
                     graph.iter_ancestry([last_revision]) if value is not None))
 
444
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
445
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
446
                generate_revno=True)
 
447
            # Drop the sequence # before caching
 
448
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
449
 
464
450
        filtered = self._filter_merge_sorted_revisions(
465
451
            self._merge_sorted_revisions_cache, start_revision_id,
466
452
            stop_revision_id, stop_rule)
467
 
        # Make sure we don't return revisions that are not part of the
468
 
        # start_revision_id ancestry.
469
 
        filtered = self._filter_start_non_ancestors(filtered)
470
453
        if direction == 'reverse':
471
454
            return filtered
472
455
        if direction == 'forward':
479
462
        """Iterate over an inclusive range of sorted revisions."""
480
463
        rev_iter = iter(merge_sorted_revisions)
481
464
        if start_revision_id is not None:
482
 
            for node in rev_iter:
483
 
                rev_id = node.key[-1]
 
465
            for rev_id, depth, revno, end_of_merge in rev_iter:
484
466
                if rev_id != start_revision_id:
485
467
                    continue
486
468
                else:
487
469
                    # The decision to include the start or not
488
470
                    # depends on the stop_rule if a stop is provided
489
 
                    # so pop this node back into the iterator
490
 
                    rev_iter = chain(iter([node]), rev_iter)
 
471
                    rev_iter = chain(
 
472
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
473
                        rev_iter)
491
474
                    break
492
475
        if stop_revision_id is None:
493
 
            # Yield everything
494
 
            for node in rev_iter:
495
 
                rev_id = node.key[-1]
496
 
                yield (rev_id, node.merge_depth, node.revno,
497
 
                       node.end_of_merge)
 
476
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
477
                yield rev_id, depth, revno, end_of_merge
498
478
        elif stop_rule == 'exclude':
499
 
            for node in rev_iter:
500
 
                rev_id = node.key[-1]
 
479
            for rev_id, depth, revno, end_of_merge in rev_iter:
501
480
                if rev_id == stop_revision_id:
502
481
                    return
503
 
                yield (rev_id, node.merge_depth, node.revno,
504
 
                       node.end_of_merge)
 
482
                yield rev_id, depth, revno, end_of_merge
505
483
        elif stop_rule == 'include':
506
 
            for node in rev_iter:
507
 
                rev_id = node.key[-1]
508
 
                yield (rev_id, node.merge_depth, node.revno,
509
 
                       node.end_of_merge)
 
484
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
485
                yield rev_id, depth, revno, end_of_merge
510
486
                if rev_id == stop_revision_id:
511
487
                    return
512
 
        elif stop_rule == 'with-merges-without-common-ancestry':
513
 
            # We want to exclude all revisions that are already part of the
514
 
            # stop_revision_id ancestry.
515
 
            graph = self.repository.get_graph()
516
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
517
 
                                                    [stop_revision_id])
518
 
            for node in rev_iter:
519
 
                rev_id = node.key[-1]
520
 
                if rev_id not in ancestors:
521
 
                    continue
522
 
                yield (rev_id, node.merge_depth, node.revno,
523
 
                       node.end_of_merge)
524
488
        elif stop_rule == 'with-merges':
525
489
            stop_rev = self.repository.get_revision(stop_revision_id)
526
490
            if stop_rev.parent_ids:
527
491
                left_parent = stop_rev.parent_ids[0]
528
492
            else:
529
493
                left_parent = _mod_revision.NULL_REVISION
530
 
            # left_parent is the actual revision we want to stop logging at,
531
 
            # since we want to show the merged revisions after the stop_rev too
532
 
            reached_stop_revision_id = False
533
 
            revision_id_whitelist = []
534
 
            for node in rev_iter:
535
 
                rev_id = node.key[-1]
 
494
            for rev_id, depth, revno, end_of_merge in rev_iter:
536
495
                if rev_id == left_parent:
537
 
                    # reached the left parent after the stop_revision
538
496
                    return
539
 
                if (not reached_stop_revision_id or
540
 
                        rev_id in revision_id_whitelist):
541
 
                    yield (rev_id, node.merge_depth, node.revno,
542
 
                       node.end_of_merge)
543
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
544
 
                        # only do the merged revs of rev_id from now on
545
 
                        rev = self.repository.get_revision(rev_id)
546
 
                        if rev.parent_ids:
547
 
                            reached_stop_revision_id = True
548
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
497
                yield rev_id, depth, revno, end_of_merge
549
498
        else:
550
499
            raise ValueError('invalid stop_rule %r' % stop_rule)
551
500
 
552
 
    def _filter_start_non_ancestors(self, rev_iter):
553
 
        # If we started from a dotted revno, we want to consider it as a tip
554
 
        # and don't want to yield revisions that are not part of its
555
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
556
 
        # uninteresting descendants of the first parent of our tip before the
557
 
        # tip itself.
558
 
        first = rev_iter.next()
559
 
        (rev_id, merge_depth, revno, end_of_merge) = first
560
 
        yield first
561
 
        if not merge_depth:
562
 
            # We start at a mainline revision so by definition, all others
563
 
            # revisions in rev_iter are ancestors
564
 
            for node in rev_iter:
565
 
                yield node
566
 
 
567
 
        clean = False
568
 
        whitelist = set()
569
 
        pmap = self.repository.get_parent_map([rev_id])
570
 
        parents = pmap.get(rev_id, [])
571
 
        if parents:
572
 
            whitelist.update(parents)
573
 
        else:
574
 
            # If there is no parents, there is nothing of interest left
575
 
 
576
 
            # FIXME: It's hard to test this scenario here as this code is never
577
 
            # called in that case. -- vila 20100322
578
 
            return
579
 
 
580
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
 
            if not clean:
582
 
                if rev_id in whitelist:
583
 
                    pmap = self.repository.get_parent_map([rev_id])
584
 
                    parents = pmap.get(rev_id, [])
585
 
                    whitelist.remove(rev_id)
586
 
                    whitelist.update(parents)
587
 
                    if merge_depth == 0:
588
 
                        # We've reached the mainline, there is nothing left to
589
 
                        # filter
590
 
                        clean = True
591
 
                else:
592
 
                    # A revision that is not part of the ancestry of our
593
 
                    # starting revision.
594
 
                    continue
595
 
            yield (rev_id, merge_depth, revno, end_of_merge)
596
 
 
597
501
    def leave_lock_in_place(self):
598
502
        """Tell this branch object not to release the physical lock when this
599
503
        object is unlocked.
616
520
        :param other: The branch to bind to
617
521
        :type other: Branch
618
522
        """
619
 
        raise errors.UpgradeRequired(self.user_url)
 
523
        raise errors.UpgradeRequired(self.base)
620
524
 
621
525
    def set_append_revisions_only(self, enabled):
622
526
        if not self._format.supports_set_append_revisions_only():
623
 
            raise errors.UpgradeRequired(self.user_url)
 
527
            raise errors.UpgradeRequired(self.base)
624
528
        if enabled:
625
529
            value = 'True'
626
530
        else:
674
578
    def get_old_bound_location(self):
675
579
        """Return the URL of the branch we used to be bound to
676
580
        """
677
 
        raise errors.UpgradeRequired(self.user_url)
 
581
        raise errors.UpgradeRequired(self.base)
678
582
 
679
583
    def get_commit_builder(self, parents, config=None, timestamp=None,
680
584
                           timezone=None, committer=None, revprops=None,
758
662
            stacking.
759
663
        """
760
664
        if not self._format.supports_stacking():
761
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
762
 
        # XXX: Changing from one fallback repository to another does not check
763
 
        # that all the data you need is present in the new fallback.
764
 
        # Possibly it should.
 
665
            raise errors.UnstackableBranchFormat(self._format, self.base)
765
666
        self._check_stackable_repo()
766
667
        if not url:
767
668
            try:
769
670
            except (errors.NotStacked, errors.UnstackableBranchFormat,
770
671
                errors.UnstackableRepositoryFormat):
771
672
                return
772
 
            self._unstack()
 
673
            url = ''
 
674
            # XXX: Lock correctness - should unlock our old repo if we were
 
675
            # locked.
 
676
            # repositories don't offer an interface to remove fallback
 
677
            # repositories today; take the conceptually simpler option and just
 
678
            # reopen it.
 
679
            self.repository = self.bzrdir.find_repository()
 
680
            self.repository.lock_write()
 
681
            # for every revision reference the branch has, ensure it is pulled
 
682
            # in.
 
683
            source_repository = self._get_fallback_repository(old_url)
 
684
            for revision_id in chain([self.last_revision()],
 
685
                self.tags.get_reverse_tag_dict()):
 
686
                self.repository.fetch(source_repository, revision_id,
 
687
                    find_ghosts=True)
773
688
        else:
774
689
            self._activate_fallback_location(url)
775
690
        # write this out after the repository is stacked to avoid setting a
776
691
        # stacked config that doesn't work.
777
692
        self._set_config_location('stacked_on_location', url)
778
693
 
779
 
    def _unstack(self):
780
 
        """Change a branch to be unstacked, copying data as needed.
781
 
        
782
 
        Don't call this directly, use set_stacked_on_url(None).
783
 
        """
784
 
        pb = ui.ui_factory.nested_progress_bar()
785
 
        try:
786
 
            pb.update("Unstacking")
787
 
            # The basic approach here is to fetch the tip of the branch,
788
 
            # including all available ghosts, from the existing stacked
789
 
            # repository into a new repository object without the fallbacks. 
790
 
            #
791
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
792
 
            # correct for CHKMap repostiories
793
 
            old_repository = self.repository
794
 
            if len(old_repository._fallback_repositories) != 1:
795
 
                raise AssertionError("can't cope with fallback repositories "
796
 
                    "of %r" % (self.repository,))
797
 
            # unlock it, including unlocking the fallback
798
 
            old_repository.unlock()
799
 
            old_repository.lock_read()
800
 
            try:
801
 
                # Repositories don't offer an interface to remove fallback
802
 
                # repositories today; take the conceptually simpler option and just
803
 
                # reopen it.  We reopen it starting from the URL so that we
804
 
                # get a separate connection for RemoteRepositories and can
805
 
                # stream from one of them to the other.  This does mean doing
806
 
                # separate SSH connection setup, but unstacking is not a
807
 
                # common operation so it's tolerable.
808
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
809
 
                new_repository = new_bzrdir.find_repository()
810
 
                self.repository = new_repository
811
 
                if self.repository._fallback_repositories:
812
 
                    raise AssertionError("didn't expect %r to have "
813
 
                        "fallback_repositories"
814
 
                        % (self.repository,))
815
 
                # this is not paired with an unlock because it's just restoring
816
 
                # the previous state; the lock's released when set_stacked_on_url
817
 
                # returns
818
 
                self.repository.lock_write()
819
 
                # XXX: If you unstack a branch while it has a working tree
820
 
                # with a pending merge, the pending-merged revisions will no
821
 
                # longer be present.  You can (probably) revert and remerge.
822
 
                #
823
 
                # XXX: This only fetches up to the tip of the repository; it
824
 
                # doesn't bring across any tags.  That's fairly consistent
825
 
                # with how branch works, but perhaps not ideal.
826
 
                self.repository.fetch(old_repository,
827
 
                    revision_id=self.last_revision(),
828
 
                    find_ghosts=True)
829
 
            finally:
830
 
                old_repository.unlock()
831
 
        finally:
832
 
            pb.finished()
833
694
 
834
695
    def _set_tags_bytes(self, bytes):
835
696
        """Mirror method for _get_tags_bytes.
915
776
 
916
777
    def unbind(self):
917
778
        """Older format branches cannot bind or unbind."""
918
 
        raise errors.UpgradeRequired(self.user_url)
 
779
        raise errors.UpgradeRequired(self.base)
919
780
 
920
781
    def last_revision(self):
921
782
        """Return last revision id, or NULL_REVISION."""
1081
942
        try:
1082
943
            return urlutils.join(self.base[:-1], parent)
1083
944
        except errors.InvalidURLJoin, e:
1084
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
945
            raise errors.InaccessibleParent(parent, self.base)
1085
946
 
1086
947
    def _get_parent_location(self):
1087
948
        raise NotImplementedError(self._get_parent_location)
1172
1033
        params = ChangeBranchTipParams(
1173
1034
            self, old_revno, new_revno, old_revid, new_revid)
1174
1035
        for hook in hooks:
1175
 
            hook(params)
 
1036
            try:
 
1037
                hook(params)
 
1038
            except errors.TipChangeRejected:
 
1039
                raise
 
1040
            except Exception:
 
1041
                exc_info = sys.exc_info()
 
1042
                hook_name = Branch.hooks.get_hook_name(hook)
 
1043
                raise errors.HookFailed(
 
1044
                    'pre_change_branch_tip', hook_name, exc_info)
1176
1045
 
1177
1046
    @needs_write_lock
1178
1047
    def update(self):
1227
1096
        revision_id: if not None, the revision history in the new branch will
1228
1097
                     be truncated to end with revision_id.
1229
1098
        """
1230
 
        if (repository_policy is not None and
1231
 
            repository_policy.requires_stacking()):
1232
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1233
1099
        result = to_bzrdir.create_branch()
1234
1100
        result.lock_write()
1235
1101
        try:
1303
1169
        target._set_all_reference_info(target_reference_dict)
1304
1170
 
1305
1171
    @needs_read_lock
1306
 
    def check(self, refs):
 
1172
    def check(self):
1307
1173
        """Check consistency of the branch.
1308
1174
 
1309
1175
        In particular this checks that revisions given in the revision-history
1312
1178
 
1313
1179
        Callers will typically also want to check the repository.
1314
1180
 
1315
 
        :param refs: Calculated refs for this branch as specified by
1316
 
            branch._get_check_refs()
1317
1181
        :return: A BranchCheckResult.
1318
1182
        """
1319
 
        result = BranchCheckResult(self)
 
1183
        ret = BranchCheckResult(self)
 
1184
        mainline_parent_id = None
1320
1185
        last_revno, last_revision_id = self.last_revision_info()
1321
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1322
 
        if actual_revno != last_revno:
1323
 
            result.errors.append(errors.BzrCheckError(
1324
 
                'revno does not match len(mainline) %s != %s' % (
1325
 
                last_revno, actual_revno)))
1326
 
        # TODO: We should probably also check that self.revision_history
1327
 
        # matches the repository for older branch formats.
1328
 
        # If looking for the code that cross-checks repository parents against
1329
 
        # the iter_reverse_revision_history output, that is now a repository
1330
 
        # specific check.
1331
 
        return result
 
1186
        real_rev_history = []
 
1187
        try:
 
1188
            for revid in self.repository.iter_reverse_revision_history(
 
1189
                last_revision_id):
 
1190
                real_rev_history.append(revid)
 
1191
        except errors.RevisionNotPresent:
 
1192
            ret.ghosts_in_mainline = True
 
1193
        else:
 
1194
            ret.ghosts_in_mainline = False
 
1195
        real_rev_history.reverse()
 
1196
        if len(real_rev_history) != last_revno:
 
1197
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1198
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1199
        # TODO: We should probably also check that real_rev_history actually
 
1200
        #       matches self.revision_history()
 
1201
        for revision_id in real_rev_history:
 
1202
            try:
 
1203
                revision = self.repository.get_revision(revision_id)
 
1204
            except errors.NoSuchRevision, e:
 
1205
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1206
                            % revision_id)
 
1207
            # In general the first entry on the revision history has no parents.
 
1208
            # But it's not illegal for it to have parents listed; this can happen
 
1209
            # in imports from Arch when the parents weren't reachable.
 
1210
            if mainline_parent_id is not None:
 
1211
                if mainline_parent_id not in revision.parent_ids:
 
1212
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1213
                                        "parents of {%s}"
 
1214
                                        % (mainline_parent_id, revision_id))
 
1215
            mainline_parent_id = revision_id
 
1216
        return ret
1332
1217
 
1333
1218
    def _get_checkout_format(self):
1334
1219
        """Return the most suitable metadir for a checkout of this branch.
1359
1244
        # clone call. Or something. 20090224 RBC/spiv.
1360
1245
        if revision_id is None:
1361
1246
            revision_id = self.last_revision()
1362
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1363
 
            revision_id=revision_id, stacked_on=stacked_on,
1364
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1247
        try:
 
1248
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1249
                revision_id=revision_id, stacked_on=stacked_on,
 
1250
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1251
        except errors.FileExists:
 
1252
            if not use_existing_dir:
 
1253
                raise
 
1254
        except errors.NoSuchFile:
 
1255
            if not create_prefix:
 
1256
                raise
1365
1257
        return dir_to.open_branch()
1366
1258
 
1367
1259
    def create_checkout(self, to_location, revision_id=None,
1386
1278
        if lightweight:
1387
1279
            format = self._get_checkout_format()
1388
1280
            checkout = format.initialize_on_transport(t)
1389
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1390
 
                target_branch=self)
 
1281
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1391
1282
        else:
1392
1283
            format = self._get_checkout_format()
1393
1284
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1435
1326
    def supports_tags(self):
1436
1327
        return self._format.supports_tags()
1437
1328
 
1438
 
    def automatic_tag_name(self, revision_id):
1439
 
        """Try to automatically find the tag name for a revision.
1440
 
 
1441
 
        :param revision_id: Revision id of the revision.
1442
 
        :return: A tag name or None if no tag name could be determined.
1443
 
        """
1444
 
        for hook in Branch.hooks['automatic_tag_name']:
1445
 
            ret = hook(self, revision_id)
1446
 
            if ret is not None:
1447
 
                return ret
1448
 
        return None
1449
 
 
1450
1329
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1451
1330
                                         other_branch):
1452
1331
        """Ensure that revision_b is a descendant of revision_a.
1516
1395
        return not (self == other)
1517
1396
 
1518
1397
    @classmethod
1519
 
    def find_format(klass, a_bzrdir, name=None):
 
1398
    def find_format(klass, a_bzrdir):
1520
1399
        """Return the format for the branch object in a_bzrdir."""
1521
1400
        try:
1522
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1523
 
            format_string = transport.get_bytes("format")
 
1401
            transport = a_bzrdir.get_branch_transport(None)
 
1402
            format_string = transport.get("format").read()
1524
1403
            return klass._formats[format_string]
1525
1404
        except errors.NoSuchFile:
1526
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1405
            raise errors.NotBranchError(path=transport.base)
1527
1406
        except KeyError:
1528
1407
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1529
1408
 
1565
1444
        """Return the short format description for this format."""
1566
1445
        raise NotImplementedError(self.get_format_description)
1567
1446
 
1568
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1569
 
        hooks = Branch.hooks['post_branch_init']
1570
 
        if not hooks:
1571
 
            return
1572
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1573
 
        for hook in hooks:
1574
 
            hook(params)
1575
 
 
1576
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1577
 
                           lock_type='metadir', set_format=True):
 
1447
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1448
                           set_format=True):
1578
1449
        """Initialize a branch in a bzrdir, with specified files
1579
1450
 
1580
1451
        :param a_bzrdir: The bzrdir to initialize the branch in
1581
1452
        :param utf8_files: The files to create as a list of
1582
1453
            (filename, content) tuples
1583
 
        :param name: Name of colocated branch to create, if any
1584
1454
        :param set_format: If True, set the format with
1585
1455
            self.get_format_string.  (BzrBranch4 has its format set
1586
1456
            elsewhere)
1587
1457
        :return: a branch in this format
1588
1458
        """
1589
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1590
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1459
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1460
        branch_transport = a_bzrdir.get_branch_transport(self)
1591
1461
        lock_map = {
1592
1462
            'metadir': ('lock', lockdir.LockDir),
1593
1463
            'branch4': ('branch-lock', lockable_files.TransportLock),
1614
1484
        finally:
1615
1485
            if lock_taken:
1616
1486
                control_files.unlock()
1617
 
        branch = self.open(a_bzrdir, name, _found=True)
1618
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1619
 
        return branch
 
1487
        return self.open(a_bzrdir, _found=True)
1620
1488
 
1621
 
    def initialize(self, a_bzrdir, name=None):
1622
 
        """Create a branch of this format in a_bzrdir.
1623
 
        
1624
 
        :param name: Name of the colocated branch to create.
1625
 
        """
 
1489
    def initialize(self, a_bzrdir):
 
1490
        """Create a branch of this format in a_bzrdir."""
1626
1491
        raise NotImplementedError(self.initialize)
1627
1492
 
1628
1493
    def is_supported(self):
1658
1523
        """
1659
1524
        raise NotImplementedError(self.network_name)
1660
1525
 
1661
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1526
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1662
1527
        """Return the branch object for a_bzrdir
1663
1528
 
1664
1529
        :param a_bzrdir: A BzrDir that contains a branch.
1665
 
        :param name: Name of colocated branch to open
1666
1530
        :param _found: a private parameter, do not use it. It is used to
1667
1531
            indicate if format probing has already be done.
1668
1532
        :param ignore_fallbacks: when set, no fallback branches will be opened
1776
1640
            "multiple hooks installed for transform_fallback_location, "
1777
1641
            "all are called with the url returned from the previous hook."
1778
1642
            "The order is however undefined.", (1, 9), None))
1779
 
        self.create_hook(HookPoint('automatic_tag_name',
1780
 
            "Called to determine an automatic tag name for a revision."
1781
 
            "automatic_tag_name is called with (branch, revision_id) and "
1782
 
            "should return a tag name or None if no tag name could be "
1783
 
            "determined. The first non-None tag name returned will be used.",
1784
 
            (2, 2), None))
1785
 
        self.create_hook(HookPoint('post_branch_init',
1786
 
            "Called after new branch initialization completes. "
1787
 
            "post_branch_init is called with a "
1788
 
            "bzrlib.branch.BranchInitHookParams. "
1789
 
            "Note that init, branch and checkout (both heavyweight and "
1790
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1791
 
        self.create_hook(HookPoint('post_switch',
1792
 
            "Called after a checkout switches branch. "
1793
 
            "post_switch is called with a "
1794
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1795
 
 
1796
1643
 
1797
1644
 
1798
1645
# install the default hooks into the Branch class.
1837
1684
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1838
1685
 
1839
1686
 
1840
 
class BranchInitHookParams(object):
1841
 
    """Object holding parameters passed to *_branch_init hooks.
1842
 
 
1843
 
    There are 4 fields that hooks may wish to access:
1844
 
 
1845
 
    :ivar format: the branch format
1846
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
 
    :ivar name: name of colocated branch, if any (or None)
1848
 
    :ivar branch: the branch created
1849
 
 
1850
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
 
    the checkout, hence they are different from the corresponding fields in
1852
 
    branch, which refer to the original branch.
1853
 
    """
1854
 
 
1855
 
    def __init__(self, format, a_bzrdir, name, branch):
1856
 
        """Create a group of BranchInitHook parameters.
1857
 
 
1858
 
        :param format: the branch format
1859
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1860
 
            initialized
1861
 
        :param name: name of colocated branch, if any (or None)
1862
 
        :param branch: the branch created
1863
 
 
1864
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1865
 
        to the checkout, hence they are different from the corresponding fields
1866
 
        in branch, which refer to the original branch.
1867
 
        """
1868
 
        self.format = format
1869
 
        self.bzrdir = a_bzrdir
1870
 
        self.name = name
1871
 
        self.branch = branch
1872
 
 
1873
 
    def __eq__(self, other):
1874
 
        return self.__dict__ == other.__dict__
1875
 
 
1876
 
    def __repr__(self):
1877
 
        if self.branch:
1878
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1879
 
        else:
1880
 
            return "<%s of format:%s bzrdir:%s>" % (
1881
 
                self.__class__.__name__, self.branch,
1882
 
                self.format, self.bzrdir)
1883
 
 
1884
 
 
1885
 
class SwitchHookParams(object):
1886
 
    """Object holding parameters passed to *_switch hooks.
1887
 
 
1888
 
    There are 4 fields that hooks may wish to access:
1889
 
 
1890
 
    :ivar control_dir: BzrDir of the checkout to change
1891
 
    :ivar to_branch: branch that the checkout is to reference
1892
 
    :ivar force: skip the check for local commits in a heavy checkout
1893
 
    :ivar revision_id: revision ID to switch to (or None)
1894
 
    """
1895
 
 
1896
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1897
 
        """Create a group of SwitchHook parameters.
1898
 
 
1899
 
        :param control_dir: BzrDir of the checkout to change
1900
 
        :param to_branch: branch that the checkout is to reference
1901
 
        :param force: skip the check for local commits in a heavy checkout
1902
 
        :param revision_id: revision ID to switch to (or None)
1903
 
        """
1904
 
        self.control_dir = control_dir
1905
 
        self.to_branch = to_branch
1906
 
        self.force = force
1907
 
        self.revision_id = revision_id
1908
 
 
1909
 
    def __eq__(self, other):
1910
 
        return self.__dict__ == other.__dict__
1911
 
 
1912
 
    def __repr__(self):
1913
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
 
            self.control_dir, self.to_branch,
1915
 
            self.revision_id)
1916
 
 
1917
 
 
1918
1687
class BzrBranchFormat4(BranchFormat):
1919
1688
    """Bzr branch format 4.
1920
1689
 
1927
1696
        """See BranchFormat.get_format_description()."""
1928
1697
        return "Branch format 4"
1929
1698
 
1930
 
    def initialize(self, a_bzrdir, name=None):
 
1699
    def initialize(self, a_bzrdir):
1931
1700
        """Create a branch of this format in a_bzrdir."""
1932
1701
        utf8_files = [('revision-history', ''),
1933
1702
                      ('branch-name', ''),
1934
1703
                      ]
1935
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1704
        return self._initialize_helper(a_bzrdir, utf8_files,
1936
1705
                                       lock_type='branch4', set_format=False)
1937
1706
 
1938
1707
    def __init__(self):
1943
1712
        """The network name for this format is the control dirs disk label."""
1944
1713
        return self._matchingbzrdir.get_format_string()
1945
1714
 
1946
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1715
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1947
1716
        """See BranchFormat.open()."""
1948
1717
        if not _found:
1949
1718
            # we are being called directly and must probe.
1951
1720
        return BzrBranch(_format=self,
1952
1721
                         _control_files=a_bzrdir._control_files,
1953
1722
                         a_bzrdir=a_bzrdir,
1954
 
                         name=name,
1955
1723
                         _repository=a_bzrdir.open_repository())
1956
1724
 
1957
1725
    def __str__(self):
1972
1740
        """
1973
1741
        return self.get_format_string()
1974
1742
 
1975
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1743
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1976
1744
        """See BranchFormat.open()."""
1977
1745
        if not _found:
1978
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1746
            format = BranchFormat.find_format(a_bzrdir)
1979
1747
            if format.__class__ != self.__class__:
1980
1748
                raise AssertionError("wrong format %r found for %r" %
1981
1749
                    (format, self))
1982
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1983
1750
        try:
 
1751
            transport = a_bzrdir.get_branch_transport(None)
1984
1752
            control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1753
                                                         lockdir.LockDir)
1986
1754
            return self._branch_class()(_format=self,
1987
1755
                              _control_files=control_files,
1988
 
                              name=name,
1989
1756
                              a_bzrdir=a_bzrdir,
1990
1757
                              _repository=a_bzrdir.find_repository(),
1991
1758
                              ignore_fallbacks=ignore_fallbacks)
1992
1759
        except errors.NoSuchFile:
1993
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1760
            raise errors.NotBranchError(path=transport.base)
1994
1761
 
1995
1762
    def __init__(self):
1996
1763
        super(BranchFormatMetadir, self).__init__()
2025
1792
        """See BranchFormat.get_format_description()."""
2026
1793
        return "Branch format 5"
2027
1794
 
2028
 
    def initialize(self, a_bzrdir, name=None):
 
1795
    def initialize(self, a_bzrdir):
2029
1796
        """Create a branch of this format in a_bzrdir."""
2030
1797
        utf8_files = [('revision-history', ''),
2031
1798
                      ('branch-name', ''),
2032
1799
                      ]
2033
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1800
        return self._initialize_helper(a_bzrdir, utf8_files)
2034
1801
 
2035
1802
    def supports_tags(self):
2036
1803
        return False
2058
1825
        """See BranchFormat.get_format_description()."""
2059
1826
        return "Branch format 6"
2060
1827
 
2061
 
    def initialize(self, a_bzrdir, name=None):
 
1828
    def initialize(self, a_bzrdir):
2062
1829
        """Create a branch of this format in a_bzrdir."""
2063
1830
        utf8_files = [('last-revision', '0 null:\n'),
2064
1831
                      ('branch.conf', ''),
2065
1832
                      ('tags', ''),
2066
1833
                      ]
2067
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1834
        return self._initialize_helper(a_bzrdir, utf8_files)
2068
1835
 
2069
1836
    def make_tags(self, branch):
2070
1837
        """See bzrlib.branch.BranchFormat.make_tags()."""
2088
1855
        """See BranchFormat.get_format_description()."""
2089
1856
        return "Branch format 8"
2090
1857
 
2091
 
    def initialize(self, a_bzrdir, name=None):
 
1858
    def initialize(self, a_bzrdir):
2092
1859
        """Create a branch of this format in a_bzrdir."""
2093
1860
        utf8_files = [('last-revision', '0 null:\n'),
2094
1861
                      ('branch.conf', ''),
2095
1862
                      ('tags', ''),
2096
1863
                      ('references', '')
2097
1864
                      ]
2098
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1865
        return self._initialize_helper(a_bzrdir, utf8_files)
2099
1866
 
2100
1867
    def __init__(self):
2101
1868
        super(BzrBranchFormat8, self).__init__()
2124
1891
    This format was introduced in bzr 1.6.
2125
1892
    """
2126
1893
 
2127
 
    def initialize(self, a_bzrdir, name=None):
 
1894
    def initialize(self, a_bzrdir):
2128
1895
        """Create a branch of this format in a_bzrdir."""
2129
1896
        utf8_files = [('last-revision', '0 null:\n'),
2130
1897
                      ('branch.conf', ''),
2131
1898
                      ('tags', ''),
2132
1899
                      ]
2133
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1900
        return self._initialize_helper(a_bzrdir, utf8_files)
2134
1901
 
2135
1902
    def _branch_class(self):
2136
1903
        return BzrBranch7
2171
1938
    def get_reference(self, a_bzrdir):
2172
1939
        """See BranchFormat.get_reference()."""
2173
1940
        transport = a_bzrdir.get_branch_transport(None)
2174
 
        return transport.get_bytes('location')
 
1941
        return transport.get('location').read()
2175
1942
 
2176
1943
    def set_reference(self, a_bzrdir, to_branch):
2177
1944
        """See BranchFormat.set_reference()."""
2178
1945
        transport = a_bzrdir.get_branch_transport(None)
2179
1946
        location = transport.put_bytes('location', to_branch.base)
2180
1947
 
2181
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1948
    def initialize(self, a_bzrdir, target_branch=None):
2182
1949
        """Create a branch of this format in a_bzrdir."""
2183
1950
        if target_branch is None:
2184
1951
            # this format does not implement branch itself, thus the implicit
2185
1952
            # creation contract must see it as uninitializable
2186
1953
            raise errors.UninitializableFormat(self)
2187
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2188
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1954
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1955
        branch_transport = a_bzrdir.get_branch_transport(self)
2189
1956
        branch_transport.put_bytes('location',
2190
 
            target_branch.bzrdir.user_url)
 
1957
            target_branch.bzrdir.root_transport.base)
2191
1958
        branch_transport.put_bytes('format', self.get_format_string())
2192
 
        branch = self.open(
2193
 
            a_bzrdir, name, _found=True,
 
1959
        return self.open(
 
1960
            a_bzrdir, _found=True,
2194
1961
            possible_transports=[target_branch.bzrdir.root_transport])
2195
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2196
 
        return branch
2197
1962
 
2198
1963
    def __init__(self):
2199
1964
        super(BranchReferenceFormat, self).__init__()
2205
1970
        def clone(to_bzrdir, revision_id=None,
2206
1971
            repository_policy=None):
2207
1972
            """See Branch.clone()."""
2208
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1973
            return format.initialize(to_bzrdir, a_branch)
2209
1974
            # cannot obey revision_id limits when cloning a reference ...
2210
1975
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2211
1976
            # emit some sort of warning/error to the caller ?!
2212
1977
        return clone
2213
1978
 
2214
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1979
    def open(self, a_bzrdir, _found=False, location=None,
2215
1980
             possible_transports=None, ignore_fallbacks=False):
2216
1981
        """Return the branch that the branch reference in a_bzrdir points at.
2217
1982
 
2218
1983
        :param a_bzrdir: A BzrDir that contains a branch.
2219
 
        :param name: Name of colocated branch to open, if any
2220
1984
        :param _found: a private parameter, do not use it. It is used to
2221
1985
            indicate if format probing has already be done.
2222
1986
        :param ignore_fallbacks: when set, no fallback branches will be opened
2227
1991
        :param possible_transports: An optional reusable transports list.
2228
1992
        """
2229
1993
        if not _found:
2230
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1994
            format = BranchFormat.find_format(a_bzrdir)
2231
1995
            if format.__class__ != self.__class__:
2232
1996
                raise AssertionError("wrong format %r found for %r" %
2233
1997
                    (format, self))
2235
1999
            location = self.get_reference(a_bzrdir)
2236
2000
        real_bzrdir = bzrdir.BzrDir.open(
2237
2001
            location, possible_transports=possible_transports)
2238
 
        result = real_bzrdir.open_branch(name=name, 
2239
 
            ignore_fallbacks=ignore_fallbacks)
 
2002
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2240
2003
        # this changes the behaviour of result.clone to create a new reference
2241
2004
        # rather than a copy of the content of the branch.
2242
2005
        # I did not use a proxy object because that needs much more extensive
2269
2032
BranchFormat.register_format(__format6)
2270
2033
BranchFormat.register_format(__format7)
2271
2034
BranchFormat.register_format(__format8)
2272
 
BranchFormat.set_default_format(__format7)
 
2035
BranchFormat.set_default_format(__format6)
2273
2036
_legacy_formats = [BzrBranchFormat4(),
2274
2037
    ]
2275
2038
network_format_registry.register(
2276
2039
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2277
2040
 
2278
2041
 
2279
 
class BranchWriteLockResult(object):
2280
 
    """The result of write locking a branch.
2281
 
 
2282
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2283
 
        None.
2284
 
    :ivar unlock: A callable which will unlock the lock.
2285
 
    """
2286
 
 
2287
 
    def __init__(self, unlock, branch_token):
2288
 
        self.branch_token = branch_token
2289
 
        self.unlock = unlock
2290
 
 
2291
 
 
2292
 
class BzrBranch(Branch, _RelockDebugMixin):
 
2042
class BzrBranch(Branch):
2293
2043
    """A branch stored in the actual filesystem.
2294
2044
 
2295
2045
    Note that it's "local" in the context of the filesystem; it doesn't
2301
2051
    :ivar repository: Repository for this branch.
2302
2052
    :ivar base: The url of the base directory for this branch; the one
2303
2053
        containing the .bzr directory.
2304
 
    :ivar name: Optional colocated branch name as it exists in the control
2305
 
        directory.
2306
2054
    """
2307
2055
 
2308
2056
    def __init__(self, _format=None,
2309
 
                 _control_files=None, a_bzrdir=None, name=None,
2310
 
                 _repository=None, ignore_fallbacks=False):
 
2057
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2058
                 ignore_fallbacks=False):
2311
2059
        """Create new branch object at a particular location."""
2312
2060
        if a_bzrdir is None:
2313
2061
            raise ValueError('a_bzrdir must be supplied')
2314
2062
        else:
2315
2063
            self.bzrdir = a_bzrdir
2316
2064
        self._base = self.bzrdir.transport.clone('..').base
2317
 
        self.name = name
2318
2065
        # XXX: We should be able to just do
2319
2066
        #   self.base = self.bzrdir.root_transport.base
2320
2067
        # but this does not quite work yet -- mbp 20080522
2327
2074
        Branch.__init__(self)
2328
2075
 
2329
2076
    def __str__(self):
2330
 
        if self.name is None:
2331
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2332
 
        else:
2333
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2334
 
                self.name)
 
2077
        return '%s(%r)' % (self.__class__.__name__, self.base)
2335
2078
 
2336
2079
    __repr__ = __str__
2337
2080
 
2348
2091
        return self.control_files.is_locked()
2349
2092
 
2350
2093
    def lock_write(self, token=None):
2351
 
        """Lock the branch for write operations.
2352
 
 
2353
 
        :param token: A token to permit reacquiring a previously held and
2354
 
            preserved lock.
2355
 
        :return: A BranchWriteLockResult.
2356
 
        """
2357
 
        if not self.is_locked():
2358
 
            self._note_lock('w')
2359
2094
        # All-in-one needs to always unlock/lock.
2360
2095
        repo_control = getattr(self.repository, 'control_files', None)
2361
2096
        if self.control_files == repo_control or not self.is_locked():
2362
 
            self.repository._warn_if_deprecated(self)
2363
2097
            self.repository.lock_write()
2364
2098
            took_lock = True
2365
2099
        else:
2366
2100
            took_lock = False
2367
2101
        try:
2368
 
            return BranchWriteLockResult(self.unlock,
2369
 
                self.control_files.lock_write(token=token))
 
2102
            return self.control_files.lock_write(token=token)
2370
2103
        except:
2371
2104
            if took_lock:
2372
2105
                self.repository.unlock()
2373
2106
            raise
2374
2107
 
2375
2108
    def lock_read(self):
2376
 
        """Lock the branch for read operations.
2377
 
 
2378
 
        :return: An object with an unlock method which will release the lock
2379
 
            obtained.
2380
 
        """
2381
 
        if not self.is_locked():
2382
 
            self._note_lock('r')
2383
2109
        # All-in-one needs to always unlock/lock.
2384
2110
        repo_control = getattr(self.repository, 'control_files', None)
2385
2111
        if self.control_files == repo_control or not self.is_locked():
2386
 
            self.repository._warn_if_deprecated(self)
2387
2112
            self.repository.lock_read()
2388
2113
            took_lock = True
2389
2114
        else:
2390
2115
            took_lock = False
2391
2116
        try:
2392
2117
            self.control_files.lock_read()
2393
 
            return self
2394
2118
        except:
2395
2119
            if took_lock:
2396
2120
                self.repository.unlock()
2397
2121
            raise
2398
2122
 
2399
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2400
2123
    def unlock(self):
2401
2124
        try:
2402
2125
            self.control_files.unlock()
2565
2288
        return result
2566
2289
 
2567
2290
    def get_stacked_on_url(self):
2568
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2291
        raise errors.UnstackableBranchFormat(self._format, self.base)
2569
2292
 
2570
2293
    def set_push_location(self, location):
2571
2294
        """See Branch.set_push_location."""
2761
2484
        if _mod_revision.is_null(last_revision):
2762
2485
            return
2763
2486
        if last_revision not in self._lefthand_history(revision_id):
2764
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2487
            raise errors.AppendRevisionsOnlyViolation(self.base)
2765
2488
 
2766
2489
    def _gen_revision_history(self):
2767
2490
        """Generate the revision history from last revision
2867
2590
        if branch_location is None:
2868
2591
            return Branch.reference_parent(self, file_id, path,
2869
2592
                                           possible_transports)
2870
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2593
        branch_location = urlutils.join(self.base, branch_location)
2871
2594
        return Branch.open(branch_location,
2872
2595
                           possible_transports=possible_transports)
2873
2596
 
2919
2642
        return stacked_url
2920
2643
 
2921
2644
    def _get_append_revisions_only(self):
2922
 
        return self.get_config(
2923
 
            ).get_user_option_as_bool('append_revisions_only')
 
2645
        value = self.get_config().get_user_option('append_revisions_only')
 
2646
        return value == 'True'
2924
2647
 
2925
2648
    @needs_write_lock
2926
2649
    def generate_revision_history(self, revision_id, last_rev=None,
2988
2711
    """
2989
2712
 
2990
2713
    def get_stacked_on_url(self):
2991
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2714
        raise errors.UnstackableBranchFormat(self._format, self.base)
2992
2715
 
2993
2716
 
2994
2717
######################################################################
3073
2796
 
3074
2797
    def __init__(self, branch):
3075
2798
        self.branch = branch
3076
 
        self.errors = []
 
2799
        self.ghosts_in_mainline = False
3077
2800
 
3078
2801
    def report_results(self, verbose):
3079
2802
        """Report the check results via trace.note.
3081
2804
        :param verbose: Requests more detailed display of what was checked,
3082
2805
            if any.
3083
2806
        """
3084
 
        note('checked branch %s format %s', self.branch.user_url,
3085
 
            self.branch._format)
3086
 
        for error in self.errors:
3087
 
            note('found error:%s', error)
 
2807
        note('checked branch %s format %s',
 
2808
             self.branch.base,
 
2809
             self.branch._format)
 
2810
        if self.ghosts_in_mainline:
 
2811
            note('branch contains ghosts in mainline')
3088
2812
 
3089
2813
 
3090
2814
class Converter5to6(object):
3185
2909
    @staticmethod
3186
2910
    def _get_branch_formats_to_test():
3187
2911
        """Return a tuple with the Branch formats to use when testing."""
3188
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
2912
        raise NotImplementedError(self._get_branch_formats_to_test)
3189
2913
 
3190
2914
    def pull(self, overwrite=False, stop_revision=None,
3191
2915
             possible_transports=None, local=False):
3346
3070
                _override_hook_source_branch=_override_hook_source_branch)
3347
3071
        finally:
3348
3072
            self.source.unlock()
 
3073
        return result
3349
3074
 
3350
3075
    def _push_with_bound_branches(self, overwrite, stop_revision,
3351
3076
            _override_hook_source_branch=None):
3416
3141
        if local and not bound_location:
3417
3142
            raise errors.LocalRequiresBoundBranch()
3418
3143
        master_branch = None
3419
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3144
        if not local and bound_location and self.source.base != bound_location:
3420
3145
            # not pulling from master, so we need to update master.
3421
3146
            master_branch = self.target.get_master_branch(possible_transports)
3422
3147
            master_branch.lock_write()