~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-01-13 02:43:21 UTC
  • mfrom: (5582.9.2 funky-chars)
  • Revision ID: pqm@pqm.ubuntu.com-20110113024321-d1ssmy4knbv806zp
(jelmer) Avoid hardcoded list of repository formats that do not support
 funky characters in filenames. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
16
16
 
17
17
 
18
18
from cStringIO import StringIO
 
19
import sys
19
20
 
20
21
from bzrlib.lazy_import import lazy_import
21
22
lazy_import(globals(), """
22
 
import itertools
 
23
from itertools import chain
23
24
from bzrlib import (
24
25
        bzrdir,
25
26
        cache_utf8,
26
 
        cleanup,
27
27
        config as _mod_config,
 
28
        controldir,
28
29
        debug,
29
30
        errors,
30
 
        fetch,
31
 
        graph as _mod_graph,
32
31
        lockdir,
33
32
        lockable_files,
34
33
        remote,
35
34
        repository,
36
35
        revision as _mod_revision,
37
36
        rio,
38
 
        tag as _mod_tag,
 
37
        symbol_versioning,
39
38
        transport,
 
39
        tsort,
40
40
        ui,
41
41
        urlutils,
42
42
        )
43
 
from bzrlib.i18n import gettext, ngettext
 
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
    )
44
49
""")
45
50
 
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
 
51
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
52
from bzrlib.hooks import HookPoint, Hooks
55
53
from bzrlib.inter import InterObject
56
54
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
57
55
from bzrlib import registry
62
60
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
63
61
 
64
62
 
 
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
 
65
68
class Branch(controldir.ControlComponent):
66
69
    """Branch holding a history of revisions.
67
70
 
68
71
    :ivar base:
69
72
        Base directory/url of the branch; using control_url and
70
73
        control_transport is more standardized.
71
 
    :ivar hooks: An instance of BranchHooks.
72
 
    :ivar _master_branch_cache: cached result of get_master_branch, see
73
 
        _clear_cached_state.
 
74
 
 
75
    hooks: An instance of BranchHooks.
74
76
    """
75
77
    # this is really an instance variable - FIXME move it there
76
78
    # - RBC 20060112
92
94
        self._partial_revision_history_cache = []
93
95
        self._tags_bytes = None
94
96
        self._last_revision_info_cache = None
95
 
        self._master_branch_cache = None
96
97
        self._merge_sorted_revisions_cache = None
97
98
        self._open_hook()
98
99
        hooks = Branch.hooks['open']
213
214
 
214
215
        :return: A bzrlib.config.BranchConfig.
215
216
        """
216
 
        return _mod_config.BranchConfig(self)
217
 
 
218
 
    def get_config_stack(self):
219
 
        """Get a bzrlib.config.BranchStack for this Branch.
220
 
 
221
 
        This can then be used to get and set configuration options for the
222
 
        branch.
223
 
 
224
 
        :return: A bzrlib.config.BranchStack.
225
 
        """
226
 
        return _mod_config.BranchStack(self)
 
217
        return BranchConfig(self)
227
218
 
228
219
    def _get_config(self):
229
220
        """Get the concrete config for just the config in this branch.
456
447
            after. If None, the rest of history is included.
457
448
        :param stop_rule: if stop_revision_id is not None, the precise rule
458
449
            to use for termination:
459
 
 
460
450
            * 'exclude' - leave the stop revision out of the result (default)
461
451
            * 'include' - the stop revision is the last item in the result
462
452
            * 'with-merges' - include the stop revision and all of its
464
454
            * 'with-merges-without-common-ancestry' - filter out revisions 
465
455
              that are in both ancestries
466
456
        :param direction: either 'reverse' or 'forward':
467
 
 
468
457
            * reverse means return the start_revision_id first, i.e.
469
458
              start at the most recent revision and go backwards in history
470
459
            * forward returns tuples in the opposite order to reverse.
514
503
        rev_iter = iter(merge_sorted_revisions)
515
504
        if start_revision_id is not None:
516
505
            for node in rev_iter:
517
 
                rev_id = node.key
 
506
                rev_id = node.key[-1]
518
507
                if rev_id != start_revision_id:
519
508
                    continue
520
509
                else:
521
510
                    # The decision to include the start or not
522
511
                    # depends on the stop_rule if a stop is provided
523
512
                    # so pop this node back into the iterator
524
 
                    rev_iter = itertools.chain(iter([node]), rev_iter)
 
513
                    rev_iter = chain(iter([node]), rev_iter)
525
514
                    break
526
515
        if stop_revision_id is None:
527
516
            # Yield everything
528
517
            for node in rev_iter:
529
 
                rev_id = node.key
 
518
                rev_id = node.key[-1]
530
519
                yield (rev_id, node.merge_depth, node.revno,
531
520
                       node.end_of_merge)
532
521
        elif stop_rule == 'exclude':
533
522
            for node in rev_iter:
534
 
                rev_id = node.key
 
523
                rev_id = node.key[-1]
535
524
                if rev_id == stop_revision_id:
536
525
                    return
537
526
                yield (rev_id, node.merge_depth, node.revno,
538
527
                       node.end_of_merge)
539
528
        elif stop_rule == 'include':
540
529
            for node in rev_iter:
541
 
                rev_id = node.key
 
530
                rev_id = node.key[-1]
542
531
                yield (rev_id, node.merge_depth, node.revno,
543
532
                       node.end_of_merge)
544
533
                if rev_id == stop_revision_id:
550
539
            ancestors = graph.find_unique_ancestors(start_revision_id,
551
540
                                                    [stop_revision_id])
552
541
            for node in rev_iter:
553
 
                rev_id = node.key
 
542
                rev_id = node.key[-1]
554
543
                if rev_id not in ancestors:
555
544
                    continue
556
545
                yield (rev_id, node.merge_depth, node.revno,
566
555
            reached_stop_revision_id = False
567
556
            revision_id_whitelist = []
568
557
            for node in rev_iter:
569
 
                rev_id = node.key
 
558
                rev_id = node.key[-1]
570
559
                if rev_id == left_parent:
571
560
                    # reached the left parent after the stop_revision
572
561
                    return
652
641
        """
653
642
        raise errors.UpgradeRequired(self.user_url)
654
643
 
655
 
    def get_append_revisions_only(self):
656
 
        """Whether it is only possible to append revisions to the history.
657
 
        """
658
 
        if not self._format.supports_set_append_revisions_only():
659
 
            return False
660
 
        return self.get_config(
661
 
            ).get_user_option_as_bool('append_revisions_only')
662
 
 
663
644
    def set_append_revisions_only(self, enabled):
664
645
        if not self._format.supports_set_append_revisions_only():
665
646
            raise errors.UpgradeRequired(self.user_url)
679
660
        raise errors.UnsupportedOperation(self.get_reference_info, self)
680
661
 
681
662
    @needs_write_lock
682
 
    def fetch(self, from_branch, last_revision=None, limit=None):
 
663
    def fetch(self, from_branch, last_revision=None, pb=None):
683
664
        """Copy revisions from from_branch into this branch.
684
665
 
685
666
        :param from_branch: Where to copy from.
686
667
        :param last_revision: What revision to stop at (None for at the end
687
668
                              of the branch.
688
 
        :param limit: Optional rough limit of revisions to fetch
 
669
        :param pb: An optional progress bar to use.
689
670
        :return: None
690
671
        """
691
 
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
 
672
        if self.base == from_branch.base:
 
673
            return (0, [])
 
674
        if pb is not None:
 
675
            symbol_versioning.warn(
 
676
                symbol_versioning.deprecated_in((1, 14, 0))
 
677
                % "pb parameter to fetch()")
 
678
        from_branch.lock_read()
 
679
        try:
 
680
            if last_revision is None:
 
681
                last_revision = from_branch.last_revision()
 
682
                last_revision = _mod_revision.ensure_null(last_revision)
 
683
            return self.repository.fetch(from_branch.repository,
 
684
                                         revision_id=last_revision,
 
685
                                         pb=pb)
 
686
        finally:
 
687
            from_branch.unlock()
692
688
 
693
689
    def get_bound_location(self):
694
690
        """Return the URL of the branch we are bound to.
705
701
 
706
702
    def get_commit_builder(self, parents, config=None, timestamp=None,
707
703
                           timezone=None, committer=None, revprops=None,
708
 
                           revision_id=None, lossy=False):
 
704
                           revision_id=None):
709
705
        """Obtain a CommitBuilder for this branch.
710
706
 
711
707
        :param parents: Revision ids of the parents of the new revision.
715
711
        :param committer: Optional committer to set for commit.
716
712
        :param revprops: Optional dictionary of revision properties.
717
713
        :param revision_id: Optional revision id.
718
 
        :param lossy: Whether to discard data that can not be natively
719
 
            represented, when pushing to a foreign VCS 
720
714
        """
721
715
 
722
716
        if config is None:
723
717
            config = self.get_config()
724
718
 
725
719
        return self.repository.get_commit_builder(self, parents, config,
726
 
            timestamp, timezone, committer, revprops, revision_id,
727
 
            lossy)
 
720
            timestamp, timezone, committer, revprops, revision_id)
728
721
 
729
722
    def get_master_branch(self, possible_transports=None):
730
723
        """Return the branch we are bound to.
757
750
        """Print `file` to stdout."""
758
751
        raise NotImplementedError(self.print_file)
759
752
 
760
 
    @deprecated_method(deprecated_in((2, 4, 0)))
761
753
    def set_revision_history(self, rev_history):
762
 
        """See Branch.set_revision_history."""
763
 
        self._set_revision_history(rev_history)
764
 
 
765
 
    @needs_write_lock
766
 
    def _set_revision_history(self, rev_history):
767
 
        if len(rev_history) == 0:
768
 
            revid = _mod_revision.NULL_REVISION
769
 
        else:
770
 
            revid = rev_history[-1]
771
 
        if rev_history != self._lefthand_history(revid):
772
 
            raise errors.NotLefthandHistory(rev_history)
773
 
        self.set_last_revision_info(len(rev_history), revid)
774
 
        self._cache_revision_history(rev_history)
775
 
        for hook in Branch.hooks['set_rh']:
776
 
            hook(self, rev_history)
777
 
 
778
 
    @needs_write_lock
779
 
    def set_last_revision_info(self, revno, revision_id):
780
 
        """Set the last revision of this branch.
781
 
 
782
 
        The caller is responsible for checking that the revno is correct
783
 
        for this revision id.
784
 
 
785
 
        It may be possible to set the branch last revision to an id not
786
 
        present in the repository.  However, branches can also be
787
 
        configured to check constraints on history, in which case this may not
788
 
        be permitted.
