~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Vincent Ladeuil
  • Date: 2012-04-17 12:18:27 UTC
  • mto: This revision was merged to the branch mainline in revision 6523.
  • Revision ID: v.ladeuil+lp@free.fr-20120417121827-nmhw3ax9fefi0r44
Fix test failures caued by a forgotten ``tests.features.sphinx`` reference

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2012 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
import bzrlib.bzrdir
17
20
 
18
21
from cStringIO import StringIO
19
 
import sys
20
22
 
21
23
from bzrlib.lazy_import import lazy_import
22
24
lazy_import(globals(), """
23
 
from itertools import chain
 
25
import itertools
24
26
from bzrlib import (
25
 
        bzrdir,
26
 
        cache_utf8,
27
 
        config as _mod_config,
28
 
        debug,
29
 
        errors,
30
 
        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,
 
27
    bzrdir,
 
28
    controldir,
 
29
    cache_utf8,
 
30
    cleanup,
 
31
    config as _mod_config,
 
32
    debug,
 
33
    errors,
 
34
    fetch,
 
35
    graph as _mod_graph,
 
36
    lockdir,
 
37
    lockable_files,
 
38
    remote,
 
39
    repository,
 
40
    revision as _mod_revision,
 
41
    rio,
 
42
    tag as _mod_tag,
 
43
    transport,
 
44
    ui,
 
45
    urlutils,
 
46
    vf_search,
46
47
    )
 
48
from bzrlib.i18n import gettext, ngettext
47
49
""")
48
50
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
 
from bzrlib.hooks import HookPoint, Hooks
 
51
# Explicitly import bzrlib.bzrdir so that the BzrProber
 
52
# is guaranteed to be registered.
 
53
import bzrlib.bzrdir
 
54
 
 
55
from bzrlib import (
 
56
    bzrdir,
 
57
    controldir,
 
58
    )
 
59
from bzrlib.decorators import (
 
60
    needs_read_lock,
 
61
    needs_write_lock,
 
62
    only_raises,
 
63
    )
 
64
from bzrlib.hooks import Hooks
51
65
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
 
66
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
67
from bzrlib import registry
54
68
from bzrlib.symbol_versioning import (
55
69
    deprecated_in,
58
72
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
59
73
 
60
74
 
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):
 
75
class Branch(controldir.ControlComponent):
67
76
    """Branch holding a history of revisions.
68
77
 
69
78
    :ivar base:
70
79
        Base directory/url of the branch; using control_url and
71
80
        control_transport is more standardized.
72
 
 
73
 
    hooks: An instance of BranchHooks.
 
81
    :ivar hooks: An instance of BranchHooks.
 
82
    :ivar _master_branch_cache: cached result of get_master_branch, see
 
83
        _clear_cached_state.
74
84
    """
75
85
    # this is really an instance variable - FIXME move it there
76
86
    # - RBC 20060112
84
94
    def user_transport(self):
85
95
        return self.bzrdir.user_transport
86
96
 
87
 
    def __init__(self, *ignored, **ignored_too):
 
97
    def __init__(self, possible_transports=None):
88
98
        self.tags = self._format.make_tags(self)
89
99
        self._revision_history_cache = None
90
100
        self._revision_id_to_revno_cache = None
91
101
        self._partial_revision_id_to_revno_cache = {}
92
102
        self._partial_revision_history_cache = []
 
103
        self._tags_bytes = None
93
104
        self._last_revision_info_cache = None
 
105
        self._master_branch_cache = None
94
106
        self._merge_sorted_revisions_cache = None
95
 
        self._open_hook()
 
107
        self._open_hook(possible_transports)
96
108
        hooks = Branch.hooks['open']
97
109
        for hook in hooks:
98
110
            hook(self)
99
111
 
100
 
    def _open_hook(self):
 
112
    def _open_hook(self, possible_transports):
101
113
        """Called by init to allow simpler extension of the base class."""
102
114
 
103
 
    def _activate_fallback_location(self, url):
 
115
    def _activate_fallback_location(self, url, possible_transports):
104
116
        """Activate the branch/repository from url as a fallback repository."""
105
 
        repo = self._get_fallback_repository(url)
 
117
        for existing_fallback_repo in self.repository._fallback_repositories:
 
118
            if existing_fallback_repo.user_url == url:
 
119
                # This fallback is already configured.  This probably only
 
120
                # happens because ControlDir.sprout is a horrible mess.  To avoid
 
121
                # confusing _unstack we don't add this a second time.
 
122
                mutter('duplicate activation of fallback %r on %r', url, self)
 
123
                return
 
124
        repo = self._get_fallback_repository(url, possible_transports)
106
125
        if repo.has_same_location(self.repository):
107
126
            raise errors.UnstackableLocationError(self.user_url, url)
108
127
        self.repository.add_fallback_repository(repo)
162
181
        For instance, if the branch is at URL/.bzr/branch,
163
182
        Branch.open(URL) -> a Branch instance.
164
183
        """
165
 
        control = bzrdir.BzrDir.open(base, _unsupported,
166
 
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
184
        control = controldir.ControlDir.open(base,
 
185
            possible_transports=possible_transports, _unsupported=_unsupported)
 
186
        return control.open_branch(unsupported=_unsupported,
 
187
            possible_transports=possible_transports)
168
188
 
169
189
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
190
    def open_from_transport(transport, name=None, _unsupported=False,
 
191
            possible_transports=None):
171
192
        """Open the branch rooted at transport"""
172
 
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
193
        control = controldir.ControlDir.open_from_transport(transport, _unsupported)
 
194
        return control.open_branch(name=name, unsupported=_unsupported,
 
195
            possible_transports=possible_transports)
174
196
 
175
197
    @staticmethod
176
198
    def open_containing(url, possible_transports=None):
184
206
        format, UnknownFormatError or UnsupportedFormatError are raised.
185
207
        If there is one, it is returned, along with the unused portion of url.
186
208
        """
