/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

Fix 1 more lock-related test failure.

* tests/test_rename_map.py:
(TestRenameMap.test_guess_renames_preserves_children): Add the
forgotten unlock.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
46
46
    )
47
47
""")
48
48
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
50
from bzrlib.hooks import HookPoint, Hooks
51
51
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
53
52
from bzrlib import registry
54
53
from bzrlib.symbol_versioning import (
55
54
    deprecated_in,
63
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
63
 
65
64
 
66
 
class Branch(bzrdir.ControlComponent):
 
65
# TODO: Maybe include checks for common corruption of newlines, etc?
 
66
 
 
67
# TODO: Some operations like log might retrieve the same revisions
 
68
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
69
# cache in memory to make this faster.  In general anything can be
 
70
# cached in memory between lock and unlock operations. .. nb thats
 
71
# what the transaction identity map provides
 
72
 
 
73
 
 
74
######################################################################
 
75
# branch objects
 
76
 
 
77
class Branch(object):
67
78
    """Branch holding a history of revisions.
68
79
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
80
    base
 
81
        Base directory/url of the branch.
72
82
 
73
83
    hooks: An instance of BranchHooks.
74
84
    """
76
86
    # - RBC 20060112
77
87
    base = None
78
88
 
79
 
    @property
80
 
    def control_transport(self):
81
 
        return self._transport
82
 
 
83
 
    @property
84
 
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
86
 
 
87
89
    def __init__(self, *ignored, **ignored_too):
88
90
        self.tags = self._format.make_tags(self)
89
91
        self._revision_history_cache = None
90
92
        self._revision_id_to_revno_cache = None
91
93
        self._partial_revision_id_to_revno_cache = {}
92
 
        self._partial_revision_history_cache = []
93
94
        self._last_revision_info_cache = None
94
95
        self._merge_sorted_revisions_cache = None
95
96
        self._open_hook()
100
101
    def _open_hook(self):
101
102
        """Called by init to allow simpler extension of the base class."""
102
103
 
103
 
    def _activate_fallback_location(self, url):
 
104
    def _activate_fallback_location(self, url, lock_style):
104
105
        """Activate the branch/repository from url as a fallback repository."""
105
106
        repo = self._get_fallback_repository(url)
106
 
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
107
        if lock_style == 'write':
 
108
            repo.lock_write()
 
109
        elif lock_style == 'read':
 
110
            repo.lock_read()
108
111
        self.repository.add_fallback_repository(repo)
109
112
 
110
113
    def break_lock(self):
126
129
            raise errors.UnstackableRepositoryFormat(self.repository._format,
127
130
                self.repository.base)
128
131
 
129
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
 
        """Extend the partial history to include a given index
131
 
 
132
 
        If a stop_index is supplied, stop when that index has been reached.
133
 
        If a stop_revision is supplied, stop when that revision is
134
 
        encountered.  Otherwise, stop when the beginning of history is
135
 
        reached.
136
 
 
137
 
        :param stop_index: The index which should be present.  When it is
138
 
            present, history extension will stop.
139
 
        :param stop_revision: The revision id which should be present.  When
140
 
            it is encountered, history extension will stop.
141
 
        """
142
 
        if len(self._partial_revision_history_cache) == 0:
143
 
            self._partial_revision_history_cache = [self.last_revision()]
144
 
        repository._iter_for_revno(
145
 
            self.repository, self._partial_revision_history_cache,
146
 
            stop_index=stop_index, stop_revision=stop_revision)
147
 
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
 
            self._partial_revision_history_cache.pop()
149
 
 
150
 
    def _get_check_refs(self):
151
 
        """Get the references needed for check().
152
 
 
153
 
        See bzrlib.check.
154
 
        """
155
 
        revid = self.last_revision()
156
 
        return [('revision-existence', revid), ('lefthand-distance', revid)]
157
 
 
158
132
    @staticmethod
159
133
    def open(base, _unsupported=False, possible_transports=None):
160
134
        """Open the branch rooted at base.
164
138
        """
165
139
        control = bzrdir.BzrDir.open(base, _unsupported,
166
140
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
141
        return control.open_branch(_unsupported)
168
142
 
169
143
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
144
    def open_from_transport(transport, _unsupported=False):
171
145
        """Open the branch rooted at transport"""
172
146
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
147
        return control.open_branch(_unsupported)
174
148
 
175
149
    @staticmethod
176
150
    def open_containing(url, possible_transports=None):
214
188
    def _get_fallback_repository(self, url):
215
189
        """Get the repository we fallback to at url."""
216
190
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
191
        a_bzrdir = bzrdir.BzrDir.open(url,
218
192
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
193
        return a_bzrdir.open_branch().repository
220
194
 
221
195
    def _get_tags_bytes(self):
222
196
        """Get the bytes of a serialised tags dict.
283
257
        new_history.reverse()
284
258
        return new_history
285
259
 
286
 
    def lock_write(self, token=None):
287
 
        """Lock the branch for write operations.
288
 
 
289
 
        :param token: A token to permit reacquiring a previously held and
290
 
            preserved lock.
291
 
        :return: A BranchWriteLockResult.
292
 
        """
 
260
    def lock_write(self):
293
261
        raise NotImplementedError(self.lock_write)
294
262
 
295
263
    def lock_read(self):
296
 
        """Lock the branch for read operations.
297
 
 
298
 
        :return: An object with an unlock method which will release the lock
299
 
            obtained.
300
 
        """
301
264
        raise NotImplementedError(self.lock_read)
302
265
 
303
266
    def unlock(self):
428
391
            * 'include' - the stop revision is the last item in the result
429
392
            * 'with-merges' - include the stop revision and all of its
430
393
              merged revisions in the result
431
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
432
 
              that are in both ancestries
433
394
        :param direction: either 'reverse' or 'forward':
434
395
            * reverse means return the start_revision_id first, i.e.
435
396
              start at the most recent revision and go backwards in history
457
418
        # start_revision_id.
458
419
        if self._merge_sorted_revisions_cache is None:
459
420
            last_revision = self.last_revision()
460
 
            known_graph = self.repository.get_known_graph_ancestry(
461
 
                [last_revision])
462
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
 
                last_revision)
 
421
            graph = self.repository.get_graph()
 
422
            parent_map = dict(((key, value) for key, value in
 
423
                     graph.iter_ancestry([last_revision]) if value is not None))
 
424
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
425
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
426
                generate_revno=True)
 
427
            # Drop the sequence # before caching
 
428
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
429
 
464
430
        filtered = self._filter_merge_sorted_revisions(
465
431
            self._merge_sorted_revisions_cache, start_revision_id,
466
432
            stop_revision_id, stop_rule)
467
 
        # Make sure we don't return revisions that are not part of the
468
 
        # start_revision_id ancestry.
469
 
        filtered = self._filter_start_non_ancestors(filtered)
470
433
        if direction == 'reverse':
471
434
            return filtered
472
435
        if direction == 'forward':
479
442
        """Iterate over an inclusive range of sorted revisions."""
480
443
        rev_iter = iter(merge_sorted_revisions)
481
444
        if start_revision_id is not None:
482
 
            for node in rev_iter:
483
 
                rev_id = node.key[-1]
 
445
            for rev_id, depth, revno, end_of_merge in rev_iter:
484
446
                if rev_id != start_revision_id:
485
447
                    continue
486
448
                else:
487
449
                    # The decision to include the start or not
488
450
                    # depends on the stop_rule if a stop is provided
489
 
                    # so pop this node back into the iterator
490
 
                    rev_iter = chain(iter([node]), rev_iter)
 
451
                    rev_iter = chain(
 
452
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
453
                        rev_iter)
491
454
                    break
492
455
        if stop_revision_id is None:
493
 
            # Yield everything
494
 
            for node in rev_iter:
495
 
                rev_id = node.key[-1]
496
 
                yield (rev_id, node.merge_depth, node.revno,
497
 
                       node.end_of_merge)
 
456
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
457
                yield rev_id, depth, revno, end_of_merge
498
458
        elif stop_rule == 'exclude':
499
 
            for node in rev_iter:
500
 
                rev_id = node.key[-1]
 
459
            for rev_id, depth, revno, end_of_merge in rev_iter:
501
460
                if rev_id == stop_revision_id:
502
461
                    return
503
 
                yield (rev_id, node.merge_depth, node.revno,
504
 
                       node.end_of_merge)
 
462
                yield rev_id, depth, revno, end_of_merge
505
463
        elif stop_rule == 'include':
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)
 
464
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
465
                yield rev_id, depth, revno, end_of_merge
510
466
                if rev_id == stop_revision_id:
511
467
                    return
512
 
        elif stop_rule == 'with-merges-without-common-ancestry':
513
 
            # We want to exclude all revisions that are already part of the
514
 
            # stop_revision_id ancestry.
515
 
            graph = self.repository.get_graph()
516
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
517
 
                                                    [stop_revision_id])
518
 
            for node in rev_iter:
519
 
                rev_id = node.key[-1]
520
 
                if rev_id not in ancestors:
521
 
                    continue
522
 
                yield (rev_id, node.merge_depth, node.revno,
523
 
                       node.end_of_merge)
524
468
        elif stop_rule == 'with-merges':
