/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2009-05-12 03:50:39 UTC
  • mto: This revision was merged to the branch mainline in revision 4593.
  • Revision ID: robertc@robertcollins.net-20090512035039-6x0pahpjpkdnm9zb
Note another possible error.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
46
46
    )
47
47
""")
48
48
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
50
from bzrlib.hooks import HookPoint, Hooks
51
51
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
53
52
from bzrlib import registry
54
53
from bzrlib.symbol_versioning import (
55
54
    deprecated_in,
63
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
63
 
65
64
 
66
 
class Branch(bzrdir.ControlComponent):
 
65
# TODO: Maybe include checks for common corruption of newlines, etc?
 
66
 
 
67
# TODO: Some operations like log might retrieve the same revisions
 
68
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
69
# cache in memory to make this faster.  In general anything can be
 
70
# cached in memory between lock and unlock operations. .. nb thats
 
71
# what the transaction identity map provides
 
72
 
 
73
 
 
74
######################################################################
 
75
# branch objects
 
76
 
 
77
class Branch(object):
67
78
    """Branch holding a history of revisions.
68
79
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
80
    base
 
81
        Base directory/url of the branch.
72
82
 
73
83
    hooks: An instance of BranchHooks.
74
84
    """
76
86
    # - RBC 20060112
77
87
    base = None
78
88
 
79
 
    @property
80
 
    def control_transport(self):
81
 
        return self._transport
82
 
 
83
 
    @property
84
 
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
86
 
 
87
89
    def __init__(self, *ignored, **ignored_too):
88
90
        self.tags = self._format.make_tags(self)
89
91
        self._revision_history_cache = None
90
92
        self._revision_id_to_revno_cache = None
91
93
        self._partial_revision_id_to_revno_cache = {}
92
 
        self._partial_revision_history_cache = []
93
94
        self._last_revision_info_cache = None
94
95
        self._merge_sorted_revisions_cache = None
95
96
        self._open_hook()
100
101
    def _open_hook(self):
101
102
        """Called by init to allow simpler extension of the base class."""
102
103
 
103
 
    def _activate_fallback_location(self, url):
 
104
    def _activate_fallback_location(self, url, lock_style):
104
105
        """Activate the branch/repository from url as a fallback repository."""
105
106
        repo = self._get_fallback_repository(url)
106
 
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
107
        if lock_style == 'write':
 
108
            repo.lock_write()
 
109
        elif lock_style == 'read':
 
110
            repo.lock_read()
108
111
        self.repository.add_fallback_repository(repo)
109
112
 
110
113
    def break_lock(self):
126
129
            raise errors.UnstackableRepositoryFormat(self.repository._format,
127
130
                self.repository.base)
128
131
 
129
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
 
        """Extend the partial history to include a given index
131
 
 
132
 
        If a stop_index is supplied, stop when that index has been reached.
133
 
        If a stop_revision is supplied, stop when that revision is
134
 
        encountered.  Otherwise, stop when the beginning of history is
135
 
        reached.
136
 
 
137
 
        :param stop_index: The index which should be present.  When it is
138
 
            present, history extension will stop.
139
 
        :param stop_revision: The revision id which should be present.  When
140
 
            it is encountered, history extension will stop.
141
 
        """
142
 
        if len(self._partial_revision_history_cache) == 0:
143
 
            self._partial_revision_history_cache = [self.last_revision()]
144
 
        repository._iter_for_revno(
145
 
            self.repository, self._partial_revision_history_cache,
146
 
            stop_index=stop_index, stop_revision=stop_revision)
147
 
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
 
            self._partial_revision_history_cache.pop()
149
 
 
150
132
    def _get_check_refs(self):
151
133
        """Get the references needed for check().
152
134
 
164
146
        """
165
147
        control = bzrdir.BzrDir.open(base, _unsupported,
166
148
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
149
        return control.open_branch(_unsupported)
168
150
 
169
151
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
152
    def open_from_transport(transport, _unsupported=False):
171
153
        """Open the branch rooted at transport"""
172
154
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
155
        return control.open_branch(_unsupported)
174
156
 
175
157
    @staticmethod
176
158
    def open_containing(url, possible_transports=None):
214
196
    def _get_fallback_repository(self, url):
215
197
        """Get the repository we fallback to at url."""
216
198
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
199
        a_bzrdir = bzrdir.BzrDir.open(url,
218
200
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
201
        return a_bzrdir.open_branch().repository
220
202
 
221
203
    def _get_tags_bytes(self):
222
204
        """Get the bytes of a serialised tags dict.
417
399
            * 'include' - the stop revision is the last item in the result
418
400
            * 'with-merges' - include the stop revision and all of its
419
401
              merged revisions in the result
420
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
 
              that are in both ancestries
422
402
        :param direction: either 'reverse' or 'forward':
423
403
            * reverse means return the start_revision_id first, i.e.
