~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2009-04-24 15:49:33 UTC
  • mto: This revision was merged to the branch mainline in revision 4303.
  • Revision ID: mbp@sourcefrog.net-20090424154933-w74cgi7rdi905026
Review tweak to comments

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
 
from cStringIO import StringIO
19
18
import sys
20
19
 
21
20
from bzrlib.lazy_import import lazy_import
31
30
        lockable_files,
32
31
        repository,
33
32
        revision as _mod_revision,
34
 
        rio,
35
33
        symbol_versioning,
36
34
        transport,
37
35
        tsort,
46
44
    )
47
45
""")
48
46
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
47
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
48
from bzrlib.hooks import HookPoint, Hooks
51
49
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
53
50
from bzrlib import registry
54
51
from bzrlib.symbol_versioning import (
55
52
    deprecated_in,
63
60
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
61
 
65
62
 
66
 
class Branch(bzrdir.ControlComponent):
 
63
# TODO: Maybe include checks for common corruption of newlines, etc?
 
64
 
 
65
# TODO: Some operations like log might retrieve the same revisions
 
66
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
67
# cache in memory to make this faster.  In general anything can be
 
68
# cached in memory between lock and unlock operations. .. nb thats
 
69
# what the transaction identity map provides
 
70
 
 
71
 
 
72
######################################################################
 
73
# branch objects
 
74
 
 
75
class Branch(object):
67
76
    """Branch holding a history of revisions.
68
77
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
78
    base
 
79
        Base directory/url of the branch.
72
80
 
73
81
    hooks: An instance of BranchHooks.
74
82
    """
76
84
    # - RBC 20060112
77
85
    base = None
78
86
 
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
87
    def __init__(self, *ignored, **ignored_too):
88
88
        self.tags = self._format.make_tags(self)
89
89
        self._revision_history_cache = None
90
90
        self._revision_id_to_revno_cache = None
91
91
        self._partial_revision_id_to_revno_cache = {}
92
 
        self._partial_revision_history_cache = []
93
92
        self._last_revision_info_cache = None
94
93
        self._merge_sorted_revisions_cache = None
95
94
        self._open_hook()
100
99
    def _open_hook(self):
101
100
        """Called by init to allow simpler extension of the base class."""
102
101
 
103
 
    def _activate_fallback_location(self, url):
 
102
    def _activate_fallback_location(self, url, lock_style):
104
103
        """Activate the branch/repository from url as a fallback repository."""
105
104
        repo = self._get_fallback_repository(url)
106
 
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
105
        if lock_style == 'write':
 
106
            repo.lock_write()
 
107
        elif lock_style == 'read':
 
108
            repo.lock_read()
108
109
        self.repository.add_fallback_repository(repo)
109
110
 
110
111
    def break_lock(self):
126
127
            raise errors.UnstackableRepositoryFormat(self.repository._format,
127
128
                self.repository.base)
128
129
 
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
130
    @staticmethod
159
131
    def open(base, _unsupported=False, possible_transports=None):
160
132
        """Open the branch rooted at base.
164
136
        """
165
137
        control = bzrdir.BzrDir.open(base, _unsupported,
166
138
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
139
        return control.open_branch(_unsupported)
168
140
 
169
141
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
142
    def open_from_transport(transport, _unsupported=False):
171
143
        """Open the branch rooted at transport"""
172
144
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
145
        return control.open_branch(_unsupported)
174
146
 
175
147
    @staticmethod
176
148
    def open_containing(url, possible_transports=None):
214
186
    def _get_fallback_repository(self, url):
215
187
        """Get the repository we fallback to at url."""
216
188
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
189
        a_bzrdir = bzrdir.BzrDir.open(url,
218
190
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
191
        return a_bzrdir.open_branch().repository
220
192
 
221
193
    def _get_tags_bytes(self):
222
194
        """Get the bytes of a serialised tags dict.
417
389
            * 'include' - the stop revision is the last item in the result
418
390
            * 'with-merges' - include the stop revision and all of its
419
391
              merged revisions in the result
420
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
 
              that are in both ancestries
422
392
        :param direction: either 'reverse' or 'forward':
423
393
            * reverse means return the start_revision_id first, i.e.
424
394
              start at the most recent revision and go backwards in history
446
416
        # start_revision_id.
447
417
        if self._merge_sorted_revisions_cache is None:
448
418
            last_revision = self.last_revision()
449
 
            known_graph = self.repository.get_known_graph_ancestry(
450
 
                [last_revision])
451
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
452
 
                last_revision)
 
419
            graph = self.repository.get_graph()
 
420
            parent_map = dict(((key, value) for key, value in
 
421
                     graph.iter_ancestry([last_revision]) if value is not None))
 
422
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
423
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
424
                generate_revno=True)
 
425
            # Drop the sequence # before caching
 
426
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
427
 
453
428
        filtered = self._filter_merge_sorted_revisions(
454
429
            self._merge_sorted_revisions_cache, start_revision_id,
455
430
            stop_revision_id, stop_rule)
456
 
        # Make sure we don't return revisions that are not part of the
457
 
        # start_revision_id ancestry.
458
 
        filtered = self._filter_start_non_ancestors(filtered)
459
431
        if direction == 'reverse':
460
432
            return filtered
461
433
        if direction == 'forward':
468
440
        """Iterate over an inclusive range of sorted revisions."""
469
441
        rev_iter = iter(merge_sorted_revisions)
470
442
        if start_revision_id is not None:
471
 
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
443
            for rev_id, depth, revno, end_of_merge in rev_iter:
473
444
                if rev_id != start_revision_id:
474
445
                    continue
475
446
                else:
476
447
                    # The decision to include the start or not
477
448
                    # depends on the stop_rule if a stop is provided
478
 
                    # so pop this node back into the iterator
479
 
                    rev_iter = chain(iter([node]), rev_iter)
 
449
                    rev_iter = chain(
 
450
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
451
                        rev_iter)
480
452
                    break
481
453
        if stop_revision_id is None:
482
 
            # Yield everything
483
 
            for node in rev_iter:
484
 
                rev_id = node.key[-1]
485
 
                yield (rev_id, node.merge_depth, node.revno,
486
 
                       node.end_of_merge)
 
454
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
455
                yield rev_id, depth, revno, end_of_merge
487
456
        elif stop_rule == 'exclude':
488
 
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
457
            for rev_id, depth, revno, end_of_merge in rev_iter:
490
458
                if rev_id == stop_revision_id:
491
459
                    return
492
 
                yield (rev_id, node.merge_depth, node.revno,
493
 
                       node.end_of_merge)
 
460
                yield rev_id, depth, revno, end_of_merge
494
461
        elif stop_rule == 'include':
495
 
            for node in rev_iter:
496
 
                rev_id = node.key[-1]
497
 
                yield (rev_id, node.merge_depth, node.revno,
498
 
                       node.end_of_merge)
 
462
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
463
                yield rev_id, depth, revno, end_of_merge
499
464
                if rev_id == stop_revision_id:
500
465
                    return
501
 
        elif stop_rule == 'with-merges-without-common-ancestry':
502
 
            # We want to exclude all revisions that are already part of the
503
 
            # stop_revision_id ancestry.
504
 
            graph = self.repository.get_graph()
505
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
506
 
                                                    [stop_revision_id])
507
 
            for node in rev_iter:
508
 
                rev_id = node.key[-1]
509
 
                if rev_id not in ancestors:
510
 
                    continue
511
 
                yield (rev_id, node.merge_depth, node.revno,
512
 
                       node.end_of_merge)
513
466
        elif stop_rule == 'with-merges':
514
467
            stop_rev = self.repository.get_revision(stop_revision_id)
515
468
            if stop_rev.parent_ids:
516
469
                left_parent = stop_rev.parent_ids[0]
517
470
            else:
518
471
                left_parent = _mod_revision.NULL_REVISION
519
 
            # left_parent is the actual revision we want to stop logging at,
520
 
            # since we want to show the merged revisions after the stop_rev too
521
 
            reached_stop_revision_id = False
522
 
            revision_id_whitelist = []
523
 
            for node in rev_iter:
524
 
                rev_id = node.key[-1]
 
472
            for rev_id, depth, revno, end_of_merge in rev_iter:
525
473
                if rev_id == left_parent:
526
 
                    # reached the left parent after the stop_revision
527
474
                    return
528
 
                if (not reached_stop_revision_id or
529
 
                        rev_id in revision_id_whitelist):
530
 
                    yield (rev_id, node.merge_depth, node.revno,
531
 
                       node.end_of_merge)
532
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
533
 
                        # only do the merged revs of rev_id from now on
534
 
                        rev = self.repository.get_revision(rev_id)
535
 
                        if rev.parent_ids:
536
 
                            reached_stop_revision_id = True
537
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
475
                yield rev_id, depth, revno, end_of_merge
538
476
        else:
539
477
            raise ValueError('invalid stop_rule %r' % stop_rule)
540
478
 
541
 
    def _filter_start_non_ancestors(self, rev_iter):
542
 
        # If we started from a dotted revno, we want to consider it as a tip
543
 
        # and don't want to yield revisions that are not part of its
544
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
545
 
        # uninteresting descendants of the first parent of our tip before the
546
 
        # tip itself.
547
 
        first = rev_iter.next()
548
 
        (rev_id, merge_depth, revno, end_of_merge) = first
549
 
        yield first
550
 
        if not merge_depth:
551
 
            # We start at a mainline revision so by definition, all others
552
 
            # revisions in rev_iter are ancestors
553
 
            for node in rev_iter:
