~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Richard Wilbur
  • Date: 2016-02-04 19:07:28 UTC
  • mto: This revision was merged to the branch mainline in revision 6618.
  • Revision ID: richard.wilbur@gmail.com-20160204190728-p0zvfii6zase0fw7
Update COPYING.txt from the original http://www.gnu.org/licenses/gpl-2.0.txt  (Only differences were in whitespace.)  Thanks to Petr Stodulka for pointing out the discrepancy.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2012 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
import bzrlib.bzrdir
17
20
 
18
21
from cStringIO import StringIO
19
 
import sys
20
22
 
21
23
from bzrlib.lazy_import import lazy_import
22
24
lazy_import(globals(), """
23
 
from itertools import chain
 
25
import itertools
24
26
from bzrlib import (
25
 
        bzrdir,
26
 
        cache_utf8,
27
 
        config as _mod_config,
28
 
        debug,
29
 
        errors,
30
 
        fetch,
31
 
        graph as _mod_graph,
32
 
        lockdir,
33
 
        lockable_files,
34
 
        remote,
35
 
        repository,
36
 
        revision as _mod_revision,
37
 
        rio,
38
 
        symbol_versioning,
39
 
        transport,
40
 
        tsort,
41
 
        ui,
42
 
        urlutils,
43
 
        )
44
 
from bzrlib.config import BranchConfig, TransportConfig
45
 
from bzrlib.tag import (
46
 
    BasicTags,
47
 
    DisabledTags,
 
27
    bzrdir,
 
28
    controldir,
 
29
    cache_utf8,
 
30
    cleanup,
 
31
    config as _mod_config,
 
32
    debug,
 
33
    errors,
 
34
    fetch,
 
35
    graph as _mod_graph,
 
36
    lockdir,
 
37
    lockable_files,
 
38
    remote,
 
39
    repository,
 
40
    revision as _mod_revision,
 
41
    rio,
 
42
    shelf,
 
43
    tag as _mod_tag,
 
44
    transport,
 
45
    ui,
 
46
    urlutils,
 
47
    vf_search,
48
48
    )
 
49
from bzrlib.i18n import gettext, ngettext
49
50
""")
50
51
 
 
52
# Explicitly import bzrlib.bzrdir so that the BzrProber
 
53
# is guaranteed to be registered.
 
54
import bzrlib.bzrdir
 
55
 
51
56
from bzrlib import (
 
57
    bzrdir,
52
58
    controldir,
53
59
    )
54
60
from bzrlib.decorators import (
67
73
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
68
74
 
69
75
 
70
 
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
71
 
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
72
 
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
73
 
 
74
 
 
75
76
class Branch(controldir.ControlComponent):
76
77
    """Branch holding a history of revisions.
77
78
 
94
95
    def user_transport(self):
95
96
        return self.bzrdir.user_transport
96
97
 
97
 
    def __init__(self, *ignored, **ignored_too):
 
98
    def __init__(self, possible_transports=None):
98
99
        self.tags = self._format.make_tags(self)
99
100
        self._revision_history_cache = None
100
101
        self._revision_id_to_revno_cache = None
104
105
        self._last_revision_info_cache = None
105
106
        self._master_branch_cache = None
106
107
        self._merge_sorted_revisions_cache = None
107
 
        self._open_hook()
 
108
        self._open_hook(possible_transports)
108
109
        hooks = Branch.hooks['open']
109
110
        for hook in hooks:
110
111
            hook(self)
111
112
 
112
 
    def _open_hook(self):
 
113
    def _open_hook(self, possible_transports):
113
114
        """Called by init to allow simpler extension of the base class."""
114
115
 
115
 
    def _activate_fallback_location(self, url):
 
116
    def _activate_fallback_location(self, url, possible_transports):
116
117
        """Activate the branch/repository from url as a fallback repository."""
117
118
        for existing_fallback_repo in self.repository._fallback_repositories:
118
119
            if existing_fallback_repo.user_url == url:
119
120
                # This fallback is already configured.  This probably only
120
 
                # happens because BzrDir.sprout is a horrible mess.  To avoid
 
121
                # happens because ControlDir.sprout is a horrible mess.  To avoid
121
122
                # confusing _unstack we don't add this a second time.
122
123
                mutter('duplicate activation of fallback %r on %r', url, self)
123
124
                return
124
 
        repo = self._get_fallback_repository(url)
 
125
        repo = self._get_fallback_repository(url, possible_transports)
125
126
        if repo.has_same_location(self.repository):
126
127
            raise errors.UnstackableLocationError(self.user_url, url)
127
128
        self.repository.add_fallback_repository(repo)
181
182
        For instance, if the branch is at URL/.bzr/branch,
182
183
        Branch.open(URL) -> a Branch instance.
183
184
        """
184
 
        control = bzrdir.BzrDir.open(base, _unsupported,
185
 
                                     possible_transports=possible_transports)
186
 
        return control.open_branch(unsupported=_unsupported)
 
185
        control = controldir.ControlDir.open(base,
 
186
            possible_transports=possible_transports, _unsupported=_unsupported)
 
187
        return control.open_branch(unsupported=_unsupported,
 
188
            possible_transports=possible_transports)
187
189
 
188
190
    @staticmethod
189
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
191
    def open_from_transport(transport, name=None, _unsupported=False,
 
192
            possible_transports=None):
190
193
        """Open the branch rooted at transport"""
191
 
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
192
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
194
        control = controldir.ControlDir.open_from_transport(transport, _unsupported)
 
195
        return control.open_branch(name=name, unsupported=_unsupported,
 
196
            possible_transports=possible_transports)
193
197
 
194
198
    @staticmethod
195
199
    def open_containing(url, possible_transports=None):
203
207
        format, UnknownFormatError or UnsupportedFormatError are raised.
204
208
        If there is one, it is returned, along with the unused portion of url.
205
209
        """
206
 
        control, relpath = bzrdir.BzrDir.open_containing(url,
 
210
        control, relpath = controldir.ControlDir.open_containing(url,
207
211
                                                         possible_transports)
208
 
        return control.open_branch(), relpath
 
212
        branch = control.open_branch(possible_transports=possible_transports)
 
213
        return (branch, relpath)
209
214
 
210
215
    def _push_should_merge_tags(self):
211
216
        """Should _basic_push merge this branch's tags into the target?
223
228
 
224
229
        :return: A bzrlib.config.BranchConfig.
225
230
        """
226
 
        return BranchConfig(self)
 
231
        return _mod_config.BranchConfig(self)
 
232
 
 
233
    def get_config_stack(self):
 
234
        """Get a bzrlib.config.BranchStack for this Branch.
 
235
 
 
236
        This can then be used to get and set configuration options for the
 
237
        branch.
 
238
 
 
239
        :return: A bzrlib.config.BranchStack.
 
240
        """
 
241
        return _mod_config.BranchStack(self)
227
242
 
228
243
    def _get_config(self):
229
244
        """Get the concrete config for just the config in this branch.
237
252
        """
238
253
        raise NotImplementedError(self._get_config)
239
254
 
240
 
    def _get_fallback_repository(self, url):
 
255
    def store_uncommitted(self, creator):
 
256
        """Store uncommitted changes from a ShelfCreator.
 
257
 
 
258
        :param creator: The ShelfCreator containing uncommitted changes, or
 
259
            None to delete any stored changes.
 
260
        :raises: ChangesAlreadyStored if the branch already has changes.
 
261
        """
 
262
        raise NotImplementedError(self.store_uncommitted)
 
263
 
 
264
    def get_unshelver(self, tree):
 
265
        """Return a shelf.Unshelver for this branch and tree.
 
266
 
 
267
        :param tree: The tree to use to construct the Unshelver.
 
268
        :return: an Unshelver or None if no changes are stored.
 
269
        """
 
270
        raise NotImplementedError(self.get_unshelver)
 
271
 
 
272
    def _get_fallback_repository(self, url, possible_transports):
241
273
        """Get the repository we fallback to at url."""
242
274
        url = urlutils.join(self.base, url)
243
 
        a_branch = Branch.open(url,
244
 
            possible_transports=[self.bzrdir.root_transport])
 
275
        a_branch = Branch.open(url, possible_transports=possible_transports)
245
276
        return a_branch.repository
246
277
 
247
278
    @needs_read_lock
456
487
            after. If None, the rest of history is included.
457
488
        :param stop_rule: if stop_revision_id is not None, the precise rule
458
489
            to use for termination:
 
490
 
459
491
            * 'exclude' - leave the stop revision out of the result (default)
460
492
            * 'include' - the stop revision is the last item in the result
461
493
            * 'with-merges' - include the stop revision and all of its
463
495
            * 'with-merges-without-common-ancestry' - filter out revisions 
464
496
              that are in both ancestries
465
497
        :param direction: either 'reverse' or 'forward':
 
498
 
466
499
            * reverse means return the start_revision_id first, i.e.
467
500
              start at the most recent revision and go backwards in history
468
501
            * forward returns tuples in the opposite order to reverse.
512
545
        rev_iter = iter(merge_sorted_revisions)
513
546
        if start_revision_id is not None:
514
547
            for node in rev_iter:
515
 
                rev_id = node.key[-1]
 
548
                rev_id = node.key
516
549
                if rev_id != start_revision_id:
517
550
                    continue
518
551
                else:
519
552
                    # The decision to include the start or not
520
553
                    # depends on the stop_rule if a stop is provided
521
554
                    # so pop this node back into the iterator
522
 
                    rev_iter = chain(iter([node]), rev_iter)
 
555
                    rev_iter = itertools.chain(iter([node]), rev_iter)
523
556
                    break
524
557
        if stop_revision_id is None:
525
558
            # Yield everything
526
559
            for node in rev_iter:
527
 
                rev_id = node.key[-1]
 
560
                rev_id = node.key
528
561
                yield (rev_id, node.merge_depth, node.revno,
529
562
                       node.end_of_merge)
530
563
        elif stop_rule == 'exclude':
531
564
            for node in rev_iter:
532
 
                rev_id = node.key[-1]
 
565
                rev_id = node.key
533
566
                if rev_id == stop_revision_id:
534
567
                    return
535
568
                yield (rev_id, node.merge_depth, node.revno,
536
569
                       node.end_of_merge)
537
570
        elif stop_rule == 'include':
538
571
            for node in rev_iter:
539
 
                rev_id = node.key[-1]
 
572
                rev_id = node.key
540
573
                yield (rev_id, node.merge_depth, node.revno,
541
574
                       node.end_of_merge)
542
575
                if rev_id == stop_revision_id:
548
581
            ancestors = graph.find_unique_ancestors(start_revision_id,
549
582
                                                    [stop_revision_id])
550
583
            for node in rev_iter:
551
 
                rev_id = node.key[-1]
 
584
                rev_id = node.key
552
585
                if rev_id not in ancestors:
553
586
                    continue
554
587
                yield (rev_id, node.merge_depth, node.revno,
564
597
            reached_stop_revision_id = False
565
598
            revision_id_whitelist = []
566
599
            for node in rev_iter:
567
 
                rev_id = node.key[-1]
 
600
                rev_id = node.key
568
601
                if rev_id == left_parent:
569
602
                    # reached the left parent after the stop_revision
570
603
                    return
650
683
        """
651
684
        raise errors.UpgradeRequired(self.user_url)
652
685
 
 
686
    def get_append_revisions_only(self):
 
687
        """Whether it is only possible to append revisions to the history.
 
688
        """
 
689
        if not self._format.supports_set_append_revisions_only():
 
690
            return False
 
691
        return self.get_config_stack().get('append_revisions_only')
 
692
 
653
693
    def set_append_revisions_only(self, enabled):
654
694
        if not self._format.supports_set_append_revisions_only():
655
695
            raise errors.UpgradeRequired(self.user_url)
656
 
        if enabled:
657
 
            value = 'True'
658
 
        else:
659
 
            value = 'False'
660
 
        self.get_config().set_user_option('append_revisions_only', value,
661
 
            warn_masked=True)
 
696
        self.get_config_stack().set('append_revisions_only', enabled)
662
697
 
663
698
    def set_reference_info(self, file_id, tree_path, branch_location):
664
699
        """Set the branch location to use for a tree reference."""
669
704
        raise errors.UnsupportedOperation(self.get_reference_info, self)
670
705
 
671
706
    @needs_write_lock
672
 
    def fetch(self, from_branch, last_revision=None, fetch_spec=None):
 
707
    def fetch(self, from_branch, last_revision=None, limit=None):
673
708
        """Copy revisions from from_branch into this branch.
674
709
 
675
710
        :param from_branch: Where to copy from.
676
711
        :param last_revision: What revision to stop at (None for at the end
677
712
                              of the branch.
678
 
        :param fetch_spec: If specified, a SearchResult or
679
 
            PendingAncestryResult that describes which revisions to copy.  This
680
 
            allows copying multiple heads at once.  Mutually exclusive with
681
 
            last_revision.
 
713
        :param limit: Optional rough limit of revisions to fetch
682
714
        :return: None
683
715
        """
684
 
        return InterBranch.get(from_branch, self).fetch(last_revision,
685
 
            fetch_spec)
 
716
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
686
717
 
687
718
    def get_bound_location(self):
688
719
        """Return the URL of the branch we are bound to.
697
728
        """
698
729
        raise errors.UpgradeRequired(self.user_url)
699
730
 
700
 
    def get_commit_builder(self, parents, config=None, timestamp=None,
 
731
    def get_commit_builder(self, parents, config_stack=None, timestamp=None,
701
732
                           timezone=None, committer=None, revprops=None,
702
733
                           revision_id=None, lossy=False):
703
734
        """Obtain a CommitBuilder for this branch.
713
744
            represented, when pushing to a foreign VCS 
714
745
        """
715
746
 
716
 
        if config is None:
717
 
            config = self.get_config()
 
747
        if config_stack is None:
 
748
            config_stack = self.get_config_stack()
718
749
 
719
 
        return self.repository.get_commit_builder(self, parents, config,
 
750
        return self.repository.get_commit_builder(self, parents, config_stack,
720
751
            timestamp, timezone, committer, revprops, revision_id,
721
752
            lossy)
722
753
 
727
758
        """
728
759
        return None
729
760
 
 
761
    @deprecated_method(deprecated_in((2, 5, 0)))
730
762
    def get_revision_delta(self, revno):
731
763
        """Return the delta for one revision.
732
764
 
733
765
        The delta is relative to its mainline predecessor, or the
734
766
        empty tree for revision 1.
735
767
        """
736
 
        rh = self.revision_history()
737
 
        if not (1 <= revno <= len(rh)):
 
768
        try:
 
769
            revid = self.get_rev_id(revno)
 
770
        except errors.NoSuchRevision:
738
771
            raise errors.InvalidRevisionNumber(revno)
739
 
        return self.repository.get_revision_delta(rh[revno-1])
 
772
        return self.repository.get_revision_delta(revid)
740
773
 
741
774
    def get_stacked_on_url(self):
742
775
        """Get the URL this branch is stacked against.
751
784
        """Print `file` to stdout."""
752
785
        raise NotImplementedError(self.print_file)
753
786
 
754
 
    def set_revision_history(self, rev_history):
755
 
        raise NotImplementedError(self.set_revision_history)
 
787
    @needs_write_lock
 
788
    def set_last_revision_info(self, revno, revision_id):
 
789
        """Set the last revision of this branch.
 
790
 
 
791
        The caller is responsible for checking that the revno is correct
 
792
        for this revision id.
 
793
 
 
794
        It may be possible to set the branch last revision to an id not
 
795
        present in the repository.  However, branches can also be
 
796
        configured to check constraints on history, in which case this may not
 
797
        be permitted.
 
798
        """
 
799
        raise NotImplementedError(self.set_last_revision_info)
 
800
 
 
801
    @needs_write_lock
 
802
    def generate_revision_history(self, revision_id, last_rev=None,
 
803
                                  other_branch=None):
 
804
        """See Branch.generate_revision_history"""
 
805
        graph = self.repository.get_graph()
 
806
        (last_revno, last_revid) = self.last_revision_info()
 
807
        known_revision_ids = [
 
808
            (last_revid, last_revno),
 
809
            (_mod_revision.NULL_REVISION, 0),
 
810
            ]
 
811
        if last_rev is not None:
 
812
            if not graph.is_ancestor(last_rev, revision_id):
 
813
                # our previous tip is not merged into stop_revision
 
814
                raise errors.DivergedBranches(self, other_branch)
 
815
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
 
816
        self.set_last_revision_info(revno, revision_id)
756
817
 
757
818
    @needs_write_lock
758
819
    def set_parent(self, url):
795
856
                return
796
857
            self._unstack()
797
858
        else:
798
 
            self._activate_fallback_location(url)
 
859
            self._activate_fallback_location(url,
 
860
                possible_transports=[self.bzrdir.root_transport])
799
861
        # write this out after the repository is stacked to avoid setting a
800
862
        # stacked config that doesn't work.
801
863
        self._set_config_location('stacked_on_location', url)
807
869
        """
808
870
        pb = ui.ui_factory.nested_progress_bar()
809
871
        try:
810
 
            pb.update("Unstacking")
 
872
            pb.update(gettext("Unstacking"))
811
873
            # The basic approach here is to fetch the tip of the branch,
812
874
            # including all available ghosts, from the existing stacked
813
875
            # repository into a new repository object without the fallbacks. 
827
889
            # stream from one of them to the other.  This does mean doing
828
890
            # separate SSH connection setup, but unstacking is not a
829
891
            # common operation so it's tolerable.
830
 
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
892
            new_bzrdir = controldir.ControlDir.open(
 
893
                self.bzrdir.root_transport.base)
831
894
            new_repository = new_bzrdir.find_repository()
832
895
            if new_repository._fallback_repositories:
833
896
                raise AssertionError("didn't expect %r to have "
876
939
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
877
940
                except errors.TagsNotSupported:
878
941
                    tags_to_fetch = set()
879
 
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
942
                fetch_spec = vf_search.NotInOtherForRevs(self.repository,
880
943
                    old_repository, required_ids=[self.last_revision()],
881
944
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
882
945
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
890
953
 
891
954
        :seealso: Branch._get_tags_bytes.
892
955
        """
893
 
        return _run_with_write_locked_target(self, self._set_tags_bytes_locked,
894
 
                bytes)
 
956
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
 
957
        op.add_cleanup(self.lock_write().unlock)
 
958
        return op.run_simple(bytes)
895
959
 
896
960
    def _set_tags_bytes_locked(self, bytes):
897
961
        self._tags_bytes = bytes
922
986
        This means the next call to revision_history will need to call
923
987
        _gen_revision_history.
924
988
 
925
 
        This API is semi-public; it only for use by subclasses, all other code
926
 
        should consider it to be private.
 
989
        This API is semi-public; it is only for use by subclasses, all other
 
990
        code should consider it to be private.
927
991
        """
928
992
        self._revision_history_cache = None
929
993
        self._revision_id_to_revno_cache = None
949
1013
        """
950
1014
        raise NotImplementedError(self._gen_revision_history)
951
1015
 
952
 
    @needs_read_lock
953
 
    def revision_history(self):
954
 
        """Return sequence of revision ids on this branch.
955
 
 
956
 
        This method will cache the revision history for as long as it is safe to
957
 
        do so.
958
 
        """
 
1016
    def _revision_history(self):
959
1017
        if 'evil' in debug.debug_flags:
960
1018
            mutter_callsite(3, "revision_history scales with history.")
961
1019
        if self._revision_history_cache is not None:
988
1046
        :return: A tuple (revno, revision_id).
989
1047
        """
990
1048
        if self._last_revision_info_cache is None:
991
 
            self._last_revision_info_cache = self._last_revision_info()
 
1049
            self._last_revision_info_cache = self._read_last_revision_info()
992
1050
        return self._last_revision_info_cache
993
1051
 
994
 
    def _last_revision_info(self):
995
 
        rh = self.revision_history()
996
 
        revno = len(rh)
997
 
        if revno:
998
 
            return (revno, rh[-1])
999
 
        else:
1000
 
            return (0, _mod_revision.NULL_REVISION)
1001
 
 
1002
 
    def update_revisions(self, other, stop_revision=None, overwrite=False,
1003
 
                         graph=None, fetch_tags=True):
1004
 
        """Pull in new perfect-fit revisions.
1005
 
 
1006
 
        :param other: Another Branch to pull from
1007
 
        :param stop_revision: Updated until the given revision
1008
 
        :param overwrite: Always set the branch pointer, rather than checking
1009
 
            to see if it is a proper descendant.
1010
 
        :param graph: A Graph object that can be used to query history
1011
 
            information. This can be None.
1012
 
        :param fetch_tags: Flag that specifies if tags from other should be
1013
 
            fetched too.
1014
 
        :return: None
1015
 
        """
1016
 
        return InterBranch.get(other, self).update_revisions(stop_revision,
1017
 
            overwrite, graph, fetch_tags=fetch_tags)
1018
 
 
1019
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1020
 
    def import_last_revision_info(self, source_repo, revno, revid):
1021
 
        """Set the last revision info, importing from another repo if necessary.
1022
 
 
1023
 
        :param source_repo: Source repository to optionally fetch from
1024
 
        :param revno: Revision number of the new tip
1025
 
        :param revid: Revision id of the new tip
1026
 
        """
1027
 
        if not self.repository.has_same_location(source_repo):
1028
 
            self.repository.fetch(source_repo, revision_id=revid)
1029
 
        self.set_last_revision_info(revno, revid)
 
1052
    def _read_last_revision_info(self):
 
1053
        raise NotImplementedError(self._read_last_revision_info)
1030
1054
 
1031
1055
    def import_last_revision_info_and_tags(self, source, revno, revid,
1032
1056
                                           lossy=False):
1045
1069
            (should only be different from the arguments when lossy=True)
1046
1070
        """
1047
1071
        if not self.repository.has_same_location(source.repository):
1048
 
            try:
1049
 
                tags_to_fetch = set(source.tags.get_reverse_tag_dict())
1050
 
            except errors.TagsNotSupported:
1051
 
                tags_to_fetch = set()
1052
 
            fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
1053
 
                source.repository, [revid],
1054
 
                if_present_ids=tags_to_fetch).execute()
1055
 
            self.repository.fetch(source.repository, fetch_spec=fetch_spec)
 
1072
            self.fetch(source, revid)
1056
1073
        self.set_last_revision_info(revno, revid)
1057
1074
        return (revno, revid)
1058
1075
 
1060
1077
        """Given a revision id, return its revno"""
1061
1078
        if _mod_revision.is_null(revision_id):
1062
1079
            return 0
1063
 
        history = self.revision_history()
 
1080
        history = self._revision_history()
1064
1081
        try:
1065
1082
            return history.index(revision_id) + 1
1066
1083
        except ValueError:
1093
1110
            stop_revision=stop_revision,
1094
1111
            possible_transports=possible_transports, *args, **kwargs)
1095
1112
 
1096
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1097
 
        **kwargs):
 
