/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: Ian Clatworthy
  • Date: 2009-07-02 08:26:00 UTC
  • mto: (4527.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4529.
  • Revision ID: ian.clatworthy@canonical.com-20090702082600-qwb1evvvfa8ctnye
first draft of a 2.0 Upgrade Guide

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 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, LogicalLockResult
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: A bzrlib.lock.LogicalLockResult.
299
 
        """
300
284
        raise NotImplementedError(self.lock_read)
301
285
 
302
286
    def unlock(self):
427
411
            * 'include' - the stop revision is the last item in the result
428
412
            * 'with-merges' - include the stop revision and all of its
429
413
              merged revisions in the result
430
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
431
 
              that are in both ancestries
432
414
        :param direction: either 'reverse' or 'forward':
433
415
            * reverse means return the start_revision_id first, i.e.
434
416
              start at the most recent revision and go backwards in history
456
438
        # start_revision_id.
457
439
        if self._merge_sorted_revisions_cache is None:
458
440
            last_revision = self.last_revision()
459
 
            known_graph = self.repository.get_known_graph_ancestry(
460
 
                [last_revision])
461
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
462
 
                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
 
463
450
        filtered = self._filter_merge_sorted_revisions(
464
451
            self._merge_sorted_revisions_cache, start_revision_id,
465
452
            stop_revision_id, stop_rule)
466
 
        # Make sure we don't return revisions that are not part of the
467
 
        # start_revision_id ancestry.
468
 
        filtered = self._filter_start_non_ancestors(filtered)
469
453
        if direction == 'reverse':
470
454
            return filtered
471
455
        if direction == 'forward':
478
462
        """Iterate over an inclusive range of sorted revisions."""
479
463
        rev_iter = iter(merge_sorted_revisions)
480
464
        if start_revision_id is not None:
481
 
            for node in rev_iter:
482
 
                rev_id = node.key[-1]
 
465
            for rev_id, depth, revno, end_of_merge in rev_iter:
483
466
                if rev_id != start_revision_id:
484
467
                    continue
485
468
                else:
486
469
                    # The decision to include the start or not
487
470
                    # depends on the stop_rule if a stop is provided
488
 
                    # so pop this node back into the iterator
489
 
                    rev_iter = chain(iter([node]), rev_iter)
 
471
                    rev_iter = chain(
 
472
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
473
                        rev_iter)
490
474
                    break
491
475
        if stop_revision_id is None:
492
 
            # Yield everything
493
 
            for node in rev_iter:
494
 
                rev_id = node.key[-1]
495
 
                yield (rev_id, node.merge_depth, node.revno,
496
 
                       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
497
478
        elif stop_rule == 'exclude':
498
 
            for node in rev_iter:
499
 
                rev_id = node.key[-1]
 
479
            for rev_id, depth, revno, end_of_merge in rev_iter:
500
480
                if rev_id == stop_revision_id:
501
481
                    return
502
 
                yield (rev_id, node.merge_depth, node.revno,
503
 
                       node.end_of_merge)
 
482
                yield rev_id, depth, revno, end_of_merge
504
483
        elif stop_rule == 'include':
505
 
            for node in rev_iter:
506
 
                rev_id = node.key[-1]
507
 
                yield (rev_id, node.merge_depth, node.revno,
508
 
                       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
509
486
                if rev_id == stop_revision_id:
510
487
                    return
511
 
        elif stop_rule == 'with-merges-without-common-ancestry':
512
 
            # We want to exclude all revisions that are already part of the
513
 
            # stop_revision_id ancestry.
514
 
            graph = self.repository.get_graph()
515
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
516
 
                                                    [stop_revision_id])
517
 
            for node in rev_iter:
518
 
                rev_id = node.key[-1]
519
 
                if rev_id not in ancestors:
520
 
                    continue
521
 
                yield (rev_id, node.merge_depth, node.revno,
522
 
                       node.end_of_merge)
523
488
        elif stop_rule == 'with-merges':
524
489
            stop_rev = self.repository.get_revision(stop_revision_id)
525
490
            if stop_rev.parent_ids:
526
491
                left_parent = stop_rev.parent_ids[0]
527
492
            else:
528
493
                left_parent = _mod_revision.NULL_REVISION
529
 
            # left_parent is the actual revision we want to stop logging at,
530
 
            # since we want to show the merged revisions after the stop_rev too
531
 
            reached_stop_revision_id = False
532
 
            revision_id_whitelist = []
533
 
            for node in rev_iter:
534
 
                rev_id = node.key[-1]
 
494
            for rev_id, depth, revno, end_of_merge in rev_iter:
535
495
                if rev_id == left_parent:
536
 
                    # reached the left parent after the stop_revision
537
496
                    return
538
 
                if (not reached_stop_revision_id or
539
 
                        rev_id in revision_id_whitelist):
540
 
                    yield (rev_id, node.merge_depth, node.revno,
541
 
                       node.end_of_merge)
542
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
543
 
                        # only do the merged revs of rev_id from now on
544
 
                        rev = self.repository.get_revision(rev_id)
545
 
                        if rev.parent_ids:
546
 
                            reached_stop_revision_id = True
547
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
497
                yield rev_id, depth, revno, end_of_merge
548
498
        else:
549
499
            raise ValueError('invalid stop_rule %r' % stop_rule)
550
500
 
551
 
    def _filter_start_non_ancestors(self, rev_iter):
552
 
        # If we started from a dotted revno, we want to consider it as a tip
553
 
        # and don't want to yield revisions that are not part of its
554
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
555
 
        # uninteresting descendants of the first parent of our tip before the
556
 
        # tip itself.
557
 
        first = rev_iter.next()
558
 
        (rev_id, merge_depth, revno, end_of_merge) = first
559
 
        yield first
560
 
        if not merge_depth:
561
 
            # We start at a mainline revision so by definition, all others
562
 
            # revisions in rev_iter are ancestors
563
 
            for node in rev_iter:
564
 
                yield node
565
 
 
566
 
        clean = False
567
 
        whitelist = set()
568
 
        pmap = self.repository.get_parent_map([rev_id])
569
 
        parents = pmap.get(rev_id, [])
570
 
        if parents:
571
 
            whitelist.update(parents)
572
 
        else:
573
 
            # If there is no parents, there is nothing of interest left
574
 
 
575
 
            # FIXME: It's hard to test this scenario here as this code is never
576
 
            # called in that case. -- vila 20100322
577
 
            return
578
 
 
579
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
580
 
            if not clean:
581
 
                if rev_id in whitelist:
582
 
                    pmap = self.repository.get_parent_map([rev_id])
583
 
                    parents = pmap.get(rev_id, [])
584
 
                    whitelist.remove(rev_id)
585
 
                    whitelist.update(parents)
586
 
                    if merge_depth == 0:
587
 
                        # We've reached the mainline, there is nothing left to
588
 
                        # filter
589
 
                        clean = True
590
 
                else:
591
 
                    # A revision that is not part of the ancestry of our
592
 
                    # starting revision.
593
 
                    continue
594
 
            yield (rev_id, merge_depth, revno, end_of_merge)
595
 
 
596
501
    def leave_lock_in_place(self):
597
502
        """Tell this branch object not to release the physical lock when this
598
503
        object is unlocked.
615
520
        :param other: The branch to bind to
616
521
        :type other: Branch
617
522
        """
618
 
        raise errors.UpgradeRequired(self.user_url)
 
523
        raise errors.UpgradeRequired(self.base)
619
524
 
620
525
    def set_append_revisions_only(self, enabled):
621
526
        if not self._format.supports_set_append_revisions_only():
622
 
            raise errors.UpgradeRequired(self.user_url)
 
527
            raise errors.UpgradeRequired(self.base)
623
528
        if enabled:
624
529
            value = 'True'
625
530
        else:
673
578
    def get_old_bound_location(self):
674
579
        """Return the URL of the branch we used to be bound to
675
580
        """
676
 
        raise errors.UpgradeRequired(self.user_url)
 
581
        raise errors.UpgradeRequired(self.base)
677
582
 
678
583
    def get_commit_builder(self, parents, config=None, timestamp=None,
679
584
                           timezone=None, committer=None, revprops=None,
757
662
            stacking.
758
663
        """
759
664
        if not self._format.supports_stacking():
760
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
761
 
        # XXX: Changing from one fallback repository to another does not check
762
 
        # that all the data you need is present in the new fallback.
763
 
        # Possibly it should.
 
665
            raise errors.UnstackableBranchFormat(self._format, self.base)
764
666
        self._check_stackable_repo()
765
667
        if not url:
766
668
            try:
768
670
            except (errors.NotStacked, errors.UnstackableBranchFormat,
769
671
                errors.UnstackableRepositoryFormat):
770
672
                return
771
 
            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)
