~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2009-06-15 11:05:33 UTC
  • mto: This revision was merged to the branch mainline in revision 4441.
  • Revision ID: robertc@robertcollins.net-20090615110533-fwqo9nnlynbp1o42
Shellcompletion apparently isn't tested.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
46
46
    )
47
47
""")
48
48
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
50
from bzrlib.hooks import HookPoint, Hooks
51
51
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
53
52
from bzrlib import registry
54
53
from bzrlib.symbol_versioning import (
55
54
    deprecated_in,
63
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
63
 
65
64
 
66
 
class Branch(bzrdir.ControlComponent):
 
65
# TODO: Maybe include checks for common corruption of newlines, etc?
 
66
 
 
67
# TODO: Some operations like log might retrieve the same revisions
 
68
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
69
# cache in memory to make this faster.  In general anything can be
 
70
# cached in memory between lock and unlock operations. .. nb thats
 
71
# what the transaction identity map provides
 
72
 
 
73
 
 
74
######################################################################
 
75
# branch objects
 
76
 
 
77
class Branch(object):
67
78
    """Branch holding a history of revisions.
68
79
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
80
    base
 
81
        Base directory/url of the branch.
72
82
 
73
83
    hooks: An instance of BranchHooks.
74
84
    """
76
86
    # - RBC 20060112
77
87
    base = None
78
88
 
79
 
    @property
80
 
    def control_transport(self):
81
 
        return self._transport
82
 
 
83
 
    @property
84
 
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
86
 
 
87
89
    def __init__(self, *ignored, **ignored_too):
88
90
        self.tags = self._format.make_tags(self)
89
91
        self._revision_history_cache = None
90
92
        self._revision_id_to_revno_cache = None
91
93
        self._partial_revision_id_to_revno_cache = {}
92
 
        self._partial_revision_history_cache = []
93
94
        self._last_revision_info_cache = None
94
95
        self._merge_sorted_revisions_cache = None
95
96
        self._open_hook()
103
104
    def _activate_fallback_location(self, url):
104
105
        """Activate the branch/repository from url as a fallback repository."""
105
106
        repo = self._get_fallback_repository(url)
106
 
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
108
107
        self.repository.add_fallback_repository(repo)
109
108
 
110
109
    def break_lock(self):
126
125
            raise errors.UnstackableRepositoryFormat(self.repository._format,
127
126
                self.repository.base)
128
127
 
129
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
 
        """Extend the partial history to include a given index
131
 
 
132
 
        If a stop_index is supplied, stop when that index has been reached.
133
 
        If a stop_revision is supplied, stop when that revision is
134
 
        encountered.  Otherwise, stop when the beginning of history is
135
 
        reached.
136
 
 
137
 
        :param stop_index: The index which should be present.  When it is
138
 
            present, history extension will stop.
139
 
        :param stop_revision: The revision id which should be present.  When
140
 
            it is encountered, history extension will stop.
141
 
        """
142
 
        if len(self._partial_revision_history_cache) == 0:
143
 
            self._partial_revision_history_cache = [self.last_revision()]
144
 
        repository._iter_for_revno(
145
 
            self.repository, self._partial_revision_history_cache,
146
 
            stop_index=stop_index, stop_revision=stop_revision)
147
 
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
 
            self._partial_revision_history_cache.pop()
149
 
 
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
128
    @staticmethod
159
129
    def open(base, _unsupported=False, possible_transports=None):
160
130
        """Open the branch rooted at base.
164
134
        """
165
135
        control = bzrdir.BzrDir.open(base, _unsupported,
166
136
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
137
        return control.open_branch(_unsupported)
168
138
 
169
139
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
140
    def open_from_transport(transport, _unsupported=False):
171
141
        """Open the branch rooted at transport"""
172
142
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
143
        return control.open_branch(_unsupported)
174
144
 
175
145
    @staticmethod
176
146
    def open_containing(url, possible_transports=None):
214
184
    def _get_fallback_repository(self, url):
215
185
        """Get the repository we fallback to at url."""
216
186
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
187
        a_bzrdir = bzrdir.BzrDir.open(url,
218
188
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
189
        return a_bzrdir.open_branch().repository
220
190
 
221
191
    def _get_tags_bytes(self):
222
192
        """Get the bytes of a serialised tags dict.
283
253
        new_history.reverse()
284
254
        return new_history
285
255
 
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
 
        """
 
256
    def lock_write(self):
293
257
        raise NotImplementedError(self.lock_write)
294
258
 
295
259
    def lock_read(self):
296
 
        """Lock the branch for read operations.
297
 
 
298
 
        :return: An object with an unlock method which will release the lock
299
 
            obtained.
