~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Andrew Bennetts
  • Date: 2009-07-27 05:35:00 UTC
  • mfrom: (4570 +trunk)
  • mto: (4634.6.29 2.0)
  • mto: This revision was merged to the branch mainline in revision 4680.
  • Revision ID: andrew.bennetts@canonical.com-20090727053500-q76zsn2dx33jhmj5
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
 
 
18
from cStringIO import StringIO
18
19
import sys
19
20
 
20
21
from bzrlib.lazy_import import lazy_import
30
31
        lockable_files,
31
32
        repository,
32
33
        revision as _mod_revision,
 
34
        rio,
 
35
        symbol_versioning,
33
36
        transport,
34
37
        tsort,
35
38
        ui,
36
39
        urlutils,
37
40
        )
38
 
from bzrlib.config import BranchConfig
 
41
from bzrlib.config import BranchConfig, TransportConfig
39
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
40
43
from bzrlib.tag import (
41
44
    BasicTags,
44
47
""")
45
48
 
46
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
47
 
from bzrlib.hooks import Hooks
 
50
from bzrlib.hooks import HookPoint, Hooks
48
51
from bzrlib.inter import InterObject
49
52
from bzrlib import registry
50
53
from bzrlib.symbol_versioning import (
83
86
    # - RBC 20060112
84
87
    base = None
85
88
 
86
 
    # override this to set the strategy for storing tags
87
 
    def _make_tags(self):
88
 
        return DisabledTags(self)
89
 
 
90
89
    def __init__(self, *ignored, **ignored_too):
91
 
        self.tags = self._make_tags()
 
90
        self.tags = self._format.make_tags(self)
92
91
        self._revision_history_cache = None
93
92
        self._revision_id_to_revno_cache = None
94
93
        self._partial_revision_id_to_revno_cache = {}
 
94
        self._partial_revision_history_cache = []
95
95
        self._last_revision_info_cache = None
96
96
        self._merge_sorted_revisions_cache = None
97
97
        self._open_hook()
102
102
    def _open_hook(self):
103
103
        """Called by init to allow simpler extension of the base class."""
104
104
 
 
105
    def _activate_fallback_location(self, url):
 
106
        """Activate the branch/repository from url as a fallback repository."""
 
107
        repo = self._get_fallback_repository(url)
 
108
        if repo.has_same_location(self.repository):
 
109
            raise errors.UnstackableLocationError(self.base, url)
 
110
        self.repository.add_fallback_repository(repo)
 
111
 
105
112
    def break_lock(self):
106
113
        """Break a lock if one is present from another instance.
107
114
 
116
123
        if master is not None:
117
124
            master.break_lock()
118
125
 
 
126
    def _check_stackable_repo(self):
 
127
        if not self.repository._format.supports_external_lookups:
 
128
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
129
                self.repository.base)
 
130
 
 
131
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
132
        """Extend the partial history to include a given index
 
133
 
 
134
        If a stop_index is supplied, stop when that index has been reached.
 
135
        If a stop_revision is supplied, stop when that revision is
 
136
        encountered.  Otherwise, stop when the beginning of history is
 
137
        reached.
 
138
 
 
139
        :param stop_index: The index which should be present.  When it is
 
140
            present, history extension will stop.
 
141
        :param stop_revision: The revision id which should be present.  When
 
142
            it is encountered, history extension will stop.
 
143
        """
 
144
        if len(self._partial_revision_history_cache) == 0:
 
145
            self._partial_revision_history_cache = [self.last_revision()]
 
146
        repository._iter_for_revno(
 
147
            self.repository, self._partial_revision_history_cache,
 
148
            stop_index=stop_index, stop_revision=stop_revision)
 
149
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
 
150
            self._partial_revision_history_cache.pop()
 
151
 
119
152
    @staticmethod
120
153
    def open(base, _unsupported=False, possible_transports=None):
121
154
        """Open the branch rooted at base.
155
188
        The default implementation returns False if this branch has no tags,
156
189
        and True the rest of the time.  Subclasses may override this.
157
190
        """
158
 
        return self.tags.supports_tags() and self.tags.get_tag_dict()
 
191
        return self.supports_tags() and self.tags.get_tag_dict()
159
192
 
160
193
    def get_config(self):
161
194
        return BranchConfig(self)
162
195
 
 
196
    def _get_config(self):
 
197
        """Get the concrete config for just the config in this branch.
 
198
 
 
199
        This is not intended for client use; see Branch.get_config for the
 
200
        public API.
 
201
 
 
202
        Added in 1.14.
 
203
 
 
204
        :return: An object supporting get_option and set_option.
 
205
        """
 
206
        raise NotImplementedError(self._get_config)
 
207
 
 
208
    def _get_fallback_repository(self, url):
 
209
        """Get the repository we fallback to at url."""
 
210
        url = urlutils.join(self.base, url)
 
211
        a_bzrdir = bzrdir.BzrDir.open(url,
 
212
            possible_transports=[self.bzrdir.root_transport])
 
213
        return a_bzrdir.open_branch().repository
 
214
 
 
215
    def _get_tags_bytes(self):
 
216
        """Get the bytes of a serialised tags dict.
 
217
 
 
218
        Note that not all branches support tags, nor do all use the same tags
 
219
        logic: this method is specific to BasicTags. Other tag implementations
 
220
        may use the same method name and behave differently, safely, because
 
221
        of the double-dispatch via
 
222
        format.make_tags->tags_instance->get_tags_dict.
 
223
 
 
224
        :return: The bytes of the tags file.
 
225
        :seealso: Branch._set_tags_bytes.
 
226
        """
 
227
        return self._transport.get_bytes('tags')
 
228
 
163
229
    def _get_nick(self, local=False, possible_transports=None):
164
230
        config = self.get_config()
165
231
        # explicit overrides master, but don't look for master if local is True
456
522
        """
457
523
        raise errors.UpgradeRequired(self.base)
458
524
 
 
525
    def set_append_revisions_only(self, enabled):
 
526
        if not self._format.supports_set_append_revisions_only():
 
527
            raise errors.UpgradeRequired(self.base)
 
528
        if enabled:
 
529
            value = 'True'
 
530
        else:
 
531
            value = 'False'
 
532
        self.get_config().set_user_option('append_revisions_only', value,
 
533
            warn_masked=True)
 
534
 
 
535
    def set_reference_info(self, file_id, tree_path, branch_location):
 
536
        """Set the branch location to use for a tree reference."""
 
537
        raise errors.UnsupportedOperation(self.set_reference_info, self)
 
538
 
 
539
    def get_reference_info(self, file_id):
 
540
        """Get the tree_path and branch_location for a tree reference."""
 
541
        raise errors.UnsupportedOperation(self.get_reference_info, self)
 
542
 
459
543
    @needs_write_lock
460
544
    def fetch(self, from_branch, last_revision=None, pb=None):
461
545
        """Copy revisions from from_branch into this branch.
468
552
        """
469
553
        if self.base == from_branch.base:
470
554
            return (0, [])
471
 
        if pb is None:
472
 
            nested_pb = ui.ui_factory.nested_progress_bar()
473
 
            pb = nested_pb
474
 
        else:
475
 
            nested_pb = None
476
 
 
 
555
        if pb is not None:
 
556
            symbol_versioning.warn(
 
557
                symbol_versioning.deprecated_in((1, 14, 0))
 
558
                % "pb parameter to fetch()")
477
559
        from_branch.lock_read()
478
560
        try:
479
561
            if last_revision is None:
480
 
                pb.update('get source history')
481
562
                last_revision = from_branch.last_revision()
482
563
                last_revision = _mod_revision.ensure_null(last_revision)
483
564
            return self.repository.fetch(from_branch.repository,
484
565
                                         revision_id=last_revision,
485
 
                                         pb=nested_pb)
 
566
                                         pb=pb)
486
567
        finally:
487
 
            if nested_pb is not None:
488
 
                nested_pb.finished()
489
568
            from_branch.unlock()
490
569
 
491
570
    def get_bound_location(self):
555
634
    def set_revision_history(self, rev_history):
556
635
        raise NotImplementedError(self.set_revision_history)
557
636
 
 
637
    @needs_write_lock
 
638
    def set_parent(self, url):
 
639
        """See Branch.set_parent."""
 
640
        # TODO: Maybe delete old location files?
 
641
        # URLs should never be unicode, even on the local fs,
 
642
        # FIXUP this and get_parent in a future branch format bump:
 
643
        # read and rewrite the file. RBC 20060125
 
644
        if url is not None:
 
645
            if isinstance(url, unicode):
 
646
                try:
 
647
                    url = url.encode('ascii')
 
648
                except UnicodeEncodeError:
 
649
                    raise errors.InvalidURL(url,
 
650
                        "Urls must be 7-bit ascii, "
 
651
                        "use bzrlib.urlutils.escape")
 
652
            url = urlutils.relative_url(self.base, url)
 
653
        self._set_parent_location(url)
 
654
 
 
655
    @needs_write_lock
558
656
    def set_stacked_on_url(self, url):
559
657
        """Set the URL this branch is stacked against.
560
658
 
563
661
        :raises UnstackableRepositoryFormat: If the repository does not support
564
662
            stacking.
565
663
        """
566
 
        raise NotImplementedError(self.set_stacked_on_url)
 
664
        if not self._format.supports_stacking():
 
665
            raise errors.UnstackableBranchFormat(self._format, self.base)
 
666
        # XXX: Changing from one fallback repository to another does not check
 
667
        # that all the data you need is present in the new fallback.
 
668
        # Possibly it should.
 
669
        self._check_stackable_repo()
 
670
        if not url:
 
671
            try:
 
672
                old_url = self.get_stacked_on_url()
 
673
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
674
                errors.UnstackableRepositoryFormat):
 
675
                return
 
676
            self._unstack()
 
677
        else:
 
678
            self._activate_fallback_location(url)
 
679
        # write this out after the repository is stacked to avoid setting a
 
680
        # stacked config that doesn't work.
 
681
        self._set_config_location('stacked_on_location', url)
 
682
 
 
683
    def _unstack(self):
 
684
        """Change a branch to be unstacked, copying data as needed.
 
