~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2010-06-28 02:41:22 UTC
  • mto: This revision was merged to the branch mainline in revision 5324.
  • Revision ID: robertc@robertcollins.net-20100628024122-g951fzp74f3u6wst
Sanity check that new_trace_file in pop_log_file is valid, and also fix a test that monkey patched get_terminal_encoding.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
24
24
from bzrlib import (
25
25
        bzrdir,
26
26
        cache_utf8,
27
 
        cleanup,
28
27
        config as _mod_config,
29
28
        debug,
30
29
        errors,
31
 
        fetch,
32
 
        graph as _mod_graph,
33
30
        lockdir,
34
31
        lockable_files,
35
32
        remote,
36
33
        repository,
37
34
        revision as _mod_revision,
38
35
        rio,
 
36
        symbol_versioning,
39
37
        transport,
 
38
        tsort,
40
39
        ui,
41
40
        urlutils,
42
41
        )
43
42
from bzrlib.config import BranchConfig, TransportConfig
 
43
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
44
44
from bzrlib.tag import (
45
45
    BasicTags,
46
46
    DisabledTags,
47
47
    )
48
48
""")
49
49
 
50
 
from bzrlib import (
51
 
    controldir,
52
 
    )
53
 
from bzrlib.decorators import (
54
 
    needs_read_lock,
55
 
    needs_write_lock,
56
 
    only_raises,
57
 
    )
58
 
from bzrlib.hooks import Hooks
 
50
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
51
from bzrlib.hooks import HookPoint, Hooks
59
52
from bzrlib.inter import InterObject
60
53
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
61
54
from bzrlib import registry
71
64
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
72
65
 
73
66
 
74
 
class Branch(controldir.ControlComponent):
 
67
class Branch(bzrdir.ControlComponent):
75
68
    """Branch holding a history of revisions.
76
69
 
77
70
    :ivar base:
78
71
        Base directory/url of the branch; using control_url and
79
72
        control_transport is more standardized.
80
 
    :ivar hooks: An instance of BranchHooks.
81
 
    :ivar _master_branch_cache: cached result of get_master_branch, see
82
 
        _clear_cached_state.
 
73
 
 
74
    hooks: An instance of BranchHooks.
83
75
    """
84
76
    # this is really an instance variable - FIXME move it there
85
77
    # - RBC 20060112
99
91
        self._revision_id_to_revno_cache = None
100
92
        self._partial_revision_id_to_revno_cache = {}
101
93
        self._partial_revision_history_cache = []
102
 
        self._tags_bytes = None
103
94
        self._last_revision_info_cache = None
104
 
        self._master_branch_cache = None
105
95
        self._merge_sorted_revisions_cache = None
106
96
        self._open_hook()
107
97
        hooks = Branch.hooks['open']
113
103
 
114
104
    def _activate_fallback_location(self, url):
115
105
        """Activate the branch/repository from url as a fallback repository."""
116
 
        for existing_fallback_repo in self.repository._fallback_repositories:
117
 
            if existing_fallback_repo.user_url == url:
118
 
                # This fallback is already configured.  This probably only
119
 
                # happens because BzrDir.sprout is a horrible mess.  To avoid
120
 
                # confusing _unstack we don't add this a second time.
121
 
                mutter('duplicate activation of fallback %r on %r', url, self)
122
 
                return
123
106
        repo = self._get_fallback_repository(url)
124
107
        if repo.has_same_location(self.repository):
125
108
            raise errors.UnstackableLocationError(self.user_url, url)
243
226
            possible_transports=[self.bzrdir.root_transport])
244
227
        return a_branch.repository
245
228
 
246
 
    @needs_read_lock
247
229
    def _get_tags_bytes(self):
248
230
        """Get the bytes of a serialised tags dict.
249
231
 
256
238
        :return: The bytes of the tags file.
257
239
        :seealso: Branch._set_tags_bytes.
258
240
        """
259
 
        if self._tags_bytes is None:
260
 
            self._tags_bytes = self._transport.get_bytes('tags')
261
 
        return self._tags_bytes
 
241
        return self._transport.get_bytes('tags')
262
242
 
263
243
    def _get_nick(self, local=False, possible_transports=None):
264
244
        config = self.get_config()
266
246
        if not local and not config.has_explicit_nickname():
267
247
            try:
268
248
                master = self.get_master_branch(possible_transports)
269
 
                if master and self.user_url == master.user_url:
270
 
                    raise errors.RecursiveBind(self.user_url)
271
249
                if master is not None:
272
250
                    # return the master branch value
273
251
                    return master.nick
274
 
            except errors.RecursiveBind, e:
275
 
                raise e
276
252
            except errors.BzrError, e:
277
253
                # Silently fall back to local implicit nick if the master is
278
254
                # unavailable
455
431
            after. If None, the rest of history is included.
456
432
        :param stop_rule: if stop_revision_id is not None, the precise rule
457
433
            to use for termination:
458
 
 
459
434
            * 'exclude' - leave the stop revision out of the result (default)
460
435
            * 'include' - the stop revision is the last item in the result
461
436
            * 'with-merges' - include the stop revision and all of its
463
438
            * 'with-merges-without-common-ancestry' - filter out revisions 
464
439
              that are in both ancestries
465
440
        :param direction: either 'reverse' or 'forward':
466
 
 
467
441
            * reverse means return the start_revision_id first, i.e.
468
442
              start at the most recent revision and go backwards in history
469
443
            * forward returns tuples in the opposite order to reverse.
513
487
        rev_iter = iter(merge_sorted_revisions)
514
488
        if start_revision_id is not None:
515
489
            for node in rev_iter:
516
 
                rev_id = node.key
 
490
                rev_id = node.key[-1]
517
491
                if rev_id != start_revision_id:
518
492
                    continue
519
493
                else:
525
499
        if stop_revision_id is None:
526
500
            # Yield everything
527
501
            for node in rev_iter:
528
 
                rev_id = node.key
 
502
                rev_id = node.key[-1]
529
503
                yield (rev_id, node.merge_depth, node.revno,
530
504
                       node.end_of_merge)
531
505
        elif stop_rule == 'exclude':
532
506
            for node in rev_iter:
533
 
                rev_id = node.key
 
507
                rev_id = node.key[-1]
534
508
                if rev_id == stop_revision_id:
535
509
                    return
536
510
                yield (rev_id, node.merge_depth, node.revno,
537
511
                       node.end_of_merge)
538
512
        elif stop_rule == 'include':
539
513
            for node in rev_iter:
540
 
                rev_id = node.key
 
514
                rev_id = node.key[-1]
541
515
                yield (rev_id, node.merge_depth, node.revno,
542
516
                       node.end_of_merge)
543
517
                if rev_id == stop_revision_id:
549
523
            ancestors = graph.find_unique_ancestors(start_revision_id,
550
524
                                                    [stop_revision_id])
551
525
            for node in rev_iter:
552
 
                rev_id = node.key
 
526
                rev_id = node.key[-1]
553
527
                if rev_id not in ancestors:
554
528
                    continue
555
529
                yield (rev_id, node.merge_depth, node.revno,
565
539
            reached_stop_revision_id = False
566
540
            revision_id_whitelist = []
567
541
            for node in rev_iter:
568
 
                rev_id = node.key
 
542
                rev_id = node.key[-1]
569
543
                if rev_id == left_parent:
570
544
                    # reached the left parent after the stop_revision
571
545
                    return
670
644
        raise errors.UnsupportedOperation(self.get_reference_info, self)
671
645
 
672
646
    @needs_write_lock
673
 
    def fetch(self, from_branch, last_revision=None, limit=None):
 
647
    def fetch(self, from_branch, last_revision=None, pb=None):
674
648
        """Copy revisions from from_branch into this branch.
675
649
 
676
650
        :param from_branch: Where to copy from.
677
651
        :param last_revision: What revision to stop at (None for at the end
678
652
                              of the branch.
679
 
        :param limit: Optional rough limit of revisions to fetch
 
653
        :param pb: An optional progress bar to use.
680
654
        :return: None
681
655
        """
682
 
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
 
656
        if self.base == from_branch.base:
 
657
            return (0, [])
 
658
        if pb is not None:
 
659
            symbol_versioning.warn(
 
660
                symbol_versioning.deprecated_in((1, 14, 0))
 
661
                % "pb parameter to fetch()")
 
662
        from_branch.lock_read()
 
663
        try:
 
664
            if last_revision is None:
 
665
                last_revision = from_branch.last_revision()
 
666
                last_revision = _mod_revision.ensure_null(last_revision)
 
667
            return self.repository.fetch(from_branch.repository,
 
668
                                         revision_id=last_revision,
 
669
                                         pb=pb)
 
670
        finally:
 
671
            from_branch.unlock()
683
672
 
684
673
    def get_bound_location(self):
685
674
        """Return the URL of the branch we are bound to.
696
685
 
697
686
    def get_commit_builder(self, parents, config=None, timestamp=None,
698
687
                           timezone=None, committer=None, revprops=None,
699
 
                           revision_id=None, lossy=False):
 
688
                           revision_id=None):
700
689
        """Obtain a CommitBuilder for this branch.
701
690
 
702
691
        :param parents: Revision ids of the parents of the new revision.
706
695
        :param committer: Optional committer to set for commit.
707
696
        :param revprops: Optional dictionary of revision properties.
708
697
        :param revision_id: Optional revision id.
709
 
        :param lossy: Whether to discard data that can not be natively
710
 
            represented, when pushing to a foreign VCS 
711
698
        """
712
699
 
713
700
        if config is None:
714
701
            config = self.get_config()
715
702
 
716
703
        return self.repository.get_commit_builder(self, parents, config,
717
 
            timestamp, timezone, committer, revprops, revision_id,
718
 
            lossy)
 
704
            timestamp, timezone, committer, revprops, revision_id)
719
705
 
720
706
    def get_master_branch(self, possible_transports=None):
721
707
        """Return the branch we are bound to.
748
734
        """Print `file` to stdout."""
749
735
        raise NotImplementedError(self.print_file)
750
736
 
751
 
    @deprecated_method(deprecated_in((2, 4, 0)))
752
737
    def set_revision_history(self, rev_history):
753
 
        """See Branch.set_revision_history."""
754
 
        self._set_revision_history(rev_history)
755
 
 
756
 
    @needs_write_lock
757
 
    def _set_revision_history(self, rev_history):
758
 
        if len(rev_history) == 0:
759
 
            revid = _mod_revision.NULL_REVISION
760
 
        else:
761
 
            revid = rev_history[-1]
762
 
        if rev_history != self._lefthand_history(revid):
763
 
            raise errors.NotLefthandHistory(rev_history)
764
 
        self.set_last_revision_info(len(rev_history), revid)
765
 
        self._cache_revision_history(rev_history)
766
 
        for hook in Branch.hooks['set_rh']:
767
 
            hook(self, rev_history)
768
 
 
769
 
    @needs_write_lock
770
 
    def set_last_revision_info(self, revno, revision_id):
771
 
        """Set the last revision of this branch.
772
 
 
773
 
        The caller is responsible for checking that the revno is correct
774
 
        for this revision id.
775
 
 
776
 
        It may be possible to set the branch last revision to an id not
777
 
        present in the repository.  However, branches can also be
778
 
        configured to check constraints on history, in which case this may not
