/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

Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
46
46
    )
47
47
""")
48
48
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
50
from bzrlib.hooks import HookPoint, Hooks
51
51
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
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()
100
101
    def _open_hook(self):
101
102
        """Called by init to allow simpler extension of the base class."""
102
103
 
103
 
    def _activate_fallback_location(self, url):
 
104
    def _activate_fallback_location(self, url, lock_style):
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)
 
107
        if lock_style == 'write':
 
108
            repo.lock_write()
 
109
        elif lock_style == 'read':
 
110
            repo.lock_read()
108
111
        self.repository.add_fallback_repository(repo)
109
112
 
110
113
    def break_lock(self):
126
129
            raise errors.UnstackableRepositoryFormat(self.repository._format,
127
130
                self.repository.base)
128
131
 
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
132
    @staticmethod
159
133
    def open(base, _unsupported=False, possible_transports=None):
160
134
        """Open the branch rooted at base.
164
138
        """
165
139
        control = bzrdir.BzrDir.open(base, _unsupported,
166
140
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
141
        return control.open_branch(_unsupported)
168
142
 
169
143
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
144
    def open_from_transport(transport, _unsupported=False):
171
145
        """Open the branch rooted at transport"""
172
146
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
147
        return control.open_branch(_unsupported)
174
148
 
175
149
    @staticmethod
176
150
    def open_containing(url, possible_transports=None):
214
188
    def _get_fallback_repository(self, url):
215
189
        """Get the repository we fallback to at url."""
216
190
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
191
        a_bzrdir = bzrdir.BzrDir.open(url,
218
192
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
193
        return a_bzrdir.open_branch().repository
220
194
 
221
195
    def _get_tags_bytes(self):
222
196
        """Get the bytes of a serialised tags dict.
283
257
        new_history.reverse()
284
258
        return new_history
285
259
 
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
 
        """
 
260
    def lock_write(self):
293
261
        raise NotImplementedError(self.lock_write)
294
262
 
295
263
    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
264
        raise NotImplementedError(self.lock_read)
302
265
 
303
266
    def unlock(self):
428
391
            * 'include' - the stop revision is the last item in the result
429
392
            * 'with-merges' - include the stop revision and all of its
430
393
              merged revisions in the result
431
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
432
 
              that are in both ancestries
433
394
        :param direction: either 'reverse' or 'forward':
434
395
            * reverse means return the start_revision_id first, i.e.
435
396
              start at the most recent revision and go backwards in history
457
418
        # start_revision_id.
458
419
        if self._merge_sorted_revisions_cache is None:
459
420
            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)
 
421
            graph = self.repository.get_graph()
 
422
            parent_map = dict(((key, value) for key, value in
 
423
                     graph.iter_ancestry([last_revision]) if value is not None))
 
424
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
425
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
426
                generate_revno=True)
 
427
            # Drop the sequence # before caching
 
428
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
429
 
464
430
        filtered = self._filter_merge_sorted_revisions(
465
431
            self._merge_sorted_revisions_cache, start_revision_id,
466
432
            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
433
        if direction == 'reverse':
471
434
            return filtered
472
435
        if direction == 'forward':
479
442
        """Iterate over an inclusive range of sorted revisions."""
480
443
        rev_iter = iter(merge_sorted_revisions)
481
444
        if start_revision_id is not None:
482
 
            for node in rev_iter:
483
 
                rev_id = node.key[-1]
 
445
            for rev_id, depth, revno, end_of_merge in rev_iter:
484
446
                if rev_id != start_revision_id:
485
447
                    continue
486
448
                else:
487
449
                    # The decision to include the start or not
488
450
                    # 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)
 
451
                    rev_iter = chain(
 
452
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
453
                        rev_iter)
491
454
                    break
492
455
        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)
 
456
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
457
                yield rev_id, depth, revno, end_of_merge
498
458
        elif stop_rule == 'exclude':
499
 
            for node in rev_iter:
500
 
                rev_id = node.key[-1]
 
459
            for rev_id, depth, revno, end_of_merge in rev_iter:
501
460
                if rev_id == stop_revision_id:
502
461
                    return
503
 
                yield (rev_id, node.merge_depth, node.revno,
504
 
                       node.end_of_merge)
 
462
                yield rev_id, depth, revno, end_of_merge
505
463
        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)
 
464
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
465
                yield rev_id, depth, revno, end_of_merge
510
466
                if rev_id == stop_revision_id:
511
467
                    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
468
        elif stop_rule == 'with-merges':
525
469
            stop_rev = self.repository.get_revision(stop_revision_id)
526
470
            if stop_rev.parent_ids:
527
471
                left_parent = stop_rev.parent_ids[0]
528
472
            else:
529
473
                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]
 
474
            for rev_id, depth, revno, end_of_merge in rev_iter:
536
475
                if rev_id == left_parent:
537
 
                    # reached the left parent after the stop_revision
538
476
                    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)
 
477
                yield rev_id, depth, revno, end_of_merge
549
478
        else:
550
479
            raise ValueError('invalid stop_rule %r' % stop_rule)
551
480
 
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
481
    def leave_lock_in_place(self):
598
482
        """Tell this branch object not to release the physical lock when this