554
 
                yield node
555
 
 
556
 
        clean = False
557
 
        whitelist = set()
558
 
        pmap = self.repository.get_parent_map([rev_id])
559
 
        parents = pmap.get(rev_id, [])
560
 
        if parents:
561
 
            whitelist.update(parents)
562
 
        else:
563
 
            # If there is no parents, there is nothing of interest left
564
 
 
565
 
            # FIXME: It's hard to test this scenario here as this code is never
566
 
            # called in that case. -- vila 20100322
567
 
            return
568
 
 
569
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
570
 
            if not clean:
571
 
                if rev_id in whitelist:
572
 
                    pmap = self.repository.get_parent_map([rev_id])
573
 
                    parents = pmap.get(rev_id, [])
574
 
                    whitelist.remove(rev_id)
575
 
                    whitelist.update(parents)
576
 
                    if merge_depth == 0:
577
 
                        # We've reached the mainline, there is nothing left to
578
 
                        # filter
579
 
                        clean = True
580
 
                else:
581
 
                    # A revision that is not part of the ancestry of our
582
 
                    # starting revision.
583
 
                    continue
584
 
            yield (rev_id, merge_depth, revno, end_of_merge)
585
 
 
586
479
    def leave_lock_in_place(self):
587
480
        """Tell this branch object not to release the physical lock when this
588
481
        object is unlocked.
605
498
        :param other: The branch to bind to
606
499
        :type other: Branch
607
500
        """
608
 
        raise errors.UpgradeRequired(self.user_url)
609
 
 
610
 
    def set_append_revisions_only(self, enabled):
611
 
        if not self._format.supports_set_append_revisions_only():
612
 
            raise errors.UpgradeRequired(self.user_url)
613
 
        if enabled:
614
 
            value = 'True'
615
 
        else:
616
 
            value = 'False'
617
 
        self.get_config().set_user_option('append_revisions_only', value,
618
 
            warn_masked=True)
619
 
 
620
 
    def set_reference_info(self, file_id, tree_path, branch_location):
621
 
        """Set the branch location to use for a tree reference."""
622
 
        raise errors.UnsupportedOperation(self.set_reference_info, self)
623
 
 
624
 
    def get_reference_info(self, file_id):
625
 
        """Get the tree_path and branch_location for a tree reference."""
626
 
        raise errors.UnsupportedOperation(self.get_reference_info, self)
 
501
        raise errors.UpgradeRequired(self.base)
627
502
 
628
503
    @needs_write_lock
629
504
    def fetch(self, from_branch, last_revision=None, pb=None):
663
538
    def get_old_bound_location(self):
664
539
        """Return the URL of the branch we used to be bound to
665
540
        """
666
 
        raise errors.UpgradeRequired(self.user_url)
 
541
        raise errors.UpgradeRequired(self.base)
667
542
 
668
543
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
544
                           timezone=None, committer=None, revprops=None,
747
622
            stacking.
748
623
        """
749
624
        if not self._format.supports_stacking():
750
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
751
 
        # XXX: Changing from one fallback repository to another does not check
752
 
        # that all the data you need is present in the new fallback.
753
 
        # Possibly it should.
 
625
            raise errors.UnstackableBranchFormat(self._format, self.base)
754
626
        self._check_stackable_repo()
755
627
        if not url:
756
628
            try:
758
630
            except (errors.NotStacked, errors.UnstackableBranchFormat,
759
631
                errors.UnstackableRepositoryFormat):
760
632
                return
761
 
            self._unstack()
 
633
            url = ''
 
634
            # XXX: Lock correctness - should unlock our old repo if we were
 
635
            # locked.
 
636
            # repositories don't offer an interface to remove fallback
 
637
            # repositories today; take the conceptually simpler option and just
 
638
            # reopen it.
 
639
            self.repository = self.bzrdir.find_repository()
 
640
            self.repository.lock_write()
 
641
            # for every revision reference the branch has, ensure it is pulled
 
642
            # in.
 
643
            source_repository = self._get_fallback_repository(old_url)
 
644
            for revision_id in chain([self.last_revision()],
 
645
                self.tags.get_reverse_tag_dict()):
 
646
                self.repository.fetch(source_repository, revision_id,
 
647
                    find_ghosts=True)
762
648
        else:
763
 
            self._activate_fallback_location(url)
 
649
            self._activate_fallback_location(url, 'write')
764
650
        # write this out after the repository is stacked to avoid setting a
765
651
        # stacked config that doesn't work.
766
652
        self._set_config_location('stacked_on_location', url)
767
653
 
768
 
    def _unstack(self):
769
 
        """Change a branch to be unstacked, copying data as needed.
770
 
        
771
 
        Don't call this directly, use set_stacked_on_url(None).
772
 
        """
773
 
        pb = ui.ui_factory.nested_progress_bar()
774
 
        try:
775
 
            pb.update("Unstacking")
776
 
            # The basic approach here is to fetch the tip of the branch,
777
 
            # including all available ghosts, from the existing stacked
778
 
            # repository into a new repository object without the fallbacks. 
779
 
            #
780
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
781
 
            # correct for CHKMap repostiories
782
 
            old_repository = self.repository
783
 
            if len(old_repository._fallback_repositories) != 1:
784
 
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
787
 
            old_repository.unlock()
788
 
            old_repository.lock_read()
789
 
            try:
790
 
                # Repositories don't offer an interface to remove fallback
791
 
                # repositories today; take the conceptually simpler option and just
792
 
                # reopen it.  We reopen it starting from the URL so that we
793
 
                # get a separate connection for RemoteRepositories and can
794
 
                # stream from one of them to the other.  This does mean doing
795
 
                # separate SSH connection setup, but unstacking is not a
796
 
                # common operation so it's tolerable.
797
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
798
 
                new_repository = new_bzrdir.find_repository()
799
 
                self.repository = new_repository
800
 
                if self.repository._fallback_repositories:
801
 
                    raise AssertionError("didn't expect %r to have "
802
 
                        "fallback_repositories"
803
 
                        % (self.repository,))
804
 
                # this is not paired with an unlock because it's just restoring
805
 
                # the previous state; the lock's released when set_stacked_on_url
806
 
                # returns
807
 
                self.repository.lock_write()
808
 
                # XXX: If you unstack a branch while it has a working tree
809
 
                # with a pending merge, the pending-merged revisions will no
810
 
                # longer be present.  You can (probably) revert and remerge.
811
 
                #
812
 
                # XXX: This only fetches up to the tip of the repository; it
813
 
                # doesn't bring across any tags.  That's fairly consistent
814
 
                # with how branch works, but perhaps not ideal.
815
 
                self.repository.fetch(old_repository,
816
 
                    revision_id=self.last_revision(),
817
 
                    find_ghosts=True)
818
 
            finally:
819
 
                old_repository.unlock()
820
 
        finally:
821
 
            pb.finished()
822
654
 
823
655
    def _set_tags_bytes(self, bytes):
824
656
        """Mirror method for _get_tags_bytes.
860
692
        self._revision_id_to_revno_cache = None
861
693
        self._last_revision_info_cache = None
862
694
        self._merge_sorted_revisions_cache = None
863
 
        self._partial_revision_history_cache = []
864
 
        self._partial_revision_id_to_revno_cache = {}
865
695
 
866
696
    def _gen_revision_history(self):
867
697
        """Return sequence of revision hashes on to this branch.
904
734
 
905
735
    def unbind(self):
906
736
        """Older format branches cannot bind or unbind."""
907
 
        raise errors.UpgradeRequired(self.user_url)
 
737
        raise errors.UpgradeRequired(self.base)
 
738
 
 
739
    def set_append_revisions_only(self, enabled):
 
740
        """Older format branches are never restricted to append-only"""
 
741
        raise errors.UpgradeRequired(self.base)
908
742
 
909
743
    def last_revision(self):
910
744
        """Return last revision id, or NULL_REVISION."""
991
825
        except ValueError:
992
826
            raise errors.NoSuchRevision(self, revision_id)
993
827
 
994
 
    @needs_read_lock
995
828
    def get_rev_id(self, revno, history=None):
996
829
        """Find the revision id of the specified revno."""
997
830
        if revno == 0:
998
831
            return _mod_revision.NULL_REVISION
999
 
        last_revno, last_revid = self.last_revision_info()
1000
 
        if revno == last_revno:
1001
 
            return last_revid
1002
 
        if revno <= 0 or revno > last_revno:
 
832
        if history is None:
 
833
            history = self.revision_history()
 
834
        if revno <= 0 or revno > len(history):
1003
835
            raise errors.NoSuchRevision(self, revno)
1004
 
        distance_from_last = last_revno - revno
1005
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
1006
 
            self._extend_partial_history(distance_from_last)
1007
 
        return self._partial_revision_history_cache[distance_from_last]
 
836
        return history[revno - 1]
1008
837
 
1009
 
    @needs_write_lock
1010
838
    def pull(self, source, overwrite=False, stop_revision=None,
1011
 
             possible_transports=None, *args, **kwargs):
 
839
             possible_transports=None, _override_hook_target=None):
1012
840
        """Mirror source into this branch.
1013
841
 
1014
842
        This branch is considered to be 'local', having low latency.
1015
843
 
1016
844
        :returns: PullResult instance
1017
845
        """
1018
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1019
 
            stop_revision=stop_revision,
1020
 
            possible_transports=possible_transports, *args, **kwargs)
 
846
        raise NotImplementedError(self.pull)
1021
847
 
1022
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
 
        **kwargs):
 
848
    def push(self, target, overwrite=False, stop_revision=None):
1024
849
        """Mirror this branch into target.
