~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Jelmer Vernooij
  • Date: 2011-12-05 14:12:23 UTC
  • mto: This revision was merged to the branch mainline in revision 6348.
  • Revision ID: jelmer@samba.org-20111205141223-8qxae4h37satlzgq
Move more functionality to vf_search.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
import bzrlib.bzrdir
17
18
 
18
19
from cStringIO import StringIO
19
 
import sys
20
20
 
21
21
from bzrlib.lazy_import import lazy_import
22
22
lazy_import(globals(), """
23
 
from itertools import chain
 
23
import itertools
24
24
from bzrlib import (
25
 
        bzrdir,
26
 
        cache_utf8,
27
 
        config as _mod_config,
28
 
        debug,
29
 
        errors,
30
 
        lockdir,
31
 
        lockable_files,
32
 
        repository,
33
 
        revision as _mod_revision,
34
 
        rio,
35
 
        symbol_versioning,
36
 
        transport,
37
 
        tsort,
38
 
        ui,
39
 
        urlutils,
40
 
        )
41
 
from bzrlib.config import BranchConfig, TransportConfig
42
 
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
 
from bzrlib.tag import (
44
 
    BasicTags,
45
 
    DisabledTags,
 
25
    bzrdir,
 
26
    controldir,
 
27
    cache_utf8,
 
28
    cleanup,
 
29
    config as _mod_config,
 
30
    debug,
 
31
    errors,
 
32
    fetch,
 
33
    graph as _mod_graph,
 
34
    lockdir,
 
35
    lockable_files,
 
36
    remote,
 
37
    repository,
 
38
    revision as _mod_revision,
 
39
    rio,
 
40
    tag as _mod_tag,
 
41
    transport,
 
42
    ui,
 
43
    urlutils,
 
44
    vf_search,
46
45
    )
 
46
from bzrlib.i18n import gettext, ngettext
47
47
""")
48
48
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
 
from bzrlib.hooks import HookPoint, Hooks
 
49
from bzrlib import (
 
50
    controldir,
 
51
    )
 
52
from bzrlib.decorators import (
 
53
    needs_read_lock,
 
54
    needs_write_lock,
 
55
    only_raises,
 
56
    )
 
57
from bzrlib.hooks import Hooks
51
58
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
 