685
        
 
686
        Don't call this directly, use set_stacked_on_url(None).
 
687
        """
 
688
        pb = ui.ui_factory.nested_progress_bar()
 
689
        try:
 
690
            pb.update("Unstacking")
 
691
            # The basic approach here is to fetch the tip of the branch,
 
692
            # including all available ghosts, from the existing stacked
 
693
            # repository into a new repository object without the fallbacks. 
 
694
            #
 
695
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
 
696
            # correct for CHKMap repostiories
 
697
            old_repository = self.repository
 
698
            if len(old_repository._fallback_repositories) != 1:
 
699
                raise AssertionError("can't cope with fallback repositories "
 
700
                    "of %r" % (self.repository,))
 
701
            # unlock it, including unlocking the fallback
 
702
            old_repository.unlock()
 
703
            old_repository.lock_read()
 
704
            try:
 
705
                # Repositories don't offer an interface to remove fallback
 
706
                # repositories today; take the conceptually simpler option and just
 
707
                # reopen it.  We reopen it starting from the URL so that we
 
708
                # get a separate connection for RemoteRepositories and can
 
709
                # stream from one of them to the other.  This does mean doing
 
710
                # separate SSH connection setup, but unstacking is not a
 
711
                # common operation so it's tolerable.
 
712
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
713
                new_repository = new_bzrdir.find_repository()
 
714
                self.repository = new_repository
 
715
                if self.repository._fallback_repositories:
 
716
                    raise AssertionError("didn't expect %r to have "
 
717
                        "fallback_repositories"
 
718
                        % (self.repository,))
 
719
                # this is not paired with an unlock because it's just restoring
 
720
                # the previous state; the lock's released when set_stacked_on_url
 
721
                # returns
 
722
                self.repository.lock_write()
 
723
                # XXX: If you unstack a branch while it has a working tree
 
724
                # with a pending merge, the pending-merged revisions will no
 
725
                # longer be present.  You can (probably) revert and remerge.
 
726
                #
 
727
                # XXX: This only fetches up to the tip of the repository; it
 
728
                # doesn't bring across any tags.  That's fairly consistent
 
729
                # with how branch works, but perhaps not ideal.
 
730
                self.repository.fetch(old_repository,
 
731
                    revision_id=self.last_revision(),
 
732
                    find_ghosts=True)
 
733
            finally:
 
734
                old_repository.unlock()
 
735
        finally:
 
736
            pb.finished()
 
737
 
 
738
    def _set_tags_bytes(self, bytes):
 
739
        """Mirror method for _get_tags_bytes.
 
740
 
 
741
        :seealso: Branch._get_tags_bytes.
 
742
        """
 
743
        return _run_with_write_locked_target(self, self._transport.put_bytes,
 
744
            'tags', bytes)
567
745
 
568
746
    def _cache_revision_history(self, rev_history):
569
747
        """Set the cached revision history to rev_history.
597
775
        self._revision_id_to_revno_cache = None
598
776
        self._last_revision_info_cache = None
599
777
        self._merge_sorted_revisions_cache = None
 
778
        self._partial_revision_history_cache = []
 
779
        self._partial_revision_id_to_revno_cache = {}
600
780
 
601
781
    def _gen_revision_history(self):
602
782
        """Return sequence of revision hashes on to this branch.
641
821
        """Older format branches cannot bind or unbind."""
642
822
        raise errors.UpgradeRequired(self.base)
643
823
 
644
 
    def set_append_revisions_only(self, enabled):
645
 
        """Older format branches are never restricted to append-only"""
646
 
        raise errors.UpgradeRequired(self.base)
647
 
 
648
824
    def last_revision(self):
649
825
        """Return last revision id, or NULL_REVISION."""
650
826
        return self.last_revision_info()[1]
730
906
        except ValueError:
731
907
            raise errors.NoSuchRevision(self, revision_id)
732
908
 
 
909
    @needs_read_lock
733
910
    def get_rev_id(self, revno, history=None):
734
911
        """Find the revision id of the specified revno."""
735
912
        if revno == 0:
736
913
            return _mod_revision.NULL_REVISION
737
 
        if history is None:
738
 
            history = self.revision_history()
739
 
        if revno <= 0 or revno > len(history):
 
914
        last_revno, last_revid = self.last_revision_info()
 
915
        if revno == last_revno:
 
916
            return last_revid
 
917
        if revno <= 0 or revno > last_revno:
740
918
            raise errors.NoSuchRevision(self, revno)
741
 
        return history[revno - 1]
 
919
        distance_from_last = last_revno - revno
 
920
        if len(self._partial_revision_history_cache) <= distance_from_last:
 
921
            self._extend_partial_history(distance_from_last)
 
922
        return self._partial_revision_history_cache[distance_from_last]
742
923
 
 
924
    @needs_write_lock
743
925
    def pull(self, source, overwrite=False, stop_revision=None,
744
 
             possible_transports=None, _override_hook_target=None):
 
926
             possible_transports=None, *args, **kwargs):
745
927
        """Mirror source into this branch.
746
928
 
747
929
        This branch is considered to be 'local', having low latency.
748
930
 
749
931
        :returns: PullResult instance
750
932
        """
751
 
        raise NotImplementedError(self.pull)
 
933
        return InterBranch.get(source, self).pull(overwrite=overwrite,
 
934
            stop_revision=stop_revision,
 
935
            possible_transports=possible_transports, *args, **kwargs)
752
936
 
753
 
    def push(self, target, overwrite=False, stop_revision=None):
 
937
    def push(self, target, overwrite=False, stop_revision=None, *args,
 
938
        **kwargs):
754
939
        """Mirror this branch into target.
755
940
 
756
941
        This branch is considered to be 'local', having low latency.
757
942
        """
758
 
        raise NotImplementedError(self.push)
 
943
        return InterBranch.get(self, target).push(overwrite, stop_revision,
 
944
            *args, **kwargs)
 
945
 
 
946
    def lossy_push(self, target, stop_revision=None):
 
947
        """Push deltas into another branch.
 
948
 
 
949
        :note: This does not, like push, retain the revision ids from 
 
950
            the source branch and will, rather than adding bzr-specific 
 
951
            metadata, push only those semantics of the revision that can be 
 
952
            natively represented by this branch' VCS.
 
953
 
 
954
        :param target: Target branch
 
955
        :param stop_revision: Revision to push, defaults to last revision.
 
956
        :return: BranchPushResult with an extra member revidmap: 
 
957
            A dictionary mapping revision ids from the target branch 
 
958
            to new revision ids in the target branch, for each 
 
959
            revision that was pushed.
 
960
        """
 
961
        inter = InterBranch.get(self, target)
 
962
        lossy_push = getattr(inter, "lossy_push", None)
 
963
        if lossy_push is None:
 
964
            raise errors.LossyPushToSameVCS(self, target)
 
965
        return lossy_push(stop_revision)
759
966
 
760
967
    def basis_tree(self):
761
968
        """Return `Tree` object for last revision."""
768
975
        pattern is that the user can override it by specifying a
769
976
        location.
770
977
        """
771
 
        raise NotImplementedError(self.get_parent)
 
978
        parent = self._get_parent_location()
 
979
        if parent is None:
 
980
            return parent
 
981
        # This is an old-format absolute path to a local branch
 
982
        # turn it into a url
 
983
        if parent.startswith('/'):
 
984
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
985
        try:
 
986
            return urlutils.join(self.base[:-1], parent)
 
987
        except errors.InvalidURLJoin, e:
 
988
            raise errors.InaccessibleParent(parent, self.base)
 
989
 
 
990
    def _get_parent_location(self):
 
991
        raise NotImplementedError(self._get_parent_location)
772
992
 
773
993
    def _set_config_location(self, name, url, config=None,
774
994
                             make_relative=False):
788
1008
            location = None
789
1009
        return location
790
1010
 
 
1011
    def get_child_submit_format(self):
 
1012
        """Return the preferred format of submissions to this branch."""
 
1013
        return self.get_config().get_user_option("child_submit_format")
 
1014
 
791
1015
    def get_submit_branch(self):
792
1016
        """Return the submit location of the branch.
793
1017
 
810
1034
    def get_public_branch(self):
811
1035
        """Return the public location of the branch.
812
1036
 
813
 
        This is is used by merge directives.
 
1037
        This is used by merge directives.
814
1038
        """
815
1039
        return self._get_config_location('public_branch')
816
1040
 
862
1086
                raise errors.HookFailed(
863
1087
                    'pre_change_branch_tip', hook_name, exc_info)
864
1088
 
865
 
    def set_parent(self, url):
866
 
        raise NotImplementedError(self.set_parent)
867
 
 
868
1089
    @needs_write_lock
869
1090
    def update(self):
870
1091
        """Synchronise this branch with the master branch if any.
900
1121
                     be truncated to end with revision_id.
901
1122
        """
902
1123
        result = to_bzrdir.create_branch()
903
 
        if repository_policy is not None:
904
 
            repository_policy.configure_branch(result)
905
 
        self.copy_content_into(result, revision_id=revision_id)
906
 
        return  result
 
1124
        result.lock_write()
 
1125
        try:
 
1126
            if repository_policy is not None:
 
1127
                repository_policy.configure_branch(result)
 
1128
            self.copy_content_into(result, revision_id=revision_id)
 
1129
        finally:
 
1130
            result.unlock()
 
1131
        return result
907
1132
 
908
1133
    @needs_read_lock
909
1134
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
915
1140
                     be truncated to end with revision_id.
916
1141
        """
917
1142
        result = to_bzrdir.create_branch()
918
 
        if repository_policy is not None:
919
 
            repository_policy.configure_branch(result)
920
 
        self.copy_content_into(result, revision_id=revision_id)
921
 
        result.set_parent(self.bzrdir.root_transport.base)
 
1143
        result.lock_write()
 
1144
        try:
 
1145
            if repository_policy is not None:
 
1146
                repository_policy.configure_branch(result)
 
1147
            self.copy_content_into(result, revision_id=revision_id)
 
1148
            result.set_parent(self.bzrdir.root_transport.base)
 
1149
        finally:
 
1150
            result.unlock()
922
1151
        return result
923
1152
 
924
1153
    def _synchronize_history(self, destination, revision_id):