779
 
        be permitted.
780
 
        """
781
 
        raise NotImplementedError(self.set_last_revision_info)
782
 
 
783
 
    @needs_write_lock
784
 
    def generate_revision_history(self, revision_id, last_rev=None,
785
 
                                  other_branch=None):
786
 
        """See Branch.generate_revision_history"""
787
 
        graph = self.repository.get_graph()
788
 
        known_revision_ids = [
789
 
            self.last_revision_info(),
790
 
            (_mod_revision.NULL_REVISION, 0),
791
 
            ]
792
 
        if last_rev is not None:
793
 
            if not graph.is_ancestor(last_rev, revision_id):
794
 
                # our previous tip is not merged into stop_revision
795
 
                raise errors.DivergedBranches(self, other_branch)
796
 
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
797
 
        self.set_last_revision_info(revno, revision_id)
 
738
        raise NotImplementedError(self.set_revision_history)
798
739
 
799
740
    @needs_write_lock
800
741
    def set_parent(self, url):
844
785
 
845
786
    def _unstack(self):
846
787
        """Change a branch to be unstacked, copying data as needed.
847
 
 
 
788
        
848
789
        Don't call this directly, use set_stacked_on_url(None).
849
790
        """
850
791
        pb = ui.ui_factory.nested_progress_bar()
859
800
            old_repository = self.repository
860
801
            if len(old_repository._fallback_repositories) != 1:
861
802
                raise AssertionError("can't cope with fallback repositories "
862
 
                    "of %r (fallbacks: %r)" % (old_repository,
863
 
                        old_repository._fallback_repositories))
864
 
            # Open the new repository object.
865
 
            # Repositories don't offer an interface to remove fallback
866
 
            # repositories today; take the conceptually simpler option and just
867
 
            # reopen it.  We reopen it starting from the URL so that we
868
 
            # get a separate connection for RemoteRepositories and can
869
 
            # stream from one of them to the other.  This does mean doing
870
 
            # separate SSH connection setup, but unstacking is not a
871
 
            # common operation so it's tolerable.
872
 
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
873
 
            new_repository = new_bzrdir.find_repository()
874
 
            if new_repository._fallback_repositories:
875
 
                raise AssertionError("didn't expect %r to have "
876
 
                    "fallback_repositories"
877
 
                    % (self.repository,))
878
 
            # Replace self.repository with the new repository.
879
 
            # Do our best to transfer the lock state (i.e. lock-tokens and
880
 
            # lock count) of self.repository to the new repository.
881
 
            lock_token = old_repository.lock_write().repository_token
882
 
            self.repository = new_repository
883
 
            if isinstance(self, remote.RemoteBranch):
884
 
                # Remote branches can have a second reference to the old
885
 
                # repository that need to be replaced.
886
 
                if self._real_branch is not None:
887
 
                    self._real_branch.repository = new_repository
888
 
            self.repository.lock_write(token=lock_token)
889
 
            if lock_token is not None:
890
 
                old_repository.leave_lock_in_place()
 
803
                    "of %r" % (self.repository,))
 
804
            # unlock it, including unlocking the fallback
891
805
            old_repository.unlock()
892
 
            if lock_token is not None:
893
 
                # XXX: self.repository.leave_lock_in_place() before this
894
 
                # function will not be preserved.  Fortunately that doesn't
895
 
                # affect the current default format (2a), and would be a
896
 
                # corner-case anyway.
897
 
                #  - Andrew Bennetts, 2010/06/30
898
 
                self.repository.dont_leave_lock_in_place()
899
 
            old_lock_count = 0
900
 
            while True:
901
 
                try:
902
 
                    old_repository.unlock()
903
 
                except errors.LockNotHeld:
904
 
                    break
905
 
                old_lock_count += 1
906
 
            if old_lock_count == 0:
907
 
                raise AssertionError(
908
 
                    'old_repository should have been locked at least once.')
909
 
            for i in range(old_lock_count-1):
 
806
            old_repository.lock_read()
 
807
            try:
 
808
                # Repositories don't offer an interface to remove fallback
 
809
                # repositories today; take the conceptually simpler option and just
 
810
                # reopen it.  We reopen it starting from the URL so that we
 
811
                # get a separate connection for RemoteRepositories and can
 
812
                # stream from one of them to the other.  This does mean doing
 
813
                # separate SSH connection setup, but unstacking is not a
 
814
                # common operation so it's tolerable.
 
815
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
816
                new_repository = new_bzrdir.find_repository()
 
817
                self.repository = new_repository
 
818
                if self.repository._fallback_repositories:
 
819
                    raise AssertionError("didn't expect %r to have "
 
820
                        "fallback_repositories"
 
821
                        % (self.repository,))
 
822
                # this is not paired with an unlock because it's just restoring
 
823
                # the previous state; the lock's released when set_stacked_on_url
 
824
                # returns
910
825
                self.repository.lock_write()
911
 
            # Fetch from the old repository into the new.
912
 
            old_repository.lock_read()
913
 
            try:
914
826
                # XXX: If you unstack a branch while it has a working tree
915
827
                # with a pending merge, the pending-merged revisions will no
916
828
                # longer be present.  You can (probably) revert and remerge.
917
 
                try:
918
 
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
919
 
                except errors.TagsNotSupported:
920
 
                    tags_to_fetch = set()
921
 
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
922
 
                    old_repository, required_ids=[self.last_revision()],
923
 
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
924
 
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
 
829
                #
 
830
                # XXX: This only fetches up to the tip of the repository; it
 
831
                # doesn't bring across any tags.  That's fairly consistent
 
832
                # with how branch works, but perhaps not ideal.
 
833
                self.repository.fetch(old_repository,
 
834
                    revision_id=self.last_revision(),
 
835
                    find_ghosts=True)
925
836
            finally:
926
837
                old_repository.unlock()
927
838
        finally:
932
843
 
933
844
        :seealso: Branch._get_tags_bytes.
934
845
        """
935
 
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
936
 
        op.add_cleanup(self.lock_write().unlock)
937
 
        return op.run_simple(bytes)
938
 
 
939
 
    def _set_tags_bytes_locked(self, bytes):
940
 
        self._tags_bytes = bytes
941
 
        return self._transport.put_bytes('tags', bytes)
 
846
        return _run_with_write_locked_target(self, self._transport.put_bytes,
 
847
            'tags', bytes)
942
848
 
943
849
    def _cache_revision_history(self, rev_history):
944
850
        """Set the cached revision history to rev_history.
971
877
        self._revision_history_cache = None
972
878
        self._revision_id_to_revno_cache = None
973
879
        self._last_revision_info_cache = None
974
 
        self._master_branch_cache = None
975
880
        self._merge_sorted_revisions_cache = None
976
881
        self._partial_revision_history_cache = []
977
882
        self._partial_revision_id_to_revno_cache = {}
978
 
        self._tags_bytes = None
979
883
 
980
884
    def _gen_revision_history(self):
981
885
        """Return sequence of revision hashes on to this branch.
1031
935
        :return: A tuple (revno, revision_id).
1032
936
        """
1033
937
        if self._last_revision_info_cache is None:
1034
 
            self._last_revision_info_cache = self._read_last_revision_info()
 
938
            self._last_revision_info_cache = self._last_revision_info()
1035
939
        return self._last_revision_info_cache
1036
940
 
1037
 
    def _read_last_revision_info(self):
1038
 
        raise NotImplementedError(self._read_last_revision_info)
1039
 
 
1040
 
    @deprecated_method(deprecated_in((2, 4, 0)))
 
941
    def _last_revision_info(self):
 
942
        rh = self.revision_history()
 
943
        revno = len(rh)
 
944
        if revno:
 
945
            return (revno, rh[-1])
 
946
        else:
 
947
            return (0, _mod_revision.NULL_REVISION)
 
948
 
 
949
    @deprecated_method(deprecated_in((1, 6, 0)))
 
950
    def missing_revisions(self, other, stop_revision=None):
 
951
        """Return a list of new revisions that would perfectly fit.
 
952
 
 
953
        If self and other have not diverged, return a list of the revisions
 
954
        present in other, but missing from self.
 
955
        """
 
956
        self_history = self.revision_history()
 
957
        self_len = len(self_history)
 
958
        other_history = other.revision_history()
 
959
        other_len = len(other_history)
 
960
        common_index = min(self_len, other_len) -1
 
961
        if common_index >= 0 and \
 
962
            self_history[common_index] != other_history[common_index]:
 
963
            raise errors.DivergedBranches(self, other)
 
964
 
 
965
        if stop_revision is None:
 
966
            stop_revision = other_len
 
967
        else:
 
968
            if stop_revision > other_len:
 
969
                raise errors.NoSuchRevision(self, stop_revision)
 
970
        return other_history[self_len:stop_revision]
 
971
 
 
972
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
973
                         graph=None):
 
974
        """Pull in new perfect-fit revisions.
 
975
 
 
976
        :param other: Another Branch to pull from
 
977
        :param stop_revision: Updated until the given revision
 
978
        :param overwrite: Always set the branch pointer, rather than checking
 
979
            to see if it is a proper descendant.
 
980
        :param graph: A Graph object that can be used to query history
 
981
            information. This can be None.
 
982
        :return: None
 
983
        """
 
984
        return InterBranch.get(other, self).update_revisions(stop_revision,
 
985
            overwrite, graph)
 
986
 
1041
987
    def import_last_revision_info(self, source_repo, revno, revid):
1042
988
        """Set the last revision info, importing from another repo if necessary.
1043
989
 
 
990
        This is used by the bound branch code to upload a revision to
 
991
        the master branch first before updating the tip of the local branch.
 
992
 
1044
993
        :param source_repo: Source repository to optionally fetch from
1045
994
        :param revno: Revision number of the new tip
1046
995
        :param revid: Revision id of the new tip
1049
998
            self.repository.fetch(source_repo, revision_id=revid)
1050
999
        self.set_last_revision_info(revno, revid)
1051
1000
 
1052
 
    def import_last_revision_info_and_tags(self, source, revno, revid,
1053
 
                                           lossy=False):
1054
 
        """Set the last revision info, importing from another repo if necessary.
1055
 
 
1056
 
        This is used by the bound branch code to upload a revision to
1057
 
        the master branch first before updating the tip of the local branch.
1058
 
        Revisions referenced by source's tags are also transferred.
1059
 
 
1060
 
        :param source: Source branch to optionally fetch from
1061
 
        :param revno: Revision number of the new tip
1062
 
        :param revid: Revision id of the new tip
1063
 
        :param lossy: Whether to discard metadata that can not be
1064
 
            natively represented
1065
 
        :return: Tuple with the new revision number and revision id
1066
 
            (should only be different from the arguments when lossy=True)
1067
 
        """
1068
 
        if not self.repository.has_same_location(source.repository):
1069
 
            self.fetch(source, revid)
1070
 
        self.set_last_revision_info(revno, revid)
1071
 
        return (revno, revid)
1072
 
 
1073
1001
    def revision_id_to_revno(self, revision_id):
1074
1002
        """Given a revision id, return its revno"""
1075
1003
        if _mod_revision.is_null(revision_id):
1107
1035
            stop_revision=stop_revision,
1108
1036
            possible_transports=possible_transports, *args, **kwargs)
1109
1037
 
1110
 
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1111
 
            *args, **kwargs):
 
