/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-13 06:58:49 UTC
  • mto: (4527.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4529.
  • Revision ID: ian.clatworthy@canonical.com-20090713065849-n7g2rsjyl6dt1mgv
Apply review feedback

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
35
35
        symbol_versioning,
36
36
        transport,
37
37
        tsort,
38
 
        ui,
39
38
        urlutils,
40
39
        )
41
40
from bzrlib.config import BranchConfig, TransportConfig
46
45
    )
47
46
""")
48
47
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
48
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
49
from bzrlib.hooks import HookPoint, Hooks
51
50
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
51
from bzrlib import registry
54
52
from bzrlib.symbol_versioning import (
55
53
    deprecated_in,
63
61
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
62
 
65
63
 
66
 
class Branch(bzrdir.ControlComponent):
 
64
# TODO: Maybe include checks for common corruption of newlines, etc?
 
65
 
 
66
# TODO: Some operations like log might retrieve the same revisions
 
67
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
68
# cache in memory to make this faster.  In general anything can be
 
69
# cached in memory between lock and unlock operations. .. nb thats
 
70
# what the transaction identity map provides
 
71
 
 
72
 
 
73
######################################################################
 
74
# branch objects
 
75
 
 
76
class Branch(object):
67
77
    """Branch holding a history of revisions.
68
78
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
79
    base
 
80
        Base directory/url of the branch.
72
81
 
73
82
    hooks: An instance of BranchHooks.
74
83
    """
76
85
    # - RBC 20060112
77
86
    base = None
78
87
 
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
88
    def __init__(self, *ignored, **ignored_too):
88
89
        self.tags = self._format.make_tags(self)
89
90
        self._revision_history_cache = None
104
105
        """Activate the branch/repository from url as a fallback repository."""
105
106
        repo = self._get_fallback_repository(url)
106
107
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
108
            raise errors.UnstackableLocationError(self.base, url)
108
109
        self.repository.add_fallback_repository(repo)
109
110
 
110
111
    def break_lock(self):
147
148
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
149
            self._partial_revision_history_cache.pop()
149
150
 
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
151
    @staticmethod
159
152
    def open(base, _unsupported=False, possible_transports=None):
160
153
        """Open the branch rooted at base.
164
157
        """
165
158
        control = bzrdir.BzrDir.open(base, _unsupported,
166
159
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
160
        return control.open_branch(_unsupported)
168
161
 
169
162
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
163
    def open_from_transport(transport, _unsupported=False):
171
164
        """Open the branch rooted at transport"""
172
165
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
166
        return control.open_branch(_unsupported)
174
167
 
175
168
    @staticmethod
176
169
    def open_containing(url, possible_transports=None):
214
207
    def _get_fallback_repository(self, url):
215
208
        """Get the repository we fallback to at url."""
216
209
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
210
        a_bzrdir = bzrdir.BzrDir.open(url,
218
211
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
212
        return a_bzrdir.open_branch().repository
220
213
 
221
214
    def _get_tags_bytes(self):
222
215
        """Get the bytes of a serialised tags dict.
283
276
        new_history.reverse()
284
277
        return new_history
285
278
 
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
 
        """
 
279
    def lock_write(self):
293
280
        raise NotImplementedError(self.lock_write)
294
281
 
295
282
    def lock_read(self):
296
 
        """Lock the branch for read operations.
297
 
 
298
 
        :return: A bzrlib.lock.LogicalLockResult.