525
469
            stop_rev = self.repository.get_revision(stop_revision_id)
526
470
            if stop_rev.parent_ids:
527
471
                left_parent = stop_rev.parent_ids[0]
528
472
            else:
529
473
                left_parent = _mod_revision.NULL_REVISION
530
 
            # left_parent is the actual revision we want to stop logging at,
531
 
            # since we want to show the merged revisions after the stop_rev too
532
 
            reached_stop_revision_id = False
533
 
            revision_id_whitelist = []
534
 
            for node in rev_iter:
535
 
                rev_id = node.key[-1]
 
474
            for rev_id, depth, revno, end_of_merge in rev_iter:
536
475
                if rev_id == left_parent:
537
 
                    # reached the left parent after the stop_revision
538
476
                    return
539
 
                if (not reached_stop_revision_id or
540
 
                        rev_id in revision_id_whitelist):
541
 
                    yield (rev_id, node.merge_depth, node.revno,
542
 
                       node.end_of_merge)
543
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
544
 
                        # only do the merged revs of rev_id from now on
545
 
                        rev = self.repository.get_revision(rev_id)
546
 
                        if rev.parent_ids:
547
 
                            reached_stop_revision_id = True
548
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
477
                yield rev_id, depth, revno, end_of_merge
549
478
        else:
550
479
            raise ValueError('invalid stop_rule %r' % stop_rule)
551
480
 
552
 
    def _filter_start_non_ancestors(self, rev_iter):
553
 
        # If we started from a dotted revno, we want to consider it as a tip
554
 
        # and don't want to yield revisions that are not part of its
555
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
556
 
        # uninteresting descendants of the first parent of our tip before the
557
 
        # tip itself.
558
 
        first = rev_iter.next()
559
 
        (rev_id, merge_depth, revno, end_of_merge) = first
560
 
        yield first
561
 
        if not merge_depth:
562
 
            # We start at a mainline revision so by definition, all others
563
 
            # revisions in rev_iter are ancestors
564
 
            for node in rev_iter:
565
 
                yield node
566
 
 
567
 
        clean = False
568
 
        whitelist = set()
569
 
        pmap = self.repository.get_parent_map([rev_id])
570
 
        parents = pmap.get(rev_id, [])
571
 
        if parents:
572
 
            whitelist.update(parents)
573
 
        else:
574
 
            # If there is no parents, there is nothing of interest left
575
 
 
576
 
            # FIXME: It's hard to test this scenario here as this code is never
577
 
            # called in that case. -- vila 20100322
578
 
            return
579
 
 
580
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
 
            if not clean:
582
 
                if rev_id in whitelist:
583
 
                    pmap = self.repository.get_parent_map([rev_id])
584
 
                    parents = pmap.get(rev_id, [])
585
 
                    whitelist.remove(rev_id)
586
 
                    whitelist.update(parents)
587
 
                    if merge_depth == 0:
588
 
                        # We've reached the mainline, there is nothing left to
589
 
                        # filter
590
 
                        clean = True
591
 
                else:
592
 
                    # A revision that is not part of the ancestry of our
593
 
                    # starting revision.
594
 
                    continue
595
 
            yield (rev_id, merge_depth, revno, end_of_merge)
596
 
 
597
481
    def leave_lock_in_place(self):
598
482
        """Tell this branch object not to release the physical lock when this
599
483
        object is unlocked.
616
500
        :param other: The branch to bind to
617
501
        :type other: Branch
618
502
        """
619
 
        raise errors.UpgradeRequired(self.user_url)
620
 
 
621
 
    def set_append_revisions_only(self, enabled):
622
 
        if not self._format.supports_set_append_revisions_only():
623
 
            raise errors.UpgradeRequired(self.user_url)
624
 
        if enabled:
625
 
            value = 'True'
626
 
        else:
627
 
            value = 'False'
628
 
        self.get_config().set_user_option('append_revisions_only', value,
629
 
            warn_masked=True)
 
503
        raise errors.UpgradeRequired(self.base)
630
504
 
631
505
    def set_reference_info(self, file_id, tree_path, branch_location):
632
506
        """Set the branch location to use for a tree reference."""
674
548
    def get_old_bound_location(self):
675
549
        """Return the URL of the branch we used to be bound to
676
550
        """
677
 
        raise errors.UpgradeRequired(self.user_url)
 
551
        raise errors.UpgradeRequired(self.base)
678
552
 