772
688
        else:
773
689
            self._activate_fallback_location(url)
774
690
        # write this out after the repository is stacked to avoid setting a
775
691
        # stacked config that doesn't work.
776
692
        self._set_config_location('stacked_on_location', url)
777
693
 
778
 
    def _unstack(self):
779
 
        """Change a branch to be unstacked, copying data as needed.
780
 
        
781
 
        Don't call this directly, use set_stacked_on_url(None).
782
 
        """
783
 
        pb = ui.ui_factory.nested_progress_bar()
784
 
        try:
785
 
            pb.update("Unstacking")
786
 
            # The basic approach here is to fetch the tip of the branch,
787
 
            # including all available ghosts, from the existing stacked
788
 
            # repository into a new repository object without the fallbacks. 
789
 
            #
790
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
791
 
            # correct for CHKMap repostiories
792
 
            old_repository = self.repository
793
 
            if len(old_repository._fallback_repositories) != 1:
794
 
                raise AssertionError("can't cope with fallback repositories "
795
 
                    "of %r" % (self.repository,))
796
 
            # unlock it, including unlocking the fallback
797
 
            old_repository.unlock()
798
 
            old_repository.lock_read()
799
 
            try:
800
 
                # Repositories don't offer an interface to remove fallback
801
 
                # repositories today; take the conceptually simpler option and just
802
 
                # reopen it.  We reopen it starting from the URL so that we
803
 
                # get a separate connection for RemoteRepositories and can
804
 
                # stream from one of them to the other.  This does mean doing
805
 
                # separate SSH connection setup, but unstacking is not a
806
 
                # common operation so it's tolerable.
807
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
808
 
                new_repository = new_bzrdir.find_repository()
809
 
                self.repository = new_repository
810
 
                if self.repository._fallback_repositories:
811
 
                    raise AssertionError("didn't expect %r to have "
812
 
                        "fallback_repositories"
813
 
                        % (self.repository,))