299
 
        """
300
283
        raise NotImplementedError(self.lock_read)
301
284
 
302
285
    def unlock(self):
427
410
            * 'include' - the stop revision is the last item in the result
428
411
            * 'with-merges' - include the stop revision and all of its
429
412
              merged revisions in the result
430
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
431
 
              that are in both ancestries
432
413
        :param direction: either 'reverse' or 'forward':
433
414
            * reverse means return the start_revision_id first, i.e.
434
415
              start at the most recent revision and go backwards in history
456
437
        # start_revision_id.
457
438
        if self._merge_sorted_revisions_cache is None:
458
439
            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)
 
440
            graph = self.repository.get_graph()
 
441
            parent_map = dict(((key, value) for key, value in
 
442
                     graph.iter_ancestry([last_revision]) if value is not None))
 
443
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
444
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
445
                generate_revno=True)
 
446
            # Drop the sequence # before caching
 
447
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
448
 
463
449
        filtered = self._filter_merge_sorted_revisions(
464
450
            self._merge_sorted_revisions_cache, start_revision_id,
465
451
            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
452
        if direction == 'reverse':
470
453
            return filtered
471
454
        if direction == 'forward':
478
461
        """Iterate over an inclusive range of sorted revisions."""
479
462
        rev_iter = iter(merge_sorted_revisions)
480
463
        if start_revision_id is not None:
481
 
            for node in rev_iter:
482
 
                rev_id = node.key[-1]
 
464
            for rev_id, depth, revno, end_of_merge in rev_iter:
483
465
                if rev_id != start_revision_id:
484
466
                    continue
485
467
                else:
486
468
                    # The decision to include the start or not
487
469
                    # 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)
 
470
                    rev_iter = chain(
 
471
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
472
                        rev_iter)
490
473
                    break
491
474
        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)
 
475
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
476
                yield rev_id, depth, revno, end_of_merge
497
477
        elif stop_rule == 'exclude':
498
 
            for node in rev_iter:
499
 
                rev_id = node.key[-1]
 
478
            for rev_id, depth, revno, end_of_merge in rev_iter:
500
479
                if rev_id == stop_revision_id:
501
480
                    return
502
 
                yield (rev_id, node.merge_depth, node.revno,
503
 
                       node.end_of_merge)
 
481
                yield rev_id, depth, revno, end_of_merge
504
482
        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)
 
483
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
484
                yield rev_id, depth, revno, end_of_merge
509
485
                if rev_id == stop_revision_id:
510
486
                    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
487
        elif stop_rule == 'with-merges':
524
488
            stop_rev = self.repository.get_revision(stop_revision_id)
525
489
            if stop_rev.parent_ids:
526
490
                left_parent = stop_rev.parent_ids[0]
527
491
            else:
528
492
                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]
 
493
            for rev_id, depth, revno, end_of_merge in rev_iter:
535
494
                if rev_id == left_parent:
536
 
                    # reached the left parent after the stop_revision
537
495
                    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)
 
496
                yield rev_id, depth, revno, end_of_merge
548
497
        else:
549
498
            raise ValueError('invalid stop_rule %r' % stop_rule)
550
499
 
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
500
    def leave_lock_in_place(self):
597
501
        """Tell this branch object not to release the physical lock when this
598
502
        object is unlocked.
615
519
        :param other: The branch to bind to
616
520
        :type other: Branch
617
521
        """
618
 
        raise errors.UpgradeRequired(self.user_url)
 
522
        raise errors.UpgradeRequired(self.base)
619
523
 
620
524
    def set_append_revisions_only(self, enabled):
621
525
        if not self._format.supports_set_append_revisions_only():
622
 
            raise errors.UpgradeRequired(self.user_url)
 
526
            raise errors.UpgradeRequired(self.base)
623
527
        if enabled:
624
528
            value = 'True'
625
529
        else:
673
577
    def get_old_bound_location(self):
674
578
        """Return the URL of the branch we used to be bound to
675
579
        """
676
 
        raise errors.UpgradeRequired(self.user_url)
 
580
        raise errors.UpgradeRequired(self.base)
677
581
 
678
582
    def get_commit_builder(self, parents, config=None, timestamp=None,
679
583
                           timezone=None, committer=None, revprops=None,
757
661
            stacking.
758
662
        """
759
663
        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.
 
664
            raise errors.UnstackableBranchFormat(self._format, self.base)
764
665
        self._check_stackable_repo()
765
666
        if not url:
766
667
            try:
768
669
            except (errors.NotStacked, errors.UnstackableBranchFormat,
769
670
                errors.UnstackableRepositoryFormat):
770
671
                return
771
 
            self._unstack()
 
672
            url = ''
 
673
            # XXX: Lock correctness - should unlock our old repo if we were
 
674
            # locked.
 
675
            # repositories don't offer an interface to remove fallback
 
676
            # repositories today; take the conceptually simpler option and just
 
677
            # reopen it.
 
678
            self.repository = self.bzrdir.find_repository()
 
679
            self.repository.lock_write()
 
680
            # for every revision reference the branch has, ensure it is pulled
 
681
            # in.
 
682
            source_repository = self._get_fallback_repository(old_url)
 
683
            for revision_id in chain([self.last_revision()],
 
684
                self.tags.get_reverse_tag_dict()):
 