187
 
        control, relpath = bzrdir.BzrDir.open_containing(url,
 
209
        control, relpath = controldir.ControlDir.open_containing(url,
188
210
                                                         possible_transports)
189
 
        return control.open_branch(), relpath
 
211
        branch = control.open_branch(possible_transports=possible_transports)
 
212
        return (branch, relpath)
190
213
 
191
214
    def _push_should_merge_tags(self):
192
215
        """Should _basic_push merge this branch's tags into the target?
197
220
        return self.supports_tags() and self.tags.get_tag_dict()
198
221
 
199
222
    def get_config(self):
200
 
        return BranchConfig(self)
 
223
        """Get a bzrlib.config.BranchConfig for this Branch.
 
224
 
 
225
        This can then be used to get and set configuration options for the
 
226
        branch.
 
227
 
 
228
        :return: A bzrlib.config.BranchConfig.
 
229
        """
 
230
        return _mod_config.BranchConfig(self)
 
231
 
 
232
    def get_config_stack(self):
 
233
        """Get a bzrlib.config.BranchStack for this Branch.
 
234
 
 
235
        This can then be used to get and set configuration options for the
 
236
        branch.
 
237
 
 
238
        :return: A bzrlib.config.BranchStack.
 
239
        """
 
240
        return _mod_config.BranchStack(self)
201
241
 
202
242
    def _get_config(self):
203
243
        """Get the concrete config for just the config in this branch.
211
251
        """
212
252
        raise NotImplementedError(self._get_config)
213
253
 
214
 
    def _get_fallback_repository(self, url):
 
254
    def _get_fallback_repository(self, url, possible_transports):
215
255
        """Get the repository we fallback to at url."""
216
256
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
218
 
            possible_transports=[self.bzrdir.root_transport])
 
257
        a_branch = Branch.open(url, possible_transports=possible_transports)
219
258
        return a_branch.repository
220
259
 
 
260
    @needs_read_lock
221
261
    def _get_tags_bytes(self):
222
262
        """Get the bytes of a serialised tags dict.
223
263
 
230
270
        :return: The bytes of the tags file.
231
271
        :seealso: Branch._set_tags_bytes.
232
272
        """
233
 
        return self._transport.get_bytes('tags')
 
273
        if self._tags_bytes is None:
 
274
            self._tags_bytes = self._transport.get_bytes('tags')
 
275
        return self._tags_bytes
234
276
 
235
277
    def _get_nick(self, local=False, possible_transports=None):
236
278
        config = self.get_config()
238
280
        if not local and not config.has_explicit_nickname():
239
281
            try:
240
282
                master = self.get_master_branch(possible_transports)
 
283
                if master and self.user_url == master.user_url:
 
284
                    raise errors.RecursiveBind(self.user_url)
241
285
                if master is not None:
242
286
                    # return the master branch value
243
287
                    return master.nick
 
288
            except errors.RecursiveBind, e:
 
289
                raise e
244
290
            except errors.BzrError, e:
245
291
                # Silently fall back to local implicit nick if the master is
246
292
                # unavailable
283
329
        new_history.reverse()
284
330
        return new_history
285
331
 
286
 
    def lock_write(self):
 
332
    def lock_write(self, token=None):
 
333
        """Lock the branch for write operations.
 
334
 
 
335
        :param token: A token to permit reacquiring a previously held and
 
336
            preserved lock.
 
337
        :return: A BranchWriteLockResult.
 
338
        """
287
339
        raise NotImplementedError(self.lock_write)
288
340
 
289
341
    def lock_read(self):
 
342
        """Lock the branch for read operations.
 
343
 
 
344
        :return: A bzrlib.lock.LogicalLockResult.
 
345
        """
290
346
        raise NotImplementedError(self.lock_read)
291
347
 
292
348
    def unlock(self):
413
469
            after. If None, the rest of history is included.
414
470
        :param stop_rule: if stop_revision_id is not None, the precise rule
415
471
            to use for termination:
 
472
 
416
473
            * 'exclude' - leave the stop revision out of the result (default)
417
474
            * 'include' - the stop revision is the last item in the result
418
475
            * 'with-merges' - include the stop revision and all of its
420
477
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
478
              that are in both ancestries
422
479
        :param direction: either 'reverse' or 'forward':
 
480
 
423
481
            * reverse means return the start_revision_id first, i.e.
424
482
              start at the most recent revision and go backwards in history
425
483
            * forward returns tuples in the opposite order to reverse.
469
527
        rev_iter = iter(merge_sorted_revisions)
470
528
        if start_revision_id is not None:
471
529
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
530
                rev_id = node.key
473
531
                if rev_id != start_revision_id:
474
532
                    continue
475
533
                else:
476
534
                    # The decision to include the start or not
477
535
                    # depends on the stop_rule if a stop is provided
478
536
                    # so pop this node back into the iterator
479
 
                    rev_iter = chain(iter([node]), rev_iter)
 
537
                    rev_iter = itertools.chain(iter([node]), rev_iter)
480
538
                    break
481
539
        if stop_revision_id is None:
482
540
            # Yield everything
483
541
            for node in rev_iter:
484
 
                rev_id = node.key[-1]
 
542
                rev_id = node.key
485
543
                yield (rev_id, node.merge_depth, node.revno,
486
544
                       node.end_of_merge)
487
545
        elif stop_rule == 'exclude':
488
546
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
547
                rev_id = node.key
490
548
                if rev_id == stop_revision_id:
491
549
                    return
492
550
                yield (rev_id, node.merge_depth, node.revno,
493
551
                       node.end_of_merge)
494
552
        elif stop_rule == 'include':
495
553
            for node in rev_iter:
496
 
                rev_id = node.key[-1]
 
554
                rev_id = node.key
497
555
                yield (rev_id, node.merge_depth, node.revno,
498
556
                       node.end_of_merge)
499
557
                if rev_id == stop_revision_id:
505
563
            ancestors = graph.find_unique_ancestors(start_revision_id,
506
564
                                                    [stop_revision_id])
507
565
            for node in rev_iter:
508
 
                rev_id = node.key[-1]
 
566
                rev_id = node.key
509
567
                if rev_id not in ancestors:
510
568
                    continue
511
569
                yield (rev_id, node.merge_depth, node.revno,
521
579
            reached_stop_revision_id = False
522
580
            revision_id_whitelist = []
523
581
            for node in rev_iter:
524
 
                rev_id = node.key[-1]
 
582
                rev_id = node.key
525
583
                if rev_id == left_parent:
526
584
                    # reached the left parent after the stop_revision
527
585
                    return
607
665
        """
608
666
        raise errors.UpgradeRequired(self.user_url)
609
667
 
 
668
    def get_append_revisions_only(self):
 
669
        """Whether it is only possible to append revisions to the history.
 
670
        """
 
671
        if not self._format.supports_set_append_revisions_only():
 
672
            return False
 
673
        return self.get_config_stack().get('append_revisions_only')
 
674
 
610
675
    def set_append_revisions_only(self, enabled):
611
676
        if not self._format.supports_set_append_revisions_only():
612
677
            raise errors.UpgradeRequired(self.user_url)
613
 
        if enabled:
614
 
            value = 'True'
615
 
        else:
616
 
            value = 'False'
617
 
        self.get_config().set_user_option('append_revisions_only', value,
618
 
            warn_masked=True)
 
678
        self.get_config_stack().set('append_revisions_only', enabled)
619
679
 
620
680
    def set_reference_info(self, file_id, tree_path, branch_location):
621
681
        """Set the branch location to use for a tree reference."""
626
686
        raise errors.UnsupportedOperation(self.get_reference_info, self)
627
687
 
628
688
    @needs_write_lock
629
 
    def fetch(self, from_branch, last_revision=None, pb=None):
 
689
    def fetch(self, from_branch, last_revision=None, limit=None):
630
690
        """Copy revisions from from_branch into this branch.
631
691
 
632
692
        :param from_branch: Where to copy from.
633
693
        :param last_revision: What revision to stop at (None for at the end
634
694
                              of the branch.
635
 
        :param pb: An optional progress bar to use.
 
695
        :param limit: Optional rough limit of revisions to fetch
636
696
        :return: None
637
697
        """
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()
 
698
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
654
699
 
655
700
    def get_bound_location(self):
656
701
        """Return the URL of the branch we are bound to.
665
710
        """
666
711
        raise errors.UpgradeRequired(self.user_url)
667
712
 
668
 
    def get_commit_builder(self, parents, config=None, timestamp=None,
 
713
    def get_commit_builder(self, parents, config_stack=None, timestamp=None,
669
714
                           timezone=None, committer=None, revprops=None,
670
 
                           revision_id=None):
 
715
                           revision_id=None, lossy=False):
671
716
        """Obtain a CommitBuilder for this branch.
672
717
 
673
718
        :param parents: Revision ids of the parents of the new revision.
677
722
        :param committer: Optional committer to set for commit.
678
723
        :param revprops: Optional dictionary of revision properties.
679
724
        :param revision_id: Optional revision id.
 
725
        :param lossy: Whether to discard data that can not be natively
 
726
            represented, when pushing to a foreign VCS 
680
727
        """
681
728
 
682
 
        if config is None:
683
 
            config = self.get_config()
 
729
        if config_stack is None:
 
730
            config_stack = self.get_config_stack()
684
731
 
685
 
        return self.repository.get_commit_builder(self, parents, config,
686
 
            timestamp, timezone, committer, revprops, revision_id)
 
732
        return self.repository.get_commit_builder(self, parents, config_stack,
 
733
            timestamp, timezone, committer, revprops, revision_id,
 
734
            lossy)
687
735
 
688
736
    def get_master_branch(self, possible_transports=None):
689
737
        """Return the branch we are bound to.
692
740
        """
693
741
        return None
694
742
 
 
743
    @deprecated_method(deprecated_in((2, 5, 0)))
695
744
    def get_revision_delta(self, revno):
696
745
        """Return the delta for one revision.
697
746
 
698
747
        The delta is relative to its mainline predecessor, or the
699
748
        empty tree for revision 1.
700
749
        """
701
 
        rh = self.revision_history()
702
 
        if not (1 <= revno <= len(rh)):
 
750
        try:
 
751
            revid = self.get_rev_id(revno)
 
752
        except errors.NoSuchRevision:
703
753
            raise errors.InvalidRevisionNumber(revno)
704
 
        return self.repository.get_revision_delta(rh[revno-1])
 
754
        return self.repository.get_revision_delta(revid)
705
755
 
706
756
    def get_stacked_on_url(self):
707
757
        """Get the URL this branch is stacked against.
716
766
        """Print `file` to stdout."""
717
767
        raise NotImplementedError(self.print_file)
718
768
 
719
 
    def set_revision_history(self, rev_history):
720
 
        raise NotImplementedError(self.set_revision_history)
 
769
    @needs_write_lock
 
770
    def set_last_revision_info(self, revno, revision_id):
 
771
        """Set the last revision of this branch.
 
772
 
 
773
        The caller is responsible for checking that the revno is correct
 
774
        for this revision id.
 
775
 
 
776
        It may be possible to set the branch last revision to an id not
 
777
        present in the repository.  However, branches can also be
 
778
        configured to check constraints on history, in which case this may not
 
779
        be permitted.
 
780
        """
 
781
        raise NotImplementedError(self.set_last_revision_info)
 
782
 
 
783
    @needs_write_lock
 
784
    def generate_revision_history(self, revision_id, last_rev=None,
 
785
                                  other_branch=None):
 
786
        """See Branch.generate_revision_history"""
 
787
        graph = self.repository.get_graph()
 
788
        (last_revno, last_revid) = self.last_revision_info()
 
789
        known_revision_ids = [
 
790
            (last_revid, last_revno),
 
791
            (_mod_revision.NULL_REVISION, 0),
 
792
            ]
 
793
        if last_rev is not None:
 
794
            if not graph.is_ancestor(last_rev, revision_id):
 
795
                # our previous tip is not merged into stop_revision
 
796
                raise errors.DivergedBranches(self, other_branch)
 
797
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
 
798
        self.set_last_revision_info(revno, revision_id)
721
799
 
722
800
    @needs_write_lock
723
801
    def set_parent(self, url):
760
838
                return
761
839
            self._unstack()
762
840
        else:
763
 
            self._activate_fallback_location(url)
 
841
            self._activate_fallback_location(url,
 
842
                possible_transports=[self.bzrdir.root_transport])
764
843
        # write this out after the repository is stacked to avoid setting a
765
844
        # stacked config that doesn't work.
766
845
        self._set_config_location('stacked_on_location', url)
767
846
 
768
847
    def _unstack(self):
769
848
        """Change a branch to be unstacked, copying data as needed.
770
 
        
 
849
 
771
850
        Don't call this directly, use set_stacked_on_url(None).
772
851
        """
773
852
        pb = ui.ui_factory.nested_progress_bar()
774
853
        try:
775
 
            pb.update("Unstacking")
 
854
            pb.update(gettext("Unstacking"))
776
855
            # The basic approach here is to fetch the tip of the branch,
777
856
            # including all available ghosts, from the existing stacked
778
857
            # repository into a new repository object without the fallbacks. 
782
861
            old_repository = self.repository
783
862
            if len(old_repository._fallback_repositories) != 1:
784
863
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
 
864
                    "of %r (fallbacks: %r)" % (old_repository,
 
865
                        old_repository._fallback_repositories))
 
866
            # Open the new repository object.
 
867
            # Repositories don't offer an interface to remove fallback
 
868
            # repositories today; take the conceptually simpler option and just
 
869
            # reopen it.  We reopen it starting from the URL so that we
 
870
            # get a separate connection for RemoteRepositories and can
 
871
            # stream from one of them to the other.  This does mean doing
 
872
            # separate SSH connection setup, but unstacking is not a
 
873
            # common operation so it's tolerable.
 
874
            new_bzrdir = controldir.ControlDir.open(
 
875
                self.bzrdir.root_transport.base)
 
876
            new_repository = new_bzrdir.find_repository()
 
877
            if new_repository._fallback_repositories:
 
878
                raise AssertionError("didn't expect %r to have "
 
879
                    "fallback_repositories"
 
880
                    % (self.repository,))
 
881
            # Replace self.repository with the new repository.
 
882
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
883
            # lock count) of self.repository to the new repository.
 
884
            lock_token = old_repository.lock_write().repository_token
 
885
            self.repository = new_repository
 
886
            if isinstance(self, remote.RemoteBranch):
 
887
                # Remote branches can have a second reference to the old
 
888
                # repository that need to be replaced.
 
889
                if self._real_branch is not None:
 
890
                    self._real_branch.repository = new_repository
 
891
            self.repository.lock_write(token=lock_token)
 
892
            if lock_token is not None:
 
893
                old_repository.leave_lock_in_place()
787
894
            old_repository.unlock()
 
895
            if lock_token is not None:
 
896
                # XXX: self.repository.leave_lock_in_place() before this
 
897
                # function will not be preserved.  Fortunately that doesn't
 
898
                # affect the current default format (2a), and would be a
 
899
                # corner-case anyway.
 
900
                #  - Andrew Bennetts, 2010/06/30
 
901
                self.repository.dont_leave_lock_in_place()
 
902
            old_lock_count = 0
 
903
            while True:
 
904
                try:
 
905
                    old_repository.unlock()
 
906
                except errors.LockNotHeld:
 
907
                    break
 
908
                old_lock_count += 1
 
909
            if old_lock_count == 0:
 
910
                raise AssertionError(
 
911
                    'old_repository should have been locked at least once.')
 
912
            for i in range(old_lock_count-1):
 
913
                self.repository.lock_write()
 
914
            # Fetch from the old repository into the new.
788
915
            old_repository.lock_read()
789
916
            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
917
                # XXX: If you unstack a branch while it has a working tree
809
918
                # with a pending merge, the pending-merged revisions will no
810
919
                # 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)
 
920
                try:
 
921
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
922
                except errors.TagsNotSupported:
 
923
                    tags_to_fetch = set()
 
924
                fetch_spec = vf_search.NotInOtherForRevs(self.repository,
 
925
                    old_repository, required_ids=[self.last_revision()],
 
926
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
927
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
818
928
            finally:
819
929
                old_repository.unlock()
820
930
        finally:
825
935
 
826
936
        :seealso: Branch._get_tags_bytes.
827
937
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
938
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
 
939
        op.add_cleanup(self.lock_write().unlock)
 
940
        return op.run_simple(bytes)
 
941
 
 
942
    def _set_tags_bytes_locked(self, bytes):
 
943
        self._tags_bytes = bytes
 
944
        return self._transport.put_bytes('tags', bytes)
830
945
 
831
946
    def _cache_revision_history(self, rev_history):
832
947
        """Set the cached revision history to rev_history.
853
968
        This means the next call to revision_history will need to call
854
969
        _gen_revision_history.
855
970
 
856
 
        This API is semi-public; it only for use by subclasses, all other code
857
 
        should consider it to be private.
 
971
        This API is semi-public; it is only for use by subclasses, all other
 
972
        code should consider it to be private.
858
973
        """
859
974
        self._revision_history_cache = None
860
975
        self._revision_id_to_revno_cache = None
861
976
        self._last_revision_info_cache = None
 
977
        self._master_branch_cache = None
862
978
        self._merge_sorted_revisions_cache = None
863
979
        self._partial_revision_history_cache = []
864
980
        self._partial_revision_id_to_revno_cache = {}
 
981
        self._tags_bytes = None
865
982
 
866
983
    def _gen_revision_history(self):
867
984
        """Return sequence of revision hashes on to this branch.
878
995
        """
879
996
        raise NotImplementedError(self._gen_revision_history)
880
997
 
881
 
    @needs_read_lock
882
 
    def revision_history(self):
883
 
        """Return sequence of revision ids on this branch.
884
 
 
885
 
        This method will cache the revision history for as long as it is safe to
886
 
        do so.
887
 
        """
 
998
    def _revision_history(self):
888
999
        if 'evil' in debug.debug_flags:
889
1000
            mutter_callsite(3, "revision_history scales with history.")
890
1001
        if self._revision_history_cache is not None:
917
1028
        :return: A tuple (revno, revision_id).
918
1029
        """
919
1030
        if self._last_revision_info_cache is None:
920
 
            self._last_revision_info_cache = self._last_revision_info()
 
1031
            self._last_revision_info_cache = self._read_last_revision_info()
921
1032
        return self._last_revision_info_cache
922
1033
 
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
 
 
 
1034
    def _read_last_revision_info(self):
 
1035
        raise NotImplementedError(self._read_last_revision_info)
 
1036
 
 
1037
    @deprecated_method(deprecated_in((2, 4, 0)))
970
1038
    def import_last_revision_info(self, source_repo, revno, revid):
971
1039
        """Set the last revision info, importing from another repo if necessary.
972
1040
 
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
1041
        :param source_repo: Source repository to optionally fetch from
977
1042
        :param revno: Revision number of the new tip
978
1043
        :param revid: Revision id of the new tip
981
1046
            self.repository.fetch(source_repo, revision_id=revid)
982
1047
        self.set_last_revision_info(revno, revid)
983
1048
 
 
1049
    def import_last_revision_info_and_tags(self, source, revno, revid,
 
1050
                                           lossy=False):
 
1051
        """Set the last revision info, importing from another repo if necessary.
 
1052
 
 
1053
        This is used by the bound branch code to upload a revision to
 
1054
        the master branch first before updating the tip of the local branch.
 
1055
        Revisions referenced by source's tags are also transferred.
 
1056
 
 
1057
        :param source: Source branch to optionally fetch from
 
1058
        :param revno: Revision number of the new tip
 
1059
        :param revid: Revision id of the new tip
 
1060
        :param lossy: Whether to discard metadata that can not be
 
1061
            natively represented
 
1062
        :return: Tuple with the new revision number and revision id
 
1063
            (should only be different from the arguments when lossy=True)
 
1064
        """
 
1065
        if not self.repository.has_same_location(source.repository):
 
1066
            self.fetch(source, revid)
 
1067
        self.set_last_revision_info(revno, revid)
 
1068
        return (revno, revid)
 
1069
 
984
1070
    def revision_id_to_revno(self, revision_id):
985
1071
        """Given a revision id, return its revno"""
986
1072
        if _mod_revision.is_null(revision_id):
987
1073
            return 0
988
 
        history = self.revision_history()
 
1074
        history = self._revision_history()
989
1075
        try:
990
1076
            return history.index(revision_id) + 1
991
1077
        except ValueError:
1006
1092
            self._extend_partial_history(distance_from_last)
1007
1093
        return self._partial_revision_history_cache[distance_from_last]
1008
1094
 
1009
 
    @needs_write_lock
1010
1095
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1096
             possible_transports=None, *args, **kwargs):
1012
1097
        """Mirror source into this branch.
1019
1104
            stop_revision=stop_revision,
1020
1105
            possible_transports=possible_transports, *args, **kwargs)