814
 
                # this is not paired with an unlock because it's just restoring
815
 
                # the previous state; the lock's released when set_stacked_on_url
816
 
                # returns
817
 
                self.repository.lock_write()
818
 
                # XXX: If you unstack a branch while it has a working tree
819
 
                # with a pending merge, the pending-merged revisions will no
820
 
                # longer be present.  You can (probably) revert and remerge.
821
 
                #
822
 
                # XXX: This only fetches up to the tip of the repository; it
823
 
                # doesn't bring across any tags.  That's fairly consistent
824
 
                # with how branch works, but perhaps not ideal.
825
 
                self.repository.fetch(old_repository,
826
 
                    revision_id=self.last_revision(),
827
 
                    find_ghosts=True)
828
 
            finally:
829
 
                old_repository.unlock()
830
 
        finally:
831
 
            pb.finished()
832
694
 
833
695
    def _set_tags_bytes(self, bytes):
834
696
        """Mirror method for _get_tags_bytes.
914
776
 
915
777
    def unbind(self):
916
778
        """Older format branches cannot bind or unbind."""
917
 
        raise errors.UpgradeRequired(self.user_url)
 
779
        raise errors.UpgradeRequired(self.base)
918
780
 
919
781
    def last_revision(self):
920
782
        """Return last revision id, or NULL_REVISION."""
1080
942
        try:
1081
943
            return urlutils.join(self.base[:-1], parent)
1082
944
        except errors.InvalidURLJoin, e:
1083
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
945
            raise errors.InaccessibleParent(parent, self.base)
1084
946
 
1085
947
    def _get_parent_location(self):
1086
948
        raise NotImplementedError(self._get_parent_location)
1171
1033
        params = ChangeBranchTipParams(
1172
1034
            self, old_revno, new_revno, old_revid, new_revid)
1173
1035
        for hook in hooks:
1174
 
            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)
1175
1045
 
1176
1046
    @needs_write_lock
1177
1047
    def update(self):
1226
1096
        revision_id: if not None, the revision history in the new branch will
1227
1097
                     be truncated to end with revision_id.
1228
1098
        """
1229
 
        if (repository_policy is not None and
1230
 
            repository_policy.requires_stacking()):
1231
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1232
1099
        result = to_bzrdir.create_branch()
1233
1100
        result.lock_write()
1234
1101
        try:
1302
1169
        target._set_all_reference_info(target_reference_dict)
1303
1170
 
1304
1171
    @needs_read_lock
1305
 
    def check(self, refs):
 
1172
    def check(self):
1306
1173
        """Check consistency of the branch.
1307
1174
 
1308
1175
        In particular this checks that revisions given in the revision-history
1311
1178
 
1312
1179
        Callers will typically also want to check the repository.
1313
1180
 
1314
 
        :param refs: Calculated refs for this branch as specified by
1315
 
            branch._get_check_refs()
1316
1181
        :return: A BranchCheckResult.
1317
1182
        """
1318
 
        result = BranchCheckResult(self)
 
1183
        ret = BranchCheckResult(self)
 
1184
        mainline_parent_id = None
1319
1185
        last_revno, last_revision_id = self.last_revision_info()
1320
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1321
 
        if actual_revno != last_revno:
1322
 
            result.errors.append(errors.BzrCheckError(
1323
 
                'revno does not match len(mainline) %s != %s' % (
1324
 
                last_revno, actual_revno)))
1325
 
        # TODO: We should probably also check that self.revision_history
1326
 
        # matches the repository for older branch formats.
1327
 
        # If looking for the code that cross-checks repository parents against
1328
 
        # the iter_reverse_revision_history output, that is now a repository
1329
 
        # specific check.
1330
 
        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
1331
1217
 
1332
1218
    def _get_checkout_format(self):
1333
1219
        """Return the most suitable metadir for a checkout of this branch.
1356
1242
        """
1357
1243
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1358
1244
        # clone call. Or something. 20090224 RBC/spiv.
1359
 
        # XXX: Should this perhaps clone colocated branches as well, 
1360
 
        # rather than just the default branch? 20100319 JRV
1361
1245
        if revision_id is None:
1362
1246
            revision_id = self.last_revision()
1363
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1364
 
            revision_id=revision_id, stacked_on=stacked_on,
1365
 
            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
1366
1257
        return dir_to.open_branch()
1367
1258
 
1368
1259
    def create_checkout(self, to_location, revision_id=None,
1387
1278
        if lightweight:
1388
1279
            format = self._get_checkout_format()
1389
1280
            checkout = format.initialize_on_transport(t)
1390
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1391
 
                target_branch=self)
 
1281
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1392
1282
        else:
1393
1283
            format = self._get_checkout_format()
1394
1284
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1436
1326
    def supports_tags(self):
1437
1327
        return self._format.supports_tags()
1438
1328
 
1439
 
    def automatic_tag_name(self, revision_id):
1440
 
        """Try to automatically find the tag name for a revision.
1441
 
 
1442
 
        :param revision_id: Revision id of the revision.
1443
 
        :return: A tag name or None if no tag name could be determined.
1444
 
        """
1445
 
        for hook in Branch.hooks['automatic_tag_name']:
1446
 
            ret = hook(self, revision_id)
1447
 
            if ret is not None:
1448
 
                return ret
1449
 
        return None