1113
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
 
1114
            *args, **kwargs):
1098
1115
        """Mirror this branch into target.
1099
1116
 
1100
1117
        This branch is considered to be 'local', having low latency.
1101
1118
        """
1102
1119
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1103
 
            *args, **kwargs)
1104
 
 
1105
 
    def lossy_push(self, target, stop_revision=None):
1106
 
        """Push deltas into another branch.
1107
 
 
1108
 
        :note: This does not, like push, retain the revision ids from 
1109
 
            the source branch and will, rather than adding bzr-specific 
1110
 
            metadata, push only those semantics of the revision that can be 
1111
 
            natively represented by this branch' VCS.
1112
 
 
1113
 
        :param target: Target branch
1114
 
        :param stop_revision: Revision to push, defaults to last revision.
1115
 
        :return: BranchPushResult with an extra member revidmap: 
1116
 
            A dictionary mapping revision ids from the target branch 
1117
 
            to new revision ids in the target branch, for each 
1118
 
            revision that was pushed.
1119
 
        """
1120
 
        inter = InterBranch.get(self, target)
1121
 
        lossy_push = getattr(inter, "lossy_push", None)
1122
 
        if lossy_push is None:
1123
 
            raise errors.LossyPushToSameVCS(self, target)
1124
 
        return lossy_push(stop_revision)
 
1120
            lossy, *args, **kwargs)
1125
1121
 
1126
1122
    def basis_tree(self):
1127
1123
        """Return `Tree` object for last revision."""
1152
1148
    def _set_config_location(self, name, url, config=None,
1153
1149
                             make_relative=False):
1154
1150
        if config is None:
1155
 
            config = self.get_config()
 
1151
            config = self.get_config_stack()
1156
1152
        if url is None:
1157
1153
            url = ''
1158
1154
        elif make_relative:
1159
1155
            url = urlutils.relative_url(self.base, url)
1160
 
        config.set_user_option(name, url, warn_masked=True)
 
1156
        config.set(name, url)
1161
1157
 
1162
1158
    def _get_config_location(self, name, config=None):
1163
1159
        if config is None:
1164
 
            config = self.get_config()
1165
 
        location = config.get_user_option(name)
 
1160
            config = self.get_config_stack()
 
1161
        location = config.get(name)
1166
1162
        if location == '':
1167
1163
            location = None
1168
1164
        return location
1169
1165
 
1170
1166
    def get_child_submit_format(self):
1171
1167
        """Return the preferred format of submissions to this branch."""