1021
1106
 
1022
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
 
        **kwargs):
 
1107
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
 
1108
            *args, **kwargs):
1024
1109
        """Mirror this branch into target.
1025
1110
 
1026
1111
        This branch is considered to be 'local', having low latency.
1027
1112
        """
1028
1113
        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)
 
1114
            lossy, *args, **kwargs)
1051
1115
 
1052
1116
    def basis_tree(self):
1053
1117
        """Return `Tree` object for last revision."""
1078
1142
    def _set_config_location(self, name, url, config=None,
1079
1143
                             make_relative=False):
1080
1144
        if config is None:
1081
 
            config = self.get_config()
 
1145
            config = self.get_config_stack()
1082
1146
        if url is None:
1083
1147
            url = ''
1084
1148
        elif make_relative:
1085
1149
            url = urlutils.relative_url(self.base, url)
1086
 
        config.set_user_option(name, url, warn_masked=True)
 
1150
        config.set(name, url)
1087
1151
 
1088
1152
    def _get_config_location(self, name, config=None):
1089
1153
        if config is None:
1090
 
            config = self.get_config()
1091
 
        location = config.get_user_option(name)
 
1154
            config = self.get_config_stack()
 
1155
        location = config.get(name)
1092
1156
        if location == '':
1093
1157
            location = None
1094
1158
        return location
1095
1159
 
1096
1160
    def get_child_submit_format(self):
1097
1161
        """Return the preferred format of submissions to this branch."""
1098
 
        return self.get_config().get_user_option("child_submit_format")
 
1162
        return self.get_config_stack().get('child_submit_format')
1099
1163
 
1100
1164
    def get_submit_branch(self):
1101
1165
        """Return the submit location of the branch.
1104
1168
        pattern is that the user can override it by specifying a
1105
1169
        location.
1106
1170
        """
1107
 
        return self.get_config().get_user_option('submit_branch')
 
1171
        return self.get_config_stack().get('submit_branch')
1108
1172
 
1109
1173
    def set_submit_branch(self, location):
1110
1174
        """Return the submit location of the branch.
1113
1177
        pattern is that the user can override it by specifying a
1114
1178
        location.
1115
1179
        """
1116
 
        self.get_config().set_user_option('submit_branch', location,
1117
 
            warn_masked=True)
 
1180
        self.get_config_stack().set('submit_branch', location)
1118
1181
 
1119
1182
    def get_public_branch(self):
1120
1183
        """Return the public location of the branch.
1133
1196
        self._set_config_location('public_branch', location)
1134
1197
 
1135
1198
    def get_push_location(self):
1136
 
        """Return the None or the location to push this branch to."""
1137
 
        push_loc = self.get_config().get_user_option('push_location')
1138
 
        return push_loc
 
1199
        """Return None or the location to push this branch to."""
 
1200
        return self.get_config_stack().get('push_location')
1139
1201
 
1140
1202
    def set_push_location(self, location):
1141
1203
        """Set a new push location for this branch."""
1208
1270
        return result
1209
1271
 
1210
1272
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1273
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1274
            repository=None):
1212
1275
        """Create a new line of development from the branch, into to_bzrdir.
1213
1276
 
1214
1277
        to_bzrdir controls the branch format.
1219
1282
        if (repository_policy is not None and
1220
1283
            repository_policy.requires_stacking()):
1221
1284
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
 
        result = to_bzrdir.create_branch()
 
1285
        result = to_bzrdir.create_branch(repository=repository)
1223
1286
        result.lock_write()
1224
1287
        try:
1225
1288
            if repository_policy is not None:
1226
1289
                repository_policy.configure_branch(result)
1227
1290
            self.copy_content_into(result, revision_id=revision_id)
1228
 
            result.set_parent(self.bzrdir.root_transport.base)
 
1291
            master_url = self.get_bound_location()
 
1292
            if master_url is None:
 
1293
                result.set_parent(self.bzrdir.root_transport.base)
 
1294
            else:
 
1295
                result.set_parent(master_url)
1229
1296
        finally:
1230
1297
            result.unlock()
1231
1298
        return result
1255
1322
                revno = 1
1256
1323
        destination.set_last_revision_info(revno, revision_id)
1257
1324
 
1258
 
    @needs_read_lock
1259
1325
    def copy_content_into(self, destination, revision_id=None):
1260
1326
        """Copy the content of self into destination.
1261
1327
 
1262
1328
        revision_id: if not None, the revision history in the new branch will
1263
1329
                     be truncated to end with revision_id.
1264
1330
        """
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)
 
1331
        return InterBranch.get(self, destination).copy_content_into(
 
1332
            revision_id=revision_id)
1276
1333
 
1277
1334
    def update_references(self, target):
1278
1335
        if not getattr(self._format, 'supports_reference_locations', False):
1315
1372
        # TODO: We should probably also check that self.revision_history
1316
1373
        # matches the repository for older branch formats.
1317
1374
        # If looking for the code that cross-checks repository parents against
1318
 
        # the iter_reverse_revision_history output, that is now a repository
 
1375
        # the Graph.iter_lefthand_ancestry output, that is now a repository
1319
1376
        # specific check.
1320
1377
        return result
1321
1378
 
1322
 
    def _get_checkout_format(self):
 
1379
    def _get_checkout_format(self, lightweight=False):
1323
1380
        """Return the most suitable metadir for a checkout of this branch.
1324
1381
        Weaves are used if this branch's repository uses weaves.
1325
1382
        """
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)
 
1383
        format = self.repository.bzrdir.checkout_metadir()
 
1384
        format.set_branch_format(self._format)
1333
1385
        return format
1334
1386
 
1335
1387
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1388
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1389
        no_tree=None):
1337
1390
        """Create a clone of this branch and its bzrdir.
1338
1391
 
1339
1392
        :param to_transport: The transport to clone onto.
1346
1399
        """
1347
1400
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1401
        # clone call. Or something. 20090224 RBC/spiv.
 
1402
        # XXX: Should this perhaps clone colocated branches as well, 
 
1403
        # rather than just the default branch? 20100319 JRV
1349
1404
        if revision_id is None:
1350
1405
            revision_id = self.last_revision()
1351
1406
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
1407
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1408
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1409
            no_tree=no_tree)
1354
1410
        return dir_to.open_branch()
1355
1411
 
1356
1412
    def create_checkout(self, to_location, revision_id=None,
1361
1417
        :param to_location: The url to produce the checkout at
1362
1418
        :param revision_id: The revision to check out
1363
1419
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1364
 
        produce a bound branch (heavyweight checkout)
 
1420
            produce a bound branch (heavyweight checkout)
1365
1421
        :param accelerator_tree: A tree which can be used for retrieving file
1366
1422
            contents more quickly than the revision tree, i.e. a workingtree.
1367
1423
            The revision tree will be used for cases where accelerator_tree's
1372
1428
        """
1373
1429
        t = transport.get_transport(to_location)
1374
1430
        t.ensure_base()
 
1431
        format = self._get_checkout_format(lightweight=lightweight)
 
1432
        try:
 
1433
            checkout = format.initialize_on_transport(t)
 
1434
        except errors.AlreadyControlDirError:
 
1435
            # It's fine if the control directory already exists,
 
1436
            # as long as there is no existing branch and working tree.
 
1437
            checkout = controldir.ControlDir.open_from_transport(t)
 
1438
            try:
 
1439
                checkout.open_branch()
 
1440
            except errors.NotBranchError:
 
1441
                pass
 
1442
            else:
 
1443
                raise errors.AlreadyControlDirError(t.base)
 
1444
            if checkout.control_transport.base == self.bzrdir.control_transport.base:
 
1445
                # When checking out to the same control directory,
 
1446
                # always create a lightweight checkout
 
1447
                lightweight = True
 
1448
 
1375
1449
        if lightweight:
1376
 
            format = self._get_checkout_format()
1377
 
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1450
            from_branch = checkout.set_branch_reference(target_branch=self)
1380
1451
        else:
1381
 
            format = self._get_checkout_format()
1382
 
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1383
 
                to_location, force_new_tree=False, format=format)
1384
 
            checkout = checkout_branch.bzrdir
 
1452
            policy = checkout.determine_repository_policy()
 
1453
            repo = policy.acquire_repository()[0]
 
1454
            checkout_branch = checkout.create_branch()
1385
1455
            checkout_branch.bind(self)
1386
1456
            # pull up to the specified revision_id to set the initial
1387
1457
            # branch tip correctly, and seed it with history.
1388
1458
            checkout_branch.pull(self, stop_revision=revision_id)
1389
 
            from_branch=None
 
1459
            from_branch = None
1390
1460
        tree = checkout.create_workingtree(revision_id,
1391
1461
                                           from_branch=from_branch,
1392
1462
                                           accelerator_tree=accelerator_tree,
1413
1483
 
1414
1484
    def reference_parent(self, file_id, path, possible_transports=None):
1415
1485
        """Return the parent branch for a tree-reference file_id
 
1486
 
1416
1487
        :param file_id: The file_id of the tree reference
1417
1488
        :param path: The path of the file_id in the tree
1418
1489
        :return: A branch associated with the file_id
1471
1542
        else:
1472
1543
            raise AssertionError("invalid heads: %r" % (heads,))
1473
1544
 
1474
 
 
1475
 
class BranchFormat(object):
 
1545
    def heads_to_fetch(self):
 
1546
        """Return the heads that must and that should be fetched to copy this
 
1547
        branch into another repo.
 
1548
 
 
1549
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1550
            set of heads that must be fetched.  if_present_fetch is a set of
 
1551
            heads that must be fetched if present, but no error is necessary if
 
1552
            they are not present.
 
1553
        """
 
1554
        # For bzr native formats must_fetch is just the tip, and
 
1555
        # if_present_fetch are the tags.
 
1556
        must_fetch = set([self.last_revision()])
 
1557
        if_present_fetch = set()
 
1558
        if self.get_config_stack().get('branch.fetch_tags'):
 
1559
            try:
 
1560
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1561
            except errors.TagsNotSupported:
 
1562
                pass
 
1563
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1564
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1565
        return must_fetch, if_present_fetch
 
1566
 
 
1567
 
 
1568
class BranchFormat(controldir.ControlComponentFormat):
1476
1569
    """An encapsulation of the initialization and open routines for a format.
1477
1570
 
1478
1571
    Formats provide three things:
1479
1572
     * An initialization routine,
1480
 
     * a format string,
 
1573
     * a format description
1481
1574
     * an open routine.
1482
1575
 
1483
1576
    Formats are placed in an dict by their format string for reference
1484
 
    during branch opening. Its not required that these be instances, they
 
1577
    during branch opening. It's not required that these be instances, they
1485
1578
    can be classes themselves with class methods - it simply depends on
1486
1579
    whether state is needed for a given format or not.
1487
1580
 
1490
1583
    object will be created every time regardless.
1491
1584
    """
1492
1585
 
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
1586
    def __eq__(self, other):
1502
1587
        return self.__class__ is other.__class__
1503
1588
 
1504
1589
    def __ne__(self, other):
1505
1590
        return not (self == other)
1506
1591
 
1507
 
    @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)
1512
 
            format_string = transport.get_bytes("format")
1513
 
            return klass._formats[format_string]
1514
 
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1516
 
        except KeyError:
1517
 
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
 
 
1519
 
    @classmethod
1520
 
    def get_default_format(klass):
1521
 
        """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.
 
1592
    def get_reference(self, controldir, name=None):
 
1593
        """Get the target reference of the branch in controldir.
1526
1594
 
1527
1595
        format probing must have been completed before calling
1528
1596
        this method - it is assumed that the format of the branch
1529
 
        in a_bzrdir is correct.
 
1597
        in controldir is correct.
1530
1598
 
1531
 
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1599
        :param controldir: The controldir to get the branch data from.
 
1600
        :param name: Name of the colocated branch to fetch
1532
1601
        :return: None if the branch is not a reference branch.
1533
1602
        """
1534
1603
        return None
1535
1604
 
1536
1605
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
1538
 
        """Set the target reference of the branch in a_bzrdir.
 
1606
    def set_reference(self, controldir, name, to_branch):
 
1607
        """Set the target reference of the branch in controldir.
1539
1608
 
1540
1609
        format probing must have been completed before calling
1541
1610
        this method - it is assumed that the format of the branch
1542
 
        in a_bzrdir is correct.
 
1611
        in controldir is correct.
1543
1612
 
1544
 
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1613
        :param controldir: The controldir to set the branch reference for.
 
1614
        :param name: Name of colocated branch to set, None for default
1545
1615
        :param to_branch: branch that the checkout is to reference
1546
1616
        """