300
 
        """
301
260
        raise NotImplementedError(self.lock_read)
302
261
 
303
262
    def unlock(self):
428
387
            * 'include' - the stop revision is the last item in the result
429
388
            * 'with-merges' - include the stop revision and all of its
430
389
              merged revisions in the result
431
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
432
 
              that are in both ancestries
433
390
        :param direction: either 'reverse' or 'forward':
434
391
            * reverse means return the start_revision_id first, i.e.
435
392
              start at the most recent revision and go backwards in history
457
414
        # start_revision_id.
458
415
        if self._merge_sorted_revisions_cache is None:
459
416
            last_revision = self.last_revision()
460
 
            known_graph = self.repository.get_known_graph_ancestry(
461
 
                [last_revision])
462
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
 
                last_revision)
 
417
            graph = self.repository.get_graph()
 
418
            parent_map = dict(((key, value) for key, value in
 
419
                     graph.iter_ancestry([last_revision]) if value is not None))
 
420
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
421
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
422
                generate_revno=True)
 
423
            # Drop the sequence # before caching
 
424
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
425
 
464
426
        filtered = self._filter_merge_sorted_revisions(
465
427
            self._merge_sorted_revisions_cache, start_revision_id,
466
428
            stop_revision_id, stop_rule)
467
 
        # Make sure we don't return revisions that are not part of the
468
 
        # start_revision_id ancestry.
469
 
        filtered = self._filter_start_non_ancestors(filtered)
470
429
        if direction == 'reverse':
471
430
            return filtered
472
431
        if direction == 'forward':
479
438
        """Iterate over an inclusive range of sorted revisions."""
480
439
        rev_iter = iter(merge_sorted_revisions)
481
440
        if start_revision_id is not None:
482
 
            for node in rev_iter:
483
 
                rev_id = node.key[-1]
 
441
            for rev_id, depth, revno, end_of_merge in rev_iter:
484
442
                if rev_id != start_revision_id:
485
443
                    continue
486
444
                else:
487
445
                    # The decision to include the start or not
488
446
                    # depends on the stop_rule if a stop is provided
489
 
                    # so pop this node back into the iterator
490
 
                    rev_iter = chain(iter([node]), rev_iter)
 
447
                    rev_iter = chain(
 
448
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
449
                        rev_iter)
491
450
                    break
492
451
        if stop_revision_id is None:
493
 
            # Yield everything
494
 
            for node in rev_iter:
495
 
                rev_id = node.key[-1]
496
 
                yield (rev_id, node.merge_depth, node.revno,
497
 
                       node.end_of_merge)
 
452
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
453
                yield rev_id, depth, revno, end_of_merge
498
454
        elif stop_rule == 'exclude':
499
 
            for node in rev_iter:
500
 
                rev_id = node.key[-1]
 
455
            for rev_id, depth, revno, end_of_merge in rev_iter:
501
456
                if rev_id == stop_revision_id:
502
457
                    return
503
 
                yield (rev_id, node.merge_depth, node.revno,
504
 
                       node.end_of_merge)
 
458
                yield rev_id, depth, revno, end_of_merge
505
459
        elif stop_rule == 'include':
506
 
            for node in rev_iter:
507
 
                rev_id = node.key[-1]
508
 
                yield (rev_id, node.merge_depth, node.revno,
509
 
                       node.end_of_merge)
 
460
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
461
                yield rev_id, depth, revno, end_of_merge
510
462
                if rev_id == stop_revision_id:
511
463
                    return
512
 
        elif stop_rule == 'with-merges-without-common-ancestry':
513
 
            # We want to exclude all revisions that are already part of the
514
 
            # stop_revision_id ancestry.
515
 
            graph = self.repository.get_graph()
516
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
517
 
                                                    [stop_revision_id])
518
 
            for node in rev_iter:
519
 
                rev_id = node.key[-1]
520
 
                if rev_id not in ancestors:
521
 
                    continue
522
 
                yield (rev_id, node.merge_depth, node.revno,
523
 
                       node.end_of_merge)
524
464
        elif stop_rule == 'with-merges':
525
465
            stop_rev = self.repository.get_revision(stop_revision_id)
526
466
            if stop_rev.parent_ids:
527
467
                left_parent = stop_rev.parent_ids[0]
528
468
            else:
529
469
                left_parent = _mod_revision.NULL_REVISION
530
 
            # left_parent is the actual revision we want to stop logging at,
531
 
            # since we want to show the merged revisions after the stop_rev too
532
 
            reached_stop_revision_id = False
533
 
            revision_id_whitelist = []
534
 
            for node in rev_iter:
535
 
                rev_id = node.key[-1]
 
470
            for rev_id, depth, revno, end_of_merge in rev_iter:
536
471
                if rev_id == left_parent:
537
 
                    # reached the left parent after the stop_revision
538
472
                    return
539
 
                if (not reached_stop_revision_id or
540
 
                        rev_id in revision_id_whitelist):
541
 
                    yield (rev_id, node.merge_depth, node.revno,
542
 
                       node.end_of_merge)
543
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
544
 
                        # only do the merged revs of rev_id from now on
545
 
                        rev = self.repository.get_revision(rev_id)
546
 
                        if rev.parent_ids:
547
 
                            reached_stop_revision_id = True
548
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
473
                yield rev_id, depth, revno, end_of_merge
549
474
        else:
550
475
            raise ValueError('invalid stop_rule %r' % stop_rule)
551
476
 
552
 
    def _filter_start_non_ancestors(self, rev_iter):
553
 
        # If we started from a dotted revno, we want to consider it as a tip
554
 
        # and don't want to yield revisions that are not part of its
555
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
556
 
        # uninteresting descendants of the first parent of our tip before the
557
 
        # tip itself.
558
 
        first = rev_iter.next()
559
 
        (rev_id, merge_depth, revno, end_of_merge) = first
560
 
        yield first
561
 
        if not merge_depth:
562
 
            # We start at a mainline revision so by definition, all others
563
 
            # revisions in rev_iter are ancestors
564
 
            for node in rev_iter:
565
 
                yield node
566
 
 
567
 
        clean = False
568
 
        whitelist = set()
569
 
        pmap = self.repository.get_parent_map([rev_id])
570
 
        parents = pmap.get(rev_id, [])
571
 
        if parents:
572
 
            whitelist.update(parents)
573
 
        else:
574
 
            # If there is no parents, there is nothing of interest left
575
 
 
576
 
            # FIXME: It's hard to test this scenario here as this code is never
577
 
            # called in that case. -- vila 20100322
578
 
            return
579
 
 
580
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
 
            if not clean:
582
 
                if rev_id in whitelist:
583
 
                    pmap = self.repository.get_parent_map([rev_id])
584
 
                    parents = pmap.get(rev_id, [])
585
 
                    whitelist.remove(rev_id)
586
 
                    whitelist.update(parents)
587
 
                    if merge_depth == 0:
588
 
                        # We've reached the mainline, there is nothing left to
589
 
                        # filter
590
 
                        clean = True
591
 
                else:
592
 
                    # A revision that is not part of the ancestry of our
593
 
                    # starting revision.
594
 
                    continue
595
 
            yield (rev_id, merge_depth, revno, end_of_merge)
596
 
 
597
477
    def leave_lock_in_place(self):
598
478
        """Tell this branch object not to release the physical lock when this
599
479
        object is unlocked.
616
496
        :param other: The branch to bind to
617
497
        :type other: Branch
618
498
        """
619
 
        raise errors.UpgradeRequired(self.user_url)
620
 
 
621
 
    def set_append_revisions_only(self, enabled):
622
 
        if not self._format.supports_set_append_revisions_only():
623
 
            raise errors.UpgradeRequired(self.user_url)
624
 
        if enabled:
625
 
            value = 'True'
626
 
        else:
627
 
            value = 'False'
628
 
        self.get_config().set_user_option('append_revisions_only', value,
629
 
            warn_masked=True)
 
499
        raise errors.UpgradeRequired(self.base)
630
500
 
631
501
    def set_reference_info(self, file_id, tree_path, branch_location):
632
502
        """Set the branch location to use for a tree reference."""
674
544
    def get_old_bound_location(self):
675
545
        """Return the URL of the branch we used to be bound to
676
546
        """
677
 
        raise errors.UpgradeRequired(self.user_url)
 
547
        raise errors.UpgradeRequired(self.base)
678
548
 
679
549
    def get_commit_builder(self, parents, config=None, timestamp=None,
680
550
                           timezone=None, committer=None, revprops=None,
758
628
            stacking.
759
629
        """
760
630
        if not self._format.supports_stacking():
761
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
762
 
        # XXX: Changing from one fallback repository to another does not check
763
 
        # that all the data you need is present in the new fallback.
764
 
        # Possibly it should.
 
631
            raise errors.UnstackableBranchFormat(self._format, self.base)
765
632
        self._check_stackable_repo()
766
633
        if not url:
767
634
            try:
769
636
            except (errors.NotStacked, errors.UnstackableBranchFormat,
770
637
                errors.UnstackableRepositoryFormat):
771
638
                return
772
 
            self._unstack()
 
639
            url = ''
 
640
            # XXX: Lock correctness - should unlock our old repo if we were
 
641
            # locked.
 
642
            # repositories don't offer an interface to remove fallback
 
643
            # repositories today; take the conceptually simpler option and just
 
644
            # reopen it.
 
645
            self.repository = self.bzrdir.find_repository()
 
646
            self.repository.lock_write()
 
647
            # for every revision reference the branch has, ensure it is pulled
 
648
            # in.
 
649
            source_repository = self._get_fallback_repository(old_url)
 
650
            for revision_id in chain([self.last_revision()],
 
651
                self.tags.get_reverse_tag_dict()):
 
652
                self.repository.fetch(source_repository, revision_id,
 
653
                    find_ghosts=True)
773
654
        else:
774
655
            self._activate_fallback_location(url)
775
656
        # write this out after the repository is stacked to avoid setting a
776
657
        # stacked config that doesn't work.
777
658
        self._set_config_location('stacked_on_location', url)
778
659
 
779
 
    def _unstack(self):
780
 
        """Change a branch to be unstacked, copying data as needed.
781
 
        
782
 
        Don't call this directly, use set_stacked_on_url(None).
783
 
        """
784
 
        pb = ui.ui_factory.nested_progress_bar()
785
 
        try:
786
 
            pb.update("Unstacking")
787
 
            # The basic approach here is to fetch the tip of the branch,
788
 
            # including all available ghosts, from the existing stacked
789
 
            # repository into a new repository object without the fallbacks. 
790
 
            #
791
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
792
 
            # correct for CHKMap repostiories
793
 
            old_repository = self.repository
794
 
            if len(old_repository._fallback_repositories) != 1:
795
 
                raise AssertionError("can't cope with fallback repositories "
796
 
                    "of %r" % (self.repository,))
797
 
            # unlock it, including unlocking the fallback
798
 
            old_repository.unlock()
799
 
            old_repository.lock_read()
800
 
            try:
801
 
                # Repositories don't offer an interface to remove fallback
802
 
                # repositories today; take the conceptually simpler option and just
803
 
                # reopen it.  We reopen it starting from the URL so that we
804
 
                # get a separate connection for RemoteRepositories and can
805
 
                # stream from one of them to the other.  This does mean doing
806
 
                # separate SSH connection setup, but unstacking is not a
807
 
                # common operation so it's tolerable.
808
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
809
 
                new_repository = new_bzrdir.find_repository()
810
 
                self.repository = new_repository
811
 
                if self.repository._fallback_repositories:
812
 
                    raise AssertionError("didn't expect %r to have "
813
 
                        "fallback_repositories"
814
 
                        % (self.repository,))
815
 
                # this is not paired with an unlock because it's just restoring
816
 
                # the previous state; the lock's released when set_stacked_on_url
817
 
                # returns
818
 
                self.repository.lock_write()
819
 
                # XXX: If you unstack a branch while it has a working tree
820
 
                # with a pending merge, the pending-merged revisions will no
821
 
                # longer be present.  You can (probably) revert and remerge.
822
 
                #
823
 
                # XXX: This only fetches up to the tip of the repository; it
824
 
                # doesn't bring across any tags.  That's fairly consistent
825
 
                # with how branch works, but perhaps not ideal.
826
 
                self.repository.fetch(old_repository,
827
 
                    revision_id=self.last_revision(),
828
 
                    find_ghosts=True)
829
 
            finally:
830
 
                old_repository.unlock()
831
 
        finally:
832
 
            pb.finished()
833
660
 
834
661
    def _set_tags_bytes(self, bytes):
835
662
        """Mirror method for _get_tags_bytes.
871
698
        self._revision_id_to_revno_cache = None
872
699
        self._last_revision_info_cache = None
873
700
        self._merge_sorted_revisions_cache = None
874
 
        self._partial_revision_history_cache = []
875
 
        self._partial_revision_id_to_revno_cache = {}
876
701
 
877
702
    def _gen_revision_history(self):
878
703
        """Return sequence of revision hashes on to this branch.
915
740
 
916
741
    def unbind(self):
917
742
        """Older format branches cannot bind or unbind."""
918
 
        raise errors.UpgradeRequired(self.user_url)
 
743
        raise errors.UpgradeRequired(self.base)
 
744
 
 
745
    def set_append_revisions_only(self, enabled):
 
746
        """Older format branches are never restricted to append-only"""
 
747
        raise errors.UpgradeRequired(self.base)
919
748
 
920
749
    def last_revision(self):
921
750
        """Return last revision id, or NULL_REVISION."""
1002
831
        except ValueError:
1003
832
            raise errors.NoSuchRevision(self, revision_id)
1004
833
 
1005
 
    @needs_read_lock
1006
834
    def get_rev_id(self, revno, history=None):
1007
835
        """Find the revision id of the specified revno."""
1008
836
        if revno == 0:
1009
837
            return _mod_revision.NULL_REVISION
1010
 
        last_revno, last_revid = self.last_revision_info()
1011
 
        if revno == last_revno:
1012
 
            return last_revid
1013
 
        if revno <= 0 or revno > last_revno:
 
838
        if history is None:
 
839
            history = self.revision_history()
 
840
        if revno <= 0 or revno > len(history):
1014
841
            raise errors.NoSuchRevision(self, revno)
1015
 
        distance_from_last = last_revno - revno
1016
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
1017
 
            self._extend_partial_history(distance_from_last)
1018
 
        return self._partial_revision_history_cache[distance_from_last]
 
842
        return history[revno - 1]
1019
843
 
1020
844
    @needs_write_lock