1450
 
 
1451
1329
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1452
1330
                                         other_branch):
1453
1331
        """Ensure that revision_b is a descendant of revision_a.
1517
1395
        return not (self == other)
1518
1396
 
1519
1397
    @classmethod
1520
 
    def find_format(klass, a_bzrdir, name=None):
 
1398
    def find_format(klass, a_bzrdir):
1521
1399
        """Return the format for the branch object in a_bzrdir."""
1522
1400
        try:
1523
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1524
 
            format_string = transport.get_bytes("format")
 
1401
            transport = a_bzrdir.get_branch_transport(None)
 
1402
            format_string = transport.get("format").read()
1525
1403
            return klass._formats[format_string]
1526
1404
        except errors.NoSuchFile:
1527
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1405
            raise errors.NotBranchError(path=transport.base)
1528
1406
        except KeyError:
1529
1407
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1530
1408
 
1533
1411
        """Return the current default format."""
1534
1412
        return klass._default_format
1535
1413
 
1536
 
    def get_reference(self, a_bzrdir, name=None):
 
1414
    def get_reference(self, a_bzrdir):
1537
1415
        """Get the target reference of the branch in a_bzrdir.
1538
1416
 
1539
1417
        format probing must have been completed before calling
1541
1419
        in a_bzrdir is correct.
1542
1420
 
1543
1421
        :param a_bzrdir: The bzrdir to get the branch data from.
1544
 
        :param name: Name of the colocated branch to fetch
1545
1422
        :return: None if the branch is not a reference branch.
1546
1423
        """
1547
1424
        return None
1548
1425
 
1549
1426
    @classmethod
1550
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1427
    def set_reference(self, a_bzrdir, to_branch):
1551
1428
        """Set the target reference of the branch in a_bzrdir.
1552
1429
 
1553
1430
        format probing must have been completed before calling
1555
1432
        in a_bzrdir is correct.
1556
1433
 
1557
1434
        :param a_bzrdir: The bzrdir to set the branch reference for.
1558
 
        :param name: Name of colocated branch to set, None for default
1559
1435
        :param to_branch: branch that the checkout is to reference
1560
1436
        """
1561
1437
        raise NotImplementedError(self.set_reference)
1568
1444
        """Return the short format description for this format."""
1569
1445
        raise NotImplementedError(self.get_format_description)
1570
1446
 
1571
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1572
 
        hooks = Branch.hooks['post_branch_init']
1573
 
        if not hooks:
1574
 
            return
1575
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1576
 
        for hook in hooks:
1577
 
            hook(params)
1578
 
 
1579
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1580
 
                           lock_type='metadir', set_format=True):
 
1447
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1448
                           set_format=True):
1581
1449
        """Initialize a branch in a bzrdir, with specified files
1582
1450
 
1583
1451
        :param a_bzrdir: The bzrdir to initialize the branch in
1584
1452
        :param utf8_files: The files to create as a list of
1585
1453
            (filename, content) tuples
1586
 
        :param name: Name of colocated branch to create, if any
1587
1454
        :param set_format: If True, set the format with
1588
1455
            self.get_format_string.  (BzrBranch4 has its format set
1589
1456
            elsewhere)
1590
1457
        :return: a branch in this format
1591
1458
        """
1592
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1593
 
        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)
1594
1461
        lock_map = {
1595
1462
            'metadir': ('lock', lockdir.LockDir),
1596
1463
            'branch4': ('branch-lock', lockable_files.TransportLock),
1617
1484
        finally:
1618
1485
            if lock_taken:
1619
1486
                control_files.unlock()
1620
 
        branch = self.open(a_bzrdir, name, _found=True)
1621
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1622
 
        return branch
 
1487
        return self.open(a_bzrdir, _found=True)
1623
1488
 
1624
 
    def initialize(self, a_bzrdir, name=None):
1625
 
        """Create a branch of this format in a_bzrdir.
1626
 
        
1627
 
        :param name: Name of the colocated branch to create.
1628
 
        """
 
1489
    def initialize(self, a_bzrdir):
 
1490
        """Create a branch of this format in a_bzrdir."""
1629
1491
        raise NotImplementedError(self.initialize)
1630
1492
 
1631
1493
    def is_supported(self):
1661
1523
        """
1662
1524
        raise NotImplementedError(self.network_name)
1663
1525
 
1664
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1526
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1665
1527
        """Return the branch object for a_bzrdir
1666
1528
 
1667
1529
        :param a_bzrdir: A BzrDir that contains a branch.
1668
 
        :param name: Name of colocated branch to open
1669
1530
        :param _found: a private parameter, do not use it. It is used to
1670
1531
            indicate if format probing has already be done.
1671
1532
        :param ignore_fallbacks: when set, no fallback branches will be opened
1779
1640
            "multiple hooks installed for transform_fallback_location, "
1780
1641
            "all are called with the url returned from the previous hook."
1781
1642
            "The order is however undefined.", (1, 9), None))
1782
 
        self.create_hook(HookPoint('automatic_tag_name',
1783
 
            "Called to determine an automatic tag name for a revision."
1784
 
            "automatic_tag_name is called with (branch, revision_id) and "
1785
 
            "should return a tag name or None if no tag name could be "
1786
 
            "determined. The first non-None tag name returned will be used.",
1787
 
            (2, 2), None))
1788
 
        self.create_hook(HookPoint('post_branch_init',
1789
 
            "Called after new branch initialization completes. "
1790
 
            "post_branch_init is called with a "
1791
 
            "bzrlib.branch.BranchInitHookParams. "
1792
 
            "Note that init, branch and checkout (both heavyweight and "
1793
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1794
 
        self.create_hook(HookPoint('post_switch',
1795
 
            "Called after a checkout switches branch. "
1796
 
            "post_switch is called with a "
1797
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1798
 
 
1799
1643
 
1800
1644
 
1801
1645
# install the default hooks into the Branch class.
1840
1684
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1841
1685
 
1842
1686
 
1843
 
class BranchInitHookParams(object):
1844
 
    """Object holding parameters passed to *_branch_init hooks.