424
404
              start at the most recent revision and go backwards in history
446
426
        # start_revision_id.
447
427
        if self._merge_sorted_revisions_cache is None:
448
428
            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)
 
429
            graph = self.repository.get_graph()
 
430
            parent_map = dict(((key, value) for key, value in
 
431
                     graph.iter_ancestry([last_revision]) if value is not None))
 
432
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
433
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
434
                generate_revno=True)
 
435
            # Drop the sequence # before caching
 
436
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
437
 
453
438
        filtered = self._filter_merge_sorted_revisions(
454
439
            self._merge_sorted_revisions_cache, start_revision_id,
455
440
            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
441
        if direction == 'reverse':
460
442
            return filtered
461
443
        if direction == 'forward':
468
450
        """Iterate over an inclusive range of sorted revisions."""
469
451
        rev_iter = iter(merge_sorted_revisions)
470
452
        if start_revision_id is not None:
471
 
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
453
            for rev_id, depth, revno, end_of_merge in rev_iter:
473
454
                if rev_id != start_revision_id:
474
455
                    continue
475
456
                else:
476
457
                    # The decision to include the start or not
477
458
                    # 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)
 
459
                    rev_iter = chain(
 
460
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
461
                        rev_iter)
480
462
                    break
481
463
        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)
 
464
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
465
                yield rev_id, depth, revno, end_of_merge
487
466
        elif stop_rule == 'exclude':
488
 
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
467
            for rev_id, depth, revno, end_of_merge in rev_iter:
490
468
                if rev_id == stop_revision_id:
491
469
                    return
492
 
                yield (rev_id, node.merge_depth, node.revno,
493
 
                       node.end_of_merge)
 
470
                yield rev_id, depth, revno, end_of_merge
494
471
        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)
 
472
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
473
                yield rev_id, depth, revno, end_of_merge
499
474
                if rev_id == stop_revision_id:
500
475
                    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
476
        elif stop_rule == 'with-merges':
514
477
            stop_rev = self.repository.get_revision(stop_revision_id)
515
478
            if stop_rev.parent_ids:
516
479
                left_parent = stop_rev.parent_ids[0]
517
480
            else:
518
481
                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]
 
482
            for rev_id, depth, revno, end_of_merge in rev_iter:
525
483
                if rev_id == left_parent:
526
 
                    # reached the left parent after the stop_revision
527
484
                    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)
 
485
                yield rev_id, depth, revno, end_of_merge
538
486
        else:
539
487
            raise ValueError('invalid stop_rule %r' % stop_rule)
540
488
 
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
489
    def leave_lock_in_place(self):
587
490
        """Tell this branch object not to release the physical lock when this
588
491
        object is unlocked.
605
508
        :param other: The branch to bind to
606
509
        :type other: Branch
607
510
        """
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)
 
511
        raise errors.UpgradeRequired(self.base)
619
512
 
620
513
    def set_reference_info(self, file_id, tree_path, branch_location):
621
514
        """Set the branch location to use for a tree reference."""
663
556
    def get_old_bound_location(self):
664
557
        """Return the URL of the branch we used to be bound to
665
558
        """
666
 
        raise errors.UpgradeRequired(self.user_url)
 
559
        raise errors.UpgradeRequired(self.base)
667
560
 
668
561
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
562
                           timezone=None, committer=None, revprops=None,
747
640
            stacking.
748
641
        """
749
642
        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.
 
643
            raise errors.UnstackableBranchFormat(self._format, self.base)
754
644
        self._check_stackable_repo()
755
645
        if not url:
756
646
            try:
758
648
            except (errors.NotStacked, errors.UnstackableBranchFormat,
759
649
                errors.UnstackableRepositoryFormat):
760
650
                return
761
 
            self._unstack()
 
651
            url = ''
 
652
            # XXX: Lock correctness - should unlock our old repo if we were
 
653
            # locked.
 
654
            # repositories don't offer an interface to remove fallback
 
655
            # repositories today; take the conceptually simpler option and just
 
656
            # reopen it.
 
657
            self.repository = self.bzrdir.find_repository()
 
658
            self.repository.lock_write()
 
659
            # for every revision reference the branch has, ensure it is pulled
 
660
            # in.
 
661
            source_repository = self._get_fallback_repository(old_url)
 
662
            for revision_id in chain([self.last_revision()],
 
663
                self.tags.get_reverse_tag_dict()):
 
664
                self.repository.fetch(source_repository, revision_id,
 
665
                    find_ghosts=True)
762
666
        else:
763
 
            self._activate_fallback_location(url)
 
667
            self._activate_fallback_location(url, 'write')
764
668
        # write this out after the repository is stacked to avoid setting a
765
669
        # stacked config that doesn't work.
766
670
        self._set_config_location('stacked_on_location', url)
767
671
 
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
672
 
823
673
    def _set_tags_bytes(self, bytes):
824
674
        """Mirror method for _get_tags_bytes.