1547
1617
        raise NotImplementedError(self.set_reference)
1548
1618
 
1549
 
    def get_format_string(self):
1550
 
        """Return the ASCII format string that identifies this format."""
1551
 
        raise NotImplementedError(self.get_format_string)
1552
 
 
1553
1619
    def get_format_description(self):
1554
1620
        """Return the short format description for this format."""
1555
1621
        raise NotImplementedError(self.get_format_description)
1556
1622
 
1557
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
 
1623
    def _run_post_branch_init_hooks(self, controldir, name, branch):
1558
1624
        hooks = Branch.hooks['post_branch_init']
1559
1625
        if not hooks:
1560
1626
            return
1561
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
 
1627
        params = BranchInitHookParams(self, controldir, name, branch)
1562
1628
        for hook in hooks:
1563
1629
            hook(params)
1564
1630
 
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
 
        
 
1631
    def initialize(self, controldir, name=None, repository=None,
 
1632
                   append_revisions_only=None):
 
1633
        """Create a branch of this format in controldir.
 
1634
 
1613
1635
        :param name: Name of the colocated branch to create.
1614
1636
        """
1615
1637
        raise NotImplementedError(self.initialize)
1635
1657
        Note that it is normal for branch to be a RemoteBranch when using tags
1636
1658
        on a RemoteBranch.
1637
1659
        """
1638
 
        return DisabledTags(branch)
 
1660
        return _mod_tag.DisabledTags(branch)
1639
1661
 
1640
1662
    def network_name(self):
1641
1663
        """A simple byte string uniquely identifying this format for RPC calls.
1647
1669
        """
1648
1670
        raise NotImplementedError(self.network_name)
1649
1671
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1651
 
        """Return the branch object for a_bzrdir
 
1672
    def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
 
1673
            found_repository=None, possible_transports=None):
 
1674
        """Return the branch object for controldir.
1652
1675
 
1653
 
        :param a_bzrdir: A BzrDir that contains a branch.
 
1676
        :param controldir: A ControlDir that contains a branch.
1654
1677
        :param name: Name of colocated branch to open
1655
1678
        :param _found: a private parameter, do not use it. It is used to
1656
1679
            indicate if format probing has already be done.
1659
1682
        """
1660
1683
        raise NotImplementedError(self.open)
1661
1684
 
1662
 
    @classmethod
1663
 
    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__)
1669
 
 
1670
 
    @classmethod
1671
 
    def set_default_format(klass, format):
1672
 
        klass._default_format = format
1673
 
 
1674
1685
    def supports_set_append_revisions_only(self):
1675
1686
        """True if this format supports set_append_revisions_only."""
1676
1687
        return False
1679
1690
        """True if this format records a stacked-on branch."""
1680
1691
        return False
1681
1692
 
 
1693
    def supports_leaving_lock(self):
 
1694
        """True if this format supports leaving locks in place."""
 
1695
        return False # by default
 
1696
 
1682
1697
    @classmethod
 
1698
    @deprecated_method(deprecated_in((2, 4, 0)))
1683
1699
    def unregister_format(klass, format):
1684
 
        del klass._formats[format.get_format_string()]
 
1700
        format_registry.remove(format)
1685
1701
 
1686
1702
    def __str__(self):
1687
1703
        return self.get_format_description().rstrip()
1690
1706
        """True if this format supports tags stored in the branch"""
1691
1707
        return False  # by default
1692
1708
 
 
1709
    def tags_are_versioned(self):
 
1710
        """Whether the tag container for this branch versions tags."""
 
1711
        return False
 
1712
 
 
1713
    def supports_tags_referencing_ghosts(self):
 
1714
        """True if tags can reference ghost revisions."""
 
1715
        return True
 
1716
 
 
1717
 
 
1718
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1719
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1720
    
 
1721
    While none of the built in BranchFormats are lazy registered yet,
 
1722
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1723
    use it, and the bzr-loom plugin uses it as well (see
 
1724
    bzrlib.plugins.loom.formats).
 
1725
    """
 
1726
 
 
1727
    def __init__(self, format_string, module_name, member_name):
 
1728
        """Create a MetaDirBranchFormatFactory.
 
1729
 
 
1730
        :param format_string: The format string the format has.
 
1731
        :param module_name: Module to load the format class from.
 
1732
        :param member_name: Attribute name within the module for the format class.
 
1733
        """
 
1734
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1735
        self._format_string = format_string
 
1736
 
 
1737
    def get_format_string(self):
 
1738
        """See BranchFormat.get_format_string."""
 
1739
        return self._format_string
 
1740
 
 
1741
    def __call__(self):
 
1742
        """Used for network_format_registry support."""
 
1743
        return self.get_obj()()
 
1744
 
1693
1745
 
1694
1746
class BranchHooks(Hooks):
1695
1747
    """A dictionary mapping hook name to a list of callables for branch hooks.
1696
1748
 
1697
 
    e.g. ['set_rh'] Is the list of items to be called when the
1698
 
    set_revision_history function is invoked.
 
1749
    e.g. ['post_push'] Is the list of items to be called when the
 
1750
    push function is invoked.
1699
1751
    """
1700
1752
 
1701
1753
    def __init__(self):
1704
1756
        These are all empty initially, because by default nothing should get
1705
1757
        notified.
1706
1758
        """
1707
 
        Hooks.__init__(self)