1845
 
 
1846
 
    There are 4 fields that hooks may wish to access:
1847
 
 
1848
 
    :ivar format: the branch format
1849
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1850
 
    :ivar name: name of colocated branch, if any (or None)
1851
 
    :ivar branch: the branch created
1852
 
 
1853
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1854
 
    the checkout, hence they are different from the corresponding fields in
1855
 
    branch, which refer to the original branch.
1856
 
    """
1857
 
 
1858
 
    def __init__(self, format, a_bzrdir, name, branch):
1859
 
        """Create a group of BranchInitHook parameters.
1860
 
 
1861
 
        :param format: the branch format
1862
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1863
 
            initialized
1864
 
        :param name: name of colocated branch, if any (or None)
1865
 
        :param branch: the branch created
1866
 
 
1867
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1868
 
        to the checkout, hence they are different from the corresponding fields
1869
 
        in branch, which refer to the original branch.
1870
 
        """
1871
 
        self.format = format
1872
 
        self.bzrdir = a_bzrdir
1873
 
        self.name = name
1874
 
        self.branch = branch
1875
 
 
1876
 
    def __eq__(self, other):
1877
 
        return self.__dict__ == other.__dict__
1878
 
 
1879
 
    def __repr__(self):
1880
 
        if self.branch:
1881
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1882
 
        else:
1883
 
            return "<%s of format:%s bzrdir:%s>" % (
1884
 
                self.__class__.__name__, self.branch,
1885
 
                self.format, self.bzrdir)
1886
 
 
1887
 
 
1888
 
class SwitchHookParams(object):
1889
 
    """Object holding parameters passed to *_switch hooks.
1890
 
 
1891
 
    There are 4 fields that hooks may wish to access:
1892
 
 
1893
 
    :ivar control_dir: BzrDir of the checkout to change
1894
 
    :ivar to_branch: branch that the checkout is to reference
1895
 
    :ivar force: skip the check for local commits in a heavy checkout
1896
 
    :ivar revision_id: revision ID to switch to (or None)
1897
 
    """
1898
 
 
1899
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1900
 
        """Create a group of SwitchHook parameters.
1901
 
 
1902
 
        :param control_dir: BzrDir of the checkout to change
1903
 
        :param to_branch: branch that the checkout is to reference
1904
 
        :param force: skip the check for local commits in a heavy checkout
1905
 
        :param revision_id: revision ID to switch to (or None)
1906
 
        """
1907
 
        self.control_dir = control_dir
1908
 
        self.to_branch = to_branch
1909
 
        self.force = force
1910
 
        self.revision_id = revision_id
1911
 
 
1912
 
    def __eq__(self, other):
1913
 
        return self.__dict__ == other.__dict__
1914
 
 
1915
 
    def __repr__(self):
1916
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1917
 
            self.control_dir, self.to_branch,
1918
 
            self.revision_id)
1919
 
 
1920
 
 
1921
1687
class BzrBranchFormat4(BranchFormat):
1922
1688
    """Bzr branch format 4.
1923
1689
 
1930
1696
        """See BranchFormat.get_format_description()."""
1931
1697
        return "Branch format 4"
1932
1698
 
1933
 
    def initialize(self, a_bzrdir, name=None):
 
1699
    def initialize(self, a_bzrdir):
1934
1700
        """Create a branch of this format in a_bzrdir."""
1935
1701
        utf8_files = [('revision-history', ''),
1936
1702
                      ('branch-name', ''),
1937
1703
                      ]
1938
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1704
        return self._initialize_helper(a_bzrdir, utf8_files,
1939
1705
                                       lock_type='branch4', set_format=False)
1940
1706
 
1941
1707
    def __init__(self):
1946
1712
        """The network name for this format is the control dirs disk label."""
1947
1713
        return self._matchingbzrdir.get_format_string()
1948
1714
 
1949
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1715
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1950
1716
        """See BranchFormat.open()."""
1951
1717
        if not _found:
1952
1718
            # we are being called directly and must probe.
1954
1720
        return BzrBranch(_format=self,
1955
1721
                         _control_files=a_bzrdir._control_files,
1956
1722
                         a_bzrdir=a_bzrdir,
1957
 
                         name=name,
1958
1723
                         _repository=a_bzrdir.open_repository())
1959
1724
 
1960
1725
    def __str__(self):