936
1165
        source_revno, source_revision_id = self.last_revision_info()
937
1166
        if revision_id is None:
938
1167
            revno, revision_id = source_revno, source_revision_id
939
 
        elif source_revision_id == revision_id:
940
 
            # we know the revno without needing to walk all of history
941
 
            revno = source_revno
942
1168
        else:
943
 
            # To figure out the revno for a random revision, we need to build
944
 
            # the revision history, and count its length.
945
 
            # We don't care about the order, just how long it is.
946
 
            # Alternatively, we could start at the current location, and count
947
 
            # backwards. But there is no guarantee that we will find it since
948
 
            # it may be a merged revision.
949
 
            revno = len(list(self.repository.iter_reverse_revision_history(
950
 
                                                                revision_id)))
 
1169
            graph = self.repository.get_graph()
 
1170
            try:
 
1171
                revno = graph.find_distance_to_null(revision_id, 
 
1172
                    [(source_revision_id, source_revno)])
 
1173
            except errors.GhostRevisionsHaveNoRevno:
 
1174
                # Default to 1, if we can't find anything else
 
1175
                revno = 1
951
1176
        destination.set_last_revision_info(revno, revision_id)
952
1177
 
953
1178
    @needs_read_lock
957
1182
        revision_id: if not None, the revision history in the new branch will
958
1183
                     be truncated to end with revision_id.
959
1184
        """
 
1185
        self.update_references(destination)
960
1186
        self._synchronize_history(destination, revision_id)
961
1187
        try:
962
1188
            parent = self.get_parent()
968
1194
        if self._push_should_merge_tags():
969
1195
            self.tags.merge_to(destination.tags)
970
1196
 
 
1197
    def update_references(self, target):
 
1198
        if not getattr(self._format, 'supports_reference_locations', False):
 
1199
            return
 
1200
        reference_dict = self._get_all_reference_info()
 
1201
        if len(reference_dict) == 0:
 
1202
            return
 
1203
        old_base = self.base
 
1204
        new_base = target.base
 
1205
        target_reference_dict = target._get_all_reference_info()
 
1206
        for file_id, (tree_path, branch_location) in (
 
1207
            reference_dict.items()):
 
1208
            branch_location = urlutils.rebase_url(branch_location,
 
1209
                                                  old_base, new_base)
 
1210
            target_reference_dict.setdefault(
 
1211
                file_id, (tree_path, branch_location))
 
1212
        target._set_all_reference_info(target_reference_dict)
 
1213
 
971
1214
    @needs_read_lock
972
1215
    def check(self):
973
1216
        """Check consistency of the branch.
980
1223
 
981
1224
        :return: A BranchCheckResult.
982
1225
        """
 
1226
        ret = BranchCheckResult(self)
983
1227
        mainline_parent_id = None
984
1228
        last_revno, last_revision_id = self.last_revision_info()
985
 
        real_rev_history = list(self.repository.iter_reverse_revision_history(
986
 
                                last_revision_id))
 
1229
        real_rev_history = []
 
1230
        try:
 
1231
            for revid in self.repository.iter_reverse_revision_history(
 
1232
                last_revision_id):
 
1233
                real_rev_history.append(revid)
 
1234
        except errors.RevisionNotPresent:
 
1235
            ret.ghosts_in_mainline = True
 
1236
        else:
 
1237
            ret.ghosts_in_mainline = False
987
1238
        real_rev_history.reverse()
988
1239
        if len(real_rev_history) != last_revno:
989
1240
            raise errors.BzrCheckError('revno does not match len(mainline)'
1005
1256
                                        "parents of {%s}"
1006
1257
                                        % (mainline_parent_id, revision_id))
1007
1258
            mainline_parent_id = revision_id
1008
 
        return BranchCheckResult(self)
 
1259
        return ret
1009
1260
 
1010
1261
    def _get_checkout_format(self):
1011
1262
        """Return the most suitable metadir for a checkout of this branch.
1021
1272
        return format
1022
1273
 
1023
1274
    def create_clone_on_transport(self, to_transport, revision_id=None,
1024
 
        stacked_on=None):
 
1275
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1025
1276
        """Create a clone of this branch and its bzrdir.
1026
1277
 
1027
1278
        :param to_transport: The transport to clone onto.
1028
1279
        :param revision_id: The revision id to use as tip in the new branch.
1029
1280
            If None the tip is obtained from this branch.
1030
1281
        :param stacked_on: An optional URL to stack the clone on.
 
1282
        :param create_prefix: Create any missing directories leading up to
 
1283
            to_transport.
 
1284
        :param use_existing_dir: Use an existing directory if one exists.
1031
1285
        """
1032
1286
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1033
1287
        # clone call. Or something. 20090224 RBC/spiv.
1034
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1035
 
            revision_id=revision_id, stacked_on=stacked_on)
 
1288
        if revision_id is None:
 
1289
            revision_id = self.last_revision()
 
1290
        try:
 
1291
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1292
                revision_id=revision_id, stacked_on=stacked_on,
 
1293
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1294
        except errors.FileExists:
 
1295
            if not use_existing_dir:
 
1296
                raise
 
1297
        except errors.NoSuchFile:
 
1298
            if not create_prefix:
 
1299
                raise
1036
1300
        return dir_to.open_branch()
1037
1301
 
1038
1302
    def create_checkout(self, to_location, revision_id=None,
1092
1356
        reconciler.reconcile()
1093
1357
        return reconciler
1094
1358
 
1095
 
    def reference_parent(self, file_id, path):
 
1359
    def reference_parent(self, file_id, path, possible_transports=None):
1096
1360
        """Return the parent branch for a tree-reference file_id
1097
1361
        :param file_id: The file_id of the tree reference
1098
1362
        :param path: The path of the file_id in the tree
1099
1363
        :return: A branch associated with the file_id
1100
1364
        """
1101
1365
        # FIXME should provide multiple branches, based on config
1102
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
 
1366
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
 
1367
                           possible_transports=possible_transports)
1103
1368
 
1104
1369
    def supports_tags(self):
1105
1370
        return self._format.supports_tags()
1164
1429
    _formats = {}
1165
1430
    """The known formats."""
1166
1431
 
 
1432
    can_set_append_revisions_only = True
 
1433
 
1167
1434
    def __eq__(self, other):
1168
1435
        return self.__class__ is other.__class__
1169
1436
 
1242
1509
        control_files = lockable_files.LockableFiles(branch_transport,
1243
1510
            lock_name, lock_class)
1244
1511
        control_files.create_lock()
1245
 
        control_files.lock_write()
 
1512
        try:
 
1513
            control_files.lock_write()
 
1514
        except errors.LockContention:
 
1515
            if lock_type != 'branch4':
 
1516
                raise
 
1517
            lock_taken = False
 
1518
        else:
 
1519
            lock_taken = True
1246
1520
        if set_format:
1247
1521
            utf8_files += [('format', self.get_format_string())]
1248
1522
        try:
1251
1525
                    filename, content,
1252
1526
                    mode=a_bzrdir._get_file_mode())
1253
1527
        finally:
1254
 
            control_files.unlock()
 
1528
            if lock_taken:
 
1529
                control_files.unlock()
1255
1530
        return self.open(a_bzrdir, _found=True)
1256
1531
 
1257
1532
    def initialize(self, a_bzrdir):
1267
1542
        """
1268
1543
        return True
1269
1544
 
 
1545
    def make_tags(self, branch):
 
1546
        """Create a tags object for branch.
 
1547
 
 
1548
        This method is on BranchFormat, because BranchFormats are reflected
 
1549
        over the wire via network_name(), whereas full Branch instances require
 
1550
        multiple VFS method calls to operate at all.
 
1551
 
 
1552
        The default implementation returns a disabled-tags instance.
 
1553
 
 
1554
        Note that it is normal for branch to be a RemoteBranch when using tags
 
1555
        on a RemoteBranch.
 
1556
        """
 
1557
        return DisabledTags(branch)
 
1558
 
1270
1559
    def network_name(self):
1271
1560
        """A simple byte string uniquely identifying this format for RPC calls.
1272
1561
 
1277
1566
        """
1278
1567
        raise NotImplementedError(self.network_name)
1279
1568
 
1280
 
    def open(self, a_bzrdir, _found=False):
 
1569
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1281
1570
        """Return the branch object for a_bzrdir
1282
1571
 
1283
 
        _found is a private parameter, do not use it. It is used to indicate
1284
 
               if format probing has already be done.
 
1572
        :param a_bzrdir: A BzrDir that contains a branch.
 
1573
        :param _found: a private parameter, do not use it. It is used to
 
1574
            indicate if format probing has already be done.
 
1575
        :param ignore_fallbacks: when set, no fallback branches will be opened
 
1576
            (if there are any).  Default is to open fallbacks.
1285
1577
        """
1286
1578
        raise NotImplementedError(self.open)
1287
1579
 
1289
1581
    def register_format(klass, format):
1290
1582
        """Register a metadir format."""
1291
1583
        klass._formats[format.get_format_string()] = format
1292
 
        # Metadir formats have a network name of their format string.
1293
 
        network_format_registry.register(format.get_format_string(), format)
 
1584
        # Metadir formats have a network name of their format string, and get
 
1585
        # registered as class factories.
 
1586
        network_format_registry.register(format.get_format_string(), format.__class__)
1294
1587
 
1295
1588
    @classmethod
1296
1589
    def set_default_format(klass, format):
1297
1590
        klass._default_format = format
1298
1591
 
 
1592
    def supports_set_append_revisions_only(self):
 
1593
        """True if this format supports set_append_revisions_only."""
 
1594
        return False
 
1595
 
1299
1596
    def supports_stacking(self):
1300
1597
        """True if this format records a stacked-on branch."""
1301
1598
        return False
1326
1623
        notified.
1327
1624
        """
1328
1625
        Hooks.__init__(self)
1329
 
        # Introduced in 0.15:
1330
 
        # invoked whenever the revision history has been set
1331
 
        # with set_revision_history. The api signature is
1332
 
        # (branch, revision_history), and the branch will
1333
 
        # be write-locked.
1334
 
        self['set_rh'] = []