1172
 
        return self.get_config().get_user_option("child_submit_format")
 
1168
        return self.get_config_stack().get('child_submit_format')
1173
1169
 
1174
1170
    def get_submit_branch(self):
1175
1171
        """Return the submit location of the branch.
1178
1174
        pattern is that the user can override it by specifying a
1179
1175
        location.
1180
1176
        """
1181
 
        return self.get_config().get_user_option('submit_branch')
 
1177
        return self.get_config_stack().get('submit_branch')
1182
1178
 
1183
1179
    def set_submit_branch(self, location):
1184
1180
        """Return the submit location of the branch.
1187
1183
        pattern is that the user can override it by specifying a
1188
1184
        location.
1189
1185
        """
1190
 
        self.get_config().set_user_option('submit_branch', location,
1191
 
            warn_masked=True)
 
1186
        self.get_config_stack().set('submit_branch', location)
1192
1187
 
1193
1188
    def get_public_branch(self):
1194
1189
        """Return the public location of the branch.
1207
1202
        self._set_config_location('public_branch', location)
1208
1203
 
1209
1204
    def get_push_location(self):
1210
 
        """Return the None or the location to push this branch to."""
1211
 
        push_loc = self.get_config().get_user_option('push_location')
1212
 
        return push_loc
 
1205
        """Return None or the location to push this branch to."""
 
1206
        return self.get_config_stack().get('push_location')
1213
1207
 
1214
1208
    def set_push_location(self, location):
1215
1209
        """Set a new push location for this branch."""
1300
1294
            if repository_policy is not None:
1301
1295
                repository_policy.configure_branch(result)
1302
1296
            self.copy_content_into(result, revision_id=revision_id)
1303
 
            result.set_parent(self.bzrdir.root_transport.base)
 
1297
            master_url = self.get_bound_location()
 
1298
            if master_url is None:
 
1299
                result.set_parent(self.bzrdir.root_transport.base)
 
1300
            else:
 
1301
                result.set_parent(master_url)
1304
1302
        finally:
1305
1303
            result.unlock()
1306
1304
        return result
1380
1378
        # TODO: We should probably also check that self.revision_history
1381
1379
        # matches the repository for older branch formats.
1382
1380
        # If looking for the code that cross-checks repository parents against
1383
 
        # the iter_reverse_revision_history output, that is now a repository
 
1381
        # the Graph.iter_lefthand_ancestry output, that is now a repository
1384
1382
        # specific check.
1385
1383
        return result
1386
1384
 
1387
 
    def _get_checkout_format(self):
 
1385
    def _get_checkout_format(self, lightweight=False):
1388
1386
        """Return the most suitable metadir for a checkout of this branch.
1389
1387
        Weaves are used if this branch's repository uses weaves.
1390
1388
        """
1425
1423
        :param to_location: The url to produce the checkout at
1426
1424
        :param revision_id: The revision to check out
1427
1425
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1428
 
        produce a bound branch (heavyweight checkout)
 
1426
            produce a bound branch (heavyweight checkout)
1429
1427
        :param accelerator_tree: A tree which can be used for retrieving file
1430
1428
            contents more quickly than the revision tree, i.e. a workingtree.
1431
1429
            The revision tree will be used for cases where accelerator_tree's
1436
1434
        """
1437
1435
        t = transport.get_transport(to_location)
1438
1436
        t.ensure_base()
 
1437
        format = self._get_checkout_format(lightweight=lightweight)
 
1438
        try:
 
1439
            checkout = format.initialize_on_transport(t)
 
1440
        except errors.AlreadyControlDirError:
 
1441
            # It's fine if the control directory already exists,
 
1442
            # as long as there is no existing branch and working tree.
 
1443
            checkout = controldir.ControlDir.open_from_transport(t)
 
1444
            try:
 
1445
                checkout.open_branch()
 
1446
            except errors.NotBranchError:
 
1447
                pass
 
1448
            else:
 
1449
                raise errors.AlreadyControlDirError(t.base)
 
1450
            if checkout.control_transport.base == self.bzrdir.control_transport.base:
 
1451
                # When checking out to the same control directory,
 
1452
                # always create a lightweight checkout
 
1453
                lightweight = True
 
1454
 
1439
1455
        if lightweight:
1440
 
            format = self._get_checkout_format()
1441
 
            checkout = format.initialize_on_transport(t)
1442
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1443
 
                target_branch=self)
 
1456
            from_branch = checkout.set_branch_reference(target_branch=self)
1444
1457
        else:
1445
 
            format = self._get_checkout_format()
1446
 
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1447
 
                to_location, force_new_tree=False, format=format)
1448
 
            checkout = checkout_branch.bzrdir
 
1458
            policy = checkout.determine_repository_policy()
 
1459
            repo = policy.acquire_repository()[0]
 
1460
            checkout_branch = checkout.create_branch()
1449
1461
            checkout_branch.bind(self)
1450
1462
            # pull up to the specified revision_id to set the initial
1451
1463
            # branch tip correctly, and seed it with history.
1452
1464
            checkout_branch.pull(self, stop_revision=revision_id)
1453
 
            from_branch=None
 
1465
            from_branch = None
1454
1466
        tree = checkout.create_workingtree(revision_id,
1455
1467
                                           from_branch=from_branch,
1456
1468
                                           accelerator_tree=accelerator_tree,
1477
1489
 
1478
1490
    def reference_parent(self, file_id, path, possible_transports=None):
1479
1491
        """Return the parent branch for a tree-reference file_id
 
1492
 
1480
1493
        :param file_id: The file_id of the tree reference
1481
1494
        :param path: The path of the file_id in the tree
1482
1495
        :return: A branch associated with the file_id
1544
1557
            heads that must be fetched if present, but no error is necessary if
1545
1558
            they are not present.
1546
1559
        """
1547
 
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
1548
 
        # are the tags.
 
1560
        # For bzr native formats must_fetch is just the tip, and
 
1561
        # if_present_fetch are the tags.
1549
1562
        must_fetch = set([self.last_revision()])
1550
 
        try:
1551
 
            if_present_fetch = set(self.tags.get_reverse_tag_dict())
1552
 
        except errors.TagsNotSupported:
1553
 
            if_present_fetch = set()
 
1563
        if_present_fetch = set()
 
1564
        if self.get_config_stack().get('branch.fetch_tags'):
 
1565
            try:
 
1566
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1567
            except errors.TagsNotSupported:
 
1568
                pass
1554
1569
        must_fetch.discard(_mod_revision.NULL_REVISION)
1555
1570
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
1556
1571
        return must_fetch, if_present_fetch
1561
1576
 
1562
1577
    Formats provide three things:
1563
1578
     * An initialization routine,
1564
 
     * a format string,
 
1579
     * a format description
1565
1580
     * an open routine.
1566
1581
 
1567
1582
    Formats are placed in an dict by their format string for reference
1574
1589
    object will be created every time regardless.
1575
1590
    """
1576
1591
 
1577
 
    can_set_append_revisions_only = True
1578
 
 
1579
1592
    def __eq__(self, other):
1580
1593
        return self.__class__ is other.__class__
1581
1594
 
1582
1595
    def __ne__(self, other):
1583
1596
        return not (self == other)
1584
1597
 
1585
 
    @classmethod
1586
 
    def find_format(klass, a_bzrdir, name=None):
1587
 
        """Return the format for the branch object in a_bzrdir."""
1588
 
        try:
1589
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1590
 
            format_string = transport.get_bytes("format")
1591
 
            return format_registry.get(format_string)
1592
 
        except errors.NoSuchFile:
1593
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1594
 
        except KeyError:
1595
 
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1596
 
 
1597
 
    @classmethod
1598
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1599
 
    def get_default_format(klass):
1600
 
        """Return the current default format."""
1601
 
        return format_registry.get_default()
1602
 
 
1603
 
    @classmethod
1604
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1605
 
    def get_formats(klass):
1606
 
        """Get all the known formats.
1607
 
 
1608
 
        Warning: This triggers a load of all lazy registered formats: do not
1609
 
        use except when that is desireed.
1610
 
        """
1611
 
        return format_registry._get_all()
1612
 
 
1613
 
    def get_reference(self, a_bzrdir, name=None):
1614
 
        """Get the target reference of the branch in a_bzrdir.
 
1598
    def get_reference(self, controldir, name=None):
 
1599
        """Get the target reference of the branch in controldir.
1615
1600
 
1616
1601
        format probing must have been completed before calling
1617
1602
        this method - it is assumed that the format of the branch
1618
 
        in a_bzrdir is correct.
 
1603
        in controldir is correct.
1619
1604
 
1620
 
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1605
        :param controldir: The controldir to get the branch data from.
1621
1606
        :param name: Name of the colocated branch to fetch
1622
1607
        :return: None if the branch is not a reference branch.
1623
1608
        """
1624
1609
        return None
1625
1610
 
1626
1611
    @classmethod
1627
 
    def set_reference(self, a_bzrdir, name, to_branch):
1628
 
        """Set the target reference of the branch in a_bzrdir.
 
1612
    def set_reference(self, controldir, name, to_branch):
 
1613
        """Set the target reference of the branch in controldir.
1629
1614
 
1630
1615
        format probing must have been completed before calling
1631
1616
        this method - it is assumed that the format of the branch
1632
 
        in a_bzrdir is correct.
 
1617
        in controldir is correct.
1633
1618
 
1634
 
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1619
        :param controldir: The controldir to set the branch reference for.
1635
1620
        :param name: Name of colocated branch to set, None for default
1636
1621
        :param to_branch: branch that the checkout is to reference
1637
1622
        """
1638
1623
        raise NotImplementedError(self.set_reference)
1639
1624
 
1640
 
    def get_format_string(self):
1641
 
        """Return the ASCII format string that identifies this format."""
1642
 
        raise NotImplementedError(self.get_format_string)
1643
 
 
1644
1625
    def get_format_description(self):
1645
1626
        """Return the short format description for this format."""
1646
1627
        raise NotImplementedError(self.get_format_description)
1647
1628
 
1648
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
 
1629
    def _run_post_branch_init_hooks(self, controldir, name, branch):
1649
1630
        hooks = Branch.hooks['post_branch_init']
1650
1631
        if not hooks:
1651
1632
            return
1652
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
 
1633
        params = BranchInitHookParams(self, controldir, name, branch)
1653
1634
        for hook in hooks:
1654
1635
            hook(params)
1655
1636
 
1656
 
    def initialize(self, a_bzrdir, name=None, repository=None):
1657
 
        """Create a branch of this format in a_bzrdir.
1658
 
        
 
1637
    def initialize(self, controldir, name=None, repository=None,
 
1638
                   append_revisions_only=None):
 
1639
        """Create a branch of this format in controldir.
 
1640
 
1659
1641
        :param name: Name of the colocated branch to create.
1660
1642
        """
1661
1643
        raise NotImplementedError(self.initialize)
1681
1663
        Note that it is normal for branch to be a RemoteBranch when using tags
1682
1664
        on a RemoteBranch.
1683
1665
        """
1684
 
        return DisabledTags(branch)
 
1666
        return _mod_tag.DisabledTags(branch)
1685
1667
 
1686
1668
    def network_name(self):
1687
1669
        """A simple byte string uniquely identifying this format for RPC calls.
1693
1675
        """
1694
1676
        raise NotImplementedError(self.network_name)
1695
1677
 
1696
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1697
 
            found_repository=None):
1698
 
        """Return the branch object for a_bzrdir
 
1678
    def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
 
1679
            found_repository=None, possible_transports=None):
 
1680
        """Return the branch object for controldir.
1699
1681
 
1700
 
        :param a_bzrdir: A BzrDir that contains a branch.
 
1682
        :param controldir: A ControlDir that contains a branch.
1701
1683
        :param name: Name of colocated branch to open
1702
1684
        :param _found: a private parameter, do not use it. It is used to
1703
1685
            indicate if format probing has already be done.
1706
1688
        """
1707
1689
        raise NotImplementedError(self.open)
1708
1690
 
1709
 
    @classmethod
1710
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1711
 
    def register_format(klass, format):
1712
 
        """Register a metadir format.
1713
 
 
1714
 
        See MetaDirBranchFormatFactory for the ability to register a format
1715
 
        without loading the code the format needs until it is actually used.
1716
 
        """
1717
 
        format_registry.register(format)
1718
 
 
1719
 
    @classmethod
1720
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1721
 
    def set_default_format(klass, format):
1722
 
        format_registry.set_default(format)
1723
 
 
1724
1691
    def supports_set_append_revisions_only(self):
1725
1692
        """True if this format supports set_append_revisions_only."""
1726
1693
        return False
1733
1700
        """True if this format supports leaving locks in place."""
1734
1701
        return False # by default
1735
1702
 
1736
 
    @classmethod
1737
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1738
 
    def unregister_format(klass, format):