599
483
        object is unlocked.
616
500
        :param other: The branch to bind to
617
501
        :type other: Branch
618
502
        """
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)
 
503
        raise errors.UpgradeRequired(self.base)
630
504
 
631
505
    def set_reference_info(self, file_id, tree_path, branch_location):
632
506
        """Set the branch location to use for a tree reference."""
674
548
    def get_old_bound_location(self):
675
549
        """Return the URL of the branch we used to be bound to
676
550
        """
677
 
        raise errors.UpgradeRequired(self.user_url)
 
551
        raise errors.UpgradeRequired(self.base)
678
552
 
679
553
    def get_commit_builder(self, parents, config=None, timestamp=None,
680
554
                           timezone=None, committer=None, revprops=None,
758
632
            stacking.
759
633
        """
760
634
        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.
 
635
            raise errors.UnstackableBranchFormat(self._format, self.base)
765
636
        self._check_stackable_repo()
766
637
        if not url:
767
638
            try:
769
640
            except (errors.NotStacked, errors.UnstackableBranchFormat,
770
641
                errors.UnstackableRepositoryFormat):
771
642
                return
772
 
            self._unstack()
 
643
            url = ''
 
644
            # XXX: Lock correctness - should unlock our old repo if we were
 
645
            # locked.
 
646
            # repositories don't offer an interface to remove fallback
 
647
            # repositories today; take the conceptually simpler option and just
 
648
            # reopen it.
 
649
            self.repository = self.bzrdir.find_repository()
 
650
            self.repository.lock_write()
 
651
            # for every revision reference the branch has, ensure it is pulled
 
652
            # in.
 
653
            source_repository = self._get_fallback_repository(old_url)
 
654
            for revision_id in chain([self.last_revision()],
 
655
                self.tags.get_reverse_tag_dict()):
 
656
                self.repository.fetch(source_repository, revision_id,
 
657
                    find_ghosts=True)
773
658
        else:
774
 
            self._activate_fallback_location(url)
 
659
            self._activate_fallback_location(url, 'write')
775
660
        # write this out after the repository is stacked to avoid setting a
776
661
        # stacked config that doesn't work.
777
662
        self._set_config_location('stacked_on_location', url)
778
663
 
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
664
 
834
665
    def _set_tags_bytes(self, bytes):
835
666
        """Mirror method for _get_tags_bytes.
871
702
        self._revision_id_to_revno_cache = None
872
703
        self._last_revision_info_cache = None
873
704
        self._merge_sorted_revisions_cache = None
874
 
        self._partial_revision_history_cache = []
875
 
        self._partial_revision_id_to_revno_cache = {}
876
705
 
877
706
    def _gen_revision_history(self):
878
707
        """Return sequence of revision hashes on to this branch.
915
744
 
916
745
    def unbind(self):
917
746
        """Older format branches cannot bind or unbind."""
918
 
        raise errors.UpgradeRequired(self.user_url)
 
747
        raise errors.UpgradeRequired(self.base)
 
748
 
 
749
    def set_append_revisions_only(self, enabled):
 
750
        """Older format branches are never restricted to append-only"""
 
751
        raise errors.UpgradeRequired(self.base)
919
752
 
920
753
    def last_revision(self):
921
754
        """Return last revision id, or NULL_REVISION."""
1002
835
        except ValueError:
1003
836
            raise errors.NoSuchRevision(self, revision_id)
1004
837
 
1005
 
    @needs_read_lock
1006
838
    def get_rev_id(self, revno, history=None):
1007
839
        """Find the revision id of the specified revno."""
1008
840
        if revno == 0:
1009
841
            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:
 
842
        if history is None:
 
843
            history = self.revision_history()
 
844
        if revno <= 0 or revno > len(history):
1014
845
            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]
 
846
        return history[revno - 1]
1019
847
 
1020
848
    @needs_write_lock