1708
 
        self.create_hook(HookPoint('set_rh',
1709
 
            "Invoked whenever the revision history has been set via "
1710
 
            "set_revision_history. The api signature is (branch, "
1711
 
            "revision_history), and the branch will be write-locked. "
1712
 
            "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',
 
1759
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1760
        self.add_hook('open',
1715
1761
            "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',
 
1762
            "branch is opened.", (1, 8))
 
1763
        self.add_hook('post_push',
1718
1764
            "Called after a push operation completes. post_push is called "
1719
1765
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
 
            "bzr client.", (0, 15), None))
1721
 
        self.create_hook(HookPoint('post_pull',
 
1766
            "bzr client.", (0, 15))
 
1767
        self.add_hook('post_pull',
1722
1768
            "Called after a pull operation completes. post_pull is called "
1723
1769
            "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 "
 
1770
            "bzr client.", (0, 15))
 
1771
        self.add_hook('pre_commit',
 
1772
            "Called after a commit is calculated but before it is "
1727
1773
            "completed. pre_commit is called with (local, master, old_revno, "
1728
1774
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
1775
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1731
1777
            "basis revision. hooks MUST NOT modify this delta. "
1732
1778
            " future_tree is an in-memory tree obtained from "
1733
1779
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
 
            "tree.", (0,91), None))
1735
 
        self.create_hook(HookPoint('post_commit',
 
1780
            "tree.", (0,91))
 
1781
        self.add_hook('post_commit',
1736
1782
            "Called in the bzr client after a commit has completed. "
1737
1783
            "post_commit is called with (local, master, old_revno, old_revid, "
1738
1784
            "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',
 
1785
            "commit to a branch.", (0, 15))
 
1786
        self.add_hook('post_uncommit',
1741
1787
            "Called in the bzr client after an uncommit completes. "
1742
1788
            "post_uncommit is called with (local, master, old_revno, "
1743
1789
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
1790
            "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',
 
1791
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1792
        self.add_hook('pre_change_branch_tip',
1747
1793
            "Called in bzr client and server before a change to the tip of a "
1748
1794
            "branch is made. pre_change_branch_tip is called with a "
1749
1795
            "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',
 
1796
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1797
        self.add_hook('post_change_branch_tip',
1752
1798
            "Called in bzr client and server after a change to the tip of a "
1753
1799
            "branch is made. post_change_branch_tip is called with a "
1754
1800
            "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',
 
1801
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1802
        self.add_hook('transform_fallback_location',
1757
1803
            "Called when a stacked branch is activating its fallback "
1758
1804
            "locations. transform_fallback_location is called with (branch, "
1759
1805
            "url), and should return a new url. Returning the same url "
1764
1810
            "fallback locations have not been activated. When there are "
1765
1811
            "multiple hooks installed for transform_fallback_location, "
1766
1812
            "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."
 
1813
            "The order is however undefined.", (1, 9))
 
1814
        self.add_hook('automatic_tag_name',
 
1815
            "Called to determine an automatic tag name for a revision. "
1770
1816
            "automatic_tag_name is called with (branch, revision_id) and "
1771
1817
            "should return a tag name or None if no tag name could be "
1772
1818
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
 
1819
            (2, 2))
 
1820
        self.add_hook('post_branch_init',
1775
1821
            "Called after new branch initialization completes. "
1776
1822
            "post_branch_init is called with a "
1777
1823
            "bzrlib.branch.BranchInitHookParams. "
1778
1824
            "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',
 
1825
            "lightweight) will all trigger this hook.", (2, 2))
 
1826
        self.add_hook('post_switch',
1781
1827
            "Called after a checkout switches branch. "
1782
1828
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1829
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1784
1830
 
1785
1831
 
1786
1832
 
1789
1835
 
1790
1836
 
1791
1837
class ChangeBranchTipParams(object):
1792
 
    """Object holding parameters passed to *_change_branch_tip hooks.
 
1838
    """Object holding parameters passed to `*_change_branch_tip` hooks.
1793
1839
 
1794
1840
    There are 5 fields that hooks may wish to access:
1795
1841
 
1827
1873
 
1828
1874
 
1829
1875
class BranchInitHookParams(object):
1830
 
    """Object holding parameters passed to *_branch_init hooks.
 
1876
    """Object holding parameters passed to `*_branch_init` hooks.
1831
1877
 
1832
1878
    There are 4 fields that hooks may wish to access:
1833
1879
 
1834
1880
    :ivar format: the branch format
1835
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
 
1881
    :ivar bzrdir: the ControlDir where the branch will be/has been initialized
1836
1882
    :ivar name: name of colocated branch, if any (or None)
1837
1883
    :ivar branch: the branch created
1838
1884
 
1841
1887
    branch, which refer to the original branch.
1842
1888
    """
1843
1889
 
1844
 
    def __init__(self, format, a_bzrdir, name, branch):
 
1890
    def __init__(self, format, controldir, name, branch):
1845
1891
        """Create a group of BranchInitHook parameters.
1846
1892
 
1847
1893
        :param format: the branch format
1848
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
 
1894
        :param controldir: the ControlDir where the branch will be/has been
1849
1895
            initialized
1850
1896
        :param name: name of colocated branch, if any (or None)
1851
1897
        :param branch: the branch created
1855
1901
        in branch, which refer to the original branch.
1856
1902
        """
1857
1903
        self.format = format
1858
 
        self.bzrdir = a_bzrdir
 
1904
        self.bzrdir = controldir
1859
1905
        self.name = name
1860
1906
        self.branch = branch
1861
1907
 
1863
1909
        return self.__dict__ == other.__dict__
1864
1910
 
1865
1911
    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)
 
1912
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1872
1913
 
1873
1914
 
1874
1915
class SwitchHookParams(object):
1875
 
    """Object holding parameters passed to *_switch hooks.
 
1916
    """Object holding parameters passed to `*_switch` hooks.
1876
1917
 
1877
1918
    There are 4 fields that hooks may wish to access:
1878
1919
 
1879
 
    :ivar control_dir: BzrDir of the checkout to change
 
1920
    :ivar control_dir: ControlDir of the checkout to change
1880
1921
    :ivar to_branch: branch that the checkout is to reference
1881
1922
    :ivar force: skip the check for local commits in a heavy checkout
1882
1923
    :ivar revision_id: revision ID to switch to (or None)
1885
1926
    def __init__(self, control_dir, to_branch, force, revision_id):
1886
1927
        """Create a group of SwitchHook parameters.
1887
1928
 
1888
 
        :param control_dir: BzrDir of the checkout to change
 
1929
        :param control_dir: ControlDir of the checkout to change
1889
1930
        :param to_branch: branch that the checkout is to reference
1890
1931
        :param force: skip the check for local commits in a heavy checkout
1891
1932
        :param revision_id: revision ID to switch to (or None)
1904
1945
            self.revision_id)
1905
1946
 
1906
1947
 
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 ]
 
1948
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
 
1949
    """Base class for branch formats that live in meta directories.
1913
1950
    """
1914
1951
 
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
1952
    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
 
class BranchFormatMetadir(BranchFormat):
1951
 
    """Common logic for meta-dir based branch formats."""
 
1953
        BranchFormat.__init__(self)
 
1954
        bzrdir.BzrFormat.__init__(self)
 
1955
 
 
1956
    @classmethod
 
1957
    def find_format(klass, controldir, name=None):
 
1958
        """Return the format for the branch object in controldir."""
 
1959
        try:
 
1960
            transport = controldir.get_branch_transport(None, name=name)
 
1961
        except errors.NoSuchFile:
 
1962
            raise errors.NotBranchError(path=name, bzrdir=controldir)
 
1963
        try:
 
1964
            format_string = transport.get_bytes("format")
 
1965
        except errors.NoSuchFile:
 
1966
            raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
 
1967
        return klass._find_format(format_registry, 'branch', format_string)
1952
1968
 
1953
1969
    def _branch_class(self):
1954
1970
        """What class to instantiate on open calls."""
1955
1971
        raise NotImplementedError(self._branch_class)
1956
1972
 
1957
 
    def network_name(self):
1958
 
        """A simple byte string uniquely identifying this format for RPC calls.
1959
 
 
1960
 
        Metadir branch formats use their format string.
 
1973
    def _get_initial_config(self, append_revisions_only=None):
 
1974
        if append_revisions_only:
 
1975
            return "append_revisions_only = True\n"
 
1976
        else:
 
1977
            # Avoid writing anything if append_revisions_only is disabled,
 
1978
            # as that is the default.
 
1979
            return ""
 
1980
 
 
1981
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
1982
                           repository=None):
 
1983
        """Initialize a branch in a control dir, with specified files
 
1984
 
 
1985
        :param a_bzrdir: The bzrdir to initialize the branch in
 
1986
        :param utf8_files: The files to create as a list of
 
1987
            (filename, content) tuples
 
1988
        :param name: Name of colocated branch to create, if any
 
1989
        :return: a branch in this format
1961
1990
        """
1962
 
        return self.get_format_string()
 
1991
        if name is None:
 
1992
            name = a_bzrdir._get_selected_branch()
 
1993
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1994
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1995
        control_files = lockable_files.LockableFiles(branch_transport,
 
1996
            'lock', lockdir.LockDir)
 
1997
        control_files.create_lock()
 
1998
        control_files.lock_write()
 
1999
        try:
 
2000
            utf8_files += [('format', self.as_string())]
 
2001
            for (filename, content) in utf8_files:
 
2002
                branch_transport.put_bytes(
 
2003
                    filename, content,
 
2004
                    mode=a_bzrdir._get_file_mode())
 
2005
        finally:
 
2006
            control_files.unlock()
 
2007
        branch = self.open(a_bzrdir, name, _found=True,
 
2008
                found_repository=repository)
 
2009
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2010
        return branch
1963
2011
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2012
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2013
            found_repository=None, possible_transports=None):
1965
2014
        """See BranchFormat.open()."""
 
2015
        if name is None:
 
2016
            name = a_bzrdir._get_selected_branch()
1966
2017
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2018
            format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
1968
2019
            if format.__class__ != self.__class__:
1969
2020
                raise AssertionError("wrong format %r found for %r" %
1970
2021
                    (format, self))
1972
2023
        try:
1973
2024
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
2025
                                                         lockdir.LockDir)
 
2026
            if found_repository is None:
 
2027
                found_repository = a_bzrdir.find_repository()
1975
2028
            return self._branch_class()(_format=self,
1976
2029
                              _control_files=control_files,
1977
2030
                              name=name,
1978
2031
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
1980
 
                              ignore_fallbacks=ignore_fallbacks)
 
2032
                              _repository=found_repository,
 
2033
                              ignore_fallbacks=ignore_fallbacks,
 
2034
                              possible_transports=possible_transports)
1981
2035
        except errors.NoSuchFile:
1982
2036
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1983
2037
 
1984
 
    def __init__(self):
1985
 
        super(BranchFormatMetadir, self).__init__()
1986
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1987
 
        self._matchingbzrdir.set_branch_format(self)
 
2038
    @property
 
2039
    def _matchingbzrdir(self):
 
2040
        ret = bzrdir.BzrDirMetaFormat1()
 
2041
        ret.set_branch_format(self)
 
2042
        return ret
1988
2043
 
1989
2044
    def supports_tags(self):
1990
2045
        return True
1991
2046
 
 
2047
    def supports_leaving_lock(self):
 
2048
        return True
 
2049
 
 
2050
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
2051
            basedir=None):
 
2052
        BranchFormat.check_support_status(self,
 
2053
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
2054
            basedir=basedir)
 
2055
        bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
2056
            recommend_upgrade=recommend_upgrade, basedir=basedir)
 
2057
 
1992
2058
 
1993
2059
class BzrBranchFormat5(BranchFormatMetadir):
1994
2060
    """Bzr branch format 5.
2006
2072
    def _branch_class(self):
2007
2073
        return BzrBranch5
2008
2074
 
2009
 
    def get_format_string(self):
 
2075
    @classmethod
 
2076
    def get_format_string(cls):
2010
2077
        """See BranchFormat.get_format_string()."""
2011
2078
        return "Bazaar-NG branch format 5\n"
2012
2079
 
2014
2081
        """See BranchFormat.get_format_description()."""
2015
2082
        return "Branch format 5"
2016
2083
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
2084
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2085
                   append_revisions_only=None):
2018
2086
        """Create a branch of this format in a_bzrdir."""
 
2087
        if append_revisions_only:
 
2088
            raise errors.UpgradeRequired(a_bzrdir.user_url)
2019
2089
        utf8_files = [('revision-history', ''),
2020
2090
                      ('branch-name', ''),
2021
2091
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2092
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2023
2093
 
2024
2094
    def supports_tags(self):
2025
2095
        return False
2039
2109
    def _branch_class(self):
2040
2110
        return BzrBranch6
2041
2111
 
2042
 
    def get_format_string(self):
 
2112
    @classmethod
 
2113
    def get_format_string(cls):
2043
2114
        """See BranchFormat.get_format_string()."""
2044
2115
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
2045
2116
 
2047
2118
        """See BranchFormat.get_format_description()."""
2048
2119
        return "Branch format 6"
2049
2120
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
2121
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2122
                   append_revisions_only=None):
2051
2123
        """Create a branch of this format in a_bzrdir."""
2052
2124
        utf8_files = [('last-revision', '0 null:\n'),
2053
 
                      ('branch.conf', ''),
 
2125
                      ('branch.conf',
 
2126
                          self._get_initial_config(append_revisions_only)),
2054
2127
                      ('tags', ''),
2055
2128
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2129
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2057
2130
 
2058
2131
    def make_tags(self, branch):
2059
2132
        """See bzrlib.branch.BranchFormat.make_tags()."""
2060
 
        return BasicTags(branch)
 
2133
        return _mod_tag.BasicTags(branch)
2061
2134
 
2062
2135
    def supports_set_append_revisions_only(self):
2063
2136
        return True
2069
2142
    def _branch_class(self):
2070
2143
        return BzrBranch8
2071
2144
 
2072
 
    def get_format_string(self):
 
2145
    @classmethod
 
2146
    def get_format_string(cls):
2073
2147
        """See BranchFormat.get_format_string()."""
2074
2148
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2075
2149
 
2077
2151
        """See BranchFormat.get_format_description()."""
2078
2152
        return "Branch format 8"
2079
2153
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
2154
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2155
                   append_revisions_only=None):
2081
2156
        """Create a branch of this format in a_bzrdir."""
2082
2157
        utf8_files = [('last-revision', '0 null:\n'),
2083
 
                      ('branch.conf', ''),
 
2158
                      ('branch.conf',
 
2159
                          self._get_initial_config(append_revisions_only)),
2084
2160
                      ('tags', ''),
2085
2161
                      ('references', '')
2086
2162
                      ]
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()
 
2163
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2093
2164
 
2094
2165
    def make_tags(self, branch):
2095
2166
        """See bzrlib.branch.BranchFormat.make_tags()."""
2096
 
        return BasicTags(branch)
 
2167
        return _mod_tag.BasicTags(branch)
2097
2168
 
2098
2169
    def supports_set_append_revisions_only(self):
2099
2170
        return True
2104
2175
    supports_reference_locations = True
2105
2176
 
2106
2177
 
2107
 
class BzrBranchFormat7(BzrBranchFormat8):
 
2178
class BzrBranchFormat7(BranchFormatMetadir):
2108
2179
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
2180
 
2110
2181
    The stacked location pointer is passed down to the repository and requires
2113
2184
    This format was introduced in bzr 1.6.
2114
2185
    """
2115
2186
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
2187
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2188
                   append_revisions_only=None):
2117
2189
        """Create a branch of this format in a_bzrdir."""
2118
2190
        utf8_files = [('last-revision', '0 null:\n'),
2119
 
                      ('branch.conf', ''),
 
2191
                      ('branch.conf',
 
2192
                          self._get_initial_config(append_revisions_only)),
2120
2193
                      ('tags', ''),
2121
2194
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2195
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2123
2196
 
2124
2197
    def _branch_class(self):
2125
2198
        return BzrBranch7
2126
2199
 
2127
 
    def get_format_string(self):
 
2200
    @classmethod
 
2201
    def get_format_string(cls):
2128
2202
        """See BranchFormat.get_format_string()."""
2129
2203
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2130
2204
 
2135
2209
    def supports_set_append_revisions_only(self):
2136
2210
        return True
2137
2211
 
 
2212
    def supports_stacking(self):
 
2213
        return True
 
2214
 
 
2215
    def make_tags(self, branch):
 
2216
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2217
        return _mod_tag.BasicTags(branch)
 
2218
 
2138
2219
    supports_reference_locations = False
2139
2220
 
2140
2221
 
2141
 
class BranchReferenceFormat(BranchFormat):
 
2222
class BranchReferenceFormat(BranchFormatMetadir):
2142
2223
    """Bzr branch reference format.
2143
2224
 
2144
2225
    Branch references are used in implementing checkouts, they
2149
2230
     - a format string
2150
2231
    """
2151
2232
 
2152
 
    def get_format_string(self):
 
2233
    @classmethod
 
2234
    def get_format_string(cls):
2153
2235
        """See BranchFormat.get_format_string()."""
2154
2236
        return "Bazaar-NG Branch Reference Format 1\n"
2155
2237
 
2157
2239
        """See BranchFormat.get_format_description()."""
2158
2240
        return "Checkout reference format 1"
2159
2241
 
2160
 
    def get_reference(self, a_bzrdir):
 
2242
    def get_reference(self, a_bzrdir, name=None):
2161
2243
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2244
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2245
        return transport.get_bytes('location')
2164
2246
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2247
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2248
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2249
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2250
        location = transport.put_bytes('location', to_branch.base)
2169
2251
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2252
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2253
            repository=None, append_revisions_only=None):
2171
2254
        """Create a branch of this format in a_bzrdir."""
2172
2255
        if target_branch is None:
2173
2256
            # this format does not implement branch itself, thus the implicit
2174
2257
            # creation contract must see it as uninitializable
2175
2258
            raise errors.UninitializableFormat(self)
2176
2259
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2260
        if a_bzrdir._format.fixed_components:
 
2261
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
 
2262
        if name is None:
 
2263
            name = a_bzrdir._get_selected_branch()
2177
2264
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2178
2265
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
2180
 
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
2266
            target_branch.user_url)
 
2267
        branch_transport.put_bytes('format', self.as_string())
 
2268
        branch = self.open(a_bzrdir, name, _found=True,
2183
2269
            possible_transports=[target_branch.bzrdir.root_transport])
2184
2270
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
2271
        return branch
2186
2272
 
2187
 
    def __init__(self):
2188
 
        super(BranchReferenceFormat, self).__init__()
2189
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2190
 
        self._matchingbzrdir.set_branch_format(self)
2191
 
 
2192
2273
    def _make_reference_clone_function(format, a_branch):
2193
2274
        """Create a clone() routine for a branch dynamically."""
2194
2275
        def clone(to_bzrdir, revision_id=None,
2201
2282
        return clone
2202
2283
 
2203
2284
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
2285
             possible_transports=None, ignore_fallbacks=False,
 
2286
             found_repository=None):
2205
2287
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2288
 
2207
2289
        :param a_bzrdir: A BzrDir that contains a branch.
2215
2297
            a_bzrdir.
2216
2298
        :param possible_transports: An optional reusable transports list.
2217
2299
        """
 
2300
        if name is None:
 
2301
            name = a_bzrdir._get_selected_branch()
2218
2302
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2303
            format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2220
2304
            if format.__class__ != self.__class__:
2221
2305
                raise AssertionError("wrong format %r found for %r" %
2222
2306
                    (format, self))
2223
2307
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
2225
 
        real_bzrdir = bzrdir.BzrDir.open(
 
2308
            location = self.get_reference(a_bzrdir, name)
 
2309
        real_bzrdir = controldir.ControlDir.open(
2226
2310
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
2311
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks,
 
2312
            possible_transports=possible_transports)
2229
2313
        # this changes the behaviour of result.clone to create a new reference
2230
2314
        # rather than a copy of the content of the branch.
2231
2315
        # I did not use a proxy object because that needs much more extensive
2238
2322
        return result
2239
2323
 
2240
2324
 
 
2325
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2326
    """Branch format registry."""
 
2327
 
 
2328
    def __init__(self, other_registry=None):
 
2329
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2330
        self._default_format = None
 
2331
 
 
2332
    def set_default(self, format):
 
2333
        self._default_format = format
 
2334
 
 
2335
    def get_default(self):
 
2336
        return self._default_format
 
2337
 
 
2338
 
2241
2339
network_format_registry = registry.FormatRegistry()
2242
2340
"""Registry of formats indexed by their network name.
2243
2341
 
2246
2344
BranchFormat.network_name() for more detail.
2247
2345
"""
2248
2346
 
 
2347
format_registry = BranchFormatRegistry(network_format_registry)
 
2348
 
2249
2349
 
2250
2350
# formats which have no format string are not discoverable
2251
2351
# and not independently creatable, so are not registered.
2253
2353
__format6 = BzrBranchFormat6()
2254
2354
__format7 = BzrBranchFormat7()
2255
2355
__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__)
 
2356
format_registry.register(__format5)
 
2357
format_registry.register(BranchReferenceFormat())
 
2358
format_registry.register(__format6)
 
2359
format_registry.register(__format7)
 
2360
format_registry.register(__format8)
 
2361
format_registry.set_default(__format7)
 
2362
 
 
2363
 
 
2364
class BranchWriteLockResult(LogicalLockResult):
 
2365
    """The result of write locking a branch.
 
2366
 
 
2367
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2368
        None.
 
2369
    :ivar unlock: A callable which will unlock the lock.
 
2370
    """
 
2371
 
 
2372
    def __init__(self, unlock, branch_token):
 
2373
        LogicalLockResult.__init__(self, unlock)
 
2374
        self.branch_token = branch_token
 
2375
 
 
2376
    def __repr__(self):
 
2377
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2378
            self.unlock)
2266
2379
 
2267
2380
 
2268
2381
class BzrBranch(Branch, _RelockDebugMixin):
2283
2396
 
2284
2397
    def __init__(self, _format=None,
2285
2398
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
2399
                 _repository=None, ignore_fallbacks=False,
 
2400
                 possible_transports=None):
2287
2401
        """Create new branch object at a particular location."""
2288
2402
        if a_bzrdir is None:
2289
2403
            raise ValueError('a_bzrdir must be supplied')
2290
 
        else:
2291
 
            self.bzrdir = a_bzrdir
2292
 
        self._base = self.bzrdir.transport.clone('..').base
 
2404
        if name is None:
 
2405
            raise ValueError('name must be supplied')
 
2406
        self.bzrdir = a_bzrdir
 
2407
        self._user_transport = self.bzrdir.transport.clone('..')
 
2408
        if name != "":
 
2409
            self._user_transport.set_segment_parameter(
 
2410
                "branch", urlutils.escape(name))
 
2411
        self._base = self._user_transport.base
2293
2412
        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
2413
        self._format = _format
2298
2414
        if _control_files is None:
2299
2415
            raise ValueError('BzrBranch _control_files is None')
2300
2416
        self.control_files = _control_files
2301
2417
        self._transport = _control_files._transport
2302
2418
        self.repository = _repository
2303
 
        Branch.__init__(self)
 
2419
        self.conf_store = None
 
2420
        Branch.__init__(self, possible_transports)
2304
2421
 
2305
2422
    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)
 
2423
        return '%s(%s)' % (self.__class__.__name__, self.user_url)
2311
2424
 
2312
2425
    __repr__ = __str__
2313
2426
 
2317
2430
 
2318
2431
    base = property(_get_base, doc="The URL for the root of this branch.")
2319
2432
 
 
2433
    @property
 
2434
    def user_transport(self):
 
2435
        return self._user_transport
 
2436
 
2320
2437
    def _get_config(self):
2321
 
        return TransportConfig(self._transport, 'branch.conf')
 
2438
        return _mod_config.TransportConfig(self._transport, 'branch.conf')
 
2439
 
 
2440
    def _get_config_store(self):
 
2441
        if self.conf_store is None:
 
2442
            self.conf_store =  _mod_config.BranchStore(self)
 
2443
        return self.conf_store
2322
2444
 
2323
2445
    def is_locked(self):
2324
2446
        return self.control_files.is_locked()
2325
2447
 
2326
2448
    def lock_write(self, token=None):
 
2449
        """Lock the branch for write operations.
 
2450
 
 
2451
        :param token: A token to permit reacquiring a previously held and
 
2452
            preserved lock.
 
2453
        :return: A BranchWriteLockResult.
 
2454
        """
2327
2455
        if not self.is_locked():
2328
2456
            self._note_lock('w')
2329
2457
        # All-in-one needs to always unlock/lock.
2335
2463
        else:
2336
2464
            took_lock = False
2337
2465
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2466
            return BranchWriteLockResult(self.unlock,
 
2467
                self.control_files.lock_write(token=token))
2339
2468
        except:
2340
2469
            if took_lock:
2341
2470
                self.repository.unlock()
2342
2471
            raise
2343
2472
 
2344
2473
    def lock_read(self):
 
2474
        """Lock the branch for read operations.
 
2475
 
 
2476
        :return: A bzrlib.lock.LogicalLockResult.
 
2477
        """
2345
2478
        if not self.is_locked():
2346
2479
            self._note_lock('r')
2347
2480
        # All-in-one needs to always unlock/lock.
2354
2487
            took_lock = False
2355
2488
        try:
2356
2489
            self.control_files.lock_read()
 
2490
            return LogicalLockResult(self.unlock)
2357
2491
        except:
2358
2492
            if took_lock:
2359
2493
                self.repository.unlock()
2361
2495
 
2362
2496
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
2497
    def unlock(self):
 
2498
        if self.control_files._lock_count == 1 and self.conf_store is not None:
 
2499
            self.conf_store.save_changes()
2364
2500
        try:
2365
2501
            self.control_files.unlock()
2366
2502
        finally:
2387
2523
        """See Branch.print_file."""
2388
2524
        return self.repository.print_file(file, revision_id)
2389
2525
 
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
2526
    @needs_write_lock
2454
2527
    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
 
        """
 
2528
        if not revision_id or not isinstance(revision_id, basestring):
 
2529
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2465
2530
        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))
 
2531
        old_revno, old_revid = self.last_revision_info()
 
2532
        if self.get_append_revisions_only():
 
2533
            self._check_history_violation(revision_id)
 
2534
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2535
        self._write_last_revision_info(revno, revision_id)
 
2536
        self._clear_cached_state()
 
2537
        self._last_revision_info_cache = revno, revision_id
 
2538
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2494
2539
 
2495
2540
    def basis_tree(self):
2496
2541
        """See Branch.basis_tree."""
2505
2550
                pass
2506
2551
        return None
2507
2552
 
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
2553
    def get_stacked_on_url(self):
2531
2554
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2532
2555
 
2543
2566
            self._transport.put_bytes('parent', url + '\n',
2544
2567
                mode=self.bzrdir._get_file_mode())
2545
2568
 
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
2569
    @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
 
2570
    def unbind(self):
 
2571
        """If bound, unbind"""
 
2572
        return self.set_bound_location(None)
2595
2573
 
2596
2574
    @needs_write_lock
2597
2575
    def bind(self, other):
2619
2597
        # history around
2620
2598
        self.set_bound_location(other.base)
2621
2599
 
 
2600
    def get_bound_location(self):
 
2601
        try:
 
2602
            return self._transport.get_bytes('bound')[:-1]
 
2603
        except errors.NoSuchFile:
 
2604
            return None
 
2605
 
 
2606
    @needs_read_lock
 
2607
    def get_master_branch(self, possible_transports=None):
 
2608
        """Return the branch we are bound to.
 
2609
 
 
2610
        :return: Either a Branch, or None
 
2611
        """
 
2612
        if self._master_branch_cache is None:
 
2613
            self._master_branch_cache = self._get_master_branch(
 
2614
                possible_transports)
 
2615
        return self._master_branch_cache
 
2616
 
 
2617
    def _get_master_branch(self, possible_transports):
 
2618
        bound_loc = self.get_bound_location()
 
2619
        if not bound_loc:
 
2620
            return None
 
2621
        try:
 
2622
            return Branch.open(bound_loc,
 
2623
                               possible_transports=possible_transports)
 
2624
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2625
            raise errors.BoundBranchConnectionFailure(
 
2626
                    self, bound_loc, e)
 
2627
 
2622
2628
    @needs_write_lock
2623
 
    def unbind(self):
2624
 
        """If bound, unbind"""
2625
 
        return self.set_bound_location(None)
 
2629
    def set_bound_location(self, location):
 
2630
        """Set the target where this branch is bound to.
 
2631
 
 
2632
        :param location: URL to the target branch
 
2633
        """
 
2634
        self._master_branch_cache = None
 
2635
        if location:
 
2636
            self._transport.put_bytes('bound', location+'\n',
 
2637
                mode=self.bzrdir._get_file_mode())
 
2638
        else:
 
2639
            try:
 
2640
                self._transport.delete('bound')
 
2641
            except errors.NoSuchFile:
 
2642
                return False
 
2643
            return True
2626
2644
 
2627
2645
    @needs_write_lock
2628
2646
    def update(self, possible_transports=None):
2641
2659
            return old_tip
2642
2660
        return None
2643
2661
 
2644
 
 
2645
 
class BzrBranch8(BzrBranch5):
 
2662
    def _read_last_revision_info(self):
 
2663
        revision_string = self._transport.get_bytes('last-revision')
 
2664
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2665
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2666
        revno = int(revno)
 
2667
        return revno, revision_id
 
2668
 
 
2669
    def _write_last_revision_info(self, revno, revision_id):
 
2670
        """Simply write out the revision id, with no checks.
 
2671
 
 
2672
        Use set_last_revision_info to perform this safely.
 
2673
 
 
2674
        Does not update the revision_history cache.
 
2675
        """
 
2676
        revision_id = _mod_revision.ensure_null(revision_id)
 
2677
        out_string = '%d %s\n' % (revno, revision_id)
 
2678
        self._transport.put_bytes('last-revision', out_string,
 
2679
            mode=self.bzrdir._get_file_mode())
 
2680
 
 
2681
    @needs_write_lock
 
2682
    def update_feature_flags(self, updated_flags):
 
2683
        """Update the feature flags for this branch.
 
2684
 
 
2685
        :param updated_flags: Dictionary mapping feature names to necessities
 
2686
            A necessity can be None to indicate the feature should be removed
 
2687
        """
 
2688
        self._format._update_feature_flags(updated_flags)
 
2689
        self.control_transport.put_bytes('format', self._format.as_string())
 
2690
 
 
2691
 
 
2692
class FullHistoryBzrBranch(BzrBranch):
 
2693
    """Bzr branch which contains the full revision history."""
 
2694
 
 
2695
    @needs_write_lock
 
2696
    def set_last_revision_info(self, revno, revision_id):
 
2697
        if not revision_id or not isinstance(revision_id, basestring):
 
2698
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2699
        revision_id = _mod_revision.ensure_null(revision_id)
 
2700
        # this old format stores the full history, but this api doesn't
 
2701
        # provide it, so we must generate, and might as well check it's
 
2702
        # correct
 
2703
        history = self._lefthand_history(revision_id)
 
2704
        if len(history) != revno:
 
2705
            raise AssertionError('%d != %d' % (len(history), revno))
 
2706
        self._set_revision_history(history)
 
2707
 
 
2708
    def _read_last_revision_info(self):
 
2709
        rh = self._revision_history()
 
2710
        revno = len(rh)
 
2711
        if revno:
 
2712
            return (revno, rh[-1])
 
2713
        else:
 
2714
            return (0, _mod_revision.NULL_REVISION)
 
2715
 
 
2716
    def _set_revision_history(self, rev_history):
 
2717
        if 'evil' in debug.debug_flags:
 
2718
            mutter_callsite(3, "set_revision_history scales with history.")
 
2719
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2720
        for rev_id in rev_history:
 
2721
            check_not_reserved_id(rev_id)
 
2722
        if Branch.hooks['post_change_branch_tip']:
 
2723
            # Don't calculate the last_revision_info() if there are no hooks
 
2724
            # that will use it.
 
2725
            old_revno, old_revid = self.last_revision_info()
 
2726
        if len(rev_history) == 0:
 
2727
            revid = _mod_revision.NULL_REVISION
 
2728
        else:
 
2729
            revid = rev_history[-1]
 
2730
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2731
        self._write_revision_history(rev_history)
 
2732
        self._clear_cached_state()
 
2733
        self._cache_revision_history(rev_history)
 
2734
        if Branch.hooks['post_change_branch_tip']:
 
2735
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2736
 
 
2737
    def _write_revision_history(self, history):
 
2738
        """Factored out of set_revision_history.
 
2739
 
 
2740
        This performs the actual writing to disk.
 
2741
        It is intended to be called by set_revision_history."""
 
2742
        self._transport.put_bytes(
 
2743
            'revision-history', '\n'.join(history),
 
2744
            mode=self.bzrdir._get_file_mode())
 
2745
 
 
2746
    def _gen_revision_history(self):
 
2747
        history = self._transport.get_bytes('revision-history').split('\n')
 
2748
        if history[-1:] == ['']:
 
2749
            # There shouldn't be a trailing newline, but just in case.
 
2750
            history.pop()
 
2751
        return history
 
2752
 
 
2753
    def _synchronize_history(self, destination, revision_id):
 
2754
        if not isinstance(destination, FullHistoryBzrBranch):
 
2755
            super(BzrBranch, self)._synchronize_history(
 
2756
                destination, revision_id)
 
2757
            return
 
2758
        if revision_id == _mod_revision.NULL_REVISION:
 
2759
            new_history = []
 
2760
        else:
 
2761
            new_history = self._revision_history()
 
2762
        if revision_id is not None and new_history != []:
 
2763
            try:
 
2764
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2765
            except ValueError:
 
2766
                rev = self.repository.get_revision(revision_id)
 
2767
                new_history = rev.get_history(self.repository)[1:]
 
2768
        destination._set_revision_history(new_history)
 
2769
 
 
2770
    @needs_write_lock
 
2771
    def generate_revision_history(self, revision_id, last_rev=None,
 
2772
        other_branch=None):
 
2773
        """Create a new revision history that will finish with revision_id.
 
2774
 
 
2775
        :param revision_id: the new tip to use.
 
2776
        :param last_rev: The previous last_revision. If not None, then this
 
2777
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2778
        :param other_branch: The other branch that DivergedBranches should
 
2779
            raise with respect to.
 
2780
        """
 
2781
        self._set_revision_history(self._lefthand_history(revision_id,
 
2782
            last_rev, other_branch))
 
2783
 
 
2784
 
 
2785
class BzrBranch5(FullHistoryBzrBranch):
 
2786
    """A format 5 branch. This supports new features over plain branches.
 
2787
 
 
2788
    It has support for a master_branch which is the data for bound branches.
 
2789
    """
 
2790
 
 
2791
 
 
2792
class BzrBranch8(BzrBranch):
2646
2793
    """A branch that stores tree-reference locations."""
2647
2794
 
2648
 
    def _open_hook(self):
 
2795
    def _open_hook(self, possible_transports=None):
2649
2796
        if self._ignore_fallbacks:
2650
2797
            return
 
2798
        if possible_transports is None:
 
2799
            possible_transports = [self.bzrdir.root_transport]
2651
2800
        try:
2652
2801
            url = self.get_stacked_on_url()
2653
2802
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2661
2810
                    raise AssertionError(
2662
2811
                        "'transform_fallback_location' hook %s returned "
2663
2812
                        "None, not a URL." % hook_name)
2664
 
            self._activate_fallback_location(url)
 
2813
            self._activate_fallback_location(url,
 
2814
                possible_transports=possible_transports)
2665
2815
 
2666
2816
    def __init__(self, *args, **kwargs):
2667
2817
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2674
2824
        self._last_revision_info_cache = None
2675
2825
        self._reference_info = None
2676
2826
 
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
2827
    def _check_history_violation(self, revision_id):
2723
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
 
2828
        current_revid = self.last_revision()
 
2829
        last_revision = _mod_revision.ensure_null(current_revid)
2724
2830
        if _mod_revision.is_null(last_revision):
2725
2831
            return
2726
 
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2832
        graph = self.repository.get_graph()
 
2833
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
 
2834
            if lh_ancestor == current_revid:
 
2835
                return
 
2836
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
2728
2837
 
2729
2838
    def _gen_revision_history(self):
2730
2839
        """Generate the revision history from last revision
2733
2842
        self._extend_partial_history(stop_index=last_revno-1)
2734
2843
        return list(reversed(self._partial_revision_history_cache))
2735
2844
 
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
2845
    @needs_write_lock
2753
2846
    def _set_parent_location(self, url):
2754
2847
        """Set the parent branch"""
2840
2933
 
2841
2934
    def set_bound_location(self, location):
2842
2935
        """See Branch.set_push_location."""
 
2936
        self._master_branch_cache = None
2843
2937
        result = None
2844
 
        config = self.get_config()
 
2938
        conf = self.get_config_stack()
2845
2939
        if location is None:
2846
 
            if config.get_user_option('bound') != 'True':
 
2940
            if not conf.get('bound'):
2847
2941
                return False
2848
2942
            else:
2849
 
                config.set_user_option('bound', 'False', warn_masked=True)
 
2943
                conf.set('bound', 'False')
2850
2944
                return True
2851
2945
        else:
2852
2946
            self._set_config_location('bound_location', location,
2853
 
                                      config=config)
2854
 
            config.set_user_option('bound', 'True', warn_masked=True)
 
2947
                                      config=conf)
 