1021
845
    def pull(self, source, overwrite=False, stop_revision=None,
1081
905
        try:
1082
906
            return urlutils.join(self.base[:-1], parent)
1083
907
        except errors.InvalidURLJoin, e:
1084
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
908
            raise errors.InaccessibleParent(parent, self.base)
1085
909
 
1086
910
    def _get_parent_location(self):
1087
911
        raise NotImplementedError(self._get_parent_location)
1172
996
        params = ChangeBranchTipParams(
1173
997
            self, old_revno, new_revno, old_revid, new_revid)
1174
998
        for hook in hooks:
1175
 
            hook(params)
 
999
            try:
 
1000
                hook(params)
 
1001
            except errors.TipChangeRejected:
 
1002
                raise
 
1003
            except Exception:
 
1004
                exc_info = sys.exc_info()
 
1005
                hook_name = Branch.hooks.get_hook_name(hook)
 
1006
                raise errors.HookFailed(
 
1007
                    'pre_change_branch_tip', hook_name, exc_info)
1176
1008
 
1177
1009
    @needs_write_lock
1178
1010
    def update(self):
1227
1059
        revision_id: if not None, the revision history in the new branch will
1228
1060
                     be truncated to end with revision_id.
1229
1061
        """
1230
 
        if (repository_policy is not None and
1231
 
            repository_policy.requires_stacking()):
1232
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1233
1062
        result = to_bzrdir.create_branch()
1234
1063
        result.lock_write()
1235
1064
        try:
1303
1132
        target._set_all_reference_info(target_reference_dict)
1304
1133
 
1305
1134
    @needs_read_lock
1306
 
    def check(self, refs):
 
1135
    def check(self):
1307
1136
        """Check consistency of the branch.
1308
1137
 
1309
1138
        In particular this checks that revisions given in the revision-history
1312
1141
 
1313
1142
        Callers will typically also want to check the repository.
1314
1143
 
1315
 
        :param refs: Calculated refs for this branch as specified by
1316
 
            branch._get_check_refs()
1317
1144
        :return: A BranchCheckResult.
1318
1145
        """
1319
 
        result = BranchCheckResult(self)
 
1146
        ret = BranchCheckResult(self)
 
1147
        mainline_parent_id = None
1320
1148
        last_revno, last_revision_id = self.last_revision_info()
1321
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1322
 
        if actual_revno != last_revno:
1323
 
            result.errors.append(errors.BzrCheckError(
1324
 
                'revno does not match len(mainline) %s != %s' % (
1325
 
                last_revno, actual_revno)))
1326
 
        # TODO: We should probably also check that self.revision_history
1327
 
        # matches the repository for older branch formats.
1328
 
        # If looking for the code that cross-checks repository parents against
1329
 
        # the iter_reverse_revision_history output, that is now a repository
1330
 
        # specific check.
1331
 
        return result
 
1149
        real_rev_history = []
 
1150
        try:
 
1151
            for revid in self.repository.iter_reverse_revision_history(
 
1152
                last_revision_id):
 
1153
                real_rev_history.append(revid)
 
1154
        except errors.RevisionNotPresent:
 
1155
            ret.ghosts_in_mainline = True
 
1156
        else:
 
1157
            ret.ghosts_in_mainline = False
 
1158
        real_rev_history.reverse()
 
1159
        if len(real_rev_history) != last_revno:
 
1160
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1161
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1162
        # TODO: We should probably also check that real_rev_history actually
 
1163
        #       matches self.revision_history()
 
1164
        for revision_id in real_rev_history:
 
1165
            try:
 
1166
                revision = self.repository.get_revision(revision_id)
 
1167
            except errors.NoSuchRevision, e:
 
1168
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1169
                            % revision_id)
 
1170
            # In general the first entry on the revision history has no parents.
 
1171
            # But it's not illegal for it to have parents listed; this can happen
 
1172
            # in imports from Arch when the parents weren't reachable.
 
1173
            if mainline_parent_id is not None:
 
1174
                if mainline_parent_id not in revision.parent_ids:
 
1175
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1176
                                        "parents of {%s}"
 
1177
                                        % (mainline_parent_id, revision_id))
 
1178
            mainline_parent_id = revision_id
 
1179
        return ret
1332
1180
 
1333
1181
    def _get_checkout_format(self):
1334
1182
        """Return the most suitable metadir for a checkout of this branch.
1359
1207
        # clone call. Or something. 20090224 RBC/spiv.
1360
1208
        if revision_id is None:
1361
1209
            revision_id = self.last_revision()
1362
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1363
 
            revision_id=revision_id, stacked_on=stacked_on,
1364
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1210
        try:
 
1211
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1212
                revision_id=revision_id, stacked_on=stacked_on,
 
1213
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1214
        except errors.FileExists:
 
1215
            if not use_existing_dir:
 
1216
                raise
 
1217
        except errors.NoSuchFile:
 
1218
            if not create_prefix:
 
1219
                raise
1365
1220
        return dir_to.open_branch()
1366
1221
 
1367
1222
    def create_checkout(self, to_location, revision_id=None,
1386
1241
        if lightweight:
1387
1242
            format = self._get_checkout_format()
1388
1243
            checkout = format.initialize_on_transport(t)
1389
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1390
 
                target_branch=self)
 
1244
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1391
1245
        else:
1392
1246
            format = self._get_checkout_format()
1393
1247
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1435
1289
    def supports_tags(self):
1436
1290
        return self._format.supports_tags()
1437
1291
 
1438
 
    def automatic_tag_name(self, revision_id):
1439
 
        """Try to automatically find the tag name for a revision.
1440
 
 
1441
 
        :param revision_id: Revision id of the revision.
1442
 
        :return: A tag name or None if no tag name could be determined.
1443
 
        """
1444
 
        for hook in Branch.hooks['automatic_tag_name']:
1445
 
            ret = hook(self, revision_id)
1446
 
            if ret is not None:
1447
 
                return ret
1448
 
        return None
1449
 
 
1450
1292
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1451
1293
                                         other_branch):
1452
1294
        """Ensure that revision_b is a descendant of revision_a.
1507
1349
    _formats = {}
1508
1350
    """The known formats."""
1509
1351
 
1510
 
    can_set_append_revisions_only = True
1511
 
 
1512
1352
    def __eq__(self, other):
1513
1353
        return self.__class__ is other.__class__
1514
1354
 
1516
1356
        return not (self == other)
1517
1357
 
1518
1358
    @classmethod
1519
 
    def find_format(klass, a_bzrdir, name=None):
 
1359
    def find_format(klass, a_bzrdir):
1520
1360
        """Return the format for the branch object in a_bzrdir."""
1521
1361
        try:
1522
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1523
 
            format_string = transport.get_bytes("format")
 
1362
            transport = a_bzrdir.get_branch_transport(None)
 
1363
            format_string = transport.get("format").read()
1524
1364
            return klass._formats[format_string]
1525
1365
        except errors.NoSuchFile:
1526
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1366
            raise errors.NotBranchError(path=transport.base)
1527
1367
        except KeyError:
1528
1368
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1529
1369
 
1565
1405
        """Return the short format description for this format."""
1566
1406
        raise NotImplementedError(self.get_format_description)
1567
1407
 
1568
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1569
 
        hooks = Branch.hooks['post_branch_init']
1570
 
        if not hooks:
1571
 
            return
1572
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1573
 
        for hook in hooks:
1574
 
            hook(params)
1575
 
 
1576
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1577
 
                           lock_type='metadir', set_format=True):
 
1408
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1409
                           set_format=True):
1578
1410
        """Initialize a branch in a bzrdir, with specified files
1579
1411
 
1580
1412
        :param a_bzrdir: The bzrdir to initialize the branch in
1581
1413
        :param utf8_files: The files to create as a list of
1582
1414
            (filename, content) tuples
1583
 
        :param name: Name of colocated branch to create, if any
1584
1415
        :param set_format: If True, set the format with
