/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: Ian Clatworthy
  • Date: 2009-07-02 08:26:00 UTC
  • mto: (4527.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4529.
  • Revision ID: ian.clatworthy@canonical.com-20090702082600-qwb1evvvfa8ctnye
first draft of a 2.0 Upgrade Guide

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
29
29
        errors,
30
30
        lockdir,
31
31
        lockable_files,
32
 
        remote,
33
32
        repository,
34
33
        revision as _mod_revision,
35
34
        rio,
47
46
    )
48
47
""")
49
48
 
50
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
51
50
from bzrlib.hooks import HookPoint, Hooks
52
51
from bzrlib.inter import InterObject
53
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
54
52
from bzrlib import registry
55
53
from bzrlib.symbol_versioning import (
56
54
    deprecated_in,
64
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
65
63
 
66
64
 
67
 
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):
68
78
    """Branch holding a history of revisions.
69
79
 
70
 
    :ivar base:
71
 
        Base directory/url of the branch; using control_url and
72
 
        control_transport is more standardized.
 
80
    base
 
81
        Base directory/url of the branch.
73
82
 
74
83
    hooks: An instance of BranchHooks.
75
84
    """
77
86
    # - RBC 20060112
78
87
    base = None
79
88
 
80
 
    @property
81
 
    def control_transport(self):
82
 
        return self._transport
83
 
 
84
 
    @property
85
 
    def user_transport(self):
86
 
        return self.bzrdir.user_transport
87
 
 
88
89
    def __init__(self, *ignored, **ignored_too):
89
90
        self.tags = self._format.make_tags(self)
90
91
        self._revision_history_cache = None
105
106
        """Activate the branch/repository from url as a fallback repository."""
106
107
        repo = self._get_fallback_repository(url)
107
108
        if repo.has_same_location(self.repository):
108
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
109
            raise errors.UnstackableLocationError(self.base, url)
109
110
        self.repository.add_fallback_repository(repo)
110
111
 
111
112
    def break_lock(self):
148
149
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
149
150
            self._partial_revision_history_cache.pop()
150
151
 
151
 
    def _get_check_refs(self):
152
 
        """Get the references needed for check().
153
 
 
154
 
        See bzrlib.check.
155
 
        """
156
 
        revid = self.last_revision()
157
 
        return [('revision-existence', revid), ('lefthand-distance', revid)]
158
 
 
159
152
    @staticmethod
160
153
    def open(base, _unsupported=False, possible_transports=None):
161
154
        """Open the branch rooted at base.
165
158
        """
166
159
        control = bzrdir.BzrDir.open(base, _unsupported,
167
160
                                     possible_transports=possible_transports)
168
 
        return control.open_branch(unsupported=_unsupported)
 
161
        return control.open_branch(_unsupported)
169
162
 
170
163
    @staticmethod
171
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
164
    def open_from_transport(transport, _unsupported=False):
172
165
        """Open the branch rooted at transport"""
173
166
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
174
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
167
        return control.open_branch(_unsupported)
175
168
 
176
169
    @staticmethod
177
170
    def open_containing(url, possible_transports=None):
198
191
        return self.supports_tags() and self.tags.get_tag_dict()
199
192
 
200
193
    def get_config(self):
201
 
        """Get a bzrlib.config.BranchConfig for this Branch.
202
 
 
203
 
        This can then be used to get and set configuration options for the
204
 
        branch.
205
 
 
206
 
        :return: A bzrlib.config.BranchConfig.
207
 
        """
208
194
        return BranchConfig(self)
209
195
 
210
196
    def _get_config(self):
222
208
    def _get_fallback_repository(self, url):
223
209
        """Get the repository we fallback to at url."""
224
210
        url = urlutils.join(self.base, url)
225
 
        a_branch = Branch.open(url,
 
211
        a_bzrdir = bzrdir.BzrDir.open(url,
226
212
            possible_transports=[self.bzrdir.root_transport])
227
 
        return a_branch.repository
 
213
        return a_bzrdir.open_branch().repository
228
214
 
229
215
    def _get_tags_bytes(self):
230
216
        """Get the bytes of a serialised tags dict.
246
232
        if not local and not config.has_explicit_nickname():
247
233
            try:
248
234
                master = self.get_master_branch(possible_transports)
249
 
                if master and self.user_url == master.user_url:
250
 
                    raise errors.RecursiveBind(self.user_url)
251
235
                if master is not None:
252
236
                    # return the master branch value
253
237
                    return master.nick
254
 
            except errors.RecursiveBind, e:
255
 
                raise e
256
238
            except errors.BzrError, e:
257
239
                # Silently fall back to local implicit nick if the master is
258
240
                # unavailable
295
277
        new_history.reverse()
296
278
        return new_history
297
279
 
298
 
    def lock_write(self, token=None):
299
 
        """Lock the branch for write operations.
300
 
 
301
 
        :param token: A token to permit reacquiring a previously held and
302
 
            preserved lock.
303
 
        :return: A BranchWriteLockResult.
304
 
        """
 
280
    def lock_write(self):
305
281
        raise NotImplementedError(self.lock_write)
306
282
 
307
283
    def lock_read(self):
308
 
        """Lock the branch for read operations.
309
 
 
310
 
        :return: A bzrlib.lock.LogicalLockResult.
311
 
        """
312
284
        raise NotImplementedError(self.lock_read)
313
285
 
314
286
    def unlock(self):
439
411
            * 'include' - the stop revision is the last item in the result
440
412
            * 'with-merges' - include the stop revision and all of its
441
413
              merged revisions in the result
442
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
443
 
              that are in both ancestries
444
414
        :param direction: either 'reverse' or 'forward':
445
415
            * reverse means return the start_revision_id first, i.e.
446
416
              start at the most recent revision and go backwards in history
468
438
        # start_revision_id.
469
439
        if self._merge_sorted_revisions_cache is None:
470
440
            last_revision = self.last_revision()
471
 
            known_graph = self.repository.get_known_graph_ancestry(
472
 
                [last_revision])
473
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
474
 
                last_revision)
 
441
            graph = self.repository.get_graph()
 
442
            parent_map = dict(((key, value) for key, value in
 
443
                     graph.iter_ancestry([last_revision]) if value is not None))
 
444
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
445
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
446
                generate_revno=True)
 
447
            # Drop the sequence # before caching
 
448
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
449
 
475
450
        filtered = self._filter_merge_sorted_revisions(
476
451
            self._merge_sorted_revisions_cache, start_revision_id,
477
452
            stop_revision_id, stop_rule)
478
 
        # Make sure we don't return revisions that are not part of the
479
 
        # start_revision_id ancestry.
480
 
        filtered = self._filter_start_non_ancestors(filtered)
481
453
        if direction == 'reverse':
482
454
            return filtered
483
455
        if direction == 'forward':
490
462
        """Iterate over an inclusive range of sorted revisions."""
491
463
        rev_iter = iter(merge_sorted_revisions)
492
464
        if start_revision_id is not None:
493
 
            for node in rev_iter:
494
 
                rev_id = node.key[-1]
 
465
            for rev_id, depth, revno, end_of_merge in rev_iter:
495
466
                if rev_id != start_revision_id:
496
467
                    continue
497
468
                else:
498
469
                    # The decision to include the start or not
499
470
                    # depends on the stop_rule if a stop is provided
500
 
                    # so pop this node back into the iterator
501
 
                    rev_iter = chain(iter([node]), rev_iter)
 
471
                    rev_iter = chain(
 
472
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
473
                        rev_iter)
502
474
                    break
503
475
        if stop_revision_id is None:
504
 
            # Yield everything
505
 
            for node in rev_iter:
506
 
                rev_id = node.key[-1]
507
 
                yield (rev_id, node.merge_depth, node.revno,
508
 
                       node.end_of_merge)
 
476
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
477
                yield rev_id, depth, revno, end_of_merge
509
478
        elif stop_rule == 'exclude':
510
 
            for node in rev_iter:
511
 
                rev_id = node.key[-1]
 
479
            for rev_id, depth, revno, end_of_merge in rev_iter:
512
480
                if rev_id == stop_revision_id:
513
481
                    return
514
 
                yield (rev_id, node.merge_depth, node.revno,
515
 
                       node.end_of_merge)
 
482
                yield rev_id, depth, revno, end_of_merge
516
483
        elif stop_rule == 'include':
517
 
            for node in rev_iter:
518
 
                rev_id = node.key[-1]
519
 
                yield (rev_id, node.merge_depth, node.revno,
520
 
                       node.end_of_merge)
 
484
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
485
                yield rev_id, depth, revno, end_of_merge
521
486
                if rev_id == stop_revision_id:
522
487
                    return
523
 
        elif stop_rule == 'with-merges-without-common-ancestry':
524
 
            # We want to exclude all revisions that are already part of the
525
 
            # stop_revision_id ancestry.
526
 
            graph = self.repository.get_graph()
527
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
528
 
                                                    [stop_revision_id])
529
 
            for node in rev_iter:
530
 
                rev_id = node.key[-1]
531
 
                if rev_id not in ancestors:
532
 
                    continue
533
 
                yield (rev_id, node.merge_depth, node.revno,
534
 
                       node.end_of_merge)
535
488
        elif stop_rule == 'with-merges':
536
489
            stop_rev = self.repository.get_revision(stop_revision_id)
537
490
            if stop_rev.parent_ids:
538
491
                left_parent = stop_rev.parent_ids[0]
539
492
            else:
540
493
                left_parent = _mod_revision.NULL_REVISION
541
 
            # left_parent is the actual revision we want to stop logging at,
542
 
            # since we want to show the merged revisions after the stop_rev too
543
 
            reached_stop_revision_id = False
544
 
            revision_id_whitelist = []
545
 
            for node in rev_iter:
546
 
                rev_id = node.key[-1]
 
494
            for rev_id, depth, revno, end_of_merge in rev_iter:
547
495
                if rev_id == left_parent:
548
 
                    # reached the left parent after the stop_revision
549
496
                    return
550
 
                if (not reached_stop_revision_id or
551
 
                        rev_id in revision_id_whitelist):
552
 
                    yield (rev_id, node.merge_depth, node.revno,
553
 
                       node.end_of_merge)
554
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
555
 
                        # only do the merged revs of rev_id from now on
556
 
                        rev = self.repository.get_revision(rev_id)
557
 
                        if rev.parent_ids:
558
 
                            reached_stop_revision_id = True
559
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
497
                yield rev_id, depth, revno, end_of_merge
560
498
        else:
561
499
            raise ValueError('invalid stop_rule %r' % stop_rule)
562
500
 
563
 
    def _filter_start_non_ancestors(self, rev_iter):
564
 
        # If we started from a dotted revno, we want to consider it as a tip
565
 
        # and don't want to yield revisions that are not part of its
566
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
567
 
        # uninteresting descendants of the first parent of our tip before the
568
 
        # tip itself.
569
 
        first = rev_iter.next()
570
 
        (rev_id, merge_depth, revno, end_of_merge) = first
571
 
        yield first
572
 
        if not merge_depth:
573
 
            # We start at a mainline revision so by definition, all others
574
 
            # revisions in rev_iter are ancestors
575
 
            for node in rev_iter:
576
 
                yield node
577
 
 
578
 
        clean = False
579
 
        whitelist = set()
580
 
        pmap = self.repository.get_parent_map([rev_id])
581
 
        parents = pmap.get(rev_id, [])
582
 
        if parents:
583
 
            whitelist.update(parents)
584
 
        else:
585
 
            # If there is no parents, there is nothing of interest left
586
 
 
587
 
            # FIXME: It's hard to test this scenario here as this code is never
588
 
            # called in that case. -- vila 20100322
589
 
            return
590
 
 
591
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
592
 
            if not clean:
593
 
                if rev_id in whitelist:
594
 
                    pmap = self.repository.get_parent_map([rev_id])
595
 
                    parents = pmap.get(rev_id, [])
596
 
                    whitelist.remove(rev_id)
597
 
                    whitelist.update(parents)
598
 
                    if merge_depth == 0:
599
 
                        # We've reached the mainline, there is nothing left to
600
 
                        # filter
601
 
                        clean = True
602
 
                else:
603
 
                    # A revision that is not part of the ancestry of our
604
 
                    # starting revision.
605
 
                    continue
606
 
            yield (rev_id, merge_depth, revno, end_of_merge)
607
 
 
608
501
    def leave_lock_in_place(self):
609
502
        """Tell this branch object not to release the physical lock when this
610
503
        object is unlocked.
627
520
        :param other: The branch to bind to
628
521
        :type other: Branch
629
522
        """
630
 
        raise errors.UpgradeRequired(self.user_url)
 
523
        raise errors.UpgradeRequired(self.base)
631
524
 
632
525
    def set_append_revisions_only(self, enabled):
633
526
        if not self._format.supports_set_append_revisions_only():
634
 
            raise errors.UpgradeRequired(self.user_url)
 
527
            raise errors.UpgradeRequired(self.base)
635
528
        if enabled:
636
529
            value = 'True'
637
530
        else:
685
578
    def get_old_bound_location(self):
686
579
        """Return the URL of the branch we used to be bound to
687
580
        """
688
 
        raise errors.UpgradeRequired(self.user_url)
 
581
        raise errors.UpgradeRequired(self.base)
689
582
 