1021
849
    def pull(self, source, overwrite=False, stop_revision=None,
1049
877
 
1050
878
        :param target: Target branch
1051
879
        :param stop_revision: Revision to push, defaults to last revision.
1052
 
        :return: BranchPushResult with an extra member revidmap: 
1053
 
            A dictionary mapping revision ids from the target branch 
 
880
        :return: Dictionary mapping revision ids from the target branch 
1054
881
            to new revision ids in the target branch, for each 
1055
882
            revision that was pushed.
1056
883
        """
1081
908
        try:
1082
909
            return urlutils.join(self.base[:-1], parent)
1083
910
        except errors.InvalidURLJoin, e:
1084
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
911
            raise errors.InaccessibleParent(parent, self.base)
1085
912
 
1086
913
    def _get_parent_location(self):
1087
914
        raise NotImplementedError(self._get_parent_location)
1104
931
            location = None
1105
932
        return location
1106
933
 
1107
 
    def get_child_submit_format(self):
1108
 
        """Return the preferred format of submissions to this branch."""
1109
 
        return self.get_config().get_user_option("child_submit_format")
1110
 
 
1111
934
    def get_submit_branch(self):
1112
935
        """Return the submit location of the branch.
1113
936
 
1172
995
        params = ChangeBranchTipParams(
1173
996
            self, old_revno, new_revno, old_revid, new_revid)
1174
997
        for hook in hooks:
1175
 
            hook(params)
 
998
            try:
 
999
                hook(params)
 
1000
            except errors.TipChangeRejected:
 
1001
                raise
 
1002
            except Exception:
 
1003
                exc_info = sys.exc_info()
 
1004
                hook_name = Branch.hooks.get_hook_name(hook)
 
1005
                raise errors.HookFailed(
 
1006
                    'pre_change_branch_tip', hook_name, exc_info)
1176
1007
 
1177
1008
    @needs_write_lock
1178
1009
    def update(self):
1227
1058
        revision_id: if not None, the revision history in the new branch will
1228
1059
                     be truncated to end with revision_id.
1229
1060
        """
1230
 
        if (repository_policy is not None and
1231
 
            repository_policy.requires_stacking()):
1232
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1233
1061
        result = to_bzrdir.create_branch()
1234
1062
        result.lock_write()
1235
1063
        try:
1256
1084
        source_revno, source_revision_id = self.last_revision_info()
1257
1085
        if revision_id is None:
1258
1086
            revno, revision_id = source_revno, source_revision_id
 
1087
        elif source_revision_id == revision_id:
 
1088
            # we know the revno without needing to walk all of history
 
1089
            revno = source_revno
1259
1090
        else:
1260
 
            graph = self.repository.get_graph()
1261
 
            try:
1262
 
                revno = graph.find_distance_to_null(revision_id, 
1263
 
                    [(source_revision_id, source_revno)])
1264
 
            except errors.GhostRevisionsHaveNoRevno:
1265
 
                # Default to 1, if we can't find anything else
1266
 
                revno = 1
 
1091
            # To figure out the revno for a random revision, we need to build
 
1092
            # the revision history, and count its length.
 
1093
            # We don't care about the order, just how long it is.
 
1094
            # Alternatively, we could start at the current location, and count
 
1095
            # backwards. But there is no guarantee that we will find it since
 
1096
            # it may be a merged revision.
 
1097
            revno = len(list(self.repository.iter_reverse_revision_history(
 
1098
                                                                revision_id)))
1267
1099
        destination.set_last_revision_info(revno, revision_id)
1268
1100
 
1269
1101
    @needs_read_lock
1303
1135
        target._set_all_reference_info(target_reference_dict)
1304
1136
 
1305
1137
    @needs_read_lock
1306
 
    def check(self, refs):
 
1138
    def check(self):
1307
1139
        """Check consistency of the branch.
1308
1140
 
1309
1141
        In particular this checks that revisions given in the revision-history
1312
1144
 
1313
1145
        Callers will typically also want to check the repository.
1314
1146
 
1315
 
        :param refs: Calculated refs for this branch as specified by
1316
 
            branch._get_check_refs()
1317
1147
        :return: A BranchCheckResult.
1318
1148
        """
1319
 
        result = BranchCheckResult(self)
 
1149
        mainline_parent_id = None
1320
1150
        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
 
1151
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
1152
                                last_revision_id))
 
1153
        real_rev_history.reverse()
 
1154
        if len(real_rev_history) != last_revno:
 
1155
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1156
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1157
        # TODO: We should probably also check that real_rev_history actually
 
1158
        #       matches self.revision_history()
 
1159
        for revision_id in real_rev_history:
 
1160
            try:
 
1161
                revision = self.repository.get_revision(revision_id)
 
1162
            except errors.NoSuchRevision, e:
 
1163
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1164
                            % revision_id)
 
1165
            # In general the first entry on the revision history has no parents.
 
1166
            # But it's not illegal for it to have parents listed; this can happen
 
1167
            # in imports from Arch when the parents weren't reachable.
 
1168
            if mainline_parent_id is not None:
 
1169
                if mainline_parent_id not in revision.parent_ids:
 
1170
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1171
                                        "parents of {%s}"
 
1172
                                        % (mainline_parent_id, revision_id))
 
1173
            mainline_parent_id = revision_id
 
1174
        return BranchCheckResult(self)
1332
1175
 
1333
1176
    def _get_checkout_format(self):
1334
1177
        """Return the most suitable metadir for a checkout of this branch.
1359
1202
        # clone call. Or something. 20090224 RBC/spiv.
1360
1203
        if revision_id is None:
1361
1204
            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)
 
1205
        try:
 
1206
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1207
                revision_id=revision_id, stacked_on=stacked_on,
 
1208
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1209
        except errors.FileExists:
 
1210
            if not use_existing_dir:
 
1211
                raise
 
1212
        except errors.NoSuchFile:
 
1213
            if not create_prefix:
 
1214
                raise
1365
1215
        return dir_to.open_branch()
1366
1216
 
1367
1217
    def create_checkout(self, to_location, revision_id=None,
1386
1236
        if lightweight:
1387
1237
            format = self._get_checkout_format()
1388
1238
            checkout = format.initialize_on_transport(t)
1389
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1390
 
                target_branch=self)
 
