/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Aaron Bentley
  • Date: 2009-05-11 19:11:14 UTC
  • mto: This revision was merged to the branch mainline in revision 4351.
  • Revision ID: aaron@aaronbentley.com-20090511191114-g0u190bdpfou9bbw
Gracefully handle mail clients that don't support bodies.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
46
46
    )
47
47
""")
48
48
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
50
from bzrlib.hooks import HookPoint, Hooks
51
51
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
52
from bzrlib import registry
54
53
from bzrlib.symbol_versioning import (
55
54
    deprecated_in,
63
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
63
 
65
64
 
66
 
class Branch(bzrdir.ControlComponent):
 
65
# TODO: Maybe include checks for common corruption of newlines, etc?
 
66
 
 
67
# TODO: Some operations like log might retrieve the same revisions
 
68
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
69
# cache in memory to make this faster.  In general anything can be
 
70
# cached in memory between lock and unlock operations. .. nb thats
 
71
# what the transaction identity map provides
 
72
 
 
73
 
 
74
######################################################################
 
75
# branch objects
 
76
 
 
77
class Branch(object):
67
78
    """Branch holding a history of revisions.
68
79
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
80
    base
 
81
        Base directory/url of the branch.
72
82
 
73
83
    hooks: An instance of BranchHooks.
74
84
    """
76
86
    # - RBC 20060112
77
87
    base = None
78
88
 
79
 
    @property
80
 
    def control_transport(self):
81
 
        return self._transport
82
 
 
83
 
    @property
84
 
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
86
 
 
87
89
    def __init__(self, *ignored, **ignored_too):
88
90
        self.tags = self._format.make_tags(self)
89
91
        self._revision_history_cache = None
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: A bzrlib.lock.LogicalLockResult.
299
 
        """
300
264
        raise NotImplementedError(self.lock_read)
301
265
 
302
266
    def unlock(self):
427
391
            * 'include' - the stop revision is the last item in the result
428
392
            * 'with-merges' - include the stop revision and all of its
429
393
              merged revisions in the result
430
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
431
 
              that are in both ancestries
432
394
        :param direction: either 'reverse' or 'forward':
433
395
            * reverse means return the start_revision_id first, i.e.
434
396
              start at the most recent revision and go backwards in history
456
418
        # start_revision_id.
457
419
        if self._merge_sorted_revisions_cache is None:
458
420
            last_revision = self.last_revision()
459
 
            known_graph = self.repository.get_known_graph_ancestry(
460
 
                [last_revision])
461
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
462
 
                last_revision)
 
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
 
463
430
        filtered = self._filter_merge_sorted_revisions(
464
431
            self._merge_sorted_revisions_cache, start_revision_id,
465
432
            stop_revision_id, stop_rule)
466
 
        # Make sure we don't return revisions that are not part of the
467
 
        # start_revision_id ancestry.
468
 
        filtered = self._filter_start_non_ancestors(filtered)
469
433
        if direction == 'reverse':
470
434
            return filtered
471
435
        if direction == 'forward':
478
442
        """Iterate over an inclusive range of sorted revisions."""
479
443
        rev_iter = iter(merge_sorted_revisions)
480
444
        if start_revision_id is not None:
481
 
            for node in rev_iter:
482
 
                rev_id = node.key[-1]
 
445
            for rev_id, depth, revno, end_of_merge in rev_iter:
483
446
                if rev_id != start_revision_id:
484
447
                    continue
485
448
                else:
486
449
                    # The decision to include the start or not
487
450
                    # depends on the stop_rule if a stop is provided
488
 
                    # so pop this node back into the iterator
489
 
                    rev_iter = chain(iter([node]), rev_iter)
 
451
                    rev_iter = chain(
 
452
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
453
                        rev_iter)
490
454
                    break
491
455
        if stop_revision_id is None:
492
 
            # Yield everything
493
 
            for node in rev_iter:
494
 
                rev_id = node.key[-1]
495
 
                yield (rev_id, node.merge_depth, node.revno,
496
 
                       node.end_of_merge)
 
456
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
457
                yield rev_id, depth, revno, end_of_merge
497
458
        elif stop_rule == 'exclude':
498
 
            for node in rev_iter:
499
 
                rev_id = node.key[-1]
 
459
            for rev_id, depth, revno, end_of_merge in rev_iter:
500
460
                if rev_id == stop_revision_id:
501
461
                    return
502
 
                yield (rev_id, node.merge_depth, node.revno,
503
 
                       node.end_of_merge)
 
462
                yield rev_id, depth, revno, end_of_merge
504
463
        elif stop_rule == 'include':
505
 
            for node in rev_iter:
506
 
                rev_id = node.key[-1]
507
 
                yield (rev_id, node.merge_depth, node.revno,
508
 
                       node.end_of_merge)
 
464
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
465
                yield rev_id, depth, revno, end_of_merge
509
466
                if rev_id == stop_revision_id:
510
467
                    return
511
 
        elif stop_rule == 'with-merges-without-common-ancestry':
512
 
            # We want to exclude all revisions that are already part of the
513
 
            # stop_revision_id ancestry.
514
 
            graph = self.repository.get_graph()
515
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
516
 
                                                    [stop_revision_id])
517
 
            for node in rev_iter:
518
 
                rev_id = node.key[-1]
519
 
                if rev_id not in ancestors:
520
 
                    continue
521
 
                yield (rev_id, node.merge_depth, node.revno,
522
 
                       node.end_of_merge)
523
468
        elif stop_rule == 'with-merges':
524
469
            stop_rev = self.repository.get_revision(stop_revision_id)
525
470
            if stop_rev.parent_ids:
526
471
                left_parent = stop_rev.parent_ids[0]
527
472
            else:
528
473
                left_parent = _mod_revision.NULL_REVISION
529
 
            # left_parent is the actual revision we want to stop logging at,
530
 
            # since we want to show the merged revisions after the stop_rev too
531
 
            reached_stop_revision_id = False
532
 
            revision_id_whitelist = []
533
 
            for node in rev_iter:
534
 
                rev_id = node.key[-1]
 
474
            for rev_id, depth, revno, end_of_merge in rev_iter:
535
475
                if rev_id == left_parent:
536
 
                    # reached the left parent after the stop_revision
537
476
                    return
538
 
                if (not reached_stop_revision_id or
539
 
                        rev_id in revision_id_whitelist):
540
 
                    yield (rev_id, node.merge_depth, node.revno,
541
 
                       node.end_of_merge)
542
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
543
 
                        # only do the merged revs of rev_id from now on
544
 
                        rev = self.repository.get_revision(rev_id)
545
 
                        if rev.parent_ids:
546
 
                            reached_stop_revision_id = True
547
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
477
                yield rev_id, depth, revno, end_of_merge
548
478
        else:
549
479
            raise ValueError('invalid stop_rule %r' % stop_rule)
550
480
 