1038
    def push(self, target, overwrite=False, stop_revision=None, *args,
 
1039
        **kwargs):
1112
1040
        """Mirror this branch into target.
1113
1041
 
1114
1042
        This branch is considered to be 'local', having low latency.
1115
1043
        """
1116
1044
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1117
 
            lossy, *args, **kwargs)
 
1045
            *args, **kwargs)
 
1046
 
 
1047
    def lossy_push(self, target, stop_revision=None):
 
1048
        """Push deltas into another branch.
 
1049
 
 
1050
        :note: This does not, like push, retain the revision ids from 
 
1051
            the source branch and will, rather than adding bzr-specific 
 
1052
            metadata, push only those semantics of the revision that can be 
 
1053
            natively represented by this branch' VCS.
 
1054
 
 
1055
        :param target: Target branch
 
1056
        :param stop_revision: Revision to push, defaults to last revision.
 
1057
        :return: BranchPushResult with an extra member revidmap: 
 
1058
            A dictionary mapping revision ids from the target branch 
 
1059
            to new revision ids in the target branch, for each 
 
1060
            revision that was pushed.
 
1061
        """
 
1062
        inter = InterBranch.get(self, target)
 
1063
        lossy_push = getattr(inter, "lossy_push", None)
 
1064
        if lossy_push is None:
 
1065
            raise errors.LossyPushToSameVCS(self, target)
 
1066
        return lossy_push(stop_revision)
1118
1067
 
1119
1068
    def basis_tree(self):
1120
1069
        """Return `Tree` object for last revision."""
1275
1224
        return result
1276
1225
 
1277
1226
    @needs_read_lock
1278
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1279
 
            repository=None):
 
1227
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1280
1228
        """Create a new line of development from the branch, into to_bzrdir.
1281
1229
 
1282
1230
        to_bzrdir controls the branch format.
1287
1235
        if (repository_policy is not None and
1288
1236
            repository_policy.requires_stacking()):
1289
1237
            to_bzrdir._format.require_stacking(_skip_repo=True)
1290
 
        result = to_bzrdir.create_branch(repository=repository)
 
1238
        result = to_bzrdir.create_branch()
1291
1239
        result.lock_write()
1292
1240
        try:
1293
1241
            if repository_policy is not None:
1294
1242
                repository_policy.configure_branch(result)
1295
1243
            self.copy_content_into(result, revision_id=revision_id)
1296
 
            master_branch = self.get_master_branch()
1297
 
            if master_branch is None:
1298
 
                result.set_parent(self.bzrdir.root_transport.base)
1299
 
            else:
1300
 
                result.set_parent(master_branch.bzrdir.root_transport.base)
 
1244
            result.set_parent(self.bzrdir.root_transport.base)
1301
1245
        finally:
1302
1246
            result.unlock()
1303
1247
        return result
1385
1329
        """Return the most suitable metadir for a checkout of this branch.
1386
1330
        Weaves are used if this branch's repository uses weaves.
1387
1331
        """
1388
 
        format = self.repository.bzrdir.checkout_metadir()
1389
 
        format.set_branch_format(self._format)
 
1332
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
 
1333
            from bzrlib.repofmt import weaverepo
 
1334
            format = bzrdir.BzrDirMetaFormat1()
 
1335
            format.repository_format = weaverepo.RepositoryFormat7()
 
1336
        else:
 
1337
            format = self.repository.bzrdir.checkout_metadir()
 
1338
            format.set_branch_format(self._format)
1390
1339
        return format
1391
1340
 
1392
1341
    def create_clone_on_transport(self, to_transport, revision_id=None,
1393
 
        stacked_on=None, create_prefix=False, use_existing_dir=False,
1394
 
        no_tree=None):
 
1342
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1395
1343
        """Create a clone of this branch and its bzrdir.
1396
1344
 
1397
1345
        :param to_transport: The transport to clone onto.
1410
1358
            revision_id = self.last_revision()
1411
1359
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1412
1360
            revision_id=revision_id, stacked_on=stacked_on,
1413
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1414
 
            no_tree=no_tree)
 
1361
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1415
1362
        return dir_to.open_branch()
1416
1363
 
1417
1364
    def create_checkout(self, to_location, revision_id=None,
1422
1369
        :param to_location: The url to produce the checkout at
1423
1370
        :param revision_id: The revision to check out
1424
1371
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1425
 
            produce a bound branch (heavyweight checkout)
 
1372
        produce a bound branch (heavyweight checkout)
1426
1373
        :param accelerator_tree: A tree which can be used for retrieving file
1427
1374
            contents more quickly than the revision tree, i.e. a workingtree.
1428
1375
            The revision tree will be used for cases where accelerator_tree's
1474
1421
 
1475
1422
    def reference_parent(self, file_id, path, possible_transports=None):
1476
1423
        """Return the parent branch for a tree-reference file_id
1477
 
 
1478
1424
        :param file_id: The file_id of the tree reference
1479
1425
        :param path: The path of the file_id in the tree
1480
1426
        :return: A branch associated with the file_id
1533
1479
        else:
1534
1480
            raise AssertionError("invalid heads: %r" % (heads,))
1535
1481
 
1536
 
    def heads_to_fetch(self):
1537
 
        """Return the heads that must and that should be fetched to copy this
1538
 
        branch into another repo.
1539
 
 
1540
 
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
1541
 
            set of heads that must be fetched.  if_present_fetch is a set of
1542
 
            heads that must be fetched if present, but no error is necessary if
1543
 
            they are not present.
1544
 
        """
1545
 
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
1546
 
        # are the tags.
1547
 
        must_fetch = set([self.last_revision()])
1548
 
        try:
1549
 
            if_present_fetch = set(self.tags.get_reverse_tag_dict())
1550
 
        except errors.TagsNotSupported:
1551
 
            if_present_fetch = set()
1552
 
        must_fetch.discard(_mod_revision.NULL_REVISION)
1553
 
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
1554
 
        return must_fetch, if_present_fetch
1555
 
 
1556
 
 
1557
 
class BranchFormat(controldir.ControlComponentFormat):
 
1482
 
 
1483
class BranchFormat(object):
1558
1484
    """An encapsulation of the initialization and open routines for a format.
1559
1485
 
1560
1486
    Formats provide three things:
1563
1489
     * an open routine.
1564
1490
 
1565
1491
    Formats are placed in an dict by their format string for reference
1566
 
    during branch opening. It's not required that these be instances, they
 
1492
    during branch opening. Its not required that these be instances, they
1567
1493
    can be classes themselves with class methods - it simply depends on
1568
1494
    whether state is needed for a given format or not.
1569
1495
 
1572
1498
    object will be created every time regardless.
1573
1499
    """
1574
1500
 
 
1501
    _default_format = None
 
1502
    """The default format used for new branches."""
 
1503
 
 
1504
    _formats = {}
 
1505
    """The known formats."""
 
1506
 
1575
1507
    can_set_append_revisions_only = True
1576
1508
 
1577
1509
    def __eq__(self, other):
1586
1518
        try:
1587
1519
            transport = a_bzrdir.get_branch_transport(None, name=name)
1588
1520
            format_string = transport.get_bytes("format")
1589
 
            return format_registry.get(format_string)
 
1521
            format = klass._formats[format_string]
 
1522
            if isinstance(format, MetaDirBranchFormatFactory):
 
1523
                return format()
 
1524
            return format
1590
1525
        except errors.NoSuchFile:
1591
1526
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1592
1527
        except KeyError:
1593
1528
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1594
1529
 
1595
1530
    @classmethod
1596
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1597
1531
    def get_default_format(klass):
1598
1532
        """Return the current default format."""
1599
 
        return format_registry.get_default()
 
1533
        return klass._default_format
1600
1534
 
1601
1535
    @classmethod
1602
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1603
1536
    def get_formats(klass):
1604
1537
        """Get all the known formats.
1605
1538
 
1606
1539
        Warning: This triggers a load of all lazy registered formats: do not
1607
1540
        use except when that is desireed.
1608
1541
        """
1609
 
        return format_registry._get_all()
 
1542
        result = []
 
1543
        for fmt in klass._formats.values():
 
1544
            if isinstance(fmt, MetaDirBranchFormatFactory):
 
1545
                fmt = fmt()
 
1546
            result.append(fmt)
 
1547
        return result
1610
1548
 
1611
1549
    def get_reference(self, a_bzrdir, name=None):
1612
1550
        """Get the target reference of the branch in a_bzrdir.
1651
1589
        for hook in hooks:
1652
1590
            hook(params)
1653
1591
 
1654
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1592
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
1593
                           lock_type='metadir', set_format=True):
 
1594
        """Initialize a branch in a bzrdir, with specified files
 
1595
 
 
1596
        :param a_bzrdir: The bzrdir to initialize the branch in
 
1597
        :param utf8_files: The files to create as a list of
 
1598
            (filename, content) tuples
 
1599
        :param name: Name of colocated branch to create, if any
 
1600
        :param set_format: If True, set the format with
 
1601
            self.get_format_string.  (BzrBranch4 has its format set
 
1602
            elsewhere)
 
1603
        :return: a branch in this format
 
1604
        """
 
1605
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1606
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1607
        lock_map = {
 
1608
            'metadir': ('lock', lockdir.LockDir),
 
1609
            'branch4': ('branch-lock', lockable_files.TransportLock),
 
1610
        }
 
1611
        lock_name, lock_class = lock_map[lock_type]
 
1612
        control_files = lockable_files.LockableFiles(branch_transport,
 
1613
            lock_name, lock_class)
 
1614
        control_files.create_lock()
 
1615
        try:
 
1616
            control_files.lock_write()
 
1617
        except errors.LockContention:
 
1618
            if lock_type != 'branch4':
 
1619
                raise
 
1620
            lock_taken = False
 
1621
        else:
 
1622
            lock_taken = True
 
1623
        if set_format:
 
1624
            utf8_files += [('format', self.get_format_string())]
 
1625
        try:
 
1626
            for (filename, content) in utf8_files:
 
1627
                branch_transport.put_bytes(
 
1628
                    filename, content,
 
1629
                    mode=a_bzrdir._get_file_mode())
 
1630
        finally:
 
1631
            if lock_taken:
 
1632
                control_files.unlock()
 
1633
        branch = self.open(a_bzrdir, name, _found=True)
 
1634
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
1635
        return branch
 
1636
 
 
1637
    def initialize(self, a_bzrdir, name=None):
1655
1638
        """Create a branch of this format in a_bzrdir.
1656
1639
        
1657
1640
        :param name: Name of the colocated branch to create.
1691
1674
        """
1692
1675
        raise NotImplementedError(self.network_name)
1693
1676
 
1694
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1695
 
            found_repository=None):
 
1677
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1696
1678
        """Return the branch object for a_bzrdir
1697
1679
 
1698
1680
        :param a_bzrdir: A BzrDir that contains a branch.
1705
1687
        raise NotImplementedError(self.open)
1706
1688
 
1707
1689
    @classmethod
1708
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1709
1690
    def register_format(klass, format):
1710
1691
        """Register a metadir format.
1711
 
 
 
1692
        
1712
1693
        See MetaDirBranchFormatFactory for the ability to register a format
1713
1694
        without loading the code the format needs until it is actually used.