685
                self.repository.fetch(source_repository, revision_id,
 
686
                    find_ghosts=True)
772
687
        else:
773
688
            self._activate_fallback_location(url)
774
689
        # write this out after the repository is stacked to avoid setting a
775
690
        # stacked config that doesn't work.
776
691
        self._set_config_location('stacked_on_location', url)
777
692
 
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
693
 
833
694
    def _set_tags_bytes(self, bytes):
834
695
        """Mirror method for _get_tags_bytes.
914
775
 
915
776
    def unbind(self):
916
777
        """Older format branches cannot bind or unbind."""
917
 
        raise errors.UpgradeRequired(self.user_url)
 
778
        raise errors.UpgradeRequired(self.base)
918
779
 
919
780
    def last_revision(self):
920
781
        """Return last revision id, or NULL_REVISION."""
1080
941
        try:
1081
942
            return urlutils.join(self.base[:-1], parent)
1082
943
        except errors.InvalidURLJoin, e:
1083
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
944
            raise errors.InaccessibleParent(parent, self.base)
1084
945
 
1085
946
    def _get_parent_location(self):
1086
947
        raise NotImplementedError(self._get_parent_location)
1171
1032
        params = ChangeBranchTipParams(
1172
1033
            self, old_revno, new_revno, old_revid, new_revid)
1173
1034
        for hook in hooks:
1174
 
            hook(params)
 
1035
            try:
 
1036
                hook(params)
 
1037
            except errors.TipChangeRejected:
 
1038
                raise
 
1039
            except Exception:
 
1040
                exc_info = sys.exc_info()
 
1041
                hook_name = Branch.hooks.get_hook_name(hook)
 
1042
                raise errors.HookFailed(
 
1043
                    'pre_change_branch_tip', hook_name, exc_info)
1175
1044
 
1176
1045
    @needs_write_lock
1177
1046
    def update(self):
1226
1095
        revision_id: if not None, the revision history in the new branch will
1227
1096
                     be truncated to end with revision_id.
1228
1097
        """
1229
 
        if (repository_policy is not None and
1230
 
            repository_policy.requires_stacking()):
1231
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1232
1098
        result = to_bzrdir.create_branch()
1233
1099
        result.lock_write()
1234
1100
        try:
1302
1168
        target._set_all_reference_info(target_reference_dict)
1303
1169
 
1304
1170
    @needs_read_lock
1305
 
    def check(self, refs):
 
1171
    def check(self):
1306
1172
        """Check consistency of the branch.
1307
1173
 
1308
1174
        In particular this checks that revisions given in the revision-history
1311
1177
 
1312
1178
        Callers will typically also want to check the repository.
1313
1179
 
1314
 
        :param refs: Calculated refs for this branch as specified by
1315
 
            branch._get_check_refs()
1316
1180
        :return: A BranchCheckResult.
1317
1181
        """
1318
 
        result = BranchCheckResult(self)
 
1182
        ret = BranchCheckResult(self)
 
1183
        mainline_parent_id = None
1319
1184
        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
 
1185
        real_rev_history = []
 
1186
        try:
 
1187
            for revid in self.repository.iter_reverse_revision_history(
 
1188
                last_revision_id):
 
1189
                real_rev_history.append(revid)
 
1190
        except errors.RevisionNotPresent:
 
1191
            ret.ghosts_in_mainline = True
 
1192
        else:
 
1193
            ret.ghosts_in_mainline = False
 
1194
        real_rev_history.reverse()
 
1195
        if len(real_rev_history) != last_revno:
 
1196
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1197
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1198
        # TODO: We should probably also check that real_rev_history actually
 
1199
        #       matches self.revision_history()
 
1200
        for revision_id in real_rev_history:
 
1201
            try:
 
1202
                revision = self.repository.get_revision(revision_id)
 
1203
            except errors.NoSuchRevision, e:
 
1204
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1205
                            % revision_id)
 
1206
            # In general the first entry on the revision history has no parents.
 
1207
            # But it's not illegal for it to have parents listed; this can happen
 
1208
            # in imports from Arch when the parents weren't reachable.
 
1209
            if mainline_parent_id is not None:
 
1210
                if mainline_parent_id not in revision.parent_ids:
 
1211
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1212
                                        "parents of {%s}"
 
1213
                                        % (mainline_parent_id, revision_id))
 