2948
            conf.set('bound', 'True')
2855
2949
        return True
2856
2950
 
2857
2951
    def _get_bound_location(self, bound):
2858
2952
        """Return the bound location in the config file.
2859
2953
 
2860
2954
        Return None if the bound parameter does not match"""
2861
 
        config = self.get_config()
2862
 
        config_bound = (config.get_user_option('bound') == 'True')
2863
 
        if config_bound != bound:
 
2955
        conf = self.get_config_stack()
 
2956
        if conf.get('bound') != bound:
2864
2957
            return None
2865
 
        return self._get_config_location('bound_location', config=config)
 
2958
        return self._get_config_location('bound_location', config=conf)
2866
2959
 
2867
2960
    def get_bound_location(self):
2868
 
        """See Branch.set_push_location."""
 
2961
        """See Branch.get_bound_location."""
2869
2962
        return self._get_bound_location(True)
2870
2963
 
2871
2964
    def get_old_bound_location(self):
2876
2969
        # you can always ask for the URL; but you might not be able to use it
2877
2970
        # if the repo can't support stacking.
2878
2971
        ## self._check_stackable_repo()
2879
 
        stacked_url = self._get_config_location('stacked_on_location')
 
2972
        # stacked_on_location is only ever defined in branch.conf, so don't
 