1714
1695
        """
1715
 
        format_registry.register(format)
 
1696
        klass._formats[format.get_format_string()] = format
 
1697
        # Metadir formats have a network name of their format string, and get
 
1698
        # registered as factories.
 
1699
        if isinstance(format, MetaDirBranchFormatFactory):
 
1700
            network_format_registry.register(format.get_format_string(), format)
 
1701
        else:
 
1702
            network_format_registry.register(format.get_format_string(),
 
1703
                format.__class__)
1716
1704
 
1717
1705
    @classmethod
1718
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1719
1706
    def set_default_format(klass, format):
1720
 
        format_registry.set_default(format)
 
1707
        klass._default_format = format
1721
1708
 
1722
1709
    def supports_set_append_revisions_only(self):
1723
1710
        """True if this format supports set_append_revisions_only."""
1727
1714
        """True if this format records a stacked-on branch."""
1728
1715
        return False
1729
1716
 
1730
 
    def supports_leaving_lock(self):
1731
 
        """True if this format supports leaving locks in place."""
1732
 
        return False # by default
1733
 
 
1734
1717
    @classmethod
1735
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1736
1718
    def unregister_format(klass, format):
1737
 
        format_registry.remove(format)
 
1719
        del klass._formats[format.get_format_string()]
1738
1720
 
1739
1721
    def __str__(self):
1740
1722
        return self.get_format_description().rstrip()
1785
1767
        These are all empty initially, because by default nothing should get
1786
1768
        notified.
1787
1769
        """