1739
 
        format_registry.remove(format)
1740
 
 
1741
1703
    def __str__(self):
1742
1704
        return self.get_format_description().rstrip()
1743
1705
 
1745
1707
        """True if this format supports tags stored in the branch"""
1746
1708
        return False  # by default
1747
1709
 
 
1710
    def tags_are_versioned(self):
 
1711
        """Whether the tag container for this branch versions tags."""
 
1712
        return False
 
1713
 
 
1714
    def supports_tags_referencing_ghosts(self):
 
1715
        """True if tags can reference ghost revisions."""
 
1716
        return True
 
1717
 
1748
1718
 
1749
1719
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1750
1720
    """A factory for a BranchFormat object, permitting simple lazy registration.
1764
1734
        """
1765
1735
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
1766
1736
        self._format_string = format_string
1767
 
        
 
1737
 
1768
1738
    def get_format_string(self):
1769
1739
        """See BranchFormat.get_format_string."""
1770
1740
        return self._format_string
1777
1747
class BranchHooks(Hooks):
1778
1748
    """A dictionary mapping hook name to a list of callables for branch hooks.
1779
1749
 
1780
 
    e.g. ['set_rh'] Is the list of items to be called when the
1781
 
    set_revision_history function is invoked.
 
1750
    e.g. ['post_push'] Is the list of items to be called when the
 
1751
    push function is invoked.
1782
1752
    """
1783
1753
 
1784
1754
    def __init__(self):
1788
1758
        notified.
1789
1759
        """
1790
1760
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1791
 
        self.add_hook('set_rh',
1792
 
            "Invoked whenever the revision history has been set via "
1793
 
            "set_revision_history. The api signature is (branch, "
1794
 
            "revision_history), and the branch will be write-locked. "
1795
 
            "The set_rh hook can be expensive for bzr to trigger, a better "
1796
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
1797
1761
        self.add_hook('open',
1798
1762
            "Called with the Branch object that has been opened after a "
1799
1763
            "branch is opened.", (1, 8))
1872
1836
 
1873
1837
 
1874
1838
class ChangeBranchTipParams(object):
1875
 
    """Object holding parameters passed to *_change_branch_tip hooks.
 
1839
    """Object holding parameters passed to `*_change_branch_tip` hooks.
1876
1840
 
1877
1841
    There are 5 fields that hooks may wish to access:
1878
1842
 
1910
1874
 
1911
1875
 
1912
1876
class BranchInitHookParams(object):
1913
 
    """Object holding parameters passed to *_branch_init hooks.
 
1877
    """Object holding parameters passed to `*_branch_init` hooks.
1914
1878
 
1915
1879
    There are 4 fields that hooks may wish to access:
1916
1880
 
1917
1881
    :ivar format: the branch format
1918
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
 
1882
    :ivar bzrdir: the ControlDir where the branch will be/has been initialized
1919
1883
    :ivar name: name of colocated branch, if any (or None)
1920
1884
    :ivar branch: the branch created
1921
1885
 
1924
1888
    branch, which refer to the original branch.
1925
1889
    """
1926
1890
 
1927
 
    def __init__(self, format, a_bzrdir, name, branch):
 
1891
    def __init__(self, format, controldir, name, branch):
1928
1892
        """Create a group of BranchInitHook parameters.
1929
1893
 
1930
1894
        :param format: the branch format
1931
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
 
1895
        :param controldir: the ControlDir where the branch will be/has been
1932
1896
            initialized
1933
1897
        :param name: name of colocated branch, if any (or None)
1934
1898
        :param branch: the branch created
1938
1902
        in branch, which refer to the original branch.
1939
1903
        """
1940
1904
        self.format = format
1941
 
        self.bzrdir = a_bzrdir
 
1905
        self.bzrdir = controldir
1942
1906
        self.name = name
1943
1907
        self.branch = branch
1944
1908
 
1950
1914
 
1951
1915
 
1952
1916
class SwitchHookParams(object):
1953
 
    """Object holding parameters passed to *_switch hooks.
 
1917
    """Object holding parameters passed to `*_switch` hooks.
1954
1918
 
1955
1919
    There are 4 fields that hooks may wish to access:
1956
1920
 
1957
 
    :ivar control_dir: BzrDir of the checkout to change
 
1921
    :ivar control_dir: ControlDir of the checkout to change
1958
1922
    :ivar to_branch: branch that the checkout is to reference
1959
1923
    :ivar force: skip the check for local commits in a heavy checkout
1960
1924
    :ivar revision_id: revision ID to switch to (or None)
1963
1927
    def __init__(self, control_dir, to_branch, force, revision_id):
1964
1928
        """Create a group of SwitchHook parameters.
1965
1929
 
1966
 
        :param control_dir: BzrDir of the checkout to change
 
1930
        :param control_dir: ControlDir of the checkout to change
1967
1931
        :param to_branch: branch that the checkout is to reference
1968
1932
        :param force: skip the check for local commits in a heavy checkout
1969
1933
        :param revision_id: revision ID to switch to (or None)
1982
1946
            self.revision_id)
1983
1947
 
1984
1948
 
1985
 
class BranchFormatMetadir(BranchFormat):
1986
 
    """Common logic for meta-dir based branch formats."""
 
1949
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
 
1950
    """Base class for branch formats that live in meta directories.
 
1951
    """
 
1952
 
 
1953
    def __init__(self):
 
1954
        BranchFormat.__init__(self)
 
1955
        bzrdir.BzrFormat.__init__(self)
 
1956
 
 
1957
    @classmethod
 
1958
    def find_format(klass, controldir, name=None):
 
1959
        """Return the format for the branch object in controldir."""
 
1960
        try:
 
1961
            transport = controldir.get_branch_transport(None, name=name)
 
1962
        except errors.NoSuchFile:
 
1963
            raise errors.NotBranchError(path=name, bzrdir=controldir)
 
1964
        try:
 
1965
            format_string = transport.get_bytes("format")
 
1966
        except errors.NoSuchFile:
 
1967
            raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
 
1968
        return klass._find_format(format_registry, 'branch', format_string)
1987
1969
 
1988
1970
    def _branch_class(self):
1989
1971
        """What class to instantiate on open calls."""
1990
1972
        raise NotImplementedError(self._branch_class)
1991
1973
 
 
1974
    def _get_initial_config(self, append_revisions_only=None):
 
1975
        if append_revisions_only:
 
1976
            return "append_revisions_only = True\n"
 
1977
        else:
 
1978
            # Avoid writing anything if append_revisions_only is disabled,
 
1979
            # as that is the default.
 
1980
            return ""
 
1981
 
1992
1982
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1993
1983
                           repository=None):
1994
 
        """Initialize a branch in a bzrdir, with specified files
 
1984
        """Initialize a branch in a control dir, with specified files
1995
1985
 
1996
1986
        :param a_bzrdir: The bzrdir to initialize the branch in
1997
1987
        :param utf8_files: The files to create as a list of
1999
1989
        :param name: Name of colocated branch to create, if any
2000
1990
        :return: a branch in this format
2001
1991
        """
 
1992
        if name is None:
 
1993
            name = a_bzrdir._get_selected_branch()
2002
1994
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2003
1995
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2004
1996
        control_files = lockable_files.LockableFiles(branch_transport,
2006
1998
        control_files.create_lock()
2007
1999
        control_files.lock_write()
2008
2000
        try:
2009
 
            utf8_files += [('format', self.get_format_string())]
 
2001
            utf8_files += [('format', self.as_string())]
2010
2002
            for (filename, content) in utf8_files:
2011
2003
                branch_transport.put_bytes(
2012
2004
                    filename, content,
2018
2010
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2019
2011
        return branch
2020
2012
 
2021
 
    def network_name(self):
2022
 
        """A simple byte string uniquely identifying this format for RPC calls.
2023
 
 
2024
 
        Metadir branch formats use their format string.
2025
 
        """
2026
 
        return self.get_format_string()
2027
 
 
2028
2013
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2029
 
            found_repository=None):
 
2014
            found_repository=None, possible_transports=None):
2030
2015
        """See BranchFormat.open()."""
 
2016
        if name is None:
 
2017
            name = a_bzrdir._get_selected_branch()
2031
2018
        if not _found:
2032
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2019
            format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2033
2020
            if format.__class__ != self.__class__:
2034
2021
                raise AssertionError("wrong format %r found for %r" %
2035
2022
                    (format, self))
2044
2031
                              name=name,
2045
2032
                              a_bzrdir=a_bzrdir,
2046
2033
                              _repository=found_repository,
2047
 
                              ignore_fallbacks=ignore_fallbacks)
 
2034
                              ignore_fallbacks=ignore_fallbacks,
 
2035
                              possible_transports=possible_transports)
2048
2036
        except errors.NoSuchFile:
2049
2037
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2050
2038
 
2051
 
    def __init__(self):
2052
 
        super(BranchFormatMetadir, self).__init__()
2053
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2054
 
        self._matchingbzrdir.set_branch_format(self)
 
2039
    @property
 
2040
    def _matchingbzrdir(self):
 
2041
        ret = bzrdir.BzrDirMetaFormat1()
 
2042
        ret.set_branch_format(self)
 
2043
        return ret
2055
2044
 
2056
2045
    def supports_tags(self):
2057
2046
        return True
2059
2048
    def supports_leaving_lock(self):
2060
2049
        return True
2061
2050
 
2062
 
 
2063
 
class BzrBranchFormat5(BranchFormatMetadir):
2064
 
    """Bzr branch format 5.
2065
 
 
2066
 
    This format has:
2067
 
     - a revision-history file.
2068
 
     - a format string
2069
 
     - a lock dir guarding the branch itself
2070
 
     - all of this stored in a branch/ subdirectory
2071
 
     - works with shared repositories.
2072
 
 
2073
 
    This format is new in bzr 0.8.
2074
 
    """
2075
 
 
2076
 
    def _branch_class(self):
2077
 
        return BzrBranch5
2078
 
 
2079
 
    def get_format_string(self):
2080
 
        """See BranchFormat.get_format_string()."""
2081
 
        return "Bazaar-NG branch format 5\n"
2082
 
 
2083
 
    def get_format_description(self):
2084
 
        """See BranchFormat.get_format_description()."""
2085
 
        return "Branch format 5"
2086
 
 
2087
 
    def initialize(self, a_bzrdir, name=None, repository=None):
2088
 
        """Create a branch of this format in a_bzrdir."""
2089
 
        utf8_files = [('revision-history', ''),
2090
 
                      ('branch-name', ''),
2091
 
                      ]
2092
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2093
 
 
2094
 
    def supports_tags(self):
2095
 
        return False
 
2051
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
2052
            basedir=None):
 
2053
        BranchFormat.check_support_status(self,
 
2054
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
2055
            basedir=basedir)
 
2056
        bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
2057
            recommend_upgrade=recommend_upgrade, basedir=basedir)
2096
2058
 
2097
2059
 
2098
2060
class BzrBranchFormat6(BranchFormatMetadir):
2109
2071
    def _branch_class(self):
2110
2072
        return BzrBranch6
2111
2073
 
2112
 
    def get_format_string(self):
 
2074
    @classmethod
 
2075
    def get_format_string(cls):
2113
2076
        """See BranchFormat.get_format_string()."""
2114
2077
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
2115
2078
 
2117
2080
        """See BranchFormat.get_format_description()."""
2118
2081
        return "Branch format 6"
2119
2082
 
2120
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2083
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2084
                   append_revisions_only=None):
2121
2085
        """Create a branch of this format in a_bzrdir."""
2122
2086
        utf8_files = [('last-revision', '0 null:\n'),
2123
 
                      ('branch.conf', ''),
 
2087
                      ('branch.conf',
 
2088
                          self._get_initial_config(append_revisions_only)),
2124
2089
                      ('tags', ''),
2125
2090
                      ]
2126
2091
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2127
2092
 
2128
2093
    def make_tags(self, branch):
2129
2094
        """See bzrlib.branch.BranchFormat.make_tags()."""
2130
 
        return BasicTags(branch)
 
2095
        return _mod_tag.BasicTags(branch)
2131
2096
 
2132
2097
    def supports_set_append_revisions_only(self):
2133
2098
        return True
2139
2104
    def _branch_class(self):
2140
2105
        return BzrBranch8
2141
2106
 
2142
 
    def get_format_string(self):
 
2107
    @classmethod
 
2108
    def get_format_string(cls):
2143
2109
        """See BranchFormat.get_format_string()."""
2144
2110
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2145
2111
 
2147
2113
        """See BranchFormat.get_format_description()."""
2148
2114
        return "Branch format 8"
2149
2115
 
2150
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2116
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2117
                   append_revisions_only=None):
2151
2118
        """Create a branch of this format in a_bzrdir."""