789
 
        """
790
 
        raise NotImplementedError(self.set_last_revision_info)
791
 
 
792
 
    @needs_write_lock
793
 
    def generate_revision_history(self, revision_id, last_rev=None,
794
 
                                  other_branch=None):
795
 
        """See Branch.generate_revision_history"""
796
 
        graph = self.repository.get_graph()
797
 
        (last_revno, last_revid) = self.last_revision_info()
798
 
        known_revision_ids = [
799
 
            (last_revid, last_revno),
800
 
            (_mod_revision.NULL_REVISION, 0),
801
 
            ]
802
 
        if last_rev is not None:
803
 
            if not graph.is_ancestor(last_rev, revision_id):
804
 
                # our previous tip is not merged into stop_revision
805
 
                raise errors.DivergedBranches(self, other_branch)
806
 
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
807
 
        self.set_last_revision_info(revno, revision_id)
 
754
        raise NotImplementedError(self.set_revision_history)
808
755
 
809
756
    @needs_write_lock
810
757
    def set_parent(self, url):
854
801
 
855
802
    def _unstack(self):
856
803
        """Change a branch to be unstacked, copying data as needed.
857
 
 
 
804
        
858
805
        Don't call this directly, use set_stacked_on_url(None).
859
806
        """
860
807
        pb = ui.ui_factory.nested_progress_bar()
861
808
        try:
862
 
            pb.update(gettext("Unstacking"))
 
809
            pb.update("Unstacking")
863
810
            # The basic approach here is to fetch the tip of the branch,
864
811
            # including all available ghosts, from the existing stacked
865
812
            # repository into a new repository object without the fallbacks. 
924
871
                # XXX: If you unstack a branch while it has a working tree
925
872
                # with a pending merge, the pending-merged revisions will no
926
873
                # longer be present.  You can (probably) revert and remerge.
927
 
                try:
928
 
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
929
 
                except errors.TagsNotSupported:
930
 
                    tags_to_fetch = set()
931
 
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
932
 
                    old_repository, required_ids=[self.last_revision()],
933
 
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
934
 
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
 
874
                #
 
875
                # XXX: This only fetches up to the tip of the repository; it
 
876
                # doesn't bring across any tags.  That's fairly consistent
 
877
                # with how branch works, but perhaps not ideal.
 
878
                self.repository.fetch(old_repository,
 
879
                    revision_id=self.last_revision(),
 
880
                    find_ghosts=True)
935
881
            finally:
936
882
                old_repository.unlock()
937
883
        finally:
942
888
 
943
889
        :seealso: Branch._get_tags_bytes.
944
890
        """
945
 
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
946
 
        op.add_cleanup(self.lock_write().unlock)
947
 
        return op.run_simple(bytes)
 
891
        return _run_with_write_locked_target(self, self._set_tags_bytes_locked,
 
892
                bytes)
948
893
 
949
894
    def _set_tags_bytes_locked(self, bytes):
950
895
        self._tags_bytes = bytes
981
926
        self._revision_history_cache = None
982
927
        self._revision_id_to_revno_cache = None
983
928
        self._last_revision_info_cache = None
984
 
        self._master_branch_cache = None
985
929
        self._merge_sorted_revisions_cache = None
986
930
        self._partial_revision_history_cache = []
987
931
        self._partial_revision_id_to_revno_cache = {}
1041
985
        :return: A tuple (revno, revision_id).
1042
986
        """
1043
987
        if self._last_revision_info_cache is None:
1044
 
            self._last_revision_info_cache = self._read_last_revision_info()
 
988
            self._last_revision_info_cache = self._last_revision_info()
1045
989
        return self._last_revision_info_cache
1046
990
 
1047
 
    def _read_last_revision_info(self):
1048
 
        raise NotImplementedError(self._read_last_revision_info)
1049
 
 
1050
 
    @deprecated_method(deprecated_in((2, 4, 0)))
 
991
    def _last_revision_info(self):
 
992
        rh = self.revision_history()
 
993
        revno = len(rh)
 
994
        if revno:
 
995
            return (revno, rh[-1])
 
996
        else:
 
997
            return (0, _mod_revision.NULL_REVISION)
 
998
 
 
999
    @deprecated_method(deprecated_in((1, 6, 0)))
 
1000
    def missing_revisions(self, other, stop_revision=None):
 
1001
        """Return a list of new revisions that would perfectly fit.
 
1002
 
 
1003
        If self and other have not diverged, return a list of the revisions
 
1004
        present in other, but missing from self.
 
1005
        """
 
1006
        self_history = self.revision_history()
 
1007
        self_len = len(self_history)
 
1008
        other_history = other.revision_history()
 
1009
        other_len = len(other_history)
 
1010
        common_index = min(self_len, other_len) -1
 
1011
        if common_index >= 0 and \
 
1012
            self_history[common_index] != other_history[common_index]:
 
1013
            raise errors.DivergedBranches(self, other)
 
1014
 
 
1015
        if stop_revision is None:
 
1016
            stop_revision = other_len
 
1017
        else:
 
1018
            if stop_revision > other_len:
 
1019
                raise errors.NoSuchRevision(self, stop_revision)
 
1020
        return other_history[self_len:stop_revision]
 
1021
 
 
1022
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
1023
                         graph=None):
 
1024
        """Pull in new perfect-fit revisions.
 
1025
 
 
1026
        :param other: Another Branch to pull from
 
1027
        :param stop_revision: Updated until the given revision
 
1028
        :param overwrite: Always set the branch pointer, rather than checking
 
1029
            to see if it is a proper descendant.
 
1030
        :param graph: A Graph object that can be used to query history
 
1031
            information. This can be None.
 
1032
        :return: None
 
1033
        """
 
1034
        return InterBranch.get(other, self).update_revisions(stop_revision,
 
1035
            overwrite, graph)
 
1036
 
1051
1037
    def import_last_revision_info(self, source_repo, revno, revid):
1052
1038
        """Set the last revision info, importing from another repo if necessary.
1053
1039
 
 
1040
        This is used by the bound branch code to upload a revision to
 
1041
        the master branch first before updating the tip of the local branch.
 
1042
 
1054
1043
        :param source_repo: Source repository to optionally fetch from
1055
1044
        :param revno: Revision number of the new tip
1056
1045
        :param revid: Revision id of the new tip
1059
1048
            self.repository.fetch(source_repo, revision_id=revid)
1060
1049
        self.set_last_revision_info(revno, revid)
1061
1050
 
1062
 
    def import_last_revision_info_and_tags(self, source, revno, revid,
1063
 
                                           lossy=False):
1064
 
        """Set the last revision info, importing from another repo if necessary.
1065
 
 
1066
 
        This is used by the bound branch code to upload a revision to
1067
 
        the master branch first before updating the tip of the local branch.
1068
 
        Revisions referenced by source's tags are also transferred.
1069
 
 
1070
 
        :param source: Source branch to optionally fetch from
1071
 
        :param revno: Revision number of the new tip
1072
 
        :param revid: Revision id of the new tip
1073
 
        :param lossy: Whether to discard metadata that can not be
1074
 
            natively represented
1075
 
        :return: Tuple with the new revision number and revision id
1076
 
            (should only be different from the arguments when lossy=True)
1077
 
        """
1078
 
        if not self.repository.has_same_location(source.repository):
1079
 
            self.fetch(source, revid)
1080
 
        self.set_last_revision_info(revno, revid)
1081
 
        return (revno, revid)
1082
 
 
1083
1051
    def revision_id_to_revno(self, revision_id):
1084
1052
        """Given a revision id, return its revno"""
1085
1053
        if _mod_revision.is_null(revision_id):
1117
1085
            stop_revision=stop_revision,
1118
1086
            possible_transports=possible_transports, *args, **kwargs)
1119
1087
 
1120
 
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1121
 
            *args, **kwargs):
 
1088
    def push(self, target, overwrite=False, stop_revision=None, *args,
 
1089
        **kwargs):
1122
1090
        """Mirror this branch into target.
1123
1091
 
1124
1092
        This branch is considered to be 'local', having low latency.
1125
1093
        """
1126
1094
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1127
 
            lossy, *args, **kwargs)
 
1095
            *args, **kwargs)
 
1096
 
 
1097
    def lossy_push(self, target, stop_revision=None):
 
1098
        """Push deltas into another branch.
 
1099
 
 
1100
        :note: This does not, like push, retain the revision ids from 
 
1101
            the source branch and will, rather than adding bzr-specific 
 
1102
            metadata, push only those semantics of the revision that can be 
 
1103
            natively represented by this branch' VCS.
 
1104
 
 
1105
        :param target: Target branch
 
1106
        :param stop_revision: Revision to push, defaults to last revision.
 
1107
        :return: BranchPushResult with an extra member revidmap: 
 
1108
            A dictionary mapping revision ids from the target branch 
 
1109
            to new revision ids in the target branch, for each 
 
1110
            revision that was pushed.
 
1111
        """
 
1112
        inter = InterBranch.get(self, target)
 
1113
        lossy_push = getattr(inter, "lossy_push", None)
 
1114
        if lossy_push is None:
 
1115
            raise errors.LossyPushToSameVCS(self, target)
 
1116
        return lossy_push(stop_revision)
1128
1117
 
1129
1118
    def basis_tree(self):
1130
1119
        """Return `Tree` object for last revision."""
1303
1292
            if repository_policy is not None:
1304
1293
                repository_policy.configure_branch(result)
1305
1294
            self.copy_content_into(result, revision_id=revision_id)
1306
 
            master_url = self.get_bound_location()
1307
 
            if master_url is None:
1308
 
                result.set_parent(self.bzrdir.root_transport.base)
1309
 
            else:
1310
 
                result.set_parent(master_url)
 
1295
            result.set_parent(self.bzrdir.root_transport.base)
1311
1296
        finally:
1312
1297
            result.unlock()
1313
1298
        return result
1391
1376
        # specific check.
1392
1377
        return result
1393
1378
 
1394
 
    def _get_checkout_format(self, lightweight=False):
 
1379
    def _get_checkout_format(self):
1395
1380
        """Return the most suitable metadir for a checkout of this branch.
1396
1381
        Weaves are used if this branch's repository uses weaves.
1397
1382
        """
1432
1417
        :param to_location: The url to produce the checkout at
1433
1418
        :param revision_id: The revision to check out
1434
1419
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1435
 
            produce a bound branch (heavyweight checkout)
 
1420
        produce a bound branch (heavyweight checkout)
1436
1421
        :param accelerator_tree: A tree which can be used for retrieving file
1437
1422
            contents more quickly than the revision tree, i.e. a workingtree.
1438
1423
            The revision tree will be used for cases where accelerator_tree's
1443
1428
        """
1444
1429
        t = transport.get_transport(to_location)
1445
1430
        t.ensure_base()
1446
 
        format = self._get_checkout_format(lightweight=lightweight)
1447
1431
        if lightweight:
 
1432
            format = self._get_checkout_format()
1448
1433
            checkout = format.initialize_on_transport(t)
1449
1434
            from_branch = BranchReferenceFormat().initialize(checkout, 
1450
1435
                target_branch=self)
1451
1436
        else:
 
1437
            format = self._get_checkout_format()
1452
1438
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1453
1439
                to_location, force_new_tree=False, format=format)
1454
1440
            checkout = checkout_branch.bzrdir
1483
1469
 
1484
1470
    def reference_parent(self, file_id, path, possible_transports=None):
1485
1471
        """Return the parent branch for a tree-reference file_id
1486
 
 
1487
1472
        :param file_id: The file_id of the tree reference