551
 
    def _filter_start_non_ancestors(self, rev_iter):
552
 
        # If we started from a dotted revno, we want to consider it as a tip
553
 
        # and don't want to yield revisions that are not part of its
554
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
555
 
        # uninteresting descendants of the first parent of our tip before the
556
 
        # tip itself.
557
 
        first = rev_iter.next()
558
 
        (rev_id, merge_depth, revno, end_of_merge) = first
559
 
        yield first
560
 
        if not merge_depth:
561
 
            # We start at a mainline revision so by definition, all others
562
 
            # revisions in rev_iter are ancestors
563
 
            for node in rev_iter:
564
 
                yield node
565
 
 
566
 
        clean = False
567
 
        whitelist = set()
568
 
        pmap = self.repository.get_parent_map([rev_id])
569
 
        parents = pmap.get(rev_id, [])
570
 
        if parents:
571
 
            whitelist.update(parents)
572
 
        else:
573
 
            # If there is no parents, there is nothing of interest left
574
 
 
575
 
            # FIXME: It's hard to test this scenario here as this code is never
576
 
            # called in that case. -- vila 20100322
577
 
            return
578
 
 
579
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
580
 
            if not clean:
581
 
                if rev_id in whitelist:
582
 
                    pmap = self.repository.get_parent_map([rev_id])
583
 
                    parents = pmap.get(rev_id, [])
584
 
                    whitelist.remove(rev_id)
585
 
                    whitelist.update(parents)
586
 
                    if merge_depth == 0:
587
 
                        # We've reached the mainline, there is nothing left to
588
 
                        # filter
589
 
                        clean = True
590
 
                else:
591
 
                    # A revision that is not part of the ancestry of our
592
 
                    # starting revision.
593
 
                    continue
594
 
            yield (rev_id, merge_depth, revno, end_of_merge)
595
 
 
596
481
    def leave_lock_in_place(self):
597
482
        """Tell this branch object not to release the physical lock when this
598
483
        object is unlocked.
615
500
        :param other: The branch to bind to
616
501
        :type other: Branch
617
502
        """
618
 
        raise errors.UpgradeRequired(self.user_url)
619
 
 
620
 
    def set_append_revisions_only(self, enabled):
621
 
        if not self._format.supports_set_append_revisions_only():
622
 
            raise errors.UpgradeRequired(self.user_url)
623
 
        if enabled:
624
 
            value = 'True'
625
 
        else:
626
 
            value = 'False'
627
 
        self.get_config().set_user_option('append_revisions_only', value,
628
 
            warn_masked=True)
 
503
        raise errors.UpgradeRequired(self.base)
629
504
 
630
505
    def set_reference_info(self, file_id, tree_path, branch_location):
631
506
        """Set the branch location to use for a tree reference."""
673
548
    def get_old_bound_location(self):
674
549
        """Return the URL of the branch we used to be bound to
675
550
        """
676
 
        raise errors.UpgradeRequired(self.user_url)
 
551
        raise errors.UpgradeRequired(self.base)
677
552
 