1214
            mainline_parent_id = revision_id
 
1215
        return ret
1331
1216
 
1332
1217
    def _get_checkout_format(self):
1333
1218
        """Return the most suitable metadir for a checkout of this branch.
1356
1241
        """
1357
1242
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1358
1243
        # 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
1244
        if revision_id is None:
1362
1245
            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)
 
1246
        try:
 
1247
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1248
                revision_id=revision_id, stacked_on=stacked_on,
 
1249
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1250
        except errors.FileExists:
 
1251
            if not use_existing_dir:
 
1252
                raise
 
1253
        except errors.NoSuchFile:
 
1254
            if not create_prefix:
 
1255
                raise
1366
1256
        return dir_to.open_branch()
1367
1257
 
1368
1258
    def create_checkout(self, to_location, revision_id=None,
1387
1277
        if lightweight:
1388
1278
            format = self._get_checkout_format()
1389
1279
            checkout = format.initialize_on_transport(t)
1390
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1391
 
                target_branch=self)
 
1280
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1392
1281
        else:
1393
1282
            format = self._get_checkout_format()
1394
1283
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1436
1325
    def supports_tags(self):
1437
1326
        return self._format.supports_tags()
1438
1327
 
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
1328
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1452
1329
                                         other_branch):
1453
1330
        """Ensure that revision_b is a descendant of revision_a.
1517
1394
        return not (self == other)
1518
1395
 
1519
1396
    @classmethod
1520
 
    def find_format(klass, a_bzrdir, name=None):
 
1397
    def find_format(klass, a_bzrdir):
1521
1398
        """Return the format for the branch object in a_bzrdir."""
1522
1399
        try:
1523
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1524
 
            format_string = transport.get_bytes("format")
 
1400
            transport = a_bzrdir.get_branch_transport(None)
 
1401
            format_string = transport.get("format").read()
1525
1402
            return klass._formats[format_string]
1526
1403
        except errors.NoSuchFile:
1527
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1404
            raise errors.NotBranchError(path=transport.base)
1528
1405
        except KeyError:
1529
1406
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1530
1407
 
1533
1410
        """Return the current default format."""
1534
1411
        return klass._default_format
1535
1412
 
1536
 
    def get_reference(self, a_bzrdir, name=None):
 
1413
    def get_reference(self, a_bzrdir):
1537
1414
        """Get the target reference of the branch in a_bzrdir.
1538
1415
 
1539
1416
        format probing must have been completed before calling
1541
1418
        in a_bzrdir is correct.
1542
1419
 
1543
1420
        :param a_bzrdir: The bzrdir to get the branch data from.
1544
 
        :param name: Name of the colocated branch to fetch
1545
1421
        :return: None if the branch is not a reference branch.
1546
1422
        """
1547
1423
        return None
1548
1424
 
1549
1425
    @classmethod
1550
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1426
    def set_reference(self, a_bzrdir, to_branch):
1551
1427
        """Set the target reference of the branch in a_bzrdir.
1552
1428
 
1553
1429
        format probing must have been completed before calling
1555
1431
        in a_bzrdir is correct.
1556
1432
 
1557
1433
        :param a_bzrdir: The bzrdir to set the branch reference for.
1558
 
        :param name: Name of colocated branch to set, None for default
1559
1434
        :param to_branch: branch that the checkout is to reference
1560
1435
        """
1561
1436
        raise NotImplementedError(self.set_reference)
1568
1443
        """Return the short format description for this format."""
1569
1444
        raise NotImplementedError(self.get_format_description)
1570
1445
 
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):
 
1446
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1447
                           set_format=True):
1581
1448
        """Initialize a branch in a bzrdir, with specified files
1582
1449
 
1583
1450
        :param a_bzrdir: The bzrdir to initialize the branch in
1584
1451
        :param utf8_files: The files to create as a list of
1585
1452
            (filename, content) tuples
1586
 
        :param name: Name of colocated branch to create, if any
1587
1453
        :param set_format: If True, set the format with
1588
1454
            self.get_format_string.  (BzrBranch4 has its format set
1589
1455
            elsewhere)
1590
1456
        :return: a branch in this format