1488
1473
        :param path: The path of the file_id in the tree
1489
1474
        :return: A branch associated with the file_id
1542
1527
        else:
1543
1528
            raise AssertionError("invalid heads: %r" % (heads,))
1544
1529
 
1545
 
    def heads_to_fetch(self):
1546
 
        """Return the heads that must and that should be fetched to copy this
1547
 
        branch into another repo.
1548
 
 
1549
 
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
1550
 
            set of heads that must be fetched.  if_present_fetch is a set of
1551
 
            heads that must be fetched if present, but no error is necessary if
1552
 
            they are not present.
1553
 
        """
1554
 
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
1555
 
        # are the tags.
1556
 
        must_fetch = set([self.last_revision()])
1557
 
        if_present_fetch = set()
1558
 
        c = self.get_config()
1559
 
        include_tags = c.get_user_option_as_bool('branch.fetch_tags',
1560
 
                                                 default=False)
1561
 
        if include_tags:
1562
 
            try:
1563
 
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
1564
 
            except errors.TagsNotSupported:
1565
 
                pass
1566
 
        must_fetch.discard(_mod_revision.NULL_REVISION)
1567
 
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
1568
 
        return must_fetch, if_present_fetch
1569
 
 
1570
 
 
1571
 
class BranchFormat(controldir.ControlComponentFormat):
 
1530
 
 
1531
class BranchFormat(object):
1572
1532
    """An encapsulation of the initialization and open routines for a format.
1573
1533
 
1574
1534
    Formats provide three things:
1586
1546
    object will be created every time regardless.
1587
1547
    """
1588
1548
 
 
1549
    _default_format = None
 
1550
    """The default format used for new branches."""
 
1551
 
 
1552
    _formats = {}
 
1553
    """The known formats."""
 
1554
 
 
1555
    can_set_append_revisions_only = True
 
1556
 
1589
1557
    def __eq__(self, other):
1590
1558
        return self.__class__ is other.__class__
1591
1559
 
1598
1566
        try:
1599
1567
            transport = a_bzrdir.get_branch_transport(None, name=name)
1600
1568
            format_string = transport.get_bytes("format")
1601
 
            return format_registry.get(format_string)
 
1569
            format = klass._formats[format_string]
 
1570
            if isinstance(format, MetaDirBranchFormatFactory):
 
1571
                return format()
 
1572
            return format
1602
1573
        except errors.NoSuchFile:
1603
1574
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1604
1575
        except KeyError:
1605
1576
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1606
1577
 
1607
1578
    @classmethod
1608
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1609
1579
    def get_default_format(klass):
1610
1580
        """Return the current default format."""
1611
 
        return format_registry.get_default()
 
1581
        return klass._default_format
1612
1582
 
1613
1583
    @classmethod
1614
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1615
1584
    def get_formats(klass):
1616
1585
        """Get all the known formats.
1617
1586
 
1618
1587
        Warning: This triggers a load of all lazy registered formats: do not
1619
1588
        use except when that is desireed.
1620
1589
        """
1621
 
        return format_registry._get_all()
 
1590
        result = []
 
1591
        for fmt in klass._formats.values():
 
1592
            if isinstance(fmt, MetaDirBranchFormatFactory):
 
1593
                fmt = fmt()
 
1594
            result.append(fmt)
 
1595
        return result
1622
1596
 
1623
1597
    def get_reference(self, a_bzrdir, name=None):
1624
1598
        """Get the target reference of the branch in a_bzrdir.
1663
1637
        for hook in hooks:
1664
1638
            hook(params)
1665
1639
 
1666
 
    def initialize(self, a_bzrdir, name=None, repository=None,
1667
 
                   append_revisions_only=None):
 
1640
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
1641
                           repository=None, lock_type='metadir',
 
1642
                           set_format=True):
 
1643
        """Initialize a branch in a bzrdir, with specified files
 
1644
 
 
1645
        :param a_bzrdir: The bzrdir to initialize the branch in
 
1646
        :param utf8_files: The files to create as a list of
 
1647
            (filename, content) tuples
 
1648
        :param name: Name of colocated branch to create, if any
 
1649
        :param set_format: If True, set the format with
 
1650
            self.get_format_string.  (BzrBranch4 has its format set
 
1651
            elsewhere)
 
1652
        :return: a branch in this format
 
1653
        """
 
1654
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1655
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1656
        lock_map = {
 
1657
            'metadir': ('lock', lockdir.LockDir),
 
1658
            'branch4': ('branch-lock', lockable_files.TransportLock),
 
1659
        }
 
1660
        lock_name, lock_class = lock_map[lock_type]
 
1661
        control_files = lockable_files.LockableFiles(branch_transport,
 
1662
            lock_name, lock_class)
 
1663
        control_files.create_lock()
 
1664
        try:
 
1665
            control_files.lock_write()
 
1666
        except errors.LockContention:
 
1667
            if lock_type != 'branch4':
 
1668
                raise
 
1669
            lock_taken = False
 
1670
        else:
 
1671
            lock_taken = True
 
1672
        if set_format:
 
1673
            utf8_files += [('format', self.get_format_string())]
 
1674
        try:
 
1675
            for (filename, content) in utf8_files:
 
1676
                branch_transport.put_bytes(
 
1677
                    filename, content,
 
1678
                    mode=a_bzrdir._get_file_mode())
 
1679
        finally:
 
1680
            if lock_taken:
 
1681
                control_files.unlock()
 
1682
        branch = self.open(a_bzrdir, name, _found=True,
 
1683
                found_repository=repository)
 
1684
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
1685
        return branch
 
1686
 
 
1687
    def initialize(self, a_bzrdir, name=None, repository=None):
1668
1688
        """Create a branch of this format in a_bzrdir.
1669
1689
        
1670
1690
        :param name: Name of the colocated branch to create.
1692
1712
        Note that it is normal for branch to be a RemoteBranch when using tags
1693
1713
        on a RemoteBranch.
1694
1714
        """
1695
 
        return _mod_tag.DisabledTags(branch)
 
1715
        return DisabledTags(branch)
1696
1716
 
1697
1717
    def network_name(self):
1698
1718
        """A simple byte string uniquely identifying this format for RPC calls.
1718
1738
        raise NotImplementedError(self.open)
1719
1739
 
1720
1740
    @classmethod
1721
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1722
1741
    def register_format(klass, format):
1723
1742
        """Register a metadir format.
1724
 
 
 
1743
        
1725
1744
        See MetaDirBranchFormatFactory for the ability to register a format
1726
1745
        without loading the code the format needs until it is actually used.
1727
1746
        """
1728
 
        format_registry.register(format)
 
1747
        klass._formats[format.get_format_string()] = format
 
1748
        # Metadir formats have a network name of their format string, and get
 
1749
        # registered as factories.
 
1750
        if isinstance(format, MetaDirBranchFormatFactory):
 
1751
            network_format_registry.register(format.get_format_string(), format)
 
1752
        else:
 
1753
            network_format_registry.register(format.get_format_string(),
 
1754
                format.__class__)
1729
1755
 
1730
1756
    @classmethod
1731
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1732
1757
    def set_default_format(klass, format):
1733
 
        format_registry.set_default(format)
 
1758
        klass._default_format = format
1734
1759
 
1735
1760
    def supports_set_append_revisions_only(self):
1736
1761
        """True if this format supports set_append_revisions_only."""
1740
1765
        """True if this format records a stacked-on branch."""
1741
1766
        return False
1742
1767
 
1743
 
    def supports_leaving_lock(self):
1744
 
        """True if this format supports leaving locks in place."""
1745
 
        return False # by default
1746
 
 
1747
1768
    @classmethod
1748
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1749
1769
    def unregister_format(klass, format):
1750
 
        format_registry.remove(format)
 
1770
        del klass._formats[format.get_format_string()]
1751
1771
 
1752
1772
    def __str__(self):
1753
1773
        return self.get_format_description().rstrip()
1756
1776
        """True if this format supports tags stored in the branch"""
1757
1777
        return False  # by default
1758
1778
 
1759
 
    def tags_are_versioned(self):
1760
 
        """Whether the tag container for this branch versions tags."""
1761
 
        return False
1762
 
 
1763
 
    def supports_tags_referencing_ghosts(self):
1764
 
        """True if tags can reference ghost revisions."""
1765
 
        return True
1766
 
 
1767
1779
 
1768
1780
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1769
1781
    """A factory for a BranchFormat object, permitting simple lazy registration.
1806
1818
        These are all empty initially, because by default nothing should get
1807
1819
        notified.
1808
1820
        """