2152
2119
        utf8_files = [('last-revision', '0 null:\n'),
2153
 
                      ('branch.conf', ''),
 
2120
                      ('branch.conf',
 
2121
                          self._get_initial_config(append_revisions_only)),
2154
2122
                      ('tags', ''),
2155
2123
                      ('references', '')
2156
2124
                      ]
2158
2126
 
2159
2127
    def make_tags(self, branch):
2160
2128
        """See bzrlib.branch.BranchFormat.make_tags()."""
2161
 
        return BasicTags(branch)
 
2129
        return _mod_tag.BasicTags(branch)
2162
2130
 
2163
2131
    def supports_set_append_revisions_only(self):
2164
2132
        return True
2178
2146
    This format was introduced in bzr 1.6.
2179
2147
    """
2180
2148
 
2181
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2149
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2150
                   append_revisions_only=None):
2182
2151
        """Create a branch of this format in a_bzrdir."""
2183
2152
        utf8_files = [('last-revision', '0 null:\n'),
2184
 
                      ('branch.conf', ''),
 
2153
                      ('branch.conf',
 
2154
                          self._get_initial_config(append_revisions_only)),
2185
2155
                      ('tags', ''),
2186
2156
                      ]
2187
2157
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2189
2159
    def _branch_class(self):
2190
2160
        return BzrBranch7
2191
2161
 
2192
 
    def get_format_string(self):
 
2162
    @classmethod
 
2163
    def get_format_string(cls):
2193
2164
        """See BranchFormat.get_format_string()."""
2194
2165
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2195
2166
 
2205
2176
 
2206
2177
    def make_tags(self, branch):
2207
2178
        """See bzrlib.branch.BranchFormat.make_tags()."""
2208
 
        return BasicTags(branch)
 
2179
        return _mod_tag.BasicTags(branch)
2209
2180
 
2210
2181
    supports_reference_locations = False
2211
2182
 
2212
2183
 
2213
 
class BranchReferenceFormat(BranchFormat):
 
2184
class BranchReferenceFormat(BranchFormatMetadir):
2214
2185
    """Bzr branch reference format.
2215
2186
 
2216
2187
    Branch references are used in implementing checkouts, they
2221
2192
     - a format string
2222
2193
    """
2223
2194
 
2224
 
    def get_format_string(self):
 
2195
    @classmethod
 
2196
    def get_format_string(cls):
2225
2197
        """See BranchFormat.get_format_string()."""
2226
2198
        return "Bazaar-NG Branch Reference Format 1\n"
2227
2199
 
2240
2212
        location = transport.put_bytes('location', to_branch.base)
2241
2213
 
2242
2214
    def initialize(self, a_bzrdir, name=None, target_branch=None,
2243
 
            repository=None):
 
2215
            repository=None, append_revisions_only=None):
2244
2216
        """Create a branch of this format in a_bzrdir."""
2245
2217
        if target_branch is None:
2246
2218
            # this format does not implement branch itself, thus the implicit
2247
2219
            # creation contract must see it as uninitializable
2248
2220
            raise errors.UninitializableFormat(self)
2249
2221
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2222
        if a_bzrdir._format.fixed_components:
 
2223
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
 
2224
        if name is None:
 
2225
            name = a_bzrdir._get_selected_branch()
2250
2226
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2251
2227
        branch_transport.put_bytes('location',
2252
 
            target_branch.bzrdir.user_url)
2253
 
        branch_transport.put_bytes('format', self.get_format_string())
2254
 
        branch = self.open(
2255
 
            a_bzrdir, name, _found=True,
 
2228
            target_branch.user_url)
 
2229
        branch_transport.put_bytes('format', self.as_string())
 
2230
        branch = self.open(a_bzrdir, name, _found=True,
2256
2231
            possible_transports=[target_branch.bzrdir.root_transport])
2257
2232
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2258
2233
        return branch
2259
2234
 
2260
 
    def __init__(self):
2261
 
        super(BranchReferenceFormat, self).__init__()
2262
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2263
 
        self._matchingbzrdir.set_branch_format(self)
2264
 
 
2265
2235
    def _make_reference_clone_function(format, a_branch):
2266
2236
        """Create a clone() routine for a branch dynamically."""
2267
2237
        def clone(to_bzrdir, revision_id=None,
2289
2259
            a_bzrdir.
2290
2260
        :param possible_transports: An optional reusable transports list.
2291
2261
        """
 
2262
        if name is None:
 
2263
            name = a_bzrdir._get_selected_branch()
2292
2264
        if not _found:
2293
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2265
            format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2294
2266
            if format.__class__ != self.__class__:
2295
2267
                raise AssertionError("wrong format %r found for %r" %
2296
2268
                    (format, self))
2297
2269
        if location is None:
2298
2270
            location = self.get_reference(a_bzrdir, name)
2299
 
        real_bzrdir = bzrdir.BzrDir.open(
 
2271
        real_bzrdir = controldir.ControlDir.open(
2300
2272
            location, possible_transports=possible_transports)
2301
 
        result = real_bzrdir.open_branch(name=name, 
2302
 
            ignore_fallbacks=ignore_fallbacks)
 
2273
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks,
 
2274
            possible_transports=possible_transports)
2303
2275
        # this changes the behaviour of result.clone to create a new reference
2304
2276
        # rather than a copy of the content of the branch.
2305
2277
        # I did not use a proxy object because that needs much more extensive
2339
2311
 
2340
2312
# formats which have no format string are not discoverable
2341
2313
# and not independently creatable, so are not registered.
2342
 
__format5 = BzrBranchFormat5()
2343
2314
__format6 = BzrBranchFormat6()
2344
2315
__format7 = BzrBranchFormat7()
2345
2316
__format8 = BzrBranchFormat8()
2346
 
format_registry.register(__format5)
 
2317
format_registry.register_lazy(
 
2318
    "Bazaar-NG branch format 5\n", "bzrlib.branchfmt.fullhistory", "BzrBranchFormat5")
2347
2319
format_registry.register(BranchReferenceFormat())
2348
2320
format_registry.register(__format6)
2349
2321
format_registry.register(__format7)
2386
2358
 
2387
2359
    def __init__(self, _format=None,
2388
2360
                 _control_files=None, a_bzrdir=None, name=None,
2389
 
                 _repository=None, ignore_fallbacks=False):
 
2361
                 _repository=None, ignore_fallbacks=False,
 
2362
                 possible_transports=None):
2390
2363
        """Create new branch object at a particular location."""
2391
2364
        if a_bzrdir is None:
2392
2365
            raise ValueError('a_bzrdir must be supplied')
2393
 
        else:
2394
 
            self.bzrdir = a_bzrdir
2395
 
        self._base = self.bzrdir.transport.clone('..').base
 
2366
        if name is None:
 
2367
            raise ValueError('name must be supplied')
 
2368
        self.bzrdir = a_bzrdir
 
2369
        self._user_transport = self.bzrdir.transport.clone('..')
 
2370
        if name != "":
 
2371
            self._user_transport.set_segment_parameter(
 
2372
                "branch", urlutils.escape(name))
 
2373
        self._base = self._user_transport.base
2396
2374
        self.name = name
2397
 
        # XXX: We should be able to just do
2398
 
        #   self.base = self.bzrdir.root_transport.base
2399
 
        # but this does not quite work yet -- mbp 20080522
2400
2375
        self._format = _format
2401
2376
        if _control_files is None:
2402
2377
            raise ValueError('BzrBranch _control_files is None')
2403
2378
        self.control_files = _control_files
2404
2379
        self._transport = _control_files._transport
2405
2380
        self.repository = _repository
2406
 
        Branch.__init__(self)
 
2381
        self.conf_store = None
 
2382
        Branch.__init__(self, possible_transports)
2407
2383
 
2408
2384
    def __str__(self):
2409
 
        if self.name is None:
2410
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2411
 
        else:
2412
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2413
 
                self.name)
 
2385
        return '%s(%s)' % (self.__class__.__name__, self.user_url)
2414
2386
 
2415
2387
    __repr__ = __str__
2416
2388
 
2420
2392
 
2421
2393
    base = property(_get_base, doc="The URL for the root of this branch.")
2422
2394
 
 
2395
    @property
 
2396
    def user_transport(self):
 
2397
        return self._user_transport
 
2398
 
2423
2399
    def _get_config(self):
2424
 
        return TransportConfig(self._transport, 'branch.conf')
 
2400
        return _mod_config.TransportConfig(self._transport, 'branch.conf')
 
2401
 
 
2402
    def _get_config_store(self):
 
2403
        if self.conf_store is None:
 
2404
            self.conf_store =  _mod_config.BranchStore(self)
 
2405
        return self.conf_store
 
2406
 
 
2407
    def _uncommitted_branch(self):
 
2408
        """Return the branch that may contain uncommitted changes."""
 
2409
        master = self.get_master_branch()
 
2410
        if master is not None:
 
2411
            return master
 
2412
        else:
 
2413
            return self
 
2414
 
 
2415
    def store_uncommitted(self, creator):
 
2416
        """Store uncommitted changes from a ShelfCreator.
 
2417
 
 
2418
        :param creator: The ShelfCreator containing uncommitted changes, or
 
2419
            None to delete any stored changes.
 
2420
        :raises: ChangesAlreadyStored if the branch already has changes.
 
2421
        """
 
2422
        branch = self._uncommitted_branch()
 
2423
        if creator is None:
 
2424
            branch._transport.delete('stored-transform')
 
2425
            return
 
2426
        if branch._transport.has('stored-transform'):
 
2427
            raise errors.ChangesAlreadyStored
 
2428
        transform = StringIO()
 
2429
        creator.write_shelf(transform)
 
2430
        transform.seek(0)
 
2431
        branch._transport.put_file('stored-transform', transform)
 
2432
 
 
2433
    def get_unshelver(self, tree):
 
2434
        """Return a shelf.Unshelver for this branch and tree.
 
2435
 
 
2436
        :param tree: The tree to use to construct the Unshelver.
 
2437
        :return: an Unshelver or None if no changes are stored.
 
2438
        """
 
2439
        branch = self._uncommitted_branch()
 
2440
        try:
 
2441
            transform = branch._transport.get('stored-transform')
 
2442
        except errors.NoSuchFile:
 
2443
            return None
 
2444
        return shelf.Unshelver.from_tree_and_shelf(tree, transform)
2425
2445
 
2426
2446
    def is_locked(self):
2427
2447
        return self.control_files.is_locked()
2435
2455
        """
2436
2456
        if not self.is_locked():
2437
2457
            self._note_lock('w')
2438
 
        # All-in-one needs to always unlock/lock.
2439
 
        repo_control = getattr(self.repository, 'control_files', None)
2440
 
        if self.control_files == repo_control or not self.is_locked():
2441
2458
            self.repository._warn_if_deprecated(self)
2442
2459
            self.repository.lock_write()
2443
2460
            took_lock = True
2458
2475
        """
2459
2476
        if not self.is_locked():
2460
2477
            self._note_lock('r')
2461
 
        # All-in-one needs to always unlock/lock.
2462
 
        repo_control = getattr(self.repository, 'control_files', None)
2463
 
        if self.control_files == repo_control or not self.is_locked():
2464
2478
            self.repository._warn_if_deprecated(self)
2465
2479
            self.repository.lock_read()
2466
2480
            took_lock = True
2476
2490
 
2477
2491
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2478
2492
    def unlock(self):
 
2493
        if self.control_files._lock_count == 1 and self.conf_store is not None:
 
2494
            self.conf_store.save_changes()
2479
2495
        try:
2480
2496
            self.control_files.unlock()
2481
2497
        finally:
2482
 
            # All-in-one needs to always unlock/lock.
2483
 
            repo_control = getattr(self.repository, 'control_files', None)
2484
 
            if (self.control_files == repo_control or
2485
 
                not self.control_files.is_locked()):
2486
 
                self.repository.unlock()
2487
2498
            if not self.control_files.is_locked():
 
2499
                self.repository.unlock()
2488
2500
                # we just released the lock
2489
2501
                self._clear_cached_state()
2490
2502
 
2502
2514
        """See Branch.print_file."""
2503
2515
        return self.repository.print_file(file, revision_id)
2504
2516
 
2505
 
    def _write_revision_history(self, history):
2506
 
        """Factored out of set_revision_history.
2507
 
 
2508
 
        This performs the actual writing to disk.
2509
 
        It is intended to be called by BzrBranch5.set_revision_history."""
2510
 
        self._transport.put_bytes(
2511
 
            'revision-history', '\n'.join(history),
2512
 
            mode=self.bzrdir._get_file_mode())
2513
 
 
2514
 
    @deprecated_method(deprecated_in((2, 4, 0)))
2515
 
    def set_revision_history(self, rev_history):
2516
 
        """See Branch.set_revision_history."""
