~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2009-07-10 06:46:10 UTC
  • mto: (4525.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4526.
  • Revision ID: mbp@sourcefrog.net-20090710064610-sqviksbqp5i34sw2
Rename to per_interrepository

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