1585
1416
            self.get_format_string.  (BzrBranch4 has its format set
1586
1417
            elsewhere)
1587
1418
        :return: a branch in this format
1588
1419
        """
1589
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1590
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1420
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1421
        branch_transport = a_bzrdir.get_branch_transport(self)
1591
1422
        lock_map = {
1592
1423
            'metadir': ('lock', lockdir.LockDir),
1593
1424
            'branch4': ('branch-lock', lockable_files.TransportLock),
1614
1445
        finally:
1615
1446
            if lock_taken:
1616
1447
                control_files.unlock()
1617
 
        branch = self.open(a_bzrdir, name, _found=True)
1618
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1619
 
        return branch
 
1448
        return self.open(a_bzrdir, _found=True)
1620
1449
 
1621
 
    def initialize(self, a_bzrdir, name=None):
1622
 
        """Create a branch of this format in a_bzrdir.
1623
 
        
1624
 
        :param name: Name of the colocated branch to create.
1625
 
        """
 
1450
    def initialize(self, a_bzrdir):
 
1451
        """Create a branch of this format in a_bzrdir."""
1626
1452
        raise NotImplementedError(self.initialize)
1627
1453
 
1628
1454
    def is_supported(self):
1658
1484
        """
1659
1485
        raise NotImplementedError(self.network_name)
1660
1486
 
1661
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1487
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1662
1488
        """Return the branch object for a_bzrdir
1663
1489
 
1664
1490
        :param a_bzrdir: A BzrDir that contains a branch.
1665
 
        :param name: Name of colocated branch to open
1666
1491
        :param _found: a private parameter, do not use it. It is used to
1667
1492
            indicate if format probing has already be done.
1668
1493
        :param ignore_fallbacks: when set, no fallback branches will be opened
1682
1507
    def set_default_format(klass, format):
1683
1508
        klass._default_format = format
1684
1509
 
1685
 
    def supports_set_append_revisions_only(self):
1686
 
        """True if this format supports set_append_revisions_only."""
1687
 
        return False
1688
 
 
1689
1510
    def supports_stacking(self):
1690
1511
        """True if this format records a stacked-on branch."""
1691
1512
        return False
1776
1597
            "multiple hooks installed for transform_fallback_location, "
1777
1598
            "all are called with the url returned from the previous hook."
1778
1599
            "The order is however undefined.", (1, 9), None))
1779
 
        self.create_hook(HookPoint('automatic_tag_name',
1780
 
            "Called to determine an automatic tag name for a revision."
1781
 
            "automatic_tag_name is called with (branch, revision_id) and "
1782
 
            "should return a tag name or None if no tag name could be "
1783
 
            "determined. The first non-None tag name returned will be used.",
1784
 
            (2, 2), None))
1785
 
        self.create_hook(HookPoint('post_branch_init',
1786
 
            "Called after new branch initialization completes. "
1787
 
            "post_branch_init is called with a "
1788
 
            "bzrlib.branch.BranchInitHookParams. "
1789
 
            "Note that init, branch and checkout (both heavyweight and "
1790
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1791
 
        self.create_hook(HookPoint('post_switch',
1792
 
            "Called after a checkout switches branch. "
1793
 
            "post_switch is called with a "
1794
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1795
 
 
1796
1600
 
1797
1601
 
1798
1602
# install the default hooks into the Branch class.
1837
1641
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1838
1642
 
1839
1643
 
1840
 
class BranchInitHookParams(object):
1841
 
    """Object holding parameters passed to *_branch_init hooks.
1842
 
 
1843
 
    There are 4 fields that hooks may wish to access:
1844
 
 
1845
 
    :ivar format: the branch format
1846
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
 
    :ivar name: name of colocated branch, if any (or None)
1848
 
    :ivar branch: the branch created
1849
 
 
1850
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
 
    the checkout, hence they are different from the corresponding fields in
1852
 
    branch, which refer to the original branch.
1853
 
    """
1854
 
 
1855
 
    def __init__(self, format, a_bzrdir, name, branch):
1856
 
        """Create a group of BranchInitHook parameters.
1857
 
 
1858
 
        :param format: the branch format
1859
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1860
 
            initialized
1861
 
        :param name: name of colocated branch, if any (or None)
1862
 
        :param branch: the branch created
1863
 
 
1864
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1865
 
        to the checkout, hence they are different from the corresponding fields
1866
 
        in branch, which refer to the original branch.
1867
 
        """
1868
 
        self.format = format
1869
 
        self.bzrdir = a_bzrdir
1870
 
        self.name = name
1871
 
        self.branch = branch
1872
 
 
1873
 
    def __eq__(self, other):
1874
 
        return self.__dict__ == other.__dict__
1875
 
 
1876
 
    def __repr__(self):
1877
 
        if self.branch:
1878
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1879
 
        else:
1880
 
            return "<%s of format:%s bzrdir:%s>" % (
1881
 
                self.__class__.__name__, self.branch,
1882
 
                self.format, self.bzrdir)
1883
 
 
1884
 
 
1885
 
class SwitchHookParams(object):
1886
 
    """Object holding parameters passed to *_switch hooks.
1887
 
 
1888
 
    There are 4 fields that hooks may wish to access:
1889
 
 
1890
 
    :ivar control_dir: BzrDir of the checkout to change
1891
 
    :ivar to_branch: branch that the checkout is to reference
1892
 
    :ivar force: skip the check for local commits in a heavy checkout
1893
 
    :ivar revision_id: revision ID to switch to (or None)
1894
 
    """
1895
 
 
1896
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1897
 
        """Create a group of SwitchHook parameters.
1898
 
 
1899
 
        :param control_dir: BzrDir of the checkout to change
1900
 
        :param to_branch: branch that the checkout is to reference
1901
 
        :param force: skip the check for local commits in a heavy checkout
1902
 
        :param revision_id: revision ID to switch to (or None)
1903
 
        """
1904
 
        self.control_dir = control_dir
1905
 
        self.to_branch = to_branch
1906
 
        self.force = force
1907
 
        self.revision_id = revision_id
1908
 
 
1909
 
    def __eq__(self, other):
1910
 
        return self.__dict__ == other.__dict__
1911
 
 
1912
 
    def __repr__(self):
1913
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
 
            self.control_dir, self.to_branch,
1915
 
            self.revision_id)
1916
 
 
1917
 
 
1918
1644
class BzrBranchFormat4(BranchFormat):
1919
1645
    """Bzr branch format 4.
1920
1646
 
1927
1653
        """See BranchFormat.get_format_description()."""
1928
1654
        return "Branch format 4"
1929
1655
 
1930
 
    def initialize(self, a_bzrdir, name=None):
 
1656
    def initialize(self, a_bzrdir):
1931
1657
        """Create a branch of this format in a_bzrdir."""