1335
 
        # Invoked after a branch is opened. The api signature is (branch).
1336
 
        self['open'] = []
1337
 
        # invoked after a push operation completes.
1338
 
        # the api signature is
1339
 
        # (push_result)
1340
 
        # containing the members
1341
 
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
1342
 
        # where local is the local target branch or None, master is the target
1343
 
        # master branch, and the rest should be self explanatory. The source
1344
 
        # is read locked and the target branches write locked. Source will
1345
 
        # be the local low-latency branch.
1346
 
        self['post_push'] = []
1347
 
        # invoked after a pull operation completes.
1348
 
        # the api signature is
1349
 
        # (pull_result)
1350
 
        # containing the members
1351
 
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
1352
 
        # where local is the local branch or None, master is the target
1353
 
        # master branch, and the rest should be self explanatory. The source
1354
 
        # is read locked and the target branches write locked. The local
1355
 
        # branch is the low-latency branch.
1356
 
        self['post_pull'] = []
1357
 
        # invoked before a commit operation takes place.
1358
 
        # the api signature is
1359
 
        # (local, master, old_revno, old_revid, future_revno, future_revid,
1360
 
        #  tree_delta, future_tree).
1361
 
        # old_revid is NULL_REVISION for the first commit to a branch
1362
 
        # tree_delta is a TreeDelta object describing changes from the basis
1363
 
        # revision, hooks MUST NOT modify this delta
1364
 
        # future_tree is an in-memory tree obtained from
1365
 
        # CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1366
 
        self['pre_commit'] = []
1367
 
        # invoked after a commit operation completes.
1368
 
        # the api signature is
1369
 
        # (local, master, old_revno, old_revid, new_revno, new_revid)
1370
 
        # old_revid is NULL_REVISION for the first commit to a branch.
1371
 
        self['post_commit'] = []
1372
 
        # invoked after a uncommit operation completes.
1373
 
        # the api signature is
1374
 
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
1375
 
        # local is the local branch or None, master is the target branch,
1376
 
        # and an empty branch recieves new_revno of 0, new_revid of None.
1377
 
        self['post_uncommit'] = []
1378
 
        # Introduced in 1.6
1379
 
        # Invoked before the tip of a branch changes.
1380
 
        # the api signature is
1381
 
        # (params) where params is a ChangeBranchTipParams with the members
1382
 
        # (branch, old_revno, new_revno, old_revid, new_revid)
1383
 
        self['pre_change_branch_tip'] = []
1384
 
        # Introduced in 1.4
1385
 
        # Invoked after the tip of a branch changes.
1386
 
        # the api signature is
1387
 
        # (params) where params is a ChangeBranchTipParams with the members
1388
 
        # (branch, old_revno, new_revno, old_revid, new_revid)
1389
 
        self['post_change_branch_tip'] = []
1390
 
        # Introduced in 1.9
1391
 
        # Invoked when a stacked branch activates its fallback locations and
1392
 
        # allows the transformation of the url of said location.
1393
 
        # the api signature is
1394
 
        # (branch, url) where branch is the branch having its fallback
1395
 
        # location activated and url is the url for the fallback location.
1396
 
        # The hook should return a url.
1397
 
        self['transform_fallback_location'] = []
 