1239
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1391
1240
        else:
1392
1241
            format = self._get_checkout_format()
1393
1242
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1435
1284
    def supports_tags(self):
1436
1285
        return self._format.supports_tags()
1437
1286
 
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
1287
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1451
1288
                                         other_branch):
1452
1289
        """Ensure that revision_b is a descendant of revision_a.
1507
1344
    _formats = {}
1508
1345
    """The known formats."""
1509
1346
 
1510
 
    can_set_append_revisions_only = True
1511
 
 
1512
1347
    def __eq__(self, other):
1513
1348
        return self.__class__ is other.__class__
1514
1349
 
1516
1351
        return not (self == other)
1517
1352
 
1518
1353
    @classmethod
1519
 
    def find_format(klass, a_bzrdir, name=None):
 
1354
    def find_format(klass, a_bzrdir):
1520
1355
        """Return the format for the branch object in a_bzrdir."""
1521
1356
        try:
1522
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1523
 
            format_string = transport.get_bytes("format")
 
1357
            transport = a_bzrdir.get_branch_transport(None)
 
1358
            format_string = transport.get("format").read()
1524
1359
            return klass._formats[format_string]
1525
1360
        except errors.NoSuchFile:
1526
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1361
            raise errors.NotBranchError(path=transport.base)
1527
1362
        except KeyError:
1528
1363
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1529
1364
 
1565
1400
        """Return the short format description for this format."""
1566
1401
        raise NotImplementedError(self.get_format_description)
1567
1402
 
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):
 
1403
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1404
                           set_format=True):
1578
1405
        """Initialize a branch in a bzrdir, with specified files
1579
1406
 
1580
1407
        :param a_bzrdir: The bzrdir to initialize the branch in
1581
1408
        :param utf8_files: The files to create as a list of
1582
1409
            (filename, content) tuples
1583
 
        :param name: Name of colocated branch to create, if any
1584
1410
        :param set_format: If True, set the format with
1585
1411
            self.get_format_string.  (BzrBranch4 has its format set
1586
1412
            elsewhere)
1587
1413
        :return: a branch in this format
1588
1414
        """
1589
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1590
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1415
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1416
        branch_transport = a_bzrdir.get_branch_transport(self)
1591
1417
        lock_map = {
1592
1418
            'metadir': ('lock', lockdir.LockDir),
1593
1419
            'branch4': ('branch-lock', lockable_files.TransportLock),
1614
1440
        finally:
1615
1441
            if lock_taken:
1616
1442
                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
 
1443
        return self.open(a_bzrdir, _found=True)
1620
1444
 
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
 
        """
 
1445
    def initialize(self, a_bzrdir):
 
1446
        """Create a branch of this format in a_bzrdir."""
1626
1447
        raise NotImplementedError(self.initialize)
1627
1448
 
1628
1449
    def is_supported(self):
1658
1479
        """
1659
1480
        raise NotImplementedError(self.network_name)
1660
1481
 
1661
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1482
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1662
1483
        """Return the branch object for a_bzrdir
1663
1484
 
1664
1485
        :param a_bzrdir: A BzrDir that contains a branch.
1665
 
        :param name: Name of colocated branch to open
1666
1486
        :param _found: a private parameter, do not use it. It is used to
1667
1487
            indicate if format probing has already be done.
1668
1488
        :param ignore_fallbacks: when set, no fallback branches will be opened
1682
1502
    def set_default_format(klass, format):
1683
1503
        klass._default_format = format
1684
1504
 
1685
 
    def supports_set_append_revisions_only(self):
1686
 
        """True if this format supports set_append_revisions_only."""
1687
 
        return False
1688
 
 
1689
1505
    def supports_stacking(self):
1690
1506
        """True if this format records a stacked-on branch."""
1691
1507
        return False
1776
1592
            "multiple hooks installed for transform_fallback_location, "
1777
1593
            "all are called with the url returned from the previous hook."
1778
1594
            "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
1595
 
1797
1596
 
1798
1597
# install the default hooks into the Branch class.
1837
1636
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1838
1637
 
1839
1638
 
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
1639
class BzrBranchFormat4(BranchFormat):
1919
1640
    """Bzr branch format 4.
1920
1641
 
1927
1648
        """See BranchFormat.get_format_description()."""
1928
1649
        return "Branch format 4"
1929
1650
 
1930
 
    def initialize(self, a_bzrdir, name=None):
 
1651
    def initialize(self, a_bzrdir):
1931
1652
        """Create a branch of this format in a_bzrdir."""
1932
1653
        utf8_files = [('revision-history', ''),
1933
1654
                      ('branch-name', ''),
1934
1655
                      ]
1935
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1656
        return self._initialize_helper(a_bzrdir, utf8_files,
1936
1657
                                       lock_type='branch4', set_format=False)
1937
1658
 
1938
1659
    def __init__(self):
1943
1664
        """The network name for this format is the control dirs disk label."""
1944
1665
        return self._matchingbzrdir.get_format_string()
1945
1666
 
1946
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1667
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1947
1668
        """See BranchFormat.open()."""
1948
1669
        if not _found:
1949
1670
            # we are being called directly and must probe.
1951
1672
        return BzrBranch(_format=self,
1952
1673
                         _control_files=a_bzrdir._control_files,
1953
1674
                         a_bzrdir=a_bzrdir,
1954
 
                         name=name,
1955
1675
                         _repository=a_bzrdir.open_repository())
1956
1676
 
1957
1677
    def __str__(self):
1972
1692
        """