690
583
    def get_commit_builder(self, parents, config=None, timestamp=None,
691
584
                           timezone=None, committer=None, revprops=None,
769
662
            stacking.
770
663
        """
771
664
        if not self._format.supports_stacking():
772
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
773
 
        # XXX: Changing from one fallback repository to another does not check
774
 
        # that all the data you need is present in the new fallback.
775
 
        # Possibly it should.
 
665
            raise errors.UnstackableBranchFormat(self._format, self.base)
776
666
        self._check_stackable_repo()
777
667
        if not url:
778
668
            try:
780
670
            except (errors.NotStacked, errors.UnstackableBranchFormat,
781
671
                errors.UnstackableRepositoryFormat):
782
672
                return
783
 
            self._unstack()
 
673
            url = ''
 
674
            # XXX: Lock correctness - should unlock our old repo if we were
 
675
            # locked.
 
676
            # repositories don't offer an interface to remove fallback
 
677
            # repositories today; take the conceptually simpler option and just
 
678
            # reopen it.
 
679
            self.repository = self.bzrdir.find_repository()
 
680
            self.repository.lock_write()
 
681
            # for every revision reference the branch has, ensure it is pulled
 
682
            # in.
 
683
            source_repository = self._get_fallback_repository(old_url)
 
684
            for revision_id in chain([self.last_revision()],
 
685
                self.tags.get_reverse_tag_dict()):
 
686
                self.repository.fetch(source_repository, revision_id,
 
687
                    find_ghosts=True)
784
688
        else:
785
689
            self._activate_fallback_location(url)
786
690
        # write this out after the repository is stacked to avoid setting a
787
691
        # stacked config that doesn't work.
788
692
        self._set_config_location('stacked_on_location', url)
789
693
 
790
 
    def _unstack(self):
791
 
        """Change a branch to be unstacked, copying data as needed.
792
 
        
793
 
        Don't call this directly, use set_stacked_on_url(None).
794
 
        """
795
 
        pb = ui.ui_factory.nested_progress_bar()
796
 
        try:
797
 
            pb.update("Unstacking")
798
 
            # The basic approach here is to fetch the tip of the branch,
799
 
            # including all available ghosts, from the existing stacked
800
 
            # repository into a new repository object without the fallbacks. 
801
 
            #
802
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
803
 
            # correct for CHKMap repostiories
804
 
            old_repository = self.repository
805
 
            if len(old_repository._fallback_repositories) != 1:
806
 
                raise AssertionError("can't cope with fallback repositories "
807
 
                    "of %r" % (self.repository,))
808
 
            # Open the new repository object.
809
 
            # Repositories don't offer an interface to remove fallback
810
 
            # repositories today; take the conceptually simpler option and just
811
 
            # reopen it.  We reopen it starting from the URL so that we
812
 
            # get a separate connection for RemoteRepositories and can
813
 
            # stream from one of them to the other.  This does mean doing
814
 
            # separate SSH connection setup, but unstacking is not a
815
 
            # common operation so it's tolerable.
816
 
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
817
 
            new_repository = new_bzrdir.find_repository()
818
 
            if new_repository._fallback_repositories:
819
 
                raise AssertionError("didn't expect %r to have "
820
 
                    "fallback_repositories"
821
 
                    % (self.repository,))
822
 
            # Replace self.repository with the new repository.
823
 
            # Do our best to transfer the lock state (i.e. lock-tokens and
824
 
            # lock count) of self.repository to the new repository.
825
 
            lock_token = old_repository.lock_write().repository_token
826
 
            self.repository = new_repository
827
 
            if isinstance(self, remote.RemoteBranch):
828
 
                # Remote branches can have a second reference to the old
829
 
                # repository that need to be replaced.
830
 
                if self._real_branch is not None:
831
 
                    self._real_branch.repository = new_repository
832
 
            self.repository.lock_write(token=lock_token)
833
 
            if lock_token is not None:
834
 
                old_repository.leave_lock_in_place()
835
 
            old_repository.unlock()
836
 
            if lock_token is not None:
837
 
                # XXX: self.repository.leave_lock_in_place() before this
838
 
                # function will not be preserved.  Fortunately that doesn't
839
 
                # affect the current default format (2a), and would be a
840
 
                # corner-case anyway.
841
 
                #  - Andrew Bennetts, 2010/06/30
842
 
                self.repository.dont_leave_lock_in_place()
843
 
            old_lock_count = 0
844
 
            while True:
845
 
                try:
846
 
                    old_repository.unlock()
847
 
                except errors.LockNotHeld:
848
 
                    break
849
 
                old_lock_count += 1
850
 
            if old_lock_count == 0:
851
 
                raise AssertionError(
852
 
                    'old_repository should have been locked at least once.')
853
 
            for i in range(old_lock_count-1):
854
 
                self.repository.lock_write()
855
 
            # Fetch from the old repository into the new.
856
 
            old_repository.lock_read()
857
 
            try:
858
 
                # XXX: If you unstack a branch while it has a working tree
859
 
                # with a pending merge, the pending-merged revisions will no
860
 
                # longer be present.  You can (probably) revert and remerge.
861
 
                #
862
 
                # XXX: This only fetches up to the tip of the repository; it
863
 
                # doesn't bring across any tags.  That's fairly consistent
864
 
                # with how branch works, but perhaps not ideal.
865
 
                self.repository.fetch(old_repository,
866
 
                    revision_id=self.last_revision(),
867
 
                    find_ghosts=True)
868
 
            finally:
869
 
                old_repository.unlock()
870
 
        finally:
871
 
            pb.finished()
872
694
 
873
695
    def _set_tags_bytes(self, bytes):
874
696
        """Mirror method for _get_tags_bytes.
954
776
 
955
777
    def unbind(self):
956
778
        """Older format branches cannot bind or unbind."""
957
 
        raise errors.UpgradeRequired(self.user_url)
 
779
        raise errors.UpgradeRequired(self.base)
958
780
 
959
781
    def last_revision(self):
960
782
        """Return last revision id, or NULL_REVISION."""
1001
823
                raise errors.NoSuchRevision(self, stop_revision)
1002
824
        return other_history[self_len:stop_revision]
1003
825
 
 
826
    @needs_write_lock
1004
827
    def update_revisions(self, other, stop_revision=None, overwrite=False,
1005
828
                         graph=None):
1006
829
        """Pull in new perfect-fit revisions.
1055
878
            self._extend_partial_history(distance_from_last)
1056
879
        return self._partial_revision_history_cache[distance_from_last]
1057
880
 
 
881
    @needs_write_lock
1058
882
    def pull(self, source, overwrite=False, stop_revision=None,
1059
883
             possible_transports=None, *args, **kwargs):
1060
884
        """Mirror source into this branch.
1118
942
        try:
1119
943
            return urlutils.join(self.base[:-1], parent)
1120
944
        except errors.InvalidURLJoin, e:
1121
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
945
            raise errors.InaccessibleParent(parent, self.base)
1122
946
 
1123
947
    def _get_parent_location(self):
1124
948
        raise NotImplementedError(self._get_parent_location)
1209
1033
        params = ChangeBranchTipParams(
1210
1034
            self, old_revno, new_revno, old_revid, new_revid)
1211
1035
        for hook in hooks:
1212
 
            hook(params)
 
1036
            try:
 
1037
                hook(params)
 
1038
            except errors.TipChangeRejected:
 
1039
                raise
 
1040
            except Exception:
 
1041
                exc_info = sys.exc_info()
 
1042
                hook_name = Branch.hooks.get_hook_name(hook)
 
1043
                raise errors.HookFailed(
 
1044
                    'pre_change_branch_tip', hook_name, exc_info)
1213
1045
 
1214
1046
    @needs_write_lock
1215
1047
    def update(self):
1264
1096
        revision_id: if not None, the revision history in the new branch will
1265
1097
                     be truncated to end with revision_id.
1266
1098
        """
1267
 
        if (repository_policy is not None and
1268
 
            repository_policy.requires_stacking()):
1269
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1270
1099
        result = to_bzrdir.create_branch()
1271
1100
        result.lock_write()
1272
1101
        try:
1303
1132
                revno = 1
1304
1133
        destination.set_last_revision_info(revno, revision_id)
1305
1134
 
 
1135
    @needs_read_lock
1306
1136
    def copy_content_into(self, destination, revision_id=None):
1307
1137
        """Copy the content of self into destination.
1308
1138
 
1309
1139
        revision_id: if not None, the revision history in the new branch will
1310
1140
                     be truncated to end with revision_id.
1311
1141
        """
1312
 
        return InterBranch.get(self, destination).copy_content_into(
1313
 
            revision_id=revision_id)
 
1142
        self.update_references(destination)
 
1143
        self._synchronize_history(destination, revision_id)
 
1144
        try:
 
1145
            parent = self.get_parent()
 
1146
        except errors.InaccessibleParent, e:
 
1147
            mutter('parent was not accessible to copy: %s', e)
 
1148
        else:
 
1149
            if parent:
 
1150
                destination.set_parent(parent)
 
1151
        if self._push_should_merge_tags():
 
1152
            self.tags.merge_to(destination.tags)
1314
1153
 
1315
1154
    def update_references(self, target):
1316
1155
        if not getattr(self._format, 'supports_reference_locations', False):
1330
1169
        target._set_all_reference_info(target_reference_dict)
1331
1170
 
1332
1171
    @needs_read_lock
1333
 
    def check(self, refs):
 
1172
    def check(self):
1334
1173
        """Check consistency of the branch.
1335
1174
 
1336
1175
        In particular this checks that revisions given in the revision-history
1339
1178
 
1340
1179
        Callers will typically also want to check the repository.
1341
1180
 
1342
 
        :param refs: Calculated refs for this branch as specified by
1343
 
            branch._get_check_refs()
1344
1181
        :return: A BranchCheckResult.
1345
1182
        """
1346
 
        result = BranchCheckResult(self)
 
1183
        ret = BranchCheckResult(self)
 
1184
        mainline_parent_id = None
1347
1185
        last_revno, last_revision_id = self.last_revision_info()
1348
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1349
 
        if actual_revno != last_revno:
1350
 
            result.errors.append(errors.BzrCheckError(
1351
 
                'revno does not match len(mainline) %s != %s' % (
1352
 
                last_revno, actual_revno)))
1353
 
        # TODO: We should probably also check that self.revision_history
1354
 
        # matches the repository for older branch formats.
1355
 
        # If looking for the code that cross-checks repository parents against
1356
 
        # the iter_reverse_revision_history output, that is now a repository
1357
 
        # specific check.
1358
 
        return result
 
1186
        real_rev_history = []
 
1187
        try:
 
1188
            for revid in self.repository.iter_reverse_revision_history(
 
1189
                last_revision_id):
 
1190
                real_rev_history.append(revid)
 
1191
        except errors.RevisionNotPresent:
 
1192
            ret.ghosts_in_mainline = True
 
1193
        else:
 
1194
            ret.ghosts_in_mainline = False
 
1195
        real_rev_history.reverse()
 
1196
        if len(real_rev_history) != last_revno:
 
1197
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1198
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1199
        # TODO: We should probably also check that real_rev_history actually
 
1200
        #       matches self.revision_history()
 
1201
        for revision_id in real_rev_history:
 
1202
            try:
 
1203
                revision = self.repository.get_revision(revision_id)
 
1204
            except errors.NoSuchRevision, e:
 
1205
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1206
                            % revision_id)
 
1207
            # In general the first entry on the revision history has no parents.
 
1208
            # But it's not illegal for it to have parents listed; this can happen
 
1209
            # in imports from Arch when the parents weren't reachable.
 
1210
            if mainline_parent_id is not None:
 
1211
                if mainline_parent_id not in revision.parent_ids:
 
1212
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1213
                                        "parents of {%s}"
 
1214
                                        % (mainline_parent_id, revision_id))
 
1215
            mainline_parent_id = revision_id
 
1216
        return ret
1359
1217
 
1360
1218
    def _get_checkout_format(self):
1361
1219
        """Return the most suitable metadir for a checkout of this branch.
1384
1242
        """
1385
1243
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1386
1244
        # clone call. Or something. 20090224 RBC/spiv.
1387
 
        # XXX: Should this perhaps clone colocated branches as well, 
1388
 
        # rather than just the default branch? 20100319 JRV
1389
1245
        if revision_id is None:
1390
1246
            revision_id = self.last_revision()
1391
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1392
 
            revision_id=revision_id, stacked_on=stacked_on,
1393
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1247
        try:
 
1248
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1249
                revision_id=revision_id, stacked_on=stacked_on,
 
1250
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1251
        except errors.FileExists:
 
1252
            if not use_existing_dir:
 
1253
                raise
 
1254
        except errors.NoSuchFile:
 
1255
            if not create_prefix:
 
1256
                raise
1394
1257
        return dir_to.open_branch()
1395
1258
 
1396
1259
    def create_checkout(self, to_location, revision_id=None,
1415
1278
        if lightweight:
1416
1279
            format = self._get_checkout_format()
1417
1280
            checkout = format.initialize_on_transport(t)
1418
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1419
 
                target_branch=self)
 
1281
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1420
1282
        else:
1421
1283
            format = self._get_checkout_format()
1422
1284
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1464
1326
    def supports_tags(self):
1465
1327
        return self._format.supports_tags()
1466
1328
 
1467
 
    def automatic_tag_name(self, revision_id):
1468
 
        """Try to automatically find the tag name for a revision.
1469
 
 
1470
 
        :param revision_id: Revision id of the revision.
1471
 
        :return: A tag name or None if no tag name could be determined.
1472
 
        """
1473
 
        for hook in Branch.hooks['automatic_tag_name']:
1474
 
            ret = hook(self, revision_id)
1475
 
            if ret is not None:
1476
 
                return ret
1477
 
        return None
1478
 
 
1479
1329
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1480
1330
                                         other_branch):
1481
1331
        """Ensure that revision_b is a descendant of revision_a.
1545
1395
        return not (self == other)
1546
1396
 
1547
1397
    @classmethod
1548
 
    def find_format(klass, a_bzrdir, name=None):
 
1398
    def find_format(klass, a_bzrdir):
1549
1399
        """Return the format for the branch object in a_bzrdir."""
1550
1400
        try:
1551
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1552
 
            format_string = transport.get_bytes("format")
1553
 
            format = klass._formats[format_string]
1554
 
            if isinstance(format, MetaDirBranchFormatFactory):
1555
 
                return format()
1556
 
            return format
 
1401
            transport = a_bzrdir.get_branch_transport(None)
 
1402
            format_string = transport.get("format").read()
 
1403
            return klass._formats[format_string]
1557
1404
        except errors.NoSuchFile:
1558
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1405
            raise errors.NotBranchError(path=transport.base)
1559
1406
        except KeyError:
1560
1407
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1561
1408
 
1564
1411
        """Return the current default format."""
1565
1412
        return klass._default_format
1566
1413
 
1567
 
    @classmethod
1568
 
    def get_formats(klass):
1569
 
        """Get all the known formats.
1570
 
 
1571
 
        Warning: This triggers a load of all lazy registered formats: do not
1572
 
        use except when that is desireed.
1573
 
        """
1574
 
        result = []
1575
 
        for fmt in klass._formats.values():
1576
 
            if isinstance(fmt, MetaDirBranchFormatFactory):
1577
 
                fmt = fmt()
1578
 
            result.append(fmt)
1579
 
        return result
1580
 
 
1581
 
    def get_reference(self, a_bzrdir, name=None):
 
1414
    def get_reference(self, a_bzrdir):
1582
1415
        """Get the target reference of the branch in a_bzrdir.
1583
1416
 
1584
1417
        format probing must have been completed before calling
1586
1419
        in a_bzrdir is correct.
1587
1420
 
1588
1421
        :param a_bzrdir: The bzrdir to get the branch data from.
1589
 
        :param name: Name of the colocated branch to fetch
1590
1422
        :return: None if the branch is not a reference branch.
1591
1423
        """
1592
1424
        return None
1593
1425
 
1594
1426
    @classmethod
1595
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1427
    def set_reference(self, a_bzrdir, to_branch):
1596
1428
        """Set the target reference of the branch in a_bzrdir.
1597
1429
 
1598
1430
        format probing must have been completed before calling
1600
1432
        in a_bzrdir is correct.
1601
1433
 
1602
1434
        :param a_bzrdir: The bzrdir to set the branch reference for.
1603
 
        :param name: Name of colocated branch to set, None for default
1604
1435
        :param to_branch: branch that the checkout is to reference
1605
1436
        """
1606
1437
        raise NotImplementedError(self.set_reference)
1613
1444
        """Return the short format description for this format."""
1614
1445
        raise NotImplementedError(self.get_format_description)
1615
1446
 
1616
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1617
 
        hooks = Branch.hooks['post_branch_init']
1618
 
        if not hooks:
1619
 
            return
1620
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1621
 
        for hook in hooks:
1622
 
            hook(params)
1623
 
 
1624
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1625
 
                           lock_type='metadir', set_format=True):
 