860
710
        self._revision_id_to_revno_cache = None
861
711
        self._last_revision_info_cache = None
862
712
        self._merge_sorted_revisions_cache = None
863
 
        self._partial_revision_history_cache = []
864
 
        self._partial_revision_id_to_revno_cache = {}
865
713
 
866
714
    def _gen_revision_history(self):
867
715
        """Return sequence of revision hashes on to this branch.
904
752
 
905
753
    def unbind(self):
906
754
        """Older format branches cannot bind or unbind."""
907
 
        raise errors.UpgradeRequired(self.user_url)
 
755
        raise errors.UpgradeRequired(self.base)
 
756
 
 
757
    def set_append_revisions_only(self, enabled):
 
758
        """Older format branches are never restricted to append-only"""
 
759
        raise errors.UpgradeRequired(self.base)
908
760
 
909
761
    def last_revision(self):
910
762
        """Return last revision id, or NULL_REVISION."""
991
843
        except ValueError:
992
844
            raise errors.NoSuchRevision(self, revision_id)
993
845
 
994
 
    @needs_read_lock
995
846
    def get_rev_id(self, revno, history=None):
996
847
        """Find the revision id of the specified revno."""
997
848
        if revno == 0:
998
849
            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:
 
850
        if history is None:
 
851
            history = self.revision_history()
 
852
        if revno <= 0 or revno > len(history):
1003
853
            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]
 
854
        return history[revno - 1]
1008
855
 
1009
 
    @needs_write_lock
1010
856
    def pull(self, source, overwrite=False, stop_revision=None,
1011
 
             possible_transports=None, *args, **kwargs):
 
857
             possible_transports=None, _override_hook_target=None):
1012
858
        """Mirror source into this branch.
1013
859
 
1014
860
        This branch is considered to be 'local', having low latency.
1015
861
 
1016
862
        :returns: PullResult instance
1017
863
        """
1018
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1019
 
            stop_revision=stop_revision,
1020
 
            possible_transports=possible_transports, *args, **kwargs)
 
864
        raise NotImplementedError(self.pull)
1021
865
 
1022
866
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
867
        **kwargs):
1028
872
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1029
873
            *args, **kwargs)
1030
874
 
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)
1051
 
 
1052
875
    def basis_tree(self):
1053
876
        """Return `Tree` object for last revision."""
1054
877
        return self.repository.revision_tree(self.last_revision())
1070
893
        try:
1071
894
            return urlutils.join(self.base[:-1], parent)
1072
895
        except errors.InvalidURLJoin, e:
1073
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
896
            raise errors.InaccessibleParent(parent, self.base)
1074
897
 
1075
898
    def _get_parent_location(self):
1076
899
        raise NotImplementedError(self._get_parent_location)
1093
916
            location = None
1094
917
        return location
1095
918
 
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
919
    def get_submit_branch(self):
1101
920
        """Return the submit location of the branch.
1102
921
 
1161
980
        params = ChangeBranchTipParams(
1162
981
            self, old_revno, new_revno, old_revid, new_revid)
1163
982
        for hook in hooks:
1164
 
            hook(params)
 
983
            try:
 
984
                hook(params)
 
985
            except errors.TipChangeRejected:
 
986
                raise
 
987
            except Exception:
 
988
                exc_info = sys.exc_info()
 
989
                hook_name = Branch.hooks.get_hook_name(hook)
 
990
                raise errors.HookFailed(
 
991
                    'pre_change_branch_tip', hook_name, exc_info)
1165
992
 
1166
993
    @needs_write_lock
1167
994
    def update(self):
1216
1043
        revision_id: if not None, the revision history in the new branch will
1217
1044
                     be truncated to end with revision_id.
1218
1045
        """
1219
 
        if (repository_policy is not None and
1220
 
            repository_policy.requires_stacking()):
1221
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
1046
        result = to_bzrdir.create_branch()
1223
1047
        result.lock_write()
1224
1048
        try:
1245
1069
        source_revno, source_revision_id = self.last_revision_info()
1246
1070
        if revision_id is None:
1247
1071
            revno, revision_id = source_revno, source_revision_id
 
1072
        elif source_revision_id == revision_id:
 
1073
            # we know the revno without needing to walk all of history
 
1074
            revno = source_revno
1248
1075
        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
 
1076
            # To figure out the revno for a random revision, we need to build
 
1077
            # the revision history, and count its length.
 
1078
            # We don't care about the order, just how long it is.
 
1079
            # Alternatively, we could start at the current location, and count
 
1080
            # backwards. But there is no guarantee that we will find it since
 
1081
            # it may be a merged revision.
 
1082
            revno = len(list(self.repository.iter_reverse_revision_history(
 
1083
                                                                revision_id)))
1256
1084
        destination.set_last_revision_info(revno, revision_id)
1257
1085
 
1258
1086
    @needs_read_lock
1348
1176
        # clone call. Or something. 20090224 RBC/spiv.
1349
1177
        if revision_id is None:
1350
1178
            revision_id = self.last_revision()
1351
 
        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)
 
1179
        try:
 
1180
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1181
                revision_id=revision_id, stacked_on=stacked_on,
 
1182
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1183
        except errors.FileExists:
 
1184
            if not use_existing_dir:
 
1185
                raise
 
1186
        except errors.NoSuchFile:
 
1187
            if not create_prefix:
 
1188
                raise
1354
1189
        return dir_to.open_branch()
1355
1190
 
1356
1191
    def create_checkout(self, to_location, revision_id=None,
1375
1210
        if lightweight:
1376
1211
            format = self._get_checkout_format()
1377
1212
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1213
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1214
        else:
1381
1215
            format = self._get_checkout_format()
1382
1216
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1424
1258
    def supports_tags(self):
1425
1259
        return self._format.supports_tags()
1426
1260
 
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
1261
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1262
                                         other_branch):
1441
1263
        """Ensure that revision_b is a descendant of revision_a.