1973
1693
        return self.get_format_string()
1974
1694
 
1975
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1695
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1976
1696
        """See BranchFormat.open()."""
1977
1697
        if not _found:
1978
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1698
            format = BranchFormat.find_format(a_bzrdir)
1979
1699
            if format.__class__ != self.__class__:
1980
1700
                raise AssertionError("wrong format %r found for %r" %
1981
1701
                    (format, self))
1982
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1983
1702
        try:
 
1703
            transport = a_bzrdir.get_branch_transport(None)
1984
1704
            control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1705
                                                         lockdir.LockDir)
1986
1706
            return self._branch_class()(_format=self,
1987
1707
                              _control_files=control_files,
1988
 
                              name=name,
1989
1708
                              a_bzrdir=a_bzrdir,
1990
1709
                              _repository=a_bzrdir.find_repository(),
1991
1710
                              ignore_fallbacks=ignore_fallbacks)
1992
1711
        except errors.NoSuchFile:
1993
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1712
            raise errors.NotBranchError(path=transport.base)
1994
1713
 
1995
1714
    def __init__(self):
1996
1715
        super(BranchFormatMetadir, self).__init__()
2025
1744
        """See BranchFormat.get_format_description()."""
2026
1745
        return "Branch format 5"
2027
1746
 
2028
 
    def initialize(self, a_bzrdir, name=None):
 
1747
    def initialize(self, a_bzrdir):
2029
1748
        """Create a branch of this format in a_bzrdir."""
2030
1749
        utf8_files = [('revision-history', ''),
2031
1750
                      ('branch-name', ''),
2032
1751
                      ]
2033
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1752
        return self._initialize_helper(a_bzrdir, utf8_files)
2034
1753
 
2035
1754
    def supports_tags(self):
2036
1755
        return False
2058
1777
        """See BranchFormat.get_format_description()."""
2059
1778
        return "Branch format 6"
2060
1779
 
2061
 
    def initialize(self, a_bzrdir, name=None):
 
1780
    def initialize(self, a_bzrdir):
2062
1781
        """Create a branch of this format in a_bzrdir."""
2063
1782
        utf8_files = [('last-revision', '0 null:\n'),
2064
1783
                      ('branch.conf', ''),
2065
1784
                      ('tags', ''),
2066
1785
                      ]
2067
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1786
        return self._initialize_helper(a_bzrdir, utf8_files)
2068
1787
 
2069
1788
    def make_tags(self, branch):
2070
1789
        """See bzrlib.branch.BranchFormat.make_tags()."""
2071
1790
        return BasicTags(branch)
2072
1791
 
2073
 
    def supports_set_append_revisions_only(self):
2074
 
        return True
2075
1792
 
2076
1793
 
2077
1794
class BzrBranchFormat8(BranchFormatMetadir):
2088
1805
        """See BranchFormat.get_format_description()."""
2089
1806
        return "Branch format 8"
2090
1807
 
2091
 
    def initialize(self, a_bzrdir, name=None):
 
1808
    def initialize(self, a_bzrdir):
2092
1809
        """Create a branch of this format in a_bzrdir."""
2093
1810
        utf8_files = [('last-revision', '0 null:\n'),
2094
1811
                      ('branch.conf', ''),
2095
1812
                      ('tags', ''),
2096
1813
                      ('references', '')
2097
1814
                      ]
2098
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1815
        return self._initialize_helper(a_bzrdir, utf8_files)
2099
1816
 
2100
1817
    def __init__(self):
2101
1818
        super(BzrBranchFormat8, self).__init__()
2106
1823
        """See bzrlib.branch.BranchFormat.make_tags()."""
2107
1824
        return BasicTags(branch)
2108
1825
 
2109
 
    def supports_set_append_revisions_only(self):
2110
 
        return True
2111
 
 
2112
1826
    def supports_stacking(self):
2113
1827
        return True
2114
1828
 
2124
1838
    This format was introduced in bzr 1.6.