1447
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1448
                           set_format=True):
1626
1449
        """Initialize a branch in a bzrdir, with specified files
1627
1450
 
1628
1451
        :param a_bzrdir: The bzrdir to initialize the branch in
1629
1452
        :param utf8_files: The files to create as a list of
1630
1453
            (filename, content) tuples
1631
 
        :param name: Name of colocated branch to create, if any
1632
1454
        :param set_format: If True, set the format with
1633
1455
            self.get_format_string.  (BzrBranch4 has its format set
1634
1456
            elsewhere)
1635
1457
        :return: a branch in this format
1636
1458
        """
1637
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1638
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1459
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1460
        branch_transport = a_bzrdir.get_branch_transport(self)
1639
1461
        lock_map = {
1640
1462
            'metadir': ('lock', lockdir.LockDir),
1641
1463
            'branch4': ('branch-lock', lockable_files.TransportLock),
1662
1484
        finally:
1663
1485
            if lock_taken:
1664
1486
                control_files.unlock()
1665
 
        branch = self.open(a_bzrdir, name, _found=True)
1666
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1667
 
        return branch
 
1487
        return self.open(a_bzrdir, _found=True)
1668
1488
 
1669
 
    def initialize(self, a_bzrdir, name=None):
1670
 
        """Create a branch of this format in a_bzrdir.
1671
 
        
1672
 
        :param name: Name of the colocated branch to create.
1673
 
        """
 
1489
    def initialize(self, a_bzrdir):
 
1490
        """Create a branch of this format in a_bzrdir."""
1674
1491
        raise NotImplementedError(self.initialize)
1675
1492
 
1676
1493
    def is_supported(self):
1706
1523
        """
1707
1524
        raise NotImplementedError(self.network_name)
1708
1525
 
1709
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1526
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1710
1527
        """Return the branch object for a_bzrdir
1711
1528
 
1712
1529
        :param a_bzrdir: A BzrDir that contains a branch.
1713
 
        :param name: Name of colocated branch to open
1714
1530
        :param _found: a private parameter, do not use it. It is used to
1715
1531
            indicate if format probing has already be done.
1716
1532
        :param ignore_fallbacks: when set, no fallback branches will be opened
1720
1536
 
1721
1537
    @classmethod
1722
1538
    def register_format(klass, format):
1723
 
        """Register a metadir format.
1724
 
        
1725
 
        See MetaDirBranchFormatFactory for the ability to register a format
1726
 
        without loading the code the format needs until it is actually used.
1727
 
        """
 
1539
        """Register a metadir format."""
1728
1540
        klass._formats[format.get_format_string()] = format
1729
1541
        # Metadir formats have a network name of their format string, and get
1730
 
        # registered as factories.
1731
 
        if isinstance(format, MetaDirBranchFormatFactory):
1732
 
            network_format_registry.register(format.get_format_string(), format)
1733
 
        else:
1734
 
            network_format_registry.register(format.get_format_string(),
1735
 
                format.__class__)
 
1542
        # registered as class factories.
 
1543
        network_format_registry.register(format.get_format_string(), format.__class__)
1736
1544
 
1737
1545
    @classmethod
1738
1546
    def set_default_format(klass, format):
1758
1566
        return False  # by default
1759
1567
 
1760
1568
 
1761
 
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1762
 
    """A factory for a BranchFormat object, permitting simple lazy registration.
1763
 
    
1764
 
    While none of the built in BranchFormats are lazy registered yet,
1765
 
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1766
 
    use it, and the bzr-loom plugin uses it as well (see
1767
 
    bzrlib.plugins.loom.formats).
1768
 
    """
1769
 
 
1770
 
    def __init__(self, format_string, module_name, member_name):
1771
 
        """Create a MetaDirBranchFormatFactory.
1772
 
 
1773
 
        :param format_string: The format string the format has.
1774
 
        :param module_name: Module to load the format class from.
1775
 
        :param member_name: Attribute name within the module for the format class.
1776
 
        """
1777
 
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
1778
 
        self._format_string = format_string
1779
 
        
1780
 
    def get_format_string(self):
1781
 
        """See BranchFormat.get_format_string."""
1782
 
        return self._format_string
1783
 
 
1784
 
    def __call__(self):
1785
 
        """Used for network_format_registry support."""
1786
 
        return self.get_obj()()
1787
 
 
1788
 
 
1789
1569
class BranchHooks(Hooks):
1790
1570
    """A dictionary mapping hook name to a list of callables for branch hooks.
1791
1571
 
1860
1640
            "multiple hooks installed for transform_fallback_location, "
1861
1641
            "all are called with the url returned from the previous hook."
1862
1642
            "The order is however undefined.", (1, 9), None))
1863
 
        self.create_hook(HookPoint('automatic_tag_name',
1864
 
            "Called to determine an automatic tag name for a revision. "
1865
 
            "automatic_tag_name is called with (branch, revision_id) and "
1866
 
            "should return a tag name or None if no tag name could be "
1867
 
            "determined. The first non-None tag name returned will be used.",
1868
 
            (2, 2), None))
1869
 
        self.create_hook(HookPoint('post_branch_init',
1870
 
            "Called after new branch initialization completes. "
1871
 
            "post_branch_init is called with a "
1872
 
            "bzrlib.branch.BranchInitHookParams. "
1873
 
            "Note that init, branch and checkout (both heavyweight and "
1874
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1875
 
        self.create_hook(HookPoint('post_switch',
1876
 
            "Called after a checkout switches branch. "
1877
 
            "post_switch is called with a "
1878
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1879
 
 
1880
1643
 
1881
1644
 
1882
1645
# install the default hooks into the Branch class.
1921
1684
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1922
1685
 
1923
1686
 
1924
 
class BranchInitHookParams(object):
1925
 
    """Object holding parameters passed to *_branch_init hooks.
1926
 
 
1927
 
    There are 4 fields that hooks may wish to access:
1928
 
 
1929
 
    :ivar format: the branch format
1930
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1931
 
    :ivar name: name of colocated branch, if any (or None)
1932
 
    :ivar branch: the branch created
1933
 
 
1934
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1935
 
    the checkout, hence they are different from the corresponding fields in
1936
 
    branch, which refer to the original branch.
1937
 
    """
1938
 
 
1939
 
    def __init__(self, format, a_bzrdir, name, branch):
1940
 
        """Create a group of BranchInitHook parameters.
1941
 
 
1942
 
        :param format: the branch format
1943
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1944
 
            initialized
1945
 
        :param name: name of colocated branch, if any (or None)
1946
 
        :param branch: the branch created
1947
 
 
1948
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1949
 
        to the checkout, hence they are different from the corresponding fields
1950
 
        in branch, which refer to the original branch.
1951
 
        """
1952
 
        self.format = format
1953
 
        self.bzrdir = a_bzrdir
1954
 
        self.name = name
1955
 
        self.branch = branch
1956
 
 
1957
 
    def __eq__(self, other):
1958
 
        return self.__dict__ == other.__dict__
1959
 
 
1960
 
    def __repr__(self):
1961
 
        if self.branch:
1962
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1963
 
        else:
1964
 
            return "<%s of format:%s bzrdir:%s>" % (
1965
 
                self.__class__.__name__, self.branch,
1966
 
                self.format, self.bzrdir)
1967
 
 
1968
 
 
1969
 
class SwitchHookParams(object):
1970
 
    """Object holding parameters passed to *_switch hooks.
1971
 
 
1972
 
    There are 4 fields that hooks may wish to access:
1973
 
 
1974
 
    :ivar control_dir: BzrDir of the checkout to change
1975
 
    :ivar to_branch: branch that the checkout is to reference
1976
 
    :ivar force: skip the check for local commits in a heavy checkout
1977
 
    :ivar revision_id: revision ID to switch to (or None)
1978
 
    """
1979
 
 
1980
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1981
 
        """Create a group of SwitchHook parameters.
1982
 
 
1983
 
        :param control_dir: BzrDir of the checkout to change
1984
 
        :param to_branch: branch that the checkout is to reference
1985
 
        :param force: skip the check for local commits in a heavy checkout
1986
 
        :param revision_id: revision ID to switch to (or None)
1987
 
        """
1988
 
        self.control_dir = control_dir
1989
 
        self.to_branch = to_branch
1990
 
        self.force = force
1991
 
        self.revision_id = revision_id
1992
 
 
1993
 
    def __eq__(self, other):
1994
 
        return self.__dict__ == other.__dict__
1995
 
 
1996
 
    def __repr__(self):
1997
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1998
 
            self.control_dir, self.to_branch,
1999
 
            self.revision_id)
2000
 
 
2001
 
 
2002
1687
class BzrBranchFormat4(BranchFormat):
2003
1688
    """Bzr branch format 4.
2004
1689
 
2011
1696
        """See BranchFormat.get_format_description()."""
2012
1697
        return "Branch format 4"
2013
1698
 
2014
 
    def initialize(self, a_bzrdir, name=None):
 
1699
    def initialize(self, a_bzrdir):
2015
1700
        """Create a branch of this format in a_bzrdir."""
2016
1701
        utf8_files = [('revision-history', ''),
2017
1702
                      ('branch-name', ''),
2018
1703
                      ]
2019
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1704
        return self._initialize_helper(a_bzrdir, utf8_files,
2020
1705
                                       lock_type='branch4', set_format=False)
2021
1706
 
2022
1707
    def __init__(self):
2027
1712
        """The network name for this format is the control dirs disk label."""
2028
1713
        return self._matchingbzrdir.get_format_string()
2029
1714
 
2030
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1715
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2031
1716
        """See BranchFormat.open()."""
2032
1717
        if not _found:
2033
1718
            # we are being called directly and must probe.
2035
1720
        return BzrBranch(_format=self,
2036
1721
                         _control_files=a_bzrdir._control_files,
2037
1722
                         a_bzrdir=a_bzrdir,
2038
 
                         name=name,
2039
1723
                         _repository=a_bzrdir.open_repository())
2040
1724
 
2041
1725
    def __str__(self):
2056
1740
        """
2057
1741
        return self.get_format_string()
2058
1742
 
2059
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1743
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2060
1744
        """See BranchFormat.open()."""
2061
1745
        if not _found:
2062
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1746
            format = BranchFormat.find_format(a_bzrdir)
2063
1747
            if format.__class__ != self.__class__:
2064
1748
                raise AssertionError("wrong format %r found for %r" %
2065
1749
                    (format, self))
2066
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2067
1750
        try:
 
1751
            transport = a_bzrdir.get_branch_transport(None)
2068
1752
            control_files = lockable_files.LockableFiles(transport, 'lock',
2069
1753
                                                         lockdir.LockDir)
2070
1754
            return self._branch_class()(_format=self,
2071
1755
                              _control_files=control_files,
2072
 
                              name=name,
2073
1756
                              a_bzrdir=a_bzrdir,
2074
1757
                              _repository=a_bzrdir.find_repository(),
2075
1758
                              ignore_fallbacks=ignore_fallbacks)
2076
1759
        except errors.NoSuchFile:
2077
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1760
            raise errors.NotBranchError(path=transport.base)
2078
1761
 
2079
1762
    def __init__(self):
2080
1763
        super(BranchFormatMetadir, self).__init__()
2109
1792
        """See BranchFormat.get_format_description()."""
2110
1793
        return "Branch format 5"
2111
1794
 
2112
 
    def initialize(self, a_bzrdir, name=None):
 
1795
    def initialize(self, a_bzrdir):
2113
1796
        """Create a branch of this format in a_bzrdir."""
2114
1797
        utf8_files = [('revision-history', ''),
2115
1798
                      ('branch-name', ''),
2116
1799
                      ]
2117
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1800
        return self._initialize_helper(a_bzrdir, utf8_files)
2118
1801
 
2119
1802
    def supports_tags(self):
2120
1803
        return False
2142
1825
        """See BranchFormat.get_format_description()."""
2143
1826
        return "Branch format 6"
2144
1827
 
2145
 
    def initialize(self, a_bzrdir, name=None):
 
1828
    def initialize(self, a_bzrdir):
2146
1829
        """Create a branch of this format in a_bzrdir."""
2147
1830
        utf8_files = [('last-revision', '0 null:\n'),
2148
1831
                      ('branch.conf', ''),
2149
1832
                      ('tags', ''),
2150
1833
                      ]
2151
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1834
        return self._initialize_helper(a_bzrdir, utf8_files)
2152
1835
 
2153
1836
    def make_tags(self, branch):
2154
1837
        """See bzrlib.branch.BranchFormat.make_tags()."""
2172
1855
        """See BranchFormat.get_format_description()."""
2173
1856
        return "Branch format 8"
2174
1857
 
2175
 
    def initialize(self, a_bzrdir, name=None):
 
1858
    def initialize(self, a_bzrdir):
2176
1859
        """Create a branch of this format in a_bzrdir."""
2177
1860
        utf8_files = [('last-revision', '0 null:\n'),
2178
1861
                      ('branch.conf', ''),
2179
1862
                      ('tags', ''),
2180
1863
                      ('references', '')
2181
1864
                      ]
2182
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1865
        return self._initialize_helper(a_bzrdir, utf8_files)
2183
1866
 
2184
1867
    def __init__(self):
2185
1868
        super(BzrBranchFormat8, self).__init__()
2208
1891
    This format was introduced in bzr 1.6.
2209
1892
    """
2210
1893
 
2211
 
    def initialize(self, a_bzrdir, name=None):
 
1894
    def initialize(self, a_bzrdir):
2212
1895
        """Create a branch of this format in a_bzrdir."""
2213
1896
        utf8_files = [('last-revision', '0 null:\n'),
2214
1897
                      ('branch.conf', ''),
2215
1898
                      ('tags', ''),
2216
1899
                      ]
2217
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1900
        return self._initialize_helper(a_bzrdir, utf8_files)
2218
1901
 
2219
1902
    def _branch_class(self):
2220
1903
        return BzrBranch7
2252
1935
        """See BranchFormat.get_format_description()."""
2253
1936
        return "Checkout reference format 1"
2254
1937
 
2255
 
    def get_reference(self, a_bzrdir, name=None):
 
1938
    def get_reference(self, a_bzrdir):
2256
1939
        """See BranchFormat.get_reference()."""
2257
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2258
 
        return transport.get_bytes('location')
 
1940
        transport = a_bzrdir.get_branch_transport(None)
 
1941
        return transport.get('location').read()
2259
1942
 
2260
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1943
    def set_reference(self, a_bzrdir, to_branch):
2261
1944
        """See BranchFormat.set_reference()."""
2262
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1945
        transport = a_bzrdir.get_branch_transport(None)
2263
1946
        location = transport.put_bytes('location', to_branch.base)
2264
1947
 
2265
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1948
    def initialize(self, a_bzrdir, target_branch=None):
2266
1949
        """Create a branch of this format in a_bzrdir."""
2267
1950
        if target_branch is None:
2268
1951
            # this format does not implement branch itself, thus the implicit
2269
1952
            # creation contract must see it as uninitializable
2270
1953
            raise errors.UninitializableFormat(self)
2271
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2272
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1954
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1955
        branch_transport = a_bzrdir.get_branch_transport(self)
2273
1956
        branch_transport.put_bytes('location',
2274
 
            target_branch.bzrdir.user_url)
 
1957
            target_branch.bzrdir.root_transport.base)