1496
1318
    _formats = {}
1497
1319
    """The known formats."""
1498
1320
 
1499
 
    can_set_append_revisions_only = True
1500
 
 
1501
1321
    def __eq__(self, other):
1502
1322
        return self.__class__ is other.__class__
1503
1323
 
1505
1325
        return not (self == other)
1506
1326
 
1507
1327
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1328
    def find_format(klass, a_bzrdir):
1509
1329
        """Return the format for the branch object in a_bzrdir."""
1510
1330
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1331
            transport = a_bzrdir.get_branch_transport(None)
 
1332
            format_string = transport.get("format").read()
1513
1333
            return klass._formats[format_string]
1514
1334
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1335
            raise errors.NotBranchError(path=transport.base)
1516
1336
        except KeyError:
1517
1337
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1338
 
1554
1374
        """Return the short format description for this format."""
1555
1375
        raise NotImplementedError(self.get_format_description)
1556
1376
 
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):
 
1377
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1378
                           set_format=True):
1567
1379
        """Initialize a branch in a bzrdir, with specified files
1568
1380
 
1569
1381
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1382
        :param utf8_files: The files to create as a list of
1571
1383
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1384
        :param set_format: If True, set the format with
1574
1385
            self.get_format_string.  (BzrBranch4 has its format set
1575
1386
            elsewhere)
1576
1387
        :return: a branch in this format
1577
1388
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1389
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1390
        branch_transport = a_bzrdir.get_branch_transport(self)
1580
1391
        lock_map = {
1581
1392
            'metadir': ('lock', lockdir.LockDir),
1582
1393
            'branch4': ('branch-lock', lockable_files.TransportLock),
1603
1414
        finally:
1604
1415
            if lock_taken:
1605
1416
                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
 
1417
        return self.open(a_bzrdir, _found=True)
1609
1418
 
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
 
        """
 
1419
    def initialize(self, a_bzrdir):
 
1420
        """Create a branch of this format in a_bzrdir."""
1615
1421
        raise NotImplementedError(self.initialize)
1616
1422
 
1617
1423
    def is_supported(self):
1647
1453
        """
1648
1454
        raise NotImplementedError(self.network_name)
1649
1455
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1456
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1651
1457
        """Return the branch object for a_bzrdir
1652
1458
 
1653
1459
        :param a_bzrdir: A BzrDir that contains a branch.
1654
 
        :param name: Name of colocated branch to open
1655
1460
        :param _found: a private parameter, do not use it. It is used to
1656
1461
            indicate if format probing has already be done.
1657
1462
        :param ignore_fallbacks: when set, no fallback branches will be opened
1671
1476
    def set_default_format(klass, format):
1672
1477
        klass._default_format = format
1673
1478
 
1674
 
    def supports_set_append_revisions_only(self):
1675
 
        """True if this format supports set_append_revisions_only."""
1676
 
        return False
1677
 
 
1678
1479
    def supports_stacking(self):
1679
1480
        """True if this format records a stacked-on branch."""
1680
1481
        return False
1765
1566
            "multiple hooks installed for transform_fallback_location, "
1766
1567
            "all are called with the url returned from the previous hook."
1767
1568
            "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
1569
 
1786
1570
 
1787
1571
# install the default hooks into the Branch class.
1826
1610
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1611
 