59
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
60
from bzrlib import registry
54
61
from bzrlib.symbol_versioning import (
55
62
    deprecated_in,
58
65
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
59
66
 
60
67
 
61
 
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
 
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
63
 
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
 
 
65
 
 
66
 
class Branch(bzrdir.ControlComponent):
 
68
class Branch(controldir.ControlComponent):
67
69
    """Branch holding a history of revisions.
68
70
 
69
71
    :ivar base:
70
72
        Base directory/url of the branch; using control_url and
71
73
        control_transport is more standardized.
72
 
 
73
 
    hooks: An instance of BranchHooks.
 
74
    :ivar hooks: An instance of BranchHooks.
 
75
    :ivar _master_branch_cache: cached result of get_master_branch, see
 
76
        _clear_cached_state.
74
77
    """
75
78
    # this is really an instance variable - FIXME move it there
76
79
    # - RBC 20060112
84
87
    def user_transport(self):
85
88
        return self.bzrdir.user_transport
86
89
 
87
 
    def __init__(self, *ignored, **ignored_too):
 
90
    def __init__(self, possible_transports=None):
88
91
        self.tags = self._format.make_tags(self)
89
92
        self._revision_history_cache = None
90
93
        self._revision_id_to_revno_cache = None
91
94
        self._partial_revision_id_to_revno_cache = {}
92
95
        self._partial_revision_history_cache = []
 
96
        self._tags_bytes = None
93
97
        self._last_revision_info_cache = None
 
98
        self._master_branch_cache = None
94
99
        self._merge_sorted_revisions_cache = None
95
 
        self._open_hook()
 
100
        self._open_hook(possible_transports)
96
101
        hooks = Branch.hooks['open']
97
102
        for hook in hooks:
98
103
            hook(self)
99
104
 
100
 
    def _open_hook(self):
 
105
    def _open_hook(self, possible_transports):
101
106
        """Called by init to allow simpler extension of the base class."""
102
107
 
103
 
    def _activate_fallback_location(self, url):
 
108
    def _activate_fallback_location(self, url, possible_transports):
104
109
        """Activate the branch/repository from url as a fallback repository."""
105
 
        repo = self._get_fallback_repository(url)
 
110
        for existing_fallback_repo in self.repository._fallback_repositories:
 
111
            if existing_fallback_repo.user_url == url:
 
112
                # This fallback is already configured.  This probably only
 
113
                # happens because ControlDir.sprout is a horrible mess.  To avoid
 
114
                # confusing _unstack we don't add this a second time.
 
115
                mutter('duplicate activation of fallback %r on %r', url, self)
 
116
                return
 
117
        repo = self._get_fallback_repository(url, possible_transports)
106
118
        if repo.has_same_location(self.repository):
107
119
            raise errors.UnstackableLocationError(self.user_url, url)
108
120
        self.repository.add_fallback_repository(repo)
162
174
        For instance, if the branch is at URL/.bzr/branch,
163
175
        Branch.open(URL) -> a Branch instance.
164
176
        """
165
 
        control = bzrdir.BzrDir.open(base, _unsupported,
 
177
        control = controldir.ControlDir.open(base, _unsupported,
166
178
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
179
        return control.open_branch(unsupported=_unsupported,
 
180
            possible_transports=possible_transports)
168
181
 
169
182
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
183
    def open_from_transport(transport, name=None, _unsupported=False,
 
184
            possible_transports=None):
171
185
        """Open the branch rooted at transport"""
172
 
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
186
        control = controldir.ControlDir.open_from_transport(transport, _unsupported)
 
187
        return control.open_branch(name=name, unsupported=_unsupported,
 
188
            possible_transports=possible_transports)
174
189
 
175
190
    @staticmethod
176
191
    def open_containing(url, possible_transports=None):
184
199
        format, UnknownFormatError or UnsupportedFormatError are raised.
185
200
        If there is one, it is returned, along with the unused portion of url.
186
201
        """
187
 
        control, relpath = bzrdir.BzrDir.open_containing(url,
 
202
        control, relpath = controldir.ControlDir.open_containing(url,
188
203
                                                         possible_transports)
189
 
        return control.open_branch(), relpath
 
204
        branch = control.open_branch(possible_transports=possible_transports)
 
205
        return (branch, relpath)
190
206
 
191
207
    def _push_should_merge_tags(self):
192
208
        """Should _basic_push merge this branch's tags into the target?
197
213
        return self.supports_tags() and self.tags.get_tag_dict()
198
214
 
199
215
    def get_config(self):
200
 
        return BranchConfig(self)
 
216
        """Get a bzrlib.config.BranchConfig for this Branch.
 
217
 
 
218
        This can then be used to get and set configuration options for the
 
219
        branch.
 
220
 
 
221
        :return: A bzrlib.config.BranchConfig.
 
222
        """
 
223
        return _mod_config.BranchConfig(self)
 
224
 
 
225
    def get_config_stack(self):
 
226
        """Get a bzrlib.config.BranchStack for this Branch.
 
227
 
 
228
        This can then be used to get and set configuration options for the
 
229
        branch.
 
230
 
 
231
        :return: A bzrlib.config.BranchStack.
 
232
        """
 
233
        return _mod_config.BranchStack(self)
201
234
 
202
235
    def _get_config(self):
203
236
        """Get the concrete config for just the config in this branch.
211
244
        """
212
245
        raise NotImplementedError(self._get_config)
213
246
 
214
 
    def _get_fallback_repository(self, url):
 
247
    def _get_fallback_repository(self, url, possible_transports):
215
248
        """Get the repository we fallback to at url."""
216
249
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
218
 
            possible_transports=[self.bzrdir.root_transport])
 
250
        a_branch = Branch.open(url, possible_transports=possible_transports)
219
251
        return a_branch.repository
220
252
 
 
253
    @needs_read_lock
221
254
    def _get_tags_bytes(self):
222
255
        """Get the bytes of a serialised tags dict.
223
256
 
230
263
        :return: The bytes of the tags file.
231
264
        :seealso: Branch._set_tags_bytes.
232
265
        """
233
 
        return self._transport.get_bytes('tags')
 
266
        if self._tags_bytes is None:
 
267
            self._tags_bytes = self._transport.get_bytes('tags')
 
268
        return self._tags_bytes
234
269
 
235
270
    def _get_nick(self, local=False, possible_transports=None):
236
271
        config = self.get_config()
238
273
        if not local and not config.has_explicit_nickname():
239
274
            try:
240
275
                master = self.get_master_branch(possible_transports)
 
276
                if master and self.user_url == master.user_url:
 
277
                    raise errors.RecursiveBind(self.user_url)
241
278
                if master is not None:
242
279
                    # return the master branch value
243
280
                    return master.nick
 
281
            except errors.RecursiveBind, e:
 
282
                raise e
244
283
            except errors.BzrError, e:
245
284
                # Silently fall back to local implicit nick if the master is
246
285
                # unavailable
283
322
        new_history.reverse()
284
323
        return new_history
285
324
 
286
 
    def lock_write(self):
 
325
    def lock_write(self, token=None):
 
326
        """Lock the branch for write operations.
 
327
 
 
328
        :param token: A token to permit reacquiring a previously held and
 
329
            preserved lock.
 
330
        :return: A BranchWriteLockResult.
 
331
        """
287
332
        raise NotImplementedError(self.lock_write)
288
333
 
289
334
    def lock_read(self):
 
335
        """Lock the branch for read operations.
 
336
 
 
337
        :return: A bzrlib.lock.LogicalLockResult.
 
338
        """
290
339
        raise NotImplementedError(self.lock_read)
291
340
 
292
341
    def unlock(self):
413
462
            after. If None, the rest of history is included.
414
463
        :param stop_rule: if stop_revision_id is not None, the precise rule
415
464
            to use for termination:
 
465
 
416
466
            * 'exclude' - leave the stop revision out of the result (default)
417
467
            * 'include' - the stop revision is the last item in the result
418
468
            * 'with-merges' - include the stop revision and all of its
420
470
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
471
              that are in both ancestries
422
472
        :param direction: either 'reverse' or 'forward':
 
473
 
423
474
            * reverse means return the start_revision_id first, i.e.
424
475
              start at the most recent revision and go backwards in history
425
476
            * forward returns tuples in the opposite order to reverse.
469
520
        rev_iter = iter(merge_sorted_revisions)
470
521
        if start_revision_id is not None:
471
522
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
523
                rev_id = node.key
473
524
                if rev_id != start_revision_id:
474
525
                    continue
475
526
                else:
476
527
                    # The decision to include the start or not
477
528
                    # depends on the stop_rule if a stop is provided
478
529
                    # so pop this node back into the iterator
479
 
                    rev_iter = chain(iter([node]), rev_iter)
 
530
                    rev_iter = itertools.chain(iter([node]), rev_iter)
480
531
                    break
481
532
        if stop_revision_id is None:
482
533
            # Yield everything
483
534
            for node in rev_iter:
484
 
                rev_id = node.key[-1]
 
535
                rev_id = node.key
485
536
                yield (rev_id, node.merge_depth, node.revno,
486
537
                       node.end_of_merge)
487
538
        elif stop_rule == 'exclude':
488
539
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
540
                rev_id = node.key
490
541
                if rev_id == stop_revision_id:
491
542
                    return
492
543
                yield (rev_id, node.merge_depth, node.revno,
493
544
                       node.end_of_merge)
494
545
        elif stop_rule == 'include':
495
546
            for node in rev_iter:
496
 
                rev_id = node.key[-1]
 
547
                rev_id = node.key
497
548
                yield (rev_id, node.merge_depth, node.revno,
498
549
                       node.end_of_merge)
499
550
                if rev_id == stop_revision_id:
505
556
            ancestors = graph.find_unique_ancestors(start_revision_id,
506
557
                                                    [stop_revision_id])
507
558
            for node in rev_iter:
508
 
                rev_id = node.key[-1]
 
559
                rev_id = node.key
509
560
                if rev_id not in ancestors:
510
561
                    continue
511
562
                yield (rev_id, node.merge_depth, node.revno,
521
572
            reached_stop_revision_id = False
522
573
            revision_id_whitelist = []
523
574
            for node in rev_iter:
524
 
                rev_id = node.key[-1]
 
575
                rev_id = node.key
525
576
                if rev_id == left_parent:
526
577
                    # reached the left parent after the stop_revision
527
578
                    return
607
658
        """
608
659
        raise errors.UpgradeRequired(self.user_url)
609
660
 
 
661
    def get_append_revisions_only(self):
 
662
        """Whether it is only possible to append revisions to the history.
 
663
        """
 
664
        if not self._format.supports_set_append_revisions_only():
 
665
            return False
 
666
        return self.get_config(
 
667
            ).get_user_option_as_bool('append_revisions_only')
 
668
 
610
669
    def set_append_revisions_only(self, enabled):
611
670
        if not self._format.supports_set_append_revisions_only():
612
671
            raise errors.UpgradeRequired(self.user_url)
626
685
        raise errors.UnsupportedOperation(self.get_reference_info, self)
627
686
 
628
687
    @needs_write_lock
629
 
    def fetch(self, from_branch, last_revision=None, pb=None):
 
688
    def fetch(self, from_branch, last_revision=None, limit=None):
630
689
        """Copy revisions from from_branch into this branch.
631
690
 
632
691
        :param from_branch: Where to copy from.
633
692
        :param last_revision: What revision to stop at (None for at the end
634
693
                              of the branch.
635
 
        :param pb: An optional progress bar to use.
 
694
        :param limit: Optional rough limit of revisions to fetch
636
695
        :return: None
637
696
        """
638
 
        if self.base == from_branch.base:
639
 
            return (0, [])
640
 
        if pb is not None:
641
 
            symbol_versioning.warn(
642
 
                symbol_versioning.deprecated_in((1, 14, 0))
643
 
                % "pb parameter to fetch()")
644
 
        from_branch.lock_read()
645
 
        try:
646
 
            if last_revision is None:
647
 
                last_revision = from_branch.last_revision()
648
 
                last_revision = _mod_revision.ensure_null(last_revision)
649
 
            return self.repository.fetch(from_branch.repository,
650
 
                                         revision_id=last_revision,
651
 
                                         pb=pb)
652
 
        finally:
653
 
            from_branch.unlock()
 
697
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
654
698
 
655
699
    def get_bound_location(self):
656
700
        """Return the URL of the branch we are bound to.
667
711
 
668
712
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
713
                           timezone=None, committer=None, revprops=None,
670
 
                           revision_id=None):
 
714
                           revision_id=None, lossy=False):
671
715
        """Obtain a CommitBuilder for this branch.
672
716
 
673
717
        :param parents: Revision ids of the parents of the new revision.
677
721
        :param committer: Optional committer to set for commit.
678
722
        :param revprops: Optional dictionary of revision properties.
679
723
        :param revision_id: Optional revision id.
 
724
        :param lossy: Whether to discard data that can not be natively
 
725
            represented, when pushing to a foreign VCS 
680
726
        """
681
727
 
682
728
        if config is None:
683
729
            config = self.get_config()
684
730
 
685
731
        return self.repository.get_commit_builder(self, parents, config,
686
 
            timestamp, timezone, committer, revprops, revision_id)
 
732
            timestamp, timezone, committer, revprops, revision_id,
 
733
            lossy)
687
734
 
688
735
    def get_master_branch(self, possible_transports=None):
689
736
        """Return the branch we are bound to.
692
739
        """
693
740
        return None
694
741
 
 
742
    @deprecated_method(deprecated_in((2, 5, 0)))
695
743
    def get_revision_delta(self, revno):
696
744
        """Return the delta for one revision.
697
745
 
698
746
        The delta is relative to its mainline predecessor, or the
699
747
        empty tree for revision 1.
700
748
        """
701
 
        rh = self.revision_history()
702
 
        if not (1 <= revno <= len(rh)):
 
749
        try:
 
750
            revid = self.get_rev_id(revno)
 
751
        except errors.NoSuchRevision:
703
752
            raise errors.InvalidRevisionNumber(revno)
704
 
        return self.repository.get_revision_delta(rh[revno-1])
 
753
        return self.repository.get_revision_delta(revid)
705
754
 
706
755
    def get_stacked_on_url(self):
707
756
        """Get the URL this branch is stacked against.
716
765
        """Print `file` to stdout."""
717
766
        raise NotImplementedError(self.print_file)
718
767
 
 
768
    @deprecated_method(deprecated_in((2, 4, 0)))
719
769
    def set_revision_history(self, rev_history):
720
 
        raise NotImplementedError(self.set_revision_history)
 
770
        """See Branch.set_revision_history."""
 
771
        self._set_revision_history(rev_history)
 
772
 
 
773
    @needs_write_lock
 
774
    def _set_revision_history(self, rev_history):
 
775
        if len(rev_history) == 0:
 
776
            revid = _mod_revision.NULL_REVISION
 
777
        else:
 
778
            revid = rev_history[-1]
 
779
        if rev_history != self._lefthand_history(revid):
 
780
            raise errors.NotLefthandHistory(rev_history)
 
781
        self.set_last_revision_info(len(rev_history), revid)
 
782
        self._cache_revision_history(rev_history)
 
783
        for hook in Branch.hooks['set_rh']:
 
784
            hook(self, rev_history)
 
785
 
 
786
    @needs_write_lock
 
787
    def set_last_revision_info(self, revno, revision_id):
 
788
        """Set the last revision of this branch.
 
789
 
 
790
        The caller is responsible for checking that the revno is correct
 
791
        for this revision id.
 
792
 
 
793
        It may be possible to set the branch last revision to an id not
 
794
        present in the repository.  However, branches can also be
 
795
        configured to check constraints on history, in which case this may not
 
796
        be permitted.
 
797
        """
 
798
        raise NotImplementedError(self.set_last_revision_info)
 
799
 
 
800
    @needs_write_lock
 
801
    def generate_revision_history(self, revision_id, last_rev=None,
 
802
                                  other_branch=None):
 
803
        """See Branch.generate_revision_history"""
 
804
        graph = self.repository.get_graph()
 
805
        (last_revno, last_revid) = self.last_revision_info()
 
806
        known_revision_ids = [
 
807
            (last_revid, last_revno),
 
808
            (_mod_revision.NULL_REVISION, 0),
 
809
            ]
 
810
        if last_rev is not None:
 
811
            if not graph.is_ancestor(last_rev, revision_id):
 
812
                # our previous tip is not merged into stop_revision
 
813
                raise errors.DivergedBranches(self, other_branch)
 
814
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
 
815
        self.set_last_revision_info(revno, revision_id)
721
816
 
722
817
    @needs_write_lock
723
818
    def set_parent(self, url):
760
855
                return
761
856
            self._unstack()
762
857
        else:
763
 
            self._activate_fallback_location(url)
 
858
            self._activate_fallback_location(url,
 
859
                possible_transports=[self.bzrdir.root_transport])
764
860
        # write this out after the repository is stacked to avoid setting a
765
861
        # stacked config that doesn't work.
766
862
        self._set_config_location('stacked_on_location', url)
767
863
 
768
864
    def _unstack(self):
769
865
        """Change a branch to be unstacked, copying data as needed.
770
 
        
 
866
 
771
867
        Don't call this directly, use set_stacked_on_url(None).
772
868
        """
773
869
        pb = ui.ui_factory.nested_progress_bar()
774
870
        try:
775
 
            pb.update("Unstacking")
 
871
            pb.update(gettext("Unstacking"))
776
872
            # The basic approach here is to fetch the tip of the branch,
777
873
            # including all available ghosts, from the existing stacked
778
874
            # repository into a new repository object without the fallbacks. 
782
878
            old_repository = self.repository
783
879
            if len(old_repository._fallback_repositories) != 1:
784
880
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
 
881
                    "of %r (fallbacks: %r)" % (old_repository,
 
882
                        old_repository._fallback_repositories))
 
883
            # Open the new repository object.
 
884
            # Repositories don't offer an interface to remove fallback
 
885
            # repositories today; take the conceptually simpler option and just
 
886
            # reopen it.  We reopen it starting from the URL so that we
 
887
            # get a separate connection for RemoteRepositories and can
 
888
            # stream from one of them to the other.  This does mean doing
 
889
            # separate SSH connection setup, but unstacking is not a
 
890
            # common operation so it's tolerable.
 
891
            new_bzrdir = controldir.ControlDir.open(
 
892
                self.bzrdir.root_transport.base)
 
893
            new_repository = new_bzrdir.find_repository()
 
894
            if new_repository._fallback_repositories:
 
895
                raise AssertionError("didn't expect %r to have "
 
896
                    "fallback_repositories"
 
897
                    % (self.repository,))
 
898
            # Replace self.repository with the new repository.
 
899
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
900
            # lock count) of self.repository to the new repository.
 
901
            lock_token = old_repository.lock_write().repository_token
 
902
            self.repository = new_repository
 
903
            if isinstance(self, remote.RemoteBranch):
 
904
                # Remote branches can have a second reference to the old
 
905
                # repository that need to be replaced.
 
906
                if self._real_branch is not None:
 
907
                    self._real_branch.repository = new_repository
 
908
            self.repository.lock_write(token=lock_token)
 
909
            if lock_token is not None:
 
910
                old_repository.leave_lock_in_place()
787
911
            old_repository.unlock()
 
912
            if lock_token is not None:
 
913
                # XXX: self.repository.leave_lock_in_place() before this
 
914
                # function will not be preserved.  Fortunately that doesn't
 
915
                # affect the current default format (2a), and would be a
 
916
                # corner-case anyway.
 
917
                #  - Andrew Bennetts, 2010/06/30
 
918
                self.repository.dont_leave_lock_in_place()
 
919
            old_lock_count = 0
 
920
            while True:
 
921
                try:
 
922
                    old_repository.unlock()
 
923
                except errors.LockNotHeld:
 
924
                    break
 
925
                old_lock_count += 1
 
926
            if old_lock_count == 0:
 
927
                raise AssertionError(
 
928
                    'old_repository should have been locked at least once.')
 
929
            for i in range(old_lock_count-1):
 
930
                self.repository.lock_write()
 
931
            # Fetch from the old repository into the new.
788
932
            old_repository.lock_read()
789
933
            try:
790
 
                # Repositories don't offer an interface to remove fallback
791
 
                # repositories today; take the conceptually simpler option and just
792
 
                # reopen it.  We reopen it starting from the URL so that we
793
 
                # get a separate connection for RemoteRepositories and can
794
 
                # stream from one of them to the other.  This does mean doing
795
 
                # separate SSH connection setup, but unstacking is not a
796
 
                # common operation so it's tolerable.
797
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
798
 
                new_repository = new_bzrdir.find_repository()
799
 
                self.repository = new_repository
800
 
                if self.repository._fallback_repositories:
801
 
                    raise AssertionError("didn't expect %r to have "
802
 
                        "fallback_repositories"
803
 
                        % (self.repository,))
804
 
                # this is not paired with an unlock because it's just restoring
805
 
                # the previous state; the lock's released when set_stacked_on_url
806
 
                # returns
807
 
                self.repository.lock_write()
808
934
                # XXX: If you unstack a branch while it has a working tree
809
935
                # with a pending merge, the pending-merged revisions will no
810
936
                # longer be present.  You can (probably) revert and remerge.
811
 
                #
812
 
                # XXX: This only fetches up to the tip of the repository; it
813
 
                # doesn't bring across any tags.  That's fairly consistent
814
 
                # with how branch works, but perhaps not ideal.
815
 
                self.repository.fetch(old_repository,
816
 
                    revision_id=self.last_revision(),
817
 
                    find_ghosts=True)
 
937
                try:
 
938
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
939
                except errors.TagsNotSupported:
 
940
                    tags_to_fetch = set()
 
941
                fetch_spec = vf_search.NotInOtherForRevs(self.repository,
 
942
                    old_repository, required_ids=[self.last_revision()],
 
943
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
944
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
818
945
            finally:
819
946
                old_repository.unlock()
820
947
        finally:
825
952
 
826
953
        :seealso: Branch._get_tags_bytes.
827
954
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
955
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
 
956
        op.add_cleanup(self.lock_write().unlock)
 
957
        return op.run_simple(bytes)
 
958
 
 
959
    def _set_tags_bytes_locked(self, bytes):
 
960
        self._tags_bytes = bytes
 
961
        return self._transport.put_bytes('tags', bytes)
830
962
 
831
963
    def _cache_revision_history(self, rev_history):
832
964
        """Set the cached revision history to rev_history.
859
991
        self._revision_history_cache = None
860
992
        self._revision_id_to_revno_cache = None
861
993
        self._last_revision_info_cache = None
 
994
        self._master_branch_cache = None
862
995
        self._merge_sorted_revisions_cache = None
863
996
        self._partial_revision_history_cache = []
864
997
        self._partial_revision_id_to_revno_cache = {}
 
998
        self._tags_bytes = None
865
999
 
866
1000
    def _gen_revision_history(self):
867
1001
        """Return sequence of revision hashes on to this branch.
878
1012
        """
879
1013
        raise NotImplementedError(self._gen_revision_history)
880
1014
 
 
1015
    @deprecated_method(deprecated_in((2, 5, 0)))
881
1016
    @needs_read_lock
882
1017
    def revision_history(self):
883
1018
        """Return sequence of revision ids on this branch.
885
1020
        This method will cache the revision history for as long as it is safe to
886
1021
        do so.
887
1022
        """
 
1023
        return self._revision_history()
 
1024
 
 
1025
    def _revision_history(self):
888
1026
        if 'evil' in debug.debug_flags:
889
1027
            mutter_callsite(3, "revision_history scales with history.")
890
1028
        if self._revision_history_cache is not None:
917
1055
        :return: A tuple (revno, revision_id).
918
1056
        """
919
1057
        if self._last_revision_info_cache is None:
920
 
            self._last_revision_info_cache = self._last_revision_info()
 
1058
            self._last_revision_info_cache = self._read_last_revision_info()
921
1059
        return self._last_revision_info_cache
922
1060
 
923
 
    def _last_revision_info(self):
924
 
        rh = self.revision_history()
925
 
        revno = len(rh)
926
 
        if revno:
927
 
            return (revno, rh[-1])
928
 
        else:
929
 
            return (0, _mod_revision.NULL_REVISION)
930
 
 
931
 
    @deprecated_method(deprecated_in((1, 6, 0)))
932
 
    def missing_revisions(self, other, stop_revision=None):
933
 
        """Return a list of new revisions that would perfectly fit.
934
 
 
935
 
        If self and other have not diverged, return a list of the revisions
936
 
        present in other, but missing from self.
937
 
        """
938
 
        self_history = self.revision_history()
939
 
        self_len = len(self_history)
940
 
        other_history = other.revision_history()
941
 
        other_len = len(other_history)
942
 
        common_index = min(self_len, other_len) -1
943
 
        if common_index >= 0 and \
944
 
            self_history[common_index] != other_history[common_index]:
945
 
            raise errors.DivergedBranches(self, other)
946
 
 
947
 
        if stop_revision is None:
948
 
            stop_revision = other_len
949
 
        else:
950
 
            if stop_revision > other_len:
951
 
                raise errors.NoSuchRevision(self, stop_revision)
952
 
        return other_history[self_len:stop_revision]
953
 
 
954
 
    @needs_write_lock
955
 
    def update_revisions(self, other, stop_revision=None, overwrite=False,
956
 
                         graph=None):
957
 
        """Pull in new perfect-fit revisions.
958
 
 
959
 
        :param other: Another Branch to pull from
960
 
        :param stop_revision: Updated until the given revision
961
 
        :param overwrite: Always set the branch pointer, rather than checking
962
 
            to see if it is a proper descendant.
963
 
        :param graph: A Graph object that can be used to query history
964
 
            information. This can be None.
965
 
        :return: None
966
 
        """
967
 
        return InterBranch.get(other, self).update_revisions(stop_revision,
968
 
            overwrite, graph)
969
 
 
 
1061
    def _read_last_revision_info(self):
 
1062
        raise NotImplementedError(self._read_last_revision_info)
 
1063
 
 
1064
    @deprecated_method(deprecated_in((2, 4, 0)))
970
1065
    def import_last_revision_info(self, source_repo, revno, revid):
971
1066
        """Set the last revision info, importing from another repo if necessary.
972
1067
 
973
 
        This is used by the bound branch code to upload a revision to
974
 
        the master branch first before updating the tip of the local branch.
975
 
 
976
1068
        :param source_repo: Source repository to optionally fetch from
977
1069
        :param revno: Revision number of the new tip
978
1070
        :param revid: Revision id of the new tip
981
1073
            self.repository.fetch(source_repo, revision_id=revid)
982
1074
        self.set_last_revision_info(revno, revid)
983
1075
 
 
1076
    def import_last_revision_info_and_tags(self, source, revno, revid,
 
1077
                                           lossy=False):
 
1078
        """Set the last revision info, importing from another repo if necessary.
 
1079
 
 
1080
        This is used by the bound branch code to upload a revision to
 
1081
        the master branch first before updating the tip of the local branch.
 
1082
        Revisions referenced by source's tags are also transferred.
 
1083
 
 
1084
        :param source: Source branch to optionally fetch from
 
1085
        :param revno: Revision number of the new tip
 
1086
        :param revid: Revision id of the new tip
 
1087
        :param lossy: Whether to discard metadata that can not be
 
1088
            natively represented
 
1089
        :return: Tuple with the new revision number and revision id
 
1090
            (should only be different from the arguments when lossy=True)
 
1091
        """
 
1092
        if not self.repository.has_same_location(source.repository):
 
1093
            self.fetch(source, revid)
 
1094
        self.set_last_revision_info(revno, revid)
 
1095
        return (revno, revid)
 
1096
 
984
1097
    def revision_id_to_revno(self, revision_id):
985
1098
        """Given a revision id, return its revno"""
986
1099
        if _mod_revision.is_null(revision_id):
987
1100
            return 0
988
 
        history = self.revision_history()
 
1101
        history = self._revision_history()
989
1102
        try:
990
1103
            return history.index(revision_id) + 1
991
1104
        except ValueError:
1006
1119
            self._extend_partial_history(distance_from_last)
1007
1120
        return self._partial_revision_history_cache[distance_from_last]
1008
1121
 
1009
 
    @needs_write_lock
1010
1122
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1123
             possible_transports=None, *args, **kwargs):
1012
1124
        """Mirror source into this branch.
1019
1131
            stop_revision=stop_revision,
1020
1132
            possible_transports=possible_transports, *args, **kwargs)
1021
1133
 
1022
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
 
        **kwargs):
 
1134
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
 
1135
            *args, **kwargs):
1024
1136
        """Mirror this branch into target.
1025
1137
 
1026
1138
        This branch is considered to be 'local', having low latency.
1027
1139
        """
1028
1140
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1029
 
            *args, **kwargs)
1030
 
 
1031
 
    def lossy_push(self, target, stop_revision=None):