2275
1958
        branch_transport.put_bytes('format', self.get_format_string())
2276
 
        branch = self.open(
2277
 
            a_bzrdir, name, _found=True,
 
1959
        return self.open(
 
1960
            a_bzrdir, _found=True,
2278
1961
            possible_transports=[target_branch.bzrdir.root_transport])
2279
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2280
 
        return branch
2281
1962
 
2282
1963
    def __init__(self):
2283
1964
        super(BranchReferenceFormat, self).__init__()
2289
1970
        def clone(to_bzrdir, revision_id=None,
2290
1971
            repository_policy=None):
2291
1972
            """See Branch.clone()."""
2292
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1973
            return format.initialize(to_bzrdir, a_branch)
2293
1974
            # cannot obey revision_id limits when cloning a reference ...
2294
1975
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2295
1976
            # emit some sort of warning/error to the caller ?!
2296
1977
        return clone
2297
1978
 
2298
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1979
    def open(self, a_bzrdir, _found=False, location=None,
2299
1980
             possible_transports=None, ignore_fallbacks=False):
2300
1981
        """Return the branch that the branch reference in a_bzrdir points at.
2301
1982
 
2302
1983
        :param a_bzrdir: A BzrDir that contains a branch.
2303
 
        :param name: Name of colocated branch to open, if any
2304
1984
        :param _found: a private parameter, do not use it. It is used to
2305
1985
            indicate if format probing has already be done.
2306
1986
        :param ignore_fallbacks: when set, no fallback branches will be opened
2311
1991
        :param possible_transports: An optional reusable transports list.
2312
1992
        """
2313
1993
        if not _found:
2314
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1994
            format = BranchFormat.find_format(a_bzrdir)
2315
1995
            if format.__class__ != self.__class__:
2316
1996
                raise AssertionError("wrong format %r found for %r" %
2317
1997
                    (format, self))
2318
1998
        if location is None:
2319
 
            location = self.get_reference(a_bzrdir, name)
 
1999
            location = self.get_reference(a_bzrdir)
2320
2000
        real_bzrdir = bzrdir.BzrDir.open(
2321
2001
            location, possible_transports=possible_transports)
2322
 
        result = real_bzrdir.open_branch(name=name, 
2323
 
            ignore_fallbacks=ignore_fallbacks)
 
2002
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2324
2003
        # this changes the behaviour of result.clone to create a new reference
2325
2004
        # rather than a copy of the content of the branch.
2326
2005
        # I did not use a proxy object because that needs much more extensive
2353
2032
BranchFormat.register_format(__format6)
2354
2033
BranchFormat.register_format(__format7)
2355
2034
BranchFormat.register_format(__format8)
2356
 
BranchFormat.set_default_format(__format7)
 
2035
BranchFormat.set_default_format(__format6)
2357
2036
_legacy_formats = [BzrBranchFormat4(),
2358
2037
    ]
2359
2038
network_format_registry.register(
2360
2039
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2361
2040
 
2362
2041
 
2363
 
class BranchWriteLockResult(LogicalLockResult):
2364
 
    """The result of write locking a branch.
2365
 
 
2366
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2367
 
        None.
2368
 
    :ivar unlock: A callable which will unlock the lock.
2369
 
    """
2370
 
 
2371
 
    def __init__(self, unlock, branch_token):
2372
 
        LogicalLockResult.__init__(self, unlock)
2373
 
        self.branch_token = branch_token
2374
 
 
2375
 
    def __repr__(self):
2376
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2377
 
            self.unlock)
2378
 
 
2379
 
 
2380
 
class BzrBranch(Branch, _RelockDebugMixin):
 
2042
class BzrBranch(Branch):
2381
2043
    """A branch stored in the actual filesystem.
2382
2044
 
2383
2045
    Note that it's "local" in the context of the filesystem; it doesn't
2389
2051
    :ivar repository: Repository for this branch.
2390
2052
    :ivar base: The url of the base directory for this branch; the one
2391
2053
        containing the .bzr directory.
2392
 
    :ivar name: Optional colocated branch name as it exists in the control
2393
 
        directory.
2394
2054
    """
2395
2055
 
2396
2056
    def __init__(self, _format=None,
2397
 
                 _control_files=None, a_bzrdir=None, name=None,
2398
 
                 _repository=None, ignore_fallbacks=False):
 
2057
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2058
                 ignore_fallbacks=False):
