~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Jonathan Riddell
  • Date: 2011-09-16 15:37:58 UTC
  • mto: This revision was merged to the branch mainline in revision 6146.
  • Revision ID: jriddell@canonical.com-20110916153758-y936k3hysjc1tphy
update tests

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
16
16
 
17
17
 
18
18
from cStringIO import StringIO
19
 
import sys
20
19
 
21
20
from bzrlib.lazy_import import lazy_import
22
21
lazy_import(globals(), """
23
 
from itertools import chain
 
22
import itertools
24
23
from bzrlib import (
25
24
        bzrdir,
26
25
        cache_utf8,
 
26
        cleanup,
27
27
        config as _mod_config,
28
 
        controldir,
29
28
        debug,
30
29
        errors,
 
30
        fetch,
 
31
        graph as _mod_graph,
31
32
        lockdir,
32
33
        lockable_files,
33
34
        remote,
34
35
        repository,
35
36
        revision as _mod_revision,
36
37
        rio,
37
 
        symbol_versioning,
 
38
        tag as _mod_tag,
38
39
        transport,
39
 
        tsort,
40
40
        ui,
41
41
        urlutils,
42
42
        )
43
 
from bzrlib.config import BranchConfig, TransportConfig
44
 
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
45
 
from bzrlib.tag import (
46
 
    BasicTags,
47
 
    DisabledTags,
48
 
    )
 
43
from bzrlib.i18n import gettext, ngettext
49
44
""")
50
45
 
51
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
52
 
from bzrlib.hooks import HookPoint, Hooks
 
46
from bzrlib import (
 
47
    controldir,
 
48
    )
 
49
from bzrlib.decorators import (
 
50
    needs_read_lock,
 
51
    needs_write_lock,
 
52
    only_raises,
 
53
    )
 
54
from bzrlib.hooks import Hooks
53
55
from bzrlib.inter import InterObject
54
56
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
55
57
from bzrlib import registry
60
62
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
61
63
 
62
64
 
63
 
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
64
 
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
65
 
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
 
 
67
 
 
68
65
class Branch(controldir.ControlComponent):
69
66
    """Branch holding a history of revisions.
70
67
 
71
68
    :ivar base:
72
69
        Base directory/url of the branch; using control_url and
73
70
        control_transport is more standardized.
74
 
 
75
 
    hooks: An instance of BranchHooks.
 
71
    :ivar hooks: An instance of BranchHooks.
 
72
    :ivar _master_branch_cache: cached result of get_master_branch, see
 
73
        _clear_cached_state.
76
74
    """
77
75
    # this is really an instance variable - FIXME move it there
78
76
    # - RBC 20060112
92
90
        self._revision_id_to_revno_cache = None
93
91
        self._partial_revision_id_to_revno_cache = {}
94
92
        self._partial_revision_history_cache = []
 
93
        self._tags_bytes = None
95
94
        self._last_revision_info_cache = None
 
95
        self._master_branch_cache = None
96
96
        self._merge_sorted_revisions_cache = None
97
97
        self._open_hook()
98
98
        hooks = Branch.hooks['open']
104
104
 
105
105
    def _activate_fallback_location(self, url):
106
106
        """Activate the branch/repository from url as a fallback repository."""
 
107
        for existing_fallback_repo in self.repository._fallback_repositories:
 
108
            if existing_fallback_repo.user_url == url:
 
109
                # This fallback is already configured.  This probably only
 
110
                # happens because BzrDir.sprout is a horrible mess.  To avoid
 
111
                # confusing _unstack we don't add this a second time.
 
112
                mutter('duplicate activation of fallback %r on %r', url, self)
 
113
                return
107
114
        repo = self._get_fallback_repository(url)
108
115
        if repo.has_same_location(self.repository):
109
116
            raise errors.UnstackableLocationError(self.user_url, url)
206
213
 
207
214
        :return: A bzrlib.config.BranchConfig.
208
215
        """
209
 
        return BranchConfig(self)
 
216
        return _mod_config.BranchConfig(self)
210
217
 
211
218
    def _get_config(self):
212
219
        """Get the concrete config for just the config in this branch.
227
234
            possible_transports=[self.bzrdir.root_transport])
228
235
        return a_branch.repository
229
236
 
 
237
    @needs_read_lock
230
238
    def _get_tags_bytes(self):
231
239
        """Get the bytes of a serialised tags dict.
232
240
 
239
247
        :return: The bytes of the tags file.
240
248
        :seealso: Branch._set_tags_bytes.
241
249
        """
242
 
        return self._transport.get_bytes('tags')
 
250
        if self._tags_bytes is None:
 
251
            self._tags_bytes = self._transport.get_bytes('tags')
 
252
        return self._tags_bytes
243
253
 
244
254
    def _get_nick(self, local=False, possible_transports=None):
245
255
        config = self.get_config()
436
446
            after. If None, the rest of history is included.
437
447
        :param stop_rule: if stop_revision_id is not None, the precise rule
438
448
            to use for termination:
 
449
 
439
450
            * 'exclude' - leave the stop revision out of the result (default)
440
451
            * 'include' - the stop revision is the last item in the result
441
452
            * 'with-merges' - include the stop revision and all of its
443
454
            * 'with-merges-without-common-ancestry' - filter out revisions 
444
455
              that are in both ancestries
445
456
        :param direction: either 'reverse' or 'forward':
 
457
 
446
458
            * reverse means return the start_revision_id first, i.e.
447
459
              start at the most recent revision and go backwards in history
448
460
            * forward returns tuples in the opposite order to reverse.
492
504
        rev_iter = iter(merge_sorted_revisions)
493
505
        if start_revision_id is not None:
494
506
            for node in rev_iter:
495
 
                rev_id = node.key[-1]
 
507
                rev_id = node.key
496
508
                if rev_id != start_revision_id:
497
509
                    continue
498
510
                else:
499
511
                    # The decision to include the start or not
500
512
                    # depends on the stop_rule if a stop is provided
501
513
                    # so pop this node back into the iterator
502
 
                    rev_iter = chain(iter([node]), rev_iter)
 
514
                    rev_iter = itertools.chain(iter([node]), rev_iter)
503
515
                    break
504
516
        if stop_revision_id is None:
505
517
            # Yield everything
506
518
            for node in rev_iter:
507
 
                rev_id = node.key[-1]
 
519
                rev_id = node.key
508
520
                yield (rev_id, node.merge_depth, node.revno,
509
521
                       node.end_of_merge)
510
522
        elif stop_rule == 'exclude':
511
523
            for node in rev_iter:
512
 
                rev_id = node.key[-1]
 
524
                rev_id = node.key
513
525
                if rev_id == stop_revision_id:
514
526
                    return
515
527
                yield (rev_id, node.merge_depth, node.revno,
516
528
                       node.end_of_merge)
517
529
        elif stop_rule == 'include':
518
530
            for node in rev_iter:
519
 
                rev_id = node.key[-1]
 
531
                rev_id = node.key
520
532
                yield (rev_id, node.merge_depth, node.revno,
521
533
                       node.end_of_merge)
522
534
                if rev_id == stop_revision_id:
528
540
            ancestors = graph.find_unique_ancestors(start_revision_id,
529
541
                                                    [stop_revision_id])
530
542
            for node in rev_iter:
531
 
                rev_id = node.key[-1]
 
543
                rev_id = node.key
532
544
                if rev_id not in ancestors:
533
545
                    continue
534
546
                yield (rev_id, node.merge_depth, node.revno,
544
556
            reached_stop_revision_id = False
545
557
            revision_id_whitelist = []
546
558
            for node in rev_iter:
547
 
                rev_id = node.key[-1]
 
559
                rev_id = node.key
548
560
                if rev_id == left_parent:
549
561
                    # reached the left parent after the stop_revision
550
562
                    return
630
642
        """
631
643
        raise errors.UpgradeRequired(self.user_url)
632
644
 
 
645
    def get_append_revisions_only(self):
 
646
        """Whether it is only possible to append revisions to the history.
 
647
        """
 
648
        if not self._format.supports_set_append_revisions_only():
 
649
            return False
 
650
        return self.get_config(
 
651
            ).get_user_option_as_bool('append_revisions_only')
 
652
 
633
653
    def set_append_revisions_only(self, enabled):
634
654
        if not self._format.supports_set_append_revisions_only():
635
655
            raise errors.UpgradeRequired(self.user_url)
649
669
        raise errors.UnsupportedOperation(self.get_reference_info, self)
650
670
 
651
671
    @needs_write_lock
652
 
    def fetch(self, from_branch, last_revision=None, pb=None):
 
672
    def fetch(self, from_branch, last_revision=None, limit=None):
653
673
        """Copy revisions from from_branch into this branch.
654
674
 
655
675
        :param from_branch: Where to copy from.
656
676
        :param last_revision: What revision to stop at (None for at the end
657
677
                              of the branch.
658
 
        :param pb: An optional progress bar to use.
 
678
        :param limit: Optional rough limit of revisions to fetch
659
679
        :return: None
660
680
        """
661
 
        if self.base == from_branch.base:
662
 
            return (0, [])
663
 
        if pb is not None:
664
 
            symbol_versioning.warn(
665
 
                symbol_versioning.deprecated_in((1, 14, 0))
666
 
                % "pb parameter to fetch()")
667
 
        from_branch.lock_read()
668
 
        try:
669
 
            if last_revision is None:
670
 
                last_revision = from_branch.last_revision()
671
 
                last_revision = _mod_revision.ensure_null(last_revision)
672
 
            return self.repository.fetch(from_branch.repository,
673
 
                                         revision_id=last_revision,
674
 
                                         pb=pb)
675
 
        finally:
676
 
            from_branch.unlock()
 
681
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
677
682
 
678
683
    def get_bound_location(self):
679
684
        """Return the URL of the branch we are bound to.
690
695
 
691
696
    def get_commit_builder(self, parents, config=None, timestamp=None,
692
697
                           timezone=None, committer=None, revprops=None,
693
 
                           revision_id=None):
 
698
                           revision_id=None, lossy=False):
694
699
        """Obtain a CommitBuilder for this branch.
695
700
 
696
701
        :param parents: Revision ids of the parents of the new revision.
700
705
        :param committer: Optional committer to set for commit.
701
706
        :param revprops: Optional dictionary of revision properties.
702
707
        :param revision_id: Optional revision id.
 
708
        :param lossy: Whether to discard data that can not be natively
 
709
            represented, when pushing to a foreign VCS 
703
710
        """
704
711
 
705
712
        if config is None:
706
713
            config = self.get_config()
707
714
 
708
715
        return self.repository.get_commit_builder(self, parents, config,
709
 
            timestamp, timezone, committer, revprops, revision_id)
 
716
            timestamp, timezone, committer, revprops, revision_id,
 
717
            lossy)
710
718
 
711
719
    def get_master_branch(self, possible_transports=None):