2125
1839
    """
2126
1840
 
2127
 
    def initialize(self, a_bzrdir, name=None):
 
1841
    def initialize(self, a_bzrdir):
2128
1842
        """Create a branch of this format in a_bzrdir."""
2129
1843
        utf8_files = [('last-revision', '0 null:\n'),
2130
1844
                      ('branch.conf', ''),
2131
1845
                      ('tags', ''),
2132
1846
                      ]
2133
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1847
        return self._initialize_helper(a_bzrdir, utf8_files)
2134
1848
 
2135
1849
    def _branch_class(self):
2136
1850
        return BzrBranch7
2143
1857
        """See BranchFormat.get_format_description()."""
2144
1858
        return "Branch format 7"
2145
1859
 
2146
 
    def supports_set_append_revisions_only(self):
2147
 
        return True
2148
 
 
2149
1860
    supports_reference_locations = False
2150
1861
 
2151
1862
 
2171
1882
    def get_reference(self, a_bzrdir):
2172
1883
        """See BranchFormat.get_reference()."""
2173
1884
        transport = a_bzrdir.get_branch_transport(None)
2174
 
        return transport.get_bytes('location')
 
1885
        return transport.get('location').read()
2175
1886
 
2176
1887
    def set_reference(self, a_bzrdir, to_branch):
2177
1888
        """See BranchFormat.set_reference()."""
2178
1889
        transport = a_bzrdir.get_branch_transport(None)
2179
1890
        location = transport.put_bytes('location', to_branch.base)
2180
1891
 
2181
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1892
    def initialize(self, a_bzrdir, target_branch=None):
2182
1893
        """Create a branch of this format in a_bzrdir."""
2183
1894
        if target_branch is None:
2184
1895
            # this format does not implement branch itself, thus the implicit
2185
1896
            # creation contract must see it as uninitializable
2186
1897
            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)
 
1898
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1899
        branch_transport = a_bzrdir.get_branch_transport(self)
2189
1900
        branch_transport.put_bytes('location',
2190
 
            target_branch.bzrdir.user_url)
 
1901
            target_branch.bzrdir.root_transport.base)
2191
1902
        branch_transport.put_bytes('format', self.get_format_string())
2192
 
        branch = self.open(
2193
 
            a_bzrdir, name, _found=True,
 
1903
        return self.open(
 
1904
            a_bzrdir, _found=True,
2194
1905
            possible_transports=[target_branch.bzrdir.root_transport])
2195
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2196
 
        return branch
2197
1906
 
2198
1907
    def __init__(self):
2199
1908
        super(BranchReferenceFormat, self).__init__()
2205
1914
        def clone(to_bzrdir, revision_id=None,
2206
1915
            repository_policy=None):
2207
1916
            """See Branch.clone()."""
2208
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1917
            return format.initialize(to_bzrdir, a_branch)
2209
1918
            # cannot obey revision_id limits when cloning a reference ...
2210
1919
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2211
1920
            # emit some sort of warning/error to the caller ?!
2212
1921
        return clone
2213
1922
 
2214
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1923
    def open(self, a_bzrdir, _found=False, location=None,
2215
1924
             possible_transports=None, ignore_fallbacks=False):
2216
1925
        """Return the branch that the branch reference in a_bzrdir points at.
2217
1926
 
2218
1927
        :param a_bzrdir: A BzrDir that contains a branch.
2219
 
        :param name: Name of colocated branch to open, if any
2220
1928
        :param _found: a private parameter, do not use it. It is used to
2221
1929
            indicate if format probing has already be done.
2222
1930
        :param ignore_fallbacks: when set, no fallback branches will be opened
2227
1935
        :param possible_transports: An optional reusable transports list.
2228
1936
        """
2229
1937
        if not _found:
2230
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1938
            format = BranchFormat.find_format(a_bzrdir)
2231
1939
            if format.__class__ != self.__class__:
2232
1940
                raise AssertionError("wrong format %r found for %r" %
2233
1941
                    (format, self))
2235
1943
            location = self.get_reference(a_bzrdir)
2236
1944
        real_bzrdir = bzrdir.BzrDir.open(
2237
1945
            location, possible_transports=possible_transports)
2238
 
        result = real_bzrdir.open_branch(name=name, 
2239
 
            ignore_fallbacks=ignore_fallbacks)
 
1946
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2240
1947
        # this changes the behaviour of result.clone to create a new reference
2241
1948
        # rather than a copy of the content of the branch.
2242
1949
        # I did not use a proxy object because that needs much more extensive
2269
1976
BranchFormat.register_format(__format6)
2270
1977
BranchFormat.register_format(__format7)
2271
1978
BranchFormat.register_format(__format8)
2272
 
BranchFormat.set_default_format(__format7)
 
1979
BranchFormat.set_default_format(__format6)
2273
1980
_legacy_formats = [BzrBranchFormat4(),
2274
1981
    ]
2275
1982
network_format_registry.register(
2276
1983
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2277
1984
 
2278
1985
 
2279
 
class BranchWriteLockResult(object):
2280
 
    """The result of write locking a branch.
2281
 
 
2282
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2283
 
        None.
2284
 
    :ivar unlock: A callable which will unlock the lock.
2285
 
    """
2286
 
 
2287
 
    def __init__(self, unlock, branch_token):
2288
 
        self.branch_token = branch_token
2289
 
        self.unlock = unlock
2290
 
 
2291
 
 
2292
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1986
class BzrBranch(Branch):
2293
1987
    """A branch stored in the actual filesystem.
2294
1988
 
2295
1989
    Note that it's "local" in the context of the filesystem; it doesn't