1626
        self.create_hook(HookPoint('set_rh',
 
1627
            "Invoked whenever the revision history has been set via "
 
1628
            "set_revision_history. The api signature is (branch, "
 
1629
            "revision_history), and the branch will be write-locked. "
 
1630
            "The set_rh hook can be expensive for bzr to trigger, a better "
 
1631
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
 
1632
        self.create_hook(HookPoint('open',
 
1633
            "Called with the Branch object that has been opened after a "
 
1634
            "branch is opened.", (1, 8), None))
 
1635
        self.create_hook(HookPoint('post_push',
 
1636
            "Called after a push operation completes. post_push is called "
 
1637
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
 
1638
            "bzr client.", (0, 15), None))
 
1639
        self.create_hook(HookPoint('post_pull',
 
1640
            "Called after a pull operation completes. post_pull is called "
 
1641
            "with a bzrlib.branch.PullResult object and only runs in the "
 
1642
            "bzr client.", (0, 15), None))
 
1643
        self.create_hook(HookPoint('pre_commit',
 
1644
            "Called after a commit is calculated but before it is is "
 
1645
            "completed. pre_commit is called with (local, master, old_revno, "
 
1646
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
 
1647
            "). old_revid is NULL_REVISION for the first commit to a branch, "
 
1648
            "tree_delta is a TreeDelta object describing changes from the "
 
1649
            "basis revision. hooks MUST NOT modify this delta. "
 
1650
            " future_tree is an in-memory tree obtained from "
 
1651
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
 
1652
            "tree.", (0,91), None))
 
1653
        self.create_hook(HookPoint('post_commit',
 
1654
            "Called in the bzr client after a commit has completed. "
 
1655
            "post_commit is called with (local, master, old_revno, old_revid, "
 
1656
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
 
1657
            "commit to a branch.", (0, 15), None))
 
1658
        self.create_hook(HookPoint('post_uncommit',
 
1659
            "Called in the bzr client after an uncommit completes. "
 
1660
            "post_uncommit is called with (local, master, old_revno, "
 
1661
            "old_revid, new_revno, new_revid) where local is the local branch "
 
1662
            "or None, master is the target branch, and an empty branch "
 
1663
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1664
        self.create_hook(HookPoint('pre_change_branch_tip',
 
1665
            "Called in bzr client and server before a change to the tip of a "
 
1666
            "branch is made. pre_change_branch_tip is called with a "
 
1667
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
 
1668
            "commit, uncommit will all trigger this hook.", (1, 6), None))
 
1669
        self.create_hook(HookPoint('post_change_branch_tip',
 
1670
            "Called in bzr client and server after a change to the tip of a "
 
1671
            "branch is made. post_change_branch_tip is called with a "
 
1672
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
 
1673
            "commit, uncommit will all trigger this hook.", (1, 4), None))
 
1674
        self.create_hook(HookPoint('transform_fallback_location',
 
1675
            "Called when a stacked branch is activating its fallback "
 
1676
            "locations. transform_fallback_location is called with (branch, "
 
1677
            "url), and should return a new url. Returning the same url "
 
1678
            "allows it to be used as-is, returning a different one can be "
 
1679
            "used to cause the branch to stack on a closer copy of that "
 
1680
            "fallback_location. Note that the branch cannot have history "
 
1681
            "accessing methods called on it during this hook because the "
 
1682
            "fallback locations have not been activated. When there are "
 
1683
            "multiple hooks installed for transform_fallback_location, "
 
1684
            "all are called with the url returned from the previous hook."
 
1685
            "The order is however undefined.", (1, 9), None))
1398
1686
 
1399
1687
 
1400
1688
# install the default hooks into the Branch class.
1467
1755
        """The network name for this format is the control dirs disk label."""
1468
1756
        return self._matchingbzrdir.get_format_string()
1469
1757
 
1470
 
    def open(self, a_bzrdir, _found=False):
1471
 
        """Return the branch object for a_bzrdir
1472
 
 
1473
 
        _found is a private parameter, do not use it. It is used to indicate
1474
 
               if format probing has already be done.
1475
 
        """
 
1758
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1759
        """See BranchFormat.open()."""
1476
1760
        if not _found:
1477
1761
            # we are being called directly and must probe.
1478
1762
            raise NotImplementedError
1499
1783
        """
1500
1784
        return self.get_format_string()
1501
1785
 
1502
 
    def open(self, a_bzrdir, _found=False):
1503
 
        """Return the branch object for a_bzrdir.
1504
 
 
1505
 
        _found is a private parameter, do not use it. It is used to indicate
1506
 
               if format probing has already be done.
1507
 
        """
 
1786
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1787
        """See BranchFormat.open()."""
1508
1788
        if not _found:
1509
1789
            format = BranchFormat.find_format(a_bzrdir)
1510
1790
            if format.__class__ != self.__class__:
1517
1797
            return self._branch_class()(_format=self,
1518
1798
                              _control_files=control_files,
1519
1799
                              a_bzrdir=a_bzrdir,
1520
 
                              _repository=a_bzrdir.find_repository())
 
1800
                              _repository=a_bzrdir.find_repository(),
 
1801
                              ignore_fallbacks=ignore_fallbacks)
1521
1802
        except errors.NoSuchFile:
1522
1803
            raise errors.NotBranchError(path=transport.base)
1523
1804
 
1595
1876
                      ]
1596
1877
        return self._initialize_helper(a_bzrdir, utf8_files)
1597
1878
 
1598
 
 
1599
 
class BzrBranchFormat7(BranchFormatMetadir):
 
1879
    def make_tags(self, branch):
 
1880
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1881
        return BasicTags(branch)
 
1882
 
 
1883
    def supports_set_append_revisions_only(self):
 
1884
        return True
 
1885
 
 
1886
 
 
1887
class BzrBranchFormat8(BranchFormatMetadir):
 
1888
    """Metadir format supporting storing locations of subtree branches."""
 
1889
 
 
1890
    def _branch_class(self):
 
1891
        return BzrBranch8
 
1892
 
 
1893
    def get_format_string(self):
 
1894
        """See BranchFormat.get_format_string()."""
 
1895
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
 
1896
 
 
1897
    def get_format_description(self):
 
1898
        """See BranchFormat.get_format_description()."""
 
1899
        return "Branch format 8"
 
1900
 
 
1901
    def initialize(self, a_bzrdir):
 
1902
        """Create a branch of this format in a_bzrdir."""
 
1903
        utf8_files = [('last-revision', '0 null:\n'),
 
1904
                      ('branch.conf', ''),
 
1905
                      ('tags', ''),
 
1906
                      ('references', '')
 
1907
                      ]
 
1908
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1909
 
 
1910
    def __init__(self):
 
1911
        super(BzrBranchFormat8, self).__init__()
 
1912
        self._matchingbzrdir.repository_format = \
 
1913
            RepositoryFormatKnitPack5RichRoot()
 
1914
 
 
1915
    def make_tags(self, branch):
 
1916
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1917
        return BasicTags(branch)
 
1918
 
 
1919
    def supports_set_append_revisions_only(self):
 
1920
        return True
 
1921
 
 
1922
    def supports_stacking(self):
 
1923
        return True
 
1924
 
 
1925
    supports_reference_locations = True
 
1926
 
 
1927
 
 
1928
class BzrBranchFormat7(BzrBranchFormat8):
1600
1929
    """Branch format with last-revision, tags, and a stacked location pointer.
1601
1930
 
1602
1931
    The stacked location pointer is passed down to the repository and requires
1605
1934
    This format was introduced in bzr 1.6.
1606
1935
    """
1607
1936
 
 
1937
    def initialize(self, a_bzrdir):
 
1938
        """Create a branch of this format in a_bzrdir."""
 
1939
        utf8_files = [('last-revision', '0 null:\n'),
 
1940
                      ('branch.conf', ''),
 
1941
                      ('tags', ''),
 
1942
                      ]
 
1943
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1944
 
1608
1945
    def _branch_class(self):
1609
1946
        return BzrBranch7
1610
1947
 
1616
1953
        """See BranchFormat.get_format_description()."""
1617
1954
        return "Branch format 7"
1618
1955
 
1619
 
    def initialize(self, a_bzrdir):
1620
 
        """Create a branch of this format in a_bzrdir."""
1621
 
        utf8_files = [('last-revision', '0 null:\n'),
1622
 
                      ('branch.conf', ''),
1623
 
                      ('tags', ''),
1624
 
                      ]
1625
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1626
 
 
1627
 
    def __init__(self):
1628
 
        super(BzrBranchFormat7, self).__init__()
1629
 
        self._matchingbzrdir.repository_format = \
1630
 
            RepositoryFormatKnitPack5RichRoot()
1631
 
 
1632
 
    def supports_stacking(self):
 
1956
    def supports_set_append_revisions_only(self):
1633
1957
        return True
1634
1958
 
 
1959
    supports_reference_locations = False
 
1960
 
1635
1961
 
1636
1962
class BranchReferenceFormat(BranchFormat):
1637
1963
    """Bzr branch reference format.
1694
2020
        return clone
1695
2021
 
1696
2022
    def open(self, a_bzrdir, _found=False, location=None,
1697
 
             possible_transports=None):
 
2023
             possible_transports=None, ignore_fallbacks=False):
1698
2024
        """Return the branch that the branch reference in a_bzrdir points at.
1699
2025
 
1700
 
        _found is a private parameter, do not use it. It is used to indicate
1701
 
               if format probing has already be done.
 
2026
        :param a_bzrdir: A BzrDir that contains a branch.
 
2027
        :param _found: a private parameter, do not use it. It is used to
 
2028
            indicate if format probing has already be done.
 
2029
        :param ignore_fallbacks: when set, no fallback branches will be opened
 
2030
            (if there are any).  Default is to open fallbacks.
 
2031
        :param location: The location of the referenced branch.  If
 
2032
            unspecified, this will be determined from the branch reference in
 
2033
            a_bzrdir.
 
2034
        :param possible_transports: An optional reusable transports list.
1702
2035
        """
1703
2036
        if not _found:
1704
2037
            format = BranchFormat.find_format(a_bzrdir)
1709
2042
            location = self.get_reference(a_bzrdir)
1710
2043
        real_bzrdir = bzrdir.BzrDir.open(
1711
2044
            location, possible_transports=possible_transports)
1712
 
        result = real_bzrdir.open_branch()
 
2045
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1713
2046
        # this changes the behaviour of result.clone to create a new reference
1714
2047
        # rather than a copy of the content of the branch.
1715
2048
        # I did not use a proxy object because that needs much more extensive
1736
2069
__format5 = BzrBranchFormat5()
1737
2070
__format6 = BzrBranchFormat6()
1738
2071
__format7 = BzrBranchFormat7()
 
2072
__format8 = BzrBranchFormat8()
1739
2073
BranchFormat.register_format(__format5)
1740
2074
BranchFormat.register_format(BranchReferenceFormat())
1741
2075
BranchFormat.register_format(__format6)
1742
2076
BranchFormat.register_format(__format7)
 
2077
BranchFormat.register_format(__format8)
1743
2078
BranchFormat.set_default_format(__format6)
1744
2079
_legacy_formats = [BzrBranchFormat4(),
1745
2080
    ]
1746
2081
network_format_registry.register(
1747
 
    _legacy_formats[0].network_name(), _legacy_formats[0])
 
2082
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1748
2083
 
1749
2084
 
1750
2085
class BzrBranch(Branch):
1762
2097
    """
1763
2098
 
1764
2099
    def __init__(self, _format=None,
1765
 
                 _control_files=None, a_bzrdir=None, _repository=None):
 
2100
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2101
                 ignore_fallbacks=False):
1766
2102
        """Create new branch object at a particular location."""
1767
2103
        if a_bzrdir is None:
1768
2104
            raise ValueError('a_bzrdir must be supplied')
1791
2127
 
1792
2128
    base = property(_get_base, doc="The URL for the root of this branch.")
1793
2129
 
 
2130
    def _get_config(self):
 
2131
        return TransportConfig(self._transport, 'branch.conf')
 
2132
 
1794
2133
    def is_locked(self):
1795
2134
        return self.control_files.is_locked()
1796
2135
 
1797
2136
    def lock_write(self, token=None):
1798
 
        repo_token = self.repository.lock_write()
 
2137
        # All-in-one needs to always unlock/lock.
 
2138
        repo_control = getattr(self.repository, 'control_files', None)
 
2139
        if self.control_files == repo_control or not self.is_locked():
 
2140
            self.repository.lock_write()
 
2141
            took_lock = True
 
2142
        else:
 
2143
            took_lock = False
1799
2144
        try:
1800
 
            token = self.control_files.lock_write(token=token)
 
2145
            return self.control_files.lock_write(token=token)
1801
2146
        except:
1802
 
            self.repository.unlock()
 
2147
            if took_lock:
 
2148
                self.repository.unlock()
1803
2149
            raise
1804
 
        return token
1805
2150
 
1806
2151
    def lock_read(self):
1807
 
        self.repository.lock_read()
 
2152
        # All-in-one needs to always unlock/lock.
 
2153
        repo_control = getattr(self.repository, 'control_files', None)
 
2154
        if self.control_files == repo_control or not self.is_locked():
 
2155
            self.repository.lock_read()
 
2156
            took_lock = True
 
2157
        else:
 
2158
            took_lock = False
1808
2159
        try:
1809
2160
            self.control_files.lock_read()
1810
2161
        except:
1811
 
            self.repository.unlock()
 
2162
            if took_lock:
 
2163
                self.repository.unlock()
1812
2164
            raise
1813
2165
 
1814
2166
    def unlock(self):
1815
 
        # TODO: test for failed two phase locks. This is known broken.
1816
2167
        try:
1817
2168
            self.control_files.unlock()
1818
2169
        finally:
1819
 
            self.repository.unlock()
1820
 
        if not self.control_files.is_locked():
1821
 
            # we just released the lock
1822
 
            self._clear_cached_state()
 
2170
            # All-in-one needs to always unlock/lock.
 
2171
            repo_control = getattr(self.repository, 'control_files', None)
 
2172
            if (self.control_files == repo_control or
 
2173
                not self.control_files.is_locked()):
 
2174
                self.repository.unlock()
 
2175
            if not self.control_files.is_locked():
 
2176
                # we just released the lock
 
2177
                self._clear_cached_state()
1823
2178
 
1824
2179
    def peek_lock_mode(self):
1825
2180
        if self.control_files._lock_count == 0:
1944
2299
        """See Branch.basis_tree."""
1945
2300
        return self.repository.revision_tree(self.last_revision())
1946
2301
 
1947
 
    @needs_write_lock
1948
 
    def pull(self, source, overwrite=False, stop_revision=None,
1949
 
             _hook_master=None, run_hooks=True, possible_transports=None,
1950
 
             _override_hook_target=None):
1951
 
        """See Branch.pull.
1952
 
 
1953
 
        :param _hook_master: Private parameter - set the branch to
1954
 
            be supplied as the master to pull hooks.
1955
 
        :param run_hooks: Private parameter - if false, this branch
1956
 
            is being called because it's the master of the primary branch,
1957
 
            so it should not run its hooks.
1958
 
        :param _override_hook_target: Private parameter - set the branch to be
1959
 
            supplied as the target_branch to pull hooks.
1960
 
        """
1961
 
        result = PullResult()
1962
 
        result.source_branch = source
1963
 
        if _override_hook_target is None:
1964
 
            result.target_branch = self
1965
 
        else:
1966
 
            result.target_branch = _override_hook_target
1967
 
        source.lock_read()
1968
 
        try:
1969
 
            # We assume that during 'pull' the local repository is closer than
1970
 
            # the remote one.
1971
 
            graph = self.repository.get_graph(source.repository)
1972
 
            result.old_revno, result.old_revid = self.last_revision_info()
1973
 
            self.update_revisions(source, stop_revision, overwrite=overwrite,
1974
 
                                  graph=graph)
1975
 
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1976
 
            result.new_revno, result.new_revid = self.last_revision_info()
1977
 
            if _hook_master:
1978
 
                result.master_branch = _hook_master
1979
 
                result.local_branch = result.target_branch
1980
 
            else:
1981
 
                result.master_branch = result.target_branch
1982
 
                result.local_branch = None
1983
 
            if run_hooks:
1984
 
                for hook in Branch.hooks['post_pull']:
1985
 
                    hook(result)
1986
 
        finally:
1987
 
            source.unlock()
1988
 
        return result
1989
 
 
1990
2302
    def _get_parent_location(self):
1991
2303
        _locs = ['parent', 'pull', 'x-pull']
1992
2304
        for l in _locs:
1996
2308
                pass
1997
2309
        return None
1998
2310
 
1999
 
    @needs_read_lock
2000
 
    def push(self, target, overwrite=False, stop_revision=None,
2001
 
             _override_hook_source_branch=None):
2002
 
        """See Branch.push.
2003
 
 
2004
 
        This is the basic concrete implementation of push()
2005
 
 
2006
 
        :param _override_hook_source_branch: If specified, run
2007
 
        the hooks passing this Branch as the source, rather than self.
2008
 
        This is for use of RemoteBranch, where push is delegated to the
2009
 
        underlying vfs-based Branch.
2010
 
        """
2011
 
        # TODO: Public option to disable running hooks - should be trivial but
2012
 
        # needs tests.
2013
 
        return _run_with_write_locked_target(
2014
 
            target, self._push_with_bound_branches, target, overwrite,
2015
 
            stop_revision,
2016
 
            _override_hook_source_branch=_override_hook_source_branch)
2017
 
 
2018
 
    def _push_with_bound_branches(self, target, overwrite,
2019
 
            stop_revision,
2020
 
            _override_hook_source_branch=None):
2021
 
        """Push from self into target, and into target's master if any.
2022
 
 
2023
 
        This is on the base BzrBranch class even though it doesn't support
2024
 
        bound branches because the *target* might be bound.
2025
 
        """
2026
 
        def _run_hooks():
2027
 
            if _override_hook_source_branch:
2028
 
                result.source_branch = _override_hook_source_branch
2029
 
            for hook in Branch.hooks['post_push']:
2030
 
                hook(result)
2031
 
 
2032
 
        bound_location = target.get_bound_location()
2033
 
        if bound_location and target.base != bound_location:
2034
 
            # there is a master branch.
2035
 
            #
2036
 
            # XXX: Why the second check?  Is it even supported for a branch to
2037
 
            # be bound to itself? -- mbp 20070507
2038
 
            master_branch = target.get_master_branch()
2039
 
            master_branch.lock_write()
2040
 
            try:
2041
 
                # push into the master from this branch.
2042
 
                self._basic_push(master_branch, overwrite, stop_revision)
2043
 
                # and push into the target branch from this. Note that we push from
2044
 
                # this branch again, because its considered the highest bandwidth
2045
 
                # repository.
2046
 
                result = self._basic_push(target, overwrite, stop_revision)
2047
 
                result.master_branch = master_branch
2048
 
                result.local_branch = target
2049
 
                _run_hooks()
2050
 
                return result
2051
 
            finally:
2052
 
                master_branch.unlock()
2053
 
        else:
2054
 
            # no master branch
2055
 
            result = self._basic_push(target, overwrite, stop_revision)
2056
 
            # TODO: Why set master_branch and local_branch if there's no
2057
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
2058
 
            # 20070504
2059
 
            result.master_branch = target
2060
 
            result.local_branch = None
2061
 
            _run_hooks()
2062
 
            return result
2063
 
 
2064
2311
    def _basic_push(self, target, overwrite, stop_revision):
2065
2312
        """Basic implementation of push without bound branches or hooks.
2066
2313
 
2067
 
        Must be called with self read locked and target write locked.
 
2314
        Must be called with source read locked and target write locked.
2068
2315
        """
2069
 
        result = PushResult()
 
2316
        result = BranchPushResult()
2070
2317
        result.source_branch = self
2071
2318
        result.target_branch = target
2072
2319
        result.old_revno, result.old_revid = target.last_revision_info()
 
2320
        self.update_references(target)
2073
2321
        if result.old_revid != self.last_revision():
2074
2322
            # We assume that during 'push' this repository is closer than
2075
2323
            # the target.
2076
2324
            graph = self.repository.get_graph(target.repository)
2077
 
            target.update_revisions(self, stop_revision, overwrite=overwrite,
2078
 
                                    graph=graph)
 
2325
            target.update_revisions(self, stop_revision,
 
2326
                overwrite=overwrite, graph=graph)
2079
2327
        if self._push_should_merge_tags():
2080
 
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
 
2328
            result.tag_conflicts = self.tags.merge_to(target.tags,
 
2329
                overwrite)
2081
2330
        result.new_revno, result.new_revid = target.last_revision_info()
2082
2331
        return result
2083
2332
 
2084
 
    def get_parent(self):
2085
 
        """See Branch.get_parent."""
2086
 
        parent = self._get_parent_location()
2087
 
        if parent is None:
2088
 
            return parent
2089
 
        # This is an old-format absolute path to a local branch
2090
 
        # turn it into a url
2091
 
        if parent.startswith('/'):
2092
 
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
2093
 
        try:
2094
 
            return urlutils.join(self.base[:-1], parent)
2095
 
        except errors.InvalidURLJoin, e:
2096
 
            raise errors.InaccessibleParent(parent, self.base)
2097
 
 
2098
2333
    def get_stacked_on_url(self):
2099
2334
        raise errors.UnstackableBranchFormat(self._format, self.base)
2100
2335
 
2104
2339
            'push_location', location,
2105
2340
            store=_mod_config.STORE_LOCATION_NORECURSE)
2106
2341
 
2107
 
    @needs_write_lock
2108
 
    def set_parent(self, url):
2109
 
        """See Branch.set_parent."""
2110
 
        # TODO: Maybe delete old location files?
2111
 
        # URLs should never be unicode, even on the local fs,
2112
 
        # FIXUP this and get_parent in a future branch format bump:
2113
 
        # read and rewrite the file. RBC 20060125
2114
 
        if url is not None:
2115
 
            if isinstance(url, unicode):
2116
 
                try:
2117
 
                    url = url.encode('ascii')
2118
 
                except UnicodeEncodeError:
2119
 
                    raise errors.InvalidURL(url,
2120
 
                        "Urls must be 7-bit ascii, "
2121
 
                        "use bzrlib.urlutils.escape")
2122
 
            url = urlutils.relative_url(self.base, url)
2123
 
        self._set_parent_location(url)
2124
 
 
2125
2342
    def _set_parent_location(self, url):
2126
2343
        if url is None:
2127
2344
            self._transport.delete('parent')
2129
2346
            self._transport.put_bytes('parent', url + '\n',
2130
2347
                mode=self.bzrdir._get_file_mode())
2131
2348
 
2132
 
    def set_stacked_on_url(self, url):
2133
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
2134
 
 
2135
2349
 
2136
2350
class BzrBranch5(BzrBranch):
2137
2351
    """A format 5 branch. This supports new features over plain branches.
2139
2353
    It has support for a master_branch which is the data for bound branches.
2140
2354
    """
2141
2355
 
2142
 
    @needs_write_lock
2143
 
    def pull(self, source, overwrite=False, stop_revision=None,
2144
 
             run_hooks=True, possible_transports=None,
2145
 
             _override_hook_target=None):
2146
 
        """Pull from source into self, updating my master if any.
2147
 
 
2148
 
        :param run_hooks: Private parameter - if false, this branch
2149
 
            is being called because it's the master of the primary branch,
2150
 
            so it should not run its hooks.
2151
 
        """
2152
 
        bound_location = self.get_bound_location()
2153
 
        master_branch = None
2154
 
        if bound_location and source.base != bound_location:
2155
 
            # not pulling from master, so we need to update master.
2156
 
            master_branch = self.get_master_branch(possible_transports)
2157
 
            master_branch.lock_write()
2158
 
        try:
2159
 
            if master_branch:
2160
 
                # pull from source into master.
2161
 
                master_branch.pull(source, overwrite, stop_revision,
2162
 
                    run_hooks=False)
2163
 
            return super(BzrBranch5, self).pull(source, overwrite,
2164
 
                stop_revision, _hook_master=master_branch,
2165
 
                run_hooks=run_hooks,
2166
 
                _override_hook_target=_override_hook_target)
2167
 
        finally:
2168
 
            if master_branch:
2169
 
                master_branch.unlock()
2170
 
 
2171
2356
    def get_bound_location(self):
2172
2357
        try:
2173
2358
            return self._transport.get_bytes('bound')[:-1]
2260
2445
        return None
2261
2446
 
2262
2447
 
2263
 
class BzrBranch7(BzrBranch5):
2264
 
    """A branch with support for a fallback repository."""
2265
 
 
2266
 
    def _get_fallback_repository(self, url):
2267
 
        """Get the repository we fallback to at url."""
2268
 
        url = urlutils.join(self.base, url)
2269
 
        a_bzrdir = bzrdir.BzrDir.open(url,
2270
 
                                      possible_transports=[self._transport])
2271
 
        return a_bzrdir.open_branch().repository
2272
 
 
2273
 
    def _activate_fallback_location(self, url):
2274
 
        """Activate the branch/repository from url as a fallback repository."""
2275
 
        self.repository.add_fallback_repository(
2276
 
            self._get_fallback_repository(url))
 
2448
class BzrBranch8(BzrBranch5):
 
2449
    """A branch that stores tree-reference locations."""
2277
2450
 
2278
2451
    def _open_hook(self):
 
2452
        if self._ignore_fallbacks:
 
2453
            return
2279
2454
        try:
2280
2455
            url = self.get_stacked_on_url()
2281
2456
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2291
2466
                        "None, not a URL." % hook_name)
2292
2467
            self._activate_fallback_location(url)
2293
2468
 
2294
 
    def _check_stackable_repo(self):
2295
 
        if not self.repository._format.supports_external_lookups:
2296
 
            raise errors.UnstackableRepositoryFormat(self.repository._format,
2297
 
                self.repository.base)
2298
 
 
2299
2469
    def __init__(self, *args, **kwargs):
2300
 
        super(BzrBranch7, self).__init__(*args, **kwargs)
 
2470
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
 
2471
        super(BzrBranch8, self).__init__(*args, **kwargs)
2301
2472
        self._last_revision_info_cache = None
2302
 
        self._partial_revision_history_cache = []
 
2473
        self._reference_info = None
2303
2474
 
2304
2475
    def _clear_cached_state(self):
2305
 
        super(BzrBranch7, self)._clear_cached_state()
 
2476
        super(BzrBranch8, self)._clear_cached_state()
2306
2477
        self._last_revision_info_cache = None
2307
 
        self._partial_revision_history_cache = []
 
2478
        self._reference_info = None
2308
2479
 
2309
2480
    def _last_revision_info(self):
2310
2481
        revision_string = self._transport.get_bytes('last-revision')
2365
2536
        self._extend_partial_history(stop_index=last_revno-1)
2366
2537
        return list(reversed(self._partial_revision_history_cache))
2367
2538
 
2368
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
2369
 
        """Extend the partial history to include a given index
2370
 
 
2371
 
        If a stop_index is supplied, stop when that index has been reached.
2372
 
        If a stop_revision is supplied, stop when that revision is
2373
 
        encountered.  Otherwise, stop when the beginning of history is
2374
 
        reached.
2375
 
 
2376
 
        :param stop_index: The index which should be present.  When it is
2377
 
            present, history extension will stop.
2378
 
        :param revision_id: The revision id which should be present.  When
2379
 
            it is encountered, history extension will stop.
2380
 
        """
2381
 
        repo = self.repository
2382
 
        if len(self._partial_revision_history_cache) == 0:
2383
 
            iterator = repo.iter_reverse_revision_history(self.last_revision())
2384
 
        else:
2385
 
            start_revision = self._partial_revision_history_cache[-1]
2386
 
            iterator = repo.iter_reverse_revision_history(start_revision)
2387
 
            #skip the last revision in the list
2388
 
            next_revision = iterator.next()
2389
 
        for revision_id in iterator:
2390
 
            self._partial_revision_history_cache.append(revision_id)
2391
 
            if (stop_index is not None and
2392
 
                len(self._partial_revision_history_cache) > stop_index):
2393
 
                break
2394
 
            if revision_id == stop_revision:
2395
 
                break
2396
 
 
2397
2539
    def _write_revision_history(self, history):
2398
2540
        """Factored out of set_revision_history.
2399
2541
 
2420
2562
        """Set the parent branch"""
2421
2563
        return self._get_config_location('parent_location')
2422
2564
 
 
2565
    @needs_write_lock
 
2566
    def _set_all_reference_info(self, info_dict):
 
2567
        """Replace all reference info stored in a branch.
 
2568
 
 
2569
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
 
2570
        """
 
2571
        s = StringIO()
 
2572
        writer = rio.RioWriter(s)
 
2573
        for key, (tree_path, branch_location) in info_dict.iteritems():
 
2574
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
 
2575
                                branch_location=branch_location)
 
2576
            writer.write_stanza(stanza)
 
2577
        self._transport.put_bytes('references', s.getvalue())
 
2578
        self._reference_info = info_dict
 
2579
 
 
2580
    @needs_read_lock
 
2581
    def _get_all_reference_info(self):
 
2582
        """Return all the reference info stored in a branch.
 
2583
 
 
2584
        :return: A dict of {file_id: (tree_path, branch_location)}
 
2585
        """
 
2586
        if self._reference_info is not None:
 
2587
            return self._reference_info
 
2588
        rio_file = self._transport.get('references')
 
2589
        try:
 
2590
            stanzas = rio.read_stanzas(rio_file)
 
2591
            info_dict = dict((s['file_id'], (s['tree_path'],
 
2592
                             s['branch_location'])) for s in stanzas)
 
2593
        finally:
 
2594
            rio_file.close()
 
2595
        self._reference_info = info_dict
 
2596
        return info_dict
 
2597
 
 
2598
    def set_reference_info(self, file_id, tree_path, branch_location):
 
2599
        """Set the branch location to use for a tree reference.
 
2600
 
 
2601
        :param file_id: The file-id of the tree reference.
 
2602
        :param tree_path: The path of the tree reference in the tree.
 
2603
        :param branch_location: The location of the branch to retrieve tree
 
2604
            references from.
 
2605
        """
 
2606
        info_dict = self._get_all_reference_info()
 
2607
        info_dict[file_id] = (tree_path, branch_location)
 
2608
        if None in (tree_path, branch_location):
 
2609
            if tree_path is not None:
 
2610
                raise ValueError('tree_path must be None when branch_location'
 
2611
                                 ' is None.')
 
2612
            if branch_location is not None:
 
2613
                raise ValueError('branch_location must be None when tree_path'
 
2614
                                 ' is None.')
 
2615
            del info_dict[file_id]
 
2616
        self._set_all_reference_info(info_dict)
 
2617
 
 
2618
    def get_reference_info(self, file_id):
 
2619
        """Get the tree_path and branch_location for a tree reference.
 
2620
 
 
2621
        :return: a tuple of (tree_path, branch_location)
 
2622
        """
 
2623
        return self._get_all_reference_info().get(file_id, (None, None))
 
2624
 
 
2625
    def reference_parent(self, file_id, path, possible_transports=None):
 
2626
        """Return the parent branch for a tree-reference file_id.
 
2627
 
 
2628
        :param file_id: The file_id of the tree reference
 
2629
        :param path: The path of the file_id in the tree
 
2630
        :return: A branch associated with the file_id
 
2631
        """
 
2632
        branch_location = self.get_reference_info(file_id)[1]
 
2633
        if branch_location is None:
 
2634
            return Branch.reference_parent(self, file_id, path,
 
2635
                                           possible_transports)
 
2636
        branch_location = urlutils.join(self.base, branch_location)
 
2637
        return Branch.open(branch_location,
 
2638
                           possible_transports=possible_transports)
 
2639
 
2423
2640
    def set_push_location(self, location):
2424
2641
        """See Branch.set_push_location."""
2425
2642
        self._set_config_location('push_location', location)
2467
2684
            raise errors.NotStacked(self)
2468
2685
        return stacked_url
2469
2686
 
2470
 
    def set_append_revisions_only(self, enabled):
2471
 
        if enabled:
2472
 
            value = 'True'
2473
 
        else:
2474
 
            value = 'False'
2475
 
        self.get_config().set_user_option('append_revisions_only', value,
2476
 
            warn_masked=True)
2477
 
 
2478
 
    def set_stacked_on_url(self, url):
2479
 
        self._check_stackable_repo()
2480
 
        if not url:
2481
 
            try:
2482
 
                old_url = self.get_stacked_on_url()
2483
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
2484
 
                errors.UnstackableRepositoryFormat):
2485
 
                return
2486
 
            url = ''
2487
 
            # repositories don't offer an interface to remove fallback
2488
 
            # repositories today; take the conceptually simpler option and just
2489
 
            # reopen it.
2490
 
            self.repository = self.bzrdir.find_repository()
2491
 
            # for every revision reference the branch has, ensure it is pulled
2492
 
            # in.
2493
 
            source_repository = self._get_fallback_repository(old_url)
2494
 
            for revision_id in chain([self.last_revision()],
2495
 
                self.tags.get_reverse_tag_dict()):
2496
 
                self.repository.fetch(source_repository, revision_id,
2497
 
                    find_ghosts=True)
2498
 
        else:
2499
 
            self._activate_fallback_location(url)
2500
 
        # write this out after the repository is stacked to avoid setting a
2501
 
        # stacked config that doesn't work.
2502
 
        self._set_config_location('stacked_on_location', url)
2503
 
 
2504
2687
    def _get_append_revisions_only(self):
2505
2688
        value = self.get_config().get_user_option('append_revisions_only')
2506
2689
        return value == 'True'
2507
2690
 
2508
 
    def _make_tags(self):
2509
 
        return BasicTags(self)
2510
 
 
2511
2691
    @needs_write_lock
2512
2692
    def generate_revision_history(self, revision_id, last_rev=None,
2513
2693
                                  other_branch=None):
2552
2732
        return self.revno() - index
2553
2733
 
2554
2734
 
 
2735
class BzrBranch7(BzrBranch8):
 
2736
    """A branch with support for a fallback repository."""
 
2737
 
 
2738
    def set_reference_info(self, file_id, tree_path, branch_location):
 
2739
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
 
2740
 
 
2741
    def get_reference_info(self, file_id):
 
2742
        Branch.get_reference_info(self, file_id)
 
2743
 
 
2744
    def reference_parent(self, file_id, path, possible_transports=None):
 
2745
        return Branch.reference_parent(self, file_id, path,
 
2746
                                       possible_transports)
 
2747
 
 
2748
 
2555
2749
class BzrBranch6(BzrBranch7):
2556
2750
    """See BzrBranchFormat6 for the capabilities of this branch.
2557
2751
 
2562
2756
    def get_stacked_on_url(self):
2563
2757
        raise errors.UnstackableBranchFormat(self._format, self.base)
2564
2758
 
2565
 
    def set_stacked_on_url(self, url):
2566
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
2567
 
 
2568
2759
 
2569
2760
######################################################################
2570
2761
# results of operations
2587
2778
    :ivar new_revno: Revision number after pull.
2588
2779
    :ivar old_revid: Tip revision id before pull.
2589
2780
    :ivar new_revid: Tip revision id after pull.
2590
 
    :ivar source_branch: Source (local) branch object.
 
2781
    :ivar source_branch: Source (local) branch object. (read locked)
2591
2782
    :ivar master_branch: Master branch of the target, or the target if no
2592
2783
        Master
2593
2784
    :ivar local_branch: target branch if there is a Master, else None
2594
 
    :ivar target_branch: Target/destination branch object.
 
2785
    :ivar target_branch: Target/destination branch object. (write locked)
2595
2786
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2596
2787
    """
2597
2788
 
2608
2799
        self._show_tag_conficts(to_file)
2609
2800
 
2610
2801
 
2611
 
class PushResult(_Result):
 
2802
class BranchPushResult(_Result):
2612
2803
    """Result of a Branch.push operation.
2613
2804
 
2614
 
    :ivar old_revno: Revision number before push.
2615
 
    :ivar new_revno: Revision number after push.
2616
 
    :ivar old_revid: Tip revision id before push.
2617
 
    :ivar new_revid: Tip revision id after push.
2618
 
    :ivar source_branch: Source branch object.
2619
 
    :ivar master_branch: Master branch of the target, or None.
2620
 
    :ivar target_branch: Target/destination branch object.
 
2805
    :ivar old_revno: Revision number (eg 10) of the target before push.
 
2806
    :ivar new_revno: Revision number (eg 12) of the target after push.
 
2807
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
 
2808
        before the push.
 
2809
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
 
2810
        after the push.
 
2811
    :ivar source_branch: Source branch object that the push was from. This is
 
2812
        read locked, and generally is a local (and thus low latency) branch.
 
2813
    :ivar master_branch: If target is a bound branch, the master branch of
 
2814
        target, or target itself. Always write locked.
 
2815
    :ivar target_branch: The direct Branch where data is being sent (write
 
2816
        locked).
 
2817
    :ivar local_branch: If the target is a bound branch this will be the
 
2818
        target, otherwise it will be None.
2621
2819
    """
2622
2820
 
2623
2821
    def __int__(self):
2641
2839
 
2642
2840
    def __init__(self, branch):
2643
2841
        self.branch = branch
 
2842
        self.ghosts_in_mainline = False
2644
2843
 
2645
2844
    def report_results(self, verbose):
2646
2845
        """Report the check results via trace.note.
2651
2850
        note('checked branch %s format %s',
2652
2851
             self.branch.base,
2653
2852
             self.branch._format)
 
2853
        if self.ghosts_in_mainline:
 
2854
            note('branch contains ghosts in mainline')
2654
2855
 
2655
2856
 
2656
2857
class Converter5to6(object):
2694
2895
        branch._transport.put_bytes('format', format.get_format_string())
2695
2896
 
2696
2897
 
 
2898
class Converter7to8(object):
 
2899
    """Perform an in-place upgrade of format 6 to format 7"""
 
2900
 
 
2901
    def convert(self, branch):
 
2902
        format = BzrBranchFormat8()
 
2903
        branch._transport.put_bytes('references', '')
 
2904
        # update target format
 
2905
        branch._transport.put_bytes('format', format.get_format_string())
 
2906
 
2697
2907
 
2698
2908
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2699
2909
    """Run ``callable(*args, **kwargs)``, write-locking target for the
2742
2952
    @staticmethod
2743
2953
    def _get_branch_formats_to_test():
2744
2954
        """Return a tuple with the Branch formats to use when testing."""
2745
 
        raise NotImplementedError(self._get_branch_formats_to_test)
 
2955
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
2956
 
 
2957
    def pull(self, overwrite=False, stop_revision=None,
 
2958
             possible_transports=None, local=False):
 
2959
        """Mirror source into target branch.
 
2960
 
 
2961
        The target branch is considered to be 'local', having low latency.
 
2962
 
 
2963
        :returns: PullResult instance
 
2964
        """
 
2965
        raise NotImplementedError(self.pull)
2746
2966
 
2747
2967
    def update_revisions(self, stop_revision=None, overwrite=False,
2748
2968
                         graph=None):
2757
2977
        """
2758
2978
        raise NotImplementedError(self.update_revisions)
2759
2979
 
 
2980
    def push(self, overwrite=False, stop_revision=None,
 
2981
             _override_hook_source_branch=None):
 
2982
        """Mirror the source branch into the target branch.
 
2983
 
 
2984
        The source branch is considered to be 'local', having low latency.
 
2985
        """
 
2986
        raise NotImplementedError(self.push)
 
2987
 
2760
2988
 
2761
2989
class GenericInterBranch(InterBranch):
2762
2990
    """InterBranch implementation that uses public Branch functions.
2809
3037
        finally:
2810
3038
            self.source.unlock()
2811
3039
 
 
3040
    def pull(self, overwrite=False, stop_revision=None,
 
3041
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3042
             _override_hook_target=None, local=False):
 
3043
        """See Branch.pull.
 
3044
 
 
3045
        :param _hook_master: Private parameter - set the branch to
 
3046
            be supplied as the master to pull hooks.
 
3047
        :param run_hooks: Private parameter - if false, this branch
 
3048
            is being called because it's the master of the primary branch,
 
3049
            so it should not run its hooks.
 
3050
        :param _override_hook_target: Private parameter - set the branch to be
 
3051
            supplied as the target_branch to pull hooks.
 
3052
        :param local: Only update the local branch, and not the bound branch.
 
3053
        """
 
3054
        # This type of branch can't be bound.
 
3055
        if local:
 
3056
            raise errors.LocalRequiresBoundBranch()
 
3057
        result = PullResult()
 
3058
        result.source_branch = self.source
 
3059
        if _override_hook_target is None:
 
3060
            result.target_branch = self.target
 
3061
        else:
 
3062
            result.target_branch = _override_hook_target
 
3063
        self.source.lock_read()
 
3064
        try:
 
3065
            # We assume that during 'pull' the target repository is closer than
 
3066
            # the source one.
 
3067
            self.source.update_references(self.target)
 
3068
            graph = self.target.repository.get_graph(self.source.repository)
 
3069
            # TODO: Branch formats should have a flag that indicates 
 
3070
            # that revno's are expensive, and pull() should honor that flag.
 
3071
            # -- JRV20090506
 
3072
            result.old_revno, result.old_revid = \
 
3073
                self.target.last_revision_info()
 
3074
            self.target.update_revisions(self.source, stop_revision,
 
3075
                overwrite=overwrite, graph=graph)
 
3076
            # TODO: The old revid should be specified when merging tags, 
 
3077
            # so a tags implementation that versions tags can only 
 
3078
            # pull in the most recent changes. -- JRV20090506
 
3079
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3080
                overwrite)
 