712
720
        """Return the branch we are bound to.
739
747
        """Print `file` to stdout."""
740
748
        raise NotImplementedError(self.print_file)
741
749
 
 
750
    @deprecated_method(deprecated_in((2, 4, 0)))
742
751
    def set_revision_history(self, rev_history):
743
 
        raise NotImplementedError(self.set_revision_history)
 
752
        """See Branch.set_revision_history."""
 
753
        self._set_revision_history(rev_history)
 
754
 
 
755
    @needs_write_lock
 
756
    def _set_revision_history(self, rev_history):
 
757
        if len(rev_history) == 0:
 
758
            revid = _mod_revision.NULL_REVISION
 
759
        else:
 
760
            revid = rev_history[-1]
 
761
        if rev_history != self._lefthand_history(revid):
 
762
            raise errors.NotLefthandHistory(rev_history)
 
763
        self.set_last_revision_info(len(rev_history), revid)
 
764
        self._cache_revision_history(rev_history)
 
765
        for hook in Branch.hooks['set_rh']:
 
766
            hook(self, rev_history)
 
767
 
 
768
    @needs_write_lock
 
769
    def set_last_revision_info(self, revno, revision_id):
 
770
        """Set the last revision of this branch.
 
771
 
 
772
        The caller is responsible for checking that the revno is correct
 
773
        for this revision id.
 
774
 
 
775
        It may be possible to set the branch last revision to an id not
 
776
        present in the repository.  However, branches can also be
 
777
        configured to check constraints on history, in which case this may not
 
778
        be permitted.
 
779
        """
 
780
        raise NotImplementedError(self.set_last_revision_info)
 
781
 
 
782
    @needs_write_lock
 
783
    def generate_revision_history(self, revision_id, last_rev=None,
 
784
                                  other_branch=None):
 
785
        """See Branch.generate_revision_history"""
 
786
        graph = self.repository.get_graph()
 
787
        (last_revno, last_revid) = self.last_revision_info()
 
788
        known_revision_ids = [
 
789
            (last_revid, last_revno),
 
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)
744
798
 
745
799
    @needs_write_lock
746
800
    def set_parent(self, url):
790
844
 
791
845
    def _unstack(self):
792
846
        """Change a branch to be unstacked, copying data as needed.
793
 
        
 
847
 
794
848
        Don't call this directly, use set_stacked_on_url(None).
795
849
        """
796
850
        pb = ui.ui_factory.nested_progress_bar()
805
859
            old_repository = self.repository
806
860
            if len(old_repository._fallback_repositories) != 1:
807
861
                raise AssertionError("can't cope with fallback repositories "
808
 
                    "of %r" % (self.repository,))
 
862
                    "of %r (fallbacks: %r)" % (old_repository,
 
863
                        old_repository._fallback_repositories))
809
864
            # Open the new repository object.
810
865
            # Repositories don't offer an interface to remove fallback
811
866
            # repositories today; take the conceptually simpler option and just
859
914
                # XXX: If you unstack a branch while it has a working tree
860
915
                # with a pending merge, the pending-merged revisions will no
861
916
                # longer be present.  You can (probably) revert and remerge.
862
 
                #
863
 
                # XXX: This only fetches up to the tip of the repository; it
864
 
                # doesn't bring across any tags.  That's fairly consistent
865
 
                # with how branch works, but perhaps not ideal.
866
 
                self.repository.fetch(old_repository,
867
 
                    revision_id=self.last_revision(),
868
 
                    find_ghosts=True)
 
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)
869
925
            finally:
870
926
                old_repository.unlock()
871
927
        finally:
876
932
 
877
933
        :seealso: Branch._get_tags_bytes.
878
934
        """
879
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
880
 
            'tags', bytes)
 
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)
881
942
 
882
943
    def _cache_revision_history(self, rev_history):
883
944
        """Set the cached revision history to rev_history.
910
971
        self._revision_history_cache = None
911
972
        self._revision_id_to_revno_cache = None
912
973
        self._last_revision_info_cache = None
 
974
        self._master_branch_cache = None
913
975
        self._merge_sorted_revisions_cache = None
914
976
        self._partial_revision_history_cache = []
915
977
        self._partial_revision_id_to_revno_cache = {}
 
978
        self._tags_bytes = None
916
979
 
917
980
    def _gen_revision_history(self):
918
981
        """Return sequence of revision hashes on to this branch.
968
1031
        :return: A tuple (revno, revision_id).
969
1032
        """
970
1033
        if self._last_revision_info_cache is None:
971
 
            self._last_revision_info_cache = self._last_revision_info()
 
1034
            self._last_revision_info_cache = self._read_last_revision_info()
972
1035
        return self._last_revision_info_cache
973
1036
 
974
 
    def _last_revision_info(self):
975
 
        rh = self.revision_history()
976
 
        revno = len(rh)
977
 
        if revno:
978
 
            return (revno, rh[-1])
979
 
        else:
980
 
            return (0, _mod_revision.NULL_REVISION)
981
 
 
982
 
    @deprecated_method(deprecated_in((1, 6, 0)))
983
 
    def missing_revisions(self, other, stop_revision=None):
984
 
        """Return a list of new revisions that would perfectly fit.
985
 
 
986
 
        If self and other have not diverged, return a list of the revisions
987
 
        present in other, but missing from self.
988
 
        """
989
 
        self_history = self.revision_history()
990
 
        self_len = len(self_history)
991
 
        other_history = other.revision_history()
992
 
        other_len = len(other_history)
993
 
        common_index = min(self_len, other_len) -1
994
 
        if common_index >= 0 and \
995
 
            self_history[common_index] != other_history[common_index]:
996
 
            raise errors.DivergedBranches(self, other)
997
 
 
998
 
        if stop_revision is None:
999
 
            stop_revision = other_len
1000
 
        else:
1001
 
            if stop_revision > other_len:
1002
 
                raise errors.NoSuchRevision(self, stop_revision)
1003
 
        return other_history[self_len:stop_revision]
1004
 
 
1005
 
    def update_revisions(self, other, stop_revision=None, overwrite=False,
1006
 
                         graph=None):
1007
 
        """Pull in new perfect-fit revisions.
1008
 
 
1009
 
        :param other: Another Branch to pull from
1010
 
        :param stop_revision: Updated until the given revision
1011
 
        :param overwrite: Always set the branch pointer, rather than checking
1012
 
            to see if it is a proper descendant.
1013
 
        :param graph: A Graph object that can be used to query history
1014
 
            information. This can be None.
1015
 
        :return: None
1016
 
        """
1017
 
        return InterBranch.get(other, self).update_revisions(stop_revision,
1018
 
            overwrite, graph)
1019
 
 
 
1037
    def _read_last_revision_info(self):
 
1038
        raise NotImplementedError(self._read_last_revision_info)
 
1039
 
 
1040
    @deprecated_method(deprecated_in((2, 4, 0)))
1020
1041
    def import_last_revision_info(self, source_repo, revno, revid):
1021
1042
        """Set the last revision info, importing from another repo if necessary.
1022
1043
 
1023
 
        This is used by the bound branch code to upload a revision to
1024
 
        the master branch first before updating the tip of the local branch.
1025
 
 
1026
1044
        :param source_repo: Source repository to optionally fetch from
1027
1045
        :param revno: Revision number of the new tip
1028
1046
        :param revid: Revision id of the new tip
1031
1049
            self.repository.fetch(source_repo, revision_id=revid)
1032
1050
        self.set_last_revision_info(revno, revid)
1033
1051
 
 
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
 
1034
1073
    def revision_id_to_revno(self, revision_id):
1035
1074
        """Given a revision id, return its revno"""
1036
1075
        if _mod_revision.is_null(revision_id):
1068
1107
            stop_revision=stop_revision,
1069
1108
            possible_transports=possible_transports, *args, **kwargs)
1070
1109
 
1071
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1072
 
        **kwargs):
 
1110
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
 
1111
            *args, **kwargs):
1073
1112
        """Mirror this branch into target.
1074
1113
 
1075
1114
        This branch is considered to be 'local', having low latency.
1076
1115
        """
1077
1116
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1078
 
            *args, **kwargs)
1079
 
 
1080
 
    def lossy_push(self, target, stop_revision=None):
1081
 
        """Push deltas into another branch.
1082
 
 
1083
 
        :note: This does not, like push, retain the revision ids from 
1084
 
            the source branch and will, rather than adding bzr-specific 
1085
 
            metadata, push only those semantics of the revision that can be 
1086
 
            natively represented by this branch' VCS.
1087
 
 
1088
 
        :param target: Target branch
1089
 
        :param stop_revision: Revision to push, defaults to last revision.
1090
 
        :return: BranchPushResult with an extra member revidmap: 
1091
 
            A dictionary mapping revision ids from the target branch 
1092
 
            to new revision ids in the target branch, for each 
1093
 
            revision that was pushed.
1094
 
        """
1095
 
        inter = InterBranch.get(self, target)
1096
 
        lossy_push = getattr(inter, "lossy_push", None)
1097
 
        if lossy_push is None:
1098
 
            raise errors.LossyPushToSameVCS(self, target)
1099
 
        return lossy_push(stop_revision)
 
1117
            lossy, *args, **kwargs)
1100
1118
 
1101
1119
    def basis_tree(self):
1102
1120
        """Return `Tree` object for last revision."""
1257
1275
        return result
1258
1276
 
1259
1277
    @needs_read_lock
1260
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1278
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1279
            repository=None):
1261
1280
        """Create a new line of development from the branch, into to_bzrdir.
1262
1281
 
1263
1282
        to_bzrdir controls the branch format.
1268
1287
        if (repository_policy is not None and
1269
1288
            repository_policy.requires_stacking()):
1270
1289
            to_bzrdir._format.require_stacking(_skip_repo=True)
1271
 
        result = to_bzrdir.create_branch()
 
1290
        result = to_bzrdir.create_branch(repository=repository)
1272
1291
        result.lock_write()
1273
1292
        try:
1274
1293
            if repository_policy is not None:
1275
1294
                repository_policy.configure_branch(result)
1276
1295
            self.copy_content_into(result, revision_id=revision_id)
1277
 
            result.set_parent(self.bzrdir.root_transport.base)
 
1296
            master_url = self.get_bound_location()
 
1297
            if master_url is None:
 
1298
                result.set_parent(self.bzrdir.root_transport.base)
 
1299
            else:
 
1300
                result.set_parent(master_url)
1278
1301
        finally:
1279
1302
            result.unlock()
1280
1303
        return result
1358
1381
        # specific check.
1359
1382
        return result
1360
1383
 
1361
 
    def _get_checkout_format(self):
 
1384
    def _get_checkout_format(self, lightweight=False):
1362
1385
        """Return the most suitable metadir for a checkout of this branch.
1363
1386
        Weaves are used if this branch's repository uses weaves.
1364
1387
        """
1365
 
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1366
 
            from bzrlib.repofmt import weaverepo
1367
 
            format = bzrdir.BzrDirMetaFormat1()
1368
 
            format.repository_format = weaverepo.RepositoryFormat7()
1369
 
        else:
1370
 
            format = self.repository.bzrdir.checkout_metadir()
1371
 
            format.set_branch_format(self._format)
 
1388
        format = self.repository.bzrdir.checkout_metadir()
 
1389
        format.set_branch_format(self._format)
1372
1390
        return format
1373
1391
 
1374
1392
    def create_clone_on_transport(self, to_transport, revision_id=None,
1375
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1393
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1394
        no_tree=None):
1376
1395
        """Create a clone of this branch and its bzrdir.
1377
1396
 
1378
1397
        :param to_transport: The transport to clone onto.
1391
1410
            revision_id = self.last_revision()
1392
1411
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1393
1412
            revision_id=revision_id, stacked_on=stacked_on,
1394
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1413
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1414
            no_tree=no_tree)
1395
1415
        return dir_to.open_branch()
1396
1416
 