679
553
    def get_commit_builder(self, parents, config=None, timestamp=None,
680
554
                           timezone=None, committer=None, revprops=None,
758
632
            stacking.
759
633
        """
760
634
        if not self._format.supports_stacking():
761
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
762
 
        # XXX: Changing from one fallback repository to another does not check
763
 
        # that all the data you need is present in the new fallback.
764
 
        # Possibly it should.
 
635
            raise errors.UnstackableBranchFormat(self._format, self.base)
765
636
        self._check_stackable_repo()
766
637
        if not url:
767
638
            try:
769
640
            except (errors.NotStacked, errors.UnstackableBranchFormat,
770
641
                errors.UnstackableRepositoryFormat):
771
642
                return
772
 
            self._unstack()
 
643
            url = ''
 
644
            # XXX: Lock correctness - should unlock our old repo if we were
 
645
            # locked.
 
646
            # repositories don't offer an interface to remove fallback
 
647
            # repositories today; take the conceptually simpler option and just
 
648
            # reopen it.
 
649
            self.repository = self.bzrdir.find_repository()
 
650
            self.repository.lock_write()
 
651
            # for every revision reference the branch has, ensure it is pulled
 
652
            # in.
 
653
            source_repository = self._get_fallback_repository(old_url)
 
654
            for revision_id in chain([self.last_revision()],
 
655
                self.tags.get_reverse_tag_dict()):
 
656
                self.repository.fetch(source_repository, revision_id,
 
657
                    find_ghosts=True)
773
658
        else:
774
 
            self._activate_fallback_location(url)
 
659
            self._activate_fallback_location(url, 'write')
775
660
        # write this out after the repository is stacked to avoid setting a
776
661
        # stacked config that doesn't work.
777
662
        self._set_config_location('stacked_on_location', url)
778
663
 
779
 
    def _unstack(self):
780
 
        """Change a branch to be unstacked, copying data as needed.
781
 
        
782
 
        Don't call this directly, use set_stacked_on_url(None).
783
 
        """
784
 
        pb = ui.ui_factory.nested_progress_bar()
785
 
        try:
786
 
            pb.update("Unstacking")
787
 
            # The basic approach here is to fetch the tip of the branch,
788
 
            # including all available ghosts, from the existing stacked
789
 
            # repository into a new repository object without the fallbacks. 
790
 
            #
791
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
792
 
            # correct for CHKMap repostiories
793
 
            old_repository = self.repository
794
 
            if len(old_repository._fallback_repositories) != 1:
795
 
                raise AssertionError("can't cope with fallback repositories "
796
 
                    "of %r" % (self.repository,))
797
 
            # unlock it, including unlocking the fallback
798
 
            old_repository.unlock()
799
 
            old_repository.lock_read()
800
 
            try:
801
 
                # Repositories don't offer an interface to remove fallback
802
 
                # repositories today; take the conceptually simpler option and just
803
 
                # reopen it.  We reopen it starting from the URL so that we
804
 
                # get a separate connection for RemoteRepositories and can
805
 
                # stream from one of them to the other.  This does mean doing
806
 
                # separate SSH connection setup, but unstacking is not a
807
 
                # common operation so it's tolerable.
808
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
809
 
                new_repository = new_bzrdir.find_repository()
810
 
                self.repository = new_repository
811
 
                if self.repository._fallback_repositories:
812
 
                    raise AssertionError("didn't expect %r to have "
813
 
                        "fallback_repositories"
814
 
                        % (self.repository,))
815
 
                # this is not paired with an unlock because it's just restoring
816
 
                # the previous state; the lock's released when set_stacked_on_url
817
 
                # returns
818
 
                self.repository.lock_write()
819
 
                # XXX: If you unstack a branch while it has a working tree
820
 
                # with a pending merge, the pending-merged revisions will no
821
 
                # longer be present.  You can (probably) revert and remerge.
822
 
                #
823
 
                # XXX: This only fetches up to the tip of the repository; it
824
 
                # doesn't bring across any tags.  That's fairly consistent
825
 
                # with how branch works, but perhaps not ideal.
826
 
                self.repository.fetch(old_repository,
827
 
                    revision_id=self.last_revision(),
828
 
                    find_ghosts=True)
829
 
            finally:
830
 
                old_repository.unlock()
831
 
        finally:
832
 
            pb.finished()
833
664
 
834
665
    def _set_tags_bytes(self, bytes):
835
666
        """Mirror method for _get_tags_bytes.
871
702
        self._revision_id_to_revno_cache = None
872
703
        self._last_revision_info_cache = None
873
704
        self._merge_sorted_revisions_cache = None
874
 
        self._partial_revision_history_cache = []
875
 
        self._partial_revision_id_to_revno_cache = {}
876
705
 
877
706
    def _gen_revision_history(self):
878
707
        """Return sequence of revision hashes on to this branch.
915
744
 
916
745
    def unbind(self):
917
746
        """Older format branches cannot bind or unbind."""
918
 
        raise errors.UpgradeRequired(self.user_url)
 
747
        raise errors.UpgradeRequired(self.base)
 
748
 
 
749
    def set_append_revisions_only(self, enabled):
 
750
        """Older format branches are never restricted to append-only"""
 
751
        raise errors.UpgradeRequired(self.base)
919
752
 
920
753
    def last_revision(self):
921
754
        """Return last revision id, or NULL_REVISION."""
1002
835
        except ValueError:
1003
836
            raise errors.NoSuchRevision(self, revision_id)
1004
837
 
1005
 
    @needs_read_lock
1006
838
    def get_rev_id(self, revno, history=None):
1007
839
        """Find the revision id of the specified revno."""
1008
840
        if revno == 0:
1009
841
            return _mod_revision.NULL_REVISION
1010
 
        last_revno, last_revid = self.last_revision_info()
1011
 
        if revno == last_revno:
1012
 
            return last_revid
1013
 
        if revno <= 0 or revno > last_revno:
 
842
        if history is None:
 
843
            history = self.revision_history()
 
844
        if revno <= 0 or revno > len(history):
1014
845
            raise errors.NoSuchRevision(self, revno)
1015
 
        distance_from_last = last_revno - revno
1016
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
1017
 
            self._extend_partial_history(distance_from_last)
1018
 
        return self._partial_revision_history_cache[distance_from_last]
 
846
        return history[revno - 1]
1019
847
 
1020
 
    @needs_write_lock
1021
848
    def pull(self, source, overwrite=False, stop_revision=None,
1022
 
             possible_transports=None, *args, **kwargs):
 
849
             possible_transports=None, _override_hook_target=None):
1023
850
        """Mirror source into this branch.
1024
851
 
1025
852
        This branch is considered to be 'local', having low latency.
1026
853
 
1027
854
        :returns: PullResult instance
1028
855
        """
1029
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1030
 
            stop_revision=stop_revision,
1031
 
            possible_transports=possible_transports, *args, **kwargs)
 
856
        raise NotImplementedError(self.pull)
1032
857
 
1033
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1034
 
        **kwargs):
 
858
    def push(self, target, overwrite=False, stop_revision=None):
1035
859
        """Mirror this branch into target.
1036
860
 
1037
861
        This branch is considered to be 'local', having low latency.
1038
862
        """
1039
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1040
 
            *args, **kwargs)
1041
 
 
1042
 
    def lossy_push(self, target, stop_revision=None):
1043
 
        """Push deltas into another branch.
1044
 
 
1045
 
        :note: This does not, like push, retain the revision ids from 
1046
 
            the source branch and will, rather than adding bzr-specific 
1047
 
            metadata, push only those semantics of the revision that can be 
1048
 
            natively represented by this branch' VCS.
1049
 
 
1050
 
        :param target: Target branch
1051
 
        :param stop_revision: Revision to push, defaults to last revision.
1052
 
        :return: BranchPushResult with an extra member revidmap: 
1053
 
            A dictionary mapping revision ids from the target branch 
1054
 
            to new revision ids in the target branch, for each 
1055
 
            revision that was pushed.
1056
 
        """
1057
 
        inter = InterBranch.get(self, target)
1058
 
        lossy_push = getattr(inter, "lossy_push", None)
1059
 
        if lossy_push is None:
1060
 
            raise errors.LossyPushToSameVCS(self, target)
1061
 
        return lossy_push(stop_revision)
 
863
        raise NotImplementedError(self.push)
1062
864
 
1063
865
    def basis_tree(self):
1064
866
        """Return `Tree` object for last revision."""
1081
883
        try:
1082
884
            return urlutils.join(self.base[:-1], parent)
1083
885
        except errors.InvalidURLJoin, e:
1084
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
886
            raise errors.InaccessibleParent(parent, self.base)
1085
887
 
1086
888
    def _get_parent_location(self):
1087
889
        raise NotImplementedError(self._get_parent_location)
1104
906
            location = None
1105
907
        return location
1106
908
 
1107
 
    def get_child_submit_format(self):
1108
 
        """Return the preferred format of submissions to this branch."""
1109
 
        return self.get_config().get_user_option("child_submit_format")
1110
 
 
1111
909
    def get_submit_branch(self):
1112
910
        """Return the submit location of the branch.
1113
911
 
1172
970
        params = ChangeBranchTipParams(
1173
971
            self, old_revno, new_revno, old_revid, new_revid)
1174
972
        for hook in hooks:
1175
 
            hook(params)
 
973
            try:
 
974
                hook(params)
 
975
            except errors.TipChangeRejected:
 
976
                raise
 
977
            except Exception:
 
978
                exc_info = sys.exc_info()
 
979
                hook_name = Branch.hooks.get_hook_name(hook)
 
980
                raise errors.HookFailed(
 
981
                    'pre_change_branch_tip', hook_name, exc_info)
1176
982
 
1177
983
    @needs_write_lock
1178
984
    def update(self):
1227
1033
        revision_id: if not None, the revision history in the new branch will
1228
1034
                     be truncated to end with revision_id.
1229
1035
        """
1230
 
        if (repository_policy is not None and
1231
 
            repository_policy.requires_stacking()):
1232
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1233
1036
        result = to_bzrdir.create_branch()
1234
1037
        result.lock_write()
1235
1038
        try:
1256
1059
        source_revno, source_revision_id = self.last_revision_info()
1257
1060
        if revision_id is None:
1258
1061
            revno, revision_id = source_revno, source_revision_id
 
1062
        elif source_revision_id == revision_id:
 
1063
            # we know the revno without needing to walk all of history
 
1064
            revno = source_revno
1259
1065
        else:
1260
 
            graph = self.repository.get_graph()
1261
 
            try:
1262
 
                revno = graph.find_distance_to_null(revision_id, 
1263
 
                    [(source_revision_id, source_revno)])
1264
 
            except errors.GhostRevisionsHaveNoRevno:
1265
 
                # Default to 1, if we can't find anything else
1266
 
                revno = 1
 
1066
            # To figure out the revno for a random revision, we need to build
 
1067
            # the revision history, and count its length.
 
1068
            # We don't care about the order, just how long it is.
 
1069
            # Alternatively, we could start at the current location, and count
 
1070
            # backwards. But there is no guarantee that we will find it since
 
1071
            # it may be a merged revision.
 
1072
            revno = len(list(self.repository.iter_reverse_revision_history(
 
1073
                                                                revision_id)))
1267
1074
        destination.set_last_revision_info(revno, revision_id)
1268
1075
 
1269
1076
    @needs_read_lock
1303
1110
        target._set_all_reference_info(target_reference_dict)
1304
1111
 
1305
1112
    @needs_read_lock
1306
 
    def check(self, refs):
 
1113
    def check(self):
1307
1114
        """Check consistency of the branch.
1308
1115
 
1309
1116
        In particular this checks that revisions given in the revision-history
1312
1119
 
1313
1120
        Callers will typically also want to check the repository.
1314
1121
 
1315
 
        :param refs: Calculated refs for this branch as specified by
1316
 
            branch._get_check_refs()
1317
1122
        :return: A BranchCheckResult.
1318
1123
        """
1319
 
        result = BranchCheckResult(self)
 
1124
        mainline_parent_id = None
1320
1125
        last_revno, last_revision_id = self.last_revision_info()
1321
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1322
 
        if actual_revno != last_revno:
1323
 
            result.errors.append(errors.BzrCheckError(
1324
 
                'revno does not match len(mainline) %s != %s' % (
1325
 
                last_revno, actual_revno)))
1326
 
        # TODO: We should probably also check that self.revision_history
1327
 
        # matches the repository for older branch formats.
1328
 
        # If looking for the code that cross-checks repository parents against
1329
 
        # the iter_reverse_revision_history output, that is now a repository
1330
 
        # specific check.
1331
 
        return result
 
1126
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
1127
                                last_revision_id))
 
1128
        real_rev_history.reverse()
 
1129
        if len(real_rev_history) != last_revno:
 
1130
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1131
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1132
        # TODO: We should probably also check that real_rev_history actually
 
1133
        #       matches self.revision_history()
 
1134
        for revision_id in real_rev_history:
 
1135
            try:
 
1136
                revision = self.repository.get_revision(revision_id)
 
1137
            except errors.NoSuchRevision, e:
 
1138
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1139
                            % revision_id)
 
1140
            # In general the first entry on the revision history has no parents.
 
1141
            # But it's not illegal for it to have parents listed; this can happen
 
1142
            # in imports from Arch when the parents weren't reachable.
 
1143
            if mainline_parent_id is not None:
 
1144
                if mainline_parent_id not in revision.parent_ids:
 
1145
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1146
                                        "parents of {%s}"
 
1147
                                        % (mainline_parent_id, revision_id))
 
1148
            mainline_parent_id = revision_id
 
1149
        return BranchCheckResult(self)
1332
1150
 
1333
1151
    def _get_checkout_format(self):
1334
1152
        """Return the most suitable metadir for a checkout of this branch.
1359
1177
        # clone call. Or something. 20090224 RBC/spiv.
1360
1178
        if revision_id is None:
1361
1179
            revision_id = self.last_revision()
1362
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1363
 
            revision_id=revision_id, stacked_on=stacked_on,
1364
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1180
        try:
 
1181
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1182
                revision_id=revision_id, stacked_on=stacked_on,
 
1183
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1184
        except errors.FileExists:
 
1185
            if not use_existing_dir:
 
1186
                raise
 
1187
        except errors.NoSuchFile:
 
1188
            if not create_prefix:
 
1189
                raise
1365
1190
        return dir_to.open_branch()
1366
1191
 
1367
1192
    def create_checkout(self, to_location, revision_id=None,
1386
1211
        if lightweight:
1387
1212
            format = self._get_checkout_format()
1388
1213
            checkout = format.initialize_on_transport(t)
1389
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1390
 
                target_branch=self)
 
1214
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1391
1215
        else:
1392
1216
            format = self._get_checkout_format()
1393
1217
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1435
1259
    def supports_tags(self):
1436
1260
        return self._format.supports_tags()
1437
1261
 
1438
 
    def automatic_tag_name(self, revision_id):
1439
 
        """Try to automatically find the tag name for a revision.
1440
 
 
1441
 
        :param revision_id: Revision id of the revision.
1442
 
        :return: A tag name or None if no tag name could be determined.
1443
 
        """
1444
 
        for hook in Branch.hooks['automatic_tag_name']:
1445
 
            ret = hook(self, revision_id)
1446
 
            if ret is not None:
1447
 
                return ret
1448
 
        return None
1449
 
 
1450
1262
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1451
1263
                                         other_branch):