3081
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3082
            if _hook_master:
 
3083
                result.master_branch = _hook_master
 
3084
                result.local_branch = result.target_branch
 
3085
            else:
 
3086
                result.master_branch = result.target_branch
 
3087
                result.local_branch = None
 
3088
            if run_hooks:
 
3089
                for hook in Branch.hooks['post_pull']:
 
3090
                    hook(result)
 
3091
        finally:
 
3092
            self.source.unlock()
 
3093
        return result
 
3094
 
 
3095
    def push(self, overwrite=False, stop_revision=None,
 
3096
             _override_hook_source_branch=None):
 
3097
        """See InterBranch.push.
 
3098
 
 
3099
        This is the basic concrete implementation of push()
 
3100
 
 
3101
        :param _override_hook_source_branch: If specified, run
 
3102
        the hooks passing this Branch as the source, rather than self.
 
3103
        This is for use of RemoteBranch, where push is delegated to the
 
3104
        underlying vfs-based Branch.
 
3105
        """
 
3106
        # TODO: Public option to disable running hooks - should be trivial but
 
3107
        # needs tests.
 
3108
        self.source.lock_read()
 
3109
        try:
 
3110
            return _run_with_write_locked_target(
 
3111
                self.target, self._push_with_bound_branches, overwrite,
 
3112
                stop_revision,
 
3113
                _override_hook_source_branch=_override_hook_source_branch)
 