2973
        # waste effort reading the whole stack of config files.
 
2974
        conf = _mod_config.BranchOnlyStack(self)
 
2975
        stacked_url = self._get_config_location('stacked_on_location',
 
2976
                                                config=conf)
2880
2977
        if stacked_url is None:
2881
2978
            raise errors.NotStacked(self)
2882
 
        return stacked_url
2883
 
 
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)
 
2979
        return stacked_url.encode('utf-8')
2895
2980
 
2896
2981
    @needs_read_lock
2897
2982
    def get_rev_id(self, revno, history=None):
2922
3007
        try:
2923
3008
            index = self._partial_revision_history_cache.index(revision_id)
2924
3009
        except ValueError:
2925
 
            self._extend_partial_history(stop_revision=revision_id)
 
3010
            try:
 
3011
                self._extend_partial_history(stop_revision=revision_id)
 
3012
            except errors.RevisionNotPresent, e:
 
3013
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2926
3014
            index = len(self._partial_revision_history_cache) - 1
 
3015
            if index < 0:
 
3016
                raise errors.NoSuchRevision(self, revision_id)
2927
3017
            if self._partial_revision_history_cache[index] != revision_id:
2928
3018
                raise errors.NoSuchRevision(self, revision_id)
2929
3019
        return self.revno() - index
2981
3071
    :ivar local_branch: target branch if there is a Master, else None
2982
3072
    :ivar target_branch: Target/destination branch object. (write locked)
2983
3073
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
 
3074
    :ivar tag_updates: A dict with new tags, see BasicTags.merge_to
2984
3075
    """
2985
3076
 
2986
 
    def __int__(self):
2987
 
        # DEPRECATED: pull used to return the change in revno
2988
 
        return self.new_revno - self.old_revno
2989
 
 
2990
3077
    def report(self, to_file):
 
3078
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
3079
        tag_updates = getattr(self, "tag_updates", None)
2991
3080
        if not is_quiet():
2992
 
            if self.old_revid == self.new_revid:
2993
 
                to_file.write('No revisions to pull.\n')
2994
 
            else:
 
3081
            if self.old_revid != self.new_revid:
2995
3082
                to_file.write('Now on revision %d.\n' % self.new_revno)
 
3083
            if tag_updates:
 
3084
                to_file.write('%d tag(s) updated.\n' % len(tag_updates))
 
3085
            if self.old_revid == self.new_revid and not tag_updates:
 
3086
                if not tag_conflicts:
 
3087
                    to_file.write('No revisions or tags to pull.\n')
 
3088
                else:
 
3089
                    to_file.write('No revisions to pull.\n')
2996
3090
        self._show_tag_conficts(to_file)
2997
3091
 
2998
3092
 
3015
3109
        target, otherwise it will be None.
3016
3110
    """
3017
3111
 
3018
 
    def __int__(self):
3019
 
        # DEPRECATED: push used to return the change in revno
3020
 
        return self.new_revno - self.old_revno
3021
 
 
3022
3112
    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)
 
3113
        # TODO: This function gets passed a to_file, but then
 
3114
        # ignores it and calls note() instead. This is also
 
3115
        # inconsistent with PullResult(), which writes to stdout.
 
3116
        # -- JRV20110901, bug #838853
 
3117
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
3118
        tag_updates = getattr(self, "tag_updates", None)
 
3119
        if not is_quiet():
 
3120
            if self.old_revid != self.new_revid:
 
3121
                note(gettext('Pushed up to revision %d.') % self.new_revno)
 
3122
            if tag_updates:
 
3123
                note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
 
3124
            if self.old_revid == self.new_revid and not tag_updates:
 
3125
                if not tag_conflicts:
 
3126
                    note(gettext('No new revisions or tags to push.'))
 
3127
                else:
 
3128
                    note(gettext('No new revisions to push.'))
3028
3129
        self._show_tag_conficts(to_file)
3029
3130
 
3030
3131
 
3044
3145
        :param verbose: Requests more detailed display of what was checked,
3045
3146
            if any.
3046
3147
        """
3047
 
        note('checked branch %s format %s', self.branch.user_url,
3048
 
            self.branch._format)
 
3148
        note(gettext('checked branch {0} format {1}').format(
 
3149
                                self.branch.user_url, self.branch._format))
3049
3150
        for error in self.errors:
3050
 
            note('found error:%s', error)
 
3151
            note(gettext('found error:%s'), error)
3051
3152
 
3052
3153
 
3053
3154
class Converter5to6(object):
3060
3161
 
3061
3162
        # Copy source data into target
3062
3163
        new_branch._write_last_revision_info(*branch.last_revision_info())
3063
 
        new_branch.set_parent(branch.get_parent())
3064
 
        new_branch.set_bound_location(branch.get_bound_location())
3065
 
        new_branch.set_push_location(branch.get_push_location())
 
3164
        new_branch.lock_write()
 
3165
        try:
 
3166
            new_branch.set_parent(branch.get_parent())
 
3167
            new_branch.set_bound_location(branch.get_bound_location())
 
3168
            new_branch.set_push_location(branch.get_push_location())
 
3169
        finally:
 
3170
            new_branch.unlock()
3066
3171
 
3067
3172
        # New branch has no tags by default
3068
3173
        new_branch.tags._set_tag_dict({})
3069
3174
 
3070
3175
        # Copying done; now update target format
3071
3176
        new_branch._transport.put_bytes('format',
3072
 
            format.get_format_string(),
 
3177
            format.as_string(),
3073
3178
            mode=new_branch.bzrdir._get_file_mode())
3074
3179
 
3075
3180
        # Clean up old files
3076
3181
        new_branch._transport.delete('revision-history')
 
3182
        branch.lock_write()
3077
3183
        try:
3078
 
            branch.set_parent(None)
3079
 
        except errors.NoSuchFile:
3080
 
            pass
3081
 
        branch.set_bound_location(None)
 
3184
            try:
 
3185
                branch.set_parent(None)
 
3186
            except errors.NoSuchFile:
 
3187
                pass
 
3188
            branch.set_bound_location(None)
 
3189
        finally:
 
3190
            branch.unlock()
3082
3191
 
3083
3192
 
3084
3193
class Converter6to7(object):
3088
3197
        format = BzrBranchFormat7()
3089
3198
        branch._set_config_location('stacked_on_location', '')
3090
3199
        # update target format
3091
 
        branch._transport.put_bytes('format', format.get_format_string())
 
3200
        branch._transport.put_bytes('format', format.as_string())
3092
3201
 
3093
3202
 
3094
3203
class Converter7to8(object):
3095
 
    """Perform an in-place upgrade of format 6 to format 7"""
 
3204
    """Perform an in-place upgrade of format 7 to format 8"""
3096
3205
 
3097
3206
    def convert(self, branch):
3098
3207
        format = BzrBranchFormat8()
3099
3208
        branch._transport.put_bytes('references', '')
3100
3209
        # update target format
3101
 
        branch._transport.put_bytes('format', format.get_format_string())
3102
 
 
3103
 
 
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
 
3210
        branch._transport.put_bytes('format', format.as_string())
3135
3211
 
3136
3212
 
3137
3213
class InterBranch(InterObject):
3145
3221
    _optimisers = []
3146
3222
    """The available optimised InterBranch types."""
3147
3223
 
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)
 
3224
    @classmethod
 
3225
    def _get_branch_formats_to_test(klass):
 
3226
        """Return an iterable of format tuples for testing.
 
3227
        
 
3228
        :return: An iterable of (from_format, to_format) to use when testing
 
3229
            this InterBranch class. Each InterBranch class should define this
 
3230
            method itself.
 
3231
        """
 
3232
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3233
 
 
3234
    @needs_write_lock
3153
3235
    def pull(self, overwrite=False, stop_revision=None,
3154
3236
             possible_transports=None, local=False):
3155
3237
        """Mirror source into target branch.
3160
3242
        """
3161
3243
        raise NotImplementedError(self.pull)
3162
3244
 
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,
 
3245
    @needs_write_lock
 
3246
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3177
3247
             _override_hook_source_branch=None):
3178
3248
        """Mirror the source branch into the target branch.
3179
3249
 