1975
1740
        """
1976
1741
        return self.get_format_string()
1977
1742
 
1978
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1743
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1979
1744
        """See BranchFormat.open()."""
1980
1745
        if not _found:
1981
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1746
            format = BranchFormat.find_format(a_bzrdir)
1982
1747
            if format.__class__ != self.__class__:
1983
1748
                raise AssertionError("wrong format %r found for %r" %
1984
1749
                    (format, self))
1985
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1986
1750
        try:
 
1751
            transport = a_bzrdir.get_branch_transport(None)
1987
1752
            control_files = lockable_files.LockableFiles(transport, 'lock',
1988
1753
                                                         lockdir.LockDir)
1989
1754
            return self._branch_class()(_format=self,
1990
1755
                              _control_files=control_files,
1991
 
                              name=name,
1992
1756
                              a_bzrdir=a_bzrdir,
1993
1757
                              _repository=a_bzrdir.find_repository(),
1994
1758
                              ignore_fallbacks=ignore_fallbacks)
1995
1759
        except errors.NoSuchFile:
1996
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1760
            raise errors.NotBranchError(path=transport.base)
1997
1761
 
1998
1762
    def __init__(self):
1999
1763
        super(BranchFormatMetadir, self).__init__()
2028
1792
        """See BranchFormat.get_format_description()."""
2029
1793
        return "Branch format 5"
2030
1794
 
2031
 
    def initialize(self, a_bzrdir, name=None):
 
1795
    def initialize(self, a_bzrdir):
2032
1796
        """Create a branch of this format in a_bzrdir."""
2033
1797
        utf8_files = [('revision-history', ''),
2034
1798
                      ('branch-name', ''),
2035
1799
                      ]
2036
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1800
        return self._initialize_helper(a_bzrdir, utf8_files)
2037
1801
 
2038
1802
    def supports_tags(self):
2039
1803
        return False
2061
1825
        """See BranchFormat.get_format_description()."""
2062
1826
        return "Branch format 6"
2063
1827
 
2064
 
    def initialize(self, a_bzrdir, name=None):
 
1828
    def initialize(self, a_bzrdir):
2065
1829
        """Create a branch of this format in a_bzrdir."""
2066
1830
        utf8_files = [('last-revision', '0 null:\n'),
2067
1831
                      ('branch.conf', ''),
2068
1832
                      ('tags', ''),
2069
1833
                      ]
2070
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1834
        return self._initialize_helper(a_bzrdir, utf8_files)
2071
1835
 
2072
1836
    def make_tags(self, branch):
2073
1837
        """See bzrlib.branch.BranchFormat.make_tags()."""
2091
1855
        """See BranchFormat.get_format_description()."""
2092
1856
        return "Branch format 8"
2093
1857
 
2094
 
    def initialize(self, a_bzrdir, name=None):
 
1858
    def initialize(self, a_bzrdir):
2095
1859
        """Create a branch of this format in a_bzrdir."""
2096
1860
        utf8_files = [('last-revision', '0 null:\n'),
2097
1861
                      ('branch.conf', ''),
2098
1862
                      ('tags', ''),
2099
1863
                      ('references', '')
2100
1864
                      ]
2101
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1865
        return self._initialize_helper(a_bzrdir, utf8_files)
2102
1866
 
2103
1867
    def __init__(self):
2104
1868
        super(BzrBranchFormat8, self).__init__()
2127
1891
    This format was introduced in bzr 1.6.
2128
1892
    """
2129
1893
 
2130
 
    def initialize(self, a_bzrdir, name=None):
 
1894
    def initialize(self, a_bzrdir):
2131
1895
        """Create a branch of this format in a_bzrdir."""
2132
1896
        utf8_files = [('last-revision', '0 null:\n'),
2133
1897
                      ('branch.conf', ''),
2134
1898
                      ('tags', ''),
2135
1899
                      ]
2136
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1900
        return self._initialize_helper(a_bzrdir, utf8_files)
2137
1901
 
2138
1902
    def _branch_class(self):
2139
1903
        return BzrBranch7
2171
1935
        """See BranchFormat.get_format_description()."""
2172
1936
        return "Checkout reference format 1"
2173
1937
 
2174
 
    def get_reference(self, a_bzrdir, name=None):
 
1938
    def get_reference(self, a_bzrdir):
2175
1939
        """See BranchFormat.get_reference()."""
2176
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2177
 
        return transport.get_bytes('location')
 
1940
        transport = a_bzrdir.get_branch_transport(None)
 
1941
        return transport.get('location').read()
2178
1942
 
2179
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1943
    def set_reference(self, a_bzrdir, to_branch):
2180
1944
        """See BranchFormat.set_reference()."""
2181
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1945
        transport = a_bzrdir.get_branch_transport(None)
2182
1946
        location = transport.put_bytes('location', to_branch.base)
2183
1947
 
2184
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1948
    def initialize(self, a_bzrdir, target_branch=None):
2185
1949
        """Create a branch of this format in a_bzrdir."""
2186
1950
        if target_branch is None:
2187
1951
            # this format does not implement branch itself, thus the implicit
2188
1952
            # creation contract must see it as uninitializable
2189
1953
            raise errors.UninitializableFormat(self)
2190
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2191
 
        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)
2192
1956
        branch_transport.put_bytes('location',
2193
 
            target_branch.bzrdir.user_url)
 
1957
            target_branch.bzrdir.root_transport.base)
2194
1958
        branch_transport.put_bytes('format', self.get_format_string())