678
553
    def get_commit_builder(self, parents, config=None, timestamp=None,
679
554
                           timezone=None, committer=None, revprops=None,
757
632
            stacking.
758
633
        """
759
634
        if not self._format.supports_stacking():
760
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
761
 
        # XXX: Changing from one fallback repository to another does not check
762
 
        # that all the data you need is present in the new fallback.
763
 
        # Possibly it should.
 
635
            raise errors.UnstackableBranchFormat(self._format, self.base)
764
636
        self._check_stackable_repo()
765
637
        if not url:
766
638
            try:
768
640
            except (errors.NotStacked, errors.UnstackableBranchFormat,
769
641
                errors.UnstackableRepositoryFormat):
770
642
                return
771
 
            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)
772
658
        else:
773
 
            self._activate_fallback_location(url)
 
659
            self._activate_fallback_location(url, 'write')
774
660
        # write this out after the repository is stacked to avoid setting a
775
661
        # stacked config that doesn't work.
776
662
        self._set_config_location('stacked_on_location', url)
777
663
 
778
 
    def _unstack(self):
779
 
        """Change a branch to be unstacked, copying data as needed.
780
 
        
781
 
        Don't call this directly, use set_stacked_on_url(None).
782
 
        """
783
 
        pb = ui.ui_factory.nested_progress_bar()
784
 
        try:
785
 
            pb.update("Unstacking")
786
 
            # The basic approach here is to fetch the tip of the branch,
787
 
            # including all available ghosts, from the existing stacked
788
 
            # repository into a new repository object without the fallbacks. 
789
 
            #
790
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
791
 
            # correct for CHKMap repostiories
792
 
            old_repository = self.repository
793
 
            if len(old_repository._fallback_repositories) != 1:
794
 
                raise AssertionError("can't cope with fallback repositories "
795
 
                    "of %r" % (self.repository,))
796
 
            # unlock it, including unlocking the fallback
797
 
            old_repository.unlock()
798
 
            old_repository.lock_read()
799
 
            try:
800
 
                # Repositories don't offer an interface to remove fallback
801
 
                # repositories today; take the conceptually simpler option and just
802
 
                # reopen it.  We reopen it starting from the URL so that we
803
 
                # get a separate connection for RemoteRepositories and can
804
 
                # stream from one of them to the other.  This does mean doing
805
 
                # separate SSH connection setup, but unstacking is not a
806
 
                # common operation so it's tolerable.
807
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
808
 
                new_repository = new_bzrdir.find_repository()
809
 
                self.repository = new_repository
810
 
                if self.repository._fallback_repositories:
811
 
                    raise AssertionError("didn't expect %r to have "
812
 
                        "fallback_repositories"
813
 
                        % (self.repository,))
814
 
                # this is not paired with an unlock because it's just restoring
815
 
                # the previous state; the lock's released when set_stacked_on_url
816
 
                # returns
817
 
                self.repository.lock_write()
818
 
                # XXX: If you unstack a branch while it has a working tree
819
 
                # with a pending merge, the pending-merged revisions will no
820
 
                # longer be present.  You can (probably) revert and remerge.
821
 
                #
822
 
                # XXX: This only fetches up to the tip of the repository; it
823
 
                # doesn't bring across any tags.  That's fairly consistent
824
 
                # with how branch works, but perhaps not ideal.
825
 
                self.repository.fetch(old_repository,
826
 
                    revision_id=self.last_revision(),
827
 
                    find_ghosts=True)
828
 
            finally:
829
 
                old_repository.unlock()
830
 
        finally:
831
 
            pb.finished()
832
664
 
833
665
    def _set_tags_bytes(self, bytes):
834
666
        """Mirror method for _get_tags_bytes.
870
702
        self._revision_id_to_revno_cache = None
871
703
        self._last_revision_info_cache = None
872
704
        self._merge_sorted_revisions_cache = None
873
 
        self._partial_revision_history_cache = []
874
 
        self._partial_revision_id_to_revno_cache = {}
875
705
 
876
706
    def _gen_revision_history(self):
877
707
        """Return sequence of revision hashes on to this branch.
914
744
 
915
745
    def unbind(self):
916
746
        """Older format branches cannot bind or unbind."""
917
 
        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)
918
752
 
919
753
    def last_revision(self):
920
754
        """Return last revision id, or NULL_REVISION."""
1001
835
        except ValueError:
1002
836
            raise errors.NoSuchRevision(self, revision_id)
1003
837
 
1004
 
    @needs_read_lock
1005
838
    def get_rev_id(self, revno, history=None):
1006
839
        """Find the revision id of the specified revno."""
1007
840
        if revno == 0:
1008
841
            return _mod_revision.NULL_REVISION
1009
 
        last_revno, last_revid = self.last_revision_info()
1010
 
        if revno == last_revno:
1011
 
            return last_revid
1012
 
        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):
1013
845
            raise errors.NoSuchRevision(self, revno)
1014
 
        distance_from_last = last_revno - revno
1015
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
1016
 
            self._extend_partial_history(distance_from_last)
1017
 
        return self._partial_revision_history_cache[distance_from_last]
 
846
        return history[revno - 1]
1018
847
 
1019
848
    @needs_write_lock
1020
849
    def pull(self, source, overwrite=False, stop_revision=None,
1038
867
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1039
868
            *args, **kwargs)
1040
869
 
1041
 
    def lossy_push(self, target, stop_revision=None):
1042
 
        """Push deltas into another branch.
1043
 
 
1044
 
        :note: This does not, like push, retain the revision ids from 
1045
 
            the source branch and will, rather than adding bzr-specific 
1046
 
            metadata, push only those semantics of the revision that can be 
1047
 
            natively represented by this branch' VCS.
1048
 
 
1049
 
        :param target: Target branch
1050
 
        :param stop_revision: Revision to push, defaults to last revision.
1051
 
        :return: BranchPushResult with an extra member revidmap: 
1052
 
            A dictionary mapping revision ids from the target branch 
1053
 
            to new revision ids in the target branch, for each 
1054
 
            revision that was pushed.
1055
 
        """
1056
 
        inter = InterBranch.get(self, target)
1057
 
        lossy_push = getattr(inter, "lossy_push", None)
1058
 
        if lossy_push is None:
1059
 
            raise errors.LossyPushToSameVCS(self, target)
1060
 
        return lossy_push(stop_revision)
1061
 
 
1062
870
    def basis_tree(self):
1063
871
        """Return `Tree` object for last revision."""
1064
872
        return self.repository.revision_tree(self.last_revision())
1080
888
        try:
1081
889
            return urlutils.join(self.base[:-1], parent)
1082
890
        except errors.InvalidURLJoin, e:
1083
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
891
            raise errors.InaccessibleParent(parent, self.base)
1084
892
 
1085
893
    def _get_parent_location(self):
1086
894
        raise NotImplementedError(self._get_parent_location)
1103
911
            location = None
1104
912
        return location
1105
913
 
1106
 
    def get_child_submit_format(self):
1107
 
        """Return the preferred format of submissions to this branch."""
1108
 
        return self.get_config().get_user_option("child_submit_format")
1109
 
 
1110
914
    def get_submit_branch(self):
1111
915
        """Return the submit location of the branch.
1112
916
 
1171
975
        params = ChangeBranchTipParams(
1172
976
            self, old_revno, new_revno, old_revid, new_revid)
1173
977
        for hook in hooks:
1174
 
            hook(params)
 
978
            try:
 
979
                hook(params)
 
980
            except errors.TipChangeRejected:
 
981
                raise
 
982
            except Exception:
 
983
                exc_info = sys.exc_info()
 
984
                hook_name = Branch.hooks.get_hook_name(hook)
 
985
                raise errors.HookFailed(
 
986
                    'pre_change_branch_tip', hook_name, exc_info)
1175
987
 
1176
988
    @needs_write_lock
1177
989
    def update(self):
1226
1038
        revision_id: if not None, the revision history in the new branch will
1227
1039
                     be truncated to end with revision_id.
1228
1040
        """
1229
 
        if (repository_policy is not None and
1230
 
            repository_policy.requires_stacking()):
1231
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1232
1041
        result = to_bzrdir.create_branch()
1233
1042
        result.lock_write()
1234
1043
        try:
1255
1064
        source_revno, source_revision_id = self.last_revision_info()
1256
1065
        if revision_id is None:
1257
1066
            revno, revision_id = source_revno, source_revision_id
 
1067
        elif source_revision_id == revision_id:
 
1068
            # we know the revno without needing to walk all of history
 
1069
            revno = source_revno
1258
1070
        else:
1259
 
            graph = self.repository.get_graph()
1260
 
            try:
1261
 
                revno = graph.find_distance_to_null(revision_id, 
1262
 
                    [(source_revision_id, source_revno)])
1263
 
            except errors.GhostRevisionsHaveNoRevno:
1264
 
                # Default to 1, if we can't find anything else
1265
 
                revno = 1
 
1071
            # To figure out the revno for a random revision, we need to build
 
1072
            # the revision history, and count its length.
 
1073
            # We don't care about the order, just how long it is.
 
1074
            # Alternatively, we could start at the current location, and count
 
1075
            # backwards. But there is no guarantee that we will find it since
 
1076
            # it may be a merged revision.
 
1077
            revno = len(list(self.repository.iter_reverse_revision_history(
 
1078
                                                                revision_id)))
1266
1079
        destination.set_last_revision_info(revno, revision_id)
1267
1080
 
1268
1081
    @needs_read_lock
1302
1115
        target._set_all_reference_info(target_reference_dict)
1303
1116
 
1304
1117
    @needs_read_lock
1305
 
    def check(self, refs):
 
1118
    def check(self):
1306
1119
        """Check consistency of the branch.
1307
1120
 
1308
1121
        In particular this checks that revisions given in the revision-history
1311
1124
 
1312
1125
        Callers will typically also want to check the repository.
1313
1126
 
1314
 
        :param refs: Calculated refs for this branch as specified by
1315
 
            branch._get_check_refs()
1316
1127
        :return: A BranchCheckResult.
1317
1128
        """
1318
 
        result = BranchCheckResult(self)
 
1129
        mainline_parent_id = None
1319
1130
        last_revno, last_revision_id = self.last_revision_info()
1320
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1321
 
        if actual_revno != last_revno:
1322
 
            result.errors.append(errors.BzrCheckError(
1323
 
                'revno does not match len(mainline) %s != %s' % (
1324
 
                last_revno, actual_revno)))
1325
 
        # TODO: We should probably also check that self.revision_history
1326
 
        # matches the repository for older branch formats.
1327
 
        # If looking for the code that cross-checks repository parents against
1328
 
        # the iter_reverse_revision_history output, that is now a repository
1329
 
        # specific check.
1330
 
        return result
 
1131
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
1132
                                last_revision_id))
 
1133
        real_rev_history.reverse()
 
1134
        if len(real_rev_history) != last_revno:
 
1135
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1136
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1137
        # TODO: We should probably also check that real_rev_history actually
 
1138
        #       matches self.revision_history()
 
1139
        for revision_id in real_rev_history:
 
1140
            try:
 
1141
                revision = self.repository.get_revision(revision_id)
 
1142
            except errors.NoSuchRevision, e:
 
1143
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1144
                            % revision_id)
 
1145
            # In general the first entry on the revision history has no parents.
 
1146
            # But it's not illegal for it to have parents listed; this can happen
 
1147
            # in imports from Arch when the parents weren't reachable.
 
1148
            if mainline_parent_id is not None:
 
1149
                if mainline_parent_id not in revision.parent_ids:
 
1150
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1151
                                        "parents of {%s}"
 
1152
                                        % (mainline_parent_id, revision_id))
 
1153
            mainline_parent_id = revision_id
 
1154
        return BranchCheckResult(self)
1331
1155
 
1332
1156
    def _get_checkout_format(self):
1333
1157
        """Return the most suitable metadir for a checkout of this branch.
1356
1180
        """
1357
1181
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1358
1182
        # clone call. Or something. 20090224 RBC/spiv.
1359
 
        # XXX: Should this perhaps clone colocated branches as well, 
1360
 
        # rather than just the default branch? 20100319 JRV
1361
1183
        if revision_id is None:
1362
1184
            revision_id = self.last_revision()
1363
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1364
 
            revision_id=revision_id, stacked_on=stacked_on,
1365
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1185
        try:
 
1186
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1187
                revision_id=revision_id, stacked_on=stacked_on,
 
1188
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1189
        except errors.FileExists:
 
1190
            if not use_existing_dir:
 
1191
                raise
 
1192
        except errors.NoSuchFile:
 
1193
            if not create_prefix:
 
1194
                raise
1366
1195
        return dir_to.open_branch()
1367
1196
 
1368
1197
    def create_checkout(self, to_location, revision_id=None,
1387
1216
        if lightweight:
1388
1217
            format = self._get_checkout_format()
1389
1218
            checkout = format.initialize_on_transport(t)
1390
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1391
 
                target_branch=self)
 
1219
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1392
1220
        else:
1393
1221
            format = self._get_checkout_format()
1394
1222
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1436
1264
    def supports_tags(self):
1437
1265
        return self._format.supports_tags()
1438
1266
 
1439
 
    def automatic_tag_name(self, revision_id):
1440
 
        """Try to automatically find the tag name for a revision.
1441
 
 
1442
 
        :param revision_id: Revision id of the revision.
1443
 
        :return: A tag name or None if no tag name could be determined.
1444
 
        """
1445
 
        for hook in Branch.hooks['automatic_tag_name']:
1446
 
            ret = hook(self, revision_id)
1447
 
            if ret is not None:
1448
 
                return ret
1449
 
        return None
1450
 
 
1451
1267
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1452
1268
                                         other_branch):
1453
1269
        """Ensure that revision_b is a descendant of revision_a.
1508
1324
    _formats = {}
1509
1325
    """The known formats."""
1510
1326
 
1511
 
    can_set_append_revisions_only = True
1512
 
 
1513
1327
    def __eq__(self, other):
1514
1328
        return self.__class__ is other.__class__
1515
1329
 
1517
1331
        return not (self == other)
1518
1332
 
1519
1333
    @classmethod
1520
 
    def find_format(klass, a_bzrdir, name=None):
 
1334
    def find_format(klass, a_bzrdir):
1521
1335
        """Return the format for the branch object in a_bzrdir."""
1522
1336
        try:
1523
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1524
 
            format_string = transport.get_bytes("format")
 
1337
            transport = a_bzrdir.get_branch_transport(None)
 
1338
            format_string = transport.get("format").read()
1525
1339
            return klass._formats[format_string]
1526
1340
        except errors.NoSuchFile:
1527
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1341
            raise errors.NotBranchError(path=transport.base)
1528
1342
        except KeyError:
1529
1343
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1530
1344
 
1533
1347
        """Return the current default format."""
1534
1348
        return klass._default_format
1535
1349
 
1536
 
    def get_reference(self, a_bzrdir, name=None):
 
1350
    def get_reference(self, a_bzrdir):
1537
1351
        """Get the target reference of the branch in a_bzrdir.
1538
1352
 
1539
1353
        format probing must have been completed before calling
1541
1355
        in a_bzrdir is correct.
1542
1356
 
1543
1357
        :param a_bzrdir: The bzrdir to get the branch data from.
1544
 
        :param name: Name of the colocated branch to fetch
1545
1358
        :return: None if the branch is not a reference branch.
1546
1359
        """
1547
1360
        return None
1548
1361
 
1549
1362
    @classmethod
1550
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1363
    def set_reference(self, a_bzrdir, to_branch):
1551
1364
        """Set the target reference of the branch in a_bzrdir.
1552
1365
 
1553
1366
        format probing must have been completed before calling
1555
1368
        in a_bzrdir is correct.
1556
1369
 
1557
1370
        :param a_bzrdir: The bzrdir to set the branch reference for.
1558
 
        :param name: Name of colocated branch to set, None for default
1559
1371
        :param to_branch: branch that the checkout is to reference
1560
1372
        """
1561
1373
        raise NotImplementedError(self.set_reference)
1568
1380
        """Return the short format description for this format."""
1569
1381
        raise NotImplementedError(self.get_format_description)
1570
1382
 
1571
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1572
 
        hooks = Branch.hooks['post_branch_init']
1573
 
        if not hooks:
1574
 
            return
1575
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1576
 
        for hook in hooks:
1577
 
            hook(params)
1578
 
 
1579
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1580
 
                           lock_type='metadir', set_format=True):
 