1932
1658
        utf8_files = [('revision-history', ''),
1933
1659
                      ('branch-name', ''),
1934
1660
                      ]
1935
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1661
        return self._initialize_helper(a_bzrdir, utf8_files,
1936
1662
                                       lock_type='branch4', set_format=False)
1937
1663
 
1938
1664
    def __init__(self):
1943
1669
        """The network name for this format is the control dirs disk label."""
1944
1670
        return self._matchingbzrdir.get_format_string()
1945
1671
 
1946
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1672
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1947
1673
        """See BranchFormat.open()."""
1948
1674
        if not _found:
1949
1675
            # we are being called directly and must probe.
1951
1677
        return BzrBranch(_format=self,
1952
1678
                         _control_files=a_bzrdir._control_files,
1953
1679
                         a_bzrdir=a_bzrdir,
1954
 
                         name=name,
1955
1680
                         _repository=a_bzrdir.open_repository())
1956
1681
 
1957
1682
    def __str__(self):
1972
1697
        """
1973
1698
        return self.get_format_string()
1974
1699
 
1975
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1700
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1976
1701
        """See BranchFormat.open()."""
1977
1702
        if not _found:
1978
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1703
            format = BranchFormat.find_format(a_bzrdir)
1979
1704
            if format.__class__ != self.__class__:
1980
1705
                raise AssertionError("wrong format %r found for %r" %
1981
1706
                    (format, self))
1982
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1983
1707
        try:
 
1708
            transport = a_bzrdir.get_branch_transport(None)
1984
1709
            control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1710
                                                         lockdir.LockDir)
1986
1711
            return self._branch_class()(_format=self,
1987
1712
                              _control_files=control_files,
1988
 
                              name=name,
1989
1713
                              a_bzrdir=a_bzrdir,
1990
1714
                              _repository=a_bzrdir.find_repository(),
1991
1715
                              ignore_fallbacks=ignore_fallbacks)
1992
1716
        except errors.NoSuchFile:
1993
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1717
            raise errors.NotBranchError(path=transport.base)
1994
1718
 
1995
1719
    def __init__(self):
1996
1720
        super(BranchFormatMetadir, self).__init__()
2025
1749
        """See BranchFormat.get_format_description()."""
2026
1750
        return "Branch format 5"
2027
1751
 
2028
 
    def initialize(self, a_bzrdir, name=None):
 
1752
    def initialize(self, a_bzrdir):
2029
1753
        """Create a branch of this format in a_bzrdir."""
2030
1754
        utf8_files = [('revision-history', ''),
2031
1755
                      ('branch-name', ''),
2032
1756
                      ]
2033
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1757
        return self._initialize_helper(a_bzrdir, utf8_files)
2034
1758
 
2035
1759
    def supports_tags(self):
2036
1760
        return False
2058
1782
        """See BranchFormat.get_format_description()."""
2059
1783
        return "Branch format 6"
2060
1784
 
2061
 
    def initialize(self, a_bzrdir, name=None):
 
1785
    def initialize(self, a_bzrdir):
2062
1786
        """Create a branch of this format in a_bzrdir."""
2063
1787
        utf8_files = [('last-revision', '0 null:\n'),
2064
1788
                      ('branch.conf', ''),
2065
1789
                      ('tags', ''),
2066
1790
                      ]
2067
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1791
        return self._initialize_helper(a_bzrdir, utf8_files)
2068
1792
 
2069
1793
    def make_tags(self, branch):
2070
1794
        """See bzrlib.branch.BranchFormat.make_tags()."""
2071
1795
        return BasicTags(branch)
2072
1796
 
2073
 
    def supports_set_append_revisions_only(self):
2074
 
        return True
2075
1797
 
2076
1798
 
2077
1799
class BzrBranchFormat8(BranchFormatMetadir):
2088
1810
        """See BranchFormat.get_format_description()."""
2089
1811
        return "Branch format 8"
2090
1812
 
2091
 
    def initialize(self, a_bzrdir, name=None):
 
1813
    def initialize(self, a_bzrdir):
2092
1814
        """Create a branch of this format in a_bzrdir."""
2093
1815
        utf8_files = [('last-revision', '0 null:\n'),
2094
1816
                      ('branch.conf', ''),
2095
1817
                      ('tags', ''),
2096
1818
                      ('references', '')
2097
1819
                      ]
2098
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1820
        return self._initialize_helper(a_bzrdir, utf8_files)
2099
1821
 
2100
1822
    def __init__(self):
2101
1823
        super(BzrBranchFormat8, self).__init__()
2106
1828
        """See bzrlib.branch.BranchFormat.make_tags()."""
2107
1829
        return BasicTags(branch)
2108
1830
 
2109
 
    def supports_set_append_revisions_only(self):
2110
 
        return True
2111
 
 
2112
1831
    def supports_stacking(self):
2113
1832
        return True
2114
1833
 
2124
1843
    This format was introduced in bzr 1.6.
2125
1844
    """
2126
1845
 
2127
 
    def initialize(self, a_bzrdir, name=None):
 
1846
    def initialize(self, a_bzrdir):
2128
1847
        """Create a branch of this format in a_bzrdir."""
2129
1848
        utf8_files = [('last-revision', '0 null:\n'),
2130
1849
                      ('branch.conf', ''),
2131
1850
                      ('tags', ''),
2132
1851
                      ]
2133
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1852
        return self._initialize_helper(a_bzrdir, utf8_files)
2134
1853
 
2135
1854
    def _branch_class(self):
2136
1855
        return BzrBranch7
2143
1862
        """See BranchFormat.get_format_description()."""
2144
1863
        return "Branch format 7"
2145
1864
 
2146
 
    def supports_set_append_revisions_only(self):
2147
 
        return True
2148
 
 
2149
1865
    supports_reference_locations = False
2150
1866
 
2151
1867
 
2171
1887
    def get_reference(self, a_bzrdir):
2172
1888
        """See BranchFormat.get_reference()."""
2173
1889
        transport = a_bzrdir.get_branch_transport(None)
2174
 
        return transport.get_bytes('location')
 
1890
        return transport.get('location').read()
2175
1891
 
2176
1892
    def set_reference(self, a_bzrdir, to_branch):
2177
1893
        """See BranchFormat.set_reference()."""
2178
1894
        transport = a_bzrdir.get_branch_transport(None)
2179
1895
        location = transport.put_bytes('location', to_branch.base)
2180
1896
 
2181
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1897
    def initialize(self, a_bzrdir, target_branch=None):
2182
1898
        """Create a branch of this format in a_bzrdir."""
2183
1899
        if target_branch is None:
2184
1900
            # this format does not implement branch itself, thus the implicit
2185
1901
            # creation contract must see it as uninitializable
2186
1902
            raise errors.UninitializableFormat(self)
2187
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2188
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1903
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1904
        branch_transport = a_bzrdir.get_branch_transport(self)