1452
1264
        """Ensure that revision_b is a descendant of revision_a.
1507
1319
    _formats = {}
1508
1320
    """The known formats."""
1509
1321
 
1510
 
    can_set_append_revisions_only = True
1511
 
 
1512
1322
    def __eq__(self, other):
1513
1323
        return self.__class__ is other.__class__
1514
1324
 
1516
1326
        return not (self == other)
1517
1327
 
1518
1328
    @classmethod
1519
 
    def find_format(klass, a_bzrdir, name=None):
 
1329
    def find_format(klass, a_bzrdir):
1520
1330
        """Return the format for the branch object in a_bzrdir."""
1521
1331
        try:
1522
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1523
 
            format_string = transport.get_bytes("format")
 
1332
            transport = a_bzrdir.get_branch_transport(None)
 
1333
            format_string = transport.get("format").read()
1524
1334
            return klass._formats[format_string]
1525
1335
        except errors.NoSuchFile:
1526
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1336
            raise errors.NotBranchError(path=transport.base)
1527
1337
        except KeyError:
1528
1338
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1529
1339
 
1565
1375
        """Return the short format description for this format."""
1566
1376
        raise NotImplementedError(self.get_format_description)
1567
1377
 
1568
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1569
 
        hooks = Branch.hooks['post_branch_init']
1570
 
        if not hooks:
1571
 
            return
1572
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1573
 
        for hook in hooks:
1574
 
            hook(params)
1575
 
 
1576
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1577
 
                           lock_type='metadir', set_format=True):
 
1378
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1379
                           set_format=True):
1578
1380
        """Initialize a branch in a bzrdir, with specified files
1579
1381
 
1580
1382
        :param a_bzrdir: The bzrdir to initialize the branch in
1581
1383
        :param utf8_files: The files to create as a list of
1582
1384
            (filename, content) tuples
1583
 
        :param name: Name of colocated branch to create, if any
1584
1385
        :param set_format: If True, set the format with
1585
1386
            self.get_format_string.  (BzrBranch4 has its format set
1586
1387
            elsewhere)
1587
1388
        :return: a branch in this format
1588
1389
        """
1589
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1590
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1390
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1391
        branch_transport = a_bzrdir.get_branch_transport(self)
1591
1392
        lock_map = {
1592
1393
            'metadir': ('lock', lockdir.LockDir),
1593
1394
            'branch4': ('branch-lock', lockable_files.TransportLock),
1614
1415
        finally:
1615
1416
            if lock_taken:
1616
1417
                control_files.unlock()
1617
 
        branch = self.open(a_bzrdir, name, _found=True)
1618
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1619
 
        return branch
 
1418
        return self.open(a_bzrdir, _found=True)
1620
1419
 
1621
 
    def initialize(self, a_bzrdir, name=None):
1622
 
        """Create a branch of this format in a_bzrdir.
1623
 
        
1624
 
        :param name: Name of the colocated branch to create.
1625
 
        """
 
1420
    def initialize(self, a_bzrdir):
 
1421
        """Create a branch of this format in a_bzrdir."""
1626
1422
        raise NotImplementedError(self.initialize)
1627
1423
 
1628
1424
    def is_supported(self):
1658
1454
        """
1659
1455
        raise NotImplementedError(self.network_name)
1660
1456
 
1661
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1457
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1662
1458
        """Return the branch object for a_bzrdir
1663
1459
 
1664
1460
        :param a_bzrdir: A BzrDir that contains a branch.
1665
 
        :param name: Name of colocated branch to open
1666
1461
        :param _found: a private parameter, do not use it. It is used to
1667
1462
            indicate if format probing has already be done.
1668
1463
        :param ignore_fallbacks: when set, no fallback branches will be opened
1682
1477
    def set_default_format(klass, format):
1683
1478
        klass._default_format = format
1684
1479
 
1685
 
    def supports_set_append_revisions_only(self):
1686
 
        """True if this format supports set_append_revisions_only."""
1687
 
        return False
1688
 
 
1689
1480
    def supports_stacking(self):
1690
1481
        """True if this format records a stacked-on branch."""
1691
1482
        return False
1776
1567
            "multiple hooks installed for transform_fallback_location, "
1777
1568
            "all are called with the url returned from the previous hook."
1778
1569
            "The order is however undefined.", (1, 9), None))
1779
 
        self.create_hook(HookPoint('automatic_tag_name',
1780
 
            "Called to determine an automatic tag name for a revision."
1781
 
            "automatic_tag_name is called with (branch, revision_id) and "
1782
 
            "should return a tag name or None if no tag name could be "
1783
 
            "determined. The first non-None tag name returned will be used.",
1784
 
            (2, 2), None))
1785
 
        self.create_hook(HookPoint('post_branch_init',
1786
 
            "Called after new branch initialization completes. "
1787
 
            "post_branch_init is called with a "
1788
 
            "bzrlib.branch.BranchInitHookParams. "
1789
 
            "Note that init, branch and checkout (both heavyweight and "
1790
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1791
 
        self.create_hook(HookPoint('post_switch',
1792
 
            "Called after a checkout switches branch. "
1793
 
            "post_switch is called with a "
1794
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1795
 
 
1796
1570
 
1797
1571
 
1798
1572
# install the default hooks into the Branch class.
1837
1611
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1838
1612
 
1839
1613
 
1840
 
class BranchInitHookParams(object):
1841
 
    """Object holding parameters passed to *_branch_init hooks.
1842
 
 
1843
 
    There are 4 fields that hooks may wish to access:
1844
 
 
1845
 
    :ivar format: the branch format
1846
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
 
    :ivar name: name of colocated branch, if any (or None)
1848
 
    :ivar branch: the branch created
1849
 
 
1850
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
 
    the checkout, hence they are different from the corresponding fields in
1852
 
    branch, which refer to the original branch.
1853
 
    """
1854
 
 
1855
 
    def __init__(self, format, a_bzrdir, name, branch):
1856
 
        """Create a group of BranchInitHook parameters.
1857
 
 
1858
 
        :param format: the branch format
1859
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1860
 
            initialized
1861
 
        :param name: name of colocated branch, if any (or None)
1862
 
        :param branch: the branch created
1863
 
 
1864
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1865
 
        to the checkout, hence they are different from the corresponding fields
1866
 
        in branch, which refer to the original branch.
1867
 
        """
1868
 
        self.format = format
1869
 
        self.bzrdir = a_bzrdir
1870
 
        self.name = name
1871
 
        self.branch = branch
1872
 
 
1873
 
    def __eq__(self, other):
1874
 
        return self.__dict__ == other.__dict__
1875
 
 
1876
 
    def __repr__(self):
1877
 
        if self.branch:
1878
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1879
 
        else:
1880
 
            return "<%s of format:%s bzrdir:%s>" % (
1881
 
                self.__class__.__name__, self.branch,
1882
 
                self.format, self.bzrdir)
1883
 
 
1884
 
 
1885
 
class SwitchHookParams(object):
1886
 
    """Object holding parameters passed to *_switch hooks.
1887
 
 
1888
 
    There are 4 fields that hooks may wish to access:
1889
 
 
1890
 
    :ivar control_dir: BzrDir of the checkout to change
1891
 
    :ivar to_branch: branch that the checkout is to reference
1892
 
    :ivar force: skip the check for local commits in a heavy checkout
1893
 
    :ivar revision_id: revision ID to switch to (or None)
1894
 
    """
1895
 
 
1896
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1897
 
        """Create a group of SwitchHook parameters.
1898
 
 
1899
 
        :param control_dir: BzrDir of the checkout to change
1900
 
        :param to_branch: branch that the checkout is to reference