1383
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1384
                           set_format=True):
1581
1385
        """Initialize a branch in a bzrdir, with specified files
1582
1386
 
1583
1387
        :param a_bzrdir: The bzrdir to initialize the branch in
1584
1388
        :param utf8_files: The files to create as a list of
1585
1389
            (filename, content) tuples
1586
 
        :param name: Name of colocated branch to create, if any
1587
1390
        :param set_format: If True, set the format with
1588
1391
            self.get_format_string.  (BzrBranch4 has its format set
1589
1392
            elsewhere)
1590
1393
        :return: a branch in this format
1591
1394
        """
1592
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1593
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1395
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1396
        branch_transport = a_bzrdir.get_branch_transport(self)
1594
1397
        lock_map = {
1595
1398
            'metadir': ('lock', lockdir.LockDir),
1596
1399
            'branch4': ('branch-lock', lockable_files.TransportLock),
1617
1420
        finally:
1618
1421
            if lock_taken:
1619
1422
                control_files.unlock()
1620
 
        branch = self.open(a_bzrdir, name, _found=True)
1621
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1622
 
        return branch
 
1423
        return self.open(a_bzrdir, _found=True)
1623
1424
 
1624
 
    def initialize(self, a_bzrdir, name=None):
1625
 
        """Create a branch of this format in a_bzrdir.
1626
 
        
1627
 
        :param name: Name of the colocated branch to create.
1628
 
        """
 
1425
    def initialize(self, a_bzrdir):
 
1426
        """Create a branch of this format in a_bzrdir."""
1629
1427
        raise NotImplementedError(self.initialize)
1630
1428
 
1631
1429
    def is_supported(self):
1661
1459
        """
1662
1460
        raise NotImplementedError(self.network_name)
1663
1461
 
1664
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1462
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1665
1463
        """Return the branch object for a_bzrdir
1666
1464
 
1667
1465
        :param a_bzrdir: A BzrDir that contains a branch.
1668
 
        :param name: Name of colocated branch to open
1669
1466
        :param _found: a private parameter, do not use it. It is used to
1670
1467
            indicate if format probing has already be done.
1671
1468
        :param ignore_fallbacks: when set, no fallback branches will be opened
1685
1482
    def set_default_format(klass, format):
1686
1483
        klass._default_format = format
1687
1484
 
1688
 
    def supports_set_append_revisions_only(self):
1689
 
        """True if this format supports set_append_revisions_only."""
1690
 
        return False
1691
 
 
1692
1485
    def supports_stacking(self):
1693
1486
        """True if this format records a stacked-on branch."""
1694
1487
        return False
1779
1572
            "multiple hooks installed for transform_fallback_location, "
1780
1573
            "all are called with the url returned from the previous hook."
1781
1574
            "The order is however undefined.", (1, 9), None))