1032
 
        """Push deltas into another branch.
1033
 
 
1034
 
        :note: This does not, like push, retain the revision ids from 
1035
 
            the source branch and will, rather than adding bzr-specific 
1036
 
            metadata, push only those semantics of the revision that can be 
1037
 
            natively represented by this branch' VCS.
1038
 
 
1039
 
        :param target: Target branch
1040
 
        :param stop_revision: Revision to push, defaults to last revision.
1041
 
        :return: BranchPushResult with an extra member revidmap: 
1042
 
            A dictionary mapping revision ids from the target branch 
1043
 
            to new revision ids in the target branch, for each 
1044
 
            revision that was pushed.
1045
 
        """
1046
 
        inter = InterBranch.get(self, target)
1047
 
        lossy_push = getattr(inter, "lossy_push", None)
1048
 
        if lossy_push is None:
1049
 
            raise errors.LossyPushToSameVCS(self, target)
1050
 
        return lossy_push(stop_revision)
 
1141
            lossy, *args, **kwargs)
1051
1142
 
1052
1143
    def basis_tree(self):
1053
1144
        """Return `Tree` object for last revision."""
1208
1299
        return result
1209
1300
 
1210
1301
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1302
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1303
            repository=None):
1212
1304
        """Create a new line of development from the branch, into to_bzrdir.
1213
1305
 
1214
1306
        to_bzrdir controls the branch format.
1219
1311
        if (repository_policy is not None and
1220
1312
            repository_policy.requires_stacking()):
1221
1313
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
 
        result = to_bzrdir.create_branch()
 
1314
        result = to_bzrdir.create_branch(repository=repository)
1223
1315
        result.lock_write()
1224
1316
        try:
1225
1317
            if repository_policy is not None:
1226
1318
                repository_policy.configure_branch(result)
1227
1319
            self.copy_content_into(result, revision_id=revision_id)
1228
 
            result.set_parent(self.bzrdir.root_transport.base)
 
1320
            master_url = self.get_bound_location()
 
1321
            if master_url is None:
 
1322
                result.set_parent(self.bzrdir.root_transport.base)
 
1323
            else:
 
1324
                result.set_parent(master_url)
1229
1325
        finally:
1230
1326
            result.unlock()
1231
1327
        return result
1255
1351
                revno = 1
1256
1352
        destination.set_last_revision_info(revno, revision_id)
1257
1353
 
1258
 
    @needs_read_lock
1259
1354
    def copy_content_into(self, destination, revision_id=None):
1260
1355
        """Copy the content of self into destination.
1261
1356
 
1262
1357
        revision_id: if not None, the revision history in the new branch will
1263
1358
                     be truncated to end with revision_id.
1264
1359
        """
1265
 
        self.update_references(destination)
1266
 
        self._synchronize_history(destination, revision_id)
1267
 
        try:
1268
 
            parent = self.get_parent()
1269
 
        except errors.InaccessibleParent, e:
1270
 
            mutter('parent was not accessible to copy: %s', e)
1271
 
        else:
1272
 
            if parent:
1273
 
                destination.set_parent(parent)
1274
 
        if self._push_should_merge_tags():
1275
 
            self.tags.merge_to(destination.tags)
 
1360
        return InterBranch.get(self, destination).copy_content_into(
 
1361
            revision_id=revision_id)
1276
1362
 
1277
1363
    def update_references(self, target):
1278
1364
        if not getattr(self._format, 'supports_reference_locations', False):
1315
1401
        # TODO: We should probably also check that self.revision_history
1316
1402
        # matches the repository for older branch formats.
1317
1403
        # If looking for the code that cross-checks repository parents against
1318
 
        # the iter_reverse_revision_history output, that is now a repository
 
1404
        # the Graph.iter_lefthand_ancestry output, that is now a repository
1319
1405
        # specific check.
1320
1406
        return result
1321
1407
 
1322
 
    def _get_checkout_format(self):
 
1408
    def _get_checkout_format(self, lightweight=False):
1323
1409
        """Return the most suitable metadir for a checkout of this branch.
1324
1410
        Weaves are used if this branch's repository uses weaves.
1325
1411
        """
1326
 
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1327
 
            from bzrlib.repofmt import weaverepo
1328
 
            format = bzrdir.BzrDirMetaFormat1()
1329
 
            format.repository_format = weaverepo.RepositoryFormat7()
1330
 
        else:
1331
 
            format = self.repository.bzrdir.checkout_metadir()
1332
 
            format.set_branch_format(self._format)
 
1412
        format = self.repository.bzrdir.checkout_metadir()
 
1413
        format.set_branch_format(self._format)
1333
1414
        return format
1334
1415
 
1335
1416
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1417
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1418
        no_tree=None):
1337
1419
        """Create a clone of this branch and its bzrdir.
1338
1420
 
1339
1421
        :param to_transport: The transport to clone onto.
1346
1428
        """
1347
1429
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1430
        # clone call. Or something. 20090224 RBC/spiv.
 
1431
        # XXX: Should this perhaps clone colocated branches as well, 
 
1432
        # rather than just the default branch? 20100319 JRV
1349
1433
        if revision_id is None:
1350
1434
            revision_id = self.last_revision()
1351
1435
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
1436
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1437
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1438
            no_tree=no_tree)
1354
1439
        return dir_to.open_branch()
1355
1440
 
1356
1441
    def create_checkout(self, to_location, revision_id=None,
1361
1446
        :param to_location: The url to produce the checkout at
1362
1447
        :param revision_id: The revision to check out
1363
1448
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1364
 
        produce a bound branch (heavyweight checkout)
 
1449
            produce a bound branch (heavyweight checkout)
1365
1450
        :param accelerator_tree: A tree which can be used for retrieving file
1366
1451
            contents more quickly than the revision tree, i.e. a workingtree.
1367
1452
            The revision tree will be used for cases where accelerator_tree's
1372
1457
        """
1373
1458
        t = transport.get_transport(to_location)
1374
1459
        t.ensure_base()
 
1460
        format = self._get_checkout_format(lightweight=lightweight)
1375
1461
        if lightweight:
1376
 
            format = self._get_checkout_format()
1377
1462
            checkout = format.initialize_on_transport(t)
1378
1463
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
1464
                target_branch=self)
1380
1465
        else:
1381
 
            format = self._get_checkout_format()
1382
 
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
 
1466
            checkout_branch = controldir.ControlDir.create_branch_convenience(
1383
1467
                to_location, force_new_tree=False, format=format)
1384
1468
            checkout = checkout_branch.bzrdir
1385
1469
            checkout_branch.bind(self)
1413
1497
 
1414
1498
    def reference_parent(self, file_id, path, possible_transports=None):
1415
1499
        """Return the parent branch for a tree-reference file_id
 
1500
 
1416
1501
        :param file_id: The file_id of the tree reference
1417
1502
        :param path: The path of the file_id in the tree
1418
1503
        :return: A branch associated with the file_id
1471
1556
        else:
1472
1557
            raise AssertionError("invalid heads: %r" % (heads,))
1473
1558
 
1474
 
 
1475
 
class BranchFormat(object):
 
1559
    def heads_to_fetch(self):
 
1560
        """Return the heads that must and that should be fetched to copy this
 
1561
        branch into another repo.
 
1562
 
 
1563
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1564
            set of heads that must be fetched.  if_present_fetch is a set of
 
1565
            heads that must be fetched if present, but no error is necessary if
 
1566
            they are not present.
 
1567
        """
 
1568
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
 
1569
        # are the tags.
 
1570
        must_fetch = set([self.last_revision()])
 
1571
        if_present_fetch = set()
 
1572
        c = self.get_config()
 
1573
        include_tags = c.get_user_option_as_bool('branch.fetch_tags',
 
1574
                                                 default=False)
 
1575
        if include_tags:
 
1576
            try:
 
1577
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1578
            except errors.TagsNotSupported:
 
1579
                pass
 
1580
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1581
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1582
        return must_fetch, if_present_fetch
 
1583
 
 
1584
 
 
1585
class BranchFormat(controldir.ControlComponentFormat):
1476
1586
    """An encapsulation of the initialization and open routines for a format.
1477
1587
 
1478
1588
    Formats provide three things:
1481
1591
     * an open routine.
1482
1592
 
1483
1593
    Formats are placed in an dict by their format string for reference
1484
 
    during branch opening. Its not required that these be instances, they
 
1594
    during branch opening. It's not required that these be instances, they
1485
1595
    can be classes themselves with class methods - it simply depends on
1486
1596
    whether state is needed for a given format or not.
1487
1597
 
1490
1600
    object will be created every time regardless.
1491
1601
    """
1492
1602
 
1493
 
    _default_format = None
1494
 
    """The default format used for new branches."""
1495
 
 
1496
 
    _formats = {}
1497
 
    """The known formats."""
1498
 
 
1499
 
    can_set_append_revisions_only = True
1500
 
 
1501
1603
    def __eq__(self, other):
1502
1604
        return self.__class__ is other.__class__
1503
1605
 
1505
1607
        return not (self == other)
1506
1608
 
1507
1609
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
1509
 
        """Return the format for the branch object in a_bzrdir."""
1510
 
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
 
1610
    def find_format(klass, controldir, name=None):
 
1611
        """Return the format for the branch object in controldir."""
 
1612
        try:
 
1613
            transport = controldir.get_branch_transport(None, name=name)
 
1614
        except errors.NoSuchFile:
 
1615
            raise errors.NotBranchError(path=name, bzrdir=controldir)
 
1616
        try:
1512
1617
            format_string = transport.get_bytes("format")
1513
 
            return klass._formats[format_string]
 
1618
            return format_registry.get(format_string)
1514
1619
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1620
            raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
1516
1621
        except KeyError:
1517
1622
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1623
 
1519
1624
    @classmethod
 
1625
    @deprecated_method(deprecated_in((2, 4, 0)))
1520
1626
    def get_default_format(klass):
1521
1627
        """Return the current default format."""
1522
 
        return klass._default_format
1523
 
 
1524
 
    def get_reference(self, a_bzrdir):
1525
 
        """Get the target reference of the branch in a_bzrdir.
 
1628
        return format_registry.get_default()
 
1629
 
 
1630
    @classmethod
 
1631
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1632
    def get_formats(klass):
 
1633
        """Get all the known formats.
 
1634
 
 
1635
        Warning: This triggers a load of all lazy registered formats: do not
 
1636
        use except when that is desireed.
 
1637
        """
 
1638
        return format_registry._get_all()
 
1639
 
 
1640
    def get_reference(self, controldir, name=None):
 
1641
        """Get the target reference of the branch in controldir.
1526
1642
 
1527
1643
        format probing must have been completed before calling
1528
1644
        this method - it is assumed that the format of the branch
1529
 
        in a_bzrdir is correct.
 
1645
        in controldir is correct.
1530
1646
 
1531
 
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1647
        :param controldir: The controldir to get the branch data from.
 
1648
        :param name: Name of the colocated branch to fetch
1532
1649
        :return: None if the branch is not a reference branch.
1533
1650
        """
1534
1651
        return None
1535
1652
 
1536
1653
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
1538
 
        """Set the target reference of the branch in a_bzrdir.
 
1654
    def set_reference(self, controldir, name, to_branch):
 
1655
        """Set the target reference of the branch in controldir.
1539
1656
 
1540
1657
        format probing must have been completed before calling
1541
1658
        this method - it is assumed that the format of the branch
1542
 
        in a_bzrdir is correct.
 
1659
        in controldir is correct.
1543
1660
 
1544
 
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1661
        :param controldir: The controldir to set the branch reference for.
 
1662
        :param name: Name of colocated branch to set, None for default
1545
1663
        :param to_branch: branch that the checkout is to reference
1546
1664
        """
1547
1665
        raise NotImplementedError(self.set_reference)
1554
1672
        """Return the short format description for this format."""
1555
1673
        raise NotImplementedError(self.get_format_description)
1556
1674
 
1557
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
 
1675
    def _run_post_branch_init_hooks(self, controldir, name, branch):
1558
1676
        hooks = Branch.hooks['post_branch_init']
1559
1677
        if not hooks:
1560
1678
            return
1561
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
 
1679
        params = BranchInitHookParams(self, controldir, name, branch)
1562
1680
        for hook in hooks:
1563
1681
            hook(params)
1564
1682
 
1565
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
 
                           lock_type='metadir', set_format=True):
1567
 
        """Initialize a branch in a bzrdir, with specified files
1568
 
 
1569
 
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
 
        :param utf8_files: The files to create as a list of
1571
 
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
 
        :param set_format: If True, set the format with
1574
 
            self.get_format_string.  (BzrBranch4 has its format set
1575
 
            elsewhere)
1576
 
        :return: a branch in this format
1577
 
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1580
 
        lock_map = {
1581
 
            'metadir': ('lock', lockdir.LockDir),
1582
 
            'branch4': ('branch-lock', lockable_files.TransportLock),
1583
 
        }
1584
 
        lock_name, lock_class = lock_map[lock_type]
1585
 
        control_files = lockable_files.LockableFiles(branch_transport,
1586
 
            lock_name, lock_class)
1587
 
        control_files.create_lock()
1588
 
        try:
1589
 
            control_files.lock_write()
1590
 
        except errors.LockContention:
1591
 
            if lock_type != 'branch4':
1592
 
                raise
1593
 
            lock_taken = False
1594
 
        else:
1595
 
            lock_taken = True
1596
 
        if set_format:
1597
 
            utf8_files += [('format', self.get_format_string())]
1598
 
        try:
1599
 
            for (filename, content) in utf8_files:
1600
 
                branch_transport.put_bytes(
1601
 
                    filename, content,
1602
 
                    mode=a_bzrdir._get_file_mode())
1603
 
        finally:
1604
 
            if lock_taken:
1605
 
                control_files.unlock()
1606
 
        branch = self.open(a_bzrdir, name, _found=True)
1607
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1608
 
        return branch
1609
 
 
1610
 
    def initialize(self, a_bzrdir, name=None):
1611
 
        """Create a branch of this format in a_bzrdir.
1612
 
        
 
1683
    def initialize(self, controldir, name=None, repository=None,
 
1684
                   append_revisions_only=None):
 
1685
        """Create a branch of this format in controldir.
 
1686
 
1613
1687
        :param name: Name of the colocated branch to create.
1614
1688
        """
1615
1689
        raise NotImplementedError(self.initialize)
1635
1709
        Note that it is normal for branch to be a RemoteBranch when using tags
1636
1710
        on a RemoteBranch.
1637
1711
        """
1638
 
        return DisabledTags(branch)
 
1712
        return _mod_tag.DisabledTags(branch)
1639
1713
 
1640
1714
    def network_name(self):
1641
1715
        """A simple byte string uniquely identifying this format for RPC calls.
1647
1721
        """
1648
1722
        raise NotImplementedError(self.network_name)
1649
1723
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1651
 
        """Return the branch object for a_bzrdir
 
1724
    def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
 
1725
            found_repository=None, possible_transports=None):
 
1726
        """Return the branch object for controldir.
1652
1727
 
1653
 
        :param a_bzrdir: A BzrDir that contains a branch.
 
1728
        :param controldir: A ControlDir that contains a branch.
1654
1729
        :param name: Name of colocated branch to open
1655
1730
        :param _found: a private parameter, do not use it. It is used to
1656
1731
            indicate if format probing has already be done.
1660
1735
        raise NotImplementedError(self.open)
1661
1736
 
1662
1737
    @classmethod
 
1738
    @deprecated_method(deprecated_in((2, 4, 0)))
1663
1739
    def register_format(klass, format):
1664
 
        """Register a metadir format."""
1665
 
        klass._formats[format.get_format_string()] = format
1666
 
        # Metadir formats have a network name of their format string, and get
1667
 
        # registered as class factories.
1668
 
        network_format_registry.register(format.get_format_string(), format.__class__)
 