1901
 
        :param force: skip the check for local commits in a heavy checkout
1902
 
        :param revision_id: revision ID to switch to (or None)
1903
 
        """
1904
 
        self.control_dir = control_dir
1905
 
        self.to_branch = to_branch
1906
 
        self.force = force
1907
 
        self.revision_id = revision_id
1908
 
 
1909
 
    def __eq__(self, other):
1910
 
        return self.__dict__ == other.__dict__
1911
 
 
1912
 
    def __repr__(self):
1913
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
 
            self.control_dir, self.to_branch,
1915
 
            self.revision_id)
1916
 
 
1917
 
 
1918
1614
class BzrBranchFormat4(BranchFormat):
1919
1615
    """Bzr branch format 4.
1920
1616
 
1927
1623
        """See BranchFormat.get_format_description()."""
1928
1624
        return "Branch format 4"
1929
1625
 
1930
 
    def initialize(self, a_bzrdir, name=None):
 
1626
    def initialize(self, a_bzrdir):
1931
1627
        """Create a branch of this format in a_bzrdir."""
1932
1628
        utf8_files = [('revision-history', ''),
1933
1629
                      ('branch-name', ''),
1934
1630
                      ]
1935
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1631
        return self._initialize_helper(a_bzrdir, utf8_files,
1936
1632
                                       lock_type='branch4', set_format=False)
1937
1633
 
1938
1634
    def __init__(self):
1943
1639
        """The network name for this format is the control dirs disk label."""
1944
1640
        return self._matchingbzrdir.get_format_string()
1945
1641
 
1946
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1642
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1947
1643
        """See BranchFormat.open()."""
1948
1644
        if not _found:
1949
1645
            # we are being called directly and must probe.
1951
1647
        return BzrBranch(_format=self,
1952
1648
                         _control_files=a_bzrdir._control_files,
1953
1649
                         a_bzrdir=a_bzrdir,
1954
 
                         name=name,
1955
1650
                         _repository=a_bzrdir.open_repository())
1956
1651
 
1957
1652
    def __str__(self):
1972
1667
        """
1973
1668
        return self.get_format_string()
1974
1669
 
1975
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1670
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1976
1671
        """See BranchFormat.open()."""
1977
1672
        if not _found:
1978
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1673
            format = BranchFormat.find_format(a_bzrdir)
1979
1674
            if format.__class__ != self.__class__:
1980
1675
                raise AssertionError("wrong format %r found for %r" %
1981
1676
                    (format, self))
1982
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1983
1677
        try:
 
1678
            transport = a_bzrdir.get_branch_transport(None)
1984
1679
            control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1680
                                                         lockdir.LockDir)
1986
1681
            return self._branch_class()(_format=self,
1987
1682
                              _control_files=control_files,
1988
 
                              name=name,
1989
1683
                              a_bzrdir=a_bzrdir,
1990
1684
                              _repository=a_bzrdir.find_repository(),
1991
1685
                              ignore_fallbacks=ignore_fallbacks)
1992
1686
        except errors.NoSuchFile:
1993
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1687
            raise errors.NotBranchError(path=transport.base)
1994
1688
 
1995
1689
    def __init__(self):
1996
1690
        super(BranchFormatMetadir, self).__init__()
2025
1719
        """See BranchFormat.get_format_description()."""
2026
1720
        return "Branch format 5"
2027
1721
 
2028
 
    def initialize(self, a_bzrdir, name=None):
 
1722
    def initialize(self, a_bzrdir):
2029
1723
        """Create a branch of this format in a_bzrdir."""
2030
1724
        utf8_files = [('revision-history', ''),
2031
1725
                      ('branch-name', ''),
2032
1726
                      ]
2033
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1727
        return self._initialize_helper(a_bzrdir, utf8_files)
2034
1728
 
2035
1729
    def supports_tags(self):
2036
1730
        return False
2058
1752
        """See BranchFormat.get_format_description()."""
2059
1753
        return "Branch format 6"
2060
1754
 
2061
 
    def initialize(self, a_bzrdir, name=None):
 
1755
    def initialize(self, a_bzrdir):
2062
1756
        """Create a branch of this format in a_bzrdir."""
2063
1757
        utf8_files = [('last-revision', '0 null:\n'),
2064
1758
                      ('branch.conf', ''),
2065
1759
                      ('tags', ''),
2066
1760
                      ]
2067
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1761
        return self._initialize_helper(a_bzrdir, utf8_files)
2068
1762
 
2069
1763
    def make_tags(self, branch):
2070
1764
        """See bzrlib.branch.BranchFormat.make_tags()."""
2071
1765
        return BasicTags(branch)
2072
1766
 
2073
 
    def supports_set_append_revisions_only(self):
2074
 
        return True
2075
1767
 
2076
1768
 
2077
1769
class BzrBranchFormat8(BranchFormatMetadir):
2088
1780
        """See BranchFormat.get_format_description()."""
2089
1781
        return "Branch format 8"
2090
1782
 
2091
 
    def initialize(self, a_bzrdir, name=None):
 
1783
    def initialize(self, a_bzrdir):
2092
1784
        """Create a branch of this format in a_bzrdir."""
2093
1785
        utf8_files = [('last-revision', '0 null:\n'),
2094
1786
                      ('branch.conf', ''),
2095
1787
                      ('tags', ''),
2096
1788
                      ('references', '')
2097
1789
                      ]
2098
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1790
        return self._initialize_helper(a_bzrdir, utf8_files)
2099
1791
 
2100
1792
    def __init__(self):
2101
1793
        super(BzrBranchFormat8, self).__init__()
2106
1798
        """See bzrlib.branch.BranchFormat.make_tags()."""
2107
1799
        return BasicTags(branch)
2108
1800
 
2109
 
    def supports_set_append_revisions_only(self):
2110
 
        return True
2111
 
 
2112
1801
    def supports_stacking(self):
2113
1802
        return True
2114
1803
 
2124
1813
    This format was introduced in bzr 1.6.
2125
1814
    """
2126
1815
 
2127
 
    def initialize(self, a_bzrdir, name=None):
 
1816
    def initialize(self, a_bzrdir):
2128
1817
        """Create a branch of this format in a_bzrdir."""
2129
1818
        utf8_files = [('last-revision', '0 null:\n'),
2130
1819
                      ('branch.conf', ''),
2131
1820
                      ('tags', ''),
2132
1821
                      ]
2133
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1822
        return self._initialize_helper(a_bzrdir, utf8_files)
2134
1823
 
2135
1824
    def _branch_class(self):
2136
1825
        return BzrBranch7
2143
1832
        """See BranchFormat.get_format_description()."""
2144
1833
        return "Branch format 7"
2145
1834
 
2146
 
    def supports_set_append_revisions_only(self):
2147
 
        return True
2148
 
 
2149
1835
    supports_reference_locations = False
2150
1836
 
2151
1837
 
2171
1857
    def get_reference(self, a_bzrdir):
2172
1858
        """See BranchFormat.get_reference()."""
2173
1859
        transport = a_bzrdir.get_branch_transport(None)
2174
 
        return transport.get_bytes('location')
 
1860
        return transport.get('location').read()
2175
1861
 
2176
1862
    def set_reference(self, a_bzrdir, to_branch):
2177
1863
        """See BranchFormat.set_reference()."""
2178
1864
        transport = a_bzrdir.get_branch_transport(None)
2179
1865
        location = transport.put_bytes('location', to_branch.base)
2180
1866
 
2181
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1867
    def initialize(self, a_bzrdir, target_branch=None):
2182
1868
        """Create a branch of this format in a_bzrdir."""
2183
1869
        if target_branch is None:
2184
1870
            # this format does not implement branch itself, thus the implicit
2185
1871
            # creation contract must see it as uninitializable
2186
1872
            raise errors.UninitializableFormat(self)
2187
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2188
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1873
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1874
        branch_transport = a_bzrdir.get_branch_transport(self)
2189
1875
        branch_transport.put_bytes('location',
2190
 
            target_branch.bzrdir.user_url)
 
1876
            target_branch.bzrdir.root_transport.base)
2191
1877
        branch_transport.put_bytes('format', self.get_format_string())