1025
850
 
1026
851
        This branch is considered to be 'local', having low latency.
1027
852
        """
1028
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1029
 
            *args, **kwargs)
1030
 
 
1031
 
    def lossy_push(self, target, stop_revision=None):
1032
 
        """Push deltas into another branch.
1033
 
 
1034
 
        :note: This does not, like push, retain the revision ids from 
1035
 
            the source branch and will, rather than adding bzr-specific 
1036
 
            metadata, push only those semantics of the revision that can be 
1037
 
            natively represented by this branch' VCS.
1038
 
 
1039
 
        :param target: Target branch
1040
 
        :param stop_revision: Revision to push, defaults to last revision.
1041
 
        :return: BranchPushResult with an extra member revidmap: 
1042
 
            A dictionary mapping revision ids from the target branch 
1043
 
            to new revision ids in the target branch, for each 
1044
 
            revision that was pushed.
1045
 
        """
1046
 
        inter = InterBranch.get(self, target)
1047
 
        lossy_push = getattr(inter, "lossy_push", None)
1048
 
        if lossy_push is None:
1049
 
            raise errors.LossyPushToSameVCS(self, target)
1050
 
        return lossy_push(stop_revision)
 
853
        raise NotImplementedError(self.push)
1051
854
 
1052
855
    def basis_tree(self):
1053
856
        """Return `Tree` object for last revision."""
1070
873
        try:
1071
874
            return urlutils.join(self.base[:-1], parent)
1072
875
        except errors.InvalidURLJoin, e:
1073
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
876
            raise errors.InaccessibleParent(parent, self.base)
1074
877
 
1075
878
    def _get_parent_location(self):
1076
879
        raise NotImplementedError(self._get_parent_location)
1093
896
            location = None
1094
897
        return location
1095
898
 
1096
 
    def get_child_submit_format(self):
1097
 
        """Return the preferred format of submissions to this branch."""
1098
 
        return self.get_config().get_user_option("child_submit_format")
1099
 
 
1100
899
    def get_submit_branch(self):
1101
900
        """Return the submit location of the branch.
1102
901
 
1161
960
        params = ChangeBranchTipParams(
1162
961
            self, old_revno, new_revno, old_revid, new_revid)
1163
962
        for hook in hooks:
1164
 
            hook(params)
 
963
            try:
 
964
                hook(params)
 
965
            except errors.TipChangeRejected:
 
966
                raise
 
967
            except Exception:
 
968
                exc_info = sys.exc_info()
 
969
                hook_name = Branch.hooks.get_hook_name(hook)
 
970
                raise errors.HookFailed(
 
971
                    'pre_change_branch_tip', hook_name, exc_info)
1165
972
 
1166
973
    @needs_write_lock
1167
974
    def update(self):
1216
1023
        revision_id: if not None, the revision history in the new branch will
1217
1024
                     be truncated to end with revision_id.
1218
1025
        """
1219
 
        if (repository_policy is not None and
1220
 
            repository_policy.requires_stacking()):
1221
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
1026
        result = to_bzrdir.create_branch()
1223
1027
        result.lock_write()
1224
1028
        try:
1245
1049
        source_revno, source_revision_id = self.last_revision_info()
1246
1050
        if revision_id is None:
1247
1051
            revno, revision_id = source_revno, source_revision_id
 
1052
        elif source_revision_id == revision_id:
 
1053
            # we know the revno without needing to walk all of history
 
1054
            revno = source_revno
1248
1055
        else:
1249
 
            graph = self.repository.get_graph()
1250
 
            try:
1251
 
                revno = graph.find_distance_to_null(revision_id, 
1252
 
                    [(source_revision_id, source_revno)])
1253
 
            except errors.GhostRevisionsHaveNoRevno:
1254
 
                # Default to 1, if we can't find anything else
1255
 
                revno = 1
 
1056
            # To figure out the revno for a random revision, we need to build
 
1057
            # the revision history, and count its length.
 
1058
            # We don't care about the order, just how long it is.
 
1059
            # Alternatively, we could start at the current location, and count
 
1060
            # backwards. But there is no guarantee that we will find it since
 
1061
            # it may be a merged revision.
 
1062
            revno = len(list(self.repository.iter_reverse_revision_history(
 
1063
                                                                revision_id)))
1256
1064
        destination.set_last_revision_info(revno, revision_id)
1257
1065
 
1258
1066
    @needs_read_lock
1262
1070
        revision_id: if not None, the revision history in the new branch will
1263
1071
                     be truncated to end with revision_id.
1264
1072
        """
1265
 
        self.update_references(destination)
1266
1073
        self._synchronize_history(destination, revision_id)
1267
1074
        try:
1268
1075
            parent = self.get_parent()
1274
1081
        if self._push_should_merge_tags():
1275
1082
            self.tags.merge_to(destination.tags)
1276
1083
 
1277
 
    def update_references(self, target):
1278
 
        if not getattr(self._format, 'supports_reference_locations', False):
1279
 
            return
1280
 
        reference_dict = self._get_all_reference_info()
1281
 
        if len(reference_dict) == 0:
1282
 
            return
1283
 
        old_base = self.base
1284
 
        new_base = target.base
1285
 
        target_reference_dict = target._get_all_reference_info()
1286
 
        for file_id, (tree_path, branch_location) in (
1287
 
            reference_dict.items()):
1288
 
            branch_location = urlutils.rebase_url(branch_location,
1289
 
                                                  old_base, new_base)
1290
 
            target_reference_dict.setdefault(
1291
 
                file_id, (tree_path, branch_location))
1292
 
        target._set_all_reference_info(target_reference_dict)
1293
 
 
1294
1084
    @needs_read_lock
1295
 
    def check(self, refs):
 
1085
    def check(self):
1296
1086
        """Check consistency of the branch.
1297
1087
 
1298
1088
        In particular this checks that revisions given in the revision-history
1301
1091
 
1302
1092
        Callers will typically also want to check the repository.
1303
1093
 
1304
 
        :param refs: Calculated refs for this branch as specified by
1305
 
            branch._get_check_refs()
1306
1094
        :return: A BranchCheckResult.
1307
1095
        """
1308
 
        result = BranchCheckResult(self)
 
1096
        mainline_parent_id = None
1309
1097
        last_revno, last_revision_id = self.last_revision_info()
1310
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1311
 
        if actual_revno != last_revno:
1312
 
            result.errors.append(errors.BzrCheckError(
1313
 
                'revno does not match len(mainline) %s != %s' % (
1314
 
                last_revno, actual_revno)))
1315
 
        # TODO: We should probably also check that self.revision_history
1316
 
        # matches the repository for older branch formats.
1317
 
        # If looking for the code that cross-checks repository parents against
1318
 
        # the iter_reverse_revision_history output, that is now a repository
1319
 
        # specific check.
1320
 
        return result
 
1098
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
1099
                                last_revision_id))
 
1100
        real_rev_history.reverse()
 
1101
        if len(real_rev_history) != last_revno:
 
1102
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1103
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1104
        # TODO: We should probably also check that real_rev_history actually
 
1105
        #       matches self.revision_history()
 
1106
        for revision_id in real_rev_history:
 
1107
            try:
 
1108
                revision = self.repository.get_revision(revision_id)
 
1109
            except errors.NoSuchRevision, e:
 
1110
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1111
                            % revision_id)
 
1112
            # In general the first entry on the revision history has no parents.
 
1113
            # But it's not illegal for it to have parents listed; this can happen
 
1114
            # in imports from Arch when the parents weren't reachable.
 
1115
            if mainline_parent_id is not None:
 
1116
                if mainline_parent_id not in revision.parent_ids:
 
1117
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1118
                                        "parents of {%s}"
 
1119
                                        % (mainline_parent_id, revision_id))
 
1120
            mainline_parent_id = revision_id
 
1121
        return BranchCheckResult(self)
1321
1122
 
1322
1123
    def _get_checkout_format(self):
1323
1124
        """Return the most suitable metadir for a checkout of this branch.
1333
1134
        return format
1334
1135
 
1335
1136
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1137
        stacked_on=None):
1337
1138
        """Create a clone of this branch and its bzrdir.
1338
1139
 
1339
1140
        :param to_transport: The transport to clone onto.
1340
1141
        :param revision_id: The revision id to use as tip in the new branch.
1341
1142
            If None the tip is obtained from this branch.
1342
1143
        :param stacked_on: An optional URL to stack the clone on.
1343
 
        :param create_prefix: Create any missing directories leading up to
1344
 
            to_transport.
1345
 
        :param use_existing_dir: Use an existing directory if one exists.
1346
1144
        """
1347
1145
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1146
        # clone call. Or something. 20090224 RBC/spiv.
1349
 
        if revision_id is None:
1350
 
            revision_id = self.last_revision()
1351
1147
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
 
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1148
            revision_id=revision_id, stacked_on=stacked_on)
1354
1149
        return dir_to.open_branch()
1355
1150
 
1356
1151
    def create_checkout(self, to_location, revision_id=None,
1375
1170
        if lightweight:
1376
1171
            format = self._get_checkout_format()
1377
1172
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1173
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1174
        else:
1381
1175
            format = self._get_checkout_format()
1382
1176
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1411
1205
        reconciler.reconcile()
1412
1206
        return reconciler
1413
1207
 
1414
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
1208
    def reference_parent(self, file_id, path):
1415
1209
        """Return the parent branch for a tree-reference file_id
1416
1210
        :param file_id: The file_id of the tree reference