2195
 
        branch = self.open(
2196
 
            a_bzrdir, name, _found=True,
 
1959
        return self.open(
 
1960
            a_bzrdir, _found=True,
2197
1961
            possible_transports=[target_branch.bzrdir.root_transport])
2198
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2199
 
        return branch
2200
1962
 
2201
1963
    def __init__(self):
2202
1964
        super(BranchReferenceFormat, self).__init__()
2208
1970
        def clone(to_bzrdir, revision_id=None,
2209
1971
            repository_policy=None):
2210
1972
            """See Branch.clone()."""
2211
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1973
            return format.initialize(to_bzrdir, a_branch)
2212
1974
            # cannot obey revision_id limits when cloning a reference ...
2213
1975
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2214
1976
            # emit some sort of warning/error to the caller ?!
2215
1977
        return clone
2216
1978
 
2217
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1979
    def open(self, a_bzrdir, _found=False, location=None,
2218
1980
             possible_transports=None, ignore_fallbacks=False):
2219
1981
        """Return the branch that the branch reference in a_bzrdir points at.
2220
1982
 
2221
1983
        :param a_bzrdir: A BzrDir that contains a branch.
2222
 
        :param name: Name of colocated branch to open, if any
2223
1984
        :param _found: a private parameter, do not use it. It is used to
2224
1985
            indicate if format probing has already be done.
2225
1986
        :param ignore_fallbacks: when set, no fallback branches will be opened
2230
1991
        :param possible_transports: An optional reusable transports list.
2231
1992
        """
2232
1993
        if not _found:
2233
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1994
            format = BranchFormat.find_format(a_bzrdir)
2234
1995
            if format.__class__ != self.__class__:
2235
1996
                raise AssertionError("wrong format %r found for %r" %
2236
1997
                    (format, self))
2237
1998
        if location is None:
2238
 
            location = self.get_reference(a_bzrdir, name)
 
1999
            location = self.get_reference(a_bzrdir)
2239
2000
        real_bzrdir = bzrdir.BzrDir.open(
2240
2001
            location, possible_transports=possible_transports)
2241
 
        result = real_bzrdir.open_branch(name=name, 
2242
 
            ignore_fallbacks=ignore_fallbacks)
 
2002
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2243
2003
        # this changes the behaviour of result.clone to create a new reference
2244
2004
        # rather than a copy of the content of the branch.
2245
2005
        # I did not use a proxy object because that needs much more extensive
2272
2032
BranchFormat.register_format(__format6)
2273
2033
BranchFormat.register_format(__format7)
2274
2034
BranchFormat.register_format(__format8)
2275
 
BranchFormat.set_default_format(__format7)
 
2035
BranchFormat.set_default_format(__format6)
2276
2036
_legacy_formats = [BzrBranchFormat4(),
2277
2037
    ]
2278
2038
network_format_registry.register(
2279
2039
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2280
2040
 
2281
2041
 
2282
 
class BranchWriteLockResult(LogicalLockResult):
2283
 
    """The result of write locking a branch.
2284
 
 
2285
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2286
 
        None.
2287
 
    :ivar unlock: A callable which will unlock the lock.
2288
 
    """
2289
 
 
2290
 
    def __init__(self, unlock, branch_token):
2291
 
        LogicalLockResult.__init__(self, unlock)
2292
 
        self.branch_token = branch_token
2293
 
 
2294
 
    def __repr__(self):
2295
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2296
 
            self.unlock)
2297
 
 
2298
 
 
2299
 
class BzrBranch(Branch, _RelockDebugMixin):
 
2042
class BzrBranch(Branch):
2300
2043
    """A branch stored in the actual filesystem.
2301
2044
 
2302
2045
    Note that it's "local" in the context of the filesystem; it doesn't
2308
2051
    :ivar repository: Repository for this branch.
2309
2052
    :ivar base: The url of the base directory for this branch; the one
2310
2053
        containing the .bzr directory.
2311
 
    :ivar name: Optional colocated branch name as it exists in the control
2312
 
        directory.
2313
2054
    """
2314
2055
 
2315
2056
    def __init__(self, _format=None,
2316
 
                 _control_files=None, a_bzrdir=None, name=None,
2317
 
                 _repository=None, ignore_fallbacks=False):
 
2057
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2058
                 ignore_fallbacks=False):
2318
2059
        """Create new branch object at a particular location."""
2319
2060
        if a_bzrdir is None:
2320
2061
            raise ValueError('a_bzrdir must be supplied')
2321
2062
        else:
2322
2063
            self.bzrdir = a_bzrdir
2323
2064
        self._base = self.bzrdir.transport.clone('..').base
2324
 
        self.name = name
2325
2065
        # XXX: We should be able to just do
2326
2066
        #   self.base = self.bzrdir.root_transport.base
2327
2067
        # but this does not quite work yet -- mbp 20080522
2334
2074
        Branch.__init__(self)
2335
2075
 
2336
2076
    def __str__(self):
2337
 
        if self.name is None:
2338
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2339
 
        else:
2340
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2341
 
                self.name)
 
2077
        return '%s(%r)' % (self.__class__.__name__, self.base)
2342
2078
 
2343
2079
    __repr__ = __str__
2344
2080
 
2355
2091
        return self.control_files.is_locked()
2356
2092
 
2357
2093
    def lock_write(self, token=None):
2358
 
        """Lock the branch for write operations.
2359
 
 
2360
 
        :param token: A token to permit reacquiring a previously held and
2361
 
            preserved lock.
2362
 
        :return: A BranchWriteLockResult.
2363
 
        """