2192
 
        branch = self.open(
2193
 
            a_bzrdir, name, _found=True,
 
1878
        return self.open(
 
1879
            a_bzrdir, _found=True,
2194
1880
            possible_transports=[target_branch.bzrdir.root_transport])
2195
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2196
 
        return branch
2197
1881
 
2198
1882
    def __init__(self):
2199
1883
        super(BranchReferenceFormat, self).__init__()
2205
1889
        def clone(to_bzrdir, revision_id=None,
2206
1890
            repository_policy=None):
2207
1891
            """See Branch.clone()."""
2208
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1892
            return format.initialize(to_bzrdir, a_branch)
2209
1893
            # cannot obey revision_id limits when cloning a reference ...
2210
1894
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2211
1895
            # emit some sort of warning/error to the caller ?!
2212
1896
        return clone
2213
1897
 
2214
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1898
    def open(self, a_bzrdir, _found=False, location=None,
2215
1899
             possible_transports=None, ignore_fallbacks=False):
2216
1900
        """Return the branch that the branch reference in a_bzrdir points at.
2217
1901
 
2218
1902
        :param a_bzrdir: A BzrDir that contains a branch.
2219
 
        :param name: Name of colocated branch to open, if any
2220
1903
        :param _found: a private parameter, do not use it. It is used to
2221
1904
            indicate if format probing has already be done.
2222
1905
        :param ignore_fallbacks: when set, no fallback branches will be opened
2227
1910
        :param possible_transports: An optional reusable transports list.
2228
1911
        """
2229
1912
        if not _found:
2230
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1913
            format = BranchFormat.find_format(a_bzrdir)
2231
1914
            if format.__class__ != self.__class__:
2232
1915
                raise AssertionError("wrong format %r found for %r" %
2233
1916
                    (format, self))
2235
1918
            location = self.get_reference(a_bzrdir)
2236
1919
        real_bzrdir = bzrdir.BzrDir.open(
2237
1920
            location, possible_transports=possible_transports)
2238
 
        result = real_bzrdir.open_branch(name=name, 
2239
 
            ignore_fallbacks=ignore_fallbacks)
 
1921
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2240
1922
        # this changes the behaviour of result.clone to create a new reference
2241
1923
        # rather than a copy of the content of the branch.
2242
1924
        # I did not use a proxy object because that needs much more extensive
2269
1951
BranchFormat.register_format(__format6)
2270
1952
BranchFormat.register_format(__format7)
2271
1953
BranchFormat.register_format(__format8)
2272
 
BranchFormat.set_default_format(__format7)
 
1954
BranchFormat.set_default_format(__format6)
2273
1955
_legacy_formats = [BzrBranchFormat4(),
2274
1956
    ]
2275
1957
network_format_registry.register(
2276
1958
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2277
1959
 
2278
1960
 
2279
 
class BranchWriteLockResult(object):
2280
 
    """The result of write locking a branch.
2281
 
 
2282
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2283
 
        None.
2284
 
    :ivar unlock: A callable which will unlock the lock.
2285
 
    """
2286
 
 
2287
 
    def __init__(self, unlock, branch_token):
2288
 
        self.branch_token = branch_token
2289
 
        self.unlock = unlock
2290
 
 
2291
 
 
2292
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1961
class BzrBranch(Branch):
2293
1962
    """A branch stored in the actual filesystem.
2294
1963
 
2295
1964
    Note that it's "local" in the context of the filesystem; it doesn't
2301
1970
    :ivar repository: Repository for this branch.
2302
1971
    :ivar base: The url of the base directory for this branch; the one
2303
1972
        containing the .bzr directory.
2304
 
    :ivar name: Optional colocated branch name as it exists in the control
2305
 
        directory.
2306
1973
    """
2307
1974
 
2308
1975
    def __init__(self, _format=None,
2309
 
                 _control_files=None, a_bzrdir=None, name=None,
2310
 
                 _repository=None, ignore_fallbacks=False):
 
1976
                 _control_files=None, a_bzrdir=None, _repository=None,
 
1977
                 ignore_fallbacks=False):
2311
1978
        """Create new branch object at a particular location."""
2312
1979
        if a_bzrdir is None:
2313
1980
            raise ValueError('a_bzrdir must be supplied')
2314
1981
        else:
2315
1982
            self.bzrdir = a_bzrdir
2316
1983
        self._base = self.bzrdir.transport.clone('..').base
2317
 
        self.name = name
2318
1984
        # XXX: We should be able to just do
2319
1985
        #   self.base = self.bzrdir.root_transport.base
2320
1986
        # but this does not quite work yet -- mbp 20080522
2327
1993
        Branch.__init__(self)
2328
1994
 
2329
1995
    def __str__(self):
2330
 
        if self.name is None:
2331
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2332
 
        else:
2333
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2334
 
                self.name)
 
1996
        return '%s(%r)' % (self.__class__.__name__, self.base)
2335
1997
 
2336
1998
    __repr__ = __str__
2337
1999
 
2348
2010
        return self.control_files.is_locked()
2349
2011
 
2350
2012
    def lock_write(self, token=None):
2351
 
        """Lock the branch for write operations.
2352
 
 
2353
 
        :param token: A token to permit reacquiring a previously held and
2354
 
            preserved lock.
2355
 
        :return: A BranchWriteLockResult.
2356
 
        """
2357
 
        if not self.is_locked():
2358
 
            self._note_lock('w')
2359
2013
        # All-in-one needs to always unlock/lock.
2360
2014
        repo_control = getattr(self.repository, 'control_files', None)
2361
2015
        if self.control_files == repo_control or not self.is_locked():
2362
 
            self.repository._warn_if_deprecated(self)
2363
2016
            self.repository.lock_write()
2364
2017
            took_lock = True
2365
2018
        else:
2366
2019
            took_lock = False
2367
2020
        try:
2368
 
            return BranchWriteLockResult(self.unlock,
2369
 
                self.control_files.lock_write(token=token))
 
2021
            return self.control_files.lock_write(token=token)
2370
2022
        except:
2371
2023
            if took_lock:
2372
2024
                self.repository.unlock()
2373
2025
            raise
2374
2026
 
2375
2027
    def lock_read(self):
2376
 
        """Lock the branch for read operations.
2377
 
 
2378
 
        :return: An object with an unlock method which will release the lock
2379
 
            obtained.
2380
 
        """
2381
 
        if not self.is_locked():
2382
 
            self._note_lock('r')
2383
2028
        # All-in-one needs to always unlock/lock.
2384
2029
        repo_control = getattr(self.repository, 'control_files', None)
2385
2030
        if self.control_files == repo_control or not self.is_locked():
2386
 
            self.repository._warn_if_deprecated(self)
2387
2031
            self.repository.lock_read()
2388
2032
            took_lock = True
2389
2033
        else:
2390
2034
            took_lock = False
2391
2035
        try:
2392
2036
            self.control_files.lock_read()
2393
 
            return self
2394
2037
        except:
2395
2038
            if took_lock:
2396
2039
                self.repository.unlock()
2397
2040
            raise
2398
2041
 
2399
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2400
2042
    def unlock(self):
2401
2043
        try:
2402
2044
            self.control_files.unlock()
2533
2175
        """See Branch.basis_tree."""
2534
2176
        return self.repository.revision_tree(self.last_revision())
2535
2177
 
 
2178
    @needs_write_lock
 
2179
    def pull(self, source, overwrite=False, stop_revision=None,
 
2180
             _hook_master=None, run_hooks=True, possible_transports=None,
 
2181
             _override_hook_target=None):
 
2182
        """See Branch.pull.
 
2183
 
 
2184
        :param _hook_master: Private parameter - set the branch to
 
2185
            be supplied as the master to pull hooks.
 
2186
        :param run_hooks: Private parameter - if false, this branch
 
2187
            is being called because it's the master of the primary branch,
 
2188
            so it should not run its hooks.
 
2189
        :param _override_hook_target: Private parameter - set the branch to be
 
2190
            supplied as the target_branch to pull hooks.
 
2191
        """
 
2192
        result = PullResult()
 
2193
        result.source_branch = source
 
2194
        if _override_hook_target is None:
 
2195
            result.target_branch = self
 
2196
        else:
 
2197
            result.target_branch = _override_hook_target
 
2198
        source.lock_read()
 
2199
        try:
 
2200
            # We assume that during 'pull' the local repository is closer than
 
2201
            # the remote one.
 
2202
            source.update_references(self)
 
2203
            graph = self.repository.get_graph(source.repository)
 
2204
            result.old_revno, result.old_revid = self.last_revision_info()
 
2205
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
2206
                                  graph=graph)
 
2207
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
2208
            result.new_revno, result.new_revid = self.last_revision_info()
 
2209
            if _hook_master:
 
2210
                result.master_branch = _hook_master
 
2211
                result.local_branch = result.target_branch
 
2212
            else:
 
2213
                result.master_branch = result.target_branch
 
2214
                result.local_branch = None
 
2215
            if run_hooks:
 
2216
                for hook in Branch.hooks['post_pull']:
 
2217
                    hook(result)
 
2218
        finally:
 
2219
            source.unlock()
 
2220
        return result
 
2221
 
2536
2222
    def _get_parent_location(self):
2537
2223
        _locs = ['parent', 'pull', 'x-pull']
2538
2224
        for l in _locs:
2542
2228
                pass
2543
2229
        return None
2544
2230
 
 
2231
    @needs_read_lock
 
2232
    def push(self, target, overwrite=False, stop_revision=None,
 
2233
             _override_hook_source_branch=None):
 
2234
        """See Branch.push.
 
2235
 
 
2236
        This is the basic concrete implementation of push()
 
2237
 
 
2238
        :param _override_hook_source_branch: If specified, run
 
2239
        the hooks passing this Branch as the source, rather than self.
 
2240
        This is for use of RemoteBranch, where push is delegated to the
 
2241
        underlying vfs-based Branch.
 
2242
        """
 
2243
        # TODO: Public option to disable running hooks - should be trivial but
 
2244
        # needs tests.
 
2245
        return _run_with_write_locked_target(
 
2246
            target, self._push_with_bound_branches, target, overwrite,
 
2247
            stop_revision,
 
2248
            _override_hook_source_branch=_override_hook_source_branch)
 