2399
2059
        """Create new branch object at a particular location."""
2400
2060
        if a_bzrdir is None:
2401
2061
            raise ValueError('a_bzrdir must be supplied')
2402
2062
        else:
2403
2063
            self.bzrdir = a_bzrdir
2404
2064
        self._base = self.bzrdir.transport.clone('..').base
2405
 
        self.name = name
2406
2065
        # XXX: We should be able to just do
2407
2066
        #   self.base = self.bzrdir.root_transport.base
2408
2067
        # but this does not quite work yet -- mbp 20080522
2415
2074
        Branch.__init__(self)
2416
2075
 
2417
2076
    def __str__(self):
2418
 
        if self.name is None:
2419
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2420
 
        else:
2421
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2422
 
                self.name)
 
2077
        return '%s(%r)' % (self.__class__.__name__, self.base)
2423
2078
 
2424
2079
    __repr__ = __str__
2425
2080
 
2436
2091
        return self.control_files.is_locked()
2437
2092
 
2438
2093
    def lock_write(self, token=None):
2439
 
        """Lock the branch for write operations.
2440
 
 
2441
 
        :param token: A token to permit reacquiring a previously held and
2442
 
            preserved lock.
2443
 
        :return: A BranchWriteLockResult.
2444
 
        """
2445
 
        if not self.is_locked():
2446
 
            self._note_lock('w')
2447
2094
        # All-in-one needs to always unlock/lock.
2448
2095
        repo_control = getattr(self.repository, 'control_files', None)
2449
2096
        if self.control_files == repo_control or not self.is_locked():
2450
 
            self.repository._warn_if_deprecated(self)
2451
2097
            self.repository.lock_write()
2452
2098
            took_lock = True
2453
2099
        else:
2454
2100
            took_lock = False
2455
2101
        try:
2456
 
            return BranchWriteLockResult(self.unlock,
2457
 
                self.control_files.lock_write(token=token))
 
2102
            return self.control_files.lock_write(token=token)
2458
2103
        except:
2459
2104
            if took_lock:
2460
2105
                self.repository.unlock()
2461
2106
            raise
2462
2107
 
2463
2108
    def lock_read(self):
2464
 
        """Lock the branch for read operations.
2465
 
 
2466
 
        :return: A bzrlib.lock.LogicalLockResult.
2467
 
        """
2468
 
        if not self.is_locked():
2469
 
            self._note_lock('r')
2470
2109
        # All-in-one needs to always unlock/lock.
2471
2110
        repo_control = getattr(self.repository, 'control_files', None)
2472
2111
        if self.control_files == repo_control or not self.is_locked():
2473
 
            self.repository._warn_if_deprecated(self)
2474
2112
            self.repository.lock_read()
2475
2113
            took_lock = True
2476
2114
        else:
2477
2115
            took_lock = False
2478
2116
        try:
2479
2117
            self.control_files.lock_read()
2480
 
            return LogicalLockResult(self.unlock)
2481
2118
        except:
2482
2119
            if took_lock:
2483
2120
                self.repository.unlock()
2484
2121
            raise
2485
2122
 
2486
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2487
2123
    def unlock(self):
2488
2124
        try:
2489
2125
            self.control_files.unlock()
2652
2288
        return result
2653
2289
 
2654
2290
    def get_stacked_on_url(self):
2655
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2291
        raise errors.UnstackableBranchFormat(self._format, self.base)
2656
2292
 
2657
2293
    def set_push_location(self, location):
2658
2294
        """See Branch.set_push_location."""
2848
2484
        if _mod_revision.is_null(last_revision):