1788
 
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1789
 
        self.add_hook('set_rh',
 
1770
        Hooks.__init__(self)
 
1771
        self.create_hook(HookPoint('set_rh',
1790
1772
            "Invoked whenever the revision history has been set via "
1791
1773
            "set_revision_history. The api signature is (branch, "
1792
1774
            "revision_history), and the branch will be write-locked. "
1793
1775
            "The set_rh hook can be expensive for bzr to trigger, a better "
1794
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
1795
 
        self.add_hook('open',
 
1776
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
 
1777
        self.create_hook(HookPoint('open',
1796
1778
            "Called with the Branch object that has been opened after a "
1797
 
            "branch is opened.", (1, 8))
1798
 
        self.add_hook('post_push',
 
1779
            "branch is opened.", (1, 8), None))
 
1780
        self.create_hook(HookPoint('post_push',
1799
1781
            "Called after a push operation completes. post_push is called "
1800
1782
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1801
 
            "bzr client.", (0, 15))
1802
 
        self.add_hook('post_pull',
 
1783
            "bzr client.", (0, 15), None))
 
1784
        self.create_hook(HookPoint('post_pull',
1803
1785
            "Called after a pull operation completes. post_pull is called "
1804
1786
            "with a bzrlib.branch.PullResult object and only runs in the "
1805
 
            "bzr client.", (0, 15))
1806
 
        self.add_hook('pre_commit',
1807
 
            "Called after a commit is calculated but before it is "
 
1787
            "bzr client.", (0, 15), None))
 
1788
        self.create_hook(HookPoint('pre_commit',
 
1789
            "Called after a commit is calculated but before it is is "
1808
1790
            "completed. pre_commit is called with (local, master, old_revno, "
1809
1791
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1810
1792
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1812
1794
            "basis revision. hooks MUST NOT modify this delta. "
1813
1795
            " future_tree is an in-memory tree obtained from "
1814
1796
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1815
 
            "tree.", (0,91))
1816
 
        self.add_hook('post_commit',
 
1797
            "tree.", (0,91), None))
 
1798
        self.create_hook(HookPoint('post_commit',
1817
1799
            "Called in the bzr client after a commit has completed. "
1818
1800
            "post_commit is called with (local, master, old_revno, old_revid, "
1819
1801
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1820
 
            "commit to a branch.", (0, 15))
1821
 
        self.add_hook('post_uncommit',
 
1802
            "commit to a branch.", (0, 15), None))
 
1803
        self.create_hook(HookPoint('post_uncommit',
1822
1804
            "Called in the bzr client after an uncommit completes. "
1823
1805
            "post_uncommit is called with (local, master, old_revno, "
1824
1806
            "old_revid, new_revno, new_revid) where local is the local branch "
1825
1807
            "or None, master is the target branch, and an empty branch "
1826
 
            "receives new_revno of 0, new_revid of None.", (0, 15))
1827
 
        self.add_hook('pre_change_branch_tip',
 
1808
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1809
        self.create_hook(HookPoint('pre_change_branch_tip',
1828
1810
            "Called in bzr client and server before a change to the tip of a "
1829
1811
            "branch is made. pre_change_branch_tip is called with a "
1830
1812
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1831
 
            "commit, uncommit will all trigger this hook.", (1, 6))
1832
 
        self.add_hook('post_change_branch_tip',
 
1813
            "commit, uncommit will all trigger this hook.", (1, 6), None))
 
1814
        self.create_hook(HookPoint('post_change_branch_tip',
1833
1815
            "Called in bzr client and server after a change to the tip of a "
1834
1816
            "branch is made. post_change_branch_tip is called with a "
1835
1817
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1836
 
            "commit, uncommit will all trigger this hook.", (1, 4))
1837
 
        self.add_hook('transform_fallback_location',
 
1818
            "commit, uncommit will all trigger this hook.", (1, 4), None))
 
1819
        self.create_hook(HookPoint('transform_fallback_location',
1838
1820
            "Called when a stacked branch is activating its fallback "
1839
1821
            "locations. transform_fallback_location is called with (branch, "
1840
1822
            "url), and should return a new url. Returning the same url "
1845
1827
            "fallback locations have not been activated. When there are "
1846
1828
            "multiple hooks installed for transform_fallback_location, "
1847
1829
            "all are called with the url returned from the previous hook."
1848
 
            "The order is however undefined.", (1, 9))
1849
 
        self.add_hook('automatic_tag_name',
1850
 
            "Called to determine an automatic tag name for a revision. "
 
1830
            "The order is however undefined.", (1, 9), None))
 
1831
        self.create_hook(HookPoint('automatic_tag_name',
 
1832
            "Called to determine an automatic tag name for a revision."
1851
1833
            "automatic_tag_name is called with (branch, revision_id) and "
1852
1834
            "should return a tag name or None if no tag name could be "
1853
1835
            "determined. The first non-None tag name returned will be used.",
1854
 
            (2, 2))
1855
 
        self.add_hook('post_branch_init',
 
1836
            (2, 2), None))
 
1837
        self.create_hook(HookPoint('post_branch_init',
1856
1838
            "Called after new branch initialization completes. "
1857
1839
            "post_branch_init is called with a "
1858
1840
            "bzrlib.branch.BranchInitHookParams. "
1859
1841
            "Note that init, branch and checkout (both heavyweight and "
1860
 
            "lightweight) will all trigger this hook.", (2, 2))
1861
 
        self.add_hook('post_switch',
 
1842
            "lightweight) will all trigger this hook.", (2, 2), None))
 
1843
        self.create_hook(HookPoint('post_switch',
1862
1844
            "Called after a checkout switches branch. "
1863
1845
            "post_switch is called with a "
1864
 
            "bzrlib.branch.SwitchHookParams.", (2, 2))
 
1846
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1865
1847
 
1866
1848
 
1867
1849
 
1870
1852
 
1871
1853
 
1872
1854
class ChangeBranchTipParams(object):
1873
 
    """Object holding parameters passed to `*_change_branch_tip` hooks.
 
1855
    """Object holding parameters passed to *_change_branch_tip hooks.
1874
1856
 
1875
1857
    There are 5 fields that hooks may wish to access:
1876
1858
 
1908
1890
 
1909
1891
 
1910
1892
class BranchInitHookParams(object):
1911
 
    """Object holding parameters passed to `*_branch_init` hooks.
 
1893
    """Object holding parameters passed to *_branch_init hooks.
1912
1894
 
1913
1895
    There are 4 fields that hooks may wish to access:
1914
1896
 
1944
1926
        return self.__dict__ == other.__dict__
1945
1927
 
1946
1928
    def __repr__(self):
1947
 
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
 
1929
        if self.branch:
 
1930
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
 
1931
        else:
 
1932
            return "<%s of format:%s bzrdir:%s>" % (
 
1933
                self.__class__.__name__, self.branch,
 
1934
                self.format, self.bzrdir)
1948
1935
 
1949
1936
 
1950
1937
class SwitchHookParams(object):
1951
 
    """Object holding parameters passed to `*_switch` hooks.
 
1938
    """Object holding parameters passed to *_switch hooks.
1952
1939
 
1953
1940
    There are 4 fields that hooks may wish to access:
1954
1941
 
1980
1967
            self.revision_id)
1981
1968
 
1982
1969
 
 
1970
class BzrBranchFormat4(BranchFormat):
 
1971
    """Bzr branch format 4.
 
1972
 
 
1973
    This format has:
 
1974
     - a revision-history file.
 
1975
     - a branch-lock lock file [ to be shared with the bzrdir ]
 
1976
    """
 
1977
 
 
1978
    def get_format_description(self):
 
1979
        """See BranchFormat.get_format_description()."""
 
1980
        return "Branch format 4"
 
1981
 
 
1982
    def initialize(self, a_bzrdir, name=None):
 
1983
        """Create a branch of this format in a_bzrdir."""
 
1984
        utf8_files = [('revision-history', ''),
 
1985
                      ('branch-name', ''),
 
1986
                      ]
 
1987
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1988
                                       lock_type='branch4', set_format=False)
 
1989
 
 
1990
    def __init__(self):
 
1991
        super(BzrBranchFormat4, self).__init__()
 
1992
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
1993
 
 
1994
    def network_name(self):
 
1995
        """The network name for this format is the control dirs disk label."""
 
1996
        return self._matchingbzrdir.get_format_string()
 
1997
 
 
1998
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1999
        """See BranchFormat.open()."""
 
2000
        if not _found:
 
2001
            # we are being called directly and must probe.
 
2002
            raise NotImplementedError
 
2003
        return BzrBranch(_format=self,
 
2004
                         _control_files=a_bzrdir._control_files,
 
2005
                         a_bzrdir=a_bzrdir,
 
2006
                         name=name,
 
2007
                         _repository=a_bzrdir.open_repository())
 
2008
 
 
2009
    def __str__(self):
 
2010
        return "Bazaar-NG branch format 4"
 
2011
 
 
2012
 
1983
2013
class BranchFormatMetadir(BranchFormat):
1984
2014
    """Common logic for meta-dir based branch formats."""
1985
2015
 
1987
2017
        """What class to instantiate on open calls."""
1988
2018
        raise NotImplementedError(self._branch_class)
1989
2019
 
1990
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1991
 
                           repository=None):
1992
 
        """Initialize a branch in a bzrdir, with specified files
1993
 
 
1994
 
        :param a_bzrdir: The bzrdir to initialize the branch in
1995
 
        :param utf8_files: The files to create as a list of
1996
 
            (filename, content) tuples
1997
 
        :param name: Name of colocated branch to create, if any
1998
 
        :return: a branch in this format
1999
 
        """
2000
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2001
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2002
 
        control_files = lockable_files.LockableFiles(branch_transport,
2003
 
            'lock', lockdir.LockDir)
2004
 
        control_files.create_lock()
2005
 
        control_files.lock_write()
2006
 
        try:
2007
 
            utf8_files += [('format', self.get_format_string())]
2008
 
            for (filename, content) in utf8_files:
2009
 
                branch_transport.put_bytes(
2010
 
                    filename, content,
2011
 
                    mode=a_bzrdir._get_file_mode())
2012
 
        finally:
2013
 
            control_files.unlock()
2014
 
        branch = self.open(a_bzrdir, name, _found=True,
2015
 
                found_repository=repository)
2016
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2017
 
        return branch
2018
 
 
2019
2020
    def network_name(self):
2020
2021
        """A simple byte string uniquely identifying this format for RPC calls.
2021
2022
 
2023
2024
        """
2024
2025
        return self.get_format_string()
2025
2026
 
2026
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2027
 
            found_repository=None):
 
2027
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2028
2028
        """See BranchFormat.open()."""
2029
2029
        if not _found:
2030
2030
            format = BranchFormat.find_format(a_bzrdir, name=name)
2035
2035
        try:
2036
2036
            control_files = lockable_files.LockableFiles(transport, 'lock',
2037
2037
                                                         lockdir.LockDir)
2038
 
            if found_repository is None:
2039
 
                found_repository = a_bzrdir.find_repository()
2040
2038
            return self._branch_class()(_format=self,
2041
2039
                              _control_files=control_files,
2042
2040
                              name=name,
2043
2041
                              a_bzrdir=a_bzrdir,
2044
 
                              _repository=found_repository,
 
2042
                              _repository=a_bzrdir.find_repository(),
2045
2043
                              ignore_fallbacks=ignore_fallbacks)
2046
2044
        except errors.NoSuchFile:
2047
2045
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2054
2052
    def supports_tags(self):
2055
2053
        return True
2056
2054
 
2057
 
    def supports_leaving_lock(self):
2058
 
        return True
2059
 
 
2060
2055
 
2061
2056
class BzrBranchFormat5(BranchFormatMetadir):
2062
2057
    """Bzr branch format 5.
2082
2077
        """See BranchFormat.get_format_description()."""
2083
2078
        return "Branch format 5"
2084
2079
 
2085
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2080
    def initialize(self, a_bzrdir, name=None):
2086
2081
        """Create a branch of this format in a_bzrdir."""
2087
2082
        utf8_files = [('revision-history', ''),
2088
2083
                      ('branch-name', ''),
2089
2084
                      ]
2090
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
2085
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2091
2086
 
2092
2087
    def supports_tags(self):
2093
2088
        return False
2115
2110
        """See BranchFormat.get_format_description()."""
2116
2111
        return "Branch format 6"
2117
2112
 
2118
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2113
    def initialize(self, a_bzrdir, name=None):
2119
2114
        """Create a branch of this format in a_bzrdir."""
2120
2115
        utf8_files = [('last-revision', '0 null:\n'),
2121
2116
                      ('branch.conf', ''),
2122
2117
                      ('tags', ''),
2123
2118
                      ]
2124
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
2119
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2125
2120
 
2126
2121
    def make_tags(self, branch):
2127
2122
        """See bzrlib.branch.BranchFormat.make_tags()."""
2145
2140
        """See BranchFormat.get_format_description()."""
2146
2141
        return "Branch format 8"
2147
2142
 
2148
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2143
    def initialize(self, a_bzrdir, name=None):
2149
2144
        """Create a branch of this format in a_bzrdir."""
2150
2145
        utf8_files = [('last-revision', '0 null:\n'),
2151
2146
                      ('branch.conf', ''),
2152
2147
                      ('tags', ''),
2153
2148
                      ('references', '')
2154
2149
                      ]
2155
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
2150
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2151
 
 
2152
    def __init__(self):
 
2153
        super(BzrBranchFormat8, self).__init__()
 
2154
        self._matchingbzrdir.repository_format = \
 
2155
            RepositoryFormatKnitPack5RichRoot()
2156
2156
 
2157
2157
    def make_tags(self, branch):
2158
2158
        """See bzrlib.branch.BranchFormat.make_tags()."""
2167
2167
    supports_reference_locations = True
2168
2168
 
2169
2169
 
2170
 
class BzrBranchFormat7(BranchFormatMetadir):
 
2170
class BzrBranchFormat7(BzrBranchFormat8):
2171
2171
    """Branch format with last-revision, tags, and a stacked location pointer.
2172
2172
 
2173
2173
    The stacked location pointer is passed down to the repository and requires
2176
2176
    This format was introduced in bzr 1.6.
2177
2177
    """
2178
2178
 
2179
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2179
    def initialize(self, a_bzrdir, name=None):
2180
2180
        """Create a branch of this format in a_bzrdir."""
2181
2181
        utf8_files = [('last-revision', '0 null:\n'),
2182
2182
                      ('branch.conf', ''),
2183
2183
                      ('tags', ''),
2184
2184
                      ]
2185
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
2185
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2186
2186
 
2187
2187
    def _branch_class(self):
2188
2188
        return BzrBranch7
2198
2198
    def supports_set_append_revisions_only(self):
2199
2199
        return True
2200
2200
 
2201
 
    def supports_stacking(self):
2202
 
        return True
2203
 
 
2204
 
    def make_tags(self, branch):
2205
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2206
 
        return BasicTags(branch)
2207
 
 
2208
2201
    supports_reference_locations = False
2209
2202
 
2210
2203
 
2237
2230
        transport = a_bzrdir.get_branch_transport(None, name=name)
2238
2231
        location = transport.put_bytes('location', to_branch.base)
2239
2232
 
2240
 
    def initialize(self, a_bzrdir, name=None, target_branch=None,
2241
 
            repository=None):
 
2233
    def initialize(self, a_bzrdir, name=None, target_branch=None):
2242
2234
        """Create a branch of this format in a_bzrdir."""
2243
2235
        if target_branch is None:
2244
2236
            # this format does not implement branch itself, thus the implicit
2272
2264
        return clone
2273
2265
 
2274
2266
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2275
 
             possible_transports=None, ignore_fallbacks=False,
2276
 
             found_repository=None):
 
2267
             possible_transports=None, ignore_fallbacks=False):
2277
2268
        """Return the branch that the branch reference in a_bzrdir points at.
2278
2269
 
2279
2270
        :param a_bzrdir: A BzrDir that contains a branch.
2310
2301
        return result
2311
2302
 
2312
2303
 
2313
 
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2314
 
    """Branch format registry."""
2315
 
 
2316
 
    def __init__(self, other_registry=None):
2317
 
        super(BranchFormatRegistry, self).__init__(other_registry)
2318
 
        self._default_format = None
2319
 
 
2320
 
    def set_default(self, format):
2321
 
        self._default_format = format
2322
 
 
2323
 
    def get_default(self):
2324
 
        return self._default_format
2325
 
 
2326
 
 
2327
2304
network_format_registry = registry.FormatRegistry()
2328
2305
"""Registry of formats indexed by their network name.
2329
2306
 
2332
2309
BranchFormat.network_name() for more detail.
2333
2310
"""
2334
2311
 
2335
 
format_registry = BranchFormatRegistry(network_format_registry)
2336
 
 
2337
2312
 
2338
2313
# formats which have no format string are not discoverable
2339
2314
# and not independently creatable, so are not registered.
2341
2316
__format6 = BzrBranchFormat6()
2342
2317
__format7 = BzrBranchFormat7()
2343
2318
__format8 = BzrBranchFormat8()
2344
 
format_registry.register(__format5)
2345
 
format_registry.register(BranchReferenceFormat())
2346
 
format_registry.register(__format6)
2347
 
format_registry.register(__format7)
2348
 
format_registry.register(__format8)
2349
 
format_registry.set_default(__format7)
 
2319
BranchFormat.register_format(__format5)
 
2320
BranchFormat.register_format(BranchReferenceFormat())
 
2321
BranchFormat.register_format(__format6)
 
2322
BranchFormat.register_format(__format7)
 
2323
BranchFormat.register_format(__format8)
 
2324
BranchFormat.set_default_format(__format7)
 
2325
_legacy_formats = [BzrBranchFormat4(),
 
2326
    ]
 
2327
network_format_registry.register(
 
2328
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2350
2329
 
2351
2330
 
2352
2331
class BranchWriteLockResult(LogicalLockResult):
2500
2479
        """See Branch.print_file."""
2501
2480
        return self.repository.print_file(file, revision_id)
2502
2481
 
 
2482
    def _write_revision_history(self, history):
 
2483
        """Factored out of set_revision_history.
 
2484
 
 
2485
        This performs the actual writing to disk.
 
2486
        It is intended to be called by BzrBranch5.set_revision_history."""
 
2487
        self._transport.put_bytes(
 
2488
            'revision-history', '\n'.join(history),
 
2489
            mode=self.bzrdir._get_file_mode())
 
2490
 
 
2491
    @needs_write_lock
 
2492
    def set_revision_history(self, rev_history):
 
2493
        """See Branch.set_revision_history."""
 
2494
        if 'evil' in debug.debug_flags:
 
2495
            mutter_callsite(3, "set_revision_history scales with history.")
 
2496
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2497
        for rev_id in rev_history:
 
2498
            check_not_reserved_id(rev_id)
 
2499
        if Branch.hooks['post_change_branch_tip']:
 
2500
            # Don't calculate the last_revision_info() if there are no hooks
 
2501
            # that will use it.
 
2502
            old_revno, old_revid = self.last_revision_info()
 
2503
        if len(rev_history) == 0:
 
2504
            revid = _mod_revision.NULL_REVISION
 
2505
        else:
 
2506
            revid = rev_history[-1]
 
2507
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2508
        self._write_revision_history(rev_history)
 
2509
        self._clear_cached_state()
 
2510
        self._cache_revision_history(rev_history)
 
2511
        for hook in Branch.hooks['set_rh']:
 
2512
            hook(self, rev_history)
 
2513
        if Branch.hooks['post_change_branch_tip']:
 
2514
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2515
 
 
2516
    def _synchronize_history(self, destination, revision_id):
 
2517
        """Synchronize last revision and revision history between branches.
 
2518
 
 
2519
        This version is most efficient when the destination is also a
 
2520
        BzrBranch5, but works for BzrBranch6 as long as the revision
 
2521
        history is the true lefthand parent history, and all of the revisions
 
2522
        are in the destination's repository.  If not, set_revision_history
 
2523
        will fail.
 
2524
 
 
2525
        :param destination: The branch to copy the history into
 
2526
        :param revision_id: The revision-id to truncate history at.  May
 
2527
          be None to copy complete history.
 
2528
        """
 
2529
        if not isinstance(destination._format, BzrBranchFormat5):
 
2530
            super(BzrBranch, self)._synchronize_history(
 
2531
                destination, revision_id)
 
2532
            return
 
2533
        if revision_id == _mod_revision.NULL_REVISION:
 
2534
            new_history = []
 
2535
        else:
 
2536
            new_history = self.revision_history()
 
2537
        if revision_id is not None and new_history != []:
 
2538
            try:
 
2539
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2540
            except ValueError:
 
2541
                rev = self.repository.get_revision(revision_id)
 
2542
                new_history = rev.get_history(self.repository)[1:]
 
2543
        destination.set_revision_history(new_history)
 
2544
 
2503
2545
    @needs_write_lock
2504
2546
    def set_last_revision_info(self, revno, revision_id):
2505
 
        if not revision_id or not isinstance(revision_id, basestring):
2506
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2547
        """Set the last revision of this branch.
 
2548
 
 
2549
        The caller is responsible for checking that the revno is correct
 
2550
        for this revision id.
 
2551
 
 
2552
        It may be possible to set the branch last revision to an id not
 
2553
        present in the repository.  However, branches can also be
 
2554
        configured to check constraints on history, in which case this may not
 
2555
        be permitted.
 
2556
        """
2507
2557
        revision_id = _mod_revision.ensure_null(revision_id)
2508
 
        old_revno, old_revid = self.last_revision_info()
2509
 
        if self._get_append_revisions_only():
2510
 
            self._check_history_violation(revision_id)
2511
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2512
 
        self._write_last_revision_info(revno, revision_id)
2513
 
        self._clear_cached_state()
2514
 
        self._last_revision_info_cache = revno, revision_id
2515
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2558
        # this old format stores the full history, but this api doesn't
 
2559
        # provide it, so we must generate, and might as well check it's
 
2560
        # correct
 
2561
        history = self._lefthand_history(revision_id)
 
2562
        if len(history) != revno:
 
2563
            raise AssertionError('%d != %d' % (len(history), revno))
 
2564
        self.set_revision_history(history)
 
2565
 
 
2566
    def _gen_revision_history(self):
 
2567
        history = self._transport.get_bytes('revision-history').split('\n')
 
2568
        if history[-1:] == ['']:
 
2569
            # There shouldn't be a trailing newline, but just in case.
 
2570
            history.pop()
 
2571
        return history
 
2572
 
 
2573
    @needs_write_lock
 
2574
    def generate_revision_history(self, revision_id, last_rev=None,
 
2575
        other_branch=None):
 
2576
        """Create a new revision history that will finish with revision_id.
 
2577
 
 
2578
        :param revision_id: the new tip to use.
 
2579
        :param last_rev: The previous last_revision. If not None, then this
 
2580
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2581
        :param other_branch: The other branch that DivergedBranches should
 
2582
            raise with respect to.
 
2583
        """
 
2584
        self.set_revision_history(self._lefthand_history(revision_id,
 
2585
            last_rev, other_branch))
2516
2586
 
2517
2587
    def basis_tree(self):
2518
2588
        """See Branch.basis_tree."""
2527
2597
                pass
2528
2598
        return None
2529
2599
 
 
2600
    def _basic_push(self, target, overwrite, stop_revision):
 
2601
        """Basic implementation of push without bound branches or hooks.
 
2602
 
 
2603
        Must be called with source read locked and target write locked.
 
2604
        """
 
2605
        result = BranchPushResult()
 
2606
        result.source_branch = self
 
2607
        result.target_branch = target
 
2608
        result.old_revno, result.old_revid = target.last_revision_info()
 
2609
        self.update_references(target)
 
2610
        if result.old_revid != self.last_revision():
 
2611
            # We assume that during 'push' this repository is closer than
 
2612
            # the target.
 
2613
            graph = self.repository.get_graph(target.repository)
 
2614
            target.update_revisions(self, stop_revision,
 
2615
                overwrite=overwrite, graph=graph)
 
2616
        if self._push_should_merge_tags():
 
2617
            result.tag_conflicts = self.tags.merge_to(target.tags,
 
2618
                overwrite)
 
2619
        result.new_revno, result.new_revid = target.last_revision_info()
 
2620
        return result
 
2621
 
2530
2622
    def get_stacked_on_url(self):
2531
2623
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2532
2624
 
2543
2635
            self._transport.put_bytes('parent', url + '\n',
2544
2636
                mode=self.bzrdir._get_file_mode())
2545
2637
 
 
2638
 
 
2639
class BzrBranch5(BzrBranch):
 
2640
    """A format 5 branch. This supports new features over plain branches.
 
2641
 
 
2642
    It has support for a master_branch which is the data for bound branches.
 
2643
    """
 
2644
 
 
2645
    def get_bound_location(self):
 
2646
        try:
 
2647
            return self._transport.get_bytes('bound')[:-1]
 
2648
        except errors.NoSuchFile:
 
2649
            return None
 
2650
 
 
2651
    @needs_read_lock
 
2652
    def get_master_branch(self, possible_transports=None):
 
2653
        """Return the branch we are bound to.
 
2654
 
 
2655
        :return: Either a Branch, or None
 
2656
 
 
2657
        This could memoise the branch, but if thats done
 
2658
        it must be revalidated on each new lock.
 
2659
        So for now we just don't memoise it.
 
2660
        # RBC 20060304 review this decision.
 
2661
        """
 
2662
        bound_loc = self.get_bound_location()
 
2663
        if not bound_loc:
 
2664
            return None
 
2665
        try:
 
2666
            return Branch.open(bound_loc,
 
2667
                               possible_transports=possible_transports)
 
2668
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2669
            raise errors.BoundBranchConnectionFailure(
 
2670
                    self, bound_loc, e)
 
2671
 
2546
2672
    @needs_write_lock
2547
 
    def unbind(self):
2548
 
        """If bound, unbind"""
2549
 
        return self.set_bound_location(None)
 
2673
    def set_bound_location(self, location):
 
2674
        """Set the target where this branch is bound to.
 
2675
 
 
2676
        :param location: URL to the target branch
 
2677
        """
 
2678
        if location:
 
2679
            self._transport.put_bytes('bound', location+'\n',
 
2680
                mode=self.bzrdir._get_file_mode())
 
2681
        else:
 
2682
            try:
 
2683
                self._transport.delete('bound')
 
2684
            except errors.NoSuchFile:
 
2685
                return False
 
2686
            return True
2550
2687
 
2551
2688
    @needs_write_lock
2552
2689
    def bind(self, other):
2574
2711
        # history around
2575
2712
        self.set_bound_location(other.base)
2576
2713
 
2577
 
    def get_bound_location(self):
2578
 
        try:
2579
 
            return self._transport.get_bytes('bound')[:-1]
2580
 
        except errors.NoSuchFile:
2581
 
            return None
2582
 
 
2583
 
    @needs_read_lock
2584
 
    def get_master_branch(self, possible_transports=None):
2585
 
        """Return the branch we are bound to.
2586
 
 
2587
 
        :return: Either a Branch, or None
2588
 
        """
2589
 
        if self._master_branch_cache is None:
2590
 
            self._master_branch_cache = self._get_master_branch(
2591
 
                possible_transports)
2592
 
        return self._master_branch_cache
2593
 
 
2594
 
    def _get_master_branch(self, possible_transports):
2595
 
        bound_loc = self.get_bound_location()
2596
 
        if not bound_loc:
2597
 
            return None
2598
 
        try:
2599
 
            return Branch.open(bound_loc,
2600
 
                               possible_transports=possible_transports)
2601
 
        except (errors.NotBranchError, errors.ConnectionError), e:
2602
 
            raise errors.BoundBranchConnectionFailure(
2603
 
                    self, bound_loc, e)
2604
 
 
2605
2714
    @needs_write_lock
2606
 
    def set_bound_location(self, location):
2607
 
        """Set the target where this branch is bound to.
2608
 
 
2609
 
        :param location: URL to the target branch
2610
 
        """
2611
 
        self._master_branch_cache = None
2612
 
        if location:
2613
 
            self._transport.put_bytes('bound', location+'\n',
2614
 
                mode=self.bzrdir._get_file_mode())
2615
 
        else:
2616
 
            try:
2617
 
                self._transport.delete('bound')
2618
 
            except errors.NoSuchFile:
2619
 
                return False
2620
 
            return True
 
2715
    def unbind(self):
 
2716
        """If bound, unbind"""
 
2717
        return self.set_bound_location(None)
2621
2718
 
2622
2719
    @needs_write_lock
2623
2720
    def update(self, possible_transports=None):
2636
2733
            return old_tip
2637
2734
        return None
2638
2735
 
2639
 
    def _read_last_revision_info(self):
2640
 
        revision_string = self._transport.get_bytes('last-revision')
2641
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2642
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2643
 
        revno = int(revno)
2644
 
        return revno, revision_id
2645
 
 
2646
 
    def _write_last_revision_info(self, revno, revision_id):
2647
 
        """Simply write out the revision id, with no checks.
2648
 
 
2649
 
        Use set_last_revision_info to perform this safely.
2650
 
 
2651
 
        Does not update the revision_history cache.
2652
 
        """
2653
 
        revision_id = _mod_revision.ensure_null(revision_id)
2654
 
        out_string = '%d %s\n' % (revno, revision_id)
2655
 
        self._transport.put_bytes('last-revision', out_string,
2656
 
            mode=self.bzrdir._get_file_mode())
2657
 
 
2658
 
 
2659
 
class FullHistoryBzrBranch(BzrBranch):
2660
 
    """Bzr branch which contains the full revision history."""
2661
 
 
2662
 
    @needs_write_lock
2663
 
    def set_last_revision_info(self, revno, revision_id):
2664
 
        if not revision_id or not isinstance(revision_id, basestring):
2665
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2666
 
        revision_id = _mod_revision.ensure_null(revision_id)
2667
 
        # this old format stores the full history, but this api doesn't
2668
 
        # provide it, so we must generate, and might as well check it's
2669
 
        # correct
2670
 
        history = self._lefthand_history(revision_id)
2671
 
        if len(history) != revno:
2672
 
            raise AssertionError('%d != %d' % (len(history), revno))
2673
 
        self._set_revision_history(history)
2674
 
 
2675
 
    def _read_last_revision_info(self):
2676
 
        rh = self.revision_history()
2677
 
        revno = len(rh)
2678
 
        if revno:
2679
 
            return (revno, rh[-1])
2680
 
        else:
2681
 
            return (0, _mod_revision.NULL_REVISION)
2682
 
 
2683
 
    @deprecated_method(deprecated_in((2, 4, 0)))
2684
 
    @needs_write_lock
2685
 
    def set_revision_history(self, rev_history):
2686
 
        """See Branch.set_revision_history."""
2687
 
        self._set_revision_history(rev_history)
2688
 
 
2689
 
    def _set_revision_history(self, rev_history):
2690
 
        if 'evil' in debug.debug_flags:
2691
 
            mutter_callsite(3, "set_revision_history scales with history.")
2692
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2693
 
        for rev_id in rev_history:
2694
 
            check_not_reserved_id(rev_id)
2695
 
        if Branch.hooks['post_change_branch_tip']:
2696
 
            # Don't calculate the last_revision_info() if there are no hooks
2697
 
            # that will use it.
2698
 
            old_revno, old_revid = self.last_revision_info()
2699
 
        if len(rev_history) == 0:
2700
 
            revid = _mod_revision.NULL_REVISION
2701
 
        else:
2702
 
            revid = rev_history[-1]
2703
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2704
 
        self._write_revision_history(rev_history)
2705
 
        self._clear_cached_state()
2706
 
        self._cache_revision_history(rev_history)
2707
 
        for hook in Branch.hooks['set_rh']:
2708
 
            hook(self, rev_history)
2709
 
        if Branch.hooks['post_change_branch_tip']:
2710
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2711
 
 
2712
 
    def _write_revision_history(self, history):
2713
 
        """Factored out of set_revision_history.
2714
 
 
2715
 
        This performs the actual writing to disk.
2716
 
        It is intended to be called by set_revision_history."""
2717
 
        self._transport.put_bytes(
2718
 
            'revision-history', '\n'.join(history),
2719
 
            mode=self.bzrdir._get_file_mode())
2720
 
 
2721
 
    def _gen_revision_history(self):
2722
 
        history = self._transport.get_bytes('revision-history').split('\n')
2723
 
        if history[-1:] == ['']:
2724
 
            # There shouldn't be a trailing newline, but just in case.
2725
 
            history.pop()
2726
 
        return history
2727
 
 
2728
 
    def _synchronize_history(self, destination, revision_id):
2729
 
        if not isinstance(destination, FullHistoryBzrBranch):
2730
 
            super(BzrBranch, self)._synchronize_history(
2731
 
                destination, revision_id)
2732
 
            return
2733
 
        if revision_id == _mod_revision.NULL_REVISION:
2734
 
            new_history = []
2735
 
        else:
2736
 
            new_history = self.revision_history()
2737
 
        if revision_id is not None and new_history != []:
2738
 
            try:
2739
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2740
 
            except ValueError:
2741
 
                rev = self.repository.get_revision(revision_id)
2742
 
                new_history = rev.get_history(self.repository)[1:]
2743
 
        destination._set_revision_history(new_history)
2744
 
 
2745
 
    @needs_write_lock
2746
 
    def generate_revision_history(self, revision_id, last_rev=None,
2747
 
        other_branch=None):
2748
 
        """Create a new revision history that will finish with revision_id.
2749
 
 
2750
 
        :param revision_id: the new tip to use.
2751
 
        :param last_rev: The previous last_revision. If not None, then this
2752
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
2753
 
        :param other_branch: The other branch that DivergedBranches should
2754
 
            raise with respect to.
2755
 
        """
2756
 
        self._set_revision_history(self._lefthand_history(revision_id,
2757
 
            last_rev, other_branch))
2758
 
 
2759
 
 
2760
 
class BzrBranch5(FullHistoryBzrBranch):
2761
 
    """A format 5 branch. This supports new features over plain branches.
2762
 
 
2763
 
    It has support for a master_branch which is the data for bound branches.
2764
 
    """
2765
 
 
2766
 
 
2767
 
class BzrBranch8(BzrBranch):
 
2736
 
 
2737
class BzrBranch8(BzrBranch5):
2768
2738
    """A branch that stores tree-reference locations."""
2769
2739
 
2770
2740
    def _open_hook(self):
2796
2766
        self._last_revision_info_cache = None
2797
2767
        self._reference_info = None
2798
2768
 
 
2769
    def _last_revision_info(self):
 
2770
        revision_string = self._transport.get_bytes('last-revision')
 
2771
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2772
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2773
        revno = int(revno)
 
2774
        return revno, revision_id
 
2775
 
 
2776
    def _write_last_revision_info(self, revno, revision_id):
 
2777
        """Simply write out the revision id, with no checks.
 
2778
 
 
2779
        Use set_last_revision_info to perform this safely.
 
2780
 
 
2781
        Does not update the revision_history cache.
 
2782
        Intended to be called by set_last_revision_info and
 
2783
        _write_revision_history.
 
2784
        """
 
2785
        revision_id = _mod_revision.ensure_null(revision_id)
 
2786
        out_string = '%d %s\n' % (revno, revision_id)
 
2787
        self._transport.put_bytes('last-revision', out_string,
 
2788
            mode=self.bzrdir._get_file_mode())
 
2789
 
 
2790
    @needs_write_lock
 
2791
    def set_last_revision_info(self, revno, revision_id):
 
2792
        revision_id = _mod_revision.ensure_null(revision_id)
 
2793
        old_revno, old_revid = self.last_revision_info()
 
2794
        if self._get_append_revisions_only():
 
2795
            self._check_history_violation(revision_id)
 
2796
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2797
        self._write_last_revision_info(revno, revision_id)
 
2798
        self._clear_cached_state()
 
2799
        self._last_revision_info_cache = revno, revision_id
 
2800
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2801
 
 
2802
    def _synchronize_history(self, destination, revision_id):
 
2803
        """Synchronize last revision and revision history between branches.
 
2804
 
 
2805
        :see: Branch._synchronize_history
 
2806
        """
 
2807
        # XXX: The base Branch has a fast implementation of this method based
 
2808
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
 
2809
        # that uses set_revision_history.  This class inherits from BzrBranch5,
 
2810
        # but wants the fast implementation, so it calls
 
2811
        # Branch._synchronize_history directly.
 
2812
        Branch._synchronize_history(self, destination, revision_id)
 
2813
 
2799
2814
    def _check_history_violation(self, revision_id):
2800
 
        current_revid = self.last_revision()
2801
 
        last_revision = _mod_revision.ensure_null(current_revid)
 
2815
        last_revision = _mod_revision.ensure_null(self.last_revision())
2802
2816
        if _mod_revision.is_null(last_revision):
2803
2817
            return
2804
 
        graph = self.repository.get_graph()
2805
 
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2806
 
            if lh_ancestor == current_revid:
2807
 
                return
2808
 
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2818
        if last_revision not in self._lefthand_history(revision_id):
 
2819
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
2809
2820
 
2810
2821
    def _gen_revision_history(self):
2811
2822
        """Generate the revision history from last revision
2814
2825
        self._extend_partial_history(stop_index=last_revno-1)
2815
2826
        return list(reversed(self._partial_revision_history_cache))
2816
2827
 
 
2828
    def _write_revision_history(self, history):
 
2829
        """Factored out of set_revision_history.
 
2830
 
 
2831
        This performs the actual writing to disk, with format-specific checks.
 
2832
        It is intended to be called by BzrBranch5.set_revision_history.
 
2833
        """
 
2834
        if len(history) == 0:
 
2835
            last_revision = 'null:'
 
2836
        else:
 
2837
            if history != self._lefthand_history(history[-1]):
 
2838
                raise errors.NotLefthandHistory(history)
 
2839
            last_revision = history[-1]
 
2840
        if self._get_append_revisions_only():
 
2841
            self._check_history_violation(last_revision)
 
2842
        self._write_last_revision_info(len(history), last_revision)
 
2843
 
2817
2844
    @needs_write_lock
2818
2845
    def _set_parent_location(self, url):
2819
2846
        """Set the parent branch"""
2905
2932
 
2906
2933
    def set_bound_location(self, location):
2907
2934
        """See Branch.set_push_location."""
2908
 
        self._master_branch_cache = None
2909
2935
        result = None
2910
2936
        config = self.get_config()
2911
2937
        if location is None:
2942
2968
        # you can always ask for the URL; but you might not be able to use it
2943
2969
        # if the repo can't support stacking.
2944
2970
        ## self._check_stackable_repo()
2945
 
        # stacked_on_location is only ever defined in branch.conf, so don't
2946
 
        # waste effort reading the whole stack of config files.
2947
 
        config = self.get_config()._get_branch_data_config()
2948
 
        stacked_url = self._get_config_location('stacked_on_location',
2949
 
            config=config)
 
2971
        stacked_url = self._get_config_location('stacked_on_location')
2950
2972
        if stacked_url is None:
2951
2973
            raise errors.NotStacked(self)
2952
2974
        return stacked_url
2955
2977
        return self.get_config(
2956
2978
            ).get_user_option_as_bool('append_revisions_only')
2957
2979
 
 
2980
    @needs_write_lock
 
2981
    def generate_revision_history(self, revision_id, last_rev=None,
 
2982
                                  other_branch=None):
 
2983
        """See BzrBranch5.generate_revision_history"""
 
2984
        history = self._lefthand_history(revision_id, last_rev, other_branch)
 
2985
        revno = len(history)
 
2986
        self.set_last_revision_info(revno, revision_id)
 
2987
 
2958
2988
    @needs_read_lock
2959
2989
    def get_rev_id(self, revno, history=None):
2960
2990
        """Find the revision id of the specified revno."""
2984
3014
        try:
2985
3015
            index = self._partial_revision_history_cache.index(revision_id)
2986
3016
        except ValueError:
2987
 
            try:
2988
 
                self._extend_partial_history(stop_revision=revision_id)
2989
 
            except errors.RevisionNotPresent, e:
2990
 
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
 
3017
            self._extend_partial_history(stop_revision=revision_id)
2991
3018
            index = len(self._partial_revision_history_cache) - 1
2992
3019
            if self._partial_revision_history_cache[index] != revision_id:
2993
3020
                raise errors.NoSuchRevision(self, revision_id)
3048
3075
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3049
3076
    """
3050
3077
 
3051
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3052
3078
    def __int__(self):
3053
 
        """Return the relative change in revno.
3054
 
 
3055
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3056
 
        """
 
3079
        # DEPRECATED: pull used to return the change in revno
3057
3080
        return self.new_revno - self.old_revno
3058
3081
 
3059
3082
    def report(self, to_file):
3084
3107
        target, otherwise it will be None.
3085
3108
    """
3086
3109
 
3087
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3088
3110
    def __int__(self):
3089
 
        """Return the relative change in revno.
3090
 
 
3091
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3092
 
        """
 
3111
        # DEPRECATED: push used to return the change in revno
3093
3112
        return self.new_revno - self.old_revno
3094
3113
 
3095
3114
    def report(self, to_file):
3174
3193
        branch._transport.put_bytes('format', format.get_format_string())
3175
3194
 
3176
3195
 
 
3196
def _run_with_write_locked_target(target, callable, *args, **kwargs):
 
3197
    """Run ``callable(*args, **kwargs)``, write-locking target for the
 
3198
    duration.
 
3199
 
 
3200
    _run_with_write_locked_target will attempt to release the lock it acquires.
 
3201
 
 
3202
    If an exception is raised by callable, then that exception *will* be
 
3203
    propagated, even if the unlock attempt raises its own error.  Thus
 
3204
    _run_with_write_locked_target should be preferred to simply doing::
 
3205
 
 
3206
        target.lock_write()
 
3207
        try:
 
3208
            return callable(*args, **kwargs)
 
3209
        finally:
 
3210
            target.unlock()
 
3211
 
 
3212
    """
 
3213
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
 
3214
    # should share code?
 
3215
    target.lock_write()
 
3216
    try:
 
3217
        result = callable(*args, **kwargs)
 
3218
    except:
 
3219
        exc_info = sys.exc_info()
 
3220
        try:
 
3221
            target.unlock()
 
3222
        finally:
 
3223
            raise exc_info[0], exc_info[1], exc_info[2]
 
3224
    else:
 
3225
        target.unlock()
 
3226
        return result
 
3227
 
 
3228
 
3177
3229
class InterBranch(InterObject):
3178
3230
    """This class represents operations taking place between two branches.
3179
3231
 
3207
3259
        raise NotImplementedError(self.pull)
3208
3260
 
3209
3261
    @needs_write_lock
3210
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
3262
    def update_revisions(self, stop_revision=None, overwrite=False,
 
3263
                         graph=None):
 
3264
        """Pull in new perfect-fit revisions.
 
3265
 
 
3266
        :param stop_revision: Updated until the given revision
 
3267
        :param overwrite: Always set the branch pointer, rather than checking
 
3268
            to see if it is a proper descendant.
 
3269
        :param graph: A Graph object that can be used to query history
 
3270
            information. This can be None.
 
3271
        :return: None
 
3272
        """
 
3273
        raise NotImplementedError(self.update_revisions)
 
3274
 
 
3275
    @needs_write_lock
 
3276
    def push(self, overwrite=False, stop_revision=None,
3211
3277
             _override_hook_source_branch=None):
3212
3278
        """Mirror the source branch into the target branch.
3213
3279
 
3215
3281
        """
3216
3282
        raise NotImplementedError(self.push)
3217
3283
 
3218
 
    @needs_write_lock
3219
 
    def copy_content_into(self, revision_id=None):
3220
 
        """Copy the content of source into target
3221
 
 
3222
 
        revision_id: if not None, the revision history in the new branch will
3223
 
                     be truncated to end with revision_id.
3224
 
        """
3225
 
        raise NotImplementedError(self.copy_content_into)
3226
 
 
3227
 
    @needs_write_lock
3228
 
    def fetch(self, stop_revision=None, limit=None):
3229
 
        """Fetch revisions.
3230
 
 
3231
 
        :param stop_revision: Last revision to fetch
3232
 
        :param limit: Optional rough limit of revisions to fetch
3233
 
        """
3234
 
        raise NotImplementedError(self.fetch)
3235
 
 
3236
3284
 
3237
3285
class GenericInterBranch(InterBranch):
3238
3286
    """InterBranch implementation that uses public Branch functions."""
3244
3292
 
3245
3293
    @classmethod
3246
3294
    def _get_branch_formats_to_test(klass):
3247
 
        return [(format_registry.get_default(), format_registry.get_default())]
 
3295
        return [(BranchFormat._default_format, BranchFormat._default_format)]
3248
3296
 
3249
3297
    @classmethod
3250
3298
    def unwrap_format(klass, format):
3251
3299
        if isinstance(format, remote.RemoteBranchFormat):
3252
3300
            format._ensure_real()
3253
3301
            return format._custom_format
3254
 
        return format
 
3302
        return format                                                                                                  
3255
3303
 
3256
3304
    @needs_write_lock
3257
3305
    def copy_content_into(self, revision_id=None):
3273
3321
            self.source.tags.merge_to(self.target.tags)
3274
3322
 
3275
3323
    @needs_write_lock
3276
 
    def fetch(self, stop_revision=None, limit=None):
3277
 
        if self.target.base == self.source.base:
3278
 
            return (0, [])
3279
 
        self.source.lock_read()
3280
 
        try:
3281
 
            fetch_spec_factory = fetch.FetchSpecFactory()
3282
 
            fetch_spec_factory.source_branch = self.source
3283
 
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3284
 
            fetch_spec_factory.source_repo = self.source.repository
3285
 
            fetch_spec_factory.target_repo = self.target.repository
3286
 
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3287
 
            fetch_spec_factory.limit = limit
3288
 
            fetch_spec = fetch_spec_factory.make_fetch_spec()
3289
 
            return self.target.repository.fetch(self.source.repository,
3290
 
                fetch_spec=fetch_spec)
3291
 
        finally:
3292
 
            self.source.unlock()
3293
 
 
3294
 
    @needs_write_lock
3295
 
    def _update_revisions(self, stop_revision=None, overwrite=False,
3296
 
            graph=None):
 
3324
    def update_revisions(self, stop_revision=None, overwrite=False,
 
3325
        graph=None):
 
3326
        """See InterBranch.update_revisions()."""
3297
3327
        other_revno, other_last_revision = self.source.last_revision_info()
3298
3328
        stop_revno = None # unknown
3299
3329
        if stop_revision is None:
3310
3340
        # case of having something to pull, and so that the check for
3311
3341
        # already merged can operate on the just fetched graph, which will
3312
3342
        # be cached in memory.
3313
 
        self.fetch(stop_revision=stop_revision)
 
3343
        self.target.fetch(self.source, stop_revision)
3314
3344
        # Check to see if one is an ancestor of the other
3315
3345
        if not overwrite:
3316
3346
            if graph is None:
3344
3374
        if local and not bound_location:
3345
3375
            raise errors.LocalRequiresBoundBranch()
3346
3376
        master_branch = None
3347
 
        source_is_master = (self.source.user_url == bound_location)
3348
 
        if not local and bound_location and not source_is_master:
 
3377
        if not local and bound_location and self.source.user_url != bound_location:
3349
3378
            # not pulling from master, so we need to update master.
3350
3379
            master_branch = self.target.get_master_branch(possible_transports)
3351
3380
            master_branch.lock_write()
3357
3386
            return self._pull(overwrite,
3358
3387
                stop_revision, _hook_master=master_branch,
3359
3388
                run_hooks=run_hooks,
3360
 
                _override_hook_target=_override_hook_target,
3361
 
                merge_tags_to_master=not source_is_master)
 
3389
                _override_hook_target=_override_hook_target)
3362
3390
        finally:
3363
3391
            if master_branch:
3364
3392
                master_branch.unlock()
3365
3393
 
3366
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
3394
    def push(self, overwrite=False, stop_revision=None,
3367
3395
             _override_hook_source_branch=None):
3368
3396
        """See InterBranch.push.
3369
3397
 
3370
3398
        This is the basic concrete implementation of push()
3371
3399
 
3372
 
        :param _override_hook_source_branch: If specified, run the hooks
3373
 
            passing this Branch as the source, rather than self.  This is for
3374
 
            use of RemoteBranch, where push is delegated to the underlying
3375
 
            vfs-based Branch.
 
3400
        :param _override_hook_source_branch: If specified, run
 
3401
        the hooks passing this Branch as the source, rather than self.
 
3402
        This is for use of RemoteBranch, where push is delegated to the
 
3403
        underlying vfs-based Branch.
3376
3404
        """
3377
 
        if lossy:
3378
 
            raise errors.LossyPushToSameVCS(self.source, self.target)
3379
3405
        # TODO: Public option to disable running hooks - should be trivial but
3380
3406
        # needs tests.
3381
 
 
3382
 
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3383
 
        op.add_cleanup(self.source.lock_read().unlock)
3384
 
        op.add_cleanup(self.target.lock_write().unlock)
3385
 
        return op.run(overwrite, stop_revision,
3386
 
            _override_hook_source_branch=_override_hook_source_branch)
3387
 
 
3388
 
    def _basic_push(self, overwrite, stop_revision):
3389
 
        """Basic implementation of push without bound branches or hooks.
3390
 
 
3391
 
        Must be called with source read locked and target write locked.
3392
 
        """
3393
 
        result = BranchPushResult()
3394
 
        result.source_branch = self.source
3395
 
        result.target_branch = self.target
3396
 
        result.old_revno, result.old_revid = self.target.last_revision_info()
3397
 
        self.source.update_references(self.target)
3398
 
        if result.old_revid != stop_revision:
3399
 
            # We assume that during 'push' this repository is closer than
3400
 
            # the target.
3401
 
            graph = self.source.repository.get_graph(self.target.repository)
3402
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3403
 
                    graph=graph)
3404
 
        if self.source._push_should_merge_tags():
3405
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3406
 
                overwrite)
3407
 
        result.new_revno, result.new_revid = self.target.last_revision_info()
3408
 
        return result
3409
 
 
3410
 
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
 
3407
        self.source.lock_read()
 
3408
        try:
 
3409
            return _run_with_write_locked_target(
 
3410
                self.target, self._push_with_bound_branches, overwrite,
 
3411
                stop_revision,
 
3412
                _override_hook_source_branch=_override_hook_source_branch)
 
3413
        finally:
 
3414
            self.source.unlock()
 
3415
 
 
3416
    def _push_with_bound_branches(self, overwrite, stop_revision,
3411
3417
            _override_hook_source_branch=None):
3412
3418
        """Push from source into target, and into target's master if any.
3413
3419
        """
3425
3431
            # be bound to itself? -- mbp 20070507
3426
3432
            master_branch = self.target.get_master_branch()
3427
3433
            master_branch.lock_write()
3428
 
            operation.add_cleanup(master_branch.unlock)
3429
 
            # push into the master from the source branch.
3430
 
            master_inter = InterBranch.get(self.source, master_branch)
3431
 
            master_inter._basic_push(overwrite, stop_revision)
3432
 
            # and push into the target branch from the source. Note that
3433
 
            # we push from the source branch again, because it's considered
3434
 
            # the highest bandwidth repository.
3435
 
            result = self._basic_push(overwrite, stop_revision)
3436
 
            result.master_branch = master_branch
3437
 
            result.local_branch = self.target
 
3434
            try:
 
3435
                # push into the master from the source branch.
 
3436
                self.source._basic_push(master_branch, overwrite, stop_revision)
 
3437
                # and push into the target branch from the source. Note that we
 
3438
                # push from the source branch again, because its considered the
 
3439
                # highest bandwidth repository.
 
3440
                result = self.source._basic_push(self.target, overwrite,
 
3441
                    stop_revision)
 
3442
                result.master_branch = master_branch
 
3443
                result.local_branch = self.target
 
3444
                _run_hooks()
 
3445
                return result
 
3446
            finally:
 
3447
                master_branch.unlock()
3438
3448
        else:
3439
 
            master_branch = None
3440
3449
            # no master branch
3441
 
            result = self._basic_push(overwrite, stop_revision)
 
3450
            result = self.source._basic_push(self.target, overwrite,
 
3451
                stop_revision)
3442
3452
            # TODO: Why set master_branch and local_branch if there's no
3443
3453
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3444
3454
            # 20070504
3445
3455
            result.master_branch = self.target
3446
3456
            result.local_branch = None
3447
 
        _run_hooks()
3448
 
        return result
 
3457
            _run_hooks()
 
3458
            return result
3449
3459
 
3450
3460
    def _pull(self, overwrite=False, stop_revision=None,
3451
3461
             possible_transports=None, _hook_master=None, run_hooks=True,
3452
 
             _override_hook_target=None, local=False,
3453
 
             merge_tags_to_master=True):
 
3462
             _override_hook_target=None, local=False):
