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