2849
2485
            return
2850
2486
        if last_revision not in self._lefthand_history(revision_id):
2851
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2487
            raise errors.AppendRevisionsOnlyViolation(self.base)
2852
2488
 
2853
2489
    def _gen_revision_history(self):
2854
2490
        """Generate the revision history from last revision
2954
2590
        if branch_location is None:
2955
2591
            return Branch.reference_parent(self, file_id, path,
2956
2592
                                           possible_transports)
2957
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2593
        branch_location = urlutils.join(self.base, branch_location)
2958
2594
        return Branch.open(branch_location,
2959
2595
                           possible_transports=possible_transports)
2960
2596
 
3006
2642
        return stacked_url
3007
2643
 
3008
2644
    def _get_append_revisions_only(self):
3009
 
        return self.get_config(
3010
 
            ).get_user_option_as_bool('append_revisions_only')
 
2645
        value = self.get_config().get_user_option('append_revisions_only')
 
2646
        return value == 'True'
3011
2647
 
3012
2648
    @needs_write_lock
3013
2649
    def generate_revision_history(self, revision_id, last_rev=None,
3075
2711
    """
3076
2712
 
3077
2713
    def get_stacked_on_url(self):
3078
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2714
        raise errors.UnstackableBranchFormat(self._format, self.base)
3079
2715
 
3080
2716
 
3081
2717
######################################################################
3160
2796
 
3161
2797
    def __init__(self, branch):
3162
2798
        self.branch = branch
3163
 
        self.errors = []
 
2799
        self.ghosts_in_mainline = False
3164
2800
 
3165
2801
    def report_results(self, verbose):
3166
2802
        """Report the check results via trace.note.
3168
2804
        :param verbose: Requests more detailed display of what was checked,
3169
2805
            if any.
3170
2806
        """
3171
 
        note('checked branch %s format %s', self.branch.user_url,
3172
 
            self.branch._format)
3173
 
        for error in self.errors:
3174
 
            note('found error:%s', error)
 
2807
        note('checked branch %s format %s',
 
2808
             self.branch.base,
 
2809
             self.branch._format)
 
2810
        if self.ghosts_in_mainline:
 
2811
            note('branch contains ghosts in mainline')
3175
2812
 
3176
2813
 
3177
2814
class Converter5to6(object):
3269
2906
    _optimisers = []
3270
2907
    """The available optimised InterBranch types."""
3271
2908
 
3272
 
    @classmethod
3273
 
    def _get_branch_formats_to_test(klass):
3274
 
        """Return an iterable of format tuples for testing.
3275
 
        
3276
 
        :return: An iterable of (from_format, to_format) to use when testing
3277
 
            this InterBranch class. Each InterBranch class should define this
3278
 
            method itself.
3279
 
        """
3280
 
        raise NotImplementedError(klass._get_branch_formats_to_test)
 
2909
    @staticmethod
 
2910
    def _get_branch_formats_to_test():
 
2911
        """Return a tuple with the Branch formats to use when testing."""
 
2912
        raise NotImplementedError(self._get_branch_formats_to_test)
3281
2913
 
3282
 
    @needs_write_lock
3283
2914
    def pull(self, overwrite=False, stop_revision=None,
3284
2915
             possible_transports=None, local=False):
3285
2916
        """Mirror source into target branch.
3290
2921
        """
3291
2922
        raise NotImplementedError(self.pull)
3292
2923
 
3293
 
    @needs_write_lock
3294
2924
    def update_revisions(self, stop_revision=None, overwrite=False,
3295
2925
                         graph=None):
3296
2926
        """Pull in new perfect-fit revisions.
3304
2934
        """
3305
2935
        raise NotImplementedError(self.update_revisions)
3306
2936
 
3307
 
    @needs_write_lock
3308
2937
    def push(self, overwrite=False, stop_revision=None,
3309
2938
             _override_hook_source_branch=None):
3310
2939
        """Mirror the source branch into the target branch.
3315
2944
 
3316
2945
 
3317
2946
class GenericInterBranch(InterBranch):
3318
 
    """InterBranch implementation that uses public Branch functions."""
3319
 
 
3320
 
    @classmethod
3321
 
    def is_compatible(klass, source, target):
3322
 
        # GenericBranch uses the public API, so always compatible
3323
 
        return True
3324
 
 
3325
 
    @classmethod
3326
 
    def _get_branch_formats_to_test(klass):
3327
 
        return [(BranchFormat._default_format, BranchFormat._default_format)]
3328
 
 
3329
 
    @classmethod
3330
 
    def unwrap_format(klass, format):
3331
 
        if isinstance(format, remote.RemoteBranchFormat):
3332
 
            format._ensure_real()
3333
 
            return format._custom_format
3334
 
        return format                                                                                                  
3335
 
 
3336
 
    @needs_write_lock
3337
 
    def copy_content_into(self, revision_id=None):
3338
 
        """Copy the content of source into target
3339
 
 
3340
 
        revision_id: if not None, the revision history in the new branch will
3341
 
                     be truncated to end with revision_id.
3342
 
        """
3343
 
        self.source.update_references(self.target)
3344
 
        self.source._synchronize_history(self.target, revision_id)
3345
 
        try:
3346
 
            parent = self.source.get_parent()
3347
 
        except errors.InaccessibleParent, e:
3348
 
            mutter('parent was not accessible to copy: %s', e)
3349
 
        else:
3350
 
            if parent:
3351
 
                self.target.set_parent(parent)
3352
 
        if self.source._push_should_merge_tags():
3353
 
            self.source.tags.merge_to(self.target.tags)
3354
 
 
3355
 
    @needs_write_lock
 
2947
    """InterBranch implementation that uses public Branch functions.
 
2948
    """
 
2949
 
 
2950
    @staticmethod
 
2951
    def _get_branch_formats_to_test():
 
2952
        return BranchFormat._default_format, BranchFormat._default_format
 
2953
 
3356
2954
    def update_revisions(self, stop_revision=None, overwrite=False,
3357
2955
        graph=None):
3358
2956
        """See InterBranch.update_revisions()."""
3359
 
        other_revno, other_last_revision = self.source.last_revision_info()
3360
 
        stop_revno = None # unknown
3361
 
        if stop_revision is None:
3362
 
            stop_revision = other_last_revision
3363
 
            if _mod_revision.is_null(stop_revision):
3364
 
                # if there are no commits, we're done.
3365
 
                return
3366
 
            stop_revno = other_revno
3367
 
 
3368
 
        # what's the current last revision, before we fetch [and change it
3369
 
        # possibly]
3370
 
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
3371
 
        # we fetch here so that we don't process data twice in the common
3372
 
        # case of having something to pull, and so that the check for
3373
 
        # already merged can operate on the just fetched graph, which will
3374
 
        # be cached in memory.
3375
 
        self.target.fetch(self.source, stop_revision)
3376
 
        # Check to see if one is an ancestor of the other
3377
 
        if not overwrite:
3378
 
            if graph is None:
3379
 
                graph = self.target.repository.get_graph()
3380
 
            if self.target._check_if_descendant_or_diverged(
3381
 
                    stop_revision, last_rev, graph, self.source):
3382
 
                # stop_revision is a descendant of last_rev, but we aren't
3383
 
                # overwriting, so we're done.
3384
 
                return
3385
 
        if stop_revno is None:
3386
 
            if graph is None:
3387
 
                graph = self.target.repository.get_graph()
3388
 
            this_revno, this_last_revision = \
3389
 
                    self.target.last_revision_info()
3390
 
            stop_revno = graph.find_distance_to_null(stop_revision,
3391
 
                            [(other_last_revision, other_revno),
3392
 
                             (this_last_revision, this_revno)])
3393
 
        self.target.set_last_revision_info(stop_revno, stop_revision)
3394
 
 
3395
 
    @needs_write_lock
 
2957
        self.source.lock_read()
 
2958
        try:
 
2959
            other_revno, other_last_revision = self.source.last_revision_info()
 
2960
            stop_revno = None # unknown
 
2961
            if stop_revision is None:
 
2962
                stop_revision = other_last_revision
 
2963
                if _mod_revision.is_null(stop_revision):
 
2964
                    # if there are no commits, we're done.
 
2965
                    return
 
2966
                stop_revno = other_revno
 
2967
 
 
2968
            # what's the current last revision, before we fetch [and change it
 
2969
            # possibly]
 
2970
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
2971
            # we fetch here so that we don't process data twice in the common
 
2972
            # case of having something to pull, and so that the check for
 
2973
            # already merged can operate on the just fetched graph, which will
 
2974
            # be cached in memory.
 
2975
            self.target.fetch(self.source, stop_revision)
 
2976
            # Check to see if one is an ancestor of the other
 
2977
            if not overwrite:
 
2978
                if graph is None:
 
2979
                    graph = self.target.repository.get_graph()
 
2980
                if self.target._check_if_descendant_or_diverged(
 
2981
                        stop_revision, last_rev, graph, self.source):
 
2982
                    # stop_revision is a descendant of last_rev, but we aren't
 
2983
                    # overwriting, so we're done.
 
2984
                    return
 
2985
            if stop_revno is None:
 
2986
                if graph is None:
 
2987
                    graph = self.target.repository.get_graph()
 
2988
                this_revno, this_last_revision = \
 
2989
                        self.target.last_revision_info()
 
2990
                stop_revno = graph.find_distance_to_null(stop_revision,
 
2991
                                [(other_last_revision, other_revno),
 
2992
                                 (this_last_revision, this_revno)])
 
2993
            self.target.set_last_revision_info(stop_revno, stop_revision)
 
2994
        finally:
 
2995
            self.source.unlock()
 
2996
 
3396
2997
    def pull(self, overwrite=False, stop_revision=None,
3397
 
             possible_transports=None, run_hooks=True,
 
2998
             possible_transports=None, _hook_master=None, run_hooks=True,
3398
2999
             _override_hook_target=None, local=False):
3399
 
        """Pull from source into self, updating my master if any.
 