1591
1457
        """
1592
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1593
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1458
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1459
        branch_transport = a_bzrdir.get_branch_transport(self)
1594
1460
        lock_map = {
1595
1461
            'metadir': ('lock', lockdir.LockDir),
1596
1462
            'branch4': ('branch-lock', lockable_files.TransportLock),
1617
1483
        finally:
1618
1484
            if lock_taken:
1619
1485
                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
 
1486
        return self.open(a_bzrdir, _found=True)
1623
1487
 
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
 
        """
 
1488
    def initialize(self, a_bzrdir):
 
1489
        """Create a branch of this format in a_bzrdir."""
1629
1490
        raise NotImplementedError(self.initialize)
1630
1491
 
1631
1492
    def is_supported(self):
1661
1522
        """
1662
1523
        raise NotImplementedError(self.network_name)
1663
1524
 
1664
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1525
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1665
1526
        """Return the branch object for a_bzrdir
1666
1527
 
1667
1528
        :param a_bzrdir: A BzrDir that contains a branch.
1668
 
        :param name: Name of colocated branch to open
1669
1529
        :param _found: a private parameter, do not use it. It is used to
1670
1530
            indicate if format probing has already be done.
1671
1531
        :param ignore_fallbacks: when set, no fallback branches will be opened
1779
1639
            "multiple hooks installed for transform_fallback_location, "
1780
1640
            "all are called with the url returned from the previous hook."
1781
1641
            "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
1642
 
1800
1643
 
1801
1644
# install the default hooks into the Branch class.
1840
1683
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1841
1684
 
1842
1685
 
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
1686
class BzrBranchFormat4(BranchFormat):
1922
1687
    """Bzr branch format 4.
1923
1688
 
1930
1695
        """See BranchFormat.get_format_description()."""
1931
1696
        return "Branch format 4"
1932
1697
 
1933
 
    def initialize(self, a_bzrdir, name=None):
 
1698
    def initialize(self, a_bzrdir):
1934
1699
        """Create a branch of this format in a_bzrdir."""
1935
1700
        utf8_files = [('revision-history', ''),
1936
1701
                      ('branch-name', ''),
1937
1702
                      ]
1938
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1703
        return self._initialize_helper(a_bzrdir, utf8_files,
1939
1704
                                       lock_type='branch4', set_format=False)
1940
1705
 
1941
1706
    def __init__(self):
1946
1711
        """The network name for this format is the control dirs disk label."""
1947
1712
        return self._matchingbzrdir.get_format_string()
1948
1713
 
1949
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1714
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1950
1715
        """See BranchFormat.open()."""
1951
1716
        if not _found:
1952
1717
            # we are being called directly and must probe.
1954
1719
        return BzrBranch(_format=self,
1955
1720
                         _control_files=a_bzrdir._control_files,
1956
1721
                         a_bzrdir=a_bzrdir,
1957
 
                         name=name,
1958
1722
                         _repository=a_bzrdir.open_repository())
1959
1723
 
1960
1724
    def __str__(self):
1975
1739
        """
1976
1740
        return self.get_format_string()
1977
1741
 
1978
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1742
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1979
1743
        """See BranchFormat.open()."""
1980
1744
        if not _found:
1981
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1745
            format = BranchFormat.find_format(a_bzrdir)
1982
1746
            if format.__class__ != self.__class__:
1983
1747
                raise AssertionError("wrong format %r found for %r" %
1984
1748
                    (format, self))
1985
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1986
1749
        try:
 
1750
            transport = a_bzrdir.get_branch_transport(None)
1987
1751
            control_files = lockable_files.LockableFiles(transport, 'lock',
1988
1752
                                                         lockdir.LockDir)
1989
1753
            return self._branch_class()(_format=self,
1990
1754
                              _control_files=control_files,
1991
 
                              name=name,
1992
1755
                              a_bzrdir=a_bzrdir,
1993
1756
                              _repository=a_bzrdir.find_repository(),
1994
1757
                              ignore_fallbacks=ignore_fallbacks)
1995
1758
        except errors.NoSuchFile:
1996
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1759
            raise errors.NotBranchError(path=transport.base)
1997
1760
 
1998
1761
    def __init__(self):
1999
1762
        super(BranchFormatMetadir, self).__init__()
2028
1791
        """See BranchFormat.get_format_description()."""
2029
1792
        return "Branch format 5"
2030
1793
 
2031
 
    def initialize(self, a_bzrdir, name=None):
 
1794
    def initialize(self, a_bzrdir):