1417
1211
        :param path: The path of the file_id in the tree
1418
1212
        :return: A branch associated with the file_id
1419
1213
        """
1420
1214
        # FIXME should provide multiple branches, based on config
1421
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1422
 
                           possible_transports=possible_transports)
 
1215
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1423
1216
 
1424
1217
    def supports_tags(self):
1425
1218
        return self._format.supports_tags()
1426
1219
 
1427
 
    def automatic_tag_name(self, revision_id):
1428
 
        """Try to automatically find the tag name for a revision.
1429
 
 
1430
 
        :param revision_id: Revision id of the revision.
1431
 
        :return: A tag name or None if no tag name could be determined.
1432
 
        """
1433
 
        for hook in Branch.hooks['automatic_tag_name']:
1434
 
            ret = hook(self, revision_id)
1435
 
            if ret is not None:
1436
 
                return ret
1437
 
        return None
1438
 
 
1439
1220
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1221
                                         other_branch):
1441
1222
        """Ensure that revision_b is a descendant of revision_a.
1496
1277
    _formats = {}
1497
1278
    """The known formats."""
1498
1279
 
1499
 
    can_set_append_revisions_only = True
1500
 
 
1501
1280
    def __eq__(self, other):
1502
1281
        return self.__class__ is other.__class__
1503
1282
 
1505
1284
        return not (self == other)
1506
1285
 
1507
1286
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1287
    def find_format(klass, a_bzrdir):
1509
1288
        """Return the format for the branch object in a_bzrdir."""
1510
1289
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1290
            transport = a_bzrdir.get_branch_transport(None)
 
1291
            format_string = transport.get("format").read()
1513
1292
            return klass._formats[format_string]
1514
1293
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1294
            raise errors.NotBranchError(path=transport.base)
1516
1295
        except KeyError:
1517
1296
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1297
 
1554
1333
        """Return the short format description for this format."""
1555
1334
        raise NotImplementedError(self.get_format_description)
1556
1335
 
1557
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1558
 
        hooks = Branch.hooks['post_branch_init']
1559
 
        if not hooks:
1560
 
            return
1561
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1562
 
        for hook in hooks:
1563
 
            hook(params)
1564
 
 
1565
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
 
                           lock_type='metadir', set_format=True):
 
1336
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1337
                           set_format=True):
1567
1338
        """Initialize a branch in a bzrdir, with specified files
1568
1339
 
1569
1340
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1341
        :param utf8_files: The files to create as a list of
1571
1342
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1343
        :param set_format: If True, set the format with
1574
1344
            self.get_format_string.  (BzrBranch4 has its format set
1575
1345
            elsewhere)
1576
1346
        :return: a branch in this format
1577
1347
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1348
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1349
        branch_transport = a_bzrdir.get_branch_transport(self)
1580
1350
        lock_map = {
1581
1351
            'metadir': ('lock', lockdir.LockDir),
1582
1352
            'branch4': ('branch-lock', lockable_files.TransportLock),
1585
1355
        control_files = lockable_files.LockableFiles(branch_transport,
1586
1356
            lock_name, lock_class)
1587
1357
        control_files.create_lock()
1588
 
        try:
1589
 
            control_files.lock_write()
1590
 
        except errors.LockContention:
1591
 
            if lock_type != 'branch4':
1592
 
                raise
1593
 
            lock_taken = False
1594
 
        else:
1595
 
            lock_taken = True
 
1358
        control_files.lock_write()
1596
1359
        if set_format:
1597
1360
            utf8_files += [('format', self.get_format_string())]
1598
1361
        try:
1601
1364
                    filename, content,
1602
1365
                    mode=a_bzrdir._get_file_mode())
1603
1366
        finally:
1604
 
            if lock_taken:
1605
 
                control_files.unlock()
1606
 
        branch = self.open(a_bzrdir, name, _found=True)
1607
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1608
 
        return branch
 
1367
            control_files.unlock()
 
1368
        return self.open(a_bzrdir, _found=True)
1609
1369
 
1610
 
    def initialize(self, a_bzrdir, name=None):
1611
 
        """Create a branch of this format in a_bzrdir.
1612
 
        
1613
 
        :param name: Name of the colocated branch to create.
1614
 
        """
 
1370
    def initialize(self, a_bzrdir):
 
1371
        """Create a branch of this format in a_bzrdir."""
1615
1372
        raise NotImplementedError(self.initialize)
1616
1373
 
1617
1374
    def is_supported(self):
1647
1404
        """
1648
1405
        raise NotImplementedError(self.network_name)
1649
1406
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1407
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1651
1408
        """Return the branch object for a_bzrdir
1652
1409
 
1653
1410
        :param a_bzrdir: A BzrDir that contains a branch.
1654
 
        :param name: Name of colocated branch to open
1655
1411
        :param _found: a private parameter, do not use it. It is used to
1656
1412
            indicate if format probing has already be done.
1657
1413
        :param ignore_fallbacks: when set, no fallback branches will be opened
1671
1427
    def set_default_format(klass, format):
1672
1428
        klass._default_format = format
1673
1429
 
1674
 
    def supports_set_append_revisions_only(self):
1675
 
        """True if this format supports set_append_revisions_only."""
1676
 
        return False
1677
 
 
1678
1430
    def supports_stacking(self):
1679
1431
        """True if this format records a stacked-on branch."""
1680
1432
        return False
1765
1517
            "multiple hooks installed for transform_fallback_location, "
1766
1518
            "all are called with the url returned from the previous hook."
1767
1519
            "The order is however undefined.", (1, 9), None))
1768
 
        self.create_hook(HookPoint('automatic_tag_name',
1769
 
            "Called to determine an automatic tag name for a revision."
1770
 
            "automatic_tag_name is called with (branch, revision_id) and "
1771
 
            "should return a tag name or None if no tag name could be "
1772
 
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
1775
 
            "Called after new branch initialization completes. "
1776
 
            "post_branch_init is called with a "
1777
 
            "bzrlib.branch.BranchInitHookParams. "
1778
 
            "Note that init, branch and checkout (both heavyweight and "
1779
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1780
 
        self.create_hook(HookPoint('post_switch',
1781
 
            "Called after a checkout switches branch. "
1782
 
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1784
 
 
1785
1520
 
1786
1521
 
1787
1522
# install the default hooks into the Branch class.
1826
1561
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1562
 
1828
1563
 
1829
 
class BranchInitHookParams(object):
1830
 
    """Object holding parameters passed to *_branch_init hooks.
1831
 
 
1832
 
    There are 4 fields that hooks may wish to access:
1833
 
 
1834
 
    :ivar format: the branch format
1835
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1836
 
    :ivar name: name of colocated branch, if any (or None)
1837
 
    :ivar branch: the branch created
1838
 
 
1839
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1840
 
    the checkout, hence they are different from the corresponding fields in
1841
 
    branch, which refer to the original branch.
1842
 
    """
1843
 
 
1844
 
    def __init__(self, format, a_bzrdir, name, branch):
1845
 
        """Create a group of BranchInitHook parameters.
1846
 
 
1847
 
        :param format: the branch format
1848
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1849
 
            initialized
1850
 
        :param name: name of colocated branch, if any (or None)
1851
 
        :param branch: the branch created
1852
 
 
1853
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1854
 
        to the checkout, hence they are different from the corresponding fields
1855
 
        in branch, which refer to the original branch.
1856
 
        """
1857
 
        self.format = format
1858
 
        self.bzrdir = a_bzrdir
1859
 
        self.name = name
1860
 
        self.branch = branch
1861
 
 
1862
 
    def __eq__(self, other):
1863
 
        return self.__dict__ == other.__dict__
1864
 
 
1865
 
    def __repr__(self):
1866
 
        if self.branch:
1867
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1868
 
        else:
1869
 
            return "<%s of format:%s bzrdir:%s>" % (
1870
 
                self.__class__.__name__, self.branch,
1871
 
                self.format, self.bzrdir)
1872
 
 
1873
 
 
1874
 
class SwitchHookParams(object):
1875
 
    """Object holding parameters passed to *_switch hooks.
1876
 
 
1877
 
    There are 4 fields that hooks may wish to access:
1878
 
 
1879
 
    :ivar control_dir: BzrDir of the checkout to change
1880
 
    :ivar to_branch: branch that the checkout is to reference
1881
 
    :ivar force: skip the check for local commits in a heavy checkout
1882
 
    :ivar revision_id: revision ID to switch to (or None)
1883
 
    """
1884
 
 
1885
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1886
 
        """Create a group of SwitchHook parameters.
1887
 
 
1888
 
        :param control_dir: BzrDir of the checkout to change
1889
 
        :param to_branch: branch that the checkout is to reference
1890
 
        :param force: skip the check for local commits in a heavy checkout
1891
 
        :param revision_id: revision ID to switch to (or None)
1892
 
        """
1893
 
        self.control_dir = control_dir
1894
 
        self.to_branch = to_branch
1895
 
        self.force = force
1896
 
        self.revision_id = revision_id
1897
 
 
1898
 
    def __eq__(self, other):
1899
 
        return self.__dict__ == other.__dict__
1900
 
 
1901
 
    def __repr__(self):
1902
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1903
 
            self.control_dir, self.to_branch,
1904
 
            self.revision_id)
1905
 
 
1906
 
 
1907
1564
class BzrBranchFormat4(BranchFormat):
1908
1565
    """Bzr branch format 4.
1909
1566
 
1916
1573
        """See BranchFormat.get_format_description()."""
1917
1574
        return "Branch format 4"