1809
 
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1810
 
        self.add_hook('set_rh',
 
1821
        Hooks.__init__(self)
 
1822
        self.create_hook(HookPoint('set_rh',
1811
1823
            "Invoked whenever the revision history has been set via "
1812
1824
            "set_revision_history. The api signature is (branch, "
1813
1825
            "revision_history), and the branch will be write-locked. "
1814
1826
            "The set_rh hook can be expensive for bzr to trigger, a better "
1815
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
1816
 
        self.add_hook('open',
 
1827
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
 
1828
        self.create_hook(HookPoint('open',
1817
1829
            "Called with the Branch object that has been opened after a "
1818
 
            "branch is opened.", (1, 8))
1819
 
        self.add_hook('post_push',
 
1830
            "branch is opened.", (1, 8), None))
 
1831
        self.create_hook(HookPoint('post_push',
1820
1832
            "Called after a push operation completes. post_push is called "
1821
1833
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1822
 
            "bzr client.", (0, 15))
1823
 
        self.add_hook('post_pull',
 
1834
            "bzr client.", (0, 15), None))
 
1835
        self.create_hook(HookPoint('post_pull',
1824
1836
            "Called after a pull operation completes. post_pull is called "
1825
1837
            "with a bzrlib.branch.PullResult object and only runs in the "
1826
 
            "bzr client.", (0, 15))
1827
 
        self.add_hook('pre_commit',
 
1838
            "bzr client.", (0, 15), None))
 
1839
        self.create_hook(HookPoint('pre_commit',
1828
1840
            "Called after a commit is calculated but before it is "
1829
1841
            "completed. pre_commit is called with (local, master, old_revno, "
1830
1842
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1833
1845
            "basis revision. hooks MUST NOT modify this delta. "
1834
1846
            " future_tree is an in-memory tree obtained from "
1835
1847
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1836
 
            "tree.", (0,91))
1837
 
        self.add_hook('post_commit',
 
1848
            "tree.", (0,91), None))
 
1849
        self.create_hook(HookPoint('post_commit',
1838
1850
            "Called in the bzr client after a commit has completed. "
1839
1851
            "post_commit is called with (local, master, old_revno, old_revid, "
1840
1852
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1841
 
            "commit to a branch.", (0, 15))
1842
 
        self.add_hook('post_uncommit',
 
1853
            "commit to a branch.", (0, 15), None))
 
1854
        self.create_hook(HookPoint('post_uncommit',
1843
1855
            "Called in the bzr client after an uncommit completes. "
1844
1856
            "post_uncommit is called with (local, master, old_revno, "
1845
1857
            "old_revid, new_revno, new_revid) where local is the local branch "
1846
1858
            "or None, master is the target branch, and an empty branch "
1847
 
            "receives new_revno of 0, new_revid of None.", (0, 15))
1848
 
        self.add_hook('pre_change_branch_tip',
 
1859
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1860
        self.create_hook(HookPoint('pre_change_branch_tip',
1849
1861
            "Called in bzr client and server before a change to the tip of a "
1850
1862
            "branch is made. pre_change_branch_tip is called with a "
1851
1863
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1852
 
            "commit, uncommit will all trigger this hook.", (1, 6))
1853
 
        self.add_hook('post_change_branch_tip',
 
1864
            "commit, uncommit will all trigger this hook.", (1, 6), None))
 
1865
        self.create_hook(HookPoint('post_change_branch_tip',
1854
1866
            "Called in bzr client and server after a change to the tip of a "
1855
1867
            "branch is made. post_change_branch_tip is called with a "
1856
1868
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1857
 
            "commit, uncommit will all trigger this hook.", (1, 4))
1858
 
        self.add_hook('transform_fallback_location',
 
1869
            "commit, uncommit will all trigger this hook.", (1, 4), None))
 
1870
        self.create_hook(HookPoint('transform_fallback_location',
1859
1871
            "Called when a stacked branch is activating its fallback "
1860
1872
            "locations. transform_fallback_location is called with (branch, "
1861
1873
            "url), and should return a new url. Returning the same url "
1866
1878
            "fallback locations have not been activated. When there are "
1867
1879
            "multiple hooks installed for transform_fallback_location, "
1868
1880
            "all are called with the url returned from the previous hook."
1869
 
            "The order is however undefined.", (1, 9))
1870
 
        self.add_hook('automatic_tag_name',
 
1881
            "The order is however undefined.", (1, 9), None))
 
1882
        self.create_hook(HookPoint('automatic_tag_name',
1871
1883
            "Called to determine an automatic tag name for a revision. "
1872
1884
            "automatic_tag_name is called with (branch, revision_id) and "
1873
1885
            "should return a tag name or None if no tag name could be "
1874
1886
            "determined. The first non-None tag name returned will be used.",
1875
 
            (2, 2))
1876
 
        self.add_hook('post_branch_init',
 
1887
            (2, 2), None))
 
1888
        self.create_hook(HookPoint('post_branch_init',
1877
1889
            "Called after new branch initialization completes. "
1878
1890
            "post_branch_init is called with a "
1879
1891
            "bzrlib.branch.BranchInitHookParams. "
1880
1892
            "Note that init, branch and checkout (both heavyweight and "
1881
 
            "lightweight) will all trigger this hook.", (2, 2))
1882
 
        self.add_hook('post_switch',
 
1893
            "lightweight) will all trigger this hook.", (2, 2), None))
 
1894
        self.create_hook(HookPoint('post_switch',
1883
1895
            "Called after a checkout switches branch. "
1884
1896
            "post_switch is called with a "
1885
 
            "bzrlib.branch.SwitchHookParams.", (2, 2))
 
1897
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1886
1898
 
1887
1899
 
1888
1900
 
1891
1903
 
1892
1904
 
1893
1905
class ChangeBranchTipParams(object):
1894
 
    """Object holding parameters passed to `*_change_branch_tip` hooks.
 
1906
    """Object holding parameters passed to *_change_branch_tip hooks.
1895
1907
 
1896
1908
    There are 5 fields that hooks may wish to access:
1897
1909
 
1929
1941
 
1930
1942
 
1931
1943
class BranchInitHookParams(object):
1932
 
    """Object holding parameters passed to `*_branch_init` hooks.
 
1944
    """Object holding parameters passed to *_branch_init hooks.
1933
1945
 
1934
1946
    There are 4 fields that hooks may wish to access:
1935
1947
 
1969
1981
 
1970
1982
 
1971
1983
class SwitchHookParams(object):
1972
 
    """Object holding parameters passed to `*_switch` hooks.
 
1984
    """Object holding parameters passed to *_switch hooks.
1973
1985
 
1974
1986
    There are 4 fields that hooks may wish to access:
1975
1987
 
2001
2013
            self.revision_id)
2002
2014
 
2003
2015
 
 
2016
class BzrBranchFormat4(BranchFormat):
 
2017
    """Bzr branch format 4.
 
2018
 
 
2019
    This format has:
 
2020
     - a revision-history file.
 
2021
     - a branch-lock lock file [ to be shared with the bzrdir ]
 
2022
    """
 
2023
 
 
2024
    def get_format_description(self):
 
2025
        """See BranchFormat.get_format_description()."""
 
2026
        return "Branch format 4"
 
2027
 
 
2028
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2029
        """Create a branch of this format in a_bzrdir."""
 
2030
        if repository is not None:
 
2031
            raise NotImplementedError(
 
2032
                "initialize(repository=<not None>) on %r" % (self,))
 
2033
        utf8_files = [('revision-history', ''),
 
2034
                      ('branch-name', ''),
 
2035
                      ]
 
2036
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
2037
                                       lock_type='branch4', set_format=False)
 
2038
 
 
2039
    def __init__(self):
 
2040
        super(BzrBranchFormat4, self).__init__()
 
2041
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
2042
 
 
2043
    def network_name(self):
 
2044
        """The network name for this format is the control dirs disk label."""
 
2045
        return self._matchingbzrdir.get_format_string()
 
2046
 
 
2047
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2048
            found_repository=None):
 
2049
        """See BranchFormat.open()."""
 
2050
        if not _found:
 
2051
            # we are being called directly and must probe.
 
2052
            raise NotImplementedError
 
2053
        if found_repository is None:
 
2054
            found_repository = a_bzrdir.open_repository()
 
2055
        return BzrBranchPreSplitOut(_format=self,
 
2056
                         _control_files=a_bzrdir._control_files,
 
2057
                         a_bzrdir=a_bzrdir,
 
2058
                         name=name,
 
2059
                         _repository=found_repository)
 
2060
 
 
2061
    def __str__(self):
 
2062
        return "Bazaar-NG branch format 4"
 
2063
 
 
2064
 
2004
2065
class BranchFormatMetadir(BranchFormat):
2005
2066
    """Common logic for meta-dir based branch formats."""
2006
2067
 
2008
2069
        """What class to instantiate on open calls."""
2009
2070
        raise NotImplementedError(self._branch_class)
2010
2071
 
2011
 
    def _get_initial_config(self, append_revisions_only=None):
2012
 
        if append_revisions_only:
2013
 
            return "append_revisions_only = True\n"
2014
 
        else:
2015
 
            # Avoid writing anything if append_revisions_only is disabled,
2016
 
            # as that is the default.
2017
 
            return ""
2018
 
 
2019
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2020
 
                           repository=None):
2021
 
        """Initialize a branch in a bzrdir, with specified files
2022
 
 
2023
 
        :param a_bzrdir: The bzrdir to initialize the branch in
2024
 
        :param utf8_files: The files to create as a list of
2025
 
            (filename, content) tuples
2026
 
        :param name: Name of colocated branch to create, if any
2027
 
        :return: a branch in this format
2028
 
        """
2029
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2030
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2031
 
        control_files = lockable_files.LockableFiles(branch_transport,
2032
 
            'lock', lockdir.LockDir)
2033
 
        control_files.create_lock()
2034
 
        control_files.lock_write()
2035
 
        try:
2036
 
            utf8_files += [('format', self.get_format_string())]
2037
 
            for (filename, content) in utf8_files:
2038
 
                branch_transport.put_bytes(
2039
 
                    filename, content,
2040
 
                    mode=a_bzrdir._get_file_mode())
2041
 
        finally:
2042
 
            control_files.unlock()
2043
 
        branch = self.open(a_bzrdir, name, _found=True,
2044
 
                found_repository=repository)
2045
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2046
 
        return branch
2047
 
 
2048
2072
    def network_name(self):
2049
2073
        """A simple byte string uniquely identifying this format for RPC calls.
2050
2074
 
2083
2107
    def supports_tags(self):
2084
2108
        return True
2085
2109
 
2086
 
    def supports_leaving_lock(self):
2087
 
        return True
2088
 
 
2089
2110
 
2090
2111
class BzrBranchFormat5(BranchFormatMetadir):
2091
2112
    """Bzr branch format 5.
2111
2132
        """See BranchFormat.get_format_description()."""
2112
2133
        return "Branch format 5"
2113
2134
 
2114
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2115
 
                   append_revisions_only=None):
 
2135
    def initialize(self, a_bzrdir, name=None, repository=None):
2116
2136
        """Create a branch of this format in a_bzrdir."""
2117
 
        if append_revisions_only:
2118
 
            raise errors.UpgradeRequired(a_bzrdir.user_url)
2119
2137
        utf8_files = [('revision-history', ''),
2120
2138
                      ('branch-name', ''),
2121
2139
                      ]
2147
2165
        """See BranchFormat.get_format_description()."""
2148
2166
        return "Branch format 6"
2149
2167
 
2150
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2151
 
                   append_revisions_only=None):
 
2168
    def initialize(self, a_bzrdir, name=None, repository=None):
2152
2169
        """Create a branch of this format in a_bzrdir."""
2153
2170
        utf8_files = [('last-revision', '0 null:\n'),
2154
 
                      ('branch.conf',
2155
 
                          self._get_initial_config(append_revisions_only)),
 
2171
                      ('branch.conf', ''),
2156
2172
                      ('tags', ''),
2157
2173
                      ]
2158
2174
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2159
2175
 
2160
2176
    def make_tags(self, branch):
2161
2177
        """See bzrlib.branch.BranchFormat.make_tags()."""
2162
 
        return _mod_tag.BasicTags(branch)
 
2178
        return BasicTags(branch)
2163
2179
 
2164
2180
    def supports_set_append_revisions_only(self):
2165
2181
        return True
2179
2195
        """See BranchFormat.get_format_description()."""
2180
2196
        return "Branch format 8"
2181
2197
 
2182
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2183
 
                   append_revisions_only=None):
 
2198
    def initialize(self, a_bzrdir, name=None, repository=None):
2184
2199
        """Create a branch of this format in a_bzrdir."""
2185
2200
        utf8_files = [('last-revision', '0 null:\n'),
2186
 
                      ('branch.conf',
2187
 
                          self._get_initial_config(append_revisions_only)),
 
2201
                      ('branch.conf', ''),
2188
2202
                      ('tags', ''),
2189
2203
                      ('references', '')
2190
2204
                      ]
2191
2205
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2192
2206
 
 
2207
    def __init__(self):
 
2208
        super(BzrBranchFormat8, self).__init__()
 
2209
        self._matchingbzrdir.repository_format = \
 
2210
            RepositoryFormatKnitPack5RichRoot()
 
2211
 
2193
2212
    def make_tags(self, branch):
2194
2213
        """See bzrlib.branch.BranchFormat.make_tags()."""
2195
 
        return _mod_tag.BasicTags(branch)
 
2214
        return BasicTags(branch)
2196
2215
 
2197
2216
    def supports_set_append_revisions_only(self):