2032
1795
        """Create a branch of this format in a_bzrdir."""
2033
1796
        utf8_files = [('revision-history', ''),
2034
1797
                      ('branch-name', ''),
2035
1798
                      ]
2036
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1799
        return self._initialize_helper(a_bzrdir, utf8_files)
2037
1800
 
2038
1801
    def supports_tags(self):
2039
1802
        return False
2061
1824
        """See BranchFormat.get_format_description()."""
2062
1825
        return "Branch format 6"
2063
1826
 
2064
 
    def initialize(self, a_bzrdir, name=None):
 
1827
    def initialize(self, a_bzrdir):
2065
1828
        """Create a branch of this format in a_bzrdir."""
2066
1829
        utf8_files = [('last-revision', '0 null:\n'),
2067
1830
                      ('branch.conf', ''),
2068
1831
                      ('tags', ''),
2069
1832
                      ]
2070
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1833
        return self._initialize_helper(a_bzrdir, utf8_files)
2071
1834
 
2072
1835
    def make_tags(self, branch):
2073
1836
        """See bzrlib.branch.BranchFormat.make_tags()."""
2091
1854
        """See BranchFormat.get_format_description()."""
2092
1855
        return "Branch format 8"
2093
1856
 
2094
 
    def initialize(self, a_bzrdir, name=None):
 
1857
    def initialize(self, a_bzrdir):
2095
1858
        """Create a branch of this format in a_bzrdir."""
2096
1859
        utf8_files = [('last-revision', '0 null:\n'),
2097
1860
                      ('branch.conf', ''),
2098
1861
                      ('tags', ''),
2099
1862
                      ('references', '')
2100
1863
                      ]
2101
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1864
        return self._initialize_helper(a_bzrdir, utf8_files)
2102
1865
 
2103
1866
    def __init__(self):
2104
1867
        super(BzrBranchFormat8, self).__init__()
2127
1890
    This format was introduced in bzr 1.6.
2128
1891
    """
2129
1892
 
2130
 
    def initialize(self, a_bzrdir, name=None):
 
1893
    def initialize(self, a_bzrdir):
2131
1894
        """Create a branch of this format in a_bzrdir."""
2132
1895
        utf8_files = [('last-revision', '0 null:\n'),
2133
1896
                      ('branch.conf', ''),
2134
1897
                      ('tags', ''),
2135
1898
                      ]
2136
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1899
        return self._initialize_helper(a_bzrdir, utf8_files)
2137
1900
 
2138
1901
    def _branch_class(self):
2139
1902
        return BzrBranch7
2171
1934
        """See BranchFormat.get_format_description()."""
2172
1935
        return "Checkout reference format 1"
2173
1936
 
2174
 
    def get_reference(self, a_bzrdir, name=None):
 
1937
    def get_reference(self, a_bzrdir):
2175
1938
        """See BranchFormat.get_reference()."""
2176
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2177
 
        return transport.get_bytes('location')
 
1939
        transport = a_bzrdir.get_branch_transport(None)
 
1940
        return transport.get('location').read()
2178
1941
 
2179
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1942
    def set_reference(self, a_bzrdir, to_branch):
2180
1943
        """See BranchFormat.set_reference()."""
2181
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1944
        transport = a_bzrdir.get_branch_transport(None)
2182
1945
        location = transport.put_bytes('location', to_branch.base)
2183
1946
 
2184
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1947
    def initialize(self, a_bzrdir, target_branch=None):
2185
1948
        """Create a branch of this format in a_bzrdir."""
2186
1949
        if target_branch is None:
2187
1950
            # this format does not implement branch itself, thus the implicit
2188
1951
            # creation contract must see it as uninitializable
2189
1952
            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)
 
1953
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1954
        branch_transport = a_bzrdir.get_branch_transport(self)
2192
1955
        branch_transport.put_bytes('location',
2193
 
            target_branch.bzrdir.user_url)
 
1956
            target_branch.bzrdir.root_transport.base)
2194
1957
        branch_transport.put_bytes('format', self.get_format_string())
2195
 
        branch = self.open(
2196
 
            a_bzrdir, name, _found=True,
 
1958
        return self.open(
 
1959
            a_bzrdir, _found=True,
2197
1960
            possible_transports=[target_branch.bzrdir.root_transport])
2198
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2199
 
        return branch
2200
1961
 
2201
1962
    def __init__(self):
2202
1963
        super(BranchReferenceFormat, self).__init__()
2208
1969
        def clone(to_bzrdir, revision_id=None,
2209
1970
            repository_policy=None):
2210
1971
            """See Branch.clone()."""
2211
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1972
            return format.initialize(to_bzrdir, a_branch)
2212
1973
            # cannot obey revision_id limits when cloning a reference ...
2213
1974
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2214
1975
            # emit some sort of warning/error to the caller ?!
2215
1976
        return clone
2216
1977
 
2217
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1978
    def open(self, a_bzrdir, _found=False, location=None,
2218
1979
             possible_transports=None, ignore_fallbacks=False):
2219
1980
        """Return the branch that the branch reference in a_bzrdir points at.