2189
1905
        branch_transport.put_bytes('location',
2190
 
            target_branch.bzrdir.user_url)
 
1906
            target_branch.bzrdir.root_transport.base)
2191
1907
        branch_transport.put_bytes('format', self.get_format_string())
2192
 
        branch = self.open(
2193
 
            a_bzrdir, name, _found=True,
 
1908
        return self.open(
 
1909
            a_bzrdir, _found=True,
2194
1910
            possible_transports=[target_branch.bzrdir.root_transport])
2195
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2196
 
        return branch
2197
1911
 
2198
1912
    def __init__(self):
2199
1913
        super(BranchReferenceFormat, self).__init__()
2205
1919
        def clone(to_bzrdir, revision_id=None,
2206
1920
            repository_policy=None):
2207
1921
            """See Branch.clone()."""
2208
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1922
            return format.initialize(to_bzrdir, a_branch)
2209
1923
            # cannot obey revision_id limits when cloning a reference ...
2210
1924
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2211
1925
            # emit some sort of warning/error to the caller ?!
2212
1926
        return clone
2213
1927
 
2214
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1928
    def open(self, a_bzrdir, _found=False, location=None,
2215
1929
             possible_transports=None, ignore_fallbacks=False):
2216
1930
        """Return the branch that the branch reference in a_bzrdir points at.
2217
1931
 
2218
1932
        :param a_bzrdir: A BzrDir that contains a branch.
2219
 
        :param name: Name of colocated branch to open, if any
2220
1933
        :param _found: a private parameter, do not use it. It is used to
2221
1934
            indicate if format probing has already be done.
2222
1935
        :param ignore_fallbacks: when set, no fallback branches will be opened
2227
1940
        :param possible_transports: An optional reusable transports list.
2228
1941
        """
2229
1942
        if not _found:
2230
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1943
            format = BranchFormat.find_format(a_bzrdir)
2231
1944
            if format.__class__ != self.__class__:
2232
1945
                raise AssertionError("wrong format %r found for %r" %
2233
1946
                    (format, self))
2235
1948
            location = self.get_reference(a_bzrdir)
2236
1949
        real_bzrdir = bzrdir.BzrDir.open(
2237
1950
            location, possible_transports=possible_transports)
2238
 
        result = real_bzrdir.open_branch(name=name, 
2239
 
            ignore_fallbacks=ignore_fallbacks)
 
1951
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2240
1952
        # this changes the behaviour of result.clone to create a new reference
2241
1953
        # rather than a copy of the content of the branch.
2242
1954
        # I did not use a proxy object because that needs much more extensive
2269
1981
BranchFormat.register_format(__format6)
2270
1982
BranchFormat.register_format(__format7)
2271
1983
BranchFormat.register_format(__format8)
2272
 
BranchFormat.set_default_format(__format7)
 
1984
BranchFormat.set_default_format(__format6)
2273
1985
_legacy_formats = [BzrBranchFormat4(),
2274
1986
    ]
2275
1987
network_format_registry.register(
2276
1988
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2277
1989
 
2278
1990
 
2279
 
class BranchWriteLockResult(object):
2280
 
    """The result of write locking a branch.
2281
 
 
2282
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2283
 
        None.
2284
 
    :ivar unlock: A callable which will unlock the lock.
2285
 
    """
2286
 
 
2287
 
    def __init__(self, unlock, branch_token):
2288
 
        self.branch_token = branch_token
2289
 
        self.unlock = unlock
2290
 
 
2291
 
    def __str__(self):
2292
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2293
 
            self.unlock)
2294
 
 
2295
 
 
2296
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1991
class BzrBranch(Branch):
2297
1992
    """A branch stored in the actual filesystem.
2298
1993
 
2299
1994
    Note that it's "local" in the context of the filesystem; it doesn't
2305
2000
    :ivar repository: Repository for this branch.
2306
2001
    :ivar base: The url of the base directory for this branch; the one
2307
2002
        containing the .bzr directory.
2308
 
    :ivar name: Optional colocated branch name as it exists in the control
2309
 
        directory.
2310
2003
    """
2311
2004
 
2312
2005
    def __init__(self, _format=None,
2313
 
                 _control_files=None, a_bzrdir=None, name=None,
2314
 
                 _repository=None, ignore_fallbacks=False):
 
2006
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2007
                 ignore_fallbacks=False):
2315
2008
        """Create new branch object at a particular location."""
2316
2009
        if a_bzrdir is None:
2317
2010
            raise ValueError('a_bzrdir must be supplied')
2318
2011
        else:
2319
2012
            self.bzrdir = a_bzrdir
2320
2013
        self._base = self.bzrdir.transport.clone('..').base
2321
 
        self.name = name
2322
2014
        # XXX: We should be able to just do
2323
2015
        #   self.base = self.bzrdir.root_transport.base
2324
2016
        # but this does not quite work yet -- mbp 20080522
2331
2023
        Branch.__init__(self)
2332
2024
 
2333
2025
    def __str__(self):
2334
 
        if self.name is None:
2335
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2336
 
        else:
2337
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2338
 
                self.name)
 
2026
        return '%s(%r)' % (self.__class__.__name__, self.base)
2339
2027
 
2340
2028
    __repr__ = __str__
2341
2029
 
2352
2040
        return self.control_files.is_locked()
2353
2041
 
2354
2042
    def lock_write(self, token=None):
2355
 
        """Lock the branch for write operations.
2356
 
 
2357
 
        :param token: A token to permit reacquiring a previously held and
2358
 
            preserved lock.
2359
 
        :return: A BranchWriteLockResult.
2360
 
        """
2361
 
        if not self.is_locked():
2362
 
            self._note_lock('w')
2363
2043
        # All-in-one needs to always unlock/lock.
2364
2044
        repo_control = getattr(self.repository, 'control_files', None)
2365
2045
        if self.control_files == repo_control or not self.is_locked():
2366
 
            self.repository._warn_if_deprecated(self)
2367
2046
            self.repository.lock_write()
2368
2047
            took_lock = True
2369
2048
        else:
2370
2049
            took_lock = False
2371
2050
        try:
2372
 
            return BranchWriteLockResult(self.unlock,
2373
 
                self.control_files.lock_write(token=token))
 
2051
            return self.control_files.lock_write(token=token)
2374
2052
        except:
2375
2053
            if took_lock:
2376
2054
                self.repository.unlock()
2377
2055
            raise
2378
2056
 
2379
2057
    def lock_read(self):
2380
 
        """Lock the branch for read operations.
2381
 
 
2382
 
        :return: An object with an unlock method which will release the lock
2383
 
            obtained.
2384
 
        """
2385
 
        if not self.is_locked():
2386
 
            self._note_lock('r')
2387
2058
        # All-in-one needs to always unlock/lock.
2388
2059
        repo_control = getattr(self.repository, 'control_files', None)