2198
2217
        return True
2203
2222
    supports_reference_locations = True
2204
2223
 
2205
2224
 
2206
 
class BzrBranchFormat7(BranchFormatMetadir):
 
2225
class BzrBranchFormat7(BzrBranchFormat8):
2207
2226
    """Branch format with last-revision, tags, and a stacked location pointer.
2208
2227
 
2209
2228
    The stacked location pointer is passed down to the repository and requires
2212
2231
    This format was introduced in bzr 1.6.
2213
2232
    """
2214
2233
 
2215
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2216
 
                   append_revisions_only=None):
 
2234
    def initialize(self, a_bzrdir, name=None, repository=None):
2217
2235
        """Create a branch of this format in a_bzrdir."""
2218
2236
        utf8_files = [('last-revision', '0 null:\n'),
2219
 
                      ('branch.conf',
2220
 
                          self._get_initial_config(append_revisions_only)),
 
2237
                      ('branch.conf', ''),
2221
2238
                      ('tags', ''),
2222
2239
                      ]
2223
2240
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2236
2253
    def supports_set_append_revisions_only(self):
2237
2254
        return True
2238
2255
 
2239
 
    def supports_stacking(self):
2240
 
        return True
2241
 
 
2242
 
    def make_tags(self, branch):
2243
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2244
 
        return _mod_tag.BasicTags(branch)
2245
 
 
2246
2256
    supports_reference_locations = False
2247
2257
 
2248
2258
 
2276
2286
        location = transport.put_bytes('location', to_branch.base)
2277
2287
 
2278
2288
    def initialize(self, a_bzrdir, name=None, target_branch=None,
2279
 
            repository=None, append_revisions_only=None):
 
2289
            repository=None):
2280
2290
        """Create a branch of this format in a_bzrdir."""
2281
2291
        if target_branch is None:
2282
2292
            # this format does not implement branch itself, thus the implicit
2283
2293
            # creation contract must see it as uninitializable
2284
2294
            raise errors.UninitializableFormat(self)
2285
2295
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2286
 
        if a_bzrdir._format.fixed_components:
2287
 
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
2288
2296
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2289
2297
        branch_transport.put_bytes('location',
2290
2298
            target_branch.bzrdir.user_url)
2350
2358
        return result
2351
2359
 
2352
2360
 
2353
 
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2354
 
    """Branch format registry."""
2355
 
 
2356
 
    def __init__(self, other_registry=None):
2357
 
        super(BranchFormatRegistry, self).__init__(other_registry)
2358
 
        self._default_format = None
2359
 
 
2360
 
    def set_default(self, format):
2361
 
        self._default_format = format
2362
 
 
2363
 
    def get_default(self):
2364
 
        return self._default_format
2365
 
 
2366
 
 
2367
2361
network_format_registry = registry.FormatRegistry()
2368
2362
"""Registry of formats indexed by their network name.
2369
2363
 
2372
2366
BranchFormat.network_name() for more detail.
2373
2367
"""
2374
2368
 
2375
 
format_registry = BranchFormatRegistry(network_format_registry)
2376
 
 
2377
2369
 
2378
2370
# formats which have no format string are not discoverable
2379
2371
# and not independently creatable, so are not registered.
2381
2373
__format6 = BzrBranchFormat6()
2382
2374
__format7 = BzrBranchFormat7()
2383
2375
__format8 = BzrBranchFormat8()
2384
 
format_registry.register(__format5)
2385
 
format_registry.register(BranchReferenceFormat())
2386
 
format_registry.register(__format6)
2387
 
format_registry.register(__format7)
2388
 
format_registry.register(__format8)
2389
 
format_registry.set_default(__format7)
 
2376
BranchFormat.register_format(__format5)
 
2377
BranchFormat.register_format(BranchReferenceFormat())
 
2378
BranchFormat.register_format(__format6)
 
2379
BranchFormat.register_format(__format7)
 
2380
BranchFormat.register_format(__format8)
 
2381
BranchFormat.set_default_format(__format7)
 
2382
_legacy_formats = [BzrBranchFormat4(),
 
2383
    ]
 