3114
        finally:
 
3115
            self.source.unlock()
 
3116
 
 
3117
    def _push_with_bound_branches(self, overwrite, stop_revision,
 
3118
            _override_hook_source_branch=None):
 
3119
        """Push from source into target, and into target's master if any.
 
3120
        """
 
3121
        def _run_hooks():
 
3122
            if _override_hook_source_branch:
 
3123
                result.source_branch = _override_hook_source_branch
 
3124
            for hook in Branch.hooks['post_push']:
 
3125
                hook(result)
 
3126
 
 
3127
        bound_location = self.target.get_bound_location()
 
3128
        if bound_location and self.target.base != bound_location:
 
3129
            # there is a master branch.
 
3130
            #
 
3131
            # XXX: Why the second check?  Is it even supported for a branch to
 
3132
            # be bound to itself? -- mbp 20070507
 
3133
            master_branch = self.target.get_master_branch()
 
3134
            master_branch.lock_write()
 
3135
            try:
 
3136
                # push into the master from the source branch.
 
3137
                self.source._basic_push(master_branch, overwrite, stop_revision)
 
3138
                # and push into the target branch from the source. Note that we
 
3139
                # push from the source branch again, because its considered the
 
3140
                # highest bandwidth repository.
 
3141
                result = self.source._basic_push(self.target, overwrite,
 
3142
                    stop_revision)
 