1740
        """Register a metadir format.
 
1741
 
 
1742
        See MetaDirBranchFormatFactory for the ability to register a format
 
1743
        without loading the code the format needs until it is actually used.
 
1744
        """
 
1745
        format_registry.register(format)
1669
1746
 
1670
1747
    @classmethod
 
1748
    @deprecated_method(deprecated_in((2, 4, 0)))
1671
1749
    def set_default_format(klass, format):
1672
 
        klass._default_format = format
 
1750
        format_registry.set_default(format)
1673
1751
 
1674
1752
    def supports_set_append_revisions_only(self):
1675
1753
        """True if this format supports set_append_revisions_only."""
1679
1757
        """True if this format records a stacked-on branch."""
1680
1758
        return False
1681
1759
 
 
1760
    def supports_leaving_lock(self):
 
1761
        """True if this format supports leaving locks in place."""
 
1762
        return False # by default
 
1763
 
1682
1764
    @classmethod
 
1765
    @deprecated_method(deprecated_in((2, 4, 0)))
1683
1766
    def unregister_format(klass, format):
1684
 
        del klass._formats[format.get_format_string()]
 
1767
        format_registry.remove(format)
1685
1768
 
1686
1769
    def __str__(self):
1687
1770
        return self.get_format_description().rstrip()
1690
1773
        """True if this format supports tags stored in the branch"""
1691
1774
        return False  # by default
1692
1775
 
 
1776
    def tags_are_versioned(self):
 
1777
        """Whether the tag container for this branch versions tags."""
 
1778
        return False
 
1779
 
 
1780
    def supports_tags_referencing_ghosts(self):
 
1781
        """True if tags can reference ghost revisions."""
 
1782
        return True
 
1783
 
 
1784
 
 
1785
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1786
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1787
    
 
1788
    While none of the built in BranchFormats are lazy registered yet,
 
1789
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1790
    use it, and the bzr-loom plugin uses it as well (see
 
1791
    bzrlib.plugins.loom.formats).
 
1792
    """
 
1793
 
 
1794
    def __init__(self, format_string, module_name, member_name):
 
1795
        """Create a MetaDirBranchFormatFactory.
 
1796
 
 
1797
        :param format_string: The format string the format has.
 
1798
        :param module_name: Module to load the format class from.
 
1799
        :param member_name: Attribute name within the module for the format class.
 
1800
        """
 
1801
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1802
        self._format_string = format_string
 
1803
        
 
1804
    def get_format_string(self):
 
1805
        """See BranchFormat.get_format_string."""
 
1806
        return self._format_string
 
1807
 
 
1808
    def __call__(self):
 
1809
        """Used for network_format_registry support."""
 
1810
        return self.get_obj()()
 
1811
 
1693
1812
 
1694
1813
class BranchHooks(Hooks):
1695
1814
    """A dictionary mapping hook name to a list of callables for branch hooks.
1704
1823
        These are all empty initially, because by default nothing should get
1705
1824
        notified.
1706
1825
        """
1707
 
        Hooks.__init__(self)
1708
 
        self.create_hook(HookPoint('set_rh',
 
1826
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1827
        self.add_hook('set_rh',
1709
1828
            "Invoked whenever the revision history has been set via "
1710
1829
            "set_revision_history. The api signature is (branch, "
1711
1830
            "revision_history), and the branch will be write-locked. "
1712
1831
            "The set_rh hook can be expensive for bzr to trigger, a better "
1713
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1714
 
        self.create_hook(HookPoint('open',
 
1832
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
 
1833
        self.add_hook('open',
1715
1834
            "Called with the Branch object that has been opened after a "
1716
 
            "branch is opened.", (1, 8), None))
1717
 
        self.create_hook(HookPoint('post_push',
 
1835
            "branch is opened.", (1, 8))
 
1836
        self.add_hook('post_push',
1718
1837
            "Called after a push operation completes. post_push is called "
1719
1838
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
 
            "bzr client.", (0, 15), None))
1721
 
        self.create_hook(HookPoint('post_pull',
 
1839
            "bzr client.", (0, 15))
 
1840
        self.add_hook('post_pull',
1722
1841
            "Called after a pull operation completes. post_pull is called "
1723
1842
            "with a bzrlib.branch.PullResult object and only runs in the "
1724
 
            "bzr client.", (0, 15), None))
1725
 
        self.create_hook(HookPoint('pre_commit',
1726
 
            "Called after a commit is calculated but before it is is "
 
1843
            "bzr client.", (0, 15))
 
1844
        self.add_hook('pre_commit',
 
1845
            "Called after a commit is calculated but before it is "
1727
1846
            "completed. pre_commit is called with (local, master, old_revno, "
1728
1847
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
1848
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1731
1850
            "basis revision. hooks MUST NOT modify this delta. "
1732
1851
            " future_tree is an in-memory tree obtained from "
1733
1852
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
 
            "tree.", (0,91), None))
1735
 
        self.create_hook(HookPoint('post_commit',
 
1853
            "tree.", (0,91))
 
1854
        self.add_hook('post_commit',
1736
1855
            "Called in the bzr client after a commit has completed. "
1737
1856
            "post_commit is called with (local, master, old_revno, old_revid, "
1738
1857
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1739
 
            "commit to a branch.", (0, 15), None))
1740
 
        self.create_hook(HookPoint('post_uncommit',
 
1858
            "commit to a branch.", (0, 15))
 
1859
        self.add_hook('post_uncommit',
1741
1860
            "Called in the bzr client after an uncommit completes. "
1742
1861
            "post_uncommit is called with (local, master, old_revno, "
1743
1862
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
1863
            "or None, master is the target branch, and an empty branch "
1745
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1746
 
        self.create_hook(HookPoint('pre_change_branch_tip',
 
1864
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1865
        self.add_hook('pre_change_branch_tip',
1747
1866
            "Called in bzr client and server before a change to the tip of a "
1748
1867
            "branch is made. pre_change_branch_tip is called with a "
1749
1868
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1750
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1751
 
        self.create_hook(HookPoint('post_change_branch_tip',
 
1869
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1870
        self.add_hook('post_change_branch_tip',
1752
1871
            "Called in bzr client and server after a change to the tip of a "
1753
1872
            "branch is made. post_change_branch_tip is called with a "
1754
1873
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1755
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1756
 
        self.create_hook(HookPoint('transform_fallback_location',
 
1874
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1875
        self.add_hook('transform_fallback_location',
1757
1876
            "Called when a stacked branch is activating its fallback "
1758
1877
            "locations. transform_fallback_location is called with (branch, "
1759
1878
            "url), and should return a new url. Returning the same url "
1764
1883
            "fallback locations have not been activated. When there are "
1765
1884
            "multiple hooks installed for transform_fallback_location, "
1766
1885
            "all are called with the url returned from the previous hook."
1767
 
            "The order is however undefined.", (1, 9), None))
1768
 
        self.create_hook(HookPoint('automatic_tag_name',
1769
 
            "Called to determine an automatic tag name for a revision."
 
1886
            "The order is however undefined.", (1, 9))
 
1887
        self.add_hook('automatic_tag_name',
 
1888
            "Called to determine an automatic tag name for a revision. "
1770
1889
            "automatic_tag_name is called with (branch, revision_id) and "
1771
1890
            "should return a tag name or None if no tag name could be "
1772
1891
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
 
1892
            (2, 2))
 
1893
        self.add_hook('post_branch_init',
1775
1894
            "Called after new branch initialization completes. "
1776
1895
            "post_branch_init is called with a "
1777
1896
            "bzrlib.branch.BranchInitHookParams. "
1778
1897
            "Note that init, branch and checkout (both heavyweight and "
1779
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1780
 
        self.create_hook(HookPoint('post_switch',
 
1898
            "lightweight) will all trigger this hook.", (2, 2))
 
1899
        self.add_hook('post_switch',
1781
1900
            "Called after a checkout switches branch. "
1782
1901
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1902
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1784
1903
 
1785
1904
 
1786
1905
 
1789
1908
 
1790
1909
 
1791
1910
class ChangeBranchTipParams(object):
1792
 
    """Object holding parameters passed to *_change_branch_tip hooks.
 
1911
    """Object holding parameters passed to `*_change_branch_tip` hooks.
1793
1912
 
1794
1913
    There are 5 fields that hooks may wish to access:
1795
1914
 
1827
1946
 
1828
1947
 
1829
1948
class BranchInitHookParams(object):
1830
 
    """Object holding parameters passed to *_branch_init hooks.
 
1949
    """Object holding parameters passed to `*_branch_init` hooks.
1831
1950
 
1832
1951
    There are 4 fields that hooks may wish to access:
1833
1952
 
1834
1953
    :ivar format: the branch format
1835
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
 
1954
    :ivar bzrdir: the ControlDir where the branch will be/has been initialized
1836
1955
    :ivar name: name of colocated branch, if any (or None)
1837
1956
    :ivar branch: the branch created
1838
1957
 
1841
1960
    branch, which refer to the original branch.
1842
1961
    """
1843
1962
 
1844
 
    def __init__(self, format, a_bzrdir, name, branch):
 
1963
    def __init__(self, format, controldir, name, branch):
1845
1964
        """Create a group of BranchInitHook parameters.
1846
1965
 
1847
1966
        :param format: the branch format
1848
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
 
1967
        :param controldir: the ControlDir where the branch will be/has been
1849
1968
            initialized
1850
1969
        :param name: name of colocated branch, if any (or None)
1851
1970
        :param branch: the branch created
1855
1974
        in branch, which refer to the original branch.
1856
1975
        """
1857
1976
        self.format = format
1858
 
        self.bzrdir = a_bzrdir
 
1977
        self.bzrdir = controldir
1859
1978
        self.name = name
1860
1979
        self.branch = branch
1861
1980
 
1863
1982
        return self.__dict__ == other.__dict__
1864
1983
 
1865
1984
    def __repr__(self):
1866
 
        if self.branch:
1867
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1868
 
        else:
1869
 
            return "<%s of format:%s bzrdir:%s>" % (
1870
 
                self.__class__.__name__, self.branch,
1871
 
                self.format, self.bzrdir)
 
1985
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1872
1986
 
1873
1987
 
1874
1988
class SwitchHookParams(object):
1875
 
    """Object holding parameters passed to *_switch hooks.
 
1989
    """Object holding parameters passed to `*_switch` hooks.
1876
1990
 
1877
1991
    There are 4 fields that hooks may wish to access:
1878
1992
 
1879
 
    :ivar control_dir: BzrDir of the checkout to change
 
1993
    :ivar control_dir: ControlDir of the checkout to change
1880
1994
    :ivar to_branch: branch that the checkout is to reference
1881
1995
    :ivar force: skip the check for local commits in a heavy checkout
1882
1996
    :ivar revision_id: revision ID to switch to (or None)
1885
1999
    def __init__(self, control_dir, to_branch, force, revision_id):
1886
2000
        """Create a group of SwitchHook parameters.
1887
2001
 
1888
 
        :param control_dir: BzrDir of the checkout to change
 
2002
        :param control_dir: ControlDir of the checkout to change
1889
2003
        :param to_branch: branch that the checkout is to reference
1890
2004
        :param force: skip the check for local commits in a heavy checkout
1891
2005
        :param revision_id: revision ID to switch to (or None)
1904
2018
            self.revision_id)
1905
2019
 
1906
2020
 
1907
 
class BzrBranchFormat4(BranchFormat):
1908
 
    """Bzr branch format 4.
1909
 
 
1910
 
    This format has:
1911
 
     - a revision-history file.
1912
 
     - a branch-lock lock file [ to be shared with the bzrdir ]
1913
 
    """
1914
 
 
1915
 
    def get_format_description(self):
1916
 
        """See BranchFormat.get_format_description()."""
1917
 
        return "Branch format 4"
1918
 
 
1919
 
    def initialize(self, a_bzrdir, name=None):
1920
 
        """Create a branch of this format in a_bzrdir."""
1921
 
        utf8_files = [('revision-history', ''),
1922
 
                      ('branch-name', ''),
1923
 
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1925
 
                                       lock_type='branch4', set_format=False)
1926
 
 
1927
 
    def __init__(self):
1928
 
        super(BzrBranchFormat4, self).__init__()
1929
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1930
 
 
1931
 
    def network_name(self):
1932
 
        """The network name for this format is the control dirs disk label."""
1933
 
        return self._matchingbzrdir.get_format_string()
1934
 
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1936
 
        """See BranchFormat.open()."""
1937
 
        if not _found:
1938
 
            # we are being called directly and must probe.
1939
 
            raise NotImplementedError
1940
 
        return BzrBranch(_format=self,
1941
 
                         _control_files=a_bzrdir._control_files,
1942
 
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
 
                         _repository=a_bzrdir.open_repository())
1945
 
 
1946
 
    def __str__(self):
1947
 
        return "Bazaar-NG branch format 4"
1948
 
 
1949
 
 
1950
2021
class BranchFormatMetadir(BranchFormat):
1951
2022
    """Common logic for meta-dir based branch formats."""
1952
2023
 
1954
2025
        """What class to instantiate on open calls."""
1955
2026
        raise NotImplementedError(self._branch_class)
1956
2027
 
 
2028
    def _get_initial_config(self, append_revisions_only=None):
 
2029
        if append_revisions_only:
 
2030
            return "append_revisions_only = True\n"
 
2031
        else:
 
2032
            # Avoid writing anything if append_revisions_only is disabled,
 
2033
            # as that is the default.
 
2034
            return ""
 
2035
 
 
2036
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
2037
                           repository=None):
 
2038
        """Initialize a branch in a bzrdir, with specified files
 
2039
 
 
2040
        :param a_bzrdir: The bzrdir to initialize the branch in
 
2041
        :param utf8_files: The files to create as a list of
 
2042
            (filename, content) tuples
 
2043
        :param name: Name of colocated branch to create, if any
 
2044
        :return: a branch in this format
 
2045
        """
 
2046
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
2047
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
2048
        control_files = lockable_files.LockableFiles(branch_transport,
 
2049
            'lock', lockdir.LockDir)
 
2050
        control_files.create_lock()
 
2051
        control_files.lock_write()
 
2052
        try:
 
2053
            utf8_files += [('format', self.get_format_string())]
 
2054
            for (filename, content) in utf8_files:
 
2055
                branch_transport.put_bytes(
 
2056
                    filename, content,
 
2057
                    mode=a_bzrdir._get_file_mode())
 
2058
        finally:
 
2059
            control_files.unlock()
 
2060
        branch = self.open(a_bzrdir, name, _found=True,
 
2061
                found_repository=repository)
 
2062
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2063
        return branch
 
2064
 
1957
2065
    def network_name(self):
1958
2066
        """A simple byte string uniquely identifying this format for RPC calls.
1959
2067
 
1961
2069
        """
1962
2070
        return self.get_format_string()
1963
2071
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2072
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2073
            found_repository=None, possible_transports=None):
1965
2074
        """See BranchFormat.open()."""
1966
2075
        if not _found:
1967
2076
            format = BranchFormat.find_format(a_bzrdir, name=name)
1972
2081
        try:
1973
2082
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
2083
                                                         lockdir.LockDir)
 
2084
            if found_repository is None:
 
2085
                found_repository = a_bzrdir.find_repository()
1975
2086
            return self._branch_class()(_format=self,
1976
2087
                              _control_files=control_files,
1977
2088
                              name=name,
1978
2089
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
1980
 
                              ignore_fallbacks=ignore_fallbacks)
 
2090
                              _repository=found_repository,
 
2091
                              ignore_fallbacks=ignore_fallbacks,
 
2092
                              possible_transports=possible_transports)
1981
2093
        except errors.NoSuchFile:
1982
2094
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1983
2095
 
1984
 
    def __init__(self):
1985
 
        super(BranchFormatMetadir, self).__init__()
1986
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1987
 
        self._matchingbzrdir.set_branch_format(self)
 
2096
    @property
 
2097
    def _matchingbzrdir(self):
 
2098
        ret = bzrdir.BzrDirMetaFormat1()
 
2099
        ret.set_branch_format(self)
 
2100
        return ret
1988
2101
 
1989
2102
    def supports_tags(self):
1990
2103
        return True
1991
2104
 
 
2105
    def supports_leaving_lock(self):
 
2106
        return True
 
2107
 
1992
2108
 
1993
2109
class BzrBranchFormat5(BranchFormatMetadir):
1994
2110
    """Bzr branch format 5.