1397
1417
    def create_checkout(self, to_location, revision_id=None,
1402
1422
        :param to_location: The url to produce the checkout at
1403
1423
        :param revision_id: The revision to check out
1404
1424
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1405
 
        produce a bound branch (heavyweight checkout)
 
1425
            produce a bound branch (heavyweight checkout)
1406
1426
        :param accelerator_tree: A tree which can be used for retrieving file
1407
1427
            contents more quickly than the revision tree, i.e. a workingtree.
1408
1428
            The revision tree will be used for cases where accelerator_tree's
1413
1433
        """
1414
1434
        t = transport.get_transport(to_location)
1415
1435
        t.ensure_base()
 
1436
        format = self._get_checkout_format(lightweight=lightweight)
1416
1437
        if lightweight:
1417
 
            format = self._get_checkout_format()
1418
1438
            checkout = format.initialize_on_transport(t)
1419
1439
            from_branch = BranchReferenceFormat().initialize(checkout, 
1420
1440
                target_branch=self)
1421
1441
        else:
1422
 
            format = self._get_checkout_format()
1423
1442
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1424
1443
                to_location, force_new_tree=False, format=format)
1425
1444
            checkout = checkout_branch.bzrdir
1454
1473
 
1455
1474
    def reference_parent(self, file_id, path, possible_transports=None):
1456
1475
        """Return the parent branch for a tree-reference file_id
 
1476
 
1457
1477
        :param file_id: The file_id of the tree reference
1458
1478
        :param path: The path of the file_id in the tree
1459
1479
        :return: A branch associated with the file_id
1512
1532
        else:
1513
1533
            raise AssertionError("invalid heads: %r" % (heads,))
1514
1534
 
1515
 
 
1516
 
class BranchFormat(object):
 
1535
    def heads_to_fetch(self):
 
1536
        """Return the heads that must and that should be fetched to copy this
 
1537
        branch into another repo.
 
1538
 
 
1539
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1540
            set of heads that must be fetched.  if_present_fetch is a set of
 
1541
            heads that must be fetched if present, but no error is necessary if
 
1542
            they are not present.
 
1543
        """
 
1544
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
 
1545
        # are the tags.
 
1546
        must_fetch = set([self.last_revision()])
 
1547
        if_present_fetch = set()
 
1548
        c = self.get_config()
 
1549
        include_tags = c.get_user_option_as_bool('branch.fetch_tags',
 
1550
                                                 default=False)
 
1551
        if include_tags:
 
1552
            try:
 
1553
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1554
            except errors.TagsNotSupported:
 
1555
                pass
 
1556
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1557
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1558
        return must_fetch, if_present_fetch
 
1559
 
 
1560
 
 
1561
class BranchFormat(controldir.ControlComponentFormat):
1517
1562
    """An encapsulation of the initialization and open routines for a format.
1518
1563
 
1519
1564
    Formats provide three things:
1531
1576
    object will be created every time regardless.
1532
1577
    """
1533
1578
 
1534
 
    _default_format = None
1535
 
    """The default format used for new branches."""
1536
 
 
1537
 
    _formats = {}
1538
 
    """The known formats."""
1539
 
 
1540
 
    can_set_append_revisions_only = True
1541
 
 
1542
1579
    def __eq__(self, other):
1543
1580
        return self.__class__ is other.__class__
1544
1581
 
1551
1588
        try:
1552
1589
            transport = a_bzrdir.get_branch_transport(None, name=name)
1553
1590
            format_string = transport.get_bytes("format")
1554
 
            format = klass._formats[format_string]
1555
 
            if isinstance(format, MetaDirBranchFormatFactory):
1556
 
                return format()
1557
 
            return format
 
1591
            return format_registry.get(format_string)
1558
1592
        except errors.NoSuchFile:
1559
1593
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1560
1594
        except KeyError:
1561
1595
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1562
1596
 
1563
1597
    @classmethod
 
1598
    @deprecated_method(deprecated_in((2, 4, 0)))
1564
1599
    def get_default_format(klass):
1565
1600
        """Return the current default format."""
1566
 
        return klass._default_format
 
1601
        return format_registry.get_default()
1567
1602
 
1568
1603
    @classmethod
 
1604
    @deprecated_method(deprecated_in((2, 4, 0)))
1569
1605
    def get_formats(klass):
1570
1606
        """Get all the known formats.
1571
1607
 
1572
1608
        Warning: This triggers a load of all lazy registered formats: do not
1573
1609
        use except when that is desireed.
1574
1610
        """
1575
 
        result = []
1576
 
        for fmt in klass._formats.values():
1577
 
            if isinstance(fmt, MetaDirBranchFormatFactory):
1578
 
                fmt = fmt()
1579
 
            result.append(fmt)
1580
 
        return result
 
1611
        return format_registry._get_all()
1581
1612
 
1582
1613
    def get_reference(self, a_bzrdir, name=None):
1583
1614
        """Get the target reference of the branch in a_bzrdir.
1622
1653
        for hook in hooks:
1623
1654
            hook(params)
1624
1655
 
1625
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1626
 
                           lock_type='metadir', set_format=True):
1627
 
        """Initialize a branch in a bzrdir, with specified files
1628
 
 
1629
 
        :param a_bzrdir: The bzrdir to initialize the branch in
1630
 
        :param utf8_files: The files to create as a list of
1631
 
            (filename, content) tuples
1632
 
        :param name: Name of colocated branch to create, if any
1633
 
        :param set_format: If True, set the format with
1634
 
            self.get_format_string.  (BzrBranch4 has its format set
1635
 
            elsewhere)
1636
 
        :return: a branch in this format
1637
 
        """
1638
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1639
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1640
 
        lock_map = {
1641
 
            'metadir': ('lock', lockdir.LockDir),
1642
 
            'branch4': ('branch-lock', lockable_files.TransportLock),
1643
 
        }
1644
 
        lock_name, lock_class = lock_map[lock_type]
1645
 
        control_files = lockable_files.LockableFiles(branch_transport,
1646
 
            lock_name, lock_class)
1647
 
        control_files.create_lock()
1648
 
        try:
1649
 
            control_files.lock_write()
1650
 
        except errors.LockContention:
1651
 
            if lock_type != 'branch4':
1652
 
                raise
1653
 
            lock_taken = False
1654
 
        else:
1655
 
            lock_taken = True
1656
 
        if set_format:
1657
 
            utf8_files += [('format', self.get_format_string())]
1658
 
        try:
1659
 
            for (filename, content) in utf8_files:
1660
 
                branch_transport.put_bytes(
1661
 
                    filename, content,
1662
 
                    mode=a_bzrdir._get_file_mode())
1663
 
        finally:
1664
 
            if lock_taken:
1665
 
                control_files.unlock()
1666
 
        branch = self.open(a_bzrdir, name, _found=True)
1667
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1668
 
        return branch
1669
 
 
1670
 
    def initialize(self, a_bzrdir, name=None):
 
1656
    def initialize(self, a_bzrdir, name=None, repository=None,
 
1657
                   append_revisions_only=None):
1671
1658
        """Create a branch of this format in a_bzrdir.
1672
1659
        
1673
1660
        :param name: Name of the colocated branch to create.
1695
1682
        Note that it is normal for branch to be a RemoteBranch when using tags
1696
1683
        on a RemoteBranch.
1697
1684
        """
1698
 
        return DisabledTags(branch)
 
1685
        return _mod_tag.DisabledTags(branch)
1699
1686
 
1700
1687
    def network_name(self):
1701
1688
        """A simple byte string uniquely identifying this format for RPC calls.
1707
1694
        """
1708
1695
        raise NotImplementedError(self.network_name)
1709
1696
 
1710
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1697
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
1698
            found_repository=None):
1711
1699
        """Return the branch object for a_bzrdir
1712
1700
 
1713
1701
        :param a_bzrdir: A BzrDir that contains a branch.
1720
1708
        raise NotImplementedError(self.open)
1721
1709
 
1722
1710
    @classmethod
 
1711
    @deprecated_method(deprecated_in((2, 4, 0)))
1723
1712
    def register_format(klass, format):
1724
1713
        """Register a metadir format.
1725
 
        
 
1714
 
1726
1715
        See MetaDirBranchFormatFactory for the ability to register a format
1727
1716
        without loading the code the format needs until it is actually used.
1728
1717
        """
1729
 
        klass._formats[format.get_format_string()] = format
1730
 
        # Metadir formats have a network name of their format string, and get
1731
 
        # registered as factories.
1732
 
        if isinstance(format, MetaDirBranchFormatFactory):
1733
 
            network_format_registry.register(format.get_format_string(), format)
1734
 
        else:
1735
 
            network_format_registry.register(format.get_format_string(),
1736
 
                format.__class__)
 
1718
        format_registry.register(format)
1737
1719
 
1738
1720
    @classmethod
 
1721
    @deprecated_method(deprecated_in((2, 4, 0)))
1739
1722
    def set_default_format(klass, format):
1740
 
        klass._default_format = format
 
1723
        format_registry.set_default(format)
1741
1724
 
1742
1725
    def supports_set_append_revisions_only(self):
1743
1726
        """True if this format supports set_append_revisions_only."""
1747
1730
        """True if this format records a stacked-on branch."""
1748
1731
        return False
1749
1732
 
 
1733
    def supports_leaving_lock(self):
 
1734
        """True if this format supports leaving locks in place."""
 
1735
        return False # by default
 
1736
 
1750
1737
    @classmethod
 
1738
    @deprecated_method(deprecated_in((2, 4, 0)))
1751
1739
    def unregister_format(klass, format):
1752
 
        del klass._formats[format.get_format_string()]
 
1740
        format_registry.remove(format)
1753
1741
 
1754
1742
    def __str__(self):
1755
1743
        return self.get_format_description().rstrip()
1758
1746
        """True if this format supports tags stored in the branch"""
1759
1747
        return False  # by default
1760
1748
 
 
1749
    def tags_are_versioned(self):
 
1750
        """Whether the tag container for this branch versions tags."""
 
1751
        return False
 
1752
 
 
1753
    def supports_tags_referencing_ghosts(self):
 
1754
        """True if tags can reference ghost revisions."""
 
1755
        return True
 
1756
 
1761
1757
 
1762
1758
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1763
1759
    """A factory for a BranchFormat object, permitting simple lazy registration.
1800
1796
        These are all empty initially, because by default nothing should get
1801
1797
        notified.
1802
1798
        """
1803
 
        Hooks.__init__(self)
1804
 
        self.create_hook(HookPoint('set_rh',
 
1799
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1800
        self.add_hook('set_rh',
1805
1801
            "Invoked whenever the revision history has been set via "
1806
1802
            "set_revision_history. The api signature is (branch, "
1807
1803
            "revision_history), and the branch will be write-locked. "
1808
1804
            "The set_rh hook can be expensive for bzr to trigger, a better "
1809
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1810
 
        self.create_hook(HookPoint('open',
 
1805
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
 
1806
        self.add_hook('open',
1811
1807
            "Called with the Branch object that has been opened after a "
1812
 
            "branch is opened.", (1, 8), None))
1813
 
        self.create_hook(HookPoint('post_push',
 
1808
            "branch is opened.", (1, 8))
 
1809
        self.add_hook('post_push',
1814
1810
            "Called after a push operation completes. post_push is called "
1815
1811
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1816
 
            "bzr client.", (0, 15), None))
1817
 
        self.create_hook(HookPoint('post_pull',
 
1812
            "bzr client.", (0, 15))
 
1813
        self.add_hook('post_pull',
1818
1814
            "Called after a pull operation completes. post_pull is called "
1819
1815
            "with a bzrlib.branch.PullResult object and only runs in the "
1820
 
            "bzr client.", (0, 15), None))
1821
 
        self.create_hook(HookPoint('pre_commit',
 
1816
            "bzr client.", (0, 15))
 
1817
        self.add_hook('pre_commit',
1822
1818
            "Called after a commit is calculated but before it is "
1823
1819
            "completed. pre_commit is called with (local, master, old_revno, "
1824
1820
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1827
1823
            "basis revision. hooks MUST NOT modify this delta. "
1828
1824
            " future_tree is an in-memory tree obtained from "
1829
1825
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1830
 
            "tree.", (0,91), None))
1831
 
        self.create_hook(HookPoint('post_commit',
 
1826
            "tree.", (0,91))
 
1827
        self.add_hook('post_commit',
1832
1828
            "Called in the bzr client after a commit has completed. "
1833
1829
            "post_commit is called with (local, master, old_revno, old_revid, "
1834
1830
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1835
 
            "commit to a branch.", (0, 15), None))
1836
 
        self.create_hook(HookPoint('post_uncommit',
 
1831
            "commit to a branch.", (0, 15))
 
1832
        self.add_hook('post_uncommit',
1837
1833
            "Called in the bzr client after an uncommit completes. "
1838
1834
            "post_uncommit is called with (local, master, old_revno, "
1839
1835
            "old_revid, new_revno, new_revid) where local is the local branch "
1840
1836
            "or None, master is the target branch, and an empty branch "
1841
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1842
 
        self.create_hook(HookPoint('pre_change_branch_tip',
 
1837
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1838
        self.add_hook('pre_change_branch_tip',
1843
1839
            "Called in bzr client and server before a change to the tip of a "
1844
1840
            "branch is made. pre_change_branch_tip is called with a "
1845
1841
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1846
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1847
 
        self.create_hook(HookPoint('post_change_branch_tip',
 
1842
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1843
        self.add_hook('post_change_branch_tip',
1848
1844
            "Called in bzr client and server after a change to the tip of a "
1849
1845
            "branch is made. post_change_branch_tip is called with a "
1850
1846
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1851
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1852
 
        self.create_hook(HookPoint('transform_fallback_location',
 
1847
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1848
        self.add_hook('transform_fallback_location',
1853
1849
            "Called when a stacked branch is activating its fallback "
1854
1850
            "locations. transform_fallback_location is called with (branch, "
1855
1851
            "url), and should return a new url. Returning the same url "
1860
1856
            "fallback locations have not been activated. When there are "
1861
1857
            "multiple hooks installed for transform_fallback_location, "
1862
1858
            "all are called with the url returned from the previous hook."
1863
 
            "The order is however undefined.", (1, 9), None))
1864
 
        self.create_hook(HookPoint('automatic_tag_name',
 
1859
            "The order is however undefined.", (1, 9))
 
1860
        self.add_hook('automatic_tag_name',
1865
1861
            "Called to determine an automatic tag name for a revision. "
1866
1862
            "automatic_tag_name is called with (branch, revision_id) and "
1867
1863
            "should return a tag name or None if no tag name could be "
1868
1864
            "determined. The first non-None tag name returned will be used.",
1869
 
            (2, 2), None))
1870
 
        self.create_hook(HookPoint('post_branch_init',
 
1865
            (2, 2))
 
1866
        self.add_hook('post_branch_init',
1871
1867
            "Called after new branch initialization completes. "
1872
1868
            "post_branch_init is called with a "
1873
1869
            "bzrlib.branch.BranchInitHookParams. "
1874
1870
            "Note that init, branch and checkout (both heavyweight and "
1875
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1876
 
        self.create_hook(HookPoint('post_switch',
 
1871
            "lightweight) will all trigger this hook.", (2, 2))
 
1872
        self.add_hook('post_switch',
1877
1873
            "Called after a checkout switches branch. "
1878
1874
            "post_switch is called with a "
1879
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1875
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1880
1876
 
1881
1877
 
1882
1878
 
1885
1881
 
1886
1882
 
1887
1883
class ChangeBranchTipParams(object):
1888
 
    """Object holding parameters passed to *_change_branch_tip hooks.
 
1884
    """Object holding parameters passed to `*_change_branch_tip` hooks.
1889
1885
 
1890
1886
    There are 5 fields that hooks may wish to access:
1891
1887
 
1923
1919
 
1924
1920
 
1925
1921
class BranchInitHookParams(object):
1926
 
    """Object holding parameters passed to *_branch_init hooks.
 
1922
    """Object holding parameters passed to `*_branch_init` hooks.
1927
1923
 
1928
1924
    There are 4 fields that hooks may wish to access:
1929
1925
 
1963
1959
 
1964
1960
 
1965
1961
class SwitchHookParams(object):
1966
 
    """Object holding parameters passed to *_switch hooks.
 
1962
    """Object holding parameters passed to `*_switch` hooks.
1967
1963
 
1968
1964
    There are 4 fields that hooks may wish to access:
1969
1965
 
1995
1991
            self.revision_id)
1996
1992
 
1997
1993
 
1998
 
class BzrBranchFormat4(BranchFormat):
1999
 
    """Bzr branch format 4.
2000
 
 
2001
 
    This format has:
2002
 
     - a revision-history file.
2003
 
     - a branch-lock lock file [ to be shared with the bzrdir ]
2004
 
    """
2005
 
 
2006
 
    def get_format_description(self):
2007
 
        """See BranchFormat.get_format_description()."""
2008
 
        return "Branch format 4"
2009
 
 
2010
 
    def initialize(self, a_bzrdir, name=None):
2011
 
        """Create a branch of this format in a_bzrdir."""
2012
 
        utf8_files = [('revision-history', ''),
2013
 
                      ('branch-name', ''),
2014
 
                      ]
2015
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
2016
 
                                       lock_type='branch4', set_format=False)
2017
 
 
2018
 
    def __init__(self):
2019
 
        super(BzrBranchFormat4, self).__init__()
2020
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
2021
 
 
2022
 
    def network_name(self):
2023
 
        """The network name for this format is the control dirs disk label."""
2024
 
        return self._matchingbzrdir.get_format_string()
2025
 
 
2026
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2027
 
        """See BranchFormat.open()."""
2028
 
        if not _found:
2029
 
            # we are being called directly and must probe.
2030
 
            raise NotImplementedError
2031
 
        return BzrBranch(_format=self,
2032
 
                         _control_files=a_bzrdir._control_files,
2033
 
                         a_bzrdir=a_bzrdir,
2034
 
                         name=name,
2035
 
                         _repository=a_bzrdir.open_repository())
2036
 
 
2037
 
    def __str__(self):
2038
 
        return "Bazaar-NG branch format 4"
2039
 
 
2040
 
 
2041
1994
class BranchFormatMetadir(BranchFormat):
2042
1995
    """Common logic for meta-dir based branch formats."""
2043
1996
 
2045
1998
        """What class to instantiate on open calls."""
2046
1999
        raise NotImplementedError(self._branch_class)
2047
2000
 
 
2001
    def _get_initial_config(self, append_revisions_only=None):
 
2002
        if append_revisions_only:
 
2003
            return "append_revisions_only = True\n"
 
2004
        else:
 
2005
            # Avoid writing anything if append_revisions_only is disabled,
 
2006
            # as that is the default.
 
2007
            return ""
 
2008
 
 
2009
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
2010
                           repository=None):
 
2011
        """Initialize a branch in a bzrdir, with specified files
 
2012
 
 
2013
        :param a_bzrdir: The bzrdir to initialize the branch in
 
2014
        :param utf8_files: The files to create as a list of
 
2015
            (filename, content) tuples
 
2016
        :param name: Name of colocated branch to create, if any
 
2017
        :return: a branch in this format
 
2018
        """
 
2019
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
2020
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
2021
        control_files = lockable_files.LockableFiles(branch_transport,
 
2022
            'lock', lockdir.LockDir)
 
2023
        control_files.create_lock()
 
2024
        control_files.lock_write()
 
2025
        try:
 
2026
            utf8_files += [('format', self.get_format_string())]
 
2027
            for (filename, content) in utf8_files:
 
2028
                branch_transport.put_bytes(
 
2029
                    filename, content,
 
2030
                    mode=a_bzrdir._get_file_mode())
 
2031
        finally:
 
2032
            control_files.unlock()
 
2033
        branch = self.open(a_bzrdir, name, _found=True,
 
2034
                found_repository=repository)
 
2035
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2036
        return branch
 
2037
 
2048
2038
    def network_name(self):
2049
2039
        """A simple byte string uniquely identifying this format for RPC calls.
2050
2040
 
2052
2042
        """
2053
2043
        return self.get_format_string()
2054
2044
 
2055
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2045
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2046
            found_repository=None):
2056
2047
        """See BranchFormat.open()."""
2057
2048
        if not _found:
2058
2049
            format = BranchFormat.find_format(a_bzrdir, name=name)
2063
2054
        try:
2064
2055
            control_files = lockable_files.LockableFiles(transport, 'lock',
2065
2056
                                                         lockdir.LockDir)
 
2057
            if found_repository is None:
 
2058
                found_repository = a_bzrdir.find_repository()
2066
2059
            return self._branch_class()(_format=self,
2067
2060
                              _control_files=control_files,
2068
2061
                              name=name,
2069
2062
                              a_bzrdir=a_bzrdir,
2070
 
                              _repository=a_bzrdir.find_repository(),
 
2063
                              _repository=found_repository,
2071
2064
                              ignore_fallbacks=ignore_fallbacks)
2072
2065
        except errors.NoSuchFile:
2073
2066
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2080
2073
    def supports_tags(self):
2081
2074
        return True
2082
2075
 
 
2076
    def supports_leaving_lock(self):
 
2077
        return True
 
2078
 
2083
2079
 
2084
2080
class BzrBranchFormat5(BranchFormatMetadir):
2085
2081
    """Bzr branch format 5.
2105
2101
        """See BranchFormat.get_format_description()."""
2106
2102
        return "Branch format 5"
2107
2103
 
2108
 
    def initialize(self, a_bzrdir, name=None):
 
2104
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2105
                   append_revisions_only=None):
2109
2106
        """Create a branch of this format in a_bzrdir."""
 
2107
        if append_revisions_only:
 
2108
            raise errors.UpgradeRequired(a_bzrdir.user_url)
2110
2109
        utf8_files = [('revision-history', ''),
2111
2110
                      ('branch-name', ''),
2112
2111
                      ]
2113
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2112
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2114
2113
 
2115
2114
    def supports_tags(self):
2116
2115
        return False
2138
2137
        """See BranchFormat.get_format_description()."""
2139
2138
        return "Branch format 6"
2140
2139
 
2141
 
    def initialize(self, a_bzrdir, name=None):
 
2140
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2141
                   append_revisions_only=None):
2142
2142
        """Create a branch of this format in a_bzrdir."""
2143
2143
        utf8_files = [('last-revision', '0 null:\n'),
2144
 
                      ('branch.conf', ''),
 
2144
                      ('branch.conf',
 
2145
                          self._get_initial_config(append_revisions_only)),
2145
2146
                      ('tags', ''),
2146
2147
                      ]
2147
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2148
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2148
2149
 
2149
2150
    def make_tags(self, branch):
2150
2151
        """See bzrlib.branch.BranchFormat.make_tags()."""
2151
 
        return BasicTags(branch)
 
2152
        return _mod_tag.BasicTags(branch)
2152
2153
 
2153
2154
    def supports_set_append_revisions_only(self):
2154
2155
        return True
2168
2169
        """See BranchFormat.get_format_description()."""
2169
2170
        return "Branch format 8"
2170
2171
 
2171
 
    def initialize(self, a_bzrdir, name=None):
 
2172
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2173
                   append_revisions_only=None):
2172
2174
        """Create a branch of this format in a_bzrdir."""
2173
2175
        utf8_files = [('last-revision', '0 null:\n'),
2174
 
                      ('branch.conf', ''),
 
2176
                      ('branch.conf',
 
2177
                          self._get_initial_config(append_revisions_only)),
2175
2178
                      ('tags', ''),
2176
2179
                      ('references', '')
2177
2180
                      ]
2178
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2179
 
 
2180
 
    def __init__(self):
2181
 
        super(BzrBranchFormat8, self).__init__()
2182
 
        self._matchingbzrdir.repository_format = \
2183
 
            RepositoryFormatKnitPack5RichRoot()
 
2181
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2184
2182
 
2185
2183
    def make_tags(self, branch):
2186
2184
        """See bzrlib.branch.BranchFormat.make_tags()."""
2187
 
        return BasicTags(branch)
 
2185
        return _mod_tag.BasicTags(branch)
2188
2186
 
2189
2187
    def supports_set_append_revisions_only(self):
2190
2188
        return True
2195
2193
    supports_reference_locations = True
2196
2194
 
2197
2195
 
2198
 
class BzrBranchFormat7(BzrBranchFormat8):
 
2196
class BzrBranchFormat7(BranchFormatMetadir):
2199
2197
    """Branch format with last-revision, tags, and a stacked location pointer.
2200
2198
 
2201
2199
    The stacked location pointer is passed down to the repository and requires
2204
2202
    This format was introduced in bzr 1.6.
2205
2203
    """
2206
2204
 
2207
 
    def initialize(self, a_bzrdir, name=None):
 
2205
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2206
                   append_revisions_only=None):
2208
2207
        """Create a branch of this format in a_bzrdir."""
2209
2208
        utf8_files = [('last-revision', '0 null:\n'),
2210
 
                      ('branch.conf', ''),
 
2209
                      ('branch.conf',
 
2210
                          self._get_initial_config(append_revisions_only)),
2211
2211
                      ('tags', ''),
2212
2212
                      ]
2213
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2213
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2214
2214
 
2215
2215
    def _branch_class(self):
2216
2216
        return BzrBranch7
2226
2226
    def supports_set_append_revisions_only(self):
2227
2227
        return True
2228
2228
 
 
2229
    def supports_stacking(self):
 
2230
        return True
 
2231
 
 
2232
    def make_tags(self, branch):
 
2233
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2234
        return _mod_tag.BasicTags(branch)
 
2235
 
2229
2236
    supports_reference_locations = False
2230
2237
 
2231
2238
 
2258
2265
        transport = a_bzrdir.get_branch_transport(None, name=name)
2259
2266
        location = transport.put_bytes('location', to_branch.base)
2260
2267
 
2261
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2268
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2269
            repository=None, append_revisions_only=None):
2262
2270
        """Create a branch of this format in a_bzrdir."""
2263
2271
        if target_branch is None:
2264
2272
            # this format does not implement branch itself, thus the implicit
2265
2273
            # creation contract must see it as uninitializable
2266
2274
            raise errors.UninitializableFormat(self)
2267
2275
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2276
        if a_bzrdir._format.fixed_components:
 
2277
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
2268
2278
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2269
2279
        branch_transport.put_bytes('location',
2270
2280
            target_branch.bzrdir.user_url)
2292
2302
        return clone
2293
2303
 
2294
2304
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2295
 
             possible_transports=None, ignore_fallbacks=False):
 
2305
             possible_transports=None, ignore_fallbacks=False,
 
2306
             found_repository=None):
2296
2307
        """Return the branch that the branch reference in a_bzrdir points at.
2297
2308
 
2298
2309
        :param a_bzrdir: A BzrDir that contains a branch.
2329
2340
        return result
2330
2341
 
2331
2342
 
 
2343
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2344
    """Branch format registry."""
 
2345
 
 
2346
    def __init__(self, other_registry=None):
 
2347
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2348
        self._default_format = None
 
2349
 
 
2350
    def set_default(self, format):
 
2351
        self._default_format = format
 
2352
 
 
2353
    def get_default(self):
 
2354
        return self._default_format
 
2355
 
 
2356
 
2332
2357
network_format_registry = registry.FormatRegistry()
2333
2358
"""Registry of formats indexed by their network name.
2334
2359
 
2337
2362
BranchFormat.network_name() for more detail.
2338
2363
"""
2339
2364
 
 
2365
format_registry = BranchFormatRegistry(network_format_registry)
 
2366
 
2340
2367
 
2341
2368
# formats which have no format string are not discoverable
2342
2369
# and not independently creatable, so are not registered.
2344
2371
__format6 = BzrBranchFormat6()
2345
2372
__format7 = BzrBranchFormat7()
2346
2373
__format8 = BzrBranchFormat8()
2347
 
BranchFormat.register_format(__format5)
2348
 
BranchFormat.register_format(BranchReferenceFormat())
2349
 
BranchFormat.register_format(__format6)
2350
 
BranchFormat.register_format(__format7)
2351
 
BranchFormat.register_format(__format8)
2352
 
BranchFormat.set_default_format(__format7)
2353
 
_legacy_formats = [BzrBranchFormat4(),
2354
 
    ]
2355
 
network_format_registry.register(
2356
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
 
2374
format_registry.register(__format5)
 
2375
format_registry.register(BranchReferenceFormat())
 
2376
format_registry.register(__format6)
 
2377
format_registry.register(__format7)
 
2378
format_registry.register(__format8)
 
2379
format_registry.set_default(__format7)
2357
2380
 
2358
2381
 
2359
2382
class BranchWriteLockResult(LogicalLockResult):
2426
2449
    base = property(_get_base, doc="The URL for the root of this branch.")
2427
2450
 
2428
2451
    def _get_config(self):
2429
 
        return TransportConfig(self._transport, 'branch.conf')
 
2452
        return _mod_config.TransportConfig(self._transport, 'branch.conf')
2430
2453
 
2431
2454
    def is_locked(self):
2432
2455
        return self.control_files.is_locked()
2507
2530
        """See Branch.print_file."""
2508
2531
        return self.repository.print_file(file, revision_id)
2509
2532
 
2510
 
    def _write_revision_history(self, history):
2511
 
        """Factored out of set_revision_history.
2512
 
 
2513
 
        This performs the actual writing to disk.
2514
 
        It is intended to be called by BzrBranch5.set_revision_history."""
2515
 
        self._transport.put_bytes(
2516
 
            'revision-history', '\n'.join(history),
2517
 
            mode=self.bzrdir._get_file_mode())
2518
 
 
2519
 
    @needs_write_lock
2520
 
    def set_revision_history(self, rev_history):
2521
 
        """See Branch.set_revision_history."""
2522
 
        if 'evil' in debug.debug_flags:
2523
 
            mutter_callsite(3, "set_revision_history scales with history.")
2524
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2525
 
        for rev_id in rev_history:
2526
 
            check_not_reserved_id(rev_id)
2527
 
        if Branch.hooks['post_change_branch_tip']:
2528
 
            # Don't calculate the last_revision_info() if there are no hooks
2529
 
            # that will use it.
2530
 
            old_revno, old_revid = self.last_revision_info()
2531
 
        if len(rev_history) == 0:
2532
 
            revid = _mod_revision.NULL_REVISION
2533
 
        else:
2534
 
            revid = rev_history[-1]
2535
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2536
 
        self._write_revision_history(rev_history)
2537
 
        self._clear_cached_state()
2538
 
        self._cache_revision_history(rev_history)
2539
 
        for hook in Branch.hooks['set_rh']:
2540
 
            hook(self, rev_history)
2541
 
        if Branch.hooks['post_change_branch_tip']:
2542
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2543
 
 
2544
 
    def _synchronize_history(self, destination, revision_id):
2545
 
        """Synchronize last revision and revision history between branches.
2546
 
 
2547
 
        This version is most efficient when the destination is also a
2548
 
        BzrBranch5, but works for BzrBranch6 as long as the revision
2549
 
        history is the true lefthand parent history, and all of the revisions
2550
 
        are in the destination's repository.  If not, set_revision_history
2551
 
        will fail.
2552
 
 
2553
 
        :param destination: The branch to copy the history into
2554
 
        :param revision_id: The revision-id to truncate history at.  May
2555
 
          be None to copy complete history.
2556
 
        """
2557
 
        if not isinstance(destination._format, BzrBranchFormat5):
2558
 
            super(BzrBranch, self)._synchronize_history(
2559
 
                destination, revision_id)
2560
 
            return
2561
 
        if revision_id == _mod_revision.NULL_REVISION:
2562
 
            new_history = []
2563
 
        else:
2564
 
            new_history = self.revision_history()
2565
 
        if revision_id is not None and new_history != []:
2566
 
            try:
2567
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2568
 
            except ValueError:
2569
 
                rev = self.repository.get_revision(revision_id)
2570
 
                new_history = rev.get_history(self.repository)[1:]
2571
 
        destination.set_revision_history(new_history)
2572
 
 
2573
2533
    @needs_write_lock
2574
2534
    def set_last_revision_info(self, revno, revision_id):
2575
 
        """Set the last revision of this branch.
2576
 
 
2577
 
        The caller is responsible for checking that the revno is correct
2578
 
        for this revision id.
2579
 
 
2580
 
        It may be possible to set the branch last revision to an id not
2581
 
        present in the repository.  However, branches can also be
2582
 
        configured to check constraints on history, in which case this may not
2583
 
        be permitted.
2584
 
        """
 
2535
        if not revision_id or not isinstance(revision_id, basestring):
 
2536
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2585
2537
        revision_id = _mod_revision.ensure_null(revision_id)
2586
 
        # this old format stores the full history, but this api doesn't
2587
 
        # provide it, so we must generate, and might as well check it's
2588
 
        # correct
2589
 
        history = self._lefthand_history(revision_id)
2590
 
        if len(history) != revno:
2591
 
            raise AssertionError('%d != %d' % (len(history), revno))
2592
 
        self.set_revision_history(history)
2593
 
 
2594
 
    def _gen_revision_history(self):
2595
 
        history = self._transport.get_bytes('revision-history').split('\n')
2596
 
        if history[-1:] == ['']:
2597
 
            # There shouldn't be a trailing newline, but just in case.
2598
 
            history.pop()
2599
 
        return history
2600
 
 
2601
 
    @needs_write_lock
2602
 
    def generate_revision_history(self, revision_id, last_rev=None,
2603
 
        other_branch=None):
2604
 
        """Create a new revision history that will finish with revision_id.
2605
 
 
2606
 
        :param revision_id: the new tip to use.
2607
 
        :param last_rev: The previous last_revision. If not None, then this
2608
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
2609
 
        :param other_branch: The other branch that DivergedBranches should
2610
 
            raise with respect to.
2611
 
        """
2612
 
        self.set_revision_history(self._lefthand_history(revision_id,
2613
 
            last_rev, other_branch))
 
2538
        old_revno, old_revid = self.last_revision_info()
 
2539
        if self.get_append_revisions_only():
 
2540
            self._check_history_violation(revision_id)
 
2541
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2542
        self._write_last_revision_info(revno, revision_id)
 
2543
        self._clear_cached_state()
 
2544
        self._last_revision_info_cache = revno, revision_id
 
2545
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2614
2546
 
2615
2547
    def basis_tree(self):
2616
2548
        """See Branch.basis_tree."""
2625
2557
                pass
2626
2558
        return None
2627
2559
 
2628
 
    def _basic_push(self, target, overwrite, stop_revision):
2629
 
        """Basic implementation of push without bound branches or hooks.
2630
 
 
2631
 
        Must be called with source read locked and target write locked.
2632
 
        """
2633
 
        result = BranchPushResult()
2634
 
        result.source_branch = self
2635
 
        result.target_branch = target
2636
 
        result.old_revno, result.old_revid = target.last_revision_info()
2637
 
        self.update_references(target)
2638
 
        if result.old_revid != self.last_revision():
2639
 
            # We assume that during 'push' this repository is closer than
2640
 
            # the target.
2641
 
            graph = self.repository.get_graph(target.repository)
2642
 
            target.update_revisions(self, stop_revision,
2643
 
                overwrite=overwrite, graph=graph)
2644
 
        if self._push_should_merge_tags():
2645
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2646
 
                overwrite)
2647
 
        result.new_revno, result.new_revid = target.last_revision_info()
2648
 
        return result
2649
 
 
2650
2560
    def get_stacked_on_url(self):
2651
2561
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2652
2562
 
2663
2573
            self._transport.put_bytes('parent', url + '\n',
2664
2574
                mode=self.bzrdir._get_file_mode())
2665
2575
 
2666
 
 
2667
 
class BzrBranch5(BzrBranch):
2668
 
    """A format 5 branch. This supports new features over plain branches.
2669
 
 
2670
 
    It has support for a master_branch which is the data for bound branches.
2671
 
    """
2672
 
 
2673
 
    def get_bound_location(self):
2674
 
        try:
2675
 
            return self._transport.get_bytes('bound')[:-1]
2676
 
        except errors.NoSuchFile:
2677
 
            return None
2678
 
 
2679
 
    @needs_read_lock
2680
 
    def get_master_branch(self, possible_transports=None):
2681
 
        """Return the branch we are bound to.
2682
 
 
2683
 
        :return: Either a Branch, or None
2684
 
 
2685
 
        This could memoise the branch, but if thats done
2686
 
        it must be revalidated on each new lock.
2687
 
        So for now we just don't memoise it.
2688
 
        # RBC 20060304 review this decision.
2689
 
        """
2690
 
        bound_loc = self.get_bound_location()
2691
 
        if not bound_loc:
2692
 
            return None
2693
 
        try:
2694
 
            return Branch.open(bound_loc,
2695
 
                               possible_transports=possible_transports)
2696
 
        except (errors.NotBranchError, errors.ConnectionError), e:
2697
 
            raise errors.BoundBranchConnectionFailure(
2698
 
                    self, bound_loc, e)
2699
 
 
2700
2576
    @needs_write_lock
2701
 
    def set_bound_location(self, location):
2702
 
        """Set the target where this branch is bound to.
2703
 
 
2704
 
        :param location: URL to the target branch
2705
 
        """
2706
 
        if location:
2707
 
            self._transport.put_bytes('bound', location+'\n',
2708
 
                mode=self.bzrdir._get_file_mode())
2709
 
        else:
2710
 
            try:
2711
 
                self._transport.delete('bound')
2712
 
            except errors.NoSuchFile:
2713
 
                return False
2714
 
            return True
 
2577
    def unbind(self):
 
2578
        """If bound, unbind"""
 
2579
        return self.set_bound_location(None)
2715
2580
 
2716
2581
    @needs_write_lock
2717
2582
    def bind(self, other):
2739
2604
        # history around
2740
2605
        self.set_bound_location(other.base)
2741
2606
 
 
2607
    def get_bound_location(self):
 
2608
        try:
 
2609
            return self._transport.get_bytes('bound')[:-1]
 
2610
        except errors.NoSuchFile:
 
2611
            return None
 
2612
 
 
2613
    @needs_read_lock
 
2614
    def get_master_branch(self, possible_transports=None):
 
2615
        """Return the branch we are bound to.
 
2616
 
 
2617
        :return: Either a Branch, or None
 
2618
        """
 
2619
        if self._master_branch_cache is None:
 
2620
            self._master_branch_cache = self._get_master_branch(
 
2621
                possible_transports)
 
2622
        return self._master_branch_cache
 
2623
 
 
2624
    def _get_master_branch(self, possible_transports):
 
2625
        bound_loc = self.get_bound_location()
 
2626
        if not bound_loc:
 
2627
            return None
 
2628
        try:
 
2629
            return Branch.open(bound_loc,
 
2630
                               possible_transports=possible_transports)
 
2631
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2632
            raise errors.BoundBranchConnectionFailure(
 
2633
                    self, bound_loc, e)
 
2634
 
2742
2635
    @needs_write_lock
2743
 
    def unbind(self):
2744
 
        """If bound, unbind"""
2745
 
        return self.set_bound_location(None)
 
2636
    def set_bound_location(self, location):
 
2637
        """Set the target where this branch is bound to.
 
2638
 
 
2639
        :param location: URL to the target branch
 
2640
        """
 
2641
        self._master_branch_cache = None
 
2642
        if location:
 
2643
            self._transport.put_bytes('bound', location+'\n',
 
2644
                mode=self.bzrdir._get_file_mode())
 
2645
        else:
 
2646
            try:
 
2647
                self._transport.delete('bound')
 
2648
            except errors.NoSuchFile:
 
2649
                return False
 
2650
            return True
2746
2651
 
2747
2652
    @needs_write_lock
2748
2653
    def update(self, possible_transports=None):
2761
2666
            return old_tip
2762
2667
        return None
2763
2668
 
2764
 
 
2765
 
class BzrBranch8(BzrBranch5):
 
2669
    def _read_last_revision_info(self):
 
2670
        revision_string = self._transport.get_bytes('last-revision')
 
2671
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2672
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2673
        revno = int(revno)
 
2674
        return revno, revision_id
 
2675
 
 
2676
    def _write_last_revision_info(self, revno, revision_id):
 
2677
        """Simply write out the revision id, with no checks.
 
2678
 
 
2679
        Use set_last_revision_info to perform this safely.
 
2680
 
 
2681
        Does not update the revision_history cache.
 
2682
        """
 
2683
        revision_id = _mod_revision.ensure_null(revision_id)
 
2684
        out_string = '%d %s\n' % (revno, revision_id)
 
2685
        self._transport.put_bytes('last-revision', out_string,
 
2686
            mode=self.bzrdir._get_file_mode())
 
2687
 
 
2688
 
 
2689
class FullHistoryBzrBranch(BzrBranch):
 
2690
    """Bzr branch which contains the full revision history."""
 
2691
 
 
2692
    @needs_write_lock
 
2693
    def set_last_revision_info(self, revno, revision_id):
 
2694
        if not revision_id or not isinstance(revision_id, basestring):
 
2695
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2696
        revision_id = _mod_revision.ensure_null(revision_id)
 
2697
        # this old format stores the full history, but this api doesn't
 
2698
        # provide it, so we must generate, and might as well check it's
 
2699
        # correct
 
2700
        history = self._lefthand_history(revision_id)
 
2701
        if len(history) != revno:
 
2702
            raise AssertionError('%d != %d' % (len(history), revno))
 
2703
        self._set_revision_history(history)
 
2704
 
 
2705
    def _read_last_revision_info(self):
 
2706
        rh = self.revision_history()
 
2707
        revno = len(rh)
 
2708
        if revno:
 
2709
            return (revno, rh[-1])
 
2710
        else:
 
2711
            return (0, _mod_revision.NULL_REVISION)
 
2712
 
 
2713
    @deprecated_method(deprecated_in((2, 4, 0)))
 
2714
    @needs_write_lock
 
2715
    def set_revision_history(self, rev_history):
 
2716
        """See Branch.set_revision_history."""
 
2717
        self._set_revision_history(rev_history)
 
2718
 
 
2719
    def _set_revision_history(self, rev_history):
 
2720
        if 'evil' in debug.debug_flags:
 
2721
            mutter_callsite(3, "set_revision_history scales with history.")
 
2722
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2723
        for rev_id in rev_history:
 
2724
            check_not_reserved_id(rev_id)
 
2725
        if Branch.hooks['post_change_branch_tip']:
 
2726
            # Don't calculate the last_revision_info() if there are no hooks
 
2727
            # that will use it.
 
2728
            old_revno, old_revid = self.last_revision_info()
 
2729
        if len(rev_history) == 0:
 
2730
            revid = _mod_revision.NULL_REVISION
 
2731
        else:
 
2732
            revid = rev_history[-1]
 
2733
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2734
        self._write_revision_history(rev_history)
 
2735
        self._clear_cached_state()
 
2736
        self._cache_revision_history(rev_history)
 
2737
        for hook in Branch.hooks['set_rh']:
 
2738
            hook(self, rev_history)
 
2739
        if Branch.hooks['post_change_branch_tip']:
 
2740
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2741
 
 
2742
    def _write_revision_history(self, history):
 
2743
        """Factored out of set_revision_history.
 
2744
 
 
2745
        This performs the actual writing to disk.
 
2746
        It is intended to be called by set_revision_history."""
 
2747
        self._transport.put_bytes(
 
2748
            'revision-history', '\n'.join(history),
 
2749
            mode=self.bzrdir._get_file_mode())
 
2750
 
 
2751
    def _gen_revision_history(self):
 
2752
        history = self._transport.get_bytes('revision-history').split('\n')
 
2753
        if history[-1:] == ['']:
 
2754
            # There shouldn't be a trailing newline, but just in case.
 
2755
            history.pop()
 
2756
        return history
 
2757
 
 
2758
    def _synchronize_history(self, destination, revision_id):
 
2759
        if not isinstance(destination, FullHistoryBzrBranch):
 
2760
            super(BzrBranch, self)._synchronize_history(
 
2761
                destination, revision_id)
 
2762
            return
 
2763
        if revision_id == _mod_revision.NULL_REVISION:
 
2764
            new_history = []
 
2765
        else:
 
2766
            new_history = self.revision_history()
 
2767
        if revision_id is not None and new_history != []:
 
2768
            try:
 
2769
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2770
            except ValueError:
 
2771
                rev = self.repository.get_revision(revision_id)
 
2772
                new_history = rev.get_history(self.repository)[1:]
 
2773
        destination._set_revision_history(new_history)
 
2774
 
 
2775
    @needs_write_lock
 
2776
    def generate_revision_history(self, revision_id, last_rev=None,
 
2777
        other_branch=None):
 
2778
        """Create a new revision history that will finish with revision_id.
 
2779
 
 
2780
        :param revision_id: the new tip to use.
 
2781
        :param last_rev: The previous last_revision. If not None, then this
 
2782
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2783
        :param other_branch: The other branch that DivergedBranches should
 
2784
            raise with respect to.
 
2785
        """
 
2786
        self._set_revision_history(self._lefthand_history(revision_id,
 
2787
            last_rev, other_branch))
 
2788
 
 
2789
 
 
2790
class BzrBranch5(FullHistoryBzrBranch):
 
2791
    """A format 5 branch. This supports new features over plain branches.
 
2792
 
 
2793
    It has support for a master_branch which is the data for bound branches.
 
2794
    """
 
2795
 
 
2796
 
 
2797
class BzrBranch8(BzrBranch):
2766
2798
    """A branch that stores tree-reference locations."""
2767
2799
 
2768
2800
    def _open_hook(self):
2794
2826
        self._last_revision_info_cache = None
2795
2827
        self._reference_info = None
2796
2828
 
2797
 
    def _last_revision_info(self):
2798
 
        revision_string = self._transport.get_bytes('last-revision')
2799
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2800
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2801
 
        revno = int(revno)
2802
 
        return revno, revision_id
2803
 
 
2804
 
    def _write_last_revision_info(self, revno, revision_id):
2805
 
        """Simply write out the revision id, with no checks.
2806
 
 
2807
 
        Use set_last_revision_info to perform this safely.
2808
 
 
2809
 
        Does not update the revision_history cache.
2810
 
        Intended to be called by set_last_revision_info and
2811
 
        _write_revision_history.
2812
 
        """
2813
 
        revision_id = _mod_revision.ensure_null(revision_id)
2814
 
        out_string = '%d %s\n' % (revno, revision_id)
2815
 
        self._transport.put_bytes('last-revision', out_string,
2816
 
            mode=self.bzrdir._get_file_mode())
2817
 
 
2818
 
    @needs_write_lock
2819
 
    def set_last_revision_info(self, revno, revision_id):
2820
 
        revision_id = _mod_revision.ensure_null(revision_id)
2821
 
        old_revno, old_revid = self.last_revision_info()
2822
 
        if self._get_append_revisions_only():
2823
 
            self._check_history_violation(revision_id)
2824
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2825
 
        self._write_last_revision_info(revno, revision_id)
2826
 
        self._clear_cached_state()
2827
 
        self._last_revision_info_cache = revno, revision_id
2828
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2829
 
 
2830
 
    def _synchronize_history(self, destination, revision_id):
2831
 
        """Synchronize last revision and revision history between branches.
2832
 
 
2833
 
        :see: Branch._synchronize_history
2834
 
        """
2835
 
        # XXX: The base Branch has a fast implementation of this method based
2836
 
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2837
 
        # that uses set_revision_history.  This class inherits from BzrBranch5,
2838
 
        # but wants the fast implementation, so it calls
2839
 
        # Branch._synchronize_history directly.
2840
 
        Branch._synchronize_history(self, destination, revision_id)
2841
 
 
2842
2829
    def _check_history_violation(self, revision_id):
2843
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
 
2830
        current_revid = self.last_revision()
 
2831
        last_revision = _mod_revision.ensure_null(current_revid)
2844
2832
        if _mod_revision.is_null(last_revision):
2845
2833
            return
2846
 
        if last_revision not in self._lefthand_history(revision_id):
2847
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2834
        graph = self.repository.get_graph()
 
2835
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
 
2836
            if lh_ancestor == current_revid:
 
2837
                return
 
2838
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
2848
2839
 
2849
2840
    def _gen_revision_history(self):
2850
2841
        """Generate the revision history from last revision
2853
2844
        self._extend_partial_history(stop_index=last_revno-1)
2854
2845
        return list(reversed(self._partial_revision_history_cache))
2855
2846
 
2856
 
    def _write_revision_history(self, history):
2857
 
        """Factored out of set_revision_history.
2858
 
 
2859
 
        This performs the actual writing to disk, with format-specific checks.
2860
 
        It is intended to be called by BzrBranch5.set_revision_history.
2861
 
        """
2862
 
        if len(history) == 0:
2863
 
            last_revision = 'null:'
2864
 
        else:
2865
 
            if history != self._lefthand_history(history[-1]):
2866
 
                raise errors.NotLefthandHistory(history)
2867
 
            last_revision = history[-1]
2868
 
        if self._get_append_revisions_only():
2869
 
            self._check_history_violation(last_revision)
2870
 
        self._write_last_revision_info(len(history), last_revision)
2871
 
 
2872
2847
    @needs_write_lock
2873
2848
    def _set_parent_location(self, url):
2874
2849
        """Set the parent branch"""
2960
2935
 
2961
2936
    def set_bound_location(self, location):
2962
2937
        """See Branch.set_push_location."""
 
2938
        self._master_branch_cache = None
2963
2939
        result = None
2964
2940
        config = self.get_config()
2965
2941
        if location is None:
2996
2972
        # you can always ask for the URL; but you might not be able to use it
2997
2973
        # if the repo can't support stacking.
2998
2974
        ## self._check_stackable_repo()
2999
 
        stacked_url = self._get_config_location('stacked_on_location')
 
2975
        # stacked_on_location is only ever defined in branch.conf, so don't
 
2976
        # waste effort reading the whole stack of config files.
 
2977
        config = self.get_config()._get_branch_data_config()
 
2978
        stacked_url = self._get_config_location('stacked_on_location',
 
2979
            config=config)
3000
2980
        if stacked_url is None:
3001
2981
            raise errors.NotStacked(self)
3002
2982
        return stacked_url
3003
2983
 
3004
 
    def _get_append_revisions_only(self):
3005
 
        return self.get_config(
3006
 
            ).get_user_option_as_bool('append_revisions_only')
3007
 
 
3008
 
    @needs_write_lock
3009
 
    def generate_revision_history(self, revision_id, last_rev=None,
3010
 
                                  other_branch=None):
3011
 
        """See BzrBranch5.generate_revision_history"""
3012
 
        history = self._lefthand_history(revision_id, last_rev, other_branch)
3013
 
        revno = len(history)
3014
 
        self.set_last_revision_info(revno, revision_id)
3015
 
 
3016
2984
    @needs_read_lock
3017
2985
    def get_rev_id(self, revno, history=None):
3018
2986
        """Find the revision id of the specified revno."""
3042
3010
        try:
3043
3011
            index = self._partial_revision_history_cache.index(revision_id)
3044
3012
        except ValueError:
3045
 
            self._extend_partial_history(stop_revision=revision_id)
 
3013
            try:
 
3014
                self._extend_partial_history(stop_revision=revision_id)
 
3015
            except errors.RevisionNotPresent, e:
 
3016
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3046
3017
            index = len(self._partial_revision_history_cache) - 1
3047
3018
            if self._partial_revision_history_cache[index] != revision_id:
3048
3019
                raise errors.NoSuchRevision(self, revision_id)
3101
3072
    :ivar local_branch: target branch if there is a Master, else None
3102
3073
    :ivar target_branch: Target/destination branch object. (write locked)
3103
3074
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
 
3075
    :ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3104
3076
    """
3105
3077
 
3106
3078
    @deprecated_method(deprecated_in((2, 3, 0)))
3112
3084
        return self.new_revno - self.old_revno
3113
3085
 
3114
3086
    def report(self, to_file):
 
3087
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
3088
        tag_updates = getattr(self, "tag_updates", None)
3115
3089
        if not is_quiet():
3116
 
            if self.old_revid == self.new_revid:
3117
 
                to_file.write('No revisions to pull.\n')
3118
 
            else:
 
3090
            if self.old_revid != self.new_revid:
3119
3091
                to_file.write('Now on revision %d.\n' % self.new_revno)
 
3092
            if tag_updates:
 
3093
                to_file.write('%d tag(s) updated.\n' % len(tag_updates))
 
3094
            if self.old_revid == self.new_revid and not tag_updates:
 
3095
                if not tag_conflicts:
 
3096
                    to_file.write('No revisions or tags to pull.\n')
 
3097
                else:
 
3098
                    to_file.write('No revisions to pull.\n')
3120
3099
        self._show_tag_conficts(to_file)
3121
3100
 
3122
3101
 
3148
3127
        return self.new_revno - self.old_revno
3149
3128
 
3150
3129
    def report(self, to_file):
3151
 
        """Write a human-readable description of the result."""
3152
 
        if self.old_revid == self.new_revid:
3153
 
            note('No new revisions to push.')
3154
 
        else:
3155
 
            note('Pushed up to revision %d.' % self.new_revno)
 
3130
        # TODO: This function gets passed a to_file, but then
 
3131
        # ignores it and calls note() instead. This is also
 
3132
        # inconsistent with PullResult(), which writes to stdout.
 
3133
        # -- JRV20110901, bug #838853
 
3134
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
3135
        tag_updates = getattr(self, "tag_updates", None)
 
3136
        if not is_quiet():
 
3137
            if self.old_revid != self.new_revid:
 
3138
                note(gettext('Pushed up to revision %d.') % self.new_revno)
 
3139
            if tag_updates:
 
3140
                note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
 
3141
            if self.old_revid == self.new_revid and not tag_updates:
 
3142
                if not tag_conflicts:
 
3143
                    note(gettext('No new revisions or tags to push.'))
 
3144
                else:
 
3145
                    note(gettext('No new revisions to push.'))
3156
3146
        self._show_tag_conficts(to_file)
3157
3147
 
3158
3148
 
3172
3162
        :param verbose: Requests more detailed display of what was checked,
3173
3163
            if any.
3174
3164
        """
3175
 
        note('checked branch %s format %s', self.branch.user_url,
 
3165
        note(gettext('checked branch %s format %s'), self.branch.user_url,
3176
3166
            self.branch._format)
3177
3167
        for error in self.errors:
3178
 
            note('found error:%s', error)
 
3168
            note(gettext('found error:%s'), error)
3179
3169
 
3180
3170
 
3181
3171
class Converter5to6(object):
3220
3210
 
3221
3211
 
3222
3212
class Converter7to8(object):
3223
 
    """Perform an in-place upgrade of format 6 to format 7"""
 
3213
    """Perform an in-place upgrade of format 7 to format 8"""
3224
3214
 
3225
3215
    def convert(self, branch):
3226
3216
        format = BzrBranchFormat8()
3229
3219
        branch._transport.put_bytes('format', format.get_format_string())
3230
3220
 
3231
3221
 
3232
 
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3233
 
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3234
 
    duration.
3235
 
 
3236
 
    _run_with_write_locked_target will attempt to release the lock it acquires.
3237
 
 
3238
 
    If an exception is raised by callable, then that exception *will* be
3239
 
    propagated, even if the unlock attempt raises its own error.  Thus
3240
 
    _run_with_write_locked_target should be preferred to simply doing::
3241
 
 
3242
 
        target.lock_write()
3243
 
        try:
3244
 
            return callable(*args, **kwargs)
3245
 
        finally:
3246
 
            target.unlock()
3247
 
 
3248
 
    """
3249
 
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
3250
 
    # should share code?
3251
 
    target.lock_write()
3252
 
    try:
3253
 
        result = callable(*args, **kwargs)
3254
 
    except:
3255
 
        exc_info = sys.exc_info()
3256
 
        try:
3257
 
            target.unlock()
3258
 
        finally:
3259
 
            raise exc_info[0], exc_info[1], exc_info[2]
3260
 
    else:
3261
 
        target.unlock()
3262
 
        return result
3263
 
 
3264
 
 
3265
3222
class InterBranch(InterObject):
3266
3223
    """This class represents operations taking place between two branches.
3267
3224
 
3295
3252
        raise NotImplementedError(self.pull)
3296
3253
 
3297
3254
    @needs_write_lock
3298
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3299
 
                         graph=None):
3300
 
        """Pull in new perfect-fit revisions.
3301
 
 
3302
 
        :param stop_revision: Updated until the given revision
3303
 
        :param overwrite: Always set the branch pointer, rather than checking
3304
 
            to see if it is a proper descendant.
3305
 
        :param graph: A Graph object that can be used to query history
3306
 
            information. This can be None.
3307
 
        :return: None
3308
 
        """
3309
 
        raise NotImplementedError(self.update_revisions)
3310
 
 
3311
 
    @needs_write_lock
3312
 
    def push(self, overwrite=False, stop_revision=None,
 
3255
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3313
3256
             _override_hook_source_branch=None):
3314
3257
        """Mirror the source branch into the target branch.
3315
3258
 
3326
3269
        """
3327
3270
        raise NotImplementedError(self.copy_content_into)
3328
3271
 
 
3272
    @needs_write_lock
 
3273
    def fetch(self, stop_revision=None, limit=None):
 
3274
        """Fetch revisions.
 
3275
 
 
3276
        :param stop_revision: Last revision to fetch
 
3277
        :param limit: Optional rough limit of revisions to fetch
 
3278
        """
 
3279
        raise NotImplementedError(self.fetch)
 
3280
 
3329
3281
 
3330
3282
class GenericInterBranch(InterBranch):
3331
3283
    """InterBranch implementation that uses public Branch functions."""
3337
3289
 
3338
3290
    @classmethod
3339
3291
    def _get_branch_formats_to_test(klass):
3340
 
        return [(BranchFormat._default_format, BranchFormat._default_format)]
 
3292
        return [(format_registry.get_default(), format_registry.get_default())]
3341
3293
 
3342
3294
    @classmethod
3343
3295
    def unwrap_format(klass, format):
3344
3296
        if isinstance(format, remote.RemoteBranchFormat):
3345
3297
            format._ensure_real()
3346
3298
            return format._custom_format
3347
 
        return format                                                                                                  
 
3299
        return format
3348
3300
 
3349
3301
    @needs_write_lock
3350
3302
    def copy_content_into(self, revision_id=None):
3366
3318
            self.source.tags.merge_to(self.target.tags)
3367
3319
 
3368
3320
    @needs_write_lock
3369
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3370
 
        graph=None):
3371
 
        """See InterBranch.update_revisions()."""
 
3321
    def fetch(self, stop_revision=None, limit=None):
 
3322
        if self.target.base == self.source.base:
 
3323
            return (0, [])
 
3324
        self.source.lock_read()
 
3325
        try:
 
3326
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3327
            fetch_spec_factory.source_branch = self.source
 
3328
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3329
            fetch_spec_factory.source_repo = self.source.repository
 
3330
            fetch_spec_factory.target_repo = self.target.repository
 
3331
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3332
            fetch_spec_factory.limit = limit
 
3333
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3334
            return self.target.repository.fetch(self.source.repository,
 
3335
                fetch_spec=fetch_spec)
 
3336
        finally:
 
3337
            self.source.unlock()
 
3338
 
 
3339
    @needs_write_lock
 
3340
    def _update_revisions(self, stop_revision=None, overwrite=False,
 
3341
            graph=None):
3372
3342
        other_revno, other_last_revision = self.source.last_revision_info()
3373
3343
        stop_revno = None # unknown
3374
3344
        if stop_revision is None:
3385
3355
        # case of having something to pull, and so that the check for
3386
3356
        # already merged can operate on the just fetched graph, which will
3387
3357
        # be cached in memory.
3388
 
        self.target.fetch(self.source, stop_revision)
 
3358
        self.fetch(stop_revision=stop_revision)
3389
3359
        # Check to see if one is an ancestor of the other
3390
3360
        if not overwrite:
3391
3361
            if graph is None:
3419
3389
        if local and not bound_location:
3420
3390
            raise errors.LocalRequiresBoundBranch()
3421
3391
        master_branch = None
3422
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3392
        source_is_master = False
 
3393
        if bound_location:
 
3394
            # bound_location comes from a config file, some care has to be
 
3395
            # taken to relate it to source.user_url
 
3396
            normalized = urlutils.normalize_url(bound_location)
 
3397
            try:
 
3398
                relpath = self.source.user_transport.relpath(normalized)
 
3399
                source_is_master = (relpath == '')
 
3400
            except (errors.PathNotChild, errors.InvalidURL):
 
3401
                source_is_master = False
 
3402
        if not local and bound_location and not source_is_master:
3423
3403
            # not pulling from master, so we need to update master.
3424
3404
            master_branch = self.target.get_master_branch(possible_transports)
3425
3405
            master_branch.lock_write()
3431
3411
            return self._pull(overwrite,
3432
3412
                stop_revision, _hook_master=master_branch,
3433
3413
                run_hooks=run_hooks,
3434
 
                _override_hook_target=_override_hook_target)
 
3414
                _override_hook_target=_override_hook_target,
 
3415
                merge_tags_to_master=not source_is_master)
3435
3416
        finally:
3436
3417
            if master_branch:
3437
3418
                master_branch.unlock()
3438
3419
 
3439
 
    def push(self, overwrite=False, stop_revision=None,
 
3420
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3440
3421
             _override_hook_source_branch=None):
3441
3422
        """See InterBranch.push.
3442
3423
 
3443
3424
        This is the basic concrete implementation of push()
3444
3425
 
3445
 
        :param _override_hook_source_branch: If specified, run
3446
 
        the hooks passing this Branch as the source, rather than self.
3447
 
        This is for use of RemoteBranch, where push is delegated to the
3448
 
        underlying vfs-based Branch.
 
3426
        :param _override_hook_source_branch: If specified, run the hooks
 
3427
            passing this Branch as the source, rather than self.  This is for
 
3428
            use of RemoteBranch, where push is delegated to the underlying
 
3429
            vfs-based Branch.
3449
3430
        """
 
3431
        if lossy:
 
3432
            raise errors.LossyPushToSameVCS(self.source, self.target)
3450
3433
        # TODO: Public option to disable running hooks - should be trivial but
3451
3434
        # needs tests.
3452
 
        self.source.lock_read()
3453
 
        try:
3454
 
            return _run_with_write_locked_target(
3455
 
                self.target, self._push_with_bound_branches, overwrite,
3456
 
                stop_revision,
3457
 
                _override_hook_source_branch=_override_hook_source_branch)
3458
 
        finally:
3459
 
            self.source.unlock()
3460
 
 
3461
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
 
3435
 
 
3436
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
 
3437
        op.add_cleanup(self.source.lock_read().unlock)
 
3438
        op.add_cleanup(self.target.lock_write().unlock)
 
3439
        return op.run(overwrite, stop_revision,
 
3440
            _override_hook_source_branch=_override_hook_source_branch)
 
3441
 
 
3442
    def _basic_push(self, overwrite, stop_revision):
 
3443
        """Basic implementation of push without bound branches or hooks.
 
3444
 
 
3445
        Must be called with source read locked and target write locked.
 
3446
        """
 
3447
        result = BranchPushResult()
 
3448
        result.source_branch = self.source
 
3449
        result.target_branch = self.target
 
3450
        result.old_revno, result.old_revid = self.target.last_revision_info()
 
3451
        self.source.update_references(self.target)
 
3452
        if result.old_revid != stop_revision:
 
3453
            # We assume that during 'push' this repository is closer than
 
3454
            # the target.
 
3455
            graph = self.source.repository.get_graph(self.target.repository)
 
3456
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3457
                    graph=graph)
 
3458
        if self.source._push_should_merge_tags():
 
3459
            result.tag_updates, result.tag_conflicts = (
 
3460
                self.source.tags.merge_to(self.target.tags, overwrite))
 
3461
        result.new_revno, result.new_revid = self.target.last_revision_info()
 
3462
        return result
 
3463
 
 
3464
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3462
3465
            _override_hook_source_branch=None):
3463
3466
        """Push from source into target, and into target's master if any.
3464
3467
        """
3476
3479
            # be bound to itself? -- mbp 20070507
3477
3480
            master_branch = self.target.get_master_branch()
3478
3481
            master_branch.lock_write()
3479
 
            try:
3480
 
                # push into the master from the source branch.
3481
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3482
 
                # and push into the target branch from the source. Note that we
3483
 
                # push from the source branch again, because it's considered the
3484
 
                # highest bandwidth repository.
3485
 
                result = self.source._basic_push(self.target, overwrite,
3486
 
                    stop_revision)
3487
 
                result.master_branch = master_branch
3488
 
                result.local_branch = self.target
3489
 
                _run_hooks()
3490
 
                return result
3491
 
            finally:
3492
 
                master_branch.unlock()
 
3482
            operation.add_cleanup(master_branch.unlock)
 
3483
            # push into the master from the source branch.
 
3484
            master_inter = InterBranch.get(self.source, master_branch)
 
3485
            master_inter._basic_push(overwrite, stop_revision)
 
3486
            # and push into the target branch from the source. Note that
 
3487
            # we push from the source branch again, because it's considered
 
3488
            # the highest bandwidth repository.
 
3489
            result = self._basic_push(overwrite, stop_revision)
 
3490
            result.master_branch = master_branch
 
3491
            result.local_branch = self.target
3493
3492
        else:
 
3493
            master_branch = None
3494
3494
            # no master branch
3495
 
            result = self.source._basic_push(self.target, overwrite,
3496
 
                stop_revision)
 
3495
            result = self._basic_push(overwrite, stop_revision)
3497
3496
            # TODO: Why set master_branch and local_branch if there's no
3498
3497
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3499
3498
            # 20070504
3500
3499
            result.master_branch = self.target
3501
3500
            result.local_branch = None
3502
 
            _run_hooks()
3503
 
            return result
 
3501
        _run_hooks()
 
3502
        return result
3504
3503
 
3505
3504
    def _pull(self, overwrite=False, stop_revision=None,
3506
3505
             possible_transports=None, _hook_master=None, run_hooks=True,
3507
 
             _override_hook_target=None, local=False):
 
3506
             _override_hook_target=None, local=False,
 
3507
             merge_tags_to_master=True):
3508
3508
        """See Branch.pull.
3509
3509
 
3510
3510
        This function is the core worker, used by GenericInterBranch.pull to
3515
3515
        :param run_hooks: Private parameter - if false, this branch
3516
3516
            is being called because it's the master of the primary branch,
3517
3517
            so it should not run its hooks.
 
3518
            is being called because it's the master of the primary branch,
 
3519
            so it should not run its hooks.
3518
3520
        :param _override_hook_target: Private parameter - set the branch to be
3519
3521
            supplied as the target_branch to pull hooks.
3520
3522
        :param local: Only update the local branch, and not the bound branch.
3539
3541
            # -- JRV20090506
3540
3542
            result.old_revno, result.old_revid = \
3541
3543
                self.target.last_revision_info()
3542
 
            self.target.update_revisions(self.source, stop_revision,
3543
 
                overwrite=overwrite, graph=graph)
 
3544
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3545
                graph=graph)
3544
3546
            # TODO: The old revid should be specified when merging tags, 
3545
3547
            # so a tags implementation that versions tags can only 
3546
3548
            # pull in the most recent changes. -- JRV20090506
3547
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3548
 
                overwrite)
 
3549
            result.tag_updates, result.tag_conflicts = (
 
3550
                self.source.tags.merge_to(self.target.tags, overwrite,
 
3551
                    ignore_master=not merge_tags_to_master))
3549
3552
            result.new_revno, result.new_revid = self.target.last_revision_info()
3550
3553
            if _hook_master:
3551
3554
                result.master_branch = _hook_master