3143
                result.master_branch = master_branch
 
3144
                result.local_branch = self.target
 
3145
                _run_hooks()
 
3146
                return result
 
3147
            finally:
 
3148
                master_branch.unlock()
 
3149
        else:
 
3150
            # no master branch
 
3151
            result = self.source._basic_push(self.target, overwrite,
 
3152
                stop_revision)
 
3153
            # TODO: Why set master_branch and local_branch if there's no
 
3154
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3155
            # 20070504
 
3156
            result.master_branch = self.target
 
3157
            result.local_branch = None
 
3158
            _run_hooks()
 
3159
            return result
 
3160
 
2812
3161
    @classmethod
2813
3162
    def is_compatible(self, source, target):
2814
3163
        # GenericBranch uses the public API, so always compatible
2815
3164
        return True
2816
3165
 
2817
3166
 
 
3167
class InterToBranch5(GenericInterBranch):
 
3168
 
 
3169
    @staticmethod
 
3170
    def _get_branch_formats_to_test():
 
3171
        return BranchFormat._default_format, BzrBranchFormat5()
 
3172
 
 
3173
    def pull(self, overwrite=False, stop_revision=None,
 
3174
             possible_transports=None, run_hooks=True,
 
3175
             _override_hook_target=None, local=False):
 
3176
        """Pull from source into self, updating my master if any.
 
3177
 
 
3178
        :param run_hooks: Private parameter - if false, this branch
 
3179
            is being called because it's the master of the primary branch,
 
3180
            so it should not run its hooks.
 
3181
        """
 
3182
        bound_location = self.target.get_bound_location()
 
3183
        if local and not bound_location:
 
3184
            raise errors.LocalRequiresBoundBranch()
 
3185
        master_branch = None
 
3186
        if not local and bound_location and self.source.base != bound_location:
 
3187
            # not pulling from master, so we need to update master.
 
3188
            master_branch = self.target.get_master_branch(possible_transports)
 
3189
            master_branch.lock_write()
 
3190
        try:
 
3191
            if master_branch:
 
3192
                # pull from source into master.
 
3193
                master_branch.pull(self.source, overwrite, stop_revision,
 
3194
                    run_hooks=False)
 
3195
            return super(InterToBranch5, self).pull(overwrite,
 
3196
                stop_revision, _hook_master=master_branch,
 
3197
                run_hooks=run_hooks,
 
3198
                _override_hook_target=_override_hook_target)
 
3199
        finally:
 
3200
            if master_branch:
 
3201
                master_branch.unlock()
 
3202
 
 
3203
 
2818
3204
InterBranch.register_optimiser(GenericInterBranch)
 
3205
InterBranch.register_optimiser(InterToBranch5)