1918
1575
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1576
    def initialize(self, a_bzrdir):
1920
1577
        """Create a branch of this format in a_bzrdir."""
1921
1578
        utf8_files = [('revision-history', ''),
1922
1579
                      ('branch-name', ''),
1923
1580
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1581
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1582
                                       lock_type='branch4', set_format=False)
1926
1583
 
1927
1584
    def __init__(self):
1932
1589
        """The network name for this format is the control dirs disk label."""
1933
1590
        return self._matchingbzrdir.get_format_string()
1934
1591
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1592
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1936
1593
        """See BranchFormat.open()."""
1937
1594
        if not _found:
1938
1595
            # we are being called directly and must probe.
1940
1597
        return BzrBranch(_format=self,
1941
1598
                         _control_files=a_bzrdir._control_files,
1942
1599
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1600
                         _repository=a_bzrdir.open_repository())
1945
1601
 
1946
1602
    def __str__(self):
1961
1617
        """
1962
1618
        return self.get_format_string()
1963
1619
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1620
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1965
1621
        """See BranchFormat.open()."""
1966
1622
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1623
            format = BranchFormat.find_format(a_bzrdir)
1968
1624
            if format.__class__ != self.__class__:
1969
1625
                raise AssertionError("wrong format %r found for %r" %
1970
1626
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1627
        try:
 
1628
            transport = a_bzrdir.get_branch_transport(None)
1973
1629
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1630
                                                         lockdir.LockDir)
1975
1631
            return self._branch_class()(_format=self,
1976
1632
                              _control_files=control_files,
1977
 
                              name=name,
1978
1633
                              a_bzrdir=a_bzrdir,
1979
1634
                              _repository=a_bzrdir.find_repository(),
1980
1635
                              ignore_fallbacks=ignore_fallbacks)
1981
1636
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1637
            raise errors.NotBranchError(path=transport.base)
1983
1638
 
1984
1639
    def __init__(self):
1985
1640
        super(BranchFormatMetadir, self).__init__()
2014
1669
        """See BranchFormat.get_format_description()."""
2015
1670
        return "Branch format 5"
2016
1671
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1672
    def initialize(self, a_bzrdir):
2018
1673
        """Create a branch of this format in a_bzrdir."""
2019
1674
        utf8_files = [('revision-history', ''),
2020
1675
                      ('branch-name', ''),
2021
1676
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1677
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1678
 
2024
1679
    def supports_tags(self):
2025
1680
        return False
2047
1702
        """See BranchFormat.get_format_description()."""
2048
1703
        return "Branch format 6"
2049
1704
 
2050
 
    def initialize(self, a_bzrdir, name=None):
2051
 
        """Create a branch of this format in a_bzrdir."""
2052
 
        utf8_files = [('last-revision', '0 null:\n'),
2053
 
                      ('branch.conf', ''),
2054
 
                      ('tags', ''),
2055
 
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2057
 
 
2058
 
    def make_tags(self, branch):
2059
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2060
 
        return BasicTags(branch)
2061
 
 
2062
 
    def supports_set_append_revisions_only(self):
2063
 
        return True
2064
 
 
2065
 
 
2066
 
class BzrBranchFormat8(BranchFormatMetadir):
2067
 
    """Metadir format supporting storing locations of subtree branches."""
2068
 
 
2069
 
    def _branch_class(self):
2070
 
        return BzrBranch8
2071
 
 
2072
 
    def get_format_string(self):
2073
 
        """See BranchFormat.get_format_string()."""
2074
 
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2075
 
 
2076
 
    def get_format_description(self):
2077
 
        """See BranchFormat.get_format_description()."""
2078
 
        return "Branch format 8"
2079
 
 
2080
 
    def initialize(self, a_bzrdir, name=None):
2081
 
        """Create a branch of this format in a_bzrdir."""
2082
 
        utf8_files = [('last-revision', '0 null:\n'),
2083
 
                      ('branch.conf', ''),
2084
 
                      ('tags', ''),
2085
 
                      ('references', '')
2086
 
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2088
 
 
2089
 
    def __init__(self):
2090
 
        super(BzrBranchFormat8, self).__init__()
2091
 
        self._matchingbzrdir.repository_format = \
2092
 
            RepositoryFormatKnitPack5RichRoot()
2093
 
 
2094
 
    def make_tags(self, branch):
2095
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2096
 
        return BasicTags(branch)
2097
 
 
2098
 
    def supports_set_append_revisions_only(self):
2099
 
        return True
2100
 
 
2101
 
    def supports_stacking(self):
2102
 
        return True
2103
 
 
2104
 
    supports_reference_locations = True
2105
 
 
2106
 
 
2107
 
class BzrBranchFormat7(BzrBranchFormat8):
 
1705
    def initialize(self, a_bzrdir):
 
1706
        """Create a branch of this format in a_bzrdir."""
 
1707
        utf8_files = [('last-revision', '0 null:\n'),
 
1708
                      ('branch.conf', ''),
 
1709
                      ('tags', ''),
 
1710
                      ]
 
1711
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1712
 
 
1713
    def make_tags(self, branch):
 
1714
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1715
        return BasicTags(branch)
 
1716
 
 
1717
 
 
1718
 
 
1719
class BzrBranchFormat7(BranchFormatMetadir):
2108
1720
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
1721
 
2110
1722
    The stacked location pointer is passed down to the repository and requires
2113
1725
    This format was introduced in bzr 1.6.
2114
1726
    """
2115
1727
 
2116
 
    def initialize(self, a_bzrdir, name=None):
2117
 
        """Create a branch of this format in a_bzrdir."""