1782
 
        self.create_hook(HookPoint('automatic_tag_name',
1783
 
            "Called to determine an automatic tag name for a revision."
1784
 
            "automatic_tag_name is called with (branch, revision_id) and "
1785
 
            "should return a tag name or None if no tag name could be "
1786
 
            "determined. The first non-None tag name returned will be used.",
1787
 
            (2, 2), None))
1788
 
        self.create_hook(HookPoint('post_branch_init',
1789
 
            "Called after new branch initialization completes. "
1790
 
            "post_branch_init is called with a "
1791
 
            "bzrlib.branch.BranchInitHookParams. "
1792
 
            "Note that init, branch and checkout (both heavyweight and "
1793
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1794
 
        self.create_hook(HookPoint('post_switch',
1795
 
            "Called after a checkout switches branch. "
1796
 
            "post_switch is called with a "
1797
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1798
 
 
1799
1575
 
1800
1576
 
1801
1577
# install the default hooks into the Branch class.
1840
1616
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1841
1617
 
1842
1618
 
1843
 
class BranchInitHookParams(object):
1844
 
    """Object holding parameters passed to *_branch_init hooks.
1845
 
 
1846
 
    There are 4 fields that hooks may wish to access:
1847
 
 
1848
 
    :ivar format: the branch format
1849
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1850
 
    :ivar name: name of colocated branch, if any (or None)
1851
 
    :ivar branch: the branch created
1852
 
 
1853
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1854
 
    the checkout, hence they are different from the corresponding fields in
1855
 
    branch, which refer to the original branch.
1856
 
    """
1857
 
 
1858
 
    def __init__(self, format, a_bzrdir, name, branch):
1859
 
        """Create a group of BranchInitHook parameters.
1860
 
 
1861
 
        :param format: the branch format
1862
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1863
 
            initialized
1864
 
        :param name: name of colocated branch, if any (or None)
1865
 
        :param branch: the branch created
1866
 
 
1867
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1868
 
        to the checkout, hence they are different from the corresponding fields
1869
 
        in branch, which refer to the original branch.
1870
 
        """
1871
 
        self.format = format
1872
 
        self.bzrdir = a_bzrdir
1873
 
        self.name = name
1874
 
        self.branch = branch
1875
 
 
1876
 
    def __eq__(self, other):
1877
 
        return self.__dict__ == other.__dict__
1878
 
 
1879
 
    def __repr__(self):
1880
 
        if self.branch:
1881
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1882
 
        else:
1883
 
            return "<%s of format:%s bzrdir:%s>" % (
1884
 
                self.__class__.__name__, self.branch,
1885
 
                self.format, self.bzrdir)
1886
 
 
1887
 
 
1888
 
class SwitchHookParams(object):
1889
 
    """Object holding parameters passed to *_switch hooks.
1890
 
 
1891
 
    There are 4 fields that hooks may wish to access:
1892
 
 
1893
 
    :ivar control_dir: BzrDir of the checkout to change
1894
 
    :ivar to_branch: branch that the checkout is to reference
1895
 
    :ivar force: skip the check for local commits in a heavy checkout
1896
 
    :ivar revision_id: revision ID to switch to (or None)
1897
 
    """
1898
 
 
1899
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1900
 
        """Create a group of SwitchHook parameters.
1901
 
 
1902
 
        :param control_dir: BzrDir of the checkout to change
1903
 
        :param to_branch: branch that the checkout is to reference
1904
 
        :param force: skip the check for local commits in a heavy checkout
1905
 
        :param revision_id: revision ID to switch to (or None)
1906
 
        """
1907
 
        self.control_dir = control_dir
1908
 
        self.to_branch = to_branch
1909
 
        self.force = force
1910
 
        self.revision_id = revision_id
1911
 
 
1912
 
    def __eq__(self, other):
1913
 
        return self.__dict__ == other.__dict__
1914
 
 
1915
 
    def __repr__(self):
1916
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1917
 
            self.control_dir, self.to_branch,
1918
 
            self.revision_id)
1919
 
 
1920
 
 
1921
1619
class BzrBranchFormat4(BranchFormat):
1922
1620
    """Bzr branch format 4.
1923
1621
 
1930
1628
        """See BranchFormat.get_format_description()."""
1931
1629
        return "Branch format 4"
1932
1630
 
1933
 
    def initialize(self, a_bzrdir, name=None):
 
1631
    def initialize(self, a_bzrdir):
1934
1632
        """Create a branch of this format in a_bzrdir."""
1935
1633
        utf8_files = [('revision-history', ''),
1936
1634
                      ('branch-name', ''),
1937
1635
                      ]
1938
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1636
        return self._initialize_helper(a_bzrdir, utf8_files,
1939
1637
                                       lock_type='branch4', set_format=False)
1940
1638
 
1941
1639
    def __init__(self):
1946
1644
        """The network name for this format is the control dirs disk label."""
1947
1645
        return self._matchingbzrdir.get_format_string()
1948
1646
 
1949
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1647
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1950
1648
        """See BranchFormat.open()."""
1951
1649
        if not _found:
1952
1650
            # we are being called directly and must probe.
1954
1652
        return BzrBranch(_format=self,
1955
1653
                         _control_files=a_bzrdir._control_files,
1956
1654
                         a_bzrdir=a_bzrdir,
1957
 
                         name=name,
1958
1655
                         _repository=a_bzrdir.open_repository())
1959
1656
 
1960
1657
    def __str__(self):
1975
1672
        """
1976
1673
        return self.get_format_string()
1977
1674
 
1978
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1675
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1979
1676
        """See BranchFormat.open()."""
1980
1677
        if not _found:
1981
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1678
            format = BranchFormat.find_format(a_bzrdir)
1982
1679
            if format.__class__ != self.__class__:
1983
1680
                raise AssertionError("wrong format %r found for %r" %
1984
1681
                    (format, self))
1985
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1986
1682
        try:
 
1683
            transport = a_bzrdir.get_branch_transport(None)
1987
1684
            control_files = lockable_files.LockableFiles(transport, 'lock',
1988
1685
                                                         lockdir.LockDir)
1989
1686
            return self._branch_class()(_format=self,
1990
1687
                              _control_files=control_files,
1991
 
                              name=name,
1992
1688
                              a_bzrdir=a_bzrdir,
1993
1689
                              _repository=a_bzrdir.find_repository(),
1994
1690
                              ignore_fallbacks=ignore_fallbacks)
1995
1691
        except errors.NoSuchFile:
1996
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1692
            raise errors.NotBranchError(path=transport.base)
1997
1693
 
1998
1694
    def __init__(self):
1999
1695
        super(BranchFormatMetadir, self).__init__()
2028
1724
        """See BranchFormat.get_format_description()."""
2029
1725
        return "Branch format 5"
2030
1726
 
2031
 
    def initialize(self, a_bzrdir, name=None):
 
1727
    def initialize(self, a_bzrdir):
2032
1728
        """Create a branch of this format in a_bzrdir."""
2033
1729
        utf8_files = [('revision-history', ''),
2034
1730
                      ('branch-name', ''),
2035
1731
                      ]
2036
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1732
        return self._initialize_helper(a_bzrdir, utf8_files)
2037
1733
 
2038
1734
    def supports_tags(self):
2039
1735
        return False
2061
1757
        """See BranchFormat.get_format_description()."""
2062
1758
        return "Branch format 6"
2063
1759
 
2064
 
    def initialize(self, a_bzrdir, name=None):
 
1760
    def initialize(self, a_bzrdir):
2065
1761
        """Create a branch of this format in a_bzrdir."""
2066
1762
        utf8_files = [('last-revision', '0 null:\n'),
2067
1763
                      ('branch.conf', ''),
2068
1764
                      ('tags', ''),
2069
1765
                      ]
2070
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1766
        return self._initialize_helper(a_bzrdir, utf8_files)
2071
1767
 
2072
1768
    def make_tags(self, branch):
2073
1769
        """See bzrlib.branch.BranchFormat.make_tags()."""
2074
1770
        return BasicTags(branch)
2075
1771
 
2076
 
    def supports_set_append_revisions_only(self):
2077
 
        return True
2078
1772
 
2079
1773
 
2080
1774
class BzrBranchFormat8(BranchFormatMetadir):
2091
1785
        """See BranchFormat.get_format_description()."""
2092
1786
        return "Branch format 8"
2093
1787
 
2094
 
    def initialize(self, a_bzrdir, name=None):
 
1788
    def initialize(self, a_bzrdir):
2095
1789
        """Create a branch of this format in a_bzrdir."""
2096
1790
        utf8_files = [('last-revision', '0 null:\n'),
2097
1791
                      ('branch.conf', ''),
2098
1792
                      ('tags', ''),
2099
1793
                      ('references', '')
2100
1794
                      ]
2101
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1795
        return self._initialize_helper(a_bzrdir, utf8_files)
2102
1796
 
2103
1797
    def __init__(self):
2104
1798
        super(BzrBranchFormat8, self).__init__()
2109
1803
        """See bzrlib.branch.BranchFormat.make_tags()."""
2110
1804
        return BasicTags(branch)
2111
1805
 
2112
 
    def supports_set_append_revisions_only(self):
2113
 
        return True
2114
 
 
2115
1806
    def supports_stacking(self):
2116
1807
        return True
2117
1808
 
2127
1818
    This format was introduced in bzr 1.6.
2128
1819
    """
2129
1820
 
2130
 
    def initialize(self, a_bzrdir, name=None):
 
1821
    def initialize(self, a_bzrdir):
2131
1822
        """Create a branch of this format in a_bzrdir."""
2132
1823
        utf8_files = [('last-revision', '0 null:\n'),
2133
1824
                      ('branch.conf', ''),
2134
1825
                      ('tags', ''),
2135
1826
                      ]
2136
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1827
        return self._initialize_helper(a_bzrdir, utf8_files)
2137
1828
 
2138
1829
    def _branch_class(self):
2139
1830
        return BzrBranch7
2146
1837
        """See BranchFormat.get_format_description()."""
2147
1838
        return "Branch format 7"
2148
1839
 
2149
 
    def supports_set_append_revisions_only(self):
2150
 
        return True
2151
 
 
2152
1840
    supports_reference_locations = False
2153
1841
 
2154
1842
 
2171
1859
        """See BranchFormat.get_format_description()."""
2172
1860
        return "Checkout reference format 1"
2173
1861
 
2174
 
    def get_reference(self, a_bzrdir, name=None):
 
1862
    def get_reference(self, a_bzrdir):
2175
1863
        """See BranchFormat.get_reference()."""
2176
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2177
 
        return transport.get_bytes('location')
 
1864
        transport = a_bzrdir.get_branch_transport(None)
 
1865
        return transport.get('location').read()
2178
1866
 
2179
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1867
    def set_reference(self, a_bzrdir, to_branch):
2180
1868
        """See BranchFormat.set_reference()."""
2181
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1869
        transport = a_bzrdir.get_branch_transport(None)
2182
1870
        location = transport.put_bytes('location', to_branch.base)
2183
1871
 
2184
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1872
    def initialize(self, a_bzrdir, target_branch=None):
2185
1873
        """Create a branch of this format in a_bzrdir."""
2186
1874
        if target_branch is None:
2187
1875
            # this format does not implement branch itself, thus the implicit
2188
1876
            # creation contract must see it as uninitializable
2189
1877
            raise errors.UninitializableFormat(self)
2190
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2191
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1878
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1879
        branch_transport = a_bzrdir.get_branch_transport(self)
2192
1880
        branch_transport.put_bytes('location',
2193
 
            target_branch.bzrdir.user_url)
 
1881
            target_branch.bzrdir.root_transport.base)
2194
1882
        branch_transport.put_bytes('format', self.get_format_string())
2195
 
        branch = self.open(
2196
 
            a_bzrdir, name, _found=True,
 
1883
        return self.open(
 
1884
            a_bzrdir, _found=True,
2197
1885
            possible_transports=[target_branch.bzrdir.root_transport])
2198
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2199
 
        return branch
2200
1886
 
2201
1887
    def __init__(self):
2202
1888
        super(BranchReferenceFormat, self).__init__()
2208
1894
        def clone(to_bzrdir, revision_id=None,
2209
1895
            repository_policy=None):
2210
1896
            """See Branch.clone()."""
2211
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1897
            return format.initialize(to_bzrdir, a_branch)
2212
1898
            # cannot obey revision_id limits when cloning a reference ...
2213
1899
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2214
1900
            # emit some sort of warning/error to the caller ?!
2215
1901
        return clone
2216
1902
 
2217
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1903
    def open(self, a_bzrdir, _found=False, location=None,
2218
1904
             possible_transports=None, ignore_fallbacks=False):
2219
1905
        """Return the branch that the branch reference in a_bzrdir points at.
2220
1906
 
2221
1907
        :param a_bzrdir: A BzrDir that contains a branch.
2222
 
        :param name: Name of colocated branch to open, if any
2223
1908
        :param _found: a private parameter, do not use it. It is used to
2224
1909
            indicate if format probing has already be done.
2225
1910
        :param ignore_fallbacks: when set, no fallback branches will be opened
2230
1915
        :param possible_transports: An optional reusable transports list.
2231
1916
        """
2232
1917
        if not _found:
2233
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1918
            format = BranchFormat.find_format(a_bzrdir)
2234
1919
            if format.__class__ != self.__class__:
2235
1920
                raise AssertionError("wrong format %r found for %r" %
2236
1921
                    (format, self))
2237
1922
        if location is None:
2238
 
            location = self.get_reference(a_bzrdir, name)
 
1923
            location = self.get_reference(a_bzrdir)
2239
1924
        real_bzrdir = bzrdir.BzrDir.open(
2240
1925
            location, possible_transports=possible_transports)
2241
 
        result = real_bzrdir.open_branch(name=name, 
2242
 
            ignore_fallbacks=ignore_fallbacks)
 
1926
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2243
1927
        # this changes the behaviour of result.clone to create a new reference
2244
1928
        # rather than a copy of the content of the branch.
2245
1929
        # I did not use a proxy object because that needs much more extensive
2272
1956
BranchFormat.register_format(__format6)
2273
1957
BranchFormat.register_format(__format7)
2274
1958
BranchFormat.register_format(__format8)
2275
 
BranchFormat.set_default_format(__format7)
 
1959
BranchFormat.set_default_format(__format6)
2276
1960
_legacy_formats = [BzrBranchFormat4(),
2277
1961
    ]
2278
1962
network_format_registry.register(
2279
1963
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2280
1964
 
2281
1965
 
2282
 
class BranchWriteLockResult(LogicalLockResult):
2283
 
    """The result of write locking a branch.
2284
 
 
2285
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2286
 
        None.
2287
 
    :ivar unlock: A callable which will unlock the lock.
2288
 
    """
2289
 
 
2290
 
    def __init__(self, unlock, branch_token):
2291
 
        LogicalLockResult.__init__(self, unlock)
2292
 
        self.branch_token = branch_token
2293
 
 
2294
 
    def __repr__(self):
2295
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2296
 
            self.unlock)
2297
 
 
2298
 
 
2299
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1966
class BzrBranch(Branch):
2300
1967
    """A branch stored in the actual filesystem.
2301
1968
 
2302
1969
    Note that it's "local" in the context of the filesystem; it doesn't
2308
1975
    :ivar repository: Repository for this branch.
2309
1976
    :ivar base: The url of the base directory for this branch; the one
2310
1977
        containing the .bzr directory.
2311
 
    :ivar name: Optional colocated branch name as it exists in the control
2312
 
        directory.
2313
1978
    """
2314
1979
 
2315
1980
    def __init__(self, _format=None,
2316
 
                 _control_files=None, a_bzrdir=None, name=None,
2317
 
                 _repository=None, ignore_fallbacks=False):
 
1981
                 _control_files=None, a_bzrdir=None, _repository=None,
 
1982
                 ignore_fallbacks=False):
2318
1983
        """Create new branch object at a particular location."""
2319
1984
        if a_bzrdir is None:
2320
1985
            raise ValueError('a_bzrdir must be supplied')
2321
1986
        else:
2322
1987
            self.bzrdir = a_bzrdir
2323
1988
        self._base = self.bzrdir.transport.clone('..').base
2324
 
        self.name = name
2325
1989
        # XXX: We should be able to just do
2326
1990
        #   self.base = self.bzrdir.root_transport.base
2327
1991
        # but this does not quite work yet -- mbp 20080522
2334
1998
        Branch.__init__(self)
2335
1999
 
2336
2000
    def __str__(self):
2337
 
        if self.name is None:
2338
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2339
 
        else:
2340
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2341
 
                self.name)
 
2001
        return '%s(%r)' % (self.__class__.__name__, self.base)
2342
2002
 
2343
2003
    __repr__ = __str__
2344
2004
 
2355
2015
        return self.control_files.is_locked()
2356
2016
 
2357
2017
    def lock_write(self, token=None):
2358
 
        """Lock the branch for write operations.
2359
 
 
2360
 
        :param token: A token to permit reacquiring a previously held and
2361
 
            preserved lock.
2362
 
        :return: A BranchWriteLockResult.
2363
 
        """
2364
 
        if not self.is_locked():
2365
 
            self._note_lock('w')
2366
2018
        # All-in-one needs to always unlock/lock.
2367
2019
        repo_control = getattr(self.repository, 'control_files', None)
2368
2020
        if self.control_files == repo_control or not self.is_locked():
2369
 
            self.repository._warn_if_deprecated(self)
2370
2021
            self.repository.lock_write()
2371
2022
            took_lock = True
2372
2023
        else:
2373
2024
            took_lock = False
2374
2025
        try:
2375
 
            return BranchWriteLockResult(self.unlock,
2376
 
                self.control_files.lock_write(token=token))
 
2026
            return self.control_files.lock_write(token=token)
2377
2027
        except:
2378
2028
            if took_lock:
2379
2029
                self.repository.unlock()
2380
2030
            raise
2381
2031
 
2382
2032
    def lock_read(self):
2383
 
        """Lock the branch for read operations.
2384
 
 
2385
 
        :return: A bzrlib.lock.LogicalLockResult.
2386
 
        """
2387
 
        if not self.is_locked():
2388
 
            self._note_lock('r')
2389
2033
        # All-in-one needs to always unlock/lock.
2390
2034
        repo_control = getattr(self.repository, 'control_files', None)
2391
2035
        if self.control_files == repo_control or not self.is_locked():
2392
 
            self.repository._warn_if_deprecated(self)
2393
2036
            self.repository.lock_read()
2394
2037
            took_lock = True
2395
2038
        else:
2396
2039
            took_lock = False
2397
2040
        try:
2398
2041
            self.control_files.lock_read()
2399
 
            return LogicalLockResult(self.unlock)
2400
2042
        except:
2401
2043
            if took_lock:
2402
2044
                self.repository.unlock()
2403
2045
            raise
2404
2046
 
2405
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2406
2047
    def unlock(self):
2407
2048
        try:
2408
2049
            self.control_files.unlock()
2571
2212
        return result
2572
2213
 
2573
2214
    def get_stacked_on_url(self):
2574
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2215
        raise errors.UnstackableBranchFormat(self._format, self.base)
2575
2216
 
2576
2217
    def set_push_location(self, location):
2577
2218
        """See Branch.set_push_location."""
2704
2345
                    raise AssertionError(
2705
2346
                        "'transform_fallback_location' hook %s returned "
2706
2347
                        "None, not a URL." % hook_name)
2707
 
            self._activate_fallback_location(url)
 
2348
            self._activate_fallback_location(url, None)
2708
2349
 
2709
2350
    def __init__(self, *args, **kwargs):
2710
2351
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2711
2352
        super(BzrBranch8, self).__init__(*args, **kwargs)
2712
2353
        self._last_revision_info_cache = None
 
2354
        self._partial_revision_history_cache = []
2713
2355
        self._reference_info = None
2714
2356
 
2715
2357
    def _clear_cached_state(self):
2716
2358
        super(BzrBranch8, self)._clear_cached_state()
2717
2359
        self._last_revision_info_cache = None
 
2360
        self._partial_revision_history_cache = []
2718
2361
        self._reference_info = None
2719
2362
 
2720
2363
    def _last_revision_info(self):
2767
2410
        if _mod_revision.is_null(last_revision):
2768
2411
            return
2769
2412
        if last_revision not in self._lefthand_history(revision_id):
2770
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2413
            raise errors.AppendRevisionsOnlyViolation(self.base)
2771
2414
 
2772
2415
    def _gen_revision_history(self):
2773
2416
        """Generate the revision history from last revision
2776
2419
        self._extend_partial_history(stop_index=last_revno-1)
2777
2420
        return list(reversed(self._partial_revision_history_cache))
2778
2421
 
 
2422
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2423
        """Extend the partial history to include a given index
 
2424
 
 
2425
        If a stop_index is supplied, stop when that index has been reached.
 
2426
        If a stop_revision is supplied, stop when that revision is
 
2427
        encountered.  Otherwise, stop when the beginning of history is
 
2428
        reached.
 
2429
 
 
2430
        :param stop_index: The index which should be present.  When it is
 
2431
            present, history extension will stop.
 
2432
        :param revision_id: The revision id which should be present.  When
 
2433
            it is encountered, history extension will stop.
 
2434
        """
 
2435
        repo = self.repository
 
2436
        if len(self._partial_revision_history_cache) == 0:
 
2437
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2438
        else:
 
2439
            start_revision = self._partial_revision_history_cache[-1]
 
2440
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2441
            #skip the last revision in the list
 
2442
            next_revision = iterator.next()
 
2443
        for revision_id in iterator:
 
2444
            self._partial_revision_history_cache.append(revision_id)
 
2445
            if (stop_index is not None and
 
2446
                len(self._partial_revision_history_cache) > stop_index):
 
2447
                break
 
2448
            if revision_id == stop_revision:
 
2449
                break
 
2450
 
2779
2451
    def _write_revision_history(self, history):
2780
2452
        """Factored out of set_revision_history.
2781
2453
 
2873
2545
        if branch_location is None:
2874
2546
            return Branch.reference_parent(self, file_id, path,
2875
2547
                                           possible_transports)
2876
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2548
        branch_location = urlutils.join(self.base, branch_location)
2877
2549
        return Branch.open(branch_location,
2878
2550
                           possible_transports=possible_transports)
2879
2551
 
2924
2596
            raise errors.NotStacked(self)
2925
2597
        return stacked_url
2926
2598
 
 
2599
    def set_append_revisions_only(self, enabled):
 
2600
        if enabled:
 
2601
            value = 'True'
 
2602
        else:
 
2603
            value = 'False'
 
2604
        self.get_config().set_user_option('append_revisions_only', value,
 
2605
            warn_masked=True)
 
2606
 
2927
2607
    def _get_append_revisions_only(self):
2928
 
        return self.get_config(
2929
 
            ).get_user_option_as_bool('append_revisions_only')
 
2608
        value = self.get_config().get_user_option('append_revisions_only')
 
2609
        return value == 'True'
2930
2610
 
2931
2611
    @needs_write_lock
2932
2612
    def generate_revision_history(self, revision_id, last_rev=None,
2994
2674
    """
2995
2675
 
2996
2676
    def get_stacked_on_url(self):
2997
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2677
        raise errors.UnstackableBranchFormat(self._format, self.base)
2998
2678
 
2999
2679
 
3000
2680
######################################################################
3079
2759
 
3080
2760
    def __init__(self, branch):
3081
2761
        self.branch = branch
3082
 
        self.errors = []
3083
2762
 
3084
2763
    def report_results(self, verbose):
3085
2764
        """Report the check results via trace.note.
3087
2766
        :param verbose: Requests more detailed display of what was checked,
3088
2767
            if any.
3089
2768
        """
3090
 
        note('checked branch %s format %s', self.branch.user_url,
3091
 
            self.branch._format)
3092
 
        for error in self.errors:
3093
 
            note('found error:%s', error)
 
2769
        note('checked branch %s format %s',
 
2770
             self.branch.base,
 
2771
             self.branch._format)
3094
2772
 
3095
2773
 
3096
2774
class Converter5to6(object):
3191
2869
    @staticmethod
3192
2870
    def _get_branch_formats_to_test():
3193
2871
        """Return a tuple with the Branch formats to use when testing."""
3194
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
2872
        raise NotImplementedError(self._get_branch_formats_to_test)
3195
2873
 
3196
2874
    def pull(self, overwrite=False, stop_revision=None,
3197
2875
             possible_transports=None, local=False):
3352
3030
                _override_hook_source_branch=_override_hook_source_branch)
3353
3031
        finally:
3354
3032
            self.source.unlock()
 
3033
        return result
3355
3034
 
3356
3035
    def _push_with_bound_branches(self, overwrite, stop_revision,
3357
3036
            _override_hook_source_branch=None):
3422
3101
        if local and not bound_location:
3423
3102
            raise errors.LocalRequiresBoundBranch()
3424
3103
        master_branch = None
3425
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3104
        if not local and bound_location and self.source.base != bound_location:
3426
3105
            # not pulling from master, so we need to update master.
3427
3106
            master_branch = self.target.get_master_branch(possible_transports)
3428
3107
            master_branch.lock_write()