2014
2130
        """See BranchFormat.get_format_description()."""
2015
2131
        return "Branch format 5"
2016
2132
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
2133
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2134
                   append_revisions_only=None):
2018
2135
        """Create a branch of this format in a_bzrdir."""
 
2136
        if append_revisions_only:
 
2137
            raise errors.UpgradeRequired(a_bzrdir.user_url)
2019
2138
        utf8_files = [('revision-history', ''),
2020
2139
                      ('branch-name', ''),
2021
2140
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2141
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2023
2142
 
2024
2143
    def supports_tags(self):
2025
2144
        return False
2047
2166
        """See BranchFormat.get_format_description()."""
2048
2167
        return "Branch format 6"
2049
2168
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
2169
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2170
                   append_revisions_only=None):
2051
2171
        """Create a branch of this format in a_bzrdir."""
2052
2172
        utf8_files = [('last-revision', '0 null:\n'),
2053
 
                      ('branch.conf', ''),
 
2173
                      ('branch.conf',
 
2174
                          self._get_initial_config(append_revisions_only)),
2054
2175
                      ('tags', ''),
2055
2176
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2177
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2057
2178
 
2058
2179
    def make_tags(self, branch):
2059
2180
        """See bzrlib.branch.BranchFormat.make_tags()."""
2060
 
        return BasicTags(branch)
 
2181
        return _mod_tag.BasicTags(branch)
2061
2182
 
2062
2183
    def supports_set_append_revisions_only(self):
2063
2184
        return True
2077
2198
        """See BranchFormat.get_format_description()."""
2078
2199
        return "Branch format 8"
2079
2200
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
2201
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2202
                   append_revisions_only=None):
2081
2203
        """Create a branch of this format in a_bzrdir."""
2082
2204
        utf8_files = [('last-revision', '0 null:\n'),
2083
 
                      ('branch.conf', ''),
 
2205
                      ('branch.conf',
 
2206
                          self._get_initial_config(append_revisions_only)),
2084
2207
                      ('tags', ''),
2085
2208
                      ('references', '')
2086
2209
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2088
 
 
2089
 
    def __init__(self):
2090
 
        super(BzrBranchFormat8, self).__init__()
2091
 
        self._matchingbzrdir.repository_format = \
2092
 
            RepositoryFormatKnitPack5RichRoot()
 
2210
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2093
2211
 
2094
2212
    def make_tags(self, branch):
2095
2213
        """See bzrlib.branch.BranchFormat.make_tags()."""
2096
 
        return BasicTags(branch)
 
2214
        return _mod_tag.BasicTags(branch)
2097
2215
 
2098
2216
    def supports_set_append_revisions_only(self):
2099
2217
        return True
2104
2222
    supports_reference_locations = True
2105
2223
 
2106
2224
 
2107
 
class BzrBranchFormat7(BzrBranchFormat8):
 
2225
class BzrBranchFormat7(BranchFormatMetadir):
2108
2226
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
2227
 
2110
2228
    The stacked location pointer is passed down to the repository and requires
2113
2231
    This format was introduced in bzr 1.6.
2114
2232
    """
2115
2233
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
2234
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2235
                   append_revisions_only=None):
2117
2236
        """Create a branch of this format in a_bzrdir."""
2118
2237
        utf8_files = [('last-revision', '0 null:\n'),
2119
 
                      ('branch.conf', ''),
 
2238
                      ('branch.conf',
 
2239
                          self._get_initial_config(append_revisions_only)),
2120
2240
                      ('tags', ''),
2121
2241
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2242
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2123
2243
 
2124
2244
    def _branch_class(self):
2125
2245
        return BzrBranch7
2135
2255
    def supports_set_append_revisions_only(self):
2136
2256
        return True
2137
2257
 
 
2258
    def supports_stacking(self):
 
2259
        return True
 
2260
 
 
2261
    def make_tags(self, branch):
 
2262
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2263
        return _mod_tag.BasicTags(branch)
 
2264
 
2138
2265
    supports_reference_locations = False
2139
2266
 
2140
2267
 
2141
 
class BranchReferenceFormat(BranchFormat):
 
2268
class BranchReferenceFormat(BranchFormatMetadir):
2142
2269
    """Bzr branch reference format.
2143
2270
 
2144
2271
    Branch references are used in implementing checkouts, they
2157
2284
        """See BranchFormat.get_format_description()."""
2158
2285
        return "Checkout reference format 1"
2159
2286
 
2160
 
    def get_reference(self, a_bzrdir):
 
2287
    def get_reference(self, a_bzrdir, name=None):
2161
2288
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2289
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2290
        return transport.get_bytes('location')
2164
2291
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2292
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2293
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2294
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2295
        location = transport.put_bytes('location', to_branch.base)
2169
2296
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2297
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2298
            repository=None, append_revisions_only=None):
2171
2299
        """Create a branch of this format in a_bzrdir."""
2172
2300
        if target_branch is None:
2173
2301
            # this format does not implement branch itself, thus the implicit
2174
2302
            # creation contract must see it as uninitializable
2175
2303
            raise errors.UninitializableFormat(self)
2176
2304
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2305
        if a_bzrdir._format.fixed_components:
 
2306
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
2177
2307
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2178
2308
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
2309
            target_branch.user_url)
2180
2310
        branch_transport.put_bytes('format', self.get_format_string())
2181
2311
        branch = self.open(
2182
2312
            a_bzrdir, name, _found=True,
2184
2314
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
2315
        return branch
2186
2316
 
2187
 
    def __init__(self):
2188
 
        super(BranchReferenceFormat, self).__init__()
2189
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2190
 
        self._matchingbzrdir.set_branch_format(self)
2191
 
 
2192
2317
    def _make_reference_clone_function(format, a_branch):
2193
2318
        """Create a clone() routine for a branch dynamically."""
2194
2319
        def clone(to_bzrdir, revision_id=None,
2201
2326
        return clone
2202
2327
 
2203
2328
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
2329
             possible_transports=None, ignore_fallbacks=False,
 
2330
             found_repository=None):
2205
2331
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2332
 
2207
2333
        :param a_bzrdir: A BzrDir that contains a branch.
2221
2347
                raise AssertionError("wrong format %r found for %r" %
2222
2348
                    (format, self))
2223
2349
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
2225
 
        real_bzrdir = bzrdir.BzrDir.open(
 
2350
            location = self.get_reference(a_bzrdir, name)
 
2351
        real_bzrdir = controldir.ControlDir.open(
2226
2352
            location, possible_transports=possible_transports)
2227
2353
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
2354
            ignore_fallbacks=ignore_fallbacks,
 
2355
            possible_transports=possible_transports)
2229
2356
        # this changes the behaviour of result.clone to create a new reference
2230
2357
        # rather than a copy of the content of the branch.
2231
2358
        # I did not use a proxy object because that needs much more extensive
2238
2365
        return result
2239
2366
 
2240
2367
 
 
2368
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2369
    """Branch format registry."""
 
2370
 
 
2371
    def __init__(self, other_registry=None):
 
2372
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2373
        self._default_format = None
 
2374
 
 
2375
    def set_default(self, format):
 
2376
        self._default_format = format
 
2377
 
 
2378
    def get_default(self):
 
2379
        return self._default_format
 
2380
 
 
2381
 
2241
2382
network_format_registry = registry.FormatRegistry()
2242
2383
"""Registry of formats indexed by their network name.
2243
2384
 
2246
2387
BranchFormat.network_name() for more detail.
2247
2388
"""
2248
2389
 
 
2390
format_registry = BranchFormatRegistry(network_format_registry)
 
2391
 
2249
2392
 
2250
2393
# formats which have no format string are not discoverable
2251
2394
# and not independently creatable, so are not registered.
2253
2396
__format6 = BzrBranchFormat6()
2254
2397
__format7 = BzrBranchFormat7()
2255
2398
__format8 = BzrBranchFormat8()
2256
 
BranchFormat.register_format(__format5)
2257
 
BranchFormat.register_format(BranchReferenceFormat())
2258
 
BranchFormat.register_format(__format6)
2259
 
BranchFormat.register_format(__format7)
2260
 
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
2262
 
_legacy_formats = [BzrBranchFormat4(),
2263
 
    ]
2264
 
network_format_registry.register(
2265
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
 
2399
format_registry.register(__format5)
 
2400
format_registry.register(BranchReferenceFormat())
 
2401
format_registry.register(__format6)
 
2402
format_registry.register(__format7)
 
2403
format_registry.register(__format8)
 
2404
format_registry.set_default(__format7)
 
2405
 
 
2406
 
 
2407
class BranchWriteLockResult(LogicalLockResult):
 
2408
    """The result of write locking a branch.
 
2409
 
 
2410
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2411
        None.
 
2412
    :ivar unlock: A callable which will unlock the lock.
 
2413
    """
 
2414
 
 
2415
    def __init__(self, unlock, branch_token):
 
2416
        LogicalLockResult.__init__(self, unlock)
 
2417
        self.branch_token = branch_token
 
2418
 
 
2419
    def __repr__(self):
 
2420
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2421
            self.unlock)
2266
2422
 
2267
2423
 
2268
2424
class BzrBranch(Branch, _RelockDebugMixin):
2283
2439
 
2284
2440
    def __init__(self, _format=None,
2285
2441
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
2442
                 _repository=None, ignore_fallbacks=False,
 
2443
                 possible_transports=None):
2287
2444
        """Create new branch object at a particular location."""
2288
2445
        if a_bzrdir is None:
2289
2446
            raise ValueError('a_bzrdir must be supplied')
2290
2447
        else:
2291
2448
            self.bzrdir = a_bzrdir
2292
 
        self._base = self.bzrdir.transport.clone('..').base
 
2449
        self._user_transport = self.bzrdir.transport.clone('..')
 
2450
        if name is not None:
 
2451
            self._user_transport.set_segment_parameter(
 
2452
                "branch", urlutils.escape(name))
 
2453
        self._base = self._user_transport.base
2293
2454
        self.name = name
2294
 
        # XXX: We should be able to just do
2295
 
        #   self.base = self.bzrdir.root_transport.base
2296
 
        # but this does not quite work yet -- mbp 20080522
2297
2455
        self._format = _format
2298
2456
        if _control_files is None:
2299
2457
            raise ValueError('BzrBranch _control_files is None')
2300
2458
        self.control_files = _control_files
2301
2459
        self._transport = _control_files._transport
2302
2460
        self.repository = _repository
2303
 
        Branch.__init__(self)
 
2461
        Branch.__init__(self, possible_transports)
2304
2462
 
2305
2463
    def __str__(self):
2306
 
        if self.name is None:
2307
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2308
 
        else:
2309
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2310
 
                self.name)
 
2464
        return '%s(%s)' % (self.__class__.__name__, self.user_url)
2311
2465
 
2312
2466
    __repr__ = __str__
2313
2467
 
2317
2471
 
2318
2472
    base = property(_get_base, doc="The URL for the root of this branch.")
2319
2473
 
 
2474
    @property
 
2475
    def user_transport(self):
 
2476
        return self._user_transport
 
2477
 
2320
2478
    def _get_config(self):
2321
 
        return TransportConfig(self._transport, 'branch.conf')
 
2479
        return _mod_config.TransportConfig(self._transport, 'branch.conf')
 
2480
 
 
2481
    def _get_config_store(self):
 
2482
        return _mod_config.BranchStore(self)
2322
2483
 
2323
2484
    def is_locked(self):
2324
2485
        return self.control_files.is_locked()
2325
2486
 
2326
2487
    def lock_write(self, token=None):
 
2488
        """Lock the branch for write operations.
 
2489
 
 
2490
        :param token: A token to permit reacquiring a previously held and
 
2491
            preserved lock.
 
2492
        :return: A BranchWriteLockResult.
 
2493
        """
2327
2494
        if not self.is_locked():
2328
2495
            self._note_lock('w')
2329
2496
        # All-in-one needs to always unlock/lock.
2335
2502
        else:
2336
2503
            took_lock = False
2337
2504
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2505
            return BranchWriteLockResult(self.unlock,
 
2506
                self.control_files.lock_write(token=token))
2339
2507
        except:
2340
2508
            if took_lock:
2341
2509
                self.repository.unlock()
2342
2510
            raise
2343
2511
 
2344
2512
    def lock_read(self):
 
2513
        """Lock the branch for read operations.
 
2514
 
 
2515
        :return: A bzrlib.lock.LogicalLockResult.
 
2516
        """
2345
2517
        if not self.is_locked():
2346
2518
            self._note_lock('r')
2347
2519
        # All-in-one needs to always unlock/lock.
2354
2526
            took_lock = False
2355
2527
        try:
2356
2528
            self.control_files.lock_read()
 
2529
            return LogicalLockResult(self.unlock)
2357
2530
        except:
2358
2531
            if took_lock:
2359
2532
                self.repository.unlock()
2387
2560
        """See Branch.print_file."""
2388
2561
        return self.repository.print_file(file, revision_id)
2389
2562
 
2390
 
    def _write_revision_history(self, history):
2391
 
        """Factored out of set_revision_history.
2392
 
 
2393
 
        This performs the actual writing to disk.
2394
 
        It is intended to be called by BzrBranch5.set_revision_history."""
2395
 
        self._transport.put_bytes(
2396
 
            'revision-history', '\n'.join(history),
2397
 
            mode=self.bzrdir._get_file_mode())
2398
 
 
2399
 
    @needs_write_lock
2400
 
    def set_revision_history(self, rev_history):
2401
 
        """See Branch.set_revision_history."""
2402
 
        if 'evil' in debug.debug_flags:
2403
 
            mutter_callsite(3, "set_revision_history scales with history.")
2404
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2405
 
        for rev_id in rev_history:
2406
 
            check_not_reserved_id(rev_id)
2407
 
        if Branch.hooks['post_change_branch_tip']:
2408
 
            # Don't calculate the last_revision_info() if there are no hooks
2409
 
            # that will use it.
2410
 
            old_revno, old_revid = self.last_revision_info()
2411
 
        if len(rev_history) == 0:
2412
 
            revid = _mod_revision.NULL_REVISION
2413
 
        else:
2414
 
            revid = rev_history[-1]
2415
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2416
 
        self._write_revision_history(rev_history)
2417
 
        self._clear_cached_state()
2418
 
        self._cache_revision_history(rev_history)
2419
 
        for hook in Branch.hooks['set_rh']:
2420
 
            hook(self, rev_history)
2421
 
        if Branch.hooks['post_change_branch_tip']:
2422
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2423
 
 
2424
 
    def _synchronize_history(self, destination, revision_id):
2425
 
        """Synchronize last revision and revision history between branches.
2426
 
 
2427
 
        This version is most efficient when the destination is also a
2428
 
        BzrBranch5, but works for BzrBranch6 as long as the revision
2429
 
        history is the true lefthand parent history, and all of the revisions
2430
 
        are in the destination's repository.  If not, set_revision_history
2431
 
        will fail.
2432
 
 
2433
 
        :param destination: The branch to copy the history into
2434
 
        :param revision_id: The revision-id to truncate history at.  May
2435
 
          be None to copy complete history.
2436
 
        """