2384
network_format_registry.register(
 
2385
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2390
2386
 
2391
2387
 
2392
2388
class BranchWriteLockResult(LogicalLockResult):
2459
2455
    base = property(_get_base, doc="The URL for the root of this branch.")
2460
2456
 
2461
2457
    def _get_config(self):
2462
 
        return _mod_config.TransportConfig(self._transport, 'branch.conf')
 
2458
        return TransportConfig(self._transport, 'branch.conf')
2463
2459
 
2464
2460
    def is_locked(self):
2465
2461
        return self.control_files.is_locked()
2540
2536
        """See Branch.print_file."""
2541
2537
        return self.repository.print_file(file, revision_id)
2542
2538
 
 
2539
    def _write_revision_history(self, history):
 
2540
        """Factored out of set_revision_history.
 
2541
 
 
2542
        This performs the actual writing to disk.
 
2543
        It is intended to be called by BzrBranch5.set_revision_history."""
 
2544
        self._transport.put_bytes(
 
2545
            'revision-history', '\n'.join(history),
 
2546
            mode=self.bzrdir._get_file_mode())
 
2547
 
 
2548
    @needs_write_lock
 
2549
    def set_revision_history(self, rev_history):
 
2550
        """See Branch.set_revision_history."""
 
2551
        if 'evil' in debug.debug_flags:
 
2552
            mutter_callsite(3, "set_revision_history scales with history.")
 
2553
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2554
        for rev_id in rev_history:
 
2555
            check_not_reserved_id(rev_id)
 
2556
        if Branch.hooks['post_change_branch_tip']:
 
2557
            # Don't calculate the last_revision_info() if there are no hooks
 
2558
            # that will use it.
 
2559
            old_revno, old_revid = self.last_revision_info()
 
2560
        if len(rev_history) == 0:
 
2561
            revid = _mod_revision.NULL_REVISION
 
2562
        else:
 
2563
            revid = rev_history[-1]
 
2564
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2565
        self._write_revision_history(rev_history)
 
2566
        self._clear_cached_state()
 
2567
        self._cache_revision_history(rev_history)
 
2568
        for hook in Branch.hooks['set_rh']:
 
2569
            hook(self, rev_history)
 
2570
        if Branch.hooks['post_change_branch_tip']:
 
2571
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2572
 
 
2573
    def _synchronize_history(self, destination, revision_id):
 
2574
        """Synchronize last revision and revision history between branches.
 
2575
 
 
2576
        This version is most efficient when the destination is also a
 
2577
        BzrBranch5, but works for BzrBranch6 as long as the revision
 
2578
        history is the true lefthand parent history, and all of the revisions
 
2579
        are in the destination's repository.  If not, set_revision_history
 
2580
        will fail.
 
2581
 
 
2582
        :param destination: The branch to copy the history into
 
2583
        :param revision_id: The revision-id to truncate history at.  May
 
2584
          be None to copy complete history.
 
2585
        """
 
2586
        if not isinstance(destination._format, BzrBranchFormat5):
 
2587
            super(BzrBranch, self)._synchronize_history(
 
2588
                destination, revision_id)
 
2589
            return
 
2590
        if revision_id == _mod_revision.NULL_REVISION:
 
2591
            new_history = []
 
2592
        else:
 
2593
            new_history = self.revision_history()
 
2594
        if revision_id is not None and new_history != []:
 
2595
            try:
 
2596
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2597
            except ValueError:
 
2598
                rev = self.repository.get_revision(revision_id)
 
2599
                new_history = rev.get_history(self.repository)[1:]
 
2600
        destination.set_revision_history(new_history)
 
2601
 
2543
2602
    @needs_write_lock
2544
2603
    def set_last_revision_info(self, revno, revision_id):
2545
 
        if not revision_id or not isinstance(revision_id, basestring):
2546
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2604
        """Set the last revision of this branch.
 
2605
 
 
2606
        The caller is responsible for checking that the revno is correct
 
2607
        for this revision id.
 
2608
 
 
2609
        It may be possible to set the branch last revision to an id not
 
2610
        present in the repository.  However, branches can also be
 
2611
        configured to check constraints on history, in which case this may not
 
2612
        be permitted.
 
2613
        """
2547
2614
        revision_id = _mod_revision.ensure_null(revision_id)
2548
 
        old_revno, old_revid = self.last_revision_info()
2549
 
        if self.get_append_revisions_only():
2550
 
            self._check_history_violation(revision_id)
2551
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2552
 
        self._write_last_revision_info(revno, revision_id)
2553
 
        self._clear_cached_state()
2554
 
        self._last_revision_info_cache = revno, revision_id
2555
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2615
        # this old format stores the full history, but this api doesn't
 
2616
        # provide it, so we must generate, and might as well check it's
 
2617
        # correct
 
2618
        history = self._lefthand_history(revision_id)
 
2619
        if len(history) != revno:
 
2620
            raise AssertionError('%d != %d' % (len(history), revno))
 
2621
        self.set_revision_history(history)
 
2622
 
 
2623
    def _gen_revision_history(self):
 
2624
        history = self._transport.get_bytes('revision-history').split('\n')
 
2625
        if history[-1:] == ['']:
 
2626
            # There shouldn't be a trailing newline, but just in case.
 
2627
            history.pop()
 
2628
        return history
 
2629
 
 
2630
    @needs_write_lock
 
2631
    def generate_revision_history(self, revision_id, last_rev=None,
 
2632
        other_branch=None):
 
2633
        """Create a new revision history that will finish with revision_id.
 
2634
 
 
2635
        :param revision_id: the new tip to use.
 
2636
        :param last_rev: The previous last_revision. If not None, then this
 
2637
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2638
        :param other_branch: The other branch that DivergedBranches should
 
2639
            raise with respect to.
 
2640
        """
 
2641
        self.set_revision_history(self._lefthand_history(revision_id,
 
2642
            last_rev, other_branch))
2556
2643
 
2557
2644
    def basis_tree(self):
2558
2645
        """See Branch.basis_tree."""
2567
2654
                pass
2568
2655
        return None
2569
2656
 
 
2657
    def _basic_push(self, target, overwrite, stop_revision):
 
2658
        """Basic implementation of push without bound branches or hooks.
 
2659
 
 
2660
        Must be called with source read locked and target write locked.
 
2661
        """
 
2662
        result = BranchPushResult()
 
2663
        result.source_branch = self
 
2664
        result.target_branch = target
 
2665
        result.old_revno, result.old_revid = target.last_revision_info()
 
2666
        self.update_references(target)
 
2667
        if result.old_revid != self.last_revision():
 
2668
            # We assume that during 'push' this repository is closer than
 
2669
            # the target.
 
2670
            graph = self.repository.get_graph(target.repository)
 
2671
            target.update_revisions(self, stop_revision,
 
2672
                overwrite=overwrite, graph=graph)
 
2673
        if self._push_should_merge_tags():
 
2674
            result.tag_conflicts = self.tags.merge_to(target.tags,
 
2675
                overwrite)
 
2676
        result.new_revno, result.new_revid = target.last_revision_info()
 
2677
        return result
 
2678
 
2570
2679
    def get_stacked_on_url(self):
2571
2680
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2572
2681
 
2583
2692
            self._transport.put_bytes('parent', url + '\n',
2584
2693
                mode=self.bzrdir._get_file_mode())
2585
2694
 
 
2695
 
 
2696
class BzrBranchPreSplitOut(BzrBranch):
 
2697
 
 
2698
    def _get_checkout_format(self):
 
2699
        """Return the most suitable metadir for a checkout of this branch.
 
2700
        Weaves are used if this branch's repository uses weaves.
 
2701
        """
 
2702
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
 
2703
        from bzrlib.bzrdir import BzrDirMetaFormat1
 
2704
        format = BzrDirMetaFormat1()
 
2705
        format.repository_format = RepositoryFormat7()
 
2706
        return format
 
2707
 
 
2708
 
 
2709
class BzrBranch5(BzrBranch):
 
2710
    """A format 5 branch. This supports new features over plain branches.
 
2711
 
 
2712
    It has support for a master_branch which is the data for bound branches.
 
2713
    """
 
2714
 
 
2715
    def get_bound_location(self):
 
2716
        try:
 
2717
            return self._transport.get_bytes('bound')[:-1]
 
2718
        except errors.NoSuchFile:
 
2719
            return None
 
2720
 
 
2721
    @needs_read_lock
 
2722
    def get_master_branch(self, possible_transports=None):
 
2723
        """Return the branch we are bound to.
 
2724
 
 
2725
        :return: Either a Branch, or None
 
2726
 
 
2727
        This could memoise the branch, but if thats done
 
2728
        it must be revalidated on each new lock.
 
2729
        So for now we just don't memoise it.
 
2730
        # RBC 20060304 review this decision.
 
2731
        """
 
2732
        bound_loc = self.get_bound_location()
 
2733
        if not bound_loc:
 
2734
            return None
 
2735
        try:
 
2736
            return Branch.open(bound_loc,
 
2737
                               possible_transports=possible_transports)
 
2738
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2739
            raise errors.BoundBranchConnectionFailure(
 
2740
                    self, bound_loc, e)
 
2741
 
2586
2742
    @needs_write_lock
2587
 
    def unbind(self):
2588
 
        """If bound, unbind"""
2589
 
        return self.set_bound_location(None)
 
2743
    def set_bound_location(self, location):
 
2744
        """Set the target where this branch is bound to.
 
2745
 
 
2746
        :param location: URL to the target branch
 
2747
        """
 
2748
        if location:
 
2749
            self._transport.put_bytes('bound', location+'\n',
 
2750
                mode=self.bzrdir._get_file_mode())
 
2751
        else:
 
2752
            try:
 
2753
                self._transport.delete('bound')
 
2754
            except errors.NoSuchFile:
 
2755
                return False
 
2756
            return True
2590
2757
 
2591
2758
    @needs_write_lock
2592
2759
    def bind(self, other):
2614
2781
        # history around
2615
2782
        self.set_bound_location(other.base)
2616
2783
 
2617
 
    def get_bound_location(self):
2618
 
        try:
2619
 
            return self._transport.get_bytes('bound')[:-1]
2620
 
        except errors.NoSuchFile:
2621
 
            return None
2622
 
 
2623
 
    @needs_read_lock
2624
 
    def get_master_branch(self, possible_transports=None):
2625
 
        """Return the branch we are bound to.
2626
 
 
2627
 
        :return: Either a Branch, or None
2628
 
        """
2629
 
        if self._master_branch_cache is None:
2630
 
            self._master_branch_cache = self._get_master_branch(
2631
 
                possible_transports)
2632
 
        return self._master_branch_cache
2633
 
 
2634
 
    def _get_master_branch(self, possible_transports):
2635
 
        bound_loc = self.get_bound_location()
2636
 
        if not bound_loc:
2637
 
            return None
2638
 
        try:
2639
 
            return Branch.open(bound_loc,
2640
 
                               possible_transports=possible_transports)
2641
 
        except (errors.NotBranchError, errors.ConnectionError), e:
2642
 
            raise errors.BoundBranchConnectionFailure(
2643
 
                    self, bound_loc, e)
2644
 
 
2645
2784
    @needs_write_lock
2646
 
    def set_bound_location(self, location):
2647
 
        """Set the target where this branch is bound to.
2648
 
 
2649
 
        :param location: URL to the target branch
2650
 
        """
2651
 
        self._master_branch_cache = None
2652
 
        if location:
2653
 
            self._transport.put_bytes('bound', location+'\n',
2654
 
                mode=self.bzrdir._get_file_mode())
2655
 
        else:
2656
 
            try:
2657
 
                self._transport.delete('bound')
2658
 
            except errors.NoSuchFile:
2659
 
                return False
2660
 
            return True
 
2785
    def unbind(self):
 
2786
        """If bound, unbind"""
 
2787
        return self.set_bound_location(None)
2661
2788
 
2662
2789
    @needs_write_lock
2663
2790
    def update(self, possible_transports=None):
2676
2803
            return old_tip
2677
2804
        return None
2678
2805
 
2679
 
    def _read_last_revision_info(self):
2680
 
        revision_string = self._transport.get_bytes('last-revision')
2681
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2682
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2683
 
        revno = int(revno)
2684
 
        return revno, revision_id
2685
 
 
2686
 
    def _write_last_revision_info(self, revno, revision_id):
2687
 
        """Simply write out the revision id, with no checks.
2688
 
 
2689
 
        Use set_last_revision_info to perform this safely.
2690
 
 
2691
 
        Does not update the revision_history cache.
2692
 
        """
2693
 
        revision_id = _mod_revision.ensure_null(revision_id)
2694
 
        out_string = '%d %s\n' % (revno, revision_id)
2695
 
        self._transport.put_bytes('last-revision', out_string,
2696
 
            mode=self.bzrdir._get_file_mode())
2697
 
 
2698
 
 
2699
 
class FullHistoryBzrBranch(BzrBranch):
2700
 
    """Bzr branch which contains the full revision history."""
2701
 
 
2702
 
    @needs_write_lock
2703
 
    def set_last_revision_info(self, revno, revision_id):
2704
 
        if not revision_id or not isinstance(revision_id, basestring):
2705
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2706
 
        revision_id = _mod_revision.ensure_null(revision_id)
2707
 
        # this old format stores the full history, but this api doesn't
2708
 
        # provide it, so we must generate, and might as well check it's
2709
 
        # correct
2710
 
        history = self._lefthand_history(revision_id)
2711
 
        if len(history) != revno:
2712
 
            raise AssertionError('%d != %d' % (len(history), revno))
2713
 
        self._set_revision_history(history)
2714
 
 
2715
 
    def _read_last_revision_info(self):
2716
 
        rh = self.revision_history()
2717
 
        revno = len(rh)
2718
 
        if revno:
2719
 
            return (revno, rh[-1])
2720
 
        else:
2721
 
            return (0, _mod_revision.NULL_REVISION)
2722
 
 
2723
 
    @deprecated_method(deprecated_in((2, 4, 0)))
2724
 
    @needs_write_lock
2725
 
    def set_revision_history(self, rev_history):
2726
 
        """See Branch.set_revision_history."""
2727
 
        self._set_revision_history(rev_history)
2728
 
 
2729
 
    def _set_revision_history(self, rev_history):
2730
 
        if 'evil' in debug.debug_flags:
2731
 
            mutter_callsite(3, "set_revision_history scales with history.")
2732
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2733
 
        for rev_id in rev_history:
2734
 
            check_not_reserved_id(rev_id)
2735
 
        if Branch.hooks['post_change_branch_tip']:
2736
 
            # Don't calculate the last_revision_info() if there are no hooks
2737
 
            # that will use it.
2738
 
            old_revno, old_revid = self.last_revision_info()
2739
 
        if len(rev_history) == 0:
2740
 
            revid = _mod_revision.NULL_REVISION
2741
 
        else:
2742
 
            revid = rev_history[-1]
2743
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2744
 
        self._write_revision_history(rev_history)
2745
 
        self._clear_cached_state()
2746
 
        self._cache_revision_history(rev_history)
2747
 
        for hook in Branch.hooks['set_rh']:
2748
 
            hook(self, rev_history)
2749
 
        if Branch.hooks['post_change_branch_tip']:
2750
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2751
 
 
2752
 
    def _write_revision_history(self, history):
2753
 
        """Factored out of set_revision_history.
2754
 
 
2755
 
        This performs the actual writing to disk.
2756
 
        It is intended to be called by set_revision_history."""
2757
 
        self._transport.put_bytes(
2758
 
            'revision-history', '\n'.join(history),
2759
 
            mode=self.bzrdir._get_file_mode())
2760
 
 
2761
 
    def _gen_revision_history(self):
2762
 
        history = self._transport.get_bytes('revision-history').split('\n')
2763
 
        if history[-1:] == ['']:
2764
 
            # There shouldn't be a trailing newline, but just in case.
2765
 
            history.pop()
2766
 
        return history
2767
 
 
2768
 
    def _synchronize_history(self, destination, revision_id):
2769
 
        if not isinstance(destination, FullHistoryBzrBranch):
2770
 
            super(BzrBranch, self)._synchronize_history(
2771
 
                destination, revision_id)
2772
 
            return
2773
 
        if revision_id == _mod_revision.NULL_REVISION:
2774
 
            new_history = []
2775
 
        else:
2776
 
            new_history = self.revision_history()
2777
 
        if revision_id is not None and new_history != []:
2778
 
            try:
2779
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2780
 
            except ValueError:
2781
 
                rev = self.repository.get_revision(revision_id)
2782
 
                new_history = rev.get_history(self.repository)[1:]
2783
 
        destination._set_revision_history(new_history)
2784
 
 
2785
 
    @needs_write_lock
2786
 
    def generate_revision_history(self, revision_id, last_rev=None,
2787
 
        other_branch=None):
2788
 
        """Create a new revision history that will finish with revision_id.
2789
 
 
2790
 
        :param revision_id: the new tip to use.
2791
 
        :param last_rev: The previous last_revision. If not None, then this
2792
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
2793
 
        :param other_branch: The other branch that DivergedBranches should
2794
 
            raise with respect to.
2795
 
        """
2796
 
        self._set_revision_history(self._lefthand_history(revision_id,
2797
 
            last_rev, other_branch))
2798
 
 
2799
 
 
2800
 
class BzrBranch5(FullHistoryBzrBranch):
2801
 
    """A format 5 branch. This supports new features over plain branches.
2802
 
 
2803
 
    It has support for a master_branch which is the data for bound branches.
2804
 
    """
2805
 
 
2806
 
 
2807
 
class BzrBranch8(BzrBranch):
 
2806
 
 
2807
class BzrBranch8(BzrBranch5):
2808
2808
    """A branch that stores tree-reference locations."""
2809
2809
 
2810
2810
    def _open_hook(self):
2836
2836
        self._last_revision_info_cache = None
2837
2837
        self._reference_info = None
2838
2838
 
 
2839
    def _last_revision_info(self):
 
2840
        revision_string = self._transport.get_bytes('last-revision')
 
2841
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2842
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2843
        revno = int(revno)
 
2844
        return revno, revision_id
 
2845
 
 
2846
    def _write_last_revision_info(self, revno, revision_id):
 
2847
        """Simply write out the revision id, with no checks.
 
2848
 
 
2849
        Use set_last_revision_info to perform this safely.
 
2850
 
 
2851
        Does not update the revision_history cache.
 
2852
        Intended to be called by set_last_revision_info and
 
2853
        _write_revision_history.
 
2854
        """
 
2855
        revision_id = _mod_revision.ensure_null(revision_id)
 
2856
        out_string = '%d %s\n' % (revno, revision_id)
 
2857
        self._transport.put_bytes('last-revision', out_string,
 
2858
            mode=self.bzrdir._get_file_mode())
 
2859
 
 
2860
    @needs_write_lock
 
2861
    def set_last_revision_info(self, revno, revision_id):
 
2862
        revision_id = _mod_revision.ensure_null(revision_id)
 
2863
        old_revno, old_revid = self.last_revision_info()
 
2864
        if self._get_append_revisions_only():
 
2865
            self._check_history_violation(revision_id)
 
2866
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2867
        self._write_last_revision_info(revno, revision_id)
 
2868
        self._clear_cached_state()
 
2869
        self._last_revision_info_cache = revno, revision_id
 
2870
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2871
 
 
2872
    def _synchronize_history(self, destination, revision_id):
 
2873
        """Synchronize last revision and revision history between branches.
 
2874
 
 
2875
        :see: Branch._synchronize_history
 
2876
        """
 
2877
        # XXX: The base Branch has a fast implementation of this method based
 
2878
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
 
2879
        # that uses set_revision_history.  This class inherits from BzrBranch5,
 
2880
        # but wants the fast implementation, so it calls
 
2881
        # Branch._synchronize_history directly.
 
2882
        Branch._synchronize_history(self, destination, revision_id)
 
2883
 
2839
2884
    def _check_history_violation(self, revision_id):
2840
 
        current_revid = self.last_revision()
2841
 
        last_revision = _mod_revision.ensure_null(current_revid)
 
2885
        last_revision = _mod_revision.ensure_null(self.last_revision())
2842
2886
        if _mod_revision.is_null(last_revision):
2843
2887
            return
2844
 
        graph = self.repository.get_graph()
2845
 
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2846
 
            if lh_ancestor == current_revid:
2847
 
                return
2848
 
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2888
        if last_revision not in self._lefthand_history(revision_id):
 
2889
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
2849
2890
 
2850
2891
    def _gen_revision_history(self):
2851
2892
        """Generate the revision history from last revision
2854
2895
        self._extend_partial_history(stop_index=last_revno-1)
2855
2896
        return list(reversed(self._partial_revision_history_cache))
2856
2897
 
 
2898
    def _write_revision_history(self, history):
 
2899
        """Factored out of set_revision_history.
 
2900
 
 
2901
        This performs the actual writing to disk, with format-specific checks.
 
2902
        It is intended to be called by BzrBranch5.set_revision_history.
 
2903
        """
 
2904
        if len(history) == 0:
 
2905
            last_revision = 'null:'
 
2906
        else:
 
2907
            if history != self._lefthand_history(history[-1]):
 
2908
                raise errors.NotLefthandHistory(history)
 
2909
            last_revision = history[-1]
 
2910
        if self._get_append_revisions_only():
 
2911
            self._check_history_violation(last_revision)
 
2912
        self._write_last_revision_info(len(history), last_revision)
 
2913
 
2857
2914
    @needs_write_lock
2858
2915
    def _set_parent_location(self, url):
2859
2916
        """Set the parent branch"""
2945
3002
 
2946
3003
    def set_bound_location(self, location):
2947
3004
        """See Branch.set_push_location."""
2948
 
        self._master_branch_cache = None
2949
3005
        result = None
2950
3006
        config = self.get_config()
2951
3007
        if location is None:
2982
3038
        # you can always ask for the URL; but you might not be able to use it
2983
3039
        # if the repo can't support stacking.
2984
3040
        ## self._check_stackable_repo()
2985
 
        # stacked_on_location is only ever defined in branch.conf, so don't
2986
 
        # waste effort reading the whole stack of config files.
2987
 
        config = self.get_config()._get_branch_data_config()
2988
 
        stacked_url = self._get_config_location('stacked_on_location',
2989
 
            config=config)
 
3041
        stacked_url = self._get_config_location('stacked_on_location')
2990
3042
        if stacked_url is None:
2991
3043
            raise errors.NotStacked(self)
2992
3044
        return stacked_url
2993
3045
 
 
3046
    def _get_append_revisions_only(self):
 
3047
        return self.get_config(
 
3048
            ).get_user_option_as_bool('append_revisions_only')
 
3049
 
 
3050
    @needs_write_lock
 
3051
    def generate_revision_history(self, revision_id, last_rev=None,
 
3052
                                  other_branch=None):
 
3053
        """See BzrBranch5.generate_revision_history"""
 
3054
        history = self._lefthand_history(revision_id, last_rev, other_branch)
 
3055
        revno = len(history)
 
3056
        self.set_last_revision_info(revno, revision_id)
 
3057
 
2994
3058
    @needs_read_lock
2995
3059
    def get_rev_id(self, revno, history=None):
2996
3060
        """Find the revision id of the specified revno."""
3020
3084
        try:
3021
3085
            index = self._partial_revision_history_cache.index(revision_id)
3022
3086
        except ValueError:
3023
 
            try:
3024
 
                self._extend_partial_history(stop_revision=revision_id)
3025
 
            except errors.RevisionNotPresent, e:
3026
 
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
 
3087
            self._extend_partial_history(stop_revision=revision_id)
3027
3088
            index = len(self._partial_revision_history_cache) - 1
3028
3089
            if self._partial_revision_history_cache[index] != revision_id:
3029
3090
                raise errors.NoSuchRevision(self, revision_id)
3082
3143
    :ivar local_branch: target branch if there is a Master, else None
3083
3144
    :ivar target_branch: Target/destination branch object. (write locked)
3084
3145
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3085
 
    :ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3086
3146
    """
3087
3147
 
3088
3148
    @deprecated_method(deprecated_in((2, 3, 0)))
3094
3154
        return self.new_revno - self.old_revno
3095
3155
 
3096
3156
    def report(self, to_file):
3097
 
        tag_conflicts = getattr(self, "tag_conflicts", None)
3098
 
        tag_updates = getattr(self, "tag_updates", None)
3099
3157
        if not is_quiet():
3100
 
            if self.old_revid != self.new_revid:
 
3158
            if self.old_revid == self.new_revid:
 
3159
                to_file.write('No revisions to pull.\n')
 
3160
            else:
3101
3161
                to_file.write('Now on revision %d.\n' % self.new_revno)
3102
 
            if tag_updates:
3103
 
                to_file.write('%d tag(s) updated.\n' % len(tag_updates))
3104
 
            if self.old_revid == self.new_revid and not tag_updates:
3105
 
                if not tag_conflicts:
3106
 
                    to_file.write('No revisions or tags to pull.\n')
3107
 
                else:
3108
 
                    to_file.write('No revisions to pull.\n')
3109
3162
        self._show_tag_conficts(to_file)
3110
3163
 
3111
3164
 
3137
3190
        return self.new_revno - self.old_revno
3138
3191
 
3139
3192
    def report(self, to_file):
3140
 
        # TODO: This function gets passed a to_file, but then
3141
 
        # ignores it and calls note() instead. This is also
3142
 
        # inconsistent with PullResult(), which writes to stdout.
3143
 
        # -- JRV20110901, bug #838853
3144
 
        tag_conflicts = getattr(self, "tag_conflicts", None)
3145
 
        tag_updates = getattr(self, "tag_updates", None)
3146
 
        if not is_quiet():
3147
 
            if self.old_revid != self.new_revid:
3148
 
                note(gettext('Pushed up to revision %d.') % self.new_revno)
3149
 
            if tag_updates:
3150
 
                note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3151
 
            if self.old_revid == self.new_revid and not tag_updates:
3152
 
                if not tag_conflicts:
3153
 
                    note(gettext('No new revisions or tags to push.'))
3154
 
                else:
3155
 
                    note(gettext('No new revisions to push.'))
 
3193
        """Write a human-readable description of the result."""
 
3194
        if self.old_revid == self.new_revid:
 
3195
            note('No new revisions to push.')
 
3196
        else:
 
3197
            note('Pushed up to revision %d.' % self.new_revno)
3156
3198
        self._show_tag_conficts(to_file)
3157
3199
 
3158
3200
 
3172
3214
        :param verbose: Requests more detailed display of what was checked,
3173
3215
            if any.
3174
3216
        """
3175
 
        note(gettext('checked branch {0} format {1}').format(
3176
 
                                self.branch.user_url, self.branch._format))
 
3217
        note('checked branch %s format %s', self.branch.user_url,
 
3218
            self.branch._format)
3177
3219
        for error in self.errors:
3178
 
            note(gettext('found error:%s'), error)
 
3220
            note('found error:%s', error)
3179
3221
 
3180
3222
 
3181
3223
class Converter5to6(object):
3220
3262
 
3221
3263
 
3222
3264
class Converter7to8(object):
3223
 
    """Perform an in-place upgrade of format 7 to format 8"""
 
3265
    """Perform an in-place upgrade of format 6 to format 7"""
3224
3266
 
3225
3267
    def convert(self, branch):
3226
3268
        format = BzrBranchFormat8()
3229
3271
        branch._transport.put_bytes('format', format.get_format_string())
3230
3272
 
3231
3273
 
 
3274
def _run_with_write_locked_target(target, callable, *args, **kwargs):
 
3275
    """Run ``callable(*args, **kwargs)``, write-locking target for the
 
3276
    duration.
 
3277
 
 
3278
    _run_with_write_locked_target will attempt to release the lock it acquires.
 
3279
 
 
3280
    If an exception is raised by callable, then that exception *will* be
 
3281
    propagated, even if the unlock attempt raises its own error.  Thus
 
3282
    _run_with_write_locked_target should be preferred to simply doing::
 
3283
 
 
3284
        target.lock_write()
 
3285
        try:
 
3286
            return callable(*args, **kwargs)
 
3287
        finally:
 
3288
            target.unlock()
 
3289
 
 
3290
    """
 
3291
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
 
3292
    # should share code?
 
3293
    target.lock_write()
 
3294
    try:
 
3295
        result = callable(*args, **kwargs)
 
3296
    except:
 
3297
        exc_info = sys.exc_info()
 
3298
        try:
 
3299
            target.unlock()
 
3300
        finally:
 
3301
            raise exc_info[0], exc_info[1], exc_info[2]
 
3302
    else:
 
3303
        target.unlock()
 
3304
        return result
 
3305
 
 
3306
 
3232
3307
class InterBranch(InterObject):
3233
3308
    """This class represents operations taking place between two branches.
3234
3309
 
3262
3337
        raise NotImplementedError(self.pull)
3263
3338
 
3264
3339
    @needs_write_lock
3265
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
3340
    def update_revisions(self, stop_revision=None, overwrite=False,
 
3341
                         graph=None):
 
3342
        """Pull in new perfect-fit revisions.
 
3343
 
 
3344
        :param stop_revision: Updated until the given revision
 
3345
        :param overwrite: Always set the branch pointer, rather than checking
 
3346
            to see if it is a proper descendant.
 
3347
        :param graph: A Graph object that can be used to query history
 
3348
            information. This can be None.
 
3349
        :return: None
 
3350
        """
 
3351
        raise NotImplementedError(self.update_revisions)
 
3352
 
 
3353
    @needs_write_lock
 
3354
    def push(self, overwrite=False, stop_revision=None,
3266
3355
             _override_hook_source_branch=None):
3267
3356
        """Mirror the source branch into the target branch.
3268
3357
 
3279
3368
        """
3280
3369
        raise NotImplementedError(self.copy_content_into)
3281
3370
 
3282
 
    @needs_write_lock
3283
 
    def fetch(self, stop_revision=None, limit=None):
3284
 
        """Fetch revisions.
3285
 
 
3286
 
        :param stop_revision: Last revision to fetch
3287
 
        :param limit: Optional rough limit of revisions to fetch
3288
 
        """
3289
 
        raise NotImplementedError(self.fetch)
3290
 
 
3291
3371
 
3292
3372
class GenericInterBranch(InterBranch):
3293
3373
    """InterBranch implementation that uses public Branch functions."""
3299
3379
 
3300
3380
    @classmethod
3301
3381
    def _get_branch_formats_to_test(klass):
3302
 
        return [(format_registry.get_default(), format_registry.get_default())]
 
3382
        return [(BranchFormat._default_format, BranchFormat._default_format)]
3303
3383
 
3304
3384
    @classmethod
3305
3385
    def unwrap_format(klass, format):
3328
3408
            self.source.tags.merge_to(self.target.tags)
3329
3409
 
3330
3410
    @needs_write_lock
3331
 
    def fetch(self, stop_revision=None, limit=None):
3332
 
        if self.target.base == self.source.base:
3333
 
            return (0, [])
3334
 
        self.source.lock_read()
3335
 
        try:
3336
 
            fetch_spec_factory = fetch.FetchSpecFactory()
3337
 
            fetch_spec_factory.source_branch = self.source
3338
 
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3339
 
            fetch_spec_factory.source_repo = self.source.repository
3340
 
            fetch_spec_factory.target_repo = self.target.repository
3341
 
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3342
 
            fetch_spec_factory.limit = limit
3343
 
            fetch_spec = fetch_spec_factory.make_fetch_spec()
3344
 
            return self.target.repository.fetch(self.source.repository,
3345
 
                fetch_spec=fetch_spec)
3346
 
        finally:
3347
 
            self.source.unlock()
3348
 
 
3349
 
    @needs_write_lock
3350
 
    def _update_revisions(self, stop_revision=None, overwrite=False,
3351
 
            graph=None):
 
3411
    def update_revisions(self, stop_revision=None, overwrite=False,
 
3412
        graph=None):
 
3413
        """See InterBranch.update_revisions()."""
3352
3414
        other_revno, other_last_revision = self.source.last_revision_info()
3353
3415
        stop_revno = None # unknown
3354
3416
        if stop_revision is None:
3365
3427
        # case of having something to pull, and so that the check for
3366
3428
        # already merged can operate on the just fetched graph, which will
3367
3429
        # be cached in memory.
3368
 
        self.fetch(stop_revision=stop_revision)
 
3430
        self.target.fetch(self.source, stop_revision)
3369
3431
        # Check to see if one is an ancestor of the other
3370
3432
        if not overwrite:
3371
3433
            if graph is None:
3399
3461
        if local and not bound_location:
3400
3462
            raise errors.LocalRequiresBoundBranch()
3401
3463
        master_branch = None
3402
 
        source_is_master = False
3403
 
        if bound_location:
3404
 
            # bound_location comes from a config file, some care has to be
3405
 
            # taken to relate it to source.user_url
3406
 
            normalized = urlutils.normalize_url(bound_location)
3407
 
            try:
3408
 
                relpath = self.source.user_transport.relpath(normalized)
3409
 
                source_is_master = (relpath == '')
3410
 
            except (errors.PathNotChild, errors.InvalidURL):
3411
 
                source_is_master = False
 
3464
        source_is_master = (self.source.user_url == bound_location)
3412
3465
        if not local and bound_location and not source_is_master:
3413
3466
            # not pulling from master, so we need to update master.
3414
3467
            master_branch = self.target.get_master_branch(possible_transports)
3427
3480
            if master_branch:
3428
3481
                master_branch.unlock()
3429
3482
 
3430
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
3483
    def push(self, overwrite=False, stop_revision=None,
3431
3484
             _override_hook_source_branch=None):
3432
3485
        """See InterBranch.push.
3433
3486
 
3434
3487
        This is the basic concrete implementation of push()
3435
3488
 
3436
 
        :param _override_hook_source_branch: If specified, run the hooks
3437
 
            passing this Branch as the source, rather than self.  This is for
3438
 
            use of RemoteBranch, where push is delegated to the underlying
3439
 
            vfs-based Branch.
 
3489
        :param _override_hook_source_branch: If specified, run
 
3490
        the hooks passing this Branch as the source, rather than self.
 
3491
        This is for use of RemoteBranch, where push is delegated to the
 
3492
        underlying vfs-based Branch.
3440
3493
        """
3441
 
        if lossy:
3442
 
            raise errors.LossyPushToSameVCS(self.source, self.target)
3443
3494
        # TODO: Public option to disable running hooks - should be trivial but
3444
3495
        # needs tests.
3445
 
 
3446
 
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3447
 
        op.add_cleanup(self.source.lock_read().unlock)
3448
 
        op.add_cleanup(self.target.lock_write().unlock)
3449
 
        return op.run(overwrite, stop_revision,
3450
 
            _override_hook_source_branch=_override_hook_source_branch)
3451
 
 
3452
 
    def _basic_push(self, overwrite, stop_revision):
3453
 
        """Basic implementation of push without bound branches or hooks.
3454
 
 
3455
 
        Must be called with source read locked and target write locked.
3456
 
        """
3457
 
        result = BranchPushResult()
3458
 
        result.source_branch = self.source
3459
 
        result.target_branch = self.target
3460
 
        result.old_revno, result.old_revid = self.target.last_revision_info()
3461
 
        self.source.update_references(self.target)
3462
 
        if result.old_revid != stop_revision:
3463
 
            # We assume that during 'push' this repository is closer than
3464
 
            # the target.
3465
 
            graph = self.source.repository.get_graph(self.target.repository)
3466
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3467
 
                    graph=graph)