2249
 
 
2250
    def _push_with_bound_branches(self, target, overwrite,
 
2251
            stop_revision,
 
2252
            _override_hook_source_branch=None):
 
2253
        """Push from self into target, and into target's master if any.
 
2254
 
 
2255
        This is on the base BzrBranch class even though it doesn't support
 
2256
        bound branches because the *target* might be bound.
 
2257
        """
 
2258
        def _run_hooks():
 
2259
            if _override_hook_source_branch:
 
2260
                result.source_branch = _override_hook_source_branch
 
2261
            for hook in Branch.hooks['post_push']:
 
2262
                hook(result)
 
2263
 
 
2264
        bound_location = target.get_bound_location()
 
2265
        if bound_location and target.base != bound_location:
 
2266
            # there is a master branch.
 
2267
            #
 
2268
            # XXX: Why the second check?  Is it even supported for a branch to
 
2269
            # be bound to itself? -- mbp 20070507
 
2270
            master_branch = target.get_master_branch()
 
2271
            master_branch.lock_write()
 
2272
            try:
 
2273
                # push into the master from this branch.
 
2274
                self._basic_push(master_branch, overwrite, stop_revision)
 
2275
                # and push into the target branch from this. Note that we push from
 
2276
                # this branch again, because its considered the highest bandwidth
 
2277
                # repository.
 
2278
                result = self._basic_push(target, overwrite, stop_revision)
 
2279
                result.master_branch = master_branch
 
2280
                result.local_branch = target
 
2281
                _run_hooks()
 
2282
                return result
 
2283
            finally:
 
2284
                master_branch.unlock()
 
2285
        else:
 
2286
            # no master branch
 
2287
            result = self._basic_push(target, overwrite, stop_revision)
 
2288
            # TODO: Why set master_branch and local_branch if there's no
 
2289
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
2290
            # 20070504
 
2291
            result.master_branch = target
 
2292
            result.local_branch = None
 
2293
            _run_hooks()
 
2294
            return result
 
2295
 
2545
2296
    def _basic_push(self, target, overwrite, stop_revision):
2546
2297
        """Basic implementation of push without bound branches or hooks.
2547
2298
 
2548
 
        Must be called with source read locked and target write locked.
 
2299
        Must be called with self read locked and target write locked.
2549
2300
        """
2550
2301
        result = BranchPushResult()
2551
2302
        result.source_branch = self
2556
2307
            # We assume that during 'push' this repository is closer than
2557
2308
            # the target.
2558
2309
            graph = self.repository.get_graph(target.repository)
2559
 
            target.update_revisions(self, stop_revision,
2560
 
                overwrite=overwrite, graph=graph)
 
2310
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
2311
                                    graph=graph)
2561
2312
        if self._push_should_merge_tags():
2562
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2563
 
                overwrite)
 
2313
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2564
2314
        result.new_revno, result.new_revid = target.last_revision_info()
2565
2315
        return result
2566
2316
 
2567
2317
    def get_stacked_on_url(self):
2568
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2318
        raise errors.UnstackableBranchFormat(self._format, self.base)
2569
2319
 
2570
2320
    def set_push_location(self, location):
2571
2321
        """See Branch.set_push_location."""
2587
2337
    It has support for a master_branch which is the data for bound branches.
2588
2338
    """
2589
2339
 
 
2340
    @needs_write_lock
 
2341
    def pull(self, source, overwrite=False, stop_revision=None,
 
2342
             run_hooks=True, possible_transports=None,
 
2343
             _override_hook_target=None):
 
2344
        """Pull from source into self, updating my master if any.
 
2345
 
 
2346
        :param run_hooks: Private parameter - if false, this branch
 
2347
            is being called because it's the master of the primary branch,
 
2348
            so it should not run its hooks.
 
2349
        """
 
2350
        bound_location = self.get_bound_location()
 
2351
        master_branch = None
 
2352
        if bound_location and source.base != bound_location:
 
2353
            # not pulling from master, so we need to update master.
 
2354
            master_branch = self.get_master_branch(possible_transports)
 
2355
            master_branch.lock_write()
 
2356
        try:
 
2357
            if master_branch:
 
2358
                # pull from source into master.
 
2359
                master_branch.pull(source, overwrite, stop_revision,
 
2360
                    run_hooks=False)
 
2361
            return super(BzrBranch5, self).pull(source, overwrite,
 
2362
                stop_revision, _hook_master=master_branch,
 
2363
                run_hooks=run_hooks,
 
2364
                _override_hook_target=_override_hook_target)
 
2365
        finally:
 
2366
            if master_branch:
 
2367
                master_branch.unlock()
 
2368
 
2590
2369
    def get_bound_location(self):
2591
2370
        try:
2592
2371
            return self._transport.get_bytes('bound')[:-1]
2698
2477
                    raise AssertionError(
2699
2478
                        "'transform_fallback_location' hook %s returned "
2700
2479
                        "None, not a URL." % hook_name)
2701
 
            self._activate_fallback_location(url)
 
2480
            self._activate_fallback_location(url, None)
2702
2481
 
2703
2482
    def __init__(self, *args, **kwargs):
2704
2483
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2705
2484
        super(BzrBranch8, self).__init__(*args, **kwargs)
2706
2485
        self._last_revision_info_cache = None
 
2486
        self._partial_revision_history_cache = []
2707
2487
        self._reference_info = None
2708
2488
 
2709
2489
    def _clear_cached_state(self):
2710
2490
        super(BzrBranch8, self)._clear_cached_state()
2711
2491
        self._last_revision_info_cache = None
 
2492
        self._partial_revision_history_cache = []
2712
2493
        self._reference_info = None
2713
2494
 
2714
2495
    def _last_revision_info(self):
2761
2542
        if _mod_revision.is_null(last_revision):
2762
2543
            return
2763
2544
        if last_revision not in self._lefthand_history(revision_id):
2764
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2545
            raise errors.AppendRevisionsOnlyViolation(self.base)
2765
2546
 
2766
2547
    def _gen_revision_history(self):
2767
2548
        """Generate the revision history from last revision
2770
2551
        self._extend_partial_history(stop_index=last_revno-1)
2771
2552
        return list(reversed(self._partial_revision_history_cache))
2772
2553
 
 
2554
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2555
        """Extend the partial history to include a given index
 
2556
 
 
2557
        If a stop_index is supplied, stop when that index has been reached.
 
2558
        If a stop_revision is supplied, stop when that revision is
 
2559
        encountered.  Otherwise, stop when the beginning of history is
 
2560
        reached.
 
2561
 
 
2562
        :param stop_index: The index which should be present.  When it is
 
2563
            present, history extension will stop.
 
2564
        :param revision_id: The revision id which should be present.  When
 
2565
            it is encountered, history extension will stop.
 
2566
        """
 
2567
        repo = self.repository
 
2568
        if len(self._partial_revision_history_cache) == 0:
 
2569
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2570
        else:
 
2571
            start_revision = self._partial_revision_history_cache[-1]
 
2572
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2573
            #skip the last revision in the list
 
2574
            next_revision = iterator.next()
 
2575
        for revision_id in iterator:
 
2576
            self._partial_revision_history_cache.append(revision_id)
 
2577
            if (stop_index is not None and
 
2578
                len(self._partial_revision_history_cache) > stop_index):
 
2579
                break
 
2580
            if revision_id == stop_revision:
 
2581
                break
 
2582
 
2773
2583
    def _write_revision_history(self, history):
2774
2584
        """Factored out of set_revision_history.
2775
2585
 
2867
2677
        if branch_location is None:
2868
2678
            return Branch.reference_parent(self, file_id, path,
2869
2679
                                           possible_transports)
2870
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2680
        branch_location = urlutils.join(self.base, branch_location)
2871
2681
        return Branch.open(branch_location,
2872
2682
                           possible_transports=possible_transports)
2873
2683
 
2918
2728
            raise errors.NotStacked(self)
2919
2729
        return stacked_url
2920
2730
 
 
2731
    def set_append_revisions_only(self, enabled):
 
2732
        if enabled:
 
2733
            value = 'True'
 
2734
        else:
 
2735
            value = 'False'
 
2736
        self.get_config().set_user_option('append_revisions_only', value,
 
2737
            warn_masked=True)
 
2738
 
2921
2739
    def _get_append_revisions_only(self):
2922
 
        return self.get_config(
2923
 
            ).get_user_option_as_bool('append_revisions_only')
 
2740
        value = self.get_config().get_user_option('append_revisions_only')
 
2741
        return value == 'True'
2924
2742
 
2925
2743
    @needs_write_lock
2926
2744
    def generate_revision_history(self, revision_id, last_rev=None,
2988
2806
    """
2989
2807
 
2990
2808
    def get_stacked_on_url(self):
2991
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2809
        raise errors.UnstackableBranchFormat(self._format, self.base)
2992
2810
 
2993
2811
 
2994
2812
######################################################################
3073
2891
 
3074
2892
    def __init__(self, branch):
3075
2893
        self.branch = branch
3076
 
        self.errors = []
3077
2894
 
3078
2895
    def report_results(self, verbose):