2389
2060
        if self.control_files == repo_control or not self.is_locked():
2390
 
            self.repository._warn_if_deprecated(self)
2391
2061
            self.repository.lock_read()
2392
2062
            took_lock = True
2393
2063
        else:
2394
2064
            took_lock = False
2395
2065
        try:
2396
2066
            self.control_files.lock_read()
2397
 
            return self
2398
2067
        except:
2399
2068
            if took_lock:
2400
2069
                self.repository.unlock()
2401
2070
            raise
2402
2071
 
2403
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2404
2072
    def unlock(self):
2405
2073
        try:
2406
2074
            self.control_files.unlock()
2569
2237
        return result
2570
2238
 
2571
2239
    def get_stacked_on_url(self):
2572
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2240
        raise errors.UnstackableBranchFormat(self._format, self.base)
2573
2241
 
2574
2242
    def set_push_location(self, location):
2575
2243
        """See Branch.set_push_location."""
2708
2376
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2709
2377
        super(BzrBranch8, self).__init__(*args, **kwargs)
2710
2378
        self._last_revision_info_cache = None
 
2379
        self._partial_revision_history_cache = []
2711
2380
        self._reference_info = None
2712
2381
 
2713
2382
    def _clear_cached_state(self):
2714
2383
        super(BzrBranch8, self)._clear_cached_state()
2715
2384
        self._last_revision_info_cache = None
 
2385
        self._partial_revision_history_cache = []
2716
2386
        self._reference_info = None
2717
2387
 
2718
2388
    def _last_revision_info(self):
2765
2435
        if _mod_revision.is_null(last_revision):
2766
2436
            return
2767
2437
        if last_revision not in self._lefthand_history(revision_id):
2768
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2438
            raise errors.AppendRevisionsOnlyViolation(self.base)
2769
2439
 
2770
2440
    def _gen_revision_history(self):
2771
2441
        """Generate the revision history from last revision
2774
2444
        self._extend_partial_history(stop_index=last_revno-1)
2775
2445
        return list(reversed(self._partial_revision_history_cache))
2776
2446
 
 
2447
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2448
        """Extend the partial history to include a given index
 
2449
 
 
2450
        If a stop_index is supplied, stop when that index has been reached.
 
2451
        If a stop_revision is supplied, stop when that revision is
 
2452
        encountered.  Otherwise, stop when the beginning of history is
 
2453
        reached.
 
2454
 
 
2455
        :param stop_index: The index which should be present.  When it is
 
2456
            present, history extension will stop.
 
2457
        :param revision_id: The revision id which should be present.  When
 
2458
            it is encountered, history extension will stop.
 
2459
        """
 
2460
        repo = self.repository
 
2461
        if len(self._partial_revision_history_cache) == 0:
 
2462
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2463
        else:
 
2464
            start_revision = self._partial_revision_history_cache[-1]
 
2465
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2466
            #skip the last revision in the list
 
2467
            next_revision = iterator.next()
 
2468
        for revision_id in iterator:
 
2469
            self._partial_revision_history_cache.append(revision_id)
 
2470
            if (stop_index is not None and
 
2471
                len(self._partial_revision_history_cache) > stop_index):
 
2472
                break
 
2473
            if revision_id == stop_revision:
 
2474
                break
 
2475
 
2777
2476
    def _write_revision_history(self, history):
2778
2477
        """Factored out of set_revision_history.
2779
2478
 
2871
2570
        if branch_location is None:
2872
2571
            return Branch.reference_parent(self, file_id, path,
2873
2572
                                           possible_transports)
2874
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2573
        branch_location = urlutils.join(self.base, branch_location)
2875
2574
        return Branch.open(branch_location,
2876
2575
                           possible_transports=possible_transports)
2877
2576
 
2922
2621
            raise errors.NotStacked(self)
2923
2622
        return stacked_url
2924
2623
 
 
2624
    def set_append_revisions_only(self, enabled):
 
2625
        if enabled:
 
2626
            value = 'True'
 
2627
        else:
 
2628
            value = 'False'
 
2629
        self.get_config().set_user_option('append_revisions_only', value,
 
2630
            warn_masked=True)
 
2631
 
2925
2632
    def _get_append_revisions_only(self):
2926
 
        return self.get_config(
2927
 
            ).get_user_option_as_bool('append_revisions_only')
 
2633
        value = self.get_config().get_user_option('append_revisions_only')
 
2634
        return value == 'True'
2928
2635
 
2929
2636
    @needs_write_lock
2930
2637
    def generate_revision_history(self, revision_id, last_rev=None,
2992
2699
    """
2993
2700
 
2994
2701
    def get_stacked_on_url(self):
2995
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2702
        raise errors.UnstackableBranchFormat(self._format, self.base)
2996
2703
 
2997
2704
 
2998
2705
######################################################################
3077
2784
 
3078
2785
    def __init__(self, branch):
3079
2786
        self.branch = branch
3080
 
        self.errors = []
 
2787
        self.ghosts_in_mainline = False
3081
2788
 
3082
2789
    def report_results(self, verbose):
3083
2790
        """Report the check results via trace.note.
3085
2792
        :param verbose: Requests more detailed display of what was checked,
3086
2793
            if any.
3087
2794
        """
3088
 
        note('checked branch %s format %s', self.branch.user_url,
3089
 
            self.branch._format)
3090
 
        for error in self.errors:
3091
 
            note('found error:%s', error)
 
2795
        note('checked branch %s format %s',
 
2796
             self.branch.base,
 
2797
             self.branch._format)
 
2798
        if self.ghosts_in_mainline:
 
2799
            note('branch contains ghosts in mainline')
3092
2800
 
3093
2801
 
3094
2802
class Converter5to6(object):
3189
2897
    @staticmethod
3190
2898
    def _get_branch_formats_to_test():
3191
2899
        """Return a tuple with the Branch formats to use when testing."""
3192
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
2900
        raise NotImplementedError(self._get_branch_formats_to_test)
3193
2901
 
3194
2902
    def pull(self, overwrite=False, stop_revision=None,
3195
2903
             possible_transports=None, local=False):
3350
3058
                _override_hook_source_branch=_override_hook_source_branch)
3351
3059
        finally:
3352
3060
            self.source.unlock()
 
3061
        return result
3353
3062
 
3354
3063
    def _push_with_bound_branches(self, overwrite, stop_revision,
3355
3064
            _override_hook_source_branch=None):
3420
3129
        if local and not bound_location:
3421
3130
            raise errors.LocalRequiresBoundBranch()
3422
3131
        master_branch = None
3423
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3132
        if not local and bound_location and self.source.base != bound_location:
3424
3133
            # not pulling from master, so we need to update master.
3425
3134
            master_branch = self.target.get_master_branch(possible_transports)
3426
3135
            master_branch.lock_write()