2301
1995
    :ivar repository: Repository for this branch.
2302
1996
    :ivar base: The url of the base directory for this branch; the one
2303
1997
        containing the .bzr directory.
2304
 
    :ivar name: Optional colocated branch name as it exists in the control
2305
 
        directory.
2306
1998
    """
2307
1999
 
2308
2000
    def __init__(self, _format=None,
2309
 
                 _control_files=None, a_bzrdir=None, name=None,
2310
 
                 _repository=None, ignore_fallbacks=False):
 
2001
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2002
                 ignore_fallbacks=False):
2311
2003
        """Create new branch object at a particular location."""
2312
2004
        if a_bzrdir is None:
2313
2005
            raise ValueError('a_bzrdir must be supplied')
2314
2006
        else:
2315
2007
            self.bzrdir = a_bzrdir
2316
2008
        self._base = self.bzrdir.transport.clone('..').base
2317
 
        self.name = name
2318
2009
        # XXX: We should be able to just do
2319
2010
        #   self.base = self.bzrdir.root_transport.base
2320
2011
        # but this does not quite work yet -- mbp 20080522
2327
2018
        Branch.__init__(self)
2328
2019
 
2329
2020
    def __str__(self):
2330
 
        if self.name is None:
2331
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2332
 
        else:
2333
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2334
 
                self.name)
 
2021
        return '%s(%r)' % (self.__class__.__name__, self.base)
2335
2022
 
2336
2023
    __repr__ = __str__
2337
2024
 
2348
2035
        return self.control_files.is_locked()
2349
2036
 
2350
2037
    def lock_write(self, token=None):
2351
 
        """Lock the branch for write operations.
2352
 
 
2353
 
        :param token: A token to permit reacquiring a previously held and
2354
 
            preserved lock.
2355
 
        :return: A BranchWriteLockResult.
2356
 
        """
2357
 
        if not self.is_locked():
2358
 
            self._note_lock('w')
2359
2038
        # All-in-one needs to always unlock/lock.
2360
2039
        repo_control = getattr(self.repository, 'control_files', None)
2361
2040
        if self.control_files == repo_control or not self.is_locked():
2362
 
            self.repository._warn_if_deprecated(self)
2363
2041
            self.repository.lock_write()
2364
2042
            took_lock = True
2365
2043
        else:
2366
2044
            took_lock = False
2367
2045
        try:
2368
 
            return BranchWriteLockResult(self.unlock,
2369
 
                self.control_files.lock_write(token=token))
 
2046
            return self.control_files.lock_write(token=token)
2370
2047
        except:
2371
2048
            if took_lock:
2372
2049
                self.repository.unlock()
2373
2050
            raise
2374
2051
 
2375
2052
    def lock_read(self):
2376
 
        """Lock the branch for read operations.
2377
 
 
2378
 
        :return: An object with an unlock method which will release the lock
2379
 
            obtained.
2380
 
        """
2381
 
        if not self.is_locked():
2382
 
            self._note_lock('r')
2383
2053
        # All-in-one needs to always unlock/lock.
2384
2054
        repo_control = getattr(self.repository, 'control_files', None)
2385
2055
        if self.control_files == repo_control or not self.is_locked():
2386
 
            self.repository._warn_if_deprecated(self)
2387
2056
            self.repository.lock_read()
2388
2057
            took_lock = True
2389
2058
        else:
2390
2059
            took_lock = False
2391
2060
        try:
2392
2061
            self.control_files.lock_read()
2393
 
            return self
2394
2062
        except:
2395
2063
            if took_lock:
2396
2064
                self.repository.unlock()
2397
2065
            raise
2398
2066
 
2399
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2400
2067
    def unlock(self):
2401
2068
        try:
2402
2069
            self.control_files.unlock()
2565
2232
        return result
2566
2233
 
2567
2234
    def get_stacked_on_url(self):
2568
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2235
        raise errors.UnstackableBranchFormat(self._format, self.base)
2569
2236
 
2570
2237
    def set_push_location(self, location):
2571
2238
        """See Branch.set_push_location."""
2698
2365
                    raise AssertionError(
2699
2366
                        "'transform_fallback_location' hook %s returned "
2700
2367
                        "None, not a URL." % hook_name)
2701
 
            self._activate_fallback_location(url)
 
2368
            self._activate_fallback_location(url, None)
2702
2369
 
2703
2370
    def __init__(self, *args, **kwargs):
2704
2371
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2705
2372
        super(BzrBranch8, self).__init__(*args, **kwargs)
2706
2373
        self._last_revision_info_cache = None
 
2374
        self._partial_revision_history_cache = []
2707
2375
        self._reference_info = None
2708
2376
 
2709
2377
    def _clear_cached_state(self):
2710
2378
        super(BzrBranch8, self)._clear_cached_state()
2711
2379
        self._last_revision_info_cache = None
 
2380
        self._partial_revision_history_cache = []
2712
2381
        self._reference_info = None
2713
2382
 
2714
2383
    def _last_revision_info(self):
2761
2430
        if _mod_revision.is_null(last_revision):
2762
2431
            return
2763
2432
        if last_revision not in self._lefthand_history(revision_id):
2764
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2433
            raise errors.AppendRevisionsOnlyViolation(self.base)
2765
2434
 
2766
2435
    def _gen_revision_history(self):
2767
2436
        """Generate the revision history from last revision