2118
 
        utf8_files = [('last-revision', '0 null:\n'),
2119
 
                      ('branch.conf', ''),
2120
 
                      ('tags', ''),
2121
 
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2123
 
 
2124
1728
    def _branch_class(self):
2125
1729
        return BzrBranch7
2126
1730
 
2132
1736
        """See BranchFormat.get_format_description()."""
2133
1737
        return "Branch format 7"
2134
1738
 
2135
 
    def supports_set_append_revisions_only(self):
 
1739
    def initialize(self, a_bzrdir):
 
1740
        """Create a branch of this format in a_bzrdir."""
 
1741
        utf8_files = [('last-revision', '0 null:\n'),
 
1742
                      ('branch.conf', ''),
 
1743
                      ('tags', ''),
 
1744
                      ]
 
1745
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1746
 
 
1747
    def __init__(self):
 
1748
        super(BzrBranchFormat7, self).__init__()
 
1749
        self._matchingbzrdir.repository_format = \
 
1750
            RepositoryFormatKnitPack5RichRoot()
 
1751
 
 
1752
    def make_tags(self, branch):
 
1753
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1754
        return BasicTags(branch)
 
1755
 
 
1756
    def supports_stacking(self):
2136
1757
        return True
2137
1758
 
2138
 
    supports_reference_locations = False
2139
 
 
2140
1759
 
2141
1760
class BranchReferenceFormat(BranchFormat):
2142
1761
    """Bzr branch reference format.
2160
1779
    def get_reference(self, a_bzrdir):
2161
1780
        """See BranchFormat.get_reference()."""
2162
1781
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1782
        return transport.get('location').read()
2164
1783
 
2165
1784
    def set_reference(self, a_bzrdir, to_branch):
2166
1785
        """See BranchFormat.set_reference()."""
2167
1786
        transport = a_bzrdir.get_branch_transport(None)
2168
1787
        location = transport.put_bytes('location', to_branch.base)
2169
1788
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1789
    def initialize(self, a_bzrdir, target_branch=None):
2171
1790
        """Create a branch of this format in a_bzrdir."""
2172
1791
        if target_branch is None:
2173
1792
            # this format does not implement branch itself, thus the implicit
2174
1793
            # creation contract must see it as uninitializable
2175
1794
            raise errors.UninitializableFormat(self)
2176
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2177
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1795
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1796
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1797
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1798
            target_branch.bzrdir.root_transport.base)
2180
1799
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
1800
        return self.open(
 
1801
            a_bzrdir, _found=True,
2183
1802
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
1803
 
2187
1804
    def __init__(self):
2188
1805
        super(BranchReferenceFormat, self).__init__()
2194
1811
        def clone(to_bzrdir, revision_id=None,
2195
1812
            repository_policy=None):
2196
1813
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1814
            return format.initialize(to_bzrdir, a_branch)
2198
1815
            # cannot obey revision_id limits when cloning a reference ...
2199
1816
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
1817
            # emit some sort of warning/error to the caller ?!
2201
1818
        return clone
2202
1819
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1820
    def open(self, a_bzrdir, _found=False, location=None,
2204
1821
             possible_transports=None, ignore_fallbacks=False):
2205
1822
        """Return the branch that the branch reference in a_bzrdir points at.
2206
1823
 
2207
1824
        :param a_bzrdir: A BzrDir that contains a branch.
2208
 
        :param name: Name of colocated branch to open, if any
2209
1825
        :param _found: a private parameter, do not use it. It is used to
2210
1826
            indicate if format probing has already be done.
2211
1827
        :param ignore_fallbacks: when set, no fallback branches will be opened
2216
1832
        :param possible_transports: An optional reusable transports list.
2217
1833
        """
2218
1834
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1835
            format = BranchFormat.find_format(a_bzrdir)
2220
1836
            if format.__class__ != self.__class__:
2221
1837
                raise AssertionError("wrong format %r found for %r" %
2222
1838
                    (format, self))
2224
1840
            location = self.get_reference(a_bzrdir)
2225
1841
        real_bzrdir = bzrdir.BzrDir.open(
2226
1842
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
1843
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2229
1844
        # this changes the behaviour of result.clone to create a new reference
2230
1845
        # rather than a copy of the content of the branch.
2231
1846
        # I did not use a proxy object because that needs much more extensive
2252
1867
__format5 = BzrBranchFormat5()
2253
1868
__format6 = BzrBranchFormat6()
2254
1869
__format7 = BzrBranchFormat7()
2255
 
__format8 = BzrBranchFormat8()
2256
1870
BranchFormat.register_format(__format5)
2257
1871
BranchFormat.register_format(BranchReferenceFormat())
2258
1872
BranchFormat.register_format(__format6)
2259
1873
BranchFormat.register_format(__format7)
2260
 
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
 
1874
BranchFormat.set_default_format(__format6)
2262
1875
_legacy_formats = [BzrBranchFormat4(),
2263
1876
    ]
2264
1877
network_format_registry.register(
2265
1878
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
1879
 
2267
1880
 
2268
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1881
class BzrBranch(Branch):
2269
1882
    """A branch stored in the actual filesystem.
2270
1883
 
2271
1884
    Note that it's "local" in the context of the filesystem; it doesn't
2277
1890
    :ivar repository: Repository for this branch.
2278
1891
    :ivar base: The url of the base directory for this branch; the one
2279
1892
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
1893
    """
2283
1894
 
2284
1895
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
1896
                 _control_files=None, a_bzrdir=None, _repository=None,
 
1897
                 ignore_fallbacks=False):
2287
1898
        """Create new branch object at a particular location."""
2288
1899
        if a_bzrdir is None:
2289
1900
            raise ValueError('a_bzrdir must be supplied')
2290
1901
        else:
2291
1902
            self.bzrdir = a_bzrdir
2292
1903
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
1904
        # XXX: We should be able to just do
2295
1905
        #   self.base = self.bzrdir.root_transport.base
2296
1906
        # but this does not quite work yet -- mbp 20080522
2303
1913
        Branch.__init__(self)
2304
1914
 
2305
1915
    def __str__(self):
2306
 
        if self.name is None:
2307
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2308
 
        else:
2309
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2310
 
                self.name)
 
1916
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
1917
 
2312
1918
    __repr__ = __str__
2313
1919
 
2324
1930
        return self.control_files.is_locked()
2325
1931
 
2326
1932
    def lock_write(self, token=None):
2327
 
        if not self.is_locked():
2328
 
            self._note_lock('w')
2329
1933
        # All-in-one needs to always unlock/lock.
2330
1934
        repo_control = getattr(self.repository, 'control_files', None)
2331
1935
        if self.control_files == repo_control or not self.is_locked():
2332
 
            self.repository._warn_if_deprecated(self)
2333
1936
            self.repository.lock_write()
2334
1937
            took_lock = True
2335
1938
        else:
2342
1945
            raise
2343
1946
 
2344
1947
    def lock_read(self):
2345
 
        if not self.is_locked():
2346
 
            self._note_lock('r')
2347
1948
        # All-in-one needs to always unlock/lock.
2348
1949
        repo_control = getattr(self.repository, 'control_files', None)
2349
1950
        if self.control_files == repo_control or not self.is_locked():
2350
 
            self.repository._warn_if_deprecated(self)
2351
1951
            self.repository.lock_read()
2352
1952
            took_lock = True
2353
1953
        else:
2359
1959
                self.repository.unlock()
2360
1960
            raise
2361
1961
 
2362
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
1962
    def unlock(self):
2364
1963
        try:
2365
1964
            self.control_files.unlock()
2496
2095
        """See Branch.basis_tree."""
2497
2096
        return self.repository.revision_tree(self.last_revision())
2498
2097
 
 
2098
    @needs_write_lock
 
2099
    def pull(self, source, overwrite=False, stop_revision=None,
 
2100
             _hook_master=None, run_hooks=True, possible_transports=None,
 
2101
             _override_hook_target=None):
 
2102
        """See Branch.pull.
 
2103
 
 
2104
        :param _hook_master: Private parameter - set the branch to
 
2105
            be supplied as the master to pull hooks.
 
2106
        :param run_hooks: Private parameter - if false, this branch
 
2107
            is being called because it's the master of the primary branch,
 
2108
            so it should not run its hooks.
 
2109
        :param _override_hook_target: Private parameter - set the branch to be
 
2110
            supplied as the target_branch to pull hooks.
 
2111
        """
 
2112
        result = PullResult()
 
2113
        result.source_branch = source
 
2114
        if _override_hook_target is None:
 
2115
            result.target_branch = self
 
2116
        else:
 
2117
            result.target_branch = _override_hook_target
 
2118
        source.lock_read()
 
2119
        try:
 
2120
            # We assume that during 'pull' the local repository is closer than
 
2121
            # the remote one.
 
2122
            graph = self.repository.get_graph(source.repository)
 
2123
            result.old_revno, result.old_revid = self.last_revision_info()
 
2124
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
2125
                                  graph=graph)
 
2126
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
2127
            result.new_revno, result.new_revid = self.last_revision_info()
 
2128
            if _hook_master:
 
2129
                result.master_branch = _hook_master
 
2130
                result.local_branch = result.target_branch
 
2131
            else:
 
2132
                result.master_branch = result.target_branch
 
2133
                result.local_branch = None
 
2134
            if run_hooks:
 
2135
                for hook in Branch.hooks['post_pull']:
 
2136
                    hook(result)
 
2137
        finally:
 
2138
            source.unlock()
 
2139
        return result
 
2140
 
2499
2141
    def _get_parent_location(self):
2500
2142
        _locs = ['parent', 'pull', 'x-pull']
2501
2143
        for l in _locs:
2505
2147
                pass
2506
2148
        return None
2507
2149
 
 
2150
    @needs_read_lock
 
2151
    def push(self, target, overwrite=False, stop_revision=None,
 
2152
             _override_hook_source_branch=None):
 
2153
        """See Branch.push.
 
2154
 
 
2155
        This is the basic concrete implementation of push()
 
2156
 
 
2157
        :param _override_hook_source_branch: If specified, run
 
2158
        the hooks passing this Branch as the source, rather than self.
 
2159
        This is for use of RemoteBranch, where push is delegated to the
 
2160
        underlying vfs-based Branch.
 
2161
        """
 
2162
        # TODO: Public option to disable running hooks - should be trivial but
 
2163
        # needs tests.
 
2164
        return _run_with_write_locked_target(
 
2165
            target, self._push_with_bound_branches, target, overwrite,
 
2166
            stop_revision,
 
2167
            _override_hook_source_branch=_override_hook_source_branch)
 
2168
 
 
2169
    def _push_with_bound_branches(self, target, overwrite,
 
2170
            stop_revision,
 
2171
            _override_hook_source_branch=None):
 
2172
        """Push from self into target, and into target's master if any.
 
2173
 
 
2174
        This is on the base BzrBranch class even though it doesn't support
 
2175
        bound branches because the *target* might be bound.
 
2176
        """
 
2177
        def _run_hooks():
 
2178
            if _override_hook_source_branch:
 
2179
                result.source_branch = _override_hook_source_branch
 
2180
            for hook in Branch.hooks['post_push']:
 
2181
                hook(result)
 
2182
 
 
2183
        bound_location = target.get_bound_location()
 
2184
        if bound_location and target.base != bound_location:
 
2185
            # there is a master branch.
 
2186
            #
 
2187
            # XXX: Why the second check?  Is it even supported for a branch to
 
2188
            # be bound to itself? -- mbp 20070507
 
2189
            master_branch = target.get_master_branch()
 
2190
            master_branch.lock_write()
 
2191
            try:
 
2192
                # push into the master from this branch.
 
2193
                self._basic_push(master_branch, overwrite, stop_revision)
 
2194
                # and push into the target branch from this. Note that we push from
 
2195
                # this branch again, because its considered the highest bandwidth
 
2196
                # repository.
 
2197
                result = self._basic_push(target, overwrite, stop_revision)
 
2198
                result.master_branch = master_branch
 
2199
                result.local_branch = target
 
2200
                _run_hooks()
 
2201
                return result
 
2202
            finally:
 
2203
                master_branch.unlock()
 
2204
        else:
 
2205
            # no master branch
 
2206
            result = self._basic_push(target, overwrite, stop_revision)
 
2207
            # TODO: Why set master_branch and local_branch if there's no
 
2208
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
2209
            # 20070504
 
2210
            result.master_branch = target
 
2211
            result.local_branch = None
 
2212
            _run_hooks()
 
2213
            return result
 
2214
 
2508
2215
    def _basic_push(self, target, overwrite, stop_revision):
2509
2216
        """Basic implementation of push without bound branches or hooks.
2510
2217
 
2511
 
        Must be called with source read locked and target write locked.
 
2218
        Must be called with self read locked and target write locked.
2512
2219
        """
2513
2220
        result = BranchPushResult()
2514
2221
        result.source_branch = self
2515
2222
        result.target_branch = target
2516
2223
        result.old_revno, result.old_revid = target.last_revision_info()
2517
 
        self.update_references(target)
2518
2224
        if result.old_revid != self.last_revision():
2519
2225
            # We assume that during 'push' this repository is closer than
2520
2226
            # the target.
2521
2227
            graph = self.repository.get_graph(target.repository)
2522
 
            target.update_revisions(self, stop_revision,
2523
 
                overwrite=overwrite, graph=graph)
 
2228
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
2229
                                    graph=graph)
2524
2230
        if self._push_should_merge_tags():
2525
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2526
 
                overwrite)
 
2231
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2527
2232
        result.new_revno, result.new_revid = target.last_revision_info()
2528
2233
        return result
2529
2234
 
2530
2235
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2236
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2237
 
2533
2238
    def set_push_location(self, location):
2534
2239
        """See Branch.set_push_location."""
2550
2255
    It has support for a master_branch which is the data for bound branches.
2551
2256
    """
2552
2257
 
 
2258
    @needs_write_lock
 
2259
    def pull(self, source, overwrite=False, stop_revision=None,
 
2260
             run_hooks=True, possible_transports=None,
 
2261
             _override_hook_target=None):
 
2262
        """Pull from source into self, updating my master if any.
 
2263
 
 
2264
        :param run_hooks: Private parameter - if false, this branch
 
2265
            is being called because it's the master of the primary branch,
 
2266
            so it should not run its hooks.
 
2267
        """
 
2268
        bound_location = self.get_bound_location()
 
2269
        master_branch = None
 
2270
        if bound_location and source.base != bound_location:
 
2271
            # not pulling from master, so we need to update master.
 
2272
            master_branch = self.get_master_branch(possible_transports)
 
2273
            master_branch.lock_write()
 
2274
        try:
 
2275
            if master_branch:
 
2276
                # pull from source into master.
 
2277
                master_branch.pull(source, overwrite, stop_revision,
 
2278
                    run_hooks=False)
 
2279
            return super(BzrBranch5, self).pull(source, overwrite,
 
2280
                stop_revision, _hook_master=master_branch,
 
2281
                run_hooks=run_hooks,
 
2282
                _override_hook_target=_override_hook_target)
 
2283
        finally:
 
2284
            if master_branch:
 
2285
                master_branch.unlock()
 
2286
 
2553
2287
    def get_bound_location(self):
2554
2288
        try:
2555
2289
            return self._transport.get_bytes('bound')[:-1]
2642
2376
        return None
2643
2377
 
2644
2378
 
2645
 
class BzrBranch8(BzrBranch5):
2646
 
    """A branch that stores tree-reference locations."""
 
2379
class BzrBranch7(BzrBranch5):
 
2380
    """A branch with support for a fallback repository."""
2647
2381
 
2648
2382
    def _open_hook(self):
2649
2383
        if self._ignore_fallbacks:
2661
2395
                    raise AssertionError(
2662
2396
                        "'transform_fallback_location' hook %s returned "
2663
2397
                        "None, not a URL." % hook_name)
2664
 
            self._activate_fallback_location(url)
 
2398
            self._activate_fallback_location(url, None)
2665
2399
 
2666
2400
    def __init__(self, *args, **kwargs):
2667
2401
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2668
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2402
        super(BzrBranch7, self).__init__(*args, **kwargs)
2669
2403
        self._last_revision_info_cache = None
2670
 
        self._reference_info = None
 
2404
        self._partial_revision_history_cache = []
2671
2405
 
2672
2406
    def _clear_cached_state(self):
2673
 
        super(BzrBranch8, self)._clear_cached_state()
 
2407
        super(BzrBranch7, self)._clear_cached_state()
2674
2408
        self._last_revision_info_cache = None
2675
 
        self._reference_info = None
 
2409
        self._partial_revision_history_cache = []
2676
2410
 
2677
2411
    def _last_revision_info(self):
2678
2412
        revision_string = self._transport.get_bytes('last-revision')
2724
2458
        if _mod_revision.is_null(last_revision):
2725
2459
            return
2726
2460
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2461
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2462
 
2729
2463
    def _gen_revision_history(self):
2730
2464
        """Generate the revision history from last revision
2733
2467
        self._extend_partial_history(stop_index=last_revno-1)
2734
2468
        return list(reversed(self._partial_revision_history_cache))
2735
2469
 
 
2470
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2471
        """Extend the partial history to include a given index
 
2472
 
 
2473
        If a stop_index is supplied, stop when that index has been reached.
 
2474
        If a stop_revision is supplied, stop when that revision is
 
2475
        encountered.  Otherwise, stop when the beginning of history is
 
2476
        reached.
 
2477
 
 
2478
        :param stop_index: The index which should be present.  When it is
 
2479
            present, history extension will stop.
 
2480
        :param revision_id: The revision id which should be present.  When
 
2481
            it is encountered, history extension will stop.
 
2482
        """
 
2483
        repo = self.repository
 
2484
        if len(self._partial_revision_history_cache) == 0:
 
2485
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2486
        else:
 
2487
            start_revision = self._partial_revision_history_cache[-1]
 
2488
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2489
            #skip the last revision in the list
 
2490
            next_revision = iterator.next()
 
2491
        for revision_id in iterator:
 
2492
            self._partial_revision_history_cache.append(revision_id)
 
2493
            if (stop_index is not None and
 
2494
                len(self._partial_revision_history_cache) > stop_index):
 
2495
                break
 
2496
            if revision_id == stop_revision:
 
2497
                break
 
2498
 
2736
2499
    def _write_revision_history(self, history):
2737
2500
        """Factored out of set_revision_history.
2738
2501
 
2759
2522
        """Set the parent branch"""
2760
2523
        return self._get_config_location('parent_location')
2761
2524
 
2762
 
    @needs_write_lock
2763
 
    def _set_all_reference_info(self, info_dict):
2764
 
        """Replace all reference info stored in a branch.
2765
 
 
2766
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2767
 
        """
2768
 
        s = StringIO()
2769
 
        writer = rio.RioWriter(s)
2770
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2771
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2772
 
                                branch_location=branch_location)