2437
 
        if not isinstance(destination._format, BzrBranchFormat5):
2438
 
            super(BzrBranch, self)._synchronize_history(
2439
 
                destination, revision_id)
2440
 
            return
2441
 
        if revision_id == _mod_revision.NULL_REVISION:
2442
 
            new_history = []
2443
 
        else:
2444
 
            new_history = self.revision_history()
2445
 
        if revision_id is not None and new_history != []:
2446
 
            try:
2447
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2448
 
            except ValueError:
2449
 
                rev = self.repository.get_revision(revision_id)
2450
 
                new_history = rev.get_history(self.repository)[1:]
2451
 
        destination.set_revision_history(new_history)
2452
 
 
2453
2563
    @needs_write_lock
2454
2564
    def set_last_revision_info(self, revno, revision_id):
2455
 
        """Set the last revision of this branch.
2456
 
 
2457
 
        The caller is responsible for checking that the revno is correct
2458
 
        for this revision id.
2459
 
 
2460
 
        It may be possible to set the branch last revision to an id not
2461
 
        present in the repository.  However, branches can also be
2462
 
        configured to check constraints on history, in which case this may not
2463
 
        be permitted.
2464
 
        """
 
2565
        if not revision_id or not isinstance(revision_id, basestring):
 
2566
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2465
2567
        revision_id = _mod_revision.ensure_null(revision_id)
2466
 
        # this old format stores the full history, but this api doesn't
2467
 
        # provide it, so we must generate, and might as well check it's
2468
 
        # correct
2469
 
        history = self._lefthand_history(revision_id)
2470
 
        if len(history) != revno:
2471
 
            raise AssertionError('%d != %d' % (len(history), revno))
2472
 
        self.set_revision_history(history)
2473
 
 
2474
 
    def _gen_revision_history(self):
2475
 
        history = self._transport.get_bytes('revision-history').split('\n')
2476
 
        if history[-1:] == ['']:
2477
 
            # There shouldn't be a trailing newline, but just in case.
2478
 
            history.pop()
2479
 
        return history
2480
 
 
2481
 
    @needs_write_lock
2482
 
    def generate_revision_history(self, revision_id, last_rev=None,
2483
 
        other_branch=None):
2484
 
        """Create a new revision history that will finish with revision_id.
2485
 
 
2486
 
        :param revision_id: the new tip to use.
2487
 
        :param last_rev: The previous last_revision. If not None, then this
2488
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
2489
 
        :param other_branch: The other branch that DivergedBranches should
2490
 
            raise with respect to.
2491
 
        """
2492
 
        self.set_revision_history(self._lefthand_history(revision_id,
2493
 
            last_rev, other_branch))
 
2568
        old_revno, old_revid = self.last_revision_info()
 
2569
        if self.get_append_revisions_only():
 
2570
            self._check_history_violation(revision_id)
 
2571
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2572
        self._write_last_revision_info(revno, revision_id)
 
2573
        self._clear_cached_state()
 
2574
        self._last_revision_info_cache = revno, revision_id
 
2575
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2494
2576
 
2495
2577
    def basis_tree(self):
2496
2578
        """See Branch.basis_tree."""
2505
2587
                pass
2506
2588
        return None
2507
2589
 
2508
 
    def _basic_push(self, target, overwrite, stop_revision):
2509
 
        """Basic implementation of push without bound branches or hooks.
2510
 
 
2511
 
        Must be called with source read locked and target write locked.
2512
 
        """
2513
 
        result = BranchPushResult()
2514
 
        result.source_branch = self
2515
 
        result.target_branch = target
2516
 
        result.old_revno, result.old_revid = target.last_revision_info()
2517
 
        self.update_references(target)
2518
 
        if result.old_revid != self.last_revision():
2519
 
            # We assume that during 'push' this repository is closer than
2520
 
            # the target.
2521
 
            graph = self.repository.get_graph(target.repository)
2522
 
            target.update_revisions(self, stop_revision,
2523
 
                overwrite=overwrite, graph=graph)
2524
 
        if self._push_should_merge_tags():
2525
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2526
 
                overwrite)
2527
 
        result.new_revno, result.new_revid = target.last_revision_info()
2528
 
        return result
2529
 
 
2530
2590
    def get_stacked_on_url(self):
2531
2591
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2532
2592
 
2543
2603
            self._transport.put_bytes('parent', url + '\n',
2544
2604
                mode=self.bzrdir._get_file_mode())
2545
2605
 
2546
 
 
2547
 
class BzrBranch5(BzrBranch):
2548
 
    """A format 5 branch. This supports new features over plain branches.
2549
 
 
2550
 
    It has support for a master_branch which is the data for bound branches.
2551
 
    """
2552
 
 
2553
 
    def get_bound_location(self):
2554
 
        try:
2555
 
            return self._transport.get_bytes('bound')[:-1]
2556
 
        except errors.NoSuchFile:
2557
 
            return None
2558
 
 
2559
 
    @needs_read_lock
2560
 
    def get_master_branch(self, possible_transports=None):
2561
 
        """Return the branch we are bound to.
2562
 
 
2563
 
        :return: Either a Branch, or None
2564
 
 
2565
 
        This could memoise the branch, but if thats done
2566
 
        it must be revalidated on each new lock.
2567
 
        So for now we just don't memoise it.
2568
 
        # RBC 20060304 review this decision.
2569
 
        """
2570
 
        bound_loc = self.get_bound_location()
2571
 
        if not bound_loc:
2572
 
            return None
2573
 
        try:
2574
 
            return Branch.open(bound_loc,
2575
 
                               possible_transports=possible_transports)
2576
 
        except (errors.NotBranchError, errors.ConnectionError), e:
2577
 
            raise errors.BoundBranchConnectionFailure(
2578
 
                    self, bound_loc, e)
2579
 
 
2580
2606
    @needs_write_lock
2581
 
    def set_bound_location(self, location):
2582
 
        """Set the target where this branch is bound to.
2583
 
 
2584
 
        :param location: URL to the target branch
2585
 
        """
2586
 
        if location:
2587
 
            self._transport.put_bytes('bound', location+'\n',
2588
 
                mode=self.bzrdir._get_file_mode())
2589
 
        else:
2590
 
            try:
2591
 
                self._transport.delete('bound')
2592
 
            except errors.NoSuchFile:
2593
 
                return False
2594
 
            return True
 
2607
    def unbind(self):
 
2608
        """If bound, unbind"""
 
2609
        return self.set_bound_location(None)
2595
2610
 
2596
2611
    @needs_write_lock
2597
2612
    def bind(self, other):
2619
2634
        # history around
2620
2635
        self.set_bound_location(other.base)
2621
2636
 
 
2637
    def get_bound_location(self):
 
2638
        try:
 
2639
            return self._transport.get_bytes('bound')[:-1]
 
2640
        except errors.NoSuchFile:
 
2641
            return None
 
2642
 
 
2643
    @needs_read_lock
 
2644
    def get_master_branch(self, possible_transports=None):
 
2645
        """Return the branch we are bound to.
 
2646
 
 
2647
        :return: Either a Branch, or None
 
2648
        """
 
2649
        if self._master_branch_cache is None:
 
2650
            self._master_branch_cache = self._get_master_branch(
 
2651
                possible_transports)
 
2652
        return self._master_branch_cache
 
2653
 
 
2654
    def _get_master_branch(self, possible_transports):
 
2655
        bound_loc = self.get_bound_location()
 
2656
        if not bound_loc:
 
2657
            return None
 
2658
        try:
 
2659
            return Branch.open(bound_loc,
 
2660
                               possible_transports=possible_transports)
 
2661
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2662
            raise errors.BoundBranchConnectionFailure(
 
2663
                    self, bound_loc, e)
 
2664
 
2622
2665
    @needs_write_lock
2623
 
    def unbind(self):
2624
 
        """If bound, unbind"""
2625
 
        return self.set_bound_location(None)
 
2666
    def set_bound_location(self, location):
 
2667
        """Set the target where this branch is bound to.
 
2668
 
 
2669
        :param location: URL to the target branch
 
2670
        """
 
2671
        self._master_branch_cache = None
 
2672
        if location:
 
2673
            self._transport.put_bytes('bound', location+'\n',
 
2674
                mode=self.bzrdir._get_file_mode())
 
2675
        else:
 
2676
            try:
 
2677
                self._transport.delete('bound')
 
2678
            except errors.NoSuchFile:
 
2679
                return False
 
2680
            return True
2626
2681
 
2627
2682
    @needs_write_lock
2628
2683
    def update(self, possible_transports=None):
2641
2696
            return old_tip
2642
2697
        return None
2643
2698
 
2644
 
 
2645
 
class BzrBranch8(BzrBranch5):
 
2699
    def _read_last_revision_info(self):
 
2700
        revision_string = self._transport.get_bytes('last-revision')
 
2701
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2702
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2703
        revno = int(revno)
 
2704
        return revno, revision_id
 
2705
 
 
2706
    def _write_last_revision_info(self, revno, revision_id):
 
2707
        """Simply write out the revision id, with no checks.
 
2708
 
 
2709
        Use set_last_revision_info to perform this safely.
 
2710
 
 
2711
        Does not update the revision_history cache.
 
2712
        """
 
2713
        revision_id = _mod_revision.ensure_null(revision_id)
 
2714
        out_string = '%d %s\n' % (revno, revision_id)
 
2715
        self._transport.put_bytes('last-revision', out_string,
 
2716
            mode=self.bzrdir._get_file_mode())
 
2717
 
 
2718
 
 
2719
class FullHistoryBzrBranch(BzrBranch):
 
2720
    """Bzr branch which contains the full revision history."""
 
2721
 
 
2722
    @needs_write_lock
 
2723
    def set_last_revision_info(self, revno, revision_id):
 
2724
        if not revision_id or not isinstance(revision_id, basestring):
 
2725
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2726
        revision_id = _mod_revision.ensure_null(revision_id)
 
2727
        # this old format stores the full history, but this api doesn't
 
2728
        # provide it, so we must generate, and might as well check it's
 
2729
        # correct
 
2730
        history = self._lefthand_history(revision_id)
 
2731
        if len(history) != revno:
 
2732
            raise AssertionError('%d != %d' % (len(history), revno))
 
2733
        self._set_revision_history(history)
 
2734
 
 
2735
    def _read_last_revision_info(self):
 
2736
        rh = self._revision_history()
 
2737
        revno = len(rh)
 
2738
        if revno:
 
2739
            return (revno, rh[-1])
 
2740
        else:
 
2741
            return (0, _mod_revision.NULL_REVISION)
 
2742
 
 
2743
    @deprecated_method(deprecated_in((2, 4, 0)))
 
2744
    @needs_write_lock
 
2745
    def set_revision_history(self, rev_history):
 
2746
        """See Branch.set_revision_history."""
 
2747
        self._set_revision_history(rev_history)
 
2748
 
 
2749
    def _set_revision_history(self, rev_history):
 
2750
        if 'evil' in debug.debug_flags:
 
2751
            mutter_callsite(3, "set_revision_history scales with history.")
 
2752
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2753
        for rev_id in rev_history:
 
2754
            check_not_reserved_id(rev_id)
 
2755
        if Branch.hooks['post_change_branch_tip']:
 
2756
            # Don't calculate the last_revision_info() if there are no hooks
 
2757
            # that will use it.
 
2758
            old_revno, old_revid = self.last_revision_info()
 
2759
        if len(rev_history) == 0:
 
2760
            revid = _mod_revision.NULL_REVISION
 
2761
        else:
 
2762
            revid = rev_history[-1]
 
2763
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2764
        self._write_revision_history(rev_history)
 
2765
        self._clear_cached_state()
 
2766
        self._cache_revision_history(rev_history)
 
2767
        for hook in Branch.hooks['set_rh']:
 
2768
            hook(self, rev_history)
 
2769
        if Branch.hooks['post_change_branch_tip']:
 
2770
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2771
 
 
2772
    def _write_revision_history(self, history):
 
2773
        """Factored out of set_revision_history.
 
2774
 
 
2775
        This performs the actual writing to disk.
 
2776
        It is intended to be called by set_revision_history."""
 
2777
        self._transport.put_bytes(
 
2778
            'revision-history', '\n'.join(history),
 
2779
            mode=self.bzrdir._get_file_mode())
 
2780
 
 
2781
    def _gen_revision_history(self):
 
2782
        history = self._transport.get_bytes('revision-history').split('\n')
 
2783
        if history[-1:] == ['']:
 
2784
            # There shouldn't be a trailing newline, but just in case.
 
2785
            history.pop()
 
2786
        return history
 
2787
 
 
2788
    def _synchronize_history(self, destination, revision_id):
 
2789
        if not isinstance(destination, FullHistoryBzrBranch):
 
2790
            super(BzrBranch, self)._synchronize_history(
 
2791
                destination, revision_id)
 
2792
            return
 
2793
        if revision_id == _mod_revision.NULL_REVISION:
 
2794
            new_history = []
 
2795
        else:
 
2796
            new_history = self._revision_history()
 
2797
        if revision_id is not None and new_history != []:
 
2798
            try:
 
2799
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2800
            except ValueError:
 
2801
                rev = self.repository.get_revision(revision_id)
 
2802
                new_history = rev.get_history(self.repository)[1:]
 
2803
        destination._set_revision_history(new_history)
 
2804
 
 
2805
    @needs_write_lock
 
2806
    def generate_revision_history(self, revision_id, last_rev=None,
 
2807
        other_branch=None):
 
2808
        """Create a new revision history that will finish with revision_id.
 
2809
 
 
2810
        :param revision_id: the new tip to use.
 
2811
        :param last_rev: The previous last_revision. If not None, then this
 
2812
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2813
        :param other_branch: The other branch that DivergedBranches should
 
2814
            raise with respect to.
 
2815
        """
 
2816
        self._set_revision_history(self._lefthand_history(revision_id,
 
2817
            last_rev, other_branch))
 
2818
 
 
2819
 
 
2820
class BzrBranch5(FullHistoryBzrBranch):
 
2821
    """A format 5 branch. This supports new features over plain branches.
 
2822
 
 
2823
    It has support for a master_branch which is the data for bound branches.
 
2824
    """
 
2825
 
 
2826
 
 
2827
class BzrBranch8(BzrBranch):
2646
2828
    """A branch that stores tree-reference locations."""
2647
2829
 
2648
 
    def _open_hook(self):
 
2830
    def _open_hook(self, possible_transports=None):
2649
2831
        if self._ignore_fallbacks:
2650
2832
            return
 
2833
        if possible_transports is None:
 
2834
            possible_transports = [self.bzrdir.root_transport]
2651
2835
        try:
2652
2836
            url = self.get_stacked_on_url()
2653
2837
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2661
2845
                    raise AssertionError(
2662
2846
                        "'transform_fallback_location' hook %s returned "
2663
2847
                        "None, not a URL." % hook_name)
2664
 
            self._activate_fallback_location(url)
 
2848
            self._activate_fallback_location(url,
 
2849
                possible_transports=possible_transports)
2665
2850
 
2666
2851
    def __init__(self, *args, **kwargs):
2667
2852
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2674
2859
        self._last_revision_info_cache = None
2675
2860
        self._reference_info = None
2676
2861
 
2677
 
    def _last_revision_info(self):
2678
 
        revision_string = self._transport.get_bytes('last-revision')
2679
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2680
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2681
 
        revno = int(revno)
2682
 
        return revno, revision_id
2683
 
 
2684
 
    def _write_last_revision_info(self, revno, revision_id):