3454
3463
        """See Branch.pull.
3455
3464
 
3456
3465
        This function is the core worker, used by GenericInterBranch.pull to
3461
3470
        :param run_hooks: Private parameter - if false, this branch
3462
3471
            is being called because it's the master of the primary branch,
3463
3472
            so it should not run its hooks.
3464
 
            is being called because it's the master of the primary branch,
3465
 
            so it should not run its hooks.
3466
3473
        :param _override_hook_target: Private parameter - set the branch to be
3467
3474
            supplied as the target_branch to pull hooks.
3468
3475
        :param local: Only update the local branch, and not the bound branch.
3487
3494
            # -- JRV20090506
3488
3495
            result.old_revno, result.old_revid = \
3489
3496
                self.target.last_revision_info()
3490
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3491
 
                graph=graph)
 
3497
            self.target.update_revisions(self.source, stop_revision,
 
3498
                overwrite=overwrite, graph=graph)
3492
3499
            # TODO: The old revid should be specified when merging tags, 
3493
3500
            # so a tags implementation that versions tags can only 
3494
3501
            # pull in the most recent changes. -- JRV20090506
3495
3502
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3496
 
                overwrite, ignore_master=not merge_tags_to_master)
 
3503
                overwrite)
3497
3504
            result.new_revno, result.new_revid = self.target.last_revision_info()
3498
3505
            if _hook_master:
3499
3506
                result.master_branch = _hook_master