3000
        """See Branch.pull.
3400
3001
 
 
3002
        :param _hook_master: Private parameter - set the branch to
 
3003
            be supplied as the master to pull hooks.
3401
3004
        :param run_hooks: Private parameter - if false, this branch
3402
3005
            is being called because it's the master of the primary branch,
3403
3006
            so it should not run its hooks.
 
3007
        :param _override_hook_target: Private parameter - set the branch to be
 
3008
            supplied as the target_branch to pull hooks.
 
3009
        :param local: Only update the local branch, and not the bound branch.
3404
3010
        """
3405
 
        bound_location = self.target.get_bound_location()
3406
 
        if local and not bound_location:
 
3011
        # This type of branch can't be bound.
 
3012
        if local:
3407
3013
            raise errors.LocalRequiresBoundBranch()
3408
 
        master_branch = None
3409
 
        if not local and bound_location and self.source.user_url != bound_location:
3410
 
            # not pulling from master, so we need to update master.
3411
 
            master_branch = self.target.get_master_branch(possible_transports)
3412
 
            master_branch.lock_write()
 
3014
        result = PullResult()
 
3015
        result.source_branch = self.source
 
3016
        if _override_hook_target is None:
 
3017
            result.target_branch = self.target
 
3018
        else:
 
3019
            result.target_branch = _override_hook_target
 
3020
        self.source.lock_read()
3413
3021
        try:
3414
 
            if master_branch:
3415
 
                # pull from source into master.
3416
 
                master_branch.pull(self.source, overwrite, stop_revision,
3417
 
                    run_hooks=False)
3418
 
            return self._pull(overwrite,
3419
 
                stop_revision, _hook_master=master_branch,
3420
 
                run_hooks=run_hooks,
3421
 
                _override_hook_target=_override_hook_target)
 
3022
            # We assume that during 'pull' the target repository is closer than
 
3023
            # the source one.
 
3024
            self.source.update_references(self.target)
 
3025
            graph = self.target.repository.get_graph(self.source.repository)
 
3026
            # TODO: Branch formats should have a flag that indicates 
 
3027
            # that revno's are expensive, and pull() should honor that flag.
 
3028
            # -- JRV20090506
 
3029
            result.old_revno, result.old_revid = \
 
3030
                self.target.last_revision_info()
 
3031
            self.target.update_revisions(self.source, stop_revision,
 
3032
                overwrite=overwrite, graph=graph)
 
3033
            # TODO: The old revid should be specified when merging tags, 
 
3034
            # so a tags implementation that versions tags can only 
 
3035
            # pull in the most recent changes. -- JRV20090506
 
3036
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3037
                overwrite)
 
3038
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3039
            if _hook_master:
 
3040
                result.master_branch = _hook_master
 
3041
                result.local_branch = result.target_branch
 
3042
            else:
 
3043
                result.master_branch = result.target_branch
 
3044
                result.local_branch = None
 
3045
            if run_hooks:
 
3046
                for hook in Branch.hooks['post_pull']:
 
3047
                    hook(result)
3422
3048
        finally:
3423
 
            if master_branch:
3424
 
                master_branch.unlock()
 
3049
            self.source.unlock()
 
3050
        return result
3425
3051
 
3426
3052
    def push(self, overwrite=False, stop_revision=None,
3427
3053
             _override_hook_source_branch=None):
3444
3070
                _override_hook_source_branch=_override_hook_source_branch)
3445
3071
        finally:
3446
3072
            self.source.unlock()
 
3073
        return result
3447
3074
 
3448
3075
    def _push_with_bound_branches(self, overwrite, stop_revision,
3449
3076
            _override_hook_source_branch=None):
3489
3116
            _run_hooks()
3490
3117
            return result
3491
3118
 
3492
 
    def _pull(self, overwrite=False, stop_revision=None,
3493
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3119
    @classmethod
 
3120
    def is_compatible(self, source, target):
 
3121
        # GenericBranch uses the public API, so always compatible
 
3122
        return True
 
3123
 
 
3124
 
 
3125
class InterToBranch5(GenericInterBranch):
 
3126
 
 
3127
    @staticmethod
 
3128
    def _get_branch_formats_to_test():
 
3129
        return BranchFormat._default_format, BzrBranchFormat5()
 
3130
 
 
3131
    def pull(self, overwrite=False, stop_revision=None,
 
3132
             possible_transports=None, run_hooks=True,
3494
3133
             _override_hook_target=None, local=False):
3495
 
        """See Branch.pull.
3496
 
 
3497
 
        This function is the core worker, used by GenericInterBranch.pull to
3498
 
        avoid duplication when pulling source->master and source->local.
3499
 
 
3500
 
        :param _hook_master: Private parameter - set the branch to
3501
 
            be supplied as the master to pull hooks.
 
3134
        """Pull from source into self, updating my master if any.
 
3135
 
3502
3136
        :param run_hooks: Private parameter - if false, this branch
3503
3137
            is being called because it's the master of the primary branch,
3504
3138
            so it should not run its hooks.
3505
 
        :param _override_hook_target: Private parameter - set the branch to be
3506
 
            supplied as the target_branch to pull hooks.
3507
 
        :param local: Only update the local branch, and not the bound branch.
3508
3139
        """
3509
 
        # This type of branch can't be bound.
3510
 
        if local:
 
3140
        bound_location = self.target.get_bound_location()
 
3141
        if local and not bound_location:
3511
3142
            raise errors.LocalRequiresBoundBranch()
3512
 
        result = PullResult()
3513
 
        result.source_branch = self.source
3514
 
        if _override_hook_target is None:
3515
 
            result.target_branch = self.target
3516
 
        else:
3517
 
            result.target_branch = _override_hook_target
3518
 
        self.source.lock_read()
 
3143
        master_branch = None
 
3144
        if not local and bound_location and self.source.base != bound_location:
 
3145
            # not pulling from master, so we need to update master.
 
3146
            master_branch = self.target.get_master_branch(possible_transports)
 
3147
            master_branch.lock_write()
3519
3148
        try:
3520
 
            # We assume that during 'pull' the target repository is closer than
3521
 
            # the source one.
3522
 
            self.source.update_references(self.target)
3523
 
            graph = self.target.repository.get_graph(self.source.repository)
3524
 
            # TODO: Branch formats should have a flag that indicates 
3525
 
            # that revno's are expensive, and pull() should honor that flag.
3526
 
            # -- JRV20090506
3527
 
            result.old_revno, result.old_revid = \
3528
 
                self.target.last_revision_info()
3529
 
            self.target.update_revisions(self.source, stop_revision,
3530
 
                overwrite=overwrite, graph=graph)
3531
 
            # TODO: The old revid should be specified when merging tags, 
3532
 
            # so a tags implementation that versions tags can only 
3533
 
            # pull in the most recent changes. -- JRV20090506
3534
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3535
 
                overwrite)
3536
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3537
 
            if _hook_master:
3538
 
                result.master_branch = _hook_master
3539
 
                result.local_branch = result.target_branch
3540
 
            else:
3541
 
                result.master_branch = result.target_branch
3542
 
                result.local_branch = None
3543
 
            if run_hooks:
3544
 
                for hook in Branch.hooks['post_pull']:
3545
 
                    hook(result)
 
3149
            if master_branch:
 
3150
                # pull from source into master.
 
3151
                master_branch.pull(self.source, overwrite, stop_revision,
 
3152
                    run_hooks=False)
 
3153
            return super(InterToBranch5, self).pull(overwrite,
 
3154
                stop_revision, _hook_master=master_branch,
 
3155
                run_hooks=run_hooks,
 
3156
                _override_hook_target=_override_hook_target)
3546
3157
        finally:
3547
 
            self.source.unlock()
3548
 
        return result
 
3158
            if master_branch:
 
3159
                master_branch.unlock()
3549
3160
 
3550
3161
 
3551
3162
InterBranch.register_optimiser(GenericInterBranch)
 
3163
InterBranch.register_optimiser(InterToBranch5)