2517
 
        self._set_revision_history(rev_history)
2518
 
 
2519
 
    @needs_write_lock
2520
 
    def _set_revision_history(self, rev_history):
2521
 
        if 'evil' in debug.debug_flags:
2522
 
            mutter_callsite(3, "set_revision_history scales with history.")
2523
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2524
 
        for rev_id in rev_history:
2525
 
            check_not_reserved_id(rev_id)
2526
 
        if Branch.hooks['post_change_branch_tip']:
2527
 
            # Don't calculate the last_revision_info() if there are no hooks
2528
 
            # that will use it.
2529
 
            old_revno, old_revid = self.last_revision_info()
2530
 
        if len(rev_history) == 0:
2531
 
            revid = _mod_revision.NULL_REVISION
2532
 
        else:
2533
 
            revid = rev_history[-1]
2534
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2535
 
        self._write_revision_history(rev_history)
2536
 
        self._clear_cached_state()
2537
 
        self._cache_revision_history(rev_history)
2538
 
        for hook in Branch.hooks['set_rh']:
2539
 
            hook(self, rev_history)
2540
 
        if Branch.hooks['post_change_branch_tip']:
2541
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2542
 
 
2543
 
    def _synchronize_history(self, destination, revision_id):
2544
 
        """Synchronize last revision and revision history between branches.
2545
 
 
2546
 
        This version is most efficient when the destination is also a
2547
 
        BzrBranch5, but works for BzrBranch6 as long as the revision
2548
 
        history is the true lefthand parent history, and all of the revisions
2549
 
        are in the destination's repository.  If not, set_revision_history
2550
 
        will fail.
2551
 
 
2552
 
        :param destination: The branch to copy the history into
2553
 
        :param revision_id: The revision-id to truncate history at.  May
2554
 
          be None to copy complete history.
2555
 
        """
2556
 
        if not isinstance(destination._format, BzrBranchFormat5):
2557
 
            super(BzrBranch, self)._synchronize_history(
2558
 
                destination, revision_id)
2559
 
            return
2560
 
        if revision_id == _mod_revision.NULL_REVISION:
2561
 
            new_history = []
2562
 
        else:
2563
 
            new_history = self.revision_history()
2564
 
        if revision_id is not None and new_history != []:
2565
 
            try:
2566
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2567
 
            except ValueError:
2568
 
                rev = self.repository.get_revision(revision_id)
2569
 
                new_history = rev.get_history(self.repository)[1:]
2570
 
        destination._set_revision_history(new_history)
2571
 
 
2572
2517
    @needs_write_lock
2573
2518
    def set_last_revision_info(self, revno, revision_id):
2574
 
        """Set the last revision of this branch.
2575
 
 
2576
 
        The caller is responsible for checking that the revno is correct
2577
 
        for this revision id.
2578
 
 
2579
 
        It may be possible to set the branch last revision to an id not
2580
 
        present in the repository.  However, branches can also be
2581
 
        configured to check constraints on history, in which case this may not
2582
 
        be permitted.
2583
 
        """
2584
2519
        if not revision_id or not isinstance(revision_id, basestring):
2585
2520
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2586
 
        # this old format stores the full history, but this api doesn't
2587
 
        # provide it, so we must generate, and might as well check it's
2588
 
        # correct
2589
 
        history = self._lefthand_history(revision_id)
2590
 
        if len(history) != revno:
2591
 
            raise AssertionError('%d != %d' % (len(history), revno))
2592
 
        self._set_revision_history(history)
2593
 
 
2594
 
    def _gen_revision_history(self):
2595
 
        history = self._transport.get_bytes('revision-history').split('\n')
2596
 
        if history[-1:] == ['']:
2597
 
            # There shouldn't be a trailing newline, but just in case.
2598
 
            history.pop()
2599
 
        return history
2600
 
 
2601
 
    @needs_write_lock
2602
 
    def generate_revision_history(self, revision_id, last_rev=None,
2603
 
        other_branch=None):
2604
 
        """Create a new revision history that will finish with revision_id.
2605
 
 
2606
 
        :param revision_id: the new tip to use.
2607
 
        :param last_rev: The previous last_revision. If not None, then this
2608
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
2609
 
        :param other_branch: The other branch that DivergedBranches should
2610
 
            raise with respect to.
2611
 
        """
2612
 
        self._set_revision_history(self._lefthand_history(revision_id,
2613
 
            last_rev, other_branch))
 
2521
        revision_id = _mod_revision.ensure_null(revision_id)
 
2522
        old_revno, old_revid = self.last_revision_info()
 
2523
        if self.get_append_revisions_only():
 
2524
            self._check_history_violation(revision_id)
 
2525
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2526
        self._write_last_revision_info(revno, revision_id)
 
2527
        self._clear_cached_state()
 
2528
        self._last_revision_info_cache = revno, revision_id
 
2529
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2614
2530
 
2615
2531
    def basis_tree(self):
2616
2532
        """See Branch.basis_tree."""
2625
2541
                pass
2626
2542
        return None
2627
2543
 
2628
 
    def _basic_push(self, target, overwrite, stop_revision):
2629
 
        """Basic implementation of push without bound branches or hooks.
2630
 
 
2631
 
        Must be called with source read locked and target write locked.
2632
 
        """
2633
 
        result = BranchPushResult()
2634
 
        result.source_branch = self
2635
 
        result.target_branch = target
2636
 
        result.old_revno, result.old_revid = target.last_revision_info()
2637
 
        self.update_references(target)
2638
 
        if result.old_revid != stop_revision:
2639
 
            # We assume that during 'push' this repository is closer than
2640
 
            # the target.
2641
 
            graph = self.repository.get_graph(target.repository)
2642
 
            target.update_revisions(self, stop_revision,
2643
 
                overwrite=overwrite, graph=graph)
2644
 
        if self._push_should_merge_tags():
2645
 
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2646
 
        result.new_revno, result.new_revid = target.last_revision_info()
2647
 
        return result
2648
 
 
2649
2544
    def get_stacked_on_url(self):
2650
2545
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2651
2546
 
2662
2557
            self._transport.put_bytes('parent', url + '\n',
2663
2558
                mode=self.bzrdir._get_file_mode())
2664
2559
 
2665
 
 
2666
 
class BzrBranch5(BzrBranch):
2667
 
    """A format 5 branch. This supports new features over plain branches.
2668
 
 
2669
 
    It has support for a master_branch which is the data for bound branches.
2670
 
    """
 
2560
    @needs_write_lock
 
2561
    def unbind(self):
 
2562
        """If bound, unbind"""
 
2563
        return self.set_bound_location(None)
 
2564
 
 
2565
    @needs_write_lock
 
2566
    def bind(self, other):
 
2567
        """Bind this branch to the branch other.
 
2568
 
 
2569
        This does not push or pull data between the branches, though it does
 
2570
        check for divergence to raise an error when the branches are not
 
2571
        either the same, or one a prefix of the other. That behaviour may not
 
2572
        be useful, so that check may be removed in future.
 
2573
 
 
2574
        :param other: The branch to bind to
 
2575
        :type other: Branch
 
2576
        """
 
2577
        # TODO: jam 20051230 Consider checking if the target is bound
 
2578
        #       It is debatable whether you should be able to bind to
 
2579
        #       a branch which is itself bound.
 
2580
        #       Committing is obviously forbidden,
 
2581
        #       but binding itself may not be.
 
2582
        #       Since we *have* to check at commit time, we don't
 
2583
        #       *need* to check here
 
2584
 
 
2585
        # we want to raise diverged if:
 
2586
        # last_rev is not in the other_last_rev history, AND
 
2587
        # other_last_rev is not in our history, and do it without pulling
 
2588
        # history around
 
2589
        self.set_bound_location(other.base)
2671
2590
 
2672
2591
    def get_bound_location(self):
2673
2592
        try:
2715
2634
            return True
2716
2635
 
2717
2636
    @needs_write_lock
2718
 
    def bind(self, other):
2719
 
        """Bind this branch to the branch other.
2720
 
 
2721
 
        This does not push or pull data between the branches, though it does
2722
 
        check for divergence to raise an error when the branches are not
2723
 
        either the same, or one a prefix of the other. That behaviour may not
2724
 
        be useful, so that check may be removed in future.
2725
 
 
2726
 
        :param other: The branch to bind to
2727
 
        :type other: Branch
2728
 
        """
2729
 
        # TODO: jam 20051230 Consider checking if the target is bound
2730
 
        #       It is debatable whether you should be able to bind to
2731
 
        #       a branch which is itself bound.
2732
 
        #       Committing is obviously forbidden,
2733
 
        #       but binding itself may not be.
2734
 
        #       Since we *have* to check at commit time, we don't
2735
 
        #       *need* to check here
2736
 
 
2737
 
        # we want to raise diverged if:
2738
 
        # last_rev is not in the other_last_rev history, AND
2739
 
        # other_last_rev is not in our history, and do it without pulling
2740
 
        # history around
2741
 
        self.set_bound_location(other.base)
2742
 
 
2743
 
    @needs_write_lock
2744
 
    def unbind(self):
2745
 
        """If bound, unbind"""
2746
 
        return self.set_bound_location(None)
2747
 
 
2748
 
    @needs_write_lock
2749
2637
    def update(self, possible_transports=None):
2750
2638
        """Synchronise this branch with the master branch if any.
2751
2639
 
2762
2650
            return old_tip
2763
2651
        return None
2764
2652
 
2765
 
 
2766
 
class BzrBranch8(BzrBranch5):
 
2653
    def _read_last_revision_info(self):
 
2654
        revision_string = self._transport.get_bytes('last-revision')
 
2655
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2656
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2657
        revno = int(revno)
 
2658
        return revno, revision_id
 
2659
 
 
2660
    def _write_last_revision_info(self, revno, revision_id):
 
2661
        """Simply write out the revision id, with no checks.
 
2662
 
 
2663
        Use set_last_revision_info to perform this safely.
 
2664
 
 
2665
        Does not update the revision_history cache.
 
2666
        """
 
2667
        revision_id = _mod_revision.ensure_null(revision_id)
 
2668
        out_string = '%d %s\n' % (revno, revision_id)
 
2669
        self._transport.put_bytes('last-revision', out_string,
 
2670
            mode=self.bzrdir._get_file_mode())
 
2671
 
 
2672
    @needs_write_lock
 
2673
    def update_feature_flags(self, updated_flags):
 
2674
        """Update the feature flags for this branch.
 
2675
 
 
2676
        :param updated_flags: Dictionary mapping feature names to necessities
 
2677
            A necessity can be None to indicate the feature should be removed
 
2678
        """
 
2679
        self._format._update_feature_flags(updated_flags)
 
2680
        self.control_transport.put_bytes('format', self._format.as_string())
 
2681
 
 
2682
 
 
2683
class BzrBranch8(BzrBranch):
2767
2684
    """A branch that stores tree-reference locations."""
2768
2685
 
2769
 
    def _open_hook(self):
 
2686
    def _open_hook(self, possible_transports=None):
2770
2687
        if self._ignore_fallbacks:
2771
2688
            return
 
2689
        if possible_transports is None:
 
2690
            possible_transports = [self.bzrdir.root_transport]
2772
2691
        try:
2773
2692
            url = self.get_stacked_on_url()
2774
2693
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2782
2701
                    raise AssertionError(
2783
2702
                        "'transform_fallback_location' hook %s returned "
2784
2703
                        "None, not a URL." % hook_name)
2785
 
            self._activate_fallback_location(url)
 
2704
            self._activate_fallback_location(url,
 
2705
                possible_transports=possible_transports)
2786
2706
 
2787
2707
    def __init__(self, *args, **kwargs):
2788
2708
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2795
2715
        self._last_revision_info_cache = None
2796
2716
        self._reference_info = None
2797
2717
 
2798
 
    def _last_revision_info(self):
2799
 
        revision_string = self._transport.get_bytes('last-revision')
2800
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2801
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2802
 
        revno = int(revno)
2803
 
        return revno, revision_id
2804
 
 
2805
 
    def _write_last_revision_info(self, revno, revision_id):
2806
 
        """Simply write out the revision id, with no checks.
2807
 
 
2808
 
        Use set_last_revision_info to perform this safely.
2809
 
 
2810
 
        Does not update the revision_history cache.
2811
 
        Intended to be called by set_last_revision_info and
2812
 
        _write_revision_history.