3181
3251
        """
3182
3252
        raise NotImplementedError(self.push)
3183
3253
 
 
3254
    @needs_write_lock
 
3255
    def copy_content_into(self, revision_id=None):
 
3256
        """Copy the content of source into target
 
3257
 
 
3258
        revision_id: if not None, the revision history in the new branch will
 
3259
                     be truncated to end with revision_id.
 
3260
        """
 
3261
        raise NotImplementedError(self.copy_content_into)
 
3262
 
 
3263
    @needs_write_lock
 
3264
    def fetch(self, stop_revision=None, limit=None):
 
3265
        """Fetch revisions.
 
3266
 
 
3267
        :param stop_revision: Last revision to fetch
 
3268
        :param limit: Optional rough limit of revisions to fetch
 
3269
        """
 
3270
        raise NotImplementedError(self.fetch)
 
3271
 
 
3272
 
 
3273
def _fix_overwrite_type(overwrite):
 
3274
    if isinstance(overwrite, bool):
 
3275
        if overwrite:
 
3276
            return ["history", "tags"]
 
3277
        else:
 
3278
            return []
 
3279
    return overwrite
 
3280
 
3184
3281
 
3185
3282
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()."""
 
3283
    """InterBranch implementation that uses public Branch functions."""
 
3284
 
 
3285
    @classmethod
 
3286
    def is_compatible(klass, source, target):
 
3287
        # GenericBranch uses the public API, so always compatible
 
3288
        return True
 
3289
 
 
3290
    @classmethod
 
3291
    def _get_branch_formats_to_test(klass):
 
3292
        return [(format_registry.get_default(), format_registry.get_default())]
 
3293
 
 
3294
    @classmethod
 
3295
    def unwrap_format(klass, format):
 
3296
        if isinstance(format, remote.RemoteBranchFormat):
 
3297
            format._ensure_real()
 
3298
            return format._custom_format
 
3299
        return format
 
3300
 
 
3301
    @needs_write_lock
 
3302
    def copy_content_into(self, revision_id=None):
 
3303
        """Copy the content of source into target
 
3304
 
 
3305
        revision_id: if not None, the revision history in the new branch will
 
3306
                     be truncated to end with revision_id.
 
3307
        """
 
3308
        self.source.update_references(self.target)
 
3309
        self.source._synchronize_history(self.target, revision_id)
 
3310
        try:
 
3311
            parent = self.source.get_parent()
 
3312
        except errors.InaccessibleParent, e:
 
3313
            mutter('parent was not accessible to copy: %s', e)
 
3314
        else:
 
3315
            if parent:
 
3316
                self.target.set_parent(parent)
 
3317
        if self.source._push_should_merge_tags():
 
3318
            self.source.tags.merge_to(self.target.tags)
 
3319
 
 
3320
    @needs_write_lock
 
3321
    def fetch(self, stop_revision=None, limit=None):
 
3322
        if self.target.base == self.source.base:
 
3323
            return (0, [])
3196
3324
        self.source.lock_read()
3197
3325
        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)
 
3326
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3327
            fetch_spec_factory.source_branch = self.source
 
3328
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3329
            fetch_spec_factory.source_repo = self.source.repository
 
3330
            fetch_spec_factory.target_repo = self.target.repository
 
3331
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3332
            fetch_spec_factory.limit = limit
 
3333
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3334
            return self.target.repository.fetch(self.source.repository,
 
3335
                fetch_spec=fetch_spec)
3233
3336
        finally:
3234
3337
            self.source.unlock()
3235
3338
 
 
3339
    @needs_write_lock
 
3340
    def _update_revisions(self, stop_revision=None, overwrite=False,
 
3341
            graph=None):
 
3342
        other_revno, other_last_revision = self.source.last_revision_info()
 
3343
        stop_revno = None # unknown
 
3344
        if stop_revision is None:
 
3345
            stop_revision = other_last_revision
 
3346
            if _mod_revision.is_null(stop_revision):
 
3347
                # if there are no commits, we're done.
 
3348
                return
 
3349
            stop_revno = other_revno
 
3350
 
 
3351
        # what's the current last revision, before we fetch [and change it
 
3352
        # possibly]
 
3353
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3354
        # we fetch here so that we don't process data twice in the common
 
3355
        # case of having something to pull, and so that the check for
 
3356
        # already merged can operate on the just fetched graph, which will
 
3357
        # be cached in memory.
 
3358
        self.fetch(stop_revision=stop_revision)
 
3359
        # Check to see if one is an ancestor of the other
 
3360
        if not overwrite:
 
3361
            if graph is None:
 
3362
                graph = self.target.repository.get_graph()
 
3363
            if self.target._check_if_descendant_or_diverged(
 
3364
                    stop_revision, last_rev, graph, self.source):
 
3365
                # stop_revision is a descendant of last_rev, but we aren't
 
3366
                # overwriting, so we're done.
 
3367
                return
 
3368
        if stop_revno is None:
 
3369
            if graph is None:
 
3370
                graph = self.target.repository.get_graph()
 
3371
            this_revno, this_last_revision = \
 
3372
                    self.target.last_revision_info()
 
3373
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3374
                            [(other_last_revision, other_revno),
 
3375
                             (this_last_revision, this_revno)])
 
3376
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3377
 
 
3378
    @needs_write_lock
3236
3379
    def pull(self, overwrite=False, stop_revision=None,
 
3380
             possible_transports=None, run_hooks=True,
 
3381
             _override_hook_target=None, local=False):
 
3382
        """Pull from source into self, updating my master if any.
 
3383
 
 
3384
        :param run_hooks: Private parameter - if false, this branch
 
3385
            is being called because it's the master of the primary branch,
 
3386
            so it should not run its hooks.
 
3387
        """
 
3388
        bound_location = self.target.get_bound_location()
 
3389
        if local and not bound_location:
 
3390
            raise errors.LocalRequiresBoundBranch()
 
3391
        master_branch = None
 
3392
        source_is_master = False
 
3393
        if bound_location:
 
3394
            # bound_location comes from a config file, some care has to be
 
3395
            # taken to relate it to source.user_url
 
3396
            normalized = urlutils.normalize_url(bound_location)
 
3397
            try:
 
3398
                relpath = self.source.user_transport.relpath(normalized)
 
3399
                source_is_master = (relpath == '')
 
3400
            except (errors.PathNotChild, errors.InvalidURL):
 
3401
                source_is_master = False
 
3402
        if not local and bound_location and not source_is_master:
 
3403
            # not pulling from master, so we need to update master.
 
3404
            master_branch = self.target.get_master_branch(possible_transports)
 
3405
            master_branch.lock_write()
 
3406
        try:
 
3407
            if master_branch:
 
3408
                # pull from source into master.
 
3409
                master_branch.pull(self.source, overwrite, stop_revision,
 
3410
                    run_hooks=False)
 
3411
            return self._pull(overwrite,
 
3412
                stop_revision, _hook_master=master_branch,
 
3413
                run_hooks=run_hooks,
 
3414
                _override_hook_target=_override_hook_target,
 
3415
                merge_tags_to_master=not source_is_master)
 
3416
        finally:
 
3417
            if master_branch:
 
3418
                master_branch.unlock()
 
3419
 
 
3420
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
3421
             _override_hook_source_branch=None):
 
3422
        """See InterBranch.push.
 
3423
 
 
3424
        This is the basic concrete implementation of push()
 
3425
 
 
3426
        :param _override_hook_source_branch: If specified, run the hooks
 
3427
            passing this Branch as the source, rather than self.  This is for
 
3428
            use of RemoteBranch, where push is delegated to the underlying
 
3429
            vfs-based Branch.
 
3430
        """
 
3431
        if lossy:
 
3432
            raise errors.LossyPushToSameVCS(self.source, self.target)
 
3433
        # TODO: Public option to disable running hooks - should be trivial but
 
3434
        # needs tests.
 
3435
 
 
3436
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
 
3437
        op.add_cleanup(self.source.lock_read().unlock)
 
3438
        op.add_cleanup(self.target.lock_write().unlock)
 
3439
        return op.run(overwrite, stop_revision,
 
3440
            _override_hook_source_branch=_override_hook_source_branch)
 
3441
 
 
3442
    def _basic_push(self, overwrite, stop_revision):
 
3443
        """Basic implementation of push without bound branches or hooks.
 
3444
 
 
3445
        Must be called with source read locked and target write locked.
 
3446
        """
 
3447
        result = BranchPushResult()
 
3448
        result.source_branch = self.source
 
3449
        result.target_branch = self.target
 
3450
        result.old_revno, result.old_revid = self.target.last_revision_info()
 
3451
        self.source.update_references(self.target)
 
3452
        overwrite = _fix_overwrite_type(overwrite)
 
3453
        if result.old_revid != stop_revision:
 
3454
            # We assume that during 'push' this repository is closer than
 
3455
            # the target.
 
3456
            graph = self.source.repository.get_graph(self.target.repository)
 
3457
            self._update_revisions(stop_revision,
 
3458
                overwrite=("history" in overwrite),
 
3459
                graph=graph)
 
3460
        if self.source._push_should_merge_tags():
 
3461
            result.tag_updates, result.tag_conflicts = (
 
3462
                self.source.tags.merge_to(
 
3463
                self.target.tags, "tags" in overwrite))
 
3464
        result.new_revno, result.new_revid = self.target.last_revision_info()
 
3465
        return result
 
3466
 
 
3467
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
 
3468
            _override_hook_source_branch=None):
 
3469
        """Push from source into target, and into target's master if any.
 
3470
        """
 
3471
        def _run_hooks():
 
3472
            if _override_hook_source_branch:
 
3473
                result.source_branch = _override_hook_source_branch
 
3474
            for hook in Branch.hooks['post_push']:
 
3475
                hook(result)
 
3476
 
 
3477
        bound_location = self.target.get_bound_location()
 
3478
        if bound_location and self.target.base != bound_location:
 
3479
            # there is a master branch.
 
3480
            #
 
3481
            # XXX: Why the second check?  Is it even supported for a branch to
 
3482
            # be bound to itself? -- mbp 20070507
 
3483
            master_branch = self.target.get_master_branch()
 
3484
            master_branch.lock_write()
 
3485
            operation.add_cleanup(master_branch.unlock)
 
3486
            # push into the master from the source branch.
 
3487
            master_inter = InterBranch.get(self.source, master_branch)
 
3488
            master_inter._basic_push(overwrite, stop_revision)
 
3489
            # and push into the target branch from the source. Note that
 
3490
            # we push from the source branch again, because it's considered
 
3491
            # the highest bandwidth repository.
 
3492
            result = self._basic_push(overwrite, stop_revision)
 
3493
            result.master_branch = master_branch
 
3494
            result.local_branch = self.target
 
3495
        else:
 
3496
            master_branch = None
 
3497
            # no master branch
 
3498
            result = self._basic_push(overwrite, stop_revision)
 
3499
            # TODO: Why set master_branch and local_branch if there's no
 
3500
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3501
            # 20070504
 
3502
            result.master_branch = self.target
 
3503
            result.local_branch = None
 
3504
        _run_hooks()
 
3505
        return result
 
3506
 
 
3507
    def _pull(self, overwrite=False, stop_revision=None,
3237
3508
             possible_transports=None, _hook_master=None, run_hooks=True,
3238
 
             _override_hook_target=None, local=False):
 
3509
             _override_hook_target=None, local=False,
 
3510
             merge_tags_to_master=True):
3239
3511
        """See Branch.pull.
3240
3512
 
 
3513
        This function is the core worker, used by GenericInterBranch.pull to
 
3514
        avoid duplication when pulling source->master and source->local.
 
3515
 
3241
3516
        :param _hook_master: Private parameter - set the branch to
3242
3517
            be supplied as the master to pull hooks.
3243
3518
        :param run_hooks: Private parameter - if false, this branch
3244
3519
            is being called because it's the master of the primary branch,
3245
3520
            so it should not run its hooks.
 
3521
            is being called because it's the master of the primary branch,
 
3522
            so it should not run its hooks.
3246
3523
        :param _override_hook_target: Private parameter - set the branch to be
3247
3524
            supplied as the target_branch to pull hooks.
3248
3525
        :param local: Only update the local branch, and not the bound branch.
3267
3544
            # -- JRV20090506
3268
3545
            result.old_revno, result.old_revid = \
3269
3546
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
 
3547
            overwrite = _fix_overwrite_type(overwrite)
 
3548
            self._update_revisions(stop_revision,
 
3549
                overwrite=("history" in overwrite),
 
3550
                graph=graph)
3272
3551
            # TODO: The old revid should be specified when merging tags, 
3273
3552
            # so a tags implementation that versions tags can only 
3274
3553
            # pull in the most recent changes. -- JRV20090506
3275
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
 
3554
            result.tag_updates, result.tag_conflicts = (
 
3555
                self.source.tags.merge_to(self.target.tags,
 
3556
                    "tags" in overwrite,
 
3557
                    ignore_master=not merge_tags_to_master))
3277
3558
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
3559
            if _hook_master:
3279
3560
                result.master_branch = _hook_master
3288
3569
            self.source.unlock()
3289
3570
        return result
3290
3571
 
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
3572
 
3400
3573
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)