2773
 
            writer.write_stanza(stanza)
2774
 
        self._transport.put_bytes('references', s.getvalue())
2775
 
        self._reference_info = info_dict
2776
 
 
2777
 
    @needs_read_lock
2778
 
    def _get_all_reference_info(self):
2779
 
        """Return all the reference info stored in a branch.
2780
 
 
2781
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2782
 
        """
2783
 
        if self._reference_info is not None:
2784
 
            return self._reference_info
2785
 
        rio_file = self._transport.get('references')
2786
 
        try:
2787
 
            stanzas = rio.read_stanzas(rio_file)
2788
 
            info_dict = dict((s['file_id'], (s['tree_path'],
2789
 
                             s['branch_location'])) for s in stanzas)
2790
 
        finally:
2791
 
            rio_file.close()
2792
 
        self._reference_info = info_dict
2793
 
        return info_dict
2794
 
 
2795
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2796
 
        """Set the branch location to use for a tree reference.
2797
 
 
2798
 
        :param file_id: The file-id of the tree reference.
2799
 
        :param tree_path: The path of the tree reference in the tree.
2800
 
        :param branch_location: The location of the branch to retrieve tree
2801
 
            references from.
2802
 
        """
2803
 
        info_dict = self._get_all_reference_info()
2804
 
        info_dict[file_id] = (tree_path, branch_location)
2805
 
        if None in (tree_path, branch_location):
2806
 
            if tree_path is not None:
2807
 
                raise ValueError('tree_path must be None when branch_location'
2808
 
                                 ' is None.')
2809
 
            if branch_location is not None:
2810
 
                raise ValueError('branch_location must be None when tree_path'
2811
 
                                 ' is None.')
2812
 
            del info_dict[file_id]
2813
 
        self._set_all_reference_info(info_dict)
2814
 
 
2815
 
    def get_reference_info(self, file_id):
2816
 
        """Get the tree_path and branch_location for a tree reference.
2817
 
 
2818
 
        :return: a tuple of (tree_path, branch_location)
2819
 
        """
2820
 
        return self._get_all_reference_info().get(file_id, (None, None))
2821
 
 
2822
 
    def reference_parent(self, file_id, path, possible_transports=None):
2823
 
        """Return the parent branch for a tree-reference file_id.
2824
 
 
2825
 
        :param file_id: The file_id of the tree reference
2826
 
        :param path: The path of the file_id in the tree
2827
 
        :return: A branch associated with the file_id
2828
 
        """
2829
 
        branch_location = self.get_reference_info(file_id)[1]
2830
 
        if branch_location is None:
2831
 
            return Branch.reference_parent(self, file_id, path,
2832
 
                                           possible_transports)
2833
 
        branch_location = urlutils.join(self.user_url, branch_location)
2834
 
        return Branch.open(branch_location,
2835
 
                           possible_transports=possible_transports)
2836
 
 
2837
2525
    def set_push_location(self, location):
2838
2526
        """See Branch.set_push_location."""
2839
2527
        self._set_config_location('push_location', location)
2881
2569
            raise errors.NotStacked(self)
2882
2570
        return stacked_url
2883
2571
 
 
2572
    def set_append_revisions_only(self, enabled):
 
2573
        if enabled:
 
2574
            value = 'True'
 
2575
        else:
 
2576
            value = 'False'
 
2577
        self.get_config().set_user_option('append_revisions_only', value,
 
2578
            warn_masked=True)
 
2579
 
2884
2580
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2581
        value = self.get_config().get_user_option('append_revisions_only')
 
2582
        return value == 'True'
2887
2583
 
2888
2584
    @needs_write_lock