2220
1981
 
2221
1982
        :param a_bzrdir: A BzrDir that contains a branch.
2222
 
        :param name: Name of colocated branch to open, if any
2223
1983
        :param _found: a private parameter, do not use it. It is used to
2224
1984
            indicate if format probing has already be done.
2225
1985
        :param ignore_fallbacks: when set, no fallback branches will be opened
2230
1990
        :param possible_transports: An optional reusable transports list.
2231
1991
        """
2232
1992
        if not _found:
2233
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1993
            format = BranchFormat.find_format(a_bzrdir)
2234
1994
            if format.__class__ != self.__class__:
2235
1995
                raise AssertionError("wrong format %r found for %r" %
2236
1996
                    (format, self))
2237
1997
        if location is None:
2238
 
            location = self.get_reference(a_bzrdir, name)
 
1998
            location = self.get_reference(a_bzrdir)
2239
1999
        real_bzrdir = bzrdir.BzrDir.open(
2240
2000
            location, possible_transports=possible_transports)
2241
 
        result = real_bzrdir.open_branch(name=name, 
2242
 
            ignore_fallbacks=ignore_fallbacks)
 
2001
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2243
2002
        # this changes the behaviour of result.clone to create a new reference
2244
2003
        # rather than a copy of the content of the branch.
2245
2004
        # I did not use a proxy object because that needs much more extensive
2272
2031
BranchFormat.register_format(__format6)
2273
2032
BranchFormat.register_format(__format7)
2274
2033
BranchFormat.register_format(__format8)
2275
 
BranchFormat.set_default_format(__format7)
 
2034
BranchFormat.set_default_format(__format6)
2276
2035
_legacy_formats = [BzrBranchFormat4(),
2277
2036
    ]
2278
2037
network_format_registry.register(
2279
2038
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2280
2039
 
2281
2040
 
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):
 
2041
class BzrBranch(Branch):
2300
2042
    """A branch stored in the actual filesystem.
2301
2043
 
2302
2044
    Note that it's "local" in the context of the filesystem; it doesn't
2308
2050
    :ivar repository: Repository for this branch.
2309
2051
    :ivar base: The url of the base directory for this branch; the one
2310
2052
        containing the .bzr directory.
2311
 
    :ivar name: Optional colocated branch name as it exists in the control
2312
 
        directory.