2813
 
        """
2814
 
        revision_id = _mod_revision.ensure_null(revision_id)
2815
 
        out_string = '%d %s\n' % (revno, revision_id)
2816
 
        self._transport.put_bytes('last-revision', out_string,
2817
 
            mode=self.bzrdir._get_file_mode())
2818
 
 
2819
 
    @needs_write_lock
2820
 
    def set_last_revision_info(self, revno, revision_id):
2821
 
        if not revision_id or not isinstance(revision_id, basestring):
2822
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2823
 
        old_revno, old_revid = self.last_revision_info()
2824
 
        if self._get_append_revisions_only():
2825
 
            self._check_history_violation(revision_id)
2826
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2827
 
        self._write_last_revision_info(revno, revision_id)
2828
 
        self._clear_cached_state()
2829
 
        self._last_revision_info_cache = revno, revision_id
2830
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2831
 
 
2832
 
    def _synchronize_history(self, destination, revision_id):
2833
 
        """Synchronize last revision and revision history between branches.
2834
 
 
2835
 
        :see: Branch._synchronize_history
2836
 
        """
2837
 
        # XXX: The base Branch has a fast implementation of this method based
2838
 
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2839
 
        # that uses set_revision_history.  This class inherits from BzrBranch5,
2840
 
        # but wants the fast implementation, so it calls
2841
 
        # Branch._synchronize_history directly.
2842
 
        Branch._synchronize_history(self, destination, revision_id)
2843
 
 
2844
2718
    def _check_history_violation(self, revision_id):
2845
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
 
2719
        current_revid = self.last_revision()
 
2720
        last_revision = _mod_revision.ensure_null(current_revid)
2846
2721
        if _mod_revision.is_null(last_revision):
2847
2722
            return
2848
 
        if last_revision not in self._lefthand_history(revision_id):
2849
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2723
        graph = self.repository.get_graph()
 
2724
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
 
2725
            if lh_ancestor == current_revid:
 
2726
                return
 
2727
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
2850
2728
 
2851
2729
    def _gen_revision_history(self):
2852
2730
        """Generate the revision history from last revision
2855
2733
        self._extend_partial_history(stop_index=last_revno-1)
2856
2734
        return list(reversed(self._partial_revision_history_cache))
2857
2735
 
2858
 
    def _write_revision_history(self, history):
2859
 
        """Factored out of set_revision_history.
2860
 
 
2861
 
        This performs the actual writing to disk, with format-specific checks.
2862
 
        It is intended to be called by BzrBranch5.set_revision_history.
2863
 
        """
2864
 
        if len(history) == 0:
2865
 
            last_revision = 'null:'
2866
 
        else:
2867
 
            if history != self._lefthand_history(history[-1]):
2868
 
                raise errors.NotLefthandHistory(history)
2869
 
            last_revision = history[-1]
2870
 
        if self._get_append_revisions_only():
2871
 
            self._check_history_violation(last_revision)
2872
 
        self._write_last_revision_info(len(history), last_revision)
2873
 
 
2874
2736
    @needs_write_lock
2875
2737
    def _set_parent_location(self, url):
2876
2738
        """Set the parent branch"""
2964
2826
        """See Branch.set_push_location."""
2965
2827
        self._master_branch_cache = None
2966
2828
        result = None
2967
 
        config = self.get_config()
 
2829
        conf = self.get_config_stack()
2968
2830
        if location is None:
2969
 
            if config.get_user_option('bound') != 'True':
 
2831
            if not conf.get('bound'):
2970
2832
                return False
2971
2833
            else:
2972
 
                config.set_user_option('bound', 'False', warn_masked=True)
 
2834
                conf.set('bound', 'False')
2973
2835
                return True
2974
2836
        else:
2975
2837
            self._set_config_location('bound_location', location,
2976
 
                                      config=config)
2977
 
            config.set_user_option('bound', 'True', warn_masked=True)
 
2838
                                      config=conf)
 
2839
            conf.set('bound', 'True')
2978
2840
        return True
2979
2841
 
2980
2842
    def _get_bound_location(self, bound):
2981
2843
        """Return the bound location in the config file.
2982
2844
 
2983
2845
        Return None if the bound parameter does not match"""
2984
 
        config = self.get_config()
2985
 
        config_bound = (config.get_user_option('bound') == 'True')
2986
 
        if config_bound != bound:
 
2846
        conf = self.get_config_stack()
 
2847
        if conf.get('bound') != bound:
2987
2848
            return None
2988
 
        return self._get_config_location('bound_location', config=config)
 
2849
        return self._get_config_location('bound_location', config=conf)
2989
2850
 
2990
2851
    def get_bound_location(self):
2991
 
        """See Branch.set_push_location."""
 
2852
        """See Branch.get_bound_location."""
2992
2853
        return self._get_bound_location(True)
2993
2854
 
2994
2855
    def get_old_bound_location(self):
2999
2860
        # you can always ask for the URL; but you might not be able to use it
3000
2861
        # if the repo can't support stacking.
3001
2862
        ## self._check_stackable_repo()
3002
 
        stacked_url = self._get_config_location('stacked_on_location')
 
2863
        # stacked_on_location is only ever defined in branch.conf, so don't
 
2864
        # waste effort reading the whole stack of config files.
 
2865
        conf = _mod_config.BranchOnlyStack(self)
 
2866
        stacked_url = self._get_config_location('stacked_on_location',
 
2867
                                                config=conf)
3003
2868
        if stacked_url is None:
3004
2869
            raise errors.NotStacked(self)
3005
 
        return stacked_url
3006
 
 
3007
 
    def _get_append_revisions_only(self):
3008
 
        return self.get_config(
3009
 
            ).get_user_option_as_bool('append_revisions_only')
3010
 
 
3011
 
    @needs_write_lock
3012
 
    def generate_revision_history(self, revision_id, last_rev=None,
3013
 
                                  other_branch=None):
3014
 
        """See BzrBranch5.generate_revision_history"""
3015
 
        history = self._lefthand_history(revision_id, last_rev, other_branch)
3016
 
        revno = len(history)
3017
 
        self.set_last_revision_info(revno, revision_id)
 
2870
        return stacked_url.encode('utf-8')
3018
2871
 
3019
2872
    @needs_read_lock
3020
2873
    def get_rev_id(self, revno, history=None):
3050
2903
            except errors.RevisionNotPresent, e:
3051
2904
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3052
2905
            index = len(self._partial_revision_history_cache) - 1
 
2906
            if index < 0:
 
2907
                raise errors.NoSuchRevision(self, revision_id)
3053
2908
            if self._partial_revision_history_cache[index] != revision_id:
3054
2909
                raise errors.NoSuchRevision(self, revision_id)
3055
2910
        return self.revno() - index
3107
2962
    :ivar local_branch: target branch if there is a Master, else None
3108
2963
    :ivar target_branch: Target/destination branch object. (write locked)
3109
2964
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
 
2965
    :ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3110
2966
    """
3111
2967
 
3112
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3113
 
    def __int__(self):
3114
 
        """Return the relative change in revno.
3115
 
 
3116
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3117
 
        """
3118
 
        return self.new_revno - self.old_revno
3119
 
 
3120
2968
    def report(self, to_file):
 
2969
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
2970
        tag_updates = getattr(self, "tag_updates", None)
3121
2971
        if not is_quiet():
3122
 
            if self.old_revid == self.new_revid:
3123
 
                to_file.write('No revisions to pull.\n')
3124
 
            else:
 
2972
            if self.old_revid != self.new_revid:
3125
2973
                to_file.write('Now on revision %d.\n' % self.new_revno)
 
2974
            if tag_updates:
 
2975
                to_file.write('%d tag(s) updated.\n' % len(tag_updates))
 
2976
            if self.old_revid == self.new_revid and not tag_updates:
 
2977
                if not tag_conflicts:
 
2978
                    to_file.write('No revisions or tags to pull.\n')
 
2979
                else:
 
2980
                    to_file.write('No revisions to pull.\n')
3126
2981
        self._show_tag_conficts(to_file)
3127
2982
 
3128
2983
 
3145
3000
        target, otherwise it will be None.
3146
3001
    """
3147
3002
 
3148
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3149
 
    def __int__(self):
3150
 
        """Return the relative change in revno.
3151
 
 
3152
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3153
 
        """
3154
 
        return self.new_revno - self.old_revno
3155
 
 
3156
3003
    def report(self, to_file):
3157
 
        """Write a human-readable description of the result."""
3158
 
        if self.old_revid == self.new_revid:
3159
 
            note('No new revisions to push.')
3160
 
        else:
3161
 
            note('Pushed up to revision %d.' % self.new_revno)
 
3004
        # TODO: This function gets passed a to_file, but then
 
3005
        # ignores it and calls note() instead. This is also
 
3006
        # inconsistent with PullResult(), which writes to stdout.
 
3007
        # -- JRV20110901, bug #838853
 
3008
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
3009
        tag_updates = getattr(self, "tag_updates", None)
 
3010
        if not is_quiet():
 
3011
            if self.old_revid != self.new_revid:
 
3012
                note(gettext('Pushed up to revision %d.') % self.new_revno)
 
3013
            if tag_updates:
 
3014
                note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
 
3015
            if self.old_revid == self.new_revid and not tag_updates:
 
3016
                if not tag_conflicts:
 
3017
                    note(gettext('No new revisions or tags to push.'))
 
3018
                else:
 
3019
                    note(gettext('No new revisions to push.'))
3162
3020
        self._show_tag_conficts(to_file)
3163
3021
 
3164
3022
 
3178
3036
        :param verbose: Requests more detailed display of what was checked,
3179
3037
            if any.
3180
3038
        """
3181
 
        note('checked branch %s format %s', self.branch.user_url,
3182
 
            self.branch._format)
 
3039
        note(gettext('checked branch {0} format {1}').format(
 
3040
                                self.branch.user_url, self.branch._format))
3183
3041
        for error in self.errors:
3184
 
            note('found error:%s', error)
 
3042
            note(gettext('found error:%s'), error)
3185
3043
 
3186
3044
 
3187
3045
class Converter5to6(object):
3194
3052
 
3195
3053
        # Copy source data into target
3196
3054
        new_branch._write_last_revision_info(*branch.last_revision_info())
3197
 
        new_branch.set_parent(branch.get_parent())
3198
 
        new_branch.set_bound_location(branch.get_bound_location())
3199
 
        new_branch.set_push_location(branch.get_push_location())
 
3055
        new_branch.lock_write()
 
3056
        try:
 
3057
            new_branch.set_parent(branch.get_parent())
 
3058
            new_branch.set_bound_location(branch.get_bound_location())
 
3059
            new_branch.set_push_location(branch.get_push_location())
 
3060
        finally:
 
3061
            new_branch.unlock()
3200
3062
 
3201
3063
        # New branch has no tags by default
3202
3064
        new_branch.tags._set_tag_dict({})
3203
3065
 
3204
3066
        # Copying done; now update target format
3205
3067
        new_branch._transport.put_bytes('format',
3206
 
            format.get_format_string(),
 
3068
            format.as_string(),
3207
3069
            mode=new_branch.bzrdir._get_file_mode())
3208
3070
 
3209
3071
        # Clean up old files
3210
3072
        new_branch._transport.delete('revision-history')
 
3073
        branch.lock_write()
3211
3074
        try:
3212
 
            branch.set_parent(None)
3213
 
        except errors.NoSuchFile:
3214
 
            pass
3215
 
        branch.set_bound_location(None)
 
3075
            try:
 
3076
                branch.set_parent(None)
 
3077
            except errors.NoSuchFile:
 
3078
                pass
 
3079
            branch.set_bound_location(None)
 
3080
        finally:
 
3081
            branch.unlock()
3216
3082
 
3217
3083
 
3218
3084
class Converter6to7(object):
3222
3088
        format = BzrBranchFormat7()
3223
3089
        branch._set_config_location('stacked_on_location', '')
3224
3090
        # update target format
3225
 
        branch._transport.put_bytes('format', format.get_format_string())
 
3091
        branch._transport.put_bytes('format', format.as_string())
3226
3092
 
3227
3093
 
3228
3094
class Converter7to8(object):
3229
 
    """Perform an in-place upgrade of format 6 to format 7"""
 
3095
    """Perform an in-place upgrade of format 7 to format 8"""
3230
3096
 
3231
3097
    def convert(self, branch):
3232
3098
        format = BzrBranchFormat8()
3233
3099
        branch._transport.put_bytes('references', '')
3234
3100
        # update target format
3235
 
        branch._transport.put_bytes('format', format.get_format_string())
3236
 
 
3237
 
 
3238
 
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3239
 
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3240
 
    duration.
3241
 
 
3242
 
    _run_with_write_locked_target will attempt to release the lock it acquires.
3243
 
 
3244
 
    If an exception is raised by callable, then that exception *will* be
3245
 
    propagated, even if the unlock attempt raises its own error.  Thus
3246
 
    _run_with_write_locked_target should be preferred to simply doing::
3247
 
 
3248
 
        target.lock_write()
3249
 
        try:
3250
 
            return callable(*args, **kwargs)
3251
 
        finally:
3252
 
            target.unlock()
3253
 
 
3254
 
    """