3079
2896
        """Report the check results via trace.note.
3081
2898
        :param verbose: Requests more detailed display of what was checked,
3082
2899
            if any.
3083
2900
        """
3084
 
        note('checked branch %s format %s', self.branch.user_url,
3085
 
            self.branch._format)
3086
 
        for error in self.errors:
3087
 
            note('found error:%s', error)
 
2901
        note('checked branch %s format %s',
 
2902
             self.branch.base,
 
2903
             self.branch._format)
3088
2904
 
3089
2905
 
3090
2906
class Converter5to6(object):
3185
3001
    @staticmethod
3186
3002
    def _get_branch_formats_to_test():
3187
3003
        """Return a tuple with the Branch formats to use when testing."""
3188
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3189
 
 
3190
 
    def pull(self, overwrite=False, stop_revision=None,
3191
 
             possible_transports=None, local=False):
3192
 
        """Mirror source into target branch.
3193
 
 
3194
 
        The target branch is considered to be 'local', having low latency.
3195
 
 
3196
 
        :returns: PullResult instance
3197
 
        """
3198
 
        raise NotImplementedError(self.pull)
 
3004
        raise NotImplementedError(self._get_branch_formats_to_test)
3199
3005
 
3200
3006
    def update_revisions(self, stop_revision=None, overwrite=False,
3201
3007
                         graph=None):
3210
3016
        """
3211
3017
        raise NotImplementedError(self.update_revisions)
3212
3018
 
3213
 
    def push(self, overwrite=False, stop_revision=None,
3214
 
             _override_hook_source_branch=None):
3215
 
        """Mirror the source branch into the target branch.
3216
 
 
3217
 
        The source branch is considered to be 'local', having low latency.
3218
 
        """
3219
 
        raise NotImplementedError(self.push)
3220
 
 
3221
3019
 
3222
3020
class GenericInterBranch(InterBranch):
3223
3021
    """InterBranch implementation that uses public Branch functions.
3270
3068
        finally:
3271
3069
            self.source.unlock()
3272
3070
 
3273
 
    def pull(self, overwrite=False, stop_revision=None,
3274
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3275
 
             _override_hook_target=None, local=False):
3276
 
        """See Branch.pull.
3277
 
 
3278
 
        :param _hook_master: Private parameter - set the branch to
3279
 
            be supplied as the master to pull hooks.
3280
 
        :param run_hooks: Private parameter - if false, this branch
3281
 
            is being called because it's the master of the primary branch,
3282
 
            so it should not run its hooks.
3283
 
        :param _override_hook_target: Private parameter - set the branch to be
3284
 
            supplied as the target_branch to pull hooks.
3285
 
        :param local: Only update the local branch, and not the bound branch.
3286
 
        """
3287
 
        # This type of branch can't be bound.
3288
 
        if local:
3289
 
            raise errors.LocalRequiresBoundBranch()
3290
 
        result = PullResult()
3291
 
        result.source_branch = self.source
3292
 
        if _override_hook_target is None:
3293
 
            result.target_branch = self.target
3294
 
        else:
3295
 
            result.target_branch = _override_hook_target
3296
 
        self.source.lock_read()
3297
 
        try:
3298
 
            # We assume that during 'pull' the target repository is closer than
3299
 
            # the source one.
3300
 
            self.source.update_references(self.target)
3301
 
            graph = self.target.repository.get_graph(self.source.repository)
3302
 
            # TODO: Branch formats should have a flag that indicates 
3303
 
            # that revno's are expensive, and pull() should honor that flag.
3304
 
            # -- JRV20090506
3305
 
            result.old_revno, result.old_revid = \
3306
 
                self.target.last_revision_info()
3307
 
            self.target.update_revisions(self.source, stop_revision,
3308
 
                overwrite=overwrite, graph=graph)
3309
 
            # TODO: The old revid should be specified when merging tags, 
3310
 
            # so a tags implementation that versions tags can only 
3311
 
            # pull in the most recent changes. -- JRV20090506
3312
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3313
 
                overwrite)
3314
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3315
 
            if _hook_master:
3316
 
                result.master_branch = _hook_master
3317
 
                result.local_branch = result.target_branch
3318
 
            else:
3319
 
                result.master_branch = result.target_branch
3320
 
                result.local_branch = None
3321
 
            if run_hooks:
3322
 
                for hook in Branch.hooks['post_pull']:
3323
 
                    hook(result)
3324
 
        finally:
3325
 
            self.source.unlock()
3326
 
        return result
3327
 
 
3328
 
    def push(self, overwrite=False, stop_revision=None,
3329
 
             _override_hook_source_branch=None):
3330
 
        """See InterBranch.push.
3331
 
 
3332
 
        This is the basic concrete implementation of push()
3333
 
 
3334
 
        :param _override_hook_source_branch: If specified, run
3335
 
        the hooks passing this Branch as the source, rather than self.
3336
 
        This is for use of RemoteBranch, where push is delegated to the
3337
 
        underlying vfs-based Branch.
3338
 
        """
3339
 
        # TODO: Public option to disable running hooks - should be trivial but
3340
 
        # needs tests.
3341
 
        self.source.lock_read()
3342
 
        try:
3343
 
            return _run_with_write_locked_target(
3344
 
                self.target, self._push_with_bound_branches, overwrite,
3345
 
                stop_revision,
3346
 
                _override_hook_source_branch=_override_hook_source_branch)
3347
 
        finally:
3348
 
            self.source.unlock()
3349
 
 
3350
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3351
 
            _override_hook_source_branch=None):
3352
 
        """Push from source into target, and into target's master if any.
3353
 
        """
3354
 
        def _run_hooks():
3355
 
            if _override_hook_source_branch:
3356
 
                result.source_branch = _override_hook_source_branch
3357
 
            for hook in Branch.hooks['post_push']:
3358
 
                hook(result)
3359
 
 
3360
 
        bound_location = self.target.get_bound_location()
3361
 
        if bound_location and self.target.base != bound_location:
3362
 
            # there is a master branch.
3363
 
            #
3364
 
            # XXX: Why the second check?  Is it even supported for a branch to
3365
 
            # be bound to itself? -- mbp 20070507
3366
 
            master_branch = self.target.get_master_branch()
3367
 
            master_branch.lock_write()
3368
 
            try:
3369
 
                # push into the master from the source branch.
3370
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3371
 
                # and push into the target branch from the source. Note that we
3372
 
                # push from the source branch again, because its considered the
3373
 
                # highest bandwidth repository.
3374
 
                result = self.source._basic_push(self.target, overwrite,
3375
 
                    stop_revision)
3376
 
                result.master_branch = master_branch
3377
 
                result.local_branch = self.target
3378
 
                _run_hooks()
3379
 
                return result
3380
 
            finally:
3381
 
                master_branch.unlock()
3382
 
        else:
3383
 
            # no master branch
3384
 
            result = self.source._basic_push(self.target, overwrite,
3385
 
                stop_revision)
3386
 
            # TODO: Why set master_branch and local_branch if there's no
3387
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3388
 
            # 20070504
3389
 
            result.master_branch = self.target
3390
 
            result.local_branch = None
3391
 
            _run_hooks()
3392
 
            return result
3393
 
 
3394
3071
    @classmethod
3395
3072
    def is_compatible(self, source, target):
3396
3073
        # GenericBranch uses the public API, so always compatible
3397
3074
        return True
3398
3075
 
3399
3076
 
3400
 
class InterToBranch5(GenericInterBranch):
3401
 
 
3402
 
    @staticmethod
3403
 
    def _get_branch_formats_to_test():
3404
 
        return BranchFormat._default_format, BzrBranchFormat5()
3405
 
 
3406
 
    def pull(self, overwrite=False, stop_revision=None,
3407
 
             possible_transports=None, run_hooks=True,
3408
 
             _override_hook_target=None, local=False):
3409
 
        """Pull from source into self, updating my master if any.
3410
 
 
3411
 
        :param run_hooks: Private parameter - if false, this branch
3412
 
            is being called because it's the master of the primary branch,
3413
 
            so it should not run its hooks.
3414
 
        """
3415
 
        bound_location = self.target.get_bound_location()
3416
 
        if local and not bound_location:
3417
 
            raise errors.LocalRequiresBoundBranch()
3418
 
        master_branch = None
3419
 
        if not local and bound_location and self.source.user_url != bound_location:
3420
 
            # not pulling from master, so we need to update master.
3421
 
            master_branch = self.target.get_master_branch(possible_transports)
3422
 
            master_branch.lock_write()
3423
 
        try:
3424
 
            if master_branch:
3425
 
                # pull from source into master.
3426
 
                master_branch.pull(self.source, overwrite, stop_revision,
3427
 
                    run_hooks=False)
3428
 
            return super(InterToBranch5, self).pull(overwrite,
3429
 
                stop_revision, _hook_master=master_branch,
3430
 
                run_hooks=run_hooks,
3431
 
                _override_hook_target=_override_hook_target)
3432
 
        finally:
3433
 
            if master_branch:
3434
 
                master_branch.unlock()
3435
 
 
3436
 
 
3437
3077
InterBranch.register_optimiser(GenericInterBranch)
3438
 
InterBranch.register_optimiser(InterToBranch5)