2313
2053
    """
2314
2054
 
2315
2055
    def __init__(self, _format=None,
2316
 
                 _control_files=None, a_bzrdir=None, name=None,
2317
 
                 _repository=None, ignore_fallbacks=False):
 
2056
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2057
                 ignore_fallbacks=False):
2318
2058
        """Create new branch object at a particular location."""
2319
2059
        if a_bzrdir is None:
2320
2060
            raise ValueError('a_bzrdir must be supplied')
2321
2061
        else:
2322
2062
            self.bzrdir = a_bzrdir
2323
2063
        self._base = self.bzrdir.transport.clone('..').base
2324
 
        self.name = name
2325
2064
        # XXX: We should be able to just do
2326
2065
        #   self.base = self.bzrdir.root_transport.base
2327
2066
        # but this does not quite work yet -- mbp 20080522
2334
2073
        Branch.__init__(self)
2335
2074
 
2336
2075
    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)
 
2076
        return '%s(%r)' % (self.__class__.__name__, self.base)
2342
2077
 
2343
2078
    __repr__ = __str__
2344
2079
 
2355
2090
        return self.control_files.is_locked()
2356
2091
 
2357
2092
    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
2093
        # All-in-one needs to always unlock/lock.
2367
2094
        repo_control = getattr(self.repository, 'control_files', None)
2368
2095
        if self.control_files == repo_control or not self.is_locked():
2369
 
            self.repository._warn_if_deprecated(self)
2370
2096
            self.repository.lock_write()
2371
2097
            took_lock = True
2372
2098
        else:
2373
2099
            took_lock = False
2374
2100
        try:
2375
 
            return BranchWriteLockResult(self.unlock,
2376
 
                self.control_files.lock_write(token=token))
 
2101
            return self.control_files.lock_write(token=token)
2377
2102
        except:
2378
2103
            if took_lock:
2379
2104
                self.repository.unlock()
2380
2105
            raise
2381
2106
 
2382
2107
    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
2108
        # All-in-one needs to always unlock/lock.
2390
2109
        repo_control = getattr(self.repository, 'control_files', None)
2391
2110
        if self.control_files == repo_control or not self.is_locked():
2392
 
            self.repository._warn_if_deprecated(self)
2393
2111
            self.repository.lock_read()
2394
2112
            took_lock = True
2395
2113
        else:
2396
2114
            took_lock = False
2397
2115
        try:
2398
2116
            self.control_files.lock_read()
2399
 
            return LogicalLockResult(self.unlock)
2400
2117
        except:
2401
2118
            if took_lock:
2402
2119
                self.repository.unlock()
2403
2120
            raise
2404
2121
 
2405
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2406
2122
    def unlock(self):
2407
2123
        try:
2408
2124
            self.control_files.unlock()
2571
2287
        return result
2572
2288
 
2573
2289
    def get_stacked_on_url(self):
2574
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2290
        raise errors.UnstackableBranchFormat(self._format, self.base)
2575
2291
 
2576
2292
    def set_push_location(self, location):
2577
2293
        """See Branch.set_push_location."""
2767
2483
        if _mod_revision.is_null(last_revision):
2768
2484
            return
2769
2485
        if last_revision not in self._lefthand_history(revision_id):
2770
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2486
            raise errors.AppendRevisionsOnlyViolation(self.base)
2771
2487
 
2772
2488
    def _gen_revision_history(self):
2773
2489
        """Generate the revision history from last revision
2873
2589
        if branch_location is None:
2874
2590
            return Branch.reference_parent(self, file_id, path,
2875
2591
                                           possible_transports)
2876
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2592
        branch_location = urlutils.join(self.base, branch_location)
2877
2593
        return Branch.open(branch_location,
2878
2594
                           possible_transports=possible_transports)
2879
2595
 
2925
2641
        return stacked_url
2926
2642
 
2927
2643
    def _get_append_revisions_only(self):
2928
 
        return self.get_config(
2929
 
            ).get_user_option_as_bool('append_revisions_only')
 
2644
        value = self.get_config().get_user_option('append_revisions_only')
 
2645
        return value == 'True'
2930
2646
 
2931
2647
    @needs_write_lock
2932
2648
    def generate_revision_history(self, revision_id, last_rev=None,
2994
2710
    """
2995
2711
 
2996
2712
    def get_stacked_on_url(self):
2997
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2713
        raise errors.UnstackableBranchFormat(self._format, self.base)
2998
2714
 
2999
2715
 
3000
2716
######################################################################
3079
2795
 
3080
2796
    def __init__(self, branch):
3081
2797
        self.branch = branch
3082
 
        self.errors = []
 
2798
        self.ghosts_in_mainline = False
3083
2799
 
3084
2800
    def report_results(self, verbose):
3085
2801
        """Report the check results via trace.note.
3087
2803
        :param verbose: Requests more detailed display of what was checked,
3088
2804
            if any.
3089
2805
        """
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)
 
2806
        note('checked branch %s format %s',
 
2807
             self.branch.base,
 
2808
             self.branch._format)
 
2809
        if self.ghosts_in_mainline:
 
2810
            note('branch contains ghosts in mainline')
3094
2811
 
3095
2812
 
3096
2813
class Converter5to6(object):
3422
3139
        if local and not bound_location:
3423
3140
            raise errors.LocalRequiresBoundBranch()
3424
3141
        master_branch = None
3425
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3142
        if not local and bound_location and self.source.base != bound_location:
3426
3143
            # not pulling from master, so we need to update master.
3427
3144
            master_branch = self.target.get_master_branch(possible_transports)
3428
3145
            master_branch.lock_write()