3255
 
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
3256
 
    # should share code?
3257
 
    target.lock_write()
3258
 
    try:
3259
 
        result = callable(*args, **kwargs)
3260
 
    except:
3261
 
        exc_info = sys.exc_info()
3262
 
        try:
3263
 
            target.unlock()
3264
 
        finally:
3265
 
            raise exc_info[0], exc_info[1], exc_info[2]
3266
 
    else:
3267
 
        target.unlock()
3268
 
        return result
 
3101
        branch._transport.put_bytes('format', format.as_string())
3269
3102
 
3270
3103
 
3271
3104
class InterBranch(InterObject):
3301
3134
        raise NotImplementedError(self.pull)
3302
3135
 
3303
3136
    @needs_write_lock
3304
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3305
 
                         graph=None, fetch_tags=True):
3306
 
        """Pull in new perfect-fit revisions.
3307
 
 
3308
 
        :param stop_revision: Updated until the given revision
3309
 
        :param overwrite: Always set the branch pointer, rather than checking
3310
 
            to see if it is a proper descendant.
3311
 
        :param graph: A Graph object that can be used to query history
3312
 
            information. This can be None.
3313
 
        :param fetch_tags: Flag that specifies if tags from source should be
3314
 
            fetched too.
3315
 
        :return: None
3316
 
        """
3317
 
        raise NotImplementedError(self.update_revisions)
3318
 
 
3319
 
    @needs_write_lock
3320
 
    def push(self, overwrite=False, stop_revision=None,
 
3137
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3321
3138
             _override_hook_source_branch=None):
3322
3139
        """Mirror the source branch into the target branch.
3323
3140
 
3335
3152
        raise NotImplementedError(self.copy_content_into)
3336
3153
 
3337
3154
    @needs_write_lock
3338
 
    def fetch(self, stop_revision=None, fetch_spec=None):
 
3155
    def fetch(self, stop_revision=None, limit=None):
3339
3156
        """Fetch revisions.
3340
3157
 
3341
3158
        :param stop_revision: Last revision to fetch
3342
 
        :param fetch_spec: Fetch spec.
 
3159
        :param limit: Optional rough limit of revisions to fetch
3343
3160
        """
3344
3161
        raise NotImplementedError(self.fetch)
3345
3162
 
3346
3163
 
 
3164
def _fix_overwrite_type(overwrite):
 
3165
    if isinstance(overwrite, bool):
 
3166
        if overwrite:
 
3167
            return ["history", "tags"]
 
3168
        else:
 
3169
            return []
 
3170
    return overwrite
 
3171
 
 
3172
 
3347
3173
class GenericInterBranch(InterBranch):
3348
3174
    """InterBranch implementation that uses public Branch functions."""
3349
3175
 
3383
3209
            self.source.tags.merge_to(self.target.tags)
3384
3210
 
3385
3211
    @needs_write_lock
3386
 
    def fetch(self, stop_revision=None, fetch_spec=None):
3387
 
        if fetch_spec is not None and stop_revision is not None:
3388
 
            raise AssertionError(
3389
 
                "fetch_spec and last_revision are mutually exclusive.")
 
3212
    def fetch(self, stop_revision=None, limit=None):
3390
3213
        if self.target.base == self.source.base:
3391
3214
            return (0, [])
3392
3215
        self.source.lock_read()
3393
3216
        try:
3394
 
            if stop_revision is None and fetch_spec is None:
3395
 
                stop_revision = self.source.last_revision()
3396
 
                stop_revision = _mod_revision.ensure_null(stop_revision)
 
3217
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3218
            fetch_spec_factory.source_branch = self.source
 
3219
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3220
            fetch_spec_factory.source_repo = self.source.repository
 
3221
            fetch_spec_factory.target_repo = self.target.repository
 
3222
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3223
            fetch_spec_factory.limit = limit
 
3224
            fetch_spec = fetch_spec_factory.make_fetch_spec()
3397
3225
            return self.target.repository.fetch(self.source.repository,
3398
 
                revision_id=stop_revision, fetch_spec=fetch_spec)
 
3226
                fetch_spec=fetch_spec)
3399
3227
        finally:
3400
3228
            self.source.unlock()
3401
3229
 
3402
3230
    @needs_write_lock
3403
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3404
 
        graph=None, fetch_tags=True):
3405
 
        """See InterBranch.update_revisions()."""
 
3231
    def _update_revisions(self, stop_revision=None, overwrite=False,
 
3232
            graph=None):
3406
3233
        other_revno, other_last_revision = self.source.last_revision_info()
3407
3234
        stop_revno = None # unknown
3408
3235
        if stop_revision is None:
3419
3246
        # case of having something to pull, and so that the check for
3420
3247
        # already merged can operate on the just fetched graph, which will
3421
3248
        # be cached in memory.
3422
 
        if fetch_tags:
3423
 
            fetch_spec_factory = fetch.FetchSpecFactory()
3424
 
            fetch_spec_factory.source_branch = self.source
3425
 
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3426
 
            fetch_spec_factory.source_repo = self.source.repository
3427
 
            fetch_spec_factory.target_repo = self.target.repository
3428
 
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3429
 
            fetch_spec = fetch_spec_factory.make_fetch_spec()
3430
 
        else:
3431
 
            fetch_spec = _mod_graph.NotInOtherForRevs(self.target.repository,
3432
 
                self.source.repository, revision_ids=[stop_revision]).execute()
3433
 
        self.target.fetch(self.source, fetch_spec=fetch_spec)
 
3249
        self.fetch(stop_revision=stop_revision)
3434
3250
        # Check to see if one is an ancestor of the other
3435
3251
        if not overwrite:
3436
3252
            if graph is None:
3464
3280
        if local and not bound_location:
3465
3281
            raise errors.LocalRequiresBoundBranch()
3466
3282
        master_branch = None
3467
 
        source_is_master = (self.source.user_url == bound_location)
 
3283
        source_is_master = False
 
3284
        if bound_location:
 
3285
            # bound_location comes from a config file, some care has to be
 
3286
            # taken to relate it to source.user_url
 
3287
            normalized = urlutils.normalize_url(bound_location)
 
3288
            try:
 
3289
                relpath = self.source.user_transport.relpath(normalized)
 
3290
                source_is_master = (relpath == '')
 
3291
            except (errors.PathNotChild, errors.InvalidURL):
 
3292
                source_is_master = False
3468
3293
        if not local and bound_location and not source_is_master:
3469
3294
            # not pulling from master, so we need to update master.
3470
3295
            master_branch = self.target.get_master_branch(possible_transports)
3483
3308
            if master_branch:
3484
3309
                master_branch.unlock()
3485
3310
 
3486
 
    def push(self, overwrite=False, stop_revision=None,
 
3311
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3487
3312
             _override_hook_source_branch=None):
3488
3313
        """See InterBranch.push.
3489
3314
 
3490
3315
        This is the basic concrete implementation of push()
3491
3316
 
3492
 
        :param _override_hook_source_branch: If specified, run
3493
 
        the hooks passing this Branch as the source, rather than self.
3494
 
        This is for use of RemoteBranch, where push is delegated to the
3495
 
        underlying vfs-based Branch.
 
3317
        :param _override_hook_source_branch: If specified, run the hooks
 
3318
            passing this Branch as the source, rather than self.  This is for
 
3319
            use of RemoteBranch, where push is delegated to the underlying
 
3320
            vfs-based Branch.
3496
3321
        """
 
3322
        if lossy:
 
3323
            raise errors.LossyPushToSameVCS(self.source, self.target)
3497
3324
        # TODO: Public option to disable running hooks - should be trivial but
3498
3325
        # needs tests.
3499
 
        self.source.lock_read()
3500
 
        try:
3501
 
            return _run_with_write_locked_target(
3502
 
                self.target, self._push_with_bound_branches, overwrite,
3503
 
                stop_revision,
3504
 
                _override_hook_source_branch=_override_hook_source_branch)
3505
 
        finally:
3506
 
            self.source.unlock()
3507
 
 
3508
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
 
3326
 
 
3327
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
 
3328
        op.add_cleanup(self.source.lock_read().unlock)
 
3329
        op.add_cleanup(self.target.lock_write().unlock)
 
3330
        return op.run(overwrite, stop_revision,
 
3331
            _override_hook_source_branch=_override_hook_source_branch)
 
3332
 
 
3333
    def _basic_push(self, overwrite, stop_revision):
 
3334
        """Basic implementation of push without bound branches or hooks.
 
3335
 
 
3336
        Must be called with source read locked and target write locked.
 
3337
        """
 
3338
        result = BranchPushResult()
 
3339
        result.source_branch = self.source
 
3340
        result.target_branch = self.target
 
3341
        result.old_revno, result.old_revid = self.target.last_revision_info()
 
3342
        self.source.update_references(self.target)
 
3343
        overwrite = _fix_overwrite_type(overwrite)
 
3344
        if result.old_revid != stop_revision:
 
3345
            # We assume that during 'push' this repository is closer than
 
3346
            # the target.
 
3347
            graph = self.source.repository.get_graph(self.target.repository)
 
3348
            self._update_revisions(stop_revision,
 
3349
                overwrite=("history" in overwrite),
 
3350
                graph=graph)
 
3351
        if self.source._push_should_merge_tags():
 
3352
            result.tag_updates, result.tag_conflicts = (
 
3353
                self.source.tags.merge_to(
 
3354
                self.target.tags, "tags" in overwrite))
 
3355
        result.new_revno, result.new_revid = self.target.last_revision_info()
 
3356
        return result
 
3357
 
 
3358
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3509
3359
            _override_hook_source_branch=None):
3510
3360
        """Push from source into target, and into target's master if any.
3511
3361
        """
3523
3373
            # be bound to itself? -- mbp 20070507
3524
3374
            master_branch = self.target.get_master_branch()
3525
3375
            master_branch.lock_write()
3526
 
            try:
3527
 
                # push into the master from the source branch.
3528
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3529
 
                # and push into the target branch from the source. Note that we
3530
 
                # push from the source branch again, because it's considered the
3531
 
                # highest bandwidth repository.
3532
 
                result = self.source._basic_push(self.target, overwrite,
3533
 
                    stop_revision)
3534
 
                result.master_branch = master_branch
3535
 
                result.local_branch = self.target
3536
 
                _run_hooks()
3537
 
                return result
3538
 
            finally:
3539
 
                master_branch.unlock()
 
3376
            operation.add_cleanup(master_branch.unlock)
 
3377
            # push into the master from the source branch.
 
3378
            master_inter = InterBranch.get(self.source, master_branch)
 
3379
            master_inter._basic_push(overwrite, stop_revision)
 
3380
            # and push into the target branch from the source. Note that
 
3381
            # we push from the source branch again, because it's considered
 
3382
            # the highest bandwidth repository.
 
3383
            result = self._basic_push(overwrite, stop_revision)
 
3384
            result.master_branch = master_branch
 
3385
            result.local_branch = self.target
3540
3386
        else:
 
3387
            master_branch = None
3541
3388
            # no master branch
3542
 
            result = self.source._basic_push(self.target, overwrite,
3543
 
                stop_revision)
 
3389
            result = self._basic_push(overwrite, stop_revision)
3544
3390
            # TODO: Why set master_branch and local_branch if there's no
3545
3391
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3546
3392
            # 20070504
3547
3393
            result.master_branch = self.target
3548
3394
            result.local_branch = None
3549
 
            _run_hooks()
3550
 
            return result
 
3395
        _run_hooks()
 
3396
        return result
3551
3397
 
3552
3398
    def _pull(self, overwrite=False, stop_revision=None,
3553
3399
             possible_transports=None, _hook_master=None, run_hooks=True,
3589
3435
            # -- JRV20090506
3590
3436
            result.old_revno, result.old_revid = \
3591
3437
                self.target.last_revision_info()
3592
 
            self.target.update_revisions(self.source, stop_revision,
3593
 
                overwrite=overwrite, graph=graph)
 
3438
            overwrite = _fix_overwrite_type(overwrite)
 
3439
            self._update_revisions(stop_revision,
 
3440
                overwrite=("history" in overwrite),
 
3441
                graph=graph)
3594
3442
            # TODO: The old revid should be specified when merging tags, 
3595
3443
            # so a tags implementation that versions tags can only 
3596
3444
            # pull in the most recent changes. -- JRV20090506
3597
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3598
 
                overwrite, ignore_master=not merge_tags_to_master)
 
3445
            result.tag_updates, result.tag_conflicts = (
 
3446
                self.source.tags.merge_to(self.target.tags,
 
3447
                    "tags" in overwrite,
 
3448
                    ignore_master=not merge_tags_to_master))
3599
3449
            result.new_revno, result.new_revid = self.target.last_revision_info()
3600
3450
            if _hook_master:
3601
3451
                result.master_branch = _hook_master