2685
 
        """Simply write out the revision id, with no checks.
2686
 
 
2687
 
        Use set_last_revision_info to perform this safely.
2688
 
 
2689
 
        Does not update the revision_history cache.
2690
 
        Intended to be called by set_last_revision_info and
2691
 
        _write_revision_history.
2692
 
        """
2693
 
        revision_id = _mod_revision.ensure_null(revision_id)
2694
 
        out_string = '%d %s\n' % (revno, revision_id)
2695
 
        self._transport.put_bytes('last-revision', out_string,
2696
 
            mode=self.bzrdir._get_file_mode())
2697
 
 
2698
 
    @needs_write_lock
2699
 
    def set_last_revision_info(self, revno, revision_id):
2700
 
        revision_id = _mod_revision.ensure_null(revision_id)
2701
 
        old_revno, old_revid = self.last_revision_info()
2702
 
        if self._get_append_revisions_only():
2703
 
            self._check_history_violation(revision_id)
2704
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2705
 
        self._write_last_revision_info(revno, revision_id)
2706
 
        self._clear_cached_state()
2707
 
        self._last_revision_info_cache = revno, revision_id
2708
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2709
 
 
2710
 
    def _synchronize_history(self, destination, revision_id):
2711
 
        """Synchronize last revision and revision history between branches.
2712
 
 
2713
 
        :see: Branch._synchronize_history
2714
 
        """
2715
 
        # XXX: The base Branch has a fast implementation of this method based
2716
 
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2717
 
        # that uses set_revision_history.  This class inherits from BzrBranch5,
2718
 
        # but wants the fast implementation, so it calls
2719
 
        # Branch._synchronize_history directly.
2720
 
        Branch._synchronize_history(self, destination, revision_id)
2721
 
 
2722
2862
    def _check_history_violation(self, revision_id):
2723
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
 
2863
        current_revid = self.last_revision()
 
2864
        last_revision = _mod_revision.ensure_null(current_revid)
2724
2865
        if _mod_revision.is_null(last_revision):
2725
2866
            return
2726
 
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2867
        graph = self.repository.get_graph()
 
2868
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
 
2869
            if lh_ancestor == current_revid:
 
2870
                return
 
2871
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
2728
2872
 
2729
2873
    def _gen_revision_history(self):
2730
2874
        """Generate the revision history from last revision
2733
2877
        self._extend_partial_history(stop_index=last_revno-1)
2734
2878
        return list(reversed(self._partial_revision_history_cache))
2735
2879
 
2736
 
    def _write_revision_history(self, history):
2737
 
        """Factored out of set_revision_history.
2738
 
 
2739
 
        This performs the actual writing to disk, with format-specific checks.
2740
 
        It is intended to be called by BzrBranch5.set_revision_history.
2741
 
        """
2742
 
        if len(history) == 0:
2743
 
            last_revision = 'null:'
2744
 
        else:
2745
 
            if history != self._lefthand_history(history[-1]):
2746
 
                raise errors.NotLefthandHistory(history)
2747
 
            last_revision = history[-1]
2748
 
        if self._get_append_revisions_only():
2749
 
            self._check_history_violation(last_revision)
2750
 
        self._write_last_revision_info(len(history), last_revision)
2751
 
 
2752
2880
    @needs_write_lock
2753
2881
    def _set_parent_location(self, url):
2754
2882
        """Set the parent branch"""
2840
2968
 
2841
2969
    def set_bound_location(self, location):
2842
2970
        """See Branch.set_push_location."""
 
2971
        self._master_branch_cache = None
2843
2972
        result = None
2844
2973
        config = self.get_config()
2845
2974
        if location is None:
2876
3005
        # you can always ask for the URL; but you might not be able to use it
2877
3006
        # if the repo can't support stacking.
2878
3007
        ## self._check_stackable_repo()
2879
 
        stacked_url = self._get_config_location('stacked_on_location')
 
3008
        # stacked_on_location is only ever defined in branch.conf, so don't
 
3009
        # waste effort reading the whole stack of config files.
 
3010
        config = self.get_config()._get_branch_data_config()
 
3011
        stacked_url = self._get_config_location('stacked_on_location',
 
3012
            config=config)
2880
3013
        if stacked_url is None:
2881
3014
            raise errors.NotStacked(self)
2882
3015
        return stacked_url
2883
3016
 
2884
 
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
2887
 
 
2888
 
    @needs_write_lock
2889
 
    def generate_revision_history(self, revision_id, last_rev=None,
2890
 
                                  other_branch=None):
2891
 
        """See BzrBranch5.generate_revision_history"""
2892
 
        history = self._lefthand_history(revision_id, last_rev, other_branch)
2893
 
        revno = len(history)
2894
 
        self.set_last_revision_info(revno, revision_id)
2895
 
 
2896
3017
    @needs_read_lock
2897
3018
    def get_rev_id(self, revno, history=None):
2898
3019
        """Find the revision id of the specified revno."""
2922
3043
        try:
2923
3044
            index = self._partial_revision_history_cache.index(revision_id)
2924
3045
        except ValueError:
2925
 
            self._extend_partial_history(stop_revision=revision_id)
 
3046
            try:
 
3047
                self._extend_partial_history(stop_revision=revision_id)
 
3048
            except errors.RevisionNotPresent, e:
 
3049
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2926
3050
            index = len(self._partial_revision_history_cache) - 1
 
3051
            if index < 0:
 
3052
                raise errors.NoSuchRevision(self, revision_id)
2927
3053
            if self._partial_revision_history_cache[index] != revision_id:
2928
3054
                raise errors.NoSuchRevision(self, revision_id)
2929
3055
        return self.revno() - index
2981
3107
    :ivar local_branch: target branch if there is a Master, else None
2982
3108
    :ivar target_branch: Target/destination branch object. (write locked)
2983
3109
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
 
3110
    :ivar tag_updates: A dict with new tags, see BasicTags.merge_to
2984
3111
    """
2985
3112
 
 
3113
    @deprecated_method(deprecated_in((2, 3, 0)))
2986
3114
    def __int__(self):
2987
 
        # DEPRECATED: pull used to return the change in revno
 
3115
        """Return the relative change in revno.
 
3116
 
 
3117
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3118
        """
2988
3119
        return self.new_revno - self.old_revno
2989
3120
 
2990
3121
    def report(self, to_file):
 
3122
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
3123
        tag_updates = getattr(self, "tag_updates", None)
2991
3124
        if not is_quiet():
2992
 
            if self.old_revid == self.new_revid:
2993
 
                to_file.write('No revisions to pull.\n')
2994
 
            else:
 
3125
            if self.old_revid != self.new_revid:
2995
3126
                to_file.write('Now on revision %d.\n' % self.new_revno)
 
3127
            if tag_updates:
 
3128
                to_file.write('%d tag(s) updated.\n' % len(tag_updates))
 
3129
            if self.old_revid == self.new_revid and not tag_updates:
 
3130
                if not tag_conflicts:
 
3131
                    to_file.write('No revisions or tags to pull.\n')
 
3132
                else:
 
3133
                    to_file.write('No revisions to pull.\n')
2996
3134
        self._show_tag_conficts(to_file)
2997
3135
 
2998
3136
 
3015
3153
        target, otherwise it will be None.
3016
3154
    """
3017
3155
 
 
3156
    @deprecated_method(deprecated_in((2, 3, 0)))
3018
3157
    def __int__(self):
3019
 
        # DEPRECATED: push used to return the change in revno
 
3158
        """Return the relative change in revno.
 
3159
 
 
3160
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3161
        """
3020
3162
        return self.new_revno - self.old_revno
3021
3163
 
3022
3164
    def report(self, to_file):
3023
 
        """Write a human-readable description of the result."""
3024
 
        if self.old_revid == self.new_revid:
3025
 
            note('No new revisions to push.')
3026
 
        else:
3027
 
            note('Pushed up to revision %d.' % self.new_revno)
 
3165
        # TODO: This function gets passed a to_file, but then
 
3166
        # ignores it and calls note() instead. This is also
 
3167
        # inconsistent with PullResult(), which writes to stdout.
 
3168
        # -- JRV20110901, bug #838853
 
3169
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
3170
        tag_updates = getattr(self, "tag_updates", None)
 
3171
        if not is_quiet():
 
3172
            if self.old_revid != self.new_revid:
 
3173
                note(gettext('Pushed up to revision %d.') % self.new_revno)
 
3174
            if tag_updates:
 
3175
                note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
 
3176
            if self.old_revid == self.new_revid and not tag_updates:
 
3177
                if not tag_conflicts:
 
3178
                    note(gettext('No new revisions or tags to push.'))
 
3179
                else:
 
3180
                    note(gettext('No new revisions to push.'))
3028
3181
        self._show_tag_conficts(to_file)
3029
3182
 
3030
3183
 
3044
3197
        :param verbose: Requests more detailed display of what was checked,
3045
3198
            if any.
3046
3199
        """
3047
 
        note('checked branch %s format %s', self.branch.user_url,
3048
 
            self.branch._format)
 
3200
        note(gettext('checked branch {0} format {1}').format(
 
3201
                                self.branch.user_url, self.branch._format))
3049
3202
        for error in self.errors:
3050
 
            note('found error:%s', error)
 
3203
            note(gettext('found error:%s'), error)
3051
3204
 
3052
3205
 
3053
3206
class Converter5to6(object):
3092
3245
 
3093
3246
 
3094
3247
class Converter7to8(object):
3095
 
    """Perform an in-place upgrade of format 6 to format 7"""
 
3248
    """Perform an in-place upgrade of format 7 to format 8"""
3096
3249
 
3097
3250
    def convert(self, branch):
3098
3251
        format = BzrBranchFormat8()
3101
3254
        branch._transport.put_bytes('format', format.get_format_string())
3102
3255
 
3103
3256
 
3104
 
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3105
 
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3106
 
    duration.
3107
 
 
3108
 
    _run_with_write_locked_target will attempt to release the lock it acquires.
3109
 
 
3110
 
    If an exception is raised by callable, then that exception *will* be
3111
 
    propagated, even if the unlock attempt raises its own error.  Thus
3112
 
    _run_with_write_locked_target should be preferred to simply doing::
3113
 
 
3114
 
        target.lock_write()
3115
 
        try:
3116
 
            return callable(*args, **kwargs)
3117
 
        finally:
3118
 
            target.unlock()
3119
 
 
3120
 
    """
3121
 
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
3122
 
    # should share code?
3123
 
    target.lock_write()
3124
 
    try:
3125
 
        result = callable(*args, **kwargs)
3126
 
    except:
3127
 
        exc_info = sys.exc_info()
3128
 
        try:
3129
 
            target.unlock()
3130
 
        finally:
3131
 
            raise exc_info[0], exc_info[1], exc_info[2]
3132
 
    else:
3133
 
        target.unlock()
3134
 
        return result
3135
 
 
3136
 
 
3137
3257
class InterBranch(InterObject):
3138
3258
    """This class represents operations taking place between two branches.
3139
3259
 
3145
3265
    _optimisers = []
3146
3266
    """The available optimised InterBranch types."""
3147
3267
 
3148
 
    @staticmethod
3149
 
    def _get_branch_formats_to_test():
3150
 
        """Return a tuple with the Branch formats to use when testing."""
3151
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
3268
    @classmethod
 
3269
    def _get_branch_formats_to_test(klass):
 
3270
        """Return an iterable of format tuples for testing.
 
3271
        
 
3272
        :return: An iterable of (from_format, to_format) to use when testing
 
3273
            this InterBranch class. Each InterBranch class should define this
 
3274
            method itself.
 
3275
        """
 
3276
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3277
 
 
3278
    @needs_write_lock
3153
3279
    def pull(self, overwrite=False, stop_revision=None,
3154
3280
             possible_transports=None, local=False):
3155
3281
        """Mirror source into target branch.
3160
3286
        """
3161
3287
        raise NotImplementedError(self.pull)
3162
3288
 
3163
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
 
                         graph=None):
3165
 
        """Pull in new perfect-fit revisions.
3166
 
 
3167
 
        :param stop_revision: Updated until the given revision
3168
 
        :param overwrite: Always set the branch pointer, rather than checking
3169
 
            to see if it is a proper descendant.
3170
 
        :param graph: A Graph object that can be used to query history
3171
 
            information. This can be None.
3172
 
        :return: None
3173
 
        """
3174
 
        raise NotImplementedError(self.update_revisions)
3175
 
 
3176
 
    def push(self, overwrite=False, stop_revision=None,
 
3289
    @needs_write_lock
 
3290
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3177
3291
             _override_hook_source_branch=None):
3178
3292
        """Mirror the source branch into the target branch.
3179
3293
 
3181
3295
        """
3182
3296
        raise NotImplementedError(self.push)
3183
3297
 
 
3298
    @needs_write_lock
 
3299
    def copy_content_into(self, revision_id=None):
 
3300
        """Copy the content of source into target
 
3301
 
 
3302
        revision_id: if not None, the revision history in the new branch will
 
3303
                     be truncated to end with revision_id.
 
3304
        """
 
3305
        raise NotImplementedError(self.copy_content_into)
 
3306
 
 
3307
    @needs_write_lock
 
3308
    def fetch(self, stop_revision=None, limit=None):
 
3309
        """Fetch revisions.
 
3310
 
 
3311
        :param stop_revision: Last revision to fetch
 
3312
        :param limit: Optional rough limit of revisions to fetch
 
3313
        """
 
3314
        raise NotImplementedError(self.fetch)
 
3315
 
3184
3316
 
3185
3317
class GenericInterBranch(InterBranch):
3186
 
    """InterBranch implementation that uses public Branch functions.
3187
 
    """
3188
 
 
3189
 
    @staticmethod
3190
 
    def _get_branch_formats_to_test():
3191
 
        return BranchFormat._default_format, BranchFormat._default_format
3192
 
 
3193
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3194
 
        graph=None):
3195
 
        """See InterBranch.update_revisions()."""
 
3318
    """InterBranch implementation that uses public Branch functions."""
 
3319
 
 
3320
    @classmethod
 
3321
    def is_compatible(klass, source, target):
 
3322
        # GenericBranch uses the public API, so always compatible
 
3323
        return True
 
3324
 
 
3325
    @classmethod
 
3326
    def _get_branch_formats_to_test(klass):
 
3327
        return [(format_registry.get_default(), format_registry.get_default())]
 
3328
 
 
3329
    @classmethod
 
3330
    def unwrap_format(klass, format):
 
3331
        if isinstance(format, remote.RemoteBranchFormat):
 
3332
            format._ensure_real()
 
3333
            return format._custom_format
 
3334
        return format
 
3335
 
 
3336
    @needs_write_lock
 
3337
    def copy_content_into(self, revision_id=None):
 
3338
        """Copy the content of source into target
 
3339
 
 
3340
        revision_id: if not None, the revision history in the new branch will
 
3341
                     be truncated to end with revision_id.
 
3342
        """
 
3343
        self.source.update_references(self.target)
 
3344
        self.source._synchronize_history(self.target, revision_id)
 
3345
        try:
 
3346
            parent = self.source.get_parent()
 
3347
        except errors.InaccessibleParent, e:
 
3348
            mutter('parent was not accessible to copy: %s', e)
 
3349
        else:
 
3350
            if parent:
 
3351
                self.target.set_parent(parent)
 
3352
        if self.source._push_should_merge_tags():
 
3353
            self.source.tags.merge_to(self.target.tags)
 
3354
 
 
3355
    @needs_write_lock
 
3356
    def fetch(self, stop_revision=None, limit=None):
 
3357
        if self.target.base == self.source.base:
 
3358
            return (0, [])
3196
3359
        self.source.lock_read()
3197
3360
        try:
3198
 
            other_revno, other_last_revision = self.source.last_revision_info()
3199
 
            stop_revno = None # unknown
3200
 
            if stop_revision is None:
3201
 
                stop_revision = other_last_revision
3202
 
                if _mod_revision.is_null(stop_revision):
3203
 
                    # if there are no commits, we're done.
3204
 
                    return
3205
 
                stop_revno = other_revno
3206
 
 
3207
 
            # what's the current last revision, before we fetch [and change it
3208
 
            # possibly]
3209
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3210
 
            # we fetch here so that we don't process data twice in the common
3211
 
            # case of having something to pull, and so that the check for
3212
 
            # already merged can operate on the just fetched graph, which will
3213
 
            # be cached in memory.
3214
 
            self.target.fetch(self.source, stop_revision)
3215
 
            # Check to see if one is an ancestor of the other
3216
 
            if not overwrite:
3217
 
                if graph is None:
3218
 
                    graph = self.target.repository.get_graph()
3219
 
                if self.target._check_if_descendant_or_diverged(
3220
 
                        stop_revision, last_rev, graph, self.source):
3221
 
                    # stop_revision is a descendant of last_rev, but we aren't
3222
 
                    # overwriting, so we're done.
3223
 
                    return
3224
 
            if stop_revno is None:
3225
 
                if graph is None:
3226
 
                    graph = self.target.repository.get_graph()
3227
 
                this_revno, this_last_revision = \
3228
 
                        self.target.last_revision_info()
3229
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3230
 
                                [(other_last_revision, other_revno),
3231
 
                                 (this_last_revision, this_revno)])
3232
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
 
3361
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3362
            fetch_spec_factory.source_branch = self.source
 
3363
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3364
            fetch_spec_factory.source_repo = self.source.repository
 
3365
            fetch_spec_factory.target_repo = self.target.repository
 
3366
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3367
            fetch_spec_factory.limit = limit
 
3368
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3369
            return self.target.repository.fetch(self.source.repository,
 
3370
                fetch_spec=fetch_spec)
3233
3371
        finally:
3234
3372
            self.source.unlock()
3235
3373
 
 
3374
    @needs_write_lock
 
3375
    def _update_revisions(self, stop_revision=None, overwrite=False,
 
3376
            graph=None):
 
3377
        other_revno, other_last_revision = self.source.last_revision_info()
 
3378
        stop_revno = None # unknown
 
3379
        if stop_revision is None:
 
3380
            stop_revision = other_last_revision
 
3381
            if _mod_revision.is_null(stop_revision):
 
3382
                # if there are no commits, we're done.
 
3383
                return
 
3384
            stop_revno = other_revno
 
3385
 
 
3386
        # what's the current last revision, before we fetch [and change it
 
3387
        # possibly]
 
3388
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3389
        # we fetch here so that we don't process data twice in the common
 
3390
        # case of having something to pull, and so that the check for
 
3391
        # already merged can operate on the just fetched graph, which will
 
3392
        # be cached in memory.
 
3393
        self.fetch(stop_revision=stop_revision)
 
3394
        # Check to see if one is an ancestor of the other
 
3395
        if not overwrite:
 
3396
            if graph is None:
 
3397
                graph = self.target.repository.get_graph()
 
3398
            if self.target._check_if_descendant_or_diverged(
 
3399
                    stop_revision, last_rev, graph, self.source):
 
3400
                # stop_revision is a descendant of last_rev, but we aren't
 
3401
                # overwriting, so we're done.
 
3402
                return
 
3403
        if stop_revno is None:
 
3404
            if graph is None:
 
3405
                graph = self.target.repository.get_graph()
 
3406
            this_revno, this_last_revision = \
 
3407
                    self.target.last_revision_info()
 
3408
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3409
                            [(other_last_revision, other_revno),
 
3410
                             (this_last_revision, this_revno)])
 
3411
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3412
 
 
3413
    @needs_write_lock
3236
3414
    def pull(self, overwrite=False, stop_revision=None,
 
3415
             possible_transports=None, run_hooks=True,
 
3416
             _override_hook_target=None, local=False):
 
3417
        """Pull from source into self, updating my master if any.
 
3418
 
 
3419
        :param run_hooks: Private parameter - if false, this branch
 
3420
            is being called because it's the master of the primary branch,
 
3421
            so it should not run its hooks.
 
3422
        """
 
3423
        bound_location = self.target.get_bound_location()
 
3424
        if local and not bound_location:
 
3425
            raise errors.LocalRequiresBoundBranch()
 
3426
        master_branch = None
 
3427
        source_is_master = False
 
3428
        if bound_location:
 
3429
            # bound_location comes from a config file, some care has to be
 
3430
            # taken to relate it to source.user_url
 
3431
            normalized = urlutils.normalize_url(bound_location)
 
3432
            try:
 
3433
                relpath = self.source.user_transport.relpath(normalized)
 
3434
                source_is_master = (relpath == '')
 
3435
            except (errors.PathNotChild, errors.InvalidURL):
 
3436
                source_is_master = False
 
3437
        if not local and bound_location and not source_is_master:
 
3438
            # not pulling from master, so we need to update master.
 
3439
            master_branch = self.target.get_master_branch(possible_transports)
 
3440
            master_branch.lock_write()
 
3441
        try:
 
3442
            if master_branch:
 
3443
                # pull from source into master.
 
3444
                master_branch.pull(self.source, overwrite, stop_revision,
 
3445
                    run_hooks=False)
 
3446
            return self._pull(overwrite,
 
3447
                stop_revision, _hook_master=master_branch,
 
3448
                run_hooks=run_hooks,
 
3449
                _override_hook_target=_override_hook_target,
 
3450
                merge_tags_to_master=not source_is_master)
 
3451
        finally:
 
3452
            if master_branch:
 
3453
                master_branch.unlock()
 
3454
 
 
3455
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
3456
             _override_hook_source_branch=None):
 
3457
        """See InterBranch.push.
 
3458
 
 
3459
        This is the basic concrete implementation of push()
 
3460
 
 
3461
        :param _override_hook_source_branch: If specified, run the hooks
 
3462
            passing this Branch as the source, rather than self.  This is for
 
3463
            use of RemoteBranch, where push is delegated to the underlying
 
3464
            vfs-based Branch.
 
3465
        """
 
3466
        if lossy:
 
3467
            raise errors.LossyPushToSameVCS(self.source, self.target)
 
3468
        # TODO: Public option to disable running hooks - should be trivial but
 
3469
        # needs tests.
 
3470
 
 
3471
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
 
3472
        op.add_cleanup(self.source.lock_read().unlock)
 
3473
        op.add_cleanup(self.target.lock_write().unlock)
 
3474
        return op.run(overwrite, stop_revision,
 
3475
            _override_hook_source_branch=_override_hook_source_branch)
 
3476
 
 
3477
    def _basic_push(self, overwrite, stop_revision):
 
3478
        """Basic implementation of push without bound branches or hooks.
 
3479
 
 
3480
        Must be called with source read locked and target write locked.
 
3481
        """
 
3482
        result = BranchPushResult()
 
3483
        result.source_branch = self.source
 
3484
        result.target_branch = self.target
 
3485
        result.old_revno, result.old_revid = self.target.last_revision_info()
 
3486
        self.source.update_references(self.target)
 
3487
        if result.old_revid != stop_revision:
 
3488
            # We assume that during 'push' this repository is closer than
 
3489
            # the target.
 
3490
            graph = self.source.repository.get_graph(self.target.repository)
 
3491
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3492
                    graph=graph)
 
3493
        if self.source._push_should_merge_tags():
 
3494
            result.tag_updates, result.tag_conflicts = (
 
3495
                self.source.tags.merge_to(self.target.tags, overwrite))
 
3496
        result.new_revno, result.new_revid = self.target.last_revision_info()
 
3497
        return result
 
3498
 
 
3499
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
 
3500
            _override_hook_source_branch=None):
 
3501
        """Push from source into target, and into target's master if any.
 
3502
        """
 
3503
        def _run_hooks():
 
3504
            if _override_hook_source_branch:
 
3505
                result.source_branch = _override_hook_source_branch
 
3506
            for hook in Branch.hooks['post_push']:
 
3507
                hook(result)
 
3508
 
 
3509
        bound_location = self.target.get_bound_location()
 
3510
        if bound_location and self.target.base != bound_location:
 
3511
            # there is a master branch.
 
3512
            #
 
3513
            # XXX: Why the second check?  Is it even supported for a branch to
 
3514
            # be bound to itself? -- mbp 20070507
 
3515
            master_branch = self.target.get_master_branch()
 
3516
            master_branch.lock_write()
 
3517
            operation.add_cleanup(master_branch.unlock)
 
3518
            # push into the master from the source branch.
 
3519
            master_inter = InterBranch.get(self.source, master_branch)
 
3520
            master_inter._basic_push(overwrite, stop_revision)
 
3521
            # and push into the target branch from the source. Note that
 
3522
            # we push from the source branch again, because it's considered
 
3523
            # the highest bandwidth repository.
 
3524
            result = self._basic_push(overwrite, stop_revision)
 
3525
            result.master_branch = master_branch
 
3526
            result.local_branch = self.target
 
3527
        else:
 
3528
            master_branch = None
 
3529
            # no master branch
 
3530
            result = self._basic_push(overwrite, stop_revision)
 
3531
            # TODO: Why set master_branch and local_branch if there's no
 
3532
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3533
            # 20070504
 
3534
            result.master_branch = self.target
 
3535
            result.local_branch = None
 
3536
        _run_hooks()
 
3537
        return result
 
3538
 
 
3539
    def _pull(self, overwrite=False, stop_revision=None,
3237
3540
             possible_transports=None, _hook_master=None, run_hooks=True,
3238
 
             _override_hook_target=None, local=False):
 
3541
             _override_hook_target=None, local=False,
 
3542
             merge_tags_to_master=True):
3239
3543
        """See Branch.pull.
3240
3544
 
 
3545
        This function is the core worker, used by GenericInterBranch.pull to
 
3546
        avoid duplication when pulling source->master and source->local.
 
3547
 
3241
3548
        :param _hook_master: Private parameter - set the branch to
3242
3549
            be supplied as the master to pull hooks.
3243
3550
        :param run_hooks: Private parameter - if false, this branch
3244
3551
            is being called because it's the master of the primary branch,
3245
3552
            so it should not run its hooks.
 
3553
            is being called because it's the master of the primary branch,
 
3554
            so it should not run its hooks.
3246
3555
        :param _override_hook_target: Private parameter - set the branch to be
3247
3556
            supplied as the target_branch to pull hooks.
3248
3557
        :param local: Only update the local branch, and not the bound branch.
3267
3576
            # -- JRV20090506
3268
3577
            result.old_revno, result.old_revid = \
3269
3578
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
 
3579
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3580
                graph=graph)
3272
3581
            # TODO: The old revid should be specified when merging tags, 
3273
3582
            # so a tags implementation that versions tags can only 
3274
3583
            # pull in the most recent changes. -- JRV20090506
3275
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
 
3584
            result.tag_updates, result.tag_conflicts = (
 
3585
                self.source.tags.merge_to(self.target.tags, overwrite,
 
3586
                    ignore_master=not merge_tags_to_master))
3277
3587
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
3588
            if _hook_master:
3279
3589
                result.master_branch = _hook_master
3288
3598
            self.source.unlock()
3289
3599
        return result
3290
3600
 
3291
 
    def push(self, overwrite=False, stop_revision=None,
3292
 
             _override_hook_source_branch=None):
3293
 
        """See InterBranch.push.
3294
 
 
3295
 
        This is the basic concrete implementation of push()
3296
 
 
3297
 
        :param _override_hook_source_branch: If specified, run
3298
 
        the hooks passing this Branch as the source, rather than self.
3299
 
        This is for use of RemoteBranch, where push is delegated to the
3300
 
        underlying vfs-based Branch.
3301
 
        """
3302
 
        # TODO: Public option to disable running hooks - should be trivial but
3303
 
        # needs tests.
3304
 
        self.source.lock_read()
3305
 
        try:
3306
 
            return _run_with_write_locked_target(
3307
 
                self.target, self._push_with_bound_branches, overwrite,
3308
 
                stop_revision,
3309
 
                _override_hook_source_branch=_override_hook_source_branch)
3310
 
        finally:
3311
 
            self.source.unlock()
3312
 
 
3313
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3314
 
            _override_hook_source_branch=None):
3315
 
        """Push from source into target, and into target's master if any.
3316
 
        """
3317
 
        def _run_hooks():
3318
 
            if _override_hook_source_branch:
3319
 
                result.source_branch = _override_hook_source_branch
3320
 
            for hook in Branch.hooks['post_push']:
3321
 
                hook(result)
3322
 
 
3323
 
        bound_location = self.target.get_bound_location()
3324
 
        if bound_location and self.target.base != bound_location:
3325
 
            # there is a master branch.
3326
 
            #
3327
 
            # XXX: Why the second check?  Is it even supported for a branch to
3328
 
            # be bound to itself? -- mbp 20070507
3329
 
            master_branch = self.target.get_master_branch()
3330
 
            master_branch.lock_write()
3331
 
            try:
3332
 
                # push into the master from the source branch.
3333
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3334
 
                # and push into the target branch from the source. Note that we
3335
 
                # push from the source branch again, because its considered the
3336
 
                # highest bandwidth repository.
3337
 
                result = self.source._basic_push(self.target, overwrite,
3338
 
                    stop_revision)
3339
 
                result.master_branch = master_branch
3340
 
                result.local_branch = self.target
3341
 
                _run_hooks()
3342
 
                return result
3343
 
            finally:
3344
 
                master_branch.unlock()
3345
 
        else:
3346
 
            # no master branch
3347
 
            result = self.source._basic_push(self.target, overwrite,
3348
 
                stop_revision)
3349
 
            # TODO: Why set master_branch and local_branch if there's no
3350
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3351
 
            # 20070504
3352
 
            result.master_branch = self.target
3353
 
            result.local_branch = None
3354
 
            _run_hooks()
3355
 
            return result
3356
 
 
3357
 
    @classmethod
3358
 
    def is_compatible(self, source, target):
3359
 
        # GenericBranch uses the public API, so always compatible
3360
 
        return True
3361
 
 
3362
 
 
3363
 
class InterToBranch5(GenericInterBranch):
3364
 
 
3365
 
    @staticmethod
3366
 
    def _get_branch_formats_to_test():
3367
 
        return BranchFormat._default_format, BzrBranchFormat5()
3368
 
 
3369
 
    def pull(self, overwrite=False, stop_revision=None,
3370
 
             possible_transports=None, run_hooks=True,
3371
 
             _override_hook_target=None, local=False):
3372
 
        """Pull from source into self, updating my master if any.
3373
 
 
3374
 
        :param run_hooks: Private parameter - if false, this branch
3375
 
            is being called because it's the master of the primary branch,
3376
 
            so it should not run its hooks.
3377
 
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
3380
 
            raise errors.LocalRequiresBoundBranch()
3381
 
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
3383
 
            # not pulling from master, so we need to update master.
3384
 
            master_branch = self.target.get_master_branch(possible_transports)
3385
 
            master_branch.lock_write()
3386
 
        try:
3387
 
            if master_branch:
3388
 
                # pull from source into master.
3389
 
                master_branch.pull(self.source, overwrite, stop_revision,
3390
 
                    run_hooks=False)
3391
 
            return super(InterToBranch5, self).pull(overwrite,
3392
 
                stop_revision, _hook_master=master_branch,
3393
 
                run_hooks=run_hooks,
3394
 
                _override_hook_target=_override_hook_target)
3395
 
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
3398
 
 
3399
3601
 
3400
3602
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)