1828
1612
 
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
1613
class BzrBranchFormat4(BranchFormat):
1908
1614
    """Bzr branch format 4.
1909
1615
 
1916
1622
        """See BranchFormat.get_format_description()."""
1917
1623
        return "Branch format 4"
1918
1624
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1625
    def initialize(self, a_bzrdir):
1920
1626
        """Create a branch of this format in a_bzrdir."""
1921
1627
        utf8_files = [('revision-history', ''),
1922
1628
                      ('branch-name', ''),
1923
1629
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1630
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1631
                                       lock_type='branch4', set_format=False)
1926
1632
 
1927
1633
    def __init__(self):
1932
1638
        """The network name for this format is the control dirs disk label."""
1933
1639
        return self._matchingbzrdir.get_format_string()
1934
1640
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1641
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1936
1642
        """See BranchFormat.open()."""
1937
1643
        if not _found:
1938
1644
            # we are being called directly and must probe.
1940
1646
        return BzrBranch(_format=self,
1941
1647
                         _control_files=a_bzrdir._control_files,
1942
1648
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1649
                         _repository=a_bzrdir.open_repository())
1945
1650
 
1946
1651
    def __str__(self):
1961
1666
        """
1962
1667
        return self.get_format_string()
1963
1668
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1669
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1965
1670
        """See BranchFormat.open()."""
1966
1671
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1672
            format = BranchFormat.find_format(a_bzrdir)
1968
1673
            if format.__class__ != self.__class__:
1969
1674
                raise AssertionError("wrong format %r found for %r" %
1970
1675
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1676
        try:
 
1677
            transport = a_bzrdir.get_branch_transport(None)
1973
1678
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1679
                                                         lockdir.LockDir)
1975
1680
            return self._branch_class()(_format=self,
1976
1681
                              _control_files=control_files,
1977
 
                              name=name,
1978
1682
                              a_bzrdir=a_bzrdir,
1979
1683
                              _repository=a_bzrdir.find_repository(),
1980
1684
                              ignore_fallbacks=ignore_fallbacks)
1981
1685
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1686
            raise errors.NotBranchError(path=transport.base)
1983
1687
 
1984
1688
    def __init__(self):
1985
1689
        super(BranchFormatMetadir, self).__init__()
2014
1718
        """See BranchFormat.get_format_description()."""
2015
1719
        return "Branch format 5"
2016
1720
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1721
    def initialize(self, a_bzrdir):
2018
1722
        """Create a branch of this format in a_bzrdir."""