3468
 
        if self.source._push_should_merge_tags():
3469
 
            result.tag_updates, result.tag_conflicts = (
3470
 
                self.source.tags.merge_to(self.target.tags, overwrite))
3471
 
        result.new_revno, result.new_revid = self.target.last_revision_info()
3472
 
        return result
3473
 
 
3474
 
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
 
3496
        self.source.lock_read()
 
3497
        try:
 
3498
            return _run_with_write_locked_target(
 
3499
                self.target, self._push_with_bound_branches, overwrite,
 
3500
                stop_revision,
 
3501
                _override_hook_source_branch=_override_hook_source_branch)
 
3502
        finally:
 
3503
            self.source.unlock()
 
3504
 
 
3505
    def _push_with_bound_branches(self, overwrite, stop_revision,
3475
3506
            _override_hook_source_branch=None):
3476
3507
        """Push from source into target, and into target's master if any.
3477
3508
        """
3489
3520
            # be bound to itself? -- mbp 20070507
3490
3521
            master_branch = self.target.get_master_branch()
3491
3522
            master_branch.lock_write()
3492
 
            operation.add_cleanup(master_branch.unlock)
3493
 
            # push into the master from the source branch.
3494
 
            master_inter = InterBranch.get(self.source, master_branch)
3495
 
            master_inter._basic_push(overwrite, stop_revision)