2770
2439
        self._extend_partial_history(stop_index=last_revno-1)
2771
2440
        return list(reversed(self._partial_revision_history_cache))
2772
2441
 
 
2442
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2443
        """Extend the partial history to include a given index
 
2444
 
 
2445
        If a stop_index is supplied, stop when that index has been reached.
 
2446
        If a stop_revision is supplied, stop when that revision is
 
2447
        encountered.  Otherwise, stop when the beginning of history is
 
2448
        reached.
 
2449
 
 
2450
        :param stop_index: The index which should be present.  When it is
 
2451
            present, history extension will stop.
 
2452
        :param revision_id: The revision id which should be present.  When
 
2453
            it is encountered, history extension will stop.
 
2454
        """
 
2455
        repo = self.repository
 
2456
        if len(self._partial_revision_history_cache) == 0:
 
2457
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2458
        else:
 
2459
            start_revision = self._partial_revision_history_cache[-1]
 
2460
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2461
            #skip the last revision in the list
 
2462
            next_revision = iterator.next()
 
2463
        for revision_id in iterator:
 
2464
            self._partial_revision_history_cache.append(revision_id)
 
2465
            if (stop_index is not None and
 
2466
                len(self._partial_revision_history_cache) > stop_index):
 
2467
                break
 
2468
            if revision_id == stop_revision:
 
2469
                break
 
2470
 
2773
2471
    def _write_revision_history(self, history):
2774
2472
        """Factored out of set_revision_history.
2775
2473
 
2867
2565
        if branch_location is None:
2868
2566
            return Branch.reference_parent(self, file_id, path,
2869
2567
                                           possible_transports)
2870
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2568
        branch_location = urlutils.join(self.base, branch_location)
2871
2569
        return Branch.open(branch_location,
2872
2570
                           possible_transports=possible_transports)
2873
2571
 
2918
2616
            raise errors.NotStacked(self)
2919
2617
        return stacked_url
2920
2618
 
 
2619
    def set_append_revisions_only(self, enabled):
 
2620
        if enabled:
 
2621
            value = 'True'
 
2622
        else:
 
2623
            value = 'False'
 
2624
        self.get_config().set_user_option('append_revisions_only', value,
 
2625
            warn_masked=True)
 
2626
 
2921
2627
    def _get_append_revisions_only(self):
2922
 
        return self.get_config(
2923
 
            ).get_user_option_as_bool('append_revisions_only')
 
2628
        value = self.get_config().get_user_option('append_revisions_only')
 
2629
        return value == 'True'
2924
2630
 
2925
2631
    @needs_write_lock
2926
2632
    def generate_revision_history(self, revision_id, last_rev=None,
2988
2694
    """
2989
2695
 
2990
2696
    def get_stacked_on_url(self):
2991
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2697
        raise errors.UnstackableBranchFormat(self._format, self.base)
2992
2698
 
2993
2699
 
2994
2700
######################################################################
3073
2779
 
3074
2780
    def __init__(self, branch):
3075
2781
        self.branch = branch
3076
 
        self.errors = []
3077
2782
 
3078
2783
    def report_results(self, verbose):
3079
2784
        """Report the check results via trace.note.
3081
2786
        :param verbose: Requests more detailed display of what was checked,
3082
2787
            if any.
3083
2788
        """
3084
 
        note('checked branch %s format %s', self.branch.user_url,
3085
 
            self.branch._format)
3086
 
        for error in self.errors:
3087
 
            note('found error:%s', error)
 
2789
        note('checked branch %s format %s',
 
2790
             self.branch.base,
 
2791
             self.branch._format)
3088
2792
 
3089
2793
 
3090
2794
class Converter5to6(object):
3185
2889
    @staticmethod
3186
2890
    def _get_branch_formats_to_test():
3187
2891
        """Return a tuple with the Branch formats to use when testing."""
3188
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
2892
        raise NotImplementedError(self._get_branch_formats_to_test)
3189
2893
 
3190
2894
    def pull(self, overwrite=False, stop_revision=None,
3191
2895
             possible_transports=None, local=False):
3346
3050
                _override_hook_source_branch=_override_hook_source_branch)
3347
3051
        finally:
3348
3052
            self.source.unlock()
 
3053
        return result
3349
3054
 
3350
3055
    def _push_with_bound_branches(self, overwrite, stop_revision,
3351
3056
            _override_hook_source_branch=None):
3416
3121
        if local and not bound_location:
3417
3122
            raise errors.LocalRequiresBoundBranch()
3418
3123
        master_branch = None
3419
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3124
        if not local and bound_location and self.source.base != bound_location:
3420
3125
            # not pulling from master, so we need to update master.
3421
3126
            master_branch = self.target.get_master_branch(possible_transports)
3422
3127
            master_branch.lock_write()