2019
1723
        utf8_files = [('revision-history', ''),
2020
1724
                      ('branch-name', ''),
2021
1725
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1726
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1727
 
2024
1728
    def supports_tags(self):
2025
1729
        return False
2047
1751
        """See BranchFormat.get_format_description()."""
2048
1752
        return "Branch format 6"
2049
1753
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
1754
    def initialize(self, a_bzrdir):
2051
1755
        """Create a branch of this format in a_bzrdir."""
2052
1756
        utf8_files = [('last-revision', '0 null:\n'),
2053
1757
                      ('branch.conf', ''),
2054
1758
                      ('tags', ''),
2055
1759
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1760
        return self._initialize_helper(a_bzrdir, utf8_files)
2057
1761
 
2058
1762
    def make_tags(self, branch):
2059
1763
        """See bzrlib.branch.BranchFormat.make_tags()."""
2060
1764
        return BasicTags(branch)
2061
1765
 
2062
 
    def supports_set_append_revisions_only(self):
2063
 
        return True
2064
1766
 
2065
1767
 
2066
1768
class BzrBranchFormat8(BranchFormatMetadir):
2077
1779
        """See BranchFormat.get_format_description()."""
2078
1780
        return "Branch format 8"
2079
1781
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
1782
    def initialize(self, a_bzrdir):
2081
1783
        """Create a branch of this format in a_bzrdir."""
2082
1784
        utf8_files = [('last-revision', '0 null:\n'),
2083
1785
                      ('branch.conf', ''),
2084
1786
                      ('tags', ''),
2085
1787
                      ('references', '')
2086
1788
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1789
        return self._initialize_helper(a_bzrdir, utf8_files)
2088
1790
 
2089
1791
    def __init__(self):
2090
1792
        super(BzrBranchFormat8, self).__init__()
2095
1797
        """See bzrlib.branch.BranchFormat.make_tags()."""
2096
1798
        return BasicTags(branch)
2097
1799
 
2098
 
    def supports_set_append_revisions_only(self):
2099
 
        return True
2100
 
 
2101
1800
    def supports_stacking(self):
2102
1801
        return True
2103
1802
 
2113
1812
    This format was introduced in bzr 1.6.
2114
1813
    """
2115
1814
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
1815
    def initialize(self, a_bzrdir):
2117
1816
        """Create a branch of this format in a_bzrdir."""
2118
1817
        utf8_files = [('last-revision', '0 null:\n'),
2119
1818
                      ('branch.conf', ''),
2120
1819
                      ('tags', ''),
2121
1820
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1821
        return self._initialize_helper(a_bzrdir, utf8_files)
2123
1822
 
2124
1823
    def _branch_class(self):
2125
1824
        return BzrBranch7
2132
1831
        """See BranchFormat.get_format_description()."""
2133
1832
        return "Branch format 7"
2134
1833
 
2135
 
    def supports_set_append_revisions_only(self):
2136
 
        return True
2137
 
 
2138
1834
    supports_reference_locations = False
2139
1835
 
2140
1836
 
2160
1856
    def get_reference(self, a_bzrdir):
2161
1857
        """See BranchFormat.get_reference()."""
2162
1858
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1859
        return transport.get('location').read()
2164
1860
 
2165
1861
    def set_reference(self, a_bzrdir, to_branch):
2166
1862
        """See BranchFormat.set_reference()."""
2167
1863
        transport = a_bzrdir.get_branch_transport(None)
2168
1864
        location = transport.put_bytes('location', to_branch.base)
2169
1865
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1866
    def initialize(self, a_bzrdir, target_branch=None):
2171
1867
        """Create a branch of this format in a_bzrdir."""
2172
1868
        if target_branch is None:
2173
1869
            # this format does not implement branch itself, thus the implicit
2174
1870
            # creation contract must see it as uninitializable
2175
1871
            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)
 
1872
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1873
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1874
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1875
            target_branch.bzrdir.root_transport.base)
2180
1876
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
1877
        return self.open(
 
1878
            a_bzrdir, _found=True,
2183
1879
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
1880
 
2187
1881
    def __init__(self):
2188
1882
        super(BranchReferenceFormat, self).__init__()
2194
1888
        def clone(to_bzrdir, revision_id=None,
2195
1889
            repository_policy=None):
2196
1890
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1891
            return format.initialize(to_bzrdir, a_branch)
2198
1892
            # cannot obey revision_id limits when cloning a reference ...
2199
1893
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
1894
            # emit some sort of warning/error to the caller ?!
2201
1895
        return clone
2202
1896
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1897
    def open(self, a_bzrdir, _found=False, location=None,
2204
1898
             possible_transports=None, ignore_fallbacks=False):
2205
1899
        """Return the branch that the branch reference in a_bzrdir points at.
2206
1900
 
2207
1901
        :param a_bzrdir: A BzrDir that contains a branch.
2208
 
        :param name: Name of colocated branch to open, if any
2209
1902
        :param _found: a private parameter, do not use it. It is used to
2210
1903
            indicate if format probing has already be done.
2211
1904
        :param ignore_fallbacks: when set, no fallback branches will be opened
2216
1909
        :param possible_transports: An optional reusable transports list.
2217
1910
        """
2218
1911
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1912
            format = BranchFormat.find_format(a_bzrdir)
2220
1913
            if format.__class__ != self.__class__:
2221
1914
                raise AssertionError("wrong format %r found for %r" %
2222
1915
                    (format, self))
2224
1917
            location = self.get_reference(a_bzrdir)
2225
1918
        real_bzrdir = bzrdir.BzrDir.open(
2226
1919
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
1920
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2229
1921
        # this changes the behaviour of result.clone to create a new reference
2230
1922
        # rather than a copy of the content of the branch.
2231
1923
        # I did not use a proxy object because that needs much more extensive
2258
1950
BranchFormat.register_format(__format6)
2259
1951
BranchFormat.register_format(__format7)
2260
1952
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
 
1953
BranchFormat.set_default_format(__format6)
2262
1954
_legacy_formats = [BzrBranchFormat4(),
2263
1955
    ]
2264
1956
network_format_registry.register(
2265
1957
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
1958
 
2267
1959
 
2268
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1960
class BzrBranch(Branch):
2269
1961
    """A branch stored in the actual filesystem.
2270
1962
 
2271
1963
    Note that it's "local" in the context of the filesystem; it doesn't
2277
1969
    :ivar repository: Repository for this branch.
2278
1970
    :ivar base: The url of the base directory for this branch; the one
2279
1971
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
1972
    """
2283
1973
 
2284
1974
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
1975
                 _control_files=None, a_bzrdir=None, _repository=None,
 
1976
                 ignore_fallbacks=False):
2287
1977
        """Create new branch object at a particular location."""
2288
1978
        if a_bzrdir is None:
2289
1979
            raise ValueError('a_bzrdir must be supplied')
2290
1980
        else:
2291
1981
            self.bzrdir = a_bzrdir
2292
1982
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
1983
        # XXX: We should be able to just do
2295
1984
        #   self.base = self.bzrdir.root_transport.base
2296
1985
        # but this does not quite work yet -- mbp 20080522
2303
1992
        Branch.__init__(self)
2304
1993
 
2305
1994
    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)
 
1995
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
1996
 
2312
1997
    __repr__ = __str__
2313
1998
 
2324
2009
        return self.control_files.is_locked()
2325
2010
 
2326
2011
    def lock_write(self, token=None):
2327
 
        if not self.is_locked():
2328
 
            self._note_lock('w')
2329
2012
        # All-in-one needs to always unlock/lock.
2330
2013
        repo_control = getattr(self.repository, 'control_files', None)
2331
2014
        if self.control_files == repo_control or not self.is_locked():
2332
 
            self.repository._warn_if_deprecated(self)
2333
2015
            self.repository.lock_write()
2334
2016
            took_lock = True
2335
2017
        else:
2342
2024
            raise
2343
2025
 
2344
2026
    def lock_read(self):
2345
 
        if not self.is_locked():
2346
 
            self._note_lock('r')
2347
2027
        # All-in-one needs to always unlock/lock.
2348
2028
        repo_control = getattr(self.repository, 'control_files', None)
2349
2029
        if self.control_files == repo_control or not self.is_locked():
2350
 
            self.repository._warn_if_deprecated(self)
2351
2030
            self.repository.lock_read()
2352
2031
            took_lock = True
2353
2032
        else:
2359
2038
                self.repository.unlock()
2360
2039
            raise
2361
2040
 
2362
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
2041
    def unlock(self):
2364
2042
        try:
2365
2043
            self.control_files.unlock()
2496
2174
        """See Branch.basis_tree."""
2497
2175
        return self.repository.revision_tree(self.last_revision())
2498
2176
 
 
2177
    @needs_write_lock
 
2178
    def pull(self, source, overwrite=False, stop_revision=None,
 
2179
             _hook_master=None, run_hooks=True, possible_transports=None,
 
2180
             _override_hook_target=None):
 
2181
        """See Branch.pull.
 
2182
 
 
2183
        :param _hook_master: Private parameter - set the branch to
 
2184
            be supplied as the master to pull hooks.
 
2185
        :param run_hooks: Private parameter - if false, this branch
 
2186
            is being called because it's the master of the primary branch,
 
2187
            so it should not run its hooks.
 
2188
        :param _override_hook_target: Private parameter - set the branch to be
 
2189
            supplied as the target_branch to pull hooks.
 
2190
        """
 
2191
        result = PullResult()
 
2192
        result.source_branch = source
 
2193
        if _override_hook_target is None:
 
2194
            result.target_branch = self
 
2195
        else:
 
2196
            result.target_branch = _override_hook_target
 
2197
        source.lock_read()
 
2198
        try:
 
2199
            # We assume that during 'pull' the local repository is closer than
 
2200
            # the remote one.
 
2201
            source.update_references(self)
 
2202
            graph = self.repository.get_graph(source.repository)
 
2203
            result.old_revno, result.old_revid = self.last_revision_info()
 
2204
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
2205
                                  graph=graph)
 
2206
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
2207
            result.new_revno, result.new_revid = self.last_revision_info()
 
2208
            if _hook_master:
 
2209
                result.master_branch = _hook_master
 
2210
                result.local_branch = result.target_branch
 
2211
            else:
 
2212
                result.master_branch = result.target_branch
 
2213
                result.local_branch = None
 
2214
            if run_hooks:
 
2215
                for hook in Branch.hooks['post_pull']:
 
2216
                    hook(result)
 
2217
        finally:
 
2218
            source.unlock()
 
2219
        return result
 
2220
 
2499
2221
    def _get_parent_location(self):
2500
2222
        _locs = ['parent', 'pull', 'x-pull']
2501
2223
        for l in _locs:
2528
2250
        return result
2529
2251
 
2530
2252
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2253
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2254
 
2533
2255
    def set_push_location(self, location):
2534
2256
        """See Branch.set_push_location."""
2550
2272
    It has support for a master_branch which is the data for bound branches.
2551
2273
    """
2552
2274
 
 
2275
    @needs_write_lock
 
2276
    def pull(self, source, overwrite=False, stop_revision=None,
 
2277
             run_hooks=True, possible_transports=None,
 
2278
             _override_hook_target=None):
 
2279
        """Pull from source into self, updating my master if any.
 
2280
 
 
2281
        :param run_hooks: Private parameter - if false, this branch
 
2282
            is being called because it's the master of the primary branch,
 
2283
            so it should not run its hooks.
 
2284
        """
 
2285
        bound_location = self.get_bound_location()
 
2286
        master_branch = None
 
2287
        if bound_location and source.base != bound_location:
 
2288
            # not pulling from master, so we need to update master.
 
2289
            master_branch = self.get_master_branch(possible_transports)
 
2290
            master_branch.lock_write()
 
2291
        try:
 
2292
            if master_branch:
 
2293
                # pull from source into master.
 
2294
                master_branch.pull(source, overwrite, stop_revision,
 
2295
                    run_hooks=False)
 
2296
            return super(BzrBranch5, self).pull(source, overwrite,
 
2297
                stop_revision, _hook_master=master_branch,
 
2298
                run_hooks=run_hooks,
 
2299
                _override_hook_target=_override_hook_target)
 
2300
        finally:
 
2301
            if master_branch:
 
2302
                master_branch.unlock()
 
2303
 
2553
2304
    def get_bound_location(self):
2554
2305
        try:
2555
2306
            return self._transport.get_bytes('bound')[:-1]
2661
2412
                    raise AssertionError(
2662
2413
                        "'transform_fallback_location' hook %s returned "
2663
2414
                        "None, not a URL." % hook_name)
2664
 
            self._activate_fallback_location(url)
 
2415
            self._activate_fallback_location(url, None)
2665
2416
 
2666
2417
    def __init__(self, *args, **kwargs):
2667
2418
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2668
2419
        super(BzrBranch8, self).__init__(*args, **kwargs)
2669
2420
        self._last_revision_info_cache = None
 
2421
        self._partial_revision_history_cache = []
2670
2422
        self._reference_info = None
2671
2423
 
2672
2424
    def _clear_cached_state(self):
2673
2425
        super(BzrBranch8, self)._clear_cached_state()
2674
2426
        self._last_revision_info_cache = None
 
2427
        self._partial_revision_history_cache = []
2675
2428
        self._reference_info = None
2676
2429
 
2677
2430
    def _last_revision_info(self):
2724
2477
        if _mod_revision.is_null(last_revision):
2725
2478
            return
2726
2479
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2480
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2481
 
2729
2482
    def _gen_revision_history(self):
2730
2483
        """Generate the revision history from last revision
2733
2486
        self._extend_partial_history(stop_index=last_revno-1)
2734
2487
        return list(reversed(self._partial_revision_history_cache))
2735
2488
 
 
2489
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2490
        """Extend the partial history to include a given index
 
2491
 
 
2492
        If a stop_index is supplied, stop when that index has been reached.
 
2493
        If a stop_revision is supplied, stop when that revision is
 
2494
        encountered.  Otherwise, stop when the beginning of history is
 
2495
        reached.
 
2496
 
 
2497
        :param stop_index: The index which should be present.  When it is
 
2498
            present, history extension will stop.
 
2499
        :param revision_id: The revision id which should be present.  When
 
2500
            it is encountered, history extension will stop.
 
2501
        """
 
2502
        repo = self.repository
 
2503
        if len(self._partial_revision_history_cache) == 0:
 
2504
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2505
        else:
 
2506
            start_revision = self._partial_revision_history_cache[-1]
 
2507
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2508
            #skip the last revision in the list
 
2509
            next_revision = iterator.next()
 
2510
        for revision_id in iterator:
 
2511
            self._partial_revision_history_cache.append(revision_id)
 
2512
            if (stop_index is not None and
 
2513
                len(self._partial_revision_history_cache) > stop_index):
 
2514
                break
 
2515
            if revision_id == stop_revision:
 
2516
                break
 
2517
 
2736
2518
    def _write_revision_history(self, history):
2737
2519
        """Factored out of set_revision_history.
2738
2520
 
2830
2612
        if branch_location is None:
2831
2613
            return Branch.reference_parent(self, file_id, path,
2832
2614
                                           possible_transports)
2833
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2615
        branch_location = urlutils.join(self.base, branch_location)
2834
2616
        return Branch.open(branch_location,
2835
2617
                           possible_transports=possible_transports)
2836
2618
 
2881
2663
            raise errors.NotStacked(self)
2882
2664
        return stacked_url
2883
2665
 
 
2666
    def set_append_revisions_only(self, enabled):
 
2667
        if enabled:
 
2668
            value = 'True'
 
2669
        else:
 
2670
            value = 'False'
 
2671
        self.get_config().set_user_option('append_revisions_only', value,
 
2672
            warn_masked=True)
 
2673
 
2884
2674
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2675
        value = self.get_config().get_user_option('append_revisions_only')
 
2676
        return value == 'True'
2887
2677
 
2888
2678
    @needs_write_lock
2889
2679
    def generate_revision_history(self, revision_id, last_rev=None,
2951
2741
    """
2952
2742
 
2953
2743
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2744
        raise errors.UnstackableBranchFormat(self._format, self.base)
2955
2745
 
2956
2746
 
2957
2747
######################################################################
3044
2834
        :param verbose: Requests more detailed display of what was checked,
3045
2835
            if any.
3046
2836
        """
3047
 
        note('checked branch %s format %s', self.branch.user_url,
 
2837
        note('checked branch %s format %s', self.branch.base,
3048
2838
            self.branch._format)
3049
2839
        for error in self.errors:
3050
2840
            note('found error:%s', error)
3148
2938
    @staticmethod
3149
2939
    def _get_branch_formats_to_test():
3150
2940
        """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)
 
2941
        raise NotImplementedError(self._get_branch_formats_to_test)
3162
2942
 
3163
2943
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
2944
                         graph=None):
3233
3013
        finally:
3234
3014
            self.source.unlock()
3235
3015
 
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
3016
    def push(self, overwrite=False, stop_revision=None,
3292
3017
             _override_hook_source_branch=None):
3293
3018
        """See InterBranch.push.
3360
3085
        return True
3361
3086
 
3362
3087
 
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
3088
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)