3496
 
            # and push into the target branch from the source. Note that
3497
 
            # we push from the source branch again, because it's considered
3498
 
            # the highest bandwidth repository.
3499
 
            result = self._basic_push(overwrite, stop_revision)
3500
 
            result.master_branch = master_branch
3501
 
            result.local_branch = self.target
 
3523
            try:
 
3524
                # push into the master from the source branch.
 
3525
                self.source._basic_push(master_branch, overwrite, stop_revision)
 
3526
                # and push into the target branch from the source. Note that we
 
3527
                # push from the source branch again, because it's considered the
 
3528
                # highest bandwidth repository.
 
3529
                result = self.source._basic_push(self.target, overwrite,
 
3530
                    stop_revision)
 
3531
                result.master_branch = master_branch
 
3532
                result.local_branch = self.target
 
3533
                _run_hooks()
 
3534
                return result
 
3535
            finally:
 
3536
                master_branch.unlock()
3502
3537
        else:
3503
 
            master_branch = None
3504
3538
            # no master branch
3505
 
            result = self._basic_push(overwrite, stop_revision)
 
3539
            result = self.source._basic_push(self.target, overwrite,
 
3540
                stop_revision)
3506
3541
            # TODO: Why set master_branch and local_branch if there's no
3507
3542
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3508
3543
            # 20070504
3509
3544
            result.master_branch = self.target
3510
3545
            result.local_branch = None
3511
 
        _run_hooks()
3512
 
        return result
 
3546
            _run_hooks()
 
3547
            return result
3513
3548
 
3514
3549
    def _pull(self, overwrite=False, stop_revision=None,
3515
3550
             possible_transports=None, _hook_master=None, run_hooks=True,
3525
3560
        :param run_hooks: Private parameter - if false, this branch
3526
3561
            is being called because it's the master of the primary branch,
3527
3562
            so it should not run its hooks.
3528
 
            is being called because it's the master of the primary branch,
3529
 
            so it should not run its hooks.
3530
3563
        :param _override_hook_target: Private parameter - set the branch to be
3531
3564
            supplied as the target_branch to pull hooks.
3532
3565
        :param local: Only update the local branch, and not the bound branch.
3551
3584
            # -- JRV20090506
3552
3585
            result.old_revno, result.old_revid = \
3553
3586
                self.target.last_revision_info()
3554
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3555
 
                graph=graph)
 
3587
            self.target.update_revisions(self.source, stop_revision,
 
3588
                overwrite=overwrite, graph=graph)
3556
3589
            # TODO: The old revid should be specified when merging tags, 
3557
3590
            # so a tags implementation that versions tags can only 
3558
3591
            # pull in the most recent changes. -- JRV20090506
3559
 
            result.tag_updates, result.tag_conflicts = (
3560
 
                self.source.tags.merge_to(self.target.tags, overwrite,
3561
 
                    ignore_master=not merge_tags_to_master))
 
3592
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3593
                overwrite, ignore_master=not merge_tags_to_master)
3562
3594
            result.new_revno, result.new_revid = self.target.last_revision_info()
3563
3595
            if _hook_master:
3564
3596
                result.master_branch = _hook_master