2364
 
        if not self.is_locked():
2365
 
            self._note_lock('w')
2366
2094
        # All-in-one needs to always unlock/lock.
2367
2095
        repo_control = getattr(self.repository, 'control_files', None)
2368
2096
        if self.control_files == repo_control or not self.is_locked():
2369
 
            self.repository._warn_if_deprecated(self)
2370
2097
            self.repository.lock_write()
2371
2098
            took_lock = True
2372
2099
        else:
2373
2100
            took_lock = False
2374
2101
        try:
2375
 
            return BranchWriteLockResult(self.unlock,
2376
 
                self.control_files.lock_write(token=token))
 
2102
            return self.control_files.lock_write(token=token)
2377
2103
        except:
2378
2104
            if took_lock:
2379
2105
                self.repository.unlock()
2380
2106
            raise
2381
2107
 
2382
2108
    def lock_read(self):
2383
 
        """Lock the branch for read operations.
2384
 
 
2385
 
        :return: A bzrlib.lock.LogicalLockResult.
2386
 
        """
2387
 
        if not self.is_locked():
2388
 
            self._note_lock('r')
2389
2109
        # All-in-one needs to always unlock/lock.
2390
2110
        repo_control = getattr(self.repository, 'control_files', None)
2391
2111
        if self.control_files == repo_control or not self.is_locked():
2392
 
            self.repository._warn_if_deprecated(self)
2393
2112
            self.repository.lock_read()
2394
2113
            took_lock = True
2395
2114
        else:
2396
2115
            took_lock = False
2397
2116
        try:
2398
2117
            self.control_files.lock_read()
2399
 
            return LogicalLockResult(self.unlock)
2400
2118
        except:
2401
2119
            if took_lock:
2402
2120
                self.repository.unlock()
2403
2121
            raise
2404
2122
 
2405
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2406
2123
    def unlock(self):
2407
2124
        try:
2408
2125
            self.control_files.unlock()
2571
2288
        return result
2572
2289
 
2573
2290
    def get_stacked_on_url(self):
2574
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2291
        raise errors.UnstackableBranchFormat(self._format, self.base)
2575
2292
 
2576
2293
    def set_push_location(self, location):
2577
2294
        """See Branch.set_push_location."""
2767
2484
        if _mod_revision.is_null(last_revision):
2768
2485
            return
2769
2486
        if last_revision not in self._lefthand_history(revision_id):
2770
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2487
            raise errors.AppendRevisionsOnlyViolation(self.base)
2771
2488
 
2772
2489
    def _gen_revision_history(self):
2773
2490
        """Generate the revision history from last revision
2873
2590
        if branch_location is None:
2874
2591
            return Branch.reference_parent(self, file_id, path,
2875
2592
                                           possible_transports)
2876
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2593
        branch_location = urlutils.join(self.base, branch_location)
2877
2594
        return Branch.open(branch_location,
2878
2595
                           possible_transports=possible_transports)
2879
2596
 
2925
2642
        return stacked_url
2926
2643
 
2927
2644
    def _get_append_revisions_only(self):
2928
 
        return self.get_config(
2929
 
            ).get_user_option_as_bool('append_revisions_only')
 
2645
        value = self.get_config().get_user_option('append_revisions_only')
 
2646
        return value == 'True'
2930
2647
 
2931
2648
    @needs_write_lock
2932
2649
    def generate_revision_history(self, revision_id, last_rev=None,
2994
2711
    """
2995
2712
 
2996
2713
    def get_stacked_on_url(self):
2997
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2714
        raise errors.UnstackableBranchFormat(self._format, self.base)
2998
2715
 
2999
2716
 
3000
2717
######################################################################
3079
2796
 
3080
2797
    def __init__(self, branch):
3081
2798
        self.branch = branch
3082
 
        self.errors = []
 
2799
        self.ghosts_in_mainline = False
3083
2800
 
3084
2801
    def report_results(self, verbose):
3085
2802
        """Report the check results via trace.note.
3087
2804
        :param verbose: Requests more detailed display of what was checked,
3088
2805
            if any.
3089
2806
        """
3090
 
        note('checked branch %s format %s', self.branch.user_url,
3091
 
            self.branch._format)
3092
 
        for error in self.errors:
3093
 
            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')
3094
2812
 
3095
2813
 
3096
2814
class Converter5to6(object):
3191
2909
    @staticmethod
3192
2910
    def _get_branch_formats_to_test():
3193
2911
        """Return a tuple with the Branch formats to use when testing."""
3194
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
2912
        raise NotImplementedError(self._get_branch_formats_to_test)
3195
2913
 
3196
2914
    def pull(self, overwrite=False, stop_revision=None,
3197
2915
             possible_transports=None, local=False):
3352
3070
                _override_hook_source_branch=_override_hook_source_branch)
3353
3071
        finally:
3354
3072
            self.source.unlock()
 
3073
        return result
3355
3074
 
3356
3075
    def _push_with_bound_branches(self, overwrite, stop_revision,
3357
3076
            _override_hook_source_branch=None):
3422
3141
        if local and not bound_location:
3423
3142
            raise errors.LocalRequiresBoundBranch()
3424
3143
        master_branch = None
3425
 
        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:
3426
3145
            # not pulling from master, so we need to update master.
3427
3146
            master_branch = self.target.get_master_branch(possible_transports)
3428
3147
            master_branch.lock_write()