2889
2585
    def generate_revision_history(self, revision_id, last_rev=None,
2929
2625
        return self.revno() - index
2930
2626
 
2931
2627
 
2932
 
class BzrBranch7(BzrBranch8):
2933
 
    """A branch with support for a fallback repository."""
2934
 
 
2935
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2936
 
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
2937
 
 
2938
 
    def get_reference_info(self, file_id):
2939
 
        Branch.get_reference_info(self, file_id)
2940
 
 
2941
 
    def reference_parent(self, file_id, path, possible_transports=None):
2942
 
        return Branch.reference_parent(self, file_id, path,
2943
 
                                       possible_transports)
2944
 
 
2945
 
 
2946
2628
class BzrBranch6(BzrBranch7):
2947
2629
    """See BzrBranchFormat6 for the capabilities of this branch.
2948
2630
 
2951
2633
    """
2952
2634
 
2953
2635
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2636
        raise errors.UnstackableBranchFormat(self._format, self.base)
2955
2637
 
2956
2638
 
2957
2639
######################################################################
3036
2718
 
3037
2719
    def __init__(self, branch):
3038
2720
        self.branch = branch
3039
 
        self.errors = []
3040
2721
 
3041
2722
    def report_results(self, verbose):
3042
2723
        """Report the check results via trace.note.
3044
2725
        :param verbose: Requests more detailed display of what was checked,
3045
2726
            if any.
3046
2727
        """
3047
 
        note('checked branch %s format %s', self.branch.user_url,
3048
 
            self.branch._format)
3049
 
        for error in self.errors:
3050
 
            note('found error:%s', error)
 
2728
        note('checked branch %s format %s',
 
2729
             self.branch.base,
 
2730
             self.branch._format)
3051
2731
 
3052
2732
 
3053
2733
class Converter5to6(object):
3091
2771
        branch._transport.put_bytes('format', format.get_format_string())
3092
2772
 
3093
2773
 
3094
 
class Converter7to8(object):
3095
 
    """Perform an in-place upgrade of format 6 to format 7"""
3096
 
 
3097
 
    def convert(self, branch):
3098
 
        format = BzrBranchFormat8()
3099
 
        branch._transport.put_bytes('references', '')
3100
 
        # update target format
3101
 
        branch._transport.put_bytes('format', format.get_format_string())
3102
 
 
3103
2774
 
3104
2775
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3105
2776
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3148
2819
    @staticmethod
3149
2820
    def _get_branch_formats_to_test():
3150
2821
        """Return a tuple with the Branch formats to use when testing."""
3151
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3152
 
 
3153
 
    def pull(self, overwrite=False, stop_revision=None,
3154
 
             possible_transports=None, local=False):
3155
 
        """Mirror source into target branch.
3156
 
 
3157
 
        The target branch is considered to be 'local', having low latency.
3158
 
 
3159
 
        :returns: PullResult instance
3160
 
        """
3161
 
        raise NotImplementedError(self.pull)
 
2822
        raise NotImplementedError(self._get_branch_formats_to_test)
3162
2823
 
3163
2824
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
2825
                         graph=None):
3173
2834
        """
3174
2835
        raise NotImplementedError(self.update_revisions)
3175
2836
 
3176
 
    def push(self, overwrite=False, stop_revision=None,
3177
 
             _override_hook_source_branch=None):
3178
 
        """Mirror the source branch into the target branch.
3179
 
 
3180
 
        The source branch is considered to be 'local', having low latency.
3181
 
        """
3182
 
        raise NotImplementedError(self.push)
3183
 
 
3184
2837
 
3185
2838
class GenericInterBranch(InterBranch):
3186
2839
    """InterBranch implementation that uses public Branch functions.
3233
2886
        finally:
3234
2887
            self.source.unlock()
3235
2888
 
3236
 
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3238
 
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
3240
 
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
 
        :param run_hooks: Private parameter - if false, this branch
3244
 
            is being called because it's the master of the primary branch,
3245
 
            so it should not run its hooks.
3246
 
        :param _override_hook_target: Private parameter - set the branch to be
3247
 
            supplied as the target_branch to pull hooks.
3248
 
        :param local: Only update the local branch, and not the bound branch.
3249
 
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
3252
 
            raise errors.LocalRequiresBoundBranch()
3253
 
        result = PullResult()
3254
 
        result.source_branch = self.source
3255
 
        if _override_hook_target is None:
3256
 
            result.target_branch = self.target
3257
 
        else:
3258
 
            result.target_branch = _override_hook_target
3259
 
        self.source.lock_read()
3260
 
        try:
3261
 
            # We assume that during 'pull' the target repository is closer than
3262
 
            # the source one.
3263
 
            self.source.update_references(self.target)
3264
 
            graph = self.target.repository.get_graph(self.source.repository)
3265
 
            # TODO: Branch formats should have a flag that indicates 
3266
 
            # that revno's are expensive, and pull() should honor that flag.
3267
 
            # -- JRV20090506
3268
 
            result.old_revno, result.old_revid = \
3269
 
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
3272
 
            # TODO: The old revid should be specified when merging tags, 
3273
 
            # so a tags implementation that versions tags can only 
3274
 
            # pull in the most recent changes. -- JRV20090506
3275
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
3277
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
 
            if _hook_master:
3279
 
                result.master_branch = _hook_master
3280
 
                result.local_branch = result.target_branch
3281
 
            else:
3282
 
                result.master_branch = result.target_branch
3283
 
                result.local_branch = None
3284
 
            if run_hooks:
3285
 
                for hook in Branch.hooks['post_pull']:
3286
 
                    hook(result)
3287
 
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
3290
 
 
3291
 
    def push(self, overwrite=False, stop_revision=None,
3292
 
             _override_hook_source_branch=None):
3293
 
        """See InterBranch.push.
3294
 
 
3295
 
        This is the basic concrete implementation of push()
3296
 
 
3297
 
        :param _override_hook_source_branch: If specified, run
3298
 
        the hooks passing this Branch as the source, rather than self.
3299
 
        This is for use of RemoteBranch, where push is delegated to the
3300
 
        underlying vfs-based Branch.
3301
 
        """
3302
 
        # TODO: Public option to disable running hooks - should be trivial but
3303
 
        # needs tests.
3304
 
        self.source.lock_read()
3305
 
        try:
3306
 
            return _run_with_write_locked_target(
3307
 
                self.target, self._push_with_bound_branches, overwrite,
3308
 
                stop_revision,
3309
 
                _override_hook_source_branch=_override_hook_source_branch)
3310
 
        finally:
3311
 
            self.source.unlock()
3312
 
 
3313
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3314
 
            _override_hook_source_branch=None):
3315
 
        """Push from source into target, and into target's master if any.
3316
 
        """
3317
 
        def _run_hooks():
3318
 
            if _override_hook_source_branch:
3319
 
                result.source_branch = _override_hook_source_branch
3320
 
            for hook in Branch.hooks['post_push']:
3321
 
                hook(result)
3322
 
 
3323
 
        bound_location = self.target.get_bound_location()
3324
 
        if bound_location and self.target.base != bound_location:
3325
 
            # there is a master branch.
3326
 
            #
3327
 
            # XXX: Why the second check?  Is it even supported for a branch to
3328
 
            # be bound to itself? -- mbp 20070507
3329
 
            master_branch = self.target.get_master_branch()
3330
 
            master_branch.lock_write()
3331
 
            try:
3332
 
                # push into the master from the source branch.
3333
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3334
 
                # and push into the target branch from the source. Note that we
3335
 
                # push from the source branch again, because its considered the
3336
 
                # highest bandwidth repository.
3337
 
                result = self.source._basic_push(self.target, overwrite,
3338
 
                    stop_revision)
3339
 
                result.master_branch = master_branch
3340
 
                result.local_branch = self.target
3341
 
                _run_hooks()
3342
 
                return result
3343
 
            finally:
3344
 
                master_branch.unlock()
3345
 
        else:
3346
 
            # no master branch
3347
 
            result = self.source._basic_push(self.target, overwrite,
3348
 
                stop_revision)
3349
 
            # TODO: Why set master_branch and local_branch if there's no
3350
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3351
 
            # 20070504
3352
 
            result.master_branch = self.target
3353
 
            result.local_branch = None
3354
 
            _run_hooks()
3355
 
            return result
3356
 
 
3357
2889
    @classmethod
3358
2890
    def is_compatible(self, source, target):
3359
2891
        # GenericBranch uses the public API, so always compatible
3360
2892
        return True
3361
2893
 
3362
2894
 
3363
 
class InterToBranch5(GenericInterBranch):
3364
 
 
3365
 
    @staticmethod
3366
 
    def _get_branch_formats_to_test():
3367
 
        return BranchFormat._default_format, BzrBranchFormat5()
3368
 
 
3369
 
    def pull(self, overwrite=False, stop_revision=None,
3370
 
             possible_transports=None, run_hooks=True,
3371
 
             _override_hook_target=None, local=False):
3372
 
        """Pull from source into self, updating my master if any.
3373
 
 
3374
 
        :param run_hooks: Private parameter - if false, this branch
3375
 
            is being called because it's the master of the primary branch,
3376
 
            so it should not run its hooks.
3377
 
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
3380
 
            raise errors.LocalRequiresBoundBranch()
3381
 
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
3383
 
            # not pulling from master, so we need to update master.
3384
 
            master_branch = self.target.get_master_branch(possible_transports)
3385
 
            master_branch.lock_write()
3386
 
        try:
3387
 
            if master_branch:
3388
 
                # pull from source into master.
3389
 
                master_branch.pull(self.source, overwrite, stop_revision,
3390
 
                    run_hooks=False)
3391
 
            return super(InterToBranch5, self).pull(overwrite,
3392
 
                stop_revision, _hook_master=master_branch,
3393
 
                run_hooks=run_hooks,
3394
 
                _override_hook_target=_override_hook_target)
3395
 
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
3398
 
 
3399
 
 
3400
2895
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)